@ckeditor/ckeditor5-undo 41.3.0-alpha.3 → 41.3.0

package/dist/types/basecommand.d.ts

@@ -1,76 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module undo/basecommand
- */
-import { Command, type Editor } from '@ckeditor/ckeditor5-core';
-import { type Batch, type Operation, type Range } from '@ckeditor/ckeditor5-engine';
-/**
- * Base class for the undo feature commands: {@link module:undo/undocommand~UndoCommand} and {@link module:undo/redocommand~RedoCommand}.
- */
-export default abstract class BaseCommand extends Command {
-    /**
-     * Stack of items stored by the command. These are pairs of:
-     *
-     * * {@link module:engine/model/batch~Batch batch} saved by the command,
-     * * {@link module:engine/model/selection~Selection selection} state at the moment of saving the batch.
-     */
-    protected _stack: Array<{
-        batch: Batch;
-        selection: {
-            ranges: Array<Range>;
-            isBackward: boolean;
-        };
-    }>;
-    /**
-     * Stores all batches that were created by this command.
-     *
-     * @internal
-     */
-    _createdBatches: WeakSet<Batch>;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    refresh(): void;
-    /**
-     * Returns all batches created by this command.
-     */
-    get createdBatches(): WeakSet<Batch>;
-    /**
-     * Stores a batch in the command, together with the selection state of the {@link module:engine/model/document~Document document}
-     * created by the editor which this command is registered to.
-     *
-     * @param batch The batch to add.
-     */
-    addBatch(batch: Batch): void;
-    /**
-     * Removes all items from the stack.
-     */
-    clearStack(): void;
-    /**
-     * Restores the {@link module:engine/model/document~Document#selection document selection} state after a batch was undone.
-     *
-     * @param ranges Ranges to be restored.
-     * @param isBackward A flag describing whether the restored range was selected forward or backward.
-     * @param operations Operations which has been applied since selection has been stored.
-     */
-    protected _restoreSelection(ranges: Array<Range>, isBackward: boolean, operations: Array<Operation>): void;
-    /**
-     * Undoes a batch by reversing that batch, transforming reversed batch and finally applying it.
-     * This is a helper method for {@link #execute}.
-     *
-     * @param batchToUndo The batch to be undone.
-     * @param undoingBatch The batch that will contain undoing changes.
-     */
-    protected _undo(batchToUndo: Batch, undoingBatch: Batch): void;
-}

package/dist/types/index.d.ts

@@ -1,17 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module undo
- */
-export { default as Undo } from './undo.js';
-export { default as UndoEditing } from './undoediting.js';
-export { default as UndoUI } from './undoui.js';
-export type { default as UndoCommand } from './undocommand.js';
-export type { default as RedoCommand } from './redocommand.js';
-import './augmentation.js';

package/dist/types/redocommand.d.ts

@@ -1,31 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module undo/redocommand
- */
-import BaseCommand from './basecommand.js';
-/**
- * The redo command stores {@link module:engine/model/batch~Batch batches} that were used to undo a batch by
- * {@link module:undo/undocommand~UndoCommand}. It is able to redo a previously undone batch by reversing the undoing
- * batches created by `UndoCommand`. The reversed batch is transformed by all the batches from
- * {@link module:engine/model/document~Document#history history} that happened after the reversed undo batch.
- *
- * The redo command also takes care of restoring the {@link module:engine/model/document~Document#selection document selection}.
- */
-export default class RedoCommand extends BaseCommand {
-    /**
-     * Executes the command. This method reverts the last {@link module:engine/model/batch~Batch batch} added to
-     * the command's stack, applies the reverted and transformed version on the
-     * {@link module:engine/model/document~Document document} and removes the batch from the stack.
-     * Then, it restores the {@link module:engine/model/document~Document#selection document selection}.
-     *
-     * @fires execute
-     */
-    execute(): void;
-}

package/dist/types/undo.d.ts

