@choksheak/react-utils 0.3.6 → 0.3.8

package/sharedQuery.d.mts

@@ -1,6 +1,7 @@
-import { SharedStateOptions, SharedState } from './sharedState.mjs';
+import { SetStateAction } from 'react';
+import { SharedStateOptions } from './sharedState.mjs';
 import { PersistTo } from './storage.mjs';
-import 'react';
+import '@choksheak/ts-utils/duration';
 import '@choksheak/ts-utils/storageAdapter';
 
 /**
@@ -16,9 +17,13 @@ import '@choksheak/ts-utils/storageAdapter';
  * records and the total byte size of data can be limited so as to ensure the
  * query does not take up too much memory.
  *
+ * Think of shared queries as like the open source npm package "react-query",
+ * but with strong type-checking and built-in support for persistence.
+ *
  * Example:
  * ```
  *   import { sharedQuery, useSharedQuery } from "@choksheak/react-utils/sharedQuery";
+ *   import { MS_PER_DAY } from "@choksheak/ts-utils/timeConstants";
  *
  *   // Create a new shared query in the top level scope.
  *   // The query function `queryFn` here does not take any arguments.
@@ -37,11 +42,6 @@ import '@choksheak/ts-utils/storageAdapter';
  *     staleMs: MS_PER_DAY,
  *   });
  *
- *   // Note that the query will only start fetching on mount in React.
- *   // But you can do `usersQuery.getCachedOrFetch()` here to prefetch the
- *   // data if necessary.
- *   usersQuery.getCachedOrFetch();
- *
  *   // Example of using a query function with arguments.
  *   export const getUserQuery = sharedQuery({
  *     queryName: "getUser",
@@ -80,7 +80,9 @@ import '@choksheak/ts-utils/storageAdapter';
  *   export const DisplayOneUser: React.FC<{userId: string}> = ({userId}) => {
  *      // Example of using the query with an argument. Whenever the argument
  *      // changes, the data will be fetched and updated automatically.
- *      const user = useSharedQuery(getUserQuery, [userId]);
+ *      const user = useSharedQuery(getUserQuery, userId);
+ *
+ *      // You can check for user.loading and user.error if needed.
  *
  *      return <>User: {user.data ? JSON.stringify(user.data) : "-"}</>;
  *   };
@@ -121,7 +123,7 @@ type UseQueryResult<TData> = QueryStateValue<TData> & Readonly<{
     /**
      * Manually refresh the data by doing a new query.
      */
-    refetch: () => void;
+    refetch: () => Promise<void>;
     /**
      * If you got the data from somewhere else (e.g. an in-memory data update),
      * just set it directly.
@@ -211,16 +213,25 @@ declare const SharedQueryConfig: {
 type SharedQueryConfig = typeof SharedQueryConfig;
 /** Convenience function to update global defaults. */
 declare function configureSharedQuery(config: Partial<SharedQueryConfig>): void;
