@ckeditor/ckeditor5-utils 34.2.0 → 35.1.0

package/src/env.js

@@ -2,170 +2,165 @@
  * @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 navigator:false */
-
 /**
  * @module utils/env
  */
-
-const userAgent = navigator.userAgent.toLowerCase();
-
+/**
+ * Safely returns `userAgent` from browser's navigator API in a lower case.
+ * If navigator API is not available it will return an empty string.
+ *
+ * @returns {String}
+ */
+export function getUserAgent() {
+    // In some environments navigator API might not be available.
+    try {
+        return navigator.userAgent.toLowerCase();
+    }
+    catch (e) {
+        return '';
+    }
+}
+const userAgent = getUserAgent();
 /**
  * A namespace containing environment and browser information.
  *
  * @namespace
  */
 const env = {
-	/**
-	 * Indicates that the application is running on Macintosh.
-	 *
-	 * @static
-	 * @type {Boolean}
-	 */
-	isMac: isMac( userAgent ),
-
-	/**
-	 * Indicates that the application is running on Windows.
-	 *
-	 * @static
-	 * @type {Boolean}
-	 */
-	isWindows: isWindows( userAgent ),
-
-	/**
-	 * Indicates that the application is running in Firefox (Gecko).
-	 *
-	 * @static
-	 * @type {Boolean}
-	 */
-	isGecko: isGecko( userAgent ),
-
-	/**
-	 * Indicates that the application is running in Safari.
-	 *
-	 * @static
-	 * @type {Boolean}
-	 */
-	isSafari: isSafari( userAgent ),
-
-	/**
-	 * Indicates the the application is running in iOS.
-	 *
-	 * @static
-	 * @type {Boolean}
-	 */
-	isiOS: isiOS( userAgent ),
-
-	/**
-	 * Indicates that the application is running on Android mobile device.
-	 *
-	 * @static
-	 * @type {Boolean}
-	 */
-	isAndroid: isAndroid( userAgent ),
-
-	/**
-	 * Indicates that the application is running in a browser using the Blink engine.
-	 *
-	 * @static
-	 * @type {Boolean}
-	 */
-	isBlink: isBlink( userAgent ),
-
-	/**
-	 * Environment features information.
-	 *
-	 * @memberOf module:utils/env~env
-	 * @namespace
-	 */
-	features: {
-		/**
-		 * Indicates that the environment supports ES2018 Unicode property escapes — like `\p{P}` or `\p{L}`.
-		 * More information about unicode properties might be found
-		 * [in Unicode Standard Annex #44](https://www.unicode.org/reports/tr44/#GC_Values_Table).
-		 *
-		 * @type {Boolean}
-		 */
-		isRegExpUnicodePropertySupported: isRegExpUnicodePropertySupported()
-	}
+    /**
+     * Indicates that the application is running on Macintosh.
+     *
+     * @static
+     * @type {Boolean}
+     */
+    isMac: isMac(userAgent),
+    /**
+     * Indicates that the application is running on Windows.
+     *
+     * @static
+     * @type {Boolean}
+     */
+    isWindows: isWindows(userAgent),
+    /**
+     * Indicates that the application is running in Firefox (Gecko).
+     *
+     * @static
+     * @type {Boolean}
+     */
+    isGecko: isGecko(userAgent),
+    /**
+     * Indicates that the application is running in Safari.
+     *
+     * @static
+     * @type {Boolean}
+     */
+    isSafari: isSafari(userAgent),
+    /**
+     * Indicates the the application is running in iOS.
+     *
+     * @static
+     * @type {Boolean}
+     */
+    isiOS: isiOS(userAgent),
+    /**
+     * Indicates that the application is running on Android mobile device.
+     *
+     * @static
+     * @type {Boolean}
+     */
+    isAndroid: isAndroid(userAgent),
+    /**
+     * Indicates that the application is running in a browser using the Blink engine.
+     *
+     * @static
+     * @type {Boolean}
+     */
+    isBlink: isBlink(userAgent),
+    /**
+     * Environment features information.
+     *
+     * @memberOf module:utils/env~env
+     * @namespace
+     */
+    features: {
+        /**
+         * Indicates that the environment supports ES2018 Unicode property escapes — like `\p{P}` or `\p{L}`.
+         * More information about unicode properties might be found
+         * [in Unicode Standard Annex #44](https://www.unicode.org/reports/tr44/#GC_Values_Table).
+         *
+         * @type {Boolean}
+         */
+        isRegExpUnicodePropertySupported: isRegExpUnicodePropertySupported()
+    }
 };
