@ckeditor/ckeditor5-engine 39.0.1 → 40.0.0

package/src/model/operation/renameoperation.js

@@ -1,115 +1,115 @@
-/**
- * @license Copyright (c) 2003-2023, 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';
-import Element from '../element';
-import Position from '../position';
-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);
-    }
-}
+/**
+ * @license Copyright (c) 2003-2023, 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';
+import Element from '../element';
+import Position from '../position';
+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

@@ -1,98 +1,98 @@
-/**
- * @license Copyright (c) 2003-2023, 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';
-import type Document from '../document';
-import type RootElement from '../rootelement';
-import type { Selectable } from '../selection';
-/**
- * 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;
-}
+/**
+ * @license Copyright (c) 2003-2023, 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';
+import type Document from '../document';
+import type RootElement from '../rootelement';
+import type { Selectable } from '../selection';
+/**
+ * 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;
+}