@ckeditor/ckeditor5-utils 41.3.1 → 41.4.0

package/dist/types/fastdiff.d.ts

@@ -0,0 +1,116 @@
+/**
+ * @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 { DiffResult } from './diff.js';
+import type { Change } from './difftochanges.js';
+/**
+ * @module utils/fastdiff
+ */
+/**
+ * Finds positions of the first and last change in the given string/array and generates a set of changes:
+ *
+ * ```ts
+ * fastDiff( '12a', '12xyza' );
+ * // [ { index: 2, type: 'insert', values: [ 'x', 'y', 'z' ] } ]
+ *
+ * fastDiff( '12a', '12aa' );
+ * // [ { index: 3, type: 'insert', values: [ 'a' ] } ]
+ *
+ * fastDiff( '12xyza', '12a' );
+ * // [ { index: 2, type: 'delete', howMany: 3 } ]
+ *
+ * fastDiff( [ '1', '2', 'a', 'a' ], [ '1', '2', 'a' ] );
+ * // [ { index: 3, type: 'delete', howMany: 1 } ]
+ *
+ * fastDiff( [ '1', '2', 'a', 'b', 'c', '3' ], [ '2', 'a', 'b' ] );
+ * // [ { index: 0, type: 'insert', values: [ '2', 'a', 'b' ] }, { index: 3, type: 'delete', howMany: 6 } ]
+ * ```
+ *
+ * Passed arrays can contain any type of data, however to compare them correctly custom comparator function
+ * should be passed as a third parameter:
+ *
+ * ```ts
+ * fastDiff( [ { value: 1 }, { value: 2 } ], [ { value: 1 }, { value: 3 } ], ( a, b ) => {
+ * 	return a.value === b.value;
+ * } );
+ * // [ { index: 1, type: 'insert', values: [ { value: 3 } ] }, { index: 2, type: 'delete', howMany: 1 } ]
+ * ```
+ *
+ * The resulted set of changes can be applied to the input in order to transform it into the output, for example:
+ *
+ * ```ts
+ * let input = '12abc3';
+ * const output = '2ab';
+ * const changes = fastDiff( input, output );
+ *
+ * changes.forEach( change => {
+ * 	if ( change.type == 'insert' ) {
+ * 		input = input.substring( 0, change.index ) + change.values.join( '' ) + input.substring( change.index );
+ * 	} else if ( change.type == 'delete' ) {
+ * 		input = input.substring( 0, change.index ) + input.substring( change.index + change.howMany );
+ * 	}
+ * } );
+ *
+ * // input equals output now
+ * ```
+ *
+ * or in case of arrays:
+ *
+ * ```ts
+ * let input = [ '1', '2', 'a', 'b', 'c', '3' ];
+ * const output = [ '2', 'a', 'b' ];
+ * const changes = fastDiff( input, output );
+ *
+ * changes.forEach( change => {
+ * 	if ( change.type == 'insert' ) {
+ * 		input = input.slice( 0, change.index ).concat( change.values, input.slice( change.index ) );
+ * 	} else if ( change.type == 'delete' ) {
+ * 		input = input.slice( 0, change.index ).concat( input.slice( change.index + change.howMany ) );
+ * 	}
+ * } );
+ *
+ * // input equals output now
+ * ```
+ *
+ * By passing `true` as the fourth parameter (`atomicChanges`) the output of this function will become compatible with
+ * the {@link module:utils/diff~diff `diff()`} function:
+ *
+ * ```ts
+ * fastDiff( '12a', '12xyza', undefined, true );
+ * // [ 'equal', 'equal', 'insert', 'insert', 'insert', 'equal' ]
+ * ```
+ *
+ * The default output format of this function is compatible with the output format of
+ * {@link module:utils/difftochanges~diffToChanges `diffToChanges()`}. The `diffToChanges()` input format is, in turn,
+ * compatible with the output of {@link module:utils/diff~diff `diff()`}:
+ *
+ * ```ts
+ * const a = '1234';
+ * const b = '12xyz34';
+ *
+ * // Both calls will return the same results (grouped changes format).
+ * fastDiff( a, b );
+ * diffToChanges( diff( a, b ) );
+ *
+ * // Again, both calls will return the same results (atomic changes format).
+ * fastDiff( a, b, undefined, true );
+ * diff( a, b );
+ * ```
+ *
+ * @typeParam T The type of array elements.
+ * @typeParam AtomicChanges The type of `atomicChanges` parameter (selects the result type).
+ * @param a Input array or string.
+ * @param b Input array or string.
+ * @param cmp Optional function used to compare array values, by default `===` (strict equal operator) is used.
+ * @param atomicChanges Whether an array of `inset|delete|equal` operations should
+ * be returned instead of changes set. This makes this function compatible with {@link module:utils/diff~diff `diff()`}.
+ * Defaults to `false`.
+ * @returns Array of changes. The elements are either {@link module:utils/diff~DiffResult} or {@link module:utils/difftochanges~Change},
+ * depending on `atomicChanges` parameter.
+ */
+export default function fastDiff<T, AtomicChanges extends boolean = false>(a: ArrayLike<T>, b: ArrayLike<T>, cmp?: (a: T, b: T) => boolean, atomicChanges?: AtomicChanges): Array<AtomicChanges extends true ? DiffResult : Change<T>>;

