happy-dom 12.10.3 → 13.0.0

package/src/browser/utilities/BrowserFrameScriptEvaluator.ts

@@ -0,0 +1,22 @@
+import IBrowserFrame from '../types/IBrowserFrame.js';
+import { Script } from 'vm';
+
+/**
+ * Browser frame script evaluator.
+ */
+export default class BrowserFrameScriptEvaluator {
+	/**
+	 * Evaluates code or a VM Script in the frame's context.
+	 *
+	 * @param frame Frame.
+	 * @param script Script.
+	 * @returns Result.
+	 */
+	public static evaluate(frame: IBrowserFrame, script: string | Script): any {
+		if (!frame.window) {
+			throw new Error('The frame has been destroyed, the "window" property is not set.');
+		}
+		script = typeof script === 'string' ? new Script(script) : script;
+		return script.runInContext(frame.window);
+	}
+}

package/src/browser/utilities/BrowserFrameURL.ts

@@ -0,0 +1,40 @@
+import IBrowserFrame from '../types/IBrowserFrame.js';
+import { URL } from 'url';
+import DOMException from '../../exception/DOMException.js';
+import DOMExceptionNameEnum from '../../exception/DOMExceptionNameEnum.js';
+
+/**
+ * Browser frame URL utility.
+ */
+export default class BrowserFrameURL {
+	/**
+	 * Returns relative URL.
+	 *
+	 * @param frame Frame.
+	 * @param url URL.
+	 * @returns Relative URL.
+	 */
+	public static getRelativeURL(frame: IBrowserFrame, url: string): URL {
+		url = url || 'about:blank';
+
+		if (url.startsWith('about:') || url.startsWith('javascript:')) {
+			return new URL(url);
+		}
+
+		try {
+			return new URL(url, frame.window.location);
+		} catch (e) {
+			if (frame.window.location.hostname) {
+				throw new DOMException(
+					`Failed to construct URL from string "${url}".`,
+					DOMExceptionNameEnum.uriMismatchError
+				);
+			} else {
+				throw new DOMException(
+					`Failed to construct URL from string "${url}" relative to URL "${frame.window.location.href}".`,
+					DOMExceptionNameEnum.uriMismatchError
+				);
+			}
+		}
+	}
+}

package/src/browser/utilities/BrowserFrameValidator.ts

@@ -0,0 +1,83 @@
+import IBrowserFrame from '../types/IBrowserFrame.js';
+import { URL } from 'url';
+import BrowserNavigationCrossOriginPolicyEnum from '../enums/BrowserNavigationCrossOriginPolicyEnum.js';
+import DetachedBrowserFrame from '../detached-browser/DetachedBrowserFrame.js';
+
+/**
+ * Browser frame validator.
+ */
+export default class BrowserFrameValidator {
+	/**
+	 * Returns true if the frame navigation complies with the cross origin policy.
+	 *
+	 * @param frame Frame.
+	 * @param toURL URL.
+	 * @returns True if the frame navigation complies with the cross origin policy.
+	 */
+	public static validateCrossOriginPolicy(frame: IBrowserFrame, toURL: URL): boolean {
+		const settings = frame.page.context.browser.settings;
+		let fromURL = frame.page.mainFrame.window.location;
+
+		if (frame.opener) {
+			fromURL = frame.opener.window.location;
+		}
+		if (frame.parentFrame) {
+			fromURL = frame.parentFrame.window.location;
+		}
+
+		if (
+			settings.navigation.crossOriginPolicy === BrowserNavigationCrossOriginPolicyEnum.sameOrigin &&
+			fromURL.protocol !== 'about:' &&
+			toURL.protocol !== 'about:' &&
+			toURL.protocol !== 'javascript:' &&
+			fromURL.origin !== toURL.origin
+		) {
+			return false;
+		}
+
+		if (
+			settings.navigation.crossOriginPolicy ===
+				BrowserNavigationCrossOriginPolicyEnum.strictOrigin &&
+			fromURL.protocol === 'https:' &&
+			toURL.protocol === 'http:'
+		) {
+			return false;
+		}
+
+		return true;
+	}
+
+	/**
+	 * Returns true if navigation is allowed for the frame.
+	 *
+	 * @param frame Frame.
+	 * @returns True if navigation is allowed for the frame.
+	 */
+	public static validateFrameNavigation(frame: IBrowserFrame): boolean {
+		const settings = frame.page.context.browser.settings;
+
+		// When using the Window instance directly and not via the Browser API we should not navigate the browser frame.
+		if (
+			frame instanceof DetachedBrowserFrame &&
+			frame.page.context === frame.page.context.browser.defaultContext &&
+			frame.page.context.pages[0] === frame.page &&
+			frame.page.mainFrame === frame
+		) {
+			return false;
+		}
+
+		if (settings.navigation.disableMainFrameNavigation && frame.page.mainFrame === frame) {
+			return false;
+		}
+
+		if (settings.navigation.disableChildFrameNavigation && frame.page.mainFrame !== frame) {
+			return false;
+		}
+
+		if (settings.navigation.disableChildPageNavigation && !!frame.opener) {
+			return false;
+		}
+
+		return true;
+	}
+}

