@tanstack/query-persist-client-core 5.105.0 → 5.105.1

package/build/modern/persist.js.map

@@ -1 +1 @@
-{"version":3,"file":"persist.js","names":[],"sources":["../../src/persist.ts"],"sourcesContent":["import { dehydrate, hydrate } from '@tanstack/query-core'\nimport type {\n  DehydrateOptions,\n  DehydratedState,\n  HydrateOptions,\n  NotifyEventType,\n  QueryClient,\n} from '@tanstack/query-core'\n\n/**\n * A value, or a promise-like that resolves to it.\n */\nexport type Promisable<T> = T | PromiseLike<T>\n\n/**\n * Saves, restores, and removes a {@link PersistedClient} in a storage.\n */\nexport interface Persister {\n  /**\n   * Saves the persisted client to the storage.\n   */\n  persistClient: (persistClient: PersistedClient) => Promisable<void>\n  /**\n   * Reads the persisted client from the storage, or `undefined` if nothing was saved.\n   */\n  restoreClient: () => Promisable<PersistedClient | undefined>\n  /**\n   * Removes the persisted client from the storage.\n   */\n  removeClient: () => Promisable<void>\n}\n\n/**\n * The dehydrated state of a `QueryClient` as it is persisted, with the time it was saved and its\n * `buster`.\n */\nexport interface PersistedClient {\n  /**\n   * When the client was saved, in milliseconds since the epoch. Compared with `maxAge` on restore.\n   */\n  timestamp: number\n  /**\n   * The `buster` the client was saved with. A persisted client with a different `buster` is\n   * discarded.\n   */\n  buster: string\n  /**\n   * The dehydrated cache of the `QueryClient`.\n   */\n  clientState: DehydratedState\n}\n\n/**\n * The options shared by restoring and saving a persisted `QueryClient`.\n */\nexport interface PersistQueryClientRootOptions {\n  /** The QueryClient to persist */\n  queryClient: QueryClient\n  /**\n   * The Persister interface for storing and restoring the cache\n   * to/from a persisted location\n   */\n  persister: Persister\n  /**\n   * A unique string that can be used to forcefully\n   * invalidate existing caches if they do not share the same buster string\n   */\n  buster?: string\n}\n\n/**\n * Options for restoring a persisted `QueryClient` with {@link persistQueryClientRestore}.\n */\nexport interface PersistedQueryClientRestoreOptions extends PersistQueryClientRootOptions {\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   */\n  maxAge?: number\n  /** The options passed to the hydrate function */\n  hydrateOptions?: HydrateOptions\n}\n\n/**\n * Options for saving a `QueryClient` with {@link persistQueryClientSave}.\n */\nexport interface PersistedQueryClientSaveOptions extends PersistQueryClientRootOptions {\n  /** The options passed to the dehydrate function */\n  dehydrateOptions?: DehydrateOptions\n}\n\n/**\n * Options for {@link persistQueryClient}, which both restores and saves a `QueryClient`.\n */\nexport interface PersistQueryClientOptions\n  extends\n    PersistedQueryClientRestoreOptions,\n    PersistedQueryClientSaveOptions,\n    PersistQueryClientRootOptions {}\n\nconst cacheEventTypes: Array<NotifyEventType> = ['added', 'removed', 'updated']\n\n/**\n * Checks if emitted event is about cache change and not about observers.\n * Useful for persist, where we only want to trigger save when cache is changed.\n * @param eventType - The type of the emitted event.\n * @returns `true` if the event is `'added'`, `'removed'`, or `'updated'`.\n */\nfunction isCacheEventType(eventType: NotifyEventType) {\n  return cacheEventTypes.includes(eventType)\n}\n\n/**\n * Restores persisted data to the QueryCache.\n *  - data obtained from persister.restoreClient.\n *  - data is hydrated using hydrateOptions.\n * If data is expired, busted, empty, or throws, it runs persister.removeClient.\n * @param options - The `queryClient` to restore into, the `persister`, and the `maxAge`, `buster`,\n * and `hydrateOptions` that decide whether and how the persisted data is restored.\n * @returns A promise that resolves once the data is restored or removed. If restoring throws, it\n * attempts to remove the persisted data and then rejects with the restore error, or with the removal\n * error if the removal fails too.\n */\nexport async function persistQueryClientRestore({\n  queryClient,\n  persister,\n  maxAge = 24 * 60 * 60 * 1000,\n  buster = '',\n  hydrateOptions,\n}: PersistedQueryClientRestoreOptions) {\n  try {\n    const persistedClient = await persister.restoreClient()\n\n    if (persistedClient) {\n      if (persistedClient.timestamp) {\n        const expired = Date.now() - persistedClient.timestamp > maxAge\n        const busted = persistedClient.buster !== buster\n        if (expired || busted) {\n          return persister.removeClient()\n        } else {\n          hydrate(queryClient, persistedClient.clientState, hydrateOptions)\n        }\n      } else {\n        return persister.removeClient()\n      }\n    }\n  } catch (err) {\n    if (process.env.NODE_ENV !== 'production') {\n      console.error(err)\n      console.warn(\n        'Encountered an error attempting to restore client cache from persisted location. As a precaution, the persisted cache will be discarded.',\n      )\n    }\n\n    await persister.removeClient()\n\n    throw err\n  }\n}\n\n/**\n * Persists data from the QueryCache.\n *  - data dehydrated using dehydrateOptions.\n *  - data is persisted using persister.persistClient.\n * @param options - The `queryClient` to persist, the `persister`, the `buster`, and the\n * `dehydrateOptions`.\n */\nexport async function persistQueryClientSave({\n  queryClient,\n  persister,\n  buster = '',\n  dehydrateOptions,\n}: PersistedQueryClientSaveOptions) {\n  const persistClient: PersistedClient = {\n    buster,\n    timestamp: Date.now(),\n    clientState: dehydrate(queryClient, dehydrateOptions),\n  }\n\n  await persister.persistClient(persistClient)\n}\n\n/**\n * Subscribe to QueryCache and MutationCache updates (for persisting).\n * @param props - The `queryClient` to monitor, the `persister`, the `buster`, and the\n * `dehydrateOptions` used for each save.\n * @returns an unsubscribe function (to discontinue monitoring)\n */\nexport function persistQueryClientSubscribe(\n  props: PersistedQueryClientSaveOptions,\n) {\n  const unsubscribeQueryCache = props.queryClient\n    .getQueryCache()\n    .subscribe((event) => {\n      if (isCacheEventType(event.type)) {\n        persistQueryClientSave(props)\n      }\n    })\n\n  const unsubscribeMutationCache = props.queryClient\n    .getMutationCache()\n    .subscribe((event) => {\n      if (isCacheEventType(event.type)) {\n        persistQueryClientSave(props)\n      }\n    })\n\n  return () => {\n    unsubscribeQueryCache()\n    unsubscribeMutationCache()\n  }\n}\n\n/**\n * Restores persisted data to QueryCache and persists further changes.\n * @param props - The options for both restoring and saving.\n * @returns A tuple of a function that stops persisting, and a promise that resolves once the\n * restore is done.\n */\nexport function persistQueryClient(\n  props: PersistQueryClientOptions,\n): [() => void, Promise<void>] {\n  let hasUnsubscribed = false\n  let persistQueryClientUnsubscribe: (() => void) | undefined\n  const unsubscribe = () => {\n    hasUnsubscribed = true\n    persistQueryClientUnsubscribe?.()\n  }\n\n  // Attempt restore\n  const restorePromise = persistQueryClientRestore(props).then(() => {\n    if (!hasUnsubscribed) {\n      // Subscribe to changes in the query cache to trigger the save\n      persistQueryClientUnsubscribe = persistQueryClientSubscribe(props)\n    }\n  })\n\n  return [unsubscribe, restorePromise]\n}\n"],"mappings":";;AAqGA,MAAM,kBAA0C;CAAC;CAAS;CAAW;AAAS;;;;;;;AAQ9E,SAAS,iBAAiB,WAA4B;CACpD,OAAO,gBAAgB,SAAS,SAAS;AAC3C;;;;;;;;;;;;AAaA,eAAsB,0BAA0B,EAC9C,aACA,WACA,SAAS,OACT,SAAS,IACT,kBACqC;CACrC,IAAI;EACF,MAAM,kBAAkB,MAAM,UAAU,cAAc;EAEtD,IAAI,iBAAiB;GACnB,IAAI,gBAAgB,WAAW;IAC7B,MAAM,UAAU,KAAK,IAAI,IAAI,gBAAgB,YAAY;IACzD,MAAM,SAAS,gBAAgB,WAAW;IAC1C,IAAI,WAAW,QACb,OAAO,UAAU,aAAa;SAE9B,QAAQ,aAAa,gBAAgB,aAAa,cAAc;GAEpE,OACE,OAAO,UAAU,aAAa;EAElC;CACF,SAAS,KAAK;EACZ,IAAI,QAAQ,IAAI,aAAa,cAAc;GACzC,QAAQ,MAAM,GAAG;GACjB,QAAQ,KACN,0IACF;EACF;EAEA,MAAM,UAAU,aAAa;EAE7B,MAAM;CACR;AACF;;;;;;;;AASA,eAAsB,uBAAuB,EAC3C,aACA,WACA,SAAS,IACT,oBACkC;CAClC,MAAM,gBAAiC;EACrC;EACA,WAAW,KAAK,IAAI;EACpB,aAAa,UAAU,aAAa,gBAAgB;CACtD;CAEA,MAAM,UAAU,cAAc,aAAa;AAC7C;;;;;;;AAQA,SAAgB,4BACd,OACA;CACA,MAAM,wBAAwB,MAAM,YACjC,cAAc,CAAC,CACf,WAAW,UAAU;EACpB,IAAI,iBAAiB,MAAM,IAAI,GAC7B,uBAAuB,KAAK;CAEhC,CAAC;CAEH,MAAM,2BAA2B,MAAM,YACpC,iBAAiB,CAAC,CAClB,WAAW,UAAU;EACpB,IAAI,iBAAiB,MAAM,IAAI,GAC7B,uBAAuB,KAAK;CAEhC,CAAC;CAEH,aAAa;EACX,sBAAsB;EACtB,yBAAyB;CAC3B;AACF;;;;;;;AAQA,SAAgB,mBACd,OAC6B;CAC7B,IAAI,kBAAkB;CACtB,IAAI;CACJ,MAAM,oBAAoB;EACxB,kBAAkB;EAClB,gCAAgC;CAClC;CAUA,OAAO,CAAC,aAPe,0BAA0B,KAAK,CAAC,CAAC,WAAW;EACjE,IAAI,CAAC,iBAEH,gCAAgC,4BAA4B,KAAK;CAErE,CAEkC,CAAC;AACrC"}
+{"version":3,"file":"persist.js","names":[],"sources":["../../src/persist.ts"],"sourcesContent":["import { dehydrate, hydrate } from '@tanstack/query-core'\nimport type {\n  DehydrateOptions,\n  DehydratedState,\n  HydrateOptions,\n  NotifyEventType,\n  QueryClient,\n} from '@tanstack/query-core'\n\n/**\n * A value, or a promise-like that resolves to it.\n */\nexport type Promisable<T> = T | PromiseLike<T>\n\n/**\n * Saves, restores, and removes a {@link PersistedClient} in a storage.\n */\nexport interface Persister {\n  /**\n   * Saves the persisted client to the storage.\n   */\n  persistClient: (persistClient: PersistedClient) => Promisable<void>\n  /**\n   * Reads the persisted client from the storage, or `undefined` if nothing was saved.\n   */\n  restoreClient: () => Promisable<PersistedClient | undefined>\n  /**\n   * Removes the persisted client from the storage.\n   */\n  removeClient: () => Promisable<void>\n}\n\n/**\n * The dehydrated state of a `QueryClient` as it is persisted, with the time it was saved and its\n * `buster`.\n */\nexport interface PersistedClient {\n  /**\n   * When the client was saved, in milliseconds since the epoch. Compared with `maxAge` on restore.\n   */\n  timestamp: number\n  /**\n   * The `buster` the client was saved with. A persisted client with a different `buster` is\n   * discarded.\n   */\n  buster: string\n  /**\n   * The dehydrated cache of the `QueryClient`.\n   */\n  clientState: DehydratedState\n}\n\n/**\n * The options shared by restoring and saving a persisted `QueryClient`.\n */\nexport interface PersistQueryClientRootOptions {\n  /** The QueryClient to persist */\n  queryClient: QueryClient\n  /**\n   * The Persister interface for storing and restoring the cache\n   * to/from a persisted location\n   */\n  persister: Persister\n  /**\n   * A unique string that can be used to forcefully\n   * invalidate existing caches if they do not share the same buster string\n   */\n  buster?: string\n}\n\n/**\n * Options for restoring a persisted `QueryClient` with {@link persistQueryClientRestore}.\n */\nexport interface PersistedQueryClientRestoreOptions extends PersistQueryClientRootOptions {\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   */\n  maxAge?: number\n  /** The options passed to the hydrate function */\n  hydrateOptions?: HydrateOptions\n}\n\n/**\n * Options for saving a `QueryClient` with {@link persistQueryClientSave}.\n */\nexport interface PersistedQueryClientSaveOptions extends PersistQueryClientRootOptions {\n  /** The options passed to the dehydrate function */\n  dehydrateOptions?: DehydrateOptions\n}\n\n/**\n * Options for {@link persistQueryClient}, which both restores and saves a `QueryClient`.\n */\nexport interface PersistQueryClientOptions\n  extends\n    PersistedQueryClientRestoreOptions,\n    PersistedQueryClientSaveOptions,\n    PersistQueryClientRootOptions {}\n\nconst cacheEventTypes: Array<NotifyEventType> = ['added', 'removed', 'updated']\n\n/**\n * Checks if emitted event is about cache change and not about observers.\n * Useful for persist, where we only want to trigger save when cache is changed.\n * @param eventType - The type of the emitted event.\n * @returns `true` if the event is `'added'`, `'removed'`, or `'updated'`.\n */\nfunction isCacheEventType(eventType: NotifyEventType) {\n  return cacheEventTypes.includes(eventType)\n}\n\n/**\n * Restores persisted data to the QueryCache.\n *  - data obtained from persister.restoreClient.\n *  - data is hydrated using hydrateOptions.\n * If data is expired, busted, empty, or throws, it runs persister.removeClient.\n * @param options - The `queryClient` to restore into, the `persister`, and the `maxAge`, `buster`,\n * and `hydrateOptions` that decide whether and how the persisted data is restored.\n * @returns A promise that resolves once the data is restored or removed. If restoring throws, it\n * attempts to remove the persisted data and then rejects with the restore error, or with the removal\n * error if the removal fails too.\n */\nexport async function persistQueryClientRestore({\n  queryClient,\n  persister,\n  maxAge = 24 * 60 * 60 * 1000,\n  buster = '',\n  hydrateOptions,\n}: PersistedQueryClientRestoreOptions) {\n  try {\n    const persistedClient = await persister.restoreClient()\n\n    if (persistedClient) {\n      if (persistedClient.timestamp) {\n        const expired = Date.now() - persistedClient.timestamp > maxAge\n        const busted = persistedClient.buster !== buster\n        if (expired || busted) {\n          return persister.removeClient()\n        } else {\n          hydrate(queryClient, persistedClient.clientState, hydrateOptions)\n        }\n      } else {\n        return persister.removeClient()\n      }\n    }\n  } catch (err) {\n    if (process.env.NODE_ENV !== 'production') {\n      console.error(err)\n      console.warn(\n        'Encountered an error attempting to restore client cache from persisted location. As a precaution, the persisted cache will be discarded.',\n      )\n    }\n\n    await persister.removeClient()\n\n    throw err\n  }\n}\n\n/**\n * Persists data from the QueryCache.\n *  - data dehydrated using dehydrateOptions.\n *  - data is persisted using persister.persistClient.\n * @param options - The `queryClient` to persist, the `persister`, the `buster`, and the\n * `dehydrateOptions`.\n */\nexport async function persistQueryClientSave({\n  queryClient,\n  persister,\n  buster = '',\n  dehydrateOptions,\n}: PersistedQueryClientSaveOptions) {\n  const persistClient: PersistedClient = {\n    buster,\n    timestamp: Date.now(),\n    clientState: dehydrate(queryClient, dehydrateOptions),\n  }\n\n  await persister.persistClient(persistClient)\n}\n\n/**\n * Subscribe to QueryCache and MutationCache updates (for persisting).\n * @param props - The `queryClient` to monitor, the `persister`, the `buster`, and the\n * `dehydrateOptions` used for each save.\n * @returns an unsubscribe function (to discontinue monitoring)\n */\nexport function persistQueryClientSubscribe(\n  props: PersistedQueryClientSaveOptions,\n) {\n  const save = () => {\n    persistQueryClientSave(props).catch((err) => {\n      if (process.env.NODE_ENV !== 'production') {\n        console.error(err)\n        console.warn(\n          'Encountered an error attempting to persist client cache to persisted location.',\n        )\n      }\n    })\n  }\n\n  const unsubscribeQueryCache = props.queryClient\n    .getQueryCache()\n    .subscribe((event) => {\n      if (isCacheEventType(event.type)) {\n        save()\n      }\n    })\n\n  const unsubscribeMutationCache = props.queryClient\n    .getMutationCache()\n    .subscribe((event) => {\n      if (isCacheEventType(event.type)) {\n        save()\n      }\n    })\n\n  return () => {\n    unsubscribeQueryCache()\n    unsubscribeMutationCache()\n  }\n}\n\n/**\n * Restores persisted data to QueryCache and persists further changes.\n * @param props - The options for both restoring and saving.\n * @returns A tuple of a function that stops persisting, and a promise that resolves once the\n * restore is done.\n */\nexport function persistQueryClient(\n  props: PersistQueryClientOptions,\n): [() => void, Promise<void>] {\n  let hasUnsubscribed = false\n  let persistQueryClientUnsubscribe: (() => void) | undefined\n  const unsubscribe = () => {\n    hasUnsubscribed = true\n    persistQueryClientUnsubscribe?.()\n  }\n\n  // Attempt restore\n  const restorePromise = persistQueryClientRestore(props).then(() => {\n    if (!hasUnsubscribed) {\n      // Subscribe to changes in the query cache to trigger the save\n      persistQueryClientUnsubscribe = persistQueryClientSubscribe(props)\n    }\n  })\n\n  return [unsubscribe, restorePromise]\n}\n"],"mappings":";;AAqGA,MAAM,kBAA0C;CAAC;CAAS;CAAW;AAAS;;;;;;;AAQ9E,SAAS,iBAAiB,WAA4B;CACpD,OAAO,gBAAgB,SAAS,SAAS;AAC3C;;;;;;;;;;;;AAaA,eAAsB,0BAA0B,EAC9C,aACA,WACA,SAAS,OACT,SAAS,IACT,kBACqC;CACrC,IAAI;EACF,MAAM,kBAAkB,MAAM,UAAU,cAAc;EAEtD,IAAI,iBAAiB;GACnB,IAAI,gBAAgB,WAAW;IAC7B,MAAM,UAAU,KAAK,IAAI,IAAI,gBAAgB,YAAY;IACzD,MAAM,SAAS,gBAAgB,WAAW;IAC1C,IAAI,WAAW,QACb,OAAO,UAAU,aAAa;SAE9B,QAAQ,aAAa,gBAAgB,aAAa,cAAc;GAEpE,OACE,OAAO,UAAU,aAAa;EAElC;CACF,SAAS,KAAK;EACZ,IAAI,QAAQ,IAAI,aAAa,cAAc;GACzC,QAAQ,MAAM,GAAG;GACjB,QAAQ,KACN,0IACF;EACF;EAEA,MAAM,UAAU,aAAa;EAE7B,MAAM;CACR;AACF;;;;;;;;AASA,eAAsB,uBAAuB,EAC3C,aACA,WACA,SAAS,IACT,oBACkC;CAClC,MAAM,gBAAiC;EACrC;EACA,WAAW,KAAK,IAAI;EACpB,aAAa,UAAU,aAAa,gBAAgB;CACtD;CAEA,MAAM,UAAU,cAAc,aAAa;AAC7C;;;;;;;AAQA,SAAgB,4BACd,OACA;CACA,MAAM,aAAa;EACjB,uBAAuB,KAAK,CAAC,CAAC,OAAO,QAAQ;GAC3C,IAAI,QAAQ,IAAI,aAAa,cAAc;IACzC,QAAQ,MAAM,GAAG;IACjB,QAAQ,KACN,gFACF;GACF;EACF,CAAC;CACH;CAEA,MAAM,wBAAwB,MAAM,YACjC,cAAc,CAAC,CACf,WAAW,UAAU;EACpB,IAAI,iBAAiB,MAAM,IAAI,GAC7B,KAAK;CAET,CAAC;CAEH,MAAM,2BAA2B,MAAM,YACpC,iBAAiB,CAAC,CAClB,WAAW,UAAU;EACpB,IAAI,iBAAiB,MAAM,IAAI,GAC7B,KAAK;CAET,CAAC;CAEH,aAAa;EACX,sBAAsB;EACtB,yBAAyB;CAC3B;AACF;;;;;;;AAQA,SAAgB,mBACd,OAC6B;CAC7B,IAAI,kBAAkB;CACtB,IAAI;CACJ,MAAM,oBAAoB;EACxB,kBAAkB;EAClB,gCAAgC;CAClC;CAUA,OAAO,CAAC,aAPe,0BAA0B,KAAK,CAAC,CAAC,WAAW;EACjE,IAAI,CAAC,iBAEH,gCAAgC,4BAA4B,KAAK;CAErE,CAEkC,CAAC;AACrC"}