package/dist/types/first.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @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 utils/first
+ */
+/**
+ * Returns first item of the given `iterator`.
+ */
+export default function first<T>(iterator: Iterator<T>): T | null;

package/dist/types/focustracker.d.ts

@@ -0,0 +1,79 @@
+/**
+ * @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
+ */
+declare const FocusTracker_base: import("./mix.js").Mixed<{
+    new (): import("./observablemixin.js").Observable;
+    prototype: import("./observablemixin.js").Observable;
+}, import("./dom/emittermixin.js").DomEmitter>;
+/**
+ * Allows observing a group of `Element`s whether at least one of them is focused.
+ *
+ * Used by the {@link module:core/editor/editor~Editor} in order to track whether the focus is still within the application,
+ * or were used outside of its UI.
+ *
+ * **Note** `focus` and `blur` listeners use event capturing, so it is only needed to register wrapper `Element`
+ * which contain other `focusable` elements. But note that this wrapper element has to be focusable too
+ * (have e.g. `tabindex="-1"`).
+ *
+ * Check out the {@glink framework/deep-dive/ui/focus-tracking "Deep dive into focus tracking"} guide to learn more.
+ */
+export default class FocusTracker extends FocusTracker_base {
+    /**
+     * True when one of the registered elements is focused.
+     *
+     * @readonly
+     * @observable
+     */
+    isFocused: boolean;
+    /**
+     * The currently focused element.
+     *
+     * While {@link #isFocused `isFocused`} remains `true`, the focus can
+     * move between different UI elements. This property tracks those
+     * elements and tells which one is currently focused.
+     *
+     * @readonly
+     * @observable
+     */
+    focusedElement: Element | null;
+    /**
+     * List of registered elements.
+     *
+     * @internal
+     */
+    _elements: Set<Element>;
+    /**
+     * Event loop timeout.
+     */
+    private _nextEventLoopTimeout;
+    constructor();
+    /**
+     * Starts tracking the specified element.
+     */
+    add(element: Element): void;
+    /**
+     * Stops tracking the specified element and stops listening on this element.
+     */
+    remove(element: Element): void;
+    /**
+     * Destroys the focus tracker by:
+     * - Disabling all event listeners attached to tracked elements.
+     * - Removing all tracked elements that were previously added.
+     */
+    destroy(): void;
+    /**
+     * Stores currently focused element and set {@link #isFocused} as `true`.
+     */
+    private _focus;
+    /**
+     * Clears currently focused element and set {@link #isFocused} as `false`.
+     * This method uses `setTimeout` to change order of fires `blur` and `focus` events.
+     */
+    private _blur;
+}
+export {};

package/dist/types/index.d.ts

