@ckeditor/ckeditor5-engine 39.0.2 → 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 (241) hide show
  1. package/package.json +2 -2
  2. package/src/controller/datacontroller.d.ts +334 -334
  3. package/src/controller/datacontroller.js +481 -481
  4. package/src/controller/editingcontroller.d.ts +98 -98
  5. package/src/controller/editingcontroller.js +191 -191
  6. package/src/conversion/conversion.d.ts +478 -478
  7. package/src/conversion/conversion.js +601 -601
  8. package/src/conversion/conversionhelpers.d.ts +26 -26
  9. package/src/conversion/conversionhelpers.js +32 -32
  10. package/src/conversion/downcastdispatcher.d.ts +562 -562
  11. package/src/conversion/downcastdispatcher.js +547 -547
  12. package/src/conversion/downcasthelpers.d.ts +1226 -1226
  13. package/src/conversion/downcasthelpers.js +2183 -2183
  14. package/src/conversion/mapper.d.ts +503 -503
  15. package/src/conversion/mapper.js +536 -536
  16. package/src/conversion/modelconsumable.d.ts +201 -201
  17. package/src/conversion/modelconsumable.js +333 -333
  18. package/src/conversion/upcastdispatcher.d.ts +492 -492
  19. package/src/conversion/upcastdispatcher.js +460 -460
  20. package/src/conversion/upcasthelpers.d.ts +499 -499
  21. package/src/conversion/upcasthelpers.js +950 -950
  22. package/src/conversion/viewconsumable.d.ts +369 -369
  23. package/src/conversion/viewconsumable.js +532 -532
  24. package/src/dataprocessor/basichtmlwriter.d.ts +18 -18
  25. package/src/dataprocessor/basichtmlwriter.js +19 -19
  26. package/src/dataprocessor/dataprocessor.d.ts +61 -61
  27. package/src/dataprocessor/dataprocessor.js +5 -5
  28. package/src/dataprocessor/htmldataprocessor.d.ts +76 -76
  29. package/src/dataprocessor/htmldataprocessor.js +96 -96
  30. package/src/dataprocessor/htmlwriter.d.ts +16 -16
  31. package/src/dataprocessor/htmlwriter.js +5 -5
  32. package/src/dataprocessor/xmldataprocessor.d.ts +90 -90
  33. package/src/dataprocessor/xmldataprocessor.js +108 -108
  34. package/src/dev-utils/model.d.ts +124 -124
  35. package/src/dev-utils/model.js +395 -395
  36. package/src/dev-utils/operationreplayer.d.ts +51 -51
  37. package/src/dev-utils/operationreplayer.js +112 -112
  38. package/src/dev-utils/utils.d.ts +37 -37
  39. package/src/dev-utils/utils.js +73 -73
  40. package/src/dev-utils/view.d.ts +319 -319
  41. package/src/dev-utils/view.js +967 -967
  42. package/src/index.d.ts +114 -114
  43. package/src/index.js +78 -78
  44. package/src/model/batch.d.ts +106 -106
  45. package/src/model/batch.js +96 -96
  46. package/src/model/differ.d.ts +387 -387
  47. package/src/model/differ.js +1149 -1149
  48. package/src/model/document.d.ts +272 -272
  49. package/src/model/document.js +361 -361
  50. package/src/model/documentfragment.d.ts +200 -200
  51. package/src/model/documentfragment.js +306 -306
  52. package/src/model/documentselection.d.ts +420 -420
  53. package/src/model/documentselection.js +993 -993
  54. package/src/model/element.d.ts +165 -165
  55. package/src/model/element.js +281 -281
  56. package/src/model/history.d.ts +114 -114
  57. package/src/model/history.js +207 -207
  58. package/src/model/item.d.ts +14 -14
  59. package/src/model/item.js +5 -5
  60. package/src/model/liveposition.d.ts +77 -77
  61. package/src/model/liveposition.js +93 -93
  62. package/src/model/liverange.d.ts +102 -102
  63. package/src/model/liverange.js +120 -120
  64. package/src/model/markercollection.d.ts +335 -335
  65. package/src/model/markercollection.js +403 -403
  66. package/src/model/model.d.ts +919 -919
  67. package/src/model/model.js +842 -842
  68. package/src/model/node.d.ts +256 -256
  69. package/src/model/node.js +375 -375
  70. package/src/model/nodelist.d.ts +91 -91
  71. package/src/model/nodelist.js +163 -163
  72. package/src/model/operation/attributeoperation.d.ts +103 -103
  73. package/src/model/operation/attributeoperation.js +148 -148
  74. package/src/model/operation/detachoperation.d.ts +60 -60
  75. package/src/model/operation/detachoperation.js +77 -77
  76. package/src/model/operation/insertoperation.d.ts +90 -90
  77. package/src/model/operation/insertoperation.js +135 -135
  78. package/src/model/operation/markeroperation.d.ts +91 -91
  79. package/src/model/operation/markeroperation.js +107 -107
  80. package/src/model/operation/mergeoperation.d.ts +100 -100
  81. package/src/model/operation/mergeoperation.js +167 -167
  82. package/src/model/operation/moveoperation.d.ts +96 -96
  83. package/src/model/operation/moveoperation.js +164 -164
  84. package/src/model/operation/nooperation.d.ts +38 -38
  85. package/src/model/operation/nooperation.js +48 -48
  86. package/src/model/operation/operation.d.ts +96 -96
  87. package/src/model/operation/operation.js +62 -62
  88. package/src/model/operation/operationfactory.d.ts +18 -18
  89. package/src/model/operation/operationfactory.js +44 -44
  90. package/src/model/operation/renameoperation.d.ts +83 -83
  91. package/src/model/operation/renameoperation.js +115 -115
  92. package/src/model/operation/rootattributeoperation.d.ts +98 -98
  93. package/src/model/operation/rootattributeoperation.js +155 -155
  94. package/src/model/operation/rootoperation.d.ts +76 -76
  95. package/src/model/operation/rootoperation.js +90 -90
  96. package/src/model/operation/splitoperation.d.ts +109 -109
  97. package/src/model/operation/splitoperation.js +194 -194
  98. package/src/model/operation/transform.d.ts +100 -100
  99. package/src/model/operation/transform.js +1985 -1985
  100. package/src/model/operation/utils.d.ts +71 -71
  101. package/src/model/operation/utils.js +213 -213
  102. package/src/model/position.d.ts +539 -539
  103. package/src/model/position.js +979 -979
  104. package/src/model/range.d.ts +458 -458
  105. package/src/model/range.js +875 -875
  106. package/src/model/rootelement.d.ts +60 -60
  107. package/src/model/rootelement.js +74 -74
  108. package/src/model/schema.d.ts +1186 -1186
  109. package/src/model/schema.js +1242 -1242
  110. package/src/model/selection.d.ts +482 -482
  111. package/src/model/selection.js +789 -789
  112. package/src/model/text.d.ts +66 -66
  113. package/src/model/text.js +85 -85
  114. package/src/model/textproxy.d.ts +144 -144
  115. package/src/model/textproxy.js +189 -189
  116. package/src/model/treewalker.d.ts +186 -186
  117. package/src/model/treewalker.js +244 -244
  118. package/src/model/typecheckable.d.ts +285 -285
  119. package/src/model/typecheckable.js +16 -16
  120. package/src/model/utils/autoparagraphing.d.ts +37 -37
  121. package/src/model/utils/autoparagraphing.js +63 -63
  122. package/src/model/utils/deletecontent.d.ts +58 -58
  123. package/src/model/utils/deletecontent.js +488 -488
  124. package/src/model/utils/findoptimalinsertionrange.d.ts +32 -32
  125. package/src/model/utils/findoptimalinsertionrange.js +57 -57
  126. package/src/model/utils/getselectedcontent.d.ts +30 -30
  127. package/src/model/utils/getselectedcontent.js +125 -125
  128. package/src/model/utils/insertcontent.d.ts +46 -46
  129. package/src/model/utils/insertcontent.js +705 -705
  130. package/src/model/utils/insertobject.d.ts +44 -44
  131. package/src/model/utils/insertobject.js +139 -139
  132. package/src/model/utils/modifyselection.d.ts +48 -48
  133. package/src/model/utils/modifyselection.js +186 -186
  134. package/src/model/utils/selection-post-fixer.d.ts +74 -74
  135. package/src/model/utils/selection-post-fixer.js +260 -260
  136. package/src/model/writer.d.ts +851 -851
  137. package/src/model/writer.js +1306 -1306
  138. package/src/view/attributeelement.d.ts +108 -108
  139. package/src/view/attributeelement.js +184 -184
  140. package/src/view/containerelement.d.ts +49 -49
  141. package/src/view/containerelement.js +80 -80
  142. package/src/view/datatransfer.d.ts +79 -79
  143. package/src/view/datatransfer.js +98 -98
  144. package/src/view/document.d.ts +184 -184
  145. package/src/view/document.js +120 -120
  146. package/src/view/documentfragment.d.ts +149 -149
  147. package/src/view/documentfragment.js +228 -228
  148. package/src/view/documentselection.d.ts +306 -306
  149. package/src/view/documentselection.js +256 -256
  150. package/src/view/domconverter.d.ts +640 -640
  151. package/src/view/domconverter.js +1450 -1425
  152. package/src/view/downcastwriter.d.ts +996 -996
  153. package/src/view/downcastwriter.js +1696 -1696
  154. package/src/view/editableelement.d.ts +62 -62
  155. package/src/view/editableelement.js +62 -62
  156. package/src/view/element.d.ts +468 -468
  157. package/src/view/element.js +724 -724
  158. package/src/view/elementdefinition.d.ts +87 -87
  159. package/src/view/elementdefinition.js +5 -5
  160. package/src/view/emptyelement.d.ts +41 -41
  161. package/src/view/emptyelement.js +73 -73
  162. package/src/view/filler.d.ts +111 -111
  163. package/src/view/filler.js +150 -150
  164. package/src/view/item.d.ts +14 -14
  165. package/src/view/item.js +5 -5
  166. package/src/view/matcher.d.ts +486 -486
  167. package/src/view/matcher.js +507 -507
  168. package/src/view/node.d.ts +163 -163
  169. package/src/view/node.js +228 -228
  170. package/src/view/observer/arrowkeysobserver.d.ts +45 -45
  171. package/src/view/observer/arrowkeysobserver.js +40 -40
  172. package/src/view/observer/bubblingemittermixin.d.ts +166 -166
  173. package/src/view/observer/bubblingemittermixin.js +172 -172
  174. package/src/view/observer/bubblingeventinfo.d.ts +47 -47
  175. package/src/view/observer/bubblingeventinfo.js +37 -37
  176. package/src/view/observer/clickobserver.d.ts +43 -43
  177. package/src/view/observer/clickobserver.js +29 -29
  178. package/src/view/observer/compositionobserver.d.ts +82 -82
  179. package/src/view/observer/compositionobserver.js +60 -60
  180. package/src/view/observer/domeventdata.d.ts +50 -50
  181. package/src/view/observer/domeventdata.js +47 -47
  182. package/src/view/observer/domeventobserver.d.ts +73 -73
  183. package/src/view/observer/domeventobserver.js +79 -79
  184. package/src/view/observer/fakeselectionobserver.d.ts +47 -47
  185. package/src/view/observer/fakeselectionobserver.js +91 -91
  186. package/src/view/observer/focusobserver.d.ts +82 -82
  187. package/src/view/observer/focusobserver.js +86 -86
  188. package/src/view/observer/inputobserver.d.ts +86 -86
  189. package/src/view/observer/inputobserver.js +164 -164
  190. package/src/view/observer/keyobserver.d.ts +66 -66
  191. package/src/view/observer/keyobserver.js +39 -39
  192. package/src/view/observer/mouseobserver.d.ts +89 -89
  193. package/src/view/observer/mouseobserver.js +29 -29
  194. package/src/view/observer/mutationobserver.d.ts +86 -86
  195. package/src/view/observer/mutationobserver.js +206 -206
  196. package/src/view/observer/observer.d.ts +89 -89
  197. package/src/view/observer/observer.js +84 -84
  198. package/src/view/observer/selectionobserver.d.ts +148 -148
  199. package/src/view/observer/selectionobserver.js +202 -202
  200. package/src/view/observer/tabobserver.d.ts +46 -46
  201. package/src/view/observer/tabobserver.js +42 -42
  202. package/src/view/placeholder.d.ts +96 -96
  203. package/src/view/placeholder.js +267 -267
  204. package/src/view/position.d.ts +189 -189
  205. package/src/view/position.js +324 -324
  206. package/src/view/range.d.ts +279 -279
  207. package/src/view/range.js +430 -430
  208. package/src/view/rawelement.d.ts +73 -73
  209. package/src/view/rawelement.js +105 -105
  210. package/src/view/renderer.d.ts +265 -265
  211. package/src/view/renderer.js +999 -999
  212. package/src/view/rooteditableelement.d.ts +41 -41
  213. package/src/view/rooteditableelement.js +69 -69
  214. package/src/view/selection.d.ts +375 -375
  215. package/src/view/selection.js +559 -559
  216. package/src/view/styles/background.d.ts +33 -33
  217. package/src/view/styles/background.js +74 -74
  218. package/src/view/styles/border.d.ts +43 -43
  219. package/src/view/styles/border.js +316 -316
  220. package/src/view/styles/margin.d.ts +29 -29
  221. package/src/view/styles/margin.js +34 -34
  222. package/src/view/styles/padding.d.ts +29 -29
  223. package/src/view/styles/padding.js +34 -34
  224. package/src/view/styles/utils.d.ts +93 -93
  225. package/src/view/styles/utils.js +219 -219
  226. package/src/view/stylesmap.d.ts +675 -675
  227. package/src/view/stylesmap.js +766 -766
  228. package/src/view/text.d.ts +74 -74
  229. package/src/view/text.js +93 -93
  230. package/src/view/textproxy.d.ts +97 -97
  231. package/src/view/textproxy.js +124 -124
  232. package/src/view/treewalker.d.ts +195 -195
  233. package/src/view/treewalker.js +327 -327
  234. package/src/view/typecheckable.d.ts +448 -448
  235. package/src/view/typecheckable.js +19 -19
  236. package/src/view/uielement.d.ts +96 -96
  237. package/src/view/uielement.js +182 -182
  238. package/src/view/upcastwriter.d.ts +417 -417
  239. package/src/view/upcastwriter.js +359 -359
  240. package/src/view/view.d.ts +487 -487
  241. package/src/view/view.js +546 -546
