@ckeditor/ckeditor5-utils 40.0.0 → 40.1.0

package/src/locale.js

@@ -1,76 +1,76 @@
-/**
- * @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/locale
- */
-/* globals console */
-import toArray from './toarray';
-import { _translate } from './translation-service';
-import { getLanguageDirection } from './language';
-/**
- * Represents the localization services.
- */
-export default class Locale {
-    /**
-     * Creates a new instance of the locale class. Learn more about
-     * {@glink features/ui-language configuring the language of the editor}.
-     *
-     * @param options Locale configuration.
-     * @param options.uiLanguage The editor UI language code in the
-     * [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) format. See {@link #uiLanguage}.
-     * @param options.contentLanguage The editor content language code in the
-     * [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) format. If not specified, the same as `options.language`.
-     * See {@link #contentLanguage}.
-     */
-    constructor({ uiLanguage = 'en', contentLanguage } = {}) {
-        this.uiLanguage = uiLanguage;
-        this.contentLanguage = contentLanguage || this.uiLanguage;
-        this.uiLanguageDirection = getLanguageDirection(this.uiLanguage);
-        this.contentLanguageDirection = getLanguageDirection(this.contentLanguage);
-        this.t = (message, values) => this._t(message, values);
-    }
-    /**
-     * The editor UI language code in the [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) format.
-     *
-     * **Note**: This property was deprecated. Please use {@link #uiLanguage} and {@link #contentLanguage}
-     * properties instead.
-     *
-     * @deprecated
-     */
-    get language() {
-        /**
-         * The {@link module:utils/locale~Locale#language `Locale#language`} property was deprecated and will
-         * be removed in the near future. Please use the {@link module:utils/locale~Locale#uiLanguage `Locale#uiLanguage`} and
-         * {@link module:utils/locale~Locale#contentLanguage `Locale#contentLanguage`} properties instead.
-         *
-         * @error locale-deprecated-language-property
-         */
-        console.warn('locale-deprecated-language-property: ' +
-            'The Locale#language property has been deprecated and will be removed in the near future. ' +
-            'Please use #uiLanguage and #contentLanguage properties instead.');
-        return this.uiLanguage;
-    }
-    /**
-     * An unbound version of the {@link #t} method.
-     */
-    _t(message, values = []) {
-        values = toArray(values);
-        if (typeof message === 'string') {
-            message = { string: message };
-        }
-        const hasPluralForm = !!message.plural;
-        const quantity = hasPluralForm ? values[0] : 1;
-        const translatedString = _translate(this.uiLanguage, message, quantity);
-        return interpolateString(translatedString, values);
-    }
-}
-/**
- * Fills the `%0, %1, ...` string placeholders with values.
- */
-function interpolateString(string, values) {
-    return string.replace(/%(\d+)/g, (match, index) => {
-        return (index < values.length) ? values[index] : match;
-    });
-}
+/**
+ * @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/locale
+ */
+/* globals console */
+import toArray from './toarray';
+import { _translate } from './translation-service';
+import { getLanguageDirection } from './language';
+/**
+ * Represents the localization services.
+ */
+export default class Locale {
+    /**
+     * Creates a new instance of the locale class. Learn more about
+     * {@glink features/ui-language configuring the language of the editor}.
+     *
+     * @param options Locale configuration.
+     * @param options.uiLanguage The editor UI language code in the
+     * [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) format. See {@link #uiLanguage}.
+     * @param options.contentLanguage The editor content language code in the
+     * [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) format. If not specified, the same as `options.language`.
+     * See {@link #contentLanguage}.
+     */
+    constructor({ uiLanguage = 'en', contentLanguage } = {}) {
+        this.uiLanguage = uiLanguage;
+        this.contentLanguage = contentLanguage || this.uiLanguage;
+        this.uiLanguageDirection = getLanguageDirection(this.uiLanguage);
+        this.contentLanguageDirection = getLanguageDirection(this.contentLanguage);
+        this.t = (message, values) => this._t(message, values);
+    }
+    /**
+     * The editor UI language code in the [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) format.
+     *
+     * **Note**: This property was deprecated. Please use {@link #uiLanguage} and {@link #contentLanguage}
+     * properties instead.
+     *
+     * @deprecated
+     */
+    get language() {
+        /**
+         * The {@link module:utils/locale~Locale#language `Locale#language`} property was deprecated and will
+         * be removed in the near future. Please use the {@link module:utils/locale~Locale#uiLanguage `Locale#uiLanguage`} and
+         * {@link module:utils/locale~Locale#contentLanguage `Locale#contentLanguage`} properties instead.
+         *
+         * @error locale-deprecated-language-property
+         */
+        console.warn('locale-deprecated-language-property: ' +
+            'The Locale#language property has been deprecated and will be removed in the near future. ' +
+            'Please use #uiLanguage and #contentLanguage properties instead.');
+        return this.uiLanguage;
+    }
+    /**
+     * An unbound version of the {@link #t} method.
+     */
+    _t(message, values = []) {
+        values = toArray(values);
+        if (typeof message === 'string') {
+            message = { string: message };
+        }
+        const hasPluralForm = !!message.plural;
+        const quantity = hasPluralForm ? values[0] : 1;
+        const translatedString = _translate(this.uiLanguage, message, quantity);
+        return interpolateString(translatedString, values);
+    }
+}
+/**
+ * Fills the `%0, %1, ...` string placeholders with values.
+ */
+function interpolateString(string, values) {
+    return string.replace(/%(\d+)/g, (match, index) => {
+        return (index < values.length) ? values[index] : match;
+    });
+}

