@serwist/next 9.5.6 → 9.5.8

package/dist/chunks/schema-BhRhcBIb.js

@@ -0,0 +1,22 @@
+import { requiredSwDestPartial } from "@serwist/build/schema";
+import { z } from "zod";
+import { injectManifestOptions } from "@serwist/webpack-plugin/schema";
+//#region src/lib/schema.ts
+const injectPartial = z.strictObject({
+	cacheOnNavigation: z.boolean().default(false),
+	disable: z.boolean().default(false),
+	register: z.boolean().default(true),
+	reloadOnOnline: z.boolean().default(true),
+	scope: z.string().optional(),
+	swUrl: z.string().default("/sw.js"),
+	globPublicPatterns: z.array(z.string()).default(["**/*"])
+});
+const injectManifestOptions$1 = z.strictObject({
+	...injectManifestOptions.shape,
+	...requiredSwDestPartial.shape,
+	...injectPartial.shape
+}).omit({ disablePrecacheManifest: true });
+//#endregion
+export { injectPartial as n, injectManifestOptions$1 as t };
+
+//# sourceMappingURL=schema-BhRhcBIb.js.map

package/dist/chunks/schema-BhRhcBIb.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema-BhRhcBIb.js","names":["injectManifestOptions","webpackInjectManifestOptions"],"sources":["../../src/lib/schema.ts"],"sourcesContent":["import { requiredSwDestPartial } from \"@serwist/build/schema\";\nimport { injectManifestOptions as webpackInjectManifestOptions } from \"@serwist/webpack-plugin/schema\";\nimport { z } from \"zod\";\n\nexport const injectPartial = z.strictObject({\n  cacheOnNavigation: z.boolean().default(false),\n  disable: z.boolean().default(false),\n  register: z.boolean().default(true),\n  reloadOnOnline: z.boolean().default(true),\n  scope: z.string().optional(),\n  swUrl: z.string().default(\"/sw.js\"),\n  globPublicPatterns: z.array(z.string()).default([\"**/*\"]),\n});\n\nexport const injectManifestOptions = z\n  .strictObject({\n    ...webpackInjectManifestOptions.shape,\n    ...requiredSwDestPartial.shape,\n    ...injectPartial.shape,\n  })\n  .omit({ disablePrecacheManifest: true });\n"],"mappings":";;;;AAIA,MAAa,gBAAgB,EAAE,aAAa;CAC1C,mBAAmB,EAAE,SAAS,CAAC,QAAQ,MAAM;CAC7C,SAAS,EAAE,SAAS,CAAC,QAAQ,MAAM;CACnC,UAAU,EAAE,SAAS,CAAC,QAAQ,KAAK;CACnC,gBAAgB,EAAE,SAAS,CAAC,QAAQ,KAAK;CACzC,OAAO,EAAE,QAAQ,CAAC,UAAU;CAC5B,OAAO,EAAE,QAAQ,CAAC,QAAQ,SAAS;CACnC,oBAAoB,EAAE,MAAM,EAAE,QAAQ,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC;CAC1D,CAAC;AAEF,MAAaA,0BAAwB,EAClC,aAAa;CACZ,GAAGC,sBAA6B;CAChC,GAAG,sBAAsB;CACzB,GAAG,cAAc;CAClB,CAAC,CACD,KAAK,EAAE,yBAAyB,MAAM,CAAC"}

package/dist/index.config.d.mts

@@ -0,0 +1,50 @@
+import { Optional } from "@serwist/utils";
+import { BuildOptions } from "@serwist/cli";
+import { NextConfigComplete } from "next/dist/server/config-shared.js";
+
+//#region src/lib/config/types.d.ts
+interface SerwistOptions extends Optional<BuildOptions, "globDirectory"> {
+  /**
+   * Whether Serwist should precache prerendered routes.
+   *
+   * @default true
+   */
+  precachePrerendered?: boolean;
+}
+//#endregion
+//#region src/lib/config/utils.d.ts
+declare const generateGlobPatterns: (distDir: string) => string[];
+//#endregion
+//#region src/index.config.d.ts
+/**
+ * Additional build context.
+ */
+interface SerwistContext {
+  /**
+   * The current working directory.
+   */
+  cwd?: string;
+  /**
+   * Whether Serwist is in development mode. This option determines how Next.js configuration
+   * is resolved. Note that it doesn't change how the service worker is built.
+   */
+  isDev?: boolean;
+}
+interface Serwist {
+  /**
+   * Integrates Serwist into your Next.js app.
+   * @param options
+   * @returns
+   */
+  (options: SerwistOptions, nextConfig?: NextConfigComplete, context?: SerwistContext): Promise<BuildOptions>;
+  /**
+   * Integrates Serwist into your Next.js app. Allows reading fully resolved Next.js configuration.
+   * @param optionsFunction
+   * @returns
+   */
+  withNextConfig: (optionsFunction: (nextConfig: NextConfigComplete) => Promise<SerwistOptions> | SerwistOptions, context?: SerwistContext) => Promise<BuildOptions>;
+}
+declare const serwist: Serwist;
+//#endregion
+export { Serwist, SerwistContext, type SerwistOptions, generateGlobPatterns, serwist };
+//# sourceMappingURL=index.config.d.mts.map

package/dist/index.config.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.config.d.mts","names":[],"sources":["../src/lib/config/types.ts","../src/lib/config/utils.ts","../src/index.config.ts"],"mappings":";;;;;UAGiB,cAAA,SAAuB,QAAA,CAAS,YAAA;;;AAAjD;;;EAME,mBAAA;AAAA;;;cCGW,oBAAA,GAAwB,OAAA;;;;ADTrC;;UEciB,cAAA;EFd+B;;;EEkB9C,GAAA;EFZmB;;;;EEiBnB,KAAA;AAAA;AAAA,UAGe,OAAA;;;;;;GAMd,OAAA,EAAS,cAAA,EAAgB,UAAA,GAAa,kBAAA,EAAoB,OAAA,GAAU,cAAA,GAAiB,OAAA,CAAQ,YAAA;EAlB/E;;;;;EAwBf,cAAA,GACE,eAAA,GAAkB,UAAA,EAAY,kBAAA,KAAuB,OAAA,CAAQ,cAAA,IAAkB,cAAA,EAC/E,OAAA,GAAU,cAAA,KACP,OAAA,CAAQ,YAAA;AAAA;AAAA,cAGF,OAAA,EAAS,OAAA"}

package/dist/index.config.mjs

@@ -0,0 +1,89 @@
+import { createRequire } from "node:module";
+import fs from "node:fs";
+import path from "node:path";
+import { rebasePath } from "@serwist/build";
+import { browserslistToEsbuild } from "@serwist/utils";
+import browserslist from "browserslist";
+import { MODERN_BROWSERSLIST_TARGET, PHASE_DEVELOPMENT_SERVER, PHASE_PRODUCTION_BUILD } from "next/constants.js";
+//#endregion
+//#region src/lib/config/utils.ts
+const nextConfig = (/* @__PURE__ */ createRequire(import.meta.url))("next/dist/server/config.js");
+const loadNextConfig = (cwd, isDev) => {
+	const nextPhase = isDev ? PHASE_DEVELOPMENT_SERVER : PHASE_PRODUCTION_BUILD;
+	return nextConfig.default(nextPhase, cwd, { silent: false });
+};
+const generateGlobPatterns = (distDir) => [`${distDir}static/**/*.{js,css,html,ico,apng,png,avif,jpg,jpeg,jfif,pjpeg,pjp,gif,svg,webp,json,webmanifest}`, "public/**/*"];
+//#endregion
+//#region src/index.config.ts
+const _cwd = process.cwd();
+const _isDev = process.env.NODE_ENV === "development";
+const serwist = async (options, nextConfig, { cwd = _cwd, isDev = _isDev } = {}) => {
+	if (!nextConfig) nextConfig = await loadNextConfig(cwd, isDev);
+	const basePath = nextConfig.basePath || "/";
+	let distDir = nextConfig.distDir;
+	if (distDir[0] === "/") distDir = distDir.slice(1);
+	if (distDir[distDir.length - 1] !== "/") distDir += "/";
+	const distServerDir = `${distDir}server/`;
+	const distAppDir = `${distServerDir}app/`;
+	const distPagesDir = `${distServerDir}pages/`;
+	const { precachePrerendered = true, globDirectory = cwd, ...cliOptions } = options;
+	for (const file of [cliOptions.swDest, `${cliOptions.swDest}.map`]) fs.rmSync(file, { force: true });
+	return {
+		dontCacheBustURLsMatching: new RegExp(`^${distDir}static/`),
+		disablePrecacheManifest: isDev,
+		...cliOptions,
+		globDirectory,
+		globPatterns: [...cliOptions.globPatterns ?? generateGlobPatterns(distDir), ...precachePrerendered ? [`${distServerDir}{app,pages}/**/*.html`] : []],
+		globIgnores: [
+			`${distAppDir}**/_not-found.html`,
+			`${distAppDir}_global-error*`,
+			`${distPagesDir}404.html`,
+			`${distPagesDir}500.html`,
+			...cliOptions.globIgnores ?? [],
+			rebasePath({
+				baseDirectory: globDirectory,
+				file: cliOptions.swSrc
+			}),
+			rebasePath({
+				baseDirectory: globDirectory,
+				file: cliOptions.swDest
+			}),
+			rebasePath({
+				baseDirectory: globDirectory,
+				file: `${cliOptions.swDest}.map`
+			})
+		],
+		manifestTransforms: [...cliOptions.manifestTransforms ?? [], (manifestEntries) => {
+			return {
+				manifest: manifestEntries.map((m) => {
+					if (m.url.startsWith(distAppDir)) m.url = m.url.slice(distAppDir.length - 1);
+					if (m.url.startsWith(distPagesDir)) m.url = m.url.slice(distPagesDir.length - 1);
+					if (m.url.endsWith(".html")) {
+						if (m.url.endsWith("/index.html")) m.url = m.url.slice(0, m.url.lastIndexOf("/") + 1);
+						else m.url = m.url.substring(0, m.url.lastIndexOf("."));
+						m.url = path.posix.join(basePath, m.url);
+					}
+					if (m.url.startsWith(distDir)) m.url = `${nextConfig.assetPrefix ?? ""}/_next/${m.url.slice(distDir.length)}`;
+					if (m.url.startsWith("public/")) m.url = path.posix.join(basePath, m.url.slice(7));
+					return m;
+				}),
+				warnings: []
+			};
+		}],
+		esbuildOptions: {
+			...cliOptions.esbuildOptions,
+			target: cliOptions.esbuildOptions?.target ?? browserslistToEsbuild(browserslist, cwd, MODERN_BROWSERSLIST_TARGET)
+		}
+	};
+};
+serwist.withNextConfig = async (optionsFunction, { cwd = _cwd, isDev = _isDev } = {}) => {
+	const nextConfig = await loadNextConfig(cwd, isDev);
+	return serwist(await optionsFunction(nextConfig), nextConfig, {
+		cwd,
+		isDev
+	});
+};
+//#endregion
+export { generateGlobPatterns, serwist };
+
+//# sourceMappingURL=index.config.mjs.map

