@ckeditor/ckeditor5-undo 0.0.0-internal-20241017.0 → 0.0.0-internal-20241206.0

package/LICENSE.md

@@ -1,10 +1,15 @@
 Software License Agreement
 ==========================
 
-**CKEditor&nbsp;5 undo feature** – https://github.com/ckeditor/ckeditor5-undo <br>
+**CKEditor&nbsp;5 Undo feature** (https://github.com/ckeditor/ckeditor5)<br>
 Copyright (c) 2003–2024, [CKSource Holding sp. z o.o.](https://cksource.com) All rights reserved.
 
-Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html).
+Licensed under a dual-license model, this software is available under:
+
+* the [GNU General Public License Version 2 or later](https://www.gnu.org/licenses/gpl.html),
+* or commercial license terms from CKSource Holding sp. z o.o.
+
+For more information, see: [https://ckeditor.com/legal/ckeditor-licensing-options](https://ckeditor.com/legal/ckeditor-licensing-options).
 
 Sources of Intellectual Property Included in CKEditor
 -----------------------------------------------------

package/README.md

@@ -3,20 +3,35 @@ CKEditor 5 undo feature
 
 [![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-undo.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-undo)
 [![Coverage Status](https://coveralls.io/repos/github/ckeditor/ckeditor5/badge.svg?branch=master)](https://coveralls.io/github/ckeditor/ckeditor5?branch=master)
-[![Build Status](https://travis-ci.com/ckeditor/ckeditor5.svg?branch=master)](https://app.travis-ci.com/github/ckeditor/ckeditor5)
+[![CircleCI](https://circleci.com/gh/ckeditor/ckeditor5.svg?style=shield)](https://app.circleci.com/pipelines/github/ckeditor/ckeditor5?branch=master)
 
 This package implements undo support for CKEditor 5.
 
-## Documentation
-
-See the [`@ckeditor/ckeditor5-undo` package](https://ckeditor.com/docs/ckeditor5/latest/api/undo.html) page in [CKEditor 5 documentation](https://ckeditor.com/docs/ckeditor5/latest/).
-
 ## Installation
 
+This plugin is part of the `ckeditor5` package. Install the whole package to use it.
+
 ```bash
 npm install ckeditor5
 ```
 
+## Create free account
+
+If you want to check full CKEditor 5 capabilities, sign up for a [free non-commitment 14-day trial](https://portal.ckeditor.com/checkout?plan=free).
+
+## Demo
+
+Check out the demo in the [undo/redo feature guide](https://ckeditor.com/docs/ckeditor5/latest/features/undo-redo.html#demo).
+
+## Documentation
+
+See the [`@ckeditor/ckeditor5-undo` package](https://ckeditor.com/docs/ckeditor5/latest/api/undo.html) page in [CKEditor 5 documentation](https://ckeditor.com/docs/ckeditor5/latest/).
+
 ## License
 
-Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html). For full details about the license, please check the `LICENSE.md` file or [https://ckeditor.com/legal/ckeditor-oss-license](https://ckeditor.com/legal/ckeditor-oss-license).
+Licensed under a dual-license model, this software is available under:
+
+* the [GNU General Public License Version 2 or later](https://www.gnu.org/licenses/gpl.html),
+* or commercial license terms from CKSource Holding sp. z o.o.
+
+For more information, see: [https://ckeditor.com/legal/ckeditor-licensing-options](https://ckeditor.com/legal/ckeditor-licensing-options).

package/dist/index.js

@@ -10,20 +10,20 @@ import { ButtonView, MenuBarMenuListItemButtonView } from '@ckeditor/ckeditor5-u
  * Base class for the undo feature commands: {@link module:undo/undocommand~UndoCommand} and {@link module:undo/redocommand~RedoCommand}.
  */ 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.
-	 */ _stack = [];
-    /**
-	 * Stores all batches that were created by this command.
-	 *
-	 * @internal
-	 */ _createdBatches = new WeakSet();
-    /**
-	 * @inheritDoc
-	 */ constructor(editor){
+     * @inheritDoc
+     */ constructor(editor){
         super(editor);
+        /**
+         * 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.
+         */ this._stack = [];
+        /**
+         * Stores all batches that were created by this command.
+         *
+         * @internal
+         */ this._createdBatches = new WeakSet();
         // Refresh state, so the command is inactive right after initialization.
         this.refresh();
         // This command should not depend on selection change.
@@ -57,21 +57,21 @@ import { ButtonView, MenuBarMenuListItemButtonView } from '@ckeditor/ckeditor5-u
         });
     }
     /**
-	 * @inheritDoc
-	 */ refresh() {
+     * @inheritDoc
+     */ refresh() {
         this.isEnabled = this._stack.length > 0;
     }
     /**
-	 * Returns all batches created by this command.
-	 */ get createdBatches() {
+     * Returns all batches created by this command.
+     */ get createdBatches() {
         return this._createdBatches;
     }
     /**
-	 * 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) {
+     * 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) {
         const docSelection = this.editor.model.document.selection;
         const selection = {
             ranges: docSelection.hasOwnRange ? Array.from(docSelection.getRanges()) : [],
@@ -84,18 +84,18 @@ import { ButtonView, MenuBarMenuListItemButtonView } from '@ckeditor/ckeditor5-u
         this.refresh();
     }
     /**
-	 * Removes all items from the stack.
-	 */ clearStack() {
+     * Removes all items from the stack.
+     */ clearStack() {
         this._stack = [];
         this.refresh();
     }
     /**
-	 * 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.
-	 */ _restoreSelection(ranges, isBackward, operations) {
+     * 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.
+     */ _restoreSelection(ranges, isBackward, operations) {
         const model = this.editor.model;
         const document = model.document;
         // This will keep the transformed selection ranges.
@@ -129,12 +129,12 @@ import { ButtonView, MenuBarMenuListItemButtonView } from '@ckeditor/ckeditor5-u
         }
     }
     /**
-	 * 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.
-	 */ _undo(batchToUndo, undoingBatch) {
+     * 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.
+     */ _undo(batchToUndo, undoingBatch) {
         const model = this.editor.model;
         const document = model.document;
         // All changes done by the command execution will be saved as one batch.
@@ -198,14 +198,14 @@ function isRangeContainedByAnyOtherRange(range, ranges) {
  * The undo command also takes care of restoring the {@link module:engine/model/document~Document#selection document selection}.
  */ 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) {
+     * 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];
@@ -236,13 +236,13 @@ function isRangeContainedByAnyOtherRange(range, ranges) {
  * The redo command also takes care of restoring the {@link module:engine/model/document~Document#selection document selection}.
  */ 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() {
+     * 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() {
         const item = this._stack.pop();
         const redoingBatch = this.editor.model.createBatch({
             isUndo: true
@@ -265,30 +265,25 @@ function isRangeContainedByAnyOtherRange(range, ranges) {
  *
  * It introduces the `'undo'` and `'redo'` commands to the editor.
  */ class UndoEditing extends Plugin {
+    constructor(){
+        super(...arguments);
+        /**
+         * Keeps track of which batches were registered in undo.
+         */ this._batchRegistry = new WeakSet();
+    }
     /**
-	 * The command that manages the undo {@link module:engine/model/batch~Batch batches} stack (history).
-	 * Created and registered during the {@link #init feature initialization}.
-	 */ _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}.
-	 */ _redoCommand;
-    /**
-	 * Keeps track of which batches were registered in undo.
-	 */ _batchRegistry = new WeakSet();
-    /**
-	 * @inheritDoc
-	 */ static get pluginName() {
+     * @inheritDoc
+     */ static get pluginName() {
         return 'UndoEditing';
     }
     /**
-	 * @inheritDoc
-	 */ static get isOfficialPlugin() {
+     * @inheritDoc
+     */ static get isOfficialPlugin() {
         return true;
     }
     /**
-	 * @inheritDoc
-	 */ init() {
+     * @inheritDoc
+     */ init() {
         const editor = this.editor;
         const t = editor.t;
         // Create commands.
@@ -365,18 +360,18 @@ function isRangeContainedByAnyOtherRange(range, ranges) {
  * The undo UI feature. It introduces the `'undo'` and `'redo'` buttons to the editor.
  */ class UndoUI extends Plugin {
     /**
-	 * @inheritDoc
-	 */ static get pluginName() {
+     * @inheritDoc
+     */ static get pluginName() {
         return 'UndoUI';
     }
     /**
-	 * @inheritDoc
-	 */ static get isOfficialPlugin() {
+     * @inheritDoc
+     */ static get isOfficialPlugin() {
         return true;
     }
     /**
-	 * @inheritDoc
-	 */ init() {
+     * @inheritDoc
+     */ init() {
         const editor = this.editor;
         const locale = editor.locale;
         const t = editor.t;
@@ -386,13 +381,13 @@ function isRangeContainedByAnyOtherRange(range, ranges) {
         this._addButtonsToFactory('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.
-	 */ _addButtonsToFactory(name, label, keystroke, Icon) {
+     * 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.
+     */ _addButtonsToFactory(name, label, keystroke, Icon) {
         const editor = this.editor;
         editor.ui.componentFactory.add(name, ()=>{
             const buttonView = this._createButton(ButtonView, name, label, keystroke, Icon);
@@ -406,8 +401,8 @@ function isRangeContainedByAnyOtherRange(range, ranges) {
         });
     }
     /**
-	 * TODO
-	 */ _createButton(ButtonClass, name, label, keystroke, Icon) {
+     * TODO
+     */ _createButton(ButtonClass, name, label, keystroke, Icon) {
         const editor = this.editor;
         const locale = editor.locale;
         const command = editor.commands.get(name);
@@ -524,21 +519,21 @@ function isRangeContainedByAnyOtherRange(range, ranges) {
  * ```
  */ class Undo extends Plugin {
     /**
-	 * @inheritDoc
-	 */ static get requires() {
+     * @inheritDoc
+     */ static get requires() {
         return [
             UndoEditing,
             UndoUI
         ];
     }
     /**
-	 * @inheritDoc
-	 */ static get pluginName() {
+     * @inheritDoc
+     */ static get pluginName() {
         return 'Undo';
     }
     /**
-	 * @inheritDoc
-	 */ static get isOfficialPlugin() {
+     * @inheritDoc
+     */ static get isOfficialPlugin() {
         return true;
     }
 }