@ckeditor/ckeditor5-utils 40.0.0 → 40.2.0

package/src/env.d.ts

@@ -1,117 +1,117 @@
-/**
- * @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/env
- */
-/**
- * Safely returns `userAgent` from browser's navigator API in a lower case.
- * If navigator API is not available it will return an empty string.
- */
-export declare function getUserAgent(): string;
-/**
- * A namespace containing environment and browser information.
- */
-export interface EnvType {
-    /**
-     * Indicates that the application is running on Macintosh.
-     */
-    readonly isMac: boolean;
-    /**
-     * Indicates that the application is running on Windows.
-     */
-    readonly isWindows: boolean;
-    /**
-     * Indicates that the application is running in Firefox (Gecko).
-     */
-    readonly isGecko: boolean;
-    /**
-     * Indicates that the application is running in Safari.
-     */
-    readonly isSafari: boolean;
-    /**
-     * Indicates the the application is running in iOS.
-     */
-    readonly isiOS: boolean;
-    /**
-     * Indicates that the application is running on Android mobile device.
-     */
-    readonly isAndroid: boolean;
-    /**
-     * Indicates that the application is running in a browser using the Blink engine.
-     */
-    readonly isBlink: boolean;
-    /**
-     * Environment features information.
-     */
-    readonly features: EnvFeaturesType;
-}
-export interface EnvFeaturesType {
-    /**
-     * Indicates that the environment supports ES2018 Unicode property escapes — like `\p{P}` or `\p{L}`.
-     * More information about unicode properties might be found
-     * [in Unicode Standard Annex #44](https://www.unicode.org/reports/tr44/#GC_Values_Table).
-     */
-    readonly isRegExpUnicodePropertySupported: boolean;
-}
-/**
- * A namespace containing environment and browser information.
- */
-declare const env: EnvType;
-export default env;
-/**
- * Checks if User Agent represented by the string is running on Macintosh.
- *
- * @param userAgent **Lowercase** `navigator.userAgent` string.
- * @returns Whether User Agent is running on Macintosh or not.
- */
-export declare function isMac(userAgent: string): boolean;
-/**
- * Checks if User Agent represented by the string is running on Windows.
- *
- * @param userAgent **Lowercase** `navigator.userAgent` string.
- * @returns Whether User Agent is running on Windows or not.
- */
-export declare function isWindows(userAgent: string): boolean;
-/**
- * Checks if User Agent represented by the string is Firefox (Gecko).
- *
- * @param userAgent **Lowercase** `navigator.userAgent` string.
- * @returns Whether User Agent is Firefox or not.
- */
-export declare function isGecko(userAgent: string): boolean;
-/**
- * Checks if User Agent represented by the string is Safari.
- *
- * @param userAgent **Lowercase** `navigator.userAgent` string.
- * @returns Whether User Agent is Safari or not.
- */
-export declare function isSafari(userAgent: string): boolean;
-/**
- * Checks if User Agent represented by the string is running in iOS.
- *
- * @param userAgent **Lowercase** `navigator.userAgent` string.
- * @returns Whether User Agent is running in iOS or not.
- */
-export declare function isiOS(userAgent: string): boolean;
-/**
- * Checks if User Agent represented by the string is Android mobile device.
- *
- * @param userAgent **Lowercase** `navigator.userAgent` string.
- * @returns Whether User Agent is Safari or not.
- */
-export declare function isAndroid(userAgent: string): boolean;
-/**
- * Checks if User Agent represented by the string is Blink engine.
- *
- * @param userAgent **Lowercase** `navigator.userAgent` string.
- * @returns Whether User Agent is Blink engine or not.
- */
-export declare function isBlink(userAgent: string): boolean;
-/**
- * Checks if the current environment supports ES2018 Unicode properties like `\p{P}` or `\p{L}`.
- * More information about unicode properties might be found
- * [in Unicode Standard Annex #44](https://www.unicode.org/reports/tr44/#GC_Values_Table).
- */
-export declare function isRegExpUnicodePropertySupported(): boolean;
+/**
+ * @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/env
+ */
+/**
+ * Safely returns `userAgent` from browser's navigator API in a lower case.
+ * If navigator API is not available it will return an empty string.
+ */
+export declare function getUserAgent(): string;
+/**
+ * A namespace containing environment and browser information.
+ */
+export interface EnvType {
+    /**
+     * Indicates that the application is running on Macintosh.
+     */
+    readonly isMac: boolean;
+    /**
+     * Indicates that the application is running on Windows.
+     */
+    readonly isWindows: boolean;
+    /**
+     * Indicates that the application is running in Firefox (Gecko).
+     */
+    readonly isGecko: boolean;
+    /**
+     * Indicates that the application is running in Safari.
+     */
+    readonly isSafari: boolean;
+    /**
+     * Indicates the the application is running in iOS.
+     */
+    readonly isiOS: boolean;
+    /**
+     * Indicates that the application is running on Android mobile device.
+     */
+    readonly isAndroid: boolean;
+    /**
+     * Indicates that the application is running in a browser using the Blink engine.
+     */
+    readonly isBlink: boolean;
+    /**
+     * Environment features information.
+     */
+    readonly features: EnvFeaturesType;
+}
+export interface EnvFeaturesType {
+    /**
+     * Indicates that the environment supports ES2018 Unicode property escapes — like `\p{P}` or `\p{L}`.
+     * More information about unicode properties might be found
+     * [in Unicode Standard Annex #44](https://www.unicode.org/reports/tr44/#GC_Values_Table).
+     */
+    readonly isRegExpUnicodePropertySupported: boolean;
+}
+/**
+ * A namespace containing environment and browser information.
+ */
+declare const env: EnvType;
+export default env;
+/**
+ * Checks if User Agent represented by the string is running on Macintosh.
+ *
+ * @param userAgent **Lowercase** `navigator.userAgent` string.
+ * @returns Whether User Agent is running on Macintosh or not.
+ */
+export declare function isMac(userAgent: string): boolean;
+/**
+ * Checks if User Agent represented by the string is running on Windows.
+ *
+ * @param userAgent **Lowercase** `navigator.userAgent` string.
+ * @returns Whether User Agent is running on Windows or not.
+ */
+export declare function isWindows(userAgent: string): boolean;
+/**
+ * Checks if User Agent represented by the string is Firefox (Gecko).
+ *
+ * @param userAgent **Lowercase** `navigator.userAgent` string.
+ * @returns Whether User Agent is Firefox or not.
+ */
+export declare function isGecko(userAgent: string): boolean;
+/**
+ * Checks if User Agent represented by the string is Safari.
+ *
+ * @param userAgent **Lowercase** `navigator.userAgent` string.
+ * @returns Whether User Agent is Safari or not.
+ */
+export declare function isSafari(userAgent: string): boolean;
+/**
+ * Checks if User Agent represented by the string is running in iOS.
+ *
+ * @param userAgent **Lowercase** `navigator.userAgent` string.
+ * @returns Whether User Agent is running in iOS or not.
+ */
+export declare function isiOS(userAgent: string): boolean;
+/**
+ * Checks if User Agent represented by the string is Android mobile device.
+ *
+ * @param userAgent **Lowercase** `navigator.userAgent` string.
+ * @returns Whether User Agent is Safari or not.
+ */
+export declare function isAndroid(userAgent: string): boolean;
+/**
+ * Checks if User Agent represented by the string is Blink engine.
+ *
+ * @param userAgent **Lowercase** `navigator.userAgent` string.
+ * @returns Whether User Agent is Blink engine or not.
+ */
+export declare function isBlink(userAgent: string): boolean;
+/**
+ * Checks if the current environment supports ES2018 Unicode properties like `\p{P}` or `\p{L}`.
+ * More information about unicode properties might be found
+ * [in Unicode Standard Annex #44](https://www.unicode.org/reports/tr44/#GC_Values_Table).
+ */
+export declare function isRegExpUnicodePropertySupported(): boolean;

