webpack 5.106.1 → 5.106.2

package/lib/ExternalModule.js

@@ -75,6 +75,7 @@ const { register } = require("./util/serialization");
 /** @typedef {ImportDependencyMeta | CssImportDependencyMeta | AssetDependencyMeta} DependencyMeta */
 
 /**
+ * Defines the source data type used by this module.
  * @typedef {object} SourceData
  * @property {boolean=} iife
  * @property {string=} init
@@ -98,6 +99,7 @@ const RUNTIME_REQUIREMENTS_FOR_MODULE = new Set([
 const EMPTY_RUNTIME_REQUIREMENTS = new Set();
 
 /**
+ * Gets source for global variable external.
  * @param {string | string[]} variableName the variable name or path
  * @param {string} type the module system
  * @returns {SourceData} the generated source
@@ -121,6 +123,7 @@ const getSourceForGlobalVariableExternal = (variableName, type) => {
 /** @typedef {string | string[]} ModuleAndSpecifiers */
 
 /**
+ * Gets source for common js external.
  * @param {ModuleAndSpecifiers} moduleAndSpecifiers the module request
  * @returns {SourceData} the generated source
  */
@@ -140,6 +143,7 @@ const getSourceForCommonJsExternal = (moduleAndSpecifiers) => {
 };
 
 /**
+ * Gets external module node commonjs init fragment.
  * @param {RuntimeTemplate} runtimeTemplate the runtime template
  * @returns {InitFragment<ChunkRenderContext>} code
  */
