@ckeditor/ckeditor5-undo 39.0.1 → 40.0.0

package/src/undocommand.d.ts

@@ -1,37 +1,37 @@
-/**
- * @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 undo/undocommand
- */
-import BaseCommand from './basecommand';
-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];
-};
+/**
+ * @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 undo/undocommand
+ */
+import BaseCommand from './basecommand';
+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/src/undocommand.js

@@ -1,44 +1,44 @@
-/**
- * @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 undo/undocommand
- */
-import BaseCommand from './basecommand';
-/**
- * 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 = null) {
-        // If batch is not given, set `batchIndex` to the last index in command stack.
-        const batchIndex = batch ? this._stack.findIndex(a => a.batch == batch) : this._stack.length - 1;
-        const item = this._stack.splice(batchIndex, 1)[0];
-        const undoingBatch = this.editor.model.createBatch({ isUndo: true });
-        // All changes have to be done in one `enqueueChange` callback so other listeners will not
-        // step between consecutive operations, or won't do changes to the document before selection is properly restored.
-        this.editor.model.enqueueChange(undoingBatch, () => {
-            this._undo(item.batch, undoingBatch);
-            const operations = this.editor.model.document.history.getOperations(item.batch.baseVersion);
-            this._restoreSelection(item.selection.ranges, item.selection.isBackward, operations);
-        });
-        // Firing `revert` event after the change block to make sure that it includes all changes from post-fixers
-        // and make sure that the selection is "stabilized" (the selection range is saved after undo is executed and then
-        // restored on redo, so it is important that the selection range is saved after post-fixers are done).
-        this.fire('revert', item.batch, undoingBatch);
-        this.refresh();
-    }
-}
+/**
+ * @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 undo/undocommand
+ */
+import BaseCommand from './basecommand';
+/**
+ * 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 = null) {
+        // If batch is not given, set `batchIndex` to the last index in command stack.
+        const batchIndex = batch ? this._stack.findIndex(a => a.batch == batch) : this._stack.length - 1;
+        const item = this._stack.splice(batchIndex, 1)[0];
+        const undoingBatch = this.editor.model.createBatch({ isUndo: true });
+        // All changes have to be done in one `enqueueChange` callback so other listeners will not
+        // step between consecutive operations, or won't do changes to the document before selection is properly restored.
+        this.editor.model.enqueueChange(undoingBatch, () => {
+            this._undo(item.batch, undoingBatch);
+            const operations = this.editor.model.document.history.getOperations(item.batch.baseVersion);
+            this._restoreSelection(item.selection.ranges, item.selection.isBackward, operations);
+        });
+        // Firing `revert` event after the change block to make sure that it includes all changes from post-fixers
+        // and make sure that the selection is "stabilized" (the selection range is saved after undo is executed and then
+        // restored on redo, so it is important that the selection range is saved after post-fixers are done).
+        this.fire('revert', item.batch, undoingBatch);
+        this.refresh();
+    }
+}

package/src/undoediting.d.ts

@@ -1,37 +1,37 @@
-/**
- * @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 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;
-}
+/**
+ * @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 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/src/undoediting.js

@@ -1,82 +1,82 @@
-/**
- * @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 undo/undoediting
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import UndoCommand from './undocommand';
-import RedoCommand from './redocommand';
-/**
- * The undo engine feature.
- *
- * It introduces the `'undo'` and `'redo'` commands to the editor.
- */
-export default class UndoEditing extends Plugin {
-    constructor() {
-        super(...arguments);
-        /**
-         * Keeps track of which batches were registered in undo.
-         */
-        this._batchRegistry = new WeakSet();
-    }
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'UndoEditing';
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        // Create commands.
-        this._undoCommand = new UndoCommand(editor);
-        this._redoCommand = new RedoCommand(editor);
-        // Register command to the editor.
-        editor.commands.add('undo', this._undoCommand);
-        editor.commands.add('redo', this._redoCommand);
-        this.listenTo(editor.model, 'applyOperation', (evt, args) => {
-            const operation = args[0];
-            // Do not register batch if the operation is not a document operation.
-            // This prevents from creating empty undo steps, where all operations where non-document operations.
-            // Non-document operations creates and alters content in detached tree fragments (for example, document fragments).
-            // Most of time this is preparing data before it is inserted into actual tree (for example during copy & paste).
-            // Such operations should not be reversed.
-            if (!operation.isDocumentOperation) {
-                return;
-            }
-            const batch = operation.batch;
-            const isRedoBatch = this._redoCommand.createdBatches.has(batch);
-            const isUndoBatch = this._undoCommand.createdBatches.has(batch);
-            const wasProcessed = this._batchRegistry.has(batch);
-            // Skip the batch if it was already processed.
-            if (wasProcessed) {
-                return;
-            }
-            // Add the batch to the registry so it will not be processed again.
-            this._batchRegistry.add(batch);
-            if (!batch.isUndoable) {
-                return;
-            }
-            if (isRedoBatch) {
-                // If this batch comes from `redoCommand`, add it to the `undoCommand` stack.
-                this._undoCommand.addBatch(batch);
-            }
-            else if (!isUndoBatch) {
-                // If the batch comes neither  from `redoCommand` nor from `undoCommand` then it is a new, regular batch.
-                // Add the batch to the `undoCommand` stack and clear the `redoCommand` stack.
-                this._undoCommand.addBatch(batch);
-                this._redoCommand.clearStack();
-            }
-        }, { priority: 'highest' });
-        this.listenTo(this._undoCommand, 'revert', (evt, undoneBatch, undoingBatch) => {
-            this._redoCommand.addBatch(undoingBatch);
-        });
-        editor.keystrokes.set('CTRL+Z', 'undo');
-        editor.keystrokes.set('CTRL+Y', 'redo');
-        editor.keystrokes.set('CTRL+SHIFT+Z', 'redo');
-    }
-}
+/**
+ * @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 undo/undoediting
+ */
+import { Plugin } from '@ckeditor/ckeditor5-core';
+import UndoCommand from './undocommand';
+import RedoCommand from './redocommand';
+/**
+ * The undo engine feature.
+ *
+ * It introduces the `'undo'` and `'redo'` commands to the editor.
+ */
+export default class UndoEditing extends Plugin {
+    constructor() {
+        super(...arguments);
+        /**
+         * Keeps track of which batches were registered in undo.
+         */
+        this._batchRegistry = new WeakSet();
+    }
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'UndoEditing';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        // Create commands.
+        this._undoCommand = new UndoCommand(editor);
+        this._redoCommand = new RedoCommand(editor);
+        // Register command to the editor.
+        editor.commands.add('undo', this._undoCommand);
+        editor.commands.add('redo', this._redoCommand);
+        this.listenTo(editor.model, 'applyOperation', (evt, args) => {
+            const operation = args[0];
+            // Do not register batch if the operation is not a document operation.
+            // This prevents from creating empty undo steps, where all operations where non-document operations.
+            // Non-document operations creates and alters content in detached tree fragments (for example, document fragments).
+            // Most of time this is preparing data before it is inserted into actual tree (for example during copy & paste).
+            // Such operations should not be reversed.
+            if (!operation.isDocumentOperation) {
+                return;
+            }
+            const batch = operation.batch;
+            const isRedoBatch = this._redoCommand.createdBatches.has(batch);
+            const isUndoBatch = this._undoCommand.createdBatches.has(batch);
+            const wasProcessed = this._batchRegistry.has(batch);
+            // Skip the batch if it was already processed.
+            if (wasProcessed) {
+                return;
+            }
+            // Add the batch to the registry so it will not be processed again.
+            this._batchRegistry.add(batch);
+            if (!batch.isUndoable) {
+                return;
+            }
+            if (isRedoBatch) {
+                // If this batch comes from `redoCommand`, add it to the `undoCommand` stack.
+                this._undoCommand.addBatch(batch);
+            }
+            else if (!isUndoBatch) {
+                // If the batch comes neither  from `redoCommand` nor from `undoCommand` then it is a new, regular batch.
+                // Add the batch to the `undoCommand` stack and clear the `redoCommand` stack.
+                this._undoCommand.addBatch(batch);
+                this._redoCommand.clearStack();
+            }
+        }, { priority: 'highest' });
+        this.listenTo(this._undoCommand, 'revert', (evt, undoneBatch, undoingBatch) => {
+            this._redoCommand.addBatch(undoingBatch);
+        });
+        editor.keystrokes.set('CTRL+Z', 'undo');
+        editor.keystrokes.set('CTRL+Y', 'redo');
+        editor.keystrokes.set('CTRL+SHIFT+Z', 'redo');
+    }
+}

