@ckeditor/ckeditor5-engine 39.0.1 → 40.0.0

package/src/model/batch.js

@@ -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
- */
-/**
- * @module engine/model/batch
- */
-import { logWarning } from '@ckeditor/ckeditor5-utils';
-/**
- * A batch instance groups model changes ({@link module:engine/model/operation/operation~Operation operations}). All operations
- * grouped in a single batch can be reverted together, so you can also think about a batch as of a single undo step. If you want
- * to extend a given undo step, you can add more changes to the batch using {@link module:engine/model/model~Model#enqueueChange}:
- *
- * ```ts
- * model.enqueueChange( batch, writer => {
- * 	writer.insertText( 'foo', paragraph, 'end' );
- * } );
- * ```
- *
- * @see module:engine/model/model~Model#enqueueChange
- * @see module:engine/model/model~Model#change
- */
-export default class Batch {
-    /**
-     * Creates a batch instance.
-     *
-     * @see module:engine/model/model~Model#enqueueChange
-     * @see module:engine/model/model~Model#change
-     * @param type A set of flags that specify the type of the batch. Batch type can alter how some of the features work
-     * when encountering a given `Batch` instance (for example, when a feature listens to applied operations).
-     */
-    constructor(type = {}) {
-        if (typeof type === 'string') {
-            type = type === 'transparent' ? { isUndoable: false } : {};
-            /**
-             * The string value for a `type` property of the `Batch` constructor has been deprecated and will be removed in the near future.
-             * Please refer to the {@link module:engine/model/batch~Batch#constructor `Batch` constructor API documentation} for more
-             * information.
-             *
-             * @error batch-constructor-deprecated-string-type
-             */
-            logWarning('batch-constructor-deprecated-string-type');
-        }
-        const { isUndoable = true, isLocal = true, isUndo = false, isTyping = false } = type;
-        this.operations = [];
-        this.isUndoable = isUndoable;
-        this.isLocal = isLocal;
-        this.isUndo = isUndo;
-        this.isTyping = isTyping;
-    }
-    /**
-     * The type of the batch.
-     *
-     * **This property has been deprecated and is always set to the `'default'` value.**
-     *
-     * It can be one of the following values:
-     * * `'default'` – All "normal" batches. This is the most commonly used type.
-     * * `'transparent'` – A batch that should be ignored by other features, i.e. an initial batch or collaborative editing
-     * changes.
-     *
-     * @deprecated
-     */
-    get type() {
-        /**
-         * The {@link module:engine/model/batch~Batch#type `Batch#type` } property has been deprecated and will be removed in the near
-         * future. Use `Batch#isLocal`, `Batch#isUndoable`, `Batch#isUndo` and `Batch#isTyping` instead.
-         *
-         * @error batch-type-deprecated
-         */
-        logWarning('batch-type-deprecated');
-        return 'default';
-    }
-    /**
-     * Returns the base version of this batch, which is equal to the base version of the first operation in the batch.
-     * If there are no operations in the batch or neither operation has the base version set, it returns `null`.
-     */
-    get baseVersion() {
-        for (const op of this.operations) {
-            if (op.baseVersion !== null) {
-                return op.baseVersion;
-            }
-        }
-        return null;
-    }
-    /**
-     * Adds an operation to the batch instance.
-     *
-     * @param operation An operation to add.
-     * @returns The added operation.
-     */
-    addOperation(operation) {
-        operation.batch = this;
-        this.operations.push(operation);
-        return 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/batch
+ */
+import { logWarning } from '@ckeditor/ckeditor5-utils';
+/**
+ * A batch instance groups model changes ({@link module:engine/model/operation/operation~Operation operations}). All operations
+ * grouped in a single batch can be reverted together, so you can also think about a batch as of a single undo step. If you want
+ * to extend a given undo step, you can add more changes to the batch using {@link module:engine/model/model~Model#enqueueChange}:
+ *
+ * ```ts
+ * model.enqueueChange( batch, writer => {
+ * 	writer.insertText( 'foo', paragraph, 'end' );
+ * } );
+ * ```
+ *
+ * @see module:engine/model/model~Model#enqueueChange
+ * @see module:engine/model/model~Model#change
+ */
+export default class Batch {
+    /**
+     * Creates a batch instance.
+     *
+     * @see module:engine/model/model~Model#enqueueChange
+     * @see module:engine/model/model~Model#change
+     * @param type A set of flags that specify the type of the batch. Batch type can alter how some of the features work
+     * when encountering a given `Batch` instance (for example, when a feature listens to applied operations).
+     */
+    constructor(type = {}) {
+        if (typeof type === 'string') {
+            type = type === 'transparent' ? { isUndoable: false } : {};
+            /**
+             * The string value for a `type` property of the `Batch` constructor has been deprecated and will be removed in the near future.
+             * Please refer to the {@link module:engine/model/batch~Batch#constructor `Batch` constructor API documentation} for more
+             * information.
+             *
+             * @error batch-constructor-deprecated-string-type
+             */
+            logWarning('batch-constructor-deprecated-string-type');
+        }
+        const { isUndoable = true, isLocal = true, isUndo = false, isTyping = false } = type;
+        this.operations = [];
+        this.isUndoable = isUndoable;
+        this.isLocal = isLocal;
+        this.isUndo = isUndo;
+        this.isTyping = isTyping;
+    }
+    /**
+     * The type of the batch.
+     *
+     * **This property has been deprecated and is always set to the `'default'` value.**
+     *
+     * It can be one of the following values:
+     * * `'default'` – All "normal" batches. This is the most commonly used type.
+     * * `'transparent'` – A batch that should be ignored by other features, i.e. an initial batch or collaborative editing
+     * changes.
+     *
+     * @deprecated
+     */
+    get type() {
+        /**
+         * The {@link module:engine/model/batch~Batch#type `Batch#type` } property has been deprecated and will be removed in the near
+         * future. Use `Batch#isLocal`, `Batch#isUndoable`, `Batch#isUndo` and `Batch#isTyping` instead.
+         *
+         * @error batch-type-deprecated
+         */
+        logWarning('batch-type-deprecated');
+        return 'default';
+    }
+    /**
+     * Returns the base version of this batch, which is equal to the base version of the first operation in the batch.
+     * If there are no operations in the batch or neither operation has the base version set, it returns `null`.
+     */
+    get baseVersion() {
+        for (const op of this.operations) {
+            if (op.baseVersion !== null) {
+                return op.baseVersion;
+            }
+        }
+        return null;
+    }
+    /**
+     * Adds an operation to the batch instance.
+     *
+     * @param operation An operation to add.
+     * @returns The added operation.
+     */
+    addOperation(operation) {
+        operation.batch = this;
+        this.operations.push(operation);
+        return operation;
+    }
+}