@ckeditor/ckeditor5-typing 40.0.0 → 40.2.0

package/src/index.d.ts

@@ -1,24 +1,24 @@
-/**
- * @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, findAttributeRangeBound } from './utils/findattributerange';
-export { default as getLastTextLine, type LastTextLineData } from './utils/getlasttextline';
-export { default as InsertTextCommand, type InsertTextCommandExecuteEvent } from './inserttextcommand';
-export type { default as DeleteCommand } from './deletecommand';
-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';
-import './augmentation';
+/**
+ * @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, findAttributeRangeBound } from './utils/findattributerange';
+export { default as getLastTextLine, type LastTextLineData } from './utils/getlasttextline';
+export { default as InsertTextCommand, type InsertTextCommandExecuteEvent } from './inserttextcommand';
+export type { default as DeleteCommand } from './deletecommand';
+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';
+import './augmentation';

package/src/index.js

@@ -1,18 +1,18 @@
-/**
- * @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, findAttributeRangeBound } from './utils/findattributerange';
-export { default as getLastTextLine } from './utils/getlasttextline';
-export { default as InsertTextCommand } from './inserttextcommand';
-import './augmentation';
+/**
+ * @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, findAttributeRangeBound } from './utils/findattributerange';
+export { default as getLastTextLine } from './utils/getlasttextline';
+export { default as InsertTextCommand } from './inserttextcommand';
+import './augmentation';

package/src/input.d.ts

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

package/src/input.js

@@ -1,141 +1,141 @@
-/**
- * @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 { env } from '@ckeditor/ckeditor5-utils';
-import InsertTextCommand from './inserttextcommand';
-import InsertTextObserver from './inserttextobserver';
-/**
- * Handles text input coming from the keyboard or other input methods.
- */
-export default class Input extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get pluginName() {
-        return 'Input';
-    }
-    /**
-     * @inheritDoc
-     */
-    init() {
-        const editor = this.editor;
-        const model = editor.model;
-        const view = editor.editing.view;
-        const modelSelection = model.document.selection;
-        view.addObserver(InsertTextObserver);
-        // TODO The above default configuration value should be defined using editor.config.define() once it's fixed.
-        const insertTextCommand = new InsertTextCommand(editor, editor.config.get('typing.undoStep') || 20);
-        // Register `insertText` command and add `input` command as an alias for backward compatibility.
-        editor.commands.add('insertText', insertTextCommand);
-        editor.commands.add('input', insertTextCommand);
-        this.listenTo(view.document, 'insertText', (evt, data) => {
-            // Rendering is disabled while composing so prevent events that will be rendered by the engine
-            // and should not be applied by the browser.
-            if (!view.document.isComposing) {
-                data.preventDefault();
-            }
-            const { text, selection: viewSelection, resultRange: viewResultRange } = data;
-            // If view selection was specified, translate it to model selection.
-            const modelRanges = Array.from(viewSelection.getRanges()).map(viewRange => {
-                return editor.editing.mapper.toModelRange(viewRange);
-            });
-            let insertText = text;
-            // Typing in English on Android is firing composition events for the whole typed word.
-            // We need to check the target range text to only apply the difference.
-            if (env.isAndroid) {
-                const selectedText = Array.from(modelRanges[0].getItems()).reduce((rangeText, node) => {
-                    return rangeText + (node.is('$textProxy') ? node.data : '');
-                }, '');
-                if (selectedText) {
-                    if (selectedText.length <= insertText.length) {
-                        if (insertText.startsWith(selectedText)) {
-                            insertText = insertText.substring(selectedText.length);
-                            modelRanges[0].start = modelRanges[0].start.getShiftedBy(selectedText.length);
-                        }
-                    }
-                    else {
-                        if (selectedText.startsWith(insertText)) {
-                            // TODO this should be mapped as delete?
-                            modelRanges[0].start = modelRanges[0].start.getShiftedBy(insertText.length);
-                            insertText = '';
-                        }
-                    }
-                }
-            }
-            const insertTextCommandData = {
-                text: insertText,
-                selection: model.createSelection(modelRanges)
-            };
-            // @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,
-            // @if CK_DEBUG_TYPING // 		`[${ modelRanges[ 0 ].start.path }]-[${ modelRanges[ 0 ].end.path }]`
-            // @if CK_DEBUG_TYPING // 	);
-            // @if CK_DEBUG_TYPING // }
-            if (viewResultRange) {
-                insertTextCommandData.resultRange = editor.editing.mapper.toModelRange(viewResultRange);
-            }
-            editor.execute('insertText', insertTextCommandData);
-            view.scrollToTheSelection();
-        });
-        if (env.isAndroid) {
-            // On Android with English keyboard, the composition starts just by putting caret
-            // at the word end or by selecting a table column. This is not a real composition started.
-            // Trigger delete content on first composition key pressed.
-            this.listenTo(view.document, 'keydown', (evt, data) => {
-                if (modelSelection.isCollapsed || data.keyCode != 229 || !view.document.isComposing) {
-                    return;
-                }
-                // @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 // 		`[${ firstPositionPath }]-[${ lastPositionPath }]`
-                // @if CK_DEBUG_TYPING // 	);
-                // @if CK_DEBUG_TYPING // }
-                deleteSelectionContent(model, insertTextCommand);
-            });
-        }
-        else {
-            // Note: The priority must precede the CompositionObserver handler to call it before
-            // the renderer is blocked, because we want to render this change.
-            this.listenTo(view.document, 'compositionstart', () => {
-                if (modelSelection.isCollapsed) {
-                    return;
-                }
-                // @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 // 		`[${ firstPositionPath }]-[${ lastPositionPath }]`
-                // @if CK_DEBUG_TYPING // 	);
-                // @if CK_DEBUG_TYPING // }
-                deleteSelectionContent(model, insertTextCommand);
-            });
-        }
-    }
-}
-function deleteSelectionContent(model, insertTextCommand) {
-    // By relying on the state of the input command we allow disabling the entire input easily
-    // by just disabling the input command. We could’ve used here the delete command but that
-    // would mean requiring the delete feature which would block loading one without the other.
-    // We could also check the editor.isReadOnly property, but that wouldn't allow to block
-    // the input without blocking other features.
-    if (!insertTextCommand.isEnabled) {
-        return;
-    }
-    const buffer = insertTextCommand.buffer;
-    buffer.lock();
-    model.enqueueChange(buffer.batch, () => {
-        model.deleteContent(model.document.selection);
-    });
-    buffer.unlock();
-}
+/**
+ * @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 { env } from '@ckeditor/ckeditor5-utils';
+import InsertTextCommand from './inserttextcommand';
+import InsertTextObserver from './inserttextobserver';
+/**
+ * Handles text input coming from the keyboard or other input methods.
+ */
+export default class Input extends Plugin {
+    /**
+     * @inheritDoc
+     */
+    static get pluginName() {
+        return 'Input';
+    }
+    /**
+     * @inheritDoc
+     */
+    init() {
+        const editor = this.editor;
+        const model = editor.model;
+        const view = editor.editing.view;
+        const modelSelection = model.document.selection;
+        view.addObserver(InsertTextObserver);
+        // TODO The above default configuration value should be defined using editor.config.define() once it's fixed.
+        const insertTextCommand = new InsertTextCommand(editor, editor.config.get('typing.undoStep') || 20);
+        // Register `insertText` command and add `input` command as an alias for backward compatibility.
+        editor.commands.add('insertText', insertTextCommand);
+        editor.commands.add('input', insertTextCommand);
+        this.listenTo(view.document, 'insertText', (evt, data) => {
+            // Rendering is disabled while composing so prevent events that will be rendered by the engine
+            // and should not be applied by the browser.
+            if (!view.document.isComposing) {
+                data.preventDefault();
+            }
+            const { text, selection: viewSelection, resultRange: viewResultRange } = data;
+            // If view selection was specified, translate it to model selection.
+            const modelRanges = Array.from(viewSelection.getRanges()).map(viewRange => {
+                return editor.editing.mapper.toModelRange(viewRange);
+            });
+            let insertText = text;
+            // Typing in English on Android is firing composition events for the whole typed word.
+            // We need to check the target range text to only apply the difference.
+            if (env.isAndroid) {
+                const selectedText = Array.from(modelRanges[0].getItems()).reduce((rangeText, node) => {
+                    return rangeText + (node.is('$textProxy') ? node.data : '');
+                }, '');
+                if (selectedText) {
+                    if (selectedText.length <= insertText.length) {
+                        if (insertText.startsWith(selectedText)) {
+                            insertText = insertText.substring(selectedText.length);
+                            modelRanges[0].start = modelRanges[0].start.getShiftedBy(selectedText.length);
+                        }
+                    }
+                    else {
+                        if (selectedText.startsWith(insertText)) {
+                            // TODO this should be mapped as delete?
+                            modelRanges[0].start = modelRanges[0].start.getShiftedBy(insertText.length);
+                            insertText = '';
+                        }
+                    }
+                }
+            }
+            const insertTextCommandData = {
+                text: insertText,
+                selection: model.createSelection(modelRanges)
+            };
+            // @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,
+            // @if CK_DEBUG_TYPING // 		`[${ modelRanges[ 0 ].start.path }]-[${ modelRanges[ 0 ].end.path }]`
+            // @if CK_DEBUG_TYPING // 	);
+            // @if CK_DEBUG_TYPING // }
+            if (viewResultRange) {
+                insertTextCommandData.resultRange = editor.editing.mapper.toModelRange(viewResultRange);
+            }
+            editor.execute('insertText', insertTextCommandData);
+            view.scrollToTheSelection();
+        });
+        if (env.isAndroid) {
+            // On Android with English keyboard, the composition starts just by putting caret
+            // at the word end or by selecting a table column. This is not a real composition started.
+            // Trigger delete content on first composition key pressed.
+            this.listenTo(view.document, 'keydown', (evt, data) => {
+                if (modelSelection.isCollapsed || data.keyCode != 229 || !view.document.isComposing) {
+                    return;
+                }
+                // @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 // 		`[${ firstPositionPath }]-[${ lastPositionPath }]`
+                // @if CK_DEBUG_TYPING // 	);
+                // @if CK_DEBUG_TYPING // }
+                deleteSelectionContent(model, insertTextCommand);
+            });
+        }
+        else {
+            // Note: The priority must precede the CompositionObserver handler to call it before
+            // the renderer is blocked, because we want to render this change.
+            this.listenTo(view.document, 'compositionstart', () => {
+                if (modelSelection.isCollapsed) {
+                    return;
+                }
+                // @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 // 		`[${ firstPositionPath }]-[${ lastPositionPath }]`
+                // @if CK_DEBUG_TYPING // 	);
+                // @if CK_DEBUG_TYPING // }
+                deleteSelectionContent(model, insertTextCommand);
+            });
+        }
+    }
+}
+function deleteSelectionContent(model, insertTextCommand) {
+    // By relying on the state of the input command we allow disabling the entire input easily
+    // by just disabling the input command. We could’ve used here the delete command but that
+    // would mean requiring the delete feature which would block loading one without the other.
+    // We could also check the editor.isReadOnly property, but that wouldn't allow to block
+    // the input without blocking other features.
+    if (!insertTextCommand.isEnabled) {
+        return;
+    }
+    const buffer = insertTextCommand.buffer;
+    buffer.lock();
+    model.enqueueChange(buffer.batch, () => {
+        model.deleteContent(model.document.selection);
+    });
+    buffer.unlock();
+}

package/src/inserttextcommand.d.ts

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