npm - @choksheak/react-utils - Versions diffs - 0.3.5 → 0.3.7 - Mend

@choksheak/react-utils 0.3.5 → 0.3.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (54) hide show

package/sharedState.d.ts CHANGED Viewed

@@ -2,13 +2,25 @@
  * @packageDocumentation
  *
  * The "shared state" is a React state that shares the same value across the
- * entire app. It is largely similar to the jotai library, but is much smaller
- * and much easier to work with when used for persisting in local storage or
- * indexed db, with an automatic expiration for persisted values.
+ * entire app. Users declare a shared state constant that can be reused across
+ * multiple components with the same underlying value.
  *
- * This library aims to be the shortest, simplest, easiest to use, and most
- * efficient implementation of shared global React states with seamless support
- * for client persistence.
+ * Shared states provide persistence to local storage and/or indexed DB out of
+ * the box, by using "@choksheak/ts-utils". Note that no matter if the shared
+ * state uses persistence or not, it will always maintain a copy of the state
+ * in memory. Persisted values can be configured with an automatic expiration
+ * duration.
+ *
+ * This module is largely similar to the open source "jotai" npm library. You
+ * can use shared states to replace "jotai" in your code, and optionally make
+ * use of the persistence mechanism. A quick migration guide from jotai is:
+ *
+ * ```
+ *   atom()          -->  sharedState()
+ *   useAtom()       -->  useSharedState()
+ *   useAtomValue()  -->  useSharedStateValue()
+ *   useSetAtom()    -->  useSharedStateSetter()
+ * ```
  *
  * Example:
  * ```
@@ -18,7 +30,9 @@
  *   // The first argument is the default value, which is required.
  *   // The second argument is an options object, and is optional (defaults
  *   // to storing in memory only without any persistence).
- *   const usersState = sharedState([], { indexedDbKey: "users" });
+ *   const usersState = sharedState(
+ *     [], { store: { persistTo: "indexedDb", key: "users" }}
+ *   );
  *
  *   export const UsersComponent: React.FC = () => {
  *     // Get both the value and the setter.
@@ -65,19 +79,24 @@ export declare function configureSharedState(config: Partial<SharedStateConfig>)
 export type SharedStateOptions<T> = {
     lazyLoad?: boolean;
 } & StorageOptions<T>;
-/** Please use sharedState() instead. */
-export declare class SharedState<T> {
-    private readonly defaultValue;
-    private readonly pubSubKey;
-    private readonly storageAdapter;
-    readonly setValueBounded: Dispatch<SetStateAction<T>>;
-    initStarted: boolean;
-    initDone: boolean;
-    constructor(defaultValue: T, options?: SharedStateOptions<T>);
+/**
+ * Create a new shared state object. Put this code at the top level scope:
+ *
+ * Example:
+ * ```
+ *   const counterState = sharedState<number>(0);
+ * ```
+ */
+export declare function sharedState<T>(defaultValue: T, options?: SharedStateOptions<T>): {
+    /** Allow users to await for the completion of data init. */
+    readonly readyPromise: Promise<void>;
+    readonly lazy: boolean;
+    readonly initStarted: false;
+    readonly initDone: false;
     /** `subscribe` function required by useSyncExternalStore. */
-    subscribe(subscriber: () => void): () => void;
+    readonly subscribe: (subscriber: () => void) => () => void;
     /** Returns true if there is a backing store. */
-    hasStore(): boolean;
+    readonly hasStore: () => boolean;
     /**
      * Set a value directly into the store. Does nothing if there is no
      * backing store.
@@ -85,38 +104,30 @@ export declare class SharedState<T> {
      * Warning: If you want to set the value properly, you should use
      * `setValue()` instead which also updates the in-memory copy.
      */
-    setInStore(value: T): Promise<void>;
+    readonly setInStore: (value: T) => Promise<void>;
     /**
      * Get a value directly from the store. Returns undefined if there is no
      * backing store.
      */
-    getFromStore(): Promise<T | undefined>;
+    readonly getFromStore: () => Promise<T | undefined>;
     /**
      * Get the value of the shared state.
      *  `getSnapshot` function — must return same ref if value unchanged.
      * Note that this would return the default value if data init from store is
      * not completed yet.
      */
-    getSnapshot(): T;
+    readonly getSnapshot: () => T;
     /** Set the value of the shared state. */
-    setValue(next: SetStateAction<T>): void;
+    readonly setValue: (next: SetStateAction<T>) => void;
     /**
      * Remove the value of the shared state. Actually this just sets the value
      * back to the given default value.
      */
-    delete(): void;
+    readonly delete: () => void;
     /** Initial default handling. */
-    initDefaultValueOnce(): Promise<void>;
-}
-/**
- * Create a new shared state object. Put this code at the top level scope:
- *
- * Example:
- * ```
- *   const counterState = sharedState<number>(0);
- * ```
- */
-export declare function sharedState<T>(defaultValue: T, options?: SharedStateOptions<T>): SharedState<T>;
+    readonly initDefaultValueOnce: () => Promise<void>;
+};
+export type SharedState<T> = ReturnType<typeof sharedState<T>>;
 /**
  * React hook for subscribing to a key in the global store.
  *
@@ -143,4 +154,4 @@ export declare function useSharedStateValue<T>(state: SharedState<T>): T;
  *   const setCounter = useSharedStateSetter(counterState);
  * ```
  */
-export declare function useSharedStateSetter<T>(state: SharedState<T>): Dispatch<SetStateAction<T>>;
+export declare function useSharedStateSetter<T>(state: SharedState<T>): (next: SetStateAction<T>) => void;

package/sharedState.min.cjs CHANGED Viewed

@@ -1,2 +1,2 @@
-"use strict";var b=Object.defineProperty;var A=Object.getOwnPropertyDescriptor;var K=Object.getOwnPropertyNames;var x=Object.prototype.hasOwnProperty;var O=(r,e)=>{for(var t in e)b(r,t,{get:e[t],enumerable:!0})},V=(r,e,t,i)=>{if(e&&typeof e=="object"||typeof e=="function")for(let n of K(e))!x.call(r,n)&&n!==t&&b(r,n,{get:()=>e[n],enumerable:!(i=A(e,n))||i.enumerable});return r};var B=r=>V(b({},"__esModule",{value:!0}),r);var k={};O(k,{SharedState:()=>S,SharedStateConfig:()=>l,configureSharedState:()=>D,sharedState:()=>P,useSharedState:()=>T,useSharedStateSetter:()=>z,useSharedStateValue:()=>M});module.exports=B(k);var w=require("@choksheak/ts-utils/timeConstants"),m=require("react");var p=require("@choksheak/ts-utils/kvStore"),h=require("@choksheak/ts-utils/localStore"),u=typeof window>"u";function v(r,e){let{store:t}=r??{};if(!t)return null;if("persistTo"in t&&typeof t.persistTo=="string"&&"key"in t&&typeof t.key=="string"){let i=t.expiryMs||e,n=t.isValid;switch(t.persistTo){case"localStorage":{let a=new h.LocalStore(t.key,{defaultExpiryMs:i});return{set:(o,s)=>{u||a.set(o,s)},get:o=>{if(u)return;let s=a.get(o);if(n&&!n(s)){console.warn(`localStorage adapter: Auto-discard invalid value for ${o}: ${JSON.stringify(s)}`),a.delete(o);return}return s},delete:o=>{u||a.delete(o)},clear:()=>{u||a.clear()}}}case"indexedDb":{let a=t.key+":",o=t.isValid;return{set:async(s,c)=>{u||await p.kvStore.set(a+s,c,i)},get:async s=>{if(u)return;let c=a+s,f=await p.kvStore.get(c);if(o&&!o(f)){console.warn(`indexedDb adapter: Auto-discard invalid value for ${s}: ${JSON.stringify(f)}`),await p.kvStore.delete(c);return}return f},delete:async s=>{u||await p.kvStore.delete(a+s)},clear:async()=>{u||await p.kvStore.clear()}}}default:throw t.persistTo,new Error(`Unknown store.adapter ${t.persistTo}`)}}return t}var l={storeExpiryMs:30*w.MS_PER_DAY,lazyLoad:!1};function D(r){Object.assign(l,r)}var g=class{dataByKey=new Map;subscribersByKey=new Map;get(e){return this.dataByKey.get(e)}set(e,t){let i=this.dataByKey.get(e);i!==t&&(this.dataByKey.set(e,t),this.notify(e,t,i))}delete(e){this.dataByKey.delete(e)}setNoNotify(e,t){this.dataByKey.set(e,t)}subscribe(e,t){let i=this.subscribersByKey.get(e);return i||(i=new Set,this.subscribersByKey.set(e,i)),i.add(t),()=>{i.delete(t),i.size===0&&this.subscribersByKey.delete(e)}}notify(e,t,i){let n=this.subscribersByKey.get(e);if(!n)return;let a=Array.from(n.values());for(let o of a)try{o(t,i)}catch(s){console.error("Error invoking subscriber:",s)}}},d=new g,y="state",E=0,S=class{constructor(e,t){this.defaultValue=e;this.pubSubKey=String(E++),this.storageAdapter=v(t,l.storeExpiryMs),this.setValueBounded=a=>{this.setValue(a)},d.setNoNotify(this.pubSubKey,e);let i=t?.lazyLoad;(i!==void 0?i:l.lazyLoad)||this.initDefaultValueOnce()}pubSubKey;storageAdapter;setValueBounded;initStarted=!1;initDone=!1;subscribe(e){return d.subscribe(this.pubSubKey,()=>e())}hasStore(){return!!this.storageAdapter}async setInStore(e){return await this.storageAdapter?.set(y,e)}async getFromStore(){return await this.storageAdapter?.get(y)}getSnapshot(){return d.get(this.pubSubKey)}setValue(e){if(typeof e=="function"){let t=d.get(this.pubSubKey);e=e(t)}d.set(this.pubSubKey,e),this.setInStore(e)}delete(){d.set(this.pubSubKey,this.defaultValue),this.storageAdapter?.set(y,this.defaultValue)}async initDefaultValueOnce(){if(this.initDone||this.initStarted)return;this.initStarted=!0;let e=await this.getFromStore(),t=e!==void 0?e:this.defaultValue;d.set(this.pubSubKey,t),this.initDone=!0}};function P(r,e){return new S(r,e)}function T(r){return r.initDefaultValueOnce(),[(0,m.useSyncExternalStore)(t=>r.subscribe(t),()=>r.getSnapshot(),()=>r.getSnapshot()),r.setValueBounded]}function M(r){return T(r)[0]}function z(r){return T(r)[1]}0&&(module.exports={SharedState,SharedStateConfig,configureSharedState,sharedState,useSharedState,useSharedStateSetter,useSharedStateValue});
+"use strict";var g=Object.defineProperty;var x=Object.getOwnPropertyDescriptor;var A=Object.getOwnPropertyNames;var O=Object.prototype.hasOwnProperty;var D=(e,i)=>{for(var n in i)g(e,n,{get:i[n],enumerable:!0})},P=(e,i,n,r)=>{if(i&&typeof i=="object"||typeof i=="function")for(let t of A(i))!O.call(e,t)&&t!==n&&g(e,t,{get:()=>i[t],enumerable:!(r=x(i,t))||r.enumerable});return e};var E=e=>P(g({},"__esModule",{value:!0}),e);var _={};D(_,{SharedStateConfig:()=>l,configureSharedState:()=>C,sharedState:()=>k,useSharedState:()=>w,useSharedStateSetter:()=>L,useSharedStateValue:()=>K});module.exports=E(_);var m=require("@choksheak/ts-utils/timeConstants"),h=require("react");var S=require("@choksheak/ts-utils/kvStore"),b=require("@choksheak/ts-utils/localStore"),d=typeof window>"u";function v(e,i){let{store:n}=e??{};if(!n)return null;if("persistTo"in n&&typeof n.persistTo=="string"&&"key"in n&&typeof n.key=="string"){let r=n.expiryMs||i,t={...n,expiryMs:r};switch(n.persistTo){case"localStorage":return M(t);case"indexedDb":return z(t);default:throw n.persistTo,new Error(`Unknown store.adapter ${n.persistTo}`)}}return n}function M({key:e,expiryMs:i,isValid:n}){let r=(0,b.createLocalStore)(e,{defaultExpiryMs:i});return{set:(t,o)=>{d||r.set(t,o)},get:t=>{if(d)return;let o=r.get(t);if(n&&!n(o)){console.warn(`localStorage adapter: Auto-discard invalid value for ${t}: ${JSON.stringify(o)}`),r.delete(t);return}return o},delete:t=>{d||r.delete(t)},clear:()=>{d||r.clear()}}}function z({key:e,expiryMs:i,isValid:n}){let r=e+":";return{set:async(t,o)=>{d||await S.kvStore.set(r+t,o,i)},get:async t=>{if(d)return;let o=r+t,a=await S.kvStore.get(o);if(n&&!n(a)){console.warn(`indexedDb adapter: Auto-discard invalid value for ${t}: ${JSON.stringify(a)}`),await S.kvStore.delete(o);return}return a},delete:async t=>{d||await S.kvStore.delete(r+t)},clear:async()=>{d||await S.kvStore.clear()}}}var l={storeExpiryMs:30*m.MS_PER_DAY,lazyLoad:!1};function C(e){Object.assign(l,e)}function N(){let e=new Map,i=new Map;function n(r,t,o){let a=i.get(r);if(!a)return;let p=Array.from(a.values());for(let f of p)try{f(t,o)}catch(u){console.error("Error invoking subscriber:",u)}}return{get(r){return e.get(r)},set(r,t){let o=e.get(r);o!==t&&(e.set(r,t),n(r,t,o))},delete(r){e.delete(r)},setNoNotify(r,t){e.set(r,t)},subscribe(r,t){let o=i.get(r);return o||(o=new Set,i.set(r,o)),o.add(t),()=>{o.delete(t),o.size===0&&i.delete(r)}}}}var c=N(),y="state",R=0;function k(e,i){let n=()=>{},r=new Promise(s=>{n=s}),t=n,o=String(R++),a=v(i,l.storeExpiryMs);c.setNoNotify(o,e);let p=i?.lazyLoad,f=p!==void 0?p:l.lazyLoad,u={readyPromise:r,lazy:f,initStarted:!1,initDone:!1,subscribe(s){return c.subscribe(o,()=>s())},hasStore(){return!!a},async setInStore(s){return await a?.set(y,s)},async getFromStore(){return await a?.get(y)},getSnapshot(){return c.get(o)},setValue(s){if(typeof s=="function"){let T=c.get(o);s=s(T)}c.set(o,s),u.setInStore(s)},delete(){c.set(o,e),a?.set(y,e)},async initDefaultValueOnce(){if(u.initDone||u.initStarted)return;u.initStarted=!0;let s=await u.getFromStore(),T=s!==void 0?s:e;c.set(o,T),u.initDone=!0,t()}};return f||u.initDefaultValueOnce(),u}function w(e){return e.initDefaultValueOnce(),[(0,h.useSyncExternalStore)(n=>e.subscribe(n),()=>e.getSnapshot(),()=>e.getSnapshot()),e.setValue]}function K(e){return w(e)[0]}function L(e){return e.initDefaultValueOnce(),e.setValue}0&&(module.exports={SharedStateConfig,configureSharedState,sharedState,useSharedState,useSharedStateSetter,useSharedStateValue});
 //# sourceMappingURL=sharedState.min.cjs.map

