@ckeditor/ckeditor5-engine 40.0.0 → 40.1.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 (242) hide show
  1. package/LICENSE.md +3 -3
  2. package/package.json +2 -2
  3. package/src/controller/datacontroller.d.ts +334 -334
  4. package/src/controller/datacontroller.js +481 -481
  5. package/src/controller/editingcontroller.d.ts +98 -98
  6. package/src/controller/editingcontroller.js +191 -191
  7. package/src/conversion/conversion.d.ts +478 -478
  8. package/src/conversion/conversion.js +601 -601
  9. package/src/conversion/conversionhelpers.d.ts +26 -26
  10. package/src/conversion/conversionhelpers.js +32 -32
  11. package/src/conversion/downcastdispatcher.d.ts +562 -562
  12. package/src/conversion/downcastdispatcher.js +547 -547
  13. package/src/conversion/downcasthelpers.d.ts +1226 -1226
  14. package/src/conversion/downcasthelpers.js +2178 -2183
  15. package/src/conversion/mapper.d.ts +503 -503
  16. package/src/conversion/mapper.js +536 -536
  17. package/src/conversion/modelconsumable.d.ts +201 -201
  18. package/src/conversion/modelconsumable.js +333 -333
  19. package/src/conversion/upcastdispatcher.d.ts +492 -492
  20. package/src/conversion/upcastdispatcher.js +460 -460
  21. package/src/conversion/upcasthelpers.d.ts +499 -499
  22. package/src/conversion/upcasthelpers.js +950 -950
  23. package/src/conversion/viewconsumable.d.ts +369 -369
  24. package/src/conversion/viewconsumable.js +536 -532
  25. package/src/dataprocessor/basichtmlwriter.d.ts +18 -18
  26. package/src/dataprocessor/basichtmlwriter.js +20 -19
  27. package/src/dataprocessor/dataprocessor.d.ts +61 -61
  28. package/src/dataprocessor/dataprocessor.js +5 -5
  29. package/src/dataprocessor/htmldataprocessor.d.ts +76 -76
  30. package/src/dataprocessor/htmldataprocessor.js +96 -96
  31. package/src/dataprocessor/htmlwriter.d.ts +16 -16
  32. package/src/dataprocessor/htmlwriter.js +5 -5
  33. package/src/dataprocessor/xmldataprocessor.d.ts +90 -90
  34. package/src/dataprocessor/xmldataprocessor.js +108 -108
  35. package/src/dev-utils/model.d.ts +124 -124
  36. package/src/dev-utils/model.js +395 -395
  37. package/src/dev-utils/operationreplayer.d.ts +51 -51
  38. package/src/dev-utils/operationreplayer.js +112 -112
  39. package/src/dev-utils/utils.d.ts +37 -37
  40. package/src/dev-utils/utils.js +73 -73
  41. package/src/dev-utils/view.d.ts +319 -319
  42. package/src/dev-utils/view.js +967 -967
  43. package/src/index.d.ts +114 -114
  44. package/src/index.js +78 -78
  45. package/src/model/batch.d.ts +106 -106
  46. package/src/model/batch.js +96 -96
  47. package/src/model/differ.d.ts +387 -387
  48. package/src/model/differ.js +1149 -1149
  49. package/src/model/document.d.ts +272 -272
  50. package/src/model/document.js +360 -361
  51. package/src/model/documentfragment.d.ts +200 -200
  52. package/src/model/documentfragment.js +306 -306
  53. package/src/model/documentselection.d.ts +420 -420
  54. package/src/model/documentselection.js +993 -993
  55. package/src/model/element.d.ts +165 -165
  56. package/src/model/element.js +281 -281
  57. package/src/model/history.d.ts +114 -114
  58. package/src/model/history.js +207 -207
  59. package/src/model/item.d.ts +14 -14
  60. package/src/model/item.js +5 -5
  61. package/src/model/liveposition.d.ts +77 -77
  62. package/src/model/liveposition.js +93 -93
  63. package/src/model/liverange.d.ts +102 -102
  64. package/src/model/liverange.js +120 -120
  65. package/src/model/markercollection.d.ts +335 -335
  66. package/src/model/markercollection.js +403 -403
  67. package/src/model/model.d.ts +919 -919
  68. package/src/model/model.js +842 -842
  69. package/src/model/node.d.ts +256 -256
  70. package/src/model/node.js +375 -375
  71. package/src/model/nodelist.d.ts +91 -91
  72. package/src/model/nodelist.js +163 -163
  73. package/src/model/operation/attributeoperation.d.ts +103 -103
  74. package/src/model/operation/attributeoperation.js +148 -148
  75. package/src/model/operation/detachoperation.d.ts +60 -60
  76. package/src/model/operation/detachoperation.js +77 -77
  77. package/src/model/operation/insertoperation.d.ts +90 -90
  78. package/src/model/operation/insertoperation.js +135 -135
  79. package/src/model/operation/markeroperation.d.ts +91 -91
  80. package/src/model/operation/markeroperation.js +107 -107
  81. package/src/model/operation/mergeoperation.d.ts +100 -100
  82. package/src/model/operation/mergeoperation.js +167 -167
  83. package/src/model/operation/moveoperation.d.ts +96 -96
  84. package/src/model/operation/moveoperation.js +164 -164
  85. package/src/model/operation/nooperation.d.ts +38 -38
  86. package/src/model/operation/nooperation.js +48 -48
  87. package/src/model/operation/operation.d.ts +96 -96
  88. package/src/model/operation/operation.js +59 -62
  89. package/src/model/operation/operationfactory.d.ts +18 -18
  90. package/src/model/operation/operationfactory.js +44 -44
  91. package/src/model/operation/renameoperation.d.ts +83 -83
  92. package/src/model/operation/renameoperation.js +115 -115
  93. package/src/model/operation/rootattributeoperation.d.ts +98 -98
  94. package/src/model/operation/rootattributeoperation.js +155 -155
  95. package/src/model/operation/rootoperation.d.ts +76 -76
  96. package/src/model/operation/rootoperation.js +90 -90
  97. package/src/model/operation/splitoperation.d.ts +109 -109
  98. package/src/model/operation/splitoperation.js +194 -194
  99. package/src/model/operation/transform.d.ts +100 -100
  100. package/src/model/operation/transform.js +1985 -1985
  101. package/src/model/operation/utils.d.ts +71 -71
  102. package/src/model/operation/utils.js +217 -213
  103. package/src/model/position.d.ts +539 -539
  104. package/src/model/position.js +979 -979
  105. package/src/model/range.d.ts +458 -458
  106. package/src/model/range.js +875 -875
  107. package/src/model/rootelement.d.ts +60 -60
  108. package/src/model/rootelement.js +74 -74
  109. package/src/model/schema.d.ts +1186 -1186
  110. package/src/model/schema.js +1242 -1242
  111. package/src/model/selection.d.ts +482 -482
  112. package/src/model/selection.js +789 -789
  113. package/src/model/text.d.ts +66 -66
  114. package/src/model/text.js +85 -85
  115. package/src/model/textproxy.d.ts +144 -144
  116. package/src/model/textproxy.js +189 -189
  117. package/src/model/treewalker.d.ts +186 -186
  118. package/src/model/treewalker.js +244 -244
  119. package/src/model/typecheckable.d.ts +285 -285
  120. package/src/model/typecheckable.js +16 -16
  121. package/src/model/utils/autoparagraphing.d.ts +37 -37
  122. package/src/model/utils/autoparagraphing.js +63 -63
  123. package/src/model/utils/deletecontent.d.ts +58 -58
  124. package/src/model/utils/deletecontent.js +488 -488
  125. package/src/model/utils/findoptimalinsertionrange.d.ts +32 -32
  126. package/src/model/utils/findoptimalinsertionrange.js +57 -57
  127. package/src/model/utils/getselectedcontent.d.ts +30 -30
  128. package/src/model/utils/getselectedcontent.js +125 -125
  129. package/src/model/utils/insertcontent.d.ts +46 -46
  130. package/src/model/utils/insertcontent.js +705 -705
  131. package/src/model/utils/insertobject.d.ts +44 -44
  132. package/src/model/utils/insertobject.js +139 -139
  133. package/src/model/utils/modifyselection.d.ts +48 -48
  134. package/src/model/utils/modifyselection.js +186 -186
  135. package/src/model/utils/selection-post-fixer.d.ts +74 -74
  136. package/src/model/utils/selection-post-fixer.js +260 -260
  137. package/src/model/writer.d.ts +851 -851
  138. package/src/model/writer.js +1306 -1306
  139. package/src/view/attributeelement.d.ts +108 -108
  140. package/src/view/attributeelement.js +184 -184
  141. package/src/view/containerelement.d.ts +49 -49
  142. package/src/view/containerelement.js +80 -80
  143. package/src/view/datatransfer.d.ts +79 -79
  144. package/src/view/datatransfer.js +98 -98
  145. package/src/view/document.d.ts +184 -184
  146. package/src/view/document.js +122 -120
  147. package/src/view/documentfragment.d.ts +153 -149
  148. package/src/view/documentfragment.js +234 -228
  149. package/src/view/documentselection.d.ts +306 -306
  150. package/src/view/documentselection.js +256 -256
  151. package/src/view/domconverter.d.ts +652 -640
  152. package/src/view/domconverter.js +1473 -1450
  153. package/src/view/downcastwriter.d.ts +996 -996
  154. package/src/view/downcastwriter.js +1696 -1696
  155. package/src/view/editableelement.d.ts +62 -62
  156. package/src/view/editableelement.js +62 -62
  157. package/src/view/element.d.ts +468 -468
  158. package/src/view/element.js +724 -724
  159. package/src/view/elementdefinition.d.ts +87 -87
  160. package/src/view/elementdefinition.js +5 -5
  161. package/src/view/emptyelement.d.ts +41 -41
  162. package/src/view/emptyelement.js +73 -73
  163. package/src/view/filler.d.ts +111 -111
  164. package/src/view/filler.js +150 -150
  165. package/src/view/item.d.ts +14 -14
  166. package/src/view/item.js +5 -5
  167. package/src/view/matcher.d.ts +486 -486
  168. package/src/view/matcher.js +507 -507
  169. package/src/view/node.d.ts +163 -163
  170. package/src/view/node.js +228 -228
  171. package/src/view/observer/arrowkeysobserver.d.ts +45 -45
  172. package/src/view/observer/arrowkeysobserver.js +40 -40
  173. package/src/view/observer/bubblingemittermixin.d.ts +166 -166
  174. package/src/view/observer/bubblingemittermixin.js +172 -172
  175. package/src/view/observer/bubblingeventinfo.d.ts +47 -47
  176. package/src/view/observer/bubblingeventinfo.js +37 -37
  177. package/src/view/observer/clickobserver.d.ts +43 -43
  178. package/src/view/observer/clickobserver.js +29 -29
  179. package/src/view/observer/compositionobserver.d.ts +82 -82
  180. package/src/view/observer/compositionobserver.js +60 -60
  181. package/src/view/observer/domeventdata.d.ts +50 -50
  182. package/src/view/observer/domeventdata.js +47 -47
  183. package/src/view/observer/domeventobserver.d.ts +73 -73
  184. package/src/view/observer/domeventobserver.js +79 -79
  185. package/src/view/observer/fakeselectionobserver.d.ts +47 -47
  186. package/src/view/observer/fakeselectionobserver.js +91 -91
  187. package/src/view/observer/focusobserver.d.ts +82 -82
  188. package/src/view/observer/focusobserver.js +86 -86
  189. package/src/view/observer/inputobserver.d.ts +86 -86
  190. package/src/view/observer/inputobserver.js +164 -164
  191. package/src/view/observer/keyobserver.d.ts +66 -66
  192. package/src/view/observer/keyobserver.js +39 -39
  193. package/src/view/observer/mouseobserver.d.ts +89 -89
  194. package/src/view/observer/mouseobserver.js +29 -29
  195. package/src/view/observer/mutationobserver.d.ts +86 -86
  196. package/src/view/observer/mutationobserver.js +206 -206
  197. package/src/view/observer/observer.d.ts +89 -89
  198. package/src/view/observer/observer.js +84 -84
  199. package/src/view/observer/selectionobserver.d.ts +148 -148
  200. package/src/view/observer/selectionobserver.js +202 -202
  201. package/src/view/observer/tabobserver.d.ts +46 -46
  202. package/src/view/observer/tabobserver.js +42 -42
  203. package/src/view/placeholder.d.ts +96 -96
  204. package/src/view/placeholder.js +267 -267
  205. package/src/view/position.d.ts +189 -189
  206. package/src/view/position.js +324 -324
  207. package/src/view/range.d.ts +279 -279
  208. package/src/view/range.js +430 -430
  209. package/src/view/rawelement.d.ts +73 -73
  210. package/src/view/rawelement.js +105 -105
  211. package/src/view/renderer.d.ts +265 -265
  212. package/src/view/renderer.js +1000 -999
  213. package/src/view/rooteditableelement.d.ts +41 -41
  214. package/src/view/rooteditableelement.js +69 -69
  215. package/src/view/selection.d.ts +375 -375
  216. package/src/view/selection.js +559 -559
  217. package/src/view/styles/background.d.ts +33 -33
  218. package/src/view/styles/background.js +74 -74
  219. package/src/view/styles/border.d.ts +43 -43
  220. package/src/view/styles/border.js +316 -316
  221. package/src/view/styles/margin.d.ts +29 -29
  222. package/src/view/styles/margin.js +34 -34
  223. package/src/view/styles/padding.d.ts +29 -29
  224. package/src/view/styles/padding.js +34 -34
  225. package/src/view/styles/utils.d.ts +93 -93
  226. package/src/view/styles/utils.js +219 -219
  227. package/src/view/stylesmap.d.ts +675 -675
  228. package/src/view/stylesmap.js +765 -766
  229. package/src/view/text.d.ts +74 -74
  230. package/src/view/text.js +93 -93
  231. package/src/view/textproxy.d.ts +97 -97
  232. package/src/view/textproxy.js +124 -124
  233. package/src/view/treewalker.d.ts +195 -195
  234. package/src/view/treewalker.js +327 -327
  235. package/src/view/typecheckable.d.ts +448 -448
  236. package/src/view/typecheckable.js +19 -19
  237. package/src/view/uielement.d.ts +96 -96
  238. package/src/view/uielement.js +183 -182
  239. package/src/view/upcastwriter.d.ts +417 -417
  240. package/src/view/upcastwriter.js +359 -359
  241. package/src/view/view.d.ts +487 -487
  242. package/src/view/view.js +546 -546
