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

package/dist/parsebase64encodedobject.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/parsebase64encodedobject
- */
+* @module utils/parsebase64encodedobject
+*/
 /**
- * Parses a base64-encoded object and returns the decoded object, or null if the decoding was unsuccessful.
- */
+* Parses a base64-encoded object and returns the decoded object, or null if the decoding was unsuccessful.
+*/
 export declare function parseBase64EncodedObject(encoded: string): Record<string, any> | null;

package/dist/parsedimensionwithunit.d.ts

@@ -0,0 +1,40 @@
+/**
+* @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/parsedimensionwithunit
+*/
+/**
+* Parses provided string with dimension value and returns extracted numeric value and unit.
+*
+* 	* If non-string dimension is passed then `null` value is returned.
+* 	* If unit is missing then `null` is returned.
+* 	* If numeric value part of string is not a number then `null` is returned.
+*
+* Example:
+* 	`"222px"` => `{ value: 222, unit: "px" }`
+*	`"99%"` => `{ value: 99, unit: "%" }`
+
+* @param dimension Unsafe string with dimension.
+* @returns Parsed dimension with extracted numeric value and units.
+* @internal
+*/
+export declare function tryParseDimensionWithUnit(dimension: string | null | undefined): DimensionWithUnit | null;
+/**
+* Converts dimension between `px` -> `%` and `%` -> `px`.
+*
+* @param parentDimensionPx	Dimension of parent element that contains measured element.
+* @param dimension Measured element dimension.
+* @param targetUnit Target unit for conversion.
+* @returns Casted dimension.
+* @internal
+*/
+export declare function tryCastDimensionsToUnit(parentDimensionPx: number, dimension: DimensionWithUnit, targetUnit: string): DimensionWithUnit;
+/**
+* @internal
+*/
+export type DimensionWithUnit = {
+	value: number;
+	unit: string;
+};

package/dist/priorities.d.ts

@@ -1,32 +1,32 @@
 /**
- * @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/priorities
- */
+* @module utils/priorities
+*/
 /**
- * String representing a priority value.
- */
-export type PriorityString = 'highest' | 'high' | 'normal' | 'low' | 'lowest' | number;
+* String representing a priority value.
+*/
+export type PriorityString = "highest" | "high" | "normal" | "low" | "lowest" | number;
 /**
- * Provides group of constants to use instead of hardcoding numeric priority values.
- */
+* Provides group of constants to use instead of hardcoding numeric priority values.
+*/
 export interface PrioritiesType {
-    /**
-     * Converts a string with priority name to it's numeric value. If `Number` is given, it just returns it.
-     *
-     * @param priority Priority to convert.
-     * @returns Converted priority.
-     */
-    get(priority?: PriorityString): number;
-    readonly highest: number;
-    readonly high: number;
-    readonly normal: number;
-    readonly low: number;
-    readonly lowest: number;
+	/**
+	* Converts a string with priority name to it's numeric value. If `Number` is given, it just returns it.
+	*
+	* @param priority Priority to convert.
+	* @returns Converted priority.
+	*/
+	get(priority?: PriorityString): number;
+	readonly highest: number;
+	readonly high: number;
+	readonly normal: number;
+	readonly low: number;
+	readonly lowest: number;
 }
 /**
- * Provides group of constants to use instead of hardcoding numeric priority values.
- */
+* Provides group of constants to use instead of hardcoding numeric priority values.
+*/
 export declare const priorities: PrioritiesType;

package/dist/retry.d.ts

@@ -1,34 +1,34 @@
 /**
- * @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
+*/
 /**
- * Tries calling the given callback until it sucessfully resolves.
- *
- * If the callback fails `maxAttempts` times, the returned promise is rejected with the last error.
- *
- * @typeParam TResult The result of a successful callback invocation.
- * @param callback The function to call until it succeeds.
- * @param options Configuration options.
- * @param options.maxAttempts Maximum number of attempts.
- * @param options.retryDelay The time in milliseconds between attempts. By default it implements exponential back-off policy.
- * @param options.signal The signal to abort further retries. The callback itself is not aborted automatically.
- */
+* Tries calling the given callback until it sucessfully resolves.
+*
+* If the callback fails `maxAttempts` times, the returned promise is rejected with the last error.
+*
+* @typeParam TResult The result of a successful callback invocation.
+* @param callback The function to call until it succeeds.
+* @param options Configuration options.
+* @param options.maxAttempts Maximum number of attempts.
+* @param options.retryDelay The time in milliseconds between attempts. By default it implements exponential back-off policy.
+* @param options.signal The signal to abort further retries. The callback itself is not aborted automatically.
+*/
 export declare function retry<TResult>(callback: () => Promise<TResult>, options?: {
-    maxAttempts?: number;
-    retryDelay?: (attempt: number) => number;
-    signal?: AbortSignal;
+	maxAttempts?: number;
+	retryDelay?: (attempt: number) => number;
+	signal?: AbortSignal;
 }): Promise<TResult>;
 /**
- * Creates a function that calculates exponential back-off delay. Pass it as `options.retryDelay` to {@link ~retry}.
- *
- * @param options.delay Base delay between invocations. Defaults to 1s.
- * @param options.factor How much to increase the delay. Defaults to 2x.
- * @param options.maxDelay Maximum timeout. Even if higher timeout is calculated, it cannot get higher than this value. Default to 10s.
- * @returns The function calculating the delay.
- */
+* Creates a function that calculates exponential back-off delay. Pass it as `options.retryDelay` to {@link ~retry}.
+*
+* @param options.delay Base delay between invocations. Defaults to 1s.
+* @param options.factor How much to increase the delay. Defaults to 2x.
+* @param options.maxDelay Maximum timeout. Even if higher timeout is calculated, it cannot get higher than this value. Default to 10s.
+* @returns The function calculating the delay.
+*/
 export declare function exponentialDelay(options?: {
-    delay?: number;
-    factor?: number;
-    maxDelay?: number;
+	delay?: number;
+	factor?: number;
+	maxDelay?: number;
 }): (attempt: number) => number;

