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

package/dist/collectstylesheets.d.ts

@@ -1,13 +1,13 @@
 /**
- * @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/collectstylesheets
- */
+* @module utils/collectstylesheets
+*/
 /**
- * A helper function for getting concatenated CSS rules from external stylesheets.
- *
- * @param stylesheets An array of stylesheet paths delivered by the user through the plugin configuration.
- */
+* A helper function for getting concatenated CSS rules from external stylesheets.
+*
+* @param stylesheets An array of stylesheet paths delivered by the user through the plugin configuration.
+*/
 export declare function collectStylesheets(stylesheets?: Array<string>): Promise<string>;

package/dist/comparearrays.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/comparearrays
- */
+* @module utils/comparearrays
+*/
 /**
- * Compares how given arrays relate to each other. One array can be: same as another array, prefix of another array
- * or completely different. If arrays are different, first index at which they differ is returned. Otherwise,
- * a flag specifying the relation is returned. Flags are negative numbers, so whenever a number >= 0 is returned
- * it means that arrays differ.
- *
- * ```ts
- * compareArrays( [ 0, 2 ], [ 0, 2 ] );		// 'same'
- * compareArrays( [ 0, 2 ], [ 0, 2, 1 ] );		// 'prefix'
- * compareArrays( [ 0, 2 ], [ 0 ] );			// 'extension'
- * compareArrays( [ 0, 2 ], [ 1, 2 ] );		// 0
- * compareArrays( [ 0, 2 ], [ 0, 1 ] );		// 1
- * ```
- *
- * @param a Array that is compared.
- * @param b Array to compare with.
- * @returns How array `a` is related to `b`.
- */
+* Compares how given arrays relate to each other. One array can be: same as another array, prefix of another array
+* or completely different. If arrays are different, first index at which they differ is returned. Otherwise,
+* a flag specifying the relation is returned. Flags are negative numbers, so whenever a number >= 0 is returned
+* it means that arrays differ.
+*
+* ```ts
+* compareArrays( [ 0, 2 ], [ 0, 2 ] );		// 'same'
+* compareArrays( [ 0, 2 ], [ 0, 2, 1 ] );		// 'prefix'
+* compareArrays( [ 0, 2 ], [ 0 ] );			// 'extension'
+* compareArrays( [ 0, 2 ], [ 1, 2 ] );		// 0
+* compareArrays( [ 0, 2 ], [ 0, 1 ] );		// 1
+* ```
+*
+* @param a Array that is compared.
+* @param b Array to compare with.
+* @returns How array `a` is related to `b`.
+*/
 export declare function compareArrays(a: ReadonlyArray<unknown>, b: ReadonlyArray<unknown>): ArrayRelation | number;
 /**
- * Array relation.
- */
-export type ArrayRelation = 'extension' | 'same' | 'prefix';
+* Array relation.
+*/
+export type ArrayRelation = "extension" | "same" | "prefix";

package/dist/config.d.ts