package/sharedState.min.cjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"sources":["../src/sharedState.ts","../src/storage.ts"],"sourcesContent":["/*\n @packageDocumentation\n \n The \"shared state\" is a React state that shares the same value across the\n * entire app. It is largely similar to the jotai library, but is much smaller\n * and much easier to work with when used for persisting in local storage or\n * indexed db, with an automatic expiration for persisted values.\n \n This library aims to be the shortest, simplest, easiest to use, and most\n * efficient implementation of shared global React states with seamless support\n * for client persistence.\n \n Example:\n * ```\n * import { sharedState, useSharedState } from \"@choksheak/react-utils/sharedState\";\n \n // Create a new shared state in the top level scope.\n * // The first argument is the default value, which is required.\n * // The second argument is an options object, and is optional (defaults\n * // to storing in memory only without any persistence).\n * const usersState = sharedState([], { indexedDbKey: \"users\" });\n \n export const UsersComponent: React.FC = () => {\n * // Get both the value and the setter.\n * const [users, setUsers] = useSharedState(usersState);\n * ...\n * };\n \n export const ReadOnlyComponent: React.FC = () => {\n * // Get the value only.\n * const users = useSharedStateValue(usersState);\n * ...\n * };\n \n export const WriteOnlyComponent: React.FC = () => {\n * // Get the setter only.\n * const setUsers = useSharedStateSetter(usersState);\n * ...\n * };\n * ```\n /\n\nimport { StorageAdapter } from \"@choksheak/ts-utils/storageAdapter\";\nimport { MS_PER_DAY } from \"@choksheak/ts-utils/timeConstants\";\nimport { Dispatch, SetStateAction, useSyncExternalStore } from \"react\";\n\nimport { getStorageAdapter, StorageOptions } from \"./storage\";\n\n/**********************************************************************/\n/ Global config /\n/*********************************************************************/\n\n/\n * These values are configurable by the user at any time.\n /\nexport const SharedStateConfig = {\n /\n Default duration for storage expiration in milliseconds. Initial value\n * is 30 days, but can be changed to anything.\n /\n storeExpiryMs: 30 MS_PER_DAY,\n\n /*\n True to load from storage only on mount, false (default) to load in\n * the top level scope when the shared state is defined.\n /\n lazyLoad: false,\n};\n\nexport type SharedStateConfig = typeof SharedStateConfig;\n\n/* Convenience function to update global defaults. /\nexport function configureSharedState(config: Partial<SharedStateConfig>) {\n Object.assign(SharedStateConfig, config);\n}\n\n/**********************************************************************/\n/ Shared state implementation /\n/*********************************************************************/\n\ntype Subscriber<T> = (next: T, prev: T) => void;\n\nclass PubSubStore {\n private dataByKey = new Map<string, unknown>();\n private subscribersByKey = new Map<string, Set<Subscriber<unknown>>>();\n\n // This could be undefined if T includes undefined, else it should never\n // return undefined because the user has to always specify the default value.\n public get<T>(key: string): T {\n return this.dataByKey.get(key) as T;\n }\n\n public set<T>(key: string, value: T): void {\n const prev = this.dataByKey.get(key) as T;\n\n // Do nothing if no change.\n if (prev === value) return;\n\n this.dataByKey.set(key, value);\n this.notify(key, value, prev);\n }\n\n public delete(key: string): void {\n this.dataByKey.delete(key);\n }\n\n public setNoNotify<T>(key: string, value: T): void {\n this.dataByKey.set(key, value);\n }\n\n // Subscribe to changes of a specific key\n public subscribe<T>(key: string, subscriber: Subscriber<T>): () => void {\n let subscribers = this.subscribersByKey.get(key);\n if (!subscribers) {\n subscribers = new Set();\n this.subscribersByKey.set(key, subscribers);\n }\n\n // Type coercion: we store Subscriber<unknown>\n subscribers.add(subscriber as Subscriber<unknown>);\n\n // Return unsubscribe function\n return () => {\n subscribers.delete(subscriber as Subscriber<unknown>);\n if (subscribers.size === 0) this.subscribersByKey.delete(key);\n };\n }\n\n private notify<T>(key: string, next: T, prev: T): void {\n const subscribers = this.subscribersByKey.get(key);\n if (!subscribers) return;\n\n // Make copy to protect against mutation during iteration.\n const copy = Array.from(subscribers.values());\n for (const subscriber of copy) {\n try {\n subscriber(next, prev);\n } catch (e) {\n console.error(`Error invoking subscriber:`, e);\n }\n }\n }\n}\n\nconst pubSubStore = new PubSubStore();\n\nconst STORAGE_KEY = \"state\";\n\n/ Options to configure a shared state. /\nexport type SharedStateOptions<T> = {\n lazyLoad?: boolean;\n} & StorageOptions<T>;\n\nlet stateKey = 0;\n\n/* Please use sharedState() instead. /\nexport class SharedState<T> {\n private readonly pubSubKey: string;\n private readonly storageAdapter: StorageAdapter<T> \| null;\n public readonly setValueBounded: Dispatch<SetStateAction<T>>;\n public initStarted = false;\n public initDone = false;\n\n public constructor(\n private readonly defaultValue: T,\n options?: SharedStateOptions<T>,\n ) {\n this.pubSubKey = String(stateKey++);\n\n // Use max of 1 storage adapter per shared state.\n this.storageAdapter = getStorageAdapter(\n options,\n SharedStateConfig.storeExpiryMs,\n );\n\n // Same as this.setValue, but binding the `this` reference.\n this.setValueBounded = (next: SetStateAction<T>) => {\n this.setValue(next);\n };\n\n // Always set the default value first to avoid returning undefineds if that\n // is not part of T.\n pubSubStore.setNoNotify(this.pubSubKey, defaultValue);\n\n const lazyLoad = options?.lazyLoad;\n const lazy = lazyLoad !== undefined ? lazyLoad : SharedStateConfig.lazyLoad;\n\n if (!lazy) {\n void this.initDefaultValueOnce();\n }\n }\n\n /* `subscribe` function required by useSyncExternalStore. /\n public subscribe(subscriber: () => void): () => void {\n return pubSubStore.subscribe(this.pubSubKey, () => subscriber());\n }\n\n /* Returns true if there is a backing store. /\n public hasStore(): boolean {\n return Boolean(this.storageAdapter);\n }\n\n /\n Set a value directly into the store. Does nothing if there is no\n * backing store.\n \n Warning: If you want to set the value properly, you should use\n * `setValue()` instead which also updates the in-memory copy.\n /\n public async setInStore(value: T): Promise<void> {\n return await this.storageAdapter?.set(STORAGE_KEY, value);\n }\n\n /\n Get a value directly from the store. Returns undefined if there is no\n * backing store.\n /\n public async getFromStore(): Promise<T \| undefined> {\n return await this.storageAdapter?.get(STORAGE_KEY);\n }\n\n /\n Get the value of the shared state.\n * `getSnapshot` function — must return same ref if value unchanged.\n * Note that this would return the default value if data init from store is\n * not completed yet.\n /\n public getSnapshot(): T {\n return pubSubStore.get(this.pubSubKey);\n }\n\n /* Set the value of the shared state. /\n public setValue(next: SetStateAction<T>): void {\n if (typeof next === \"function\") {\n const prev = pubSubStore.get<T>(this.pubSubKey);\n next = (next as (p: T) => T)(prev);\n }\n\n pubSubStore.set(this.pubSubKey, next);\n void this.setInStore(next);\n }\n\n /\n Remove the value of the shared state. Actually this just sets the value\n * back to the given default value.\n /\n public delete() {\n pubSubStore.set(this.pubSubKey, this.defaultValue);\n void this.storageAdapter?.set(STORAGE_KEY, this.defaultValue);\n }\n\n /* Initial default handling. /\n public async initDefaultValueOnce() {\n if (this.initDone \|\| this.initStarted) return;\n this.initStarted = true;\n\n const stored = await this.getFromStore();\n const value = stored !== undefined ? stored : this.defaultValue;\n\n pubSubStore.set(this.pubSubKey, value);\n\n this.initDone = true;\n }\n}\n\n/\n Create a new shared state object. Put this code at the top level scope:\n \n Example:\n * ```\n * const counterState = sharedState<number>(0);\n * ```\n /\nexport function sharedState<T>(\n defaultValue: T,\n options?: SharedStateOptions<T>,\n): SharedState<T> {\n return new SharedState(defaultValue, options);\n}\n\n/\n React hook for subscribing to a key in the global store.\n \n Example:\n * ```\n * const [counter, setCounter] = useSharedState(counterState);\n * ```\n /\nexport function useSharedState<T>(\n state: SharedState<T>,\n): [T, Dispatch<SetStateAction<T>>] {\n state.initDefaultValueOnce();\n\n const value = useSyncExternalStore(\n (onStoreChange) => state.subscribe(onStoreChange),\n () => state.getSnapshot(),\n // getServerSnapshot is needed to prevent SSR dev errors in nextjs.\n () => state.getSnapshot(),\n );\n\n return [value, state.setValueBounded];\n}\n\n/\n Same as useSharedState(), but returns the value only.\n \n Example:\n * ```\n * const counter = useSharedStateValue(counterState);\n * ```\n /\nexport function useSharedStateValue<T>(state: SharedState<T>) {\n return useSharedState(state)[0];\n}\n\n/\n Same as useSharedState(), but returns the setter only.\n \n Example:\n * ```\n * const setCounter = useSharedStateSetter(counterState);\n * ```\n /\nexport function useSharedStateSetter<T>(state: SharedState<T>) {\n return useSharedState(state)[1];\n}\n","import { kvStore } from \"@choksheak/ts-utils/kvStore\";\nimport { LocalStore } from \"@choksheak/ts-utils/localStore\";\nimport { StorageAdapter } from \"@choksheak/ts-utils/storageAdapter\";\n\n/* List of all available pre-built persistence options. /\nexport type PersistTo = \"localStorage\" \| \"indexedDb\";\n\n/* Options to configure a pre-built store adapter. /\nexport type StoreOptions = {\n /* Choose which pre-built store adapter to use. /\n persistTo: PersistTo;\n\n /* Storage key to act as a namespace to store the data. /\n key: string;\n\n /* How long to wait before the value is considered expired. /\n expiryMs?: number;\n\n /* Returns true if the given value supposed to be of type T is valid. /\n isValid?: (u: unknown) => boolean;\n};\n\n/* Either use a pre-built store, or a custom one you provide. /\nexport type StorageOptions<T> = {\n /\n You can either specify the storage adapter directly to use a custom\n * store, or specify the properties to use the pre-built ones.\n */\n store?: StorageAdapter<T> \| StoreOptions;\n};\n\n// In SSR (Server-Side Rendering) mode, we never want to use our storage\n// adapters for anything.\nconst IS_NOT_BROWSER = typeof window === \"undefined\";\n\nexport function getStorageAdapter<T>(\n options: StorageOptions<T> \| undefined,\n defaultStoreExpiryMs: number,\n): StorageAdapter<T> \| null {\n const { store } = options ?? {};\n\n if (!store) {\n return null;\n }\n\n if (\n \"persistTo\" in store &&\n typeof store.persistTo === \"string\" &&\n \"key\" in store &&\n typeof store.key === \"string\"\n ) {\n const expiryMs = store.expiryMs \|\| defaultStoreExpiryMs;\n const isValid = store.isValid;\n\n switch (store.persistTo) {\n case \"localStorage\": {\n const adapter = new LocalStore(store.key, {\n defaultExpiryMs: expiryMs,\n });\n\n // Handle SSR.\n return {\n set: (key: string, value: T): void => {\n if (IS_NOT_BROWSER) return; // handle SSR\n\n // Also apply the custom expiryMs on every item in this store.\n adapter.set(key, value);\n },\n get: (key: string): T \| undefined => {\n if (IS_NOT_BROWSER) return undefined; // handle SSR\n\n const value = adapter.get<T>(key);\n\n if (isValid && !isValid(value)) {\n console.warn(\n `localStorage adapter: Auto-discard invalid value for ${key}: ${JSON.stringify(value)}`,\n );\n adapter.delete(key);\n return undefined;\n }\n\n return value;\n },\n delete: (key: string): void => {\n if (IS_NOT_BROWSER) return; // handle SSR\n\n adapter.delete(key);\n },\n clear: (): void => {\n if (IS_NOT_BROWSER) return; // handle SSR\n\n adapter.clear();\n },\n };\n }\n\n case \"indexedDb\": {\n // Use the key prefix as a unique namespace for this store.\n const keyPrefix = store.key + \":\";\n const isValid = store.isValid;\n\n // Prefix all keys using `keyPrefix` so that we can keep all data in\n // the same store in the same DB. If we keep the data in different\n // DB stores, then GC will not be able to clean up abandoned stores.\n return {\n set: async (key: string, value: T): Promise<void> => {\n if (IS_NOT_BROWSER) return; // handle SSR\n\n // Also apply the custom expiryMs on every item in this store.\n await kvStore.set(keyPrefix + key, value, expiryMs);\n },\n get: async (key: string): Promise<T \| undefined> => {\n if (IS_NOT_BROWSER) return undefined; // handle SSR\n\n const fullKey = keyPrefix + key;\n const value = await kvStore.get<T>(fullKey);\n\n if (isValid && !isValid(value)) {\n console.warn(\n `indexedDb adapter: Auto-discard invalid value for ${key}: ${JSON.stringify(value)}`,\n );\n await kvStore.delete(fullKey);\n return undefined;\n }\n\n return value;\n },\n delete: async (key: string): Promise<void> => {\n if (IS_NOT_BROWSER) return; // handle SSR\n\n await kvStore.delete(keyPrefix + key);\n },\n clear: async (): Promise<void> => {\n if (IS_NOT_BROWSER) return; // handle SSR\n\n await kvStore.clear();\n },\n };\n }\n\n default:\n store.persistTo satisfies never;\n throw new Error(`Unknown store.adapter ${store.persistTo}`);\n }\n }\n\n return store as StorageAdapter<T>;\n}\n"],"mappings":"yaAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,iBAAAE,EAAA,sBAAAC,EAAA,yBAAAC,EAAA,gBAAAC,EAAA,mBAAAC,EAAA,yBAAAC,EAAA,wBAAAC,IAAA,eAAAC,EAAAT,GA2CA,IAAAU,EAA2B,6CAC3BC,EAA+D,iBC5C/D,IAAAC,EAAwB,uCACxBC,EAA2B,0CAgCrBC,EAAiB,OAAO,OAAW,IAElC,SAASC,EACdC,EACAC,EAC0B,CAC1B,GAAM,CAAE,MAAAC,CAAM,EAAIF,GAAW,CAAC,EAE9B,GAAI,CAACE,EACH,OAAO,KAGT,GACE,cAAeA,GACf,OAAOA,EAAM,WAAc,UAC3B,QAASA,GACT,OAAOA,EAAM,KAAQ,SACrB,CACA,IAAMC,EAAWD,EAAM,UAAYD,EAC7BG,EAAUF,EAAM,QAEtB,OAAQA,EAAM,UAAW,CACvB,IAAK,eAAgB,CACnB,IAAMG,EAAU,IAAI,aAAWH,EAAM,IAAK,CACxC,gBAAiBC,CACnB,CAAC,EAGD,MAAO,CACL,IAAK,CAACG,EAAaC,IAAmB,CAChCT,GAGJO,EAAQ,IAAIC,EAAKC,CAAK,CACxB,EACA,IAAMD,GAA+B,CACnC,GAAIR,EAAgB,OAEpB,IAAMS,EAAQF,EAAQ,IAAOC,CAAG,EAEhC,GAAIF,GAAW,CAACA,EAAQG,CAAK,EAAG,CAC9B,QAAQ,KACN,wDAAwDD,CAAG,KAAK,KAAK,UAAUC,CAAK,CAAC,EACvF,EACAF,EAAQ,OAAOC,CAAG,EAClB,MACF,CAEA,OAAOC,CACT,EACA,OAASD,GAAsB,CACzBR,GAEJO,EAAQ,OAAOC,CAAG,CACpB,EACA,MAAO,IAAY,CACbR,GAEJO,EAAQ,MAAM,CAChB,CACF,CACF,CAEA,IAAK,YAAa,CAEhB,IAAMG,EAAYN,EAAM,IAAM,IACxBE,EAAUF,EAAM,QAKtB,MAAO,CACL,IAAK,MAAOI,EAAaC,IAA4B,CAC/CT,GAGJ,MAAM,UAAQ,IAAIU,EAAYF,EAAKC,EAAOJ,CAAQ,CACpD,EACA,IAAK,MAAOG,GAAwC,CAClD,GAAIR,EAAgB,OAEpB,IAAMW,EAAUD,EAAYF,EACtBC,EAAQ,MAAM,UAAQ,IAAOE,CAAO,EAE1C,GAAIL,GAAW,CAACA,EAAQG,CAAK,EAAG,CAC9B,QAAQ,KACN,qDAAqDD,CAAG,KAAK,KAAK,UAAUC,CAAK,CAAC,EACpF,EACA,MAAM,UAAQ,OAAOE,CAAO,EAC5B,MACF,CAEA,OAAOF,CACT,EACA,OAAQ,MAAOD,GAA+B,CACxCR,GAEJ,MAAM,UAAQ,OAAOU,EAAYF,CAAG,CACtC,EACA,MAAO,SAA2B,CAC5BR,GAEJ,MAAM,UAAQ,MAAM,CACtB,CACF,CACF,CAEA,QACE,MAAAI,EAAM,UACA,IAAI,MAAM,yBAAyBA,EAAM,SAAS,EAAE,CAC9D,CACF,CAEA,OAAOA,CACT,CD5FO,IAAMQ,EAAoB,CAK/B,cAAe,GAAK,aAMpB,SAAU,EACZ,EAKO,SAASC,EAAqBC,EAAoC,CACvE,OAAO,OAAOF,EAAmBE,CAAM,CACzC,CAQA,IAAMC,EAAN,KAAkB,CACR,UAAY,IAAI,IAChB,iBAAmB,IAAI,IAIxB,IAAOC,EAAgB,CAC5B,OAAO,KAAK,UAAU,IAAIA,CAAG,CAC/B,CAEO,IAAOA,EAAaC,EAAgB,CACzC,IAAMC,EAAO,KAAK,UAAU,IAAIF,CAAG,EAG/BE,IAASD,IAEb,KAAK,UAAU,IAAID,EAAKC,CAAK,EAC7B,KAAK,OAAOD,EAAKC,EAAOC,CAAI,EAC9B,CAEO,OAAOF,EAAmB,CAC/B,KAAK,UAAU,OAAOA,CAAG,CAC3B,CAEO,YAAeA,EAAaC,EAAgB,CACjD,KAAK,UAAU,IAAID,EAAKC,CAAK,CAC/B,CAGO,UAAaD,EAAaG,EAAuC,CACtE,IAAIC,EAAc,KAAK,iBAAiB,IAAIJ,CAAG,EAC/C,OAAKI,IACHA,EAAc,IAAI,IAClB,KAAK,iBAAiB,IAAIJ,EAAKI,CAAW,GAI5CA,EAAY,IAAID,CAAiC,EAG1C,IAAM,CACXC,EAAY,OAAOD,CAAiC,EAChDC,EAAY,OAAS,GAAG,KAAK,iBAAiB,OAAOJ,CAAG,CAC9D,CACF,CAEQ,OAAUA,EAAaK,EAASH,EAAe,CACrD,IAAME,EAAc,KAAK,iBAAiB,IAAIJ,CAAG,EACjD,GAAI,CAACI,EAAa,OAGlB,IAAME,EAAO,MAAM,KAAKF,EAAY,OAAO,CAAC,EAC5C,QAAWD,KAAcG,EACvB,GAAI,CACFH,EAAWE,EAAMH,CAAI,CACvB,OAASK,EAAG,CACV,QAAQ,MAAM,6BAA8BA,CAAC,CAC/C,CAEJ,CACF,EAEMC,EAAc,IAAIT,EAElBU,EAAc,QAOhBC,EAAW,EAGFC,EAAN,KAAqB,CAOnB,YACYC,EACjBC,EACA,CAFiB,kBAAAD,EAGjB,KAAK,UAAY,OAAOF,GAAU,EAGlC,KAAK,eAAiBI,EACpBD,EACAjB,EAAkB,aACpB,EAGA,KAAK,gBAAmBS,GAA4B,CAClD,KAAK,SAASA,CAAI,CACpB,EAIAG,EAAY,YAAY,KAAK,UAAWI,CAAY,EAEpD,IAAMG,EAAWF,GAAS,UACbE,IAAa,OAAYA,EAAWnB,EAAkB,WAG5D,KAAK,qBAAqB,CAEnC,CAjCiB,UACA,eACD,gBACT,YAAc,GACd,SAAW,GAgCX,UAAUO,EAAoC,CACnD,OAAOK,EAAY,UAAU,KAAK,UAAW,IAAML,EAAW,CAAC,CACjE,CAGO,UAAoB,CACzB,MAAO,EAAQ,KAAK,cACtB,CASA,MAAa,WAAWF,EAAyB,CAC/C,OAAO,MAAM,KAAK,gBAAgB,IAAIQ,EAAaR,CAAK,CAC1D,CAMA,MAAa,cAAuC,CAClD,OAAO,MAAM,KAAK,gBAAgB,IAAIQ,CAAW,CACnD,CAQO,aAAiB,CACtB,OAAOD,EAAY,IAAI,KAAK,SAAS,CACvC,CAGO,SAASH,EAA+B,CAC7C,GAAI,OAAOA,GAAS,WAAY,CAC9B,IAAMH,EAAOM,EAAY,IAAO,KAAK,SAAS,EAC9CH,EAAQA,EAAqBH,CAAI,CACnC,CAEAM,EAAY,IAAI,KAAK,UAAWH,CAAI,EAC/B,KAAK,WAAWA,CAAI,CAC3B,CAMO,QAAS,CACdG,EAAY,IAAI,KAAK,UAAW,KAAK,YAAY,EAC5C,KAAK,gBAAgB,IAAIC,EAAa,KAAK,YAAY,CAC9D,CAGA,MAAa,sBAAuB,CAClC,GAAI,KAAK,UAAY,KAAK,YAAa,OACvC,KAAK,YAAc,GAEnB,IAAMO,EAAS,MAAM,KAAK,aAAa,EACjCf,EAAQe,IAAW,OAAYA,EAAS,KAAK,aAEnDR,EAAY,IAAI,KAAK,UAAWP,CAAK,EAErC,KAAK,SAAW,EAClB,CACF,EAUO,SAASgB,EACdL,EACAC,EACgB,CAChB,OAAO,IAAIF,EAAYC,EAAcC,CAAO,CAC9C,CAUO,SAASK,EACdC,EACkC,CAClC,OAAAA,EAAM,qBAAqB,EASpB,IAPO,wBACXC,GAAkBD,EAAM,UAAUC,CAAa,EAChD,IAAMD,EAAM,YAAY,EAExB,IAAMA,EAAM,YAAY,CAC1B,EAEeA,EAAM,eAAe,CACtC,CAUO,SAASE,EAAuBF,EAAuB,CAC5D,OAAOD,EAAeC,CAAK,EAAE,CAAC,CAChC,CAUO,SAASG,EAAwBH,EAAuB,CAC7D,OAAOD,EAAeC,CAAK,EAAE,CAAC,CAChC","names":["sharedState_exports","__export","SharedState","SharedStateConfig","configureSharedState","sharedState","useSharedState","useSharedStateSetter","useSharedStateValue","__toCommonJS","import_timeConstants","import_react","import_kvStore","import_localStore","IS_NOT_BROWSER","getStorageAdapter","options","defaultStoreExpiryMs","store","expiryMs","isValid","adapter","key","value","keyPrefix","fullKey","SharedStateConfig","configureSharedState","config","PubSubStore","key","value","prev","subscriber","subscribers","next","copy","e","pubSubStore","STORAGE_KEY","stateKey","SharedState","defaultValue","options","getStorageAdapter","lazyLoad","stored","sharedState","useSharedState","state","onStoreChange","useSharedStateValue","useSharedStateSetter"]}
1	+ {"version":3,"sources":["../src/sharedState.ts","../src/storage.ts"],"sourcesContent":["/*\n @packageDocumentation\n \n The \"shared state\" is a React state that shares the same value across the\n * entire app. Users declare a shared state constant that can be reused across\n * multiple components with the same underlying value.\n \n Shared states provide persistence to local storage and/or indexed DB out of\n * the box, by using \"@choksheak/ts-utils\". Note that no matter if the shared\n * state uses persistence or not, it will always maintain a copy of the state\n * in memory. Persisted values can be configured with an automatic expiration\n * duration.\n \n This module is largely similar to the open source \"jotai\" npm library. You\n * can use shared states to replace \"jotai\" in your code, and optionally make\n * use of the persistence mechanism. A quick migration guide from jotai is:\n \n ```\n * atom() --> sharedState()\n * useAtom() --> useSharedState()\n * useAtomValue() --> useSharedStateValue()\n * useSetAtom() --> useSharedStateSetter()\n * ```\n \n Example:\n * ```\n * import { sharedState, useSharedState } from \"@choksheak/react-utils/sharedState\";\n \n // Create a new shared state in the top level scope.\n * // The first argument is the default value, which is required.\n * // The second argument is an options object, and is optional (defaults\n * // to storing in memory only without any persistence).\n * const usersState = sharedState(\n * [], { store: { persistTo: \"indexedDb\", key: \"users\" }}\n * );\n \n export const UsersComponent: React.FC = () => {\n * // Get both the value and the setter.\n * const [users, setUsers] = useSharedState(usersState);\n * ...\n * };\n \n export const ReadOnlyComponent: React.FC = () => {\n * // Get the value only.\n * const users = useSharedStateValue(usersState);\n * ...\n * };\n \n export const WriteOnlyComponent: React.FC = () => {\n * // Get the setter only.\n * const setUsers = useSharedStateSetter(usersState);\n * ...\n * };\n * ```\n /\n\nimport { MS_PER_DAY } from \"@choksheak/ts-utils/timeConstants\";\nimport { Dispatch, SetStateAction, useSyncExternalStore } from \"react\";\n\nimport { getStorageAdapter, StorageOptions } from \"./storage\";\n\n/**********************************************************************/\n/ Global config /\n/*********************************************************************/\n\n/\n * These values are configurable by the user at any time.\n /\nexport const SharedStateConfig = {\n /\n Default duration for storage expiration in milliseconds. Initial value\n * is 30 days, but can be changed to anything.\n /\n storeExpiryMs: 30 MS_PER_DAY,\n\n /*\n True to load from storage only on mount, false (default) to load in\n * the top level scope when the shared state is defined.\n /\n lazyLoad: false,\n};\n\nexport type SharedStateConfig = typeof SharedStateConfig;\n\n/* Convenience function to update global defaults. /\nexport function configureSharedState(config: Partial<SharedStateConfig>) {\n Object.assign(SharedStateConfig, config);\n}\n\n/**********************************************************************/\n/ Pub-sub store\n/**********************************************************************/\n\ntype Subscriber<T> = (next: T, prev: T) => void;\n\nfunction createPubSubStore() {\n const dataByKey = new Map<string, unknown>();\n const subscribersByKey = new Map<string, Set<Subscriber<unknown>>>();\n\n function notify<T>(key: string, next: T, prev: T): void {\n const subscribers = subscribersByKey.get(key);\n if (!subscribers) return;\n\n // Make copy to protect against mutation during iteration.\n const copy = Array.from(subscribers.values());\n for (const subscriber of copy) {\n try {\n subscriber(next, prev);\n } catch (e) {\n console.error(`Error invoking subscriber:`, e);\n }\n }\n }\n\n return {\n // This could be undefined if T includes undefined, else it should never\n // return undefined because the user has to always specify the default value.\n get<T>(key: string): T {\n return dataByKey.get(key) as T;\n },\n\n set<T>(key: string, value: T): void {\n const prev = dataByKey.get(key) as T;\n\n // Do nothing if no change.\n if (prev === value) return;\n\n dataByKey.set(key, value);\n notify(key, value, prev);\n },\n\n delete(key: string): void {\n dataByKey.delete(key);\n },\n\n setNoNotify<T>(key: string, value: T): void {\n dataByKey.set(key, value);\n },\n\n // Subscribe to changes of a specific key\n subscribe<T>(key: string, subscriber: Subscriber<T>): () => void {\n let subscribers = subscribersByKey.get(key);\n if (!subscribers) {\n subscribers = new Set();\n subscribersByKey.set(key, subscribers);\n }\n\n // Type coercion: we store Subscriber<unknown>\n subscribers.add(subscriber as Subscriber<unknown>);\n\n // Return unsubscribe function\n return () => {\n subscribers.delete(subscriber as Subscriber<unknown>);\n if (subscribers.size === 0) subscribersByKey.delete(key);\n };\n },\n } as const;\n}\n\nconst pubSubStore = createPubSubStore();\n\n/*********************************************************************/\n/ Shared state implementation /\n/*********************************************************************/\n\nconst STORAGE_KEY = \"state\";\n\n/ Options to configure a shared state. /\nexport type SharedStateOptions<T> = {\n lazyLoad?: boolean;\n} & StorageOptions<T>;\n\nlet stateKey = 0;\n\n/\n Create a new shared state object. Put this code at the top level scope:\n \n Example:\n * ```\n * const counterState = sharedState<number>(0);\n * ```\n /\nexport function sharedState<T>(\n defaultValue: T,\n options?: SharedStateOptions<T>,\n) {\n let readyResolve: () => void = () => {};\n\n const readyPromise = new Promise<void>((resolve) => {\n readyResolve = resolve;\n });\n\n const resolveReadyPromise = readyResolve;\n\n const pubSubKey = String(stateKey++);\n\n // Use max of 1 storage adapter per shared state.\n const storageAdapter = getStorageAdapter(\n options,\n SharedStateConfig.storeExpiryMs,\n );\n\n // Always set the default value first to avoid returning undefineds if that\n // is not part of T.\n pubSubStore.setNoNotify(pubSubKey, defaultValue);\n\n const lazyLoad = options?.lazyLoad;\n const lazy = lazyLoad !== undefined ? lazyLoad : SharedStateConfig.lazyLoad;\n\n const obj = {\n /* Allow users to await for the completion of data init. /\n readyPromise,\n\n lazy,\n\n initStarted: false,\n initDone: false,\n\n /* `subscribe` function required by useSyncExternalStore. /\n subscribe(subscriber: () => void): () => void {\n return pubSubStore.subscribe(pubSubKey, () => subscriber());\n },\n\n /* Returns true if there is a backing store. /\n hasStore(): boolean {\n return Boolean(storageAdapter);\n },\n\n /\n Set a value directly into the store. Does nothing if there is no\n * backing store.\n \n Warning: If you want to set the value properly, you should use\n * `setValue()` instead which also updates the in-memory copy.\n /\n async setInStore(value: T): Promise<void> {\n return await storageAdapter?.set(STORAGE_KEY, value);\n },\n\n /\n Get a value directly from the store. Returns undefined if there is no\n * backing store.\n /\n async getFromStore(): Promise<T \| undefined> {\n return await storageAdapter?.get(STORAGE_KEY);\n },\n\n /\n Get the value of the shared state.\n * `getSnapshot` function — must return same ref if value unchanged.\n * Note that this would return the default value if data init from store is\n * not completed yet.\n /\n getSnapshot(): T {\n return pubSubStore.get(pubSubKey);\n },\n\n /* Set the value of the shared state. /\n setValue(next: SetStateAction<T>): void {\n if (typeof next === \"function\") {\n const prev = pubSubStore.get<T>(pubSubKey);\n next = (next as (p: T) => T)(prev);\n }\n\n pubSubStore.set(pubSubKey, next);\n void obj.setInStore(next);\n },\n\n /\n Remove the value of the shared state. Actually this just sets the value\n * back to the given default value.\n /\n delete() {\n pubSubStore.set(pubSubKey, defaultValue);\n void storageAdapter?.set(STORAGE_KEY, defaultValue);\n },\n\n /* Initial default handling. /\n async initDefaultValueOnce() {\n if (obj.initDone \|\| obj.initStarted) return;\n // @ts-expect-error ts(2540) - Assign to readonly property.\n obj.initStarted = true;\n\n const stored = await obj.getFromStore();\n const value = stored !== undefined ? stored : defaultValue;\n\n pubSubStore.set(pubSubKey, value);\n\n // @ts-expect-error ts(2540) - Assign to readonly property.\n obj.initDone = true;\n resolveReadyPromise();\n },\n } as const;\n\n if (!lazy) {\n void obj.initDefaultValueOnce();\n }\n\n return obj;\n}\n\nexport type SharedState<T> = ReturnType<typeof sharedState<T>>;\n\n/\n React hook for subscribing to a key in the global store.\n \n Example:\n * ```\n * const [counter, setCounter] = useSharedState(counterState);\n * ```\n /\nexport function useSharedState<T>(\n state: SharedState<T>,\n): [T, Dispatch<SetStateAction<T>>] {\n void state.initDefaultValueOnce();\n\n const value = useSyncExternalStore(\n (onStoreChange) => state.subscribe(onStoreChange),\n () => state.getSnapshot(),\n // getServerSnapshot is needed to prevent SSR dev errors in nextjs.\n () => state.getSnapshot(),\n );\n\n return [value, state.setValue];\n}\n\n/\n Same as useSharedState(), but returns the value only.\n \n Example:\n * ```\n * const counter = useSharedStateValue(counterState);\n * ```\n /\nexport function useSharedStateValue<T>(state: SharedState<T>) {\n return useSharedState(state)[0];\n}\n\n/\n Same as useSharedState(), but returns the setter only.\n \n Example:\n * ```\n * const setCounter = useSharedStateSetter(counterState);\n * ```\n /\nexport function useSharedStateSetter<T>(state: SharedState<T>) {\n void state.initDefaultValueOnce();\n\n return state.setValue;\n}\n","/\n @packageDocumentation\n \n Backing storage implementation for the shared state. Note that this uses the\n * LocalStore and KvStore from package \"@choksheak/ts-utils\", but is customized\n * to be used for shared states.\n \n Normally you will not need to use this module directly, but if you have a\n * need for it, feel free to use it.\n /\n\nimport { Duration } from \"@choksheak/ts-utils/duration\";\nimport { kvStore } from \"@choksheak/ts-utils/kvStore\";\nimport { createLocalStore } from \"@choksheak/ts-utils/localStore\";\nimport { StorageAdapter } from \"@choksheak/ts-utils/storageAdapter\";\n\n/* List of all available pre-built persistence options. /\nexport type PersistTo = \"localStorage\" \| \"indexedDb\";\n\n/* Options to configure a pre-built store adapter. /\nexport type StoreOptions = {\n /* Choose which pre-built store adapter to use. /\n persistTo: PersistTo;\n\n /* Storage key to act as a namespace to store the data. /\n key: string;\n\n /* How long to wait before the value is considered expired. /\n expiryMs?: number \| Duration;\n\n /* Returns true if the given value supposed to be of type T is valid. /\n isValid?: (u: unknown) => boolean;\n};\n\nexport type StoreConstructorArgs = Omit<StoreOptions, \"persistTo\">;\n\n/* Either use a pre-built store, or a custom one you provide. /\nexport type StorageOptions<T> = {\n /\n You can either specify the storage adapter directly to use a custom\n * store, or specify the properties to use the pre-built ones.\n /\n store?: StorageAdapter<T> \| StoreOptions;\n};\n\n// In SSR (Server-Side Rendering) mode, we never want to use our storage\n// adapters for anything.\nconst IS_NOT_BROWSER = typeof window === \"undefined\";\n\n/\n Convert a StorageOptions<T> config object into an actual storage adapter, or\n * returns null if a storage adapter is not configured.\n /\nexport function getStorageAdapter<T>(\n options: StorageOptions<T> \| undefined,\n defaultStoreExpiryMs: number,\n): StorageAdapter<T> \| null {\n const { store } = options ?? {};\n\n if (!store) {\n return null;\n }\n\n if (\n \"persistTo\" in store &&\n typeof store.persistTo === \"string\" &&\n \"key\" in store &&\n typeof store.key === \"string\"\n ) {\n const expiryMs = store.expiryMs \|\| defaultStoreExpiryMs;\n const config = { ...store, expiryMs };\n\n switch (store.persistTo) {\n case \"localStorage\":\n return localStoreAdapter<T>(config);\n\n case \"indexedDb\":\n return kvStoreAdapter<T>(config);\n\n default:\n store.persistTo satisfies never;\n throw new Error(`Unknown store.adapter ${store.persistTo}`);\n }\n }\n\n return store as StorageAdapter<T>;\n}\n\n/\n Create a new SSR-safe local store adapter, which allows users to reuse the\n * same adapter in multiple shared states or shared queries.\n /\nexport function localStoreAdapter<T>({\n key,\n expiryMs,\n isValid,\n}: StoreConstructorArgs) {\n const adapter = createLocalStore(key, { defaultExpiryMs: expiryMs });\n\n return {\n set: (key: string, value: T): void => {\n if (IS_NOT_BROWSER) return; // handle SSR\n\n // Also apply the custom expiryMs on every item in this store.\n adapter.set(key, value);\n },\n\n get: (key: string): T \| undefined => {\n if (IS_NOT_BROWSER) return undefined; // handle SSR\n\n const value = adapter.get<T>(key);\n\n if (isValid && !isValid(value)) {\n console.warn(\n `localStorage adapter: Auto-discard invalid value for ${key}: ${JSON.stringify(value)}`,\n );\n adapter.delete(key);\n return undefined;\n }\n\n return value;\n },\n\n delete: (key: string): void => {\n if (IS_NOT_BROWSER) return; // handle SSR\n\n adapter.delete(key);\n },\n\n clear: (): void => {\n if (IS_NOT_BROWSER) return; // handle SSR\n\n adapter.clear();\n },\n };\n}\n\n/\n Create a new SSR-safe indexed DB KV store adapter, which allows users to\n * reuse the same adapter in multiple shared states or shared queries.\n */\nexport function kvStoreAdapter<T>({\n key,\n expiryMs,\n isValid,\n}: StoreConstructorArgs) {\n // Use the key prefix as a unique namespace for this store.\n const keyPrefix = key + \":\";\n\n // Prefix all keys using `keyPrefix` so that we can keep all data in\n // the same store in the same DB. If we keep the data in different\n // DB stores, then GC will not be able to clean up abandoned stores.\n return {\n set: async (key: string, value: T): Promise<void> => {\n if (IS_NOT_BROWSER) return; // handle SSR\n\n // Also apply the custom expiryMs on every item in this store.\n await kvStore.set(keyPrefix + key, value, expiryMs);\n },\n get: async (key: string): Promise<T \| undefined> => {\n if (IS_NOT_BROWSER) return undefined; // handle SSR\n\n const fullKey = keyPrefix + key;\n const value = await kvStore.get<T>(fullKey);\n\n if (isValid && !isValid(value)) {\n console.warn(\n `indexedDb adapter: Auto-discard invalid value for ${key}: ${JSON.stringify(value)}`,\n );\n await kvStore.delete(fullKey);\n return undefined;\n }\n\n return value;\n },\n delete: async (key: string): Promise<void> => {\n if (IS_NOT_BROWSER) return; // handle SSR\n\n await kvStore.delete(keyPrefix + key);\n },\n clear: async (): Promise<void> => {\n if (IS_NOT_BROWSER) return; // handle SSR\n\n await kvStore.clear();\n },\n };\n}\n"],"mappings":"yaAAA,IAAAA,EAAA,GAAAC,EAAAD,EAAA,uBAAAE,EAAA,yBAAAC,EAAA,gBAAAC,EAAA,mBAAAC,EAAA,yBAAAC,EAAA,wBAAAC,IAAA,eAAAC,EAAAR,GAwDA,IAAAS,EAA2B,6CAC3BC,EAA+D,iBC7C/D,IAAAC,EAAwB,uCACxBC,EAAiC,0CAkC3BC,EAAiB,OAAO,OAAW,IAMlC,SAASC,EACdC,EACAC,EAC0B,CAC1B,GAAM,CAAE,MAAAC,CAAM,EAAIF,GAAW,CAAC,EAE9B,GAAI,CAACE,EACH,OAAO,KAGT,GACE,cAAeA,GACf,OAAOA,EAAM,WAAc,UAC3B,QAASA,GACT,OAAOA,EAAM,KAAQ,SACrB,CACA,IAAMC,EAAWD,EAAM,UAAYD,EAC7BG,EAAS,CAAE,GAAGF,EAAO,SAAAC,CAAS,EAEpC,OAAQD,EAAM,UAAW,CACvB,IAAK,eACH,OAAOG,EAAqBD,CAAM,EAEpC,IAAK,YACH,OAAOE,EAAkBF,CAAM,EAEjC,QACE,MAAAF,EAAM,UACA,IAAI,MAAM,yBAAyBA,EAAM,SAAS,EAAE,CAC9D,CACF,CAEA,OAAOA,CACT,CAMO,SAASG,EAAqB,CACnC,IAAAE,EACA,SAAAJ,EACA,QAAAK,CACF,EAAyB,CACvB,IAAMC,KAAU,oBAAiBF,EAAK,CAAE,gBAAiBJ,CAAS,CAAC,EAEnE,MAAO,CACL,IAAK,CAACI,EAAaG,IAAmB,CAChCZ,GAGJW,EAAQ,IAAIF,EAAKG,CAAK,CACxB,EAEA,IAAMH,GAA+B,CACnC,GAAIT,EAAgB,OAEpB,IAAMY,EAAQD,EAAQ,IAAOF,CAAG,EAEhC,GAAIC,GAAW,CAACA,EAAQE,CAAK,EAAG,CAC9B,QAAQ,KACN,wDAAwDH,CAAG,KAAK,KAAK,UAAUG,CAAK,CAAC,EACvF,EACAD,EAAQ,OAAOF,CAAG,EAClB,MACF,CAEA,OAAOG,CACT,EAEA,OAASH,GAAsB,CACzBT,GAEJW,EAAQ,OAAOF,CAAG,CACpB,EAEA,MAAO,IAAY,CACbT,GAEJW,EAAQ,MAAM,CAChB,CACF,CACF,CAMO,SAASH,EAAkB,CAChC,IAAAC,EACA,SAAAJ,EACA,QAAAK,CACF,EAAyB,CAEvB,IAAMG,EAAYJ,EAAM,IAKxB,MAAO,CACL,IAAK,MAAOA,EAAaG,IAA4B,CAC/CZ,GAGJ,MAAM,UAAQ,IAAIa,EAAYJ,EAAKG,EAAOP,CAAQ,CACpD,EACA,IAAK,MAAOI,GAAwC,CAClD,GAAIT,EAAgB,OAEpB,IAAMc,EAAUD,EAAYJ,EACtBG,EAAQ,MAAM,UAAQ,IAAOE,CAAO,EAE1C,GAAIJ,GAAW,CAACA,EAAQE,CAAK,EAAG,CAC9B,QAAQ,KACN,qDAAqDH,CAAG,KAAK,KAAK,UAAUG,CAAK,CAAC,EACpF,EACA,MAAM,UAAQ,OAAOE,CAAO,EAC5B,MACF,CAEA,OAAOF,CACT,EACA,OAAQ,MAAOH,GAA+B,CACxCT,GAEJ,MAAM,UAAQ,OAAOa,EAAYJ,CAAG,CACtC,EACA,MAAO,SAA2B,CAC5BT,GAEJ,MAAM,UAAQ,MAAM,CACtB,CACF,CACF,CDtHO,IAAMe,EAAoB,CAK/B,cAAe,GAAK,aAMpB,SAAU,EACZ,EAKO,SAASC,EAAqBC,EAAoC,CACvE,OAAO,OAAOF,EAAmBE,CAAM,CACzC,CAQA,SAASC,GAAoB,CAC3B,IAAMC,EAAY,IAAI,IAChBC,EAAmB,IAAI,IAE7B,SAASC,EAAUC,EAAaC,EAASC,EAAe,CACtD,IAAMC,EAAcL,EAAiB,IAAIE,CAAG,EAC5C,GAAI,CAACG,EAAa,OAGlB,IAAMC,EAAO,MAAM,KAAKD,EAAY,OAAO,CAAC,EAC5C,QAAWE,KAAcD,EACvB,GAAI,CACFC,EAAWJ,EAAMC,CAAI,CACvB,OAASI,EAAG,CACV,QAAQ,MAAM,6BAA8BA,CAAC,CAC/C,CAEJ,CAEA,MAAO,CAGL,IAAON,EAAgB,CACrB,OAAOH,EAAU,IAAIG,CAAG,CAC1B,EAEA,IAAOA,EAAaO,EAAgB,CAClC,IAAML,EAAOL,EAAU,IAAIG,CAAG,EAG1BE,IAASK,IAEbV,EAAU,IAAIG,EAAKO,CAAK,EACxBR,EAAOC,EAAKO,EAAOL,CAAI,EACzB,EAEA,OAAOF,EAAmB,CACxBH,EAAU,OAAOG,CAAG,CACtB,EAEA,YAAeA,EAAaO,EAAgB,CAC1CV,EAAU,IAAIG,EAAKO,CAAK,CAC1B,EAGA,UAAaP,EAAaK,EAAuC,CAC/D,IAAIF,EAAcL,EAAiB,IAAIE,CAAG,EAC1C,OAAKG,IACHA,EAAc,IAAI,IAClBL,EAAiB,IAAIE,EAAKG,CAAW,GAIvCA,EAAY,IAAIE,CAAiC,EAG1C,IAAM,CACXF,EAAY,OAAOE,CAAiC,EAChDF,EAAY,OAAS,GAAGL,EAAiB,OAAOE,CAAG,CACzD,CACF,CACF,CACF,CAEA,IAAMQ,EAAcZ,EAAkB,EAMhCa,EAAc,QAOhBC,EAAW,EAUR,SAASC,EACdC,EACAC,EACA,CACA,IAAIC,EAA2B,IAAM,CAAC,EAEhCC,EAAe,IAAI,QAAeC,GAAY,CAClDF,EAAeE,CACjB,CAAC,EAEKC,EAAsBH,EAEtBI,EAAY,OAAOR,GAAU,EAG7BS,EAAiBC,EACrBP,EACApB,EAAkB,aACpB,EAIAe,EAAY,YAAYU,EAAWN,CAAY,EAE/C,IAAMS,EAAWR,GAAS,SACpBS,EAAOD,IAAa,OAAYA,EAAW5B,EAAkB,SAE7D8B,EAAM,CAEV,aAAAR,EAEA,KAAAO,EAEA,YAAa,GACb,SAAU,GAGV,UAAUjB,EAAoC,CAC5C,OAAOG,EAAY,UAAUU,EAAW,IAAMb,EAAW,CAAC,CAC5D,EAGA,UAAoB,CAClB,MAAO,EAAQc,CACjB,EASA,MAAM,WAAWZ,EAAyB,CACxC,OAAO,MAAMY,GAAgB,IAAIV,EAAaF,CAAK,CACrD,EAMA,MAAM,cAAuC,CAC3C,OAAO,MAAMY,GAAgB,IAAIV,CAAW,CAC9C,EAQA,aAAiB,CACf,OAAOD,EAAY,IAAIU,CAAS,CAClC,EAGA,SAASjB,EAA+B,CACtC,GAAI,OAAOA,GAAS,WAAY,CAC9B,IAAMC,EAAOM,EAAY,IAAOU,CAAS,EACzCjB,EAAQA,EAAqBC,CAAI,CACnC,CAEAM,EAAY,IAAIU,EAAWjB,CAAI,EAC1BsB,EAAI,WAAWtB,CAAI,CAC1B,EAMA,QAAS,CACPO,EAAY,IAAIU,EAAWN,CAAY,EAClCO,GAAgB,IAAIV,EAAaG,CAAY,CACpD,EAGA,MAAM,sBAAuB,CAC3B,GAAIW,EAAI,UAAYA,EAAI,YAAa,OAErCA,EAAI,YAAc,GAElB,IAAMC,EAAS,MAAMD,EAAI,aAAa,EAChChB,EAAQiB,IAAW,OAAYA,EAASZ,EAE9CJ,EAAY,IAAIU,EAAWX,CAAK,EAGhCgB,EAAI,SAAW,GACfN,EAAoB,CACtB,CACF,EAEA,OAAKK,GACEC,EAAI,qBAAqB,EAGzBA,CACT,CAYO,SAASE,EACdC,EACkC,CAClC,OAAKA,EAAM,qBAAqB,EASzB,IAPO,wBACXC,GAAkBD,EAAM,UAAUC,CAAa,EAChD,IAAMD,EAAM,YAAY,EAExB,IAAMA,EAAM,YAAY,CAC1B,EAEeA,EAAM,QAAQ,CAC/B,CAUO,SAASE,EAAuBF,EAAuB,CAC5D,OAAOD,EAAeC,CAAK,EAAE,CAAC,CAChC,CAUO,SAASG,EAAwBH,EAAuB,CAC7D,OAAKA,EAAM,qBAAqB,EAEzBA,EAAM,QACf","names":["sharedState_exports","__export","SharedStateConfig","configureSharedState","sharedState","useSharedState","useSharedStateSetter","useSharedStateValue","__toCommonJS","import_timeConstants","import_react","import_kvStore","import_localStore","IS_NOT_BROWSER","getStorageAdapter","options","defaultStoreExpiryMs","store","expiryMs","config","localStoreAdapter","kvStoreAdapter","key","isValid","adapter","value","keyPrefix","fullKey","SharedStateConfig","configureSharedState","config","createPubSubStore","dataByKey","subscribersByKey","notify","key","next","prev","subscribers","copy","subscriber","e","value","pubSubStore","STORAGE_KEY","stateKey","sharedState","defaultValue","options","readyResolve","readyPromise","resolve","resolveReadyPromise","pubSubKey","storageAdapter","getStorageAdapter","lazyLoad","lazy","obj","stored","useSharedState","state","onStoreChange","useSharedStateValue","useSharedStateSetter"]}

