@ckeditor/ckeditor5-utils 34.2.0 → 35.1.0

package/src/diff.js

@@ -2,16 +2,12 @@
  * @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';
-
+import fastDiff from './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.
@@ -26,113 +22,92 @@ import fastDiff from '../src/fastdiff';
  * @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.
+ * @returns {Array.<module:utils/diff~DiffResult>} 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 );
+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

@@ -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/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.
@@ -25,62 +23,54 @@
  *
  *		input.join( '' ) == output.join( '' ); // -> true
  *
- * @param {Array.<'equal'|'insert'|'delete'>} diff Result of {@link module:utils/diff~diff}.
+ * @param {Array.<module:utils/diff~DiffResult>} 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
+ * @returns {Array.<module:utils/difftochanges~Change>} 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;
-	}
+export default function diffToChanges(diff, output) {
+    const changes = [];
+    let index = 0;
+    let lastOperation = null;
+    diff.forEach(change => {
+        if (change == 'equal') {
+            pushLast();
+            index++;
+        }
+        else if (change == 'insert') {
+            if (lastOperation && lastOperation.type == 'insert') {
+                lastOperation.values.push(output[index]);
+            }
+            else {
+                pushLast();
+                lastOperation = {
+                    type: 'insert',
+                    index,
+                    values: [output[index]]
+                };
+            }
+            index++;
+        }
+        else /* if ( change == 'delete' ) */ {
+            if (lastOperation && lastOperation.type == 'delete') {
+                lastOperation.howMany++;
+            }
+            else {
+                pushLast();
+                lastOperation = {
+                    type: 'delete',
+                    index,
+                    howMany: 1
+                };
+            }
+        }
+    });
+    pushLast();
+    return changes;
+    function pushLast() {
+        if (lastOperation) {
+            changes.push(lastOperation);
+            lastOperation = null;
+        }
+    }
 }

package/src/dom/createelement.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/dom/createelement
  */
-
 import isIterable from '../isiterable';
 import { isString } from 'lodash-es';
-
 /**
  * Creates element with attributes and children.
  *
@@ -21,29 +18,24 @@ import { isString } from 'lodash-es';
  * @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
+ * @param {Node|String|Iterable.<Node|String>} [children] Child or any iterable 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;
+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;
 }