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

package/dist/model/nodelist.d.ts

@@ -1,115 +1,115 @@
 /**
- * @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/model/nodelist
- */
-import { ModelNode } from './node.js';
+* @module engine/model/nodelist
+*/
+import { ModelNode } from "./node.js";
 /**
- * Provides an interface to operate on a list of {@link module:engine/model/node~ModelNode nodes}. `NodeList` is used internally
- * in classes like {@link module:engine/model/element~ModelElement Element}
- * or {@link module:engine/model/documentfragment~ModelDocumentFragment ModelDocumentFragment}.
- */
+* Provides an interface to operate on a list of {@link module:engine/model/node~ModelNode nodes}. `NodeList` is used internally
+* in classes like {@link module:engine/model/element~ModelElement Element}
+* or {@link module:engine/model/documentfragment~ModelDocumentFragment ModelDocumentFragment}.
+*/
 export declare class ModelNodeList implements Iterable<ModelNode> {
-    /**
-     * Nodes contained in this node list.
-     */
-    private _nodes;
-    /**
-     * This array maps numbers (offsets) to node that is placed at that offset.
-     *
-     * This array is similar to `_nodes` with the difference that one node may occupy multiple consecutive items in the array.
-     *
-     * This array is needed to quickly retrieve a node that is placed at given offset.
-     */
-    private _offsetToNode;
-    /**
-     * Creates a node list.
-     *
-     * @internal
-     * @param nodes Nodes contained in this node list.
-     */
-    constructor(nodes?: Iterable<ModelNode>);
-    /**
-     * Iterable interface.
-     *
-     * Iterates over all nodes contained inside this node list.
-     */
-    [Symbol.iterator](): IterableIterator<ModelNode>;
-    /**
-     * Number of nodes contained inside this node list.
-     */
-    get length(): number;
-    /**
-     * Sum of {@link module:engine/model/node~ModelNode#offsetSize offset sizes} of all nodes contained inside this node list.
-     */
-    get maxOffset(): number;
-    /**
-     * Gets the node at the given index. Returns `null` if incorrect index was passed.
-     */
-    getNode(index: number): ModelNode | null;
-    /**
-     * Gets the node at the given offset. Returns `null` if incorrect offset was passed.
-     */
-    getNodeAtOffset(offset: number): ModelNode | null;
-    /**
-     * Returns an index of the given node or `null` if given node does not have a parent.
-     *
-     * This is an alias to {@link module:engine/model/node~ModelNode#index}.
-     */
-    getNodeIndex(node: ModelNode): number | null;
-    /**
-     * Returns the offset at which given node is placed in its parent or `null` if given node does not have a parent.
-     *
-     * This is an alias to {@link module:engine/model/node~ModelNode#startOffset}.
-     */
-    getNodeStartOffset(node: ModelNode): number | null;
-    /**
-     * Converts index to offset in node list.
-     *
-     * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `model-nodelist-index-out-of-bounds` if given index is less
-     * than `0` or more than {@link #length}.
-     */
-    indexToOffset(index: number): number;
-    /**
-     * Converts offset in node list to index.
-     *
-     * Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `model-nodelist-offset-out-of-bounds` if given offset is less
-     * than `0` or more than {@link #maxOffset}.
-     */
-    offsetToIndex(offset: number): number;
-    /**
-     * Inserts given nodes at given index.
-     *
-     * @internal
-     * @param index Index at which nodes should be inserted.
-     * @param nodes Nodes to be inserted.
-     */
-    _insertNodes(index: number, nodes: Iterable<ModelNode>): void;
-    /**
-     * Removes one or more nodes starting at the given index.
-     *
-     * @internal
-     * @param indexStart Index of the first node to remove.
-     * @param howMany Number of nodes to remove.
-     * @returns Array containing removed nodes.
-     */
-    _removeNodes(indexStart: number, howMany?: number): Array<ModelNode>;
-    /**
-     * Removes children nodes provided as an array. These nodes do not need to be direct siblings.
-     *
-     * This method is faster than removing nodes one by one, as it recalculates offsets only once.
-     *
-     * @internal
-     * @param nodes Array of nodes.
-     */
-    _removeNodesArray(nodes: Array<ModelNode>): void;
-    /**
-     * Converts `NodeList` instance to an array containing nodes that were inserted in the node list. Nodes
-     * are also converted to their plain object representation.
-     *
-     * @returns `NodeList` instance converted to `Array`.
-     */
-    toJSON(): unknown;
+	/**
+	* Nodes contained in this node list.
+	*/
+	private _nodes;
+	/**
+	* This array maps numbers (offsets) to node that is placed at that offset.
+	*
+	* This array is similar to `_nodes` with the difference that one node may occupy multiple consecutive items in the array.
+	*
+	* This array is needed to quickly retrieve a node that is placed at given offset.
+	*/
+	private _offsetToNode;
+	/**
+	* Creates a node list.
+	*
+	* @internal
+	* @param nodes Nodes contained in this node list.
+	*/
+	constructor(nodes?: Iterable<ModelNode>);
+	/**
+	* Iterable interface.
+	*
+	* Iterates over all nodes contained inside this node list.
+	*/
+	[Symbol.iterator](): IterableIterator<ModelNode>;
+	/**
+	* Number of nodes contained inside this node list.
+	*/
+	get length(): number;
+	/**
+	* Sum of {@link module:engine/model/node~ModelNode#offsetSize offset sizes} of all nodes contained inside this node list.
+	*/
+	get maxOffset(): number;
+	/**
+	* Gets the node at the given index. Returns `null` if incorrect index was passed.
+	*/
+	getNode(index: number): ModelNode | null;
+	/**
+	* Gets the node at the given offset. Returns `null` if incorrect offset was passed.
+	*/
+	getNodeAtOffset(offset: number): ModelNode | null;
+	/**
+	* Returns an index of the given node or `null` if given node does not have a parent.
+	*
+	* This is an alias to {@link module:engine/model/node~ModelNode#index}.
+	*/
+	getNodeIndex(node: ModelNode): number | null;
+	/**
+	* Returns the offset at which given node is placed in its parent or `null` if given node does not have a parent.
+	*
+	* This is an alias to {@link module:engine/model/node~ModelNode#startOffset}.
+	*/
+	getNodeStartOffset(node: ModelNode): number | null;
+	/**
+	* Converts index to offset in node list.
+	*
+	* Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `model-nodelist-index-out-of-bounds` if given index is less
+	* than `0` or more than {@link #length}.
+	*/
+	indexToOffset(index: number): number;
+	/**
+	* Converts offset in node list to index.
+	*
+	* Throws {@link module:utils/ckeditorerror~CKEditorError CKEditorError} `model-nodelist-offset-out-of-bounds` if given offset is less
+	* than `0` or more than {@link #maxOffset}.
+	*/
+	offsetToIndex(offset: number): number;
+	/**
+	* Inserts given nodes at given index.
+	*
+	* @internal
+	* @param index Index at which nodes should be inserted.
+	* @param nodes Nodes to be inserted.
+	*/
+	_insertNodes(index: number, nodes: Iterable<ModelNode>): void;
+	/**
+	* Removes one or more nodes starting at the given index.
+	*
+	* @internal
+	* @param indexStart Index of the first node to remove.
+	* @param howMany Number of nodes to remove.
+	* @returns Array containing removed nodes.
+	*/
+	_removeNodes(indexStart: number, howMany?: number): Array<ModelNode>;
+	/**
+	* Removes children nodes provided as an array. These nodes do not need to be direct siblings.
+	*
+	* This method is faster than removing nodes one by one, as it recalculates offsets only once.
+	*
+	* @internal
+	* @param nodes Array of nodes.
+	*/
+	_removeNodesArray(nodes: Array<ModelNode>): void;
+	/**
+	* Converts `NodeList` instance to an array containing nodes that were inserted in the node list. Nodes
+	* are also converted to their plain object representation.
+	*
+	* @returns `NodeList` instance converted to `Array`.
+	*/
+	toJSON(): unknown;
 }

