@vezham/hooks 26.2.0 → 26.3.0

package/dist/index.d.ts

@@ -2,4 +2,5 @@ export { AppContext, useApp, type AppIdentity } from './lib/use-app';
 export { CommandContext, useCommand } from './lib/use-command';
 export { useLocalStore, type LocalStoreOptions } from './lib/use-local-store';
 export { useCopyToClipboard, type CopyToClipboardStatus } from './lib/use-copy-to-clipboard';
+export { useIndexedDBStore, type IndexedDBMutationOptions, type IndexedDBStoreOptions } from './lib/use-indexed-db-store';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,WAAW,EAAE,MAAM,eAAe,CAAA;AACpE,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAC9D,OAAO,EAAE,aAAa,EAAE,KAAK,iBAAiB,EAAE,MAAM,uBAAuB,CAAA;AAC7E,OAAO,EACL,kBAAkB,EAClB,KAAK,qBAAqB,EAC3B,MAAM,6BAA6B,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,KAAK,WAAW,EAAE,MAAM,eAAe,CAAA;AACpE,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAC9D,OAAO,EAAE,aAAa,EAAE,KAAK,iBAAiB,EAAE,MAAM,uBAAuB,CAAA;AAC7E,OAAO,EACL,kBAAkB,EAClB,KAAK,qBAAqB,EAC3B,MAAM,6BAA6B,CAAA;AAEpC,OAAO,EACL,iBAAiB,EACjB,KAAK,wBAAwB,EAC7B,KAAK,qBAAqB,EAC3B,MAAM,4BAA4B,CAAA"}

package/dist/index.js

@@ -2,4 +2,5 @@ import { AppContext, useApp } from "./lib/use-app/index.js";
 import { CommandContext, useCommand } from "./lib/use-command/index.js";
 import { useLocalStore } from "./lib/use-local-store/index.js";
 import { useCopyToClipboard } from "./lib/use-copy-to-clipboard/index.js";
-export { AppContext, CommandContext, useApp, useCommand, useCopyToClipboard, useLocalStore };
+import { useIndexedDBStore } from "./lib/use-indexed-db-store/index.js";
+export { AppContext, CommandContext, useApp, useCommand, useCopyToClipboard, useIndexedDBStore, useLocalStore };

package/dist/lib/use-indexed-db-store/database.d.ts

@@ -0,0 +1,6 @@
+export interface IndexedDBMutationOptions {
+    optimistic?: boolean;
+    deletePrefixes?: readonly string[];
+}
+export declare const updateIndexedDBValue: <T>(factory: IDBFactory | undefined, key: string, initialValue: T, parse?: (value: unknown) => T, update?: (current: T) => T, options?: IndexedDBMutationOptions) => Promise<T>;
+//# sourceMappingURL=database.d.ts.map

package/dist/lib/use-indexed-db-store/database.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"database.d.ts","sourceRoot":"","sources":["../../../src/lib/use-indexed-db-store/database.ts"],"names":[],"mappings":"AAIA,MAAM,WAAW,wBAAwB;IACvC,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB,cAAc,CAAC,EAAE,SAAS,MAAM,EAAE,CAAA;CACnC;AA+BD,eAAO,MAAM,oBAAoB,GAAU,CAAC,EAC1C,SAAS,UAAU,GAAG,SAAS,EAC/B,KAAK,MAAM,EACX,cAAc,CAAC,EACf,QAAQ,CAAC,KAAK,EAAE,OAAO,KAAK,CAAC,EAC7B,SAAS,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,EAC1B,UAAS,wBAA6B,KACrC,OAAO,CAAC,CAAC,CAwEX,CAAA"}

package/dist/lib/use-indexed-db-store/database.js

