@serwist/webpack-plugin 8.3.0 → 8.4.1

package/dist/index.cjs

@@ -120,7 +120,7 @@ function prettyBytes(number, options) {
     // If webpack has the asset marked as immutable, then we don't need to
     // use an out-of-band revision for it.
     // See https://github.com/webpack/webpack/issues/9038
-    if (asset.info && asset.info.immutable) {
+    if (asset.info?.immutable) {
         return null;
     }
     return crypto.createHash("md5").update(Buffer.from(asset.source.source())).digest("hex");
@@ -147,12 +147,11 @@ function prettyBytes(number, options) {
     // See https://github.com/jantimon/html-webpack-plugin/pull/1516
     if (publicPath === "auto") {
         return paths.join("");
-    } else {
-        return [
-            publicPath,
-            ...paths
-        ].join("");
     }
+    return [
+        publicPath,
+        ...paths
+    ].join("");
 }
 
 /**
@@ -173,10 +172,9 @@ function prettyBytes(number, options) {
                 compilation
             });
         //return compilation !== null;
-        } else {
-            if (webpack.ModuleFilenameHelpers.matchPart(asset.name, condition)) {
-                return true;
-            }
+        }
+        if (webpack.ModuleFilenameHelpers.matchPart(asset.name, condition)) {
+            return true;
         }
     }
     // We'll only get here if none of the conditions applied.
@@ -193,18 +191,17 @@ function prettyBytes(number, options) {
  * @returns
  * @private
  */ function getNamesOfAssetsInChunkOrGroup(compilation, chunkOrGroup) {
-    const chunkGroup = compilation.namedChunkGroups && compilation.namedChunkGroups.get(chunkOrGroup);
+    const chunkGroup = compilation.namedChunkGroups?.get(chunkOrGroup);
     if (chunkGroup) {
         const assetNames = [];
         for (const chunk of chunkGroup.chunks){
             assetNames.push(...getNamesOfAssetsInChunk(chunk));
         }
         return assetNames;
-    } else {
-        const chunk = compilation.namedChunks && compilation.namedChunks.get(chunkOrGroup);
-        if (chunk) {
-            return getNamesOfAssetsInChunk(chunk);
-        }
+    }
+    const chunk = compilation.namedChunks?.get(chunkOrGroup);
+    if (chunk) {
+        return getNamesOfAssetsInChunk(chunk);
     }
     // If we get here, there's no chunkGroup or chunk with that name.
     return null;
@@ -248,7 +245,7 @@ function prettyBytes(number, options) {
                     allowedAssetNames.add(assetName);
                 }
             } else {
-                compilation.warnings.push(new Error(`The chunk '${name}' was ` + `provided in your Serwist chunks config, but was not found in the ` + `compilation.`));
+                compilation.warnings.push(new Error(`The chunk '${name}' was provided in your Serwist chunks config, but was not found in the compilation.`));
             }
         }
     }
