happy-dom 12.10.2 → 13.0.0

package/src/console/VirtualConsole.ts

@@ -15,11 +15,11 @@ export default class VirtualConsole implements Console {
 	// This is not part of the browser specs.
 	public Console: ConsoleConstructor;
 
-	private _printer: IVirtualConsolePrinter;
-	private _count: { [label: string]: number } = {};
-	private _time: { [label: string]: number } = {};
-	private _groupID = 0;
-	private _groups: IVirtualConsoleLogGroup[] = [];
+	#printer: IVirtualConsolePrinter;
+	#count: { [label: string]: number } = {};
+	#time: { [label: string]: number } = {};
+	#groupID = 0;
+	#groups: IVirtualConsoleLogGroup[] = [];
 
 	/**
 	 * Constructor.
@@ -27,7 +27,7 @@ export default class VirtualConsole implements Console {
 	 * @param printer Console printer.
 	 */
 	constructor(printer: IVirtualConsolePrinter) {
-		this._printer = printer;
+		this.#printer = printer;
 	}
 
 	/**
@@ -38,11 +38,11 @@ export default class VirtualConsole implements Console {
 	 */
 	public assert(assertion: boolean, ...args: Array<object | string>): void {
 		if (!assertion) {
-			this._printer.print({
+			this.#printer.print({
 				type: VirtualConsoleLogTypeEnum.assert,
 				level: VirtualConsoleLogLevelEnum.error,
 				message: ['Assertion failed:', ...args],
-				group: this._groups[this._groups.length - 1] || null
+				group: this.#groups[this.#groups.length - 1] || null
 			});
 		}
 	}
@@ -51,7 +51,7 @@ export default class VirtualConsole implements Console {
 	 * Clears the console.
 	 */
 	public clear(): void {
-		this._printer.clear();
+		this.#printer.clear();
 	}
 
 	/**
@@ -60,17 +60,17 @@ export default class VirtualConsole implements Console {
 	 * @param [label='default'] Label.
 	 */
 	public count(label = 'default'): void {
-		if (!this._count[label]) {
-			this._count[label] = 0;
+		if (!this.#count[label]) {
+			this.#count[label] = 0;
 		}
 
-		this._count[label]++;
+		this.#count[label]++;
 
-		this._printer.print({
+		this.#printer.print({
 			type: VirtualConsoleLogTypeEnum.count,
 			level: VirtualConsoleLogLevelEnum.info,
-			message: [`${label}: ${this._count[label]}`],
-			group: this._groups[this._groups.length - 1] || null
+			message: [`${label}: ${this.#count[label]}`],
+			group: this.#groups[this.#groups.length - 1] || null
 		});
 	}
 
@@ -80,13 +80,13 @@ export default class VirtualConsole implements Console {
 	 * @param [label='default'] Label.
 	 */
 	public countReset(label = 'default'): void {
-		delete this._count[label];
+		delete this.#count[label];
 
-		this._printer.print({
+		this.#printer.print({
 			type: VirtualConsoleLogTypeEnum.countReset,
 			level: VirtualConsoleLogLevelEnum.warn,
 			message: [`${label}: 0`],
-			group: this._groups[this._groups.length - 1] || null
+			group: this.#groups[this.#groups.length - 1] || null
 		});
 	}
 
@@ -96,11 +96,11 @@ export default class VirtualConsole implements Console {
 	 * @param args Arguments.
 	 */
 	public debug(...args: Array<object | string>): void {
-		this._printer.print({
+		this.#printer.print({
 			type: VirtualConsoleLogTypeEnum.debug,
 			level: VirtualConsoleLogLevelEnum.log,
 			message: args,
-			group: this._groups[this._groups.length - 1] || null
+			group: this.#groups[this.#groups.length - 1] || null
 		});
 	}
 
@@ -110,11 +110,11 @@ export default class VirtualConsole implements Console {
 	 * @param data Data.
 	 */
 	public dir(data: object): void {
-		this._printer.print({
+		this.#printer.print({
 			type: VirtualConsoleLogTypeEnum.dir,
 			level: VirtualConsoleLogLevelEnum.log,
 			message: [data],
-			group: this._groups[this._groups.length - 1] || null
+			group: this.#groups[this.#groups.length - 1] || null
 		});
 	}
 
@@ -124,11 +124,11 @@ export default class VirtualConsole implements Console {
 	 * @param data Data.
 	 */
 	public dirxml(data: object): void {
-		this._printer.print({
+		this.#printer.print({
 			type: VirtualConsoleLogTypeEnum.dirxml,
 			level: VirtualConsoleLogLevelEnum.log,
 			message: [data],
-			group: this._groups[this._groups.length - 1] || null
+			group: this.#groups[this.#groups.length - 1] || null
 		});
 	}
 
@@ -138,11 +138,11 @@ export default class VirtualConsole implements Console {
 	 * @param args Arguments.
 	 */
 	public error(...args: Array<object | string>): void {
-		this._printer.print({
+		this.#printer.print({
 			type: VirtualConsoleLogTypeEnum.error,
 			level: VirtualConsoleLogLevelEnum.error,
 			message: args,
-			group: this._groups[this._groups.length - 1] || null
+			group: this.#groups[this.#groups.length - 1] || null
 		});
 	}
 
@@ -163,15 +163,15 @@ export default class VirtualConsole implements Console {
 	 * @param [label] Label.
 	 */
 	public group(label?: string): void {
-		this._groupID++;
+		this.#groupID++;
 		const group = {
-			id: this._groupID,
+			id: this.#groupID,
 			label: label || 'default',
 			collapsed: false,
-			parent: this._groups[this._groups.length - 1] || null
+			parent: this.#groups[this.#groups.length - 1] || null
 		};
-		this._groups.push(group);
-		this._printer.print({
+		this.#groups.push(group);
+		this.#printer.print({
 			type: VirtualConsoleLogTypeEnum.group,
 			level: VirtualConsoleLogLevelEnum.log,
 			message: [label || 'default'],
@@ -185,15 +185,15 @@ export default class VirtualConsole implements Console {
 	 * @param [label] Label.
 	 */
 	public groupCollapsed(label?: string): void {
-		this._groupID++;
+		this.#groupID++;
 		const group = {
-			id: this._groupID,
+			id: this.#groupID,
 			label: label || 'default',
 			collapsed: true,
-			parent: this._groups[this._groups.length - 1] || null
+			parent: this.#groups[this.#groups.length - 1] || null
 		};
-		this._groups.push(group);
-		this._printer.print({
+		this.#groups.push(group);
+		this.#printer.print({
 			type: VirtualConsoleLogTypeEnum.groupCollapsed,
 			level: VirtualConsoleLogLevelEnum.log,
 			message: [label || 'default'],
@@ -205,10 +205,10 @@ export default class VirtualConsole implements Console {
 	 * Exits the current inline group in the console.
 	 */
 	public groupEnd(): void {
-		if (this._groups.length === 0) {
+		if (this.#groups.length === 0) {
 			return;
 		}
-		this._groups.pop();
+		this.#groups.pop();
 	}
 
 	/**
@@ -216,11 +216,11 @@ export default class VirtualConsole implements Console {
 	 * @param args
 	 */
 	public info(...args: Array<object | string>): void {
-		this._printer.print({
+		this.#printer.print({
 			type: VirtualConsoleLogTypeEnum.info,
 			level: VirtualConsoleLogLevelEnum.info,
 			message: args,
-			group: this._groups[this._groups.length - 1] || null
+			group: this.#groups[this.#groups.length - 1] || null
 		});
 	}
 
@@ -230,11 +230,11 @@ export default class VirtualConsole implements Console {
 	 * @param args Arguments.
 	 */
 	public log(...args: Array<object | string>): void {
-		this._printer.print({
+		this.#printer.print({
 			type: VirtualConsoleLogTypeEnum.log,
 			level: VirtualConsoleLogLevelEnum.log,
 			message: args,
-			group: this._groups[this._groups.length - 1] || null
+			group: this.#groups[this.#groups.length - 1] || null
 		});
 	}
 
@@ -262,11 +262,11 @@ export default class VirtualConsole implements Console {
 	 * @param data Data.
 	 */
 	public table(data: { [key: string]: number | string | boolean } | string[]): void {
-		this._printer.print({
+		this.#printer.print({
 			type: VirtualConsoleLogTypeEnum.table,
 			level: VirtualConsoleLogLevelEnum.log,
 			message: [data],
-			group: this._groups[this._groups.length - 1] || null
+			group: this.#groups[this.#groups.length - 1] || null
 		});
 	}
 
@@ -276,7 +276,7 @@ export default class VirtualConsole implements Console {
 	 * @param [label=default] Label.
 	 */
 	public time(label = 'default'): void {
-		this._time[label] = PerfHooks.performance.now();
+		this.#time[label] = PerfHooks.performance.now();
 	}
 
 	/**
@@ -286,14 +286,14 @@ export default class VirtualConsole implements Console {
 	 * @param [label=default] Label.
 	 */
 	public timeEnd(label = 'default'): void {
-		const time = this._time[label];
+		const time = this.#time[label];
 		if (time) {
 			const duration = PerfHooks.performance.now() - time;
-			this._printer.print({
+			this.#printer.print({
 				type: VirtualConsoleLogTypeEnum.timeEnd,
 				level: VirtualConsoleLogLevelEnum.info,
 				message: [`${label}: ${duration}ms - timer ended`],
-				group: this._groups[this._groups.length - 1] || null
+				group: this.#groups[this.#groups.length - 1] || null
 			});
 		}
 	}
@@ -306,14 +306,14 @@ export default class VirtualConsole implements Console {
 	 * @param [args] Arguments.
 	 */
 	public timeLog(label = 'default', ...args: Array<object | string>): void {
-		const time = this._time[label];
+		const time = this.#time[label];
 		if (time) {
 			const duration = PerfHooks.performance.now() - time;
-			this._printer.print({
+			this.#printer.print({
 				type: VirtualConsoleLogTypeEnum.timeLog,
 				level: VirtualConsoleLogLevelEnum.info,
 				message: [`${label}: ${duration}ms`, ...args],
-				group: this._groups[this._groups.length - 1] || null
+				group: this.#groups[this.#groups.length - 1] || null
 			});
 		}
 	}
@@ -333,11 +333,11 @@ export default class VirtualConsole implements Console {
 	 * @param args Arguments.
 	 */
 	public trace(...args: Array<object | string>): void {
-		this._printer.print({
+		this.#printer.print({
 			type: VirtualConsoleLogTypeEnum.trace,
 			level: VirtualConsoleLogLevelEnum.log,
 			message: [...args, new Error('stack').stack.replace('Error: stack', '')],
-			group: this._groups[this._groups.length - 1] || null
+			group: this.#groups[this.#groups.length - 1] || null
 		});
 	}
 
@@ -347,11 +347,11 @@ export default class VirtualConsole implements Console {
 	 * @param args Arguments.
 	 */
 	public warn(...args: Array<object | string>): void {
-		this._printer.print({
+		this.#printer.print({
 			type: VirtualConsoleLogTypeEnum.warn,
 			level: VirtualConsoleLogLevelEnum.warn,
 			message: args,
-			group: this._groups[this._groups.length - 1] || null
+			group: this.#groups[this.#groups.length - 1] || null
 		});
 	}
 }

package/src/console/VirtualConsolePrinter.ts

@@ -8,8 +8,8 @@ import IVirtualConsolePrinter from './types/IVirtualConsolePrinter.js';
  * Virtual console printer.
  */
 export default class VirtualConsolePrinter implements IVirtualConsolePrinter {
-	private _logEntries: IVirtualConsoleLogEntry[] = [];
-	private _listeners: {
+	#logEntries: IVirtualConsoleLogEntry[] = [];
+	#listeners: {
 		print: Array<(event: Event) => void>;
 		clear: Array<(event: Event) => void>;
 	} = { print: [], clear: [] };
@@ -20,7 +20,7 @@ export default class VirtualConsolePrinter implements IVirtualConsolePrinter {
 	 * @param logEntry Log entry.
 	 */
 	public print(logEntry: IVirtualConsoleLogEntry): void {
-		this._logEntries.push(logEntry);
+		this.#logEntries.push(logEntry);
 		this.dispatchEvent(new Event('print'));
 	}
 
@@ -28,7 +28,7 @@ export default class VirtualConsolePrinter implements IVirtualConsolePrinter {
 	 * Clears the output.
 	 */
 	public clear(): void {
-		this._logEntries = [];
+		this.#logEntries = [];
 		this.dispatchEvent(new Event('clear'));
 	}
 
@@ -39,10 +39,10 @@ export default class VirtualConsolePrinter implements IVirtualConsolePrinter {
 	 * @param listener Listener.
 	 */
 	public addEventListener(eventType: 'print' | 'clear', listener: (event: Event) => void): void {
-		if (!this._listeners[eventType]) {
+		if (!this.#listeners[eventType]) {
 			throw new Error(`Event type "${eventType}" is not supported.`);
 		}
-		this._listeners[eventType].push(listener);
+		this.#listeners[eventType].push(listener);
 	}
 
 	/**
@@ -52,12 +52,12 @@ export default class VirtualConsolePrinter implements IVirtualConsolePrinter {
 	 * @param listener Listener.
 	 */
 	public removeEventListener(eventType: 'print' | 'clear', listener: (event: Event) => void): void {
-		if (!this._listeners[eventType]) {
+		if (!this.#listeners[eventType]) {
 			throw new Error(`Event type "${eventType}" is not supported.`);
 		}
-		const index = this._listeners[eventType].indexOf(listener);
+		const index = this.#listeners[eventType].indexOf(listener);
 		if (index !== -1) {
-			this._listeners[eventType].splice(index, 1);
+			this.#listeners[eventType].splice(index, 1);
 		}
 	}
 
@@ -67,10 +67,10 @@ export default class VirtualConsolePrinter implements IVirtualConsolePrinter {
 	 * @param event Event.
 	 */
 	public dispatchEvent(event: Event): void {
-		if (!this._listeners[event.type]) {
+		if (!this.#listeners[event.type]) {
 			throw new Error(`Event type "${event.type}" is not supported.`);
 		}
-		for (const listener of this._listeners[event.type]) {
+		for (const listener of this.#listeners[event.type]) {
 			listener(event);
 		}
 	}
@@ -81,8 +81,8 @@ export default class VirtualConsolePrinter implements IVirtualConsolePrinter {
 	 * @returns Console log entries.
 	 */
 	public read(): IVirtualConsoleLogEntry[] {
-		const logEntries = this._logEntries;
-		this._logEntries = [];
+		const logEntries = this.#logEntries;
+		this.#logEntries = [];
 		return logEntries;
 	}
 

package/src/console/types/IVirtualConsolePrinter.ts

@@ -54,5 +54,5 @@ export default interface IVirtualConsolePrinter {
 	 * @param [logLevel] Log level.
 	 * @returns Buffer as a string of concatenated log entries.
 	 */
-	readAsString(logLevel: VirtualConsoleLogLevelEnum): string;
+	readAsString(logLevel?: VirtualConsoleLogLevelEnum): string;
 }

package/src/cookie/CookieContainer.ts

@@ -0,0 +1,72 @@
+import URL from '../url/URL.js';
+import ICookie from './types/ICookie.js';
+import ICookieContainer from './types/ICookieContainer.js';
+import CookieExpireUtility from './urilities/CookieExpireUtility.js';
+import CookieURLUtility from './urilities/CookieURLUtility.js';
+
+/**
+ * Cookie Container.
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cookie.
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie.
+ */
+export default class CookieContainer implements ICookieContainer {
+	#cookies: ICookie[] = [];
+
+	/**
+	 * Adds cookies.
+	 *
+	 * @param cookies Cookies.
+	 */
+	public addCookies(cookies: ICookie[]): void {
+		const indexMap: { [k: string]: number } = {};
+		const getKey = (cookie: ICookie): string =>
+			`${cookie.key}-${cookie.originURL.hostname}-${
+				cookie.originURL.pathname
+			}-${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;
+		}
+
+		for (const cookie of cookies) {
+			if (cookie?.key) {
+				// Remove existing cookie with same name, domain and path.
+				const index = indexMap[getKey(cookie)];
+
+				if (index !== undefined) {
+					this.#cookies.splice(index, 1);
+				}
+
+				if (!CookieExpireUtility.hasExpired(cookie)) {
+					indexMap[getKey(cookie)] = this.#cookies.length;
+					this.#cookies.push(cookie);
+				}
+			}
+		}
+	}
+
+	/**
+	 * Returns cookies.
+	 *
+	 * @param [url] URL.
+	 * @param [httpOnly] "true" if only http cookies should be returned.
+	 * @returns Cookies.
+	 */
+	public getCookies(url: URL | null = null, httpOnly = false): ICookie[] {
+		const cookies = [];
+
+		for (const cookie of this.#cookies) {
+			if (
+				!CookieExpireUtility.hasExpired(cookie) &&
+				(!httpOnly || !cookie.httpOnly) &&
+				(!url || CookieURLUtility.cookieMatchesURL(cookie, url || cookie.originURL))
+			) {
+				cookies.push(cookie);
+			}
+		}
+
+		return cookies;
+	}
+}

package/src/cookie/types/ICookie.ts

@@ -0,0 +1,16 @@
+import CookieSameSiteEnum from '../enums/CookieSameSiteEnum.js';
+
+export default interface ICookie {
+	// Required
+	key: string;
+	value: string | null;
+	originURL: URL;
+
+	// Optional
+	domain: string;
+	path: string;
+	expires: Date | null;
+	httpOnly: boolean;
+	secure: boolean;
+	sameSite: CookieSameSiteEnum;
+}

package/src/cookie/types/ICookieContainer.ts

@@ -0,0 +1,26 @@
+import URL from '../../url/URL.js';
+import ICookie from '../types/ICookie.js';
+
+/**
+ * Cookie Container.
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Cookie.
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie.
+ */
+export default interface ICookieContainer {
+	/**
+	 * Adds cookies.
+	 *
+	 * @param cookies Cookies.
+	 */
+	addCookies(cookies: ICookie[]): void;
+
+	/**
+	 * Returns cookies.
+	 *
+	 * @param [url] URL.
+	 * @param [httpOnly] "true" if only http cookies should be returned.
+	 * @returns Cookies.
+	 */
+	getCookies(url: URL | null, httpOnly: boolean): ICookie[];
+}

package/src/cookie/urilities/CookieExpireUtility.ts

@@ -0,0 +1,16 @@
+import ICookie from '../types/ICookie.js';
+
+/**
+ * Cookie expire utility.
+ */
+export default class CookieExpireUtility {
+	/**
+	 * Returns "true" if cookie has expired.
+	 *
+	 * @param cookie Cookie.
+	 * @returns "true" if cookie has expired.
+	 */
+	public static hasExpired(cookie: ICookie): boolean {
+		return cookie.expires && cookie.expires.getTime() < Date.now();
+	}
+}

package/src/cookie/urilities/CookieStringUtility.ts

@@ -0,0 +1,116 @@
+import CookieSameSiteEnum from '../enums/CookieSameSiteEnum.js';
+import URL from '../../url/URL.js';
+import ICookie from '../types/ICookie.js';
+
+/**
+ * Cookie string.
+ */
+export default class CookieStringUtility {
+	/**
+	 * Returns cookie.
+	 *
+	 * @param originURL Origin URL.
+	 * @param cookieString Cookie string.
+	 * @returns Cookie.
+	 */
+	public static stringToCookie(originURL: URL, cookieString: string): ICookie | null {
+		const parts = cookieString.split(';');
+		const [key, value] = parts.shift().split('=');
+
+		const cookie: ICookie = {
+			// Required
+			key: key.trim(),
+			value: value ?? null,
+			originURL,
+
+			// Optional
+			domain: '',
+			path: '',
+			expires: null,
+			httpOnly: false,
+			secure: false,
+			sameSite: CookieSameSiteEnum.lax
+		};
+
+		// Invalid if key is empty.
+		if (!cookie.key) {
+			return null;
+		}
+
+		for (const part of parts) {
+			const keyAndValue = part.split('=');
+			const key = keyAndValue[0].trim().toLowerCase();
+			const value = keyAndValue[1];
+
+			switch (key) {
+				case 'expires':
+					cookie.expires = new Date(value);
+					break;
+				case 'max-age':
+					cookie.expires = new Date(parseInt(value, 10) * 1000 + Date.now());
+					break;
+				case 'domain':
+					cookie.domain = value;
+					break;
+				case 'path':
+					cookie.path = value.startsWith('/') ? value : `/${value}`;
+					break;
+				case 'httponly':
+					cookie.httpOnly = true;
+					break;
+				case 'secure':
+					cookie.secure = true;
+					break;
+				case 'samesite':
+					switch (value.toLowerCase()) {
+						case 'strict':
+							cookie.sameSite = CookieSameSiteEnum.strict;
+							break;
+						case 'lax':
+							cookie.sameSite = CookieSameSiteEnum.lax;
+							break;
+						case 'none':
+							cookie.sameSite = CookieSameSiteEnum.none;
+					}
+					break;
+			}
+		}
+
+		const lowerKey = cookie.key.toLowerCase();
+
+		// Invalid if __secure- prefix is used and cookie is not secure.
+		if (lowerKey.startsWith('__secure-') && !cookie.secure) {
+			return null;
+		}
+
+		// Invalid if __host- prefix is used and cookie is not secure, not on root path or has a domain.
+		if (
+			lowerKey.startsWith('__host-') &&
+			(!cookie.secure || cookie.path !== '/' || cookie.domain)
+		) {
+			return null;
+		}
+
+		return cookie;
+	}
+
+	/**
+	 * Returns cookie string with key and value.
+	 *
+	 * @param cookies Cookies.
+	 * @returns Cookie string.
+	 */
+	public static cookiesToString(cookies: ICookie[]): string {
+		const cookieString: string[] = [];
+
+		for (const cookie of cookies) {
+			if (cookie.value !== null) {
+				cookieString.push(`${cookie.key}=${cookie.value}`);
+			} else {
+				cookieString.push(cookie.key);
+			}
+		}
+
+		return cookieString.join('; ');
+	}
+}

package/src/cookie/urilities/CookieURLUtility.ts

@@ -0,0 +1,26 @@
+import CookieSameSiteEnum from '../enums/CookieSameSiteEnum.js';
+import URL from '../../url/URL.js';
+import ICookie from '../types/ICookie.js';
+
+/**
+ * Cookie string.
+ */
+export default class CookieURLUtility {
+	/**
+	 * Returns "true" if cookie matches URL.
+	 *
+	 * @param cookie Cookie.
+	 * @param url URL.
+	 * @returns "true" if cookie matches URL.
+	 */
+	public static cookieMatchesURL(cookie: ICookie, url: URL): boolean {
+		return (
+			(!cookie.secure || url.protocol === 'https:') &&
+			(!cookie.domain || url.hostname.endsWith(cookie.domain)) &&
+			(!cookie.path || url.pathname.startsWith(cookie.path)) &&
+			// @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie#samesitesamesite-value
+			((cookie.sameSite === CookieSameSiteEnum.none && cookie.secure) ||
+				cookie.originURL.hostname === url.hostname)
+		);
+	}
+}

package/src/css/CSSParser.ts

@@ -1,4 +1,5 @@
 import CSSRule from './CSSRule.js';
+import * as PropertySymbol from '../PropertySymbol.js';
 import CSSStyleSheet from './CSSStyleSheet.js';
 import CSSStyleRule from './rules/CSSStyleRule.js';
 import CSSKeyframeRule from './rules/CSSKeyframeRule.js';
@@ -131,7 +132,7 @@ export default class CSSParser {
 						case CSSRule.FONT_FACE_RULE:
 						case CSSRule.KEYFRAME_RULE:
 						case CSSRule.STYLE_RULE:
-							(<CSSStyleRule>parentRule)._cssText = cssText;
+							(<CSSStyleRule>parentRule)[PropertySymbol.cssText] = cssText;
 							break;
 					}
 				}