package/src/mapsequal.d.ts

@@ -1,15 +1,15 @@
-/**
- * @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/mapsequal
- */
-/**
- * Checks whether given `Map`s are equal, that is has same size and same key-value pairs.
- *
- * @param mapA The first map to compare.
- * @param mapB The second map to compare.
- * @returns `true` if given maps are equal, `false` otherwise.
- */
-export default function mapsEqual<Key>(mapA: Map<Key, unknown>, mapB: Map<Key, unknown>): boolean;
+/**
+ * @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/mapsequal
+ */
+/**
+ * Checks whether given `Map`s are equal, that is has same size and same key-value pairs.
+ *
+ * @param mapA The first map to compare.
+ * @param mapB The second map to compare.
+ * @returns `true` if given maps are equal, `false` otherwise.
+ */
+export default function mapsEqual<Key>(mapA: Map<Key, unknown>, mapB: Map<Key, unknown>): boolean;

package/src/mapsequal.js

@@ -1,27 +1,27 @@
-/**
- * @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/mapsequal
- */
-/**
- * Checks whether given `Map`s are equal, that is has same size and same key-value pairs.
- *
- * @param mapA The first map to compare.
- * @param mapB The second map to compare.
- * @returns `true` if given maps are equal, `false` otherwise.
- */
-export default function mapsEqual(mapA, mapB) {
-    if (mapA.size != mapB.size) {
-        return false;
-    }
-    for (const attr of mapA.entries()) {
-        const valA = JSON.stringify(attr[1]);
-        const valB = JSON.stringify(mapB.get(attr[0]));
-        if (valA !== valB) {
-            return false;
-        }
-    }
-    return true;
-}
+/**
+ * @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/mapsequal
+ */
+/**
+ * Checks whether given `Map`s are equal, that is has same size and same key-value pairs.
+ *
+ * @param mapA The first map to compare.
+ * @param mapB The second map to compare.
+ * @returns `true` if given maps are equal, `false` otherwise.
+ */
+export default function mapsEqual(mapA, mapB) {
+    if (mapA.size != mapB.size) {
+        return false;
+    }
+    for (const attr of mapA.entries()) {
+        const valA = JSON.stringify(attr[1]);
+        const valB = JSON.stringify(mapB.get(attr[0]));
+        if (valA !== valB) {
+            return false;
+        }
+    }
+    return true;
+}

package/src/mix.d.ts

