@ckeditor/ckeditor5-utils 32.0.0 → 34.1.0

package/LICENSE.md

@@ -2,7 +2,7 @@ Software License Agreement
 ==========================
 
 **CKEditor 5 utilities** – https://github.com/ckeditor/ckeditor5-utils <br>
-Copyright (c) 2003-2022, [CKSource](http://cksource.com) Holding sp. z o.o. All rights reserved.
+Copyright (c) 2003-2022, [CKSource Holding sp. z o.o.](https://cksource.com) All rights reserved.
 
 Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html).
 
@@ -18,4 +18,4 @@ The following libraries are included in CKEditor under the [MIT license](https:/
 Trademarks
 ----------
 
-**CKEditor** is a trademark of [CKSource](http://cksource.com) Holding sp. z o.o. All other brand and product names are trademarks, registered trademarks or service marks of their respective holders.
+**CKEditor** is a trademark of [CKSource Holding sp. z o.o.](https://cksource.com) All other brand and product names are trademarks, registered trademarks or service marks of their respective holders.

package/README.md

@@ -3,7 +3,8 @@ CKEditor 5 utilities
 
 [![npm version](https://badge.fury.io/js/%40ckeditor%2Fckeditor5-utils.svg)](https://www.npmjs.com/package/@ckeditor/ckeditor5-utils)
 [![Coverage Status](https://coveralls.io/repos/github/ckeditor/ckeditor5/badge.svg?branch=master)](https://coveralls.io/github/ckeditor/ckeditor5?branch=master)
-[![Build Status](https://travis-ci.com/ckeditor/ckeditor5.svg?branch=master)](https://travis-ci.com/ckeditor/ckeditor5)
+[![Build Status](https://travis-ci.com/ckeditor/ckeditor5.svg?branch=master)](https://app.travis-ci.com/github/ckeditor/ckeditor5)
+![Dependency Status](https://img.shields.io/librariesio/release/npm/@ckeditor/ckeditor5-utils)
 
 Various utilities used by CKEditor 5 and its features. This is a sort of  CKEditor 5's standard library.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-utils",
-  "version": "32.0.0",
+  "version": "34.1.0",
   "description": "Miscellaneous utilities used by CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -14,10 +14,10 @@
     "lodash-es": "^4.17.15"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-build-classic": "^32.0.0",
-    "@ckeditor/ckeditor5-editor-classic": "^32.0.0",
-    "@ckeditor/ckeditor5-core": "^32.0.0",
-    "@ckeditor/ckeditor5-engine": "^32.0.0"
+    "@ckeditor/ckeditor5-build-classic": "^34.1.0",
+    "@ckeditor/ckeditor5-editor-classic": "^34.1.0",
+    "@ckeditor/ckeditor5-core": "^34.1.0",
+    "@ckeditor/ckeditor5-engine": "^34.1.0"
   },
   "engines": {
     "node": ">=14.0.0",

package/src/ckeditorerror.js

@@ -12,8 +12,7 @@
 /**
  * URL to the documentation with error codes.
  */
-export const DOCUMENTATION_URL =
-	'https://ckeditor.com/docs/ckeditor5/latest/framework/guides/support/error-codes.html';
+export const DOCUMENTATION_URL = 'https://ckeditor.com/docs/ckeditor5/latest/support/error-codes.html';
 
 /**
  * The CKEditor error class.

package/src/dom/iscomment.js

@@ -10,7 +10,7 @@
  */
 
 /**
- * Checks if the object is a native DOM Comment node.
+ * Checks whether the object is a native DOM Comment node.
  *
  * @param {*} obj
  * @returns {Boolean}

package/src/dom/isvisible.js

@@ -8,7 +8,7 @@
  */
 
 /**
- * Checks if the element is visible to the user in DOM:
+ * Checks whether the element is visible to the user in DOM:
  *
  * * connected to the root of the document,
  * * has no `display: none`,

package/src/emittermixin.js

@@ -10,6 +10,7 @@
 import EventInfo from './eventinfo';
 import uid from './uid';
 import priorities from './priorities';
+import insertToPriorityArray from './inserttopriorityarray';
 
 // To check if component is loaded more than once.
 import './version';
@@ -298,21 +299,7 @@ const EmitterMixin = {
 		// Add the callback to all callbacks list.
 		for ( const callbacks of lists ) {
 			// Add the callback to the list in the right priority position.
-			let added = false;
-
-			for ( let i = 0; i < callbacks.length; i++ ) {
-				if ( callbacks[ i ].priority < priority ) {
-					callbacks.splice( i, 0, callbackDefinition );
-					added = true;
-
-					break;
-				}
-			}
-
-			// Add at the end, if right place was not found.
-			if ( !added ) {
-				callbacks.push( callbackDefinition );
-			}
+			insertToPriorityArray( callbacks, callbackDefinition );
 		}
 	},
 

package/src/index.js

@@ -27,6 +27,7 @@ export { default as ResizeObserver } from './dom/resizeobserver';
 export { default as setDataInElement } from './dom/setdatainelement';
 export { default as toUnit } from './dom/tounit';
 export { default as isVisible } from './dom/isvisible';
+export * from './dom/scroll';
 
 export * from './keyboard';
 export * from './language';

package/src/inserttopriorityarray.js

@@ -0,0 +1,42 @@
+/**
+ * @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
+ */
+
+import priorities from './priorities';
+
+/**
+ * @module utils/inserttopriorityarray
+ */
+
+/**
+ * The priority object descriptor.
+ *
+ *		const objectWithPriority = {
+ *			priority: 'high'
+ *		}
+ *
+ * @typedef {Object} module:utils/inserttopriorityarray~ObjectWithPriority
+ *
+ * @property {module:utils/priorities~PriorityString|Number} priority Priority of the object.
+ */
+
+/**
+ * Inserts any object with priority at correct index by priority so registered objects are always sorted from highest to lowest priority.
+ *
+ * @param {Array.<module:utils/inserttopriorityarray~ObjectWithPriority>} objects Array of objects with priority to insert object to.
+ * @param {module:utils/inserttopriorityarray~ObjectWithPriority} objectToInsert Object with `priority` property.
+ */
+export default function insertToPriorityArray( objects, objectToInsert ) {
+	const priority = priorities.get( objectToInsert.priority );
+
+	for ( let i = 0; i < objects.length; i++ ) {
+		if ( priorities.get( objects[ i ].priority ) < priority ) {
+			objects.splice( i, 0, objectToInsert );
+
+			return;
+		}
+	}
+
+	objects.push( objectToInsert );
+}

package/src/unicode.js

@@ -67,3 +67,40 @@ export function isInsideSurrogatePair( string, 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.
+ *
+ * @param {String} string String to check.
+ * @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 );
+}
+
+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' );
+}

package/src/version.js

@@ -11,7 +11,7 @@
 
 import CKEditorError from './ckeditorerror';
 
-const version = '32.0.0';
+const version = '34.1.0';
 
 export default version;
 
@@ -49,14 +49,14 @@ if ( windowOrGlobal.CKEDITOR_VERSION ) {
 	 * Adding plugins to a build is done by taking the source version of this build (so, before it was built with webpack)
 	 * and adding plugins there. In this situation, webpack will know that it only needs to load each plugin once.
 	 *
-	 * Read more in the {@glink builds/guides/integration/installing-plugins "Installing plugins"} guide.
+	 * Read more in the {@glink installation/getting-started/installing-plugins "Installing plugins"} guide.
 	 *
 	 * # Confused an editor build with an editor implementation
 	 *
 	 * This scenario is very similar to the previous one, but has a different origin.
 	 *
 	 * Let's assume that you wanted to use CKEditor 5 from source, as explained in the
-	 * {@glink builds/guides/integration/advanced-setup#scenario-2-building-from-source "Building from source"} section
+	 * {@glink installation/advanced/alternative-setups/integrating-from-source "Building from source"} section
 	 * or in the {@glink framework/guides/quick-start "Quick start"} guide of CKEditor 5 Framework.
 	 *
 	 * The correct way to do so is to import an editor and plugins and run them together like this:
@@ -98,7 +98,7 @@ if ( windowOrGlobal.CKEDITOR_VERSION ) {
 	 * Check your web page for duplicated `<script>` elements or make sure your page builder/bundler includes CKEditor only once.
 	 *
 	 * If you want to use two different types of editors at once, see the
-	 * {@glink builds/guides/integration/advanced-setup#scenario-3-using-two-different-editors "Using two different editors"}
+	 * {@glink installation/advanced/using-two-editors "Using two different editors"}
 	 * section.
 	 *
 	 * # Using outdated packages
@@ -124,7 +124,7 @@ if ( windowOrGlobal.CKEDITOR_VERSION ) {
 	 * **Note:** All official CKEditor 5 packages (excluding integrations and `ckeditor5-dev-*` packages) are released in the
 	 * same major version. This is &mdash; in the `x.y.z`, the `x` is the same for all packages. This is the simplest way to check
 	 * whether you use packages coming from the same CKEditor 5 version. You can read more about versioning in the
-	 * {@glink framework/guides/support/versioning-policy Versioning policy} guide.
+	 * {@glink support/versioning-policy Versioning policy} guide.
 	 *
 	 * # Packages were duplicated in `node_modules`
 	 *