@ckeditor/ckeditor5-engine 39.0.2 → 40.0.0

package/src/view/text.d.ts

@@ -1,74 +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;
-}
+/**
+ * @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

@@ -1,93 +1,93 @@
-/**
- * @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';
-/**
- * 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 {
-    /**
-     * 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, data) {
-        super(document);
-        this._textData = data;
-    }
-    /**
-     * The text content.
-     */
-    get data() {
-        return this._textData;
-    }
-    /**
-     * 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() {
-        return this.data;
-    }
-    set _data(data) {
-        this._fireChange('text', this);
-        this._textData = data;
-    }
-    /**
-     * 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) {
-        if (!(otherNode instanceof Text)) {
-            return false;
-        }
-        return this === otherNode || this.data === otherNode.data;
-    }
-    /**
-     * Clones this node.
-     *
-     * @internal
-     * @returns Text node that is a clone of this node.
-     */
-    _clone() {
-        return new Text(this.document, this.data);
-    }
-}
-// 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.
-        type === 'text' || type === 'view:text' ||
-        // From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
-        type === 'node' || type === 'view:node';
-};
+/**
+ * @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';
+/**
+ * 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 {
+    /**
+     * 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, data) {
+        super(document);
+        this._textData = data;
+    }
+    /**
+     * The text content.
+     */
+    get data() {
+        return this._textData;
+    }
+    /**
+     * 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() {
+        return this.data;
+    }
+    set _data(data) {
+        this._fireChange('text', this);
+        this._textData = data;
+    }
+    /**
+     * 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) {
+        if (!(otherNode instanceof Text)) {
+            return false;
+        }
+        return this === otherNode || this.data === otherNode.data;
+    }
+    /**
+     * Clones this node.
+     *
+     * @internal
+     * @returns Text node that is a clone of this node.
+     */
+    _clone() {
+        return new Text(this.document, this.data);
+    }
+}
+// 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.
+        type === 'text' || type === 'view:text' ||
+        // From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
+        type === 'node' || type === 'view:node';
+};

package/src/view/textproxy.d.ts

@@ -1,97 +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>;
-}
+/**
+ * @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>;
+}