@tanstack/query-async-storage-persister 5.101.3 → 5.102.0

package/build/modern/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/index.ts"],"sourcesContent":["import { asyncThrottle } from './asyncThrottle'\nimport { noop } from './utils'\nimport type {\n  AsyncStorage,\n  MaybePromise,\n  PersistedClient,\n  Persister,\n  Promisable,\n} from '@tanstack/query-persist-client-core'\n\nexport type AsyncPersistRetryer = (props: {\n  persistedClient: PersistedClient\n  error: Error\n  errorCount: number\n}) => Promisable<PersistedClient | undefined>\n\ninterface CreateAsyncStoragePersisterOptions {\n  /** The storage client used for setting and retrieving items from cache.\n   * For SSR pass in `undefined`. Note that window.localStorage can be\n   * `null` in Android WebViews depending on how they are configured.\n   */\n  storage: AsyncStorage<string> | undefined | null\n  /** The key to use when storing the cache */\n  key?: string\n  /** To avoid spamming,\n   * pass a time in ms to throttle saving the cache to disk */\n  throttleTime?: number\n  /**\n   * How to serialize the data to storage.\n   * @default `JSON.stringify`\n   */\n  serialize?: (client: PersistedClient) => MaybePromise<string>\n  /**\n   * How to deserialize the data from storage.\n   * @default `JSON.parse`\n   */\n  deserialize?: (cachedString: string) => MaybePromise<PersistedClient>\n\n  retry?: AsyncPersistRetryer\n}\n\nexport const createAsyncStoragePersister = ({\n  storage,\n  key = `REACT_QUERY_OFFLINE_CACHE`,\n  throttleTime = 1000,\n  serialize = JSON.stringify,\n  deserialize = JSON.parse,\n  retry,\n}: CreateAsyncStoragePersisterOptions): Persister => {\n  if (storage) {\n    const trySave = async (\n      persistedClient: PersistedClient,\n    ): Promise<Error | undefined> => {\n      try {\n        const serialized = await serialize(persistedClient)\n        await storage.setItem(key, serialized)\n        return\n      } catch (error) {\n        return error as Error\n      }\n    }\n\n    return {\n      persistClient: asyncThrottle(\n        async (persistedClient) => {\n          let client: PersistedClient | undefined = persistedClient\n          let error = await trySave(client)\n          let errorCount = 0\n          while (error && client) {\n            errorCount++\n            client = await retry?.({\n              persistedClient: client,\n              error,\n              errorCount,\n            })\n\n            if (client) {\n              error = await trySave(client)\n            }\n          }\n        },\n        { interval: throttleTime },\n      ),\n      restoreClient: async () => {\n        const cacheString = await storage.getItem(key)\n\n        if (!cacheString) {\n          return\n        }\n\n        return await deserialize(cacheString)\n      },\n      removeClient: () => storage.removeItem(key),\n    }\n  }\n\n  return {\n    persistClient: noop,\n    restoreClient: () => Promise.resolve(undefined),\n    removeClient: noop,\n  }\n}\n"],"mappings":";AAAA,SAAS,qBAAqB;AAC9B,SAAS,YAAY;AAwCd,IAAM,8BAA8B,CAAC;AAAA,EAC1C;AAAA,EACA,MAAM;AAAA,EACN,eAAe;AAAA,EACf,YAAY,KAAK;AAAA,EACjB,cAAc,KAAK;AAAA,EACnB;AACF,MAAqD;AACnD,MAAI,SAAS;AACX,UAAM,UAAU,OACd,oBAC+B;AAC/B,UAAI;AACF,cAAM,aAAa,MAAM,UAAU,eAAe;AAClD,cAAM,QAAQ,QAAQ,KAAK,UAAU;AACrC;AAAA,MACF,SAAS,OAAO;AACd,eAAO;AAAA,MACT;AAAA,IACF;AAEA,WAAO;AAAA,MACL,eAAe;AAAA,QACb,OAAO,oBAAoB;AACzB,cAAI,SAAsC;AAC1C,cAAI,QAAQ,MAAM,QAAQ,MAAM;AAChC,cAAI,aAAa;AACjB,iBAAO,SAAS,QAAQ;AACtB;AACA,qBAAS,MAAM,QAAQ;AAAA,cACrB,iBAAiB;AAAA,cACjB;AAAA,cACA;AAAA,YACF,CAAC;AAED,gBAAI,QAAQ;AACV,sBAAQ,MAAM,QAAQ,MAAM;AAAA,YAC9B;AAAA,UACF;AAAA,QACF;AAAA,QACA,EAAE,UAAU,aAAa;AAAA,MAC3B;AAAA,MACA,eAAe,YAAY;AACzB,cAAM,cAAc,MAAM,QAAQ,QAAQ,GAAG;AAE7C,YAAI,CAAC,aAAa;AAChB;AAAA,QACF;AAEA,eAAO,MAAM,YAAY,WAAW;AAAA,MACtC;AAAA,MACA,cAAc,MAAM,QAAQ,WAAW,GAAG;AAAA,IAC5C;AAAA,EACF;AAEA,SAAO;AAAA,IACL,eAAe;AAAA,IACf,eAAe,MAAM,QAAQ,QAAQ,MAAS;AAAA,IAC9C,cAAc;AAAA,EAChB;AACF;","names":[]}
+{"version":3,"file":"index.js","names":[],"sources":["../../src/index.ts"],"sourcesContent":["import { asyncThrottle } from './asyncThrottle'\nimport { noop } from './utils'\nimport type {\n  AsyncStorage,\n  MaybePromise,\n  PersistedClient,\n  Persister,\n  Promisable,\n} from '@tanstack/query-persist-client-core'\n\nexport type AsyncPersistRetryer = (props: {\n  persistedClient: PersistedClient\n  error: Error\n  errorCount: number\n}) => Promisable<PersistedClient | undefined>\n\ninterface CreateAsyncStoragePersisterOptions {\n  /** The storage client used for setting and retrieving items from cache.\n   * For SSR pass in `undefined`. Note that window.localStorage can be\n   * `null` in Android WebViews depending on how they are configured.\n   */\n  storage: AsyncStorage<string> | undefined | null\n  /** The key to use when storing the cache */\n  key?: string\n  /** To avoid spamming,\n   * pass a time in ms to throttle saving the cache to disk */\n  throttleTime?: number\n  /**\n   * How to serialize the data to storage.\n   * @default `JSON.stringify`\n   */\n  serialize?: (client: PersistedClient) => MaybePromise<string>\n  /**\n   * How to deserialize the data from storage.\n   * @default `JSON.parse`\n   */\n  deserialize?: (cachedString: string) => MaybePromise<PersistedClient>\n\n  retry?: AsyncPersistRetryer\n}\n\nexport const createAsyncStoragePersister = ({\n  storage,\n  key = `REACT_QUERY_OFFLINE_CACHE`,\n  throttleTime = 1000,\n  serialize = JSON.stringify,\n  deserialize = JSON.parse,\n  retry,\n}: CreateAsyncStoragePersisterOptions): Persister => {\n  if (storage) {\n    const trySave = async (\n      persistedClient: PersistedClient,\n    ): Promise<Error | undefined> => {\n      try {\n        const serialized = await serialize(persistedClient)\n        await storage.setItem(key, serialized)\n        return\n      } catch (error) {\n        return error as Error\n      }\n    }\n\n    return {\n      persistClient: asyncThrottle(\n        async (persistedClient) => {\n          let client: PersistedClient | undefined = persistedClient\n          let error = await trySave(client)\n          let errorCount = 0\n          while (error && client) {\n            errorCount++\n            client = await retry?.({\n              persistedClient: client,\n              error,\n              errorCount,\n            })\n\n            if (client) {\n              error = await trySave(client)\n            }\n          }\n        },\n        { interval: throttleTime },\n      ),\n      restoreClient: async () => {\n        const cacheString = await storage.getItem(key)\n\n        if (!cacheString) {\n          return\n        }\n\n        return await deserialize(cacheString)\n      },\n      removeClient: () => storage.removeItem(key),\n    }\n  }\n\n  return {\n    persistClient: noop,\n    restoreClient: () => Promise.resolve(undefined),\n    removeClient: noop,\n  }\n}\n"],"mappings":";;;AAyCA,MAAa,+BAA+B,EAC1C,SACA,MAAM,6BACN,eAAe,KACf,YAAY,KAAK,WACjB,cAAc,KAAK,OACnB,YACmD;CACnD,IAAI,SAAS;EACX,MAAM,UAAU,OACd,oBAC+B;GAC/B,IAAI;IACF,MAAM,aAAa,MAAM,UAAU,eAAe;IAClD,MAAM,QAAQ,QAAQ,KAAK,UAAU;IACrC;GACF,SAAS,OAAO;IACd,OAAO;GACT;EACF;EAEA,OAAO;GACL,eAAe,cACb,OAAO,oBAAoB;IACzB,IAAI,SAAsC;IAC1C,IAAI,QAAQ,MAAM,QAAQ,MAAM;IAChC,IAAI,aAAa;IACjB,OAAO,SAAS,QAAQ;KACtB;KACA,SAAS,MAAM,QAAQ;MACrB,iBAAiB;MACjB;MACA;KACF,CAAC;KAED,IAAI,QACF,QAAQ,MAAM,QAAQ,MAAM;IAEhC;GACF,GACA,EAAE,UAAU,aAAa,CAC3B;GACA,eAAe,YAAY;IACzB,MAAM,cAAc,MAAM,QAAQ,QAAQ,GAAG;IAE7C,IAAI,CAAC,aACH;IAGF,OAAO,MAAM,YAAY,WAAW;GACtC;GACA,oBAAoB,QAAQ,WAAW,GAAG;EAC5C;CACF;CAEA,OAAO;EACL,eAAe;EACf,qBAAqB,QAAQ,QAAQ,KAAA,CAAS;EAC9C,cAAc;CAChB;AACF"}

