@vite-pwa/nuxt 1.1.1 → 2.0.1

package/dist/runtime/plugins/pwa.client.js

@@ -1,63 +1,86 @@
-import { defineNuxtPlugin } from "#imports";
-import { display, installPrompt, periodicSyncForUpdates } from "virtual:nuxt-pwa-configuration";
+import {
+  activateSWSwitcherDev,
+  callBeforeRegisterHook,
+  initializeDev,
+  periodicSyncForUpdates
+} from "virtual:nuxt-pwa-configuration";
 import { useRegisterSW } from "virtual:pwa-register/vue";
-import { nextTick, reactive, ref } from "vue";
+import { defineNuxtPlugin, reactive, ref } from "#imports";
 const plugin = defineNuxtPlugin({
   name: "vite-pwa:nuxt:client:plugin",
   enforce: "post",
   parallel: true,
-  setup(nuxtApp) {
+  async setup(nuxtApp) {
+    if (import.meta.dev) {
+      initializeDev();
+    }
     const registrationError = ref(false);
     const swActivated = ref(false);
-    const showInstallPrompt = ref(false);
-    const hideInstall = ref(!installPrompt ? true : localStorage.getItem(installPrompt) === "true");
-    const ua = navigator.userAgent;
-    const ios = ua.match(/iPhone|iPad|iPod/);
-    const useDisplay = display === "standalone" || display === "minimal-ui" ? `${display}` : "standalone";
-    const standalone = window.matchMedia(`(display-mode: ${useDisplay})`).matches;
-    const isInstalled = ref(!!(standalone || ios && !ua.match(/Safari/)));
-    const isPWAInstalled = ref(isInstalled.value);
-    window.matchMedia(`(display-mode: ${useDisplay})`).addEventListener("change", (e) => {
-      if (!isPWAInstalled.value && e.matches)
-        isPWAInstalled.value = true;
-    });
-    let swRegistration;
-    const getSWRegistration = () => swRegistration;
-    const registerPeriodicSync = (swUrl, r, timeout) => {
+    function registerPeriodicSync(swUrl, r, timeout) {
       setInterval(async () => {
-        if (r && r.installing || "connection" in navigator && !navigator.onLine)
+        if (r && r.installing || "connection" in navigator && !navigator.onLine) {
           return;
-        const resp = await fetch(swUrl, {
-          cache: "no-store",
-          headers: {
-            "cache": "no-store",
-            "cache-control": "no-cache"
+        }
+        try {
+          const resp = await fetch(
+            swUrl,
+            {
+              cache: "no-store",
+              headers: {
+                "cache": "no-store",
+                "cache-control": "no-cache"
+              }
+            }
+          );
+          if (resp?.status === 200) {
+            await r.update();
           }
-        });
-        if (resp?.status === 200)
-          await r.update();
+        } catch (error) {
+          await nuxtApp.hooks.callHook(
+            "service-worker:periodic-sync-update-failed",
+            {
+              url: swUrl,
+              error,
+              registration: r
+            }
+          );
+        }
       }, timeout);
-    };
-    const {
-      offlineReady,
-      needRefresh,
-      updateServiceWorker
-    } = useRegisterSW({
+    }
+    const hooks = nuxtApp.hooks;
+    const options = {
       immediate: true,
       onRegisterError(error) {
-        nuxtApp.hooks.callHook("service-worker:registration-failed", { error });
+        hooks.callHook(
+          "service-worker:registration-failed",
+          { error }
+        );
         registrationError.value = true;
       },
       onRegisteredSW(swUrl, r) {
-        swRegistration = r;
+        if (import.meta.dev) {
+          activateSWSwitcherDev();
+        }
         const timeout = periodicSyncForUpdates;
-        nuxtApp.hooks.callHook("service-worker:registered", { url: swUrl, registration: r });
+        nuxtApp.hooks.callHook(
+          "service-worker:registered",
+          {
+            url: swUrl,
+            registration: r
+          }
+        );
         if (r?.active?.state === "activated") {
           swActivated.value = true;
           if (timeout > 0) {
             registerPeriodicSync(swUrl, r, timeout * 1e3);
           }
-          nuxtApp.hooks.callHook("service-worker:activated", { url: swUrl, registration: r });
+          nuxtApp.hooks.callHook(
+            "service-worker:activated",
+            {
+              url: swUrl,
+              registration: r
+            }
+          );
         } else if (r?.installing) {
           r.installing.addEventListener("statechange", (e) => {
             const sw = e.target;
@@ -66,53 +89,44 @@ const plugin = defineNuxtPlugin({
               if (timeout > 0) {
                 registerPeriodicSync(swUrl, r, timeout * 1e3);
               }
-              nuxtApp.hooks.callHook("service-worker:activated", { url: swUrl, registration: r });
+              nuxtApp.hooks.callHook(
+                "service-worker:activated",
+                {
+                  url: swUrl,
+                  registration: r
+                }
+              );
             }
           });
         }
       }
-    });
-    const cancelPrompt = async () => {
-      offlineReady.value = false;
-      needRefresh.value = false;
     };
-    let install = () => Promise.resolve(void 0);
-    let cancelInstall = () => {
-    };
-    if (!hideInstall.value) {
-      let deferredPrompt;
-      const beforeInstallPrompt = (e) => {
-        e.preventDefault();
-        deferredPrompt = e;
-        showInstallPrompt.value = true;
-      };
-      window.addEventListener("beforeinstallprompt", beforeInstallPrompt);
-      window.addEventListener("appinstalled", () => {
-        deferredPrompt = void 0;
-        showInstallPrompt.value = false;
-      });
-      cancelInstall = () => {
-        deferredPrompt = void 0;
-        showInstallPrompt.value = false;
-        window.removeEventListener("beforeinstallprompt", beforeInstallPrompt);
-        hideInstall.value = true;
-        localStorage.setItem(installPrompt, "true");
-      };
-      install = async () => {
-        if (!showInstallPrompt.value || !deferredPrompt) {
-          showInstallPrompt.value = false;
-          return void 0;
+    if (callBeforeRegisterHook) {
+      await hooks.callHook(
+        "service-worker:before-register",
+        (trustedScriptUrl) => {
+          options.trustedScriptUrl = trustedScriptUrl;
         }
-        showInstallPrompt.value = false;
-        await nextTick();
-        deferredPrompt.prompt();
-        return await deferredPrompt.userChoice;
-      };
+      );
     }
+    const {
+      offlineReady,
+      needRefresh,
+      updateServiceWorker
+    } = useRegisterSW(options);
+    async function cancelPrompt() {
+      offlineReady.value = false;
+      needRefresh.value = false;
+    }
+    const {
+      isPWAInstalled,
+      showInstallPrompt,
+      cancelInstall,
+      install
+    } = nuxtApp.$pwaInstallPrompt;
     return {
       provide: {
         pwa: reactive({
-          isInstalled,
           isPWAInstalled,
           showInstallPrompt,
           cancelInstall,
@@ -122,8 +136,7 @@ const plugin = defineNuxtPlugin({
           offlineReady,
           needRefresh,
           updateServiceWorker,
-          cancelPrompt,
-          getSWRegistration
+          cancelPrompt
         })
       }
     };

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

@@ -1,149 +1,90 @@
-import type { Ref } from 'vue'
-import type { UnwrapNestedRefs } from 'vue'
-
+import type { Ref } from 'vue';
 /**
  * Result of the native PWA installation prompt.
  */
 export interface UserChoice {
-  /**
-   * The user's selection on the install prompt.
-   */
-  outcome: 'accepted' | 'dismissed'
-  /**
-   * Platform identifier provided by the browser for where the prompt was shown
-   * (for example, 'web' or a store-specific value). The exact values are
-   * browser-dependent and not standardized.
-   */
-  platform: string
+    /**
+     * The user's selection on the installation prompt.
+     */
+    outcome: 'accepted' | 'dismissed';
+    /**
+     * Platform identifier provided by the browser for where the prompt was shown
+     * (for example, 'web' or a store-specific value). The exact values are
+     * browser-dependent and not standardized.
+     */
+    platform: string;
 }
-
 /**
  * Browser event fired before showing the native PWA install prompt.
  *
  * This event allows delaying the native prompt and showing a custom UI first.
  */
 export type BeforeInstallPromptEvent = Event & {
-  /**
-   * Triggers the browser's native install prompt.
-   */
-  prompt: () => void
-  /**
-   * Resolves with the user's selection once they interact with the prompt.
-   */
-  userChoice: Promise<UserChoice>
+    /**
+     * Triggers the browser's native installation prompt.
+     */
+    prompt: () => void;
+    /**
+     * Resolves with the user's selection once they interact with the prompt.
+     */
+    userChoice: Promise<UserChoice>;
+};
+/**
+ * PWA Install Prompt state and helpers injected into Nuxt as `$pwaInstallPrompt`.
+ */
+export interface PwaInstallPromptInjection {
+    /**
+     * Whether the app is currently installed as a PWA.
+     * This value updates as installation state changes (e.g. display-mode changes).
+     */
+    isPWAInstalled: Ref<boolean>;
+    /**
+     * When `true`, your UI should show a custom installation prompt. This flag is set
+     * after the `beforeinstallprompt` event is captured and cleared when the user
+     * proceeds or cancels.
+     */
+    showInstallPrompt: Ref<boolean>;
+    /**
+     * Cancels the custom install flow and hides future prompts by setting an
+     * opt-out flag (stored in `localStorage` when configured via `installPrompt`).
+     */
+    cancelInstall: () => void;
+    /**
+     * Shows the native installation prompt if available and returns the user's choice.
+     * Returns `undefined` when the prompt is not available or not currently shown.
+     */
+    install: () => Promise<UserChoice | undefined>;
 }
-
 /**
  * Reactive PWA state and helpers injected into Nuxt as `$pwa`.
  */
-export interface PwaInjection {
-  /**
-   * @deprecated Use `isPWAInstalled` instead. Legacy boolean computed from
-   * browser heuristics to detect if the app is installed.
-   */
-  isInstalled: boolean
-  /**
-   * Whether the app is currently installed as a PWA.
-   * This value updates as installation state changes (e.g. display-mode changes).
-   */
-  isPWAInstalled: Ref<boolean>
-  /**
-   * When `true`, your UI should show a custom install prompt. This flag is set
-   * after the `beforeinstallprompt` event is captured and cleared when the user
-   * proceeds or cancels.
-   */
-  showInstallPrompt: Ref<boolean>
-  /**
-   * Cancels the custom install flow and hides future prompts by setting an
-   * opt-out flag (stored in `localStorage` when configured via `installPrompt`).
-   */
-  cancelInstall: () => void
-  /**
-   * Shows the native install prompt if available and returns the user's choice.
-   * Returns `undefined` when the prompt is not available or not currently shown.
-   */
-  install: () => Promise<UserChoice | undefined>
-  /**
-   * Whether the service worker has reached the `activated` state.
-   */
-  swActivated: Ref<boolean>
-  /**
-   * Indicates that registering the service worker failed.
-   */
-  registrationError: Ref<boolean>
-  /**
-   * Becomes `true` when the app is ready to work offline (precache completed).
-   * This flag is activated only once, when the service worker is registered and activated for first time.
-   */
-  offlineReady: Ref<boolean>
-  /**
-   * Becomes `true` when a new service worker is waiting to activate and a
-   * refresh is recommended to apply updates.
-   */
-  needRefresh: Ref<boolean>
-  /**
-   * Applies the waiting service worker. When `reloadPage` is `true`, reloads
-   * the page after activating the new service worker.
-   */
-  updateServiceWorker: (reloadPage?: boolean | undefined) => Promise<void>
-  /**
-   * Dismisses update/install notifications by resetting `offlineReady` and
-   * `needRefresh` to `false`.
-   */
-  cancelPrompt: () => Promise<void>
-  /**
-   * From version 0.10.8 it is deprecated, use a plugin instead with the new Nuxt Runtime Client Hooks:
-   * ```ts
-   * // plugins/pwa.client.ts
-   * export default defineNuxtPlugin((nuxtApp) => {
-   *   nuxtApp.hook('service-worker:registered', ({ url, registration }) => {
-   *     // eslint-disable-next-line no-console
-   *     console.log(`service worker registered at ${url}`, registration)
-   *   })
-   *   nuxtApp.hook('service-worker:registration-failed', ({ error }) => {
-   *     console.error(`service worker registration failed`, error)
-   *   })
-   *   nuxtApp.hook('service-worker:activated', ({ url, registration }) => {
-   *     // eslint-disable-next-line no-console
-   *     console.log(`service worker activated at ${url}`, registration)
-   *   })
-   * })
-   * ```
-   *
-   * @deprecated Directly access the registration in your own plugin via the
-   * runtime client hooks instead.
-   */
-  getSWRegistration: () => ServiceWorkerRegistration | undefined
-}
-
-declare module '#app' {
-  interface NuxtApp {
+export interface PwaInjection extends PwaInstallPromptInjection {
     /**
-     * Reactive PWA state and controls provided by @vite-pwa/nuxt.
-     *
-     * Example:
-     * ```ts
-     * const { $pwa } = useNuxtApp()
-     * if ($pwa?.needRefresh) await $pwa.updateServiceWorker(true)
-     * ```
+     * Whether the service worker has reached the `activated` state.
      */
-    $pwa?: UnwrapNestedRefs<PwaInjection>
-  }
-}
-
-declare module 'vue' {
-  interface ComponentCustomProperties {
+    swActivated: Ref<boolean>;
+    /**
+     * Indicates that registering the service worker failed.
+     */
+    registrationError: Ref<boolean>;
+    /**
+     * Becomes `true` when the app is ready to work offline (precache completed).
+     * This flag is activated only once, when the service worker is registered and activated for first time.
+     */
+    offlineReady: Ref<boolean>;
+    /**
+     * Becomes `true` when a new service worker is waiting to activate and a
+     * refresh is recommended to apply updates.
+     */
+    needRefresh: Ref<boolean>;
+    /**
+     * Applies the waiting service worker. When `reloadPage` is `true`, reloads
+     * the page after activating the new service worker.
+     */
+    updateServiceWorker: (reloadPage?: boolean | undefined) => Promise<void>;
     /**
-     * Reactive PWA state and controls provided by @vite-pwa/nuxt.
-     *
-     * Example:
-     * ```ts
-     * const { $pwa } = useNuxtApp()
-     * if ($pwa?.needRefresh) await $pwa.updateServiceWorker(true)
-     * ```
+     * Dismisses service worker update/installed notifications by resetting `offlineReady` and
+     * `needRefresh` to `false`.
      */
-    $pwa?: UnwrapNestedRefs<PwaInjection>
-  }
+    cancelPrompt: () => Promise<void>;
 }
-
-export {}

package/dist/types.d.mts

@@ -1,4 +1,4 @@
-import type { ModuleHooks, ModuleRuntimeHooks } from './module.js'
+import type { ModuleHooks, ModuleRuntimeHooks } from './module.mjs'
 
 declare module '#app' {
   interface RuntimeNuxtHooks extends ModuleRuntimeHooks {}
@@ -8,8 +8,8 @@ declare module '@nuxt/schema' {
   interface NuxtHooks extends ModuleHooks {}
 }
 
-declare module 'nuxt/schema' {
-  interface NuxtHooks extends ModuleHooks {}
-}
+export { type definePwaConfig } from '@vite-pwa/nuxt-core/config'
+
+export { default } from './module.mjs'
 
-export { type ClientOptions, type ModuleHooks, type ModuleOptions, type ModuleRuntimeHooks, type PwaModuleHooks, type PwaModuleOptions, default } from './module.js'
+export { type BeforeBuildServiceWorkerHook, type ModuleHooks, type ModuleOptions, type ModuleRuntimeHooks, type PWAModuleRuntimeHooks, type PwaModuleHooks, type PwaModuleOptions, type ServiceWorkerPeriodicSyncUpdateError, type ServiceWorkerRegistrationErrorOptions, type ServiceWorkerRuntimeHooksOptions } from './module.mjs'

package/package.json

@@ -1,22 +1,23 @@
 {
   "name": "@vite-pwa/nuxt",
   "type": "module",
-  "version": "1.1.1",
-  "description": "Zero-config PWA for Nuxt 3",
+  "version": "2.0.1",
+  "description": "Zero-config PWA for Nuxt",
   "author": "antfu <anthonyfu117@hotmail.com>",
   "license": "MIT",
   "funding": "https://github.com/sponsors/antfu",
   "homepage": "https://github.com/vite-pwa/nuxt#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/vite-pwa/nuxt.git"
+    "url": "git+https://github.com/vite-pwa/nuxt.git",
+    "directory": "packages/module"
   },
   "bugs": "https://github.com/vite-pwa/nuxt/issues",
   "keywords": [
     "nuxt",
     "pwa",
     "workbox",
-    "vite-plugin-pwa",
+    "unplugin-pwa",
     "nuxt-module"
   ],
   "exports": {
@@ -24,53 +25,49 @@
       "types": "./dist/types.d.mts",
       "default": "./dist/module.mjs"
     },
+    "./config": "./config/index.mjs",
     "./configuration": {
       "types": "./configuration.d.ts"
     },
-    "./package.json": "./package.json",
-    "./*": "./*"
+    "./package.json": "./package.json"
   },
   "main": "./dist/module.mjs",
-  "types": "./dist/types.d.ts",
+  "types": "./dist/types.d.mts",
   "files": [
     "*.d.ts",
+    "config",
     "dist"
   ],
   "peerDependencies": {
-    "@vite-pwa/assets-generator": "^1.0.0"
+    "@vite-pwa/assets-generator": "^1.0.0 || ^2.0.0",
+    "magicast": "^0.5.0",
+    "rolldown": "^1.0.0-0"
   },
   "peerDependenciesMeta": {
     "@vite-pwa/assets-generator": {
       "optional": true
+    },
+    "magicast": {
+      "optional": true
+    },
+    "rolldown": {
+      "optional": true
     }
   },
   "dependencies": {
-    "@nuxt/kit": "^3.9.0",
-    "pathe": "^1.1.1",
-    "ufo": "^1.3.2",
-    "vite-plugin-pwa": "^1.2.0"
+    "@nuxt/kit": "^4.6.4",
+    "@unplugin-pwa/core": "^0.0.6",
+    "@vite-pwa/nuxt-core": "2.0.1",
+    "@vite-pwa/nuxt-vite": "2.0.1",
+    "@vite-pwa/workbox-build": "^8.0.15",
+    "defu": "^6.1.7",
+    "verkit": "^0.5.0"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^4.11.0",
-    "@antfu/ni": "^0.21.10",
-    "@nuxt/module-builder": "^0.8.3",
-    "@nuxt/schema": "^3.10.1",
-    "@nuxt/test-utils": "^3.11.0",
-    "@playwright/test": "^1.40.1",
-    "@types/node": "^18",
-    "bumpp": "^9.2.0",
-    "eslint": "^9.23.0",
-    "node-fetch-native": "^1.4.1",
-    "nuxt": "^3.10.1",
-    "publint": "^0.2.5",
-    "rimraf": "^5.0.5",
-    "serve": "^14.2.1",
-    "typescript": "^5.4.5",
-    "vitest": "^1.1.0",
-    "vue-tsc": "^1.8.27"
-  },
-  "resolutions": {
-    "@nuxt/kit": "^3.10.1"
+    "@nuxt/devtools": "^4.1.0",
+    "@nuxt/schema": "^4.6.4",
+    "@vite-pwa/assets-generator": "^2.0.0",
+    "nuxt": "^4.6.4"
   },
   "build": {
     "externals": [
@@ -81,38 +78,22 @@
       "h3",
       "pathe",
       "rollup",
+      "rolldown",
       "ufo",
       "vite",
-      "vite-plugin-pwa"
+      "@unplugin-pwa/core",
+      "@unplugin-pwa/vite",
+      "@vite-pwa/workbox-build",
+      "@vite-pwa/workbox-swkit",
+      "@vite-pwa/workbox-window"
     ]
   },
-  "stackblitz": {
-    "startCommand": "nr prepack && nr dev:prepare && nr dev"
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
   },
   "scripts": {
-    "dev": "nuxi dev playground",
-    "dev:generate": "nuxi generate playground",
-    "dev:generate:netlify": "NITRO_PRESET=netlify nuxi generate playground",
-    "dev:generate:vercel": "NITRO_PRESET=vercel nuxi generate playground",
-    "dev:build": "nuxi build playground",
-    "dev:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground",
-    "dev:preview:build": "nr dev:build && node playground/.output/server/index.mjs",
-    "dev:preview:generate": "nr dev:generate && serve playground/dist",
-    "dev:assets:prepare": "nuxt-module-build build --stub && nuxt-module-build prepare && nuxi prepare playground-assets",
-    "dev:assets": "nr dev:assets:prepare && nuxi dev playground-assets",
-    "dev:assets:generate": "nr dev:assets:prepare && nuxi generate playground-assets",
-    "dev:assets:build": "nr dev:assets:prepare && nuxi build playground-assets",
-    "release": "bumpp",
-    "lint": "eslint .",
-    "lint:fix": "nr lint --fix",
-    "test:build:serve": "PORT=4173 node playground/.output/server/index.mjs",
-    "test:generate:serve": "PORT=4173 serve playground/dist",
-    "test:build": "nr dev:build && NUXT_ECOSYSTEM_CI=true TEST_BUILD=true vitest run && TEST_BUILD=true playwright test",
-    "test:generate": "nr dev:generate && NUXT_ECOSYSTEM_CI=true vitest run && playwright test",
-    "test:build:local": "nr dev:build && TEST_BUILD=true vitest run && TEST_BUILD=true playwright test",
-    "test:generate:local": "nr dev:generate && vitest run && playwright test",
-    "test:local": "nr test:build:local && nr test:generate:local",
-    "test": "nr test:build && nr test:generate",
-    "test:with-build": "nr dev:prepare && nr prepack && nr test"
+    "build": "nuxt-module-build prepare && nuxt-module-build build",
+    "test:typecheck": "vue-tsc --noEmit"
   }
 }

package/dist/chunks/dev.mjs

@@ -1,37 +0,0 @@
-import fs from 'node:fs';
-import { join } from 'node:path';
-import { eventHandler } from 'h3';
-
-function dev(swMap, resolvedSwMapFile, worboxMap, buildDir, baseURL) {
-  return eventHandler(async (event) => {
-    const url = event.path;
-    if (!url)
-      return;
-    const file = url === swMap ? resolvedSwMapFile : url.startsWith(worboxMap) && url.endsWith(".js.map") ? join(
-      buildDir,
-      "dev-sw-dist",
-      url.slice(baseURL.length)
-    ) : void 0;
-    if (file) {
-      try {
-        await waitFor(() => fs.existsSync(file));
-        const map = fs.readFileSync(file, "utf-8");
-        event.headers.set("Content-Type", "application/json");
-        event.headers.set("Cache-Control", "public, max-age=0, must-revalidate");
-        event.headers.set("Content-Length", `${map.length}`);
-        event.node.res.end(map);
-      } catch {
-      }
-    }
-  });
-}
-async function waitFor(method, retries = 5) {
-  if (method())
-    return;
-  if (retries === 0)
-    throw new Error("Timeout in waitFor");
-  await new Promise((resolve) => setTimeout(resolve, 300));
-  return waitFor(method, retries - 1);
-}
-
-export { dev };