@ckeditor/ckeditor5-engine 30.0.0

package/src/index.js

@@ -0,0 +1,52 @@
+/**
+ * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. 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';
+export { default as LivePosition } from './model/liveposition';
+export { default as Model } from './model/model';
+export { default as TreeWalker } from './model/treewalker';
+export { default as Element } from './model/element';
+
+export { default as DomConverter } from './view/domconverter';
+export { default as Renderer } from './view/renderer';
+export { default as ViewDocument } from './view/document';
+
+export { getFillerOffset } from './view/containerelement';
+export { default as Observer } from './view/observer/observer';
+export { default as ClickObserver } from './view/observer/clickobserver';
+export { default as DomEventObserver } from './view/observer/domeventobserver';
+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';
+export * from './view/styles/margin';
+export * from './view/styles/padding';
+export * from './view/styles/utils';

package/src/model/batch.js

@@ -0,0 +1,82 @@
+/**
+ * @license Copyright (c) 2003-2021, CKSource - Frederico Knabben. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+
+/**
+ * @module engine/model/batch
+ */
+
+/**
+ * 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}:
+ *
+ *		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 {'transparent'|'default'} [type='default'] The type of the batch.
+	 */
+	constructor( type = 'default' ) {
+		/**
+		 * An array of operations that compose this batch.
+		 *
+		 * @readonly
+		 * @type {Array.<module:engine/model/operation/operation~Operation>}
+		 */
+		this.operations = [];
+
+		/**
+		 * The type of the batch.
+		 *
+		 * 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.
+		 *
+		 * @readonly
+		 * @type {'transparent'|'default'}
+		 */
+		this.type = type;
+	}
+
+	/**
+	 * 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;
+	}
+}