@ckeditor/ckeditor5-engine 36.0.1 → 37.0.0-alpha.0

package/src/view/text.d.ts

@@ -0,0 +1,74 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module engine/view/text
+ */
+import Node from './node';
+import type Document from './document';
+/**
+ * Tree view text node.
+ *
+ * The constructor of this class should not be used directly. To create a new text node instance
+ * use the {@link module:engine/view/downcastwriter~DowncastWriter#createText `DowncastWriter#createText()`}
+ * method when working on data downcasted from the model or the
+ * {@link module:engine/view/upcastwriter~UpcastWriter#createText `UpcastWriter#createText()`}
+ * method when working on non-semantic views.
+ */
+export default class Text extends Node {
+    /**
+     * The text content.
+     *
+     * Setting the data fires the {@link module:engine/view/node~Node#event:change:text change event}.
+     */
+    private _textData;
+    /**
+     * Creates a tree view text node.
+     *
+     * @see module:engine/view/downcastwriter~DowncastWriter#createText
+     * @internal
+     * @param document The document instance to which this text node belongs.
+     * @param data The text's data.
+     */
+    constructor(document: Document, data: string);
+    /**
+     * The text content.
+     */
+    get data(): string;
+    /**
+     * The `_data` property is controlled by a getter and a setter.
+     *
+     * The getter is required when using the addition assignment operator on protected property:
+     *
+     * ```ts
+     * const foo = downcastWriter.createText( 'foo' );
+     * const bar = downcastWriter.createText( 'bar' );
+     *
+     * foo._data += bar.data;   // executes: `foo._data = foo._data + bar.data`
+     * console.log( foo.data ); // prints: 'foobar'
+     * ```
+     *
+     * If the protected getter didn't exist, `foo._data` will return `undefined` and result of the merge will be invalid.
+     *
+     * The setter sets data and fires the {@link module:engine/view/node~Node#event:change:text change event}.
+     *
+     * @internal
+     */
+    get _data(): string;
+    set _data(data: string);
+    /**
+     * Checks if this text node is similar to other text node.
+     * Both nodes should have the same data to be considered as similar.
+     *
+     * @param otherNode Node to check if it is same as this node.
+     */
+    isSimilar(otherNode: Node): boolean;
+    /**
+     * Clones this node.
+     *
+     * @internal
+     * @returns Text node that is a clone of this node.
+     */
+    _clone(): Text;
+}

package/src/view/text.js

