@ckeditor/ckeditor5-utils 41.3.1 → 41.4.0

package/dist/types/spy.d.ts

@@ -0,0 +1,25 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @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.
+ */
+declare function spy(): {
+    (): void;
+    called?: boolean;
+};
+export default spy;

package/dist/types/toarray.d.ts

@@ -0,0 +1,29 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @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.
+ */
+export default 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.
+ */
+export default function toArray<T>(data: ReadonlyArrayOrItem<T>): ReadonlyArray<T>;
+export type ArrayOrItem<T> = T | Array<T>;
+export type ReadonlyArrayOrItem<T> = T | ReadonlyArray<T>;

package/dist/types/tomap.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * 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 default function toMap<T>(data: {
+    readonly [key: string]: T;
+} | Iterable<readonly [string, T]> | null | undefined): Map<string, T>;

package/dist/types/translation-service.d.ts

@@ -0,0 +1,178 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module utils/translation-service
+ */
+import type { Translations } from './locale.js';
+import { type ArrayOrItem } from './toarray.js';
+declare global {
+    var CKEDITOR_TRANSLATIONS: Translations;
+}
+/**
+ * Adds translations to existing ones or overrides the existing translations. These translations will later
+ * be available for the {@link module:utils/locale~Locale#t `t()`} function.
+ *
+ * The `translations` is an object which consists of `messageId: translation` pairs. Note that the message ID can be
+ * either constructed from the message string or from the message ID if it was passed
+ * (this happens rarely and mostly for short messages or messages with placeholders).
+ * Since the editor displays only the message string, the message ID can be found either in the source code or in the
+ * built translations for another language.
+ *
+ * ```ts
+ * add( 'pl', {
+ * 	'Cancel': 'Anuluj',
+ * 	'IMAGE': 'obraz', // Note that the `IMAGE` comes from the message ID, while the string can be `image`.
+ * } );
+ * ```
+ *
+ * If the message is supposed to support various plural forms, make sure to provide an array with the singular form and all plural forms:
+ *
+ * ```ts
+ * add( 'pl', {
+ * 	'Add space': [ 'Dodaj spację', 'Dodaj %0 spacje', 'Dodaj %0 spacji' ]
+ * } );
+ * ```
+ *
+ * You should also specify the third argument (the `getPluralForm()` function) that will be used to determine the plural form if no
+ * language file was loaded for that language. All language files coming from CKEditor 5 sources will have this option set, so
+ * these plural form rules will be reused by other translations added to the registered languages. The `getPluralForm()` function
+ * can return either a Boolean or a number.
+ *
+ * ```ts
+ * add( 'en', {
+ * 	// ... Translations.
+ * }, n => n !== 1 );
+ * add( 'pl', {
+ * 	// ... Translations.
+ * }, n => n == 1 ? 0 : n % 10 >= 2 && n % 10 <= 4 && ( n % 100 < 10 || n % 100 >= 20 ) ? 1 : 2 );
+ * ```
+ *
+ * All translations extend the global `window.CKEDITOR_TRANSLATIONS` object. An example of this object can be found below:
+ *
+ * ```ts
+ * {
+ * 	pl: {
+ * 		dictionary: {
+ * 			'Cancel': 'Anuluj',
+ * 			'Add space': [ 'Dodaj spację', 'Dodaj %0 spacje', 'Dodaj %0 spacji' ]
+ * 		},
+ * 		// A function that returns the plural form index.
+ * 		getPluralForm: n => n == 1 ? 0 : n % 10 >= 2 && n % 10 <= 4 && ( n % 100 < 10 || n % 100 >= 20 ) ? 1 : 2 );
+ * 	}
+ * 	// Other languages.
+ * 	}
+ * ```
+ *
+ * If you cannot import this function from this module (e.g. because you use a CKEditor 5 build), you can
+ * still add translations by extending the global `window.CKEDITOR_TRANSLATIONS` object by using a function like
+ * the one below:
+ *
+ * ```ts
+ * function addTranslations( language, translations, getPluralForm ) {
+ * 	if ( !global.window.CKEDITOR_TRANSLATIONS ) {
+ * 		global.window.CKEDITOR_TRANSLATIONS = {};
+ * 	}
+
+ * 	if ( !global.window.CKEDITOR_TRANSLATIONS[ language ] ) {
+ * 		global.window.CKEDITOR_TRANSLATIONS[ language ] = {};
+ * 	}
+ *
+ * 	const languageTranslations = global.window.CKEDITOR_TRANSLATIONS[ language ];
+ *
+ * 	languageTranslations.dictionary = languageTranslations.dictionary || {};
+ * 	languageTranslations.getPluralForm = getPluralForm || languageTranslations.getPluralForm;
+ *
+ * 	// Extend the dictionary for the given language.
+ * 	Object.assign( languageTranslations.dictionary, translations );
+ * }
+ * ```
+ *
+ * @param language Target language.
+ * @param translations An object with translations which will be added to the dictionary.
+ * For each message ID the value should be either a translation or an array of translations if the message
+ * should support plural forms.
+ * @param getPluralForm A function that returns the plural form index (a number).
+ */
+export declare function add(language: string, translations: {
+    readonly [messageId: string]: string | ReadonlyArray<string>;
+}, getPluralForm?: (n: number) => number): void;
+/**
+ * **Note:** This method is internal, use {@link module:utils/locale~Locale#t the `t()` function} instead to translate
+ * the editor UI parts.
+ *
+ * This function is responsible for translating messages to the specified language. It uses translations added perviously
+ * by {@link module:utils/translation-service~add} (a translations dictionary and the `getPluralForm()` function
+ * to provide accurate translations of plural forms).
+ *
+ * When no translation is defined in the dictionary or the dictionary does not exist, this function returns
+ * the original message string or the message plural depending on the number of elements.
+ *
+ * ```ts
+ * translate( 'pl', { string: 'Cancel' } ); // 'Cancel'
+ * ```
+ *
+ * The third optional argument is the number of elements, based on which the single form or one of the plural forms
+ * should be picked when the message is supposed to support various plural forms.
+ *
+ * ```ts
+ * translate( 'en', { string: 'Add a space', plural: 'Add %0 spaces' }, 1 ); // 'Add a space'
+ * translate( 'en', { string: 'Add a space', plural: 'Add %0 spaces' }, 3 ); // 'Add %0 spaces'
+ * ```
+ *
+ * The message should provide an ID using the `id` property when the message strings are not unique and their
+ * translations should be different.
+ *
+ * ```ts
+ * translate( 'en', { string: 'image', id: 'ADD_IMAGE' } );
+ * translate( 'en', { string: 'image', id: 'AN_IMAGE' } );
+ * ```
+ *
+ * @internal
+ * @param language Target language.
+ * @param message A message that will be translated.
+ * @param quantity The number of elements for which a plural form should be picked from the target language dictionary.
+ * @param translations Translations passed in editor config, if not provided use the global `window.CKEDITOR_TRANSLATIONS`.
+ * @returns Translated sentence.
+ */
+export declare function _translate(language: string, message: Message, quantity?: number, translations?: Translations): string;
+/**
+ * Clears dictionaries for test purposes.
+ *
+ * @internal
+ */
+export declare function _clear(): void;
+/**
+ * If array then merge objects which are inside otherwise return given object.
+ *
+ * @internal
+ * @param translations Translations passed in editor config.
+ */
+export declare function _unifyTranslations(translations?: ArrayOrItem<Translations>): Translations | undefined;
+/**
+ * The internationalization message interface. A message that implements this interface can be passed to the `t()` function
+ * to be translated to the target UI language.
+ */
+export interface Message {
+    /**
+     * The message string to translate. Acts as a default translation if the translation for a given language
+     * is not defined. When the message is supposed to support plural forms, the string should be the English singular form of the message.
+     */
+    readonly string: string;
+    /**
+     * The message ID. If passed, the message ID is taken from this property instead of the `message.string`.
+     * This property is useful when various messages share the same message string, for example, the `editor` string in `in the editor`
+     * and `my editor` sentences.
+     */
+    readonly id?: string;
+    /**
+     * The plural form of the message. This property should be skipped when a message is not supposed
+     * to support plural forms. Otherwise it should always be set to a string with the English plural form of the message.
+     */
+    readonly plural?: string;
+}

