@depup/webpack 5.106.0-depup.0 → 5.109.0-depup.0

package/lib/serialization/PlainObjectSerializer.js

@@ -4,18 +4,17 @@
 
 "use strict";
 
-/** @typedef {import("./ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
-/** @typedef {import("./ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
-
 /** @typedef {EXPECTED_FUNCTION} CacheAssoc */
 
 /**
+ * Defines the shared type used by this module.
  * @template T
  * @typedef {WeakMap<CacheAssoc, ObjectStructure<T>>}
  */
 const cache = new WeakMap();
 
 /**
+ * Represents ObjectStructure.
  * @template T
  */
 class ObjectStructure {
@@ -27,6 +26,7 @@ class ObjectStructure {
 	}
 
 	/**
+	 * Returns keys.
 	 * @param {keyof T[]} keys keys
 	 * @returns {keyof T[]} keys
 	 */
@@ -36,6 +36,7 @@ class ObjectStructure {
 	}
 
 	/**
+	 * Returns object structure.
 	 * @param {keyof T} key key
 	 * @returns {ObjectStructure<T>} object structure
 	 */
@@ -50,6 +51,7 @@ class ObjectStructure {
 }
 
 /**
+ * Returns keys.
  * @template T
  * @param {(keyof T)[]} keys keys
  * @param {CacheAssoc} cacheAssoc cache assoc fn
@@ -70,9 +72,10 @@ const getCachedKeys = (keys, cacheAssoc) => {
 
 class PlainObjectSerializer {
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @template {object} T
 	 * @param {T} obj plain object
-	 * @param {ObjectSerializerContext} context context
+	 * @param {import("./ObjectMiddleware").ObjectSerializerContext<((keyof T)[] | keyof T | null | T[keyof T])[]>} context context
 	 */
 	serialize(obj, context) {
 		const keys = /** @type {(keyof T)[]} */ (Object.keys(obj));
@@ -98,19 +101,24 @@ class PlainObjectSerializer {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @template {object} T
-	 * @param {ObjectDeserializerContext} context context
+	 * @param {import("./ObjectMiddleware").ObjectDeserializerContext<((keyof T)[] | keyof T | null | T[keyof T])[]>} context context
 	 * @returns {T} plain object
 	 */
 	deserialize(context) {
-		const keys = context.read();
+		const keys = /** @type {(keyof T)[] | keyof T | null} */ (context.read());
 		const obj = /** @type {T} */ ({});
 		if (Array.isArray(keys)) {
 			for (const key of keys) {
-				obj[/** @type {keyof T} */ (key)] = context.read();
+				obj[/** @type {keyof T} */ (key)] = /** @type {T[keyof T]} */ (
+					context.read()
+				);
 			}
 		} else if (keys !== null) {
-			obj[/** @type {keyof T} */ (keys)] = context.read();
+			obj[/** @type {keyof T} */ (keys)] = /** @type {T[keyof T]} */ (
+				context.read()
+			);
 		}
 		return obj;
 	}

package/lib/serialization/RegExpObjectSerializer.js

@@ -4,11 +4,12 @@
 
 "use strict";
 
-/** @typedef {import("./ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
-/** @typedef {import("./ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
+/** @typedef {import("./ObjectMiddleware").ObjectDeserializerContext<[string, string]>} ObjectDeserializerContext */
+/** @typedef {import("./ObjectMiddleware").ObjectSerializerContext<[string, string]>} ObjectSerializerContext */
 
 class RegExpObjectSerializer {
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {RegExp} obj regexp
 	 * @param {ObjectSerializerContext} context context
 	 */
@@ -18,6 +19,7 @@ class RegExpObjectSerializer {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 * @returns {RegExp} regexp
 	 */

package/lib/serialization/Serializer.js

@@ -5,27 +5,32 @@
 "use strict";
 
 /**
+ * Defines the serializer middleware type used by this module.
  * @template T, K, C
  * @typedef {import("./SerializerMiddleware")<T, K, C>} SerializerMiddleware
  */
 
 /**
+ * Represents Serializer.
  * @template DeserializedValue
  * @template SerializedValue
  * @template Context
  */
 class Serializer {
 	/**
+	 * Creates an instance of Serializer.
 	 * @param {SerializerMiddleware<EXPECTED_ANY, EXPECTED_ANY, EXPECTED_ANY>[]} middlewares serializer middlewares
 	 * @param {Context=} context context
 	 */
 	constructor(middlewares, context) {
 		this.serializeMiddlewares = [...middlewares];
 		this.deserializeMiddlewares = [...middlewares].reverse();
+		/** @type {Context | undefined} */
 		this.context = context;
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @template ExtendedContext
 	 * @param {DeserializedValue | Promise<DeserializedValue>} obj object
 	 * @param {Context & ExtendedContext} context context object
@@ -57,6 +62,7 @@ class Serializer {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @template ExtendedContext
 	 * @param {SerializedValue | Promise<SerializedValue>} value value
 	 * @param {Context & ExtendedContext} context object

package/lib/serialization/SerializerMiddleware.js

@@ -13,6 +13,7 @@ const LAZY_SERIALIZED_VALUE = Symbol("lazy serialization data");
 /** @typedef {Record<string, EXPECTED_ANY>} LazyOptions */
 
 /**
+ * Defines the lazy function type used by this module.
  * @template InputValue
  * @template OutputValue
  * @template {LazyTarget} InternalLazyTarget
@@ -21,6 +22,7 @@ const LAZY_SERIALIZED_VALUE = Symbol("lazy serialization data");
  */
 
 /**
+ * Represents SerializerMiddleware.
  * @template DeserializedType
  * @template SerializedType
  * @template Context
@@ -28,31 +30,34 @@ const LAZY_SERIALIZED_VALUE = Symbol("lazy serialization data");
 class SerializerMiddleware {
 	/* istanbul ignore next */
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @abstract
 	 * @param {DeserializedType} data data
 	 * @param {Context} context context object
 	 * @returns {SerializedType | Promise<SerializedType> | null} serialized data
 	 */
 	serialize(data, context) {
-		const AbstractMethodError = require("../AbstractMethodError");
+		const AbstractMethodError = require("../errors/AbstractMethodError");
 
 		throw new AbstractMethodError();
 	}
 
 	/* istanbul ignore next */
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @abstract
 	 * @param {SerializedType} data data
 	 * @param {Context} context context object
 	 * @returns {DeserializedType | Promise<DeserializedType>} deserialized data
 	 */
 	deserialize(data, context) {
-		const AbstractMethodError = require("../AbstractMethodError");
+		const AbstractMethodError = require("../errors/AbstractMethodError");
 
 		throw new AbstractMethodError();
 	}
 
 	/**
+	 * Creates a lazy from the provided value.
 	 * @template TLazyInputValue
 	 * @template TLazyOutputValue
 	 * @template {LazyTarget} TLazyTarget
@@ -80,6 +85,7 @@ class SerializerMiddleware {
 	}
 
 	/**
+	 * Checks whether this serializer middleware is lazy.
 	 * @template {LazyTarget} TLazyTarget
 	 * @param {EXPECTED_ANY} fn lazy function
 	 * @param {TLazyTarget=} target target middleware
@@ -92,6 +98,7 @@ class SerializerMiddleware {
 	}
 
 	/**
+	 * Returns options.
 	 * @template TLazyInputValue
 	 * @template TLazyOutputValue
 	 * @template {LazyTarget} TLazyTarget
@@ -105,6 +112,7 @@ class SerializerMiddleware {
 	}
 
 	/**
+	 * Gets lazy serialized value.
 	 * @template TLazyInputValue
 	 * @template TLazyOutputValue
 	 * @template {LazyTarget} TLazyTarget
@@ -118,6 +126,7 @@ class SerializerMiddleware {
 	}
 
 	/**
+	 * Sets lazy serialized value.
 	 * @template TLazyInputValue
 	 * @template TLazyOutputValue
 	 * @template {LazyTarget} TLazyTarget
@@ -131,6 +140,7 @@ class SerializerMiddleware {
 	}
 
 	/**
+	 * Returns new lazy.
 	 * @template TLazyInputValue DeserializedValue
 	 * @template TLazyOutputValue SerializedValue
 	 * @template {LazyTarget} TLazyTarget
@@ -165,6 +175,7 @@ class SerializerMiddleware {
 	}
 
 	/**
+	 * Returns new lazy.
 	 * @template TLazyInputValue SerializedValue
 	 * @template TLazyOutputValue DeserializedValue
 	 * @template {LazyTarget} TLazyTarget
@@ -198,6 +209,7 @@ class SerializerMiddleware {
 	}
 
 	/**
+	 * Returns new lazy.
 	 * @template TLazyInputValue
 	 * @template TLazyOutputValue
 	 * @template {LazyTarget} TLazyTarget

package/lib/serialization/SetObjectSerializer.js

@@ -4,14 +4,12 @@
 
 "use strict";
 
-/** @typedef {import("./ObjectMiddleware").ObjectDeserializerContext} ObjectDeserializerContext */
-/** @typedef {import("./ObjectMiddleware").ObjectSerializerContext} ObjectSerializerContext */
-
 class SetObjectSerializer {
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @template T
 	 * @param {Set<T>} obj set
-	 * @param {ObjectSerializerContext} context context
+	 * @param {import("./ObjectMiddleware").ObjectSerializerContext<(number | T)[]>} context context
 	 */
 	serialize(obj, context) {
 		context.write(obj.size);
@@ -21,17 +19,17 @@ class SetObjectSerializer {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @template T
-	 * @param {ObjectDeserializerContext} context context
+	 * @param {import("./ObjectMiddleware").ObjectDeserializerContext<(number | T)[]>} context context
 	 * @returns {Set<T>} date
 	 */
 	deserialize(context) {
-		/** @type {number} */
-		const size = context.read();
+		const size = /** @type {number} */ (context.read());
 		/** @type {Set<T>} */
 		const set = new Set();
 		for (let i = 0; i < size; i++) {
-			set.add(context.read());
+			set.add(/** @type {T} */ (context.read()));
 		}
 		return set;
 	}

package/lib/serialization/SingleItemMiddleware.js

@@ -11,10 +11,12 @@ const SerializerMiddleware = require("./SerializerMiddleware");
 /** @typedef {EXPECTED_OBJECT} Context */
 
 /**
+ * Represents SingleItemMiddleware.
  * @extends {SerializerMiddleware<DeserializedType, SerializedType, Context>}
  */
 class SingleItemMiddleware extends SerializerMiddleware {
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {DeserializedType} data data
 	 * @param {Context} context context object
 	 * @returns {SerializedType | Promise<SerializedType> | null} serialized data
@@ -24,6 +26,7 @@ class SingleItemMiddleware extends SerializerMiddleware {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {SerializedType} data data
 	 * @param {Context} context context object
 	 * @returns {DeserializedType | Promise<DeserializedType>} deserialized data

package/lib/sharing/ConsumeSharedFallbackDependency.js

@@ -10,6 +10,7 @@ const makeSerializable = require("../util/makeSerializable");
 
 class ConsumeSharedFallbackDependency extends ModuleDependency {
 	/**
+	 * Creates an instance of ConsumeSharedFallbackDependency.
 	 * @param {string} request the request
 	 */
 	constructor(request) {

package/lib/sharing/ConsumeSharedModule.js

@@ -39,14 +39,15 @@ const fallbackModuleCache = new WeakMap();
 /** @typedef {import("../Module").ExportsType} ExportsType */
 /** @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<[ConsumeOptions]>} ObjectDeserializerContext */
+/** @typedef {import("../serialization/ObjectMiddleware").ObjectSerializerContext<[ConsumeOptions]>} ObjectSerializerContext */
 /** @typedef {import("../util/Hash")} Hash */
 /** @typedef {import("../util/fs").InputFileSystem} InputFileSystem */
 /** @typedef {import("../util/semver").SemVerRange} SemVerRange */
 /** @typedef {import("../Module").BasicSourceTypes} BasicSourceTypes */
 
 /**
+ * Represents the consume shared module runtime component.
  * @typedef {object} ConsumeOptions
  * @property {string=} import fallback request
  * @property {string=} importResolved resolved fallback request
@@ -61,15 +62,18 @@ const fallbackModuleCache = new WeakMap();
 
 class ConsumeSharedModule extends Module {
 	/**
+	 * Creates an instance of ConsumeSharedModule.
 	 * @param {string} context context
 	 * @param {ConsumeOptions} options consume options
 	 */
 	constructor(context, options) {
 		super(WEBPACK_MODULE_TYPE_CONSUME_SHARED_MODULE, context);
+		/** @type {ConsumeOptions} */
 		this.options = options;
 	}
 
 	/**
+	 * Returns the unique identifier used to reference this module.
 	 * @returns {string} a unique identifier of the module
 	 */
 	identifier() {
@@ -88,6 +92,7 @@ class ConsumeSharedModule 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
 	 */
@@ -111,6 +116,7 @@ class ConsumeSharedModule extends Module {
 	}
 
 	/**
+	 * Gets the library identifier.
 	 * @param {LibIdentOptions} options options
 	 * @returns {LibIdent | null} an identifier for library inclusion
 	 */
@@ -124,6 +130,7 @@ class ConsumeSharedModule 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}
@@ -133,6 +140,7 @@ class ConsumeSharedModule 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
@@ -157,6 +165,7 @@ class ConsumeSharedModule extends Module {
 	}
 
 	/**
+	 * Returns the source types this module can generate.
 	 * @returns {SourceTypes} types available (do not mutate)
 	 */
 	getSourceTypes() {
@@ -177,6 +186,7 @@ class ConsumeSharedModule extends Module {
 	}
 
 	/**
+	 * Get fallback module.
 	 * @param {ModuleGraph} moduleGraph the module graph
 	 * @returns {Module | null} fallback module
 	 */
@@ -213,6 +223,7 @@ class ConsumeSharedModule extends Module {
 	}
 
 	/**
+	 * Returns export type.
 	 * @param {ModuleGraph} moduleGraph the module graph
 	 * @param {boolean | undefined} strict the importing module is strict
 	 * @returns {ExportsType} export type
@@ -228,6 +239,7 @@ class ConsumeSharedModule 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)
 	 */
@@ -236,6 +248,7 @@ class ConsumeSharedModule 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}
@@ -246,6 +259,7 @@ class ConsumeSharedModule extends Module {
 	}
 
 	/**
+	 * Generates code and runtime requirements for this module.
 	 * @param {CodeGenerationContext} context context for code generation
 	 * @returns {CodeGenerationResult} result
 	 */
@@ -318,21 +332,21 @@ class ConsumeSharedModule extends Module {
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize(context) {
-		const { write } = context;
-		write(this.options);
+		context.write(this.options);
 		super.serialize(context);
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 */
 	deserialize(context) {
-		const { read } = context;
-		this.options = read();
-		super.deserialize(context);
+		this.options = context.read();
+		super.deserialize(context.rest);
 	}
 }
 

package/lib/sharing/ConsumeSharedPlugin.js

@@ -5,10 +5,10 @@
 
 "use strict";
 
-const ModuleNotFoundError = require("../ModuleNotFoundError");
 const RuntimeGlobals = require("../RuntimeGlobals");
-const WebpackError = require("../WebpackError");
 const { parseOptions } = require("../container/options");
+const ModuleNotFoundError = require("../errors/ModuleNotFoundError");
+const WebpackError = require("../errors/WebpackError");
 const LazySet = require("../util/LazySet");
 const { parseRange } = require("../util/semver");
 const ConsumeSharedFallbackDependency = require("./ConsumeSharedFallbackDependency");
@@ -37,14 +37,16 @@ const PLUGIN_NAME = "ConsumeSharedPlugin";
 
 class ConsumeSharedPlugin {
 	/**
+	 * Creates an instance of ConsumeSharedPlugin.
 	 * @param {ConsumeSharedPluginOptions} options options
 	 */
 	constructor(options) {
+		/** @type {ConsumeSharedPluginOptions} */
 		this.options = options;
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -149,6 +151,7 @@ class ConsumeSharedPlugin {
 				);
 
 				/**
+				 * Creates a consume shared module.
 				 * @param {string} context issuer directory
 				 * @param {string} request request
 				 * @param {ConsumeOptions} config options
@@ -156,6 +159,7 @@ class ConsumeSharedPlugin {
 				 */
 				const createConsumeSharedModule = (context, request, config) => {
 					/**
+					 * Required version warning.
 					 * @param {string} details details
 					 */
 					const requiredVersionWarning = (details) => {
@@ -171,6 +175,7 @@ class ConsumeSharedPlugin {
 					return Promise.all([
 						new Promise(
 							/**
+							 * Handles the callback logic for this hook.
 							 * @param {(value?: string) => void} resolve resolve
 							 */
 							(resolve) => {
@@ -214,6 +219,7 @@ class ConsumeSharedPlugin {
 						),
 						new Promise(
 							/**
+							 * Handles the name callback for this hook.
 							 * @param {(value?: SemVerRange) => void} resolve resolve
 							 */
 							(resolve) => {
@@ -351,15 +357,9 @@ class ConsumeSharedPlugin {
 						) {
 							return Promise.resolve();
 						}
-						const options = resolvedConsumes.get(
-							/** @type {string} */ (resource)
-						);
+						const options = resolvedConsumes.get(resource);
 						if (options !== undefined) {
-							return createConsumeSharedModule(
-								context,
-								/** @type {string} */ (resource),
-								options
-							);
+							return createConsumeSharedModule(context, resource, options);
 						}
 						return Promise.resolve();
 					}