@ckeditor/ckeditor5-utils 34.2.0 → 35.1.0

package/src/priorities.js

@@ -2,43 +2,31 @@
  * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
-/**
- * @module utils/priorities
- */
-
-/**
- * String representing a priority value.
- *
- * @typedef {'highest'|'high'|'normal'|'low'|'lowest'} module:utils/priorities~PriorityString
- */
-
 /**
  * Provides group of constants to use instead of hardcoding numeric priority values.
  *
  * @namespace
  */
 const priorities = {
-	/**
-	 * Converts a string with priority name to it's numeric value. If `Number` is given, it just returns it.
-	 *
-	 * @static
-	 * @param {module:utils/priorities~PriorityString|Number} priority Priority to convert.
-	 * @returns {Number} Converted priority.
-	 */
-	get( priority ) {
-		if ( typeof priority != 'number' ) {
-			return this[ priority ] || this.normal;
-		} else {
-			return priority;
-		}
-	},
-
-	highest: 100000,
-	high: 1000,
-	normal: 0,
-	low: -1000,
-	lowest: -100000
+    /**
+     * Converts a string with priority name to it's numeric value. If `Number` is given, it just returns it.
+     *
+     * @static
+     * @param {module:utils/priorities~PriorityString|Number} [priority] Priority to convert.
+     * @returns {Number} Converted priority.
+     */
+    get(priority = 'normal') {
+        if (typeof priority != 'number') {
+            return this[priority] || this.normal;
+        }
+        else {
+            return priority;
+        }
+    },
+    highest: 100000,
+    high: 1000,
+    normal: 0,
+    low: -1000,
+    lowest: -100000
 };
-
 export default priorities;

package/src/spy.js

@@ -2,11 +2,9 @@
  * @license Copyright (c) 2003-2022, 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.
  *
@@ -17,9 +15,8 @@
  * @returns {Function} The spy function.
  */
 function spy() {
-	return function spy() {
-		spy.called = true;
-	};
+    return function spy() {
+        spy.called = true;
+    };
 }
-
 export default spy;

package/src/toarray.js

@@ -2,17 +2,6 @@
  * @license Copyright (c) 2003-2022, 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.
