@ckeditor/ckeditor5-utils 37.0.1 → 38.0.0-rc.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-utils",
-  "version": "37.0.1",
+  "version": "38.0.0-rc.0",
   "description": "Miscellaneous utilities used by CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -14,10 +14,10 @@
     "lodash-es": "^4.17.15"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-build-classic": "^37.0.1",
-    "@ckeditor/ckeditor5-editor-classic": "^37.0.1",
-    "@ckeditor/ckeditor5-core": "^37.0.1",
-    "@ckeditor/ckeditor5-engine": "^37.0.1",
+    "@ckeditor/ckeditor5-build-classic": "^38.0.0-rc.0",
+    "@ckeditor/ckeditor5-editor-classic": "^38.0.0-rc.0",
+    "@ckeditor/ckeditor5-core": "^38.0.0-rc.0",
+    "@ckeditor/ckeditor5-engine": "^38.0.0-rc.0",
     "@types/lodash-es": "^4.17.6",
     "typescript": "^4.8.4"
   },

package/src/delay.d.ts

@@ -0,0 +1,19 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module utils/delay
+ */
+/**
+ * Returns a function wrapper that will trigger a function after a specified wait time.
+ * The timeout can be canceled by calling the cancel function on the returned wrapped function.
+ *
+ * @param func The function to wrap.
+ * @param wait The timeout in ms.
+ */
+export default function delay<T extends (...args: Array<any>) => any>(func: T, wait: number): DelayedFunc<T>;
+export interface DelayedFunc<T extends (...args: Array<any>) => any> {
+    (...args: Parameters<T>): void;
+    cancel(): void;
+}

package/src/delay.js

@@ -0,0 +1,26 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module utils/delay
+ */
+/* globals setTimeout, clearTimeout */
+/**
+ * Returns a function wrapper that will trigger a function after a specified wait time.
+ * The timeout can be canceled by calling the cancel function on the returned wrapped function.
+ *
+ * @param func The function to wrap.
+ * @param wait The timeout in ms.
+ */
+export default function delay(func, wait) {
+    let timer;
+    function delayed(...args) {
+        delayed.cancel();
+        timer = setTimeout(() => func(...args), wait);
+    }
+    delayed.cancel = () => {
+        clearTimeout(timer);
+    };
+    return delayed;
+}

package/src/dom/global.js

@@ -25,7 +25,7 @@ try {
 }
 catch (e) {
     // It's not possible to mock a window object to simulate lack of a window object without writing extremely convoluted code.
-    /* istanbul ignore next */
+    /* istanbul ignore next -- @preserve */
     // Let's cast it to not change module's API.
     // We only handle this so loading editor in environments without window and document doesn't fail.
     // For better DX we shouldn't introduce mixed types and require developers to check the type manually.

package/src/dom/isvalidattributename.d.ts

@@ -0,0 +1,10 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * Checks if the given attribute name is valid in terms of HTML.
+ *
+ * @param name Attribute name.
+ */
+export default function isValidAttributeName(name: string): boolean;

package/src/dom/isvalidattributename.js

@@ -0,0 +1,22 @@
+/**
+ * @license Copyright (c) 2003-2023, 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/isvalidattributename
+ */
+import global from './global';
+/**
+ * Checks if the given attribute name is valid in terms of HTML.
+ *
+ * @param name Attribute name.
+ */
+export default function isValidAttributeName(name) {
+    try {
+        global.document.createAttribute(name);
+    }
+    catch (error) {
+        return false;
+    }
+    return true;
+}

package/src/emittermixin.js

@@ -172,7 +172,7 @@ export default function EmitterMixin(base) {
             }
             catch (err) {
                 // @if CK_DEBUG // throw err;
-                /* istanbul ignore next */
+                /* istanbul ignore next -- @preserve */
                 CKEditorError.rethrowUnexpectedError(err, this);
             }
         }

package/src/index.d.ts

@@ -36,6 +36,7 @@ export { default as insertAt } from './dom/insertat';
 export { default as isComment } from './dom/iscomment';
 export { default as isNode } from './dom/isnode';
 export { default as isRange } from './dom/isrange';
+export { default as isValidAttributeName } from './dom/isvalidattributename';
 export { default as isVisible } from './dom/isvisible';
 export { getOptimalPosition, type Options as PositionOptions, type PositioningFunction } from './dom/position';
 export { default as remove } from './dom/remove';
@@ -53,5 +54,7 @@ export { default as priorities, type PriorityString } from './priorities';
 export { default as insertToPriorityArray } from './inserttopriorityarray';
 export { default as spliceArray } from './splicearray';
 export { default as uid } from './uid';
+export { default as delay, type DelayedFunc } from './delay';
+export { default as verifyLicense } from './verifylicense';
 export * from './unicode';
-export { default as version } from './version';
+export { default as version, releaseDate } from './version';

