@tanstack/query-persist-client-core 5.76.0 → 5.76.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -21,12 +21,12 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
21
21
  var createPersister_exports = {};
22
22
  __export(createPersister_exports, {
23
23
  PERSISTER_KEY_PREFIX: () => PERSISTER_KEY_PREFIX,
24
- experimental_createPersister: () => experimental_createPersister
24
+ experimental_createQueryPersister: () => experimental_createQueryPersister
25
25
  });
26
26
  module.exports = __toCommonJS(createPersister_exports);
27
27
  var import_query_core = require("@tanstack/query-core");
28
28
  var PERSISTER_KEY_PREFIX = "tanstack-query";
29
- function experimental_createPersister({
29
+ function experimental_createQueryPersister({
30
30
  storage,
31
31
  buster = "",
32
32
  maxAge = 1e3 * 60 * 60 * 24,
@@ -35,34 +35,32 @@ function experimental_createPersister({
35
35
  prefix = PERSISTER_KEY_PREFIX,
36
36
  filters
37
37
  }) {
38
- return async function persisterFn(queryFn, context, query) {
39
- const storageKey = `${prefix}-${query.queryHash}`;
40
- const matchesFilter = filters ? (0, import_query_core.matchQuery)(filters, query) : true;
41
- if (matchesFilter && query.state.data === void 0 && storage != null) {
38
+ function isExpiredOrBusted(persistedQuery) {
39
+ if (persistedQuery.state.dataUpdatedAt) {
40
+ const queryAge = Date.now() - persistedQuery.state.dataUpdatedAt;
41
+ const expired = queryAge > maxAge;
42
+ const busted = persistedQuery.buster !== buster;
43
+ if (expired || busted) {
44
+ return true;
45
+ }
46
+ return false;
47
+ }
48
+ return true;
49
+ }
50
+ async function retrieveQuery(queryHash, afterRestoreMacroTask) {
51
+ if (storage != null) {
52
+ const storageKey = `${prefix}-${queryHash}`;
42
53
  try {
43
54
  const storedData = await storage.getItem(storageKey);
44
55
  if (storedData) {
45
56
  const persistedQuery = await deserialize(storedData);
46
- if (persistedQuery.state.dataUpdatedAt) {
47
- const queryAge = Date.now() - persistedQuery.state.dataUpdatedAt;
48
- const expired = queryAge > maxAge;
49
- const busted = persistedQuery.buster !== buster;
50
- if (expired || busted) {
51
- await storage.removeItem(storageKey);
52
- } else {
53
- setTimeout(() => {
54
- query.setState({
55
- dataUpdatedAt: persistedQuery.state.dataUpdatedAt,
56
- errorUpdatedAt: persistedQuery.state.errorUpdatedAt
57
- });
58
- if (query.isStale()) {
59
- query.fetch();
60
- }
61
- }, 0);
62
- return Promise.resolve(persistedQuery.state.data);
63
- }
64
- } else {
57
+ if (isExpiredOrBusted(persistedQuery)) {
65
58
  await storage.removeItem(storageKey);
59
+ } else {
60
+ if (afterRestoreMacroTask) {
61
+ setTimeout(() => afterRestoreMacroTask(persistedQuery), 0);
62
+ }
63
+ return persistedQuery.state.data;
66
64
  }
67
65
  }
68
66
  } catch (err) {
@@ -75,26 +73,118 @@ function experimental_createPersister({
75
73
  await storage.removeItem(storageKey);
76
74
  }
77
75
  }
78
- const queryFnResult = await queryFn(context);
76
+ return;
77
+ }
78
+ async function persistQueryByKey(queryKey, queryClient) {
79
+ if (storage != null) {
80
+ const query = queryClient.getQueryCache().find({ queryKey });
81
+ if (query) {
82
+ await persistQuery(query);
83
+ } else {
84
+ if (process.env.NODE_ENV === "development") {
85
+ console.warn(
86
+ "Could not find query to be persisted. QueryKey:",
87
+ JSON.stringify(queryKey)
88
+ );
89
+ }
90
+ }
91
+ }
92
+ }
93
+ async function persistQuery(query) {
94
+ if (storage != null) {
95
+ const storageKey = `${prefix}-${query.queryHash}`;
96
+ storage.setItem(
97
+ storageKey,
98
+ await serialize({
99
+ state: query.state,
100
+ queryKey: query.queryKey,
101
+ queryHash: query.queryHash,
102
+ buster
103
+ })
104
+ );
105
+ }
106
+ }
107
+ async function persisterFn(queryFn, ctx, query) {
108
+ const matchesFilter = filters ? (0, import_query_core.matchQuery)(filters, query) : true;
109
+ if (matchesFilter && query.state.data === void 0 && storage != null) {
110
+ const restoredData = await retrieveQuery(
111
+ query.queryHash,
112
+ (persistedQuery) => {
113
+ query.setState({
114
+ dataUpdatedAt: persistedQuery.state.dataUpdatedAt,
115
+ errorUpdatedAt: persistedQuery.state.errorUpdatedAt
116
+ });
117
+ if (query.isStale()) {
118
+ query.fetch();
119
+ }
120
+ }
121
+ );
122
+ if (restoredData != null) {
123
+ return Promise.resolve(restoredData);
124
+ }
125
+ }
126
+ const queryFnResult = await queryFn(ctx);
79
127
  if (matchesFilter && storage != null) {
80
- setTimeout(async () => {
81
- storage.setItem(
82
- storageKey,
83
- await serialize({
84
- state: query.state,
85
- queryKey: query.queryKey,
86
- queryHash: query.queryHash,
87
- buster
88
- })
89
- );
128
+ setTimeout(() => {
129
+ persistQuery(query);
90
130
  }, 0);
91
131
  }
92
132
  return Promise.resolve(queryFnResult);
133
+ }
134
+ async function persisterGc() {
135
+ if (storage == null ? void 0 : storage.entries) {
136
+ const entries = await storage.entries();
137
+ for (const [key, value] of entries) {
138
+ if (key.startsWith(prefix)) {
139
+ const persistedQuery = await deserialize(value);
140
+ if (isExpiredOrBusted(persistedQuery)) {
141
+ await storage.removeItem(key);
142
+ }
143
+ }
144
+ }
145
+ } else if (process.env.NODE_ENV === "development") {
146
+ throw new Error(
147
+ "Provided storage does not implement `entries` method. Garbage collection is not possible without ability to iterate over storage items."
148
+ );
149
+ }
150
+ }
151
+ async function persisterRestoreAll(queryClient) {
152
+ if (storage == null ? void 0 : storage.entries) {
153
+ const entries = await storage.entries();
154
+ for (const [key, value] of entries) {
155
+ if (key.startsWith(prefix)) {
156
+ const persistedQuery = await deserialize(value);
157
+ if (isExpiredOrBusted(persistedQuery)) {
158
+ await storage.removeItem(key);
159
+ } else {
160
+ queryClient.setQueryData(
161
+ persistedQuery.queryKey,
162
+ persistedQuery.state.data,
163
+ {
164
+ updatedAt: persistedQuery.state.dataUpdatedAt
165
+ }
166
+ );
167
+ }
168
+ }
169
+ }
170
+ } else if (process.env.NODE_ENV === "development") {
171
+ throw new Error(
172
+ "Provided storage does not implement `entries` method. Restoration of all stored entries is not possible without ability to iterate over storage items."
173
+ );
174
+ }
175
+ }
176
+ return {
177
+ persisterFn,
178
+ persistQuery,
179
+ persistQueryByKey,
180
+ retrieveQuery,
181
+ persisterGc,
182
+ persisterRestoreAll
93
183
  };
94
184
  }
95
185
  // Annotate the CommonJS export names for ESM import in node:
96
186
  0 && (module.exports = {
97
187
  PERSISTER_KEY_PREFIX,
98
- experimental_createPersister
188
+ experimental_createQueryPersister
99
189
  });
100
190
  //# sourceMappingURL=createPersister.cjs.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/createPersister.ts"],"sourcesContent":["import { matchQuery } from '@tanstack/query-core'\nimport type {\n Query,\n QueryFilters,\n QueryFunctionContext,\n QueryKey,\n QueryState,\n} from '@tanstack/query-core'\n\nexport interface PersistedQuery {\n buster: string\n queryHash: string\n queryKey: QueryKey\n state: QueryState\n}\n\nexport type MaybePromise<T> = T | Promise<T>\n\nexport interface AsyncStorage<TStorageValue = string> {\n getItem: (key: string) => MaybePromise<TStorageValue | undefined | null>\n setItem: (key: string, value: TStorageValue) => MaybePromise<unknown>\n removeItem: (key: string) => MaybePromise<void>\n}\n\nexport interface StoragePersisterOptions<TStorageValue = string> {\n /** The storage client used for setting and retrieving items from cache.\n * For SSR pass in `undefined`.\n */\n storage: AsyncStorage<TStorageValue> | undefined | null\n /**\n * How to serialize the data to storage.\n * @default `JSON.stringify`\n */\n serialize?: (persistedQuery: PersistedQuery) => MaybePromise<TStorageValue>\n /**\n * How to deserialize the data from storage.\n * @default `JSON.parse`\n */\n deserialize?: (cachedString: TStorageValue) => MaybePromise<PersistedQuery>\n /**\n * A unique string that can be used to forcefully invalidate existing caches,\n * if they do not share the same buster string\n */\n buster?: string\n /**\n * The max-allowed age of the cache in milliseconds.\n * If a persisted cache is found that is older than this\n * time, it will be discarded\n * @default 24 hours\n */\n maxAge?: number\n /**\n * Prefix to be used for storage key.\n * Storage key is a combination of prefix and query hash in a form of `prefix-queryHash`.\n * @default 'tanstack-query'\n */\n prefix?: string\n /**\n * Filters to narrow down which Queries should be persisted.\n */\n filters?: QueryFilters\n}\n\nexport const PERSISTER_KEY_PREFIX = 'tanstack-query'\n\n/**\n * Warning: experimental feature.\n * This utility function enables fine-grained query persistence.\n * Simple add it as a `persister` parameter to `useQuery` or `defaultOptions` on `queryClient`.\n *\n * ```\n * useQuery({\n queryKey: ['myKey'],\n queryFn: fetcher,\n persister: createPersister({\n storage: localStorage,\n }),\n })\n ```\n */\nexport function experimental_createPersister<TStorageValue = string>({\n storage,\n buster = '',\n maxAge = 1000 * 60 * 60 * 24,\n serialize = JSON.stringify as Required<\n StoragePersisterOptions<TStorageValue>\n >['serialize'],\n deserialize = JSON.parse as Required<\n StoragePersisterOptions<TStorageValue>\n >['deserialize'],\n prefix = PERSISTER_KEY_PREFIX,\n filters,\n}: StoragePersisterOptions<TStorageValue>) {\n return async function persisterFn<T, TQueryKey extends QueryKey>(\n queryFn: (context: QueryFunctionContext<TQueryKey>) => T | Promise<T>,\n context: QueryFunctionContext<TQueryKey>,\n query: Query,\n ) {\n const storageKey = `${prefix}-${query.queryHash}`\n const matchesFilter = filters ? matchQuery(filters, query) : true\n\n // Try to restore only if we do not have any data in the cache and we have persister defined\n if (matchesFilter && query.state.data === undefined && storage != null) {\n try {\n const storedData = await storage.getItem(storageKey)\n if (storedData) {\n const persistedQuery = await deserialize(storedData)\n\n if (persistedQuery.state.dataUpdatedAt) {\n const queryAge = Date.now() - persistedQuery.state.dataUpdatedAt\n const expired = queryAge > maxAge\n const busted = persistedQuery.buster !== buster\n if (expired || busted) {\n await storage.removeItem(storageKey)\n } else {\n // Just after restoring we want to get fresh data from the server if it's stale\n setTimeout(() => {\n // Set proper updatedAt, since resolving in the first pass overrides those values\n query.setState({\n dataUpdatedAt: persistedQuery.state.dataUpdatedAt,\n errorUpdatedAt: persistedQuery.state.errorUpdatedAt,\n })\n\n if (query.isStale()) {\n query.fetch()\n }\n }, 0)\n // We must resolve the promise here, as otherwise we will have `loading` state in the app until `queryFn` resolves\n return Promise.resolve(persistedQuery.state.data as T)\n }\n } else {\n await storage.removeItem(storageKey)\n }\n }\n } catch (err) {\n if (process.env.NODE_ENV === 'development') {\n console.error(err)\n console.warn(\n 'Encountered an error attempting to restore query cache from persisted location.',\n )\n }\n await storage.removeItem(storageKey)\n }\n }\n\n // If we did not restore, or restoration failed - fetch\n const queryFnResult = await queryFn(context)\n\n if (matchesFilter && storage != null) {\n // Persist if we have storage defined, we use timeout to get proper state to be persisted\n setTimeout(async () => {\n storage.setItem(\n storageKey,\n await serialize({\n state: query.state,\n queryKey: query.queryKey,\n queryHash: query.queryHash,\n buster: buster,\n }),\n )\n }, 0)\n }\n\n return Promise.resolve(queryFnResult)\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,wBAA2B;AA+DpB,IAAM,uBAAuB;AAiB7B,SAAS,6BAAqD;AAAA,EACnE;AAAA,EACA,SAAS;AAAA,EACT,SAAS,MAAO,KAAK,KAAK;AAAA,EAC1B,YAAY,KAAK;AAAA,EAGjB,cAAc,KAAK;AAAA,EAGnB,SAAS;AAAA,EACT;AACF,GAA2C;AACzC,SAAO,eAAe,YACpB,SACA,SACA,OACA;AACA,UAAM,aAAa,GAAG,MAAM,IAAI,MAAM,SAAS;AAC/C,UAAM,gBAAgB,cAAU,8BAAW,SAAS,KAAK,IAAI;AAG7D,QAAI,iBAAiB,MAAM,MAAM,SAAS,UAAa,WAAW,MAAM;AACtE,UAAI;AACF,cAAM,aAAa,MAAM,QAAQ,QAAQ,UAAU;AACnD,YAAI,YAAY;AACd,gBAAM,iBAAiB,MAAM,YAAY,UAAU;AAEnD,cAAI,eAAe,MAAM,eAAe;AACtC,kBAAM,WAAW,KAAK,IAAI,IAAI,eAAe,MAAM;AACnD,kBAAM,UAAU,WAAW;AAC3B,kBAAM,SAAS,eAAe,WAAW;AACzC,gBAAI,WAAW,QAAQ;AACrB,oBAAM,QAAQ,WAAW,UAAU;AAAA,YACrC,OAAO;AAEL,yBAAW,MAAM;AAEf,sBAAM,SAAS;AAAA,kBACb,eAAe,eAAe,MAAM;AAAA,kBACpC,gBAAgB,eAAe,MAAM;AAAA,gBACvC,CAAC;AAED,oBAAI,MAAM,QAAQ,GAAG;AACnB,wBAAM,MAAM;AAAA,gBACd;AAAA,cACF,GAAG,CAAC;AAEJ,qBAAO,QAAQ,QAAQ,eAAe,MAAM,IAAS;AAAA,YACvD;AAAA,UACF,OAAO;AACL,kBAAM,QAAQ,WAAW,UAAU;AAAA,UACrC;AAAA,QACF;AAAA,MACF,SAAS,KAAK;AACZ,YAAI,QAAQ,IAAI,aAAa,eAAe;AAC1C,kBAAQ,MAAM,GAAG;AACjB,kBAAQ;AAAA,YACN;AAAA,UACF;AAAA,QACF;AACA,cAAM,QAAQ,WAAW,UAAU;AAAA,MACrC;AAAA,IACF;AAGA,UAAM,gBAAgB,MAAM,QAAQ,OAAO;AAE3C,QAAI,iBAAiB,WAAW,MAAM;AAEpC,iBAAW,YAAY;AACrB,gBAAQ;AAAA,UACN;AAAA,UACA,MAAM,UAAU;AAAA,YACd,OAAO,MAAM;AAAA,YACb,UAAU,MAAM;AAAA,YAChB,WAAW,MAAM;AAAA,YACjB;AAAA,UACF,CAAC;AAAA,QACH;AAAA,MACF,GAAG,CAAC;AAAA,IACN;AAEA,WAAO,QAAQ,QAAQ,aAAa;AAAA,EACtC;AACF;","names":[]}
1
+ {"version":3,"sources":["../../src/createPersister.ts"],"sourcesContent":["import { matchQuery } from '@tanstack/query-core'\nimport type {\n Query,\n QueryClient,\n QueryFilters,\n QueryFunctionContext,\n QueryKey,\n QueryState,\n} from '@tanstack/query-core'\n\nexport interface PersistedQuery {\n buster: string\n queryHash: string\n queryKey: QueryKey\n state: QueryState\n}\n\nexport type MaybePromise<T> = T | Promise<T>\n\nexport interface AsyncStorage<TStorageValue = string> {\n getItem: (key: string) => MaybePromise<TStorageValue | undefined | null>\n setItem: (key: string, value: TStorageValue) => MaybePromise<unknown>\n removeItem: (key: string) => MaybePromise<void>\n entries?: () => MaybePromise<Array<[key: string, value: TStorageValue]>>\n}\n\nexport interface StoragePersisterOptions<TStorageValue = string> {\n /** The storage client used for setting and retrieving items from cache.\n * For SSR pass in `undefined`.\n */\n storage: AsyncStorage<TStorageValue> | undefined | null\n /**\n * How to serialize the data to storage.\n * @default `JSON.stringify`\n */\n serialize?: (persistedQuery: PersistedQuery) => MaybePromise<TStorageValue>\n /**\n * How to deserialize the data from storage.\n * @default `JSON.parse`\n */\n deserialize?: (cachedString: TStorageValue) => MaybePromise<PersistedQuery>\n /**\n * A unique string that can be used to forcefully invalidate existing caches,\n * if they do not share the same buster string\n */\n buster?: string\n /**\n * The max-allowed age of the cache in milliseconds.\n * If a persisted cache is found that is older than this\n * time, it will be discarded\n * @default 24 hours\n */\n maxAge?: number\n /**\n * Prefix to be used for storage key.\n * Storage key is a combination of prefix and query hash in a form of `prefix-queryHash`.\n * @default 'tanstack-query'\n */\n prefix?: string\n /**\n * Filters to narrow down which Queries should be persisted.\n */\n filters?: QueryFilters\n}\n\nexport const PERSISTER_KEY_PREFIX = 'tanstack-query'\n\n/**\n * Warning: experimental feature.\n * This utility function enables fine-grained query persistence.\n * Simple add it as a `persister` parameter to `useQuery` or `defaultOptions` on `queryClient`.\n *\n * ```\n * useQuery({\n queryKey: ['myKey'],\n queryFn: fetcher,\n persister: createPersister({\n storage: localStorage,\n }),\n })\n ```\n */\nexport function experimental_createQueryPersister<TStorageValue = string>({\n storage,\n buster = '',\n maxAge = 1000 * 60 * 60 * 24,\n serialize = JSON.stringify as Required<\n StoragePersisterOptions<TStorageValue>\n >['serialize'],\n deserialize = JSON.parse as Required<\n StoragePersisterOptions<TStorageValue>\n >['deserialize'],\n prefix = PERSISTER_KEY_PREFIX,\n filters,\n}: StoragePersisterOptions<TStorageValue>) {\n function isExpiredOrBusted(persistedQuery: PersistedQuery) {\n if (persistedQuery.state.dataUpdatedAt) {\n const queryAge = Date.now() - persistedQuery.state.dataUpdatedAt\n const expired = queryAge > maxAge\n const busted = persistedQuery.buster !== buster\n\n if (expired || busted) {\n return true\n }\n\n return false\n }\n\n return true\n }\n\n async function retrieveQuery<T>(\n queryHash: string,\n afterRestoreMacroTask?: (persistedQuery: PersistedQuery) => void,\n ) {\n if (storage != null) {\n const storageKey = `${prefix}-${queryHash}`\n try {\n const storedData = await storage.getItem(storageKey)\n if (storedData) {\n const persistedQuery = await deserialize(storedData)\n\n if (isExpiredOrBusted(persistedQuery)) {\n await storage.removeItem(storageKey)\n } else {\n if (afterRestoreMacroTask) {\n // Just after restoring we want to get fresh data from the server if it's stale\n setTimeout(() => afterRestoreMacroTask(persistedQuery), 0)\n }\n // We must resolve the promise here, as otherwise we will have `loading` state in the app until `queryFn` resolves\n return persistedQuery.state.data as T\n }\n }\n } catch (err) {\n if (process.env.NODE_ENV === 'development') {\n console.error(err)\n console.warn(\n 'Encountered an error attempting to restore query cache from persisted location.',\n )\n }\n await storage.removeItem(storageKey)\n }\n }\n\n return\n }\n\n async function persistQueryByKey(\n queryKey: QueryKey,\n queryClient: QueryClient,\n ) {\n if (storage != null) {\n const query = queryClient.getQueryCache().find({ queryKey })\n if (query) {\n await persistQuery(query)\n } else {\n if (process.env.NODE_ENV === 'development') {\n console.warn(\n 'Could not find query to be persisted. QueryKey:',\n JSON.stringify(queryKey),\n )\n }\n }\n }\n }\n\n async function persistQuery(query: Query) {\n if (storage != null) {\n const storageKey = `${prefix}-${query.queryHash}`\n storage.setItem(\n storageKey,\n await serialize({\n state: query.state,\n queryKey: query.queryKey,\n queryHash: query.queryHash,\n buster: buster,\n }),\n )\n }\n }\n\n async function persisterFn<T, TQueryKey extends QueryKey>(\n queryFn: (context: QueryFunctionContext<TQueryKey>) => T | Promise<T>,\n ctx: QueryFunctionContext<TQueryKey>,\n query: Query,\n ) {\n const matchesFilter = filters ? matchQuery(filters, query) : true\n\n // Try to restore only if we do not have any data in the cache and we have persister defined\n if (matchesFilter && query.state.data === undefined && storage != null) {\n const restoredData = await retrieveQuery(\n query.queryHash,\n (persistedQuery: PersistedQuery) => {\n // Set proper updatedAt, since resolving in the first pass overrides those values\n query.setState({\n dataUpdatedAt: persistedQuery.state.dataUpdatedAt,\n errorUpdatedAt: persistedQuery.state.errorUpdatedAt,\n })\n\n if (query.isStale()) {\n query.fetch()\n }\n },\n )\n\n if (restoredData != null) {\n return Promise.resolve(restoredData as T)\n }\n }\n\n // If we did not restore, or restoration failed - fetch\n const queryFnResult = await queryFn(ctx)\n\n if (matchesFilter && storage != null) {\n // Persist if we have storage defined, we use timeout to get proper state to be persisted\n setTimeout(() => {\n persistQuery(query)\n }, 0)\n }\n\n return Promise.resolve(queryFnResult)\n }\n\n async function persisterGc() {\n if (storage?.entries) {\n const entries = await storage.entries()\n for (const [key, value] of entries) {\n if (key.startsWith(prefix)) {\n const persistedQuery = await deserialize(value)\n\n if (isExpiredOrBusted(persistedQuery)) {\n await storage.removeItem(key)\n }\n }\n }\n } else if (process.env.NODE_ENV === 'development') {\n throw new Error(\n 'Provided storage does not implement `entries` method. Garbage collection is not possible without ability to iterate over storage items.',\n )\n }\n }\n\n async function persisterRestoreAll(queryClient: QueryClient) {\n if (storage?.entries) {\n const entries = await storage.entries()\n for (const [key, value] of entries) {\n if (key.startsWith(prefix)) {\n const persistedQuery = await deserialize(value)\n\n if (isExpiredOrBusted(persistedQuery)) {\n await storage.removeItem(key)\n } else {\n queryClient.setQueryData(\n persistedQuery.queryKey,\n persistedQuery.state.data,\n {\n updatedAt: persistedQuery.state.dataUpdatedAt,\n },\n )\n }\n }\n }\n } else if (process.env.NODE_ENV === 'development') {\n throw new Error(\n 'Provided storage does not implement `entries` method. Restoration of all stored entries is not possible without ability to iterate over storage items.',\n )\n }\n }\n\n return {\n persisterFn,\n persistQuery,\n persistQueryByKey,\n retrieveQuery,\n persisterGc,\n persisterRestoreAll,\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,wBAA2B;AAiEpB,IAAM,uBAAuB;AAiB7B,SAAS,kCAA0D;AAAA,EACxE;AAAA,EACA,SAAS;AAAA,EACT,SAAS,MAAO,KAAK,KAAK;AAAA,EAC1B,YAAY,KAAK;AAAA,EAGjB,cAAc,KAAK;AAAA,EAGnB,SAAS;AAAA,EACT;AACF,GAA2C;AACzC,WAAS,kBAAkB,gBAAgC;AACzD,QAAI,eAAe,MAAM,eAAe;AACtC,YAAM,WAAW,KAAK,IAAI,IAAI,eAAe,MAAM;AACnD,YAAM,UAAU,WAAW;AAC3B,YAAM,SAAS,eAAe,WAAW;AAEzC,UAAI,WAAW,QAAQ;AACrB,eAAO;AAAA,MACT;AAEA,aAAO;AAAA,IACT;AAEA,WAAO;AAAA,EACT;AAEA,iBAAe,cACb,WACA,uBACA;AACA,QAAI,WAAW,MAAM;AACnB,YAAM,aAAa,GAAG,MAAM,IAAI,SAAS;AACzC,UAAI;AACF,cAAM,aAAa,MAAM,QAAQ,QAAQ,UAAU;AACnD,YAAI,YAAY;AACd,gBAAM,iBAAiB,MAAM,YAAY,UAAU;AAEnD,cAAI,kBAAkB,cAAc,GAAG;AACrC,kBAAM,QAAQ,WAAW,UAAU;AAAA,UACrC,OAAO;AACL,gBAAI,uBAAuB;AAEzB,yBAAW,MAAM,sBAAsB,cAAc,GAAG,CAAC;AAAA,YAC3D;AAEA,mBAAO,eAAe,MAAM;AAAA,UAC9B;AAAA,QACF;AAAA,MACF,SAAS,KAAK;AACZ,YAAI,QAAQ,IAAI,aAAa,eAAe;AAC1C,kBAAQ,MAAM,GAAG;AACjB,kBAAQ;AAAA,YACN;AAAA,UACF;AAAA,QACF;AACA,cAAM,QAAQ,WAAW,UAAU;AAAA,MACrC;AAAA,IACF;AAEA;AAAA,EACF;AAEA,iBAAe,kBACb,UACA,aACA;AACA,QAAI,WAAW,MAAM;AACnB,YAAM,QAAQ,YAAY,cAAc,EAAE,KAAK,EAAE,SAAS,CAAC;AAC3D,UAAI,OAAO;AACT,cAAM,aAAa,KAAK;AAAA,MAC1B,OAAO;AACL,YAAI,QAAQ,IAAI,aAAa,eAAe;AAC1C,kBAAQ;AAAA,YACN;AAAA,YACA,KAAK,UAAU,QAAQ;AAAA,UACzB;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,iBAAe,aAAa,OAAc;AACxC,QAAI,WAAW,MAAM;AACnB,YAAM,aAAa,GAAG,MAAM,IAAI,MAAM,SAAS;AAC/C,cAAQ;AAAA,QACN;AAAA,QACA,MAAM,UAAU;AAAA,UACd,OAAO,MAAM;AAAA,UACb,UAAU,MAAM;AAAA,UAChB,WAAW,MAAM;AAAA,UACjB;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF;AAAA,EACF;AAEA,iBAAe,YACb,SACA,KACA,OACA;AACA,UAAM,gBAAgB,cAAU,8BAAW,SAAS,KAAK,IAAI;AAG7D,QAAI,iBAAiB,MAAM,MAAM,SAAS,UAAa,WAAW,MAAM;AACtE,YAAM,eAAe,MAAM;AAAA,QACzB,MAAM;AAAA,QACN,CAAC,mBAAmC;AAElC,gBAAM,SAAS;AAAA,YACb,eAAe,eAAe,MAAM;AAAA,YACpC,gBAAgB,eAAe,MAAM;AAAA,UACvC,CAAC;AAED,cAAI,MAAM,QAAQ,GAAG;AACnB,kBAAM,MAAM;AAAA,UACd;AAAA,QACF;AAAA,MACF;AAEA,UAAI,gBAAgB,MAAM;AACxB,eAAO,QAAQ,QAAQ,YAAiB;AAAA,MAC1C;AAAA,IACF;AAGA,UAAM,gBAAgB,MAAM,QAAQ,GAAG;AAEvC,QAAI,iBAAiB,WAAW,MAAM;AAEpC,iBAAW,MAAM;AACf,qBAAa,KAAK;AAAA,MACpB,GAAG,CAAC;AAAA,IACN;AAEA,WAAO,QAAQ,QAAQ,aAAa;AAAA,EACtC;AAEA,iBAAe,cAAc;AAC3B,QAAI,mCAAS,SAAS;AACpB,YAAM,UAAU,MAAM,QAAQ,QAAQ;AACtC,iBAAW,CAAC,KAAK,KAAK,KAAK,SAAS;AAClC,YAAI,IAAI,WAAW,MAAM,GAAG;AAC1B,gBAAM,iBAAiB,MAAM,YAAY,KAAK;AAE9C,cAAI,kBAAkB,cAAc,GAAG;AACrC,kBAAM,QAAQ,WAAW,GAAG;AAAA,UAC9B;AAAA,QACF;AAAA,MACF;AAAA,IACF,WAAW,QAAQ,IAAI,aAAa,eAAe;AACjD,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,iBAAe,oBAAoB,aAA0B;AAC3D,QAAI,mCAAS,SAAS;AACpB,YAAM,UAAU,MAAM,QAAQ,QAAQ;AACtC,iBAAW,CAAC,KAAK,KAAK,KAAK,SAAS;AAClC,YAAI,IAAI,WAAW,MAAM,GAAG;AAC1B,gBAAM,iBAAiB,MAAM,YAAY,KAAK;AAE9C,cAAI,kBAAkB,cAAc,GAAG;AACrC,kBAAM,QAAQ,WAAW,GAAG;AAAA,UAC9B,OAAO;AACL,wBAAY;AAAA,cACV,eAAe;AAAA,cACf,eAAe,MAAM;AAAA,cACrB;AAAA,gBACE,WAAW,eAAe,MAAM;AAAA,cAClC;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF,WAAW,QAAQ,IAAI,aAAa,eAAe;AACjD,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;","names":[]}
@@ -1,4 +1,4 @@
1
- import { QueryKey, QueryState, QueryFilters, QueryFunctionContext, Query } from '@tanstack/query-core';
1
+ import { QueryKey, QueryState, QueryFilters, QueryFunctionContext, Query, QueryClient } from '@tanstack/query-core';
2
2
 
3
3
  interface PersistedQuery {
4
4
  buster: string;
@@ -11,6 +11,7 @@ interface AsyncStorage<TStorageValue = string> {
11
11
  getItem: (key: string) => MaybePromise<TStorageValue | undefined | null>;
12
12
  setItem: (key: string, value: TStorageValue) => MaybePromise<unknown>;
13
13
  removeItem: (key: string) => MaybePromise<void>;
14
+ entries?: () => MaybePromise<Array<[key: string, value: TStorageValue]>>;
14
15
  }
15
16
  interface StoragePersisterOptions<TStorageValue = string> {
16
17
  /** The storage client used for setting and retrieving items from cache.
@@ -66,6 +67,13 @@ declare const PERSISTER_KEY_PREFIX = "tanstack-query";
66
67
  })
67
68
  ```
68
69
  */
69
- declare function experimental_createPersister<TStorageValue = string>({ storage, buster, maxAge, serialize, deserialize, prefix, filters, }: StoragePersisterOptions<TStorageValue>): <T, TQueryKey extends QueryKey>(queryFn: (context: QueryFunctionContext<TQueryKey>) => T | Promise<T>, context: QueryFunctionContext<TQueryKey>, query: Query) => Promise<T>;
70
+ declare function experimental_createQueryPersister<TStorageValue = string>({ storage, buster, maxAge, serialize, deserialize, prefix, filters, }: StoragePersisterOptions<TStorageValue>): {
71
+ persisterFn: <T, TQueryKey extends QueryKey>(queryFn: (context: QueryFunctionContext<TQueryKey>) => T | Promise<T>, ctx: QueryFunctionContext<TQueryKey>, query: Query) => Promise<T>;
72
+ persistQuery: (query: Query) => Promise<void>;
73
+ persistQueryByKey: (queryKey: QueryKey, queryClient: QueryClient) => Promise<void>;
74
+ retrieveQuery: <T>(queryHash: string, afterRestoreMacroTask?: (persistedQuery: PersistedQuery) => void) => Promise<T | undefined>;
75
+ persisterGc: () => Promise<void>;
76
+ persisterRestoreAll: (queryClient: QueryClient) => Promise<void>;
77
+ };
70
78
 
71
- export { type AsyncStorage, type MaybePromise, PERSISTER_KEY_PREFIX, type PersistedQuery, type StoragePersisterOptions, experimental_createPersister };
79
+ export { type AsyncStorage, type MaybePromise, PERSISTER_KEY_PREFIX, type PersistedQuery, type StoragePersisterOptions, experimental_createQueryPersister };
@@ -1,4 +1,4 @@
1
- import { QueryKey, QueryState, QueryFilters, QueryFunctionContext, Query } from '@tanstack/query-core';
1
+ import { QueryKey, QueryState, QueryFilters, QueryFunctionContext, Query, QueryClient } from '@tanstack/query-core';
2
2
 
3
3
  interface PersistedQuery {
4
4
  buster: string;
@@ -11,6 +11,7 @@ interface AsyncStorage<TStorageValue = string> {
11
11
  getItem: (key: string) => MaybePromise<TStorageValue | undefined | null>;
12
12
  setItem: (key: string, value: TStorageValue) => MaybePromise<unknown>;
13
13
  removeItem: (key: string) => MaybePromise<void>;
14
+ entries?: () => MaybePromise<Array<[key: string, value: TStorageValue]>>;
14
15
  }
15
16
  interface StoragePersisterOptions<TStorageValue = string> {
16
17
  /** The storage client used for setting and retrieving items from cache.
@@ -66,6 +67,13 @@ declare const PERSISTER_KEY_PREFIX = "tanstack-query";
66
67
  })
67
68
  ```
68
69
  */
69
- declare function experimental_createPersister<TStorageValue = string>({ storage, buster, maxAge, serialize, deserialize, prefix, filters, }: StoragePersisterOptions<TStorageValue>): <T, TQueryKey extends QueryKey>(queryFn: (context: QueryFunctionContext<TQueryKey>) => T | Promise<T>, context: QueryFunctionContext<TQueryKey>, query: Query) => Promise<T>;
70
+ declare function experimental_createQueryPersister<TStorageValue = string>({ storage, buster, maxAge, serialize, deserialize, prefix, filters, }: StoragePersisterOptions<TStorageValue>): {
71
+ persisterFn: <T, TQueryKey extends QueryKey>(queryFn: (context: QueryFunctionContext<TQueryKey>) => T | Promise<T>, ctx: QueryFunctionContext<TQueryKey>, query: Query) => Promise<T>;
72
+ persistQuery: (query: Query) => Promise<void>;
73
+ persistQueryByKey: (queryKey: QueryKey, queryClient: QueryClient) => Promise<void>;
74
+ retrieveQuery: <T>(queryHash: string, afterRestoreMacroTask?: (persistedQuery: PersistedQuery) => void) => Promise<T | undefined>;
75
+ persisterGc: () => Promise<void>;
76
+ persisterRestoreAll: (queryClient: QueryClient) => Promise<void>;
77
+ };
70
78
 
71
- export { type AsyncStorage, type MaybePromise, PERSISTER_KEY_PREFIX, type PersistedQuery, type StoragePersisterOptions, experimental_createPersister };
79
+ export { type AsyncStorage, type MaybePromise, PERSISTER_KEY_PREFIX, type PersistedQuery, type StoragePersisterOptions, experimental_createQueryPersister };
@@ -1,7 +1,7 @@
1
1
  // src/createPersister.ts
2
2
  import { matchQuery } from "@tanstack/query-core";
3
3
  var PERSISTER_KEY_PREFIX = "tanstack-query";
4
- function experimental_createPersister({
4
+ function experimental_createQueryPersister({
5
5
  storage,
6
6
  buster = "",
7
7
  maxAge = 1e3 * 60 * 60 * 24,
@@ -10,34 +10,32 @@ function experimental_createPersister({
10
10
  prefix = PERSISTER_KEY_PREFIX,
11
11
  filters
12
12
  }) {
13
- return async function persisterFn(queryFn, context, query) {
14
- const storageKey = `${prefix}-${query.queryHash}`;
15
- const matchesFilter = filters ? matchQuery(filters, query) : true;
16
- if (matchesFilter && query.state.data === void 0 && storage != null) {
13
+ function isExpiredOrBusted(persistedQuery) {
14
+ if (persistedQuery.state.dataUpdatedAt) {
15
+ const queryAge = Date.now() - persistedQuery.state.dataUpdatedAt;
16
+ const expired = queryAge > maxAge;
17
+ const busted = persistedQuery.buster !== buster;
18
+ if (expired || busted) {
19
+ return true;
20
+ }
21
+ return false;
22
+ }
23
+ return true;
24
+ }
25
+ async function retrieveQuery(queryHash, afterRestoreMacroTask) {
26
+ if (storage != null) {
27
+ const storageKey = `${prefix}-${queryHash}`;
17
28
  try {
18
29
  const storedData = await storage.getItem(storageKey);
19
30
  if (storedData) {
20
31
  const persistedQuery = await deserialize(storedData);
21
- if (persistedQuery.state.dataUpdatedAt) {
22
- const queryAge = Date.now() - persistedQuery.state.dataUpdatedAt;
23
- const expired = queryAge > maxAge;
24
- const busted = persistedQuery.buster !== buster;
25
- if (expired || busted) {
26
- await storage.removeItem(storageKey);
27
- } else {
28
- setTimeout(() => {
29
- query.setState({
30
- dataUpdatedAt: persistedQuery.state.dataUpdatedAt,
31
- errorUpdatedAt: persistedQuery.state.errorUpdatedAt
32
- });
33
- if (query.isStale()) {
34
- query.fetch();
35
- }
36
- }, 0);
37
- return Promise.resolve(persistedQuery.state.data);
38
- }
39
- } else {
32
+ if (isExpiredOrBusted(persistedQuery)) {
40
33
  await storage.removeItem(storageKey);
34
+ } else {
35
+ if (afterRestoreMacroTask) {
36
+ setTimeout(() => afterRestoreMacroTask(persistedQuery), 0);
37
+ }
38
+ return persistedQuery.state.data;
41
39
  }
42
40
  }
43
41
  } catch (err) {
@@ -50,25 +48,117 @@ function experimental_createPersister({
50
48
  await storage.removeItem(storageKey);
51
49
  }
52
50
  }
53
- const queryFnResult = await queryFn(context);
51
+ return;
52
+ }
53
+ async function persistQueryByKey(queryKey, queryClient) {
54
+ if (storage != null) {
55
+ const query = queryClient.getQueryCache().find({ queryKey });
56
+ if (query) {
57
+ await persistQuery(query);
58
+ } else {
59
+ if (process.env.NODE_ENV === "development") {
60
+ console.warn(
61
+ "Could not find query to be persisted. QueryKey:",
62
+ JSON.stringify(queryKey)
63
+ );
64
+ }
65
+ }
66
+ }
67
+ }
68
+ async function persistQuery(query) {
69
+ if (storage != null) {
70
+ const storageKey = `${prefix}-${query.queryHash}`;
71
+ storage.setItem(
72
+ storageKey,
73
+ await serialize({
74
+ state: query.state,
75
+ queryKey: query.queryKey,
76
+ queryHash: query.queryHash,
77
+ buster
78
+ })
79
+ );
80
+ }
81
+ }
82
+ async function persisterFn(queryFn, ctx, query) {
83
+ const matchesFilter = filters ? matchQuery(filters, query) : true;
84
+ if (matchesFilter && query.state.data === void 0 && storage != null) {
85
+ const restoredData = await retrieveQuery(
86
+ query.queryHash,
87
+ (persistedQuery) => {
88
+ query.setState({
89
+ dataUpdatedAt: persistedQuery.state.dataUpdatedAt,
90
+ errorUpdatedAt: persistedQuery.state.errorUpdatedAt
91
+ });
92
+ if (query.isStale()) {
93
+ query.fetch();
94
+ }
95
+ }
96
+ );
97
+ if (restoredData != null) {
98
+ return Promise.resolve(restoredData);
99
+ }
100
+ }
101
+ const queryFnResult = await queryFn(ctx);
54
102
  if (matchesFilter && storage != null) {
55
- setTimeout(async () => {
56
- storage.setItem(
57
- storageKey,
58
- await serialize({
59
- state: query.state,
60
- queryKey: query.queryKey,
61
- queryHash: query.queryHash,
62
- buster
63
- })
64
- );
103
+ setTimeout(() => {
104
+ persistQuery(query);
65
105
  }, 0);
66
106
  }
67
107
  return Promise.resolve(queryFnResult);
108
+ }
109
+ async function persisterGc() {
110
+ if (storage == null ? void 0 : storage.entries) {
111
+ const entries = await storage.entries();
112
+ for (const [key, value] of entries) {
113
+ if (key.startsWith(prefix)) {
114
+ const persistedQuery = await deserialize(value);
115
+ if (isExpiredOrBusted(persistedQuery)) {
116
+ await storage.removeItem(key);
117
+ }
118
+ }
119
+ }
120
+ } else if (process.env.NODE_ENV === "development") {
121
+ throw new Error(
122
+ "Provided storage does not implement `entries` method. Garbage collection is not possible without ability to iterate over storage items."
123
+ );
124
+ }
125
+ }
126
+ async function persisterRestoreAll(queryClient) {
127
+ if (storage == null ? void 0 : storage.entries) {
128
+ const entries = await storage.entries();
129
+ for (const [key, value] of entries) {
130
+ if (key.startsWith(prefix)) {
131
+ const persistedQuery = await deserialize(value);
132
+ if (isExpiredOrBusted(persistedQuery)) {
133
+ await storage.removeItem(key);
134
+ } else {
135
+ queryClient.setQueryData(
136
+ persistedQuery.queryKey,
137
+ persistedQuery.state.data,
138
+ {
139
+ updatedAt: persistedQuery.state.dataUpdatedAt
140
+ }
141
+ );
142
+ }
143
+ }
144
+ }
145
+ } else if (process.env.NODE_ENV === "development") {
146
+ throw new Error(
147
+ "Provided storage does not implement `entries` method. Restoration of all stored entries is not possible without ability to iterate over storage items."
148
+ );
149
+ }
150
+ }
151
+ return {
152
+ persisterFn,
153
+ persistQuery,
154
+ persistQueryByKey,
155
+ retrieveQuery,
156
+ persisterGc,
157
+ persisterRestoreAll
68
158
  };
69
159
  }
70
160
  export {
71
161
  PERSISTER_KEY_PREFIX,
72
- experimental_createPersister
162
+ experimental_createQueryPersister
73
163
  };
74
164
  //# sourceMappingURL=createPersister.js.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/createPersister.ts"],"sourcesContent":["import { matchQuery } from '@tanstack/query-core'\nimport type {\n Query,\n QueryFilters,\n QueryFunctionContext,\n QueryKey,\n QueryState,\n} from '@tanstack/query-core'\n\nexport interface PersistedQuery {\n buster: string\n queryHash: string\n queryKey: QueryKey\n state: QueryState\n}\n\nexport type MaybePromise<T> = T | Promise<T>\n\nexport interface AsyncStorage<TStorageValue = string> {\n getItem: (key: string) => MaybePromise<TStorageValue | undefined | null>\n setItem: (key: string, value: TStorageValue) => MaybePromise<unknown>\n removeItem: (key: string) => MaybePromise<void>\n}\n\nexport interface StoragePersisterOptions<TStorageValue = string> {\n /** The storage client used for setting and retrieving items from cache.\n * For SSR pass in `undefined`.\n */\n storage: AsyncStorage<TStorageValue> | undefined | null\n /**\n * How to serialize the data to storage.\n * @default `JSON.stringify`\n */\n serialize?: (persistedQuery: PersistedQuery) => MaybePromise<TStorageValue>\n /**\n * How to deserialize the data from storage.\n * @default `JSON.parse`\n */\n deserialize?: (cachedString: TStorageValue) => MaybePromise<PersistedQuery>\n /**\n * A unique string that can be used to forcefully invalidate existing caches,\n * if they do not share the same buster string\n */\n buster?: string\n /**\n * The max-allowed age of the cache in milliseconds.\n * If a persisted cache is found that is older than this\n * time, it will be discarded\n * @default 24 hours\n */\n maxAge?: number\n /**\n * Prefix to be used for storage key.\n * Storage key is a combination of prefix and query hash in a form of `prefix-queryHash`.\n * @default 'tanstack-query'\n */\n prefix?: string\n /**\n * Filters to narrow down which Queries should be persisted.\n */\n filters?: QueryFilters\n}\n\nexport const PERSISTER_KEY_PREFIX = 'tanstack-query'\n\n/**\n * Warning: experimental feature.\n * This utility function enables fine-grained query persistence.\n * Simple add it as a `persister` parameter to `useQuery` or `defaultOptions` on `queryClient`.\n *\n * ```\n * useQuery({\n queryKey: ['myKey'],\n queryFn: fetcher,\n persister: createPersister({\n storage: localStorage,\n }),\n })\n ```\n */\nexport function experimental_createPersister<TStorageValue = string>({\n storage,\n buster = '',\n maxAge = 1000 * 60 * 60 * 24,\n serialize = JSON.stringify as Required<\n StoragePersisterOptions<TStorageValue>\n >['serialize'],\n deserialize = JSON.parse as Required<\n StoragePersisterOptions<TStorageValue>\n >['deserialize'],\n prefix = PERSISTER_KEY_PREFIX,\n filters,\n}: StoragePersisterOptions<TStorageValue>) {\n return async function persisterFn<T, TQueryKey extends QueryKey>(\n queryFn: (context: QueryFunctionContext<TQueryKey>) => T | Promise<T>,\n context: QueryFunctionContext<TQueryKey>,\n query: Query,\n ) {\n const storageKey = `${prefix}-${query.queryHash}`\n const matchesFilter = filters ? matchQuery(filters, query) : true\n\n // Try to restore only if we do not have any data in the cache and we have persister defined\n if (matchesFilter && query.state.data === undefined && storage != null) {\n try {\n const storedData = await storage.getItem(storageKey)\n if (storedData) {\n const persistedQuery = await deserialize(storedData)\n\n if (persistedQuery.state.dataUpdatedAt) {\n const queryAge = Date.now() - persistedQuery.state.dataUpdatedAt\n const expired = queryAge > maxAge\n const busted = persistedQuery.buster !== buster\n if (expired || busted) {\n await storage.removeItem(storageKey)\n } else {\n // Just after restoring we want to get fresh data from the server if it's stale\n setTimeout(() => {\n // Set proper updatedAt, since resolving in the first pass overrides those values\n query.setState({\n dataUpdatedAt: persistedQuery.state.dataUpdatedAt,\n errorUpdatedAt: persistedQuery.state.errorUpdatedAt,\n })\n\n if (query.isStale()) {\n query.fetch()\n }\n }, 0)\n // We must resolve the promise here, as otherwise we will have `loading` state in the app until `queryFn` resolves\n return Promise.resolve(persistedQuery.state.data as T)\n }\n } else {\n await storage.removeItem(storageKey)\n }\n }\n } catch (err) {\n if (process.env.NODE_ENV === 'development') {\n console.error(err)\n console.warn(\n 'Encountered an error attempting to restore query cache from persisted location.',\n )\n }\n await storage.removeItem(storageKey)\n }\n }\n\n // If we did not restore, or restoration failed - fetch\n const queryFnResult = await queryFn(context)\n\n if (matchesFilter && storage != null) {\n // Persist if we have storage defined, we use timeout to get proper state to be persisted\n setTimeout(async () => {\n storage.setItem(\n storageKey,\n await serialize({\n state: query.state,\n queryKey: query.queryKey,\n queryHash: query.queryHash,\n buster: buster,\n }),\n )\n }, 0)\n }\n\n return Promise.resolve(queryFnResult)\n }\n}\n"],"mappings":";AAAA,SAAS,kBAAkB;AA+DpB,IAAM,uBAAuB;AAiB7B,SAAS,6BAAqD;AAAA,EACnE;AAAA,EACA,SAAS;AAAA,EACT,SAAS,MAAO,KAAK,KAAK;AAAA,EAC1B,YAAY,KAAK;AAAA,EAGjB,cAAc,KAAK;AAAA,EAGnB,SAAS;AAAA,EACT;AACF,GAA2C;AACzC,SAAO,eAAe,YACpB,SACA,SACA,OACA;AACA,UAAM,aAAa,GAAG,MAAM,IAAI,MAAM,SAAS;AAC/C,UAAM,gBAAgB,UAAU,WAAW,SAAS,KAAK,IAAI;AAG7D,QAAI,iBAAiB,MAAM,MAAM,SAAS,UAAa,WAAW,MAAM;AACtE,UAAI;AACF,cAAM,aAAa,MAAM,QAAQ,QAAQ,UAAU;AACnD,YAAI,YAAY;AACd,gBAAM,iBAAiB,MAAM,YAAY,UAAU;AAEnD,cAAI,eAAe,MAAM,eAAe;AACtC,kBAAM,WAAW,KAAK,IAAI,IAAI,eAAe,MAAM;AACnD,kBAAM,UAAU,WAAW;AAC3B,kBAAM,SAAS,eAAe,WAAW;AACzC,gBAAI,WAAW,QAAQ;AACrB,oBAAM,QAAQ,WAAW,UAAU;AAAA,YACrC,OAAO;AAEL,yBAAW,MAAM;AAEf,sBAAM,SAAS;AAAA,kBACb,eAAe,eAAe,MAAM;AAAA,kBACpC,gBAAgB,eAAe,MAAM;AAAA,gBACvC,CAAC;AAED,oBAAI,MAAM,QAAQ,GAAG;AACnB,wBAAM,MAAM;AAAA,gBACd;AAAA,cACF,GAAG,CAAC;AAEJ,qBAAO,QAAQ,QAAQ,eAAe,MAAM,IAAS;AAAA,YACvD;AAAA,UACF,OAAO;AACL,kBAAM,QAAQ,WAAW,UAAU;AAAA,UACrC;AAAA,QACF;AAAA,MACF,SAAS,KAAK;AACZ,YAAI,QAAQ,IAAI,aAAa,eAAe;AAC1C,kBAAQ,MAAM,GAAG;AACjB,kBAAQ;AAAA,YACN;AAAA,UACF;AAAA,QACF;AACA,cAAM,QAAQ,WAAW,UAAU;AAAA,MACrC;AAAA,IACF;AAGA,UAAM,gBAAgB,MAAM,QAAQ,OAAO;AAE3C,QAAI,iBAAiB,WAAW,MAAM;AAEpC,iBAAW,YAAY;AACrB,gBAAQ;AAAA,UACN;AAAA,UACA,MAAM,UAAU;AAAA,YACd,OAAO,MAAM;AAAA,YACb,UAAU,MAAM;AAAA,YAChB,WAAW,MAAM;AAAA,YACjB;AAAA,UACF,CAAC;AAAA,QACH;AAAA,MACF,GAAG,CAAC;AAAA,IACN;AAEA,WAAO,QAAQ,QAAQ,aAAa;AAAA,EACtC;AACF;","names":[]}
1
+ {"version":3,"sources":["../../src/createPersister.ts"],"sourcesContent":["import { matchQuery } from '@tanstack/query-core'\nimport type {\n Query,\n QueryClient,\n QueryFilters,\n QueryFunctionContext,\n QueryKey,\n QueryState,\n} from '@tanstack/query-core'\n\nexport interface PersistedQuery {\n buster: string\n queryHash: string\n queryKey: QueryKey\n state: QueryState\n}\n\nexport type MaybePromise<T> = T | Promise<T>\n\nexport interface AsyncStorage<TStorageValue = string> {\n getItem: (key: string) => MaybePromise<TStorageValue | undefined | null>\n setItem: (key: string, value: TStorageValue) => MaybePromise<unknown>\n removeItem: (key: string) => MaybePromise<void>\n entries?: () => MaybePromise<Array<[key: string, value: TStorageValue]>>\n}\n\nexport interface StoragePersisterOptions<TStorageValue = string> {\n /** The storage client used for setting and retrieving items from cache.\n * For SSR pass in `undefined`.\n */\n storage: AsyncStorage<TStorageValue> | undefined | null\n /**\n * How to serialize the data to storage.\n * @default `JSON.stringify`\n */\n serialize?: (persistedQuery: PersistedQuery) => MaybePromise<TStorageValue>\n /**\n * How to deserialize the data from storage.\n * @default `JSON.parse`\n */\n deserialize?: (cachedString: TStorageValue) => MaybePromise<PersistedQuery>\n /**\n * A unique string that can be used to forcefully invalidate existing caches,\n * if they do not share the same buster string\n */\n buster?: string\n /**\n * The max-allowed age of the cache in milliseconds.\n * If a persisted cache is found that is older than this\n * time, it will be discarded\n * @default 24 hours\n */\n maxAge?: number\n /**\n * Prefix to be used for storage key.\n * Storage key is a combination of prefix and query hash in a form of `prefix-queryHash`.\n * @default 'tanstack-query'\n */\n prefix?: string\n /**\n * Filters to narrow down which Queries should be persisted.\n */\n filters?: QueryFilters\n}\n\nexport const PERSISTER_KEY_PREFIX = 'tanstack-query'\n\n/**\n * Warning: experimental feature.\n * This utility function enables fine-grained query persistence.\n * Simple add it as a `persister` parameter to `useQuery` or `defaultOptions` on `queryClient`.\n *\n * ```\n * useQuery({\n queryKey: ['myKey'],\n queryFn: fetcher,\n persister: createPersister({\n storage: localStorage,\n }),\n })\n ```\n */\nexport function experimental_createQueryPersister<TStorageValue = string>({\n storage,\n buster = '',\n maxAge = 1000 * 60 * 60 * 24,\n serialize = JSON.stringify as Required<\n StoragePersisterOptions<TStorageValue>\n >['serialize'],\n deserialize = JSON.parse as Required<\n StoragePersisterOptions<TStorageValue>\n >['deserialize'],\n prefix = PERSISTER_KEY_PREFIX,\n filters,\n}: StoragePersisterOptions<TStorageValue>) {\n function isExpiredOrBusted(persistedQuery: PersistedQuery) {\n if (persistedQuery.state.dataUpdatedAt) {\n const queryAge = Date.now() - persistedQuery.state.dataUpdatedAt\n const expired = queryAge > maxAge\n const busted = persistedQuery.buster !== buster\n\n if (expired || busted) {\n return true\n }\n\n return false\n }\n\n return true\n }\n\n async function retrieveQuery<T>(\n queryHash: string,\n afterRestoreMacroTask?: (persistedQuery: PersistedQuery) => void,\n ) {\n if (storage != null) {\n const storageKey = `${prefix}-${queryHash}`\n try {\n const storedData = await storage.getItem(storageKey)\n if (storedData) {\n const persistedQuery = await deserialize(storedData)\n\n if (isExpiredOrBusted(persistedQuery)) {\n await storage.removeItem(storageKey)\n } else {\n if (afterRestoreMacroTask) {\n // Just after restoring we want to get fresh data from the server if it's stale\n setTimeout(() => afterRestoreMacroTask(persistedQuery), 0)\n }\n // We must resolve the promise here, as otherwise we will have `loading` state in the app until `queryFn` resolves\n return persistedQuery.state.data as T\n }\n }\n } catch (err) {\n if (process.env.NODE_ENV === 'development') {\n console.error(err)\n console.warn(\n 'Encountered an error attempting to restore query cache from persisted location.',\n )\n }\n await storage.removeItem(storageKey)\n }\n }\n\n return\n }\n\n async function persistQueryByKey(\n queryKey: QueryKey,\n queryClient: QueryClient,\n ) {\n if (storage != null) {\n const query = queryClient.getQueryCache().find({ queryKey })\n if (query) {\n await persistQuery(query)\n } else {\n if (process.env.NODE_ENV === 'development') {\n console.warn(\n 'Could not find query to be persisted. QueryKey:',\n JSON.stringify(queryKey),\n )\n }\n }\n }\n }\n\n async function persistQuery(query: Query) {\n if (storage != null) {\n const storageKey = `${prefix}-${query.queryHash}`\n storage.setItem(\n storageKey,\n await serialize({\n state: query.state,\n queryKey: query.queryKey,\n queryHash: query.queryHash,\n buster: buster,\n }),\n )\n }\n }\n\n async function persisterFn<T, TQueryKey extends QueryKey>(\n queryFn: (context: QueryFunctionContext<TQueryKey>) => T | Promise<T>,\n ctx: QueryFunctionContext<TQueryKey>,\n query: Query,\n ) {\n const matchesFilter = filters ? matchQuery(filters, query) : true\n\n // Try to restore only if we do not have any data in the cache and we have persister defined\n if (matchesFilter && query.state.data === undefined && storage != null) {\n const restoredData = await retrieveQuery(\n query.queryHash,\n (persistedQuery: PersistedQuery) => {\n // Set proper updatedAt, since resolving in the first pass overrides those values\n query.setState({\n dataUpdatedAt: persistedQuery.state.dataUpdatedAt,\n errorUpdatedAt: persistedQuery.state.errorUpdatedAt,\n })\n\n if (query.isStale()) {\n query.fetch()\n }\n },\n )\n\n if (restoredData != null) {\n return Promise.resolve(restoredData as T)\n }\n }\n\n // If we did not restore, or restoration failed - fetch\n const queryFnResult = await queryFn(ctx)\n\n if (matchesFilter && storage != null) {\n // Persist if we have storage defined, we use timeout to get proper state to be persisted\n setTimeout(() => {\n persistQuery(query)\n }, 0)\n }\n\n return Promise.resolve(queryFnResult)\n }\n\n async function persisterGc() {\n if (storage?.entries) {\n const entries = await storage.entries()\n for (const [key, value] of entries) {\n if (key.startsWith(prefix)) {\n const persistedQuery = await deserialize(value)\n\n if (isExpiredOrBusted(persistedQuery)) {\n await storage.removeItem(key)\n }\n }\n }\n } else if (process.env.NODE_ENV === 'development') {\n throw new Error(\n 'Provided storage does not implement `entries` method. Garbage collection is not possible without ability to iterate over storage items.',\n )\n }\n }\n\n async function persisterRestoreAll(queryClient: QueryClient) {\n if (storage?.entries) {\n const entries = await storage.entries()\n for (const [key, value] of entries) {\n if (key.startsWith(prefix)) {\n const persistedQuery = await deserialize(value)\n\n if (isExpiredOrBusted(persistedQuery)) {\n await storage.removeItem(key)\n } else {\n queryClient.setQueryData(\n persistedQuery.queryKey,\n persistedQuery.state.data,\n {\n updatedAt: persistedQuery.state.dataUpdatedAt,\n },\n )\n }\n }\n }\n } else if (process.env.NODE_ENV === 'development') {\n throw new Error(\n 'Provided storage does not implement `entries` method. Restoration of all stored entries is not possible without ability to iterate over storage items.',\n )\n }\n }\n\n return {\n persisterFn,\n persistQuery,\n persistQueryByKey,\n retrieveQuery,\n persisterGc,\n persisterRestoreAll,\n }\n}\n"],"mappings":";AAAA,SAAS,kBAAkB;AAiEpB,IAAM,uBAAuB;AAiB7B,SAAS,kCAA0D;AAAA,EACxE;AAAA,EACA,SAAS;AAAA,EACT,SAAS,MAAO,KAAK,KAAK;AAAA,EAC1B,YAAY,KAAK;AAAA,EAGjB,cAAc,KAAK;AAAA,EAGnB,SAAS;AAAA,EACT;AACF,GAA2C;AACzC,WAAS,kBAAkB,gBAAgC;AACzD,QAAI,eAAe,MAAM,eAAe;AACtC,YAAM,WAAW,KAAK,IAAI,IAAI,eAAe,MAAM;AACnD,YAAM,UAAU,WAAW;AAC3B,YAAM,SAAS,eAAe,WAAW;AAEzC,UAAI,WAAW,QAAQ;AACrB,eAAO;AAAA,MACT;AAEA,aAAO;AAAA,IACT;AAEA,WAAO;AAAA,EACT;AAEA,iBAAe,cACb,WACA,uBACA;AACA,QAAI,WAAW,MAAM;AACnB,YAAM,aAAa,GAAG,MAAM,IAAI,SAAS;AACzC,UAAI;AACF,cAAM,aAAa,MAAM,QAAQ,QAAQ,UAAU;AACnD,YAAI,YAAY;AACd,gBAAM,iBAAiB,MAAM,YAAY,UAAU;AAEnD,cAAI,kBAAkB,cAAc,GAAG;AACrC,kBAAM,QAAQ,WAAW,UAAU;AAAA,UACrC,OAAO;AACL,gBAAI,uBAAuB;AAEzB,yBAAW,MAAM,sBAAsB,cAAc,GAAG,CAAC;AAAA,YAC3D;AAEA,mBAAO,eAAe,MAAM;AAAA,UAC9B;AAAA,QACF;AAAA,MACF,SAAS,KAAK;AACZ,YAAI,QAAQ,IAAI,aAAa,eAAe;AAC1C,kBAAQ,MAAM,GAAG;AACjB,kBAAQ;AAAA,YACN;AAAA,UACF;AAAA,QACF;AACA,cAAM,QAAQ,WAAW,UAAU;AAAA,MACrC;AAAA,IACF;AAEA;AAAA,EACF;AAEA,iBAAe,kBACb,UACA,aACA;AACA,QAAI,WAAW,MAAM;AACnB,YAAM,QAAQ,YAAY,cAAc,EAAE,KAAK,EAAE,SAAS,CAAC;AAC3D,UAAI,OAAO;AACT,cAAM,aAAa,KAAK;AAAA,MAC1B,OAAO;AACL,YAAI,QAAQ,IAAI,aAAa,eAAe;AAC1C,kBAAQ;AAAA,YACN;AAAA,YACA,KAAK,UAAU,QAAQ;AAAA,UACzB;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,iBAAe,aAAa,OAAc;AACxC,QAAI,WAAW,MAAM;AACnB,YAAM,aAAa,GAAG,MAAM,IAAI,MAAM,SAAS;AAC/C,cAAQ;AAAA,QACN;AAAA,QACA,MAAM,UAAU;AAAA,UACd,OAAO,MAAM;AAAA,UACb,UAAU,MAAM;AAAA,UAChB,WAAW,MAAM;AAAA,UACjB;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF;AAAA,EACF;AAEA,iBAAe,YACb,SACA,KACA,OACA;AACA,UAAM,gBAAgB,UAAU,WAAW,SAAS,KAAK,IAAI;AAG7D,QAAI,iBAAiB,MAAM,MAAM,SAAS,UAAa,WAAW,MAAM;AACtE,YAAM,eAAe,MAAM;AAAA,QACzB,MAAM;AAAA,QACN,CAAC,mBAAmC;AAElC,gBAAM,SAAS;AAAA,YACb,eAAe,eAAe,MAAM;AAAA,YACpC,gBAAgB,eAAe,MAAM;AAAA,UACvC,CAAC;AAED,cAAI,MAAM,QAAQ,GAAG;AACnB,kBAAM,MAAM;AAAA,UACd;AAAA,QACF;AAAA,MACF;AAEA,UAAI,gBAAgB,MAAM;AACxB,eAAO,QAAQ,QAAQ,YAAiB;AAAA,MAC1C;AAAA,IACF;AAGA,UAAM,gBAAgB,MAAM,QAAQ,GAAG;AAEvC,QAAI,iBAAiB,WAAW,MAAM;AAEpC,iBAAW,MAAM;AACf,qBAAa,KAAK;AAAA,MACpB,GAAG,CAAC;AAAA,IACN;AAEA,WAAO,QAAQ,QAAQ,aAAa;AAAA,EACtC;AAEA,iBAAe,cAAc;AAC3B,QAAI,mCAAS,SAAS;AACpB,YAAM,UAAU,MAAM,QAAQ,QAAQ;AACtC,iBAAW,CAAC,KAAK,KAAK,KAAK,SAAS;AAClC,YAAI,IAAI,WAAW,MAAM,GAAG;AAC1B,gBAAM,iBAAiB,MAAM,YAAY,KAAK;AAE9C,cAAI,kBAAkB,cAAc,GAAG;AACrC,kBAAM,QAAQ,WAAW,GAAG;AAAA,UAC9B;AAAA,QACF;AAAA,MACF;AAAA,IACF,WAAW,QAAQ,IAAI,aAAa,eAAe;AACjD,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,iBAAe,oBAAoB,aAA0B;AAC3D,QAAI,mCAAS,SAAS;AACpB,YAAM,UAAU,MAAM,QAAQ,QAAQ;AACtC,iBAAW,CAAC,KAAK,KAAK,KAAK,SAAS;AAClC,YAAI,IAAI,WAAW,MAAM,GAAG;AAC1B,gBAAM,iBAAiB,MAAM,YAAY,KAAK;AAE9C,cAAI,kBAAkB,cAAc,GAAG;AACrC,kBAAM,QAAQ,WAAW,GAAG;AAAA,UAC9B,OAAO;AACL,wBAAY;AAAA,cACV,eAAe;AAAA,cACf,eAAe,MAAM;AAAA,cACrB;AAAA,gBACE,WAAW,eAAe,MAAM;AAAA,cAClC;AAAA,YACF;AAAA,UACF;AAAA,QACF;AAAA,MACF;AAAA,IACF,WAAW,QAAQ,IAAI,aAAa,eAAe;AACjD,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AAAA,IACL;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,EACF;AACF;","names":[]}
@@ -1,4 +1,4 @@
1
1
  export { PersistQueryClientOptions, PersistQueryClientRootOptions, PersistedClient, PersistedQueryClientRestoreOptions, PersistedQueryClientSaveOptions, Persister, Promisable, persistQueryClient, persistQueryClientRestore, persistQueryClientSave, persistQueryClientSubscribe } from './persist.cjs';
2
2
  export { PersistRetryer, removeOldestQuery } from './retryStrategies.cjs';
3
- export { AsyncStorage, MaybePromise, PERSISTER_KEY_PREFIX, PersistedQuery, StoragePersisterOptions, experimental_createPersister } from './createPersister.cjs';
3
+ export { AsyncStorage, MaybePromise, PERSISTER_KEY_PREFIX, PersistedQuery, StoragePersisterOptions, experimental_createQueryPersister } from './createPersister.cjs';
4
4
  import '@tanstack/query-core';
@@ -1,4 +1,4 @@
1
1
  export { PersistQueryClientOptions, PersistQueryClientRootOptions, PersistedClient, PersistedQueryClientRestoreOptions, PersistedQueryClientSaveOptions, Persister, Promisable, persistQueryClient, persistQueryClientRestore, persistQueryClientSave, persistQueryClientSubscribe } from './persist.js';
2
2
  export { PersistRetryer, removeOldestQuery } from './retryStrategies.js';
3
- export { AsyncStorage, MaybePromise, PERSISTER_KEY_PREFIX, PersistedQuery, StoragePersisterOptions, experimental_createPersister } from './createPersister.js';
3
+ export { AsyncStorage, MaybePromise, PERSISTER_KEY_PREFIX, PersistedQuery, StoragePersisterOptions, experimental_createQueryPersister } from './createPersister.js';
4
4
  import '@tanstack/query-core';