@tanstack/query-persist-client-core 5.94.4 → 5.94.5

package/build/modern/_tsup-dts-rollup.d.ts

@@ -0,0 +1,246 @@
+import type { DehydratedState } from '@tanstack/query-core';
+import type { DehydrateOptions } from '@tanstack/query-core';
+import type { HydrateOptions } from '@tanstack/query-core';
+import { Options } from 'tsup';
+import type { Query } from '@tanstack/query-core';
+import type { QueryClient } from '@tanstack/query-core';
+import type { QueryFilters } from '@tanstack/query-core';
+import type { QueryFunctionContext } from '@tanstack/query-core';
+import type { QueryKey } from '@tanstack/query-core';
+import type { QueryState } from '@tanstack/query-core';
+import { UserConfig } from 'vite';
+
+declare interface AsyncStorage<TStorageValue = string> {
+    getItem: (key: string) => MaybePromise<TStorageValue | undefined | null>;
+    setItem: (key: string, value: TStorageValue) => MaybePromise<unknown>;
+    removeItem: (key: string) => MaybePromise<void>;
+    entries?: () => MaybePromise<Array<[key: string, value: TStorageValue]>>;
+}
+export { AsyncStorage }
+export { AsyncStorage as AsyncStorage_alias_1 }
+
+export declare function createMockPersister(): Persister;
+
+export declare function createSpyPersister(): Persister;
+
+export declare const default_alias: any[];
+
+export declare const default_alias_1: any[];
+
+export declare const default_alias_2: Options | Options[] | ((overrideOptions: Options) => Options | Options[] | Promise<Options | Options[]>);
+
+export declare const default_alias_3: UserConfig;
+
+/**
+ * Warning: experimental feature.
+ * This utility function enables fine-grained query persistence.
+ * Simple add it as a `persister` parameter to `useQuery` or `defaultOptions` on `queryClient`.
+ *
+ * ```
+ * useQuery({
+ queryKey: ['myKey'],
+ queryFn: fetcher,
+ persister: createPersister({
+ storage: localStorage,
+ }),
+ })
+ ```
+ */
+declare function experimental_createQueryPersister<TStorageValue = string>({ storage, buster, maxAge, serialize, deserialize, prefix, refetchOnRestore, filters, }: StoragePersisterOptions<TStorageValue>): {
+    persisterFn: <T, TQueryKey extends QueryKey>(queryFn: (context: QueryFunctionContext<TQueryKey>) => T | Promise<T>, ctx: QueryFunctionContext<TQueryKey>, query: Query) => Promise<T>;
+    persistQuery: (query: Query) => Promise<void>;
+    persistQueryByKey: (queryKey: QueryKey, queryClient: QueryClient) => Promise<void>;
+    retrieveQuery: <T>(queryHash: string, afterRestoreMacroTask?: (persistedQuery: PersistedQuery) => void) => Promise<T | undefined>;
+    persisterGc: () => Promise<void>;
+    restoreQueries: (queryClient: QueryClient, filters?: Pick<QueryFilters, "queryKey" | "exact">) => Promise<void>;
+    removeQueries: (filters?: Pick<QueryFilters, "queryKey" | "exact">) => Promise<void>;
+};
+export { experimental_createQueryPersister }
+export { experimental_createQueryPersister as experimental_createQueryPersister_alias_1 }
+
+/**
+ * @param {Object} opts - Options for building configurations.
+ * @param {string[]} opts.entry - The entry array.
+ * @returns {import('tsup').Options}
+ */
+export declare function legacyConfig(opts: {
+    entry: string[];
+}): Options;
+
+declare type MaybePromise<T> = T | Promise<T>;
+export { MaybePromise }
+export { MaybePromise as MaybePromise_alias_1 }
+
+/**
+ * @param {Object} opts - Options for building configurations.
+ * @param {string[]} opts.entry - The entry array.
+ * @returns {import('tsup').Options}
+ */
+export declare function modernConfig(opts: {
+    entry: string[];
+}): Options;
+
+declare interface PersistedClient {
+    timestamp: number;
+    buster: string;
+    clientState: DehydratedState;
+}
+export { PersistedClient }
+export { PersistedClient as PersistedClient_alias_1 }
+
+declare interface PersistedQuery {
+    buster: string;
+    queryHash: string;
+    queryKey: QueryKey;
+    state: QueryState;
+}
+export { PersistedQuery }
+export { PersistedQuery as PersistedQuery_alias_1 }
+
+declare interface PersistedQueryClientRestoreOptions extends PersistQueryClientRootOptions {
+    /** The max-allowed age of the cache in milliseconds.
+     * If a persisted cache is found that is older than this
+     * time, it will be discarded */
+    maxAge?: number;
+    /** The options passed to the hydrate function */
+    hydrateOptions?: HydrateOptions;
+}
+export { PersistedQueryClientRestoreOptions }
+export { PersistedQueryClientRestoreOptions as PersistedQueryClientRestoreOptions_alias_1 }
+
+declare interface PersistedQueryClientSaveOptions extends PersistQueryClientRootOptions {
+    /** The options passed to the dehydrate function */
+    dehydrateOptions?: DehydrateOptions;
+}
+export { PersistedQueryClientSaveOptions }
+export { PersistedQueryClientSaveOptions as PersistedQueryClientSaveOptions_alias_1 }
+
+declare interface Persister {
+    persistClient: (persistClient: PersistedClient) => Promisable<void>;
+    restoreClient: () => Promisable<PersistedClient | undefined>;
+    removeClient: () => Promisable<void>;
+}
+export { Persister }
+export { Persister as Persister_alias_1 }
+
+declare const PERSISTER_KEY_PREFIX = "tanstack-query";
+export { PERSISTER_KEY_PREFIX }
+export { PERSISTER_KEY_PREFIX as PERSISTER_KEY_PREFIX_alias_1 }
+
+/**
+ * Restores persisted data to QueryCache and persists further changes.
+ */
+declare function persistQueryClient(props: PersistQueryClientOptions): [() => void, Promise<void>];
+export { persistQueryClient }
+export { persistQueryClient as persistQueryClient_alias_1 }
+
+declare interface PersistQueryClientOptions extends PersistedQueryClientRestoreOptions, PersistedQueryClientSaveOptions, PersistQueryClientRootOptions {
+}
+export { PersistQueryClientOptions }
+export { PersistQueryClientOptions as PersistQueryClientOptions_alias_1 }
+
+/**
+ * Restores persisted data to the QueryCache
+ *  - data obtained from persister.restoreClient
+ *  - data is hydrated using hydrateOptions
+ * If data is expired, busted, empty, or throws, it runs persister.removeClient
+ */
+declare function persistQueryClientRestore({ queryClient, persister, maxAge, buster, hydrateOptions, }: PersistedQueryClientRestoreOptions): Promise<void>;
+export { persistQueryClientRestore }
+export { persistQueryClientRestore as persistQueryClientRestore_alias_1 }
+
+declare interface PersistQueryClientRootOptions {
+    /** The QueryClient to persist */
+    queryClient: QueryClient;
+    /** The Persister interface for storing and restoring the cache
+     * to/from a persisted location */
+    persister: Persister;
+    /** A unique string that can be used to forcefully
+     * invalidate existing caches if they do not share the same buster string */
+    buster?: string;
+}
+export { PersistQueryClientRootOptions }
+export { PersistQueryClientRootOptions as PersistQueryClientRootOptions_alias_1 }
+
+/**
+ * Persists data from the QueryCache
+ *  - data dehydrated using dehydrateOptions
+ *  - data is persisted using persister.persistClient
+ */
+declare function persistQueryClientSave({ queryClient, persister, buster, dehydrateOptions, }: PersistedQueryClientSaveOptions): Promise<void>;
+export { persistQueryClientSave }
+export { persistQueryClientSave as persistQueryClientSave_alias_1 }
+
+/**
+ * Subscribe to QueryCache and MutationCache updates (for persisting)
+ * @returns an unsubscribe function (to discontinue monitoring)
+ */
+declare function persistQueryClientSubscribe(props: PersistedQueryClientSaveOptions): () => void;
+export { persistQueryClientSubscribe }
+export { persistQueryClientSubscribe as persistQueryClientSubscribe_alias_1 }
+
+declare type PersistRetryer = (props: {
+    persistedClient: PersistedClient;
+    error: Error;
+    errorCount: number;
+}) => PersistedClient | undefined;
+export { PersistRetryer }
+export { PersistRetryer as PersistRetryer_alias_1 }
+
+declare type Promisable<T> = T | PromiseLike<T>;
+export { Promisable }
+export { Promisable as Promisable_alias_1 }
+
+declare const removeOldestQuery: PersistRetryer;
+export { removeOldestQuery }
+export { removeOldestQuery as removeOldestQuery_alias_1 }
+
+declare interface StoragePersisterOptions<TStorageValue = string> {
+    /** The storage client used for setting and retrieving items from cache.
+     * For SSR pass in `undefined`.
+     */
+    storage: AsyncStorage<TStorageValue> | undefined | null;
+    /**
+     * How to serialize the data to storage.
+     * @default `JSON.stringify`
+     */
+    serialize?: (persistedQuery: PersistedQuery) => MaybePromise<TStorageValue>;
+    /**
+     * How to deserialize the data from storage.
+     * @default `JSON.parse`
+     */
+    deserialize?: (cachedString: TStorageValue) => MaybePromise<PersistedQuery>;
+    /**
+     * A unique string that can be used to forcefully invalidate existing caches,
+     * if they do not share the same buster string
+     */
+    buster?: string;
+    /**
+     * The max-allowed age of the cache in milliseconds.
+     * If a persisted cache is found that is older than this
+     * time, it will be discarded
+     * @default 24 hours
+     */
+    maxAge?: number;
+    /**
+     * Prefix to be used for storage key.
+     * Storage key is a combination of prefix and query hash in a form of `prefix-queryHash`.
+     * @default 'tanstack-query'
+     */
+    prefix?: string;
+    /**
+     * If set to `true`, the query will refetch on successful query restoration if the data is stale.
+     * If set to `false`, the query will not refetch on successful query restoration.
+     * If set to `'always'`, the query will always refetch on successful query restoration.
+     * Defaults to `true`.
+     */
+    refetchOnRestore?: boolean | 'always';
+    /**
+     * Filters to narrow down which Queries should be persisted.
+     */
+    filters?: QueryFilters;
+}
+export { StoragePersisterOptions }
+export { StoragePersisterOptions as StoragePersisterOptions_alias_1 }
+
+export { }

