happy-dom 5.3.3 → 6.0.0

package/src/nodes/html-dialog-element/IHTMLDialogElement.ts

@@ -0,0 +1,29 @@
+import IHTMLElement from '../html-element/IHTMLElement';
+
+/**
+ * HTML Dialog Element.
+ *
+ * Reference:
+ * https://developer.mozilla.org/en-US/docs/Web/API/HTMLDialogElement.
+ */
+export default interface IHTMLDialogElement extends IHTMLElement {
+	open: boolean;
+	returnValue: string;
+
+	/**
+	 * Closes the dialog.
+	 *
+	 * @param [returnValue] ReturnValue.
+	 */
+	close(returnValue?: string): void;
+
+	/**
+	 * Shows the modal.
+	 */
+	showModal(): void;
+
+	/**
+	 * Shows the dialog.
+	 */
+	show(): void;
+}

package/src/nodes/html-template-element/HTMLTemplateElement.ts

@@ -1,11 +1,9 @@
-import Node from '../node/Node';
 import HTMLElement from '../html-element/HTMLElement';
 import IDocumentFragment from '../document-fragment/IDocumentFragment';
 import INode from '../node/INode';
 import IHTMLTemplateElement from './IHTMLTemplateElement';
 import XMLParser from '../../xml-parser/XMLParser';
 import XMLSerializer from '../../xml-serializer/XMLSerializer';
-import DOMException from '../../exception/DOMException';
 
 /**
  * HTML Template Element.
@@ -36,34 +34,18 @@ export default class HTMLTemplateElement extends HTMLElement implements IHTMLTem
 		}
 	}
 
-	/**
-	 * @override
-	 */
-	public get outerHTML(): string {
-		return new XMLSerializer().serializeToString(this.content);
-	}
-
-	/**
-	 * @override
-	 */
-	public set outerHTML(_html: string) {
-		throw new DOMException(
-			`Failed to set the 'outerHTML' property on 'Element': This element has no parent node.`
-		);
-	}
-
 	/**
 	 * @override
 	 */
 	public get previousSibling(): INode {
-		return this.content.previousSibling;
+		return null;
 	}
 
 	/**
 	 * @override
 	 */
 	public get nextSibling(): INode {
-		return this.content.nextSibling;
+		return null;
 	}
 
 	/**
@@ -102,7 +84,7 @@ export default class HTMLTemplateElement extends HTMLElement implements IHTMLTem
 	/**
 	 * @override
 	 */
