@ckeditor/ckeditor5-utils 34.2.0 → 35.0.0

package/src/comparearrays.js

@@ -1,51 +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/comparearrays
- */
-
-/**
- * Compares how given arrays relate to each other. One array can be: same as another array, prefix of another array
- * or completely different. If arrays are different, first index at which they differ is returned. Otherwise,
- * a flag specifying the relation is returned. Flags are negative numbers, so whenever a number >= 0 is returned
- * it means that arrays differ.
- *
- *		compareArrays( [ 0, 2 ], [ 0, 2 ] );		// 'same'
- *		compareArrays( [ 0, 2 ], [ 0, 2, 1 ] );		// 'prefix'
- *		compareArrays( [ 0, 2 ], [ 0 ] );			// 'extension'
- *		compareArrays( [ 0, 2 ], [ 1, 2 ] );		// 0
- *		compareArrays( [ 0, 2 ], [ 0, 1 ] );		// 1
- *
- * @param {Array} a Array that is compared.
- * @param {Array} b Array to compare with.
- * @returns {module:utils/comparearrays~ArrayRelation} How array `a` is related to `b`.
- */
-export default function compareArrays( a, b ) {
-	const minLen = Math.min( a.length, b.length );
-
-	for ( let i = 0; i < minLen; i++ ) {
-		if ( a[ i ] != b[ i ] ) {
-			// The arrays are different.
-			return i;
-		}
-	}
-
-	// Both arrays were same at all points.
-	if ( a.length == b.length ) {
-		// If their length is also same, they are the same.
-		return 'same';
-	} else if ( a.length < b.length ) {
-		// Compared array is shorter so it is a prefix of the other array.
-		return 'prefix';
-	} else {
-		// Compared array is longer so it is an extension of the other array.
-		return 'extension';
-	}
-}
-
-/**
- * @typedef {'extension'|'same'|'prefix'} module:utils/comparearrays~ArrayRelation
- */

package/src/config.js

