@nkzw/fate-indexeddb 1.5.0 → 1.5.1

package/README.md

@@ -1354,13 +1354,13 @@ Then pass `persistence` when creating the client:
 
 ```tsx
 import { createPersistence } from '@nkzw/fate/persistence';
-import { indexedDB } from '@nkzw/fate-indexeddb';
+import { createIndexedDBStorage } from '@nkzw/fate-indexeddb';
 import { createFateClient } from 'react-fate/client';
 
 const fate = createFateClient({
   persistence: createPersistence({
     key: `workspace:${workspaceId}:user:${userId}`,
-    storage: indexedDB(),
+    storage: createIndexedDBStorage(),
   }),
   url: '/api/fate',
 });
@@ -1373,7 +1373,7 @@ persistence: createPersistence({
   key: `workspace:${workspaceId}:user:${userId}`,
   maxAge: 24 * 60 * 60 * 1000,
   maxBytes: 25 * 1024 * 1024,
-  storage: indexedDB(),
+  storage: createIndexedDBStorage(),
 }),
 ```
 
@@ -1545,7 +1545,7 @@ const durableHTTP = createHTTPTransport<MyAPI>({
 
 const fate = createFateClient({
   // ...your generated tRPC or GraphQL client options...
-  persistence: createPersistence({ key: accountKey, storage: indexedDB() }),
+  persistence: createPersistence({ key: accountKey, storage: createIndexedDBStorage() }),
   mutateDurably: durableHTTP.mutateDurably,
 });
 ```
@@ -1635,7 +1635,6 @@ The core persistence layer has no IndexedDB dependency. You can use another back
 ```ts
 interface PersistenceStorage {
   read(key: string): Promise<unknown>;
-  write(key: string, value: unknown): Promise<void>;
   scan(
     prefix: string,
     after?: string,
@@ -1650,9 +1649,8 @@ interface PersistenceStorage {
 Values use fate's hydration codec and can be stored as JSON. The adapter handles storage and coordination:
 
 - `read` returns the saved value for a key.
-- `write` replaces one value atomically and resolves after it has committed.
 - `scan` returns keys under a prefix in ascending order, strictly after the optional cursor, up to the limit (64 by default). Use your backend's ordered index to keep each scan small.
-- `writeBatch` commits all entries atomically. An `undefined` value deletes the key.
+- `writeBatch` commits all entries atomically and resolves after they have committed. An `undefined` value deletes the key. Use a one-entry batch for a single write.
 - `exclusive` coordinates every tab or process sharing the backend. Different lock names are independent: fate holds a delivery lock during network work and acquires a separate write lock when updating storage. Your adapter must allow that nesting.
 - `subscribe` notifies other clients after a change commits, including keys changed by `writeBatch`. Without notifications, clients check saved mutations during delivery attempts and explicit `retry()` calls.
 

package/lib/index.d.mts

@@ -1,7 +1,8 @@
 import { PersistenceStorage } from "@nkzw/fate/persistence";
 //#region src/index.d.ts
-declare function indexedDB({ name }?: {
+type IndexedDBStorageOptions = Readonly<{
   name?: string;
-}): PersistenceStorage;
+}>;
+declare function createIndexedDBStorage({ name }?: IndexedDBStorageOptions): PersistenceStorage;
 //#endregion
-export { indexedDB };
+export { IndexedDBStorageOptions, createIndexedDBStorage };

package/lib/index.mjs

@@ -1,23 +1,23 @@
 import { openDB } from "idb";
 //#region src/index.ts
-function indexedDB({ name = "fate" } = {}) {
-	let leases = 0;
+function createIndexedDBStorage({ name = "fate" } = {}) {
+	let connectionLeases = 0;
 	let connection;
-	const release = () => {
-		if (--leases === 0) {
+	const releaseDatabase = () => {
+		if (--connectionLeases === 0) {
 			const previous = connection;
 			connection = void 0;
 			previous?.then((db) => db.close(), () => {});
 		}
 	};
-	const database = async () => {
-		leases++;
+	const acquireDatabase = async () => {
+		connectionLeases++;
 		try {
 			return await (connection ??= openDB(name, 1, { upgrade(db) {
 				db.createObjectStore("fate");
 			} }));
 		} catch (error) {
-			release();
+			releaseDatabase();
 			throw error;
 		}
 	};
@@ -43,24 +43,24 @@ function indexedDB({ name = "fate" } = {}) {
 		exclusive(key, run) {
 			if (typeof navigator === "undefined" || !navigator.locks) throw new Error("fate(indexeddb): Web Locks are required for safe durable writes across tabs.");
 			return navigator.locks.request(`fate:${JSON.stringify([name, key])}`, async () => {
-				leases++;
+				connectionLeases++;
 				try {
 					return await run();
 				} finally {
-					release();
+					releaseDatabase();
 				}
 			});
 		},
 		async read(key) {
-			const db = await database();
+			const db = await acquireDatabase();
 			try {
 				return await db.get("fate", key);
 			} finally {
-				release();
+				releaseDatabase();
 			}
 		},
 		async scan(prefix, after, limit = 64) {
-			const db = await database();
+			const db = await acquireDatabase();
 			try {
 				const range = IDBKeyRange.lowerBound(after !== void 0 && after >= prefix ? after : prefix, after !== void 0 && after >= prefix);
 				const transaction = db.transaction("fate");
@@ -76,7 +76,7 @@ function indexedDB({ name = "fate" } = {}) {
 				await transaction.done;
 				return entries;
 			} finally {
-				release();
+				releaseDatabase();
 			}
 		},
 		subscribe(key, listener) {
@@ -101,19 +101,8 @@ function indexedDB({ name = "fate" } = {}) {
 				}
 			};
 		},
-		async write(key, value) {
-			const db = await database();
-			try {
-				const transaction = db.transaction("fate", "readwrite");
-				await transaction.store.put(value, key);
-				await transaction.done;
-			} finally {
-				release();
-			}
-			broadcast([key]);
-		},
 		async writeBatch(entries) {
-			const db = await database();
+			const db = await acquireDatabase();
 			try {
 				const transaction = db.transaction("fate", "readwrite");
 				try {
@@ -127,11 +116,11 @@ function indexedDB({ name = "fate" } = {}) {
 					throw error;
 				}
 			} finally {
-				release();
+				releaseDatabase();
 			}
 			broadcast([...new Set(entries.map(([key]) => key))]);
 		}
 	};
 }
 //#endregion
-export { indexedDB };
+export { createIndexedDBStorage };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nkzw/fate-indexeddb",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "Optional IndexedDB persistence adapter for fate.",
   "license": "MIT",
   "files": [
@@ -22,10 +22,10 @@
     "fake-indexeddb": "^6.2.4",
     "vite": "npm:@voidzero-dev/vite-plus-core@0.3.0",
     "vite-plus": "0.3.0",
-    "@nkzw/fate": "1.5.0"
+    "@nkzw/fate": "1.5.1"
   },
   "peerDependencies": {
-    "@nkzw/fate": "^1.4.0"
+    "@nkzw/fate": "^1.5.1"
   },
   "scripts": {
     "build": "vp pack --tsconfig tsconfig.json -d lib src/index.ts"