package/sharedState.min.mjs CHANGED Viewed

@@ -1,2 +1,2 @@
-import{MS_PER_DAY as v}from"@choksheak/ts-utils/timeConstants";import{useSyncExternalStore as w}from"react";import{kvStore as p}from"@choksheak/ts-utils/kvStore";import{LocalStore as h}from"@choksheak/ts-utils/localStore";var o=typeof window>"u";function g(r,e){let{store:t}=r??{};if(!t)return null;if("persistTo"in t&&typeof t.persistTo=="string"&&"key"in t&&typeof t.key=="string"){let i=t.expiryMs||e,d=t.isValid;switch(t.persistTo){case"localStorage":{let a=new h(t.key,{defaultExpiryMs:i});return{set:(n,s)=>{o||a.set(n,s)},get:n=>{if(o)return;let s=a.get(n);if(d&&!d(s)){console.warn(`localStorage adapter: Auto-discard invalid value for ${n}: ${JSON.stringify(s)}`),a.delete(n);return}return s},delete:n=>{o||a.delete(n)},clear:()=>{o||a.clear()}}}case"indexedDb":{let a=t.key+":",n=t.isValid;return{set:async(s,c)=>{o||await p.set(a+s,c,i)},get:async s=>{if(o)return;let c=a+s,l=await p.get(c);if(n&&!n(l)){console.warn(`indexedDb adapter: Auto-discard invalid value for ${s}: ${JSON.stringify(l)}`),await p.delete(c);return}return l},delete:async s=>{o||await p.delete(a+s)},clear:async()=>{o||await p.clear()}}}default:throw t.persistTo,new Error(`Unknown store.adapter ${t.persistTo}`)}}return t}var f={storeExpiryMs:30*v,lazyLoad:!1};function M(r){Object.assign(f,r)}var b=class{dataByKey=new Map;subscribersByKey=new Map;get(e){return this.dataByKey.get(e)}set(e,t){let i=this.dataByKey.get(e);i!==t&&(this.dataByKey.set(e,t),this.notify(e,t,i))}delete(e){this.dataByKey.delete(e)}setNoNotify(e,t){this.dataByKey.set(e,t)}subscribe(e,t){let i=this.subscribersByKey.get(e);return i||(i=new Set,this.subscribersByKey.set(e,i)),i.add(t),()=>{i.delete(t),i.size===0&&this.subscribersByKey.delete(e)}}notify(e,t,i){let d=this.subscribersByKey.get(e);if(!d)return;let a=Array.from(d.values());for(let n of a)try{n(t,i)}catch(s){console.error("Error invoking subscriber:",s)}}},u=new b,S="state",m=0,y=class{constructor(e,t){this.defaultValue=e;this.pubSubKey=String(m++),this.storageAdapter=g(t,f.storeExpiryMs),this.setValueBounded=a=>{this.setValue(a)},u.setNoNotify(this.pubSubKey,e);let i=t?.lazyLoad;(i!==void 0?i:f.lazyLoad)||this.initDefaultValueOnce()}pubSubKey;storageAdapter;setValueBounded;initStarted=!1;initDone=!1;subscribe(e){return u.subscribe(this.pubSubKey,()=>e())}hasStore(){return!!this.storageAdapter}async setInStore(e){return await this.storageAdapter?.set(S,e)}async getFromStore(){return await this.storageAdapter?.get(S)}getSnapshot(){return u.get(this.pubSubKey)}setValue(e){if(typeof e=="function"){let t=u.get(this.pubSubKey);e=e(t)}u.set(this.pubSubKey,e),this.setInStore(e)}delete(){u.set(this.pubSubKey,this.defaultValue),this.storageAdapter?.set(S,this.defaultValue)}async initDefaultValueOnce(){if(this.initDone||this.initStarted)return;this.initStarted=!0;let e=await this.getFromStore(),t=e!==void 0?e:this.defaultValue;u.set(this.pubSubKey,t),this.initDone=!0}};function z(r,e){return new y(r,e)}function T(r){return r.initDefaultValueOnce(),[w(t=>r.subscribe(t),()=>r.getSnapshot(),()=>r.getSnapshot()),r.setValueBounded]}function k(r){return T(r)[0]}function N(r){return T(r)[1]}export{y as SharedState,f as SharedStateConfig,M as configureSharedState,z as sharedState,T as useSharedState,N as useSharedStateSetter,k as useSharedStateValue};
+import{MS_PER_DAY as h}from"@choksheak/ts-utils/timeConstants";import{useSyncExternalStore as w}from"react";import{kvStore as S}from"@choksheak/ts-utils/kvStore";import{createLocalStore as b}from"@choksheak/ts-utils/localStore";var d=typeof window>"u";function y(r,i){let{store:n}=r??{};if(!n)return null;if("persistTo"in n&&typeof n.persistTo=="string"&&"key"in n&&typeof n.key=="string"){let o=n.expiryMs||i,e={...n,expiryMs:o};switch(n.persistTo){case"localStorage":return v(e);case"indexedDb":return m(e);default:throw n.persistTo,new Error(`Unknown store.adapter ${n.persistTo}`)}}return n}function v({key:r,expiryMs:i,isValid:n}){let o=b(r,{defaultExpiryMs:i});return{set:(e,t)=>{d||o.set(e,t)},get:e=>{if(d)return;let t=o.get(e);if(n&&!n(t)){console.warn(`localStorage adapter: Auto-discard invalid value for ${e}: ${JSON.stringify(t)}`),o.delete(e);return}return t},delete:e=>{d||o.delete(e)},clear:()=>{d||o.clear()}}}function m({key:r,expiryMs:i,isValid:n}){let o=r+":";return{set:async(e,t)=>{d||await S.set(o+e,t,i)},get:async e=>{if(d)return;let t=o+e,a=await S.get(t);if(n&&!n(a)){console.warn(`indexedDb adapter: Auto-discard invalid value for ${e}: ${JSON.stringify(a)}`),await S.delete(t);return}return a},delete:async e=>{d||await S.delete(o+e)},clear:async()=>{d||await S.clear()}}}var g={storeExpiryMs:30*h,lazyLoad:!1};function K(r){Object.assign(g,r)}function x(){let r=new Map,i=new Map;function n(o,e,t){let a=i.get(o);if(!a)return;let p=Array.from(a.values());for(let f of p)try{f(e,t)}catch(u){console.error("Error invoking subscriber:",u)}}return{get(o){return r.get(o)},set(o,e){let t=r.get(o);t!==e&&(r.set(o,e),n(o,e,t))},delete(o){r.delete(o)},setNoNotify(o,e){r.set(o,e)},subscribe(o,e){let t=i.get(o);return t||(t=new Set,i.set(o,t)),t.add(e),()=>{t.delete(e),t.size===0&&i.delete(o)}}}}var c=x(),T="state",A=0;function L(r,i){let n=()=>{},o=new Promise(s=>{n=s}),e=n,t=String(A++),a=y(i,g.storeExpiryMs);c.setNoNotify(t,r);let p=i?.lazyLoad,f=p!==void 0?p:g.lazyLoad,u={readyPromise:o,lazy:f,initStarted:!1,initDone:!1,subscribe(s){return c.subscribe(t,()=>s())},hasStore(){return!!a},async setInStore(s){return await a?.set(T,s)},async getFromStore(){return await a?.get(T)},getSnapshot(){return c.get(t)},setValue(s){if(typeof s=="function"){let l=c.get(t);s=s(l)}c.set(t,s),u.setInStore(s)},delete(){c.set(t,r),a?.set(T,r)},async initDefaultValueOnce(){if(u.initDone||u.initStarted)return;u.initStarted=!0;let s=await u.getFromStore(),l=s!==void 0?s:r;c.set(t,l),u.initDone=!0,e()}};return f||u.initDefaultValueOnce(),u}function O(r){return r.initDefaultValueOnce(),[w(n=>r.subscribe(n),()=>r.getSnapshot(),()=>r.getSnapshot()),r.setValue]}function _(r){return O(r)[0]}function $(r){return r.initDefaultValueOnce(),r.setValue}export{g as SharedStateConfig,K as configureSharedState,L as sharedState,O as useSharedState,$ as useSharedStateSetter,_ as useSharedStateValue};
 //# sourceMappingURL=sharedState.min.mjs.map