package/dist/model/operation/attributeoperation.d.ts

@@ -1,103 +1,103 @@
 /**
- * @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/model/operation/attributeoperation
- */
-import { Operation } from './operation.js';
-import { ModelRange } from '../range.js';
-import { type ModelDocument } from '../document.js';
-import type { ModelSelectable } from '../selection.js';
+* @module engine/model/operation/attributeoperation
+*/
+import { Operation } from "./operation.js";
+import { ModelRange } from "../range.js";
+import { type ModelDocument } from "../document.js";
+import type { ModelSelectable } from "../selection.js";
 /**
- * Operation to change nodes' attribute.
- *
- * Using this class you can add, remove or change value of the attribute.
- */
+* Operation to change nodes' attribute.
+*
+* Using this class you can add, remove or change value of the attribute.
+*/
 export declare class AttributeOperation extends Operation {
-    /**
-     * Range on which operation should be applied.
-     *
-     * @readonly
-     */
-    range: ModelRange;
-    /**
-     * Key of an attribute to change or remove.
-     *
-     * @readonly
-     */
-    key: string;
-    /**
-     * Old value of the attribute with given key or `null`, if attribute was not set before.
-     *
-     * @readonly
-     */
-    oldValue: unknown;
-    /**
-     * New value of the attribute with given key or `null`, if operation should remove attribute.
-     *
-     * @readonly
-     */
-    newValue: unknown;
-    /**
-     * Creates an operation that changes, removes or adds attributes.
-     *
-     * If only `newValue` is set, attribute will be added on a node. Note that all nodes in operation's range must not
-     * have an attribute with the same key as the added attribute.
-     *
-     * If only `oldValue` is set, then attribute with given key will be removed. Note that all nodes in operation's range
-     * must have an attribute with that key added.
-     *
-     * If both `newValue` and `oldValue` are set, then the operation will change the attribute value. Note that all nodes in
-     * operation's ranges must already have an attribute with given key and `oldValue` as value
-     *
-     * @param range Range on which the operation should be applied. Must be a flat range.
-     * @param key Key of an attribute to change or remove.
-     * @param oldValue Old value of the attribute with given key or `null`, if attribute was not set before.
-     * @param newValue New value of the attribute with given key or `null`, if operation should remove attribute.
-     * @param baseVersion Document {@link module:engine/model/document~ModelDocument#version} on which operation
-     * can be applied or `null` if the operation operates on detached (non-document) tree.
-     */
-    constructor(range: ModelRange, key: string, oldValue: unknown, newValue: unknown, baseVersion: number | null);
-    /**
-     * @inheritDoc
-     */
-    get type(): 'addAttribute' | 'removeAttribute' | 'changeAttribute';
-    /**
-     * @inheritDoc
-     */
-    get affectedSelectable(): ModelSelectable;
-    /**
-     * Creates and returns an operation that has the same parameters as this operation.
-     */
-    clone(): AttributeOperation;
-    /**
-     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
-     */
-    getReversed(): Operation;
-    /**
-     * @inheritDoc
-     */
-    toJSON(): unknown;
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _validate(): void;
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _execute(): void;
-    /**
-     * @inheritDoc
-     */
-    static get className(): string;
-    /**
-     * Creates `AttributeOperation` object from deserialized object, i.e. from parsed JSON string.
-     *
-     * @param json Deserialized JSON object.
-     * @param document Document on which this operation will be applied.
-     */
-    static fromJSON(json: any, document: ModelDocument): AttributeOperation;
+	/**
+	* Range on which operation should be applied.
+	*
+	* @readonly
+	*/
+	range: ModelRange;
+	/**
+	* Key of an attribute to change or remove.
+	*
+	* @readonly
+	*/
+	key: string;
+	/**
+	* Old value of the attribute with given key or `null`, if attribute was not set before.
+	*
+	* @readonly
+	*/
+	oldValue: unknown;
+	/**
+	* New value of the attribute with given key or `null`, if operation should remove attribute.
+	*
+	* @readonly
+	*/
+	newValue: unknown;
+	/**
+	* Creates an operation that changes, removes or adds attributes.
+	*
+	* If only `newValue` is set, attribute will be added on a node. Note that all nodes in operation's range must not
+	* have an attribute with the same key as the added attribute.
+	*
+	* If only `oldValue` is set, then attribute with given key will be removed. Note that all nodes in operation's range
+	* must have an attribute with that key added.
+	*
+	* If both `newValue` and `oldValue` are set, then the operation will change the attribute value. Note that all nodes in
+	* operation's ranges must already have an attribute with given key and `oldValue` as value
+	*
+	* @param range Range on which the operation should be applied. Must be a flat range.
+	* @param key Key of an attribute to change or remove.
+	* @param oldValue Old value of the attribute with given key or `null`, if attribute was not set before.
+	* @param newValue New value of the attribute with given key or `null`, if operation should remove attribute.
+	* @param baseVersion Document {@link module:engine/model/document~ModelDocument#version} on which operation
+	* can be applied or `null` if the operation operates on detached (non-document) tree.
+	*/
+	constructor(range: ModelRange, key: string, oldValue: unknown, newValue: unknown, baseVersion: number | null);
+	/**
+	* @inheritDoc
+	*/
+	get type(): "addAttribute" | "removeAttribute" | "changeAttribute";
+	/**
+	* @inheritDoc
+	*/
+	get affectedSelectable(): ModelSelectable;
+	/**
+	* Creates and returns an operation that has the same parameters as this operation.
+	*/
+	clone(): AttributeOperation;
+	/**
+	* See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
+	*/
+	getReversed(): Operation;
+	/**
+	* @inheritDoc
+	*/
+	override toJSON(): unknown;
+	/**
+	* @inheritDoc
+	* @internal
+	*/
+	override _validate(): void;
+	/**
+	* @inheritDoc
+	* @internal
+	*/
+	_execute(): void;
+	/**
+	* @inheritDoc
+	*/
+	static override get className(): string;
+	/**
+	* Creates `AttributeOperation` object from deserialized object, i.e. from parsed JSON string.
+	*
+	* @param json Deserialized JSON object.
+	* @param document Document on which this operation will be applied.
+	*/
+	static override fromJSON(json: any, document: ModelDocument): AttributeOperation;
 }

