@choksheak/react-utils 0.2.6 → 0.2.8

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.
@@ -1 +1 @@
1
- {"version":3,"sources":["../src/sharedQuery.ts","../src/sharedState.ts","../src/utils/storage.ts","../src/utils/stringify.ts","../src/utils/useDeepMemo.ts"],"sourcesContent":["/**\n * The \"shared query\" is a data fetching convenience library that helps users\n * to load data, check for staleness and expiration, cache in memory, local\n * storage or indexed db, and be able to manipulate the data anytime.\n *\n * Each shared query creates a new private shared state that handles the data\n * storage. This shared state contains the records for all queries, where each\n * query is a unique set of arguments used to make the query. The number of\n * records and the total byte size of data can be limited so as to ensure the\n * query does not take up too much memory.\n *\n * @packageDocumentation\n */\n\nimport { MS_PER_DAY } from \"@choksheak/ts-utils/timeConstants\";\nimport getByteSize from \"object-sizeof\";\nimport { useCallback, useEffect, useMemo, useRef } from \"react\";\n\nimport {\n SharedState,\n sharedState,\n SharedStateOptions,\n useSharedState,\n} from \"./sharedState\";\nimport { stringifyDeterministicForKeys } from \"./utils/stringify\";\nimport { useDeepMemo } from \"./utils/useDeepMemo\";\n\nexport type QueryFn<TArgs extends unknown[], TData> = (\n ...args: TArgs\n) => Promise<TData> | TData;\n\nexport type QueryStateValue<TData> = {\n /**\n * When this record was last updated. Used for LRU determination. If you want\n * the data age, please use `dataUpdatedMs` instead.\n */\n lastUpdatedMs: number;\n\n loading: boolean;\n data?: TData;\n dataUpdatedMs?: number;\n\n /**\n * Use unknown type for error because we can't assume what type of variable\n * will be thrown from the query function. We also don't want to add this\n * type to QueryStateValue<TError> as it adds complexity to the type.\n */\n error?: unknown;\n\n errorUpdatedMs?: number;\n};\n\nexport type UseQueryResult<TData> = QueryStateValue<TData> & {\n /**\n * Cancels the inflight query (if any). Returns true if canceled.\n */\n abortCurrentQuery: (reason?: unknown) => boolean;\n\n /**\n * Manually refresh the data by doing a new query.\n */\n refetch: () => void;\n\n /**\n * If you got the data from somewhere else (e.g. an in-memory data update),\n * just set it directly.\n */\n setData: (data: TData, dataUpdatedMs?: number) => void;\n\n deleteData: () => void;\n};\n\nexport type PersistTo = \"localStorage\" | \"indexedDb\";\n\n/**\n * The full query state is a record of all the fetch states mapped by\n * query key to the state entry.\n */\nexport type SharedQueryState<TData> = Record<string, QueryStateValue<TData>>;\n\nexport type SharedQueryOptions<TArgs extends unknown[], TData> = {\n // The name could have been auto-generated, but we let the user give us a\n // human-readable name that can be identified quickly in the logs.\n queryName: string;\n\n // Function to fetch data.\n queryFn: QueryFn<TArgs, TData>;\n\n // ms before data considered stale; 0 means always stale.\n staleMs?: number;\n\n // ms before data is removed from cache; 0 means never expire.\n expiryMs?: number;\n\n // Trigger background re-fetch if stale.\n refetchOnStale?: boolean;\n\n // Shortcut to set the localStorageKey or indexedDbKey automatically from\n // queryName. This is important because it avoids requiring the user to\n // specify the same queryName twice everytime.\n persistTo?: PersistTo;\n\n // Max number of entries to keep. The oldest entries will be discarded.\n // The last record cannot be discarded. 0 means no limit.\n maxSize?: number;\n\n // Max number of bytes to keep. The oldest entries will be discarded.\n // The last record cannot be discarded. 0 means no limit.\n maxBytes?: number;\n\n // Customize the logger.\n log?: (...args: unknown[]) => void;\n} & SharedStateOptions<SharedQueryState<TData>>;\n\n/** Users can override these values globally. */\nexport const SharedQueryDefaults = {\n // Refetch on every page load.\n staleMs: 0,\n\n // Keep in cache for a long time.\n expiryMs: 30 * MS_PER_DAY,\n\n // Always refetch automatically if the data is stale.\n refetchOnStale: true,\n\n // No default persistence configured.\n persistTo: undefined as PersistTo | undefined,\n\n // 100 is not too large, but please tweak accordingly.\n maxSize: 100,\n\n // 100kb limit before discarding old records.\n maxBytes: 100_000,\n\n // Default to log to console.\n log: (...args: unknown[]) => console.log(\"[sharedQuery]\", ...args),\n};\n\nexport class SharedQuery<TArgs extends unknown[], TData> {\n private readonly inflightQueries = new Map<\n string,\n { promise: Promise<TData>; abortController: AbortController }\n >();\n\n public readonly queryState: SharedState<SharedQueryState<TData>>;\n\n public readonly queryName: string;\n private readonly queryFn: QueryFn<TArgs, TData>;\n public readonly expiryMs: number;\n public readonly staleMs: number;\n public readonly refetchOnStale: boolean;\n public readonly maxSize: number;\n public readonly maxBytes: number;\n public readonly log: (...args: unknown[]) => void;\n\n public constructor(options: SharedQueryOptions<TArgs, TData>) {\n this.queryName = options.queryName;\n this.queryFn = options.queryFn;\n\n this.staleMs = options?.staleMs ?? SharedQueryDefaults.staleMs;\n this.expiryMs = options?.expiryMs ?? SharedQueryDefaults.expiryMs;\n\n this.refetchOnStale =\n options?.refetchOnStale ?? SharedQueryDefaults.refetchOnStale;\n\n // Apply shortcut when using `persistTo`.\n // Specifying the storage keys will take precedence over `persistTo`.\n if (!options.localStorageKey && !options.indexedDbKey) {\n const persistTo = options.persistTo ?? SharedQueryDefaults.persistTo;\n\n if (persistTo === \"localStorage\") {\n options.localStorageKey = options.queryName;\n } else if (persistTo === \"indexedDb\") {\n options.indexedDbKey = options.queryName;\n }\n }\n\n this.maxSize = options?.maxSize ?? SharedQueryDefaults.maxSize;\n this.maxBytes = options?.maxBytes ?? SharedQueryDefaults.maxBytes;\n\n this.log = options?.log ?? SharedQueryDefaults.log;\n\n this.queryState = sharedState<SharedQueryState<TData>>(\n {}, // defaultValue\n {\n ...options,\n // Fallback to use expiryMs for the storeExpiryMs.\n storeExpiryMs: options?.storeExpiryMs || this.expiryMs,\n },\n );\n }\n\n /** Returns a key to identify requests based on the given args. */\n public getQueryKey(args: TArgs): string {\n return this.queryName + \":\" + stringifyDeterministicForKeys(args);\n }\n\n /**\n * Get the AbortController to abort the inflight query (if any).\n *\n * Note that once you get the controller, you can also get the signal easily\n * using `controller.signal`. So if you need both the controller and the\n * signal, just use this function.\n */\n public getAbortController(args: TArgs): AbortController | null {\n const queryKey = this.getQueryKey(args);\n return this.getAbortControllerByKey(queryKey);\n }\n\n public getAbortControllerByKey(queryKey: string): AbortController | null {\n return this.inflightQueries.get(queryKey)?.abortController ?? null;\n }\n\n /**\n * Get the AbortSignal to check for query abortions.\n *\n * Example:\n * ```\n * const getUserQuery = sharedQuery({\n * queryName: \"getUser\",\n * queryFn: (userId: string) => {\n * // Get the signal for this current execution.\n * const signal = getUserQuery.getAbortSignal([userId]);\n *\n * // Pass the signal to fetch so that it can be aborted.\n * const response = await fetch(`/users/${userId}`, { signal });\n *\n * // Check for errors.\n * if (!response.ok) {\n * throw new Error(response.statusText);\n * }\n *\n * // Return the data.\n * return await response.json();\n * },\n * });\n * ```\n */\n public getAbortSignal(args: TArgs): AbortSignal | null {\n const queryKey = this.getQueryKey(args);\n return this.getAbortSignalByKey(queryKey);\n }\n\n public getAbortSignalByKey(queryKey: string): AbortSignal | null {\n return this.getAbortControllerByKey(queryKey)?.signal ?? null;\n }\n\n private isStale(dataUpdatedMs: number): boolean {\n if (this.staleMs === 0) return true; // always stale\n\n const ageMs = Date.now() - dataUpdatedMs;\n return ageMs > this.staleMs;\n }\n\n private isExpired(dataUpdatedMs: number): boolean {\n if (this.expiryMs === 0) return false; // never expire\n\n const ageMs = Date.now() - dataUpdatedMs;\n return ageMs > this.expiryMs;\n }\n\n public async getCachedOrFetch(...args: TArgs): Promise<TData> {\n const queryKey = this.getQueryKey(args);\n const cached = this.queryState.getSnapshot()?.[queryKey];\n\n if (cached?.data && !this.isExpired(cached.dataUpdatedMs ?? 0)) {\n // Return cached value if not stale.\n if (!this.isStale(cached.dataUpdatedMs ?? 0)) {\n this.log(`Return fresh data ${queryKey} from cache without fetching`);\n return cached.data;\n }\n\n // If stale, optionally update the data in the background.\n if (this.refetchOnStale) {\n this.log(`refetchOnStale for ${queryKey}`);\n void this.dedupedFetch(queryKey, ...args);\n }\n\n // Still return stale data immediately.\n this.log(`Returning stale data for ${queryKey}`);\n return cached.data;\n }\n\n return await this.dedupedFetch(queryKey, ...args);\n }\n\n private dedupedFetch(queryKey: string, ...args: TArgs): Promise<TData> {\n const inflightQuery = this.inflightQueries.get(queryKey);\n\n // De-duplicate in-flight requests\n if (inflightQuery) {\n this.log(`Deduplicating inflight fetch for ${queryKey}`);\n return inflightQuery.promise;\n }\n\n // Fetch new data\n const promise = this.startFetching(queryKey, args);\n const abortController = new AbortController();\n\n this.inflightQueries.set(queryKey, { promise, abortController });\n\n return promise;\n }\n\n private async startFetching(queryKey: string, args: TArgs) {\n this.log(`Start fetching ${queryKey}`);\n\n try {\n const data = await this.queryFn(...args);\n\n this.log(`Successfully fetched ${queryKey}`);\n this.setData(queryKey, data, Date.now());\n return data;\n } catch (e) {\n this.log(`Failed to fetch ${queryKey}: ${e}`);\n throw e;\n } finally {\n this.inflightQueries.delete(queryKey);\n }\n }\n\n /** Get the entire stored entry for a query key. */\n public getQueryValue(queryKey: string): QueryStateValue<TData> | undefined {\n return this.queryState.getSnapshot()?.[queryKey];\n }\n\n /** Get the current stored data for a query key. */\n public getData(queryKey: string): TData | undefined {\n return this.queryState.getSnapshot()?.[queryKey]?.data;\n }\n\n /** Set the data directly if the user obtained it from somewhere else. */\n public setData(\n queryKey: string,\n data: TData,\n dataUpdatedMs = Date.now(),\n ): void {\n const entry: QueryStateValue<TData> = {\n lastUpdatedMs: Date.now(),\n loading: false,\n data,\n dataUpdatedMs,\n };\n\n this.queryState.setValue((prev) => ({ ...prev, [queryKey]: entry }));\n\n this.enforceSizeLimit();\n }\n\n /**\n * Do a new fetch even when the data is already cached, but don't fetch if\n * another fetch is already inflight.\n */\n public async updateFromSource(...args: TArgs): Promise<TData> {\n const key = this.getQueryKey(args);\n return await this.dedupedFetch(key, ...args);\n }\n\n /** Delete the cached data for one set of arguments. */\n public deleteData(queryKey: string): void {\n const record = this.queryState.getSnapshot();\n const clone = { ...record };\n delete clone[queryKey];\n this.queryState.setValue(clone);\n\n const inflight = this.inflightQueries.get(queryKey);\n if (inflight) {\n this.inflightQueries.delete(queryKey);\n inflight.abortController.abort(\"Deleted\");\n }\n }\n\n /** Delete all currently cached data & all inflight promises. */\n public clear(): void {\n this.queryState.delete();\n\n for (const { abortController } of Array.from(\n this.inflightQueries.values(),\n )) {\n abortController.abort(\"Cleared\");\n }\n\n this.inflightQueries.clear();\n }\n\n /**\n * Discard the oldest entries if the size exceeds the limit. The last\n * remaining record cannot be deleted no matter what the limit is.\n */\n public enforceSizeLimit(): void {\n // Skip if there are no limits.\n if (!this.maxSize && !this.maxBytes) {\n return;\n }\n\n const oldState = this.queryState.getSnapshot();\n const oldSize = Object.keys(oldState).length;\n\n // Cannot do GC if size is 1 or less.\n if (oldSize <= 1) {\n return;\n }\n\n const oldByteSize = getByteSize(oldState);\n\n let newState = oldState;\n let needUpdate = false;\n\n // Limit by number of records.\n if (this.maxSize) {\n const numToCut = oldSize - this.maxSize;\n\n if (numToCut > 0) {\n this.log(\n `enforceSizeLimit for ${this.queryName} needed due to size ${oldSize} > ${this.maxSize}`,\n );\n\n newState = { ...newState }; // shallow clone\n needUpdate = true;\n\n Object.entries(newState)\n .sort(\n (entry1, entry2) =>\n // Sort descending.\n entry2[1].lastUpdatedMs - entry1[1].lastUpdatedMs,\n )\n .slice(-numToCut)\n .forEach(([key]) => {\n delete newState[key];\n });\n }\n }\n\n // Limit by byte size.\n if (this.maxBytes && Object.keys(newState).length > 1) {\n // Recompute only if changed by above code.\n const currentByteSize = needUpdate ? getByteSize(newState) : oldByteSize;\n\n let bytesToCut = currentByteSize - this.maxBytes;\n\n if (bytesToCut > 0) {\n this.log(\n `enforceSizeLimit for ${this.queryName} needed due to byte size ${currentByteSize.toLocaleString()} > ${this.maxBytes.toLocaleString()}`,\n );\n\n // Shallow clone only if not already cloned above.\n if (!needUpdate) {\n newState = { ...newState };\n needUpdate = true;\n }\n\n const entriesByTimeAscending = Object.entries(newState).sort(\n (entry1, entry2) => entry1[1].lastUpdatedMs - entry2[1].lastUpdatedMs,\n );\n\n for (\n let i = 0;\n // Leave the last record entriesByTimeAscending[len-1] untouched.\n i < entriesByTimeAscending.length - 1 && bytesToCut > 0;\n i++\n ) {\n const key = entriesByTimeAscending[i][0];\n const thisSize = getByteSize(key) + getByteSize(newState[key]);\n delete newState[key];\n bytesToCut -= thisSize;\n }\n }\n }\n\n // Update the state.\n if (needUpdate) {\n this.queryState.setValue(newState);\n\n // Log to inform user that the data was trimmed.\n this.log(\n `Trimmed data for ${this.queryName}: size=(${oldSize} -> ${Object.keys(newState).length}) (limit=${this.maxSize}), byteSize=(${oldByteSize.toLocaleString()} -> ${getByteSize(newState).toLocaleString()}) (limit=${this.maxBytes.toLocaleString()})`,\n );\n\n return;\n }\n\n // Log to indicate why trimming was not needed.\n this.log(\n `No need to trim data for ${this.queryName}: size=${oldSize} (limit=${this.maxSize}), byteSize=${oldByteSize.toLocaleString()} (limit=${this.maxBytes.toLocaleString()})`,\n );\n }\n}\n\nconst seenQueryNames = new Set<string>();\n\n/**\n * Create a reusable shared query object that can be used to auto de-duplicate\n * and cache all data fetches, with auto-expiration and staleness checks.\n *\n * Each `queryName` must be unique, and can only be declared once, most often\n * in the top level scope. The queryName is used for logging only.\n *\n * Example:\n * ```\n * export const usersQuery = sharedQuery({\n * queryName: \"users\",\n * queryFn: listUsers,\n * persistTo: \"indexedDb\",\n * staleMs: MS_PER_DAY,\n * });\n * ```\n */\nexport function sharedQuery<TArgs extends unknown[], TData>(\n // The name could have been auto-generated, but we let the user give us a\n // human-readable name that can be identified quickly in the logs.\n options: SharedQueryOptions<TArgs, TData>,\n): SharedQuery<TArgs, TData> {\n if (seenQueryNames.has(options.queryName)) {\n throw new Error(`Duplicate shared query \"${options.queryName}\"`);\n }\n seenQueryNames.add(options.queryName);\n\n return new SharedQuery(options);\n}\n\nconst DEFAULT_QUERY_STATE_ENTRY: QueryStateValue<unknown> = {\n lastUpdatedMs: 0,\n loading: true,\n};\n\n/**\n * React hook to make use of a shared query inside any React component.\n *\n * Example:\n * ```\n * const users = useSharedQuery(usersQuery, [\"123\"]);\n * ```\n */\nexport function useSharedQuery<TArgs extends unknown[], TData>(\n query: SharedQuery<TArgs, TData>,\n // Default to use no arguments.\n args: TArgs = [] as unknown as TArgs,\n): UseQueryResult<TData> {\n // We don't expect users to provide a stable `args`, so stabilize it here.\n const stableArgs = useDeepMemo(args);\n\n const [queryState, setQueryState] = useSharedState(query.queryState);\n\n const isMounted = useRef(true);\n\n const queryKey = useMemo(\n () => query.getQueryKey(stableArgs),\n [query, stableArgs],\n );\n\n // Make sure typechecker knows this could be undefined.\n const queryStateValue = queryState[queryKey] as\n | QueryStateValue<TData>\n | undefined;\n\n const setQueryStateValue = useCallback(\n (\n arg:\n | QueryStateValue<TData>\n | ((\n prev: QueryStateValue<TData> | undefined,\n ) => QueryStateValue<TData>),\n ) => {\n setQueryState((prev) => {\n const clone = { ...prev };\n clone[queryKey] =\n typeof arg === \"function\" ? arg(clone[queryKey]) : arg;\n return clone;\n });\n },\n [queryKey, setQueryState],\n );\n\n // The fetch logic wrapped in useCallback to be stable for useEffect\n const execute = useCallback(\n async (forceRefresh: boolean) => {\n query.log(`Begin executing shared query ${queryKey}`);\n\n setQueryStateValue((prev) => ({\n // Keep old data and error.\n ...(prev ?? {}),\n lastUpdatedMs: Date.now(),\n loading: true,\n }));\n\n try {\n const data = await (forceRefresh\n ? query.updateFromSource(...stableArgs)\n : query.getCachedOrFetch(...stableArgs));\n\n if (isMounted.current) {\n const now = Date.now();\n\n setQueryStateValue({\n // Don't keep old error.\n lastUpdatedMs: now,\n loading: false,\n data,\n dataUpdatedMs: now,\n });\n }\n } catch (e) {\n if (isMounted.current) {\n const now = Date.now();\n\n setQueryStateValue((prev) => ({\n // Keep old data.\n ...(prev ?? {}),\n lastUpdatedMs: now,\n loading: false,\n error: e,\n errorUpdatedMs: now,\n }));\n }\n }\n },\n [query, queryKey, setQueryStateValue, stableArgs],\n );\n\n useEffect(() => {\n isMounted.current = true;\n\n void execute(false);\n\n return () => {\n isMounted.current = false;\n };\n }, [execute]);\n\n return useMemo(() => {\n const state =\n queryStateValue ?? (DEFAULT_QUERY_STATE_ENTRY as QueryStateValue<TData>);\n\n return {\n ...state,\n // This works only if the user-given queryFn supports abort. If not,\n // this function doesn't do anything, since we don't have any means to\n // abort the running queryFn.\n abortCurrentQuery: (reason?: unknown) => {\n const controller = query.getAbortControllerByKey(queryKey);\n controller?.abort(reason);\n return Boolean(controller);\n },\n refetch: () => {\n void execute(true);\n },\n setData: (data: TData, dataUpdatedMs?: number) => {\n const now = Date.now();\n setQueryStateValue((prev) => ({\n ...(prev ?? {}),\n data,\n dataUpdatedMs: dataUpdatedMs ?? now,\n lastUpdatedMs: now,\n loading: false,\n }));\n },\n deleteData: () => {\n setQueryState((prev) => {\n const clone = { ...prev };\n delete clone[queryKey];\n return clone;\n });\n },\n };\n }, [\n execute,\n query,\n queryKey,\n queryStateValue,\n setQueryState,\n setQueryStateValue,\n ]);\n}\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 * @packageDocumentation\n */\n\nimport { MS_PER_DAY } from \"@choksheak/ts-utils/timeConstants\";\nimport { useSyncExternalStore } from \"react\";\n\nimport {\n getStorageAdapter,\n StorageAdapter,\n StorageOptions,\n} from \"./utils/storage\";\n\n/************************************************************************/\n/* Global config */\n/************************************************************************/\n\n/**\n * These values are configurable by the user at any time.\n */\nexport const SharedStateDefaults = {\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\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\nexport type SharedStateOptions<T> = {\n lazyLoad?: boolean;\n} & StorageOptions<T>;\n\nlet stateKey = 0;\n\nexport class SharedState<T> {\n private readonly pubSubKey: string;\n private readonly storageAdapter: StorageAdapter<T> | null;\n public readonly setValueBounded: (next: T | ((prev: T) => T)) => void;\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 SharedStateDefaults.storeExpiryMs,\n );\n\n // Same as this.setValue, but binding the `this` reference.\n this.setValueBounded = (arg) => this.setValue(arg);\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 =\n lazyLoad !== undefined ? lazyLoad : SharedStateDefaults.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 // Get the value of the shared state.\n // `getSnapshot` function — must return same ref if value unchanged\n public getSnapshot(): T {\n return pubSubStore.get(this.pubSubKey);\n }\n\n // Set the value of the shared state.\n public setValue(next: T | ((prev: T) => 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.storageAdapter?.save(STORAGE_KEY, next);\n }\n\n // Remove the value of the shared state. Actually this just sets the value\n // back to the given default value.\n public delete() {\n pubSubStore.set(this.pubSubKey, this.defaultValue);\n void this.storageAdapter?.save(STORAGE_KEY, this.defaultValue);\n }\n\n // Initial default handling\n public async initDefaultValueOnce() {\n if (this.initDone) return;\n this.initDone = true;\n\n const v = await this.storageAdapter?.load(STORAGE_KEY);\n pubSubStore.set(this.pubSubKey, v !== undefined ? v : this.defaultValue);\n }\n}\n\n/**\n * Create a new shared state object. Put this code at the top level scope:\n *\n * const myState = sharedState<number>(0);\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 * const [my, setMy] = useSharedState(myState);\n */\nexport function useSharedState<T>(\n state: SharedState<T>,\n): [T, (next: T | ((prev: T) => T)) => void] {\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/** E.g. const my = useSharedStateValue(myState) */\nexport function useSharedStateValue<T>(state: SharedState<T>) {\n return useSharedState(state)[0];\n}\n\n/** E.g. const setMy = useSharedStateSetter(myState) */\nexport function useSharedStateSetter<T>(state: SharedState<T>) {\n return useSharedState(state)[1];\n}\n","import { kvStore } from \"@choksheak/ts-utils/kvStore\";\n\nexport type StorageAdapter<T> = {\n save: (key: string, value: T) => Promise<void> | void;\n load: (key: string) => Promise<T | undefined> | T | undefined;\n delete: (key: string) => Promise<void> | void;\n clear: () => Promise<void> | void;\n};\n\nexport type StorageOptions<T> = {\n // If specified, this will be used and all other fields will be ignored.\n store?: StorageAdapter<T>;\n\n // Storage key in local storage for this data.\n localStorageKey?: string;\n\n // Storage key in indexed db for this data.\n indexedDbKey?: string;\n\n // How long to wait before the value is considered expired.\n storeExpiryMs?: number;\n};\n\nexport function getStorageAdapter<T>(\n options: StorageOptions<T> | undefined,\n defaultStoreExpiryMs: number,\n): StorageAdapter<T> | null {\n const { localStorageKey, indexedDbKey, storeExpiryMs, store } = options ?? {};\n\n if (store) {\n return store;\n }\n\n const expiryMs = storeExpiryMs || defaultStoreExpiryMs;\n\n if (localStorageKey) {\n return new LocalStorageAdapter<T>(localStorageKey, expiryMs);\n }\n\n if (indexedDbKey) {\n return new IndexedDbAdapter<T>(indexedDbKey, expiryMs);\n }\n\n return null;\n}\n\n/************************************************************************/\n/* Storage adapters */\n/************************************************************************/\n\ntype ValueWithExpiration<T> = { value: T; expiresAt: number };\n\n/** Save state to memory only - not persisted. */\nexport class InMemoryStorageAdapter<T> implements StorageAdapter<T> {\n private readonly cache = new Map<string, ValueWithExpiration<T>>();\n\n public constructor(\n public readonly keyPrefix: string,\n public readonly expiryMs: number,\n ) {}\n\n public save(key: string, value: T): void {\n const fullKey = this.keyPrefix + \":\" + key;\n this.cache.set(fullKey, {\n value,\n expiresAt: Date.now() + this.expiryMs,\n });\n }\n\n public load(key: string): T | undefined {\n const fullKey = this.keyPrefix + \":\" + key;\n const cached = this.cache.get(fullKey);\n\n if (cached && Date.now() < cached.expiresAt) {\n return cached.value;\n }\n\n return undefined;\n }\n\n public delete(key: string): void {\n const fullKey = this.keyPrefix + \":\" + key;\n this.cache.delete(fullKey);\n }\n\n public clear(): void {\n this.cache.clear();\n }\n}\n\n/** Save state to local storage. */\nexport class LocalStorageAdapter<T> implements StorageAdapter<T> {\n public constructor(\n public readonly keyPrefix: string,\n public readonly expiryMs: number,\n ) {}\n\n public save(key: string, value: T): void {\n if (typeof window === \"undefined\") return;\n\n const fullKey = this.keyPrefix + \":\" + key;\n window.localStorage.setItem(\n fullKey,\n JSON.stringify({\n value,\n expiresAt: this.expiryMs ? Date.now() + this.expiryMs : 0,\n } satisfies ValueWithExpiration<T>),\n );\n }\n\n public load(key: string): T | undefined {\n if (typeof window === \"undefined\") return undefined;\n\n const fullKey = this.keyPrefix + \":\" + key;\n const raw = window.localStorage.getItem(fullKey);\n if (!raw) return undefined;\n\n try {\n const box = JSON.parse(raw) as ValueWithExpiration<T>;\n if (!box || (box.expiresAt && Date.now() >= box.expiresAt)) {\n window.localStorage.removeItem(fullKey);\n return undefined;\n }\n\n return box.value;\n } catch {\n // Ignore error.\n window.localStorage.removeItem(fullKey);\n return undefined;\n }\n }\n\n public delete(key: string): void {\n if (typeof window === \"undefined\") return;\n\n const fullKey = this.keyPrefix + \":\" + key;\n window.localStorage.removeItem(fullKey);\n }\n\n public clear(): void {\n if (typeof window === \"undefined\") return;\n\n for (const key of Object.keys(window.localStorage)) {\n if (key.startsWith(this.keyPrefix)) {\n window.localStorage.removeItem(key);\n }\n }\n }\n}\n\n/** Save state to indexed db. */\nexport class IndexedDbAdapter<T> implements StorageAdapter<T> {\n public constructor(\n public readonly keyPrefix: string,\n public readonly expiryMs: number,\n ) {}\n\n public async save(key: string, value: T): Promise<void> {\n if (typeof window === \"undefined\") return;\n\n const fullKey = this.keyPrefix + \":\" + key;\n await kvStore.set(fullKey, JSON.stringify(value), this.expiryMs);\n }\n\n public async load(key: string): Promise<T | undefined> {\n if (typeof window === \"undefined\") return undefined;\n\n const fullKey = this.keyPrefix + \":\" + key;\n const raw = await kvStore.get<string>(fullKey);\n if (raw === undefined) return undefined;\n\n try {\n return JSON.parse(raw);\n } catch {\n // Ignore error.\n await kvStore.delete(fullKey);\n return undefined;\n }\n }\n\n public async delete(key: string): Promise<void> {\n if (typeof window === \"undefined\") return;\n\n const fullKey = this.keyPrefix + \":\" + key;\n await kvStore.delete(fullKey);\n }\n\n public async clear(): Promise<void> {\n if (typeof window === \"undefined\") return;\n\n await kvStore.forEach(async (k) => {\n if (k.startsWith(this.keyPrefix)) {\n await kvStore.delete(k);\n }\n });\n }\n}\n","/**\n * JSON stringify a value of any type, and returns an unsafe string. The string\n * is \"unsafe\" because you might not be able to restore the original object\n * using the serialized JSON. This is specifically used for query key generation\n * and is not suitable for more general uses.\n *\n * Note: The given value should not contain any functions because functions\n * cannot be serialized and deserialized properly.\n */\nexport function stringifyDeterministicForKeys(params: unknown): string {\n const cache = new Set();\n\n return JSON.stringify(params, (_, value) => {\n if (typeof value === \"function\") {\n throw new Error(`Functions should not be passed into query parameters`);\n }\n\n if (!value || typeof value !== \"object\" || Array.isArray(value)) {\n return value;\n }\n\n if (cache.has(value)) {\n // Circular reference detected! Return a placeholder string.\n return \"[Circular]\";\n }\n\n cache.add(value);\n\n // Don't crash on circular references, but don't mark the top level object\n // as circular because we want to return as much string as possible.\n if (value !== params) {\n try {\n JSON.stringify(value);\n } catch {\n return \"[Unserializable]\";\n }\n }\n\n return Object.keys(value)\n .sort()\n .reduce(\n (result: Record<string, unknown>, key: string) => {\n result[key] = value[key];\n return result;\n },\n {} as Record<string, unknown>,\n );\n });\n}\n","import isEqual from \"lodash/isEqual\";\nimport { useMemo, useState } from \"react\";\n\n/** Provides a stable value for T based on deep equality. */\nexport function useDeepMemo<T>(value: T): T {\n const [state, setState] = useState<T>(value);\n\n return useMemo(() => {\n if (state === value || isEqual(state, value)) {\n return state;\n }\n\n // We check equality, so this should be safe.\n // eslint-disable-next-line react-hooks/set-state-in-render\n setState(value);\n\n return value;\n }, [state, value]);\n}\n"],"mappings":"AAcA,OAAS,cAAAA,MAAkB,oCAC3B,OAAOC,MAAiB,gBACxB,OAAS,eAAAC,EAAa,aAAAC,EAAW,WAAAC,EAAS,UAAAC,MAAc,QCHxD,OAAS,cAAAC,MAAkB,oCAC3B,OAAS,wBAAAC,MAA4B,QCdrC,OAAS,WAAAC,MAAe,8BAuBjB,SAASC,EACdC,EACAC,EAC0B,CAC1B,GAAM,CAAE,gBAAAC,EAAiB,aAAAC,EAAc,cAAAC,EAAe,MAAAC,CAAM,EAAIL,GAAW,CAAC,EAE5E,GAAIK,EACF,OAAOA,EAGT,IAAMC,EAAWF,GAAiBH,EAElC,OAAIC,EACK,IAAIK,EAAuBL,EAAiBI,CAAQ,EAGzDH,EACK,IAAIK,EAAoBL,EAAcG,CAAQ,EAGhD,IACT,CA+CO,IAAMG,EAAN,KAA0D,CACxD,YACWC,EACAC,EAChB,CAFgB,eAAAD,EACA,cAAAC,CACf,CAEI,KAAKC,EAAaC,EAAgB,CACvC,GAAI,OAAO,OAAW,IAAa,OAEnC,IAAMC,EAAU,KAAK,UAAY,IAAMF,EACvC,OAAO,aAAa,QAClBE,EACA,KAAK,UAAU,CACb,MAAAD,EACA,UAAW,KAAK,SAAW,KAAK,IAAI,EAAI,KAAK,SAAW,CAC1D,CAAkC,CACpC,CACF,CAEO,KAAKD,EAA4B,CACtC,GAAI,OAAO,OAAW,IAAa,OAEnC,IAAME,EAAU,KAAK,UAAY,IAAMF,EACjCG,EAAM,OAAO,aAAa,QAAQD,CAAO,EAC/C,GAAKC,EAEL,GAAI,CACF,IAAMC,EAAM,KAAK,MAAMD,CAAG,EAC1B,GAAI,CAACC,GAAQA,EAAI,WAAa,KAAK,IAAI,GAAKA,EAAI,UAAY,CAC1D,OAAO,aAAa,WAAWF,CAAO,EACtC,MACF,CAEA,OAAOE,EAAI,KACb,MAAQ,CAEN,OAAO,aAAa,WAAWF,CAAO,EACtC,MACF,CACF,CAEO,OAAOF,EAAmB,CAC/B,GAAI,OAAO,OAAW,IAAa,OAEnC,IAAME,EAAU,KAAK,UAAY,IAAMF,EACvC,OAAO,aAAa,WAAWE,CAAO,CACxC,CAEO,OAAc,CACnB,GAAI,SAAO,OAAW,KAEtB,QAAWF,KAAO,OAAO,KAAK,OAAO,YAAY,EAC3CA,EAAI,WAAW,KAAK,SAAS,GAC/B,OAAO,aAAa,WAAWA,CAAG,CAGxC,CACF,EAGaK,EAAN,KAAuD,CACrD,YACWP,EACAC,EAChB,CAFgB,eAAAD,EACA,cAAAC,CACf,CAEH,MAAa,KAAKC,EAAaC,EAAyB,CACtD,GAAI,OAAO,OAAW,IAAa,OAEnC,IAAMC,EAAU,KAAK,UAAY,IAAMF,EACvC,MAAMM,EAAQ,IAAIJ,EAAS,KAAK,UAAUD,CAAK,EAAG,KAAK,QAAQ,CACjE,CAEA,MAAa,KAAKD,EAAqC,CACrD,GAAI,OAAO,OAAW,IAAa,OAEnC,IAAME,EAAU,KAAK,UAAY,IAAMF,EACjCG,EAAM,MAAMG,EAAQ,IAAYJ,CAAO,EAC7C,GAAIC,IAAQ,OAEZ,GAAI,CACF,OAAO,KAAK,MAAMA,CAAG,CACvB,MAAQ,CAEN,MAAMG,EAAQ,OAAOJ,CAAO,EAC5B,MACF,CACF,CAEA,MAAa,OAAOF,EAA4B,CAC9C,GAAI,OAAO,OAAW,IAAa,OAEnC,IAAME,EAAU,KAAK,UAAY,IAAMF,EACvC,MAAMM,EAAQ,OAAOJ,CAAO,CAC9B,CAEA,MAAa,OAAuB,CAC9B,OAAO,OAAW,KAEtB,MAAMI,EAAQ,QAAQ,MAAOC,GAAM,CAC7BA,EAAE,WAAW,KAAK,SAAS,GAC7B,MAAMD,EAAQ,OAAOC,CAAC,CAE1B,CAAC,CACH,CACF,EDvKO,IAAMC,EAAsB,CAKjC,cAAe,GAAKC,EAMpB,SAAU,EACZ,EAQMC,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,QAMhBC,EAAW,EAEFC,EAAN,KAAqB,CAMnB,YACYC,EACjBC,EACA,CAFiB,kBAAAD,EAGjB,KAAK,UAAY,OAAOF,GAAU,EAGlC,KAAK,eAAiBI,EACpBD,EACAhB,EAAoB,aACtB,EAGA,KAAK,gBAAmBkB,GAAQ,KAAK,SAASA,CAAG,EAIjDP,EAAY,YAAY,KAAK,UAAWI,CAAY,EAEpD,IAAMI,EAAWH,GAAS,UAExBG,IAAa,OAAYA,EAAWnB,EAAoB,WAGnD,KAAK,qBAAqB,CAEnC,CA/BiB,UACA,eACD,gBACT,SAAW,GA+BX,UAAUM,EAAoC,CACnD,OAAOK,EAAY,UAAU,KAAK,UAAW,IAAML,EAAW,CAAC,CACjE,CAIO,aAAiB,CACtB,OAAOK,EAAY,IAAI,KAAK,SAAS,CACvC,CAGO,SAASH,EAAkC,CAChD,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,gBAAgB,KAAKI,EAAaJ,CAAI,CAClD,CAIO,QAAS,CACdG,EAAY,IAAI,KAAK,UAAW,KAAK,YAAY,EAC5C,KAAK,gBAAgB,KAAKC,EAAa,KAAK,YAAY,CAC/D,CAGA,MAAa,sBAAuB,CAClC,GAAI,KAAK,SAAU,OACnB,KAAK,SAAW,GAEhB,IAAMQ,EAAI,MAAM,KAAK,gBAAgB,KAAKR,CAAW,EACrDD,EAAY,IAAI,KAAK,UAAWS,IAAM,OAAYA,EAAI,KAAK,YAAY,CACzE,CACF,EAOO,SAASC,EACdN,EACAC,EACgB,CAChB,OAAO,IAAIF,EAAYC,EAAcC,CAAO,CAC9C,CAMO,SAASM,EACdC,EAC2C,CAC3C,OAAAA,EAAM,qBAAqB,EASpB,CAPOC,EACXC,GAAkBF,EAAM,UAAUE,CAAa,EAChD,IAAMF,EAAM,YAAY,EAExB,IAAMA,EAAM,YAAY,CAC1B,EAEeA,EAAM,eAAe,CACtC,CEtNO,SAASG,EAA8BC,EAAyB,CACrE,IAAMC,EAAQ,IAAI,IAElB,OAAO,KAAK,UAAUD,EAAQ,CAACE,EAAGC,IAAU,CAC1C,GAAI,OAAOA,GAAU,WACnB,MAAM,IAAI,MAAM,sDAAsD,EAGxE,GAAI,CAACA,GAAS,OAAOA,GAAU,UAAY,MAAM,QAAQA,CAAK,EAC5D,OAAOA,EAGT,GAAIF,EAAM,IAAIE,CAAK,EAEjB,MAAO,aAOT,GAJAF,EAAM,IAAIE,CAAK,EAIXA,IAAUH,EACZ,GAAI,CACF,KAAK,UAAUG,CAAK,CACtB,MAAQ,CACN,MAAO,kBACT,CAGF,OAAO,OAAO,KAAKA,CAAK,EACrB,KAAK,EACL,OACC,CAACC,EAAiCC,KAChCD,EAAOC,CAAG,EAAIF,EAAME,CAAG,EAChBD,GAET,CAAC,CACH,CACJ,CAAC,CACH,CChDA,OAAOE,MAAa,iBACpB,OAAS,WAAAC,EAAS,YAAAC,MAAgB,QAG3B,SAASC,EAAeC,EAAa,CAC1C,GAAM,CAACC,EAAOC,CAAQ,EAAIJ,EAAYE,CAAK,EAE3C,OAAOH,EAAQ,IACTI,IAAUD,GAASJ,EAAQK,EAAOD,CAAK,EAClCC,GAKTC,EAASF,CAAK,EAEPA,GACN,CAACC,EAAOD,CAAK,CAAC,CACnB,CJiGO,IAAMG,EAAsB,CAEjC,QAAS,EAGT,SAAU,GAAKC,EAGf,eAAgB,GAGhB,UAAW,OAGX,QAAS,IAGT,SAAU,IAGV,IAAK,IAAIC,IAAoB,QAAQ,IAAI,gBAAiB,GAAGA,CAAI,CACnE,EAEaC,EAAN,KAAkD,CACtC,gBAAkB,IAAI,IAKvB,WAEA,UACC,QACD,SACA,QACA,eACA,QACA,SACA,IAET,YAAYC,EAA2C,CAY5D,GAXA,KAAK,UAAYA,EAAQ,UACzB,KAAK,QAAUA,EAAQ,QAEvB,KAAK,QAAUA,GAAS,SAAWJ,EAAoB,QACvD,KAAK,SAAWI,GAAS,UAAYJ,EAAoB,SAEzD,KAAK,eACHI,GAAS,gBAAkBJ,EAAoB,eAI7C,CAACI,EAAQ,iBAAmB,CAACA,EAAQ,aAAc,CACrD,IAAMC,EAAYD,EAAQ,WAAaJ,EAAoB,UAEvDK,IAAc,eAChBD,EAAQ,gBAAkBA,EAAQ,UACzBC,IAAc,cACvBD,EAAQ,aAAeA,EAAQ,UAEnC,CAEA,KAAK,QAAUA,GAAS,SAAWJ,EAAoB,QACvD,KAAK,SAAWI,GAAS,UAAYJ,EAAoB,SAEzD,KAAK,IAAMI,GAAS,KAAOJ,EAAoB,IAE/C,KAAK,WAAaM,EAChB,CAAC,EACD,CACE,GAAGF,EAEH,cAAeA,GAAS,eAAiB,KAAK,QAChD,CACF,CACF,CAGO,YAAYF,EAAqB,CACtC,OAAO,KAAK,UAAY,IAAMK,EAA8BL,CAAI,CAClE,CASO,mBAAmBA,EAAqC,CAC7D,IAAMM,EAAW,KAAK,YAAYN,CAAI,EACtC,OAAO,KAAK,wBAAwBM,CAAQ,CAC9C,CAEO,wBAAwBA,EAA0C,CACvE,OAAO,KAAK,gBAAgB,IAAIA,CAAQ,GAAG,iBAAmB,IAChE,CA2BO,eAAeN,EAAiC,CACrD,IAAMM,EAAW,KAAK,YAAYN,CAAI,EACtC,OAAO,KAAK,oBAAoBM,CAAQ,CAC1C,CAEO,oBAAoBA,EAAsC,CAC/D,OAAO,KAAK,wBAAwBA,CAAQ,GAAG,QAAU,IAC3D,CAEQ,QAAQC,EAAgC,CAC9C,OAAI,KAAK,UAAY,EAAU,GAEjB,KAAK,IAAI,EAAIA,EACZ,KAAK,OACtB,CAEQ,UAAUA,EAAgC,CAChD,OAAI,KAAK,WAAa,EAAU,GAElB,KAAK,IAAI,EAAIA,EACZ,KAAK,QACtB,CAEA,MAAa,oBAAoBP,EAA6B,CAC5D,IAAMM,EAAW,KAAK,YAAYN,CAAI,EAChCQ,EAAS,KAAK,WAAW,YAAY,IAAIF,CAAQ,EAEvD,OAAIE,GAAQ,MAAQ,CAAC,KAAK,UAAUA,EAAO,eAAiB,CAAC,EAEtD,KAAK,QAAQA,EAAO,eAAiB,CAAC,GAMvC,KAAK,iBACP,KAAK,IAAI,sBAAsBF,CAAQ,EAAE,EACpC,KAAK,aAAaA,EAAU,GAAGN,CAAI,GAI1C,KAAK,IAAI,4BAA4BM,CAAQ,EAAE,EACxCE,EAAO,OAZZ,KAAK,IAAI,qBAAqBF,CAAQ,8BAA8B,EAC7DE,EAAO,MAcX,MAAM,KAAK,aAAaF,EAAU,GAAGN,CAAI,CAClD,CAEQ,aAAaM,KAAqBN,EAA6B,CACrE,IAAMS,EAAgB,KAAK,gBAAgB,IAAIH,CAAQ,EAGvD,GAAIG,EACF,YAAK,IAAI,oCAAoCH,CAAQ,EAAE,EAChDG,EAAc,QAIvB,IAAMC,EAAU,KAAK,cAAcJ,EAAUN,CAAI,EAC3CW,EAAkB,IAAI,gBAE5B,YAAK,gBAAgB,IAAIL,EAAU,CAAE,QAAAI,EAAS,gBAAAC,CAAgB,CAAC,EAExDD,CACT,CAEA,MAAc,cAAcJ,EAAkBN,EAAa,CACzD,KAAK,IAAI,kBAAkBM,CAAQ,EAAE,EAErC,GAAI,CACF,IAAMM,EAAO,MAAM,KAAK,QAAQ,GAAGZ,CAAI,EAEvC,YAAK,IAAI,wBAAwBM,CAAQ,EAAE,EAC3C,KAAK,QAAQA,EAAUM,EAAM,KAAK,IAAI,CAAC,EAChCA,CACT,OAASC,EAAG,CACV,WAAK,IAAI,mBAAmBP,CAAQ,KAAKO,CAAC,EAAE,EACtCA,CACR,QAAE,CACA,KAAK,gBAAgB,OAAOP,CAAQ,CACtC,CACF,CAGO,cAAcA,EAAsD,CACzE,OAAO,KAAK,WAAW,YAAY,IAAIA,CAAQ,CACjD,CAGO,QAAQA,EAAqC,CAClD,OAAO,KAAK,WAAW,YAAY,IAAIA,CAAQ,GAAG,IACpD,CAGO,QACLA,EACAM,EACAL,EAAgB,KAAK,IAAI,EACnB,CACN,IAAMO,EAAgC,CACpC,cAAe,KAAK,IAAI,EACxB,QAAS,GACT,KAAAF,EACA,cAAAL,CACF,EAEA,KAAK,WAAW,SAAUQ,IAAU,CAAE,GAAGA,EAAM,CAACT,CAAQ,EAAGQ,CAAM,EAAE,EAEnE,KAAK,iBAAiB,CACxB,CAMA,MAAa,oBAAoBd,EAA6B,CAC5D,IAAMgB,EAAM,KAAK,YAAYhB,CAAI,EACjC,OAAO,MAAM,KAAK,aAAagB,EAAK,GAAGhB,CAAI,CAC7C,CAGO,WAAWM,EAAwB,CAExC,IAAMW,EAAQ,CAAE,GADD,KAAK,WAAW,YAAY,CACjB,EAC1B,OAAOA,EAAMX,CAAQ,EACrB,KAAK,WAAW,SAASW,CAAK,EAE9B,IAAMC,EAAW,KAAK,gBAAgB,IAAIZ,CAAQ,EAC9CY,IACF,KAAK,gBAAgB,OAAOZ,CAAQ,EACpCY,EAAS,gBAAgB,MAAM,SAAS,EAE5C,CAGO,OAAc,CACnB,KAAK,WAAW,OAAO,EAEvB,OAAW,CAAE,gBAAAP,CAAgB,IAAK,MAAM,KACtC,KAAK,gBAAgB,OAAO,CAC9B,EACEA,EAAgB,MAAM,SAAS,EAGjC,KAAK,gBAAgB,MAAM,CAC7B,CAMO,kBAAyB,CAE9B,GAAI,CAAC,KAAK,SAAW,CAAC,KAAK,SACzB,OAGF,IAAMQ,EAAW,KAAK,WAAW,YAAY,EACvCC,EAAU,OAAO,KAAKD,CAAQ,EAAE,OAGtC,GAAIC,GAAW,EACb,OAGF,IAAMC,EAAcC,EAAYH,CAAQ,EAEpCI,EAAWJ,EACXK,EAAa,GAGjB,GAAI,KAAK,QAAS,CAChB,IAAMC,EAAWL,EAAU,KAAK,QAE5BK,EAAW,IACb,KAAK,IACH,wBAAwB,KAAK,SAAS,uBAAuBL,CAAO,MAAM,KAAK,OAAO,EACxF,EAEAG,EAAW,CAAE,GAAGA,CAAS,EACzBC,EAAa,GAEb,OAAO,QAAQD,CAAQ,EACpB,KACC,CAACG,EAAQC,IAEPA,EAAO,CAAC,EAAE,cAAgBD,EAAO,CAAC,EAAE,aACxC,EACC,MAAM,CAACD,CAAQ,EACf,QAAQ,CAAC,CAACT,CAAG,IAAM,CAClB,OAAOO,EAASP,CAAG,CACrB,CAAC,EAEP,CAGA,GAAI,KAAK,UAAY,OAAO,KAAKO,CAAQ,EAAE,OAAS,EAAG,CAErD,IAAMK,EAAkBJ,EAAaF,EAAYC,CAAQ,EAAIF,EAEzDQ,EAAaD,EAAkB,KAAK,SAExC,GAAIC,EAAa,EAAG,CAClB,KAAK,IACH,wBAAwB,KAAK,SAAS,4BAA4BD,EAAgB,eAAe,CAAC,MAAM,KAAK,SAAS,eAAe,CAAC,EACxI,EAGKJ,IACHD,EAAW,CAAE,GAAGA,CAAS,EACzBC,EAAa,IAGf,IAAMM,EAAyB,OAAO,QAAQP,CAAQ,EAAE,KACtD,CAACG,EAAQC,IAAWD,EAAO,CAAC,EAAE,cAAgBC,EAAO,CAAC,EAAE,aAC1D,EAEA,QACMI,EAAI,EAERA,EAAID,EAAuB,OAAS,GAAKD,EAAa,EACtDE,IACA,CACA,IAAMf,EAAMc,EAAuBC,CAAC,EAAE,CAAC,EACjCC,EAAWV,EAAYN,CAAG,EAAIM,EAAYC,EAASP,CAAG,CAAC,EAC7D,OAAOO,EAASP,CAAG,EACnBa,GAAcG,CAChB,CACF,CACF,CAGA,GAAIR,EAAY,CACd,KAAK,WAAW,SAASD,CAAQ,EAGjC,KAAK,IACH,oBAAoB,KAAK,SAAS,WAAWH,CAAO,OAAO,OAAO,KAAKG,CAAQ,EAAE,MAAM,YAAY,KAAK,OAAO,gBAAgBF,EAAY,eAAe,CAAC,OAAOC,EAAYC,CAAQ,EAAE,eAAe,CAAC,YAAY,KAAK,SAAS,eAAe,CAAC,GACpP,EAEA,MACF,CAGA,KAAK,IACH,4BAA4B,KAAK,SAAS,UAAUH,CAAO,WAAW,KAAK,OAAO,eAAeC,EAAY,eAAe,CAAC,WAAW,KAAK,SAAS,eAAe,CAAC,GACxK,CACF,CACF,EAEMY,EAAiB,IAAI,IAmBpB,SAASC,GAGdhC,EAC2B,CAC3B,GAAI+B,EAAe,IAAI/B,EAAQ,SAAS,EACtC,MAAM,IAAI,MAAM,2BAA2BA,EAAQ,SAAS,GAAG,EAEjE,OAAA+B,EAAe,IAAI/B,EAAQ,SAAS,EAE7B,IAAID,EAAYC,CAAO,CAChC,CAEA,IAAMiC,EAAsD,CAC1D,cAAe,EACf,QAAS,EACX,EAUO,SAASC,GACdC,EAEArC,EAAc,CAAC,EACQ,CAEvB,IAAMsC,EAAaC,EAAYvC,CAAI,EAE7B,CAACwC,EAAYC,CAAa,EAAIC,EAAeL,EAAM,UAAU,EAE7DM,EAAYC,EAAO,EAAI,EAEvBtC,EAAWuC,EACf,IAAMR,EAAM,YAAYC,CAAU,EAClC,CAACD,EAAOC,CAAU,CACpB,EAGMQ,EAAkBN,EAAWlC,CAAQ,EAIrCyC,EAAqBC,EAEvBC,GAKG,CACHR,EAAe1B,GAAS,CACtB,IAAME,EAAQ,CAAE,GAAGF,CAAK,EACxB,OAAAE,EAAMX,CAAQ,EACZ,OAAO2C,GAAQ,WAAaA,EAAIhC,EAAMX,CAAQ,CAAC,EAAI2C,EAC9ChC,CACT,CAAC,CACH,EACA,CAACX,EAAUmC,CAAa,CAC1B,EAGMS,EAAUF,EACd,MAAOG,GAA0B,CAC/Bd,EAAM,IAAI,gCAAgC/B,CAAQ,EAAE,EAEpDyC,EAAoBhC,IAAU,CAE5B,GAAIA,GAAQ,CAAC,EACb,cAAe,KAAK,IAAI,EACxB,QAAS,EACX,EAAE,EAEF,GAAI,CACF,IAAMH,EAAO,MAAOuC,EAChBd,EAAM,iBAAiB,GAAGC,CAAU,EACpCD,EAAM,iBAAiB,GAAGC,CAAU,GAExC,GAAIK,EAAU,QAAS,CACrB,IAAMS,EAAM,KAAK,IAAI,EAErBL,EAAmB,CAEjB,cAAeK,EACf,QAAS,GACT,KAAAxC,EACA,cAAewC,CACjB,CAAC,CACH,CACF,OAASvC,EAAG,CACV,GAAI8B,EAAU,QAAS,CACrB,IAAMS,EAAM,KAAK,IAAI,EAErBL,EAAoBhC,IAAU,CAE5B,GAAIA,GAAQ,CAAC,EACb,cAAeqC,EACf,QAAS,GACT,MAAOvC,EACP,eAAgBuC,CAClB,EAAE,CACJ,CACF,CACF,EACA,CAACf,EAAO/B,EAAUyC,EAAoBT,CAAU,CAClD,EAEA,OAAAe,EAAU,KACRV,EAAU,QAAU,GAEfO,EAAQ,EAAK,EAEX,IAAM,CACXP,EAAU,QAAU,EACtB,GACC,CAACO,CAAO,CAAC,EAELL,EAAQ,KAIN,CACL,GAHAC,GAAoBX,EAOpB,kBAAoBmB,GAAqB,CACvC,IAAMC,EAAalB,EAAM,wBAAwB/B,CAAQ,EACzD,OAAAiD,GAAY,MAAMD,CAAM,EACjB,EAAQC,CACjB,EACA,QAAS,IAAM,CACRL,EAAQ,EAAI,CACnB,EACA,QAAS,CAACtC,EAAaL,IAA2B,CAChD,IAAM6C,EAAM,KAAK,IAAI,EACrBL,EAAoBhC,IAAU,CAC5B,GAAIA,GAAQ,CAAC,EACb,KAAAH,EACA,cAAeL,GAAiB6C,EAChC,cAAeA,EACf,QAAS,EACX,EAAE,CACJ,EACA,WAAY,IAAM,CAChBX,EAAe1B,GAAS,CACtB,IAAME,EAAQ,CAAE,GAAGF,CAAK,EACxB,cAAOE,EAAMX,CAAQ,EACdW,CACT,CAAC,CACH,CACF,GACC,CACDiC,EACAb,EACA/B,EACAwC,EACAL,EACAM,CACF,CAAC,CACH","names":["MS_PER_DAY","getByteSize","useCallback","useEffect","useMemo","useRef","MS_PER_DAY","useSyncExternalStore","kvStore","getStorageAdapter","options","defaultStoreExpiryMs","localStorageKey","indexedDbKey","storeExpiryMs","store","expiryMs","LocalStorageAdapter","IndexedDbAdapter","LocalStorageAdapter","keyPrefix","expiryMs","key","value","fullKey","raw","box","IndexedDbAdapter","kvStore","k","SharedStateDefaults","MS_PER_DAY","PubSubStore","key","value","prev","subscriber","subscribers","next","copy","e","pubSubStore","STORAGE_KEY","stateKey","SharedState","defaultValue","options","getStorageAdapter","arg","lazyLoad","v","sharedState","useSharedState","state","useSyncExternalStore","onStoreChange","stringifyDeterministicForKeys","params","cache","_","value","result","key","isEqual","useMemo","useState","useDeepMemo","value","state","setState","SharedQueryDefaults","MS_PER_DAY","args","SharedQuery","options","persistTo","sharedState","stringifyDeterministicForKeys","queryKey","dataUpdatedMs","cached","inflightQuery","promise","abortController","data","e","entry","prev","key","clone","inflight","oldState","oldSize","oldByteSize","getByteSize","newState","needUpdate","numToCut","entry1","entry2","currentByteSize","bytesToCut","entriesByTimeAscending","i","thisSize","seenQueryNames","sharedQuery","DEFAULT_QUERY_STATE_ENTRY","useSharedQuery","query","stableArgs","useDeepMemo","queryState","setQueryState","useSharedState","isMounted","useRef","useMemo","queryStateValue","setQueryStateValue","useCallback","arg","execute","forceRefresh","now","useEffect","reason","controller"]}
1
+ {"version":3,"sources":["../src/sharedQuery.ts","../src/sharedState.ts","../src/utils/storage.ts","../src/utils/stringify.ts","../src/utils/useDeepMemo.ts"],"sourcesContent":["/**\n * @packageDocumentation\n *\n * The \"shared query\" is a data fetching convenience library that helps users\n * to load data, check for staleness and expiration, cache in memory, local\n * storage or indexed db, and be able to manipulate the data anytime.\n *\n * Each shared query creates a new private shared state that handles the data\n * storage. This shared state contains the records for all queries, where each\n * query is a unique set of arguments used to make the query. The number of\n * records and the total byte size of data can be limited so as to ensure the\n * query does not take up too much memory.\n *\n * Example:\n * ```\n * import { sharedQuery, useSharedQuery } from \"@choksheak/react-utils/sharedQuery\";\n *\n * // Create a new shared query in the top level scope.\n * // The query function `queryFn` here does not take any arguments.\n * //\n * // Only the queryName and queryFn are required and everything else is\n * // optional.\n * //\n * // The queryName must be unique, otherwise we will throw an\n * // error. This is because defining the same queryName for two different\n * // queries implies that the queries are the same, thus violating the idea\n * // of a \"shared\" query, and almost certainly points to a bug in the code.\n * export const usersQuery = sharedQuery({\n * queryName: \"users\",\n * queryFn: listUsers,\n * persistTo: \"indexedDb\",\n * staleMs: MS_PER_DAY,\n * });\n *\n * // Note that the query will only start fetching on mount in React.\n * // But you can do `usersQuery.getCachedOrFetch()` here to prefetch the\n * // data if necessary.\n * usersQuery.getCachedOrFetch();\n *\n * // Example of using a query function with arguments.\n * export const getUserQuery = sharedQuery({\n * queryName: \"getUser\",\n * queryFn: getUser, // getUser(userId: string) => User\n * persistTo: \"indexedDb\",\n * staleMs: MS_PER_DAY,\n * });\n *\n * export const UsersComponent: React.FC = () => {\n * // Second argument is optional, and is an array of arguments to be\n * // passed to the `queryFn`.\n * const users = useSharedQuery(usersQuery);\n *\n * return (\n * <>\n * <h1>List of Users</h1>\n *\n * <button onclick={users.refetch}>Refresh</button>\n *\n * {users.loading && <Loader />}\n *\n * {users.error && !users.data && <p>Error: {String(users.error)}</p>}\n *\n * <p>Data: {users.data ? JSON.stringify(users.data) : \"-\"}</p>\n * </>\n * );\n * };\n *\n * export const AnotherComponent: React.FC = () => {\n * // This query will be deduped with the one above, sharing the same\n * // data and the same fetches.\n * const users = useSharedQuery(usersQuery);\n * ...\n * };\n *\n * export const DisplayOneUser: React.FC<{userId: string}> = ({userId}) => {\n * // Example of using the query with an argument. Whenever the argument\n * // changes, the data will be fetched and updated automatically.\n * const user = useSharedQuery(getUserQuery, [userId]);\n *\n * return <>User: {user.data ? JSON.stringify(user.data) : \"-\"}</>;\n * };\n * ```\n */\n\nimport { MS_PER_DAY } from \"@choksheak/ts-utils/timeConstants\";\nimport getByteSize from \"object-sizeof\";\nimport {\n SetStateAction,\n useCallback,\n useEffect,\n useMemo,\n useRef,\n useState,\n} from \"react\";\n\nimport {\n SharedState,\n sharedState,\n SharedStateOptions,\n useSharedState,\n} from \"./sharedState\";\nimport { stringifyDeterministicForKeys } from \"./utils/stringify\";\nimport { useDeepMemo } from \"./utils/useDeepMemo\";\n\n/** Type of the queryFn used to fetch the data from source. */\nexport type QueryFn<TArgs extends unknown[], TData> = (\n ...args: TArgs\n) => Promise<TData> | TData;\n\n/** An entry for a persisted state corresponding to one query key. */\nexport type QueryStateValue<TData> = Readonly<{\n /**\n * When this record was last updated. Used for LRU determination. If you want\n * the data age, please use `dataUpdatedMs` instead.\n */\n lastUpdatedMs: number;\n\n loading: boolean;\n data?: TData;\n dataUpdatedMs?: number;\n\n /**\n * Use unknown type for error because we can't assume what type of variable\n * will be thrown from the query function. We also don't want to add this\n * type to QueryStateValue<TError> as it adds complexity to the type.\n */\n error?: unknown;\n\n errorUpdatedMs?: number;\n}>;\n\n/** Return type for useSharedQuery(). */\nexport type UseQueryResult<TData> = QueryStateValue<TData> &\n Readonly<{\n /**\n * Return the last non-empty data if you want to display the last loaded data\n * while waiting for the new data to load.\n */\n lastNonEmptyData: TData | undefined;\n\n /**\n * Cancels the inflight query (if any). Returns true if canceled.\n */\n abortCurrentQuery: (reason?: unknown) => boolean;\n\n /**\n * Manually refresh the data by doing a new query.\n */\n refetch: () => void;\n\n /**\n * If you got the data from somewhere else (e.g. an in-memory data update),\n * just set it directly.\n */\n setData: (data: TData, dataUpdatedMs?: number) => void;\n\n deleteData: () => void;\n }>;\n\n/** List of all available persistence options. */\nexport type PersistTo = \"localStorage\" | \"indexedDb\";\n\n/**\n * The full query state is a record of all the fetch states mapped by\n * query key to the state entry.\n */\nexport type SharedQueryState<TData> = Record<string, QueryStateValue<TData>>;\n\n/** Options to configure a shared query. */\nexport type SharedQueryOptions<TArgs extends unknown[], TData> = {\n /**\n * The name could have been auto-generated, but we let the user give us a\n * human-readable name that can be identified quickly in the logs.\n * Note that the queryKey is a string formed by the queryName plus the query\n * arguments.\n */\n queryName: string;\n\n /**\n * Function to fetch data.\n */\n queryFn: QueryFn<TArgs, TData>;\n\n /**\n * ms before data considered stale; 0 means always stale.\n */\n staleMs?: number;\n\n /**\n * ms before data is removed from cache; 0 means never expire.\n */\n expiryMs?: number;\n\n /**\n * Trigger background re-fetch if stale.\n */\n refetchOnStale?: boolean;\n\n /**\n * Shortcut to set the localStorageKey or indexedDbKey automatically from\n * queryName. This is important because it avoids requiring the user to\n * specify the same queryName twice everytime.\n */\n persistTo?: PersistTo;\n\n /**\n * Max number of entries to keep. The oldest entries will be discarded.\n * The last record cannot be discarded. 0 means no limit.\n */\n maxSize?: number;\n\n /**\n * Max number of bytes to keep. The oldest entries will be discarded.\n * The last record cannot be discarded. 0 means no limit.\n */\n maxBytes?: number;\n\n /**\n * Keep a copy of the last non-empty data so that when you change the\n * query arguments, you can still display the old data while waiting for the\n * new data to load.\n */\n keepLastNonEmptyData?: boolean;\n\n /**\n * Customize the logger.\n */\n log?: (...args: unknown[]) => void;\n} & SharedStateOptions<SharedQueryState<TData>>;\n\n/** Users can override these values globally. */\nexport const SharedQueryDefaults = {\n /** Refetch on every page load. */\n staleMs: 0,\n\n /** Keep in cache for a long time. */\n expiryMs: 30 * MS_PER_DAY,\n\n /** Always refetch automatically if the data is stale. */\n refetchOnStale: true,\n\n /** No default persistence configured. */\n persistTo: undefined as PersistTo | undefined,\n\n /** 100 is not too large, but please tweak accordingly. */\n maxSize: 100,\n\n /** 100kb limit before discarding old records. */\n maxBytes: 100_000,\n\n /** Default to log to console. */\n log: (...args: unknown[]) => console.log(\"[sharedQuery]\", ...args),\n};\n\n/** Please use sharedQuery() instead. */\nexport class SharedQuery<TArgs extends unknown[], TData> {\n private readonly inflightQueries = new Map<\n string,\n { promise: Promise<TData>; abortController: AbortController }\n >();\n\n public readonly queryState: SharedState<SharedQueryState<TData>>;\n\n /**\n * Keep track of the mounted query keys. This handles the case where an\n * earlier-started query returns later, and when it returns, it was already\n * unmounted, thus making it eligible for clean up right after fetch.\n */\n private readonly mountedKeys = new Map<string, number>();\n\n public readonly queryName: string;\n private readonly queryFn: QueryFn<TArgs, TData>;\n public readonly expiryMs: number;\n public readonly staleMs: number;\n public readonly refetchOnStale: boolean;\n public readonly maxSize: number;\n public readonly maxBytes: number;\n public readonly keepLastNonEmptyData: boolean;\n public readonly log: (...args: unknown[]) => void;\n\n public constructor(options: SharedQueryOptions<TArgs, TData>) {\n this.queryName = options.queryName;\n this.queryFn = options.queryFn;\n\n this.staleMs = options?.staleMs ?? SharedQueryDefaults.staleMs;\n this.expiryMs = options?.expiryMs ?? SharedQueryDefaults.expiryMs;\n\n this.refetchOnStale =\n options?.refetchOnStale ?? SharedQueryDefaults.refetchOnStale;\n\n // Apply shortcut when using `persistTo`.\n // Specifying the storage keys will take precedence over `persistTo`.\n if (!options.localStorageKey && !options.indexedDbKey) {\n const persistTo = options.persistTo ?? SharedQueryDefaults.persistTo;\n\n if (persistTo === \"localStorage\") {\n options.localStorageKey = options.queryName;\n } else if (persistTo === \"indexedDb\") {\n options.indexedDbKey = options.queryName;\n }\n }\n\n this.maxSize = options?.maxSize ?? SharedQueryDefaults.maxSize;\n this.maxBytes = options?.maxBytes ?? SharedQueryDefaults.maxBytes;\n\n this.keepLastNonEmptyData = Boolean(options?.keepLastNonEmptyData);\n\n this.log = options?.log ?? SharedQueryDefaults.log;\n\n this.queryState = sharedState<SharedQueryState<TData>>(\n {}, // defaultValue\n {\n ...options,\n // Fallback to use expiryMs for the storeExpiryMs.\n storeExpiryMs: options?.storeExpiryMs || this.expiryMs,\n },\n );\n }\n\n /** Returns a key to identify requests based on the given args. */\n public getQueryKey(args: TArgs): string {\n return this.queryName + \":\" + stringifyDeterministicForKeys(args);\n }\n\n /**\n * Get the AbortController to abort the inflight query (if any).\n *\n * Note that once you get the controller, you can also get the signal easily\n * using `controller.signal`. So if you need both the controller and the\n * signal, just use this function.\n */\n public getAbortController(args: TArgs): AbortController | null {\n const queryKey = this.getQueryKey(args);\n return this.getAbortControllerByKey(queryKey);\n }\n\n public getAbortControllerByKey(queryKey: string): AbortController | null {\n return this.inflightQueries.get(queryKey)?.abortController ?? null;\n }\n\n /**\n * Get the AbortSignal to check for query abortions.\n *\n * Example:\n * ```\n * const getUserQuery = sharedQuery({\n * queryName: \"getUser\",\n * queryFn: (userId: string) => {\n * // Get the signal for this current execution.\n * const signal = getUserQuery.getAbortSignal([userId]);\n *\n * // Pass the signal to fetch so that it can be aborted.\n * const response = await fetch(`/users/${userId}`, { signal });\n *\n * // Check for errors.\n * if (!response.ok) {\n * throw new Error(response.statusText);\n * }\n *\n * // Return the data.\n * return await response.json();\n * },\n * });\n * ```\n */\n public getAbortSignal(args: TArgs): AbortSignal | null {\n const queryKey = this.getQueryKey(args);\n return this.getAbortSignalByKey(queryKey);\n }\n\n public getAbortSignalByKey(queryKey: string): AbortSignal | null {\n return this.getAbortControllerByKey(queryKey)?.signal ?? null;\n }\n\n private isStale(dataUpdatedMs: number): boolean {\n if (this.staleMs === 0) return true; // always stale\n\n const ageMs = Date.now() - dataUpdatedMs;\n return ageMs > this.staleMs;\n }\n\n private isExpired(dataUpdatedMs: number): boolean {\n if (this.expiryMs === 0) return false; // never expire\n\n const ageMs = Date.now() - dataUpdatedMs;\n return ageMs > this.expiryMs;\n }\n\n public async getCachedOrFetch(...args: TArgs): Promise<TData> {\n const queryKey = this.getQueryKey(args);\n const cached = this.queryState.getSnapshot()?.[queryKey];\n\n if (cached?.data && !this.isExpired(cached.dataUpdatedMs ?? 0)) {\n // Return cached value if not stale.\n if (!this.isStale(cached.dataUpdatedMs ?? 0)) {\n this.log(`Return fresh data ${queryKey} from cache without fetching`);\n return cached.data;\n }\n\n // If stale, optionally update the data in the background.\n if (this.refetchOnStale) {\n this.log(`refetchOnStale for ${queryKey}`);\n void this.dedupedFetch(queryKey, ...args);\n }\n\n // Still return stale data immediately.\n this.log(`Returning stale data for ${queryKey}`);\n return cached.data;\n }\n\n return await this.dedupedFetch(queryKey, ...args);\n }\n\n private dedupedFetch(queryKey: string, ...args: TArgs): Promise<TData> {\n const inflightQuery = this.inflightQueries.get(queryKey);\n\n // De-duplicate in-flight requests\n if (inflightQuery) {\n this.log(`Deduplicating inflight fetch for ${queryKey}`);\n return inflightQuery.promise;\n }\n\n // Fetch new data\n const promise = this.startFetching(queryKey, args);\n const abortController = new AbortController();\n\n this.inflightQueries.set(queryKey, { promise, abortController });\n\n return promise;\n }\n\n private async startFetching(queryKey: string, args: TArgs) {\n this.log(`Start fetching ${queryKey}`);\n\n try {\n const data = await this.queryFn(...args);\n\n this.log(`Successfully fetched ${queryKey}`);\n this.setData(queryKey, data, Date.now());\n return data;\n } catch (e) {\n this.log(`Failed to fetch ${queryKey}: ${e}`);\n throw e;\n } finally {\n this.inflightQueries.delete(queryKey);\n }\n }\n\n /** Get the entire stored entry for a query key. */\n public getQueryValue(queryKey: string): QueryStateValue<TData> | undefined {\n return this.queryState.getSnapshot()?.[queryKey];\n }\n\n /** Get the current stored data for a query key. */\n public getData(queryKey: string): TData | undefined {\n return this.queryState.getSnapshot()?.[queryKey]?.data;\n }\n\n /** Set the data directly if the user obtained it from somewhere else. */\n public setData(\n queryKey: string,\n data: TData,\n dataUpdatedMs = Date.now(),\n ): void {\n const entry: QueryStateValue<TData> = {\n lastUpdatedMs: Date.now(),\n loading: false,\n data,\n dataUpdatedMs,\n };\n\n this.queryState.setValue((prev) => ({ ...prev, [queryKey]: entry }));\n\n this.enforceSizeLimit();\n }\n\n /**\n * Do a new fetch even when the data is already cached, but don't fetch if\n * another fetch is already inflight.\n */\n public async updateFromSource(...args: TArgs): Promise<TData> {\n const key = this.getQueryKey(args);\n return await this.dedupedFetch(key, ...args);\n }\n\n /** Delete the cached data for one set of arguments. */\n public deleteData(queryKey: string): void {\n const record = this.queryState.getSnapshot();\n const clone = { ...record };\n delete clone[queryKey];\n this.queryState.setValue(clone);\n\n const inflight = this.inflightQueries.get(queryKey);\n if (inflight) {\n this.inflightQueries.delete(queryKey);\n inflight.abortController.abort(\"Deleted\");\n }\n }\n\n /** Delete all currently cached data & all inflight promises. */\n public clear(): void {\n this.queryState.delete();\n\n for (const { abortController } of Array.from(\n this.inflightQueries.values(),\n )) {\n abortController.abort(\"Cleared\");\n }\n\n this.inflightQueries.clear();\n }\n\n /** Keep track of mounted keys. */\n public mount(queryKey: string): void {\n this.mountedKeys.set(queryKey, (this.mountedKeys.get(queryKey) ?? 0) + 1);\n }\n\n /** Clean up mounted keys. */\n public unmount(queryKey: string): void {\n const count = this.mountedKeys.get(queryKey);\n if (count === 1) {\n this.mountedKeys.delete(queryKey);\n } else {\n this.mountedKeys.set(queryKey, (count ?? 0) - 1);\n }\n }\n\n /**\n * Discard the oldest entries if the size exceeds the limit. The last\n * remaining record cannot be deleted no matter what the limit is.\n */\n public enforceSizeLimit(): void {\n // Skip if there are no limits.\n if (!this.maxSize && !this.maxBytes) {\n return;\n }\n\n const oldState = this.queryState.getSnapshot();\n const oldSize = Object.keys(oldState).length;\n\n // Cannot do GC if size is 1 or less.\n if (oldSize <= 1) {\n return;\n }\n\n const oldByteSize = getByteSize(oldState);\n\n let numToCut = this.maxSize ? oldSize - this.maxSize : 0;\n let bytesToCut = this.maxBytes ? oldByteSize - this.maxBytes : 0;\n\n // Log to indicate why trimming was not needed.\n if (numToCut <= 0 && bytesToCut <= 0) {\n this.log(\n `No need to trim data for ${this.queryName}: size=${oldSize} (limit=${this.maxSize}), byteSize=${oldByteSize.toLocaleString()} (limit=${this.maxBytes.toLocaleString()})`,\n );\n return;\n }\n\n // Log to inform user that trimming is needed.\n this.log(\n `Need to trim ${this.queryName}: numToCut=${numToCut}, bytesToCut=${bytesToCut}`,\n );\n\n const newState = { ...oldState }; // shallow clone\n let needUpdate = false;\n\n const entriesByTimeAscending = Object.entries(newState).sort(\n (entry1, entry2) => entry1[1].lastUpdatedMs - entry2[1].lastUpdatedMs,\n );\n\n for (const [key] of entriesByTimeAscending) {\n // Mounted keys cannot be cleaned up as they are visible in the UI.\n if (this.mountedKeys.has(key)) {\n this.log(`Cannot clean up ${key} as it is mounted`);\n continue;\n }\n\n const byteSize = getByteSize(key) + getByteSize(newState[key]);\n this.log(\n `Cleaning up unmounted ${key} (byteSize=${byteSize.toLocaleString()})`,\n );\n\n numToCut--;\n bytesToCut -= byteSize;\n\n delete newState[key];\n needUpdate = true;\n\n if (numToCut <= 0 && bytesToCut <= 0) {\n break;\n }\n }\n\n // Log to indicate why trimming was not needed.\n if (!needUpdate) {\n this.log(\n `No trimmable entries found for ${this.queryName}: size=${oldSize} (limit=${this.maxSize}), byteSize=${oldByteSize.toLocaleString()} (limit=${this.maxBytes.toLocaleString()})`,\n );\n return;\n }\n\n // Update the state.\n this.queryState.setValue(newState);\n\n // Log to inform user that the data was trimmed.\n this.log(\n `Trimmed data for ${this.queryName}: size=[${oldSize} -> ${Object.keys(newState).length}] (limit=${this.maxSize}), byteSize=[${oldByteSize.toLocaleString()} -> ${getByteSize(newState).toLocaleString()}] (limit=${this.maxBytes.toLocaleString()})`,\n );\n }\n}\n\n// Disallow duplicate query names.\nconst seenQueryNames = new Set<string>();\n\n/**\n * Create a reusable shared query object that can be used to auto de-duplicate\n * and cache all data fetches, with auto-expiration and staleness checks.\n *\n * Each `queryName` must be unique, and can only be declared once, most often\n * in the top level scope. The queryName is used for logging only.\n *\n * Example:\n * ```\n * export const usersQuery = sharedQuery({\n * queryName: \"users\",\n * queryFn: listUsers,\n * persistTo: \"indexedDb\",\n * staleMs: MS_PER_DAY,\n * });\n * ```\n */\nexport function sharedQuery<TArgs extends unknown[], TData>(\n // The name could have been auto-generated, but we let the user give us a\n // human-readable name that can be identified quickly in the logs.\n options: SharedQueryOptions<TArgs, TData>,\n): SharedQuery<TArgs, TData> {\n if (seenQueryNames.has(options.queryName)) {\n throw new Error(`Duplicate shared query \"${options.queryName}\"`);\n }\n seenQueryNames.add(options.queryName);\n\n return new SharedQuery(options);\n}\n\n// Using any so that we don't need to typecast later.\n// eslint-disable-next-line @typescript-eslint/no-explicit-any\nconst DEFAULT_QUERY_STATE_ENTRY: Readonly<QueryStateValue<any>> = {\n lastUpdatedMs: 0,\n loading: true,\n};\n\n/**\n * React hook to make use of a shared query inside any React component.\n *\n * Example:\n * ```\n * const users = useSharedQuery(usersQuery, [\"123\"]);\n * ```\n */\nexport function useSharedQuery<TArgs extends unknown[], TData>(\n query: SharedQuery<TArgs, TData>,\n // Default to use no arguments.\n args: TArgs = [] as unknown as TArgs,\n): UseQueryResult<TData> {\n // We don't expect users to provide a stable `args`, so stabilize it here.\n const stableArgs = useDeepMemo(args);\n\n const [queryState, setQueryState] = useSharedState(query.queryState);\n\n const isMounted = useRef(true);\n\n const queryKey = useMemo(\n () => query.getQueryKey(stableArgs),\n [query, stableArgs],\n );\n\n // Init with empty object.\n const queryStateValue: QueryStateValue<TData> =\n queryState[queryKey] ?? DEFAULT_QUERY_STATE_ENTRY;\n\n const setQueryStateValue = useCallback(\n (next: SetStateAction<QueryStateValue<TData>>) => {\n setQueryState((prev) => {\n const clone = { ...prev };\n clone[queryKey] =\n typeof next === \"function\"\n ? next(clone[queryKey] ?? DEFAULT_QUERY_STATE_ENTRY)\n : next;\n return clone;\n });\n },\n [queryKey, setQueryState],\n );\n\n // Keep the last non-empty data loaded in case you want to show a placeholder\n // during new loads.\n const [lastNonEmptyData, setLastNonEmptyData] = useState<TData | undefined>();\n\n useEffect(() => {\n if (query.keepLastNonEmptyData && queryStateValue.data !== undefined) {\n setLastNonEmptyData(queryStateValue.data);\n }\n }, [query.keepLastNonEmptyData, queryStateValue.data]);\n\n // The fetch logic wrapped in useCallback to be stable for useEffect\n const execute = useCallback(\n async (forceRefresh: boolean) => {\n query.log(`Begin executing shared query ${queryKey}`);\n\n setQueryStateValue((prev) => ({\n // Keep old data and error.\n ...prev,\n lastUpdatedMs: Date.now(),\n loading: true,\n }));\n\n try {\n const data = await (forceRefresh\n ? query.updateFromSource(...stableArgs)\n : query.getCachedOrFetch(...stableArgs));\n\n if (isMounted.current) {\n const now = Date.now();\n\n setQueryStateValue({\n // Don't keep old error.\n lastUpdatedMs: now,\n loading: false,\n data,\n dataUpdatedMs: now,\n });\n }\n } catch (e) {\n if (isMounted.current) {\n const now = Date.now();\n\n setQueryStateValue((prev) => ({\n // Keep old data.\n ...prev,\n lastUpdatedMs: now,\n loading: false,\n error: e,\n errorUpdatedMs: now,\n }));\n }\n }\n },\n [query, queryKey, setQueryStateValue, stableArgs],\n );\n\n useEffect(() => {\n isMounted.current = true;\n query.mount(queryKey);\n\n void execute(false);\n\n return () => {\n isMounted.current = false;\n query.unmount(queryKey);\n };\n }, [execute, query, queryKey]);\n\n return useMemo(() => {\n return {\n ...queryStateValue,\n lastNonEmptyData,\n // This works only if the user-given queryFn supports abort. If not,\n // this function doesn't do anything, since we don't have any means to\n // abort the running queryFn.\n abortCurrentQuery: (reason?: unknown) => {\n const controller = query.getAbortControllerByKey(queryKey);\n controller?.abort(reason);\n return Boolean(controller);\n },\n refetch: () => {\n void execute(true);\n },\n setData: (data: TData, dataUpdatedMs?: number) => {\n const now = Date.now();\n setQueryStateValue((prev) => ({\n ...prev,\n data,\n dataUpdatedMs: dataUpdatedMs ?? now,\n lastUpdatedMs: now,\n loading: false,\n }));\n },\n deleteData: () => {\n setQueryState((prev) => {\n const clone = { ...prev };\n delete clone[queryKey];\n return clone;\n });\n },\n } satisfies UseQueryResult<TData>;\n }, [\n execute,\n lastNonEmptyData,\n query,\n queryKey,\n queryStateValue,\n setQueryState,\n setQueryStateValue,\n ]);\n}\n","/**\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 { MS_PER_DAY } from \"@choksheak/ts-utils/timeConstants\";\nimport { Dispatch, SetStateAction, useSyncExternalStore } from \"react\";\n\nimport {\n getStorageAdapter,\n StorageAdapter,\n StorageOptions,\n} from \"./utils/storage\";\n\n/************************************************************************/\n/* Global config */\n/************************************************************************/\n\n/**\n * These values are configurable by the user at any time.\n */\nexport const SharedStateDefaults = {\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\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 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 SharedStateDefaults.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 =\n lazyLoad !== undefined ? lazyLoad : SharedStateDefaults.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 // Get the value of the shared state.\n // `getSnapshot` function — must return same ref if value unchanged\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.storageAdapter?.save(STORAGE_KEY, next);\n }\n\n // Remove the value of the shared state. Actually this just sets the value\n // back to the given default value.\n public delete() {\n pubSubStore.set(this.pubSubKey, this.defaultValue);\n void this.storageAdapter?.save(STORAGE_KEY, this.defaultValue);\n }\n\n // Initial default handling\n public async initDefaultValueOnce() {\n if (this.initDone) return;\n this.initDone = true;\n\n const v = await this.storageAdapter?.load(STORAGE_KEY);\n pubSubStore.set(this.pubSubKey, v !== undefined ? v : this.defaultValue);\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\";\n\nexport type StorageAdapter<T> = {\n save: (key: string, value: T) => Promise<void> | void;\n load: (key: string) => Promise<T | undefined> | T | undefined;\n delete: (key: string) => Promise<void> | void;\n clear: () => Promise<void> | void;\n};\n\nexport type StorageOptions<T> = {\n // If specified, this will be used and all other fields will be ignored.\n store?: StorageAdapter<T>;\n\n // Storage key in local storage for this data.\n localStorageKey?: string;\n\n // Storage key in indexed db for this data.\n indexedDbKey?: string;\n\n // How long to wait before the value is considered expired.\n storeExpiryMs?: number;\n};\n\nexport function getStorageAdapter<T>(\n options: StorageOptions<T> | undefined,\n defaultStoreExpiryMs: number,\n): StorageAdapter<T> | null {\n const { localStorageKey, indexedDbKey, storeExpiryMs, store } = options ?? {};\n\n if (store) {\n return store;\n }\n\n const expiryMs = storeExpiryMs || defaultStoreExpiryMs;\n\n if (localStorageKey) {\n return new LocalStorageAdapter<T>(localStorageKey, expiryMs);\n }\n\n if (indexedDbKey) {\n return new IndexedDbAdapter<T>(indexedDbKey, expiryMs);\n }\n\n return null;\n}\n\n/************************************************************************/\n/* Storage adapters */\n/************************************************************************/\n\ntype ValueWithExpiration<T> = { value: T; expiresAt: number };\n\n/** Save state to memory only - not persisted. */\nexport class InMemoryStorageAdapter<T> implements StorageAdapter<T> {\n private readonly cache = new Map<string, ValueWithExpiration<T>>();\n\n public constructor(\n public readonly keyPrefix: string,\n public readonly expiryMs: number,\n ) {}\n\n public save(key: string, value: T): void {\n const fullKey = this.keyPrefix + \":\" + key;\n this.cache.set(fullKey, {\n value,\n expiresAt: Date.now() + this.expiryMs,\n });\n }\n\n public load(key: string): T | undefined {\n const fullKey = this.keyPrefix + \":\" + key;\n const cached = this.cache.get(fullKey);\n\n if (cached && Date.now() < cached.expiresAt) {\n return cached.value;\n }\n\n return undefined;\n }\n\n public delete(key: string): void {\n const fullKey = this.keyPrefix + \":\" + key;\n this.cache.delete(fullKey);\n }\n\n public clear(): void {\n this.cache.clear();\n }\n}\n\n/** Save state to local storage. */\nexport class LocalStorageAdapter<T> implements StorageAdapter<T> {\n public constructor(\n public readonly keyPrefix: string,\n public readonly expiryMs: number,\n ) {}\n\n public save(key: string, value: T): void {\n if (typeof window === \"undefined\") return;\n\n const fullKey = this.keyPrefix + \":\" + key;\n window.localStorage.setItem(\n fullKey,\n JSON.stringify({\n value,\n expiresAt: this.expiryMs ? Date.now() + this.expiryMs : 0,\n } satisfies ValueWithExpiration<T>),\n );\n }\n\n public load(key: string): T | undefined {\n if (typeof window === \"undefined\") return undefined;\n\n const fullKey = this.keyPrefix + \":\" + key;\n const raw = window.localStorage.getItem(fullKey);\n if (!raw) return undefined;\n\n try {\n const box = JSON.parse(raw) as ValueWithExpiration<T>;\n if (!box || (box.expiresAt && Date.now() >= box.expiresAt)) {\n window.localStorage.removeItem(fullKey);\n return undefined;\n }\n\n return box.value;\n } catch {\n // Ignore error.\n window.localStorage.removeItem(fullKey);\n return undefined;\n }\n }\n\n public delete(key: string): void {\n if (typeof window === \"undefined\") return;\n\n const fullKey = this.keyPrefix + \":\" + key;\n window.localStorage.removeItem(fullKey);\n }\n\n public clear(): void {\n if (typeof window === \"undefined\") return;\n\n for (const key of Object.keys(window.localStorage)) {\n if (key.startsWith(this.keyPrefix)) {\n window.localStorage.removeItem(key);\n }\n }\n }\n}\n\n/** Save state to indexed db. */\nexport class IndexedDbAdapter<T> implements StorageAdapter<T> {\n public constructor(\n public readonly keyPrefix: string,\n public readonly expiryMs: number,\n ) {}\n\n public async save(key: string, value: T): Promise<void> {\n if (typeof window === \"undefined\") return;\n\n const fullKey = this.keyPrefix + \":\" + key;\n await kvStore.set(fullKey, JSON.stringify(value), this.expiryMs);\n }\n\n public async load(key: string): Promise<T | undefined> {\n if (typeof window === \"undefined\") return undefined;\n\n const fullKey = this.keyPrefix + \":\" + key;\n const raw = await kvStore.get<string>(fullKey);\n if (raw === undefined) return undefined;\n\n try {\n return JSON.parse(raw);\n } catch {\n // Ignore error.\n await kvStore.delete(fullKey);\n return undefined;\n }\n }\n\n public async delete(key: string): Promise<void> {\n if (typeof window === \"undefined\") return;\n\n const fullKey = this.keyPrefix + \":\" + key;\n await kvStore.delete(fullKey);\n }\n\n public async clear(): Promise<void> {\n if (typeof window === \"undefined\") return;\n\n await kvStore.forEach(async (k) => {\n if (k.startsWith(this.keyPrefix)) {\n await kvStore.delete(k);\n }\n });\n }\n}\n","/**\n * JSON stringify a value of any type, and returns an unsafe string. The string\n * is \"unsafe\" because you might not be able to restore the original object\n * using the serialized JSON. This is specifically used for query key generation\n * and is not suitable for more general uses.\n *\n * Note: The given value should not contain any functions because functions\n * cannot be serialized and deserialized properly.\n */\nexport function stringifyDeterministicForKeys(params: unknown): string {\n const cache = new Set();\n\n return JSON.stringify(params, (_, value) => {\n if (typeof value === \"function\") {\n throw new Error(`Functions should not be passed into query parameters`);\n }\n\n if (!value || typeof value !== \"object\" || Array.isArray(value)) {\n return value;\n }\n\n if (cache.has(value)) {\n // Circular reference detected! Return a placeholder string.\n return \"[Circular]\";\n }\n\n cache.add(value);\n\n // Don't crash on circular references, but don't mark the top level object\n // as circular because we want to return as much string as possible.\n if (value !== params) {\n try {\n JSON.stringify(value);\n } catch {\n return \"[Unserializable]\";\n }\n }\n\n return Object.keys(value)\n .sort()\n .reduce(\n (result: Record<string, unknown>, key: string) => {\n result[key] = value[key];\n return result;\n },\n {} as Record<string, unknown>,\n );\n });\n}\n","import isEqual from \"lodash/isEqual\";\nimport { useMemo, useState } from \"react\";\n\n/** Provides a stable value for T based on deep equality. */\nexport function useDeepMemo<T>(value: T): T {\n const [state, setState] = useState<T>(value);\n\n return useMemo(() => {\n if (state === value || isEqual(state, value)) {\n return state;\n }\n\n // We check equality, so this should be safe.\n // eslint-disable-next-line react-hooks/set-state-in-render\n setState(value);\n\n return value;\n }, [state, value]);\n}\n"],"mappings":"AAoFA,OAAS,cAAAA,MAAkB,oCAC3B,OAAOC,MAAiB,gBACxB,OAEE,eAAAC,EACA,aAAAC,EACA,WAAAC,EACA,UAAAC,EACA,YAAAC,MACK,QCnDP,OAAS,cAAAC,MAAkB,oCAC3B,OAAmC,wBAAAC,MAA4B,QC3C/D,OAAS,WAAAC,MAAe,8BAuBjB,SAASC,EACdC,EACAC,EAC0B,CAC1B,GAAM,CAAE,gBAAAC,EAAiB,aAAAC,EAAc,cAAAC,EAAe,MAAAC,CAAM,EAAIL,GAAW,CAAC,EAE5E,GAAIK,EACF,OAAOA,EAGT,IAAMC,EAAWF,GAAiBH,EAElC,OAAIC,EACK,IAAIK,EAAuBL,EAAiBI,CAAQ,EAGzDH,EACK,IAAIK,EAAoBL,EAAcG,CAAQ,EAGhD,IACT,CA+CO,IAAMG,EAAN,KAA0D,CACxD,YACWC,EACAC,EAChB,CAFgB,eAAAD,EACA,cAAAC,CACf,CAEI,KAAKC,EAAaC,EAAgB,CACvC,GAAI,OAAO,OAAW,IAAa,OAEnC,IAAMC,EAAU,KAAK,UAAY,IAAMF,EACvC,OAAO,aAAa,QAClBE,EACA,KAAK,UAAU,CACb,MAAAD,EACA,UAAW,KAAK,SAAW,KAAK,IAAI,EAAI,KAAK,SAAW,CAC1D,CAAkC,CACpC,CACF,CAEO,KAAKD,EAA4B,CACtC,GAAI,OAAO,OAAW,IAAa,OAEnC,IAAME,EAAU,KAAK,UAAY,IAAMF,EACjCG,EAAM,OAAO,aAAa,QAAQD,CAAO,EAC/C,GAAKC,EAEL,GAAI,CACF,IAAMC,EAAM,KAAK,MAAMD,CAAG,EAC1B,GAAI,CAACC,GAAQA,EAAI,WAAa,KAAK,IAAI,GAAKA,EAAI,UAAY,CAC1D,OAAO,aAAa,WAAWF,CAAO,EACtC,MACF,CAEA,OAAOE,EAAI,KACb,MAAQ,CAEN,OAAO,aAAa,WAAWF,CAAO,EACtC,MACF,CACF,CAEO,OAAOF,EAAmB,CAC/B,GAAI,OAAO,OAAW,IAAa,OAEnC,IAAME,EAAU,KAAK,UAAY,IAAMF,EACvC,OAAO,aAAa,WAAWE,CAAO,CACxC,CAEO,OAAc,CACnB,GAAI,SAAO,OAAW,KAEtB,QAAWF,KAAO,OAAO,KAAK,OAAO,YAAY,EAC3CA,EAAI,WAAW,KAAK,SAAS,GAC/B,OAAO,aAAa,WAAWA,CAAG,CAGxC,CACF,EAGaK,EAAN,KAAuD,CACrD,YACWP,EACAC,EAChB,CAFgB,eAAAD,EACA,cAAAC,CACf,CAEH,MAAa,KAAKC,EAAaC,EAAyB,CACtD,GAAI,OAAO,OAAW,IAAa,OAEnC,IAAMC,EAAU,KAAK,UAAY,IAAMF,EACvC,MAAMM,EAAQ,IAAIJ,EAAS,KAAK,UAAUD,CAAK,EAAG,KAAK,QAAQ,CACjE,CAEA,MAAa,KAAKD,EAAqC,CACrD,GAAI,OAAO,OAAW,IAAa,OAEnC,IAAME,EAAU,KAAK,UAAY,IAAMF,EACjCG,EAAM,MAAMG,EAAQ,IAAYJ,CAAO,EAC7C,GAAIC,IAAQ,OAEZ,GAAI,CACF,OAAO,KAAK,MAAMA,CAAG,CACvB,MAAQ,CAEN,MAAMG,EAAQ,OAAOJ,CAAO,EAC5B,MACF,CACF,CAEA,MAAa,OAAOF,EAA4B,CAC9C,GAAI,OAAO,OAAW,IAAa,OAEnC,IAAME,EAAU,KAAK,UAAY,IAAMF,EACvC,MAAMM,EAAQ,OAAOJ,CAAO,CAC9B,CAEA,MAAa,OAAuB,CAC9B,OAAO,OAAW,KAEtB,MAAMI,EAAQ,QAAQ,MAAOC,GAAM,CAC7BA,EAAE,WAAW,KAAK,SAAS,GAC7B,MAAMD,EAAQ,OAAOC,CAAC,CAE1B,CAAC,CACH,CACF,ED1IO,IAAMC,EAAsB,CAKjC,cAAe,GAAKC,EAMpB,SAAU,EACZ,EAQMC,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,CAMnB,YACYC,EACjBC,EACA,CAFiB,kBAAAD,EAGjB,KAAK,UAAY,OAAOF,GAAU,EAGlC,KAAK,eAAiBI,EACpBD,EACAhB,EAAoB,aACtB,EAGA,KAAK,gBAAmBQ,GAA4B,CAClD,KAAK,SAASA,CAAI,CACpB,EAIAG,EAAY,YAAY,KAAK,UAAWI,CAAY,EAEpD,IAAMG,EAAWF,GAAS,UAExBE,IAAa,OAAYA,EAAWlB,EAAoB,WAGnD,KAAK,qBAAqB,CAEnC,CAjCiB,UACA,eACD,gBACT,SAAW,GAiCX,UAAUM,EAAoC,CACnD,OAAOK,EAAY,UAAU,KAAK,UAAW,IAAML,EAAW,CAAC,CACjE,CAIO,aAAiB,CACtB,OAAOK,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,gBAAgB,KAAKI,EAAaJ,CAAI,CAClD,CAIO,QAAS,CACdG,EAAY,IAAI,KAAK,UAAW,KAAK,YAAY,EAC5C,KAAK,gBAAgB,KAAKC,EAAa,KAAK,YAAY,CAC/D,CAGA,MAAa,sBAAuB,CAClC,GAAI,KAAK,SAAU,OACnB,KAAK,SAAW,GAEhB,IAAMO,EAAI,MAAM,KAAK,gBAAgB,KAAKP,CAAW,EACrDD,EAAY,IAAI,KAAK,UAAWQ,IAAM,OAAYA,EAAI,KAAK,YAAY,CACzE,CACF,EAUO,SAASC,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,CE9PO,SAASG,EAA8BC,EAAyB,CACrE,IAAMC,EAAQ,IAAI,IAElB,OAAO,KAAK,UAAUD,EAAQ,CAACE,EAAGC,IAAU,CAC1C,GAAI,OAAOA,GAAU,WACnB,MAAM,IAAI,MAAM,sDAAsD,EAGxE,GAAI,CAACA,GAAS,OAAOA,GAAU,UAAY,MAAM,QAAQA,CAAK,EAC5D,OAAOA,EAGT,GAAIF,EAAM,IAAIE,CAAK,EAEjB,MAAO,aAOT,GAJAF,EAAM,IAAIE,CAAK,EAIXA,IAAUH,EACZ,GAAI,CACF,KAAK,UAAUG,CAAK,CACtB,MAAQ,CACN,MAAO,kBACT,CAGF,OAAO,OAAO,KAAKA,CAAK,EACrB,KAAK,EACL,OACC,CAACC,EAAiCC,KAChCD,EAAOC,CAAG,EAAIF,EAAME,CAAG,EAChBD,GAET,CAAC,CACH,CACJ,CAAC,CACH,CChDA,OAAOE,MAAa,iBACpB,OAAS,WAAAC,EAAS,YAAAC,MAAgB,QAG3B,SAASC,EAAeC,EAAa,CAC1C,GAAM,CAACC,EAAOC,CAAQ,EAAIJ,EAAYE,CAAK,EAE3C,OAAOH,EAAQ,IACTI,IAAUD,GAASJ,EAAQK,EAAOD,CAAK,EAClCC,GAKTC,EAASF,CAAK,EAEPA,GACN,CAACC,EAAOD,CAAK,CAAC,CACnB,CJqNO,IAAMG,EAAsB,CAEjC,QAAS,EAGT,SAAU,GAAKC,EAGf,eAAgB,GAGhB,UAAW,OAGX,QAAS,IAGT,SAAU,IAGV,IAAK,IAAIC,IAAoB,QAAQ,IAAI,gBAAiB,GAAGA,CAAI,CACnE,EAGaC,EAAN,KAAkD,CACtC,gBAAkB,IAAI,IAKvB,WAOC,YAAc,IAAI,IAEnB,UACC,QACD,SACA,QACA,eACA,QACA,SACA,qBACA,IAET,YAAYC,EAA2C,CAY5D,GAXA,KAAK,UAAYA,EAAQ,UACzB,KAAK,QAAUA,EAAQ,QAEvB,KAAK,QAAUA,GAAS,SAAWJ,EAAoB,QACvD,KAAK,SAAWI,GAAS,UAAYJ,EAAoB,SAEzD,KAAK,eACHI,GAAS,gBAAkBJ,EAAoB,eAI7C,CAACI,EAAQ,iBAAmB,CAACA,EAAQ,aAAc,CACrD,IAAMC,EAAYD,EAAQ,WAAaJ,EAAoB,UAEvDK,IAAc,eAChBD,EAAQ,gBAAkBA,EAAQ,UACzBC,IAAc,cACvBD,EAAQ,aAAeA,EAAQ,UAEnC,CAEA,KAAK,QAAUA,GAAS,SAAWJ,EAAoB,QACvD,KAAK,SAAWI,GAAS,UAAYJ,EAAoB,SAEzD,KAAK,qBAAuB,EAAQI,GAAS,qBAE7C,KAAK,IAAMA,GAAS,KAAOJ,EAAoB,IAE/C,KAAK,WAAaM,EAChB,CAAC,EACD,CACE,GAAGF,EAEH,cAAeA,GAAS,eAAiB,KAAK,QAChD,CACF,CACF,CAGO,YAAYF,EAAqB,CACtC,OAAO,KAAK,UAAY,IAAMK,EAA8BL,CAAI,CAClE,CASO,mBAAmBA,EAAqC,CAC7D,IAAMM,EAAW,KAAK,YAAYN,CAAI,EACtC,OAAO,KAAK,wBAAwBM,CAAQ,CAC9C,CAEO,wBAAwBA,EAA0C,CACvE,OAAO,KAAK,gBAAgB,IAAIA,CAAQ,GAAG,iBAAmB,IAChE,CA2BO,eAAeN,EAAiC,CACrD,IAAMM,EAAW,KAAK,YAAYN,CAAI,EACtC,OAAO,KAAK,oBAAoBM,CAAQ,CAC1C,CAEO,oBAAoBA,EAAsC,CAC/D,OAAO,KAAK,wBAAwBA,CAAQ,GAAG,QAAU,IAC3D,CAEQ,QAAQC,EAAgC,CAC9C,OAAI,KAAK,UAAY,EAAU,GAEjB,KAAK,IAAI,EAAIA,EACZ,KAAK,OACtB,CAEQ,UAAUA,EAAgC,CAChD,OAAI,KAAK,WAAa,EAAU,GAElB,KAAK,IAAI,EAAIA,EACZ,KAAK,QACtB,CAEA,MAAa,oBAAoBP,EAA6B,CAC5D,IAAMM,EAAW,KAAK,YAAYN,CAAI,EAChCQ,EAAS,KAAK,WAAW,YAAY,IAAIF,CAAQ,EAEvD,OAAIE,GAAQ,MAAQ,CAAC,KAAK,UAAUA,EAAO,eAAiB,CAAC,EAEtD,KAAK,QAAQA,EAAO,eAAiB,CAAC,GAMvC,KAAK,iBACP,KAAK,IAAI,sBAAsBF,CAAQ,EAAE,EACpC,KAAK,aAAaA,EAAU,GAAGN,CAAI,GAI1C,KAAK,IAAI,4BAA4BM,CAAQ,EAAE,EACxCE,EAAO,OAZZ,KAAK,IAAI,qBAAqBF,CAAQ,8BAA8B,EAC7DE,EAAO,MAcX,MAAM,KAAK,aAAaF,EAAU,GAAGN,CAAI,CAClD,CAEQ,aAAaM,KAAqBN,EAA6B,CACrE,IAAMS,EAAgB,KAAK,gBAAgB,IAAIH,CAAQ,EAGvD,GAAIG,EACF,YAAK,IAAI,oCAAoCH,CAAQ,EAAE,EAChDG,EAAc,QAIvB,IAAMC,EAAU,KAAK,cAAcJ,EAAUN,CAAI,EAC3CW,EAAkB,IAAI,gBAE5B,YAAK,gBAAgB,IAAIL,EAAU,CAAE,QAAAI,EAAS,gBAAAC,CAAgB,CAAC,EAExDD,CACT,CAEA,MAAc,cAAcJ,EAAkBN,EAAa,CACzD,KAAK,IAAI,kBAAkBM,CAAQ,EAAE,EAErC,GAAI,CACF,IAAMM,EAAO,MAAM,KAAK,QAAQ,GAAGZ,CAAI,EAEvC,YAAK,IAAI,wBAAwBM,CAAQ,EAAE,EAC3C,KAAK,QAAQA,EAAUM,EAAM,KAAK,IAAI,CAAC,EAChCA,CACT,OAASC,EAAG,CACV,WAAK,IAAI,mBAAmBP,CAAQ,KAAKO,CAAC,EAAE,EACtCA,CACR,QAAE,CACA,KAAK,gBAAgB,OAAOP,CAAQ,CACtC,CACF,CAGO,cAAcA,EAAsD,CACzE,OAAO,KAAK,WAAW,YAAY,IAAIA,CAAQ,CACjD,CAGO,QAAQA,EAAqC,CAClD,OAAO,KAAK,WAAW,YAAY,IAAIA,CAAQ,GAAG,IACpD,CAGO,QACLA,EACAM,EACAL,EAAgB,KAAK,IAAI,EACnB,CACN,IAAMO,EAAgC,CACpC,cAAe,KAAK,IAAI,EACxB,QAAS,GACT,KAAAF,EACA,cAAAL,CACF,EAEA,KAAK,WAAW,SAAUQ,IAAU,CAAE,GAAGA,EAAM,CAACT,CAAQ,EAAGQ,CAAM,EAAE,EAEnE,KAAK,iBAAiB,CACxB,CAMA,MAAa,oBAAoBd,EAA6B,CAC5D,IAAMgB,EAAM,KAAK,YAAYhB,CAAI,EACjC,OAAO,MAAM,KAAK,aAAagB,EAAK,GAAGhB,CAAI,CAC7C,CAGO,WAAWM,EAAwB,CAExC,IAAMW,EAAQ,CAAE,GADD,KAAK,WAAW,YAAY,CACjB,EAC1B,OAAOA,EAAMX,CAAQ,EACrB,KAAK,WAAW,SAASW,CAAK,EAE9B,IAAMC,EAAW,KAAK,gBAAgB,IAAIZ,CAAQ,EAC9CY,IACF,KAAK,gBAAgB,OAAOZ,CAAQ,EACpCY,EAAS,gBAAgB,MAAM,SAAS,EAE5C,CAGO,OAAc,CACnB,KAAK,WAAW,OAAO,EAEvB,OAAW,CAAE,gBAAAP,CAAgB,IAAK,MAAM,KACtC,KAAK,gBAAgB,OAAO,CAC9B,EACEA,EAAgB,MAAM,SAAS,EAGjC,KAAK,gBAAgB,MAAM,CAC7B,CAGO,MAAML,EAAwB,CACnC,KAAK,YAAY,IAAIA,GAAW,KAAK,YAAY,IAAIA,CAAQ,GAAK,GAAK,CAAC,CAC1E,CAGO,QAAQA,EAAwB,CACrC,IAAMa,EAAQ,KAAK,YAAY,IAAIb,CAAQ,EACvCa,IAAU,EACZ,KAAK,YAAY,OAAOb,CAAQ,EAEhC,KAAK,YAAY,IAAIA,GAAWa,GAAS,GAAK,CAAC,CAEnD,CAMO,kBAAyB,CAE9B,GAAI,CAAC,KAAK,SAAW,CAAC,KAAK,SACzB,OAGF,IAAMC,EAAW,KAAK,WAAW,YAAY,EACvCC,EAAU,OAAO,KAAKD,CAAQ,EAAE,OAGtC,GAAIC,GAAW,EACb,OAGF,IAAMC,EAAcC,EAAYH,CAAQ,EAEpCI,EAAW,KAAK,QAAUH,EAAU,KAAK,QAAU,EACnDI,EAAa,KAAK,SAAWH,EAAc,KAAK,SAAW,EAG/D,GAAIE,GAAY,GAAKC,GAAc,EAAG,CACpC,KAAK,IACH,4BAA4B,KAAK,SAAS,UAAUJ,CAAO,WAAW,KAAK,OAAO,eAAeC,EAAY,eAAe,CAAC,WAAW,KAAK,SAAS,eAAe,CAAC,GACxK,EACA,MACF,CAGA,KAAK,IACH,gBAAgB,KAAK,SAAS,cAAcE,CAAQ,gBAAgBC,CAAU,EAChF,EAEA,IAAMC,EAAW,CAAE,GAAGN,CAAS,EAC3BO,EAAa,GAEXC,EAAyB,OAAO,QAAQF,CAAQ,EAAE,KACtD,CAACG,EAAQC,IAAWD,EAAO,CAAC,EAAE,cAAgBC,EAAO,CAAC,EAAE,aAC1D,EAEA,OAAW,CAACd,CAAG,IAAKY,EAAwB,CAE1C,GAAI,KAAK,YAAY,IAAIZ,CAAG,EAAG,CAC7B,KAAK,IAAI,mBAAmBA,CAAG,mBAAmB,EAClD,QACF,CAEA,IAAMe,EAAWR,EAAYP,CAAG,EAAIO,EAAYG,EAASV,CAAG,CAAC,EAW7D,GAVA,KAAK,IACH,yBAAyBA,CAAG,cAAce,EAAS,eAAe,CAAC,GACrE,EAEAP,IACAC,GAAcM,EAEd,OAAOL,EAASV,CAAG,EACnBW,EAAa,GAETH,GAAY,GAAKC,GAAc,EACjC,KAEJ,CAGA,GAAI,CAACE,EAAY,CACf,KAAK,IACH,kCAAkC,KAAK,SAAS,UAAUN,CAAO,WAAW,KAAK,OAAO,eAAeC,EAAY,eAAe,CAAC,WAAW,KAAK,SAAS,eAAe,CAAC,GAC9K,EACA,MACF,CAGA,KAAK,WAAW,SAASI,CAAQ,EAGjC,KAAK,IACH,oBAAoB,KAAK,SAAS,WAAWL,CAAO,OAAO,OAAO,KAAKK,CAAQ,EAAE,MAAM,YAAY,KAAK,OAAO,gBAAgBJ,EAAY,eAAe,CAAC,OAAOC,EAAYG,CAAQ,EAAE,eAAe,CAAC,YAAY,KAAK,SAAS,eAAe,CAAC,GACpP,CACF,CACF,EAGMM,EAAiB,IAAI,IAmBpB,SAASC,GAGd/B,EAC2B,CAC3B,GAAI8B,EAAe,IAAI9B,EAAQ,SAAS,EACtC,MAAM,IAAI,MAAM,2BAA2BA,EAAQ,SAAS,GAAG,EAEjE,OAAA8B,EAAe,IAAI9B,EAAQ,SAAS,EAE7B,IAAID,EAAYC,CAAO,CAChC,CAIA,IAAMgC,EAA4D,CAChE,cAAe,EACf,QAAS,EACX,EAUO,SAASC,GACdC,EAEApC,EAAc,CAAC,EACQ,CAEvB,IAAMqC,EAAaC,EAAYtC,CAAI,EAE7B,CAACuC,EAAYC,CAAa,EAAIC,EAAeL,EAAM,UAAU,EAE7DM,EAAYC,EAAO,EAAI,EAEvBrC,EAAWsC,EACf,IAAMR,EAAM,YAAYC,CAAU,EAClC,CAACD,EAAOC,CAAU,CACpB,EAGMQ,EACJN,EAAWjC,CAAQ,GAAK4B,EAEpBY,EAAqBC,EACxBC,GAAiD,CAChDR,EAAezB,GAAS,CACtB,IAAME,EAAQ,CAAE,GAAGF,CAAK,EACxB,OAAAE,EAAMX,CAAQ,EACZ,OAAO0C,GAAS,WACZA,EAAK/B,EAAMX,CAAQ,GAAK4B,CAAyB,EACjDc,EACC/B,CACT,CAAC,CACH,EACA,CAACX,EAAUkC,CAAa,CAC1B,EAIM,CAACS,EAAkBC,CAAmB,EAAIC,EAA4B,EAE5EC,EAAU,IAAM,CACVhB,EAAM,sBAAwBS,EAAgB,OAAS,QACzDK,EAAoBL,EAAgB,IAAI,CAE5C,EAAG,CAACT,EAAM,qBAAsBS,EAAgB,IAAI,CAAC,EAGrD,IAAMQ,EAAUN,EACd,MAAOO,GAA0B,CAC/BlB,EAAM,IAAI,gCAAgC9B,CAAQ,EAAE,EAEpDwC,EAAoB/B,IAAU,CAE5B,GAAGA,EACH,cAAe,KAAK,IAAI,EACxB,QAAS,EACX,EAAE,EAEF,GAAI,CACF,IAAMH,EAAO,MAAO0C,EAChBlB,EAAM,iBAAiB,GAAGC,CAAU,EACpCD,EAAM,iBAAiB,GAAGC,CAAU,GAExC,GAAIK,EAAU,QAAS,CACrB,IAAMa,EAAM,KAAK,IAAI,EAErBT,EAAmB,CAEjB,cAAeS,EACf,QAAS,GACT,KAAA3C,EACA,cAAe2C,CACjB,CAAC,CACH,CACF,OAAS1C,EAAG,CACV,GAAI6B,EAAU,QAAS,CACrB,IAAMa,EAAM,KAAK,IAAI,EAErBT,EAAoB/B,IAAU,CAE5B,GAAGA,EACH,cAAewC,EACf,QAAS,GACT,MAAO1C,EACP,eAAgB0C,CAClB,EAAE,CACJ,CACF,CACF,EACA,CAACnB,EAAO9B,EAAUwC,EAAoBT,CAAU,CAClD,EAEA,OAAAe,EAAU,KACRV,EAAU,QAAU,GACpBN,EAAM,MAAM9B,CAAQ,EAEf+C,EAAQ,EAAK,EAEX,IAAM,CACXX,EAAU,QAAU,GACpBN,EAAM,QAAQ9B,CAAQ,CACxB,GACC,CAAC+C,EAASjB,EAAO9B,CAAQ,CAAC,EAEtBsC,EAAQ,KACN,CACL,GAAGC,EACH,iBAAAI,EAIA,kBAAoBO,GAAqB,CACvC,IAAMC,EAAarB,EAAM,wBAAwB9B,CAAQ,EACzD,OAAAmD,GAAY,MAAMD,CAAM,EACjB,EAAQC,CACjB,EACA,QAAS,IAAM,CACRJ,EAAQ,EAAI,CACnB,EACA,QAAS,CAACzC,EAAaL,IAA2B,CAChD,IAAMgD,EAAM,KAAK,IAAI,EACrBT,EAAoB/B,IAAU,CAC5B,GAAGA,EACH,KAAAH,EACA,cAAeL,GAAiBgD,EAChC,cAAeA,EACf,QAAS,EACX,EAAE,CACJ,EACA,WAAY,IAAM,CAChBf,EAAezB,GAAS,CACtB,IAAME,EAAQ,CAAE,GAAGF,CAAK,EACxB,cAAOE,EAAMX,CAAQ,EACdW,CACT,CAAC,CACH,CACF,GACC,CACDoC,EACAJ,EACAb,EACA9B,EACAuC,EACAL,EACAM,CACF,CAAC,CACH","names":["MS_PER_DAY","getByteSize","useCallback","useEffect","useMemo","useRef","useState","MS_PER_DAY","useSyncExternalStore","kvStore","getStorageAdapter","options","defaultStoreExpiryMs","localStorageKey","indexedDbKey","storeExpiryMs","store","expiryMs","LocalStorageAdapter","IndexedDbAdapter","LocalStorageAdapter","keyPrefix","expiryMs","key","value","fullKey","raw","box","IndexedDbAdapter","kvStore","k","SharedStateDefaults","MS_PER_DAY","PubSubStore","key","value","prev","subscriber","subscribers","next","copy","e","pubSubStore","STORAGE_KEY","stateKey","SharedState","defaultValue","options","getStorageAdapter","lazyLoad","v","sharedState","useSharedState","state","useSyncExternalStore","onStoreChange","stringifyDeterministicForKeys","params","cache","_","value","result","key","isEqual","useMemo","useState","useDeepMemo","value","state","setState","SharedQueryDefaults","MS_PER_DAY","args","SharedQuery","options","persistTo","sharedState","stringifyDeterministicForKeys","queryKey","dataUpdatedMs","cached","inflightQuery","promise","abortController","data","e","entry","prev","key","clone","inflight","count","oldState","oldSize","oldByteSize","getByteSize","numToCut","bytesToCut","newState","needUpdate","entriesByTimeAscending","entry1","entry2","byteSize","seenQueryNames","sharedQuery","DEFAULT_QUERY_STATE_ENTRY","useSharedQuery","query","stableArgs","useDeepMemo","queryState","setQueryState","useSharedState","isMounted","useRef","useMemo","queryStateValue","setQueryStateValue","useCallback","next","lastNonEmptyData","setLastNonEmptyData","useState","useEffect","execute","forceRefresh","now","reason","controller"]}
package/sharedQuery.mjs CHANGED
@@ -1,7 +1,13 @@
1
1
  // src/sharedQuery.ts
