@ckeditor/ckeditor5-utils 48.2.0-alpha.7 → 48.3.0-alpha.0

package/dist/env.d.ts

@@ -1,154 +1,154 @@
 /**
- * @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
+*/
 /**
- * Safely returns `userAgent` from browser's navigator API in a lower case.
- * If navigator API is not available it will return an empty string.
- *
- * @internal
- */
+* Safely returns `userAgent` from browser's navigator API in a lower case.
+* If navigator API is not available it will return an empty string.
+*
+* @internal
+*/
 export declare function getUserAgent(): string;
 /**
- * A namespace containing environment and browser information.
- */
+* A namespace containing environment and browser information.
+*/
 export interface EnvType {
-    /**
-     * Indicates that the application is running on Macintosh.
-     */
-    readonly isMac: boolean;
-    /**
-     * Indicates that the application is running on Windows.
-     */
-    readonly isWindows: boolean;
-    /**
-     * Indicates that the application is running in Firefox (Gecko).
-     */
-    readonly isGecko: boolean;
-    /**
-     * Indicates that the application is running in Safari.
-     */
-    readonly isSafari: boolean;
-    /**
-     * Indicates that the application is running in iOS.
-     */
-    readonly isiOS: boolean;
-    /**
-     * Indicates that the application is running on Android mobile device.
-     */
-    readonly isAndroid: boolean;
-    /**
-     * Indicates that the application is running in a browser using the Blink engine.
-     */
-    readonly isBlink: boolean;
-    /**
-     * Indicates that the user agent has enabled a forced colors mode (e.g. Windows High Contrast mode).
-     *
-     * Note that the value of this property is evaluated each time it is accessed, and it may change over time, if the environment
-     * settings have changed.
-     */
-    readonly isMediaForcedColors: boolean;
-    /**
-     * Indicates that "prefer reduced motion" browser setting is active.
-     *
-     * Note that the value of this property is evaluated each time it is accessed, and it may change over time, if the environment
-     * settings have changed.
-     */
-    readonly isMotionReduced: boolean;
-    /**
-     * Environment features information.
-     */
-    readonly features: EnvFeaturesType;
+	/**
+	* Indicates that the application is running on Macintosh.
+	*/
+	readonly isMac: boolean;
+	/**
+	* Indicates that the application is running on Windows.
+	*/
+	readonly isWindows: boolean;
+	/**
+	* Indicates that the application is running in Firefox (Gecko).
+	*/
+	readonly isGecko: boolean;
+	/**
+	* Indicates that the application is running in Safari.
+	*/
+	readonly isSafari: boolean;
+	/**
+	* Indicates that the application is running in iOS.
+	*/
+	readonly isiOS: boolean;
+	/**
+	* Indicates that the application is running on Android mobile device.
+	*/
+	readonly isAndroid: boolean;
+	/**
+	* Indicates that the application is running in a browser using the Blink engine.
+	*/
+	readonly isBlink: boolean;
+	/**
+	* Indicates that the user agent has enabled a forced colors mode (e.g. Windows High Contrast mode).
+	*
+	* Note that the value of this property is evaluated each time it is accessed, and it may change over time, if the environment
+	* settings have changed.
+	*/
+	readonly isMediaForcedColors: boolean;
+	/**
+	* Indicates that "prefer reduced motion" browser setting is active.
+	*
+	* Note that the value of this property is evaluated each time it is accessed, and it may change over time, if the environment
+	* settings have changed.
+	*/
+	readonly isMotionReduced: boolean;
+	/**
+	* Environment features information.
+	*/
+	readonly features: EnvFeaturesType;
 }
 export interface EnvFeaturesType {
-    /**
-     * Indicates that the environment supports ES2018 Unicode property escapes — like `\p{P}` or `\p{L}`.
-     * More information about unicode properties might be found
-     * [in Unicode Standard Annex #44](https://www.unicode.org/reports/tr44/#GC_Values_Table).
-     */
-    readonly isRegExpUnicodePropertySupported: boolean;
+	/**
+	* Indicates that the environment supports ES2018 Unicode property escapes — like `\p{P}` or `\p{L}`.
+	* More information about unicode properties might be found
+	* [in Unicode Standard Annex #44](https://www.unicode.org/reports/tr44/#GC_Values_Table).
+	*/
+	readonly isRegExpUnicodePropertySupported: boolean;
 }
 /**
- * A namespace containing environment and browser information.
- */
+* A namespace containing environment and browser information.
+*/
 export declare const env: EnvType;
 /**
- * Checks if User Agent represented by the string is running on Macintosh.
- *
- * @internal
- * @param userAgent **Lowercase** `navigator.userAgent` string.
- * @returns Whether User Agent is running on Macintosh or not.
- */
+* Checks if User Agent represented by the string is running on Macintosh.
+*
+* @internal
+* @param userAgent **Lowercase** `navigator.userAgent` string.
+* @returns Whether User Agent is running on Macintosh or not.
+*/
 export declare function isMac(userAgent: string): boolean;
 /**
- * Checks if User Agent represented by the string is running on Windows.
- *
- * @internal
- * @param userAgent **Lowercase** `navigator.userAgent` string.
- * @returns Whether User Agent is running on Windows or not.
- */
+* Checks if User Agent represented by the string is running on Windows.
+*
+* @internal
+* @param userAgent **Lowercase** `navigator.userAgent` string.
+* @returns Whether User Agent is running on Windows or not.
+*/
 export declare function isWindows(userAgent: string): boolean;
 /**
- * Checks if User Agent represented by the string is Firefox (Gecko).
- *
- * @internal
- * @param userAgent **Lowercase** `navigator.userAgent` string.
- * @returns Whether User Agent is Firefox or not.
- */
+* Checks if User Agent represented by the string is Firefox (Gecko).
+*
+* @internal
+* @param userAgent **Lowercase** `navigator.userAgent` string.
+* @returns Whether User Agent is Firefox or not.
+*/
 export declare function isGecko(userAgent: string): boolean;
 /**
- * Checks if User Agent represented by the string is Safari.
- *
- * @internal
- * @param userAgent **Lowercase** `navigator.userAgent` string.
- * @returns Whether User Agent is Safari or not.
- */
+* Checks if User Agent represented by the string is Safari.
+*
+* @internal
+* @param userAgent **Lowercase** `navigator.userAgent` string.
+* @returns Whether User Agent is Safari or not.
+*/
 export declare function isSafari(userAgent: string): boolean;
 /**
- * Checks if User Agent represented by the string is running in iOS.
- *
- * @internal
- * @param userAgent **Lowercase** `navigator.userAgent` string.
- * @returns Whether User Agent is running in iOS or not.
- */
+* Checks if User Agent represented by the string is running in iOS.
+*
+* @internal
+* @param userAgent **Lowercase** `navigator.userAgent` string.
+* @returns Whether User Agent is running in iOS or not.
+*/
 export declare function isiOS(userAgent: string): boolean;
 /**
- * Checks if User Agent represented by the string is Android mobile device.
- *
- * @internal
- * @param userAgent **Lowercase** `navigator.userAgent` string.
- * @returns Whether User Agent is Safari or not.
- */
+* Checks if User Agent represented by the string is Android mobile device.
+*
+* @internal
+* @param userAgent **Lowercase** `navigator.userAgent` string.
+* @returns Whether User Agent is Safari or not.
+*/
 export declare function isAndroid(userAgent: string): boolean;
 /**
- * Checks if User Agent represented by the string is Blink engine.
- *
- * @internal
- * @param userAgent **Lowercase** `navigator.userAgent` string.
- * @returns Whether User Agent is Blink engine or not.
- */
+* Checks if User Agent represented by the string is Blink engine.
+*
+* @internal
+* @param userAgent **Lowercase** `navigator.userAgent` string.
+* @returns Whether User Agent is Blink engine or not.
+*/
 export declare function isBlink(userAgent: string): boolean;
 /**
- * Checks if the current environment supports ES2018 Unicode properties like `\p{P}` or `\p{L}`.
- * More information about unicode properties might be found
- * [in Unicode Standard Annex #44](https://www.unicode.org/reports/tr44/#GC_Values_Table).
- *
- * @internal
- */
+* Checks if the current environment supports ES2018 Unicode properties like `\p{P}` or `\p{L}`.
+* More information about unicode properties might be found
+* [in Unicode Standard Annex #44](https://www.unicode.org/reports/tr44/#GC_Values_Table).
+*
+* @internal
+*/
 export declare function isRegExpUnicodePropertySupported(): boolean;
 /**
- * Checks if the user agent has enabled a forced colors mode (e.g. Windows High Contrast mode).
- *
- * Returns `false` in environments where `window` global object is not available.
- *
- * @internal
- */
+* Checks if the user agent has enabled a forced colors mode (e.g. Windows High Contrast mode).
+*
+* Returns `false` in environments where `window` global object is not available.
+*
+* @internal
+*/
 export declare function isMediaForcedColors(): boolean;
 /**
- * Checks if the user enabled "prefers reduced motion" setting in browser.
- *
- * Returns `false` in environments where `window` global object is not available.
- *
- * @internal
- */
+* Checks if the user enabled "prefers reduced motion" setting in browser.
+*
+* Returns `false` in environments where `window` global object is not available.
+*
+* @internal
+*/
 export declare function isMotionReduced(): boolean;

package/dist/eventinfo.d.ts

@@ -1,58 +1,61 @@
 /**
- * @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
+*/
 /**
- * The event object passed to event callbacks. It is used to provide information about the event as well as a tool to
- * manipulate it.
- */
-export declare class EventInfo<TName extends string = string, TReturn = unknown> {
-    /**
-     * The object that fired the event.
-     */
-    readonly source: object;
-    /**
-     * The event name.
-     */
-    readonly name: TName;
-    /**
-     * Path this event has followed. See {@link module:utils/emittermixin~Emitter#delegate}.
-     */
-    path: Array<object>;
-    /**
-     * Stops the event emitter to call further callbacks for this event interaction.
-     */
-    readonly stop: {
-        (): void;
-        called?: boolean;
-    };
-    /**
-     * Removes the current callback from future interactions of this event.
-     */
-    readonly off: {
-        (): void;
-        called?: boolean;
-    };
-    /**
-     * The value which will be returned by {@link module:utils/emittermixin~Emitter#fire}.
-     *
-     * It's `undefined` by default and can be changed by an event listener:
-     *
-     * ```ts
-     * dataController.fire( 'getSelectedContent', ( evt ) => {
-     * 	// This listener will make `dataController.fire( 'getSelectedContent' )`
-     * 	// always return an empty DocumentFragment.
-     * 	evt.return = new DocumentFragment();
-     *
-     * 	// Make sure no other listeners are executed.
-     * 	evt.stop();
-     * } );
-     * ```
-     */
-    return: TReturn | undefined;
-    /**
-     * @param source The emitter.
-     * @param name The event name.
-     */
-    constructor(source: object, name: TName);
+* The event object passed to event callbacks. It is used to provide information about the event as well as a tool to
+* manipulate it.
+*/
+export declare class EventInfo<
+	TName extends string = string,
+	TReturn = unknown
+> {
+	/**
+	* The object that fired the event.
+	*/
+	readonly source: object;
+	/**
+	* The event name.
+	*/
+	readonly name: TName;
+	/**
+	* Path this event has followed. See {@link module:utils/emittermixin~Emitter#delegate}.
+	*/
+	path: Array<object>;
+	/**
+	* Stops the event emitter to call further callbacks for this event interaction.
+	*/
+	readonly stop: {
+		(): void;
+		called?: boolean;
+	};
+	/**
+	* Removes the current callback from future interactions of this event.
+	*/
+	readonly off: {
+		(): void;
+		called?: boolean;
+	};
+	/**
+	* The value which will be returned by {@link module:utils/emittermixin~Emitter#fire}.
+	*
+	* It's `undefined` by default and can be changed by an event listener:
+	*
+	* ```ts
+	* dataController.fire( 'getSelectedContent', ( evt ) => {
+	* 	// This listener will make `dataController.fire( 'getSelectedContent' )`
+	* 	// always return an empty DocumentFragment.
+	* 	evt.return = new DocumentFragment();
+	*
+	* 	// Make sure no other listeners are executed.
+	* 	evt.stop();
+	* } );
+	* ```
+	*/
+	return: TReturn | undefined;
+	/**
+	* @param source The emitter.
+	* @param name The event name.
+	*/
+	constructor(source: object, name: TName);
 }

package/dist/fastdiff.d.ts

@@ -1,112 +1,115 @@
 /**
- * @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/fastdiff
- */
-import type { DiffResult } from './diff.js';
-import type { Change } from './difftochanges.js';
+* @module utils/fastdiff
+*/
+import type { DiffResult } from "./diff.js";
+import type { Change } from "./difftochanges.js";
 /**
- * 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 declare 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>>;
+* 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 declare 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/first.d.ts

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