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

package/src/model/operation/attributeoperation.js

@@ -1,172 +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/attributeoperation
- */
-import { Operation } from './operation.js';
-import { _setAttribute } from './utils.js';
-import { ModelRange } from '../range.js';
-import { CKEditorError } from '@ckeditor/ckeditor5-utils';
-import { isEqual } from 'es-toolkit/compat';
-/**
- * Operation to change nodes' attribute.
- *
- * Using this class you can add, remove or change value of the attribute.
- */
-export class AttributeOperation extends Operation {
-    /**
-     * Range on which operation should be applied.
-     *
-     * @readonly
-     */
-    range;
-    /**
-     * Key of an attribute to change or remove.
-     *
-     * @readonly
-     */
-    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.
-     *
-     * 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, key, oldValue, newValue, baseVersion) {
-        super(baseVersion);
-        this.range = range.clone();
-        this.key = key;
-        this.oldValue = oldValue === undefined ? null : oldValue;
-        this.newValue = newValue === undefined ? null : newValue;
-    }
-    /**
-     * @inheritDoc
-     */
-    get type() {
-        if (this.oldValue === null) {
-            return 'addAttribute';
-        }
-        else if (this.newValue === null) {
-            return 'removeAttribute';
-        }
-        else {
-            return 'changeAttribute';
-        }
-    }
-    /**
-     * @inheritDoc
-     */
-    get affectedSelectable() {
-        return this.range.clone();
-    }
-    /**
-     * Creates and returns an operation that has the same parameters as this operation.
-     */
-    clone() {
-        return new AttributeOperation(this.range, this.key, this.oldValue, this.newValue, this.baseVersion);
-    }
-    /**
-     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
-     */
-    getReversed() {
-        return new AttributeOperation(this.range, this.key, this.newValue, this.oldValue, this.baseVersion + 1);
-    }
-    /**
-     * @inheritDoc
-     */
-    toJSON() {
-        const json = super.toJSON();
-        json.range = this.range.toJSON();
-        return json;
-    }
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _validate() {
-        if (!this.range.isFlat) {
-            /**
-             * The range to change is not flat.
-             *
-             * @error attribute-operation-range-not-flat
-             */
-            throw new CKEditorError('attribute-operation-range-not-flat', this);
-        }
-        for (const item of this.range.getItems({ shallow: true })) {
-            if (this.oldValue !== null && !isEqual(item.getAttribute(this.key), this.oldValue)) {
-                /**
-                 * Changed node has different attribute value than operation's old attribute value.
-                 *
-                 * @error attribute-operation-wrong-old-value
-                 * @param {module:engine/model/item~ModelItem} root The item element.
-                 * @param {string} key The key of the attribute.
-                 * @param {never} value The value.
-                 */
-                throw new CKEditorError('attribute-operation-wrong-old-value', this, { item, key: this.key, value: this.oldValue });
-            }
-            if (this.oldValue === null && this.newValue !== null && item.hasAttribute(this.key)) {
-                /**
-                 * The attribute with given key already exists for the given node.
-                 *
-                 * @error attribute-operation-attribute-exists
-                 * @param {module:engine/model/item~ModelItem} root The item element.
-                 * @param {string} key The key of the attribute.
-                 */
-                throw new CKEditorError('attribute-operation-attribute-exists', this, { node: item, key: this.key });
-            }
-        }
-    }
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _execute() {
-        // If value to set is same as old value, don't do anything.
-        if (!isEqual(this.oldValue, this.newValue)) {
-            // Execution.
-            _setAttribute(this.range, this.key, this.newValue);
-        }
-    }
-    /**
-     * @inheritDoc
-     */
-    static get className() {
-        return 'AttributeOperation';
-    }
-    /**
-     * 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, document) {
-        return new AttributeOperation(ModelRange.fromJSON(json.range, document), json.key, json.oldValue, json.newValue, json.baseVersion);
-    }
-}

package/src/model/operation/detachoperation.js

@@ -1,87 +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/detachoperation
- */
-import { Operation } from './operation.js';
-import { ModelRange } from '../range.js';
-import { _remove } from './utils.js';
-import { CKEditorError } from '@ckeditor/ckeditor5-utils';
-// @if CK_DEBUG_ENGINE // const ModelRange = require( '../range' ).default;
-/**
- * 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 class DetachOperation extends Operation {
-    /**
-     * Position before the first {@link module:engine/model/item~ModelItem model item} to detach.
-     */
-    sourcePosition;
-    /**
-     * Offset size of moved range.
-     */
-    howMany;
-    /**
-     * 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, howMany) {
-        super(null);
-        this.sourcePosition = sourcePosition.clone();
-        this.howMany = howMany;
-    }
-    /**
-     * @inheritDoc
-     */
-    get type() {
-        return 'detach';
-    }
-    /**
-     * @inheritDoc
-     */
-    get affectedSelectable() {
-        return null;
-    }
-    /**
-     * @inheritDoc
-     */
-    toJSON() {
-        const json = super.toJSON();
-        json.sourcePosition = this.sourcePosition.toJSON();
-        return json;
-    }
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _validate() {
-        if (this.sourcePosition.root.document) {
-            /**
-             * Cannot detach document node.
-             *
-             * @error detach-operation-on-document-node
-             */
-            throw new CKEditorError('detach-operation-on-document-node', this);
-        }
-    }
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _execute() {
-        _remove(ModelRange._createFromPositionAndShift(this.sourcePosition, this.howMany));
-    }
-    /**
-     * @inheritDoc
-     */
-    static get className() {
-        return 'DetachOperation';
-    }
-}