package/dist/index.config.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.config.mjs","names":[],"sources":["../src/lib/config/utils.ts","../src/index.config.ts"],"sourcesContent":["import { PHASE_DEVELOPMENT_SERVER, PHASE_PRODUCTION_BUILD } from \"next/constants.js\";\nimport type { NextConfigComplete } from \"next/dist/server/config-shared.js\";\n\nimport nextConfig = require(\"next/dist/server/config.js\");\n\nexport const loadNextConfig = (cwd: string, isDev: boolean): Promise<NextConfigComplete> => {\n  const nextPhase = isDev ? PHASE_DEVELOPMENT_SERVER : PHASE_PRODUCTION_BUILD;\n  return nextConfig.default(nextPhase, cwd, {\n    silent: false,\n  });\n};\n\nexport const generateGlobPatterns = (distDir: string): string[] => [\n  `${distDir}static/**/*.{js,css,html,ico,apng,png,avif,jpg,jpeg,jfif,pjpeg,pjp,gif,svg,webp,json,webmanifest}`,\n  \"public/**/*\",\n];\n","import fs from \"node:fs\";\nimport path from \"node:path\";\nimport { rebasePath } from \"@serwist/build\";\nimport type { BuildOptions } from \"@serwist/cli\";\nimport { browserslistToEsbuild } from \"@serwist/utils\";\nimport browserslist from \"browserslist\";\nimport { MODERN_BROWSERSLIST_TARGET } from \"next/constants.js\";\nimport type { NextConfigComplete } from \"next/dist/server/config-shared.js\";\nimport type { SerwistOptions } from \"./lib/config/types.js\";\nimport { generateGlobPatterns, loadNextConfig } from \"./lib/config/utils.js\";\n\nconst _cwd = process.cwd();\nconst _isDev = process.env.NODE_ENV === \"development\";\n\n/**\n * Additional build context.\n */\nexport interface SerwistContext {\n  /**\n   * The current working directory.\n   */\n  cwd?: string;\n  /**\n   * Whether Serwist is in development mode. This option determines how Next.js configuration\n   * is resolved. Note that it doesn't change how the service worker is built.\n   */\n  isDev?: boolean;\n}\n\nexport interface Serwist {\n  /**\n   * Integrates Serwist into your Next.js app.\n   * @param options\n   * @returns\n   */\n  (options: SerwistOptions, nextConfig?: NextConfigComplete, context?: SerwistContext): Promise<BuildOptions>;\n  /**\n   * Integrates Serwist into your Next.js app. Allows reading fully resolved Next.js configuration.\n   * @param optionsFunction\n   * @returns\n   */\n  withNextConfig: (\n    optionsFunction: (nextConfig: NextConfigComplete) => Promise<SerwistOptions> | SerwistOptions,\n    context?: SerwistContext,\n  ) => Promise<BuildOptions>;\n}\n\nexport const serwist: Serwist = async (options, nextConfig, { cwd = _cwd, isDev = _isDev } = {}) => {\n  if (!nextConfig) nextConfig = await loadNextConfig(cwd, isDev);\n  const basePath = nextConfig.basePath || \"/\";\n  let distDir = nextConfig.distDir;\n  if (distDir[0] === \"/\") distDir = distDir.slice(1);\n  if (distDir[distDir.length - 1] !== \"/\") distDir += \"/\";\n  const distServerDir = `${distDir}server/`;\n  const distAppDir = `${distServerDir}app/`;\n  const distPagesDir = `${distServerDir}pages/`;\n  const { precachePrerendered = true, globDirectory = cwd, ...cliOptions } = options;\n  for (const file of [cliOptions.swDest, `${cliOptions.swDest}.map`]) {\n    fs.rmSync(file, { force: true });\n  }\n  return {\n    dontCacheBustURLsMatching: new RegExp(`^${distDir}static/`),\n    disablePrecacheManifest: isDev,\n    ...cliOptions,\n    globDirectory,\n    globPatterns: [\n      ...(cliOptions.globPatterns ?? generateGlobPatterns(distDir)),\n      ...(precachePrerendered ? [`${distServerDir}{app,pages}/**/*.html`] : []),\n    ],\n    globIgnores: [\n      `${distAppDir}**/_not-found.html`,\n      `${distAppDir}_global-error*`,\n      `${distPagesDir}404.html`,\n      `${distPagesDir}500.html`,\n      ...(cliOptions.globIgnores ?? []),\n      rebasePath({ baseDirectory: globDirectory, file: cliOptions.swSrc }),\n      rebasePath({ baseDirectory: globDirectory, file: cliOptions.swDest }),\n      rebasePath({ baseDirectory: globDirectory, file: `${cliOptions.swDest}.map` }),\n    ],\n    manifestTransforms: [\n      ...(cliOptions.manifestTransforms ?? []),\n      (manifestEntries) => {\n        const manifest = manifestEntries.map((m) => {\n          if (m.url.startsWith(distAppDir)) {\n            // Keep the prefixing slash.\n            m.url = m.url.slice(distAppDir.length - 1);\n          }\n          if (m.url.startsWith(distPagesDir)) {\n            // Keep the prefixing slash.\n            m.url = m.url.slice(distPagesDir.length - 1);\n          }\n          if (m.url.endsWith(\".html\")) {\n            // trailingSlash: true && output: 'export'\n            // or root index.html.\n            // https://nextjs.org/docs/app/api-reference/config/next-config-js/trailingSlash\n            // \"/abc/index.html\" -> \"/abc/\"\n            // \"/index.html\" -> \"/\"\n            if (m.url.endsWith(\"/index.html\")) {\n              m.url = m.url.slice(0, m.url.lastIndexOf(\"/\") + 1);\n            }\n            // \"/xxx.html\" -> \"/xxx\"\n            else {\n              m.url = m.url.substring(0, m.url.lastIndexOf(\".\"));\n            }\n            m.url = path.posix.join(basePath, m.url);\n          }\n          // Replace all references to \"$(distDir)\" with \"$(assetPrefix)/_next/\".\n          if (m.url.startsWith(distDir)) {\n            m.url = `${nextConfig.assetPrefix ?? \"\"}/_next/${m.url.slice(distDir.length)}`;\n          }\n          // Replace all references to public/ with \"$(basePath)/\".\n          if (m.url.startsWith(\"public/\")) {\n            m.url = path.posix.join(basePath, m.url.slice(7));\n          }\n          return m;\n        });\n        return { manifest, warnings: [] };\n      },\n    ],\n    esbuildOptions: {\n      ...cliOptions.esbuildOptions,\n      target: cliOptions.esbuildOptions?.target ?? browserslistToEsbuild(browserslist, cwd, MODERN_BROWSERSLIST_TARGET),\n    },\n  };\n};\n\nserwist.withNextConfig = async (optionsFunction, { cwd = _cwd, isDev = _isDev } = {}) => {\n  const nextConfig = await loadNextConfig(cwd, isDev);\n  return serwist(await optionsFunction(nextConfig), nextConfig, { cwd, isDev });\n};\n\nexport { generateGlobPatterns };\n\nexport type { SerwistOptions };\n"],"mappings":";;;;;;;;;MAGO,cAAA,8CAAA,EAAqB,6BAAA;AAE5B,MAAa,kBAAkB,KAAa,UAAgD;CAC1F,MAAM,YAAY,QAAQ,2BAA2B;AACrD,QAAO,WAAW,QAAQ,WAAW,KAAK,EACxC,QAAQ,OACT,CAAC;;AAGJ,MAAa,wBAAwB,YAA8B,CACjE,GAAG,QAAQ,oGACX,cACD;;;ACJD,MAAM,OAAO,QAAQ,KAAK;AAC1B,MAAM,SAAS,QAAQ,IAAI,aAAa;AAmCxC,MAAa,UAAmB,OAAO,SAAS,YAAY,EAAE,MAAM,MAAM,QAAQ,WAAW,EAAE,KAAK;AAClG,KAAI,CAAC,WAAY,cAAa,MAAM,eAAe,KAAK,MAAM;CAC9D,MAAM,WAAW,WAAW,YAAY;CACxC,IAAI,UAAU,WAAW;AACzB,KAAI,QAAQ,OAAO,IAAK,WAAU,QAAQ,MAAM,EAAE;AAClD,KAAI,QAAQ,QAAQ,SAAS,OAAO,IAAK,YAAW;CACpD,MAAM,gBAAgB,GAAG,QAAQ;CACjC,MAAM,aAAa,GAAG,cAAc;CACpC,MAAM,eAAe,GAAG,cAAc;CACtC,MAAM,EAAE,sBAAsB,MAAM,gBAAgB,KAAK,GAAG,eAAe;AAC3E,MAAK,MAAM,QAAQ,CAAC,WAAW,QAAQ,GAAG,WAAW,OAAO,MAAM,CAChE,IAAG,OAAO,MAAM,EAAE,OAAO,MAAM,CAAC;AAElC,QAAO;EACL,2BAA2B,IAAI,OAAO,IAAI,QAAQ,SAAS;EAC3D,yBAAyB;EACzB,GAAG;EACH;EACA,cAAc,CACZ,GAAI,WAAW,gBAAgB,qBAAqB,QAAQ,EAC5D,GAAI,sBAAsB,CAAC,GAAG,cAAc,uBAAuB,GAAG,EAAE,CACzE;EACD,aAAa;GACX,GAAG,WAAW;GACd,GAAG,WAAW;GACd,GAAG,aAAa;GAChB,GAAG,aAAa;GAChB,GAAI,WAAW,eAAe,EAAE;GAChC,WAAW;IAAE,eAAe;IAAe,MAAM,WAAW;IAAO,CAAC;GACpE,WAAW;IAAE,eAAe;IAAe,MAAM,WAAW;IAAQ,CAAC;GACrE,WAAW;IAAE,eAAe;IAAe,MAAM,GAAG,WAAW,OAAO;IAAO,CAAC;GAC/E;EACD,oBAAoB,CAClB,GAAI,WAAW,sBAAsB,EAAE,GACtC,oBAAoB;AAmCnB,UAAO;IAAE,UAlCQ,gBAAgB,KAAK,MAAM;AAC1C,SAAI,EAAE,IAAI,WAAW,WAAW,CAE9B,GAAE,MAAM,EAAE,IAAI,MAAM,WAAW,SAAS,EAAE;AAE5C,SAAI,EAAE,IAAI,WAAW,aAAa,CAEhC,GAAE,MAAM,EAAE,IAAI,MAAM,aAAa,SAAS,EAAE;AAE9C,SAAI,EAAE,IAAI,SAAS,QAAQ,EAAE;AAM3B,UAAI,EAAE,IAAI,SAAS,cAAc,CAC/B,GAAE,MAAM,EAAE,IAAI,MAAM,GAAG,EAAE,IAAI,YAAY,IAAI,GAAG,EAAE;UAIlD,GAAE,MAAM,EAAE,IAAI,UAAU,GAAG,EAAE,IAAI,YAAY,IAAI,CAAC;AAEpD,QAAE,MAAM,KAAK,MAAM,KAAK,UAAU,EAAE,IAAI;;AAG1C,SAAI,EAAE,IAAI,WAAW,QAAQ,CAC3B,GAAE,MAAM,GAAG,WAAW,eAAe,GAAG,SAAS,EAAE,IAAI,MAAM,QAAQ,OAAO;AAG9E,SAAI,EAAE,IAAI,WAAW,UAAU,CAC7B,GAAE,MAAM,KAAK,MAAM,KAAK,UAAU,EAAE,IAAI,MAAM,EAAE,CAAC;AAEnD,YAAO;MAEQ;IAAE,UAAU,EAAE;IAAE;IAEpC;EACD,gBAAgB;GACd,GAAG,WAAW;GACd,QAAQ,WAAW,gBAAgB,UAAU,sBAAsB,cAAc,KAAK,2BAA2B;GAClH;EACF;;AAGH,QAAQ,iBAAiB,OAAO,iBAAiB,EAAE,MAAM,MAAM,QAAQ,WAAW,EAAE,KAAK;CACvF,MAAM,aAAa,MAAM,eAAe,KAAK,MAAM;AACnD,QAAO,QAAQ,MAAM,gBAAgB,WAAW,EAAE,YAAY;EAAE;EAAK;EAAO,CAAC"}