@@ -1,163 +1,166 @@
 /**
- * @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
+*/
 /**
- * Handles a configuration dictionary.
- *
- * @typeParam Cfg A type of the configuration dictionary.
- */
+* Handles a configuration dictionary.
+*
+* @typeParam Cfg A type of the configuration dictionary.
+*/
 export declare class Config<Cfg> {
-    /**
-     * Store for the whole configuration.
-     */
-    private readonly _config;
-    /**
-     * Creates an instance of the {@link ~Config} class.
-     *
-     * @param configurations The initial configurations to be set. Usually, provided by the user.
-     * @param defaultConfigurations The default configurations. Usually, provided by the system.
-     */
-    constructor(configurations?: Partial<Cfg>, defaultConfigurations?: Partial<Cfg>);
-    /**
-     * Set configuration values.
-     *
-     * It also accepts setting a "deep configuration" by using dots in the name. For example, `'resize.width'` sets
-     * the value for the `width` configuration in the `resize` subset.
-     *
-     * ```ts
-     * config.set( 'resize.width', 500 );
-     * ```
-     *
-     * It accepts both a name/value pair or an object, which properties and values will be used to set
-     * configurations. See {@link #set:CONFIG_OBJECT}.
-     *
-     * @label KEY_VALUE
-     * @param name The configuration name. Configuration names are case-sensitive.
-     * @param value The configuration value.
-     */
-    set<K extends string>(name: K, value: GetSubConfig<Cfg, K>): void;
-    /**
-     * Set configuration values.
-     *
-     * It accepts an object, which properties and values will be used to set configurations.
-     *
-     * ```ts
-     * config.set( {
-     * 	width: 500
-     * 	toolbar: {
-     * 		collapsed: true
-     * 	}
-     * } );
-     *
-     * // Equivalent to:
-     * config.set( 'width', 500 );
-     * config.set( 'toolbar.collapsed', true );
-     * ```
-     *
-     * Passing an object as the value will amend the configuration, not replace it.
-     *
-     * ```ts
-     * config.set( 'toolbar', {
-     * 	collapsed: true,
-     * } );
-     *
-     * config.set( 'toolbar', {
-     * 	color: 'red',
-     * } );
-     *
-     * config.get( 'toolbar.collapsed' ); // true
-     * config.get( 'toolbar.color' ); // 'red'
-     * ```
-     *
-     * It accepts both a name/value pair or an object, which properties and values will be used to set
-     * configurations. See {@link #set:KEY_VALUE}.
-     *
-     * @label CONFIG_OBJECT
-     * @param config The configuration object from which take properties as
-     * configuration entries. Configuration names are case-sensitive.
-     */
-    set(config: Partial<Cfg>): void;
-    /**
-     * Does exactly the same as {@link #set:KEY_VALUE} with one exception – passed configuration extends
-     * existing one, but does not overwrite already defined values.
-     *
-     * This method is supposed to be called by plugin developers to setup plugin's configurations. It would be
-     * rarely used for other needs.
-     *
-     * @label KEY_VALUE
-     * @param name The configuration name. Configuration names are case-sensitive.
-     * @param value The configuration value.
-     */
-    define<K extends string>(name: K, value: GetSubConfig<Cfg, K>): void;
-    /**
-     * Does exactly the same as {@link #set:CONFIG_OBJECT} with one exception – passed configuration extends
-     * existing one, but does not overwrite already defined values.
-     *
-     * This method is supposed to be called by plugin developers to setup plugin's configurations. It would be
-     * rarely used for other needs.
-     *
-     * @label CONFIG_OBJECT
-     * @param config The configuration object from which take properties as
-     * configuration entries. Configuration names are case-sensitive.
-     */
-    define(config: Partial<Cfg>): void;
-    /**
-     * Gets the value for a configuration entry.
-     *
-     * ```ts
-     * config.get( 'name' );
-     * ```
-     *
-     * Deep configurations can be retrieved by separating each part with a dot.
-     *
-     * ```ts
-     * config.get( 'toolbar.collapsed' );
-     * ```
-     *
-     * @param name The configuration name. Configuration names are case-sensitive.
-     * @returns The configuration value or `undefined` if the configuration entry was not found.
-     */
-    get<K extends string>(name: K): GetSubConfig<Cfg, K> | undefined;
-    /**
-     * Iterates over all top level configuration names.
-     */
-    names(): Iterable<string>;
-    /**
-     * Saves passed configuration to the specified target (nested object).
-     *
-     * @param target Nested config object.
-     * @param name The configuration name or an object from which take properties as
-     * configuration entries. Configuration names are case-sensitive.
-     * @param value The configuration value. Used if a name is passed.
-     * @param isDefine Define if passed configuration should overwrite existing one.
-     */
-    private _setToTarget;
-    /**
-     * Get specified configuration from specified source (nested object).
-     *
-     * @param source level of nested object.
-     * @param name The configuration name. Configuration names are case-sensitive.
-     * @returns The configuration value or `undefined` if the configuration entry was not found.
-     */
-    private _getFromSource;
-    /**
-     * Iterates through passed object and calls {@link #_setToTarget} method with object key and value for each property.
-     *
-     * @param target Nested config object.
-     * @param configuration Configuration data set
-     * @param isDefine Defines if passed configuration is default configuration or not.
-     */
-    private _setObjectToTarget;
+	/**
+	* Store for the whole configuration.
+	*/
+	private readonly _config;
+	/**
+	* Creates an instance of the {@link ~Config} class.
+	*
+	* @param configurations The initial configurations to be set. Usually, provided by the user.
+	* @param defaultConfigurations The default configurations. Usually, provided by the system.
+	*/
+	constructor(configurations?: Partial<Cfg>, defaultConfigurations?: Partial<Cfg>);
+	/**
+	* Set configuration values.
+	*
+	* It also accepts setting a "deep configuration" by using dots in the name. For example, `'resize.width'` sets
+	* the value for the `width` configuration in the `resize` subset.
+	*
+	* ```ts
+	* config.set( 'resize.width', 500 );
+	* ```
+	*
+	* It accepts both a name/value pair or an object, which properties and values will be used to set
+	* configurations. See {@link #set:CONFIG_OBJECT}.
+	*
+	* @label KEY_VALUE
+	* @param name The configuration name. Configuration names are case-sensitive.
+	* @param value The configuration value.
+	*/
+	set<K extends string>(name: K, value: GetSubConfig<Cfg, K>): void;
+	/**
+	* Set configuration values.
+	*
+	* It accepts an object, which properties and values will be used to set configurations.
+	*
+	* ```ts
+	* config.set( {
+	* 	width: 500
+	* 	toolbar: {
+	* 		collapsed: true
+	* 	}
+	* } );
+	*
+	* // Equivalent to:
+	* config.set( 'width', 500 );
+	* config.set( 'toolbar.collapsed', true );
+	* ```
+	*
+	* Passing an object as the value will amend the configuration, not replace it.
+	*
+	* ```ts
+	* config.set( 'toolbar', {
+	* 	collapsed: true,
+	* } );
+	*
+	* config.set( 'toolbar', {
+	* 	color: 'red',
+	* } );
+	*
+	* config.get( 'toolbar.collapsed' ); // true
+	* config.get( 'toolbar.color' ); // 'red'
+	* ```
+	*
+	* It accepts both a name/value pair or an object, which properties and values will be used to set
+	* configurations. See {@link #set:KEY_VALUE}.
+	*
+	* @label CONFIG_OBJECT
+	* @param config The configuration object from which take properties as
+	* configuration entries. Configuration names are case-sensitive.
+	*/
+	set(config: Partial<Cfg>): void;
+	/**
+	* Does exactly the same as {@link #set:KEY_VALUE} with one exception – passed configuration extends
+	* existing one, but does not overwrite already defined values.
+	*
+	* This method is supposed to be called by plugin developers to setup plugin's configurations. It would be
+	* rarely used for other needs.
+	*
+	* @label KEY_VALUE
+	* @param name The configuration name. Configuration names are case-sensitive.
+	* @param value The configuration value.
+	*/
+	define<K extends string>(name: K, value: GetSubConfig<Cfg, K>): void;
+	/**
+	* Does exactly the same as {@link #set:CONFIG_OBJECT} with one exception – passed configuration extends
+	* existing one, but does not overwrite already defined values.
+	*
+	* This method is supposed to be called by plugin developers to setup plugin's configurations. It would be
+	* rarely used for other needs.
+	*
+	* @label CONFIG_OBJECT
+	* @param config The configuration object from which take properties as
+	* configuration entries. Configuration names are case-sensitive.
+	*/
+	define(config: Partial<Cfg>): void;
+	/**
+	* Gets the value for a configuration entry.
+	*
+	* ```ts
+	* config.get( 'name' );
+	* ```
+	*
+	* Deep configurations can be retrieved by separating each part with a dot.
+	*
+	* ```ts
+	* config.get( 'toolbar.collapsed' );
+	* ```
+	*
+	* @param name The configuration name. Configuration names are case-sensitive.
+	* @returns The configuration value or `undefined` if the configuration entry was not found.
+	*/
+	get<K extends string>(name: K): GetSubConfig<Cfg, K> | undefined;
+	/**
+	* Iterates over all top level configuration names.
+	*/
+	names(): Iterable<string>;
+	/**
+	* Saves passed configuration to the specified target (nested object).
+	*
+	* @param target Nested config object.
+	* @param name The configuration name or an object from which take properties as
+	* configuration entries. Configuration names are case-sensitive.
+	* @param value The configuration value. Used if a name is passed.
+	* @param isDefine Define if passed configuration should overwrite existing one.
+	*/
+	private _setToTarget;
+	/**
+	* Get specified configuration from specified source (nested object).
+	*
+	* @param source level of nested object.
+	* @param name The configuration name. Configuration names are case-sensitive.
+	* @returns The configuration value or `undefined` if the configuration entry was not found.
+	*/
+	private _getFromSource;
+	/**
+	* Iterates through passed object and calls {@link #_setToTarget} method with object key and value for each property.
+	*
+	* @param target Nested config object.
+	* @param configuration Configuration data set
+	* @param isDefine Defines if passed configuration is default configuration or not.
+	*/
+	private _setObjectToTarget;
 }
 /**
- * An utility type excluding primitive values and arrays from the union.
- */
+* An utility type excluding primitive values and arrays from the union.
+*/
 export type OnlyObject<T> = Exclude<T, undefined | null | string | number | boolean | Array<any>>;
 /**
- * An utility type extracting configuration value from the given name.
- *
- * @typeParam T The type of a configuration dictionary.
- * @typeParam K The literal type of configuration name (dot-separated path).
- */
-export type GetSubConfig<T, K> = K extends keyof T ? T[K] : K extends `${infer K1}.${infer K2}` ? K1 extends keyof T ? GetSubConfig<OnlyObject<T[K1]>, K2> : unknown : unknown;
+* An utility type extracting configuration value from the given name.
+*
+* @typeParam T The type of a configuration dictionary.
+* @typeParam K The literal type of configuration name (dot-separated path).
+*/
+export type GetSubConfig<
+	T,
+	K
+> = K extends keyof T ? T[K] : K extends `${infer K1}.${infer K2}` ? K1 extends keyof T ? GetSubConfig<OnlyObject<T[K1]>, K2> : unknown : unknown;

