/
ModelToDomSettings.ts
268 lines (233 loc) · 8.55 KB
/
ModelToDomSettings.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
import type { Definition } from '../metadata/Definition';
import type { ContentModelBlock } from '../block/ContentModelBlock';
import type { ContentModelBlockFormat } from '../format/ContentModelBlockFormat';
import type { ContentModelBlockGroup } from '../group/ContentModelBlockGroup';
import type { ContentModelBr } from '../segment/ContentModelBr';
import type { ContentModelDecorator } from '../decorator/ContentModelDecorator';
import type { ContentModelDivider } from '../block/ContentModelDivider';
import type { ContentModelEntity } from '../entity/ContentModelEntity';
import type { ContentModelFormatBase } from '../format/ContentModelFormatBase';
import type { ContentModelFormatContainer } from '../group/ContentModelFormatContainer';
import type { ContentModelFormatMap } from '../format/ContentModelFormatMap';
import type { ContentModelGeneralBlock } from '../group/ContentModelGeneralBlock';
import type { ContentModelGeneralSegment } from '../segment/ContentModelGeneralSegment';
import type { ContentModelImage } from '../segment/ContentModelImage';
import type { ContentModelListItem } from '../group/ContentModelListItem';
import type { ContentModelListItemFormat } from '../format/ContentModelListItemFormat';
import type { ContentModelListItemLevelFormat } from '../format/ContentModelListItemLevelFormat';
import type { ContentModelParagraph } from '../block/ContentModelParagraph';
import type { ContentModelSegment } from '../segment/ContentModelSegment';
import type { ContentModelSegmentFormat } from '../format/ContentModelSegmentFormat';
import type { ContentModelTable } from '../block/ContentModelTable';
import type { ContentModelTableRow } from '../block/ContentModelTableRow';
import type { ContentModelText } from '../segment/ContentModelText';
import type { FormatHandlerTypeMap, FormatKey } from '../format/FormatHandlerTypeMap';
import type { ModelToDomContext } from './ModelToDomContext';
import type { ListMetadataFormat } from '../format/metadata/ListMetadataFormat';
import type {
ContentModelHandler,
ContentModelBlockHandler,
ContentModelSegmentHandler,
} from './ContentModelHandler';
/**
* Default implicit format map from tag name (lower case) to segment format
*/
export type DefaultImplicitFormatMap = Record<
string,
Readonly<ContentModelSegmentFormat & ContentModelBlockFormat>
>;
/**
* Apply format to the given HTML element
* @param format The format object to apply
* @param element The HTML element to apply format to
* @param context The context object that provide related context information
*/
export type FormatApplier<TFormat extends ContentModelFormatBase> = (
format: TFormat,
element: HTMLElement,
context: ModelToDomContext
) => void;
/**
* Apply format to the given text node
* @param format The format object to apply
* @param textNode The text node to apply format to
* @param context The context object that provide related context information
*/
export type TextFormatApplier<
TFormat extends ContentModelSegmentFormat = ContentModelSegmentFormat
> = (format: TFormat, textNode: Text, context: ModelToDomContext) => void;
/**
* All format appliers
*/
export type FormatAppliers = {
[Key in FormatKey]: FormatApplier<FormatHandlerTypeMap[Key]> | null;
};
/**
* A map from format parser category name to an array of parsers. This is for HTMLElement only
*/
export type ElementFormatAppliersPerCategory = {
[Key in keyof ContentModelFormatMap]: (FormatApplier<ContentModelFormatMap[Key]> | null)[];
};
/**
* A map from format parser category name to an array of parsers
*/
export type FormatAppliersPerCategory = ElementFormatAppliersPerCategory & {
text: TextFormatApplier[];
};
/**
* Represents a map from content model handler name to its handle type
*/
export type ContentModelHandlerMap = {
/**
* Content Model type for ContentModelBlock
*/
block: ContentModelBlockHandler<ContentModelBlock>;
/**
* Content Model type for child models of ContentModelBlockGroup
*/
blockGroupChildren: ContentModelHandler<ContentModelBlockGroup>;
/**
* Content Model type for ContentModelBr
*/
br: ContentModelSegmentHandler<ContentModelBr>;
/**
* Content Model type for child models of ContentModelEntity
*/
entityBlock: ContentModelBlockHandler<ContentModelEntity>;
/**
* Content Model type for child models of ContentModelEntity
*/
entitySegment: ContentModelSegmentHandler<ContentModelEntity>;
/**
* Content Model type for ContentModelGeneralBlock
*/
generalBlock: ContentModelBlockHandler<ContentModelGeneralBlock>;
/**
* Content Model type for ContentModelGeneralBlock
*/
generalSegment: ContentModelSegmentHandler<ContentModelGeneralSegment>;
/**
* Content Model type for ContentModelHR
*/
divider: ContentModelBlockHandler<ContentModelDivider>;
/**
* Content Model type for ContentModelImage
*/
image: ContentModelSegmentHandler<ContentModelImage>;
/**
* Content Model type for list group of ContentModelListItem
*/
list: ContentModelBlockHandler<ContentModelListItem>;
/**
* Content Model type for list item of ContentModelListItem
*/
listItem: ContentModelBlockHandler<ContentModelListItem>;
/**
* Content Model type for ContentModelParagraph
*/
paragraph: ContentModelBlockHandler<ContentModelParagraph>;
/**
* Content Model type for ContentModelFormatContainer
*/
formatContainer: ContentModelBlockHandler<ContentModelFormatContainer>;
/**
* Content Model type for ContentModelSegment
*/
segment: ContentModelSegmentHandler<ContentModelSegment>;
/**
* Content Model type for ContentModelCode
*/
segmentDecorator: ContentModelSegmentHandler<ContentModelSegment>;
/**
* Content Model type for ContentModelTable
*/
table: ContentModelBlockHandler<ContentModelTable>;
/**
* Content Model type for ContentModelText
*/
text: ContentModelSegmentHandler<ContentModelText>;
};
/**
* Function type to apply metadata value into format
* @param metadata The metadata object to apply
* @param format The format object to apply metadata to
* @param context Content Model to DOM context
*/
export type ApplyMetadata<TMetadata, TFormat extends ContentModelFormatBase> = (
metadata: TMetadata | null,
format: TFormat,
context: ModelToDomContext
) => void;
/**
* Metadata applier interface
*/
export interface MetadataApplier<TMetadata, TFormat extends ContentModelFormatBase> {
/**
* The metadata applier function
*/
applierFunction: ApplyMetadata<TMetadata, TFormat>;
/**
* @optional Metadata definition, used for validate the metadata object
*/
metadataDefinition?: Definition<TMetadata>;
}
/**
* Map of metadata handlers
*/
export type MetadataAppliers = {
/**
* Metadata handler for list item
*/
listItem?: MetadataApplier<ListMetadataFormat, ContentModelListItemFormat>;
/**
* Metadata handler for list level
*/
listLevel?: MetadataApplier<ListMetadataFormat, ContentModelListItemLevelFormat>;
};
/**
* An optional callback that will be called when a DOM node is created
* @param modelElement The related Content Model element
* @param node The node created for this model element
*/
export type OnNodeCreated = (
modelElement:
| ContentModelBlock
| ContentModelBlockGroup
| ContentModelSegment
| ContentModelDecorator
| ContentModelTableRow,
node: Node
) => void;
/**
* Represents settings to customize DOM to Content Model conversion
*/
export interface ModelToDomSettings {
/**
* Map of Content Model handlers
*/
modelHandlers: ContentModelHandlerMap;
/**
* Map of format appliers
*/
formatAppliers: FormatAppliersPerCategory;
/**
* Map of metadata appliers
*/
metadataAppliers: MetadataAppliers;
/**
* Default Content Model to DOM handlers before overriding.
* This provides a way to call original handler from an overridden handler function
*/
defaultModelHandlers: Readonly<ContentModelHandlerMap>;
/**
* Default format parsers before overriding.
* This provides a way to call original format applier from an overridden applier function
*/
defaultFormatAppliers: Readonly<FormatAppliers>;
/**
* An optional callback that will be called when a DOM node is created
* @param modelElement The related Content Model element
* @param node The node created for this model element
*/
onNodeCreated?: OnNodeCreated;
}