@depup/webpack 5.106.1-depup.0 → 5.109.2-depup.0

package/lib/ProvidePlugin.js

@@ -24,14 +24,16 @@ const PLUGIN_NAME = "ProvidePlugin";
 
 class ProvidePlugin {
 	/**
+	 * Creates an instance of ProvidePlugin.
 	 * @param {Record<string, string | string[]>} definitions the provided identifiers
 	 */
 	constructor(definitions) {
+		/** @type {Record<string, string | string[]>} */
 		this.definitions = definitions;
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -53,6 +55,7 @@ class ProvidePlugin {
 					new ProvidedDependency.Template()
 				);
 				/**
+				 * Handles the hook callback for this code path.
 				 * @param {JavascriptParser} parser the parser
 				 * @param {JavascriptParserOptions} parserOptions options
 				 * @returns {void}
@@ -82,7 +85,7 @@ class ProvidePlugin {
 								request.slice(1),
 								/** @type {Range} */ (expr.range)
 							);
-							dep.loc = /** @type {DependencyLocation} */ (expr.loc);
+							dep.loc = parser.getLocation(expr);
 							parser.state.module.addDependency(dep);
 							return true;
 						});
@@ -97,7 +100,7 @@ class ProvidePlugin {
 								request.slice(1),
 								/** @type {Range} */ (expr.callee.range)
 							);
-							dep.loc = /** @type {DependencyLocation} */ (expr.callee.loc);
+							dep.loc = parser.getLocation(expr.callee);
 							parser.state.module.addDependency(dep);
 							parser.walkExpressions(expr.arguments);
 							return true;

package/lib/RawModule.js

@@ -29,13 +29,14 @@ const makeSerializable = require("./util/makeSerializable");
 /** @typedef {import("./ModuleGraphConnection").ConnectionState} ConnectionState */
 /** @typedef {import("./RequestShortener")} RequestShortener */
 /** @typedef {import("./ResolverFactory").ResolverWithOptions} ResolverWithOptions */
