@ckeditor/ckeditor5-utils 48.8.1-alpha.3 → 49.0.0-alpha.0

package/LICENSE.md

@@ -18,7 +18,7 @@ Where not otherwise indicated, all CKEditor 5 content is authored by CKSour
 
 The following libraries are included in CKEditor 5 under the [MIT license](https://opensource.org/licenses/MIT):
 
-* es-toolkit - Copyright (c) 2024 Viva Republica, Inc and Copyright OpenJS Foundation and other contributors.
+* es-toolkit - Copyright (c) 2024 Viva Republica, Inc.
 
 Trademarks
 ----------

package/dist/abortabledebounce.d.ts

@@ -1,17 +1,23 @@
 /**
- * @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/abortabledebounce
- */
+* @module utils/abortabledebounce
+*/
 /**
- * Returns a function wrapper that will execute the provided function and abort any previous call that is still in progress.
- *
- * @param func The function to be called. It will be provided with `AbortSignal` as the first parameter.
- */
-export declare function abortableDebounce<Args extends Array<any>, Ret>(func: (signal: AbortSignal, ...args: Args) => Ret): AbortableFunc<Args, Ret>;
-export interface AbortableFunc<Args extends Array<any>, Ret> {
-    (...args: Args): Ret;
-    abort(): void;
+* Returns a function wrapper that will execute the provided function and abort any previous call that is still in progress.
+*
+* @param func The function to be called. It will be provided with `AbortSignal` as the first parameter.
+*/
+export declare function abortableDebounce<
+	Args extends Array<any>,
+	Ret
+>(func: (signal: AbortSignal, ...args: Args) => Ret): AbortableFunc<Args, Ret>;
+export interface AbortableFunc<
+	Args extends Array<any>,
+	Ret
+> {
+	(...args: Args): Ret;
+	abort(): void;
 }

package/dist/areconnectedthroughproperties.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/areconnectedthroughproperties
- */
+* @module utils/areconnectedthroughproperties
+*/
 /**
- * Traverses both structures to find out whether there is a reference that is shared between both structures.
- */
+* Traverses both structures to find out whether there is a reference that is shared between both structures.
+*/
 export declare function areConnectedThroughProperties(obj1: object, obj2: object): boolean;

package/dist/ckeditorerror.d.ts

@@ -1,124 +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
+*/
 /**
- * @module utils/ckeditorerror
- */
+* @module utils/ckeditorerror
+*/
 /**
- * URL to the documentation with error codes.
- */
+* URL to the documentation with error codes.
+*/
 export declare const DOCUMENTATION_URL = "https://ckeditor.com/docs/ckeditor5/latest/support/error-codes.html";
 /**
- * The CKEditor error class.
- *
- * You should throw `CKEditorError` when:
- *
- * * An unexpected situation occurred and the editor (most probably) will not work properly. Such exception will be handled
- * by the {@link module:watchdog/watchdog~Watchdog watchdog} (if it is integrated),
- * * If the editor is incorrectly integrated or the editor API is used in the wrong way. This way you will give
- * feedback to the developer as soon as possible. Keep in mind that for common integration issues which should not
- * stop editor initialization (like missing upload adapter, wrong name of a toolbar component) we use
- * {@link module:utils/ckeditorerror~logWarning `logWarning()`} and
- * {@link module:utils/ckeditorerror~logError `logError()`}
- * to improve developers experience and let them see the a working editor as soon as possible.
- *
- * ```ts
- * /**
- *  * Error thrown when a plugin cannot be loaded due to JavaScript errors, lack of plugins with a given name, etc.
- *  *
- *  * @error plugin-load
- *  * @param pluginName The name of the plugin that could not be loaded.
- *  * @param moduleName The name of the module which tried to load this plugin.
- *  *\/
- * throw new CKEditorError( 'plugin-load', {
- * 	pluginName: 'foo',
- * 	moduleName: 'bar'
- * } );
- * ```
- */
+* The CKEditor error class.
+*
+* You should throw `CKEditorError` when:
+*
+* * An unexpected situation occurred and the editor (most probably) will not work properly. Such exception will be
+* reported to the callbacks registered with {@link module:core/errorreporter~onEditorError `onEditorError()`},
+* * If the editor is incorrectly integrated or the editor API is used in the wrong way. This way you will give
+* feedback to the developer as soon as possible. Keep in mind that for common integration issues which should not
+* stop editor initialization (like missing upload adapter, wrong name of a toolbar component) we use
+* {@link module:utils/ckeditorerror~logWarning `logWarning()`} and
+* {@link module:utils/ckeditorerror~logError `logError()`}
+* to improve developers experience and let them see the a working editor as soon as possible.
+*
+* ```ts
+* /**
+*  * Error thrown when a plugin cannot be loaded due to JavaScript errors, lack of plugins with a given name, etc.
+*  *
+*  * @error plugin-load
+*  * @param pluginName The name of the plugin that could not be loaded.
+*  * @param moduleName The name of the module which tried to load this plugin.
+*  *\/
+* throw new CKEditorError( 'plugin-load', {
+* 	pluginName: 'foo',
+* 	moduleName: 'bar'
+* } );
+* ```
+*/
 export declare class CKEditorError extends Error {
-    /**
-     * A context of the error by which the Watchdog is able to determine which editor crashed.
-     */
-    readonly context: object | null | undefined;
-    /**
-     * The additional error data passed to the constructor. Undefined if none was passed.
-     */
-    readonly data?: object;
-    /**
-     * Creates an instance of the CKEditorError class.
-     *
-     * @param errorName The error id in an `error-name` format. A link to this error documentation page will be added
-     * to the thrown error's `message`.
-     * @param context A context of the error by which the {@link module:watchdog/watchdog~Watchdog watchdog}
-     * is able to determine which editor crashed. It should be an editor instance or a property connected to it. It can be also
-     * a `null` value if the editor should not be restarted in case of the error (e.g. during the editor initialization).
-     * The error context should be checked using the `areConnectedThroughProperties( editor, context )` utility
-     * to check if the object works as the context.
-     * @param data Additional data describing the error. A stringified version of this object
-     * will be appended to the error message, so the data are quickly visible in the console. The original
-     * data object will also be later available under the {@link #data} property.
-     * @param originalError An optional original error that is being wrapped in the `CKEditorError` instance.
-     */
-    constructor(errorName: string, context?: object | null, data?: object, originalError?: Error);
-    /**
-     * Checks if the error is of the `CKEditorError` type.
-     */
-    is(type: string): boolean;
-    /**
-     * A utility that ensures that the thrown error is a {@link module:utils/ckeditorerror~CKEditorError} one.
-     * It is useful when combined with the {@link module:watchdog/watchdog~Watchdog} feature, which can restart the editor in case
-     * of a {@link module:utils/ckeditorerror~CKEditorError} error.
-     *
-     * @param error The error to rethrow.
-     * @param context An object connected through properties with the editor instance. This context will be used
-     * by the watchdog to verify which editor should be restarted.
-     */
-    static rethrowUnexpectedError(error: Error, context: object): never;
+	/**
+	* A context of the error by which error reporting works out which editor the error came from.
+	*/
+	readonly context: object | null | undefined;
+	/**
+	* The additional error data passed to the constructor. Undefined if none was passed.
+	*/
+	readonly data?: object;
+	/**
+	* Creates an instance of the CKEditorError class.
+	*
+	* @param errorName The error id in an `error-name` format. A link to this error documentation page will be added
+	* to the thrown error's `message`.
+	* @param context A context of the error by which {@link module:core/errorreporter~onEditorError error reporting}
+	* works out which editor the error came from. It should be an editor instance or a property connected to it. It can be
+	* also a `null` value if the error should not be attributed to any editor (e.g. during the editor initialization).
+	* The error context should be checked using the `areConnectedThroughProperties( editor, context )` utility
+	* to check if the object works as the context.
+	* @param data Additional data describing the error. A stringified version of this object
+	* will be appended to the error message, so the data are quickly visible in the console. The original
+	* data object will also be later available under the {@link #data} property.
+	* @param originalError An optional original error that is being wrapped in the `CKEditorError` instance.
+	*/
+	constructor(errorName: string, context?: object | null, data?: object, originalError?: Error);
+	/**
+	* Checks if the error is of the `CKEditorError` type.
+	*/
+	is(type: string): boolean;
+	/**
+	* A utility that ensures that the thrown error is a {@link module:utils/ckeditorerror~CKEditorError} one.
+	* Only a {@link module:utils/ckeditorerror~CKEditorError} is reported to the callbacks registered with
+	* {@link module:core/errorreporter~onEditorError `onEditorError()`}, so wrapping an unexpected error in one is what
+	* makes it reach them.
+	*
+	* @param error The error to rethrow.
+	* @param context An object connected through properties with the editor instance. This context is what error
+	* reporting uses to work out which editor the error came from.
+	*/
+	static rethrowUnexpectedError(error: Error, context: object): never;
 }
 /**
- * Logs a warning to the console with a properly formatted message and adds a link to the documentation.
- * Use whenever you want to log a warning to the console.
- *
- * ```ts
- * /**
- *  * There was a problem processing the configuration of the toolbar. The item with the given
- *  * name does not exist, so it was omitted when rendering the toolbar.
- *  *
- *  * @error toolbarview-item-unavailable
- *  * @param {String} name The name of the component.
- *  *\/
- * logWarning( 'toolbarview-item-unavailable', { name } );
- * ```
- *
- * See also {@link module:utils/ckeditorerror~CKEditorError} for an explanation when to throw an error and when to log
- * a warning or an error to the console.
- *
- * @param errorName The error name to be logged.
- * @param data Additional data to be logged.
- */
+* Logs a warning to the console with a properly formatted message and adds a link to the documentation.
+* Use whenever you want to log a warning to the console.
+*
+* ```ts
+* /**
+*  * There was a problem processing the configuration of the toolbar. The item with the given
+*  * name does not exist, so it was omitted when rendering the toolbar.
+*  *
+*  * @error toolbarview-item-unavailable
+*  * @param {String} name The name of the component.
+*  *\/
+* logWarning( 'toolbarview-item-unavailable', { name } );
+* ```
+*
+* See also {@link module:utils/ckeditorerror~CKEditorError} for an explanation when to throw an error and when to log
+* a warning or an error to the console.
+*
+* @param errorName The error name to be logged.
+* @param data Additional data to be logged.
+*/
 export declare function logWarning(errorName: string, data?: object): void;
 /**
- * Logs an error to the console with a properly formatted message and adds a link to the documentation.
- * Use whenever you want to log an error to the console.
- *
- * ```ts
- * /**
- *  * There was a problem processing the configuration of the toolbar. The item with the given
- *  * name does not exist, so it was omitted when rendering the toolbar.
- *  *
- *  * @error toolbarview-item-unavailable
- *  * @param {String} name The name of the component.
- *  *\/
- *  logError( 'toolbarview-item-unavailable', { name } );
- * ```
- *
- * **Note**: In most cases logging a warning using {@link module:utils/ckeditorerror~logWarning} is enough.
- *
- * See also {@link module:utils/ckeditorerror~CKEditorError} for an explanation when to use each method.
- *
- * @param errorName The error name to be logged.
- * @param data Additional data to be logged.
- */
+* Logs an error to the console with a properly formatted message and adds a link to the documentation.
+* Use whenever you want to log an error to the console.
+*
+* ```ts
+* /**
+*  * There was a problem processing the configuration of the toolbar. The item with the given
+*  * name does not exist, so it was omitted when rendering the toolbar.
+*  *
+*  * @error toolbarview-item-unavailable
+*  * @param {String} name The name of the component.
+*  *\/
+*  logError( 'toolbarview-item-unavailable', { name } );
+* ```
+*
+* **Note**: In most cases logging a warning using {@link module:utils/ckeditorerror~logWarning} is enough.
+*
+* See also {@link module:utils/ckeditorerror~CKEditorError} for an explanation when to use each method.
+*
+* @param errorName The error name to be logged.
+* @param data Additional data to be logged.
+*/
 export declare function logError(errorName: string, data?: object): void;