@serwist/webpack-plugin 8.1.0 → 8.2.0

package/dist/{index.old.cjs → index.cjs}

@@ -5,6 +5,7 @@ var stringify = require('fast-json-stable-stringify');
 var upath = require('upath');
 var webpack = require('webpack');
 var crypto = require('crypto');
+var relativeToOutputPath = require('./relative-to-output-path-5MVPPhSi.js');
 
 const BYTE_UNITS = [
     'B',
@@ -115,7 +116,7 @@ function prettyBytes(number, options) {
  * @returns The MD5 hash of the asset's source.
  *
  * @private
- */ function getAssetHash(asset) {
+ */ const getAssetHash = (asset)=>{
     // 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
@@ -123,7 +124,7 @@ function prettyBytes(number, options) {
         return null;
     }
     return crypto.createHash("md5").update(Buffer.from(asset.source.source())).digest("hex");
-}
+};
 
 /*
   Copyright 2018 Google LLC
@@ -316,7 +317,7 @@ async function getManifestEntriesFromCompilation(compilation, config) {
         compilation.warnings.push(new Error(warning));
     }
     // Ensure that the entries are properly sorted by URL.
-    const sortedEntries = manifestEntries.sort((a, b)=>a.url === b.url ? 0 : a.url > b.url ? 1 : -1);
+    const sortedEntries = manifestEntries?.sort((a, b)=>a.url === b.url ? 0 : a.url > b.url ? 1 : -1);
     return {
         size,
         sortedEntries
@@ -357,23 +358,6 @@ async function getManifestEntriesFromCompilation(compilation, config) {
     return undefined;
 }
 
-/**
- * @param compilation The webpack compilation.
- * @param swDest The original swDest value.
- *
- * @returns If swDest was not absolute, the returns swDest as-is.
- * Otherwise, returns swDest relative to the compilation's output path.
- *
- * @private
- */ function relativeToOutputPath(compilation, swDest) {
-    // See https://github.com/jantimon/html-webpack-plugin/pull/266/files#diff-168726dbe96b3ce427e7fedce31bb0bcR38
-    if (upath.resolve(swDest) === upath.normalize(swDest)) {
-        return upath.relative(compilation.options.output.path, swDest);
-    }
-    // Otherwise, return swDest as-is.
-    return swDest;
-}
-
 // Used to keep track of swDest files written by *any* instance of this plugin.
 // See https://github.com/GoogleChrome/workbox/issues/2181
 const _generatedAssetNames = new Set();
@@ -429,7 +413,7 @@ const _generatedAssetNames = new Set();
         if (config.disablePrecacheManifest) {
             return {
                 size: 0,
-                sortedEntries: [],
+                sortedEntries: undefined,
                 manifestString: "undefined"
             };
         }
@@ -536,7 +520,7 @@ const _generatedAssetNames = new Set();
                 throw new Error(`Please check your ${this.constructor.name} plugin ` + `configuration:\n${error.message}`);
             }
         }
-        this.config.swDest = relativeToOutputPath(compilation, this.config.swDest);
+        this.config.swDest = relativeToOutputPath.relativeToOutputPath(compilation, this.config.swDest);
         _generatedAssetNames.add(this.config.swDest);
         if (this.config.compileSrc) {
             await this.performChildCompilation(compilation, parentCompiler);
@@ -590,7 +574,7 @@ const _generatedAssetNames = new Set();
         }
         if (compilation.getLogger) {
             const logger = compilation.getLogger(this.constructor.name);
-            logger.info(`The service worker at ${config.swDest ?? ""} will precache ${sortedEntries.length} URLs, totaling ${prettyBytes(size)}.`);
+            logger.info(`The service worker at ${config.swDest ?? ""} will precache ${sortedEntries?.length ?? 0} URLs, totaling ${prettyBytes(size)}.`);
         }
     }
 }

package/dist/{index.internal.old.cjs → index.internal.cjs}

@@ -1,24 +1,8 @@
 'use strict';
 
 var webpack = require('webpack');