package/dist/index.d.mts

@@ -0,0 +1,111 @@
+import { InjectManifestOptions as InjectManifestOptions$1, InjectManifestOptionsComplete as InjectManifestOptionsComplete$1 } from "@serwist/webpack-plugin";
+import { RequiredSwDestPartial, RequiredSwDestResolved } from "@serwist/build";
+import { Require } from "@serwist/utils";
+import { NextConfig } from "next";
+
+//#region src/lib/types.d.ts
+interface InjectPartial {
+  /**
+   * Enables additional route caching when users navigate through pages with
+   * `next/link`. This improves the user experience in some cases but it
+   * also adds a bit of overhead due to additional network calls.
+   * @default false
+   */
+  cacheOnNavigation?: boolean;
+  /**
+   * Whether Serwist should be disabled.
+   * @default false
+   */
+  disable?: boolean;
+  /**
+   * Whether `@serwist/next` should automatically register the service worker for you. If
+   * you want to register the service worker yourself, set this to `false` and run
+   * `window.serwist.register()` in `componentDidMount` or `useEffect`.
+   * @example
+   *   ```tsx
+   *   // app/register-pwa.tsx
+   *   "use client";
+   *   import { useEffect } from "react";
+   *   import type { Serwist } from "@serwist/window";
+   *
+   *   declare global {
+   *     interface Window {
+   *       serwist: Serwist;
+   *     }
+   *   }
+   *
+   *   export default function RegisterPWA() {
+   *     useEffect(() => {
+   *       if ("serviceWorker" in navigator && window.serwist !== undefined) {
+   *         window.serwist.register();
+   *       }
+   *     }, []);
+   *     return <></>;
+   *   }
+   *
+   *   // app/layout.tsx
+   *   import RegisterPWA from "./register-pwa";
+   *
+   *   export default function RootLayout({
+   *     children,
+   *   }: {
+   *     children: React.ReactNode;
+   *   }) {
+   *     return (
+   *       <html lang="en">
+   *         <head />
+   *         <body>
+   *           <RegisterPWA />
+   *           {children}
+   *         </body>
+   *       </html>
+   *     );
+   *   }
+   *   ```
+   * @default true
+   */
+  register?: boolean;
+  /**
+   * Whether Serwist should reload the app when it goes online.
+   * @default true
+   */
+  reloadOnOnline?: boolean;
+  /**
+   * The service worker's URL scope. Set to `/foo/` so that paths under `/foo/` are under the service
+   * worker's control while others are not.
+   * @default nextConfig.basePath
+   */
+  scope?: string;
+  /**
+   * The URL to the service worker.
+   * @default "/sw.js"
+   */
+  swUrl?: string;
+  /**
+   * Files in the public directory matching any of these patterns
+   * will be included in the precache manifest. For more information,
+   * see [`node-glob`'s Glob Primer](https://github.com/isaacs/node-glob#glob-primer).
+   * @default
+   * ```
+   * ["**\/*"]
+   * ```
+   */
+  globPublicPatterns?: string[];
+}
+type InjectResolved = Require<InjectPartial, "cacheOnNavigation" | "disable" | "register" | "reloadOnOnline" | "swUrl" | "globPublicPatterns">;
+type InjectManifestOptions = Omit<InjectManifestOptions$1 & RequiredSwDestPartial & InjectPartial, "disablePrecacheManifest">;
+type InjectManifestOptionsComplete = Omit<InjectManifestOptionsComplete$1 & RequiredSwDestResolved & InjectResolved, "disablePrecacheManifest">;
+//#endregion
+//#region src/lib/validator.d.ts
+declare const validateInjectManifestOptions: (input: unknown) => InjectManifestOptionsComplete;
+//#endregion
+//#region src/index.d.ts
+/**
+ * Integrates Serwist into your Next.js app.
+ * @param userOptions
+ * @returns
+ */
+declare const withSerwistInit: (userOptions: InjectManifestOptions) => ((nextConfig?: NextConfig) => NextConfig);
+//#endregion
+export { type InjectManifestOptions as PluginOptions, type InjectManifestOptionsComplete as PluginOptionsComplete, withSerwistInit as default, validateInjectManifestOptions };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/lib/types.ts","../src/lib/validator.ts","../src/index.ts"],"mappings":";;;;;;UAOiB,aAAA;;;AAAjB;;;;EAOE,iBAAA;EAKA;;;;EAAA,OAAA;EA0EA;;;AAGF;;;;;AAEA;;;;;;;;;;;;;;;AAEA;;;;;;;;;;;;;;;;;;AC/FA;;;;;;ED8DE,QAAA;;AExDiE;;;EF6DjE,cAAA;EEpD2E;;;;;EF0D3E,KAAA;EE1D2E;;;;EF+D3E,KAAA;;;;;;;;;;EAUA,kBAAA;AAAA;AAAA,KAGU,cAAA,GAAiB,OAAA,CAAQ,aAAA;AAAA,KAEzB,qBAAA,GAAwB,IAAA,CAAK,uBAAA,GAA+B,qBAAA,GAAwB,aAAA;AAAA,KAEpF,6BAAA,GAAgC,IAAA,CAC1C,+BAAA,GAAuC,sBAAA,GAAyB,cAAA;;;cChGrD,6BAAA,GAAiC,KAAA,cAAiB,6BAAA;;;;;;ADE/D;;cEaM,eAAA,GAAmB,WAAA,EAAa,qBAAA,OAA0B,UAAA,GAAa,UAAA,KAAe,UAAA"}

