/
useQueries.ts
167 lines (152 loc) 路 6.04 KB
/
useQueries.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
/* eslint-disable @typescript-eslint/no-explicit-any */
import { QueriesObserver } from '@tanstack/query-core'
import { onScopeDispose, reactive, readonly, watch } from 'vue-demi'
import type { Ref } from 'vue-demi'
import type { QueryFunction, QueryObserverResult } from '@tanstack/query-core'
import { useQueryClient } from './useQueryClient'
import type { UseQueryOptions } from './useQuery'
import { cloneDeepUnref } from './utils'
// Avoid TS depth-limit error in case of large array literal
type MAXIMUM_DEPTH = 20
type GetOptions<T> =
// Part 1: responsible for applying explicit type parameter to function arguments, if object { queryFnData: TQueryFnData, error: TError, data: TData }
T extends {
queryFnData: infer TQueryFnData
error?: infer TError
data: infer TData
}
? UseQueryOptions<TQueryFnData, TError, TData>
: T extends { queryFnData: infer TQueryFnData; error?: infer TError }
? UseQueryOptions<TQueryFnData, TError>
: T extends { data: infer TData; error?: infer TError }
? UseQueryOptions<unknown, TError, TData>
: // Part 2: responsible for applying explicit type parameter to function arguments, if tuple [TQueryFnData, TError, TData]
T extends [infer TQueryFnData, infer TError, infer TData]
? UseQueryOptions<TQueryFnData, TError, TData>
: T extends [infer TQueryFnData, infer TError]
? UseQueryOptions<TQueryFnData, TError>
: T extends [infer TQueryFnData]
? UseQueryOptions<TQueryFnData>
: // Part 3: responsible for inferring and enforcing type if no explicit parameter was provided
T extends {
queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey>
select: (data: any) => infer TData
}
? UseQueryOptions<TQueryFnData, unknown, TData, TQueryKey>
: T extends { queryFn?: QueryFunction<infer TQueryFnData, infer TQueryKey> }
? UseQueryOptions<TQueryFnData, unknown, TQueryFnData, TQueryKey>
: // Fallback
UseQueryOptions
type GetResults<T> =
// Part 1: responsible for mapping explicit type parameter to function result, if object
T extends { queryFnData: any; error?: infer TError; data: infer TData }
? QueryObserverResult<TData, TError>
: T extends { queryFnData: infer TQueryFnData; error?: infer TError }
? QueryObserverResult<TQueryFnData, TError>
: T extends { data: infer TData; error?: infer TError }
? QueryObserverResult<TData, TError>
: // Part 2: responsible for mapping explicit type parameter to function result, if tuple
T extends [any, infer TError, infer TData]
? QueryObserverResult<TData, TError>
: T extends [infer TQueryFnData, infer TError]
? QueryObserverResult<TQueryFnData, TError>
: T extends [infer TQueryFnData]
? QueryObserverResult<TQueryFnData>
: // Part 3: responsible for mapping inferred type to results, if no explicit parameter was provided
T extends {
queryFn?: QueryFunction<unknown, any>
select: (data: any) => infer TData
}
? QueryObserverResult<TData>
: T extends { queryFn?: QueryFunction<infer TQueryFnData, any> }
? QueryObserverResult<TQueryFnData>
: // Fallback
QueryObserverResult
/**
* UseQueriesOptions reducer recursively unwraps function arguments to infer/enforce type param
*/
export type UseQueriesOptions<
T extends any[],
Result extends any[] = [],
Depth extends ReadonlyArray<number> = [],
> = Depth['length'] extends MAXIMUM_DEPTH
? UseQueryOptions[]
: T extends []
? []
: T extends [infer Head]
? [...Result, GetOptions<Head>]
: T extends [infer Head, ...infer Tail]
? UseQueriesOptions<[...Tail], [...Result, GetOptions<Head>], [...Depth, 1]>
: unknown[] extends T
? T
: // If T is *some* array but we couldn't assign unknown[] to it, then it must hold some known/homogenous type!
// use this to infer the param types in the case of Array.map() argument
T extends UseQueryOptions<
infer TQueryFnData,
infer TError,
infer TData,
infer TQueryKey
>[]
? UseQueryOptions<TQueryFnData, TError, TData, TQueryKey>[]
: // Fallback
UseQueryOptions[]
/**
* UseQueriesResults reducer recursively maps type param to results
*/
export type UseQueriesResults<
T extends any[],
Result extends any[] = [],
Depth extends ReadonlyArray<number> = [],
> = Depth['length'] extends MAXIMUM_DEPTH
? QueryObserverResult[]
: T extends []
? []
: T extends [infer Head]
? [...Result, GetResults<Head>]
: T extends [infer Head, ...infer Tail]
? UseQueriesResults<[...Tail], [...Result, GetResults<Head>], [...Depth, 1]>
: T extends UseQueryOptions<
infer TQueryFnData,
infer TError,
infer TData,
any
>[]
? // Dynamic-size (homogenous) UseQueryOptions array: map directly to array of results
QueryObserverResult<unknown extends TData ? TQueryFnData : TData, TError>[]
: // Fallback
QueryObserverResult[]
type UseQueriesOptionsArg<T extends any[]> = readonly [...UseQueriesOptions<T>]
export function useQueries<T extends any[]>({
queries,
}: {
queries: Ref<UseQueriesOptionsArg<T>> | UseQueriesOptionsArg<T>
}): Readonly<UseQueriesResults<T>> {
const unreffedQueries = cloneDeepUnref(queries) as UseQueriesOptionsArg<T>
const queryClientKey = unreffedQueries[0]?.queryClientKey
const optionsQueryClient = unreffedQueries[0]?.queryClient
const queryClient = optionsQueryClient ?? useQueryClient(queryClientKey)
const defaultedQueries = unreffedQueries.map((options) => {
return queryClient.defaultQueryOptions(options)
})
const observer = new QueriesObserver(queryClient, defaultedQueries)
const state = reactive(observer.getCurrentResult())
const unsubscribe = observer.subscribe((result) => {
state.splice(0, state.length, ...result)
})
watch(
() => queries,
() => {
const defaulted = (
cloneDeepUnref(queries) as UseQueriesOptionsArg<T>
).map((options) => {
return queryClient.defaultQueryOptions(options)
})
observer.setQueries(defaulted)
},
{ deep: true },
)
onScopeDispose(() => {
unsubscribe()
})
return readonly(state) as UseQueriesResults<T>
}