@tanstack/query-persist-client-core 5.104.1 → 5.104.2

package/build/legacy/createPersister.cjs

@@ -9,15 +9,25 @@ const PERSISTER_KEY_PREFIX = "tanstack-query";
 *
 * ```
 * useQuery({
-queryKey: ['myKey'],
-queryFn: fetcher,
-persister: createPersister({
-storage: localStorage,
-}),
-})
-```
+*   queryKey: ['myKey'],
+*   queryFn: fetcher,
+*   persister: createPersister({
+*     storage: localStorage,
+*   }),
+* })
+* ```
+* @param options - The storage to persist to, and the options for serializing, expiring, and
+* filtering persisted queries.
+* @returns The `persisterFn` to pass as a query's `persister`, plus functions to persist, retrieve,
+* restore, remove, and garbage collect persisted queries manually.
 */
 function experimental_createQueryPersister({ storage, buster = "", maxAge = 864e5, serialize = JSON.stringify, deserialize = JSON.parse, prefix = PERSISTER_KEY_PREFIX, refetchOnRestore = true, filters }) {
+	/**
+	* Checks whether a persisted query should be discarded.
+	* @param persistedQuery - The persisted query to check.
+	* @returns `true` if it has no `dataUpdatedAt`, is older than `maxAge`, or has a different
+	* `buster`.
+	*/
 	function isExpiredOrBusted(persistedQuery) {
 		if (persistedQuery.state.dataUpdatedAt) {
 			const expired = Date.now() - persistedQuery.state.dataUpdatedAt > maxAge;
@@ -27,6 +37,14 @@ function experimental_createQueryPersister({ storage, buster = "", maxAge = 864e
 		}
 		return true;
 	}
+	/**
+	* Reads the persisted data of a query from storage. Expired, busted, or unreadable entries are
+	* removed instead.
+	* @param queryHash - The hash of the query to read.
+	* @param afterRestoreMacroTask - Scheduled with the persisted query after it is restored.
+	* @returns A promise that resolves with the persisted data, or `undefined` if nothing was
+	* restored.
+	*/
 	async function retrieveQuery(queryHash, afterRestoreMacroTask) {
 		if (storage != null) {
 			const storageKey = `${prefix}-${queryHash}`;
@@ -55,6 +73,12 @@ function experimental_createQueryPersister({ storage, buster = "", maxAge = 864e
 			}
 		}
 	}
+	/**
+	* Persists the query with the given key, if it exists in the client's cache.
+	* @param queryKey - The key of the query to persist.
+	* @param queryClient - The client whose cache holds the query.
+	* @returns A promise that resolves once the query is persisted.
+	*/
 	async function persistQueryByKey(queryKey, queryClient) {
 		if (storage != null) {
 			const query = queryClient.getQueryCache().find({ queryKey });
@@ -62,6 +86,11 @@ function experimental_createQueryPersister({ storage, buster = "", maxAge = 864e
 			else if (process.env.NODE_ENV === "development") console.warn("Could not find query to be persisted. QueryKey:", JSON.stringify(queryKey));
 		}
 	}
+	/**
+	* Writes a query's state, key, hash, and `buster` to storage.
+	* @param query - The query to persist.
+	* @returns A promise that resolves once the entry is serialized and written.
+	*/
 	async function persistQuery(query) {
 		if (storage != null) {
 			const storageKey = `${prefix}-${query.queryHash}`;
@@ -73,6 +102,14 @@ function experimental_createQueryPersister({ storage, buster = "", maxAge = 864e
 			}));
 		}
 	}
+	/**
+	* The `persister` of a query: restores its data from storage if the query has none yet, otherwise
+	* runs `queryFn` and persists the result.
+	* @param queryFn - The query's own query function.
+	* @param ctx - The context passed to `queryFn`.
+	* @param query - The query being fetched.
+	* @returns A promise that resolves with the restored or fetched data.
+	*/
 	async function persisterFn(queryFn, ctx, query) {
 		const matchesFilter = filters ? (0, _tanstack_query_core.matchQuery)(filters, query) : true;
 		if (matchesFilter && query.state.data === void 0 && storage != null) {
@@ -91,6 +128,11 @@ function experimental_createQueryPersister({ storage, buster = "", maxAge = 864e
 		});
 		return Promise.resolve(queryFnResult);
 	}
+	/**
+	* Removes expired, busted, or unreadable entries from storage. Requires the storage to implement
+	* `entries`.
+	* @returns A promise that resolves once every entry is checked.
+	*/
 	async function persisterGc() {
 		if (storage === null || storage === void 0 ? void 0 : storage.entries) {
 			const storageKeyPrefix = `${prefix}-`;
@@ -107,6 +149,14 @@ function experimental_createQueryPersister({ storage, buster = "", maxAge = 864e
 			}
 		} 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.");
 	}
+	/**
+	* Restores every persisted query matching `filters` into the client's cache with
+	* `queryClient.setQueryData`. Requires the storage to implement `entries`.
+	* @param queryClient - The client to restore the queries into.
+	* @param filters - The `queryKey` and `exact` filters to match. Without them, every query is
+	* restored.
+	* @returns A promise that resolves once every entry is checked.
+	*/
 	async function restoreQueries(queryClient, filters = {}) {
 		const { exact, queryKey } = filters;
 		if (storage === null || storage === void 0 ? void 0 : storage.entries) {
@@ -133,6 +183,13 @@ function experimental_createQueryPersister({ storage, buster = "", maxAge = 864e
 			}
 		} 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.");
 	}
+	/**
+	* Removes every persisted query matching `filters` from storage. Requires the storage to implement
+	* `entries`.
+	* @param filters - The `queryKey` and `exact` filters to match. Without them, every query is
+	* removed.
+	* @returns A promise that resolves once every entry is checked.
+	*/
 	async function removeQueries(filters = {}) {
 		const { exact, queryKey } = filters;
 		if (storage === null || storage === void 0 ? void 0 : storage.entries) {

package/build/legacy/createPersister.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"createPersister.cjs","names":["matchQuery","hashKey","partialMatchKey"],"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   *\n   * @defaultValue 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 != null) {\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":";;;AA8EA,MAAa,uBAAuB;;;;;;;;;;;;;;;;AAiBpC,SAAgB,kCAA0D,EACxE,SACA,SAAS,IACT,SAAS,OACT,YAAY,KAAK,WAGjB,cAAc,KAAK,OAGnB,SAAS,sBACT,mBAAmB,MACnB,WACyC;CACzC,SAAS,kBAAkB,gBAAgC;EACzD,IAAI,eAAe,MAAM,eAAe;GAEtC,MAAM,UADW,KAAK,IAAI,IAAI,eAAe,MAAM,gBACxB;GAC3B,MAAM,SAAS,eAAe,WAAW;GAEzC,IAAI,WAAW,QACb,OAAO;GAGT,OAAO;EACT;EAEA,OAAO;CACT;CAEA,eAAe,cACb,WACA,uBACA;EACA,IAAI,WAAW,MAAM;GACnB,MAAM,aAAa,GAAG,OAAO,GAAG;GAChC,IAAI;IACF,MAAM,aAAa,MAAM,QAAQ,QAAQ,UAAU;IACnD,IAAI,cAAc,MAAM;KACtB,IAAI;KACJ,IAAI;MACF,iBAAiB,MAAM,YAAY,UAAU;KAC/C,QAAQ;MACN,MAAM,QAAQ,WAAW,UAAU;MACnC;KACF;KAEA,IAAI,kBAAkB,cAAc,GAClC,MAAM,QAAQ,WAAW,UAAU;UAC9B;MACL,IAAI,uBAEF,qBAAA,cAAc,eACZ,sBAAsB,cAAc,CACtC;MAGF,OAAO,eAAe,MAAM;KAC9B;IACF;GACF,SAAS,KAAK;IACZ,IAAI,QAAQ,IAAI,aAAa,eAAe;KAC1C,QAAQ,MAAM,GAAG;KACjB,QAAQ,KACN,iFACF;IACF;IACA,MAAM,QAAQ,WAAW,UAAU;GACrC;EACF;CAGF;CAEA,eAAe,kBACb,UACA,aACA;EACA,IAAI,WAAW,MAAM;GACnB,MAAM,QAAQ,YAAY,cAAc,CAAC,CAAC,KAAK,EAAE,SAAS,CAAC;GAC3D,IAAI,OACF,MAAM,aAAa,KAAK;QAExB,IAAI,QAAQ,IAAI,aAAa,eAC3B,QAAQ,KACN,mDACA,KAAK,UAAU,QAAQ,CACzB;EAGN;CACF;CAEA,eAAe,aAAa,OAAc;EACxC,IAAI,WAAW,MAAM;GACnB,MAAM,aAAa,GAAG,OAAO,GAAG,MAAM;GACtC,QAAQ,QACN,YACA,MAAM,UAAU;IACd,OAAO,MAAM;IACb,UAAU,MAAM;IAChB,WAAW,MAAM;IACT;GACV,CAAC,CACH;EACF;CACF;CAEA,eAAe,YACb,SACA,KACA,OACA;EACA,MAAM,gBAAgB,WAAA,GAAUA,qBAAAA,WAAAA,CAAW,SAAS,KAAK,IAAI;EAG7D,IAAI,iBAAiB,MAAM,MAAM,SAAS,KAAA,KAAa,WAAW,MAAM;GACtE,MAAM,eAAe,MAAM,cACzB,MAAM,YACL,mBAAmC;IAElC,MAAM,SAAS;KACb,eAAe,eAAe,MAAM;KACpC,gBAAgB,eAAe,MAAM;IACvC,CAAC;IAED,IACE,qBAAqB,YACpB,qBAAqB,QAAQ,MAAM,QAAQ,GAE5C,MAAM,MAAM;GAEhB,CACF;GAEA,IAAI,iBAAiB,KAAA,GACnB,OAAO,QAAQ,QAAQ,YAAiB;EAE5C;EAGA,MAAM,gBAAgB,MAAM,QAAQ,GAAG;EAEvC,IAAI,iBAAiB,WAAW,MAE9B,qBAAA,cAAc,eAAe;GAC3B,aAAa,KAAK;EACpB,CAAC;EAGH,OAAO,QAAQ,QAAQ,aAAa;CACtC;CAEA,eAAe,cAAc;EAC3B,IAAA,YAAA,QAAA,YAAA,KAAA,IAAA,KAAA,IAAI,QAAS,SAAS;GACpB,MAAM,mBAAmB,GAAG,OAAO;GACnC,MAAM,UAAU,MAAM,QAAQ,QAAQ;GACtC,KAAK,MAAM,CAAC,KAAK,UAAU,SACzB,IAAI,IAAI,WAAW,gBAAgB,GAAG;IACpC,IAAI;IACJ,IAAI;KACF,iBAAiB,MAAM,YAAY,KAAK;IAC1C,QAAQ;KACN,MAAM,QAAQ,WAAW,GAAG;KAC5B;IACF;IACA,IAAI,kBAAkB,cAAc,GAClC,MAAM,QAAQ,WAAW,GAAG;GAEhC;EAEJ,OAAO,IAAI,QAAQ,IAAI,aAAa,eAClC,MAAM,IAAI,MACR,yIACF;CAEJ;CAEA,eAAe,eACb,aACA,UAAoD,CAAC,GACtC;EACf,MAAM,EAAE,OAAO,aAAa;EAE5B,IAAA,YAAA,QAAA,YAAA,KAAA,IAAA,KAAA,IAAI,QAAS,SAAS;GACpB,MAAM,mBAAmB,GAAG,OAAO;GACnC,MAAM,UAAU,MAAM,QAAQ,QAAQ;GACtC,KAAK,MAAM,CAAC,KAAK,UAAU,SACzB,IAAI,IAAI,WAAW,gBAAgB,GAAG;IACpC,IAAI;IACJ,IAAI;KACF,iBAAiB,MAAM,YAAY,KAAK;IAC1C,QAAQ;KACN,MAAM,QAAQ,WAAW,GAAG;KAC5B;IACF;IACA,IAAI,kBAAkB,cAAc,GAAG;KACrC,MAAM,QAAQ,WAAW,GAAG;KAC5B;IACF;IAEA,IAAI,UAAU;KACZ,IAAI,OACE;UAAA,eAAe,eAAA,GAAcC,qBAAAA,QAAAA,CAAQ,QAAQ,GAC/C;KAAA,OAEG,IAAI,EAAA,GAACC,qBAAAA,gBAAAA,CAAgB,eAAe,UAAU,QAAQ,GAC3D;IAEJ;IAEA,YAAY,aACV,eAAe,UACf,eAAe,MAAM,MACrB,EACE,WAAW,eAAe,MAAM,cAClC,CACF;GACF;EAEJ,OAAO,IAAI,QAAQ,IAAI,aAAa,eAClC,MAAM,IAAI,MACR,wJACF;CAEJ;CAEA,eAAe,cACb,UAAoD,CAAC,GACtC;EACf,MAAM,EAAE,OAAO,aAAa;EAE5B,IAAA,YAAA,QAAA,YAAA,KAAA,IAAA,KAAA,IAAI,QAAS,SAAS;GACpB,MAAM,UAAU,MAAM,QAAQ,QAAQ;GACtC,MAAM,mBAAmB,GAAG,OAAO;GACnC,KAAK,MAAM,CAAC,KAAK,UAAU,SACzB,IAAI,IAAI,WAAW,gBAAgB,GAAG;IACpC,IAAI,CAAC,UAAU;KACb,MAAM,QAAQ,WAAW,GAAG;KAC5B;IACF;IAEA,IAAI;IACJ,IAAI;KACF,iBAAiB,MAAM,YAAY,KAAK;IAC1C,QAAQ;KACN,MAAM,QAAQ,WAAW,GAAG;KAC5B;IACF;IAEA,IAAI,OACE;SAAA,eAAe,eAAA,GAAcD,qBAAAA,QAAAA,CAAQ,QAAQ,GAC/C;IAAA,OAEG,IAAI,EAAA,GAACC,qBAAAA,gBAAAA,CAAgB,eAAe,UAAU,QAAQ,GAC3D;IAGF,MAAM,QAAQ,WAAW,GAAG;GAC9B;EAEJ,OAAO,IAAI,QAAQ,IAAI,aAAa,eAClC,MAAM,IAAI,MACR,gJACF;CAEJ;CAEA,OAAO;EACL;EACA;EACA;EACA;EACA;EACA;EACA;CACF;AACF"}
+{"version":3,"file":"createPersister.cjs","names":["matchQuery","hashKey","partialMatchKey"],"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\n/**\n * A single query as stored by {@link experimental_createQueryPersister}.\n */\nexport interface PersistedQuery {\n  /**\n   * The `buster` the query was saved with. Entries with a different `buster` are discarded.\n   */\n  buster: string\n  /**\n   * The hash of the query.\n   */\n  queryHash: string\n  /**\n   * The key of the query.\n   */\n  queryKey: QueryKey\n  /**\n   * The state of the query, including its data and when it was last updated.\n   */\n  state: QueryState\n}\n\n/**\n * A value, or a promise that resolves to it.\n */\nexport type MaybePromise<T> = T | Promise<T>\n\n/**\n * A key-value storage, such as `localStorage` or `AsyncStorage`, whose methods may be synchronous\n * or return promises.\n */\nexport interface AsyncStorage<TStorageValue = string> {\n  /**\n   * Reads the value stored under `key`, or `null`/`undefined` if there is none.\n   */\n  getItem: (key: string) => MaybePromise<TStorageValue | undefined | null>\n  /**\n   * Stores `value` under `key`.\n   */\n  setItem: (key: string, value: TStorageValue) => MaybePromise<unknown>\n  /**\n   * Removes the value stored under `key`.\n   */\n  removeItem: (key: string) => MaybePromise<void>\n  /**\n   * Returns all stored key-value pairs. Required for removing expired entries in bulk.\n   */\n  entries?: () => MaybePromise<Array<[key: string, value: TStorageValue]>>\n}\n\n/**\n * Options for {@link experimental_createQueryPersister}.\n */\nexport interface StoragePersisterOptions<TStorageValue = string> {\n  /**\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   * @defaultValue 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 * @param options - The storage to persist to, and the options for serializing, expiring, and\n * filtering persisted queries.\n * @returns The `persisterFn` to pass as a query's `persister`, plus functions to persist, retrieve,\n * restore, remove, and garbage collect persisted queries manually.\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  /**\n   * Checks whether a persisted query should be discarded.\n   * @param persistedQuery - The persisted query to check.\n   * @returns `true` if it has no `dataUpdatedAt`, is older than `maxAge`, or has a different\n   * `buster`.\n   */\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  /**\n   * Reads the persisted data of a query from storage. Expired, busted, or unreadable entries are\n   * removed instead.\n   * @param queryHash - The hash of the query to read.\n   * @param afterRestoreMacroTask - Scheduled with the persisted query after it is restored.\n   * @returns A promise that resolves with the persisted data, or `undefined` if nothing was\n   * restored.\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 != null) {\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  /**\n   * Persists the query with the given key, if it exists in the client's cache.\n   * @param queryKey - The key of the query to persist.\n   * @param queryClient - The client whose cache holds the query.\n   * @returns A promise that resolves once the query is persisted.\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  /**\n   * Writes a query's state, key, hash, and `buster` to storage.\n   * @param query - The query to persist.\n   * @returns A promise that resolves once the entry is serialized and written.\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  /**\n   * The `persister` of a query: restores its data from storage if the query has none yet, otherwise\n   * runs `queryFn` and persists the result.\n   * @param queryFn - The query's own query function.\n   * @param ctx - The context passed to `queryFn`.\n   * @param query - The query being fetched.\n   * @returns A promise that resolves with the restored or fetched data.\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  /**\n   * Removes expired, busted, or unreadable entries from storage. Requires the storage to implement\n   * `entries`.\n   * @returns A promise that resolves once every entry is checked.\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  /**\n   * Restores every persisted query matching `filters` into the client's cache with\n   * `queryClient.setQueryData`. Requires the storage to implement `entries`.\n   * @param queryClient - The client to restore the queries into.\n   * @param filters - The `queryKey` and `exact` filters to match. Without them, every query is\n   * restored.\n   * @returns A promise that resolves once every entry is checked.\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  /**\n   * Removes every persisted query matching `filters` from storage. Requires the storage to implement\n   * `entries`.\n   * @param filters - The `queryKey` and `exact` filters to match. Without them, every query is\n   * removed.\n   * @returns A promise that resolves once every entry is checked.\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":";;;AAmHA,MAAa,uBAAuB;;;;;;;;;;;;;;;;;;;;AAqBpC,SAAgB,kCAA0D,EACxE,SACA,SAAS,IACT,SAAS,OACT,YAAY,KAAK,WAGjB,cAAc,KAAK,OAGnB,SAAS,sBACT,mBAAmB,MACnB,WACyC;;;;;;;CAOzC,SAAS,kBAAkB,gBAAgC;EACzD,IAAI,eAAe,MAAM,eAAe;GAEtC,MAAM,UADW,KAAK,IAAI,IAAI,eAAe,MAAM,gBACxB;GAC3B,MAAM,SAAS,eAAe,WAAW;GAEzC,IAAI,WAAW,QACb,OAAO;GAGT,OAAO;EACT;EAEA,OAAO;CACT;;;;;;;;;CAUA,eAAe,cACb,WACA,uBACA;EACA,IAAI,WAAW,MAAM;GACnB,MAAM,aAAa,GAAG,OAAO,GAAG;GAChC,IAAI;IACF,MAAM,aAAa,MAAM,QAAQ,QAAQ,UAAU;IACnD,IAAI,cAAc,MAAM;KACtB,IAAI;KACJ,IAAI;MACF,iBAAiB,MAAM,YAAY,UAAU;KAC/C,QAAQ;MACN,MAAM,QAAQ,WAAW,UAAU;MACnC;KACF;KAEA,IAAI,kBAAkB,cAAc,GAClC,MAAM,QAAQ,WAAW,UAAU;UAC9B;MACL,IAAI,uBAEF,qBAAA,cAAc,eACZ,sBAAsB,cAAc,CACtC;MAGF,OAAO,eAAe,MAAM;KAC9B;IACF;GACF,SAAS,KAAK;IACZ,IAAI,QAAQ,IAAI,aAAa,eAAe;KAC1C,QAAQ,MAAM,GAAG;KACjB,QAAQ,KACN,iFACF;IACF;IACA,MAAM,QAAQ,WAAW,UAAU;GACrC;EACF;CAGF;;;;;;;CAQA,eAAe,kBACb,UACA,aACA;EACA,IAAI,WAAW,MAAM;GACnB,MAAM,QAAQ,YAAY,cAAc,CAAC,CAAC,KAAK,EAAE,SAAS,CAAC;GAC3D,IAAI,OACF,MAAM,aAAa,KAAK;QAExB,IAAI,QAAQ,IAAI,aAAa,eAC3B,QAAQ,KACN,mDACA,KAAK,UAAU,QAAQ,CACzB;EAGN;CACF;;;;;;CAOA,eAAe,aAAa,OAAc;EACxC,IAAI,WAAW,MAAM;GACnB,MAAM,aAAa,GAAG,OAAO,GAAG,MAAM;GACtC,QAAQ,QACN,YACA,MAAM,UAAU;IACd,OAAO,MAAM;IACb,UAAU,MAAM;IAChB,WAAW,MAAM;IACT;GACV,CAAC,CACH;EACF;CACF;;;;;;;;;CAUA,eAAe,YACb,SACA,KACA,OACA;EACA,MAAM,gBAAgB,WAAA,GAAUA,qBAAAA,WAAAA,CAAW,SAAS,KAAK,IAAI;EAG7D,IAAI,iBAAiB,MAAM,MAAM,SAAS,KAAA,KAAa,WAAW,MAAM;GACtE,MAAM,eAAe,MAAM,cACzB,MAAM,YACL,mBAAmC;IAElC,MAAM,SAAS;KACb,eAAe,eAAe,MAAM;KACpC,gBAAgB,eAAe,MAAM;IACvC,CAAC;IAED,IACE,qBAAqB,YACpB,qBAAqB,QAAQ,MAAM,QAAQ,GAE5C,MAAM,MAAM;GAEhB,CACF;GAEA,IAAI,iBAAiB,KAAA,GACnB,OAAO,QAAQ,QAAQ,YAAiB;EAE5C;EAGA,MAAM,gBAAgB,MAAM,QAAQ,GAAG;EAEvC,IAAI,iBAAiB,WAAW,MAE9B,qBAAA,cAAc,eAAe;GAC3B,aAAa,KAAK;EACpB,CAAC;EAGH,OAAO,QAAQ,QAAQ,aAAa;CACtC;;;;;;CAOA,eAAe,cAAc;EAC3B,IAAA,YAAA,QAAA,YAAA,KAAA,IAAA,KAAA,IAAI,QAAS,SAAS;GACpB,MAAM,mBAAmB,GAAG,OAAO;GACnC,MAAM,UAAU,MAAM,QAAQ,QAAQ;GACtC,KAAK,MAAM,CAAC,KAAK,UAAU,SACzB,IAAI,IAAI,WAAW,gBAAgB,GAAG;IACpC,IAAI;IACJ,IAAI;KACF,iBAAiB,MAAM,YAAY,KAAK;IAC1C,QAAQ;KACN,MAAM,QAAQ,WAAW,GAAG;KAC5B;IACF;IACA,IAAI,kBAAkB,cAAc,GAClC,MAAM,QAAQ,WAAW,GAAG;GAEhC;EAEJ,OAAO,IAAI,QAAQ,IAAI,aAAa,eAClC,MAAM,IAAI,MACR,yIACF;CAEJ;;;;;;;;;CAUA,eAAe,eACb,aACA,UAAoD,CAAC,GACtC;EACf,MAAM,EAAE,OAAO,aAAa;EAE5B,IAAA,YAAA,QAAA,YAAA,KAAA,IAAA,KAAA,IAAI,QAAS,SAAS;GACpB,MAAM,mBAAmB,GAAG,OAAO;GACnC,MAAM,UAAU,MAAM,QAAQ,QAAQ;GACtC,KAAK,MAAM,CAAC,KAAK,UAAU,SACzB,IAAI,IAAI,WAAW,gBAAgB,GAAG;IACpC,IAAI;IACJ,IAAI;KACF,iBAAiB,MAAM,YAAY,KAAK;IAC1C,QAAQ;KACN,MAAM,QAAQ,WAAW,GAAG;KAC5B;IACF;IACA,IAAI,kBAAkB,cAAc,GAAG;KACrC,MAAM,QAAQ,WAAW,GAAG;KAC5B;IACF;IAEA,IAAI,UAAU;KACZ,IAAI,OACE;UAAA,eAAe,eAAA,GAAcC,qBAAAA,QAAAA,CAAQ,QAAQ,GAC/C;KAAA,OAEG,IAAI,EAAA,GAACC,qBAAAA,gBAAAA,CAAgB,eAAe,UAAU,QAAQ,GAC3D;IAEJ;IAEA,YAAY,aACV,eAAe,UACf,eAAe,MAAM,MACrB,EACE,WAAW,eAAe,MAAM,cAClC,CACF;GACF;EAEJ,OAAO,IAAI,QAAQ,IAAI,aAAa,eAClC,MAAM,IAAI,MACR,wJACF;CAEJ;;;;;;;;CASA,eAAe,cACb,UAAoD,CAAC,GACtC;EACf,MAAM,EAAE,OAAO,aAAa;EAE5B,IAAA,YAAA,QAAA,YAAA,KAAA,IAAA,KAAA,IAAI,QAAS,SAAS;GACpB,MAAM,UAAU,MAAM,QAAQ,QAAQ;GACtC,MAAM,mBAAmB,GAAG,OAAO;GACnC,KAAK,MAAM,CAAC,KAAK,UAAU,SACzB,IAAI,IAAI,WAAW,gBAAgB,GAAG;IACpC,IAAI,CAAC,UAAU;KACb,MAAM,QAAQ,WAAW,GAAG;KAC5B;IACF;IAEA,IAAI;IACJ,IAAI;KACF,iBAAiB,MAAM,YAAY,KAAK;IAC1C,QAAQ;KACN,MAAM,QAAQ,WAAW,GAAG;KAC5B;IACF;IAEA,IAAI,OACE;SAAA,eAAe,eAAA,GAAcD,qBAAAA,QAAAA,CAAQ,QAAQ,GAC/C;IAAA,OAEG,IAAI,EAAA,GAACC,qBAAAA,gBAAAA,CAAgB,eAAe,UAAU,QAAQ,GAC3D;IAGF,MAAM,QAAQ,WAAW,GAAG;GAC9B;EAEJ,OAAO,IAAI,QAAQ,IAAI,aAAa,eAClC,MAAM,IAAI,MACR,gJACF;CAEJ;CAEA,OAAO;EACL;EACA;EACA;EACA;EACA;EACA;EACA;CACF;AACF"}

package/build/legacy/createPersister.d.cts

@@ -1,20 +1,58 @@
 import { Query, QueryClient, QueryFilters, QueryFunctionContext, QueryKey, QueryState } from "@tanstack/query-core";
 //#region src/createPersister.d.ts
+/**
+ * A single query as stored by {@link experimental_createQueryPersister}.
+ */
 export interface PersistedQuery {
+  /**
+   * The `buster` the query was saved with. Entries with a different `buster` are discarded.
+   */
   buster: string;
+  /**
+   * The hash of the query.
+   */
   queryHash: string;
+  /**
+   * The key of the query.
+   */
   queryKey: QueryKey;
+  /**
+   * The state of the query, including its data and when it was last updated.
+   */
   state: QueryState;
 }
+/**
+ * A value, or a promise that resolves to it.
+ */
 export type MaybePromise<T> = T | Promise<T>;
+/**
+ * A key-value storage, such as `localStorage` or `AsyncStorage`, whose methods may be synchronous
+ * or return promises.
+ */
 export interface AsyncStorage<TStorageValue = string> {
+  /**
+   * Reads the value stored under `key`, or `null`/`undefined` if there is none.
+   */
   getItem: (key: string) => MaybePromise<TStorageValue | undefined | null>;
+  /**
+   * Stores `value` under `key`.
+   */
   setItem: (key: string, value: TStorageValue) => MaybePromise<unknown>;
+  /**
+   * Removes the value stored under `key`.
+   */
   removeItem: (key: string) => MaybePromise<void>;
+  /**
+   * Returns all stored key-value pairs. Required for removing expired entries in bulk.
+   */
   entries?: () => MaybePromise<Array<[key: string, value: TStorageValue]>>;
 }
+/**
+ * Options for {@link experimental_createQueryPersister}.
+ */
 export interface StoragePersisterOptions<TStorageValue = string> {
-  /** The storage client used for setting and retrieving items from cache.
+  /**
+   * The storage client used for setting and retrieving items from cache.
    * For SSR pass in `undefined`.
    */
   storage: AsyncStorage<TStorageValue> | undefined | null;
@@ -50,7 +88,6 @@ export interface StoragePersisterOptions<TStorageValue = 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.
-   *
    * @defaultValue true
    */
   refetchOnRestore?: boolean | 'always';
@@ -67,13 +104,17 @@ export declare const PERSISTER_KEY_PREFIX = "tanstack-query";
  *
  * ```
  * useQuery({
-     queryKey: ['myKey'],
-     queryFn: fetcher,
-     persister: createPersister({
-       storage: localStorage,
-     }),
-   })
-   ```
+ *   queryKey: ['myKey'],
+ *   queryFn: fetcher,
+ *   persister: createPersister({
+ *     storage: localStorage,
+ *   }),
+ * })
+ * ```
+ * @param options - The storage to persist to, and the options for serializing, expiring, and
+ * filtering persisted queries.
+ * @returns The `persisterFn` to pass as a query's `persister`, plus functions to persist, retrieve,
+ * restore, remove, and garbage collect persisted queries manually.
  */
 export 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>;

