@serwist/build 8.3.0 → 8.4.1

package/README.md

@@ -1 +1 @@
-This module's documentation can be found at https://developers.google.com/web/tools/workbox/modules/workbox-build
+This module's documentation can be found at https://serwist.pages.dev/docs/build

package/dist/index.cjs

@@ -1,18 +1,18 @@
 'use strict';
 
-var commonTags = require('common-tags');
+var stringify = require('fast-json-stable-stringify');
 var assert = require('assert');
+var commonTags = require('common-tags');
 var crypto = require('crypto');
 var glob = require('glob');
 var upath = require('upath');
 var fse = require('fs-extra');
 var betterAjvErrors = require('@apideck/better-ajv-errors');
 var Ajv = require('ajv');
-var stringify = require('fast-json-stable-stringify');
 var sourceMap = require('source-map');
 
 const errors = {
-    "unable-to-get-rootdir": `Unable to get the root directory of your web app.`,
+    "unable-to-get-rootdir": "Unable to get the root directory of your web app.",
     "no-extension": commonTags.oneLine`Unable to detect a usable extension for a file in your web
     app directory.`,
     "invalid-file-manifest-name": commonTags.oneLine`The File Manifest Name must have at least one
@@ -133,7 +133,7 @@ function getFileHash(file) {
         const buffer = fse.readFileSync(file);
         return getStringHash(buffer);
     } catch (err) {
-        throw new Error(errors["unable-to-get-file-hash"] + ` '${err instanceof Error && err.message ? err.message : ""}'`);
+        throw new Error(`${errors["unable-to-get-file-hash"]} '${err instanceof Error && err.message ? err.message : ""}'`);
     }
 }
 
@@ -145,7 +145,7 @@ function getFileSize(file) {
         }
         return stat.size;
     } catch (err) {
-        throw new Error(errors["unable-to-get-file-size"] + ` '${err instanceof Error && err.message ? err.message : ""}'`);
+        throw new Error(`${errors["unable-to-get-file-size"]} '${err instanceof Error && err.message ? err.message : ""}'`);
     }
 }
 
@@ -159,14 +159,14 @@ function getFileDetails({ globDirectory, globFollow, globIgnores, globPattern })
             ignore: globIgnores
         });
     } catch (err) {
-        throw new Error(errors["unable-to-glob-files"] + ` '${err instanceof Error && err.message ? err.message : ""}'`);
+        throw new Error(`${errors["unable-to-glob-files"]} '${err instanceof Error && err.message ? err.message : ""}'`);
     }
     if (globbedFiles.length === 0) {
-        warning = errors["useless-glob-pattern"] + " " + JSON.stringify({
+        warning = `${errors["useless-glob-pattern"]} ${JSON.stringify({
             globDirectory,
             globPattern,
             globIgnores
-        }, null, 2);
+        }, null, 2)}`;
     }
     const globbedFileDetails = [];
     for (const file of globbedFiles){
@@ -343,7 +343,7 @@ function maximumSizeTransform(maximumFileSizeToCacheInBytes) {
             if (entry.size <= maximumFileSizeToCacheInBytes) {
                 return true;
             }
-            warnings.push(`${entry.url} is ${prettyBytes(entry.size)}, and won't ` + `be precached. Configure maximumFileSizeToCacheInBytes to change ` + `this limit.`);
+            warnings.push(`${entry.url} is ${prettyBytes(entry.size)}, and won't be precached. Configure maximumFileSizeToCacheInBytes to change this limit.`);
             return false;
         });
         return {
@@ -477,6 +477,7 @@ async function transformManifest({ additionalPrecacheEntries, dontCacheBustURLsM
     let size = 0;
     for (const manifestEntry of transformedManifest){
         size += manifestEntry.size || 0;
+        // biome-ignore lint/performance/noDelete: I don't understand this part yet.
         delete manifestEntry.size;
     }
     return {
@@ -569,6 +570,177 @@ async function getFileManifestEntries({ additionalPrecacheEntries, dontCacheBust
     return transformedManifest;
 }
 
+var additionalProperties$3 = false;
+var type$3 = "object";
+var properties$3 = {
+    additionalPrecacheEntries: {
+        description: "A list of entries to be precached, in addition to any entries that are\ngenerated as part of the build configuration.",
+        type: "array",
+        items: {
+            anyOf: [
+                {
+                    $ref: "#/definitions/ManifestEntry"
+                },
+                {
+                    type: "string"
+                }
+            ]
+        }
+    },
+    dontCacheBustURLsMatching: {
+        description: "Assets that match this will be assumed to be uniquely versioned via their\nURL, and exempted from the normal HTTP cache-busting that's done when\npopulating the precache. While not required, it's recommended that if your\nexisting build process already inserts a `[hash]` value into each filename,\nyou provide a RegExp that will detect that, as it will reduce the bandwidth\nconsumed when precaching.",
+        $ref: "#/definitions/RegExp"
+    },
+    manifestTransforms: {
+        description: "One or more functions which will be applied sequentially against the\ngenerated manifest. If `modifyURLPrefix` or `dontCacheBustURLsMatching` are\nalso specified, their corresponding transformations will be applied first.",
+        type: "array",
+        items: {}
+    },
+    maximumFileSizeToCacheInBytes: {
+        description: "This value can be used to determine the maximum size of files that will be\nprecached. This prevents you from inadvertently precaching very large files\nthat might have accidentally matched one of your patterns.",
+        "default": 2097152,
+        type: "number"
+    },
+    modifyURLPrefix: {
+        description: "An object mapping string prefixes to replacement string values. This can be\nused to, e.g., remove or add a path prefix from a manifest entry if your\nweb hosting setup doesn't match your local filesystem setup. As an\nalternative with more flexibility, you can use the `manifestTransforms`\noption and provide a function that modifies the entries in the manifest\nusing whatever logic you provide.\n\nExample usage:\n\n```\n// Replace a '/dist/' prefix with '/', and also prepend\n// '/static' to every URL.\nmodifyURLPrefix: {\n  '/dist/': '/',\n  '': '/static',\n}\n```",
+        type: "object",
+        additionalProperties: {
+            type: "string"
+        }
+    },
+    globFollow: {
+        description: "Determines whether or not symlinks are followed when generating the\nprecache manifest. For more information, see the definition of `follow` in\nthe `glob` [documentation](https://github.com/isaacs/node-glob#options).",
+        "default": true,
+        type: "boolean"
+    },
+    globIgnores: {
+        description: "A set of patterns matching files to always exclude when generating the\nprecache manifest. For more information, see the definition of `ignore` in\nthe `glob` [documentation](https://github.com/isaacs/node-glob#options).",
+        "default": [
+            "**/node_modules/**/*"
+        ],
+        type: "array",
+        items: {
+            type: "string"
+        }
+    },
+    globPatterns: {
+        description: "Files matching any of these patterns will be included in the precache\nmanifest. For more information, see the\n[`glob` primer](https://github.com/isaacs/node-glob#glob-primer).",
+        "default": [
+            "**/*.{js,css,html}"
+        ],
+        type: "array",
+        items: {
+            type: "string"
+        }
+    },
+    globStrict: {
+        description: "If true, an error reading a directory when generating a precache manifest\nwill cause the build to fail. If false, the problematic directory will be\nskipped. For more information, see the definition of `strict` in the `glob`\n[documentation](https://github.com/isaacs/node-glob#options).",
+        "default": true,
+        type: "boolean"
+    },
+    templatedURLs: {
+        description: "If a URL is rendered based on some server-side logic, its contents may\ndepend on multiple files or on some other unique string value. The keys in\nthis object are server-rendered URLs. If the values are an array of\nstrings, they will be interpreted as `glob` patterns, and the contents of\nany files matching the patterns will be used to uniquely version the URL.\nIf used with a single string, it will be interpreted as unique versioning\ninformation that you've generated for a given URL.",
+        type: "object",
+        additionalProperties: {
+            anyOf: [
+                {
+                    type: "array",
+                    items: {
+                        type: "string"
+                    }
+                },
+                {
+                    type: "string"
+                }
+            ]
+        }
+    },
+    globDirectory: {
+        description: "The local directory you wish to match `globPatterns` against. The path is\nrelative to the current directory.",
+        type: "string"
+    }
+};
+var required$3 = [
+    "globDirectory"
+];
+var definitions$3 = {
+    ManifestEntry: {
+        type: "object",
+        properties: {
+            integrity: {
+                type: "string"
+            },
+            revision: {
+                type: [
+                    "null",
+                    "string"
+                ]
+            },
+            url: {
+                type: "string"
+            }
+        },
+        additionalProperties: false,
+        required: [
+            "revision",
+            "url"
+        ]
+    },
+    "RegExp": {
+        type: "object",
+        properties: {
+            source: {
+                type: "string"
+            },
+            global: {
+                type: "boolean"
+            },
+            ignoreCase: {
+                type: "boolean"
+            },
+            multiline: {
+                type: "boolean"
+            },
+            lastIndex: {
+                type: "number"
+            },
+            flags: {
+                type: "string"
+            },
+            sticky: {
+                type: "boolean"
+            },
+            unicode: {
+                type: "boolean"
+            },
+            dotAll: {
+                type: "boolean"
+            }
+        },
+        additionalProperties: false,
+        required: [
+            "dotAll",
+            "flags",
+            "global",
+            "ignoreCase",
+            "lastIndex",
+            "multiline",
+            "source",
+            "sticky",
+            "unicode"
+        ]
+    }
+};
+var $schema$3 = "http://json-schema.org/draft-07/schema#";
+var getManifestOptionsSchema = {
+    additionalProperties: additionalProperties$3,
+    type: type$3,
+    properties: properties$3,
+    required: required$3,
+    definitions: definitions$3,
+    $schema: $schema$3
+};
+
 var additionalProperties$2 = false;
 var type$2 = "object";
 var properties$2 = {
@@ -654,13 +826,33 @@ var properties$2 = {
             ]
         }
     },
+    injectionPoint: {
+        description: "The string to find inside of the `swSrc` file. Once found, it will be\nreplaced by the generated precache manifest.",
+        "default": "self.__SW_MANIFEST",
+        type: "string"
+    },
+    swSrc: {
+        description: "The path and filename of the service worker file that will be read during\nthe build process, relative to the current working directory.",
+        type: "string"
+    },
+    swDest: {
+        description: "The path and filename of the service worker file that will be created by\nthe build process, relative to the current working directory. It must end\nin '.js'.",
+        type: "string"
+    },
     globDirectory: {
         description: "The local directory you wish to match `globPatterns` against. The path is\nrelative to the current directory.",
         type: "string"
+    },
+    disablePrecacheManifest: {
+        description: "Whether the precache manifest should be set to `undefined`.",
+        "default": false,
+        type: "boolean"
     }
 };
 var required$2 = [
-    "globDirectory"
+    "globDirectory",
+    "swDest",
+    "swSrc"
 ];
 var definitions$2 = {
     ManifestEntry: {
@@ -731,7 +923,7 @@ var definitions$2 = {
     }
 };
 var $schema$2 = "http://json-schema.org/draft-07/schema#";
-var getManifestOptionsSchema = {
+var injectManifestOptionsSchema = {
     additionalProperties: additionalProperties$2,
     type: type$2,
     properties: properties$2,
@@ -922,7 +1114,7 @@ var definitions$1 = {
     }
 };
 var $schema$1 = "http://json-schema.org/draft-07/schema#";
-var injectManifestOptionsSchema = {
+var viteInjectManifestOptionsSchema = {
     additionalProperties: additionalProperties$1,
     type: type$1,
     properties: properties$1,
@@ -1113,7 +1305,8 @@ var webpackInjectManifestOptionsSchema = {
 const optionsSchemas = {
     GetManifest: getManifestOptionsSchema,
     InjectManifest: injectManifestOptionsSchema,
-    WebpackInjectManifest: webpackInjectManifestOptionsSchema
+    WebpackInjectManifest: webpackInjectManifestOptionsSchema,
+    ViteInjectManifest: viteInjectManifestOptionsSchema
 };
 
 const ajv = new Ajv({
@@ -1177,6 +1370,10 @@ function validateWebpackInjectManifestOptions(input) {
     const [validatedOptions] = validate(inputWithExcludeDefault, "WebpackInjectManifest");
     return validatedOptions;
 }
+const validateViteInjectManifestOptions = (input)=>{
+    const [validatedOptions] = validate(input, "ViteInjectManifest");
+    return validatedOptions;
+};
 
 /**
  * This method returns a list of URLs to precache, referred to as a "precache
@@ -1207,7 +1404,7 @@ function validateWebpackInjectManifestOptions(input) {
 */ // Adapted from https://github.com/lydell/source-map-url/blob/master/source-map-url.js
 // See https://github.com/GoogleChrome/workbox/issues/3019
 const innerRegex = /[#@] sourceMappingURL=([^\s'"]*)/;
-const regex = RegExp("(?:" + "/\\*" + "(?:\\s*\r?\n(?://)?)?" + "(?:" + innerRegex.source + ")" + "\\s*" + "\\*/" + "|" + "//(?:" + innerRegex.source + ")" + ")" + "\\s*");
+const regex = RegExp(`(?:/\\*(?:\\s*\r?\n(?://)?)?(?:${innerRegex.source})\\s*\\*/|//(?:${innerRegex.source}))\\s*`);
 function getSourceMapURL(srcContents) {
     const match = srcContents.match(regex);
     return match ? match[1] || match[2] || "" : null;
@@ -1370,7 +1567,7 @@ function translateURLToSourcemapPaths(url, swSrc, swDest) {
         throw new Error(`${errors["injection-point-not-found"]} ${injectionPoint}`);
     }
     assert(injectionResults.length === 1, `${errors["multiple-injection-points"]} ${injectionPoint}`);
-    const manifestString = stringify(manifestEntries);
+    const manifestString = manifestEntries === undefined ? "undefined" : stringify(manifestEntries);
     const filesToWrite = {};
     const url = getSourceMapURL(swFileContents);
     // See https://github.com/GoogleChrome/workbox/issues/2957
@@ -1406,7 +1603,7 @@ function translateURLToSourcemapPaths(url, swSrc, swDest) {
         try {
             await fse.mkdirp(upath.dirname(file));
         } catch (error) {
-            throw new Error(errors["unable-to-make-sw-directory"] + ` '${error instanceof Error && error.message ? error.message : ""}'`);
+            throw new Error(`${errors["unable-to-make-sw-directory"]} '${error instanceof Error && error.message ? error.message : ""}'`);
         }
         await fse.writeFile(file, contents);
     }
@@ -1419,11 +1616,17 @@ function translateURLToSourcemapPaths(url, swSrc, swDest) {
     };
 }
 
+exports.stringify = stringify;
 exports.errors = errors;
 exports.escapeRegExp = escapeRegExp;
+exports.getFileManifestEntries = getFileManifestEntries;
 exports.getManifest = getManifest;
 exports.getSourceMapURL = getSourceMapURL;
 exports.injectManifest = injectManifest;
+exports.rebasePath = rebasePath;
 exports.replaceAndUpdateSourceMap = replaceAndUpdateSourceMap;
 exports.transformManifest = transformManifest;
+exports.translateURLToSourcemapPaths = translateURLToSourcemapPaths;
+exports.validateInjectManifestOptions = validateInjectManifestOptions;
+exports.validateViteInjectManifestOptions = validateViteInjectManifestOptions;
 exports.validateWebpackInjectManifestOptions = validateWebpackInjectManifestOptions;

package/dist/index.d.cts

@@ -1,10 +1,14 @@
-import { errors } from "./lib/errors.js";
+import stringify from "fast-json-stable-stringify";
 import { getManifest } from "./get-manifest.js";
 import { injectManifest } from "./inject-manifest.js";
+import { errors } from "./lib/errors.js";
 import { escapeRegExp } from "./lib/escape-regexp.js";
+import { getFileManifestEntries } from "./lib/get-file-manifest-entries.js";
 import { getSourceMapURL } from "./lib/get-source-map-url.js";
+import { rebasePath } from "./lib/rebase-path.js";
 import { replaceAndUpdateSourceMap } from "./lib/replace-and-update-source-map.js";
 import { transformManifest } from "./lib/transform-manifest.js";
-import { validateWebpackInjectManifestOptions } from "./lib/validate-options.js";
-export { escapeRegExp, errors, getManifest, getSourceMapURL, injectManifest, replaceAndUpdateSourceMap, transformManifest, validateWebpackInjectManifestOptions, };
+import { translateURLToSourcemapPaths } from "./lib/translate-url-to-sourcemap-paths.js";
+import { validateInjectManifestOptions, validateViteInjectManifestOptions, validateWebpackInjectManifestOptions } from "./lib/validate-options.js";
+export { errors, escapeRegExp, getFileManifestEntries, getManifest, getSourceMapURL, injectManifest, rebasePath, replaceAndUpdateSourceMap, stringify, transformManifest, translateURLToSourcemapPaths, validateInjectManifestOptions, validateViteInjectManifestOptions, validateWebpackInjectManifestOptions, };
 export * from "./types.js";

package/dist/index.d.ts

@@ -1,10 +1,14 @@
-import { errors } from "./lib/errors.js";
+import stringify from "fast-json-stable-stringify";
 import { getManifest } from "./get-manifest.js";
 import { injectManifest } from "./inject-manifest.js";
+import { errors } from "./lib/errors.js";
 import { escapeRegExp } from "./lib/escape-regexp.js";
+import { getFileManifestEntries } from "./lib/get-file-manifest-entries.js";
 import { getSourceMapURL } from "./lib/get-source-map-url.js";
+import { rebasePath } from "./lib/rebase-path.js";
 import { replaceAndUpdateSourceMap } from "./lib/replace-and-update-source-map.js";
 import { transformManifest } from "./lib/transform-manifest.js";
-import { validateWebpackInjectManifestOptions } from "./lib/validate-options.js";
-export { escapeRegExp, errors, getManifest, getSourceMapURL, injectManifest, replaceAndUpdateSourceMap, transformManifest, validateWebpackInjectManifestOptions, };
+import { translateURLToSourcemapPaths } from "./lib/translate-url-to-sourcemap-paths.js";
+import { validateInjectManifestOptions, validateViteInjectManifestOptions, validateWebpackInjectManifestOptions } from "./lib/validate-options.js";
+export { errors, escapeRegExp, getFileManifestEntries, getManifest, getSourceMapURL, injectManifest, rebasePath, replaceAndUpdateSourceMap, stringify, transformManifest, translateURLToSourcemapPaths, validateInjectManifestOptions, validateViteInjectManifestOptions, validateWebpackInjectManifestOptions, };
 export * from "./types.js";

package/dist/index.js

@@ -1,16 +1,17 @@
-import { oneLine } from 'common-tags';
+import stringify from 'fast-json-stable-stringify';
+export { default as stringify } from 'fast-json-stable-stringify';
 import assert from 'assert';
+import { oneLine } from 'common-tags';
 import crypto from 'crypto';
 import { glob } from 'glob';
 import upath from 'upath';
 import fse from 'fs-extra';
 import { betterAjvErrors } from '@apideck/better-ajv-errors';
 import Ajv from 'ajv';
-import stringify from 'fast-json-stable-stringify';
 import { SourceMapGenerator, SourceMapConsumer } from 'source-map';
 
 const errors = {
-    "unable-to-get-rootdir": `Unable to get the root directory of your web app.`,
+    "unable-to-get-rootdir": "Unable to get the root directory of your web app.",
     "no-extension": oneLine`Unable to detect a usable extension for a file in your web
     app directory.`,
     "invalid-file-manifest-name": oneLine`The File Manifest Name must have at least one
@@ -131,7 +132,7 @@ function getFileHash(file) {
         const buffer = fse.readFileSync(file);
         return getStringHash(buffer);
     } catch (err) {
-        throw new Error(errors["unable-to-get-file-hash"] + ` '${err instanceof Error && err.message ? err.message : ""}'`);
+        throw new Error(`${errors["unable-to-get-file-hash"]} '${err instanceof Error && err.message ? err.message : ""}'`);
     }
 }
 
@@ -143,7 +144,7 @@ function getFileSize(file) {
         }
         return stat.size;
     } catch (err) {
-        throw new Error(errors["unable-to-get-file-size"] + ` '${err instanceof Error && err.message ? err.message : ""}'`);
+        throw new Error(`${errors["unable-to-get-file-size"]} '${err instanceof Error && err.message ? err.message : ""}'`);
     }
 }
 
@@ -157,14 +158,14 @@ function getFileDetails({ globDirectory, globFollow, globIgnores, globPattern })
             ignore: globIgnores
         });
     } catch (err) {
-        throw new Error(errors["unable-to-glob-files"] + ` '${err instanceof Error && err.message ? err.message : ""}'`);
+        throw new Error(`${errors["unable-to-glob-files"]} '${err instanceof Error && err.message ? err.message : ""}'`);
     }
     if (globbedFiles.length === 0) {
-        warning = errors["useless-glob-pattern"] + " " + JSON.stringify({
+        warning = `${errors["useless-glob-pattern"]} ${JSON.stringify({
             globDirectory,
             globPattern,
             globIgnores
-        }, null, 2);
+        }, null, 2)}`;
     }
     const globbedFileDetails = [];
     for (const file of globbedFiles){
@@ -341,7 +342,7 @@ function maximumSizeTransform(maximumFileSizeToCacheInBytes) {
             if (entry.size <= maximumFileSizeToCacheInBytes) {
                 return true;
             }
-            warnings.push(`${entry.url} is ${prettyBytes(entry.size)}, and won't ` + `be precached. Configure maximumFileSizeToCacheInBytes to change ` + `this limit.`);
+            warnings.push(`${entry.url} is ${prettyBytes(entry.size)}, and won't be precached. Configure maximumFileSizeToCacheInBytes to change this limit.`);
             return false;
         });
         return {
@@ -475,6 +476,7 @@ async function transformManifest({ additionalPrecacheEntries, dontCacheBustURLsM
     let size = 0;
     for (const manifestEntry of transformedManifest){
         size += manifestEntry.size || 0;
+        // biome-ignore lint/performance/noDelete: I don't understand this part yet.
         delete manifestEntry.size;
     }
     return {
@@ -567,6 +569,177 @@ async function getFileManifestEntries({ additionalPrecacheEntries, dontCacheBust
     return transformedManifest;
 }
 
+var additionalProperties$3 = false;
+var type$3 = "object";
+var properties$3 = {
+    additionalPrecacheEntries: {
+        description: "A list of entries to be precached, in addition to any entries that are\ngenerated as part of the build configuration.",
+        type: "array",
+        items: {
+            anyOf: [
+                {
+                    $ref: "#/definitions/ManifestEntry"
+                },
+                {
+                    type: "string"
+                }
+            ]
+        }
+    },
+    dontCacheBustURLsMatching: {
+        description: "Assets that match this will be assumed to be uniquely versioned via their\nURL, and exempted from the normal HTTP cache-busting that's done when\npopulating the precache. While not required, it's recommended that if your\nexisting build process already inserts a `[hash]` value into each filename,\nyou provide a RegExp that will detect that, as it will reduce the bandwidth\nconsumed when precaching.",
+        $ref: "#/definitions/RegExp"
+    },
+    manifestTransforms: {
+        description: "One or more functions which will be applied sequentially against the\ngenerated manifest. If `modifyURLPrefix` or `dontCacheBustURLsMatching` are\nalso specified, their corresponding transformations will be applied first.",
+        type: "array",
+        items: {}
+    },
+    maximumFileSizeToCacheInBytes: {
+        description: "This value can be used to determine the maximum size of files that will be\nprecached. This prevents you from inadvertently precaching very large files\nthat might have accidentally matched one of your patterns.",
+        "default": 2097152,
+        type: "number"
+    },
+    modifyURLPrefix: {
+        description: "An object mapping string prefixes to replacement string values. This can be\nused to, e.g., remove or add a path prefix from a manifest entry if your\nweb hosting setup doesn't match your local filesystem setup. As an\nalternative with more flexibility, you can use the `manifestTransforms`\noption and provide a function that modifies the entries in the manifest\nusing whatever logic you provide.\n\nExample usage:\n\n```\n// Replace a '/dist/' prefix with '/', and also prepend\n// '/static' to every URL.\nmodifyURLPrefix: {\n  '/dist/': '/',\n  '': '/static',\n}\n```",
+        type: "object",
+        additionalProperties: {
+            type: "string"
+        }
+    },
+    globFollow: {
+        description: "Determines whether or not symlinks are followed when generating the\nprecache manifest. For more information, see the definition of `follow` in\nthe `glob` [documentation](https://github.com/isaacs/node-glob#options).",
+        "default": true,
+        type: "boolean"
+    },
+    globIgnores: {
+        description: "A set of patterns matching files to always exclude when generating the\nprecache manifest. For more information, see the definition of `ignore` in\nthe `glob` [documentation](https://github.com/isaacs/node-glob#options).",
+        "default": [
+            "**/node_modules/**/*"
+        ],
+        type: "array",
+        items: {
+            type: "string"
+        }
+    },
+    globPatterns: {
+        description: "Files matching any of these patterns will be included in the precache\nmanifest. For more information, see the\n[`glob` primer](https://github.com/isaacs/node-glob#glob-primer).",
+        "default": [
+            "**/*.{js,css,html}"
+        ],
+        type: "array",
+        items: {
+            type: "string"
+        }
+    },
+    globStrict: {
+        description: "If true, an error reading a directory when generating a precache manifest\nwill cause the build to fail. If false, the problematic directory will be\nskipped. For more information, see the definition of `strict` in the `glob`\n[documentation](https://github.com/isaacs/node-glob#options).",
+        "default": true,
+        type: "boolean"
+    },
+    templatedURLs: {
+        description: "If a URL is rendered based on some server-side logic, its contents may\ndepend on multiple files or on some other unique string value. The keys in\nthis object are server-rendered URLs. If the values are an array of\nstrings, they will be interpreted as `glob` patterns, and the contents of\nany files matching the patterns will be used to uniquely version the URL.\nIf used with a single string, it will be interpreted as unique versioning\ninformation that you've generated for a given URL.",
+        type: "object",
+        additionalProperties: {
+            anyOf: [
+                {
+                    type: "array",
+                    items: {
+                        type: "string"
+                    }
+                },
+                {
+                    type: "string"
+                }
+            ]
+        }
+    },
+    globDirectory: {
+        description: "The local directory you wish to match `globPatterns` against. The path is\nrelative to the current directory.",
+        type: "string"
+    }
+};
+var required$3 = [
+    "globDirectory"
+];
+var definitions$3 = {
+    ManifestEntry: {
+        type: "object",
+        properties: {
+            integrity: {
+                type: "string"
+            },
+            revision: {
+                type: [
+                    "null",
+                    "string"
+                ]
+            },
+            url: {
+                type: "string"
+            }
+        },
+        additionalProperties: false,
+        required: [
+            "revision",
+            "url"
+        ]
+    },
+    "RegExp": {
+        type: "object",
+        properties: {
+            source: {
+                type: "string"
+            },
+            global: {
+                type: "boolean"
+            },
+            ignoreCase: {
+                type: "boolean"
+            },
+            multiline: {
+                type: "boolean"
+            },
+            lastIndex: {
+                type: "number"
+            },
+            flags: {
+                type: "string"
+            },
+            sticky: {
+                type: "boolean"
+            },
+            unicode: {
+                type: "boolean"
+            },
+            dotAll: {
+                type: "boolean"
+            }
+        },
+        additionalProperties: false,
+        required: [
+            "dotAll",
+            "flags",
+            "global",
+            "ignoreCase",
+            "lastIndex",
+            "multiline",
+            "source",
+            "sticky",
+            "unicode"
+        ]
+    }
+};
+var $schema$3 = "http://json-schema.org/draft-07/schema#";
+var getManifestOptionsSchema = {
+    additionalProperties: additionalProperties$3,
+    type: type$3,
+    properties: properties$3,
+    required: required$3,
+    definitions: definitions$3,
+    $schema: $schema$3
+};
+
 var additionalProperties$2 = false;
 var type$2 = "object";
 var properties$2 = {
@@ -652,13 +825,33 @@ var properties$2 = {
             ]
         }
     },
+    injectionPoint: {
+        description: "The string to find inside of the `swSrc` file. Once found, it will be\nreplaced by the generated precache manifest.",
+        "default": "self.__SW_MANIFEST",
+        type: "string"
+    },
+    swSrc: {
+        description: "The path and filename of the service worker file that will be read during\nthe build process, relative to the current working directory.",
+        type: "string"
+    },
+    swDest: {
+        description: "The path and filename of the service worker file that will be created by\nthe build process, relative to the current working directory. It must end\nin '.js'.",
+        type: "string"
+    },
     globDirectory: {
         description: "The local directory you wish to match `globPatterns` against. The path is\nrelative to the current directory.",
         type: "string"
+    },
+    disablePrecacheManifest: {
+        description: "Whether the precache manifest should be set to `undefined`.",
+        "default": false,
+        type: "boolean"
     }
 };
 var required$2 = [
-    "globDirectory"
+    "globDirectory",
+    "swDest",
+    "swSrc"
 ];
 var definitions$2 = {
     ManifestEntry: {
@@ -729,7 +922,7 @@ var definitions$2 = {
     }
 };
 var $schema$2 = "http://json-schema.org/draft-07/schema#";
-var getManifestOptionsSchema = {
+var injectManifestOptionsSchema = {
     additionalProperties: additionalProperties$2,
     type: type$2,
     properties: properties$2,
@@ -920,7 +1113,7 @@ var definitions$1 = {
     }
 };
 var $schema$1 = "http://json-schema.org/draft-07/schema#";
-var injectManifestOptionsSchema = {
+var viteInjectManifestOptionsSchema = {
     additionalProperties: additionalProperties$1,
     type: type$1,
     properties: properties$1,
@@ -1111,7 +1304,8 @@ var webpackInjectManifestOptionsSchema = {
 const optionsSchemas = {
     GetManifest: getManifestOptionsSchema,
     InjectManifest: injectManifestOptionsSchema,
-    WebpackInjectManifest: webpackInjectManifestOptionsSchema
+    WebpackInjectManifest: webpackInjectManifestOptionsSchema,
+    ViteInjectManifest: viteInjectManifestOptionsSchema
 };
 
 const ajv = new Ajv({
@@ -1175,6 +1369,10 @@ function validateWebpackInjectManifestOptions(input) {
     const [validatedOptions] = validate(inputWithExcludeDefault, "WebpackInjectManifest");
     return validatedOptions;
 }
+const validateViteInjectManifestOptions = (input)=>{
+    const [validatedOptions] = validate(input, "ViteInjectManifest");
+    return validatedOptions;
+};
 
 /**
  * This method returns a list of URLs to precache, referred to as a "precache
@@ -1205,7 +1403,7 @@ function validateWebpackInjectManifestOptions(input) {
 */ // Adapted from https://github.com/lydell/source-map-url/blob/master/source-map-url.js
 // See https://github.com/GoogleChrome/workbox/issues/3019
 const innerRegex = /[#@] sourceMappingURL=([^\s'"]*)/;
-const regex = RegExp("(?:" + "/\\*" + "(?:\\s*\r?\n(?://)?)?" + "(?:" + innerRegex.source + ")" + "\\s*" + "\\*/" + "|" + "//(?:" + innerRegex.source + ")" + ")" + "\\s*");
+const regex = RegExp(`(?:/\\*(?:\\s*\r?\n(?://)?)?(?:${innerRegex.source})\\s*\\*/|//(?:${innerRegex.source}))\\s*`);
 function getSourceMapURL(srcContents) {
     const match = srcContents.match(regex);
     return match ? match[1] || match[2] || "" : null;
@@ -1368,7 +1566,7 @@ function translateURLToSourcemapPaths(url, swSrc, swDest) {
         throw new Error(`${errors["injection-point-not-found"]} ${injectionPoint}`);
     }
     assert(injectionResults.length === 1, `${errors["multiple-injection-points"]} ${injectionPoint}`);
-    const manifestString = stringify(manifestEntries);
+    const manifestString = manifestEntries === undefined ? "undefined" : stringify(manifestEntries);
     const filesToWrite = {};
     const url = getSourceMapURL(swFileContents);
     // See https://github.com/GoogleChrome/workbox/issues/2957
@@ -1404,7 +1602,7 @@ function translateURLToSourcemapPaths(url, swSrc, swDest) {
         try {
             await fse.mkdirp(upath.dirname(file));
         } catch (error) {
-            throw new Error(errors["unable-to-make-sw-directory"] + ` '${error instanceof Error && error.message ? error.message : ""}'`);
+            throw new Error(`${errors["unable-to-make-sw-directory"]} '${error instanceof Error && error.message ? error.message : ""}'`);
         }
         await fse.writeFile(file, contents);
     }
@@ -1417,4 +1615,4 @@ function translateURLToSourcemapPaths(url, swSrc, swDest) {
     };
 }
 
-export { errors, escapeRegExp, getManifest, getSourceMapURL, injectManifest, replaceAndUpdateSourceMap, transformManifest, validateWebpackInjectManifestOptions };
+export { errors, escapeRegExp, getFileManifestEntries, getManifest, getSourceMapURL, injectManifest, rebasePath, replaceAndUpdateSourceMap, transformManifest, translateURLToSourcemapPaths, validateInjectManifestOptions, validateViteInjectManifestOptions, validateWebpackInjectManifestOptions };

package/dist/lib/validate-options.d.ts

@@ -1,7 +1,8 @@
-import type { GetManifestOptions, InjectManifestOptions, WebpackInjectManifestOptions } from "../types.js";
+import type { GetManifestOptions, InjectManifestOptions, ViteInjectManifestOptions, WebpackInjectManifestOptions } from "../types.js";
 export declare class SerwistConfigError extends Error {
     constructor(message?: string);
 }
 export declare function validateGetManifestOptions(input: unknown): GetManifestOptions;
 export declare function validateInjectManifestOptions(input: unknown): InjectManifestOptions;
 export declare function validateWebpackInjectManifestOptions(input: unknown): WebpackInjectManifestOptions;
+export declare const validateViteInjectManifestOptions: (input: unknown) => ViteInjectManifestOptions;

package/dist/schema/index.d.ts

@@ -445,4 +445,161 @@ export declare const optionsSchemas: {
         };
         $schema: string;
     };
+    ViteInjectManifest: {
+        additionalProperties: boolean;
+        type: string;
+        properties: {
+            additionalPrecacheEntries: {
+                description: string;
+                type: string;
+                items: {
+                    anyOf: ({
+                        $ref: string;
+                        type?: undefined;
+                    } | {
+                        type: string;
+                        $ref?: undefined;
+                    })[];
+                };
+            };
+            dontCacheBustURLsMatching: {
+                description: string;
+                $ref: string;
+            };
+            manifestTransforms: {
+                description: string;
+                type: string;
+                items: {};
+            };
+            maximumFileSizeToCacheInBytes: {
+                description: string;
+                default: number;
+                type: string;
+            };
+            modifyURLPrefix: {
+                description: string;
+                type: string;
+                additionalProperties: {
+                    type: string;
+                };
+            };
+            globFollow: {
+                description: string;
+                default: boolean;
+                type: string;
+            };
+            globIgnores: {
+                description: string;
+                default: string[];
+                type: string;
+                items: {
+                    type: string;
+                };
+            };
+            globPatterns: {
+                description: string;
+                default: string[];
+                type: string;
+                items: {
+                    type: string;
+                };
+            };
+            globStrict: {
+                description: string;
+                default: boolean;
+                type: string;
+            };
+            templatedURLs: {
+                description: string;
+                type: string;
+                additionalProperties: {
+                    anyOf: ({
+                        type: string;
+                        items: {
+                            type: string;
+                        };
+                    } | {
+                        type: string;
+                        items?: undefined;
+                    })[];
+                };
+            };
+            injectionPoint: {
+                description: string;
+                default: string;
+                type: string;
+            };
+            swSrc: {
+                description: string;
+                type: string;
+            };
+            swDest: {
+                description: string;
+                type: string;
+            };
+            globDirectory: {
+                description: string;
+                type: string;
+            };
+            disablePrecacheManifest: {
+                description: string;
+                default: boolean;
+                type: string;
+            };
+        };
+        required: string[];
+        definitions: {
+            ManifestEntry: {
+                type: string;
+                properties: {
+                    integrity: {
+                        type: string;
+                    };
+                    revision: {
+                        type: string[];
+                    };
+                    url: {
+                        type: string;
+                    };
+                };
+                additionalProperties: boolean;
+                required: string[];
+            };
+            RegExp: {
+                type: string;
+                properties: {
+                    source: {
+                        type: string;
+                    };
+                    global: {
+                        type: string;
+                    };
+                    ignoreCase: {
+                        type: string;
+                    };
+                    multiline: {
+                        type: string;
+                    };
+                    lastIndex: {
+                        type: string;
+                    };
+                    flags: {
+                        type: string;
+                    };
+                    sticky: {
+                        type: string;
+                    };
+                    unicode: {
+                        type: string;
+                    };
+                    dotAll: {
+                        type: string;
+                    };
+                };
+                additionalProperties: boolean;
+                required: string[];
+            };
+        };
+        $schema: string;
+    };
 };

package/dist/types.d.ts

@@ -131,7 +131,8 @@ export interface BasePartial {
      */
     additionalPrecacheEntries?: Array<string | ManifestEntry>;
     /**
-     * Whether the precache manifest should be set to `undefined`.
+     * Whether the precache manifest should be set to `undefined`. Essentially whether `@serwist/build` should
+     * be disabled. Mostly useful when you want it to only check if the provided options are valid.
      * @default false
      */
     disablePrecacheManifest?: boolean;
@@ -198,29 +199,35 @@ export interface GlobPartial {
     /**
      * Determines whether or not symlinks are followed when generating the
      * precache manifest. For more information, see the definition of `follow` in
-     * the `glob` [documentation](https://github.com/isaacs/node-glob#options).
+     * [glob's documentation](https://github.com/isaacs/node-glob#options).
      * @default true
      */
     globFollow?: boolean;
     /**
      * A set of patterns matching files to always exclude when generating the
      * precache manifest. For more information, see the definition of `ignore` in
-     * the `glob` [documentation](https://github.com/isaacs/node-glob#options).
-     * @default ["**\/node_modules\/**\/*"]
+     * [glob's documentation](https://github.com/isaacs/node-glob#options).
+     * @default
+     * ```
+     * ["**\/node_modules\/**\/*"]
+     * ```
      */
     globIgnores?: Array<string>;
     /**
      * Files matching any of these patterns will be included in the precache
-     * manifest. For more information, see the
-     * [`glob` primer](https://github.com/isaacs/node-glob#glob-primer).
-     * @default ["**\/*.{js,css,html}"]
+     * manifest. For more information, see
+     * [glob's Glob Primer](https://github.com/isaacs/node-glob#glob-primer).
+     * @default
+     * ```
+     * ["**\/*.{js,css,html}"]
+     * ```
      */
     globPatterns?: Array<string>;
     /**
      * If true, an error reading a directory when generating a precache manifest
      * will cause the build to fail. If false, the problematic directory will be
-     * skipped. For more information, see the definition of `strict` in the `glob`
-     * [documentation](https://github.com/isaacs/node-glob#options).
+     * skipped. For more information, see the definition of `strict` in
+     * [glob's documentation](https://github.com/isaacs/node-glob#options).
      * @default true
      */
     globStrict?: boolean;
@@ -316,6 +323,7 @@ export interface WebpackInjectManifestPartial {
 export type GetManifestOptions = BasePartial & GlobPartial & RequiredGlobDirectoryPartial;
 export type InjectManifestOptions = BasePartial & GlobPartial & InjectPartial & RequiredSWDestPartial & RequiredGlobDirectoryPartial;
 export type WebpackInjectManifestOptions = BasePartial & WebpackPartial & InjectPartial & WebpackInjectManifestPartial;
+export type ViteInjectManifestOptions = BasePartial & GlobPartial & InjectPartial & RequiredSWDestPartial & RequiredGlobDirectoryPartial;
 export interface GetManifestResult {
     count: number;
     manifestEntries: Array<ManifestEntry> | undefined;
@@ -344,7 +352,7 @@ export type SerwistPackageJSON = PackageJson;
 /**
  * @private
  */
-export type MethodNames = "GetManifest" | "InjectManifest" | "WebpackInjectManifest";
+export type MethodNames = "GetManifest" | "InjectManifest" | "WebpackInjectManifest" | "ViteInjectManifest";
 /**
  * @private
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serwist/build",
-  "version": "8.3.0",
+  "version": "8.4.1",
   "type": "module",
   "description": "A module that integrates into your build process, helping you generate a manifest of local files that should be precached.",
   "files": [
@@ -23,7 +23,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",
@@ -49,31 +49,29 @@
     "glob": "10.3.10",
     "rollup": "4.9.1",
     "source-map": "0.8.0-beta.0",
-    "stringify-object": "5.0.0",
-    "strip-comments": "2.0.1",
     "upath": "2.0.1",
-    "@serwist/background-sync": "8.3.0",
-    "@serwist/broadcast-update": "8.3.0",
-    "@serwist/cacheable-response": "8.3.0",
-    "@serwist/core": "8.3.0",
-    "@serwist/expiration": "8.3.0",
-    "@serwist/google-analytics": "8.3.0",
-    "@serwist/precaching": "8.3.0",
-    "@serwist/routing": "8.3.0"
+    "@serwist/background-sync": "8.4.1",
+    "@serwist/broadcast-update": "8.4.1",
+    "@serwist/cacheable-response": "8.4.1",
+    "@serwist/core": "8.4.1",
+    "@serwist/expiration": "8.4.1",
+    "@serwist/google-analytics": "8.4.1",
+    "@serwist/precaching": "8.4.1",
+    "@serwist/routing": "8.4.1"
   },
   "devDependencies": {
     "@types/common-tags": "1.8.4",
     "@types/fs-extra": "11.0.4",
     "@types/node": "20.10.5",
     "@types/stringify-object": "4.0.5",
-    "@types/strip-comments": "2.0.4",
     "pretty-bytes": "6.1.1",
     "type-fest": "4.8.3",
-    "@serwist/constants": "8.3.0"
+    "@serwist/constants": "8.4.1"
   },
   "scripts": {
     "build": "rimraf dist && cross-env NODE_OPTIONS='--max-old-space-size=4096' 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"
   }
 }

package/dist/lib/stringify-without-comments.d.ts

@@ -1,3 +0,0 @@
-export declare function stringifyWithoutComments(obj: {
-    [key: string]: any;
-}): string;