package/build/modern/createPersister.cjs

@@ -0,0 +1,258 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/createPersister.ts
+var createPersister_exports = {};
+__export(createPersister_exports, {
+  PERSISTER_KEY_PREFIX: () => PERSISTER_KEY_PREFIX,
+  experimental_createQueryPersister: () => experimental_createQueryPersister
+});
+module.exports = __toCommonJS(createPersister_exports);
+var import_query_core = require("@tanstack/query-core");
+var PERSISTER_KEY_PREFIX = "tanstack-query";
+function experimental_createQueryPersister({
+  storage,
+  buster = "",
+  maxAge = 1e3 * 60 * 60 * 24,
+  serialize = JSON.stringify,
+  deserialize = JSON.parse,
+  prefix = PERSISTER_KEY_PREFIX,
+  refetchOnRestore = true,
+  filters
+}) {
+  function isExpiredOrBusted(persistedQuery) {
+    if (persistedQuery.state.dataUpdatedAt) {
+      const queryAge = Date.now() - persistedQuery.state.dataUpdatedAt;
+      const expired = queryAge > maxAge;
+      const busted = persistedQuery.buster !== buster;
+      if (expired || busted) {
+        return true;
+      }
+      return false;
+    }
+    return true;
+  }
+  async function retrieveQuery(queryHash, afterRestoreMacroTask) {
+    if (storage != null) {
+      const storageKey = `${prefix}-${queryHash}`;
+      try {
+        const storedData = await storage.getItem(storageKey);
+        if (storedData) {
+          let persistedQuery;
+          try {
+            persistedQuery = await deserialize(storedData);
+          } catch {
+            await storage.removeItem(storageKey);
+            return;
+          }
+          if (isExpiredOrBusted(persistedQuery)) {
+            await storage.removeItem(storageKey);
+          } else {
+            if (afterRestoreMacroTask) {
+              import_query_core.notifyManager.schedule(
+                () => afterRestoreMacroTask(persistedQuery)
+              );
+            }
+            return persistedQuery.state.data;
+          }
+        }
+      } catch (err) {
+        if (process.env.NODE_ENV === "development") {
+          console.error(err);
+          console.warn(
+            "Encountered an error attempting to restore query cache from persisted location."
+          );
+        }
+        await storage.removeItem(storageKey);
+      }
+    }
+    return;
+  }
+  async function persistQueryByKey(queryKey, queryClient) {
+    if (storage != null) {
+      const query = queryClient.getQueryCache().find({ queryKey });
+      if (query) {
+        await persistQuery(query);
+      } else {
+        if (process.env.NODE_ENV === "development") {
+          console.warn(
+            "Could not find query to be persisted. QueryKey:",
+            JSON.stringify(queryKey)
+          );
+        }
+      }
+    }
+  }
+  async function persistQuery(query) {
+    if (storage != null) {
+      const storageKey = `${prefix}-${query.queryHash}`;
+      storage.setItem(
+        storageKey,
+        await serialize({
+          state: query.state,
+          queryKey: query.queryKey,
+          queryHash: query.queryHash,
+          buster
+        })
+      );
+    }
+  }
+  async function persisterFn(queryFn, ctx, query) {
+    const matchesFilter = filters ? (0, import_query_core.matchQuery)(filters, query) : true;
+    if (matchesFilter && query.state.data === void 0 && storage != null) {
+      const restoredData = await retrieveQuery(
+        query.queryHash,
+        (persistedQuery) => {
+          query.setState({
+            dataUpdatedAt: persistedQuery.state.dataUpdatedAt,
+            errorUpdatedAt: persistedQuery.state.errorUpdatedAt
+          });
+          if (refetchOnRestore === "always" || refetchOnRestore === true && query.isStale()) {
+            query.fetch();
+          }
+        }
+      );
+      if (restoredData !== void 0) {
+        return Promise.resolve(restoredData);
+      }
+    }
+    const queryFnResult = await queryFn(ctx);
+    if (matchesFilter && storage != null) {
+      import_query_core.notifyManager.schedule(() => {
+        persistQuery(query);
+      });
+    }
+    return Promise.resolve(queryFnResult);
+  }
+  async function persisterGc() {
+    if (storage?.entries) {
+      const storageKeyPrefix = `${prefix}-`;
+      const entries = await storage.entries();
+      for (const [key, value] of entries) {
+        if (key.startsWith(storageKeyPrefix)) {
+          let persistedQuery;
+          try {
+            persistedQuery = await deserialize(value);
+          } catch {
+            await storage.removeItem(key);
+            continue;
+          }
+          if (isExpiredOrBusted(persistedQuery)) {
+            await storage.removeItem(key);
+          }
+        }
+      }
+    } else if (process.env.NODE_ENV === "development") {
+      throw new Error(
+        "Provided storage does not implement `entries` method. Garbage collection is not possible without ability to iterate over storage items."
+      );
+    }
+  }
+  async function restoreQueries(queryClient, filters2 = {}) {
+    const { exact, queryKey } = filters2;
+    if (storage?.entries) {
+      const storageKeyPrefix = `${prefix}-`;
+      const entries = await storage.entries();
+      for (const [key, value] of entries) {
+        if (key.startsWith(storageKeyPrefix)) {
+          let persistedQuery;
+          try {
+            persistedQuery = await deserialize(value);
+          } catch {
+            await storage.removeItem(key);
+            continue;
+          }
+          if (isExpiredOrBusted(persistedQuery)) {
+            await storage.removeItem(key);
+            continue;
+          }
+          if (queryKey) {
+            if (exact) {
+              if (persistedQuery.queryHash !== (0, import_query_core.hashKey)(queryKey)) {
+                continue;
+              }
+            } else if (!(0, import_query_core.partialMatchKey)(persistedQuery.queryKey, queryKey)) {
+              continue;
+            }
+          }
+          queryClient.setQueryData(
+            persistedQuery.queryKey,
+            persistedQuery.state.data,
+            {
+              updatedAt: persistedQuery.state.dataUpdatedAt
+            }
+          );
+        }
+      }
+    } else if (process.env.NODE_ENV === "development") {
+      throw new Error(
+        "Provided storage does not implement `entries` method. Restoration of all stored entries is not possible without ability to iterate over storage items."
+      );
+    }
+  }
+  async function removeQueries(filters2 = {}) {
+    const { exact, queryKey } = filters2;
+    if (storage?.entries) {
+      const entries = await storage.entries();
+      const storageKeyPrefix = `${prefix}-`;
+      for (const [key, value] of entries) {
+        if (key.startsWith(storageKeyPrefix)) {
+          if (!queryKey) {
+            await storage.removeItem(key);
+            continue;
+          }
+          let persistedQuery;
+          try {
+            persistedQuery = await deserialize(value);
+          } catch {
+            await storage.removeItem(key);
+            continue;
+          }
+          if (exact) {
+            if (persistedQuery.queryHash !== (0, import_query_core.hashKey)(queryKey)) {
+              continue;
+            }
+          } else if (!(0, import_query_core.partialMatchKey)(persistedQuery.queryKey, queryKey)) {
+            continue;
+          }
+          await storage.removeItem(key);
+        }
+      }
+    } else if (process.env.NODE_ENV === "development") {
+      throw new Error(
+        "Provided storage does not implement `entries` method. Removal of stored entries is not possible without ability to iterate over storage items."
+      );
+    }
+  }
+  return {
+    persisterFn,
+    persistQuery,
+    persistQueryByKey,
+    retrieveQuery,
+    persisterGc,
+    restoreQueries,
+    removeQueries
+  };
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  PERSISTER_KEY_PREFIX,
+  experimental_createQueryPersister
+});
+//# sourceMappingURL=createPersister.cjs.map

