@ckeditor/ckeditor5-engine 40.0.0 → 40.1.0

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

@@ -1,103 +1,103 @@
-/**
- * @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/attributeoperation
- */
-import Operation from './operation';
-import Range from '../range';
-import type Document from '../document';
-import type { Selectable } from '../selection';
-/**
- * Operation to change nodes' attribute.
- *
- * Using this class you can add, remove or change value of the attribute.
- */
-export default class AttributeOperation extends Operation {
-    /**
-     * Range on which operation should be applied.
-     *
-     * @readonly
-     */
-    range: Range;
-    /**
-     * 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.
-     *
-     * 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~Document#version} on which operation
-     * can be applied or `null` if the operation operates on detached (non-document) tree.
-     */
-    constructor(range: Range, key: string, oldValue: unknown, newValue: unknown, baseVersion: number | null);
-    /**
-     * @inheritDoc
-     */
-    get type(): 'addAttribute' | 'removeAttribute' | 'changeAttribute';
-    /**
-     * @inheritDoc
-     */
-    get affectedSelectable(): Selectable;
-    /**
-     * Creates and returns an operation that has the same parameters as this operation.
-     */
-    clone(): AttributeOperation;
-    /**
-     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
-     */
-    getReversed(): Operation;
-    /**
-     * @inheritDoc
-     */
-    toJSON(): unknown;
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _validate(): void;
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _execute(): void;
-    /**
-     * @inheritDoc
-     */
-    static get className(): string;
-    /**
-     * 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: any, document: Document): AttributeOperation;
-}
+/**
+ * @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/attributeoperation
+ */
+import Operation from './operation';
+import Range from '../range';
+import type Document from '../document';
+import type { Selectable } from '../selection';
+/**
+ * Operation to change nodes' attribute.
+ *
+ * Using this class you can add, remove or change value of the attribute.
+ */
+export default class AttributeOperation extends Operation {
+    /**
+     * Range on which operation should be applied.
+     *
+     * @readonly
+     */
+    range: Range;
+    /**
+     * 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.
+     *
+     * 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~Document#version} on which operation
+     * can be applied or `null` if the operation operates on detached (non-document) tree.
+     */
+    constructor(range: Range, key: string, oldValue: unknown, newValue: unknown, baseVersion: number | null);
+    /**
+     * @inheritDoc
+     */
+    get type(): 'addAttribute' | 'removeAttribute' | 'changeAttribute';
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable(): Selectable;
+    /**
+     * Creates and returns an operation that has the same parameters as this operation.
+     */
+    clone(): AttributeOperation;
+    /**
+     * See {@link module:engine/model/operation/operation~Operation#getReversed `Operation#getReversed()`}.
+     */
+    getReversed(): Operation;
+    /**
+     * @inheritDoc
+     */
+    toJSON(): unknown;
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    _validate(): void;
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    _execute(): void;
+    /**
+     * @inheritDoc
+     */
+    static get className(): string;
+    /**
+     * 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: any, document: Document): AttributeOperation;
+}

package/src/model/operation/attributeoperation.js

@@ -1,148 +1,148 @@
-/**
- * @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/attributeoperation
- */
-import Operation from './operation';
-import { _setAttribute } from './utils';
-import Range from '../range';
-import { CKEditorError } from '@ckeditor/ckeditor5-utils';
-import { isEqual } from 'lodash-es';
-/**
- * Operation to change nodes' attribute.
- *
- * Using this class you can add, remove or change value of the attribute.
- */
-export default class AttributeOperation extends Operation {
-    /**
-     * 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~Document#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 item
-                 * @param key
-                 * @param 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 node
-                 * @param key
-                 */
-                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(Range.fromJSON(json.range, document), json.key, json.oldValue, json.newValue, 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/attributeoperation
+ */
+import Operation from './operation';
+import { _setAttribute } from './utils';
+import Range from '../range';
+import { CKEditorError } from '@ckeditor/ckeditor5-utils';
+import { isEqual } from 'lodash-es';
+/**
+ * Operation to change nodes' attribute.
+ *
+ * Using this class you can add, remove or change value of the attribute.
+ */
+export default class AttributeOperation extends Operation {
+    /**
+     * 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~Document#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 item
+                 * @param key
+                 * @param 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 node
+                 * @param key
+                 */
+                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(Range.fromJSON(json.range, document), json.key, json.oldValue, json.newValue, json.baseVersion);
+    }
+}

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

@@ -1,60 +1,60 @@
-/**
- * @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/detachoperation
- */
-import Operation from './operation';
-import type Position from '../position';
-import type { Selectable } from '../selection';
-/**
- * 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.
- */
-export default class DetachOperation extends Operation {
-    /**
-     * Position before the first {@link module:engine/model/item~Item model item} to detach.
-     */
-    sourcePosition: Position;
-    /**
-     * Offset size of moved range.
-     */
-    howMany: number;
-    clone: never;
-    getReversed: never;
-    /**
-     * Creates an insert operation.
-     *
-     * @param sourcePosition Position before the first {@link module:engine/model/item~Item 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: Position, howMany: number);
-    /**
-     * @inheritDoc
-     */
-    get type(): 'detach';
-    /**
-     * @inheritDoc
-     */
-    get affectedSelectable(): Selectable;
-    /**
-     * @inheritDoc
-     */
-    toJSON(): unknown;
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _validate(): void;
-    /**
-     * @inheritDoc
-     * @internal
-     */
-    _execute(): void;
-    /**
-     * @inheritDoc
-     */
-    static get className(): string;
-}
+/**
+ * @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/detachoperation
+ */
+import Operation from './operation';
+import type Position from '../position';
+import type { Selectable } from '../selection';
+/**
+ * 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.
+ */
+export default class DetachOperation extends Operation {
+    /**
+     * Position before the first {@link module:engine/model/item~Item model item} to detach.
+     */
+    sourcePosition: Position;
+    /**
+     * Offset size of moved range.
+     */
+    howMany: number;
+    clone: never;
+    getReversed: never;
+    /**
+     * Creates an insert operation.
+     *
+     * @param sourcePosition Position before the first {@link module:engine/model/item~Item 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: Position, howMany: number);
+    /**
+     * @inheritDoc
+     */
+    get type(): 'detach';
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable(): Selectable;
+    /**
+     * @inheritDoc
+     */
+    toJSON(): unknown;
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    _validate(): void;
+    /**
+     * @inheritDoc
+     * @internal
+     */
+    _execute(): void;
+    /**
+     * @inheritDoc
+     */
+    static get className(): string;
+}