feat(api): allow overriding options

package.json

@@ -122,6 +122,7 @@
   },
   "dependencies": {
     "debug": "^4.3.6",
+    "defu": "6.1.2",
     "pretty-bytes": "^6.1.1",
     "tinyglobby": "^0.2.10",
     "workbox-build": "^7.3.0",

src/api.ts

@@ -2,6 +2,7 @@ import { resolve } from 'node:path'
 import { existsSync } from 'node:fs'
 import type { OutputBundle } from 'rollup'
 import { cyan, yellow } from 'kolorist'
+import { defu } from "defu";
 import { generateInjectManifest, generateServiceWorker } from './modules'
 import { generateWebManifestFile } from './assets'
 import { DEV_SW_NAME, FILE_SW_REGISTER } from './constants'
@@ -12,7 +13,7 @@ import {
   generateWebManifest,
 } from './html'
 import type { PWAPluginContext } from './context'
-import type { ExtendManifestEntriesHook, VitePluginPWAAPI } from './types'
+import type { ExtendManifestEntriesHook, VitePluginPWAAPI, ResolvedVitePWAOptions } from './types'
 
 export async function _generateSW({ options, version, viteConfig }: PWAPluginContext) {
   if (options.disable)
@@ -142,11 +143,11 @@ export function createAPI(ctx: PWAPluginContext) {
         },
       }
     },
-    generateBundle(bundle) {
-      return _generateBundle(ctx, bundle)
+    generateBundle(bundle, optionsOverride?: Partial<ResolvedVitePWAOptions>) {      
+      return _generateBundle(defu({options: optionsOverride}, ctx), bundle)
     },
-    async generateSW() {
-      return await _generateSW(ctx)
+    async generateSW(optionsOverride?: Partial<ResolvedVitePWAOptions>) {
+      return await _generateSW(defu({options: optionsOverride}, ctx))
     },
     extendManifestEntries(fn: ExtendManifestEntriesHook) {
       const { options } = ctx

src/client/build/preact.ts

@@ -7,6 +7,7 @@ export type { RegisterSWOptions }
 export function useRegisterSW(options: RegisterSWOptions = {}) {
   const {
     immediate = true,
+    baseUrl,
     onNeedRefresh,
     onOfflineReady,
     onRegistered,
@@ -20,6 +21,7 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {
   const [updateServiceWorker] = useState(() => {
     return registerSW({
       immediate,
+      baseUrl,
       onOfflineReady() {
         setOfflineReady(true)
         onOfflineReady?.()

src/client/build/react.ts

@@ -7,6 +7,7 @@ export type { RegisterSWOptions }
 export function useRegisterSW(options: RegisterSWOptions = {}) {
   const {
     immediate = true,
+    baseUrl,
     onNeedRefresh,
     onOfflineReady,
     onRegistered,
@@ -20,6 +21,7 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {
   const [updateServiceWorker] = useState(() => {
     return registerSW({
       immediate,
+      baseUrl,
       onOfflineReady() {
         setOfflineReady(true)
         onOfflineReady?.()

src/client/build/register.ts

@@ -17,6 +17,7 @@ export type { RegisterSWOptions }
 export function registerSW(options: RegisterSWOptions = {}) {
   const {
     immediate = false,
+    baseUrl = "",
     onNeedRefresh,
     onOfflineReady,
     onRegistered,
@@ -39,7 +40,7 @@ export function registerSW(options: RegisterSWOptions = {}) {
     if ('serviceWorker' in navigator) {
       wb = await import('workbox-window').then(({ Workbox }) => {
         // __SW__, __SCOPE__ and __TYPE__ will be replaced by virtual module
-        return new Workbox('__SW__', { scope: '__SCOPE__', type: '__TYPE__' })
+        return new Workbox(baseUrl+'__SW__', { scope: baseUrl+'__SCOPE__', type: '__TYPE__' })
       }).catch((e) => {
         onRegisterError?.(e)
         return undefined

src/client/build/solid.ts

@@ -7,6 +7,7 @@ export type { RegisterSWOptions }
 export function useRegisterSW(options: RegisterSWOptions = {}) {
   const {
     immediate = true,
+    baseUrl,
     onNeedRefresh,
     onOfflineReady,
     onRegistered,
@@ -19,6 +20,7 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {
 
   const updateServiceWorker = registerSW({
     immediate,
+    baseUrl,
     onOfflineReady() {
       setOfflineReady(true)
       onOfflineReady?.()

src/client/build/svelte.ts

@@ -7,6 +7,7 @@ export type { RegisterSWOptions }
 export function useRegisterSW(options: RegisterSWOptions = {}) {
   const {
     immediate = true,
+    baseUrl,
     onNeedRefresh,
     onOfflineReady,
     onRegistered,
@@ -19,6 +20,7 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {
 
   const updateServiceWorker = registerSW({
     immediate,
+    baseUrl,
     onOfflineReady() {
       offlineReady.set(true)
       onOfflineReady?.()

src/client/build/vue.ts

@@ -7,6 +7,7 @@ export type { RegisterSWOptions }
 export function useRegisterSW(options: RegisterSWOptions = {}) {
   const {
     immediate = true,
+    baseUrl,
     onNeedRefresh,
     onOfflineReady,
     onRegistered,
@@ -19,6 +20,7 @@ export function useRegisterSW(options: RegisterSWOptions = {}) {
 
   const updateServiceWorker = registerSW({
     immediate,
+    baseUrl,
     onNeedRefresh() {
       needRefresh.value = true
       onNeedRefresh?.()

src/client/type.d.ts

@@ -1,5 +1,6 @@
 export interface RegisterSWOptions {
   immediate?: boolean
+  baseUrl?: string
   onNeedRefresh?: () => void
   onOfflineReady?: () => void
   /**