@ckeditor/ckeditor5-utils 40.0.0 → 40.2.0

package/src/config.js

@@ -1,162 +1,163 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module utils/config
- */
-import { isPlainObject, isElement, cloneDeepWith } from 'lodash-es';
-/**
- * Handles a configuration dictionary.
- *
- * @typeParam Cfg A type of the configuration dictionary.
- */
-export default class 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, defaultConfigurations) {
-        this._config = {};
-        // Set default configuration.
-        if (defaultConfigurations) {
-            // Clone the configuration to make sure that the properties will not be shared
-            // between editors and make the watchdog feature work correctly.
-            this.define(cloneConfig(defaultConfigurations));
-        }
-        // Set initial configuration.
-        if (configurations) {
-            this._setObjectToTarget(this._config, configurations);
-        }
-    }
-    set(name, value) {
-        this._setToTarget(this._config, name, value);
-    }
-    define(name, value) {
-        const isDefine = true;
-        this._setToTarget(this._config, name, value, isDefine);
-    }
-    /**
-     * 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(name) {
-        return this._getFromSource(this._config, name);
-    }
-    /**
-     * Iterates over all top level configuration names.
-     */
-    *names() {
-        for (const name of Object.keys(this._config)) {
-            yield name;
-        }
-    }
-    /**
-     * 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.
-     */
-    _setToTarget(target, name, value, isDefine = false) {
-        // In case of an object, iterate through it and call `_setToTarget` again for each property.
-        if (isPlainObject(name)) {
-            this._setObjectToTarget(target, name, isDefine);
-            return;
-        }
-        // The configuration name should be split into parts if it has dots. E.g. `resize.width` -> [`resize`, `width`].
-        const parts = name.split('.');
-        // Take the name of the configuration out of the parts. E.g. `resize.width` -> `width`.
-        name = parts.pop();
-        // Iterate over parts to check if currently stored configuration has proper structure.
-        for (const part of parts) {
-            // If there is no object for specified part then create one.
-            if (!isPlainObject(target[part])) {
-                target[part] = {};
-            }
-            // Nested object becomes a target.
-            target = target[part];
-        }
-        // In case of value is an object.
-        if (isPlainObject(value)) {
-            // We take care of proper config structure.
-            if (!isPlainObject(target[name])) {
-                target[name] = {};
-            }
-            target = target[name];
-            // And iterate through this object calling `_setToTarget` again for each property.
-            this._setObjectToTarget(target, value, isDefine);
-            return;
-        }
-        // Do nothing if we are defining configuration for non empty name.
-        if (isDefine && typeof target[name] != 'undefined') {
-            return;
-        }
-        target[name] = value;
-    }
-    /**
-     * 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.
-     */
-    _getFromSource(source, name) {
-        // The configuration name should be split into parts if it has dots. E.g. `resize.width` -> [`resize`, `width`].
-        const parts = name.split('.');
-        // Take the name of the configuration out of the parts. E.g. `resize.width` -> `width`.
-        name = parts.pop();
-        // Iterate over parts to check if currently stored configuration has proper structure.
-        for (const part of parts) {
-            if (!isPlainObject(source[part])) {
-                source = null;
-                break;
-            }
-            // Nested object becomes a source.
-            source = source[part];
-        }
-        // Always returns undefined for non existing configuration.
-        return source ? cloneConfig(source[name]) : undefined;
-    }
-    /**
-     * 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.
-     */
-    _setObjectToTarget(target, configuration, isDefine) {
-        Object.keys(configuration).forEach(key => {
-            this._setToTarget(target, key, configuration[key], isDefine);
-        });
-    }
-}
-/**
- * Clones configuration object or value.
- */
-function cloneConfig(source) {
-    return cloneDeepWith(source, leaveDOMReferences);
-}
-/**
- * A customized function for cloneDeepWith.
- * It will leave references to DOM Elements instead of cloning them.
- */
-function leaveDOMReferences(value) {
-    return isElement(value) ? value : undefined;
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module utils/config
+ */
+import { isPlainObject, isElement, cloneDeepWith } from 'lodash-es';
+/**
+ * Handles a configuration dictionary.
+ *
+ * @typeParam Cfg A type of the configuration dictionary.
+ */
+export default class 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, defaultConfigurations) {
+        this._config = {};
+        // Set default configuration.
+        if (defaultConfigurations) {
+            // Clone the configuration to make sure that the properties will not be shared
+            // between editors and make the watchdog feature work correctly.
+            this.define(cloneConfig(defaultConfigurations));
+        }
+        // Set initial configuration.
+        if (configurations) {
+            this._setObjectToTarget(this._config, configurations);
+        }
+    }
+    set(name, value) {
+        this._setToTarget(this._config, name, value);
+    }
+    define(name, value) {
+        const isDefine = true;
+        this._setToTarget(this._config, name, value, isDefine);
+    }
+    /**
+     * 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(name) {
+        return this._getFromSource(this._config, name);
+    }
+    /**
+     * Iterates over all top level configuration names.
+     */
+    *names() {
+        for (const name of Object.keys(this._config)) {
+            yield name;
+        }
+    }
+    /**
+     * 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.
+     */
+    _setToTarget(target, name, value, isDefine = false) {
+        // In case of an object, iterate through it and call `_setToTarget` again for each property.
+        if (isPlainObject(name)) {
+            this._setObjectToTarget(target, name, isDefine);
+            return;
+        }
+        // The configuration name should be split into parts if it has dots. E.g. `resize.width` -> [`resize`, `width`].
+        const parts = name.split('.');
+        // Take the name of the configuration out of the parts. E.g. `resize.width` -> `width`.
+        name = parts.pop();
+        // Iterate over parts to check if currently stored configuration has proper structure.
+        for (const part of parts) {
+            // If there is no object for specified part then create one.
+            if (!isPlainObject(target[part])) {
+                target[part] = {};
+            }
+            // Nested object becomes a target.
+            target = target[part];
+        }
+        // In case of value is an object.
+        if (isPlainObject(value)) {
+            // We take care of proper config structure.
+            if (!isPlainObject(target[name])) {
+                target[name] = {};
+            }
+            target = target[name];
+            // And iterate through this object calling `_setToTarget` again for each property.
+            this._setObjectToTarget(target, value, isDefine);
+            return;
+        }
+        // Do nothing if we are defining configuration for non empty name.
+        if (isDefine && typeof target[name] != 'undefined') {
+            return;
+        }
+        target[name] = value;
+    }
+    /**
+     * 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.
+     */
+    _getFromSource(source, name) {
+        // The configuration name should be split into parts if it has dots. E.g. `resize.width` -> [`resize`, `width`].
+        const parts = name.split('.');
+        // Take the name of the configuration out of the parts. E.g. `resize.width` -> `width`.
+        name = parts.pop();
+        // Iterate over parts to check if currently stored configuration has proper structure.
+        for (const part of parts) {
+            if (!isPlainObject(source[part])) {
+                source = null;
+                break;
+            }
+            // Nested object becomes a source.
+            source = source[part];
+        }
+        // Always returns undefined for non existing configuration.
+        return source ? cloneConfig(source[name]) : undefined;
+    }
+    /**
+     * 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.
+     */
+    _setObjectToTarget(target, configuration, isDefine) {
+        Object.keys(configuration).forEach(key => {
+            this._setToTarget(target, key, configuration[key], isDefine);
+        });
+    }
+}
+/**
+ * Clones configuration object or value.
+ */
+function cloneConfig(source) {
+    return cloneDeepWith(source, leaveItemReferences);
+}
+/**
+ * A customized function for cloneDeepWith.
+ * In case if it's a DOM Element it will leave references to DOM Elements instead of cloning them.
+ * If it's a function it will leave reference to actuall function.
+ */
+function leaveItemReferences(value) {
+    return isElement(value) || typeof value === 'function' ? value : undefined;
+}

