@ckeditor/ckeditor5-engine 45.2.1 → 46.0.0-alpha.0

package/src/conversion/downcastdispatcher.d.ts

@@ -5,19 +5,19 @@
 /**
  * @module engine/conversion/downcastdispatcher
  */
-import Consumable from './modelconsumable.js';
-import Range from '../model/range.js';
-import type { default as Differ, DiffItem } from '../model/differ.js';
-import type { default as MarkerCollection } from '../model/markercollection.js';
-import type DocumentSelection from '../model/documentselection.js';
-import type DowncastWriter from '../view/downcastwriter.js';
-import type Element from '../model/element.js';
-import type Item from '../model/item.js';
-import type Mapper from './mapper.js';
-import type Position from '../model/position.js';
-import type Schema from '../model/schema.js';
-import type Selection from '../model/selection.js';
-import type ViewElement from '../view/element.js';
+import { ModelConsumable } from './modelconsumable.js';
+import { ModelRange } from '../model/range.js';
+import type { Differ, DifferItem, DifferItemReinsert } from '../model/differ.js';
+import type { MarkerCollection } from '../model/markercollection.js';
+import { type ModelDocumentSelection } from '../model/documentselection.js';
+import { type ViewDowncastWriter } from '../view/downcastwriter.js';
+import { type ModelElement } from '../model/element.js';
+import { type ModelItem } from '../model/item.js';
+import { type Mapper } from './mapper.js';
+import { type ModelPosition } from '../model/position.js';
+import { type ModelSchema } from '../model/schema.js';
+import { type ModelSelection } from '../model/selection.js';
+import { type ViewElement } from '../view/element.js';
 declare const DowncastDispatcher_base: {
     new (): import("@ckeditor/ckeditor5-utils").Emitter;
     prototype: import("@ckeditor/ckeditor5-utils").Emitter;
@@ -83,7 +83,7 @@ declare const DowncastDispatcher_base: {
  * then the default converter at the `lowest` priority will not trigger the conversion of this node's attributes and child nodes.
  *
  * When providing custom listeners for a downcast dispatcher, remember to use the provided
- * {@link module:engine/view/downcastwriter~DowncastWriter view downcast writer} to apply changes to the view document.
+ * {@link module:engine/view/downcastwriter~ViewDowncastWriter view downcast writer} to apply changes to the view document.
  *
  * You can read more about conversion in the following guide:
  *
@@ -113,7 +113,7 @@ declare const DowncastDispatcher_base: {
  * } );
  * ```
  */
-export default class DowncastDispatcher extends /* #__PURE__ */ DowncastDispatcher_base {
+export declare class DowncastDispatcher extends /* #__PURE__ */ DowncastDispatcher_base {
     /**
      * A template for an interface passed by the dispatcher to the event callbacks.
      *
@@ -147,7 +147,7 @@ export default class DowncastDispatcher extends /* #__PURE__ */ DowncastDispatch
      * @param markers Markers related to the model fragment to convert.
      * @param writer The view writer that should be used to modify the view document.
      */
-    convertChanges(differ: Differ, markers: MarkerCollection, writer: DowncastWriter): void;
+    convertChanges(differ: Differ, markers: MarkerCollection, writer: ViewDowncastWriter): void;
     /**
      * Starts a conversion of a model range and the provided markers.
      *
@@ -159,11 +159,11 @@ export default class DowncastDispatcher extends /* #__PURE__ */ DowncastDispatch
      * @param writer The view writer that should be used to modify the view document.
      * @param options Optional options object passed to `convertionApi.options`.
      */
-    convert(range: Range, markers: Map<string, Range>, writer: DowncastWriter, options?: DowncastConversionApi['options']): void;
+    convert(range: ModelRange, markers: Map<string, ModelRange>, writer: ViewDowncastWriter, options?: DowncastConversionApi['options']): void;
     /**
      * Starts the model selection conversion.
      *
-     * Fires events for a given {@link module:engine/model/selection~Selection selection} to start the selection conversion.
+     * Fires events for a given {@link module:engine/model/selection~ModelSelection selection} to start the selection conversion.
      *
      * @fires selection
      * @fires addMarker
@@ -172,7 +172,7 @@ export default class DowncastDispatcher extends /* #__PURE__ */ DowncastDispatch
      * @param markers Markers connected with the converted model.
      * @param writer View writer that should be used to modify the view document.
      */
-    convertSelection(selection: Selection | DocumentSelection, markers: MarkerCollection, writer: DowncastWriter): void;
+    convertSelection(selection: ModelSelection | ModelDocumentSelection, markers: MarkerCollection, writer: ViewDowncastWriter): void;
     /**
      * Fires insertion conversion of a range of nodes.
      *
@@ -244,7 +244,7 @@ export default class DowncastDispatcher extends /* #__PURE__ */ DowncastDispatch
     /**
      * Fires the reduction of changes buffered in the {@link module:engine/model/differ~Differ `Differ`}.
      *
-     * Features can replace selected {@link module:engine/model/differ~DiffItem `DiffItem`}s with `reinsert` entries to trigger
+     * Features can replace selected {@link module:engine/model/differ~DifferItem `DifferItem`}s with `reinsert` entries to trigger
      * reconversion. The {@link module:engine/conversion/downcasthelpers~DowncastHelpers#elementToStructure
      * `DowncastHelpers.elementToStructure()`} is using this event to trigger reconversion.
      *
@@ -297,7 +297,7 @@ export default class DowncastDispatcher extends /* #__PURE__ */ DowncastDispatch
     private _testAndFireAddAttributes;
     /**
      * Builds an instance of the {@link module:engine/conversion/downcastdispatcher~DowncastConversionApi} from a template and a given
-     * {@link module:engine/view/downcastwriter~DowncastWriter `DowncastWriter`} and options object.
+     * {@link module:engine/view/downcastwriter~ViewDowncastWriter `ViewDowncastWriter`} and options object.
      *
      * @param writer View writer that should be used to modify the view document.
      * @param refreshedItems A set of model elements that should not reuse their
@@ -311,7 +311,7 @@ export default class DowncastDispatcher extends /* #__PURE__ */ DowncastDispatch
  * Fired to enable reducing (transforming) changes buffered in the {@link module:engine/model/differ~Differ `Differ`} before
  * {@link ~DowncastDispatcher#convertChanges `convertChanges()`} will fire any conversion events.
  *
- * For instance, a feature can replace selected {@link module:engine/model/differ~DiffItem `DiffItem`}s with a `reinsert` entry
+ * For instance, a feature can replace selected {@link module:engine/model/differ~DifferItem `DifferItem`}s with a `reinsert` entry
  * to trigger reconversion of an element when e.g. its attribute has changes.
  * The {@link module:engine/conversion/downcasthelpers~DowncastHelpers#elementToStructure
      * `DowncastHelpers.elementToStructure()`} helper is using this event to trigger reconversion of an element when the element,
@@ -327,75 +327,75 @@ export type DowncastReduceChangesEventData = {
     /**
      * A buffered changes to get reduced.
      */
-    changes: Iterable<DiffItem | DiffItemReinsert>;
+    changes: Iterable<DifferItem | DifferItemReinsert>;
 };
-type EventMap<TItem = Item> = {
+export type DowncastDispatcherEventMap<TItem = ModelItem> = {
     insert: {
         item: TItem;
-        range: Range;
+        range: ModelRange;
         reconversion?: boolean;
     };
     remove: {
-        position: Position;
+        position: ModelPosition;
         length: number;
     };
     attribute: {
         item: TItem;
-        range: Range;
+        range: ModelRange;
         attributeKey: string;
         attributeOldValue: unknown;
         attributeNewValue: unknown;
     };
     cleanSelection: {
-        selection: Selection | DocumentSelection;
+        selection: ModelSelection | ModelDocumentSelection;
     };
     selection: {
-        selection: Selection | DocumentSelection;
+        selection: ModelSelection | ModelDocumentSelection;
     };
     addMarker: {
-        item?: Item | Selection | DocumentSelection;
-        range?: Range;
-        markerRange: Range;
+        item?: ModelItem | ModelSelection | ModelDocumentSelection;
+        range?: ModelRange;
+        markerRange: ModelRange;
         markerName: string;
     };
     removeMarker: {
-        markerRange: Range;
+        markerRange: ModelRange;
         markerName: string;
     };
 };
-export type DowncastEvent<TName extends keyof EventMap<TItem>, TItem = Item> = {
+export type DowncastEvent<TName extends keyof DowncastDispatcherEventMap<TItem>, TItem = ModelItem> = {
     name: TName | `${TName}:${string}`;
-    args: [data: EventMap<TItem>[TName], conversionApi: DowncastConversionApi];
+    args: [data: DowncastDispatcherEventMap<TItem>[TName], conversionApi: DowncastConversionApi];
 };
 /**
  * Fired for inserted nodes.
  *
  * `insert` is a namespace for a class of events. Names of actually called events follow this pattern:
- * `insert:name`. `name` is either `'$text'`, when {@link module:engine/model/text~Text a text node} has been inserted,
- * or {@link module:engine/model/element~Element#name name} of inserted element.
+ * `insert:name`. `name` is either `'$text'`, when {@link module:engine/model/text~ModelText a text node} has been inserted,
+ * or {@link module:engine/model/element~ModelElement#name name} of inserted element.
  *
  * This way, the listeners can either listen to a general `insert` event or specific event (for example `insert:paragraph`).
  *
  * @eventName ~DowncastDispatcher#insert
  * @param {Object} data Additional information about the change.
- * @param {module:engine/model/item~Item} data.item The inserted item.
- * @param {module:engine/model/range~Range} data.range Range spanning over inserted item.
+ * @param {module:engine/model/item~ModelItem} data.item The inserted item.
+ * @param {module:engine/model/range~ModelRange} data.range Range spanning over inserted item.
  * @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi Conversion interface
  * to be used by callback, passed in the `DowncastDispatcher` constructor.
  */
-export type DowncastInsertEvent<TItem extends Item = Item> = DowncastEvent<'insert', TItem>;
+export type DowncastInsertEvent<TItem extends ModelItem = ModelItem> = DowncastEvent<'insert', TItem>;
 /**
  * Fired for removed nodes.
  *
  * `remove` is a namespace for a class of events. Names of actually called events follow this pattern:
- * `remove:name`. `name` is either `'$text'`, when a {@link module:engine/model/text~Text a text node} has been removed,
- * or the {@link module:engine/model/element~Element#name name} of removed element.
+ * `remove:name`. `name` is either `'$text'`, when a {@link module:engine/model/text~ModelText a text node} has been removed,
+ * or the {@link module:engine/model/element~ModelElement#name name} of removed element.
  *
  * This way, listeners can either listen to a general `remove` event or specific event (for example `remove:paragraph`).
  *
  * @eventName ~DowncastDispatcher#remove
  * @param {Object} data Additional information about the change.
- * @param {module:engine/model/position~Position} data.position Position from which the node has been removed.
+ * @param {module:engine/model/position~ModelPosition} data.position Position from which the node has been removed.
  * @param {Number} data.length Offset size of the removed node.
  * @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi Conversion interface
  * to be used by callback, passed in `DowncastDispatcher` constructor.
@@ -410,28 +410,28 @@ export type DowncastRemoveEvent = DowncastEvent<'remove'>;
  *
  * `attribute` is a namespace for a class of events. Names of actually called events follow this pattern:
  * `attribute:attributeKey:name`. `attributeKey` is the key of added/changed/removed attribute.
- * `name` is either `'$text'` if change was on {@link module:engine/model/text~Text a text node},
- * or the {@link module:engine/model/element~Element#name name} of element which attribute has changed.
+ * `name` is either `'$text'` if change was on {@link module:engine/model/text~ModelText a text node},
+ * or the {@link module:engine/model/element~ModelElement#name name} of element which attribute has changed.
  *
  * This way listeners can either listen to a general `attribute:bold` event or specific event (for example `attribute:src:imageBlock`).
  *
  * @eventName ~DowncastDispatcher#attribute
  * @param {Object} data Additional information about the change.
- * @param {module:engine/model/item~Item|module:engine/model/documentselection~DocumentSelection} data.item Changed item
+ * @param {module:engine/model/item~ModelItem|module:engine/model/documentselection~ModelDocumentSelection} data.item Changed item
  * or converted selection.
- * @param {module:engine/model/range~Range} data.range Range spanning over changed item or selection range.
+ * @param {module:engine/model/range~ModelRange} data.range Range spanning over changed item or selection range.
  * @param {String} data.attributeKey Attribute key.
  * @param {*} data.attributeOldValue Attribute value before the change. This is `null` when selection attribute is converted.
  * @param {*} data.attributeNewValue New attribute value.
  * @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi Conversion interface
  * to be used by callback, passed in `DowncastDispatcher` constructor.
  */
-export type DowncastAttributeEvent<TItem = Item | Selection | DocumentSelection> = DowncastEvent<'attribute', TItem>;
+export type DowncastAttributeEvent<TItem = ModelItem | ModelSelection | ModelDocumentSelection> = DowncastEvent<'attribute', TItem>;
 /**
- * Fired for {@link module:engine/model/selection~Selection selection} changes.
+ * Fired for {@link module:engine/model/selection~ModelSelection selection} changes.
  *
  * @eventName ~DowncastDispatcher#selection
- * @param {module:engine/model/selection~Selection} selection Selection that is converted.
+ * @param {module:engine/model/selection~ModelSelection} selection Selection that is converted.
  * @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi Conversion interface
  * to be used by callback, passed in `DowncastDispatcher` constructor.
  */
@@ -443,7 +443,7 @@ export type DowncastSelectionEvent = DowncastEvent<'selection'>;
  * Should be used to clean up the view state at the current selection position, before the selection is moved to another place.
  *
  * @eventName ~DowncastDispatcher#cleanSelection
- * @param {module:engine/model/selection~Selection} selection Selection that is converted.
+ * @param {module:engine/model/selection~ModelSelection} selection Selection that is converted.
  * @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi Conversion interface
  * to be used by callback, passed in `DowncastDispatcher` constructor.
  */
@@ -473,11 +473,11 @@ export type DowncastCleanSelectionEvent = DowncastEvent<'cleanSelection'>;
  *
  * @eventName ~DowncastDispatcher#addMarker
  * @param {Object} data Additional information about the change.
- * @param {module:engine/model/item~Item|module:engine/model/selection~Selection} data.item Item inside the new marker or
+ * @param {module:engine/model/item~ModelItem|module:engine/model/selection~ModelSelection} data.item Item inside the new marker or
  * the selection that is being converted.
- * @param {module:engine/model/range~Range} [data.range] Range spanning over converted item. Available only in marker conversion, if
+ * @param {module:engine/model/range~ModelRange} [data.range] Range spanning over converted item. Available only in marker conversion, if
  * the marker range was not collapsed.
- * @param {module:engine/model/range~Range} data.markerRange Marker range.
+ * @param {module:engine/model/range~ModelRange} data.markerRange Marker range.
  * @param {String} data.markerName Marker name.
  * @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi Conversion interface
  * to be used by callback, passed in `DowncastDispatcher` constructor.
@@ -493,18 +493,12 @@ export type DowncastAddMarkerEvent = DowncastEvent<'addMarker'>;
  *
  * @eventName ~DowncastDispatcher#removeMarker
  * @param {Object} data Additional information about the change.
- * @param {module:engine/model/range~Range} data.markerRange Marker range.
+ * @param {module:engine/model/range~ModelRange} data.markerRange Marker range.
  * @param {String} data.markerName Marker name.
  * @param {module:engine/conversion/downcastdispatcher~DowncastConversionApi} conversionApi Conversion interface
  * to be used by callback, passed in `DowncastDispatcher` constructor.
  */
 export type DowncastRemoveMarkerEvent = DowncastEvent<'removeMarker'>;
-export interface DiffItemReinsert {
-    type: 'reinsert';
-    name: string;
-    position: Position;
-    length: number;
-}
 /**
  * Conversion interface that is registered for given {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher}
  * and is passed as one of parameters when {@link module:engine/conversion/downcastdispatcher~DowncastDispatcher dispatcher}
@@ -520,19 +514,19 @@ export interface DowncastConversionApi {
      * converted, an appropriate consumable value should be {@link module:engine/conversion/modelconsumable~ModelConsumable#consume
      * consumed}.
      */
-    consumable: Consumable;
+    consumable: ModelConsumable;
     /**
      * The {@link module:engine/conversion/mapper~Mapper} instance.
      */
     mapper: Mapper;
     /**
-     * The {@link module:engine/model/schema~Schema} instance set for the model that is downcast.
+     * The {@link module:engine/model/schema~ModelSchema} instance set for the model that is downcast.
      */
-    schema: Schema;
+    schema: ModelSchema;
     /**
-     * The {@link module:engine/view/downcastwriter~DowncastWriter} instance used to manipulate the data during conversion.
+     * The {@link module:engine/view/downcastwriter~ViewDowncastWriter} instance used to manipulate the data during conversion.
      */
-    writer: DowncastWriter;
+    writer: ViewDowncastWriter;
     /**
      * An object with an additional configuration which can be used during the conversion process.
      * Available only for data downcast conversion.
@@ -544,19 +538,19 @@ export interface DowncastConversionApi {
      *
      * @param item The model item to trigger nested insert conversion on.
      */
-    convertItem(item: Item): void;
+    convertItem(item: ModelItem): void;
     /**
      * Triggers conversion of children of a specified element.
      *
      * @param element The model element to trigger children insert conversion on.
      */
-    convertChildren(element: Element): void;
+    convertChildren(element: ModelElement): void;
     /**
      * Triggers conversion of attributes of a specified item.
      *
      * @param item The model item to trigger attribute conversion on.
      */
-    convertAttributes(item: Item): void;
+    convertAttributes(item: ModelItem): void;
     canReuseView(element: ViewElement): boolean;
 }
 export {};

package/src/conversion/downcastdispatcher.js

@@ -5,8 +5,8 @@
 /**
  * @module engine/conversion/downcastdispatcher
  */
-import Consumable from './modelconsumable.js';
-import Range from '../model/range.js';
+import { ModelConsumable } from './modelconsumable.js';
+import { ModelRange } from '../model/range.js';
 import { EmitterMixin } from '@ckeditor/ckeditor5-utils';
 /**
  * The downcast dispatcher is a central point of downcasting (conversion from the model to the view), which is a process of reacting
@@ -69,7 +69,7 @@ import { EmitterMixin } from '@ckeditor/ckeditor5-utils';
  * then the default converter at the `lowest` priority will not trigger the conversion of this node's attributes and child nodes.
  *
  * When providing custom listeners for a downcast dispatcher, remember to use the provided
- * {@link module:engine/view/downcastwriter~DowncastWriter view downcast writer} to apply changes to the view document.
+ * {@link module:engine/view/downcastwriter~ViewDowncastWriter view downcast writer} to apply changes to the view document.
  *
  * You can read more about conversion in the following guide:
  *
@@ -99,7 +99,7 @@ import { EmitterMixin } from '@ckeditor/ckeditor5-utils';
  * } );
  * ```
  */
-export default class DowncastDispatcher extends /* #__PURE__ */ EmitterMixin() {
+export class DowncastDispatcher extends /* #__PURE__ */ EmitterMixin() {
     /**
      * A template for an interface passed by the dispatcher to the event callbacks.
      *
@@ -148,10 +148,10 @@ export default class DowncastDispatcher extends /* #__PURE__ */ EmitterMixin() {
         // Convert changes that happened on model tree.
         for (const entry of changes) {
             if (entry.type === 'insert') {
-                this._convertInsert(Range._createFromPositionAndShift(entry.position, entry.length), conversionApi);
+                this._convertInsert(ModelRange._createFromPositionAndShift(entry.position, entry.length), conversionApi);
             }
             else if (entry.type === 'reinsert') {
-                this._convertReinsert(Range._createFromPositionAndShift(entry.position, entry.length), conversionApi);
+                this._convertReinsert(ModelRange._createFromPositionAndShift(entry.position, entry.length), conversionApi);
             }
             else if (entry.type === 'remove') {
                 this._convertRemove(entry.position, entry.length, entry.name, conversionApi);
@@ -199,7 +199,7 @@ export default class DowncastDispatcher extends /* #__PURE__ */ EmitterMixin() {
     /**
      * Starts the model selection conversion.
      *
-     * Fires events for a given {@link module:engine/model/selection~Selection selection} to start the selection conversion.
+     * Fires events for a given {@link module:engine/model/selection~ModelSelection selection} to start the selection conversion.
      *
      * @fires selection
      * @fires addMarker
@@ -306,7 +306,7 @@ export default class DowncastDispatcher extends /* #__PURE__ */ EmitterMixin() {
         for (const value of range) {
             const data = {
                 item: value.item,
-                range: Range._createFromPositionAndShift(value.previousPosition, value.length),
+                range: ModelRange._createFromPositionAndShift(value.previousPosition, value.length),
                 attributeKey: key,
                 attributeOldValue: oldValue,
                 attributeNewValue: newValue
@@ -373,7 +373,7 @@ export default class DowncastDispatcher extends /* #__PURE__ */ EmitterMixin() {
             if (!conversionApi.consumable.test(item, eventName)) {
                 continue;
             }
-            const data = { item, range: Range._createOn(item), markerName, markerRange };
+            const data = { item, range: ModelRange._createOn(item), markerName, markerRange };
             this.fire(eventName, data, conversionApi);
         }
     }
@@ -395,7 +395,7 @@ export default class DowncastDispatcher extends /* #__PURE__ */ EmitterMixin() {
     /**
      * Fires the reduction of changes buffered in the {@link module:engine/model/differ~Differ `Differ`}.
      *
-     * Features can replace selected {@link module:engine/model/differ~DiffItem `DiffItem`}s with `reinsert` entries to trigger
+     * Features can replace selected {@link module:engine/model/differ~DifferItem `DifferItem`}s with `reinsert` entries to trigger
      * reconversion. The {@link module:engine/conversion/downcasthelpers~DowncastHelpers#elementToStructure
      * `DowncastHelpers.elementToStructure()`} is using this event to trigger reconversion.
      *
@@ -493,7 +493,7 @@ export default class DowncastDispatcher extends /* #__PURE__ */ EmitterMixin() {
     _testAndFireAddAttributes(item, conversionApi) {
         const data = {
             item,
-            range: Range._createOn(item)
+            range: ModelRange._createOn(item)
         };
         for (const key of data.item.getAttributeKeys()) {
             data.attributeKey = key;
@@ -504,7 +504,7 @@ export default class DowncastDispatcher extends /* #__PURE__ */ EmitterMixin() {
     }
     /**
      * Builds an instance of the {@link module:engine/conversion/downcastdispatcher~DowncastConversionApi} from a template and a given
-     * {@link module:engine/view/downcastwriter~DowncastWriter `DowncastWriter`} and options object.
+     * {@link module:engine/view/downcastwriter~ViewDowncastWriter `ViewDowncastWriter`} and options object.
      *
      * @param writer View writer that should be used to modify the view document.
      * @param refreshedItems A set of model elements that should not reuse their
@@ -515,11 +515,11 @@ export default class DowncastDispatcher extends /* #__PURE__ */ EmitterMixin() {
     _createConversionApi(writer, refreshedItems = new Set(), options = {}) {
         const conversionApi = {
             ...this._conversionApi,
-            consumable: new Consumable(),
+            consumable: new ModelConsumable(),
             writer,
             options,
-            convertItem: item => this._convertInsert(Range._createOn(item), conversionApi),
-            convertChildren: element => this._convertInsert(Range._createIn(element), conversionApi, { doNotAddConsumables: true }),
+            convertItem: item => this._convertInsert(ModelRange._createOn(item), conversionApi),
+            convertChildren: element => this._convertInsert(ModelRange._createIn(element), conversionApi, { doNotAddConsumables: true }),
             convertAttributes: item => this._testAndFireAddAttributes(item, conversionApi),
             canReuseView: viewElement => !refreshedItems.has(conversionApi.mapper.toModelElement(viewElement))
         };
@@ -551,6 +551,6 @@ function getEventName(type, data) {
 function walkerValueToEventData(value) {
     return {
         item: value.item,
-        range: Range._createFromPositionAndShift(value.previousPosition, value.length)
+        range: ModelRange._createFromPositionAndShift(value.previousPosition, value.length)
     };
 }