@@ -1,121 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module undo/undo
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import UndoEditing from './undoediting.js';
-import UndoUI from './undoui.js';
-/**
- * The undo feature.
- *
- * This is a "glue" plugin which loads the {@link module:undo/undoediting~UndoEditing undo editing feature}
- * and the {@link module:undo/undoui~UndoUI undo UI feature}.
- *
- * Below is an explanation of the undo mechanism working together with {@link module:engine/model/history~History History}:
- *
- * Whenever an {@link module:engine/model/operation/operation~Operation operation} is applied to the
- * {@link module:engine/model/document~Document document}, it is saved to `History` as is.
- * The {@link module:engine/model/batch~Batch batch} that owns that operation is also saved, in
- * {@link module:undo/undocommand~UndoCommand}, together with the selection that was present in the document before the
- * operation was applied. A batch is saved instead of the operation because changes are undone batch-by-batch, not operation-by-operation
- * and a batch is seen as one undo step.
- *
- * After changes happen to the document, the `History` and `UndoCommand` stack can be represented as follows:
- *
- * ```
- *    History                            Undo stack
- * ==============             ==================================
- * [operation A1]                      [  batch A  ]
- * [operation B1]                      [  batch B  ]
- * [operation B2]                      [  batch C  ]
- * [operation C1]
- * [operation C2]
- * [operation B3]
- * [operation C3]
- * ```
- *
- * Where operations starting with the same letter are from same batch.
- *
- * Undoing a batch means that a set of operations which will reverse the effects of that batch needs to be generated.
- * For example, if a batch added several letters, undoing the batch should remove them. It is important to apply undoing
- * operations in the reversed order, so if a batch has operation `X`, `Y`, `Z`, reversed operations `Zr`, `Yr` and `Xr`
- * need to be applied. Otherwise reversed operation `Xr` would operate on a wrong document state, because operation `X`
- * does not know that operations `Y` and `Z` happened.
- *
- * After operations from an undone batch got {@link module:engine/model/operation/operation~Operation#getReversed reversed},
- * one needs to make sure if they are ready to be applied. In the scenario above, operation `C3` is the last operation and `C3r`
- * bases on up-to-date document state, so it can be applied to the document.
- *
- * ```
- *      History                             Undo stack
- * =================             ==================================
- * [ operation A1  ]                      [  batch A  ]
- * [ operation B1  ]                      [  batch B  ]
- * [ operation B2  ]             [   processing undoing batch C   ]
- * [ operation C1  ]
- * [ operation C2  ]
- * [ operation B3  ]
- * [ operation C3  ]
- * [ operation C3r ]
- * ```
- *
- * Next is operation `C2`, reversed to `C2r`. `C2r` bases on `C2`, so it bases on the wrong document state. It needs to be
- * transformed by operations from history that happened after it, so it "knows" about them. Let us assume that `C2' = C2r * B3 * C3 * C3r`,
- * where `*` means "transformed by". Rest of operations from that batch are processed in the same fashion.
- *
- * ```
- *      History                             Undo stack                                      Redo stack
- * =================             ==================================             ==================================
- * [ operation A1  ]                      [  batch A  ]                                    [ batch Cr ]
- * [ operation B1  ]                      [  batch B  ]
- * [ operation B2  ]
- * [ operation C1  ]
- * [ operation C2  ]
- * [ operation B3  ]
- * [ operation C3  ]
- * [ operation C3r ]
- * [ operation C2' ]
- * [ operation C1' ]
- * ```
- *
- * Selective undo works on the same basis, however, instead of undoing the last batch in the undo stack, any batch can be undone.
- * The same algorithm applies: operations from a batch (i.e. `A1`) are reversed and then transformed by operations stored in history.
- *
- * Redo also is very similar to undo. It has its own stack that is filled with undoing (reversed batches). Operations from
- * the batch that is re-done are reversed-back, transformed in proper order and applied to the document.
- *
- * ```
- *      History                             Undo stack                                      Redo stack
- * =================             ==================================             ==================================
- * [ operation A1  ]                      [  batch A  ]
- * [ operation B1  ]                      [  batch B  ]
- * [ operation B2  ]                      [ batch Crr ]
- * [ operation C1  ]
- * [ operation C2  ]
- * [ operation B3  ]
- * [ operation C3  ]
- * [ operation C3r ]
- * [ operation C2' ]
- * [ operation C1' ]
- * [ operation C1'r]
- * [ operation C2'r]
- * [ operation C3rr]
- * ```
- */
-export default class Undo extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof UndoEditing, typeof UndoUI];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "Undo";
-}

package/dist/types/undocommand.d.ts

@@ -1,41 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module undo/undocommand
- */
-import BaseCommand from './basecommand.js';
-import type { Batch } from '@ckeditor/ckeditor5-engine';
-/**
- * The undo command stores {@link module:engine/model/batch~Batch batches} applied to the
- * {@link module:engine/model/document~Document document} and is able to undo a batch by reversing it and transforming by
- * batches from {@link module:engine/model/document~Document#history history} that happened after the reversed batch.
- *
- * The undo command also takes care of restoring the {@link module:engine/model/document~Document#selection document selection}.
- */
-export default class UndoCommand extends BaseCommand {
-    /**
-     * Executes the command. This method reverts a {@link module:engine/model/batch~Batch batch} added to the command's stack, transforms
-     * and applies the reverted version on the {@link module:engine/model/document~Document document} and removes the batch from the stack.
-     * Then, it restores the {@link module:engine/model/document~Document#selection document selection}.
-     *
-     * @fires execute
-     * @fires revert
-     * @param batch A batch that should be undone. If not set, the last added batch will be undone.
-     */
-    execute(batch?: Batch | null): void;
-}
-/**
- * Fired when execution of the command reverts some batch.
- *
- * @eventName ~UndoCommand#revert
- */
-export type UndoCommandRevertEvent = {
-    name: 'revert';
-    args: [batch: Batch, undoingBatch: Batch];
-};

package/dist/types/undoediting.d.ts

@@ -1,41 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module undo/undoediting
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-/**
- * The undo engine feature.
- *
- * It introduces the `'undo'` and `'redo'` commands to the editor.
- */
-export default class UndoEditing extends Plugin {
-    /**
-     * The command that manages the undo {@link module:engine/model/batch~Batch batches} stack (history).
-     * Created and registered during the {@link #init feature initialization}.
-     */
-    private _undoCommand;
-    /**
-     * The command that manages the redo {@link module:engine/model/batch~Batch batches} stack (history).
-     * Created and registered during the {@link #init feature initialization}.
-     */
-    private _redoCommand;
-    /**
-     * Keeps track of which batches were registered in undo.
-     */
-    private _batchRegistry;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "UndoEditing";
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-}

package/dist/types/undoui.d.ts

@@ -1,34 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module undo/undoui
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-/**
- * The undo UI feature. It introduces the `'undo'` and `'redo'` buttons to the editor.
- */
-export default class UndoUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "UndoUI";
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Creates a button for the specified command.
-     *
-     * @param name Command name.
-     * @param label Button label.
-     * @param keystroke Command keystroke.
-     * @param Icon Source of the icon.
-     */
-    private _addButton;
-}