package/src/count.d.ts

@@ -1,18 +1,18 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @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.
- */
-export default function count(iterable: Iterable<unknown>): number;
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @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.
+ */
+export default function count(iterable: Iterable<unknown>): number;

package/src/count.js

@@ -1,24 +1,24 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @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.
- */
-export default function count(iterable) {
-    let count = 0;
-    for (const _ of iterable) { // eslint-disable-line no-unused-vars
-        count++;
-    }
-    return count;
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @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.
+ */
+export default function count(iterable) {
+    let count = 0;
+    for (const _ of iterable) { // eslint-disable-line no-unused-vars
+        count++;
+    }
+    return count;
+}

package/src/delay.d.ts

@@ -1,19 +1,19 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @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.
- */
-export default 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;
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @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.
+ */
+export default 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;
+}

package/src/delay.js

@@ -1,26 +1,26 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * @module utils/delay
- */
-/* globals setTimeout, clearTimeout */
-/**
- * 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 default function delay(func, wait) {
-    let timer;
-    function delayed(...args) {
-        delayed.cancel();
-        timer = setTimeout(() => func(...args), wait);
-    }
-    delayed.cancel = () => {
-        clearTimeout(timer);
-    };
-    return delayed;
-}
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module utils/delay
+ */
+/* globals setTimeout, clearTimeout */
+/**
+ * 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 default function delay(func, wait) {
+    let timer;
+    function delayed(...args) {
+        delayed.cancel();
+        timer = setTimeout(() => func(...args), wait);
+    }
+    delayed.cancel = () => {
+        clearTimeout(timer);
+    };
+    return delayed;
+}

package/src/diff.d.ts

@@ -1,31 +1,31 @@
-/**
- * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
- * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
- */
-/**
- * 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.
- */
-declare function diff<T>(a: ArrayLike<T>, b: ArrayLike<T>, cmp?: (a: T, b: T) => boolean): Array<DiffResult>;
-declare namespace diff {
-    var fastDiff: typeof import("./fastdiff").default;
-}
-export default diff;
-/**
- * The element of the result of {@link module:utils/diff~diff} function.
- */
-export type DiffResult = 'equal' | 'insert' | 'delete';
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * 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.
+ */
+declare function diff<T>(a: ArrayLike<T>, b: ArrayLike<T>, cmp?: (a: T, b: T) => boolean): Array<DiffResult>;
+declare namespace diff {
+    var fastDiff: typeof import("./fastdiff").default;
+}
+export default diff;
+/**
+ * The element of the result of {@link module:utils/diff~diff} function.
+ */
+export type DiffResult = 'equal' | 'insert' | 'delete';