package/build/modern/retryStrategies.cjs

@@ -1,5 +1,5 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-//#region src/retryStrategies.ts
+// src/retryStrategies.ts
 /**
 * A {@link PersistRetryer} that drops the query with the oldest `dataUpdatedAt` and tries again, until
 * no queries are left.
@@ -23,7 +23,6 @@ const removeOldestQuery = ({ persistedClient }) => {
 		return client;
 	}
 };
-//#endregion
 exports.removeOldestQuery = removeOldestQuery;
 
 //# sourceMappingURL=retryStrategies.cjs.map

package/build/modern/retryStrategies.d.cts

@@ -1,5 +1,4 @@
 import { PersistedClient } from "./persist.cjs";
-//#region src/retryStrategies.d.ts
 /**
  * Called when saving the persisted client fails. Returns a smaller client to try saving again, or
  * `undefined` to give up.
@@ -16,5 +15,4 @@ export type PersistRetryer = (props: {
  * @returns A copy of the client without its oldest query, or `undefined` if it has no queries.
  */
 export declare const removeOldestQuery: PersistRetryer;
-//#endregion
 //# sourceMappingURL=retryStrategies.d.cts.map

package/build/modern/retryStrategies.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"retryStrategies.d.cts","names":[],"sources":["../../src/retryStrategies.ts"],"mappings":";;;;;;YAMY,kBAAkB;EAC5B,iBAAiB;EACjB,OAAO;EACP;MACI;;;;;;;qBAQO,mBAAmB"}
+{"version":3,"file":"retryStrategies.d.cts","names":[],"sources":["../../src/retryStrategies.ts"],"mappings":";;;;;YAMY,kBAAkB;EAC5B,iBAAiB;EACjB,OAAO;EACP;MACI;;;;;;;qBAQO,mBAAmB"}

