@vite-pwa/vitepress 0.2.1 → 0.2.3

package/dist/index.cjs

@@ -80,12 +80,44 @@ function withUserConfig(config) {
     }
     return head;
   };
+  let allowlist;
+  if (pwa.strategies !== "injectManifest" && pwa.experimental?.includeAllowlist === true) {
+    pwa.workbox = pwa.workbox ?? {};
+    allowlist = pwa.workbox.navigateFallbackAllowlist = pwa.workbox.navigateFallbackAllowlist ?? [];
+    pwa.workbox.runtimeCaching = pwa.workbox.runtimeCaching ?? [];
+    pwa.workbox.runtimeCaching.push({
+      urlPattern: ({ request, sameOrigin }) => {
+        return sameOrigin && request.mode === "navigate";
+      },
+      handler: "NetworkOnly",
+      options: {
+        plugins: [{
+          /* this callback will be called when the fetch call fails */
+          handlerDidError: async () => Response.redirect("404", 302),
+          /* this callback will prevent caching the response */
+          cacheWillUpdate: async () => null
+        }]
+      }
+    });
+  }
   vitePressConfig.buildEnd = async (siteConfig) => {
     await userBuildEnd?.(siteConfig);
-    api && !api.disabled && await api.generateSW();
+    if (api && !api.disabled) {
+      if (typeof allowlist !== "undefined") {
+        const base = siteConfig.site.base ?? "/";
+        for (const page of siteConfig.pages) {
+          const regex = page === "index.md" ? escapeStringRegexp(base) : escapeStringRegexp(`${base}${page.replace(/\.md$/, "")}`);
+          allowlist.push(new RegExp(`^${regex}(\\.html)?$`));
+        }
+      }
+      await api.generateSW();
+    }
   };
   return vitePressConfig;
 }
+function escapeStringRegexp(value) {
+  return value.replace(/[|\\{}()[\]^$+*?.]/g, "\\$&").replace(/-/g, "\\x2d");
+}
 
 async function withPwa(config) {
   if (typeof config === "function") {

package/dist/index.d.cts

@@ -4,6 +4,16 @@ import { DefaultTheme, UserConfigExport } from 'vitepress';
 import { VitePWAOptions } from 'vite-plugin-pwa';
 
 interface PwaOptions extends Partial<VitePWAOptions> {
+    experimental?: {
+        /**
+         * When using `generateSW` strategy, include the logic to handle the `workbox.navigateFallbackAllowlist` option.
+         *
+         * @see https://github.com/vite-pwa/vitepress/issues/22
+         *
+         * @default false
+         */
+        includeAllowlist?: boolean;
+    };
 }
 declare module 'vitepress' {
     interface UserConfig {

package/dist/index.d.mts

@@ -4,6 +4,16 @@ import { DefaultTheme, UserConfigExport } from 'vitepress';
 import { VitePWAOptions } from 'vite-plugin-pwa';
 
 interface PwaOptions extends Partial<VitePWAOptions> {
+    experimental?: {
+        /**
+         * When using `generateSW` strategy, include the logic to handle the `workbox.navigateFallbackAllowlist` option.
+         *
+         * @see https://github.com/vite-pwa/vitepress/issues/22
+         *
+         * @default false
+         */
+        includeAllowlist?: boolean;
+    };
 }
 declare module 'vitepress' {
     interface UserConfig {

package/dist/index.d.ts

@@ -4,6 +4,16 @@ import { DefaultTheme, UserConfigExport } from 'vitepress';
 import { VitePWAOptions } from 'vite-plugin-pwa';
 
 interface PwaOptions extends Partial<VitePWAOptions> {
+    experimental?: {
+        /**
+         * When using `generateSW` strategy, include the logic to handle the `workbox.navigateFallbackAllowlist` option.
+         *
+         * @see https://github.com/vite-pwa/vitepress/issues/22
+         *
+         * @default false
+         */
+        includeAllowlist?: boolean;
+    };
 }
 declare module 'vitepress' {
     interface UserConfig {

package/dist/index.mjs

@@ -78,12 +78,44 @@ function withUserConfig(config) {
     }
     return head;
   };
+  let allowlist;
+  if (pwa.strategies !== "injectManifest" && pwa.experimental?.includeAllowlist === true) {
+    pwa.workbox = pwa.workbox ?? {};
+    allowlist = pwa.workbox.navigateFallbackAllowlist = pwa.workbox.navigateFallbackAllowlist ?? [];
+    pwa.workbox.runtimeCaching = pwa.workbox.runtimeCaching ?? [];
+    pwa.workbox.runtimeCaching.push({
+      urlPattern: ({ request, sameOrigin }) => {
+        return sameOrigin && request.mode === "navigate";
+      },
+      handler: "NetworkOnly",
+      options: {
+        plugins: [{
+          /* this callback will be called when the fetch call fails */
+          handlerDidError: async () => Response.redirect("404", 302),
+          /* this callback will prevent caching the response */
+          cacheWillUpdate: async () => null
+        }]
+      }
+    });
+  }
   vitePressConfig.buildEnd = async (siteConfig) => {
     await userBuildEnd?.(siteConfig);
-    api && !api.disabled && await api.generateSW();
+    if (api && !api.disabled) {
+      if (typeof allowlist !== "undefined") {
+        const base = siteConfig.site.base ?? "/";
+        for (const page of siteConfig.pages) {
+          const regex = page === "index.md" ? escapeStringRegexp(base) : escapeStringRegexp(`${base}${page.replace(/\.md$/, "")}`);
+          allowlist.push(new RegExp(`^${regex}(\\.html)?$`));
+        }
+      }
+      await api.generateSW();
+    }
   };
   return vitePressConfig;
 }
+function escapeStringRegexp(value) {
+  return value.replace(/[|\\{}()[\]^$+*?.]/g, "\\$&").replace(/-/g, "\\x2d");
+}
 
 async function withPwa(config) {
   if (typeof config === "function") {

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@vite-pwa/vitepress",
   "type": "module",
-  "version": "0.2.1",
-  "packageManager": "pnpm@8.7.4",
+  "version": "0.2.3",
+  "packageManager": "pnpm@8.9.0",
   "description": "Zero-config PWA for VitePress",
   "author": "antfu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -66,4 +66,4 @@
       ]
     }
   }
-}
+}