@ckeditor/ckeditor5-utils 41.3.1 → 41.4.0

package/dist/types/config.d.ts

@@ -0,0 +1,167 @@
+/**
+ * @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
+ */
+/**
+ * Handles a configuration dictionary.
+ *
+ * @typeParam Cfg A type of the configuration dictionary.
+ */
+export default class Config<Cfg> {
+    /**
+     * Store for the whole configuration.
+     */
+    private readonly _config;
+    /**
+     * Creates an instance of the {@link ~Config} class.
+     *
+     * @param configurations The initial configurations to be set. Usually, provided by the user.
+     * @param defaultConfigurations The default configurations. Usually, provided by the system.
+     */
+    constructor(configurations?: Partial<Cfg>, defaultConfigurations?: Partial<Cfg>);
+    /**
+     * Set configuration values.
+     *
+     * It also accepts setting a "deep configuration" by using dots in the name. For example, `'resize.width'` sets
+     * the value for the `width` configuration in the `resize` subset.
+     *
+     * ```ts
+     * config.set( 'resize.width', 500 );
+     * ```
+     *
+     * It accepts both a name/value pair or an object, which properties and values will be used to set
+     * configurations. See {@link #set:CONFIG_OBJECT}.
+     *
+     * @label KEY_VALUE
+     * @param name The configuration name. Configuration names are case-sensitive.
+     * @param value The configuration value.
+     */
+    set<K extends string>(name: K, value: GetSubConfig<Cfg, K>): void;
+    /**
+     * Set configuration values.
+     *
+     * It accepts an object, which properties and values will be used to set configurations.
+     *
+     * ```ts
+     * config.set( {
+     * 	width: 500
+     * 	toolbar: {
+     * 		collapsed: true
+     * 	}
+     * } );
+     *
+     * // Equivalent to:
+     * config.set( 'width', 500 );
+     * config.set( 'toolbar.collapsed', true );
+     * ```
+     *
+     * Passing an object as the value will amend the configuration, not replace it.
+     *
+     * ```ts
+     * config.set( 'toolbar', {
+     * 	collapsed: true,
+     * } );
+     *
+     * config.set( 'toolbar', {
+     * 	color: 'red',
+     * } );
+     *
+     * config.get( 'toolbar.collapsed' ); // true
+     * config.get( 'toolbar.color' ); // 'red'
+     * ```
+     *
+     * It accepts both a name/value pair or an object, which properties and values will be used to set
+     * configurations. See {@link #set:KEY_VALUE}.
+     *
+     * @label CONFIG_OBJECT
+     * @param config The configuration object from which take properties as
+     * configuration entries. Configuration names are case-sensitive.
+     */
+    set(config: Partial<Cfg>): void;
+    /**
+     * Does exactly the same as {@link #set:KEY_VALUE} with one exception – passed configuration extends
+     * existing one, but does not overwrite already defined values.
+     *
+     * This method is supposed to be called by plugin developers to setup plugin's configurations. It would be
+     * rarely used for other needs.
+     *
+     * @label KEY_VALUE
+     * @param name The configuration name. Configuration names are case-sensitive.
+     * @param value The configuration value.
+     */
+    define<K extends string>(name: K, value: GetSubConfig<Cfg, K>): void;
+    /**
+     * Does exactly the same as {@link #set:CONFIG_OBJECT} with one exception – passed configuration extends
+     * existing one, but does not overwrite already defined values.
+     *
+     * This method is supposed to be called by plugin developers to setup plugin's configurations. It would be
+     * rarely used for other needs.
+     *
+     * @label CONFIG_OBJECT
+     * @param config The configuration object from which take properties as
+     * configuration entries. Configuration names are case-sensitive.
+     */
+    define(config: Partial<Cfg>): void;
+    /**
+     * Gets the value for a configuration entry.
+     *
+     * ```ts
+     * config.get( 'name' );
+     * ```
+     *
+     * Deep configurations can be retrieved by separating each part with a dot.
+     *
+     * ```ts
+     * config.get( 'toolbar.collapsed' );
+     * ```
+     *
+     * @param name The configuration name. Configuration names are case-sensitive.
+     * @returns The configuration value or `undefined` if the configuration entry was not found.
+     */
+    get<K extends string>(name: K): GetSubConfig<Cfg, K> | undefined;
+    /**
+     * Iterates over all top level configuration names.
+     */
+    names(): Iterable<string>;
+    /**
+     * Saves passed configuration to the specified target (nested object).
+     *
+     * @param target Nested config object.
+     * @param name The configuration name or an object from which take properties as
+     * configuration entries. Configuration names are case-sensitive.
+     * @param value The configuration value. Used if a name is passed.
+     * @param isDefine Define if passed configuration should overwrite existing one.
+     */
+    private _setToTarget;
+    /**
+     * Get specified configuration from specified source (nested object).
+     *
+     * @param source level of nested object.
+     * @param name The configuration name. Configuration names are case-sensitive.
+     * @returns The configuration value or `undefined` if the configuration entry was not found.
+     */
+    private _getFromSource;
+    /**
+     * Iterates through passed object and calls {@link #_setToTarget} method with object key and value for each property.
+     *
+     * @param target Nested config object.
+     * @param configuration Configuration data set
+     * @param isDefine Defines if passed configuration is default configuration or not.
+     */
+    private _setObjectToTarget;
+}
+/**
+ * An utility type excluding primitive values and arrays from the union.
+ */
+export type OnlyObject<T> = Exclude<T, undefined | null | string | number | boolean | Array<any>>;
+/**
+ * An utility type extracting configuration value from the given name.
+ *
+ * @typeParam T The type of a configuration dictionary.
+ * @typeParam K The literal type of configuration name (dot-separated path).
+ */
+export type GetSubConfig<T, K> = K extends keyof T ? T[K] : K extends `${infer K1}.${infer K2}` ? K1 extends keyof T ? GetSubConfig<OnlyObject<T[K1]>, K2> : unknown : unknown;

