Open History to see the last commit
1import {
2 QueriesObserver,
3 QueryClient,
4 notifyManager,
5} from '@tanstack/query-core'
6import {
7 DestroyRef,
8 NgZone,
9 computed,
10 effect,
11 inject,
12 signal,
13} from '@angular/core'
14import { assertInjector } from './util/assert-injector/assert-injector'
15import type { Injector, Signal } from '@angular/core'
16import type {
17 DefaultError,
18 OmitKeyof,
19 QueriesObserverOptions,
20 QueriesPlaceholderDataFunction,
21 QueryFunction,
22 QueryKey,
23 QueryObserverOptions,
24 QueryObserverResult,
25 ThrowOnError,
26} from '@tanstack/query-core'
27β
28// This defines the `CreateQueryOptions` that are accepted in `QueriesOptions` & `GetOptions`.
29// `placeholderData` function does not have a parameter
30type QueryObserverOptionsForCreateQueries<
31 TQueryFnData = unknown,
32 TError = DefaultError,
33 TData = TQueryFnData,
34 TQueryKey extends QueryKey = QueryKey,
35> = OmitKeyof<
36 QueryObserverOptions<TQueryFnData, TError, TData, TQueryFnData, TQueryKey>,
37 'placeholderData'
38> & {
39 placeholderData?: TQueryFnData | QueriesPlaceholderDataFunction<TQueryFnData>
40}
41β
42// Avoid TS depth-limit error in case of large array literal
43type MAXIMUM_DEPTH = 20
44β
45// Widen the type of the symbol to enable type inference even if skipToken is not immutable.
46type SkipTokenForUseQueries = symbol
47β
48type GetOptions<T> =
49 // Part 1: responsible for applying explicit type parameter to function arguments, if object { queryFnData: TQueryFnData, error: TError, data: TData }
50 T extends {
51 queryFnData: infer TQueryFnData
52 error?: infer TError
53 data: infer TData
54 }
55 ? QueryObserverOptionsForCreateQueries<TQueryFnData, TError, TData>
56 : T extends { queryFnData: infer TQueryFnData; error?: infer TError }
57 ? QueryObserverOptionsForCreateQueries<TQueryFnData, TError>
58 : T extends { data: infer TData; error?: infer TError }
59 ? QueryObserverOptionsForCreateQueries<unknown, TError, TData>
60 : // Part 2: responsible for applying explicit type parameter to function arguments, if tuple [TQueryFnData, TError, TData]
61 T extends [infer TQueryFnData, infer TError, infer TData]
62 ? QueryObserverOptionsForCreateQueries<TQueryFnData, TError, TData>
63 : T extends [infer TQueryFnData, infer TError]
64 ? QueryObserverOptionsForCreateQueries<TQueryFnData, TError>
65 : T extends [infer TQueryFnData]
66 ? QueryObserverOptionsForCreateQueries<TQueryFnData>
67 : // Part 3: responsible for inferring and enforcing type if no explicit parameter was provided
68 T extends {
69 queryFn?:
70 | QueryFunction<infer TQueryFnData, infer TQueryKey>
71 | SkipTokenForUseQueries
72 select: (data: any) => infer TData
73 throwOnError?: ThrowOnError<any, infer TError, any, any>
74 }
75 ? QueryObserverOptionsForCreateQueries<
76 TQueryFnData,
77 unknown extends TError ? DefaultError : TError,
78 unknown extends TData ? TQueryFnData : TData,
79 TQueryKey
80 >
81 : // Fallback
82 QueryObserverOptionsForCreateQueries
83β
84type GetResults<T> =
85 // Part 1: responsible for mapping explicit type parameter to function result, if object
86 T extends { queryFnData: any; error?: infer TError; data: infer TData }
87 ? QueryObserverResult<TData, TError>
88 : T extends { queryFnData: infer TQueryFnData; error?: infer TError }
89 ? QueryObserverResult<TQueryFnData, TError>
90 : T extends { data: infer TData; error?: infer TError }
91 ? QueryObserverResult<TData, TError>
92 : // Part 2: responsible for mapping explicit type parameter to function result, if tuple
93 T extends [any, infer TError, infer TData]
94 ? QueryObserverResult<TData, TError>
95 : T extends [infer TQueryFnData, infer TError]
96 ? QueryObserverResult<TQueryFnData, TError>
97 : T extends [infer TQueryFnData]
98 ? QueryObserverResult<TQueryFnData>
99 : // Part 3: responsible for mapping inferred type to results, if no explicit parameter was provided
100 T extends {
101 queryFn?:
102 | QueryFunction<infer TQueryFnData, any>
103 | SkipTokenForUseQueries
104 select: (data: any) => infer TData
105 throwOnError?: ThrowOnError<any, infer TError, any, any>
106 }
107 ? QueryObserverResult<
108 unknown extends TData ? TQueryFnData : TData,
109 unknown extends TError ? DefaultError : TError
110 >
111 : // Fallback
112 QueryObserverResult
113β
114/**
115 * QueriesOptions reducer recursively unwraps function arguments to infer/enforce type param
116 * @public
117 */
118export type QueriesOptions<
119 T extends Array<any>,
120 TResult extends Array<any> = [],
121 TDepth extends ReadonlyArray<number> = [],
122> = TDepth['length'] extends MAXIMUM_DEPTH
123 ? Array<QueryObserverOptionsForCreateQueries>
124 : T extends []
125 ? []
126 : T extends [infer Head]
127 ? [...TResult, GetOptions<Head>]
128 : T extends [infer Head, ...infer Tail]
129 ? QueriesOptions<
130 [...Tail],
131 [...TResult, GetOptions<Head>],
132 [...TDepth, 1]
133 >
134 : ReadonlyArray<unknown> extends T
135 ? T
136 : // If T is *some* array but we couldn't assign unknown[] to it, then it must hold some known/homogenous type!
137 // use this to infer the param types in the case of Array.map() argument
138 T extends Array<
139 QueryObserverOptionsForCreateQueries<
140 infer TQueryFnData,
141 infer TError,
142 infer TData,
143 infer TQueryKey
144 >
145 >
146 ? Array<
147 QueryObserverOptionsForCreateQueries<
148 TQueryFnData,
149 TError,
150 TData,
151 TQueryKey
152 >
153 >
154 : // Fallback
155 Array<QueryObserverOptionsForCreateQueries>
156β
157/**
158 * QueriesResults reducer recursively maps type param to results
159 * @public
160 */
161export type QueriesResults<
162 T extends Array<any>,
163 TResult extends Array<any> = [],
164 TDepth extends ReadonlyArray<number> = [],
165> = TDepth['length'] extends MAXIMUM_DEPTH
166 ? Array<QueryObserverResult>
167 : T extends []
168 ? []
169 : T extends [infer Head]
170 ? [...TResult, GetResults<Head>]
171 : T extends [infer Head, ...infer Tail]
172 ? QueriesResults<
173 [...Tail],
174 [...TResult, GetResults<Head>],
175 [...TDepth, 1]
176 >
177 : T extends Array<
178 QueryObserverOptionsForCreateQueries<
179 infer TQueryFnData,
180 infer TError,
181 infer TData,
182 any
183 >
184 >
185 ? // Dynamic-size (homogenous) CreateQueryOptions array: map directly to array of results
186 Array<
187 QueryObserverResult<
188 unknown extends TData ? TQueryFnData : TData,
189 unknown extends TError ? DefaultError : TError
190 >
191 >
192 : // Fallback
193 Array<QueryObserverResult>
194β
195/**
196 * @param root0
197 * @param root0.queries
198 * @param root0.combine
199 * @param injector
200 * @public
201 */
202export function injectQueries<
203 T extends Array<any>,
204 TCombinedResult = QueriesResults<T>,
205>(
206 {
207 queries,
208 ...options
209 }: {
210 queries: Signal<[...QueriesOptions<T>]>
211 combine?: (result: QueriesResults<T>) => TCombinedResult
212 },
213 injector?: Injector,
214): Signal<TCombinedResult> {
215 return assertInjector(injectQueries, injector, () => {
216 const destroyRef = inject(DestroyRef)
217 const ngZone = inject(NgZone)
218 const queryClient = inject(QueryClient)
219β
220 const defaultedQueries = computed(() => {
221 return queries().map((opts) => {
222 const defaultedOptions = queryClient.defaultQueryOptions(opts)
223 // Make sure the results are already in fetching state before subscribing or updating options
224 defaultedOptions._optimisticResults = 'optimistic'
225β
226 return defaultedOptions as QueryObserverOptions
227 })
228 })
229β
230 const observer = new QueriesObserver<TCombinedResult>(
231 queryClient,
232 defaultedQueries(),
233 options as QueriesObserverOptions<TCombinedResult>,
234 )
235β
236 // Do not notify on updates because of changes in the options because
237 // these changes should already be reflected in the optimistic result.
238 effect(() => {
239 observer.setQueries(
240 defaultedQueries(),
241 options as QueriesObserverOptions<TCombinedResult>,
242 )
243 })
244β
245 const [, getCombinedResult] = observer.getOptimisticResult(
246 defaultedQueries(),
247 (options as QueriesObserverOptions<TCombinedResult>).combine,
248 )
249β
250 const result = signal(getCombinedResult() as any)
251β
252 const unsubscribe = ngZone.runOutsideAngular(() =>
253 observer.subscribe(notifyManager.batchCalls(result.set)),
254 )
255 destroyRef.onDestroy(unsubscribe)
256β
257 return result
258 })
259}