happy-dom 5.3.3 → 6.0.0

package/lib/nodes/node/NodeUtility.js

@@ -0,0 +1,123 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const NodeTypeEnum_1 = __importDefault(require("./NodeTypeEnum"));
+/**
+ * Node utility.
+ */
+class NodeUtility {
+    /**
+     * Returns boolean indicating if nodeB is an inclusive ancestor of nodeA.
+     *
+     * Based on:
+     * https://github.com/jsdom/jsdom/blob/master/lib/jsdom/living/helpers/node.js
+     *
+     * @see https://dom.spec.whatwg.org/#concept-tree-inclusive-ancestor
+     * @param ancestorNode Ancestor node.
+     * @param referenceNode Reference node.
+     * @returns "true" if following.
+     */
+    static isInclusiveAncestor(ancestorNode, referenceNode) {
+        let parent = referenceNode;
+        while (parent) {
+            if (ancestorNode === parent) {
+                return true;
+            }
+            parent = parent.parentNode;
+        }
+        return false;
+    }
+    /**
+     * Returns boolean indicating if nodeB is following nodeA in the document tree.
+     *
+     * Based on:
+     * https://github.com/jsdom/jsdom/blob/master/lib/jsdom/living/helpers/node.js
+     *
+     * @see https://dom.spec.whatwg.org/#concept-tree-following
+     * @param nodeA Node A.
+     * @param nodeB Node B.
+     * @returns "true" if following.
+     */
+    static isFollowing(nodeA, nodeB) {
+        if (nodeA === nodeB) {
+            return false;
+        }
+        let current = nodeB;
+        while (current) {
+            current = this.following(current);
+            if (current === nodeA) {
+                return true;
+            }
+        }
+        return false;
+    }
+    /**
+     * Node length.
+     *
+     * Based on:
+     * https://github.com/jsdom/jsdom/blob/master/lib/jsdom/living/helpers/node.js
+     *
+     * @see https://dom.spec.whatwg.org/#concept-node-length
+     * @param node Node.
+     * @returns Node length.
+     */
+    static getNodeLength(node) {
+        switch (node.nodeType) {
+            case NodeTypeEnum_1.default.documentTypeNode:
+                return 0;
+            case NodeTypeEnum_1.default.textNode:
+            case NodeTypeEnum_1.default.processingInstructionNode:
+            case NodeTypeEnum_1.default.commentNode:
+                return node.data.length;
+            default:
+                return node.childNodes.length;
+        }
+    }
+    /**
+     * Returns boolean indicating if nodeB is following nodeA in the document tree.
+     *
+     * Based on:
+     * https://github.com/jsdom/js-symbol-tree/blob/master/lib/SymbolTree.js#L220
+     *
+     * @param node Node.
+     * @param [root] Root.
+     * @returns Following node.
+     */
+    static following(node, root) {
+        const firstChild = node.firstChild;
+        if (firstChild) {
+            return firstChild;
+        }
+        let current = node;
+        while (current) {
+            if (current === root) {
+                return null;
+            }
+            const nextSibling = current.nextSibling;
+            if (nextSibling) {
+                return nextSibling;
+            }
+            current = current.parentNode;
+        }
+        return null;
+    }
+    /**
+     * Returns the next sibling or parents sibling.
+     *
+     * @param node Node.
+     * @returns Next decentant node.
+     */
+    static nextDecendantNode(node) {
+        while (node && !node.nextSibling) {
+            node = node.parentNode;
+        }
+        if (!node) {
+            return null;
+        }
+        return node.nextSibling;
+    }
+}
+exports.default = NodeUtility;
+//# sourceMappingURL=NodeUtility.js.map

