feat: add pwa:beforeBuildServiceWorker Nuxt hook (#196)

* feat: add `pwa:beforeBuildServiceWorker` Nuxt hook

* chore: add experimental `includeAllowlist`

* chore: use also Nuxt `pages:resolved` hook

* chore: rename module hook render pages param

* chore: remove experimental allowlist

* chore: fix jsdoc

Author: userquin

playground/nuxt.config.ts

@@ -5,7 +5,14 @@ const sw = process.env.SW === 'true'
 export default defineNuxtConfig({
   /* ssr: false, */
   // typescript,
-  modules: ['@vite-pwa/nuxt'],
+  modules: [
+    '@vite-pwa/nuxt',
+    (_, nuxt) => {
+      nuxt.hook('pwa:beforeBuildServiceWorker', (options) => {
+        console.log('pwa:beforeBuildServiceWorker: ', options.base)
+      })
+    },
+  ],
   future: {
     typescriptBundlerResolution: true,
   },
@@ -20,7 +27,7 @@ export default defineNuxtConfig({
       },
     },
     prerender: {
-      routes: ['/', '/about'],
+      routes: ['/'/* , '/about' */],
     },
   },
   imports: {
@@ -73,6 +80,9 @@ export default defineNuxtConfig({
       // if enabling periodic sync for update use 1 hour or so (periodicSyncForUpdates: 3600)
       periodicSyncForUpdates: 20,
     },
+    experimental: {
+      includeAllowlist: true,
+    },
     devOptions: {
       enabled: true,
       suppressWarnings: true,

src/module.ts

@@ -1,5 +1,5 @@
 import type { HookResult } from '@nuxt/schema'
-import type { PwaModuleOptions } from './types'
+import type { PwaModuleOptions, ResolvedVitePWAOptions } from './types'
 import { defineNuxtModule } from '@nuxt/kit'
 import { version } from '../package.json'
 import { doSetup } from './utils/module'
@@ -8,6 +8,10 @@ export * from './types'
 
 export interface ModuleOptions extends PwaModuleOptions {}
 
+export interface ModuleHooks {
+  'pwa:beforeBuildServiceWorker': (options: ResolvedVitePWAOptions) => HookResult
+}
+
 export interface ModuleRuntimeHooks {
   /**
    * Emitted when the service worker is registered

src/types.ts

@@ -1,5 +1,7 @@
 import type { VitePWAOptions } from 'vite-plugin-pwa'
 
+export type { ResolvedVitePWAOptions } from 'vite-plugin-pwa'
+
 export interface ClientOptions {
   /**
    * Exposes the plugin: defaults to true.
@@ -52,11 +54,12 @@ export interface PwaModuleOptions extends Partial<VitePWAOptions> {
      *         const newUrl = new URL(url.href)
      *         newUrl.search = ''
      *         urls.push(newUrl)
-     *      }
-     *      return urls
-     *    }
-     *  }
+     *       }
+     *       return urls
+     *     }
+     *   }
      * )
+     * ```
      */
     enableWorkboxPayloadQueryParams?: true
   }

src/utils/config.ts

@@ -112,6 +112,19 @@ export function configurePWAOptions(
       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(