@ckeditor/ckeditor5-typing 40.0.0 → 40.1.0

package/LICENSE.md

@@ -2,7 +2,7 @@ Software License Agreement
 ==========================
 
 **CKEditor&nbsp;5 typing feature** – https://github.com/ckeditor/ckeditor5-typing <br>
-Copyright (c) 2003-2023, [CKSource Holding sp. z o.o.](https://cksource.com) All rights reserved.
+Copyright (c) 2003–2023, [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).
 
@@ -13,9 +13,9 @@ Where not otherwise indicated, all CKEditor content is authored by CKSource engi
 
 The following libraries are included in CKEditor under the [MIT license](https://opensource.org/licenses/MIT):
 
-* lodash - Copyright (c) JS Foundation and other contributors https://js.foundation/. Based on Underscore.js, copyright Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors http://underscorejs.org/.
+* Lodash - Copyright (c) JS Foundation and other contributors https://js.foundation/. Based on Underscore.js, copyright Jeremy Ashkenas, DocumentCloud and Investigative Reporters & Editors http://underscorejs.org/.
 
 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.
+**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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-typing",
-  "version": "40.0.0",
+  "version": "40.1.0",
   "description": "Typing feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -12,9 +12,9 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-core": "40.0.0",
-    "@ckeditor/ckeditor5-engine": "40.0.0",
-    "@ckeditor/ckeditor5-utils": "40.0.0",
+    "@ckeditor/ckeditor5-core": "40.1.0",
+    "@ckeditor/ckeditor5-engine": "40.1.0",
+    "@ckeditor/ckeditor5-utils": "40.1.0",
     "lodash-es": "4.17.21"
   },
   "author": "CKSource (http://cksource.com/)",

package/src/augmentation.d.ts

@@ -1,27 +1,27 @@
-/**
- * @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
- */
-import type { Delete, DeleteCommand, Input, InsertTextCommand, TextTransformation, TwoStepCaretMovement, Typing, TypingConfig } from './index';
-declare module '@ckeditor/ckeditor5-core' {
-    interface EditorConfig {
-        /**
-         * The configuration of the typing features. Used by the features from the `@ckeditor/ckeditor5-typing` package.
-         *
-         * Read more in {@link module:typing/typingconfig~TypingConfig}.
-         */
-        typing?: TypingConfig;
-    }
-    interface CommandsMap {
-        deleteForward: DeleteCommand;
-        delete: DeleteCommand;
-        insertText: InsertTextCommand;
-    }
-    interface PluginsMap {
-        [Delete.pluginName]: Delete;
-        [Input.pluginName]: Input;
-        [TextTransformation.pluginName]: TextTransformation;
-        [TwoStepCaretMovement.pluginName]: TwoStepCaretMovement;
-        [Typing.pluginName]: Typing;
-    }
-}
+/**
+ * @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
+ */
+import type { Delete, DeleteCommand, Input, InsertTextCommand, TextTransformation, TwoStepCaretMovement, Typing, TypingConfig } from './index';
+declare module '@ckeditor/ckeditor5-core' {
+    interface EditorConfig {
+        /**
+         * The configuration of the typing features. Used by the features from the `@ckeditor/ckeditor5-typing` package.
+         *
+         * Read more in {@link module:typing/typingconfig~TypingConfig}.
+         */
+        typing?: TypingConfig;
+    }
+    interface CommandsMap {
+        deleteForward: DeleteCommand;
+        delete: DeleteCommand;
+        insertText: InsertTextCommand;
+    }
+    interface PluginsMap {
+        [Delete.pluginName]: Delete;
+        [Input.pluginName]: Input;
+        [TextTransformation.pluginName]: TextTransformation;
+        [TwoStepCaretMovement.pluginName]: TwoStepCaretMovement;
+        [Typing.pluginName]: Typing;
+    }
+}

package/src/augmentation.js

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

package/src/delete.d.ts

@@ -1,32 +1,32 @@
-/**
- * @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 typing/delete
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-/**
- * The delete and backspace feature. Handles keys such as <kbd>Delete</kbd> and <kbd>Backspace</kbd>, other
- * keystrokes and user actions that result in deleting content in the editor.
- */
-export default class Delete extends Plugin {
-    /**
-     * Whether pressing backspace should trigger undo action
-     */
-    private _undoOnBackspace;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "Delete";
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * If the next user action after calling this method is pressing backspace, it would undo the last change.
-     *
-     * Requires {@link module:undo/undoediting~UndoEditing} plugin. If not loaded, does nothing.
-     */
-    requestUndoOnBackspace(): 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 typing/delete
+ */
+import { Plugin } from '@ckeditor/ckeditor5-core';
+/**
+ * The delete and backspace feature. Handles keys such as <kbd>Delete</kbd> and <kbd>Backspace</kbd>, other
+ * keystrokes and user actions that result in deleting content in the editor.
+ */
+export default class Delete extends Plugin {
+    /**
+     * Whether pressing backspace should trigger undo action
+     */
+    private _undoOnBackspace;
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): "Delete";
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * If the next user action after calling this method is pressing backspace, it would undo the last change.
+     *
+     * Requires {@link module:undo/undoediting~UndoEditing} plugin. If not loaded, does nothing.
+     */
+    requestUndoOnBackspace(): void;
+}

package/src/delete.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 typing/delete
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
-import DeleteCommand from './deletecommand';
-import DeleteObserver from './deleteobserver';
-/**
- * The delete and backspace feature. Handles keys such as <kbd>Delete</kbd> and <kbd>Backspace</kbd>, other
- * keystrokes and user actions that result in deleting content in the editor.
- */
-export default class Delete extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'Delete';
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        const view = editor.editing.view;
-        const viewDocument = view.document;
-        const modelDocument = editor.model.document;
-        view.addObserver(DeleteObserver);
-        this._undoOnBackspace = false;
-        const deleteForwardCommand = new DeleteCommand(editor, 'forward');
-        // Register `deleteForward` command and add `forwardDelete` command as an alias for backward compatibility.
-        editor.commands.add('deleteForward', deleteForwardCommand);
-        editor.commands.add('forwardDelete', deleteForwardCommand);
-        editor.commands.add('delete', new DeleteCommand(editor, 'backward'));
-        this.listenTo(viewDocument, 'delete', (evt, data) => {
-            // When not in composition, we handle the action, so prevent the default one.
-            // When in composition, it's the browser who modify the DOM (renderer is disabled).
-            if (!viewDocument.isComposing) {
-                data.preventDefault();
-            }
-            const { direction, sequence, selectionToRemove, unit } = data;
-            const commandName = direction === 'forward' ? 'deleteForward' : 'delete';
-            const commandData = { sequence };
-            if (unit == 'selection') {
-                const modelRanges = Array.from(selectionToRemove.getRanges()).map(viewRange => {
-                    return editor.editing.mapper.toModelRange(viewRange);
-                });
-                commandData.selection = editor.model.createSelection(modelRanges);
-            }
-            else {
-                commandData.unit = unit;
-            }
-            editor.execute(commandName, commandData);
-            view.scrollToTheSelection();
-        }, { priority: 'low' });
-        if (this.editor.plugins.has('UndoEditing')) {
-            this.listenTo(viewDocument, 'delete', (evt, data) => {
-                if (this._undoOnBackspace && data.direction == 'backward' && data.sequence == 1 && data.unit == 'codePoint') {
-                    this._undoOnBackspace = false;
-                    editor.execute('undo');
-                    data.preventDefault();
-                    evt.stop();
-                }
-            }, { context: '$capture' });
-            this.listenTo(modelDocument, 'change', () => {
-                this._undoOnBackspace = false;
-            });
-        }
-    }
-    /**
-     * If the next user action after calling this method is pressing backspace, it would undo the last change.
-     *
-     * Requires {@link module:undo/undoediting~UndoEditing} plugin. If not loaded, does nothing.
-     */
-    requestUndoOnBackspace() {
-        if (this.editor.plugins.has('UndoEditing')) {
-            this._undoOnBackspace = true;
-        }
-    }
-}
+/**
+ * @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 typing/delete
+ */
+import { Plugin } from '@ckeditor/ckeditor5-core';
+import DeleteCommand from './deletecommand';
+import DeleteObserver from './deleteobserver';
+/**
+ * The delete and backspace feature. Handles keys such as <kbd>Delete</kbd> and <kbd>Backspace</kbd>, other
+ * keystrokes and user actions that result in deleting content in the editor.
+ */
+export default class Delete extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'Delete';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const view = editor.editing.view;
+        const viewDocument = view.document;
+        const modelDocument = editor.model.document;
+        view.addObserver(DeleteObserver);
+        this._undoOnBackspace = false;
+        const deleteForwardCommand = new DeleteCommand(editor, 'forward');
+        // Register `deleteForward` command and add `forwardDelete` command as an alias for backward compatibility.
+        editor.commands.add('deleteForward', deleteForwardCommand);
+        editor.commands.add('forwardDelete', deleteForwardCommand);
+        editor.commands.add('delete', new DeleteCommand(editor, 'backward'));
+        this.listenTo(viewDocument, 'delete', (evt, data) => {
+            // When not in composition, we handle the action, so prevent the default one.
+            // When in composition, it's the browser who modify the DOM (renderer is disabled).
+            if (!viewDocument.isComposing) {
+                data.preventDefault();
+            }
+            const { direction, sequence, selectionToRemove, unit } = data;
+            const commandName = direction === 'forward' ? 'deleteForward' : 'delete';
+            const commandData = { sequence };
+            if (unit == 'selection') {
+                const modelRanges = Array.from(selectionToRemove.getRanges()).map(viewRange => {
+                    return editor.editing.mapper.toModelRange(viewRange);
+                });
+                commandData.selection = editor.model.createSelection(modelRanges);
+            }
+            else {
+                commandData.unit = unit;
+            }
+            editor.execute(commandName, commandData);
+            view.scrollToTheSelection();
+        }, { priority: 'low' });
+        if (this.editor.plugins.has('UndoEditing')) {
+            this.listenTo(viewDocument, 'delete', (evt, data) => {
+                if (this._undoOnBackspace && data.direction == 'backward' && data.sequence == 1 && data.unit == 'codePoint') {
+                    this._undoOnBackspace = false;
+                    editor.execute('undo');
+                    data.preventDefault();
+                    evt.stop();
+                }
+            }, { context: '$capture' });
+            this.listenTo(modelDocument, 'change', () => {
+                this._undoOnBackspace = false;
+            });
+        }
+    }
+    /**
+     * If the next user action after calling this method is pressing backspace, it would undo the last change.
+     *
+     * Requires {@link module:undo/undoediting~UndoEditing} plugin. If not loaded, does nothing.
+     */
+    requestUndoOnBackspace() {
+        if (this.editor.plugins.has('UndoEditing')) {
+            this._undoOnBackspace = true;
+        }
+    }
+}

