@serwist/turbopack 9.3.0 → 9.4.0

package/dist/index.react.d.ts

@@ -1,8 +1,11 @@
 import { Serwist } from "@serwist/window";
 import { type ReactNode } from "react";
+import { useSerwist } from "./lib/context.js";
 export interface SerwistProviderProps {
     swUrl: string;
+    disable?: boolean;
     register?: boolean;
+    cacheOnNavigation?: boolean;
     reloadOnOnline?: boolean;
     options?: RegistrationOptions;
     children?: ReactNode;
@@ -12,5 +15,11 @@ declare global {
         serwist: Serwist;
     }
 }
-export declare function SerwistProvider({ swUrl, register, reloadOnOnline, options, children }: SerwistProviderProps): import("react").JSX.Element;
+/**
+ * `@serwist/window` provider for Next.js apps.
+ * @param options
+ * @returns
+ */
+export declare function SerwistProvider({ swUrl, disable, register, cacheOnNavigation, reloadOnOnline, options, children, }: SerwistProviderProps): import("react").JSX.Element;
+export { useSerwist };
 //# sourceMappingURL=index.react.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.react.d.ts","sourceRoot":"","sources":["../src/index.react.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE1C,OAAO,EAAE,KAAK,SAAS,EAAuB,MAAM,OAAO,CAAC;AAG5D,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,OAAO,EAAE,OAAO,CAAC;KAClB;CACF;AAED,wBAAgB,eAAe,CAAC,EAAE,KAAK,EAAE,QAAe,EAAE,cAAqB,EAAE,OAAO,EAAE,QAAQ,EAAE,EAAE,oBAAoB,+BAwBzH"}