package/dist/types/uid.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * Returns a unique id. The id starts with an "e" character and a randomly generated string of
+ * 32 alphanumeric characters.
+ *
+ * **Note**: The characters the unique id is built from correspond to the hex number notation
+ * (from "0" to "9", from "a" to "f"). In other words, each id corresponds to an "e" followed
+ * by 16 8-bit numbers next to each other.
+ *
+ * @returns An unique id string.
+ */
+export default function uid(): string;

package/dist/types/unicode.d.ts

@@ -0,0 +1,58 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * Set of utils to handle unicode characters.
+ *
+ * @module utils/unicode
+ */
+/**
+ * Checks whether given `character` is a combining mark.
+ *
+ * @param character Character to check.
+ */
+export declare function isCombiningMark(character: string): boolean;
+/**
+ * Checks whether given `character` is a high half of surrogate pair.
+ *
+ * Using UTF-16 terminology, a surrogate pair denotes UTF-16 character using two UTF-8 characters. The surrogate pair
+ * consist of high surrogate pair character followed by low surrogate pair character.
+ *
+ * @param character Character to check.
+ */
+export declare function isHighSurrogateHalf(character: string): boolean;
+/**
+ * Checks whether given `character` is a low half of surrogate pair.
+ *
+ * Using UTF-16 terminology, a surrogate pair denotes UTF-16 character using two UTF-8 characters. The surrogate pair
+ * consist of high surrogate pair character followed by low surrogate pair character.
+ *
+ * @param character Character to check.
+ */
+export declare function isLowSurrogateHalf(character: string): boolean;
+/**
+ * Checks whether given offset in a string is inside a surrogate pair (between two surrogate halves).
+ *
+ * @param string String to check.
+ * @param offset Offset to check.
+ */
+export declare function isInsideSurrogatePair(string: string, offset: number): boolean;
+/**
+ * Checks whether given offset in a string is between base character and combining mark or between two combining marks.
+ *
+ * @param string String to check.
+ * @param offset Offset to check.
+ */
+export declare function isInsideCombinedSymbol(string: string, offset: number): boolean;
+/**
+ * Checks whether given offset in a string is inside multi-character emoji sequence.
+ *
+ * @param string String to check.
+ * @param offset Offset to check.
+ */
+export declare function isInsideEmojiSequence(string: string, offset: number): boolean;