package/src/env.js

@@ -1,122 +1,122 @@
-/**
- * @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
- */
-/* globals navigator:false */
-/**
- * @module utils/env
- */
-/**
- * Safely returns `userAgent` from browser's navigator API in a lower case.
- * If navigator API is not available it will return an empty string.
- */
-export function getUserAgent() {
-    // In some environments navigator API might not be available.
-    try {
-        return navigator.userAgent.toLowerCase();
-    }
-    catch (e) {
-        return '';
-    }
-}
-const userAgent = getUserAgent();
-/**
- * A namespace containing environment and browser information.
- */
-const env = {
-    isMac: isMac(userAgent),
-    isWindows: isWindows(userAgent),
-    isGecko: isGecko(userAgent),
-    isSafari: isSafari(userAgent),
-    isiOS: isiOS(userAgent),
-    isAndroid: isAndroid(userAgent),
-    isBlink: isBlink(userAgent),
-    features: {
-        isRegExpUnicodePropertySupported: isRegExpUnicodePropertySupported()
-    }
-};
-export default env;
-/**
- * Checks if User Agent represented by the string is running on Macintosh.
- *
- * @param userAgent **Lowercase** `navigator.userAgent` string.
- * @returns Whether User Agent is running on Macintosh or not.
- */
-export function isMac(userAgent) {
-    return userAgent.indexOf('macintosh') > -1;
-}
-/**
- * Checks if User Agent represented by the string is running on Windows.
- *
- * @param userAgent **Lowercase** `navigator.userAgent` string.
- * @returns Whether User Agent is running on Windows or not.
- */
-export function isWindows(userAgent) {
-    return userAgent.indexOf('windows') > -1;
-}
-/**
- * Checks if User Agent represented by the string is Firefox (Gecko).
- *
- * @param userAgent **Lowercase** `navigator.userAgent` string.
- * @returns Whether User Agent is Firefox or not.
- */
-export function isGecko(userAgent) {
-    return !!userAgent.match(/gecko\/\d+/);
-}
-/**
- * Checks if User Agent represented by the string is Safari.
- *
- * @param userAgent **Lowercase** `navigator.userAgent` string.
- * @returns Whether User Agent is Safari or not.
- */
-export function isSafari(userAgent) {
-    return userAgent.indexOf(' applewebkit/') > -1 && userAgent.indexOf('chrome') === -1;
-}
-/**
- * Checks if User Agent represented by the string is running in iOS.
- *
- * @param userAgent **Lowercase** `navigator.userAgent` string.
- * @returns Whether User Agent is running in iOS or not.
- */
-export function isiOS(userAgent) {
-    // "Request mobile site" || "Request desktop site".
-    return !!userAgent.match(/iphone|ipad/i) || (isMac(userAgent) && navigator.maxTouchPoints > 0);
-}
-/**
- * Checks if User Agent represented by the string is Android mobile device.
- *
- * @param userAgent **Lowercase** `navigator.userAgent` string.
- * @returns Whether User Agent is Safari or not.
- */
-export function isAndroid(userAgent) {
-    return userAgent.indexOf('android') > -1;
-}
-/**
- * Checks if User Agent represented by the string is Blink engine.
- *
- * @param userAgent **Lowercase** `navigator.userAgent` string.
- * @returns Whether User Agent is Blink engine or not.
- */
-export function isBlink(userAgent) {
-    // The Edge browser before switching to the Blink engine used to report itself as Chrome (and "Edge/")
-    // but after switching to the Blink it replaced "Edge/" with "Edg/".
-    return userAgent.indexOf('chrome/') > -1 && userAgent.indexOf('edge/') < 0;
-}
-/**
- * Checks if the current environment supports ES2018 Unicode properties like `\p{P}` or `\p{L}`.
- * More information about unicode properties might be found
- * [in Unicode Standard Annex #44](https://www.unicode.org/reports/tr44/#GC_Values_Table).
- */
-export function isRegExpUnicodePropertySupported() {
-    let isSupported = false;
-    // Feature detection for Unicode properties. Added in ES2018. Currently Firefox does not support it.
-    // See https://github.com/ckeditor/ckeditor5-mention/issues/44#issuecomment-487002174.
-    try {
-        // Usage of regular expression literal cause error during build (ckeditor/ckeditor5-dev#534).
-        isSupported = 'ć'.search(new RegExp('[\\p{L}]', 'u')) === 0;
-    }
-    catch (error) {
-        // Firefox throws a SyntaxError when the group is unsupported.
-    }
-    return isSupported;
-}
+/**
+ * @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
+ */
+/* globals navigator:false */
+/**
+ * @module utils/env
+ */
+/**
+ * Safely returns `userAgent` from browser's navigator API in a lower case.
+ * If navigator API is not available it will return an empty string.
+ */
+export function getUserAgent() {
+    // In some environments navigator API might not be available.
+    try {
+        return navigator.userAgent.toLowerCase();
+    }
+    catch (e) {
+        return '';
+    }
+}
+const userAgent = getUserAgent();
+/**
+ * A namespace containing environment and browser information.
+ */
+const env = {
+    isMac: isMac(userAgent),
+    isWindows: isWindows(userAgent),
+    isGecko: isGecko(userAgent),
+    isSafari: isSafari(userAgent),
+    isiOS: isiOS(userAgent),
+    isAndroid: isAndroid(userAgent),
+    isBlink: isBlink(userAgent),
+    features: {
+        isRegExpUnicodePropertySupported: isRegExpUnicodePropertySupported()
+    }
+};
+export default env;
+/**
+ * Checks if User Agent represented by the string is running on Macintosh.
+ *
+ * @param userAgent **Lowercase** `navigator.userAgent` string.
+ * @returns Whether User Agent is running on Macintosh or not.
+ */
+export function isMac(userAgent) {
+    return userAgent.indexOf('macintosh') > -1;
+}
+/**
+ * Checks if User Agent represented by the string is running on Windows.
+ *
+ * @param userAgent **Lowercase** `navigator.userAgent` string.
+ * @returns Whether User Agent is running on Windows or not.
+ */
+export function isWindows(userAgent) {
+    return userAgent.indexOf('windows') > -1;
+}
+/**
+ * Checks if User Agent represented by the string is Firefox (Gecko).
+ *
+ * @param userAgent **Lowercase** `navigator.userAgent` string.
+ * @returns Whether User Agent is Firefox or not.
+ */
+export function isGecko(userAgent) {
+    return !!userAgent.match(/gecko\/\d+/);
+}
+/**
+ * Checks if User Agent represented by the string is Safari.
+ *
+ * @param userAgent **Lowercase** `navigator.userAgent` string.
+ * @returns Whether User Agent is Safari or not.
+ */
+export function isSafari(userAgent) {
+    return userAgent.indexOf(' applewebkit/') > -1 && userAgent.indexOf('chrome') === -1;
+}
+/**
+ * Checks if User Agent represented by the string is running in iOS.
+ *
+ * @param userAgent **Lowercase** `navigator.userAgent` string.
+ * @returns Whether User Agent is running in iOS or not.
+ */
+export function isiOS(userAgent) {
+    // "Request mobile site" || "Request desktop site".
+    return !!userAgent.match(/iphone|ipad/i) || (isMac(userAgent) && navigator.maxTouchPoints > 0);
+}
+/**
+ * Checks if User Agent represented by the string is Android mobile device.
+ *
+ * @param userAgent **Lowercase** `navigator.userAgent` string.
+ * @returns Whether User Agent is Safari or not.
+ */
+export function isAndroid(userAgent) {
+    return userAgent.indexOf('android') > -1;
+}
+/**
+ * Checks if User Agent represented by the string is Blink engine.
+ *
+ * @param userAgent **Lowercase** `navigator.userAgent` string.
+ * @returns Whether User Agent is Blink engine or not.
+ */
+export function isBlink(userAgent) {
+    // The Edge browser before switching to the Blink engine used to report itself as Chrome (and "Edge/")
+    // but after switching to the Blink it replaced "Edge/" with "Edg/".
+    return userAgent.indexOf('chrome/') > -1 && userAgent.indexOf('edge/') < 0;
+}
+/**
+ * Checks if the current environment supports ES2018 Unicode properties like `\p{P}` or `\p{L}`.
+ * More information about unicode properties might be found
+ * [in Unicode Standard Annex #44](https://www.unicode.org/reports/tr44/#GC_Values_Table).
+ */
+export function isRegExpUnicodePropertySupported() {
+    let isSupported = false;
+    // Feature detection for Unicode properties. Added in ES2018. Currently Firefox does not support it.
+    // See https://github.com/ckeditor/ckeditor5-mention/issues/44#issuecomment-487002174.
+    try {
+        // Usage of regular expression literal cause error during build (ckeditor/ckeditor5-dev#534).
+        isSupported = 'ć'.search(new RegExp('[\\p{L}]', 'u')) === 0;
+    }
+    catch (error) {
+        // Firefox throws a SyntaxError when the group is unsupported.
+    }
+    return isSupported;
+}