package/dist/types/count.d.ts

@@ -0,0 +1,22 @@
+/**
+ * @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/count
+ */
+/**
+ * Returns the number of items return by the iterator.
+ *
+ * ```ts
+ * count( [ 1, 2, 3, 4, 5 ] ); // 5;
+ * ```
+ *
+ * @param iterable Any iterable.
+ * @returns Number of items returned by that iterable.
+ */
+export default function count(iterable: Iterable<unknown>): number;

package/dist/types/delay.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @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/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/dist/types/diff.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @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 the difference between two arrays or strings producing an array containing a list of changes
+ * necessary to transform input into output.
+ *
+ * ```ts
+ * diff( 'aba', 'acca' ); // [ 'equal', 'insert', 'insert', 'delete', 'equal' ]
+ * ```
+ *
+ * This function is based on the "O(NP) Sequence Comparison Algorithm" by Sun Wu, Udi Manber, Gene Myers, Webb Miller.
+ * Unfortunately, while it gives the most precise results, its to complex for longer strings/arrow (above 200 items).
+ * Therefore, `diff()` automatically switches to {@link module:utils/fastdiff~fastDiff `fastDiff()`} when detecting
+ * such a scenario. The return formats of both functions are identical.
+ *
+ * @param a Input array or string.
+ * @param b Output array or string.
+ * @param cmp Optional function used to compare array values, by default === is used.
+ * @returns Array of changes.
+ */
+declare function diff<T>(a: ArrayLike<T>, b: ArrayLike<T>, cmp?: (a: T, b: T) => boolean): Array<DiffResult>;
+declare namespace diff {
+    var fastDiff: typeof import("./fastdiff.js").default;
+}
+export default diff;
+/**
+ * The element of the result of {@link module:utils/diff~diff} function.
+ */
+export type DiffResult = 'equal' | 'insert' | 'delete';

package/dist/types/difftochanges.d.ts

@@ -0,0 +1,63 @@
+/**
+ * @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';
+/**
+ * @module utils/difftochanges
+ */
+/**
+ * Creates a set of changes which need to be applied to the input in order to transform
+ * it into the output. This function can be used with strings or arrays.
+ *
+ * ```ts
+ * const input = Array.from( 'abc' );
+ * const output = Array.from( 'xaby' );
+ * const changes = diffToChanges( diff( input, output ), output );
+ *
+ * changes.forEach( change => {
+ * 	if ( change.type == 'insert' ) {
+ * 		input.splice( change.index, 0, ...change.values );
+ * 	} else if ( change.type == 'delete' ) {
+ * 		input.splice( change.index, change.howMany );
+ * 	}
+ * } );
+ *
+ * input.join( '' ) == output.join( '' ); // -> true
+ * ```
+ *
+ * @typeParam T The type of output array element.
+ * @param diff Result of {@link module:utils/diff~diff}.
+ * @param output The string or array which was passed as diff's output.
+ * @returns Set of changes (insert or delete) which need to be applied to the input
+ * in order to transform it into the output.
+ */
+export default function diffToChanges<T>(diff: ReadonlyArray<DiffResult>, output: ArrayLike<T>): Array<Change<T>>;
+/**
+ * An object describing insertion change.
+ *
+ * @typeParam T The type of output array element.
+ */
+export interface InsertChange<T> {
+    type: 'insert';
+    index: number;
+    values: Array<T>;
+}
+/**
+ * An object describing deletion change.
+ */
+export interface DeleteChange {
+    type: 'delete';
+    index: number;
+    howMany: number;
+}
+/**
+ * The element of the result of {@link module:utils/difftochanges~diffToChanges} function.
+ *
+ * @typeParam T The type of output array element.
+ */
+export type Change<T> = InsertChange<T> | DeleteChange;