package/build/legacy/createPersister.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"createPersister.d.cts","names":[],"sources":["../../src/createPersister.ts"],"mappings":";;iBAeiB;EACf;EACA;EACA,UAAU;EACV,OAAO;;YAGG,aAAa,KAAK,IAAI,QAAQ;iBAEzB,aAAa;EAC5B,UAAU,gBAAgB,aAAa;EACvC,UAAU,aAAa,OAAO,kBAAkB;EAChD,aAAa,gBAAgB;EAC7B,gBAAgB,aAAa,OAAO,aAAa,OAAO;;iBAGzC,wBAAwB;;;;EAIvC,SAAS,aAAa;;;;;EAKtB,aAAa,gBAAgB,mBAAmB,aAAa;;;;;EAK7D,eAAe,cAAc,kBAAkB,aAAa;;;;;EAK5D;;;;;;;EAOA;;;;;;EAMA;;;;;;;;EAQA;;;;EAIA,UAAU;;qBAGC;;;;;;;;;;;;;;;;wBAiBG,kCAAkC,0BAChD,SACA,QACA,QACA,WAGA,aAGA,QACA,kBACA,WACC,wBAAwB;EA+FE,cAAA,GAAG,kBAAkB,UAAQ,UAC5C,SAAS,qBAAqB,eAAe,IAAI,QAAQ,IAAE,KAChE,qBAAqB,YAAU,OAC7B,UAAK,QAAA;EAlBqB,eAAA,OAAA,UAAK;EAlB5B,oBAAA,UAAA,UAAQ,aACL,gBAAW;EA9CG,gBAAA,GAAC,mBACX,yBACQ,gBAAgB,4BAAuB,QAAA;;EAmJnD,iBAAA,aAAA,aAAW,UACf,KAAK,wCACb;EA+CQ,gBAAA,UAAA,KAAK,wCACb"}
+{"version":3,"file":"createPersister.d.cts","names":[],"sources":["../../src/createPersister.ts"],"mappings":";;;;;iBAkBiB;;;;EAIf;;;;EAIA;;;;EAIA,UAAU;;;;EAIV,OAAO;;;;;YAMG,aAAa,KAAK,IAAI,QAAQ;;;;;iBAMzB,aAAa;;;;EAI5B,UAAU,gBAAgB,aAAa;;;;EAIvC,UAAU,aAAa,OAAO,kBAAkB;;;;EAIhD,aAAa,gBAAgB;;;;EAI7B,gBAAgB,aAAa,OAAO,aAAa,OAAO;;;;;iBAMzC,wBAAwB;;;;;EAKvC,SAAS,aAAa;;;;;EAKtB,aAAa,gBAAgB,mBAAmB,aAAa;;;;;EAK7D,eAAe,cAAc,kBAAkB,aAAa;;;;;EAK5D;;;;;;;EAOA;;;;;;EAMA;;;;;;;EAOA;;;;EAIA,UAAU;;qBAGC;;;;;;;;;;;;;;;;;;;;wBAqBG,kCAAkC,0BAChD,SACA,QACA,QACA,WAGA,aAGA,QACA,kBACA,WACC,wBAAwB;EAgIE,cAAA,GAAG,kBAAkB,UAAQ,UAC5C,SAAS,qBAAqB,eAAe,IAAI,QAAQ,IAAE,KAChE,qBAAqB,YAAU,OAC7B,UAAK,QAAA;EA1BqB,eAAA,OAAA,UAAK;EAvB5B,oBAAA,UAAA,UAAQ,aACL,gBAAW;EApDG,gBAAA,GAAC,mBACX,yBACQ,gBAAgB,4BAAuB,QAAA;;EAmLnD,iBAAA,aAAA,aAAW,UACf,KAAK,wCACb;EAsDQ,gBAAA,UAAA,KAAK,wCACb"}

