@ckeditor/ckeditor5-utils 0.0.0-internal-20241017.0

package/dist/env.d.ts

@@ -0,0 +1,144 @@
+/**
+ * @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
+ */
+/**
+ * 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 that 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;
+    /**
+     * 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;
+    /**
+     * 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;
+/**
+ * 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 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/eventinfo.d.ts

@@ -0,0 +1,62 @@
+/**
+ * @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
+ */
+/**
+ * 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/dist/fastdiff.d.ts

@@ -0,0 +1,116 @@
+/**
+ * @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
+ */
+import type { DiffResult } from './diff.js';
+import type { Change } from './difftochanges.js';
+/**
+ * @module utils/fastdiff
+ */
+/**
+ * Finds positions of the first and last change in the given string/array and generates a set of changes:
+ *
+ * ```ts
+ * fastDiff( '12a', '12xyza' );
+ * // [ { index: 2, type: 'insert', values: [ 'x', 'y', 'z' ] } ]
+ *
+ * fastDiff( '12a', '12aa' );
+ * // [ { index: 3, type: 'insert', values: [ 'a' ] } ]
+ *
+ * fastDiff( '12xyza', '12a' );
+ * // [ { index: 2, type: 'delete', howMany: 3 } ]
+ *
+ * fastDiff( [ '1', '2', 'a', 'a' ], [ '1', '2', 'a' ] );
+ * // [ { index: 3, type: 'delete', howMany: 1 } ]
+ *
+ * fastDiff( [ '1', '2', 'a', 'b', 'c', '3' ], [ '2', 'a', 'b' ] );
+ * // [ { index: 0, type: 'insert', values: [ '2', 'a', 'b' ] }, { index: 3, type: 'delete', howMany: 6 } ]
+ * ```
+ *
+ * Passed arrays can contain any type of data, however to compare them correctly custom comparator function
+ * should be passed as a third parameter:
+ *
+ * ```ts
+ * fastDiff( [ { value: 1 }, { value: 2 } ], [ { value: 1 }, { value: 3 } ], ( a, b ) => {
+ * 	return a.value === b.value;
+ * } );
+ * // [ { index: 1, type: 'insert', values: [ { value: 3 } ] }, { index: 2, type: 'delete', howMany: 1 } ]
+ * ```
+ *
+ * The resulted set of changes can be applied to the input in order to transform it into the output, for example:
+ *
+ * ```ts
+ * let input = '12abc3';
+ * const output = '2ab';
+ * const changes = fastDiff( input, output );
+ *
+ * changes.forEach( change => {
+ * 	if ( change.type == 'insert' ) {
+ * 		input = input.substring( 0, change.index ) + change.values.join( '' ) + input.substring( change.index );
+ * 	} else if ( change.type == 'delete' ) {
+ * 		input = input.substring( 0, change.index ) + input.substring( change.index + change.howMany );
+ * 	}
+ * } );
+ *
+ * // input equals output now
+ * ```
+ *
+ * or in case of arrays:
+ *
+ * ```ts
+ * let input = [ '1', '2', 'a', 'b', 'c', '3' ];
+ * const output = [ '2', 'a', 'b' ];
+ * const changes = fastDiff( input, output );
+ *
+ * changes.forEach( change => {
+ * 	if ( change.type == 'insert' ) {
+ * 		input = input.slice( 0, change.index ).concat( change.values, input.slice( change.index ) );
+ * 	} else if ( change.type == 'delete' ) {
+ * 		input = input.slice( 0, change.index ).concat( input.slice( change.index + change.howMany ) );
+ * 	}
+ * } );
+ *
+ * // input equals output now
+ * ```
+ *
+ * By passing `true` as the fourth parameter (`atomicChanges`) the output of this function will become compatible with
+ * the {@link module:utils/diff~diff `diff()`} function:
+ *
+ * ```ts
+ * fastDiff( '12a', '12xyza', undefined, true );
+ * // [ 'equal', 'equal', 'insert', 'insert', 'insert', 'equal' ]
+ * ```
+ *
+ * The default output format of this function is compatible with the output format of
+ * {@link module:utils/difftochanges~diffToChanges `diffToChanges()`}. The `diffToChanges()` input format is, in turn,
+ * compatible with the output of {@link module:utils/diff~diff `diff()`}:
+ *
+ * ```ts
+ * const a = '1234';
+ * const b = '12xyz34';
+ *
+ * // Both calls will return the same results (grouped changes format).
+ * fastDiff( a, b );
+ * diffToChanges( diff( a, b ) );
+ *
+ * // Again, both calls will return the same results (atomic changes format).
+ * fastDiff( a, b, undefined, true );
+ * diff( a, b );
+ * ```
+ *
+ * @typeParam T The type of array elements.
+ * @typeParam AtomicChanges The type of `atomicChanges` parameter (selects the result type).
+ * @param a Input array or string.
+ * @param b Input array or string.
+ * @param cmp Optional function used to compare array values, by default `===` (strict equal operator) is used.
+ * @param atomicChanges Whether an array of `inset|delete|equal` operations should
+ * be returned instead of changes set. This makes this function compatible with {@link module:utils/diff~diff `diff()`}.
+ * Defaults to `false`.
+ * @returns Array of changes. The elements are either {@link module:utils/diff~DiffResult} or {@link module:utils/difftochanges~Change},
+ * depending on `atomicChanges` parameter.
+ */
+export default function fastDiff<T, AtomicChanges extends boolean = false>(a: ArrayLike<T>, b: ArrayLike<T>, cmp?: (a: T, b: T) => boolean, atomicChanges?: AtomicChanges): Array<AtomicChanges extends true ? DiffResult : Change<T>>;