@@ -14,34 +14,22 @@ import Node from './node';
  * method when working on data downcasted from the model or the
  * {@link module:engine/view/upcastwriter~UpcastWriter#createText `UpcastWriter#createText()`}
  * method when working on non-semantic views.
- *
- * @extends module:engine/view/node~Node
  */
 export default class Text extends Node {
     /**
      * Creates a tree view text node.
      *
-     * @protected
-     * @param {module:engine/view/document~Document} document The document instance to which this text node belongs.
-     * @param {String} data The text's data.
+     * @see module:engine/view/downcastwriter~DowncastWriter#createText
+     * @internal
+     * @param document The document instance to which this text node belongs.
+     * @param data The text's data.
      */
     constructor(document, data) {
         super(document);
-        /**
-         * The text content.
-         *
-         * Setting the data fires the {@link module:engine/view/node~Node#event:change:text change event}.
-         *
-         * @protected
-         * @member {String} module:engine/view/text~Text#_textData
-         */
         this._textData = data;
     }
     /**
      * The text content.
-     *
-     * @readonly
-     * @type {String}
      */
     get data() {
         return this._textData;
@@ -51,18 +39,19 @@ export default class Text extends Node {
      *
      * The getter is required when using the addition assignment operator on protected property:
      *
-     *		const foo = downcastWriter.createText( 'foo' );
-     *		const bar = downcastWriter.createText( 'bar' );
+     * ```ts
+     * const foo = downcastWriter.createText( 'foo' );
+     * const bar = downcastWriter.createText( 'bar' );
      *
-     *		foo._data += bar.data;   // executes: `foo._data = foo._data + bar.data`
-     *		console.log( foo.data ); // prints: 'foobar'
+     * foo._data += bar.data;   // executes: `foo._data = foo._data + bar.data`
+     * console.log( foo.data ); // prints: 'foobar'
+     * ```
      *
      * If the protected getter didn't exist, `foo._data` will return `undefined` and result of the merge will be invalid.
      *
      * The setter sets data and fires the {@link module:engine/view/node~Node#event:change:text change event}.
      *
-     * @protected
-     * @type {String}
+     * @internal
      */
     get _data() {
         return this.data;
@@ -75,8 +64,7 @@ export default class Text extends Node {
      * Checks if this text node is similar to other text node.
      * Both nodes should have the same data to be considered as similar.
      *
-     * @param {module:engine/view/node~Node} otherNode Node to check if it is same as this node.
-     * @returns {Boolean}
+     * @param otherNode Node to check if it is same as this node.
      */
     isSimilar(otherNode) {
         if (!(otherNode instanceof Text)) {
@@ -87,33 +75,15 @@ export default class Text extends Node {
     /**
      * Clones this node.
      *
-     * @protected
-     * @returns {module:engine/view/text~Text} Text node that is a clone of this node.
+     * @internal
+     * @returns Text node that is a clone of this node.
      */
     _clone() {
         return new Text(this.document, this.data);
     }
 }
-/**
- * Checks whether this object is of the given type.
- *
- *		text.is( '$text' ); // -> true
- *		text.is( 'node' ); // -> true
- *		text.is( 'view:$text' ); // -> true
- *		text.is( 'view:node' ); // -> true
- *
- *		text.is( 'model:$text' ); // -> false
- *		text.is( 'element' ); // -> false
- *		text.is( 'range' ); // -> false
- *
- * {@link module:engine/view/node~Node#is Check the entire list of view objects} which implement the `is()` method.
- *
- * **Note:** Until version 20.0.0 this method wasn't accepting `'$text'` type. The legacy `'text'` type is still
- * accepted for backward compatibility.
- *
- * @param {String} type Type to check.
- * @returns {Boolean}
- */
+// The magic of type inference using `is` method is centralized in `TypeCheckable` class.
+// Proper overload would interfere with that.
 Text.prototype.is = function (type) {
     return type === '$text' || type === 'view:$text' ||
         // This are legacy values kept for backward compatibility.

package/src/view/textproxy.d.ts

@@ -0,0 +1,97 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module engine/view/textproxy
+ */
+import TypeCheckable from './typecheckable';
+import type Document from './document';
+import type DocumentFragment from './documentfragment';
+import type Element from './element';
+import type Node from './node';
+import type Text from './text';
+/**
+ * TextProxy is a wrapper for substring of {@link module:engine/view/text~Text}. Instance of this class is created by
+ * {@link module:engine/view/treewalker~TreeWalker} when only a part of {@link module:engine/view/text~Text} needs to be returned.
+ *
+ * `TextProxy` has an API similar to {@link module:engine/view/text~Text Text} and allows to do most of the common tasks performed
+ * on view nodes.
+ *
+ * **Note:** Some `TextProxy` instances may represent whole text node, not just a part of it.
+ * See {@link module:engine/view/textproxy~TextProxy#isPartial}.
+ *
+ * **Note:** `TextProxy` is a readonly interface.
+ *
+ * **Note:** `TextProxy` instances are created on the fly basing on the current state of parent {@link module:engine/view/text~Text}.
+ * Because of this it is highly unrecommended to store references to `TextProxy instances because they might get
+ * invalidated due to operations on Document. Also TextProxy is not a {@link module:engine/view/node~Node} so it can not be
+ * inserted as a child of {@link module:engine/view/element~Element}.
+ *
+ * `TextProxy` instances are created by {@link module:engine/view/treewalker~TreeWalker view tree walker}. You should not need to create
+ * an instance of this class by your own.
+ */
+export default class TextProxy extends TypeCheckable {
+    /**
+     * Reference to the {@link module:engine/view/text~Text} element which TextProxy is a substring.
+     */
+    readonly textNode: Text;
+    /**
+     * Text data represented by this text proxy.
+     */
+    readonly data: string;
+    /**
+     * Offset in the `textNode` where this `TextProxy` instance starts.
+     */
+    readonly offsetInText: number;
+    /**
+     * Creates a text proxy.
+     *
+     * @internal
+     * @param textNode Text node which part is represented by this text proxy.
+     * @param offsetInText Offset in {@link module:engine/view/textproxy~TextProxy#textNode text node}
+     * from which the text proxy starts.
+     * @param length Text proxy length, that is how many text node's characters, starting from `offsetInText` it represents.
+     * @constructor
+     */
+    constructor(textNode: Text, offsetInText: number, length: number);
+    /**
+     * Offset size of this node.
+     */
+    get offsetSize(): number;
+    /**
+     * Flag indicating whether `TextProxy` instance covers only part of the original {@link module:engine/view/text~Text text node}
+     * (`true`) or the whole text node (`false`).
+     *
+     * This is `false` when text proxy starts at the very beginning of {@link module:engine/view/textproxy~TextProxy#textNode textNode}
+     * ({@link module:engine/view/textproxy~TextProxy#offsetInText offsetInText} equals `0`) and text proxy sizes is equal to
+     * text node size.
+     */
+    get isPartial(): boolean;
+    /**
+     * Parent of this text proxy, which is same as parent of text node represented by this text proxy.
+     */
+    get parent(): Element | DocumentFragment | null;
+    /**
+     * Root of this text proxy, which is same as root of text node represented by this text proxy.
+     */
+    get root(): Node | DocumentFragment;
+    /**
+     * {@link module:engine/view/document~Document View document} that owns this text proxy, or `null` if the text proxy is inside
+     * {@link module:engine/view/documentfragment~DocumentFragment document fragment}.
+     */
+    get document(): Document | null;
+    /**
+     * Returns ancestors array of this text proxy.
+     *
+     * @param options Options object.
+     * @param options.includeSelf When set to `true`, textNode will be also included in parent's array.
+     * @param options.parentFirst When set to `true`, array will be sorted from text proxy parent to
+     * root element, otherwise root element will be the first item in the array.
+     * @returns Array with ancestors.
+     */
+    getAncestors(options?: {
+        includeSelf?: boolean;
+        parentFirst?: boolean;
+    }): Array<Text | Element | DocumentFragment>;
+}

package/src/view/textproxy.js

@@ -31,21 +31,15 @@ export default class TextProxy extends TypeCheckable {
     /**
      * Creates a text proxy.
      *
-     * @protected
-     * @param {module:engine/view/text~Text} textNode Text node which part is represented by this text proxy.
-     * @param {Number} offsetInText Offset in {@link module:engine/view/textproxy~TextProxy#textNode text node}
+     * @internal
+     * @param textNode Text node which part is represented by this text proxy.
+     * @param offsetInText Offset in {@link module:engine/view/textproxy~TextProxy#textNode text node}
      * from which the text proxy starts.
-     * @param {Number} length Text proxy length, that is how many text node's characters, starting from `offsetInText` it represents.
+     * @param length Text proxy length, that is how many text node's characters, starting from `offsetInText` it represents.
      * @constructor
      */
     constructor(textNode, offsetInText, length) {
         super();
-        /**
-         * Reference to the {@link module:engine/view/text~Text} element which TextProxy is a substring.
-         *
-         * @readonly
-         * @member {module:engine/view/text~Text} module:engine/view/textproxy~TextProxy#textNode
-         */
         this.textNode = textNode;
         if (offsetInText < 0 || offsetInText > textNode.data.length) {
             /**
@@ -63,26 +57,11 @@ export default class TextProxy extends TypeCheckable {
              */
             throw new CKEditorError('view-textproxy-wrong-length', this);
         }
-        /**
-         * Text data represented by this text proxy.
-         *
-         * @readonly
-         * @member {String} module:engine/view/textproxy~TextProxy#data
-         */
         this.data = textNode.data.substring(offsetInText, offsetInText + length);
-        /**
-         * Offset in the `textNode` where this `TextProxy` instance starts.
-         *
-         * @readonly
-         * @member {Number} module:engine/view/textproxy~TextProxy#offsetInText
-         */
         this.offsetInText = offsetInText;
     }
     /**
      * Offset size of this node.
-     *
-     * @readonly
-     * @type {Number}
      */
     get offsetSize() {
         return this.data.length;
@@ -94,27 +73,18 @@ export default class TextProxy extends TypeCheckable {
      * This is `false` when text proxy starts at the very beginning of {@link module:engine/view/textproxy~TextProxy#textNode textNode}
      * ({@link module:engine/view/textproxy~TextProxy#offsetInText offsetInText} equals `0`) and text proxy sizes is equal to
      * text node size.
-     *
-     * @readonly
-     * @type {Boolean}
      */
     get isPartial() {
         return this.data.length !== this.textNode.data.length;
     }
     /**
      * Parent of this text proxy, which is same as parent of text node represented by this text proxy.
-     *
-     * @readonly
-     * @type {module:engine/view/element~Element|module:engine/view/documentfragment~DocumentFragment|null}
      */
     get parent() {
         return this.textNode.parent;
     }
     /**
      * Root of this text proxy, which is same as root of text node represented by this text proxy.
-     *
-     * @readonly
-     * @type {module:engine/view/node~Node|module:engine/view/documentfragment~DocumentFragment}
      */
     get root() {
         return this.textNode.root;
@@ -122,9 +92,6 @@ export default class TextProxy extends TypeCheckable {
     /**
      * {@link module:engine/view/document~Document View document} that owns this text proxy, or `null` if the text proxy is inside
      * {@link module:engine/view/documentfragment~DocumentFragment document fragment}.
-     *
-     * @readonly
-     * @type {module:engine/view/document~Document|null}
      */
     get document() {
         return this.textNode.document;
@@ -132,11 +99,11 @@ export default class TextProxy extends TypeCheckable {
     /**
      * Returns ancestors array of this text proxy.
      *
-     * @param {Object} options Options object.
-     * @param {Boolean} [options.includeSelf=false] When set to `true` {#textNode} will be also included in parent's array.
-     * @param {Boolean} [options.parentFirst=false] When set to `true`, array will be sorted from text proxy parent to
+     * @param options Options object.
+     * @param options.includeSelf When set to `true`, textNode will be also included in parent's array.
+     * @param options.parentFirst When set to `true`, array will be sorted from text proxy parent to
      * root element, otherwise root element will be the first item in the array.
-     * @returns {Array} Array with ancestors.
+     * @returns Array with ancestors.
      */
     getAncestors(options = {}) {
         const ancestors = [];
@@ -148,24 +115,8 @@ export default class TextProxy extends TypeCheckable {
         return ancestors;
     }
 }
-/**
- * Checks whether this object is of the given type.
- *
- *		textProxy.is( '$textProxy' ); // -> true
- *		textProxy.is( 'view:$textProxy' ); // -> true
- *
- *		textProxy.is( 'model:$textProxy' ); // -> false
- *		textProxy.is( 'element' ); // -> false
- *		textProxy.is( 'range' ); // -> false
- *
- * {@link module:engine/view/node~Node#is Check the entire list of view objects} which implement the `is()` method.
- *
- * **Note:** Until version 20.0.0 this method wasn't accepting `'$textProxy'` type. The legacy `'textProxy'` type is still
- * accepted for backward compatibility.
- *
- * @param {String} type Type to check.
- * @returns {Boolean}
- */
+// The magic of type inference using `is` method is centralized in `TypeCheckable` class.
+// Proper overload would interfere with that.
 TextProxy.prototype.is = function (type) {
     return type === '$textProxy' || type === 'view:$textProxy' ||
         // This are legacy values kept for backward compatibility.

package/src/view/treewalker.d.ts

@@ -0,0 +1,195 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import Position from './position';
+import type Item from './item';
+import type Range from './range';
+/**
+ * Position iterator class. It allows to iterate forward and backward over the document.
+ */
+export default class TreeWalker implements IterableIterator<TreeWalkerValue> {
+    /**
+     * Walking direction. Defaults `'forward'`.
+     */
+    readonly direction: TreeWalkerDirection;
+    /**
+     * Iterator boundaries.
+     *
+     * When the iterator is walking `'forward'` on the end of boundary or is walking `'backward'`
+     * on the start of boundary, then `{ done: true }` is returned.
+     *
+     * If boundaries are not defined they are set before first and after last child of the root node.
+     */
+    readonly boundaries: Range | null;
+    /**
+     * Flag indicating whether all characters from {@link module:engine/view/text~Text} should be returned as one
+     * {@link module:engine/view/text~Text} or one by one as {@link module:engine/view/textproxy~TextProxy}.
+     */
+    readonly singleCharacters: boolean;
+    /**
+     * Flag indicating whether iterator should enter elements or not. If the iterator is shallow child nodes of any
+     * iterated node will not be returned along with `elementEnd` tag.
+     */
+    readonly shallow: boolean;
+    /**
+     * Flag indicating whether iterator should ignore `elementEnd` tags. If set to `true`, walker will not
+     * return a parent node of the start position. Each {@link module:engine/view/element~Element} will be returned once.
+     * When set to `false` each element might be returned twice: for `'elementStart'` and `'elementEnd'`.
+     */
+    readonly ignoreElementEnd: boolean;
+    /**
+     * Iterator position. If start position is not defined then position depends on {@link #direction}. If direction is
+     * `'forward'` position starts form the beginning, when direction is `'backward'` position starts from the end.
+     */
+    private _position;
+    /**
+     * Start boundary parent.
+     */
+    private readonly _boundaryStartParent;
+    /**
+     * End boundary parent.
+     */
+    private readonly _boundaryEndParent;
+    /**
+     * Creates a range iterator. All parameters are optional, but you have to specify either `boundaries` or `startPosition`.
+     *
+     * @param options Object with configuration.
+     */
+    constructor(options?: TreeWalkerOptions);
+    /**
+     * Iterable interface.
+     */
+    [Symbol.iterator](): IterableIterator<TreeWalkerValue>;
+    /**
+     * Iterator position. If start position is not defined then position depends on {@link #direction}. If direction is
+     * `'forward'` position starts form the beginning, when direction is `'backward'` position starts from the end.
+     */
+    get position(): Position;
+    /**
+     * Moves {@link #position} in the {@link #direction} skipping values as long as the callback function returns `true`.
+     *
+     * For example:
+     *
+     * ```ts
+     * walker.skip( value => value.type == 'text' ); // <p>{}foo</p> -> <p>foo[]</p>
+     * walker.skip( value => true ); // Move the position to the end: <p>{}foo</p> -> <p>foo</p>[]
+     * walker.skip( value => false ); // Do not move the position.
+     * ```
+     *
+     * @param skip Callback function. Gets {@link module:engine/view/treewalker~TreeWalkerValue} and should
+     * return `true` if the value should be skipped or `false` if not.
+     */
+    skip(skip: (value: TreeWalkerValue) => boolean): void;
+    /**
+     * Gets the next tree walker's value.
+     *
+     * @returns Object implementing iterator interface, returning
+     * information about taken step.
+     */
+    next(): IteratorResult<TreeWalkerValue, undefined>;
+    /**
+     * Makes a step forward in view. Moves the {@link #position} to the next position and returns the encountered value.
+     */
+    private _next;
+    /**
+     * Makes a step backward in view. Moves the {@link #position} to the previous position and returns the encountered value.
+     */
+    private _previous;
+    /**
+     * Format returned data and adjust `previousPosition` and `nextPosition` if reach the bound of the {@link module:engine/view/text~Text}.
+     *
+     * @param type Type of step.
+     * @param item Item between old and new position.
+     * @param previousPosition Previous position of iterator.
+     * @param nextPosition Next position of iterator.
+     * @param length Length of the item.
+     */
+    private _formatReturnValue;
+}
+/**
+ * Type of the step made by {@link module:engine/view/treewalker~TreeWalker}.
+ * Possible values: `'elementStart'` if walker is at the beginning of a node, `'elementEnd'` if walker is at the end
+ * of node, or `'text'` if walker traversed over single and multiple characters.
+ * For {@link module:engine/view/text~Text} `elementStart` and `elementEnd` is not returned.
+ */
+export type TreeWalkerValueType = 'elementStart' | 'elementEnd' | 'text';
+/**
+ * Object returned by {@link module:engine/view/treewalker~TreeWalker} when traversing tree view.
+ */
+export interface TreeWalkerValue {
+    /**
+     * Type of the step made by {@link module:engine/view/treewalker~TreeWalker}.
+     */
+    type: TreeWalkerValueType;
+    /**
+     * Item between the old and the new positions of the tree walker.
+     */
+    item: Item;
+    /**
+     * Previous position of the iterator.
+     * * Forward iteration: For `'elementEnd'` it is the last position inside the element. For all other types it is the
+     * position before the item.
+     * * Backward iteration: For `'elementStart'` it is the first position inside the element. For all other types it is
+     * the position after item.
+     * * If the position is at the beginning or at the end of the {@link module:engine/view/text~Text} it is always moved from the
+     * inside of the text to its parent just before or just after that text.
+     */
+    previousPosition: Position;
+    /**
+     * Next position of the iterator.
+     * * Forward iteration: For `'elementStart'` it is the first position inside the element. For all other types it is
+     * the position after the item.
+     * * Backward iteration: For `'elementEnd'` it is last position inside element. For all other types it is the position
+     * before the item.
+     * * If the position is at the beginning or at the end of the {@link module:engine/view/text~Text} it is always moved from the
+     * inside of the text to its parent just before or just after that text.
+     */
+    nextPosition: Position;
+    /**
+     * Length of the item. For `'elementStart'` it is `1`. For `'text'` it is
+     * the length of that text. For `'elementEnd'` it is `undefined`.
+     */
+    length?: number;
+}
+/**
+ * Tree walking direction.
+ */
+export type TreeWalkerDirection = 'forward' | 'backward';
+/**
+ * The configuration of {@link ~TreeWalker}.
+ */
+export interface TreeWalkerOptions {
+    /**
+     * Walking direction.
+     *
+     * @default 'forward'
+     */
+    direction?: TreeWalkerDirection;
+    /**
+     * Range to define boundaries of the iterator.
+     */
+    boundaries?: Range | null;
+    /**
+     * Starting position.
+     */
+    startPosition?: Position;
+    /**
+     * Flag indicating whether all characters from
+     * {@link module:engine/view/text~Text} should be returned as one {@link module:engine/view/text~Text} (`false`) or one by one as
+     * {@link module:engine/view/textproxy~TextProxy} (`true`).
+     */
+    singleCharacters?: boolean;
+    /**
+     * Flag indicating whether iterator should enter elements or not. If the
+     * iterator is shallow child nodes of any iterated node will not be returned along with `elementEnd` tag.
+     */
+    shallow?: boolean;
+    /**
+     * Flag indicating whether iterator should ignore `elementEnd`
+     * tags. If the option is true walker will not return a parent node of start position. If this option is `true`
+     * each {@link module:engine/view/element~Element} will be returned once, while if the option is `false` they might be returned
+     * twice: for `'elementStart'` and `'elementEnd'`.
+     */
+    ignoreElementEnd?: boolean;
+}