package/dist/index.mjs

@@ -0,0 +1,242 @@
+import { t as injectManifestOptions } from "./chunks/schema-BhRhcBIb.js";
+import { createRequire } from "node:module";
+import fs from "node:fs";
+import path from "node:path";
+import { fileURLToPath } from "node:url";
+import { InjectManifest } from "@serwist/webpack-plugin";
+import { ChildCompilationPlugin, relativeToOutputPath } from "@serwist/webpack-plugin/internal";
+import { globSync } from "glob";
+import crypto from "node:crypto";
+import { bold, green, red, white, yellow } from "kolorist";
+import semver from "semver";
+import { SerwistConfigError, validationErrorMap } from "@serwist/build/schema";
+import { z } from "zod";
+//#region src/lib/find-first-truthy.ts
+/**
+* Find the first truthy value in an array.
+* @param arr
+* @param fn
+* @returns
+*/
+const findFirstTruthy = (arr, fn) => {
+	for (const i of arr) {
+		const resolved = fn(i);
+		if (resolved) return resolved;
+	}
+};
+//#endregion
+//#region src/lib/get-file-hash.ts
+const getFileHash = (file) => crypto.createHash("md5").update(fs.readFileSync(file)).digest("hex");
+//#endregion
+//#region src/lib/get-content-hash.ts
+const getContentHash = (file, isDev) => {
+	if (isDev) return "development";
+	return getFileHash(file).slice(0, 16);
+};
+createRequire(import.meta.url);
+//#endregion
+//#region src/lib/load-tsconfig.ts
+const loadTSConfig = (baseDir, relativeTSConfigPath) => {
+	try {
+		const tsConfigPath = findFirstTruthy([relativeTSConfigPath ?? "tsconfig.json", "jsconfig.json"], (filePath) => {
+			const resolvedPath = path.join(baseDir, filePath);
+			return fs.existsSync(resolvedPath) ? resolvedPath : void 0;
+		});
+		if (!tsConfigPath) return;
+		return JSON.parse(fs.readFileSync(tsConfigPath, "utf-8"));
+	} catch {
+		return;
+	}
+};
+//#endregion
+//#region src/lib/logger.ts
+const require = createRequire(import.meta.url);
+const LOGGING_SPACE_PREFIX = semver.gte(require("next/package.json").version, "16.0.0") ? "" : " ";
+const prefixedLog = (prefixType, ...message) => {
+	let prefix;
+	let consoleMethod;
+	switch (prefixType) {
+		case "wait":
+			prefix = `${white(bold("○"))} (serwist)`;
+			consoleMethod = "log";
+			break;
+		case "error":
+			prefix = `${red(bold("X"))} (serwist)`;
+			consoleMethod = "error";
+			break;
+		case "warn":
+			prefix = `${yellow(bold("⚠"))} (serwist)`;
+			consoleMethod = "warn";
+			break;
+		case "info":
+			prefix = `${white(bold("○"))} (serwist)`;
+			consoleMethod = "log";
+			break;
+		case "event":
+			prefix = `${green(bold("✓"))} (serwist)`;
+			consoleMethod = "log";
+			break;
+	}
+	if ((message[0] === "" || message[0] === void 0) && message.length === 1) message.shift();
+	if (message.length === 0) console[consoleMethod]("");
+	else console[consoleMethod](`${LOGGING_SPACE_PREFIX}${prefix}`, ...message);
+};
+const info = (...message) => prefixedLog("info", ...message);
+const event = (...message) => prefixedLog("event", ...message);
+//#endregion
+//#region src/lib/validator.ts
+const validateInjectManifestOptions = (input) => {
+	const result = injectManifestOptions.safeParse(input, { error: validationErrorMap });
+	if (!result.success) throw new SerwistConfigError({
+		moduleName: "@serwist/next",
+		message: z.prettifyError(result.error)
+	});
+	return result.data;
+};
+//#endregion
+//#region src/index.ts
+const dirname = "__dirname" in globalThis ? __dirname : fileURLToPath(new URL(".", import.meta.url));
+/**
+* Integrates Serwist into your Next.js app.
+* @param userOptions
+* @returns
+*/
+const withSerwistInit = (userOptions) => {
+	if (!process.env.SERWIST_SUPPRESS_TURBOPACK_WARNING && process.env.TURBOPACK && !userOptions.disable) {
+		process.env.SERWIST_SUPPRESS_TURBOPACK_WARNING = "1";
+		console.warn(`[@serwist/next] WARNING: You are using '@serwist/next' with \`next dev --turbopack\`, but it doesn't support Turbopack. Do one of the following:
+
+- Set \`disable\` to \`process.env.NODE_ENV !== "production"\`.
+
+- Use webpack by running \`next dev --webpack\` instead of \`next dev --turbopack\`.
+
+- Migrate to '@serwist/turbopack' which has experimental support for Turbopack. See https://serwist.pages.dev/docs/next/turbo for more information.
+
+- Migrate to configurator mode which has support for Turbopack. See https://serwist.pages.dev/docs/next/config for more information. 
+
+Follow https://github.com/serwist/serwist/issues/54 for progress on Serwist + Turbopack. You can also suppress this warning by setting SERWIST_SUPPRESS_TURBOPACK_WARNING=1.\n`);
+	}
+	return (nextConfig = {}) => ({
+		...nextConfig,
+		webpack(config, options) {
+			const webpack = options.webpack;
+			const { dev } = options;
+			const basePath = options.config.basePath || "/";
+			const tsConfigJson = loadTSConfig(options.dir, nextConfig?.typescript?.tsconfigPath);
+			const { cacheOnNavigation, disable, scope = basePath, swUrl, register, reloadOnOnline, globPublicPatterns, ...buildOptions } = validateInjectManifestOptions(userOptions);
+			if (typeof nextConfig.webpack === "function") config = nextConfig.webpack(config, options);
+			if (disable) {
+				options.isServer && info("Serwist is disabled.");
+				return config;
+			}
+			if (!config.plugins) config.plugins = [];
+			const _sw = path.posix.join(basePath, swUrl);
+			const _scope = path.posix.join(scope, "/");
+			config.plugins.push(new webpack.DefinePlugin({
+				"self.__SERWIST_SW_ENTRY.sw": `'${_sw}'`,
+				"self.__SERWIST_SW_ENTRY.scope": `'${_scope}'`,
+				"self.__SERWIST_SW_ENTRY.cacheOnNavigation": `${cacheOnNavigation}`,
+				"self.__SERWIST_SW_ENTRY.register": `${register}`,
+				"self.__SERWIST_SW_ENTRY.reloadOnOnline": `${reloadOnOnline}`
+			}));
+			const swEntryJs = path.join(dirname, "sw-entry.mjs");
+			const entry = config.entry;
+			config.entry = async () => {
+				const entries = await entry();
+				if (entries["main.js"] && !entries["main.js"].includes(swEntryJs)) {
+					if (Array.isArray(entries["main.js"])) entries["main.js"].unshift(swEntryJs);
+					else if (typeof entries["main.js"] === "string") entries["main.js"] = [swEntryJs, entries["main.js"]];
+				}
+				if (entries["main-app"] && !entries["main-app"].includes(swEntryJs)) {
+					if (Array.isArray(entries["main-app"])) entries["main-app"].unshift(swEntryJs);
+					else if (typeof entries["main-app"] === "string") entries["main-app"] = [swEntryJs, entries["main-app"]];
+				}
+				return entries;
+			};
+			if (!options.isServer) {
+				if (!register) {
+					info("The service worker will not be automatically registered, please call 'window.serwist.register()' in 'componentDidMount' or 'useEffect'.");
+					if (!tsConfigJson?.compilerOptions?.types?.includes("@serwist/next/typings")) info("You may also want to add '@serwist/next/typings' to your TypeScript/JavaScript configuration file at 'compilerOptions.types'.");
+				}
+				const { swSrc: userSwSrc, swDest: userSwDest, additionalPrecacheEntries, exclude, manifestTransforms = [], ...otherBuildOptions } = buildOptions;
+				let swSrc = userSwSrc;
+				let swDest = userSwDest;
+				if (!path.isAbsolute(swSrc)) swSrc = path.join(options.dir, swSrc);
+				if (!path.isAbsolute(swDest)) swDest = path.join(options.dir, swDest);
+				const publicDir = path.resolve(options.dir, "public");
+				const { dir: destDir, base: destBase } = path.parse(swDest);
+				const cleanUpList = globSync([
+					"swe-worker-*.js",
+					"swe-worker-*.js.map",
+					destBase,
+					`${destBase}.map`
+				], {
+					absolute: true,
+					nodir: true,
+					follow: true,
+					cwd: destDir
+				});
+				for (const file of cleanUpList) fs.rmSync(file, { force: true });
+				const shouldBuildSWEntryWorker = cacheOnNavigation;
+				let swEntryPublicPath;
+				let swEntryWorkerDest;
+				if (shouldBuildSWEntryWorker) {
+					const swEntryWorkerSrc = path.join(dirname, "sw-entry-worker.mjs");
+					const swEntryName = `swe-worker-${getContentHash(swEntryWorkerSrc, dev)}.js`;
+					swEntryPublicPath = path.posix.join(basePath, swEntryName);
+					swEntryWorkerDest = path.join(destDir, swEntryName);
+					config.plugins.push(new ChildCompilationPlugin({
+						src: swEntryWorkerSrc,
+						dest: swEntryWorkerDest
+					}));
+				}
+				config.plugins.push(new webpack.DefinePlugin({ "self.__SERWIST_SW_ENTRY.swEntryWorker": swEntryPublicPath && `'${swEntryPublicPath}'` }));
+				event(`Bundling the service worker script with the URL '${_sw}' and the scope '${_scope}'...`);
+				let resolvedManifestEntries = additionalPrecacheEntries;
+				if (!resolvedManifestEntries) resolvedManifestEntries = globSync(globPublicPatterns, {
+					nodir: true,
+					follow: true,
+					cwd: publicDir,
+					ignore: [
+						"swe-worker-*.js",
+						destBase,
+						`${destBase}.map`
+					]
+				}).map((f) => ({
+					url: path.posix.join(basePath, f),
+					revision: getFileHash(path.join(publicDir, f))
+				}));
+				const publicPath = config.output?.publicPath;
+				config.plugins.push(new InjectManifest({
+					swSrc,
+					swDest,
+					disablePrecacheManifest: dev,
+					additionalPrecacheEntries: dev ? [] : resolvedManifestEntries,
+					exclude: [...exclude, ({ asset, compilation }) => {
+						const swDestRelativeOutput = relativeToOutputPath(compilation, swDest);
+						const swAsset = compilation.getAsset(swDestRelativeOutput);
+						return asset.name === swAsset?.name || asset.name.startsWith("server/") || /^[^/]*\.json$/.test(asset.name) || dev && !asset.name.startsWith("static/runtime/");
+					}],
+					manifestTransforms: [...manifestTransforms, async (manifestEntries, compilation) => {
+						const publicFilesPrefix = `${publicPath}${relativeToOutputPath(compilation, publicDir)}`;
+						return {
+							manifest: manifestEntries.map((m) => {
+								m.url = m.url.replace("/_next//static/image", "/_next/static/image").replace("/_next//static/media", "/_next/static/media");
+								if (m.url.startsWith(publicFilesPrefix)) m.url = path.posix.join(basePath, m.url.replace(publicFilesPrefix, ""));
+								m.url = m.url.replace(/\[/g, "%5B").replace(/\]/g, "%5D").replace(/@/g, "%40");
+								return m;
+							}),
+							warnings: []
+						};
+					}],
+					...otherBuildOptions
+				}));
+			}
+			return config;
+		}
+	});
+};
+//#endregion
+export { withSerwistInit as default, validateInjectManifestOptions };
+
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":["require","logger.info"],"sources":["../src/lib/find-first-truthy.ts","../src/lib/get-file-hash.ts","../src/lib/get-content-hash.ts","../src/lib/get-package-version.ts","../src/lib/load-tsconfig.ts","../src/lib/logger.ts","../src/lib/validator.ts","../src/index.ts"],"sourcesContent":["/**\n * Find the first truthy value in an array.\n * @param arr\n * @param fn\n * @returns\n */\nexport const findFirstTruthy = <T, U>(arr: T[], fn: (elm: T) => U) => {\n  for (const i of arr) {\n    const resolved = fn(i);\n    if (resolved) {\n      return resolved;\n    }\n  }\n  return undefined;\n};\n","import crypto from \"node:crypto\";\nimport fs from \"node:fs\";\n\nexport const getFileHash = (file: fs.PathOrFileDescriptor) => crypto.createHash(\"md5\").update(fs.readFileSync(file)).digest(\"hex\");\n","import type fs from \"node:fs\";\n\nimport { getFileHash } from \"./get-file-hash.js\";\n\nexport const getContentHash = (file: fs.PathOrFileDescriptor, isDev: boolean) => {\n  if (isDev) {\n    return \"development\";\n  }\n  return getFileHash(file).slice(0, 16);\n};\n","import { createRequire } from \"node:module\";\n\nconst require = createRequire(import.meta.url);\n\n/**\n * Get a package's version\n * @param packageName\n * @returns\n */\nexport const getPackageVersion = (packageName: string): string | undefined => {\n  try {\n    return require(`${packageName}/package.json`).version;\n  } catch {\n    return undefined;\n  }\n};\n","import fs from \"node:fs\";\nimport path from \"node:path\";\n\nimport type { TsConfigJson as TSConfigJSON } from \"type-fest\";\n\nimport { findFirstTruthy } from \"./find-first-truthy.js\";\n\nexport const loadTSConfig = (baseDir: string, relativeTSConfigPath: string | undefined): TSConfigJSON | undefined => {\n  try {\n    // Find tsconfig.json file\n    const tsConfigPath = findFirstTruthy([relativeTSConfigPath ?? \"tsconfig.json\", \"jsconfig.json\"], (filePath) => {\n      const resolvedPath = path.join(baseDir, filePath);\n      return fs.existsSync(resolvedPath) ? resolvedPath : undefined;\n    });\n    if (!tsConfigPath) {\n      return undefined;\n    }\n    // Read tsconfig.json file\n    return JSON.parse(fs.readFileSync(tsConfigPath, \"utf-8\"));\n  } catch {\n    return undefined;\n  }\n};\n","import { createRequire } from \"node:module\";\nimport { bold, green, red, white, yellow } from \"kolorist\";\nimport semver from \"semver\";\n\nconst require = createRequire(import.meta.url);\n\nconst LOGGING_SPACE_PREFIX = semver.gte(require(\"next/package.json\").version, \"16.0.0\") ? \"\" : \" \";\n\nexport type LoggingMethods = \"wait\" | \"error\" | \"warn\" | \"info\" | \"event\";\n\nconst prefixedLog = (prefixType: LoggingMethods, ...message: any[]) => {\n  let prefix: string;\n  let consoleMethod: keyof Console;\n\n  switch (prefixType) {\n    case \"wait\":\n      prefix = `${white(bold(\"○\"))} (serwist)`;\n      consoleMethod = \"log\";\n      break;\n    case \"error\":\n      prefix = `${red(bold(\"X\"))} (serwist)`;\n      consoleMethod = \"error\";\n      break;\n    case \"warn\":\n      prefix = `${yellow(bold(\"⚠\"))} (serwist)`;\n      consoleMethod = \"warn\";\n      break;\n    case \"info\":\n      prefix = `${white(bold(\"○\"))} (serwist)`;\n      consoleMethod = \"log\";\n      break;\n    case \"event\":\n      prefix = `${green(bold(\"✓\"))} (serwist)`;\n      consoleMethod = \"log\";\n      break;\n  }\n\n  if ((message[0] === \"\" || message[0] === undefined) && message.length === 1) {\n    message.shift();\n  }\n\n  // If there's no message, don't print the prefix but a new line\n  if (message.length === 0) {\n    console[consoleMethod](\"\");\n  } else {\n    console[consoleMethod](`${LOGGING_SPACE_PREFIX}${prefix}`, ...message);\n  }\n};\n\nexport const wait = (...message: any[]) => prefixedLog(\"wait\", ...message);\n\nexport const error = (...message: any[]) => prefixedLog(\"error\", ...message);\n\nexport const warn = (...message: any[]) => prefixedLog(\"warn\", ...message);\n\nexport const info = (...message: any[]) => prefixedLog(\"info\", ...message);\n\nexport const event = (...message: any[]) => prefixedLog(\"event\", ...message);\n","import { SerwistConfigError, validationErrorMap } from \"@serwist/build/schema\";\nimport { z } from \"zod\";\nimport { injectManifestOptions } from \"./schema.js\";\nimport type { InjectManifestOptionsComplete } from \"./types.js\";\n\nexport const validateInjectManifestOptions = (input: unknown): InjectManifestOptionsComplete => {\n  const result = injectManifestOptions.safeParse(input, {\n    error: validationErrorMap,\n  });\n  if (!result.success) {\n    throw new SerwistConfigError({ moduleName: \"@serwist/next\", message: z.prettifyError(result.error) });\n  }\n  return result.data;\n};\n","import fs from \"node:fs\";\nimport path from \"node:path\";\nimport { fileURLToPath } from \"node:url\";\nimport { InjectManifest } from \"@serwist/webpack-plugin\";\nimport { ChildCompilationPlugin, relativeToOutputPath } from \"@serwist/webpack-plugin/internal\";\nimport { globSync } from \"glob\";\nimport type { NextConfig } from \"next\";\nimport type { Compilation, Configuration, default as Webpack } from \"webpack\";\nimport type { ExcludeParams, SerwistNextOptions, SerwistNextOptionsKey } from \"./internal-types.js\";\nimport { getContentHash, getFileHash, loadTSConfig, logger } from \"./lib/index.js\";\nimport type { InjectManifestOptions, InjectManifestOptionsComplete } from \"./lib/types.js\";\nimport { validateInjectManifestOptions } from \"./lib/validator.js\";\n\nconst dirname = \"__dirname\" in globalThis ? __dirname : fileURLToPath(new URL(\".\", import.meta.url));\n\n/**\n * Integrates Serwist into your Next.js app.\n * @param userOptions\n * @returns\n */\nconst withSerwistInit = (userOptions: InjectManifestOptions): ((nextConfig?: NextConfig) => NextConfig) => {\n  if (!process.env.SERWIST_SUPPRESS_TURBOPACK_WARNING && process.env.TURBOPACK && !userOptions.disable) {\n    process.env.SERWIST_SUPPRESS_TURBOPACK_WARNING = \"1\";\n    console.warn(\n      `[@serwist/next] WARNING: You are using '@serwist/next' with \\`next dev --turbopack\\`, but it doesn't support Turbopack. Do one of the following:\n\n- Set \\`disable\\` to \\`process.env.NODE_ENV !== \"production\"\\`.\n\n- Use webpack by running \\`next dev --webpack\\` instead of \\`next dev --turbopack\\`.\n\n- Migrate to '@serwist/turbopack' which has experimental support for Turbopack. See https://serwist.pages.dev/docs/next/turbo for more information.\n\n- Migrate to configurator mode which has support for Turbopack. See https://serwist.pages.dev/docs/next/config for more information. \n\nFollow https://github.com/serwist/serwist/issues/54 for progress on Serwist + Turbopack. You can also suppress this warning by setting SERWIST_SUPPRESS_TURBOPACK_WARNING=1.\\n`,\n    );\n  }\n  return (nextConfig = {}) => ({\n    ...nextConfig,\n    webpack(config: Configuration, options) {\n      const webpack: typeof Webpack = options.webpack;\n      const { dev } = options;\n\n      const basePath = options.config.basePath || \"/\";\n\n      const tsConfigJson = loadTSConfig(options.dir, nextConfig?.typescript?.tsconfigPath);\n\n      const {\n        cacheOnNavigation,\n        disable,\n        scope = basePath,\n        swUrl,\n        register,\n        reloadOnOnline,\n        globPublicPatterns,\n        ...buildOptions\n      } = validateInjectManifestOptions(userOptions);\n\n      if (typeof nextConfig.webpack === \"function\") {\n        config = nextConfig.webpack(config, options);\n      }\n\n      if (disable) {\n        options.isServer && logger.info(\"Serwist is disabled.\");\n        return config;\n      }\n\n      if (!config.plugins) {\n        config.plugins = [];\n      }\n\n      const _sw = path.posix.join(basePath, swUrl);\n      const _scope = path.posix.join(scope, \"/\");\n\n      config.plugins.push(\n        new webpack.DefinePlugin({\n          \"self.__SERWIST_SW_ENTRY.sw\": `'${_sw}'`,\n          \"self.__SERWIST_SW_ENTRY.scope\": `'${_scope}'`,\n          \"self.__SERWIST_SW_ENTRY.cacheOnNavigation\": `${cacheOnNavigation}`,\n          \"self.__SERWIST_SW_ENTRY.register\": `${register}`,\n          \"self.__SERWIST_SW_ENTRY.reloadOnOnline\": `${reloadOnOnline}`,\n        } satisfies Record<`${SerwistNextOptionsKey}.${Exclude<keyof SerwistNextOptions, \"swEntryWorker\">}`, string | undefined>),\n      );\n\n      const swEntryJs = path.join(dirname, \"sw-entry.mjs\");\n      const entry = config.entry as () => Promise<Record<string, string[] | string>>;\n      config.entry = async () => {\n        const entries = await entry();\n        if (entries[\"main.js\"] && !entries[\"main.js\"].includes(swEntryJs)) {\n          if (Array.isArray(entries[\"main.js\"])) {\n            entries[\"main.js\"].unshift(swEntryJs);\n          } else if (typeof entries[\"main.js\"] === \"string\") {\n            entries[\"main.js\"] = [swEntryJs, entries[\"main.js\"]];\n          }\n        }\n        if (entries[\"main-app\"] && !entries[\"main-app\"].includes(swEntryJs)) {\n          if (Array.isArray(entries[\"main-app\"])) {\n            entries[\"main-app\"].unshift(swEntryJs);\n          } else if (typeof entries[\"main-app\"] === \"string\") {\n            entries[\"main-app\"] = [swEntryJs, entries[\"main-app\"]];\n          }\n        }\n        return entries;\n      };\n\n      if (!options.isServer) {\n        if (!register) {\n          logger.info(\n            \"The service worker will not be automatically registered, please call 'window.serwist.register()' in 'componentDidMount' or 'useEffect'.\",\n          );\n\n          if (!tsConfigJson?.compilerOptions?.types?.includes(\"@serwist/next/typings\")) {\n            logger.info(\n              \"You may also want to add '@serwist/next/typings' to your TypeScript/JavaScript configuration file at 'compilerOptions.types'.\",\n            );\n          }\n        }\n\n        const {\n          swSrc: userSwSrc,\n          swDest: userSwDest,\n          additionalPrecacheEntries,\n          exclude,\n          manifestTransforms = [],\n          ...otherBuildOptions\n        } = buildOptions;\n\n        let swSrc = userSwSrc;\n        let swDest = userSwDest;\n\n        // If these two paths are not absolute, they will be resolved from `compilation.options.output.path`,\n        // which is `${options.dir}/${nextConfig.destDir}` for Next.js apps, rather than `${options.dir}`\n        // as an user would expect.\n        if (!path.isAbsolute(swSrc)) {\n          swSrc = path.join(options.dir, swSrc);\n        }\n        if (!path.isAbsolute(swDest)) {\n          swDest = path.join(options.dir, swDest);\n        }\n\n        const publicDir = path.resolve(options.dir, \"public\");\n        const { dir: destDir, base: destBase } = path.parse(swDest);\n\n        const cleanUpList = globSync([\"swe-worker-*.js\", \"swe-worker-*.js.map\", destBase, `${destBase}.map`], {\n          absolute: true,\n          nodir: true,\n          follow: true,\n          cwd: destDir,\n        });\n\n        for (const file of cleanUpList) {\n          fs.rmSync(file, { force: true });\n        }\n\n        const shouldBuildSWEntryWorker = cacheOnNavigation;\n        let swEntryPublicPath: string | undefined;\n        let swEntryWorkerDest: string | undefined;\n\n        if (shouldBuildSWEntryWorker) {\n          const swEntryWorkerSrc = path.join(dirname, \"sw-entry-worker.mjs\");\n          const swEntryName = `swe-worker-${getContentHash(swEntryWorkerSrc, dev)}.js`;\n          swEntryPublicPath = path.posix.join(basePath, swEntryName);\n          swEntryWorkerDest = path.join(destDir, swEntryName);\n          config.plugins.push(\n            new ChildCompilationPlugin({\n              src: swEntryWorkerSrc,\n              dest: swEntryWorkerDest,\n            }),\n          );\n        }\n        config.plugins.push(\n          new webpack.DefinePlugin({\n            \"self.__SERWIST_SW_ENTRY.swEntryWorker\": swEntryPublicPath && `'${swEntryPublicPath}'`,\n          } satisfies Record<`${SerwistNextOptionsKey}.${Extract<keyof SerwistNextOptions, \"swEntryWorker\">}`, string | undefined>),\n        );\n\n        logger.event(`Bundling the service worker script with the URL '${_sw}' and the scope '${_scope}'...`);\n\n        // Precache files in public folder\n        let resolvedManifestEntries = additionalPrecacheEntries;\n\n        if (!resolvedManifestEntries) {\n          const publicScan = globSync(globPublicPatterns, {\n            nodir: true,\n            follow: true,\n            cwd: publicDir,\n            ignore: [\"swe-worker-*.js\", destBase, `${destBase}.map`],\n          });\n          resolvedManifestEntries = publicScan.map((f) => ({\n            url: path.posix.join(basePath, f),\n            revision: getFileHash(path.join(publicDir, f)),\n          }));\n        }\n\n        const publicPath = config.output?.publicPath;\n\n        config.plugins.push(\n          new InjectManifest({\n            swSrc,\n            swDest,\n            disablePrecacheManifest: dev,\n            additionalPrecacheEntries: dev ? [] : resolvedManifestEntries,\n            exclude: [\n              ...exclude,\n              ({ asset, compilation }: ExcludeParams) => {\n                // Same as how `@serwist/webpack-plugin` does it. It is always\n                // `relativeToOutputPath(compilation, originalSwDest)`.\n                const swDestRelativeOutput = relativeToOutputPath(compilation, swDest);\n                const swAsset = compilation.getAsset(swDestRelativeOutput);\n                return (\n                  // We don't need the service worker to be cached.\n                  asset.name === swAsset?.name ||\n                  asset.name.startsWith(\"server/\") ||\n                  // This excludes all JSON files in the compilation directory by filtering\n                  // out paths that have slashes or don't end with `.json`. Only said files\n                  // match this criterion.\n                  /^[^/]*\\.json$/.test(asset.name) ||\n                  (dev && !asset.name.startsWith(\"static/runtime/\"))\n                );\n              },\n            ],\n            manifestTransforms: [\n              ...manifestTransforms,\n              async (manifestEntries, compilation) => {\n                // This path always uses forward slashes, so it is safe to use it in the following string replace.\n                const publicDirRelativeOutput = relativeToOutputPath(compilation as Compilation, publicDir);\n                // `publicPath` is always `${assetPrefix}/_next/` for Next.js apps.\n                const publicFilesPrefix = `${publicPath}${publicDirRelativeOutput}`;\n                const manifest = manifestEntries.map((m) => {\n                  m.url = m.url.replace(\"/_next//static/image\", \"/_next/static/image\").replace(\"/_next//static/media\", \"/_next/static/media\");\n                  // We remove `${publicPath}/${publicDirRelativeOutput}` because `assetPrefix`\n                  // is not intended for files that are in the public directory and we also want\n                  // to remove `/_next/${publicDirRelativeOutput}` from the URL, since that is not how\n                  // we resolve files in the public directory.\n                  if (m.url.startsWith(publicFilesPrefix)) {\n                    m.url = path.posix.join(basePath, m.url.replace(publicFilesPrefix, \"\"));\n                  }\n                  m.url = m.url.replace(/\\[/g, \"%5B\").replace(/\\]/g, \"%5D\").replace(/@/g, \"%40\");\n                  return m;\n                });\n                return { manifest, warnings: [] };\n              },\n            ],\n            ...otherBuildOptions,\n          }),\n        );\n      }\n\n      return config;\n    },\n  });\n};\n\nexport default withSerwistInit;\nexport { validateInjectManifestOptions };\nexport type { InjectManifestOptions as PluginOptions, InjectManifestOptionsComplete as PluginOptionsComplete };\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAMA,MAAa,mBAAyB,KAAU,OAAsB;AACpE,MAAK,MAAM,KAAK,KAAK;EACnB,MAAM,WAAW,GAAG,EAAE;AACtB,MAAI,SACF,QAAO;;;;;ACPb,MAAa,eAAe,SAAkC,OAAO,WAAW,MAAM,CAAC,OAAO,GAAG,aAAa,KAAK,CAAC,CAAC,OAAO,MAAM;;;ACClI,MAAa,kBAAkB,MAA+B,UAAmB;AAC/E,KAAI,MACF,QAAO;AAET,QAAO,YAAY,KAAK,CAAC,MAAM,GAAG,GAAG;;ACNvB,cAAc,OAAO,KAAK,IAAI;;;ACK9C,MAAa,gBAAgB,SAAiB,yBAAuE;AACnH,KAAI;EAEF,MAAM,eAAe,gBAAgB,CAAC,wBAAwB,iBAAiB,gBAAgB,GAAG,aAAa;GAC7G,MAAM,eAAe,KAAK,KAAK,SAAS,SAAS;AACjD,UAAO,GAAG,WAAW,aAAa,GAAG,eAAe,KAAA;IACpD;AACF,MAAI,CAAC,aACH;AAGF,SAAO,KAAK,MAAM,GAAG,aAAa,cAAc,QAAQ,CAAC;SACnD;AACN;;;;;AChBJ,MAAM,UAAU,cAAc,OAAO,KAAK,IAAI;AAE9C,MAAM,uBAAuB,OAAO,IAAI,QAAQ,oBAAoB,CAAC,SAAS,SAAS,GAAG,KAAK;AAI/F,MAAM,eAAe,YAA4B,GAAG,YAAmB;CACrE,IAAI;CACJ,IAAI;AAEJ,SAAQ,YAAR;EACE,KAAK;AACH,YAAS,GAAG,MAAM,KAAK,IAAI,CAAC,CAAC;AAC7B,mBAAgB;AAChB;EACF,KAAK;AACH,YAAS,GAAG,IAAI,KAAK,IAAI,CAAC,CAAC;AAC3B,mBAAgB;AAChB;EACF,KAAK;AACH,YAAS,GAAG,OAAO,KAAK,IAAI,CAAC,CAAC;AAC9B,mBAAgB;AAChB;EACF,KAAK;AACH,YAAS,GAAG,MAAM,KAAK,IAAI,CAAC,CAAC;AAC7B,mBAAgB;AAChB;EACF,KAAK;AACH,YAAS,GAAG,MAAM,KAAK,IAAI,CAAC,CAAC;AAC7B,mBAAgB;AAChB;;AAGJ,MAAK,QAAQ,OAAO,MAAM,QAAQ,OAAO,KAAA,MAAc,QAAQ,WAAW,EACxE,SAAQ,OAAO;AAIjB,KAAI,QAAQ,WAAW,EACrB,SAAQ,eAAe,GAAG;KAE1B,SAAQ,eAAe,GAAG,uBAAuB,UAAU,GAAG,QAAQ;;AAU1E,MAAa,QAAQ,GAAG,YAAmB,YAAY,QAAQ,GAAG,QAAQ;AAE1E,MAAa,SAAS,GAAG,YAAmB,YAAY,SAAS,GAAG,QAAQ;;;ACpD5E,MAAa,iCAAiC,UAAkD;CAC9F,MAAM,SAAS,sBAAsB,UAAU,OAAO,EACpD,OAAO,oBACR,CAAC;AACF,KAAI,CAAC,OAAO,QACV,OAAM,IAAI,mBAAmB;EAAE,YAAY;EAAiB,SAAS,EAAE,cAAc,OAAO,MAAM;EAAE,CAAC;AAEvG,QAAO,OAAO;;;;ACChB,MAAM,UAAU,eAAe,aAAa,YAAY,cAAc,IAAI,IAAI,KAAK,OAAO,KAAK,IAAI,CAAC;;;;;;AAOpG,MAAM,mBAAmB,gBAAkF;AACzG,KAAI,CAAC,QAAQ,IAAI,sCAAsC,QAAQ,IAAI,aAAa,CAAC,YAAY,SAAS;AACpG,UAAQ,IAAI,qCAAqC;AACjD,UAAQ,KACN;;;;;;;;;;gLAWD;;AAEH,SAAQ,aAAa,EAAE,MAAM;EAC3B,GAAG;EACH,QAAQ,QAAuB,SAAS;GACtC,MAAM,UAA0B,QAAQ;GACxC,MAAM,EAAE,QAAQ;GAEhB,MAAM,WAAW,QAAQ,OAAO,YAAY;GAE5C,MAAM,eAAe,aAAa,QAAQ,KAAK,YAAY,YAAY,aAAa;GAEpF,MAAM,EACJ,mBACA,SACA,QAAQ,UACR,OACA,UACA,gBACA,oBACA,GAAG,iBACD,8BAA8B,YAAY;AAE9C,OAAI,OAAO,WAAW,YAAY,WAChC,UAAS,WAAW,QAAQ,QAAQ,QAAQ;AAG9C,OAAI,SAAS;AACX,YAAQ,YAAYC,KAAY,uBAAuB;AACvD,WAAO;;AAGT,OAAI,CAAC,OAAO,QACV,QAAO,UAAU,EAAE;GAGrB,MAAM,MAAM,KAAK,MAAM,KAAK,UAAU,MAAM;GAC5C,MAAM,SAAS,KAAK,MAAM,KAAK,OAAO,IAAI;AAE1C,UAAO,QAAQ,KACb,IAAI,QAAQ,aAAa;IACvB,8BAA8B,IAAI,IAAI;IACtC,iCAAiC,IAAI,OAAO;IAC5C,6CAA6C,GAAG;IAChD,oCAAoC,GAAG;IACvC,0CAA0C,GAAG;IAC9C,CAAwH,CAC1H;GAED,MAAM,YAAY,KAAK,KAAK,SAAS,eAAe;GACpD,MAAM,QAAQ,OAAO;AACrB,UAAO,QAAQ,YAAY;IACzB,MAAM,UAAU,MAAM,OAAO;AAC7B,QAAI,QAAQ,cAAc,CAAC,QAAQ,WAAW,SAAS,UAAU;SAC3D,MAAM,QAAQ,QAAQ,WAAW,CACnC,SAAQ,WAAW,QAAQ,UAAU;cAC5B,OAAO,QAAQ,eAAe,SACvC,SAAQ,aAAa,CAAC,WAAW,QAAQ,WAAW;;AAGxD,QAAI,QAAQ,eAAe,CAAC,QAAQ,YAAY,SAAS,UAAU;SAC7D,MAAM,QAAQ,QAAQ,YAAY,CACpC,SAAQ,YAAY,QAAQ,UAAU;cAC7B,OAAO,QAAQ,gBAAgB,SACxC,SAAQ,cAAc,CAAC,WAAW,QAAQ,YAAY;;AAG1D,WAAO;;AAGT,OAAI,CAAC,QAAQ,UAAU;AACrB,QAAI,CAAC,UAAU;AACb,UACE,0IACD;AAED,SAAI,CAAC,cAAc,iBAAiB,OAAO,SAAS,wBAAwB,CAC1E,MACE,gIACD;;IAIL,MAAM,EACJ,OAAO,WACP,QAAQ,YACR,2BACA,SACA,qBAAqB,EAAE,EACvB,GAAG,sBACD;IAEJ,IAAI,QAAQ;IACZ,IAAI,SAAS;AAKb,QAAI,CAAC,KAAK,WAAW,MAAM,CACzB,SAAQ,KAAK,KAAK,QAAQ,KAAK,MAAM;AAEvC,QAAI,CAAC,KAAK,WAAW,OAAO,CAC1B,UAAS,KAAK,KAAK,QAAQ,KAAK,OAAO;IAGzC,MAAM,YAAY,KAAK,QAAQ,QAAQ,KAAK,SAAS;IACrD,MAAM,EAAE,KAAK,SAAS,MAAM,aAAa,KAAK,MAAM,OAAO;IAE3D,MAAM,cAAc,SAAS;KAAC;KAAmB;KAAuB;KAAU,GAAG,SAAS;KAAM,EAAE;KACpG,UAAU;KACV,OAAO;KACP,QAAQ;KACR,KAAK;KACN,CAAC;AAEF,SAAK,MAAM,QAAQ,YACjB,IAAG,OAAO,MAAM,EAAE,OAAO,MAAM,CAAC;IAGlC,MAAM,2BAA2B;IACjC,IAAI;IACJ,IAAI;AAEJ,QAAI,0BAA0B;KAC5B,MAAM,mBAAmB,KAAK,KAAK,SAAS,sBAAsB;KAClE,MAAM,cAAc,cAAc,eAAe,kBAAkB,IAAI,CAAC;AACxE,yBAAoB,KAAK,MAAM,KAAK,UAAU,YAAY;AAC1D,yBAAoB,KAAK,KAAK,SAAS,YAAY;AACnD,YAAO,QAAQ,KACb,IAAI,uBAAuB;MACzB,KAAK;MACL,MAAM;MACP,CAAC,CACH;;AAEH,WAAO,QAAQ,KACb,IAAI,QAAQ,aAAa,EACvB,yCAAyC,qBAAqB,IAAI,kBAAkB,IACrF,CAAwH,CAC1H;AAED,UAAa,oDAAoD,IAAI,mBAAmB,OAAO,MAAM;IAGrG,IAAI,0BAA0B;AAE9B,QAAI,CAAC,wBAOH,2BANmB,SAAS,oBAAoB;KAC9C,OAAO;KACP,QAAQ;KACR,KAAK;KACL,QAAQ;MAAC;MAAmB;MAAU,GAAG,SAAS;MAAM;KACzD,CACmC,CAAC,KAAK,OAAO;KAC/C,KAAK,KAAK,MAAM,KAAK,UAAU,EAAE;KACjC,UAAU,YAAY,KAAK,KAAK,WAAW,EAAE,CAAC;KAC/C,EAAE;IAGL,MAAM,aAAa,OAAO,QAAQ;AAElC,WAAO,QAAQ,KACb,IAAI,eAAe;KACjB;KACA;KACA,yBAAyB;KACzB,2BAA2B,MAAM,EAAE,GAAG;KACtC,SAAS,CACP,GAAG,UACF,EAAE,OAAO,kBAAiC;MAGzC,MAAM,uBAAuB,qBAAqB,aAAa,OAAO;MACtE,MAAM,UAAU,YAAY,SAAS,qBAAqB;AAC1D,aAEE,MAAM,SAAS,SAAS,QACxB,MAAM,KAAK,WAAW,UAAU,IAIhC,gBAAgB,KAAK,MAAM,KAAK,IAC/B,OAAO,CAAC,MAAM,KAAK,WAAW,kBAAkB;OAGtD;KACD,oBAAoB,CAClB,GAAG,oBACH,OAAO,iBAAiB,gBAAgB;MAItC,MAAM,oBAAoB,GAAG,aAFG,qBAAqB,aAA4B,UAEhB;AAajE,aAAO;OAAE,UAZQ,gBAAgB,KAAK,MAAM;AAC1C,UAAE,MAAM,EAAE,IAAI,QAAQ,wBAAwB,sBAAsB,CAAC,QAAQ,wBAAwB,sBAAsB;AAK3H,YAAI,EAAE,IAAI,WAAW,kBAAkB,CACrC,GAAE,MAAM,KAAK,MAAM,KAAK,UAAU,EAAE,IAAI,QAAQ,mBAAmB,GAAG,CAAC;AAEzE,UAAE,MAAM,EAAE,IAAI,QAAQ,OAAO,MAAM,CAAC,QAAQ,OAAO,MAAM,CAAC,QAAQ,MAAM,MAAM;AAC9E,eAAO;SAEQ;OAAE,UAAU,EAAE;OAAE;OAEpC;KACD,GAAG;KACJ,CAAC,CACH;;AAGH,UAAO;;EAEV"}

