@tanstack/query-sync-storage-persister 4.0.0

package/build/cjs/index.js

@@ -0,0 +1,92 @@
+/**
+ * query-sync-storage-persister
+ *
+ * Copyright (c) TanStack
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE.md file in the root directory of this source tree.
+ *
+ * @license MIT
+ */
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+function createSyncStoragePersister({
+  storage,
+  key = "REACT_QUERY_OFFLINE_CACHE",
+  throttleTime = 1000,
+  serialize = JSON.stringify,
+  deserialize = JSON.parse,
+  retry
+}) {
+  if (typeof storage !== 'undefined') {
+    const trySave = persistedClient => {
+      try {
+        storage.setItem(key, serialize(persistedClient));
+      } catch (error) {
+        return error;
+      }
+    };
+
+    return {
+      persistClient: throttle(persistedClient => {
+        let client = persistedClient;
+        let error = trySave(client);
+        let errorCount = 0;
+
+        while (error && client) {
+          errorCount++;
+          client = retry == null ? void 0 : retry({
+            persistedClient: client,
+            error,
+            errorCount
+          });
+
+          if (client) {
+            error = trySave(client);
+          }
+        }
+      }, throttleTime),
+      restoreClient: () => {
+        const cacheString = storage.getItem(key);
+
+        if (!cacheString) {
+          return;
+        }
+
+        return deserialize(cacheString);
+      },
+      removeClient: () => {
+        storage.removeItem(key);
+      }
+    };
+  }
+
+  return {
+    persistClient: noop,
+    restoreClient: () => undefined,
+    removeClient: noop
+  };
+}
+
+function throttle(func, wait = 100) {
+  let timer = null;
+  let params;
+  return function (...args) {
+    params = args;
+
+    if (timer === null) {
+      timer = setTimeout(() => {
+        func(...params);
+        timer = null;
+      }, wait);
+    }
+  };
+} // eslint-disable-next-line @typescript-eslint/no-empty-function
+
+
+function noop() {}
+
+exports.createSyncStoragePersister = createSyncStoragePersister;
+//# sourceMappingURL=index.js.map

