@ckeditor/ckeditor5-typing 48.2.0 → 48.3.0-alpha.0

package/dist/input.d.ts

@@ -1,33 +1,33 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module typing/input
- */
-import { Plugin } from '@ckeditor/ckeditor5-core';
+* @module typing/input
+*/
+import { Plugin } from "@ckeditor/ckeditor5-core";
 /**
- * Handles text input coming from the keyboard or other input methods.
- */
+* Handles text input coming from the keyboard or other input methods.
+*/
 export declare class Input extends Plugin {
-    /**
-     * The queue of `insertText` command executions that are waiting for the DOM to get updated after beforeinput event.
-     */
-    private _typingQueue;
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "Input";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * @inheritDoc
-     */
-    destroy(): void;
+	/**
+	* The queue of `insertText` command executions that are waiting for the DOM to get updated after beforeinput event.
+	*/
+	private _typingQueue;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "Input";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* @inheritDoc
+	*/
+	override destroy(): void;
 }

package/dist/inserttextcommand.d.ts

@@ -1,76 +1,74 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module typing/inserttextcommand
- */
-import { Command, type Editor } from '@ckeditor/ckeditor5-core';
-import { TypingChangeBuffer } from './utils/changebuffer.js';
-import type { ModelDocumentSelection, ModelRange, ModelSelection } from '@ckeditor/ckeditor5-engine';
+* @module typing/inserttextcommand
+*/
+import { Command, type Editor } from "@ckeditor/ckeditor5-core";
+import { TypingChangeBuffer } from "./utils/changebuffer.js";
+import type { ModelDocumentSelection, ModelRange, ModelSelection } from "@ckeditor/ckeditor5-engine";
 /**
- * The insert text command. Used by the {@link module:typing/input~Input input feature} to handle typing.
- */
+* The insert text command. Used by the {@link module:typing/input~Input input feature} to handle typing.
+*/
 export declare 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(): TypingChangeBuffer;
