Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

useSuspenseQueries.ts

211 lines8.0 KB

1'use client'
2import { skipToken } from '@tanstack/query-core'
3import { useQueries } from './useQueries'
4import { defaultThrowOnError } from './suspense'
5import type { UseSuspenseQueryOptions, UseSuspenseQueryResult } from './types'
6import type {
7 DefaultError,
8 QueryClient,
9 QueryFunction,
10 ThrowOnError,
11} from '@tanstack/query-core'
12​
13// Avoid TS depth-limit error in case of large array literal
14type MAXIMUM_DEPTH = 20
15​
16// Widen the type of the symbol to enable type inference even if skipToken is not immutable.
17type SkipTokenForUseQueries = symbol
18​
19type GetUseSuspenseQueryOptions<T> =
20 // Part 1: responsible for applying explicit type parameter to function arguments, if object { queryFnData: TQueryFnData, error: TError, data: TData }
21 T extends {
22 queryFnData: infer TQueryFnData
23 error?: infer TError
24 data: infer TData
25 }
26 ? UseSuspenseQueryOptions<TQueryFnData, TError, TData>
27 : T extends { queryFnData: infer TQueryFnData; error?: infer TError }
28 ? UseSuspenseQueryOptions<TQueryFnData, TError>
29 : T extends { data: infer TData; error?: infer TError }
30 ? UseSuspenseQueryOptions<unknown, TError, TData>
31 : // Part 2: responsible for applying explicit type parameter to function arguments, if tuple [TQueryFnData, TError, TData]
32 T extends [infer TQueryFnData, infer TError, infer TData]
33 ? UseSuspenseQueryOptions<TQueryFnData, TError, TData>
34 : T extends [infer TQueryFnData, infer TError]
35 ? UseSuspenseQueryOptions<TQueryFnData, TError>
36 : T extends [infer TQueryFnData]
37 ? UseSuspenseQueryOptions<TQueryFnData>
38 : // Part 3: responsible for inferring and enforcing type if no explicit parameter was provided
39 T extends {
40 queryFn?:
41 | QueryFunction<infer TQueryFnData, infer TQueryKey>
42 | SkipTokenForUseQueries
43 select?: (data: any) => infer TData
44 throwOnError?: ThrowOnError<any, infer TError, any, any>
45 }
46 ? UseSuspenseQueryOptions<
47 TQueryFnData,
48 TError,
49 TData,
50 TQueryKey
51 >
52 : T extends {
53 queryFn?:
54 | QueryFunction<infer TQueryFnData, infer TQueryKey>
55 | SkipTokenForUseQueries
56 throwOnError?: ThrowOnError<any, infer TError, any, any>
57 }
58 ? UseSuspenseQueryOptions<
59 TQueryFnData,
60 TError,
61 TQueryFnData,
62 TQueryKey
63 >
64 : // Fallback
65 UseSuspenseQueryOptions
66​
67type GetUseSuspenseQueryResult<T> =
68 // Part 1: responsible for mapping explicit type parameter to function result, if object
69 T extends { queryFnData: any; error?: infer TError; data: infer TData }
70 ? UseSuspenseQueryResult<TData, TError>
71 : T extends { queryFnData: infer TQueryFnData; error?: infer TError }
72 ? UseSuspenseQueryResult<TQueryFnData, TError>
73 : T extends { data: infer TData; error?: infer TError }
74 ? UseSuspenseQueryResult<TData, TError>
75 : // Part 2: responsible for mapping explicit type parameter to function result, if tuple
76 T extends [any, infer TError, infer TData]
77 ? UseSuspenseQueryResult<TData, TError>
78 : T extends [infer TQueryFnData, infer TError]
79 ? UseSuspenseQueryResult<TQueryFnData, TError>
80 : T extends [infer TQueryFnData]
81 ? UseSuspenseQueryResult<TQueryFnData>
82 : // Part 3: responsible for mapping inferred type to results, if no explicit parameter was provided
83 T extends {
84 queryFn?:
85 | QueryFunction<infer TQueryFnData, any>
86 | SkipTokenForUseQueries
87 select?: (data: any) => infer TData
88 throwOnError?: ThrowOnError<any, infer TError, any, any>
89 }
90 ? UseSuspenseQueryResult<
91 unknown extends TData ? TQueryFnData : TData,
92 unknown extends TError ? DefaultError : TError
93 >
94 : T extends {
95 queryFn?:
96 | QueryFunction<infer TQueryFnData, any>
97 | SkipTokenForUseQueries
98 throwOnError?: ThrowOnError<any, infer TError, any, any>
99 }
100 ? UseSuspenseQueryResult<
101 TQueryFnData,
102 unknown extends TError ? DefaultError : TError
103 >
104 : // Fallback
105 UseSuspenseQueryResult
106​
107/**
108 * SuspenseQueriesOptions reducer recursively unwraps function arguments to infer/enforce type param
109 */
110export type SuspenseQueriesOptions<
111 T extends Array<any>,
112 TResults extends Array<any> = [],
113 TDepth extends ReadonlyArray<number> = [],
114> = TDepth['length'] extends MAXIMUM_DEPTH
115 ? Array<UseSuspenseQueryOptions>
116 : T extends []
117 ? []
118 : T extends [infer Head]
119 ? [...TResults, GetUseSuspenseQueryOptions<Head>]
120 : T extends [infer Head, ...infer Tails]
121 ? SuspenseQueriesOptions<
122 [...Tails],
123 [...TResults, GetUseSuspenseQueryOptions<Head>],
124 [...TDepth, 1]
125 >
126 : Array<unknown> extends T
127 ? T
128 : // If T is *some* array but we couldn't assign unknown[] to it, then it must hold some known/homogenous type!
129 // use this to infer the param types in the case of Array.map() argument
130 T extends Array<
131 UseSuspenseQueryOptions<
132 infer TQueryFnData,
133 infer TError,
134 infer TData,
135 infer TQueryKey
136 >
137 >
138 ? Array<
139 UseSuspenseQueryOptions<TQueryFnData, TError, TData, TQueryKey>
140 >
141 : // Fallback
142 Array<UseSuspenseQueryOptions>
143​
144/**
145 * SuspenseQueriesResults reducer recursively maps type param to results
146 */
147export type SuspenseQueriesResults<
148 T extends Array<any>,
149 TResults extends Array<any> = [],
150 TDepth extends ReadonlyArray<number> = [],
151> = TDepth['length'] extends MAXIMUM_DEPTH
152 ? Array<UseSuspenseQueryResult>
153 : T extends []
154 ? []
155 : T extends [infer Head]
156 ? [...TResults, GetUseSuspenseQueryResult<Head>]
157 : T extends [infer Head, ...infer Tails]
158 ? SuspenseQueriesResults<
159 [...Tails],
160 [...TResults, GetUseSuspenseQueryResult<Head>],
161 [...TDepth, 1]
162 >
163 : { [K in keyof T]: GetUseSuspenseQueryResult<T[K]> }
164​
165export function useSuspenseQueries<
166 T extends Array<any>,
167 TCombinedResult = SuspenseQueriesResults<T>,
168>(
169 options: {
170 queries:
171 | readonly [...SuspenseQueriesOptions<T>]
172 | readonly [...{ [K in keyof T]: GetUseSuspenseQueryOptions<T[K]> }]
173 combine?: (result: SuspenseQueriesResults<T>) => TCombinedResult
174 },
175 queryClient?: QueryClient,
176): TCombinedResult
177​
178export function useSuspenseQueries<
179 T extends Array<any>,
180 TCombinedResult = SuspenseQueriesResults<T>,
181>(
182 options: {
183 queries: readonly [...SuspenseQueriesOptions<T>]
184 combine?: (result: SuspenseQueriesResults<T>) => TCombinedResult
185 },
186 queryClient?: QueryClient,
187): TCombinedResult
188​
189export function useSuspenseQueries(options: any, queryClient?: QueryClient) {
190 return useQueries(
191 {
192 ...options,
193 queries: options.queries.map((query: any) => {
194 if (process.env.NODE_ENV !== 'production') {
195 if (query.queryFn === skipToken) {
196 console.error('skipToken is not allowed for useSuspenseQueries')
197 }
198 }
199​
200 return {
201 ...query,
202 suspense: true,
203 throwOnError: defaultThrowOnError,
204 enabled: true,
205 placeholderData: undefined,
206 }
207 }),
208 },
209 queryClient,
210 )