@happy-dom/server-renderer 19.0.0

package/src/index.ts

@@ -0,0 +1,17 @@
+import ServerRenderer from './ServerRenderer.js';
+import ServerRendererServer from './ServerRenderer.js';
+import IServerRendererItem from './types/IServerRendererItem.js';
+import IServerRendererResult from './types/IServerRendererResult.js';
+import IServerRendererConfiguration from './types/IServerRendererConfiguration.js';
+import IOptionalServerRendererConfiguration from './types/IOptionalServerRendererConfiguration.js';
+import ServerRendererLogLevelEnum from './enums/ServerRendererLogLevelEnum.js';
+
+export {
+	ServerRenderer,
+	ServerRendererServer,
+	IServerRendererItem,
+	IServerRendererResult,
+	IServerRendererConfiguration,
+	IOptionalServerRendererConfiguration,
+	ServerRendererLogLevelEnum
+};

package/src/types/IOptionalServerRendererConfiguration.ts

@@ -0,0 +1,108 @@
+import type IOptionalBrowserSettings from 'happy-dom/lib/browser/types/IOptionalBrowserSettings.js';
+import ServerRendererLogLevelEnum from '../enums/ServerRendererLogLevelEnum.js';
+import IServerRendererItem from './IServerRendererItem.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.
+	 */
+	cache?: {
+		/**
+		 * Disables all caching.
+		 */
+		disable?: boolean;
+		/**
+		 * Directory for caching files.
+		 */
+		directory?: string;
+		/**
+		 * Warm up by rendering the first item before rendering the rest.
+		 */
+		warmup?: boolean;
+	};
+	/**
+	 * Settings for the worker.
+	 */
+	worker?: {
+		/**
+		 * Disables the worker.
+		 */
+		disable?: boolean;
+		/**
+		 * Maximum concurrency for the worker.
+		 */
+		maxConcurrency?: number;
+	};
+	/**
+	 * Settings for rendering.
+	 */
+	render?: {
+		/**
+		 * Maximum concurrency for rendering.
+		 */
+		maxConcurrency?: number;
+		/**
+		 * Timeout for rendering in milliseconds.
+		 */
+		timeout?: number;
+		/**
+		 * Use incognito context for rendering.
+		 */
+		incognitoContext?: boolean;
+		/**
+		 * Render shadow roots with the "serializable" option set to true.
+		 */
+		serializableShadowRoots?: boolean;
+		/**
+		 * Render all shadow roots, including those that are not serializable.
+		 */
+		allShadowRoots?: boolean;
+		/**
+		 * Tags to exclude from shadow root rendering.
+		 */
+		excludeShadowRootTags?: string[] | null;
+		/**
+		 * Disable polyfills used for unimplemented functionality.
+		 */
+		disablePolyfills?: boolean;
+	};
+	/**
+	 * List of URLs to render.
+	 */
+	urls?: Array<string | IServerRendererItem> | null;
+	/**
+	 * Proxy server settings.
+	 */
+	server?: {
+		start?: boolean;
+		serverURL?: string;
+		targetOrigin?: string | null;
+		disableCache?: boolean;
+		disableCacheQueue?: boolean;
+		cacheTime?: number;
+	};
+}

package/src/types/IServerRendererConfiguration.ts

@@ -0,0 +1,108 @@
+import type IBrowserSettings from 'happy-dom/lib/browser/types/IBrowserSettings.js';
+import ServerRendererLogLevelEnum from '../enums/ServerRendererLogLevelEnum.js';
+import IServerRendererItem from './IServerRendererItem.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.
+	 */
+	help: boolean;
+	/**
+	 * Output directory.
+	 */
+	outputDirectory: string;
+	/**
+	 * Cache settings.
+	 */
+	cache: {
+		/**
+		 * Disables all caching.
+		 */
+		disable: boolean;
+		/**
+		 * Directory for caching files.
+		 */
+		directory: string;
+		/**
+		 * Warm up by rendering the first item before rendering the rest.
+		 */
+		warmup: boolean;
+	};
+	/**
+	 * Settings for the worker.
+	 */
+	worker: {
+		/**
+		 * Disables the worker.
+		 */
+		disable: boolean;
+		/**
+		 * Maximum concurrency for the worker.
+		 */
+		maxConcurrency: number;
+	};
+	/**
+	 * Settings for rendering.
+	 */
+	render: {
+		/**
+		 * Maximum concurrency for rendering.
+		 */
+		maxConcurrency: number;
+		/**
+		 * Timeout for rendering in milliseconds.
+		 */
+		timeout: number;
+		/**
+		 * Use incognito context for rendering.
+		 */
+		incognitoContext: boolean;
+		/**
+		 * Render shadow roots with the "serializable" option set to true.
+		 */
+		serializableShadowRoots: boolean;
+		/**
+		 * Render all shadow roots, including those that are not serializable.
+		 */
+		allShadowRoots: boolean;
+		/**
+		 * Tags to exclude from shadow root rendering.
+		 */
+		excludeShadowRootTags: string[] | null;
+		/**
+		 * Disable polyfills used for unimplemented functionality.
+		 */
+		disablePolyfills: boolean;
+	};
+	/**
+	 * List of URLs to render.
+	 */
+	urls: Array<string | IServerRendererItem> | null;
+	/**
+	 * Proxy server settings.
+	 */
+	server: {
+		start: boolean;
+		serverURL: string;
+		targetOrigin: string | null;
+		disableCache: boolean;
+		disableCacheQueue: boolean;
+		cacheTime: number;
+	};
+}