package/build/cjs/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../src/index.ts"],"sourcesContent":["import {\n  PersistedClient,\n  Persister,\n  PersistRetryer,\n} from '@tanstack/react-query-persist-client'\n\ninterface Storage {\n  getItem: (key: string) => string | null\n  setItem: (key: string, value: string) => void\n  removeItem: (key: string) => void\n}\n\ninterface CreateSyncStoragePersisterOptions {\n  /** The storage client used for setting and retrieving items from cache.\n   * For SSR pass in `undefined`.\n   */\n  storage: Storage | undefined\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) => string\n  /**\n   * How to deserialize the data from storage.\n   * @default `JSON.parse`\n   */\n  deserialize?: (cachedString: string) => PersistedClient\n\n  retry?: PersistRetryer\n}\n\nexport function createSyncStoragePersister({\n  storage,\n  key = `REACT_QUERY_OFFLINE_CACHE`,\n  throttleTime = 1000,\n  serialize = JSON.stringify,\n  deserialize = JSON.parse,\n  retry,\n}: CreateSyncStoragePersisterOptions): Persister {\n  if (typeof storage !== 'undefined') {\n    const trySave = (persistedClient: PersistedClient): Error | undefined => {\n      try {\n        storage.setItem(key, serialize(persistedClient))\n      } catch (error) {\n        return error as Error\n      }\n    }\n    return {\n      persistClient: throttle((persistedClient) => {\n        let client: PersistedClient | undefined = persistedClient\n        let error = trySave(client)\n        let errorCount = 0\n        while (error && client) {\n          errorCount++\n          client = retry?.({\n            persistedClient: client,\n            error,\n            errorCount,\n          })\n\n          if (client) {\n            error = trySave(client)\n          }\n        }\n      }, throttleTime),\n      restoreClient: () => {\n        const cacheString = storage.getItem(key)\n\n        if (!cacheString) {\n          return\n        }\n\n        return deserialize(cacheString) as PersistedClient\n      },\n      removeClient: () => {\n        storage.removeItem(key)\n      },\n    }\n  }\n\n  return {\n    persistClient: noop,\n    restoreClient: () => undefined,\n    removeClient: noop,\n  }\n}\n\nfunction throttle<TArgs extends any[]>(\n  func: (...args: TArgs) => any,\n  wait = 100,\n) {\n  let timer: ReturnType<typeof setTimeout> | null = null\n  let params: TArgs\n  return function (...args: TArgs) {\n    params = args\n    if (timer === null) {\n      timer = setTimeout(() => {\n        func(...params)\n        timer = null\n      }, wait)\n    }\n  }\n}\n\n// eslint-disable-next-line @typescript-eslint/no-empty-function\nfunction noop() {}\n"],"names":["createSyncStoragePersister","storage","key","throttleTime","serialize","JSON","stringify","deserialize","parse","retry","trySave","persistedClient","setItem","error","persistClient","throttle","client","errorCount","restoreClient","cacheString","getItem","removeClient","removeItem","noop","undefined","func","wait","timer","params","args","setTimeout"],"mappings":";;;;;;;;;;;;;;AAoCO,SAASA,0BAAT,CAAoC;EACzCC,OADyC;AAEzCC,EAAAA,GAAG,GAFsC,2BAAA;AAGzCC,EAAAA,YAAY,GAAG,IAH0B;EAIzCC,SAAS,GAAGC,IAAI,CAACC,SAJwB;EAKzCC,WAAW,GAAGF,IAAI,CAACG,KALsB;AAMzCC,EAAAA,KAAAA;AANyC,CAApC,EAO0C;AAC/C,EAAA,IAAI,OAAOR,OAAP,KAAmB,WAAvB,EAAoC;IAClC,MAAMS,OAAO,GAAIC,eAAD,IAAyD;MACvE,IAAI;QACFV,OAAO,CAACW,OAAR,CAAgBV,GAAhB,EAAqBE,SAAS,CAACO,eAAD,CAA9B,CAAA,CAAA;OADF,CAEE,OAAOE,KAAP,EAAc;AACd,QAAA,OAAOA,KAAP,CAAA;AACD,OAAA;KALH,CAAA;;IAOA,OAAO;AACLC,MAAAA,aAAa,EAAEC,QAAQ,CAAEJ,eAAD,IAAqB;QAC3C,IAAIK,MAAmC,GAAGL,eAA1C,CAAA;AACA,QAAA,IAAIE,KAAK,GAAGH,OAAO,CAACM,MAAD,CAAnB,CAAA;QACA,IAAIC,UAAU,GAAG,CAAjB,CAAA;;QACA,OAAOJ,KAAK,IAAIG,MAAhB,EAAwB;UACtBC,UAAU,EAAA,CAAA;AACVD,UAAAA,MAAM,GAAGP,KAAH,IAAGA,IAAAA,GAAAA,KAAAA,CAAAA,GAAAA,KAAK,CAAG;AACfE,YAAAA,eAAe,EAAEK,MADF;YAEfH,KAFe;AAGfI,YAAAA,UAAAA;AAHe,WAAH,CAAd,CAAA;;AAMA,UAAA,IAAID,MAAJ,EAAY;AACVH,YAAAA,KAAK,GAAGH,OAAO,CAACM,MAAD,CAAf,CAAA;AACD,WAAA;AACF,SAAA;OAfoB,EAgBpBb,YAhBoB,CADlB;AAkBLe,MAAAA,aAAa,EAAE,MAAM;AACnB,QAAA,MAAMC,WAAW,GAAGlB,OAAO,CAACmB,OAAR,CAAgBlB,GAAhB,CAApB,CAAA;;QAEA,IAAI,CAACiB,WAAL,EAAkB;AAChB,UAAA,OAAA;AACD,SAAA;;QAED,OAAOZ,WAAW,CAACY,WAAD,CAAlB,CAAA;OAzBG;AA2BLE,MAAAA,YAAY,EAAE,MAAM;QAClBpB,OAAO,CAACqB,UAAR,CAAmBpB,GAAnB,CAAA,CAAA;AACD,OAAA;KA7BH,CAAA;AA+BD,GAAA;;EAED,OAAO;AACLY,IAAAA,aAAa,EAAES,IADV;IAELL,aAAa,EAAE,MAAMM,SAFhB;AAGLH,IAAAA,YAAY,EAAEE,IAAAA;GAHhB,CAAA;AAKD,CAAA;;AAED,SAASR,QAAT,CACEU,IADF,EAEEC,IAAI,GAAG,GAFT,EAGE;EACA,IAAIC,KAA2C,GAAG,IAAlD,CAAA;AACA,EAAA,IAAIC,MAAJ,CAAA;EACA,OAAO,UAAU,GAAGC,IAAb,EAA0B;AAC/BD,IAAAA,MAAM,GAAGC,IAAT,CAAA;;IACA,IAAIF,KAAK,KAAK,IAAd,EAAoB;MAClBA,KAAK,GAAGG,UAAU,CAAC,MAAM;QACvBL,IAAI,CAAC,GAAGG,MAAJ,CAAJ,CAAA;AACAD,QAAAA,KAAK,GAAG,IAAR,CAAA;OAFgB,EAGfD,IAHe,CAAlB,CAAA;AAID,KAAA;GAPH,CAAA;AASD;;;AAGD,SAASH,IAAT,GAAgB;;;;"}

