@serwist/next 9.0.0-preview.0 → 9.0.0-preview.10

package/dist/index.worker.d.ts

@@ -1,5 +1,4 @@
+import { PAGES_CACHE_NAME } from "./worker/constants.js";
 import { defaultCache } from "./worker/defaultCache.js";
-import { type DefinePageRuntimeCachingOptions, type PageRuntimeCaching, definePageRuntimeCaching } from "./worker/definePageRuntimeCaching.js";
-export { defaultCache, definePageRuntimeCaching };
-export type { DefinePageRuntimeCachingOptions, PageRuntimeCaching };
+export { defaultCache, PAGES_CACHE_NAME };
 //# sourceMappingURL=index.worker.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"index.worker.d.ts","sourceRoot":"","sources":["../src/index.worker.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AACxD,OAAO,EAAE,KAAK,+BAA+B,EAAE,KAAK,kBAAkB,EAAE,wBAAwB,EAAE,MAAM,sCAAsC,CAAC;AAE/I,OAAO,EAAE,YAAY,EAAE,wBAAwB,EAAE,CAAC;AAClD,YAAY,EAAE,+BAA+B,EAAE,kBAAkB,EAAE,CAAC"}
+{"version":3,"file":"index.worker.d.ts","sourceRoot":"","sources":["../src/index.worker.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAExD,OAAO,EAAE,YAAY,EAAE,gBAAgB,EAAE,CAAC"}

package/dist/index.worker.js

@@ -1,171 +1,162 @@
-const nonNullable = (value)=>value !== null && value !== undefined;
+import { ExpirationPlugin } from '@serwist/expiration';
+import { RangeRequestsPlugin } from '@serwist/range-requests';
+import { CacheFirst, StaleWhileRevalidate, NetworkFirst } from '@serwist/strategies';
 
-/**
- * Conveniently define three `runtimeCaching` entries for Next.js pages.
- * @param options
- * @returns
- */ const definePageRuntimeCaching = ({ rscPrefetch, rsc, html })=>{
-    const pageRcs = [
-        rscPrefetch,
-        rsc,
-        html
-    ];
-    if (pageRcs[0]) {
-        if (!pageRcs[0].options) pageRcs[0].options = {};
-        pageRcs[0].options.cacheName = "pages-rsc-prefetch";
-    }
-    if (pageRcs[1]) {
-        if (!pageRcs[1].options) pageRcs[1].options = {};
-        pageRcs[1].options.cacheName = "pages-rsc";
-    }
-    if (pageRcs[2]) {
-        if (!pageRcs[2].options) pageRcs[2].options = {};
-        pageRcs[2].options.cacheName = "pages";
-    }
-    return pageRcs.filter(nonNullable);
+const PAGES_CACHE_NAME = {
+    rscPrefetch: "pages-rsc-prefetch",
+    rsc: "pages-rsc",
+    html: "pages"
 };
 
-// Serwist RuntimeCaching config: https://developers.google.com/web/tools/workbox/reference-docs/latest/module-workbox-build#.RuntimeCachingEntry
 const defaultCache = [
     {
-        urlPattern: /^https:\/\/fonts\.(?:gstatic)\.com\/.*/i,
-        handler: "CacheFirst",
-        options: {
+        matcher: /^https:\/\/fonts\.(?:gstatic)\.com\/.*/i,
+        handler: new CacheFirst({
             cacheName: "google-fonts-webfonts",
-            expiration: {
-                maxEntries: 4,
-                maxAgeSeconds: 365 * 24 * 60 * 60
-            }
-        }
+            plugins: [
+                new ExpirationPlugin({
+                    maxEntries: 4,
+                    maxAgeSeconds: 365 * 24 * 60 * 60
+                })
+            ]
+        })
     },
     {
-        urlPattern: /^https:\/\/fonts\.(?:googleapis)\.com\/.*/i,
-        handler: "StaleWhileRevalidate",
-        options: {
+        matcher: /^https:\/\/fonts\.(?:googleapis)\.com\/.*/i,
+        handler: new StaleWhileRevalidate({
             cacheName: "google-fonts-stylesheets",
-            expiration: {
-                maxEntries: 4,
-                maxAgeSeconds: 7 * 24 * 60 * 60
-            }
-        }
+            plugins: [
+                new ExpirationPlugin({
+                    maxEntries: 4,
+                    maxAgeSeconds: 7 * 24 * 60 * 60
+                })
+            ]
+        })
     },
     {
-        urlPattern: /\.(?:eot|otf|ttc|ttf|woff|woff2|font.css)$/i,
-        handler: "StaleWhileRevalidate",
-        options: {
+        matcher: /\.(?:eot|otf|ttc|ttf|woff|woff2|font.css)$/i,
+        handler: new StaleWhileRevalidate({
             cacheName: "static-font-assets",
-            expiration: {
-                maxEntries: 4,
-                maxAgeSeconds: 7 * 24 * 60 * 60
-            }
-        }
+            plugins: [
+                new ExpirationPlugin({
+                    maxEntries: 4,
+                    maxAgeSeconds: 7 * 24 * 60 * 60
+                })
+            ]
+        })
     },
     {
-        urlPattern: /\.(?:jpg|jpeg|gif|png|svg|ico|webp)$/i,
-        handler: "StaleWhileRevalidate",
-        options: {
+        matcher: /\.(?:jpg|jpeg|gif|png|svg|ico|webp)$/i,
+        handler: new StaleWhileRevalidate({
             cacheName: "static-image-assets",
-            expiration: {
-                maxEntries: 64,
-                maxAgeSeconds: 30 * 24 * 60 * 60
-            }
-        }
+            plugins: [
+                new ExpirationPlugin({
+                    maxEntries: 64,
+                    maxAgeSeconds: 30 * 24 * 60 * 60
+                })
+            ]
+        })
     },
     {
-        urlPattern: /\/_next\/static.+\.js$/i,
-        handler: "CacheFirst",
-        options: {
+        matcher: /\/_next\/static.+\.js$/i,
+        handler: new CacheFirst({
             cacheName: "next-static-js-assets",
-            expiration: {
-                maxEntries: 64,
-                maxAgeSeconds: 24 * 60 * 60
-            }
-        }
+            plugins: [
+                new ExpirationPlugin({
+                    maxEntries: 64,
+                    maxAgeSeconds: 24 * 60 * 60
+                })
+            ]
+        })
     },
     {
-        urlPattern: /\/_next\/image\?url=.+$/i,
-        handler: "StaleWhileRevalidate",
-        options: {
+        matcher: /\/_next\/image\?url=.+$/i,
+        handler: new StaleWhileRevalidate({
             cacheName: "next-image",
-            expiration: {
-                maxEntries: 64,
-                maxAgeSeconds: 24 * 60 * 60
-            }
-        }
+            plugins: [
+                new ExpirationPlugin({
+                    maxEntries: 64,
+                    maxAgeSeconds: 24 * 60 * 60
+                })
+            ]
+        })
     },
     {
-        urlPattern: /\.(?:mp3|wav|ogg)$/i,
-        handler: "CacheFirst",
-        options: {
-            rangeRequests: true,
+        matcher: /\.(?:mp3|wav|ogg)$/i,
+        handler: new CacheFirst({
             cacheName: "static-audio-assets",
-            expiration: {
-                maxEntries: 32,
-                maxAgeSeconds: 24 * 60 * 60
-            }
-        }
+            plugins: [
+                new ExpirationPlugin({
+                    maxEntries: 32,
+                    maxAgeSeconds: 24 * 60 * 60
+                }),
+                new RangeRequestsPlugin()
+            ]
+        })
     },
     {
-        urlPattern: /\.(?:mp4|webm)$/i,
-        handler: "CacheFirst",
-        options: {
-            rangeRequests: true,
+        matcher: /\.(?:mp4|webm)$/i,
+        handler: new CacheFirst({
             cacheName: "static-video-assets",
-            expiration: {
-                maxEntries: 32,
-                maxAgeSeconds: 24 * 60 * 60
-            }
-        }
+            plugins: [
+                new ExpirationPlugin({
+                    maxEntries: 32,
+                    maxAgeSeconds: 24 * 60 * 60
+                }),
+                new RangeRequestsPlugin()
+            ]
+        })
     },
     {
-        urlPattern: /\.(?:js)$/i,
-        handler: "StaleWhileRevalidate",
-        options: {
+        matcher: /\.(?:js)$/i,
+        handler: new StaleWhileRevalidate({
             cacheName: "static-js-assets",
-            expiration: {
-                maxEntries: 48,
-                maxAgeSeconds: 24 * 60 * 60
-            }
-        }
+            plugins: [
+                new ExpirationPlugin({
+                    maxEntries: 48,
+                    maxAgeSeconds: 24 * 60 * 60
+                })
+            ]
+        })
     },
     {
-        urlPattern: /\.(?:css|less)$/i,
-        handler: "StaleWhileRevalidate",
-        options: {
+        matcher: /\.(?:css|less)$/i,
+        handler: new StaleWhileRevalidate({
             cacheName: "static-style-assets",
-            expiration: {
-                maxEntries: 32,
-                maxAgeSeconds: 24 * 60 * 60
-            }
-        }
+            plugins: [
+                new ExpirationPlugin({
+                    maxEntries: 32,
+                    maxAgeSeconds: 24 * 60 * 60
+                })
+            ]
+        })
     },
     {
-        urlPattern: /\/_next\/data\/.+\/.+\.json$/i,
-        handler: "StaleWhileRevalidate",
-        options: {
+        matcher: /\/_next\/data\/.+\/.+\.json$/i,
+        handler: new NetworkFirst({
             cacheName: "next-data",
-            expiration: {
-                maxEntries: 32,
-                maxAgeSeconds: 24 * 60 * 60
-            }
-        }
+            plugins: [
+                new ExpirationPlugin({
+                    maxEntries: 32,
+                    maxAgeSeconds: 24 * 60 * 60
+                })
+            ]
+        })
     },
     {
-        urlPattern: /\.(?:json|xml|csv)$/i,
-        handler: "NetworkFirst",
-        options: {
+        matcher: /\.(?:json|xml|csv)$/i,
+        handler: new NetworkFirst({
             cacheName: "static-data-assets",
-            expiration: {
-                maxEntries: 32,
-                maxAgeSeconds: 24 * 60 * 60
-            }
-        }
+            plugins: [
+                new ExpirationPlugin({
+                    maxEntries: 32,
+                    maxAgeSeconds: 24 * 60 * 60
+                })
+            ]
+        })
     },
     {
-        urlPattern: ({ sameOrigin, url: { pathname } })=>{
-            // Exclude /api/auth/callback/* to fix OAuth workflow in Safari without having an impact on other environments
-            // The above route is the default for next-auth, you may need to change it if your OAuth workflow has a different callback route
-            // Issue: https://github.com/shadowwalker/next-pwa/issues/131#issuecomment-821894809
+        matcher: ({ sameOrigin, url: { pathname } })=>{
             if (!sameOrigin || pathname.startsWith("/api/auth/callback")) {
                 return false;
             }
@@ -174,72 +165,79 @@ const defaultCache = [
             }
             return false;
         },
-        handler: "NetworkFirst",
         method: "GET",
-        options: {
+        handler: new NetworkFirst({
             cacheName: "apis",
-            expiration: {
-                maxEntries: 16,
-                maxAgeSeconds: 24 * 60 * 60
-            },
+            plugins: [
+                new ExpirationPlugin({
+                    maxEntries: 16,
+                    maxAgeSeconds: 24 * 60 * 60
+                })
+            ],
             networkTimeoutSeconds: 10
-        }
-    },
-    ...definePageRuntimeCaching({
-        rscPrefetch: {
-            urlPattern: ({ request, url: { pathname }, sameOrigin })=>request.headers.get("RSC") === "1" && request.headers.get("Next-Router-Prefetch") === "1" && sameOrigin && !pathname.startsWith("/api/"),
-            handler: "NetworkFirst",
-            options: {
-                expiration: {
+        })
+    },
+    {
+        matcher: ({ request, url: { pathname }, sameOrigin })=>request.headers.get("RSC") === "1" && request.headers.get("Next-Router-Prefetch") === "1" && sameOrigin && !pathname.startsWith("/api/"),
+        handler: new NetworkFirst({
+            cacheName: PAGES_CACHE_NAME.rscPrefetch,
+            plugins: [
+                new ExpirationPlugin({
                     maxEntries: 32,
                     maxAgeSeconds: 24 * 60 * 60
-                }
-            }
-        },
-        rsc: {
-            urlPattern: ({ request, url: { pathname }, sameOrigin })=>request.headers.get("RSC") === "1" && sameOrigin && !pathname.startsWith("/api/"),
-            handler: "NetworkFirst",
-            options: {
-                expiration: {
+                })
+            ]
+        })
+    },
+    {
+        matcher: ({ request, url: { pathname }, sameOrigin })=>request.headers.get("RSC") === "1" && sameOrigin && !pathname.startsWith("/api/"),
+        handler: new NetworkFirst({
+            cacheName: PAGES_CACHE_NAME.rsc,
+            plugins: [
+                new ExpirationPlugin({
                     maxEntries: 32,
                     maxAgeSeconds: 24 * 60 * 60
-                }
-            }
-        },
-        html: {
-            urlPattern: ({ request, url: { pathname }, sameOrigin })=>request.headers.get("Content-Type")?.includes("text/html") && sameOrigin && !pathname.startsWith("/api/"),
-            handler: "NetworkFirst",
-            options: {
-                expiration: {
+                })
+            ]
+        })
+    },
+    {
+        matcher: ({ request, url: { pathname }, sameOrigin })=>request.headers.get("Content-Type")?.includes("text/html") && sameOrigin && !pathname.startsWith("/api/"),
+        handler: new NetworkFirst({
+            cacheName: PAGES_CACHE_NAME.html,
+            plugins: [
+                new ExpirationPlugin({
                     maxEntries: 32,
                     maxAgeSeconds: 24 * 60 * 60
-                }
-            }
-        }
-    }),
+                })
+            ]
+        })
+    },
     {
-        urlPattern: ({ url: { pathname }, sameOrigin })=>sameOrigin && !pathname.startsWith("/api/"),
-        handler: "NetworkFirst",
-        options: {
+        matcher: ({ url: { pathname }, sameOrigin })=>sameOrigin && !pathname.startsWith("/api/"),
+        handler: new NetworkFirst({
             cacheName: "others",
-            expiration: {
-                maxEntries: 32,
-                maxAgeSeconds: 24 * 60 * 60
-            }
-        }
+            plugins: [
+                new ExpirationPlugin({
+                    maxEntries: 32,
+                    maxAgeSeconds: 24 * 60 * 60
+                })
+            ]
+        })
     },
     {
-        urlPattern: ({ sameOrigin })=>!sameOrigin,
-        handler: "NetworkFirst",
-        options: {
+        matcher: ({ sameOrigin })=>!sameOrigin,
+        handler: new NetworkFirst({
             cacheName: "cross-origin",
-            expiration: {
-                maxEntries: 32,
-                maxAgeSeconds: 60 * 60
-            },
+            plugins: [
+                new ExpirationPlugin({
+                    maxEntries: 32,
+                    maxAgeSeconds: 60 * 60
+                })
+            ],
             networkTimeoutSeconds: 10
-        }
+        })
     }
 ];
 
-export { defaultCache, definePageRuntimeCaching };
+export { PAGES_CACHE_NAME, defaultCache };

package/dist/internal-types.d.ts

@@ -3,7 +3,7 @@ export type SerwistNextOptionsKey = "self.__SERWIST_SW_ENTRY";
 export interface SerwistNextOptions {
     sw: string;
     scope: string;
-    cacheOnFrontEndNav: boolean;
+    cacheOnNavigation: boolean;
     register: boolean;
     reloadOnOnline: boolean;
     swEntryWorker: string | undefined;

package/dist/internal-types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"internal-types.d.ts","sourceRoot":"","sources":["../src/internal-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAElD,MAAM,MAAM,qBAAqB,GAAG,yBAAyB,CAAC;AAE9D,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,kBAAkB,EAAE,OAAO,CAAC;IAC5B,QAAQ,EAAE,OAAO,CAAC;IAClB,cAAc,EAAE,OAAO,CAAC;IACxB,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;CACnC;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,KAAK,CAAC;IACb,WAAW,EAAE,WAAW,CAAC;CAC1B"}
+{"version":3,"file":"internal-types.d.ts","sourceRoot":"","sources":["../src/internal-types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAElD,MAAM,MAAM,qBAAqB,GAAG,yBAAyB,CAAC;AAE9D,MAAM,WAAW,kBAAkB;IACjC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,iBAAiB,EAAE,OAAO,CAAC;IAC3B,QAAQ,EAAE,OAAO,CAAC;IAClB,cAAc,EAAE,OAAO,CAAC;IACxB,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;CACnC;AAED,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,KAAK,CAAC;IACb,WAAW,EAAE,WAAW,CAAC;CAC1B"}

package/dist/sw-entry.js

@@ -11,8 +11,8 @@ if (typeof window !== "undefined" && "serviceWorker" in navigator && typeof cach
     if (self.__SERWIST_SW_ENTRY.register) {
         window.serwist.register();
     }
-    if (self.__SERWIST_SW_ENTRY.cacheOnFrontEndNav) {
-        const cacheOnFrontEndNav = async (url)=>{
+    if (self.__SERWIST_SW_ENTRY.cacheOnNavigation) {
+        const cacheOnNavigation = async (url)=>{
             if (!window.navigator.onLine || !url) {
                 return;
             }
@@ -24,15 +24,15 @@ if (typeof window !== "undefined" && "serviceWorker" in navigator && typeof cach
         const pushState = history.pushState;
         history.pushState = (...args)=>{
             pushState.apply(history, args);
-            cacheOnFrontEndNav(args[2]);
+            cacheOnNavigation(args[2]);
         };
         const replaceState = history.replaceState;
         history.replaceState = (...args)=>{
             replaceState.apply(history, args);
-            cacheOnFrontEndNav(args[2]);
+            cacheOnNavigation(args[2]);
         };
         window.addEventListener("online", ()=>{
-            cacheOnFrontEndNav(window.location.pathname);
+            cacheOnNavigation(window.location.pathname);
         });
     }
     if (self.__SERWIST_SW_ENTRY.reloadOnOnline) {

package/dist/worker/constants.d.ts

@@ -0,0 +1,6 @@
+export declare const PAGES_CACHE_NAME: {
+    readonly rscPrefetch: "pages-rsc-prefetch";
+    readonly rsc: "pages-rsc";
+    readonly html: "pages";
+};
+//# sourceMappingURL=constants.d.ts.map

package/dist/worker/constants.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../../src/worker/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,gBAAgB;;;;CAInB,CAAC"}

package/dist/worker/defaultCache.d.ts

@@ -1,3 +1,15 @@
-import type { RuntimeCaching } from "@serwist/sw";
-export declare const defaultCache: RuntimeCaching[];
+import { CacheFirst, NetworkFirst } from "@serwist/strategies";
+export declare const defaultCache: ({
+    matcher: RegExp;
+    handler: CacheFirst;
+    method?: undefined;
+} | {
+    matcher: ({ sameOrigin, url: { pathname } }: import("@serwist/core").RouteMatchCallbackOptions) => boolean;
+    method: "GET";
+    handler: NetworkFirst;
+} | {
+    matcher: ({ request, url: { pathname }, sameOrigin }: import("@serwist/core").RouteMatchCallbackOptions) => boolean | undefined;
+    handler: NetworkFirst;
+    method?: undefined;
+})[];
 //# sourceMappingURL=defaultCache.d.ts.map

package/dist/worker/defaultCache.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"defaultCache.d.ts","sourceRoot":"","sources":["../../src/worker/defaultCache.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAIlD,eAAO,MAAM,YAAY,kBA0NG,CAAC"}
+{"version":3,"file":"defaultCache.d.ts","sourceRoot":"","sources":["../../src/worker/defaultCache.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAwB,MAAM,qBAAqB,CAAC;AAMrF,eAAO,MAAM,YAAY;;;;;;;;;;;;IA6OG,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@serwist/next",
-  "version": "9.0.0-preview.0",
+  "version": "9.0.0-preview.10",
   "type": "module",
   "description": "A module that integrates Serwist into your Next.js application.",
   "files": [
@@ -12,8 +12,13 @@
     "serwistjs",
     "sw",
     "service worker",
+    "progressive web apps",
     "web",
-    "service-worker"
+    "service-worker",
+    "progressive-web-apps",
+    "next",
+    "next.js",
+    "pwa"
   ],
   "engines": {
     "node": ">=18.0.0"
@@ -50,32 +55,34 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "clean-webpack-plugin": "4.0.0",
-    "fast-glob": "3.3.2",
-    "@serwist/build": "9.0.0-preview.0",
-    "@serwist/core": "9.0.0-preview.0",
-    "@serwist/webpack-plugin": "9.0.0-preview.0",
-    "@serwist/window": "9.0.0-preview.0"
+    "chalk": "5.3.0",
+    "glob": "10.3.10",
+    "@serwist/build": "9.0.0-preview.10",
+    "@serwist/core": "9.0.0-preview.10",
+    "@serwist/expiration": "9.0.0-preview.10",
+    "@serwist/range-requests": "9.0.0-preview.10",
+    "@serwist/strategies": "9.0.0-preview.10",
+    "@serwist/webpack-plugin": "9.0.0-preview.10",
+    "@serwist/window": "9.0.0-preview.10"
   },
   "devDependencies": {
     "@types/node": "20.11.16",
-    "chalk": "5.3.0",
     "next": "14.1.0",
     "react": "18.2.0",
     "react-dom": "18.2.0",
     "rollup": "4.9.6",
     "type-fest": "4.10.2",
-    "typescript": "5.4.0-dev.20240203",
+    "typescript": "5.4.0-dev.20240206",
     "webpack": "5.90.1",
-    "@serwist/constants": "9.0.0-preview.0",
-    "@serwist/sw": "9.0.0-preview.0",
-    "@serwist/utils": "9.0.0-preview.0"
+    "@serwist/constants": "9.0.0-preview.10",
+    "@serwist/sw": "9.0.0-preview.10",
+    "@serwist/utils": "9.0.0-preview.10"
   },
   "peerDependencies": {
     "next": ">=14.0.0",
     "typescript": ">=5.0.0",
     "webpack": ">=5.9.0",
-    "@serwist/sw": "9.0.0-preview.0"
+    "@serwist/sw": "9.0.0-preview.10"
   },
   "peerDependenciesMeta": {
     "@serwist/sw": {