webpack 5.59.0 → 5.94.0

package/lib/webworker/ImportScriptsChunkLoadingRuntimeModule.js

@@ -15,7 +15,16 @@ const { getInitialChunkIds } = require("../javascript/StartupHelpers");
 const compileBooleanMatcher = require("../util/compileBooleanMatcher");
 const { getUndoPath } = require("../util/identifier");
 
+/** @typedef {import("../Chunk")} Chunk */
+/** @typedef {import("../ChunkGraph")} ChunkGraph */
+/** @typedef {import("../Compilation")} Compilation */
+/** @typedef {import("../Module").ReadOnlyRuntimeRequirements} ReadOnlyRuntimeRequirements */
+
 class ImportScriptsChunkLoadingRuntimeModule extends RuntimeModule {
+	/**
+	 * @param {ReadOnlyRuntimeRequirements} runtimeRequirements runtime requirements
+	 * @param {boolean} withCreateScriptUrl with createScriptUrl support
+	 */
 	constructor(runtimeRequirements, withCreateScriptUrl) {
 		super("importScripts chunk loading", RuntimeModule.STAGE_ATTACH);
 		this.runtimeRequirements = runtimeRequirements;
@@ -23,18 +32,38 @@ class ImportScriptsChunkLoadingRuntimeModule extends RuntimeModule {
 	}
 
 	/**
-	 * @returns {string} runtime code
+	 * @private
+	 * @param {Chunk} chunk chunk
+	 * @returns {string} generated code
+	 */
+	_generateBaseUri(chunk) {
+		const options = chunk.getEntryOptions();
+		if (options && options.baseUri) {
+			return `${RuntimeGlobals.baseURI} = ${JSON.stringify(options.baseUri)};`;
+		}
+		const compilation = /** @type {Compilation} */ (this.compilation);
+		const outputName = compilation.getPath(
+			getChunkFilenameTemplate(chunk, compilation.outputOptions),
+			{
+				chunk,
+				contentHashType: "javascript"
+			}
+		);
+		const rootOutputDir = getUndoPath(
+			outputName,
+			/** @type {string} */ (compilation.outputOptions.path),
+			false
+		);
+		return `${RuntimeGlobals.baseURI} = self.location + ${JSON.stringify(
+			rootOutputDir ? `/../${rootOutputDir}` : ""
+		)};`;
+	}
+
+	/**
+	 * @returns {string | null} runtime code
 	 */
 	generate() {
-		const {
-			chunk,
-			chunkGraph,
-			compilation: {
-				runtimeTemplate,
-				outputOptions: { globalObject, chunkLoadingGlobal, hotUpdateGlobal }
-			},
-			_withCreateScriptUrl: withCreateScriptUrl
-		} = this;
+		const compilation = /** @type {Compilation} */ (this.compilation);
 		const fn = RuntimeGlobals.ensureChunkHandlers;
 		const withBaseURI = this.runtimeRequirements.has(RuntimeGlobals.baseURI);
 		const withLoading = this.runtimeRequirements.has(
@@ -46,39 +75,25 @@ class ImportScriptsChunkLoadingRuntimeModule extends RuntimeModule {
 		const withHmrManifest = this.runtimeRequirements.has(
 			RuntimeGlobals.hmrDownloadManifest
 		);
+		const globalObject = compilation.runtimeTemplate.globalObject;
 		const chunkLoadingGlobalExpr = `${globalObject}[${JSON.stringify(
-			chunkLoadingGlobal
+			compilation.outputOptions.chunkLoadingGlobal
 		)}]`;
+		const chunkGraph = /** @type {ChunkGraph} */ (this.chunkGraph);
+		const chunk = /** @type {Chunk} */ (this.chunk);
 		const hasJsMatcher = compileBooleanMatcher(
 			chunkGraph.getChunkConditionMap(chunk, chunkHasJs)
 		);
-		const initialChunkIds = getInitialChunkIds(chunk, chunkGraph);
-
-		const outputName = this.compilation.getPath(
-			getChunkFilenameTemplate(chunk, this.compilation.outputOptions),
-			{
-				chunk,
-				contentHashType: "javascript"
-			}
-		);
-		const rootOutputDir = getUndoPath(
-			outputName,
-			this.compilation.outputOptions.path,
-			false
-		);
+		const initialChunkIds = getInitialChunkIds(chunk, chunkGraph, chunkHasJs);
 
 		const stateExpression = withHmr
 			? `${RuntimeGlobals.hmrRuntimeStatePrefix}_importScripts`
 			: undefined;
+		const runtimeTemplate = compilation.runtimeTemplate;
+		const { _withCreateScriptUrl: withCreateScriptUrl } = this;
 
 		return Template.asString([
-			withBaseURI
-				? Template.asString([
-						`${RuntimeGlobals.baseURI} = self.location + ${JSON.stringify(
-							rootOutputDir ? "/../" + rootOutputDir : ""
-						)};`
-				  ])
-				: "// no baseURI",
+			withBaseURI ? this._generateBaseUri(chunk) : "// no baseURI",
 			"",
 			"// object to store loaded chunks",
 			'// "1" means "already loaded"',
@@ -109,12 +124,12 @@ class ImportScriptsChunkLoadingRuntimeModule extends RuntimeModule {
 								"}"
 							]),
 							"}",
-							"if(runtime) runtime(__webpack_require__);",
+							`if(runtime) runtime(${RuntimeGlobals.require});`,
 							"while(chunkIds.length)",
 							Template.indent("installedChunks[chunkIds.pop()] = 1;"),
 							"parentChunkLoadingFunction(data);"
 						])};`
-				  ])
+					])
 				: "// no chunk install function needed",
 			withLoading
 				? Template.asString([
@@ -138,14 +153,14 @@ class ImportScriptsChunkLoadingRuntimeModule extends RuntimeModule {
 											"}"
 										]),
 										"}"
-								  ]
+									]
 								: "installedChunks[chunkId] = 1;"
 						)};`,
 						"",
 						`var chunkLoadingGlobal = ${chunkLoadingGlobalExpr} = ${chunkLoadingGlobalExpr} || [];`,
 						"var parentChunkLoadingFunction = chunkLoadingGlobal.push.bind(chunkLoadingGlobal);",
 						"chunkLoadingGlobal.push = installChunk;"
-				  ])
+					])
 				: "// no chunk loading",
 			"",
 			withHmr