package/src/browser/utilities/BrowserPageUtility.ts

@@ -0,0 +1,94 @@
+import IBrowserFrame from '../types/IBrowserFrame.js';
+import IBrowserPage from '../types/IBrowserPage.js';
+import IBrowserPageViewport from '../types/IBrowserPageViewport.js';
+import Event from '../../event/Event.js';
+import IVirtualConsolePrinter from '../../console/types/IVirtualConsolePrinter.js';
+import IBrowserContext from '../types/IBrowserContext.js';
+import BrowserFrameFactory from './BrowserFrameFactory.js';
+
+/**
+ * Browser page utility.
+ */
+export default class BrowserPageUtility {
+	/**
+	 * Returns frames for a page.
+	 *
+	 * @param page Page.
+	 * @returns Frames.
+	 */
+	public static getFrames(page: IBrowserPage): IBrowserFrame[] {
+		return this.findFrames(page.mainFrame);
+	}
+
+	/**
+	 * Sets the viewport.
+	 *
+	 * @param page Page.
+	 * @param viewport Viewport.
+	 */
+	public static setViewport(page: IBrowserPage, viewport: IBrowserPageViewport): void {
+		if (
+			(viewport.width !== undefined && page.mainFrame.window.innerWidth !== viewport.width) ||
+			(viewport.height !== undefined && page.mainFrame.window.innerHeight !== viewport.height)
+		) {
+			if (viewport.width !== undefined && page.mainFrame.window.innerWidth !== viewport.width) {
+				(<number>page.mainFrame.window.innerWidth) = viewport.width;
+				(<number>page.mainFrame.window.outerWidth) = viewport.width;
+			}
+
+			if (viewport.height !== undefined && page.mainFrame.window.innerHeight !== viewport.height) {
+				(<number>page.mainFrame.window.innerHeight) = viewport.height;
+				(<number>page.mainFrame.window.outerHeight) = viewport.height;
+			}
+
+			page.mainFrame.window.dispatchEvent(new Event('resize'));
+		}
+
+		if (viewport.devicePixelRatio !== undefined) {
+			(<number>page.mainFrame.window.devicePixelRatio) = viewport.devicePixelRatio;
+		}
+	}
+
+	/**
+	 * Aborts all ongoing operations and destroys the page.
+	 *
+	 * @param page Page.
+	 */
+	public static closePage(page: IBrowserPage): Promise<void> {
+		// Using Promise instead of async/await to prevent microtask
+		return new Promise((resolve, reject) => {
+			if (!page.mainFrame) {
+				resolve();
+				return;
+			}
+
+			const index = page.context.pages.indexOf(page);
+			if (index !== -1) {
+				page.context.pages.splice(index, 1);
+			}
+
+			BrowserFrameFactory.destroyFrame(page.mainFrame)
+				.then(() => {
+					(<IVirtualConsolePrinter | null>page.virtualConsolePrinter) = null;
+					(<IBrowserFrame | null>page.mainFrame) = null;
+					(<IBrowserContext | null>page.context) = null;
+					resolve();
+				})
+				.catch((error) => reject(error));
+		});
+	}
+
+	/**
+	 * Returns all frames.
+	 *
+	 * @param parentFrame Parent frame.
+	 * @returns Frames, including the parent.
+	 */
+	private static findFrames(parentFrame: IBrowserFrame): IBrowserFrame[] {
+		let frames = [parentFrame];
+		for (const frame of parentFrame.childFrames) {
+			frames = frames.concat(this.findFrames(frame));
+		}
+		return frames;
+	}
+}

package/src/clipboard/Clipboard.ts

@@ -1,5 +1,5 @@
 import DOMException from '../exception/DOMException.js';
-import IWindow from '../window/IWindow.js';
+import IBrowserWindow from '../window/IBrowserWindow.js';
 import ClipboardItem from './ClipboardItem.js';
 import Blob from '../file/Blob.js';
 