-	public removeChild(node: Node): INode {
+	public removeChild(node: INode): INode {
 		return this.content.removeChild(node);
 	}
 

package/src/nodes/node/INode.ts

@@ -2,14 +2,16 @@ import IEventTarget from '../../event/IEventTarget';
 import IDocument from '../document/IDocument';
 import IElement from '../element/IElement';
 import INodeList from './INodeList';
+import NodeTypeEnum from './NodeTypeEnum';
 
 export default interface INode extends IEventTarget {
-	readonly ELEMENT_NODE: number;
-	readonly TEXT_NODE: number;
-	readonly COMMENT_NODE: number;
-	readonly DOCUMENT_NODE: number;
-	readonly DOCUMENT_TYPE_NODE: number;
-	readonly DOCUMENT_FRAGMENT_NODE: number;
+	readonly ELEMENT_NODE: NodeTypeEnum;
+	readonly TEXT_NODE: NodeTypeEnum;
+	readonly COMMENT_NODE: NodeTypeEnum;
+	readonly DOCUMENT_NODE: NodeTypeEnum;
+	readonly DOCUMENT_TYPE_NODE: NodeTypeEnum;
+	readonly DOCUMENT_FRAGMENT_NODE: NodeTypeEnum;
+	readonly PROCESSING_INSTRUCTION_NODE: NodeTypeEnum;
 	readonly ownerDocument: IDocument;
 	readonly parentNode: INode;
 	readonly parentElement: IElement;

package/src/nodes/node/Node.ts

@@ -1,7 +1,7 @@
 import EventTarget from '../../event/EventTarget';
 import MutationRecord from '../../mutation-observer/MutationRecord';
 import MutationTypeEnum from '../../mutation-observer/MutationTypeEnum';
-import MutationObserverListener from '../../mutation-observer/MutationListener';
+import MutationListener from '../../mutation-observer/MutationListener';
 import Event from '../../event/Event';
 import INode from './INode';
 import DOMException from '../../exception/DOMException';
@@ -10,41 +10,46 @@ import IElement from '../element/IElement';
 import IHTMLBaseElement from '../html-base-element/IHTMLBaseElement';
 import INodeList from './INodeList';
 import NodeListFactory from './NodeListFactory';
+import NodeTypeEnum from './NodeTypeEnum';
 
 /**
  * Node.
  */
 export default class Node extends EventTarget implements INode {
+	// Owner document is set when the Node is created by the Document
+	public static _ownerDocument: IDocument = null;
+
 	// Public properties
-	public static readonly ELEMENT_NODE = 1;
-	public static readonly TEXT_NODE = 3;
-	public static readonly COMMENT_NODE = 8;
-	public static readonly DOCUMENT_NODE = 9;
-	public static readonly DOCUMENT_TYPE_NODE = 10;
-	public static readonly DOCUMENT_FRAGMENT_NODE = 11;
-	public static ownerDocument: IDocument = null;
-	public readonly ELEMENT_NODE = 1;
-	public readonly TEXT_NODE = 3;
-	public readonly COMMENT_NODE = 8;
-	public readonly DOCUMENT_NODE = 9;
-	public readonly DOCUMENT_TYPE_NODE = 10;
-	public readonly DOCUMENT_FRAGMENT_NODE = 11;
+	public static readonly ELEMENT_NODE = NodeTypeEnum.elementNode;
+	public static readonly TEXT_NODE = NodeTypeEnum.textNode;
+	public static readonly COMMENT_NODE = NodeTypeEnum.commentNode;
+	public static readonly DOCUMENT_NODE = NodeTypeEnum.documentNode;
+	public static readonly DOCUMENT_TYPE_NODE = NodeTypeEnum.documentTypeNode;
+	public static readonly DOCUMENT_FRAGMENT_NODE = NodeTypeEnum.documentFragmentNode;
+	public static readonly PROCESSING_INSTRUCTION_NODE = NodeTypeEnum.processingInstructionNode;
+	public readonly ELEMENT_NODE = NodeTypeEnum.elementNode;
+	public readonly TEXT_NODE = NodeTypeEnum.textNode;
+	public readonly COMMENT_NODE = NodeTypeEnum.commentNode;
+	public readonly DOCUMENT_NODE = NodeTypeEnum.documentNode;
+	public readonly DOCUMENT_TYPE_NODE = NodeTypeEnum.documentTypeNode;
+	public readonly DOCUMENT_FRAGMENT_NODE = NodeTypeEnum.documentFragmentNode;
+	public readonly PROCESSING_INSTRUCTION_NODE = NodeTypeEnum.processingInstructionNode;
 	public readonly ownerDocument: IDocument = null;
 	public readonly parentNode: INode = null;
 	public readonly nodeType: number;
 	public readonly childNodes: INodeList<INode> = NodeListFactory.create();
 	public readonly isConnected: boolean = false;
-	public _rootNode: INode = null;
 
 	// Custom Properties (not part of HTML standard)
-	protected _observers: MutationObserverListener[] = [];
+	public _rootNode: INode = null;
+	public _observers: MutationListener[] = [];
 
 	/**
 	 * Constructor.
 	 */
 	constructor() {
 		super();
-		this.ownerDocument = (<typeof Node>this.constructor).ownerDocument;
+		this.ownerDocument = (<typeof Node>this.constructor)._ownerDocument;
 	}
 
 	/**
@@ -457,7 +462,7 @@ export default class Node extends EventTarget implements INode {
 	 *
 	 * @param listener Listener.
 	 */
-	public _observe(listener: MutationObserverListener): void {
+	public _observe(listener: MutationListener): void {
 		this._observers.push(listener);
 		if (listener.options.subtree) {
 			for (const node of this.childNodes) {
@@ -472,7 +477,7 @@ export default class Node extends EventTarget implements INode {
 	 *
 	 * @param listener Listener.
 	 */
-	public _unobserve(listener: MutationObserverListener): void {
+	public _unobserve(listener: MutationListener): void {
 		const index = this._observers.indexOf(listener);
 		if (index !== -1) {
 			this._observers.splice(index, 1);

package/src/nodes/node/NodeTypeEnum.ts

@@ -0,0 +1,11 @@
+enum NodeTypeEnum {
+	elementNode = 1,
+	textNode = 3,
+	commentNode = 8,
+	documentNode = 9,
+	documentTypeNode = 10,
+	documentFragmentNode = 11,
+	processingInstructionNode = 7
+}
+
+export default NodeTypeEnum;

package/src/nodes/node/NodeUtility.ts

@@ -0,0 +1,139 @@
+import IText from '../text/IText';
+import IComment from '../comment/IComment';
+import INode from './INode';
+import NodeTypeEnum from './NodeTypeEnum';
+
+/**
+ * Node utility.
+ */
+export default 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.
+	 */
+	public static isInclusiveAncestor(ancestorNode: INode, referenceNode: INode): boolean {
+		let parent: INode = 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.
+	 */
+	public static isFollowing(nodeA: INode, nodeB: INode): boolean {
+		if (nodeA === nodeB) {
+			return false;
+		}
+
+		let current: INode = 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.
+	 */
+	public static getNodeLength(node: INode): number {
+		switch (node.nodeType) {
+			case NodeTypeEnum.documentTypeNode:
+				return 0;
+
+			case NodeTypeEnum.textNode:
+			case NodeTypeEnum.processingInstructionNode:
+			case NodeTypeEnum.commentNode:
+				return (<IText | IComment>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.
+	 */
+	public static following(node: INode, root?: INode): INode {
+		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.
+	 */
+	public static nextDecendantNode(node: INode): INode {
+		while (node && !node.nextSibling) {
+			node = node.parentNode;
+		}
+
+		if (!node) {
+			return null;
+		}
+
+		return node.nextSibling;
+	}
+}

package/src/nodes/text/IText.ts

@@ -1,6 +1,16 @@
 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/src/nodes/text/Text.ts

@@ -1,6 +1,8 @@
 import Node from '../node/Node';
 import CharacterData from '../character-data/CharacterData';
 import IText from './IText';
+import DOMException from '../../exception/DOMException';
+import DOMExceptionNameEnum from '../../exception/DOMExceptionNameEnum';
 
 /**
  * Text node.
@@ -17,6 +19,37 @@ export default class Text extends CharacterData implements IText {
 		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.
+	 */
+	public splitText(offset: number): IText {
+		const length = this._data.length;
+
+		if (offset > length) {
+			new DOMException(
+				'The index is not in the allowed range.',
+				DOMExceptionNameEnum.indexSizeError
+			);
+		}
+
+		const count = length - offset;
+		const newData = this.substringData(offset, count);
+		const newNode = <IText>this.ownerDocument.createTextNode(newData);
+
+		if (this.parentNode !== null) {
+			this.parentNode.insertBefore(newNode, this.nextSibling);
+		}
+
+		this.replaceData(offset, count, '');
+
+		return newNode;
+	}
+
 	/**
 	 * Converts to string.
 	 *

package/src/range/IRangeBoundaryPoint.ts

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