@serwist/next 9.0.0-preview.9 → 9.0.0

package/src/worker/defaultCache.ts

@@ -1,246 +1,269 @@
-import { ExpirationPlugin } from "@serwist/expiration";
-import { RangeRequestsPlugin } from "@serwist/range-requests";
-import { CacheFirst, NetworkFirst, StaleWhileRevalidate } from "@serwist/strategies";
-import type { RuntimeCaching } from "@serwist/sw";
+import type { RuntimeCaching } from "serwist";
+import { CacheFirst, ExpirationPlugin, NetworkFirst, RangeRequestsPlugin, StaleWhileRevalidate } from "serwist";
 
 import { PAGES_CACHE_NAME } from "./constants.js";
 
-// Serwist RuntimeCaching config: https://serwist.pages.dev/docs/sw/register-runtime-caching
-export const defaultCache = [
-  {
-    matcher: /^https:\/\/fonts\.(?:gstatic)\.com\/.*/i,
-    handler: new CacheFirst({
-      cacheName: "google-fonts-webfonts",
-      plugins: [
-        new ExpirationPlugin({
-          maxEntries: 4,
-          maxAgeSeconds: 365 * 24 * 60 * 60, // 365 days
-        }),
-      ],
-    }),
-  },
-  {
-    matcher: /^https:\/\/fonts\.(?:googleapis)\.com\/.*/i,
-    handler: new StaleWhileRevalidate({
-      cacheName: "google-fonts-stylesheets",
-      plugins: [
-        new ExpirationPlugin({
-          maxEntries: 4,
-          maxAgeSeconds: 7 * 24 * 60 * 60, // 7 days
-        }),
-      ],
-    }),
-  },
-  {
-    matcher: /\.(?:eot|otf|ttc|ttf|woff|woff2|font.css)$/i,
-    handler: new StaleWhileRevalidate({
-      cacheName: "static-font-assets",
-      plugins: [
-        new ExpirationPlugin({
-          maxEntries: 4,
-          maxAgeSeconds: 7 * 24 * 60 * 60, // 7 days
-        }),
-      ],
-    }),
-  },
-  {
-    matcher: /\.(?:jpg|jpeg|gif|png|svg|ico|webp)$/i,
-    handler: new StaleWhileRevalidate({
-      cacheName: "static-image-assets",
-      plugins: [
-        new ExpirationPlugin({
-          maxEntries: 64,
-          maxAgeSeconds: 30 * 24 * 60 * 60, // 30 days
-        }),
-      ],
-    }),
-  },
-  {
-    matcher: /\/_next\/static.+\.js$/i,
-    handler: new CacheFirst({
-      cacheName: "next-static-js-assets",
-      plugins: [
-        new ExpirationPlugin({
-          maxEntries: 64,
-          maxAgeSeconds: 24 * 60 * 60, // 24 hours
-        }),
-      ],
-    }),
-  },
-  {
-    matcher: /\/_next\/image\?url=.+$/i,
-    handler: new StaleWhileRevalidate({
-      cacheName: "next-image",
-      plugins: [
-        new ExpirationPlugin({
-          maxEntries: 64,
-          maxAgeSeconds: 24 * 60 * 60, // 24 hours
-        }),
-      ],
-    }),
-  },
-  {
-    matcher: /\.(?:mp3|wav|ogg)$/i,
-    handler: new CacheFirst({
-      cacheName: "static-audio-assets",
-      plugins: [
-        new ExpirationPlugin({
-          maxEntries: 32,
-          maxAgeSeconds: 24 * 60 * 60, // 24 hours
-        }),
-        new RangeRequestsPlugin(),
-      ],
-    }),
-  },
-  {
-    matcher: /\.(?:mp4|webm)$/i,
-    handler: new CacheFirst({
-      cacheName: "static-video-assets",
-      plugins: [
-        new ExpirationPlugin({
-          maxEntries: 32,
-          maxAgeSeconds: 24 * 60 * 60, // 24 hours
-        }),
-        new RangeRequestsPlugin(),
-      ],
-    }),
-  },
-  {
-    matcher: /\.(?:js)$/i,
-    handler: new StaleWhileRevalidate({
-      cacheName: "static-js-assets",
-      plugins: [
-        new ExpirationPlugin({
-          maxEntries: 48,
-          maxAgeSeconds: 24 * 60 * 60, // 24 hours
-        }),
-      ],
-    }),
-  },
-  {
-    matcher: /\.(?:css|less)$/i,
-    handler: new StaleWhileRevalidate({
-      cacheName: "static-style-assets",
-      plugins: [
-        new ExpirationPlugin({
-          maxEntries: 32,
-          maxAgeSeconds: 24 * 60 * 60, // 24 hours
-        }),
-      ],
-    }),
-  },
-  {
-    matcher: /\/_next\/data\/.+\/.+\.json$/i,
-    handler: new NetworkFirst({
-      cacheName: "next-data",
-      plugins: [
-        new ExpirationPlugin({
-          maxEntries: 32,
-          maxAgeSeconds: 24 * 60 * 60, // 24 hours
-        }),
-      ],
-    }),
-  },
-  {
-    matcher: /\.(?:json|xml|csv)$/i,
-    handler: new NetworkFirst({
-      cacheName: "static-data-assets",
-      plugins: [
-        new ExpirationPlugin({
-          maxEntries: 32,
-          maxAgeSeconds: 24 * 60 * 60, // 24 hours
-        }),
-      ],
-    }),
-  },
-  {
-    matcher: ({ 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
-      if (!sameOrigin || pathname.startsWith("/api/auth/callback")) {
-        return false;
-      }
+/**
+ * The default, recommended list of caching strategies for applications
+ * built with Next.js.
+ *
+ * @see https://serwist.pages.dev/docs/next/worker-exports#default-cache
+ */
+export const defaultCache: RuntimeCaching[] =
+  process.env.NODE_ENV !== "production"
+    ? []
+    : [
+        {
+          matcher: /^https:\/\/fonts\.(?:gstatic)\.com\/.*/i,
+          handler: new CacheFirst({
+            cacheName: "google-fonts-webfonts",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 4,
+                maxAgeSeconds: 365 * 24 * 60 * 60, // 365 days
+                maxAgeFrom: "last-used",
+              }),
+            ],
+          }),
+        },
+        {
+          matcher: /^https:\/\/fonts\.(?:googleapis)\.com\/.*/i,
+          handler: new StaleWhileRevalidate({
+            cacheName: "google-fonts-stylesheets",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 4,
+                maxAgeSeconds: 7 * 24 * 60 * 60, // 7 days
+                maxAgeFrom: "last-used",
+              }),
+            ],
+          }),
+        },
+        {
+          matcher: /\.(?:eot|otf|ttc|ttf|woff|woff2|font.css)$/i,
+          handler: new StaleWhileRevalidate({
+            cacheName: "static-font-assets",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 4,
+                maxAgeSeconds: 7 * 24 * 60 * 60, // 7 days
+                maxAgeFrom: "last-used",
+              }),
+            ],
+          }),
+        },
+        {
+          matcher: /\.(?:jpg|jpeg|gif|png|svg|ico|webp)$/i,
+          handler: new StaleWhileRevalidate({
+            cacheName: "static-image-assets",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 64,
+                maxAgeSeconds: 30 * 24 * 60 * 60, // 30 days
+                maxAgeFrom: "last-used",
+              }),
+            ],
+          }),
+        },
+        {
+          matcher: /\/_next\/static.+\.js$/i,
+          handler: new CacheFirst({
+            cacheName: "next-static-js-assets",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 64,
+                maxAgeSeconds: 24 * 60 * 60, // 24 hours
+                maxAgeFrom: "last-used",
+              }),
+            ],
+          }),
+        },
+        {
+          matcher: /\/_next\/image\?url=.+$/i,
+          handler: new StaleWhileRevalidate({
+            cacheName: "next-image",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 64,
+                maxAgeSeconds: 24 * 60 * 60, // 24 hours
+                maxAgeFrom: "last-used",
+              }),
+            ],
+          }),
+        },
+        {
+          matcher: /\.(?:mp3|wav|ogg)$/i,
+          handler: new CacheFirst({
+            cacheName: "static-audio-assets",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 32,
+                maxAgeSeconds: 24 * 60 * 60, // 24 hours
+                maxAgeFrom: "last-used",
+              }),
+              new RangeRequestsPlugin(),
+            ],
+          }),
+        },
+        {
+          matcher: /\.(?:mp4|webm)$/i,
+          handler: new CacheFirst({
+            cacheName: "static-video-assets",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 32,
+                maxAgeSeconds: 24 * 60 * 60, // 24 hours
+                maxAgeFrom: "last-used",
+              }),
+              new RangeRequestsPlugin(),
+            ],
+          }),
+        },
+        {
+          matcher: /\.(?:js)$/i,
+          handler: new StaleWhileRevalidate({
+            cacheName: "static-js-assets",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 48,
+                maxAgeSeconds: 24 * 60 * 60, // 24 hours
+                maxAgeFrom: "last-used",
+              }),
+            ],
+          }),
+        },
+        {
+          matcher: /\.(?:css|less)$/i,
+          handler: new StaleWhileRevalidate({
+            cacheName: "static-style-assets",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 32,
+                maxAgeSeconds: 24 * 60 * 60, // 24 hours
+                maxAgeFrom: "last-used",
+              }),
+            ],
+          }),
+        },
+        {
+          matcher: /\/_next\/data\/.+\/.+\.json$/i,
+          handler: new NetworkFirst({
+            cacheName: "next-data",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 32,
+                maxAgeSeconds: 24 * 60 * 60, // 24 hours
+                maxAgeFrom: "last-used",
+              }),
+            ],
+          }),
+        },
+        {
+          matcher: /\.(?:json|xml|csv)$/i,
+          handler: new NetworkFirst({
+            cacheName: "static-data-assets",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 32,
+                maxAgeSeconds: 24 * 60 * 60, // 24 hours
+                maxAgeFrom: "last-used",
+              }),
+            ],
+          }),
+        },
+        {
+          matcher: ({ 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
+            // TODO(ducanhgh): Investigate Auth.js's "/api/auth/*" failing when we allow them
+            // to be cached (the current behaviour).
+            if (!sameOrigin || pathname.startsWith("/api/auth/callback")) {
+              return false;
+            }
 
-      if (pathname.startsWith("/api/")) {
-        return true;
-      }
+            if (pathname.startsWith("/api/")) {
+              return true;
+            }
 
-      return false;
-    },
-    method: "GET",
-    handler: new NetworkFirst({
-      cacheName: "apis",
-      plugins: [
-        new ExpirationPlugin({
-          maxEntries: 16,
-          maxAgeSeconds: 24 * 60 * 60, // 24 hours
-        }),
-      ],
-      networkTimeoutSeconds: 10, // fallback to cache if API does not response within 10 seconds
-    }),
-  },
-  {
-    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, // 24 hours
-        }),
-      ],
-    }),
-  },
-  {
-    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, // 24 hours
-        }),
-      ],
-    }),
-  },
-  {
-    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, // 24 hours
-        }),
-      ],
-    }),
-  },
-  {
-    matcher: ({ url: { pathname }, sameOrigin }) => sameOrigin && !pathname.startsWith("/api/"),
-    handler: new NetworkFirst({
-      cacheName: "others",
-      plugins: [
-        new ExpirationPlugin({
-          maxEntries: 32,
-          maxAgeSeconds: 24 * 60 * 60, // 24 hours
-        }),
-      ],
-    }),
-  },
-  {
-    matcher: ({ sameOrigin }) => !sameOrigin,
-    handler: new NetworkFirst({
-      cacheName: "cross-origin",
-      plugins: [
-        new ExpirationPlugin({
-          maxEntries: 32,
-          maxAgeSeconds: 60 * 60, // 1 hour
-        }),
-      ],
-      networkTimeoutSeconds: 10,
-    }),
-  },
-] satisfies RuntimeCaching[];
+            return false;
+          },
+          method: "GET",
+          handler: new NetworkFirst({
+            cacheName: "apis",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 16,
+                maxAgeSeconds: 24 * 60 * 60, // 24 hours
+                maxAgeFrom: "last-used",
+              }),
+            ],
+            networkTimeoutSeconds: 10, // fallback to cache if API does not response within 10 seconds
+          }),
+        },
+        {
+          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, // 24 hours
+              }),
+            ],
+          }),
+        },
+        {
+          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, // 24 hours
+              }),
+            ],
+          }),
+        },
+        {
+          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, // 24 hours
+              }),
+            ],
+          }),
+        },
+        {
+          matcher: ({ url: { pathname }, sameOrigin }) => sameOrigin && !pathname.startsWith("/api/"),
+          handler: new NetworkFirst({
+            cacheName: "others",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 32,
+                maxAgeSeconds: 24 * 60 * 60, // 24 hours
+              }),
+            ],
+          }),
+        },
+        {
+          matcher: ({ sameOrigin }) => !sameOrigin,
+          handler: new NetworkFirst({
+            cacheName: "cross-origin",
+            plugins: [
+              new ExpirationPlugin({
+                maxEntries: 32,
+                maxAgeSeconds: 60 * 60, // 1 hour
+              }),
+            ],
+            networkTimeoutSeconds: 10,
+          }),
+        },
+      ];