package/src/model/operation/insertoperation.js

@@ -1,153 +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/insertoperation
- */
-import { Operation } from './operation.js';
-import { ModelPosition } from '../position.js';
-import { ModelNodeList } from '../nodelist.js';
-import { MoveOperation } from './moveoperation.js';
-import { _insert, _normalizeNodes } from './utils.js';
-import { ModelText } from '../text.js';
-import { ModelElement } from '../element.js';
-import { CKEditorError } from '@ckeditor/ckeditor5-utils';
-/**
- * Operation to insert one or more nodes at given position in the model.
- */
-export class InsertOperation extends Operation {
-    /**
-     * Position of insertion.
-     *
-     * @readonly
-     */
-    position;
-    /**
-     * List of nodes to insert.
-     *
-     * @readonly
-     */
-    nodes;
-    /**
-     * Flag deciding how the operation should be transformed. If set to `true`, nodes might get additional attributes
-     * during operational transformation. This happens when the operation insertion position is inside of a range
-     * where attributes have changed.
-     */
-    shouldReceiveAttributes;
-    /**
-     * Creates an insert operation.
-     *
-     * @param position Position of insertion.
-     * @param nodes The list of nodes to 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(position, nodes, baseVersion) {
-        super(baseVersion);
-        this.position = position.clone();
-        this.position.stickiness = 'toNone';
-        this.nodes = new ModelNodeList(_normalizeNodes(nodes));
-        this.shouldReceiveAttributes = false;
-    }
-    /**
-     * @inheritDoc
-     */
-    get type() {
-        return 'insert';
-    }
-    /**
-     * Total offset size of inserted nodes.
-     */
-    get howMany() {
-        return this.nodes.maxOffset;
-    }
-    /**
-     * @inheritDoc
-     */
-    get affectedSelectable() {
-        return this.position.clone();
-    }
-    /**
-     * Creates and returns an operation that has the same parameters as this operation.
-     */
-    clone() {
-        const nodes = new ModelNodeList([...this.nodes].map(node => node._clone(true)));
-        const insert = new InsertOperation(this.position, nodes, this.baseVersion);
-        insert.shouldReceiveAttributes = this.shouldReceiveAttributes;
-        return insert;
-    }
-    /**
-     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
-     */
-    getReversed() {
-        const graveyard = this.position.root.document.graveyard;
-        const gyPosition = new ModelPosition(graveyard, [0]);
-        return new MoveOperation(this.position, this.nodes.maxOffset, gyPosition, this.baseVersion + 1);
-    }
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _validate() {
-        const targetElement = this.position.parent;
-        if (!targetElement || targetElement.maxOffset < this.position.offset) {
-            /**
-             * Insertion position is invalid.
-             *
-             * @error insert-operation-position-invalid
-             */
-            throw new CKEditorError('insert-operation-position-invalid', this);
-        }
-    }
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _execute() {
-        // What happens here is that we want original nodes be passed to writer because we want original nodes
-        // to be inserted to the model. But in InsertOperation, we want to keep those nodes as they were added
-        // to the operation, not modified. For example, text nodes can get merged or cropped while Elements can
-        // get children. It is important that InsertOperation has the copy of original nodes in intact state.
-        const originalNodes = this.nodes;
-        this.nodes = new ModelNodeList([...originalNodes].map(node => node._clone(true)));
-        _insert(this.position, originalNodes);
-    }
-    /**
-     * @inheritDoc
-     */
-    toJSON() {
-        const json = super.toJSON();
-        json.position = this.position.toJSON();
-        json.nodes = this.nodes.toJSON();
-        return json;
-    }
-    /**
-     * @inheritDoc
-     */
-    static get className() {
-        return 'InsertOperation';
-    }
-    /**
-     * Creates `InsertOperation` 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 children = [];
-        for (const child of json.nodes) {
-            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));
-            }
-        }
-        const insert = new InsertOperation(ModelPosition.fromJSON(json.position, document), children, json.baseVersion);
-        insert.shouldReceiveAttributes = json.shouldReceiveAttributes;
-        return insert;
-    }
-}

package/src/model/operation/markeroperation.js

@@ -1,136 +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/markeroperation
- */
-import { Operation } from './operation.js';
-import { ModelRange } from '../range.js';
-export class MarkerOperation extends Operation {
-    /**
-     * Marker name.
-     *
-     * @readonly
-     */
-    name;
-    /**
-     * Marker range before the change.
-     *
-     * @readonly
-     */
-    oldRange;
-    /**
-     * Marker range after the change.
-     *
-     * @readonly
-     */
-    newRange;
-    /**
-     * Specifies whether the marker operation affects the data produced by the data pipeline
-     * (is persisted in the editor's data).
-     *
-     * @readonly
-     */
-    affectsData;
-    /**
-     * Marker collection on which change should be executed.
-     */
-    _markers;
-    /**
-     * @param name Marker name.
-     * @param oldRange Marker range before the change.
-     * @param newRange Marker range after the change.
-     * @param markers Marker collection on which change should be executed.
-     * @param affectsData Specifies whether the marker operation affects the data produced by the data pipeline
-     * (is persisted in the editor's data).
-     * @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(name, oldRange, newRange, markers, affectsData, baseVersion) {
-        super(baseVersion);
-        this.name = name;
-        this.oldRange = oldRange ? oldRange.clone() : null;
-        this.newRange = newRange ? newRange.clone() : null;
-        this.affectsData = affectsData;
-        this._markers = markers;
-    }
-    /**
-     * @inheritDoc
-     */
-    get type() {
-        return 'marker';
-    }
-    /**
-     * @inheritDoc
-     */
-    get affectedSelectable() {
-        const ranges = [];
-        if (this.oldRange) {
-            ranges.push(this.oldRange.clone());
-        }
-        if (this.newRange) {
-            if (this.oldRange) {
-                ranges.push(...this.newRange.getDifference(this.oldRange));
-            }
-            else {
-                ranges.push(this.newRange.clone());
-            }
-        }
-        return ranges;
-    }
-    /**
-     * Creates and returns an operation that has the same parameters as this operation.
-     */
-    clone() {
-        return new MarkerOperation(this.name, this.oldRange, this.newRange, this._markers, this.affectsData, this.baseVersion);
-    }
-    /**
-     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
-     */
-    getReversed() {
-        return new MarkerOperation(this.name, this.newRange, this.oldRange, this._markers, this.affectsData, this.baseVersion + 1);
-    }
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _execute() {
-        if (this.newRange) {
-            this._markers._set(this.name, this.newRange, true, this.affectsData);
-        }
-        else {
-            this._markers._remove(this.name);
-        }
-    }
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    toJSON() {
-        const json = super.toJSON();
-        if (this.oldRange) {
-            json.oldRange = this.oldRange.toJSON();
-        }
-        if (this.newRange) {
-            json.newRange = this.newRange.toJSON();
-        }
-        delete json._markers;
-        return json;
-    }
-    /**
-     * @inheritDoc
-     */
-    static get className() {
-        return 'MarkerOperation';
-    }
-    /**
-     * Creates `MarkerOperation` 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 MarkerOperation(json.name, json.oldRange ? ModelRange.fromJSON(json.oldRange, document) : null, json.newRange ? ModelRange.fromJSON(json.newRange, document) : null, document.model.markers, json.affectsData, json.baseVersion);
-    }
-}