-var upath = require('upath');
-
-/**
- * @param compilation The webpack compilation.
- * @param swDest The original swDest value.
- *
- * @returns If swDest was not absolute, the returns swDest as-is.
- * Otherwise, returns swDest relative to the compilation's output path.
- *
- * @private
- */ function relativeToOutputPath(compilation, swDest) {
-    // See https://github.com/jantimon/html-webpack-plugin/pull/266/files#diff-168726dbe96b3ce427e7fedce31bb0bcR38
-    if (upath.resolve(swDest) === upath.normalize(swDest)) {
-        return upath.relative(compilation.options.output.path, swDest);
-    }
-    // Otherwise, return swDest as-is.
-    return swDest;
-}
+var relativeToOutputPath = require('./relative-to-output-path-5MVPPhSi.js');
+require('upath');
 
 /**
  * Compile a file by creating a child of the hooked compiler.
@@ -39,7 +23,7 @@ var upath = require('upath');
             }));
     }
     async performChildCompilation(compilation, parentCompiler) {
-        const resolvedDest = relativeToOutputPath(compilation, this.dest);
+        const resolvedDest = relativeToOutputPath.relativeToOutputPath(compilation, this.dest);
         const outputOptions = {
             filename: resolvedDest
         };

package/dist/index.internal.js

@@ -1,22 +1,6 @@
 import webpack from 'webpack';
-import upath from 'upath';
-
-/**
- * @param compilation The webpack compilation.
- * @param swDest The original swDest value.
- *
- * @returns If swDest was not absolute, the returns swDest as-is.
- * Otherwise, returns swDest relative to the compilation's output path.
- *
- * @private
- */ function relativeToOutputPath(compilation, swDest) {
-    // See https://github.com/jantimon/html-webpack-plugin/pull/266/files#diff-168726dbe96b3ce427e7fedce31bb0bcR38
-    if (upath.resolve(swDest) === upath.normalize(swDest)) {
-        return upath.relative(compilation.options.output.path, swDest);
-    }
-    // Otherwise, return swDest as-is.
-    return swDest;
-}
+import { r as relativeToOutputPath } from './relative-to-output-path-pbrP9MDI.js';
+import 'upath';
 
 /**
  * Compile a file by creating a child of the hooked compiler.

package/dist/index.js

@@ -3,6 +3,7 @@ import stringify from 'fast-json-stable-stringify';
 import upath from 'upath';
 import webpack from 'webpack';
 import crypto from 'crypto';
+import { r as relativeToOutputPath } from './relative-to-output-path-pbrP9MDI.js';
 
 const BYTE_UNITS = [
     'B',
@@ -113,7 +114,7 @@ function prettyBytes(number, options) {
  * @returns The MD5 hash of the asset's source.
  *
  * @private
- */ function getAssetHash(asset) {
+ */ const getAssetHash = (asset)=>{
     // 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
@@ -121,7 +122,7 @@ function prettyBytes(number, options) {
         return null;
     }
     return crypto.createHash("md5").update(Buffer.from(asset.source.source())).digest("hex");
-}
+};
 
 /*
   Copyright 2018 Google LLC
@@ -314,7 +315,7 @@ async function getManifestEntriesFromCompilation(compilation, config) {
         compilation.warnings.push(new Error(warning));
     }
     // Ensure that the entries are properly sorted by URL.
-    const sortedEntries = manifestEntries.sort((a, b)=>a.url === b.url ? 0 : a.url > b.url ? 1 : -1);
+    const sortedEntries = manifestEntries?.sort((a, b)=>a.url === b.url ? 0 : a.url > b.url ? 1 : -1);
     return {
         size,
         sortedEntries
@@ -355,23 +356,6 @@ async function getManifestEntriesFromCompilation(compilation, config) {
     return undefined;
 }
 
-/**
- * @param compilation The webpack compilation.
- * @param swDest The original swDest value.
- *
- * @returns If swDest was not absolute, the returns swDest as-is.
- * Otherwise, returns swDest relative to the compilation's output path.
- *
- * @private
- */ function relativeToOutputPath(compilation, swDest) {
-    // See https://github.com/jantimon/html-webpack-plugin/pull/266/files#diff-168726dbe96b3ce427e7fedce31bb0bcR38
-    if (upath.resolve(swDest) === upath.normalize(swDest)) {
-        return upath.relative(compilation.options.output.path, swDest);
-    }
-    // Otherwise, return swDest as-is.
-    return swDest;
-}
-
 // Used to keep track of swDest files written by *any* instance of this plugin.
 // See https://github.com/GoogleChrome/workbox/issues/2181
 const _generatedAssetNames = new Set();
