@ckeditor/ckeditor5-typing 36.0.0 → 37.0.0-alpha.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-typing",
-  "version": "36.0.0",
+  "version": "37.0.0-alpha.0",
   "description": "Typing feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -12,29 +12,29 @@
   ],
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-core": "^36.0.0",
-    "@ckeditor/ckeditor5-engine": "^36.0.0",
-    "@ckeditor/ckeditor5-utils": "^36.0.0",
+    "@ckeditor/ckeditor5-core": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-engine": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-utils": "^37.0.0-alpha.0",
     "lodash-es": "^4.17.15"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-autoformat": "^36.0.0",
-    "@ckeditor/ckeditor5-basic-styles": "^36.0.0",
-    "@ckeditor/ckeditor5-block-quote": "^36.0.0",
-    "@ckeditor/ckeditor5-code-block": "^36.0.0",
-    "@ckeditor/ckeditor5-editor-classic": "^36.0.0",
-    "@ckeditor/ckeditor5-enter": "^36.0.0",
-    "@ckeditor/ckeditor5-essentials": "^36.0.0",
-    "@ckeditor/ckeditor5-heading": "^36.0.0",
-    "@ckeditor/ckeditor5-image": "^36.0.0",
-    "@ckeditor/ckeditor5-indent": "^36.0.0",
-    "@ckeditor/ckeditor5-link": "^36.0.0",
-    "@ckeditor/ckeditor5-list": "^36.0.0",
-    "@ckeditor/ckeditor5-media-embed": "^36.0.0",
-    "@ckeditor/ckeditor5-mention": "^36.0.0",
-    "@ckeditor/ckeditor5-paragraph": "^36.0.0",
-    "@ckeditor/ckeditor5-table": "^36.0.0",
-    "@ckeditor/ckeditor5-undo": "^36.0.0",
+    "@ckeditor/ckeditor5-autoformat": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-basic-styles": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-block-quote": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-code-block": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-editor-classic": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-enter": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-essentials": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-heading": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-image": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-indent": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-link": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-list": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-media-embed": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-mention": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-paragraph": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-table": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-undo": "^37.0.0-alpha.0",
     "typescript": "^4.8.4",
     "webpack": "^5.58.1",
     "webpack-cli": "^4.9.0"
@@ -63,5 +63,6 @@
   "scripts": {
     "build": "tsc -p ./tsconfig.release.json",
     "postversion": "npm run build"
-  }
+  },
+  "types": "src/index.d.ts"
 }

package/src/delete.d.ts

@@ -0,0 +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 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;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [Delete.pluginName]: Delete;
+    }
+}

package/src/delete.js