+{"version":3,"file":"index.react.d.ts","sourceRoot":"","sources":["../src/index.react.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE1C,OAAO,EAAE,KAAK,SAAS,EAAuB,MAAM,OAAO,CAAC;AAC5D,OAAO,EAAkB,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE9D,MAAM,WAAW,oBAAoB;IACnC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,iBAAiB,CAAC,EAAE,OAAO,CAAC;IAC5B,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB,OAAO,CAAC,EAAE,mBAAmB,CAAC;IAC9B,QAAQ,CAAC,EAAE,SAAS,CAAC;CACtB;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,MAAM;QACd,OAAO,EAAE,OAAO,CAAC;KAClB;CACF;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,EAC9B,KAAK,EACL,OAAe,EACf,QAAe,EACf,iBAAwB,EACxB,cAAqB,EACrB,OAAO,EACP,QAAQ,GACT,EAAE,oBAAoB,+BAuDtB;AAED,OAAO,EAAE,UAAU,EAAE,CAAC"}

package/dist/index.react.js

@@ -1,31 +1,70 @@
 import { jsx } from 'react/jsx-runtime';
 import { Serwist } from '@serwist/window';
 import { isCurrentPageOutOfScope } from '@serwist/window/internal';
-import { createContext, useState, useEffect } from 'react';
+import { createContext, useContext, useState, useEffect } from 'react';
 
 const SerwistContext = createContext(null);
+const useSerwist = ()=>{
+    const context = useContext(SerwistContext);
+    if (!context) {
+        throw new Error("[useSerwist]: 'SerwistContext' is not available.");
+    }
+    return context;
+};
 
-function SerwistProvider({ swUrl, register = true, reloadOnOnline = true, options, children }) {
+function SerwistProvider({ swUrl, disable = false, register = true, cacheOnNavigation = true, reloadOnOnline = true, options, children }) {
     const [serwist] = useState(()=>{
         if (typeof window === "undefined") return null;
+        if (disable) return null;
+        const scope = options?.scope || "/";
         if (!(window.serwist && window.serwist instanceof Serwist) && "serviceWorker" in navigator) {
             window.serwist = new Serwist(swUrl, {
                 ...options,
-                type: options?.type || "module",
-                scope: options?.scope || "/"
+                scope,
+                type: options?.type || "module"
             });
+            if (register && !isCurrentPageOutOfScope(scope)) {
+                void window.serwist.register();
+            }
         }
         return window.serwist ?? null;
     });
     useEffect(()=>{
-        const scope = options?.scope || "/";
-        if (register && !isCurrentPageOutOfScope(scope)) {
-            void serwist?.register();
+        const cacheUrls = async (url)=>{
+            if (!window.navigator.onLine || !url) {
+                return;
+            }
+            serwist?.messageSW({
+                type: "CACHE_URLS",
+                payload: {
+                    urlsToCache: [
+                        url
+                    ]
+                }
+            });
+        };
+        const cacheCurrentPathname = ()=>cacheUrls(window.location.pathname);
+        const pushState = history.pushState;
+        const replaceState = history.replaceState;
+        if (cacheOnNavigation) {
+            history.pushState = (...args)=>{
+                pushState.apply(history, args);
+                cacheUrls(args[2]);
+            };
+            history.replaceState = (...args)=>{
+                replaceState.apply(history, args);
+                cacheUrls(args[2]);
+            };
+            window.addEventListener("online", cacheCurrentPathname);
         }
+        return ()=>{
+            history.pushState = pushState;
+            history.replaceState = replaceState;
+            window.removeEventListener("online", cacheCurrentPathname);
+        };
     }, [
-        register,
-        options?.scope,
-        serwist?.register
+        serwist,
+        cacheOnNavigation
     ]);
     useEffect(()=>{
         const reload = ()=>location.reload();
@@ -46,4 +85,4 @@ function SerwistProvider({ swUrl, register = true, reloadOnOnline = true, option
     });
 }
 
-export { SerwistProvider };
+export { SerwistProvider, useSerwist };

package/dist/types.d.ts

@@ -1,8 +1,8 @@
 import type { BasePartial, BaseResolved, GlobPartial, GlobResolved, InjectPartial, InjectResolved, OptionalGlobDirectoryPartial, RequiredGlobDirectoryResolved } from "@serwist/build";
 import type { Prettify, Require } from "@serwist/utils";
 import type { BuildOptions } from "esbuild-wasm";
-import type { SUPPORTED_ESBUILD_OPTIONS } from "./lib/constants.js";
 import type { NextConfig as CompleteNextConfig } from "next";
+import type { SUPPORTED_ESBUILD_OPTIONS } from "./lib/constants.js";
 export type EsbuildSupportedOptions = (typeof SUPPORTED_ESBUILD_OPTIONS)[number];
 export type EsbuildOptions = Pick<BuildOptions, EsbuildSupportedOptions>;
 export interface NextConfig extends Pick<CompleteNextConfig, "basePath" | "distDir"> {

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,YAAY,EACZ,WAAW,EACX,YAAY,EACZ,aAAa,EACb,cAAc,EACd,4BAA4B,EAC5B,6BAA6B,EAC9B,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC;AACpE,OAAO,KAAK,EAAE,UAAU,IAAI,kBAAkB,EAAE,MAAM,MAAM,CAAC;AAE7D,MAAM,MAAM,uBAAuB,GAAG,CAAC,OAAO,yBAAyB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEjF,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,YAAY,EAAE,uBAAuB,CAAC,CAAC;AAEzE,MAAM,WAAW,UAAW,SAAQ,IAAI,CAAC,kBAAkB,EAAE,UAAU,GAAG,SAAS,CAAC;IAClF;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;;;;OAOG;IACH,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;IACjC;;;OAGG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC;AAED,MAAM,WAAW,aAAc,SAAQ,OAAO,CAAC,YAAY,EAAE,KAAK,GAAG,gBAAgB,CAAC;IACpF,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,UAAU,GAAG,SAAS,CAAC,CAAC;CACzD;AAED,MAAM,MAAM,qBAAqB,GAAG,QAAQ,CAC1C,IAAI,CAAC,WAAW,GAAG,WAAW,GAAG,aAAa,GAAG,4BAA4B,GAAG,YAAY,EAAE,yBAAyB,CAAC,CACzH,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG,QAAQ,CAClD,IAAI,CACF,OAAO,CAAC,YAAY,EAAE,2BAA2B,CAAC,GAAG,YAAY,GAAG,cAAc,GAAG,6BAA6B,GAAG,aAAa,EAClI,yBAAyB,CAC1B,CACF,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,WAAW,EACX,YAAY,EACZ,WAAW,EACX,YAAY,EACZ,aAAa,EACb,cAAc,EACd,4BAA4B,EAC5B,6BAA6B,EAC9B,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,QAAQ,EAAE,OAAO,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,cAAc,CAAC;AACjD,OAAO,KAAK,EAAE,UAAU,IAAI,kBAAkB,EAAE,MAAM,MAAM,CAAC;AAC7D,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC;AAEpE,MAAM,MAAM,uBAAuB,GAAG,CAAC,OAAO,yBAAyB,CAAC,CAAC,MAAM,CAAC,CAAC;AAEjF,MAAM,MAAM,cAAc,GAAG,IAAI,CAAC,YAAY,EAAE,uBAAuB,CAAC,CAAC;AAEzE,MAAM,WAAW,UAAW,SAAQ,IAAI,CAAC,kBAAkB,EAAE,UAAU,GAAG,SAAS,CAAC;IAClF;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;;OAKG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,YAAY;IAC3B;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IACb;;;;;;;OAOG;IACH,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC,CAAC;IACjC;;;OAGG;IACH,cAAc,CAAC,EAAE,cAAc,CAAC;CACjC;AAED,MAAM,WAAW,aAAc,SAAQ,OAAO,CAAC,YAAY,EAAE,KAAK,GAAG,gBAAgB,CAAC;IACpF,UAAU,EAAE,OAAO,CAAC,UAAU,EAAE,UAAU,GAAG,SAAS,CAAC,CAAC;CACzD;AAED,MAAM,MAAM,qBAAqB,GAAG,QAAQ,CAC1C,IAAI,CAAC,WAAW,GAAG,WAAW,GAAG,aAAa,GAAG,4BAA4B,GAAG,YAAY,EAAE,yBAAyB,CAAC,CACzH,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG,QAAQ,CAClD,IAAI,CACF,OAAO,CAAC,YAAY,EAAE,2BAA2B,CAAC,GAAG,YAAY,GAAG,cAAc,GAAG,6BAA6B,GAAG,aAAa,EAClI,yBAAyB,CAC1B,CACF,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serwist/turbopack",
-  "version": "9.3.0",
+  "version": "9.4.0",
   "type": "module",
   "sideEffects": false,
   "description": "A module that integrates Serwist into your Next.js / Turbopack application.",
@@ -67,9 +67,9 @@
     "kolorist": "1.8.0",
     "semver": "7.7.3",
     "zod": "4.2.1",
-    "@serwist/build": "9.3.0",
-    "@serwist/window": "9.3.0",
-    "serwist": "9.3.0"
+    "@serwist/build": "9.4.0",
+    "@serwist/window": "9.4.0",
+    "serwist": "9.4.0"
   },
   "devDependencies": {
     "@types/node": "25.0.3",
@@ -82,8 +82,8 @@
     "rollup": "4.54.0",
     "type-fest": "5.3.1",
     "typescript": "5.9.3",
-    "@serwist/configs": "9.3.0",
-    "@serwist/utils": "9.3.0"
+    "@serwist/utils": "9.4.0",
+    "@serwist/configs": "9.4.0"
   },
   "peerDependencies": {
     "esbuild-wasm": ">=0.25.0 <1.0.0",

package/src/index.react.tsx

@@ -1,11 +1,13 @@
 import { Serwist } from "@serwist/window";
 import { isCurrentPageOutOfScope } from "@serwist/window/internal";
 import { type ReactNode, useEffect, useState } from "react";
-import { SerwistContext } from "./lib/context.js";
+import { SerwistContext, useSerwist } from "./lib/context.js";
 
 export interface SerwistProviderProps {
   swUrl: string;
+  disable?: boolean;
   register?: boolean;
+  cacheOnNavigation?: boolean;
   reloadOnOnline?: boolean;
   options?: RegistrationOptions;
   children?: ReactNode;
@@ -17,20 +19,64 @@ declare global {
   }
 }
 
-export function SerwistProvider({ swUrl, register = true, reloadOnOnline = true, options, children }: SerwistProviderProps) {
+/**
+ * `@serwist/window` provider for Next.js apps.
+ * @param options
+ * @returns
+ */
+export function SerwistProvider({
+  swUrl,
+  disable = false,
+  register = true,
+  cacheOnNavigation = true,
+  reloadOnOnline = true,
+  options,
+  children,
+}: SerwistProviderProps) {
   const [serwist] = useState(() => {
     if (typeof window === "undefined") return null;
+    if (disable) return null;
+    const scope = options?.scope || "/";
     if (!(window.serwist && window.serwist instanceof Serwist) && "serviceWorker" in navigator) {
-      window.serwist = new Serwist(swUrl, { ...options, type: options?.type || "module", scope: options?.scope || "/" });
+      window.serwist = new Serwist(swUrl, { ...options, scope, type: options?.type || "module" });
+      if (register && !isCurrentPageOutOfScope(scope)) {
+        void window.serwist.register();
+      }
     }
     return window.serwist ?? null;
   });
   useEffect(() => {
-    const scope = options?.scope || "/";
-    if (register && !isCurrentPageOutOfScope(scope)) {
-      void serwist?.register();
+    const cacheUrls = async (url?: string | URL | null | undefined) => {
+      if (!window.navigator.onLine || !url) {
+        return;
+      }
+      serwist?.messageSW({
+        type: "CACHE_URLS",
+        payload: { urlsToCache: [url] },
+      });
+    };
+    const cacheCurrentPathname = () => cacheUrls(window.location.pathname);
+    const pushState = history.pushState;
+    const replaceState = history.replaceState;
+
+    if (cacheOnNavigation) {
+      history.pushState = (...args) => {
+        pushState.apply(history, args);
+        cacheUrls(args[2]);
+      };
+      history.replaceState = (...args) => {
+        replaceState.apply(history, args);
+        cacheUrls(args[2]);
+      };
+      window.addEventListener("online", cacheCurrentPathname);
     }
-  }, [register, options?.scope, serwist?.register]);
+
+    return () => {
+      history.pushState = pushState;
+      history.replaceState = replaceState;
+      window.removeEventListener("online", cacheCurrentPathname);
+    };
+  }, [serwist, cacheOnNavigation]);
   useEffect(() => {
     const reload = () => location.reload();
     if (reloadOnOnline) {
@@ -42,3 +88,5 @@ export function SerwistProvider({ swUrl, register = true, reloadOnOnline = true,
   }, [reloadOnOnline]);
   return <SerwistContext.Provider value={{ serwist }}>{children}</SerwistContext.Provider>;
 }
+
+export { useSerwist };

package/src/index.schema.ts

@@ -1,5 +1,5 @@
 import path from "node:path";
-import { assertType, type Equals, basePartial, globPartial, injectPartial } from "@serwist/build/schema";
+import { assertType, basePartial, type Equals, globPartial, injectPartial } from "@serwist/build/schema";
 import z from "zod";
 import { SUPPORTED_ESBUILD_OPTIONS } from "./lib/constants.js";
 import { generateGlobPatterns } from "./lib/utils.js";

package/src/types.ts

@@ -10,8 +10,8 @@ import type {
 } from "@serwist/build";
 import type { Prettify, Require } from "@serwist/utils";
 import type { BuildOptions } from "esbuild-wasm";
-import type { SUPPORTED_ESBUILD_OPTIONS } from "./lib/constants.js";
 import type { NextConfig as CompleteNextConfig } from "next";
+import type { SUPPORTED_ESBUILD_OPTIONS } from "./lib/constants.js";
 
 export type EsbuildSupportedOptions = (typeof SUPPORTED_ESBUILD_OPTIONS)[number];