package/build/modern/utils.cjs

@@ -1,32 +1,7 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region src/utils.ts
+function noop() {}
+//#endregion
+exports.noop = noop;
 
-// src/utils.ts
-var utils_exports = {};
-__export(utils_exports, {
-  noop: () => noop
-});
-module.exports = __toCommonJS(utils_exports);
-function noop() {
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  noop
-});
 //# sourceMappingURL=utils.cjs.map

package/build/modern/utils.cjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utils.ts"],"sourcesContent":["export function noop(): void\nexport function noop(): undefined\nexport function noop() {}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAEO,SAAS,OAAO;AAAC;","names":[]}
+{"version":3,"file":"utils.cjs","names":[],"sources":["../../src/utils.ts"],"sourcesContent":["export function noop(): void\nexport function noop(): undefined\nexport function noop() {}\n"],"mappings":";;AAEA,SAAgB,OAAO,CAAC"}

package/build/modern/utils.d.cts

@@ -1 +1,6 @@
-export { noop } from './_tsup-dts-rollup.cjs';
+//#region src/utils.d.ts
+declare function noop(): void;
+declare function noop(): undefined;
+//#endregion
+export { noop };
+//# sourceMappingURL=utils.d.cts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.cts","names":[],"sources":["../../src/utils.ts"],"mappings":";iBAAgB;iBACA"}

