/**
* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
*/
import { type Operation } from "./operation/operation.js";
/**
* 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 declare class Batch implements BatchType {
	/**
	* An array of operations that compose this batch.
	*/
	readonly operations: Array<Operation>;
	/**
	* Whether the batch can be undone through the undo feature.
	*/
	readonly isUndoable: boolean;
	/**
	* Whether the batch includes operations created locally (`true`) or operations created on other, remote editors (`false`).
	*/
	readonly isLocal: boolean;
	/**
	* Whether the batch was created by the undo feature and undoes other operations.
	*/
	readonly isUndo: boolean;
	/**
	* Whether the batch includes operations connected with typing.
	*/
	readonly isTyping: boolean;
	/**
	* 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?: BatchType);
	/**
	* 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(): number | null;
	/**
	* Adds an operation to the batch instance.
	*
	* @param operation An operation to add.
	* @returns The added operation.
	*/
	addOperation(operation: Operation): Operation;
}
/**
* 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).
*/
export interface BatchType {
	/**
	* Whether a batch can be undone through undo feature.
	*
	* @default true
	*/
	isUndoable?: boolean;
	/**
	* Whether a batch includes operations created locally (`true`) or operations created on
	* other, remote editors (`false`).
	*
	* @default true
	*/
	isLocal?: boolean;
	/**
	* Whether a batch was created by the undo feature and undoes other operations.
	*
	* @default false
	*/
	isUndo?: boolean;
	/**
	* Whether a batch includes operations connected with a typing action.
	*
	* @default false
	*/
	isTyping?: boolean;
}