package/dist/first.d.ts

@@ -0,0 +1,15 @@
+/**
+ * @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
+ */
+/**
+ * @module utils/first
+ */
+/**
+ * Returns first item of the given `iterator`.
+ */
+export default function first<T>(iterator: Iterator<T>): T | null;

package/dist/focustracker.d.ts

@@ -0,0 +1,83 @@
+/**
+ * @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
+ */
+declare const FocusTracker_base: import("./mix.js").Mixed<{
+    new (): import("./observablemixin.js").Observable;
+    prototype: import("./observablemixin.js").Observable;
+}, import("./dom/emittermixin.js").DomEmitter>;
+/**
+ * Allows observing a group of `Element`s whether at least one of them is focused.
+ *
+ * Used by the {@link module:core/editor/editor~Editor} in order to track whether the focus is still within the application,
+ * or were used outside of its UI.
+ *
+ * **Note** `focus` and `blur` listeners use event capturing, so it is only needed to register wrapper `Element`
+ * which contain other `focusable` elements. But note that this wrapper element has to be focusable too
+ * (have e.g. `tabindex="-1"`).
+ *
+ * Check out the {@glink framework/deep-dive/ui/focus-tracking "Deep dive into focus tracking"} guide to learn more.
+ */
+export default class FocusTracker extends /* #__PURE__ */ FocusTracker_base {
+    /**
+     * True when one of the registered elements is focused.
+     *
+     * @readonly
+     * @observable
+     */
+    isFocused: boolean;
+    /**
+     * The currently focused element.
+     *
+     * While {@link #isFocused `isFocused`} remains `true`, the focus can
+     * move between different UI elements. This property tracks those
+     * elements and tells which one is currently focused.
+     *
+     * @readonly
+     * @observable
+     */
+    focusedElement: Element | null;
+    /**
+     * List of registered elements.
+     *
+     * @internal
+     */
+    _elements: Set<Element>;
+    /**
+     * Event loop timeout.
+     */
+    private _nextEventLoopTimeout;
+    constructor();
+    /**
+     * List of registered elements.
+     */
+    get elements(): Array<Element>;
+    /**
+     * Starts tracking the specified element.
+     */
+    add(element: Element): void;
+    /**
+     * Stops tracking the specified element and stops listening on this element.
+     */
+    remove(element: Element): void;
+    /**
+     * Destroys the focus tracker by:
+     * - Disabling all event listeners attached to tracked elements.
+     * - Removing all tracked elements that were previously added.
+     */
+    destroy(): void;
+    /**
+     * Stores currently focused element and set {@link #isFocused} as `true`.
+     */
+    private _focus;
+    /**
+     * Clears currently focused element and set {@link #isFocused} as `false`.
+     * This method uses `setTimeout` to change order of fires `blur` and `focus` events.
+     */
+    private _blur;
+}
+export {};

