@choksheak/react-utils 0.4.7 → 0.4.8

package/sharedQuery.cjs

@@ -1,584 +1,17 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true}); function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } function _nullishCoalesce(lhs, rhsFn) { if (lhs != null) { return lhs; } else { return rhsFn(); } } function _optionalChain(ops) { let lastAccessLHS = undefined; let value = ops[0]; let i = 1; while (i < ops.length) { const op = ops[i]; const fn = ops[i + 1]; i += 2; if ((op === 'optionalAccess' || op === 'optionalCall') && value == null) { return undefined; } if (op === 'access' || op === 'optionalAccess') { lastAccessLHS = value; value = fn(value); } else if (op === 'call' || op === 'optionalCall') { value = fn((...args) => value.call(lastAccessLHS, ...args)); lastAccessLHS = undefined; } } return value; }var _http = require('@choksheak/ts-utils/http');
-var _nonNil = require('@choksheak/ts-utils/nonNil');
-var _objectsizeof = require('object-sizeof'); var _objectsizeof2 = _interopRequireDefault(_objectsizeof);
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});
 
 
 
 
+var _chunkHFIQE4XZcjs = require('./chunk-HFIQE4XZ.cjs');
+require('./chunk-UNDIVFP5.cjs');
+require('./chunk-5PDGU37E.cjs');
+require('./chunk-CYTO5EZE.cjs');
+require('./chunk-WXLUEDBO.cjs');
+require('./chunk-IS3BZTWE.cjs');
 
 
-var _react = require('react');
-var _xxhashjs = require('xxhashjs'); var _xxhashjs2 = _interopRequireDefault(_xxhashjs);
-var _sharedState = require('./sharedState');
-var _stringify = require('./stringify');
-var _useDeepMemo = require('./useDeepMemo');
-const SharedQueryConfig = {
-  /** Refetch on every page load. */
-  staleMs: 0,
-  /** Keep in cache for a long time. */
-  expiryMs: 30 * 864e5,
-  /** Always refetch automatically if the data is stale. */
-  refetchOnStale: true,
-  /** No default persistence configured. */
-  persistTo: void 0,
-  /** 100 is not too large, but please tweak accordingly. */
-  maxSize: 100,
-  /** 100kb limit before discarding old records. */
-  maxBytes: 1e5,
-  /** Default to log to console. */
-  log: (...args) => console.log("[sharedQuery]", ...args)
-};
-function configureSharedQuery(config) {
-  Object.assign(SharedQueryConfig, config);
-}
-const moduleQueryRegistry = /* @__PURE__ */ new Map();
-function getOrCreateQueryRegistry() {
-  if (typeof window !== "undefined") {
-    const g = window.globalThis;
-    return g.reactUtilsQueryRegistry ??= /* @__PURE__ */ new Map();
-  }
-  return moduleQueryRegistry;
-}
-function sharedQuery1(options) {
-  const registry = getOrCreateQueryRegistry();
-  const key = options.queryName || options.url;
-  const existing = registry.get(key);
-  if (existing) {
-    return existing;
-  }
-  const obj = sharedQuery2(options);
-  registry.set(key, obj);
-  return obj;
-}
-function sharedQuery2(options) {
-  const url = options.url || "";
-  const queryName = options.queryName || url;
-  if (!queryName) {
-    throw new Error(`Either queryName or url must be specified.`);
-  }
-  const inflightQueries = /* @__PURE__ */ new Map();
-  const mountedKeys = /* @__PURE__ */ new Map();
-  let queryFn;
-  if (options.queryFn) {
-    queryFn = options.queryFn;
-  } else if (url) {
-    const fetcher = _http.http.use(_http.retries.call(void 0, ));
-    queryFn = async (...args) => {
-      let params = "";
-      const firstArg = _optionalChain([args, 'optionalAccess', _ => _[0]]);
-      if (firstArg) {
-        if (typeof firstArg === "string") {
-          params = firstArg;
-        } else if (typeof firstArg === "object") {
-          const entries = [];
-          for (const [k, v] of Object.entries(firstArg)) {
-            if (v === void 0) continue;
-            if (Array.isArray(v)) {
-              for (const item of v) {
-                if (item === void 0) continue;
-                entries.push([k, String(item)]);
-              }
-            } else {
-              entries.push([k, String(v)]);
-            }
-          }
-          params = new URLSearchParams(entries).toString();
-        }
-        if (params) {
-          if (url.includes("?")) {
-            params = "&" + params;
-          } else {
-            params = "?" + params;
-          }
-        }
-      }
-      const response = await fetcher.get(url + params);
-      return await response.json();
-    };
-  } else {
-    throw new Error(`Either queryFn or url must be specified`);
-  }
-  const refetchFn = options.refetchFn;
-  const staleMs = _nullishCoalesce(_optionalChain([options, 'optionalAccess', _2 => _2.staleMs]), () => ( SharedQueryConfig.staleMs));
-  const expiryMs = _nullishCoalesce(_optionalChain([options, 'optionalAccess', _3 => _3.expiryMs]), () => ( SharedQueryConfig.expiryMs));
-  const refetchOnStale = _nullishCoalesce(_optionalChain([options, 'optionalAccess', _4 => _4.refetchOnStale]), () => ( SharedQueryConfig.refetchOnStale));
-  const store = options.store;
-  if (store) {
-    if ("persistTo" in store && store.isValid) {
-      const isValid = store.isValid;
-      options = {
-        ...options,
-        store: {
-          ...store,
-          isValid: (u) => {
-            if (!u || typeof u !== "object") {
-              return false;
-            }
-            for (const v of Object.values(u)) {
-              if (!v || typeof v !== "object" || !("data" in v) || !("dataUpdatedMs" in v) || !("lastUpdatedMs" in v) || typeof v.dataUpdatedMs !== "number" || typeof v.lastUpdatedMs !== "number" || !isValid(v.data)) {
-                return false;
-              }
-            }
-            return true;
-          }
-        }
-      };
-    }
-  } else {
-    const persistTo = _nullishCoalesce(options.persistTo, () => ( SharedQueryConfig.persistTo));
-    if (persistTo) {
-      options = {
-        ...options,
-        store: {
-          persistTo,
-          key: queryName,
-          expiryMs
-        }
-      };
-    }
-  }
-  const maxSize = _nullishCoalesce(_optionalChain([options, 'optionalAccess', _5 => _5.maxSize]), () => ( SharedQueryConfig.maxSize));
-  const maxBytes = _nullishCoalesce(_optionalChain([options, 'optionalAccess', _6 => _6.maxBytes]), () => ( SharedQueryConfig.maxBytes));
-  const keepLastNonEmptyData = Boolean(_optionalChain([options, 'optionalAccess', _7 => _7.keepLastNonEmptyData]));
-  const log = _nullishCoalesce(_optionalChain([options, 'optionalAccess', _8 => _8.log]), () => ( SharedQueryConfig.log));
-  const queryState = _sharedState.sharedState.call(void 0, 
-    {},
-    // defaultValue
-    options
-  );
-  function isStale(dataUpdatedMs) {
-    if (staleMs === 0) return true;
-    const ageMs = Date.now() - dataUpdatedMs;
-    return ageMs > staleMs;
-  }
-  function isExpired(dataUpdatedMs) {
-    if (expiryMs === 0) return false;
-    const ageMs = Date.now() - dataUpdatedMs;
-    return ageMs > expiryMs;
-  }
-  function enforceSizeLimit() {
-    if (!maxSize && !maxBytes) {
-      return;
-    }
-    const oldState = queryState.getSnapshot();
-    const oldSize = Object.keys(oldState).length;
-    if (oldSize <= 1) {
-      return;
-    }
-    const oldByteSize = _objectsizeof2.default.call(void 0, oldState);
-    let numToCut = maxSize ? oldSize - maxSize : 0;
-    let bytesToCut = maxBytes ? oldByteSize - maxBytes : 0;
-    if (numToCut <= 0 && bytesToCut <= 0) {
-      log(
-        `No need to trim data for ${queryName}: size=${oldSize} (limit=${maxSize}), byteSize=${oldByteSize.toLocaleString()} (limit=${maxBytes.toLocaleString()})`
-      );
-      return;
-    }
-    log(
-      `Need to trim ${queryName}: numToCut=${numToCut}, bytesToCut=${bytesToCut}`
-    );
-    const newState = { ...oldState };
-    let needUpdate = false;
-    const deleteKeyIfNotMounted = (key, expired) => {
-      if (mountedKeys.has(key)) {
-        log(`Cannot clean up ${key} as it is mounted`);
-        return;
-      }
-      const byteSize = _objectsizeof2.default.call(void 0, key) + _objectsizeof2.default.call(void 0, newState[key]);
-      log(
-        `Cleaning up unmounted${expired ? ", expired" : ""} ${key} (byteSize=${byteSize.toLocaleString()})`
-      );
-      numToCut--;
-      bytesToCut -= byteSize;
-      delete newState[key];
-      needUpdate = true;
-    };
-    let entriesByTimeAscending = Object.entries(newState).sort(
-      (entry1, entry2) => entry1[1].lastUpdatedMs - entry2[1].lastUpdatedMs
-    );
-    for (const [key] of entriesByTimeAscending) {
-      if (!isExpired(newState[key].lastUpdatedMs)) {
-        break;
-      }
-      deleteKeyIfNotMounted(key, true);
-    }
-    if (numToCut > 0 || bytesToCut > 0) {
-      if (needUpdate) {
-        entriesByTimeAscending = Object.entries(newState).sort(
-          (entry1, entry2) => entry1[1].lastUpdatedMs - entry2[1].lastUpdatedMs
-        );
-      }
-      for (const [key] of entriesByTimeAscending) {
-        deleteKeyIfNotMounted(key, false);
-        if (numToCut <= 0 && bytesToCut <= 0) {
-          break;
-        }
-      }
-    }
-    if (!needUpdate) {
-      log(
-        `No trimmable entries found for ${queryName}: size=${oldSize} (limit=${maxSize}), byteSize=${oldByteSize.toLocaleString()} (limit=${maxBytes.toLocaleString()})`
-      );
-      return;
-    }
-    queryState.setValue(newState);
-    log(
-      `Trimmed data for ${queryName}: size=[${oldSize} -> ${Object.keys(newState).length}] (limit=${maxSize}), byteSize=[${oldByteSize.toLocaleString()} -> ${_objectsizeof2.default.call(void 0, newState).toLocaleString()}] (limit=${maxBytes.toLocaleString()})`
-    );
-  }
-  function setData(queryKey, data, dataUpdatedMs = Date.now()) {
-    const entry = {
-      lastUpdatedMs: Date.now(),
-      loading: false,
-      data,
-      dataUpdatedMs
-    };
-    queryState.setValue((prev) => ({ ...prev, [queryKey]: entry }));
-    enforceSizeLimit();
-  }
-  async function startFetching(queryKey, queryType, args) {
-    log(`Start fetching ${queryKey}, queryType=${queryType}`);
-    try {
-      const data = await (queryType === "refetch" && refetchFn ? refetchFn(...args) : queryFn(...args));
-      log(`Successfully fetched ${queryKey}`);
-      setData(queryKey, data, Date.now());
-      return data;
-    } catch (e) {
-      log(`Failed to fetch ${queryKey} for queryType=${queryType}: ${e}`);
-      throw e;
-    } finally {
-      inflightQueries.delete(queryKey);
-    }
-  }
-  function dedupedFetch(queryKey, queryType, ...args) {
-    const inflightQuery = inflightQueries.get(queryKey);
-    if (inflightQuery) {
-      log(
-        `Deduplicating inflight fetch for ${queryKey}, queryType=${queryType}`
-      );
-      return inflightQuery.promise;
-    }
-    const promise = startFetching(queryKey, queryType, args);
-    const abortController = new AbortController();
-    inflightQueries.set(queryKey, { promise, abortController });
-    return promise;
-  }
-  const obj = {
-    queryName,
-    queryFn,
-    refetchFn,
-    expiryMs,
-    staleMs,
-    refetchOnStale,
-    maxSize,
-    maxBytes,
-    keepLastNonEmptyData,
-    log,
-    queryState,
-    /** Returns a key to identify requests based on the given args. */
-    getQueryKey(args) {
-      let s = _stringify.stringifyDeterministicForKeys.call(void 0, args);
-      if (s.length > 30) {
-        s = _xxhashjs2.default.h32(s, 39406).toString(16).slice(2);
-      }
-      return queryName + ":" + s;
-    },
-    /**
-     * Get the AbortController to abort the inflight query (if any).
-     *
-     * Note that once you get the controller, you can also get the signal easily
-     * using `controller.signal`. So if you need both the controller and the
-     * signal, just use this function.
-     */
-    getAbortController(args) {
-      const queryKey = obj.getQueryKey(args);
-      return obj.getAbortControllerByKey(queryKey);
-    },
-    getAbortControllerByKey(queryKey) {
-      return _nullishCoalesce(_optionalChain([inflightQueries, 'access', _9 => _9.get, 'call', _10 => _10(queryKey), 'optionalAccess', _11 => _11.abortController]), () => ( null));
-    },
-    /**
-     * Get the AbortSignal to check for query abortions.
-     *
-     * Example using fetch:
-     * ```
-     *   const getUserQuery = sharedQuery({
-     *     queryName: "getUser",
-     *     queryFn: (userId: string) => {
-     *       // Get the signal for this current execution.
-     *       const signal = getUserQuery.getAbortSignal([userId]);
-     *
-     *       // Pass the signal to fetch so that it can be aborted.
-     *       const response = await fetch(`/users/${userId}`, { signal });
-     *
-     *       // Check for errors.
-     *       if (!response.ok) {
-     *         throw new Error(response.statusText);
-     *       }
-     *
-     *       // Return the data.
-     *       return await response.json();
-     *     },
-     *   });
-     * ```
-     *
-     * Example using `http.ts`:
-     * ```
-     *   const getUserQuery = sharedQuery({
-     *     queryName: "getUser",
-     *     queryFn: (userId: string) => {
-     *       // Get the signal for this current execution.
-     *       const signal = getUserQuery.getAbortSignal([userId]);
-     *
-     *       // Pass the signal to fetch so that it can be aborted.
-     *       const response = await http.get(`/users/${userId}`, { signal });
-     *       return await response.json();
-     *     },
-     *   });
-     * ```
-     */
-    getAbortSignal(args) {
-      const queryKey = obj.getQueryKey(args);
-      return obj.getAbortSignalByKey(queryKey);
-    },
-    getAbortSignalByKey(queryKey) {
-      return _nullishCoalesce(_optionalChain([obj, 'access', _12 => _12.getAbortControllerByKey, 'call', _13 => _13(queryKey), 'optionalAccess', _14 => _14.signal]), () => ( null));
-    },
-    /** For cached data, we need to return the correct timestamps as well. */
-    async getCachedOrFetch(...args) {
-      const startMs = Date.now();
-      await queryState.readyPromise;
-      const waitedMs = Date.now() - startMs;
-      const queryKey = obj.getQueryKey(args);
-      const cached = _optionalChain([queryState, 'access', _15 => _15.getSnapshot, 'call', _16 => _16(), 'optionalAccess', _17 => _17[queryKey]]);
-      if (waitedMs) {
-        log(`${queryKey}: Waited for ${waitedMs}ms before data is ready`);
-      }
-      if (_optionalChain([cached, 'optionalAccess', _18 => _18.data]) && !isExpired(_nullishCoalesce(cached.dataUpdatedMs, () => ( 0)))) {
-        if (!isStale(_nullishCoalesce(cached.dataUpdatedMs, () => ( 0)))) {
-          log(`Return fresh data ${queryKey} from cache without fetching`);
-          return cached;
-        }
-        if (refetchOnStale) {
-          log(`refetchOnStale for ${queryKey}`);
-          void dedupedFetch(queryKey, "query", ...args);
-        }
-        log(`Returning stale data for ${queryKey}`);
-        return cached;
-      }
-      const data = await dedupedFetch(queryKey, "query", ...args);
-      const now = Date.now();
-      return {
-        // Don't keep old error.
-        lastUpdatedMs: now,
-        loading: false,
-        data,
-        dataUpdatedMs: now
-      };
-    },
-    /** Get the entire stored entry for a query key. */
-    getQueryValue(queryKey) {
-      return _optionalChain([queryState, 'access', _19 => _19.getSnapshot, 'call', _20 => _20(), 'optionalAccess', _21 => _21[queryKey]]);
-    },
-    /** Get the current stored data for a query key. */
-    getData(queryKey) {
-      const stateValue = _optionalChain([queryState, 'access', _22 => _22.getSnapshot, 'call', _23 => _23(), 'optionalAccess', _24 => _24[queryKey]]);
-      if (_optionalChain([stateValue, 'optionalAccess', _25 => _25.lastUpdatedMs])) {
-        if (isExpired(stateValue.lastUpdatedMs)) {
-          obj.deleteData(queryKey);
-          return void 0;
-        }
-      }
-      return _optionalChain([stateValue, 'optionalAccess', _26 => _26.data]);
-    },
-    /** Set the data directly if the user obtained it from somewhere else. */
-    setData,
-    /**
-     * Do a new fetch even when the data is already cached, but don't fetch if
-     * another fetch is already inflight.
-     */
-    async updateFromSource(...args) {
-      const key = obj.getQueryKey(args);
-      return await dedupedFetch(key, "query", ...args);
-    },
-    /**
-     * Perform an explicit refetch. If `options.refetchFn` was not specified,
-     * then this would be identical to calling `obj.updateFromSource()`.
-     */
-    async refetch(...args) {
-      const key = obj.getQueryKey(args);
-      return await dedupedFetch(key, "refetch", ...args);
-    },
-    /** Delete the cached data for one set of arguments. */
-    deleteData(queryKey) {
-      const record = queryState.getSnapshot();
-      const clone = { ...record };
-      delete clone[queryKey];
-      queryState.setValue(clone);
-      const inflight = inflightQueries.get(queryKey);
-      if (inflight) {
-        inflightQueries.delete(queryKey);
-        inflight.abortController.abort("Deleted");
-      }
-    },
-    /** Delete all currently cached data & all inflight promises. */
-    clear() {
-      queryState.delete();
-      for (const { abortController } of Array.from(inflightQueries.values())) {
-        abortController.abort("Cleared");
-      }
-      inflightQueries.clear();
-    },
-    /** Keep track of mounted keys. */
-    mount(queryKey) {
-      mountedKeys.set(queryKey, (_nullishCoalesce(mountedKeys.get(queryKey), () => ( 0))) + 1);
-    },
-    /** Clean up mounted keys. */
-    unmount(queryKey) {
-      const count = mountedKeys.get(queryKey);
-      if (count === 1) {
-        mountedKeys.delete(queryKey);
-      } else {
-        mountedKeys.set(queryKey, (_nullishCoalesce(count, () => ( 0))) - 1);
-      }
-    },
-    /**
-     * Discard the oldest entries if the size exceeds the limit. The last
-     * remaining record cannot be deleted no matter what the limit is.
-     */
-    enforceSizeLimit
-  };
-  return obj;
-}
-function sharedQuery(options) {
-  return sharedQuery1(options);
-}
-const DEFAULT_QUERY_STATE_ENTRY = {
-  lastUpdatedMs: 0,
-  loading: true
-};
-function useSharedQuery(query, ...args) {
-  const stableArgs = _useDeepMemo.useDeepMemo.call(void 0, args);
-  const [queryState, setQueryState] = _sharedState.useSharedState.call(void 0, query.queryState);
-  const isMounted = _react.useRef.call(void 0, true);
-  const queryKey = _react.useMemo.call(void 0, 
-    () => query.getQueryKey(stableArgs),
-    [query, stableArgs]
-  );
-  const queryStateValue = _nullishCoalesce(queryState[queryKey], () => ( DEFAULT_QUERY_STATE_ENTRY));
-  const setQueryStateValue = _react.useCallback.call(void 0, 
-    (next) => {
-      setQueryState((prev) => {
-        const clone = { ...prev };
-        clone[queryKey] = typeof next === "function" ? next(_nullishCoalesce(clone[queryKey], () => ( DEFAULT_QUERY_STATE_ENTRY))) : next;
-        return clone;
-      });
-    },
-    [queryKey, setQueryState]
-  );
-  const [lastNonEmptyData, setLastNonEmptyData] = _react.useState.call(void 0, );
-  _react.useEffect.call(void 0, () => {
-    if (query.keepLastNonEmptyData && queryStateValue.data !== void 0) {
-      setLastNonEmptyData(queryStateValue.data);
-    }
-  }, [query.keepLastNonEmptyData, queryStateValue.data]);
-  const executeQuery = _react.useCallback.call(void 0, 
-    async (isRefetch) => {
-      query.log(
-        `Begin executing shared query ${queryKey}, isRefetch=${isRefetch}`
-      );
-      if (!isMounted.current) return;
-      setQueryStateValue((prev) => ({
-        // Keep old data and error.
-        ...prev,
-        lastUpdatedMs: Date.now(),
-        loading: true
-      }));
-      try {
-        let state;
-        if (isRefetch) {
-          const data = await query.refetch(...stableArgs);
-          const now = Date.now();
-          state = {
-            // Don't keep old error.
-            lastUpdatedMs: now,
-            loading: false,
-            data,
-            dataUpdatedMs: now
-          };
-        } else {
-          state = await query.getCachedOrFetch(...stableArgs);
-        }
-        if (!isMounted.current) return;
-        setQueryStateValue({ ...state, loading: false });
-        return state.data;
-      } catch (e) {
-        if (!isMounted.current) return;
-        const now = Date.now();
-        setQueryStateValue((prev) => ({
-          // Keep old data.
-          ...prev,
-          lastUpdatedMs: now,
-          loading: false,
-          error: e,
-          errorUpdatedMs: now
-        }));
-      }
-    },
-    [query, queryKey, setQueryStateValue, stableArgs]
-  );
-  _react.useEffect.call(void 0, () => {
-    isMounted.current = true;
-    query.mount(queryKey);
-    void executeQuery(false);
-    return () => {
-      isMounted.current = false;
-      query.unmount(queryKey);
-    };
-  }, [executeQuery, query, queryKey]);
-  return _react.useMemo.call(void 0, () => {
-    return {
-      ...queryStateValue,
-      // Fill with lastNonEmptyData when data is undefined.
-      data: queryStateValue.data !== void 0 ? queryStateValue.data : lastNonEmptyData,
-      latestData: queryStateValue.data,
-      // This works only if the user-given queryFn supports abort. If not,
-      // this function doesn't do anything, since we don't have any means to
-      // abort the running queryFn.
-      abortCurrentQuery: (reason) => {
-        const controller = query.getAbortControllerByKey(queryKey);
-        _optionalChain([controller, 'optionalAccess', _27 => _27.abort, 'call', _28 => _28(reason)]);
-        return Boolean(controller);
-      },
-      getCachedOrFetch: async () => {
-        const data = await query.getCachedOrFetch(...stableArgs);
-        return _nonNil.nonNil.call(void 0, 
-          data.data,
-          typeof data.error === "string" ? data.error : JSON.stringify(data.error)
-        );
-      },
-      refetch: () => {
-        return executeQuery(true);
-      },
-      setData: (data, dataUpdatedMs) => {
-        query.setData(queryKey, data, dataUpdatedMs);
-      },
-      deleteData: () => {
-        query.deleteData(queryKey);
-      }
-    };
-  }, [
-    executeQuery,
-    lastNonEmptyData,
-    query,
-    queryKey,
-    queryStateValue,
-    stableArgs
-  ]);
-}
 
 
 
-
-
-exports.SharedQueryConfig = SharedQueryConfig; exports.configureSharedQuery = configureSharedQuery; exports.sharedQuery = sharedQuery; exports.useSharedQuery = useSharedQuery;
+exports.SharedQueryConfig = _chunkHFIQE4XZcjs.SharedQueryConfig; exports.configureSharedQuery = _chunkHFIQE4XZcjs.configureSharedQuery; exports.sharedQuery = _chunkHFIQE4XZcjs.sharedQuery; exports.useSharedQuery = _chunkHFIQE4XZcjs.useSharedQuery;