@ckeditor/ckeditor5-utils 40.0.0 → 40.2.0

package/src/dom/getancestors.js

@@ -1,27 +1,27 @@
-/**
- * @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 Node */
-/**
- * @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) {
-    const nodes = [];
-    let currentNode = node;
-    // We are interested in `Node`s `DocumentFragment`s only.
-    while (currentNode && currentNode.nodeType != Node.DOCUMENT_NODE) {
-        nodes.unshift(currentNode);
-        currentNode = currentNode.parentNode;
-    }
-    return nodes;
-}
+/**
+ * @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 Node */
+/**
+ * @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) {
+    const nodes = [];
+    let currentNode = node;
+    // We are interested in `Node`s `DocumentFragment`s only.
+    while (currentNode && currentNode.nodeType != Node.DOCUMENT_NODE) {
+        nodes.unshift(currentNode);
+        currentNode = currentNode.parentNode;
+    }
+    return nodes;
+}

package/src/dom/getborderwidths.d.ts

@@ -1,24 +1,24 @@
-/**
- * @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/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;
-}
+/**
+ * @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/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/src/dom/getborderwidths.js

@@ -1,24 +1,24 @@
-/**
- * @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/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) {
-    // Call getComputedStyle on the window the element document belongs to.
-    const style = element.ownerDocument.defaultView.getComputedStyle(element);
-    return {
-        top: parseInt(style.borderTopWidth, 10),
-        right: parseInt(style.borderRightWidth, 10),
-        bottom: parseInt(style.borderBottomWidth, 10),
-        left: parseInt(style.borderLeftWidth, 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
+ */
+/**
+ * @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) {
+    // Call getComputedStyle on the window the element document belongs to.
+    const style = element.ownerDocument.defaultView.getComputedStyle(element);
+    return {
+        top: parseInt(style.borderTopWidth, 10),
+        right: parseInt(style.borderRightWidth, 10),
+        bottom: parseInt(style.borderBottomWidth, 10),
+        left: parseInt(style.borderLeftWidth, 10)
+    };
+}

package/src/dom/getcommonancestor.d.ts

@@ -1,12 +1,12 @@
-/**
- * @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
- */
-/**
- * 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;
+/**
+ * @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
+ */
+/**
+ * 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/src/dom/getcommonancestor.js

@@ -1,25 +1,25 @@
-/**
- * @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/getcommonancestor
- */
-import getAncestors from './getancestors';
-/**
- * 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, nodeB) {
-    const ancestorsA = getAncestors(nodeA);
-    const ancestorsB = getAncestors(nodeB);
-    let i = 0;
-    // It does not matter which array is shorter.
-    while (ancestorsA[i] == ancestorsB[i] && ancestorsA[i]) {
-        i++;
-    }
-    return i === 0 ? null : ancestorsA[i - 1];
-}
+/**
+ * @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/getcommonancestor
+ */
+import getAncestors from './getancestors';
+/**
+ * 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, nodeB) {
+    const ancestorsA = getAncestors(nodeA);
+    const ancestorsB = getAncestors(nodeB);
+    let i = 0;
+    // It does not matter which array is shorter.
+    while (ancestorsA[i] == ancestorsB[i] && ancestorsA[i]) {
+        i++;
+    }
+    return i === 0 ? null : ancestorsA[i - 1];
+}

package/src/dom/getdatafromelement.d.ts

@@ -1,14 +1,14 @@
-/**
- * @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/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;
+/**
+ * @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/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/src/dom/getdatafromelement.js

@@ -1,20 +1,20 @@
-/**
- * @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 HTMLTextAreaElement */
-/**
- * @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) {
-    if (el instanceof HTMLTextAreaElement) {
-        return el.value;
-    }
-    return el.innerHTML;
-}
+/**
+ * @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 HTMLTextAreaElement */
+/**
+ * @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) {
+    if (el instanceof HTMLTextAreaElement) {
+        return el.value;
+    }
+    return el.innerHTML;
+}

package/src/dom/getpositionedancestor.d.ts

@@ -1,10 +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
- */
-/**
- * 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;
+/**
+ * @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
+ */
+/**
+ * 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/src/dom/getpositionedancestor.js

@@ -1,22 +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/getpositionedancestor
- */
-import global from './global';
-/**
- * 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) {
-    if (!element || !element.parentNode) {
-        return null;
-    }
-    if (element.offsetParent === global.document.body) {
-        return null;
-    }
-    return element.offsetParent;
-}
+/**
+ * @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/getpositionedancestor
+ */
+import global from './global';
+/**
+ * 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) {
+    if (!element || !element.parentNode) {
+        return null;
+    }
+    if (element.offsetParent === global.document.body) {
+        return null;
+    }
+    return element.offsetParent;
+}

package/src/dom/global.d.ts

@@ -1,32 +1,32 @@
-/**
- * @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/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;
+/**
+ * @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/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;

package/src/dom/global.js

@@ -1,35 +1,35 @@
-/**
- * @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
- */
-/**
- * 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 );
- * ```
- */
-let globalVar; // named globalVar instead of global: https://github.com/ckeditor/ckeditor5/issues/12971
-// In some environments window and document API might not be available.
-try {
-    globalVar = { window, document };
-}
-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 -- @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.
-    // This module should not be used on purpose in any environment outside browser.
-    globalVar = { window: {}, document: {} };
-}
-export default globalVar;
+/**
+ * @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
+ */
+/**
+ * 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 );
+ * ```
+ */
+let globalVar; // named globalVar instead of global: https://github.com/ckeditor/ckeditor5/issues/12971
+// In some environments window and document API might not be available.
+try {
+    globalVar = { window, document };
+}
+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 -- @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.
+    // This module should not be used on purpose in any environment outside browser.
+    globalVar = { window: {}, document: {} };
+}
+export default globalVar;

