happy-dom 8.9.0 → 9.0.1

package/src/fetch/utilities/FetchRequestHeaderUtility.ts

@@ -0,0 +1,47 @@
+import Headers from '../Headers';
+import IHeaders from '../types/IHeaders';
+
+const FORBIDDEN_HEADER_NAMES = [
+	'accept-charset',
+	'accept-encoding',
+	'access-control-request-headers',
+	'access-control-request-method',
+	'connection',
+	'content-length',
+	'cookie',
+	'cookie2',
+	'date',
+	'dnt',
+	'expect',
+	'host',
+	'keep-alive',
+	'origin',
+	'referer',
+	'te',
+	'trailer',
+	'transfer-encoding',
+	'upgrade',
+	'via'
+];
+
+/**
+ * Fetch request header utility.
+ */
+export default class FetchRequestHeaderUtility {
+	/**
+	 * Validates request headers.
+	 *
+	 * @param headers Headers.
+	 */
+	public static removeForbiddenHeaders(headers: IHeaders): void {
+		for (const key of Object.keys((<Headers>headers)._entries)) {
+			if (
+				FORBIDDEN_HEADER_NAMES.includes(key) ||
+				key.startsWith('proxy-') ||
+				key.startsWith('sec-')
+			) {
+				delete (<Headers>headers)._entries[key];
+			}
+		}
+	}
+}

package/src/fetch/utilities/FetchRequestReferrerUtility.ts