package/build/modern/retryStrategies.d.ts

@@ -1,5 +1,4 @@
 import { PersistedClient } from "./persist.js";
-//#region src/retryStrategies.d.ts
 /**
  * Called when saving the persisted client fails. Returns a smaller client to try saving again, or
  * `undefined` to give up.
@@ -16,5 +15,4 @@ export type PersistRetryer = (props: {
  * @returns A copy of the client without its oldest query, or `undefined` if it has no queries.
  */
 export declare const removeOldestQuery: PersistRetryer;
-//#endregion
 //# sourceMappingURL=retryStrategies.d.ts.map

package/build/modern/retryStrategies.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"retryStrategies.d.ts","names":[],"sources":["../../src/retryStrategies.ts"],"mappings":";;;;;;YAMY,kBAAkB;EAC5B,iBAAiB;EACjB,OAAO;EACP;MACI;;;;;;;qBAQO,mBAAmB"}
+{"version":3,"file":"retryStrategies.d.ts","names":[],"sources":["../../src/retryStrategies.ts"],"mappings":";;;;;YAMY,kBAAkB;EAC5B,iBAAiB;EACjB,OAAO;EACP;MACI;;;;;;;qBAQO,mBAAmB"}

package/build/modern/retryStrategies.js

@@ -1,4 +1,4 @@
-//#region src/retryStrategies.ts
+// src/retryStrategies.ts
 /**
 * A {@link PersistRetryer} that drops the query with the oldest `dataUpdatedAt` and tries again, until
 * no queries are left.
@@ -22,7 +22,6 @@ const removeOldestQuery = ({ persistedClient }) => {
 		return client;
 	}
 };
-//#endregion
 export { removeOldestQuery };
 
 //# sourceMappingURL=retryStrategies.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/query-persist-client-core",
-  "version": "5.105.0",
+  "version": "5.105.1",
   "description": "Set of utilities for interacting with persisters, which can save your queryClient for later use",
   "author": "tannerlinsley",
   "license": "MIT",
@@ -40,7 +40,7 @@
     "!src/__tests__"
   ],
   "dependencies": {
-    "@tanstack/query-core": "5.105.0"
+    "@tanstack/query-core": "5.105.1"
   },
   "devDependencies": {
     "@tanstack/query-test-utils": "0.0.0",

package/src/createPersister.ts

@@ -148,6 +148,31 @@ export function experimental_createQueryPersister<TStorageValue = string>({
   refetchOnRestore = true,
   filters: persistFilters,
 }: StoragePersisterOptions<TStorageValue>) {
+  /**
+   * Checks the fields used to filter, expire, and restore a deserialized query.
+   * @param value - The deserialized value to check.
+   * @returns `true` if the value can be processed as a persisted query.
+   */
+  function isValidPersistedQuery(value: unknown) {
+    if (typeof value !== 'object' || value === null || Array.isArray(value)) {
+      return false
+    }
+
+    const persistedQuery = value as Partial<Omit<PersistedQuery, 'state'>> & {
+      state?: Partial<QueryState> | null
+    }
+    const state = persistedQuery.state
+
+    return (
+      typeof persistedQuery.queryHash === 'string' &&
+      Array.isArray(persistedQuery.queryKey) &&
+      typeof state === 'object' &&
+      state !== null &&
+      !Array.isArray(state) &&
+      Number.isFinite(state.dataUpdatedAt)
+    )
+  }
+
   /**
    * Checks whether a persisted query should be discarded.
    * @param persistedQuery - The persisted query to check.
@@ -190,6 +215,9 @@ export function experimental_createQueryPersister<TStorageValue = string>({
           let persistedQuery: PersistedQuery
           try {
             persistedQuery = await deserialize(storedData)
+            if (!isValidPersistedQuery(persistedQuery)) {
+              throw new Error('Invalid persisted query')
+            }
           } catch {
             await storage.removeItem(storageKey)
             return
@@ -336,6 +364,9 @@ export function experimental_createQueryPersister<TStorageValue = string>({
           let persistedQuery: PersistedQuery
           try {
             persistedQuery = await deserialize(value)
+            if (!isValidPersistedQuery(persistedQuery)) {
+              throw new Error('Invalid persisted query')
+            }
           } catch {
             await storage.removeItem(key)
             continue
@@ -374,6 +405,9 @@ export function experimental_createQueryPersister<TStorageValue = string>({
           let persistedQuery: PersistedQuery
           try {
             persistedQuery = await deserialize(value)
+            if (!isValidPersistedQuery(persistedQuery)) {
+              throw new Error('Invalid persisted query')
+            }
           } catch {
             await storage.removeItem(key)
             continue
@@ -434,6 +468,9 @@ export function experimental_createQueryPersister<TStorageValue = string>({
           let persistedQuery: PersistedQuery
           try {
             persistedQuery = await deserialize(value)
+            if (!isValidPersistedQuery(persistedQuery)) {
+              throw new Error('Invalid persisted query')
+            }
           } catch {
             await storage.removeItem(key)
             continue

package/src/persist.ts

@@ -190,11 +190,22 @@ export async function persistQueryClientSave({
 export function persistQueryClientSubscribe(
   props: PersistedQueryClientSaveOptions,
 ) {
+  const save = () => {
+    persistQueryClientSave(props).catch((err) => {
+      if (process.env.NODE_ENV !== 'production') {
+        console.error(err)
+        console.warn(
+          'Encountered an error attempting to persist client cache to persisted location.',
+        )
+      }
+    })
+  }
+
   const unsubscribeQueryCache = props.queryClient
     .getQueryCache()
     .subscribe((event) => {
       if (isCacheEventType(event.type)) {
-        persistQueryClientSave(props)
+        save()
       }
     })
 
@@ -202,7 +213,7 @@ export function persistQueryClientSubscribe(
     .getMutationCache()
     .subscribe((event) => {
       if (isCacheEventType(event.type)) {
-        persistQueryClientSave(props)
+        save()
       }
     })