package/build/modern/utils.d.ts

@@ -1 +1,6 @@
-export { noop } from './_tsup-dts-rollup.js';
+//#region src/utils.d.ts
+declare function noop(): void;
+declare function noop(): undefined;
+//#endregion
+export { noop };
+//# sourceMappingURL=utils.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","names":[],"sources":["../../src/utils.ts"],"mappings":";iBAAgB;iBACA"}

package/build/modern/utils.js

@@ -1,7 +1,6 @@
-// src/utils.ts
-function noop() {
-}
-export {
-  noop
-};
+//#region src/utils.ts
+function noop() {}
+//#endregion
+export { noop };
+
 //# sourceMappingURL=utils.js.map

package/build/modern/utils.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/utils.ts"],"sourcesContent":["export function noop(): void\nexport function noop(): undefined\nexport function noop() {}\n"],"mappings":";AAEO,SAAS,OAAO;AAAC;","names":[]}
+{"version":3,"file":"utils.js","names":[],"sources":["../../src/utils.ts"],"sourcesContent":["export function noop(): void\nexport function noop(): undefined\nexport function noop() {}\n"],"mappings":";AAEA,SAAgB,OAAO,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tanstack/query-async-storage-persister",
-  "version": "5.101.3",
+  "version": "5.102.0",
   "description": "A persister for asynchronous storages, to be used with TanStack/Query",
   "author": "tannerlinsley",
   "license": "MIT",
@@ -40,8 +40,8 @@
     "!src/__tests__"
   ],
   "dependencies": {
-    "@tanstack/query-core": "5.101.3",
-    "@tanstack/query-persist-client-core": "5.101.3"
+    "@tanstack/query-core": "5.102.0",
+    "@tanstack/query-persist-client-core": "5.102.0"
   },
   "devDependencies": {
     "npm-run-all2": "^5.0.0",
@@ -52,17 +52,15 @@
     "compile": "tsc --build",
     "test:eslint": "eslint --concurrency=auto ./src",
     "test:types": "npm-run-all --serial test:types:*",
-    "test:types:ts54": "node ../../node_modules/typescript54/lib/tsc.js --build",
-    "test:types:ts55": "node ../../node_modules/typescript55/lib/tsc.js --build",
     "test:types:ts56": "node ../../node_modules/typescript56/lib/tsc.js --build",
     "test:types:ts57": "node ../../node_modules/typescript57/lib/tsc.js --build",
     "test:types:ts58": "node ../../node_modules/typescript58/lib/tsc.js --build",
     "test:types:ts59": "node ../../node_modules/typescript59/lib/tsc.js --build",
     "test:types:tscurrent": "tsc --build",
-    "test:types:ts60": "node ../../node_modules/typescript60/lib/tsc.js --build",
+    "test:types:ts70": "node ../../node_modules/typescript70/lib/tsc.js --build",
     "test:lib": "vitest",
     "test:lib:dev": "pnpm run test:lib --watch",
     "test:build": "publint --strict && attw --pack",
-    "build": "tsup --tsconfig tsconfig.prod.json"
+    "build": "tsdown --tsconfig tsconfig.prod.json"
   }
 }

