@ckeditor/ckeditor5-utils 34.2.0 → 35.0.0

package/src/env.js

@@ -1,190 +0,0 @@
-/**
- * @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();
-
-/**
- * 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()
-	}
-};
-
-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;
-}
-
-/**
- * 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;
-}
-
-/**
- * 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+/ );
-}
-
-/**
- * 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;
-}
-
-/**
- * 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 );
-}
-
-/**
- * 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;
-}
-
-/**
- * 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;
-}
-
-/**
- * Checks if the current environment supports ES2018 Unicode properties 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).
- *
- * @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;
-}

package/src/eventinfo.js

@@ -1,79 +0,0 @@
-/**
- * @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
-		 */
-	}
-}

package/src/fastdiff.js

@@ -1,261 +0,0 @@
-/**
- * @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:
- *
- *		fastDiff( '12a', '12xyza' );
- *		// [ { index: 2, type: 'insert', values: [ 'x', 'y', 'z' ] } ]
- *
- *		fastDiff( '12a', '12aa' );
- *		// [ { index: 3, type: 'insert', values: [ 'a' ] } ]
- *
- *		fastDiff( '12xyza', '12a' );
- *		// [ { index: 2, type: 'delete', howMany: 3 } ]
- *
- *		fastDiff( [ '1', '2', 'a', 'a' ], [ '1', '2', 'a' ] );
- *		// [ { index: 3, type: 'delete', howMany: 1 } ]
- *
- *		fastDiff( [ '1', '2', 'a', 'b', 'c', '3' ], [ '2', 'a', 'b' ] );
- *		// [ { index: 0, type: 'insert', values: [ '2', 'a', 'b' ] }, { index: 3, type: 'delete', howMany: 6 } ]
- *
- * Passed arrays can contain any type of data, however to compare them correctly custom comparator function
- * should be passed as a third parameter:
- *
- *		fastDiff( [ { value: 1 }, { value: 2 } ], [ { value: 1 }, { value: 3 } ], ( a, b ) => {
- *			return a.value === b.value;
- *		} );
- *		// [ { index: 1, type: 'insert', values: [ { value: 3 } ] }, { index: 2, type: 'delete', howMany: 1 } ]
- *
- * The resulted set of changes can be applied to the input in order to transform it into the output, for example:
- *
- *		let input = '12abc3';
- *		const output = '2ab';
- *		const changes = fastDiff( input, output );
- *
- *		changes.forEach( change => {
- *			if ( change.type == 'insert' ) {
- *				input = input.substring( 0, change.index ) + change.values.join( '' ) + input.substring( change.index );
- *			} else if ( change.type == 'delete' ) {
- *				input = input.substring( 0, change.index ) + input.substring( change.index + change.howMany );
- *			}
- *		} );
- *
- *		// input equals output now
- *
- * or in case of arrays:
- *
- *		let input = [ '1', '2', 'a', 'b', 'c', '3' ];
- *		const output = [ '2', 'a', 'b' ];
- *		const changes = fastDiff( input, output );
- *
- *		changes.forEach( change => {
- *			if ( change.type == 'insert' ) {
- *				input = input.slice( 0, change.index ).concat( change.values, input.slice( change.index ) );
- *			} else if ( change.type == 'delete' ) {
- *				input = input.slice( 0, change.index ).concat( input.slice( change.index + change.howMany ) );
- *			}
- *		} );
- *
- *		// input equals output now
- *
- * By passing `true` as the fourth parameter (`atomicChanges`) the output of this function will become compatible with
- * the {@link module:utils/diff~diff `diff()`} function:
- *
- *		fastDiff( '12a', '12xyza' );
- *		// [ 'equal', 'equal', 'insert', 'insert', 'insert', 'equal' ]
- *
- * The default output format of this function is compatible with the output format of
- * {@link module:utils/difftochanges~diffToChanges `diffToChanges()`}. The `diffToChanges()` input format is, in turn,
- * compatible with the output of {@link module:utils/diff~diff `diff()`}:
- *
- *		const a = '1234';
- *		const b = '12xyz34';
- *
- *		// Both calls will return the same results (grouped changes format).
- *		fastDiff( a, b );
- *		diffToChanges( diff( a, b ) );
- *
- *		// Again, both calls will return the same results (atomic changes format).
- *		fastDiff( a, b, null, true );
- *		diff( a, b );
- *
- *
- * @param {Array|String} a Input array or string.
- * @param {Array|String} b Input array or string.
- * @param {Function} [cmp] Optional function used to compare array values, by default `===` (strict equal operator) is used.
- * @param {Boolean} [atomicChanges=false] Whether an array of `inset|delete|equal` operations should
- * 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 );
-}
-
-// 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' ] );
-//		console.log( indexes ); // { firstIndex: 1, lastIndexOld: 3, lastIndexNew: 4 }
-//
-// The above indexes means that in the first array the modified part is `1[23]4` and in the second array it is `1[342]4`.
-// Based on such indexes, array with `insert`/`delete` operations which allows transforming first value into the second one
-// can be generated.
-//
-// @param {Array} arr1
-// @param {Array} arr2
-// @param {Function} cmp Comparator function.
-// @returns {Object}
-// @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 };
-}
-
-// 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.
-}
-
-// 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();
-}
-
-// 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;
-}
-
-// 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;
-}

package/src/first.js

@@ -1,24 +0,0 @@
-/**
- * @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/first
- */
-
-/**
- * Returns first item of the given `iterable`.
- *
- * @param {Iterable.<*>} iterable
- * @returns {*}
- */
-export default function first( iterable ) {
-	const iteratorItem = iterable.next();
-
-	if ( iteratorItem.done ) {
-		return null;
-	}
-
-	return iteratorItem.value;
-}