@ckeditor/ckeditor5-engine 39.0.1 → 40.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (244) hide show
  1. package/CHANGELOG.md +2 -2
  2. package/LICENSE.md +1 -1
  3. package/README.md +8 -8
  4. package/package.json +2 -6
  5. package/src/controller/datacontroller.d.ts +334 -334
  6. package/src/controller/datacontroller.js +481 -481
  7. package/src/controller/editingcontroller.d.ts +98 -98
  8. package/src/controller/editingcontroller.js +191 -191
  9. package/src/conversion/conversion.d.ts +478 -478
  10. package/src/conversion/conversion.js +601 -601
  11. package/src/conversion/conversionhelpers.d.ts +26 -26
  12. package/src/conversion/conversionhelpers.js +32 -32
  13. package/src/conversion/downcastdispatcher.d.ts +562 -562
  14. package/src/conversion/downcastdispatcher.js +547 -547
  15. package/src/conversion/downcasthelpers.d.ts +1226 -1226
  16. package/src/conversion/downcasthelpers.js +2183 -2183
  17. package/src/conversion/mapper.d.ts +503 -503
  18. package/src/conversion/mapper.js +536 -536
  19. package/src/conversion/modelconsumable.d.ts +201 -201
  20. package/src/conversion/modelconsumable.js +333 -333
  21. package/src/conversion/upcastdispatcher.d.ts +492 -492
  22. package/src/conversion/upcastdispatcher.js +460 -460
  23. package/src/conversion/upcasthelpers.d.ts +499 -499
  24. package/src/conversion/upcasthelpers.js +950 -950
  25. package/src/conversion/viewconsumable.d.ts +369 -369
  26. package/src/conversion/viewconsumable.js +532 -532
  27. package/src/dataprocessor/basichtmlwriter.d.ts +18 -18
  28. package/src/dataprocessor/basichtmlwriter.js +19 -19
  29. package/src/dataprocessor/dataprocessor.d.ts +61 -61
  30. package/src/dataprocessor/dataprocessor.js +5 -5
  31. package/src/dataprocessor/htmldataprocessor.d.ts +76 -76
  32. package/src/dataprocessor/htmldataprocessor.js +96 -96
  33. package/src/dataprocessor/htmlwriter.d.ts +16 -16
  34. package/src/dataprocessor/htmlwriter.js +5 -5
  35. package/src/dataprocessor/xmldataprocessor.d.ts +90 -90
  36. package/src/dataprocessor/xmldataprocessor.js +108 -108
  37. package/src/dev-utils/model.d.ts +124 -124
  38. package/src/dev-utils/model.js +395 -395
  39. package/src/dev-utils/operationreplayer.d.ts +51 -51
  40. package/src/dev-utils/operationreplayer.js +112 -112
  41. package/src/dev-utils/utils.d.ts +37 -37
  42. package/src/dev-utils/utils.js +73 -73
  43. package/src/dev-utils/view.d.ts +319 -319
  44. package/src/dev-utils/view.js +967 -967
  45. package/src/index.d.ts +114 -114
  46. package/src/index.js +78 -78
  47. package/src/model/batch.d.ts +106 -106
  48. package/src/model/batch.js +96 -96
  49. package/src/model/differ.d.ts +387 -387
  50. package/src/model/differ.js +1149 -1149
  51. package/src/model/document.d.ts +272 -272
  52. package/src/model/document.js +361 -361
  53. package/src/model/documentfragment.d.ts +200 -200
  54. package/src/model/documentfragment.js +306 -306
  55. package/src/model/documentselection.d.ts +420 -420
  56. package/src/model/documentselection.js +993 -993
  57. package/src/model/element.d.ts +165 -165
  58. package/src/model/element.js +281 -281
  59. package/src/model/history.d.ts +114 -114
  60. package/src/model/history.js +207 -207
  61. package/src/model/item.d.ts +14 -14
  62. package/src/model/item.js +5 -5
  63. package/src/model/liveposition.d.ts +77 -77
  64. package/src/model/liveposition.js +93 -93
  65. package/src/model/liverange.d.ts +102 -102
  66. package/src/model/liverange.js +120 -120
  67. package/src/model/markercollection.d.ts +335 -335
  68. package/src/model/markercollection.js +403 -403
  69. package/src/model/model.d.ts +919 -919
  70. package/src/model/model.js +842 -842
  71. package/src/model/node.d.ts +256 -256
  72. package/src/model/node.js +375 -375
  73. package/src/model/nodelist.d.ts +91 -91
  74. package/src/model/nodelist.js +163 -163
  75. package/src/model/operation/attributeoperation.d.ts +103 -103
  76. package/src/model/operation/attributeoperation.js +148 -148
  77. package/src/model/operation/detachoperation.d.ts +60 -60
  78. package/src/model/operation/detachoperation.js +77 -77
  79. package/src/model/operation/insertoperation.d.ts +90 -90
  80. package/src/model/operation/insertoperation.js +135 -135
  81. package/src/model/operation/markeroperation.d.ts +91 -91
  82. package/src/model/operation/markeroperation.js +107 -107
  83. package/src/model/operation/mergeoperation.d.ts +100 -100
  84. package/src/model/operation/mergeoperation.js +167 -167
  85. package/src/model/operation/moveoperation.d.ts +96 -96
  86. package/src/model/operation/moveoperation.js +164 -164
  87. package/src/model/operation/nooperation.d.ts +38 -38
  88. package/src/model/operation/nooperation.js +48 -48
  89. package/src/model/operation/operation.d.ts +96 -96
  90. package/src/model/operation/operation.js +62 -62
  91. package/src/model/operation/operationfactory.d.ts +18 -18
  92. package/src/model/operation/operationfactory.js +44 -44
  93. package/src/model/operation/renameoperation.d.ts +83 -83
  94. package/src/model/operation/renameoperation.js +115 -115
  95. package/src/model/operation/rootattributeoperation.d.ts +98 -98
  96. package/src/model/operation/rootattributeoperation.js +155 -155
  97. package/src/model/operation/rootoperation.d.ts +76 -76
  98. package/src/model/operation/rootoperation.js +90 -90
  99. package/src/model/operation/splitoperation.d.ts +109 -109
  100. package/src/model/operation/splitoperation.js +194 -194
  101. package/src/model/operation/transform.d.ts +100 -100
  102. package/src/model/operation/transform.js +1985 -1985
  103. package/src/model/operation/utils.d.ts +71 -71
  104. package/src/model/operation/utils.js +213 -213
  105. package/src/model/position.d.ts +539 -539
  106. package/src/model/position.js +979 -979
  107. package/src/model/range.d.ts +458 -458
  108. package/src/model/range.js +875 -875
  109. package/src/model/rootelement.d.ts +60 -60
  110. package/src/model/rootelement.js +74 -74
  111. package/src/model/schema.d.ts +1186 -1186
  112. package/src/model/schema.js +1242 -1242
  113. package/src/model/selection.d.ts +482 -482
  114. package/src/model/selection.js +789 -789
  115. package/src/model/text.d.ts +66 -66
  116. package/src/model/text.js +85 -85
  117. package/src/model/textproxy.d.ts +144 -144
  118. package/src/model/textproxy.js +189 -189
  119. package/src/model/treewalker.d.ts +186 -186
  120. package/src/model/treewalker.js +244 -244
  121. package/src/model/typecheckable.d.ts +285 -285
  122. package/src/model/typecheckable.js +16 -16
  123. package/src/model/utils/autoparagraphing.d.ts +37 -37
  124. package/src/model/utils/autoparagraphing.js +63 -63
  125. package/src/model/utils/deletecontent.d.ts +58 -58
  126. package/src/model/utils/deletecontent.js +488 -488
  127. package/src/model/utils/findoptimalinsertionrange.d.ts +32 -32
  128. package/src/model/utils/findoptimalinsertionrange.js +57 -57
  129. package/src/model/utils/getselectedcontent.d.ts +30 -30
  130. package/src/model/utils/getselectedcontent.js +125 -125
  131. package/src/model/utils/insertcontent.d.ts +46 -46
  132. package/src/model/utils/insertcontent.js +705 -705
  133. package/src/model/utils/insertobject.d.ts +44 -44
  134. package/src/model/utils/insertobject.js +139 -139
  135. package/src/model/utils/modifyselection.d.ts +48 -48
  136. package/src/model/utils/modifyselection.js +186 -186
  137. package/src/model/utils/selection-post-fixer.d.ts +74 -74
  138. package/src/model/utils/selection-post-fixer.js +260 -260
  139. package/src/model/writer.d.ts +851 -851
  140. package/src/model/writer.js +1306 -1306
  141. package/src/view/attributeelement.d.ts +108 -108
  142. package/src/view/attributeelement.js +184 -184
  143. package/src/view/containerelement.d.ts +49 -49
  144. package/src/view/containerelement.js +80 -80
  145. package/src/view/datatransfer.d.ts +79 -79
  146. package/src/view/datatransfer.js +98 -98
  147. package/src/view/document.d.ts +184 -184
  148. package/src/view/document.js +120 -120
  149. package/src/view/documentfragment.d.ts +149 -149
  150. package/src/view/documentfragment.js +228 -228
  151. package/src/view/documentselection.d.ts +306 -306
  152. package/src/view/documentselection.js +256 -256
  153. package/src/view/domconverter.d.ts +640 -640
  154. package/src/view/domconverter.js +1450 -1425
  155. package/src/view/downcastwriter.d.ts +996 -996
  156. package/src/view/downcastwriter.js +1696 -1696
  157. package/src/view/editableelement.d.ts +62 -62
  158. package/src/view/editableelement.js +62 -62
  159. package/src/view/element.d.ts +468 -468
  160. package/src/view/element.js +724 -724
  161. package/src/view/elementdefinition.d.ts +87 -87
  162. package/src/view/elementdefinition.js +5 -5
  163. package/src/view/emptyelement.d.ts +41 -41
  164. package/src/view/emptyelement.js +73 -73
  165. package/src/view/filler.d.ts +111 -111
  166. package/src/view/filler.js +150 -150
  167. package/src/view/item.d.ts +14 -14
  168. package/src/view/item.js +5 -5
  169. package/src/view/matcher.d.ts +486 -486
  170. package/src/view/matcher.js +507 -507
  171. package/src/view/node.d.ts +163 -163
  172. package/src/view/node.js +228 -228
  173. package/src/view/observer/arrowkeysobserver.d.ts +45 -45
  174. package/src/view/observer/arrowkeysobserver.js +40 -40
  175. package/src/view/observer/bubblingemittermixin.d.ts +166 -166
  176. package/src/view/observer/bubblingemittermixin.js +172 -172
  177. package/src/view/observer/bubblingeventinfo.d.ts +47 -47
  178. package/src/view/observer/bubblingeventinfo.js +37 -37
  179. package/src/view/observer/clickobserver.d.ts +43 -43
  180. package/src/view/observer/clickobserver.js +29 -29
  181. package/src/view/observer/compositionobserver.d.ts +82 -82
  182. package/src/view/observer/compositionobserver.js +60 -60
  183. package/src/view/observer/domeventdata.d.ts +50 -50
  184. package/src/view/observer/domeventdata.js +47 -47
  185. package/src/view/observer/domeventobserver.d.ts +73 -73
  186. package/src/view/observer/domeventobserver.js +79 -79
  187. package/src/view/observer/fakeselectionobserver.d.ts +47 -47
  188. package/src/view/observer/fakeselectionobserver.js +91 -91
  189. package/src/view/observer/focusobserver.d.ts +82 -82
  190. package/src/view/observer/focusobserver.js +86 -86
  191. package/src/view/observer/inputobserver.d.ts +86 -86
  192. package/src/view/observer/inputobserver.js +164 -164
  193. package/src/view/observer/keyobserver.d.ts +66 -66
  194. package/src/view/observer/keyobserver.js +39 -39
  195. package/src/view/observer/mouseobserver.d.ts +89 -89
  196. package/src/view/observer/mouseobserver.js +29 -29
  197. package/src/view/observer/mutationobserver.d.ts +86 -86
  198. package/src/view/observer/mutationobserver.js +206 -206
  199. package/src/view/observer/observer.d.ts +89 -89
  200. package/src/view/observer/observer.js +84 -84
  201. package/src/view/observer/selectionobserver.d.ts +148 -148
  202. package/src/view/observer/selectionobserver.js +202 -202
  203. package/src/view/observer/tabobserver.d.ts +46 -46
  204. package/src/view/observer/tabobserver.js +42 -42
  205. package/src/view/placeholder.d.ts +96 -96
  206. package/src/view/placeholder.js +267 -267
  207. package/src/view/position.d.ts +189 -189
  208. package/src/view/position.js +324 -324
  209. package/src/view/range.d.ts +279 -279
  210. package/src/view/range.js +430 -430
  211. package/src/view/rawelement.d.ts +73 -73
  212. package/src/view/rawelement.js +105 -105
  213. package/src/view/renderer.d.ts +265 -265
  214. package/src/view/renderer.js +999 -999
  215. package/src/view/rooteditableelement.d.ts +41 -41
  216. package/src/view/rooteditableelement.js +69 -69
  217. package/src/view/selection.d.ts +375 -375
  218. package/src/view/selection.js +559 -559
  219. package/src/view/styles/background.d.ts +33 -33
  220. package/src/view/styles/background.js +74 -74
  221. package/src/view/styles/border.d.ts +43 -43
  222. package/src/view/styles/border.js +316 -316
  223. package/src/view/styles/margin.d.ts +29 -29
  224. package/src/view/styles/margin.js +34 -34
  225. package/src/view/styles/padding.d.ts +29 -29
  226. package/src/view/styles/padding.js +34 -34
  227. package/src/view/styles/utils.d.ts +93 -93
  228. package/src/view/styles/utils.js +219 -219
  229. package/src/view/stylesmap.d.ts +675 -675
  230. package/src/view/stylesmap.js +766 -766
  231. package/src/view/text.d.ts +74 -74
  232. package/src/view/text.js +93 -93
  233. package/src/view/textproxy.d.ts +97 -97
  234. package/src/view/textproxy.js +124 -124
  235. package/src/view/treewalker.d.ts +195 -195
  236. package/src/view/treewalker.js +327 -327
  237. package/src/view/typecheckable.d.ts +448 -448
  238. package/src/view/typecheckable.js +19 -19
  239. package/src/view/uielement.d.ts +96 -96
  240. package/src/view/uielement.js +182 -182
  241. package/src/view/upcastwriter.d.ts +417 -417
  242. package/src/view/upcastwriter.js +359 -359
  243. package/src/view/view.d.ts +487 -487
  244. package/src/view/view.js +546 -546