@@ -402,7 +399,7 @@ const _generatedAssetNames = new Set();
         this.config = Object.assign({
             mode: compiler.options.mode,
             // Use swSrc with a hardcoded .js extension, in case swSrc is a .ts file.
-            swDest: parsedSwSrc.name + ".js"
+            swDest: `${parsedSwSrc.name}.js`
         }, this.config);
     }
     /**
@@ -419,7 +416,7 @@ const _generatedAssetNames = new Set();
         }
         // See https://github.com/GoogleChrome/workbox/issues/1790
         if (this.alreadyCalled) {
-            const warningMessage = `${this.constructor.name} has been called ` + `multiple times, perhaps due to running webpack in --watch mode. The ` + `precache manifest generated after the first call may be inaccurate! ` + `Please see https://github.com/GoogleChrome/workbox/issues/1790 for ` + `more information.`;
+            const warningMessage = `${this.constructor.name} has been called multiple times, perhaps due to running webpack in --watch mode. The precache manifest generated after the first call may be inaccurate! Please see https://github.com/GoogleChrome/workbox/issues/1790 for more information.`;
             if (!compilation.warnings.some((warning)=>warning instanceof Error && warning.message === warningMessage)) {
                 compilation.warnings.push(new Error(warningMessage));
             }
@@ -551,7 +548,7 @@ const _generatedAssetNames = new Set();
             throw new Error(`Can't find ${config.injectionPoint} in your SW source.`);
         }
         if (injectionResults.length !== 1) {
-            throw new Error(`Multiple instances of ${config.injectionPoint} were ` + "found in your SW source. Include it only once. For more info, see " + "https://github.com/GoogleChrome/workbox/issues/2681");
+            throw new Error(`Multiple instances of ${config.injectionPoint} were found in your SW source. Include it only once. For more info, see https://github.com/GoogleChrome/workbox/issues/2681`);
         }
         const sourcemapAssetName = getSourcemapAssetName(compilation, swAssetString, config.swDest);
         if (sourcemapAssetName) {

package/dist/index.d.cts

@@ -0,0 +1,2 @@
+import { InjectManifest } from "./inject-manifest.js";
+export { InjectManifest };

package/dist/index.js

@@ -118,7 +118,7 @@ function prettyBytes(number, options) {
     // If webpack has the asset marked as immutable, then we don't need to
     // use an out-of-band revision for it.
     // See https://github.com/webpack/webpack/issues/9038
-    if (asset.info && asset.info.immutable) {
+    if (asset.info?.immutable) {
         return null;
     }
     return crypto.createHash("md5").update(Buffer.from(asset.source.source())).digest("hex");
@@ -145,12 +145,11 @@ function prettyBytes(number, options) {
     // See https://github.com/jantimon/html-webpack-plugin/pull/1516
     if (publicPath === "auto") {
         return paths.join("");
-    } else {
-        return [
-            publicPath,
-            ...paths
-        ].join("");
     }
+    return [
+        publicPath,
+        ...paths
+    ].join("");
 }
 
 /**
@@ -171,10 +170,9 @@ function prettyBytes(number, options) {
                 compilation
             });
         //return compilation !== null;
-        } else {
-            if (webpack.ModuleFilenameHelpers.matchPart(asset.name, condition)) {
-                return true;
-            }
+        }
+        if (webpack.ModuleFilenameHelpers.matchPart(asset.name, condition)) {
+            return true;
         }
     }
     // We'll only get here if none of the conditions applied.
@@ -191,18 +189,17 @@ function prettyBytes(number, options) {
  * @returns
  * @private
  */ function getNamesOfAssetsInChunkOrGroup(compilation, chunkOrGroup) {
-    const chunkGroup = compilation.namedChunkGroups && compilation.namedChunkGroups.get(chunkOrGroup);
+    const chunkGroup = compilation.namedChunkGroups?.get(chunkOrGroup);
     if (chunkGroup) {
         const assetNames = [];
         for (const chunk of chunkGroup.chunks){
             assetNames.push(...getNamesOfAssetsInChunk(chunk));
         }
         return assetNames;
-    } else {
-        const chunk = compilation.namedChunks && compilation.namedChunks.get(chunkOrGroup);
-        if (chunk) {
-            return getNamesOfAssetsInChunk(chunk);
-        }
+    }
+    const chunk = compilation.namedChunks?.get(chunkOrGroup);
+    if (chunk) {
+        return getNamesOfAssetsInChunk(chunk);
     }
     // If we get here, there's no chunkGroup or chunk with that name.
     return null;
@@ -246,7 +243,7 @@ function prettyBytes(number, options) {
                     allowedAssetNames.add(assetName);
                 }
             } else {
-                compilation.warnings.push(new Error(`The chunk '${name}' was ` + `provided in your Serwist chunks config, but was not found in the ` + `compilation.`));
+                compilation.warnings.push(new Error(`The chunk '${name}' was provided in your Serwist chunks config, but was not found in the compilation.`));
             }
         }
     }