@@ -1,246 +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/config
- */
-
-import { isPlainObject, isElement, cloneDeepWith } from 'lodash-es';
-
-/**
- * Handles a configuration dictionary.
- */
-export default class Config {
-	/**
-	 * Creates an instance of the {@link ~Config} class.
-	 *
-	 * @param {Object} [configurations] The initial configurations to be set. Usually, provided by the user.
-	 * @param {Object} [defaultConfigurations] The default configurations. Usually, provided by the system.
-	 */
-	constructor( configurations, defaultConfigurations ) {
-		/**
-		 * Store for the whole configuration.
-		 *
-		 * @private
-		 * @member {Object}
-		 */
-		this._config = {};
-
-		// Set default configuration.
-		if ( defaultConfigurations ) {
-			// Clone the configuration to make sure that the properties will not be shared
-			// between editors and make the watchdog feature work correctly.
-			this.define( cloneConfig( defaultConfigurations ) );
-		}
-
-		// Set initial configuration.
-		if ( configurations ) {
-			this._setObjectToTarget( this._config, configurations );
-		}
-	}
-
-	/**
-	 * Set configuration values.
-	 *
-	 * It accepts both a name/value pair or an object, which properties and values will be used to set
-	 * configurations.
-	 *
-	 * It also accepts setting a "deep configuration" by using dots in the name. For example, `'resize.width'` sets
-	 * the value for the `width` configuration in the `resize` subset.
-	 *
-	 *		config.set( 'width', 500 );
-	 *		config.set( 'toolbar.collapsed', true );
-	 *
-	 *		// Equivalent to:
-	 *		config.set( {
-	 *			width: 500
-	 *			toolbar: {
-	 *				collapsed: true
-	 *			}
-	 *		} );
-	 *
-	 * Passing an object as the value will amend the configuration, not replace it.
-	 *
-	 *		config.set( 'toolbar', {
-	 *			collapsed: true,
-	 *		} );
-	 *
-	 *		config.set( 'toolbar', {
-	 *			color: 'red',
-	 *		} );
-	 *
-	 *		config.get( 'toolbar.collapsed' ); // true
-	 *		config.get( 'toolbar.color' ); // 'red'
-	 *
-	 * @param {String|Object} name The configuration name or an object from which take properties as
-	 * configuration entries. Configuration names are case-sensitive.
-	 * @param {*} value The configuration value. Used if a name is passed.
-	 */
-	set( name, value ) {
-		this._setToTarget( this._config, name, value );
-	}
-
-	/**
-	 * Does exactly the same as {@link #set} with one exception – passed configuration extends
-	 * existing one, but does not overwrite already defined values.
-	 *
-	 * This method is supposed to be called by plugin developers to setup plugin's configurations. It would be
-	 * rarely used for other needs.
-	 *
-	 * @param {String|Object} name The configuration name or an object from which take properties as
-	 * configuration entries. Configuration names are case-sensitive.
-	 * @param {*} value The configuration value. Used if a name is passed.
-	 */
-	define( name, value ) {
-		const isDefine = true;
-
-		this._setToTarget( this._config, name, value, isDefine );
-	}
-
-	/**
-	 * Gets the value for a configuration entry.
-	 *
-	 *		config.get( 'name' );
-	 *
-	 * Deep configurations can be retrieved by separating each part with a dot.
-	 *
-	 *		config.get( 'toolbar.collapsed' );
-	 *
-	 * @param {String} name The configuration name. Configuration names are case-sensitive.
-	 * @returns {*} The configuration value or `undefined` if the configuration entry was not found.
-	 */
-	get( name ) {
-		return this._getFromSource( this._config, name );
-	}
-
-	/**
-	 * Iterates over all top level configuration names.
-	 *
-	 * @returns {Iterable.<String>}
-	 */
-	* names() {
-		for ( const name of Object.keys( this._config ) ) {
-			yield name;
-		}
-	}
-
-	/**
-	 * Saves passed configuration to the specified target (nested object).
-	 *
-	 * @private
-	 * @param {Object} target Nested config object.
-	 * @param {String|Object} name The configuration name or an object from which take properties as
-	 * configuration entries. Configuration names are case-sensitive.
-	 * @param {*} value The configuration value. Used if a name is passed.
-	 * @param {Boolean} [isDefine=false] Define if passed configuration should overwrite existing one.
-	 */
-	_setToTarget( target, name, value, isDefine = false ) {
-		// In case of an object, iterate through it and call `_setToTarget` again for each property.
-		if ( isPlainObject( name ) ) {
-			this._setObjectToTarget( target, name, isDefine );
-
-			return;
-		}
-
-		// The configuration name should be split into parts if it has dots. E.g. `resize.width` -> [`resize`, `width`].
-		const parts = name.split( '.' );
-
-		// Take the name of the configuration out of the parts. E.g. `resize.width` -> `width`.
-		name = parts.pop();
-
-		// Iterate over parts to check if currently stored configuration has proper structure.
-		for ( const part of parts ) {
-			// If there is no object for specified part then create one.
-			if ( !isPlainObject( target[ part ] ) ) {
-				target[ part ] = {};
-			}
-
-			// Nested object becomes a target.
-			target = target[ part ];
-		}
-
-		// In case of value is an object.
-		if ( isPlainObject( value ) ) {
-			// We take care of proper config structure.
-			if ( !isPlainObject( target[ name ] ) ) {
-				target[ name ] = {};
-			}
-
-			target = target[ name ];
-
-			// And iterate through this object calling `_setToTarget` again for each property.
-			this._setObjectToTarget( target, value, isDefine );
-
-			return;
-		}
-
-		// Do nothing if we are defining configuration for non empty name.
-		if ( isDefine && typeof target[ name ] != 'undefined' ) {
-			return;
-		}
-
-		target[ name ] = value;
-	}
-
-	/**
-	 * Get specified configuration from specified source (nested object).
-	 *
-	 * @private
-	 * @param {Object} source level of nested object.
-	 * @param {String} name The configuration name. Configuration names are case-sensitive.
-	 * @returns {*} The configuration value or `undefined` if the configuration entry was not found.
-	 */
-	_getFromSource( source, name ) {
-		// The configuration name should be split into parts if it has dots. E.g. `resize.width` -> [`resize`, `width`].
-		const parts = name.split( '.' );
-
-		// Take the name of the configuration out of the parts. E.g. `resize.width` -> `width`.
-		name = parts.pop();
-
-		// Iterate over parts to check if currently stored configuration has proper structure.
-		for ( const part of parts ) {
-			if ( !isPlainObject( source[ part ] ) ) {
-				source = null;
-				break;
-			}
-
-			// Nested object becomes a source.
-			source = source[ part ];
-		}
-
-		// Always returns undefined for non existing configuration.
-		return source ? cloneConfig( source[ name ] ) : undefined;
-	}
-
-	/**
-	 * Iterates through passed object and calls {@link #_setToTarget} method with object key and value for each property.
-	 *
-	 * @private
-	 * @param {Object} target Nested config object.
-	 * @param {Object} configuration Configuration data set
-	 * @param {Boolean} [isDefine] Defines if passed configuration is default configuration or not.
-	 */
-	_setObjectToTarget( target, configuration, isDefine ) {
-		Object.keys( configuration ).forEach( key => {
-			this._setToTarget( target, key, configuration[ key ], isDefine );
-		} );
-	}
-}
-
-// Clones configuration object or value.
-// @param {*} source Source configuration
-// @returns {*} Cloned configuration value.
-function cloneConfig( source ) {
-	return cloneDeepWith( source, leaveDOMReferences );
-}
-
-// A customized function for cloneDeepWith.
-// It will leave references to DOM Elements instead of cloning them.
-//
-// @param {*} value
-// @returns {Element|undefined}
-function leaveDOMReferences( value ) {
-	return isElement( value ) ? value : undefined;
-}