@@ -0,0 +1,241 @@
+import { URL } from 'url';
+import IRequest from '../types/IRequest';
+import IDocument from '../../nodes/document/IDocument';
+import { isIP } from 'net';
+import Headers from '../Headers';
+import IRequestReferrerPolicy from '../types/IRequestReferrerPolicy';
+
+const REQUEST_REFERRER_UNSUPPORTED_PROTOCOL_REGEXP = /^(about|blob|data):$/;
+const REFERRER_POLICIES: IRequestReferrerPolicy[] = [
+	'',
+	'no-referrer',
+	'no-referrer-when-downgrade',
+	'same-origin',
+	'origin',
+	'strict-origin',
+	'origin-when-cross-origin',
+	'strict-origin-when-cross-origin',
+	'unsafe-url'
+];
+
+/**
+ * Fetch referrer utility.
+ */
+export default class FetchRequestReferrerUtility {
+	/**
+	 * Returns the request referrer to be used as the value for the "Referer" header.
+	 *
+	 * Based on:
+	 * https://github.com/node-fetch/node-fetch/blob/main/src/utils/referrer.js (MIT)
+	 *
+	 * @see https://w3c.github.io/webappsec-referrer-policy/#determine-requests-referrer
+	 * @param document Document.
+	 * @param request Request.
+	 * @returns Request referrer.
+	 */
+	public static getSentReferrer(
+		document: IDocument,
+		request: IRequest
+	): '' | 'no-referrer' | 'client' | URL {
+		if (request.referrer === 'about:client' && document.defaultView.location.origin === 'null') {
+			return 'no-referrer';
+		}
+
+		const requestURL = new URL(request.url);
+		const referrerURL =
+			request.referrer === 'about:client'
+				? new URL(document.defaultView.location.href)
+				: new URL(request.referrer);
+
+		if (REQUEST_REFERRER_UNSUPPORTED_PROTOCOL_REGEXP.test(referrerURL.protocol)) {
+			return 'no-referrer';
+		}
+
+		referrerURL.username = '';
+		referrerURL.password = '';
+		referrerURL.hash = '';
+
+		switch (request.referrerPolicy) {
+			case 'no-referrer':
+				return 'no-referrer';
+			case 'origin':
+				return new URL(referrerURL.origin);
+			case 'unsafe-url':
+				return referrerURL;
+			case 'strict-origin':
+				if (
+					this.isURLPotentiallyTrustWorthy(referrerURL) &&
+					!this.isURLPotentiallyTrustWorthy(requestURL)
+				) {
+					return 'no-referrer';
+				}
+
+				return new URL(referrerURL.origin);
+			case 'strict-origin-when-cross-origin':
+				if (referrerURL.origin === requestURL.origin) {
+					return referrerURL;
+				}
+
+				if (
+					this.isURLPotentiallyTrustWorthy(referrerURL) &&
+					!this.isURLPotentiallyTrustWorthy(requestURL)
+				) {
+					return 'no-referrer';
+				}
+
+				return new URL(referrerURL.origin);
+			case 'same-origin':
+				if (referrerURL.origin === requestURL.origin) {
+					return referrerURL;
+				}
+
+				return 'no-referrer';
+			case 'origin-when-cross-origin':
+				if (referrerURL.origin === requestURL.origin) {
+					return referrerURL;
+				}
+
+				return new URL(referrerURL.origin);
+			case 'no-referrer-when-downgrade':
+				if (
+					this.isURLPotentiallyTrustWorthy(referrerURL) &&
+					!this.isURLPotentiallyTrustWorthy(requestURL)
+				) {
+					return 'no-referrer';
+				}
+
+				return referrerURL;
+		}
+
+		return 'no-referrer';
+	}
+
+	/**
+	 * Returns initial referrer.
+	 *
+	 * @param document Document.
+	 * @param referrer Referrer.
+	 * @returns Initial referrer.
+	 */
+	public static getInitialReferrer(
+		document: IDocument,
+		referrer: '' | 'no-referrer' | 'client' | string | URL
+	): '' | 'no-referrer' | 'client' | URL {
+		if (referrer === '' || referrer === 'no-referrer' || referrer === 'client') {
+			return referrer;
+		} else if (referrer) {
+			const referrerURL = referrer instanceof URL ? referrer : new URL(referrer, document.location);
+			return referrerURL.origin === document.location.origin ? referrerURL : 'client';
+		}
+
+		return 'client';
+	}
+
+	/**
+	 * Returns referrer policy from header.
+	 *
+	 * @see https://w3c.github.io/webappsec-referrer-policy/#parse-referrer-policy-from-header
+	 * @param headers Response headers
+	 * @returns Policy.
+	 */
+	public static getReferrerPolicyFromHeader(headers: Headers): IRequestReferrerPolicy {
+		const referrerPolicyHeader = headers.get('Referrer-Policy');
+
+		if (!referrerPolicyHeader) {
+			return '';
+		}
+
+		const policyTokens = referrerPolicyHeader.split(/[,\s]+/);
+		let policy: IRequestReferrerPolicy = '';
+
+		for (const token of policyTokens) {
+			if (token && REFERRER_POLICIES.includes(<IRequestReferrerPolicy>token)) {
+				policy = <IRequestReferrerPolicy>token;
+			}
+		}
+
+		return policy;
+	}
+
+	/**
+	 * Returns "true" if the request's referrer is potentially trustworthy.
+	 *
+	 * @see https://w3c.github.io/webappsec-secure-contexts/#is-origin-trustworthy
+	 * @param url URL.
+	 * @returns "true" if the request's referrer is potentially trustworthy.
+	 */
+	private static isURLPotentiallyTrustWorthy(url: URL): boolean {
+		// 1. If url is "about:blank" or "about:srcdoc", return "Potentially Trustworthy".
+		if (/^about:(blank|srcdoc)$/.test(url.href)) {
+			return true;
+		}
+
+		// 2. If url's scheme is "data", return "Potentially Trustworthy".
+		if (url.protocol === 'data:') {
+			return true;
+		}
+
+		// Note: The origin of blob: and filesystem: URLs is the origin of the context in which they were
+		// Created. Therefore, blobs created in a trustworthy origin will themselves be potentially
+		// Trustworthy.
+		if (/^(blob|filesystem):$/.test(url.protocol)) {
+			return true;
+		}
+
+		// 3. Return the result of executing §3.2 Is origin potentially trustworthy? on url's origin.
+		return this.isOriginPotentiallyTrustWorthy(url);
+	}
+
+	/**
+	 * Returns "true" if the request's referrer origin is potentially trustworthy.
+	 *
+	 * @see https://w3c.github.io/webappsec-secure-contexts/#is-origin-trustworthy
+	 * @param url URL.
+	 * @returns "true" if the request's referrer origin is potentially trustworthy.
+	 */
+	private static isOriginPotentiallyTrustWorthy(url: URL): boolean {
+		// 1. If origin is an opaque origin, return "Not Trustworthy".
+		// Not applicable
+
+		// 2. Assert: origin is a tuple origin.
+		// Not for implementations
+
+		// 3. If origin's scheme is either "https" or "wss", return "Potentially Trustworthy".
+		if (/^(http|ws)s:$/.test(url.protocol)) {
+			return true;
+		}
+
+		// 4. If origin's host component matches one of the CIDR notations 127.0.0.0/8 or ::1/128 [RFC4632], return "Potentially Trustworthy".
+		const hostIp = url.host.replace(/(^\[)|(]$)/g, '');
+		const hostIPVersion = isIP(hostIp);
+
+		if (hostIPVersion === 4 && /^127\./.test(hostIp)) {
+			return true;
+		}
+
+		if (hostIPVersion === 6 && /^(((0+:){7})|(::(0+:){0,6}))0*1$/.test(hostIp)) {
+			return true;
+		}
+
+		// 5. If origin's host component is "localhost" or falls within ".localhost", and the user agent conforms to the name resolution rules in [let-localhost-be-localhost], return "Potentially Trustworthy".
+		// We are returning FALSE here because we cannot ensure conformance to
+		// Let-localhost-be-loalhost (https://tools.ietf.org/html/draft-west-let-localhost-be-localhost)
+		if (url.host === 'localhost' || url.host.endsWith('.localhost')) {
+			return false;
+		}
+
+		// 6. If origin's scheme component is file, return "Potentially Trustworthy".
+		if (url.protocol === 'file:') {
+			return true;
+		}
+
+		// 7. If origin's scheme component is one which the user agent considers to be authenticated, return "Potentially Trustworthy".
+		// Not supported
+
+		// 8. If origin has been configured as a trustworthy origin, return "Potentially Trustworthy".
+		// Not supported
+
+		// 9. Return "Not Trustworthy".
+		return false;
+	}
+}

package/src/fetch/utilities/FetchRequestValidationUtility.ts

@@ -0,0 +1,82 @@
+import DOMException from '../../exception/DOMException';
+import DOMExceptionNameEnum from '../../exception/DOMExceptionNameEnum';
+import IRequestReferrerPolicy from '../types/IRequestReferrerPolicy';
+import IRequestRedirect from '../types/IRequestRedirect';
+import { URL } from 'url';
+import IRequest from '../types/IRequest';
+
+const VALID_REFERRER_POLICIES = [
+	'',
+	'no-referrer',
+	'no-referrer-when-downgrade',
+	'same-origin',
+	'origin',
+	'strict-origin',
+	'origin-when-cross-origin',
+	'strict-origin-when-cross-origin',
+	'unsafe-url'
+];
+
+const VALID_REDIRECTS = ['error', 'manual', 'follow'];
+
+/**
+ * Fetch request validation utility.
+ */
+export default class FetchRequestValidationUtility {
+	/**
+	 * Validates request body.
+	 *
+	 * @throws DOMException
+	 * @param request Request.
+	 */
+	public static validateBody(request: IRequest): void {
+		if (request.body && (request.method === 'GET' || request.method === 'HEAD')) {
+			throw new DOMException(
+				`Request with GET/HEAD method cannot have body.`,
+				DOMExceptionNameEnum.invalidStateError
+			);
+		}
+	}
+
+	/**
+	 * Validates request URL.
+	 *
+	 * @throws DOMException
+	 * @param url URL.
+	 */
+	public static validateURL(url: URL): void {
+		if (url.username !== '' || url.password !== '') {
+			throw new DOMException(
+				`${url} is an url with embedded credentials.`,
+				DOMExceptionNameEnum.notSupportedError
+			);
+		}
+	}
+
+	/**
+	 * Validates request referrer policy.
+	 *
+	 * @throws DOMException
+	 * @param referrerPolicy Referrer policy.
+	 */
+	public static validateReferrerPolicy(referrerPolicy: IRequestReferrerPolicy): void {
+		if (!VALID_REFERRER_POLICIES.includes(referrerPolicy)) {
+			throw new DOMException(
+				`Invalid referrer policy "${referrerPolicy}".`,
+				DOMExceptionNameEnum.syntaxError
+			);
+		}
+	}
+
+	/**
+	 * Validates request redirect.
+	 *
+	 * @throws DOMException
+	 * @param redirect Redirect.
+	 */
+	public static validateRedirect(redirect: IRequestRedirect): void {
+		if (!VALID_REDIRECTS.includes(redirect)) {
+			throw new DOMException(`Invalid redirect "${redirect}".`, DOMExceptionNameEnum.syntaxError);
+		}
+	}
+}