package/dist/splicearray.d.ts

@@ -1,26 +1,26 @@
 /**
- * @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/splicearray
- */
+* @module utils/splicearray
+*/
 /**
- * Splices one array into another. To be used instead of `Array.prototype.splice` for better
- * performance and because the latter may throw "Maximum call stack size exceeded" error when
- * passing huge number of items to insert.
- *
- * ```ts
- * spliceArray( [ 1, 2 ], [ 3, 4 ], 0 );	// [ 3, 4, 1, 2 ]
- * spliceArray( [ 1, 2 ], [ 3, 4 ], 1 );	// [ 1, 3, 4, 2 ]
- * spliceArray( [ 1, 2 ], [ 3, 4 ], 2 );	// [ 1, 2, 3, 4 ]
- * spliceArray( [ 1, 2 ], [],       0 );	// [ 1, 2 ]
- * ```
- *
- * @param targetArray Array to be spliced.
- * @param insertArray Array of elements to be inserted to target.
- * @param index Index at which nodes should be inserted.
- *
- * @returns New spliced array.
- */
+* Splices one array into another. To be used instead of `Array.prototype.splice` for better
+* performance and because the latter may throw "Maximum call stack size exceeded" error when
+* passing huge number of items to insert.
+*
+* ```ts
+* spliceArray( [ 1, 2 ], [ 3, 4 ], 0 );	// [ 3, 4, 1, 2 ]
+* spliceArray( [ 1, 2 ], [ 3, 4 ], 1 );	// [ 1, 3, 4, 2 ]
+* spliceArray( [ 1, 2 ], [ 3, 4 ], 2 );	// [ 1, 2, 3, 4 ]
+* spliceArray( [ 1, 2 ], [],       0 );	// [ 1, 2 ]
+* ```
+*
+* @param targetArray Array to be spliced.
+* @param insertArray Array of elements to be inserted to target.
+* @param index Index at which nodes should be inserted.
+*
+* @returns New spliced array.
+*/
 export declare function spliceArray<T>(targetArray: Array<T>, insertArray: Array<T>, index: number): void;

package/dist/spy.d.ts

@@ -1,20 +1,20 @@
 /**
- * @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/spy
- */
+* @module utils/spy
+*/
 /**
- * Creates a spy function (ala Sinon.js) that can be used to inspect call to it.
- *
- * The following are the present features:
- *
- * * spy.called: property set to `true` if the function has been called at least once.
- *
- * @returns The spy function.
- */
+* Creates a spy function (ala Sinon.js) that can be used to inspect call to it.
+*
+* The following are the present features:
+*
+* * spy.called: property set to `true` if the function has been called at least once.
+*
+* @returns The spy function.
+*/
 export declare function spy(): {
-    (): void;
-    called?: boolean;
+	(): void;
+	called?: boolean;
 };

package/dist/toarray.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
+*/
 /**
- * @module utils/toarray
- */
+* @module utils/toarray
+*/
 /**
- * Transforms any value to an array. If the provided value is already an array, it is returned unchanged.
- *
- * @label MUTABLE
- * @param data The value to transform to an array.
- * @returns An array created from data.
- */
+* Transforms any value to an array. If the provided value is already an array, it is returned unchanged.
+*
+* @label MUTABLE
+* @param data The value to transform to an array.
+* @returns An array created from data.
+*/
 export declare function toArray<T>(data: ArrayOrItem<T>): Array<T>;
 /**
- * Transforms any value to an array. If the provided value is already an array, it is returned unchanged.
- *
- * @label IMMUTABLE
- * @param data The value to transform to an array.
- * @returns An array created from data.
- */
+* Transforms any value to an array. If the provided value is already an array, it is returned unchanged.
+*
+* @label IMMUTABLE
+* @param data The value to transform to an array.
+* @returns An array created from data.
+*/
 export declare function toArray<T>(data: ReadonlyArrayOrItem<T>): ReadonlyArray<T>;
 export type ArrayOrItem<T> = T | Array<T>;
 export type ReadonlyArrayOrItem<T> = T | ReadonlyArray<T>;

package/dist/tomap.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
+*/
 /**
- * Transforms object or iterable to map. Iterable needs to be in the format acceptable by the `Map` constructor.
- *
- * ```ts
- * map = toMap( { 'foo': 1, 'bar': 2 } );
- * map = toMap( [ [ 'foo', 1 ], [ 'bar', 2 ] ] );
- * map = toMap( anotherMap );
- * ```
- *
- * @param data Object or iterable to transform.
- * @returns Map created from data.
- */
+* Transforms object or iterable to map. Iterable needs to be in the format acceptable by the `Map` constructor.
+*
+* ```ts
+* map = toMap( { 'foo': 1, 'bar': 2 } );
+* map = toMap( [ [ 'foo', 1 ], [ 'bar', 2 ] ] );
+* map = toMap( anotherMap );
+* ```
+*
+* @param data Object or iterable to transform.
+* @returns Map created from data.
+*/
 export declare function toMap<T>(data: {
-    readonly [key: string]: T;
+	readonly [key: string]: T;
 } | Iterable<readonly [string, T]> | null | undefined): Map<string, T>;