package/src/index.js

@@ -35,6 +35,7 @@ export { default as insertAt } from './dom/insertat';
 export { default as isComment } from './dom/iscomment';
 export { default as isNode } from './dom/isnode';
 export { default as isRange } from './dom/isrange';
+export { default as isValidAttributeName } from './dom/isvalidattributename';
 export { default as isVisible } from './dom/isvisible';
 export { getOptimalPosition } from './dom/position';
 export { default as remove } from './dom/remove';
@@ -52,5 +53,7 @@ export { default as priorities } from './priorities';
 export { default as insertToPriorityArray } from './inserttopriorityarray';
 export { default as spliceArray } from './splicearray';
 export { default as uid } from './uid';
+export { default as delay } from './delay';
+export { default as verifyLicense } from './verifylicense';
 export * from './unicode';
-export { default as version } from './version';
+export { default as version, releaseDate } from './version';

package/src/mix.d.ts

@@ -78,8 +78,8 @@ export type Constructor<Instance = object> = abstract new (...args: Array<any>)
  * @typeParam Mixin An interface representing mixin.
  */
 export type Mixed<Base extends Constructor, Mixin extends object> = {
-    new (...args: ConstructorParameters<Base>): InstanceType<Base> & Mixin;
-    prototype: InstanceType<Base> & Mixin;
+    new (...args: ConstructorParameters<Base>): Mixin & InstanceType<Base>;
+    prototype: Mixin & InstanceType<Base>;
 } & {
     [K in keyof Base]: Base[K];
 };

package/src/translation-service.js

@@ -8,7 +8,7 @@
  */
 import CKEditorError from './ckeditorerror';
 import global from './dom/global';
-/* istanbul ignore else */
+/* istanbul ignore else -- @preserve */
 if (!global.window.CKEDITOR_TRANSLATIONS) {
     global.window.CKEDITOR_TRANSLATIONS = {};
 }

package/src/verifylicense.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * Possible states of the key after verification.
+ */
+export type VerifiedKeyStatus = 'VALID' | 'INVALID';
+/**
+ * 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.
+ */
+export default function verifyLicense(token: string | undefined): VerifiedKeyStatus;

package/src/verifylicense.js

@@ -0,0 +1,83 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module utils/verifylicense
+ */
+import { releaseDate } from './version';
+/**
+ * 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.
+ */
+export default function verifyLicense(token) {
+    function oldTokenCheck(token) {
+        if (token.match(/^[a-zA-Z0-9+/=$]+$/g) && (token.length >= 40 && token.length <= 255)) {
+            return 'VALID';
+        }
+        else {
+            return 'INVALID';
+        }
+    }
+    // TODO: issue ci#3175
+    let decryptedData = '';
+    let decryptedSecondElement = '';
+    if (!token) {
+        return 'INVALID';
+    }
+    try {
+        decryptedData = atob(token);
+    }
+    catch (e) {
+        return 'INVALID';
+    }
+    const splittedDecryptedData = decryptedData.split('-');
+    const firstElement = splittedDecryptedData[0];
+    const secondElement = splittedDecryptedData[1];
+    if (!secondElement) {
+        return oldTokenCheck(token);
+    }
+    try {
+        atob(secondElement);
+    }
+    catch (e) {
+        try {
+            atob(firstElement);
+            if (!atob(firstElement).length) {
+                return oldTokenCheck(token);
+            }
+        }
+        catch (e) {
+            return oldTokenCheck(token);
+        }
+    }
+    if (firstElement.length < 40 || firstElement.length > 255) {
+        return 'INVALID';
+    }
+    try {
+        // Must be a valid format.
+        atob(firstElement);
+    }
+    catch (e) {
+        return 'INVALID';
+    }
+    try {
+        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 'VALID';
+}

package/src/version.d.ts

@@ -2,8 +2,9 @@
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
  */
-declare const version = "37.0.1";
+declare const version = "38.0.0-rc.0";
 export default version;
+export declare const releaseDate: Date;
 declare global {
     var CKEDITOR_VERSION: string;
 }

package/src/version.js

@@ -7,11 +7,13 @@
  */
 /* globals window, global */
 import CKEditorError from './ckeditorerror';
-const version = '37.0.1';
+const version = '38.0.0-rc.0';
 export default version;
-/* istanbul ignore next */
+// The second argument is not a month. It is `monthIndex` and starts from `0`.
+export const releaseDate = new Date(2023, 4, 15);
+/* istanbul ignore next -- @preserve */
 const windowOrGlobal = typeof window === 'object' ? window : global;
-/* istanbul ignore next */
+/* istanbul ignore next -- @preserve */
 if (windowOrGlobal.CKEDITOR_VERSION) {
     /**
      * This error is thrown when due to a mistake in how CKEditor 5 was installed or initialized, some