@himanshu-sorathiya/react-kit 1.0.24 → 1.0.25

package/dist/index.d.ts

@@ -458,6 +458,44 @@ export interface UseSortReturn<T> {
 	getSortIndex: (id: string) => number | undefined;
 }
 export declare function useSort<T>(data?: T[], initialSorts?: SortState): UseSortReturn<T>;
+export interface StorageSerializer<T> {
+	serialize: (value: T) => string;
+	deserialize: (raw: string) => T;
+}
+export interface BaseStorageOptions<T> {
+	serializer?: StorageSerializer<T>;
+	initializeWithValue?: boolean;
+	sameInstanceSync?: boolean;
+}
+export interface StorageCustomEventDetail {
+	value: string | null;
+	instanceId: symbol;
+}
+export interface UseLocalStorageOptions<T> extends BaseStorageOptions<T> {
+	crossInstanceSync?: boolean;
+}
+export interface UseLocalStorageReturn<T> {
+	value: T | undefined;
+	setValue: (valueOrUpdater: T | ((prev: T | undefined) => T)) => void;
+	removeValue: () => void;
+	isHydrated: boolean;
+	error: Error | null;
+}
+export declare function useLocalStorage<T = unknown>(key: string, initialValue?: T, options?: UseLocalStorageOptions<T>): UseLocalStorageReturn<T>;
+export type UseSessionStorageOptions<T> = BaseStorageOptions<T>;
+export interface UseSessionStorageReturn<T> {
+	value: T | undefined;
+	setValue: (valueOrUpdater: T | ((prev: T | undefined) => T)) => void;
+	removeValue: () => void;
+	isHydrated: boolean;
+	error: Error | null;
+}
+export declare function useSessionStorage<T = unknown>(key: string, initialValue?: T, options?: UseSessionStorageOptions<T>): UseSessionStorageReturn<T>;
+export declare const defaultSerializer: StorageSerializer<unknown>;
+export declare function mapSerializer<K, V>(): StorageSerializer<Map<K, V>>;
+export declare function setSerializer<V>(): StorageSerializer<Set<V>>;
+export declare const dateSerializer: StorageSerializer<Date>;
+export declare const bigIntSerializer: StorageSerializer<bigint>;
 export interface FuzzyHighlighterProps {
 	text: string;
 	query: string;

package/dist/index.js

@@ -2,5 +2,6 @@ import { t as e } from "./useEventListener.js";
 import { n as t, t as n } from "./events2.js";
 import { a as r, c as i, d as a, f as o, i as s, l as c, n as l, o as u, r as d, s as f, t as p, u as m } from "./performance2.js";
 import { a as h, c as g, i as _, n as v, o as y, r as b, s as x, t as S } from "./state2.js";
-import { a as C, c as w, i as T, n as E, o as D, r as O, s as k, t as A } from "./ui2.js";
-export { w as FuzzyHighlighter, T as ModalLayout, t as useClickOutside, o as useDebounce, a as useDebouncedCallback, m as useDebouncedState, c as useDebouncedValue, e as useEventListener, O as useExpansion, g as useFilter, x as useFuzzySearch, y as useGrouping, n as useKey, C as useModal, D as useModalActions, k as useModalState, h as useMultipleSelection, _ as useOrder, b as usePagination, E as usePin, i as useRateLimit, f as useRateLimitedCallback, v as useSingleSelection, S as useSort, u as useThrottle, r as useThrottledCallback, s as useThrottledState, d as useThrottledValue, l as useVirtualGrid, p as useVirtualList, A as useVisibility };
+import { a as C, i as w, n as T, o as E, r as D, s as O, t as k } from "./storage2.js";
+import { a as A, c as j, i as M, n as N, o as P, r as F, s as I, t as L } from "./ui2.js";
+export { j as FuzzyHighlighter, M as ModalLayout, D as bigIntSerializer, w as dateSerializer, C as defaultSerializer, E as mapSerializer, O as setSerializer, t as useClickOutside, o as useDebounce, a as useDebouncedCallback, m as useDebouncedState, c as useDebouncedValue, e as useEventListener, F as useExpansion, g as useFilter, x as useFuzzySearch, y as useGrouping, n as useKey, T as useLocalStorage, A as useModal, P as useModalActions, I as useModalState, h as useMultipleSelection, _ as useOrder, b as usePagination, N as usePin, i as useRateLimit, f as useRateLimitedCallback, k as useSessionStorage, v as useSingleSelection, S as useSort, u as useThrottle, r as useThrottledCallback, s as useThrottledState, d as useThrottledValue, l as useVirtualGrid, p as useVirtualList, L as useVisibility };

package/dist/storage.d.ts

@@ -0,0 +1,42 @@
+// Generated by dts-bundle-generator v9.5.1
+
+export interface StorageSerializer<T> {
+	serialize: (value: T) => string;
+	deserialize: (raw: string) => T;
+}
+export interface BaseStorageOptions<T> {
+	serializer?: StorageSerializer<T>;
+	initializeWithValue?: boolean;
+	sameInstanceSync?: boolean;
+}
+export interface StorageCustomEventDetail {
+	value: string | null;
+	instanceId: symbol;
+}
+export interface UseLocalStorageOptions<T> extends BaseStorageOptions<T> {
+	crossInstanceSync?: boolean;
+}
+export interface UseLocalStorageReturn<T> {
+	value: T | undefined;
+	setValue: (valueOrUpdater: T | ((prev: T | undefined) => T)) => void;
+	removeValue: () => void;
+	isHydrated: boolean;
+	error: Error | null;
+}
+export declare function useLocalStorage<T = unknown>(key: string, initialValue?: T, options?: UseLocalStorageOptions<T>): UseLocalStorageReturn<T>;
+export type UseSessionStorageOptions<T> = BaseStorageOptions<T>;
+export interface UseSessionStorageReturn<T> {
+	value: T | undefined;
+	setValue: (valueOrUpdater: T | ((prev: T | undefined) => T)) => void;
+	removeValue: () => void;
+	isHydrated: boolean;
+	error: Error | null;
+}
+export declare function useSessionStorage<T = unknown>(key: string, initialValue?: T, options?: UseSessionStorageOptions<T>): UseSessionStorageReturn<T>;
+export declare const defaultSerializer: StorageSerializer<unknown>;
+export declare function mapSerializer<K, V>(): StorageSerializer<Map<K, V>>;
+export declare function setSerializer<V>(): StorageSerializer<Set<V>>;
+export declare const dateSerializer: StorageSerializer<Date>;
+export declare const bigIntSerializer: StorageSerializer<bigint>;
+
+export {};

package/dist/storage.js

@@ -0,0 +1,2 @@
+import { a as e, i as t, n, o as r, r as i, s as a, t as o } from "./storage2.js";
+export { i as bigIntSerializer, t as dateSerializer, e as defaultSerializer, r as mapSerializer, a as setSerializer, n as useLocalStorage, o as useSessionStorage };

package/dist/storage2.js

@@ -0,0 +1,261 @@
+import { t as e } from "./useEventListener.js";
+import { useCallback as t, useEffect as n, useRef as r, useState as i } from "react";
+//#region src/shared/storageShared/serializers.ts
+var a = {
+	serialize: (e) => JSON.stringify(e),
+	deserialize: (e) => JSON.parse(e)
+};
+function o() {
+	return {
+		serialize: (e) => JSON.stringify(Array.from(e.entries())),
+		deserialize: (e) => new Map(JSON.parse(e))
+	};
+}
+function s() {
+	return {
+		serialize: (e) => JSON.stringify(Array.from(e.values())),
+		deserialize: (e) => new Set(JSON.parse(e))
+	};
+}
+var c = {
+	serialize: (e) => e.toISOString(),
+	deserialize: (e) => {
+		let t = new Date(e);
+		if (isNaN(t.getTime())) throw Error(`[react-kit] dateSerializer: invalid date string "${e}"`);
+		return t;
+	}
+}, l = {
+	serialize: (e) => e.toString(),
+	deserialize: (e) => {
+		try {
+			return BigInt(e);
+		} catch {
+			throw Error(`[react-kit] bigIntSerializer: cannot convert "${e}" to bigint`);
+		}
+	}
+}, u = "react-kit:use-local-storage";
+//#endregion
+//#region src/storage/useLocalStorage/utils.ts
+function d() {
+	if (typeof window > "u") return null;
+	try {
+		return window.localStorage;
+	} catch {
+		return null;
+	}
+}
+function f(e, t, n, r) {
+	try {
+		let i = e.getItem(t);
+		return i === null ? {
+			value: n,
+			error: null
+		} : {
+			value: r.deserialize(i),
+			error: null
+		};
+	} catch (e) {
+		return {
+			value: n,
+			error: e instanceof Error ? e : Error(String(e))
+		};
+	}
+}
+function p(e, t, n) {
+	let r = {
+		value: t,
+		instanceId: n
+	}, i = new CustomEvent(`${u}:${e}`, { detail: r });
+	window.dispatchEvent(i);
+}
+//#endregion
+//#region src/storage/useLocalStorage/useLocalStorage.ts
+function m(o, s, c = {}) {
+	let { serializer: l = a, initializeWithValue: m = !0, sameInstanceSync: h = !0, crossInstanceSync: g = !0 } = c, [_] = i(() => o), v = r(_), y = o !== _, b = `${u}:${_}`, x = r(Symbol()), S = r(l);
+	n(() => {
+		S.current = l;
+	}, [l]);
+	let [C, w] = i(() => {
+		if (!m) return;
+		let e = d();
+		if (!e) return s;
+		let { value: t } = f(e, o, s, l);
+		return t;
+	}), T = r(C);
+	n(() => {
+		T.current = C;
+	}, [C]);
+	let [E, D] = i(m && typeof window < "u"), [O, k] = i(null);
+	n(() => {
+		if (!y) return;
+		let e = /* @__PURE__ */ Error(`[react-kit:use-local-storage] Changing the storage key at runtime is not supported. Still using original key: "${v.current}". Received new key: "${o}".`);
+		console.warn(e.message), k(e);
+	}, [o, y]), n(() => {
+		if (m) return;
+		let e = d(), { value: t, error: n } = e === null ? {
+			value: s,
+			error: null
+		} : f(e, v.current, s, S.current);
+		n && (console.warn(`[react-kit:use-local-storage] Failed to read key "${v.current}" from localStorage:`, n.message), k(n)), w(t), D(!0);
+	}, [m]);
+	let A = t((e) => {
+		let t = d();
+		if (!t) return;
+		let n = T.current, r = typeof e == "function" ? e(n) : e;
+		try {
+			let e = S.current.serialize(r);
+			t.setItem(v.current, e), w(r), k(null), h && p(v.current, e, x.current);
+		} catch (e) {
+			let t = e instanceof Error ? e : Error(String(e));
+			console.warn(`[react-kit:use-local-storage] Failed to write key "${v.current}" to localStorage:`, t.message), k(t);
+		}
+	}, [h]), j = t(() => {
+		let e = d();
+		e && (e.removeItem(v.current), w(s), k(null), h && p(v.current, null, x.current));
+	}, [h]);
+	return e("storage", (e) => {
+		if (g && e.storageArea === d() && e.key === v.current) {
+			if (e.newValue === null) {
+				w(s), k(null);
+				return;
+			}
+			try {
+				let t = S.current.deserialize(e.newValue);
+				w(t), k(null);
+			} catch (e) {
+				let t = e instanceof Error ? e : Error(String(e));
+				console.warn(`[react-kit:use-local-storage] Failed to deserialize cross-tab update for key "${v.current}":`, t.message), w(s), k(t);
+			}
+		}
+	}), e(b, (e) => {
+		if (!h) return;
+		let t = e.detail;
+		if (t.instanceId !== x.current) {
+			if (t.value === null) {
+				w(s), k(null);
+				return;
+			}
+			try {
+				let e = S.current.deserialize(t.value);
+				w(e), k(null);
+			} catch (e) {
+				let t = e instanceof Error ? e : Error(String(e));
+				console.warn(`[react-kit:use-local-storage] Failed to deserialize same-tab update for key "${v.current}":`, t.message), w(s), k(t);
+			}
+		}
+	}, { target: typeof window > "u" ? null : window }), {
+		value: C,
+		setValue: A,
+		removeValue: j,
+		isHydrated: E,
+		error: O
+	};
+}
+//#endregion
+//#region src/storage/useSessionStorage/constants.ts
+var h = "react-kit:use-session-storage";
+//#endregion
+//#region src/storage/useSessionStorage/utils.ts
+function g() {
+	if (typeof window > "u") return null;
+	try {
+		return window.sessionStorage;
+	} catch {
+		return null;
+	}
+}
+function _(e, t, n, r) {
+	try {
+		let i = e.getItem(t);
+		return i === null ? {
+			value: n,
+			error: null
+		} : {
+			value: r.deserialize(i),
+			error: null
+		};
+	} catch (e) {
+		return {
+			value: n,
+			error: e instanceof Error ? e : Error(String(e))
+		};
+	}
+}
+function v(e, t, n) {
+	let r = {
+		value: t,
+		instanceId: n
+	}, i = new CustomEvent(`${h}:${e}`, { detail: r });
+	window.dispatchEvent(i);
+}
+//#endregion
+//#region src/storage/useSessionStorage/useSessionStorage.ts
+function y(o, s, c = {}) {
+	let { serializer: l = a, initializeWithValue: u = !0, sameInstanceSync: d = !0 } = c, [f] = i(() => o), p = r(f), m = o !== f, y = `${h}:${f}`, b = r(Symbol()), x = r(l);
+	n(() => {
+		x.current = l;
+	}, [l]);
+	let [S, C] = i(() => {
+		if (!u) return;
+		let e = g();
+		if (!e) return s;
+		let { value: t } = _(e, o, s, l);
+		return t;
+	}), w = r(S);
+	n(() => {
+		w.current = S;
+	}, [S]);
+	let [T, E] = i(u && typeof window < "u"), [D, O] = i(null);
+	n(() => {
+		if (!m) return;
+		let e = /* @__PURE__ */ Error(`[react-kit:use-session-storage] Changing the storage key at runtime is not supported. Still using original key: "${p.current}". Received new key: "${o}".`);
+		console.warn(e.message), O(e);
+	}, [o, m]), n(() => {
+		if (u) return;
+		let e = g(), { value: t, error: n } = e === null ? {
+			value: s,
+			error: null
+		} : _(e, p.current, s, x.current);
+		n && (console.warn(`[react-kit:use-session-storage] Failed to read key "${p.current}" from sessionStorage:`, n.message), O(n)), C(t), E(!0);
+	}, [u]);
+	let k = t((e) => {
+		let t = g();
+		if (!t) return;
+		let n = w.current, r = typeof e == "function" ? e(n) : e;
+		try {
+			let e = x.current.serialize(r);
+			t.setItem(p.current, e), C(r), O(null), d && v(p.current, e, b.current);
+		} catch (e) {
+			let t = e instanceof Error ? e : Error(String(e));
+			console.warn(`[react-kit:use-session-storage] Failed to write key "${p.current}" to sessionStorage:`, t.message), O(t);
+		}
+	}, [d]), A = t(() => {
+		let e = g();
+		e && (e.removeItem(p.current), C(s), O(null), d && v(p.current, null, b.current));
+	}, [d]);
+	return e(y, (e) => {
+		if (!d) return;
+		let t = e.detail;
+		if (t.instanceId !== b.current) {
+			if (t.value === null) {
+				C(s), O(null);
+				return;
+			}
+			try {
+				let e = x.current.deserialize(t.value);
+				C(e), O(null);
+			} catch (e) {
+				let t = e instanceof Error ? e : Error(String(e));
+				console.warn(`[react-kit:use-session-storage] Failed to deserialize same-tab update for key "${p.current}":`, t.message), C(s), O(t);
+			}
+		}
+	}, { target: typeof window > "u" ? null : window }), {
+		value: S,
+		setValue: k,
+		removeValue: A,
+		isHydrated: T,
+		error: D
+	};
+}
+//#endregion
+export { a, c as i, m as n, o, l as r, s, y as t };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@himanshu-sorathiya/react-kit",
-	"version": "1.0.24",
+	"version": "1.0.25",
 	"description": "An opinionated collection of react hooks, and reusable UI components.",
 	"type": "module",
 	"module": "./dist/index.js",
@@ -29,11 +29,15 @@
 			"types": "./dist/events.d.ts",
 			"import": "./dist/events.js"
 		},
