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

package/src/model/markercollection.d.ts

@@ -5,10 +5,10 @@
 /**
  * @module engine/model/markercollection
  */
-import TypeCheckable from './typecheckable.js';
-import LiveRange, { type LiveRangeChangeContentEvent, type LiveRangeChangeRangeEvent, type LiveRangeChangeEvent } from './liverange.js';
-import type Position from './position.js';
-import type Range from './range.js';
+import { ModelTypeCheckable } from './typecheckable.js';
+import { ModelLiveRange, type ModelLiveRangeChangeContentEvent, type ModelLiveRangeChangeRangeEvent, type ModelLiveRangeChangeEvent } from './liverange.js';
+import { type ModelPosition } from './position.js';
+import { type ModelRange } from './range.js';
 declare const MarkerCollection_base: {
     new (): import("@ckeditor/ckeditor5-utils").Emitter;
     prototype: import("@ckeditor/ckeditor5-utils").Emitter;
@@ -18,8 +18,8 @@ declare const MarkerCollection_base: {
  * It lets you {@link module:engine/model/markercollection~MarkerCollection#get get} markers or track them using
  * {@link module:engine/model/markercollection~MarkerCollection#event:update} event.
  *
- * To create, change or remove makers use {@link module:engine/model/writer~Writer model writers'} methods:
- * {@link module:engine/model/writer~Writer#addMarker} or {@link module:engine/model/writer~Writer#removeMarker}. Since
+ * To create, change or remove makers use {@link module:engine/model/writer~ModelWriter model writers'} methods:
+ * {@link module:engine/model/writer~ModelWriter#addMarker} or {@link module:engine/model/writer~ModelWriter#removeMarker}. Since
  * the writer is the only proper way to change the data model it is not possible to change markers directly using this
  * collection. All markers created by the writer will be automatically added to this collection.
  *
@@ -27,7 +27,7 @@ declare const MarkerCollection_base: {
  *
  * @see module:engine/model/markercollection~Marker
  */
-export default class MarkerCollection extends /* #__PURE__ */ MarkerCollection_base implements Iterable<Marker> {
+export declare class MarkerCollection extends /* #__PURE__ */ MarkerCollection_base implements Iterable<Marker> {
     /**
      * Stores {@link ~Marker markers} added to the collection.
      */
@@ -55,7 +55,7 @@ export default class MarkerCollection extends /* #__PURE__ */ MarkerCollection_b
     get(markerName: string): Marker | null;
     /**
      * Creates and adds a {@link ~Marker marker} to the `MarkerCollection` with given name on given
-     * {@link module:engine/model/range~Range range}.
+     * {@link module:engine/model/range~ModelRange range}.
      *
      * If `MarkerCollection` already had a marker with given name (or {@link ~Marker marker} was passed), the marker in
      * collection is updated and {@link module:engine/model/markercollection~MarkerCollection#event:update} event is fired
@@ -71,7 +71,7 @@ export default class MarkerCollection extends /* #__PURE__ */ MarkerCollection_b
      * (is persisted in the editor's data).
      * @returns `Marker` instance which was added or updated.
      */
-    _set(markerOrName: string | Marker, range: Range, managedUsingOperations?: boolean, affectsData?: boolean): Marker;
+    _set(markerOrName: string | Marker, range: ModelRange, managedUsingOperations?: boolean, affectsData?: boolean): Marker;
     /**
      * Removes given {@link ~Marker marker} or a marker with given name from the `MarkerCollection`.
      *
@@ -92,13 +92,14 @@ export default class MarkerCollection extends /* #__PURE__ */ MarkerCollection_b
      */
     _refresh(markerOrName: string | Marker): void;
     /**
-     * Returns iterator that iterates over all markers, which ranges contain given {@link module:engine/model/position~Position position}.
+     * Returns iterator that iterates over all markers, which ranges
+     * contain given {@link module:engine/model/position~ModelPosition position}.
      */
-    getMarkersAtPosition(position: Position): IterableIterator<Marker>;
+    getMarkersAtPosition(position: ModelPosition): IterableIterator<Marker>;
     /**
-     * Returns iterator that iterates over all markers, which intersects with given {@link module:engine/model/range~Range range}.
+     * Returns iterator that iterates over all markers, which intersects with given {@link module:engine/model/range~ModelRange range}.
      */
-    getMarkersIntersectingRange(range: Range): Iterable<Marker>;
+    getMarkersIntersectingRange(range: ModelRange): Iterable<Marker>;
     /**
      * Destroys marker collection and all markers inside it.
      */
@@ -125,7 +126,7 @@ export interface MarkerData {
     /**
      * Marker range. `null` if the marker was removed.
      */
-    range: Range | null;
+    range: ModelRange | null;
     /**
      * A property defining if the marker affects data.
      */
@@ -135,10 +136,10 @@ export interface MarkerData {
      */
     managedUsingOperations: boolean;
 }
-declare const Marker_base: import("@ckeditor/ckeditor5-utils").Mixed<typeof TypeCheckable, import("@ckeditor/ckeditor5-utils").Emitter>;
+declare const Marker_base: import("@ckeditor/ckeditor5-utils").Mixed<typeof ModelTypeCheckable, import("@ckeditor/ckeditor5-utils").Emitter>;
 /**
  * `Marker` is a continuous part of the model (like a range), is named and represents some kind of information about the
- * marked part of the model document. In contrary to {@link module:engine/model/node~Node nodes}, which are building blocks of
+ * marked part of the model document. In contrary to {@link module:engine/model/node~ModelNode nodes}, which are building blocks of
  * the model document tree, markers are not stored directly in the document tree but in the
  * {@link module:engine/model/model~Model#markers model markers' collection}. Still, they are document data, by giving
  * additional meaning to the part of a model document between marker start and marker end.
@@ -157,7 +158,7 @@ declare const Marker_base: import("@ckeditor/ckeditor5-utils").Mixed<typeof Type
  * Markers are built from a name and a range.
  *
  * Range of the marker is updated automatically when document changes, using
- * {@link module:engine/model/liverange~LiveRange live range} mechanism.
+ * {@link module:engine/model/liverange~ModelLiveRange live range} mechanism.
  *
  * Name is used to group and identify markers. Names have to be unique, but markers can be grouped by
  * using common prefixes, separated with `:`, for example: `user:john` or `search:3`. That's useful in term of creating
@@ -167,7 +168,7 @@ declare const Marker_base: import("@ckeditor/ckeditor5-utils").Mixed<typeof Type
  *
  * There are two types of markers.
  *
- * 1. Markers managed directly, without using operations. They are added directly by {@link module:engine/model/writer~Writer}
+ * 1. Markers managed directly, without using operations. They are added directly by {@link module:engine/model/writer~ModelWriter}
  * to the {@link module:engine/model/markercollection~MarkerCollection} without any additional mechanism. They can be used
  * as bookmarks or visual markers. They are great for showing results of the find, or select link when the focus is in the input.
  *
@@ -176,8 +177,8 @@ declare const Marker_base: import("@ckeditor/ckeditor5-utils").Mixed<typeof Type
  * Therefore, they are handled in the undo stack and synchronized between clients if the collaboration plugin is enabled.
  * This type of markers is useful for solutions like spell checking or comments.
  *
- * Both type of them should be added / updated by {@link module:engine/model/writer~Writer#addMarker}
- * and removed by {@link module:engine/model/writer~Writer#removeMarker} methods.
+ * Both type of them should be added / updated by {@link module:engine/model/writer~ModelWriter#addMarker}
+ * and removed by {@link module:engine/model/writer~ModelWriter#removeMarker} methods.
  *
  * ```ts
  * model.change( ( writer ) => {
@@ -189,7 +190,7 @@ declare const Marker_base: import("@ckeditor/ckeditor5-utils").Mixed<typeof Type
  * } );
  * ```
  *
- * See {@link module:engine/model/writer~Writer} to find more examples.
+ * See {@link module:engine/model/writer~ModelWriter} to find more examples.
  *
  * Since markers need to track change in the document, for efficiency reasons, it is best to create and keep as little
  * markers as possible and remove them as soon as they are not needed anymore.
@@ -235,11 +236,11 @@ declare class Marker extends /* #__PURE__ */ Marker_base {
      * @param managedUsingOperations Specifies whether the marker is managed using operations.
      * @param affectsData Specifies whether the marker affects the data produced by the data pipeline (is persisted in the editor's data).
      */
-    constructor(name: string, liveRange: LiveRange, managedUsingOperations: boolean, affectsData: boolean);
+    constructor(name: string, liveRange: ModelLiveRange, managedUsingOperations: boolean, affectsData: boolean);
     /**
      * A value indicating if the marker is managed using operations.
      * See {@link ~Marker marker class description} to learn more about marker types.
-     * See {@link module:engine/model/writer~Writer#addMarker}.
+     * See {@link module:engine/model/writer~ModelWriter#addMarker}.
      */
     get managedUsingOperations(): boolean;
     /**
@@ -253,22 +254,22 @@ declare class Marker extends /* #__PURE__ */ Marker_base {
     /**
      * Returns current marker start position.
      */
-    getStart(): Position;
+    getStart(): ModelPosition;
     /**
      * Returns current marker end position.
      */
-    getEnd(): Position;
+    getEnd(): ModelPosition;
     /**
      * Returns a range that represents the current state of the marker.
      *
-     * Keep in mind that returned value is a {@link module:engine/model/range~Range Range}, not a
-     * {@link module:engine/model/liverange~LiveRange LiveRange}. This means that it is up-to-date and relevant only
+     * Keep in mind that returned value is a {@link module:engine/model/range~ModelRange Range}, not a
+     * {@link module:engine/model/liverange~ModelLiveRange ModelLiveRange}. This means that it is up-to-date and relevant only
      * until next model document change. Do not store values returned by this method. Instead, store {@link ~Marker#name}
      * and get `Marker` instance from {@link module:engine/model/markercollection~MarkerCollection MarkerCollection} every
      * time there is a need to read marker properties. This will guarantee that the marker has not been removed and
      * that it's data is up-to-date.
      */
-    getRange(): Range;
+    getRange(): ModelRange;
     /**
      * Binds new live range to the marker and detach the old one if is attached.
      *
@@ -276,7 +277,7 @@ declare class Marker extends /* #__PURE__ */ Marker_base {
      * @param liveRange Live range to attach
      * @returns Attached live range.
      */
-    _attachLiveRange(liveRange: LiveRange): LiveRange;
+    _attachLiveRange(liveRange: ModelLiveRange): ModelLiveRange;
     /**
      * Unbinds and destroys currently attached live range.
      *
@@ -284,35 +285,35 @@ declare class Marker extends /* #__PURE__ */ Marker_base {
      */
     _detachLiveRange(): void;
 }
-export type { Marker };
+export { Marker };
 /**
- * Fired whenever {@link ~Marker#_liveRange marker range} is changed due to changes on {@link module:engine/model/document~Document}.
- * This is a delegated {@link module:engine/model/liverange~LiveRange#event:change:range LiveRange change:range event}.
+ * Fired whenever {@link ~Marker#_liveRange marker range} is changed due to changes on {@link module:engine/model/document~ModelDocument}.
+ * This is a delegated {@link module:engine/model/liverange~ModelLiveRange#event:change:range ModelLiveRange change:range event}.
  *
  * When marker is removed from {@link module:engine/model/markercollection~MarkerCollection MarkerCollection},
  * all event listeners listening to it should be removed. It is best to do it on
  * {@link module:engine/model/markercollection~MarkerCollection#event:update MarkerCollection update event}.
  *
- * @see module:engine/model/liverange~LiveRange#event:change:range
+ * @see module:engine/model/liverange~ModelLiveRange#event:change:range
  * @eventName ~Marker#change:range
  */
-export type MarkerChangeRangeEvent = LiveRangeChangeRangeEvent;
+export type MarkerChangeRangeEvent = ModelLiveRangeChangeRangeEvent;
 /**
- * Fired whenever change on {@link module:engine/model/document~Document} is done inside {@link ~Marker#_liveRange marker range}.
- * This is a delegated {@link module:engine/model/liverange~LiveRange#event:change:content LiveRange change:content event}.
+ * Fired whenever change on {@link module:engine/model/document~ModelDocument} is done inside {@link ~Marker#_liveRange marker range}.
+ * This is a delegated {@link module:engine/model/liverange~ModelLiveRange#event:change:content ModelLiveRange change:content event}.
  *
  * When marker is removed from {@link module:engine/model/markercollection~MarkerCollection MarkerCollection},
  * all event listeners listening to it should be removed. It is best to do it on
  * {@link module:engine/model/markercollection~MarkerCollection#event:update MarkerCollection update event}.
  *
- * @see module:engine/model/liverange~LiveRange#event:change:content
+ * @see module:engine/model/liverange~ModelLiveRange#event:change:content
  * @eventName ~Marker#change:content
  */
-export type MarkerCollectionChangeContentEvent = LiveRangeChangeContentEvent;
+export type MarkerCollectionChangeContentEvent = ModelLiveRangeChangeContentEvent;
 /**
  * Describes `change:range` or `change:content` event.
  */
-export type MarkerChangeEvent = LiveRangeChangeEvent;
+export type MarkerChangeEvent = ModelLiveRangeChangeEvent;
 /**
  * Fired whenever marker is added, updated or removed from `MarkerCollection`.
  *
@@ -326,7 +327,7 @@ export type MarkerChangeEvent = LiveRangeChangeEvent;
  */
 export type MarkerCollectionUpdateEvent = {
     name: 'update' | `update:${string}`;
-    args: [marker: Marker, oldRange: Range | null, newRange: Range | null, oldMarkerData: MarkerData];
+    args: [marker: Marker, oldRange: ModelRange | null, newRange: ModelRange | null, oldMarkerData: MarkerData];
 };
 /**
  * Cannot use a {@link module:engine/model/markercollection~MarkerCollection#destroy destroyed marker} instance.

package/src/model/markercollection.js

@@ -5,16 +5,16 @@
 /**
  * @module engine/model/markercollection
  */
-import TypeCheckable from './typecheckable.js';
-import LiveRange from './liverange.js';
+import { ModelTypeCheckable } from './typecheckable.js';
+import { ModelLiveRange } from './liverange.js';
 import { CKEditorError, EmitterMixin } from '@ckeditor/ckeditor5-utils';
 /**
  * The collection of all {@link module:engine/model/markercollection~Marker markers} attached to the document.
  * It lets you {@link module:engine/model/markercollection~MarkerCollection#get get} markers or track them using
  * {@link module:engine/model/markercollection~MarkerCollection#event:update} event.
  *
- * To create, change or remove makers use {@link module:engine/model/writer~Writer model writers'} methods:
- * {@link module:engine/model/writer~Writer#addMarker} or {@link module:engine/model/writer~Writer#removeMarker}. Since
+ * To create, change or remove makers use {@link module:engine/model/writer~ModelWriter model writers'} methods:
+ * {@link module:engine/model/writer~ModelWriter#addMarker} or {@link module:engine/model/writer~ModelWriter#removeMarker}. Since
  * the writer is the only proper way to change the data model it is not possible to change markers directly using this
  * collection. All markers created by the writer will be automatically added to this collection.
  *
@@ -22,7 +22,7 @@ import { CKEditorError, EmitterMixin } from '@ckeditor/ckeditor5-utils';
  *
  * @see module:engine/model/markercollection~Marker
  */
-export default class MarkerCollection extends /* #__PURE__ */ EmitterMixin() {
+export class MarkerCollection extends /* #__PURE__ */ EmitterMixin() {
     /**
      * Stores {@link ~Marker markers} added to the collection.
      */
@@ -57,7 +57,7 @@ export default class MarkerCollection extends /* #__PURE__ */ EmitterMixin() {
     }
     /**
      * Creates and adds a {@link ~Marker marker} to the `MarkerCollection` with given name on given
-     * {@link module:engine/model/range~Range range}.
+     * {@link module:engine/model/range~ModelRange range}.
      *
      * If `MarkerCollection` already had a marker with given name (or {@link ~Marker marker} was passed), the marker in
      * collection is updated and {@link module:engine/model/markercollection~MarkerCollection#event:update} event is fired
@@ -89,7 +89,7 @@ export default class MarkerCollection extends /* #__PURE__ */ EmitterMixin() {
             const oldRange = oldMarker.getRange();
             let hasChanged = false;
             if (!oldRange.isEqual(range)) {
-                oldMarker._attachLiveRange(LiveRange.fromRange(range));
+                oldMarker._attachLiveRange(ModelLiveRange.fromRange(range));
                 hasChanged = true;
             }
             if (managedUsingOperations != oldMarker.managedUsingOperations) {
@@ -105,7 +105,7 @@ export default class MarkerCollection extends /* #__PURE__ */ EmitterMixin() {
             }
             return oldMarker;
         }
-        const liveRange = LiveRange.fromRange(range);
+        const liveRange = ModelLiveRange.fromRange(range);
         const marker = new Marker(markerName, liveRange, managedUsingOperations, affectsData);
         this._markers.set(markerName, marker);
         this.fire(`update:${markerName}`, marker, null, range, { ...marker.getData(), range: null });
@@ -154,7 +154,8 @@ export default class MarkerCollection extends /* #__PURE__ */ EmitterMixin() {
         this.fire(`update:${markerName}`, marker, range, range, marker.getData());
     }
     /**
-     * Returns iterator that iterates over all markers, which ranges contain given {@link module:engine/model/position~Position position}.
+     * Returns iterator that iterates over all markers, which ranges
+     * contain given {@link module:engine/model/position~ModelPosition position}.
      */
     *getMarkersAtPosition(position) {
         for (const marker of this) {
@@ -164,7 +165,7 @@ export default class MarkerCollection extends /* #__PURE__ */ EmitterMixin() {
         }
     }
     /**
-     * Returns iterator that iterates over all markers, which intersects with given {@link module:engine/model/range~Range range}.
+     * Returns iterator that iterates over all markers, which intersects with given {@link module:engine/model/range~ModelRange range}.
      */
     *getMarkersIntersectingRange(range) {
         for (const marker of this) {
@@ -212,7 +213,7 @@ export default class MarkerCollection extends /* #__PURE__ */ EmitterMixin() {
 }
 /**
  * `Marker` is a continuous part of the model (like a range), is named and represents some kind of information about the
- * marked part of the model document. In contrary to {@link module:engine/model/node~Node nodes}, which are building blocks of
+ * marked part of the model document. In contrary to {@link module:engine/model/node~ModelNode nodes}, which are building blocks of
  * the model document tree, markers are not stored directly in the document tree but in the
  * {@link module:engine/model/model~Model#markers model markers' collection}. Still, they are document data, by giving
  * additional meaning to the part of a model document between marker start and marker end.
@@ -231,7 +232,7 @@ export default class MarkerCollection extends /* #__PURE__ */ EmitterMixin() {
  * Markers are built from a name and a range.
  *
  * Range of the marker is updated automatically when document changes, using
- * {@link module:engine/model/liverange~LiveRange live range} mechanism.
+ * {@link module:engine/model/liverange~ModelLiveRange live range} mechanism.
  *
  * Name is used to group and identify markers. Names have to be unique, but markers can be grouped by
  * using common prefixes, separated with `:`, for example: `user:john` or `search:3`. That's useful in term of creating
@@ -241,7 +242,7 @@ export default class MarkerCollection extends /* #__PURE__ */ EmitterMixin() {
  *
  * There are two types of markers.
  *
- * 1. Markers managed directly, without using operations. They are added directly by {@link module:engine/model/writer~Writer}
+ * 1. Markers managed directly, without using operations. They are added directly by {@link module:engine/model/writer~ModelWriter}
  * to the {@link module:engine/model/markercollection~MarkerCollection} without any additional mechanism. They can be used
  * as bookmarks or visual markers. They are great for showing results of the find, or select link when the focus is in the input.
  *
@@ -250,8 +251,8 @@ export default class MarkerCollection extends /* #__PURE__ */ EmitterMixin() {
  * Therefore, they are handled in the undo stack and synchronized between clients if the collaboration plugin is enabled.
  * This type of markers is useful for solutions like spell checking or comments.
  *
- * Both type of them should be added / updated by {@link module:engine/model/writer~Writer#addMarker}
- * and removed by {@link module:engine/model/writer~Writer#removeMarker} methods.
+ * Both type of them should be added / updated by {@link module:engine/model/writer~ModelWriter#addMarker}
+ * and removed by {@link module:engine/model/writer~ModelWriter#removeMarker} methods.
  *
  * ```ts
  * model.change( ( writer ) => {
@@ -263,7 +264,7 @@ export default class MarkerCollection extends /* #__PURE__ */ EmitterMixin() {
  * } );
  * ```
  *
- * See {@link module:engine/model/writer~Writer} to find more examples.
+ * See {@link module:engine/model/writer~ModelWriter} to find more examples.
  *
  * Since markers need to track change in the document, for efficiency reasons, it is best to create and keep as little
  * markers as possible and remove them as soon as they are not needed anymore.
@@ -279,7 +280,7 @@ export default class MarkerCollection extends /* #__PURE__ */ EmitterMixin() {
  *
  * `Marker` instances are created and destroyed only by {@link ~MarkerCollection MarkerCollection}.
  */
-class Marker extends /* #__PURE__ */ EmitterMixin(TypeCheckable) {
+class Marker extends /* #__PURE__ */ EmitterMixin(ModelTypeCheckable) {
     /**
      * Marker's name.
      */
@@ -319,7 +320,7 @@ class Marker extends /* #__PURE__ */ EmitterMixin(TypeCheckable) {
     /**
      * A value indicating if the marker is managed using operations.
      * See {@link ~Marker marker class description} to learn more about marker types.
-     * See {@link module:engine/model/writer~Writer#addMarker}.
+     * See {@link module:engine/model/writer~ModelWriter#addMarker}.
      */
     get managedUsingOperations() {
         if (!this._liveRange) {
@@ -367,8 +368,8 @@ class Marker extends /* #__PURE__ */ EmitterMixin(TypeCheckable) {
     /**
      * Returns a range that represents the current state of the marker.
      *
-     * Keep in mind that returned value is a {@link module:engine/model/range~Range Range}, not a
-     * {@link module:engine/model/liverange~LiveRange LiveRange}. This means that it is up-to-date and relevant only
+     * Keep in mind that returned value is a {@link module:engine/model/range~ModelRange Range}, not a
+     * {@link module:engine/model/liverange~ModelLiveRange ModelLiveRange}. This means that it is up-to-date and relevant only
      * until next model document change. Do not store values returned by this method. Instead, store {@link ~Marker#name}
      * and get `Marker` instance from {@link module:engine/model/markercollection~MarkerCollection MarkerCollection} every
      * time there is a need to read marker properties. This will guarantee that the marker has not been removed and
@@ -414,6 +415,7 @@ class Marker extends /* #__PURE__ */ EmitterMixin(TypeCheckable) {
 Marker.prototype.is = function (type) {
     return type === 'marker' || type === 'model:marker';
 };
+export { Marker };
 /**
  * Cannot use a {@link module:engine/model/markercollection~MarkerCollection#destroy destroyed marker} instance.
  *