@@ -0,0 +1,83 @@
+//#region src/lib/use-indexed-db-store/database.ts
+var INDEXED_DB_NAME = "vezham";
+var RECORDS = "records";
+var DELETED_PREFIXES = "\0deleted-prefixes";
+var openDatabase = (factory) => new Promise((resolve, reject) => {
+	if (!factory) {
+		reject(/* @__PURE__ */ new Error("IndexedDB is unavailable in this browser."));
+		return;
+	}
+	const request = factory.open(INDEXED_DB_NAME, 1);
+	let blocked = false;
+	request.onupgradeneeded = () => {
+		if (!request.result.objectStoreNames.contains(RECORDS)) request.result.createObjectStore(RECORDS);
+	};
+	request.onerror = () => reject(request.error ?? /* @__PURE__ */ new Error("Unable to open IndexedDB."));
+	request.onblocked = () => {
+		blocked = true;
+		reject(/* @__PURE__ */ new Error("IndexedDB is blocked by another open page."));
+	};
+	request.onsuccess = () => {
+		if (blocked) {
+			request.result.close();
+			return;
+		}
+		request.result.onversionchange = () => request.result.close();
+		resolve(request.result);
+	};
+});
+var updateIndexedDBValue = async (factory, key, initialValue, parse, update, options = {}) => {
+	const database = await openDatabase(factory);
+	return new Promise((resolve, reject) => {
+		let value;
+		let failure;
+		const transaction = database.transaction(RECORDS, "readwrite");
+		const records = transaction.objectStore(RECORDS);
+		const deletedRequest = records.get(DELETED_PREFIXES);
+		deletedRequest.onsuccess = () => {
+			const deleted = deletedRequest.result ?? [];
+			if (deleted.some((prefix) => key.startsWith(prefix))) {
+				failure = /* @__PURE__ */ new Error("This data scope has been deleted.");
+				transaction.abort();
+				return;
+			}
+			const request = records.get(key);
+			request.onsuccess = () => {
+				try {
+					const stored = request.result;
+					const current = stored === void 0 ? initialValue : parse ? parse(stored) : stored;
+					value = update ? update(current) : current;
+					if (update || stored === void 0) records.put(value, key);
+					const prefixes = options.deletePrefixes ?? [];
+					if (prefixes.length) {
+						if (!update || prefixes.some((prefix) => !prefix || key.startsWith(prefix))) throw new Error("Invalid IndexedDB deletion scope.");
+						records.put([.../* @__PURE__ */ new Set([...deleted, ...prefixes])], DELETED_PREFIXES);
+						const cursor = records.openCursor();
+						cursor.onsuccess = () => {
+							const entry = cursor.result;
+							if (!entry) return;
+							if (typeof entry.key === "string" && prefixes.some((prefix) => entry.key.toString().startsWith(prefix))) entry.delete();
+							entry.continue();
+						};
+					}
+				} catch (cause) {
+					failure = cause;
+					transaction.abort();
+				}
+			};
+		};
+		transaction.oncomplete = () => {
+			database.close();
+			resolve(value);
+		};
+		transaction.onabort = () => {
+			database.close();
+			reject(failure ?? transaction.error ?? /* @__PURE__ */ new Error("IndexedDB transaction was aborted."));
+		};
+		transaction.onerror = () => {
+			failure ??= transaction.error;
+		};
+	});
+};
+//#endregion
+export { updateIndexedDBValue };

package/dist/lib/use-indexed-db-store/index.d.ts

@@ -0,0 +1,13 @@
+import type { IndexedDBStoreOptions } from './indexed-db-store';
+export declare const useIndexedDBStore: <T>(key: string, initialValue: T, options?: IndexedDBStoreOptions<T>) => {
+    setValue: (update: T | ((current: T) => T), options?: import("./database").IndexedDBMutationOptions) => Promise<boolean>;
+    flush: () => Promise<undefined>;
+    refresh: () => Promise<undefined>;
+    value: T;
+    isReady: boolean;
+    isSaved: boolean;
+    error: unknown;
+};
+export type { IndexedDBStoreOptions } from './indexed-db-store';
+export type { IndexedDBMutationOptions } from './database';
+//# sourceMappingURL=index.d.ts.map