-
 export default env;
-
 /**
  * Checks if User Agent represented by the string is running on Macintosh.
  *
  * @param {String} userAgent **Lowercase** `navigator.userAgent` string.
  * @returns {Boolean} Whether User Agent is running on Macintosh or not.
  */
-export function isMac( userAgent ) {
-	return userAgent.indexOf( 'macintosh' ) > -1;
+export function isMac(userAgent) {
+    return userAgent.indexOf('macintosh') > -1;
 }
-
 /**
  * Checks if User Agent represented by the string is running on Windows.
  *
  * @param {String} userAgent **Lowercase** `navigator.userAgent` string.
  * @returns {Boolean} Whether User Agent is running on Windows or not.
  */
-export function isWindows( userAgent ) {
-	return userAgent.indexOf( 'windows' ) > -1;
+export function isWindows(userAgent) {
+    return userAgent.indexOf('windows') > -1;
 }
-
 /**
  * Checks if User Agent represented by the string is Firefox (Gecko).
  *
  * @param {String} userAgent **Lowercase** `navigator.userAgent` string.
  * @returns {Boolean} Whether User Agent is Firefox or not.
  */
-export function isGecko( userAgent ) {
-	return !!userAgent.match( /gecko\/\d+/ );
+export function isGecko(userAgent) {
+    return !!userAgent.match(/gecko\/\d+/);
 }
-
 /**
  * Checks if User Agent represented by the string is Safari.
  *
  * @param {String} userAgent **Lowercase** `navigator.userAgent` string.
  * @returns {Boolean} Whether User Agent is Safari or not.
  */
-export function isSafari( userAgent ) {
-	return userAgent.indexOf( ' applewebkit/' ) > -1 && userAgent.indexOf( 'chrome' ) === -1;
+export function isSafari(userAgent) {
+    return userAgent.indexOf(' applewebkit/') > -1 && userAgent.indexOf('chrome') === -1;
 }
-
 /**
  * Checks if User Agent represented by the string is running in iOS.
  *
  * @param {String} userAgent **Lowercase** `navigator.userAgent` string.
  * @returns {Boolean} Whether User Agent is running in iOS or not.
  */
-export function isiOS( userAgent ) {
-	// "Request mobile site" || "Request desktop site".
-	return !!userAgent.match( /iphone|ipad/i ) || ( isMac( userAgent ) && navigator.maxTouchPoints > 0 );
+export function isiOS(userAgent) {
+    // "Request mobile site" || "Request desktop site".
+    return !!userAgent.match(/iphone|ipad/i) || (isMac(userAgent) && navigator.maxTouchPoints > 0);
 }
-
 /**
  * Checks if User Agent represented by the string is Android mobile device.
  *
  * @param {String} userAgent **Lowercase** `navigator.userAgent` string.
  * @returns {Boolean} Whether User Agent is Safari or not.
  */
-export function isAndroid( userAgent ) {
-	return userAgent.indexOf( 'android' ) > -1;
+export function isAndroid(userAgent) {
+    return userAgent.indexOf('android') > -1;
 }
-
 /**
  * Checks if User Agent represented by the string is Blink engine.
  *
  * @param {String} userAgent **Lowercase** `navigator.userAgent` string.
  * @returns {Boolean} Whether User Agent is Blink engine or not.
  */
-export function isBlink( userAgent ) {
-	// The Edge browser before switching to the Blink engine used to report itself as Chrome (and "Edge/")
-	// but after switching to the Blink it replaced "Edge/" with "Edg/".
-	return userAgent.indexOf( 'chrome/' ) > -1 && userAgent.indexOf( 'edge/' ) < 0;
+export function isBlink(userAgent) {
+    // The Edge browser before switching to the Blink engine used to report itself as Chrome (and "Edge/")
+    // but after switching to the Blink it replaced "Edge/" with "Edg/".
+    return userAgent.indexOf('chrome/') > -1 && userAgent.indexOf('edge/') < 0;
 }
-
 /**
  * Checks if the current environment supports ES2018 Unicode properties like `\p{P}` or `\p{L}`.
  * More information about unicode properties might be found
@@ -174,17 +169,15 @@ export function isBlink( userAgent ) {
  * @returns {Boolean}
  */
 export function isRegExpUnicodePropertySupported() {
-	let isSupported = false;
-
-	// Feature detection for Unicode properties. Added in ES2018. Currently Firefox does not support it.
-	// See https://github.com/ckeditor/ckeditor5-mention/issues/44#issuecomment-487002174.
-
-	try {
-		// Usage of regular expression literal cause error during build (ckeditor/ckeditor5-dev#534).
-		isSupported = 'ć'.search( new RegExp( '[\\p{L}]', 'u' ) ) === 0;
-	} catch ( error ) {
-		// Firefox throws a SyntaxError when the group is unsupported.
-	}
-
-	return isSupported;
+    let isSupported = false;
+    // Feature detection for Unicode properties. Added in ES2018. Currently Firefox does not support it.
+    // See https://github.com/ckeditor/ckeditor5-mention/issues/44#issuecomment-487002174.
+    try {
+        // Usage of regular expression literal cause error during build (ckeditor/ckeditor5-dev#534).
+        isSupported = 'ć'.search(new RegExp('[\\p{L}]', 'u')) === 0;
+    }
+    catch (error) {
+        // Firefox throws a SyntaxError when the group is unsupported.
+    }
+    return isSupported;
 }

package/src/eventinfo.js

@@ -2,78 +2,25 @@
  * @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/eventinfo
  */
-
 import spy from './spy';
-
 /**
  * The event object passed to event callbacks. It is used to provide information about the event as well as a tool to
  * manipulate it.
  */
 export default class EventInfo {
-	/**
-	 * @param {Object} source The emitter.
-	 * @param {String} name The event name.
-	 */
-	constructor( source, name ) {
-		/**
-		 * The object that fired the event.
-		 *
-		 * @readonly
-		 * @member {Object}
-		 */
-		this.source = source;
-
-		/**
-		 * The event name.
-		 *
-		 * @readonly
-		 * @member {String}
-		 */
-		this.name = name;
-
-		/**
-		 * Path this event has followed. See {@link module:utils/emittermixin~EmitterMixin#delegate}.
-		 *
-		 * @readonly
-		 * @member {Array.<Object>}
-		 */
-		this.path = [];
-
-		// The following methods are defined in the constructor because they must be re-created per instance.
-
-		/**
-		 * Stops the event emitter to call further callbacks for this event interaction.
-		 *
-		 * @method #stop
-		 */
-		this.stop = spy();
-
-		/**
-		 * Removes the current callback from future interactions of this event.
-		 *
-		 * @method #off
-		 */
-		this.off = spy();
-
-		/**
-		 * The value which will be returned by {@link module:utils/emittermixin~EmitterMixin#fire}.
-		 *
-		 * It's `undefined` by default and can be changed by an event listener:
-		 *
-		 *		dataController.fire( 'getSelectedContent', ( evt ) => {
-		 *			// This listener will make `dataController.fire( 'getSelectedContent' )`
-		 *			// always return an empty DocumentFragment.
-		 *			evt.return = new DocumentFragment();
-		 *
-		 *			// Make sure no other listeners are executed.
-		 *			evt.stop();
-		 *		} );
-		 *
-		 * @member #return
-		 */
-	}
+    /**
+     * @param {Object} source The emitter.
+     * @param {String} name The event name.
+     */
+    constructor(source, name) {
+        this.source = source;
+        this.name = name;
+        this.path = [];
+        // The following methods are defined in the constructor because they must be re-created per instance.
+        this.stop = spy();
+        this.off = spy();
+    }
 }

package/src/fastdiff.js

@@ -2,11 +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/fastdiff
- */
-
 /**
  * Finds positions of the first and last change in the given string/array and generates a set of changes:
  *
@@ -94,33 +89,24 @@
  * be returned instead of changes set. This makes this function compatible with {@link module:utils/diff~diff `diff()`}.
  * @returns {Array} Array of changes.
  */
-export default function fastDiff( a, b, cmp, atomicChanges = false ) {
-	// Set the comparator function.
-	cmp = cmp || function( a, b ) {
-		return a === b;
-	};
-
-	// Convert the string (or any array-like object - eg. NodeList) to an array by using the slice() method because,
-	// unlike Array.from(), it returns array of UTF-16 code units instead of the code points of a string.
-	// One code point might be a surrogate pair of two code units. All text offsets are expected to be in code units.
-	// See ckeditor/ckeditor5#3147.
-	//
-	// We need to make sure here that fastDiff() works identical to diff().
-	if ( !Array.isArray( a ) ) {
-		a = Array.prototype.slice.call( a );
-	}
-
-	if ( !Array.isArray( b ) ) {
-		b = Array.prototype.slice.call( b );
-	}
-
-	// Find first and last change.
-	const changeIndexes = findChangeBoundaryIndexes( a, b, cmp );
-
-	// Transform into changes array.
-	return atomicChanges ? changeIndexesToAtomicChanges( changeIndexes, b.length ) : changeIndexesToChanges( b, changeIndexes );
+export default function fastDiff(a, b, cmp, atomicChanges = false) {
+    // Set the comparator function.
+    cmp = cmp || function (a, b) {
+        return a === b;
+    };
+    // Convert the string (or any array-like object - eg. NodeList) to an array by using the slice() method because,
+    // unlike Array.from(), it returns array of UTF-16 code units instead of the code points of a string.
+    // One code point might be a surrogate pair of two code units. All text offsets are expected to be in code units.
+    // See ckeditor/ckeditor5#3147.
+    //
+    // We need to make sure here that fastDiff() works identical to diff().
+    const arrayA = Array.isArray(a) ? a : Array.prototype.slice.call(a);
+    const arrayB = Array.isArray(b) ? b : Array.prototype.slice.call(b);
+    // Find first and last change.
+    const changeIndexes = findChangeBoundaryIndexes(arrayA, arrayB, cmp);
+    // Transform into changes array.
+    return atomicChanges ? changeIndexesToAtomicChanges(changeIndexes, arrayB.length) : changeIndexesToChanges(arrayB, changeIndexes);
 }
-
 // Finds position of the first and last change in the given arrays. For example:
 //
 //		const indexes = findChangeBoundaryIndexes( [ '1', '2', '3', '4' ], [ '1', '3', '4', '2', '4' ] );
@@ -137,125 +123,107 @@ export default function fastDiff( a, b, cmp, atomicChanges = false ) {
 // @returns {Number} return.firstIndex Index of the first change in both values (always the same for both).
 // @returns {Number} result.lastIndexOld Index of the last common value in `arr1`.
 // @returns {Number} result.lastIndexNew Index of the last common value in `arr2`.
-function findChangeBoundaryIndexes( arr1, arr2, cmp ) {
-	// Find the first difference between passed values.
-	const firstIndex = findFirstDifferenceIndex( arr1, arr2, cmp );
-
-	// If arrays are equal return -1 indexes object.
-	if ( firstIndex === -1 ) {
-		return { firstIndex: -1, lastIndexOld: -1, lastIndexNew: -1 };
-	}
-
-	// Remove the common part of each value and reverse them to make it simpler to find the last difference between them.
-	const oldArrayReversed = cutAndReverse( arr1, firstIndex );
-	const newArrayReversed = cutAndReverse( arr2, firstIndex );
-
-	// Find the first difference between reversed values.
-	// It should be treated as "how many elements from the end the last difference occurred".
-	//
-	// For example:
-	//
-	// 				initial	->	after cut	-> reversed:
-	// oldValue:	'321ba'	->	'21ba'		-> 'ab12'
-	// newValue:	'31xba'	->	'1xba'		-> 'abx1'
-	// lastIndex:							-> 2
-	//
-	// So the last change occurred two characters from the end of the arrays.
-	const lastIndex = findFirstDifferenceIndex( oldArrayReversed, newArrayReversed, cmp );
-
-	// Use `lastIndex` to calculate proper offset, starting from the beginning (`lastIndex` kind of starts from the end).
-	const lastIndexOld = arr1.length - lastIndex;
-	const lastIndexNew = arr2.length - lastIndex;
-
-	return { firstIndex, lastIndexOld, lastIndexNew };
+function findChangeBoundaryIndexes(arr1, arr2, cmp) {
+    // Find the first difference between passed values.
+    const firstIndex = findFirstDifferenceIndex(arr1, arr2, cmp);
+    // If arrays are equal return -1 indexes object.
+    if (firstIndex === -1) {
+        return { firstIndex: -1, lastIndexOld: -1, lastIndexNew: -1 };
+    }
+    // Remove the common part of each value and reverse them to make it simpler to find the last difference between them.
+    const oldArrayReversed = cutAndReverse(arr1, firstIndex);
+    const newArrayReversed = cutAndReverse(arr2, firstIndex);
+    // Find the first difference between reversed values.
+    // It should be treated as "how many elements from the end the last difference occurred".
+    //
+    // For example:
+    //
+    // 				initial	->	after cut	-> reversed:
+    // oldValue:	'321ba'	->	'21ba'		-> 'ab12'
+    // newValue:	'31xba'	->	'1xba'		-> 'abx1'
+    // lastIndex:							-> 2
+    //
+    // So the last change occurred two characters from the end of the arrays.
+    const lastIndex = findFirstDifferenceIndex(oldArrayReversed, newArrayReversed, cmp);
+    // Use `lastIndex` to calculate proper offset, starting from the beginning (`lastIndex` kind of starts from the end).
+    const lastIndexOld = arr1.length - lastIndex;
+    const lastIndexNew = arr2.length - lastIndex;
+    return { firstIndex, lastIndexOld, lastIndexNew };
 }
-
 // Returns a first index on which given arrays differ. If both arrays are the same, -1 is returned.
 //
 // @param {Array} arr1
 // @param {Array} arr2
 // @param {Function} cmp Comparator function.
 // @returns {Number}
-function findFirstDifferenceIndex( arr1, arr2, cmp ) {
-	for ( let i = 0; i < Math.max( arr1.length, arr2.length ); i++ ) {
-		if ( arr1[ i ] === undefined || arr2[ i ] === undefined || !cmp( arr1[ i ], arr2[ i ] ) ) {
-			return i;
-		}
-	}
-
-	return -1; // Return -1 if arrays are equal.
+function findFirstDifferenceIndex(arr1, arr2, cmp) {
+    for (let i = 0; i < Math.max(arr1.length, arr2.length); i++) {
+        if (arr1[i] === undefined || arr2[i] === undefined || !cmp(arr1[i], arr2[i])) {
+            return i;
+        }
+    }
+    return -1; // Return -1 if arrays are equal.
 }
-
 // Returns a copy of the given array with `howMany` elements removed starting from the beginning and in reversed order.
 //
 // @param {Array} arr Array to be processed.
 // @param {Number} howMany How many elements from array beginning to remove.
 // @returns {Array} Shortened and reversed array.
-function cutAndReverse( arr, howMany ) {
-	return arr.slice( howMany ).reverse();
+function cutAndReverse(arr, howMany) {
+    return arr.slice(howMany).reverse();
 }
-
 // Generates changes array based on change indexes from `findChangeBoundaryIndexes` function. This function will
 // generate array with 0 (no changes), 1 (deletion or insertion) or 2 records (insertion and deletion).
 //
 // @param {Array} newArray New array for which change indexes were calculated.
 // @param {Object} changeIndexes Change indexes object from `findChangeBoundaryIndexes` function.
-// @returns {Array.<Object>} Array of changes compatible with {@link module:utils/difftochanges~diffToChanges} format.
-function changeIndexesToChanges( newArray, changeIndexes ) {
-	const result = [];
-	const { firstIndex, lastIndexOld, lastIndexNew } = changeIndexes;
-
-	// Order operations as 'insert', 'delete' array to keep compatibility with {@link module:utils/difftochanges~diffToChanges}
-	// in most cases. However, 'diffToChanges' does not stick to any order so in some cases
-	// (for example replacing '12345' with 'abcd') it will generate 'delete', 'insert' order.
-	if ( lastIndexNew - firstIndex > 0 ) {
-		result.push( {
-			index: firstIndex,
-			type: 'insert',
-			values: newArray.slice( firstIndex, lastIndexNew )
-		} );
-	}
-
-	if ( lastIndexOld - firstIndex > 0 ) {
-		result.push( {
-			index: firstIndex + ( lastIndexNew - firstIndex ), // Increase index of what was inserted.
-			type: 'delete',
-			howMany: lastIndexOld - firstIndex
-		} );
-	}
-
-	return result;
+// @returns {Array.<module:utils/difftochanges~Change>} Array of changes compatible with
+// {@link module:utils/difftochanges~diffToChanges} format.
+function changeIndexesToChanges(newArray, changeIndexes) {
+    const result = [];
+    const { firstIndex, lastIndexOld, lastIndexNew } = changeIndexes;
+    // Order operations as 'insert', 'delete' array to keep compatibility with {@link module:utils/difftochanges~diffToChanges}
+    // in most cases. However, 'diffToChanges' does not stick to any order so in some cases
+    // (for example replacing '12345' with 'abcd') it will generate 'delete', 'insert' order.
+    if (lastIndexNew - firstIndex > 0) {
+        result.push({
+            index: firstIndex,
+            type: 'insert',
+            values: newArray.slice(firstIndex, lastIndexNew)
+        });
+    }
+    if (lastIndexOld - firstIndex > 0) {
+        result.push({
+            index: firstIndex + (lastIndexNew - firstIndex),
+            type: 'delete',
+            howMany: lastIndexOld - firstIndex
+        });
+    }
+    return result;
 }
-
 // Generates array with set `equal|insert|delete` operations based on change indexes from `findChangeBoundaryIndexes` function.
 //
 // @param {Object} changeIndexes Change indexes object from `findChangeBoundaryIndexes` function.
 // @param {Number} newLength Length of the new array on which `findChangeBoundaryIndexes` calculated change indexes.
-// @returns {Array.<String>} Array of changes compatible with {@link module:utils/diff~diff} format.
-function changeIndexesToAtomicChanges( changeIndexes, newLength ) {
-	const { firstIndex, lastIndexOld, lastIndexNew } = changeIndexes;
-
-	// No changes.
-	if ( firstIndex === -1 ) {
-		return Array( newLength ).fill( 'equal' );
-	}
-
-	let result = [];
-	if ( firstIndex > 0 ) {
-		result = result.concat( Array( firstIndex ).fill( 'equal' ) );
-	}
-
-	if ( lastIndexNew - firstIndex > 0 ) {
-		result = result.concat( Array( lastIndexNew - firstIndex ).fill( 'insert' ) );
-	}
-
-	if ( lastIndexOld - firstIndex > 0 ) {
-		result = result.concat( Array( lastIndexOld - firstIndex ).fill( 'delete' ) );
-	}
-
-	if ( lastIndexNew < newLength ) {
-		result = result.concat( Array( newLength - lastIndexNew ).fill( 'equal' ) );
-	}
-
-	return result;
+// @returns {Array.<module:utils/diff~DiffResult>} Array of changes compatible with {@link module:utils/diff~diff} format.
+function changeIndexesToAtomicChanges(changeIndexes, newLength) {
+    const { firstIndex, lastIndexOld, lastIndexNew } = changeIndexes;
+    // No changes.
+    if (firstIndex === -1) {
+        return Array(newLength).fill('equal');
+    }
+    let result = [];
+    if (firstIndex > 0) {
+        result = result.concat(Array(firstIndex).fill('equal'));
+    }
+    if (lastIndexNew - firstIndex > 0) {
+        result = result.concat(Array(lastIndexNew - firstIndex).fill('insert'));
+    }
+    if (lastIndexOld - firstIndex > 0) {
+        result = result.concat(Array(lastIndexOld - firstIndex).fill('delete'));
+    }
+    if (lastIndexNew < newLength) {
+        result = result.concat(Array(newLength - lastIndexNew).fill('equal'));
+    }
+    return result;
 }