package/dist/index-content.css

@@ -0,0 +1,4 @@
+/**
+ * @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
+ */

package/dist/index-editor.css

@@ -0,0 +1,4 @@
+/**
+ * @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
+ */

package/dist/index.css

@@ -0,0 +1,4 @@
+/**
+ * @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
+ */

package/dist/index.d.ts

@@ -0,0 +1,70 @@
+/**
+ * @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
+ */
+/**
+ * @module utils
+ */
+export { default as env } from './env.js';
+export { default as diff, type DiffResult } from './diff.js';
+export { default as fastDiff } from './fastdiff.js';
+export { default as diffToChanges } from './difftochanges.js';
+export { default as mix } from './mix.js';
+export type { Constructor, Mixed } from './mix.js';
+export { default as EmitterMixin, type Emitter, type BaseEvent, type CallbackOptions, type EmitterMixinDelegateChain, type GetCallback, type GetCallbackOptions, type GetEventInfo, type GetNameOrEventInfo } from './emittermixin.js';
+export { default as EventInfo } from './eventinfo.js';
+export { default as ObservableMixin, type Observable, type DecoratedMethodEvent, type ObservableChangeEvent, type ObservableSetEvent } from './observablemixin.js';
+export { default as CKEditorError, logError, logWarning } from './ckeditorerror.js';
+export { default as ElementReplacer } from './elementreplacer.js';
+export { default as abortableDebounce, type AbortableFunc } from './abortabledebounce.js';
+export { default as count } from './count.js';
+export { default as compareArrays } from './comparearrays.js';
+export { default as createElement } from './dom/createelement.js';
+export { default as Config } from './config.js';
+export { default as isIterable } from './isiterable.js';
+export { default as DomEmitterMixin, type DomEmitter } from './dom/emittermixin.js';
+export { default as findClosestScrollableAncestor } from './dom/findclosestscrollableancestor.js';
+export { default as global } from './dom/global.js';
+export { default as getAncestors } from './dom/getancestors.js';
+export { default as getDataFromElement } from './dom/getdatafromelement.js';
+export { default as getBorderWidths } from './dom/getborderwidths.js';
+export { default as getRangeFromMouseEvent } from './dom/getrangefrommouseevent.js';
+export { default as isText } from './dom/istext.js';
+export { default as Rect, type RectSource } from './dom/rect.js';
+export { default as ResizeObserver } from './dom/resizeobserver.js';
+export { default as setDataInElement } from './dom/setdatainelement.js';
+export { default as toUnit } from './dom/tounit.js';
+export { default as indexOf } from './dom/indexof.js';
+export { default as insertAt } from './dom/insertat.js';
+export { default as isComment } from './dom/iscomment.js';
+export { default as isNode } from './dom/isnode.js';
+export { default as isRange } from './dom/isrange.js';
+export { default as isValidAttributeName } from './dom/isvalidattributename.js';
+export { default as isVisible } from './dom/isvisible.js';
+export { getOptimalPosition, type Options as PositionOptions, type PositioningFunction, type DomPoint } from './dom/position.js';
+export { default as remove } from './dom/remove.js';
+export * from './dom/scroll.js';
+export * from './keyboard.js';
+export * from './language.js';
+export { default as Locale, type LocaleTranslate, type Translations } from './locale.js';
+export { default as Collection, type CollectionAddEvent, type CollectionChangeEvent, type CollectionRemoveEvent } from './collection.js';
+export { default as first } from './first.js';
+export { default as FocusTracker } from './focustracker.js';
+export { default as KeystrokeHandler, type KeystrokeHandlerOptions } from './keystrokehandler.js';
+export { default as toArray, type ArrayOrItem, type ReadonlyArrayOrItem } from './toarray.js';
+export { default as toMap } from './tomap.js';
+export { default as priorities, type PriorityString } from './priorities.js';
+export { default as retry, exponentialDelay } from './retry.js';
+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 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';