package/dist/lib/use-indexed-db-store/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/lib/use-indexed-db-store/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAA;AAI/D,eAAO,MAAM,iBAAiB,GAAI,CAAC,EACjC,KAAK,MAAM,EACX,cAAc,CAAC,EACf,UAAS,qBAAqB,CAAC,CAAC,CAAM;;;;;;;;CAkBvC,CAAA;AAED,YAAY,EAAE,qBAAqB,EAAE,MAAM,oBAAoB,CAAA;AAE/D,YAAY,EAAE,wBAAwB,EAAE,MAAM,YAAY,CAAA"}

package/dist/lib/use-indexed-db-store/index.js

@@ -0,0 +1,20 @@
+import { getIndexedDBStore } from "./indexed-db-store.js";
+import { useMemo, useSyncExternalStore } from "react";
+//#region src/lib/use-indexed-db-store/index.ts
+var disabledSubscribe = () => () => void 0;
+var useIndexedDBStore = (key, initialValue, options = {}) => {
+	const { parse, enabled = true } = options;
+	const store = useMemo(() => getIndexedDBStore(key, initialValue, parse), [
+		key,
+		initialValue,
+		parse
+	]);
+	return {
+		...useSyncExternalStore(enabled ? store.subscribe : disabledSubscribe, enabled ? store.getSnapshot : store.getInitialSnapshot, store.getInitialSnapshot),
+		setValue: store.setValue,
+		flush: store.flush,
+		refresh: store.refresh
+	};
+};
+//#endregion
+export { useIndexedDBStore };

package/dist/lib/use-indexed-db-store/indexed-db-store.d.ts

@@ -0,0 +1,23 @@
+import { type IndexedDBMutationOptions } from './database';
+export interface IndexedDBStoreOptions<T> {
+    parse?: (value: unknown) => T;
+    enabled?: boolean;
+}
+interface Snapshot<T> {
+    value: T;
+    isReady: boolean;
+    isSaved: boolean;
+    error: unknown;
+}
+declare const createIndexedDBStore: <T>(key: string, initialValue: T, parse?: (value: unknown) => T) => {
+    getSnapshot: () => Snapshot<T>;
+    getInitialSnapshot: () => Snapshot<T>;
+    setValue: (update: T | ((current: T) => T), options?: IndexedDBMutationOptions) => Promise<boolean>;
+    refresh: () => Promise<undefined>;
+    flush: () => Promise<undefined>;
+    subscribe: (listener: () => void) => () => void;
+};
+type IndexedDBStore<T> = ReturnType<typeof createIndexedDBStore<T>>;
+export declare const getIndexedDBStore: <T>(key: string, initialValue: T, parse?: (value: unknown) => T) => IndexedDBStore<T>;
+export {};
+//# sourceMappingURL=indexed-db-store.d.ts.map

package/dist/lib/use-indexed-db-store/indexed-db-store.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"indexed-db-store.d.ts","sourceRoot":"","sources":["../../../src/lib/use-indexed-db-store/indexed-db-store.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,wBAAwB,EAAwB,MAAM,YAAY,CAAA;AAEhF,MAAM,WAAW,qBAAqB,CAAC,CAAC;IACtC,KAAK,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,CAAC,CAAA;IAC7B,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,UAAU,QAAQ,CAAC,CAAC;IAClB,KAAK,EAAE,CAAC,CAAA;IACR,OAAO,EAAE,OAAO,CAAA;IAChB,OAAO,EAAE,OAAO,CAAA;IAChB,KAAK,EAAE,OAAO,CAAA;CACf;AAED,QAAA,MAAM,oBAAoB,GAAI,CAAC,EAC7B,KAAK,MAAM,EACX,cAAc,CAAC,EACf,QAAQ,CAAC,KAAK,EAAE,OAAO,KAAK,CAAC;;;uBA4CnB,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,CAAC,KAAK,CAAC,CAAC,YACrB,wBAAwB,KACjC,OAAO,CAAC,OAAO,CAAC;;;0BA2DK,MAAM,IAAI;CA6BnC,CAAA;AAED,KAAK,cAAc,CAAC,CAAC,IAAI,UAAU,CAAC,OAAO,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAA;AAGnE,eAAO,MAAM,iBAAiB,GAAI,CAAC,EACjC,KAAK,MAAM,EACX,cAAc,CAAC,EACf,QAAQ,CAAC,KAAK,EAAE,OAAO,KAAK,CAAC,KAC5B,cAAc,CAAC,CAAC,CAE6B,CAAA"}