-    /**
-     * @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;
+	/**
+	* 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(): TypingChangeBuffer;
+	/**
+	* @inheritDoc
+	*/
+	override 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.
+	*/
+	override 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.
- */
+* 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?: ModelSelection | ModelDocumentSelection;
-    /**
-     * The range in which the text is inserted. Defaults to the first range in the current selection.
-     */
-    range?: ModelRange;
-    /**
-     * 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?: ModelRange;
+	/**
+	* 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?: ModelSelection | ModelDocumentSelection;
+	/**
+	* The range in which the text is inserted. Defaults to the first range in the current selection.
+	*/
+	range?: ModelRange;
+	/**
+	* 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?: ModelRange;
 }
 export interface InsertTextCommandExecuteEvent {
-    name: 'execute';
-    args: [
-        data: [options: InsertTextCommandOptions]
-    ];
+	name: "execute";
+	args: [data: [options: InsertTextCommandOptions]];
 }

package/dist/inserttextobserver.d.ts

@@ -1,64 +1,64 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import { ViewDocumentDomEventData, Observer, FocusObserver, type EditingView, type ViewDocumentSelection, type ViewSelection } from '@ckeditor/ckeditor5-engine';
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
+import { ViewDocumentDomEventData, Observer, FocusObserver, type EditingView, type ViewDocumentSelection, type ViewSelection } from "@ckeditor/ckeditor5-engine";
 /**
- * Text insertion observer introduces the {@link module:engine/view/document~ViewDocument#event:insertText} event.
- */
+* Text insertion observer introduces the {@link module:engine/view/document~ViewDocument#event:insertText} event.
+*/
 export declare class InsertTextObserver extends Observer {
-    /**
-     * Instance of the focus observer. Insert text observer calls
-     * {@link module:engine/view/observer/focusobserver~FocusObserver#flush} to mark the latest focus change as complete.
-     */
-    readonly focusObserver: FocusObserver;
-    /**
-     * @inheritDoc
-     */
-    constructor(view: EditingView);
-    /**
-     * @inheritDoc
-     */
-    observe(): void;
-    /**
-     * @inheritDoc
-     */
-    stopObserving(): void;
+	/**
+	* Instance of the focus observer. Insert text observer calls
+	* {@link module:engine/view/observer/focusobserver~FocusObserver#flush} to mark the latest focus change as complete.
+	*/
+	readonly focusObserver: FocusObserver;
+	/**
+	* @inheritDoc
+	*/
+	constructor(view: EditingView);
+	/**
+	* @inheritDoc
+	*/
+	observe(): void;
+	/**
+	* @inheritDoc
+	*/
+	stopObserving(): void;
 }
 /**
- * Event fired when the user types text, for instance presses <kbd>A</kbd> or <kbd>?</kbd> in the
- * editing view document.
- *
- * **Note**: This event will **not** fire for keystrokes such as <kbd>Delete</kbd> or <kbd>Enter</kbd>.
- * They have dedicated events, see {@link module:engine/view/document~ViewDocument#event:delete} and
- * {@link module:engine/view/document~ViewDocument#event:enter} to learn more.
- *
- * **Note**: This event is fired by the {@link module:typing/inserttextobserver~InsertTextObserver input feature}.
- *
- * @eventName module:engine/view/document~ViewDocument#insertText
- * @param data The event data.
- */
+* Event fired when the user types text, for instance presses <kbd>A</kbd> or <kbd>?</kbd> in the
+* editing view document.
+*
+* **Note**: This event will **not** fire for keystrokes such as <kbd>Delete</kbd> or <kbd>Enter</kbd>.
+* They have dedicated events, see {@link module:engine/view/document~ViewDocument#event:delete} and
+* {@link module:engine/view/document~ViewDocument#event:enter} to learn more.
+*
+* **Note**: This event is fired by the {@link module:typing/inserttextobserver~InsertTextObserver input feature}.
+*
+* @eventName module:engine/view/document~ViewDocument#insertText
+* @param data The event data.
+*/
 export type ViewDocumentInsertTextEvent = {
-    name: 'insertText';
-    args: [data: InsertTextEventData];
+	name: "insertText";
+	args: [data: InsertTextEventData];
 };
 export interface InsertTextEventData extends ViewDocumentDomEventData {
-    /**
-     *  The text to be inserted.
-     */
-    text: string;
-    /**
-     * The selection into which the text should be inserted.
-     * If not specified, the insertion should occur at the current view selection.
-     */
-    selection?: ViewSelection | ViewDocumentSelection;
-    /**
-     * A flag indicating that event was fired during composition.
-     *
-     * Corresponds to the
-     * {@link module:engine/view/document~ViewDocument#event:compositionstart},
-     * {@link module:engine/view/document~ViewDocument#event:compositionupdate},
-     * and {@link module:engine/view/document~ViewDocument#event:compositionend } trio.
-     */
-    isComposing?: boolean;
+	/**
+	*  The text to be inserted.
+	*/
+	text: string;
+	/**
+	* The selection into which the text should be inserted.
+	* If not specified, the insertion should occur at the current view selection.
+	*/
+	selection?: ViewSelection | ViewDocumentSelection;
+	/**
+	* A flag indicating that event was fired during composition.
+	*
+	* Corresponds to the
+	* {@link module:engine/view/document~ViewDocument#event:compositionstart},
+	* {@link module:engine/view/document~ViewDocument#event:compositionupdate},
+	* and {@link module:engine/view/document~ViewDocument#event:compositionend } trio.
+	*/
+	isComposing?: boolean;
 }

package/dist/texttransformation.d.ts

@@ -1,39 +1,39 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
 /**
- * @module typing/texttransformation
- */
-import { Plugin, type Editor } from '@ckeditor/ckeditor5-core';
-import { Delete } from './delete.js';
-import { Input } from './input.js';
+* @module typing/texttransformation
+*/
+import { Plugin, type Editor, type PluginDependenciesOf } from "@ckeditor/ckeditor5-core";
+import { Delete } from "./delete.js";
+import { Input } from "./input.js";
 /**
- * The text transformation plugin.
- */
+* The text transformation plugin.
+*/
 export declare class TextTransformation extends Plugin {
-    /**
-     * @inheritDoc
-     */
-    static get requires(): readonly [typeof Delete, typeof Input];
-    /**
-     * @inheritDoc
-     */
-    static get pluginName(): "TextTransformation";
-    /**
-     * @inheritDoc
-     */
-    static get isOfficialPlugin(): true;
-    /**
-     * @inheritDoc
-     */
-    constructor(editor: Editor);
-    /**
-     * @inheritDoc
-     */
-    init(): void;
-    /**
-     * Create new TextWatcher listening to the editor for typing and selection events.
-     */
-    private _enableTransformationWatchers;
+	/**
+	* @inheritDoc
+	*/
+	static get requires(): PluginDependenciesOf<[Delete, Input]>;
+	/**
+	* @inheritDoc
+	*/
+	static get pluginName(): "TextTransformation";
+	/**
+	* @inheritDoc
+	*/
+	static override get isOfficialPlugin(): true;
+	/**
+	* @inheritDoc
+	*/
+	constructor(editor: Editor);
+	/**
+	* @inheritDoc
+	*/
+	init(): void;
+	/**
+	* Create new TextWatcher listening to the editor for typing and selection events.
+	*/
+	private _enableTransformationWatchers;
 }

package/dist/textwatcher.d.ts

@@ -1,138 +1,137 @@
 /**
- * @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
- */
-import type { Batch, Model, ModelRange } from '@ckeditor/ckeditor5-engine';
-declare const TextWatcher_base: {
-    new (): import("@ckeditor/ckeditor5-utils").Observable;
-    prototype: import("@ckeditor/ckeditor5-utils").Observable;
-};
+* @license Copyright (c) 2003-2026, CKSource Holding sp. z o.o. All rights reserved.
+* For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-licensing-options
+*/
+/**
+* @module typing/textwatcher
+*/
+import { type ObservableMixinConstructor } from "@ckeditor/ckeditor5-utils";
+import type { Batch, Model, ModelRange } from "@ckeditor/ckeditor5-engine";
+declare const TextWatcherBase: ObservableMixinConstructor;
 /**
- * The text watcher feature.
- *
- * Fires the {@link module:typing/textwatcher~TextWatcher#event:matched:data `matched:data`},
- * {@link module:typing/textwatcher~TextWatcher#event:matched:selection `matched:selection`} and
- * {@link module:typing/textwatcher~TextWatcher#event:unmatched `unmatched`} events on typing or selection changes.
- */
-export declare class TextWatcher extends /* #__PURE__ */ TextWatcher_base {
-    /**
-     * The editor's model.
-     */
-    readonly model: Model;
-    /**
-     * The function used to match the text.
-     *
-     * The test callback can return 3 values:
-     *
-     * * `false` if there is no match,
-     * * `true` if there is a match,
-     * * an object if there is a match and we want to pass some additional information to the {@link #event:matched:data} event.
-     */
-    testCallback: (text: string) => unknown;
-    /**
-     * Whether there is a match currently.
-     */
-    private _hasMatch;
-    /**
-     * Flag indicating whether the `TextWatcher` instance is enabled or disabled.
-     * A disabled TextWatcher will not evaluate text.
-     *
-     * To disable TextWatcher:
-     *
-     * ```ts
-     * const watcher = new TextWatcher( editor.model, testCallback );
-     *
-     * // After this a testCallback will not be called.
-     * watcher.isEnabled = false;
-     * ```
-     */
-    isEnabled: boolean;
-    /**
-     * Creates a text watcher instance.
-     *
-     * @param testCallback See {@link module:typing/textwatcher~TextWatcher#testCallback}.
-     */
-    constructor(model: Model, testCallback: (text: string) => unknown);
-    /**
-     * Flag indicating whether there is a match currently.
-     */
-    get hasMatch(): boolean;
-    /**
-     * Starts listening to the editor for typing and selection events.
-     */
-    private _startListening;
-    /**
-     * Checks the editor content for matched text.
-     *
-     * @fires matched:data
-     * @fires matched:selection
-     * @fires unmatched
-     *
-     * @param suffix A suffix used for generating the event name.
-     * @param data Data object for event.
-     */
-    private _evaluateTextBeforeSelection;
+* The text watcher feature.
+*
+* Fires the {@link module:typing/textwatcher~TextWatcher#event:matched:data `matched:data`},
+* {@link module:typing/textwatcher~TextWatcher#event:matched:selection `matched:selection`} and
+* {@link module:typing/textwatcher~TextWatcher#event:unmatched `unmatched`} events on typing or selection changes.
+*/
+export declare class TextWatcher extends TextWatcherBase {
+	/**
+	* The editor's model.
+	*/
+	readonly model: Model;
+	/**
+	* The function used to match the text.
+	*
+	* The test callback can return 3 values:
+	*
+	* * `false` if there is no match,
+	* * `true` if there is a match,
+	* * an object if there is a match and we want to pass some additional information to the {@link #event:matched:data} event.
+	*/
+	testCallback: (text: string) => unknown;
+	/**
+	* Whether there is a match currently.
+	*/
+	private _hasMatch;
+	/**
+	* Flag indicating whether the `TextWatcher` instance is enabled or disabled.
+	* A disabled TextWatcher will not evaluate text.
+	*
+	* To disable TextWatcher:
+	*
+	* ```ts
+	* const watcher = new TextWatcher( editor.model, testCallback );
+	*
+	* // After this a testCallback will not be called.
+	* watcher.isEnabled = false;
+	* ```
+	*/
+	isEnabled: boolean;
+	/**
+	* Creates a text watcher instance.
+	*
+	* @param testCallback See {@link module:typing/textwatcher~TextWatcher#testCallback}.
+	*/
+	constructor(model: Model, testCallback: (text: string) => unknown);
+	/**
+	* Flag indicating whether there is a match currently.
+	*/
+	get hasMatch(): boolean;
+	/**
+	* Starts listening to the editor for typing and selection events.
+	*/
+	private _startListening;
+	/**
+	* Checks the editor content for matched text.
+	*
+	* @fires matched:data
+	* @fires matched:selection
+	* @fires unmatched
+	*
+	* @param suffix A suffix used for generating the event name.
+	* @param data Data object for event.
+	*/
+	private _evaluateTextBeforeSelection;
 }
 export type TextWatcherMatchedEvent<TCallbackResult extends Record<string, unknown> = Record<string, unknown>> = {
-    name: 'matched' | 'matched:data' | 'matched:selection';
-    args: [
-        {
-            text: string;
-            range: ModelRange;
-            batch?: Batch;
-        } & TCallbackResult
-    ];
+	name: "matched" | "matched:data" | "matched:selection";
+	args: [{
+		text: string;
+		range: ModelRange;
+		batch?: Batch;
+	} & TCallbackResult];
 };
 /**
- * Fired whenever the text watcher found a match for data changes.
- *
- * @eventName ~TextWatcher#matched:data
- * @param data Event data.
- * @param data.testResult The additional data returned from the {@link module:typing/textwatcher~TextWatcher#testCallback}.
- */
+* Fired whenever the text watcher found a match for data changes.
+*
+* @eventName ~TextWatcher#matched:data
+* @param data Event data.
+* @param data.testResult The additional data returned from the {@link module:typing/textwatcher~TextWatcher#testCallback}.
+*/
 export type TextWatcherMatchedDataEvent<TCallbackResult extends Record<string, unknown>> = {
-    name: 'matched:data';
-    args: [data: TextWatcherMatchedTypingDataEventData & TCallbackResult];
+	name: "matched:data";
+	args: [data: TextWatcherMatchedTypingDataEventData & TCallbackResult];
 };
 export interface TextWatcherMatchedTypingDataEventData {
-    /**
-     * The full text before selection to which the regexp was applied.
-     */
-    text: string;
-    /**
-     * The range representing the position of the `data.text`.
-     */
-    range: ModelRange;
-    batch: Batch;
+	/**
+	* The full text before selection to which the regexp was applied.
+	*/
+	text: string;
+	/**
+	* The range representing the position of the `data.text`.
+	*/
+	range: ModelRange;
+	batch: Batch;
 }
 /**
- * Fired whenever the text watcher found a match for selection changes.
- *
- * @eventName ~TextWatcher#matched:selection
- * @param data Event data.
- * @param data.testResult The additional data returned from the {@link module:typing/textwatcher~TextWatcher#testCallback}.
- */
+* Fired whenever the text watcher found a match for selection changes.
+*
+* @eventName ~TextWatcher#matched:selection
+* @param data Event data.
+* @param data.testResult The additional data returned from the {@link module:typing/textwatcher~TextWatcher#testCallback}.
+*/
 export type TextWatcherMatchedTypingSelectionEvent<TCallbackResult extends Record<string, unknown>> = {
-    name: 'matched:selection';
-    args: [data: TextWatcherMatchedTypingSelectionEventData & TCallbackResult];
+	name: "matched:selection";
+	args: [data: TextWatcherMatchedTypingSelectionEventData & TCallbackResult];
 };
 export interface TextWatcherMatchedTypingSelectionEventData {
-    /**
-     * The full text before selection.
-     */
-    text: string;
-    /**
-     * The range representing the position of the `data.text`.
-     */
-    range: ModelRange;
+	/**
+	* The full text before selection.
+	*/
+	text: string;
+	/**
+	* The range representing the position of the `data.text`.
+	*/
+	range: ModelRange;
 }
 /**
- * Fired whenever the text does not match anymore. Fired only when the text watcher found a match.
- *
- * @eventName ~TextWatcher#unmatched
- */
+* Fired whenever the text does not match anymore. Fired only when the text watcher found a match.
+*
+* @eventName ~TextWatcher#unmatched
+*/
 export type TextWatcherUnmatchedTypingEvent = {
-    name: 'unmatched';
-    args: [];
+	name: "unmatched";
+	args: [];
 };
 export {};