@ckeditor/ckeditor5-utils 41.4.1 → 42.0.0-alpha.0

package/dist/types/collection.d.ts

@@ -22,7 +22,7 @@ declare const Collection_base: {
  *
  * @typeParam T The type of the collection element.
  */
-export default class Collection<T extends Record<string, any>> extends Collection_base implements Iterable<T> {
+export default class Collection<T extends Record<string, any>> extends /* #__PURE__ */ Collection_base implements Iterable<T> {
     /**
      * The internal list of items in the collection.
      */

package/dist/types/env.d.ts

@@ -6,9 +6,6 @@
  * @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/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.
@@ -35,7 +32,7 @@ export interface EnvType {
      */
     readonly isSafari: boolean;
     /**
-     * Indicates the the application is running in iOS.
+     * Indicates that the application is running in iOS.
      */
     readonly isiOS: boolean;
     /**
@@ -47,11 +44,17 @@ export interface EnvType {
      */
     readonly isBlink: boolean;
     /**
-     * Indicates that the the user agent has enabled a forced colors mode (e.g. Windows High Contrast mode).
+     * Indicates that the user agent has enabled a forced colors mode (e.g. Windows High Contrast mode).
+     *
+     * Note that the value of this property is evaluated each time it is accessed, and it may change over time, if the environment
+     * settings have changed.
      */
     readonly isMediaForcedColors: boolean;
     /**
      * Indicates that "prefer reduced motion" browser setting is active.
+     *
+     * Note that the value of this property is evaluated each time it is accessed, and it may change over time, if the environment
+     * settings have changed.
      */
     readonly isMotionReduced: boolean;
     /**
@@ -129,9 +132,13 @@ export declare function isBlink(userAgent: string): boolean;
 export declare function isRegExpUnicodePropertySupported(): boolean;
 /**
  * Checks if the user agent has enabled a forced colors mode (e.g. Windows High Contrast mode).
+ *
+ * Returns `false` in environments where `window` global object is not available.
  */
 export declare function isMediaForcedColors(): boolean;
 /**
- * Checks if user enabled "prefers reduced motion" setting in browser.
+ * Checks if the user enabled "prefers reduced motion" setting in browser.
+ *
+ * Returns `false` in environments where `window` global object is not available.
  */
 export declare function isMotionReduced(): boolean;

package/dist/types/focustracker.d.ts

@@ -22,7 +22,7 @@ declare const FocusTracker_base: import("./mix.js").Mixed<{
  *
  * Check out the {@glink framework/deep-dive/ui/focus-tracking "Deep dive into focus tracking"} guide to learn more.
  */
-export default class FocusTracker extends FocusTracker_base {
+export default class FocusTracker extends /* #__PURE__ */ FocusTracker_base {
     /**
      * True when one of the registered elements is focused.
      *

package/dist/types/locale.d.ts

@@ -97,7 +97,7 @@ export default class Locale {
     translations?: Translations;
     /**
      * Creates a new instance of the locale class. Learn more about
-     * {@glink features/ui-language configuring the language of the editor}.
+     * {@glink getting-started/setup/ui-language configuring the language of the editor}.
      *
      * @param options Locale configuration.
      * @param options.uiLanguage The editor UI language code in the

package/dist/types/version.d.ts

@@ -6,7 +6,7 @@
  * @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
  */
-declare const version = "41.4.1";
+declare const version = "42.0.0-alpha.0";
 export default version;
 export declare const releaseDate: Date;
 declare global {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-utils",
-  "version": "41.4.1",
+  "version": "42.0.0-alpha.0",
   "description": "Miscellaneous utilities used by CKEditor 5.",
   "keywords": [
     "ckeditor",

package/src/collection.d.ts

@@ -18,7 +18,7 @@ declare const Collection_base: {
  *
  * @typeParam T The type of the collection element.
  */
-export default class Collection<T extends Record<string, any>> extends Collection_base implements Iterable<T> {
+export default class Collection<T extends Record<string, any>> extends /* #__PURE__ */ Collection_base implements Iterable<T> {
     /**
      * The internal list of items in the collection.
      */

package/src/collection.js

@@ -21,7 +21,7 @@ import isIterable from './isiterable.js';
  *
  * @typeParam T The type of the collection element.
  */
-export default class Collection extends EmitterMixin() {
+export default class Collection extends /* #__PURE__ */ EmitterMixin() {
     constructor(initialItemsOrOptions = {}, options = {}) {
         super();
         const hasInitialItems = isIterable(initialItemsOrOptions);

package/src/dom/emittermixin.js

@@ -9,7 +9,7 @@ import EmitterMixin, { _getEmitterListenedTo, _setEmitterId } from '../emittermi
 import uid from '../uid.js';
 import isNode from './isnode.js';
 import isWindow from './iswindow.js';
-const defaultEmitterClass = DomEmitterMixin(EmitterMixin());
+const defaultEmitterClass = /* #__PURE__ */ DomEmitterMixin(/* #__PURE__ */ EmitterMixin());
 export default function DomEmitterMixin(base) {
     if (!base) {
         return defaultEmitterClass;
@@ -110,7 +110,7 @@ export default function DomEmitterMixin(base) {
  *                    +-----------------------------------------+
  *                                fire( click, DOM Event )
  */
-class ProxyEmitter extends EmitterMixin() {
+class ProxyEmitter extends /* #__PURE__ */ EmitterMixin() {
     /**
      * @param node DOM Node that fires events.
      * @param options Additional options.

package/src/emittermixin.js

@@ -15,7 +15,7 @@ import CKEditorError from './ckeditorerror.js';
 const _listeningTo = Symbol('listeningTo');
 const _emitterId = Symbol('emitterId');
 const _delegations = Symbol('delegations');
-const defaultEmitterClass = EmitterMixin(Object);
+const defaultEmitterClass = /* #__PURE__ */ EmitterMixin(Object);
 export default function EmitterMixin(base) {
     if (!base) {
         return defaultEmitterClass;

package/src/env.d.ts

@@ -2,9 +2,6 @@
  * @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/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.
@@ -31,7 +28,7 @@ export interface EnvType {
      */
     readonly isSafari: boolean;
     /**
-     * Indicates the the application is running in iOS.
+     * Indicates that the application is running in iOS.
      */
     readonly isiOS: boolean;
     /**
@@ -43,11 +40,17 @@ export interface EnvType {
      */
     readonly isBlink: boolean;
     /**
-     * Indicates that the the user agent has enabled a forced colors mode (e.g. Windows High Contrast mode).
+     * Indicates that the user agent has enabled a forced colors mode (e.g. Windows High Contrast mode).
+     *
+     * Note that the value of this property is evaluated each time it is accessed, and it may change over time, if the environment
+     * settings have changed.
      */
     readonly isMediaForcedColors: boolean;
     /**
      * Indicates that "prefer reduced motion" browser setting is active.
+     *
+     * Note that the value of this property is evaluated each time it is accessed, and it may change over time, if the environment
+     * settings have changed.
      */
     readonly isMotionReduced: boolean;
     /**
@@ -125,9 +128,13 @@ export declare function isBlink(userAgent: string): boolean;
 export declare function isRegExpUnicodePropertySupported(): boolean;
 /**
  * Checks if the user agent has enabled a forced colors mode (e.g. Windows High Contrast mode).
+ *
+ * Returns `false` in environments where `window` global object is not available.
  */
 export declare function isMediaForcedColors(): boolean;
 /**
- * Checks if user enabled "prefers reduced motion" setting in browser.
+ * Checks if the user enabled "prefers reduced motion" setting in browser.
+ *
+ * Returns `false` in environments where `window` global object is not available.
  */
 export declare function isMotionReduced(): boolean;

package/src/env.js

@@ -6,6 +6,7 @@
 /**
  * @module utils/env
  */
+import global from './dom/global.js';
 /**
  * Safely returns `userAgent` from browser's navigator API in a lower case.
  * If navigator API is not available it will return an empty string.
@@ -19,24 +20,26 @@ export function getUserAgent() {
         return '';
     }
 }
-const userAgent = getUserAgent();
+const userAgent = /* #__PURE__ */ 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),
-    isMediaForcedColors: isMediaForcedColors(),
+    isMac: /* #__PURE__ */ isMac(userAgent),
+    isWindows: /* #__PURE__ */ isWindows(userAgent),
+    isGecko: /* #__PURE__ */ isGecko(userAgent),
+    isSafari: /* #__PURE__ */ isSafari(userAgent),
+    isiOS: /* #__PURE__ */ isiOS(userAgent),
+    isAndroid: /* #__PURE__ */ isAndroid(userAgent),
+    isBlink: /* #__PURE__ */ isBlink(userAgent),
+    get isMediaForcedColors() {
+        return isMediaForcedColors();
+    },
     get isMotionReduced() {
         return isMotionReduced();
     },
     features: {
-        isRegExpUnicodePropertySupported: isRegExpUnicodePropertySupported()
+        isRegExpUnicodePropertySupported: /* #__PURE__ */ isRegExpUnicodePropertySupported()
     }
 };
 export default env;
@@ -126,13 +129,17 @@ export function isRegExpUnicodePropertySupported() {
 }
 /**
  * Checks if the user agent has enabled a forced colors mode (e.g. Windows High Contrast mode).
+ *
+ * Returns `false` in environments where `window` global object is not available.
  */
 export function isMediaForcedColors() {
-    return window.matchMedia('(forced-colors: active)').matches;
+    return global.window.matchMedia ? global.window.matchMedia('(forced-colors: active)').matches : false;
 }
 /**
- * Checks if user enabled "prefers reduced motion" setting in browser.
+ * Checks if the user enabled "prefers reduced motion" setting in browser.
+ *
+ * Returns `false` in environments where `window` global object is not available.
  */
 export function isMotionReduced() {
-    return window.matchMedia('(prefers-reduced-motion)').matches;
+    return global.window.matchMedia ? global.window.matchMedia('(prefers-reduced-motion)').matches : false;
 }

package/src/focustracker.d.ts

@@ -18,7 +18,7 @@ declare const FocusTracker_base: import("./mix.js").Mixed<{
  *
  * Check out the {@glink framework/deep-dive/ui/focus-tracking "Deep dive into focus tracking"} guide to learn more.
  */
-export default class FocusTracker extends FocusTracker_base {
+export default class FocusTracker extends /* #__PURE__ */ FocusTracker_base {
     /**
      * True when one of the registered elements is focused.
      *

package/src/focustracker.js

@@ -21,7 +21,7 @@ import CKEditorError from './ckeditorerror.js';
  *
  * Check out the {@glink framework/deep-dive/ui/focus-tracking "Deep dive into focus tracking"} guide to learn more.
  */
-export default class FocusTracker extends DomEmitterMixin(ObservableMixin()) {
+export default class FocusTracker extends /* #__PURE__ */ DomEmitterMixin(/* #__PURE__ */ ObservableMixin()) {
     constructor() {
         super();
         /**

package/src/keyboard.js

@@ -37,8 +37,9 @@ const keyCodesToGlyphs = {
  * * `backspace`, `delete`, `enter`, `esc`, `tab`,
  * * `ctrl`, `cmd`, `shift`, `alt`.
  */
-export const keyCodes = generateKnownKeyCodes();
-const keyCodeNames = Object.fromEntries(Object.entries(keyCodes).map(([name, code]) => {
+export const keyCodes = /* #__PURE__ */ generateKnownKeyCodes();
+const keyCodeNames = /* #__PURE__ */ Object.fromEntries(
+/* #__PURE__ */ Object.entries(keyCodes).map(([name, code]) => {
     let prettyKeyName;
     if (code in keyCodesToGlyphs) {
         prettyKeyName = keyCodesToGlyphs[code];

package/src/locale.d.ts

@@ -93,7 +93,7 @@ export default class Locale {
     translations?: Translations;
     /**
      * Creates a new instance of the locale class. Learn more about
-     * {@glink features/ui-language configuring the language of the editor}.
+     * {@glink getting-started/setup/ui-language configuring the language of the editor}.
      *
      * @param options Locale configuration.
      * @param options.uiLanguage The editor UI language code in the

package/src/locale.js

@@ -15,7 +15,7 @@ import { getLanguageDirection } from './language.js';
 export default class Locale {
     /**
      * Creates a new instance of the locale class. Learn more about
-     * {@glink features/ui-language configuring the language of the editor}.
+     * {@glink getting-started/setup/ui-language configuring the language of the editor}.
      *
      * @param options Locale configuration.
      * @param options.uiLanguage The editor UI language code in the

package/src/observablemixin.js

@@ -14,7 +14,7 @@ const boundObservablesSymbol = Symbol('boundObservables');
 const boundPropertiesSymbol = Symbol('boundProperties');
 const decoratedMethods = Symbol('decoratedMethods');
 const decoratedOriginal = Symbol('decoratedOriginal');
-const defaultObservableClass = ObservableMixin(EmitterMixin());
+const defaultObservableClass = /* #__PURE__ */ ObservableMixin(/* #__PURE__ */ EmitterMixin());
 export default function ObservableMixin(base) {
     if (!base) {
         return defaultObservableClass;

package/src/unicode.js

@@ -56,7 +56,7 @@ export function isInsideSurrogatePair(string, offset) {
 export function isInsideCombinedSymbol(string, offset) {
     return isCombiningMark(string.charAt(offset));
 }
-const EMOJI_PATTERN = buildEmojiRegexp();
+const EMOJI_PATTERN = /* #__PURE__ */ buildEmojiRegexp();
 /**
  * Checks whether given offset in a string is inside multi-character emoji sequence.
  *

package/src/version.d.ts

@@ -2,7 +2,7 @@
  * @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
  */
-declare const version = "41.4.1";
+declare const version = "42.0.0-alpha.0";
 export default version;
 export declare const releaseDate: Date;
 declare global {

package/src/version.js

@@ -6,13 +6,19 @@
  * @module utils/version
  */
 import CKEditorError from './ckeditorerror.js';
-const version = '41.4.1';
+const version = '42.0.0-alpha.0';
 export default version;
 // The second argument is not a month. It is `monthIndex` and starts from `0`.
-export const releaseDate = new Date(2024, 4, 16);
+export const releaseDate = new Date(2024, 5, 5);
 /* istanbul ignore next -- @preserve */
 if (globalThis.CKEDITOR_VERSION) {
     /**
+     * The best solution to avoid this error is migrating your CKEditor 5 instance to
+     * {@glink updating/new-installation-methods new installation methods}.
+     *
+     * Mentioned below are predefined builds, which are a deprecated installation method. The solutions
+     * provided are kept here for legacy support only.
+     *
      * This error is thrown when due to a mistake in how CKEditor 5 was installed or initialized, some
      * of its modules were duplicated (evaluated and executed twice). Module duplication leads to inevitable runtime
      * errors.
@@ -43,15 +49,11 @@ if (globalThis.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 installation/plugins/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 installation/advanced/alternative-setups/integrating-from-source-webpack "Building from source"} section
-     * or in the {@glink framework/quick-start "Quick start"} guide of CKEditor 5 Framework.
+     * Let's assume that you wanted to use CKEditor 5 from source.
      *
      * The correct way to do so is to import an editor and plugins and run them together like this:
      *
@@ -96,7 +98,7 @@ if (globalThis.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 installation/advanced/using-two-editors "Using two different editors"}
+     * {@glink getting-started/legacy/advanced/using-two-editors "Using two different editors"}
      * section.
      *
      * # Using outdated packages