@@ -0,0 +1,68 @@
+/**
+ * @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 utils
+ */
+export { default as env } from './env.js';
+export { default as diff, type DiffResult } from './diff.js';
+export { default as fastDiff } from './fastdiff.js';
+export { default as diffToChanges } from './difftochanges.js';
+export { default as mix } from './mix.js';
+export type { Constructor, Mixed } from './mix.js';
+export { default as EmitterMixin, type Emitter, type BaseEvent, type CallbackOptions, type EmitterMixinDelegateChain, type GetCallback, type GetCallbackOptions, type GetEventInfo, type GetNameOrEventInfo } from './emittermixin.js';
+export { default as EventInfo } from './eventinfo.js';
+export { default as ObservableMixin, type Observable, type DecoratedMethodEvent, type ObservableChangeEvent, type ObservableSetEvent } from './observablemixin.js';
+export { default as CKEditorError, logError, logWarning } from './ckeditorerror.js';
+export { default as ElementReplacer } from './elementreplacer.js';
+export { default as abortableDebounce, type AbortableFunc } from './abortabledebounce.js';
+export { default as count } from './count.js';
+export { default as compareArrays } from './comparearrays.js';
+export { default as createElement } from './dom/createelement.js';
+export { default as Config } from './config.js';
+export { default as isIterable } from './isiterable.js';
+export { default as DomEmitterMixin, type DomEmitter } from './dom/emittermixin.js';
+export { default as findClosestScrollableAncestor } from './dom/findclosestscrollableancestor.js';
+export { default as global } from './dom/global.js';
+export { default as getAncestors } from './dom/getancestors.js';
+export { default as getDataFromElement } from './dom/getdatafromelement.js';
+export { default as getBorderWidths } from './dom/getborderwidths.js';
+export { default as isText } from './dom/istext.js';
+export { default as Rect, type RectSource } from './dom/rect.js';
+export { default as ResizeObserver } from './dom/resizeobserver.js';
+export { default as setDataInElement } from './dom/setdatainelement.js';
+export { default as toUnit } from './dom/tounit.js';
+export { default as indexOf } from './dom/indexof.js';
+export { default as insertAt } from './dom/insertat.js';
+export { default as isComment } from './dom/iscomment.js';
+export { default as isNode } from './dom/isnode.js';
+export { default as isRange } from './dom/isrange.js';
+export { default as isValidAttributeName } from './dom/isvalidattributename.js';
+export { default as isVisible } from './dom/isvisible.js';
+export { getOptimalPosition, type Options as PositionOptions, type PositioningFunction, type DomPoint } from './dom/position.js';
+export { default as remove } from './dom/remove.js';
+export * from './dom/scroll.js';
+export * from './keyboard.js';
+export * from './language.js';
+export { default as Locale, type LocaleTranslate, type Translations } from './locale.js';
+export { default as Collection, type CollectionAddEvent, type CollectionChangeEvent, type CollectionRemoveEvent } from './collection.js';
+export { default as first } from './first.js';
+export { default as FocusTracker } from './focustracker.js';
+export { default as KeystrokeHandler } from './keystrokehandler.js';
+export { default as toArray, type ArrayOrItem, type ReadonlyArrayOrItem } from './toarray.js';
+export { default as toMap } from './tomap.js';
+export { default as priorities, type PriorityString } from './priorities.js';
+export { default as retry, exponentialDelay } from './retry.js';
+export { default as insertToPriorityArray } from './inserttopriorityarray.js';
+export { default as spliceArray } from './splicearray.js';
+export { default as uid } from './uid.js';
+export { default as delay, type DelayedFunc } from './delay.js';
+export { default as verifyLicense } from './verifylicense.js';
+export { default as wait } from './wait.js';
+export * from './unicode.js';
+export { default as version, releaseDate } from './version.js';

package/dist/types/inserttopriorityarray.d.ts

@@ -0,0 +1,34 @@
+/**
+ * @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 PriorityString } from './priorities.js';
+/**
+ * @module utils/inserttopriorityarray
+ */
+/**
+ * The priority object descriptor.
+ *
+ * ```ts
+ * const objectWithPriority = {
+ * 	priority: 'high'
+ * }
+ * ```
+ */
+export interface ObjectWithPriority {
+    /**
+     * 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.
+ */
+export default function insertToPriorityArray<T extends ObjectWithPriority>(objects: Array<T>, objectToInsert: T): void;

package/dist/types/isiterable.d.ts

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

package/dist/types/keyboard.d.ts

@@ -0,0 +1,130 @@
+/**
+ * @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
+ */
+/**
+ * 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`, `enter`, `esc`, `tab`,
+ * * `ctrl`, `cmd`, `shift`, `alt`.
+ */
+export declare const keyCodes: {
+    readonly [keyCode: 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.
+ */
+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.
+ */
+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.
+ * @returns The keystroke text specific for the environment.
+ */
+export declare function getEnvKeystrokeText(keystroke: string): 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}.
+ */
+export declare function isArrowKeyCode(keyCode: number): boolean;
+/**
+ * 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~DocumentSelection 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~DocumentSelection 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.
+ */
+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;
+}

package/dist/types/keystrokehandler.d.ts

@@ -0,0 +1,91 @@
+/**
+ * @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 { 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.
+ *
+ */
+export default 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~KeyEventData key event data} object and
+     * a helper function to call both `preventDefault()` and `stopPropagation()` on the underlying event.
+     * @param options Additional options.
+     * @param options.priority 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.
+     */
+    set(keystroke: string | ReadonlyArray<string | number>, callback: (ev: KeyboardEvent, cancel: () => void) => void, options?: {
+        readonly priority?: PriorityString;
+    }): 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;
+}

package/dist/types/language.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @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 utils/language
+ */
+/**
+ * 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.
+ */
+export declare function getLanguageDirection(languageCode: string): LanguageDirection;