webpack 5.106.0 → 5.106.2

package/lib/util/runtime.js

@@ -15,6 +15,7 @@ const SortableSet = require("./SortableSet");
 /** @typedef {RuntimeSpec | boolean} RuntimeCondition */
 
 /**
+ * Gets entry runtime.
  * @param {Compilation} compilation the compilation
  * @param {string} name name of the entry
  * @param {EntryOptions=} options optionally already received entry options
@@ -54,6 +55,7 @@ const getEntryRuntime = (compilation, name, options) => {
 };
 
 /**
+ * Processes the provided runtime.
  * @param {RuntimeSpec} runtime runtime
  * @param {(runtime: string | undefined) => void} fn functor
  * @param {boolean} deterministicOrder enforce a deterministic order
@@ -73,6 +75,7 @@ const forEachRuntime = (runtime, fn, deterministicOrder = false) => {
 };
 
 /**
+ * Returns runtime key.
  * @template T
  * @param {Exclude<RuntimeSpec, undefined | string>} set set
  * @returns {string} runtime key
@@ -83,6 +86,7 @@ const getRuntimesKey = (set) => {
 };
 
 /**
+ * Returns key of runtimes.
  * @param {RuntimeSpec} runtime runtime(s)
  * @returns {string} key of runtimes
  */
@@ -93,6 +97,7 @@ const getRuntimeKey = (runtime) => {
 };
 
 /**
+ * Returns runtime(s).
  * @param {string} key key of runtimes
  * @returns {RuntimeSpec} runtime(s)
  */
@@ -104,6 +109,7 @@ const keyToRuntime = (key) => {
 };
 
 /**
+ * Gets runtimes string.
  * @template T
  * @param {Exclude<RuntimeSpec, undefined | string>} set set
  * @returns {string} runtime string
@@ -114,6 +120,7 @@ const getRuntimesString = (set) => {
 };
 
 /**
+ * Returns readable version.
  * @param {RuntimeSpec} runtime runtime(s)
  * @returns {string} readable version
  */
@@ -124,6 +131,7 @@ const runtimeToString = (runtime) => {
 };
 
 /**
+ * Runtime condition to string.
  * @param {RuntimeCondition} runtimeCondition runtime condition
  * @returns {string} readable version
  */