-/** Please use sharedQuery() instead. */
-declare class SharedQuery<TArgs extends unknown[], TData> {
-    private readonly inflightQueries;
-    readonly queryState: SharedState<SharedQueryState<TData>>;
-    /**
-     * Keep track of the mounted query keys. This handles the case where an
-     * earlier-started query returns later, and when it returns, it was already
-     * unmounted, thus making it eligible for clean up right after fetch.
-     */
-    private readonly mountedKeys;
+/**
+ * Create a reusable shared query object that can be used to auto de-duplicate
+ * and cache all data fetches, with auto-expiration and staleness checks.
+ *
+ * Each `queryName` must be unique, and can only be declared once, most often
+ * in the top level scope. The queryName is mainly used for logging and also
+ * used as the storage key when you use the top-level `persistTo`.
+ *
+ * Example:
+ * ```
+ *   export const usersQuery = sharedQuery({
+ *     queryName: "users",
+ *     queryFn: listUsers,
+ *     persistTo: "indexedDb",
+ *     staleMs: MS_PER_DAY,
+ *   });
+ * ```
+ */
+declare function sharedQuery<TArgs extends unknown[], TData>(options: SharedQueryOptions<TArgs, TData>): {
     readonly queryName: string;
     readonly queryFn: QueryFn<TArgs, TData>;
     readonly refetchFn: QueryFn<TArgs, TData> | undefined;
@@ -231,9 +242,22 @@ declare class SharedQuery<TArgs extends unknown[], TData> {
     readonly maxBytes: number;
     readonly keepLastNonEmptyData: boolean;
     readonly log: (...args: unknown[]) => void;
-    constructor(options: SharedQueryOptions<TArgs, TData>);
+    readonly queryState: {
+        readonly readyPromise: Promise<void>;
+        readonly lazy: boolean;
+        readonly initStarted: false;
+        readonly initDone: false;
+        readonly subscribe: (subscriber: () => void) => () => void;
+        readonly hasStore: () => boolean;
+        readonly setInStore: (value: SharedQueryState<TData>) => Promise<void>;
+        readonly getFromStore: () => Promise<SharedQueryState<TData> | undefined>;
+        readonly getSnapshot: () => SharedQueryState<TData>;
+        readonly setValue: (next: SetStateAction<SharedQueryState<TData>>) => void;
+        readonly delete: () => void;
+        readonly initDefaultValueOnce: () => Promise<void>;
+    };
     /** Returns a key to identify requests based on the given args. */
-    getQueryKey(args: TArgs): string;
+    readonly getQueryKey: (args: TArgs) => string;
     /**
      * Get the AbortController to abort the inflight query (if any).
      *
@@ -241,8 +265,8 @@ declare class SharedQuery<TArgs extends unknown[], TData> {
      * using `controller.signal`. So if you need both the controller and the
      * signal, just use this function.
      */
-    getAbortController(args: TArgs): AbortController | null;
-    getAbortControllerByKey(queryKey: string): AbortController | null;
+    readonly getAbortController: (args: TArgs) => AbortController | null;
+    readonly getAbortControllerByKey: (queryKey: string) => AbortController | null;
     /**
      * Get the AbortSignal to check for query abortions.
      *
@@ -268,62 +292,41 @@ declare class SharedQuery<TArgs extends unknown[], TData> {
      *   });
      * ```
      */
-    getAbortSignal(args: TArgs): AbortSignal | null;
-    getAbortSignalByKey(queryKey: string): AbortSignal | null;
-    private isStale;
-    private isExpired;
+    readonly getAbortSignal: (args: TArgs) => AbortSignal | null;
+    readonly getAbortSignalByKey: (queryKey: string) => AbortSignal | null;
     /** For cached data, we need to return the correct timestamps as well. */
-    getCachedOrFetch(...args: TArgs): Promise<QueryStateValue<TData>>;
-    private dedupedFetch;
-    private startFetching;
+    readonly getCachedOrFetch: (...args: TArgs) => Promise<QueryStateValue<TData>>;
     /** Get the entire stored entry for a query key. */
-    getQueryValue(queryKey: string): QueryStateValue<TData> | undefined;
+    readonly getQueryValue: (queryKey: string) => QueryStateValue<TData> | undefined;
     /** Get the current stored data for a query key. */
-    getData(queryKey: string): TData | undefined;
+    readonly getData: (queryKey: string) => TData | undefined;
     /** Set the data directly if the user obtained it from somewhere else. */
-    setData(queryKey: string, data: TData, dataUpdatedMs?: number): void;
+    readonly setData: (queryKey: string, data: TData, dataUpdatedMs?: number) => void;
     /**
      * Do a new fetch even when the data is already cached, but don't fetch if
      * another fetch is already inflight.
      */
-    updateFromSource(...args: TArgs): Promise<TData>;
+    readonly updateFromSource: (...args: TArgs) => Promise<TData>;
     /**
      * Perform an explicit refetch. If `options.refetchFn` was not specified,
-     * then this would be identical to calling `this.updateFromSource()`.
+     * then this would be identical to calling `obj.updateFromSource()`.
      */
-    refetch(...args: TArgs): Promise<TData>;
+    readonly refetch: (...args: TArgs) => Promise<TData>;
     /** Delete the cached data for one set of arguments. */
-    deleteData(queryKey: string): void;
+    readonly deleteData: (queryKey: string) => void;
     /** Delete all currently cached data & all inflight promises. */
-    clear(): void;
+    readonly clear: () => void;
     /** Keep track of mounted keys. */
-    mount(queryKey: string): void;
+    readonly mount: (queryKey: string) => void;
     /** Clean up mounted keys. */
-    unmount(queryKey: string): void;
+    readonly unmount: (queryKey: string) => void;
     /**
      * Discard the oldest entries if the size exceeds the limit. The last
      * remaining record cannot be deleted no matter what the limit is.
      */
-    enforceSizeLimit(): void;
-}
-/**
- * Create a reusable shared query object that can be used to auto de-duplicate
- * and cache all data fetches, with auto-expiration and staleness checks.
- *
- * Each `queryName` must be unique, and can only be declared once, most often
- * in the top level scope. The queryName is used for logging only.
- *
- * Example:
- * ```
- *   export const usersQuery = sharedQuery({
- *     queryName: "users",
- *     queryFn: listUsers,
- *     persistTo: "indexedDb",
- *     staleMs: MS_PER_DAY,
- *   });
- * ```
- */
-declare function sharedQuery<TArgs extends unknown[], TData>(options: SharedQueryOptions<TArgs, TData>): SharedQuery<TArgs, TData>;
+    readonly enforceSizeLimit: () => void;
+};
+type SharedQuery<TArgs extends unknown[], TData> = ReturnType<typeof sharedQuery<TArgs, TData>>;
 /**
  * React hook to make use of a shared query inside any React component. The
  * args do not need to be specified if no args are needed, i.e. this would work
@@ -338,4 +341,4 @@ declare function sharedQuery<TArgs extends unknown[], TData>(options: SharedQuer
  */
 declare function useSharedQuery<TArgs extends unknown[], TData>(query: SharedQuery<TArgs, TData>, ...args: TArgs): UseQueryResult<TData>;
 
-export { type QueryFn, type QueryStateValue, SharedQuery, SharedQueryConfig, type SharedQueryOptions, type SharedQueryState, type UseQueryResult, configureSharedQuery, sharedQuery, useSharedQuery };
+export { type QueryFn, type QueryStateValue, type SharedQuery, SharedQueryConfig, type SharedQueryOptions, type SharedQueryState, type UseQueryResult, configureSharedQuery, sharedQuery, useSharedQuery };

package/sharedQuery.d.ts

@@ -11,9 +11,13 @@
  * records and the total byte size of data can be limited so as to ensure the
  * query does not take up too much memory.
  *
+ * Think of shared queries as like the open source npm package "react-query",
+ * but with strong type-checking and built-in support for persistence.
+ *
  * Example:
  * ```
  *   import { sharedQuery, useSharedQuery } from "@choksheak/react-utils/sharedQuery";
+ *   import { MS_PER_DAY } from "@choksheak/ts-utils/timeConstants";
  *
  *   // Create a new shared query in the top level scope.
  *   // The query function `queryFn` here does not take any arguments.
@@ -32,11 +36,6 @@
  *     staleMs: MS_PER_DAY,
  *   });
  *
- *   // Note that the query will only start fetching on mount in React.
- *   // But you can do `usersQuery.getCachedOrFetch()` here to prefetch the
- *   // data if necessary.
- *   usersQuery.getCachedOrFetch();
- *
  *   // Example of using a query function with arguments.
  *   export const getUserQuery = sharedQuery({
  *     queryName: "getUser",
@@ -75,13 +74,16 @@
  *   export const DisplayOneUser: React.FC<{userId: string}> = ({userId}) => {
  *      // Example of using the query with an argument. Whenever the argument
  *      // changes, the data will be fetched and updated automatically.
- *      const user = useSharedQuery(getUserQuery, [userId]);
+ *      const user = useSharedQuery(getUserQuery, userId);
+ *
+ *      // You can check for user.loading and user.error if needed.
  *
  *      return <>User: {user.data ? JSON.stringify(user.data) : "-"}</>;
  *   };
  * ```
  */
-import { SharedState, SharedStateOptions } from "./sharedState";
+import { SetStateAction } from "react";
+import { SharedStateOptions } from "./sharedState";
 import { PersistTo } from "./storage";
 /** Type of the queryFn used to fetch the data from source. */
 export type QueryFn<TArgs extends unknown[], TData> = (...args: TArgs) => Promise<TData> | TData;
@@ -117,7 +119,7 @@ export type UseQueryResult<TData> = QueryStateValue<TData> & Readonly<{
     /**
      * Manually refresh the data by doing a new query.
      */
-    refetch: () => void;
+    refetch: () => Promise<void>;
     /**
      * If you got the data from somewhere else (e.g. an in-memory data update),
      * just set it directly.
@@ -207,16 +209,25 @@ export declare const SharedQueryConfig: {
 export type SharedQueryConfig = typeof SharedQueryConfig;
 /** Convenience function to update global defaults. */
 export declare function configureSharedQuery(config: Partial<SharedQueryConfig>): void;
-/** Please use sharedQuery() instead. */
-export declare class SharedQuery<TArgs extends unknown[], TData> {
-    private readonly inflightQueries;
-    readonly queryState: SharedState<SharedQueryState<TData>>;
-    /**
-     * Keep track of the mounted query keys. This handles the case where an
-     * earlier-started query returns later, and when it returns, it was already
-     * unmounted, thus making it eligible for clean up right after fetch.
-     */
-    private readonly mountedKeys;
+/**
+ * Create a reusable shared query object that can be used to auto de-duplicate
+ * and cache all data fetches, with auto-expiration and staleness checks.
+ *
+ * Each `queryName` must be unique, and can only be declared once, most often
+ * in the top level scope. The queryName is mainly used for logging and also
+ * used as the storage key when you use the top-level `persistTo`.
+ *
+ * Example:
+ * ```
+ *   export const usersQuery = sharedQuery({
+ *     queryName: "users",
+ *     queryFn: listUsers,
+ *     persistTo: "indexedDb",
+ *     staleMs: MS_PER_DAY,
+ *   });
+ * ```
+ */
+export declare function sharedQuery<TArgs extends unknown[], TData>(options: SharedQueryOptions<TArgs, TData>): {
     readonly queryName: string;
     readonly queryFn: QueryFn<TArgs, TData>;
     readonly refetchFn: QueryFn<TArgs, TData> | undefined;
@@ -227,9 +238,22 @@ export declare class SharedQuery<TArgs extends unknown[], TData> {
     readonly maxBytes: number;
     readonly keepLastNonEmptyData: boolean;
     readonly log: (...args: unknown[]) => void;
-    constructor(options: SharedQueryOptions<TArgs, TData>);
+    readonly queryState: {
+        readonly readyPromise: Promise<void>;
+        readonly lazy: boolean;
+        readonly initStarted: false;
+        readonly initDone: false;
+        readonly subscribe: (subscriber: () => void) => () => void;
+        readonly hasStore: () => boolean;
+        readonly setInStore: (value: SharedQueryState<TData>) => Promise<void>;
+        readonly getFromStore: () => Promise<SharedQueryState<TData> | undefined>;
+        readonly getSnapshot: () => SharedQueryState<TData>;
+        readonly setValue: (next: SetStateAction<SharedQueryState<TData>>) => void;
+        readonly delete: () => void;
+        readonly initDefaultValueOnce: () => Promise<void>;
+    };
     /** Returns a key to identify requests based on the given args. */
-    getQueryKey(args: TArgs): string;
+    readonly getQueryKey: (args: TArgs) => string;
     /**
      * Get the AbortController to abort the inflight query (if any).
      *
@@ -237,8 +261,8 @@ export declare class SharedQuery<TArgs extends unknown[], TData> {
      * using `controller.signal`. So if you need both the controller and the
      * signal, just use this function.
      */
-    getAbortController(args: TArgs): AbortController | null;
-    getAbortControllerByKey(queryKey: string): AbortController | null;
+    readonly getAbortController: (args: TArgs) => AbortController | null;
+    readonly getAbortControllerByKey: (queryKey: string) => AbortController | null;
     /**
      * Get the AbortSignal to check for query abortions.
      *
@@ -264,62 +288,41 @@ export declare class SharedQuery<TArgs extends unknown[], TData> {
      *   });
      * ```
      */
-    getAbortSignal(args: TArgs): AbortSignal | null;
-    getAbortSignalByKey(queryKey: string): AbortSignal | null;
-    private isStale;
-    private isExpired;
+    readonly getAbortSignal: (args: TArgs) => AbortSignal | null;
+    readonly getAbortSignalByKey: (queryKey: string) => AbortSignal | null;
     /** For cached data, we need to return the correct timestamps as well. */
-    getCachedOrFetch(...args: TArgs): Promise<QueryStateValue<TData>>;
-    private dedupedFetch;
-    private startFetching;
+    readonly getCachedOrFetch: (...args: TArgs) => Promise<QueryStateValue<TData>>;
     /** Get the entire stored entry for a query key. */
-    getQueryValue(queryKey: string): QueryStateValue<TData> | undefined;
+    readonly getQueryValue: (queryKey: string) => QueryStateValue<TData> | undefined;
     /** Get the current stored data for a query key. */
-    getData(queryKey: string): TData | undefined;
+    readonly getData: (queryKey: string) => TData | undefined;
     /** Set the data directly if the user obtained it from somewhere else. */
-    setData(queryKey: string, data: TData, dataUpdatedMs?: number): void;
+    readonly setData: (queryKey: string, data: TData, dataUpdatedMs?: number) => void;
     /**
      * Do a new fetch even when the data is already cached, but don't fetch if
      * another fetch is already inflight.
      */
-    updateFromSource(...args: TArgs): Promise<TData>;
+    readonly updateFromSource: (...args: TArgs) => Promise<TData>;
     /**
      * Perform an explicit refetch. If `options.refetchFn` was not specified,
-     * then this would be identical to calling `this.updateFromSource()`.
+     * then this would be identical to calling `obj.updateFromSource()`.
      */
-    refetch(...args: TArgs): Promise<TData>;
+    readonly refetch: (...args: TArgs) => Promise<TData>;
     /** Delete the cached data for one set of arguments. */
-    deleteData(queryKey: string): void;
+    readonly deleteData: (queryKey: string) => void;
     /** Delete all currently cached data & all inflight promises. */
-    clear(): void;
+    readonly clear: () => void;
     /** Keep track of mounted keys. */
-    mount(queryKey: string): void;
+    readonly mount: (queryKey: string) => void;
     /** Clean up mounted keys. */
-    unmount(queryKey: string): void;
+    readonly unmount: (queryKey: string) => void;
     /**
      * Discard the oldest entries if the size exceeds the limit. The last
      * remaining record cannot be deleted no matter what the limit is.
      */
-    enforceSizeLimit(): void;
-}
-/**
- * Create a reusable shared query object that can be used to auto de-duplicate
- * and cache all data fetches, with auto-expiration and staleness checks.
- *
- * Each `queryName` must be unique, and can only be declared once, most often
- * in the top level scope. The queryName is used for logging only.
- *
- * Example:
- * ```
- *   export const usersQuery = sharedQuery({
- *     queryName: "users",
- *     queryFn: listUsers,
- *     persistTo: "indexedDb",
- *     staleMs: MS_PER_DAY,
- *   });
- * ```
- */
-export declare function sharedQuery<TArgs extends unknown[], TData>(options: SharedQueryOptions<TArgs, TData>): SharedQuery<TArgs, TData>;
+    readonly enforceSizeLimit: () => void;
+};
+export type SharedQuery<TArgs extends unknown[], TData> = ReturnType<typeof sharedQuery<TArgs, TData>>;
 /**
  * React hook to make use of a shared query inside any React component. The
  * args do not need to be specified if no args are needed, i.e. this would work

package/sharedQuery.min.cjs

@@ -1,2 +1,2 @@
-"use strict";var q=Object.create;var w=Object.defineProperty;var _=Object.getOwnPropertyDescriptor;var j=Object.getOwnPropertyNames;var Y=Object.getPrototypeOf,I=Object.prototype.hasOwnProperty;var J=(r,e)=>{for(var t in e)w(r,t,{get:e[t],enumerable:!0})},$=(r,e,t,a)=>{if(e&&typeof e=="object"||typeof e=="function")for(let s of j(e))!I.call(r,s)&&s!==t&&w(r,s,{get:()=>e[s],enumerable:!(a=_(e,s))||a.enumerable});return r};var O=(r,e,t)=>(t=r!=null?q(Y(r)):{},$(e||!r||!r.__esModule?w(t,"default",{value:r,enumerable:!0}):t,r)),W=r=>$(w({},"__esModule",{value:!0}),r);var ee={};J(ee,{SharedQuery:()=>A,SharedQueryConfig:()=>g,configureSharedQuery:()=>H,sharedQuery:()=>X,useSharedQuery:()=>Z});module.exports=W(ee);var R=require("@choksheak/ts-utils/timeConstants"),D=O(require("object-sizeof")),y=require("react");var C=require("@choksheak/ts-utils/timeConstants"),V=require("react");var T=require("@choksheak/ts-utils/kvStore"),B=require("@choksheak/ts-utils/localStore"),S=typeof window>"u";function K(r,e){let{store:t}=r??{};if(!t)return null;if("persistTo"in t&&typeof t.persistTo=="string"&&"key"in t&&typeof t.key=="string"){let a=t.expiryMs||e,s=t.isValid;switch(t.persistTo){case"localStorage":{let n=new B.LocalStore(t.key,{defaultExpiryMs:a});return{set:(i,o)=>{S||n.set(i,o)},get:i=>{if(S)return;let o=n.get(i);if(s&&!s(o)){console.warn(`localStorage adapter: Auto-discard invalid value for ${i}: ${JSON.stringify(o)}`),n.delete(i);return}return o},delete:i=>{S||n.delete(i)},clear:()=>{S||n.clear()}}}case"indexedDb":{let n=t.key+":",i=t.isValid;return{set:async(o,c)=>{S||await T.kvStore.set(n+o,c,a)},get:async o=>{if(S)return;let c=n+o,h=await T.kvStore.get(c);if(i&&!i(h)){console.warn(`indexedDb adapter: Auto-discard invalid value for ${o}: ${JSON.stringify(h)}`),await T.kvStore.delete(c);return}return h},delete:async o=>{S||await T.kvStore.delete(n+o)},clear:async()=>{S||await T.kvStore.clear()}}}default:throw t.persistTo,new Error(`Unknown store.adapter ${t.persistTo}`)}}return t}var N={storeExpiryMs:30*C.MS_PER_DAY,lazyLoad:!1};var Q=class{dataByKey=new Map;subscribersByKey=new Map;get(e){return this.dataByKey.get(e)}set(e,t){let a=this.dataByKey.get(e);a!==t&&(this.dataByKey.set(e,t),this.notify(e,t,a))}delete(e){this.dataByKey.delete(e)}setNoNotify(e,t){this.dataByKey.set(e,t)}subscribe(e,t){let a=this.subscribersByKey.get(e);return a||(a=new Set,this.subscribersByKey.set(e,a)),a.add(t),()=>{a.delete(t),a.size===0&&this.subscribersByKey.delete(e)}}notify(e,t,a){let s=this.subscribersByKey.get(e);if(!s)return;let n=Array.from(s.values());for(let i of n)try{i(t,a)}catch(o){console.error("Error invoking subscriber:",o)}}},b=new Q,M="state",G=0,v=class{constructor(e,t){this.defaultValue=e;let a=()=>{};this.readyPromise=new Promise(i=>{a=i}),this.resolveReadyPromise=a,this.pubSubKey=String(G++),this.storageAdapter=K(t,N.storeExpiryMs),this.setValueBounded=i=>{this.setValue(i)},b.setNoNotify(this.pubSubKey,e);let s=t?.lazyLoad;(s!==void 0?s:N.lazyLoad)||this.initDefaultValueOnce()}pubSubKey;storageAdapter;setValueBounded;initStarted=!1;initDone=!1;readyPromise;resolveReadyPromise;subscribe(e){return b.subscribe(this.pubSubKey,()=>e())}hasStore(){return!!this.storageAdapter}async setInStore(e){return await this.storageAdapter?.set(M,e)}async getFromStore(){return await this.storageAdapter?.get(M)}getSnapshot(){return b.get(this.pubSubKey)}setValue(e){if(typeof e=="function"){let t=b.get(this.pubSubKey);e=e(t)}b.set(this.pubSubKey,e),this.setInStore(e)}delete(){b.set(this.pubSubKey,this.defaultValue),this.storageAdapter?.set(M,this.defaultValue)}async initDefaultValueOnce(){if(this.initDone||this.initStarted)return;this.initStarted=!0;let e=await this.getFromStore(),t=e!==void 0?e:this.defaultValue;b.set(this.pubSubKey,t),this.initDone=!0,this.resolveReadyPromise()}};function z(r,e){return new v(r,e)}function F(r){return r.initDefaultValueOnce(),[(0,V.useSyncExternalStore)(t=>r.subscribe(t),()=>r.getSnapshot(),()=>r.getSnapshot()),r.setValueBounded]}function k(r){let e=new Set;return JSON.stringify(r,(t,a)=>{if(typeof a=="function")throw new Error("Functions should not be passed into query parameters");if(!a||typeof a!="object"||Array.isArray(a))return a;if(e.has(a))return"[Circular]";if(e.add(a),a!==r)try{JSON.stringify(a)}catch{return"[Unserializable]"}return Object.keys(a).sort().reduce((s,n)=>(s[n]=a[n],s),{})})}var E=O(require("lodash/isEqual")),x=require("react");function U(r){let[e,t]=(0,x.useState)(r);return(0,x.useMemo)(()=>e===r||(0,E.default)(e,r)?e:(t(r),r),[e,r])}var g={staleMs:0,expiryMs:30*R.MS_PER_DAY,refetchOnStale:!0,persistTo:void 0,maxSize:100,maxBytes:1e5,log:(...r)=>console.log("[sharedQuery]",...r)};function H(r){Object.assign(g,r)}var A=class{inflightQueries=new Map;queryState;mountedKeys=new Map;queryName;queryFn;refetchFn;expiryMs;staleMs;refetchOnStale;maxSize;maxBytes;keepLastNonEmptyData;log;constructor(e){if(this.queryName=e.queryName,this.queryFn=e.queryFn,this.refetchFn=e.refetchFn,this.staleMs=e?.staleMs??g.staleMs,this.expiryMs=e?.expiryMs??g.expiryMs,this.refetchOnStale=e?.refetchOnStale??g.refetchOnStale,!e.store){let t=e.persistTo??g.persistTo;t&&(e.store={persistTo:t,key:e.queryName,expiryMs:this.expiryMs})}this.maxSize=e?.maxSize??g.maxSize,this.maxBytes=e?.maxBytes??g.maxBytes,this.keepLastNonEmptyData=!!e?.keepLastNonEmptyData,this.log=e?.log??g.log,this.queryState=z({},e)}getQueryKey(e){return this.queryName+":"+k(e)}getAbortController(e){let t=this.getQueryKey(e);return this.getAbortControllerByKey(t)}getAbortControllerByKey(e){return this.inflightQueries.get(e)?.abortController??null}getAbortSignal(e){let t=this.getQueryKey(e);return this.getAbortSignalByKey(t)}getAbortSignalByKey(e){return this.getAbortControllerByKey(e)?.signal??null}isStale(e){return this.staleMs===0?!0:Date.now()-e>this.staleMs}isExpired(e){return this.expiryMs===0?!1:Date.now()-e>this.expiryMs}async getCachedOrFetch(...e){let t=Date.now();await this.queryState.readyPromise;let a=Date.now()-t,s=this.getQueryKey(e),n=this.queryState.getSnapshot()?.[s];if(a&&this.log(`${s}: Waited for ${a}ms before data is ready`),n?.data&&!this.isExpired(n.dataUpdatedMs??0))return this.isStale(n.dataUpdatedMs??0)?(this.refetchOnStale&&(this.log(`refetchOnStale for ${s}`),this.dedupedFetch(s,"query",...e)),this.log(`Returning stale data for ${s}`),n):(this.log(`Return fresh data ${s} from cache without fetching`),n);let i=await this.dedupedFetch(s,"query",...e),o=Date.now();return{lastUpdatedMs:o,loading:!1,data:i,dataUpdatedMs:o}}dedupedFetch(e,t,...a){let s=this.inflightQueries.get(e);if(s)return this.log(`Deduplicating inflight fetch for ${e}, queryType=${t}`),s.promise;let n=this.startFetching(e,t,a),i=new AbortController;return this.inflightQueries.set(e,{promise:n,abortController:i}),n}async startFetching(e,t,a){this.log(`Start fetching ${e}, queryType=${t}`);try{let s=await(t==="refetch"&&this.refetchFn?this.refetchFn(...a):this.queryFn(...a));return this.log(`Successfully fetched ${e}`),this.setData(e,s,Date.now()),s}catch(s){throw this.log(`Failed to fetch ${e} for queryType=${t}: ${s}`),s}finally{this.inflightQueries.delete(e)}}getQueryValue(e){return this.queryState.getSnapshot()?.[e]}getData(e){let t=this.queryState.getSnapshot()?.[e];if(t?.lastUpdatedMs&&this.isExpired(t.lastUpdatedMs)){this.deleteData(e);return}return t?.data}setData(e,t,a=Date.now()){let s={lastUpdatedMs:Date.now(),loading:!1,data:t,dataUpdatedMs:a};this.queryState.setValue(n=>({...n,[e]:s})),this.enforceSizeLimit()}async updateFromSource(...e){let t=this.getQueryKey(e);return await this.dedupedFetch(t,"query",...e)}async refetch(...e){let t=this.getQueryKey(e);return await this.dedupedFetch(t,"refetch",...e)}deleteData(e){let a={...this.queryState.getSnapshot()};delete a[e],this.queryState.setValue(a);let s=this.inflightQueries.get(e);s&&(this.inflightQueries.delete(e),s.abortController.abort("Deleted"))}clear(){this.queryState.delete();for(let{abortController:e}of Array.from(this.inflightQueries.values()))e.abort("Cleared");this.inflightQueries.clear()}mount(e){this.mountedKeys.set(e,(this.mountedKeys.get(e)??0)+1)}unmount(e){let t=this.mountedKeys.get(e);t===1?this.mountedKeys.delete(e):this.mountedKeys.set(e,(t??0)-1)}enforceSizeLimit(){if(!this.maxSize&&!this.maxBytes)return;let e=this.queryState.getSnapshot(),t=Object.keys(e).length;if(t<=1)return;let a=(0,D.default)(e),s=this.maxSize?t-this.maxSize:0,n=this.maxBytes?a-this.maxBytes:0;if(s<=0&&n<=0){this.log(`No need to trim data for ${this.queryName}: size=${t} (limit=${this.maxSize}), byteSize=${a.toLocaleString()} (limit=${this.maxBytes.toLocaleString()})`);return}this.log(`Need to trim ${this.queryName}: numToCut=${s}, bytesToCut=${n}`);let i={...e},o=!1,c=(u,f)=>{if(this.mountedKeys.has(u)){this.log(`Cannot clean up ${u} as it is mounted`);return}let l=(0,D.default)(u)+(0,D.default)(i[u]);this.log(`Cleaning up unmounted${f?", expired":""} ${u} (byteSize=${l.toLocaleString()})`),s--,n-=l,delete i[u],o=!0},h=Object.entries(i).sort((u,f)=>u[1].lastUpdatedMs-f[1].lastUpdatedMs);for(let[u]of h){if(!this.isExpired(i[u].lastUpdatedMs))break;c(u,!0)}if(s>0||n>0){o&&(h=Object.entries(i).sort((u,f)=>u[1].lastUpdatedMs-f[1].lastUpdatedMs));for(let[u]of h)if(c(u,!1),s<=0&&n<=0)break}if(!o){this.log(`No trimmable entries found for ${this.queryName}: size=${t} (limit=${this.maxSize}), byteSize=${a.toLocaleString()} (limit=${this.maxBytes.toLocaleString()})`);return}this.queryState.setValue(i),this.log(`Trimmed data for ${this.queryName}: size=[${t} -> ${Object.keys(i).length}] (limit=${this.maxSize}), byteSize=[${a.toLocaleString()} -> ${(0,D.default)(i).toLocaleString()}] (limit=${this.maxBytes.toLocaleString()})`)}},P=new Set;function X(r){if(P.has(r.queryName))throw new Error(`Duplicate shared query "${r.queryName}"`);return P.add(r.queryName),new A(r)}var L={lastUpdatedMs:0,loading:!0};function Z(r,...e){let t=U(e),[a,s]=F(r.queryState),n=(0,y.useRef)(!0),i=(0,y.useMemo)(()=>r.getQueryKey(t),[r,t]),o=a[i]??L,c=(0,y.useCallback)(l=>{s(d=>{let p={...d};return p[i]=typeof l=="function"?l(p[i]??L):l,p})},[i,s]),[h,u]=(0,y.useState)();(0,y.useEffect)(()=>{r.keepLastNonEmptyData&&o.data!==void 0&&u(o.data)},[r.keepLastNonEmptyData,o.data]);let f=(0,y.useCallback)(async l=>{if(r.log(`Begin executing shared query ${i}, isRefetch=${l}`),!!n.current){c(d=>({...d,lastUpdatedMs:Date.now(),loading:!0}));try{let d;if(l){let p=await r.refetch(...t),m=Date.now();d={lastUpdatedMs:m,loading:!1,data:p,dataUpdatedMs:m}}else d=await r.getCachedOrFetch(...t);if(!n.current)return;c({...d,loading:!1})}catch(d){if(!n.current)return;let p=Date.now();c(m=>({...m,lastUpdatedMs:p,loading:!1,error:d,errorUpdatedMs:p}))}}},[r,i,c,t]);return(0,y.useEffect)(()=>(n.current=!0,r.mount(i),f(!1),()=>{n.current=!1,r.unmount(i)}),[f,r,i]),(0,y.useMemo)(()=>({...o,lastNonEmptyData:h,abortCurrentQuery:l=>{let d=r.getAbortControllerByKey(i);return d?.abort(l),!!d},refetch:()=>{f(!0)},setData:(l,d)=>{let p=Date.now();c(m=>({...m,data:l,dataUpdatedMs:d??p,lastUpdatedMs:p,loading:!1}))},deleteData:()=>{s(l=>{let d={...l};return delete d[i],d})}}),[f,h,r,i,o,s,c])}0&&(module.exports={SharedQuery,SharedQueryConfig,configureSharedQuery,sharedQuery,useSharedQuery});
+"use strict";var ae=Object.create;var P=Object.defineProperty;var oe=Object.getOwnPropertyDescriptor;var se=Object.getOwnPropertyNames;var ie=Object.getPrototypeOf,ue=Object.prototype.hasOwnProperty;var de=(e,o)=>{for(var n in o)P(e,n,{get:o[n],enumerable:!0})},K=(e,o,n,r)=>{if(o&&typeof o=="object"||typeof o=="function")for(let a of se(o))!ue.call(e,a)&&a!==n&&P(e,a,{get:()=>o[a],enumerable:!(r=oe(o,a))||r.enumerable});return e};var j=(e,o,n)=>(n=e!=null?ae(ie(e)):{},K(o||!e||!e.__esModule?P(n,"default",{value:e,enumerable:!0}):n,e)),ce=e=>K(P({},"__esModule",{value:!0}),e);var me={};de(me,{SharedQueryConfig:()=>M,configureSharedQuery:()=>pe,sharedQuery:()=>ye,useSharedQuery:()=>Te});module.exports=ce(me);var re=require("@choksheak/ts-utils/timeConstants"),U=j(require("object-sizeof")),b=require("react");var J=require("@choksheak/ts-utils/timeConstants"),W=require("react");var O=require("@choksheak/ts-utils/kvStore"),_=require("@choksheak/ts-utils/localStore"),x=typeof window>"u";function Y(e,o){let{store:n}=e??{};if(!n)return null;if("persistTo"in n&&typeof n.persistTo=="string"&&"key"in n&&typeof n.key=="string"){let r=n.expiryMs||o,a={...n,expiryMs:r};switch(n.persistTo){case"localStorage":return le(a);case"indexedDb":return fe(a);default:throw n.persistTo,new Error(`Unknown store.adapter ${n.persistTo}`)}}return n}function le({key:e,expiryMs:o,isValid:n}){let r=(0,_.createLocalStore)(e,{defaultExpiryMs:o});return{set:(a,s)=>{x||r.set(a,s)},get:a=>{if(x)return;let s=r.get(a);if(n&&!n(s)){console.warn(`localStorage adapter: Auto-discard invalid value for ${a}: ${JSON.stringify(s)}`),r.delete(a);return}return s},delete:a=>{x||r.delete(a)},clear:()=>{x||r.clear()}}}function fe({key:e,expiryMs:o,isValid:n}){let r=e+":";return{set:async(a,s)=>{x||await O.kvStore.set(r+a,s,o)},get:async a=>{if(x)return;let s=r+a,u=await O.kvStore.get(s);if(u!==void 0&&n&&!n(u)){console.warn(`indexedDb adapter: Auto-discard invalid value for ${a}:`,u),await O.kvStore.delete(s);return}return u},delete:async a=>{x||await O.kvStore.delete(r+a)},clear:async()=>{x||await O.kvStore.clear()}}}var I={storeExpiryMs:30*J.MS_PER_DAY,lazyLoad:!1};function ge(){let e=new Map,o=new Map;function n(r,a,s){let u=o.get(r);if(!u)return;let T=Array.from(u.values());for(let h of T)try{h(a,s)}catch(S){console.error("Error invoking subscriber:",S)}}return{get(r){return e.get(r)},set(r,a){let s=e.get(r);s!==a&&(e.set(r,a),n(r,a,s))},delete(r){e.delete(r)},setNoNotify(r,a){e.set(r,a)},subscribe(r,a){let s=o.get(r);return s||(s=new Set,o.set(r,s)),s.add(a),()=>{s.delete(a),s.size===0&&o.delete(r)}}}}var Q=ge(),z="state",Se=0;function G(e,o){let n=()=>{},r=new Promise(f=>{n=f}),a=n,s=String(Se++),u=Y(o,I.storeExpiryMs);Q.setNoNotify(s,e);let T=o?.lazyLoad,h=T!==void 0?T:I.lazyLoad,S={readyPromise:r,lazy:h,initStarted:!1,initDone:!1,subscribe(f){return Q.subscribe(s,()=>f())},hasStore(){return!!u},async setInStore(f){return await u?.set(z,f)},async getFromStore(){return await u?.get(z)},getSnapshot(){return Q.get(s)},setValue(f){if(typeof f=="function"){let p=Q.get(s);f=f(p)}Q.set(s,f),S.setInStore(f)},delete(){Q.set(s,e),u?.set(z,e)},async initDefaultValueOnce(){if(S.initDone||S.initStarted)return;S.initStarted=!0;let f=await S.getFromStore(),p=f!==void 0?f:e;Q.set(s,p),S.initDone=!0,a()}};return h||S.initDefaultValueOnce(),S}function H(e){return e.initDefaultValueOnce(),[(0,W.useSyncExternalStore)(n=>e.subscribe(n),()=>e.getSnapshot(),()=>e.getSnapshot()),e.setValue]}function X(e){let o=new Set;return JSON.stringify(e,(n,r)=>{if(typeof r=="function")throw new Error("Functions should not be passed into query parameters");if(!r||typeof r!="object"||Array.isArray(r))return r;if(o.has(r))return"[Circular]";if(o.add(r),r!==e)try{JSON.stringify(r)}catch{return"[Unserializable]"}return Object.keys(r).sort().reduce((a,s)=>(a[s]=r[s],a),{})})}var Z=j(require("lodash/isEqual")),E=require("react");function q(e){let[o,n]=(0,E.useState)(e);return(0,E.useMemo)(()=>(0,Z.default)(o,e)?o:(n(e),e),[o,e])}var M={staleMs:0,expiryMs:30*re.MS_PER_DAY,refetchOnStale:!0,persistTo:void 0,maxSize:100,maxBytes:1e5,log:(...e)=>console.log("[sharedQuery]",...e)};function pe(e){Object.assign(M,e)}var ee=new Set;function ye(e){if(ee.has(e.queryName))throw new Error(`Duplicate shared query name "${e.queryName}"`);ee.add(e.queryName);let o=new Map,n=new Map,r=e.queryName,a=e.queryFn,s=e.refetchFn,u=e?.staleMs??M.staleMs,T=e?.expiryMs??M.expiryMs,h=e?.refetchOnStale??M.refetchOnStale,S=e.store;if(S){if("persistTo"in S&&S.isValid){let t=S.isValid;e={...e,store:{...S,isValid:i=>{if(!i||typeof i!="object")return!1;for(let l of Object.values(i))if(!l||typeof l!="object"||!("data"in l)||!("dataUpdatedMs"in l)||!("lastUpdatedMs"in l)||typeof l.dataUpdatedMs!="number"||typeof l.lastUpdatedMs!="number"||!t(l.data))return!1;return!0}}}}}else{let t=e.persistTo??M.persistTo;t&&(e={...e,store:{persistTo:t,key:r,expiryMs:T}})}let f=e?.maxSize??M.maxSize,p=e?.maxBytes??M.maxBytes,D=!!e?.keepLastNonEmptyData,d=e?.log??M.log,g=G({},e);function v(t){return u===0?!0:Date.now()-t>u}function N(t){return T===0?!1:Date.now()-t>T}function R(){if(!f&&!p)return;let t=g.getSnapshot(),i=Object.keys(t).length;if(i<=1)return;let l=(0,U.default)(t),c=f?i-f:0,y=p?l-p:0;if(c<=0&&y<=0){d(`No need to trim data for ${r}: size=${i} (limit=${f}), byteSize=${l.toLocaleString()} (limit=${p.toLocaleString()})`);return}d(`Need to trim ${r}: numToCut=${c}, bytesToCut=${y}`);let w={...t},$=!1,B=(m,C)=>{if(n.has(m)){d(`Cannot clean up ${m} as it is mounted`);return}let F=(0,U.default)(m)+(0,U.default)(w[m]);d(`Cleaning up unmounted${C?", expired":""} ${m} (byteSize=${F.toLocaleString()})`),c--,y-=F,delete w[m],$=!0},V=Object.entries(w).sort((m,C)=>m[1].lastUpdatedMs-C[1].lastUpdatedMs);for(let[m]of V){if(!N(w[m].lastUpdatedMs))break;B(m,!0)}if(c>0||y>0){$&&(V=Object.entries(w).sort((m,C)=>m[1].lastUpdatedMs-C[1].lastUpdatedMs));for(let[m]of V)if(B(m,!1),c<=0&&y<=0)break}if(!$){d(`No trimmable entries found for ${r}: size=${i} (limit=${f}), byteSize=${l.toLocaleString()} (limit=${p.toLocaleString()})`);return}g.setValue(w),d(`Trimmed data for ${r}: size=[${i} -> ${Object.keys(w).length}] (limit=${f}), byteSize=[${l.toLocaleString()} -> ${(0,U.default)(w).toLocaleString()}] (limit=${p.toLocaleString()})`)}function L(t,i,l=Date.now()){let c={lastUpdatedMs:Date.now(),loading:!1,data:i,dataUpdatedMs:l};g.setValue(y=>({...y,[t]:c})),R()}async function ne(t,i,l){d(`Start fetching ${t}, queryType=${i}`);try{let c=await(i==="refetch"&&s?s(...l):a(...l));return d(`Successfully fetched ${t}`),L(t,c,Date.now()),c}catch(c){throw d(`Failed to fetch ${t} for queryType=${i}: ${c}`),c}finally{o.delete(t)}}function k(t,i,...l){let c=o.get(t);if(c)return d(`Deduplicating inflight fetch for ${t}, queryType=${i}`),c.promise;let y=ne(t,i,l),w=new AbortController;return o.set(t,{promise:y,abortController:w}),y}let A={queryName:r,queryFn:a,refetchFn:s,expiryMs:T,staleMs:u,refetchOnStale:h,maxSize:f,maxBytes:p,keepLastNonEmptyData:D,log:d,queryState:g,getQueryKey(t){return r+":"+X(t)},getAbortController(t){let i=A.getQueryKey(t);return A.getAbortControllerByKey(i)},getAbortControllerByKey(t){return o.get(t)?.abortController??null},getAbortSignal(t){let i=A.getQueryKey(t);return A.getAbortSignalByKey(i)},getAbortSignalByKey(t){return A.getAbortControllerByKey(t)?.signal??null},async getCachedOrFetch(...t){let i=Date.now();await g.readyPromise;let l=Date.now()-i,c=A.getQueryKey(t),y=g.getSnapshot()?.[c];if(l&&d(`${c}: Waited for ${l}ms before data is ready`),y?.data&&!N(y.dataUpdatedMs??0))return v(y.dataUpdatedMs??0)?(h&&(d(`refetchOnStale for ${c}`),k(c,"query",...t)),d(`Returning stale data for ${c}`),y):(d(`Return fresh data ${c} from cache without fetching`),y);let w=await k(c,"query",...t),$=Date.now();return{lastUpdatedMs:$,loading:!1,data:w,dataUpdatedMs:$}},getQueryValue(t){return g.getSnapshot()?.[t]},getData(t){let i=g.getSnapshot()?.[t];if(i?.lastUpdatedMs&&N(i.lastUpdatedMs)){A.deleteData(t);return}return i?.data},setData:L,async updateFromSource(...t){let i=A.getQueryKey(t);return await k(i,"query",...t)},async refetch(...t){let i=A.getQueryKey(t);return await k(i,"refetch",...t)},deleteData(t){let l={...g.getSnapshot()};delete l[t],g.setValue(l);let c=o.get(t);c&&(o.delete(t),c.abortController.abort("Deleted"))},clear(){g.delete();for(let{abortController:t}of Array.from(o.values()))t.abort("Cleared");o.clear()},mount(t){n.set(t,(n.get(t)??0)+1)},unmount(t){let i=n.get(t);i===1?n.delete(t):n.set(t,(i??0)-1)},enforceSizeLimit:R};return A}var te={lastUpdatedMs:0,loading:!0};function Te(e,...o){let n=q(o),[r,a]=H(e.queryState),s=(0,b.useRef)(!0),u=(0,b.useMemo)(()=>e.getQueryKey(n),[e,n]),T=r[u]??te,h=(0,b.useCallback)(D=>{a(d=>{let g={...d};return g[u]=typeof D=="function"?D(g[u]??te):D,g})},[u,a]),[S,f]=(0,b.useState)();(0,b.useEffect)(()=>{e.keepLastNonEmptyData&&T.data!==void 0&&f(T.data)},[e.keepLastNonEmptyData,T.data]);let p=(0,b.useCallback)(async D=>{if(e.log(`Begin executing shared query ${u}, isRefetch=${D}`),!!s.current){h(d=>({...d,lastUpdatedMs:Date.now(),loading:!0}));try{let d;if(D){let g=await e.refetch(...n),v=Date.now();d={lastUpdatedMs:v,loading:!1,data:g,dataUpdatedMs:v}}else d=await e.getCachedOrFetch(...n);if(!s.current)return;h({...d,loading:!1})}catch(d){if(!s.current)return;let g=Date.now();h(v=>({...v,lastUpdatedMs:g,loading:!1,error:d,errorUpdatedMs:g}))}}},[e,u,h,n]);return(0,b.useEffect)(()=>(s.current=!0,e.mount(u),p(!1),()=>{s.current=!1,e.unmount(u)}),[p,e,u]),(0,b.useMemo)(()=>({...T,lastNonEmptyData:S,abortCurrentQuery:D=>{let d=e.getAbortControllerByKey(u);return d?.abort(D),!!d},refetch:()=>p(!0),setData:(D,d)=>{e.setData(u,D,d)},deleteData:()=>{e.deleteData(u)}}),[p,S,e,u,T])}0&&(module.exports={SharedQueryConfig,configureSharedQuery,sharedQuery,useSharedQuery});
 //# sourceMappingURL=sharedQuery.min.cjs.map