package/build/legacy/_tsup-dts-rollup.d.cts

@@ -1,50 +0,0 @@
-import type { AsyncStorage } from '@tanstack/query-persist-client-core';
-import type { MaybePromise } from '@tanstack/query-persist-client-core';
-import type { PersistedClient } from '@tanstack/query-persist-client-core';
-import type { Persister } from '@tanstack/query-persist-client-core';
-import type { Promisable } from '@tanstack/query-persist-client-core';
-
-export declare type AsyncPersistRetryer = (props: {
-    persistedClient: PersistedClient;
-    error: Error;
-    errorCount: number;
-}) => Promisable<PersistedClient | undefined>;
-
-export declare function asyncThrottle<TArgs extends ReadonlyArray<unknown>>(func: (...args: TArgs) => Promise<void>, { interval, onError }?: AsyncThrottleOptions): (...args: TArgs) => Promise<void>;
-
-declare interface AsyncThrottleOptions {
-    interval?: number;
-    onError?: (error: unknown) => void;
-}
-
-export declare const createAsyncStoragePersister: ({ storage, key, throttleTime, serialize, deserialize, retry, }: CreateAsyncStoragePersisterOptions) => Persister;
-
-declare interface CreateAsyncStoragePersisterOptions {
-    /** The storage client used for setting and retrieving items from cache.
-     * For SSR pass in `undefined`. Note that window.localStorage can be
-     * `null` in Android WebViews depending on how they are configured.
-     */
-    storage: AsyncStorage<string> | undefined | null;
-    /** The key to use when storing the cache */
-    key?: string;
-    /** To avoid spamming,
-     * pass a time in ms to throttle saving the cache to disk */
-    throttleTime?: number;
-    /**
-     * How to serialize the data to storage.
-     * @default `JSON.stringify`
-     */
-    serialize?: (client: PersistedClient) => MaybePromise<string>;
-    /**
-     * How to deserialize the data from storage.
-     * @default `JSON.parse`
-     */
-    deserialize?: (cachedString: string) => MaybePromise<PersistedClient>;
-    retry?: AsyncPersistRetryer;
-}
-
-export declare function noop(): void;
-
-export declare function noop(): undefined;
-
-export { }

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