package/src/types/IServerRendererItem.ts

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

package/src/types/IServerRendererResult.ts

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

package/src/utilities/BrowserWindowPolyfill.ts

@@ -0,0 +1,93 @@
+import { BrowserWindow } from 'happy-dom';
+
+/**
+ * Browser window polyfill utility.
+ */
+export default class BrowserWindowPolyfill {
+	/**
+	 * Applies polyfills to the window object.
+	 *
+	 * @param window Window.
+	 */
+	public static applyPolyfills(window: BrowserWindow): void {
+		/* eslint-disable jsdoc/require-jsdoc */
+		window.HTMLCanvasElement.prototype.getContext = () => ({
+			resetTransform: () => {},
+			fill: () => {},
+			getContextAttributes: () => ({}),
+			pixelStorei: () => {},
+			getParameter: () => ({}),
+			getExtension: () => null,
+			createTexture: () => ({}),
+			activeTexture: () => {},
+			bindTexture: () => {},
+			texImage2D: () => {},
+			texParameteri: () => {},
+			createFramebuffer: () => ({}),
+			bindFramebuffer: () => {},
+			createRenderbuffer: () => ({}),
+			bindRenderbuffer: () => {},
+			renderbufferStorage: () => {},
+			framebufferRenderbuffer: () => {},
+			framebufferTexture2D: () => {},
+			createBuffer: () => ({}),
+			bindBuffer: () => {},
+			bufferData: () => {},
+			deleteFramebuffer: () => {},
+			deleteRenderbuffer: () => {},
+			deleteTexture: () => {},
+			viewport: () => {},
+			depthMask: () => {},
+			enable: () => {},
+			depthFunc: () => {},
+			disable: () => {},
+			stencilMask: () => {},
+			stencilFunc: () => {},
+			stencilOp: () => {},
+			colorMask: () => {},
+			clearColor: () => {},
+			clearDepth: () => {},
+			clear: () => {},
+			clearStencil: () => {},
+			createShader: () => ({}),
+			shaderSource: () => ({}),
+			compileShader: () => ({}),
+			createProgram: () => ({}),
+			attachShader: () => ({}),
+			linkProgram: () => ({}),
+			getProgramParameter: () => ({}),
+			deleteShader: () => ({}),
+			getUniformLocation: () => ({}),
+			useProgram: () => {},
+			uniform1i: () => {},
+			cullFace: () => {},
+			frontFace: () => {},
+			drawElements: () => {},
+			copyTexImage2D: () => {},
+			generateMipmap: () => {},
+			uniform1f: () => {},
+			uniform2f: () => {},
+			uniform3f: () => {},
+			uniform4f: () => {},
+			uniformMatrix4fv: () => {},
+			bufferSubData: () => {},
+			drawElementsInstanced: () => {}
+		});
+		(<any>window).Worker = class {
+			public postMessage(): any {}
+			public terminate(): any {}
+		};
+		(<any>window).Path2D = class {
+			public addPath(): any {}
+			public addPath2D(): any {}
+			public closePath(): any {}
+			public moveTo(): any {}
+			public lineTo(): any {}
+			public arc(): any {}
+			public rect(): any {}
+			public fill(): any {}
+			public stroke(): any {}
+		};
+		/* eslint-enable jsdoc/require-jsdoc */
+	}
+}

package/src/utilities/HelpPrinter.ts