package/build/legacy/createPersister.d.ts

@@ -1,20 +1,58 @@
 import { Query, QueryClient, QueryFilters, QueryFunctionContext, QueryKey, QueryState } from "@tanstack/query-core";
 //#region src/createPersister.d.ts
+/**
+ * A single query as stored by {@link experimental_createQueryPersister}.
+ */
 export interface PersistedQuery {
+  /**
+   * The `buster` the query was saved with. Entries with a different `buster` are discarded.
+   */
   buster: string;
+  /**
+   * The hash of the query.
+   */
   queryHash: string;
+  /**
+   * The key of the query.
+   */
   queryKey: QueryKey;
+  /**
+   * The state of the query, including its data and when it was last updated.
+   */
   state: QueryState;
 }
+/**
+ * A value, or a promise that resolves to it.
+ */
 export type MaybePromise<T> = T | Promise<T>;
+/**
+ * A key-value storage, such as `localStorage` or `AsyncStorage`, whose methods may be synchronous
+ * or return promises.
+ */
 export interface AsyncStorage<TStorageValue = string> {
+  /**
+   * Reads the value stored under `key`, or `null`/`undefined` if there is none.
+   */
   getItem: (key: string) => MaybePromise<TStorageValue | undefined | null>;
+  /**
+   * Stores `value` under `key`.
+   */
   setItem: (key: string, value: TStorageValue) => MaybePromise<unknown>;
+  /**
+   * Removes the value stored under `key`.
+   */
   removeItem: (key: string) => MaybePromise<void>;
+  /**
+   * Returns all stored key-value pairs. Required for removing expired entries in bulk.
+   */
   entries?: () => MaybePromise<Array<[key: string, value: TStorageValue]>>;
 }
