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