package/lib/nodes/node/NodeUtility.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"NodeUtility.js","sourceRoot":"","sources":["../../../src/nodes/node/NodeUtility.ts"],"names":[],"mappings":";;;;;AAGA,kEAA0C;AAE1C;;GAEG;AACH,MAAqB,WAAW;IAC/B;;;;;;;;;;OAUG;IACI,MAAM,CAAC,mBAAmB,CAAC,YAAmB,EAAE,aAAoB;QAC1E,IAAI,MAAM,GAAU,aAAa,CAAC;QAClC,OAAO,MAAM,EAAE;YACd,IAAI,YAAY,KAAK,MAAM,EAAE;gBAC5B,OAAO,IAAI,CAAC;aACZ;YACD,MAAM,GAAG,MAAM,CAAC,UAAU,CAAC;SAC3B;QACD,OAAO,KAAK,CAAC;IACd,CAAC;IAED;;;;;;;;;;OAUG;IACI,MAAM,CAAC,WAAW,CAAC,KAAY,EAAE,KAAY;QACnD,IAAI,KAAK,KAAK,KAAK,EAAE;YACpB,OAAO,KAAK,CAAC;SACb;QAED,IAAI,OAAO,GAAU,KAAK,CAAC;QAE3B,OAAO,OAAO,EAAE;YACf,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;YAElC,IAAI,OAAO,KAAK,KAAK,EAAE;gBACtB,OAAO,IAAI,CAAC;aACZ;SACD;QAED,OAAO,KAAK,CAAC;IACd,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,aAAa,CAAC,IAAW;QACtC,QAAQ,IAAI,CAAC,QAAQ,EAAE;YACtB,KAAK,sBAAY,CAAC,gBAAgB;gBACjC,OAAO,CAAC,CAAC;YAEV,KAAK,sBAAY,CAAC,QAAQ,CAAC;YAC3B,KAAK,sBAAY,CAAC,yBAAyB,CAAC;YAC5C,KAAK,sBAAY,CAAC,WAAW;gBAC5B,OAA0B,IAAK,CAAC,IAAI,CAAC,MAAM,CAAC;YAE7C;gBACC,OAAO,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;SAC/B;IACF,CAAC;IAED;;;;;;;;;OASG;IACI,MAAM,CAAC,SAAS,CAAC,IAAW,EAAE,IAAY;QAChD,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC;QAEnC,IAAI,UAAU,EAAE;YACf,OAAO,UAAU,CAAC;SAClB;QAED,IAAI,OAAO,GAAG,IAAI,CAAC;QAEnB,OAAO,OAAO,EAAE;YACf,IAAI,OAAO,KAAK,IAAI,EAAE;gBACrB,OAAO,IAAI,CAAC;aACZ;YAED,MAAM,WAAW,GAAG,OAAO,CAAC,WAAW,CAAC;YAExC,IAAI,WAAW,EAAE;gBAChB,OAAO,WAAW,CAAC;aACnB;YAED,OAAO,GAAG,OAAO,CAAC,UAAU,CAAC;SAC7B;QAED,OAAO,IAAI,CAAC;IACb,CAAC;IAED;;;;;OAKG;IACI,MAAM,CAAC,iBAAiB,CAAC,IAAW;QAC1C,OAAO,IAAI,IAAI,CAAC,IAAI,CAAC,WAAW,EAAE;YACjC,IAAI,GAAG,IAAI,CAAC,UAAU,CAAC;SACvB;QAED,IAAI,CAAC,IAAI,EAAE;YACV,OAAO,IAAI,CAAC;SACZ;QAED,OAAO,IAAI,CAAC,WAAW,CAAC;IACzB,CAAC;CACD;AAlID,8BAkIC"}

package/lib/nodes/text/IText.d.ts