@@ -11,8 +11,6 @@ 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.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class Delete extends Plugin {
     /**

package/src/deletecommand.d.ts

@@ -0,0 +1,90 @@
+/**
+ * @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';
+import './typingconfig';
+/**
+ * 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;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface CommandsMap {
+        deleteForward: DeleteCommand;
+        delete: DeleteCommand;
+    }
+}

package/src/deletecommand.js

@@ -13,40 +13,21 @@ import './typingconfig';
 /**
  * The delete command. Used by the {@link module:typing/delete~Delete delete feature} to handle the <kbd>Delete</kbd> and
  * <kbd>Backspace</kbd> keys.
- *
- * @extends module:core/command~Command
  */
 export default class DeleteCommand extends Command {
     /**
      * Creates an instance of the command.
      *
-     * @param {module:core/editor/editor~Editor} editor
-     * @param {'forward'|'backward'} direction The directionality of the delete describing in what direction it
+     * @param direction The directionality of the delete describing in what direction it
      * should consume the content when the selection is collapsed.
      */
     constructor(editor, direction) {
         super(editor);
-        /**
-         * The directionality of the delete describing in what direction it should
-         * consume the content when the selection is collapsed.
-         *
-         * @readonly
-         * @member {'forward'|'backward'} #direction
-         */
         this.direction = direction;
-        /**
-         * Delete's change buffer used to group subsequent changes into batches.
-         *
-         * @readonly
-         * @private
-         * @type {module:typing/utils/changebuffer~ChangeBuffer}
-         */
         this._buffer = new ChangeBuffer(editor.model, editor.config.get('typing.undoStep'));
     }
     /**
      * The current change buffer.
-     *
-     * @type {module:typing/utils/changebuffer~ChangeBuffer}
      */
     get buffer() {
         return this._buffer;
@@ -56,13 +37,11 @@ export default class DeleteCommand extends Command {
      * or a piece of content in the {@link #direction defined direction}.
      *
      * @fires execute
-     * @param {Object} [options] The command options.
-     * @param {'character'|'codePoint'|'word'} [options.unit='character']
-     * See {@link module:engine/model/utils/modifyselection~modifySelection}'s options.
-     * @param {Number} [options.sequence=1] A number describing which subsequent delete event it is without the key being released.
+     * @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 {module:engine/model/selection~Selection} [options.selection] Selection to remove. If not set, current model selection
-     * will be used.
+     * @param options.selection Selection to remove. If not set, current model selection will be used.
      */
     execute(options = {}) {
         const model = this.editor.model;
@@ -104,10 +83,10 @@ export default class DeleteCommand extends Command {
             selection.getFirstRange().getMinimalFlatRanges().forEach(range => {
                 changeCount += count(range.getWalker({ singleCharacters: true, ignoreElementEnd: true, shallow: true }));
             });
-            // @if CK_DEBUG_TYPING // if ( window.logCKETyping ) {
+            // @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
             // @if CK_DEBUG_TYPING // 	console.log( '%c[DeleteCommand]%c Delete content',
             // @if CK_DEBUG_TYPING // 		'font-weight: bold; color: green;', '',
-            // @if CK_DEBUG_TYPING // 		`[${ selection.getFirstPosition().path }]-[${ selection.getLastPosition().path }]`, options
+            // @if CK_DEBUG_TYPING // 		`[${ selection.getFirstPosition()!.path }]-[${ selection.getLastPosition()!.path }]`, options
             // @if CK_DEBUG_TYPING // 	);
             // @if CK_DEBUG_TYPING // }
             model.deleteContent(selection, {
@@ -133,9 +112,7 @@ export default class DeleteCommand extends Command {
      *
      * See https://github.com/ckeditor/ckeditor5-typing/issues/61.
      *
-     * @private
-     * @param {Number} sequence A number describing which subsequent delete event it is without the key being released.
-     * @returns {Boolean}
+     * @param sequence A number describing which subsequent delete event it is without the key being released.
      */
     _shouldEntireContentBeReplacedWithParagraph(sequence) {
         // Does nothing if user pressed and held the "Backspace" or "Delete" key.
@@ -167,8 +144,7 @@ export default class DeleteCommand extends Command {
     /**
      * The entire content is replaced with the paragraph. Selection is moved inside the paragraph.
      *
-     * @private
-     * @param {module:engine/model/writer~Writer} writer The model writer.
+     * @param writer The model writer.
      */
     _replaceEntireContentWithParagraph(writer) {
         const model = this.editor.model;
@@ -184,10 +160,8 @@ export default class DeleteCommand extends Command {
      * 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.
      *
-     * @private
-     * @param {module:engine/model/selection~Selection} selection The selection.
-     * @param {Number} sequence A number describing which subsequent delete event it is without the key being released.
-     * @returns {Boolean}
+     * @param selection The selection.
+     * @param sequence A number describing which subsequent delete event it is without the key being released.
      */
     _shouldReplaceFirstBlockWithParagraph(selection, sequence) {
         const model = this.editor.model;

package/src/deleteobserver.d.ts

@@ -0,0 +1,51 @@
+/**
+ * @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 { DomEventData, Observer, type BubblingEvent, type ViewDocumentSelection, type ViewSelection, type View } from '@ckeditor/ckeditor5-engine';
+/**
+ * Delete observer introduces the {@link module:engine/view/document~Document#event:delete} event.
+ */
+export default class DeleteObserver extends Observer {
+    /**
+     * @inheritDoc
+     */
+    constructor(view: View);
+    /**
+     * @inheritDoc
+     */
+    observe(): void;
+}
+/**
+ * Event fired when the user tries to delete content (e.g. presses <kbd>Delete</kbd> or <kbd>Backspace</kbd>).
+ *
+ * Note: This event is fired by the {@link module:typing/deleteobserver~DeleteObserver delete observer}
+ * (usually registered by the {@link module:typing/delete~Delete delete feature}).
+ *
+ * @eventName delete
+ * @param data The event data.
+ */
+export type ViewDocumentDeleteEvent = BubblingEvent<{
+    name: 'delete';
+    args: [data: DeleteEventData];
+}>;
+export interface DeleteEventData extends DomEventData<InputEvent> {
+    /**
+     * The direction in which the deletion should happen.
+     */
+    direction: 'backward' | 'forward';
+    /**
+     * The "amount" of content that should be deleted.
+     */
+    unit: 'selection' | 'codePoint' | 'character' | 'word';
+    /**
+     * A number describing which subsequent delete event it is without the key being released.
+     * If it's 2 or more it means that the key was pressed and hold.
+     */
+    sequence: number;
+    /**
+     * View selection which content should be removed. If not set,
+     * current selection should be used.
+     */
+    selectionToRemove?: ViewSelection | ViewDocumentSelection;
+}

package/src/deleteobserver.js

@@ -94,8 +94,6 @@ const DELETE_EVENT_TYPES = {
 };
 /**
  * Delete observer introduces the {@link module:engine/view/document~Document#event:delete} event.
- *
- * @extends module:engine/view/observer/observer~Observer
  */
 export default class DeleteObserver extends Observer {
     /**
@@ -165,7 +163,9 @@ export default class DeleteObserver extends Observer {
      */
     observe() { }
 }
-// Enables workaround for the issue https://github.com/ckeditor/ckeditor5/issues/11904.
+/**
+ * Enables workaround for the issue https://github.com/ckeditor/ckeditor5/issues/11904.
+ */
 function enableChromeWorkaround(observer) {
     const view = observer.view;
     const document = view.document;

package/src/index.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @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
+ */
+export { default as Typing } from './typing';
+export { default as Input } from './input';
+export { default as Delete } from './delete';
+export { default as TextWatcher } from './textwatcher';
+export { default as TwoStepCaretMovement } from './twostepcaretmovement';
+export { default as TextTransformation } from './texttransformation';
+export { default as inlineHighlight } from './utils/inlinehighlight';
+export { default as findAttributeRange } from './utils/findattributerange';
+export { default as getLastTextLine, type LastTextLineData } from './utils/getlasttextline';
+export { default as InsertTextCommand, type InsertTextCommandExecuteEvent } from './inserttextcommand';
+export type { TypingConfig } from './typingconfig';
+export type { ViewDocumentDeleteEvent } from './deleteobserver';
+export type { ViewDocumentInsertTextEvent, InsertTextEventData } from './inserttextobserver';
+export type { TextWatcherMatchedEvent } from './textwatcher';
+export type { TextWatcherMatchedDataEvent } from './textwatcher';

package/src/index.js

@@ -14,3 +14,4 @@ export { default as TextTransformation } from './texttransformation';
 export { default as inlineHighlight } from './utils/inlinehighlight';
 export { default as findAttributeRange } from './utils/findattributerange';
 export { default as getLastTextLine } from './utils/getlasttextline';
+export { default as InsertTextCommand } from './inserttextcommand';

package/src/input.d.ts

@@ -0,0 +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
+ */
+/**
+ * @module typing/input
+ */
+import { Plugin } from '@ckeditor/ckeditor5-core';
+import './typingconfig';
+/**
+ * Handles text input coming from the keyboard or other input methods.
+ */
+export default class Input extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'Input';
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [Input.pluginName]: Input;
+    }
+}

package/src/input.js

@@ -13,8 +13,6 @@ import InsertTextObserver from './inserttextobserver';
 import './typingconfig';
 /**
  * Handles text input coming from the keyboard or other input methods.
- *
- * @extends module:core/plugin~Plugin
  */
 export default class Input extends Plugin {
     /**
@@ -75,7 +73,7 @@ export default class Input extends Plugin {
                 text: insertText,
                 selection: model.createSelection(modelRanges)
             };
-            // @if CK_DEBUG_TYPING // if ( window.logCKETyping ) {
+            // @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
             // @if CK_DEBUG_TYPING // 	console.log( '%c[Input]%c Execute insertText:',
             // @if CK_DEBUG_TYPING // 		'font-weight: bold; color: green;', '',
             // @if CK_DEBUG_TYPING // 		insertText,
@@ -95,10 +93,12 @@ export default class Input extends Plugin {
                 if (modelSelection.isCollapsed || data.keyCode != 229 || !view.document.isComposing) {
                     return;
                 }
-                // @if CK_DEBUG_TYPING // if ( window.logCKETyping ) {
+                // @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
+                // @if CK_DEBUG_TYPING // 	const firstPositionPath = modelSelection.getFirstPosition()!.path;
+                // @if CK_DEBUG_TYPING // 	const lastPositionPath = modelSelection.getLastPosition()!.path;
                 // @if CK_DEBUG_TYPING // 	console.log( '%c[Input]%c KeyDown 229 -> model.deleteContent()',
                 // @if CK_DEBUG_TYPING // 		'font-weight: bold; color: green;', '',
-                // @if CK_DEBUG_TYPING // 		`[${ modelSelection.getFirstPosition().path }]-[${ modelSelection.getLastPosition().path }]`
+                // @if CK_DEBUG_TYPING // 		`[${ firstPositionPath }]-[${ lastPositionPath }]`
                 // @if CK_DEBUG_TYPING // 	);
                 // @if CK_DEBUG_TYPING // }
                 deleteSelectionContent(model, insertTextCommand);
@@ -111,10 +111,12 @@ export default class Input extends Plugin {
                 if (modelSelection.isCollapsed) {
                     return;
                 }
-                // @if CK_DEBUG_TYPING // if ( window.logCKETyping ) {
+                // @if CK_DEBUG_TYPING // if ( ( window as any ).logCKETyping ) {
+                // @if CK_DEBUG_TYPING // 	const firstPositionPath = modelSelection.getFirstPosition()!.path;
+                // @if CK_DEBUG_TYPING // 	const lastPositionPath = modelSelection.getLastPosition()!.path;
                 // @if CK_DEBUG_TYPING // 	console.log( '%c[Input]%c Composition start -> model.deleteContent()',
                 // @if CK_DEBUG_TYPING // 		'font-weight: bold; color: green;', '',
-                // @if CK_DEBUG_TYPING // 		`[${ modelSelection.getFirstPosition().path }]-[${ modelSelection.getLastPosition().path }]`
+                // @if CK_DEBUG_TYPING // 		`[${ firstPositionPath }]-[${ lastPositionPath }]`
                 // @if CK_DEBUG_TYPING // 	);
                 // @if CK_DEBUG_TYPING // }
                 deleteSelectionContent(model, insertTextCommand);

package/src/inserttextcommand.d.ts

@@ -0,0 +1,81 @@
+/**
+ * @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/inserttextcommand
+ */
+import { Command, type Editor } from '@ckeditor/ckeditor5-core';
+import ChangeBuffer from './utils/changebuffer';
+import type { DocumentSelection, Range, Selection } from '@ckeditor/ckeditor5-engine';
+/**
+ * The insert text command. Used by the {@link module:typing/input~Input input feature} to handle typing.
+ */
+export default class InsertTextCommand extends Command {
+    /**
+     * Typing's change buffer used to group subsequent changes into batches.
+     */
+    private readonly _buffer;
+    /**
+     * Creates an instance of the command.
+     *
+     * @param undoStepSize The maximum number of atomic changes
+     * which can be contained in one batch in the command buffer.
+     */
+    constructor(editor: Editor, undoStepSize: number);
+    /**
+     * The current change buffer.
+     */
+    get buffer(): ChangeBuffer;
+    /**
+     * @inheritDoc
+     */
+    destroy(): void;
+    /**
+     * Executes the input command. It replaces the content within the given range with the given text.
+     * Replacing is a two step process, first the content within the range is removed and then the new text is inserted
+     * at the beginning of the range (which after the removal is a collapsed range).
+     *
+     * @fires execute
+     * @param options The command options.
+     */
+    execute(options?: InsertTextCommandOptions): void;
+}
+/**
+ * Interface with parameters for executing InsertTextCommand.
+ *
+ * Both `range` and `selection` parameters are used for defining selection but should not be used together.
+ * If both are defined, only `selection` will be considered.
+ */
+export interface InsertTextCommandOptions {
+    /**
+     * The text to be inserted.
+     */
+    text?: string;
+    /**
+     * The selection in which the text is inserted.
+     * Inserting a text into a selection deletes the current content within selection ranges. If the selection is not specified,
+     * the current selection in the model will be used instead.
+     */
+    selection?: Selection | DocumentSelection;
+    /**
+     * The range in which the text is inserted. Defaults to the first range in the current selection.
+     */
+    range?: Range;
+    /**
+     * The range where the selection should be placed after the insertion.
+     * If not specified, the selection will be placed right after the inserted text.
+     */
+    resultRange?: Range;
+}
+export interface InsertTextCommandExecuteEvent {
+    name: 'execute';
+    args: [
+        data: [options: InsertTextCommandOptions]
+    ];
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface CommandsMap {
+        insertText: InsertTextCommand;
+    }
+}

package/src/inserttextcommand.js

@@ -9,32 +9,20 @@ import { Command } from '@ckeditor/ckeditor5-core';
 import ChangeBuffer from './utils/changebuffer';
 /**
  * The insert text command. Used by the {@link module:typing/input~Input input feature} to handle typing.
- *
- * @extends module:core/command~Command
  */
 export default class InsertTextCommand extends Command {
     /**
      * Creates an instance of the command.
      *
-     * @param {module:core/editor/editor~Editor} editor
-     * @param {Number} undoStepSize The maximum number of atomic changes
+     * @param undoStepSize The maximum number of atomic changes
      * which can be contained in one batch in the command buffer.
      */
     constructor(editor, undoStepSize) {
         super(editor);
-        /**
-         * Typing's change buffer used to group subsequent changes into batches.
-         *
-         * @readonly
-         * @private
-         * @member {module:typing/utils/changebuffer~ChangeBuffer} #_buffer
-         */
         this._buffer = new ChangeBuffer(editor.model, undoStepSize);
     }
     /**
      * The current change buffer.
-     *
-     * @type {module:typing/utils/changebuffer~ChangeBuffer}
      */
     get buffer() {
         return this._buffer;
@@ -52,17 +40,7 @@ export default class InsertTextCommand extends Command {
      * at the beginning of the range (which after the removal is a collapsed range).
      *
      * @fires execute
-     * @param {Object} [options] The command options.
-     * @param {String} [options.text=''] The text to be inserted.
-     * @param {module:engine/model/selection~Selection} [options.selection] The selection in which the text is inserted.
-     * Inserting a text into a selection deletes the current content within selection ranges. If the selection is not specified,
-     * the current selection in the model will be used instead.
-     * // TODO note that those 2 options are exclusive (either selection or range)
-     * @param {module:engine/model/range~Range} [options.range] The range in which the text is inserted. Defaults
-     * to the first range in the current selection.
-     * @param {module:engine/model/range~Range} [options.resultRange] The range where the selection
-     * should be placed after the insertion. If not specified, the selection will be placed right after
-     * the inserted text.
+     * @param options The command options.
      */
     execute(options = {}) {
         const model = this.editor.model;