@ckeditor/ckeditor5-utils 48.2.0 → 48.3.0-alpha.1

package/dist/inserttopriorityarray.d.ts

@@ -1,30 +1,30 @@
 /**
- * @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 utils/inserttopriorityarray
- */
-import { type PriorityString } from './priorities.js';
+* @module utils/inserttopriorityarray
+*/
+import { type PriorityString } from "./priorities.js";
 /**
- * The priority object descriptor.
- *
- * ```ts
- * const objectWithPriority = {
- * 	priority: 'high'
- * }
- * ```
- */
+* The priority object descriptor.
+*
+* ```ts
+* const objectWithPriority = {
+* 	priority: 'high'
+* }
+* ```
+*/
 export interface ObjectWithPriority {
-    /**
-     * Priority of the object.
-     */
-    priority: PriorityString;
+	/**
+	* Priority of the object.
+	*/
+	priority: PriorityString;
 }
 /**
- * Inserts any object with priority at correct index by priority so registered objects are always sorted from highest to lowest priority.
- *
- * @param objects Array of objects with priority to insert object to.
- * @param objectToInsert Object with `priority` property.
- */
+* Inserts any object with priority at correct index by priority so registered objects are always sorted from highest to lowest priority.
+*
+* @param objects Array of objects with priority to insert object to.
+* @param objectToInsert Object with `priority` property.
+*/
 export declare function insertToPriorityArray<T extends ObjectWithPriority>(objects: Array<T>, objectToInsert: T): void;

package/dist/isfeatureblockedbylicensekey.d.ts

@@ -1,14 +1,14 @@
 /**
- * @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 utils/isfeatureblockedbylicensekey
- */
+* @module utils/isfeatureblockedbylicensekey
+*/
 /**
- * Checks whether a feature (represented by an unique id) is blocked by the provided license key.
- *
- * @param licensePayload Decoded license key.
- * @param licenseFeatureCode An unique feature id to check.
- */
+* Checks whether a feature (represented by an unique id) is blocked by the provided license key.
+*
+* @param licensePayload Decoded license key.
+* @param licenseFeatureCode An unique feature id to check.
+*/
 export declare function isFeatureBlockedByLicenseKey(licensePayload: Record<string, any>, licenseFeatureCode: string): boolean;

package/dist/isiterable.d.ts

@@ -1,14 +1,14 @@
 /**
- * @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 utils/isiterable
- */
+* @module utils/isiterable
+*/
 /**
- * Checks if value implements iterator interface.
- *
- * @param value The value to check.
- * @returns True if value implements iterator interface.
- */
+* Checks if value implements iterator interface.
+*
+* @param value The value to check.
+* @returns True if value implements iterator interface.
+*/
 export declare function isIterable(value: any): value is Iterable<any>;

package/dist/keyboard.d.ts