package/src/count.js

@@ -1,26 +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/count
- */
-
-/**
- * Returns the number of items return by the iterator.
- *
- *		count( [ 1, 2, 3, 4, 5 ] ); // 5;
- *
- * @param {Iterable.<*>} iterator Any iterator.
- * @returns {Number} Number of items returned by that iterator.
- */
-export default function count( iterator ) {
-	let count = 0;
-
-	for ( const _ of iterator ) { // eslint-disable-line no-unused-vars
-		count++;
-	}
-
-	return count;
-}

package/src/diff.js

@@ -1,138 +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/diff
- */
-
-import fastDiff from '../src/fastdiff';
-
-// The following code is based on the "O(NP) Sequence Comparison Algorithm"
-// by Sun Wu, Udi Manber, Gene Myers, Webb Miller.
-
-/**
- * Calculates the difference between two arrays or strings producing an array containing a list of changes
- * necessary to transform input into output.
- *
- *		diff( 'aba', 'acca' ); // [ 'equal', 'insert', 'insert', 'delete', 'equal' ]
- *
- * This function is based on the "O(NP) Sequence Comparison Algorithm" by Sun Wu, Udi Manber, Gene Myers, Webb Miller.
- * Unfortunately, while it gives the most precise results, its to complex for longer strings/arrow (above 200 items).
- * Therefore, `diff()` automatically switches to {@link module:utils/fastdiff~fastDiff `fastDiff()`} when detecting
- * such a scenario. The return formats of both functions are identical.
- *
- * @param {Array|String} a Input array or string.
- * @param {Array|String} b Output array or string.
- * @param {Function} [cmp] Optional function used to compare array values, by default === is used.
- * @returns {Array} Array of changes.
- */
-export default function diff( a, b, cmp ) {
-	// Set the comparator function.
-	cmp = cmp || function( a, b ) {
-		return a === b;
-	};
-
-	const aLength = a.length;
-	const bLength = b.length;
-
-	// Perform `fastDiff` for longer strings/arrays (see #269).
-	if ( aLength > 200 || bLength > 200 || aLength + bLength > 300 ) {
-		return diff.fastDiff( a, b, cmp, true );
-	}
-
-	// Temporary action type statics.
-	let _insert, _delete;
-
-	// Swapped the arrays to use the shorter one as the first one.
-	if ( bLength < aLength ) {
-		const tmp = a;
-
-		a = b;
-		b = tmp;
-
-		// We swap the action types as well.
-		_insert = 'delete';
-		_delete = 'insert';
-	} else {
-		_insert = 'insert';
-		_delete = 'delete';
-	}
-
-	const m = a.length;
-	const n = b.length;
-	const delta = n - m;
-
-	// Edit scripts, for each diagonal.
-	const es = {};
-	// Furthest points, the furthest y we can get on each diagonal.
-	const fp = {};
-
-	function snake( k ) {
-		// We use -1 as an alternative below to handle initial values ( instead of filling the fp with -1 first ).
-		// Furthest points (y) on the diagonal below k.
-		const y1 = ( fp[ k - 1 ] !== undefined ? fp[ k - 1 ] : -1 ) + 1;
-		// Furthest points (y) on the diagonal above k.
-		const y2 = fp[ k + 1 ] !== undefined ? fp[ k + 1 ] : -1;
-		// The way we should go to get further.
-		const dir = y1 > y2 ? -1 : 1;
-
-		// Clone previous changes array (if any).
-		if ( es[ k + dir ] ) {
-			es[ k ] = es[ k + dir ].slice( 0 );
-		}
-
-		// Create changes array.
-		if ( !es[ k ] ) {
-			es[ k ] = [];
-		}
-
-		// Push the action.
-		es[ k ].push( y1 > y2 ? _insert : _delete );
-
-		// Set the beginning coordinates.
-		let y = Math.max( y1, y2 );
-		let x = y - k;
-
-		// Traverse the diagonal as long as the values match.
-		while ( x < m && y < n && cmp( a[ x ], b[ y ] ) ) {
-			x++;
-			y++;
-			// Push no change action.
-			es[ k ].push( 'equal' );
-		}
-
-		return y;
-	}
-
-	let p = 0;
-	let k;
-
-	// Traverse the graph until we reach the end of the longer string.
-	do {
-		// Updates furthest points and edit scripts for diagonals below delta.
-		for ( k = -p; k < delta; k++ ) {
-			fp[ k ] = snake( k );
-		}
-
-		// Updates furthest points and edit scripts for diagonals above delta.
-		for ( k = delta + p; k > delta; k-- ) {
-			fp[ k ] = snake( k );
-		}
-
-		// Updates furthest point and edit script for the delta diagonal.
-		// note that the delta diagonal is the one which goes through the sink (m, n).
-		fp[ delta ] = snake( delta );
-
-		p++;
-	} while ( fp[ delta ] !== n );
-
-	// Return the final list of edit changes.
-	// We remove the first item that represents the action for the injected nulls.
-	return es[ delta ].slice( 1 );
-}
-
-// Store the API in static property to easily overwrite it in tests.
-// Too bad dependency injection does not work in Webpack + ES 6 (const) + Babel.
-diff.fastDiff = fastDiff;