@@ -1,85 +1,85 @@
-/**
- * @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/mix
- */
-/**
- * Copies enumerable properties and symbols from the objects given as 2nd+ parameters to the
- * prototype of first object (a constructor).
- *
- * ```
- * class Editor {
- * 	...
- * }
- *
- * const SomeMixin = {
- * 	a() {
- * 		return 'a';
- * 	}
- * };
- *
- * mix( Editor, SomeMixin, ... );
- *
- * new Editor().a(); // -> 'a'
- * ```
- *
- * Note: Properties which already exist in the base class will not be overriden.
- *
- * @deprecated Use mixin pattern, see: https://www.typescriptlang.org/docs/handbook/mixins.html.
- * @param baseClass Class which prototype will be extended.
- * @param mixins Objects from which to get properties.
- */
-export default function mix(baseClass: Function, ...mixins: Array<object>): void;
-/**
- * Helper type that represents constructor creating given objects. Can be used as a type constraint.
- *
- * ```ts
- * // The function accepts any class constructor.
- * function MyFunction<Ctor extends Constructor>( ctor: Ctor ) {
- * 	// ...
- * }
- *
- * // The function accepts any class constructor of type derived from `MyBase`.
- * function MyFunction<Ctor extends Constructor<MyBase>>( ctor: Ctor ) {
- * 	// ...
- * }
- * ```
- */
-export type Constructor<Instance = object> = abstract new (...args: Array<any>) => Instance;
-/**
- * Helper type that creates constructor types from a base class and a mixin interface.
- *
- * ```ts
- * interface MyMixinInterface {
- * 	mixinMethod(): void;
- * }
- *
- * function MyMixin<Base extends Constructor>( base: Base ): Mixed<Base, MyMixinInterface> {
- * 	// ...
- * }
- *
- * class BaseClass {
- * 	baseMethod(): void {
- * 		// ...
- * 	}
- * }
- *
- * const MixedClass = MyMixin( BaseClass );
- *
- * // Contains both `mixinMethod()` and `baseMethod()`.
- * const myObject = new MixedClass();
- * myObject.mixinMethod();
- * myObject.baseMethod();
- * ```
- *
- * @typeParam Base A type of constructor of a class to apply mixin to.
- * @typeParam Mixin An interface representing mixin.
- */
-export type Mixed<Base extends Constructor, Mixin extends object> = {
-    new (...args: ConstructorParameters<Base>): Mixin & InstanceType<Base>;
-    prototype: Mixin & InstanceType<Base>;
-} & {
-    [K in keyof Base]: Base[K];
-};
+/**
+ * @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/mix
+ */
+/**
+ * Copies enumerable properties and symbols from the objects given as 2nd+ parameters to the
+ * prototype of first object (a constructor).
+ *
+ * ```
+ * class Editor {
+ * 	...
+ * }
+ *
+ * const SomeMixin = {
+ * 	a() {
+ * 		return 'a';
+ * 	}
+ * };
+ *
+ * mix( Editor, SomeMixin, ... );
+ *
+ * new Editor().a(); // -> 'a'
+ * ```
+ *
+ * Note: Properties which already exist in the base class will not be overriden.
+ *
+ * @deprecated Use mixin pattern, see: https://www.typescriptlang.org/docs/handbook/mixins.html.
+ * @param baseClass Class which prototype will be extended.
+ * @param mixins Objects from which to get properties.
+ */
+export default function mix(baseClass: Function, ...mixins: Array<object>): void;
+/**
+ * Helper type that represents constructor creating given objects. Can be used as a type constraint.
+ *
+ * ```ts
+ * // The function accepts any class constructor.
+ * function MyFunction<Ctor extends Constructor>( ctor: Ctor ) {
+ * 	// ...
+ * }
+ *
+ * // The function accepts any class constructor of type derived from `MyBase`.
+ * function MyFunction<Ctor extends Constructor<MyBase>>( ctor: Ctor ) {
+ * 	// ...
+ * }
+ * ```
+ */
+export type Constructor<Instance = object> = abstract new (...args: Array<any>) => Instance;
+/**
+ * Helper type that creates constructor types from a base class and a mixin interface.
+ *
+ * ```ts
+ * interface MyMixinInterface {
+ * 	mixinMethod(): void;
+ * }
+ *
+ * function MyMixin<Base extends Constructor>( base: Base ): Mixed<Base, MyMixinInterface> {
+ * 	// ...
+ * }
+ *
+ * class BaseClass {
+ * 	baseMethod(): void {
+ * 		// ...
+ * 	}
+ * }
+ *
+ * const MixedClass = MyMixin( BaseClass );
+ *
+ * // Contains both `mixinMethod()` and `baseMethod()`.
+ * const myObject = new MixedClass();
+ * myObject.mixinMethod();
+ * myObject.baseMethod();
+ * ```
+ *
+ * @typeParam Base A type of constructor of a class to apply mixin to.
+ * @typeParam Mixin An interface representing mixin.
+ */
+export type Mixed<Base extends Constructor, Mixin extends object> = {
+    new (...args: ConstructorParameters<Base>): Mixin & InstanceType<Base>;
+    prototype: Mixin & InstanceType<Base>;
+} & {
+    [K in keyof Base]: Base[K];
+};

