/
index.ts
274 lines (253 loc) · 8.05 KB
/
index.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
import type {
ArraySchemaType,
PortableTextBlock,
PortableTextObject,
PortableTextTextBlock,
} from '@sanity/types'
import {flatten} from 'lodash'
import {findBlockType} from '../util/findBlockType'
import {resolveJsType} from '../util/resolveJsType'
import type {
ArbitraryTypedObject,
DeserializerRule,
HtmlDeserializerOptions,
PlaceholderAnnotation,
PlaceholderDecorator,
TypedObject,
} from '../types'
import {createRules} from './rules'
import {
createRuleOptions,
defaultParseHtml,
ensureRootIsBlocks,
flattenNestedBlocks,
trimWhitespace,
preprocess,
tagName,
isNodeList,
isMinimalSpan,
isPlaceholderDecorator,
isPlaceholderAnnotation,
isMinimalBlock,
} from './helpers'
/**
* HTML Deserializer
*
*/
export default class HtmlDeserializer {
blockContentType: ArraySchemaType
rules: DeserializerRule[]
parseHtml: (html: string) => HTMLElement
_markDefs: PortableTextObject[] = []
/**
* Create a new serializer respecting a Sanity block content type's schema
*
* @param blockContentType - Schema type for array containing _at least_ a block child type
* @param options - Options for the deserialization process
*/
constructor(blockContentType: ArraySchemaType, options: HtmlDeserializerOptions = {}) {
const {rules = []} = options
if (!blockContentType) {
throw new Error("Parameter 'blockContentType' is required")
}
const standardRules = createRules(blockContentType, createRuleOptions(blockContentType))
this.rules = [...rules, ...standardRules]
const parseHtml = options.parseHtml || defaultParseHtml()
this.blockContentType = blockContentType
this.parseHtml = (html) => {
const doc = preprocess(html, parseHtml)
return doc.body
}
}
/**
* Deserialize HTML.
*
* @param html - The HTML to deserialize, as a string
* @returns Array of blocks - either portable text blocks or other allowed blocks
*/
deserialize = (html: string): TypedObject[] => {
this._markDefs = []
const {parseHtml} = this
const fragment = parseHtml(html)
const children = Array.from(fragment.childNodes) as HTMLElement[]
// Ensure that there are no blocks within blocks, and trim whitespace
const blocks = trimWhitespace(
flattenNestedBlocks(ensureRootIsBlocks(this.deserializeElements(children)))
)
if (this._markDefs.length > 0) {
blocks
.filter((block): block is PortableTextTextBlock => block._type === 'block')
.forEach((block) => {
block.markDefs = block.markDefs || []
block.markDefs = block.markDefs.concat(
this._markDefs.filter((def) => {
return flatten(block.children.map((child) => child.marks || [])).includes(def._key)
})
)
})
}
// Set back the potentially hoisted block type
const type = this.blockContentType.of.find(findBlockType)
if (!type) {
return blocks
}
return blocks.map((block) => {
if (block._type === 'block') {
block._type = type.name
}
return block
})
}
/**
* Deserialize an array of DOM elements.
*
* @param elements - Array of DOM elements to deserialize
* @returns
*/
deserializeElements = (elements: Node[] = []): TypedObject[] => {
let nodes: TypedObject[] = []
elements.forEach((element) => {
nodes = nodes.concat(this.deserializeElement(element))
})
return nodes
}
/**
* Deserialize a DOM element
*
* @param element - Deserialize a DOM element
* @returns
*/
deserializeElement = (element: Node): TypedObject | TypedObject[] => {
const next = (elements: Node | Node[] | NodeList): TypedObject | TypedObject[] | undefined => {
if (isNodeList(elements)) {
return this.deserializeElements(Array.from(elements))
}
if (Array.isArray(elements)) {
return this.deserializeElements(elements)
}
if (!elements) {
return undefined
}
return this.deserializeElement(elements)
}
const block = (props: ArbitraryTypedObject) => {
return {
_type: '__block',
block: props,
}
}
let node
for (let i = 0; i < this.rules.length; i++) {
const rule = this.rules[i]
if (!rule.deserialize) {
continue
}
const ret = rule.deserialize(element, next, block)
const type = resolveJsType(ret)
if (type !== 'array' && type !== 'object' && type !== 'null' && type !== 'undefined') {
throw new Error(`A rule returned an invalid deserialized representation: "${node}".`)
}
if (ret === undefined) {
continue
} else if (ret === null) {
throw new Error('Deserializer rule returned `null`')
} else if (Array.isArray(ret)) {
node = ret
} else if (isPlaceholderDecorator(ret)) {
node = this.deserializeDecorator(ret)
} else if (isPlaceholderAnnotation(ret)) {
node = this.deserializeAnnotation(ret)
} else {
node = ret
}
// Set list level on list item
if (ret && !Array.isArray(ret) && isMinimalBlock(ret) && 'listItem' in ret) {
let parent = element.parentNode?.parentNode
while (parent && tagName(parent) === 'li') {
parent = parent.parentNode?.parentNode
ret.level = ret.level ? ret.level + 1 : 1
}
}
// Set newlines on spans orginating from a block element within a blockquote
if (ret && !Array.isArray(ret) && isMinimalBlock(ret) && ret.style === 'blockquote') {
ret.children.forEach((child, index) => {
if (isMinimalSpan(child) && child.text === '\r') {
child.text = '\n\n'
if (index === 0 || index === ret.children.length - 1) {
ret.children.splice(index, 1)
}
}
})
}
break
}
return node || next(element.childNodes) || []
}
/**
* Deserialize a `__decorator` type
* (an internal made up type to process decorators exclusively)
*
* @param decorator -
* @returns array of ...
*/
deserializeDecorator = (decorator: PlaceholderDecorator): TypedObject[] => {
const {name} = decorator
const applyDecorator = (node: TypedObject) => {
if (isPlaceholderDecorator(node)) {
return this.deserializeDecorator(node)
} else if (isMinimalSpan(node)) {
node.marks = node.marks || []
if (node.text.trim()) {
// Only apply marks if this is an actual text
node.marks.unshift(name)
}
} else if ('children' in node && Array.isArray((node as PortableTextBlock).children)) {
const block = node as any
block.children = block.children.map(applyDecorator)
}
return node
}
return decorator.children.reduce((children, node) => {
const ret = applyDecorator(node)
if (Array.isArray(ret)) {
return children.concat(ret)
}
children.push(ret)
return children
}, [] as TypedObject[])
}
/**
* Deserialize a `__annotation` object.
* (an internal made up type to process annotations exclusively)
*
* @param annotation -
* @returns Array of...
*/
deserializeAnnotation = (annotation: PlaceholderAnnotation): TypedObject[] => {
const {markDef} = annotation
this._markDefs.push(markDef)
const applyAnnotation = (node: TypedObject) => {
if (isPlaceholderAnnotation(node)) {
return this.deserializeAnnotation(node)
} else if (isMinimalSpan(node)) {
node.marks = node.marks || []
if (node.text.trim()) {
// Only apply marks if this is an actual text
node.marks.unshift(markDef._key)
}
} else if ('children' in node && Array.isArray((node as PortableTextBlock).children)) {
const block = node as any
block.children = block.children.map(applyAnnotation)
}
return node
}
return annotation.children.reduce((children, node) => {
const ret = applyAnnotation(node)
if (Array.isArray(ret)) {
return children.concat(ret)
}
children.push(ret)
return children
}, [] as TypedObject[])
}
}