package/src/eventinfo.d.ts

@@ -1,58 +1,58 @@
-/**
- * @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
- */
-/**
- * The event object passed to event callbacks. It is used to provide information about the event as well as a tool to
- * manipulate it.
- */
-export default class EventInfo<TName extends string = string, TReturn = unknown> {
-    /**
-     * The object that fired the event.
-     */
-    readonly source: object;
-    /**
-     * The event name.
-     */
-    readonly name: TName;
-    /**
-     * Path this event has followed. See {@link module:utils/emittermixin~Emitter#delegate}.
-     */
-    path: Array<object>;
-    /**
-     * Stops the event emitter to call further callbacks for this event interaction.
-     */
-    readonly stop: {
-        (): void;
-        called?: boolean;
-    };
-    /**
-     * Removes the current callback from future interactions of this event.
-     */
-    readonly off: {
-        (): void;
-        called?: boolean;
-    };
-    /**
-     * The value which will be returned by {@link module:utils/emittermixin~Emitter#fire}.
-     *
-     * It's `undefined` by default and can be changed by an event listener:
-     *
-     * ```ts
-     * dataController.fire( 'getSelectedContent', ( evt ) => {
-     * 	// This listener will make `dataController.fire( 'getSelectedContent' )`
-     * 	// always return an empty DocumentFragment.
-     * 	evt.return = new DocumentFragment();
-     *
-     * 	// Make sure no other listeners are executed.
-     * 	evt.stop();
-     * } );
-     * ```
-     */
-    return: TReturn | undefined;
-    /**
-     * @param source The emitter.
-     * @param name The event name.
-     */
-    constructor(source: object, name: TName);
-}
+/**
+ * @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
+ */
+/**
+ * The event object passed to event callbacks. It is used to provide information about the event as well as a tool to
+ * manipulate it.
+ */
+export default class EventInfo<TName extends string = string, TReturn = unknown> {
+    /**
+     * The object that fired the event.
+     */
+    readonly source: object;
+    /**
+     * The event name.
+     */
+    readonly name: TName;
+    /**
+     * Path this event has followed. See {@link module:utils/emittermixin~Emitter#delegate}.
+     */
+    path: Array<object>;
+    /**
+     * Stops the event emitter to call further callbacks for this event interaction.
+     */
+    readonly stop: {
+        (): void;
+        called?: boolean;
+    };
+    /**
+     * Removes the current callback from future interactions of this event.
+     */
+    readonly off: {
+        (): void;
+        called?: boolean;
+    };
+    /**
+     * The value which will be returned by {@link module:utils/emittermixin~Emitter#fire}.
+     *
+     * It's `undefined` by default and can be changed by an event listener:
+     *
+     * ```ts
+     * dataController.fire( 'getSelectedContent', ( evt ) => {
+     * 	// This listener will make `dataController.fire( 'getSelectedContent' )`
+     * 	// always return an empty DocumentFragment.
+     * 	evt.return = new DocumentFragment();
+     *
+     * 	// Make sure no other listeners are executed.
+     * 	evt.stop();
+     * } );
+     * ```
+     */
+    return: TReturn | undefined;
+    /**
+     * @param source The emitter.
+     * @param name The event name.
+     */
+    constructor(source: object, name: TName);
+}

package/src/eventinfo.js

@@ -1,26 +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/eventinfo
- */
-import spy from './spy';
-/**
- * The event object passed to event callbacks. It is used to provide information about the event as well as a tool to
- * manipulate it.
- */
-export default class EventInfo {
-    /**
-     * @param source The emitter.
-     * @param name The event name.
-     */
-    constructor(source, name) {
-        this.source = source;
-        this.name = name;
-        this.path = [];
-        // The following methods are defined in the constructor because they must be re-created per instance.
-        this.stop = spy();
-        this.off = spy();
-    }
-}
+/**
+ * @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/eventinfo
+ */
+import spy from './spy';
+/**
+ * The event object passed to event callbacks. It is used to provide information about the event as well as a tool to
+ * manipulate it.
+ */
+export default class EventInfo {
+    /**
+     * @param source The emitter.
+     * @param name The event name.
+     */
+    constructor(source, name) {
+        this.source = source;
+        this.name = name;
+        this.path = [];
+        // The following methods are defined in the constructor because they must be re-created per instance.
+        this.stop = spy();
+        this.off = spy();
+    }
+}