webpack 5.106.0 → 5.106.2

package/lib/ExportsInfo.js

@@ -42,6 +42,7 @@ const { forEachRuntime } = require("./util/runtime");
 /** @typedef {Set<ExportInfo>} AlreadyVisitedExportInfo */
 
 /**
+ * Defines the restore provided data exports type used by this module.
  * @typedef {object} RestoreProvidedDataExports
  * @property {ExportInfoName} name
  * @property {ExportInfo["provided"]} provided
@@ -64,6 +65,7 @@ const CIRCULAR = Symbol("circular target");
 
 class RestoreProvidedData {
 	/**
+	 * Creates an instance of RestoreProvidedData.
 	 * @param {RestoreProvidedDataExports[]} exports exports
 	 * @param {ExportInfo["provided"]} otherProvided other provided
 	 * @param {ExportInfo["canMangleProvide"]} otherCanMangleProvide other can mangle provide
@@ -82,6 +84,7 @@ class RestoreProvidedData {
 	}
 
 	/**
+	 * Serializes this instance into the provided serializer context.
 	 * @param {ObjectSerializerContext} context context
 	 */
 	serialize({ write }) {
@@ -92,6 +95,7 @@ class RestoreProvidedData {
 	}
 
 	/**
+	 * Restores this instance from the provided deserializer context.
 	 * @param {ObjectDeserializerContext} context context
 	 * @returns {RestoreProvidedData} RestoreProvidedData
 	 */
@@ -121,6 +125,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Gets owned exports.
 	 * @returns {Iterable<ExportInfo>} all owned exports in any order
 	 */
 	get ownedExports() {
@@ -128,6 +133,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Gets ordered owned exports.
 	 * @returns {Iterable<ExportInfo>} all owned exports in order
 	 */
 	get orderedOwnedExports() {
@@ -138,6 +144,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Returns all exports in any order.
 	 * @returns {Iterable<ExportInfo>} all exports in any order
 	 */
 	get exports() {
@@ -152,6 +159,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Gets ordered exports.
 	 * @returns {Iterable<ExportInfo>} all exports in order
 	 */
 	get orderedExports() {
@@ -175,6 +183,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Gets other exports info.
 	 * @returns {ExportInfo} the export info of unlisted exports
 	 */
 	get otherExportsInfo() {
@@ -185,6 +194,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Processes the provided export.
 	 * @param {Exports} exports exports
 	 * @private
 	 */
@@ -217,6 +227,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Sets redirect named to.
 	 * @param {ExportsInfo | undefined} exportsInfo exports info
 	 * @returns {boolean} result
 	 */
@@ -260,6 +271,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Gets own export info.
 	 * @param {ExportInfoName} name export name
 	 * @returns {ExportInfo} export info for this name
 	 */
@@ -273,6 +285,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Returns export info for this name.
 	 * @param {ExportInfoName} name export name
 	 * @returns {ExportInfo} export info for this name
 	 */
@@ -289,6 +302,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Gets read only export info.
 	 * @param {ExportInfoName} name export name
 	 * @returns {ExportInfo} export info for this name
 	 */
@@ -302,6 +316,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Gets read only export info recursive.
 	 * @param {ExportInfoName[]} name export name
 	 * @returns {ExportInfo | undefined} export info for this name
 	 */
@@ -313,6 +328,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Gets nested exports info.
 	 * @param {ExportInfoName[]=} name the export name
 	 * @returns {ExportsInfo | undefined} the nested exports info
 	 */
@@ -326,6 +342,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Sets unknown exports provided.
 	 * @param {boolean=} canMangle true, if exports can still be mangled (defaults to false)
 	 * @param {ExportsSpecExcludeExports=} excludeExports list of unaffected exports
 	 * @param {Dependency=} targetKey use this as key for the target
@@ -404,6 +421,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Sets used in unknown way.
 	 * @param {RuntimeSpec} runtime the runtime
 	 * @returns {boolean} true, when something changed
 	 */
@@ -437,6 +455,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Sets used without info.
 	 * @param {RuntimeSpec} runtime the runtime
 	 * @returns {boolean} true, when something changed
 	 */
@@ -464,6 +483,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Sets all known exports used.
 	 * @param {RuntimeSpec} runtime the runtime
 	 * @returns {boolean} true, when something changed
 	 */
@@ -479,6 +499,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Sets used for side effects only.
 	 * @param {RuntimeSpec} runtime the runtime
 	 * @returns {boolean} true, when something changed
 	 */
@@ -491,6 +512,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Checks whether this exports info is used.
 	 * @param {RuntimeSpec} runtime the runtime
 	 * @returns {boolean} true, when the module exports are used in any way
 	 */
@@ -511,6 +533,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Checks whether this exports info is module used.
 	 * @param {RuntimeSpec} runtime the runtime
 	 * @returns {boolean} true, when the module is used in any way
 	 */
@@ -523,6 +546,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Returns set of used exports, or true (when namespace object is used), or false (when unused), or null (when unknown).
 	 * @param {RuntimeSpec} runtime the runtime
 	 * @returns {SortableSet<ExportInfoName> | boolean | null} set of used exports, or true (when namespace object is used), or false (when unused), or null (when unknown)
 	 */
@@ -572,6 +596,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Gets provided exports.
 	 * @returns {null | true | ExportInfoName[]} list of exports when known
 	 */
 	getProvidedExports() {
@@ -611,6 +636,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Gets relevant exports.
 	 * @param {RuntimeSpec} runtime the runtime
 	 * @returns {ExportInfo[]} exports that are relevant (not unused and potential provided)
 	 */
@@ -638,6 +664,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Checks whether this exports info is export provided.
 	 * @param {ExportInfoName | ExportInfoName[]} name the name of the export
 	 * @returns {boolean | undefined | null} if the export is provided
 	 */
@@ -654,6 +681,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Returns key representing the usage.
 	 * @param {RuntimeSpec} runtime runtime
 	 * @returns {string} key representing the usage
 	 */
@@ -673,6 +701,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Checks whether this exports info is equally used.
 	 * @param {RuntimeSpec} runtimeA first runtime
 	 * @param {RuntimeSpec} runtimeB second runtime
 	 * @returns {boolean} true, when equally used
@@ -701,6 +730,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Returns usage status.
 	 * @param {ExportInfoName | ExportInfoName[]} name export name
 	 * @param {RuntimeSpec} runtime check usage for this runtime only
 	 * @returns {UsageStateType} usage status
@@ -719,6 +749,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Returns the used name.
 	 * @param {ExportInfoName | ExportInfoName[]} name the export name
 	 * @param {RuntimeSpec} runtime check usage for this runtime only
 	 * @returns {UsedName} the used name
@@ -755,6 +786,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Updates the hash with the data contributed by this instance.
 	 * @param {Hash} hash the hash
 	 * @param {RuntimeSpec} runtime the runtime
 	 * @returns {void}
@@ -764,6 +796,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Updates hash using the provided hash.
 	 * @param {Hash} hash the hash
 	 * @param {RuntimeSpec} runtime the runtime
 	 * @param {Set<ExportsInfo>} alreadyVisitedExportsInfo for circular references
@@ -785,6 +818,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Gets restore provided data.
 	 * @returns {RestoreProvidedData} restore provided data
 	 */
 	getRestoreProvidedData() {
@@ -821,6 +855,7 @@ class ExportsInfo {
 	}
 
 	/**
+	 * Processes the provided data.
 	 * @param {RestoreProvidedData} data data
 	 */
 	restoreProvided({
@@ -855,6 +890,7 @@ class ExportsInfo {
 
 class ExportInfo {
 	/**
+	 * Creates an instance of ExportInfo.
 	 * @param {ExportInfoName | null} name the original name of the export
 	 * @param {ExportInfo=} initFrom init values from this ExportInfo
 	 */
@@ -955,6 +991,7 @@ class ExportInfo {
 	}
 
 	/**
+	 * Sets used in unknown way.
 	 * @param {RuntimeSpec} runtime only apply to this runtime
 	 * @returns {boolean} true, when something changed
 	 */
@@ -977,6 +1014,7 @@ class ExportInfo {
 	}
 
 	/**
+	 * Sets used without info.
 	 * @param {RuntimeSpec} runtime only apply to this runtime
 	 * @returns {boolean} true, when something changed
 	 */
@@ -1006,6 +1044,7 @@ class ExportInfo {
 	}
 
 	/**
+	 * Sets used conditionally.
 	 * @param {(condition: UsageStateType) => boolean} condition compare with old value
 	 * @param {UsageStateType} newValue set when condition is true
 	 * @param {RuntimeSpec} runtime only apply to this runtime
@@ -1059,6 +1098,7 @@ class ExportInfo {
 	}
 
 	/**
+	 * Updates used using the provided new value.
 	 * @param {UsageStateType} newValue new value of the used state
 	 * @param {RuntimeSpec} runtime only apply to this runtime
 	 * @returns {boolean} true when something has changed
@@ -1107,6 +1147,7 @@ class ExportInfo {
 	}
 
 	/**
+	 * Returns true, if something has changed.
 	 * @param {Dependency} key the key
 	 * @returns {boolean} true, if something has changed
 	 */
@@ -1120,6 +1161,7 @@ class ExportInfo {
 	}
 
 	/**
+	 * Updates target using the provided key.
 	 * @param {Dependency} key the key
 	 * @param {ModuleGraphConnection} connection the target module if a single one
 	 * @param {ExportInfoName[] | null=} exportName the exported name
@@ -1165,6 +1207,7 @@ class ExportInfo {
 	}
 
 	/**
+	 * Returns usage state.
 	 * @param {RuntimeSpec} runtime for this runtime
 	 * @returns {UsageStateType} usage state
 	 */
@@ -1203,7 +1246,7 @@ class ExportInfo {
 	}
 
 	/**
-	 * get used name
+	 * Returns used name.
 	 * @param {string | undefined} fallbackName fallback name for used exports with no name
 	 * @param {RuntimeSpec} runtime check usage for this runtime only
 	 * @returns {string | false} used name
@@ -1234,6 +1277,7 @@ class ExportInfo {
 	}
 
 	/**
+	 * Checks whether this export info has used name.
 	 * @returns {boolean} true, when a mangled name of this export is set
 	 */
 	hasUsedName() {
@@ -1241,7 +1285,7 @@ class ExportInfo {
 	}
 
 	/**
-	 * Sets the mangled name of this export
+	 * Updates used name using the provided name.
 	 * @param {string} name the new name
 	 * @returns {void}
 	 */
@@ -1250,6 +1294,7 @@ class ExportInfo {
 	}
 
 	/**
+	 * Gets terminal binding.
 	 * @param {ModuleGraph} moduleGraph the module graph
 	 * @param {ResolveTargetFilter} resolveTargetFilter filter function to further resolve target
 	 * @returns {ExportInfo | ExportsInfo | undefined} the terminal binding export(s) info if known
@@ -1294,6 +1339,7 @@ class ExportInfo {
 	}
 
 	/**
+	 * Returns the target, undefined when there is no target, false when no target is valid.
 	 * @param {ModuleGraph} moduleGraph the module graph
 	 * @param {ValidTargetModuleFilter} validTargetModuleFilter a valid target module
 	 * @returns {TargetItemWithoutConnection | null | undefined | false} the target, undefined when there is no target, false when no target is valid
@@ -1303,6 +1349,7 @@ class ExportInfo {
 	}
 
 	/**
+	 * Returns the target, undefined when there is no target, false when no target is valid.
 	 * @param {ModuleGraph} moduleGraph the module graph
 	 * @param {ValidTargetModuleFilter} validTargetModuleFilter a valid target module
 	 * @param {AlreadyVisitedExportInfo} alreadyVisited set of already visited export info to avoid circular references
@@ -1353,6 +1400,7 @@ class ExportInfo {
 	}
 
 	/**
+	 * Returns the target.
 	 * @param {ModuleGraph} moduleGraph the module graph
 	 * @param {ResolveTargetFilter} resolveTargetFilter filter function to further resolve target
 	 * @returns {TargetItemWithConnection | undefined} the target
@@ -1364,6 +1412,7 @@ class ExportInfo {
 	}
 
 	/**
+	 * Returns the target.
 	 * @param {ModuleGraph} moduleGraph the module graph
 	 * @param {ResolveTargetFilter} resolveTargetFilter filter function to further resolve target
 	 * @param {AlreadyVisitedExportInfo | undefined} alreadyVisited set of already visited export info to avoid circular references
@@ -1371,6 +1420,7 @@ class ExportInfo {
 	 */
 	_getTarget(moduleGraph, resolveTargetFilter, alreadyVisited) {
 		/**
+		 * Returns resolved target.
 		 * @param {TargetItem | undefined | null} inputTarget unresolved target
 		 * @param {AlreadyVisitedExportInfo} alreadyVisited set of already visited export info to avoid circular references
 		 * @returns {TargetItemWithConnection | CIRCULAR | null} resolved target
@@ -1501,6 +1551,7 @@ class ExportInfo {
 	}
 
 	/**
+	 * Creates a nested exports info.
 	 * @returns {ExportsInfo} an exports info
 	 */
 	createNestedExportsInfo() {
@@ -1522,6 +1573,7 @@ class ExportInfo {
 	}
 
 	/**
+	 * Checks whether this export info contains the base info.
 	 * @param {ExportInfo} baseInfo base info
 	 * @param {RuntimeSpec} runtime runtime
 	 * @returns {boolean} true when has info, otherwise false
@@ -1536,6 +1588,7 @@ class ExportInfo {
 	}
 
 	/**
+	 * Updates the hash with the data contributed by this instance.
 	 * @param {Hash} hash the hash
 	 * @param {RuntimeSpec} runtime the runtime
 	 * @returns {void}
@@ -1545,6 +1598,7 @@ class ExportInfo {
 	}
 
 	/**
+	 * Updates hash using the provided hash.
 	 * @param {Hash} hash the hash
 	 * @param {RuntimeSpec} runtime the runtime
 	 * @param {Set<ExportsInfo>} alreadyVisitedExportsInfo for circular references

package/lib/ExportsInfoApiPlugin.js

@@ -22,7 +22,7 @@ const PLUGIN_NAME = "ExportsInfoApiPlugin";
 
 class ExportsInfoApiPlugin {
 	/**
-	 * Apply the plugin
+	 * Applies the plugin by registering its hooks on the compiler.
 	 * @param {Compiler} compiler the compiler instance
 	 * @returns {void}
 	 */
@@ -35,6 +35,7 @@ class ExportsInfoApiPlugin {
 					new ExportsInfoDependency.Template()
 				);
 				/**
+				 * Handles the hook callback for this code path.
 				 * @param {JavascriptParser} parser the parser
 				 * @returns {void}
 				 */