@happy-dom/server-renderer 20.0.10 → 20.1.0

package/src/types/IOptionalServerRendererConfiguration.ts

@@ -1,32 +1,39 @@
 import type IOptionalBrowserSettings from 'happy-dom/lib/browser/types/IOptionalBrowserSettings.js';
 import ServerRendererLogLevelEnum from '../enums/ServerRendererLogLevelEnum.js';
 import IServerRendererItem from './IServerRendererItem.js';
+import ServerRendererModeEnum from '../enums/ServerRendererModeEnum.js';
 
 export default interface IOptionalServerRendererConfiguration {
 	/**
 	 * Settings for the browser.
 	 */
 	browser?: IOptionalBrowserSettings;
+
 	/**
 	 * Log level for the server renderer.
 	 */
 	logLevel?: ServerRendererLogLevelEnum;
+
 	/**
 	 * Enables debugging. This will override "browser.debug.traceWaitUntilComplete".
 	 */
 	debug?: boolean;
+
 	/**
 	 * Enables inspector.
 	 */
 	inspect?: boolean;
+
 	/**
 	 * Shows help information and exits.
 	 */
 	help?: boolean;
+
 	/**
 	 * Output directory.
 	 */
 	outputDirectory?: string;
+
 	/**
 	 * Cache settings.
 	 */
@@ -44,6 +51,7 @@ export default interface IOptionalServerRendererConfiguration {
 		 */
 		warmup?: boolean;
 	};
+
 	/**
 	 * Settings for the worker.
 	 */
@@ -57,6 +65,7 @@ export default interface IOptionalServerRendererConfiguration {
 		 */
 		maxConcurrency?: number;
 	};
+
 	/**
 	 * Settings for rendering.
 	 */
@@ -89,11 +98,21 @@ export default interface IOptionalServerRendererConfiguration {
 		 * Disable polyfills used for unimplemented functionality.
 		 */
 		disablePolyfills?: boolean;
+		/**
+		 * Setup script to be injected before rendering.
+		 */
+		setupScript?: string | null;
+		/**
+		 * Rendering mode.
+		 */
+		mode?: ServerRendererModeEnum;
 	};
+
 	/**
-	 * List of URLs to render.
+	 * List render items. Each item can be a URL string or an object specifying the URL or HTML string along with additional options.
 	 */
-	urls?: Array<string | IServerRendererItem> | null;
+	renderItems?: Array<string | IServerRendererItem> | null;
+
 	/**
 	 * Proxy server settings.
 	 */

package/src/types/IServerRendererConfiguration.ts

@@ -1,24 +1,29 @@
 import type IBrowserSettings from 'happy-dom/lib/browser/types/IBrowserSettings.js';
 import ServerRendererLogLevelEnum from '../enums/ServerRendererLogLevelEnum.js';
 import IServerRendererItem from './IServerRendererItem.js';
+import ServerRendererModeEnum from '../enums/ServerRendererModeEnum.js';
 
 export default interface IServerRendererConfiguration {
 	/**
 	 * Settings for the browser.
 	 */
 	browser: IBrowserSettings;
+
 	/**
 	 * Log level for the server renderer.
 	 */
 	logLevel: ServerRendererLogLevelEnum;
+
 	/**
 	 * Enables debugging. This will override "browser.debug.traceWaitUntilComplete".
 	 */
 	debug: boolean;
+
 	/**
 	 * Enables inspector.
 	 */
 	inspect: boolean;
+
 	/**
 	 * Shows help information and exits.
 	 */
@@ -27,6 +32,7 @@ export default interface IServerRendererConfiguration {
 	 * Output directory.
 	 */
 	outputDirectory: string;
+
 	/**
 	 * Cache settings.
 	 */
@@ -44,6 +50,7 @@ export default interface IServerRendererConfiguration {
 		 */
 		warmup: boolean;
 	};
+
 	/**
 	 * Settings for the worker.
 	 */
@@ -57,6 +64,7 @@ export default interface IServerRendererConfiguration {
 		 */
 		maxConcurrency: number;
 	};
+
 	/**
 	 * Settings for rendering.
 	 */
@@ -89,11 +97,21 @@ export default interface IServerRendererConfiguration {
 		 * Disable polyfills used for unimplemented functionality.
 		 */
 		disablePolyfills: boolean;
+		/**
+		 * Setup script to be injected before rendering.
+		 */
+		setupScript: string | null;
+		/**
+		 * Rendering mode.
+		 */
+		mode: ServerRendererModeEnum;
 	};
+
 	/**
-	 * List of URLs to render.
+	 * List render items. Each item can be a URL string or an object specifying the URL or HTML string along with additional options.
 	 */
-	urls: Array<string | IServerRendererItem> | null;
+	renderItems: Array<string | IServerRendererItem> | null;
+
 	/**
 	 * Proxy server settings.
 	 */

package/src/types/IServerRendererItem.ts

@@ -1,5 +1,6 @@
 export default interface IServerRendererItem {
-	url: string;
+	url?: string;
+	html?: string;
 	outputFile?: string | null;
 	headers?: string[][] | { [key: string]: string } | null;
 }

package/src/types/IServerRendererResult.ts

@@ -1,9 +1,9 @@
 export default interface IServerRendererResult {
-	url: string;
+	url: string | null;
 	content: string | null;
-	status: number;
-	statusText: string;
-	headers: { [key: string]: string };
+	status: number | null;
+	statusText: string | null;
+	headers: { [key: string]: string } | null;
 	outputFile: string | null;
 	error: string | null;
 	pageErrors: string[];

package/src/utilities/BrowserWindowPolyfill.ts

@@ -73,11 +73,12 @@ export default class BrowserWindowPolyfill {
 			bufferSubData: () => {},
 			drawElementsInstanced: () => {}
 		});
-		(<any>window).Worker = class {
+		(<any>window).Worker = class Worker {
 			public postMessage(): any {}
 			public terminate(): any {}
 		};
-		(<any>window).Path2D = class {
+
+		(<any>window).Path2D = class Path2D {
 			public addPath(): any {}
 			public addPath2D(): any {}
 			public closePath(): any {}

package/src/utilities/HelpPrinterRows.ts

@@ -126,15 +126,15 @@ export default [
 		'1'
 	],
 	[
-		'--browser.disableJavaScriptEvaluation',
-		'',
+		'--browser.enableJavaScriptEvaluation',
+		'--javaScript, --javascript, -j',
 		'boolean',
-		'Disables JavaScript evaluation.',
+		'Enables JavaScript evaluation.',
 		'false'
 	],
 	[
 		'--browser.suppressInsecureJavaScriptEnvironmentWarning',
-		'',
+		'--suppressJavaScriptWarning, -sj',
 		'boolean',
 		'Suppresses the warning that is printed when code generation from strings is enabled at process level',
 		'false'
@@ -198,6 +198,27 @@ export default [
 		'Setup a virtual server. E.g. -vs="^https://e.com/[a-z]{2}/|./build"',
 		''
 	],
+	[
+		'--browser.module.resolveNodeModules.directory=<path>',
+		'',
+		'string',
+		'Directory to resolve node modules from.',
+		''
+	],
+	[
+		'--browser.module.resolveNodeModules.url=<url>',
+		'',
+		'string',
+		'URL to resolve node modules to.',
+		''
+	],
+	[
+		'--browser.module.resolveNodeModules.mainFields=<fields>',
+		'',
+		'string[]',
+		'Comma-separated list of main fields to use when resolving node modules.',
+		''
+	],
 	[
 		'--browser.navigation.disableMainFrameNavigation',
 		'',

package/src/utilities/ProcessArgumentsParser.ts

@@ -1,9 +1,9 @@
-import DefaultServerRendererConfiguration from '../config/DefaultServerRendererConfiguration.js';
 import IServerRendererConfiguration from '../types/IServerRendererConfiguration.js';
 import IServerRendererItem from '../types/IServerRendererItem.js';
 import Path from 'path';
 import { BrowserNavigationCrossOriginPolicyEnum } from 'happy-dom';
 import ServerRendererLogLevelEnum from '../enums/ServerRendererLogLevelEnum.js';
+import ServerRendererConfigurationFactory from './ServerRendererConfigurationFactory.js';
 
 /**
  * CLI process arguments parser.
@@ -15,33 +15,72 @@ export default class ProcessArgumentsParser {
 	 * @param args Arguments.
 	 */
 	public static async getConfiguration(args: string[]): Promise<IServerRendererConfiguration> {
-		let config: IServerRendererConfiguration = JSON.parse(
-			JSON.stringify(DefaultServerRendererConfiguration)
-		);
+		let config: IServerRendererConfiguration =
+			ServerRendererConfigurationFactory.createConfiguration();
 
 		for (const arg of args) {
 			if (arg[0] === '-') {
 				if (arg.startsWith('--config=') || arg.startsWith('-c=')) {
-					config = (await import(Path.resolve(this.stripQuotes(arg.split('=')[1])))).default;
+					config = ServerRendererConfigurationFactory.createConfiguration(
+						(await import(Path.resolve(this.stripQuotes(arg.split('=')[1])))).default
+					);
 
-					if (config.urls) {
-						const newUrls: IServerRendererItem[] = [];
-						for (const urlItem of config.urls) {
-							const isString = typeof urlItem === 'string';
-							const url = new URL(isString ? urlItem : urlItem.url);
-							newUrls.push({
-								url: url.href,
-								outputFile: this.getOutputFile(url),
-								headers: isString ? null : (<IServerRendererItem>urlItem).headers || null
-							});
+					if (config.renderItems) {
+						const newRenderItems: IServerRendererItem[] = [];
+						for (const renderItem of config.renderItems) {
+							if (typeof renderItem === 'string') {
+								const url = new URL(renderItem);
+								newRenderItems.push({
+									url: url.href,
+									outputFile: this.getOutputFile(url)
+								});
+							} else {
+								if (renderItem.url) {
+									const url = new URL(renderItem.url);
+									const newRenderItem: IServerRendererItem = {
+										url: url.href,
+										outputFile: renderItem.outputFile || this.getOutputFile(url)
+									};
+									if (renderItem.html) {
+										newRenderItem.html = renderItem.html;
+									}
+									if (renderItem.headers) {
+										newRenderItem.headers = renderItem.headers;
+									}
+									newRenderItems.push(newRenderItem);
+								} else {
+									if (!renderItem.outputFile) {
+										throw new Error(
+											`Missing output file in render item: ${JSON.stringify(renderItem)}`
+										);
+									}
+									const newRenderItem: IServerRendererItem = {
+										html: renderItem.html,
+										outputFile: renderItem.outputFile
+									};
+									if (renderItem.headers) {
+										newRenderItem.headers = renderItem.headers;
+									}
+									newRenderItems.push(newRenderItem);
+								}
+							}
 						}
-						config.urls = newUrls;
+						config.renderItems = newRenderItems;
 					}
 				} else if (arg === '--help' || arg === '-h') {
 					config.help = true;
-				} else if (arg === '--browser.disableJavaScriptEvaluation') {
-					config.browser.enableJavaScriptEvaluation = false;
-				} else if (arg === '--browser.suppressInsecureJavaScriptEnvironmentWarning') {
+				} else if (
+					arg === '--browser.enableJavaScriptEvaluation' ||
+					arg === '--javaScript' ||
+					arg === '--javascript' ||
+					arg === '-j'
+				) {
+					config.browser.enableJavaScriptEvaluation = true;
+				} else if (
+					arg === '--browser.suppressInsecureJavaScriptEnvironmentWarning' ||
+					arg === '--suppressJavaScriptWarning' ||
+					arg === '-sj'
+				) {
 					config.browser.suppressInsecureJavaScriptEnvironmentWarning = true;
 				} else if (arg === '--browser.disableJavaScriptFileLoading') {
 					config.browser.disableJavaScriptFileLoading = true;
@@ -126,6 +165,32 @@ export default class ProcessArgumentsParser {
 						url: new RegExp(parts[0].trim()),
 						directory: parts[1].trim()
 					});
+				} else if (arg.startsWith('--browser.module.resolveNodeModules.url=')) {
+					if (!config.browser.module.resolveNodeModules) {
+						config.browser.module.resolveNodeModules = {
+							url: '',
+							directory: ''
+						};
+					}
+					config.browser.module.resolveNodeModules.url = this.stripQuotes(arg.split('=')[1]);
+				} else if (arg.startsWith('--browser.module.resolveNodeModules.directory=')) {
+					if (!config.browser.module.resolveNodeModules) {
+						config.browser.module.resolveNodeModules = {
+							url: '',
+							directory: ''
+						};
+					}
+					config.browser.module.resolveNodeModules.directory = this.stripQuotes(arg.split('=')[1]);
+				} else if (arg.startsWith('--browser.module.resolveNodeModules.mainFields=')) {
+					if (!config.browser.module.resolveNodeModules) {
+						config.browser.module.resolveNodeModules = {
+							url: '',
+							directory: ''
+						};
+					}
+					config.browser.module.resolveNodeModules.mainFields = this.stripQuotes(
+						arg.split('=')[1]
+					).split(',');
 				} else if (arg === '--browser.navigation.disableMainFrameNavigation') {
 					config.browser.navigation.disableMainFrameNavigation = true;
 				} else if (arg === '--browser.navigation.disableChildFrameNavigation') {
@@ -189,7 +254,7 @@ export default class ProcessArgumentsParser {
 				} else if (arg === '--cache.disable') {
 					config.cache.disable = true;
 				} else if (arg.startsWith('--cache.directory=') || arg.startsWith('-cd=')) {
-					config.cache.directory = this.stripQuotes(arg.split('=')[1]);
+					config.cache.directory = Path.resolve(this.stripQuotes(arg.split('=')[1]));
 				} else if (arg === '--cache.warmup') {
 					config.cache.warmup = true;
 				} else if (arg.startsWith('--logLevel=') || arg.startsWith('-l=')) {
@@ -234,7 +299,7 @@ export default class ProcessArgumentsParser {
 				} else if (arg === '--inspect' || arg === '-i') {
 					config.inspect = true;
 				} else if (arg.startsWith('--outputDirectory=') || arg.startsWith('-o=')) {
-					config.outputDirectory = this.stripQuotes(arg.split('=')[1]);
+					config.outputDirectory = Path.resolve(this.stripQuotes(arg.split('=')[1]));
 				} else if (arg.startsWith('--server.serverURL=') || arg.startsWith('-su=')) {
 					config.server.serverURL = this.stripQuotes(arg.split('=')[1]);
 				} else if (arg.startsWith('--server.targetOrigin=') || arg.startsWith('-st=')) {
@@ -255,6 +320,10 @@ export default class ProcessArgumentsParser {
 					throw new Error(
 						'URLs shouldn\'t be set by "--urls=". Instead set them with quotes without an argument name. E.g. "https://example.com/page" "https://example.com/another/page"'
 					);
+				} else if (arg.startsWith('--renderItems=')) {
+					throw new Error(
+						'Render items shouldn\'t be set by "--renderItems=". Instead set each URL with quotes without an argument name. E.g. "https://example.com/page" "https://example.com/another/page"'
+					);
 				}
 			} else if (arg) {
 				const urlString =
@@ -274,11 +343,11 @@ export default class ProcessArgumentsParser {
 						outputFile: this.getOutputFile(url)
 					};
 
-					if (!config.urls) {
-						config.urls = [];
+					if (!config.renderItems) {
+						config.renderItems = [];
 					}
 
-					config.urls.push(item);
+					config.renderItems.push(item);
 				}
 			}
 		}

package/src/utilities/ServerRendererConfigurationFactory.ts

@@ -40,7 +40,7 @@ export default class ServerRendererConfigurationFactory {
 				...DefaultServerRendererConfiguration.render,
 				...configuration?.render
 			},
-			urls: configuration?.urls || null,
+			renderItems: configuration?.renderItems || null,
 			server: {
 				...DefaultServerRendererConfiguration.server,
 				...configuration?.server

package/lib/ServerRendererWorker.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ServerRendererWorker.d.ts","sourceRoot":"","sources":["../src/ServerRendererWorker.ts"],"names":[],"mappings":"AAIA;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,oBAAoB;IACxC;;OAEG;WACiB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;CAe5C"}

package/lib/ServerRendererWorker.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ServerRendererWorker.js","sourceRoot":"","sources":["../src/ServerRendererWorker.ts"],"names":[],"mappings":"AAAA,OAAO,qBAAqB,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,SAAS,MAAM,gBAAgB,CAAC;AAEvC;;GAEG;AACH,MAAM,CAAC,OAAO,OAAO,oBAAoB;IACxC;;OAEG;IACI,MAAM,CAAC,KAAK,CAAC,OAAO;QAC1B,MAAM,EAAE,aAAa,EAAE,GAAG,UAAU,CAAC;QAErC,IAAI,aAAa,CAAC,OAAO,EAAE,CAAC;YAC3B,SAAS,CAAC,IAAI,EAAE,CAAC;YACjB,SAAS,CAAC,eAAe,EAAE,CAAC;QAC7B,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,qBAAqB,CAAC,aAAa,CAAC,CAAC;QAEzD,UAAU,EAAE,EAAE,CAAC,SAAS,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;YAC7C,MAAM,OAAO,GAAG,MAAM,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAC5C,UAAU,EAAE,WAAW,CAAC,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,CAAC,CAAC;QACtD,CAAC,CAAC,CAAC;IACJ,CAAC;CACD;AAED,oBAAoB,CAAC,OAAO,EAAE,CAAC"}