@@ -1,50 +0,0 @@
-import type { AsyncStorage } from '@tanstack/query-persist-client-core';
-import type { MaybePromise } from '@tanstack/query-persist-client-core';
-import type { PersistedClient } from '@tanstack/query-persist-client-core';
-import type { Persister } from '@tanstack/query-persist-client-core';
-import type { Promisable } from '@tanstack/query-persist-client-core';
-
-export declare type AsyncPersistRetryer = (props: {
-    persistedClient: PersistedClient;
-    error: Error;
-    errorCount: number;
-}) => Promisable<PersistedClient | undefined>;
-
-export declare function asyncThrottle<TArgs extends ReadonlyArray<unknown>>(func: (...args: TArgs) => Promise<void>, { interval, onError }?: AsyncThrottleOptions): (...args: TArgs) => Promise<void>;
-
-declare interface AsyncThrottleOptions {
-    interval?: number;
-    onError?: (error: unknown) => void;
-}
-
-export declare const createAsyncStoragePersister: ({ storage, key, throttleTime, serialize, deserialize, retry, }: CreateAsyncStoragePersisterOptions) => Persister;
-
-declare interface CreateAsyncStoragePersisterOptions {
-    /** The storage client used for setting and retrieving items from cache.
-     * For SSR pass in `undefined`. Note that window.localStorage can be
-     * `null` in Android WebViews depending on how they are configured.
-     */
-    storage: AsyncStorage<string> | undefined | null;
-    /** The key to use when storing the cache */
-    key?: string;
-    /** To avoid spamming,
-     * pass a time in ms to throttle saving the cache to disk */
-    throttleTime?: number;
-    /**
-     * How to serialize the data to storage.
-     * @default `JSON.stringify`
-     */
-    serialize?: (client: PersistedClient) => MaybePromise<string>;
-    /**
-     * How to deserialize the data from storage.
-     * @default `JSON.parse`
-     */
-    deserialize?: (cachedString: string) => MaybePromise<PersistedClient>;
-    retry?: AsyncPersistRetryer;
-}
-
-export declare function noop(): void;
-
-export declare function noop(): undefined;
-
-export { }

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

