@tanstack/query-persist-client-core 5.101.4 → 5.102.0

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.
Files changed (65) hide show
  1. package/build/legacy/createPersister.cjs +172 -256
  2. package/build/legacy/createPersister.cjs.map +1 -1
  3. package/build/legacy/createPersister.d.cts +88 -6
  4. package/build/legacy/createPersister.d.cts.map +1 -0
  5. package/build/legacy/createPersister.d.ts +88 -6
  6. package/build/legacy/createPersister.d.ts.map +1 -0
  7. package/build/legacy/createPersister.js +170 -235
  8. package/build/legacy/createPersister.js.map +1 -1
  9. package/build/legacy/index.cjs +14 -27
  10. package/build/legacy/index.cjs.map +1 -1
  11. package/build/legacy/index.d.cts +4 -19
  12. package/build/legacy/index.d.ts +4 -19
  13. package/build/legacy/index.js +8 -4
  14. package/build/legacy/index.js.map +1 -1
  15. package/build/legacy/persist.cjs +82 -108
  16. package/build/legacy/persist.cjs.map +1 -1
  17. package/build/legacy/persist.d.cts +61 -11
  18. package/build/legacy/persist.d.cts.map +1 -0
  19. package/build/legacy/persist.d.ts +61 -11
  20. package/build/legacy/persist.d.ts.map +1 -0
  21. package/build/legacy/persist.js +77 -79
  22. package/build/legacy/persist.js.map +1 -1
  23. package/build/legacy/retryStrategies.cjs +20 -44
  24. package/build/legacy/retryStrategies.cjs.map +1 -1
  25. package/build/legacy/retryStrategies.d.cts +11 -2
  26. package/build/legacy/retryStrategies.d.cts.map +1 -0
  27. package/build/legacy/retryStrategies.d.ts +11 -2
  28. package/build/legacy/retryStrategies.d.ts.map +1 -0
  29. package/build/legacy/retryStrategies.js +20 -20
  30. package/build/legacy/retryStrategies.js.map +1 -1
  31. package/build/modern/createPersister.cjs +172 -256
  32. package/build/modern/createPersister.cjs.map +1 -1
  33. package/build/modern/createPersister.d.cts +88 -6
  34. package/build/modern/createPersister.d.cts.map +1 -0
  35. package/build/modern/createPersister.d.ts +88 -6
  36. package/build/modern/createPersister.d.ts.map +1 -0
  37. package/build/modern/createPersister.js +170 -235
  38. package/build/modern/createPersister.js.map +1 -1
  39. package/build/modern/index.cjs +14 -27
  40. package/build/modern/index.cjs.map +1 -1
  41. package/build/modern/index.d.cts +4 -19
  42. package/build/modern/index.d.ts +4 -19
  43. package/build/modern/index.js +8 -4
  44. package/build/modern/index.js.map +1 -1
  45. package/build/modern/persist.cjs +82 -108
  46. package/build/modern/persist.cjs.map +1 -1
  47. package/build/modern/persist.d.cts +61 -11
  48. package/build/modern/persist.d.cts.map +1 -0
  49. package/build/modern/persist.d.ts +61 -11
  50. package/build/modern/persist.d.ts.map +1 -0
  51. package/build/modern/persist.js +77 -79
  52. package/build/modern/persist.js.map +1 -1
  53. package/build/modern/retryStrategies.cjs +20 -44
  54. package/build/modern/retryStrategies.cjs.map +1 -1
  55. package/build/modern/retryStrategies.d.cts +11 -2
  56. package/build/modern/retryStrategies.d.cts.map +1 -0
  57. package/build/modern/retryStrategies.d.ts +11 -2
  58. package/build/modern/retryStrategies.d.ts.map +1 -0
  59. package/build/modern/retryStrategies.js +20 -20
  60. package/build/modern/retryStrategies.js.map +1 -1
  61. package/package.json +4 -6
  62. package/build/legacy/_tsup-dts-rollup.d.cts +0 -214
  63. package/build/legacy/_tsup-dts-rollup.d.ts +0 -214
  64. package/build/modern/_tsup-dts-rollup.d.cts +0 -214
  65. package/build/modern/_tsup-dts-rollup.d.ts +0 -214
