@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,562 +1,562 @@
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/conversion/downcastdispatcher
7
- */
8
- import Consumable from './modelconsumable';
9
- import Range from '../model/range';
10
- import type { default as Differ, DiffItem } from '../model/differ';
11
- import type { default as MarkerCollection } from '../model/markercollection';
12
- import type DocumentSelection from '../model/documentselection';
13
- import type DowncastWriter from '../view/downcastwriter';
14
- import type Element from '../model/element';
15
- import type Item from '../model/item';
16
- import type Mapper from './mapper';
17
- import type Position from '../model/position';
18
- import type Schema from '../model/schema';
19
- import type Selection from '../model/selection';
20
- import type ViewElement from '../view/element';
21
- declare const DowncastDispatcher_base: {
22
- new (): import("@ckeditor/ckeditor5-utils").Emitter;
23
- prototype: import("@ckeditor/ckeditor5-utils").Emitter;
24
- };
25
- /**
26
- * The downcast dispatcher is a central point of downcasting (conversion from the model to the view), which is a process of reacting
27
- * to changes in the model and firing a set of events. The callbacks listening to these events are called converters. The
28
- * converters' role is to convert the model changes to changes in view (for example, adding view nodes or
29
- * changing attributes on view elements).
30
- *
31
- * During the conversion process, downcast dispatcher fires events basing on the state of the model and prepares
32
- * data for these events. It is important to understand that the events are connected with the changes done on the model,
33
- * for example: "a node has been inserted" or "an attribute has changed". This is in contrary to upcasting (a view-to-model conversion)
34
- * where you convert the view state (view nodes) to a model tree.
35
- *
36
- * The events are prepared basing on a diff created by the {@link module:engine/model/differ~Differ Differ}, which buffers them
37
- * and then passes to the downcast dispatcher as a diff between the old model state and the new model state.
38
- *
39
- * Note that because the changes are converted, there is a need to have a mapping between the model structure and the view structure.
40
- * To map positions and elements during the downcast (a model-to-view conversion), use {@link module:engine/conversion/mapper~Mapper}.
41
- *
42
- * Downcast dispatcher fires the following events for model tree changes:
43
- *
44
- * * {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:insert `insert`} –
45
- * If a range of nodes was inserted to the model tree.
46
- * * {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:remove `remove`} –
47
- * If a range of nodes was removed from the model tree.
48
- * * {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:attribute `attribute`} –
49
- * If an attribute was added, changed or removed from a model node.
50
- *
51
- * For {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:insert `insert`}
52
- * and {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:attribute `attribute`},
53
- * the downcast dispatcher generates {@link module:engine/conversion/modelconsumable~ModelConsumable consumables}.
54
- * These are used to have control over which changes have already been consumed. It is useful when some converters
55
- * overwrite others or convert multiple changes (for example, it converts an insertion of an element and also converts that
56
- * element's attributes during the insertion).
57
- *
58
- * Additionally, downcast dispatcher fires events for {@link module:engine/model/markercollection~Marker marker} changes:
59
- *
60
- * * {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:addMarker `addMarker`} – If a marker was added.
61
- * * {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:removeMarker `removeMarker`} – If a marker was
62
- * removed.
63
- *
64
- * Note that changing a marker is done through removing the marker from the old range and adding it to the new range,
65
- * so both of these events are fired.
66
- *
67
- * Finally, a downcast dispatcher also handles firing events for the {@link module:engine/model/selection model selection}
68
- * conversion:
69
- *
70
- * * {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:selection `selection`}
71
- * – Converts the selection from the model to the view.
72
- * * {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:attribute `attribute`}
73
- * – Fired for every selection attribute.
74
- * * {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:addMarker `addMarker`}
75
- * – Fired for every marker that contains a selection.
76
- *
77
- * Unlike the model tree and the markers, the events for selection are not fired for changes but for a selection state.
78
- *
79
- * When providing custom listeners for a downcast dispatcher, remember to check whether a given change has not been
80
- * {@link module:engine/conversion/modelconsumable~ModelConsumable#consume consumed} yet.
81
- *
82
- * When providing custom listeners for a downcast dispatcher, keep in mind that you **should not** stop the event. If you stop it,
83
- * then the default converter at the `lowest` priority will not trigger the conversion of this node's attributes and child nodes.
84
- *
85
- * When providing custom listeners for a downcast dispatcher, remember to use the provided
86
- * {@link module:engine/view/downcastwriter~DowncastWriter view downcast writer} to apply changes to the view document.
87
- *
88
- * You can read more about conversion in the following guide:
89
- *
90
- * * {@glink framework/deep-dive/conversion/downcast Downcast conversion}
91
- *
92
- * An example of a custom converter for the downcast dispatcher:
93
- *
94
- * ```ts
95
- * // You will convert inserting a "paragraph" model element into the model.
96
- * downcastDispatcher.on( 'insert:paragraph', ( evt, data, conversionApi ) => {
97
- * // Remember to check whether the change has not been consumed yet and consume it.
98
- * if ( !conversionApi.consumable.consume( data.item, 'insert' ) ) {
99
- * return;
100
- * }
101
- *
102
- * // Translate the position in the model to a position in the view.
103
- * const viewPosition = conversionApi.mapper.toViewPosition( data.range.start );
104
- *
105
- * // Create a <p> element that will be inserted into the view at the `viewPosition`.
106
- * const viewElement = conversionApi.writer.createContainerElement( 'p' );
107
- *
108
- * // Bind the newly created view element to the model element so positions will map accordingly in the future.
109
- * conversionApi.mapper.bindElements( data.item, viewElement );
110
- *
111
- * // Add the newly created view element to the view.
112
- * conversionApi.writer.insert( viewPosition, viewElement );
113
- * } );
114
- * ```
115
- */
116
- export default class DowncastDispatcher extends DowncastDispatcher_base {
117
- /**
118
- * A template for an interface passed by the dispatcher to the event callbacks.
119
- *
120
- * @internal
121
- */
122
- readonly _conversionApi: Pick<DowncastConversionApi, 'dispatcher' | 'mapper' | 'schema'>;
123
- /**
124
- * A map of already fired events for a given `ModelConsumable`.
125
- */
126
- private readonly _firedEventsMap;
127
- /**
128
- * Creates a downcast dispatcher instance.
129
- *
130
- * @see module:engine/conversion/downcastdispatcher~DowncastConversionApi
131
- *
132
- * @param conversionApi Additional properties for an interface that will be passed to events fired
133
- * by the downcast dispatcher.
134
- */
135
- constructor(conversionApi: Pick<DowncastConversionApi, 'mapper' | 'schema'>);
136
- /**
137
- * Converts changes buffered in the given {@link module:engine/model/differ~Differ model differ}
138
- * and fires conversion events based on it.
139
- *
140
- * @fires insert
141
- * @fires remove
142
- * @fires attribute
143
- * @fires addMarker
144
- * @fires removeMarker
145
- * @fires reduceChanges
146
- * @param differ The differ object with buffered changes.
147
- * @param markers Markers related to the model fragment to convert.
148
- * @param writer The view writer that should be used to modify the view document.
149
- */
150
- convertChanges(differ: Differ, markers: MarkerCollection, writer: DowncastWriter): void;
151
- /**
152
- * Starts a conversion of a model range and the provided markers.
153
- *
154
- * @fires insert
155
- * @fires attribute
156
- * @fires addMarker
157
- * @param range The inserted range.
158
- * @param markers The map of markers that should be down-casted.
159
- * @param writer The view writer that should be used to modify the view document.
160
- * @param options Optional options object passed to `convertionApi.options`.
161
- */
162
- convert(range: Range, markers: Map<string, Range>, writer: DowncastWriter, options?: DowncastConversionApi['options']): void;
163
- /**
164
- * Starts the model selection conversion.
165
- *
166
- * Fires events for a given {@link module:engine/model/selection~Selection selection} to start the selection conversion.
167
- *
168
- * @fires selection
169
- * @fires addMarker
170
- * @fires attribute
171
- * @param selection The selection to convert.
172
- * @param markers Markers connected with the converted model.
173
- * @param writer View writer that should be used to modify the view document.
174
- */
175
- convertSelection(selection: Selection | DocumentSelection, markers: MarkerCollection, writer: DowncastWriter): void;
176
- /**
177
- * Fires insertion conversion of a range of nodes.
178
- *
179
- * For each node in the range, {@link #event:insert `insert` event is fired}. For each attribute on each node,
180
- * {@link #event:attribute `attribute` event is fired}.
181
- *
182
- * @fires insert
183
- * @fires attribute
184
- * @param range The inserted range.
185
- * @param conversionApi The conversion API object.
186
- * @param options.doNotAddConsumables Whether the ModelConsumable should not get populated
187
- * for items in the provided range.
188
- */
189
- private _convertInsert;
190
- /**
191
- * Fires conversion of a single node removal. Fires {@link #event:remove remove event} with provided data.
192
- *
193
- * @param position Position from which node was removed.
194
- * @param length Offset size of removed node.
195
- * @param name Name of removed node.
196
- * @param conversionApi The conversion API object.
197
- */
198
- private _convertRemove;
199
- /**
200
- * Starts a conversion of an attribute change on a given `range`.
201
- *
202
- * For each node in the given `range`, {@link #event:attribute attribute event} is fired with the passed data.
203
- *
204
- * @fires attribute
205
- * @param range Changed range.
206
- * @param key Key of the attribute that has changed.
207
- * @param oldValue Attribute value before the change or `null` if the attribute has not been set before.
208
- * @param newValue New attribute value or `null` if the attribute has been removed.
209
- * @param conversionApi The conversion API object.
210
- */
211
- private _convertAttribute;
212
- /**
213
- * Fires re-insertion conversion (with a `reconversion` flag passed to `insert` events)
214
- * of a range of elements (only elements on the range depth, without children).
215
- *
216
- * For each node in the range on its depth (without children), {@link #event:insert `insert` event} is fired.
217
- * For each attribute on each node, {@link #event:attribute `attribute` event} is fired.
218
- *
219
- * @fires insert
220
- * @fires attribute
221
- * @param range The range to reinsert.
222
- * @param conversionApi The conversion API object.
223
- */
224
- private _convertReinsert;
225
- /**
226
- * Converts the added marker. Fires the {@link #event:addMarker `addMarker`} event for each item
227
- * in the marker's range. If the range is collapsed, a single event is dispatched. See the event description for more details.
228
- *
229
- * @fires addMarker
230
- * @param markerName Marker name.
231
- * @param markerRange The marker range.
232
- * @param conversionApi The conversion API object.
233
- */
234
- private _convertMarkerAdd;
235
- /**
236
- * Fires the conversion of the marker removal. Fires the {@link #event:removeMarker `removeMarker`} event with the provided data.
237
- *
238
- * @fires removeMarker
239
- * @param markerName Marker name.
240
- * @param markerRange The marker range.
241
- * @param conversionApi The conversion API object.
242
- */
243
- private _convertMarkerRemove;
244
- /**
245
- * Fires the reduction of changes buffered in the {@link module:engine/model/differ~Differ `Differ`}.
246
- *
247
- * Features can replace selected {@link module:engine/model/differ~DiffItem `DiffItem`}s with `reinsert` entries to trigger
248
- * reconversion. The {@link module:engine/conversion/downcasthelpers~DowncastHelpers#elementToStructure
249
- * `DowncastHelpers.elementToStructure()`} is using this event to trigger reconversion.
250
- *
251
- * @fires reduceChanges
252
- */
253
- private _reduceChanges;
254
- /**
255
- * Populates provided {@link module:engine/conversion/modelconsumable~ModelConsumable} with values to consume from a given range,
256
- * assuming that the range has just been inserted to the model.
257
- *
258
- * @param consumable The consumable.
259
- * @param walkerValues The walker values for the inserted range.
260
- * @returns The values to consume.
261
- */
262
- private _addConsumablesForInsert;
263
- /**
264
- * Populates provided {@link module:engine/conversion/modelconsumable~ModelConsumable} with values to consume for a given range.
265
- *
266
- * @param consumable The consumable.
267
- * @param range The affected range.
268
- * @param type Consumable type.
269
- * @returns The values to consume.
270
- */
271
- private _addConsumablesForRange;
272
- /**
273
- * Populates provided {@link module:engine/conversion/modelconsumable~ModelConsumable} with selection consumable values.
274
- *
275
- * @param consumable The consumable.
276
- * @param selection The selection to create the consumable from.
277
- * @param markers Markers that contain the selection.
278
- * @returns The values to consume.
279
- */
280
- private _addConsumablesForSelection;
281
- /**
282
- * Tests whether given event wasn't already fired and if so, fires it.
283
- *
284
- * @fires insert
285
- * @fires attribute
286
- * @param type Event type.
287
- * @param data Event data.
288
- * @param conversionApi The conversion API object.
289
- */
290
- private _testAndFire;
291
- /**
292
- * Fires not already fired events for setting attributes on just inserted item.
293
- *
294
- * @param item The model item to convert attributes for.
295
- * @param conversionApi The conversion API object.
296
- */
297
- private _testAndFireAddAttributes;
298
- /**
299
- * Builds an instance of the {@link module:engine/conversion/downcastdispatcher~DowncastConversionApi} from a template and a given
300
- * {@link module:engine/view/downcastwriter~DowncastWriter `DowncastWriter`} and options object.
301
- *
302
- * @param writer View writer that should be used to modify the view document.
303
- * @param refreshedItems A set of model elements that should not reuse their
304
- * previous view representations.
305
- * @param options Optional options passed to `convertionApi.options`.
306
- * @return The conversion API object.
307
- */
308
- private _createConversionApi;
309
- }
310
- /**
311
- * Fired to enable reducing (transforming) changes buffered in the {@link module:engine/model/differ~Differ `Differ`} before
312
- * {@link ~DowncastDispatcher#convertChanges `convertChanges()`} will fire any conversion events.
313
- *
314
- * For instance, a feature can replace selected {@link module:engine/model/differ~DiffItem `DiffItem`}s with a `reinsert` entry
315
- * to trigger reconversion of an element when e.g. its attribute has changes.
316
- * The {@link module:engine/conversion/downcasthelpers~DowncastHelpers#elementToStructure
317
- * `DowncastHelpers.elementToStructure()`} helper is using this event to trigger reconversion of an element when the element,
318
- * its attributes or direct children changed.
319
- *
320
- * @eventName ~DowncastDispatcher#reduceChanges
321
- */
322
- export type DowncastReduceChangesEvent = {
323
- name: 'reduceChanges';
324
- args: [data: DowncastReduceChangesEventData];
325
- };
326
- export type DowncastReduceChangesEventData = {
327
- /**
328
- * A buffered changes to get reduced.
329
- */
330
- changes: Iterable<DiffItem | DiffItemReinsert>;
331
- };
332
- type EventMap<TItem = Item> = {
333
- insert: {
334
- item: TItem;
335
- range: Range;
336
- reconversion?: boolean;
337
- };
338
- remove: {
339
- position: Position;
340
- length: number;
341
- };
342
- attribute: {
343
- item: TItem;
344
- range: Range;
345
- attributeKey: string;
346
- attributeOldValue: unknown;
347
- attributeNewValue: unknown;
348
- };
349
- cleanSelection: {
350
- selection: Selection | DocumentSelection;
351
- };
352
- selection: {
353
- selection: Selection | DocumentSelection;
354
- };
355
- addMarker: {
356
- item?: Item | Selection | DocumentSelection;
357
- range?: Range;
358
- markerRange: Range;
359
- markerName: string;
360
- };
361
- removeMarker: {
362
- markerRange: Range;
363
- markerName: string;
364
- };
365
- };
366
- export type DowncastEvent<TName extends keyof EventMap<TItem>, TItem = Item> = {
367
- name: TName | `${TName}:${string}`;
368
- args: [data: EventMap<TItem>[TName], conversionApi: DowncastConversionApi];
369
- };
370
- /**
371
- * Fired for inserted nodes.
372
- *
373
- * `insert` is a namespace for a class of events. Names of actually called events follow this pattern:
374
- * `insert:name`. `name` is either `'$text'`, when {@link module:engine/model/text~Text a text node} has been inserted,
375
- * or {@link module:engine/model/element~Element#name name} of inserted element.
376
- *
377
- * This way, the listeners can either listen to a general `insert` event or specific event (for example `insert:paragraph`).
378
- *
379
- * @eventName ~DowncastDispatcher#insert
380
- * @param {Object} data Additional information about the change.
381
- * @param {module:engine/model/item~Item} data.item The inserted item.
382
- * @param {module:engine/model/range~Range} data.range Range spanning over inserted item.
383
- * @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi Conversion interface
384
- * to be used by callback, passed in the `DowncastDispatcher` constructor.
385
- */
386
- export type DowncastInsertEvent<TItem extends Item = Item> = DowncastEvent<'insert', TItem>;
387
- /**
388
- * Fired for removed nodes.
389
- *
390
- * `remove` is a namespace for a class of events. Names of actually called events follow this pattern:
391
- * `remove:name`. `name` is either `'$text'`, when a {@link module:engine/model/text~Text a text node} has been removed,
392
- * or the {@link module:engine/model/element~Element#name name} of removed element.
393
- *
394
- * This way, listeners can either listen to a general `remove` event or specific event (for example `remove:paragraph`).
395
- *
396
- * @eventName ~DowncastDispatcher#remove
397
- * @param {Object} data Additional information about the change.
398
- * @param {module:engine/model/position~Position} data.position Position from which the node has been removed.
399
- * @param {Number} data.length Offset size of the removed node.
400
- * @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi Conversion interface
401
- * to be used by callback, passed in `DowncastDispatcher` constructor.
402
- */
403
- export type DowncastRemoveEvent = DowncastEvent<'remove'>;
404
- /**
405
- * Fired in the following cases:
406
- *
407
- * * when an attribute has been added, changed, or removed from a node,
408
- * * when a node with an attribute is inserted,
409
- * * when a collapsed model selection attribute is converted.
410
- *
411
- * `attribute` is a namespace for a class of events. Names of actually called events follow this pattern:
412
- * `attribute:attributeKey:name`. `attributeKey` is the key of added/changed/removed attribute.
413
- * `name` is either `'$text'` if change was on {@link module:engine/model/text~Text a text node},
414
- * or the {@link module:engine/model/element~Element#name name} of element which attribute has changed.
415
- *
416
- * This way listeners can either listen to a general `attribute:bold` event or specific event (for example `attribute:src:imageBlock`).
417
- *
418
- * @eventName ~DowncastDispatcher#attribute
419
- * @param {Object} data Additional information about the change.
420
- * @param {module:engine/model/item~Item|module:engine/model/documentselection~DocumentSelection} data.item Changed item
421
- * or converted selection.
422
- * @param {module:engine/model/range~Range} data.range Range spanning over changed item or selection range.
423
- * @param {String} data.attributeKey Attribute key.
424
- * @param {*} data.attributeOldValue Attribute value before the change. This is `null` when selection attribute is converted.
425
- * @param {*} data.attributeNewValue New attribute value.
426
- * @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi Conversion interface
427
- * to be used by callback, passed in `DowncastDispatcher` constructor.
428
- */
429
- export type DowncastAttributeEvent<TItem = Item | Selection | DocumentSelection> = DowncastEvent<'attribute', TItem>;
430
- /**
431
- * Fired for {@link module:engine/model/selection~Selection selection} changes.
432
- *
433
- * @eventName ~DowncastDispatcher#selection
434
- * @param {module:engine/model/selection~Selection} selection Selection that is converted.
435
- * @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi Conversion interface
436
- * to be used by callback, passed in `DowncastDispatcher` constructor.
437
- */
438
- export type DowncastSelectionEvent = DowncastEvent<'selection'>;
439
- /**
440
- * Fired at the beginning of selection conversion, before
441
- * {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:selection selection} events.
442
- *
443
- * Should be used to clean up the view state at the current selection position, before the selection is moved to another place.
444
- *
445
- * @eventName ~DowncastDispatcher#cleanSelection
446
- * @param {module:engine/model/selection~Selection} selection Selection that is converted.
447
- * @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi Conversion interface
448
- * to be used by callback, passed in `DowncastDispatcher` constructor.
449
- */
450
- export type DowncastCleanSelectionEvent = DowncastEvent<'cleanSelection'>;
451
- /**
452
- * Fired when a new marker is added to the model. Also fired when a collapsed model selection that is inside a marker is converted.
453
- *
454
- * `addMarker` is a namespace for a class of events. Names of actually called events follow this pattern:
455
- * `addMarker:markerName`. By specifying certain marker names, you can make the events even more gradual. For example,
456
- * if markers are named `foo:abc`, `foo:bar`, then it is possible to listen to `addMarker:foo` or `addMarker:foo:abc` and
457
- * `addMarker:foo:bar` events.
458
- *
459
- * If the marker range is not collapsed:
460
- *
461
- * * the event is fired for each item in the marker range one by one,
462
- * * `conversionApi.consumable` includes each item of the marker range and the consumable value is same as the event name.
463
- *
464
- * If the marker range is collapsed:
465
- *
466
- * * there is only one event,
467
- * * `conversionApi.consumable` includes marker range with the event name.
468
- *
469
- * If the selection inside a marker is converted:
470
- *
471
- * * there is only one event,
472
- * * `conversionApi.consumable` includes the selection instance with the event name.
473
- *
474
- * @eventName ~DowncastDispatcher#addMarker
475
- * @param {Object} data Additional information about the change.
476
- * @param {module:engine/model/item~Item|module:engine/model/selection~Selection} data.item Item inside the new marker or
477
- * the selection that is being converted.
478
- * @param {module:engine/model/range~Range} [data.range] Range spanning over converted item. Available only in marker conversion, if
479
- * the marker range was not collapsed.
480
- * @param {module:engine/model/range~Range} data.markerRange Marker range.
481
- * @param {String} data.markerName Marker name.
482
- * @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi Conversion interface
483
- * to be used by callback, passed in `DowncastDispatcher` constructor.
484
- */
485
- export type DowncastAddMarkerEvent = DowncastEvent<'addMarker'>;
486
- /**
487
- * Fired when a marker is removed from the model.
488
- *
489
- * `removeMarker` is a namespace for a class of events. Names of actually called events follow this pattern:
490
- * `removeMarker:markerName`. By specifying certain marker names, you can make the events even more gradual. For example,
491
- * if markers are named `foo:abc`, `foo:bar`, then it is possible to listen to `removeMarker:foo` or `removeMarker:foo:abc` and
492
- * `removeMarker:foo:bar` events.
493
- *
494
- * @eventName ~DowncastDispatcher#removeMarker
495
- * @param {Object} data Additional information about the change.
496
- * @param {module:engine/model/range~Range} data.markerRange Marker range.
497
- * @param {String} data.markerName Marker name.
498
- * @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi Conversion interface
499
- * to be used by callback, passed in `DowncastDispatcher` constructor.
500
- */
501
- export type DowncastRemoveMarkerEvent = DowncastEvent<'removeMarker'>;
502
- export interface DiffItemReinsert {
503
- type: 'reinsert';
504
- name: string;
505
- position: Position;
506
- length: number;
507
- }
508
- /**
509
- * Conversion interface that is registered for given {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher}
510
- * and is passed as one of parameters when {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher dispatcher}
511
- * fires its events.
512
- */
513
- export interface DowncastConversionApi {
514
- /**
515
- * The {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher} instance.
516
- */
517
- dispatcher: DowncastDispatcher;
518
- /**
519
- * Stores the information about what parts of a processed model item are still waiting to be handled. After a piece of a model item was
520
- * converted, an appropriate consumable value should be {@link module:engine/conversion/modelconsumable~ModelConsumable#consume
521
- * consumed}.
522
- */
523
- consumable: Consumable;
524
- /**
525
- * The {@link module:engine/conversion/mapper~Mapper} instance.
526
- */
527
- mapper: Mapper;
528
- /**
529
- * The {@link module:engine/model/schema~Schema} instance set for the model that is downcast.
530
- */
531
- schema: Schema;
532
- /**
533
- * The {@link module:engine/view/downcastwriter~DowncastWriter} instance used to manipulate the data during conversion.
534
- */
535
- writer: DowncastWriter;
536
- /**
537
- * An object with an additional configuration which can be used during the conversion process.
538
- * Available only for data downcast conversion.
539
- */
540
- options: Record<string, unknown>;
541
- /**
542
- * Triggers conversion of a specified item.
543
- * This conversion is triggered within (as a separate process of) the parent conversion.
544
- *
545
- * @param item The model item to trigger nested insert conversion on.
546
- */
547
- convertItem(item: Item): void;
548
- /**
549
- * Triggers conversion of children of a specified element.
550
- *
551
- * @param element The model element to trigger children insert conversion on.
552
- */
553
- convertChildren(element: Element): void;
554
- /**
555
- * Triggers conversion of attributes of a specified item.
556
- *
557
- * @param item The model item to trigger attribute conversion on.
558
- */
559
- convertAttributes(item: Item): void;
560
- canReuseView(element: ViewElement): boolean;
561
- }
562
- 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
+ /**
6
+ * @module engine/conversion/downcastdispatcher
7
+ */
8
+ import Consumable from './modelconsumable';
9
+ import Range from '../model/range';
10
+ import type { default as Differ, DiffItem } from '../model/differ';
11
+ import type { default as MarkerCollection } from '../model/markercollection';
12
+ import type DocumentSelection from '../model/documentselection';
13
+ import type DowncastWriter from '../view/downcastwriter';
14
+ import type Element from '../model/element';
15
+ import type Item from '../model/item';
16
+ import type Mapper from './mapper';
17
+ import type Position from '../model/position';
18
+ import type Schema from '../model/schema';
19
+ import type Selection from '../model/selection';
20
+ import type ViewElement from '../view/element';
21
+ declare const DowncastDispatcher_base: {
22
+ new (): import("@ckeditor/ckeditor5-utils").Emitter;
23
+ prototype: import("@ckeditor/ckeditor5-utils").Emitter;
24
+ };
25
+ /**
26
+ * The downcast dispatcher is a central point of downcasting (conversion from the model to the view), which is a process of reacting
27
+ * to changes in the model and firing a set of events. The callbacks listening to these events are called converters. The
28
+ * converters' role is to convert the model changes to changes in view (for example, adding view nodes or
29
+ * changing attributes on view elements).
30
+ *
31
+ * During the conversion process, downcast dispatcher fires events basing on the state of the model and prepares
32
+ * data for these events. It is important to understand that the events are connected with the changes done on the model,
33
+ * for example: "a node has been inserted" or "an attribute has changed". This is in contrary to upcasting (a view-to-model conversion)
34
+ * where you convert the view state (view nodes) to a model tree.
35
+ *
36
+ * The events are prepared basing on a diff created by the {@link module:engine/model/differ~Differ Differ}, which buffers them
37
+ * and then passes to the downcast dispatcher as a diff between the old model state and the new model state.
38
+ *
39
+ * Note that because the changes are converted, there is a need to have a mapping between the model structure and the view structure.
40
+ * To map positions and elements during the downcast (a model-to-view conversion), use {@link module:engine/conversion/mapper~Mapper}.
41
+ *
42
+ * Downcast dispatcher fires the following events for model tree changes:
43
+ *
44
+ * * {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:insert `insert`} &ndash;
45
+ * If a range of nodes was inserted to the model tree.
46
+ * * {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:remove `remove`} &ndash;
47
+ * If a range of nodes was removed from the model tree.
48
+ * * {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:attribute `attribute`} &ndash;
49
+ * If an attribute was added, changed or removed from a model node.
50
+ *
51
+ * For {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:insert `insert`}
52
+ * and {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:attribute `attribute`},
53
+ * the downcast dispatcher generates {@link module:engine/conversion/modelconsumable~ModelConsumable consumables}.
54
+ * These are used to have control over which changes have already been consumed. It is useful when some converters
55
+ * overwrite others or convert multiple changes (for example, it converts an insertion of an element and also converts that
56
+ * element's attributes during the insertion).
57
+ *
58
+ * Additionally, downcast dispatcher fires events for {@link module:engine/model/markercollection~Marker marker} changes:
59
+ *
60
+ * * {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:addMarker `addMarker`} &ndash; If a marker was added.
61
+ * * {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:removeMarker `removeMarker`} &ndash; If a marker was
62
+ * removed.
63
+ *
64
+ * Note that changing a marker is done through removing the marker from the old range and adding it to the new range,
65
+ * so both of these events are fired.
66
+ *
67
+ * Finally, a downcast dispatcher also handles firing events for the {@link module:engine/model/selection model selection}
68
+ * conversion:
69
+ *
70
+ * * {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:selection `selection`}
71
+ * &ndash; Converts the selection from the model to the view.
72
+ * * {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:attribute `attribute`}
73
+ * &ndash; Fired for every selection attribute.
74
+ * * {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:addMarker `addMarker`}
75
+ * &ndash; Fired for every marker that contains a selection.
76
+ *
77
+ * Unlike the model tree and the markers, the events for selection are not fired for changes but for a selection state.
78
+ *
79
+ * When providing custom listeners for a downcast dispatcher, remember to check whether a given change has not been
80
+ * {@link module:engine/conversion/modelconsumable~ModelConsumable#consume consumed} yet.
81
+ *
82
+ * When providing custom listeners for a downcast dispatcher, keep in mind that you **should not** stop the event. If you stop it,
83
+ * then the default converter at the `lowest` priority will not trigger the conversion of this node's attributes and child nodes.
84
+ *
85
+ * When providing custom listeners for a downcast dispatcher, remember to use the provided
86
+ * {@link module:engine/view/downcastwriter~DowncastWriter view downcast writer} to apply changes to the view document.
87
+ *
88
+ * You can read more about conversion in the following guide:
89
+ *
90
+ * * {@glink framework/deep-dive/conversion/downcast Downcast conversion}
91
+ *
92
+ * An example of a custom converter for the downcast dispatcher:
93
+ *
94
+ * ```ts
95
+ * // You will convert inserting a "paragraph" model element into the model.
96
+ * downcastDispatcher.on( 'insert:paragraph', ( evt, data, conversionApi ) => {
97
+ * // Remember to check whether the change has not been consumed yet and consume it.
98
+ * if ( !conversionApi.consumable.consume( data.item, 'insert' ) ) {
99
+ * return;
100
+ * }
101
+ *
102
+ * // Translate the position in the model to a position in the view.
103
+ * const viewPosition = conversionApi.mapper.toViewPosition( data.range.start );
104
+ *
105
+ * // Create a <p> element that will be inserted into the view at the `viewPosition`.
106
+ * const viewElement = conversionApi.writer.createContainerElement( 'p' );
107
+ *
108
+ * // Bind the newly created view element to the model element so positions will map accordingly in the future.
109
+ * conversionApi.mapper.bindElements( data.item, viewElement );
110
+ *
111
+ * // Add the newly created view element to the view.
112
+ * conversionApi.writer.insert( viewPosition, viewElement );
113
+ * } );
114
+ * ```
115
+ */
116
+ export default class DowncastDispatcher extends DowncastDispatcher_base {
117
+ /**
118
+ * A template for an interface passed by the dispatcher to the event callbacks.
119
+ *
120
+ * @internal
121
+ */
122
+ readonly _conversionApi: Pick<DowncastConversionApi, 'dispatcher' | 'mapper' | 'schema'>;
123
+ /**
124
+ * A map of already fired events for a given `ModelConsumable`.
125
+ */
126
+ private readonly _firedEventsMap;
127
+ /**
128
+ * Creates a downcast dispatcher instance.
129
+ *
130
+ * @see module:engine/conversion/downcastdispatcher~DowncastConversionApi
131
+ *
132
+ * @param conversionApi Additional properties for an interface that will be passed to events fired
133
+ * by the downcast dispatcher.
134
+ */
135
+ constructor(conversionApi: Pick<DowncastConversionApi, 'mapper' | 'schema'>);
136
+ /**
137
+ * Converts changes buffered in the given {@link module:engine/model/differ~Differ model differ}
138
+ * and fires conversion events based on it.
139
+ *
140
+ * @fires insert
141
+ * @fires remove
142
+ * @fires attribute
143
+ * @fires addMarker
144
+ * @fires removeMarker
145
+ * @fires reduceChanges
146
+ * @param differ The differ object with buffered changes.
147
+ * @param markers Markers related to the model fragment to convert.
148
+ * @param writer The view writer that should be used to modify the view document.
149
+ */
150
+ convertChanges(differ: Differ, markers: MarkerCollection, writer: DowncastWriter): void;
151
+ /**
152
+ * Starts a conversion of a model range and the provided markers.
153
+ *
154
+ * @fires insert
155
+ * @fires attribute
156
+ * @fires addMarker
157
+ * @param range The inserted range.
158
+ * @param markers The map of markers that should be down-casted.
159
+ * @param writer The view writer that should be used to modify the view document.
160
+ * @param options Optional options object passed to `convertionApi.options`.
161
+ */
162
+ convert(range: Range, markers: Map<string, Range>, writer: DowncastWriter, options?: DowncastConversionApi['options']): void;
163
+ /**
164
+ * Starts the model selection conversion.
165
+ *
166
+ * Fires events for a given {@link module:engine/model/selection~Selection selection} to start the selection conversion.
167
+ *
168
+ * @fires selection
169
+ * @fires addMarker
170
+ * @fires attribute
171
+ * @param selection The selection to convert.
172
+ * @param markers Markers connected with the converted model.
173
+ * @param writer View writer that should be used to modify the view document.
174
+ */
175
+ convertSelection(selection: Selection | DocumentSelection, markers: MarkerCollection, writer: DowncastWriter): void;
176
+ /**
177
+ * Fires insertion conversion of a range of nodes.
178
+ *
179
+ * For each node in the range, {@link #event:insert `insert` event is fired}. For each attribute on each node,
180
+ * {@link #event:attribute `attribute` event is fired}.
181
+ *
182
+ * @fires insert
183
+ * @fires attribute
184
+ * @param range The inserted range.
185
+ * @param conversionApi The conversion API object.
186
+ * @param options.doNotAddConsumables Whether the ModelConsumable should not get populated
187
+ * for items in the provided range.
188
+ */
189
+ private _convertInsert;
190
+ /**
191
+ * Fires conversion of a single node removal. Fires {@link #event:remove remove event} with provided data.
192
+ *
193
+ * @param position Position from which node was removed.
194
+ * @param length Offset size of removed node.
195
+ * @param name Name of removed node.
196
+ * @param conversionApi The conversion API object.
197
+ */
198
+ private _convertRemove;
199
+ /**
200
+ * Starts a conversion of an attribute change on a given `range`.
201
+ *
202
+ * For each node in the given `range`, {@link #event:attribute attribute event} is fired with the passed data.
203
+ *
204
+ * @fires attribute
205
+ * @param range Changed range.
206
+ * @param key Key of the attribute that has changed.
207
+ * @param oldValue Attribute value before the change or `null` if the attribute has not been set before.
208
+ * @param newValue New attribute value or `null` if the attribute has been removed.
209
+ * @param conversionApi The conversion API object.
210
+ */
211
+ private _convertAttribute;
212
+ /**
213
+ * Fires re-insertion conversion (with a `reconversion` flag passed to `insert` events)
214
+ * of a range of elements (only elements on the range depth, without children).
215
+ *
216
+ * For each node in the range on its depth (without children), {@link #event:insert `insert` event} is fired.
217
+ * For each attribute on each node, {@link #event:attribute `attribute` event} is fired.
218
+ *
219
+ * @fires insert
220
+ * @fires attribute
221
+ * @param range The range to reinsert.
222
+ * @param conversionApi The conversion API object.
223
+ */
224
+ private _convertReinsert;
225
+ /**
226
+ * Converts the added marker. Fires the {@link #event:addMarker `addMarker`} event for each item
227
+ * in the marker's range. If the range is collapsed, a single event is dispatched. See the event description for more details.
228
+ *
229
+ * @fires addMarker
230
+ * @param markerName Marker name.
231
+ * @param markerRange The marker range.
232
+ * @param conversionApi The conversion API object.
233
+ */
234
+ private _convertMarkerAdd;
235
+ /**
236
+ * Fires the conversion of the marker removal. Fires the {@link #event:removeMarker `removeMarker`} event with the provided data.
237
+ *
238
+ * @fires removeMarker
239
+ * @param markerName Marker name.
240
+ * @param markerRange The marker range.
241
+ * @param conversionApi The conversion API object.
242
+ */
243
+ private _convertMarkerRemove;
244
+ /**
245
+ * Fires the reduction of changes buffered in the {@link module:engine/model/differ~Differ `Differ`}.
246
+ *
247
+ * Features can replace selected {@link module:engine/model/differ~DiffItem `DiffItem`}s with `reinsert` entries to trigger
248
+ * reconversion. The {@link module:engine/conversion/downcasthelpers~DowncastHelpers#elementToStructure
249
+ * `DowncastHelpers.elementToStructure()`} is using this event to trigger reconversion.
250
+ *
251
+ * @fires reduceChanges
252
+ */
253
+ private _reduceChanges;
254
+ /**
255
+ * Populates provided {@link module:engine/conversion/modelconsumable~ModelConsumable} with values to consume from a given range,
256
+ * assuming that the range has just been inserted to the model.
257
+ *
258
+ * @param consumable The consumable.
259
+ * @param walkerValues The walker values for the inserted range.
260
+ * @returns The values to consume.
261
+ */
262
+ private _addConsumablesForInsert;
263
+ /**
264
+ * Populates provided {@link module:engine/conversion/modelconsumable~ModelConsumable} with values to consume for a given range.
265
+ *
266
+ * @param consumable The consumable.
267
+ * @param range The affected range.
268
+ * @param type Consumable type.
269
+ * @returns The values to consume.
270
+ */
271
+ private _addConsumablesForRange;
272
+ /**
273
+ * Populates provided {@link module:engine/conversion/modelconsumable~ModelConsumable} with selection consumable values.
274
+ *
275
+ * @param consumable The consumable.
276
+ * @param selection The selection to create the consumable from.
277
+ * @param markers Markers that contain the selection.
278
+ * @returns The values to consume.
279
+ */
280
+ private _addConsumablesForSelection;
281
+ /**
282
+ * Tests whether given event wasn't already fired and if so, fires it.
283
+ *
284
+ * @fires insert
285
+ * @fires attribute
286
+ * @param type Event type.
287
+ * @param data Event data.
288
+ * @param conversionApi The conversion API object.
289
+ */
290
+ private _testAndFire;
291
+ /**
292
+ * Fires not already fired events for setting attributes on just inserted item.
293
+ *
294
+ * @param item The model item to convert attributes for.
295
+ * @param conversionApi The conversion API object.
296
+ */
297
+ private _testAndFireAddAttributes;
298
+ /**
299
+ * Builds an instance of the {@link module:engine/conversion/downcastdispatcher~DowncastConversionApi} from a template and a given
300
+ * {@link module:engine/view/downcastwriter~DowncastWriter `DowncastWriter`} and options object.
301
+ *
302
+ * @param writer View writer that should be used to modify the view document.
303
+ * @param refreshedItems A set of model elements that should not reuse their
304
+ * previous view representations.
305
+ * @param options Optional options passed to `convertionApi.options`.
306
+ * @return The conversion API object.
307
+ */
308
+ private _createConversionApi;
309
+ }
310
+ /**
311
+ * Fired to enable reducing (transforming) changes buffered in the {@link module:engine/model/differ~Differ `Differ`} before
312
+ * {@link ~DowncastDispatcher#convertChanges `convertChanges()`} will fire any conversion events.
313
+ *
314
+ * For instance, a feature can replace selected {@link module:engine/model/differ~DiffItem `DiffItem`}s with a `reinsert` entry
315
+ * to trigger reconversion of an element when e.g. its attribute has changes.
316
+ * The {@link module:engine/conversion/downcasthelpers~DowncastHelpers#elementToStructure
317
+ * `DowncastHelpers.elementToStructure()`} helper is using this event to trigger reconversion of an element when the element,
318
+ * its attributes or direct children changed.
319
+ *
320
+ * @eventName ~DowncastDispatcher#reduceChanges
321
+ */
322
+ export type DowncastReduceChangesEvent = {
323
+ name: 'reduceChanges';
324
+ args: [data: DowncastReduceChangesEventData];
325
+ };
326
+ export type DowncastReduceChangesEventData = {
327
+ /**
328
+ * A buffered changes to get reduced.
329
+ */
330
+ changes: Iterable<DiffItem | DiffItemReinsert>;
331
+ };
332
+ type EventMap<TItem = Item> = {
333
+ insert: {
334
+ item: TItem;
335
+ range: Range;
336
+ reconversion?: boolean;
337
+ };
338
+ remove: {
339
+ position: Position;
340
+ length: number;
341
+ };
342
+ attribute: {
343
+ item: TItem;
344
+ range: Range;
345
+ attributeKey: string;
346
+ attributeOldValue: unknown;
347
+ attributeNewValue: unknown;
348
+ };
349
+ cleanSelection: {
350
+ selection: Selection | DocumentSelection;
351
+ };
352
+ selection: {
353
+ selection: Selection | DocumentSelection;
354
+ };
355
+ addMarker: {
356
+ item?: Item | Selection | DocumentSelection;
357
+ range?: Range;
358
+ markerRange: Range;
359
+ markerName: string;
360
+ };
361
+ removeMarker: {
362
+ markerRange: Range;
363
+ markerName: string;
364
+ };
365
+ };
366
+ export type DowncastEvent<TName extends keyof EventMap<TItem>, TItem = Item> = {
367
+ name: TName | `${TName}:${string}`;
368
+ args: [data: EventMap<TItem>[TName], conversionApi: DowncastConversionApi];
369
+ };
370
+ /**
371
+ * Fired for inserted nodes.
372
+ *
373
+ * `insert` is a namespace for a class of events. Names of actually called events follow this pattern:
374
+ * `insert:name`. `name` is either `'$text'`, when {@link module:engine/model/text~Text a text node} has been inserted,
375
+ * or {@link module:engine/model/element~Element#name name} of inserted element.
376
+ *
377
+ * This way, the listeners can either listen to a general `insert` event or specific event (for example `insert:paragraph`).
378
+ *
379
+ * @eventName ~DowncastDispatcher#insert
380
+ * @param {Object} data Additional information about the change.
381
+ * @param {module:engine/model/item~Item} data.item The inserted item.
382
+ * @param {module:engine/model/range~Range} data.range Range spanning over inserted item.
383
+ * @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi Conversion interface
384
+ * to be used by callback, passed in the `DowncastDispatcher` constructor.
385
+ */
386
+ export type DowncastInsertEvent<TItem extends Item = Item> = DowncastEvent<'insert', TItem>;
387
+ /**
388
+ * Fired for removed nodes.
389
+ *
390
+ * `remove` is a namespace for a class of events. Names of actually called events follow this pattern:
391
+ * `remove:name`. `name` is either `'$text'`, when a {@link module:engine/model/text~Text a text node} has been removed,
392
+ * or the {@link module:engine/model/element~Element#name name} of removed element.
393
+ *
394
+ * This way, listeners can either listen to a general `remove` event or specific event (for example `remove:paragraph`).
395
+ *
396
+ * @eventName ~DowncastDispatcher#remove
397
+ * @param {Object} data Additional information about the change.
398
+ * @param {module:engine/model/position~Position} data.position Position from which the node has been removed.
399
+ * @param {Number} data.length Offset size of the removed node.
400
+ * @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi Conversion interface
401
+ * to be used by callback, passed in `DowncastDispatcher` constructor.
402
+ */
403
+ export type DowncastRemoveEvent = DowncastEvent<'remove'>;
404
+ /**
405
+ * Fired in the following cases:
406
+ *
407
+ * * when an attribute has been added, changed, or removed from a node,
408
+ * * when a node with an attribute is inserted,
409
+ * * when a collapsed model selection attribute is converted.
410
+ *
411
+ * `attribute` is a namespace for a class of events. Names of actually called events follow this pattern:
412
+ * `attribute:attributeKey:name`. `attributeKey` is the key of added/changed/removed attribute.
413
+ * `name` is either `'$text'` if change was on {@link module:engine/model/text~Text a text node},
414
+ * or the {@link module:engine/model/element~Element#name name} of element which attribute has changed.
415
+ *
416
+ * This way listeners can either listen to a general `attribute:bold` event or specific event (for example `attribute:src:imageBlock`).
417
+ *
418
+ * @eventName ~DowncastDispatcher#attribute
419
+ * @param {Object} data Additional information about the change.
420
+ * @param {module:engine/model/item~Item|module:engine/model/documentselection~DocumentSelection} data.item Changed item
421
+ * or converted selection.
422
+ * @param {module:engine/model/range~Range} data.range Range spanning over changed item or selection range.
423
+ * @param {String} data.attributeKey Attribute key.
424
+ * @param {*} data.attributeOldValue Attribute value before the change. This is `null` when selection attribute is converted.
425
+ * @param {*} data.attributeNewValue New attribute value.
426
+ * @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi Conversion interface
427
+ * to be used by callback, passed in `DowncastDispatcher` constructor.
428
+ */
429
+ export type DowncastAttributeEvent<TItem = Item | Selection | DocumentSelection> = DowncastEvent<'attribute', TItem>;
430
+ /**
431
+ * Fired for {@link module:engine/model/selection~Selection selection} changes.
432
+ *
433
+ * @eventName ~DowncastDispatcher#selection
434
+ * @param {module:engine/model/selection~Selection} selection Selection that is converted.
435
+ * @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi Conversion interface
436
+ * to be used by callback, passed in `DowncastDispatcher` constructor.
437
+ */
438
+ export type DowncastSelectionEvent = DowncastEvent<'selection'>;
439
+ /**
440
+ * Fired at the beginning of selection conversion, before
441
+ * {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher#event:selection selection} events.
442
+ *
443
+ * Should be used to clean up the view state at the current selection position, before the selection is moved to another place.
444
+ *
445
+ * @eventName ~DowncastDispatcher#cleanSelection
446
+ * @param {module:engine/model/selection~Selection} selection Selection that is converted.
447
+ * @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi Conversion interface
448
+ * to be used by callback, passed in `DowncastDispatcher` constructor.
449
+ */
450
+ export type DowncastCleanSelectionEvent = DowncastEvent<'cleanSelection'>;
451
+ /**
452
+ * Fired when a new marker is added to the model. Also fired when a collapsed model selection that is inside a marker is converted.
453
+ *
454
+ * `addMarker` is a namespace for a class of events. Names of actually called events follow this pattern:
455
+ * `addMarker:markerName`. By specifying certain marker names, you can make the events even more gradual. For example,
456
+ * if markers are named `foo:abc`, `foo:bar`, then it is possible to listen to `addMarker:foo` or `addMarker:foo:abc` and
457
+ * `addMarker:foo:bar` events.
458
+ *
459
+ * If the marker range is not collapsed:
460
+ *
461
+ * * the event is fired for each item in the marker range one by one,
462
+ * * `conversionApi.consumable` includes each item of the marker range and the consumable value is same as the event name.
463
+ *
464
+ * If the marker range is collapsed:
465
+ *
466
+ * * there is only one event,
467
+ * * `conversionApi.consumable` includes marker range with the event name.
468
+ *
469
+ * If the selection inside a marker is converted:
470
+ *
471
+ * * there is only one event,
472
+ * * `conversionApi.consumable` includes the selection instance with the event name.
473
+ *
474
+ * @eventName ~DowncastDispatcher#addMarker
475
+ * @param {Object} data Additional information about the change.
476
+ * @param {module:engine/model/item~Item|module:engine/model/selection~Selection} data.item Item inside the new marker or
477
+ * the selection that is being converted.
478
+ * @param {module:engine/model/range~Range} [data.range] Range spanning over converted item. Available only in marker conversion, if
479
+ * the marker range was not collapsed.
480
+ * @param {module:engine/model/range~Range} data.markerRange Marker range.
481
+ * @param {String} data.markerName Marker name.
482
+ * @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi Conversion interface
483
+ * to be used by callback, passed in `DowncastDispatcher` constructor.
484
+ */
485
+ export type DowncastAddMarkerEvent = DowncastEvent<'addMarker'>;
486
+ /**
487
+ * Fired when a marker is removed from the model.
488
+ *
489
+ * `removeMarker` is a namespace for a class of events. Names of actually called events follow this pattern:
490
+ * `removeMarker:markerName`. By specifying certain marker names, you can make the events even more gradual. For example,
491
+ * if markers are named `foo:abc`, `foo:bar`, then it is possible to listen to `removeMarker:foo` or `removeMarker:foo:abc` and
492
+ * `removeMarker:foo:bar` events.
493
+ *
494
+ * @eventName ~DowncastDispatcher#removeMarker
495
+ * @param {Object} data Additional information about the change.
496
+ * @param {module:engine/model/range~Range} data.markerRange Marker range.
497
+ * @param {String} data.markerName Marker name.
498
+ * @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi Conversion interface
499
+ * to be used by callback, passed in `DowncastDispatcher` constructor.
500
+ */
501
+ export type DowncastRemoveMarkerEvent = DowncastEvent<'removeMarker'>;
502
+ export interface DiffItemReinsert {
503
+ type: 'reinsert';
504
+ name: string;
505
+ position: Position;
506
+ length: number;
507
+ }
508
+ /**
509
+ * Conversion interface that is registered for given {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher}
510
+ * and is passed as one of parameters when {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher dispatcher}
511
+ * fires its events.
512
+ */
513
+ export interface DowncastConversionApi {
514
+ /**
515
+ * The {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher} instance.
516
+ */
517
+ dispatcher: DowncastDispatcher;
518
+ /**
519
+ * Stores the information about what parts of a processed model item are still waiting to be handled. After a piece of a model item was
520
+ * converted, an appropriate consumable value should be {@link module:engine/conversion/modelconsumable~ModelConsumable#consume
521
+ * consumed}.
522
+ */
523
+ consumable: Consumable;
524
+ /**
525
+ * The {@link module:engine/conversion/mapper~Mapper} instance.
526
+ */
527
+ mapper: Mapper;
528
+ /**
529
+ * The {@link module:engine/model/schema~Schema} instance set for the model that is downcast.
530
+ */
531
+ schema: Schema;
532
+ /**
533
+ * The {@link module:engine/view/downcastwriter~DowncastWriter} instance used to manipulate the data during conversion.
534
+ */
535
+ writer: DowncastWriter;
536
+ /**
537
+ * An object with an additional configuration which can be used during the conversion process.
538
+ * Available only for data downcast conversion.
539
+ */
540
+ options: Record<string, unknown>;
541
+ /**
542
+ * Triggers conversion of a specified item.
543
+ * This conversion is triggered within (as a separate process of) the parent conversion.
544
+ *
545
+ * @param item The model item to trigger nested insert conversion on.
546
+ */
547
+ convertItem(item: Item): void;
548
+ /**
549
+ * Triggers conversion of children of a specified element.
550
+ *
551
+ * @param element The model element to trigger children insert conversion on.
552
+ */
553
+ convertChildren(element: Element): void;
554
+ /**
555
+ * Triggers conversion of attributes of a specified item.
556
+ *
557
+ * @param item The model item to trigger attribute conversion on.
558
+ */
559
+ convertAttributes(item: Item): void;
560
+ canReuseView(element: ViewElement): boolean;
561
+ }
562
+ export {};