@ckeditor/ckeditor5-utils 41.0.0 → 41.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-utils",
-  "version": "41.0.0",
+  "version": "41.2.0",
   "description": "Miscellaneous utilities used by CKEditor 5.",
   "keywords": [
     "ckeditor",

package/src/index.d.ts

@@ -45,7 +45,7 @@ export { default as remove } from './dom/remove.js';
 export * from './dom/scroll.js';
 export * from './keyboard.js';
 export * from './language.js';
-export { default as Locale, type LocaleTranslate } from './locale.js';
+export { default as Locale, type LocaleTranslate, type Translations } from './locale.js';
 export { default as Collection, type CollectionAddEvent, type CollectionChangeEvent, type CollectionRemoveEvent } from './collection.js';
 export { default as first } from './first.js';
 export { default as FocusTracker } from './focustracker.js';

package/src/keyboard.js

@@ -15,6 +15,13 @@ const modifiersToGlyphsNonMac = {
     alt: 'Alt+',
     shift: 'Shift+'
 };
+const keyCodesToGlyphs = {
+    37: '←',
+    38: '↑',
+    39: '→',
+    40: '↓',
+    9: '⇥'
+};
 /**
  * An object with `keyName => keyCode` pairs for a set of known keys.
  *
@@ -29,7 +36,16 @@ const modifiersToGlyphsNonMac = {
  * * `ctrl`, `cmd`, `shift`, `alt`.
  */
 export const keyCodes = generateKnownKeyCodes();
-const keyCodeNames = Object.fromEntries(Object.entries(keyCodes).map(([name, code]) => [code, name.charAt(0).toUpperCase() + name.slice(1)]));
+const keyCodeNames = Object.fromEntries(Object.entries(keyCodes).map(([name, code]) => {
+    let prettyKeyName;
+    if (code in keyCodesToGlyphs) {
+        prettyKeyName = keyCodesToGlyphs[code];
+    }
+    else {
+        prettyKeyName = name.charAt(0).toUpperCase() + name.slice(1);
+    }
+    return [code, prettyKeyName];
+}));
 /**
  * Converts a key name or {@link module:utils/keyboard~KeystrokeInfo keystroke info} into a key code.
  *
@@ -211,9 +227,19 @@ function generateKnownKeyCodes() {
         keyCodes['f' + (code - 111)] = code;
     }
     // other characters
-    for (const char of '`-=[];\',./\\') {
-        keyCodes[char] = char.charCodeAt(0);
-    }
+    Object.assign(keyCodes, {
+        '\'': 222,
+        ',': 108,
+        '-': 109,
+        '.': 110,
+        '/': 111,
+        ';': 186,
+        '=': 187,
+        '[': 219,
+        '\\': 220,
+        ']': 221,
+        '`': 223
+    });
     return keyCodes;
 }
 function splitKeystrokeText(keystroke) {

package/src/locale.d.ts

@@ -2,6 +2,10 @@
  * @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/locale
+ */
+import { type ArrayOrItem } from './toarray.js';
 import { type Message } from './translation-service.js';
 import { type LanguageDirection } from './language.js';
 /**
@@ -83,6 +87,10 @@ export default class Locale {
      * ```
      */
     readonly t: LocaleTranslate;
+    /**
+     * Object that contains translations.
+     */
+    translations?: Translations;
     /**
      * Creates a new instance of the locale class. Learn more about
      * {@glink features/ui-language configuring the language of the editor}.
@@ -93,10 +101,12 @@ export default class Locale {
      * @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}.
+     * @param translations Translations passed as a editor config parameter.
      */
-    constructor({ uiLanguage, contentLanguage }?: {
+    constructor({ uiLanguage, contentLanguage, translations }?: {
         readonly uiLanguage?: string;
         readonly contentLanguage?: string;
+        readonly translations?: ArrayOrItem<Translations>;
     });
     /**
      * The editor UI language code in the [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) format.
@@ -118,3 +128,14 @@ export default class Locale {
  * For messages supporting plural forms the first value will determine the plural form.
  */
 export type LocaleTranslate = (message: string | Message, values?: number | string | ReadonlyArray<number | string>) => string;
+/**
+ * Translations object definition.
+ */
+export type Translations = {
+    [language: string]: {
+        dictionary: {
+            [messageId: string]: string | ReadonlyArray<string>;
+        };
+        getPluralForm?: (n: number) => number;
+    };
+};

package/src/locale.js

@@ -7,7 +7,7 @@
  */
 /* globals console */
 import toArray from './toarray.js';
-import { _translate } from './translation-service.js';
+import { _translate, _unifyTranslations } from './translation-service.js';
 import { getLanguageDirection } from './language.js';
 /**
  * Represents the localization services.
@@ -23,12 +23,14 @@ export default class Locale {
      * @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}.
+     * @param translations Translations passed as a editor config parameter.
      */
-    constructor({ uiLanguage = 'en', contentLanguage } = {}) {
+    constructor({ uiLanguage = 'en', contentLanguage, translations } = {}) {
         this.uiLanguage = uiLanguage;
         this.contentLanguage = contentLanguage || this.uiLanguage;
         this.uiLanguageDirection = getLanguageDirection(this.uiLanguage);
         this.contentLanguageDirection = getLanguageDirection(this.contentLanguage);
+        this.translations = _unifyTranslations(translations);
         this.t = (message, values) => this._t(message, values);
     }
     /**
@@ -62,7 +64,7 @@ export default class Locale {
         }
         const hasPluralForm = !!message.plural;
         const quantity = hasPluralForm ? values[0] : 1;
-        const translatedString = _translate(this.uiLanguage, message, quantity);
+        const translatedString = _translate(this.uiLanguage, message, quantity, this.translations);
         return interpolateString(translatedString, values);
     }
 }

package/src/translation-service.d.ts

@@ -2,15 +2,13 @@
  * @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: {
-        [language: string]: {
-            dictionary: {
-                [messageId: string]: string | ReadonlyArray<string>;
-            };
-            getPluralForm?: (n: number) => number;
-        };
-    };
+    var CKEDITOR_TRANSLATIONS: Translations;
 }
 /**
  * Adds translations to existing ones or overrides the existing translations. These translations will later
@@ -135,15 +133,23 @@ export declare function add(language: string, translations: {
  * @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): string;
+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.

package/src/translation-service.js

@@ -2,12 +2,9 @@
  * @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
  */
-/* eslint-disable no-var */
-/**
- * @module utils/translation-service
- */
 import CKEditorError from './ckeditorerror.js';
 import global from './dom/global.js';
+import { merge } from 'lodash-es';
 /* istanbul ignore else -- @preserve */
 if (!global.window.CKEDITOR_TRANSLATIONS) {
     global.window.CKEDITOR_TRANSLATIONS = {};
@@ -141,9 +138,10 @@ export function add(language, translations, getPluralForm) {
  * @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 function _translate(language, message, quantity = 1) {
+export function _translate(language, message, quantity = 1, translations) {
     if (typeof quantity !== 'number') {
         /**
          * An incorrect value was passed to the translation function. This was probably caused
@@ -154,22 +152,23 @@ export function _translate(language, message, quantity = 1) {
          */
         throw new CKEditorError('translation-service-quantity-not-a-number', null, { quantity });
     }
-    const numberOfLanguages = getNumberOfLanguages();
+    const normalizedTranslations = translations || global.window.CKEDITOR_TRANSLATIONS;
+    const numberOfLanguages = getNumberOfLanguages(normalizedTranslations);
     if (numberOfLanguages === 1) {
         // Override the language to the only supported one.
         // This can't be done in the `Locale` class, because the translations comes after the `Locale` class initialization.
-        language = Object.keys(global.window.CKEDITOR_TRANSLATIONS)[0];
+        language = Object.keys(normalizedTranslations)[0];
     }
     const messageId = message.id || message.string;
-    if (numberOfLanguages === 0 || !hasTranslation(language, messageId)) {
+    if (numberOfLanguages === 0 || !hasTranslation(language, messageId, normalizedTranslations)) {
         if (quantity !== 1) {
             // Return the default plural form that was passed in the `message.plural` parameter.
             return message.plural;
         }
         return message.string;
     }
-    const dictionary = global.window.CKEDITOR_TRANSLATIONS[language].dictionary;
-    const getPluralForm = global.window.CKEDITOR_TRANSLATIONS[language].getPluralForm || (n => n === 1 ? 0 : 1);
+    const dictionary = normalizedTranslations[language].dictionary;
+    const getPluralForm = normalizedTranslations[language].getPluralForm || (n => n === 1 ? 0 : 1);
     const translation = dictionary[messageId];
     if (typeof translation === 'string') {
         return translation;
@@ -184,15 +183,27 @@ export function _translate(language, message, quantity = 1) {
  * @internal
  */
 export function _clear() {
-    global.window.CKEDITOR_TRANSLATIONS = {};
+    if (global.window.CKEDITOR_TRANSLATIONS) {
+        global.window.CKEDITOR_TRANSLATIONS = {};
+    }
+}
+/**
+ * If array then merge objects which are inside otherwise return given object.
+ *
+ * @internal
+ * @param translations Translations passed in editor config.
+ */
+export function _unifyTranslations(translations) {
+    return Array.isArray(translations) ?
+        translations.reduce((acc, translation) => merge(acc, translation)) :
+        translations;
 }
 /**
  * Checks whether the dictionary exists and translation in that dictionary exists.
  */
-function hasTranslation(language, messageId) {
-    return (!!global.window.CKEDITOR_TRANSLATIONS[language] &&
-        !!global.window.CKEDITOR_TRANSLATIONS[language].dictionary[messageId]);
+function hasTranslation(language, messageId, translations) {
+    return !!translations[language] && !!translations[language].dictionary[messageId];
 }
-function getNumberOfLanguages() {
-    return Object.keys(global.window.CKEDITOR_TRANSLATIONS).length;
+function getNumberOfLanguages(translations) {
+    return Object.keys(translations).length;
 }

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.0.0";
+declare const version = "41.2.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.0.0';
+const version = '41.2.0';
 export default version;
 // The second argument is not a month. It is `monthIndex` and starts from `0`.
-export const releaseDate = new Date(2024, 0, 17);
+export const releaseDate = new Date(2024, 2, 6);
 /* istanbul ignore next -- @preserve */
 if (globalThis.CKEDITOR_VERSION) {
     /**