feat: add new option to include kit version.json file to sw precache (#…

…75)

* feat: add new option to include kit version.json file to sw precache

* chore: update jsdocs

examples/sveltekit-ts/client-test/sw.spec.ts

@@ -47,5 +47,5 @@ test('The service worker is registered and cache storage is present', async ({ p
  // dontCacheBustURLsMatching: any asset in _app/immutable folder shouldn't have a revision (?__WB_REVISION__=)
  expect(urls.some(url => url.startsWith('_app/immutable/') && url.endsWith('.css'))).toEqual(true)
  expect(urls.some(url => url.startsWith('_app/immutable/') && url.endsWith('.js'))).toEqual(true)
- // expect(urls.some(url => url.includes('_app/version.json?__WB_REVISION__='))).toEqual(true)
+ expect(urls.some(url => url.includes('_app/version.json?__WB_REVISION__='))).toEqual(true)
 });

examples/sveltekit-ts/playwright.config.ts

@@ -2,6 +2,8 @@ import { defineConfig, devices } from '@playwright/test'
 
 const url = 'http://localhost:4173'
 
+// eslint-disable-next-line @typescript-eslint/ban-ts-comment
+// @ts-ignore
 import { nodeAdapter } from './adapter.mjs'
 
 /**

examples/sveltekit-ts/vite.config.ts

@@ -76,7 +76,9 @@ const config: UserConfig = {
  navigateFallback: '/',
  },
  // if you have shared info in svelte config file put in a separate module and use it also here
- kit: {}
+ kit: {
+ includeVersionFile: true,
+ }
  }
  )
  ]

src/config.ts

@@ -52,24 +52,24 @@ export function configureSvelteKitOptions(
  if (!config.globDirectory)
  config.globDirectory = `${outDir}/output`
 
- if (!config.modifyURLPrefix)
+ let buildAssetsDir = kit.appDir ?? '_app/'
+ if (buildAssetsDir[0] === '/')
+ buildAssetsDir = buildAssetsDir.slice(1)
+ if (buildAssetsDir[buildAssetsDir.length - 1] !== '/')
+ buildAssetsDir += '/'
+
+ if (!config.modifyURLPrefix) {
  config.globPatterns = buildGlobPatterns(config.globPatterns)
+ if (kit.includeVersionFile)
+ config.globPatterns.push(`client/${buildAssetsDir}version.json`)
+ }
 
  // exclude server assets: sw is built on SSR build
  config.globIgnores = buildGlobIgnores(config.globIgnores)
 
  // Vite 5 support: allow override dontCacheBustURLsMatching
- if (!('dontCacheBustURLsMatching' in config)) {
- let buildAssetsDir = kit.appDir ?? '_app/'
- if (buildAssetsDir[0] === '/')
- buildAssetsDir = buildAssetsDir.slice(1)
- if (buildAssetsDir[buildAssetsDir.length - 1] !== '/')
- buildAssetsDir += '/'
-
- buildAssetsDir += 'immutable/'
-
- config.dontCacheBustURLsMatching = new RegExp(buildAssetsDir)
- }
+ if (!('dontCacheBustURLsMatching' in config))
+ config.dontCacheBustURLsMatching = new RegExp(`${buildAssetsDir}immutable/`)
 
  if (!config.manifestTransforms) {
  config.manifestTransforms = [createManifestTransform(
@@ -105,10 +105,8 @@ function createManifestTransform(base: string, webManifestName?: string, options
  // fallback page in `.svelte-kit/output/prerendered` folder (fallback.html is the default).
  if (url.startsWith('client/'))
  url = url.slice(7)
-
  else if (url.startsWith('prerendered/pages/'))
  url = url.slice(18)
-
  else if (url === defaultAdapterFallback)
  url = adapterFallback!
 

src/types.ts

@@ -32,6 +32,13 @@ export interface KitOptions {
  * @see https://kit.svelte.dev/docs/configuration#appdir
  */
  appDir?: string
+
+ /**
+ * Include `${appDir}/version.json` in the service worker precache manifest?
+ *
+ * @default false
+ */
+ includeVersionFile?: boolean
 }
 
 export interface SvelteKitPWAOptions extends Partial<VitePWAOptions> {