@ckeditor/ckeditor5-utils 0.0.0-internal-20241017.0

package/src/keyboard.js

@@ -0,0 +1,252 @@
+/**
+ * @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
+ */
+import CKEditorError from './ckeditorerror.js';
+import env from './env.js';
+const modifiersToGlyphsMac = {
+    ctrl: '⌃',
+    cmd: '⌘',
+    alt: '⌥',
+    shift: '⇧'
+};
+const modifiersToGlyphsNonMac = {
+    ctrl: 'Ctrl+',
+    alt: 'Alt+',
+    shift: 'Shift+'
+};
+const keyCodesToGlyphs = {
+    37: '←',
+    38: '↑',
+    39: '→',
+    40: '↓',
+    9: '⇥',
+    33: 'Page Up',
+    34: 'Page Down'
+};
+/**
+ * An object with `keyName => keyCode` pairs for a set of known keys.
+ *
+ * Contains:
+ *
+ * * `a-z`,
+ * * `0-9`,
+ * * `f1-f12`,
+ * * `` ` ``, `-`, `=`, `[`, `]`, `;`, `'`, `,`, `.`, `/`, `\`,
+ * * `arrow(left|up|right|bottom)`,
+ * * `backspace`, `delete`, `enter`, `esc`, `tab`,
+ * * `ctrl`, `cmd`, `shift`, `alt`.
+ */
+export const keyCodes = /* #__PURE__ */ generateKnownKeyCodes();
+const keyCodeNames = /* #__PURE__ */ Object.fromEntries(
+/* #__PURE__ */ 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.
+ *
+ * Note: Key names are matched with {@link module:utils/keyboard#keyCodes} in a case-insensitive way.
+ *
+ * @param key A key name (see {@link module:utils/keyboard#keyCodes}) or a keystroke data object.
+ * @returns Key or keystroke code.
+ */
+export function getCode(key) {
+    let keyCode;
+    if (typeof key == 'string') {
+        keyCode = keyCodes[key.toLowerCase()];
+        if (!keyCode) {
+            /**
+             * Unknown key name. Only key names included in the {@link module:utils/keyboard#keyCodes} can be used.
+             *
+             * @error keyboard-unknown-key
+             * @param {String} key
+             */
+            throw new CKEditorError('keyboard-unknown-key', null, { key });
+        }
+    }
+    else {
+        keyCode = key.keyCode +
+            (key.altKey ? keyCodes.alt : 0) +
+            (key.ctrlKey ? keyCodes.ctrl : 0) +
+            (key.shiftKey ? keyCodes.shift : 0) +
+            (key.metaKey ? keyCodes.cmd : 0);
+    }
+    return keyCode;
+}
+/**
+ * Parses the keystroke and returns a keystroke code that will match the code returned by
+ * {@link module:utils/keyboard~getCode} for the corresponding {@link module:utils/keyboard~KeystrokeInfo keystroke info}.
+ *
+ * The keystroke can be passed in two formats:
+ *
+ * * as a single string – e.g. `ctrl + A`,
+ * * as an array of {@link module:utils/keyboard~keyCodes known key names} and key codes – e.g.:
+ *   * `[ 'ctrl', 32 ]` (ctrl + space),
+ *   * `[ 'ctrl', 'a' ]` (ctrl + A).
+ *
+ * Note: Key names are matched with {@link module:utils/keyboard#keyCodes} in a case-insensitive way.
+ *
+ * Note: Only keystrokes with a single non-modifier key are supported (e.g. `ctrl+A` is OK, but `ctrl+A+B` is not).
+ *
+ * Note: On macOS, keystroke handling is translating the `Ctrl` key to the `Cmd` key and handling only that keystroke.
+ * For example, a registered keystroke `Ctrl+A` will be translated to `Cmd+A` on macOS. To disable the translation of some keystroke,
+ * use the forced modifier: `Ctrl!+A` (note the exclamation mark).
+ *
+ * @param keystroke The keystroke definition.
+ * @returns Keystroke code.
+ */
+export function parseKeystroke(keystroke) {
+    if (typeof keystroke == 'string') {
+        keystroke = splitKeystrokeText(keystroke);
+    }
+    return keystroke
+        .map(key => (typeof key == 'string') ? getEnvKeyCode(key) : key)
+        .reduce((key, sum) => sum + key, 0);
+}
+/**
+ * Translates any keystroke string text like `"Ctrl+A"` to an
+ * environment–specific keystroke, i.e. `"⌘A"` on macOS.
+ *
+ * @param keystroke The keystroke text.
+ * @returns The keystroke text specific for the environment.
+ */
+export function getEnvKeystrokeText(keystroke) {
+    let keystrokeCode = parseKeystroke(keystroke);
+    const modifiersToGlyphs = Object.entries((env.isMac || env.isiOS) ? modifiersToGlyphsMac : modifiersToGlyphsNonMac);
+    const modifiers = modifiersToGlyphs.reduce((modifiers, [name, glyph]) => {
+        // Modifier keys are stored as a bit mask so extract those from the keystroke code.
+        if ((keystrokeCode & keyCodes[name]) != 0) {
+            keystrokeCode &= ~keyCodes[name];
+            modifiers += glyph;
+        }
+        return modifiers;
+    }, '');
+    return modifiers + (keystrokeCode ? keyCodeNames[keystrokeCode] : '');
+}
+/**
+ * Returns `true` if the provided key code represents one of the arrow keys.
+ *
+ * @param keyCode A key code as in {@link module:utils/keyboard~KeystrokeInfo#keyCode}.
+ */
+export function isArrowKeyCode(keyCode) {
+    return keyCode == keyCodes.arrowright ||
+        keyCode == keyCodes.arrowleft ||
+        keyCode == keyCodes.arrowup ||
+        keyCode == keyCodes.arrowdown;
+}
+/**
+ * Returns the direction in which the {@link module:engine/model/documentselection~DocumentSelection selection}
+ * will move when the provided arrow key code is pressed considering the language direction of the editor content.
+ *
+ * For instance, in right–to–left (RTL) content languages, pressing the left arrow means moving the selection right (forward)
+ * in the model structure. Similarly, pressing the right arrow moves the selection left (backward).
+ *
+ * @param keyCode A key code as in {@link module:utils/keyboard~KeystrokeInfo#keyCode}.
+ * @param contentLanguageDirection The content language direction, corresponding to
+ * {@link module:utils/locale~Locale#contentLanguageDirection}.
+ * @returns Localized arrow direction or `undefined` for non-arrow key codes.
+ */
+export function getLocalizedArrowKeyCodeDirection(keyCode, contentLanguageDirection) {
+    const isLtrContent = contentLanguageDirection === 'ltr';
+    switch (keyCode) {
+        case keyCodes.arrowleft:
+            return isLtrContent ? 'left' : 'right';
+        case keyCodes.arrowright:
+            return isLtrContent ? 'right' : 'left';
+        case keyCodes.arrowup:
+            return 'up';
+        case keyCodes.arrowdown:
+            return 'down';
+    }
+}
+/**
+ * Converts a key name to the key code with mapping based on the env.
+ *
+ * See: {@link module:utils/keyboard~getCode}.
+ *
+ * @param key The key name (see {@link module:utils/keyboard#keyCodes}).
+ * @returns Key code.
+ */
+function getEnvKeyCode(key) {
+    // Don't remap modifier key for forced modifiers.
+    if (key.endsWith('!')) {
+        return getCode(key.slice(0, -1));
+    }
+    const code = getCode(key);
+    return (env.isMac || env.isiOS) && code == keyCodes.ctrl ? keyCodes.cmd : code;
+}
+/**
+ * Determines if the provided key code moves the {@link module:engine/model/documentselection~DocumentSelection selection}
+ * forward or backward considering the language direction of the editor content.
+ *
+ * For instance, in right–to–left (RTL) languages, pressing the left arrow means moving forward
+ * in the model structure. Similarly, pressing the right arrow moves the selection backward.
+ *
+ * @param keyCode A key code as in {@link module:utils/keyboard~KeystrokeInfo#keyCode}.
+ * @param contentLanguageDirection The content language direction, corresponding to
+ * {@link module:utils/locale~Locale#contentLanguageDirection}.
+ */
+export function isForwardArrowKeyCode(keyCode, contentLanguageDirection) {
+    const localizedKeyCodeDirection = getLocalizedArrowKeyCodeDirection(keyCode, contentLanguageDirection);
+    return localizedKeyCodeDirection === 'down' || localizedKeyCodeDirection === 'right';
+}
+function generateKnownKeyCodes() {
+    const keyCodes = {
+        pageup: 33,
+        pagedown: 34,
+        arrowleft: 37,
+        arrowup: 38,
+        arrowright: 39,
+        arrowdown: 40,
+        backspace: 8,
+        delete: 46,
+        enter: 13,
+        space: 32,
+        esc: 27,
+        tab: 9,
+        // The idea about these numbers is that they do not collide with any real key codes, so we can use them
+        // like bit masks.
+        ctrl: 0x110000,
+        shift: 0x220000,
+        alt: 0x440000,
+        cmd: 0x880000
+    };
+    // a-z
+    for (let code = 65; code <= 90; code++) {
+        const letter = String.fromCharCode(code);
+        keyCodes[letter.toLowerCase()] = code;
+    }
+    // 0-9
+    for (let code = 48; code <= 57; code++) {
+        keyCodes[code - 48] = code;
+    }
+    // F1-F12
+    for (let code = 112; code <= 123; code++) {
+        keyCodes['f' + (code - 111)] = code;
+    }
+    // other characters
+    Object.assign(keyCodes, {
+        '\'': 222,
+        ',': 108,
+        '-': 109,
+        '.': 110,
+        '/': 111,
+        ';': 186,
+        '=': 187,
+        '[': 219,
+        '\\': 220,
+        ']': 221,
+        '`': 223
+    });
+    return keyCodes;
+}
+function splitKeystrokeText(keystroke) {
+    return keystroke.split('+').map(key => key.trim());
+}

package/src/keystrokehandler.d.ts

@@ -0,0 +1,97 @@
+/**
+ * @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
+ */
+import type { Emitter } from './emittermixin.js';
+import { type KeystrokeInfo } from './keyboard.js';
+import type { PriorityString } from './priorities.js';
+/**
+ * Keystroke handler allows registering callbacks for given keystrokes.
+ *
+ * The most frequent use of this class is through the {@link module:core/editor/editor~Editor#keystrokes `editor.keystrokes`}
+ * property. It allows listening to keystrokes executed in the editing view:
+ *
+ * ```ts
+ * editor.keystrokes.set( 'Ctrl+A', ( keyEvtData, cancel ) => {
+ * 	console.log( 'Ctrl+A has been pressed' );
+ * 	cancel();
+ * } );
+ * ```
+ *
+ * However, this utility class can be used in various part of the UI. For instance, a certain {@link module:ui/view~View}
+ * can use it like this:
+ *
+ * ```ts
+ * class MyView extends View {
+ * 	constructor() {
+ * 		this.keystrokes = new KeystrokeHandler();
+ *
+ * 		this.keystrokes.set( 'tab', handleTabKey );
+ * 	}
+ *
+ * 	render() {
+ * 		super.render();
+ *
+ * 		this.keystrokes.listenTo( this.element );
+ * 	}
+ * }
+ * ```
+ *
+ * That keystroke handler will listen to `keydown` events fired in this view's main element.
+ *
+ */
+export default class KeystrokeHandler {
+    /**
+     * Listener used to listen to events for easier keystroke handler destruction.
+     */
+    private readonly _listener;
+    /**
+     * Creates an instance of the keystroke handler.
+     */
+    constructor();
+    /**
+     * Starts listening for `keydown` events from a given emitter.
+     */
+    listenTo(emitter: Emitter | HTMLElement | Window): void;
+    /**
+     * Registers a handler for the specified keystroke.
+     *
+     * @param keystroke Keystroke defined in a format accepted by
+     * the {@link module:utils/keyboard~parseKeystroke} function.
+     * @param callback A function called with the
+     * {@link module:engine/view/observer/keyobserver~KeyEventData key event data} object and
+     * a helper function to call both `preventDefault()` and `stopPropagation()` on the underlying event.
+     * @param options Additional options.
+     */
+    set(keystroke: string | ReadonlyArray<string | number>, callback: (ev: KeyboardEvent, cancel: () => void) => void, options?: KeystrokeHandlerOptions): void;
+    /**
+     * Triggers a keystroke handler for a specified key combination, if such a keystroke was {@link #set defined}.
+     *
+     * @param keyEvtData Key event data.
+     * @returns Whether the keystroke was handled.
+     */
+    press(keyEvtData: Readonly<KeystrokeInfo>): boolean;
+    /**
+     * Stops listening to `keydown` events from the given emitter.
+     */
+    stopListening(emitter?: Emitter | HTMLElement | Window): void;
+    /**
+     * Destroys the keystroke handler.
+     */
+    destroy(): void;
+}
+/**
+ * {@link module:utils/keystrokehandler~KeystrokeHandler#set} method options.
+ */
+export interface KeystrokeHandlerOptions {
+    /**
+     * The priority of the keystroke callback. The higher the priority value the sooner the callback will be executed.
+     * Keystrokes having the same priority are called in the order they were added.
+     */
+    readonly priority?: PriorityString;
+    /**
+     * An optional callback function allowing for filtering keystrokes based on arbitrary criteria.
+     * The callback function receives `keydown` DOM event as a parameter.
+     */
+    readonly filter?: (keyEvtData: KeyboardEvent) => boolean;
+}

package/src/keystrokehandler.js

@@ -0,0 +1,122 @@
+/**
+ * @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/keystrokehandler
+ */
+import DomEmitterMixin from './dom/emittermixin.js';
+import { getCode, parseKeystroke } from './keyboard.js';
+/**
+ * Keystroke handler allows registering callbacks for given keystrokes.
+ *
+ * The most frequent use of this class is through the {@link module:core/editor/editor~Editor#keystrokes `editor.keystrokes`}
+ * property. It allows listening to keystrokes executed in the editing view:
+ *
+ * ```ts
+ * editor.keystrokes.set( 'Ctrl+A', ( keyEvtData, cancel ) => {
+ * 	console.log( 'Ctrl+A has been pressed' );
+ * 	cancel();
+ * } );
+ * ```
+ *
+ * However, this utility class can be used in various part of the UI. For instance, a certain {@link module:ui/view~View}
+ * can use it like this:
+ *
+ * ```ts
+ * class MyView extends View {
+ * 	constructor() {
+ * 		this.keystrokes = new KeystrokeHandler();
+ *
+ * 		this.keystrokes.set( 'tab', handleTabKey );
+ * 	}
+ *
+ * 	render() {
+ * 		super.render();
+ *
+ * 		this.keystrokes.listenTo( this.element );
+ * 	}
+ * }
+ * ```
+ *
+ * That keystroke handler will listen to `keydown` events fired in this view's main element.
+ *
+ */
+export default class KeystrokeHandler {
+    /**
+     * Creates an instance of the keystroke handler.
+     */
+    constructor() {
+        this._listener = new (DomEmitterMixin())();
+    }
+    /**
+     * Starts listening for `keydown` events from a given emitter.
+     */
+    listenTo(emitter) {
+        // The #_listener works here as a kind of dispatcher. It groups the events coming from the same
+        // keystroke so the listeners can be attached to them with different priorities.
+        //
+        // E.g. all the keystrokes with the `keyCode` of 42 coming from the `emitter` are propagated
+        // as a `_keydown:42` event by the `_listener`. If there's a callback created by the `set`
+        // method for this 42 keystroke, it listens to the `_listener#_keydown:42` event only and interacts
+        // only with other listeners of this particular event, thus making it possible to prioritize
+        // the listeners and safely cancel execution, when needed. Instead of duplicating the Emitter logic,
+        // the KeystrokeHandler re–uses it to do its job.
+        this._listener.listenTo(emitter, 'keydown', (evt, keyEvtData) => {
+            this._listener.fire('_keydown:' + getCode(keyEvtData), keyEvtData);
+        });
+    }
+    /**
+     * Registers a handler for the specified keystroke.
+     *
+     * @param keystroke Keystroke defined in a format accepted by
+     * the {@link module:utils/keyboard~parseKeystroke} function.
+     * @param callback A function called with the
+     * {@link module:engine/view/observer/keyobserver~KeyEventData key event data} object and
+     * a helper function to call both `preventDefault()` and `stopPropagation()` on the underlying event.
+     * @param options Additional options.
+     */
+    set(keystroke, callback, options = {}) {
+        const keyCode = parseKeystroke(keystroke);
+        const priority = options.priority;
+        // Execute the passed callback on KeystrokeHandler#_keydown.
+        // TODO: https://github.com/ckeditor/ckeditor5-utils/issues/144
+        this._listener.listenTo(this._listener, '_keydown:' + keyCode, (evt, keyEvtData) => {
+            if (options.filter && !options.filter(keyEvtData)) {
+                return;
+            }
+            callback(keyEvtData, () => {
+                // Stop the event in the DOM: no listener in the web page
+                // will be triggered by this event.
+                keyEvtData.preventDefault();
+                keyEvtData.stopPropagation();
+                // Stop the event in the KeystrokeHandler: no more callbacks
+                // will be executed for this keystroke.
+                evt.stop();
+            });
+            // Mark this keystroke as handled by the callback. See: #press.
+            evt.return = true;
+        }, { priority });
+    }
+    /**
+     * Triggers a keystroke handler for a specified key combination, if such a keystroke was {@link #set defined}.
+     *
+     * @param keyEvtData Key event data.
+     * @returns Whether the keystroke was handled.
+     */
+    press(keyEvtData) {
+        return !!this._listener.fire('_keydown:' + getCode(keyEvtData), keyEvtData);
+    }
+    /**
+     * Stops listening to `keydown` events from the given emitter.
+     */
+    stopListening(emitter) {
+        this._listener.stopListening(emitter);
+    }
+    /**
+     * Destroys the keystroke handler.
+     */
+    destroy() {
+        this.stopListening();
+    }
+}

package/src/language.d.ts

@@ -0,0 +1,17 @@
+/**
+ * @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/language
+ */
+/**
+ * String representing a language direction.
+ */
+export type LanguageDirection = 'ltr' | 'rtl';
+/**
+ * Helps determine whether a language text direction is LTR or RTL.
+ *
+ * @param languageCode The ISO 639-1 or ISO 639-2 language code.
+ */
+export declare function getLanguageDirection(languageCode: string): LanguageDirection;

package/src/language.js

@@ -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
+ */
+const RTL_LANGUAGE_CODES = [
+    'ar', 'ara',
+    'dv', 'div',
+    'fa', 'per', 'fas',
+    'he', 'heb',
+    'ku', 'kur',
+    'ug', 'uig' // Uighur, Uyghur
+];
+/**
+ * Helps determine whether a language text direction is LTR or RTL.
+ *
+ * @param languageCode The ISO 639-1 or ISO 639-2 language code.
+ */
+export function getLanguageDirection(languageCode) {
+    return RTL_LANGUAGE_CODES.includes(languageCode) ? 'rtl' : 'ltr';
+}

package/src/locale.d.ts

@@ -0,0 +1,141 @@
+/**
+ * @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';
+/**
+ * Represents the localization services.
+ */
+export default class Locale {
+    /**
+     * The editor UI language code in the [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) format.
+     *
+     * If the {@link #contentLanguage content language} was not specified in the `Locale` constructor,
+     * it also defines the language of the content.
+     */
+    readonly uiLanguage: string;
+    /**
+     * Text direction of the {@link #uiLanguage editor UI language}. Either `'ltr'` or `'rtl'`.
+     */
+    readonly uiLanguageDirection: LanguageDirection;
+    /**
+     * The editor content language code in the [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1) format.
+     *
+     * Usually the same as the {@link #uiLanguage editor language}, it can be customized by passing an optional
+     * argument to the `Locale` constructor.
+     */
+    readonly contentLanguage: string;
+    /**
+     * Text direction of the {@link #contentLanguage editor content language}.
+     *
+     * If the content language was passed directly to the `Locale` constructor, this property represents the
+     * direction of that language.
+     *
+     * If the {@link #contentLanguage editor content language} was derived from the {@link #uiLanguage editor language},
+     * the content language direction is the same as the {@link #uiLanguageDirection UI language direction}.
+     *
+     * The value is either `'ltr'` or `'rtl'`.
+     */
+    readonly contentLanguageDirection: LanguageDirection;
+    /**
+     * Translates the given message to the {@link #uiLanguage}. This method is also available in
+     * {@link module:core/editor/editor~Editor#t `Editor`} and {@link module:ui/view~View#t `View`}.
+     *
+     * This method's context is statically bound to the `Locale` instance and **should always be called as a function**:
+     *
+     * ```ts
+     * const t = locale.t;
+     * t( 'Label' );
+     * ```
+     *
+     * The message can be either a string or an object implementing the {@link module:utils/translation-service~Message} interface.
+     *
+     * The message may contain placeholders (`%<index>`) for value(s) that are passed as a `values` parameter.
+     * For an array of values, the `%<index>` will be changed to an element of that array at the given index.
+     * For a single value passed as the second argument, only the `%0` placeholders will be changed to the provided value.
+     *
+     * ```ts
+     * t( 'Created file "%0" in %1ms.', [ fileName, timeTaken ] );
+     * t( 'Created file "%0", fileName );
+     * ```
+     *
+     * The message supports plural forms. To specify the plural form, use the `plural` property. Singular or plural form
+     * will be chosen depending on the first value from the passed `values`. The value of the `plural` property is used
+     * as a default plural translation when the translation for the target language is missing.
+     *
+     * ```ts
+     * t( { string: 'Add a space', plural: 'Add %0 spaces' }, 1 ); // 'Add a space' for the English language.
+     * t( { string: 'Add a space', plural: 'Add %0 spaces' }, 5 ); // 'Add 5 spaces' for the English language.
+     * t( { string: '%1 a space', plural: '%1 %0 spaces' }, [ 2, 'Add' ] ); // 'Add 2 spaces' for the English language.
+     *
+     * t( { string: 'Add a space', plural: 'Add %0 spaces' }, 1 ); // 'Dodaj spację' for the Polish language.
+     * t( { string: 'Add a space', plural: 'Add %0 spaces' }, 5 ); // 'Dodaj 5 spacji' for the Polish language.
+     * t( { string: '%1 a space', plural: '%1 %0 spaces' }, [ 2, 'Add' ] ); // 'Dodaj 2 spacje' for the Polish language.
+     * ```
+     *
+     *  * 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' } );
+     * ```
+     */
+    readonly t: LocaleTranslate;
+    /**
+     * Object that contains translations.
+     */
+    translations?: Translations;
+    /**
+     * Creates a new instance of the locale class. Learn more about
+     * {@glink getting-started/setup/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}.
+     * @param translations Translations passed as a editor config parameter.
+     */
+    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.
+     *
+     * **Note**: This property was deprecated. Please use {@link #uiLanguage} and {@link #contentLanguage}
+     * properties instead.
+     *
+     * @deprecated
+     */
+    get language(): string;
+    /**
+     * An unbound version of the {@link #t} method.
+     */
+    private _t;
+}
+/**
+ * @param message A message that will be localized (translated).
+ * @param values A value or an array of values that will fill message placeholders.
+ * 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 | boolean) | null;
+    };
+};