@ckeditor/ckeditor5-engine 47.6.1 → 48.0.0-alpha.0

package/src/model/element.js

@@ -1,323 +0,0 @@
-/**
- * @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/element
- */
-import { ModelNode } from './node.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, convertMapToStringifiedObject, convertMapToTags } = require( '../dev-utils/utils' );
-/**
- * Model element. Type of {@link module:engine/model/node~ModelNode node} that has a
- * {@link module:engine/model/element~ModelElement#name name} and {@link module:engine/model/element~ModelElement#getChildren child nodes}.
- *
- * **Important**: see {@link module:engine/model/node~ModelNode} to read about restrictions using `Element` and `Node` API.
- */
-export class ModelElement extends ModelNode {
-    /**
-     * Element name.
-     */
-    name;
-    /**
-     * List of children nodes.
-     */
-    _children = new ModelNodeList();
-    /**
-     * Creates a model element.
-     *
-     * **Note:** Constructor of this class shouldn't be used directly in the code.
-     * Use the {@link module:engine/model/writer~ModelWriter#createElement} method instead.
-     *
-     * @internal
-     * @param name Element's name.
-     * @param attrs Element's attributes. See {@link module:utils/tomap~toMap} for a list of accepted values.
-     * @param children One or more nodes to be inserted as children of created element.
-     */
-    constructor(name, attrs, children) {
-        super(attrs);
-        this.name = name;
-        if (children) {
-            this._insertChild(0, children);
-        }
-    }
-    /**
-     * Number of this element's children.
-     */
-    get childCount() {
-        return this._children.length;
-    }
-    /**
-     * Sum of {@link module:engine/model/node~ModelNode#offsetSize offset sizes} of all of this element's children.
-     */
-    get maxOffset() {
-        return this._children.maxOffset;
-    }
-    /**
-     * Is `true` if there are no nodes inside this element, `false` otherwise.
-     */
-    get isEmpty() {
-        return this.childCount === 0;
-    }
-    /**
-     * Gets the child at the given index. Returns `null` if incorrect index was passed.
-     *
-     * @param index Index in this element.
-     * @returns Child node.
-     */
-    getChild(index) {
-        return this._children.getNode(index);
-    }
-    /**
-     * Gets the child at the given offset. Returns `null` if incorrect index was passed.
-     *
-     * @param offset Offset in this element.
-     * @returns Child node.
-     */
-    getChildAtOffset(offset) {
-        return this._children.getNodeAtOffset(offset);
-    }
-    /**
-     * Returns an iterator that iterates over all of this element's children.
-     */
-    getChildren() {
-        return this._children[Symbol.iterator]();
-    }
-    /**
-     * Returns an index of the given child node. Returns `null` if given node is not a child of this element.
-     *
-     * @param node Child node to look for.
-     * @returns Child node's index in this element.
-     */
-    getChildIndex(node) {
-        return this._children.getNodeIndex(node);
-    }
-    /**
-     * Returns the starting offset of given child. Starting offset is equal to the sum of
-     * {@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 element.
-     *
-     * @param node Child node to look for.
-     * @returns Child node's starting offset.
-     */
-    getChildStartOffset(node) {
-        return this._children.getNodeStartOffset(node);
-    }
-    /**
-     * Returns index of a node that occupies given offset. If given offset is too low, returns `0`. If given offset is
-     * too high, returns {@link module:engine/model/element~ModelElement#getChildIndex index after last child}.
-     *
-     * ```ts
-     * const textNode = new Text( 'foo' );
-     * const pElement = new Element( 'p' );
-     * const divElement = new Element( [ textNode, pElement ] );
-     * divElement.offsetToIndex( -1 ); // Returns 0, because offset is too low.
-     * divElement.offsetToIndex( 0 ); // Returns 0, because offset 0 is taken by `textNode` which is at index 0.
-     * divElement.offsetToIndex( 1 ); // Returns 0, because `textNode` has `offsetSize` equal to 3, so it occupies offset 1 too.
-     * divElement.offsetToIndex( 2 ); // Returns 0.
-     * divElement.offsetToIndex( 3 ); // Returns 1.
-     * divElement.offsetToIndex( 4 ); // Returns 2. There are no nodes at offset 4, so last available index is returned.
-     * ```
-     */
-    offsetToIndex(offset) {
-        return this._children.offsetToIndex(offset);
-    }
-    /**
-     * Returns a descendant node by its path relative to this element.
-     *
-     * ```ts
-     * // <this>a<b>c</b></this>
-     * this.getNodeByPath( [ 0 ] );     // -> "a"
-     * this.getNodeByPath( [ 1 ] );     // -> <b>
-     * this.getNodeByPath( [ 1, 0 ] );  // -> "c"
-     * ```
-     *
-     * @param relativePath Path of the node to find, relative to this element.
-     */
-    getNodeByPath(relativePath) {
-        // eslint-disable-next-line @typescript-eslint/no-this-alias, consistent-this
-        let node = this;
-        for (const offset of relativePath) {
-            node = node.getChildAtOffset(offset);
-        }
-        return node;
-    }
-    /**
-     * Returns the parent element of the given name. Returns null if the element is not inside the desired parent.
-     *
-     * @param parentName The name of the parent element to find.
-     * @param options Options object.
-     * @param options.includeSelf When set to `true` this node will be also included while searching.
-     */
-    findAncestor(parentName, options = {}) {
-        let parent = options.includeSelf ? this : this.parent;
-        while (parent) {
-            if (parent.name === parentName) {
-                return parent;
-            }
-            parent = parent.parent;
-        }
-        return null;
-    }
-    /**
-     * Converts `Element` instance to plain object and returns it. Takes care of converting all of this element's children.
-     *
-     * @returns `Element` instance converted to plain object.
-     */
-    toJSON() {
-        const json = super.toJSON();
-        json.name = this.name;
-        if (this._children.length > 0) {
-            json.children = [];
-            for (const node of this._children) {
-                json.children.push(node.toJSON());
-            }
-        }
-        return json;
-    }
-    /**
-     * Creates a copy of this element and returns it. Created element has the same name and attributes as the original element.
-     * If clone is deep, the original element's children are also cloned. If not, then empty element is returned.
-     *
-     * @internal
-     * @param deep If set to `true` clones element and all its children recursively. When set to `false`,
-     * element will be cloned without any child.
-     */
-    _clone(deep = false) {
-        const children = deep ? cloneNodes(this._children) : undefined;
-        return new ModelElement(this.name, this.getAttributes(), children);
-    }
-    /**
-     * {@link module:engine/model/element~ModelElement#_insertChild Inserts} one or more nodes at the end of this element.
-     *
-     * @see module:engine/model/writer~ModelWriter#append
-     * @internal
-     * @param nodes Nodes to be inserted.
-     */
-    _appendChild(nodes) {
-        this._insertChild(this.childCount, 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 element.
-     *
-     * @see module:engine/model/writer~ModelWriter#insert
-     * @internal
-     * @param index Index at which nodes should be inserted.
-     * @param items Items to be inserted.
-     */
-    _insertChild(index, items) {
-        const nodes = normalize(items);
-        for (const node of nodes) {
-            // If node that is being added to this element is already inside another element, first remove it from the old parent.
-            if (node.parent !== null) {
-                node._remove();
-            }
-            node.parent = this;
-        }
-        this._children._insertNodes(index, nodes);
-    }
-    /**
-     * Removes one or more nodes starting at the given index and sets
-     * {@link module:engine/model/node~ModelNode#parent parent} of these nodes to `null`.
-     *
-     * @see module:engine/model/writer~ModelWriter#remove
-     * @internal
-     * @param index Index of the first node to remove.
-     * @param howMany Number of nodes to remove.
-     * @returns Array containing removed nodes.
-     */
-    _removeChildren(index, howMany = 1) {
-        const nodes = this._children._removeNodes(index, howMany);
-        for (const node of nodes) {
-            node.parent = null;
-        }
-        return nodes;
-    }
-    /**
-     * Removes children nodes provided as an array and sets
-     * the {@link module:engine/model/node~ModelNode#parent parent} of these nodes to `null`.
-     *
-     * 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.
-     */
-    _removeChildrenArray(nodes) {
-        this._children._removeNodesArray(nodes);
-        for (const node of nodes) {
-            node.parent = null;
-        }
-    }
-    /**
-     * Creates an `Element` instance from given plain object (i.e. parsed JSON string).
-     * Converts `Element` children to proper nodes.
-     *
-     * @param json Plain object to be converted to `Element`.
-     * @returns `Element` instance created using given plain object.
-     */
-    static fromJSON(json) {
-        let children;
-        if (json.children) {
-            children = [];
-            for (const child of json.children) {
-                if (child.name) {
-                    // If child has name property, it is an Element.
-                    children.push(ModelElement.fromJSON(child));
-                }
-                else {
-                    // Otherwise, it is a Text node.
-                    children.push(ModelText.fromJSON(child));
-                }
-            }
-        }
-        return new ModelElement(json.name, json.attributes, children);
-    }
-}
-// The magic of type inference using `is` method is centralized in `TypeCheckable` class.
-// Proper overload would interfere with that.
-ModelElement.prototype.is = function (type, name) {
-    if (!name) {
-        return type === 'element' || type === 'model:element' ||
-            // From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
-            type === 'node' || type === 'model:node';
-    }
-    return name === this.name && (type === 'element' || type === 'model:element');
-};
-/**
- * Converts strings to Text and non-iterables to arrays.
- */
-function normalize(nodes) {
-    // Separate condition because string is iterable.
-    if (typeof nodes == 'string') {
-        return [new ModelText(nodes)];
-    }
-    if (!isIterable(nodes)) {
-        nodes = [nodes];
-    }
-    const normalizedNodes = [];
-    for (const node of nodes) {
-        if (typeof node == 'string') {
-            normalizedNodes.push(new ModelText(node));
-        }
-        else if (node instanceof ModelTextProxy) {
-            normalizedNodes.push(new ModelText(node.data, node.getAttributes()));
-        }
-        else {
-            normalizedNodes.push(node);
-        }
-    }
-    return normalizedNodes;
-}
-function cloneNodes(nodes) {
-    const clonedNodes = [];
-    for (const node of nodes) {
-        clonedNodes.push(node._clone(true));
-    }
-    return clonedNodes;
-}

package/src/model/history.js

@@ -1,206 +0,0 @@
-/**
- * @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
- */
-import { CKEditorError } from '@ckeditor/ckeditor5-utils';
-/**
- * @module engine/model/history
- */
-/**
- * `History` keeps the track of all the operations applied to the {@link module:engine/model/document~ModelDocument document}.
- */
-export class History {
-    /**
-     * Operations added to the history.
-     */
-    _operations = [];
-    /**
-     * Holds an information which {@link module:engine/model/operation/operation~Operation operation} undoes which
-     * {@link module:engine/model/operation/operation~Operation operation}.
-     *
-     * Keys of the map are "undoing operations", that is operations that undone some other operations. For each key, the
-     * value is an operation that has been undone by the "undoing operation".
-     */
-    _undoPairs = new Map();
-    /**
-     * Holds all undone operations.
-     */
-    _undoneOperations = new Set();
-    /**
-     * A map that allows retrieving the operations fast based on the given base version.
-     */
-    _baseVersionToOperationIndex = new Map();
-    /**
-     * The history version.
-     */
-    _version = 0;
-    /**
-     * The gap pairs kept in the <from,to> format.
-     *
-     * Anytime the `history.version` is set to a version larger than `history.version + 1`,
-     * a new <lastHistoryVersion, newHistoryVersion> entry is added to the map.
-     */
-    _gaps = new Map();
-    /**
-     * The version of the last operation in the history.
-     *
-     * The history version is incremented automatically when a new operation is added to the history.
-     * Setting the version manually should be done only in rare circumstances when a gap is planned
-     * between history versions. When doing so, a gap will be created and the history will accept adding
-     * an operation with base version equal to the new history version.
-     */
-    get version() {
-        return this._version;
-    }
-    set version(version) {
-        // Store a gap if there are some operations already in the history and the
-        // new version does not increment the latest one.
-        if (this._operations.length && version > this._version + 1) {
-            this._gaps.set(this._version, version);
-        }
-        this._version = version;
-    }
-    /**
-     * The last history operation.
-     */
-    get lastOperation() {
-        return this._operations[this._operations.length - 1];
-    }
-    /**
-     * Adds an operation to the history and increments the history version.
-     *
-     * The operation's base version should be equal to the history version. Otherwise an error is thrown.
-     */
-    addOperation(operation) {
-        if (operation.baseVersion !== this.version) {
-            /**
-             * Only operations with matching versions can be added to the history.
-             *
-             * @error model-document-history-addoperation-incorrect-version
-             * @param {module:engine/model/operation/operation~Operation} operation The current operation.
-             * @param {number} historyVersion The current document history version.
-             */
-            throw new CKEditorError('model-document-history-addoperation-incorrect-version', this, {
-                operation,
-                historyVersion: this.version
-            });
-        }
-        this._operations.push(operation);
-        this._version++;
-        this._baseVersionToOperationIndex.set(operation.baseVersion, this._operations.length - 1);
-    }
-    /**
-     * Returns operations from the given range of operation base versions that were added to the history.
-     *
-     * Note that there may be gaps in operations base versions.
-     *
-     * @param fromBaseVersion Base version from which operations should be returned (inclusive).
-     * @param toBaseVersion Base version up to which operations should be returned (exclusive).
-     * @returns History operations for the given range, in chronological order.
-     */
-    getOperations(fromBaseVersion, toBaseVersion = this.version) {
-        // When there is no operation in the history, return an empty array.
-        // After that we can be sure that `firstOperation`, `lastOperation` are not nullish.
-        if (!this._operations.length) {
-            return [];
-        }
-        const firstOperation = this._operations[0];
-        if (fromBaseVersion === undefined) {
-            fromBaseVersion = firstOperation.baseVersion;
-        }
-        // Change exclusive `toBaseVersion` to inclusive, so it will refer to the actual index.
-        // Thanks to that mapping from base versions to operation indexes are possible.
-        let inclusiveTo = toBaseVersion - 1;
-        // Check if "from" or "to" point to a gap between versions.
-        // If yes, then change the incorrect position to the proper side of the gap.
-        // Thanks to it, it will be possible to get index of the operation.
-        for (const [gapFrom, gapTo] of this._gaps) {
-            if (fromBaseVersion > gapFrom && fromBaseVersion < gapTo) {
-                fromBaseVersion = gapTo;
-            }
-            if (inclusiveTo > gapFrom && inclusiveTo < gapTo) {
-                inclusiveTo = gapFrom - 1;
-            }
-        }
-        // If the whole range is outside of the operation versions, then return an empty array.
-        if (inclusiveTo < firstOperation.baseVersion || fromBaseVersion > this.lastOperation.baseVersion) {
-            return [];
-        }
-        let fromIndex = this._baseVersionToOperationIndex.get(fromBaseVersion);
-        // If the range starts before the first operation, then use the first operation as the range's start.
-        if (fromIndex === undefined) {
-            fromIndex = 0;
-        }
-        let toIndex = this._baseVersionToOperationIndex.get(inclusiveTo);
-        // If the range ends after the last operation, then use the last operation as the range's end.
-        if (toIndex === undefined) {
-            toIndex = this._operations.length - 1;
-        }
-        // Return the part of the history operations based on the calculated start index and end index.
-        return this._operations.slice(fromIndex, 
-        // The `toIndex` should be included in the returned operations, so add `1`.
-        toIndex + 1);
-    }
-    /**
-     * Returns operation from the history that bases on given `baseVersion`.
-     *
-     * @param baseVersion Base version of the operation to get.
-     * @returns Operation with given base version or `undefined` if there is no such operation in history.
-     */
-    getOperation(baseVersion) {
-        const operationIndex = this._baseVersionToOperationIndex.get(baseVersion);
-        if (operationIndex === undefined) {
-            return;
-        }
-        return this._operations[operationIndex];
-    }
-    /**
-     * Marks in history that one operation is an operation that is undoing the other operation. By marking operation this way,
-     * history is keeping more context information about operations, which helps in operational transformation.
-     *
-     * @param undoneOperation Operation which is undone by `undoingOperation`.
-     * @param undoingOperation Operation which undoes `undoneOperation`.
-     */
-    setOperationAsUndone(undoneOperation, undoingOperation) {
-        this._undoPairs.set(undoingOperation, undoneOperation);
-        this._undoneOperations.add(undoneOperation);
-    }
-    /**
-     * Checks whether given `operation` is undoing any other operation.
-     *
-     * @param operation Operation to check.
-     * @returns `true` if given `operation` is undoing any other operation, `false` otherwise.
-     */
-    isUndoingOperation(operation) {
-        return this._undoPairs.has(operation);
-    }
-    /**
-     * Checks whether given `operation` has been undone by any other operation.
-     *
-     * @param operation Operation to check.
-     * @returns `true` if given `operation` has been undone any other operation, `false` otherwise.
-     */
-    isUndoneOperation(operation) {
-        return this._undoneOperations.has(operation);
-    }
-    /**
-     * For given `undoingOperation`, returns the operation which has been undone by it.
-     *
-     * @returns Operation that has been undone by given `undoingOperation` or `undefined`
-     * if given `undoingOperation` is not undoing any other operation.
-     */
-    getUndoneOperation(undoingOperation) {
-        return this._undoPairs.get(undoingOperation);
-    }
-    /**
-     * Resets the history of operations.
-     */
-    reset() {
-        this._version = 0;
-        this._undoPairs = new Map();
-        this._operations = [];
-        this._undoneOperations = new Set();
-        this._gaps = new Map();
-        this._baseVersionToOperationIndex = new Map();
-    }
-}

package/src/model/item.js

@@ -1,5 +0,0 @@
-/**
- * @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
- */
-export {};

package/src/model/liveposition.js

@@ -1,93 +0,0 @@
-/**
- * @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/liveposition
- */
-import { ModelPosition } from './position.js';
-import { CKEditorError, EmitterMixin } from '@ckeditor/ckeditor5-utils';
-/**
- * `ModelLivePosition` is a type of {@link module:engine/model/position~ModelPosition Position}
- * that updates itself as {@link module:engine/model/document~ModelDocument document}
- * is changed through operations. It may be used as a bookmark.
- *
- * **Note:** Contrary to {@link module:engine/model/position~ModelPosition}, `ModelLivePosition` works only in roots that are
- * {@link module:engine/model/rootelement~ModelRootElement}.
- * If {@link module:engine/model/documentfragment~ModelDocumentFragment} is passed, error will be thrown.
- *
- * **Note:** Be very careful when dealing with `ModelLivePosition`. Each `ModelLivePosition` instance bind events that might
- * have to be unbound.
- * Use {@link module:engine/model/liveposition~ModelLivePosition#detach} whenever you don't need `ModelLivePosition` anymore.
- */
-export class ModelLivePosition extends /* #__PURE__ */ EmitterMixin(ModelPosition) {
-    /**
-     * Creates a live position.
-     *
-     * @see module:engine/model/position~ModelPosition
-     */
-    constructor(root, path, stickiness = 'toNone') {
-        super(root, path, stickiness);
-        if (!this.root.is('rootElement')) {
-            /**
-             * LivePosition's root has to be an instance of ModelRootElement.
-             *
-             * @error model-liveposition-root-not-rootelement
-             */
-            throw new CKEditorError('model-liveposition-root-not-rootelement', root);
-        }
-        bindWithDocument.call(this);
-    }
-    /**
-     * Unbinds all events previously bound by `ModelLivePosition`. Use it whenever you don't need `ModelLivePosition` instance
-     * anymore (i.e. when leaving scope in which it was declared or before re-assigning variable that was
-     * referring to it).
-     */
-    detach() {
-        this.stopListening();
-    }
-    /**
-     * Creates a {@link module:engine/model/position~ModelPosition position instance}, which is equal to this live position.
-     */
-    toPosition() {
-        return new ModelPosition(this.root, this.path.slice(), this.stickiness);
-    }
-    /**
-     * Creates a `ModelLivePosition` instance that is equal to position.
-     */
-    static fromPosition(position, stickiness) {
-        return new this(position.root, position.path.slice(), stickiness ? stickiness : position.stickiness);
-    }
-}
-// The magic of type inference using `is` method is centralized in `TypeCheckable` class.
-// Proper overload would interfere with that.
-ModelLivePosition.prototype.is = function (type) {
-    return type === 'livePosition' || type === 'model:livePosition' ||
-        // From super.is(). This is highly utilised method and cannot call super. See ckeditor/ckeditor5#6529.
-        type == 'position' || type === 'model:position';
-};
-/**
- * Binds this `ModelLivePosition` to the {@link module:engine/model/document~ModelDocument document} that owns
- * this position's {@link module:engine/model/position~ModelPosition#root root}.
- */
-function bindWithDocument() {
-    this.listenTo(this.root.document.model, 'applyOperation', (event, args) => {
-        const operation = args[0];
-        if (!operation.isDocumentOperation) {
-            return;
-        }
-        transform.call(this, operation);
-    }, { priority: 'low' });
-}
-/**
- * Updates this position accordingly to the updates applied to the model. Bases on change events.
- */
-function transform(operation) {
-    const result = this.getTransformedByOperation(operation);
-    if (!this.isEqual(result)) {
-        const oldPosition = this.toPosition();
-        this.path = result.path;
-        this.root = result.root;
-        this.fire('change', oldPosition);
-    }
-}