@@ -1,5 +1,14 @@
 import ICharacterData from '../character-data/ICharacterData';
 export default interface IText extends ICharacterData {
+    /**
+     * Breaks the Text node into two nodes at the specified offset, keeping both nodes in the tree as siblings.
+     *
+     * @see https://dom.spec.whatwg.org/#dom-text-splittext
+     * @see https://dom.spec.whatwg.org/#dom-text-splittext
+     * @param offset Offset.
+     * @returns New text node.
+     */
+    splitText(offset: number): IText;
     /**
      * Clones a node.
      *

package/lib/nodes/text/Text.d.ts

@@ -4,13 +4,22 @@ import IText from './IText';
  * Text node.
  */
 export default class Text extends CharacterData implements IText {
-    readonly nodeType = 3;
+    readonly nodeType = NodeTypeEnum.textNode;
     /**
      * Node name.
      *
      * @returns Node name.
      */
     get nodeName(): string;
+    /**
+     * Breaks the Text node into two nodes at the specified offset, keeping both nodes in the tree as siblings.
+     *
+     * @see https://dom.spec.whatwg.org/#dom-text-splittext
+     * @see https://dom.spec.whatwg.org/#dom-text-splittext
+     * @param offset Offset.
+     * @returns New text node.
+     */
+    splitText(offset: number): IText;
     /**
      * Converts to string.
      *

package/lib/nodes/text/Text.js

@@ -5,6 +5,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 const Node_1 = __importDefault(require("../node/Node"));
 const CharacterData_1 = __importDefault(require("../character-data/CharacterData"));
+const DOMException_1 = __importDefault(require("../../exception/DOMException"));
+const DOMExceptionNameEnum_1 = __importDefault(require("../../exception/DOMExceptionNameEnum"));
 /**
  * Text node.
  */
@@ -21,6 +23,28 @@ class Text extends CharacterData_1.default {
     get nodeName() {
         return '#text';
     }
+    /**
+     * Breaks the Text node into two nodes at the specified offset, keeping both nodes in the tree as siblings.
+     *
+     * @see https://dom.spec.whatwg.org/#dom-text-splittext
+     * @see https://dom.spec.whatwg.org/#dom-text-splittext
+     * @param offset Offset.
+     * @returns New text node.
+     */
+    splitText(offset) {
+        const length = this._data.length;
+        if (offset > length) {
+            new DOMException_1.default('The index is not in the allowed range.', DOMExceptionNameEnum_1.default.indexSizeError);
+        }
+        const count = length - offset;
+        const newData = this.substringData(offset, count);
+        const newNode = this.ownerDocument.createTextNode(newData);
+        if (this.parentNode !== null) {
+            this.parentNode.insertBefore(newNode, this.nextSibling);
+        }
+        this.replaceData(offset, count, '');
+        return newNode;
+    }
     /**
      * Converts to string.
      *

package/lib/nodes/text/Text.js.map

@@ -1 +1 @@
-{"version":3,"file":"Text.js","sourceRoot":"","sources":["../../../src/nodes/text/Text.ts"],"names":[],"mappings":";;;;;AAAA,wDAAgC;AAChC,oFAA4D;AAG5D;;GAEG;AACH,MAAqB,IAAK,SAAQ,uBAAa;IAA/C;;QACiB,aAAQ,GAAG,cAAI,CAAC,SAAS,CAAC;IA8B3C,CAAC;IA5BA;;;;OAIG;IACH,IAAW,QAAQ;QAClB,OAAO,OAAO,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACI,QAAQ;QACd,OAAO,eAAe,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACI,SAAS,CAAC,IAAI,GAAG,KAAK;QAC5B,OAAa,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;CACD;AA/BD,uBA+BC"}
+{"version":3,"file":"Text.js","sourceRoot":"","sources":["../../../src/nodes/text/Text.ts"],"names":[],"mappings":";;;;;AAAA,wDAAgC;AAChC,oFAA4D;AAE5D,gFAAwD;AACxD,gGAAwE;AAExE;;GAEG;AACH,MAAqB,IAAK,SAAQ,uBAAa;IAA/C;;QACiB,aAAQ,GAAG,cAAI,CAAC,SAAS,CAAC;IA6D3C,CAAC;IA3DA;;;;OAIG;IACH,IAAW,QAAQ;QAClB,OAAO,OAAO,CAAC;IAChB,CAAC;IAED;;;;;;;OAOG;IACI,SAAS,CAAC,MAAc;QAC9B,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;QAEjC,IAAI,MAAM,GAAG,MAAM,EAAE;YACpB,IAAI,sBAAY,CACf,wCAAwC,EACxC,8BAAoB,CAAC,cAAc,CACnC,CAAC;SACF;QAED,MAAM,KAAK,GAAG,MAAM,GAAG,MAAM,CAAC;QAC9B,MAAM,OAAO,GAAG,IAAI,CAAC,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QAClD,MAAM,OAAO,GAAU,IAAI,CAAC,aAAa,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;QAElE,IAAI,IAAI,CAAC,UAAU,KAAK,IAAI,EAAE;YAC7B,IAAI,CAAC,UAAU,CAAC,YAAY,CAAC,OAAO,EAAE,IAAI,CAAC,WAAW,CAAC,CAAC;SACxD;QAED,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE,CAAC,CAAC;QAEpC,OAAO,OAAO,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACI,QAAQ;QACd,OAAO,eAAe,CAAC;IACxB,CAAC;IAED;;;;;;OAMG;IACI,SAAS,CAAC,IAAI,GAAG,KAAK;QAC5B,OAAa,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;CACD;AA9DD,uBA8DC"}

package/lib/range/IRangeBoundaryPoint.d.ts

@@ -0,0 +1,8 @@
+import INode from '../nodes/node/INode';
+/**
+ * Range boundary point.
+ */
+export default interface IRangeBoundaryPoint {
+    node: INode;
+    offset: number;
+}

package/lib/range/IRangeBoundaryPoint.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IRangeBoundaryPoint.js.map

package/lib/range/IRangeBoundaryPoint.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IRangeBoundaryPoint.js","sourceRoot":"","sources":["../../src/range/IRangeBoundaryPoint.ts"],"names":[],"mappings":""}

package/lib/range/Range.d.ts

@@ -0,0 +1,249 @@
+import INode from '../nodes/node/INode';
+import IDocument from '../nodes/document/IDocument';
+import IDocumentFragment from '../nodes/document-fragment/IDocumentFragment';
+import DOMRect from '../nodes/element/DOMRect';
+import RangeHowEnum from './RangeHowEnum';
+import IDOMRectList from '../nodes/element/IDOMRectList';
+import IRangeBoundaryPoint from './IRangeBoundaryPoint';
+/**
+ * Range.
+ *
+ * Based on logic from:
+ * https://github.com/jsdom/jsdom/blob/master/lib/jsdom/living/range/Range-impl.js
+ *
+ * Reference:
+ * https://developer.mozilla.org/en-US/docs/Web/API/Range.
+ */
+export default class Range {
+    static _ownerDocument: IDocument;
+    static readonly END_TO_END: number;
+    static readonly END_TO_START: number;
+    static readonly START_TO_END: number;
+    static readonly START_TO_START: number;
+    readonly END_TO_END: number;
+    readonly END_TO_START: number;
+    readonly START_TO_END: number;
+    readonly START_TO_START: number;
+    readonly _ownerDocument: IDocument;
+    _start: IRangeBoundaryPoint;
+    _end: IRangeBoundaryPoint;
+    /**
+     * Constructor.
+     */
+    constructor();
+    /**
+     * Returns start container.
+     *
+     * @see https://dom.spec.whatwg.org/#dom-range-startcontainer
+     * @returns Start container.
+     */
+    get startContainer(): INode;
+    /**
+     * Returns end container.
+     *
+     * @see https://dom.spec.whatwg.org/#dom-range-endcontainer
+     * @returns End container.
+     */
+    get endContainer(): INode;
+    /**
+     * Returns start offset.
+     *
+     * @see https://dom.spec.whatwg.org/#dom-range-startoffset
+     * @returns Start offset.
+     */
+    get startOffset(): number;
+    /**
+     * Returns end offset.
+     *
+     * @see https://dom.spec.whatwg.org/#dom-range-endoffset
+     * @returns End offset.
+     */
+    get endOffset(): number;
+    /**
+     * Returns a boolean value indicating whether the range's start and end points are at the same position.
+     *
+     * @see https://dom.spec.whatwg.org/#dom-range-collapsed
+     * @returns Collapsed.
+     */
+    get collapsed(): boolean;
+    /**
+     * Returns the deepest Node that contains the startContainer and endContainer nodes.
+     *
+     * @see https://dom.spec.whatwg.org/#dom-range-commonancestorcontainer
+     * @returns Node.
+     */
+    get commonAncestorContainer(): INode;
+    /**
+     * Returns -1, 0, or 1 depending on whether the referenceNode is before, the same as, or after the Range.
+     *
+     * @see https://dom.spec.whatwg.org/#dom-range-collapse
+     * @param toStart A boolean value: true collapses the Range to its start, false to its end. If omitted, it defaults to false.
+     */
+    collapse(toStart?: boolean): void;
+    /**
+     * Compares the boundary points of the Range with those of another range.
+     *
+     * @see https://dom.spec.whatwg.org/#dom-range-compareboundarypoints
+     * @param how How.
+     * @param sourceRange Range.
+     * @returns A number, -1, 0, or 1, indicating whether the corresponding boundary-point of the Range is respectively before, equal to, or after the corresponding boundary-point of sourceRange.
+     */
+    compareBoundaryPoints(how: RangeHowEnum, sourceRange: Range): number;
+    /**
+     * Returns -1, 0, or 1 depending on whether the referenceNode is before, the same as, or after the Range.
+     *
+     * @see https://dom.spec.whatwg.org/#dom-range-comparepoint
+     * @param node Reference node.
+     * @param offset Offset.
+     * @returns -1,0, or 1.
+     */
+    comparePoint(node: INode, offset: any): number;
+    /**
+     * Returns a DocumentFragment copying the objects of type Node included in the Range.
+     *
+     * @see https://dom.spec.whatwg.org/#concept-range-clone
+     * @returns Document fragment.
+     */
+    cloneContents(): IDocumentFragment;
+    /**
+     * Returns a Range object with boundary points identical to the cloned Range.
+     *
+     * @see https://dom.spec.whatwg.org/#dom-range-clonerange
+     * @returns Range.
+     */
+    cloneRange(): Range;
+    /**
+     * Returns a DocumentFragment by invoking the HTML fragment parsing algorithm or the XML fragment parsing algorithm with the start of the range (the parent of the selected node) as the context node. The HTML fragment parsing algorithm is used if the range belongs to a Document whose HTMLness bit is set. In the HTML case, if the context node would be html, for historical reasons the fragment parsing algorithm is invoked with body as the context instead.
+     *
+     * @see https://w3c.github.io/DOM-Parsing/#dfn-fragment-parsing-algorithm
+     * @param tagString Tag string.
+     * @returns Document fragment.
+     */
+    createContextualFragment(tagString: string): IDocumentFragment;
+    /**
+     * Removes the contents of the Range from the Document.
+     *
+     * @see https://dom.spec.whatwg.org/#dom-range-deletecontents
+     */
+    deleteContents(): void;
+    /**
+     * Does nothing. It used to disable the Range object and enable the browser to release associated resources. The method has been kept for compatibility.
+     *
+     * @see https://dom.spec.whatwg.org/#dom-range-detach
+     */
+    detach(): void;
+    /**
+     * Moves contents of the Range from the document tree into a DocumentFragment.
+     *
+     * @see https://dom.spec.whatwg.org/#dom-range-extractcontents
+     * @returns Document fragment.
+     */
+    extractContents(): IDocumentFragment;
+    /**
+     * Returns a DOMRect object that bounds the contents of the range; this is a rectangle enclosing the union of the bounding rectangles for all the elements in the range.
+     *
+     * @returns DOMRect object.
+     */
+    getBoundingClientRect(): DOMRect;
+    /**
+     * The Range.getClientRects() method returns a list of DOMRect objects representing the area of the screen occupied by the range. This is created by aggregating the results of calls to Element.getClientRects() for all the elements in the range.
+     *
+     * @returns DOMRect objects.
+     */
+    getClientRects(): IDOMRectList<DOMRect>;
+    /**
+     * Returns a boolean indicating whether the given point is in the Range.
+     *
+     * @see https://dom.spec.whatwg.org/#dom-range-ispointinrange
+     * @param node Reference node.
+     * @param offset Offset.
+     * @returns "true" if in range.
+     */
+    isPointInRange(node: INode, offset?: number): boolean;
+    /**
+     * Inserts a node at the start of the Range.
+     *
+     * @see https://dom.spec.whatwg.org/#concept-range-insert
+     * @param newNode New node.
+     */
+    insertNode(newNode: INode): void;
+    /**
+     * Returns a boolean indicating whether the given Node intersects the Range.
+     *
+     * @see https://dom.spec.whatwg.org/#dom-range-intersectsnode
+     * @param node Reference node.
+     * @returns "true" if it intersects.
+     */
+    intersectsNode(node: INode): boolean;
+    /**
+     * Sets the Range to contain the Node and its contents.
+     *
+     * @see https://dom.spec.whatwg.org/#concept-range-select
+     * @param node Reference node.
+     */
+    selectNode(node: INode): void;
+    /**
+     * Sets the Range to contain the contents of a Node.
+     *
+     * @see https://dom.spec.whatwg.org/#dom-range-selectnodecontents
+     * @param node Reference node.
+     */
+    selectNodeContents(node: INode): void;
+    /**
+     * Sets the end position of a Range to be located at the given offset into the specified node x.
+     *
+     * @see https://dom.spec.whatwg.org/#dom-range-setend
+     * @param node End node.
+     * @param offset End offset.
+     */
+    setEnd(node: INode, offset?: number): void;
+    /**
+     * Sets the start position of a Range.
+     *
+     * @see https://dom.spec.whatwg.org/#dom-range-setstart
+     * @param node Start node.
+     * @param offset Start offset.
+     */
+    setStart(node: INode, offset?: number): void;
+    /**
+     * Sets the end position of a Range relative to another Node.
+     *
+     * @see https://dom.spec.whatwg.org/#dom-range-setendafter
+     * @param node Reference node.
+     */
+    setEndAfter(node: INode): void;
+    /**
+     * Sets the end position of a Range relative to another Node.
+     *
+     * @see https://dom.spec.whatwg.org/#dom-range-setendbefore
+     * @param node Reference node.
+     */
+    setEndBefore(node: INode): void;
+    /**
+     * Sets the start position of a Range relative to a Node.
+     *
+     * @see https://dom.spec.whatwg.org/#dom-range-setstartafter
+     * @param node Reference node.
+     */
+    setStartAfter(node: INode): void;
+    /**
+     * Sets the start position of a Range relative to another Node.
+     *
+     * @see https://dom.spec.whatwg.org/#dom-range-setstartbefore
+     * @param node Reference node.
+     */
+    setStartBefore(node: INode): void;
+    /**
+     * Moves content of the Range into a new node, placing the new node at the start of the specified range.
+     *
+     * @see https://dom.spec.whatwg.org/#dom-range-surroundcontents
+     * @param newParent New parent.
+     */
+    surroundContents(newParent: INode): void;
+    /**
+     * Returns the text of the Range.
+     *
+     * @see https://dom.spec.whatwg.org/#dom-range-stringifier
+     */
+    toString(): string;
+}