package/src/mix.js

@@ -1,50 +1,50 @@
-/**
- * @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/mix
- */
-/**
- * Copies enumerable properties and symbols from the objects given as 2nd+ parameters to the
- * prototype of first object (a constructor).
- *
- * ```
- * class Editor {
- * 	...
- * }
- *
- * const SomeMixin = {
- * 	a() {
- * 		return 'a';
- * 	}
- * };
- *
- * mix( Editor, SomeMixin, ... );
- *
- * new Editor().a(); // -> 'a'
- * ```
- *
- * Note: Properties which already exist in the base class will not be overriden.
- *
- * @deprecated Use mixin pattern, see: https://www.typescriptlang.org/docs/handbook/mixins.html.
- * @param baseClass Class which prototype will be extended.
- * @param mixins Objects from which to get properties.
- */
-export default function mix(baseClass, ...mixins) {
-    mixins.forEach(mixin => {
-        const propertyNames = Object.getOwnPropertyNames(mixin);
-        const propertySymbols = Object.getOwnPropertySymbols(mixin);
-        propertyNames.concat(propertySymbols).forEach(key => {
-            if (key in baseClass.prototype) {
-                return;
-            }
-            if (typeof mixin == 'function' && (key == 'length' || key == 'name' || key == 'prototype')) {
-                return;
-            }
-            const sourceDescriptor = Object.getOwnPropertyDescriptor(mixin, key);
-            sourceDescriptor.enumerable = false;
-            Object.defineProperty(baseClass.prototype, key, sourceDescriptor);
-        });
-    });
-}
+/**
+ * @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/mix
+ */
+/**
+ * Copies enumerable properties and symbols from the objects given as 2nd+ parameters to the
+ * prototype of first object (a constructor).
+ *
+ * ```
+ * class Editor {
+ * 	...
+ * }
+ *
+ * const SomeMixin = {
+ * 	a() {
+ * 		return 'a';
+ * 	}
+ * };
+ *
+ * mix( Editor, SomeMixin, ... );
+ *
+ * new Editor().a(); // -> 'a'
+ * ```
+ *
+ * Note: Properties which already exist in the base class will not be overriden.
+ *
+ * @deprecated Use mixin pattern, see: https://www.typescriptlang.org/docs/handbook/mixins.html.
+ * @param baseClass Class which prototype will be extended.
+ * @param mixins Objects from which to get properties.
+ */
+export default function mix(baseClass, ...mixins) {
+    mixins.forEach(mixin => {
+        const propertyNames = Object.getOwnPropertyNames(mixin);
+        const propertySymbols = Object.getOwnPropertySymbols(mixin);
+        propertyNames.concat(propertySymbols).forEach(key => {
+            if (key in baseClass.prototype) {
+                return;
+            }
+            if (typeof mixin == 'function' && (key == 'length' || key == 'name' || key == 'prototype')) {
+                return;
+            }
+            const sourceDescriptor = Object.getOwnPropertyDescriptor(mixin, key);
+            sourceDescriptor.enumerable = false;
+            Object.defineProperty(baseClass.prototype, key, sourceDescriptor);
+        });
+    });
+}