@@ -1,90 +1,90 @@
1
- /**
2
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- import DomConverter from '../view/domconverter';
6
- import type DataProcessor from './dataprocessor';
7
- import type HtmlWriter from './htmlwriter';
8
- import type ViewDocument from '../view/document';
9
- import type ViewDocumentFragment from '../view/documentfragment';
10
- import type { MatcherPattern } from '../view/matcher';
11
- /**
12
- * The XML data processor class.
13
- * This data processor implementation uses XML as input and output data.
14
- * This class is needed because unlike HTML, XML allows to use any tag with any value.
15
- * For example, `<link>Text</link>` is a valid XML but invalid HTML.
16
- */
17
- export default class XmlDataProcessor implements DataProcessor {
18
- /**
19
- * A list of namespaces allowed to use in the XML input.
20
- *
21
- * For example, registering namespaces [ 'attribute', 'container' ] allows to use `<attirbute:tagName></attribute:tagName>`
22
- * and `<container:tagName></container:tagName>` input. It is mainly for debugging.
23
- */
24
- namespaces: Array<string>;
25
- /**
26
- * DOM parser instance used to parse an XML string to an XML document.
27
- */
28
- domParser: DOMParser;
29
- /**
30
- * DOM converter used to convert DOM elements to view elements.
31
- */
32
- domConverter: DomConverter;
33
- /**
34
- * A basic HTML writer instance used to convert DOM elements to an XML string.
35
- * There is no need to use a dedicated XML writer because the basic HTML writer works well in this case.
36
- */
37
- htmlWriter: HtmlWriter;
38
- skipComments: boolean;
39
- /**
40
- * Creates a new instance of the XML data processor class.
41
- *
42
- * @param document The view document instance.
43
- * @param options Configuration options.
44
- * @param options.namespaces A list of namespaces allowed to use in the XML input.
45
- */
46
- constructor(document: ViewDocument, options?: {
47
- namespaces?: Array<string>;
48
- });
49
- /**
50
- * Converts the provided {@link module:engine/view/documentfragment~DocumentFragment document fragment}
51
- * to data format &mdash; in this case an XML string.
52
- *
53
- * @returns An XML string.
54
- */
55
- toData(viewFragment: ViewDocumentFragment): string;
56
- /**
57
- * Converts the provided XML string to a view tree.
58
- *
59
- * @param data An XML string.
60
- * @returns A converted view element.
61
- */
62
- toView(data: string): ViewDocumentFragment;
63
- /**
64
- * Registers a {@link module:engine/view/matcher~MatcherPattern} for view elements whose content should be treated as raw data
65
- * and not processed during the conversion from XML to view elements.
66
- *
67
- * The raw data can be later accessed by a
68
- * {@link module:engine/view/element~Element#getCustomProperty custom property of a view element} called `"$rawContent"`.
69
- *
70
- * @param pattern Pattern matching all view elements whose content should be treated as raw data.
71
- */
72
- registerRawContentMatcher(pattern: MatcherPattern): void;
73
- /**
74
- * If the processor is set to use marked fillers, it will insert `&nbsp;` fillers wrapped in `<span>` elements
75
- * (`<span data-cke-filler="true">&nbsp;</span>`) instead of regular `&nbsp;` characters.
76
- *
77
- * This mode allows for a more precise handling of block fillers (so they do not leak into editor content) but
78
- * bloats the editor data with additional markup.
79
- *
80
- * This mode may be required by some features and will be turned on by them automatically.
81
- *
82
- * @param type Whether to use the default or the marked `&nbsp;` block fillers.
83
- */
84
- useFillerType(type: 'default' | 'marked'): void;
85
- /**
86
- * Converts an XML string to its DOM representation. Returns a document fragment containing nodes parsed from
87
- * the provided data.
88
- */
89
- private _toDom;
90
- }
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ import DomConverter from '../view/domconverter';
6
+ import type DataProcessor from './dataprocessor';
7
+ import type HtmlWriter from './htmlwriter';
8
+ import type ViewDocument from '../view/document';
9
+ import type ViewDocumentFragment from '../view/documentfragment';
10
+ import type { MatcherPattern } from '../view/matcher';
11
+ /**
12
+ * The XML data processor class.
13
+ * This data processor implementation uses XML as input and output data.
14
+ * This class is needed because unlike HTML, XML allows to use any tag with any value.
15
+ * For example, `<link>Text</link>` is a valid XML but invalid HTML.
16
+ */
17
+ export default class XmlDataProcessor implements DataProcessor {
18
+ /**
19
+ * A list of namespaces allowed to use in the XML input.
20
+ *
21
+ * For example, registering namespaces [ 'attribute', 'container' ] allows to use `<attirbute:tagName></attribute:tagName>`
22
+ * and `<container:tagName></container:tagName>` input. It is mainly for debugging.
23
+ */
24
+ namespaces: Array<string>;
25
+ /**
26
+ * DOM parser instance used to parse an XML string to an XML document.
27
+ */
28
+ domParser: DOMParser;
29
+ /**
30
+ * DOM converter used to convert DOM elements to view elements.
31
+ */
32
+ domConverter: DomConverter;
33
+ /**
34
+ * A basic HTML writer instance used to convert DOM elements to an XML string.
35
+ * There is no need to use a dedicated XML writer because the basic HTML writer works well in this case.
36
+ */
37
+ htmlWriter: HtmlWriter;
38
+ skipComments: boolean;
39
+ /**
40
+ * Creates a new instance of the XML data processor class.
41
+ *
42
+ * @param document The view document instance.
43
+ * @param options Configuration options.
44
+ * @param options.namespaces A list of namespaces allowed to use in the XML input.
45
+ */
46
+ constructor(document: ViewDocument, options?: {
47
+ namespaces?: Array<string>;
48
+ });
49
+ /**
50
+ * Converts the provided {@link module:engine/view/documentfragment~DocumentFragment document fragment}
51
+ * to data format &mdash; in this case an XML string.
52
+ *
53
+ * @returns An XML string.
54
+ */
55
+ toData(viewFragment: ViewDocumentFragment): string;
56
+ /**
57
+ * Converts the provided XML string to a view tree.
58
+ *
59
+ * @param data An XML string.
60
+ * @returns A converted view element.
61
+ */
62
+ toView(data: string): ViewDocumentFragment;
63
+ /**
64
+ * Registers a {@link module:engine/view/matcher~MatcherPattern} for view elements whose content should be treated as raw data
65
+ * and not processed during the conversion from XML to view elements.
66
+ *
67
+ * The raw data can be later accessed by a
68
+ * {@link module:engine/view/element~Element#getCustomProperty custom property of a view element} called `"$rawContent"`.
69
+ *
70
+ * @param pattern Pattern matching all view elements whose content should be treated as raw data.
71
+ */
72
+ registerRawContentMatcher(pattern: MatcherPattern): void;
73
+ /**
74
+ * If the processor is set to use marked fillers, it will insert `&nbsp;` fillers wrapped in `<span>` elements
75
+ * (`<span data-cke-filler="true">&nbsp;</span>`) instead of regular `&nbsp;` characters.
76
+ *
77
+ * This mode allows for a more precise handling of block fillers (so they do not leak into editor content) but
78
+ * bloats the editor data with additional markup.
79
+ *
80
+ * This mode may be required by some features and will be turned on by them automatically.
81
+ *
82
+ * @param type Whether to use the default or the marked `&nbsp;` block fillers.
83
+ */
84
+ useFillerType(type: 'default' | 'marked'): void;
85
+ /**
86
+ * Converts an XML string to its DOM representation. Returns a document fragment containing nodes parsed from
87
+ * the provided data.
88
+ */
89
+ private _toDom;
90
+ }
@@ -1,108 +1,108 @@
1
- /**
2
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- /**
6
- * @module engine/dataprocessor/xmldataprocessor
7
- */
8
- /* globals DOMParser */
9
- import BasicHtmlWriter from './basichtmlwriter';
10
- import DomConverter from '../view/domconverter';
11
- /**
12
- * The XML data processor class.
13
- * This data processor implementation uses XML as input and output data.
14
- * This class is needed because unlike HTML, XML allows to use any tag with any value.
15
- * For example, `<link>Text</link>` is a valid XML but invalid HTML.
16
- */
17
- export default class XmlDataProcessor {
18
- /**
19
- * Creates a new instance of the XML data processor class.
20
- *
21
- * @param document The view document instance.
22
- * @param options Configuration options.
23
- * @param options.namespaces A list of namespaces allowed to use in the XML input.
24
- */
25
- constructor(document, options = {}) {
26
- this.skipComments = true;
27
- this.namespaces = options.namespaces || [];
28
- this.domParser = new DOMParser();
29
- this.domConverter = new DomConverter(document, { renderingMode: 'data' });
30
- this.htmlWriter = new BasicHtmlWriter();
31
- }
32
- /**
33
- * Converts the provided {@link module:engine/view/documentfragment~DocumentFragment document fragment}
34
- * to data format &mdash; in this case an XML string.
35
- *
36
- * @returns An XML string.
37
- */
38
- toData(viewFragment) {
39
- // Convert view DocumentFragment to DOM DocumentFragment.
40
- const domFragment = this.domConverter.viewToDom(viewFragment);
41
- // Convert DOM DocumentFragment to XML output.
42
- // There is no need to use dedicated for XML serializing method because BasicHtmlWriter works well in this case.
43
- return this.htmlWriter.getHtml(domFragment);
44
- }
45
- /**
46
- * Converts the provided XML string to a view tree.
47
- *
48
- * @param data An XML string.
49
- * @returns A converted view element.
50
- */
51
- toView(data) {
52
- // Convert input XML data to DOM DocumentFragment.
53
- const domFragment = this._toDom(data);
54
- // Convert DOM DocumentFragment to view DocumentFragment.
55
- return this.domConverter.domToView(domFragment, {
56
- keepOriginalCase: true,
57
- skipComments: this.skipComments
58
- });
59
- }
60
- /**
61
- * Registers a {@link module:engine/view/matcher~MatcherPattern} for view elements whose content should be treated as raw data
62
- * and not processed during the conversion from XML to view elements.
63
- *
64
- * The raw data can be later accessed by a
65
- * {@link module:engine/view/element~Element#getCustomProperty custom property of a view element} called `"$rawContent"`.
66
- *
67
- * @param pattern Pattern matching all view elements whose content should be treated as raw data.
68
- */
69
- registerRawContentMatcher(pattern) {
70
- this.domConverter.registerRawContentMatcher(pattern);
71
- }
72
- /**
73
- * If the processor is set to use marked fillers, it will insert `&nbsp;` fillers wrapped in `<span>` elements
74
- * (`<span data-cke-filler="true">&nbsp;</span>`) instead of regular `&nbsp;` characters.
75
- *
76
- * This mode allows for a more precise handling of block fillers (so they do not leak into editor content) but
77
- * bloats the editor data with additional markup.
78
- *
79
- * This mode may be required by some features and will be turned on by them automatically.
80
- *
81
- * @param type Whether to use the default or the marked `&nbsp;` block fillers.
82
- */
83
- useFillerType(type) {
84
- this.domConverter.blockFillerMode = type == 'marked' ? 'markedNbsp' : 'nbsp';
85
- }
86
- /**
87
- * Converts an XML string to its DOM representation. Returns a document fragment containing nodes parsed from
88
- * the provided data.
89
- */
90
- _toDom(data) {
91
- // Stringify namespaces.
92
- const namespaces = this.namespaces.map(nsp => `xmlns:${nsp}="nsp"`).join(' ');
93
- // Wrap data into root element with optional namespace definitions.
94
- data = `<xml ${namespaces}>${data}</xml>`;
95
- const parsedDocument = this.domParser.parseFromString(data, 'text/xml');
96
- // Parse validation.
97
- const parserError = parsedDocument.querySelector('parsererror');
98
- if (parserError) {
99
- throw new Error('Parse error - ' + parserError.textContent);
100
- }
101
- const fragment = parsedDocument.createDocumentFragment();
102
- const nodes = parsedDocument.documentElement.childNodes;
103
- while (nodes.length > 0) {
104
- fragment.appendChild(nodes[0]);
105
- }
106
- return fragment;
107
- }
108
- }
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ /**
6
+ * @module engine/dataprocessor/xmldataprocessor
7
+ */
8
+ /* globals DOMParser */
9
+ import BasicHtmlWriter from './basichtmlwriter';
10
+ import DomConverter from '../view/domconverter';
11
+ /**
12
+ * The XML data processor class.
13
+ * This data processor implementation uses XML as input and output data.
14
+ * This class is needed because unlike HTML, XML allows to use any tag with any value.
15
+ * For example, `<link>Text</link>` is a valid XML but invalid HTML.
16
+ */
17
+ export default class XmlDataProcessor {
18
+ /**
19
+ * Creates a new instance of the XML data processor class.
20
+ *
21
+ * @param document The view document instance.
22
+ * @param options Configuration options.
23
+ * @param options.namespaces A list of namespaces allowed to use in the XML input.
24
+ */
25
+ constructor(document, options = {}) {
26
+ this.skipComments = true;
27
+ this.namespaces = options.namespaces || [];
28
+ this.domParser = new DOMParser();
29
+ this.domConverter = new DomConverter(document, { renderingMode: 'data' });
30
+ this.htmlWriter = new BasicHtmlWriter();
31
+ }
32
+ /**
33
+ * Converts the provided {@link module:engine/view/documentfragment~DocumentFragment document fragment}
34
+ * to data format &mdash; in this case an XML string.
35
+ *
36
+ * @returns An XML string.
37
+ */
38
+ toData(viewFragment) {
39
+ // Convert view DocumentFragment to DOM DocumentFragment.
40
+ const domFragment = this.domConverter.viewToDom(viewFragment);
41
+ // Convert DOM DocumentFragment to XML output.
42
+ // There is no need to use dedicated for XML serializing method because BasicHtmlWriter works well in this case.
43
+ return this.htmlWriter.getHtml(domFragment);
44
+ }
45
+ /**
46
+ * Converts the provided XML string to a view tree.
47
+ *
48
+ * @param data An XML string.
49
+ * @returns A converted view element.
50
+ */
51
+ toView(data) {
52
+ // Convert input XML data to DOM DocumentFragment.
53
+ const domFragment = this._toDom(data);
54
+ // Convert DOM DocumentFragment to view DocumentFragment.
55
+ return this.domConverter.domToView(domFragment, {
56
+ keepOriginalCase: true,
57
+ skipComments: this.skipComments
58
+ });
59
+ }
60
+ /**
61
+ * Registers a {@link module:engine/view/matcher~MatcherPattern} for view elements whose content should be treated as raw data
62
+ * and not processed during the conversion from XML to view elements.
63
+ *
64
+ * The raw data can be later accessed by a
65
+ * {@link module:engine/view/element~Element#getCustomProperty custom property of a view element} called `"$rawContent"`.
66
+ *
67
+ * @param pattern Pattern matching all view elements whose content should be treated as raw data.
68
+ */
69
+ registerRawContentMatcher(pattern) {
70
+ this.domConverter.registerRawContentMatcher(pattern);
71
+ }
72
+ /**
73
+ * If the processor is set to use marked fillers, it will insert `&nbsp;` fillers wrapped in `<span>` elements
74
+ * (`<span data-cke-filler="true">&nbsp;</span>`) instead of regular `&nbsp;` characters.
75
+ *
76
+ * This mode allows for a more precise handling of block fillers (so they do not leak into editor content) but
77
+ * bloats the editor data with additional markup.
78
+ *
79
+ * This mode may be required by some features and will be turned on by them automatically.
80
+ *
81
+ * @param type Whether to use the default or the marked `&nbsp;` block fillers.
82
+ */
83
+ useFillerType(type) {
84
+ this.domConverter.blockFillerMode = type == 'marked' ? 'markedNbsp' : 'nbsp';
85
+ }
86
+ /**
87
+ * Converts an XML string to its DOM representation. Returns a document fragment containing nodes parsed from
88
+ * the provided data.
89
+ */
90
+ _toDom(data) {
91
+ // Stringify namespaces.
92
+ const namespaces = this.namespaces.map(nsp => `xmlns:${nsp}="nsp"`).join(' ');
93
+ // Wrap data into root element with optional namespace definitions.
94
+ data = `<xml ${namespaces}>${data}</xml>`;
95
+ const parsedDocument = this.domParser.parseFromString(data, 'text/xml');
96
+ // Parse validation.
97
+ const parserError = parsedDocument.querySelector('parsererror');
98
+ if (parserError) {
99
+ throw new Error('Parse error - ' + parserError.textContent);
100
+ }
101
+ const fragment = parsedDocument.createDocumentFragment();
102
+ const nodes = parsedDocument.documentElement.childNodes;
103
+ while (nodes.length > 0) {
104
+ fragment.appendChild(nodes[0]);
105
+ }
106
+ return fragment;
107
+ }
108
+ }
@@ -1,124 +1,124 @@
1
- /**
2
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
- */
5
- import Model from '../model/model';
6
- import ModelRange from '../model/range';
7
- import ModelPosition from '../model/position';
8
- import ModelSelection from '../model/selection';
9
- import ModelDocumentFragment from '../model/documentfragment';
10
- import DocumentSelection from '../model/documentselection';
11
- import type { BatchType } from '../model/batch';
12
- import type MarkerCollection from '../model/markercollection';
13
- import type { default as Schema, SchemaContextDefinition } from '../model/schema';
14
- import type ModelNode from '../model/node';
15
- /**
16
- * Writes the content of a model {@link module:engine/model/document~Document document} to an HTML-like string.
17
- *
18
- * ```ts
19
- * getData( editor.model ); // -> '<paragraph>Foo![]</paragraph>'
20
- * ```
21
- *
22
- * **Note:** A {@link module:engine/model/text~Text text} node that contains attributes will be represented as:
23
- *
24
- * ```xml
25
- * <$text attribute="value">Text data</$text>
26
- * ```
27
- *
28
- * **Note:** Using this tool in production-grade code is not recommended. It was designed for development, prototyping,
29
- * debugging and testing.
30
- *
31
- * @param options.withoutSelection Whether to write the selection. When set to `true`, the selection will
32
- * not be included in the returned string.
33
- * @param options.rootName The name of the root from which the data should be stringified. If not provided,
34
- * the default `main` name will be used.
35
- * @param options.convertMarkers Whether to include markers in the returned string.
36
- * @returns The stringified data.
37
- */
38
- export declare function getData(model: Model, options?: {
39
- withoutSelection?: boolean;
40
- rootName?: string;
41
- convertMarkers?: boolean;
42
- }): string;
43
- export declare namespace getData {
44
- var _stringify: typeof stringify;
45
- }
46
- /**
47
- * Sets the content of a model {@link module:engine/model/document~Document document} provided as an HTML-like string.
48
- *
49
- * ```ts
50
- * setData( editor.model, '<paragraph>Foo![]</paragraph>' );
51
- * ```
52
- *
53
- * **Note:** Remember to register elements in the {@link module:engine/model/model~Model#schema model's schema} before
54
- * trying to use them.
55
- *
56
- * **Note:** To create a {@link module:engine/model/text~Text text} node that contains attributes use:
57
- *
58
- * ```xml
59
- * <$text attribute="value">Text data</$text>
60
- * ```
61
- *
62
- * **Note:** Using this tool in production-grade code is not recommended. It was designed for development, prototyping,
63
- * debugging and testing.
64
- *
65
- * @param data HTML-like string to write into the document.
66
- * @param options.rootName Root name where parsed data will be stored. If not provided, the default `main`
67
- * name will be used.
68
- * @param options.selectionAttributes A list of attributes which will be passed to the selection.
69
- * @param options.lastRangeBackward If set to `true`, the last range will be added as backward.
70
- * @param options.batchType Batch type used for inserting elements. See {@link module:engine/model/batch~Batch#constructor}.
71
- * See {@link module:engine/model/batch~Batch#type}.
72
- */
73
- export declare function setData(model: Model, data: string, options?: {
74
- rootName?: string;
75
- selectionAttributes?: Record<string, unknown>;
76
- lastRangeBackward?: boolean;
77
- batchType?: BatchType;
78
- }): void;
79
- export declare namespace setData {
80
- var _parse: typeof parse;
81
- }
82
- /**
83
- * Converts model nodes to HTML-like string representation.
84
- *
85
- * **Note:** A {@link module:engine/model/text~Text text} node that contains attributes will be represented as:
86
- *
87
- * ```xml
88
- * <$text attribute="value">Text data</$text>
89
- * ```
90
- *
91
- * @param node A node to stringify.
92
- * @param selectionOrPositionOrRange A selection instance whose ranges will be included in the returned string data.
93
- * If a range instance is provided, it will be converted to a selection containing this range. If a position instance
94
- * is provided, it will be converted to a selection containing one range collapsed at this position.
95
- * @param markers Markers to include.
96
- * @returns An HTML-like string representing the model.
97
- */
98
- export declare function stringify(node: ModelNode | ModelDocumentFragment, selectionOrPositionOrRange?: ModelSelection | DocumentSelection | ModelPosition | ModelRange | null, markers?: MarkerCollection | null): string;
99
- /**
100
- * Parses an HTML-like string and returns the model {@link module:engine/model/rootelement~RootElement rootElement}.
101
- *
102
- * **Note:** To create a {@link module:engine/model/text~Text text} node that contains attributes use:
103
- *
104
- * ```xml
105
- * <$text attribute="value">Text data</$text>
106
- * ```
107
- *
108
- * @param data HTML-like string to be parsed.
109
- * @param schema A schema instance used by converters for element validation.
110
- * @param options Additional configuration.
111
- * @param options.selectionAttributes A list of attributes which will be passed to the selection.
112
- * @param options.lastRangeBackward If set to `true`, the last range will be added as backward.
113
- * @param options.context The conversion context. If not provided, the default `'$root'` will be used.
114
- * @returns Returns the parsed model node or an object with two fields: `model` and `selection`,
115
- * when selection ranges were included in the data to parse.
116
- */
117
- export declare function parse(data: string, schema: Schema, options?: {
118
- selectionAttributes?: Record<string, unknown> | Iterable<[string, unknown]>;
119
- lastRangeBackward?: boolean;
120
- context?: SchemaContextDefinition;
121
- }): ModelNode | ModelDocumentFragment | {
122
- model: ModelNode | ModelDocumentFragment;
123
- selection: ModelSelection;
124
- };
1
+ /**
2
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
3
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
4
+ */
5
+ import Model from '../model/model';
6
+ import ModelRange from '../model/range';
7
+ import ModelPosition from '../model/position';
8
+ import ModelSelection from '../model/selection';
9
+ import ModelDocumentFragment from '../model/documentfragment';
10
+ import DocumentSelection from '../model/documentselection';
11
+ import type { BatchType } from '../model/batch';
12
+ import type MarkerCollection from '../model/markercollection';
13
+ import type { default as Schema, SchemaContextDefinition } from '../model/schema';
14
+ import type ModelNode from '../model/node';
15
+ /**
16
+ * Writes the content of a model {@link module:engine/model/document~Document document} to an HTML-like string.
17
+ *
18
+ * ```ts
19
+ * getData( editor.model ); // -> '<paragraph>Foo![]</paragraph>'
20
+ * ```
21
+ *
22
+ * **Note:** A {@link module:engine/model/text~Text text} node that contains attributes will be represented as:
23
+ *
24
+ * ```xml
25
+ * <$text attribute="value">Text data</$text>
26
+ * ```
27
+ *
28
+ * **Note:** Using this tool in production-grade code is not recommended. It was designed for development, prototyping,
29
+ * debugging and testing.
30
+ *
31
+ * @param options.withoutSelection Whether to write the selection. When set to `true`, the selection will
32
+ * not be included in the returned string.
33
+ * @param options.rootName The name of the root from which the data should be stringified. If not provided,
34
+ * the default `main` name will be used.
35
+ * @param options.convertMarkers Whether to include markers in the returned string.
36
+ * @returns The stringified data.
37
+ */
38
+ export declare function getData(model: Model, options?: {
39
+ withoutSelection?: boolean;
40
+ rootName?: string;
41
+ convertMarkers?: boolean;
42
+ }): string;
43
+ export declare namespace getData {
44
+ var _stringify: typeof stringify;
45
+ }
46
+ /**
47
+ * Sets the content of a model {@link module:engine/model/document~Document document} provided as an HTML-like string.
48
+ *
49
+ * ```ts
50
+ * setData( editor.model, '<paragraph>Foo![]</paragraph>' );
51
+ * ```
52
+ *
53
+ * **Note:** Remember to register elements in the {@link module:engine/model/model~Model#schema model's schema} before
54
+ * trying to use them.
55
+ *
56
+ * **Note:** To create a {@link module:engine/model/text~Text text} node that contains attributes use:
57
+ *
58
+ * ```xml
59
+ * <$text attribute="value">Text data</$text>
60
+ * ```
61
+ *
62
+ * **Note:** Using this tool in production-grade code is not recommended. It was designed for development, prototyping,
63
+ * debugging and testing.
64
+ *
65
+ * @param data HTML-like string to write into the document.
66
+ * @param options.rootName Root name where parsed data will be stored. If not provided, the default `main`
67
+ * name will be used.
68
+ * @param options.selectionAttributes A list of attributes which will be passed to the selection.
69
+ * @param options.lastRangeBackward If set to `true`, the last range will be added as backward.
70
+ * @param options.batchType Batch type used for inserting elements. See {@link module:engine/model/batch~Batch#constructor}.
71
+ * See {@link module:engine/model/batch~Batch#type}.
72
+ */
73
+ export declare function setData(model: Model, data: string, options?: {
74
+ rootName?: string;
75
+ selectionAttributes?: Record<string, unknown>;
76
+ lastRangeBackward?: boolean;
77
+ batchType?: BatchType;
78
+ }): void;
79
+ export declare namespace setData {
80
+ var _parse: typeof parse;
81
+ }
82
+ /**
83
+ * Converts model nodes to HTML-like string representation.
84
+ *
85
+ * **Note:** A {@link module:engine/model/text~Text text} node that contains attributes will be represented as:
86
+ *
87
+ * ```xml
88
+ * <$text attribute="value">Text data</$text>
89
+ * ```
90
+ *
91
+ * @param node A node to stringify.
92
+ * @param selectionOrPositionOrRange A selection instance whose ranges will be included in the returned string data.
93
+ * If a range instance is provided, it will be converted to a selection containing this range. If a position instance
94
+ * is provided, it will be converted to a selection containing one range collapsed at this position.
95
+ * @param markers Markers to include.
96
+ * @returns An HTML-like string representing the model.
97
+ */
98
+ export declare function stringify(node: ModelNode | ModelDocumentFragment, selectionOrPositionOrRange?: ModelSelection | DocumentSelection | ModelPosition | ModelRange | null, markers?: MarkerCollection | null): string;
99
+ /**
100
+ * Parses an HTML-like string and returns the model {@link module:engine/model/rootelement~RootElement rootElement}.
101
+ *
102
+ * **Note:** To create a {@link module:engine/model/text~Text text} node that contains attributes use:
103
+ *
104
+ * ```xml
105
+ * <$text attribute="value">Text data</$text>
106
+ * ```
107
+ *
108
+ * @param data HTML-like string to be parsed.
109
+ * @param schema A schema instance used by converters for element validation.
110
+ * @param options Additional configuration.
111
+ * @param options.selectionAttributes A list of attributes which will be passed to the selection.
112
+ * @param options.lastRangeBackward If set to `true`, the last range will be added as backward.
113
+ * @param options.context The conversion context. If not provided, the default `'$root'` will be used.
114
+ * @returns Returns the parsed model node or an object with two fields: `model` and `selection`,
115
+ * when selection ranges were included in the data to parse.
116
+ */
117
+ export declare function parse(data: string, schema: Schema, options?: {
118
+ selectionAttributes?: Record<string, unknown> | Iterable<[string, unknown]>;
119
+ lastRangeBackward?: boolean;
120
+ context?: SchemaContextDefinition;
121
+ }): ModelNode | ModelDocumentFragment | {
122
+ model: ModelNode | ModelDocumentFragment;
123
+ selection: ModelSelection;
124
+ };