@ckeditor/ckeditor5-engine 48.2.0 → 48.3.0-alpha.0

package/dist/view/text.d.ts

@@ -1,80 +1,80 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module engine/view/text
- */
-import { ViewNode } from './node.js';
-import { type ViewDocument } from './document.js';
+* @module engine/view/text
+*/
+import { ViewNode } from "./node.js";
+import { type ViewDocument } from "./document.js";
 /**
- * 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~ViewDowncastWriter#createText `ViewDowncastWriter#createText()`}
- * method when working on data downcasted from the model or the
- * {@link module:engine/view/upcastwriter~ViewUpcastWriter#createText `ViewUpcastWriter#createText()`}
- * method when working on non-semantic views.
- */
+* 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~ViewDowncastWriter#createText `ViewDowncastWriter#createText()`}
+* method when working on data downcasted from the model or the
+* {@link module:engine/view/upcastwriter~ViewUpcastWriter#createText `ViewUpcastWriter#createText()`}
+* method when working on non-semantic views.
+*/
 export declare class ViewText extends ViewNode {
-    /**
-     * The text content.
-     *
-     * Setting the data fires the {@link module:engine/view/node~ViewNode#event:change:text change event}.
-     */
-    private _textData;
-    /**
-     * Creates a tree view text node.
-     *
-     * @see module:engine/view/downcastwriter~ViewDowncastWriter#createText
-     * @internal
-     * @param document The document instance to which this text node belongs.
-     * @param data The text's data.
-     */
-    constructor(document: ViewDocument, 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~ViewNode#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: ViewNode): boolean;
-    /**
-     * Converts `ViewText` instance to plain object and returns it.
-     *
-     * @returns `ViewText` instance converted to plain object.
-     */
-    toJSON(): unknown;
-    /**
-     * Clones this node.
-     *
-     * @internal
-     * @returns Text node that is a clone of this node.
-     */
-    _clone(): ViewText;
+	/**
+	* The text content.
+	*
+	* Setting the data fires the {@link module:engine/view/node~ViewNode#event:change:text change event}.
+	*/
+	private _textData;
+	/**
+	* Creates a tree view text node.
+	*
+	* @see module:engine/view/downcastwriter~ViewDowncastWriter#createText
+	* @internal
+	* @param document The document instance to which this text node belongs.
+	* @param data The text's data.
+	*/
+	constructor(document: ViewDocument, 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~ViewNode#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: ViewNode): boolean;
+	/**
+	* Converts `ViewText` instance to plain object and returns it.
+	*
+	* @returns `ViewText` instance converted to plain object.
+	*/
+	override toJSON(): unknown;
+	/**
+	* Clones this node.
+	*
+	* @internal
+	* @returns Text node that is a clone of this node.
+	*/
+	_clone(): ViewText;
 }

package/dist/view/textproxy.d.ts

@@ -1,97 +1,97 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module engine/view/textproxy
- */
-import { ViewTypeCheckable } from './typecheckable.js';
-import { type ViewDocument } from './document.js';
-import { type ViewDocumentFragment } from './documentfragment.js';
-import { type ViewElement } from './element.js';
-import { type ViewNode } from './node.js';
-import { type ViewText } from './text.js';
+* @module engine/view/textproxy
+*/
+import { ViewTypeCheckable } from "./typecheckable.js";
+import { type ViewDocument } from "./document.js";
+import { type ViewDocumentFragment } from "./documentfragment.js";
+import { type ViewElement } from "./element.js";
+import { type ViewNode } from "./node.js";
+import { type ViewText } from "./text.js";
 /**
- * ViewTextProxy is a wrapper for substring of {@link module:engine/view/text~ViewText}. Instance of this class is created by
- * {@link module:engine/view/treewalker~ViewTreeWalker} when only a part of {@link module:engine/view/text~ViewText} needs to be returned.
- *
- * `ViewTextProxy` has an API similar to {@link module:engine/view/text~ViewText Text} and allows to do most of the common tasks performed
- * on view nodes.
- *
- * **Note:** Some `ViewTextProxy` instances may represent whole text node, not just a part of it.
- * See {@link module:engine/view/textproxy~ViewTextProxy#isPartial}.
- *
- * **Note:** `ViewTextProxy` is a readonly interface.
- *
- * **Note:** `ViewTextProxy` instances are created on the fly basing
- * on the current state of parent {@link module:engine/view/text~ViewText}.
- * Because of this it is highly unrecommended to store references to `TextProxy instances because they might get
- * invalidated due to operations on Document. Also ViewTextProxy is not a {@link module:engine/view/node~ViewNode} so it cannot be
- * inserted as a child of {@link module:engine/view/element~ViewElement}.
- *
- * `ViewTextProxy` instances are created by {@link module:engine/view/treewalker~ViewTreeWalker view tree walker}.
- * You should not need to create an instance of this class by your own.
- */
+* ViewTextProxy is a wrapper for substring of {@link module:engine/view/text~ViewText}. Instance of this class is created by
+* {@link module:engine/view/treewalker~ViewTreeWalker} when only a part of {@link module:engine/view/text~ViewText} needs to be returned.
+*
+* `ViewTextProxy` has an API similar to {@link module:engine/view/text~ViewText Text} and allows to do most of the common tasks performed
+* on view nodes.
+*
+* **Note:** Some `ViewTextProxy` instances may represent whole text node, not just a part of it.
+* See {@link module:engine/view/textproxy~ViewTextProxy#isPartial}.
+*
+* **Note:** `ViewTextProxy` is a readonly interface.
+*
+* **Note:** `ViewTextProxy` instances are created on the fly basing
+* on the current state of parent {@link module:engine/view/text~ViewText}.
+* Because of this it is highly unrecommended to store references to `TextProxy instances because they might get
+* invalidated due to operations on Document. Also ViewTextProxy is not a {@link module:engine/view/node~ViewNode} so it cannot be
+* inserted as a child of {@link module:engine/view/element~ViewElement}.
+*
+* `ViewTextProxy` instances are created by {@link module:engine/view/treewalker~ViewTreeWalker view tree walker}.
+* You should not need to create an instance of this class by your own.
+*/
 export declare class ViewTextProxy extends ViewTypeCheckable {
-    /**
-     * Reference to the {@link module:engine/view/text~ViewText} element which ViewTextProxy is a substring.
-     */
-    readonly textNode: ViewText;
-    /**
-     * Text data represented by this text proxy.
-     */
-    readonly data: string;
-    /**
-     * Offset in the `textNode` where this `ViewTextProxy` 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~ViewTextProxy#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(textNode: ViewText, offsetInText: number, length: number);
-    /**
-     * Offset size of this node.
-     */
-    get offsetSize(): number;
-    /**
-     * Flag indicating whether `ViewTextProxy` instance covers only part of the original {@link module:engine/view/text~ViewText 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~ViewTextProxy#textNode textNode}
-     * ({@link module:engine/view/textproxy~ViewTextProxy#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(): ViewElement | ViewDocumentFragment | null;
-    /**
-     * Root of this text proxy, which is same as root of text node represented by this text proxy.
-     */
-    get root(): ViewNode | ViewDocumentFragment;
-    /**
-     * {@link module:engine/view/document~ViewDocument View document} that owns this text proxy, or `null` if the text proxy is inside
-     * {@link module:engine/view/documentfragment~ViewDocumentFragment document fragment}.
-     */
-    get document(): ViewDocument | 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<ViewText | ViewElement | ViewDocumentFragment>;
+	/**
+	* Reference to the {@link module:engine/view/text~ViewText} element which ViewTextProxy is a substring.
+	*/
+	readonly textNode: ViewText;
+	/**
+	* Text data represented by this text proxy.
+	*/
+	readonly data: string;
+	/**
+	* Offset in the `textNode` where this `ViewTextProxy` 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~ViewTextProxy#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(textNode: ViewText, offsetInText: number, length: number);
+	/**
+	* Offset size of this node.
+	*/
+	get offsetSize(): number;
+	/**
+	* Flag indicating whether `ViewTextProxy` instance covers only part of the original {@link module:engine/view/text~ViewText 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~ViewTextProxy#textNode textNode}
+	* ({@link module:engine/view/textproxy~ViewTextProxy#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(): ViewElement | ViewDocumentFragment | null;
+	/**
+	* Root of this text proxy, which is same as root of text node represented by this text proxy.
+	*/
+	get root(): ViewNode | ViewDocumentFragment;
+	/**
+	* {@link module:engine/view/document~ViewDocument View document} that owns this text proxy, or `null` if the text proxy is inside
+	* {@link module:engine/view/documentfragment~ViewDocumentFragment document fragment}.
+	*/
+	get document(): ViewDocument | 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<ViewText | ViewElement | ViewDocumentFragment>;
 }

package/dist/view/tokenlist.d.ts

@@ -1,109 +1,109 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module engine/view/tokenlist
- */
-import { type ArrayOrItem } from '@ckeditor/ckeditor5-utils';
-import type { ViewElementAttributeValue } from './element.js';
+* @module engine/view/tokenlist
+*/
+import { type ArrayOrItem } from "@ckeditor/ckeditor5-utils";
+import type { ViewElementAttributeValue } from "./element.js";
 /**
- * Token list. Allows handling (adding, removing, retrieving) a set of tokens (for example class names).
- */
+* Token list. Allows handling (adding, removing, retrieving) a set of tokens (for example class names).
+*/
 export declare class ViewTokenList implements ViewElementAttributeValue {
-    /**
-     * The set of tokens.
-     */
-    private _set;
-    /**
-     * Returns true if token list has no tokens set.
-     */
-    get isEmpty(): boolean;
-    /**
-     * Number of tokens.
-     */
-    get size(): number;
-    /**
-     * Checks if a given token is set.
-     */
-    has(name: string): boolean;
-    /**
-     * Returns all tokens.
-     */
-    keys(): Array<string>;
-    /**
-     * Resets the value to the given one.
-     */
-    setTo(value: string): this;
-    /**
-     * Sets a given token without affecting other tokens.
-     */
-    set(tokens: ArrayOrItem<string>): void;
-    /**
-     * Removes given token.
-     */
-    remove(tokens: ArrayOrItem<string>): void;
-    /**
-     * Removes all tokens.
-     */
-    clear(): void;
-    /**
-     * Returns a normalized tokens string.
-     */
-    toString(): string;
-    /**
-     * Returns `true` if both attributes have the same tokens.
-     */
-    isSimilar(other: ViewTokenList): boolean;
-    /**
-     * Clones the attribute value.
-     *
-     * @internal
-     */
-    _clone(): this;
-    /**
-     * Used by the {@link module:engine/view/matcher~Matcher Matcher} to collect matching attribute tokens.
-     *
-     * @internal
-     * @param tokenPattern The matched token name pattern.
-     * @returns An array of matching tokens.
-     */
-    _getTokensMatch(tokenPattern: true | string | RegExp): Array<string> | undefined;
-    /**
-     * Returns a list of consumables for the attribute.
-     *
-     * Could be filtered by the given token name.
-     *
-     * @internal
-     */
-    _getConsumables(name?: string): Array<string>;
-    /**
-     * Used by {@link module:engine/view/element~ViewElement#_canMergeAttributesFrom} to verify if the given attribute
-     * can be merged without conflicts into the attribute.
-     *
-     * This method is indirectly used by the {@link module:engine/view/downcastwriter~ViewDowncastWriter} while downcasting
-     * an {@link module:engine/view/attributeelement~ViewAttributeElement} to merge it with other `AttributeElement`.
-     *
-     * @internal
-     */
-    _canMergeFrom(): boolean;
-    /**
-     * Used by {@link module:engine/view/element~ViewElement#_mergeAttributesFrom} to merge a given attribute into the attribute.
-     *
-     * This method is indirectly used by the {@link module:engine/view/downcastwriter~ViewDowncastWriter} while down-casting
-     * an {@link module:engine/view/attributeelement~ViewAttributeElement} to merge it with other ViewAttributeElement.
-     *
-     * @internal
-     */
-    _mergeFrom(other: ViewTokenList): void;
-    /**
-     * Used by {@link module:engine/view/element~ViewElement#_canSubtractAttributesOf} to verify if the given attribute
-     * can be fully subtracted from the attribute.
-     *
-     * This method is indirectly used by the {@link module:engine/view/downcastwriter~ViewDowncastWriter} while down-casting
-     * an {@link module:engine/view/attributeelement~ViewAttributeElement} to unwrap the ViewAttributeElement.
-     *
-     * @internal
-     */
-    _isMatching(other: ViewTokenList): boolean;
+	/**
+	* The set of tokens.
+	*/
+	private _set;
+	/**
+	* Returns true if token list has no tokens set.
+	*/
+	get isEmpty(): boolean;
+	/**
+	* Number of tokens.
+	*/
+	get size(): number;
+	/**
+	* Checks if a given token is set.
+	*/
+	has(name: string): boolean;
+	/**
+	* Returns all tokens.
+	*/
+	keys(): Array<string>;
+	/**
+	* Resets the value to the given one.
+	*/
+	setTo(value: string): this;
+	/**
+	* Sets a given token without affecting other tokens.
+	*/
+	set(tokens: ArrayOrItem<string>): void;
+	/**
+	* Removes given token.
+	*/
+	remove(tokens: ArrayOrItem<string>): void;
+	/**
+	* Removes all tokens.
+	*/
+	clear(): void;
+	/**
+	* Returns a normalized tokens string.
+	*/
+	toString(): string;
+	/**
+	* Returns `true` if both attributes have the same tokens.
+	*/
+	isSimilar(other: ViewTokenList): boolean;
+	/**
+	* Clones the attribute value.
+	*
+	* @internal
+	*/
+	_clone(): this;
+	/**
+	* Used by the {@link module:engine/view/matcher~Matcher Matcher} to collect matching attribute tokens.
+	*
+	* @internal
+	* @param tokenPattern The matched token name pattern.
+	* @returns An array of matching tokens.
+	*/
+	_getTokensMatch(tokenPattern: true | string | RegExp): Array<string> | undefined;
+	/**
+	* Returns a list of consumables for the attribute.
+	*
+	* Could be filtered by the given token name.
+	*
+	* @internal
+	*/
+	_getConsumables(name?: string): Array<string>;
+	/**
+	* Used by {@link module:engine/view/element~ViewElement#_canMergeAttributesFrom} to verify if the given attribute
+	* can be merged without conflicts into the attribute.
+	*
+	* This method is indirectly used by the {@link module:engine/view/downcastwriter~ViewDowncastWriter} while downcasting
+	* an {@link module:engine/view/attributeelement~ViewAttributeElement} to merge it with other `AttributeElement`.
+	*
+	* @internal
+	*/
+	_canMergeFrom(): boolean;
+	/**
+	* Used by {@link module:engine/view/element~ViewElement#_mergeAttributesFrom} to merge a given attribute into the attribute.
+	*
+	* This method is indirectly used by the {@link module:engine/view/downcastwriter~ViewDowncastWriter} while down-casting
+	* an {@link module:engine/view/attributeelement~ViewAttributeElement} to merge it with other ViewAttributeElement.
+	*
+	* @internal
+	*/
+	_mergeFrom(other: ViewTokenList): void;
+	/**
+	* Used by {@link module:engine/view/element~ViewElement#_canSubtractAttributesOf} to verify if the given attribute
+	* can be fully subtracted from the attribute.
+	*
+	* This method is indirectly used by the {@link module:engine/view/downcastwriter~ViewDowncastWriter} while down-casting
+	* an {@link module:engine/view/attributeelement~ViewAttributeElement} to unwrap the ViewAttributeElement.
+	*
+	* @internal
+	*/
+	_isMatching(other: ViewTokenList): boolean;
 }