FAQ #

IDE errors 'Cannot find module' (ts2307) #

{
  "compilerOptions": {
    "types": [
      "vite-plugin-pwa/client"
    ]
  }
}

{
  "compilerOptions": {
    "types": [
      "vite-plugin-pwa/client"
    ]
  }
}

/// <reference types="vite-plugin-pwa/client" />

/// <reference types="vite-plugin-pwa/client" />

Type declarations #

You can find the full list of the vite-plugin-pwa plugin configuration options in the following types.ts module.

You can find all the vite-plugin-pwa virtual modules declarations in the following client.d.ts.

Web app manifest and 401 status code (Unauthorized) #

Browsers send requests for the web manifest without credentials, so if your site sits behind auth, the request will fail with a 401 Unauthorized error – even if the user is logged in.

To send the request with credentials, the <link rel="manifest"> needs a crossorigin="use-credentials" attribute, which you can enable via useCredentials in the plugin options:

useCredentials: true

useCredentials: true

Service Worker errors on browser #

If your service worker code is being compiled with unexpected exports (for example: export default require_sw();), you can change the build output format to iief, add the following code to your pwa configuration:

injectManifest: {
  rollupFormat: 'iief'
}

injectManifest: {
  rollupFormat: 'iief'
}

Error: Unable to find a place to inject the manifest #

If you're using a custom service worker without precaching (self.__WB_MANIFEST) and you're getting this error on build process, you need to disable injection point in your pwa plugin configuration (available only from version ^0.14.0):

injectManifest: {
  injectionPoint: undefined
}

injectManifest: {
  injectionPoint: undefined
}

Service Worker Registration Errors #

You can handle Service Worker registration errors if you want to notify the user with following code on your main.ts or main.js:

import { registerSW } from 'virtual:pwa-register'

const updateSW = registerSW({
  onRegisterError(error) {}
})

import { registerSW } from 'virtual:pwa-register'

const updateSW = registerSW({
  onRegisterError(error) {}
})

and then inside onRegisterError, just notify the user that there was an error registering the service worker.

Missing assets from SW precache manifest #

If you find any assets are missing from the service worker's precache manifest, you should check if they exceed the maximumFileSizeToCacheInBytes, the default value is 2 MiB.

You can increase the value to your needs, for example to allow assets up to 3 MiB:

• when using generateSW strategy:

workbox: {
  maximumFileSizeToCacheInBytes: 3000000
}

workbox: {
  maximumFileSizeToCacheInBytes: 3000000
}

• when using injectManifest strategy:

injectManifest: {
  maximumFileSizeToCacheInBytes: 3000000
}

injectManifest: {
  maximumFileSizeToCacheInBytes: 3000000
}

Exclude routes #

If you need to exclude some routes from service worker interception:

• for generateSW strategy
• for injectManifest strategy

navigator / window is undefined #

If you are getting navigator is undefined or window is undefined errors when building your application, you have configured your application in an SSR / SSG environment.

The error could be due to using this plugin or another library not aware of SSR / SSG: your code will be called on the client but also on the server side on build process, so when building the application your server logic will be invoked, and there is no navigator / window on the server, it is undefined.

Third party libraries #

If the cause of the error is a third party library that is not aware of the SSR / SSG environment, the way to work around the error is to import it with a dynamic import when window is defined:

if (typeof window !== 'undefined')
  import('./library-not-ssr-ssg-aware')

if (typeof window !== 'undefined')
  import('./library-not-ssr-ssg-aware')

Alternatively, if your framework supports component onMount / onMounted lifecycle hook, you can import the third party library on the callback, since the frameworks should call this lifecycle hook only on client side, you should check your framework documentation.

Vite PWA Virtual Module #

If the cause of the error is the virtual module of this plugin, you can work around this problem following SSR/SSG: Prompt for update or SSR/SSG: Automatic reload entries.

If you are using autoUpdate strategy and a router with isReady support (that is, the router allow register a callback to be called when the current component route finish loading), you can delay the service worker registration to be on the router callback.