-/** @typedef {import("./serialization/ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
-/** @typedef {import("./serialization/ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
+/** @typedef {import("./serialization/ObjectMiddleware").ObjectDeserializerContext<[string, string, string, ReadOnlyRuntimeRequirements | null]>} ObjectDeserializerContext */
+/** @typedef {import("./serialization/ObjectMiddleware").ObjectSerializerContext<[string, string, string, ReadOnlyRuntimeRequirements | null]>} ObjectSerializerContext */
 /** @typedef {import("./util/Hash")} Hash */
 /** @typedef {import("./util/fs").InputFileSystem} InputFileSystem */
 
 class RawModule extends Module {
 	/**
+	 * Creates an instance of RawModule.
 	 * @param {string} source source code
 	 * @param {string} identifier unique identifier
 	 * @param {string=} readableIdentifier readable identifier
@@ -43,13 +44,18 @@ class RawModule extends Module {
 	 */
 	constructor(source, identifier, readableIdentifier, runtimeRequirements) {
 		super(JAVASCRIPT_MODULE_TYPE_DYNAMIC, null);
+		/** @type {string} */
 		this.sourceStr = source;
+		/** @type {string} */
 		this.identifierStr = identifier || this.sourceStr;
+		/** @type {string} */
 		this.readableIdentifierStr = readableIdentifier || this.identifierStr;
+		/** @type {ReadOnlyRuntimeRequirements | null} */
 		this.runtimeRequirements = runtimeRequirements || null;
 	}
 
 	/**
+	 * Returns the source types this module can generate.
 	 * @returns {SourceTypes} types available (do not mutate)
 	 */
 	getSourceTypes() {
@@ -57,6 +63,7 @@ class RawModule extends Module {
 	}
 
 	/**
+	 * Returns the unique identifier used to reference this module.
 	 * @returns {string} a unique identifier of the module
 	 */
 	identifier() {
@@ -64,6 +71,7 @@ class RawModule extends Module {
 	}
 
 	/**
+	 * Returns the estimated size for the requested source type.
 	 * @param {string=} type the source type for which the size should be estimated
 	 * @returns {number} the estimated size of the module (must be non-zero)
 	 */
@@ -72,6 +80,7 @@ class RawModule extends Module {
 	}
 
 	/**
+	 * Returns a human-readable identifier for this module.
 	 * @param {RequestShortener} requestShortener the request shortener
 	 * @returns {string} a user readable identifier of the module
 	 */
@@ -82,6 +91,7 @@ class RawModule extends Module {
 	}
 
 	/**
+	 * Checks whether the module needs to be rebuilt for the current build state.
 	 * @param {NeedBuildContext} context context info
 	 * @param {NeedBuildCallback} callback callback function, returns true, if the module needs a rebuild
 	 * @returns {void}
@@ -91,6 +101,7 @@ class RawModule extends Module {
 	}
 
 	/**
+	 * Builds the module using the provided compilation context.
 	 * @param {WebpackOptions} options webpack options
 	 * @param {Compilation} compilation the compilation
 	 * @param {ResolverWithOptions} resolver the resolver
@@ -107,6 +118,7 @@ class RawModule extends Module {
 	}
 
 	/**
+	 * Gets side effects connection state.
 	 * @param {ModuleGraph} moduleGraph the module graph
 	 * @returns {ConnectionState} how this module should be connected to referencing modules when consumed for side-effects only
 	 */
@@ -119,6 +131,7 @@ class RawModule extends Module {
 	}
 
 	/**
+	 * Generates code and runtime requirements for this module.
 	 * @param {CodeGenerationContext} context context for code generation
 	 * @returns {CodeGenerationResult} result
 	 */
@@ -137,6 +150,7 @@ class RawModule extends Module {
 	}
 
 	/**
+	 * Updates the hash with the data contributed by this instance.
 	 * @param {Hash} hash the hash used to track dependencies
 	 * @param {UpdateHashContext} context context
 	 * @returns {void}
@@ -147,31 +161,33 @@ class RawModule extends Module {
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize(context) {
-		const { write } = context;
-
-		write(this.sourceStr);
-		write(this.identifierStr);
-		write(this.readableIdentifierStr);
-		write(this.runtimeRequirements);
+		context
+			.write(this.sourceStr)
+			.write(this.identifierStr)
+			.write(this.readableIdentifierStr)
+			.write(this.runtimeRequirements);
 
 		super.serialize(context);
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 */
 	deserialize(context) {
-		const { read } = context;
-
-		this.sourceStr = read();
-		this.identifierStr = read();
-		this.readableIdentifierStr = read();
-		this.runtimeRequirements = read();
-
-		super.deserialize(context);
+		this.sourceStr = context.read();
+		const c1 = context.rest;
+		this.identifierStr = c1.read();
+		const c2 = c1.rest;
+		this.readableIdentifierStr = c2.read();
+		const c3 = c2.rest;
+		this.runtimeRequirements = c3.read();
+
+		super.deserialize(c3.rest);
 	}
 }
 

package/lib/RecordIdsPlugin.js

@@ -13,6 +13,7 @@ const identifierUtils = require("./util/identifier");
 /** @typedef {import("./Module")} Module */
 
 /**
+ * Defines the records chunks type used by this module.
  * @typedef {object} RecordsChunks
  * @property {Record<string, number>=} byName
  * @property {Record<string, number>=} bySource
@@ -20,18 +21,21 @@ const identifierUtils = require("./util/identifier");
  */
 
 /**
+ * Defines the records modules type used by this module.
  * @typedef {object} RecordsModules
  * @property {Record<string, number>=} byIdentifier
  * @property {number[]=} usedIds
  */
 
 /**
+ * Defines the records type used by this module.
  * @typedef {object} Records
  * @property {RecordsChunks=} chunks
  * @property {RecordsModules=} modules
  */
 
 /**
+ * Defines the record ids plugin options type used by this module.
  * @typedef {object} RecordIdsPluginOptions
  * @property {boolean=} portableIds true, when ids need to be portable
  */
@@ -42,13 +46,16 @@ const PLUGIN_NAME = "RecordIdsPlugin";
 
 class RecordIdsPlugin {
 	/**
+	 * Creates an instance of RecordIdsPlugin.
 	 * @param {RecordIdsPluginOptions=} options object
 	 */
 	constructor(options) {
+		/** @type {RecordIdsPluginOptions} */
 		this.options = options || {};
 	}
 
 	/**
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the Compiler
 	 * @returns {void}
 	 */
@@ -62,6 +69,7 @@ class RecordIdsPlugin {
 			);
 
 		/**
+		 * Gets module identifier.
 		 * @param {Module} module the module
 		 * @returns {string} the (portable) identifier
 		 */
@@ -113,6 +121,7 @@ class RecordIdsPlugin {
 			/** @typedef {string[]} ChunkSources */
 
 			/**
+			 * Gets chunk sources.
 			 * @param {Chunk} chunk the chunk
 			 * @returns {ChunkSources} sources of the chunk
 			 */

package/lib/RequestShortener.js

@@ -9,8 +9,14 @@ const { contextify } = require("./util/identifier");
 
 /** @typedef {import("./util/identifier").AssociatedObjectForCache} AssociatedObjectForCache */
 
+/**
+ * Shortens absolute or verbose request strings so diagnostics and stats output
+ * can be rendered relative to a chosen base directory.
+ */
 class RequestShortener {
 	/**
+	 * Binds a context-aware shortening function to the provided directory and
+	 * optional cache owner.
 	 * @param {string} dir the directory
 	 * @param {AssociatedObjectForCache=} associatedObjectForCache an object to which the cache will be attached
 	 */
@@ -22,6 +28,8 @@ class RequestShortener {
 	}
 
 	/**
+	 * Returns a request string rewritten relative to the configured directory
+	 * when one is provided.
 	 * @param {string | undefined | null} request the request to shorten
 	 * @returns {string | undefined | null} the shortened request
 	 */

package/lib/ResolverFactory.js

@@ -20,6 +20,7 @@ const {
 
 /** @typedef {WebpackResolveOptions & { dependencyType?: string, resolveToContext?: boolean }} ResolveOptionsWithDependencyType */
 /**
+ * Defines the with options type used by this module.
  * @typedef {object} WithOptions
  * @property {(options: Partial<ResolveOptionsWithDependencyType>) => ResolverWithOptions} withOptions create a resolver with additional/different options
  */
@@ -31,6 +32,7 @@ const {
 const EMPTY_RESOLVE_OPTIONS = {};
 
 /**
+ * Convert to resolve options.
  * @param {ResolveOptionsWithDependencyType} resolveOptionsWithDepType enhanced options
  * @returns {ResolveOptions} merged options
  */
@@ -69,6 +71,7 @@ const convertToResolveOptions = (resolveOptionsWithDepType) => {
 };
 
 /**
+ * Represents the resolver factory runtime component.
  * @typedef {object} ResolverCache
  * @property {WeakMap<ResolveOptionsWithDependencyType, ResolverWithOptions>} direct
  * @property {Map<string, ResolverWithOptions>} stringified
@@ -91,6 +94,7 @@ module.exports = class ResolverFactory {
 	}
 
 	/**
+	 * Returns the resolver.
 	 * @param {string} type type of resolver
 	 * @param {ResolveOptionsWithDependencyType=} resolveOptions options
 	 * @returns {ResolverWithOptions} the resolver
@@ -121,6 +125,7 @@ module.exports = class ResolverFactory {
 	}
 
 	/**
+	 * Returns the resolver.
 	 * @param {string} type type of resolver
 	 * @param {ResolveOptionsWithDependencyType} resolveOptionsWithDepType options
 	 * @returns {ResolverWithOptions} the resolver

package/lib/RuntimeGlobals.js

@@ -15,6 +15,13 @@ module.exports.amdDefine = "__webpack_require__.amdD";
  */
 module.exports.amdOptions = "__webpack_require__.amdO";
 
+/**
+ * analyzable single-chunk `import()` that keeps `ensureChunk` timing and deduplication:
+ * resolves immediately for an installed chunk, else runs the literal import and installs it
+ * Signature: (chunkId, () => Promise) => Promise
+ */
+module.exports.analyzableChunkImport = "__webpack_require__.ei";
+
 /**
  * Creates an async module. The body function must be a async function.
  * "module.exports" will be decorated with an AsyncModulePromise.
@@ -39,6 +46,15 @@ module.exports.asyncModuleDoneSymbol = "__webpack_require__.aD";
  */
 module.exports.asyncModuleExportSymbol = "__webpack_require__.aE";
 
+/**
+ * Drives an async module body written as a generator function (used when the
+ * target environment supports generators but not `async`/`await`).
+ * It runs the generator, resolving each `yield`ed dependency promise, so the
+ * body reads like a plain `async` function without emitting `async`/`await`.
+ * Signature: function(body: GeneratorFunction) => (handleDependencies, result) => void
+ */
+module.exports.asyncModuleGenerator = "__webpack_require__.aG";
+
 /**
  * the baseURI of current document
  */
@@ -54,6 +70,11 @@ module.exports.chunkCallback = "webpackChunk";
  */
 module.exports.chunkName = "__webpack_require__.cn";
 
+/**
+ * wrap and eagerly execute a CommonJS module body, returning its exports
+ */
+module.exports.commonJsWrap = "__webpack_require__.cjs";
+
 /**
  * compatibility get default export
  */
@@ -83,12 +104,7 @@ module.exports.createScript = "__webpack_require__.ts";
  */
 module.exports.createScriptUrl = "__webpack_require__.tu";
 
-/**
- * merge multiple CSS stylesheets (CSSStyleSheet or string) into one CSS text string
- * Arguments: (sheets: Array<CSSStyleSheet | string> | CSSStyleSheet | string) => string
- */
 module.exports.cssInjectStyle = "__webpack_require__.is";
-module.exports.cssMergeStyleSheets = "__webpack_require__.mcs";
 
 /**
  * The current scope when getting a module from a remote
@@ -200,6 +216,12 @@ module.exports.getTrustedTypesPolicy = "__webpack_require__.tt";
  */
 module.exports.getUpdateManifestFilename = "__webpack_require__.hmrF";
 
+/**
+ * the object url of the worklet bootstrap script (sets up `self`, `location` and
+ * a throwing `importScripts` before worklet chunks are added)
+ */
+module.exports.getWorkletBootstrap = "__webpack_require__.wb";
+
 /**
  * the global object
  */
@@ -336,6 +358,12 @@ module.exports.nodeModuleDecorator = "__webpack_require__.nmd";
  */
 module.exports.onChunksLoaded = "__webpack_require__.O";
 
+/**
+ * the asset prefetch function: injects a
+ * `<link rel="prefetch">` for an asset module URL
+ */
+module.exports.prefetchAsset = "__webpack_require__.PA";
+
 /**
  * the chunk prefetch function
  */
@@ -346,6 +374,12 @@ module.exports.prefetchChunk = "__webpack_require__.E";
  */
 module.exports.prefetchChunkHandlers = "__webpack_require__.F";
 
+/**
+ * the asset preload function: injects a
+ * `<link rel="preload">` for an asset module URL
+ */
+module.exports.preloadAsset = "__webpack_require__.LA";
+
 /**
  * the chunk preload function
  */
@@ -391,6 +425,11 @@ module.exports.runtimeId = "__webpack_require__.j";
  */
 module.exports.scriptNonce = "__webpack_require__.nc";
 
+/**
+ * set .name to "default" for anonymous default exports per ES spec
+ */
+module.exports.setAnonymousDefaultName = "__webpack_require__.dn";
+
 /**
  * an object with all share scopes
  */
@@ -402,6 +441,14 @@ module.exports.shareScopeMap = "__webpack_require__.S";
  */
 module.exports.startup = "__webpack_require__.x";
 
+/**
+ * marker requirement that adds the startup runtime module which fires
+ * `<link rel="prefetch|preload">` for `new URL(..., import.meta.url)`
+ * assets with `webpackPrefetch` / `webpackPreload` hints, before any
+ * chunk module evaluates
+ */
+module.exports.startupAssetHints = "__webpack_require__.SAH";
+
 /**
  * method to startup an entrypoint with needed chunks.
  * Signature: (moduleId: Id, chunkIds: Id[]) => any.
@@ -410,6 +457,7 @@ module.exports.startup = "__webpack_require__.x";
 module.exports.startupEntrypoint = "__webpack_require__.X";
 
 /**
+ * Describes how this item operation behaves.
  * @deprecated
  * creating a default startup function with the entry modules
  */
@@ -454,3 +502,8 @@ module.exports.uncaughtErrorHandler = "__webpack_require__.oe";
  * an object containing all installed WebAssembly.Instance export objects keyed by module id
  */
 module.exports.wasmInstances = "__webpack_require__.w";
+
+/**
+ * the Worker constructor for universal targets (global Worker or worker_threads)
+ */
+module.exports.worker = "__webpack_require__.wc";

package/lib/RuntimeModule.js

@@ -36,6 +36,7 @@ const { WEBPACK_MODULE_TYPE_RUNTIME } = require("./ModuleTypeConstants");
 
 class RuntimeModule extends Module {
 	/**
+	 * Creates an instance of RuntimeModule.
 	 * @param {string} name a readable name
 	 * @param {number=} stage an optional stage
 	 */
@@ -64,6 +65,7 @@ class RuntimeModule extends Module {
 	}
 
 	/**
+	 * Processes the provided compilation.
 	 * @param {Compilation} compilation the compilation
 	 * @param {Chunk} chunk the chunk
 	 * @param {ChunkGraph} chunkGraph the chunk graph
@@ -76,6 +78,7 @@ class RuntimeModule extends Module {
 	}
 
 	/**
+	 * Returns the unique identifier used to reference this module.
 	 * @returns {string} a unique identifier of the module
 	 */
 	identifier() {
@@ -83,6 +86,7 @@ class RuntimeModule extends Module {
 	}
 
 	/**
+	 * Returns a human-readable identifier for this module.
 	 * @param {RequestShortener} requestShortener the request shortener
 	 * @returns {string} a user readable identifier of the module
 	 */
@@ -91,6 +95,7 @@ class RuntimeModule extends Module {
 	}
 
 	/**
+	 * Checks whether the module needs to be rebuilt for the current build state.
 	 * @param {NeedBuildContext} context context info
 	 * @param {NeedBuildCallback} callback callback function, returns true, if the module needs a rebuild
 	 * @returns {void}
@@ -100,6 +105,7 @@ class RuntimeModule extends Module {
 	}
 
 	/**
+	 * Builds the module using the provided compilation context.
 	 * @param {WebpackOptions} options webpack options
 	 * @param {Compilation} compilation the compilation
 	 * @param {ResolverWithOptions} resolver the resolver
@@ -114,6 +120,7 @@ class RuntimeModule extends Module {
 	}
 
 	/**
+	 * Updates the hash with the data contributed by this instance.
 	 * @param {Hash} hash the hash used to track dependencies
 	 * @param {UpdateHashContext} context context
 	 * @returns {void}
@@ -122,12 +129,14 @@ class RuntimeModule extends Module {
 		hash.update(this.name);
 		hash.update(`${this.stage}`);
 		try {
-			if (this.fullHash || this.dependentHash) {
-				// Do not use getGeneratedCode here, because i. e. compilation hash might be not
-				// ready at this point. We will cache it later instead.
-				hash.update(/** @type {string} */ (this.generate()));
-			} else {
-				hash.update(/** @type {string} */ (this.getGeneratedCode()));
+			const code =
+				this.fullHash || this.dependentHash
+					? // Do not use getGeneratedCode here, because i. e. compilation hash might be not
+						// ready at this point. We will cache it later instead.
+						this.generate()
+					: this.getGeneratedCode();
+			if (code !== null && code !== undefined) {
+				hash.update(code);
 			}
 		} catch (err) {
 			hash.update(/** @type {Error} */ (err).message);
@@ -136,6 +145,7 @@ class RuntimeModule extends Module {
 	}
 
 	/**
+	 * Returns the source types this module can generate.
 	 * @returns {SourceTypes} types available (do not mutate)
 	 */
 	getSourceTypes() {
@@ -156,6 +166,7 @@ class RuntimeModule extends Module {
 	}
 
 	/**
+	 * Generates code and runtime requirements for this module.
 	 * @param {CodeGenerationContext} context context for code generation
 	 * @returns {CodeGenerationResult} result
 	 */
@@ -178,6 +189,7 @@ class RuntimeModule extends Module {
 	}
 
 	/**
+	 * Returns the estimated size for the requested source type.
 	 * @param {string=} type the source type for which the size should be estimated
 	 * @returns {number} the estimated size of the module (must be non-zero)
 	 */
@@ -192,16 +204,18 @@ class RuntimeModule extends Module {
 
 	/* istanbul ignore next */
 	/**
+	 * Generates runtime code for this runtime module.
 	 * @abstract
 	 * @returns {string | null} runtime code
 	 */
 	generate() {
-		const AbstractMethodError = require("./AbstractMethodError");
+		const AbstractMethodError = require("./errors/AbstractMethodError");
 
 		throw new AbstractMethodError();
 	}
 
 	/**
+	 * Gets generated code.
 	 * @returns {string | null} runtime code
 	 */
 	getGeneratedCode() {
@@ -212,6 +226,7 @@ class RuntimeModule extends Module {
 	}
 
 	/**
+	 * Returns true, if the runtime module should get it's own scope.
 	 * @returns {boolean} true, if the runtime module should get it's own scope
 	 */
 	shouldIsolate() {