@depup/webpack-sources 3.3.4-depup.0 → 3.6.0-depup.0

package/lib/SizeOnlySource.js

@@ -19,7 +19,6 @@ class SizeOnlySource extends Source {
 	constructor(size) {
 		super();
 		/**
-		 * @private
 		 * @type {number}
 		 */
 		this._size = size;
@@ -31,6 +30,9 @@ class SizeOnlySource extends Source {
 		);
 	}
 
+	/**
+	 * @returns {number} size
+	 */
 	size() {
 		return this._size;
 	}
@@ -49,6 +51,13 @@ class SizeOnlySource extends Source {
 		throw this._error();
 	}
 
+	/**
+	 * @returns {Buffer[]} buffers
+	 */
+	buffers() {
+		throw this._error();
+	}
+
 	/**
 	 * @param {MapOptions=} options map options
 	 * @returns {RawSourceMap | null} map

package/lib/Source.js

@@ -9,6 +9,7 @@
  * @typedef {object} MapOptions
  * @property {boolean=} columns need columns?
  * @property {boolean=} module is module
+ * @property {boolean=} scopes emit the `scopes` field from the bindings the sources declare
  */
 
 /**
@@ -22,6 +23,7 @@
  * @property {string} file file
  * @property {string=} debugId debug id
  * @property {number[]=} ignoreList ignore list
+ * @property {string=} scopes encoded `scopes` field of the "Scopes" proposal
  */
 
 /** @typedef {string | Buffer} SourceValue */
@@ -38,6 +40,13 @@
  * @property {(encoding?: string) => string | Buffer} digest get hash digest
  */
 
+/**
+ * @typedef {object} ClearCacheOptions
+ * @property {boolean=} maps drop cached source maps (default `true`)
+ * @property {boolean=} source drop cached source/buffer copies (default `true`)
+ * @property {boolean=} parsedMap drop the parsed object form of cached source maps on `SourceMapSource` instances (default `false` — re-parsing JSON is significantly more expensive than `toString`). Only takes effect when a serialized form (buffer or string) is also retained, so the data remains recoverable.
+ */
+
 class Source {
 	/**
 	 * @returns {SourceValue} source
@@ -46,12 +55,25 @@ class Source {
 		throw new Error("Abstract");
 	}
 
+	/**
+	 * @returns {Buffer} buffer
+	 */
 	buffer() {
 		const source = this.source();
 		if (Buffer.isBuffer(source)) return source;
 		return Buffer.from(source, "utf8");
 	}
 
+	/**
+	 * @returns {Buffer[]} buffers
+	 */
+	buffers() {
+		return [this.buffer()];
+	}
+
+	/**
+	 * @returns {number} size
+	 */
 	size() {
 		return this.buffer().length;
 	}
@@ -84,6 +106,23 @@ class Source {
 	updateHash(hash) {
 		throw new Error("Abstract");
 	}
+
+	/**
+	 * Release cached data held by this source. clearCache is a memory
+	 * hint: it never affects correctness or output, only how expensive
+	 * the next read is. Subclasses override; the base is a no-op so
+	 * every Source supports the call. Composite sources always recurse
+	 * into wrapped sources. When the same child is reachable via several
+	 * parents (e.g. modules shared across webpack chunks), pass a shared
+	 * `visited` WeakSet so each subtree is walked at most once.
+	 * Not safe to call concurrently with source/map/sourceAndMap/
+	 * streamChunks/updateHash on the same instance.
+	 * @param {ClearCacheOptions=} options selectors
+	 * @param {WeakSet<Source>=} visited de-duplication set shared across calls
+	 * @returns {void}
+	 */
+	// eslint-disable-next-line no-unused-vars
+	clearCache(options, visited) {}
 }
 
 module.exports = Source;

package/lib/SourceMapSource.js

@@ -13,6 +13,7 @@ const {
 	isDualStringBufferCachingEnabled,
 } = require("./helpers/stringBufferUtils");
 
+/** @typedef {import("./Source").ClearCacheOptions} ClearCacheOptions */
 /** @typedef {import("./Source").HashLike} HashLike */
 /** @typedef {import("./Source").MapOptions} MapOptions */
 /** @typedef {import("./Source").RawSourceMap} RawSourceMap */
@@ -44,12 +45,10 @@ class SourceMapSource extends Source {
 		super();
 		const valueIsBuffer = Buffer.isBuffer(value);
 		/**
-		 * @private
 		 * @type {undefined | string}
 		 */
 		this._valueAsString = valueIsBuffer ? undefined : value;
 		/**
-		 * @private
 		 * @type {undefined | Buffer}
 		 */
 		this._valueAsBuffer = valueIsBuffer ? value : undefined;
@@ -60,18 +59,15 @@ class SourceMapSource extends Source {
 		const sourceMapIsBuffer = Buffer.isBuffer(sourceMap);
 		const sourceMapIsString = typeof sourceMap === "string";
 		/**
-		 * @private
 		 * @type {undefined | RawSourceMap}
 		 */
 		this._sourceMapAsObject =
 			sourceMapIsBuffer || sourceMapIsString ? undefined : sourceMap;
 		/**
-		 * @private
 		 * @type {undefined | string}
 		 */
 		this._sourceMapAsString = sourceMapIsString ? sourceMap : undefined;
 		/**
-		 * @private
 		 * @type {undefined | Buffer}
 		 */
 		this._sourceMapAsBuffer = sourceMapIsBuffer ? sourceMap : undefined;
@@ -89,7 +85,6 @@ class SourceMapSource extends Source {
 		const innerSourceMapIsBuffer = Buffer.isBuffer(innerSourceMap);
 		const innerSourceMapIsString = typeof innerSourceMap === "string";
 		/**
-		 * @private
 		 * @type {undefined | RawSourceMap}
 		 */
 
@@ -98,14 +93,12 @@ class SourceMapSource extends Source {
 				? undefined
 				: innerSourceMap || undefined;
 		/**
-		 * @private
 		 * @type {undefined | string}
 		 */
 		this._innerSourceMapAsString = innerSourceMapIsString
 			? innerSourceMap
 			: undefined;
 		/**
-		 * @private
 		 * @type {undefined | Buffer}
 		 */
 		this._innerSourceMapAsBuffer = innerSourceMapIsBuffer
@@ -129,6 +122,9 @@ class SourceMapSource extends Source {
 		];
 	}
 
+	/**
+	 * @returns {Buffer} buffer
+	 */
 	buffer() {
 		if (this._valueAsBuffer === undefined) {
 			const value = Buffer.from(
@@ -143,6 +139,20 @@ class SourceMapSource extends Source {
 		return this._valueAsBuffer;
 	}
 
+	/**
+	 * @returns {number} size
+	 */
+	size() {
+		if (this._cachedSize !== undefined) return this._cachedSize;
+		if (this._valueAsBuffer !== undefined) {
+			return (this._cachedSize = this._valueAsBuffer.length);
+		}
+		return (this._cachedSize = Buffer.byteLength(
+			/** @type {string} */ (this._valueAsString),
+			"utf8",
+		));
+	}
+
 	/**
 	 * @returns {SourceValue} source
 	 */
@@ -160,7 +170,6 @@ class SourceMapSource extends Source {
 	}
 
 	/**
-	 * @private
 	 * @returns {undefined | Buffer} buffer
 	 */
 	_originalSourceBuffer() {
@@ -214,7 +223,6 @@ class SourceMapSource extends Source {
 	}
 
 	/**
-	 * @private
 	 * @returns {string} result
 	 */
 	_innerSourceMapString() {
@@ -337,6 +345,80 @@ class SourceMapSource extends Source {
 		);
 	}
 
+	/**
+	 * Release cached data held by this source. clearCache is a memory
+	 * hint: it never affects correctness or output, only how expensive
+	 * the next read is. Subclasses override; the base is a no-op so
+	 * every Source supports the call. Composite sources always recurse
+	 * into wrapped sources. When the same child is reachable via several
+	 * parents (e.g. modules shared across webpack chunks), pass a shared
+	 * `visited` WeakSet so each subtree is walked at most once.
+	 * Not safe to call concurrently with source/map/sourceAndMap/
+	 * streamChunks/updateHash on the same instance.
+	 * @param {ClearCacheOptions=} options selectors
+	 * @param {WeakSet<Source>=} visited de-duplication set shared across calls
+	 * @returns {void}
+	 */
+	clearCache(options, visited) {
+		if (visited !== undefined) {
+			if (visited.has(this)) return;
+			visited.add(this);
+		}
+		const clearSource = !options || options.source !== false;
+		const clearMaps = !options || options.maps !== false;
+		const clearParsedMap = options !== undefined && options.parsedMap === true;
+		// For every dual-cached pair, drop the string form when the
+		// buffer is also held — buffer is more compact in V8 (1 byte/char
+		// vs 2) and the string rehydrates cheaply. Parsed object forms
+		// of source maps are heavier but only dropped when
+		// `parsedMap: true` is set, because re-parsing JSON is much more
+		// expensive than `toString` from a buffer.
+		if (clearSource) {
+			if (
+				this._valueAsString !== undefined &&
+				this._valueAsBuffer !== undefined
+			) {
+				this._valueAsString = undefined;
+			}
+			if (
+				this._originalSourceAsString !== undefined &&
+				this._originalSourceAsBuffer !== undefined
+			) {
+				this._originalSourceAsString = undefined;
+			}
+		}
+		if (clearMaps) {
+			if (
+				this._sourceMapAsString !== undefined &&
+				this._sourceMapAsBuffer !== undefined
+			) {
+				this._sourceMapAsString = undefined;
+			}
+			if (
+				clearParsedMap &&
+				this._sourceMapAsObject !== undefined &&
+				(this._sourceMapAsBuffer !== undefined ||
+					this._sourceMapAsString !== undefined)
+			) {
+				this._sourceMapAsObject = undefined;
+			}
+			if (
+				this._innerSourceMapAsString !== undefined &&
+				this._innerSourceMapAsBuffer !== undefined
+			) {
+				this._innerSourceMapAsString = undefined;
+			}
+			if (
+				clearParsedMap &&
+				this._innerSourceMapAsObject !== undefined &&
+				(this._innerSourceMapAsBuffer !== undefined ||
+					this._innerSourceMapAsString !== undefined)
+			) {
+				this._innerSourceMapAsObject = undefined;
+			}
+		}
+	}
+
 	/**
 	 * @param {HashLike} hash hash
 	 * @returns {void}