+/**
+ * Options for {@link experimental_createQueryPersister}.
+ */
 export interface StoragePersisterOptions<TStorageValue = string> {
-  /** The storage client used for setting and retrieving items from cache.
+  /**
+   * The storage client used for setting and retrieving items from cache.
    * For SSR pass in `undefined`.
    */
   storage: AsyncStorage<TStorageValue> | undefined | null;
@@ -50,7 +88,6 @@ export interface StoragePersisterOptions<TStorageValue = 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.
-   *
    * @defaultValue true
    */
   refetchOnRestore?: boolean | 'always';
@@ -67,13 +104,17 @@ export declare const PERSISTER_KEY_PREFIX = "tanstack-query";
  *
  * ```
  * useQuery({
-     queryKey: ['myKey'],
-     queryFn: fetcher,
-     persister: createPersister({
-       storage: localStorage,
-     }),
-   })
-   ```
+ *   queryKey: ['myKey'],
+ *   queryFn: fetcher,
+ *   persister: createPersister({
+ *     storage: localStorage,
+ *   }),
+ * })
+ * ```
+ * @param options - The storage to persist to, and the options for serializing, expiring, and
+ * filtering persisted queries.
+ * @returns The `persisterFn` to pass as a query's `persister`, plus functions to persist, retrieve,
+ * restore, remove, and garbage collect persisted queries manually.
  */
 export 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>;

package/build/legacy/createPersister.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"createPersister.d.ts","names":[],"sources":["../../src/createPersister.ts"],"mappings":";;iBAeiB;EACf;EACA;EACA,UAAU;EACV,OAAO;;YAGG,aAAa,KAAK,IAAI,QAAQ;iBAEzB,aAAa;EAC5B,UAAU,gBAAgB,aAAa;EACvC,UAAU,aAAa,OAAO,kBAAkB;EAChD,aAAa,gBAAgB;EAC7B,gBAAgB,aAAa,OAAO,aAAa,OAAO;;iBAGzC,wBAAwB;;;;EAIvC,SAAS,aAAa;;;;;EAKtB,aAAa,gBAAgB,mBAAmB,aAAa;;;;;EAK7D,eAAe,cAAc,kBAAkB,aAAa;;;;;EAK5D;;;;;;;EAOA;;;;;;EAMA;;;;;;;;EAQA;;;;EAIA,UAAU;;qBAGC;;;;;;;;;;;;;;;;wBAiBG,kCAAkC,0BAChD,SACA,QACA,QACA,WAGA,aAGA,QACA,kBACA,WACC,wBAAwB;EA+FE,cAAA,GAAG,kBAAkB,UAAQ,UAC5C,SAAS,qBAAqB,eAAe,IAAI,QAAQ,IAAE,KAChE,qBAAqB,YAAU,OAC7B,UAAK,QAAA;EAlBqB,eAAA,OAAA,UAAK;EAlB5B,oBAAA,UAAA,UAAQ,aACL,gBAAW;EA9CG,gBAAA,GAAC,mBACX,yBACQ,gBAAgB,4BAAuB,QAAA;;EAmJnD,iBAAA,aAAA,aAAW,UACf,KAAK,wCACb;EA+CQ,gBAAA,UAAA,KAAK,wCACb"}
+{"version":3,"file":"createPersister.d.ts","names":[],"sources":["../../src/createPersister.ts"],"mappings":";;;;;iBAkBiB;;;;EAIf;;;;EAIA;;;;EAIA,UAAU;;;;EAIV,OAAO;;;;;YAMG,aAAa,KAAK,IAAI,QAAQ;;;;;iBAMzB,aAAa;;;;EAI5B,UAAU,gBAAgB,aAAa;;;;EAIvC,UAAU,aAAa,OAAO,kBAAkB;;;;EAIhD,aAAa,gBAAgB;;;;EAI7B,gBAAgB,aAAa,OAAO,aAAa,OAAO;;;;;iBAMzC,wBAAwB;;;;;EAKvC,SAAS,aAAa;;;;;EAKtB,aAAa,gBAAgB,mBAAmB,aAAa;;;;;EAK7D,eAAe,cAAc,kBAAkB,aAAa;;;;;EAK5D;;;;;;;EAOA;;;;;;EAMA;;;;;;;EAOA;;;;EAIA,UAAU;;qBAGC;;;;;;;;;;;;;;;;;;;;wBAqBG,kCAAkC,0BAChD,SACA,QACA,QACA,WAGA,aAGA,QACA,kBACA,WACC,wBAAwB;EAgIE,cAAA,GAAG,kBAAkB,UAAQ,UAC5C,SAAS,qBAAqB,eAAe,IAAI,QAAQ,IAAE,KAChE,qBAAqB,YAAU,OAC7B,UAAK,QAAA;EA1BqB,eAAA,OAAA,UAAK;EAvB5B,oBAAA,UAAA,UAAQ,aACL,gBAAW;EApDG,gBAAA,GAAC,mBACX,yBACQ,gBAAgB,4BAAuB,QAAA;;EAmLnD,iBAAA,aAAA,aAAW,UACf,KAAK,wCACb;EAsDQ,gBAAA,UAAA,KAAK,wCACb"}

package/build/legacy/createPersister.js

@@ -8,15 +8,25 @@ const PERSISTER_KEY_PREFIX = "tanstack-query";
 *
 * ```
 * useQuery({
-queryKey: ['myKey'],
-queryFn: fetcher,
-persister: createPersister({
-storage: localStorage,
-}),
-})
-```
+*   queryKey: ['myKey'],
+*   queryFn: fetcher,
+*   persister: createPersister({
+*     storage: localStorage,
+*   }),
+* })
+* ```
+* @param options - The storage to persist to, and the options for serializing, expiring, and
+* filtering persisted queries.
+* @returns The `persisterFn` to pass as a query's `persister`, plus functions to persist, retrieve,
+* restore, remove, and garbage collect persisted queries manually.
 */
 function experimental_createQueryPersister({ storage, buster = "", maxAge = 864e5, serialize = JSON.stringify, deserialize = JSON.parse, prefix = PERSISTER_KEY_PREFIX, refetchOnRestore = true, filters }) {
+	/**
+	* Checks whether a persisted query should be discarded.
+	* @param persistedQuery - The persisted query to check.
+	* @returns `true` if it has no `dataUpdatedAt`, is older than `maxAge`, or has a different
+	* `buster`.
+	*/
 	function isExpiredOrBusted(persistedQuery) {
 		if (persistedQuery.state.dataUpdatedAt) {
 			const expired = Date.now() - persistedQuery.state.dataUpdatedAt > maxAge;
@@ -26,6 +36,14 @@ function experimental_createQueryPersister({ storage, buster = "", maxAge = 864e
 		}
 		return true;
 	}
+	/**
+	* Reads the persisted data of a query from storage. Expired, busted, or unreadable entries are
+	* removed instead.
+	* @param queryHash - The hash of the query to read.
+	* @param afterRestoreMacroTask - Scheduled with the persisted query after it is restored.
+	* @returns A promise that resolves with the persisted data, or `undefined` if nothing was
+	* restored.
+	*/
 	async function retrieveQuery(queryHash, afterRestoreMacroTask) {
 		if (storage != null) {
 			const storageKey = `${prefix}-${queryHash}`;
@@ -54,6 +72,12 @@ function experimental_createQueryPersister({ storage, buster = "", maxAge = 864e
 			}
 		}
 	}
+	/**
+	* Persists the query with the given key, if it exists in the client's cache.
+	* @param queryKey - The key of the query to persist.
+	* @param queryClient - The client whose cache holds the query.
+	* @returns A promise that resolves once the query is persisted.
+	*/
 	async function persistQueryByKey(queryKey, queryClient) {
 		if (storage != null) {
 			const query = queryClient.getQueryCache().find({ queryKey });
@@ -61,6 +85,11 @@ function experimental_createQueryPersister({ storage, buster = "", maxAge = 864e
 			else if (process.env.NODE_ENV === "development") console.warn("Could not find query to be persisted. QueryKey:", JSON.stringify(queryKey));
 		}
 	}
+	/**
+	* Writes a query's state, key, hash, and `buster` to storage.
+	* @param query - The query to persist.
+	* @returns A promise that resolves once the entry is serialized and written.
+	*/
 	async function persistQuery(query) {
 		if (storage != null) {
 			const storageKey = `${prefix}-${query.queryHash}`;
@@ -72,6 +101,14 @@ function experimental_createQueryPersister({ storage, buster = "", maxAge = 864e
 			}));
 		}
 	}
+	/**
+	* The `persister` of a query: restores its data from storage if the query has none yet, otherwise
+	* runs `queryFn` and persists the result.
+	* @param queryFn - The query's own query function.
+	* @param ctx - The context passed to `queryFn`.
+	* @param query - The query being fetched.
+	* @returns A promise that resolves with the restored or fetched data.
+	*/
 	async function persisterFn(queryFn, ctx, query) {
 		const matchesFilter = filters ? matchQuery(filters, query) : true;
 		if (matchesFilter && query.state.data === void 0 && storage != null) {
@@ -90,6 +127,11 @@ function experimental_createQueryPersister({ storage, buster = "", maxAge = 864e
 		});
 		return Promise.resolve(queryFnResult);
 	}
+	/**
+	* Removes expired, busted, or unreadable entries from storage. Requires the storage to implement
+	* `entries`.
+	* @returns A promise that resolves once every entry is checked.
+	*/
 	async function persisterGc() {
 		if (storage === null || storage === void 0 ? void 0 : storage.entries) {
 			const storageKeyPrefix = `${prefix}-`;
@@ -106,6 +148,14 @@ function experimental_createQueryPersister({ storage, buster = "", maxAge = 864e
 			}
 		} 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.");
 	}
+	/**
+	* Restores every persisted query matching `filters` into the client's cache with
+	* `queryClient.setQueryData`. Requires the storage to implement `entries`.
+	* @param queryClient - The client to restore the queries into.
+	* @param filters - The `queryKey` and `exact` filters to match. Without them, every query is
+	* restored.
+	* @returns A promise that resolves once every entry is checked.
+	*/
 	async function restoreQueries(queryClient, filters = {}) {
 		const { exact, queryKey } = filters;
 		if (storage === null || storage === void 0 ? void 0 : storage.entries) {
@@ -132,6 +182,13 @@ function experimental_createQueryPersister({ storage, buster = "", maxAge = 864e
 			}
 		} 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.");
 	}
+	/**
+	* Removes every persisted query matching `filters` from storage. Requires the storage to implement
+	* `entries`.
+	* @param filters - The `queryKey` and `exact` filters to match. Without them, every query is
+	* removed.
+	* @returns A promise that resolves once every entry is checked.
+	*/
 	async function removeQueries(filters = {}) {
 		const { exact, queryKey } = filters;
 		if (storage === null || storage === void 0 ? void 0 : storage.entries) {

package/build/legacy/createPersister.js.map

@@ -1 +1 @@
-{"version":3,"file":"createPersister.js","names":[],"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   *\n   * @defaultValue 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 != null) {\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":";;AA8EA,MAAa,uBAAuB;;;;;;;;;;;;;;;;AAiBpC,SAAgB,kCAA0D,EACxE,SACA,SAAS,IACT,SAAS,OACT,YAAY,KAAK,WAGjB,cAAc,KAAK,OAGnB,SAAS,sBACT,mBAAmB,MACnB,WACyC;CACzC,SAAS,kBAAkB,gBAAgC;EACzD,IAAI,eAAe,MAAM,eAAe;GAEtC,MAAM,UADW,KAAK,IAAI,IAAI,eAAe,MAAM,gBACxB;GAC3B,MAAM,SAAS,eAAe,WAAW;GAEzC,IAAI,WAAW,QACb,OAAO;GAGT,OAAO;EACT;EAEA,OAAO;CACT;CAEA,eAAe,cACb,WACA,uBACA;EACA,IAAI,WAAW,MAAM;GACnB,MAAM,aAAa,GAAG,OAAO,GAAG;GAChC,IAAI;IACF,MAAM,aAAa,MAAM,QAAQ,QAAQ,UAAU;IACnD,IAAI,cAAc,MAAM;KACtB,IAAI;KACJ,IAAI;MACF,iBAAiB,MAAM,YAAY,UAAU;KAC/C,QAAQ;MACN,MAAM,QAAQ,WAAW,UAAU;MACnC;KACF;KAEA,IAAI,kBAAkB,cAAc,GAClC,MAAM,QAAQ,WAAW,UAAU;UAC9B;MACL,IAAI,uBAEF,cAAc,eACZ,sBAAsB,cAAc,CACtC;MAGF,OAAO,eAAe,MAAM;KAC9B;IACF;GACF,SAAS,KAAK;IACZ,IAAI,QAAQ,IAAI,aAAa,eAAe;KAC1C,QAAQ,MAAM,GAAG;KACjB,QAAQ,KACN,iFACF;IACF;IACA,MAAM,QAAQ,WAAW,UAAU;GACrC;EACF;CAGF;CAEA,eAAe,kBACb,UACA,aACA;EACA,IAAI,WAAW,MAAM;GACnB,MAAM,QAAQ,YAAY,cAAc,CAAC,CAAC,KAAK,EAAE,SAAS,CAAC;GAC3D,IAAI,OACF,MAAM,aAAa,KAAK;QAExB,IAAI,QAAQ,IAAI,aAAa,eAC3B,QAAQ,KACN,mDACA,KAAK,UAAU,QAAQ,CACzB;EAGN;CACF;CAEA,eAAe,aAAa,OAAc;EACxC,IAAI,WAAW,MAAM;GACnB,MAAM,aAAa,GAAG,OAAO,GAAG,MAAM;GACtC,QAAQ,QACN,YACA,MAAM,UAAU;IACd,OAAO,MAAM;IACb,UAAU,MAAM;IAChB,WAAW,MAAM;IACT;GACV,CAAC,CACH;EACF;CACF;CAEA,eAAe,YACb,SACA,KACA,OACA;EACA,MAAM,gBAAgB,UAAU,WAAW,SAAS,KAAK,IAAI;EAG7D,IAAI,iBAAiB,MAAM,MAAM,SAAS,KAAA,KAAa,WAAW,MAAM;GACtE,MAAM,eAAe,MAAM,cACzB,MAAM,YACL,mBAAmC;IAElC,MAAM,SAAS;KACb,eAAe,eAAe,MAAM;KACpC,gBAAgB,eAAe,MAAM;IACvC,CAAC;IAED,IACE,qBAAqB,YACpB,qBAAqB,QAAQ,MAAM,QAAQ,GAE5C,MAAM,MAAM;GAEhB,CACF;GAEA,IAAI,iBAAiB,KAAA,GACnB,OAAO,QAAQ,QAAQ,YAAiB;EAE5C;EAGA,MAAM,gBAAgB,MAAM,QAAQ,GAAG;EAEvC,IAAI,iBAAiB,WAAW,MAE9B,cAAc,eAAe;GAC3B,aAAa,KAAK;EACpB,CAAC;EAGH,OAAO,QAAQ,QAAQ,aAAa;CACtC;CAEA,eAAe,cAAc;EAC3B,IAAA,YAAA,QAAA,YAAA,KAAA,IAAA,KAAA,IAAI,QAAS,SAAS;GACpB,MAAM,mBAAmB,GAAG,OAAO;GACnC,MAAM,UAAU,MAAM,QAAQ,QAAQ;GACtC,KAAK,MAAM,CAAC,KAAK,UAAU,SACzB,IAAI,IAAI,WAAW,gBAAgB,GAAG;IACpC,IAAI;IACJ,IAAI;KACF,iBAAiB,MAAM,YAAY,KAAK;IAC1C,QAAQ;KACN,MAAM,QAAQ,WAAW,GAAG;KAC5B;IACF;IACA,IAAI,kBAAkB,cAAc,GAClC,MAAM,QAAQ,WAAW,GAAG;GAEhC;EAEJ,OAAO,IAAI,QAAQ,IAAI,aAAa,eAClC,MAAM,IAAI,MACR,yIACF;CAEJ;CAEA,eAAe,eACb,aACA,UAAoD,CAAC,GACtC;EACf,MAAM,EAAE,OAAO,aAAa;EAE5B,IAAA,YAAA,QAAA,YAAA,KAAA,IAAA,KAAA,IAAI,QAAS,SAAS;GACpB,MAAM,mBAAmB,GAAG,OAAO;GACnC,MAAM,UAAU,MAAM,QAAQ,QAAQ;GACtC,KAAK,MAAM,CAAC,KAAK,UAAU,SACzB,IAAI,IAAI,WAAW,gBAAgB,GAAG;IACpC,IAAI;IACJ,IAAI;KACF,iBAAiB,MAAM,YAAY,KAAK;IAC1C,QAAQ;KACN,MAAM,QAAQ,WAAW,GAAG;KAC5B;IACF;IACA,IAAI,kBAAkB,cAAc,GAAG;KACrC,MAAM,QAAQ,WAAW,GAAG;KAC5B;IACF;IAEA,IAAI,UAAU;KACZ,IAAI,OACE;UAAA,eAAe,cAAc,QAAQ,QAAQ,GAC/C;KAAA,OAEG,IAAI,CAAC,gBAAgB,eAAe,UAAU,QAAQ,GAC3D;IAEJ;IAEA,YAAY,aACV,eAAe,UACf,eAAe,MAAM,MACrB,EACE,WAAW,eAAe,MAAM,cAClC,CACF;GACF;EAEJ,OAAO,IAAI,QAAQ,IAAI,aAAa,eAClC,MAAM,IAAI,MACR,wJACF;CAEJ;CAEA,eAAe,cACb,UAAoD,CAAC,GACtC;EACf,MAAM,EAAE,OAAO,aAAa;EAE5B,IAAA,YAAA,QAAA,YAAA,KAAA,IAAA,KAAA,IAAI,QAAS,SAAS;GACpB,MAAM,UAAU,MAAM,QAAQ,QAAQ;GACtC,MAAM,mBAAmB,GAAG,OAAO;GACnC,KAAK,MAAM,CAAC,KAAK,UAAU,SACzB,IAAI,IAAI,WAAW,gBAAgB,GAAG;IACpC,IAAI,CAAC,UAAU;KACb,MAAM,QAAQ,WAAW,GAAG;KAC5B;IACF;IAEA,IAAI;IACJ,IAAI;KACF,iBAAiB,MAAM,YAAY,KAAK;IAC1C,QAAQ;KACN,MAAM,QAAQ,WAAW,GAAG;KAC5B;IACF;IAEA,IAAI,OACE;SAAA,eAAe,cAAc,QAAQ,QAAQ,GAC/C;IAAA,OAEG,IAAI,CAAC,gBAAgB,eAAe,UAAU,QAAQ,GAC3D;IAGF,MAAM,QAAQ,WAAW,GAAG;GAC9B;EAEJ,OAAO,IAAI,QAAQ,IAAI,aAAa,eAClC,MAAM,IAAI,MACR,gJACF;CAEJ;CAEA,OAAO;EACL;EACA;EACA;EACA;EACA;EACA;EACA;CACF;AACF"}
+{"version":3,"file":"createPersister.js","names":[],"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\n/**\n * A single query as stored by {@link experimental_createQueryPersister}.\n */\nexport interface PersistedQuery {\n  /**\n   * The `buster` the query was saved with. Entries with a different `buster` are discarded.\n   */\n  buster: string\n  /**\n   * The hash of the query.\n   */\n  queryHash: string\n  /**\n   * The key of the query.\n   */\n  queryKey: QueryKey\n  /**\n   * The state of the query, including its data and when it was last updated.\n   */\n  state: QueryState\n}\n\n/**\n * A value, or a promise that resolves to it.\n */\nexport type MaybePromise<T> = T | Promise<T>\n\n/**\n * A key-value storage, such as `localStorage` or `AsyncStorage`, whose methods may be synchronous\n * or return promises.\n */\nexport interface AsyncStorage<TStorageValue = string> {\n  /**\n   * Reads the value stored under `key`, or `null`/`undefined` if there is none.\n   */\n  getItem: (key: string) => MaybePromise<TStorageValue | undefined | null>\n  /**\n   * Stores `value` under `key`.\n   */\n  setItem: (key: string, value: TStorageValue) => MaybePromise<unknown>\n  /**\n   * Removes the value stored under `key`.\n   */\n  removeItem: (key: string) => MaybePromise<void>\n  /**\n   * Returns all stored key-value pairs. Required for removing expired entries in bulk.\n   */\n  entries?: () => MaybePromise<Array<[key: string, value: TStorageValue]>>\n}\n\n/**\n * Options for {@link experimental_createQueryPersister}.\n */\nexport interface StoragePersisterOptions<TStorageValue = string> {\n  /**\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   * @defaultValue 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 * @param options - The storage to persist to, and the options for serializing, expiring, and\n * filtering persisted queries.\n * @returns The `persisterFn` to pass as a query's `persister`, plus functions to persist, retrieve,\n * restore, remove, and garbage collect persisted queries manually.\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  /**\n   * Checks whether a persisted query should be discarded.\n   * @param persistedQuery - The persisted query to check.\n   * @returns `true` if it has no `dataUpdatedAt`, is older than `maxAge`, or has a different\n   * `buster`.\n   */\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  /**\n   * Reads the persisted data of a query from storage. Expired, busted, or unreadable entries are\n   * removed instead.\n   * @param queryHash - The hash of the query to read.\n   * @param afterRestoreMacroTask - Scheduled with the persisted query after it is restored.\n   * @returns A promise that resolves with the persisted data, or `undefined` if nothing was\n   * restored.\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 != null) {\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  /**\n   * Persists the query with the given key, if it exists in the client's cache.\n   * @param queryKey - The key of the query to persist.\n   * @param queryClient - The client whose cache holds the query.\n   * @returns A promise that resolves once the query is persisted.\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  /**\n   * Writes a query's state, key, hash, and `buster` to storage.\n   * @param query - The query to persist.\n   * @returns A promise that resolves once the entry is serialized and written.\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  /**\n   * The `persister` of a query: restores its data from storage if the query has none yet, otherwise\n   * runs `queryFn` and persists the result.\n   * @param queryFn - The query's own query function.\n   * @param ctx - The context passed to `queryFn`.\n   * @param query - The query being fetched.\n   * @returns A promise that resolves with the restored or fetched data.\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  /**\n   * Removes expired, busted, or unreadable entries from storage. Requires the storage to implement\n   * `entries`.\n   * @returns A promise that resolves once every entry is checked.\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  /**\n   * Restores every persisted query matching `filters` into the client's cache with\n   * `queryClient.setQueryData`. Requires the storage to implement `entries`.\n   * @param queryClient - The client to restore the queries into.\n   * @param filters - The `queryKey` and `exact` filters to match. Without them, every query is\n   * restored.\n   * @returns A promise that resolves once every entry is checked.\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  /**\n   * Removes every persisted query matching `filters` from storage. Requires the storage to implement\n   * `entries`.\n   * @param filters - The `queryKey` and `exact` filters to match. Without them, every query is\n   * removed.\n   * @returns A promise that resolves once every entry is checked.\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":";;AAmHA,MAAa,uBAAuB;;;;;;;;;;;;;;;;;;;;AAqBpC,SAAgB,kCAA0D,EACxE,SACA,SAAS,IACT,SAAS,OACT,YAAY,KAAK,WAGjB,cAAc,KAAK,OAGnB,SAAS,sBACT,mBAAmB,MACnB,WACyC;;;;;;;CAOzC,SAAS,kBAAkB,gBAAgC;EACzD,IAAI,eAAe,MAAM,eAAe;GAEtC,MAAM,UADW,KAAK,IAAI,IAAI,eAAe,MAAM,gBACxB;GAC3B,MAAM,SAAS,eAAe,WAAW;GAEzC,IAAI,WAAW,QACb,OAAO;GAGT,OAAO;EACT;EAEA,OAAO;CACT;;;;;;;;;CAUA,eAAe,cACb,WACA,uBACA;EACA,IAAI,WAAW,MAAM;GACnB,MAAM,aAAa,GAAG,OAAO,GAAG;GAChC,IAAI;IACF,MAAM,aAAa,MAAM,QAAQ,QAAQ,UAAU;IACnD,IAAI,cAAc,MAAM;KACtB,IAAI;KACJ,IAAI;MACF,iBAAiB,MAAM,YAAY,UAAU;KAC/C,QAAQ;MACN,MAAM,QAAQ,WAAW,UAAU;MACnC;KACF;KAEA,IAAI,kBAAkB,cAAc,GAClC,MAAM,QAAQ,WAAW,UAAU;UAC9B;MACL,IAAI,uBAEF,cAAc,eACZ,sBAAsB,cAAc,CACtC;MAGF,OAAO,eAAe,MAAM;KAC9B;IACF;GACF,SAAS,KAAK;IACZ,IAAI,QAAQ,IAAI,aAAa,eAAe;KAC1C,QAAQ,MAAM,GAAG;KACjB,QAAQ,KACN,iFACF;IACF;IACA,MAAM,QAAQ,WAAW,UAAU;GACrC;EACF;CAGF;;;;;;;CAQA,eAAe,kBACb,UACA,aACA;EACA,IAAI,WAAW,MAAM;GACnB,MAAM,QAAQ,YAAY,cAAc,CAAC,CAAC,KAAK,EAAE,SAAS,CAAC;GAC3D,IAAI,OACF,MAAM,aAAa,KAAK;QAExB,IAAI,QAAQ,IAAI,aAAa,eAC3B,QAAQ,KACN,mDACA,KAAK,UAAU,QAAQ,CACzB;EAGN;CACF;;;;;;CAOA,eAAe,aAAa,OAAc;EACxC,IAAI,WAAW,MAAM;GACnB,MAAM,aAAa,GAAG,OAAO,GAAG,MAAM;GACtC,QAAQ,QACN,YACA,MAAM,UAAU;IACd,OAAO,MAAM;IACb,UAAU,MAAM;IAChB,WAAW,MAAM;IACT;GACV,CAAC,CACH;EACF;CACF;;;;;;;;;CAUA,eAAe,YACb,SACA,KACA,OACA;EACA,MAAM,gBAAgB,UAAU,WAAW,SAAS,KAAK,IAAI;EAG7D,IAAI,iBAAiB,MAAM,MAAM,SAAS,KAAA,KAAa,WAAW,MAAM;GACtE,MAAM,eAAe,MAAM,cACzB,MAAM,YACL,mBAAmC;IAElC,MAAM,SAAS;KACb,eAAe,eAAe,MAAM;KACpC,gBAAgB,eAAe,MAAM;IACvC,CAAC;IAED,IACE,qBAAqB,YACpB,qBAAqB,QAAQ,MAAM,QAAQ,GAE5C,MAAM,MAAM;GAEhB,CACF;GAEA,IAAI,iBAAiB,KAAA,GACnB,OAAO,QAAQ,QAAQ,YAAiB;EAE5C;EAGA,MAAM,gBAAgB,MAAM,QAAQ,GAAG;EAEvC,IAAI,iBAAiB,WAAW,MAE9B,cAAc,eAAe;GAC3B,aAAa,KAAK;EACpB,CAAC;EAGH,OAAO,QAAQ,QAAQ,aAAa;CACtC;;;;;;CAOA,eAAe,cAAc;EAC3B,IAAA,YAAA,QAAA,YAAA,KAAA,IAAA,KAAA,IAAI,QAAS,SAAS;GACpB,MAAM,mBAAmB,GAAG,OAAO;GACnC,MAAM,UAAU,MAAM,QAAQ,QAAQ;GACtC,KAAK,MAAM,CAAC,KAAK,UAAU,SACzB,IAAI,IAAI,WAAW,gBAAgB,GAAG;IACpC,IAAI;IACJ,IAAI;KACF,iBAAiB,MAAM,YAAY,KAAK;IAC1C,QAAQ;KACN,MAAM,QAAQ,WAAW,GAAG;KAC5B;IACF;IACA,IAAI,kBAAkB,cAAc,GAClC,MAAM,QAAQ,WAAW,GAAG;GAEhC;EAEJ,OAAO,IAAI,QAAQ,IAAI,aAAa,eAClC,MAAM,IAAI,MACR,yIACF;CAEJ;;;;;;;;;CAUA,eAAe,eACb,aACA,UAAoD,CAAC,GACtC;EACf,MAAM,EAAE,OAAO,aAAa;EAE5B,IAAA,YAAA,QAAA,YAAA,KAAA,IAAA,KAAA,IAAI,QAAS,SAAS;GACpB,MAAM,mBAAmB,GAAG,OAAO;GACnC,MAAM,UAAU,MAAM,QAAQ,QAAQ;GACtC,KAAK,MAAM,CAAC,KAAK,UAAU,SACzB,IAAI,IAAI,WAAW,gBAAgB,GAAG;IACpC,IAAI;IACJ,IAAI;KACF,iBAAiB,MAAM,YAAY,KAAK;IAC1C,QAAQ;KACN,MAAM,QAAQ,WAAW,GAAG;KAC5B;IACF;IACA,IAAI,kBAAkB,cAAc,GAAG;KACrC,MAAM,QAAQ,WAAW,GAAG;KAC5B;IACF;IAEA,IAAI,UAAU;KACZ,IAAI,OACE;UAAA,eAAe,cAAc,QAAQ,QAAQ,GAC/C;KAAA,OAEG,IAAI,CAAC,gBAAgB,eAAe,UAAU,QAAQ,GAC3D;IAEJ;IAEA,YAAY,aACV,eAAe,UACf,eAAe,MAAM,MACrB,EACE,WAAW,eAAe,MAAM,cAClC,CACF;GACF;EAEJ,OAAO,IAAI,QAAQ,IAAI,aAAa,eAClC,MAAM,IAAI,MACR,wJACF;CAEJ;;;;;;;;CASA,eAAe,cACb,UAAoD,CAAC,GACtC;EACf,MAAM,EAAE,OAAO,aAAa;EAE5B,IAAA,YAAA,QAAA,YAAA,KAAA,IAAA,KAAA,IAAI,QAAS,SAAS;GACpB,MAAM,UAAU,MAAM,QAAQ,QAAQ;GACtC,MAAM,mBAAmB,GAAG,OAAO;GACnC,KAAK,MAAM,CAAC,KAAK,UAAU,SACzB,IAAI,IAAI,WAAW,gBAAgB,GAAG;IACpC,IAAI,CAAC,UAAU;KACb,MAAM,QAAQ,WAAW,GAAG;KAC5B;IACF;IAEA,IAAI;IACJ,IAAI;KACF,iBAAiB,MAAM,YAAY,KAAK;IAC1C,QAAQ;KACN,MAAM,QAAQ,WAAW,GAAG;KAC5B;IACF;IAEA,IAAI,OACE;SAAA,eAAe,cAAc,QAAQ,QAAQ,GAC/C;IAAA,OAEG,IAAI,CAAC,gBAAgB,eAAe,UAAU,QAAQ,GAC3D;IAGF,MAAM,QAAQ,WAAW,GAAG;GAC9B;EAEJ,OAAO,IAAI,QAAQ,IAAI,aAAa,eAClC,MAAM,IAAI,MACR,gJACF;CAEJ;CAEA,OAAO;EACL;EACA;EACA;EACA;EACA;EACA;EACA;CACF;AACF"}