@@ -1,6 +1,88 @@
1
- export { experimental_createQueryPersister } from './_tsup-dts-rollup.js';
2
- export { PersistedQuery } from './_tsup-dts-rollup.js';
3
- export { MaybePromise } from './_tsup-dts-rollup.js';
4
- export { AsyncStorage } from './_tsup-dts-rollup.js';
5
- export { StoragePersisterOptions } from './_tsup-dts-rollup.js';
6
- export { PERSISTER_KEY_PREFIX } from './_tsup-dts-rollup.js';
1
+ import { Query, QueryClient, QueryFilters, QueryFunctionContext, QueryKey, QueryState } from "@tanstack/query-core";
2
+ //#region src/createPersister.d.ts
3
+ interface PersistedQuery {
4
+ buster: string;
5
+ queryHash: string;
6
+ queryKey: QueryKey;
7
+ state: QueryState;
8
+ }
9
+ type MaybePromise<T> = T | Promise<T>;
10
+ interface AsyncStorage<TStorageValue = string> {
11
+ getItem: (key: string) => MaybePromise<TStorageValue | undefined | null>;
12
+ setItem: (key: string, value: TStorageValue) => MaybePromise<unknown>;
13
+ removeItem: (key: string) => MaybePromise<void>;
14
+ entries?: () => MaybePromise<Array<[key: string, value: TStorageValue]>>;
15
+ }
16
+ interface StoragePersisterOptions<TStorageValue = string> {
17
+ /** The storage client used for setting and retrieving items from cache.
18
+ * For SSR pass in `undefined`.
19
+ */
20
+ storage: AsyncStorage<TStorageValue> | undefined | null;
21
+ /**
22
+ * How to serialize the data to storage.
23
+ * @default `JSON.stringify`
24
+ */
25
+ serialize?: (persistedQuery: PersistedQuery) => MaybePromise<TStorageValue>;
26
+ /**
27
+ * How to deserialize the data from storage.
28
+ * @default `JSON.parse`
29
+ */
30
+ deserialize?: (cachedString: TStorageValue) => MaybePromise<PersistedQuery>;
31
+ /**
32
+ * A unique string that can be used to forcefully invalidate existing caches,
33
+ * if they do not share the same buster string
34
+ */
35
+ buster?: string;
36
+ /**
37
+ * The max-allowed age of the cache in milliseconds.
38
+ * If a persisted cache is found that is older than this
39
+ * time, it will be discarded
40
+ * @default 24 hours
41
+ */
42
+ maxAge?: number;
43
+ /**
44
+ * Prefix to be used for storage key.
45
+ * Storage key is a combination of prefix and query hash in a form of `prefix-queryHash`.
46
+ * @default 'tanstack-query'
47
+ */
48
+ prefix?: string;
49
+ /**
50
+ * If set to `true`, the query will refetch on successful query restoration if the data is stale.
51
+ * If set to `false`, the query will not refetch on successful query restoration.
52
+ * If set to `'always'`, the query will always refetch on successful query restoration.
53
+ * Defaults to `true`.
54
+ */
55
+ refetchOnRestore?: boolean | 'always';
56
+ /**
57
+ * Filters to narrow down which Queries should be persisted.
58
+ */
59
+ filters?: QueryFilters;
60
+ }
61
+ declare const PERSISTER_KEY_PREFIX = "tanstack-query";
62
+ /**
63
+ * Warning: experimental feature.
64
+ * This utility function enables fine-grained query persistence.
65
+ * Simple add it as a `persister` parameter to `useQuery` or `defaultOptions` on `queryClient`.
66
+ *
67
+ * ```
68
+ * useQuery({
69
+ queryKey: ['myKey'],
70
+ queryFn: fetcher,
71
+ persister: createPersister({
72
+ storage: localStorage,
73
+ }),
74
+ })
75
+ ```
76
+ */
77
+ declare function experimental_createQueryPersister<TStorageValue = string>({ storage, buster, maxAge, serialize, deserialize, prefix, refetchOnRestore, filters }: StoragePersisterOptions<TStorageValue>): {
78
+ persisterFn: <T, TQueryKey extends QueryKey>(queryFn: (context: QueryFunctionContext<TQueryKey>) => T | Promise<T>, ctx: QueryFunctionContext<TQueryKey>, query: Query) => Promise<T>;
79
+ persistQuery: (query: Query) => Promise<void>;
80
+ persistQueryByKey: (queryKey: QueryKey, queryClient: QueryClient) => Promise<void>;
81
+ retrieveQuery: <T>(queryHash: string, afterRestoreMacroTask?: (persistedQuery: PersistedQuery) => void) => Promise<T | undefined>;
82
+ persisterGc: () => Promise<void>;
83
+ restoreQueries: (queryClient: QueryClient, filters?: Pick<QueryFilters, "queryKey" | "exact">) => Promise<void>;
84
+ removeQueries: (filters?: Pick<QueryFilters, "queryKey" | "exact">) => Promise<void>;
85
+ };
86
+ //#endregion
87
+ export { AsyncStorage, MaybePromise, PERSISTER_KEY_PREFIX, PersistedQuery, StoragePersisterOptions, experimental_createQueryPersister };
88
+ //# sourceMappingURL=createPersister.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"createPersister.d.ts","names":[],"sources":["../../src/createPersister.ts"],"mappings":";;UAeiB;EACf;EACA;EACA,UAAU;EACV,OAAO;;KAGG,aAAa,KAAK,IAAI,QAAQ;UAEzB,aAAa;EAC5B,UAAU,gBAAgB,aAAa;EACvC,UAAU,aAAa,OAAO,kBAAkB;EAChD,aAAa,gBAAgB;EAC7B,gBAAgB,aAAa,OAAO,aAAa,OAAO;;UAGzC,wBAAwB;;;;EAIvC,SAAS,aAAa;;;;;EAKtB,aAAa,gBAAgB,mBAAmB,aAAa;;;;;EAK7D,eAAe,cAAc,kBAAkB,aAAa;;;;;EAK5D;;;;;;;EAOA;;;;;;EAMA;;;;;;;EAOA;;;;EAIA,UAAU;;cAGC;;;;;;;;;;;;;;;;iBAiBG,kCAAkC,0BAChD,SACA,QACA,QACA,WAGA,aAGA,QACA,kBACA,WACC,wBAAwB;EA+FE,cAAA,GAAG,kBAAkB,UAAQ,UAC5C,SAAS,qBAAqB,eAAe,IAAI,QAAQ,IAAE,KAChE,qBAAqB,YAAU,OAC7B,UAAK,QAAA;EAlBqB,eAAA,OAAA,UAAK;EAlB5B,oBAAA,UAAA,UAAQ,aACL,gBAAW;EA9CG,gBAAA,GAAC,mBACX,yBACQ,gBAAgB,4BAAuB,QAAA;;EAmJnD,iBAAA,aAAA,aAAW,UACf,KAAK,wCACb;EA+CQ,gBAAA,UAAA,KAAK,wCACb"}
@@ -1,237 +1,172 @@
1
- // src/createPersister.ts
2
- import {
3
- hashKey,
4
- matchQuery,
5
- notifyManager,
6
- partialMatchKey
7
- } from "@tanstack/query-core";
8
- var PERSISTER_KEY_PREFIX = "tanstack-query";
9
- function experimental_createQueryPersister({
10
- storage,
11
- buster = "",
12
- maxAge = 1e3 * 60 * 60 * 24,
13
- serialize = JSON.stringify,
14
- deserialize = JSON.parse,
15
- prefix = PERSISTER_KEY_PREFIX,
16
- refetchOnRestore = true,
17
- filters
18
- }) {
19
- function isExpiredOrBusted(persistedQuery) {
20
- if (persistedQuery.state.dataUpdatedAt) {
21
- const queryAge = Date.now() - persistedQuery.state.dataUpdatedAt;
22
- const expired = queryAge > maxAge;
23
- const busted = persistedQuery.buster !== buster;
24
- if (expired || busted) {
25
- return true;
26
- }
27
- return false;
28
- }
29
- return true;
30
- }
31
- async function retrieveQuery(queryHash, afterRestoreMacroTask) {
32
- if (storage != null) {
33
- const storageKey = `${prefix}-${queryHash}`;
34
- try {
35
- const storedData = await storage.getItem(storageKey);
36
- if (storedData) {
37
- let persistedQuery;
38
- try {
39
- persistedQuery = await deserialize(storedData);
40
- } catch {
41
- await storage.removeItem(storageKey);
42
- return;
43
- }
44
- if (isExpiredOrBusted(persistedQuery)) {
45
- await storage.removeItem(storageKey);
46
- } else {
47
- if (afterRestoreMacroTask) {
48
- notifyManager.schedule(
49
- () => afterRestoreMacroTask(persistedQuery)
50
- );
51
- }
52
- return persistedQuery.state.data;
53
- }
54
- }
55
- } catch (err) {
56
- if (process.env.NODE_ENV === "development") {
57
- console.error(err);
58
- console.warn(
59
- "Encountered an error attempting to restore query cache from persisted location."
60
- );
61
- }
62
- await storage.removeItem(storageKey);
63
- }
64
- }
65
- return;
66
- }
67
- async function persistQueryByKey(queryKey, queryClient) {
68
- if (storage != null) {
69
- const query = queryClient.getQueryCache().find({ queryKey });
70
- if (query) {
71
- await persistQuery(query);
72
- } else {
73
- if (process.env.NODE_ENV === "development") {
74
- console.warn(
75
- "Could not find query to be persisted. QueryKey:",
76
- JSON.stringify(queryKey)
77
- );
78
- }
79
- }
80
- }
81
- }
82
- async function persistQuery(query) {
83
- if (storage != null) {
84
- const storageKey = `${prefix}-${query.queryHash}`;
85
- storage.setItem(
86
- storageKey,
87
- await serialize({
88
- state: query.state,
89
- queryKey: query.queryKey,
90
- queryHash: query.queryHash,
91
- buster
92
- })
93
- );
94
- }
95
- }
96
- async function persisterFn(queryFn, ctx, query) {
97
- const matchesFilter = filters ? matchQuery(filters, query) : true;
98
- if (matchesFilter && query.state.data === void 0 && storage != null) {
99
- const restoredData = await retrieveQuery(
100
- query.queryHash,
101
- (persistedQuery) => {
102
- query.setState({
103
- dataUpdatedAt: persistedQuery.state.dataUpdatedAt,
104
- errorUpdatedAt: persistedQuery.state.errorUpdatedAt
105
- });
106
- if (refetchOnRestore === "always" || refetchOnRestore === true && query.isStale()) {
107
- query.fetch();
108
- }
109
- }
110
- );
111
- if (restoredData !== void 0) {
112
- return Promise.resolve(restoredData);
113
- }
114
- }
115
- const queryFnResult = await queryFn(ctx);
116
- if (matchesFilter && storage != null) {
117
- notifyManager.schedule(() => {
118
- persistQuery(query);
119
- });
120
- }
121
- return Promise.resolve(queryFnResult);
122
- }
123
- async function persisterGc() {
124
- if (storage?.entries) {
125
- const storageKeyPrefix = `${prefix}-`;
126
- const entries = await storage.entries();
127
- for (const [key, value] of entries) {
128
- if (key.startsWith(storageKeyPrefix)) {
129
- let persistedQuery;
130
- try {
131
- persistedQuery = await deserialize(value);
132
- } catch {
133
- await storage.removeItem(key);
134
- continue;
135
- }
136
- if (isExpiredOrBusted(persistedQuery)) {
137
- await storage.removeItem(key);
138
- }
139
- }
140
- }
141
- } else if (process.env.NODE_ENV === "development") {
142
- throw new Error(
143
- "Provided storage does not implement `entries` method. Garbage collection is not possible without ability to iterate over storage items."
144
- );
145
- }
146
- }
147
- async function restoreQueries(queryClient, filters2 = {}) {
148
- const { exact, queryKey } = filters2;
149
- if (storage?.entries) {
150
- const storageKeyPrefix = `${prefix}-`;
151
- const entries = await storage.entries();
152
- for (const [key, value] of entries) {
153
- if (key.startsWith(storageKeyPrefix)) {
154
- let persistedQuery;
155
- try {
156
- persistedQuery = await deserialize(value);
157
- } catch {
158
- await storage.removeItem(key);
159
- continue;
160
- }
161
- if (isExpiredOrBusted(persistedQuery)) {
162
- await storage.removeItem(key);
163
- continue;
164
- }
165
- if (queryKey) {
166
- if (exact) {
167
- if (persistedQuery.queryHash !== hashKey(queryKey)) {
168
- continue;
169
- }
170
- } else if (!partialMatchKey(persistedQuery.queryKey, queryKey)) {
171
- continue;
172
- }
173
- }
174
- queryClient.setQueryData(
175
- persistedQuery.queryKey,
176
- persistedQuery.state.data,
177
- {
178
- updatedAt: persistedQuery.state.dataUpdatedAt
179
- }
180
- );
181
- }
182
- }
183
- } else if (process.env.NODE_ENV === "development") {
184
- throw new Error(
185
- "Provided storage does not implement `entries` method. Restoration of all stored entries is not possible without ability to iterate over storage items."
186
- );
187
- }
188
- }
189
- async function removeQueries(filters2 = {}) {
190
- const { exact, queryKey } = filters2;
191
- if (storage?.entries) {
192
- const entries = await storage.entries();
193
- const storageKeyPrefix = `${prefix}-`;
194
- for (const [key, value] of entries) {
195
- if (key.startsWith(storageKeyPrefix)) {
196
- if (!queryKey) {
197
- await storage.removeItem(key);
198
- continue;
199
- }
200
- let persistedQuery;
201
- try {
202
- persistedQuery = await deserialize(value);
203
- } catch {
204
- await storage.removeItem(key);
205
- continue;
206
- }
207
- if (exact) {
208
- if (persistedQuery.queryHash !== hashKey(queryKey)) {
209
- continue;
210
- }
211
- } else if (!partialMatchKey(persistedQuery.queryKey, queryKey)) {
212
- continue;
213
- }
214
- await storage.removeItem(key);
215
- }
216
- }
217
- } else if (process.env.NODE_ENV === "development") {
218
- throw new Error(
219
- "Provided storage does not implement `entries` method. Removal of stored entries is not possible without ability to iterate over storage items."
220
- );
221
- }
222
- }
223
- return {
224
- persisterFn,
225
- persistQuery,
226
- persistQueryByKey,
227
- retrieveQuery,
228
- persisterGc,
229
- restoreQueries,
230
- removeQueries
231
- };
1
+ import { hashKey, matchQuery, notifyManager, partialMatchKey } from "@tanstack/query-core";
2
+ //#region src/createPersister.ts
3
+ const PERSISTER_KEY_PREFIX = "tanstack-query";
4
+ /**
5
+ * Warning: experimental feature.
6
+ * This utility function enables fine-grained query persistence.
7
+ * Simple add it as a `persister` parameter to `useQuery` or `defaultOptions` on `queryClient`.
8
+ *
9
+ * ```
10
+ * useQuery({
11
+ queryKey: ['myKey'],
12
+ queryFn: fetcher,
13
+ persister: createPersister({
14
+ storage: localStorage,
15
+ }),
16
+ })
17
+ ```
18
+ */
19
+ function experimental_createQueryPersister({ storage, buster = "", maxAge = 864e5, serialize = JSON.stringify, deserialize = JSON.parse, prefix = PERSISTER_KEY_PREFIX, refetchOnRestore = true, filters }) {
20
+ function isExpiredOrBusted(persistedQuery) {
21
+ if (persistedQuery.state.dataUpdatedAt) {
22
+ const expired = Date.now() - persistedQuery.state.dataUpdatedAt > maxAge;
23
+ const busted = persistedQuery.buster !== buster;
24
+ if (expired || busted) return true;
25
+ return false;
26
+ }
27
+ return true;
28
+ }
29
+ async function retrieveQuery(queryHash, afterRestoreMacroTask) {
30
+ if (storage != null) {
31
+ const storageKey = `${prefix}-${queryHash}`;
32
+ try {
33
+ const storedData = await storage.getItem(storageKey);
34
+ if (storedData) {
35
+ let persistedQuery;
36
+ try {
37
+ persistedQuery = await deserialize(storedData);
38
+ } catch {
39
+ await storage.removeItem(storageKey);
40
+ return;
41
+ }
42
+ if (isExpiredOrBusted(persistedQuery)) await storage.removeItem(storageKey);
43
+ else {
44
+ if (afterRestoreMacroTask) notifyManager.schedule(() => afterRestoreMacroTask(persistedQuery));
45
+ return persistedQuery.state.data;
46
+ }
47
+ }
48
+ } catch (err) {
49
+ if (process.env.NODE_ENV === "development") {
50
+ console.error(err);
51
+ console.warn("Encountered an error attempting to restore query cache from persisted location.");
52
+ }
53
+ await storage.removeItem(storageKey);
54
+ }
55
+ }
56
+ }
57
+ async function persistQueryByKey(queryKey, queryClient) {
58
+ if (storage != null) {
59
+ const query = queryClient.getQueryCache().find({ queryKey });
60
+ if (query) await persistQuery(query);
61
+ else if (process.env.NODE_ENV === "development") console.warn("Could not find query to be persisted. QueryKey:", JSON.stringify(queryKey));
62
+ }
63
+ }
64
+ async function persistQuery(query) {
65
+ if (storage != null) {
66
+ const storageKey = `${prefix}-${query.queryHash}`;
67
+ storage.setItem(storageKey, await serialize({
68
+ state: query.state,
69
+ queryKey: query.queryKey,
70
+ queryHash: query.queryHash,
71
+ buster
72
+ }));
73
+ }
74
+ }
75
+ async function persisterFn(queryFn, ctx, query) {
76
+ const matchesFilter = filters ? matchQuery(filters, query) : true;
77
+ if (matchesFilter && query.state.data === void 0 && storage != null) {
78
+ const restoredData = await retrieveQuery(query.queryHash, (persistedQuery) => {
79
+ query.setState({
80
+ dataUpdatedAt: persistedQuery.state.dataUpdatedAt,
81
+ errorUpdatedAt: persistedQuery.state.errorUpdatedAt
82
+ });
83
+ if (refetchOnRestore === "always" || refetchOnRestore === true && query.isStale()) query.fetch();
84
+ });
85
+ if (restoredData !== void 0) return Promise.resolve(restoredData);
86
+ }
87
+ const queryFnResult = await queryFn(ctx);
88
+ if (matchesFilter && storage != null) notifyManager.schedule(() => {
89
+ persistQuery(query);
90
+ });
91
+ return Promise.resolve(queryFnResult);
92
+ }
93
+ async function persisterGc() {
94
+ if (storage?.entries) {
95
+ const storageKeyPrefix = `${prefix}-`;
96
+ const entries = await storage.entries();
97
+ for (const [key, value] of entries) if (key.startsWith(storageKeyPrefix)) {
98
+ let persistedQuery;
99
+ try {
100
+ persistedQuery = await deserialize(value);
101
+ } catch {
102
+ await storage.removeItem(key);
103
+ continue;
104
+ }
105
+ if (isExpiredOrBusted(persistedQuery)) await storage.removeItem(key);
106
+ }
107
+ } else if (process.env.NODE_ENV === "development") throw new Error("Provided storage does not implement `entries` method. Garbage collection is not possible without ability to iterate over storage items.");
108
+ }
109
+ async function restoreQueries(queryClient, filters = {}) {
110
+ const { exact, queryKey } = filters;
111
+ if (storage?.entries) {
112
+ const storageKeyPrefix = `${prefix}-`;
113
+ const entries = await storage.entries();
114
+ for (const [key, value] of entries) if (key.startsWith(storageKeyPrefix)) {
115
+ let persistedQuery;
116
+ try {
117
+ persistedQuery = await deserialize(value);
118
+ } catch {
119
+ await storage.removeItem(key);
120
+ continue;
121
+ }
122
+ if (isExpiredOrBusted(persistedQuery)) {
123
+ await storage.removeItem(key);
124
+ continue;
125
+ }
126
+ if (queryKey) {
127
+ if (exact) {
128
+ if (persistedQuery.queryHash !== hashKey(queryKey)) continue;
129
+ } else if (!partialMatchKey(persistedQuery.queryKey, queryKey)) continue;
130
+ }
131
+ queryClient.setQueryData(persistedQuery.queryKey, persistedQuery.state.data, { updatedAt: persistedQuery.state.dataUpdatedAt });
132
+ }
133
+ } else if (process.env.NODE_ENV === "development") throw new Error("Provided storage does not implement `entries` method. Restoration of all stored entries is not possible without ability to iterate over storage items.");
134
+ }
135
+ async function removeQueries(filters = {}) {
136
+ const { exact, queryKey } = filters;
137
+ if (storage?.entries) {
138
+ const entries = await storage.entries();
139
+ const storageKeyPrefix = `${prefix}-`;
140
+ for (const [key, value] of entries) if (key.startsWith(storageKeyPrefix)) {
141
+ if (!queryKey) {
142
+ await storage.removeItem(key);
143
+ continue;
144
+ }
145
+ let persistedQuery;
146
+ try {
147
+ persistedQuery = await deserialize(value);
148
+ } catch {
149
+ await storage.removeItem(key);
150
+ continue;
151
+ }
152
+ if (exact) {
153
+ if (persistedQuery.queryHash !== hashKey(queryKey)) continue;
154
+ } else if (!partialMatchKey(persistedQuery.queryKey, queryKey)) continue;
155
+ await storage.removeItem(key);
156
+ }
157
+ } else if (process.env.NODE_ENV === "development") throw new Error("Provided storage does not implement `entries` method. Removal of stored entries is not possible without ability to iterate over storage items.");
158
+ }
159
+ return {
160
+ persisterFn,
161
+ persistQuery,
162
+ persistQueryByKey,
163
+ retrieveQuery,
164
+ persisterGc,
165
+ restoreQueries,
166
+ removeQueries
167
+ };
232
168
  }
233
- export {
234
- PERSISTER_KEY_PREFIX,
235
- experimental_createQueryPersister
236
- };
169
+ //#endregion
170
+ export { PERSISTER_KEY_PREFIX, experimental_createQueryPersister };
171
+
237
172
  //# sourceMappingURL=createPersister.js.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/createPersister.ts"],"sourcesContent":["import {\n hashKey,\n matchQuery,\n notifyManager,\n partialMatchKey,\n} 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 * If set to `true`, the query will refetch on successful query restoration if the data is stale.\n * If set to `false`, the query will not refetch on successful query restoration.\n * If set to `'always'`, the query will always refetch on successful query restoration.\n * Defaults to `true`.\n */\n refetchOnRestore?: boolean | 'always'\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 refetchOnRestore = true,\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 let persistedQuery: PersistedQuery\n try {\n persistedQuery = await deserialize(storedData)\n } catch {\n await storage.removeItem(storageKey)\n return\n }\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 notifyManager.schedule(() =>\n afterRestoreMacroTask(persistedQuery),\n )\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 (\n refetchOnRestore === 'always' ||\n (refetchOnRestore === true && query.isStale())\n ) {\n query.fetch()\n }\n },\n )\n\n if (restoredData !== undefined) {\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 notifyManager.schedule(() => {\n persistQuery(query)\n })\n }\n\n return Promise.resolve(queryFnResult)\n }\n\n async function persisterGc() {\n if (storage?.entries) {\n const storageKeyPrefix = `${prefix}-`\n const entries = await storage.entries()\n for (const [key, value] of entries) {\n if (key.startsWith(storageKeyPrefix)) {\n let persistedQuery: PersistedQuery\n try {\n persistedQuery = await deserialize(value)\n } catch {\n await storage.removeItem(key)\n continue\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 restoreQueries(\n queryClient: QueryClient,\n filters: Pick<QueryFilters, 'queryKey' | 'exact'> = {},\n ): Promise<void> {\n const { exact, queryKey } = filters\n\n if (storage?.entries) {\n const storageKeyPrefix = `${prefix}-`\n const entries = await storage.entries()\n for (const [key, value] of entries) {\n if (key.startsWith(storageKeyPrefix)) {\n let persistedQuery: PersistedQuery\n try {\n persistedQuery = await deserialize(value)\n } catch {\n await storage.removeItem(key)\n continue\n }\n if (isExpiredOrBusted(persistedQuery)) {\n await storage.removeItem(key)\n continue\n }\n\n if (queryKey) {\n if (exact) {\n if (persistedQuery.queryHash !== hashKey(queryKey)) {\n continue\n }\n } else if (!partialMatchKey(persistedQuery.queryKey, queryKey)) {\n continue\n }\n }\n\n queryClient.setQueryData(\n persistedQuery.queryKey,\n persistedQuery.state.data,\n {\n updatedAt: persistedQuery.state.dataUpdatedAt,\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 async function removeQueries(\n filters: Pick<QueryFilters, 'queryKey' | 'exact'> = {},\n ): Promise<void> {\n const { exact, queryKey } = filters\n\n if (storage?.entries) {\n const entries = await storage.entries()\n const storageKeyPrefix = `${prefix}-`\n for (const [key, value] of entries) {\n if (key.startsWith(storageKeyPrefix)) {\n if (!queryKey) {\n await storage.removeItem(key)\n continue\n }\n\n let persistedQuery: PersistedQuery\n try {\n persistedQuery = await deserialize(value)\n } catch {\n await storage.removeItem(key)\n continue\n }\n\n if (exact) {\n if (persistedQuery.queryHash !== hashKey(queryKey)) {\n continue\n }\n } else if (!partialMatchKey(persistedQuery.queryKey, queryKey)) {\n continue\n }\n\n await storage.removeItem(key)\n }\n }\n } else if (process.env.NODE_ENV === 'development') {\n throw new Error(\n 'Provided storage does not implement `entries` method. Removal of 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 restoreQueries,\n removeQueries,\n }\n}\n"],"mappings":";AAAA;AAAA,EACE;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,OACK;AAwEA,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,mBAAmB;AAAA,EACnB;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,cAAI;AACJ,cAAI;AACF,6BAAiB,MAAM,YAAY,UAAU;AAAA,UAC/C,QAAQ;AACN,kBAAM,QAAQ,WAAW,UAAU;AACnC;AAAA,UACF;AAEA,cAAI,kBAAkB,cAAc,GAAG;AACrC,kBAAM,QAAQ,WAAW,UAAU;AAAA,UACrC,OAAO;AACL,gBAAI,uBAAuB;AAEzB,4BAAc;AAAA,gBAAS,MACrB,sBAAsB,cAAc;AAAA,cACtC;AAAA,YACF;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,cACE,qBAAqB,YACpB,qBAAqB,QAAQ,MAAM,QAAQ,GAC5C;AACA,kBAAM,MAAM;AAAA,UACd;AAAA,QACF;AAAA,MACF;AAEA,UAAI,iBAAiB,QAAW;AAC9B,eAAO,QAAQ,QAAQ,YAAiB;AAAA,MAC1C;AAAA,IACF;AAGA,UAAM,gBAAgB,MAAM,QAAQ,GAAG;AAEvC,QAAI,iBAAiB,WAAW,MAAM;AAEpC,oBAAc,SAAS,MAAM;AAC3B,qBAAa,KAAK;AAAA,MACpB,CAAC;AAAA,IACH;AAEA,WAAO,QAAQ,QAAQ,aAAa;AAAA,EACtC;AAEA,iBAAe,cAAc;AAC3B,QAAI,SAAS,SAAS;AACpB,YAAM,mBAAmB,GAAG,MAAM;AAClC,YAAM,UAAU,MAAM,QAAQ,QAAQ;AACtC,iBAAW,CAAC,KAAK,KAAK,KAAK,SAAS;AAClC,YAAI,IAAI,WAAW,gBAAgB,GAAG;AACpC,cAAI;AACJ,cAAI;AACF,6BAAiB,MAAM,YAAY,KAAK;AAAA,UAC1C,QAAQ;AACN,kBAAM,QAAQ,WAAW,GAAG;AAC5B;AAAA,UACF;AACA,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,eACb,aACAA,WAAoD,CAAC,GACtC;AACf,UAAM,EAAE,OAAO,SAAS,IAAIA;AAE5B,QAAI,SAAS,SAAS;AACpB,YAAM,mBAAmB,GAAG,MAAM;AAClC,YAAM,UAAU,MAAM,QAAQ,QAAQ;AACtC,iBAAW,CAAC,KAAK,KAAK,KAAK,SAAS;AAClC,YAAI,IAAI,WAAW,gBAAgB,GAAG;AACpC,cAAI;AACJ,cAAI;AACF,6BAAiB,MAAM,YAAY,KAAK;AAAA,UAC1C,QAAQ;AACN,kBAAM,QAAQ,WAAW,GAAG;AAC5B;AAAA,UACF;AACA,cAAI,kBAAkB,cAAc,GAAG;AACrC,kBAAM,QAAQ,WAAW,GAAG;AAC5B;AAAA,UACF;AAEA,cAAI,UAAU;AACZ,gBAAI,OAAO;AACT,kBAAI,eAAe,cAAc,QAAQ,QAAQ,GAAG;AAClD;AAAA,cACF;AAAA,YACF,WAAW,CAAC,gBAAgB,eAAe,UAAU,QAAQ,GAAG;AAC9D;AAAA,YACF;AAAA,UACF;AAEA,sBAAY;AAAA,YACV,eAAe;AAAA,YACf,eAAe,MAAM;AAAA,YACrB;AAAA,cACE,WAAW,eAAe,MAAM;AAAA,YAClC;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,iBAAe,cACbA,WAAoD,CAAC,GACtC;AACf,UAAM,EAAE,OAAO,SAAS,IAAIA;AAE5B,QAAI,SAAS,SAAS;AACpB,YAAM,UAAU,MAAM,QAAQ,QAAQ;AACtC,YAAM,mBAAmB,GAAG,MAAM;AAClC,iBAAW,CAAC,KAAK,KAAK,KAAK,SAAS;AAClC,YAAI,IAAI,WAAW,gBAAgB,GAAG;AACpC,cAAI,CAAC,UAAU;AACb,kBAAM,QAAQ,WAAW,GAAG;AAC5B;AAAA,UACF;AAEA,cAAI;AACJ,cAAI;AACF,6BAAiB,MAAM,YAAY,KAAK;AAAA,UAC1C,QAAQ;AACN,kBAAM,QAAQ,WAAW,GAAG;AAC5B;AAAA,UACF;AAEA,cAAI,OAAO;AACT,gBAAI,eAAe,cAAc,QAAQ,QAAQ,GAAG;AAClD;AAAA,YACF;AAAA,UACF,WAAW,CAAC,gBAAgB,eAAe,UAAU,QAAQ,GAAG;AAC9D;AAAA,UACF;AAEA,gBAAM,QAAQ,WAAW,GAAG;AAAA,QAC9B;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,IACA;AAAA,EACF;AACF;","names":["filters"]}
1
+ {"version":3,"file":"createPersister.js","names":[],"sources":["../../src/createPersister.ts"],"sourcesContent":["import {\n hashKey,\n matchQuery,\n notifyManager,\n partialMatchKey,\n} 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 * If set to `true`, the query will refetch on successful query restoration if the data is stale.\n * If set to `false`, the query will not refetch on successful query restoration.\n * If set to `'always'`, the query will always refetch on successful query restoration.\n * Defaults to `true`.\n */\n refetchOnRestore?: boolean | 'always'\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 refetchOnRestore = true,\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 let persistedQuery: PersistedQuery\n try {\n persistedQuery = await deserialize(storedData)\n } catch {\n await storage.removeItem(storageKey)\n return\n }\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 notifyManager.schedule(() =>\n afterRestoreMacroTask(persistedQuery),\n )\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 (\n refetchOnRestore === 'always' ||\n (refetchOnRestore === true && query.isStale())\n ) {\n query.fetch()\n }\n },\n )\n\n if (restoredData !== undefined) {\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 notifyManager.schedule(() => {\n persistQuery(query)\n })\n }\n\n return Promise.resolve(queryFnResult)\n }\n\n async function persisterGc() {\n if (storage?.entries) {\n const storageKeyPrefix = `${prefix}-`\n const entries = await storage.entries()\n for (const [key, value] of entries) {\n if (key.startsWith(storageKeyPrefix)) {\n let persistedQuery: PersistedQuery\n try {\n persistedQuery = await deserialize(value)\n } catch {\n await storage.removeItem(key)\n continue\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 restoreQueries(\n queryClient: QueryClient,\n filters: Pick<QueryFilters, 'queryKey' | 'exact'> = {},\n ): Promise<void> {\n const { exact, queryKey } = filters\n\n if (storage?.entries) {\n const storageKeyPrefix = `${prefix}-`\n const entries = await storage.entries()\n for (const [key, value] of entries) {\n if (key.startsWith(storageKeyPrefix)) {\n let persistedQuery: PersistedQuery\n try {\n persistedQuery = await deserialize(value)\n } catch {\n await storage.removeItem(key)\n continue\n }\n if (isExpiredOrBusted(persistedQuery)) {\n await storage.removeItem(key)\n continue\n }\n\n if (queryKey) {\n if (exact) {\n if (persistedQuery.queryHash !== hashKey(queryKey)) {\n continue\n }\n } else if (!partialMatchKey(persistedQuery.queryKey, queryKey)) {\n continue\n }\n }\n\n queryClient.setQueryData(\n persistedQuery.queryKey,\n persistedQuery.state.data,\n {\n updatedAt: persistedQuery.state.dataUpdatedAt,\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 async function removeQueries(\n filters: Pick<QueryFilters, 'queryKey' | 'exact'> = {},\n ): Promise<void> {\n const { exact, queryKey } = filters\n\n if (storage?.entries) {\n const entries = await storage.entries()\n const storageKeyPrefix = `${prefix}-`\n for (const [key, value] of entries) {\n if (key.startsWith(storageKeyPrefix)) {\n if (!queryKey) {\n await storage.removeItem(key)\n continue\n }\n\n let persistedQuery: PersistedQuery\n try {\n persistedQuery = await deserialize(value)\n } catch {\n await storage.removeItem(key)\n continue\n }\n\n if (exact) {\n if (persistedQuery.queryHash !== hashKey(queryKey)) {\n continue\n }\n } else if (!partialMatchKey(persistedQuery.queryKey, queryKey)) {\n continue\n }\n\n await storage.removeItem(key)\n }\n }\n } else if (process.env.NODE_ENV === 'development') {\n throw new Error(\n 'Provided storage does not implement `entries` method. Removal of 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 restoreQueries,\n removeQueries,\n }\n}\n"],"mappings":";;AA6EA,MAAa,uBAAuB;;;;;;;;;;;;;;;;AAiBpC,SAAgB,kCAA0D,EACxE,SACA,SAAS,IACT,SAAS,OACT,YAAY,KAAK,WAGjB,cAAc,KAAK,OAGnB,SAAS,sBACT,mBAAmB,MACnB,WACyC;CACzC,SAAS,kBAAkB,gBAAgC;EACzD,IAAI,eAAe,MAAM,eAAe;GAEtC,MAAM,UADW,KAAK,IAAI,IAAI,eAAe,MAAM,gBACxB;GAC3B,MAAM,SAAS,eAAe,WAAW;GAEzC,IAAI,WAAW,QACb,OAAO;GAGT,OAAO;EACT;EAEA,OAAO;CACT;CAEA,eAAe,cACb,WACA,uBACA;EACA,IAAI,WAAW,MAAM;GACnB,MAAM,aAAa,GAAG,OAAO,GAAG;GAChC,IAAI;IACF,MAAM,aAAa,MAAM,QAAQ,QAAQ,UAAU;IACnD,IAAI,YAAY;KACd,IAAI;KACJ,IAAI;MACF,iBAAiB,MAAM,YAAY,UAAU;KAC/C,QAAQ;MACN,MAAM,QAAQ,WAAW,UAAU;MACnC;KACF;KAEA,IAAI,kBAAkB,cAAc,GAClC,MAAM,QAAQ,WAAW,UAAU;UAC9B;MACL,IAAI,uBAEF,cAAc,eACZ,sBAAsB,cAAc,CACtC;MAGF,OAAO,eAAe,MAAM;KAC9B;IACF;GACF,SAAS,KAAK;IACZ,IAAI,QAAQ,IAAI,aAAa,eAAe;KAC1C,QAAQ,MAAM,GAAG;KACjB,QAAQ,KACN,iFACF;IACF;IACA,MAAM,QAAQ,WAAW,UAAU;GACrC;EACF;CAGF;CAEA,eAAe,kBACb,UACA,aACA;EACA,IAAI,WAAW,MAAM;GACnB,MAAM,QAAQ,YAAY,cAAc,CAAC,CAAC,KAAK,EAAE,SAAS,CAAC;GAC3D,IAAI,OACF,MAAM,aAAa,KAAK;QAExB,IAAI,QAAQ,IAAI,aAAa,eAC3B,QAAQ,KACN,mDACA,KAAK,UAAU,QAAQ,CACzB;EAGN;CACF;CAEA,eAAe,aAAa,OAAc;EACxC,IAAI,WAAW,MAAM;GACnB,MAAM,aAAa,GAAG,OAAO,GAAG,MAAM;GACtC,QAAQ,QACN,YACA,MAAM,UAAU;IACd,OAAO,MAAM;IACb,UAAU,MAAM;IAChB,WAAW,MAAM;IACT;GACV,CAAC,CACH;EACF;CACF;CAEA,eAAe,YACb,SACA,KACA,OACA;EACA,MAAM,gBAAgB,UAAU,WAAW,SAAS,KAAK,IAAI;EAG7D,IAAI,iBAAiB,MAAM,MAAM,SAAS,KAAA,KAAa,WAAW,MAAM;GACtE,MAAM,eAAe,MAAM,cACzB,MAAM,YACL,mBAAmC;IAElC,MAAM,SAAS;KACb,eAAe,eAAe,MAAM;KACpC,gBAAgB,eAAe,MAAM;IACvC,CAAC;IAED,IACE,qBAAqB,YACpB,qBAAqB,QAAQ,MAAM,QAAQ,GAE5C,MAAM,MAAM;GAEhB,CACF;GAEA,IAAI,iBAAiB,KAAA,GACnB,OAAO,QAAQ,QAAQ,YAAiB;EAE5C;EAGA,MAAM,gBAAgB,MAAM,QAAQ,GAAG;EAEvC,IAAI,iBAAiB,WAAW,MAE9B,cAAc,eAAe;GAC3B,aAAa,KAAK;EACpB,CAAC;EAGH,OAAO,QAAQ,QAAQ,aAAa;CACtC;CAEA,eAAe,cAAc;EAC3B,IAAI,SAAS,SAAS;GACpB,MAAM,mBAAmB,GAAG,OAAO;GACnC,MAAM,UAAU,MAAM,QAAQ,QAAQ;GACtC,KAAK,MAAM,CAAC,KAAK,UAAU,SACzB,IAAI,IAAI,WAAW,gBAAgB,GAAG;IACpC,IAAI;IACJ,IAAI;KACF,iBAAiB,MAAM,YAAY,KAAK;IAC1C,QAAQ;KACN,MAAM,QAAQ,WAAW,GAAG;KAC5B;IACF;IACA,IAAI,kBAAkB,cAAc,GAClC,MAAM,QAAQ,WAAW,GAAG;GAEhC;EAEJ,OAAO,IAAI,QAAQ,IAAI,aAAa,eAClC,MAAM,IAAI,MACR,yIACF;CAEJ;CAEA,eAAe,eACb,aACA,UAAoD,CAAC,GACtC;EACf,MAAM,EAAE,OAAO,aAAa;EAE5B,IAAI,SAAS,SAAS;GACpB,MAAM,mBAAmB,GAAG,OAAO;GACnC,MAAM,UAAU,MAAM,QAAQ,QAAQ;GACtC,KAAK,MAAM,CAAC,KAAK,UAAU,SACzB,IAAI,IAAI,WAAW,gBAAgB,GAAG;IACpC,IAAI;IACJ,IAAI;KACF,iBAAiB,MAAM,YAAY,KAAK;IAC1C,QAAQ;KACN,MAAM,QAAQ,WAAW,GAAG;KAC5B;IACF;IACA,IAAI,kBAAkB,cAAc,GAAG;KACrC,MAAM,QAAQ,WAAW,GAAG;KAC5B;IACF;IAEA,IAAI,UAAU;KACZ,IAAI,OACE;UAAA,eAAe,cAAc,QAAQ,QAAQ,GAC/C;KAAA,OAEG,IAAI,CAAC,gBAAgB,eAAe,UAAU,QAAQ,GAC3D;IAEJ;IAEA,YAAY,aACV,eAAe,UACf,eAAe,MAAM,MACrB,EACE,WAAW,eAAe,MAAM,cAClC,CACF;GACF;EAEJ,OAAO,IAAI,QAAQ,IAAI,aAAa,eAClC,MAAM,IAAI,MACR,wJACF;CAEJ;CAEA,eAAe,cACb,UAAoD,CAAC,GACtC;EACf,MAAM,EAAE,OAAO,aAAa;EAE5B,IAAI,SAAS,SAAS;GACpB,MAAM,UAAU,MAAM,QAAQ,QAAQ;GACtC,MAAM,mBAAmB,GAAG,OAAO;GACnC,KAAK,MAAM,CAAC,KAAK,UAAU,SACzB,IAAI,IAAI,WAAW,gBAAgB,GAAG;IACpC,IAAI,CAAC,UAAU;KACb,MAAM,QAAQ,WAAW,GAAG;KAC5B;IACF;IAEA,IAAI;IACJ,IAAI;KACF,iBAAiB,MAAM,YAAY,KAAK;IAC1C,QAAQ;KACN,MAAM,QAAQ,WAAW,GAAG;KAC5B;IACF;IAEA,IAAI,OACE;SAAA,eAAe,cAAc,QAAQ,QAAQ,GAC/C;IAAA,OAEG,IAAI,CAAC,gBAAgB,eAAe,UAAU,QAAQ,GAC3D;IAGF,MAAM,QAAQ,WAAW,GAAG;GAC9B;EAEJ,OAAO,IAAI,QAAQ,IAAI,aAAa,eAClC,MAAM,IAAI,MACR,gJACF;CAEJ;CAEA,OAAO;EACL;EACA;EACA;EACA;EACA;EACA;EACA;CACF;AACF"}
@@ -1,29 +1,16 @@
1
- "use strict";
2
- var __defProp = Object.defineProperty;
3
- var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
4
- var __getOwnPropNames = Object.getOwnPropertyNames;
5
- var __hasOwnProp = Object.prototype.hasOwnProperty;
6
- var __copyProps = (to, from, except, desc) => {
7
- if (from && typeof from === "object" || typeof from === "function") {
8
- for (let key of __getOwnPropNames(from))
9
- if (!__hasOwnProp.call(to, key) && key !== except)
10
- __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
11
- }
12
- return to;
13
- };
14
- var __reExport = (target, mod, secondTarget) => (__copyProps(target, mod, "default"), secondTarget && __copyProps(secondTarget, mod, "default"));
15
- var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
1
+ Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
2
+ const require_createPersister = require("./createPersister.cjs");
3
+ const require_persist = require("./persist.cjs");
4
+ const require_retryStrategies = require("./retryStrategies.cjs");
5
+ //#region src/index.ts
6
+ /* istanbul ignore file */
7
+ //#endregion
8
+ exports.PERSISTER_KEY_PREFIX = require_createPersister.PERSISTER_KEY_PREFIX;
9
+ exports.experimental_createQueryPersister = require_createPersister.experimental_createQueryPersister;
10
+ exports.persistQueryClient = require_persist.persistQueryClient;
11
+ exports.persistQueryClientRestore = require_persist.persistQueryClientRestore;
12
+ exports.persistQueryClientSave = require_persist.persistQueryClientSave;
13
+ exports.persistQueryClientSubscribe = require_persist.persistQueryClientSubscribe;
14
+ exports.removeOldestQuery = require_retryStrategies.removeOldestQuery;
16
15
 
17
- // src/index.ts
18
- var index_exports = {};
19
- module.exports = __toCommonJS(index_exports);
20
- __reExport(index_exports, require("./persist.cjs"), module.exports);
21
- __reExport(index_exports, require("./retryStrategies.cjs"), module.exports);
22
- __reExport(index_exports, require("./createPersister.cjs"), module.exports);
23
- // Annotate the CommonJS export names for ESM import in node:
24
- 0 && (module.exports = {
25
- ...require("./persist.cjs"),
26
- ...require("./retryStrategies.cjs"),
27
- ...require("./createPersister.cjs")
28
- });
29
16
  //# sourceMappingURL=index.cjs.map
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/index.ts"],"sourcesContent":["/* istanbul ignore file */\n\nexport * from './persist'\nexport * from './retryStrategies'\nexport * from './createPersister'\n"],"mappings":";;;;;;;;;;;;;;;;;AAAA;AAAA;AAEA,0BAAc,0BAFd;AAGA,0BAAc,kCAHd;AAIA,0BAAc,kCAJd;","names":[]}
1
+ {"version":3,"file":"index.cjs","names":[],"sources":["../../src/index.ts"],"sourcesContent":["/* istanbul ignore file */\n\nexport * from './persist'\nexport * from './retryStrategies'\nexport * from './createPersister'\n"],"mappings":""}