@ckeditor/ckeditor5-engine 0.0.0-internal-20241017.0

package/src/model/operation/renameoperation.js

@@ -0,0 +1,115 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module engine/model/operation/renameoperation
+ */
+import Operation from './operation.js';
+import Element from '../element.js';
+import Position 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 default class RenameOperation extends Operation {
+    /**
+     * 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~Document#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 Element)) {
+            /**
+             * 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 (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);
+        }
+    }
+    /**
+     * @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(Position.fromJSON(json.position, document), json.oldName, json.newName, json.baseVersion);
+    }
+}

package/src/model/operation/rootattributeoperation.d.ts

@@ -0,0 +1,98 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module engine/model/operation/rootattributeoperation
+ */
+import Operation from './operation.js';
+import type Document from '../document.js';
+import type RootElement from '../rootelement.js';
+import type { Selectable } from '../selection.js';
+/**
+ * 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~Position} has to be inside a root.
+ * {@link module:engine/model/position~Position} can't be created before a root element.
+ */
+export default class RootAttributeOperation extends Operation {
+    /**
+     * Root element to change.
+     */
+    readonly root: RootElement;
+    /**
+     * 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 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~Document#version} on which operation
+     * can be applied or `null` if the operation operates on detached (non-document) tree.
+     */
+    constructor(root: RootElement, key: string, oldValue: unknown, newValue: unknown, baseVersion: number | null);
+    /**
+     * @inheritDoc
+     */
+    get type(): 'addRootAttribute' | 'removeRootAttribute' | 'changeRootAttribute';
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable(): Selectable;
+    /**
+     * Creates and returns an operation that has the same parameters as this operation.
+     *
+     * @returns Clone of this operation.
+     */
+    clone(): RootAttributeOperation;
+    /**
+     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
+     */
+    getReversed(): Operation;
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    _validate(): void;
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    _execute(): void;
+    /**
+     * @inheritDoc
+     */
+    toJSON(): unknown;
+    /**
+     * @inheritDoc
+     */
+    static get className(): string;
+    /**
+     * 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: any, document: Document): RootAttributeOperation;
+}

package/src/model/operation/rootattributeoperation.js

@@ -0,0 +1,155 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @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~Position} has to be inside a root.
+ * {@link module:engine/model/position~Position} can't be created before a root element.
+ */
+export default class RootAttributeOperation extends Operation {
+    /**
+     * 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~Document#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 root
+             * @param key
+             * @param value
+             */
+            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 root
+             * @param key
+             * @param value
+             */
+            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 root
+             * @param key
+             */
+            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 specified name does not exist.
+             *
+             * @error rootattribute-operation-fromjson-no-root
+             * @param rootName
+             */
+            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.d.ts

@@ -0,0 +1,76 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module engine/model/operation/rootoperation
+ */
+import Operation from './operation.js';
+import type Document from '../document.js';
+import type { Selectable } from '../selection.js';
+/**
+ * Operation that creates (or attaches) or detaches a root element.
+ */
+export default class RootOperation extends Operation {
+    /**
+     * Root name to create or detach.
+     */
+    readonly rootName: string;
+    /**
+     * Root element name.
+     */
+    readonly elementName: string;
+    /**
+     * Specifies whether the operation adds (`true`) or detaches the root (`false`).
+     */
+    readonly isAdd: boolean;
+    /**
+     * Document which owns the root.
+     */
+    private readonly _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~Document#version} on which operation can be applied.
+     */
+    constructor(rootName: string, elementName: string, isAdd: boolean, document: Document, baseVersion: number);
+    /**
+     * @inheritDoc
+     */
+    get type(): 'addRoot' | 'detachRoot';
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable(): Selectable;
+    /**
+     * @inheritDoc
+     */
+    clone(): RootOperation;
+    /**
+     * @inheritDoc
+     */
+    getReversed(): RootOperation;
+    /**
+     * @inheritDoc
+     */
+    _execute(): void;
+    /**
+     * @inheritDoc
+     */
+    toJSON(): unknown;
+    /**
+     * @inheritDoc
+     */
+    static get className(): string;
+    /**
+     * 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: any, document: Document): RootOperation;
+}

package/src/model/operation/rootoperation.js

@@ -0,0 +1,90 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module engine/model/operation/rootoperation
+ */
+import Operation from './operation.js';
+/**
+ * Operation that creates (or attaches) or detaches a root element.
+ */
+export default class RootOperation extends Operation {
+    /**
+     * 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~Document#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.d.ts

@@ -0,0 +1,109 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module engine/model/operation/splitoperation
+ */
+import Operation from './operation.js';
+import Position from '../position.js';
+import Range from '../range.js';
+import type Document from '../document.js';
+import type { Selectable } from '../selection.js';
+/**
+ * Operation to split {@link module:engine/model/element~Element 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 default class SplitOperation extends Operation {
+    /**
+     * Position at which an element should be split.
+     */
+    splitPosition: Position;
+    /**
+     * Total offset size of elements that are in the split element after `position`.
+     */
+    howMany: number;
+    /**
+     * Position at which the clone of split element (or element from graveyard) will be inserted.
+     */
+    insertionPosition: Position;
+    /**
+     * 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: Position | null;
+    /**
+     * 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~Document#version} on which operation
+     * can be applied or `null` if the operation operates on detached (non-document) tree.
+     */
+    constructor(splitPosition: Position, howMany: number, insertionPosition: Position, graveyardPosition: Position | null, baseVersion: number | null);
+    /**
+     * @inheritDoc
+     */
+    get type(): '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(): Position;
+    /**
+     * 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(): Range;
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable(): Selectable;
+    /**
+     * Creates and returns an operation that has the same parameters as this operation.
+     *
+     * @returns Clone of this operation.
+     */
+    clone(): SplitOperation;
+    /**
+     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
+     */
+    getReversed(): Operation;
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    _validate(): void;
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    _execute(): void;
+    /**
+     * @inheritDoc
+     */
+    toJSON(): unknown;
+    /**
+     * @inheritDoc
+     */
+    static get className(): string;
+    /**
+     * Helper function that returns a default insertion position basing on given `splitPosition`. The default insertion
+     * position is after the split element.
+     */
+    static getInsertionPosition(splitPosition: Position): Position;
+    /**
+     * 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: any, document: Document): SplitOperation;
+}