@vite-pwa/nuxt 1.0.0 → 1.0.3

package/dist/chunks/pwa-icons.mjs

@@ -3,7 +3,7 @@ import { resolve, relative, basename } from 'node:path';
 import process from 'node:process';
 import { instructions } from '@vite-pwa/assets-generator/api/instructions';
 import { loadConfig } from '@vite-pwa/assets-generator/config';
-import { p as pwaIcons, g as generatePwaImageType } from '../shared/nuxt.4b59a78c.mjs';
+import { p as pwaIcons, g as generatePwaImageType } from '../shared/nuxt.73bdad2b.mjs';
 import '@nuxt/kit';
 import 'vite-plugin-pwa';
 import 'node:crypto';

package/dist/module.d.mts

@@ -1,6 +1,6 @@
 import * as _nuxt_schema from '@nuxt/schema';
 import { HookResult } from '@nuxt/schema';
-import { VitePWAOptions } from 'vite-plugin-pwa';
+import { VitePWAOptions, ResolvedVitePWAOptions } from 'vite-plugin-pwa';
 
 interface ClientOptions {
     /**
@@ -23,6 +23,45 @@ interface ClientOptions {
     installPrompt?: boolean | string;
 }
 interface PwaModuleOptions extends Partial<VitePWAOptions> {
+    /**
+     * Experimental features.
+     */
+    experimental?: {
+        /**
+         * NOTE: this option will be ignored if using the `injectManifest` strategy or when Nuxt experimental payload
+         * extraction is disabled.
+         *
+         * Enable custom runtime caching to resolve the payload.json requests with query parameters when offline:
+         * - Workbox doesn't allow to configure `precacheAndRoute` `urlManipulation` option when using the `generateSW` strategy.
+         * - Nuxt SSG will generate a payload.json file and will fetch it with a query parameter.
+         * - The service worker cannot resolve the payload.json request with query parameters, and you won't get the payload when offline.
+         *
+         * Enabling this option will add a custom runtime caching handler to the service worker to resolve the payload files
+         * with query parameters when offline: the runtime caching handler will redirect to the payload.json file without
+         * query parameters when the original request fails.
+         *
+         * If you're using `injectManifest` strategy, you can fix the issue in your custom service worker adding the
+         * following `urlManipulation` callback to the `precacheAndRouter` call:
+         * ```ts
+         * // self.__WB_MANIFEST is the default injection point
+         * precacheAndRoute(
+         *   self.__WB_MANIFEST,
+         *   {
+         *     urlManipulation: ({ url }) => {
+         *       const urls: URL[] = []
+         *       if (url.pathname.endsWith('_payload.json')) {
+         *         const newUrl = new URL(url.href)
+         *         newUrl.search = ''
+         *         urls.push(newUrl)
+         *       }
+         *       return urls
+         *     }
+         *   }
+         * )
+         * ```
+         */
+        enableWorkboxPayloadQueryParams?: true;
+    };
     registerWebManifestInRouteRules?: boolean;
     /**
      * Writes the plugin to disk: defaults to false (debug).
@@ -33,9 +72,14 @@ interface PwaModuleOptions extends Partial<VitePWAOptions> {
      */
     client?: ClientOptions;
 }
+interface PwaModuleHooks {
+    'pwa:beforeBuildServiceWorker': (options: ResolvedVitePWAOptions) => HookResult;
+}
 
 interface ModuleOptions extends PwaModuleOptions {
 }
