@ckeditor/ckeditor5-engine 40.0.0 → 40.1.0

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

@@ -1,96 +1,96 @@
-/**
- * @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
- */
-import type Batch from '../batch';
-import type Document from '../document';
-import type { Selectable } from '../selection';
-/**
- * @module engine/model/operation/operation
- */
-/**
- * Abstract base operation class.
- */
-export default abstract class Operation {
-    /**
-     * {@link module:engine/model/document~Document#version} on which operation can be applied. If you try to
-     * {@link module:engine/model/model~Model#applyOperation apply} operation with different base version than the
-     * {@link module:engine/model/document~Document#version document version} the
-     * {@link module:utils/ckeditorerror~CKEditorError model-document-applyOperation-wrong-version} error is thrown.
-     */
-    baseVersion: number | null;
-    /**
-     * Defines whether operation is executed on attached or detached {@link module:engine/model/item~Item items}.
-     */
-    readonly isDocumentOperation: boolean;
-    /**
-     * {@link module:engine/model/batch~Batch Batch} to which the operation is added or `null` if the operation is not
-     * added to any batch yet.
-     */
-    batch: Batch | null;
-    /**
-     * Operation type.
-     */
-    abstract readonly type: string;
-    /**
-     * Base operation constructor.
-     *
-     * @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(baseVersion: number | null);
-    /**
-     * A selectable that will be affected by the operation after it is executed.
-     *
-     * The exact returned parameter differs between operation types.
-     */
-    abstract get affectedSelectable(): Selectable;
-    /**
-     * Creates and returns an operation that has the same parameters as this operation.
-     *
-     * @returns Clone of this operation.
-     */
-    abstract clone(): Operation;
-    /**
-     * Creates and returns a reverse operation. Reverse operation when executed right after
-     * the original operation will bring back tree model state to the point before the original
-     * operation execution. In other words, it reverses changes done by the original operation.
-     *
-     * Keep in mind that tree model state may change since executing the original operation,
-     * so reverse operation will be "outdated". In that case you will need to transform it by
-     * all operations that were executed after the original operation.
-     *
-     * @returns Reversed operation.
-     */
-    abstract getReversed(): Operation;
-    /**
-     * Executes the operation - modifications described by the operation properties will be applied to the model tree.
-     *
-     * @internal
-     */
-    abstract _execute(): void;
-    /**
-     * Checks whether the operation's parameters are correct and the operation can be correctly executed. Throws
-     * an error if operation is not valid.
-     *
-     * @internal
-     */
-    _validate(): void;
-    /**
-     * Custom toJSON method to solve child-parent circular dependencies.
-     *
-     * @returns Clone of this object with the operation property replaced with string.
-     */
-    toJSON(): unknown;
-    /**
-     * Name of the operation class used for serialization.
-     */
-    static get className(): string;
-    /**
-     * Creates `Operation` object from deserialized object, i.e. from parsed JSON string.
-     *
-     * @param json Deserialized JSON object.
-     * @param doc Document on which this operation will be applied.
-     */
-    static fromJSON(json: any, document: Document): Operation;
-}
+/**
+ * @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/operation
+ */
+import type Batch from '../batch';
+import type Document from '../document';
+import type { Selectable } from '../selection';
+/**
+ * Abstract base operation class.
+ */
+export default abstract class Operation {
+    /**
+     * {@link module:engine/model/document~Document#version} on which operation can be applied. If you try to
+     * {@link module:engine/model/model~Model#applyOperation apply} operation with different base version than the
+     * {@link module:engine/model/document~Document#version document version} the
+     * {@link module:utils/ckeditorerror~CKEditorError model-document-applyOperation-wrong-version} error is thrown.
+     */
+    baseVersion: number | null;
+    /**
+     * Defines whether operation is executed on attached or detached {@link module:engine/model/item~Item items}.
+     */
+    readonly isDocumentOperation: boolean;
+    /**
+     * {@link module:engine/model/batch~Batch Batch} to which the operation is added or `null` if the operation is not
+     * added to any batch yet.
+     */
+    batch: Batch | null;
+    /**
+     * Operation type.
+     */
+    abstract readonly type: string;
+    /**
+     * Base operation constructor.
+     *
+     * @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(baseVersion: number | null);
+    /**
+     * A selectable that will be affected by the operation after it is executed.
+     *
+     * The exact returned parameter differs between operation types.
+     */
+    abstract get affectedSelectable(): Selectable;
+    /**
+     * Creates and returns an operation that has the same parameters as this operation.
+     *
+     * @returns Clone of this operation.
+     */
+    abstract clone(): Operation;
+    /**
+     * Creates and returns a reverse operation. Reverse operation when executed right after
+     * the original operation will bring back tree model state to the point before the original
+     * operation execution. In other words, it reverses changes done by the original operation.
+     *
+     * Keep in mind that tree model state may change since executing the original operation,
+     * so reverse operation will be "outdated". In that case you will need to transform it by
+     * all operations that were executed after the original operation.
+     *
+     * @returns Reversed operation.
+     */
+    abstract getReversed(): Operation;
+    /**
+     * Executes the operation - modifications described by the operation properties will be applied to the model tree.
+     *
+     * @internal
+     */
+    abstract _execute(): void;
+    /**
+     * Checks whether the operation's parameters are correct and the operation can be correctly executed. Throws
+     * an error if operation is not valid.
+     *
+     * @internal
+     */
+    _validate(): void;
+    /**
+     * Custom toJSON method to solve child-parent circular dependencies.
+     *
+     * @returns Clone of this object with the operation property replaced with string.
+     */
+    toJSON(): unknown;
+    /**
+     * Name of the operation class used for serialization.
+     */
+    static get className(): string;
+    /**
+     * Creates `Operation` object from deserialized object, i.e. from parsed JSON string.
+     *
+     * @param json Deserialized JSON object.
+     * @param doc Document on which this operation will be applied.
+     */
+    static fromJSON(json: any, document: Document): Operation;
+}