package/dist/lib/use-indexed-db-store/indexed-db-store.js

@@ -0,0 +1,131 @@
+import { updateIndexedDBValue } from "./database.js";
+//#region src/lib/use-indexed-db-store/indexed-db-store.ts
+var createIndexedDBStore = (key, initialValue, parse) => {
+	const initial = {
+		value: initialValue,
+		isReady: false,
+		isSaved: true,
+		error: null
+	};
+	let snapshot = initial;
+	let factory;
+	let channel;
+	let queue = Promise.resolve();
+	let revision = 0;
+	let pending = 0;
+	const listeners = /* @__PURE__ */ new Set();
+	const emit = () => listeners.forEach((listener) => listener());
+	const fail = (error) => {
+		snapshot = {
+			...snapshot,
+			isReady: true,
+			isSaved: false,
+			error
+		};
+		emit();
+	};
+	const acceptRead = (value, version) => {
+		if (revision !== version || pending) return;
+		snapshot = {
+			value,
+			isReady: true,
+			isSaved: true,
+			error: null
+		};
+		emit();
+	};
+	const read = async () => {
+		const version = revision;
+		try {
+			const value = await updateIndexedDBValue(factory, key, initialValue, parse);
+			acceptRead(value, version);
+		} catch (error) {
+			if (revision === version) fail(error);
+		}
+	};
+	const refresh = () => {
+		queue = queue.then(read);
+		return queue.then(() => void 0);
+	};
+	const setValue = (update, options) => {
+		if (!snapshot.isReady || snapshot.error) return Promise.resolve(false);
+		const apply = (current) => typeof update === "function" ? update(current) : update;
+		let optimistic;
+		try {
+			optimistic = apply(snapshot.value);
+		} catch (error) {
+			fail(error);
+			return Promise.resolve(false);
+		}
+		const version = ++revision;
+		pending++;
+		snapshot = {
+			value: options?.optimistic === false ? snapshot.value : optimistic,
+			isReady: true,
+			isSaved: false,
+			error: null
+		};
+		emit();
+		const operation = queue.then(async () => {
+			try {
+				const value = await updateIndexedDBValue(factory, key, initialValue, parse, apply, options);
+				pending--;
+				if (version === revision) {
+					snapshot = {
+						value,
+						isReady: true,
+						isSaved: pending === 0,
+						error: null
+					};
+					emit();
+				}
+				channel?.postMessage(key);
+				return true;
+			} catch (error) {
+				pending--;
+				if (version === revision) fail(error);
+				return false;
+			}
+		});
+		queue = operation.then(() => void 0);
+		return operation;
+	};
+	const store = {
+		getSnapshot: () => snapshot,
+		getInitialSnapshot: () => initial,
+		setValue,
+		refresh,
+		flush: () => queue.then(() => void 0),
+		subscribe: (listener) => {
+			const first = listeners.size === 0;
+			listeners.add(listener);
+			if (first) {
+				stores.set(key, store);
+				factory ??= globalThis.indexedDB;
+				if (!channel && typeof BroadcastChannel !== "undefined") {
+					channel = new BroadcastChannel("vezham:indexeddb");
+					channel.onmessage = (event) => {
+						if (event.data === key && listeners.size) refresh();
+					};
+				}
+				refresh();
+			}
+			return () => {
+				listeners.delete(listener);
+				if (listeners.size) return;
+				if (stores.get(key) === store) stores.delete(key);
+				queue.then(() => {
+					if (!listeners.size) {
+						channel?.close();
+						channel = void 0;
+					}
+				});
+			};
+		}
+	};
+	return store;
+};
+var stores = /* @__PURE__ */ new Map();
+var getIndexedDBStore = (key, initialValue, parse) => stores.get(key) ?? createIndexedDBStore(key, initialValue, parse);
+//#endregion
+export { getIndexedDBStore };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vezham/hooks",
-  "version": "26.2.0",
+  "version": "26.3.0",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vezham/vx-fe-pkgs.git",