Skip to content

Commit e0117f2

Browse files
ymc9ymc9
authored
refactor(orm): simplify ORM query args (#396)
* refactor(orm): simplify ORM query args * update * simplify hooks signatures * addressing PR comments * update
1 parent 39e0fa2 commit e0117f2

File tree

8 files changed

+415
-313
lines changed

8 files changed

+415
-313
lines changed

‎packages/clients/tanstack-query/src/react.ts‎

Lines changed: 65 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -31,13 +31,13 @@ import type {
3131
CreateManyArgs,
3232
DeleteArgs,
3333
DeleteManyArgs,
34-
FindArgs,
34+
FindFirstArgs,
35+
FindManyArgs,
3536
FindUniqueArgs,
3637
GroupByArgs,
3738
GroupByResult,
38-
ModelResult,
39-
SelectIncludeOmit,
4039
SelectSubset,
40+
SimplifiedModelResult,
4141
Subset,
4242
UpdateArgs,
4343
UpdateManyAndReturnArgs,
@@ -126,13 +126,13 @@ export type ModelMutationResult<T, TArgs> = UseMutationResult<T, DefaultError, T
126126
export type ModelMutationModelResult<
127127
Schema extends SchemaDef,
128128
Model extends GetModels<Schema>,
129-
TArgs extends SelectIncludeOmit<Schema, Model, boolean>,
129+
TArgs,
130130
Array extends boolean = false,
131-
> = Omit<ModelMutationResult<ModelResult<Schema, Model, TArgs>, TArgs>, 'mutateAsync'> & {
131+
> = Omit<ModelMutationResult<SimplifiedModelResult<Schema, Model, TArgs, false, Array>, TArgs>, 'mutateAsync'> & {
132132
mutateAsync<T extends TArgs>(
133133
args: T,
134-
options?: ModelMutationOptions<ModelResult<Schema, Model, T>, T>,
135-
): Promise<Array extends true ? ModelResult<Schema, Model, T>[] : ModelResult<Schema, Model, T>>;
134+
options?: ModelMutationOptions<SimplifiedModelResult<Schema, Model, T, false, Array>, T>,
135+
): Promise<SimplifiedModelResult<Schema, Model, T, false, Array>>;
136136
};
137137

138138
export type ClientHooks<Schema extends SchemaDef> = {
@@ -145,108 +145,108 @@ export type ModelQueryHooks<Schema extends SchemaDef, Model extends GetModels<Sc
145145
Schema,
146146
Model,
147147
{
148-
useFindUnique<T extends FindUniqueArgs<Schema, Model>>(
148+
useFindUnique<T extends FindUniqueArgs<Schema, Model, true>>(
149149
args: SelectSubset<T, FindUniqueArgs<Schema, Model>>,
150-
options?: ModelQueryOptions<ModelResult<Schema, Model, T> | null>,
151-
): ModelQueryResult<ModelResult<Schema, Model, T> | null>;
150+
options?: ModelQueryOptions<SimplifiedModelResult<Schema, Model, T> | null>,
151+
): ModelQueryResult<SimplifiedModelResult<Schema, Model, T> | null>;
152152

153-
useSuspenseFindUnique<T extends FindUniqueArgs<Schema, Model>>(
153+
useSuspenseFindUnique<T extends FindUniqueArgs<Schema, Model, true>>(
154154
args: SelectSubset<T, FindUniqueArgs<Schema, Model>>,
155-
options?: ModelSuspenseQueryOptions<ModelResult<Schema, Model, T> | null>,
156-
): ModelSuspenseQueryResult<ModelResult<Schema, Model, T> | null>;
157-
158-
useFindFirst<T extends FindArgs<Schema, Model, false>>(
159-
args?: SelectSubset<T, FindArgs<Schema, Model, false>>,
160-
options?: ModelQueryOptions<ModelResult<Schema, Model, T> | null>,
161-
): ModelQueryResult<ModelResult<Schema, Model, T> | null>;
162-
163-
useSuspenseFindFirst<T extends FindArgs<Schema, Model, false>>(
164-
args?: SelectSubset<T, FindArgs<Schema, Model, false>>,
165-
options?: ModelSuspenseQueryOptions<ModelResult<Schema, Model, T> | null>,
166-
): ModelSuspenseQueryResult<ModelResult<Schema, Model, T> | null>;
167-
168-
useFindMany<T extends FindArgs<Schema, Model, true>>(
169-
args?: SelectSubset<T, FindArgs<Schema, Model, true>>,
170-
options?: ModelQueryOptions<ModelResult<Schema, Model, T>[]>,
171-
): ModelQueryResult<ModelResult<Schema, Model, T>[]>;
172-
173-
useSuspenseFindMany<T extends FindArgs<Schema, Model, true>>(
174-
args?: SelectSubset<T, FindArgs<Schema, Model, true>>,
175-
options?: ModelSuspenseQueryOptions<ModelResult<Schema, Model, T>[]>,
176-
): ModelSuspenseQueryResult<ModelResult<Schema, Model, T>[]>;
177-
178-
useInfiniteFindMany<T extends FindArgs<Schema, Model, true>>(
179-
args?: SelectSubset<T, FindArgs<Schema, Model, true>>,
180-
options?: ModelInfiniteQueryOptions<ModelResult<Schema, Model, T>[]>,
181-
): ModelInfiniteQueryResult<InfiniteData<ModelResult<Schema, Model, T>[]>>;
182-
183-
useSuspenseInfiniteFindMany<T extends FindArgs<Schema, Model, true>>(
184-
args?: SelectSubset<T, FindArgs<Schema, Model, true>>,
185-
options?: ModelSuspenseInfiniteQueryOptions<ModelResult<Schema, Model, T>[]>,
186-
): ModelSuspenseInfiniteQueryResult<InfiniteData<ModelResult<Schema, Model, T>[]>>;
187-
188-
useCreate<T extends CreateArgs<Schema, Model>>(
189-
options?: ModelMutationOptions<ModelResult<Schema, Model, T>, T>,
155+
options?: ModelSuspenseQueryOptions<SimplifiedModelResult<Schema, Model, T> | null>,
156+
): ModelSuspenseQueryResult<SimplifiedModelResult<Schema, Model, T> | null>;
157+
158+
useFindFirst<T extends FindFirstArgs<Schema, Model, true>>(
159+
args?: SelectSubset<T, FindFirstArgs<Schema, Model>>,
160+
options?: ModelQueryOptions<SimplifiedModelResult<Schema, Model, T> | null>,
161+
): ModelQueryResult<SimplifiedModelResult<Schema, Model, T> | null>;
162+
163+
useSuspenseFindFirst<T extends FindFirstArgs<Schema, Model, true>>(
164+
args?: SelectSubset<T, FindFirstArgs<Schema, Model>>,
165+
options?: ModelSuspenseQueryOptions<SimplifiedModelResult<Schema, Model, T> | null>,
166+
): ModelSuspenseQueryResult<SimplifiedModelResult<Schema, Model, T> | null>;
167+
168+
useFindMany<T extends FindManyArgs<Schema, Model, true>>(
169+
args?: SelectSubset<T, FindManyArgs<Schema, Model>>,
170+
options?: ModelQueryOptions<SimplifiedModelResult<Schema, Model, T>[]>,
171+
): ModelQueryResult<SimplifiedModelResult<Schema, Model, T>[]>;
172+
173+
useSuspenseFindMany<T extends FindManyArgs<Schema, Model, true>>(
174+
args?: SelectSubset<T, FindManyArgs<Schema, Model>>,
175+
options?: ModelSuspenseQueryOptions<SimplifiedModelResult<Schema, Model, T>[]>,
176+
): ModelSuspenseQueryResult<SimplifiedModelResult<Schema, Model, T>[]>;
177+
178+
useInfiniteFindMany<T extends FindManyArgs<Schema, Model, true>>(
179+
args?: SelectSubset<T, FindManyArgs<Schema, Model>>,
180+
options?: ModelInfiniteQueryOptions<SimplifiedModelResult<Schema, Model, T>[]>,
181+
): ModelInfiniteQueryResult<InfiniteData<SimplifiedModelResult<Schema, Model, T>[]>>;
182+
183+
useSuspenseInfiniteFindMany<T extends FindManyArgs<Schema, Model, true>>(
184+
args?: SelectSubset<T, FindManyArgs<Schema, Model>>,
185+
options?: ModelSuspenseInfiniteQueryOptions<SimplifiedModelResult<Schema, Model, T>[]>,
186+
): ModelSuspenseInfiniteQueryResult<InfiniteData<SimplifiedModelResult<Schema, Model, T>[]>>;
187+
188+
useCreate<T extends CreateArgs<Schema, Model, true>>(
189+
options?: ModelMutationOptions<SimplifiedModelResult<Schema, Model, T>, T>,
190190
): ModelMutationModelResult<Schema, Model, T>;
191191

192-
useCreateMany<T extends CreateManyArgs<Schema, Model>>(
192+
useCreateMany<T extends CreateManyArgs<Schema, Model, true>>(
193193
options?: ModelMutationOptions<BatchResult, T>,
194194
): ModelMutationResult<BatchResult, T>;
195195

196-
useCreateManyAndReturn<T extends CreateManyAndReturnArgs<Schema, Model>>(
197-
options?: ModelMutationOptions<ModelResult<Schema, Model, T>[], T>,
196+
useCreateManyAndReturn<T extends CreateManyAndReturnArgs<Schema, Model, true>>(
197+
options?: ModelMutationOptions<SimplifiedModelResult<Schema, Model, T>[], T>,
198198
): ModelMutationModelResult<Schema, Model, T, true>;
199199

200-
useUpdate<T extends UpdateArgs<Schema, Model>>(
201-
options?: ModelMutationOptions<ModelResult<Schema, Model, T>, T>,
200+
useUpdate<T extends UpdateArgs<Schema, Model, true>>(
201+
options?: ModelMutationOptions<SimplifiedModelResult<Schema, Model, T>, T>,
202202
): ModelMutationModelResult<Schema, Model, T>;
203203

204-
useUpdateMany<T extends UpdateManyArgs<Schema, Model>>(
204+
useUpdateMany<T extends UpdateManyArgs<Schema, Model, true>>(
205205
options?: ModelMutationOptions<BatchResult, T>,
206206
): ModelMutationResult<BatchResult, T>;
207207

208-
useUpdateManyAndReturn<T extends UpdateManyAndReturnArgs<Schema, Model>>(
209-
options?: ModelMutationOptions<ModelResult<Schema, Model, T>[], T>,
208+
useUpdateManyAndReturn<T extends UpdateManyAndReturnArgs<Schema, Model, true>>(
209+
options?: ModelMutationOptions<SimplifiedModelResult<Schema, Model, T>[], T>,
210210
): ModelMutationModelResult<Schema, Model, T, true>;
211211

212-
useUpsert<T extends UpsertArgs<Schema, Model>>(
213-
options?: ModelMutationOptions<ModelResult<Schema, Model, T>, T>,
212+
useUpsert<T extends UpsertArgs<Schema, Model, true>>(
213+
options?: ModelMutationOptions<SimplifiedModelResult<Schema, Model, T>, T>,
214214
): ModelMutationModelResult<Schema, Model, T>;
215215

216-
useDelete<T extends DeleteArgs<Schema, Model>>(
217-
options?: ModelMutationOptions<ModelResult<Schema, Model, T>, T>,
216+
useDelete<T extends DeleteArgs<Schema, Model, true>>(
217+
options?: ModelMutationOptions<SimplifiedModelResult<Schema, Model, T>, T>,
218218
): ModelMutationModelResult<Schema, Model, T>;
219219

220-
useDeleteMany<T extends DeleteManyArgs<Schema, Model>>(
220+
useDeleteMany<T extends DeleteManyArgs<Schema, Model, true>>(
221221
options?: ModelMutationOptions<BatchResult, T>,
222222
): ModelMutationResult<BatchResult, T>;
223223

224-
useCount<T extends CountArgs<Schema, Model>>(
224+
useCount<T extends CountArgs<Schema, Model, true>>(
225225
args?: Subset<T, CountArgs<Schema, Model>>,
226226
options?: ModelQueryOptions<CountResult<Schema, Model, T>>,
227227
): ModelQueryResult<CountResult<Schema, Model, T>>;
228228

229-
useSuspenseCount<T extends CountArgs<Schema, Model>>(
229+
useSuspenseCount<T extends CountArgs<Schema, Model, true>>(
230230
args?: Subset<T, CountArgs<Schema, Model>>,
231231
options?: ModelSuspenseQueryOptions<CountResult<Schema, Model, T>>,
232232
): ModelSuspenseQueryResult<CountResult<Schema, Model, T>>;
233233

234-
useAggregate<T extends AggregateArgs<Schema, Model>>(
234+
useAggregate<T extends AggregateArgs<Schema, Model, true>>(
235235
args: Subset<T, AggregateArgs<Schema, Model>>,
236236
options?: ModelQueryOptions<AggregateResult<Schema, Model, T>>,
237237
): ModelQueryResult<AggregateResult<Schema, Model, T>>;
238238

239-
useSuspenseAggregate<T extends AggregateArgs<Schema, Model>>(
239+
useSuspenseAggregate<T extends AggregateArgs<Schema, Model, true>>(
240240
args: Subset<T, AggregateArgs<Schema, Model>>,
241241
options?: ModelSuspenseQueryOptions<AggregateResult<Schema, Model, T>>,
242242
): ModelSuspenseQueryResult<AggregateResult<Schema, Model, T>>;
243243

244-
useGroupBy<T extends GroupByArgs<Schema, Model>>(
244+
useGroupBy<T extends GroupByArgs<Schema, Model, true>>(
245245
args: Subset<T, GroupByArgs<Schema, Model>>,
246246
options?: ModelQueryOptions<GroupByResult<Schema, Model, T>>,
247247
): ModelQueryResult<GroupByResult<Schema, Model, T>>;
248248

249-
useSuspenseGroupBy<T extends GroupByArgs<Schema, Model>>(
249+
useSuspenseGroupBy<T extends GroupByArgs<Schema, Model, true>>(
250250
args: Subset<T, GroupByArgs<Schema, Model>>,
251251
options?: ModelSuspenseQueryOptions<GroupByResult<Schema, Model, T>>,
252252
): ModelSuspenseQueryResult<GroupByResult<Schema, Model, T>>;

‎packages/clients/tanstack-query/src/svelte.ts‎

Lines changed: 47 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,13 @@ import type {
2727
CreateManyArgs,
2828
DeleteArgs,
2929
DeleteManyArgs,
30-
FindArgs,
30+
FindFirstArgs,
31+
FindManyArgs,
3132
FindUniqueArgs,
3233
GroupByArgs,
3334
GroupByResult,
34-
ModelResult,
35-
SelectIncludeOmit,
3635
SelectSubset,
36+
SimplifiedModelResult,
3737
Subset,
3838
UpdateArgs,
3939
UpdateManyAndReturnArgs,
@@ -114,14 +114,17 @@ export type ModelMutationResult<T, TArgs> = CreateMutationResult<T, DefaultError
114114
export type ModelMutationModelResult<
115115
Schema extends SchemaDef,
116116
Model extends GetModels<Schema>,
117-
TArgs extends SelectIncludeOmit<Schema, Model, boolean>,
117+
TArgs,
118118
Array extends boolean = false,
119119
> = Readable<
120-
Omit<UnwrapStore<ModelMutationResult<ModelResult<Schema, Model, TArgs>, TArgs>>, 'mutateAsync'> & {
120+
Omit<
121+
UnwrapStore<ModelMutationResult<SimplifiedModelResult<Schema, Model, TArgs, false, Array>, TArgs>>,
122+
'mutateAsync'
123+
> & {
121124
mutateAsync<T extends TArgs>(
122125
args: T,
123-
options?: ModelMutationOptions<ModelResult<Schema, Model, T>, T>,
124-
): Promise<Array extends true ? ModelResult<Schema, Model, T>[] : ModelResult<Schema, Model, T>>;
126+
options?: ModelMutationOptions<SimplifiedModelResult<Schema, Model, T, false, Array>, T>,
127+
): Promise<SimplifiedModelResult<Schema, Model, T, false, Array>>;
125128
}
126129
>;
127130

@@ -135,73 +138,73 @@ export type ModelQueryHooks<Schema extends SchemaDef, Model extends GetModels<Sc
135138
Schema,
136139
Model,
137140
{
138-
useFindUnique<T extends FindUniqueArgs<Schema, Model>>(
141+
useFindUnique<T extends FindUniqueArgs<Schema, Model, true>>(
139142
args: SelectSubset<T, FindUniqueArgs<Schema, Model>>,
140-
options?: ModelQueryOptions<ModelResult<Schema, Model, T> | null>,
141-
): ModelQueryResult<ModelResult<Schema, Model, T> | null>;
142-
143-
useFindFirst<T extends FindArgs<Schema, Model, false>>(
144-
args?: SelectSubset<T, FindArgs<Schema, Model, false>>,
145-
options?: ModelQueryOptions<ModelResult<Schema, Model, T> | null>,
146-
): ModelQueryResult<ModelResult<Schema, Model, T> | null>;
147-
148-
useFindMany<T extends FindArgs<Schema, Model, true>>(
149-
args?: SelectSubset<T, FindArgs<Schema, Model, true>>,
150-
options?: ModelQueryOptions<ModelResult<Schema, Model, T>[]>,
151-
): ModelQueryResult<ModelResult<Schema, Model, T>[]>;
152-
153-
useInfiniteFindMany<T extends FindArgs<Schema, Model, true>>(
154-
args?: SelectSubset<T, FindArgs<Schema, Model, true>>,
155-
options?: ModelInfiniteQueryOptions<ModelResult<Schema, Model, T>[]>,
156-
): ModelInfiniteQueryResult<InfiniteData<ModelResult<Schema, Model, T>[]>>;
157-
158-
useCreate<T extends CreateArgs<Schema, Model>>(
159-
options?: ModelMutationOptions<ModelResult<Schema, Model, T>, T>,
143+
options?: ModelQueryOptions<SimplifiedModelResult<Schema, Model, T> | null>,
144+
): ModelQueryResult<SimplifiedModelResult<Schema, Model, T> | null>;
145+
146+
useFindFirst<T extends FindFirstArgs<Schema, Model, true>>(
147+
args?: SelectSubset<T, FindFirstArgs<Schema, Model>>,
148+
options?: ModelQueryOptions<SimplifiedModelResult<Schema, Model, T> | null>,
149+
): ModelQueryResult<SimplifiedModelResult<Schema, Model, T> | null>;
150+
151+
useFindMany<T extends FindManyArgs<Schema, Model, true>>(
152+
args?: SelectSubset<T, FindManyArgs<Schema, Model>>,
153+
options?: ModelQueryOptions<SimplifiedModelResult<Schema, Model, T>[]>,
154+
): ModelQueryResult<SimplifiedModelResult<Schema, Model, T>[]>;
155+
156+
useInfiniteFindMany<T extends FindManyArgs<Schema, Model, true>>(
157+
args?: SelectSubset<T, FindManyArgs<Schema, Model>>,
158+
options?: ModelInfiniteQueryOptions<SimplifiedModelResult<Schema, Model, T>[]>,
159+
): ModelInfiniteQueryResult<InfiniteData<SimplifiedModelResult<Schema, Model, T>[]>>;
160+
161+
useCreate<T extends CreateArgs<Schema, Model, true>>(
162+
options?: ModelMutationOptions<SimplifiedModelResult<Schema, Model, T>, T>,
160163
): ModelMutationModelResult<Schema, Model, T>;
161164

162-
useCreateMany<T extends CreateManyArgs<Schema, Model>>(
165+
useCreateMany<T extends CreateManyArgs<Schema, Model, true>>(
163166
options?: ModelMutationOptions<BatchResult, T>,
164167
): ModelMutationResult<BatchResult, T>;
165168

166-
useCreateManyAndReturn<T extends CreateManyAndReturnArgs<Schema, Model>>(
167-
options?: ModelMutationOptions<ModelResult<Schema, Model, T>[], T>,
169+
useCreateManyAndReturn<T extends CreateManyAndReturnArgs<Schema, Model, true>>(
170+
options?: ModelMutationOptions<SimplifiedModelResult<Schema, Model, T>[], T>,
168171
): ModelMutationModelResult<Schema, Model, T, true>;
169172

170-
useUpdate<T extends UpdateArgs<Schema, Model>>(
171-
options?: ModelMutationOptions<ModelResult<Schema, Model, T>, T>,
173+
useUpdate<T extends UpdateArgs<Schema, Model, true>>(
174+
options?: ModelMutationOptions<SimplifiedModelResult<Schema, Model, T>, T>,
172175
): ModelMutationModelResult<Schema, Model, T>;
173176

174-
useUpdateMany<T extends UpdateManyArgs<Schema, Model>>(
177+
useUpdateMany<T extends UpdateManyArgs<Schema, Model, true>>(
175178
options?: ModelMutationOptions<BatchResult, T>,
176179
): ModelMutationResult<BatchResult, T>;
177180

178-
useUpdateManyAndReturn<T extends UpdateManyAndReturnArgs<Schema, Model>>(
179-
options?: ModelMutationOptions<ModelResult<Schema, Model, T>[], T>,
181+
useUpdateManyAndReturn<T extends UpdateManyAndReturnArgs<Schema, Model, true>>(
182+
options?: ModelMutationOptions<SimplifiedModelResult<Schema, Model, T>[], T>,
180183
): ModelMutationModelResult<Schema, Model, T, true>;
181184

182-
useUpsert<T extends UpsertArgs<Schema, Model>>(
183-
options?: ModelMutationOptions<ModelResult<Schema, Model, T>, T>,
185+
useUpsert<T extends UpsertArgs<Schema, Model, true>>(
186+
options?: ModelMutationOptions<SimplifiedModelResult<Schema, Model, T>, T>,
184187
): ModelMutationModelResult<Schema, Model, T>;
185188

186-
useDelete<T extends DeleteArgs<Schema, Model>>(
187-
options?: ModelMutationOptions<ModelResult<Schema, Model, T>, T>,
189+
useDelete<T extends DeleteArgs<Schema, Model, true>>(
190+
options?: ModelMutationOptions<SimplifiedModelResult<Schema, Model, T>, T>,
188191
): ModelMutationModelResult<Schema, Model, T>;
189192

190-
useDeleteMany<T extends DeleteManyArgs<Schema, Model>>(
193+
useDeleteMany<T extends DeleteManyArgs<Schema, Model, true>>(
191194
options?: ModelMutationOptions<BatchResult, T>,
192195
): ModelMutationResult<BatchResult, T>;
193196

194-
useCount<T extends CountArgs<Schema, Model>>(
197+
useCount<T extends CountArgs<Schema, Model, true>>(
195198
args?: Subset<T, CountArgs<Schema, Model>>,
196199
options?: ModelQueryOptions<CountResult<Schema, Model, T>>,
197200
): ModelQueryResult<CountResult<Schema, Model, T>>;
198201

199-
useAggregate<T extends AggregateArgs<Schema, Model>>(
202+
useAggregate<T extends AggregateArgs<Schema, Model, true>>(
200203
args: Subset<T, AggregateArgs<Schema, Model>>,
201204
options?: ModelQueryOptions<AggregateResult<Schema, Model, T>>,
202205
): ModelQueryResult<AggregateResult<Schema, Model, T>>;
203206

204-
useGroupBy<T extends GroupByArgs<Schema, Model>>(
207+
useGroupBy<T extends GroupByArgs<Schema, Model, true>>(
205208
args: Subset<T, GroupByArgs<Schema, Model>>,
206209
options?: ModelQueryOptions<GroupByResult<Schema, Model, T>>,
207210
): ModelQueryResult<GroupByResult<Schema, Model, T>>;

0 commit comments

Comments
 (0)