@vite-pwa/nuxt 0.0.7 → 0.0.8

package/dist/module.d.ts

@@ -1,38 +1,57 @@
 import * as _nuxt_schema from '@nuxt/schema';
 import { VitePWAOptions } from 'vite-plugin-pwa';
+import { UnwrapNestedRefs, Ref } from 'vue';
 
-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 ModuleOptions extends Partial<VitePWAOptions> {
-    registerWebManifestInRouteRules?: boolean;
-    /**
-     * Writes the plugin to disk: defaults to false (debug).
-     */
-    writePlugin?: boolean;
-    /**
-     * Options for plugin.
-     */
-    client?: ClientOptions;
+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>;
+    }
+}
+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 ModuleOptions 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<ModuleOptions>;
 
-export { ClientOptions, ModuleOptions, _default as default };
+export { ClientOptions, ModuleOptions, PwaInjection, _default as default };

package/dist/module.json

@@ -1,5 +1,5 @@
 {
   "name": "pwa",
   "configKey": "pwa",
-  "version": "0.0.7"
+  "version": "0.0.8"
 }

package/dist/runtime/VitePwaManifest.d.ts

@@ -1,2 +1,2 @@
-declare const _default: import("vue").DefineComponent<{}, () => null, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}>;
-export default _default;
+declare const _default: import("vue").DefineComponent<{}, () => null, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}>;
+export default _default;

package/dist/types.d.ts

@@ -6,5 +6,10 @@ declare module '@nuxt/schema' {
   interface NuxtOptions { ['pwa']?: ModuleOptions }
 }
 
+declare module 'nuxt/schema' {
+  interface NuxtConfig { ['pwa']?: Partial<ModuleOptions> }
+  interface NuxtOptions { ['pwa']?: ModuleOptions }
+}
+
 
-export { ClientOptions, ModuleOptions, default } from './module'
+export { ClientOptions, ModuleOptions, PwaInjection, default } from './module'

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@vite-pwa/nuxt",
   "type": "module",
-  "version": "0.0.7",
-  "packageManager": "pnpm@7.29.0",
+  "version": "0.0.8",
+  "packageManager": "pnpm@8.5.0",
   "description": "Zero-config PWA for Nuxt 3",
   "author": "antfu <anthonyfu117@hotmail.com>",
   "license": "MIT",
@@ -41,31 +41,40 @@
     "dev:generate:vercel": "NITRO_PRESET=vercel nuxi generate playground",
     "dev:build": "nuxi build playground",
     "dev:prepare": "nuxt-module-build --stub && nuxi prepare playground",
-    "dev:preview:build": "npm run dev:build && node playground/.output/server/index.mjs",
-    "dev:preview:generate": "npm run dev:generate && npx serve playground/dist",
+    "dev:preview:build": "nr dev:build && node playground/.output/server/index.mjs",
+    "dev:preview:generate": "nr dev:generate && serve playground/dist",
     "prepublishOnly": "npm run prepack",
     "release": "bumpp && npm publish",
     "lint": "eslint .",
-    "lint-fix": "nr lint --fix"
+    "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 && TEST_BUILD=true vitest run && TEST_BUILD=true playwright test",
+    "test:generate": "nr dev:generate && vitest run && playwright test",
+    "test": "nr test:build && nr test:generate",
+    "test:with-build": "nr dev:prepare && nr prepack && nr test"
   },
   "peerDependencies": {
-    "@nuxt/kit": "^3.0.0 || ^3.1.0",
+    "@nuxt/kit": "^3.0.0",
     "vite-plugin-pwa": "^0.14.0"
   },
   "dependencies": {
-    "@nuxt/kit": "^3.2.0",
-    "vite-plugin-pwa": "^0.14.4"
+    "@nuxt/kit": "^3.4.3",
+    "vite-plugin-pwa": "^0.14.7"
   },
   "devDependencies": {
-    "@antfu/eslint-config": "^0.35.2",
-    "@antfu/ni": "^0.20.0",
-    "@nuxt/module-builder": "^0.2.1",
-    "@nuxt/schema": "^3.2.0",
-    "@nuxt/test-utils": "^3.2.0",
+    "@antfu/eslint-config": "^0.38.6",
+    "@antfu/ni": "^0.21.3",
+    "@nuxt/module-builder": "^0.3.1",
+    "@nuxt/schema": "^3.4.3",
+    "@nuxt/test-utils": "^3.4.3",
+    "@playwright/test": "^1.33.0",
     "bumpp": "^8.2.1",
-    "eslint": "^8.34.0",
-    "nuxt": "^3.2.0",
-    "typescript": "^4.9.5"
+    "eslint": "^8.40.0",
+    "nuxt": "^3.4.3",
+    "serve": "^14.2.0",
+    "typescript": "^5.0.4",
+    "vitest": "^0.31.0"
   },
   "build": {
     "externals": [

package/templates/pwa.client.ts

@@ -1,7 +1,9 @@
-import { ref, reactive, nextTick } from 'vue'
+import { ref, reactive, nextTick, type UnwrapNestedRefs } from 'vue'
 import { useRegisterSW } from 'virtual:pwa-register/vue'
 import { defineNuxtPlugin } from '#imports'
 
+import { type PwaInjection } from '../src/types'
+
 // @ts-ignore
 const options: { periodicSyncForUpdates: number; installPrompt?: string } = <%= JSON.stringify(options) %>
 
@@ -115,7 +117,6 @@ export default defineNuxtPlugin(() => {
     }
   }
 
-
   return {
     provide: {
       pwa: reactive({
@@ -130,7 +131,7 @@ export default defineNuxtPlugin(() => {
         updateServiceWorker,
         cancelPrompt,
         getSWRegistration,
-      }),
+      }) satisfies UnwrapNestedRefs<PwaInjection>,
     },
   }
 })