package/src/undoui.d.ts

@@ -1,30 +1,30 @@
-/**
- * @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 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;
-}
+/**
+ * @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 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;
+}

package/src/undoui.js

@@ -1,61 +1,61 @@
-/**
- * @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 undo/undoui
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import { ButtonView } from '@ckeditor/ckeditor5-ui';
-import undoIcon from '../theme/icons/undo.svg';
-import redoIcon from '../theme/icons/redo.svg';
-/**
- * The undo UI feature. It introduces the `'undo'` and `'redo'` buttons to the editor.
- */
-export default class UndoUI extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'UndoUI';
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        const locale = editor.locale;
-        const t = editor.t;
-        const localizedUndoIcon = locale.uiLanguageDirection == 'ltr' ? undoIcon : redoIcon;
-        const localizedRedoIcon = locale.uiLanguageDirection == 'ltr' ? redoIcon : undoIcon;
-        this._addButton('undo', t('Undo'), 'CTRL+Z', localizedUndoIcon);
-        this._addButton('redo', t('Redo'), 'CTRL+Y', localizedRedoIcon);
-    }
-    /**
-     * 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.
-     */
-    _addButton(name, label, keystroke, Icon) {
-        const editor = this.editor;
-        editor.ui.componentFactory.add(name, locale => {
-            const command = editor.commands.get(name);
-            const view = new ButtonView(locale);
-            view.set({
-                label,
-                icon: Icon,
-                keystroke,
-                tooltip: true
-            });
-            view.bind('isEnabled').to(command, 'isEnabled');
-            this.listenTo(view, 'execute', () => {
-                editor.execute(name);
-                editor.editing.view.focus();
-            });
-            return view;
-        });
-    }
-}
+/**
+ * @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 undo/undoui
+ */
+import { Plugin } from '@ckeditor/ckeditor5-core';
+import { ButtonView } from '@ckeditor/ckeditor5-ui';
+import undoIcon from '../theme/icons/undo.svg';
+import redoIcon from '../theme/icons/redo.svg';
+/**
+ * The undo UI feature. It introduces the `'undo'` and `'redo'` buttons to the editor.
+ */
+export default class UndoUI extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'UndoUI';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const locale = editor.locale;
+        const t = editor.t;
+        const localizedUndoIcon = locale.uiLanguageDirection == 'ltr' ? undoIcon : redoIcon;
+        const localizedRedoIcon = locale.uiLanguageDirection == 'ltr' ? redoIcon : undoIcon;
+        this._addButton('undo', t('Undo'), 'CTRL+Z', localizedUndoIcon);
+        this._addButton('redo', t('Redo'), 'CTRL+Y', localizedRedoIcon);
+    }
+    /**
+     * 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.
+     */
+    _addButton(name, label, keystroke, Icon) {
+        const editor = this.editor;
+        editor.ui.componentFactory.add(name, locale => {
+            const command = editor.commands.get(name);
+            const view = new ButtonView(locale);
+            view.set({
+                label,
+                icon: Icon,
+                keystroke,
+                tooltip: true
+            });
+            view.bind('isEnabled').to(command, 'isEnabled');
+            this.listenTo(view, 'execute', () => {
+                editor.execute(name);
+                editor.editing.view.focus();
+            });
+            return view;
+        });
+    }
+}