package/dist/model/operation/detachoperation.d.ts

@@ -1,62 +1,62 @@
 /**
- * @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/model/operation/detachoperation
- */
-import { Operation } from './operation.js';
-import { type ModelPosition } from '../position.js';
-import type { ModelSelectable } from '../selection.js';
+* @module engine/model/operation/detachoperation
+*/
+import { Operation } from "./operation.js";
+import { type ModelPosition } from "../position.js";
+import type { ModelSelectable } from "../selection.js";
 /**
- * Operation to permanently remove node from detached root.
- * Note this operation is only a local operation and won't be send to the other clients.
- *
- * @internal
- */
+* Operation to permanently remove node from detached root.
+* Note this operation is only a local operation and won't be send to the other clients.
+*
+* @internal
+*/
 export declare class DetachOperation extends Operation {
-    /**
-     * Position before the first {@link module:engine/model/item~ModelItem model item} to detach.
-     */
-    sourcePosition: ModelPosition;
-    /**
-     * Offset size of moved range.
-     */
-    howMany: number;
-    clone: never;
-    getReversed: never;
-    /**
-     * Creates an insert operation.
-     *
-     * @param sourcePosition Position before the first {@link module:engine/model/item~ModelItem model item} to move.
-     * @param howMany Offset size of moved range. Moved range will start from `sourcePosition` and end at
-     * `sourcePosition` with offset shifted by `howMany`.
-     */
-    constructor(sourcePosition: ModelPosition, howMany: number);
-    /**
-     * @inheritDoc
-     */
-    get type(): 'detach';
-    /**
-     * @inheritDoc
-     */
-    get affectedSelectable(): ModelSelectable;
-    /**
-     * @inheritDoc
-     */
-    toJSON(): unknown;
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _validate(): void;
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _execute(): void;
-    /**
-     * @inheritDoc
-     */
-    static get className(): string;
+	/**
+	* Position before the first {@link module:engine/model/item~ModelItem model item} to detach.
+	*/
+	sourcePosition: ModelPosition;
+	/**
+	* Offset size of moved range.
+	*/
+	howMany: number;
+	clone: never;
+	getReversed: never;
+	/**
+	* Creates an insert operation.
+	*
+	* @param sourcePosition Position before the first {@link module:engine/model/item~ModelItem model item} to move.
+	* @param howMany Offset size of moved range. Moved range will start from `sourcePosition` and end at
+	* `sourcePosition` with offset shifted by `howMany`.
+	*/
+	constructor(sourcePosition: ModelPosition, howMany: number);
+	/**
+	* @inheritDoc
+	*/
+	get type(): "detach";
+	/**
+	* @inheritDoc
+	*/
+	get affectedSelectable(): ModelSelectable;
+	/**
+	* @inheritDoc
+	*/
+	override toJSON(): unknown;
+	/**
+	* @inheritDoc
+	* @internal
+	*/
+	override _validate(): void;
+	/**
+	* @inheritDoc
+	* @internal
+	*/
+	_execute(): void;
+	/**
+	* @inheritDoc
+	*/
+	static override get className(): string;
 }