@tanstack/query-core 5.105.0 → 5.105.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/build/legacy/{classPrivateFieldSet2-CukOTU3U.js → classPrivateFieldSet2-CWIQ5CvM.js} +5 -10
- package/build/legacy/{classPrivateFieldSet2-CvCEk6bM.cjs → classPrivateFieldSet2-C_J9s9he.cjs} +5 -10
- package/build/legacy/{classPrivateMethodInitSpec-Nr6mgZRs.cjs → classPrivateMethodInitSpec-BMGv9vbZ.cjs} +2 -3
- package/build/legacy/{classPrivateMethodInitSpec-CgB-WYk3.js → classPrivateMethodInitSpec-DipaBicy.js} +2 -3
- package/build/legacy/environmentManager.cjs +1 -2
- package/build/legacy/environmentManager.d.cts +0 -2
- package/build/legacy/environmentManager.d.cts.map +1 -1
- package/build/legacy/environmentManager.d.ts +0 -2
- package/build/legacy/environmentManager.d.ts.map +1 -1
- package/build/legacy/environmentManager.js +1 -2
- package/build/legacy/focusManager.cjs +2 -3
- package/build/legacy/focusManager.d.cts +1 -3
- package/build/legacy/focusManager.d.cts.map +1 -1
- package/build/legacy/focusManager.d.ts +1 -3
- package/build/legacy/focusManager.d.ts.map +1 -1
- package/build/legacy/focusManager.js +2 -3
- package/build/{modern/hydration-CS3HS-a9.d.ts → legacy/hydration-BXjqUj_D.d.cts} +28 -39
- package/build/legacy/hydration-BXjqUj_D.d.cts.map +1 -0
- package/build/legacy/{hydration-CS3HS-a9.d.ts → hydration-vgIjIhk6.d.ts} +28 -39
- package/build/legacy/hydration-vgIjIhk6.d.ts.map +1 -0
- package/build/legacy/hydration.cjs +1 -2
- package/build/legacy/hydration.d.cts +1 -1
- package/build/legacy/hydration.d.ts +1 -1
- package/build/legacy/hydration.js +1 -2
- package/build/legacy/index.cjs +1 -2
- package/build/legacy/index.d.cts +1 -1
- package/build/legacy/index.d.ts +1 -1
- package/build/legacy/index.js +1 -2
- package/build/legacy/infiniteQueryBehavior.cjs +3 -3
- package/build/legacy/infiniteQueryBehavior.cjs.map +1 -1
- package/build/legacy/infiniteQueryBehavior.d.cts +1 -3
- package/build/legacy/infiniteQueryBehavior.d.cts.map +1 -1
- package/build/legacy/infiniteQueryBehavior.d.ts +1 -3
- package/build/legacy/infiniteQueryBehavior.d.ts.map +1 -1
- package/build/legacy/infiniteQueryBehavior.js +4 -4
- package/build/legacy/infiniteQueryBehavior.js.map +1 -1
- package/build/legacy/infiniteQueryObserver.cjs +1 -2
- package/build/legacy/infiniteQueryObserver.d.cts +2 -4
- package/build/legacy/infiniteQueryObserver.d.cts.map +1 -1
- package/build/legacy/infiniteQueryObserver.d.ts +2 -4
- package/build/legacy/infiniteQueryObserver.d.ts.map +1 -1
- package/build/legacy/infiniteQueryObserver.js +1 -2
- package/build/legacy/mutation.cjs +4 -4
- package/build/legacy/mutation.cjs.map +1 -1
- package/build/legacy/mutation.d.cts +1 -1
- package/build/legacy/mutation.d.ts +1 -1
- package/build/legacy/mutation.js +4 -4
- package/build/legacy/mutation.js.map +1 -1
- package/build/legacy/mutationCache.cjs +2 -3
- package/build/legacy/mutationCache.d.cts +1 -1
- package/build/legacy/mutationCache.d.ts +1 -1
- package/build/legacy/mutationCache.js +2 -3
- package/build/legacy/mutationObserver.cjs +3 -4
- package/build/legacy/mutationObserver.d.cts +1 -1
- package/build/legacy/mutationObserver.d.ts +1 -1
- package/build/legacy/mutationObserver.js +3 -4
- package/build/legacy/notifyManager.cjs +1 -2
- package/build/legacy/notifyManager.cjs.map +1 -1
- package/build/legacy/notifyManager.d.cts +0 -2
- package/build/legacy/notifyManager.d.cts.map +1 -1
- package/build/legacy/notifyManager.d.ts +0 -2
- package/build/legacy/notifyManager.d.ts.map +1 -1
- package/build/legacy/notifyManager.js +1 -2
- package/build/legacy/onlineManager.cjs +2 -3
- package/build/legacy/onlineManager.d.cts +1 -3
- package/build/legacy/onlineManager.d.cts.map +1 -1
- package/build/legacy/onlineManager.d.ts +1 -3
- package/build/legacy/onlineManager.d.ts.map +1 -1
- package/build/legacy/onlineManager.js +2 -3
- package/build/legacy/queriesObserver.cjs +3 -4
- package/build/legacy/queriesObserver.d.cts +2 -4
- package/build/legacy/queriesObserver.d.cts.map +1 -1
- package/build/legacy/queriesObserver.d.ts +2 -4
- package/build/legacy/queriesObserver.d.ts.map +1 -1
- package/build/legacy/queriesObserver.js +3 -4
- package/build/legacy/query.cjs +57 -40
- package/build/legacy/query.cjs.map +1 -1
- package/build/legacy/query.d.cts +1 -1
- package/build/legacy/query.d.ts +1 -1
- package/build/legacy/query.js +58 -41
- package/build/legacy/query.js.map +1 -1
- package/build/legacy/queryCache.cjs +2 -3
- package/build/legacy/queryCache.d.cts +1 -1
- package/build/legacy/queryCache.d.ts +1 -1
- package/build/legacy/queryCache.js +2 -3
- package/build/legacy/queryClient.cjs +13 -9
- package/build/legacy/queryClient.cjs.map +1 -1
- package/build/legacy/queryClient.d.cts +1 -1
- package/build/legacy/queryClient.d.ts +1 -1
- package/build/legacy/queryClient.js +13 -9
- package/build/legacy/queryClient.js.map +1 -1
- package/build/legacy/queryObserver.cjs +6 -10
- package/build/legacy/queryObserver.cjs.map +1 -1
- package/build/legacy/queryObserver.d.cts +1 -1
- package/build/legacy/queryObserver.d.ts +1 -1
- package/build/legacy/queryObserver.js +6 -10
- package/build/legacy/queryObserver.js.map +1 -1
- package/build/{modern/removable-Cw9GNGyK.d.ts → legacy/removable-B1nFbgZm.d.cts} +1 -3
- package/build/legacy/removable-B1nFbgZm.d.cts.map +1 -0
- package/build/legacy/{removable-Cw9GNGyK.d.ts → removable-B1nFbgZm.d.ts} +1 -3
- package/build/legacy/removable-B1nFbgZm.d.ts.map +1 -0
- package/build/legacy/removable.cjs +2 -3
- package/build/legacy/removable.d.cts +1 -1
- package/build/legacy/removable.d.ts +1 -1
- package/build/legacy/removable.js +2 -3
- package/build/legacy/retryer.cjs +1 -2
- package/build/legacy/retryer.d.cts +1 -1
- package/build/legacy/retryer.d.ts +1 -1
- package/build/legacy/retryer.js +1 -2
- package/build/legacy/streamedQuery.cjs +11 -6
- package/build/legacy/streamedQuery.cjs.map +1 -1
- package/build/legacy/streamedQuery.d.cts +3 -3
- package/build/legacy/streamedQuery.d.cts.map +1 -1
- package/build/legacy/streamedQuery.d.ts +3 -3
- package/build/legacy/streamedQuery.d.ts.map +1 -1
- package/build/legacy/streamedQuery.js +12 -7
- package/build/legacy/streamedQuery.js.map +1 -1
- package/build/legacy/{subscribable-czlHOxMP.d.ts → subscribable-D2lAzdDi.d.cts} +1 -3
- package/build/legacy/subscribable-D2lAzdDi.d.cts.map +1 -0
- package/build/{modern/subscribable-czlHOxMP.d.ts → legacy/subscribable-D2lAzdDi.d.ts} +1 -3
- package/build/legacy/subscribable-D2lAzdDi.d.ts.map +1 -0
- package/build/legacy/subscribable.cjs +1 -2
- package/build/legacy/subscribable.d.cts +1 -1
- package/build/legacy/subscribable.d.ts +1 -1
- package/build/legacy/subscribable.js +1 -2
- package/build/legacy/timeoutManager.cjs +2 -3
- package/build/legacy/timeoutManager.d.cts +0 -2
- package/build/legacy/timeoutManager.d.cts.map +1 -1
- package/build/legacy/timeoutManager.d.ts +0 -2
- package/build/legacy/timeoutManager.d.ts.map +1 -1
- package/build/legacy/timeoutManager.js +2 -3
- package/build/legacy/types.cjs +1 -2
- package/build/legacy/types.d.cts +1 -1
- package/build/legacy/types.d.ts +1 -1
- package/build/legacy/types.js +1 -2
- package/build/legacy/utils.cjs +24 -21
- package/build/legacy/utils.cjs.map +1 -1
- package/build/legacy/utils.d.cts +2 -2
- package/build/legacy/utils.d.ts +2 -2
- package/build/legacy/utils.js +24 -22
- package/build/legacy/utils.js.map +1 -1
- package/build/modern/environmentManager.cjs +1 -2
- package/build/modern/environmentManager.d.cts +0 -2
- package/build/modern/environmentManager.d.cts.map +1 -1
- package/build/modern/environmentManager.d.ts +0 -2
- package/build/modern/environmentManager.d.ts.map +1 -1
- package/build/modern/environmentManager.js +1 -2
- package/build/modern/focusManager.cjs +1 -2
- package/build/modern/focusManager.d.cts +1 -3
- package/build/modern/focusManager.d.cts.map +1 -1
- package/build/modern/focusManager.d.ts +1 -3
- package/build/modern/focusManager.d.ts.map +1 -1
- package/build/modern/focusManager.js +1 -2
- package/build/modern/{hydration-DhAJ02bL.d.cts → hydration-BXjqUj_D.d.cts} +28 -39
- package/build/modern/hydration-BXjqUj_D.d.cts.map +1 -0
- package/build/{legacy/hydration-DhAJ02bL.d.cts → modern/hydration-vgIjIhk6.d.ts} +28 -39
- package/build/modern/hydration-vgIjIhk6.d.ts.map +1 -0
- package/build/modern/hydration.cjs +1 -2
- package/build/modern/hydration.d.cts +1 -1
- package/build/modern/hydration.d.ts +1 -1
- package/build/modern/hydration.js +1 -2
- package/build/modern/index.cjs +1 -2
- package/build/modern/index.d.cts +1 -1
- package/build/modern/index.d.ts +1 -1
- package/build/modern/index.js +1 -2
- package/build/modern/infiniteQueryBehavior.cjs +3 -3
- package/build/modern/infiniteQueryBehavior.cjs.map +1 -1
- package/build/modern/infiniteQueryBehavior.d.cts +1 -3
- package/build/modern/infiniteQueryBehavior.d.cts.map +1 -1
- package/build/modern/infiniteQueryBehavior.d.ts +1 -3
- package/build/modern/infiniteQueryBehavior.d.ts.map +1 -1
- package/build/modern/infiniteQueryBehavior.js +4 -4
- package/build/modern/infiniteQueryBehavior.js.map +1 -1
- package/build/modern/infiniteQueryObserver.cjs +1 -2
- package/build/modern/infiniteQueryObserver.d.cts +2 -4
- package/build/modern/infiniteQueryObserver.d.cts.map +1 -1
- package/build/modern/infiniteQueryObserver.d.ts +2 -4
- package/build/modern/infiniteQueryObserver.d.ts.map +1 -1
- package/build/modern/infiniteQueryObserver.js +1 -2
- package/build/modern/mutation.cjs +2 -2
- package/build/modern/mutation.cjs.map +1 -1
- package/build/modern/mutation.d.cts +1 -1
- package/build/modern/mutation.d.ts +1 -1
- package/build/modern/mutation.js +2 -2
- package/build/modern/mutation.js.map +1 -1
- package/build/modern/mutationCache.cjs +1 -2
- package/build/modern/mutationCache.d.cts +1 -1
- package/build/modern/mutationCache.d.ts +1 -1
- package/build/modern/mutationCache.js +1 -2
- package/build/modern/mutationObserver.cjs +1 -2
- package/build/modern/mutationObserver.d.cts +1 -1
- package/build/modern/mutationObserver.d.ts +1 -1
- package/build/modern/mutationObserver.js +1 -2
- package/build/modern/notifyManager.cjs +1 -2
- package/build/modern/notifyManager.cjs.map +1 -1
- package/build/modern/notifyManager.d.cts +0 -2
- package/build/modern/notifyManager.d.cts.map +1 -1
- package/build/modern/notifyManager.d.ts +0 -2
- package/build/modern/notifyManager.d.ts.map +1 -1
- package/build/modern/notifyManager.js +1 -2
- package/build/modern/onlineManager.cjs +1 -2
- package/build/modern/onlineManager.d.cts +1 -3
- package/build/modern/onlineManager.d.cts.map +1 -1
- package/build/modern/onlineManager.d.ts +1 -3
- package/build/modern/onlineManager.d.ts.map +1 -1
- package/build/modern/onlineManager.js +1 -2
- package/build/modern/queriesObserver.cjs +1 -2
- package/build/modern/queriesObserver.d.cts +2 -4
- package/build/modern/queriesObserver.d.cts.map +1 -1
- package/build/modern/queriesObserver.d.ts +2 -4
- package/build/modern/queriesObserver.d.ts.map +1 -1
- package/build/modern/queriesObserver.js +1 -2
- package/build/modern/query.cjs +52 -36
- package/build/modern/query.cjs.map +1 -1
- package/build/modern/query.d.cts +1 -1
- package/build/modern/query.d.ts +1 -1
- package/build/modern/query.js +53 -37
- package/build/modern/query.js.map +1 -1
- package/build/modern/queryCache.cjs +1 -2
- package/build/modern/queryCache.d.cts +1 -1
- package/build/modern/queryCache.d.ts +1 -1
- package/build/modern/queryCache.js +1 -2
- package/build/modern/queryClient.cjs +12 -8
- package/build/modern/queryClient.cjs.map +1 -1
- package/build/modern/queryClient.d.cts +1 -1
- package/build/modern/queryClient.d.ts +1 -1
- package/build/modern/queryClient.js +12 -8
- package/build/modern/queryClient.js.map +1 -1
- package/build/modern/queryObserver.cjs +4 -8
- package/build/modern/queryObserver.cjs.map +1 -1
- package/build/modern/queryObserver.d.cts +1 -1
- package/build/modern/queryObserver.d.ts +1 -1
- package/build/modern/queryObserver.js +4 -8
- package/build/modern/queryObserver.js.map +1 -1
- package/build/modern/{removable-Cw9GNGyK.d.cts → removable-B1nFbgZm.d.cts} +1 -3
- package/build/modern/removable-B1nFbgZm.d.cts.map +1 -0
- package/build/{legacy/removable-Cw9GNGyK.d.cts → modern/removable-B1nFbgZm.d.ts} +1 -3
- package/build/modern/removable-B1nFbgZm.d.ts.map +1 -0
- package/build/modern/removable.cjs +1 -2
- package/build/modern/removable.d.cts +1 -1
- package/build/modern/removable.d.ts +1 -1
- package/build/modern/removable.js +1 -2
- package/build/modern/retryer.cjs +1 -2
- package/build/modern/retryer.d.cts +1 -1
- package/build/modern/retryer.d.ts +1 -1
- package/build/modern/retryer.js +1 -2
- package/build/modern/streamedQuery.cjs +11 -6
- package/build/modern/streamedQuery.cjs.map +1 -1
- package/build/modern/streamedQuery.d.cts +3 -3
- package/build/modern/streamedQuery.d.cts.map +1 -1
- package/build/modern/streamedQuery.d.ts +3 -3
- package/build/modern/streamedQuery.d.ts.map +1 -1
- package/build/modern/streamedQuery.js +12 -7
- package/build/modern/streamedQuery.js.map +1 -1
- package/build/{legacy/subscribable-czlHOxMP.d.cts → modern/subscribable-D2lAzdDi.d.cts} +1 -3
- package/build/modern/subscribable-D2lAzdDi.d.cts.map +1 -0
- package/build/modern/{subscribable-czlHOxMP.d.cts → subscribable-D2lAzdDi.d.ts} +1 -3
- package/build/modern/subscribable-D2lAzdDi.d.ts.map +1 -0
- package/build/modern/subscribable.cjs +1 -2
- package/build/modern/subscribable.d.cts +1 -1
- package/build/modern/subscribable.d.ts +1 -1
- package/build/modern/subscribable.js +1 -2
- package/build/modern/timeoutManager.cjs +1 -2
- package/build/modern/timeoutManager.d.cts +0 -2
- package/build/modern/timeoutManager.d.cts.map +1 -1
- package/build/modern/timeoutManager.d.ts +0 -2
- package/build/modern/timeoutManager.d.ts.map +1 -1
- package/build/modern/timeoutManager.js +1 -2
- package/build/modern/types.cjs +1 -2
- package/build/modern/types.d.cts +1 -1
- package/build/modern/types.d.ts +1 -1
- package/build/modern/types.js +1 -2
- package/build/modern/utils.cjs +24 -21
- package/build/modern/utils.cjs.map +1 -1
- package/build/modern/utils.d.cts +2 -2
- package/build/modern/utils.d.ts +2 -2
- package/build/modern/utils.js +24 -22
- package/build/modern/utils.js.map +1 -1
- package/package.json +1 -1
- package/src/infiniteQueryBehavior.ts +5 -1
- package/src/mutation.ts +4 -0
- package/src/query.ts +78 -64
- package/src/queryClient.ts +17 -13
- package/src/queryObserver.ts +14 -12
- package/src/streamedQuery.ts +14 -3
- package/src/utils.ts +39 -26
- package/build/legacy/hydration-CS3HS-a9.d.ts.map +0 -1
- package/build/legacy/hydration-DhAJ02bL.d.cts.map +0 -1
- package/build/legacy/removable-Cw9GNGyK.d.cts.map +0 -1
- package/build/legacy/removable-Cw9GNGyK.d.ts.map +0 -1
- package/build/legacy/subscribable-czlHOxMP.d.cts.map +0 -1
- package/build/legacy/subscribable-czlHOxMP.d.ts.map +0 -1
- package/build/modern/hydration-CS3HS-a9.d.ts.map +0 -1
- package/build/modern/hydration-DhAJ02bL.d.cts.map +0 -1
- package/build/modern/removable-Cw9GNGyK.d.cts.map +0 -1
- package/build/modern/removable-Cw9GNGyK.d.ts.map +0 -1
- package/build/modern/subscribable-czlHOxMP.d.cts.map +0 -1
- package/build/modern/subscribable-czlHOxMP.d.ts.map +0 -1
|
@@ -1,11 +1,13 @@
|
|
|
1
1
|
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
2
2
|
const require_utils = require("./utils.cjs");
|
|
3
|
-
|
|
3
|
+
// src/streamedQuery.ts
|
|
4
4
|
/**
|
|
5
5
|
* This is a helper function to create a query function that streams data from an AsyncIterable.
|
|
6
6
|
* Data will be an Array of all the chunks received.
|
|
7
7
|
* The query will be in a 'pending' state until the first chunk of data is received, but will go to 'success' after that.
|
|
8
8
|
* The query will stay in fetchStatus 'fetching' until the stream ends.
|
|
9
|
+
* Explicit cancellation stops further cache updates, even if `streamFn` does not read `signal`.
|
|
10
|
+
* If `streamFn` does not read `signal`, the stream continues after the last observer unsubscribes.
|
|
9
11
|
* @param options - The `streamFn` that returns an AsyncIterable to stream data from, and the optional
|
|
10
12
|
* `refetchMode`, `reducer`, and `initialValue` options.
|
|
11
13
|
* @returns A query function to pass as `queryFn`.
|
|
@@ -21,6 +23,8 @@ const require_utils = require("./utils.cjs");
|
|
|
21
23
|
*/
|
|
22
24
|
function streamedQuery({ streamFn, refetchMode = "reset", reducer = (items, chunk) => require_utils.addToEnd(items, chunk), initialValue = [] }) {
|
|
23
25
|
return async (context) => {
|
|
26
|
+
const signal = context[require_utils.fetchSignal];
|
|
27
|
+
if (signal === null || signal === void 0 ? void 0 : signal.aborted) return initialValue;
|
|
24
28
|
const query = context.client.getQueryCache().find({
|
|
25
29
|
queryKey: context.queryKey,
|
|
26
30
|
exact: true
|
|
@@ -32,25 +36,26 @@ function streamedQuery({ streamFn, refetchMode = "reset", reducer = (items, chun
|
|
|
32
36
|
});
|
|
33
37
|
let result = initialValue;
|
|
34
38
|
let cancelled = false;
|
|
35
|
-
const
|
|
39
|
+
const streamFnContext = require_utils.addConsumeAwareSignal({
|
|
36
40
|
client: context.client,
|
|
37
41
|
meta: context.meta,
|
|
38
42
|
queryKey: context.queryKey,
|
|
39
43
|
pageParam: context.pageParam,
|
|
40
44
|
direction: context.direction
|
|
41
|
-
}, () => context.signal, () => cancelled = true)
|
|
45
|
+
}, () => context.signal, () => cancelled = true, signal);
|
|
46
|
+
const isStreamInactive = () => cancelled || (signal === null || signal === void 0 ? void 0 : signal.aborted) === true;
|
|
47
|
+
const stream = await streamFn(streamFnContext);
|
|
42
48
|
const isReplaceRefetch = isRefetch && refetchMode === "replace";
|
|
43
49
|
for await (const chunk of stream) {
|
|
44
|
-
if (
|
|
50
|
+
if (isStreamInactive()) break;
|
|
45
51
|
if (isReplaceRefetch) result = reducer(result, chunk);
|
|
46
52
|
else context.client.setQueryData(context.queryKey, (prev) => reducer(prev === void 0 ? initialValue : prev, chunk));
|
|
47
53
|
}
|
|
48
|
-
if (isReplaceRefetch && !
|
|
54
|
+
if (isReplaceRefetch && !isStreamInactive()) context.client.setQueryData(context.queryKey, result);
|
|
49
55
|
const data = context.client.getQueryData(context.queryKey);
|
|
50
56
|
return data === void 0 ? initialValue : data;
|
|
51
57
|
};
|
|
52
58
|
}
|
|
53
|
-
//#endregion
|
|
54
59
|
exports.streamedQuery = streamedQuery;
|
|
55
60
|
|
|
56
61
|
//# sourceMappingURL=streamedQuery.cjs.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"streamedQuery.cjs","names":["addToEnd","addConsumeAwareSignal"],"sources":["../../src/streamedQuery.ts"],"sourcesContent":["import { addConsumeAwareSignal, addToEnd } from './utils'\nimport type {\n OmitKeyof,\n QueryFunction,\n QueryFunctionContext,\n QueryKey,\n} from './types'\n\ntype BaseStreamedQueryParams<TQueryFnData, TQueryKey extends QueryKey> = {\n /** The function that returns an `AsyncIterable` to stream data from. */\n streamFn: (\n context: QueryFunctionContext<TQueryKey>,\n ) => AsyncIterable<TQueryFnData> | Promise<AsyncIterable<TQueryFnData>>\n /**\n * Defines how refetches are handled.\n * - `'reset'` (default): erases all data and puts the query back into `pending` state.\n * - `'append'`: appends new data to the existing data.\n * - `'replace'`: writes all data to the cache once the stream ends.\n */\n refetchMode?: 'append' | 'reset' | 'replace'\n}\n\ntype SimpleStreamedQueryParams<\n TQueryFnData,\n TQueryKey extends QueryKey,\n> = BaseStreamedQueryParams<TQueryFnData, TQueryKey> & {\n reducer?: never\n initialValue?: never\n}\n\ntype ReducibleStreamedQueryParams<\n TQueryFnData,\n TData,\n TQueryKey extends QueryKey,\n> = BaseStreamedQueryParams<TQueryFnData, TQueryKey> & {\n /**\n * Reduces streamed chunks into the final data shape. Required whenever `TData` is not an\n * array, since there is no default way to accumulate non-array chunks.\n */\n reducer: (acc: TData, chunk: TQueryFnData) => TData\n /**\n * The value used while the first chunk is being fetched, and returned if the stream yields no\n * values. Required together with a custom `reducer`.\n */\n initialValue: TData\n}\n\ntype StreamedQueryParams<TQueryFnData, TData, TQueryKey extends QueryKey> =\n | SimpleStreamedQueryParams<TQueryFnData, TQueryKey>\n | ReducibleStreamedQueryParams<TQueryFnData, TData, TQueryKey>\n\n/**\n * This is a helper function to create a query function that streams data from an AsyncIterable.\n * Data will be an Array of all the chunks received.\n * The query will be in a 'pending' state until the first chunk of data is received, but will go to 'success' after that.\n * The query will stay in fetchStatus 'fetching' until the stream ends.\n * @param options - The `streamFn` that returns an AsyncIterable to stream data from, and the optional\n * `refetchMode`, `reducer`, and `initialValue` options.\n * @returns A query function to pass as `queryFn`.\n * @example\n * ```ts\n * await queryClient.query({\n * queryKey: ['data'],\n * queryFn: streamedQuery({\n * streamFn: fetchDataInChunks,\n * }),\n * })\n * ```\n */\nexport function streamedQuery<\n TQueryFnData = unknown,\n TData = Array<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n>({\n streamFn,\n refetchMode = 'reset',\n reducer = (items, chunk) =>\n addToEnd(items as Array<TQueryFnData>, chunk) as TData,\n initialValue = [] as TData,\n}: StreamedQueryParams<TQueryFnData, TData, TQueryKey>): QueryFunction<\n TData,\n TQueryKey\n> {\n return async (context) => {\n const query = context.client\n .getQueryCache()\n .find({ queryKey: context.queryKey, exact: true })\n const isRefetch = !!query && query.isFetched()\n if (isRefetch && refetchMode === 'reset') {\n query.setState({\n ...query.resetState,\n fetchStatus: 'fetching',\n })\n }\n\n let result = initialValue\n\n let cancelled = false as boolean\n const streamFnContext = addConsumeAwareSignal<\n OmitKeyof<typeof context, 'signal'>\n >(\n {\n client: context.client,\n meta: context.meta,\n queryKey: context.queryKey,\n pageParam: context.pageParam,\n direction: context.direction,\n },\n () => context.signal,\n () => (cancelled = true),\n )\n\n const stream = await streamFn(streamFnContext)\n\n const isReplaceRefetch = isRefetch && refetchMode === 'replace'\n\n for await (const chunk of stream) {\n if (
|
|
1
|
+
{"version":3,"file":"streamedQuery.cjs","names":["addToEnd","signalContext","fetchSignal","addConsumeAwareSignal"],"sources":["../../src/streamedQuery.ts"],"sourcesContent":["import { addConsumeAwareSignal, addToEnd, fetchSignal } from './utils'\nimport type { FetchSignalContext } from './utils'\nimport type {\n OmitKeyof,\n QueryFunction,\n QueryFunctionContext,\n QueryKey,\n} from './types'\n\ntype BaseStreamedQueryParams<TQueryFnData, TQueryKey extends QueryKey> = {\n /** The function that returns an `AsyncIterable` to stream data from. */\n streamFn: (\n context: QueryFunctionContext<TQueryKey>,\n ) => AsyncIterable<TQueryFnData> | Promise<AsyncIterable<TQueryFnData>>\n /**\n * Defines how refetches are handled.\n * - `'reset'` (default): erases all data and puts the query back into `pending` state.\n * - `'append'`: appends new data to the existing data.\n * - `'replace'`: writes all data to the cache once the stream ends.\n */\n refetchMode?: 'append' | 'reset' | 'replace'\n}\n\ntype SimpleStreamedQueryParams<\n TQueryFnData,\n TQueryKey extends QueryKey,\n> = BaseStreamedQueryParams<TQueryFnData, TQueryKey> & {\n reducer?: never\n initialValue?: never\n}\n\ntype ReducibleStreamedQueryParams<\n TQueryFnData,\n TData,\n TQueryKey extends QueryKey,\n> = BaseStreamedQueryParams<TQueryFnData, TQueryKey> & {\n /**\n * Reduces streamed chunks into the final data shape. Required whenever `TData` is not an\n * array, since there is no default way to accumulate non-array chunks.\n */\n reducer: (acc: TData, chunk: TQueryFnData) => TData\n /**\n * The value used while the first chunk is being fetched, and returned if the stream yields no\n * values. Required together with a custom `reducer`.\n */\n initialValue: TData\n}\n\ntype StreamedQueryParams<TQueryFnData, TData, TQueryKey extends QueryKey> =\n | SimpleStreamedQueryParams<TQueryFnData, TQueryKey>\n | ReducibleStreamedQueryParams<TQueryFnData, TData, TQueryKey>\n\n/**\n * This is a helper function to create a query function that streams data from an AsyncIterable.\n * Data will be an Array of all the chunks received.\n * The query will be in a 'pending' state until the first chunk of data is received, but will go to 'success' after that.\n * The query will stay in fetchStatus 'fetching' until the stream ends.\n * Explicit cancellation stops further cache updates, even if `streamFn` does not read `signal`.\n * If `streamFn` does not read `signal`, the stream continues after the last observer unsubscribes.\n * @param options - The `streamFn` that returns an AsyncIterable to stream data from, and the optional\n * `refetchMode`, `reducer`, and `initialValue` options.\n * @returns A query function to pass as `queryFn`.\n * @example\n * ```ts\n * await queryClient.query({\n * queryKey: ['data'],\n * queryFn: streamedQuery({\n * streamFn: fetchDataInChunks,\n * }),\n * })\n * ```\n */\nexport function streamedQuery<\n TQueryFnData = unknown,\n TData = Array<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n>({\n streamFn,\n refetchMode = 'reset',\n reducer = (items, chunk) =>\n addToEnd(items as Array<TQueryFnData>, chunk) as TData,\n initialValue = [] as TData,\n}: StreamedQueryParams<TQueryFnData, TData, TQueryKey>): QueryFunction<\n TData,\n TQueryKey\n> {\n return async (context) => {\n const signalContext: FetchSignalContext = context\n const signal = signalContext[fetchSignal]\n if (signal?.aborted) {\n return initialValue\n }\n\n const query = context.client\n .getQueryCache()\n .find({ queryKey: context.queryKey, exact: true })\n const isRefetch = !!query && query.isFetched()\n if (isRefetch && refetchMode === 'reset') {\n query.setState({\n ...query.resetState,\n fetchStatus: 'fetching',\n })\n }\n\n let result = initialValue\n\n let cancelled = false as boolean\n const streamFnContext = addConsumeAwareSignal<\n OmitKeyof<typeof context, 'signal'>\n >(\n {\n client: context.client,\n meta: context.meta,\n queryKey: context.queryKey,\n pageParam: context.pageParam,\n direction: context.direction,\n },\n () => context.signal,\n () => (cancelled = true),\n signal,\n )\n\n const isStreamInactive = () => cancelled || signal?.aborted === true\n const stream = await streamFn(streamFnContext)\n\n const isReplaceRefetch = isRefetch && refetchMode === 'replace'\n\n for await (const chunk of stream) {\n if (isStreamInactive()) {\n break\n }\n\n if (isReplaceRefetch) {\n // don't append to the cache directly when replace-refetching\n result = reducer(result, chunk)\n } else {\n context.client.setQueryData<TData>(context.queryKey, (prev) =>\n reducer(prev === undefined ? initialValue : prev, chunk),\n )\n }\n }\n\n // finalize result: replace-refetching needs to write to the cache\n if (isReplaceRefetch && !isStreamInactive()) {\n context.client.setQueryData<TData>(context.queryKey, result)\n }\n\n const data = context.client.getQueryData<TData>(context.queryKey)\n return data === undefined ? initialValue : data\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAwEA,SAAgB,cAId,EACA,UACA,cAAc,SACd,WAAW,OAAO,UAChBA,cAAAA,SAAS,OAA8B,KAAK,GAC9C,eAAe,CAAC,KAIhB;CACA,OAAO,OAAO,YAAY;EAExB,MAAM,SAASC,QAAcC,cAAAA;EAC7B,IAAA,WAAA,QAAA,WAAA,KAAA,IAAA,KAAA,IAAI,OAAQ,SACV,OAAO;EAGT,MAAM,QAAQ,QAAQ,OACnB,cAAc,CAAC,CACf,KAAK;GAAE,UAAU,QAAQ;GAAU,OAAO;EAAK,CAAC;EACnD,MAAM,YAAY,CAAC,CAAC,SAAS,MAAM,UAAU;EAC7C,IAAI,aAAa,gBAAgB,SAC/B,MAAM,SAAS;GACb,GAAG,MAAM;GACT,aAAa;EACf,CAAC;EAGH,IAAI,SAAS;EAEb,IAAI,YAAY;EAChB,MAAM,kBAAkBC,cAAAA,sBAGtB;GACE,QAAQ,QAAQ;GAChB,MAAM,QAAQ;GACd,UAAU,QAAQ;GAClB,WAAW,QAAQ;GACnB,WAAW,QAAQ;EACrB,SACM,QAAQ,cACP,YAAY,MACnB,MACF;EAEA,MAAM,yBAAyB,cAAA,WAAA,QAAA,WAAA,KAAA,IAAA,KAAA,IAAa,OAAQ,aAAY;EAChE,MAAM,SAAS,MAAM,SAAS,eAAe;EAE7C,MAAM,mBAAmB,aAAa,gBAAgB;EAEtD,WAAW,MAAM,SAAS,QAAQ;GAChC,IAAI,iBAAiB,GACnB;GAGF,IAAI,kBAEF,SAAS,QAAQ,QAAQ,KAAK;QAE9B,QAAQ,OAAO,aAAoB,QAAQ,WAAW,SACpD,QAAQ,SAAS,KAAA,IAAY,eAAe,MAAM,KAAK,CACzD;EAEJ;EAGA,IAAI,oBAAoB,CAAC,iBAAiB,GACxC,QAAQ,OAAO,aAAoB,QAAQ,UAAU,MAAM;EAG7D,MAAM,OAAO,QAAQ,OAAO,aAAoB,QAAQ,QAAQ;EAChE,OAAO,SAAS,KAAA,IAAY,eAAe;CAC7C;AACF"}
|
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
import { Ct as QueryKey, St as QueryFunctionContext, xt as QueryFunction } from "./hydration-
|
|
2
|
-
//#region src/streamedQuery.d.ts
|
|
1
|
+
import { Ct as QueryKey, St as QueryFunctionContext, xt as QueryFunction } from "./hydration-BXjqUj_D.cjs";
|
|
3
2
|
type BaseStreamedQueryParams<TQueryFnData, TQueryKey extends QueryKey> = {
|
|
4
3
|
/** The function that returns an `AsyncIterable` to stream data from. */
|
|
5
4
|
streamFn: (context: QueryFunctionContext<TQueryKey>) => AsyncIterable<TQueryFnData> | Promise<AsyncIterable<TQueryFnData>>;
|
|
@@ -33,6 +32,8 @@ type StreamedQueryParams<TQueryFnData, TData, TQueryKey extends QueryKey> = Simp
|
|
|
33
32
|
* Data will be an Array of all the chunks received.
|
|
34
33
|
* The query will be in a 'pending' state until the first chunk of data is received, but will go to 'success' after that.
|
|
35
34
|
* The query will stay in fetchStatus 'fetching' until the stream ends.
|
|
35
|
+
* Explicit cancellation stops further cache updates, even if `streamFn` does not read `signal`.
|
|
36
|
+
* If `streamFn` does not read `signal`, the stream continues after the last observer unsubscribes.
|
|
36
37
|
* @param options - The `streamFn` that returns an AsyncIterable to stream data from, and the optional
|
|
37
38
|
* `refetchMode`, `reducer`, and `initialValue` options.
|
|
38
39
|
* @returns A query function to pass as `queryFn`.
|
|
@@ -47,5 +48,4 @@ type StreamedQueryParams<TQueryFnData, TData, TQueryKey extends QueryKey> = Simp
|
|
|
47
48
|
* ```
|
|
48
49
|
*/
|
|
49
50
|
export declare function streamedQuery<TQueryFnData = unknown, TData = Array<TQueryFnData>, TQueryKey extends QueryKey = QueryKey>({ streamFn, refetchMode, reducer, initialValue }: StreamedQueryParams<TQueryFnData, TData, TQueryKey>): QueryFunction<TData, TQueryKey>;
|
|
50
|
-
//#endregion
|
|
51
51
|
//# sourceMappingURL=streamedQuery.d.cts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"streamedQuery.d.cts","names":[],"sources":["../../src/streamedQuery.ts"],"mappings":"
|
|
1
|
+
{"version":3,"file":"streamedQuery.d.cts","names":[],"sources":["../../src/streamedQuery.ts"],"mappings":";KASK,wBAAwB,cAAc,kBAAkB;;EAE3D,WACE,SAAS,qBAAqB,eAC3B,cAAc,gBAAgB,QAAQ,cAAc;;;;;;;EAOzD;;KAGG,0BACH,cACA,kBAAkB,YAChB,wBAAwB,cAAc;EACxC;EACA;;KAGG,6BACH,cACA,OACA,kBAAkB,YAChB,wBAAwB,cAAc;;;;;EAKxC,UAAU,KAAK,OAAO,OAAO,iBAAiB;;;;;EAK9C,cAAc;;KAGX,oBAAoB,cAAc,OAAO,kBAAkB,YAC5D,0BAA0B,cAAc,aACxC,6BAA6B,cAAc,OAAO;;;;;;;;;;;;;;;;;;;;;wBAsBtC,cACd,wBACA,QAAQ,MAAM,eACd,kBAAkB,WAAW,YAE7B,UACA,aACA,SAEA,gBACC,oBAAoB,cAAc,OAAO,aAAa,cACvD,OACA"}
|
|
@@ -1,5 +1,4 @@
|
|
|
1
|
-
import { Ct as QueryKey, St as QueryFunctionContext, xt as QueryFunction } from "./hydration-
|
|
2
|
-
//#region src/streamedQuery.d.ts
|
|
1
|
+
import { Ct as QueryKey, St as QueryFunctionContext, xt as QueryFunction } from "./hydration-vgIjIhk6.js";
|
|
3
2
|
type BaseStreamedQueryParams<TQueryFnData, TQueryKey extends QueryKey> = {
|
|
4
3
|
/** The function that returns an `AsyncIterable` to stream data from. */
|
|
5
4
|
streamFn: (context: QueryFunctionContext<TQueryKey>) => AsyncIterable<TQueryFnData> | Promise<AsyncIterable<TQueryFnData>>;
|
|
@@ -33,6 +32,8 @@ type StreamedQueryParams<TQueryFnData, TData, TQueryKey extends QueryKey> = Simp
|
|
|
33
32
|
* Data will be an Array of all the chunks received.
|
|
34
33
|
* The query will be in a 'pending' state until the first chunk of data is received, but will go to 'success' after that.
|
|
35
34
|
* The query will stay in fetchStatus 'fetching' until the stream ends.
|
|
35
|
+
* Explicit cancellation stops further cache updates, even if `streamFn` does not read `signal`.
|
|
36
|
+
* If `streamFn` does not read `signal`, the stream continues after the last observer unsubscribes.
|
|
36
37
|
* @param options - The `streamFn` that returns an AsyncIterable to stream data from, and the optional
|
|
37
38
|
* `refetchMode`, `reducer`, and `initialValue` options.
|
|
38
39
|
* @returns A query function to pass as `queryFn`.
|
|
@@ -47,5 +48,4 @@ type StreamedQueryParams<TQueryFnData, TData, TQueryKey extends QueryKey> = Simp
|
|
|
47
48
|
* ```
|
|
48
49
|
*/
|
|
49
50
|
export declare function streamedQuery<TQueryFnData = unknown, TData = Array<TQueryFnData>, TQueryKey extends QueryKey = QueryKey>({ streamFn, refetchMode, reducer, initialValue }: StreamedQueryParams<TQueryFnData, TData, TQueryKey>): QueryFunction<TData, TQueryKey>;
|
|
50
|
-
//#endregion
|
|
51
51
|
//# sourceMappingURL=streamedQuery.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"streamedQuery.d.ts","names":[],"sources":["../../src/streamedQuery.ts"],"mappings":"
|
|
1
|
+
{"version":3,"file":"streamedQuery.d.ts","names":[],"sources":["../../src/streamedQuery.ts"],"mappings":";KASK,wBAAwB,cAAc,kBAAkB;;EAE3D,WACE,SAAS,qBAAqB,eAC3B,cAAc,gBAAgB,QAAQ,cAAc;;;;;;;EAOzD;;KAGG,0BACH,cACA,kBAAkB,YAChB,wBAAwB,cAAc;EACxC;EACA;;KAGG,6BACH,cACA,OACA,kBAAkB,YAChB,wBAAwB,cAAc;;;;;EAKxC,UAAU,KAAK,OAAO,OAAO,iBAAiB;;;;;EAK9C,cAAc;;KAGX,oBAAoB,cAAc,OAAO,kBAAkB,YAC5D,0BAA0B,cAAc,aACxC,6BAA6B,cAAc,OAAO;;;;;;;;;;;;;;;;;;;;;wBAsBtC,cACd,wBACA,QAAQ,MAAM,eACd,kBAAkB,WAAW,YAE7B,UACA,aACA,SAEA,gBACC,oBAAoB,cAAc,OAAO,aAAa,cACvD,OACA"}
|
|
@@ -1,10 +1,12 @@
|
|
|
1
|
-
import { addConsumeAwareSignal, addToEnd } from "./utils.js";
|
|
2
|
-
|
|
1
|
+
import { addConsumeAwareSignal, addToEnd, fetchSignal } from "./utils.js";
|
|
2
|
+
// src/streamedQuery.ts
|
|
3
3
|
/**
|
|
4
4
|
* This is a helper function to create a query function that streams data from an AsyncIterable.
|
|
5
5
|
* Data will be an Array of all the chunks received.
|
|
6
6
|
* The query will be in a 'pending' state until the first chunk of data is received, but will go to 'success' after that.
|
|
7
7
|
* The query will stay in fetchStatus 'fetching' until the stream ends.
|
|
8
|
+
* Explicit cancellation stops further cache updates, even if `streamFn` does not read `signal`.
|
|
9
|
+
* If `streamFn` does not read `signal`, the stream continues after the last observer unsubscribes.
|
|
8
10
|
* @param options - The `streamFn` that returns an AsyncIterable to stream data from, and the optional
|
|
9
11
|
* `refetchMode`, `reducer`, and `initialValue` options.
|
|
10
12
|
* @returns A query function to pass as `queryFn`.
|
|
@@ -20,6 +22,8 @@ import { addConsumeAwareSignal, addToEnd } from "./utils.js";
|
|
|
20
22
|
*/
|
|
21
23
|
function streamedQuery({ streamFn, refetchMode = "reset", reducer = (items, chunk) => addToEnd(items, chunk), initialValue = [] }) {
|
|
22
24
|
return async (context) => {
|
|
25
|
+
const signal = context[fetchSignal];
|
|
26
|
+
if (signal === null || signal === void 0 ? void 0 : signal.aborted) return initialValue;
|
|
23
27
|
const query = context.client.getQueryCache().find({
|
|
24
28
|
queryKey: context.queryKey,
|
|
25
29
|
exact: true
|
|
@@ -31,25 +35,26 @@ function streamedQuery({ streamFn, refetchMode = "reset", reducer = (items, chun
|
|
|
31
35
|
});
|
|
32
36
|
let result = initialValue;
|
|
33
37
|
let cancelled = false;
|
|
34
|
-
const
|
|
38
|
+
const streamFnContext = addConsumeAwareSignal({
|
|
35
39
|
client: context.client,
|
|
36
40
|
meta: context.meta,
|
|
37
41
|
queryKey: context.queryKey,
|
|
38
42
|
pageParam: context.pageParam,
|
|
39
43
|
direction: context.direction
|
|
40
|
-
}, () => context.signal, () => cancelled = true)
|
|
44
|
+
}, () => context.signal, () => cancelled = true, signal);
|
|
45
|
+
const isStreamInactive = () => cancelled || (signal === null || signal === void 0 ? void 0 : signal.aborted) === true;
|
|
46
|
+
const stream = await streamFn(streamFnContext);
|
|
41
47
|
const isReplaceRefetch = isRefetch && refetchMode === "replace";
|
|
42
48
|
for await (const chunk of stream) {
|
|
43
|
-
if (
|
|
49
|
+
if (isStreamInactive()) break;
|
|
44
50
|
if (isReplaceRefetch) result = reducer(result, chunk);
|
|
45
51
|
else context.client.setQueryData(context.queryKey, (prev) => reducer(prev === void 0 ? initialValue : prev, chunk));
|
|
46
52
|
}
|
|
47
|
-
if (isReplaceRefetch && !
|
|
53
|
+
if (isReplaceRefetch && !isStreamInactive()) context.client.setQueryData(context.queryKey, result);
|
|
48
54
|
const data = context.client.getQueryData(context.queryKey);
|
|
49
55
|
return data === void 0 ? initialValue : data;
|
|
50
56
|
};
|
|
51
57
|
}
|
|
52
|
-
//#endregion
|
|
53
58
|
export { streamedQuery };
|
|
54
59
|
|
|
55
60
|
//# sourceMappingURL=streamedQuery.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"streamedQuery.js","names":[],"sources":["../../src/streamedQuery.ts"],"sourcesContent":["import { addConsumeAwareSignal, addToEnd } from './utils'\nimport type {\n OmitKeyof,\n QueryFunction,\n QueryFunctionContext,\n QueryKey,\n} from './types'\n\ntype BaseStreamedQueryParams<TQueryFnData, TQueryKey extends QueryKey> = {\n /** The function that returns an `AsyncIterable` to stream data from. */\n streamFn: (\n context: QueryFunctionContext<TQueryKey>,\n ) => AsyncIterable<TQueryFnData> | Promise<AsyncIterable<TQueryFnData>>\n /**\n * Defines how refetches are handled.\n * - `'reset'` (default): erases all data and puts the query back into `pending` state.\n * - `'append'`: appends new data to the existing data.\n * - `'replace'`: writes all data to the cache once the stream ends.\n */\n refetchMode?: 'append' | 'reset' | 'replace'\n}\n\ntype SimpleStreamedQueryParams<\n TQueryFnData,\n TQueryKey extends QueryKey,\n> = BaseStreamedQueryParams<TQueryFnData, TQueryKey> & {\n reducer?: never\n initialValue?: never\n}\n\ntype ReducibleStreamedQueryParams<\n TQueryFnData,\n TData,\n TQueryKey extends QueryKey,\n> = BaseStreamedQueryParams<TQueryFnData, TQueryKey> & {\n /**\n * Reduces streamed chunks into the final data shape. Required whenever `TData` is not an\n * array, since there is no default way to accumulate non-array chunks.\n */\n reducer: (acc: TData, chunk: TQueryFnData) => TData\n /**\n * The value used while the first chunk is being fetched, and returned if the stream yields no\n * values. Required together with a custom `reducer`.\n */\n initialValue: TData\n}\n\ntype StreamedQueryParams<TQueryFnData, TData, TQueryKey extends QueryKey> =\n | SimpleStreamedQueryParams<TQueryFnData, TQueryKey>\n | ReducibleStreamedQueryParams<TQueryFnData, TData, TQueryKey>\n\n/**\n * This is a helper function to create a query function that streams data from an AsyncIterable.\n * Data will be an Array of all the chunks received.\n * The query will be in a 'pending' state until the first chunk of data is received, but will go to 'success' after that.\n * The query will stay in fetchStatus 'fetching' until the stream ends.\n * @param options - The `streamFn` that returns an AsyncIterable to stream data from, and the optional\n * `refetchMode`, `reducer`, and `initialValue` options.\n * @returns A query function to pass as `queryFn`.\n * @example\n * ```ts\n * await queryClient.query({\n * queryKey: ['data'],\n * queryFn: streamedQuery({\n * streamFn: fetchDataInChunks,\n * }),\n * })\n * ```\n */\nexport function streamedQuery<\n TQueryFnData = unknown,\n TData = Array<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n>({\n streamFn,\n refetchMode = 'reset',\n reducer = (items, chunk) =>\n addToEnd(items as Array<TQueryFnData>, chunk) as TData,\n initialValue = [] as TData,\n}: StreamedQueryParams<TQueryFnData, TData, TQueryKey>): QueryFunction<\n TData,\n TQueryKey\n> {\n return async (context) => {\n const query = context.client\n .getQueryCache()\n .find({ queryKey: context.queryKey, exact: true })\n const isRefetch = !!query && query.isFetched()\n if (isRefetch && refetchMode === 'reset') {\n query.setState({\n ...query.resetState,\n fetchStatus: 'fetching',\n })\n }\n\n let result = initialValue\n\n let cancelled = false as boolean\n const streamFnContext = addConsumeAwareSignal<\n OmitKeyof<typeof context, 'signal'>\n >(\n {\n client: context.client,\n meta: context.meta,\n queryKey: context.queryKey,\n pageParam: context.pageParam,\n direction: context.direction,\n },\n () => context.signal,\n () => (cancelled = true),\n )\n\n const stream = await streamFn(streamFnContext)\n\n const isReplaceRefetch = isRefetch && refetchMode === 'replace'\n\n for await (const chunk of stream) {\n if (
|
|
1
|
+
{"version":3,"file":"streamedQuery.js","names":["signalContext"],"sources":["../../src/streamedQuery.ts"],"sourcesContent":["import { addConsumeAwareSignal, addToEnd, fetchSignal } from './utils'\nimport type { FetchSignalContext } from './utils'\nimport type {\n OmitKeyof,\n QueryFunction,\n QueryFunctionContext,\n QueryKey,\n} from './types'\n\ntype BaseStreamedQueryParams<TQueryFnData, TQueryKey extends QueryKey> = {\n /** The function that returns an `AsyncIterable` to stream data from. */\n streamFn: (\n context: QueryFunctionContext<TQueryKey>,\n ) => AsyncIterable<TQueryFnData> | Promise<AsyncIterable<TQueryFnData>>\n /**\n * Defines how refetches are handled.\n * - `'reset'` (default): erases all data and puts the query back into `pending` state.\n * - `'append'`: appends new data to the existing data.\n * - `'replace'`: writes all data to the cache once the stream ends.\n */\n refetchMode?: 'append' | 'reset' | 'replace'\n}\n\ntype SimpleStreamedQueryParams<\n TQueryFnData,\n TQueryKey extends QueryKey,\n> = BaseStreamedQueryParams<TQueryFnData, TQueryKey> & {\n reducer?: never\n initialValue?: never\n}\n\ntype ReducibleStreamedQueryParams<\n TQueryFnData,\n TData,\n TQueryKey extends QueryKey,\n> = BaseStreamedQueryParams<TQueryFnData, TQueryKey> & {\n /**\n * Reduces streamed chunks into the final data shape. Required whenever `TData` is not an\n * array, since there is no default way to accumulate non-array chunks.\n */\n reducer: (acc: TData, chunk: TQueryFnData) => TData\n /**\n * The value used while the first chunk is being fetched, and returned if the stream yields no\n * values. Required together with a custom `reducer`.\n */\n initialValue: TData\n}\n\ntype StreamedQueryParams<TQueryFnData, TData, TQueryKey extends QueryKey> =\n | SimpleStreamedQueryParams<TQueryFnData, TQueryKey>\n | ReducibleStreamedQueryParams<TQueryFnData, TData, TQueryKey>\n\n/**\n * This is a helper function to create a query function that streams data from an AsyncIterable.\n * Data will be an Array of all the chunks received.\n * The query will be in a 'pending' state until the first chunk of data is received, but will go to 'success' after that.\n * The query will stay in fetchStatus 'fetching' until the stream ends.\n * Explicit cancellation stops further cache updates, even if `streamFn` does not read `signal`.\n * If `streamFn` does not read `signal`, the stream continues after the last observer unsubscribes.\n * @param options - The `streamFn` that returns an AsyncIterable to stream data from, and the optional\n * `refetchMode`, `reducer`, and `initialValue` options.\n * @returns A query function to pass as `queryFn`.\n * @example\n * ```ts\n * await queryClient.query({\n * queryKey: ['data'],\n * queryFn: streamedQuery({\n * streamFn: fetchDataInChunks,\n * }),\n * })\n * ```\n */\nexport function streamedQuery<\n TQueryFnData = unknown,\n TData = Array<TQueryFnData>,\n TQueryKey extends QueryKey = QueryKey,\n>({\n streamFn,\n refetchMode = 'reset',\n reducer = (items, chunk) =>\n addToEnd(items as Array<TQueryFnData>, chunk) as TData,\n initialValue = [] as TData,\n}: StreamedQueryParams<TQueryFnData, TData, TQueryKey>): QueryFunction<\n TData,\n TQueryKey\n> {\n return async (context) => {\n const signalContext: FetchSignalContext = context\n const signal = signalContext[fetchSignal]\n if (signal?.aborted) {\n return initialValue\n }\n\n const query = context.client\n .getQueryCache()\n .find({ queryKey: context.queryKey, exact: true })\n const isRefetch = !!query && query.isFetched()\n if (isRefetch && refetchMode === 'reset') {\n query.setState({\n ...query.resetState,\n fetchStatus: 'fetching',\n })\n }\n\n let result = initialValue\n\n let cancelled = false as boolean\n const streamFnContext = addConsumeAwareSignal<\n OmitKeyof<typeof context, 'signal'>\n >(\n {\n client: context.client,\n meta: context.meta,\n queryKey: context.queryKey,\n pageParam: context.pageParam,\n direction: context.direction,\n },\n () => context.signal,\n () => (cancelled = true),\n signal,\n )\n\n const isStreamInactive = () => cancelled || signal?.aborted === true\n const stream = await streamFn(streamFnContext)\n\n const isReplaceRefetch = isRefetch && refetchMode === 'replace'\n\n for await (const chunk of stream) {\n if (isStreamInactive()) {\n break\n }\n\n if (isReplaceRefetch) {\n // don't append to the cache directly when replace-refetching\n result = reducer(result, chunk)\n } else {\n context.client.setQueryData<TData>(context.queryKey, (prev) =>\n reducer(prev === undefined ? initialValue : prev, chunk),\n )\n }\n }\n\n // finalize result: replace-refetching needs to write to the cache\n if (isReplaceRefetch && !isStreamInactive()) {\n context.client.setQueryData<TData>(context.queryKey, result)\n }\n\n const data = context.client.getQueryData<TData>(context.queryKey)\n return data === undefined ? initialValue : data\n }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;AAwEA,SAAgB,cAId,EACA,UACA,cAAc,SACd,WAAW,OAAO,UAChB,SAAS,OAA8B,KAAK,GAC9C,eAAe,CAAC,KAIhB;CACA,OAAO,OAAO,YAAY;EAExB,MAAM,SAASA,QAAc;EAC7B,IAAA,WAAA,QAAA,WAAA,KAAA,IAAA,KAAA,IAAI,OAAQ,SACV,OAAO;EAGT,MAAM,QAAQ,QAAQ,OACnB,cAAc,CAAC,CACf,KAAK;GAAE,UAAU,QAAQ;GAAU,OAAO;EAAK,CAAC;EACnD,MAAM,YAAY,CAAC,CAAC,SAAS,MAAM,UAAU;EAC7C,IAAI,aAAa,gBAAgB,SAC/B,MAAM,SAAS;GACb,GAAG,MAAM;GACT,aAAa;EACf,CAAC;EAGH,IAAI,SAAS;EAEb,IAAI,YAAY;EAChB,MAAM,kBAAkB,sBAGtB;GACE,QAAQ,QAAQ;GAChB,MAAM,QAAQ;GACd,UAAU,QAAQ;GAClB,WAAW,QAAQ;GACnB,WAAW,QAAQ;EACrB,SACM,QAAQ,cACP,YAAY,MACnB,MACF;EAEA,MAAM,yBAAyB,cAAA,WAAA,QAAA,WAAA,KAAA,IAAA,KAAA,IAAa,OAAQ,aAAY;EAChE,MAAM,SAAS,MAAM,SAAS,eAAe;EAE7C,MAAM,mBAAmB,aAAa,gBAAgB;EAEtD,WAAW,MAAM,SAAS,QAAQ;GAChC,IAAI,iBAAiB,GACnB;GAGF,IAAI,kBAEF,SAAS,QAAQ,QAAQ,KAAK;QAE9B,QAAQ,OAAO,aAAoB,QAAQ,WAAW,SACpD,QAAQ,SAAS,KAAA,IAAY,eAAe,MAAM,KAAK,CACzD;EAEJ;EAGA,IAAI,oBAAoB,CAAC,iBAAiB,GACxC,QAAQ,OAAO,aAAoB,QAAQ,UAAU,MAAM;EAG7D,MAAM,OAAO,QAAQ,OAAO,aAAoB,QAAQ,QAAQ;EAChE,OAAO,SAAS,KAAA,IAAY,eAAe;CAC7C;AACF"}
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
//#region src/subscribable.d.ts
|
|
2
1
|
/**
|
|
3
2
|
* The base class behind everything in Query that you can subscribe to: `QueryCache`, `MutationCache`,
|
|
4
3
|
* the observers, and the `FocusManager`/`OnlineManager` behind `focusManager` and `onlineManager`.
|
|
@@ -39,6 +38,5 @@ declare class Subscribable<TListener extends Function> {
|
|
|
39
38
|
*/
|
|
40
39
|
protected onUnsubscribe(): void;
|
|
41
40
|
}
|
|
42
|
-
//#endregion
|
|
43
41
|
export { Subscribable as t };
|
|
44
|
-
//# sourceMappingURL=subscribable-
|
|
42
|
+
//# sourceMappingURL=subscribable-D2lAzdDi.d.cts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"subscribable-D2lAzdDi.d.cts","names":[],"sources":["../../src/subscribable.ts"],"mappings":";;;;;cAKa,aAAa,kBAAkB;YAChC,WAAS,IAAA;;;;;;;;;;;;;;;;;EAqBnB,UAAU,UAAU;;;;;EAepB;;;;;YAQU;;;;;YAQA"}
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
//#region src/subscribable.d.ts
|
|
2
1
|
/**
|
|
3
2
|
* The base class behind everything in Query that you can subscribe to: `QueryCache`, `MutationCache`,
|
|
4
3
|
* the observers, and the `FocusManager`/`OnlineManager` behind `focusManager` and `onlineManager`.
|
|
@@ -39,6 +38,5 @@ declare class Subscribable<TListener extends Function> {
|
|
|
39
38
|
*/
|
|
40
39
|
protected onUnsubscribe(): void;
|
|
41
40
|
}
|
|
42
|
-
//#endregion
|
|
43
41
|
export { Subscribable as t };
|
|
44
|
-
//# sourceMappingURL=subscribable-
|
|
42
|
+
//# sourceMappingURL=subscribable-D2lAzdDi.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"subscribable-D2lAzdDi.d.ts","names":[],"sources":["../../src/subscribable.ts"],"mappings":";;;;;cAKa,aAAa,kBAAkB;YAChC,WAAS,IAAA;;;;;;;;;;;;;;;;;EAqBnB,UAAU,UAAU;;;;;EAepB;;;;;YAQU;;;;;YAQA"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
2
|
-
|
|
2
|
+
// src/subscribable.ts
|
|
3
3
|
/**
|
|
4
4
|
* The base class behind everything in Query that you can subscribe to: `QueryCache`, `MutationCache`,
|
|
5
5
|
* the observers, and the `FocusManager`/`OnlineManager` behind `focusManager` and `onlineManager`.
|
|
@@ -51,7 +51,6 @@ var Subscribable = class {
|
|
|
51
51
|
*/
|
|
52
52
|
onUnsubscribe() {}
|
|
53
53
|
};
|
|
54
|
-
//#endregion
|
|
55
54
|
exports.Subscribable = Subscribable;
|
|
56
55
|
|
|
57
56
|
//# sourceMappingURL=subscribable.cjs.map
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { t as Subscribable } from "./subscribable-
|
|
1
|
+
import { t as Subscribable } from "./subscribable-D2lAzdDi.cjs";
|
|
2
2
|
export { Subscribable };
|
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { t as Subscribable } from "./subscribable-
|
|
1
|
+
import { t as Subscribable } from "./subscribable-D2lAzdDi.js";
|
|
2
2
|
export { Subscribable };
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
|
|
1
|
+
// src/subscribable.ts
|
|
2
2
|
/**
|
|
3
3
|
* The base class behind everything in Query that you can subscribe to: `QueryCache`, `MutationCache`,
|
|
4
4
|
* the observers, and the `FocusManager`/`OnlineManager` behind `focusManager` and `onlineManager`.
|
|
@@ -50,7 +50,6 @@ var Subscribable = class {
|
|
|
50
50
|
*/
|
|
51
51
|
onUnsubscribe() {}
|
|
52
52
|
};
|
|
53
|
-
//#endregion
|
|
54
53
|
export { Subscribable };
|
|
55
54
|
|
|
56
55
|
//# sourceMappingURL=subscribable.js.map
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
2
|
-
const require_classPrivateFieldSet2 = require("./classPrivateFieldSet2-
|
|
3
|
-
|
|
2
|
+
const require_classPrivateFieldSet2 = require("./classPrivateFieldSet2-C_J9s9he.cjs");
|
|
3
|
+
// src/timeoutManager.ts
|
|
4
4
|
const defaultTimeoutProvider = {
|
|
5
5
|
setTimeout: (callback, delay) => setTimeout(callback, delay),
|
|
6
6
|
clearTimeout: (timeoutId) => clearTimeout(timeoutId),
|
|
@@ -165,7 +165,6 @@ const timeoutManager = new TimeoutManager();
|
|
|
165
165
|
function systemSetTimeoutZero(callback) {
|
|
166
166
|
setTimeout(callback, 0);
|
|
167
167
|
}
|
|
168
|
-
//#endregion
|
|
169
168
|
exports.TimeoutManager = TimeoutManager;
|
|
170
169
|
exports.defaultTimeoutProvider = defaultTimeoutProvider;
|
|
171
170
|
exports.systemSetTimeoutZero = systemSetTimeoutZero;
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
//#region src/timeoutManager.d.ts
|
|
2
1
|
/**
|
|
3
2
|
* {@link TimeoutManager} does not support passing arguments to the callback.
|
|
4
3
|
*
|
|
@@ -177,5 +176,4 @@ export declare const timeoutManager: TimeoutManager;
|
|
|
177
176
|
* @param callback - The function to call on the next event loop tick.
|
|
178
177
|
*/
|
|
179
178
|
export declare function systemSetTimeoutZero(callback: TimeoutCallback): void;
|
|
180
|
-
//#endregion
|
|
181
179
|
//# sourceMappingURL=timeoutManager.d.cts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"timeoutManager.d.cts","names":[],"sources":["../../src/timeoutManager.ts"],"mappings":"
|
|
1
|
+
{"version":3,"file":"timeoutManager.d.cts","names":[],"sources":["../../src/timeoutManager.ts"],"mappings":";;;;;;;;YAQY,mBAAmB;;;;;;;YAQnB;GAA6B,OAAO;;;;;;;;;;;YAWpC,gBAAgB,iBAAiB,iBAAiB;;;;WAKjD,aAAa,UAAU,iBAAiB,kBAAkB;;;;WAI1D,eAAe,WAAW;;;;WAK1B,cAAc,UAAU,iBAAiB,kBAAkB;;;;WAI3D,gBAAgB,YAAY;;qBAK5B,wBAAwB;;;;;;;;;;;;qBA+BxB,0BAA0B,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;EAoC1C,mBAAmB,iBAAiB,gBAClC,UAAU,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;EAkD5B,WAAW,UAAU,iBAAiB,gBAAgB;;;;;;;;;;;;;;;;;;EAwBtD,aAAa,WAAW;;;;;;;;;;;;;;;;;;;;EAuBxB,YAAY,UAAU,iBAAiB,gBAAgB;;;;;;;;;;;;;;;;;;EAwBvD,cAAc,YAAY;;;;;qBAQf,gBAAc;;;;;;;;;wBAUX,qBAAqB,UAAU"}
|
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
//#region src/timeoutManager.d.ts
|
|
2
1
|
/**
|
|
3
2
|
* {@link TimeoutManager} does not support passing arguments to the callback.
|
|
4
3
|
*
|
|
@@ -177,5 +176,4 @@ export declare const timeoutManager: TimeoutManager;
|
|
|
177
176
|
* @param callback - The function to call on the next event loop tick.
|
|
178
177
|
*/
|
|
179
178
|
export declare function systemSetTimeoutZero(callback: TimeoutCallback): void;
|
|
180
|
-
//#endregion
|
|
181
179
|
//# sourceMappingURL=timeoutManager.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"timeoutManager.d.ts","names":[],"sources":["../../src/timeoutManager.ts"],"mappings":"
|
|
1
|
+
{"version":3,"file":"timeoutManager.d.ts","names":[],"sources":["../../src/timeoutManager.ts"],"mappings":";;;;;;;;YAQY,mBAAmB;;;;;;;YAQnB;GAA6B,OAAO;;;;;;;;;;;YAWpC,gBAAgB,iBAAiB,iBAAiB;;;;WAKjD,aAAa,UAAU,iBAAiB,kBAAkB;;;;WAI1D,eAAe,WAAW;;;;WAK1B,cAAc,UAAU,iBAAiB,kBAAkB;;;;WAI3D,gBAAgB,YAAY;;qBAK5B,wBAAwB;;;;;;;;;;;;qBA+BxB,0BAA0B,KAAK;;;;;;;;;;;;;;;;;;;;;;;;;;;EAoC1C,mBAAmB,iBAAiB,gBAClC,UAAU,gBAAgB;;;;;;;;;;;;;;;;;;;;;;;EAkD5B,WAAW,UAAU,iBAAiB,gBAAgB;;;;;;;;;;;;;;;;;;EAwBtD,aAAa,WAAW;;;;;;;;;;;;;;;;;;;;EAuBxB,YAAY,UAAU,iBAAiB,gBAAgB;;;;;;;;;;;;;;;;;;EAwBvD,cAAc,YAAY;;;;;qBAQf,gBAAc;;;;;;;;;wBAUX,qBAAqB,UAAU"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { i as _classPrivateFieldInitSpec, n as _classPrivateFieldGet2, t as _classPrivateFieldSet2 } from "./classPrivateFieldSet2-
|
|
2
|
-
|
|
1
|
+
import { i as _classPrivateFieldInitSpec, n as _classPrivateFieldGet2, t as _classPrivateFieldSet2 } from "./classPrivateFieldSet2-CWIQ5CvM.js";
|
|
2
|
+
// src/timeoutManager.ts
|
|
3
3
|
const defaultTimeoutProvider = {
|
|
4
4
|
setTimeout: (callback, delay) => setTimeout(callback, delay),
|
|
5
5
|
clearTimeout: (timeoutId) => clearTimeout(timeoutId),
|
|
@@ -164,7 +164,6 @@ const timeoutManager = new TimeoutManager();
|
|
|
164
164
|
function systemSetTimeoutZero(callback) {
|
|
165
165
|
setTimeout(callback, 0);
|
|
166
166
|
}
|
|
167
|
-
//#endregion
|
|
168
167
|
export { TimeoutManager, defaultTimeoutProvider, systemSetTimeoutZero, timeoutManager };
|
|
169
168
|
|
|
170
169
|
//# sourceMappingURL=timeoutManager.js.map
|
package/build/legacy/types.cjs
CHANGED
|
@@ -1,10 +1,9 @@
|
|
|
1
1
|
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
2
|
-
|
|
2
|
+
// src/types.ts
|
|
3
3
|
/* istanbul ignore file */
|
|
4
4
|
const dataTagSymbol = Symbol();
|
|
5
5
|
const dataTagErrorSymbol = Symbol();
|
|
6
6
|
const unsetMarker = Symbol();
|
|
7
|
-
//#endregion
|
|
8
7
|
exports.dataTagErrorSymbol = dataTagErrorSymbol;
|
|
9
8
|
exports.dataTagSymbol = dataTagSymbol;
|
|
10
9
|
exports.unsetMarker = unsetMarker;
|
package/build/legacy/types.d.cts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { $ as MutationObserverBaseResult, A as InfiniteData, At as QueryObserverOptions, B as InfiniteQueryObserverSuccessResult, Bt as RefetchQueryFilters, C as FetchPreviousPageOptions, Ct as QueryKey, D as GetPreviousPageParamFunction, Dt as QueryObserverBaseResult, E as GetNextPageParamFunction, Et as QueryMeta, F as InfiniteQueryObserverOptions, Ft as QueryObserverSuccessResult, G as InvalidateQueryFilters, Gt as StaleTime, H as InitialDataFunction, Ht as ResetOptions, I as InfiniteQueryObserverPendingResult, It as QueryOptions, J as MutateOptions, Jt as UnsetMarker, K as MutateFunction, Kt as StaleTimeFunction, L as InfiniteQueryObserverPlaceholderResult, Lt as QueryPersister, M as InfiniteQueryObserverBaseResult, Mt as QueryObserverPlaceholderResult, N as InfiniteQueryObserverLoadingErrorResult, Nt as QueryObserverRefetchErrorResult, O as InferDataFromTag, Ot as QueryObserverLoadingErrorResult, P as InfiniteQueryObserverLoadingResult, Pt as QueryObserverResult, Q as MutationMeta, Qt as unsetMarker, R as InfiniteQueryObserverRefetchErrorResult, Rt as QueryStatus, S as FetchNextPageOptions, St as QueryFunctionContext, T as FetchStatus, Tt as QueryKeyWithDataTag, U as InitialPageParam, Ut as ResultOptions, V as InfiniteQueryPageParamsOptions, Vt as Register, W as InvalidateOptions, Wt as SetDataOptions, X as MutationFunctionContext, Xt as dataTagErrorSymbol, Y as MutationFunction, Yt as WithRequired, Z as MutationKey, Zt as dataTagSymbol, _ as DefinedQueryObserverResult, _t as QueriesPlaceholderDataFunction, at as MutationObserverSuccessResult, b as EnsureQueryDataOptions, bt as QueryExecuteOptions, ct as MutationStatus, d as DataTag, dt as NotifyEvent, et as MutationObserverErrorResult, f as DefaultError, ft as NotifyEventType, g as DefinedInfiniteQueryObserverResult, gt as PlaceholderDataFunction, h as DefaultedQueryObserverOptions, ht as Override, it as MutationObserverResult, j as InfiniteQueryExecuteOptions, jt as QueryObserverPendingResult, k as InferErrorFromTag, kt as QueryObserverLoadingResult, l as AnyDataTag, lt as NetworkMode, m as DefaultedInfiniteQueryObserverOptions, mt as OmitKeyof, nt as MutationObserverLoadingResult, ot as MutationOptions, p as DefaultOptions, pt as NotifyOnChangeProps, q as MutateFunctionRest, qt as ThrowOnError, rt as MutationObserverOptions, st as MutationScope, tt as MutationObserverIdleResult, u as CancelOptions, ut as NonUndefinedGuard, v as DistributiveOmit, vt as QueryBooleanOption, w as FetchQueryOptions, wt as QueryKeyHashFunction, x as FetchInfiniteQueryOptions, xt as QueryFunction, y as EnsureInfiniteQueryDataOptions, yt as QueryClientConfig, z as InfiniteQueryObserverResult, zt as RefetchOptions } from "./hydration-
|
|
1
|
+
import { $ as MutationObserverBaseResult, A as InfiniteData, At as QueryObserverOptions, B as InfiniteQueryObserverSuccessResult, Bt as RefetchQueryFilters, C as FetchPreviousPageOptions, Ct as QueryKey, D as GetPreviousPageParamFunction, Dt as QueryObserverBaseResult, E as GetNextPageParamFunction, Et as QueryMeta, F as InfiniteQueryObserverOptions, Ft as QueryObserverSuccessResult, G as InvalidateQueryFilters, Gt as StaleTime, H as InitialDataFunction, Ht as ResetOptions, I as InfiniteQueryObserverPendingResult, It as QueryOptions, J as MutateOptions, Jt as UnsetMarker, K as MutateFunction, Kt as StaleTimeFunction, L as InfiniteQueryObserverPlaceholderResult, Lt as QueryPersister, M as InfiniteQueryObserverBaseResult, Mt as QueryObserverPlaceholderResult, N as InfiniteQueryObserverLoadingErrorResult, Nt as QueryObserverRefetchErrorResult, O as InferDataFromTag, Ot as QueryObserverLoadingErrorResult, P as InfiniteQueryObserverLoadingResult, Pt as QueryObserverResult, Q as MutationMeta, Qt as unsetMarker, R as InfiniteQueryObserverRefetchErrorResult, Rt as QueryStatus, S as FetchNextPageOptions, St as QueryFunctionContext, T as FetchStatus, Tt as QueryKeyWithDataTag, U as InitialPageParam, Ut as ResultOptions, V as InfiniteQueryPageParamsOptions, Vt as Register, W as InvalidateOptions, Wt as SetDataOptions, X as MutationFunctionContext, Xt as dataTagErrorSymbol, Y as MutationFunction, Yt as WithRequired, Z as MutationKey, Zt as dataTagSymbol, _ as DefinedQueryObserverResult, _t as QueriesPlaceholderDataFunction, at as MutationObserverSuccessResult, b as EnsureQueryDataOptions, bt as QueryExecuteOptions, ct as MutationStatus, d as DataTag, dt as NotifyEvent, et as MutationObserverErrorResult, f as DefaultError, ft as NotifyEventType, g as DefinedInfiniteQueryObserverResult, gt as PlaceholderDataFunction, h as DefaultedQueryObserverOptions, ht as Override, it as MutationObserverResult, j as InfiniteQueryExecuteOptions, jt as QueryObserverPendingResult, k as InferErrorFromTag, kt as QueryObserverLoadingResult, l as AnyDataTag, lt as NetworkMode, m as DefaultedInfiniteQueryObserverOptions, mt as OmitKeyof, nt as MutationObserverLoadingResult, ot as MutationOptions, p as DefaultOptions, pt as NotifyOnChangeProps, q as MutateFunctionRest, qt as ThrowOnError, rt as MutationObserverOptions, st as MutationScope, tt as MutationObserverIdleResult, u as CancelOptions, ut as NonUndefinedGuard, v as DistributiveOmit, vt as QueryBooleanOption, w as FetchQueryOptions, wt as QueryKeyHashFunction, x as FetchInfiniteQueryOptions, xt as QueryFunction, y as EnsureInfiniteQueryDataOptions, yt as QueryClientConfig, z as InfiniteQueryObserverResult, zt as RefetchOptions } from "./hydration-BXjqUj_D.cjs";
|
|
2
2
|
export { AnyDataTag, CancelOptions, DataTag, DefaultError, DefaultOptions, DefaultedInfiniteQueryObserverOptions, DefaultedQueryObserverOptions, DefinedInfiniteQueryObserverResult, DefinedQueryObserverResult, DistributiveOmit, EnsureInfiniteQueryDataOptions, EnsureQueryDataOptions, FetchInfiniteQueryOptions, FetchNextPageOptions, FetchPreviousPageOptions, FetchQueryOptions, FetchStatus, GetNextPageParamFunction, GetPreviousPageParamFunction, InferDataFromTag, InferErrorFromTag, InfiniteData, InfiniteQueryExecuteOptions, InfiniteQueryObserverBaseResult, InfiniteQueryObserverLoadingErrorResult, InfiniteQueryObserverLoadingResult, InfiniteQueryObserverOptions, InfiniteQueryObserverPendingResult, InfiniteQueryObserverPlaceholderResult, InfiniteQueryObserverRefetchErrorResult, InfiniteQueryObserverResult, InfiniteQueryObserverSuccessResult, InfiniteQueryPageParamsOptions, InitialDataFunction, InitialPageParam, InvalidateOptions, InvalidateQueryFilters, MutateFunction, MutateFunctionRest, MutateOptions, MutationFunction, MutationFunctionContext, MutationKey, MutationMeta, MutationObserverBaseResult, MutationObserverErrorResult, MutationObserverIdleResult, MutationObserverLoadingResult, MutationObserverOptions, MutationObserverResult, MutationObserverSuccessResult, MutationOptions, MutationScope, MutationStatus, NetworkMode, NonUndefinedGuard, NotifyEvent, NotifyEventType, NotifyOnChangeProps, OmitKeyof, Override, PlaceholderDataFunction, QueriesPlaceholderDataFunction, QueryBooleanOption, QueryClientConfig, QueryExecuteOptions, QueryFunction, QueryFunctionContext, QueryKey, QueryKeyHashFunction, QueryKeyWithDataTag, QueryMeta, QueryObserverBaseResult, QueryObserverLoadingErrorResult, QueryObserverLoadingResult, QueryObserverOptions, QueryObserverPendingResult, QueryObserverPlaceholderResult, QueryObserverRefetchErrorResult, QueryObserverResult, QueryObserverSuccessResult, QueryOptions, QueryPersister, QueryStatus, RefetchOptions, RefetchQueryFilters, Register, ResetOptions, ResultOptions, SetDataOptions, StaleTime, StaleTimeFunction, ThrowOnError, UnsetMarker, WithRequired, dataTagErrorSymbol, dataTagSymbol, unsetMarker };
|
package/build/legacy/types.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
import { $ as MutationObserverBaseResult, A as InfiniteData, At as QueryObserverOptions, B as InfiniteQueryObserverSuccessResult, Bt as RefetchQueryFilters, C as FetchPreviousPageOptions, Ct as QueryKey, D as GetPreviousPageParamFunction, Dt as QueryObserverBaseResult, E as GetNextPageParamFunction, Et as QueryMeta, F as InfiniteQueryObserverOptions, Ft as QueryObserverSuccessResult, G as InvalidateQueryFilters, Gt as StaleTime, H as InitialDataFunction, Ht as ResetOptions, I as InfiniteQueryObserverPendingResult, It as QueryOptions, J as MutateOptions, Jt as UnsetMarker, K as MutateFunction, Kt as StaleTimeFunction, L as InfiniteQueryObserverPlaceholderResult, Lt as QueryPersister, M as InfiniteQueryObserverBaseResult, Mt as QueryObserverPlaceholderResult, N as InfiniteQueryObserverLoadingErrorResult, Nt as QueryObserverRefetchErrorResult, O as InferDataFromTag, Ot as QueryObserverLoadingErrorResult, P as InfiniteQueryObserverLoadingResult, Pt as QueryObserverResult, Q as MutationMeta, Qt as unsetMarker, R as InfiniteQueryObserverRefetchErrorResult, Rt as QueryStatus, S as FetchNextPageOptions, St as QueryFunctionContext, T as FetchStatus, Tt as QueryKeyWithDataTag, U as InitialPageParam, Ut as ResultOptions, V as InfiniteQueryPageParamsOptions, Vt as Register, W as InvalidateOptions, Wt as SetDataOptions, X as MutationFunctionContext, Xt as dataTagErrorSymbol, Y as MutationFunction, Yt as WithRequired, Z as MutationKey, Zt as dataTagSymbol, _ as DefinedQueryObserverResult, _t as QueriesPlaceholderDataFunction, at as MutationObserverSuccessResult, b as EnsureQueryDataOptions, bt as QueryExecuteOptions, ct as MutationStatus, d as DataTag, dt as NotifyEvent, et as MutationObserverErrorResult, f as DefaultError, ft as NotifyEventType, g as DefinedInfiniteQueryObserverResult, gt as PlaceholderDataFunction, h as DefaultedQueryObserverOptions, ht as Override, it as MutationObserverResult, j as InfiniteQueryExecuteOptions, jt as QueryObserverPendingResult, k as InferErrorFromTag, kt as QueryObserverLoadingResult, l as AnyDataTag, lt as NetworkMode, m as DefaultedInfiniteQueryObserverOptions, mt as OmitKeyof, nt as MutationObserverLoadingResult, ot as MutationOptions, p as DefaultOptions, pt as NotifyOnChangeProps, q as MutateFunctionRest, qt as ThrowOnError, rt as MutationObserverOptions, st as MutationScope, tt as MutationObserverIdleResult, u as CancelOptions, ut as NonUndefinedGuard, v as DistributiveOmit, vt as QueryBooleanOption, w as FetchQueryOptions, wt as QueryKeyHashFunction, x as FetchInfiniteQueryOptions, xt as QueryFunction, y as EnsureInfiniteQueryDataOptions, yt as QueryClientConfig, z as InfiniteQueryObserverResult, zt as RefetchOptions } from "./hydration-
|
|
1
|
+
import { $ as MutationObserverBaseResult, A as InfiniteData, At as QueryObserverOptions, B as InfiniteQueryObserverSuccessResult, Bt as RefetchQueryFilters, C as FetchPreviousPageOptions, Ct as QueryKey, D as GetPreviousPageParamFunction, Dt as QueryObserverBaseResult, E as GetNextPageParamFunction, Et as QueryMeta, F as InfiniteQueryObserverOptions, Ft as QueryObserverSuccessResult, G as InvalidateQueryFilters, Gt as StaleTime, H as InitialDataFunction, Ht as ResetOptions, I as InfiniteQueryObserverPendingResult, It as QueryOptions, J as MutateOptions, Jt as UnsetMarker, K as MutateFunction, Kt as StaleTimeFunction, L as InfiniteQueryObserverPlaceholderResult, Lt as QueryPersister, M as InfiniteQueryObserverBaseResult, Mt as QueryObserverPlaceholderResult, N as InfiniteQueryObserverLoadingErrorResult, Nt as QueryObserverRefetchErrorResult, O as InferDataFromTag, Ot as QueryObserverLoadingErrorResult, P as InfiniteQueryObserverLoadingResult, Pt as QueryObserverResult, Q as MutationMeta, Qt as unsetMarker, R as InfiniteQueryObserverRefetchErrorResult, Rt as QueryStatus, S as FetchNextPageOptions, St as QueryFunctionContext, T as FetchStatus, Tt as QueryKeyWithDataTag, U as InitialPageParam, Ut as ResultOptions, V as InfiniteQueryPageParamsOptions, Vt as Register, W as InvalidateOptions, Wt as SetDataOptions, X as MutationFunctionContext, Xt as dataTagErrorSymbol, Y as MutationFunction, Yt as WithRequired, Z as MutationKey, Zt as dataTagSymbol, _ as DefinedQueryObserverResult, _t as QueriesPlaceholderDataFunction, at as MutationObserverSuccessResult, b as EnsureQueryDataOptions, bt as QueryExecuteOptions, ct as MutationStatus, d as DataTag, dt as NotifyEvent, et as MutationObserverErrorResult, f as DefaultError, ft as NotifyEventType, g as DefinedInfiniteQueryObserverResult, gt as PlaceholderDataFunction, h as DefaultedQueryObserverOptions, ht as Override, it as MutationObserverResult, j as InfiniteQueryExecuteOptions, jt as QueryObserverPendingResult, k as InferErrorFromTag, kt as QueryObserverLoadingResult, l as AnyDataTag, lt as NetworkMode, m as DefaultedInfiniteQueryObserverOptions, mt as OmitKeyof, nt as MutationObserverLoadingResult, ot as MutationOptions, p as DefaultOptions, pt as NotifyOnChangeProps, q as MutateFunctionRest, qt as ThrowOnError, rt as MutationObserverOptions, st as MutationScope, tt as MutationObserverIdleResult, u as CancelOptions, ut as NonUndefinedGuard, v as DistributiveOmit, vt as QueryBooleanOption, w as FetchQueryOptions, wt as QueryKeyHashFunction, x as FetchInfiniteQueryOptions, xt as QueryFunction, y as EnsureInfiniteQueryDataOptions, yt as QueryClientConfig, z as InfiniteQueryObserverResult, zt as RefetchOptions } from "./hydration-vgIjIhk6.js";
|
|
2
2
|
export { AnyDataTag, CancelOptions, DataTag, DefaultError, DefaultOptions, DefaultedInfiniteQueryObserverOptions, DefaultedQueryObserverOptions, DefinedInfiniteQueryObserverResult, DefinedQueryObserverResult, DistributiveOmit, EnsureInfiniteQueryDataOptions, EnsureQueryDataOptions, FetchInfiniteQueryOptions, FetchNextPageOptions, FetchPreviousPageOptions, FetchQueryOptions, FetchStatus, GetNextPageParamFunction, GetPreviousPageParamFunction, InferDataFromTag, InferErrorFromTag, InfiniteData, InfiniteQueryExecuteOptions, InfiniteQueryObserverBaseResult, InfiniteQueryObserverLoadingErrorResult, InfiniteQueryObserverLoadingResult, InfiniteQueryObserverOptions, InfiniteQueryObserverPendingResult, InfiniteQueryObserverPlaceholderResult, InfiniteQueryObserverRefetchErrorResult, InfiniteQueryObserverResult, InfiniteQueryObserverSuccessResult, InfiniteQueryPageParamsOptions, InitialDataFunction, InitialPageParam, InvalidateOptions, InvalidateQueryFilters, MutateFunction, MutateFunctionRest, MutateOptions, MutationFunction, MutationFunctionContext, MutationKey, MutationMeta, MutationObserverBaseResult, MutationObserverErrorResult, MutationObserverIdleResult, MutationObserverLoadingResult, MutationObserverOptions, MutationObserverResult, MutationObserverSuccessResult, MutationOptions, MutationScope, MutationStatus, NetworkMode, NonUndefinedGuard, NotifyEvent, NotifyEventType, NotifyOnChangeProps, OmitKeyof, Override, PlaceholderDataFunction, QueriesPlaceholderDataFunction, QueryBooleanOption, QueryClientConfig, QueryExecuteOptions, QueryFunction, QueryFunctionContext, QueryKey, QueryKeyHashFunction, QueryKeyWithDataTag, QueryMeta, QueryObserverBaseResult, QueryObserverLoadingErrorResult, QueryObserverLoadingResult, QueryObserverOptions, QueryObserverPendingResult, QueryObserverPlaceholderResult, QueryObserverRefetchErrorResult, QueryObserverResult, QueryObserverSuccessResult, QueryOptions, QueryPersister, QueryStatus, RefetchOptions, RefetchQueryFilters, Register, ResetOptions, ResultOptions, SetDataOptions, StaleTime, StaleTimeFunction, ThrowOnError, UnsetMarker, WithRequired, dataTagErrorSymbol, dataTagSymbol, unsetMarker };
|
package/build/legacy/types.js
CHANGED
|
@@ -1,9 +1,8 @@
|
|
|
1
|
-
|
|
1
|
+
// src/types.ts
|
|
2
2
|
/* istanbul ignore file */
|
|
3
3
|
const dataTagSymbol = Symbol();
|
|
4
4
|
const dataTagErrorSymbol = Symbol();
|
|
5
5
|
const unsetMarker = Symbol();
|
|
6
|
-
//#endregion
|
|
7
6
|
export { dataTagErrorSymbol, dataTagSymbol, unsetMarker };
|
|
8
7
|
|
|
9
8
|
//# sourceMappingURL=types.js.map
|
package/build/legacy/utils.cjs
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
|
|
2
2
|
const require_timeoutManager = require("./timeoutManager.cjs");
|
|
3
|
-
|
|
3
|
+
// src/utils.ts
|
|
4
4
|
/**
|
|
5
5
|
* @deprecated use `environmentManager.isServer()` instead.
|
|
6
6
|
*/
|
|
@@ -183,7 +183,7 @@ function replaceEqualDeep(a, b, depth = 0) {
|
|
|
183
183
|
*/
|
|
184
184
|
function shallowEqualObjects(a, b) {
|
|
185
185
|
if (!b || Object.keys(a).length !== Object.keys(b).length) return false;
|
|
186
|
-
for (const key
|
|
186
|
+
for (const key of Object.keys(a)) if (!hasOwn.call(b, key) || a[key] !== b[key]) return false;
|
|
187
187
|
return true;
|
|
188
188
|
}
|
|
189
189
|
/**
|
|
@@ -273,29 +273,27 @@ function keepPreviousData(previousData) {
|
|
|
273
273
|
}
|
|
274
274
|
/**
|
|
275
275
|
* Returns a new array with `item` added at the end. If that makes the array longer than `max`,
|
|
276
|
-
*
|
|
277
|
-
* `items` already did.
|
|
276
|
+
* excess items are removed from the start.
|
|
278
277
|
* @param items - The current items.
|
|
279
278
|
* @param item - The value to append.
|
|
280
|
-
* @param max - The
|
|
279
|
+
* @param max - The maximum number of items to keep. `0` (the default) means no limit.
|
|
281
280
|
* @returns A new array with `item` added.
|
|
282
281
|
*/
|
|
283
282
|
function addToEnd(items, item, max = 0) {
|
|
284
283
|
const newItems = [...items, item];
|
|
285
|
-
return max && newItems.length > max ? newItems.slice(
|
|
284
|
+
return max && newItems.length > max ? newItems.slice(-max) : newItems;
|
|
286
285
|
}
|
|
287
286
|
/**
|
|
288
287
|
* Returns a new array with `item` added at the start. If that makes the array longer than `max`,
|
|
289
|
-
*
|
|
290
|
-
* `items` already did.
|
|
288
|
+
* excess items are removed from the end.
|
|
291
289
|
* @param items - The current items.
|
|
292
290
|
* @param item - The value to prepend.
|
|
293
|
-
* @param max - The
|
|
291
|
+
* @param max - The maximum number of items to keep. `0` (the default) means no limit.
|
|
294
292
|
* @returns A new array with `item` added.
|
|
295
293
|
*/
|
|
296
294
|
function addToStart(items, item, max = 0) {
|
|
297
295
|
const newItems = [item, ...items];
|
|
298
|
-
return max && newItems.length > max ? newItems.slice(0,
|
|
296
|
+
return max && newItems.length > max ? newItems.slice(0, max) : newItems;
|
|
299
297
|
}
|
|
300
298
|
/**
|
|
301
299
|
* Sentinel value that can be passed as a query's `queryFn` to conditionally disable the query (equivalent
|
|
@@ -348,6 +346,7 @@ function shouldThrowError(throwOnError, params) {
|
|
|
348
346
|
if (typeof throwOnError === "function") return throwOnError(...params);
|
|
349
347
|
return !!throwOnError;
|
|
350
348
|
}
|
|
349
|
+
const fetchSignal = Symbol();
|
|
351
350
|
/**
|
|
352
351
|
* Adds a lazy `signal` getter to an object, such as a query function context. The first time
|
|
353
352
|
* `signal` is read, `onCancelled` is registered for the signal's `abort` event (or called right
|
|
@@ -355,29 +354,33 @@ function shouldThrowError(throwOnError, params) {
|
|
|
355
354
|
* @param object - The object to add the `signal` property to.
|
|
356
355
|
* @param getSignal - Returns the `AbortSignal`. Called once, when `signal` is first read.
|
|
357
356
|
* @param onCancelled - Called when the signal is aborted, if `signal` was read.
|
|
357
|
+
* @param internalSignal - The fetch signal to forward without consuming the getter.
|
|
358
358
|
* @returns The same object, with the `signal` property added.
|
|
359
359
|
*/
|
|
360
|
-
function addConsumeAwareSignal(object, getSignal, onCancelled) {
|
|
360
|
+
function addConsumeAwareSignal(object, getSignal, onCancelled, internalSignal) {
|
|
361
361
|
let consumed = false;
|
|
362
362
|
let signal;
|
|
363
|
-
Object.
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
363
|
+
Object.defineProperties(object, {
|
|
364
|
+
[fetchSignal]: { value: internalSignal },
|
|
365
|
+
signal: {
|
|
366
|
+
enumerable: true,
|
|
367
|
+
get: () => {
|
|
368
|
+
signal ?? (signal = getSignal());
|
|
369
|
+
if (consumed) return signal;
|
|
370
|
+
consumed = true;
|
|
371
|
+
if (signal.aborted) onCancelled();
|
|
372
|
+
else signal.addEventListener("abort", onCancelled, { once: true });
|
|
373
|
+
return signal;
|
|
374
|
+
}
|
|
372
375
|
}
|
|
373
376
|
});
|
|
374
377
|
return object;
|
|
375
378
|
}
|
|
376
|
-
//#endregion
|
|
377
379
|
exports.addConsumeAwareSignal = addConsumeAwareSignal;
|
|
378
380
|
exports.addToEnd = addToEnd;
|
|
379
381
|
exports.addToStart = addToStart;
|
|
380
382
|
exports.ensureQueryFn = ensureQueryFn;
|
|
383
|
+
exports.fetchSignal = fetchSignal;
|
|
381
384
|
exports.functionalUpdate = functionalUpdate;
|
|
382
385
|
exports.hashKey = hashKey;
|
|
383
386
|
exports.hashQueryKeyByOptions = hashQueryKeyByOptions;
|