@@ -1,120 +1,120 @@
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/model/liverange
7
- */
8
- import Range from './range';
9
- import { EmitterMixin } from '@ckeditor/ckeditor5-utils';
10
- /**
11
- * `LiveRange` is a type of {@link module:engine/model/range~Range Range}
12
- * that updates itself as {@link module:engine/model/document~Document document}
13
- * is changed through operations. It may be used as a bookmark.
14
- *
15
- * **Note:** Be very careful when dealing with `LiveRange`. Each `LiveRange` instance bind events that might
16
- * have to be unbound. Use {@link module:engine/model/liverange~LiveRange#detach detach} whenever you don't need `LiveRange` anymore.
17
- */
18
- export default class LiveRange extends EmitterMixin(Range) {
19
- /**
20
- * Creates a live range.
21
- *
22
- * @see module:engine/model/range~Range
23
- */
24
- constructor(start, end) {
25
- super(start, end);
26
- bindWithDocument.call(this);
27
- }
28
- /**
29
- * Unbinds all events previously bound by `LiveRange`. Use it whenever you don't need `LiveRange` instance
30
- * anymore (i.e. when leaving scope in which it was declared or before re-assigning variable that was
31
- * referring to it).
32
- */
33
- detach() {
34
- this.stopListening();
35
- }
36
- /**
37
- * Creates a {@link module:engine/model/range~Range range instance} that is equal to this live range.
38
- */
39
- toRange() {
40
- return new Range(this.start, this.end);
41
- }
42
- /**
43
- * Creates a `LiveRange` instance that is equal to the given range.
44
- */
45
- static fromRange(range) {
46
- return new LiveRange(range.start, range.end);
47
- }
48
- }
49
- // The magic of type inference using `is` method is centralized in `TypeCheckable` class.
50
- // Proper overload would interfere with that.
51
- LiveRange.prototype.is = function (type) {
52
- return type === 'liveRange' || type === 'model:liveRange' ||
53
- // From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
54
- type == 'range' || type === 'model:range';
55
- };
56
- /**
57
- * Binds this `LiveRange` to the {@link module:engine/model/document~Document document}
58
- * that owns this range's {@link module:engine/model/range~Range#root root}.
59
- */
60
- function bindWithDocument() {
61
- this.listenTo(this.root.document.model, 'applyOperation', (event, args) => {
62
- const operation = args[0];
63
- if (!operation.isDocumentOperation) {
64
- return;
65
- }
66
- transform.call(this, operation);
67
- }, { priority: 'low' });
68
- }
69
- /**
70
- * Updates this range accordingly to the updates applied to the model. Bases on change events.
71
- */
72
- function transform(operation) {
73
- // Transform the range by the operation. Join the result ranges if needed.
74
- const ranges = this.getTransformedByOperation(operation);
75
- const result = Range._createFromRanges(ranges);
76
- const boundariesChanged = !result.isEqual(this);
77
- const contentChanged = doesOperationChangeRangeContent(this, operation);
78
- let deletionPosition = null;
79
- if (boundariesChanged) {
80
- // If range boundaries have changed, fire `change:range` event.
81
- //
82
- if (result.root.rootName == '$graveyard') {
83
- // If the range was moved to the graveyard root, set `deletionPosition`.
84
- if (operation.type == 'remove') {
85
- deletionPosition = operation.sourcePosition;
86
- }
87
- else {
88
- // Merge operation.
89
- deletionPosition = operation.deletionPosition;
90
- }
91
- }
92
- const oldRange = this.toRange();
93
- this.start = result.start;
94
- this.end = result.end;
95
- this.fire('change:range', oldRange, { deletionPosition });
96
- }
97
- else if (contentChanged) {
98
- // If range boundaries have not changed, but there was change inside the range, fire `change:content` event.
99
- this.fire('change:content', this.toRange(), { deletionPosition });
100
- }
101
- }
102
- /**
103
- * Checks whether given operation changes something inside the range (even if it does not change boundaries).
104
- */
105
- function doesOperationChangeRangeContent(range, operation) {
106
- switch (operation.type) {
107
- case 'insert':
108
- return range.containsPosition(operation.position);
109
- case 'move':
110
- case 'remove':
111
- case 'reinsert':
112
- case 'merge':
113
- return range.containsPosition(operation.sourcePosition) ||
114
- range.start.isEqual(operation.sourcePosition) ||
115
- range.containsPosition(operation.targetPosition);
116
- case 'split':
117
- return range.containsPosition(operation.splitPosition) || range.containsPosition(operation.insertionPosition);
118
- }
119
- return false;
120
- }
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/model/liverange
7
+ */
8
+ import Range from './range';
9
+ import { EmitterMixin } from '@ckeditor/ckeditor5-utils';
10
+ /**
11
+ * `LiveRange` is a type of {@link module:engine/model/range~Range Range}
12
+ * that updates itself as {@link module:engine/model/document~Document document}
13
+ * is changed through operations. It may be used as a bookmark.
14
+ *
15
+ * **Note:** Be very careful when dealing with `LiveRange`. Each `LiveRange` instance bind events that might
16
+ * have to be unbound. Use {@link module:engine/model/liverange~LiveRange#detach detach} whenever you don't need `LiveRange` anymore.
17
+ */
18
+ export default class LiveRange extends EmitterMixin(Range) {
19
+ /**
20
+ * Creates a live range.
21
+ *
22
+ * @see module:engine/model/range~Range
23
+ */
24
+ constructor(start, end) {
25
+ super(start, end);
26
+ bindWithDocument.call(this);
27
+ }
28
+ /**
29
+ * Unbinds all events previously bound by `LiveRange`. Use it whenever you don't need `LiveRange` instance
30
+ * anymore (i.e. when leaving scope in which it was declared or before re-assigning variable that was
31
+ * referring to it).
32
+ */
33
+ detach() {
34
+ this.stopListening();
35
+ }
36
+ /**
37
+ * Creates a {@link module:engine/model/range~Range range instance} that is equal to this live range.
38
+ */
39
+ toRange() {
40
+ return new Range(this.start, this.end);
41
+ }
42
+ /**
43
+ * Creates a `LiveRange` instance that is equal to the given range.
44
+ */
45
+ static fromRange(range) {
46
+ return new LiveRange(range.start, range.end);
47
+ }
48
+ }
49
+ // The magic of type inference using `is` method is centralized in `TypeCheckable` class.
50
+ // Proper overload would interfere with that.
51
+ LiveRange.prototype.is = function (type) {
52
+ return type === 'liveRange' || type === 'model:liveRange' ||
53
+ // From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
54
+ type == 'range' || type === 'model:range';
55
+ };
56
+ /**
57
+ * Binds this `LiveRange` to the {@link module:engine/model/document~Document document}
58
+ * that owns this range's {@link module:engine/model/range~Range#root root}.
59
+ */
60
+ function bindWithDocument() {
61
+ this.listenTo(this.root.document.model, 'applyOperation', (event, args) => {
62
+ const operation = args[0];
63
+ if (!operation.isDocumentOperation) {
64
+ return;
65
+ }
66
+ transform.call(this, operation);
67
+ }, { priority: 'low' });
68
+ }
69
+ /**
70
+ * Updates this range accordingly to the updates applied to the model. Bases on change events.
71
+ */
72
+ function transform(operation) {
73
+ // Transform the range by the operation. Join the result ranges if needed.
74
+ const ranges = this.getTransformedByOperation(operation);
75
+ const result = Range._createFromRanges(ranges);
76
+ const boundariesChanged = !result.isEqual(this);
77
+ const contentChanged = doesOperationChangeRangeContent(this, operation);
78
+ let deletionPosition = null;
79
+ if (boundariesChanged) {
80
+ // If range boundaries have changed, fire `change:range` event.
81
+ //
82
+ if (result.root.rootName == '$graveyard') {
83
+ // If the range was moved to the graveyard root, set `deletionPosition`.
84
+ if (operation.type == 'remove') {
85
+ deletionPosition = operation.sourcePosition;
86
+ }
87
+ else {
88
+ // Merge operation.
89
+ deletionPosition = operation.deletionPosition;
90
+ }
91
+ }
92
+ const oldRange = this.toRange();
93
+ this.start = result.start;
94
+ this.end = result.end;
95
+ this.fire('change:range', oldRange, { deletionPosition });
96
+ }
97
+ else if (contentChanged) {
98
+ // If range boundaries have not changed, but there was change inside the range, fire `change:content` event.
99
+ this.fire('change:content', this.toRange(), { deletionPosition });
100
+ }
101
+ }
102
+ /**
103
+ * Checks whether given operation changes something inside the range (even if it does not change boundaries).
104
+ */
105
+ function doesOperationChangeRangeContent(range, operation) {
106
+ switch (operation.type) {
107
+ case 'insert':
108
+ return range.containsPosition(operation.position);
109
+ case 'move':
110
+ case 'remove':
111
+ case 'reinsert':
112
+ case 'merge':
113
+ return range.containsPosition(operation.sourcePosition) ||
114
+ range.start.isEqual(operation.sourcePosition) ||
115
+ range.containsPosition(operation.targetPosition);
116
+ case 'split':
117
+ return range.containsPosition(operation.splitPosition) || range.containsPosition(operation.insertionPosition);
118
+ }
119
+ return false;
120
+ }