@@ -427,7 +411,7 @@ const _generatedAssetNames = new Set();
         if (config.disablePrecacheManifest) {
             return {
                 size: 0,
-                sortedEntries: [],
+                sortedEntries: undefined,
                 manifestString: "undefined"
             };
         }
@@ -588,7 +572,7 @@ const _generatedAssetNames = new Set();
         }
         if (compilation.getLogger) {
             const logger = compilation.getLogger(this.constructor.name);
-            logger.info(`The service worker at ${config.swDest ?? ""} will precache ${sortedEntries.length} URLs, totaling ${prettyBytes(size)}.`);
+            logger.info(`The service worker at ${config.swDest ?? ""} will precache ${sortedEntries?.length ?? 0} URLs, totaling ${prettyBytes(size)}.`);
         }
     }
 }

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/inject-manifest.d.ts

@@ -42,7 +42,7 @@ declare class InjectManifest {
      */
     getManifestEntries(compilation: webpack.Compilation, config: WebpackInjectManifestOptions): Promise<{
         size: number;
-        sortedEntries: import("@serwist/build").ManifestEntry[];
+        sortedEntries: import("@serwist/build").ManifestEntry[] | undefined;
         manifestString: string;
     }>;
     /**

package/dist/lib/child-compilation-plugin.d.cts

@@ -0,0 +1,20 @@
+import type { WebpackPluginInstance } from "webpack";
+import webpack from "webpack";
+export interface ChildCompilationPluginOptions {
+    src: string;
+    dest: string;
+    plugins?: WebpackPluginInstance[];
+}
+/**
+ * Compile a file by creating a child of the hooked compiler.
+ *
+ * @private
+ */
+export declare class ChildCompilationPlugin implements WebpackPluginInstance {
+    src: string;
+    dest: string;
+    plugins: WebpackPluginInstance[] | undefined;
+    constructor({ src, dest, plugins }: ChildCompilationPluginOptions);
+    apply(compiler: webpack.Compiler): void;
+    performChildCompilation(compilation: webpack.Compilation, parentCompiler: webpack.Compiler): Promise<void>;
+}

package/dist/lib/get-asset-hash.d.cts

@@ -0,0 +1,8 @@
+import type { Asset } from "webpack";
+/**
+ * @param asset
+ * @returns The MD5 hash of the asset's source.
+ *
+ * @private
+ */
+export declare const getAssetHash: (asset: Asset) => string | null;

package/dist/lib/get-asset-hash.d.ts

@@ -5,4 +5,4 @@ import type { Asset } from "webpack";
  *
  * @private
  */
-export declare function getAssetHash(asset: Asset): string | null;
+export declare const getAssetHash: (asset: Asset) => string | null;

package/dist/lib/get-manifest-entries-from-compilation.d.cts

@@ -0,0 +1,6 @@
+import type { ManifestEntry, WebpackInjectManifestOptions } from "@serwist/build";
+import type { Compilation } from "webpack";
+export declare function getManifestEntriesFromCompilation(compilation: Compilation, config: WebpackInjectManifestOptions): Promise<{
+    size: number;
+    sortedEntries: ManifestEntry[] | undefined;
+}>;

package/dist/lib/get-manifest-entries-from-compilation.d.ts

@@ -2,5 +2,5 @@ import type { ManifestEntry, WebpackInjectManifestOptions } from "@serwist/build
 import type { Compilation } from "webpack";
 export declare function getManifestEntriesFromCompilation(compilation: Compilation, config: WebpackInjectManifestOptions): Promise<{
     size: number;
-    sortedEntries: ManifestEntry[];
+    sortedEntries: ManifestEntry[] | undefined;
 }>;

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/dist/lib/relative-to-output-path.d.cts

@@ -0,0 +1,11 @@
+import type { Compilation } from "webpack";
+/**
+ * @param compilation The webpack compilation.
+ * @param swDest The original swDest value.
+ *
+ * @returns If swDest was not absolute, the returns swDest as-is.
+ * Otherwise, returns swDest relative to the compilation's output path.
+ *
+ * @private
+ */
+export declare function relativeToOutputPath(compilation: Compilation, swDest: string): string;

package/dist/lib/resolve-webpack-url.d.cts

@@ -0,0 +1,12 @@
+/**
+ * Resolves a url in the way that webpack would (with string concatenation)
+ *
+ * Use publicPath + filePath instead of url.resolve(publicPath, filePath) see:
+ * https://webpack.js.org/configuration/output/#output-publicpath
+ *
+ * @param publicPath The publicPath value from webpack's compilation.
+ * @param paths File paths to join
+ * @returns Joined file path
+ * @private
+ */
+export declare function resolveWebpackURL(publicPath: string, ...paths: Array<string>): string;

package/dist/relative-to-output-path-5MVPPhSi.js

@@ -0,0 +1,22 @@
+'use strict';
+
+var upath = require('upath');
+
+/**
+ * @param compilation The webpack compilation.
+ * @param swDest The original swDest value.
+ *
+ * @returns If swDest was not absolute, the returns swDest as-is.
+ * Otherwise, returns swDest relative to the compilation's output path.
+ *
+ * @private
+ */ function relativeToOutputPath(compilation, swDest) {
+    // See https://github.com/jantimon/html-webpack-plugin/pull/266/files#diff-168726dbe96b3ce427e7fedce31bb0bcR38
+    if (upath.resolve(swDest) === upath.normalize(swDest)) {
+        return upath.relative(compilation.options.output.path, swDest);
+    }
+    // Otherwise, return swDest as-is.
+    return swDest;
+}
+
+exports.relativeToOutputPath = relativeToOutputPath;

package/dist/relative-to-output-path-pbrP9MDI.js

@@ -0,0 +1,20 @@
+import upath from 'upath';
+
+/**
+ * @param compilation The webpack compilation.
+ * @param swDest The original swDest value.
+ *
+ * @returns If swDest was not absolute, the returns swDest as-is.
+ * Otherwise, returns swDest relative to the compilation's output path.
+ *
+ * @private
+ */ function relativeToOutputPath(compilation, swDest) {
+    // See https://github.com/jantimon/html-webpack-plugin/pull/266/files#diff-168726dbe96b3ce427e7fedce31bb0bcR38
+    if (upath.resolve(swDest) === upath.normalize(swDest)) {
+        return upath.relative(compilation.options.output.path, swDest);
+    }
+    // Otherwise, return swDest as-is.
+    return swDest;
+}
+
+export { relativeToOutputPath as r };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serwist/webpack-plugin",
-  "version": "8.1.0",
+  "version": "8.2.0",
   "type": "module",
   "description": "A plugin for your Webpack build process, helping you generate a manifest of local files that should be precached.",
   "files": [
@@ -24,9 +24,9 @@
   "license": "MIT",
   "repository": "serwist/serwist",
   "bugs": "https://github.com/serwist/serwist/issues",
-  "homepage": "https://ducanh-next-pwa.vercel.app",
+  "homepage": "https://serwist.vercel.app",
   "module": "./dist/index.js",
-  "main": "./dist/index.old.cjs",
+  "main": "./dist/index.cjs",
   "types": "./dist/index.d.ts",
   "typesVersions": {
     "*": {
@@ -42,8 +42,8 @@
         "default": "./dist/index.js"
       },
       "require": {
-        "types": "./dist/index.old.d.cts",
-        "default": "./dist/index.old.cjs"
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
       }
     },
     "./internal": {
@@ -52,8 +52,8 @@
         "default": "./dist/index.internal.js"
       },
       "require": {
-        "types": "./dist/index.internal.old.d.cts",
-        "default": "./dist/index.internal.old.cjs"
+        "types": "./dist/index.internal.d.cts",
+        "default": "./dist/index.internal.cjs"
       }
     },
     "./package.json": "./package.json"
@@ -62,7 +62,7 @@
     "fast-json-stable-stringify": "2.1.0",
     "rollup": "4.9.1",
     "upath": "2.0.1",
-    "@serwist/build": "8.1.0"
+    "@serwist/build": "8.2.0"
   },
   "peerDependencies": {
     "webpack": "4.4.0 || ^5.9.0"
@@ -71,7 +71,7 @@
     "@types/node": "20.10.5",
     "@types/webpack": "5.28.5",
     "pretty-bytes": "6.1.1",
-    "@serwist/constants": "8.1.0"
+    "@serwist/constants": "8.2.0"
   },
   "scripts": {
     "build": "rimraf dist && cross-env NODE_ENV=production rollup --config rollup.config.js",