package/build/esm/index.js

@@ -0,0 +1,88 @@
+/**
+ * query-sync-storage-persister
+ *
+ * Copyright (c) TanStack
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE.md file in the root directory of this source tree.
+ *
+ * @license MIT
+ */
+function createSyncStoragePersister({
+  storage,
+  key = "REACT_QUERY_OFFLINE_CACHE",
+  throttleTime = 1000,
+  serialize = JSON.stringify,
+  deserialize = JSON.parse,
+  retry
+}) {
+  if (typeof storage !== 'undefined') {
+    const trySave = persistedClient => {
+      try {
+        storage.setItem(key, serialize(persistedClient));
+      } catch (error) {
+        return error;
+      }
+    };
+
+    return {
+      persistClient: throttle(persistedClient => {
+        let client = persistedClient;
+        let error = trySave(client);
+        let errorCount = 0;
+
+        while (error && client) {
+          errorCount++;
+          client = retry == null ? void 0 : retry({
+            persistedClient: client,
+            error,
+            errorCount
+          });
+
+          if (client) {
+            error = trySave(client);
+          }
+        }
+      }, throttleTime),
+      restoreClient: () => {
+        const cacheString = storage.getItem(key);
+
+        if (!cacheString) {
+          return;
+        }
+
+        return deserialize(cacheString);
+      },
+      removeClient: () => {
+        storage.removeItem(key);
+      }
+    };
+  }
+
+  return {
+    persistClient: noop,
+    restoreClient: () => undefined,
+    removeClient: noop
+  };
+}
+
+function throttle(func, wait = 100) {
+  let timer = null;
+  let params;
+  return function (...args) {
+    params = args;
+
+    if (timer === null) {
+      timer = setTimeout(() => {
+        func(...params);
+        timer = null;
+      }, wait);
+    }
+  };
+} // eslint-disable-next-line @typescript-eslint/no-empty-function
+
+
+function noop() {}
+
+export { createSyncStoragePersister };
+//# sourceMappingURL=index.js.map

