webpack 5.76.1 → 5.88.2

package/lib/AsyncDependenciesBlock.js

@@ -15,13 +15,15 @@ const makeSerializable = require("./util/makeSerializable");
 /** @typedef {import("./Dependency").UpdateHashContext} UpdateHashContext */
 /** @typedef {import("./Entrypoint").EntryOptions} EntryOptions */
 /** @typedef {import("./Module")} Module */
+/** @typedef {import("./serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
+/** @typedef {import("./serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
 /** @typedef {import("./util/Hash")} Hash */
 
 class AsyncDependenciesBlock extends DependenciesBlock {
 	/**
-	 * @param {ChunkGroupOptions & { entryOptions?: EntryOptions }} groupOptions options for the group
-	 * @param {DependencyLocation=} loc the line of code
-	 * @param {string=} request the request
+	 * @param {(ChunkGroupOptions & { entryOptions?: EntryOptions }) | null} groupOptions options for the group
+	 * @param {(DependencyLocation | null)=} loc the line of code
+	 * @param {(string | null)=} request the request
 	 */
 	constructor(groupOptions, loc, request) {
 		super();
@@ -37,14 +39,14 @@ class AsyncDependenciesBlock extends DependenciesBlock {
 	}
 
 	/**
-	 * @returns {string} The name of the chunk
+	 * @returns {string | undefined} The name of the chunk
 	 */
 	get chunkName() {
 		return this.groupOptions.name;
 	}
 
 	/**
-	 * @param {string} value The new chunk name
+	 * @param {string | undefined} value The new chunk name
 	 * @returns {void}
 	 */
 	set chunkName(value) {
@@ -71,6 +73,9 @@ class AsyncDependenciesBlock extends DependenciesBlock {
 		super.updateHash(hash, context);
 	}
 
+	/**
+	 * @param {ObjectSerializerContext} context context
+	 */
 	serialize(context) {
 		const { write } = context;
 		write(this.groupOptions);
@@ -79,6 +84,9 @@ class AsyncDependenciesBlock extends DependenciesBlock {
 		super.serialize(context);
 	}
 
+	/**
+	 * @param {ObjectDeserializerContext} context context
+	 */
 	deserialize(context) {
 		const { read } = context;
 		this.groupOptions = read();

package/lib/AutomaticPrefetchPlugin.js

@@ -27,6 +27,7 @@ class AutomaticPrefetchPlugin {
 				);
 			}
 		);
+		/** @type {{context: string, request: string}[] | null} */
 		let lastModules = null;
 		compiler.hooks.afterCompile.tap("AutomaticPrefetchPlugin", compilation => {
 			lastModules = [];

package/lib/BannerPlugin.js

@@ -11,6 +11,7 @@ const ModuleFilenameHelpers = require("./ModuleFilenameHelpers");
 const Template = require("./Template");
 const createSchemaValidation = require("./util/create-schema-validation");
 
+/** @typedef {import("../declarations/plugins/BannerPlugin").BannerFunction} BannerFunction */
 /** @typedef {import("../declarations/plugins/BannerPlugin").BannerPluginArgument} BannerPluginArgument */
 /** @typedef {import("../declarations/plugins/BannerPlugin").BannerPluginOptions} BannerPluginOptions */
 /** @typedef {import("./Compiler")} Compiler */
@@ -24,6 +25,10 @@ const validate = createSchemaValidation(
 	}
 );
 
+/**
+ * @param {string} str string to wrap
+ * @returns {string} wrapped string
+ */
 const wrapComment = str => {
 	if (!str.includes("\n")) {
 		return Template.toComment(str);
@@ -56,7 +61,7 @@ class BannerPlugin {
 			const getBanner = bannerOption;
 			this.banner = this.options.raw
 				? getBanner
-				: data => wrapComment(getBanner(data));
+				: /** @type {BannerFunction} */ data => wrapComment(getBanner(data));
 		} else {
 			const banner = this.options.raw
 				? bannerOption

package/lib/CacheFacade.js

@@ -55,6 +55,10 @@ class MultiItemCache {
 	 * @returns {Promise<T>} promise with the data
 	 */
 	getPromise() {
+		/**
+		 * @param {number} i index
+		 * @returns {Promise<T>} promise with the data
+		 */
 		const next = i => {
 			return this._items[i].getPromise().then(result => {
 				if (result !== undefined) return result;

package/lib/CaseSensitiveModulesWarning.js

@@ -42,7 +42,9 @@ const createModulesListMessage = (modules, moduleGraph) => {
 
 			if (validReasons.length > 0) {
 				message += `\n    Used by ${validReasons.length} module(s), i. e.`;
-				message += `\n    ${validReasons[0].identifier()}`;
+				message += `\n    ${
+					/** @type {Module[]} */ (validReasons)[0].identifier()
+				}`;
 			}
 			return message;
 		})

package/lib/Chunk.js

@@ -23,6 +23,7 @@ const { mergeRuntime } = require("./util/runtime");
 /** @typedef {import("./ChunkGraph").ChunkSizeOptions} ChunkSizeOptions */
 /** @typedef {import("./ChunkGraph").ModuleFilterPredicate} ModuleFilterPredicate */
 /** @typedef {import("./ChunkGroup")} ChunkGroup */
+/** @typedef {import("./ChunkGroup").ChunkGroupOptions} ChunkGroupOptions */
 /** @typedef {import("./Compilation")} Compilation */
 /** @typedef {import("./Compilation").AssetInfo} AssetInfo */
 /** @typedef {import("./Compilation").PathData} PathData */
@@ -32,6 +33,8 @@ const { mergeRuntime } = require("./util/runtime");
 /** @typedef {import("./util/Hash")} Hash */
 /** @typedef {import("./util/runtime").RuntimeSpec} RuntimeSpec */
 
+/** @typedef {number | string} ChunkId */
+
 const ChunkFilesSet = createArrayToSetDeprecationSet("chunk.files");
 
 /**
@@ -66,21 +69,21 @@ class Chunk {
 	 * @param {boolean} backCompat enable backward-compatibility
 	 */
 	constructor(name, backCompat = true) {
-		/** @type {number | string | null} */
+		/** @type {ChunkId | null} */
 		this.id = null;
-		/** @type {(number|string)[] | null} */
+		/** @type {ChunkId[] | null} */
 		this.ids = null;
 		/** @type {number} */
 		this.debugId = debugId++;
-		/** @type {string} */
+		/** @type {string | undefined} */
 		this.name = name;
 		/** @type {SortableSet<string>} */
 		this.idNameHints = new SortableSet();
 		/** @type {boolean} */
 		this.preventIntegration = false;
-		/** @type {(string | function(PathData, AssetInfo=): string)?} */
+		/** @type {(string | function(PathData, AssetInfo=): string) | undefined} */
 		this.filenameTemplate = undefined;
-		/** @type {(string | function(PathData, AssetInfo=): string)?} */
+		/** @type {(string | function(PathData, AssetInfo=): string) | undefined} */
 		this.cssFilenameTemplate = undefined;
 		/** @private @type {SortableSet<ChunkGroup>} */
 		this._groups = new SortableSet(undefined, compareChunkGroupsByIndex);
@@ -350,7 +353,7 @@ class Chunk {
 		const chunkModuleHashMap = Object.create(null);
 
 		for (const asyncChunk of this.getAllAsyncChunks()) {
-			/** @type {(string|number)[]} */
+			/** @type {ChunkId[] | undefined} */
 			let array;
 			for (const module of chunkGraph.getOrderedChunkModulesIterable(
 				asyncChunk,
@@ -359,7 +362,7 @@ class Chunk {
 				if (filterFn(module)) {
 					if (array === undefined) {
 						array = [];
-						chunkModuleIdMap[asyncChunk.id] = array;
+						chunkModuleIdMap[/** @type {ChunkId} */ (asyncChunk.id)] = array;
 					}
 					const moduleId = chunkGraph.getModuleId(module);
 					array.push(moduleId);
@@ -405,15 +408,18 @@ class Chunk {
 		const chunkNameMap = Object.create(null);
 
 		for (const chunk of this.getAllAsyncChunks()) {
-			chunkHashMap[chunk.id] = realHash ? chunk.hash : chunk.renderedHash;
+			const id = /** @type {ChunkId} */ (chunk.id);
+			chunkHashMap[id] =
+				/** @type {string} */
+				(realHash ? chunk.hash : chunk.renderedHash);
 			for (const key of Object.keys(chunk.contentHash)) {
 				if (!chunkContentHashMap[key]) {
 					chunkContentHashMap[key] = Object.create(null);
 				}
-				chunkContentHashMap[key][chunk.id] = chunk.contentHash[key];
+				chunkContentHashMap[key][id] = chunk.contentHash[key];
 			}
 			if (chunk.name) {
-				chunkNameMap[chunk.id] = chunk.name;
+				chunkNameMap[id] = chunk.name;
 			}
 		}
 
@@ -505,7 +511,7 @@ class Chunk {
 	}
 
 	/**
-	 * @returns {Iterable<ChunkGroup>} the chunkGroups that the said chunk is referenced in
+	 * @returns {SortableSet<ChunkGroup>} the chunkGroups that the said chunk is referenced in
 	 */
 	get groupsIterable() {
 		this._groups.sort();
@@ -553,7 +559,11 @@ class Chunk {
 		const entryModules =
 			chunkGraph.getChunkEntryModulesWithChunkGroupIterable(this);
 		for (const [m, chunkGroup] of entryModules) {
-			hash.update(`entry${chunkGraph.getModuleId(m)}${chunkGroup.id}`);
+			hash.update(
+				`entry${chunkGraph.getModuleId(m)}${
+					/** @type {ChunkGroup} */ (chunkGroup).id
+				}`
+			);
 		}
 	}
 
@@ -697,7 +707,13 @@ class Chunk {
 								lists.set(name, list);
 							}
 							list.push({
-								order: childGroup.options[key],
+								order:
+									/** @type {number} */
+									(
+										childGroup.options[
+											/** @type {keyof ChunkGroupOptions} */ (key)
+										]
+									),
 								group: childGroup
 							});
 						}
@@ -718,7 +734,7 @@ class Chunk {
 			for (const item of list) {
 				for (const chunk of item.group.chunks) {
 					if (filterFn && !filterFn(chunk, chunkGraph)) continue;
-					chunkIdSet.add(chunk.id);
+					chunkIdSet.add(/** @type {ChunkId} */ (chunk.id));
 				}
 			}
 			if (chunkIdSet.size > 0) {
@@ -731,13 +747,14 @@ class Chunk {
 	/**
 	 * @param {ChunkGraph} chunkGraph the chunk graph
 	 * @param {string} type option name
-	 * @returns {{ onChunks: Chunk[], chunks: Set<Chunk> }[]} referenced chunks for a specific type
+	 * @returns {{ onChunks: Chunk[], chunks: Set<Chunk> }[] | undefined} referenced chunks for a specific type
 	 */
 	getChildrenOfTypeInOrder(chunkGraph, type) {
 		const list = [];
 		for (const group of this.groupsIterable) {
 			for (const childGroup of group.childrenIterable) {
-				const order = childGroup.options[type];
+				const order =
+					childGroup.options[/** @type {keyof ChunkGroupOptions} */ (type)];
 				if (order === undefined) continue;
 				list.push({
 					order,
@@ -748,7 +765,8 @@ class Chunk {
 		}
 		if (list.length === 0) return undefined;
 		list.sort((a, b) => {
-			const cmp = b.order - a.order;
+			const cmp =
+				/** @type {number} */ (b.order) - /** @type {number} */ (a.order);
 			if (cmp !== 0) return cmp;
 			return a.group.compareTo(chunkGraph, b.group);
 		});
@@ -792,7 +810,7 @@ class Chunk {
 				if (chunkMap === undefined) {
 					chunkMaps[key] = chunkMap = Object.create(null);
 				}
-				chunkMap[chunk.id] = data[key];
+				chunkMap[/** @type {ChunkId} */ (chunk.id)] = data[key];
 			}
 		};
 

package/lib/ChunkGraph.js

@@ -188,7 +188,7 @@ class ChunkGraphModule {
 		this.entryInChunks = undefined;
 		/** @type {Set<Chunk> | undefined} */
 		this.runtimeInChunks = undefined;
-		/** @type {RuntimeSpecMap<ModuleHashInfo>} */
+		/** @type {RuntimeSpecMap<ModuleHashInfo> | undefined} */
 		this.hashes = undefined;
 		/** @type {string | number} */
 		this.id = null;
@@ -1388,7 +1388,7 @@ Caller might not support runtime-dependent code generation (opt-out via optimiza
 	 */
 	hasModuleHashes(module, runtime) {
 		const cgm = this._getChunkGraphModule(module);
-		const hashes = cgm.hashes;
+		const hashes = /** @type {RuntimeSpecMap<ModuleHashInfo>} */ (cgm.hashes);
 		return hashes && hashes.has(runtime);
 	}
 
@@ -1399,7 +1399,7 @@ Caller might not support runtime-dependent code generation (opt-out via optimiza
 	 */
 	getModuleHash(module, runtime) {
 		const cgm = this._getChunkGraphModule(module);
-		const hashes = cgm.hashes;
+		const hashes = /** @type {RuntimeSpecMap<ModuleHashInfo>} */ (cgm.hashes);
 		return this._getModuleHashInfo(module, hashes, runtime).hash;
 	}
 
@@ -1410,7 +1410,7 @@ Caller might not support runtime-dependent code generation (opt-out via optimiza
 	 */
 	getRenderedModuleHash(module, runtime) {
 		const cgm = this._getChunkGraphModule(module);
-		const hashes = cgm.hashes;
+		const hashes = /** @type {RuntimeSpecMap<ModuleHashInfo>} */ (cgm.hashes);
 		return this._getModuleHashInfo(module, hashes, runtime).renderedHash;
 	}
 

package/lib/ChunkGroup.js

@@ -28,6 +28,7 @@ const {
  * @typedef {Object} RawChunkGroupOptions
  * @property {number=} preloadOrder
  * @property {number=} prefetchOrder
+ * @property {("low" | "high" | "auto")=} fetchPriority
  */
 
 /** @typedef {RawChunkGroupOptions & { name?: string }} ChunkGroupOptions */
@@ -97,7 +98,7 @@ class ChunkGroup {
 		/** Indices in bottom-up order */
 		/** @private @type {Map<Module, number>} */
 		this._modulePostOrderIndices = new Map();
-		/** @type {number} */
+		/** @type {number | undefined} */
 		this.index = undefined;
 	}
 
@@ -108,9 +109,15 @@ class ChunkGroup {
 	 */
 	addOptions(options) {
 		for (const key of Object.keys(options)) {
-			if (this.options[key] === undefined) {
-				this.options[key] = options[key];
-			} else if (this.options[key] !== options[key]) {
+			if (
+				this.options[/** @type {keyof ChunkGroupOptions} */ (key)] === undefined
+			) {
+				this.options[key] =
+					options[/** @type {keyof ChunkGroupOptions} */ (key)];
+			} else if (
+				this.options[/** @type {keyof ChunkGroupOptions} */ (key)] !==
+				options[/** @type {keyof ChunkGroupOptions} */ (key)]
+			) {
 				if (key.endsWith("Order")) {
 					this.options[key] = Math.max(this.options[key], options[key]);
 				} else {
@@ -124,7 +131,7 @@ class ChunkGroup {
 
 	/**
 	 * returns the name of current ChunkGroup
-	 * @returns {string|undefined} returns the ChunkGroup name
+	 * @returns {string | undefined} returns the ChunkGroup name
 	 */
 	get name() {
 		return this.options.name;
@@ -132,7 +139,7 @@ class ChunkGroup {
 
 	/**
 	 * sets a new name for current ChunkGroup
-	 * @param {string} value the new name for ChunkGroup
+	 * @param {string | undefined} value the new name for ChunkGroup
 	 * @returns {void}
 	 */
 	set name(value) {
@@ -353,7 +360,7 @@ class ChunkGroup {
 	}
 
 	/**
-	 * @returns {Array} an array containing the blocks
+	 * @returns {Array<AsyncDependenciesBlock>} an array containing the blocks
 	 */
 	getBlocks() {
 		return this._blocks.getFromCache(getArray);
@@ -363,6 +370,10 @@ class ChunkGroup {
 		return this._blocks.size;
 	}
 
+	/**
+	 * @param {AsyncDependenciesBlock} block block
+	 * @returns {boolean} true, if block exists
+	 */
 	hasBlock(block) {
 		return this._blocks.has(block);
 	}
@@ -492,7 +503,11 @@ class ChunkGroup {
 						lists.set(name, (list = []));
 					}
 					list.push({
-						order: childGroup.options[key],
+						order:
+							/** @type {number} */
+							(
+								childGroup.options[/** @type {keyof ChunkGroupOptions} */ (key)]
+							),
 						group: childGroup
 					});
 				}
@@ -524,7 +539,7 @@ class ChunkGroup {
 	/**
 	 * Gets the top-down index of a module in this ChunkGroup
 	 * @param {Module} module the module
-	 * @returns {number} index
+	 * @returns {number | undefined} index
 	 */
 	getModulePreOrderIndex(module) {
 		return this._modulePreOrderIndices.get(module);
@@ -543,7 +558,7 @@ class ChunkGroup {
 	/**
 	 * Gets the bottom-up index of a module in this ChunkGroup
 	 * @param {Module} module the module
-	 * @returns {number} index
+	 * @returns {number | undefined} index
 	 */
 	getModulePostOrderIndex(module) {
 		return this._modulePostOrderIndices.get(module);

package/lib/CleanPlugin.js

@@ -78,7 +78,8 @@ const getDiffToFs = (fs, outputPath, currentAssets, callback) => {
 		directories,
 		10,
 		(directory, callback) => {
-			fs.readdir(join(fs, outputPath, directory), (err, entries) => {
+			/** @type {NonNullable<OutputFileSystem["readdir"]>} */
+			(fs.readdir)(join(fs, outputPath, directory), (err, entries) => {
 				if (err) {
 					if (err.code === "ENOENT") return callback();
 					if (err.code === "ENOTDIR") {
@@ -128,7 +129,8 @@ const getDiffToOldAssets = (currentAssets, oldAssets) => {
  */
 const doStat = (fs, filename, callback) => {
 	if ("lstat" in fs) {
-		fs.lstat(filename, callback);
+		/** @type {NonNullable<OutputFileSystem["lstat"]>} */
+		(fs.lstat)(filename, callback);
 	} else {
 		fs.stat(filename, callback);
 	}
@@ -145,6 +147,9 @@ const doStat = (fs, filename, callback) => {
  * @returns {void}
  */
 const applyDiff = (fs, outputPath, dry, logger, diff, isKept, callback) => {
+	/**
+	 * @param {string} msg message
+	 */
 	const log = msg => {
 		if (dry) {
 			logger.info(msg);
@@ -165,6 +170,10 @@ const applyDiff = (fs, outputPath, dry, logger, diff, isKept, callback) => {
 		jobs,
 		10,
 		({ type, filename, parent }, push, callback) => {
+			/**
+			 * @param {Error & { code?: string }} err error
+			 * @returns {void}
+			 */
 			const handleError = err => {
 				if (err.code === "ENOENT") {
 					log(`${filename} was removed during cleaning by something else`);
@@ -195,7 +204,9 @@ const applyDiff = (fs, outputPath, dry, logger, diff, isKept, callback) => {
 							});
 							return callback();
 						}
-						fs.readdir(path, (err, entries) => {
+
+						/** @type {NonNullable<OutputFileSystem["readdir"]>} */
+						(fs.readdir)(path, (err, entries) => {
 							if (err) return handleError(err);
 							/** @type {Job} */
 							const deleteJob = {
@@ -317,9 +328,17 @@ class CleanPlugin {
 			typeof keep === "function"
 				? keep
 				: typeof keep === "string"
-				? path => path.startsWith(keep)
+				? /**
+				   * @param {string} path path
+				   * @returns {boolean} true, if the path should be kept
+				   */
+				  path => path.startsWith(keep)
 				: typeof keep === "object" && keep.test
-				? path => keep.test(path)
+				? /**
+				   * @param {string} path path
+				   * @returns {boolean} true, if the path should be kept
+				   */
+				  path => keep.test(path)
 				: () => false;
 
 		// We assume that no external modification happens while the compiler is active
@@ -371,6 +390,10 @@ class CleanPlugin {
 
 				const outputPath = compilation.getPath(compiler.outputPath, {});
 
+				/**
+				 * @param {string} path path
+				 * @returns {boolean} true, if needs to be kept
+				 */
 				const isKept = path => {
 					const result = hooks.keep.call(path);
 					if (result !== undefined) return result;
@@ -378,7 +401,7 @@ class CleanPlugin {
 				};
 
 				/**
-				 * @param {Error=} err err
+				 * @param {(Error | null)=} err err
 				 * @param {Set<string>=} diff diff
 				 */
 				const diffCallback = (err, diff) => {
@@ -392,7 +415,7 @@ class CleanPlugin {
 						outputPath,
 						dry,
 						logger,
-						diff,
+						/** @type {Set<string>} */ (diff),
 						isKept,
 						(err, keptAssets) => {
 							if (err) {

package/lib/CodeGenerationResults.js

@@ -5,7 +5,7 @@
 
 "use strict";
 
-const { provide } = require("./util/MapHelpers");
+const { getOrInsert } = require("./util/MapHelpers");
 const { first } = require("./util/SetHelpers");
 const createHash = require("./util/createHash");
 const { runtimeToString, RuntimeSpecMap } = require("./util/runtime");
@@ -147,7 +147,7 @@ Caller might not support runtime-dependent code generation (opt-out via optimiza
 	 * @returns {void}
 	 */
 	add(module, runtime, result) {
-		const map = provide(this.map, module, () => new RuntimeSpecMap());
+		const map = getOrInsert(this.map, module, () => new RuntimeSpecMap());
 		map.set(runtime, result);
 	}
 }