@@ -400,7 +397,7 @@ const _generatedAssetNames = new Set();
         this.config = Object.assign({
             mode: compiler.options.mode,
             // Use swSrc with a hardcoded .js extension, in case swSrc is a .ts file.
-            swDest: parsedSwSrc.name + ".js"
+            swDest: `${parsedSwSrc.name}.js`
         }, this.config);
     }
     /**
@@ -417,7 +414,7 @@ const _generatedAssetNames = new Set();
         }
         // See https://github.com/GoogleChrome/workbox/issues/1790
         if (this.alreadyCalled) {
-            const warningMessage = `${this.constructor.name} has been called ` + `multiple times, perhaps due to running webpack in --watch mode. The ` + `precache manifest generated after the first call may be inaccurate! ` + `Please see https://github.com/GoogleChrome/workbox/issues/1790 for ` + `more information.`;
+            const warningMessage = `${this.constructor.name} has been called multiple times, perhaps due to running webpack in --watch mode. The precache manifest generated after the first call may be inaccurate! Please see https://github.com/GoogleChrome/workbox/issues/1790 for more information.`;
             if (!compilation.warnings.some((warning)=>warning instanceof Error && warning.message === warningMessage)) {
                 compilation.warnings.push(new Error(warningMessage));
             }
@@ -549,7 +546,7 @@ const _generatedAssetNames = new Set();
             throw new Error(`Can't find ${config.injectionPoint} in your SW source.`);
         }
         if (injectionResults.length !== 1) {
-            throw new Error(`Multiple instances of ${config.injectionPoint} were ` + "found in your SW source. Include it only once. For more info, see " + "https://github.com/GoogleChrome/workbox/issues/2681");
+            throw new Error(`Multiple instances of ${config.injectionPoint} were found in your SW source. Include it only once. For more info, see https://github.com/GoogleChrome/workbox/issues/2681`);
         }
         const sourcemapAssetName = getSourcemapAssetName(compilation, swAssetString, config.swDest);
         if (sourcemapAssetName) {

package/dist/inject-manifest.d.cts

@@ -0,0 +1,82 @@
+import type { WebpackInjectManifestOptions } from "@serwist/build";
+import webpack from "webpack";
+/**
+ * This class supports compiling a service worker file provided via `swSrc`,
+ * and injecting into that service worker a list of URLs and revision
+ * information for precaching based on the webpack asset pipeline.
+ *
+ * Use an instance of `InjectManifest` in the
+ * [`plugins` array](https://webpack.js.org/concepts/plugins/#usage) of a
+ * webpack config.
+ *
+ * In addition to injecting the manifest, this plugin will perform a compilation
+ * of the `swSrc` file, using the options from the main webpack configuration.
+ *
+ * ```
+ * // The following lists some common options; see the rest of the documentation
+ * // for the full set of options and defaults.
+ * new InjectManifest({
+ *   exclude: [/.../, '...'],
+ *   maximumFileSizeToCacheInBytes: ...,
+ *   swSrc: '...',
+ * });
+ * ```
+ */
+declare class InjectManifest {
+    protected config: WebpackInjectManifestOptions;
+    private alreadyCalled;
+    /**
+     * Creates an instance of InjectManifest.
+     */
+    constructor(config: WebpackInjectManifestOptions);
+    /**
+     * @param compiler default compiler object passed from webpack
+     *
+     * @private
+     */
+    propagateWebpackConfig(compiler: webpack.Compiler): void;
+    /**
+     * `getManifestEntriesFromCompilation` with a few additional checks.
+     *
+     * @private
+     */
+    getManifestEntries(compilation: webpack.Compilation, config: WebpackInjectManifestOptions): Promise<{
+        size: number;
+        sortedEntries: import("@serwist/build").ManifestEntry[] | undefined;
+        manifestString: string;
+    }>;
+    /**
+     * @param compiler default compiler object passed from webpack
+     *
+     * @private
+     */
+    apply(compiler: webpack.Compiler): void;
+    /**
+     * @param compilation The webpack compilation.
+     * @param parentCompiler The webpack parent compiler.
+     *
+     * @private
+     */
+    performChildCompilation(compilation: webpack.Compilation, parentCompiler: webpack.Compiler): Promise<void>;
+    /**
+     * @param compilation The webpack compilation.
+     * @param parentCompiler The webpack parent compiler.
+     *
+     * @private
+     */
+    addSrcToAssets(compilation: webpack.Compilation, parentCompiler: webpack.Compiler): void;
+    /**
+     * @param compilation The webpack compilation.
+     * @param parentCompiler The webpack parent compiler.
+     *
+     * @private
+     */
+    handleMake(compilation: webpack.Compilation, parentCompiler: webpack.Compiler): Promise<void>;
+    /**
+     * @param compilation The webpack compilation.
+     *
+     * @private
+     */
+    addAssets(compilation: webpack.Compilation): Promise<void>;
+}
+export { InjectManifest };

package/dist/lib/get-sourcemap-asset-name.d.cts

@@ -0,0 +1,19 @@
+import type { Compilation } from "webpack";
+/**
+ * If our bundled swDest file contains a sourcemap, we would invalidate that
+ * mapping if we just replaced injectionPoint with the stringified manifest.
+ * Instead, we need to update the swDest contents as well as the sourcemap
+ * at the same time.
+ *
+ * See https://github.com/GoogleChrome/workbox/issues/2235
+ *
+ * @param compilation The current webpack compilation.
+ * @param swContents The contents of the swSrc file, which may or
+ * may not include a valid sourcemap comment.
+ * @param swDest The configured swDest value.
+ * @returns If the swContents contains a valid sourcemap
+ * comment pointing to an asset present in the compilation, this will return the
+ * name of that asset. Otherwise, it will return undefined.
+ * @private
+ */
+export declare function getSourcemapAssetName(compilation: Compilation, swContents: string, swDest: string): string | undefined;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serwist/webpack-plugin",
-  "version": "8.3.0",
+  "version": "8.4.1",
   "type": "module",
   "description": "A plugin for your Webpack build process, helping you generate a manifest of local files that should be precached.",
   "files": [
@@ -24,7 +24,7 @@
   "license": "MIT",
   "repository": "serwist/serwist",
   "bugs": "https://github.com/serwist/serwist/issues",
-  "homepage": "https://serwist.vercel.app",
+  "homepage": "https://serwist.pages.dev",
   "module": "./dist/index.js",
   "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
@@ -61,7 +61,7 @@
   "dependencies": {
     "fast-json-stable-stringify": "2.1.0",
     "upath": "2.0.1",
-    "@serwist/build": "8.3.0"
+    "@serwist/build": "8.4.1"
   },
   "peerDependencies": {
     "webpack": "4.4.0 || ^5.9.0"
@@ -71,11 +71,12 @@
     "@types/webpack": "5.28.5",
     "pretty-bytes": "6.1.1",
     "rollup": "4.9.1",
-    "@serwist/constants": "8.3.0"
+    "@serwist/constants": "8.4.1"
   },
   "scripts": {
     "build": "rimraf dist && cross-env NODE_ENV=production rollup --config rollup.config.js",
-    "lint": "eslint src --ext ts,tsx,js,jsx,cjs,mjs",
+    "dev": "rollup --config rollup.config.js --watch",
+    "lint": "biome lint ./src",
     "typecheck": "tsc"
   }
 }