For example, using vue-router, you can register the service worker for autoUpdate strategy using this code:

import type { Router } from 'vue-router'
export const registerPWA = (router: Router) => {
  router.isReady().then(async () => {
    const { registerSW } = await import('virtual:pwa-register')
    registerSW({ immediate: true })
  })
}

import type { Router } from 'vue-router'
export const registerPWA = (router: Router) => {
  router.isReady().then(async () => {
    const { registerSW } = await import('virtual:pwa-register')
    registerSW({ immediate: true })
  })
}

You can see an example for autoUpdate strategy on a SSR / SSG environment (vite-ssg) on Vitesse Template.

If you are using prompt strategy, you will need to load the ReloadPrompt component using dynamic import with async fashion, for example, using vue 3:

// src/App.vue
<script setup lang='ts'>
import { defineAsyncComponent } from 'vue'
const ClientReloadPrompt = typeof window !== 'undefined'
  ? defineAsyncComponent(() => import('./ReloadPrompt.vue'))
  : null
</script>

<template>
  <router-view />
  <template v-if="ClientReloadPrompt">
    <ClientReloadPrompt />
  </template>
</template>

// src/App.vue
<script setup lang='ts'>
import { defineAsyncComponent } from 'vue'
const ClientReloadPrompt = typeof window !== 'undefined'
  ? defineAsyncComponent(() => import('./ReloadPrompt.vue'))
  : null
</script>

<template>
  <router-view />
  <template v-if="ClientReloadPrompt">
    <ClientReloadPrompt />
  </template>
</template>

or using svelte:

<!-- App.svelte -->
<script>
  import { onMount } from 'svelte';
  let ClientReloadPrompt;
  onMount(async () => {
    typeof window !== 'undefined' && (ClientReloadPrompt = await import('$lib/ReloadPrompt.svelte')).default)
  })
</script>
...
{#if ClientReloadPrompt}
<svelte:component this={ClientReloadPrompt}/>
{/if}

<!-- App.svelte -->
<script>
  import { onMount } from 'svelte';
  let ClientReloadPrompt;
  onMount(async () => {
    typeof window !== 'undefined' && (ClientReloadPrompt = await import('$lib/ReloadPrompt.svelte')).default)
  })
</script>
...
{#if ClientReloadPrompt}
<svelte:component this={ClientReloadPrompt}/>
{/if}

You can check your SSR / SSG environment to see if it provides some way to register components only on client side. Following with vite-ssg on Vitesse Template, it provides ClientOnly functional component, that will prevent registering components on server side, and so you can use the original code but enclosing ReloadPrompt component with it:

// src/App.vue
<template>
  ...
  <ClientOnly>
    <ReloadPrompt />
  </ClientOnly>
</template>

// src/App.vue
<template>
  ...
  <ClientOnly>
    <ReloadPrompt />
  </ClientOnly>
</template>

VitePress #

You can check the ReloadPrompt component of this site to call the PWA virtual module:

<script setup lang="ts">
import { onBeforeMount, ref } from 'vue'

const needRefresh = ref(false)

let updateServiceWorker: (() => Promise<void>) | undefined

const onNeedRefresh = () => {
  needRefresh.value = true
}
const close = async () => {
  needRefresh.value = false
}

onBeforeMount(async () => {
  const { registerSW } = await import('virtual:pwa-register')
  updateServiceWorker = registerSW({
    immediate: true,
    onNeedRefresh,
  })
})
</script>

<script setup lang="ts">
import { onBeforeMount, ref } from 'vue'

const needRefresh = ref(false)

let updateServiceWorker: (() => Promise<void>) | undefined

const onNeedRefresh = () => {
  needRefresh.value = true
}
const close = async () => {
  needRefresh.value = false
}

onBeforeMount(async () => {
  const { registerSW } = await import('virtual:pwa-register')
  updateServiceWorker = registerSW({
    immediate: true,
    onNeedRefresh,
  })
})
</script>