package/dist/count.d.ts

@@ -1,18 +1,18 @@
 /**
- * @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/count
- */
+* @module utils/count
+*/
 /**
- * Returns the number of items return by the iterator.
- *
- * ```ts
- * count( [ 1, 2, 3, 4, 5 ] ); // 5;
- * ```
- *
- * @param iterable Any iterable.
- * @returns Number of items returned by that iterable.
- */
+* Returns the number of items return by the iterator.
+*
+* ```ts
+* count( [ 1, 2, 3, 4, 5 ] ); // 5;
+* ```
+*
+* @param iterable Any iterable.
+* @returns Number of items returned by that iterable.
+*/
 export declare function count(iterable: Iterable<unknown>): number;

package/dist/crc32.d.ts

@@ -1,25 +1,25 @@
 /**
- * @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
+*/
 /**
- * Calculates CRC-32 checksum for a given inputData to verify the integrity of data.
- *
- * @param inputData Accepts a single value (string, number, boolean), an array of strings, or an array of all of the above types.
- * Non-string values are converted to strings before calculating the checksum.
- * The checksum calculation is based on the concatenated string representation of the input values:
- * * `crc32('foo')` is equivalent to `crc32(['foo'])`
- * * `crc32(123)` is equivalent to `crc32(['123'])`
- * * `crc32(true)` is equivalent to `crc32(['true'])`
- * * `crc32(['foo', 123, true])` produces the same result as `crc32('foo123true')`
- * * Nested arrays of strings are flattened, so `crc32([['foo', 'bar'], 'baz'])` is equivalent to `crc32(['foobar', 'baz'])`
- *
- * @returns The CRC-32 checksum, returned as a hexadecimal string.
- */
+* Calculates CRC-32 checksum for a given inputData to verify the integrity of data.
+*
+* @param inputData Accepts a single value (string, number, boolean), an array of strings, or an array of all of the above types.
+* Non-string values are converted to strings before calculating the checksum.
+* The checksum calculation is based on the concatenated string representation of the input values:
+* * `crc32('foo')` is equivalent to `crc32(['foo'])`
+* * `crc32(123)` is equivalent to `crc32(['123'])`
+* * `crc32(true)` is equivalent to `crc32(['true'])`
+* * `crc32(['foo', 123, true])` produces the same result as `crc32('foo123true')`
+* * Nested arrays of strings are flattened, so `crc32([['foo', 'bar'], 'baz'])` is equivalent to `crc32(['foobar', 'baz'])`
+*
+* @returns The CRC-32 checksum, returned as a hexadecimal string.
+*/
 export declare function crc32(inputData: CRCData): string;
 /**
- * The input data for the CRC-32 checksum calculation.
- * Can be a single value (string, number, boolean), an array of strings, or an array of all of the above types.
- */
+* The input data for the CRC-32 checksum calculation.
+* Can be a single value (string, number, boolean), an array of strings, or an array of all of the above types.
+*/
 export type CRCData = CRCValue | Array<CRCValue>;
 export type CRCValue = string | number | boolean | Array<string>;