package/build/modern/createPersister.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/createPersister.ts"],"sourcesContent":["import {\n  hashKey,\n  matchQuery,\n  notifyManager,\n  partialMatchKey,\n} from '@tanstack/query-core'\nimport type {\n  Query,\n  QueryClient,\n  QueryFilters,\n  QueryFunctionContext,\n  QueryKey,\n  QueryState,\n} from '@tanstack/query-core'\n\nexport interface PersistedQuery {\n  buster: string\n  queryHash: string\n  queryKey: QueryKey\n  state: QueryState\n}\n\nexport type MaybePromise<T> = T | Promise<T>\n\nexport interface AsyncStorage<TStorageValue = string> {\n  getItem: (key: string) => MaybePromise<TStorageValue | undefined | null>\n  setItem: (key: string, value: TStorageValue) => MaybePromise<unknown>\n  removeItem: (key: string) => MaybePromise<void>\n  entries?: () => MaybePromise<Array<[key: string, value: TStorageValue]>>\n}\n\nexport interface StoragePersisterOptions<TStorageValue = string> {\n  /** The storage client used for setting and retrieving items from cache.\n   * For SSR pass in `undefined`.\n   */\n  storage: AsyncStorage<TStorageValue> | undefined | null\n  /**\n   * How to serialize the data to storage.\n   * @default `JSON.stringify`\n   */\n  serialize?: (persistedQuery: PersistedQuery) => MaybePromise<TStorageValue>\n  /**\n   * How to deserialize the data from storage.\n   * @default `JSON.parse`\n   */\n  deserialize?: (cachedString: TStorageValue) => MaybePromise<PersistedQuery>\n  /**\n   * A unique string that can be used to forcefully invalidate existing caches,\n   * if they do not share the same buster string\n   */\n  buster?: string\n  /**\n   * The max-allowed age of the cache in milliseconds.\n   * If a persisted cache is found that is older than this\n   * time, it will be discarded\n   * @default 24 hours\n   */\n  maxAge?: number\n  /**\n   * Prefix to be used for storage key.\n   * Storage key is a combination of prefix and query hash in a form of `prefix-queryHash`.\n   * @default 'tanstack-query'\n   */\n  prefix?: string\n  /**\n   * If set to `true`, the query will refetch on successful query restoration if the data is stale.\n   * If set to `false`, the query will not refetch on successful query restoration.\n   * If set to `'always'`, the query will always refetch on successful query restoration.\n   * Defaults to `true`.\n   */\n  refetchOnRestore?: boolean | 'always'\n  /**\n   * Filters to narrow down which Queries should be persisted.\n   */\n  filters?: QueryFilters\n}\n\nexport const PERSISTER_KEY_PREFIX = 'tanstack-query'\n\n/**\n * Warning: experimental feature.\n * This utility function enables fine-grained query persistence.\n * Simple add it as a `persister` parameter to `useQuery` or `defaultOptions` on `queryClient`.\n *\n * ```\n * useQuery({\n     queryKey: ['myKey'],\n     queryFn: fetcher,\n     persister: createPersister({\n       storage: localStorage,\n     }),\n   })\n   ```\n */\nexport function experimental_createQueryPersister<TStorageValue = string>({\n  storage,\n  buster = '',\n  maxAge = 1000 * 60 * 60 * 24,\n  serialize = JSON.stringify as Required<\n    StoragePersisterOptions<TStorageValue>\n  >['serialize'],\n  deserialize = JSON.parse as Required<\n    StoragePersisterOptions<TStorageValue>\n  >['deserialize'],\n  prefix = PERSISTER_KEY_PREFIX,\n  refetchOnRestore = true,\n  filters,\n}: StoragePersisterOptions<TStorageValue>) {\n  function isExpiredOrBusted(persistedQuery: PersistedQuery) {\n    if (persistedQuery.state.dataUpdatedAt) {\n      const queryAge = Date.now() - persistedQuery.state.dataUpdatedAt\n      const expired = queryAge > maxAge\n      const busted = persistedQuery.buster !== buster\n\n      if (expired || busted) {\n        return true\n      }\n\n      return false\n    }\n\n    return true\n  }\n\n  async function retrieveQuery<T>(\n    queryHash: string,\n    afterRestoreMacroTask?: (persistedQuery: PersistedQuery) => void,\n  ) {\n    if (storage != null) {\n      const storageKey = `${prefix}-${queryHash}`\n      try {\n        const storedData = await storage.getItem(storageKey)\n        if (storedData) {\n          let persistedQuery: PersistedQuery\n          try {\n            persistedQuery = await deserialize(storedData)\n          } catch {\n            await storage.removeItem(storageKey)\n            return\n          }\n\n          if (isExpiredOrBusted(persistedQuery)) {\n            await storage.removeItem(storageKey)\n          } else {\n            if (afterRestoreMacroTask) {\n              // Just after restoring we want to get fresh data from the server if it's stale\n              notifyManager.schedule(() =>\n                afterRestoreMacroTask(persistedQuery),\n              )\n            }\n            // We must resolve the promise here, as otherwise we will have `loading` state in the app until `queryFn` resolves\n            return persistedQuery.state.data as T\n          }\n        }\n      } catch (err) {\n        if (process.env.NODE_ENV === 'development') {\n          console.error(err)\n          console.warn(\n            'Encountered an error attempting to restore query cache from persisted location.',\n          )\n        }\n        await storage.removeItem(storageKey)\n      }\n    }\n\n    return\n  }\n\n  async function persistQueryByKey(\n    queryKey: QueryKey,\n    queryClient: QueryClient,\n  ) {\n    if (storage != null) {\n      const query = queryClient.getQueryCache().find({ queryKey })\n      if (query) {\n        await persistQuery(query)\n      } else {\n        if (process.env.NODE_ENV === 'development') {\n          console.warn(\n            'Could not find query to be persisted. QueryKey:',\n            JSON.stringify(queryKey),\n          )\n        }\n      }\n    }\n  }\n\n  async function persistQuery(query: Query) {\n    if (storage != null) {\n      const storageKey = `${prefix}-${query.queryHash}`\n      storage.setItem(\n        storageKey,\n        await serialize({\n          state: query.state,\n          queryKey: query.queryKey,\n          queryHash: query.queryHash,\n          buster: buster,\n        }),\n      )\n    }\n  }\n\n  async function persisterFn<T, TQueryKey extends QueryKey>(\n    queryFn: (context: QueryFunctionContext<TQueryKey>) => T | Promise<T>,\n    ctx: QueryFunctionContext<TQueryKey>,\n    query: Query,\n  ) {\n    const matchesFilter = filters ? matchQuery(filters, query) : true\n\n    // Try to restore only if we do not have any data in the cache and we have persister defined\n    if (matchesFilter && query.state.data === undefined && storage != null) {\n      const restoredData = await retrieveQuery(\n        query.queryHash,\n        (persistedQuery: PersistedQuery) => {\n          // Set proper updatedAt, since resolving in the first pass overrides those values\n          query.setState({\n            dataUpdatedAt: persistedQuery.state.dataUpdatedAt,\n            errorUpdatedAt: persistedQuery.state.errorUpdatedAt,\n          })\n\n          if (\n            refetchOnRestore === 'always' ||\n            (refetchOnRestore === true && query.isStale())\n          ) {\n            query.fetch()\n          }\n        },\n      )\n\n      if (restoredData !== undefined) {\n        return Promise.resolve(restoredData as T)\n      }\n    }\n\n    // If we did not restore, or restoration failed - fetch\n    const queryFnResult = await queryFn(ctx)\n\n    if (matchesFilter && storage != null) {\n      // Persist if we have storage defined, we use timeout to get proper state to be persisted\n      notifyManager.schedule(() => {\n        persistQuery(query)\n      })\n    }\n\n    return Promise.resolve(queryFnResult)\n  }\n\n  async function persisterGc() {\n    if (storage?.entries) {\n      const storageKeyPrefix = `${prefix}-`\n      const entries = await storage.entries()\n      for (const [key, value] of entries) {\n        if (key.startsWith(storageKeyPrefix)) {\n          let persistedQuery: PersistedQuery\n          try {\n            persistedQuery = await deserialize(value)\n          } catch {\n            await storage.removeItem(key)\n            continue\n          }\n          if (isExpiredOrBusted(persistedQuery)) {\n            await storage.removeItem(key)\n          }\n        }\n      }\n    } else if (process.env.NODE_ENV === 'development') {\n      throw new Error(\n        'Provided storage does not implement `entries` method. Garbage collection is not possible without ability to iterate over storage items.',\n      )\n    }\n  }\n\n  async function restoreQueries(\n    queryClient: QueryClient,\n    filters: Pick<QueryFilters, 'queryKey' | 'exact'> = {},\n  ): Promise<void> {\n    const { exact, queryKey } = filters\n\n    if (storage?.entries) {\n      const storageKeyPrefix = `${prefix}-`\n      const entries = await storage.entries()\n      for (const [key, value] of entries) {\n        if (key.startsWith(storageKeyPrefix)) {\n          let persistedQuery: PersistedQuery\n          try {\n            persistedQuery = await deserialize(value)\n          } catch {\n            await storage.removeItem(key)\n            continue\n          }\n          if (isExpiredOrBusted(persistedQuery)) {\n            await storage.removeItem(key)\n            continue\n          }\n\n          if (queryKey) {\n            if (exact) {\n              if (persistedQuery.queryHash !== hashKey(queryKey)) {\n                continue\n              }\n            } else if (!partialMatchKey(persistedQuery.queryKey, queryKey)) {\n              continue\n            }\n          }\n\n          queryClient.setQueryData(\n            persistedQuery.queryKey,\n            persistedQuery.state.data,\n            {\n              updatedAt: persistedQuery.state.dataUpdatedAt,\n            },\n          )\n        }\n      }\n    } else if (process.env.NODE_ENV === 'development') {\n      throw new Error(\n        'Provided storage does not implement `entries` method. Restoration of all stored entries is not possible without ability to iterate over storage items.',\n      )\n    }\n  }\n\n  async function removeQueries(\n    filters: Pick<QueryFilters, 'queryKey' | 'exact'> = {},\n  ): Promise<void> {\n    const { exact, queryKey } = filters\n\n    if (storage?.entries) {\n      const entries = await storage.entries()\n      const storageKeyPrefix = `${prefix}-`\n      for (const [key, value] of entries) {\n        if (key.startsWith(storageKeyPrefix)) {\n          if (!queryKey) {\n            await storage.removeItem(key)\n            continue\n          }\n\n          let persistedQuery: PersistedQuery\n          try {\n            persistedQuery = await deserialize(value)\n          } catch {\n            await storage.removeItem(key)\n            continue\n          }\n\n          if (exact) {\n            if (persistedQuery.queryHash !== hashKey(queryKey)) {\n              continue\n            }\n          } else if (!partialMatchKey(persistedQuery.queryKey, queryKey)) {\n            continue\n          }\n\n          await storage.removeItem(key)\n        }\n      }\n    } else if (process.env.NODE_ENV === 'development') {\n      throw new Error(\n        'Provided storage does not implement `entries` method. Removal of stored entries is not possible without ability to iterate over storage items.',\n      )\n    }\n  }\n\n  return {\n    persisterFn,\n    persistQuery,\n    persistQueryByKey,\n    retrieveQuery,\n    persisterGc,\n    restoreQueries,\n    removeQueries,\n  }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,wBAKO;AAwEA,IAAM,uBAAuB;AAiB7B,SAAS,kCAA0D;AAAA,EACxE;AAAA,EACA,SAAS;AAAA,EACT,SAAS,MAAO,KAAK,KAAK;AAAA,EAC1B,YAAY,KAAK;AAAA,EAGjB,cAAc,KAAK;AAAA,EAGnB,SAAS;AAAA,EACT,mBAAmB;AAAA,EACnB;AACF,GAA2C;AACzC,WAAS,kBAAkB,gBAAgC;AACzD,QAAI,eAAe,MAAM,eAAe;AACtC,YAAM,WAAW,KAAK,IAAI,IAAI,eAAe,MAAM;AACnD,YAAM,UAAU,WAAW;AAC3B,YAAM,SAAS,eAAe,WAAW;AAEzC,UAAI,WAAW,QAAQ;AACrB,eAAO;AAAA,MACT;AAEA,aAAO;AAAA,IACT;AAEA,WAAO;AAAA,EACT;AAEA,iBAAe,cACb,WACA,uBACA;AACA,QAAI,WAAW,MAAM;AACnB,YAAM,aAAa,GAAG,MAAM,IAAI,SAAS;AACzC,UAAI;AACF,cAAM,aAAa,MAAM,QAAQ,QAAQ,UAAU;AACnD,YAAI,YAAY;AACd,cAAI;AACJ,cAAI;AACF,6BAAiB,MAAM,YAAY,UAAU;AAAA,UAC/C,QAAQ;AACN,kBAAM,QAAQ,WAAW,UAAU;AACnC;AAAA,UACF;AAEA,cAAI,kBAAkB,cAAc,GAAG;AACrC,kBAAM,QAAQ,WAAW,UAAU;AAAA,UACrC,OAAO;AACL,gBAAI,uBAAuB;AAEzB,8CAAc;AAAA,gBAAS,MACrB,sBAAsB,cAAc;AAAA,cACtC;AAAA,YACF;AAEA,mBAAO,eAAe,MAAM;AAAA,UAC9B;AAAA,QACF;AAAA,MACF,SAAS,KAAK;AACZ,YAAI,QAAQ,IAAI,aAAa,eAAe;AAC1C,kBAAQ,MAAM,GAAG;AACjB,kBAAQ;AAAA,YACN;AAAA,UACF;AAAA,QACF;AACA,cAAM,QAAQ,WAAW,UAAU;AAAA,MACrC;AAAA,IACF;AAEA;AAAA,EACF;AAEA,iBAAe,kBACb,UACA,aACA;AACA,QAAI,WAAW,MAAM;AACnB,YAAM,QAAQ,YAAY,cAAc,EAAE,KAAK,EAAE,SAAS,CAAC;AAC3D,UAAI,OAAO;AACT,cAAM,aAAa,KAAK;AAAA,MAC1B,OAAO;AACL,YAAI,QAAQ,IAAI,aAAa,eAAe;AAC1C,kBAAQ;AAAA,YACN;AAAA,YACA,KAAK,UAAU,QAAQ;AAAA,UACzB;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,iBAAe,aAAa,OAAc;AACxC,QAAI,WAAW,MAAM;AACnB,YAAM,aAAa,GAAG,MAAM,IAAI,MAAM,SAAS;AAC/C,cAAQ;AAAA,QACN;AAAA,QACA,MAAM,UAAU;AAAA,UACd,OAAO,MAAM;AAAA,UACb,UAAU,MAAM;AAAA,UAChB,WAAW,MAAM;AAAA,UACjB;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF;AAAA,EACF;AAEA,iBAAe,YACb,SACA,KACA,OACA;AACA,UAAM,gBAAgB,cAAU,8BAAW,SAAS,KAAK,IAAI;AAG7D,QAAI,iBAAiB,MAAM,MAAM,SAAS,UAAa,WAAW,MAAM;AACtE,YAAM,eAAe,MAAM;AAAA,QACzB,MAAM;AAAA,QACN,CAAC,mBAAmC;AAElC,gBAAM,SAAS;AAAA,YACb,eAAe,eAAe,MAAM;AAAA,YACpC,gBAAgB,eAAe,MAAM;AAAA,UACvC,CAAC;AAED,cACE,qBAAqB,YACpB,qBAAqB,QAAQ,MAAM,QAAQ,GAC5C;AACA,kBAAM,MAAM;AAAA,UACd;AAAA,QACF;AAAA,MACF;AAEA,UAAI,iBAAiB,QAAW;AAC9B,eAAO,QAAQ,QAAQ,YAAiB;AAAA,MAC1C;AAAA,IACF;AAGA,UAAM,gBAAgB,MAAM,QAAQ,GAAG;AAEvC,QAAI,iBAAiB,WAAW,MAAM;AAEpC,sCAAc,SAAS,MAAM;AAC3B,qBAAa,KAAK;AAAA,MACpB,CAAC;AAAA,IACH;AAEA,WAAO,QAAQ,QAAQ,aAAa;AAAA,EACtC;AAEA,iBAAe,cAAc;AAC3B,QAAI,SAAS,SAAS;AACpB,YAAM,mBAAmB,GAAG,MAAM;AAClC,YAAM,UAAU,MAAM,QAAQ,QAAQ;AACtC,iBAAW,CAAC,KAAK,KAAK,KAAK,SAAS;AAClC,YAAI,IAAI,WAAW,gBAAgB,GAAG;AACpC,cAAI;AACJ,cAAI;AACF,6BAAiB,MAAM,YAAY,KAAK;AAAA,UAC1C,QAAQ;AACN,kBAAM,QAAQ,WAAW,GAAG;AAC5B;AAAA,UACF;AACA,cAAI,kBAAkB,cAAc,GAAG;AACrC,kBAAM,QAAQ,WAAW,GAAG;AAAA,UAC9B;AAAA,QACF;AAAA,MACF;AAAA,IACF,WAAW,QAAQ,IAAI,aAAa,eAAe;AACjD,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,iBAAe,eACb,aACAA,WAAoD,CAAC,GACtC;AACf,UAAM,EAAE,OAAO,SAAS,IAAIA;AAE5B,QAAI,SAAS,SAAS;AACpB,YAAM,mBAAmB,GAAG,MAAM;AAClC,YAAM,UAAU,MAAM,QAAQ,QAAQ;AACtC,iBAAW,CAAC,KAAK,KAAK,KAAK,SAAS;AAClC,YAAI,IAAI,WAAW,gBAAgB,GAAG;AACpC,cAAI;AACJ,cAAI;AACF,6BAAiB,MAAM,YAAY,KAAK;AAAA,UAC1C,QAAQ;AACN,kBAAM,QAAQ,WAAW,GAAG;AAC5B;AAAA,UACF;AACA,cAAI,kBAAkB,cAAc,GAAG;AACrC,kBAAM,QAAQ,WAAW,GAAG;AAC5B;AAAA,UACF;AAEA,cAAI,UAAU;AACZ,gBAAI,OAAO;AACT,kBAAI,eAAe,kBAAc,2BAAQ,QAAQ,GAAG;AAClD;AAAA,cACF;AAAA,YACF,WAAW,KAAC,mCAAgB,eAAe,UAAU,QAAQ,GAAG;AAC9D;AAAA,YACF;AAAA,UACF;AAEA,sBAAY;AAAA,YACV,eAAe;AAAA,YACf,eAAe,MAAM;AAAA,YACrB;AAAA,cACE,WAAW,eAAe,MAAM;AAAA,YAClC;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF,WAAW,QAAQ,IAAI,aAAa,eAAe;AACjD,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,iBAAe,cACbA,WAAoD,CAAC,GACtC;AACf,UAAM,EAAE,OAAO,SAAS,IAAIA;AAE5B,QAAI,SAAS,SAAS;AACpB,YAAM,UAAU,MAAM,QAAQ,QAAQ;AACtC,YAAM,mBAAmB,GAAG,MAAM;AAClC,iBAAW,CAAC,KAAK,KAAK,KAAK,SAAS;AAClC,YAAI,IAAI,WAAW,gBAAgB,GAAG;AACpC,cAAI,CAAC,UAAU;AACb,kBAAM,QAAQ,WAAW,GAAG;AAC5B;AAAA,UACF;AAEA,cAAI;AACJ,cAAI;AACF,6BAAiB,MAAM,YAAY,KAAK;AAAA,UAC1C,QAAQ;AACN,kBAAM,QAAQ,WAAW,GAAG;AAC5B;AAAA,UACF;AAEA,cAAI,OAAO;AACT,gBAAI,eAAe,kBAAc,2BAAQ,QAAQ,GAAG;AAClD;AAAA,YACF;AAAA,UACF,WAAW,KAAC,mCAAgB,eAAe,UAAU,QAAQ,GAAG;AAC9D;AAAA,UACF;AAEA,gBAAM,QAAQ,WAAW,GAAG;AAAA,QAC9B;AAAA,MACF;AAAA,IACF,WAAW,QAAQ,IAAI,aAAa,eAAe;AACjD,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;","names":["filters"]}

package/build/modern/createPersister.d.cts

@@ -0,0 +1,6 @@
+export { experimental_createQueryPersister } from './_tsup-dts-rollup.cjs';
+export { PersistedQuery } from './_tsup-dts-rollup.cjs';
+export { MaybePromise } from './_tsup-dts-rollup.cjs';
+export { AsyncStorage } from './_tsup-dts-rollup.cjs';
+export { StoragePersisterOptions } from './_tsup-dts-rollup.cjs';
+export { PERSISTER_KEY_PREFIX } from './_tsup-dts-rollup.cjs';

package/build/modern/createPersister.d.ts

@@ -0,0 +1,6 @@
+export { experimental_createQueryPersister } from './_tsup-dts-rollup.js';
+export { PersistedQuery } from './_tsup-dts-rollup.js';
+export { MaybePromise } from './_tsup-dts-rollup.js';
+export { AsyncStorage } from './_tsup-dts-rollup.js';
+export { StoragePersisterOptions } from './_tsup-dts-rollup.js';
+export { PERSISTER_KEY_PREFIX } from './_tsup-dts-rollup.js';