package/build/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../src/index.ts"],"sourcesContent":["import {\n  PersistedClient,\n  Persister,\n  PersistRetryer,\n} from '@tanstack/react-query-persist-client'\n\ninterface Storage {\n  getItem: (key: string) => string | null\n  setItem: (key: string, value: string) => void\n  removeItem: (key: string) => void\n}\n\ninterface CreateSyncStoragePersisterOptions {\n  /** The storage client used for setting and retrieving items from cache.\n   * For SSR pass in `undefined`.\n   */\n  storage: Storage | undefined\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) => string\n  /**\n   * How to deserialize the data from storage.\n   * @default `JSON.parse`\n   */\n  deserialize?: (cachedString: string) => PersistedClient\n\n  retry?: PersistRetryer\n}\n\nexport function createSyncStoragePersister({\n  storage,\n  key = `REACT_QUERY_OFFLINE_CACHE`,\n  throttleTime = 1000,\n  serialize = JSON.stringify,\n  deserialize = JSON.parse,\n  retry,\n}: CreateSyncStoragePersisterOptions): Persister {\n  if (typeof storage !== 'undefined') {\n    const trySave = (persistedClient: PersistedClient): Error | undefined => {\n      try {\n        storage.setItem(key, serialize(persistedClient))\n      } catch (error) {\n        return error as Error\n      }\n    }\n    return {\n      persistClient: throttle((persistedClient) => {\n        let client: PersistedClient | undefined = persistedClient\n        let error = trySave(client)\n        let errorCount = 0\n        while (error && client) {\n          errorCount++\n          client = retry?.({\n            persistedClient: client,\n            error,\n            errorCount,\n          })\n\n          if (client) {\n            error = trySave(client)\n          }\n        }\n      }, throttleTime),\n      restoreClient: () => {\n        const cacheString = storage.getItem(key)\n\n        if (!cacheString) {\n          return\n        }\n\n        return deserialize(cacheString) as PersistedClient\n      },\n      removeClient: () => {\n        storage.removeItem(key)\n      },\n    }\n  }\n\n  return {\n    persistClient: noop,\n    restoreClient: () => undefined,\n    removeClient: noop,\n  }\n}\n\nfunction throttle<TArgs extends any[]>(\n  func: (...args: TArgs) => any,\n  wait = 100,\n) {\n  let timer: ReturnType<typeof setTimeout> | null = null\n  let params: TArgs\n  return function (...args: TArgs) {\n    params = args\n    if (timer === null) {\n      timer = setTimeout(() => {\n        func(...params)\n        timer = null\n      }, wait)\n    }\n  }\n}\n\n// eslint-disable-next-line @typescript-eslint/no-empty-function\nfunction noop() {}\n"],"names":["createSyncStoragePersister","storage","key","throttleTime","serialize","JSON","stringify","deserialize","parse","retry","trySave","persistedClient","setItem","error","persistClient","throttle","client","errorCount","restoreClient","cacheString","getItem","removeClient","removeItem","noop","undefined","func","wait","timer","params","args","setTimeout"],"mappings":";;;;;;;;;;AAoCO,SAASA,0BAAT,CAAoC;EACzCC,OADyC;AAEzCC,EAAAA,GAAG,GAFsC,2BAAA;AAGzCC,EAAAA,YAAY,GAAG,IAH0B;EAIzCC,SAAS,GAAGC,IAAI,CAACC,SAJwB;EAKzCC,WAAW,GAAGF,IAAI,CAACG,KALsB;AAMzCC,EAAAA,KAAAA;AANyC,CAApC,EAO0C;AAC/C,EAAA,IAAI,OAAOR,OAAP,KAAmB,WAAvB,EAAoC;IAClC,MAAMS,OAAO,GAAIC,eAAD,IAAyD;MACvE,IAAI;QACFV,OAAO,CAACW,OAAR,CAAgBV,GAAhB,EAAqBE,SAAS,CAACO,eAAD,CAA9B,CAAA,CAAA;OADF,CAEE,OAAOE,KAAP,EAAc;AACd,QAAA,OAAOA,KAAP,CAAA;AACD,OAAA;KALH,CAAA;;IAOA,OAAO;AACLC,MAAAA,aAAa,EAAEC,QAAQ,CAAEJ,eAAD,IAAqB;QAC3C,IAAIK,MAAmC,GAAGL,eAA1C,CAAA;AACA,QAAA,IAAIE,KAAK,GAAGH,OAAO,CAACM,MAAD,CAAnB,CAAA;QACA,IAAIC,UAAU,GAAG,CAAjB,CAAA;;QACA,OAAOJ,KAAK,IAAIG,MAAhB,EAAwB;UACtBC,UAAU,EAAA,CAAA;AACVD,UAAAA,MAAM,GAAGP,KAAH,IAAGA,IAAAA,GAAAA,KAAAA,CAAAA,GAAAA,KAAK,CAAG;AACfE,YAAAA,eAAe,EAAEK,MADF;YAEfH,KAFe;AAGfI,YAAAA,UAAAA;AAHe,WAAH,CAAd,CAAA;;AAMA,UAAA,IAAID,MAAJ,EAAY;AACVH,YAAAA,KAAK,GAAGH,OAAO,CAACM,MAAD,CAAf,CAAA;AACD,WAAA;AACF,SAAA;OAfoB,EAgBpBb,YAhBoB,CADlB;AAkBLe,MAAAA,aAAa,EAAE,MAAM;AACnB,QAAA,MAAMC,WAAW,GAAGlB,OAAO,CAACmB,OAAR,CAAgBlB,GAAhB,CAApB,CAAA;;QAEA,IAAI,CAACiB,WAAL,EAAkB;AAChB,UAAA,OAAA;AACD,SAAA;;QAED,OAAOZ,WAAW,CAACY,WAAD,CAAlB,CAAA;OAzBG;AA2BLE,MAAAA,YAAY,EAAE,MAAM;QAClBpB,OAAO,CAACqB,UAAR,CAAmBpB,GAAnB,CAAA,CAAA;AACD,OAAA;KA7BH,CAAA;AA+BD,GAAA;;EAED,OAAO;AACLY,IAAAA,aAAa,EAAES,IADV;IAELL,aAAa,EAAE,MAAMM,SAFhB;AAGLH,IAAAA,YAAY,EAAEE,IAAAA;GAHhB,CAAA;AAKD,CAAA;;AAED,SAASR,QAAT,CACEU,IADF,EAEEC,IAAI,GAAG,GAFT,EAGE;EACA,IAAIC,KAA2C,GAAG,IAAlD,CAAA;AACA,EAAA,IAAIC,MAAJ,CAAA;EACA,OAAO,UAAU,GAAGC,IAAb,EAA0B;AAC/BD,IAAAA,MAAM,GAAGC,IAAT,CAAA;;IACA,IAAIF,KAAK,KAAK,IAAd,EAAoB;MAClBA,KAAK,GAAGG,UAAU,CAAC,MAAM;QACvBL,IAAI,CAAC,GAAGG,MAAJ,CAAJ,CAAA;AACAD,QAAAA,KAAK,GAAG,IAAR,CAAA;OAFgB,EAGfD,IAHe,CAAlB,CAAA;AAID,KAAA;GAPH,CAAA;AASD;;;AAGD,SAASH,IAAT,GAAgB;;;;"}