@wells-nelson/build-tools 1.0.1 → 1.0.2

package/README.md

@@ -40,14 +40,19 @@ export default defineConfig(({ mode, command }) => ({
 
 ```ts
 /// <reference types="@sveltejs/kit" />
-import { version } from '$app/env';
+import { dev, version } from '$app/env';
 import { assets, immutable } from '$app/manifest';
 import { self } from '$app/service-worker';
 import { registerAppShellCache } from '@wells-nelson/build-tools/service-worker';
 
-registerAppShellCache({ sw: self, version, files: [...immutable, ...assets], cachePrefix: 'my-app' });
+registerAppShellCache({ sw: self, version, dev, files: [...immutable, ...assets], cachePrefix: 'my-app' });
 ```
 
+Navigations go to the network first, so starting the app online always loads the latest deploy;
+offline they fall back to the cached shell. A new worker skips waiting and takes over open
+pages. `networkOnly` paths are never cached (default: SvelteKit's `_app/version.json`, so
+`updated` from `$app/state` notices new deploys). `dev` caches nothing.
+
 ## Templates
 
 `templates/deploy-pages.yml` (replace `__REPO__`) and `templates/manifest.webmanifest`.

package/dist/service-worker.d.ts

@@ -1,7 +1,9 @@
 /**
  * Offline-first app shell for a SvelteKit service worker. Everything the app needs is precached
- * on install; navigations fall back to the cached shell (the app root) when the network is
- * unavailable; cross-origin requests (Supabase, Google avatars) are left to the network.
+ * on install; navigations go to the network first (so starting the app online always
+ * loads the latest deploy) and fall back to the cached shell (the app root) offline. A new
+ * deploy's worker installs, skips waiting and takes over open pages straight away. Cross-origin
+ * requests (Supabase, Google avatars) are left to the network.
  *
  * ```ts
  * // src/service-worker/index.ts
@@ -40,8 +42,14 @@ export interface AppShellCacheOptions {
      * loads (a cache-first worker would otherwise keep serving stale dev modules).
      */
     dev?: boolean;
+    /**
+     * Paths (relative to the scope) that always go to the network and are never cached. Defaults
+     * to SvelteKit's `_app/version.json`, so its update check (`updated` in `$app/state`) sees
+     * new deploys instead of the first answer it ever cached.
+     */
+    networkOnly?: string[];
 }
-export declare function registerAppShellCache({ sw, version, files, cachePrefix, dev }: AppShellCacheOptions): {
+export declare function registerAppShellCache({ sw, version, files, cachePrefix, dev, networkOnly }: AppShellCacheOptions): {
     cacheName: null;
     precache: never[];
 } | {

package/dist/service-worker.js

@@ -1,7 +1,9 @@
 /**
  * Offline-first app shell for a SvelteKit service worker. Everything the app needs is precached
- * on install; navigations fall back to the cached shell (the app root) when the network is
- * unavailable; cross-origin requests (Supabase, Google avatars) are left to the network.
+ * on install; navigations go to the network first (so starting the app online always
+ * loads the latest deploy) and fall back to the cached shell (the app root) offline. A new
+ * deploy's worker installs, skips waiting and takes over open pages straight away. Cross-origin
+ * requests (Supabase, Google avatars) are left to the network.
  *
  * ```ts
  * // src/service-worker/index.ts
@@ -14,7 +16,7 @@
  * registerAppShellCache({ sw: self, version, dev, files: [...immutable, ...assets], cachePrefix: 'my-app' });
  * ```
  */
-export function registerAppShellCache({ sw, version, files, cachePrefix = 'app', dev = false }) {
+export function registerAppShellCache({ sw, version, files, cachePrefix = 'app', dev = false, networkOnly = ['_app/version.json'] }) {
     const CACHE = `${cachePrefix}-cache-${version}`;
     if (dev) {
         sw.addEventListener('install', (event) => event.waitUntil(sw.skipWaiting()));
@@ -31,6 +33,7 @@ export function registerAppShellCache({ sw, version, files, cachePrefix = 'app',
     const scope = new URL(sw.registration.scope);
     // The app root serves the SPA shell (index.html on GitHub Pages, the fallback page elsewhere).
     const SHELL = scope.href;
+    const NETWORK_ONLY = new Set(networkOnly.map((p) => new URL(p, scope).pathname));
     const PRECACHE = files.map((f) => new URL(typeof f === 'string' ? f : f.path, scope).href).concat(SHELL);
     sw.addEventListener('install', (event) => {
         event.waitUntil((async () => {
@@ -52,7 +55,7 @@ export function registerAppShellCache({ sw, version, files, cachePrefix = 'app',
         if (request.method !== 'GET')
             return;
         const url = new URL(request.url);
-        if (url.origin !== scope.origin)
+        if (url.origin !== scope.origin || NETWORK_ONLY.has(url.pathname))
             return;
         if (request.mode === 'navigate') {
             event.respondWith((async () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wells-nelson/build-tools",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "Build and deployment tooling for Wells Nelson SvelteKit PWAs: postbuild, PWA icon generator, Vite config pieces, service worker, and templates.",
   "license": "MIT",
   "repository": {