package/src/file/Blob.ts

@@ -8,7 +8,7 @@ import IBlob from './IBlob';
  * https://github.com/jsdom/jsdom/blob/master/lib/jsdom/living/file-api/Blob-impl.js (MIT licensed).
  */
 export default class Blob implements IBlob {
-	public readonly _buffer: Buffer = null;
+	public _buffer: Buffer = null;
 	public readonly type: string = '';
 
 	/**
@@ -136,7 +136,7 @@ export default class Blob implements IBlob {
 	}
 
 	/**
-	 * Closes the blob.
+	 * Returns the object converted to string.
 	 *
 	 * @returns String.
 	 */

package/src/file/File.ts

@@ -21,7 +21,11 @@ export default class File extends Blob {
 	 * @param [options.lastModifier] Last modified. Defaults to Date.now().
 	 * @param options.lastModified
 	 */
-	constructor(bits, name, options?: { type?: string; lastModified?: number }) {
+	constructor(
+		bits: (ArrayBuffer | ArrayBufferView | Blob | Buffer | string)[],
+		name: string,
+		options?: { type?: string; lastModified?: number }
+	) {
 		super(bits, options);
 
 		this.name = name.replace(/\//g, ':');

package/src/form-data/FormData.ts

@@ -0,0 +1,237 @@
+import Blob from '../file/Blob';
+import File from '../file/File';
+import IHTMLInputElement from '../nodes/html-input-element/IHTMLInputElement';
+import IHTMLFormElement from '../nodes/html-form-element/IHTMLFormElement';
+import HTMLFormControlsCollection from '../nodes/html-form-element/HTMLFormControlsCollection';
+import IHTMLTextAreaElement from '../nodes/html-text-area-element/IHTMLTextAreaElement';
+import IHTMLSelectElement from '../nodes/html-select-element/IHTMLSelectElement';
+import IHTMLButtonElement from '../nodes/html-button-element/IHTMLButtonElement';
+
+type FormDataEntry = {
+	name: string;
+	value: string | File;
+};
+
+const SUBMITTABLE_ELEMENTS = ['BUTTON', 'INPUT', 'OBJECT', 'SELECT', 'TEXTAREA'];
+
+/**
+ * FormData.
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/API/FormData
+ */
+export default class FormData implements Iterable<[string, string | File]> {
+	private _entries: FormDataEntry[] = [];
+
+	/**
+	 * Constructor.
+	 *
+	 * @param [form] Form.
+	 */
+	constructor(form?: IHTMLFormElement) {
+		if (form) {
+			for (const name of Object.keys((<HTMLFormControlsCollection>form.elements)._namedItems)) {
+				const radioNodeList = (<HTMLFormControlsCollection>form.elements)._namedItems[name];
+				let element:
+					| IHTMLInputElement
+					| IHTMLTextAreaElement
+					| IHTMLSelectElement
+					| IHTMLButtonElement = radioNodeList[0];
+
+				if (radioNodeList.length > 1) {
+					for (const radioNode of radioNodeList) {
+						if (radioNode.checked) {
+							element = radioNode;
+						}
+					}
+				}
+
+				if (element.name && SUBMITTABLE_ELEMENTS.includes(element.tagName)) {
+					if (element.tagName === 'INPUT' && element.type === 'file') {
+						if ((<IHTMLInputElement>element).files.length === 0) {
+							this.append(element.name, new File([], '', { type: 'application/octet-stream' }));
+						} else {
+							for (const file of (<IHTMLInputElement>element).files) {
+								this.append(element.name, file);
+							}
+						}
+					} else {
+						this.append(element.name, element.value);
+					}
+				}
+			}
+		}
+	}
+
+	/**
+	 * For each.
+	 *
+	 * @param callback Callback.
+	 */
+	public forEach(callback: (key: string, value: string | File, thisArg: FormData) => void): void {
+		for (const entry of this._entries) {
+			callback.call(this, entry.name, entry.value, this);
+		}
+	}
+
+	/**
+	 * Appends a new value onto an existing key.
+	 *
+	 * @param name Name.
+	 * @param value Value.
+	 * @param [filename] Filename.
+	 */
+	public append(name: string, value: string | Blob | File, filename?: string): void {
+		this._entries.push({
+			name,
+			value: this._parseValue(value, filename)
+		});
+	}
+
+	/**
+	 * Removes a value.
+	 *
+	 * @param name Name.
+	 */
+	public delete(name: string): void {
+		const newEntries: FormDataEntry[] = [];
+		for (const entry of this._entries) {
+			if (entry.name !== name) {
+				newEntries.push(entry);
+			}
+		}
+		this._entries = newEntries;
+	}
+
+	/**
+	 * Returns value.
+	 *
+	 * @param name Name.
+	 * @returns Value.
+	 */
+	public get(name: string): string | File | null {
+		for (const entry of this._entries) {
+			if (entry.name === name) {
+				return entry.value;
+			}
+		}
+		return null;
+	}
+
+	/**
+	 * Returns all values associated with the given name.
+	 *
+	 * @param name Name.
+	 * @returns Values.
+	 */
+	public getAll(name: string): Array<string | File> {
+		const values: Array<string | File> = [];
+		for (const entry of this._entries) {
+			if (entry.name === name) {
+				values.push(entry.value);
+			}
+		}
+		return values;
+	}
+
+	/**
+	 * Returns whether a FormData object contains a certain key.
+	 *
+	 * @param name Name.
+	 * @returns "true" if the FormData object contains the key.
+	 */
+	public has(name: string): boolean {
+		for (const entry of this._entries) {
+			if (entry.name === name) {
+				return true;
+			}
+		}
+		return false;
+	}
+
+	/**
+	 * Sets a new value for an existing key inside a FormData object, or adds the key/value if it does not already exist.
+	 *
+	 * @param name Name.
+	 * @param value Value.
+	 * @param [filename] Filename.
+	 */
+	public set(name: string, value: string | Blob | File, filename?: string): void {
+		for (const entry of this._entries) {
+			if (entry.name === name) {
+				entry.value = this._parseValue(value, filename);
+				return;
+			}
+		}
+		this.append(name, value);
+	}
+
+	/**
+	 * Returns an iterator, allowing you to go through all keys of the key/value pairs contained in this object.
+	 *
+	 * @returns Iterator.
+	 */
+	public *keys(): IterableIterator<string> {
+		for (const entry of this._entries) {
+			yield entry.name;
+		}
+	}
+
+	/**
+	 * Returns an iterator, allowing you to go through all values of the key/value pairs contained in this object.
+	 *
+	 * @returns Iterator.
+	 */
+	public *values(): IterableIterator<string | File> {
+		for (const entry of this._entries) {
+			yield entry.value;
+		}
+	}
+
+	/**
+	 * Returns an iterator, allowing you to go through all key/value pairs contained in this object.
+	 *
+	 * @returns Iterator.
+	 */
+	public *entries(): IterableIterator<[string, string | File]> {
+		for (const entry of this._entries) {
+			yield [entry.name, entry.value];
+		}
+	}
+
+	/**
+	 * Iterator.
+	 *
+	 * @returns Iterator.
+	 */
+	public *[Symbol.iterator](): IterableIterator<[string, string | File]> {
+		for (const entry of this._entries) {
+			yield [entry.name, entry.value];
+		}
+	}
+
+	/**
+	 * Parses a value.
+	 *
+	 * @param value Value.
+	 * @param [filename] Filename.
+	 * @returns Parsed value.
+	 */
+	private _parseValue(value: string | Blob | File, filename?: string): string | File {
+		if (value instanceof Blob && !(value instanceof File)) {
+			const file = new File([], 'blob', { type: value.type });
+			file._buffer = value._buffer;
+			return file;
+		}
+
+		if (value instanceof File) {
+			if (filename) {
+				const file = new File([], filename, { type: value.type, lastModified: value.lastModified });
+				file._buffer = value._buffer;
+				return file;
+			}
+			return value;
+		}
+
+		return String(value);
+	}
+}

package/src/index.ts

@@ -50,6 +50,9 @@ import SVGDocument from './nodes/svg-document/SVGDocument';
 import Element from './nodes/element/Element';
 import IElement from './nodes/element/IElement';
 import IHTMLCollection from './nodes/element/IHTMLCollection';
+import HTMLCollection from './nodes/element/HTMLCollection';
+import HTMLFormControlsCollection from './nodes/html-form-element/HTMLFormControlsCollection';
+import IHTMLFormControlsCollection from './nodes/html-form-element/IHTMLFormControlsCollection';
 import HTMLElement from './nodes/html-element/HTMLElement';
 import IHTMLElement from './nodes/html-element/IHTMLElement';
 import HTMLTemplateElement from './nodes/html-template-element/HTMLTemplateElement';
@@ -115,6 +118,7 @@ import CSSKeyframeRule from './css/rules/CSSKeyframeRule';
 import CSSKeyframesRule from './css/rules/CSSKeyframesRule';
 import CSSMediaRule from './css/rules/CSSMediaRule';
 import CSSStyleRule from './css/rules/CSSStyleRule';
+import CSSSupportsRule from './css/rules/CSSSupportsRule';
 import Storage from './storage/Storage';
 import DOMRect from './nodes/element/DOMRect';
 import Selection from './selection/Selection';
@@ -127,6 +131,15 @@ import ProcessingInstruction from './nodes/processing-instruction/ProcessingInst
 import IProcessingInstruction from './nodes/processing-instruction/IProcessingInstruction';
 import FileList from './nodes/html-input-element/FileList';
 import IFileList from './nodes/html-input-element/IFileList';
+import AbortController from './fetch/AbortController';
+import AbortSignal from './fetch/AbortSignal';
+import Request from './fetch/Request';
+import IRequest from './fetch/types/IRequest';
+import Response from './fetch/Response';
+import IResponse from './fetch/types/IResponse';
+import Headers from './fetch/Headers';
+import IHeaders from './fetch/types/IHeaders';
+import FormData from './form-data/FormData';
 
 export {
 	GlobalWindow,
@@ -181,6 +194,9 @@ export {
 	Element,
 	IElement,
 	IHTMLCollection,
+	HTMLCollection,
+	HTMLFormControlsCollection,
+	IHTMLFormControlsCollection,
 	HTMLElement,
 	IHTMLElement,
 	HTMLTemplateElement,
@@ -246,6 +262,7 @@ export {
 	CSSKeyframesRule,
 	CSSMediaRule,
 	CSSStyleRule,
+	CSSSupportsRule,
 	Storage,
 	DOMRect,
 	URLSearchParams,
@@ -258,5 +275,14 @@ export {
 	ProcessingInstruction,
 	IProcessingInstruction,
 	FileList,
-	IFileList
+	IFileList,
+	AbortController,
+	AbortSignal,
+	Request,
+	IRequest,
+	Response,
+	IResponse,
+	Headers,
+	IHeaders,
+	FormData
 };