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

package/build/modern/persist.cjs

@@ -1,23 +1,30 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 let _tanstack_query_core = require("@tanstack/query-core");
 //#region src/persist.ts
-/**
-* Checks if emitted event is about cache change and not about observers.
-* Useful for persist, where we only want to trigger save when cache is changed.
-*/
 const cacheEventTypes = [
 	"added",
 	"removed",
 	"updated"
 ];
+/**
+* Checks if emitted event is about cache change and not about observers.
+* Useful for persist, where we only want to trigger save when cache is changed.
+* @param eventType - The type of the emitted event.
+* @returns `true` if the event is `'added'`, `'removed'`, or `'updated'`.
+*/
 function isCacheEventType(eventType) {
 	return cacheEventTypes.includes(eventType);
 }
 /**
-* Restores persisted data to the QueryCache
-*  - data obtained from persister.restoreClient
-*  - data is hydrated using hydrateOptions
-* If data is expired, busted, empty, or throws, it runs persister.removeClient
+* Restores persisted data to the QueryCache.
+*  - data obtained from persister.restoreClient.
+*  - data is hydrated using hydrateOptions.
+* If data is expired, busted, empty, or throws, it runs persister.removeClient.
+* @param options - The `queryClient` to restore into, the `persister`, and the `maxAge`, `buster`,
+* and `hydrateOptions` that decide whether and how the persisted data is restored.
+* @returns A promise that resolves once the data is restored or removed. If restoring throws, it
+* attempts to remove the persisted data and then rejects with the restore error, or with the removal
+* error if the removal fails too.
 */
 async function persistQueryClientRestore({ queryClient, persister, maxAge = 864e5, buster = "", hydrateOptions }) {
 	try {
@@ -40,9 +47,11 @@ async function persistQueryClientRestore({ queryClient, persister, maxAge = 864e
 	}
 }
 /**
-* Persists data from the QueryCache
-*  - data dehydrated using dehydrateOptions
-*  - data is persisted using persister.persistClient
+* Persists data from the QueryCache.
+*  - data dehydrated using dehydrateOptions.
+*  - data is persisted using persister.persistClient.
+* @param options - The `queryClient` to persist, the `persister`, the `buster`, and the
+* `dehydrateOptions`.
 */
 async function persistQueryClientSave({ queryClient, persister, buster = "", dehydrateOptions }) {
 	const persistClient = {
@@ -53,7 +62,9 @@ async function persistQueryClientSave({ queryClient, persister, buster = "", deh
 	await persister.persistClient(persistClient);
 }
 /**
-* Subscribe to QueryCache and MutationCache updates (for persisting)
+* Subscribe to QueryCache and MutationCache updates (for persisting).
+* @param props - The `queryClient` to monitor, the `persister`, the `buster`, and the
+* `dehydrateOptions` used for each save.
 * @returns an unsubscribe function (to discontinue monitoring)
 */
 function persistQueryClientSubscribe(props) {
@@ -70,6 +81,9 @@ function persistQueryClientSubscribe(props) {
 }
 /**
 * Restores persisted data to QueryCache and persists further changes.
+* @param props - The options for both restoring and saving.
+* @returns A tuple of a function that stops persisting, and a promise that resolves once the
+* restore is done.
 */
 function persistQueryClient(props) {
 	let hasUnsubscribed = false;

package/build/modern/persist.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"persist.cjs","names":["dehydrate"],"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\nexport type Promisable<T> = T | PromiseLike<T>\n\nexport interface Persister {\n  persistClient: (persistClient: PersistedClient) => Promisable<void>\n  restoreClient: () => Promisable<PersistedClient | undefined>\n  removeClient: () => Promisable<void>\n}\n\nexport interface PersistedClient {\n  timestamp: number\n  buster: string\n  clientState: DehydratedState\n}\n\nexport interface PersistQueryClientRootOptions {\n  /** The QueryClient to persist */\n  queryClient: QueryClient\n  /** The Persister interface for storing and restoring the cache\n   * to/from a persisted location */\n  persister: Persister\n  /** A unique string that can be used to forcefully\n   * invalidate existing caches if they do not share the same buster string */\n  buster?: string\n}\n\nexport interface PersistedQueryClientRestoreOptions extends PersistQueryClientRootOptions {\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  maxAge?: number\n  /** The options passed to the hydrate function */\n  hydrateOptions?: HydrateOptions\n}\n\nexport interface PersistedQueryClientSaveOptions extends PersistQueryClientRootOptions {\n  /** The options passed to the dehydrate function */\n  dehydrateOptions?: DehydrateOptions\n}\n\nexport interface PersistQueryClientOptions\n  extends\n    PersistedQueryClientRestoreOptions,\n    PersistedQueryClientSaveOptions,\n    PersistQueryClientRootOptions {}\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 */\nconst cacheEventTypes: Array<NotifyEventType> = ['added', 'removed', '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 */\nexport async function persistQueryClientRestore({\n  queryClient,\n  persister,\n  maxAge = 1000 * 60 * 60 * 24,\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 */\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 * @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 */\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":";;;;;;;AA0DA,MAAM,kBAA0C;CAAC;CAAS;CAAW;AAAS;AAE9E,SAAS,iBAAiB,WAA4B;CACpD,OAAO,gBAAgB,SAAS,SAAS;AAC3C;;;;;;;AAQA,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,CAAA,GAAA,qBAAA,QAAA,CAAQ,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;;;;;;AAOA,eAAsB,uBAAuB,EAC3C,aACA,WACA,SAAS,IACT,oBACkC;CAClC,MAAM,gBAAiC;EACrC;EACA,WAAW,KAAK,IAAI;EACpB,cAAA,GAAaA,qBAAAA,UAAAA,CAAU,aAAa,gBAAgB;CACtD;CAEA,MAAM,UAAU,cAAc,aAAa;AAC7C;;;;;AAMA,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;;;;AAKA,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.cjs","names":["dehydrate"],"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 = 1000 * 60 * 60 * 24,\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,CAAA,GAAA,qBAAA,QAAA,CAAQ,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,cAAA,GAAaA,qBAAAA,UAAAA,CAAU,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"}

package/build/modern/persist.d.cts

@@ -1,59 +1,118 @@
 import { DehydrateOptions, DehydratedState, HydrateOptions, QueryClient } from "@tanstack/query-core";
 //#region src/persist.d.ts
+/**
+ * A value, or a promise-like that resolves to it.
+ */
 export type Promisable<T> = T | PromiseLike<T>;
+/**
+ * Saves, restores, and removes a {@link PersistedClient} in a storage.
+ */
 export interface Persister {
+  /**
+   * Saves the persisted client to the storage.
+   */
   persistClient: (persistClient: PersistedClient) => Promisable<void>;
+  /**
+   * Reads the persisted client from the storage, or `undefined` if nothing was saved.
+   */
   restoreClient: () => Promisable<PersistedClient | undefined>;
+  /**
+   * Removes the persisted client from the storage.
+   */
   removeClient: () => Promisable<void>;
 }
+/**
+ * The dehydrated state of a `QueryClient` as it is persisted, with the time it was saved and its
+ * `buster`.
+ */
 export interface PersistedClient {
+  /**
+   * When the client was saved, in milliseconds since the epoch. Compared with `maxAge` on restore.
+   */
   timestamp: number;
+  /**
+   * The `buster` the client was saved with. A persisted client with a different `buster` is
+   * discarded.
+   */
   buster: string;
+  /**
+   * The dehydrated cache of the `QueryClient`.
+   */
   clientState: DehydratedState;
 }
+/**
+ * The options shared by restoring and saving a persisted `QueryClient`.
+ */
 export interface PersistQueryClientRootOptions {
   /** The QueryClient to persist */
   queryClient: QueryClient;
-  /** The Persister interface for storing and restoring the cache
-   * to/from a persisted location */
+  /**
+   * The Persister interface for storing and restoring the cache
+   * to/from a persisted location
+   */
   persister: Persister;
-  /** A unique string that can be used to forcefully
-   * invalidate existing caches if they do not share the same buster string */
+  /**
+   * A unique string that can be used to forcefully
+   * invalidate existing caches if they do not share the same buster string
+   */
   buster?: string;
 }
+/**
+ * Options for restoring a persisted `QueryClient` with {@link persistQueryClientRestore}.
+ */
 export interface PersistedQueryClientRestoreOptions extends PersistQueryClientRootOptions {
-  /** The max-allowed age of the cache in milliseconds.
+  /**
+   * The max-allowed age of the cache in milliseconds.
    * If a persisted cache is found that is older than this
-   * time, it will be discarded */
+   * time, it will be discarded
+   */
   maxAge?: number;
   /** The options passed to the hydrate function */
   hydrateOptions?: HydrateOptions;
 }
+/**
+ * Options for saving a `QueryClient` with {@link persistQueryClientSave}.
+ */
 export interface PersistedQueryClientSaveOptions extends PersistQueryClientRootOptions {
   /** The options passed to the dehydrate function */
   dehydrateOptions?: DehydrateOptions;
 }
+/**
+ * Options for {@link persistQueryClient}, which both restores and saves a `QueryClient`.
+ */
 export interface PersistQueryClientOptions extends PersistedQueryClientRestoreOptions, PersistedQueryClientSaveOptions, PersistQueryClientRootOptions {}
 /**
- * Restores persisted data to the QueryCache
- *  - data obtained from persister.restoreClient
- *  - data is hydrated using hydrateOptions
- * If data is expired, busted, empty, or throws, it runs persister.removeClient
+ * Restores persisted data to the QueryCache.
+ *  - data obtained from persister.restoreClient.
+ *  - data is hydrated using hydrateOptions.
+ * If data is expired, busted, empty, or throws, it runs persister.removeClient.
+ * @param options - The `queryClient` to restore into, the `persister`, and the `maxAge`, `buster`,
+ * and `hydrateOptions` that decide whether and how the persisted data is restored.
+ * @returns A promise that resolves once the data is restored or removed. If restoring throws, it
+ * attempts to remove the persisted data and then rejects with the restore error, or with the removal
+ * error if the removal fails too.
  */
 export declare function persistQueryClientRestore({ queryClient, persister, maxAge, buster, hydrateOptions }: PersistedQueryClientRestoreOptions): Promise<void>;
 /**
- * Persists data from the QueryCache
- *  - data dehydrated using dehydrateOptions
- *  - data is persisted using persister.persistClient
+ * Persists data from the QueryCache.
+ *  - data dehydrated using dehydrateOptions.
+ *  - data is persisted using persister.persistClient.
+ * @param options - The `queryClient` to persist, the `persister`, the `buster`, and the
+ * `dehydrateOptions`.
  */
 export declare function persistQueryClientSave({ queryClient, persister, buster, dehydrateOptions }: PersistedQueryClientSaveOptions): Promise<void>;
 /**
- * Subscribe to QueryCache and MutationCache updates (for persisting)
+ * Subscribe to QueryCache and MutationCache updates (for persisting).
+ * @param props - The `queryClient` to monitor, the `persister`, the `buster`, and the
+ * `dehydrateOptions` used for each save.
  * @returns an unsubscribe function (to discontinue monitoring)
  */
 export declare function persistQueryClientSubscribe(props: PersistedQueryClientSaveOptions): () => void;
 /**
  * Restores persisted data to QueryCache and persists further changes.
+ * @param props - The options for both restoring and saving.
+ * @returns A tuple of a function that stops persisting, and a promise that resolves once the
+ * restore is done.
  */
 export declare function persistQueryClient(props: PersistQueryClientOptions): [() => void, Promise<void>];
 //#endregion

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

@@ -1 +1 @@
-{"version":3,"file":"persist.d.cts","names":[],"sources":["../../src/persist.ts"],"mappings":";;YASY,WAAW,KAAK,IAAI,YAAY;iBAE3B;EACf,gBAAgB,eAAe,oBAAoB;EACnD,qBAAqB,WAAW;EAChC,oBAAoB;;iBAGL;EACf;EACA;EACA,aAAa;;iBAGE;;EAEf,aAAa;;;EAGb,WAAW;;;EAGX;;iBAGe,2CAA2C;;;;EAI1D;;EAEA,iBAAiB;;iBAGF,wCAAwC;;EAEvD,mBAAmB;;iBAGJ,kCAEb,oCACA,iCACA;;;;;;;wBAkBkB,4BACpB,aACA,WACA,QACA,QACA,kBACC,qCAAkC;;;;;;wBAoCf,yBACpB,aACA,WACA,QACA,oBACC,kCAA+B;;;;;wBAclB,4BACd,OAAO;;;;wBA2BO,mBACd,OAAO,yCACO"}
+{"version":3,"file":"persist.d.cts","names":[],"sources":["../../src/persist.ts"],"mappings":";;;;;YAYY,WAAW,KAAK,IAAI,YAAY;;;;iBAK3B;;;;EAIf,gBAAgB,eAAe,oBAAoB;;;;EAInD,qBAAqB,WAAW;;;;EAIhC,oBAAoB;;;;;;iBAOL;;;;EAIf;;;;;EAKA;;;;EAIA,aAAa;;;;;iBAME;;EAEf,aAAa;;;;;EAKb,WAAW;;;;;EAKX;;;;;iBAMe,2CAA2C;;;;;;EAM1D;;EAEA,iBAAiB;;;;;iBAMF,wCAAwC;;EAEvD,mBAAmB;;;;;iBAMJ,kCAEb,oCACA,iCACA;;;;;;;;;;;;wBAyBkB,4BACpB,aACA,WACA,QACA,QACA,kBACC,qCAAkC;;;;;;;;wBAsCf,yBACpB,aACA,WACA,QACA,oBACC,kCAA+B;;;;;;;wBAgBlB,4BACd,OAAO;;;;;;;wBA8BO,mBACd,OAAO,yCACO"}

package/build/modern/persist.d.ts

@@ -1,59 +1,118 @@
 import { DehydrateOptions, DehydratedState, HydrateOptions, QueryClient } from "@tanstack/query-core";
 //#region src/persist.d.ts
+/**
+ * A value, or a promise-like that resolves to it.
+ */
 export type Promisable<T> = T | PromiseLike<T>;
+/**
+ * Saves, restores, and removes a {@link PersistedClient} in a storage.
+ */
 export interface Persister {
+  /**
+   * Saves the persisted client to the storage.
+   */
   persistClient: (persistClient: PersistedClient) => Promisable<void>;
+  /**
+   * Reads the persisted client from the storage, or `undefined` if nothing was saved.
+   */
   restoreClient: () => Promisable<PersistedClient | undefined>;
+  /**
+   * Removes the persisted client from the storage.
+   */
   removeClient: () => Promisable<void>;
 }
+/**
+ * The dehydrated state of a `QueryClient` as it is persisted, with the time it was saved and its
+ * `buster`.
+ */
 export interface PersistedClient {
+  /**
+   * When the client was saved, in milliseconds since the epoch. Compared with `maxAge` on restore.
+   */
   timestamp: number;
+  /**
+   * The `buster` the client was saved with. A persisted client with a different `buster` is
+   * discarded.
+   */
   buster: string;
+  /**
+   * The dehydrated cache of the `QueryClient`.
+   */
   clientState: DehydratedState;
 }
+/**
+ * The options shared by restoring and saving a persisted `QueryClient`.
+ */
 export interface PersistQueryClientRootOptions {
   /** The QueryClient to persist */
   queryClient: QueryClient;
-  /** The Persister interface for storing and restoring the cache
-   * to/from a persisted location */
+  /**
+   * The Persister interface for storing and restoring the cache
+   * to/from a persisted location
+   */
   persister: Persister;
-  /** A unique string that can be used to forcefully
-   * invalidate existing caches if they do not share the same buster string */
+  /**
+   * A unique string that can be used to forcefully
+   * invalidate existing caches if they do not share the same buster string
+   */
   buster?: string;
 }
+/**
+ * Options for restoring a persisted `QueryClient` with {@link persistQueryClientRestore}.
+ */
 export interface PersistedQueryClientRestoreOptions extends PersistQueryClientRootOptions {
-  /** The max-allowed age of the cache in milliseconds.
+  /**
+   * The max-allowed age of the cache in milliseconds.
    * If a persisted cache is found that is older than this
-   * time, it will be discarded */
+   * time, it will be discarded
+   */
   maxAge?: number;
   /** The options passed to the hydrate function */
   hydrateOptions?: HydrateOptions;
 }
+/**
+ * Options for saving a `QueryClient` with {@link persistQueryClientSave}.
+ */
 export interface PersistedQueryClientSaveOptions extends PersistQueryClientRootOptions {
   /** The options passed to the dehydrate function */
   dehydrateOptions?: DehydrateOptions;
 }
+/**
+ * Options for {@link persistQueryClient}, which both restores and saves a `QueryClient`.
+ */
 export interface PersistQueryClientOptions extends PersistedQueryClientRestoreOptions, PersistedQueryClientSaveOptions, PersistQueryClientRootOptions {}
 /**
- * Restores persisted data to the QueryCache
- *  - data obtained from persister.restoreClient
- *  - data is hydrated using hydrateOptions
- * If data is expired, busted, empty, or throws, it runs persister.removeClient
+ * Restores persisted data to the QueryCache.
+ *  - data obtained from persister.restoreClient.
+ *  - data is hydrated using hydrateOptions.
+ * If data is expired, busted, empty, or throws, it runs persister.removeClient.
+ * @param options - The `queryClient` to restore into, the `persister`, and the `maxAge`, `buster`,
+ * and `hydrateOptions` that decide whether and how the persisted data is restored.
+ * @returns A promise that resolves once the data is restored or removed. If restoring throws, it
+ * attempts to remove the persisted data and then rejects with the restore error, or with the removal
+ * error if the removal fails too.
  */
 export declare function persistQueryClientRestore({ queryClient, persister, maxAge, buster, hydrateOptions }: PersistedQueryClientRestoreOptions): Promise<void>;
 /**
- * Persists data from the QueryCache
- *  - data dehydrated using dehydrateOptions
- *  - data is persisted using persister.persistClient
+ * Persists data from the QueryCache.
+ *  - data dehydrated using dehydrateOptions.
+ *  - data is persisted using persister.persistClient.
+ * @param options - The `queryClient` to persist, the `persister`, the `buster`, and the
+ * `dehydrateOptions`.
  */
 export declare function persistQueryClientSave({ queryClient, persister, buster, dehydrateOptions }: PersistedQueryClientSaveOptions): Promise<void>;
 /**
- * Subscribe to QueryCache and MutationCache updates (for persisting)
+ * Subscribe to QueryCache and MutationCache updates (for persisting).
+ * @param props - The `queryClient` to monitor, the `persister`, the `buster`, and the
+ * `dehydrateOptions` used for each save.
  * @returns an unsubscribe function (to discontinue monitoring)
  */
 export declare function persistQueryClientSubscribe(props: PersistedQueryClientSaveOptions): () => void;
 /**
  * Restores persisted data to QueryCache and persists further changes.
+ * @param props - The options for both restoring and saving.
+ * @returns A tuple of a function that stops persisting, and a promise that resolves once the
+ * restore is done.
  */
 export declare function persistQueryClient(props: PersistQueryClientOptions): [() => void, Promise<void>];
 //#endregion

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

@@ -1 +1 @@
-{"version":3,"file":"persist.d.ts","names":[],"sources":["../../src/persist.ts"],"mappings":";;YASY,WAAW,KAAK,IAAI,YAAY;iBAE3B;EACf,gBAAgB,eAAe,oBAAoB;EACnD,qBAAqB,WAAW;EAChC,oBAAoB;;iBAGL;EACf;EACA;EACA,aAAa;;iBAGE;;EAEf,aAAa;;;EAGb,WAAW;;;EAGX;;iBAGe,2CAA2C;;;;EAI1D;;EAEA,iBAAiB;;iBAGF,wCAAwC;;EAEvD,mBAAmB;;iBAGJ,kCAEb,oCACA,iCACA;;;;;;;wBAkBkB,4BACpB,aACA,WACA,QACA,QACA,kBACC,qCAAkC;;;;;;wBAoCf,yBACpB,aACA,WACA,QACA,oBACC,kCAA+B;;;;;wBAclB,4BACd,OAAO;;;;wBA2BO,mBACd,OAAO,yCACO"}
+{"version":3,"file":"persist.d.ts","names":[],"sources":["../../src/persist.ts"],"mappings":";;;;;YAYY,WAAW,KAAK,IAAI,YAAY;;;;iBAK3B;;;;EAIf,gBAAgB,eAAe,oBAAoB;;;;EAInD,qBAAqB,WAAW;;;;EAIhC,oBAAoB;;;;;;iBAOL;;;;EAIf;;;;;EAKA;;;;EAIA,aAAa;;;;;iBAME;;EAEf,aAAa;;;;;EAKb,WAAW;;;;;EAKX;;;;;iBAMe,2CAA2C;;;;;;EAM1D;;EAEA,iBAAiB;;;;;iBAMF,wCAAwC;;EAEvD,mBAAmB;;;;;iBAMJ,kCAEb,oCACA,iCACA;;;;;;;;;;;;wBAyBkB,4BACpB,aACA,WACA,QACA,QACA,kBACC,qCAAkC;;;;;;;;wBAsCf,yBACpB,aACA,WACA,QACA,oBACC,kCAA+B;;;;;;;wBAgBlB,4BACd,OAAO;;;;;;;wBA8BO,mBACd,OAAO,yCACO"}

package/build/modern/persist.js

@@ -1,22 +1,29 @@
 import { dehydrate, hydrate } from "@tanstack/query-core";
 //#region src/persist.ts
-/**
-* Checks if emitted event is about cache change and not about observers.
-* Useful for persist, where we only want to trigger save when cache is changed.
-*/
 const cacheEventTypes = [
 	"added",
 	"removed",
 	"updated"
 ];
+/**
+* Checks if emitted event is about cache change and not about observers.
+* Useful for persist, where we only want to trigger save when cache is changed.
+* @param eventType - The type of the emitted event.
+* @returns `true` if the event is `'added'`, `'removed'`, or `'updated'`.
+*/
 function isCacheEventType(eventType) {
 	return cacheEventTypes.includes(eventType);
 }
 /**
-* Restores persisted data to the QueryCache
-*  - data obtained from persister.restoreClient
-*  - data is hydrated using hydrateOptions
-* If data is expired, busted, empty, or throws, it runs persister.removeClient
+* Restores persisted data to the QueryCache.
+*  - data obtained from persister.restoreClient.
+*  - data is hydrated using hydrateOptions.
+* If data is expired, busted, empty, or throws, it runs persister.removeClient.
+* @param options - The `queryClient` to restore into, the `persister`, and the `maxAge`, `buster`,
+* and `hydrateOptions` that decide whether and how the persisted data is restored.
+* @returns A promise that resolves once the data is restored or removed. If restoring throws, it
+* attempts to remove the persisted data and then rejects with the restore error, or with the removal
+* error if the removal fails too.
 */
 async function persistQueryClientRestore({ queryClient, persister, maxAge = 864e5, buster = "", hydrateOptions }) {
 	try {
@@ -39,9 +46,11 @@ async function persistQueryClientRestore({ queryClient, persister, maxAge = 864e
 	}
 }
 /**
-* Persists data from the QueryCache
-*  - data dehydrated using dehydrateOptions
-*  - data is persisted using persister.persistClient
+* Persists data from the QueryCache.
+*  - data dehydrated using dehydrateOptions.
+*  - data is persisted using persister.persistClient.
+* @param options - The `queryClient` to persist, the `persister`, the `buster`, and the
+* `dehydrateOptions`.
 */
 async function persistQueryClientSave({ queryClient, persister, buster = "", dehydrateOptions }) {
 	const persistClient = {
@@ -52,7 +61,9 @@ async function persistQueryClientSave({ queryClient, persister, buster = "", deh
 	await persister.persistClient(persistClient);
 }
 /**
-* Subscribe to QueryCache and MutationCache updates (for persisting)
+* Subscribe to QueryCache and MutationCache updates (for persisting).
+* @param props - The `queryClient` to monitor, the `persister`, the `buster`, and the
+* `dehydrateOptions` used for each save.
 * @returns an unsubscribe function (to discontinue monitoring)
 */
 function persistQueryClientSubscribe(props) {
@@ -69,6 +80,9 @@ function persistQueryClientSubscribe(props) {
 }
 /**
 * Restores persisted data to QueryCache and persists further changes.
+* @param props - The options for both restoring and saving.
+* @returns A tuple of a function that stops persisting, and a promise that resolves once the
+* restore is done.
 */
 function persistQueryClient(props) {
 	let hasUnsubscribed = false;

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\nexport type Promisable<T> = T | PromiseLike<T>\n\nexport interface Persister {\n  persistClient: (persistClient: PersistedClient) => Promisable<void>\n  restoreClient: () => Promisable<PersistedClient | undefined>\n  removeClient: () => Promisable<void>\n}\n\nexport interface PersistedClient {\n  timestamp: number\n  buster: string\n  clientState: DehydratedState\n}\n\nexport interface PersistQueryClientRootOptions {\n  /** The QueryClient to persist */\n  queryClient: QueryClient\n  /** The Persister interface for storing and restoring the cache\n   * to/from a persisted location */\n  persister: Persister\n  /** A unique string that can be used to forcefully\n   * invalidate existing caches if they do not share the same buster string */\n  buster?: string\n}\n\nexport interface PersistedQueryClientRestoreOptions extends PersistQueryClientRootOptions {\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  maxAge?: number\n  /** The options passed to the hydrate function */\n  hydrateOptions?: HydrateOptions\n}\n\nexport interface PersistedQueryClientSaveOptions extends PersistQueryClientRootOptions {\n  /** The options passed to the dehydrate function */\n  dehydrateOptions?: DehydrateOptions\n}\n\nexport interface PersistQueryClientOptions\n  extends\n    PersistedQueryClientRestoreOptions,\n    PersistedQueryClientSaveOptions,\n    PersistQueryClientRootOptions {}\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 */\nconst cacheEventTypes: Array<NotifyEventType> = ['added', 'removed', '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 */\nexport async function persistQueryClientRestore({\n  queryClient,\n  persister,\n  maxAge = 1000 * 60 * 60 * 24,\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 */\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 * @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 */\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":";;;;;;AA0DA,MAAM,kBAA0C;CAAC;CAAS;CAAW;AAAS;AAE9E,SAAS,iBAAiB,WAA4B;CACpD,OAAO,gBAAgB,SAAS,SAAS;AAC3C;;;;;;;AAQA,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;;;;;;AAOA,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;;;;;AAMA,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;;;;AAKA,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 = 1000 * 60 * 60 * 24,\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"}

package/build/modern/retryStrategies.cjs

@@ -1,5 +1,11 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
 //#region src/retryStrategies.ts
+/**
+* A {@link PersistRetryer} that drops the query with the oldest `dataUpdatedAt` and tries again, until
+* no queries are left.
+* @param props - The `persistedClient` that failed to save.
+* @returns A copy of the client without its oldest query, or `undefined` if it has no queries.
+*/
 const removeOldestQuery = ({ persistedClient }) => {
 	const mutations = [...persistedClient.clientState.mutations];
 	const queries = [...persistedClient.clientState.queries];

package/build/modern/retryStrategies.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"retryStrategies.cjs","names":[],"sources":["../../src/retryStrategies.ts"],"sourcesContent":["import type { PersistedClient } from './persist'\n\nexport type PersistRetryer = (props: {\n  persistedClient: PersistedClient\n  error: Error\n  errorCount: number\n}) => PersistedClient | undefined\n\nexport const removeOldestQuery: PersistRetryer = ({ persistedClient }) => {\n  const mutations = [...persistedClient.clientState.mutations]\n  const queries = [...persistedClient.clientState.queries]\n  const client: PersistedClient = {\n    ...persistedClient,\n    clientState: { mutations, queries },\n  }\n\n  // sort queries by dataUpdatedAt (oldest first)\n  const sortedQueries = [...queries].sort(\n    (a, b) => a.state.dataUpdatedAt - b.state.dataUpdatedAt,\n  )\n\n  // clean oldest query\n  if (sortedQueries.length > 0) {\n    const oldestData = sortedQueries.shift()\n    client.clientState.queries = queries.filter((q) => q !== oldestData)\n    return client\n  }\n\n  return undefined\n}\n"],"mappings":";;AAQA,MAAa,qBAAqC,EAAE,sBAAsB;CACxE,MAAM,YAAY,CAAC,GAAG,gBAAgB,YAAY,SAAS;CAC3D,MAAM,UAAU,CAAC,GAAG,gBAAgB,YAAY,OAAO;CACvD,MAAM,SAA0B;EAC9B,GAAG;EACH,aAAa;GAAE;GAAW;EAAQ;CACpC;CAGA,MAAM,gBAAgB,CAAC,GAAG,OAAO,CAAC,CAAC,MAChC,GAAG,MAAM,EAAE,MAAM,gBAAgB,EAAE,MAAM,aAC5C;CAGA,IAAI,cAAc,SAAS,GAAG;EAC5B,MAAM,aAAa,cAAc,MAAM;EACvC,OAAO,YAAY,UAAU,QAAQ,QAAQ,MAAM,MAAM,UAAU;EACnE,OAAO;CACT;AAGF"}
+{"version":3,"file":"retryStrategies.cjs","names":[],"sources":["../../src/retryStrategies.ts"],"sourcesContent":["import type { PersistedClient } from './persist'\n\n/**\n * Called when saving the persisted client fails. Returns a smaller client to try saving again, or\n * `undefined` to give up.\n */\nexport type PersistRetryer = (props: {\n  persistedClient: PersistedClient\n  error: Error\n  errorCount: number\n}) => PersistedClient | undefined\n\n/**\n * A {@link PersistRetryer} that drops the query with the oldest `dataUpdatedAt` and tries again, until\n * no queries are left.\n * @param props - The `persistedClient` that failed to save.\n * @returns A copy of the client without its oldest query, or `undefined` if it has no queries.\n */\nexport const removeOldestQuery: PersistRetryer = ({ persistedClient }) => {\n  const mutations = [...persistedClient.clientState.mutations]\n  const queries = [...persistedClient.clientState.queries]\n  const client: PersistedClient = {\n    ...persistedClient,\n    clientState: { mutations, queries },\n  }\n\n  // sort queries by dataUpdatedAt (oldest first)\n  const sortedQueries = [...queries].sort(\n    (a, b) => a.state.dataUpdatedAt - b.state.dataUpdatedAt,\n  )\n\n  // clean oldest query\n  if (sortedQueries.length > 0) {\n    const oldestData = sortedQueries.shift()\n    client.clientState.queries = queries.filter((q) => q !== oldestData)\n    return client\n  }\n\n  return undefined\n}\n"],"mappings":";;;;;;;;AAkBA,MAAa,qBAAqC,EAAE,sBAAsB;CACxE,MAAM,YAAY,CAAC,GAAG,gBAAgB,YAAY,SAAS;CAC3D,MAAM,UAAU,CAAC,GAAG,gBAAgB,YAAY,OAAO;CACvD,MAAM,SAA0B;EAC9B,GAAG;EACH,aAAa;GAAE;GAAW;EAAQ;CACpC;CAGA,MAAM,gBAAgB,CAAC,GAAG,OAAO,CAAC,CAAC,MAChC,GAAG,MAAM,EAAE,MAAM,gBAAgB,EAAE,MAAM,aAC5C;CAGA,IAAI,cAAc,SAAS,GAAG;EAC5B,MAAM,aAAa,cAAc,MAAM;EACvC,OAAO,YAAY,UAAU,QAAQ,QAAQ,MAAM,MAAM,UAAU;EACnE,OAAO;CACT;AAGF"}

package/build/modern/retryStrategies.d.cts

@@ -1,10 +1,20 @@
 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.
+ */
 export type PersistRetryer = (props: {
   persistedClient: PersistedClient;
   error: Error;
   errorCount: number;
 }) => PersistedClient | undefined;
+/**
+ * A {@link PersistRetryer} that drops the query with the oldest `dataUpdatedAt` and tries again, until
+ * no queries are left.
+ * @param props - The `persistedClient` that failed to save.
+ * @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":";;YAEY,kBAAkB;EAC5B,iBAAiB;EACjB,OAAO;EACP;MACI;qBAEO,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,10 +1,20 @@
 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.
+ */
 export type PersistRetryer = (props: {
   persistedClient: PersistedClient;
   error: Error;
   errorCount: number;
 }) => PersistedClient | undefined;
+/**
+ * A {@link PersistRetryer} that drops the query with the oldest `dataUpdatedAt` and tries again, until
+ * no queries are left.
+ * @param props - The `persistedClient` that failed to save.
+ * @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":";;YAEY,kBAAkB;EAC5B,iBAAiB;EACjB,OAAO;EACP;MACI;qBAEO,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,10 @@
 //#region src/retryStrategies.ts
+/**
+* A {@link PersistRetryer} that drops the query with the oldest `dataUpdatedAt` and tries again, until
+* no queries are left.
+* @param props - The `persistedClient` that failed to save.
+* @returns A copy of the client without its oldest query, or `undefined` if it has no queries.
+*/
 const removeOldestQuery = ({ persistedClient }) => {
 	const mutations = [...persistedClient.clientState.mutations];
 	const queries = [...persistedClient.clientState.queries];

package/build/modern/retryStrategies.js.map

@@ -1 +1 @@
-{"version":3,"file":"retryStrategies.js","names":[],"sources":["../../src/retryStrategies.ts"],"sourcesContent":["import type { PersistedClient } from './persist'\n\nexport type PersistRetryer = (props: {\n  persistedClient: PersistedClient\n  error: Error\n  errorCount: number\n}) => PersistedClient | undefined\n\nexport const removeOldestQuery: PersistRetryer = ({ persistedClient }) => {\n  const mutations = [...persistedClient.clientState.mutations]\n  const queries = [...persistedClient.clientState.queries]\n  const client: PersistedClient = {\n    ...persistedClient,\n    clientState: { mutations, queries },\n  }\n\n  // sort queries by dataUpdatedAt (oldest first)\n  const sortedQueries = [...queries].sort(\n    (a, b) => a.state.dataUpdatedAt - b.state.dataUpdatedAt,\n  )\n\n  // clean oldest query\n  if (sortedQueries.length > 0) {\n    const oldestData = sortedQueries.shift()\n    client.clientState.queries = queries.filter((q) => q !== oldestData)\n    return client\n  }\n\n  return undefined\n}\n"],"mappings":";AAQA,MAAa,qBAAqC,EAAE,sBAAsB;CACxE,MAAM,YAAY,CAAC,GAAG,gBAAgB,YAAY,SAAS;CAC3D,MAAM,UAAU,CAAC,GAAG,gBAAgB,YAAY,OAAO;CACvD,MAAM,SAA0B;EAC9B,GAAG;EACH,aAAa;GAAE;GAAW;EAAQ;CACpC;CAGA,MAAM,gBAAgB,CAAC,GAAG,OAAO,CAAC,CAAC,MAChC,GAAG,MAAM,EAAE,MAAM,gBAAgB,EAAE,MAAM,aAC5C;CAGA,IAAI,cAAc,SAAS,GAAG;EAC5B,MAAM,aAAa,cAAc,MAAM;EACvC,OAAO,YAAY,UAAU,QAAQ,QAAQ,MAAM,MAAM,UAAU;EACnE,OAAO;CACT;AAGF"}
+{"version":3,"file":"retryStrategies.js","names":[],"sources":["../../src/retryStrategies.ts"],"sourcesContent":["import type { PersistedClient } from './persist'\n\n/**\n * Called when saving the persisted client fails. Returns a smaller client to try saving again, or\n * `undefined` to give up.\n */\nexport type PersistRetryer = (props: {\n  persistedClient: PersistedClient\n  error: Error\n  errorCount: number\n}) => PersistedClient | undefined\n\n/**\n * A {@link PersistRetryer} that drops the query with the oldest `dataUpdatedAt` and tries again, until\n * no queries are left.\n * @param props - The `persistedClient` that failed to save.\n * @returns A copy of the client without its oldest query, or `undefined` if it has no queries.\n */\nexport const removeOldestQuery: PersistRetryer = ({ persistedClient }) => {\n  const mutations = [...persistedClient.clientState.mutations]\n  const queries = [...persistedClient.clientState.queries]\n  const client: PersistedClient = {\n    ...persistedClient,\n    clientState: { mutations, queries },\n  }\n\n  // sort queries by dataUpdatedAt (oldest first)\n  const sortedQueries = [...queries].sort(\n    (a, b) => a.state.dataUpdatedAt - b.state.dataUpdatedAt,\n  )\n\n  // clean oldest query\n  if (sortedQueries.length > 0) {\n    const oldestData = sortedQueries.shift()\n    client.clientState.queries = queries.filter((q) => q !== oldestData)\n    return client\n  }\n\n  return undefined\n}\n"],"mappings":";;;;;;;AAkBA,MAAa,qBAAqC,EAAE,sBAAsB;CACxE,MAAM,YAAY,CAAC,GAAG,gBAAgB,YAAY,SAAS;CAC3D,MAAM,UAAU,CAAC,GAAG,gBAAgB,YAAY,OAAO;CACvD,MAAM,SAA0B;EAC9B,GAAG;EACH,aAAa;GAAE;GAAW;EAAQ;CACpC;CAGA,MAAM,gBAAgB,CAAC,GAAG,OAAO,CAAC,CAAC,MAChC,GAAG,MAAM,EAAE,MAAM,gBAAgB,EAAE,MAAM,aAC5C;CAGA,IAAI,cAAc,SAAS,GAAG;EAC5B,MAAM,aAAa,cAAc,MAAM;EACvC,OAAO,YAAY,UAAU,QAAQ,QAAQ,MAAM,MAAM,UAAU;EACnE,OAAO;CACT;AAGF"}