@@ -1,18 +1,18 @@
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/basichtmlwriter
7
- */
8
- import type HtmlWriter from './htmlwriter';
9
- /**
10
- * Basic HTML writer. It uses the native `innerHTML` property for basic conversion
11
- * from a document fragment to an HTML string.
12
- */
13
- export default class BasicHtmlWriter implements HtmlWriter {
14
- /**
15
- * Returns an HTML string created from the document fragment.
16
- */
17
- getHtml(fragment: DocumentFragment): string;
18
- }
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/basichtmlwriter
7
+ */
8
+ import type HtmlWriter from './htmlwriter';
9
+ /**
10
+ * Basic HTML writer. It uses the native `innerHTML` property for basic conversion
11
+ * from a document fragment to an HTML string.
12
+ */
13
+ export default class BasicHtmlWriter implements HtmlWriter {
14
+ /**
15
+ * Returns an HTML string created from the document fragment.
16
+ */
17
+ getHtml(fragment: DocumentFragment): string;
18
+ }
@@ -1,19 +1,20 @@
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
- * Basic HTML writer. It uses the native `innerHTML` property for basic conversion
7
- * from a document fragment to an HTML string.
8
- */
9
- export default class BasicHtmlWriter {
10
- /**
11
- * Returns an HTML string created from the document fragment.
12
- */
13
- getHtml(fragment) {
14
- const doc = document.implementation.createHTMLDocument('');
15
- const container = doc.createElement('div');
16
- container.appendChild(fragment);
17
- return container.innerHTML;
18
- }
19
- }
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 { global } from '@ckeditor/ckeditor5-utils';
6
+ /**
7
+ * Basic HTML writer. It uses the native `innerHTML` property for basic conversion
8
+ * from a document fragment to an HTML string.
9
+ */
10
+ export default class BasicHtmlWriter {
11
+ /**
12
+ * Returns an HTML string created from the document fragment.
13
+ */
14
+ getHtml(fragment) {
15
+ const doc = global.document.implementation.createHTMLDocument('');
16
+ const container = doc.createElement('div');
17
+ container.appendChild(fragment);
18
+ return container.innerHTML;
19
+ }
20
+ }
@@ -1,61 +1,61 @@
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/dataprocessor
7
- */
8
- import type ViewDocumentFragment from '../view/documentfragment';
9
- import type { MatcherPattern } from '../view/matcher';
10
- /**
11
- * The data processor interface. It should be implemented by actual data processors.
12
- *
13
- * Each data processor implements a certain format of the data. For example, {@glink features/markdown Markdown data processor}
14
- * will convert the data (a Markdown string) to a {@link module:engine/view/documentfragment~DocumentFragment document fragment} and back.
15
- *
16
- * **Note:** While the CKEditor 5 architecture supports changing the data format, in most scenarios we do recommend sticking to
17
- * the default format which is HTML (supported by the {@link module:engine/dataprocessor/htmldataprocessor~HtmlDataProcessor}).
18
- * HTML remains [the best standard for rich-text data](https://medium.com/content-uneditable/a-standard-for-rich-text-data-4b3a507af552).
19
- *
20
- * And please do remember – using Markdown [does not automatically make your
21
- * application/website secure](https://github.com/ckeditor/ckeditor5-markdown-gfm/issues/16#issuecomment-375752994).
22
- */
23
- export default interface DataProcessor {
24
- /**
25
- * Converts a {@link module:engine/view/documentfragment~DocumentFragment document fragment} to data.
26
- *
27
- * @param viewFragment The document fragment to be processed.
28
- */
29
- toData(viewFragment: ViewDocumentFragment): string;
30
- /**
31
- * Converts the data to a {@link module:engine/view/documentfragment~DocumentFragment document fragment}.
32
- *
33
- * @param data The data to be processed.
34
- */
35
- toView(data: string): ViewDocumentFragment;
36
- /**
37
- * Registers a {@link module:engine/view/matcher~MatcherPattern} for view elements whose content should be treated as raw data
38
- * and its content should be converted to a
39
- * {@link module:engine/view/element~Element#getCustomProperty custom property of a view element} called `"$rawContent"` while
40
- * converting {@link #toView to view}.
41
- *
42
- * @param pattern Pattern matching all view elements whose content should be treated as plain text.
43
- */
44
- registerRawContentMatcher(pattern: MatcherPattern): void;
45
- /**
46
- * If the processor is set to use marked fillers, it will insert `&nbsp;` fillers wrapped in `<span>` elements
47
- * (`<span data-cke-filler="true">&nbsp;</span>`) instead of regular `&nbsp;` characters.
48
- *
49
- * This mode allows for more precise handling of block fillers (so they do not leak into the editor content) but bloats the
50
- * editor data with additional markup.
51
- *
52
- * This mode may be required by some features and will be turned on by them automatically.
53
- *
54
- * @param type Whether to use the default or marked `&nbsp;` block fillers.
55
- */
56
- useFillerType(type: 'default' | 'marked'): void;
57
- /**
58
- * If `false`, comment nodes will be converted to `$comment`. Otherwise comment nodes are ignored.
59
- */
60
- skipComments?: boolean;
61
- }
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/dataprocessor
7
+ */
8
+ import type ViewDocumentFragment from '../view/documentfragment';
9
+ import type { MatcherPattern } from '../view/matcher';
10
+ /**
11
+ * The data processor interface. It should be implemented by actual data processors.
12
+ *
13
+ * Each data processor implements a certain format of the data. For example, {@glink features/markdown Markdown data processor}
14
+ * will convert the data (a Markdown string) to a {@link module:engine/view/documentfragment~DocumentFragment document fragment} and back.
15
+ *
16
+ * **Note:** While the CKEditor 5 architecture supports changing the data format, in most scenarios we do recommend sticking to
17
+ * the default format which is HTML (supported by the {@link module:engine/dataprocessor/htmldataprocessor~HtmlDataProcessor}).
18
+ * HTML remains [the best standard for rich-text data](https://medium.com/content-uneditable/a-standard-for-rich-text-data-4b3a507af552).
19
+ *
20
+ * And please do remember – using Markdown [does not automatically make your
21
+ * application/website secure](https://github.com/ckeditor/ckeditor5-markdown-gfm/issues/16#issuecomment-375752994).
22
+ */
23
+ export default interface DataProcessor {
24
+ /**
25
+ * Converts a {@link module:engine/view/documentfragment~DocumentFragment document fragment} to data.
26
+ *
27
+ * @param viewFragment The document fragment to be processed.
28
+ */
29
+ toData(viewFragment: ViewDocumentFragment): string;
30
+ /**
31
+ * Converts the data to a {@link module:engine/view/documentfragment~DocumentFragment document fragment}.
32
+ *
33
+ * @param data The data to be processed.
34
+ */
35
+ toView(data: string): ViewDocumentFragment;
36
+ /**
37
+ * Registers a {@link module:engine/view/matcher~MatcherPattern} for view elements whose content should be treated as raw data
38
+ * and its content should be converted to a
39
+ * {@link module:engine/view/element~Element#getCustomProperty custom property of a view element} called `"$rawContent"` while
40
+ * converting {@link #toView to view}.
41
+ *
42
+ * @param pattern Pattern matching all view elements whose content should be treated as plain text.
43
+ */
44
+ registerRawContentMatcher(pattern: MatcherPattern): void;
45
+ /**
46
+ * If the processor is set to use marked fillers, it will insert `&nbsp;` fillers wrapped in `<span>` elements
47
+ * (`<span data-cke-filler="true">&nbsp;</span>`) instead of regular `&nbsp;` characters.
48
+ *
49
+ * This mode allows for more precise handling of block fillers (so they do not leak into the editor content) but bloats the
50
+ * editor data with additional markup.
51
+ *
52
+ * This mode may be required by some features and will be turned on by them automatically.
53
+ *
54
+ * @param type Whether to use the default or marked `&nbsp;` block fillers.
55
+ */
56
+ useFillerType(type: 'default' | 'marked'): void;
57
+ /**
58
+ * If `false`, comment nodes will be converted to `$comment`. Otherwise comment nodes are ignored.
59
+ */
60
+ skipComments?: boolean;
61
+ }
@@ -1,5 +1,5 @@
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
- export {};
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
+ export {};
@@ -1,76 +1,76 @@
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 HTML data processor class.
13
- * This data processor implementation uses HTML as input and output data.
14
- */
15
- export default class HtmlDataProcessor implements DataProcessor {
16
- /**
17
- * A DOM parser instance used to parse an HTML string to an HTML document.
18
- */
19
- domParser: DOMParser;
20
- /**
21
- * A DOM converter used to convert DOM elements to view elements.
22
- */
23
- domConverter: DomConverter;
24
- /**
25
- * A basic HTML writer instance used to convert DOM elements to an HTML string.
26
- */
27
- htmlWriter: HtmlWriter;
28
- skipComments: boolean;
29
- /**
30
- * Creates a new instance of the HTML data processor class.
31
- *
32
- * @param document The view document instance.
33
- */
34
- constructor(document: ViewDocument);
35
- /**
36
- * Converts a provided {@link module:engine/view/documentfragment~DocumentFragment document fragment}
37
- * to data format &mdash; in this case to an HTML string.
38
- *
39
- * @returns HTML string.
40
- */
41
- toData(viewFragment: ViewDocumentFragment): string;
42
- /**
43
- * Converts the provided HTML string to a view tree.
44
- *
45
- * @param data An HTML string.
46
- * @returns A converted view element.
47
- */
48
- toView(data: string): ViewDocumentFragment;
49
- /**
50
- * Registers a {@link module:engine/view/matcher~MatcherPattern} for view elements whose content should be treated as raw data
51
- * and not processed during the conversion from the DOM to the view elements.
52
- *
53
- * The raw data can be later accessed by a
54
- * {@link module:engine/view/element~Element#getCustomProperty custom property of a view element} called `"$rawContent"`.
55
- *
56
- * @param pattern Pattern matching all view elements whose content should be treated as raw data.
57
- */
58
- registerRawContentMatcher(pattern: MatcherPattern): void;
59
- /**
60
- * If the processor is set to use marked fillers, it will insert `&nbsp;` fillers wrapped in `<span>` elements
61
- * (`<span data-cke-filler="true">&nbsp;</span>`) instead of regular `&nbsp;` characters.
62
- *
63
- * This mode allows for a more precise handling of the block fillers (so they do not leak into the editor content) but
64
- * bloats the editor data with additional markup.
65
- *
66
- * This mode may be required by some features and will be turned on by them automatically.
67
- *
68
- * @param type Whether to use the default or the marked `&nbsp;` block fillers.
69
- */
70
- useFillerType(type: 'default' | 'marked'): void;
71
- /**
72
- * Converts an HTML string to its DOM representation. Returns a document fragment containing nodes parsed from
73
- * the provided data.
74
- */
75
- protected _toDom(data: string): DocumentFragment;
76
- }
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 HTML data processor class.
13
+ * This data processor implementation uses HTML as input and output data.
14
+ */
15
+ export default class HtmlDataProcessor implements DataProcessor {
16
+ /**
17
+ * A DOM parser instance used to parse an HTML string to an HTML document.
18
+ */
19
+ domParser: DOMParser;
20
+ /**
21
+ * A DOM converter used to convert DOM elements to view elements.
22
+ */
23
+ domConverter: DomConverter;
24
+ /**
25
+ * A basic HTML writer instance used to convert DOM elements to an HTML string.
26
+ */
27
+ htmlWriter: HtmlWriter;
28
+ skipComments: boolean;
29
+ /**
30
+ * Creates a new instance of the HTML data processor class.
31
+ *
32
+ * @param document The view document instance.
33
+ */
34
+ constructor(document: ViewDocument);
35
+ /**
36
+ * Converts a provided {@link module:engine/view/documentfragment~DocumentFragment document fragment}
37
+ * to data format &mdash; in this case to an HTML string.
38
+ *
39
+ * @returns HTML string.
40
+ */
41
+ toData(viewFragment: ViewDocumentFragment): string;
42
+ /**
43
+ * Converts the provided HTML string to a view tree.
44
+ *
45
+ * @param data An HTML string.
46
+ * @returns A converted view element.
47
+ */
48
+ toView(data: string): ViewDocumentFragment;
49
+ /**
50
+ * Registers a {@link module:engine/view/matcher~MatcherPattern} for view elements whose content should be treated as raw data
51
+ * and not processed during the conversion from the DOM to the view elements.
52
+ *
53
+ * The raw data can be later accessed by a
54
+ * {@link module:engine/view/element~Element#getCustomProperty custom property of a view element} called `"$rawContent"`.
55
+ *
56
+ * @param pattern Pattern matching all view elements whose content should be treated as raw data.
57
+ */
58
+ registerRawContentMatcher(pattern: MatcherPattern): void;
59
+ /**
60
+ * If the processor is set to use marked fillers, it will insert `&nbsp;` fillers wrapped in `<span>` elements
61
+ * (`<span data-cke-filler="true">&nbsp;</span>`) instead of regular `&nbsp;` characters.
62
+ *
63
+ * This mode allows for a more precise handling of the block fillers (so they do not leak into the editor content) but
64
+ * bloats the editor data with additional markup.
65
+ *
66
+ * This mode may be required by some features and will be turned on by them automatically.
67
+ *
68
+ * @param type Whether to use the default or the marked `&nbsp;` block fillers.
69
+ */
70
+ useFillerType(type: 'default' | 'marked'): void;
71
+ /**
72
+ * Converts an HTML string to its DOM representation. Returns a document fragment containing nodes parsed from
73
+ * the provided data.
74
+ */
75
+ protected _toDom(data: string): DocumentFragment;
76
+ }
@@ -1,96 +1,96 @@
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/htmldataprocessor
7
- */
8
- /* globals DOMParser */
9
- import BasicHtmlWriter from './basichtmlwriter';
10
- import DomConverter from '../view/domconverter';
11
- /**
12
- * The HTML data processor class.
13
- * This data processor implementation uses HTML as input and output data.
14
- */
15
- export default class HtmlDataProcessor {
16
- /**
17
- * Creates a new instance of the HTML data processor class.
18
- *
19
- * @param document The view document instance.
20
- */
21
- constructor(document) {
22
- this.skipComments = true;
23
- this.domParser = new DOMParser();
24
- this.domConverter = new DomConverter(document, { renderingMode: 'data' });
25
- this.htmlWriter = new BasicHtmlWriter();
26
- }
27
- /**
28
- * Converts a provided {@link module:engine/view/documentfragment~DocumentFragment document fragment}
29
- * to data format &mdash; in this case to an HTML string.
30
- *
31
- * @returns HTML string.
32
- */
33
- toData(viewFragment) {
34
- // Convert view DocumentFragment to DOM DocumentFragment.
35
- const domFragment = this.domConverter.viewToDom(viewFragment);
36
- // Convert DOM DocumentFragment to HTML output.
37
- return this.htmlWriter.getHtml(domFragment);
38
- }
39
- /**
40
- * Converts the provided HTML string to a view tree.
41
- *
42
- * @param data An HTML string.
43
- * @returns A converted view element.
44
- */
45
- toView(data) {
46
- // Convert input HTML data to DOM DocumentFragment.
47
- const domFragment = this._toDom(data);
48
- // Convert DOM DocumentFragment to view DocumentFragment.
49
- return this.domConverter.domToView(domFragment, { skipComments: this.skipComments });
50
- }
51
- /**
52
- * Registers a {@link module:engine/view/matcher~MatcherPattern} for view elements whose content should be treated as raw data
53
- * and not processed during the conversion from the DOM to the view elements.
54
- *
55
- * The raw data can be later accessed by a
56
- * {@link module:engine/view/element~Element#getCustomProperty custom property of a view element} called `"$rawContent"`.
57
- *
58
- * @param pattern Pattern matching all view elements whose content should be treated as raw data.
59
- */
60
- registerRawContentMatcher(pattern) {
61
- this.domConverter.registerRawContentMatcher(pattern);
62
- }
63
- /**
64
- * If the processor is set to use marked fillers, it will insert `&nbsp;` fillers wrapped in `<span>` elements
65
- * (`<span data-cke-filler="true">&nbsp;</span>`) instead of regular `&nbsp;` characters.
66
- *
67
- * This mode allows for a more precise handling of the block fillers (so they do not leak into the editor content) but
68
- * bloats the editor data with additional markup.
69
- *
70
- * This mode may be required by some features and will be turned on by them automatically.
71
- *
72
- * @param type Whether to use the default or the marked `&nbsp;` block fillers.
73
- */
74
- useFillerType(type) {
75
- this.domConverter.blockFillerMode = type == 'marked' ? 'markedNbsp' : 'nbsp';
76
- }
77
- /**
78
- * Converts an HTML string to its DOM representation. Returns a document fragment containing nodes parsed from
79
- * the provided data.
80
- */
81
- _toDom(data) {
82
- // Wrap data with a <body> tag so leading non-layout nodes (like <script>, <style>, HTML comment)
83
- // will be preserved in the body collection.
84
- // Do it only for data that is not a full HTML document.
85
- if (!data.match(/<(?:html|body|head|meta)(?:\s[^>]*)?>/i)) {
86
- data = `<body>${data}</body>`;
87
- }
88
- const document = this.domParser.parseFromString(data, 'text/html');
89
- const fragment = document.createDocumentFragment();
90
- const bodyChildNodes = document.body.childNodes;
91
- while (bodyChildNodes.length > 0) {
92
- fragment.appendChild(bodyChildNodes[0]);
93
- }
94
- return fragment;
95
- }
96
- }
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/htmldataprocessor
7
+ */
8
+ /* globals DOMParser */
9
+ import BasicHtmlWriter from './basichtmlwriter';
10
+ import DomConverter from '../view/domconverter';
11
+ /**
12
+ * The HTML data processor class.
13
+ * This data processor implementation uses HTML as input and output data.
14
+ */
15
+ export default class HtmlDataProcessor {
16
+ /**
17
+ * Creates a new instance of the HTML data processor class.
18
+ *
19
+ * @param document The view document instance.
20
+ */
21
+ constructor(document) {
22
+ this.skipComments = true;
23
+ this.domParser = new DOMParser();
24
+ this.domConverter = new DomConverter(document, { renderingMode: 'data' });
25
+ this.htmlWriter = new BasicHtmlWriter();
26
+ }
27
+ /**
28
+ * Converts a provided {@link module:engine/view/documentfragment~DocumentFragment document fragment}
29
+ * to data format &mdash; in this case to an HTML string.
30
+ *
31
+ * @returns HTML string.
32
+ */
33
+ toData(viewFragment) {
34
+ // Convert view DocumentFragment to DOM DocumentFragment.
35
+ const domFragment = this.domConverter.viewToDom(viewFragment);
36
+ // Convert DOM DocumentFragment to HTML output.
37
+ return this.htmlWriter.getHtml(domFragment);
38
+ }
39
+ /**
40
+ * Converts the provided HTML string to a view tree.
41
+ *
42
+ * @param data An HTML string.
43
+ * @returns A converted view element.
44
+ */
45
+ toView(data) {
46
+ // Convert input HTML data to DOM DocumentFragment.
47
+ const domFragment = this._toDom(data);
48
+ // Convert DOM DocumentFragment to view DocumentFragment.
49
+ return this.domConverter.domToView(domFragment, { skipComments: this.skipComments });
50
+ }
51
+ /**
52
+ * Registers a {@link module:engine/view/matcher~MatcherPattern} for view elements whose content should be treated as raw data
53
+ * and not processed during the conversion from the DOM to the view elements.
54
+ *
55
+ * The raw data can be later accessed by a
56
+ * {@link module:engine/view/element~Element#getCustomProperty custom property of a view element} called `"$rawContent"`.
57
+ *
58
+ * @param pattern Pattern matching all view elements whose content should be treated as raw data.
59
+ */
60
+ registerRawContentMatcher(pattern) {
61
+ this.domConverter.registerRawContentMatcher(pattern);
62
+ }
63
+ /**
64
+ * If the processor is set to use marked fillers, it will insert `&nbsp;` fillers wrapped in `<span>` elements
65
+ * (`<span data-cke-filler="true">&nbsp;</span>`) instead of regular `&nbsp;` characters.
66
+ *
67
+ * This mode allows for a more precise handling of the block fillers (so they do not leak into the editor content) but
68
+ * bloats the editor data with additional markup.
69
+ *
70
+ * This mode may be required by some features and will be turned on by them automatically.
71
+ *
72
+ * @param type Whether to use the default or the marked `&nbsp;` block fillers.
73
+ */
74
+ useFillerType(type) {
75
+ this.domConverter.blockFillerMode = type == 'marked' ? 'markedNbsp' : 'nbsp';
76
+ }
77
+ /**
78
+ * Converts an HTML string to its DOM representation. Returns a document fragment containing nodes parsed from
79
+ * the provided data.
80
+ */
81
+ _toDom(data) {
82
+ // Wrap data with a <body> tag so leading non-layout nodes (like <script>, <style>, HTML comment)
83
+ // will be preserved in the body collection.
84
+ // Do it only for data that is not a full HTML document.
85
+ if (!data.match(/<(?:html|body|head|meta)(?:\s[^>]*)?>/i)) {
86
+ data = `<body>${data}</body>`;
87
+ }
88
+ const document = this.domParser.parseFromString(data, 'text/html');
89
+ const fragment = document.createDocumentFragment();
90
+ const bodyChildNodes = document.body.childNodes;
91
+ while (bodyChildNodes.length > 0) {
92
+ fragment.appendChild(bodyChildNodes[0]);
93
+ }
94
+ return fragment;
95
+ }
96
+ }
@@ -1,16 +1,16 @@
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/htmlwriter
7
- */
8
- /**
9
- * The HTML writer interface.
10
- */
11
- export default interface HtmlWriter {
12
- /**
13
- * Returns an HTML string created from a document fragment.
14
- */
15
- getHtml(fragment: DocumentFragment): string;
16
- }
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/htmlwriter
7
+ */
8
+ /**
9
+ * The HTML writer interface.
10
+ */
11
+ export default interface HtmlWriter {
12
+ /**
13
+ * Returns an HTML string created from a document fragment.
14
+ */
15
+ getHtml(fragment: DocumentFragment): string;
16
+ }
@@ -1,5 +1,5 @@
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
- export {};
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
+ export {};