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

package/src/model/operation/mergeoperation.js

@@ -1,184 +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/operation/mergeoperation
- */
-import { Operation } from './operation.js';
-import { SplitOperation } from './splitoperation.js';
-import { ModelPosition } from '../position.js';
-import { ModelRange } from '../range.js';
-import { _move } from './utils.js';
-import { CKEditorError } from '@ckeditor/ckeditor5-utils';
-/**
- * Operation to merge two {@link module:engine/model/element~ModelElement elements}.
- *
- * The merged element is the parent of {@link ~MergeOperation#sourcePosition} and it is merged into the parent of
- * {@link ~MergeOperation#targetPosition}. All nodes from the merged element are moved to {@link ~MergeOperation#targetPosition}.
- *
- * The merged element is moved to the graveyard at {@link ~MergeOperation#graveyardPosition}.
- */
-export class MergeOperation extends Operation {
-    /**
-     * Position inside the merged element. All nodes from that element after that position will be moved to {@link #targetPosition}.
-     */
-    sourcePosition;
-    /**
-     * Summary offset size of nodes which will be moved from the merged element to the new parent.
-     */
-    howMany;
-    /**
-     * Position which the nodes from the merged elements will be moved to.
-     */
-    targetPosition;
-    /**
-     * Position in graveyard to which the merged element will be moved.
-     */
-    graveyardPosition;
-    /**
-     * Creates a merge operation.
-     *
-     * @param sourcePosition Position inside the merged element. All nodes from that
-     * element after that position will be moved to {@link #targetPosition}.
-     * @param howMany Summary offset size of nodes which will be moved from the merged element to the new parent.
-     * @param targetPosition Position which the nodes from the merged elements will be moved to.
-     * @param graveyardPosition Position in graveyard to which the merged element will be moved.
-     * @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(sourcePosition, howMany, targetPosition, graveyardPosition, baseVersion) {
-        super(baseVersion);
-        this.sourcePosition = sourcePosition.clone();
-        // This is, and should always remain, the first position in its parent.
-        this.sourcePosition.stickiness = 'toPrevious';
-        this.howMany = howMany;
-        this.targetPosition = targetPosition.clone();
-        // Except of a rare scenario in `MergeOperation` x `MergeOperation` transformation,
-        // this is, and should always remain, the last position in its parent.
-        this.targetPosition.stickiness = 'toNext';
-        this.graveyardPosition = graveyardPosition.clone();
-    }
-    /**
-     * @inheritDoc
-     */
-    get type() {
-        return 'merge';
-    }
-    /**
-     * Position before the merged element (which will be deleted).
-     */
-    get deletionPosition() {
-        return new ModelPosition(this.sourcePosition.root, this.sourcePosition.path.slice(0, -1));
-    }
-    /**
-     * Artificial range that contains all the nodes from the merged element that will be moved to {@link ~MergeOperation#sourcePosition}.
-     * The range starts at {@link ~MergeOperation#sourcePosition} and ends in the same parent, at `POSITIVE_INFINITY` offset.
-     */
-    get movedRange() {
-        const end = this.sourcePosition.getShiftedBy(Number.POSITIVE_INFINITY);
-        return new ModelRange(this.sourcePosition, end);
-    }
-    /**
-     * @inheritDoc
-     */
-    get affectedSelectable() {
-        const mergedElement = this.sourcePosition.parent;
-        return [
-            ModelRange._createOn(mergedElement),
-            // These could be positions but `Selectable` type only supports `Iterable<Range>`.
-            ModelRange._createFromPositionAndShift(this.targetPosition, 0),
-            ModelRange._createFromPositionAndShift(this.graveyardPosition, 0)
-        ];
-    }
-    /**
-     * Creates and returns an operation that has the same parameters as this operation.
-     */
-    clone() {
-        return new MergeOperation(this.sourcePosition, this.howMany, this.targetPosition, this.graveyardPosition, this.baseVersion);
-    }
-    /**
-     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
-     */
-    getReversed() {
-        // Positions in this method are transformed by this merge operation because the split operation bases on
-        // the context after this merge operation happened (because split operation reverses it).
-        // So we need to acknowledge that the merge operation happened and those positions changed a little.
-        const targetPosition = this.targetPosition._getTransformedByMergeOperation(this);
-        const path = this.sourcePosition.path.slice(0, -1);
-        const insertionPosition = new ModelPosition(this.sourcePosition.root, path)._getTransformedByMergeOperation(this);
-        return new SplitOperation(targetPosition, this.howMany, insertionPosition, this.graveyardPosition, this.baseVersion + 1);
-    }
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _validate() {
-        const sourceElement = this.sourcePosition.parent;
-        const targetElement = this.targetPosition.parent;
-        // Validate whether merge operation has correct parameters.
-        if (!sourceElement.parent) {
-            /**
-             * Merge source position is invalid. The element to be merged must have a parent node.
-             *
-             * @error merge-operation-source-position-invalid
-             */
-            throw new CKEditorError('merge-operation-source-position-invalid', this);
-        }
-        else if (!targetElement.parent) {
-            /**
-             * Merge target position is invalid. The element to be merged must have a parent node.
-             *
-             * @error merge-operation-target-position-invalid
-             */
-            throw new CKEditorError('merge-operation-target-position-invalid', this);
-        }
-        else if (this.howMany !== Number.NEGATIVE_INFINITY && this.howMany != sourceElement.maxOffset) {
-            /**
-             * Merge operation specifies wrong number of nodes to move.
-             *
-             * @error merge-operation-how-many-invalid
-             */
-            throw new CKEditorError('merge-operation-how-many-invalid', this);
-        }
-        this.howMany = this.sourcePosition.parent.maxOffset;
-    }
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _execute() {
-        const mergedElement = this.sourcePosition.parent;
-        const sourceRange = ModelRange._createIn(mergedElement);
-        _move(sourceRange, this.targetPosition);
-        _move(ModelRange._createOn(mergedElement), this.graveyardPosition);
-    }
-    /**
-     * @inheritDoc
-     */
-    toJSON() {
-        const json = super.toJSON();
-        json.sourcePosition = json.sourcePosition.toJSON();
-        json.targetPosition = json.targetPosition.toJSON();
-        json.graveyardPosition = json.graveyardPosition.toJSON();
-        return json;
-    }
-    /**
-     * @inheritDoc
-     */
-    static get className() {
-        return 'MergeOperation';
-    }
-    /**
-     * Creates `MergeOperation` 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, document) {
-        const sourcePosition = ModelPosition.fromJSON(json.sourcePosition, document);
-        const targetPosition = ModelPosition.fromJSON(json.targetPosition, document);
-        const graveyardPosition = ModelPosition.fromJSON(json.graveyardPosition, document);
-        return new this(sourcePosition, json.howMany, targetPosition, graveyardPosition, json.baseVersion);
-    }
-}

package/src/model/operation/moveoperation.js

@@ -1,179 +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/operation/moveoperation
- */
-import { Operation } from './operation.js';
-import { ModelPosition } from '../position.js';
-import { ModelRange } from '../range.js';
-import { _move } from './utils.js';
-import { CKEditorError, compareArrays } from '@ckeditor/ckeditor5-utils';
-// @if CK_DEBUG_ENGINE // const ModelRange = require( '../range' ).default;
-/**
- * Operation to move a range of {@link module:engine/model/item~ModelItem model items}
- * to given {@link module:engine/model/position~ModelPosition target position}.
- */
-export class MoveOperation extends Operation {
-    /**
-     * Position before the first {@link module:engine/model/item~ModelItem model item} to move.
-     */
-    sourcePosition;
-    /**
-     * Offset size of moved range.
-     */
-    howMany;
-    /**
-     * Position at which moved nodes will be inserted.
-     */
-    targetPosition;
-    /**
-     * Creates a move 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`.
-     * @param targetPosition Position at which moved nodes will be inserted.
-     * @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(sourcePosition, howMany, targetPosition, baseVersion) {
-        super(baseVersion);
-        this.sourcePosition = sourcePosition.clone();
-        // `'toNext'` because `sourcePosition` is a bit like a start of the moved range.
-        this.sourcePosition.stickiness = 'toNext';
-        this.howMany = howMany;
-        this.targetPosition = targetPosition.clone();
-        this.targetPosition.stickiness = 'toNone';
-    }
-    /**
-     * @inheritDoc
-     */
-    get type() {
-        if (this.targetPosition.root.rootName == this.sourcePosition.root.rootName) {
-            return 'move';
-        }
-        else if (this.targetPosition.root.rootName == '$graveyard') {
-            return 'remove';
-        }
-        else if (this.sourcePosition.root.rootName == '$graveyard') {
-            return 'reinsert';
-        }
-        return 'move';
-    }
-    /**
-     * @inheritDoc
-     */
-    get affectedSelectable() {
-        return [
-            ModelRange._createFromPositionAndShift(this.sourcePosition, this.howMany),
-            ModelRange._createFromPositionAndShift(this.targetPosition, 0)
-        ];
-    }
-    /**
-     * Creates and returns an operation that has the same parameters as this operation.
-     */
-    clone() {
-        return new MoveOperation(this.sourcePosition, this.howMany, this.targetPosition, this.baseVersion);
-    }
-    /**
-     * Returns the start position of the moved range after it got moved. This may be different than
-     * {@link module:engine/model/operation/moveoperation~MoveOperation#targetPosition} in some cases, i.e. when a range is moved
-     * inside the same parent but {@link module:engine/model/operation/moveoperation~MoveOperation#targetPosition targetPosition}
-     * is after {@link module:engine/model/operation/moveoperation~MoveOperation#sourcePosition sourcePosition}.
-     *
-     * ```
-     *  vv              vv
-     * abcdefg ===> adefbcg
-     *      ^          ^
-     *      targetPos  movedRangeStart
-     *      offset 6   offset 4
-     *```
-     */
-    getMovedRangeStart() {
-        return this.targetPosition._getTransformedByDeletion(this.sourcePosition, this.howMany);
-    }
-    /**
-     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
-     */
-    getReversed() {
-        const newTargetPosition = this.sourcePosition._getTransformedByInsertion(this.targetPosition, this.howMany);
-        return new MoveOperation(this.getMovedRangeStart(), this.howMany, newTargetPosition, this.baseVersion + 1);
-    }
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _validate() {
-        const sourceElement = this.sourcePosition.parent;
-        const targetElement = this.targetPosition.parent;
-        const sourceOffset = this.sourcePosition.offset;
-        const targetOffset = this.targetPosition.offset;
-        // Validate whether move operation has correct parameters.
-        // Validation is pretty complex but move operation is one of the core ways to manipulate the document state.
-        // We expect that many errors might be connected with one of scenarios described below.
-        if (sourceOffset + this.howMany > sourceElement.maxOffset) {
-            /**
-             * The nodes which should be moved do not exist.
-             *
-             * @error move-operation-nodes-do-not-exist
-             */
-            throw new CKEditorError('move-operation-nodes-do-not-exist', this);
-        }
-        else if (sourceElement === targetElement && sourceOffset < targetOffset && targetOffset < sourceOffset + this.howMany) {
-            /**
-             * Trying to move a range of nodes into the middle of that range.
-             *
-             * @error move-operation-range-into-itself
-             */
-            throw new CKEditorError('move-operation-range-into-itself', this);
-        }
-        else if (this.sourcePosition.root == this.targetPosition.root) {
-            if (compareArrays(this.sourcePosition.getParentPath(), this.targetPosition.getParentPath()) == 'prefix') {
-                const i = this.sourcePosition.path.length - 1;
-                if (this.targetPosition.path[i] >= sourceOffset && this.targetPosition.path[i] < sourceOffset + this.howMany) {
-                    /**
-                     * Trying to move a range of nodes into one of nodes from that range.
-                     *
-                     * @error move-operation-node-into-itself
-                     */
-                    throw new CKEditorError('move-operation-node-into-itself', this);
-                }
-            }
-        }
-    }
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _execute() {
-        _move(ModelRange._createFromPositionAndShift(this.sourcePosition, this.howMany), this.targetPosition);
-    }
-    /**
-     * @inheritDoc
-     */
-    toJSON() {
-        const json = super.toJSON();
-        json.sourcePosition = this.sourcePosition.toJSON();
-        json.targetPosition = this.targetPosition.toJSON();
-        return json;
-    }
-    /**
-     * @inheritDoc
-     */
-    static get className() {
-        return 'MoveOperation';
-    }
-    /**
-     * Creates `MoveOperation` 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, document) {
-        const sourcePosition = ModelPosition.fromJSON(json.sourcePosition, document);
-        const targetPosition = ModelPosition.fromJSON(json.targetPosition, document);
-        return new this(sourcePosition, json.howMany, targetPosition, json.baseVersion);
-    }
-}

package/src/model/operation/nooperation.js

@@ -1,48 +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/operation/nooperation
- */
-import { Operation } from './operation.js';
-/**
- * Operation which is doing nothing ("empty operation", "do-nothing operation", "noop"). This is an operation,
- * which when executed does not change the tree model. It still has some parameters defined for transformation purposes.
- *
- * In most cases this operation is a result of transforming operations. When transformation returns
- * {@link module:engine/model/operation/nooperation~NoOperation} it means that changes done by the transformed operation
- * have already been applied.
- */
-export class NoOperation extends Operation {
-    get type() {
-        return 'noop';
-    }
-    /**
-     * @inheritDoc
-     */
-    get affectedSelectable() {
-        return null;
-    }
-    /**
-     * Creates and returns an operation that has the same parameters as this operation.
-     */
-    clone() {
-        return new NoOperation(this.baseVersion);
-    }
-    /**
-     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
-     */
-    getReversed() {
-        return new NoOperation(this.baseVersion + 1);
-    }
-    /** @internal */
-    _execute() {
-    }
-    /**
-     * @inheritDoc
-     */
-    static get className() {
-        return 'NoOperation';
-    }
-}

package/src/model/operation/operation.js

@@ -1,78 +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
- */
-/**
- * Abstract base operation class.
- */
-export class Operation {
-    /**
-     * {@link module:engine/model/document~ModelDocument#version} on which operation can be applied. If you try to
-     * {@link module:engine/model/model~Model#applyOperation apply} operation with different base version than the
-     * {@link module:engine/model/document~ModelDocument#version document version} the
-     * {@link module:utils/ckeditorerror~CKEditorError model-document-applyOperation-wrong-version} error is thrown.
-     */
-    baseVersion;
-    /**
-     * Defines whether operation is executed on attached or detached {@link module:engine/model/item~ModelItem items}.
-     */
-    isDocumentOperation;
-    /**
-     * {@link module:engine/model/batch~Batch Batch} to which the operation is added or `null` if the operation is not
-     * added to any batch yet.
-     *
-     * Note, that a {@link #isDocumentOperation non-document operation} has this property always set to `null`, and is never added
-     * to any batch.
-     */
-    batch;
-    /**
-     * Base operation constructor.
-     *
-     * @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(baseVersion) {
-        this.baseVersion = baseVersion;
-        this.isDocumentOperation = this.baseVersion !== null;
-        this.batch = null;
-    }
-    /**
-     * Checks whether the operation's parameters are correct and the operation can be correctly executed. Throws
-     * an error if operation is not valid.
-     *
-     * @internal
-     */
-    _validate() {
-    }
-    /**
-     * Custom toJSON method to solve child-parent circular dependencies.
-     *
-     * @returns Clone of this object with the operation property replaced with string.
-     */
-    toJSON() {
-        // This method creates only a shallow copy, all nested objects should be defined separately.
-        // See https://github.com/ckeditor/ckeditor5-engine/issues/1477.
-        const json = Object.assign({}, this);
-        json.__className = this.constructor.className;
-        // Remove reference to the parent `Batch` to avoid circular dependencies.
-        delete json.batch;
-        // This can be derived from `baseVersion` so we can remove it.
-        delete json.isDocumentOperation;
-        return json;
-    }
-    /**
-     * Name of the operation class used for serialization.
-     */
-    static get className() {
-        return 'Operation';
-    }
-    /**
-     * Creates `Operation` 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, document) {
-        return new this(json.baseVersion);
-    }
-}

package/src/model/operation/operationfactory.js

@@ -1,44 +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/operation/operationfactory
- */
-import { AttributeOperation } from './attributeoperation.js';
-import { InsertOperation } from './insertoperation.js';
-import { MarkerOperation } from './markeroperation.js';
-import { MoveOperation } from './moveoperation.js';
-import { NoOperation } from './nooperation.js';
-import { Operation } from './operation.js';
-import { RenameOperation } from './renameoperation.js';
-import { RootAttributeOperation } from './rootattributeoperation.js';
-import { RootOperation } from './rootoperation.js';
-import { SplitOperation } from './splitoperation.js';
-import { MergeOperation } from './mergeoperation.js';
-const operations = {};
-operations[AttributeOperation.className] = AttributeOperation;
-operations[InsertOperation.className] = InsertOperation;
-operations[MarkerOperation.className] = MarkerOperation;
-operations[MoveOperation.className] = MoveOperation;
-operations[NoOperation.className] = NoOperation;
-operations[Operation.className] = Operation;
-operations[RenameOperation.className] = RenameOperation;
-operations[RootAttributeOperation.className] = RootAttributeOperation;
-operations[RootOperation.className] = RootOperation;
-operations[SplitOperation.className] = SplitOperation;
-operations[MergeOperation.className] = MergeOperation;
-/**
- * A factory class for creating operations.
- */
-export class OperationFactory {
-    /**
-     * Creates an operation instance from a JSON object (parsed JSON string).
-     *
-     * @param json Deserialized JSON object.
-     * @param document Document on which this operation will be applied.
-     */
-    static fromJSON(json, document) {
-        return operations[json.__className].fromJSON(json, document);
-    }
-}

package/src/model/operation/renameoperation.js

@@ -1,128 +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/operation/renameoperation
- */
-import { Operation } from './operation.js';
-import { ModelElement } from '../element.js';
-import { ModelPosition } from '../position.js';
-import { CKEditorError } from '@ckeditor/ckeditor5-utils';
-/**
- * Operation to change element's name.
- *
- * Using this class you can change element's name.
- */
-export class RenameOperation extends Operation {
-    /**
-     * Position before an element to change.
-     */
-    position;
-    /**
-     * Current name of the element.
-     */
-    oldName;
-    /**
-     * New name for the element.
-     */
-    newName;
-    /**
-     * Creates an operation that changes element's name.
-     *
-     * @param position Position before an element to change.
-     * @param oldName Current name of the element.
-     * @param newName New name for the element.
-     * @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(position, oldName, newName, baseVersion) {
-        super(baseVersion);
-        this.position = position;
-        // This position sticks to the next node because it is a position before the node that we want to change.
-        this.position.stickiness = 'toNext';
-        this.oldName = oldName;
-        this.newName = newName;
-    }
-    /**
-     * @inheritDoc
-     */
-    get type() {
-        return 'rename';
-    }
-    /**
-     * @inheritDoc
-     */
-    get affectedSelectable() {
-        return this.position.nodeAfter;
-    }
-    /**
-     * Creates and returns an operation that has the same parameters as this operation.
-     *
-     * @returns Clone of this operation.
-     */
-    clone() {
-        return new RenameOperation(this.position.clone(), this.oldName, this.newName, this.baseVersion);
-    }
-    /**
-     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
-     */
-    getReversed() {
-        return new RenameOperation(this.position.clone(), this.newName, this.oldName, this.baseVersion + 1);
-    }
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _validate() {
-        const element = this.position.nodeAfter;
-        if (!(element instanceof ModelElement)) {
-            /**
-             * Given position is invalid or node after it is not instance of Element.
-             *
-             * @error rename-operation-wrong-position
-             */
-            throw new CKEditorError('rename-operation-wrong-position', this);
-        }
-        else if (this.oldName !== '' && element.name !== this.oldName) {
-            /**
-             * Element to change has different name than operation's old name.
-             *
-             * @error rename-operation-wrong-name
-             */
-            throw new CKEditorError('rename-operation-wrong-name', this);
-        }
-        this.oldName = element.name;
-    }
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _execute() {
-        const element = this.position.nodeAfter;
-        element.name = this.newName;
-    }
-    /**
-     * @inheritDoc
-     */
-    toJSON() {
-        const json = super.toJSON();
-        json.position = this.position.toJSON();
-        return json;
-    }
-    /**
-     * @inheritDoc
-     */
-    static get className() {
-        return 'RenameOperation';
-    }
-    /**
-     * Creates `RenameOperation` 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, document) {
-        return new RenameOperation(ModelPosition.fromJSON(json.position, document), json.oldName, json.newName, json.baseVersion);
-    }
-}