@@ -10,7 +10,7 @@ import Blob from '../file/Blob.js';
  * https://developer.mozilla.org/en-US/docs/Web/API/Clipboard.
  */
 export default class Clipboard {
-	#ownerWindow: IWindow;
+	#ownerWindow: IBrowserWindow;
 	#data: ClipboardItem[] = [];
 
 	/**
@@ -18,7 +18,7 @@ export default class Clipboard {
 	 *
 	 * @param ownerWindow Owner window.
 	 */
-	constructor(ownerWindow: IWindow) {
+	constructor(ownerWindow: IBrowserWindow) {
 		this.#ownerWindow = ownerWindow;
 	}
 

package/src/config/ElementTag.ts

@@ -1,155 +1,130 @@
-import HTMLElement from '../nodes/html-element/HTMLElement.js';
-import HTMLTemplateElement from '../nodes/html-template-element/HTMLTemplateElement.js';
-import HTMLFormElement from '../nodes/html-form-element/HTMLFormElement.js';
-import HTMLInputElement from '../nodes/html-input-element/HTMLInputElement.js';
-import HTMLTextAreaElement from '../nodes/html-text-area-element/HTMLTextAreaElement.js';
-import SVGSVGElement from '../nodes/svg-element/SVGSVGElement.js';
-import SVGElement from '../nodes/svg-element/SVGElement.js';
-import HTMLScriptElement from '../nodes/html-script-element/HTMLScriptElement.js';
-import HTMLImageElement from '../nodes/html-image-element/HTMLImageElement.js';
-import HTMLLinkElement from '../nodes/html-link-element/HTMLLinkElement.js';
-import HTMLStyleElement from '../nodes/html-style-element/HTMLStyleElement.js';
-import HTMLLabelElement from '../nodes/html-label-element/HTMLLabelElement.js';
-import HTMLSlotElement from '../nodes/html-slot-element/HTMLSlotElement.js';
-import HTMLMetaElement from '../nodes/html-meta-element/HTMLMetaElement.js';
-import HTMLBaseElement from '../nodes/html-base-element/HTMLBaseElement.js';
-import HTMLSelectElement from '../nodes/html-select-element/HTMLSelectElement.js';
-import HTMLOptionElement from '../nodes/html-option-element/HTMLOptionElement.js';
-import HTMLOptGroupElement from '../nodes/html-opt-group-element/HTMLOptGroupElement.js';
-import HTMLDialogElement from '../nodes/html-dialog-element/HTMLDialogElement.js';
-import HTMLButtonElement from '../nodes/html-button-element/HTMLButtonElement.js';
-import HTMLAudioElement from '../nodes/html-audio-element/HTMLAudioElement.js';
-import HTMLVideoElement from '../nodes/html-video-element/HTMLVideoElement.js';
-import HTMLAnchorElement from '../nodes/html-anchor-element/HTMLAnchorElement.js';
-import HTMLIFrameElement from '../nodes/html-iframe-element/HTMLIFrameElement.js';
-
-export default {
-	A: HTMLAnchorElement,
-	ABBR: HTMLElement,
-	ADDRESS: HTMLElement,
-	AREA: HTMLElement,
-	ARTICLE: HTMLElement,
-	ASIDE: HTMLElement,
-	AUDIO: HTMLAudioElement,
-	B: HTMLElement,
-	BASE: HTMLBaseElement,
-	BDI: HTMLElement,
-	BDO: HTMLElement,
-	BLOCKQUAOTE: HTMLElement,
-	BODY: HTMLElement,
-	TEMPLATE: HTMLTemplateElement,
-	FORM: HTMLFormElement,
-	INPUT: HTMLInputElement,
-	TEXTAREA: HTMLTextAreaElement,
-	SCRIPT: HTMLScriptElement,
-	IMG: HTMLImageElement,
-	LINK: HTMLLinkElement,
-	STYLE: HTMLStyleElement,
-	LABEL: HTMLLabelElement,
-	SLOT: HTMLSlotElement,
-	SVG: SVGSVGElement,
-	G: SVGElement,
-	CIRCLE: SVGElement,
-	ELLIPSE: SVGElement,
-	LINE: SVGElement,
-	PATH: SVGElement,
-	POLYGON: SVGElement,
-	POLYLINE: SVGElement,
-	RECT: SVGElement,
-	STOP: SVGElement,
-	USE: SVGElement,
-	META: HTMLMetaElement,
-	BLOCKQUOTE: HTMLElement,
-	BR: HTMLElement,
-	BUTTON: HTMLButtonElement,
-	CANVAS: HTMLElement,
-	CAPTION: HTMLElement,
-	CITE: HTMLElement,
-	CODE: HTMLElement,
-	COL: HTMLElement,
-	COLGROUP: HTMLElement,
-	DATA: HTMLElement,
-	DATALIST: HTMLElement,
-	DD: HTMLElement,
-	DEL: HTMLElement,
-	DETAILS: HTMLElement,
-	DFN: HTMLElement,
-	DIALOG: HTMLDialogElement,
-	DIV: HTMLElement,
-	DL: HTMLElement,
-	DT: HTMLElement,
-	EM: HTMLElement,
-	EMBED: HTMLElement,
-	FIELDSET: HTMLElement,
-	FIGCAPTION: HTMLElement,
-	FIGURE: HTMLElement,
-	FOOTER: HTMLElement,
-	H1: HTMLElement,
-	H2: HTMLElement,
-	H3: HTMLElement,
-	H4: HTMLElement,
-	H5: HTMLElement,
-	H6: HTMLElement,
-	HEAD: HTMLElement,
-	HEADER: HTMLElement,
-	HGROUP: HTMLElement,
-	HR: HTMLElement,
-	HTML: HTMLElement,
-	I: HTMLElement,
-	IFRAME: HTMLIFrameElement,
-	INS: HTMLElement,
-	KBD: HTMLElement,
-	LEGEND: HTMLElement,
-	LI: HTMLElement,
-	MAIN: HTMLElement,
-	MAP: HTMLElement,
-	MARK: HTMLElement,
-	MATH: HTMLElement,
-	MENU: HTMLElement,
-	MENUITEM: HTMLElement,
-	METER: HTMLElement,
-	NAV: HTMLElement,
-	NOSCRIPT: HTMLElement,
-	OBJECT: HTMLElement,
-	OL: HTMLElement,
-	OPTGROUP: HTMLOptGroupElement,
-	OPTION: HTMLOptionElement,
-	OUTPUT: HTMLElement,
-	P: HTMLElement,
-	PARAM: HTMLElement,
-	PICTURE: HTMLElement,
-	PRE: HTMLElement,
-	PROGRESS: HTMLElement,
-	Q: HTMLElement,
-	RB: HTMLElement,
-	RP: HTMLElement,
-	RT: HTMLElement,
-	RTC: HTMLElement,
-	RUBY: HTMLElement,
-	S: HTMLElement,
-	SAMP: HTMLElement,
-	SECTION: HTMLElement,
-	SELECT: HTMLSelectElement,
-	SMALL: HTMLElement,
-	SOURCE: HTMLElement,
-	SPAN: HTMLElement,
-	STRONG: HTMLElement,
-	SUB: HTMLElement,
-	SUMMARY: HTMLElement,
-	SUP: HTMLElement,
-	TABLE: HTMLElement,
-	TBODY: HTMLElement,
-	TD: HTMLElement,
-	TFOOT: HTMLElement,
-	TH: HTMLElement,
-	THEAD: HTMLElement,
-	TIME: HTMLElement,
-	TITLE: HTMLElement,
-	TR: HTMLElement,
-	TRACK: HTMLElement,
-	U: HTMLElement,
-	UL: HTMLElement,
-	VAR: HTMLElement,
-	VIDEO: HTMLVideoElement,
-	WBR: HTMLElement
+export default <{ [key: string]: string }>{
+	A: 'HTMLAnchorElement',
+	ABBR: 'HTMLElement',
+	ADDRESS: 'HTMLElement',
+	AREA: 'HTMLElement',
+	ARTICLE: 'HTMLElement',
+	ASIDE: 'HTMLElement',
+	AUDIO: 'HTMLAudioElement',
+	B: 'HTMLElement',
+	BASE: 'HTMLBaseElement',
+	BDI: 'HTMLElement',
+	BDO: 'HTMLElement',
+	BLOCKQUAOTE: 'HTMLElement',
+	BODY: 'HTMLElement',
+	TEMPLATE: 'HTMLTemplateElement',
+	FORM: 'HTMLFormElement',
+	INPUT: 'HTMLInputElement',
+	TEXTAREA: 'HTMLTextAreaElement',
+	SCRIPT: 'HTMLScriptElement',
+	IMG: 'HTMLImageElement',
+	LINK: 'HTMLLinkElement',
+	STYLE: 'HTMLStyleElement',
+	LABEL: 'HTMLLabelElement',
+	SLOT: 'HTMLSlotElement',
+	SVG: 'SVGSVGElement',
+	G: 'SVGElement',
+	CIRCLE: 'SVGElement',
+	ELLIPSE: 'SVGElement',
+	LINE: 'SVGElement',
+	PATH: 'SVGElement',
+	POLYGON: 'SVGElement',
+	POLYLINE: 'SVGElement',
+	RECT: 'SVGElement',
+	STOP: 'SVGElement',
+	USE: 'SVGElement',
+	META: 'HTMLMetaElement',
+	BLOCKQUOTE: 'HTMLElement',
+	BR: 'HTMLElement',
+	BUTTON: 'HTMLButtonElement',
+	CANVAS: 'HTMLElement',
+	CAPTION: 'HTMLElement',
+	CITE: 'HTMLElement',
+	CODE: 'HTMLElement',
+	COL: 'HTMLElement',
+	COLGROUP: 'HTMLElement',
+	DATA: 'HTMLElement',
+	DATALIST: 'HTMLElement',
+	DD: 'HTMLElement',
+	DEL: 'HTMLElement',
+	DETAILS: 'HTMLElement',
+	DFN: 'HTMLElement',
+	DIALOG: 'HTMLDialogElement',
+	DIV: 'HTMLElement',
+	DL: 'HTMLElement',
+	DT: 'HTMLElement',
+	EM: 'HTMLElement',
+	EMBED: 'HTMLElement',
+	FIELDSET: 'HTMLElement',
+	FIGCAPTION: 'HTMLElement',
+	FIGURE: 'HTMLElement',
+	FOOTER: 'HTMLElement',
+	H1: 'HTMLElement',
+	H2: 'HTMLElement',
+	H3: 'HTMLElement',
+	H4: 'HTMLElement',
+	H5: 'HTMLElement',
+	H6: 'HTMLElement',
+	HEAD: 'HTMLElement',
+	HEADER: 'HTMLElement',
+	HGROUP: 'HTMLElement',
+	HR: 'HTMLElement',
+	HTML: 'HTMLElement',
+	I: 'HTMLElement',
+	IFRAME: 'HTMLIFrameElement',
+	INS: 'HTMLElement',
+	KBD: 'HTMLElement',
+	LEGEND: 'HTMLElement',
+	LI: 'HTMLElement',
+	MAIN: 'HTMLElement',
+	MAP: 'HTMLElement',
+	MARK: 'HTMLElement',
+	MATH: 'HTMLElement',
+	MENU: 'HTMLElement',
+	MENUITEM: 'HTMLElement',
+	METER: 'HTMLElement',
+	NAV: 'HTMLElement',
+	NOSCRIPT: 'HTMLElement',
+	OBJECT: 'HTMLElement',
+	OL: 'HTMLElement',
+	OPTGROUP: 'HTMLOptGroupElement',
+	OPTION: 'HTMLOptionElement',
+	OUTPUT: 'HTMLElement',
+	P: 'HTMLElement',
+	PARAM: 'HTMLElement',
+	PICTURE: 'HTMLElement',
+	PRE: 'HTMLElement',
+	PROGRESS: 'HTMLElement',
+	Q: 'HTMLElement',
+	RB: 'HTMLElement',
+	RP: 'HTMLElement',
+	RT: 'HTMLElement',
+	RTC: 'HTMLElement',
+	RUBY: 'HTMLElement',
+	S: 'HTMLElement',
+	SAMP: 'HTMLElement',
+	SECTION: 'HTMLElement',
+	SELECT: 'HTMLSelectElement',
+	SMALL: 'HTMLElement',
+	SOURCE: 'HTMLElement',
+	SPAN: 'HTMLElement',
+	STRONG: 'HTMLElement',
+	SUB: 'HTMLElement',
+	SUMMARY: 'HTMLElement',
+	SUP: 'HTMLElement',
+	TABLE: 'HTMLElement',
+	TBODY: 'HTMLElement',
+	TD: 'HTMLElement',
+	TFOOT: 'HTMLElement',
+	TH: 'HTMLElement',
+	THEAD: 'HTMLElement',
+	TIME: 'HTMLElement',
+	TITLE: 'HTMLElement',
+	TR: 'HTMLElement',
+	TRACK: 'HTMLElement',
+	U: 'HTMLElement',
+	UL: 'HTMLElement',
+	VAR: 'HTMLElement',
+	VIDEO: 'HTMLVideoElement',
+	WBR: 'HTMLElement'
 };