package/src/deletecommand.d.ts

@@ -1,83 +1,83 @@
-/**
- * @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 typing/deletecommand
- */
-import { Command, type Editor } from '@ckeditor/ckeditor5-core';
-import type { DocumentSelection, Selection } from '@ckeditor/ckeditor5-engine';
-import ChangeBuffer from './utils/changebuffer';
-/**
- * The delete command. Used by the {@link module:typing/delete~Delete delete feature} to handle the <kbd>Delete</kbd> and
- * <kbd>Backspace</kbd> keys.
- */
-export default class DeleteCommand extends Command {
-    /**
-     * The directionality of the delete describing in what direction it should
-     * consume the content when the selection is collapsed.
-     */
-    readonly direction: 'forward' | 'backward';
-    /**
-     * Delete's change buffer used to group subsequent changes into batches.
-     */
-    private readonly _buffer;
-    /**
-     * Creates an instance of the command.
-     *
-     * @param direction The directionality of the delete describing in what direction it
-     * should consume the content when the selection is collapsed.
-     */
-    constructor(editor: Editor, direction: 'forward' | 'backward');
-    /**
-     * The current change buffer.
-     */
-    get buffer(): ChangeBuffer;
-    /**
-     * Executes the delete command. Depending on whether the selection is collapsed or not, deletes its content
-     * or a piece of content in the {@link #direction defined direction}.
-     *
-     * @fires execute
-     * @param options The command options.
-     * @param options.unit See {@link module:engine/model/utils/modifyselection~modifySelection}'s options.
-     * @param options.sequence A number describing which subsequent delete event it is without the key being released.
-     * See the {@link module:engine/view/document~Document#event:delete} event data.
-     * @param options.selection Selection to remove. If not set, current model selection will be used.
-     */
-    execute(options?: {
-        unit?: 'character' | 'codePoint' | 'word';
-        sequence?: number;
-        selection?: Selection | DocumentSelection;
-    }): void;
-    /**
-     * If the user keeps <kbd>Backspace</kbd> or <kbd>Delete</kbd> key pressed, the content of the current
-     * editable will be cleared. However, this will not yet lead to resetting the remaining block to a paragraph
-     * (which happens e.g. when the user does <kbd>Ctrl</kbd> + <kbd>A</kbd>, <kbd>Backspace</kbd>).
-     *
-     * But, if the user pressed the key in an empty editable for the first time,
-     * we want to replace the entire content with a paragraph if:
-     *
-     * * the current limit element is empty,
-     * * the paragraph is allowed in the limit element,
-     * * the limit doesn't already have a paragraph inside.
-     *
-     * See https://github.com/ckeditor/ckeditor5-typing/issues/61.
-     *
-     * @param sequence A number describing which subsequent delete event it is without the key being released.
-     */
-    private _shouldEntireContentBeReplacedWithParagraph;
-    /**
-     * The entire content is replaced with the paragraph. Selection is moved inside the paragraph.
-     *
-     * @param writer The model writer.
-     */
-    private _replaceEntireContentWithParagraph;
-    /**
-     * Checks if the selection is inside an empty element that is the first child of the limit element
-     * and should be replaced with a paragraph.
-     *
-     * @param selection The selection.
-     * @param sequence A number describing which subsequent delete event it is without the key being released.
-     */
-    private _shouldReplaceFirstBlockWithParagraph;
-}
+/**
+ * @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 typing/deletecommand
+ */
+import { Command, type Editor } from '@ckeditor/ckeditor5-core';
+import type { DocumentSelection, Selection } from '@ckeditor/ckeditor5-engine';
+import ChangeBuffer from './utils/changebuffer';
+/**
+ * The delete command. Used by the {@link module:typing/delete~Delete delete feature} to handle the <kbd>Delete</kbd> and
+ * <kbd>Backspace</kbd> keys.
+ */
+export default class DeleteCommand extends Command {
+    /**
+     * The directionality of the delete describing in what direction it should
+     * consume the content when the selection is collapsed.
+     */
+    readonly direction: 'forward' | 'backward';
+    /**
+     * Delete's change buffer used to group subsequent changes into batches.
+     */
+    private readonly _buffer;
+    /**
+     * Creates an instance of the command.
+     *
+     * @param direction The directionality of the delete describing in what direction it
+     * should consume the content when the selection is collapsed.
+     */
+    constructor(editor: Editor, direction: 'forward' | 'backward');
+    /**
+     * The current change buffer.
+     */
+    get buffer(): ChangeBuffer;
+    /**
+     * Executes the delete command. Depending on whether the selection is collapsed or not, deletes its content
+     * or a piece of content in the {@link #direction defined direction}.
+     *
+     * @fires execute
+     * @param options The command options.
+     * @param options.unit See {@link module:engine/model/utils/modifyselection~modifySelection}'s options.
+     * @param options.sequence A number describing which subsequent delete event it is without the key being released.
+     * See the {@link module:engine/view/document~Document#event:delete} event data.
+     * @param options.selection Selection to remove. If not set, current model selection will be used.
+     */
+    execute(options?: {
+        unit?: 'character' | 'codePoint' | 'word';
+        sequence?: number;
+        selection?: Selection | DocumentSelection;
+    }): void;
+    /**
+     * If the user keeps <kbd>Backspace</kbd> or <kbd>Delete</kbd> key pressed, the content of the current
+     * editable will be cleared. However, this will not yet lead to resetting the remaining block to a paragraph
+     * (which happens e.g. when the user does <kbd>Ctrl</kbd> + <kbd>A</kbd>, <kbd>Backspace</kbd>).
+     *
+     * But, if the user pressed the key in an empty editable for the first time,
+     * we want to replace the entire content with a paragraph if:
+     *
+     * * the current limit element is empty,
+     * * the paragraph is allowed in the limit element,
+     * * the limit doesn't already have a paragraph inside.
+     *
+     * See https://github.com/ckeditor/ckeditor5-typing/issues/61.
+     *
+     * @param sequence A number describing which subsequent delete event it is without the key being released.
+     */
+    private _shouldEntireContentBeReplacedWithParagraph;
+    /**
+     * The entire content is replaced with the paragraph. Selection is moved inside the paragraph.
+     *
+     * @param writer The model writer.
+     */
+    private _replaceEntireContentWithParagraph;
+    /**
+     * Checks if the selection is inside an empty element that is the first child of the limit element
+     * and should be replaced with a paragraph.
+     *
+     * @param selection The selection.
+     * @param sequence A number describing which subsequent delete event it is without the key being released.
+     */
+    private _shouldReplaceFirstBlockWithParagraph;
+}