package/dist/index.react.d.mts

@@ -0,0 +1,41 @@
+import { Serwist } from "@serwist/window";
+import { JSX, ReactNode } from "react";
+
+//#region src/lib/context.d.ts
+interface SerwistContextValues {
+  serwist: Serwist | null;
+}
+declare const useSerwist: () => SerwistContextValues;
+//#endregion
+//#region src/index.react.d.ts
+interface SerwistProviderProps {
+  swUrl: string;
+  disable?: boolean;
+  register?: boolean;
+  cacheOnNavigation?: boolean;
+  reloadOnOnline?: boolean;
+  options?: RegistrationOptions;
+  children?: ReactNode;
+}
+declare global {
+  interface Window {
+    serwist: Serwist;
+  }
+}
+/**
+ * `@serwist/window` provider for Next.js apps.
+ * @param options
+ * @returns
+ */
+declare function SerwistProvider({
+  swUrl,
+  disable,
+  register,
+  cacheOnNavigation,
+  reloadOnOnline,
+  options,
+  children
+}: SerwistProviderProps): JSX.Element;
+//#endregion
+export { SerwistProvider, SerwistProviderProps, useSerwist };
+//# sourceMappingURL=index.react.d.mts.map

package/dist/index.react.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.react.d.mts","names":[],"sources":["../src/lib/context.ts","../src/index.react.tsx"],"mappings":";;;;UAGiB,oBAAA;EACf,OAAA,EAAS,OAAA;AAAA;AAAA,cAKE,UAAA,QAAU,oBAAA;;;UCJN,oBAAA;EACf,KAAA;EACA,OAAA;EACA,QAAA;EACA,iBAAA;EACA,cAAA;EACA,OAAA,GAAU,mBAAA;EACV,QAAA,GAAW,SAAA;AAAA;AAAA,QAGL,MAAA;EAAA,UACI,MAAA;IACR,OAAA,EAAS,OAAA;EAAA;AAAA;AAZb;;;;;AAAA,iBAqBgB,eAAA,CAAA;EACd,KAAA;EACA,OAAA;EACA,QAAA;EACA,iBAAA;EACA,cAAA;EACA,OAAA;EACA;AAAA,GACC,oBAAA,GAAuB,GAAA,CAAI,OAAA"}