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

package/src/model/operation/rootattributeoperation.js

@@ -1,173 +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/rootattributeoperation
- */
-import { Operation } from './operation.js';
-import { CKEditorError } from '@ckeditor/ckeditor5-utils';
-/**
- * Operation to change root element's attribute. Using this class you can add, remove or change value of the attribute.
- *
- * This operation is needed, because root elements can't be changed through
- * {@link module:engine/model/operation/attributeoperation~AttributeOperation}.
- * It is because {@link module:engine/model/operation/attributeoperation~AttributeOperation}
- * requires a range to change and root element can't
- * be a part of range because every {@link module:engine/model/position~ModelPosition} has to be inside a root.
- * {@link module:engine/model/position~ModelPosition} can't be created before a root element.
- */
-export class RootAttributeOperation extends Operation {
-    /**
-     * Root element to change.
-     */
-    root;
-    /**
-     * Key of an attribute to change or remove.
-     */
-    key;
-    /**
-     * Old value of the attribute with given key or `null`, if attribute was not set before.
-     *
-     * @readonly
-     */
-    oldValue;
-    /**
-     * New value of the attribute with given key or `null`, if operation should remove attribute.
-     *
-     * @readonly
-     */
-    newValue;
-    /**
-     * Creates an operation that changes, removes or adds attributes on root element.
-     *
-     * @see module:engine/model/operation/attributeoperation~AttributeOperation
-     * @param root Root element to change.
-     * @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(root, key, oldValue, newValue, baseVersion) {
-        super(baseVersion);
-        this.root = root;
-        this.key = key;
-        this.oldValue = oldValue === undefined ? null : oldValue;
-        this.newValue = newValue === undefined ? null : newValue;
-    }
-    /**
-     * @inheritDoc
-     */
-    get type() {
-        if (this.oldValue === null) {
-            return 'addRootAttribute';
-        }
-        else if (this.newValue === null) {
-            return 'removeRootAttribute';
-        }
-        else {
-            return 'changeRootAttribute';
-        }
-    }
-    /**
-     * @inheritDoc
-     */
-    get affectedSelectable() {
-        return this.root;
-    }
-    /**
-     * Creates and returns an operation that has the same parameters as this operation.
-     *
-     * @returns Clone of this operation.
-     */
-    clone() {
-        return new RootAttributeOperation(this.root, this.key, this.oldValue, this.newValue, this.baseVersion);
-    }
-    /**
-     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
-     */
-    getReversed() {
-        return new RootAttributeOperation(this.root, this.key, this.newValue, this.oldValue, this.baseVersion + 1);
-    }
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _validate() {
-        if (this.root != this.root.root || this.root.is('documentFragment')) {
-            /**
-             * The element to change is not a root element.
-             *
-             * @error rootattribute-operation-not-a-root
-             * @param {module:engine/model/rootelement~ModelRootElement} root The root element.
-             * @param {string} key The key of the attribute.
-             */
-            throw new CKEditorError('rootattribute-operation-not-a-root', this, { root: this.root, key: this.key });
-        }
-        if (this.oldValue !== null && this.root.getAttribute(this.key) !== this.oldValue) {
-            /**
-             * The attribute which should be removed does not exist for the given node.
-             *
-             * @error rootattribute-operation-wrong-old-value
-             * @param {module:engine/model/rootelement~ModelRootElement} root The root element.
-             * @param {string} key The key of the attribute.
-             */
-            throw new CKEditorError('rootattribute-operation-wrong-old-value', this, { root: this.root, key: this.key });
-        }
-        if (this.oldValue === null && this.newValue !== null && this.root.hasAttribute(this.key)) {
-            /**
-             * The attribute with given key already exists for the given node.
-             *
-             * @error rootattribute-operation-attribute-exists
-             * @param {module:engine/model/rootelement~ModelRootElement} root The root element.
-             * @param {string} key The key of the attribute.
-             */
-            throw new CKEditorError('rootattribute-operation-attribute-exists', this, { root: this.root, key: this.key });
-        }
-    }
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _execute() {
-        if (this.newValue !== null) {
-            this.root._setAttribute(this.key, this.newValue);
-        }
-        else {
-            this.root._removeAttribute(this.key);
-        }
-    }
-    /**
-     * @inheritDoc
-     */
-    toJSON() {
-        const json = super.toJSON();
-        json.root = this.root.toJSON();
-        return json;
-    }
-    /**
-     * @inheritDoc
-     */
-    static get className() {
-        return 'RootAttributeOperation';
-    }
-    /**
-     * Creates `RootAttributeOperation` 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) {
-        if (!document.getRoot(json.root)) {
-            /**
-             * Cannot create RootAttributeOperation for document. Root with the specified name does not exist.
-             *
-             * @error rootattribute-operation-fromjson-no-root
-             * @param {string} rootName The root name.
-             */
-            throw new CKEditorError('rootattribute-operation-fromjson-no-root', this, { rootName: json.root });
-        }
-        return new RootAttributeOperation(document.getRoot(json.root), json.key, json.oldValue, json.newValue, json.baseVersion);
-    }
-}