2
2
  import { MS_PER_DAY as MS_PER_DAY2 } from "@choksheak/ts-utils/timeConstants";
3
3
  import getByteSize from "object-sizeof";
4
- import { useCallback, useEffect, useMemo as useMemo2, useRef } from "react";
4
+ import {
5
+ useCallback,
6
+ useEffect,
7
+ useMemo as useMemo2,
8
+ useRef,
9
+ useState as useState2
10
+ } from "react";
5
11
 
6
12
  // src/sharedState.ts
7
13
  import { MS_PER_DAY } from "@choksheak/ts-utils/timeConstants";
@@ -177,7 +183,9 @@ var SharedState = class {
177
183
  options,
178
184
  SharedStateDefaults.storeExpiryMs
179
185
  );
180
- this.setValueBounded = (arg) => this.setValue(arg);
186
+ this.setValueBounded = (next) => {
187
+ this.setValue(next);
188
+ };
181
189
  pubSubStore.setNoNotify(this.pubSubKey, defaultValue);
182
190
  const lazyLoad = options?.lazyLoad;
183
191
  const lazy = lazyLoad !== void 0 ? lazyLoad : SharedStateDefaults.lazyLoad;
@@ -282,24 +290,30 @@ function useDeepMemo(value) {
282
290
 
283
291
  // src/sharedQuery.ts
284
292
  var SharedQueryDefaults = {
285
- // Refetch on every page load.
293
+ /** Refetch on every page load. */
286
294
  staleMs: 0,
287
- // Keep in cache for a long time.
295
+ /** Keep in cache for a long time. */
288
296
  expiryMs: 30 * MS_PER_DAY2,
289
- // Always refetch automatically if the data is stale.
297
+ /** Always refetch automatically if the data is stale. */
290
298
  refetchOnStale: true,
291
- // No default persistence configured.
299
+ /** No default persistence configured. */
292
300
  persistTo: void 0,
293
- // 100 is not too large, but please tweak accordingly.
301
+ /** 100 is not too large, but please tweak accordingly. */
294
302
  maxSize: 100,
295
- // 100kb limit before discarding old records.
303
+ /** 100kb limit before discarding old records. */
296
304
  maxBytes: 1e5,
297
- // Default to log to console.
305
+ /** Default to log to console. */
298
306
  log: (...args) => console.log("[sharedQuery]", ...args)
299
307
  };
300
308
  var SharedQuery = class {
301
309
  inflightQueries = /* @__PURE__ */ new Map();
302
310
  queryState;
311
+ /**
312
+ * Keep track of the mounted query keys. This handles the case where an
313
+ * earlier-started query returns later, and when it returns, it was already
314
+ * unmounted, thus making it eligible for clean up right after fetch.
315
+ */
316
+ mountedKeys = /* @__PURE__ */ new Map();
303
317
  queryName;
304
318
  queryFn;
305
319
  expiryMs;
@@ -307,6 +321,7 @@ var SharedQuery = class {
307
321
  refetchOnStale;
308
322
  maxSize;
309
323
  maxBytes;
324
+ keepLastNonEmptyData;
310
325
  log;
311
326
  constructor(options) {
312
327
  this.queryName = options.queryName;
@@ -324,6 +339,7 @@ var SharedQuery = class {
324
339
  }
325
340
  this.maxSize = options?.maxSize ?? SharedQueryDefaults.maxSize;
326
341
  this.maxBytes = options?.maxBytes ?? SharedQueryDefaults.maxBytes;
342
+ this.keepLastNonEmptyData = Boolean(options?.keepLastNonEmptyData);
327
343
  this.log = options?.log ?? SharedQueryDefaults.log;
328
344
  this.queryState = sharedState(
329
345
  {},
@@ -486,6 +502,19 @@ var SharedQuery = class {
486
502
  }
487
503
  this.inflightQueries.clear();
488
504
  }
505
+ /** Keep track of mounted keys. */
506
+ mount(queryKey) {
507
+ this.mountedKeys.set(queryKey, (this.mountedKeys.get(queryKey) ?? 0) + 1);
508
+ }
509
+ /** Clean up mounted keys. */
510
+ unmount(queryKey) {
511
+ const count = this.mountedKeys.get(queryKey);
512
+ if (count === 1) {
513
+ this.mountedKeys.delete(queryKey);
514
+ } else {
515
+ this.mountedKeys.set(queryKey, (count ?? 0) - 1);
516
+ }
517
+ }
489
518
  /**
490
519
  * Discard the oldest entries if the size exceeds the limit. The last
491
520
  * remaining record cannot be deleted no matter what the limit is.
@@ -500,62 +529,48 @@ var SharedQuery = class {
500
529
  return;
501
530
  }
502
531
  const oldByteSize = getByteSize(oldState);
503
- let newState = oldState;
532
+ let numToCut = this.maxSize ? oldSize - this.maxSize : 0;
533
+ let bytesToCut = this.maxBytes ? oldByteSize - this.maxBytes : 0;
534
+ if (numToCut <= 0 && bytesToCut <= 0) {
535
+ this.log(
536
+ `No need to trim data for ${this.queryName}: size=${oldSize} (limit=${this.maxSize}), byteSize=${oldByteSize.toLocaleString()} (limit=${this.maxBytes.toLocaleString()})`
537
+ );
538
+ return;
539
+ }
540
+ this.log(
541
+ `Need to trim ${this.queryName}: numToCut=${numToCut}, bytesToCut=${bytesToCut}`
542
+ );
543
+ const newState = { ...oldState };
504
544
  let needUpdate = false;
505
- if (this.maxSize) {
506
- const numToCut = oldSize - this.maxSize;
507
- if (numToCut > 0) {
508
- this.log(
509
- `enforceSizeLimit for ${this.queryName} needed due to size ${oldSize} > ${this.maxSize}`
510
- );
511
- newState = { ...newState };
512
- needUpdate = true;
513
- Object.entries(newState).sort(
514
- (entry1, entry2) => (
515
- // Sort descending.
516
- entry2[1].lastUpdatedMs - entry1[1].lastUpdatedMs
517
- )
518
- ).slice(-numToCut).forEach(([key]) => {
519
- delete newState[key];
520
- });
545
+ const entriesByTimeAscending = Object.entries(newState).sort(
546
+ (entry1, entry2) => entry1[1].lastUpdatedMs - entry2[1].lastUpdatedMs
547
+ );
548
+ for (const [key] of entriesByTimeAscending) {
549
+ if (this.mountedKeys.has(key)) {
550
+ this.log(`Cannot clean up ${key} as it is mounted`);
551
+ continue;
521
552
  }
522
- }
523
- if (this.maxBytes && Object.keys(newState).length > 1) {
524
- const currentByteSize = needUpdate ? getByteSize(newState) : oldByteSize;
525
- let bytesToCut = currentByteSize - this.maxBytes;
526
- if (bytesToCut > 0) {
527
- this.log(
528
- `enforceSizeLimit for ${this.queryName} needed due to byte size ${currentByteSize.toLocaleString()} > ${this.maxBytes.toLocaleString()}`
529
- );
530
- if (!needUpdate) {
531
- newState = { ...newState };
532
- needUpdate = true;
533
- }
534
- const entriesByTimeAscending = Object.entries(newState).sort(
535
- (entry1, entry2) => entry1[1].lastUpdatedMs - entry2[1].lastUpdatedMs
536
- );
537
- for (
538
- let i = 0;
539
- // Leave the last record entriesByTimeAscending[len-1] untouched.
540
- i < entriesByTimeAscending.length - 1 && bytesToCut > 0;
541
- i++
542
- ) {
543
- const key = entriesByTimeAscending[i][0];
544
- const thisSize = getByteSize(key) + getByteSize(newState[key]);
545
- delete newState[key];
546
- bytesToCut -= thisSize;
547
- }
553
+ const byteSize = getByteSize(key) + getByteSize(newState[key]);
554
+ this.log(
555
+ `Cleaning up unmounted ${key} (byteSize=${byteSize.toLocaleString()})`
556
+ );
557
+ numToCut--;
558
+ bytesToCut -= byteSize;
559
+ delete newState[key];
560
+ needUpdate = true;
561
+ if (numToCut <= 0 && bytesToCut <= 0) {
562
+ break;
548
563
  }
549
564
  }
550
- if (needUpdate) {
551
- this.queryState.setValue(newState);
565
+ if (!needUpdate) {
552
566
  this.log(
553
- `Trimmed data for ${this.queryName}: size=(${oldSize} -> ${Object.keys(newState).length}) (limit=${this.maxSize}), byteSize=(${oldByteSize.toLocaleString()} -> ${getByteSize(newState).toLocaleString()}) (limit=${this.maxBytes.toLocaleString()})`
567
+ `No trimmable entries found for ${this.queryName}: size=${oldSize} (limit=${this.maxSize}), byteSize=${oldByteSize.toLocaleString()} (limit=${this.maxBytes.toLocaleString()})`
554
568
  );
555
569
  return;
556
570
  }
571
+ this.queryState.setValue(newState);
557
572
  this.log(
558
- `No need to trim data for ${this.queryName}: size=${oldSize} (limit=${this.maxSize}), byteSize=${oldByteSize.toLocaleString()} (limit=${this.maxBytes.toLocaleString()})`
573
+ `Trimmed data for ${this.queryName}: size=[${oldSize} -> ${Object.keys(newState).length}] (limit=${this.maxSize}), byteSize=[${oldByteSize.toLocaleString()} -> ${getByteSize(newState).toLocaleString()}] (limit=${this.maxBytes.toLocaleString()})`
559
574
  );
560
575
  }
561
576
  };
@@ -579,23 +594,29 @@ function useSharedQuery(query, args = []) {
579
594
  () => query.getQueryKey(stableArgs),
580
595
  [query, stableArgs]
581
596
  );
582
- const queryStateValue = queryState[queryKey];
597
+ const queryStateValue = queryState[queryKey] ?? DEFAULT_QUERY_STATE_ENTRY;
583
598
  const setQueryStateValue = useCallback(
584
- (arg) => {
599
+ (next) => {
585
600
  setQueryState((prev) => {
586
601
  const clone = { ...prev };
587
- clone[queryKey] = typeof arg === "function" ? arg(clone[queryKey]) : arg;
602
+ clone[queryKey] = typeof next === "function" ? next(clone[queryKey] ?? DEFAULT_QUERY_STATE_ENTRY) : next;
588
603
  return clone;
589
604
  });
590
605
  },
591
606
  [queryKey, setQueryState]
592
607
  );
608
+ const [lastNonEmptyData, setLastNonEmptyData] = useState2();
609
+ useEffect(() => {
610
+ if (query.keepLastNonEmptyData && queryStateValue.data !== void 0) {
611
+ setLastNonEmptyData(queryStateValue.data);
612
+ }
613
+ }, [query.keepLastNonEmptyData, queryStateValue.data]);
593
614
  const execute = useCallback(
594
615
  async (forceRefresh) => {
595
616
  query.log(`Begin executing shared query ${queryKey}`);
596
617
  setQueryStateValue((prev) => ({
597
618
  // Keep old data and error.
598
- ...prev ?? {},
619
+ ...prev,
599
620
  lastUpdatedMs: Date.now(),
600
621
  loading: true
601
622
  }));
@@ -616,7 +637,7 @@ function useSharedQuery(query, args = []) {
616
637
  const now = Date.now();
617
638
  setQueryStateValue((prev) => ({
618
639
  // Keep old data.
619
- ...prev ?? {},
640
+ ...prev,
620
641
  lastUpdatedMs: now,
621
642
  loading: false,
622
643
  error: e,
@@ -629,15 +650,17 @@ function useSharedQuery(query, args = []) {
629
650
  );
630
651
  useEffect(() => {
631
652
  isMounted.current = true;
653
+ query.mount(queryKey);
632
654
  void execute(false);
633
655
  return () => {
634
656
  isMounted.current = false;
657
+ query.unmount(queryKey);
635
658
  };
636
- }, [execute]);
659
+ }, [execute, query, queryKey]);
637
660
  return useMemo2(() => {
638
- const state = queryStateValue ?? DEFAULT_QUERY_STATE_ENTRY;
639
661
  return {
640
- ...state,
662
+ ...queryStateValue,
663
+ lastNonEmptyData,
641
664
  // This works only if the user-given queryFn supports abort. If not,
642
665
  // this function doesn't do anything, since we don't have any means to
643
666
  // abort the running queryFn.
@@ -652,7 +675,7 @@ function useSharedQuery(query, args = []) {
652
675
  setData: (data, dataUpdatedMs) => {
653
676
  const now = Date.now();
654
677
  setQueryStateValue((prev) => ({
655
- ...prev ?? {},
678
+ ...prev,
656
679
  data,
657
680
  dataUpdatedMs: dataUpdatedMs ?? now,
658
681
  lastUpdatedMs: now,
@@ -669,6 +692,7 @@ function useSharedQuery(query, args = []) {
669
692
  };
670
693
  }, [
671
694
  execute,
695
+ lastNonEmptyData,
672
696
  query,
673
697
  queryKey,
674
698
  queryStateValue,
package/sharedState.cjs CHANGED
@@ -201,7 +201,9 @@ var SharedState = class {
201
201
  options,
202
202
  SharedStateDefaults.storeExpiryMs
203
203
  );
204
- this.setValueBounded = (arg) => this.setValue(arg);
204
+ this.setValueBounded = (next) => {
205
+ this.setValue(next);
206
+ };
205
207
  pubSubStore.setNoNotify(this.pubSubKey, defaultValue);
206
208
  const lazyLoad = options?.lazyLoad;
207
209
  const lazy = lazyLoad !== void 0 ? lazyLoad : SharedStateDefaults.lazyLoad;