package/dist/decodelicensekey.d.ts

@@ -1,10 +1,10 @@
 /**
- * @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
+*/
 /**
- * Parses the provided license key and returns the decoded object, or null if the decoding was unsuccessful.
- *
- * @param licenseKey The license key to decode.
- */
+* Parses the provided license key and returns the decoded object, or null if the decoding was unsuccessful.
+*
+* @param licenseKey The license key to decode.
+*/
 export declare function decodeLicenseKey(licenseKey?: string): Record<string, any> | null;

package/dist/delay.d.ts

@@ -1,19 +1,19 @@
 /**
- * @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/delay
- */
+* @module utils/delay
+*/
 /**
- * Returns a function wrapper that will trigger a function after a specified wait time.
- * The timeout can be canceled by calling the cancel function on the returned wrapped function.
- *
- * @param func The function to wrap.
- * @param wait The timeout in ms.
- */
+* Returns a function wrapper that will trigger a function after a specified wait time.
+* The timeout can be canceled by calling the cancel function on the returned wrapped function.
+*
+* @param func The function to wrap.
+* @param wait The timeout in ms.
+*/
 export declare function delay<T extends (...args: Array<any>) => any>(func: T, wait: number): DelayedFunc<T>;
 export interface DelayedFunc<T extends (...args: Array<any>) => any> {
-    (...args: Parameters<T>): void;
-    cancel(): void;
+	(...args: Parameters<T>): void;
+	cancel(): void;
 }

