@ckeditor/ckeditor5-utils 43.3.1 → 44.0.0-alpha.0

package/README.md

@@ -3,20 +3,26 @@ 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://app.travis-ci.com/github/ckeditor/ckeditor5)
+[![CircleCI](https://circleci.com/gh/ckeditor/ckeditor5.svg?style=shield)](https://app.circleci.com/pipelines/github/ckeditor/ckeditor5?branch=master)
 
 Various utilities used by CKEditor 5 and its features. This is a sort of  CKEditor 5's standard library.
 
-## Documentation
-
-See the [`@ckeditor/ckeditor5-utils` package](https://ckeditor.com/docs/ckeditor5/latest/api/utils.html) page in [CKEditor 5 documentation](https://ckeditor.com/docs/ckeditor5/latest/).
-
 ## Installation
 
+This plugin is part of the `ckeditor5` package. Install the whole package to use it.
+
 ```bash
 npm install ckeditor5
 ```
 
+## Create free account
+
+If you want to check full CKEditor 5 capabilities, sign up for a [free non-commitment 14-day trial](https://portal.ckeditor.com/signup).
+
+## Documentation
+
+See the [`@ckeditor/ckeditor5-utils` package](https://ckeditor.com/docs/ckeditor5/latest/api/utils.html) page in [CKEditor 5 documentation](https://ckeditor.com/docs/ckeditor5/latest/).
+
 ## License
 
 Licensed under the terms of [GNU General Public License Version 2 or later](http://www.gnu.org/licenses/gpl.html). For full details about the license, please check the `LICENSE.md` file or [https://ckeditor.com/legal/ckeditor-oss-license](https://ckeditor.com/legal/ckeditor-oss-license).

package/dist/crc32.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * Calculates CRC-32 checksum for a given inputData to verify the integrity of data.
+ *
+ * @param inputData Accepts a single value (string, number, boolean), an array of strings, or an array of all of the above types.
+ * Non-string values are converted to strings before calculating the checksum.
+ * The checksum calculation is based on the concatenated string representation of the input values:
+ * * `crc32('foo')` is equivalent to `crc32(['foo'])`
+ * * `crc32(123)` is equivalent to `crc32(['123'])`
+ * * `crc32(true)` is equivalent to `crc32(['true'])`
+ * * `crc32(['foo', 123, true])` produces the same result as `crc32('foo123true')`
+ * * Nested arrays of strings are flattened, so `crc32([['foo', 'bar'], 'baz'])` is equivalent to `crc32(['foobar', 'baz'])`
+ *
+ * @returns The CRC-32 checksum, returned as a hexadecimal string.
+ */
+export default function crc32(inputData: CRCData): string;
+/**
+ * The input data for the CRC-32 checksum calculation.
+ * Can be a single value (string, number, boolean), an array of strings, or an array of all of the above types.
+ */
+export type CRCData = CRCValue | Array<CRCValue>;
+type CRCValue = string | number | boolean | Array<string>;
+export {};

package/dist/index.d.ts

@@ -63,7 +63,8 @@ export { default as insertToPriorityArray } from './inserttopriorityarray.js';
 export { default as spliceArray } from './splicearray.js';
 export { default as uid } from './uid.js';
 export { default as delay, type DelayedFunc } from './delay.js';
-export { default as verifyLicense } from './verifylicense.js';
 export { default as wait } from './wait.js';
+export { default as parseBase64EncodedObject } from './parsebase64encodedobject.js';
+export { default as crc32, type CRCData } from './crc32.js';
 export * from './unicode.js';
 export { default as version, releaseDate } from './version.js';

package/dist/index.js

@@ -768,13 +768,19 @@ diff.fastDiff = fastDiff;
  * @param objectToInsert Object with `priority` property.
  */ 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;
+    // Binary search for better performance in large tables.
+    let left = 0;
+    let right = objects.length;
+    while(left < right){
+        const mid = left + right >> 1; // Use bitwise operator for faster floor division by 2.
+        const midPriority = priorities.get(objects[mid].priority);
+        if (midPriority < priority) {
+            right = mid;
+        } else {
+            left = mid + 1;
         }
     }
-    objects.push(objectToInsert);
+    objects.splice(left, 0, objectToInsert);
 }
 
 /**
@@ -953,9 +959,9 @@ diff.fastDiff = fastDiff;
     ];
 }
 
-const version = '43.3.1';
+const version = '44.0.0-alpha.0';
 // The second argument is not a month. It is `monthIndex` and starts from `0`.
-const releaseDate = new Date(2024, 10, 6);
+const releaseDate = new Date(2024, 10, 20);
 /* istanbul ignore next -- @preserve */ if (globalThis.CKEDITOR_VERSION) {
     /**
 	 * This error is thrown when, due to a mistake in the way CKEditor&nbsp;5 was installed,
@@ -3973,7 +3979,22 @@ const rectProperties = [
         });
         // Obtain the rect of the target after it has been scrolled within its ancestors.
         // It's time to scroll the viewport.
-        const targetRect = getRectRelativeToWindow(target, currentWindow);
+        let targetRect = getRectRelativeToWindow(target, currentWindow);
+        // Detect situation where the target is higher than the first scrollable ancestor.
+        // In such case scrolling the viewport to reveal the target might be malfunctioning because
+        // the target `.top` position is lower than the ancestor's `.top` position. If it's large enough it can be negative.
+        // It causes the `scrollWindowToShowRect` to scroll the viewport to the negative top position which is not possible
+        // and leads to the viewport being scrolled to the absolute top of the document. To prevent this, the target's rect
+        // must be shifted to the ancestor's top position. It should not affect the target's visibility because the ancestor
+        // is already scrolled to reveal the target.
+        // See more: https://github.com/ckeditor/ckeditor5/issues/17079
+        const ancestorWindowRelativeRect = getRectRelativeToWindow(firstAncestorToScroll, currentWindow);
+        if (targetRect.height > ancestorWindowRelativeRect.height) {
+            const ancestorTargetIntersection = targetRect.getIntersection(ancestorWindowRelativeRect);
+            if (ancestorTargetIntersection) {
+                targetRect = ancestorTargetIntersection;
+            }
+        }
         scrollWindowToShowRect({
             window: currentWindow,
             rect: targetRect,
@@ -5924,77 +5945,81 @@ function isFocusedView(subTreeRoot, view) {
 }
 
 /**
- * Checks whether the given string contains information that allows you to verify the license status.
- *
- * @param token The string to check.
- * @returns String that represents the state of given `token` parameter.
- */ function verifyLicense(token) {
-    // This function implements naive and partial license key check mechanism,
-    // used only to decide whether to show or hide the "Powered by CKEditor" logo.
-    //
-    // You can read the reasoning behind showing the logo to unlicensed (GPL) users
-    // in this thread: https://github.com/ckeditor/ckeditor5/issues/14082.
-    //
-    // We firmly believe in the values behind creating open-source software, even when that
-    // means keeping the license verification logic open for everyone to see.
-    //
-    // Please keep this code intact. Thank you for your understanding.
-    function oldTokenCheck(token) {
-        if (token.length >= 40 && token.length <= 255) {
-            return 'VALID';
-        } else {
-            return 'INVALID';
-        }
-    }
-    // TODO: issue ci#3175
-    if (!token) {
-        return 'INVALID';
-    }
-    let decryptedData = '';
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */ /**
+ * @module utils/parsebase64encodedobject
+ */ /**
+ * Parses a base64-encoded object and returns the decoded object, or null if the decoding was unsuccessful.
+ */ function parseBase64EncodedObject(encoded) {
     try {
-        decryptedData = atob(token);
+        if (!encoded.startsWith('ey')) {
+            return null;
+        }
+        const decoded = atob(encoded.replace(/-/g, '+').replace(/_/g, '/'));
+        return JSON.parse(decoded);
     } catch (e) {
-        return 'INVALID';
-    }
-    const splittedDecryptedData = decryptedData.split('-');
-    const firstElement = splittedDecryptedData[0];
-    const secondElement = splittedDecryptedData[1];
-    if (!secondElement) {
-        return oldTokenCheck(token);
+        return null;
     }
-    try {
-        atob(secondElement);
-    } catch (e) {
-        try {
-            atob(firstElement);
-            if (!atob(firstElement).length) {
-                return oldTokenCheck(token);
+}
+
+/**
+ * @license Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */ /**
+ * @module utils/crc32
+ */ /**
+ * Generates a CRC lookup table.
+ * This function creates and returns a 256-element array of pre-computed CRC values for quick CRC calculation.
+ * It uses the polynomial 0xEDB88320 to compute each value in the loop, optimizing future CRC calculations.
+ */ function makeCrcTable() {
+    const crcTable = [];
+    for(let n = 0; n < 256; n++){
+        let c = n;
+        for(let k = 0; k < 8; k++){
+            if (c & 1) {
+                c = 0xEDB88320 ^ c >>> 1;
+            } else {
+                c = c >>> 1;
             }
-        } catch (e) {
-            return oldTokenCheck(token);
         }
+        crcTable[n] = c;
     }
-    if (firstElement.length < 40 || firstElement.length > 255) {
-        return 'INVALID';
-    }
-    let decryptedSecondElement = '';
-    try {
-        atob(firstElement);
-        decryptedSecondElement = atob(secondElement);
-    } catch (e) {
-        return 'INVALID';
-    }
-    if (decryptedSecondElement.length !== 8) {
-        return 'INVALID';
-    }
-    const year = Number(decryptedSecondElement.substring(0, 4));
-    const monthIndex = Number(decryptedSecondElement.substring(4, 6)) - 1;
-    const day = Number(decryptedSecondElement.substring(6, 8));
-    const date = new Date(year, monthIndex, day);
-    if (date < releaseDate || isNaN(Number(date))) {
-        return 'INVALID';
+    return crcTable;
+}
+/**
+ * Calculates CRC-32 checksum for a given inputData to verify the integrity of data.
+ *
+ * @param inputData Accepts a single value (string, number, boolean), an array of strings, or an array of all of the above types.
+ * Non-string values are converted to strings before calculating the checksum.
+ * The checksum calculation is based on the concatenated string representation of the input values:
+ * * `crc32('foo')` is equivalent to `crc32(['foo'])`
+ * * `crc32(123)` is equivalent to `crc32(['123'])`
+ * * `crc32(true)` is equivalent to `crc32(['true'])`
+ * * `crc32(['foo', 123, true])` produces the same result as `crc32('foo123true')`
+ * * Nested arrays of strings are flattened, so `crc32([['foo', 'bar'], 'baz'])` is equivalent to `crc32(['foobar', 'baz'])`
+ *
+ * @returns The CRC-32 checksum, returned as a hexadecimal string.
+ */ function crc32(inputData) {
+    const dataArray = Array.isArray(inputData) ? inputData : [
+        inputData
+    ];
+    const crcTable = makeCrcTable();
+    let crc = 0 ^ -1;
+    // Convert data to a single string.
+    const dataString = dataArray.map((item)=>{
+        if (Array.isArray(item)) {
+            return item.join('');
+        }
+        return String(item);
+    }).join('');
+    // Calculate the CRC for the resulting string.
+    for(let i = 0; i < dataString.length; i++){
+        const byte = dataString.charCodeAt(i);
+        crc = crc >>> 8 ^ crcTable[(crc ^ byte) & 0xFF];
     }
-    return 'VALID';
+    crc = (crc ^ -1) >>> 0; // Force unsigned integer.
+    return crc.toString(16).padStart(8, '0');
 }
 
 /**
@@ -6075,5 +6100,5 @@ function buildEmojiRegexp() {
     return new RegExp(sequence, 'ug');
 }
 
-export { CKEditorError, Collection, Config, DomEmitterMixin, ElementReplacer, EmitterMixin, EventInfo, FocusTracker, KeystrokeHandler, Locale, ObservableMixin, Rect, ResizeObserver, abortableDebounce, compareArrays, count, createElement, delay, diff, diffToChanges, env, exponentialDelay, fastDiff, findClosestScrollableAncestor, first, getAncestors, getBorderWidths, getCode, getDataFromElement, getEnvKeystrokeText, getLanguageDirection, getLocalizedArrowKeyCodeDirection, getOptimalPosition, getRangeFromMouseEvent, global, indexOf, insertAt, insertToPriorityArray, isArrowKeyCode, isCombiningMark, isComment, isForwardArrowKeyCode, isHighSurrogateHalf, isInsideCombinedSymbol, isInsideEmojiSequence, isInsideSurrogatePair, isIterable, isLowSurrogateHalf, isNode, isRange, isText, isValidAttributeName, isViewWithFocusTracker, isVisible, keyCodes, logError, logWarning, mix, parseKeystroke, priorities, releaseDate, remove, retry, scrollAncestorsToShowTarget, scrollViewportToShowTarget, setDataInElement, spliceArray, toArray, toMap, toUnit, uid, verifyLicense, version, wait };
+export { CKEditorError, Collection, Config, DomEmitterMixin, ElementReplacer, EmitterMixin, EventInfo, FocusTracker, KeystrokeHandler, Locale, ObservableMixin, Rect, ResizeObserver, abortableDebounce, compareArrays, count, crc32, createElement, delay, diff, diffToChanges, env, exponentialDelay, fastDiff, findClosestScrollableAncestor, first, getAncestors, getBorderWidths, getCode, getDataFromElement, getEnvKeystrokeText, getLanguageDirection, getLocalizedArrowKeyCodeDirection, getOptimalPosition, getRangeFromMouseEvent, global, indexOf, insertAt, insertToPriorityArray, isArrowKeyCode, isCombiningMark, isComment, isForwardArrowKeyCode, isHighSurrogateHalf, isInsideCombinedSymbol, isInsideEmojiSequence, isInsideSurrogatePair, isIterable, isLowSurrogateHalf, isNode, isRange, isText, isValidAttributeName, isViewWithFocusTracker, isVisible, keyCodes, logError, logWarning, mix, parseBase64EncodedObject, parseKeystroke, priorities, releaseDate, remove, retry, scrollAncestorsToShowTarget, scrollViewportToShowTarget, setDataInElement, spliceArray, toArray, toMap, toUnit, uid, version, wait };
 //# sourceMappingURL=index.js.map