+interface ModuleHooks extends PwaModuleHooks {
+}
 interface ModuleRuntimeHooks {
     /**
      * Emitted when the service worker is registered
@@ -63,4 +107,4 @@ interface ModuleRuntimeHooks {
 }
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
 
-export { type ClientOptions, type ModuleOptions, type ModuleRuntimeHooks, type PwaModuleOptions, _default as default };
+export { type ClientOptions, type ModuleHooks, type ModuleOptions, type ModuleRuntimeHooks, type PwaModuleHooks, type PwaModuleOptions, _default as default };

package/dist/module.d.ts

@@ -1,6 +1,6 @@
 import * as _nuxt_schema from '@nuxt/schema';
 import { HookResult } from '@nuxt/schema';
-import { VitePWAOptions } from 'vite-plugin-pwa';
+import { VitePWAOptions, ResolvedVitePWAOptions } from 'vite-plugin-pwa';
 
 interface ClientOptions {
     /**
@@ -23,6 +23,45 @@ interface ClientOptions {
     installPrompt?: boolean | string;
 }
 interface PwaModuleOptions extends Partial<VitePWAOptions> {
+    /**
+     * Experimental features.
+     */
+    experimental?: {
+        /**
+         * NOTE: this option will be ignored if using the `injectManifest` strategy or when Nuxt experimental payload
+         * extraction is disabled.
+         *
+         * Enable custom runtime caching to resolve the payload.json requests with query parameters when offline:
+         * - Workbox doesn't allow to configure `precacheAndRoute` `urlManipulation` option when using the `generateSW` strategy.
+         * - Nuxt SSG will generate a payload.json file and will fetch it with a query parameter.
+         * - The service worker cannot resolve the payload.json request with query parameters, and you won't get the payload when offline.
+         *
+         * Enabling this option will add a custom runtime caching handler to the service worker to resolve the payload files
+         * with query parameters when offline: the runtime caching handler will redirect to the payload.json file without
+         * query parameters when the original request fails.
+         *
+         * If you're using `injectManifest` strategy, you can fix the issue in your custom service worker adding the
+         * following `urlManipulation` callback to the `precacheAndRouter` call:
+         * ```ts
+         * // self.__WB_MANIFEST is the default injection point
+         * precacheAndRoute(
+         *   self.__WB_MANIFEST,
+         *   {
+         *     urlManipulation: ({ url }) => {
+         *       const urls: URL[] = []
+         *       if (url.pathname.endsWith('_payload.json')) {
+         *         const newUrl = new URL(url.href)
+         *         newUrl.search = ''
+         *         urls.push(newUrl)
+         *       }
+         *       return urls
+         *     }
+         *   }
+         * )
+         * ```
+         */
+        enableWorkboxPayloadQueryParams?: true;
+    };
     registerWebManifestInRouteRules?: boolean;
     /**
      * Writes the plugin to disk: defaults to false (debug).
@@ -33,9 +72,14 @@ interface PwaModuleOptions extends Partial<VitePWAOptions> {
      */
     client?: ClientOptions;
 }
+interface PwaModuleHooks {
+    'pwa:beforeBuildServiceWorker': (options: ResolvedVitePWAOptions) => HookResult;
+}
 
 interface ModuleOptions extends PwaModuleOptions {
 }
+interface ModuleHooks extends PwaModuleHooks {
+}
 interface ModuleRuntimeHooks {
     /**
      * Emitted when the service worker is registered
@@ -63,4 +107,4 @@ interface ModuleRuntimeHooks {
 }
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
 
-export { type ClientOptions, type ModuleOptions, type ModuleRuntimeHooks, type PwaModuleOptions, _default as default };
+export { type ClientOptions, type ModuleHooks, type ModuleOptions, type ModuleRuntimeHooks, type PwaModuleHooks, type PwaModuleOptions, _default as default };

package/dist/module.json

@@ -5,7 +5,7 @@
     "nuxt": ">=3.6.5",
     "bridge": false
   },
-  "version": "1.0.0",
+  "version": "1.0.3",
   "builder": {
     "@nuxt/module-builder": "0.8.3",
     "unbuild": "2.0.0"

package/dist/module.mjs

@@ -1,5 +1,5 @@
 import '@nuxt/kit';
-export { m as default } from './shared/nuxt.4b59a78c.mjs';
+export { m as default } from './shared/nuxt.73bdad2b.mjs';
 import 'node:fs/promises';
 import 'node:path';
 import 'vite-plugin-pwa';

package/dist/shared/{nuxt.4b59a78c.mjs → nuxt.73bdad2b.mjs}

@@ -6,7 +6,7 @@ import { createHash } from 'node:crypto';
 import { createReadStream } from 'node:fs';
 import { resolve } from 'pathe';
 
-const version = "1.0.0";
+const version = "1.0.3";
 
 function configurePWAOptions(nuxt3_8, options, nuxt, nitroConfig) {
   if (!options.outDir) {
@@ -20,6 +20,7 @@ function configurePWAOptions(nuxt3_8, options, nuxt, nitroConfig) {
     options.injectManifest = options.injectManifest ?? {};
     config = options.injectManifest;
   } else {
+    options.strategies = "generateSW";
     options.workbox = options.workbox ?? {};
     if (options.registerType === "autoUpdate" && (options.client?.registerPlugin || options.injectRegister === "script" || options.injectRegister === "inline")) {
       options.workbox.clientsClaim = true;
@@ -46,6 +47,25 @@ function configurePWAOptions(nuxt3_8, options, nuxt, nitroConfig) {
     if (enableGlobPatterns) {
       config.globPatterns = config.globPatterns ?? [];
       config.globPatterns.push("**/_payload.json");
+      if (options.strategies === "generateSW" && options.experimental?.enableWorkboxPayloadQueryParams) {
+        options.workbox.runtimeCaching = options.workbox.runtimeCaching ?? [];
+        options.workbox.runtimeCaching.push({
+          urlPattern: /\/_payload\.json\?/,
+          handler: "NetworkOnly",
+          options: {
+            plugins: [{
+              /* this callback will be called when the fetch call fails */
+              handlerDidError: async ({ request }) => {
+                const url = new URL(request.url);
+                url.search = "";
+                return Response.redirect(url.href, 302);
+              },
+              /* this callback will prevent caching the response */
+              cacheWillUpdate: async () => null
+            }]
+          }
+        });
+      }
     }
   }
   let appManifestFolder;