package/dist/utils/find-first-truthy.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"find-first-truthy.d.ts","sourceRoot":"","sources":["../../src/utils/find-first-truthy.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,eAAO,MAAM,eAAe,mEAQ3B,CAAC"}

package/dist/utils/get-content-hash.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"get-content-hash.d.ts","sourceRoot":"","sources":["../../src/utils/get-content-hash.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,MAAM,SAAS,CAAC;AAI9B,eAAO,MAAM,cAAc,SAAU,GAAG,oBAAoB,SAAS,OAAO,WAK3E,CAAC"}

package/dist/utils/get-file-hash.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"get-file-hash.d.ts","sourceRoot":"","sources":["../../src/utils/get-file-hash.ts"],"names":[],"mappings":";AACA,OAAO,EAAE,MAAM,SAAS,CAAC;AAEzB,eAAO,MAAM,WAAW,SAAU,GAAG,oBAAoB,WAAyE,CAAC"}

package/dist/utils/get-package-version.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"get-package-version.d.ts","sourceRoot":"","sources":["../../src/utils/get-package-version.ts"],"names":[],"mappings":"AAIA;;;;GAIG;AACH,eAAO,MAAM,iBAAiB,gBAAiB,MAAM,KAAG,MAAM,GAAG,SAMhE,CAAC"}

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

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,KAAK,MAAM,MAAM,aAAa,CAAC"}

package/dist/utils/load-tsconfig.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"load-tsconfig.d.ts","sourceRoot":"","sources":["../../src/utils/load-tsconfig.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,YAAY,IAAI,YAAY,EAAE,MAAM,WAAW,CAAC;AAI9D,eAAO,MAAM,YAAY,YAAa,MAAM,wBAAwB,MAAM,GAAG,SAAS,KAAG,YAAY,GAAG,SAmBvG,CAAC"}

package/dist/utils/logger.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"logger.d.ts","sourceRoot":"","sources":["../../src/utils/logger.ts"],"names":[],"mappings":"AAsCA,eAAO,MAAM,IAAI,eAAgB,GAAG,EAAE,SAErC,CAAC;AAEF,eAAO,MAAM,KAAK,eAAgB,GAAG,EAAE,SAEtC,CAAC;AAEF,eAAO,MAAM,IAAI,eAAgB,GAAG,EAAE,SAErC,CAAC;AAEF,eAAO,MAAM,IAAI,eAAgB,GAAG,EAAE,SAErC,CAAC;AAEF,eAAO,MAAM,KAAK,eAAgB,GAAG,EAAE,SAEtC,CAAC"}