@@ -157,6 +161,7 @@ const getExternalModuleNodeCommonjsInitFragment = (runtimeTemplate) => {
 };
 
 /**
+ * Gets source for common js external in node module.
  * @param {ModuleAndSpecifiers} moduleAndSpecifiers the module request
  * @param {RuntimeTemplate} runtimeTemplate the runtime template
  * @returns {SourceData} the generated source
@@ -186,6 +191,7 @@ const getSourceForCommonJsExternalInNodeModule = (
 };
 
 /**
+ * Gets source for import external.
  * @param {ModuleAndSpecifiers} moduleAndSpecifiers the module request
  * @param {RuntimeTemplate} runtimeTemplate the runtime template
  * @param {ImportDependencyMeta=} dependencyMeta the dependency meta
@@ -240,6 +246,7 @@ const getSourceForImportExternal = (
 };
 
 /**
+ * Import assertion replacer.
  * @param {string} key key
  * @param {ImportAttributes | string | boolean | undefined} value value
  * @returns {ImportAttributes | string | boolean | undefined} replaced value
@@ -253,10 +260,12 @@ const importAssertionReplacer = (key, value) => {
 };
 
 /**
+ * Represents ModuleExternalInitFragment.
  * @extends {InitFragment<GenerateContext>}
  */
 class ModuleExternalInitFragment extends InitFragment {
 	/**
+	 * Creates an instance of ModuleExternalInitFragment.
 	 * @param {string} request import source
 	 * @param {Imported} imported the imported specifiers
 	 * @param {string=} ident recomputed ident
@@ -294,6 +303,7 @@ class ModuleExternalInitFragment extends InitFragment {
 	}
 
 	/**
+	 * Returns imported.
 	 * @returns {Imported} imported
 	 */
 	getImported() {
@@ -301,6 +311,7 @@ class ModuleExternalInitFragment extends InitFragment {
 	}
 
 	/**
+	 * Updates imported using the provided imported.
 	 * @param {Imported} imported imported
 	 */
 	setImported(imported) {
@@ -308,6 +319,7 @@ class ModuleExternalInitFragment extends InitFragment {
 	}
 
 	/**
+	 * Returns the source code that will be included as initialization code.
 	 * @param {GenerateContext} context context
 	 * @returns {string | Source | undefined} the source code that will be included as initialization code
 	 */
@@ -355,6 +367,7 @@ class ModuleExternalInitFragment extends InitFragment {
 	}
 
 	/**
+	 * Returns identifier.
 	 * @param {string} ident ident
 	 * @returns {string} identifier
 	 */
@@ -363,6 +376,7 @@ class ModuleExternalInitFragment extends InitFragment {
 	}
 
 	/**
+	 * Returns normalized imported.
 	 * @param {Imported} imported imported
 	 * @returns {Imported} normalized imported
 	 */
@@ -395,6 +409,7 @@ register(
 );
 
 /**
+ * Generates module remapping.
  * @param {string} input input
  * @param {ExportsInfo} exportsInfo the exports info
  * @param {RuntimeSpec=} runtime the runtime
@@ -437,6 +452,7 @@ const generateModuleRemapping = (
 };
 
 /**
+ * Gets source for module external.
  * @param {ModuleAndSpecifiers} moduleAndSpecifiers the module request
  * @param {ExportsInfo} exportsInfo exports info of this module
  * @param {RuntimeSpec} runtime the runtime
@@ -530,6 +546,7 @@ const getSourceForModuleExternal = (
 };
 
 /**
+ * Gets source for script external.
  * @param {string | string[]} urlAndGlobal the script request
  * @param {RuntimeTemplate} runtimeTemplate the runtime template
  * @returns {SourceData} the generated source
@@ -567,6 +584,7 @@ const getSourceForScriptExternal = (urlAndGlobal, runtimeTemplate) => {
 };
 
 /**
+ * Checks external variable.
  * @param {string} variableName the variable name to check
  * @param {string} request the request path
  * @param {RuntimeTemplate} runtimeTemplate the runtime template
@@ -578,6 +596,7 @@ const checkExternalVariable = (variableName, request, runtimeTemplate) =>
 	)} }\n`;
 
 /**
+ * Gets source for amd or umd external.
  * @param {ModuleId | string} id the module id
  * @param {boolean} optional true, if the module is optional
  * @param {string | string[]} request the request path
@@ -606,6 +625,7 @@ const getSourceForAmdOrUmdExternal = (
 };
 
 /**
+ * Gets source for default case.
  * @param {boolean} optional true, if the module is optional
  * @param {string | string[]} request the request path
  * @param {RuntimeTemplate} runtimeTemplate the runtime template
@@ -631,6 +651,7 @@ const getSourceForDefaultCase = (optional, request, runtimeTemplate) => {
 /** @typedef {string | string[] | RequestRecord} ExternalModuleRequest */
 
 /**
+ * Defines the external module hooks type used by this module.
  * @typedef {object} ExternalModuleHooks
  * @property {SyncBailHook<[Chunk, Compilation], boolean>} chunkCondition
  */
@@ -640,6 +661,7 @@ const compilationHooksMap = new WeakMap();
 
 class ExternalModule extends Module {
 	/**
+	 * Creates an instance of ExternalModule.
 	 * @param {ExternalModuleRequest} request request
 	 * @param {ExternalsType} type type
 	 * @param {string} userRequest user request
@@ -660,6 +682,7 @@ class ExternalModule extends Module {
 	}
 
 	/**
+	 * Returns the attached hooks.
 	 * @param {Compilation} compilation the compilation
 	 * @returns {ExternalModuleHooks} the attached hooks
 	 */
@@ -675,6 +698,7 @@ class ExternalModule extends Module {
 	}
 
 	/**
+	 * Returns the source types this module can generate.
 	 * @returns {SourceTypes} types available (do not mutate)
 	 */
 	getSourceTypes() {
@@ -693,6 +717,7 @@ class ExternalModule extends Module {
 	}
 
 	/**
+	 * Gets the library identifier.
 	 * @param {LibIdentOptions} options options
 	 * @returns {LibIdent | null} an identifier for library inclusion
 	 */
@@ -701,6 +726,7 @@ class ExternalModule extends Module {
 	}
 
 	/**
+	 * Returns true if the module can be placed in the chunk.
 	 * @param {Chunk} chunk the chunk which condition should be checked
 	 * @param {Compilation} compilation the compilation
 	 * @returns {boolean} true if the module can be placed in the chunk
@@ -721,6 +747,7 @@ class ExternalModule extends Module {
 	}
 
 	/**
+	 * Returns the unique identifier used to reference this module.
 	 * @returns {string} a unique identifier of the module
 	 */
 	identifier() {
@@ -728,6 +755,7 @@ class ExternalModule 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
 	 */
@@ -736,6 +764,7 @@ class ExternalModule 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}
@@ -745,6 +774,7 @@ class ExternalModule 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
@@ -838,6 +868,7 @@ class ExternalModule extends Module {
 	}
 
 	/**
+	 * Returns the reason this module cannot be concatenated, when one exists.
 	 * @param {ConcatenationBailoutReasonContext} context context
 	 * @returns {string | undefined} reason why this module can't be concatenated, undefined when it can be concatenated
 	 */
@@ -855,6 +886,7 @@ class ExternalModule extends Module {
 	}
 
 	/**
+	 * Get request and external type.
 	 * @private
 	 * @returns {{ request: string | string[], externalType: ExternalsType }} the request and external type
 	 */
@@ -901,6 +933,7 @@ class ExternalModule extends Module {
 	}
 
 	/**
+	 * Returns the source data.
 	 * @private
 	 * @param {string | string[]} request request
 	 * @param {ExternalsType} externalType the external type
@@ -1007,6 +1040,7 @@ class ExternalModule extends Module {
 	}
 
 	/**
+	 * Generates code and runtime requirements for this module.
 	 * @param {CodeGenerationContext} context context for code generation
 	 * @returns {CodeGenerationResult} result
 	 */
@@ -1143,6 +1177,7 @@ class ExternalModule 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)
 	 */
@@ -1151,6 +1186,7 @@ class ExternalModule 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}
@@ -1166,6 +1202,7 @@ class ExternalModule extends Module {
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize(context) {
@@ -1180,6 +1217,7 @@ class ExternalModule extends Module {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 */
 	deserialize(context) {

package/lib/ExternalModuleFactoryPlugin.js

@@ -33,6 +33,7 @@ const { cachedSetProperty, resolveByProperty } = require("./util/cleverMerge");
 /** @typedef {(options?: ResolveOptions) => ExternalItemFunctionDataGetResolveCallbackResult | ExternalItemFunctionDataGetResolveResult} ExternalItemFunctionDataGetResolve */
 
 /**
+ * Defines the external item function data type used by this module.
  * @typedef {object} ExternalItemFunctionData
  * @property {string} context the directory in which the request is placed
  * @property {ModuleFactoryCreateDataContextInfo} contextInfo contextual information
@@ -50,6 +51,7 @@ const EMPTY_RESOLVE_OPTIONS = {};
 // TODO webpack 6 remove this
 const callDeprecatedExternals = util.deprecate(
 	/**
+	 * Handles the callback logic for this hook.
 	 * @param {EXPECTED_FUNCTION} externalsFunction externals function
 	 * @param {string} context context
 	 * @param {string} request request
@@ -67,6 +69,7 @@ const callDeprecatedExternals = util.deprecate(
 /** @typedef {ExternalItemObjectKnown & ExternalItemObjectUnknown} ExternalItemObject */
 
 /**
+ * Defines the external weak cache type used by this module.
  * @template {ExternalItemObject} T
  * @typedef {WeakMap<T, Map<IssuerLayer, Omit<T, "byLayer">>>} ExternalWeakCache
  */
@@ -75,6 +78,7 @@ const callDeprecatedExternals = util.deprecate(
 const cache = new WeakMap();
 
 /**
+ * Returns result.
  * @param {ExternalItemObject} obj obj
  * @param {IssuerLayer} layer layer
  * @returns {Omit<ExternalItemObject, "byLayer">} result
@@ -99,6 +103,7 @@ const PLUGIN_NAME = "ExternalModuleFactoryPlugin";
 
 class ExternalModuleFactoryPlugin {
 	/**
+	 * Creates an instance of ExternalModuleFactoryPlugin.
 	 * @param {ExternalsType | ((dependency: Dependency) => ExternalsType)} type default external type
 	 * @param {Externals} externals externals config
 	 */
@@ -108,6 +113,7 @@ class ExternalModuleFactoryPlugin {
 	}
 
 	/**
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {NormalModuleFactory} normalModuleFactory the normal module factory
 	 * @returns {void}
 	 */
@@ -124,6 +130,7 @@ class ExternalModuleFactoryPlugin {
 				/** @typedef {(err?: Error | null, externalModule?: ExternalModule) => void} HandleExternalCallback */
 
 				/**
+				 * Processes the provided value.
 				 * @param {ExternalValue} value the external config
 				 * @param {ExternalsType | undefined} type type of external
 				 * @param {HandleExternalCallback} callback callback
@@ -215,6 +222,7 @@ class ExternalModuleFactoryPlugin {
 				};
 
 				/**
+				 * Processes the provided external.
 				 * @param {Externals} externals externals config
 				 * @param {HandleExternalCallback} callback callback
 				 * @returns {void}
@@ -230,6 +238,7 @@ class ExternalModuleFactoryPlugin {
 							/** @type {boolean | undefined} */
 							let asyncFlag;
 							/**
+							 * Handle externals and callback.
 							 * @param {(Error | null)=} err err
 							 * @param {ExternalModule=} module module
 							 * @returns {void}
@@ -262,6 +271,7 @@ class ExternalModuleFactoryPlugin {
 						}
 					} else if (typeof externals === "function") {
 						/**
+						 * Processes the provided err.
 						 * @param {Error | null | undefined} err err
 						 * @param {ExternalValue=} value value
 						 * @param {ExternalsType=} type type

package/lib/ExternalsPlugin.js

@@ -19,6 +19,7 @@ const PLUGIN_NAME = "ExternalsPlugin";
 
 class ExternalsPlugin {
 	/**
+	 * Creates an instance of ExternalsPlugin.
 	 * @param {ExternalsType | ((dependency: Dependency) => ExternalsType)} type default external type
 	 * @param {Externals} externals externals config
 	 */
@@ -28,7 +29,7 @@ class ExternalsPlugin {
 	}
 
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */