@tanstack/query-persist-client-core 5.8.7 → 5.12.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.
- package/build/legacy/createPersister.cjs +3 -3
- package/build/legacy/createPersister.cjs.map +1 -1
- package/build/legacy/createPersister.d.cts +11 -10
- package/build/legacy/createPersister.d.ts +11 -10
- package/build/legacy/createPersister.js +3 -3
- package/build/legacy/createPersister.js.map +1 -1
- package/build/legacy/index.d.cts +1 -1
- package/build/legacy/index.d.ts +1 -1
- package/build/legacy/persist.d.cts +1 -1
- package/build/legacy/persist.d.ts +1 -1
- package/build/legacy/retryStrategies.d.cts +1 -1
- package/build/legacy/retryStrategies.d.ts +1 -1
- package/build/modern/createPersister.cjs +3 -3
- package/build/modern/createPersister.cjs.map +1 -1
- package/build/modern/createPersister.d.cts +11 -10
- package/build/modern/createPersister.d.ts +11 -10
- package/build/modern/createPersister.js +3 -3
- package/build/modern/createPersister.js.map +1 -1
- package/build/modern/index.d.cts +1 -1
- package/build/modern/index.d.ts +1 -1
- package/build/modern/persist.d.cts +1 -1
- package/build/modern/persist.d.ts +1 -1
- package/build/modern/retryStrategies.d.cts +1 -1
- package/build/modern/retryStrategies.d.ts +1 -1
- package/package.json +2 -2
- package/src/__tests__/createPersister.test.ts +63 -0
- package/src/createPersister.ts +21 -15
|
@@ -42,7 +42,7 @@ function experimental_createPersister({
|
|
|
42
42
|
try {
|
|
43
43
|
const storedData = await storage.getItem(storageKey);
|
|
44
44
|
if (storedData) {
|
|
45
|
-
const persistedQuery = deserialize(storedData);
|
|
45
|
+
const persistedQuery = await deserialize(storedData);
|
|
46
46
|
if (persistedQuery.state.dataUpdatedAt) {
|
|
47
47
|
const queryAge = Date.now() - persistedQuery.state.dataUpdatedAt;
|
|
48
48
|
const expired = queryAge > maxAge;
|
|
@@ -77,10 +77,10 @@ function experimental_createPersister({
|
|
|
77
77
|
}
|
|
78
78
|
const queryFnResult = await queryFn(context);
|
|
79
79
|
if (matchesFilter && storage != null) {
|
|
80
|
-
setTimeout(() => {
|
|
80
|
+
setTimeout(async () => {
|
|
81
81
|
storage.setItem(
|
|
82
82
|
storageKey,
|
|
83
|
-
serialize({
|
|
83
|
+
await serialize({
|
|
84
84
|
state: query.state,
|
|
85
85
|
queryKey: query.queryKey,
|
|
86
86
|
queryHash: query.queryHash,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/createPersister.ts"],"sourcesContent":["import { matchQuery } from '@tanstack/query-core'\nimport type { QueryFilters } from '@tanstack/query-core'\nimport type {\n Query,\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 interface AsyncStorage {\n getItem: (key: string) =>
|
|
1
|
+
{"version":3,"sources":["../../src/createPersister.ts"],"sourcesContent":["import { matchQuery } from '@tanstack/query-core'\nimport type { QueryFilters } from '@tanstack/query-core'\nimport type {\n Query,\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 persistance.\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":[]}
|
|
@@ -6,26 +6,27 @@ interface PersistedQuery {
|
|
|
6
6
|
queryKey: QueryKey;
|
|
7
7
|
state: QueryState;
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
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>;
|
|
13
14
|
}
|
|
14
|
-
interface StoragePersisterOptions {
|
|
15
|
+
interface StoragePersisterOptions<TStorageValue = string> {
|
|
15
16
|
/** The storage client used for setting and retrieving items from cache.
|
|
16
17
|
* For SSR pass in `undefined`.
|
|
17
18
|
*/
|
|
18
|
-
storage: AsyncStorage |
|
|
19
|
+
storage: AsyncStorage<TStorageValue> | undefined | null;
|
|
19
20
|
/**
|
|
20
21
|
* How to serialize the data to storage.
|
|
21
22
|
* @default `JSON.stringify`
|
|
22
23
|
*/
|
|
23
|
-
serialize?: (persistedQuery: PersistedQuery) =>
|
|
24
|
+
serialize?: (persistedQuery: PersistedQuery) => MaybePromise<TStorageValue>;
|
|
24
25
|
/**
|
|
25
26
|
* How to deserialize the data from storage.
|
|
26
27
|
* @default `JSON.parse`
|
|
27
28
|
*/
|
|
28
|
-
deserialize?: (cachedString:
|
|
29
|
+
deserialize?: (cachedString: TStorageValue) => MaybePromise<PersistedQuery>;
|
|
29
30
|
/**
|
|
30
31
|
* A unique string that can be used to forcefully invalidate existing caches,
|
|
31
32
|
* if they do not share the same buster string
|
|
@@ -65,7 +66,7 @@ declare const PERSISTER_KEY_PREFIX = "tanstack-query";
|
|
|
65
66
|
})
|
|
66
67
|
```
|
|
67
68
|
*/
|
|
68
|
-
declare function experimental_createPersister({ storage, buster, maxAge, serialize, deserialize, prefix, filters, }: StoragePersisterOptions): <T, TQueryKey extends QueryKey>(queryFn: (context: {
|
|
69
|
+
declare function experimental_createPersister<TStorageValue = string>({ storage, buster, maxAge, serialize, deserialize, prefix, filters, }: StoragePersisterOptions<TStorageValue>): <T, TQueryKey extends QueryKey>(queryFn: (context: {
|
|
69
70
|
queryKey: TQueryKey;
|
|
70
71
|
signal: AbortSignal;
|
|
71
72
|
meta: Record<string, unknown> | undefined;
|
|
@@ -75,4 +76,4 @@ declare function experimental_createPersister({ storage, buster, maxAge, seriali
|
|
|
75
76
|
meta: Record<string, unknown> | undefined;
|
|
76
77
|
}, query: Query) => Promise<T>;
|
|
77
78
|
|
|
78
|
-
export { AsyncStorage, PERSISTER_KEY_PREFIX, PersistedQuery, StoragePersisterOptions, experimental_createPersister };
|
|
79
|
+
export { type AsyncStorage, type MaybePromise, PERSISTER_KEY_PREFIX, type PersistedQuery, type StoragePersisterOptions, experimental_createPersister };
|
|
@@ -6,26 +6,27 @@ interface PersistedQuery {
|
|
|
6
6
|
queryKey: QueryKey;
|
|
7
7
|
state: QueryState;
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
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>;
|
|
13
14
|
}
|
|
14
|
-
interface StoragePersisterOptions {
|
|
15
|
+
interface StoragePersisterOptions<TStorageValue = string> {
|
|
15
16
|
/** The storage client used for setting and retrieving items from cache.
|
|
16
17
|
* For SSR pass in `undefined`.
|
|
17
18
|
*/
|
|
18
|
-
storage: AsyncStorage |
|
|
19
|
+
storage: AsyncStorage<TStorageValue> | undefined | null;
|
|
19
20
|
/**
|
|
20
21
|
* How to serialize the data to storage.
|
|
21
22
|
* @default `JSON.stringify`
|
|
22
23
|
*/
|
|
23
|
-
serialize?: (persistedQuery: PersistedQuery) =>
|
|
24
|
+
serialize?: (persistedQuery: PersistedQuery) => MaybePromise<TStorageValue>;
|
|
24
25
|
/**
|
|
25
26
|
* How to deserialize the data from storage.
|
|
26
27
|
* @default `JSON.parse`
|
|
27
28
|
*/
|
|
28
|
-
deserialize?: (cachedString:
|
|
29
|
+
deserialize?: (cachedString: TStorageValue) => MaybePromise<PersistedQuery>;
|
|
29
30
|
/**
|
|
30
31
|
* A unique string that can be used to forcefully invalidate existing caches,
|
|
31
32
|
* if they do not share the same buster string
|
|
@@ -65,7 +66,7 @@ declare const PERSISTER_KEY_PREFIX = "tanstack-query";
|
|
|
65
66
|
})
|
|
66
67
|
```
|
|
67
68
|
*/
|
|
68
|
-
declare function experimental_createPersister({ storage, buster, maxAge, serialize, deserialize, prefix, filters, }: StoragePersisterOptions): <T, TQueryKey extends QueryKey>(queryFn: (context: {
|
|
69
|
+
declare function experimental_createPersister<TStorageValue = string>({ storage, buster, maxAge, serialize, deserialize, prefix, filters, }: StoragePersisterOptions<TStorageValue>): <T, TQueryKey extends QueryKey>(queryFn: (context: {
|
|
69
70
|
queryKey: TQueryKey;
|
|
70
71
|
signal: AbortSignal;
|
|
71
72
|
meta: Record<string, unknown> | undefined;
|
|
@@ -75,4 +76,4 @@ declare function experimental_createPersister({ storage, buster, maxAge, seriali
|
|
|
75
76
|
meta: Record<string, unknown> | undefined;
|
|
76
77
|
}, query: Query) => Promise<T>;
|
|
77
78
|
|
|
78
|
-
export { AsyncStorage, PERSISTER_KEY_PREFIX, PersistedQuery, StoragePersisterOptions, experimental_createPersister };
|
|
79
|
+
export { type AsyncStorage, type MaybePromise, PERSISTER_KEY_PREFIX, type PersistedQuery, type StoragePersisterOptions, experimental_createPersister };
|
|
@@ -17,7 +17,7 @@ function experimental_createPersister({
|
|
|
17
17
|
try {
|
|
18
18
|
const storedData = await storage.getItem(storageKey);
|
|
19
19
|
if (storedData) {
|
|
20
|
-
const persistedQuery = deserialize(storedData);
|
|
20
|
+
const persistedQuery = await deserialize(storedData);
|
|
21
21
|
if (persistedQuery.state.dataUpdatedAt) {
|
|
22
22
|
const queryAge = Date.now() - persistedQuery.state.dataUpdatedAt;
|
|
23
23
|
const expired = queryAge > maxAge;
|
|
@@ -52,10 +52,10 @@ function experimental_createPersister({
|
|
|
52
52
|
}
|
|
53
53
|
const queryFnResult = await queryFn(context);
|
|
54
54
|
if (matchesFilter && storage != null) {
|
|
55
|
-
setTimeout(() => {
|
|
55
|
+
setTimeout(async () => {
|
|
56
56
|
storage.setItem(
|
|
57
57
|
storageKey,
|
|
58
|
-
serialize({
|
|
58
|
+
await serialize({
|
|
59
59
|
state: query.state,
|
|
60
60
|
queryKey: query.queryKey,
|
|
61
61
|
queryHash: query.queryHash,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/createPersister.ts"],"sourcesContent":["import { matchQuery } from '@tanstack/query-core'\nimport type { QueryFilters } from '@tanstack/query-core'\nimport type {\n Query,\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 interface AsyncStorage {\n getItem: (key: string) =>
|
|
1
|
+
{"version":3,"sources":["../../src/createPersister.ts"],"sourcesContent":["import { matchQuery } from '@tanstack/query-core'\nimport type { QueryFilters } from '@tanstack/query-core'\nimport type {\n Query,\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 persistance.\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":[]}
|
package/build/legacy/index.d.cts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
export { PersistQueryClienRootOptions, PersistQueryClientOptions, PersistedClient, PersistedQueryClientRestoreOptions, PersistedQueryClientSaveOptions, Persister, Promisable, persistQueryClient, persistQueryClientRestore, persistQueryClientSave, persistQueryClientSubscribe } from './persist.cjs';
|
|
2
2
|
export { PersistRetryer, removeOldestQuery } from './retryStrategies.cjs';
|
|
3
|
-
export { AsyncStorage, PERSISTER_KEY_PREFIX, PersistedQuery, StoragePersisterOptions, experimental_createPersister } from './createPersister.cjs';
|
|
3
|
+
export { AsyncStorage, MaybePromise, PERSISTER_KEY_PREFIX, PersistedQuery, StoragePersisterOptions, experimental_createPersister } from './createPersister.cjs';
|
|
4
4
|
import '@tanstack/query-core';
|
package/build/legacy/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
export { PersistQueryClienRootOptions, PersistQueryClientOptions, PersistedClient, PersistedQueryClientRestoreOptions, PersistedQueryClientSaveOptions, Persister, Promisable, persistQueryClient, persistQueryClientRestore, persistQueryClientSave, persistQueryClientSubscribe } from './persist.js';
|
|
2
2
|
export { PersistRetryer, removeOldestQuery } from './retryStrategies.js';
|
|
3
|
-
export { AsyncStorage, PERSISTER_KEY_PREFIX, PersistedQuery, StoragePersisterOptions, experimental_createPersister } from './createPersister.js';
|
|
3
|
+
export { AsyncStorage, MaybePromise, PERSISTER_KEY_PREFIX, PersistedQuery, StoragePersisterOptions, experimental_createPersister } from './createPersister.js';
|
|
4
4
|
import '@tanstack/query-core';
|
|
@@ -58,4 +58,4 @@ declare function persistQueryClientSubscribe(props: PersistedQueryClientSaveOpti
|
|
|
58
58
|
*/
|
|
59
59
|
declare function persistQueryClient(props: PersistQueryClientOptions): [() => void, Promise<void>];
|
|
60
60
|
|
|
61
|
-
export { PersistQueryClienRootOptions, PersistQueryClientOptions, PersistedClient, PersistedQueryClientRestoreOptions, PersistedQueryClientSaveOptions, Persister, Promisable, persistQueryClient, persistQueryClientRestore, persistQueryClientSave, persistQueryClientSubscribe };
|
|
61
|
+
export { type PersistQueryClienRootOptions, type PersistQueryClientOptions, type PersistedClient, type PersistedQueryClientRestoreOptions, type PersistedQueryClientSaveOptions, type Persister, type Promisable, persistQueryClient, persistQueryClientRestore, persistQueryClientSave, persistQueryClientSubscribe };
|
|
@@ -58,4 +58,4 @@ declare function persistQueryClientSubscribe(props: PersistedQueryClientSaveOpti
|
|
|
58
58
|
*/
|
|
59
59
|
declare function persistQueryClient(props: PersistQueryClientOptions): [() => void, Promise<void>];
|
|
60
60
|
|
|
61
|
-
export { PersistQueryClienRootOptions, PersistQueryClientOptions, PersistedClient, PersistedQueryClientRestoreOptions, PersistedQueryClientSaveOptions, Persister, Promisable, persistQueryClient, persistQueryClientRestore, persistQueryClientSave, persistQueryClientSubscribe };
|
|
61
|
+
export { type PersistQueryClienRootOptions, type PersistQueryClientOptions, type PersistedClient, type PersistedQueryClientRestoreOptions, type PersistedQueryClientSaveOptions, type Persister, type Promisable, persistQueryClient, persistQueryClientRestore, persistQueryClientSave, persistQueryClientSubscribe };
|
|
@@ -42,7 +42,7 @@ function experimental_createPersister({
|
|
|
42
42
|
try {
|
|
43
43
|
const storedData = await storage.getItem(storageKey);
|
|
44
44
|
if (storedData) {
|
|
45
|
-
const persistedQuery = deserialize(storedData);
|
|
45
|
+
const persistedQuery = await deserialize(storedData);
|
|
46
46
|
if (persistedQuery.state.dataUpdatedAt) {
|
|
47
47
|
const queryAge = Date.now() - persistedQuery.state.dataUpdatedAt;
|
|
48
48
|
const expired = queryAge > maxAge;
|
|
@@ -77,10 +77,10 @@ function experimental_createPersister({
|
|
|
77
77
|
}
|
|
78
78
|
const queryFnResult = await queryFn(context);
|
|
79
79
|
if (matchesFilter && storage != null) {
|
|
80
|
-
setTimeout(() => {
|
|
80
|
+
setTimeout(async () => {
|
|
81
81
|
storage.setItem(
|
|
82
82
|
storageKey,
|
|
83
|
-
serialize({
|
|
83
|
+
await serialize({
|
|
84
84
|
state: query.state,
|
|
85
85
|
queryKey: query.queryKey,
|
|
86
86
|
queryHash: query.queryHash,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/createPersister.ts"],"sourcesContent":["import { matchQuery } from '@tanstack/query-core'\nimport type { QueryFilters } from '@tanstack/query-core'\nimport type {\n Query,\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 interface AsyncStorage {\n getItem: (key: string) =>
|
|
1
|
+
{"version":3,"sources":["../../src/createPersister.ts"],"sourcesContent":["import { matchQuery } from '@tanstack/query-core'\nimport type { QueryFilters } from '@tanstack/query-core'\nimport type {\n Query,\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 persistance.\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":[]}
|
|
@@ -6,26 +6,27 @@ interface PersistedQuery {
|
|
|
6
6
|
queryKey: QueryKey;
|
|
7
7
|
state: QueryState;
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
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>;
|
|
13
14
|
}
|
|
14
|
-
interface StoragePersisterOptions {
|
|
15
|
+
interface StoragePersisterOptions<TStorageValue = string> {
|
|
15
16
|
/** The storage client used for setting and retrieving items from cache.
|
|
16
17
|
* For SSR pass in `undefined`.
|
|
17
18
|
*/
|
|
18
|
-
storage: AsyncStorage |
|
|
19
|
+
storage: AsyncStorage<TStorageValue> | undefined | null;
|
|
19
20
|
/**
|
|
20
21
|
* How to serialize the data to storage.
|
|
21
22
|
* @default `JSON.stringify`
|
|
22
23
|
*/
|
|
23
|
-
serialize?: (persistedQuery: PersistedQuery) =>
|
|
24
|
+
serialize?: (persistedQuery: PersistedQuery) => MaybePromise<TStorageValue>;
|
|
24
25
|
/**
|
|
25
26
|
* How to deserialize the data from storage.
|
|
26
27
|
* @default `JSON.parse`
|
|
27
28
|
*/
|
|
28
|
-
deserialize?: (cachedString:
|
|
29
|
+
deserialize?: (cachedString: TStorageValue) => MaybePromise<PersistedQuery>;
|
|
29
30
|
/**
|
|
30
31
|
* A unique string that can be used to forcefully invalidate existing caches,
|
|
31
32
|
* if they do not share the same buster string
|
|
@@ -65,7 +66,7 @@ declare const PERSISTER_KEY_PREFIX = "tanstack-query";
|
|
|
65
66
|
})
|
|
66
67
|
```
|
|
67
68
|
*/
|
|
68
|
-
declare function experimental_createPersister({ storage, buster, maxAge, serialize, deserialize, prefix, filters, }: StoragePersisterOptions): <T, TQueryKey extends QueryKey>(queryFn: (context: {
|
|
69
|
+
declare function experimental_createPersister<TStorageValue = string>({ storage, buster, maxAge, serialize, deserialize, prefix, filters, }: StoragePersisterOptions<TStorageValue>): <T, TQueryKey extends QueryKey>(queryFn: (context: {
|
|
69
70
|
queryKey: TQueryKey;
|
|
70
71
|
signal: AbortSignal;
|
|
71
72
|
meta: Record<string, unknown> | undefined;
|
|
@@ -75,4 +76,4 @@ declare function experimental_createPersister({ storage, buster, maxAge, seriali
|
|
|
75
76
|
meta: Record<string, unknown> | undefined;
|
|
76
77
|
}, query: Query) => Promise<T>;
|
|
77
78
|
|
|
78
|
-
export { AsyncStorage, PERSISTER_KEY_PREFIX, PersistedQuery, StoragePersisterOptions, experimental_createPersister };
|
|
79
|
+
export { type AsyncStorage, type MaybePromise, PERSISTER_KEY_PREFIX, type PersistedQuery, type StoragePersisterOptions, experimental_createPersister };
|
|
@@ -6,26 +6,27 @@ interface PersistedQuery {
|
|
|
6
6
|
queryKey: QueryKey;
|
|
7
7
|
state: QueryState;
|
|
8
8
|
}
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
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>;
|
|
13
14
|
}
|
|
14
|
-
interface StoragePersisterOptions {
|
|
15
|
+
interface StoragePersisterOptions<TStorageValue = string> {
|
|
15
16
|
/** The storage client used for setting and retrieving items from cache.
|
|
16
17
|
* For SSR pass in `undefined`.
|
|
17
18
|
*/
|
|
18
|
-
storage: AsyncStorage |
|
|
19
|
+
storage: AsyncStorage<TStorageValue> | undefined | null;
|
|
19
20
|
/**
|
|
20
21
|
* How to serialize the data to storage.
|
|
21
22
|
* @default `JSON.stringify`
|
|
22
23
|
*/
|
|
23
|
-
serialize?: (persistedQuery: PersistedQuery) =>
|
|
24
|
+
serialize?: (persistedQuery: PersistedQuery) => MaybePromise<TStorageValue>;
|
|
24
25
|
/**
|
|
25
26
|
* How to deserialize the data from storage.
|
|
26
27
|
* @default `JSON.parse`
|
|
27
28
|
*/
|
|
28
|
-
deserialize?: (cachedString:
|
|
29
|
+
deserialize?: (cachedString: TStorageValue) => MaybePromise<PersistedQuery>;
|
|
29
30
|
/**
|
|
30
31
|
* A unique string that can be used to forcefully invalidate existing caches,
|
|
31
32
|
* if they do not share the same buster string
|
|
@@ -65,7 +66,7 @@ declare const PERSISTER_KEY_PREFIX = "tanstack-query";
|
|
|
65
66
|
})
|
|
66
67
|
```
|
|
67
68
|
*/
|
|
68
|
-
declare function experimental_createPersister({ storage, buster, maxAge, serialize, deserialize, prefix, filters, }: StoragePersisterOptions): <T, TQueryKey extends QueryKey>(queryFn: (context: {
|
|
69
|
+
declare function experimental_createPersister<TStorageValue = string>({ storage, buster, maxAge, serialize, deserialize, prefix, filters, }: StoragePersisterOptions<TStorageValue>): <T, TQueryKey extends QueryKey>(queryFn: (context: {
|
|
69
70
|
queryKey: TQueryKey;
|
|
70
71
|
signal: AbortSignal;
|
|
71
72
|
meta: Record<string, unknown> | undefined;
|
|
@@ -75,4 +76,4 @@ declare function experimental_createPersister({ storage, buster, maxAge, seriali
|
|
|
75
76
|
meta: Record<string, unknown> | undefined;
|
|
76
77
|
}, query: Query) => Promise<T>;
|
|
77
78
|
|
|
78
|
-
export { AsyncStorage, PERSISTER_KEY_PREFIX, PersistedQuery, StoragePersisterOptions, experimental_createPersister };
|
|
79
|
+
export { type AsyncStorage, type MaybePromise, PERSISTER_KEY_PREFIX, type PersistedQuery, type StoragePersisterOptions, experimental_createPersister };
|
|
@@ -17,7 +17,7 @@ function experimental_createPersister({
|
|
|
17
17
|
try {
|
|
18
18
|
const storedData = await storage.getItem(storageKey);
|
|
19
19
|
if (storedData) {
|
|
20
|
-
const persistedQuery = deserialize(storedData);
|
|
20
|
+
const persistedQuery = await deserialize(storedData);
|
|
21
21
|
if (persistedQuery.state.dataUpdatedAt) {
|
|
22
22
|
const queryAge = Date.now() - persistedQuery.state.dataUpdatedAt;
|
|
23
23
|
const expired = queryAge > maxAge;
|
|
@@ -52,10 +52,10 @@ function experimental_createPersister({
|
|
|
52
52
|
}
|
|
53
53
|
const queryFnResult = await queryFn(context);
|
|
54
54
|
if (matchesFilter && storage != null) {
|
|
55
|
-
setTimeout(() => {
|
|
55
|
+
setTimeout(async () => {
|
|
56
56
|
storage.setItem(
|
|
57
57
|
storageKey,
|
|
58
|
-
serialize({
|
|
58
|
+
await serialize({
|
|
59
59
|
state: query.state,
|
|
60
60
|
queryKey: query.queryKey,
|
|
61
61
|
queryHash: query.queryHash,
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/createPersister.ts"],"sourcesContent":["import { matchQuery } from '@tanstack/query-core'\nimport type { QueryFilters } from '@tanstack/query-core'\nimport type {\n Query,\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 interface AsyncStorage {\n getItem: (key: string) =>
|
|
1
|
+
{"version":3,"sources":["../../src/createPersister.ts"],"sourcesContent":["import { matchQuery } from '@tanstack/query-core'\nimport type { QueryFilters } from '@tanstack/query-core'\nimport type {\n Query,\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 persistance.\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":[]}
|
package/build/modern/index.d.cts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
export { PersistQueryClienRootOptions, PersistQueryClientOptions, PersistedClient, PersistedQueryClientRestoreOptions, PersistedQueryClientSaveOptions, Persister, Promisable, persistQueryClient, persistQueryClientRestore, persistQueryClientSave, persistQueryClientSubscribe } from './persist.cjs';
|
|
2
2
|
export { PersistRetryer, removeOldestQuery } from './retryStrategies.cjs';
|
|
3
|
-
export { AsyncStorage, PERSISTER_KEY_PREFIX, PersistedQuery, StoragePersisterOptions, experimental_createPersister } from './createPersister.cjs';
|
|
3
|
+
export { AsyncStorage, MaybePromise, PERSISTER_KEY_PREFIX, PersistedQuery, StoragePersisterOptions, experimental_createPersister } from './createPersister.cjs';
|
|
4
4
|
import '@tanstack/query-core';
|
package/build/modern/index.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
export { PersistQueryClienRootOptions, PersistQueryClientOptions, PersistedClient, PersistedQueryClientRestoreOptions, PersistedQueryClientSaveOptions, Persister, Promisable, persistQueryClient, persistQueryClientRestore, persistQueryClientSave, persistQueryClientSubscribe } from './persist.js';
|
|
2
2
|
export { PersistRetryer, removeOldestQuery } from './retryStrategies.js';
|
|
3
|
-
export { AsyncStorage, PERSISTER_KEY_PREFIX, PersistedQuery, StoragePersisterOptions, experimental_createPersister } from './createPersister.js';
|
|
3
|
+
export { AsyncStorage, MaybePromise, PERSISTER_KEY_PREFIX, PersistedQuery, StoragePersisterOptions, experimental_createPersister } from './createPersister.js';
|
|
4
4
|
import '@tanstack/query-core';
|
|
@@ -58,4 +58,4 @@ declare function persistQueryClientSubscribe(props: PersistedQueryClientSaveOpti
|
|
|
58
58
|
*/
|
|
59
59
|
declare function persistQueryClient(props: PersistQueryClientOptions): [() => void, Promise<void>];
|
|
60
60
|
|
|
61
|
-
export { PersistQueryClienRootOptions, PersistQueryClientOptions, PersistedClient, PersistedQueryClientRestoreOptions, PersistedQueryClientSaveOptions, Persister, Promisable, persistQueryClient, persistQueryClientRestore, persistQueryClientSave, persistQueryClientSubscribe };
|
|
61
|
+
export { type PersistQueryClienRootOptions, type PersistQueryClientOptions, type PersistedClient, type PersistedQueryClientRestoreOptions, type PersistedQueryClientSaveOptions, type Persister, type Promisable, persistQueryClient, persistQueryClientRestore, persistQueryClientSave, persistQueryClientSubscribe };
|
|
@@ -58,4 +58,4 @@ declare function persistQueryClientSubscribe(props: PersistedQueryClientSaveOpti
|
|
|
58
58
|
*/
|
|
59
59
|
declare function persistQueryClient(props: PersistQueryClientOptions): [() => void, Promise<void>];
|
|
60
60
|
|
|
61
|
-
export { PersistQueryClienRootOptions, PersistQueryClientOptions, PersistedClient, PersistedQueryClientRestoreOptions, PersistedQueryClientSaveOptions, Persister, Promisable, persistQueryClient, persistQueryClientRestore, persistQueryClientSave, persistQueryClientSubscribe };
|
|
61
|
+
export { type PersistQueryClienRootOptions, type PersistQueryClientOptions, type PersistedClient, type PersistedQueryClientRestoreOptions, type PersistedQueryClientSaveOptions, type Persister, type Promisable, persistQueryClient, persistQueryClientRestore, persistQueryClientSave, persistQueryClientSubscribe };
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tanstack/query-persist-client-core",
|
|
3
|
-
"version": "5.
|
|
3
|
+
"version": "5.12.0",
|
|
4
4
|
"description": "Set of utilities for interacting with persisters, which can save your queryClient for later use",
|
|
5
5
|
"author": "tannerlinsley",
|
|
6
6
|
"license": "MIT",
|
|
@@ -37,7 +37,7 @@
|
|
|
37
37
|
"src"
|
|
38
38
|
],
|
|
39
39
|
"dependencies": {
|
|
40
|
-
"@tanstack/query-core": "5.
|
|
40
|
+
"@tanstack/query-core": "5.12.0"
|
|
41
41
|
},
|
|
42
42
|
"scripts": {
|
|
43
43
|
"clean": "rimraf ./build && rimraf ./coverage",
|
|
@@ -309,4 +309,67 @@ describe('createPersister', () => {
|
|
|
309
309
|
expect(queryFn).toHaveBeenCalledTimes(1)
|
|
310
310
|
expect(query.fetch).toHaveBeenCalledTimes(0)
|
|
311
311
|
})
|
|
312
|
+
|
|
313
|
+
test('should restore item from the storage with async deserializer', async () => {
|
|
314
|
+
const storage = getFreshStorage()
|
|
315
|
+
const { context, persisterFn, query, queryFn, storageKey } = setupPersister(
|
|
316
|
+
['foo'],
|
|
317
|
+
{
|
|
318
|
+
storage,
|
|
319
|
+
deserialize: (cachedString: string) =>
|
|
320
|
+
new Promise((resolve) => resolve(JSON.parse(cachedString))),
|
|
321
|
+
},
|
|
322
|
+
)
|
|
323
|
+
|
|
324
|
+
await storage.setItem(
|
|
325
|
+
storageKey,
|
|
326
|
+
JSON.stringify({
|
|
327
|
+
buster: '',
|
|
328
|
+
state: { dataUpdatedAt: Date.now() },
|
|
329
|
+
}),
|
|
330
|
+
)
|
|
331
|
+
|
|
332
|
+
await persisterFn(queryFn, context, query)
|
|
333
|
+
query.state.isInvalidated = true
|
|
334
|
+
query.fetch = vi.fn()
|
|
335
|
+
|
|
336
|
+
await sleep(0)
|
|
337
|
+
|
|
338
|
+
expect(queryFn).toHaveBeenCalledTimes(0)
|
|
339
|
+
expect(query.fetch).toHaveBeenCalledTimes(1)
|
|
340
|
+
})
|
|
341
|
+
|
|
342
|
+
test('should store item after successfull fetch with async serializer', async () => {
|
|
343
|
+
const storage = getFreshStorage()
|
|
344
|
+
const {
|
|
345
|
+
context,
|
|
346
|
+
persisterFn,
|
|
347
|
+
query,
|
|
348
|
+
queryFn,
|
|
349
|
+
queryHash,
|
|
350
|
+
queryKey,
|
|
351
|
+
storageKey,
|
|
352
|
+
} = setupPersister(['foo'], {
|
|
353
|
+
storage,
|
|
354
|
+
serialize: (persistedQuery) =>
|
|
355
|
+
new Promise((resolve) => resolve(JSON.stringify(persistedQuery))),
|
|
356
|
+
})
|
|
357
|
+
|
|
358
|
+
await persisterFn(queryFn, context, query)
|
|
359
|
+
query.setData('baz')
|
|
360
|
+
|
|
361
|
+
await sleep(0)
|
|
362
|
+
|
|
363
|
+
expect(queryFn).toHaveBeenCalledOnce()
|
|
364
|
+
expect(queryFn).toHaveBeenCalledWith(context)
|
|
365
|
+
|
|
366
|
+
expect(JSON.parse(await storage.getItem(storageKey))).toMatchObject({
|
|
367
|
+
buster: '',
|
|
368
|
+
queryHash,
|
|
369
|
+
queryKey,
|
|
370
|
+
state: {
|
|
371
|
+
data: 'baz',
|
|
372
|
+
},
|
|
373
|
+
})
|
|
374
|
+
})
|
|
312
375
|
})
|
package/src/createPersister.ts
CHANGED
|
@@ -14,27 +14,29 @@ export interface PersistedQuery {
|
|
|
14
14
|
state: QueryState
|
|
15
15
|
}
|
|
16
16
|
|
|
17
|
-
export
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
17
|
+
export type MaybePromise<T> = T | Promise<T>
|
|
18
|
+
|
|
19
|
+
export interface AsyncStorage<TStorageValue = string> {
|
|
20
|
+
getItem: (key: string) => MaybePromise<TStorageValue | undefined | null>
|
|
21
|
+
setItem: (key: string, value: TStorageValue) => MaybePromise<unknown>
|
|
22
|
+
removeItem: (key: string) => MaybePromise<void>
|
|
21
23
|
}
|
|
22
24
|
|
|
23
|
-
export interface StoragePersisterOptions {
|
|
25
|
+
export interface StoragePersisterOptions<TStorageValue = string> {
|
|
24
26
|
/** The storage client used for setting and retrieving items from cache.
|
|
25
27
|
* For SSR pass in `undefined`.
|
|
26
28
|
*/
|
|
27
|
-
storage: AsyncStorage |
|
|
29
|
+
storage: AsyncStorage<TStorageValue> | undefined | null
|
|
28
30
|
/**
|
|
29
31
|
* How to serialize the data to storage.
|
|
30
32
|
* @default `JSON.stringify`
|
|
31
33
|
*/
|
|
32
|
-
serialize?: (persistedQuery: PersistedQuery) =>
|
|
34
|
+
serialize?: (persistedQuery: PersistedQuery) => MaybePromise<TStorageValue>
|
|
33
35
|
/**
|
|
34
36
|
* How to deserialize the data from storage.
|
|
35
37
|
* @default `JSON.parse`
|
|
36
38
|
*/
|
|
37
|
-
deserialize?: (cachedString:
|
|
39
|
+
deserialize?: (cachedString: TStorageValue) => MaybePromise<PersistedQuery>
|
|
38
40
|
/**
|
|
39
41
|
* A unique string that can be used to forcefully invalidate existing caches,
|
|
40
42
|
* if they do not share the same buster string
|
|
@@ -76,15 +78,19 @@ export const PERSISTER_KEY_PREFIX = 'tanstack-query'
|
|
|
76
78
|
})
|
|
77
79
|
```
|
|
78
80
|
*/
|
|
79
|
-
export function experimental_createPersister({
|
|
81
|
+
export function experimental_createPersister<TStorageValue = string>({
|
|
80
82
|
storage,
|
|
81
83
|
buster = '',
|
|
82
84
|
maxAge = 1000 * 60 * 60 * 24,
|
|
83
|
-
serialize = JSON.stringify
|
|
84
|
-
|
|
85
|
+
serialize = JSON.stringify as Required<
|
|
86
|
+
StoragePersisterOptions<TStorageValue>
|
|
87
|
+
>['serialize'],
|
|
88
|
+
deserialize = JSON.parse as Required<
|
|
89
|
+
StoragePersisterOptions<TStorageValue>
|
|
90
|
+
>['deserialize'],
|
|
85
91
|
prefix = PERSISTER_KEY_PREFIX,
|
|
86
92
|
filters,
|
|
87
|
-
}: StoragePersisterOptions) {
|
|
93
|
+
}: StoragePersisterOptions<TStorageValue>) {
|
|
88
94
|
return async function persisterFn<T, TQueryKey extends QueryKey>(
|
|
89
95
|
queryFn: (context: QueryFunctionContext<TQueryKey>) => T | Promise<T>,
|
|
90
96
|
context: QueryFunctionContext<TQueryKey>,
|
|
@@ -98,7 +104,7 @@ export function experimental_createPersister({
|
|
|
98
104
|
try {
|
|
99
105
|
const storedData = await storage.getItem(storageKey)
|
|
100
106
|
if (storedData) {
|
|
101
|
-
const persistedQuery = deserialize(storedData)
|
|
107
|
+
const persistedQuery = await deserialize(storedData)
|
|
102
108
|
|
|
103
109
|
if (persistedQuery.state.dataUpdatedAt) {
|
|
104
110
|
const queryAge = Date.now() - persistedQuery.state.dataUpdatedAt
|
|
@@ -142,10 +148,10 @@ export function experimental_createPersister({
|
|
|
142
148
|
|
|
143
149
|
if (matchesFilter && storage != null) {
|
|
144
150
|
// Persist if we have storage defined, we use timeout to get proper state to be persisted
|
|
145
|
-
setTimeout(() => {
|
|
151
|
+
setTimeout(async () => {
|
|
146
152
|
storage.setItem(
|
|
147
153
|
storageKey,
|
|
148
|
-
serialize({
|
|
154
|
+
await serialize({
|
|
149
155
|
state: query.state,
|
|
150
156
|
queryKey: query.queryKey,
|
|
151
157
|
queryHash: query.queryHash,
|