package/dist/types/dom/createelement.d.ts

@@ -0,0 +1,61 @@
+/**
+ * @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
+ */
+/**
+ * Attributes to be applied to the HTML element.
+ */
+type HTMLElementAttributes = {
+    readonly [key: string]: string;
+};
+/**
+ * Attributes to be applied to the SVG element.
+ */
+type SVGElementAttributes = HTMLElementAttributes & {
+    xmlns: string;
+};
+/**
+ * Element or elements that will be added to the created element as children. Strings will be automatically turned into Text nodes.
+ */
+type ChildrenElements = Node | string | Iterable<Node | string>;
+/**
+ * Creates an SVG element with attributes and children elements.
+ *
+ * ```ts
+ * createElement( document, 'mask', { xmlns: 'http://www.w3.org/2000/svg' } ); // <mask>
+ * createElement( document, 'mask', { xmlns: 'http://www.w3.org/2000/svg', id: 'foo' } ); // <mask id="foo">
+ * createElement( document, 'mask', { xmlns: 'http://www.w3.org/2000/svg' }, 'foo' ); // <mask>foo</mask>
+ * createElement( document, 'mask', { xmlns: 'http://www.w3.org/2000/svg' }, [ createElement(...) ] ); // <mask><...></mask>
+ * ```
+ *
+ * @label SVG_ELEMENT
+ * @param doc Document used to create the element.
+ * @param name Name of the SVG element.
+ * @param attributes Object where keys represent attribute keys and values represent attribute values.
+ * @param children Child or any iterable of children. Strings will be automatically turned into Text nodes.
+ * @returns SVG element.
+ */
+export default function createElement<T extends keyof SVGElementTagNameMap>(doc: Document, name: T, attributes: SVGElementAttributes, children?: ChildrenElements): SVGElementTagNameMap[T];
+/**
+ * Creates an HTML element with attributes and children elements.
+ *
+ * ```ts
+ * createElement( document, 'p' ); // <p>
+ * createElement( document, 'p', { class: 'foo' } ); // <p class="foo">
+ * createElement( document, 'p', null, 'foo' ); // <p>foo</p>
+ * createElement( document, 'p', null, [ createElement(...) ] ); // <p><...></p>
+ * ```
+ *
+ * @label HTML_ELEMENT
+ * @param doc Document used to create the element.
+ * @param name Name of the HTML element.
+ * @param attributes Object where keys represent attribute keys and values represent attribute values.
+ * @param children Child or any iterable of children. Strings will be automatically turned into Text nodes.
+ * @returns HTML element.
+ */
+export default function createElement<T extends keyof HTMLElementTagNameMap>(doc: Document, name: T, attributes?: HTMLElementAttributes, children?: ChildrenElements): HTMLElementTagNameMap[T];
+export {};

package/dist/types/dom/emittermixin.d.ts

