@sigmaott/base-next 1.4.0 → 1.4.2

package/src/pwa/index.ts

@@ -1,194 +1,194 @@
-import { join } from 'node:path'
-import { mkdir } from 'node:fs/promises'
-import { addComponent, addPluginTemplate, createResolver, defineNuxtModule, extendWebpackConfig } from '@nuxt/kit'
-import type { VitePluginPWAAPI } from 'vite-plugin-pwa'
-import { VitePWA } from 'vite-plugin-pwa'
-import type { Plugin } from 'vite'
-import type { ModuleOptions } from './types'
-import { configurePWAOptions } from './config'
-import { regeneratePWA, writeWebManifest } from './utils'
-
-export * from './types'
-
-export default defineNuxtModule<ModuleOptions>({
-  meta: {
-    name: 'pwa',
-    configKey: 'pwa',
-  },
-  defaults: nuxt => ({
-    base: nuxt.options.app.baseURL,
-    scope: nuxt.options.app.baseURL,
-    injectRegister: false,
-    includeManifestIcons: false,
-    registerPlugin: true,
-    writePlugin: false,
-    client: {
-      registerPlugin: true,
-      installPrompt: false,
-      periodicSyncForUpdates: 0,
-    },
-  }),
-  async setup(options, nuxt) {
-    const resolver = createResolver(import.meta.url)
-
-    let vitePwaClientPlugin: Plugin | undefined
-    const resolveVitePluginPWAAPI = (): VitePluginPWAAPI | undefined => {
-      return vitePwaClientPlugin?.api
-    }
-
-    const client = options.client ?? { registerPlugin: true, installPrompt: false, periodicSyncForUpdates: 0 }
-    if (client.registerPlugin) {
-      addPluginTemplate({
-        src: resolver.resolve('../templates/pwa.client.ts'),
-        write: nuxt.options.dev || options.writePlugin,
-        options: {
-          periodicSyncForUpdates: typeof client.periodicSyncForUpdates === 'number' ? client.periodicSyncForUpdates : 0,
-          installPrompt: (typeof client.installPrompt === 'undefined' || client.installPrompt === false)
-            ? undefined
-            : (client.installPrompt === true || client.installPrompt.trim() === '')
-                ? 'vite-pwa:hide-install'
-                : client.installPrompt.trim(),
-        },
-      })
-    }
-
-    await addComponent({
-      name: 'VitePwaManifest',
-      filePath: resolver.resolve('./runtime/VitePwaManifest'),
-    })
-
-    nuxt.hook('prepare:types', ({ references }) => {
-      references.push({ types: 'vite-plugin-pwa/vue' })
-      references.push({ types: 'vite-plugin-pwa/info' })
-    })
-
-    const manifestDir = join(nuxt.options.buildDir, 'manifests')
-    nuxt.options.nitro.publicAssets = nuxt.options.nitro.publicAssets || []
-    nuxt.options.nitro.publicAssets.push({
-      dir: manifestDir,
-      maxAge: 0,
-    })
-
-    nuxt.hook('nitro:init', (nitro) => {
-      configurePWAOptions(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')
-      if (plugin)
-        throw new Error('Remove vite-plugin-pwa plugin from Vite Plugins entry in Nuxt config file!')
-    })
-
-    nuxt.hook('vite:extendConfig', async (viteInlineConfig, { isClient }) => {
-      viteInlineConfig.plugins = viteInlineConfig.plugins || []
-      const plugin = viteInlineConfig.plugins.find(p => p && typeof p === 'object' && 'name' in p && p.name === 'vite-plugin-pwa')
-      if (plugin)
-        throw new Error('Remove vite-plugin-pwa plugin from Vite Plugins entry in Nuxt config file!')
-
-      if (options.manifest && isClient) {
-        viteInlineConfig.plugins.push({
-          name: 'vite-pwa-nuxt:webmanifest:build',
-          apply: 'build',
-          async writeBundle(_options, bundle) {
-            if (options.disable || !bundle)
-              return
-
-            const api = resolveVitePluginPWAAPI()
-            if (api) {
-              await mkdir(manifestDir, { recursive: true })
-              await writeWebManifest(manifestDir, options.manifestFilename || 'manifest.webmanifest', api)
-            }
-          },
-        })
-      }
-
-      // remove vite plugin pwa build plugin
-      const plugins = [...VitePWA(options).filter(p => p.name !== 'vite-plugin-pwa:build')]
-      viteInlineConfig.plugins.push(plugins)
-      if (isClient)
-        vitePwaClientPlugin = plugins.find(p => p.name === 'vite-plugin-pwa') as Plugin
-    })
-
-    extendWebpackConfig(() => {
-      throw new Error('Webpack is not supported: @vite-pwa/nuxt module can only be used with Vite!')
-    })
-
-    const baseURL = `${nuxt.options.runtimeConfig.app.baseURL}/`
-
-    if (nuxt.options.dev) {
-      const webManifest = `${nuxt.options.app.baseURL}${options.devOptions?.webManifestUrl ?? options.manifestFilename ?? 'manifest.webmanifest'}`
-      const devSw = `${nuxt.options.app.baseURL}dev-sw.js?dev-sw`
-      const workbox = `${nuxt.options.app.baseURL}workbox-`
-      // @ts-expect-error just ignore
-      const emptyHandle = (_req, _res, next) => {
-        next()
-      }
-      nuxt.hook('vite:serverCreated', (viteServer, { isServer }) => {
-        if (isServer)
-          return
-
-        viteServer.middlewares.stack.push({ route: webManifest, handle: emptyHandle })
-        viteServer.middlewares.stack.push({ route: devSw, handle: emptyHandle })
-      })
-
-      if (!options.strategies || options.strategies === 'generateSW') {
-        nuxt.hook('vite:serverCreated', (viteServer, { isServer }) => {
-          if (isServer)
-            return
-
-          viteServer.middlewares.stack.push({ route: workbox, handle: emptyHandle })
-        })
-        if (options.devOptions?.suppressWarnings) {
-          const suppressWarnings = `${nuxt.options.app.baseURL}suppress-warnings.js`
-          nuxt.hook('vite:serverCreated', (viteServer, { isServer }) => {
-            if (isServer)
-              return
-
-            viteServer.middlewares.stack.push({ route: suppressWarnings, handle: emptyHandle })
-          })
-        }
-      }
-    }
-    else {
-      if (!options.disable && options.registerWebManifestInRouteRules) {
-        nuxt.hook('nitro:config', async (nitroConfig) => {
-          nitroConfig.routeRules = nitroConfig.routeRules || {}
-          let swName = options.filename || 'sw.js'
-          if (options.strategies === 'injectManifest' && swName.endsWith('.ts'))
-            swName = swName.replace(/\.ts$/, '.js')
-
-          nitroConfig.routeRules[`${baseURL}${swName}`] = {
-            headers: {
-              'Cache-Control': 'public, max-age=0, must-revalidate',
-            },
-          }
-          // if provided by the user, we don't know web manifest name
-          if (options.manifest) {
-            nitroConfig.routeRules[`${baseURL}${options.manifestFilename ?? 'manifest.webmanifest'}`] = {
-              headers: {
-                'Content-Type': 'application/manifest+json',
-                'Cache-Control': 'public, max-age=0, must-revalidate',
-              },
-            }
-          }
-        })
-      }
-      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(),
-          )
-        })
-      }
-    }
-  },
-})
+import { join } from 'node:path'
+import { mkdir } from 'node:fs/promises'
+import { addComponent, addPluginTemplate, createResolver, defineNuxtModule, extendWebpackConfig } from '@nuxt/kit'
+import type { VitePluginPWAAPI } from 'vite-plugin-pwa'
+import { VitePWA } from 'vite-plugin-pwa'
+import type { Plugin } from 'vite'
+import type { ModuleOptions } from './types'
+import { configurePWAOptions } from './config'
+import { regeneratePWA, writeWebManifest } from './utils'
+
+export * from './types'
+
+export default defineNuxtModule<ModuleOptions>({
+  meta: {
+    name: 'pwa',
+    configKey: 'pwa',
+  },
+  defaults: nuxt => ({
+    base: nuxt.options.app.baseURL,
+    scope: nuxt.options.app.baseURL,
+    injectRegister: false,
+    includeManifestIcons: false,
+    registerPlugin: true,
+    writePlugin: false,
+    client: {
+      registerPlugin: true,
+      installPrompt: false,
+      periodicSyncForUpdates: 0,
+    },
+  }),
+  async setup(options, nuxt) {
+    const resolver = createResolver(import.meta.url)
+
+    let vitePwaClientPlugin: Plugin | undefined
+    const resolveVitePluginPWAAPI = (): VitePluginPWAAPI | undefined => {
+      return vitePwaClientPlugin?.api
+    }
+
+    const client = options.client ?? { registerPlugin: true, installPrompt: false, periodicSyncForUpdates: 0 }
+    if (client.registerPlugin) {
+      addPluginTemplate({
+        src: resolver.resolve('../templates/pwa.client.ts'),
+        write: nuxt.options.dev || options.writePlugin,
+        options: {
+          periodicSyncForUpdates: typeof client.periodicSyncForUpdates === 'number' ? client.periodicSyncForUpdates : 0,
+          installPrompt: (typeof client.installPrompt === 'undefined' || client.installPrompt === false)
+            ? undefined
+            : (client.installPrompt === true || client.installPrompt.trim() === '')
+                ? 'vite-pwa:hide-install'
+                : client.installPrompt.trim(),
+        },
+      })
+    }
+
+    await addComponent({
+      name: 'VitePwaManifest',
+      filePath: resolver.resolve('./runtime/VitePwaManifest'),
+    })
+
+    nuxt.hook('prepare:types', ({ references }) => {
+      references.push({ types: 'vite-plugin-pwa/vue' })
+      references.push({ types: 'vite-plugin-pwa/info' })
+    })
+
+    const manifestDir = join(nuxt.options.buildDir, 'manifests')
+    nuxt.options.nitro.publicAssets = nuxt.options.nitro.publicAssets || []
+    nuxt.options.nitro.publicAssets.push({
+      dir: manifestDir,
+      maxAge: 0,
+    })
+
+    nuxt.hook('nitro:init', (nitro) => {
+      configurePWAOptions(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')
+      if (plugin)
+        throw new Error('Remove vite-plugin-pwa plugin from Vite Plugins entry in Nuxt config file!')
+    })
+
+    nuxt.hook('vite:extendConfig', async (viteInlineConfig, { isClient }) => {
+      viteInlineConfig.plugins = viteInlineConfig.plugins || []
+      const plugin = viteInlineConfig.plugins.find(p => p && typeof p === 'object' && 'name' in p && p.name === 'vite-plugin-pwa')
+      if (plugin)
+        throw new Error('Remove vite-plugin-pwa plugin from Vite Plugins entry in Nuxt config file!')
+
+      if (options.manifest && isClient) {
+        viteInlineConfig.plugins.push({
+          name: 'vite-pwa-nuxt:webmanifest:build',
+          apply: 'build',
+          async writeBundle(_options, bundle) {
+            if (options.disable || !bundle)
+              return
+
+            const api = resolveVitePluginPWAAPI()
+            if (api) {
+              await mkdir(manifestDir, { recursive: true })
+              await writeWebManifest(manifestDir, options.manifestFilename || 'manifest.webmanifest', api)
+            }
+          },
+        })
+      }
+
+      // remove vite plugin pwa build plugin
+      const plugins = [...VitePWA(options).filter(p => p.name !== 'vite-plugin-pwa:build')]
+      viteInlineConfig.plugins.push(plugins)
+      if (isClient)
+        vitePwaClientPlugin = plugins.find(p => p.name === 'vite-plugin-pwa') as Plugin
+    })
+
+    extendWebpackConfig(() => {
+      throw new Error('Webpack is not supported: @vite-pwa/nuxt module can only be used with Vite!')
+    })
+
+    const baseURL = `${nuxt.options.runtimeConfig.app.baseURL}/`
+
+    if (nuxt.options.dev) {
+      const webManifest = `${nuxt.options.app.baseURL}${options.devOptions?.webManifestUrl ?? options.manifestFilename ?? 'manifest.webmanifest'}`
+      const devSw = `${nuxt.options.app.baseURL}dev-sw.js?dev-sw`
+      const workbox = `${nuxt.options.app.baseURL}workbox-`
+      // @ts-expect-error just ignore
+      const emptyHandle = (_req, _res, next) => {
+        next()
+      }
+      nuxt.hook('vite:serverCreated', (viteServer, { isServer }) => {
+        if (isServer)
+          return
+
+        viteServer.middlewares.stack.push({ route: webManifest, handle: emptyHandle })
+        viteServer.middlewares.stack.push({ route: devSw, handle: emptyHandle })
+      })
+
+      if (!options.strategies || options.strategies === 'generateSW') {
+        nuxt.hook('vite:serverCreated', (viteServer, { isServer }) => {
+          if (isServer)
+            return
+
+          viteServer.middlewares.stack.push({ route: workbox, handle: emptyHandle })
+        })
+        if (options.devOptions?.suppressWarnings) {
+          const suppressWarnings = `${nuxt.options.app.baseURL}suppress-warnings.js`
+          nuxt.hook('vite:serverCreated', (viteServer, { isServer }) => {
+            if (isServer)
+              return
+
+            viteServer.middlewares.stack.push({ route: suppressWarnings, handle: emptyHandle })
+          })
+        }
+      }
+    }
+    else {
+      if (!options.disable && options.registerWebManifestInRouteRules) {
+        nuxt.hook('nitro:config', async (nitroConfig) => {
+          nitroConfig.routeRules = nitroConfig.routeRules || {}
+          let swName = options.filename || 'sw.js'
+          if (options.strategies === 'injectManifest' && swName.endsWith('.ts'))
+            swName = swName.replace(/\.ts$/, '.js')
+
+          nitroConfig.routeRules[`${baseURL}${swName}`] = {
+            headers: {
+              'Cache-Control': 'public, max-age=0, must-revalidate',
+            },
+          }
+          // if provided by the user, we don't know web manifest name
+          if (options.manifest) {
+            nitroConfig.routeRules[`${baseURL}${options.manifestFilename ?? 'manifest.webmanifest'}`] = {
+              headers: {
+                'Content-Type': 'application/manifest+json',
+                'Cache-Control': 'public, max-age=0, must-revalidate',
+              },
+            }
+          }
+        })
+      }
+      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/src/pwa/runtime/VitePwaManifest.ts

@@ -1,33 +1,33 @@
-import type { MetaObject } from '@nuxt/schema'
-import { defineComponent, ref } from 'vue'
-import { pwaInfo } from 'virtual:pwa-info'
-import { useHead } from '#imports'
-
-export default defineComponent({
-  async setup() {
-    if (pwaInfo) {
-      const meta = ref<MetaObject>({ link: [] })
-      useHead(meta)
-
-      const { webManifest } = pwaInfo
-      if (webManifest) {
-        const { href, useCredentials } = webManifest
-        if (useCredentials) {
-          meta.value.link!.push({
-            rel: 'manifest',
-            href,
-            crossorigin: 'use-credentials',
-          })
-        }
-        else {
-          meta.value.link!.push({
-            rel: 'manifest',
-            href,
-          })
-        }
-      }
-    }
-
-    return () => null
-  },
-})
+import type { MetaObject } from '@nuxt/schema'
+import { defineComponent, ref } from 'vue'
+import { pwaInfo } from 'virtual:pwa-info'
+import { useHead } from '#imports'
+
+export default defineComponent({
+  async setup() {
+    if (pwaInfo) {
+      const meta = ref<MetaObject>({ link: [] })
+      useHead(meta)
+
+      const { webManifest } = pwaInfo
+      if (webManifest) {
+        const { href, useCredentials } = webManifest
+        if (useCredentials) {
+          meta.value.link!.push({
+            rel: 'manifest',
+            href,
+            crossorigin: 'use-credentials',
+          })
+        }
+        else {
+          meta.value.link!.push({
+            rel: 'manifest',
+            href,
+          })
+        }
+      }
+    }
+
+    return () => null
+  },
+})

package/src/pwa/types.ts

@@ -1,56 +1,56 @@
-import type { VitePWAOptions } from 'vite-plugin-pwa'
-import { type Ref, 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
-}
-
-// TODO: fix this issue upstream in nuxt/module-builder
-declare module '#app' {
-  interface NuxtApp {
-    $pwa: UnwrapNestedRefs<PwaInjection>
-  }
-}
-
-export 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
-}
-
-export interface ModuleOptions extends Partial<VitePWAOptions> {
-  registerWebManifestInRouteRules?: boolean
-  /**
-   * Writes the plugin to disk: defaults to false (debug).
-   */
-  writePlugin?: boolean
-  /**
-   * Options for plugin.
-   */
-  client?: ClientOptions
-}
+import type { VitePWAOptions } from 'vite-plugin-pwa'
+import { type Ref, 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
+}
+
+// TODO: fix this issue upstream in nuxt/module-builder
+declare module '#app' {
+  interface NuxtApp {
+    $pwa: UnwrapNestedRefs<PwaInjection>
+  }
+}
+
+export 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
+}
+
+export interface ModuleOptions extends Partial<VitePWAOptions> {
+  registerWebManifestInRouteRules?: boolean
+  /**
+   * Writes the plugin to disk: defaults to false (debug).
+   */
+  writePlugin?: boolean
+  /**
+   * Options for plugin.
+   */
+  client?: ClientOptions
+}

package/src/pwa/utils.ts

@@ -1,16 +1,16 @@
-import { writeFile } from 'node:fs/promises'
-import type { VitePluginPWAAPI } from 'vite-plugin-pwa'
-import { resolve } from 'pathe'
-
-export async function regeneratePWA(dir: string, api?: VitePluginPWAAPI) {
-  if (!api || api.disabled)
-    return
-
-  await api.generateSW()
-}
-
-export async function writeWebManifest(dir: string, path: string, api: VitePluginPWAAPI) {
-  const manifest = api.generateBundle({})?.[path]
-  if (manifest && 'source' in manifest)
-    await writeFile(resolve(dir, path), manifest.source, 'utf-8')
-}
+import { writeFile } from 'node:fs/promises'
+import type { VitePluginPWAAPI } from 'vite-plugin-pwa'
+import { resolve } from 'pathe'
+
+export async function regeneratePWA(dir: string, api?: VitePluginPWAAPI) {
+  if (!api || api.disabled)
+    return
+
+  await api.generateSW()
+}
+
+export async function writeWebManifest(dir: string, path: string, api: VitePluginPWAAPI) {
+  const manifest = api.generateBundle({})?.[path]
+  if (manifest && 'source' in manifest)
+    await writeFile(resolve(dir, path), manifest.source, 'utf-8')
+}