@ckeditor/ckeditor5-typing 41.3.0-alpha.4 → 41.3.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-typing",
-  "version": "41.3.0-alpha.4",
+  "version": "41.3.1",
   "description": "Typing feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -13,9 +13,9 @@
   "type": "module",
   "main": "src/index.js",
   "dependencies": {
-    "@ckeditor/ckeditor5-core": "41.3.0-alpha.4",
-    "@ckeditor/ckeditor5-engine": "41.3.0-alpha.4",
-    "@ckeditor/ckeditor5-utils": "41.3.0-alpha.4",
+    "@ckeditor/ckeditor5-core": "41.3.1",
+    "@ckeditor/ckeditor5-engine": "41.3.1",
+    "@ckeditor/ckeditor5-utils": "41.3.1",
     "lodash-es": "4.17.21"
   },
   "author": "CKSource (http://cksource.com/)",
@@ -28,7 +28,6 @@
     "directory": "packages/ckeditor5-typing"
   },
   "files": [
-    "dist",
     "lang",
     "src/**/*.js",
     "src/**/*.d.ts",

package/dist/content-index.css

@@ -1,4 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */

package/dist/editor-index.css

@@ -1,4 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */

package/dist/index.css

@@ -1,4 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */

package/dist/types/augmentation.d.ts

@@ -1,31 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-import type { Delete, DeleteCommand, Input, InsertTextCommand, TextTransformation, TwoStepCaretMovement, Typing, TypingConfig } from './index.js';
-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/dist/types/delete.d.ts

@@ -1,36 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module 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/dist/types/deletecommand.d.ts

@@ -1,87 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module typing/deletecommand
- */
-import { Command, type Editor } from '@ckeditor/ckeditor5-core';
-import type { DocumentSelection, Selection } from '@ckeditor/ckeditor5-engine';
-import ChangeBuffer from './utils/changebuffer.js';
-/**
- * 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;
-}

package/dist/types/deleteobserver.d.ts

@@ -1,59 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-import { DomEventData, Observer, type BubblingEvent, type ViewDocumentSelection, type ViewSelection, type EditingView } 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: EditingView);
-    /**
-     * @inheritDoc
-     */
-    observe(): void;
-    /**
-     * @inheritDoc
-     */
-    stopObserving(): 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 module:engine/view/document~Document#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/dist/types/index.d.ts

@@ -1,28 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module typing
- */
-export { default as Typing } from './typing.js';
-export { default as Input } from './input.js';
-export { default as Delete } from './delete.js';
-export { default as TextWatcher } from './textwatcher.js';
-export { default as TwoStepCaretMovement } from './twostepcaretmovement.js';
-export { default as TextTransformation } from './texttransformation.js';
-export { default as inlineHighlight } from './utils/inlinehighlight.js';
-export { default as findAttributeRange, findAttributeRangeBound } from './utils/findattributerange.js';
-export { default as getLastTextLine, type LastTextLineData } from './utils/getlasttextline.js';
-export { default as InsertTextCommand, type InsertTextCommandExecuteEvent } from './inserttextcommand.js';
-export type { default as DeleteCommand } from './deletecommand.js';
-export type { TypingConfig } from './typingconfig.js';
-export type { ViewDocumentDeleteEvent } from './deleteobserver.js';
-export type { ViewDocumentInsertTextEvent, InsertTextEventData } from './inserttextobserver.js';
-export type { TextWatcherMatchedEvent } from './textwatcher.js';
-export type { TextWatcherMatchedDataEvent } from './textwatcher.js';
-import './augmentation.js';

package/dist/types/input.d.ts

@@ -1,25 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module 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/dist/types/inserttextcommand.d.ts

@@ -1,80 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module typing/inserttextcommand
- */
-import { Command, type Editor } from '@ckeditor/ckeditor5-core';
-import ChangeBuffer from './utils/changebuffer.js';
-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]
-    ];
-}

package/dist/types/inserttextobserver.d.ts

@@ -1,63 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-import { DomEventData, Observer, FocusObserver, type EditingView, type ViewDocumentSelection, type ViewRange, type ViewSelection } from '@ckeditor/ckeditor5-engine';
-/**
- * Text insertion observer introduces the {@link module:engine/view/document~Document#event:insertText} event.
- */
-export default 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;
-}
-/**
- * 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~Document#event:delete} and
- * {@link module:engine/view/document~Document#event:enter} to learn more.
- *
- * **Note**: This event is fired by the {@link module:typing/inserttextobserver~InsertTextObserver input feature}.
- *
- * @eventName module:engine/view/document~Document#insertText
- * @param data The event data.
- */
-export type ViewDocumentInsertTextEvent = {
-    name: 'insertText';
-    args: [data: InsertTextEventData];
-};
-export interface InsertTextEventData extends DomEventData {
-    /**
-     *  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;
-    /**
-     * The range that view selection should be set to after insertion.
-     */
-    resultRange?: ViewRange;
-}

package/dist/types/texttransformation.d.ts

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

package/dist/types/textwatcher.d.ts

@@ -1,142 +0,0 @@
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-import type { Batch, Model, Range } from '@ckeditor/ckeditor5-engine';
-declare const TextWatcher_base: {
-    new (): import("@ckeditor/ckeditor5-utils").Observable;
-    prototype: import("@ckeditor/ckeditor5-utils").Observable;
-};
-/**
- * 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 default class TextWatcher extends 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;
-}
-export type TextWatcherMatchedEvent<TCallbackResult extends Record<string, unknown> = Record<string, unknown>> = {
-    name: 'matched' | 'matched:data' | 'matched:selection';
-    args: [
-        {
-            text: string;
-            range: Range;
-            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}.
- */
-export type TextWatcherMatchedDataEvent<TCallbackResult extends Record<string, unknown>> = {
-    name: 'matched:data';
-    args: [data: TextWatcherMatchedDataEventData & TCallbackResult];
-};
-export interface TextWatcherMatchedDataEventData {
-    /**
-     * The full text before selection to which the regexp was applied.
-     */
-    text: string;
-    /**
-     * The range representing the position of the `data.text`.
-     */
-    range: Range;
-    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}.
- */
-export type TextWatcherMatchedSelectionEvent<TCallbackResult extends Record<string, unknown>> = {
-    name: 'matched:selection';
-    args: [data: TextWatcherMatchedSelectionEventData & TCallbackResult];
-};
-export interface TextWatcherMatchedSelectionEventData {
-    /**
-     * The full text before selection.
-     */
-    text: string;
-    /**
-     * The range representing the position of the `data.text`.
-     */
-    range: Range;
-}
-/**
- * Fired whenever the text does not match anymore. Fired only when the text watcher found a match.
- *
- * @eventName ~TextWatcher#unmatched
- */
-export type TextWatcherUnmatchedEvent = {
-    name: 'unmatched';
-    args: [];
-};
-export {};