sveltekit-cache-first 1.0.0 → 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Isaac Boorman
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,74 @@
+<<<<<<< HEAD
+# SvelteKit Cache First
+
+A small library to make your SvelteKit Web App / PWA use a cache first approach: instant second visit loads and fast performance on poor network conditions.
+
+## Setup
+
+```bash
+npm install sveltekit-cache-first
+```
+
+```js
+// src/service-worker.js
+import { version, build, files } from '$service-worker';
+import { setupServiceWorker } from 'sveltekit-cache-first/sw';
+
+setupServiceWorker(self, { version, build, files });
+```
+
+#### Component method
+```svelte
+<script>
+	import { UpdateAvailable } from 'sveltekit-cache-first';
+</script>
+
+<UpdateAvailable>
+	{#snippet children({ accept })}
+		<h2>An update is available</h2>
+		<p>Refresh to update</p>
+		<button onclick={() => accept()}>Refresh</button>
+	{/snippet}
+</UpdateAvailable>
+
+<!-- Optional -->
+<!-- Note: This will disappear after the update has been detected, which may take a few seconds to appear. Only use this if your app must always be running the latest version. And if that is that is the case, strongly consider if cache-first is the right approach, or use other methods like api versioning. -->
+<NoUpdate>
+	Main logic here
+</NoUpdate>
+```
+
+#### Custom handler method, using [svelte-sonner](https://github.com/wobsoriano/svelte-sonner)
+```js
+// src/routes/+layout.svelte
+import { toast } from 'svelte-sonner';
+import { onUpdate } from 'sveltekit-cache-first';
+
+onMount(() => {
+	onUpdate((accept) => {
+		// Your notification logic here, eg:
+		toast('An update is available', {
+			description: 'Refresh to update',
+			action: {
+				label: 'Refresh',
+				onClick: () => accept()
+			}
+		});
+	});
+});
+```
+
+## Config
+
+```js
+// default values
+const options = {
+	cachePageData: false, // Cache _data.json: data returned by load functions
+	ignoredRoutes: ['/api'] // Routes to always fetch fresh for
+};
+
+setupServiceWorker(self, { version, build, files, options });
+=======
 # Svelte library
 
 Everything you need to build a Svelte library, powered by [`sv`](https://npmjs.com/package/sv).
@@ -62,4 +133,5 @@ To publish your library to [npm](https://www.npmjs.com):
 
 ```sh
 npm publish
+>>>>>>> b1866e7 (Fix imports and double updates)
 ```

package/dist/update.d.ts

@@ -0,0 +1 @@
+export declare function onUpdate(handle: (onAccept: () => void) => void): void;

package/dist/update.js

@@ -0,0 +1,63 @@
+function getVersion(worker) {
+    return new Promise((resolve) => {
+        const channel = new MessageChannel();
+        channel.port1.onmessage = (e) => resolve(e.data ?? null);
+        worker.postMessage({ type: 'SKLOCALFIRST_GET_VERSION' }, [channel.port2]);
+    });
+}
+async function checkVersionChanged(worker) {
+    const version = await getVersion(worker);
+    if (!version)
+        return false;
+    const lastPrompted = localStorage.getItem('lastPrompted');
+    if (lastPrompted === version)
+        return false;
+    localStorage.setItem('lastPrompted', version);
+    return true;
+}
+function handleAccept(worker) {
+    worker.postMessage({ type: 'SKLOCALFIRST_SKIP_WAITING' });
+}
+const handlers = [];
+let listenerSetUp = false;
+function setupSWListener() {
+    if (!('serviceWorker' in navigator)) {
+        return () => { };
+    }
+    navigator.serviceWorker.getRegistration().then(async (reg) => {
+        if (!reg)
+            return;
+        // 1️⃣ Detect if a waiting SW already exists
+        if (reg.waiting) {
+            const sw = reg.waiting;
+            if (await checkVersionChanged(sw)) {
+                handlers.forEach((handle) => handle(() => handleAccept(sw)));
+            }
+        }
+        // 2️⃣ Listen for new SW installations
+        reg.addEventListener('updatefound', () => {
+            const sw = reg.installing;
+            if (!sw)
+                return;
+            sw.addEventListener('statechange', async () => {
+                if (sw.state === 'installed' && navigator.serviceWorker.controller) {
+                    if (await checkVersionChanged(sw)) {
+                        handlers.forEach((handle) => handle(() => handleAccept(sw)));
+                    }
+                }
+            });
+        });
+    });
+    // 3️⃣ Reload page when the new SW takes control
+    navigator.serviceWorker.addEventListener('controllerchange', () => {
+        window.location.reload();
+    });
+    listenerSetUp = true;
+}
+export function onUpdate(handle) {
+    handlers.push(handle);
+    if (!listenerSetUp) {
+        setupSWListener();
+    }
+    handlers.push(handle);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "sveltekit-cache-first",
-	"version": "1.0.0",
+	"version": "1.1.0",
 	"repository": "github:isaxk/sveltekit-cache-first",
 	"scripts": {
 		"dev": "vite dev",
@@ -28,6 +28,14 @@
 		".": {
 			"types": "./dist/index.d.ts",
 			"svelte": "./dist/index.js"
+		},
+		"sw": {
+			"types": "./dist/sw.d.ts",
+			"svelte": "./dist/sw.js"
+		},
+		"client": {
+			"types": "./dist/client.d.ts",
+			"svelte": "./dist/client.js"
 		}
 	},
 	"peerDependencies": {