happy-dom 17.6.3 → 18.0.1

package/src/browser/types/IBrowser.ts

@@ -14,6 +14,7 @@ export default interface IBrowser {
 	readonly contexts: IBrowserContext[];
 	readonly settings: IBrowserSettings;
 	readonly console: Console | null;
+	readonly closed: boolean;
 	readonly [PropertySymbol.exceptionObserver]: BrowserExceptionObserver | null;
 
 	/**

package/src/browser/types/IBrowserContext.ts

@@ -13,6 +13,7 @@ export default interface IBrowserContext {
 	readonly cookieContainer: ICookieContainer;
 	readonly responseCache: IResponseCache;
 	readonly preflightResponseCache: IPreflightResponseCache;
+	readonly closed: boolean;
 
 	/**
 	 * Aborts all ongoing operations and destroys the context.

package/src/browser/types/IBrowserFrame.ts

@@ -19,6 +19,7 @@ export default interface IBrowserFrame {
 	readonly page: IBrowserPage;
 	readonly window: BrowserWindow;
 	readonly document: Document;
+	readonly closed: boolean;
 	content: string;
 	url: string;
 	[PropertySymbol.history]: IHistoryItem[];

package/src/browser/types/IBrowserPage.ts

@@ -18,6 +18,7 @@ export default interface IBrowserPage {
 	readonly console: Console;
 	readonly frames: IBrowserFrame[];
 	readonly viewport: IBrowserPageViewport;
+	readonly closed: boolean;
 	content: string;
 	url: string;
 

package/src/browser/utilities/BrowserFrameFactory.ts

@@ -1,6 +1,5 @@
 import IBrowserFrame from '../types/IBrowserFrame.js';
 import * as PropertySymbol from '../../PropertySymbol.js';
-import BrowserWindow from '../../window/BrowserWindow.js';
 import IBrowserPage from '../types/IBrowserPage.js';
 
 /**
@@ -28,7 +27,13 @@ export default class BrowserFrameFactory {
 	 * @param frame Frame.
 	 */
 	public static destroyFrame(frame: IBrowserFrame): Promise<void> {
-		const exceptionObserver = frame.page?.context?.browser?.[PropertySymbol.exceptionObserver];
+		const exceptionObserver = frame.page.context.browser[PropertySymbol.exceptionObserver];
+
+		if (frame.closed) {
+			return Promise.resolve();
+		}
+
+		(<boolean>frame.closed) = true;
 
 		// Using Promise instead of async/await to prevent usage of a microtask
 		return new Promise((resolve, reject) => {
@@ -52,8 +57,7 @@ export default class BrowserFrameFactory {
 							exceptionObserver.disconnect(frame.window);
 						}
 
-						(<IBrowserPage | null>frame.page) = null;
-						(<BrowserWindow | null>frame.window) = null;
+						(<object>frame.window) = { closed: true };
 						frame[PropertySymbol.openerFrame] = null;
 						frame[PropertySymbol.openerWindow] = null;
 
@@ -75,8 +79,7 @@ export default class BrowserFrameFactory {
 								exceptionObserver.disconnect(frame.window);
 							}
 
-							(<IBrowserPage | null>frame.page) = null;
-							(<BrowserWindow | null>frame.window) = null;
+							(<object>frame.window) = { closed: true };
 							frame[PropertySymbol.openerFrame] = null;
 							frame[PropertySymbol.openerWindow] = null;
 

package/src/browser/utilities/BrowserFrameNavigator.ts

@@ -34,7 +34,7 @@ export default class BrowserFrameNavigator {
 		windowClass: new (
 			browserFrame: IBrowserFrame,
 			options?: { url?: string; width?: number; height?: number }
-		) => BrowserWindow | null;
+		) => BrowserWindow;
 		frame: IBrowserFrame;
 		url: string;
 		goToOptions?: IGoToOptions;
@@ -267,13 +267,13 @@ export default class BrowserFrameNavigator {
 		windowClass: new (
 			browserFrame: IBrowserFrame,
 			options?: { url?: string; width?: number; height?: number }
-		) => BrowserWindow | null;
+		) => BrowserWindow;
 		frame: IBrowserFrame;
 		goToOptions?: IGoToOptions;
 	}): Promise<Response | null> {
 		const { windowClass, frame, goToOptions } = options;
 		const history = frame[PropertySymbol.history];
-		let historyItem: IHistoryItem;
+		let historyItem: IHistoryItem | null = null;
 
 		for (let i = history.length - 1; i >= 0; i--) {
 			if (history[i].isCurrent) {
@@ -326,13 +326,13 @@ export default class BrowserFrameNavigator {
 		windowClass: new (
 			browserFrame: IBrowserFrame,
 			options?: { url?: string; width?: number; height?: number }
-		) => BrowserWindow | null;
+		) => BrowserWindow;
 		frame: IBrowserFrame;
 		goToOptions?: IGoToOptions;
 	}): Promise<Response | null> {
 		const { windowClass, frame, goToOptions } = options;
 		const history = frame[PropertySymbol.history];
-		let historyItem: IHistoryItem;
+		let historyItem: IHistoryItem | null = null;
 
 		for (let i = history.length - 1; i >= 0; i--) {
 			if (history[i].isCurrent) {
@@ -386,7 +386,7 @@ export default class BrowserFrameNavigator {
 		windowClass: new (
 			browserFrame: IBrowserFrame,
 			options?: { url?: string; width?: number; height?: number }
-		) => BrowserWindow | null;
+		) => BrowserWindow;
 		frame: IBrowserFrame;
 		goToOptions?: IGoToOptions;
 		steps?: number;
@@ -397,7 +397,7 @@ export default class BrowserFrameNavigator {
 
 		const { windowClass, frame, goToOptions, steps } = options;
 		const history = frame[PropertySymbol.history];
-		let historyItem: IHistoryItem;
+		let historyItem: IHistoryItem | null = null;
 
 		for (let i = history.length - 1; i >= 0; i--) {
 			if (history[i].isCurrent) {
@@ -450,13 +450,13 @@ export default class BrowserFrameNavigator {
 		windowClass: new (
 			browserFrame: IBrowserFrame,
 			options?: { url?: string; width?: number; height?: number }
-		) => BrowserWindow | null;
+		) => BrowserWindow;
 		frame: IBrowserFrame;
 		goToOptions?: IGoToOptions;
 	}): Promise<Response | null> {
 		const { windowClass, frame, goToOptions } = options;
 		const history = frame[PropertySymbol.history];
-		let historyItem: IHistoryItem;
+		let historyItem: IHistoryItem | null = null;
 
 		for (let i = history.length - 1; i >= 0; i--) {
 			if (history[i].isCurrent) {

package/src/browser/utilities/BrowserFrameURL.ts

@@ -12,7 +12,7 @@ export default class BrowserFrameURL {
 	 * @param url URL.
 	 * @returns Relative URL.
 	 */
-	public static getRelativeURL(frame: IBrowserFrame, url: string | URL): URL {
+	public static getRelativeURL(frame: IBrowserFrame, url?: string | URL | null): URL {
 		url = url ? String(url) : 'about:blank';
 
 		if (url.startsWith('about:') || url.startsWith('javascript:')) {

package/src/browser/utilities/BrowserPageUtility.ts

@@ -1,7 +1,5 @@
 import IBrowserFrame from '../types/IBrowserFrame.js';
 import IBrowserPage from '../types/IBrowserPage.js';
-import IVirtualConsolePrinter from '../../console/IVirtualConsolePrinter.js';
-import IBrowserContext from '../types/IBrowserContext.js';
 import BrowserFrameFactory from './BrowserFrameFactory.js';
 
 /**
@@ -24,27 +22,22 @@ export default class BrowserPageUtility {
 	 * @param page Page.
 	 */
 	public static closePage(page: IBrowserPage): Promise<void> {
+		if (page.closed) {
+			return Promise.resolve();
+		}
+
+		(<boolean>page.closed) = true;
+
+		const index = page.context.pages.indexOf(page);
+
+		if (index !== -1) {
+			page.context.pages.splice(index, 1);
+		}
+
+		page.virtualConsolePrinter.close();
+
 		// 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));
-		});
+		return BrowserFrameFactory.destroyFrame(page.mainFrame);
 	}
 
 	/**

package/src/console/IVirtualConsoleLogEntry.ts

@@ -5,6 +5,6 @@ import VirtualConsoleLogTypeEnum from './enums/VirtualConsoleLogTypeEnum.js';
 export default interface IVirtualConsoleLogEntry {
 	type: VirtualConsoleLogTypeEnum;
 	level: VirtualConsoleLogLevelEnum;
-	message: Array<string | object>;
+	message: Array<string | any>;
 	group: IVirtualConsoleLogGroup | null;
 }

package/src/console/VirtualConsole.ts

@@ -12,7 +12,7 @@ import { ConsoleConstructor } from 'console';
 export default class VirtualConsole implements Console {
 	// This is needed as the interface for the NodeJS Console also have a reference to the ConsoleConstructor class as a property for some reason.
 	// This is not part of the browser specs.
-	public Console: ConsoleConstructor;
+	public declare Console: ConsoleConstructor;
 
 	#printer: IVirtualConsolePrinter;
 	#count: { [label: string]: number } = {};

package/src/console/VirtualConsolePrinter.ts

@@ -13,6 +13,16 @@ export default class VirtualConsolePrinter implements IVirtualConsolePrinter {
 		print: Array<(event: Event) => void>;
 		clear: Array<(event: Event) => void>;
 	} = { print: [], clear: [] };
+	#closed = false;
+
+	/**
+	 * Returns closed state.
+	 *
+	 * @returns True if the printer is closed.
+	 */
+	public get closed(): boolean {
+		return this.#closed;
+	}
 
 	/**
 	 * Writes to the output.
@@ -20,6 +30,9 @@ export default class VirtualConsolePrinter implements IVirtualConsolePrinter {
 	 * @param logEntry Log entry.
 	 */
 	public print(logEntry: IVirtualConsoleLogEntry): void {
+		if (this.#closed) {
+			return;
+		}
 		this.#logEntries.push(logEntry);
 		this.dispatchEvent(new Event('print'));
 	}
@@ -28,10 +41,25 @@ export default class VirtualConsolePrinter implements IVirtualConsolePrinter {
 	 * Clears the output.
 	 */
 	public clear(): void {
+		if (this.#closed) {
+			return;
+		}
 		this.#logEntries = [];
 		this.dispatchEvent(new Event('clear'));
 	}
 
+	/**
+	 * Clears and closes the virtual console printer.
+	 */
+	public close(): void {
+		if (this.#closed) {
+			return;
+		}
+		this.#logEntries = [];
+		this.#listeners = { print: [], clear: [] };
+		this.#closed = true;
+	}
+
 	/**
 	 * Adds an event listener.
 	 *
@@ -39,6 +67,9 @@ export default class VirtualConsolePrinter implements IVirtualConsolePrinter {
 	 * @param listener Listener.
 	 */
 	public addEventListener(eventType: 'print' | 'clear', listener: (event: Event) => void): void {
+		if (this.#closed) {
+			return;
+		}
 		if (!this.#listeners[eventType]) {
 			throw new Error(`Event type "${eventType}" is not supported.`);
 		}
@@ -52,6 +83,9 @@ export default class VirtualConsolePrinter implements IVirtualConsolePrinter {
 	 * @param listener Listener.
 	 */
 	public removeEventListener(eventType: 'print' | 'clear', listener: (event: Event) => void): void {
+		if (this.#closed) {
+			return;
+		}
 		if (!this.#listeners[eventType]) {
 			throw new Error(`Event type "${eventType}" is not supported.`);
 		}
@@ -67,11 +101,18 @@ export default class VirtualConsolePrinter implements IVirtualConsolePrinter {
 	 * @param event Event.
 	 */
 	public dispatchEvent(event: Event): void {
-		if (!this.#listeners[event.type]) {
-			throw new Error(`Event type "${event.type}" is not supported.`);
+		if (this.#closed) {
+			return;
 		}
-		for (const listener of this.#listeners[event.type]) {
-			listener(event);
+		switch (event.type) {
+			case 'print':
+			case 'clear':
+				for (const listener of this.#listeners[event.type]) {
+					listener(event);
+				}
+				break;
+			default:
+				throw new Error(`Event type "${event.type}" is not supported.`);
 		}
 	}
 

package/src/console/utilities/VirtualConsoleLogEntryStringifier.ts

@@ -27,7 +27,7 @@ export default class VirtualConsoleLogEntryStringifier {
 				try {
 					output += JSON.stringify(part);
 				} catch (error) {
-					output += new Error('Failed to JSON stringify object in log entry.').stack.replace(
+					output += new Error('Failed to JSON stringify object in log entry.').stack!.replace(
 						/\n    at/gm,
 						'\n    ' + tabbing + 'at'
 					);

package/src/cookie/CookieContainer.ts

@@ -21,13 +21,13 @@ export default class CookieContainer implements ICookieContainer {
 	 * @param cookies Cookies.
 	 */
 	public addCookies(cookies: IOptionalCookie[]): void {
-		const indexMap: { [k: string]: number } = {};
+		const indexMap: Map<string, number> = new Map();
 		const getKey = (cookie: ICookie): string =>
 			`${cookie.key}-${cookie.originURL.hostname}-${cookie.path}-${typeof cookie.value}`;
 
 		// Creates a map of cookie key, domain, path and value to index.
 		for (let i = 0, max = this.#cookies.length; i < max; i++) {
-			indexMap[getKey(this.#cookies[i])] = i;
+			indexMap.set(getKey(this.#cookies[i]), i);
 		}
 
 		for (const cookie of cookies) {
@@ -35,14 +35,14 @@ export default class CookieContainer implements ICookieContainer {
 
 			if (newCookie && newCookie.key && newCookie.originURL) {
 				// Remove existing cookie with same name, domain and path.
-				const index = indexMap[getKey(newCookie)];
+				const index = indexMap.get(getKey(newCookie));
 
 				if (index !== undefined) {
 					this.#cookies.splice(index, 1);
 				}
 
 				if (!CookieExpireUtility.hasExpired(newCookie)) {
-					indexMap[getKey(newCookie)] = this.#cookies.length;
+					indexMap.set(getKey(newCookie), this.#cookies.length);
 					this.#cookies.push(newCookie);
 				}
 			}
@@ -71,4 +71,11 @@ export default class CookieContainer implements ICookieContainer {
 
 		return cookies;
 	}
+
+	/**
+	 * Clears all cookies.
+	 */
+	public clearCookies(): void {
+		this.#cookies = [];
+	}
 }

package/src/cookie/DefaultCookie.ts

@@ -3,8 +3,8 @@ import ICookie from './ICookie.js';
 
 export default <ICookie>{
 	// Required
-	key: null,
-	originURL: null,
+	key: null!,
+	originURL: null!,
 
 	// Optional
 	value: null,

package/src/cookie/ICookieContainer.ts

@@ -23,5 +23,10 @@ export default interface ICookieContainer {
 	 * @param [httpOnly] "true" if only http cookies should be returned.
 	 * @returns Cookies.
 	 */
-	getCookies(url: URL | null, httpOnly?: boolean): ICookie[];
+	getCookies(url?: URL | null, httpOnly?: boolean): ICookie[];
+
+	/**
+	 * Clears all cookies.
+	 */
+	clearCookies(): void;
 }

package/src/cookie/urilities/CookieStringUtility.ts

@@ -2,6 +2,7 @@ import CookieSameSiteEnum from '../enums/CookieSameSiteEnum.js';
 import URL from '../../url/URL.js';
 import ICookie from '../ICookie.js';
 import DefaultCookie from '../DefaultCookie.js';
+import Location from '../../location/Location.js';
 
 /**
  * Cookie string.
@@ -14,9 +15,14 @@ export default class CookieStringUtility {
 	 * @param cookieString Cookie string.
 	 * @returns Cookie.
 	 */
-	public static stringToCookie(originURL: URL, cookieString: string): ICookie | null {
+	public static stringToCookie(originURL: URL | Location, cookieString: string): ICookie | null {
 		const parts = cookieString.split(';');
 		const part = parts.shift();
+
+		if (!part) {
+			return null;
+		}
+
 		const index = part.indexOf('=');
 		const key = index !== -1 ? part.slice(0, index).trim() : part.trim();
 		const value = index !== -1 ? part.slice(index + 1).trim() : null;

package/src/css/CSS.ts

@@ -1,6 +1,5 @@
 import CSSEscaper from './utilities/CSSEscaper.js';
 import CSSUnitValue from './CSSUnitValue.js';
-import CSSUnits from './CSSUnits.js';
 
 /**
  * The CSS interface holds useful CSS-related methods.
@@ -9,14 +8,35 @@ import CSSUnits from './CSSUnits.js';
  * https://developer.mozilla.org/en-US/docs/Web/API/CSS.
  */
 export default class CSS {
-	/**
-	 * Constructor.
-	 */
-	constructor() {
-		for (const unit of CSSUnits) {
-			this[unit] = (value: number) => new CSSUnitValue(value, unit);
-		}
-	}
+	public readonly Hz = (value: number): CSSUnitValue => new CSSUnitValue(value, 'Hz');
+	public readonly Q = (value: number): CSSUnitValue => new CSSUnitValue(value, 'Q');
+	public readonly ch = (value: number): CSSUnitValue => new CSSUnitValue(value, 'ch');
+	public readonly cm = (value: number): CSSUnitValue => new CSSUnitValue(value, 'cm');
+	public readonly deg = (value: number): CSSUnitValue => new CSSUnitValue(value, 'deg');
+	public readonly dpcm = (value: number): CSSUnitValue => new CSSUnitValue(value, 'dpcm');
+	public readonly dpi = (value: number): CSSUnitValue => new CSSUnitValue(value, 'dpi');
+	public readonly dppx = (value: number): CSSUnitValue => new CSSUnitValue(value, 'dppx');
+	public readonly em = (value: number): CSSUnitValue => new CSSUnitValue(value, 'em');
+	public readonly ex = (value: number): CSSUnitValue => new CSSUnitValue(value, 'ex');
+	public readonly fr = (value: number): CSSUnitValue => new CSSUnitValue(value, 'fr');
+	public readonly grad = (value: number): CSSUnitValue => new CSSUnitValue(value, 'grad');
+	public readonly in = (value: number): CSSUnitValue => new CSSUnitValue(value, 'in');
+	public readonly kHz = (value: number): CSSUnitValue => new CSSUnitValue(value, 'kHz');
+	public readonly mm = (value: number): CSSUnitValue => new CSSUnitValue(value, 'mm');
+	public readonly ms = (value: number): CSSUnitValue => new CSSUnitValue(value, 'ms');
+	public readonly number = (value: number): CSSUnitValue => new CSSUnitValue(value, 'number');
+	public readonly pc = (value: number): CSSUnitValue => new CSSUnitValue(value, 'pc');
+	public readonly percent = (value: number): CSSUnitValue => new CSSUnitValue(value, 'percent');
+	public readonly pt = (value: number): CSSUnitValue => new CSSUnitValue(value, 'pt');
+	public readonly px = (value: number): CSSUnitValue => new CSSUnitValue(value, 'px');
+	public readonly rad = (value: number): CSSUnitValue => new CSSUnitValue(value, 'rad');
+	public readonly rem = (value: number): CSSUnitValue => new CSSUnitValue(value, 'rem');
+	public readonly s = (value: number): CSSUnitValue => new CSSUnitValue(value, 's');
+	public readonly turn = (value: number): CSSUnitValue => new CSSUnitValue(value, 'turn');
+	public readonly vh = (value: number): CSSUnitValue => new CSSUnitValue(value, 'vh');
+	public readonly vmax = (value: number): CSSUnitValue => new CSSUnitValue(value, 'vmax');
+	public readonly vmin = (value: number): CSSUnitValue => new CSSUnitValue(value, 'vmin');
+	public readonly vw = (value: number): CSSUnitValue => new CSSUnitValue(value, 'vw');
 
 	/**
 	 * Returns a Boolean indicating if the pair property-value, or the condition, given in parameter is supported.

package/src/css/CSSRule.ts

@@ -27,8 +27,8 @@ export default class CSSRule {
 	public [PropertySymbol.window]: BrowserWindow;
 
 	// Public properties
-	public parentRule: CSSRule = null;
-	public parentStyleSheet: CSSStyleSheet = null;
+	public parentRule: CSSRule | null = null;
+	public parentStyleSheet: CSSStyleSheet | null = null;
 	public type: CSSRuleTypeEnum | null = null;
 
 	/**

package/src/css/CSSStyleSheet.ts

@@ -15,9 +15,6 @@ export default class CSSStyleSheet {
 	// Injected by WindowContextClassExtender
 	protected declare [PropertySymbol.window]: BrowserWindow;
 
-	public value: string = null;
-	public name: string = null;
-	public namespaceURI: string = null;
 	public readonly cssRules: CSSRule[] = [];
 
 	// TODO: MediaList is not fully implemented.
@@ -25,7 +22,7 @@ export default class CSSStyleSheet {
 	public title: string;
 	public alternate: boolean;
 	public disabled: boolean;
-	#currentText: string = null;
+	#currentText: string | null = null;
 
 	/**
 	 * Constructor.

package/src/css/CSSUnitValue.ts

@@ -4,8 +4,8 @@ import CSSUnits from './CSSUnits.js';
  * CSS unit value.
  */
 export default class CSSUnitValue {
-	public unit: string = null;
-	public value: number = null;
+	public unit: string;
+	public value: number;
 
 	/**
 	 * Constructor.

package/src/css/MediaList.ts

@@ -2,6 +2,7 @@
  * MediaList interface.
  */
 export default class MediaList {
+	[index: number]: string;
 	public readonly length = 0;
 
 	/**