@ckeditor/ckeditor5-undo 0.0.0-internal-20241017.0

package/CHANGELOG.md

@@ -0,0 +1,4 @@
+Changelog
+=========
+
+All changes in the package are documented in https://github.com/ckeditor/ckeditor5/blob/master/CHANGELOG.md.

package/LICENSE.md

@@ -0,0 +1,17 @@
+Software License Agreement
+==========================
+
+**CKEditor&nbsp;5 undo feature** – https://github.com/ckeditor/ckeditor5-undo <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).
+
+Sources of Intellectual Property Included in CKEditor
+-----------------------------------------------------
+
+Where not otherwise indicated, all CKEditor content is authored by CKSource engineers and consists of CKSource-owned intellectual property. In some specific instances, CKEditor will incorporate work done by developers outside of CKSource with their express permission.
+
+Trademarks
+----------
+
+**CKEditor** is a trademark of [CKSource Holding sp. z o.o.](https://cksource.com) All other brand and product names are trademarks, registered trademarks, or service marks of their respective holders.

package/README.md

@@ -0,0 +1,22 @@
+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)
+
+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
+
+```bash
+npm install ckeditor5
+```
+
+## 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).

package/ckeditor5-metadata.json

@@ -0,0 +1,23 @@
+{
+	"plugins": [
+		{
+			"name": "Undo",
+			"className": "Undo",
+			"description": "Support the undo and redo functionalities.",
+			"docs": "features/undo-redo.html",
+			"path": "src/undo.js",
+			"uiComponents": [
+				{
+					"type": "Button",
+					"name": "undo",
+					"iconPath": "@ckeditor/ckeditor5-core/theme/icons/undo.svg"
+				},
+				{
+					"type": "Button",
+					"name": "redo",
+					"iconPath": "@ckeditor/ckeditor5-core/theme/icons/redo.svg"
+				}
+			]
+		}
+	]
+}

package/dist/augmentation.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @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
+ */
+import type { Undo, UndoEditing, UndoUI, UndoCommand, RedoCommand } from './index.js';
+declare module '@ckeditor/ckeditor5-core' {
+    interface CommandsMap {
+        undo: UndoCommand;
+        redo: RedoCommand;
+    }
+    interface PluginsMap {
+        [Undo.pluginName]: Undo;
+        [UndoEditing.pluginName]: UndoEditing;
+        [UndoUI.pluginName]: UndoUI;
+    }
+}

package/dist/basecommand.d.ts

@@ -0,0 +1,76 @@
+/**
+ * @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/index-content.css

@@ -0,0 +1,4 @@
+/**
+ * @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
+ */

package/dist/index-editor.css

@@ -0,0 +1,4 @@
+/**
+ * @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
+ */

package/dist/index.css

@@ -0,0 +1,4 @@
+/**
+ * @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
+ */

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @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';