package/src/nth.d.ts

@@ -1,16 +1,16 @@
-/**
- * @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/nth
- */
-/**
- * Returns `nth` (starts from `0` of course) item of the given `iterable`.
- *
- * If the iterable is a generator, then it consumes **all its items**.
- * If it's a normal iterator, then it consumes **all items up to the given index**.
- * Refer to the [Iterators and Generators](https://developer.mozilla.org/en/docs/Web/JavaScript/Guide/Iterators_and_Generators)
- * guide to learn differences between these interfaces.
- */
-export default function nth<T>(index: number, iterable: Iterable<T>): T | null;
+/**
+ * @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/nth
+ */
+/**
+ * Returns `nth` (starts from `0` of course) item of the given `iterable`.
+ *
+ * If the iterable is a generator, then it consumes **all its items**.
+ * If it's a normal iterator, then it consumes **all items up to the given index**.
+ * Refer to the [Iterators and Generators](https://developer.mozilla.org/en/docs/Web/JavaScript/Guide/Iterators_and_Generators)
+ * guide to learn differences between these interfaces.
+ */
+export default function nth<T>(index: number, iterable: Iterable<T>): T | null;

package/src/nth.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/nth
- */
-/**
- * Returns `nth` (starts from `0` of course) item of the given `iterable`.
- *
- * If the iterable is a generator, then it consumes **all its items**.
- * If it's a normal iterator, then it consumes **all items up to the given index**.
- * Refer to the [Iterators and Generators](https://developer.mozilla.org/en/docs/Web/JavaScript/Guide/Iterators_and_Generators)
- * guide to learn differences between these interfaces.
- */
-export default function nth(index, iterable) {
-    for (const item of iterable) {
-        if (index === 0) {
-            return item;
-        }
-        index -= 1;
-    }
-    return null;
-}
+/**
+ * @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/nth
+ */
+/**
+ * Returns `nth` (starts from `0` of course) item of the given `iterable`.
+ *
+ * If the iterable is a generator, then it consumes **all its items**.
+ * If it's a normal iterator, then it consumes **all items up to the given index**.
+ * Refer to the [Iterators and Generators](https://developer.mozilla.org/en/docs/Web/JavaScript/Guide/Iterators_and_Generators)
+ * guide to learn differences between these interfaces.
+ */
+export default function nth(index, iterable) {
+    for (const item of iterable) {
+        if (index === 0) {
+            return item;
+        }
+        index -= 1;
+    }
+    return null;
+}

package/src/objecttomap.d.ts

@@ -1,23 +1,23 @@
-/**
- * @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/objecttomap
- */
-/**
- * Transforms object to map.
- *
- * ```ts
- * const map = objectToMap( { 'foo': 1, 'bar': 2 } );
- * map.get( 'foo' ); // 1
- * ```
- *
- * **Note**: For mixed data (`Object` or `Iterable`) there's a dedicated {@link module:utils/tomap~toMap} function.
- *
- * @param obj Object to transform.
- * @returns Map created from object.
- */
-export default function objectToMap<T>(obj: {
-    readonly [key: string]: T;
-} | null | undefined): Map<string, T>;
+/**
+ * @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/objecttomap
+ */
+/**
+ * Transforms object to map.
+ *
+ * ```ts
+ * const map = objectToMap( { 'foo': 1, 'bar': 2 } );
+ * map.get( 'foo' ); // 1
+ * ```
+ *
+ * **Note**: For mixed data (`Object` or `Iterable`) there's a dedicated {@link module:utils/tomap~toMap} function.
+ *
+ * @param obj Object to transform.
+ * @returns Map created from object.
+ */
+export default function objectToMap<T>(obj: {
+    readonly [key: string]: T;
+} | null | undefined): Map<string, T>;