package/src/difftochanges.js

@@ -1,86 +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/difftochanges
- */
-
-/**
- * Creates a set of changes which need to be applied to the input in order to transform
- * it into the output. This function can be used with strings or arrays.
- *
- *		const input = Array.from( 'abc' );
- *		const output = Array.from( 'xaby' );
- *		const changes = diffToChanges( diff( input, output ), output );
- *
- *		changes.forEach( change => {
- *			if ( change.type == 'insert' ) {
- *				input.splice( change.index, 0, ...change.values );
- *			} else if ( change.type == 'delete' ) {
- *				input.splice( change.index, change.howMany );
- *			}
- *		} );
- *
- *		input.join( '' ) == output.join( '' ); // -> true
- *
- * @param {Array.<'equal'|'insert'|'delete'>} diff Result of {@link module:utils/diff~diff}.
- * @param {String|Array} output The string or array which was passed as diff's output.
- * @returns {Array.<Object>} Set of changes (insert or delete) which need to be applied to the input
- * in order to transform it into the output.
- */
-export default function diffToChanges( diff, output ) {
-	const changes = [];
-	let index = 0;
-	let lastOperation;
-
-	diff.forEach( change => {
-		if ( change == 'equal' ) {
-			pushLast();
-
-			index++;
-		} else if ( change == 'insert' ) {
-			if ( isContinuationOf( 'insert' ) ) {
-				lastOperation.values.push( output[ index ] );
-			} else {
-				pushLast();
-
-				lastOperation = {
-					type: 'insert',
-					index,
-					values: [ output[ index ] ]
-				};
-			}
-
-			index++;
-		} else /* if ( change == 'delete' ) */ {
-			if ( isContinuationOf( 'delete' ) ) {
-				lastOperation.howMany++;
-			} else {
-				pushLast();
-
-				lastOperation = {
-					type: 'delete',
-					index,
-					howMany: 1
-				};
-			}
-		}
-	} );
-
-	pushLast();
-
-	return changes;
-
-	function pushLast() {
-		if ( lastOperation ) {
-			changes.push( lastOperation );
-			lastOperation = null;
-		}
-	}
-
-	function isContinuationOf( expected ) {
-		return lastOperation && lastOperation.type == expected;
-	}
-}

package/src/dom/createelement.js

@@ -1,49 +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/dom/createelement
- */
-
-import isIterable from '../isiterable';
-import { isString } from 'lodash-es';
-
-/**
- * Creates element with attributes and children.
- *
- *		createElement( document, 'p' ); // <p>
- *		createElement( document, 'p', { class: 'foo' } ); // <p class="foo">
- *		createElement( document, 'p', null, 'foo' ); // <p>foo</p>
- *		createElement( document, 'p', null, [ 'foo', createElement( document, 'img' ) ] ); // <p>foo<img></p>
- *
- * @param {Document} doc Document used to create element.
- * @param {String} name Name of the element.
- * @param {Object} [attributes] Object keys will become attributes keys and object values will became attributes values.
- * @param {Node|String|Array.<Node|String>} [children] Child or array of children. Strings will be automatically turned
- * into Text nodes.
- * @returns {Element} Created element.
- */
-export default function createElement( doc, name, attributes = {}, children = [] ) {
-	const namespace = attributes && attributes.xmlns;
-	const element = namespace ? doc.createElementNS( namespace, name ) : doc.createElement( name );
-
-	for ( const key in attributes ) {
-		element.setAttribute( key, attributes[ key ] );
-	}
-
-	if ( isString( children ) || !isIterable( children ) ) {
-		children = [ children ];
-	}
-
-	for ( let child of children ) {
-		if ( isString( child ) ) {
-			child = doc.createTextNode( child );
-		}
-
-		element.appendChild( child );
-	}
-
-	return element;
-}