+		"./storage": {
+			"types": "./dist/storage.d.ts",
+			"import": "./dist/storage.js"
+		},
 		"./styles.css": "./dist/index.css"
 	},
 	"scripts": {
 		"dev": "vite",
-		"build": "vite build && dts-bundle-generator --project tsconfig.app.json -o dist/index.d.ts src/index.ts && dts-bundle-generator --project tsconfig.app.json -o dist/ui.d.ts src/ui/index.ts && dts-bundle-generator --project tsconfig.app.json -o dist/state.d.ts src/state/index.ts && dts-bundle-generator --project tsconfig.app.json -o dist/performance.d.ts src/performance/index.ts && dts-bundle-generator --project tsconfig.app.json -o dist/events.d.ts src/events/index.ts",
+		"build": "vite build && dts-bundle-generator --project tsconfig.app.json -o dist/index.d.ts src/index.ts && dts-bundle-generator --project tsconfig.app.json -o dist/ui.d.ts src/ui/index.ts && dts-bundle-generator --project tsconfig.app.json -o dist/state.d.ts src/state/index.ts && dts-bundle-generator --project tsconfig.app.json -o dist/performance.d.ts src/performance/index.ts && dts-bundle-generator --project tsconfig.app.json -o dist/events.d.ts src/events/index.ts && dts-bundle-generator --project tsconfig.app.json -o dist/storage.d.ts src/storage/index.ts",
 		"lint": "eslint .",
 		"preview": "vite preview",
 		"format": "prettier . --write"