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

package/src/model/documentfragment.d.ts

@@ -5,25 +5,25 @@
 /**
  * @module engine/model/documentfragment
  */
-import TypeCheckable from './typecheckable.js';
-import type Item from './item.js';
-import type Node from './node.js';
-import type Range from './range.js';
+import { ModelTypeCheckable } from './typecheckable.js';
+import { type ModelItem } from './item.js';
+import { type ModelNode } from './node.js';
+import { type ModelRange } from './range.js';
 /**
- * DocumentFragment represents a part of model which does not have a common root but its top-level nodes
+ * ModelDocumentFragment represents a part of model which does not have a common root but its top-level nodes
  * can be seen as siblings. In other words, it is a detached part of model tree, without a root.
  *
- * DocumentFragment has own {@link module:engine/model/markercollection~MarkerCollection}. Markers from this collection
+ * ModelDocumentFragment has own {@link module:engine/model/markercollection~MarkerCollection}. Markers from this collection
  * will be set to the {@link module:engine/model/model~Model#markers model markers} by a
- * {@link module:engine/model/writer~Writer#insert} function.
+ * {@link module:engine/model/writer~ModelWriter#insert} function.
  */
-export default class DocumentFragment extends TypeCheckable implements Iterable<Node> {
+export declare class ModelDocumentFragment extends ModelTypeCheckable implements Iterable<ModelNode> {
     /**
-     * DocumentFragment static markers map. This is a list of names and {@link module:engine/model/range~Range ranges}
+     * ModelDocumentFragment static markers map. This is a list of names and {@link module:engine/model/range~ModelRange ranges}
      * which will be set as Markers to {@link module:engine/model/model~Model#markers model markers collection}
-     * when DocumentFragment will be inserted to the document.
+     * when ModelDocumentFragment will be inserted to the document.
      */
-    readonly markers: Map<string, Range>;
+    readonly markers: Map<string, ModelRange>;
     /**
      * Artificial element name. Returns `undefined`. Added for compatibility reasons.
      */
@@ -37,25 +37,25 @@ export default class DocumentFragment extends TypeCheckable implements Iterable<
      */
     private readonly _children;
     /**
-     * Creates an empty `DocumentFragment`.
+     * Creates an empty `ModelDocumentFragment`.
      *
      * **Note:** Constructor of this class shouldn't be used directly in the code.
-     * Use the {@link module:engine/model/writer~Writer#createDocumentFragment} method instead.
+     * Use the {@link module:engine/model/writer~ModelWriter#createDocumentFragment} method instead.
      *
      * @internal
-     * @param children Nodes to be contained inside the `DocumentFragment`.
+     * @param children Nodes to be contained inside the `ModelDocumentFragment`.
      */
-    constructor(children?: Node | Iterable<Node>);
+    constructor(children?: ModelNode | Iterable<ModelNode>);
     /**
      * Returns an iterator that iterates over all nodes contained inside this document fragment.
      */
-    [Symbol.iterator](): IterableIterator<Node>;
+    [Symbol.iterator](): IterableIterator<ModelNode>;
     /**
      * Number of this document fragment's children.
      */
     get childCount(): number;
     /**
-     * Sum of {@link module:engine/model/node~Node#offsetSize offset sizes} of all of this document fragment's children.
+     * Sum of {@link module:engine/model/node~ModelNode#offsetSize offset sizes} of all of this document fragment's children.
      */
     get maxOffset(): number;
     /**
@@ -71,19 +71,19 @@ export default class DocumentFragment extends TypeCheckable implements Iterable<
      */
     get previousSibling(): null;
     /**
-     * Artificial root of `DocumentFragment`. Returns itself. Added for compatibility reasons.
+     * Artificial root of `ModelDocumentFragment`. Returns itself. Added for compatibility reasons.
      */
-    get root(): DocumentFragment;
+    get root(): ModelDocumentFragment;
     /**
-     * Artificial parent of `DocumentFragment`. Returns `null`. Added for compatibility reasons.
+     * Artificial parent of `ModelDocumentFragment`. Returns `null`. Added for compatibility reasons.
      */
     get parent(): null;
     /**
-     * Artificial owner of `DocumentFragment`. Returns `null`. Added for compatibility reasons.
+     * Artificial owner of `ModelDocumentFragment`. Returns `null`. Added for compatibility reasons.
      */
     get document(): null;
     /**
-     * Returns `false` as `DocumentFragment` by definition is not attached to a document. Added for compatibility reasons.
+     * Returns `false` as `ModelDocumentFragment` by definition is not attached to a document. Added for compatibility reasons.
      */
     isAttached(): false;
     /**
@@ -96,36 +96,36 @@ export default class DocumentFragment extends TypeCheckable implements Iterable<
      * @param index Index in this document fragment.
      * @returns Child node.
      */
-    getChild(index: number): Node | null;
+    getChild(index: number): ModelNode | null;
     /**
      * Gets the child at the given offset. Returns `null` if incorrect index was passed.
      *
      * @param offset Offset in this document fragment.
      * @returns Child node.
      */
-    getChildAtOffset(offset: number): Node | null;
+    getChildAtOffset(offset: number): ModelNode | null;
     /**
      * Returns an iterator that iterates over all of this document fragment's children.
      */
-    getChildren(): IterableIterator<Node>;
+    getChildren(): IterableIterator<ModelNode>;
     /**
      * Returns an index of the given child node. Returns `null` if given node is not a child of this document fragment.
      *
      * @param node Child node to look for.
      * @returns Child node's index.
      */
-    getChildIndex(node: Node): number | null;
+    getChildIndex(node: ModelNode): number | null;
     /**
      * Returns the starting offset of given child. Starting offset is equal to the sum of
-     * {@link module:engine/model/node~Node#offsetSize offset sizes} of all node's siblings that are before it. Returns `null` if
+     * {@link module:engine/model/node~ModelNode#offsetSize offset sizes} of all node's siblings that are before it. Returns `null` if
      * given node is not a child of this document fragment.
      *
      * @param node Child node to look for.
      * @returns Child node's starting offset.
      */
-    getChildStartOffset(node: Node): number | null;
+    getChildStartOffset(node: ModelNode): number | null;
     /**
-     * Returns path to a `DocumentFragment`, which is an empty array. Added for compatibility reasons.
+     * Returns path to a `ModelDocumentFragment`, which is an empty array. Added for compatibility reasons.
      */
     getPath(): Array<number>;
     /**
@@ -140,7 +140,7 @@ export default class DocumentFragment extends TypeCheckable implements Iterable<
      *
      * @param relativePath Path of the node to find, relative to this element.
      */
-    getNodeByPath(relativePath: Array<number>): Node | DocumentFragment;
+    getNodeByPath(relativePath: Array<number>): ModelNode | ModelDocumentFragment;
     /**
      * Converts offset "position" to index "position".
      *
@@ -150,7 +150,7 @@ export default class DocumentFragment extends TypeCheckable implements Iterable<
      * ```ts
      * const textNode = new Text( 'foo' );
      * const pElement = new Element( 'p' );
-     * const docFrag = new DocumentFragment( [ textNode, pElement ] );
+     * const docFrag = new ModelDocumentFragment( [ textNode, pElement ] );
      * docFrag.offsetToIndex( -1 ); // Returns 0, because offset is too low.
      * docFrag.offsetToIndex( 0 ); // Returns 0, because offset 0 is taken by `textNode` which is at index 0.
      * docFrag.offsetToIndex( 1 ); // Returns 0, because `textNode` has `offsetSize` equal to 3, so it occupies offset 1 too.
@@ -164,49 +164,49 @@ export default class DocumentFragment extends TypeCheckable implements Iterable<
      */
     offsetToIndex(offset: number): number;
     /**
-     * Converts `DocumentFragment` instance to plain object and returns it.
+     * Converts `ModelDocumentFragment` instance to plain object and returns it.
      * Takes care of converting all of this document fragment's children.
      *
-     * @returns `DocumentFragment` instance converted to plain object.
+     * @returns `ModelDocumentFragment` instance converted to plain object.
      */
     toJSON(): unknown;
     /**
-     * Creates a `DocumentFragment` instance from given plain object (i.e. parsed JSON string).
-     * Converts `DocumentFragment` children to proper nodes.
+     * Creates a `ModelDocumentFragment` instance from given plain object (i.e. parsed JSON string).
+     * Converts `ModelDocumentFragment` children to proper nodes.
      *
-     * @param json Plain object to be converted to `DocumentFragment`.
-     * @returns `DocumentFragment` instance created using given plain object.
+     * @param json Plain object to be converted to `ModelDocumentFragment`.
+     * @returns `ModelDocumentFragment` instance created using given plain object.
      */
-    static fromJSON(json: any): DocumentFragment;
+    static fromJSON(json: any): ModelDocumentFragment;
     /**
      * {@link #_insertChild Inserts} one or more nodes at the end of this document fragment.
      *
      * @internal
      * @param items Items to be inserted.
      */
-    _appendChild(items: string | Item | Iterable<string | Item>): void;
+    _appendChild(items: string | ModelItem | Iterable<string | ModelItem>): void;
     /**
-     * Inserts one or more nodes at the given index and sets {@link module:engine/model/node~Node#parent parent} of these nodes
+     * Inserts one or more nodes at the given index and sets {@link module:engine/model/node~ModelNode#parent parent} of these nodes
      * to this document fragment.
      *
      * @internal
      * @param index Index at which nodes should be inserted.
      * @param items Items to be inserted.
      */
-    _insertChild(index: number, items: string | Item | Iterable<string | Item>): void;
+    _insertChild(index: number, items: string | ModelItem | Iterable<string | ModelItem>): void;
     /**
      * Removes one or more nodes starting at the given index
-     * and sets {@link module:engine/model/node~Node#parent parent} of these nodes to `null`.
+     * and sets {@link module:engine/model/node~ModelNode#parent parent} of these nodes to `null`.
      *
      * @internal
      * @param index Index of the first node to remove.
      * @param howMany Number of nodes to remove.
      * @returns Array containing removed nodes.
      */
-    _removeChildren(index: number, howMany?: number): Array<Node>;
+    _removeChildren(index: number, howMany?: number): Array<ModelNode>;
     /**
      * Removes children nodes provided as an array and sets
-     * the {@link module:engine/model/node~Node#parent parent} of these nodes to `null`.
+     * the {@link module:engine/model/node~ModelNode#parent parent} of these nodes to `null`.
      *
      * These nodes do not need to be direct siblings.
      *
@@ -215,5 +215,5 @@ export default class DocumentFragment extends TypeCheckable implements Iterable<
      * @internal
      * @param nodes Array of nodes.
      */
-    _removeChildrenArray(nodes: Array<Node>): void;
+    _removeChildrenArray(nodes: Array<ModelNode>): void;
 }

package/src/model/documentfragment.js

@@ -5,40 +5,40 @@
 /**
  * @module engine/model/documentfragment
  */
-import TypeCheckable from './typecheckable.js';
-import Element from './element.js';
-import NodeList from './nodelist.js';
-import Text from './text.js';
-import TextProxy from './textproxy.js';
+import { ModelTypeCheckable } from './typecheckable.js';
+import { ModelElement } from './element.js';
+import { ModelNodeList } from './nodelist.js';
+import { ModelText } from './text.js';
+import { ModelTextProxy } from './textproxy.js';
 import { isIterable } from '@ckeditor/ckeditor5-utils';
 // @if CK_DEBUG_ENGINE // const { stringifyMap } = require( '../dev-utils/utils' );
 /**
- * DocumentFragment represents a part of model which does not have a common root but its top-level nodes
+ * ModelDocumentFragment represents a part of model which does not have a common root but its top-level nodes
  * can be seen as siblings. In other words, it is a detached part of model tree, without a root.
  *
- * DocumentFragment has own {@link module:engine/model/markercollection~MarkerCollection}. Markers from this collection
+ * ModelDocumentFragment has own {@link module:engine/model/markercollection~MarkerCollection}. Markers from this collection
  * will be set to the {@link module:engine/model/model~Model#markers model markers} by a
- * {@link module:engine/model/writer~Writer#insert} function.
+ * {@link module:engine/model/writer~ModelWriter#insert} function.
  */
-export default class DocumentFragment extends TypeCheckable {
+export class ModelDocumentFragment extends ModelTypeCheckable {
     /**
-     * DocumentFragment static markers map. This is a list of names and {@link module:engine/model/range~Range ranges}
+     * ModelDocumentFragment static markers map. This is a list of names and {@link module:engine/model/range~ModelRange ranges}
      * which will be set as Markers to {@link module:engine/model/model~Model#markers model markers collection}
-     * when DocumentFragment will be inserted to the document.
+     * when ModelDocumentFragment will be inserted to the document.
      */
     markers = new Map();
     /**
      * List of nodes contained inside the document fragment.
      */
-    _children = new NodeList();
+    _children = new ModelNodeList();
     /**
-     * Creates an empty `DocumentFragment`.
+     * Creates an empty `ModelDocumentFragment`.
      *
      * **Note:** Constructor of this class shouldn't be used directly in the code.
-     * Use the {@link module:engine/model/writer~Writer#createDocumentFragment} method instead.
+     * Use the {@link module:engine/model/writer~ModelWriter#createDocumentFragment} method instead.
      *
      * @internal
-     * @param children Nodes to be contained inside the `DocumentFragment`.
+     * @param children Nodes to be contained inside the `ModelDocumentFragment`.
      */
     constructor(children) {
         super();
@@ -59,7 +59,7 @@ export default class DocumentFragment extends TypeCheckable {
         return this._children.length;
     }
     /**
-     * Sum of {@link module:engine/model/node~Node#offsetSize offset sizes} of all of this document fragment's children.
+     * Sum of {@link module:engine/model/node~ModelNode#offsetSize offset sizes} of all of this document fragment's children.
      */
     get maxOffset() {
         return this._children.maxOffset;
@@ -83,25 +83,25 @@ export default class DocumentFragment extends TypeCheckable {
         return null;
     }
     /**
-     * Artificial root of `DocumentFragment`. Returns itself. Added for compatibility reasons.
+     * Artificial root of `ModelDocumentFragment`. Returns itself. Added for compatibility reasons.
      */
     get root() {
         return this;
     }
     /**
-     * Artificial parent of `DocumentFragment`. Returns `null`. Added for compatibility reasons.
+     * Artificial parent of `ModelDocumentFragment`. Returns `null`. Added for compatibility reasons.
      */
     get parent() {
         return null;
     }
     /**
-     * Artificial owner of `DocumentFragment`. Returns `null`. Added for compatibility reasons.
+     * Artificial owner of `ModelDocumentFragment`. Returns `null`. Added for compatibility reasons.
      */
     get document() {
         return null;
     }
     /**
-     * Returns `false` as `DocumentFragment` by definition is not attached to a document. Added for compatibility reasons.
+     * Returns `false` as `ModelDocumentFragment` by definition is not attached to a document. Added for compatibility reasons.
      */
     isAttached() {
         return false;
@@ -147,7 +147,7 @@ export default class DocumentFragment extends TypeCheckable {
     }
     /**
      * Returns the starting offset of given child. Starting offset is equal to the sum of
-     * {@link module:engine/model/node~Node#offsetSize offset sizes} of all node's siblings that are before it. Returns `null` if
+     * {@link module:engine/model/node~ModelNode#offsetSize offset sizes} of all node's siblings that are before it. Returns `null` if
      * given node is not a child of this document fragment.
      *
      * @param node Child node to look for.
@@ -157,7 +157,7 @@ export default class DocumentFragment extends TypeCheckable {
         return this._children.getNodeStartOffset(node);
     }
     /**
-     * Returns path to a `DocumentFragment`, which is an empty array. Added for compatibility reasons.
+     * Returns path to a `ModelDocumentFragment`, which is an empty array. Added for compatibility reasons.
      */
     getPath() {
         return [];
@@ -191,7 +191,7 @@ export default class DocumentFragment extends TypeCheckable {
      * ```ts
      * const textNode = new Text( 'foo' );
      * const pElement = new Element( 'p' );
-     * const docFrag = new DocumentFragment( [ textNode, pElement ] );
+     * const docFrag = new ModelDocumentFragment( [ textNode, pElement ] );
      * docFrag.offsetToIndex( -1 ); // Returns 0, because offset is too low.
      * docFrag.offsetToIndex( 0 ); // Returns 0, because offset 0 is taken by `textNode` which is at index 0.
      * docFrag.offsetToIndex( 1 ); // Returns 0, because `textNode` has `offsetSize` equal to 3, so it occupies offset 1 too.
@@ -207,10 +207,10 @@ export default class DocumentFragment extends TypeCheckable {
         return this._children.offsetToIndex(offset);
     }
     /**
-     * Converts `DocumentFragment` instance to plain object and returns it.
+     * Converts `ModelDocumentFragment` instance to plain object and returns it.
      * Takes care of converting all of this document fragment's children.
      *
-     * @returns `DocumentFragment` instance converted to plain object.
+     * @returns `ModelDocumentFragment` instance converted to plain object.
      */
     toJSON() {
         const json = [];
@@ -220,25 +220,25 @@ export default class DocumentFragment extends TypeCheckable {
         return json;
     }
     /**
-     * Creates a `DocumentFragment` instance from given plain object (i.e. parsed JSON string).
-     * Converts `DocumentFragment` children to proper nodes.
+     * Creates a `ModelDocumentFragment` instance from given plain object (i.e. parsed JSON string).
+     * Converts `ModelDocumentFragment` children to proper nodes.
      *
-     * @param json Plain object to be converted to `DocumentFragment`.
-     * @returns `DocumentFragment` instance created using given plain object.
+     * @param json Plain object to be converted to `ModelDocumentFragment`.
+     * @returns `ModelDocumentFragment` instance created using given plain object.
      */
     static fromJSON(json) {
         const children = [];
         for (const child of json) {
             if (child.name) {
                 // If child has name property, it is an Element.
-                children.push(Element.fromJSON(child));
+                children.push(ModelElement.fromJSON(child));
             }
             else {
                 // Otherwise, it is a Text node.
-                children.push(Text.fromJSON(child));
+                children.push(ModelText.fromJSON(child));
             }
         }
-        return new DocumentFragment(children);
+        return new ModelDocumentFragment(children);
     }
     /**
      * {@link #_insertChild Inserts} one or more nodes at the end of this document fragment.
@@ -250,7 +250,7 @@ export default class DocumentFragment extends TypeCheckable {
         this._insertChild(this.childCount, items);
     }
     /**
-     * Inserts one or more nodes at the given index and sets {@link module:engine/model/node~Node#parent parent} of these nodes
+     * Inserts one or more nodes at the given index and sets {@link module:engine/model/node~ModelNode#parent parent} of these nodes
      * to this document fragment.
      *
      * @internal
@@ -270,7 +270,7 @@ export default class DocumentFragment extends TypeCheckable {
     }
     /**
      * Removes one or more nodes starting at the given index
-     * and sets {@link module:engine/model/node~Node#parent parent} of these nodes to `null`.
+     * and sets {@link module:engine/model/node~ModelNode#parent parent} of these nodes to `null`.
      *
      * @internal
      * @param index Index of the first node to remove.
@@ -286,7 +286,7 @@ export default class DocumentFragment extends TypeCheckable {
     }
     /**
      * Removes children nodes provided as an array and sets
-     * the {@link module:engine/model/node~Node#parent parent} of these nodes to `null`.
+     * the {@link module:engine/model/node~ModelNode#parent parent} of these nodes to `null`.
      *
      * These nodes do not need to be direct siblings.
      *
@@ -304,7 +304,7 @@ export default class DocumentFragment extends TypeCheckable {
 }
 // The magic of type inference using `is` method is centralized in `TypeCheckable` class.
 // Proper overload would interfere with that.
-DocumentFragment.prototype.is = function (type) {
+ModelDocumentFragment.prototype.is = function (type) {
     return type === 'documentFragment' || type === 'model:documentFragment';
 };
 /**
@@ -313,7 +313,7 @@ DocumentFragment.prototype.is = function (type) {
 function normalize(nodes) {
     // Separate condition because string is iterable.
     if (typeof nodes == 'string') {
-        return [new Text(nodes)];
+        return [new ModelText(nodes)];
     }
     if (!isIterable(nodes)) {
         nodes = [nodes];
@@ -322,10 +322,10 @@ function normalize(nodes) {
     return Array.from(nodes)
         .map(node => {
         if (typeof node == 'string') {
-            return new Text(node);
+            return new ModelText(node);
         }
-        if (node instanceof TextProxy) {
-            return new Text(node.data, node.getAttributes());
+        if (node instanceof ModelTextProxy) {
+            return new ModelText(node.data, node.getAttributes());
         }
         return node;
     });