@@ -154,7 +169,7 @@ class ImportScriptsChunkLoadingRuntimeModule extends RuntimeModule {
 						Template.indent([
 							"var success = false;",
 							`${globalObject}[${JSON.stringify(
-								hotUpdateGlobal
+								compilation.outputOptions.hotUpdateGlobal
 							)}] = ${runtimeTemplate.basicFunction("_, moreModules, runtime", [
 								"for(var moduleId in moreModules) {",
 								Template.indent([
@@ -182,7 +197,7 @@ class ImportScriptsChunkLoadingRuntimeModule extends RuntimeModule {
 						Template.getFunctionContent(
 							require("../hmr/JavascriptHotModuleReplacement.runtime.js")
 						)
-							.replace(/\$key\$/g, "importScrips")
+							.replace(/\$key\$/g, "importScripts")
 							.replace(/\$installedChunks\$/g, "installedChunks")
 							.replace(/\$loadUpdateChunk\$/g, "loadUpdateChunk")
 							.replace(/\$moduleCache\$/g, RuntimeGlobals.moduleCache)
@@ -201,7 +216,7 @@ class ImportScriptsChunkLoadingRuntimeModule extends RuntimeModule {
 								/\$hmrInvalidateModuleHandlers\$/g,
 								RuntimeGlobals.hmrInvalidateModuleHandlers
 							)
-				  ])
+					])
 				: "// no HMR",
 			"",
 			withHmrManifest
@@ -218,7 +233,7 @@ class ImportScriptsChunkLoadingRuntimeModule extends RuntimeModule {
 								"return response.json();"
 							])});`
 						])};`
-				  ])
+					])
 				: "// no HMR manifest"
 		]);
 	}

package/module.d.ts

@@ -0,0 +1,233 @@
+declare namespace webpack {
+	type DeclinedEvent =
+		| {
+				type: "declined";
+				/** The module in question. */
+				moduleId: number | string;
+				/** the chain from where the update was propagated. */
+				chain: (number | string)[];
+				/** the module id of the declining parent */
+				parentId: number | string;
+		  }
+		| {
+				type: "self-declined";
+				/** The module in question. */
+				moduleId: number | string;
+				/** the chain from where the update was propagated. */
+				chain: (number | string)[];
+		  };
+
+	type UnacceptedEvent = {
+		type: "unaccepted";
+		/** The module in question. */
+		moduleId: number | string;
+		/** the chain from where the update was propagated. */
+		chain: (number | string)[];
+	};
+
+	type AcceptedEvent = {
+		type: "accepted";
+		/** The module in question. */
+		moduleId: number | string;
+		/** the modules that are outdated and will be disposed */
+		outdatedModules: (number | string)[];
+		/** the accepted dependencies that are outdated */
+		outdatedDependencies: {
+			[id: number]: (number | string)[];
+		};
+	};
+
+	type DisposedEvent = {
+		type: "disposed";
+		/** The module in question. */
+		moduleId: number | string;
+	};
+
+	type ErroredEvent =
+		| {
+				type: "accept-error-handler-errored";
+				/** The module in question. */
+				moduleId: number | string;
+				/** the module id owning the accept handler. */
+				dependencyId: number | string;
+				/** the thrown error */
+				error: Error;
+				/** the error thrown by the module before the error handler tried to handle it. */
+				originalError: Error;
+		  }
+		| {
+				type: "self-accept-error-handler-errored";
+				/** The module in question. */
+				moduleId: number | string;
+				/** the thrown error */
+				error: Error;
+				/** the error thrown by the module before the error handler tried to handle it. */
+				originalError: Error;
+		  }
+		| {
+				type: "accept-errored";
+				/** The module in question. */
+				moduleId: number | string;
+				/** the module id owning the accept handler. */
+				dependencyId: number | string;
+				/** the thrown error */
+				error: Error;
+		  }
+		| {
+				type: "self-accept-errored";
+				/** The module in question. */
+				moduleId: number | string;
+				/** the thrown error */
+				error: Error;
+		  };
+
+	type HotEvent =
+		| DeclinedEvent
+		| UnacceptedEvent
+		| AcceptedEvent
+		| DisposedEvent
+		| ErroredEvent;
+
+	interface ApplyOptions {
+		ignoreUnaccepted?: boolean;
+		ignoreDeclined?: boolean;
+		ignoreErrored?: boolean;
+		onDeclined?: (event: DeclinedEvent) => void;
+		onUnaccepted?: (event: UnacceptedEvent) => void;
+		onAccepted?: (event: AcceptedEvent) => void;
+		onDisposed?: (event: DisposedEvent) => void;
+		onErrored?: (event: ErroredEvent) => void;
+	}
+
+	const enum HotUpdateStatus {
+		idle = "idle",
+		check = "check",
+		prepare = "prepare",
+		ready = "ready",
+		dispose = "dispose",
+		apply = "apply",
+		abort = "abort",
+		fail = "fail"
+	}
+
+	interface Hot {
+		accept: {
+			(
+				modules: string | string[],
+				callback?: (outdatedDependencies: string[]) => void,
+				errorHandler?: (
+					err: Error,
+					context: { moduleId: string | number; dependencyId: string | number }
+				) => void
+			): void;
+			(
+				errorHandler?: (
+					err: Error,
+					ids: { moduleId: string | number; module: NodeJS.Module }
+				) => void
+			): void;
+		};
+		status(): HotUpdateStatus;
+		decline(module?: string | string[]): void;
+		dispose(callback: (data: object) => void): void;
+		addDisposeHandler(callback: (data: object) => void): void;
+		removeDisposeHandler(callback: (data: object) => void): void;
+		invalidate(): void;
+		addStatusHandler(callback: (status: HotUpdateStatus) => void): void;
+		removeStatusHandler(callback: (status: HotUpdateStatus) => void): void;
+		data: object;
+		check(
+			autoApply?: boolean | ApplyOptions
+		): Promise<(string | number)[] | null>;
+		apply(options?: ApplyOptions): Promise<(string | number)[] | null>;
+	}
+
+	interface ExportInfo {
+		used: boolean;
+		provideInfo: boolean | null | undefined;
+		useInfo: boolean | null | undefined;
+		canMangle: boolean;
+	}
+
+	interface ExportsInfo {
+		[k: string]: ExportInfo & ExportsInfo;
+	}
+
+	interface Context {
+		resolve(dependency: string): string | number;
+		keys(): Array<string>;
+		id: string | number;
+		(dependency: string): unknown;
+	}
+}
+
+interface ImportMeta {
+	url: string;
+	webpack: number;
+	webpackHot: webpack.Hot;
+	webpackContext: (
+		request: string,
+		options?: {
+			recursive?: boolean;
+			regExp?: RegExp;
+			include?: RegExp;
+			exclude?: RegExp;
+			preload?: boolean | number;
+			prefetch?: boolean | number;
+			fetchPriority?: "low" | "high" | "auto";
+			chunkName?: string;
+			exports?: string | string[][];
+			mode?: "sync" | "eager" | "weak" | "lazy" | "lazy-once";
+		}
+	) => webpack.Context;
+}
+
+declare const __resourceQuery: string;
+declare var __webpack_public_path__: string;
+declare var __webpack_nonce__: string;
+declare const __webpack_chunkname__: string;
+declare var __webpack_base_uri__: string;
+declare var __webpack_runtime_id__: string;
+declare const __webpack_hash__: string;
+declare const __webpack_modules__: Record<string | number, NodeJS.Module>;
+declare const __webpack_require__: (id: string | number) => unknown;
+declare var __webpack_chunk_load__: (chunkId: string | number) => Promise<void>;
+declare var __webpack_get_script_filename__: (
+	chunkId: string | number
+) => string;
+declare var __webpack_is_included__: (request: string) => boolean;
+declare var __webpack_exports_info__: webpack.ExportsInfo;
+declare const __webpack_share_scopes__: Record<
+	string,
+	Record<
+		string,
+		{ loaded?: 1; get: () => Promise<unknown>; from: string; eager: boolean }
+	>
+>;
+declare var __webpack_init_sharing__: (scope: string) => Promise<void>;
+declare var __non_webpack_require__: (id: any) => unknown;
+declare const __system_context__: object;
+
+declare namespace NodeJS {
+	interface Module {
+		hot: webpack.Hot;
+	}
+
+	interface Require {
+		ensure(
+			dependencies: string[],
+			callback: (require: (module: string) => void) => void,
+			errorCallback?: (error: Error) => void,
+			chunkName?: string
+		): void;
+		context(
+			request: string,
+			includeSubdirectories?: boolean,
+			filter?: RegExp,
+			mode?: "sync" | "eager" | "weak" | "lazy" | "lazy-once"
+		): webpack.Context;
+		include(dependency: string): void;
+		resolveWeak(dependency: string): void;
+		onError?: (error: Error) => void;
+	}
+}