package/dist/types/verifylicense.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * Possible states of the key after verification.
+ */
+export type VerifiedKeyStatus = 'VALID' | 'INVALID';
+/**
+ * Checks whether the given string contains information that allows you to verify the license status.
+ *
+ * @param token The string to check.
+ * @returns String that represents the state of given `token` parameter.
+ */
+export default function verifyLicense(token: string | undefined): VerifiedKeyStatus;

package/dist/types/version.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+declare const version = "41.4.0";
+export default version;
+export declare const releaseDate: Date;
+declare global {
+    var CKEDITOR_VERSION: string;
+}

package/dist/types/wait.d.ts

@@ -0,0 +1,20 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module utils/wait
+ */
+/**
+ * Returns a promise that is resolved after the specified time.
+ *
+ * @param timeout The time in milliseconds to wait.
+ * @param options.signal A signal to abort the waiting.
+ */
+export default function wait(timeout: number, options?: {
+    signal?: AbortSignal;
+}): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-utils",
-  "version": "41.3.1",
+  "version": "41.4.0",
   "description": "Miscellaneous utilities used by CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -24,6 +24,7 @@
     "directory": "packages/ckeditor5-utils"
   },
   "files": [
+    "dist",
     "lang",
     "src/**/*.js",
     "src/**/*.d.ts",

package/src/env.d.ts

@@ -42,6 +42,14 @@ export interface EnvType {
      * Indicates that the application is running in a browser using the Blink engine.
      */
     readonly isBlink: boolean;
+    /**
+     * Indicates that the the user agent has enabled a forced colors mode (e.g. Windows High Contrast mode).
+     */
+    readonly isMediaForcedColors: boolean;
+    /**
+     * Indicates that "prefer reduced motion" browser setting is active.
+     */
+    readonly isMotionReduced: boolean;
     /**
      * Environment features information.
      */
@@ -115,3 +123,11 @@ export declare function isBlink(userAgent: string): boolean;
  * [in Unicode Standard Annex #44](https://www.unicode.org/reports/tr44/#GC_Values_Table).
  */
 export declare function isRegExpUnicodePropertySupported(): boolean;
+/**
+ * Checks if the user agent has enabled a forced colors mode (e.g. Windows High Contrast mode).
+ */
+export declare function isMediaForcedColors(): boolean;
+/**
+ * Checks if user enabled "prefers reduced motion" setting in browser.
+ */
+export declare function isMotionReduced(): boolean;

package/src/env.js

@@ -31,6 +31,10 @@ const env = {
     isiOS: isiOS(userAgent),
     isAndroid: isAndroid(userAgent),
     isBlink: isBlink(userAgent),
+    isMediaForcedColors: isMediaForcedColors(),
+    get isMotionReduced() {
+        return isMotionReduced();
+    },
     features: {
         isRegExpUnicodePropertySupported: isRegExpUnicodePropertySupported()
     }
@@ -120,3 +124,15 @@ export function isRegExpUnicodePropertySupported() {
     }
     return isSupported;
 }
+/**
+ * Checks if the user agent has enabled a forced colors mode (e.g. Windows High Contrast mode).
+ */
+export function isMediaForcedColors() {
+    return window.matchMedia('(forced-colors: active)').matches;
+}
+/**
+ * Checks if user enabled "prefers reduced motion" setting in browser.
+ */
+export function isMotionReduced() {
+    return window.matchMedia('(prefers-reduced-motion)').matches;
+}

package/src/locale.d.ts

@@ -136,6 +136,6 @@ export type Translations = {
         dictionary: {
             [messageId: string]: string | ReadonlyArray<string>;
         };
-        getPluralForm?: (n: number) => number;
+        getPluralForm?: ((n: number) => number | boolean) | null;
     };
 };

package/src/version.d.ts

@@ -2,7 +2,7 @@
  * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-declare const version = "41.3.1";
+declare const version = "41.4.0";
 export default version;
 export declare const releaseDate: Date;
 declare global {

package/src/version.js

@@ -6,10 +6,10 @@
  * @module utils/version
  */
 import CKEditorError from './ckeditorerror.js';
-const version = '41.3.1';
+const version = '41.4.0';
 export default version;
 // The second argument is not a month. It is `monthIndex` and starts from `0`.
-export const releaseDate = new Date(2024, 3, 16);
+export const releaseDate = new Date(2024, 4, 15);
 /* istanbul ignore next -- @preserve */
 if (globalThis.CKEDITOR_VERSION) {
     /**