package/src/model/operation/rootoperation.js

@@ -1,106 +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/rootoperation
- */
-import { Operation } from './operation.js';
-/**
- * Operation that creates (or attaches) or detaches a root element.
- */
-export class RootOperation extends Operation {
-    /**
-     * Root name to create or detach.
-     */
-    rootName;
-    /**
-     * Root element name.
-     */
-    elementName;
-    /**
-     * Specifies whether the operation adds (`true`) or detaches the root (`false`).
-     */
-    isAdd;
-    /**
-     * Document which owns the root.
-     */
-    _document;
-    /**
-     * Creates an operation that creates or removes a root element.
-     *
-     * @param rootName Root name to create or detach.
-     * @param elementName Root element name.
-     * @param isAdd Specifies whether the operation adds (`true`) or detaches the root (`false`).
-     * @param document Document which owns the root.
-     * @param baseVersion Document {@link module:engine/model/document~ModelDocument#version} on which operation can be applied.
-     */
-    constructor(rootName, elementName, isAdd, document, baseVersion) {
-        super(baseVersion);
-        this.rootName = rootName;
-        this.elementName = elementName;
-        this.isAdd = isAdd;
-        this._document = document;
-        // Make sure that the root exists ASAP, this is important for RTC.
-        // If the root was dynamically added, there will be more operations that operate on/in this root.
-        // These operations will require root element instance (in operation property or in position instance).
-        // If the root is not created ahead of time, instantiating such operations may fail.
-        if (!this._document.getRoot(this.rootName)) {
-            const root = this._document.createRoot(this.elementName, this.rootName);
-            root._isAttached = false;
-        }
-    }
-    /**
-     * @inheritDoc
-     */
-    get type() {
-        return this.isAdd ? 'addRoot' : 'detachRoot';
-    }
-    /**
-     * @inheritDoc
-     */
-    get affectedSelectable() {
-        return this._document.getRoot(this.rootName);
-    }
-    /**
-     * @inheritDoc
-     */
-    clone() {
-        return new RootOperation(this.rootName, this.elementName, this.isAdd, this._document, this.baseVersion);
-    }
-    /**
-     * @inheritDoc
-     */
-    getReversed() {
-        return new RootOperation(this.rootName, this.elementName, !this.isAdd, this._document, this.baseVersion + 1);
-    }
-    /**
-     * @inheritDoc
-     */
-    _execute() {
-        this._document.getRoot(this.rootName)._isAttached = this.isAdd;
-    }
-    /**
-     * @inheritDoc
-     */
-    toJSON() {
-        const json = super.toJSON();
-        delete json._document;
-        return json;
-    }
-    /**
-     * @inheritDoc
-     */
-    static get className() {
-        return 'RootOperation';
-    }
-    /**
-     * Creates `RootOperation` 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 RootOperation(json.rootName, json.elementName, json.isAdd, document, json.baseVersion);
-    }
-}

package/src/model/operation/splitoperation.js

@@ -1,214 +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/splitoperation
- */
-import { Operation } from './operation.js';
-import { MergeOperation } from './mergeoperation.js';
-import { ModelPosition } from '../position.js';
-import { ModelRange } from '../range.js';
-import { _insert, _move } from './utils.js';
-import { CKEditorError } from '@ckeditor/ckeditor5-utils';
-/**
- * Operation to split {@link module:engine/model/element~ModelElement an element} at given
- * {@link module:engine/model/operation/splitoperation~SplitOperation#splitPosition split position} into two elements,
- * both containing a part of the element's original content.
- */
-export class SplitOperation extends Operation {
-    /**
-     * Position at which an element should be split.
-     */
-    splitPosition;
-    /**
-     * Total offset size of elements that are in the split element after `position`.
-     */
-    howMany;
-    /**
-     * Position at which the clone of split element (or element from graveyard) will be inserted.
-     */
-    insertionPosition;
-    /**
-     * Position in the graveyard root before the element which should be used as a parent of the nodes after `position`.
-     * If it is not set, a copy of the the `position` parent will be used.
-     *
-     * The default behavior is to clone the split element. Element from graveyard is used during undo.
-     */
-    graveyardPosition;
-    /**
-     * Creates a split operation.
-     *
-     * @param splitPosition Position at which an element should be split.
-     * @param howMany Total offset size of elements that are in the split element after `position`.
-     * @param insertionPosition Position at which the clone of split element (or element from graveyard) will be inserted.
-     * @param graveyardPosition Position in the graveyard root before the element which
-     * should be used as a parent of the nodes after `position`. If it is not set, a copy of the the `position` parent will be used.
-     * @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(splitPosition, howMany, insertionPosition, graveyardPosition, baseVersion) {
-        super(baseVersion);
-        this.splitPosition = splitPosition.clone();
-        // Keep position sticking to the next node. This way any new content added at the place where the element is split
-        // will be left in the original element.
-        this.splitPosition.stickiness = 'toNext';
-        this.howMany = howMany;
-        this.insertionPosition = insertionPosition;
-        this.graveyardPosition = graveyardPosition ? graveyardPosition.clone() : null;
-        if (this.graveyardPosition) {
-            this.graveyardPosition.stickiness = 'toNext';
-        }
-    }
-    /**
-     * @inheritDoc
-     */
-    get type() {
-        return 'split';
-    }
-    /**
-     * Position inside the new clone of a split element.
-     *
-     * This is a position where nodes that are after the split position will be moved to.
-     */
-    get moveTargetPosition() {
-        const path = this.insertionPosition.path.slice();
-        path.push(0);
-        return new ModelPosition(this.insertionPosition.root, path);
-    }
-    /**
-     * Artificial range that contains all the nodes from the split element that will be moved to the new element.
-     * The range starts at {@link #splitPosition} and ends in the same parent, at `POSITIVE_INFINITY` offset.
-     */
-    get movedRange() {
-        const end = this.splitPosition.getShiftedBy(Number.POSITIVE_INFINITY);
-        return new ModelRange(this.splitPosition, end);
-    }
-    /**
-     * @inheritDoc
-     */
-    get affectedSelectable() {
-        // These could be positions but `Selectable` type only supports `Iterable<Range>`.
-        const ranges = [
-            ModelRange._createFromPositionAndShift(this.splitPosition, 0),
-            ModelRange._createFromPositionAndShift(this.insertionPosition, 0)
-        ];
-        if (this.graveyardPosition) {
-            ranges.push(ModelRange._createFromPositionAndShift(this.graveyardPosition, 0));
-        }
-        return ranges;
-    }
-    /**
-     * Creates and returns an operation that has the same parameters as this operation.
-     *
-     * @returns Clone of this operation.
-     */
-    clone() {
-        return new SplitOperation(this.splitPosition, this.howMany, this.insertionPosition, this.graveyardPosition, this.baseVersion);
-    }
-    /**
-     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
-     */
-    getReversed() {
-        const graveyard = this.splitPosition.root.document.graveyard;
-        const graveyardPosition = new ModelPosition(graveyard, [0]);
-        return new MergeOperation(this.moveTargetPosition, this.howMany, this.splitPosition, graveyardPosition, this.baseVersion + 1);
-    }
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _validate() {
-        const element = this.splitPosition.parent;
-        const offset = this.splitPosition.offset;
-        // Validate whether split operation has correct parameters.
-        if (!element || element.maxOffset < offset) {
-            /**
-             * Split position is invalid.
-             *
-             * @error split-operation-position-invalid
-             */
-            throw new CKEditorError('split-operation-position-invalid', this);
-        }
-        else if (!element.parent) {
-            /**
-             * Cannot split root element.
-             *
-             * @error split-operation-split-in-root
-             */
-            throw new CKEditorError('split-operation-split-in-root', this);
-        }
-        else if (this.howMany !== Number.NEGATIVE_INFINITY && this.howMany != element.maxOffset - this.splitPosition.offset) {
-            /**
-             * Split operation specifies wrong number of nodes to move.
-             *
-             * @error split-operation-how-many-invalid
-             */
-            throw new CKEditorError('split-operation-how-many-invalid', this);
-        }
-        else if (this.graveyardPosition && !this.graveyardPosition.nodeAfter) {
-            /**
-             * Graveyard position invalid.
-             *
-             * @error split-operation-graveyard-position-invalid
-             */
-            throw new CKEditorError('split-operation-graveyard-position-invalid', this);
-        }
-        this.howMany = this.splitPosition.parent.maxOffset - this.splitPosition.offset;
-    }
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _execute() {
-        const splitElement = this.splitPosition.parent;
-        if (this.graveyardPosition) {
-            _move(ModelRange._createFromPositionAndShift(this.graveyardPosition, 1), this.insertionPosition);
-        }
-        else {
-            const newElement = splitElement._clone();
-            _insert(this.insertionPosition, newElement);
-        }
-        const sourceRange = new ModelRange(ModelPosition._createAt(splitElement, this.splitPosition.offset), ModelPosition._createAt(splitElement, splitElement.maxOffset));
-        _move(sourceRange, this.moveTargetPosition);
-    }
-    /**
-     * @inheritDoc
-     */
-    toJSON() {
-        const json = super.toJSON();
-        json.splitPosition = this.splitPosition.toJSON();
-        json.insertionPosition = this.insertionPosition.toJSON();
-        if (this.graveyardPosition) {
-            json.graveyardPosition = this.graveyardPosition.toJSON();
-        }
-        return json;
-    }
-    /**
-     * @inheritDoc
-     */
-    static get className() {
-        return 'SplitOperation';
-    }
-    /**
-     * Helper function that returns a default insertion position basing on given `splitPosition`. The default insertion
-     * position is after the split element.
-     */
-    static getInsertionPosition(splitPosition) {
-        const path = splitPosition.path.slice(0, -1);
-        path[path.length - 1]++;
-        return new ModelPosition(splitPosition.root, path, 'toPrevious');
-    }
-    /**
-     * Creates `SplitOperation` 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 splitPosition = ModelPosition.fromJSON(json.splitPosition, document);
-        const insertionPosition = ModelPosition.fromJSON(json.insertionPosition, document);
-        const graveyardPosition = json.graveyardPosition ? ModelPosition.fromJSON(json.graveyardPosition, document) : null;
-        return new this(splitPosition, json.howMany, insertionPosition, graveyardPosition, json.baseVersion);
-    }
-}