package/src/model/operation/operation.js

@@ -1,62 +1,59 @@
-/**
- * @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/operation
- */
-/**
- * Abstract base operation class.
- */
-export default class Operation {
-    /**
-     * Base operation constructor.
-     *
-     * @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(baseVersion) {
-        this.baseVersion = baseVersion;
-        this.isDocumentOperation = this.baseVersion !== null;
-        this.batch = null;
-    }
-    /**
-     * Checks whether the operation's parameters are correct and the operation can be correctly executed. Throws
-     * an error if operation is not valid.
-     *
-     * @internal
-     */
-    _validate() {
-    }
-    /**
-     * Custom toJSON method to solve child-parent circular dependencies.
-     *
-     * @returns Clone of this object with the operation property replaced with string.
-     */
-    toJSON() {
-        // This method creates only a shallow copy, all nested objects should be defined separately.
-        // See https://github.com/ckeditor/ckeditor5-engine/issues/1477.
-        const json = Object.assign({}, this);
-        json.__className = this.constructor.className;
-        // Remove reference to the parent `Batch` to avoid circular dependencies.
-        delete json.batch;
-        // Only document operations are shared with other clients so it is not necessary to keep this information.
-        delete json.isDocumentOperation;
-        return json;
-    }
-    /**
-     * Name of the operation class used for serialization.
-     */
-    static get className() {
-        return 'Operation';
-    }
-    /**
-     * Creates `Operation` object from deserialized object, i.e. from parsed JSON string.
-     *
-     * @param json Deserialized JSON object.
-     * @param doc Document on which this operation will be applied.
-     */
-    static fromJSON(json, document) {
-        return new this(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
+ */
+/**
+ * Abstract base operation class.
+ */
+export default class Operation {
+    /**
+     * Base operation constructor.
+     *
+     * @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(baseVersion) {
+        this.baseVersion = baseVersion;
+        this.isDocumentOperation = this.baseVersion !== null;
+        this.batch = null;
+    }
+    /**
+     * Checks whether the operation's parameters are correct and the operation can be correctly executed. Throws
+     * an error if operation is not valid.
+     *
+     * @internal
+     */
+    _validate() {
+    }
+    /**
+     * Custom toJSON method to solve child-parent circular dependencies.
+     *
+     * @returns Clone of this object with the operation property replaced with string.
+     */
+    toJSON() {
+        // This method creates only a shallow copy, all nested objects should be defined separately.
+        // See https://github.com/ckeditor/ckeditor5-engine/issues/1477.
+        const json = Object.assign({}, this);
+        json.__className = this.constructor.className;
+        // Remove reference to the parent `Batch` to avoid circular dependencies.
+        delete json.batch;
+        // Only document operations are shared with other clients so it is not necessary to keep this information.
+        delete json.isDocumentOperation;
+        return json;
+    }
+    /**
+     * Name of the operation class used for serialization.
+     */
+    static get className() {
+        return 'Operation';
+    }
+    /**
+     * Creates `Operation` object from deserialized object, i.e. from parsed JSON string.
+     *
+     * @param json Deserialized JSON object.
+     * @param doc Document on which this operation will be applied.
+     */
+    static fromJSON(json, document) {
+        return new this(json.baseVersion);
+    }
+}

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

@@ -1,18 +1,18 @@
-/**
- * @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
- */
-import Operation from './operation';
-import type Document from '../document';
-/**
- * A factory class for creating operations.
- */
-export default abstract class OperationFactory {
-    /**
-     * Creates an operation instance from a JSON object (parsed JSON string).
-     *
-     * @param json Deserialized JSON object.
-     * @param document Document on which this operation will be applied.
-     */
-    static fromJSON(json: any, document: Document): Operation;
-}
+/**
+ * @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
+ */
+import Operation from './operation';
+import type Document from '../document';
+/**
+ * A factory class for creating operations.
+ */
+export default abstract class OperationFactory {
+    /**
+     * Creates an operation instance from a JSON object (parsed JSON string).
+     *
+     * @param json Deserialized JSON object.
+     * @param document Document on which this operation will be applied.
+     */
+    static fromJSON(json: any, document: Document): Operation;
+}

package/src/model/operation/operationfactory.js

@@ -1,44 +1,44 @@
-/**
- * @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/operationfactory
- */
-import AttributeOperation from './attributeoperation';
-import InsertOperation from './insertoperation';
-import MarkerOperation from './markeroperation';
-import MoveOperation from './moveoperation';
-import NoOperation from './nooperation';
-import Operation from './operation';
-import RenameOperation from './renameoperation';
-import RootAttributeOperation from './rootattributeoperation';
-import RootOperation from './rootoperation';
-import SplitOperation from './splitoperation';
-import MergeOperation from './mergeoperation';
-const operations = {};
-operations[AttributeOperation.className] = AttributeOperation;
-operations[InsertOperation.className] = InsertOperation;
-operations[MarkerOperation.className] = MarkerOperation;
-operations[MoveOperation.className] = MoveOperation;
-operations[NoOperation.className] = NoOperation;
-operations[Operation.className] = Operation;
-operations[RenameOperation.className] = RenameOperation;
-operations[RootAttributeOperation.className] = RootAttributeOperation;
-operations[RootOperation.className] = RootOperation;
-operations[SplitOperation.className] = SplitOperation;
-operations[MergeOperation.className] = MergeOperation;
-/**
- * A factory class for creating operations.
- */
-export default class OperationFactory {
-    /**
-     * Creates an operation instance from a JSON object (parsed JSON string).
-     *
-     * @param json Deserialized JSON object.
-     * @param document Document on which this operation will be applied.
-     */
-    static fromJSON(json, document) {
-        return operations[json.__className].fromJSON(json, document);
-    }
-}
+/**
+ * @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/operationfactory
+ */
+import AttributeOperation from './attributeoperation';
+import InsertOperation from './insertoperation';
+import MarkerOperation from './markeroperation';
+import MoveOperation from './moveoperation';
+import NoOperation from './nooperation';
+import Operation from './operation';
+import RenameOperation from './renameoperation';
+import RootAttributeOperation from './rootattributeoperation';
+import RootOperation from './rootoperation';
+import SplitOperation from './splitoperation';
+import MergeOperation from './mergeoperation';
+const operations = {};
+operations[AttributeOperation.className] = AttributeOperation;
+operations[InsertOperation.className] = InsertOperation;
+operations[MarkerOperation.className] = MarkerOperation;
+operations[MoveOperation.className] = MoveOperation;
+operations[NoOperation.className] = NoOperation;
+operations[Operation.className] = Operation;
+operations[RenameOperation.className] = RenameOperation;
+operations[RootAttributeOperation.className] = RootAttributeOperation;
+operations[RootOperation.className] = RootOperation;
+operations[SplitOperation.className] = SplitOperation;
+operations[MergeOperation.className] = MergeOperation;
+/**
+ * A factory class for creating operations.
+ */
+export default class OperationFactory {
+    /**
+     * Creates an operation instance from a JSON object (parsed JSON string).
+     *
+     * @param json Deserialized JSON object.
+     * @param document Document on which this operation will be applied.
+     */
+    static fromJSON(json, document) {
+        return operations[json.__className].fromJSON(json, document);
+    }
+}

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

@@ -1,83 +1,83 @@
-/**
- * @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 Position from '../position';
-import type Document from '../document';
-import type { Selectable } from '../selection';
-/**
- * Operation to change element's name.
- *
- * Using this class you can change element's name.
- */
-export default class RenameOperation extends Operation {
-    /**
-     * Position before an element to change.
-     */
-    position: Position;
-    /**
-     * Current name of the element.
-     */
-    oldName: string;
-    /**
-     * New name for the element.
-     */
-    newName: string;
-    /**
-     * 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: Position, oldName: string, newName: string, baseVersion: number | null);
-    /**
-     * @inheritDoc
-     */
-    get type(): 'rename';
-    /**
-     * @inheritDoc
-     */
-    get affectedSelectable(): Selectable;
-    /**
-     * Creates and returns an operation that has the same parameters as this operation.
-     *
-     * @returns Clone of this operation.
-     */
-    clone(): RenameOperation;
-    /**
-     * 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 `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: any, document: Document): RenameOperation;
-}
+/**
+ * @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 Position from '../position';
+import type Document from '../document';
+import type { Selectable } from '../selection';
+/**
+ * Operation to change element's name.
+ *
+ * Using this class you can change element's name.
+ */
+export default class RenameOperation extends Operation {
+    /**
+     * Position before an element to change.
+     */
+    position: Position;
+    /**
+     * Current name of the element.
+     */
+    oldName: string;
+    /**
+     * New name for the element.
+     */
+    newName: string;
+    /**
+     * 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: Position, oldName: string, newName: string, baseVersion: number | null);
+    /**
+     * @inheritDoc
+     */
+    get type(): 'rename';
+    /**
+     * @inheritDoc
+     */
+    get affectedSelectable(): Selectable;
+    /**
+     * Creates and returns an operation that has the same parameters as this operation.
+     *
+     * @returns Clone of this operation.
+     */
+    clone(): RenameOperation;
+    /**
+     * 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 `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: any, document: Document): RenameOperation;
+}