@@ -63,6 +83,18 @@ function configurePWAOptions(nuxt3_8, options, nuxt, nitroConfig) {
       outDir: options.outDir
     };
   }
+  const integration = options.integration ?? {};
+  const {
+    beforeBuildServiceWorker: original,
+    ...rest
+  } = integration;
+  options.integration = {
+    ...rest,
+    async beforeBuildServiceWorker(resolvedPwaOptions) {
+      await original?.(resolvedPwaOptions);
+      await nuxt.callHook("pwa:beforeBuildServiceWorker", resolvedPwaOptions);
+    }
+  };
 }
 function createManifestTransform(base, publicFolder, appManifestFolder) {
   return async (entries) => {

package/dist/types.d.mts

@@ -1,7 +1,15 @@
-import type { ModuleRuntimeHooks } from './module.js'
+import type { ModuleHooks, ModuleRuntimeHooks } from './module.js'
 
 declare module '#app' {
   interface RuntimeNuxtHooks extends ModuleRuntimeHooks {}
 }
 
-export { type ClientOptions, type ModuleOptions, type ModuleRuntimeHooks, type PwaModuleOptions, default } from './module.js'
+declare module '@nuxt/schema' {
+  interface NuxtHooks extends ModuleHooks {}
+}
+
+declare module 'nuxt/schema' {
+  interface NuxtHooks extends ModuleHooks {}
+}
+
+export { type ClientOptions, type ModuleHooks, type ModuleOptions, type ModuleRuntimeHooks, type PwaModuleHooks, type PwaModuleOptions, default } from './module.js'

package/dist/types.d.ts

@@ -1,7 +1,15 @@
-import type { ModuleRuntimeHooks } from './module'
+import type { ModuleHooks, ModuleRuntimeHooks } from './module'
 
 declare module '#app' {
   interface RuntimeNuxtHooks extends ModuleRuntimeHooks {}
 }
 
-export { type ClientOptions, type ModuleOptions, type ModuleRuntimeHooks, type PwaModuleOptions, default } from './module'
+declare module '@nuxt/schema' {
+  interface NuxtHooks extends ModuleHooks {}
+}
+
+declare module 'nuxt/schema' {
+  interface NuxtHooks extends ModuleHooks {}
+}
+
+export { type ClientOptions, type ModuleHooks, type ModuleOptions, type ModuleRuntimeHooks, type PwaModuleHooks, type PwaModuleOptions, default } from './module'

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@vite-pwa/nuxt",
   "type": "module",
-  "version": "1.0.0",
-  "packageManager": "pnpm@10.7.0",
+  "version": "1.0.3",
+  "packageManager": "pnpm@10.11.0",
   "description": "Zero-config PWA for Nuxt 3",
   "author": "antfu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -113,4 +113,4 @@
   "stackblitz": {
     "startCommand": "nr prepack && nr dev:prepare && nr dev"
   }
-}
+}