@vite-pwa/nuxt 0.2.3 → 0.3.1

package/dist/module.d.mts

@@ -0,0 +1,49 @@
+import * as _nuxt_schema from '@nuxt/schema';
+import { VitePWAOptions } from 'vite-plugin-pwa';
+
+interface ClientOptions {
+    /**
+     * Exposes the plugin: defaults to true.
+     */
+    registerPlugin?: boolean;
+    /**
+     * Registers a periodic sync for updates interval: value in seconds.
+     */
+    periodicSyncForUpdates?: number;
+    /**
+     * Will prevent showing native PWA install prompt: defaults to false.
+     *
+     * When set to true or no empty string, the native PWA install prompt will be prevented.
+     *
+     * When set to a string, it will be used as the key in `localStorage` to prevent show the PWA install prompt widget.
+     *
+     * When set to true, the key used will be `vite-pwa:hide-install`.
+     */
+    installPrompt?: boolean | string;
+}
+interface PwaModuleOptions extends Partial<VitePWAOptions> {
+    registerWebManifestInRouteRules?: boolean;
+    /**
+     * Writes the plugin to disk: defaults to false (debug).
+     */
+    writePlugin?: boolean;
+    /**
+     * Options for plugin.
+     */
+    client?: ClientOptions;
+}
+
+declare const _default: _nuxt_schema.NuxtModule<PwaModuleOptions>;
+
+interface ModuleOptions extends PwaModuleOptions {
+}
+declare module '@nuxt/schema' {
+    interface NuxtConfig {
+        ['vuetify']?: Partial<ModuleOptions>;
+    }
+    interface NuxtOptions {
+        ['vuetify']?: ModuleOptions;
+    }
+}
+
+export { type ClientOptions, type ModuleOptions, type PwaModuleOptions, _default as default };

package/dist/module.d.ts

@@ -21,7 +21,7 @@ interface ClientOptions {
      */
     installPrompt?: boolean | string;
 }
-interface ModuleOptions extends Partial<VitePWAOptions> {
+interface PwaModuleOptions extends Partial<VitePWAOptions> {
     registerWebManifestInRouteRules?: boolean;
     /**
      * Writes the plugin to disk: defaults to false (debug).
@@ -33,6 +33,17 @@ interface ModuleOptions extends Partial<VitePWAOptions> {
     client?: ClientOptions;
 }
 
-declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
+declare const _default: _nuxt_schema.NuxtModule<PwaModuleOptions>;
 
-export { ClientOptions, ModuleOptions, _default as default };
+interface ModuleOptions extends PwaModuleOptions {
+}
+declare module '@nuxt/schema' {
+    interface NuxtConfig {
+        ['vuetify']?: Partial<ModuleOptions>;
+    }
+    interface NuxtOptions {
+        ['vuetify']?: ModuleOptions;
+    }
+}
+
+export { type ClientOptions, type ModuleOptions, type PwaModuleOptions, _default as default };

package/dist/module.json

@@ -1,5 +1,9 @@
 {
   "name": "pwa",
   "configKey": "pwa",
-  "version": "0.2.3"
+  "compatibility": {
+    "nuxt": "^3.6.5",
+    "bridge": false
+  },
+  "version": "0.3.1"
 }

package/dist/module.mjs

@@ -1,10 +1,12 @@
 import { join } from 'node:path';
 import { writeFile, mkdir } from 'node:fs/promises';
-import { defineNuxtModule, createResolver, addPlugin, addComponent, extendWebpackConfig } from '@nuxt/kit';
+import { defineNuxtModule, createResolver, getNuxtVersion, addPlugin, addComponent, extendWebpackConfig } from '@nuxt/kit';
 import { VitePWA } from 'vite-plugin-pwa';
 import { resolve } from 'pathe';
 
-function configurePWAOptions(options, nuxt, nitroConfig) {
+const version = "0.3.1";
+
+function configurePWAOptions(nuxt3_8, options, nuxt, nitroConfig) {
   if (!options.outDir) {
     const publicDir = nitroConfig.output?.publicDir ?? nuxt.options.nitro?.output?.publicDir;
     options.outDir = publicDir ? resolve(publicDir) : resolve(nuxt.options.buildDir, "../.output/public");
@@ -30,10 +32,25 @@ function configurePWAOptions(options, nuxt, nitroConfig) {
       options.workbox.navigateFallback = nuxt.options.app.baseURL ?? "/";
     config = options.workbox;
   }
+  if (nuxt.options.experimental.payloadExtraction) {
+    config.globPatterns = config.globPatterns ?? [];
+    config.globPatterns.push("**/_payload.json");
+  }
+  let appManifestFolder;
+  if (nuxt3_8 && nuxt.options.experimental.appManifest) {
+    config.globPatterns = config.globPatterns ?? [];
+    appManifestFolder = nuxt.options.app.buildAssetsDir ?? "_nuxt/";
+    if (appManifestFolder[0] === "/")
+      appManifestFolder = appManifestFolder.slice(1);
+    if (appManifestFolder[appManifestFolder.length - 1] !== "/")
+      appManifestFolder += "/";
+    appManifestFolder += "builds/";
+    config.globPatterns.push(`${appManifestFolder}**/*.json`);
+  }
   if (!nuxt.options.dev && !config.manifestTransforms)
-    config.manifestTransforms = [createManifestTransform(nuxt.options.app.baseURL ?? "/")];
+    config.manifestTransforms = [createManifestTransform(nuxt.options.app.baseURL ?? "/", appManifestFolder)];
 }