package/dist/diff.d.ts

@@ -1,30 +1,35 @@
 /**
- * @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
+*/
 /**
- * Calculates the difference between two arrays or strings producing an array containing a list of changes
- * necessary to transform input into output.
- *
- * ```ts
- * diff( 'aba', 'acca' ); // [ 'equal', 'insert', 'insert', 'delete', 'equal' ]
- * ```
- *
- * This function is based on the "O(NP) Sequence Comparison Algorithm" by Sun Wu, Udi Manber, Gene Myers, Webb Miller.
- * Unfortunately, while it gives the most precise results, its to complex for longer strings/arrow (above 200 items).
- * Therefore, `diff()` automatically switches to {@link module:utils/fastdiff~fastDiff `fastDiff()`} when detecting
- * such a scenario. The return formats of both functions are identical.
- *
- * @param a Input array or string.
- * @param b Output array or string.
- * @param cmp Optional function used to compare array values, by default === is used.
- * @returns Array of changes.
- */
-export declare function diff<T>(a: ArrayLike<T>, b: ArrayLike<T>, cmp?: (a: T, b: T) => boolean): Array<DiffResult>;
-export declare namespace diff {
-    var fastDiff: typeof import("./fastdiff.js").fastDiff;
-}
+* @module utils/diff
+*/
+import { fastDiff as fastDiffFunction } from "./fastdiff.js";
+export type Diff = {
+	<T>(a: ArrayLike<T>, b: ArrayLike<T>, cmp?: (a: T, b: T) => boolean): Array<DiffResult>;
+	fastDiff: typeof fastDiffFunction;
+};
 /**
- * The element of the result of {@link module:utils/diff~diff} function.
- */
-export type DiffResult = 'equal' | 'insert' | 'delete';
+* Calculates the difference between two arrays or strings producing an array containing a list of changes
+* necessary to transform input into output.
+*
+* ```ts
+* diff( 'aba', 'acca' ); // [ 'equal', 'insert', 'insert', 'delete', 'equal' ]
+* ```
+*
+* This function is based on the "O(NP) Sequence Comparison Algorithm" by Sun Wu, Udi Manber, Gene Myers, Webb Miller.
+* Unfortunately, while it gives the most precise results, its to complex for longer strings/arrow (above 200 items).
+* Therefore, `diff()` automatically switches to {@link module:utils/fastdiff~fastDiff `fastDiff()`} when detecting
+* such a scenario. The return formats of both functions are identical.
+*
+* @param a Input array or string.
+* @param b Output array or string.
+* @param cmp Optional function used to compare array values, by default === is used.
+* @returns Array of changes.
+*/
+export declare const diff: Diff;
+/**
+* The element of the result of {@link module:utils/diff~diff} function.
+*/
+export type DiffResult = "equal" | "insert" | "delete";