@@ -134,6 +142,7 @@ const runtimeConditionToString = (runtimeCondition) => {
 };
 
 /**
+ * Returns true, when they are equal.
  * @param {RuntimeSpec} a first
  * @param {RuntimeSpec} b second
  * @returns {boolean} true, when they are equal
@@ -164,6 +173,7 @@ const runtimeEqual = (a, b) => {
 };
 
 /**
+ * Compares the provided values and returns their ordering.
  * @param {RuntimeSpec} a first
  * @param {RuntimeSpec} b second
  * @returns {-1 | 0 | 1} compare
@@ -184,6 +194,7 @@ const compareRuntime = (a, b) => {
 };
 
 /**
+ * Merges the provided values into a single result.
  * @param {RuntimeSpec} a first
  * @param {RuntimeSpec} b second
  * @returns {RuntimeSpec} merged
@@ -225,6 +236,7 @@ const mergeRuntime = (a, b) => {
 };
 
 /**
+ * Merges runtime condition.
  * @param {RuntimeCondition} a first
  * @param {RuntimeCondition} b second
  * @param {RuntimeSpec} runtime full runtime
@@ -246,6 +258,7 @@ const mergeRuntimeCondition = (a, b, runtime) => {
 };
 
 /**
+ * Merges runtime condition non false.
  * @param {RuntimeSpec | true} a first
  * @param {RuntimeSpec | true} b second
  * @param {RuntimeSpec} runtime full runtime
@@ -265,6 +278,7 @@ const mergeRuntimeConditionNonFalse = (a, b, runtime) => {
 };
 
 /**
+ * Merges runtime owned.
  * @param {RuntimeSpec} a first (may be modified)
  * @param {RuntimeSpec} b second
  * @returns {RuntimeSpec} merged
@@ -302,6 +316,7 @@ const mergeRuntimeOwned = (a, b) => {
 };
 
 /**
+ * Returns merged.
  * @param {RuntimeSpec} a first
  * @param {RuntimeSpec} b second
  * @returns {RuntimeSpec} merged
@@ -339,6 +354,7 @@ const intersectRuntime = (a, b) => {
 };
 
 /**
+ * Returns result.
  * @param {RuntimeSpec} a first
  * @param {RuntimeSpec} b second
  * @returns {RuntimeSpec} result
@@ -384,6 +400,7 @@ const subtractRuntime = (a, b) => {
 };
 
 /**
+ * Subtract runtime condition.
  * @param {RuntimeCondition} a first
  * @param {RuntimeCondition} b second
  * @param {RuntimeSpec} runtime runtime
@@ -398,6 +415,7 @@ const subtractRuntimeCondition = (a, b, runtime) => {
 };
 
 /**
+ * Returns true/false if filter is constant for all runtimes, otherwise runtimes that are active.
  * @param {RuntimeSpec} runtime runtime
  * @param {(runtime?: RuntimeSpec) => boolean} filter filter function
  * @returns {boolean | RuntimeSpec} true/false if filter is constant for all runtimes, otherwise runtimes that are active
@@ -424,16 +442,19 @@ const filterRuntime = (runtime, filter) => {
 };
 
 /**
+ * Defines the runtime spec map inner map type used by this module.
  * @template T
  * @typedef {Map<string, T>} RuntimeSpecMapInnerMap
  */
 
 /**
+ * Represents RuntimeSpecMap.
  * @template T
  * @template [R=T]
  */
 class RuntimeSpecMap {
 	/**
+	 * Creates an instance of RuntimeSpecMap.
 	 * @param {RuntimeSpecMap<T, R>=} clone copy form this
 	 */
 	constructor(clone) {
@@ -448,6 +469,7 @@ class RuntimeSpecMap {
 	}
 
 	/**
+	 * Returns value.
 	 * @param {RuntimeSpec} runtime the runtimes
 	 * @returns {R | undefined} value
 	 */
@@ -467,6 +489,7 @@ class RuntimeSpecMap {
 	}
 
 	/**
+	 * Returns true, when the runtime is stored.
 	 * @param {RuntimeSpec} runtime the runtimes
 	 * @returns {boolean} true, when the runtime is stored
 	 */
@@ -484,6 +507,7 @@ class RuntimeSpecMap {
 	}
 
 	/**
+	 * Updates default using the provided runtime.
 	 * @param {RuntimeSpec} runtime the runtimes
 	 * @param {R} value the value
 	 */
@@ -515,6 +539,7 @@ class RuntimeSpecMap {
 	}
 
 	/**
+	 * Returns the new value.
 	 * @param {RuntimeSpec} runtime the runtimes
 	 * @param {() => R} computer function to compute the value
 	 * @returns {R} the new value
@@ -557,6 +582,7 @@ class RuntimeSpecMap {
 	}
 
 	/**
+	 * Processes the provided runtime.
 	 * @param {RuntimeSpec} runtime the runtimes
 	 */
 	delete(runtime) {
@@ -577,6 +603,7 @@ class RuntimeSpecMap {
 	}
 
 	/**
+	 * Processes the provided runtime.
 	 * @param {RuntimeSpec} runtime the runtimes
 	 * @param {(value: R | undefined) => R} fn function to update the value
 	 */
@@ -634,6 +661,7 @@ class RuntimeSpecMap {
 	}
 
 	/**
+	 * Returns values.
 	 * @returns {IterableIterator<R>} values
 	 */
 	values() {
@@ -658,6 +686,7 @@ class RuntimeSpecMap {
 
 class RuntimeSpecSet {
 	/**
+	 * Creates an instance of RuntimeSpecSet.
 	 * @param {Iterable<RuntimeSpec>=} iterable iterable
 	 */
 	constructor(iterable) {
@@ -671,6 +700,7 @@ class RuntimeSpecSet {
 	}
 
 	/**
+	 * Processes the provided runtime.
 	 * @param {RuntimeSpec} runtime runtime
 	 */
 	add(runtime) {
@@ -678,6 +708,7 @@ class RuntimeSpecSet {
 	}
 
 	/**
+	 * Returns true, when the runtime exists.
 	 * @param {RuntimeSpec} runtime runtime
 	 * @returns {boolean} true, when the runtime exists
 	 */
@@ -686,6 +717,7 @@ class RuntimeSpecSet {
 	}
 
 	/**
+	 * Returns iterable iterator.
 	 * @returns {IterableIterator<RuntimeSpec>} iterable iterator
 	 */
 	[Symbol.iterator]() {

package/lib/util/semver.js

@@ -11,11 +11,13 @@
 /** @typedef {(SemVerRangeItem | SemVerRangeItem[])[]} SemVerRange */
 
 /**
+ * Returns parsed version.
  * @param {string} str version string
  * @returns {SemVerRange} parsed version
  */
 const parseVersion = (str) => {
 	/**
+	 * Returns result.
 	 * @param {str} str str
 	 * @returns {VersionValue[]} result
 	 */
@@ -49,6 +51,7 @@ module.exports.parseVersion = parseVersion;
 
 /* eslint-disable eqeqeq */
 /**
+ * Returns true, iff a < b.
  * @param {string} a version
  * @param {string} b version
  * @returns {boolean} true, iff a < b
@@ -98,11 +101,13 @@ const versionLt = (a, b) => {
 module.exports.versionLt = versionLt;
 
 /**
+ * Returns parsed range.
  * @param {string} str range string
  * @returns {SemVerRange} parsed range
  */
 module.exports.parseRange = (str) => {
 	/**
+	 * Returns result.
 	 * @param {string} str str
 	 * @returns {VersionValue[]} result
 	 */
@@ -114,6 +119,7 @@ module.exports.parseRange = (str) => {
 
 	// see https://docs.npmjs.com/misc/semver#range-grammar for grammar
 	/**
+	 * Returns the sem ver range item.
 	 * @param {string} str str
 	 * @returns {SemVerRangeItem[]}
 	 */
@@ -143,6 +149,7 @@ module.exports.parseRange = (str) => {
 	};
 
 	/**
+	 * Returns the sem ver range item.
 	 *
 	 * @param {SemVerRangeItem[]} range range
 	 * @returns {SemVerRangeItem[]}
@@ -163,6 +170,7 @@ module.exports.parseRange = (str) => {
 	};
 
 	/**
+	 * Returns result.
 	 *
 	 * @param {SemVerRangeItem[]} range
 	 * @returns {SemVerRangeItem[]} result
@@ -172,6 +180,7 @@ module.exports.parseRange = (str) => {
 	};
 
 	/**
+	 * Returns the sem ver range.
 	 * @param {string} str str
 	 * @returns {SemVerRange}
 	 */
@@ -230,6 +239,7 @@ module.exports.parseRange = (str) => {
 	};
 
 	/**
+	 * Returns result.
 	 *
 	 * @param {SemVerRangeItem[][]} items items
 	 * @param {number} fn fn
@@ -251,6 +261,7 @@ module.exports.parseRange = (str) => {
 	};
 
 	/**
+	 * Returns the sem ver range.
 	 * @param {string} str str
 	 * @returns {SemVerRange}
 	 */
@@ -291,6 +302,7 @@ module.exports.parseRange = (str) => {
 	};
 
 	/**
+	 * Returns the sem ver range.
 	 * @param {string} str str
 	 * @returns {SemVerRange}
 	 */
@@ -309,6 +321,7 @@ module.exports.parseRange = (str) => {
 
 /* eslint-disable eqeqeq */
 /**
+ * Returns the string.
  * @param {SemVerRange} range
  * @returns {string}
  */
@@ -370,6 +383,7 @@ const rangeToString = (range) => {
 module.exports.rangeToString = rangeToString;
 
 /**
+ * Returns if version satisfy the range.
  * @param {SemVerRange} range version range
  * @param {string} version the version
  * @returns {boolean} if version satisfy the range
@@ -531,6 +545,7 @@ const satisfy = (range, version) => {
 module.exports.satisfy = satisfy;
 
 /**
+ * Returns the string.
  * @param {SemVerRange | string | number | false | undefined} json
  * @returns {string}
  */

package/lib/util/serialization.js

@@ -13,6 +13,7 @@ const memoize = require("./memoize");
 /** @typedef {import("../util/fs").IntermediateFileSystem} IntermediateFileSystem */
 
 /**
+ * Defines the serializer type used by this module.
  * @template D, S, C
  * @typedef {import("../serialization/Serializer")<D, S, C>} Serializer
  */
@@ -109,6 +110,7 @@ module.exports = {
 		);
 	},
 	/**
+	 * Creates a file serializer.
 	 * @template D, S, C
 	 * @param {IntermediateFileSystem} fs filesystem
 	 * @param {HashFunction} hashFunction hash function to use

package/lib/util/smartGrouping.js

@@ -6,6 +6,7 @@
 "use strict";
 
 /**
+ * Defines the group options type used by this module.
  * @typedef {object} GroupOptions
  * @property {boolean=} groupChildren
  * @property {boolean=} force
@@ -13,6 +14,7 @@
  */
 
 /**
+ * Defines the group config type used by this module.
  * @template I
  * @template G
  * @typedef {object} GroupConfig
@@ -22,17 +24,20 @@
  */
 
 /**
+ * Defines the group type used by this module.
  * @template I
  * @template G
  * @typedef {{ config: GroupConfig<I, G>, name: string, alreadyGrouped: boolean, items: Items<I, G> | undefined }} Group
  */
 
 /**
+ * Defines the groups type used by this module.
  * @template I, G
  * @typedef {Set<Group<I, G>>} Groups
  */
 
 /**
+ * Defines the item with groups type used by this module.
  * @template I
  * @template G
  * @typedef {object} ItemWithGroups
@@ -41,11 +46,13 @@
  */
 
 /**
+ * Defines the items type used by this module.
  * @template T, G
  * @typedef {Set<ItemWithGroups<T, G>>} Items
  */
 
 /**
+ * Returns grouped items.
  * @template I
  * @template G
  * @template R
@@ -90,6 +97,7 @@ const smartGrouping = (items, groupConfigs) => {
 	}
 
 	/**
+	 * Returns groups items.
 	 * @param {Items<I, G>} itemsWithGroups input items with groups
 	 * @returns {(I | G)[]} groups items
 	 */

package/lib/util/source.js

@@ -11,6 +11,7 @@
 const equalityCache = new WeakMap();
 
 /**
+ * Checks whether source equal true, when both sources are equal.
  * @param {Source} a a source
  * @param {Source} b another source
  * @returns {boolean} true, when both sources are equal
@@ -29,6 +30,7 @@ const _isSourceEqual = (a, b) => {
 };
 
 /**
+ * Checks whether this object is source equal.
  * @param {Source} a a source
  * @param {Source} b another source
  * @returns {boolean} true, when both sources are equal

package/lib/validateSchema.js

@@ -69,6 +69,7 @@ const REMOVED = {
 /* cSpell:enable */
 
 /**
+ * Processes the provided schema.
  * @param {Parameters<typeof validate>[0]} schema a json schema
  * @param {Parameters<typeof validate>[1]} options the options that should be validated
  * @param {Parameters<typeof validate>[2]=} validationConfiguration configuration for generating errors

package/lib/wasm/EnableWasmLoadingPlugin.js

@@ -14,6 +14,8 @@
 const enabledTypes = new WeakMap();
 
 /**
+ * Returns the set of wasm loading backends that have already been enabled for
+ * the compiler.
  * @param {Compiler} compiler compiler instance
  * @returns {WasmLoadingTypes} enabled types
  */
@@ -27,8 +29,14 @@ const getEnabledTypes = (compiler) => {
 	return set;
 };
 
+/**
+ * Validates and enables named wasm loading backends by applying the plugin
+ * implementations that provide their runtime support.
+ */
 class EnableWasmLoadingPlugin {
 	/**
+	 * Stores the wasm loading backend name that should be enabled for the
+	 * compiler.
 	 * @param {WasmLoadingType} type library type that should be available
 	 */
 	constructor(type) {
@@ -37,6 +45,8 @@ class EnableWasmLoadingPlugin {
 	}
 
 	/**
+	 * Marks a custom or built-in wasm loading type as enabled for the compiler
+	 * without applying additional built-in behavior.
 	 * @param {Compiler} compiler the compiler instance
 	 * @param {WasmLoadingType} type type of library
 	 * @returns {void}
@@ -46,6 +56,8 @@ class EnableWasmLoadingPlugin {
 	}
 
 	/**
+	 * Verifies that a wasm loading type has been enabled before code generation
+	 * attempts to use it.
 	 * @param {Compiler} compiler the compiler instance
 	 * @param {WasmLoadingType} type type of library
 	 * @returns {void}
@@ -63,7 +75,9 @@ class EnableWasmLoadingPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Enables the requested wasm loading backend once and applies the
+	 * environment-specific plugins that provide its parser, generator, and
+	 * runtime support.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */

package/lib/wasm-async/AsyncWasmCompileRuntimeModule.js

@@ -46,6 +46,7 @@ class AsyncWasmCompileRuntimeModule extends RuntimeModule {
 	}
 
 	/**
+	 * Generates runtime code for this runtime module.
 	 * @returns {string | null} runtime code
 	 */
 	generate() {

package/lib/wasm-async/AsyncWasmLoadingRuntimeModule.js

@@ -47,6 +47,7 @@ class AsyncWasmLoadingRuntimeModule extends RuntimeModule {
 	}
 
 	/**
+	 * Generates runtime code for this runtime module.
 	 * @returns {string | null} runtime code
 	 */
 	generate() {

package/lib/wasm-async/AsyncWebAssemblyGenerator.js

@@ -16,12 +16,14 @@ const { WEBASSEMBLY_TYPES } = require("../ModuleSourceTypeConstants");
 /** @typedef {import("../NormalModule")} NormalModule */
 
 /**
+ * Represents the async web assembly generator runtime component.
  * @typedef {object} AsyncWebAssemblyGeneratorOptions
  * @property {boolean=} mangleImports mangle imports
  */
 
 class AsyncWebAssemblyGenerator extends Generator {
 	/**
+	 * Creates an instance of AsyncWebAssemblyGenerator.
 	 * @param {AsyncWebAssemblyGeneratorOptions} options options
 	 */
 	constructor(options) {
@@ -31,6 +33,7 @@ class AsyncWebAssemblyGenerator extends Generator {
 	}
 
 	/**
+	 * Returns the source types available for this module.
 	 * @param {NormalModule} module fresh module
 	 * @returns {SourceTypes} available types (do not mutate)
 	 */
@@ -39,6 +42,7 @@ class AsyncWebAssemblyGenerator extends Generator {
 	}
 
 	/**
+	 * Returns the estimated size for the requested source type.
 	 * @param {NormalModule} module the module
 	 * @param {SourceType=} type source type
 	 * @returns {number} estimate size of the module
@@ -52,6 +56,7 @@ class AsyncWebAssemblyGenerator extends Generator {
 	}
 
 	/**
+	 * Generates generated code for this runtime module.
 	 * @param {NormalModule} module module for which the code should be generated
 	 * @param {GenerateContext} generateContext context for generate
 	 * @returns {Source | null} generated code
@@ -61,6 +66,7 @@ class AsyncWebAssemblyGenerator extends Generator {
 	}
 
 	/**
+	 * Generates fallback output for the provided error condition.
 	 * @param {Error} error the error
 	 * @param {NormalModule} module module for which the code should be generated
 	 * @param {GenerateContext} generateContext context for generate

package/lib/wasm-async/AsyncWebAssemblyJavascriptGenerator.js

@@ -22,11 +22,13 @@ const WebAssemblyImportDependency = require("../dependencies/WebAssemblyImportDe
 /** @typedef {import("../NormalModule")} NormalModule */
 
 /**
+ * Represents the async web assembly javascript generator runtime component.
  * @typedef {{ request: string, importVar: string, dependency: WebAssemblyImportDependency }} ImportObjRequestItem
  */
 
 class AsyncWebAssemblyJavascriptGenerator extends Generator {
 	/**
+	 * Returns the source types available for this module.
 	 * @param {NormalModule} module fresh module
 	 * @returns {SourceTypes} available types (do not mutate)
 	 */
@@ -35,6 +37,7 @@ class AsyncWebAssemblyJavascriptGenerator extends Generator {
 	}
 
 	/**
+	 * Returns the estimated size for the requested source type.
 	 * @param {NormalModule} module the module
 	 * @param {SourceType=} type source type
 	 * @returns {number} estimate size of the module
@@ -50,6 +53,7 @@ class AsyncWebAssemblyJavascriptGenerator extends Generator {
 	}
 
 	/**
+	 * Generates generated code for this runtime module.
 	 * @param {NormalModule} module module for which the code should be generated
 	 * @param {GenerateContext} generateContext context for generate
 	 * @returns {Source | null} generated code
@@ -253,6 +257,7 @@ class AsyncWebAssemblyJavascriptGenerator extends Generator {
 	}
 
 	/**
+	 * Generates fallback output for the provided error condition.
 	 * @param {Error} error the error
 	 * @param {NormalModule} module module for which the code should be generated
 	 * @param {GenerateContext} generateContext context for generate

package/lib/wasm-async/AsyncWebAssemblyModulesPlugin.js

@@ -53,6 +53,7 @@ class AsyncWasmModule extends NormalModule {
 	}
 
 	/**
+	 * Returns the unique identifier used to reference this module.
 	 * @returns {string} a unique identifier of the module
 	 */
 	identifier() {
@@ -79,6 +80,7 @@ class AsyncWasmModule extends NormalModule {
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize(context) {
@@ -117,6 +119,7 @@ class AsyncWasmModule extends NormalModule {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 */
 	deserialize(context) {
@@ -129,6 +132,7 @@ class AsyncWasmModule extends NormalModule {
 makeSerializable(AsyncWasmModule, "webpack/lib/wasm-async/AsyncWasmModule");
 
 /**
+ * Defines the web assembly render context type used by this module.
  * @typedef {object} WebAssemblyRenderContext
  * @property {Chunk} chunk the chunk
  * @property {DependencyTemplates} dependencyTemplates the dependency templates
@@ -139,11 +143,13 @@ makeSerializable(AsyncWasmModule, "webpack/lib/wasm-async/AsyncWasmModule");
  */
 
 /**
+ * Defines the compilation hooks type used by this module.
  * @typedef {object} CompilationHooks
  * @property {SyncWaterfallHook<[Source, Module, WebAssemblyRenderContext]>} renderModuleContent
  */
 
 /**
+ * Defines the async web assembly modules plugin options type used by this module.
  * @typedef {object} AsyncWebAssemblyModulesPluginOptions
  * @property {boolean=} mangleImports mangle imports
  */
@@ -155,6 +161,7 @@ const PLUGIN_NAME = "AsyncWebAssemblyModulesPlugin";
 
 class AsyncWebAssemblyModulesPlugin {
 	/**
+	 * Returns the attached hooks.
 	 * @param {Compilation} compilation the compilation
 	 * @returns {CompilationHooks} the attached hooks
 	 */
@@ -179,6 +186,7 @@ class AsyncWebAssemblyModulesPlugin {
 	}
 
 	/**
+	 * Creates an instance of AsyncWebAssemblyModulesPlugin.
 	 * @param {AsyncWebAssemblyModulesPluginOptions} options options
 	 */
 	constructor(options) {
@@ -187,7 +195,7 @@ class AsyncWebAssemblyModulesPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -286,6 +294,7 @@ class AsyncWebAssemblyModulesPlugin {
 	}
 
 	/**
+	 * Renders the newly generated source from rendering.
 	 * @param {Module} module the rendered module
 	 * @param {WebAssemblyRenderContext} renderContext options object
 	 * @param {CompilationHooks} hooks hooks

package/lib/wasm-async/AsyncWebAssemblyParser.js

@@ -31,6 +31,7 @@ const decoderOpts = {
 
 class WebAssemblyParser extends Parser {
 	/**
+	 * Parses the provided source and updates the parser state.
 	 * @param {string | Buffer | PreparsedAst} source the source to parse
 	 * @param {ParserState} state the parser state
 	 * @returns {ParserState} the parser state