package/src/dom/indexof.d.ts

@@ -1,14 +1,14 @@
-/**
- * @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/indexof
- */
-/**
- * Returns index of the node in the parent element.
- *
- * @param node Node which index is tested.
- * @returns Index of the node in the parent element. Returns 0 if node has no parent.
- */
-export default function indexOf(node: Node): number;
+/**
+ * @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/indexof
+ */
+/**
+ * Returns index of the node in the parent element.
+ *
+ * @param node Node which index is tested.
+ * @returns Index of the node in the parent element. Returns 0 if node has no parent.
+ */
+export default function indexOf(node: Node): number;

package/src/dom/indexof.js

@@ -1,21 +1,21 @@
-/**
- * @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/indexof
- */
-/**
- * Returns index of the node in the parent element.
- *
- * @param node Node which index is tested.
- * @returns Index of the node in the parent element. Returns 0 if node has no parent.
- */
-export default function indexOf(node) {
-    let index = 0;
-    while (node.previousSibling) {
-        node = node.previousSibling;
-        index++;
-    }
-    return index;
-}
+/**
+ * @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/indexof
+ */
+/**
+ * Returns index of the node in the parent element.
+ *
+ * @param node Node which index is tested.
+ * @returns Index of the node in the parent element. Returns 0 if node has no parent.
+ */
+export default function indexOf(node) {
+    let index = 0;
+    while (node.previousSibling) {
+        node = node.previousSibling;
+        index++;
+    }
+    return index;
+}

package/src/dom/insertat.d.ts

@@ -1,15 +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
- */
-/**
- * @module utils/dom/insertat
- */
-/**
- * Inserts node to the parent at given index.
- *
- * @param parentElement Parent element.
- * @param index Insertions index.
- * @param nodeToInsert Node to insert.
- */
-export default function insertAt(parentElement: Element, index: number, nodeToInsert: Node): void;
+/**
+ * @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/insertat
+ */
+/**
+ * Inserts node to the parent at given index.
+ *
+ * @param parentElement Parent element.
+ * @param index Insertions index.
+ * @param nodeToInsert Node to insert.
+ */
+export default function insertAt(parentElement: Element, index: number, nodeToInsert: Node): void;

package/src/dom/insertat.js

@@ -1,17 +1,17 @@
-/**
- * @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/insertat
- */
-/**
- * Inserts node to the parent at given index.
- *
- * @param parentElement Parent element.
- * @param index Insertions index.
- * @param nodeToInsert Node to insert.
- */
-export default function insertAt(parentElement, index, nodeToInsert) {
-    parentElement.insertBefore(nodeToInsert, parentElement.childNodes[index] || null);
-}
+/**
+ * @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/insertat
+ */
+/**
+ * Inserts node to the parent at given index.
+ *
+ * @param parentElement Parent element.
+ * @param index Insertions index.
+ * @param nodeToInsert Node to insert.
+ */
+export default function insertAt(parentElement, index, nodeToInsert) {
+    parentElement.insertBefore(nodeToInsert, parentElement.childNodes[index] || null);
+}