@@ -1,127 +1,125 @@
 /**
- * @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
+*/
 /**
- * A set of utilities related to keyboard support.
- *
- * @module utils/keyboard
- */
-import type { LanguageDirection } from './language.js';
+* A set of utilities related to keyboard support.
+*
+* @module utils/keyboard
+*/
+import type { LanguageDirection } from "./language.js";
 /**
- * An object with `keyName => keyCode` pairs for a set of known keys.
- *
- * Contains:
- *
- * * `a-z`,
- * * `0-9`,
- * * `f1-f12`,
- * * `` ` ``, `-`, `=`, `[`, `]`, `;`, `'`, `,`, `.`, `/`, `\`,
- * * `arrow(left|up|right|bottom)`,
- * * `backspace`, `delete`, `end`, `enter`, `esc`, `home`, `tab`,
- * * `ctrl`, `cmd`, `shift`, `alt`.
- */
-export declare const keyCodes: {
-    readonly [keyCode: string]: number;
-};
+* An object with `keyName => keyCode` pairs for a set of known keys.
+*
+* Contains:
+*
+* * `a-z`,
+* * `0-9`,
+* * `f1-f12`,
+* * `` ` ``, `-`, `=`, `[`, `]`, `;`, `'`, `,`, `.`, `/`, `\`,
+* * `arrow(left|up|right|bottom)`,
+* * `backspace`, `delete`, `end`, `enter`, `esc`, `home`, `tab`,
+* * `ctrl`, `cmd`, `shift`, `alt`.
+*/
+export declare const keyCodes: Record<string, number>;
 /**
- * Converts a key name or {@link module:utils/keyboard~KeystrokeInfo keystroke info} into a key code.
- *
- * Note: Key names are matched with {@link module:utils/keyboard#keyCodes} in a case-insensitive way.
- *
- * @param key A key name (see {@link module:utils/keyboard#keyCodes}) or a keystroke data object.
- * @returns Key or keystroke code.
- */
+* Converts a key name or {@link module:utils/keyboard~KeystrokeInfo keystroke info} into a key code.
+*
+* Note: Key names are matched with {@link module:utils/keyboard#keyCodes} in a case-insensitive way.
+*
+* @param key A key name (see {@link module:utils/keyboard#keyCodes}) or a keystroke data object.
+* @returns Key or keystroke code.
+*/
 export declare function getCode(key: string | Readonly<KeystrokeInfo>): number;
 /**
- * Parses the keystroke and returns a keystroke code that will match the code returned by
- * {@link module:utils/keyboard~getCode} for the corresponding {@link module:utils/keyboard~KeystrokeInfo keystroke info}.
- *
- * The keystroke can be passed in two formats:
- *
- * * as a single string – e.g. `ctrl + A`,
- * * as an array of {@link module:utils/keyboard~keyCodes known key names} and key codes – e.g.:
- *   * `[ 'ctrl', 32 ]` (ctrl + space),
- *   * `[ 'ctrl', 'a' ]` (ctrl + A).
- *
- * Note: Key names are matched with {@link module:utils/keyboard#keyCodes} in a case-insensitive way.
- *
- * Note: Only keystrokes with a single non-modifier key are supported (e.g. `ctrl+A` is OK, but `ctrl+A+B` is not).
- *
- * Note: On macOS, keystroke handling is translating the `Ctrl` key to the `Cmd` key and handling only that keystroke.
- * For example, a registered keystroke `Ctrl+A` will be translated to `Cmd+A` on macOS. To disable the translation of some keystroke,
- * use the forced modifier: `Ctrl!+A` (note the exclamation mark).
- *
- * @param keystroke The keystroke definition.
- * @returns Keystroke code.
- */
+* Parses the keystroke and returns a keystroke code that will match the code returned by
+* {@link module:utils/keyboard~getCode} for the corresponding {@link module:utils/keyboard~KeystrokeInfo keystroke info}.
+*
+* The keystroke can be passed in two formats:
+*
+* * as a single string – e.g. `ctrl + A`,
+* * as an array of {@link module:utils/keyboard~keyCodes known key names} and key codes – e.g.:
+*   * `[ 'ctrl', 32 ]` (ctrl + space),
+*   * `[ 'ctrl', 'a' ]` (ctrl + A).
+*
+* Note: Key names are matched with {@link module:utils/keyboard#keyCodes} in a case-insensitive way.
+*
+* Note: Only keystrokes with a single non-modifier key are supported (e.g. `ctrl+A` is OK, but `ctrl+A+B` is not).
+*
+* Note: On macOS, keystroke handling is translating the `Ctrl` key to the `Cmd` key and handling only that keystroke.
+* For example, a registered keystroke `Ctrl+A` will be translated to `Cmd+A` on macOS. To disable the translation of some keystroke,
+* use the forced modifier: `Ctrl!+A` (note the exclamation mark).
+*
+* @param keystroke The keystroke definition.
+* @returns Keystroke code.
+*/
 export declare function parseKeystroke(keystroke: string | ReadonlyArray<number | string>): number;
 /**
- * Translates any keystroke string text like `"Ctrl+A"` to an
- * environment–specific keystroke, i.e. `"⌘A"` on macOS.
- *
- * @param keystroke The keystroke text.
- * @param [forcedEnv] The environment to force the key translation to. If not provided, the current environment is used.
- * @returns The keystroke text specific for the environment.
- */
-export declare function getEnvKeystrokeText(keystroke: string, forcedEnv?: 'PC' | 'Mac'): string;
+* Translates any keystroke string text like `"Ctrl+A"` to an
+* environment–specific keystroke, i.e. `"⌘A"` on macOS.
+*
+* @param keystroke The keystroke text.
+* @param [forcedEnv] The environment to force the key translation to. If not provided, the current environment is used.
+* @returns The keystroke text specific for the environment.
+*/
+export declare function getEnvKeystrokeText(keystroke: string, forcedEnv?: "PC" | "Mac"): string;
 /**
- * Returns `true` if the provided key code represents one of the arrow keys.
- *
- * @param keyCode A key code as in {@link module:utils/keyboard~KeystrokeInfo#keyCode}.
- */
+* Returns `true` if the provided key code represents one of the arrow keys.
+*
+* @param keyCode A key code as in {@link module:utils/keyboard~KeystrokeInfo#keyCode}.
+*/
 export declare function isArrowKeyCode(keyCode: number): boolean;
 /**
- * String representing a direction of an arrow key kode.
- */
-export type ArrowKeyCodeDirection = 'left' | 'up' | 'right' | 'down';
+* String representing a direction of an arrow key kode.
+*/
+export type ArrowKeyCodeDirection = "left" | "up" | "right" | "down";
 /**
- * Returns the direction in which the {@link module:engine/model/documentselection~ModelDocumentSelection selection}
- * will move when the provided arrow key code is pressed considering the language direction of the editor content.
- *
- * For instance, in right–to–left (RTL) content languages, pressing the left arrow means moving the selection right (forward)
- * in the model structure. Similarly, pressing the right arrow moves the selection left (backward).
- *
- * @param keyCode A key code as in {@link module:utils/keyboard~KeystrokeInfo#keyCode}.
- * @param contentLanguageDirection The content language direction, corresponding to
- * {@link module:utils/locale~Locale#contentLanguageDirection}.
- * @returns Localized arrow direction or `undefined` for non-arrow key codes.
- */
+* Returns the direction in which the {@link module:engine/model/documentselection~ModelDocumentSelection selection}
+* will move when the provided arrow key code is pressed considering the language direction of the editor content.
+*
+* For instance, in right–to–left (RTL) content languages, pressing the left arrow means moving the selection right (forward)
+* in the model structure. Similarly, pressing the right arrow moves the selection left (backward).
+*
+* @param keyCode A key code as in {@link module:utils/keyboard~KeystrokeInfo#keyCode}.
+* @param contentLanguageDirection The content language direction, corresponding to
+* {@link module:utils/locale~Locale#contentLanguageDirection}.
+* @returns Localized arrow direction or `undefined` for non-arrow key codes.
+*/
 export declare function getLocalizedArrowKeyCodeDirection(keyCode: number, contentLanguageDirection: LanguageDirection): ArrowKeyCodeDirection | undefined;
 /**
- * Determines if the provided key code moves the {@link module:engine/model/documentselection~ModelDocumentSelection selection}
- * forward or backward considering the language direction of the editor content.
- *
- * For instance, in right–to–left (RTL) languages, pressing the left arrow means moving forward
- * in the model structure. Similarly, pressing the right arrow moves the selection backward.
- *
- * @param keyCode A key code as in {@link module:utils/keyboard~KeystrokeInfo#keyCode}.
- * @param contentLanguageDirection The content language direction, corresponding to
- * {@link module:utils/locale~Locale#contentLanguageDirection}.
- */
+* Determines if the provided key code moves the {@link module:engine/model/documentselection~ModelDocumentSelection selection}
+* forward or backward considering the language direction of the editor content.
+*
+* For instance, in right–to–left (RTL) languages, pressing the left arrow means moving forward
+* in the model structure. Similarly, pressing the right arrow moves the selection backward.
+*
+* @param keyCode A key code as in {@link module:utils/keyboard~KeystrokeInfo#keyCode}.
+* @param contentLanguageDirection The content language direction, corresponding to
+* {@link module:utils/locale~Locale#contentLanguageDirection}.
+*/
 export declare function isForwardArrowKeyCode(keyCode: number, contentLanguageDirection: LanguageDirection): boolean;
 /**
- * Information about the keystroke.
- */
+* Information about the keystroke.
+*/
 export interface KeystrokeInfo {
-    /**
-     * The [key code](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/keyCode).
-     */
-    keyCode: number;
-    /**
-     * Whether the <kbd>Alt</kbd> modifier was pressed.
-     */
-    altKey: boolean;
-    /**
-     * Whether the <kbd>Cmd</kbd> modifier was pressed.
-     */
-    metaKey: boolean;
-    /**
-     * Whether the <kbd>Ctrl</kbd> modifier was pressed.
-     */
-    ctrlKey: boolean;
-    /**
-     * Whether the <kbd>Shift</kbd> modifier was pressed.
-     */
-    shiftKey: boolean;
+	/**
+	* The [key code](https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/keyCode).
+	*/
+	keyCode: number;
+	/**
+	* Whether the <kbd>Alt</kbd> modifier was pressed.
+	*/
+	altKey: boolean;
+	/**
+	* Whether the <kbd>Cmd</kbd> modifier was pressed.
+	*/
+	metaKey: boolean;
+	/**
+	* Whether the <kbd>Ctrl</kbd> modifier was pressed.
+	*/
+	ctrlKey: boolean;
+	/**
+	* Whether the <kbd>Shift</kbd> modifier was pressed.
+	*/
+	shiftKey: boolean;
 }

package/dist/keystrokehandler.d.ts

@@ -1,97 +1,97 @@
 /**
- * @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 { Emitter } from './emittermixin.js';
-import { type KeystrokeInfo } from './keyboard.js';
-import type { PriorityString } from './priorities.js';
+* @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 { Emitter } from "./emittermixin.js";
+import { type KeystrokeInfo } from "./keyboard.js";
+import type { PriorityString } from "./priorities.js";
 /**
- * Keystroke handler allows registering callbacks for given keystrokes.
- *
- * The most frequent use of this class is through the {@link module:core/editor/editor~Editor#keystrokes `editor.keystrokes`}
- * property. It allows listening to keystrokes executed in the editing view:
- *
- * ```ts
- * editor.keystrokes.set( 'Ctrl+A', ( keyEvtData, cancel ) => {
- * 	console.log( 'Ctrl+A has been pressed' );
- * 	cancel();
- * } );
- * ```
- *
- * However, this utility class can be used in various part of the UI. For instance, a certain {@link module:ui/view~View}
- * can use it like this:
- *
- * ```ts
- * class MyView extends View {
- * 	constructor() {
- * 		this.keystrokes = new KeystrokeHandler();
- *
- * 		this.keystrokes.set( 'tab', handleTabKey );
- * 	}
- *
- * 	render() {
- * 		super.render();
- *
- * 		this.keystrokes.listenTo( this.element );
- * 	}
- * }
- * ```
- *
- * That keystroke handler will listen to `keydown` events fired in this view's main element.
- *
- */
+* Keystroke handler allows registering callbacks for given keystrokes.
+*
+* The most frequent use of this class is through the {@link module:core/editor/editor~Editor#keystrokes `editor.keystrokes`}
+* property. It allows listening to keystrokes executed in the editing view:
+*
+* ```ts
+* editor.keystrokes.set( 'Ctrl+A', ( keyEvtData, cancel ) => {
+* 	console.log( 'Ctrl+A has been pressed' );
+* 	cancel();
+* } );
+* ```
+*
+* However, this utility class can be used in various part of the UI. For instance, a certain {@link module:ui/view~View}
+* can use it like this:
+*
+* ```ts
+* class MyView extends View {
+* 	constructor() {
+* 		this.keystrokes = new KeystrokeHandler();
+*
+* 		this.keystrokes.set( 'tab', handleTabKey );
+* 	}
+*
+* 	render() {
+* 		super.render();
+*
+* 		this.keystrokes.listenTo( this.element );
+* 	}
+* }
+* ```
+*
+* That keystroke handler will listen to `keydown` events fired in this view's main element.
+*
+*/
 export declare class KeystrokeHandler {
-    /**
-     * Listener used to listen to events for easier keystroke handler destruction.
-     */
-    private readonly _listener;
-    /**
-     * Creates an instance of the keystroke handler.
-     */
-    constructor();
-    /**
-     * Starts listening for `keydown` events from a given emitter.
-     */
-    listenTo(emitter: Emitter | HTMLElement | Window): void;
-    /**
-     * Registers a handler for the specified keystroke.
-     *
-     * @param keystroke Keystroke defined in a format accepted by
-     * the {@link module:utils/keyboard~parseKeystroke} function.
-     * @param callback A function called with the
-     * {@link module:engine/view/observer/keyobserver~ViewDocumentKeyEventData key event data} object and
-     * a helper function to call both `preventDefault()` and `stopPropagation()` on the underlying event.
-     * @param options Additional options.
-     */
-    set(keystroke: string | ReadonlyArray<string | number>, callback: (ev: KeyboardEvent, cancel: () => void) => void, options?: KeystrokeHandlerOptions): void;
-    /**
-     * Triggers a keystroke handler for a specified key combination, if such a keystroke was {@link #set defined}.
-     *
-     * @param keyEvtData Key event data.
-     * @returns Whether the keystroke was handled.
-     */
-    press(keyEvtData: Readonly<KeystrokeInfo>): boolean;
-    /**
-     * Stops listening to `keydown` events from the given emitter.
-     */
-    stopListening(emitter?: Emitter | HTMLElement | Window): void;
-    /**
-     * Destroys the keystroke handler.
-     */
-    destroy(): void;
+	/**
+	* Listener used to listen to events for easier keystroke handler destruction.
+	*/
+	private readonly _listener;
+	/**
+	* Creates an instance of the keystroke handler.
+	*/
+	constructor();
+	/**
+	* Starts listening for `keydown` events from a given emitter.
+	*/
+	listenTo(emitter: Emitter | HTMLElement | Window): void;
+	/**
+	* Registers a handler for the specified keystroke.
+	*
+	* @param keystroke Keystroke defined in a format accepted by
+	* the {@link module:utils/keyboard~parseKeystroke} function.
+	* @param callback A function called with the
+	* {@link module:engine/view/observer/keyobserver~ViewDocumentKeyEventData key event data} object and
+	* a helper function to call both `preventDefault()` and `stopPropagation()` on the underlying event.
+	* @param options Additional options.
+	*/
+	set(keystroke: string | ReadonlyArray<string | number>, callback: (ev: KeyboardEvent, cancel: () => void) => void, options?: KeystrokeHandlerOptions): void;
+	/**
+	* Triggers a keystroke handler for a specified key combination, if such a keystroke was {@link #set defined}.
+	*
+	* @param keyEvtData Key event data.
+	* @returns Whether the keystroke was handled.
+	*/
+	press(keyEvtData: Readonly<KeystrokeInfo>): boolean;
+	/**
+	* Stops listening to `keydown` events from the given emitter.
+	*/
+	stopListening(emitter?: Emitter | HTMLElement | Window): void;
+	/**
+	* Destroys the keystroke handler.
+	*/
+	destroy(): void;
 }
 /**
- * {@link module:utils/keystrokehandler~KeystrokeHandler#set} method options.
- */
+* {@link module:utils/keystrokehandler~KeystrokeHandler#set} method options.
+*/
 export interface KeystrokeHandlerOptions {
-    /**
-     * The priority of the keystroke callback. The higher the priority value the sooner the callback will be executed.
-     * Keystrokes having the same priority are called in the order they were added.
-     */
-    readonly priority?: PriorityString;
-    /**
-     * An optional callback function allowing for filtering keystrokes based on arbitrary criteria.
-     * The callback function receives `keydown` DOM event as a parameter.
-     */
-    readonly filter?: (keyEvtData: KeyboardEvent) => boolean;
+	/**
+	* The priority of the keystroke callback. The higher the priority value the sooner the callback will be executed.
+	* Keystrokes having the same priority are called in the order they were added.
+	*/
+	readonly priority?: PriorityString;
+	/**
+	* An optional callback function allowing for filtering keystrokes based on arbitrary criteria.
+	* The callback function receives `keydown` DOM event as a parameter.
+	*/
+	readonly filter?: (keyEvtData: KeyboardEvent) => boolean;
 }

package/dist/language.d.ts

@@ -1,17 +1,17 @@
 /**
- * @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 utils/language
- */
+* @module utils/language
+*/
 /**
- * String representing a language direction.
- */
-export type LanguageDirection = 'ltr' | 'rtl';
+* String representing a language direction.
+*/
+export type LanguageDirection = "ltr" | "rtl";
 /**
- * Helps determine whether a language text direction is LTR or RTL.
- *
- * @param languageCode The ISO 639-1 or ISO 639-2 language code.
- */
+* Helps determine whether a language text direction is LTR or RTL.
+*
+* @param languageCode The ISO 639-1 or ISO 639-2 language code.
+*/
 export declare function getLanguageDirection(languageCode: string): LanguageDirection;

package/dist/legacyerrors.d.ts

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