@ckeditor/ckeditor5-engine 34.2.0 → 35.1.0

package/src/index.js

@@ -2,25 +2,18 @@
  * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module engine
  */
-
 export * from './view/placeholder';
-
 export { default as EditingController } from './controller/editingcontroller';
 export { default as DataController } from './controller/datacontroller';
-
 export { default as Conversion } from './conversion/conversion';
-
 export { default as HtmlDataProcessor } from './dataprocessor/htmldataprocessor';
-
 export { default as InsertOperation } from './model/operation/insertoperation';
 export { default as MarkerOperation } from './model/operation/markeroperation';
 export { default as OperationFactory } from './model/operation/operationfactory';
 export { transformSets } from './model/operation/transform';
-
 export { default as DocumentSelection } from './model/documentselection';
 export { default as Range } from './model/range';
 export { default as LiveRange } from './model/liverange';
@@ -32,7 +25,6 @@ export { default as Position } from './model/position';
 export { default as DocumentFragment } from './model/documentfragment';
 export { default as History } from './model/history';
 export { default as Text } from './model/text';
-
 export { default as DomConverter } from './view/domconverter';
 export { default as Renderer } from './view/renderer';
 export { default as ViewDocument } from './view/document';
@@ -44,7 +36,6 @@ export { default as ViewEmptyElement } from './view/emptyelement';
 export { default as ViewRawElement } from './view/rawelement';
 export { default as ViewUIElement } from './view/uielement';
 export { default as ViewDocumentFragment } from './view/documentfragment';
-
 export { getFillerOffset } from './view/containerelement';
 export { default as Observer } from './view/observer/observer';
 export { default as ClickObserver } from './view/observer/clickobserver';
@@ -53,9 +44,7 @@ export { default as MouseObserver } from './view/observer/mouseobserver';
 export { default as DowncastWriter } from './view/downcastwriter';
 export { default as UpcastWriter } from './view/upcastwriter';
 export { default as Matcher } from './view/matcher';
-
 export { default as DomEventData } from './view/observer/domeventdata';
-
 export { StylesProcessor } from './view/stylesmap';
 export * from './view/styles/background';
 export * from './view/styles/border';

package/src/model/batch.js

@@ -2,13 +2,10 @@
  * @license Copyright (c) 2003-2022, 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/src/ckeditorerror';
-
 /**
  * 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
@@ -22,128 +19,115 @@ import { logWarning } from '@ckeditor/ckeditor5-utils/src/ckeditorerror';
  * @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 {Object} [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).
-	 * @param {Boolean} [type.isUndoable=true] Whether a batch can be undone through undo feature.
-	 * @param {Boolean} [type.isLocal=true] Whether a batch includes operations created locally (`true`) or operations created on
-	 * other, remote editors (`false`).
-	 * @param {Boolean} [type.isUndo=false] Whether a batch was created by the undo feature and undoes other operations.
-	 * @param {Boolean} [type.isTyping=false] Whether a batch includes operations connected with a typing action.
-	 */
-	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;
-
-		/**
-		 * An array of operations that compose this batch.
-		 *
-		 * @readonly
-		 * @type {Array.<module:engine/model/operation/operation~Operation>}
-		 */
-		this.operations = [];
-
-		/**
-		 * Whether the batch can be undone through the undo feature.
-		 *
-		 * @readonly
-		 * @type {Boolean}
-		 */
-		this.isUndoable = isUndoable;
-
-		/**
-		 * Whether the batch includes operations created locally (`true`) or operations created on other, remote editors (`false`).
-		 *
-		 * @readonly
-		 * @type {Boolean}
-		 */
-		this.isLocal = isLocal;
-
-		/**
-		 * Whether the batch was created by the undo feature and undoes other operations.
-		 *
-		 * @readonly
-		 * @type {Boolean}
-		 */
-		this.isUndo = isUndo;
-
-		/**
-		 * Whether the batch includes operations connected with typing.
-		 *
-		 * @readonly
-		 * @type {Boolean}
-		 */
-		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'` &ndash; All "normal" batches. This is the most commonly used type.
-	 * * `'transparent'` &ndash; A batch that should be ignored by other features, i.e. an initial batch or collaborative editing
-	 * changes.
-	 *
-	 * @deprecated
-	 * @type {'default'}
-	 */
-	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`.
-	 *
-	 * @readonly
-	 * @type {Number|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 {module:engine/model/operation/operation~Operation} operation An operation to add.
-	 * @returns {module:engine/model/operation/operation~Operation} The added operation.
-	 */
-	addOperation( operation ) {
-		operation.batch = this;
-		this.operations.push( operation );
-
-		return operation;
-	}
+    /**
+     * Creates a batch instance.
+     *
+     * @see module:engine/model/model~Model#enqueueChange
+     * @see module:engine/model/model~Model#change
+     * @param {Object} [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).
+     * @param {Boolean} [type.isUndoable=true] Whether a batch can be undone through undo feature.
+     * @param {Boolean} [type.isLocal=true] Whether a batch includes operations created locally (`true`) or operations created on
+     * other, remote editors (`false`).
+     * @param {Boolean} [type.isUndo=false] Whether a batch was created by the undo feature and undoes other operations.
+     * @param {Boolean} [type.isTyping=false] Whether a batch includes operations connected with a typing action.
+     */
+    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;
+        /**
+         * An array of operations that compose this batch.
+         *
+         * @readonly
+         * @type {Array.<module:engine/model/operation/operation~Operation>}
+         */
+        this.operations = [];
+        /**
+         * Whether the batch can be undone through the undo feature.
+         *
+         * @readonly
+         * @type {Boolean}
+         */
+        this.isUndoable = isUndoable;
+        /**
+         * Whether the batch includes operations created locally (`true`) or operations created on other, remote editors (`false`).
+         *
+         * @readonly
+         * @type {Boolean}
+         */
+        this.isLocal = isLocal;
+        /**
+         * Whether the batch was created by the undo feature and undoes other operations.
+         *
+         * @readonly
+         * @type {Boolean}
+         */
+        this.isUndo = isUndo;
+        /**
+         * Whether the batch includes operations connected with typing.
+         *
+         * @readonly
+         * @type {Boolean}
+         */
+        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'` &ndash; All "normal" batches. This is the most commonly used type.
+     * * `'transparent'` &ndash; A batch that should be ignored by other features, i.e. an initial batch or collaborative editing
+     * changes.
+     *
+     * @deprecated
+     * @type {'default'}
+     */
+    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`.
+     *
+     * @readonly
+     * @type {Number|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 {module:engine/model/operation/operation~Operation} operation An operation to add.
+     * @returns {module:engine/model/operation/operation~Operation} The added operation.
+     */
+    addOperation(operation) {
+        operation.batch = this;
+        this.operations.push(operation);
+        return operation;
+    }
 }