@@ -0,0 +1,36 @@
+import HelpPrinterRows from './HelpPrinterRows.js';
+
+/* eslint-disable no-console */
+
+/**
+ * CLI help printer.
+ */
+export default class HelpPrinter {
+	/**
+	 * Prints help information.
+	 */
+	public static print(): void {
+		console.log('Happy DOM Server Renderer');
+		console.log('========================');
+		console.log('');
+		console.log('Usage: happy-dom-sr [options]');
+		console.log('');
+		console.log('Options:');
+		console.log('');
+
+		// Calculate column widths
+		const colWidths = [0, 0, 0, 0, 0];
+		for (const row of HelpPrinterRows) {
+			for (let i = 0; i < row.length; i++) {
+				colWidths[i] = Math.max(colWidths[i], row[i].length);
+			}
+		}
+
+		// Print table
+		for (const row of HelpPrinterRows) {
+			console.log('| ' + row.map((cell, i) => cell.padEnd(colWidths[i])).join(' | ') + ' |');
+		}
+
+		console.log('');
+	}
+}

package/src/utilities/HelpPrinterRows.ts

@@ -0,0 +1,260 @@
+export default [
+	['Argument', 'Aliases', 'Type', 'Description', 'Default'],
+	[
+		'-------------------------------------------------',
+		'----------------------------------',
+		'----------',
+		'--------------------------------------------------------------------------------------',
+		'---------------------'
+	],
+	['"<url>"', '', 'string', 'One or more URLs to render.', ''],
+	['--help', '-h', 'boolean', 'Displays this help information.', 'false'],
+	['--config=<path>', '-c', 'string', 'Path to the configuration file.', ''],
+	[
+		'--outputDirectory=<path>',
+		'-o',
+		'string',
+		'Directory to save rendered output.',
+		'./happy-dom/render'
+	],
+	['--cache.disable', '', 'boolean', 'Disables fetch response cache.', 'false'],
+	['--cache.warmup', '', 'boolean', 'Renders the first URL first to warmup the cache.', 'false'],
+	[
+		'--cache.directory=<path>',
+		'-cd',
+		'string',
+		'Directory to store the cache.',
+		'./happy-dom/cache'
+	],
+	[
+		'--debug',
+		'-d',
+		'boolean',
+		'Enables debug mode which is collected when the rendering has timed out.',
+		'false'
+	],
+	[
+		'--inspect',
+		'-i',
+		'boolean',
+		'Enables inspector mode. Opens a Chromium DevTools inspector for each worker.',
+		'false'
+	],
+	[
+		'--logLevel=<level>',
+		'-l',
+		'number',
+		'Sets the log level (0-4). 0: none, 1: error, 2: warn, 3: info, 4: debug.',
+		'3'
+	],
+	[
+		'--server.start',
+		'--server, -s',
+		'boolean',
+		'Starts the server renderer proxy server.',
+		'false'
+	],
+	[
+		'--server.serverURL=<url>',
+		'-su',
+		'string',
+		'URL of the server renderer proxy server.',
+		'http://localhost:3000'
+	],
+	['--server.targetOrigin=<url>', '-st', 'string', 'Target origin (e.g. https://example.com)', ''],
+	['--server.disableCache', '-sdc', 'boolean', 'Disables the server memory cache.', 'false'],
+	[
+		'--server.disableCacheQueue',
+		'-sdq',
+		'boolean',
+		'Disables the server memory cache queue.',
+		'false'
+	],
+	[
+		'--server.cacheTime=<ms>',
+		'-sct',
+		'number',
+		'Time in milliseconds to keep items in the server memory cache.',
+		'60000'
+	],
+	[
+		'--render.timeout=<ms>',
+		'-rt',
+		'number',
+		'Time in milliseconds to wait before considering the rendering as timed out.',
+		'30000'
+	],
+	[
+		'--render.maxConcurrency=<number>',
+		'',
+		'number',
+		'Maximum number of concurrent renderings inside a worker.',
+		'10'
+	],
+	[
+		'--render.incognitoContext',
+		'',
+		'boolean',
+		'Enables incognito context for each rendering.',
+		'false'
+	],
+	['--render.serializableShadowRoots', '', 'boolean', 'Render serializable shadow roots.', 'false'],
+	['--render.allShadowRoots', '', 'boolean', 'Render all shadow roots.', 'false'],
+	[
+		'--render.excludeShadowRootTags=<tags>',
+		'',
+		'string[]',
+		'Comma-separated list of tags to exclude shadow root rendering for.',
+		''
+	],
+	['--render.disablePolyfills', '', 'boolean', 'Disables polyfills.', 'false'],
+	['--worker.disable', '', 'boolean', 'Disables workers.', 'false'],
+	[
+		'--worker.maxConcurrency=<number>',
+		'',
+		'number',
+		'Maximum number of concurrent workers. 50% of CPU threads by default.',
+		''
+	],
+	['--browser.viewport.width=<number>', '-vw', 'number', 'Sets the viewport width.', '1024'],
+	['--browser.viewport.height=<number>', '-vh', 'number', 'Sets the viewport height.', '768'],
+	[
+		'--browser.viewport.devicePixelRatio=<number>',
+		'',
+		'number',
+		'Sets the device pixel ratio.',
+		'1'
+	],
+	[
+		'--browser.disableJavascriptEvaluation',
+		'',
+		'boolean',
+		'Disables JavaScript evaluation.',
+		'false'
+	],
+	[
+		'--browser.disableJavaScriptFileLoading',
+		'',
+		'boolean',
+		'Disables JavaScript file loading.',
+		'false'
+	],
+	['--browser.disableCSSFileLoading', '', 'boolean', 'Disables CSS file loading.', 'false'],
+	[
+		'--browser.disableComputedStyleRendering',
+		'',
+		'boolean',
+		'Disables computed style rendering.',
+		'false'
+	],
+	[
+		'--browser.timer.maxTimeout',
+		'',
+		'boolean',
+		'Maximum value for setTimeout and setInterval.',
+		''
+	],
+	['--browser.timer.maxIntervalTime', '', 'boolean', 'Maximum interval time for setInterval.', ''],
+	[
+		'--browser.timer.maxIntervalIterations',
+		'',
+		'boolean',
+		'Maximum interval iterations for setInterval.',
+		''
+	],
+	['--browser.timer.preventTimerLoops', '', 'boolean', 'Prevents timer loops.', 'false'],
+	[
+		'--browser.fetch.disableSameOriginPolicy',
+		'',
+		'boolean',
+		'Disables same-origin policy for fetch requests.',
+		'false'
+	],
+	[
+		'--browser.fetch.disableStrictSSL',
+		'',
+		'boolean',
+		'Disables strict SSL for fetch requests.',
+		'false'
+	],
+	[
+		'--browser.fetch.requestHeaders=<value>',
+		'--browser.fetch.requestHeader, -rh',
+		'string',
+		'Request header. E.g. -rh="Header:Value" or -rh="^https://e.com/[a-z]{2}/|Header:Value"',
+		''
+	],
+	[
+		'--browser.fetch.virtualServers=<value>',
+		'--browser.fetch.virtualServer, -vs',
+		'string',
+		'Setup a virtual server. E.g. -vs="^https://e.com/[a-z]{2}/|./build"',
+		''
+	],
+	[
+		'--browser.navigation.disableMainFrameNavigation',
+		'',
+		'boolean',
+		'Disables main frame navigation.',
+		'false'
+	],
+	[
+		'--browser.navigation.disableChildFrameNavigation',
+		'',
+		'boolean',
+		'Disables child frame navigation.',
+		'false'
+	],
+	[
+		'--browser.navigation.disableChildPageNavigation',
+		'',
+		'boolean',
+		'Disables child page navigation.',
+		'false'
+	],
+	[
+		'--browser.navigation.disableFallbackToSetURL',
+		'',
+		'boolean',
+		'Disables fallback to set the location of the window.',
+		'false'
+	],
+	[
+		'--browser.navigation.crossOriginPolicy=<policy>',
+		'',
+		'string',
+		'Sets the cross-origin navigation policy. "anyOrigin", "sameOrigin" or "strictOrigin".',
+		'"anyOrigin"'
+	],
+	['--browser.navigator.userAgent=<value>', '', 'string', 'Sets the user agent.', ''],
+	[
+		'--browser.navigator.maxTouchPoints=<points>',
+		'',
+		'number',
+		'Sets the maximum touch points.',
+		'0'
+	],
+	[
+		'--browser.device.prefersColorScheme=<value>',
+		'',
+		'string',
+		'Sets the preferred color scheme.',
+		'"light"'
+	],
+	[
+		'--browser.device.prefersReducedMotion=<value>',
+		'',
+		'string',
+		'Sets the preferred reduced motion.',
+		'"no-preference"'
+	],
+	['--browser.device.mediaType=<type>', '', 'string', 'Sets the media type.', '"screen"'],
+	['--browser.device.forcedColors=<value>', '', 'string', 'Sets the forced colors.', '"none"'],
+	[
+		'--browser.debug.traceWaitUntilComplete=<ms>',
+		'',
+		'number',
+		'Throw an error with trace info about waitUntilComplete().',
+		''
+	]
+];

package/src/utilities/PackageVersion.ts

@@ -0,0 +1,12 @@
+/**
+ * Package version.
+ */
+export default class PackageVersion {
+	/**
+	 * Prints help information.
+	 */
+	public static async getVersion(): Promise<string> {
+		const packageJson = await import('../../package.json', { with: { type: 'json' } });
+		return packageJson.default['version'];
+	}
+}