@@ -0,0 +1,146 @@
+/**
+ * @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/dom/emittermixin
+ */
+import { type Emitter, type CallbackOptions, type BaseEvent, type GetCallback } from '../emittermixin.js';
+import type EventInfo from '../eventinfo.js';
+import type { Constructor, Mixed } from '../mix.js';
+/**
+ * Mixin that injects the DOM events API into its host. It provides the API
+ * compatible with {@link module:utils/emittermixin~Emitter}.
+ *
+ * This function creates a class that inherits from the provided `base` and implements `Emitter` interface.
+ *
+ * DOM emitter mixin is by default available in the {@link module:ui/view~View} class,
+ * but it can also be mixed into any other class:
+ *
+ * ```ts
+ * import DomEmitterMixin from '../utils/dom/emittermixin.js';
+ *
+ * class BaseClass { ... }
+ *
+ * class SomeView extends DomEmitterMixin( BaseClass ) {}
+ *
+ * const view = new SomeView();
+ * view.listenTo( domElement, ( evt, domEvt ) => {
+ * 	console.log( evt, domEvt );
+ * } );
+ * ```
+ *
+ * @label EXTENDS
+ */
+export default function DomEmitterMixin<Base extends Constructor<Emitter>>(base: Base): Mixed<Base, DomEmitter>;
+/**
+ * Mixin that injects the DOM events API into its host. It provides the API
+ * compatible with {@link module:utils/emittermixin~Emitter}.
+ *
+ * This function creates a class that implements `Emitter` interface.
+ *
+ * DOM emitter mixin is by default available in the {@link module:ui/view~View} class,
+ * but it can also be mixed into any other class:
+ *
+ * ```ts
+ * import DomEmitterMixin from '../utils/dom/emittermixin.js';
+ *
+ * class SomeView extends DomEmitterMixin() {}
+ *
+ * const view = new SomeView();
+ * view.listenTo( domElement, ( evt, domEvt ) => {
+ * 	console.log( evt, domEvt );
+ * } );
+ * ```
+ *
+ * @label NO_ARGUMENTS
+ */
+export default function DomEmitterMixin(): {
+    new (): DomEmitter;
+    prototype: DomEmitter;
+};
+export interface DomEventMap extends HTMLElementEventMap, WindowEventMap {
+}
+/**
+ * Interface representing classes which mix in {@link module:utils/dom/emittermixin~DomEmitterMixin}.
+ *
+ * Can be easily implemented by a class by mixing the {@link module:utils/dom/emittermixin~DomEmitterMixin} mixin.
+ *
+ * ```ts
+ * class MyClass extends DomEmitterMixin( OtherBaseClass ) {
+ * 	// This class now implements the `Emitter` interface.
+ * }
+ * ```
+ */
+export interface DomEmitter extends Emitter {
+    /**
+     * Registers a callback function to be executed when an event is fired in a specific Emitter or DOM Node.
+     * It is backwards compatible with {@link module:utils/emittermixin~Emitter#listenTo}.
+     *
+     * @label HTML_EMITTER
+     * @param emitter The object that fires the event.
+     * @param event The name of the event.
+     * @param callback The function to be called on event.
+     * @param options Additional options.
+     * @param options.useCapture Indicates that events of this type will be dispatched to the registered
+     * listener before being dispatched to any EventTarget beneath it in the DOM tree.
+     * @param options.usePassive Indicates that the function specified by listener will never call preventDefault()
+     * and prevents blocking browser's main thread by this event handler.
+     */
+    listenTo<K extends keyof DomEventMap>(emitter: Node | Window, event: K, callback: (this: this, ev: EventInfo, event: DomEventMap[K]) => void, options?: CallbackOptions & {
+        readonly useCapture?: boolean;
+        readonly usePassive?: boolean;
+    }): void;
+    /**
+     * Registers a callback function to be executed when an event is fired in a specific (emitter) object.
+     *
+     * Events can be grouped in namespaces using `:`.
+     * When namespaced event is fired, it additionally fires all callbacks for that namespace.
+     *
+     * ```ts
+     * // myEmitter.on( ... ) is a shorthand for myEmitter.listenTo( myEmitter, ... ).
+     * myEmitter.on( 'myGroup', genericCallback );
+     * myEmitter.on( 'myGroup:myEvent', specificCallback );
+     *
+     * // genericCallback is fired.
+     * myEmitter.fire( 'myGroup' );
+     * // both genericCallback and specificCallback are fired.
+     * myEmitter.fire( 'myGroup:myEvent' );
+     * // genericCallback is fired even though there are no callbacks for "foo".
+     * myEmitter.fire( 'myGroup:foo' );
+     * ```
+     *
+     * An event callback can {@link module:utils/eventinfo~EventInfo#stop stop the event} and
+     * set the {@link module:utils/eventinfo~EventInfo#return return value} of the {@link #fire} method.
+     *
+     * @label DOM_EMITTER
+     * @typeParam TEvent The type describing the event. See {@link module:utils/emittermixin~BaseEvent}.
+     * @param emitter The object that fires the event.
+     * @param event The name of the event.
+     * @param callback The function to be called on event.
+     * @param options Additional options.
+     */
+    listenTo<TEvent extends BaseEvent>(emitter: Emitter, event: TEvent['name'], callback: GetCallback<TEvent>, options?: CallbackOptions): void;
+    /**
+     * Stops listening for events. It can be used at different levels:
+     * It is backwards compatible with {@link module:utils/emittermixin~Emitter#listenTo}.
+     *
+     * * To stop listening to a specific callback.
+     * * To stop listening to a specific event.
+     * * To stop listening to all events fired by a specific object.
+     * * To stop listening to all events fired by all objects.
+     *
+     * @label DOM_STOP
+     * @param emitter The object to stop listening to.
+     * If omitted, stops it for all objects.
+     * @param event (Requires the `emitter`) The name of the event to stop listening to. If omitted, stops it
+     * for all events from `emitter`.
+     * @param callback (Requires the `event`) The function to be removed from the call list for the given
+     * `event`.
+     */
+    stopListening(emitter?: Emitter | Node | Window, event?: string, callback?: Function): void;
+}