-function createManifestTransform(base) {
+function createManifestTransform(base, appManifestFolder) {
   return async (entries) => {
     entries.filter((e) => e && e.url.endsWith(".html")).forEach((e) => {
       const url = e.url.startsWith("/") ? e.url.slice(1) : e.url;
@@ -45,11 +62,17 @@ function createManifestTransform(base) {
         e.url = parts.length > 1 ? parts.slice(0, parts.length - 1).join("/") : parts[0];
       }
     });
+    if (appManifestFolder) {
+      const regExp = /(\/)?[0-9a-f]{8}\b-[0-9a-f]{4}\b-[0-9a-f]{4}\b-[0-9a-f]{4}\b-[0-9a-f]{12}\.json$/i;
+      entries.filter((e) => e && e.url.startsWith(appManifestFolder) && regExp.test(e.url)).forEach((e) => {
+        e.revision = null;
+      });
+    }
     return { manifest: entries, warnings: [] };
   };
 }
 
-async function regeneratePWA(dir, api) {
+async function regeneratePWA(_dir, api) {
   if (!api || api.disabled)
     return;
   await api.generateSW();
@@ -63,7 +86,12 @@ async function writeWebManifest(dir, path, api) {
 const module = defineNuxtModule({
   meta: {
     name: "pwa",
-    configKey: "pwa"
+    configKey: "pwa",
+    compatibility: {
+      nuxt: "^3.6.5",
+      bridge: false
+    },
+    version
   },
   defaults: (nuxt) => ({
     base: nuxt.options.app.baseURL,
@@ -80,6 +108,8 @@ const module = defineNuxtModule({
   }),
   async setup(options, nuxt) {
     const resolver = createResolver(import.meta.url);
+    const nuxtVersion = getNuxtVersion(nuxt).split(".").map((v) => Number.parseInt(v));
+    const nuxt3_8 = nuxtVersion.length > 1 && (nuxtVersion[0] > 3 || nuxtVersion[0] === 3 && nuxtVersion[1] >= 8);
     let vitePwaClientPlugin;
     const resolveVitePluginPWAAPI = () => {
       return vitePwaClientPlugin?.api;
@@ -99,11 +129,19 @@ const module = defineNuxtModule({
         mode: "client"
       });
     }
-    await addComponent({
-      name: "VitePwaManifest",
-      filePath: resolver.resolve(runtimeDir, "components/VitePwaManifest")
-    });
+    await Promise.all([
+      addComponent({
+        name: "VitePwaManifest",
+        filePath: resolver.resolve(runtimeDir, "components/VitePwaManifest")
+      }),
+      addComponent({
+        name: "NuxtPwaManifest",
+        filePath: resolver.resolve(runtimeDir, "components/VitePwaManifest")
+      })
+    ]);
     nuxt.hook("prepare:types", ({ references }) => {
+      const types = resolver.resolve(runtimeDir, "plugins/types");
+      references.push({ path: resolver.resolve(nuxt.options.buildDir, types) });
       references.push({ types: "@vite-pwa/nuxt/configuration" });
       references.push({ types: "vite-plugin-pwa/vue" });
       references.push({ types: "vite-plugin-pwa/info" });
@@ -115,7 +153,7 @@ const module = defineNuxtModule({
       maxAge: 0
     });
     nuxt.hook("nitro:init", (nitro) => {
-      configurePWAOptions(options, nuxt, nitro.options);
+      configurePWAOptions(nuxt3_8, options, nuxt, nitro.options);
     });
     nuxt.hook("vite:extend", ({ config }) => {
       const plugin = config.plugins?.find((p) => p && typeof p === "object" && "name" in p && p.name === "vite-plugin-pwa");
@@ -222,21 +260,30 @@ export const periodicSyncForUpdates = ${typeof client.periodicSyncForUpdates ===
           }
         });
       }
-      nuxt.hook("nitro:init", (nitro) => {
-        nitro.hooks.hook("rollup:before", async () => {
+      if (nuxt3_8) {
+        nuxt.hook("nitro:build:public-assets", async () => {
           await regeneratePWA(
             options.outDir,
             resolveVitePluginPWAAPI()
           );
         });
-      });
-      if (nuxt.options._generate) {
-        nuxt.hook("close", async () => {
-          await regeneratePWA(
-            options.outDir,
-            resolveVitePluginPWAAPI()
-          );
+      } else {
+        nuxt.hook("nitro:init", (nitro) => {
+          nitro.hooks.hook("rollup:before", async () => {
+            await regeneratePWA(
+              options.outDir,
+              resolveVitePluginPWAAPI()
+            );
+          });
         });
+        if (nuxt.options._generate) {
+          nuxt.hook("close", async () => {
+            await regeneratePWA(
+              options.outDir,
+              resolveVitePluginPWAAPI()
+            );
+          });
+        }
       }
     }
   }

package/dist/runtime/plugins/pwa.client.d.ts

@@ -1,6 +1,6 @@
 import type { UnwrapNestedRefs } from 'vue';
-import type { PwaInjection } from './pwa';
-import type { Plugin } from '#app/nuxt';
+import type { PwaInjection } from './types';
+import type { Plugin } from '#app';
 declare const plugin: Plugin<{
     pwa?: UnwrapNestedRefs<PwaInjection>;
 }>;

package/dist/runtime/plugins/pwa.client.stub.d.ts

@@ -1,6 +1,6 @@
 import type { UnwrapNestedRefs } from 'vue';
-import type { PwaInjection } from './pwa';
-import type { Plugin } from '#app/nuxt';
+import type { PwaInjection } from './types';
+import type { Plugin } from '#app';
 declare const plugin: Plugin<{
     pwa?: UnwrapNestedRefs<PwaInjection>;
 }>;

package/dist/runtime/plugins/types.d.ts

@@ -0,0 +1,30 @@
+import type { Ref } from 'vue'
+import type { UnwrapNestedRefs } from 'vue'
+
+export interface PwaInjection {
+  isInstalled: boolean
+  showInstallPrompt: Ref<boolean>
+  cancelInstall: () => void
+  install: () => Promise<void>
+  swActivated: Ref<boolean>
+  registrationError: Ref<boolean>
+  offlineReady: Ref<boolean>
+  needRefresh: Ref<boolean>
+  updateServiceWorker: (reloadPage?: boolean | undefined) => Promise<void>
+  cancelPrompt: () => Promise<void>
+  getSWRegistration: () => ServiceWorkerRegistration | undefined
+}
+
+declare module '#app' {
+  interface NuxtApp {
+    $pwa?: UnwrapNestedRefs<PwaInjection>
+  }
+}
+
+declare module '@vue/runtime-core' {
+  interface ComponentCustomProperties {
+    $pwa?: UnwrapNestedRefs<PwaInjection>
+  }
+}
+
+export {}

package/dist/types.d.mts

@@ -0,0 +1,16 @@
+
+import type { ModuleOptions } from './module'
+
+
+declare module '@nuxt/schema' {
+  interface NuxtConfig { ['pwa']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['pwa']?: ModuleOptions }
+}
+
+declare module 'nuxt/schema' {
+  interface NuxtConfig { ['pwa']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['pwa']?: ModuleOptions }
+}
+
+
+export type { ClientOptions, ModuleOptions, PwaModuleOptions, default } from './module'

package/dist/types.d.ts

@@ -1,5 +1,6 @@
 
-import { ModuleOptions } from './module'
+import type { ModuleOptions } from './module'
+
 
 declare module '@nuxt/schema' {
   interface NuxtConfig { ['pwa']?: Partial<ModuleOptions> }
@@ -12,4 +13,4 @@ declare module 'nuxt/schema' {
 }
 
 
-export { ClientOptions, ModuleOptions, default } from './module'
+export type { ClientOptions, ModuleOptions, PwaModuleOptions, default } from './module'

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@vite-pwa/nuxt",
   "type": "module",
-  "version": "0.2.3",
-  "packageManager": "pnpm@8.10.3",
+  "version": "0.3.1",
+  "packageManager": "pnpm@8.10.5",
   "description": "Zero-config PWA for Nuxt 3",
   "author": "antfu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -22,13 +22,13 @@
   ],
   "exports": {
     ".": {
-      "types": "./dist/types.d.ts",
-      "import": "./dist/module.mjs",
-      "require": "./dist/module.cjs"
+      "types": "./dist/types.d.mts",
+      "default": "./dist/module.mjs"
     },
     "./configuration": {
       "types": "./configuration.d.ts"
-    }
+    },
+    "./*": "./*"
   },
   "main": "./dist/module.cjs",
   "types": "./dist/types.d.ts",
@@ -37,7 +37,7 @@
     "*.d.ts"
   ],
   "scripts": {
-    "prepack": "nuxt-module-build prepare && nuxt-module-build",
+    "prepack": "nuxt-module-build prepare && nuxt-module-build build",
     "dev": "nuxi dev playground",
     "dev:generate": "nuxi generate playground",
     "dev:generate:netlify": "NITRO_PRESET=netlify nuxi generate playground",
@@ -56,31 +56,30 @@
     "test": "nr test:build && nr test:generate",
     "test:with-build": "nr dev:prepare && nr prepack && nr test"
   },
-  "peerDependencies": {
-    "@nuxt/kit": "^3.6.2",
-    "vite-plugin-pwa": ">=0.16.5 <1"
-  },
   "dependencies": {
-    "@nuxt/kit": "^3.6.2",
+    "@nuxt/kit": "^3.8.2",
     "pathe": "^1.1.1",
-    "ufo": "^1.3.1",
-    "vite-plugin-pwa": ">=0.16.5 <1"
+    "ufo": "^1.3.2",
+    "vite-plugin-pwa": ">=0.16.7 <1"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^0.41.0",
-    "@antfu/ni": "^0.21.8",
-    "@nuxt/module-builder": "^0.4.0",
-    "@nuxt/schema": "^3.6.5",
-    "@nuxt/test-utils": "^3.5.3",
+    "@antfu/eslint-config": "^0.43.1",
+    "@antfu/ni": "^0.21.10",
+    "@nuxt/module-builder": "^0.5.4",
+    "@nuxt/schema": "^3.8.2",
+    "@nuxt/test-utils": "^3.8.1",
     "@playwright/test": "^1.37.1",
     "@types/node": "^18",
     "bumpp": "^9.2.0",
-    "eslint": "^8.49.0",
+    "eslint": "^8.54.0",
     "node-fetch-native": "^1.4.1",
-    "nuxt": "^3.6.5",
+    "nuxt": "^3.8.2",
+    "publint": "^0.2.5",
+    "rimraf": "^5.0.5",
     "serve": "^14.2.1",
-    "typescript": "^5.2.2",
-    "vitest": "^0.34.4"
+    "typescript": "^5.3.2",
+    "vitest": "^0.34.4",
+    "vue-tsc": "^1.8.22"
   },
   "build": {
     "externals": [
@@ -95,4 +94,4 @@
       "vite-plugin-pwa"
     ]
   }
-}
+}

package/dist/runtime/plugins/pwa.d.ts

@@ -1,14 +0,0 @@
-import type { Ref } from 'vue';
-export interface PwaInjection {
-    isInstalled: boolean;
-    showInstallPrompt: Ref<boolean>;
-    cancelInstall: () => void;
-    install: () => Promise<void>;
-    swActivated: Ref<boolean>;
-    registrationError: Ref<boolean>;
-    offlineReady: Ref<boolean>;
-    needRefresh: Ref<boolean>;
-    updateServiceWorker: (reloadPage?: boolean | undefined) => Promise<void>;
-    cancelPrompt: () => Promise<void>;
-    getSWRegistration: () => ServiceWorkerRegistration | undefined;
-}