- *
- * @param {*} data The value to transform to an array.
- * @returns {Array} An array created from data.
- */
-export default function toArray( data ) {
-	return Array.isArray( data ) ? data : [ data ];
+export default function toArray(data) {
+    return Array.isArray(data) ? data : [data];
 }

package/src/tomap.js

@@ -2,14 +2,11 @@
  * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module utils/tomap
  */
-
 import objectToMap from './objecttomap';
 import isIterable from './isiterable';
-
 /**
  * Transforms object or iterable to map. Iterable needs to be in the format acceptable by the `Map` constructor.
  *
@@ -17,13 +14,14 @@ import isIterable from './isiterable';
  *		map = toMap( [ [ 'foo', 1 ], [ 'bar', 2 ] ] );
  *		map = toMap( anotherMap );
  *
- * @param {Object|Iterable} data Object or iterable to transform.
+ * @param {Object|Iterable|null} data Object or iterable to transform.
  * @returns {Map} Map created from data.
  */
-export default function toMap( data ) {
-	if ( isIterable( data ) ) {
-		return new Map( data );
-	} else {
-		return objectToMap( data );
-	}
+export default function toMap(data) {
+    if (isIterable(data)) {
+        return new Map(data);
+    }
+    else {
+        return objectToMap(data);
+    }
 }

package/src/translation-service.js

@@ -2,20 +2,16 @@
  * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
-/* globals window */
-
+/* eslint-disable no-var */
 /**
  * @module utils/translation-service
  */
-
 import CKEditorError from './ckeditorerror';
-
+import global from './dom/global';
 /* istanbul ignore else */
-if ( !window.CKEDITOR_TRANSLATIONS ) {
-	window.CKEDITOR_TRANSLATIONS = {};
+if (!global.window.CKEDITOR_TRANSLATIONS) {
+    global.window.CKEDITOR_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.
@@ -68,15 +64,15 @@ if ( !window.CKEDITOR_TRANSLATIONS ) {
  * the one below:
  *
  *		function addTranslations( language, translations, getPluralForm ) {
- *			if ( !window.CKEDITOR_TRANSLATIONS ) {
- *				window.CKEDITOR_TRANSLATIONS = {};
+ *			if ( !global.window.CKEDITOR_TRANSLATIONS ) {
+ *				global.window.CKEDITOR_TRANSLATIONS = {};
  *			}
 
- *			if ( !window.CKEDITOR_TRANSLATIONS[ language ] ) {
- *				window.CKEDITOR_TRANSLATIONS[ language ] = {};
+ *			if ( !global.window.CKEDITOR_TRANSLATIONS[ language ] ) {
+ *				global.window.CKEDITOR_TRANSLATIONS[ language ] = {};
  *			}
  *
- *			const languageTranslations = window.CKEDITOR_TRANSLATIONS[ language ];
+ *			const languageTranslations = global.window.CKEDITOR_TRANSLATIONS[ language ];
  *
  * 			languageTranslations.dictionary = languageTranslations.dictionary || {};
  * 			languageTranslations.getPluralForm = getPluralForm || languageTranslations.getPluralForm;
@@ -89,21 +85,17 @@ if ( !window.CKEDITOR_TRANSLATIONS ) {
  * @param {Object.<String,*>} 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 {Function} getPluralForm A function that returns the plural form index (a number).
+ * @param {Function} [getPluralForm] A function that returns the plural form index (a number).
  */
-export function add( language, translations, getPluralForm ) {
-	if ( !window.CKEDITOR_TRANSLATIONS[ language ] ) {
-		window.CKEDITOR_TRANSLATIONS[ language ] = {};
-	}
-
-	const languageTranslations = window.CKEDITOR_TRANSLATIONS[ language ];
-
-	languageTranslations.dictionary = languageTranslations.dictionary || {};
-	languageTranslations.getPluralForm = getPluralForm || languageTranslations.getPluralForm;
-
-	Object.assign( languageTranslations.dictionary, translations );
+export function add(language, translations, getPluralForm) {
+    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;
+    Object.assign(languageTranslations.dictionary, translations);
 }
-
 /**
  * **Note:** This method is internal, use {@link module:utils/locale~Locale#t the `t()` function} instead to translate
  * the editor UI parts.
@@ -135,82 +127,54 @@ export function add( language, translations, getPluralForm ) {
  * @param {Number} [quantity] The number of elements for which a plural form should be picked from the target language dictionary.
  * @returns {String} Translated sentence.
  */
-export function _translate( language, message, quantity = 1 ) {
-	if ( typeof quantity !== 'number' ) {
-		/**
-		 * An incorrect value was passed to the translation function. This was probably caused
-		 * by an incorrect message interpolation of a plural form. Note that for messages supporting plural forms
-		 * the second argument of the `t()` function should always be a number or an array with a number as the first element.
-		 *
-		 * @error translation-service-quantity-not-a-number
-		 */
-		throw new CKEditorError( 'translation-service-quantity-not-a-number', null, { quantity } );
-	}
-
-	const numberOfLanguages = getNumberOfLanguages();
-
-	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( window.CKEDITOR_TRANSLATIONS )[ 0 ];
-	}
-
-	const messageId = message.id || message.string;
-
-	if ( numberOfLanguages === 0 || !hasTranslation( language, messageId ) ) {
-		if ( quantity !== 1 ) {
-			// Return the default plural form that was passed in the `message.plural` parameter.
-			return message.plural;
-		}
-
-		return message.string;
-	}
-
-	const dictionary = window.CKEDITOR_TRANSLATIONS[ language ].dictionary;
-	const getPluralForm = window.CKEDITOR_TRANSLATIONS[ language ].getPluralForm || ( n => n === 1 ? 0 : 1 );
-
-	if ( typeof dictionary[ messageId ] === 'string' ) {
-		return dictionary[ messageId ];
-	}
-
-	const pluralFormIndex = Number( getPluralForm( quantity ) );
-
-	// Note: The `translate` function is not responsible for replacing `%0, %1, ...` with values.
-	return dictionary[ messageId ][ pluralFormIndex ];
+export function _translate(language, message, quantity = 1) {
+    if (typeof quantity !== 'number') {
+        /**
+         * An incorrect value was passed to the translation function. This was probably caused
+         * by an incorrect message interpolation of a plural form. Note that for messages supporting plural forms
+         * the second argument of the `t()` function should always be a number or an array with a number as the first element.
+         *
+         * @error translation-service-quantity-not-a-number
+         */
+        throw new CKEditorError('translation-service-quantity-not-a-number', null, { quantity });
+    }
+    const numberOfLanguages = getNumberOfLanguages();
+    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];
+    }
+    const messageId = message.id || message.string;
+    if (numberOfLanguages === 0 || !hasTranslation(language, messageId)) {
+        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 translation = dictionary[messageId];
+    if (typeof translation === 'string') {
+        return translation;
+    }
+    const pluralFormIndex = Number(getPluralForm(quantity));
+    // Note: The `translate` function is not responsible for replacing `%0, %1, ...` with values.
+    return translation[pluralFormIndex];
 }
-
 /**
  * Clears dictionaries for test purposes.
  *
  * @protected
  */
 export function _clear() {
-	window.CKEDITOR_TRANSLATIONS = {};
+    global.window.CKEDITOR_TRANSLATIONS = {};
 }
-
 // Checks whether the dictionary exists and translation in that dictionary exists.
-function hasTranslation( language, messageId ) {
-	return (
-		!!window.CKEDITOR_TRANSLATIONS[ language ] &&
-		!!window.CKEDITOR_TRANSLATIONS[ language ].dictionary[ messageId ]
-	);
+function hasTranslation(language, messageId) {
+    return (!!global.window.CKEDITOR_TRANSLATIONS[language] &&
+        !!global.window.CKEDITOR_TRANSLATIONS[language].dictionary[messageId]);
 }
-
 function getNumberOfLanguages() {
-	return Object.keys( window.CKEDITOR_TRANSLATIONS ).length;
+    return Object.keys(global.window.CKEDITOR_TRANSLATIONS).length;
 }
-
-/**
- * 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.
- *
- * @typedef {Object} module:utils/translation-service~Message
- *
- * @property {String} string 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.
- * @property {String} [id] 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.
- * @property {String} [plural] 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.
- */

package/src/uid.js

@@ -2,16 +2,13 @@
  * @license Copyright (c) 2003-2022, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-
 /**
  * @module utils/uid
  */
-
 // A hash table of hex numbers to avoid using toString() in uid() which is costly.
 // [ '00', '01', '02', ..., 'fe', 'ff' ]
-const HEX_NUMBERS = new Array( 256 ).fill()
-	.map( ( val, index ) => ( '0' + ( index ).toString( 16 ) ).slice( -2 ) );
-
+const HEX_NUMBERS = new Array(256).fill('')
+    .map((_, index) => ('0' + (index).toString(16)).slice(-2));
 /**
  * Returns a unique id. The id starts with an "e" character and a randomly generated string of
  * 32 alphanumeric characters.
@@ -23,37 +20,36 @@ const HEX_NUMBERS = new Array( 256 ).fill()
  * @returns {String} An unique id string.
  */
 export default function uid() {
-	// Let's create some positive random 32bit integers first.
-	//
-	// 1. Math.random() is a float between 0 and 1.
-	// 2. 0x100000000 is 2^32 = 4294967296.
-	// 3. >>> 0 enforces integer (in JS all numbers are floating point).
-	//
-	// For instance:
-	//		Math.random() * 0x100000000 = 3366450031.853859
-	// but
-	//		Math.random() * 0x100000000 >>> 0 = 3366450031.
-	const r1 = Math.random() * 0x100000000 >>> 0;
-	const r2 = Math.random() * 0x100000000 >>> 0;
-	const r3 = Math.random() * 0x100000000 >>> 0;
-	const r4 = Math.random() * 0x100000000 >>> 0;
-
-	// Make sure that id does not start with number.
-	return 'e' +
-		HEX_NUMBERS[ r1 >> 0 & 0xFF ] +
-		HEX_NUMBERS[ r1 >> 8 & 0xFF ] +
-		HEX_NUMBERS[ r1 >> 16 & 0xFF ] +
-		HEX_NUMBERS[ r1 >> 24 & 0xFF ] +
-		HEX_NUMBERS[ r2 >> 0 & 0xFF ] +
-		HEX_NUMBERS[ r2 >> 8 & 0xFF ] +
-		HEX_NUMBERS[ r2 >> 16 & 0xFF ] +
-		HEX_NUMBERS[ r2 >> 24 & 0xFF ] +
-		HEX_NUMBERS[ r3 >> 0 & 0xFF ] +
-		HEX_NUMBERS[ r3 >> 8 & 0xFF ] +
-		HEX_NUMBERS[ r3 >> 16 & 0xFF ] +
-		HEX_NUMBERS[ r3 >> 24 & 0xFF ] +
-		HEX_NUMBERS[ r4 >> 0 & 0xFF ] +
-		HEX_NUMBERS[ r4 >> 8 & 0xFF ] +
-		HEX_NUMBERS[ r4 >> 16 & 0xFF ] +
-		HEX_NUMBERS[ r4 >> 24 & 0xFF ];
+    // Let's create some positive random 32bit integers first.
+    //
+    // 1. Math.random() is a float between 0 and 1.
+    // 2. 0x100000000 is 2^32 = 4294967296.
+    // 3. >>> 0 enforces integer (in JS all numbers are floating point).
+    //
+    // For instance:
+    //		Math.random() * 0x100000000 = 3366450031.853859
+    // but
+    //		Math.random() * 0x100000000 >>> 0 = 3366450031.
+    const r1 = Math.random() * 0x100000000 >>> 0;
+    const r2 = Math.random() * 0x100000000 >>> 0;
+    const r3 = Math.random() * 0x100000000 >>> 0;
+    const r4 = Math.random() * 0x100000000 >>> 0;
+    // Make sure that id does not start with number.
+    return 'e' +
+        HEX_NUMBERS[r1 >> 0 & 0xFF] +
+        HEX_NUMBERS[r1 >> 8 & 0xFF] +
+        HEX_NUMBERS[r1 >> 16 & 0xFF] +
+        HEX_NUMBERS[r1 >> 24 & 0xFF] +
+        HEX_NUMBERS[r2 >> 0 & 0xFF] +
+        HEX_NUMBERS[r2 >> 8 & 0xFF] +
+        HEX_NUMBERS[r2 >> 16 & 0xFF] +
+        HEX_NUMBERS[r2 >> 24 & 0xFF] +
+        HEX_NUMBERS[r3 >> 0 & 0xFF] +
+        HEX_NUMBERS[r3 >> 8 & 0xFF] +
+        HEX_NUMBERS[r3 >> 16 & 0xFF] +
+        HEX_NUMBERS[r3 >> 24 & 0xFF] +
+        HEX_NUMBERS[r4 >> 0 & 0xFF] +
+        HEX_NUMBERS[r4 >> 8 & 0xFF] +
+        HEX_NUMBERS[r4 >> 16 & 0xFF] +
+        HEX_NUMBERS[r4 >> 24 & 0xFF];
 }

package/src/unicode.js

@@ -2,24 +2,21 @@
  * @license Copyright (c) 2003-2022, 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 {String} character Character to check.
  * @returns {Boolean}
  */
-export function isCombiningMark( character ) {
-	// eslint-disable-next-line no-misleading-character-class
-	return !!character && character.length == 1 && /[\u0300-\u036f\u1ab0-\u1aff\u1dc0-\u1dff\u20d0-\u20ff\ufe20-\ufe2f]/.test( character );
+export function isCombiningMark(character) {
+    // eslint-disable-next-line no-misleading-character-class
+    return !!character && character.length == 1 && /[\u0300-\u036f\u1ab0-\u1aff\u1dc0-\u1dff\u20d0-\u20ff\ufe20-\ufe2f]/.test(character);
 }
-
 /**
  * Checks whether given `character` is a high half of surrogate pair.
  *
@@ -29,10 +26,9 @@ export function isCombiningMark( character ) {
  * @param {String} character Character to check.
  * @returns {Boolean}
  */
-export function isHighSurrogateHalf( character ) {
-	return !!character && character.length == 1 && /[\ud800-\udbff]/.test( character );
+export function isHighSurrogateHalf(character) {
+    return !!character && character.length == 1 && /[\ud800-\udbff]/.test(character);
 }
-
 /**
  * Checks whether given `character` is a low half of surrogate pair.
  *
@@ -42,10 +38,9 @@ export function isHighSurrogateHalf( character ) {
  * @param {String} character Character to check.
  * @returns {Boolean}
  */
-export function isLowSurrogateHalf( character ) {
-	return !!character && character.length == 1 && /[\udc00-\udfff]/.test( character );
+export function isLowSurrogateHalf(character) {
+    return !!character && character.length == 1 && /[\udc00-\udfff]/.test(character);
 }
-
 /**
  * Checks whether given offset in a string is inside a surrogate pair (between two surrogate halves).
  *
@@ -53,10 +48,9 @@ export function isLowSurrogateHalf( character ) {
  * @param {Number} offset Offset to check.
  * @returns {Boolean}
  */
-export function isInsideSurrogatePair( string, offset ) {
-	return isHighSurrogateHalf( string.charAt( offset - 1 ) ) && isLowSurrogateHalf( string.charAt( offset ) );
+export function isInsideSurrogatePair(string, offset) {
+    return isHighSurrogateHalf(string.charAt(offset - 1)) && isLowSurrogateHalf(string.charAt(offset));
 }
-
 /**
  * Checks whether given offset in a string is between base character and combining mark or between two combining marks.
  *
@@ -64,12 +58,10 @@ export function isInsideSurrogatePair( string, offset ) {
  * @param {Number} offset Offset to check.
  * @returns {Boolean}
  */
-export function isInsideCombinedSymbol( string, offset ) {
-	return isCombiningMark( string.charAt( offset ) );
+export function isInsideCombinedSymbol(string, offset) {
+    return isCombiningMark(string.charAt(offset));
 }
-
 const EMOJI_PATTERN = buildEmojiRegexp();
-
 /**
  * Checks whether given offset in a string is inside multi-character emoji sequence.
  *
@@ -77,30 +69,23 @@ const EMOJI_PATTERN = buildEmojiRegexp();
  * @param {Number} offset Offset to check.
  * @returns {Boolean}
  */
-export function isInsideEmojiSequence( string, offset ) {
-	const matches = String( string ).matchAll( EMOJI_PATTERN );
-
-	return Array.from( matches ).some( match => match.index < offset && offset < match.index + match[ 0 ].length );
+export function isInsideEmojiSequence(string, offset) {
+    const matches = String(string).matchAll(EMOJI_PATTERN);
+    return Array.from(matches).some(match => match.index < offset && offset < match.index + match[0].length);
 }
-
 function buildEmojiRegexp() {
-	const parts = [
-		// Emoji Tag Sequence (ETS)
-		/\p{Emoji}[\u{E0020}-\u{E007E}]+\u{E007F}/u,
-
-		// Emoji Keycap Sequence
-		/\p{Emoji}\u{FE0F}?\u{20E3}/u,
-
-		// Emoji Presentation Sequence
-		/\p{Emoji}\u{FE0F}/u,
-
-		// Single-Character Emoji / Emoji Modifier Sequence
-		/(?=\p{General_Category=Other_Symbol})\p{Emoji}\p{Emoji_Modifier}*/u
-	];
-
-	const flagSequence = /\p{Regional_Indicator}{2}/u.source;
-	const emoji = '(?:' + parts.map( part => part.source ).join( '|' ) + ')';
-	const sequence = `${ flagSequence }|${ emoji }(?:\u{200D}${ emoji })*`;
-
-	return new RegExp( sequence, 'ug' );
+    const parts = [
+        // Emoji Tag Sequence (ETS)
+        /\p{Emoji}[\u{E0020}-\u{E007E}]+\u{E007F}/u,
+        // Emoji Keycap Sequence
+        /\p{Emoji}\u{FE0F}?\u{20E3}/u,
+        // Emoji Presentation Sequence
+        /\p{Emoji}\u{FE0F}/u,
+        // Single-Character Emoji / Emoji Modifier Sequence
+        /(?=\p{General_Category=Other_Symbol})\p{Emoji}\p{Emoji_Modifier}*/u
+    ];
+    const flagSequence = /\p{Regional_Indicator}{2}/u.source;
+    const emoji = '(?:' + parts.map(part => part.source).join('|') + ')';
+    const sequence = `${flagSequence}|${emoji}(?:\u{200D}${emoji})*`;
+    return new RegExp(sequence, 'ug');
 }