package/dist/types/dom/findclosestscrollableancestor.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
+ */
+/**
+ * Returns the closest scrollable ancestor of a DOM element.
+ *
+ * @param domElement DOM element.
+ * @returns First ancestor of `domElement` that is scrollable or null if such ancestor doesn't exist.
+ */
+export default function findClosestScrollableAncestor(domElement: HTMLElement): HTMLElement | null;

package/dist/types/dom/getancestors.d.ts

@@ -0,0 +1,21 @@
+/**
+ * @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/dom/getancestors
+ */
+/**
+ * Returns all ancestors of given DOM node, starting from the top-most (root). Includes the given node itself. If the
+ * node is a part of `DocumentFragment` that `DocumentFragment` will be returned. In contrary, if the node is
+ * appended to a `Document`, that `Document` will not be returned (algorithms operating on DOM tree care for `Document#documentElement`
+ * at most, which will be returned).
+ *
+ * @param node DOM node.
+ * @returns Array of given `node` parents.
+ */
+export default function getAncestors(node: Node): Array<Node>;

package/dist/types/dom/getborderwidths.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @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/dom/getborderwidths
+ */
+/**
+ * Returns an object containing CSS border widths of a specified HTML element.
+ *
+ * @param element An element which has CSS borders.
+ * @returns An object containing `top`, `left`, `right` and `bottom` properties
+ * with numerical values of the `border-[top,left,right,bottom]-width` CSS styles.
+ */
+export default function getBorderWidths(element: HTMLElement): BorderWidths;
+/**
+ * An object describing widths of `HTMLElement` borders.
+*/
+export interface BorderWidths {
+    top: number;
+    right: number;
+    bottom: number;
+    left: number;
+}

package/dist/types/dom/getcommonancestor.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @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
+ */
+/**
+ * Searches and returns the lowest common ancestor of two given nodes.
+ *
+ * @param nodeA First node.
+ * @param nodeB Second node.
+ * @returns Lowest common ancestor of both nodes or `null` if nodes do not have a common ancestor.
+ */
+export default function getCommonAncestor(nodeA: Node, nodeB: Node): Node | null;

package/dist/types/dom/getdatafromelement.d.ts

@@ -0,0 +1,18 @@
+/**
+ * @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/dom/getdatafromelement
+ */
+/**
+ * Gets data from a given source element.
+ *
+ * @param el The element from which the data will be retrieved.
+ * @returns The data string.
+ */
+export default function getDataFromElement(el: HTMLElement): string;

package/dist/types/dom/getpositionedancestor.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @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
+ */
+/**
+ * For a given element, returns the nearest ancestor element which CSS position is not "static".
+ *
+ * @param element The native DOM element to be checked.
+ */
+export default function getPositionedAncestor(element?: HTMLElement): HTMLElement | null;

package/dist/types/dom/global.d.ts

@@ -0,0 +1,36 @@
+/**
+ * @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/dom/global
+ */
+/**
+ * A helper (module) giving an access to the global DOM objects such as `window` and `document`.
+ */
+export interface GlobalType {
+    readonly window: Window & typeof globalThis;
+    readonly document: Document;
+}
+/**
+ * A helper (module) giving an access to the global DOM objects such as `window` and
+ * `document`. Accessing these objects using this helper allows easy and bulletproof
+ * testing, i.e. stubbing native properties:
+ *
+ * ```ts
+ * import { global } from 'ckeditor5/utils';
+ *
+ * // This stub will work for any code using global module.
+ * testUtils.sinon.stub( global, 'window', {
+ * 	innerWidth: 10000
+ * } );
+ *
+ * console.log( global.window.innerWidth );
+ * ```
+ */
+declare let globalVar: GlobalType;
+export default globalVar;