package/sharedState.min.mjs.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"sources":["../src/sharedState.ts","../src/storage.ts"],"sourcesContent":["/*\n @packageDocumentation\n \n The \"shared state\" is a React state that shares the same value across the\n * entire app. It is largely similar to the jotai library, but is much smaller\n * and much easier to work with when used for persisting in local storage or\n * indexed db, with an automatic expiration for persisted values.\n \n This library aims to be the shortest, simplest, easiest to use, and most\n * efficient implementation of shared global React states with seamless support\n * for client persistence.\n \n Example:\n * ```\n * import { sharedState, useSharedState } from \"@choksheak/react-utils/sharedState\";\n \n // Create a new shared state in the top level scope.\n * // The first argument is the default value, which is required.\n * // The second argument is an options object, and is optional (defaults\n * // to storing in memory only without any persistence).\n * const usersState = sharedState([], { indexedDbKey: \"users\" });\n \n export const UsersComponent: React.FC = () => {\n * // Get both the value and the setter.\n * const [users, setUsers] = useSharedState(usersState);\n * ...\n * };\n \n export const ReadOnlyComponent: React.FC = () => {\n * // Get the value only.\n * const users = useSharedStateValue(usersState);\n * ...\n * };\n \n export const WriteOnlyComponent: React.FC = () => {\n * // Get the setter only.\n * const setUsers = useSharedStateSetter(usersState);\n * ...\n * };\n * ```\n /\n\nimport { StorageAdapter } from \"@choksheak/ts-utils/storageAdapter\";\nimport { MS_PER_DAY } from \"@choksheak/ts-utils/timeConstants\";\nimport { Dispatch, SetStateAction, useSyncExternalStore } from \"react\";\n\nimport { getStorageAdapter, StorageOptions } from \"./storage\";\n\n/**********************************************************************/\n/ Global config /\n/*********************************************************************/\n\n/\n * These values are configurable by the user at any time.\n /\nexport const SharedStateConfig = {\n /\n Default duration for storage expiration in milliseconds. Initial value\n * is 30 days, but can be changed to anything.\n /\n storeExpiryMs: 30 MS_PER_DAY,\n\n /*\n True to load from storage only on mount, false (default) to load in\n * the top level scope when the shared state is defined.\n /\n lazyLoad: false,\n};\n\nexport type SharedStateConfig = typeof SharedStateConfig;\n\n/* Convenience function to update global defaults. /\nexport function configureSharedState(config: Partial<SharedStateConfig>) {\n Object.assign(SharedStateConfig, config);\n}\n\n/**********************************************************************/\n/ Shared state implementation /\n/*********************************************************************/\n\ntype Subscriber<T> = (next: T, prev: T) => void;\n\nclass PubSubStore {\n private dataByKey = new Map<string, unknown>();\n private subscribersByKey = new Map<string, Set<Subscriber<unknown>>>();\n\n // This could be undefined if T includes undefined, else it should never\n // return undefined because the user has to always specify the default value.\n public get<T>(key: string): T {\n return this.dataByKey.get(key) as T;\n }\n\n public set<T>(key: string, value: T): void {\n const prev = this.dataByKey.get(key) as T;\n\n // Do nothing if no change.\n if (prev === value) return;\n\n this.dataByKey.set(key, value);\n this.notify(key, value, prev);\n }\n\n public delete(key: string): void {\n this.dataByKey.delete(key);\n }\n\n public setNoNotify<T>(key: string, value: T): void {\n this.dataByKey.set(key, value);\n }\n\n // Subscribe to changes of a specific key\n public subscribe<T>(key: string, subscriber: Subscriber<T>): () => void {\n let subscribers = this.subscribersByKey.get(key);\n if (!subscribers) {\n subscribers = new Set();\n this.subscribersByKey.set(key, subscribers);\n }\n\n // Type coercion: we store Subscriber<unknown>\n subscribers.add(subscriber as Subscriber<unknown>);\n\n // Return unsubscribe function\n return () => {\n subscribers.delete(subscriber as Subscriber<unknown>);\n if (subscribers.size === 0) this.subscribersByKey.delete(key);\n };\n }\n\n private notify<T>(key: string, next: T, prev: T): void {\n const subscribers = this.subscribersByKey.get(key);\n if (!subscribers) return;\n\n // Make copy to protect against mutation during iteration.\n const copy = Array.from(subscribers.values());\n for (const subscriber of copy) {\n try {\n subscriber(next, prev);\n } catch (e) {\n console.error(`Error invoking subscriber:`, e);\n }\n }\n }\n}\n\nconst pubSubStore = new PubSubStore();\n\nconst STORAGE_KEY = \"state\";\n\n/ Options to configure a shared state. /\nexport type SharedStateOptions<T> = {\n lazyLoad?: boolean;\n} & StorageOptions<T>;\n\nlet stateKey = 0;\n\n/* Please use sharedState() instead. /\nexport class SharedState<T> {\n private readonly pubSubKey: string;\n private readonly storageAdapter: StorageAdapter<T> \| null;\n public readonly setValueBounded: Dispatch<SetStateAction<T>>;\n public initStarted = false;\n public initDone = false;\n\n public constructor(\n private readonly defaultValue: T,\n options?: SharedStateOptions<T>,\n ) {\n this.pubSubKey = String(stateKey++);\n\n // Use max of 1 storage adapter per shared state.\n this.storageAdapter = getStorageAdapter(\n options,\n SharedStateConfig.storeExpiryMs,\n );\n\n // Same as this.setValue, but binding the `this` reference.\n this.setValueBounded = (next: SetStateAction<T>) => {\n this.setValue(next);\n };\n\n // Always set the default value first to avoid returning undefineds if that\n // is not part of T.\n pubSubStore.setNoNotify(this.pubSubKey, defaultValue);\n\n const lazyLoad = options?.lazyLoad;\n const lazy = lazyLoad !== undefined ? lazyLoad : SharedStateConfig.lazyLoad;\n\n if (!lazy) {\n void this.initDefaultValueOnce();\n }\n }\n\n /* `subscribe` function required by useSyncExternalStore. /\n public subscribe(subscriber: () => void): () => void {\n return pubSubStore.subscribe(this.pubSubKey, () => subscriber());\n }\n\n /* Returns true if there is a backing store. /\n public hasStore(): boolean {\n return Boolean(this.storageAdapter);\n }\n\n /\n Set a value directly into the store. Does nothing if there is no\n * backing store.\n \n Warning: If you want to set the value properly, you should use\n * `setValue()` instead which also updates the in-memory copy.\n /\n public async setInStore(value: T): Promise<void> {\n return await this.storageAdapter?.set(STORAGE_KEY, value);\n }\n\n /\n Get a value directly from the store. Returns undefined if there is no\n * backing store.\n /\n public async getFromStore(): Promise<T \| undefined> {\n return await this.storageAdapter?.get(STORAGE_KEY);\n }\n\n /\n Get the value of the shared state.\n * `getSnapshot` function — must return same ref if value unchanged.\n * Note that this would return the default value if data init from store is\n * not completed yet.\n /\n public getSnapshot(): T {\n return pubSubStore.get(this.pubSubKey);\n }\n\n /* Set the value of the shared state. /\n public setValue(next: SetStateAction<T>): void {\n if (typeof next === \"function\") {\n const prev = pubSubStore.get<T>(this.pubSubKey);\n next = (next as (p: T) => T)(prev);\n }\n\n pubSubStore.set(this.pubSubKey, next);\n void this.setInStore(next);\n }\n\n /\n Remove the value of the shared state. Actually this just sets the value\n * back to the given default value.\n /\n public delete() {\n pubSubStore.set(this.pubSubKey, this.defaultValue);\n void this.storageAdapter?.set(STORAGE_KEY, this.defaultValue);\n }\n\n /* Initial default handling. /\n public async initDefaultValueOnce() {\n if (this.initDone \|\| this.initStarted) return;\n this.initStarted = true;\n\n const stored = await this.getFromStore();\n const value = stored !== undefined ? stored : this.defaultValue;\n\n pubSubStore.set(this.pubSubKey, value);\n\n this.initDone = true;\n }\n}\n\n/\n Create a new shared state object. Put this code at the top level scope:\n \n Example:\n * ```\n * const counterState = sharedState<number>(0);\n * ```\n /\nexport function sharedState<T>(\n defaultValue: T,\n options?: SharedStateOptions<T>,\n): SharedState<T> {\n return new SharedState(defaultValue, options);\n}\n\n/\n React hook for subscribing to a key in the global store.\n \n Example:\n * ```\n * const [counter, setCounter] = useSharedState(counterState);\n * ```\n /\nexport function useSharedState<T>(\n state: SharedState<T>,\n): [T, Dispatch<SetStateAction<T>>] {\n state.initDefaultValueOnce();\n\n const value = useSyncExternalStore(\n (onStoreChange) => state.subscribe(onStoreChange),\n () => state.getSnapshot(),\n // getServerSnapshot is needed to prevent SSR dev errors in nextjs.\n () => state.getSnapshot(),\n );\n\n return [value, state.setValueBounded];\n}\n\n/\n Same as useSharedState(), but returns the value only.\n \n Example:\n * ```\n * const counter = useSharedStateValue(counterState);\n * ```\n /\nexport function useSharedStateValue<T>(state: SharedState<T>) {\n return useSharedState(state)[0];\n}\n\n/\n Same as useSharedState(), but returns the setter only.\n \n Example:\n * ```\n * const setCounter = useSharedStateSetter(counterState);\n * ```\n /\nexport function useSharedStateSetter<T>(state: SharedState<T>) {\n return useSharedState(state)[1];\n}\n","import { kvStore } from \"@choksheak/ts-utils/kvStore\";\nimport { LocalStore } from \"@choksheak/ts-utils/localStore\";\nimport { StorageAdapter } from \"@choksheak/ts-utils/storageAdapter\";\n\n/* List of all available pre-built persistence options. /\nexport type PersistTo = \"localStorage\" \| \"indexedDb\";\n\n/* Options to configure a pre-built store adapter. /\nexport type StoreOptions = {\n /* Choose which pre-built store adapter to use. /\n persistTo: PersistTo;\n\n /* Storage key to act as a namespace to store the data. /\n key: string;\n\n /* How long to wait before the value is considered expired. /\n expiryMs?: number;\n\n /* Returns true if the given value supposed to be of type T is valid. /\n isValid?: (u: unknown) => boolean;\n};\n\n/* Either use a pre-built store, or a custom one you provide. /\nexport type StorageOptions<T> = {\n /\n You can either specify the storage adapter directly to use a custom\n * store, or specify the properties to use the pre-built ones.\n */\n store?: StorageAdapter<T> \| StoreOptions;\n};\n\n// In SSR (Server-Side Rendering) mode, we never want to use our storage\n// adapters for anything.\nconst IS_NOT_BROWSER = typeof window === \"undefined\";\n\nexport function getStorageAdapter<T>(\n options: StorageOptions<T> \| undefined,\n defaultStoreExpiryMs: number,\n): StorageAdapter<T> \| null {\n const { store } = options ?? {};\n\n if (!store) {\n return null;\n }\n\n if (\n \"persistTo\" in store &&\n typeof store.persistTo === \"string\" &&\n \"key\" in store &&\n typeof store.key === \"string\"\n ) {\n const expiryMs = store.expiryMs \|\| defaultStoreExpiryMs;\n const isValid = store.isValid;\n\n switch (store.persistTo) {\n case \"localStorage\": {\n const adapter = new LocalStore(store.key, {\n defaultExpiryMs: expiryMs,\n });\n\n // Handle SSR.\n return {\n set: (key: string, value: T): void => {\n if (IS_NOT_BROWSER) return; // handle SSR\n\n // Also apply the custom expiryMs on every item in this store.\n adapter.set(key, value);\n },\n get: (key: string): T \| undefined => {\n if (IS_NOT_BROWSER) return undefined; // handle SSR\n\n const value = adapter.get<T>(key);\n\n if (isValid && !isValid(value)) {\n console.warn(\n `localStorage adapter: Auto-discard invalid value for ${key}: ${JSON.stringify(value)}`,\n );\n adapter.delete(key);\n return undefined;\n }\n\n return value;\n },\n delete: (key: string): void => {\n if (IS_NOT_BROWSER) return; // handle SSR\n\n adapter.delete(key);\n },\n clear: (): void => {\n if (IS_NOT_BROWSER) return; // handle SSR\n\n adapter.clear();\n },\n };\n }\n\n case \"indexedDb\": {\n // Use the key prefix as a unique namespace for this store.\n const keyPrefix = store.key + \":\";\n const isValid = store.isValid;\n\n // Prefix all keys using `keyPrefix` so that we can keep all data in\n // the same store in the same DB. If we keep the data in different\n // DB stores, then GC will not be able to clean up abandoned stores.\n return {\n set: async (key: string, value: T): Promise<void> => {\n if (IS_NOT_BROWSER) return; // handle SSR\n\n // Also apply the custom expiryMs on every item in this store.\n await kvStore.set(keyPrefix + key, value, expiryMs);\n },\n get: async (key: string): Promise<T \| undefined> => {\n if (IS_NOT_BROWSER) return undefined; // handle SSR\n\n const fullKey = keyPrefix + key;\n const value = await kvStore.get<T>(fullKey);\n\n if (isValid && !isValid(value)) {\n console.warn(\n `indexedDb adapter: Auto-discard invalid value for ${key}: ${JSON.stringify(value)}`,\n );\n await kvStore.delete(fullKey);\n return undefined;\n }\n\n return value;\n },\n delete: async (key: string): Promise<void> => {\n if (IS_NOT_BROWSER) return; // handle SSR\n\n await kvStore.delete(keyPrefix + key);\n },\n clear: async (): Promise<void> => {\n if (IS_NOT_BROWSER) return; // handle SSR\n\n await kvStore.clear();\n },\n };\n }\n\n default:\n store.persistTo satisfies never;\n throw new Error(`Unknown store.adapter ${store.persistTo}`);\n }\n }\n\n return store as StorageAdapter<T>;\n}\n"],"mappings":"AA2CA,OAAS,cAAAA,MAAkB,oCAC3B,OAAmC,wBAAAC,MAA4B,QC5C/D,OAAS,WAAAC,MAAe,8BACxB,OAAS,cAAAC,MAAkB,iCAgC3B,IAAMC,EAAiB,OAAO,OAAW,IAElC,SAASC,EACdC,EACAC,EAC0B,CAC1B,GAAM,CAAE,MAAAC,CAAM,EAAIF,GAAW,CAAC,EAE9B,GAAI,CAACE,EACH,OAAO,KAGT,GACE,cAAeA,GACf,OAAOA,EAAM,WAAc,UAC3B,QAASA,GACT,OAAOA,EAAM,KAAQ,SACrB,CACA,IAAMC,EAAWD,EAAM,UAAYD,EAC7BG,EAAUF,EAAM,QAEtB,OAAQA,EAAM,UAAW,CACvB,IAAK,eAAgB,CACnB,IAAMG,EAAU,IAAIR,EAAWK,EAAM,IAAK,CACxC,gBAAiBC,CACnB,CAAC,EAGD,MAAO,CACL,IAAK,CAACG,EAAaC,IAAmB,CAChCT,GAGJO,EAAQ,IAAIC,EAAKC,CAAK,CACxB,EACA,IAAMD,GAA+B,CACnC,GAAIR,EAAgB,OAEpB,IAAMS,EAAQF,EAAQ,IAAOC,CAAG,EAEhC,GAAIF,GAAW,CAACA,EAAQG,CAAK,EAAG,CAC9B,QAAQ,KACN,wDAAwDD,CAAG,KAAK,KAAK,UAAUC,CAAK,CAAC,EACvF,EACAF,EAAQ,OAAOC,CAAG,EAClB,MACF,CAEA,OAAOC,CACT,EACA,OAASD,GAAsB,CACzBR,GAEJO,EAAQ,OAAOC,CAAG,CACpB,EACA,MAAO,IAAY,CACbR,GAEJO,EAAQ,MAAM,CAChB,CACF,CACF,CAEA,IAAK,YAAa,CAEhB,IAAMG,EAAYN,EAAM,IAAM,IACxBE,EAAUF,EAAM,QAKtB,MAAO,CACL,IAAK,MAAOI,EAAaC,IAA4B,CAC/CT,GAGJ,MAAMF,EAAQ,IAAIY,EAAYF,EAAKC,EAAOJ,CAAQ,CACpD,EACA,IAAK,MAAOG,GAAwC,CAClD,GAAIR,EAAgB,OAEpB,IAAMW,EAAUD,EAAYF,EACtBC,EAAQ,MAAMX,EAAQ,IAAOa,CAAO,EAE1C,GAAIL,GAAW,CAACA,EAAQG,CAAK,EAAG,CAC9B,QAAQ,KACN,qDAAqDD,CAAG,KAAK,KAAK,UAAUC,CAAK,CAAC,EACpF,EACA,MAAMX,EAAQ,OAAOa,CAAO,EAC5B,MACF,CAEA,OAAOF,CACT,EACA,OAAQ,MAAOD,GAA+B,CACxCR,GAEJ,MAAMF,EAAQ,OAAOY,EAAYF,CAAG,CACtC,EACA,MAAO,SAA2B,CAC5BR,GAEJ,MAAMF,EAAQ,MAAM,CACtB,CACF,CACF,CAEA,QACE,MAAAM,EAAM,UACA,IAAI,MAAM,yBAAyBA,EAAM,SAAS,EAAE,CAC9D,CACF,CAEA,OAAOA,CACT,CD5FO,IAAMQ,EAAoB,CAK/B,cAAe,GAAKC,EAMpB,SAAU,EACZ,EAKO,SAASC,EAAqBC,EAAoC,CACvE,OAAO,OAAOH,EAAmBG,CAAM,CACzC,CAQA,IAAMC,EAAN,KAAkB,CACR,UAAY,IAAI,IAChB,iBAAmB,IAAI,IAIxB,IAAOC,EAAgB,CAC5B,OAAO,KAAK,UAAU,IAAIA,CAAG,CAC/B,CAEO,IAAOA,EAAaC,EAAgB,CACzC,IAAMC,EAAO,KAAK,UAAU,IAAIF,CAAG,EAG/BE,IAASD,IAEb,KAAK,UAAU,IAAID,EAAKC,CAAK,EAC7B,KAAK,OAAOD,EAAKC,EAAOC,CAAI,EAC9B,CAEO,OAAOF,EAAmB,CAC/B,KAAK,UAAU,OAAOA,CAAG,CAC3B,CAEO,YAAeA,EAAaC,EAAgB,CACjD,KAAK,UAAU,IAAID,EAAKC,CAAK,CAC/B,CAGO,UAAaD,EAAaG,EAAuC,CACtE,IAAIC,EAAc,KAAK,iBAAiB,IAAIJ,CAAG,EAC/C,OAAKI,IACHA,EAAc,IAAI,IAClB,KAAK,iBAAiB,IAAIJ,EAAKI,CAAW,GAI5CA,EAAY,IAAID,CAAiC,EAG1C,IAAM,CACXC,EAAY,OAAOD,CAAiC,EAChDC,EAAY,OAAS,GAAG,KAAK,iBAAiB,OAAOJ,CAAG,CAC9D,CACF,CAEQ,OAAUA,EAAaK,EAASH,EAAe,CACrD,IAAME,EAAc,KAAK,iBAAiB,IAAIJ,CAAG,EACjD,GAAI,CAACI,EAAa,OAGlB,IAAME,EAAO,MAAM,KAAKF,EAAY,OAAO,CAAC,EAC5C,QAAWD,KAAcG,EACvB,GAAI,CACFH,EAAWE,EAAMH,CAAI,CACvB,OAASK,EAAG,CACV,QAAQ,MAAM,6BAA8BA,CAAC,CAC/C,CAEJ,CACF,EAEMC,EAAc,IAAIT,EAElBU,EAAc,QAOhBC,EAAW,EAGFC,EAAN,KAAqB,CAOnB,YACYC,EACjBC,EACA,CAFiB,kBAAAD,EAGjB,KAAK,UAAY,OAAOF,GAAU,EAGlC,KAAK,eAAiBI,EACpBD,EACAlB,EAAkB,aACpB,EAGA,KAAK,gBAAmBU,GAA4B,CAClD,KAAK,SAASA,CAAI,CACpB,EAIAG,EAAY,YAAY,KAAK,UAAWI,CAAY,EAEpD,IAAMG,EAAWF,GAAS,UACbE,IAAa,OAAYA,EAAWpB,EAAkB,WAG5D,KAAK,qBAAqB,CAEnC,CAjCiB,UACA,eACD,gBACT,YAAc,GACd,SAAW,GAgCX,UAAUQ,EAAoC,CACnD,OAAOK,EAAY,UAAU,KAAK,UAAW,IAAML,EAAW,CAAC,CACjE,CAGO,UAAoB,CACzB,MAAO,EAAQ,KAAK,cACtB,CASA,MAAa,WAAWF,EAAyB,CAC/C,OAAO,MAAM,KAAK,gBAAgB,IAAIQ,EAAaR,CAAK,CAC1D,CAMA,MAAa,cAAuC,CAClD,OAAO,MAAM,KAAK,gBAAgB,IAAIQ,CAAW,CACnD,CAQO,aAAiB,CACtB,OAAOD,EAAY,IAAI,KAAK,SAAS,CACvC,CAGO,SAASH,EAA+B,CAC7C,GAAI,OAAOA,GAAS,WAAY,CAC9B,IAAMH,EAAOM,EAAY,IAAO,KAAK,SAAS,EAC9CH,EAAQA,EAAqBH,CAAI,CACnC,CAEAM,EAAY,IAAI,KAAK,UAAWH,CAAI,EAC/B,KAAK,WAAWA,CAAI,CAC3B,CAMO,QAAS,CACdG,EAAY,IAAI,KAAK,UAAW,KAAK,YAAY,EAC5C,KAAK,gBAAgB,IAAIC,EAAa,KAAK,YAAY,CAC9D,CAGA,MAAa,sBAAuB,CAClC,GAAI,KAAK,UAAY,KAAK,YAAa,OACvC,KAAK,YAAc,GAEnB,IAAMO,EAAS,MAAM,KAAK,aAAa,EACjCf,EAAQe,IAAW,OAAYA,EAAS,KAAK,aAEnDR,EAAY,IAAI,KAAK,UAAWP,CAAK,EAErC,KAAK,SAAW,EAClB,CACF,EAUO,SAASgB,EACdL,EACAC,EACgB,CAChB,OAAO,IAAIF,EAAYC,EAAcC,CAAO,CAC9C,CAUO,SAASK,EACdC,EACkC,CAClC,OAAAA,EAAM,qBAAqB,EASpB,CAPOC,EACXC,GAAkBF,EAAM,UAAUE,CAAa,EAChD,IAAMF,EAAM,YAAY,EAExB,IAAMA,EAAM,YAAY,CAC1B,EAEeA,EAAM,eAAe,CACtC,CAUO,SAASG,EAAuBH,EAAuB,CAC5D,OAAOD,EAAeC,CAAK,EAAE,CAAC,CAChC,CAUO,SAASI,EAAwBJ,EAAuB,CAC7D,OAAOD,EAAeC,CAAK,EAAE,CAAC,CAChC","names":["MS_PER_DAY","useSyncExternalStore","kvStore","LocalStore","IS_NOT_BROWSER","getStorageAdapter","options","defaultStoreExpiryMs","store","expiryMs","isValid","adapter","key","value","keyPrefix","fullKey","SharedStateConfig","MS_PER_DAY","configureSharedState","config","PubSubStore","key","value","prev","subscriber","subscribers","next","copy","e","pubSubStore","STORAGE_KEY","stateKey","SharedState","defaultValue","options","getStorageAdapter","lazyLoad","stored","sharedState","useSharedState","state","useSyncExternalStore","onStoreChange","useSharedStateValue","useSharedStateSetter"]}
1	+ {"version":3,"sources":["../src/sharedState.ts","../src/storage.ts"],"sourcesContent":["/*\n @packageDocumentation\n \n The \"shared state\" is a React state that shares the same value across the\n * entire app. Users declare a shared state constant that can be reused across\n * multiple components with the same underlying value.\n \n Shared states provide persistence to local storage and/or indexed DB out of\n * the box, by using \"@choksheak/ts-utils\". Note that no matter if the shared\n * state uses persistence or not, it will always maintain a copy of the state\n * in memory. Persisted values can be configured with an automatic expiration\n * duration.\n \n This module is largely similar to the open source \"jotai\" npm library. You\n * can use shared states to replace \"jotai\" in your code, and optionally make\n * use of the persistence mechanism. A quick migration guide from jotai is:\n \n ```\n * atom() --> sharedState()\n * useAtom() --> useSharedState()\n * useAtomValue() --> useSharedStateValue()\n * useSetAtom() --> useSharedStateSetter()\n * ```\n \n Example:\n * ```\n * import { sharedState, useSharedState } from \"@choksheak/react-utils/sharedState\";\n \n // Create a new shared state in the top level scope.\n * // The first argument is the default value, which is required.\n * // The second argument is an options object, and is optional (defaults\n * // to storing in memory only without any persistence).\n * const usersState = sharedState(\n * [], { store: { persistTo: \"indexedDb\", key: \"users\" }}\n * );\n \n export const UsersComponent: React.FC = () => {\n * // Get both the value and the setter.\n * const [users, setUsers] = useSharedState(usersState);\n * ...\n * };\n \n export const ReadOnlyComponent: React.FC = () => {\n * // Get the value only.\n * const users = useSharedStateValue(usersState);\n * ...\n * };\n \n export const WriteOnlyComponent: React.FC = () => {\n * // Get the setter only.\n * const setUsers = useSharedStateSetter(usersState);\n * ...\n * };\n * ```\n /\n\nimport { MS_PER_DAY } from \"@choksheak/ts-utils/timeConstants\";\nimport { Dispatch, SetStateAction, useSyncExternalStore } from \"react\";\n\nimport { getStorageAdapter, StorageOptions } from \"./storage\";\n\n/**********************************************************************/\n/ Global config /\n/*********************************************************************/\n\n/\n * These values are configurable by the user at any time.\n /\nexport const SharedStateConfig = {\n /\n Default duration for storage expiration in milliseconds. Initial value\n * is 30 days, but can be changed to anything.\n /\n storeExpiryMs: 30 MS_PER_DAY,\n\n /*\n True to load from storage only on mount, false (default) to load in\n * the top level scope when the shared state is defined.\n /\n lazyLoad: false,\n};\n\nexport type SharedStateConfig = typeof SharedStateConfig;\n\n/* Convenience function to update global defaults. /\nexport function configureSharedState(config: Partial<SharedStateConfig>) {\n Object.assign(SharedStateConfig, config);\n}\n\n/**********************************************************************/\n/ Pub-sub store\n/**********************************************************************/\n\ntype Subscriber<T> = (next: T, prev: T) => void;\n\nfunction createPubSubStore() {\n const dataByKey = new Map<string, unknown>();\n const subscribersByKey = new Map<string, Set<Subscriber<unknown>>>();\n\n function notify<T>(key: string, next: T, prev: T): void {\n const subscribers = subscribersByKey.get(key);\n if (!subscribers) return;\n\n // Make copy to protect against mutation during iteration.\n const copy = Array.from(subscribers.values());\n for (const subscriber of copy) {\n try {\n subscriber(next, prev);\n } catch (e) {\n console.error(`Error invoking subscriber:`, e);\n }\n }\n }\n\n return {\n // This could be undefined if T includes undefined, else it should never\n // return undefined because the user has to always specify the default value.\n get<T>(key: string): T {\n return dataByKey.get(key) as T;\n },\n\n set<T>(key: string, value: T): void {\n const prev = dataByKey.get(key) as T;\n\n // Do nothing if no change.\n if (prev === value) return;\n\n dataByKey.set(key, value);\n notify(key, value, prev);\n },\n\n delete(key: string): void {\n dataByKey.delete(key);\n },\n\n setNoNotify<T>(key: string, value: T): void {\n dataByKey.set(key, value);\n },\n\n // Subscribe to changes of a specific key\n subscribe<T>(key: string, subscriber: Subscriber<T>): () => void {\n let subscribers = subscribersByKey.get(key);\n if (!subscribers) {\n subscribers = new Set();\n subscribersByKey.set(key, subscribers);\n }\n\n // Type coercion: we store Subscriber<unknown>\n subscribers.add(subscriber as Subscriber<unknown>);\n\n // Return unsubscribe function\n return () => {\n subscribers.delete(subscriber as Subscriber<unknown>);\n if (subscribers.size === 0) subscribersByKey.delete(key);\n };\n },\n } as const;\n}\n\nconst pubSubStore = createPubSubStore();\n\n/*********************************************************************/\n/ Shared state implementation /\n/*********************************************************************/\n\nconst STORAGE_KEY = \"state\";\n\n/ Options to configure a shared state. /\nexport type SharedStateOptions<T> = {\n lazyLoad?: boolean;\n} & StorageOptions<T>;\n\nlet stateKey = 0;\n\n/\n Create a new shared state object. Put this code at the top level scope:\n \n Example:\n * ```\n * const counterState = sharedState<number>(0);\n * ```\n /\nexport function sharedState<T>(\n defaultValue: T,\n options?: SharedStateOptions<T>,\n) {\n let readyResolve: () => void = () => {};\n\n const readyPromise = new Promise<void>((resolve) => {\n readyResolve = resolve;\n });\n\n const resolveReadyPromise = readyResolve;\n\n const pubSubKey = String(stateKey++);\n\n // Use max of 1 storage adapter per shared state.\n const storageAdapter = getStorageAdapter(\n options,\n SharedStateConfig.storeExpiryMs,\n );\n\n // Always set the default value first to avoid returning undefineds if that\n // is not part of T.\n pubSubStore.setNoNotify(pubSubKey, defaultValue);\n\n const lazyLoad = options?.lazyLoad;\n const lazy = lazyLoad !== undefined ? lazyLoad : SharedStateConfig.lazyLoad;\n\n const obj = {\n /* Allow users to await for the completion of data init. /\n readyPromise,\n\n lazy,\n\n initStarted: false,\n initDone: false,\n\n /* `subscribe` function required by useSyncExternalStore. /\n subscribe(subscriber: () => void): () => void {\n return pubSubStore.subscribe(pubSubKey, () => subscriber());\n },\n\n /* Returns true if there is a backing store. /\n hasStore(): boolean {\n return Boolean(storageAdapter);\n },\n\n /\n Set a value directly into the store. Does nothing if there is no\n * backing store.\n \n Warning: If you want to set the value properly, you should use\n * `setValue()` instead which also updates the in-memory copy.\n /\n async setInStore(value: T): Promise<void> {\n return await storageAdapter?.set(STORAGE_KEY, value);\n },\n\n /\n Get a value directly from the store. Returns undefined if there is no\n * backing store.\n /\n async getFromStore(): Promise<T \| undefined> {\n return await storageAdapter?.get(STORAGE_KEY);\n },\n\n /\n Get the value of the shared state.\n * `getSnapshot` function — must return same ref if value unchanged.\n * Note that this would return the default value if data init from store is\n * not completed yet.\n /\n getSnapshot(): T {\n return pubSubStore.get(pubSubKey);\n },\n\n /* Set the value of the shared state. /\n setValue(next: SetStateAction<T>): void {\n if (typeof next === \"function\") {\n const prev = pubSubStore.get<T>(pubSubKey);\n next = (next as (p: T) => T)(prev);\n }\n\n pubSubStore.set(pubSubKey, next);\n void obj.setInStore(next);\n },\n\n /\n Remove the value of the shared state. Actually this just sets the value\n * back to the given default value.\n /\n delete() {\n pubSubStore.set(pubSubKey, defaultValue);\n void storageAdapter?.set(STORAGE_KEY, defaultValue);\n },\n\n /* Initial default handling. /\n async initDefaultValueOnce() {\n if (obj.initDone \|\| obj.initStarted) return;\n // @ts-expect-error ts(2540) - Assign to readonly property.\n obj.initStarted = true;\n\n const stored = await obj.getFromStore();\n const value = stored !== undefined ? stored : defaultValue;\n\n pubSubStore.set(pubSubKey, value);\n\n // @ts-expect-error ts(2540) - Assign to readonly property.\n obj.initDone = true;\n resolveReadyPromise();\n },\n } as const;\n\n if (!lazy) {\n void obj.initDefaultValueOnce();\n }\n\n return obj;\n}\n\nexport type SharedState<T> = ReturnType<typeof sharedState<T>>;\n\n/\n React hook for subscribing to a key in the global store.\n \n Example:\n * ```\n * const [counter, setCounter] = useSharedState(counterState);\n * ```\n /\nexport function useSharedState<T>(\n state: SharedState<T>,\n): [T, Dispatch<SetStateAction<T>>] {\n void state.initDefaultValueOnce();\n\n const value = useSyncExternalStore(\n (onStoreChange) => state.subscribe(onStoreChange),\n () => state.getSnapshot(),\n // getServerSnapshot is needed to prevent SSR dev errors in nextjs.\n () => state.getSnapshot(),\n );\n\n return [value, state.setValue];\n}\n\n/\n Same as useSharedState(), but returns the value only.\n \n Example:\n * ```\n * const counter = useSharedStateValue(counterState);\n * ```\n /\nexport function useSharedStateValue<T>(state: SharedState<T>) {\n return useSharedState(state)[0];\n}\n\n/\n Same as useSharedState(), but returns the setter only.\n \n Example:\n * ```\n * const setCounter = useSharedStateSetter(counterState);\n * ```\n /\nexport function useSharedStateSetter<T>(state: SharedState<T>) {\n void state.initDefaultValueOnce();\n\n return state.setValue;\n}\n","/\n @packageDocumentation\n \n Backing storage implementation for the shared state. Note that this uses the\n * LocalStore and KvStore from package \"@choksheak/ts-utils\", but is customized\n * to be used for shared states.\n \n Normally you will not need to use this module directly, but if you have a\n * need for it, feel free to use it.\n /\n\nimport { Duration } from \"@choksheak/ts-utils/duration\";\nimport { kvStore } from \"@choksheak/ts-utils/kvStore\";\nimport { createLocalStore } from \"@choksheak/ts-utils/localStore\";\nimport { StorageAdapter } from \"@choksheak/ts-utils/storageAdapter\";\n\n/* List of all available pre-built persistence options. /\nexport type PersistTo = \"localStorage\" \| \"indexedDb\";\n\n/* Options to configure a pre-built store adapter. /\nexport type StoreOptions = {\n /* Choose which pre-built store adapter to use. /\n persistTo: PersistTo;\n\n /* Storage key to act as a namespace to store the data. /\n key: string;\n\n /* How long to wait before the value is considered expired. /\n expiryMs?: number \| Duration;\n\n /* Returns true if the given value supposed to be of type T is valid. /\n isValid?: (u: unknown) => boolean;\n};\n\nexport type StoreConstructorArgs = Omit<StoreOptions, \"persistTo\">;\n\n/* Either use a pre-built store, or a custom one you provide. /\nexport type StorageOptions<T> = {\n /\n You can either specify the storage adapter directly to use a custom\n * store, or specify the properties to use the pre-built ones.\n /\n store?: StorageAdapter<T> \| StoreOptions;\n};\n\n// In SSR (Server-Side Rendering) mode, we never want to use our storage\n// adapters for anything.\nconst IS_NOT_BROWSER = typeof window === \"undefined\";\n\n/\n Convert a StorageOptions<T> config object into an actual storage adapter, or\n * returns null if a storage adapter is not configured.\n /\nexport function getStorageAdapter<T>(\n options: StorageOptions<T> \| undefined,\n defaultStoreExpiryMs: number,\n): StorageAdapter<T> \| null {\n const { store } = options ?? {};\n\n if (!store) {\n return null;\n }\n\n if (\n \"persistTo\" in store &&\n typeof store.persistTo === \"string\" &&\n \"key\" in store &&\n typeof store.key === \"string\"\n ) {\n const expiryMs = store.expiryMs \|\| defaultStoreExpiryMs;\n const config = { ...store, expiryMs };\n\n switch (store.persistTo) {\n case \"localStorage\":\n return localStoreAdapter<T>(config);\n\n case \"indexedDb\":\n return kvStoreAdapter<T>(config);\n\n default:\n store.persistTo satisfies never;\n throw new Error(`Unknown store.adapter ${store.persistTo}`);\n }\n }\n\n return store as StorageAdapter<T>;\n}\n\n/\n Create a new SSR-safe local store adapter, which allows users to reuse the\n * same adapter in multiple shared states or shared queries.\n /\nexport function localStoreAdapter<T>({\n key,\n expiryMs,\n isValid,\n}: StoreConstructorArgs) {\n const adapter = createLocalStore(key, { defaultExpiryMs: expiryMs });\n\n return {\n set: (key: string, value: T): void => {\n if (IS_NOT_BROWSER) return; // handle SSR\n\n // Also apply the custom expiryMs on every item in this store.\n adapter.set(key, value);\n },\n\n get: (key: string): T \| undefined => {\n if (IS_NOT_BROWSER) return undefined; // handle SSR\n\n const value = adapter.get<T>(key);\n\n if (isValid && !isValid(value)) {\n console.warn(\n `localStorage adapter: Auto-discard invalid value for ${key}: ${JSON.stringify(value)}`,\n );\n adapter.delete(key);\n return undefined;\n }\n\n return value;\n },\n\n delete: (key: string): void => {\n if (IS_NOT_BROWSER) return; // handle SSR\n\n adapter.delete(key);\n },\n\n clear: (): void => {\n if (IS_NOT_BROWSER) return; // handle SSR\n\n adapter.clear();\n },\n };\n}\n\n/\n Create a new SSR-safe indexed DB KV store adapter, which allows users to\n * reuse the same adapter in multiple shared states or shared queries.\n */\nexport function kvStoreAdapter<T>({\n key,\n expiryMs,\n isValid,\n}: StoreConstructorArgs) {\n // Use the key prefix as a unique namespace for this store.\n const keyPrefix = key + \":\";\n\n // Prefix all keys using `keyPrefix` so that we can keep all data in\n // the same store in the same DB. If we keep the data in different\n // DB stores, then GC will not be able to clean up abandoned stores.\n return {\n set: async (key: string, value: T): Promise<void> => {\n if (IS_NOT_BROWSER) return; // handle SSR\n\n // Also apply the custom expiryMs on every item in this store.\n await kvStore.set(keyPrefix + key, value, expiryMs);\n },\n get: async (key: string): Promise<T \| undefined> => {\n if (IS_NOT_BROWSER) return undefined; // handle SSR\n\n const fullKey = keyPrefix + key;\n const value = await kvStore.get<T>(fullKey);\n\n if (isValid && !isValid(value)) {\n console.warn(\n `indexedDb adapter: Auto-discard invalid value for ${key}: ${JSON.stringify(value)}`,\n );\n await kvStore.delete(fullKey);\n return undefined;\n }\n\n return value;\n },\n delete: async (key: string): Promise<void> => {\n if (IS_NOT_BROWSER) return; // handle SSR\n\n await kvStore.delete(keyPrefix + key);\n },\n clear: async (): Promise<void> => {\n if (IS_NOT_BROWSER) return; // handle SSR\n\n await kvStore.clear();\n },\n };\n}\n"],"mappings":"AAwDA,OAAS,cAAAA,MAAkB,oCAC3B,OAAmC,wBAAAC,MAA4B,QC7C/D,OAAS,WAAAC,MAAe,8BACxB,OAAS,oBAAAC,MAAwB,iCAkCjC,IAAMC,EAAiB,OAAO,OAAW,IAMlC,SAASC,EACdC,EACAC,EAC0B,CAC1B,GAAM,CAAE,MAAAC,CAAM,EAAIF,GAAW,CAAC,EAE9B,GAAI,CAACE,EACH,OAAO,KAGT,GACE,cAAeA,GACf,OAAOA,EAAM,WAAc,UAC3B,QAASA,GACT,OAAOA,EAAM,KAAQ,SACrB,CACA,IAAMC,EAAWD,EAAM,UAAYD,EAC7BG,EAAS,CAAE,GAAGF,EAAO,SAAAC,CAAS,EAEpC,OAAQD,EAAM,UAAW,CACvB,IAAK,eACH,OAAOG,EAAqBD,CAAM,EAEpC,IAAK,YACH,OAAOE,EAAkBF,CAAM,EAEjC,QACE,MAAAF,EAAM,UACA,IAAI,MAAM,yBAAyBA,EAAM,SAAS,EAAE,CAC9D,CACF,CAEA,OAAOA,CACT,CAMO,SAASG,EAAqB,CACnC,IAAAE,EACA,SAAAJ,EACA,QAAAK,CACF,EAAyB,CACvB,IAAMC,EAAUZ,EAAiBU,EAAK,CAAE,gBAAiBJ,CAAS,CAAC,EAEnE,MAAO,CACL,IAAK,CAACI,EAAaG,IAAmB,CAChCZ,GAGJW,EAAQ,IAAIF,EAAKG,CAAK,CACxB,EAEA,IAAMH,GAA+B,CACnC,GAAIT,EAAgB,OAEpB,IAAMY,EAAQD,EAAQ,IAAOF,CAAG,EAEhC,GAAIC,GAAW,CAACA,EAAQE,CAAK,EAAG,CAC9B,QAAQ,KACN,wDAAwDH,CAAG,KAAK,KAAK,UAAUG,CAAK,CAAC,EACvF,EACAD,EAAQ,OAAOF,CAAG,EAClB,MACF,CAEA,OAAOG,CACT,EAEA,OAASH,GAAsB,CACzBT,GAEJW,EAAQ,OAAOF,CAAG,CACpB,EAEA,MAAO,IAAY,CACbT,GAEJW,EAAQ,MAAM,CAChB,CACF,CACF,CAMO,SAASH,EAAkB,CAChC,IAAAC,EACA,SAAAJ,EACA,QAAAK,CACF,EAAyB,CAEvB,IAAMG,EAAYJ,EAAM,IAKxB,MAAO,CACL,IAAK,MAAOA,EAAaG,IAA4B,CAC/CZ,GAGJ,MAAMF,EAAQ,IAAIe,EAAYJ,EAAKG,EAAOP,CAAQ,CACpD,EACA,IAAK,MAAOI,GAAwC,CAClD,GAAIT,EAAgB,OAEpB,IAAMc,EAAUD,EAAYJ,EACtBG,EAAQ,MAAMd,EAAQ,IAAOgB,CAAO,EAE1C,GAAIJ,GAAW,CAACA,EAAQE,CAAK,EAAG,CAC9B,QAAQ,KACN,qDAAqDH,CAAG,KAAK,KAAK,UAAUG,CAAK,CAAC,EACpF,EACA,MAAMd,EAAQ,OAAOgB,CAAO,EAC5B,MACF,CAEA,OAAOF,CACT,EACA,OAAQ,MAAOH,GAA+B,CACxCT,GAEJ,MAAMF,EAAQ,OAAOe,EAAYJ,CAAG,CACtC,EACA,MAAO,SAA2B,CAC5BT,GAEJ,MAAMF,EAAQ,MAAM,CACtB,CACF,CACF,CDtHO,IAAMiB,EAAoB,CAK/B,cAAe,GAAKC,EAMpB,SAAU,EACZ,EAKO,SAASC,EAAqBC,EAAoC,CACvE,OAAO,OAAOH,EAAmBG,CAAM,CACzC,CAQA,SAASC,GAAoB,CAC3B,IAAMC,EAAY,IAAI,IAChBC,EAAmB,IAAI,IAE7B,SAASC,EAAUC,EAAaC,EAASC,EAAe,CACtD,IAAMC,EAAcL,EAAiB,IAAIE,CAAG,EAC5C,GAAI,CAACG,EAAa,OAGlB,IAAMC,EAAO,MAAM,KAAKD,EAAY,OAAO,CAAC,EAC5C,QAAWE,KAAcD,EACvB,GAAI,CACFC,EAAWJ,EAAMC,CAAI,CACvB,OAASI,EAAG,CACV,QAAQ,MAAM,6BAA8BA,CAAC,CAC/C,CAEJ,CAEA,MAAO,CAGL,IAAON,EAAgB,CACrB,OAAOH,EAAU,IAAIG,CAAG,CAC1B,EAEA,IAAOA,EAAaO,EAAgB,CAClC,IAAML,EAAOL,EAAU,IAAIG,CAAG,EAG1BE,IAASK,IAEbV,EAAU,IAAIG,EAAKO,CAAK,EACxBR,EAAOC,EAAKO,EAAOL,CAAI,EACzB,EAEA,OAAOF,EAAmB,CACxBH,EAAU,OAAOG,CAAG,CACtB,EAEA,YAAeA,EAAaO,EAAgB,CAC1CV,EAAU,IAAIG,EAAKO,CAAK,CAC1B,EAGA,UAAaP,EAAaK,EAAuC,CAC/D,IAAIF,EAAcL,EAAiB,IAAIE,CAAG,EAC1C,OAAKG,IACHA,EAAc,IAAI,IAClBL,EAAiB,IAAIE,EAAKG,CAAW,GAIvCA,EAAY,IAAIE,CAAiC,EAG1C,IAAM,CACXF,EAAY,OAAOE,CAAiC,EAChDF,EAAY,OAAS,GAAGL,EAAiB,OAAOE,CAAG,CACzD,CACF,CACF,CACF,CAEA,IAAMQ,EAAcZ,EAAkB,EAMhCa,EAAc,QAOhBC,EAAW,EAUR,SAASC,EACdC,EACAC,EACA,CACA,IAAIC,EAA2B,IAAM,CAAC,EAEhCC,EAAe,IAAI,QAAeC,GAAY,CAClDF,EAAeE,CACjB,CAAC,EAEKC,EAAsBH,EAEtBI,EAAY,OAAOR,GAAU,EAG7BS,EAAiBC,EACrBP,EACArB,EAAkB,aACpB,EAIAgB,EAAY,YAAYU,EAAWN,CAAY,EAE/C,IAAMS,EAAWR,GAAS,SACpBS,EAAOD,IAAa,OAAYA,EAAW7B,EAAkB,SAE7D+B,EAAM,CAEV,aAAAR,EAEA,KAAAO,EAEA,YAAa,GACb,SAAU,GAGV,UAAUjB,EAAoC,CAC5C,OAAOG,EAAY,UAAUU,EAAW,IAAMb,EAAW,CAAC,CAC5D,EAGA,UAAoB,CAClB,MAAO,EAAQc,CACjB,EASA,MAAM,WAAWZ,EAAyB,CACxC,OAAO,MAAMY,GAAgB,IAAIV,EAAaF,CAAK,CACrD,EAMA,MAAM,cAAuC,CAC3C,OAAO,MAAMY,GAAgB,IAAIV,CAAW,CAC9C,EAQA,aAAiB,CACf,OAAOD,EAAY,IAAIU,CAAS,CAClC,EAGA,SAASjB,EAA+B,CACtC,GAAI,OAAOA,GAAS,WAAY,CAC9B,IAAMC,EAAOM,EAAY,IAAOU,CAAS,EACzCjB,EAAQA,EAAqBC,CAAI,CACnC,CAEAM,EAAY,IAAIU,EAAWjB,CAAI,EAC1BsB,EAAI,WAAWtB,CAAI,CAC1B,EAMA,QAAS,CACPO,EAAY,IAAIU,EAAWN,CAAY,EAClCO,GAAgB,IAAIV,EAAaG,CAAY,CACpD,EAGA,MAAM,sBAAuB,CAC3B,GAAIW,EAAI,UAAYA,EAAI,YAAa,OAErCA,EAAI,YAAc,GAElB,IAAMC,EAAS,MAAMD,EAAI,aAAa,EAChChB,EAAQiB,IAAW,OAAYA,EAASZ,EAE9CJ,EAAY,IAAIU,EAAWX,CAAK,EAGhCgB,EAAI,SAAW,GACfN,EAAoB,CACtB,CACF,EAEA,OAAKK,GACEC,EAAI,qBAAqB,EAGzBA,CACT,CAYO,SAASE,EACdC,EACkC,CAClC,OAAKA,EAAM,qBAAqB,EASzB,CAPOC,EACXC,GAAkBF,EAAM,UAAUE,CAAa,EAChD,IAAMF,EAAM,YAAY,EAExB,IAAMA,EAAM,YAAY,CAC1B,EAEeA,EAAM,QAAQ,CAC/B,CAUO,SAASG,EAAuBH,EAAuB,CAC5D,OAAOD,EAAeC,CAAK,EAAE,CAAC,CAChC,CAUO,SAASI,EAAwBJ,EAAuB,CAC7D,OAAKA,EAAM,qBAAqB,EAEzBA,EAAM,QACf","names":["MS_PER_DAY","useSyncExternalStore","kvStore","createLocalStore","IS_NOT_BROWSER","getStorageAdapter","options","defaultStoreExpiryMs","store","expiryMs","config","localStoreAdapter","kvStoreAdapter","key","isValid","adapter","value","keyPrefix","fullKey","SharedStateConfig","MS_PER_DAY","configureSharedState","config","createPubSubStore","dataByKey","subscribersByKey","notify","key","next","prev","subscribers","copy","subscriber","e","value","pubSubStore","STORAGE_KEY","stateKey","sharedState","defaultValue","options","readyResolve","readyPromise","resolve","resolveReadyPromise","pubSubKey","storageAdapter","getStorageAdapter","lazyLoad","lazy","obj","stored","useSharedState","state","useSyncExternalStore","onStoreChange","useSharedStateValue","useSharedStateSetter"]}