webpack 5.106.0 → 5.106.2

package/lib/schemes/HttpUriPlugin.js

@@ -38,11 +38,13 @@ const MAX_REDIRECTS = 5;
 /** @typedef {(url: URL, requestOptions: RequestOptions, callback: (incomingMessage: IncomingMessage) => void) => EventEmitter} Fetch */
 
 /**
+ * Defines the events map type used by this module.
  * @typedef {object} EventsMap
  * @property {[Error]} error
  */
 
 /**
+ * Returns fn.
  * @param {typeof import("http") | typeof import("https")} request request
  * @param {string | URL | undefined} proxy proxy
  * @returns {Fetch} fn
@@ -52,6 +54,7 @@ const proxyFetch = (request, proxy) => (url, options, callback) => {
 	const eventEmitter = new EventEmitter();
 
 	/**
+	 * Processes the provided socket.
 	 * @param {Socket=} socket socket
 	 * @returns {void}
 	 */
@@ -105,6 +108,7 @@ const proxyFetch = (request, proxy) => (url, options, callback) => {
 let inProgressWrite;
 
 /**
+ * Returns safe path.
  * @param {string} str path
  * @returns {string} safe path
  */
@@ -112,6 +116,7 @@ const toSafePath = (str) =>
 	str.replace(/^[^a-z0-9]+|[^a-z0-9]+$/gi, "").replace(/[^a-z0-9._-]+/gi, "_");
 
 /**
+ * Returns integrity.
  * @param {Buffer} content content
  * @returns {string} integrity
  */
@@ -123,6 +128,7 @@ const computeIntegrity = (content) => {
 };
 
 /**
+ * Returns true, if integrity matches.
  * @param {Buffer} content content
  * @param {string} integrity integrity
  * @returns {boolean} true, if integrity matches
@@ -133,6 +139,7 @@ const verifyIntegrity = (content, integrity) => {
 };
 
 /**
+ * Parses key value pairs.
  * @param {string} str input
  * @returns {Record<string, string>} parsed
  */
@@ -155,6 +162,7 @@ const parseKeyValuePairs = (str) => {
 };
 
 /**
+ * Parses cache control.
  * @param {string | undefined} cacheControl Cache-Control header
  * @param {number} requestTime timestamp of request
  * @returns {{ storeCache: boolean, storeLock: boolean, validUntil: number }} Logic for storing in cache and lockfile cache
@@ -182,6 +190,7 @@ const parseCacheControl = (cacheControl, requestTime) => {
 };
 
 /**
+ * Defines the lockfile entry type used by this module.
  * @typedef {object} LockfileEntry
  * @property {string} resolved
  * @property {string} integrity
@@ -189,6 +198,7 @@ const parseCacheControl = (cacheControl, requestTime) => {
  */
 
 /**
+ * Are lockfile entries equal.
  * @param {LockfileEntry} a first lockfile entry
  * @param {LockfileEntry} b second lockfile entry
  * @returns {boolean} true when equal, otherwise false
@@ -199,6 +209,7 @@ const areLockfileEntriesEqual = (a, b) =>
 	a.contentType === b.contentType;
 
 /**
+ * Returns , integrity: ${string}, contentType: ${string}`} stringified entry.
  * @param {LockfileEntry} entry lockfile entry
  * @returns {`resolved: ${string}, integrity: ${string}, contentType: ${string}`} stringified entry
  */
@@ -230,6 +241,7 @@ class Lockfile {
 	}
 
 	/**
+	 * Parses the provided source and updates the parser state.
 	 * @param {string} content content of the lockfile
 	 * @returns {Lockfile} lockfile
 	 */
@@ -257,6 +269,7 @@ class Lockfile {
 	}
 
 	/**
+	 * Returns a string representation.
 	 * @returns {string} stringified lockfile
 	 */
 	toString() {
@@ -281,16 +294,19 @@ class Lockfile {
 }
 
 /**
+ * Defines the fn without key callback type used by this module.
  * @template R
  * @typedef {(err: Error | null, result?: R) => void}  FnWithoutKeyCallback
  */
 
 /**
+ * Defines the fn without key type used by this module.
  * @template R
  * @typedef {(callback: FnWithoutKeyCallback<R>) => void} FnWithoutKey
  */
 
 /**
+ * Caches d without key.
  * @template R
  * @param {FnWithoutKey<R>} fn function
  * @returns {FnWithoutKey<R>} cached function
@@ -324,17 +340,20 @@ const cachedWithoutKey = (fn) => {
 };
 
 /**
+ * Defines the fn with key callback type used by this module.
  * @template R
  * @typedef {(err: Error | null, result?: R) => void} FnWithKeyCallback
  */
 
 /**
+ * Defines the fn with key type used by this module.
  * @template T
  * @template R
  * @typedef {(item: T, callback: FnWithKeyCallback<R>) => void} FnWithKey
  */
 
 /**
+ * Returns } cached function.
  * @template T
  * @template R
  * @param {FnWithKey<T, R>} fn function
@@ -343,12 +362,14 @@ const cachedWithoutKey = (fn) => {
  */
 const cachedWithKey = (fn, forceFn = fn) => {
 	/**
+	 * Defines the cache entry type used by this module.
 	 * @template R
 	 * @typedef {{ result?: R, error?: Error, callbacks?: FnWithKeyCallback<R>[], force?: true }} CacheEntry
 	 */
 	/** @type {Map<T, CacheEntry<R>>} */
 	const cache = new Map();
 	/**
+	 * Processes the provided arg.
 	 * @param {T} arg arg
 	 * @param {FnWithKeyCallback<R>} callback callback
 	 * @returns {void}
@@ -381,6 +402,7 @@ const cachedWithKey = (fn, forceFn = fn) => {
 		});
 	};
 	/**
+	 * Processes the provided arg.
 	 * @param {T} arg arg
 	 * @param {FnWithKeyCallback<R>} callback callback
 	 * @returns {void}
@@ -417,12 +439,14 @@ const cachedWithKey = (fn, forceFn = fn) => {
 };
 
 /**
+ * Defines the lockfile cache type used by this module.
  * @typedef {object} LockfileCache
  * @property {Lockfile} lockfile lockfile
  * @property {Snapshot} snapshot snapshot
  */
 
 /**
+ * Defines the resolve content result type used by this module.
  * @typedef {object} ResolveContentResult
  * @property {LockfileEntry} entry lockfile entry
  * @property {Buffer} content content
@@ -440,6 +464,7 @@ const PLUGIN_NAME = "HttpUriPlugin";
 
 class HttpUriPlugin {
 	/**
+	 * Creates an instance of HttpUriPlugin.
 	 * @param {HttpUriPluginOptions} options options
 	 */
 	constructor(options) {
@@ -448,7 +473,7 @@ class HttpUriPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -519,6 +544,7 @@ class HttpUriPlugin {
 				/** @type {Map<string, string>} */
 				const cacheKeyCache = new Map();
 				/**
+				 * Returns the key.
 				 * @param {string} url the url
 				 * @returns {string} the key
 				 */
@@ -531,6 +557,7 @@ class HttpUriPlugin {
 				};
 
 				/**
+				 * Returns the key.
 				 * @param {string} url the url
 				 * @returns {string} the key
 				 */
@@ -552,6 +579,7 @@ class HttpUriPlugin {
 
 				const getLockfile = cachedWithoutKey(
 					/**
+					 * Handles the callback logic for this hook.
 					 * @param {(err: Error | null, lockfile?: Lockfile) => void} callback callback
 					 * @returns {void}
 					 */
@@ -604,6 +632,7 @@ class HttpUriPlugin {
 				let lockfileUpdates;
 
 				/**
+				 * Stores the provided lockfile.
 				 * @param {Lockfile} lockfile lockfile instance
 				 * @param {string} url url to store
 				 * @param {LockfileEntry | "ignore" | "no-cache"} entry lockfile entry
@@ -643,6 +672,7 @@ class HttpUriPlugin {
 				};
 
 				/**
+				 * Stores the provided lockfile.
 				 * @param {Lockfile} lockfile lockfile
 				 * @param {string} url url
 				 * @param {ResolveContentResult} result result
@@ -672,6 +702,7 @@ class HttpUriPlugin {
 
 				for (const { scheme, fetch } of schemes) {
 					/**
+					 * Validate redirect location.
 					 * @param {string} location Location header value (relative or absolute)
 					 * @param {string} base current absolute URL
 					 * @returns {string} absolute, validated redirect target
@@ -702,6 +733,7 @@ class HttpUriPlugin {
 						return nextUrl.href;
 					};
 					/**
+					 * Processes the provided url.
 					 * @param {string} url URL
 					 * @param {string | null} integrity integrity
 					 * @param {(err: Error | null, resolveContentResult?: ResolveContentResult) => void} callback callback
@@ -714,6 +746,7 @@ class HttpUriPlugin {
 						redirectCount = 0
 					) => {
 						/**
+						 * Processes the provided err.
 						 * @param {Error | null} err error
 						 * @param {FetchResult=} _result fetch result
 						 * @returns {void}
@@ -772,6 +805,7 @@ class HttpUriPlugin {
 					};
 
 					/**
+					 * Processes the provided url.
 					 * @param {string} url URL
 					 * @param {FetchResult | RedirectFetchResult | undefined} cachedResult result from cache
 					 * @param {(err: Error | null, fetchResult?: FetchResult) => void} callback callback
@@ -798,6 +832,7 @@ class HttpUriPlugin {
 								requestTime
 							);
 							/**
+							 * Processes the provided partial result.
 							 * @param {Partial<Pick<FetchResultMeta, "fresh">> & (Pick<RedirectFetchResult, "location"> | Pick<ContentFetchResult, "content" | "entry">)} partialResult result
 							 * @returns {void}
 							 */
@@ -914,6 +949,7 @@ class HttpUriPlugin {
 							stream.on(
 								"data",
 								/**
+								 * Handles the callback logic for this hook.
 								 * @param {Buffer} chunk chunk
 								 */
 								(chunk) => {
@@ -957,6 +993,7 @@ class HttpUriPlugin {
 
 					const fetchContent = cachedWithKey(
 						/**
+						 * Handles the callback logic for this hook.
 						 * @param {string} url URL
 						 * @param {(err: Error | null, result?: FetchResult) => void} callback callback
 						 * @returns {void}
@@ -975,6 +1012,7 @@ class HttpUriPlugin {
 					);
 
 					/**
+					 * Checks whether this http uri plugin is allowed.
 					 * @param {string} uri uri
 					 * @returns {boolean} true when allowed, otherwise false
 					 */
@@ -1013,6 +1051,7 @@ class HttpUriPlugin {
 
 					const getInfo = cachedWithKey(
 						/**
+						 * Processes the provided url.
 						 * @param {string} url the url
 						 * @param {(err: Error | null, info?: Info) => void} callback callback
 						 * @returns {void}
@@ -1085,6 +1124,7 @@ Remove this line from the lockfile to force upgrading.`
 								}
 								let entry = entryOrString;
 								/**
+								 * Processes the provided locked content.
 								 * @param {Buffer=} lockedContent locked content
 								 */
 								const doFetch = (lockedContent) => {
@@ -1165,6 +1205,7 @@ Remove this line from the lockfile to force upgrading.`
 										}
 										const content = /** @type {Buffer} */ (result);
 										/**
+										 * Continue with cached content.
 										 * @param {Buffer | undefined} _result result
 										 * @returns {void}
 										 */
@@ -1262,6 +1303,7 @@ Run build with un-frozen lockfile to automatically fix lockfile.`
 					);
 
 					/**
+					 * Respond with url module.
 					 * @param {URL} url url
 					 * @param {ResourceDataWithData} resourceData resource data
 					 * @param {(err: Error | null, result: true | void) => void} callback callback

package/lib/schemes/VirtualUrlPlugin.js

@@ -17,6 +17,7 @@ const DEFAULT_SCHEME = "virtual";
 const PLUGIN_NAME = "VirtualUrlPlugin";
 
 /**
+ * Defines the compiler type used by this module.
  * @typedef {import("../Compiler")} Compiler
  * @typedef {import("../../declarations/plugins/schemes/VirtualUrlPlugin").VirtualModule} VirtualModuleConfig
  * @typedef {import("../../declarations/plugins/schemes/VirtualUrlPlugin").VirtualModuleContent} VirtualModuleInput
@@ -28,6 +29,7 @@ const PLUGIN_NAME = "VirtualUrlPlugin";
 /** @typedef {{ [key: string]: VirtualModuleInput }} VirtualModules */
 
 /**
+ * Defines the loader context type used by this module.
  * @template T
  * @typedef {import("../../declarations/LoaderContext").LoaderContext<T>} LoaderContext
  */
@@ -103,6 +105,7 @@ function toCacheKey(id, scheme) {
 
 class VirtualUrlPlugin {
 	/**
+	 * Creates an instance of VirtualUrlPlugin.
 	 * @param {VirtualModules} modules The virtual modules
 	 * @param {Omit<VirtualUrlOptions, "modules"> | string=} schemeOrOptions The URL scheme to use
 	 */
@@ -124,7 +127,7 @@ class VirtualUrlPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -156,6 +159,7 @@ class VirtualUrlPlugin {
 					(path, data) => {
 						if (data.filename && this.modules[data.filename]) {
 							/**
+							 * Returns safe path.
 							 * @param {string} str path
 							 * @returns {string} safe path
 							 */
@@ -261,6 +265,7 @@ class VirtualUrlPlugin {
 	}
 
 	/**
+	 * Finds virtual module config by id.
 	 * @param {string} id The module id
 	 * @returns {VirtualModuleConfig} The virtual module config
 	 */

package/lib/serialization/AggregateErrorSerializer.js

@@ -11,6 +11,7 @@
 
 class AggregateErrorSerializer {
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {AggregateError} obj error
 	 * @param {ObjectSerializerContext} context context
 	 */
@@ -22,6 +23,7 @@ class AggregateErrorSerializer {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 * @returns {AggregateError} error
 	 */

package/lib/serialization/ArraySerializer.js

@@ -9,6 +9,7 @@
 
 class ArraySerializer {
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @template T
 	 * @param {T[]} array array
 	 * @param {ObjectSerializerContext} context context
@@ -19,6 +20,7 @@ class ArraySerializer {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @template T
 	 * @param {ObjectDeserializerContext} context context
 	 * @returns {T[]} array

package/lib/serialization/BinaryMiddleware.js

@@ -114,6 +114,7 @@ const MEASURE_END_OPERATION = Symbol("MEASURE_END_OPERATION");
 /** @typedef {typeof MEASURE_END_OPERATION} MEASURE_END_OPERATION_TYPE */
 
 /**
+ * Returns type of number for serialization.
  * @param {number} n number
  * @returns {0 | 1 | 2} type of number for serialization
  */
@@ -126,6 +127,7 @@ const identifyNumber = (n) => {
 };
 
 /**
+ * Returns type of bigint for serialization.
  * @param {bigint} n bigint
  * @returns {0 | 1 | 2} type of bigint for serialization
  */
@@ -140,16 +142,19 @@ const identifyBigInt = (n) => {
 /** @typedef {{ retainedBuffer?: (x: Buffer) => Buffer }} Context} */
 
 /**
+ * Defines the lazy function type used by this module.
  * @template LazyInputValue
  * @template LazyOutputValue
  * @typedef {import("./SerializerMiddleware").LazyFunction<LazyInputValue, LazyOutputValue, BinaryMiddleware, undefined>} LazyFunction
  */
 
 /**
+ * Represents BinaryMiddleware.
  * @extends {SerializerMiddleware<DeserializedType, SerializedType, Context>}
  */
 class BinaryMiddleware 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
@@ -159,6 +164,7 @@ class BinaryMiddleware extends SerializerMiddleware {
 	}
 
 	/**
+	 * Returns new lazy.
 	 * @param {LazyFunction<DeserializedType, SerializedType>} fn lazy function
 	 * @param {Context} context serialize function
 	 * @returns {LazyFunction<SerializedType, DeserializedType>} new lazy
@@ -170,6 +176,7 @@ class BinaryMiddleware extends SerializerMiddleware {
 	}
 
 	/**
+	 * Returns serialized data.
 	 * @param {DeserializedType} data data
 	 * @param {Context} context context object
 	 * @param {{ leftOverBuffer: Buffer | null, allocationSize: number, increaseCounter: number }} allocationScope allocation scope
@@ -196,6 +203,7 @@ class BinaryMiddleware extends SerializerMiddleware {
 			currentBuffer = Buffer.allocUnsafe(allocationScope.allocationSize);
 		}
 		/**
+		 * Processes the provided bytes needed.
 		 * @param {number} bytesNeeded bytes needed
 		 */
 		const allocate = (bytesNeeded) => {
@@ -246,6 +254,7 @@ class BinaryMiddleware extends SerializerMiddleware {
 			}
 		};
 		/**
+		 * Processes the provided byte.
 		 * @param {number} byte byte
 		 */
 		const writeU8 = (byte) => {
@@ -253,6 +262,7 @@ class BinaryMiddleware extends SerializerMiddleware {
 			(currentBuffer).writeUInt8(byte, currentPosition++);
 		};
 		/**
+		 * Processes the provided ui32.
 		 * @param {number} ui32 ui32
 		 */
 		const writeU32 = (ui32) => {
@@ -266,6 +276,7 @@ class BinaryMiddleware extends SerializerMiddleware {
 			measureStack.push(buffers.length, currentPosition);
 		};
 		/**
+		 * Returns size.
 		 * @returns {number} size
 		 */
 		const measureEnd = () => {
@@ -653,6 +664,7 @@ class BinaryMiddleware 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
@@ -662,6 +674,7 @@ class BinaryMiddleware extends SerializerMiddleware {
 	}
 
 	/**
+	 * Create lazy deserialized.
 	 * @private
 	 * @param {SerializedType} content content
 	 * @param {Context} context context object
@@ -677,6 +690,7 @@ class BinaryMiddleware extends SerializerMiddleware {
 	}
 
 	/**
+	 * Returns new lazy.
 	 * @private
 	 * @param {LazyFunction<SerializedType, DeserializedType>} fn lazy function
 	 * @param {Context} context context object
@@ -689,6 +703,7 @@ class BinaryMiddleware extends SerializerMiddleware {
 	}
 
 	/**
+	 * Returns deserialized data.
 	 * @param {SerializedType} data data
 	 * @param {Context} context context object
 	 * @returns {DeserializedType} deserialized data
@@ -712,6 +727,7 @@ class BinaryMiddleware extends SerializerMiddleware {
 			}
 		};
 		/**
+		 * Checks whether this binary middleware is in current buffer.
 		 * @param {number} n n
 		 * @returns {boolean} true when in current buffer, otherwise false
 		 */
@@ -728,7 +744,7 @@ class BinaryMiddleware extends SerializerMiddleware {
 			}
 		};
 		/**
-		 * Reads n bytes
+		 * Returns buffer with bytes.
 		 * @param {number} n amount of bytes to read
 		 * @returns {Buffer} buffer with bytes
 		 */
@@ -779,6 +795,7 @@ class BinaryMiddleware extends SerializerMiddleware {
 			return res;
 		};
 		/**
+		 * Returns u8.
 		 * @returns {number} U8
 		 */
 		const readU8 = () => {
@@ -795,10 +812,12 @@ class BinaryMiddleware extends SerializerMiddleware {
 			return byte;
 		};
 		/**
+		 * Returns u32.
 		 * @returns {number} U32
 		 */
 		const readU32 = () => read(I32_SIZE).readUInt32LE(0);
 		/**
+		 * Processes the provided data.
 		 * @param {number} data data
 		 * @param {number} n n
 		 */

package/lib/serialization/DateObjectSerializer.js

@@ -9,6 +9,7 @@
 
 class DateObjectSerializer {
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {Date} obj date
 	 * @param {ObjectSerializerContext} context context
 	 */
@@ -17,6 +18,7 @@ class DateObjectSerializer {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 * @returns {Date} date
 	 */

package/lib/serialization/ErrorObjectSerializer.js

@@ -11,6 +11,7 @@
 
 class ErrorObjectSerializer {
 	/**
+	 * Creates an instance of ErrorObjectSerializer.
 	 * @param {ErrorConstructor | EvalErrorConstructor | RangeErrorConstructor | ReferenceErrorConstructor | SyntaxErrorConstructor | TypeErrorConstructor} Type error type
 	 */
 	constructor(Type) {
@@ -18,6 +19,7 @@ class ErrorObjectSerializer {
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {Error | EvalError | RangeError | ReferenceError | SyntaxError | TypeError} obj error
 	 * @param {ObjectSerializerContext} context context
 	 */
@@ -31,6 +33,7 @@ class ErrorObjectSerializer {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 * @returns {Error | EvalError | RangeError | ReferenceError | SyntaxError | TypeError} error
 	 */