@@ -1,50 +0,0 @@
-import type { AsyncStorage } from '@tanstack/query-persist-client-core';
-import type { MaybePromise } from '@tanstack/query-persist-client-core';
-import type { PersistedClient } from '@tanstack/query-persist-client-core';
-import type { Persister } from '@tanstack/query-persist-client-core';
-import type { Promisable } from '@tanstack/query-persist-client-core';
-
-export declare type AsyncPersistRetryer = (props: {
-    persistedClient: PersistedClient;
-    error: Error;
-    errorCount: number;
-}) => Promisable<PersistedClient | undefined>;
-
-export declare function asyncThrottle<TArgs extends ReadonlyArray<unknown>>(func: (...args: TArgs) => Promise<void>, { interval, onError }?: AsyncThrottleOptions): (...args: TArgs) => Promise<void>;
-
-declare interface AsyncThrottleOptions {
-    interval?: number;
-    onError?: (error: unknown) => void;
-}
-
-export declare const createAsyncStoragePersister: ({ storage, key, throttleTime, serialize, deserialize, retry, }: CreateAsyncStoragePersisterOptions) => Persister;
-
-declare interface CreateAsyncStoragePersisterOptions {
-    /** The storage client used for setting and retrieving items from cache.
-     * For SSR pass in `undefined`. Note that window.localStorage can be
-     * `null` in Android WebViews depending on how they are configured.
-     */
-    storage: AsyncStorage<string> | undefined | null;
-    /** The key to use when storing the cache */
-    key?: string;
-    /** To avoid spamming,
-     * pass a time in ms to throttle saving the cache to disk */
-    throttleTime?: number;
-    /**
-     * How to serialize the data to storage.
-     * @default `JSON.stringify`
-     */
-    serialize?: (client: PersistedClient) => MaybePromise<string>;
-    /**
-     * How to deserialize the data from storage.
-     * @default `JSON.parse`
-     */
-    deserialize?: (cachedString: string) => MaybePromise<PersistedClient>;
-    retry?: AsyncPersistRetryer;
-}
-
-export declare function noop(): void;
-
-export declare function noop(): undefined;
-
-export { }

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

@@ -1,50 +0,0 @@
-import type { AsyncStorage } from '@tanstack/query-persist-client-core';
-import type { MaybePromise } from '@tanstack/query-persist-client-core';
-import type { PersistedClient } from '@tanstack/query-persist-client-core';
-import type { Persister } from '@tanstack/query-persist-client-core';
-import type { Promisable } from '@tanstack/query-persist-client-core';
-
-export declare type AsyncPersistRetryer = (props: {
-    persistedClient: PersistedClient;
-    error: Error;
-    errorCount: number;
-}) => Promisable<PersistedClient | undefined>;
-
-export declare function asyncThrottle<TArgs extends ReadonlyArray<unknown>>(func: (...args: TArgs) => Promise<void>, { interval, onError }?: AsyncThrottleOptions): (...args: TArgs) => Promise<void>;
-
-declare interface AsyncThrottleOptions {
-    interval?: number;
-    onError?: (error: unknown) => void;
-}
-
-export declare const createAsyncStoragePersister: ({ storage, key, throttleTime, serialize, deserialize, retry, }: CreateAsyncStoragePersisterOptions) => Persister;
-
-declare interface CreateAsyncStoragePersisterOptions {
-    /** The storage client used for setting and retrieving items from cache.
-     * For SSR pass in `undefined`. Note that window.localStorage can be
-     * `null` in Android WebViews depending on how they are configured.
-     */
-    storage: AsyncStorage<string> | undefined | null;
-    /** The key to use when storing the cache */
-    key?: string;
-    /** To avoid spamming,
-     * pass a time in ms to throttle saving the cache to disk */
-    throttleTime?: number;
-    /**
-     * How to serialize the data to storage.
-     * @default `JSON.stringify`
-     */
-    serialize?: (client: PersistedClient) => MaybePromise<string>;
-    /**
-     * How to deserialize the data from storage.
-     * @default `JSON.parse`
-     */
-    deserialize?: (cachedString: string) => MaybePromise<PersistedClient>;
-    retry?: AsyncPersistRetryer;
-}
-
-export declare function noop(): void;
-
-export declare function noop(): undefined;
-
-export { }