Skip to content

refactor(orm): simplify ORM query args #396

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Nov 13, 2025
Merged

refactor(orm): simplify ORM query args #396

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1787e06
refactor(orm): simplify ORM query args
ymc9 Nov 13, 2025
f207738
update
ymc9 Nov 13, 2025
3f91597
simplify hooks signatures
ymc9 Nov 13, 2025
b2aa24e
addressing PR comments
ymc9 Nov 13, 2025
d2cad6d
update
ymc9 Nov 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
130 changes: 65 additions & 65 deletions packages/clients/tanstack-query/src/react.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,13 +31,13 @@ import type {
CreateManyArgs,
DeleteArgs,
DeleteManyArgs,
FindArgs,
FindFirstArgs,
FindManyArgs,
FindUniqueArgs,
GroupByArgs,
GroupByResult,
ModelResult,
SelectIncludeOmit,
SelectSubset,
SimplifiedModelResult,
Subset,
UpdateArgs,
UpdateManyAndReturnArgs,
Expand Down Expand Up @@ -126,13 +126,13 @@ export type ModelMutationResult<T, TArgs> = UseMutationResult<T, DefaultError, T
export type ModelMutationModelResult<
Schema extends SchemaDef,
Model extends GetModels<Schema>,
TArgs extends SelectIncludeOmit<Schema, Model, boolean>,
TArgs,
Array extends boolean = false,
> = Omit<ModelMutationResult<ModelResult<Schema, Model, TArgs>, TArgs>, 'mutateAsync'> & {
> = Omit<ModelMutationResult<SimplifiedModelResult<Schema, Model, TArgs, false, Array>, TArgs>, 'mutateAsync'> & {
mutateAsync<T extends TArgs>(
args: T,
options?: ModelMutationOptions<ModelResult<Schema, Model, T>, T>,
): Promise<Array extends true ? ModelResult<Schema, Model, T>[] : ModelResult<Schema, Model, T>>;
options?: ModelMutationOptions<SimplifiedModelResult<Schema, Model, T, false, Array>, T>,
): Promise<SimplifiedModelResult<Schema, Model, T, false, Array>>;
};

export type ClientHooks<Schema extends SchemaDef> = {
Expand All @@ -145,108 +145,108 @@ export type ModelQueryHooks<Schema extends SchemaDef, Model extends GetModels<Sc
Schema,
Model,
{
useFindUnique<T extends FindUniqueArgs<Schema, Model>>(
useFindUnique<T extends FindUniqueArgs<Schema, Model, true>>(
args: SelectSubset<T, FindUniqueArgs<Schema, Model>>,
options?: ModelQueryOptions<ModelResult<Schema, Model, T> | null>,
): ModelQueryResult<ModelResult<Schema, Model, T> | null>;
options?: ModelQueryOptions<SimplifiedModelResult<Schema, Model, T> | null>,
): ModelQueryResult<SimplifiedModelResult<Schema, Model, T> | null>;

useSuspenseFindUnique<T extends FindUniqueArgs<Schema, Model>>(
useSuspenseFindUnique<T extends FindUniqueArgs<Schema, Model, true>>(
args: SelectSubset<T, FindUniqueArgs<Schema, Model>>,
options?: ModelSuspenseQueryOptions<ModelResult<Schema, Model, T> | null>,
): ModelSuspenseQueryResult<ModelResult<Schema, Model, T> | null>;

useFindFirst<T extends FindArgs<Schema, Model, false>>(
args?: SelectSubset<T, FindArgs<Schema, Model, false>>,
options?: ModelQueryOptions<ModelResult<Schema, Model, T> | null>,
): ModelQueryResult<ModelResult<Schema, Model, T> | null>;

useSuspenseFindFirst<T extends FindArgs<Schema, Model, false>>(
args?: SelectSubset<T, FindArgs<Schema, Model, false>>,
options?: ModelSuspenseQueryOptions<ModelResult<Schema, Model, T> | null>,
): ModelSuspenseQueryResult<ModelResult<Schema, Model, T> | null>;

useFindMany<T extends FindArgs<Schema, Model, true>>(
args?: SelectSubset<T, FindArgs<Schema, Model, true>>,
options?: ModelQueryOptions<ModelResult<Schema, Model, T>[]>,
): ModelQueryResult<ModelResult<Schema, Model, T>[]>;

useSuspenseFindMany<T extends FindArgs<Schema, Model, true>>(
args?: SelectSubset<T, FindArgs<Schema, Model, true>>,
options?: ModelSuspenseQueryOptions<ModelResult<Schema, Model, T>[]>,
): ModelSuspenseQueryResult<ModelResult<Schema, Model, T>[]>;

useInfiniteFindMany<T extends FindArgs<Schema, Model, true>>(
args?: SelectSubset<T, FindArgs<Schema, Model, true>>,
options?: ModelInfiniteQueryOptions<ModelResult<Schema, Model, T>[]>,
): ModelInfiniteQueryResult<InfiniteData<ModelResult<Schema, Model, T>[]>>;

useSuspenseInfiniteFindMany<T extends FindArgs<Schema, Model, true>>(
args?: SelectSubset<T, FindArgs<Schema, Model, true>>,
options?: ModelSuspenseInfiniteQueryOptions<ModelResult<Schema, Model, T>[]>,
): ModelSuspenseInfiniteQueryResult<InfiniteData<ModelResult<Schema, Model, T>[]>>;

useCreate<T extends CreateArgs<Schema, Model>>(
options?: ModelMutationOptions<ModelResult<Schema, Model, T>, T>,
options?: ModelSuspenseQueryOptions<SimplifiedModelResult<Schema, Model, T> | null>,
): ModelSuspenseQueryResult<SimplifiedModelResult<Schema, Model, T> | null>;

useFindFirst<T extends FindFirstArgs<Schema, Model, true>>(
args?: SelectSubset<T, FindFirstArgs<Schema, Model>>,
options?: ModelQueryOptions<SimplifiedModelResult<Schema, Model, T> | null>,
): ModelQueryResult<SimplifiedModelResult<Schema, Model, T> | null>;

useSuspenseFindFirst<T extends FindFirstArgs<Schema, Model, true>>(
args?: SelectSubset<T, FindFirstArgs<Schema, Model>>,
options?: ModelSuspenseQueryOptions<SimplifiedModelResult<Schema, Model, T> | null>,
): ModelSuspenseQueryResult<SimplifiedModelResult<Schema, Model, T> | null>;

useFindMany<T extends FindManyArgs<Schema, Model, true>>(
args?: SelectSubset<T, FindManyArgs<Schema, Model>>,
options?: ModelQueryOptions<SimplifiedModelResult<Schema, Model, T>[]>,
): ModelQueryResult<SimplifiedModelResult<Schema, Model, T>[]>;

useSuspenseFindMany<T extends FindManyArgs<Schema, Model, true>>(
args?: SelectSubset<T, FindManyArgs<Schema, Model>>,
options?: ModelSuspenseQueryOptions<SimplifiedModelResult<Schema, Model, T>[]>,
): ModelSuspenseQueryResult<SimplifiedModelResult<Schema, Model, T>[]>;

useInfiniteFindMany<T extends FindManyArgs<Schema, Model, true>>(
args?: SelectSubset<T, FindManyArgs<Schema, Model>>,
options?: ModelInfiniteQueryOptions<SimplifiedModelResult<Schema, Model, T>[]>,
): ModelInfiniteQueryResult<InfiniteData<SimplifiedModelResult<Schema, Model, T>[]>>;

useSuspenseInfiniteFindMany<T extends FindManyArgs<Schema, Model, true>>(
args?: SelectSubset<T, FindManyArgs<Schema, Model>>,
options?: ModelSuspenseInfiniteQueryOptions<SimplifiedModelResult<Schema, Model, T>[]>,
): ModelSuspenseInfiniteQueryResult<InfiniteData<SimplifiedModelResult<Schema, Model, T>[]>>;

useCreate<T extends CreateArgs<Schema, Model, true>>(
options?: ModelMutationOptions<SimplifiedModelResult<Schema, Model, T>, T>,
): ModelMutationModelResult<Schema, Model, T>;

useCreateMany<T extends CreateManyArgs<Schema, Model>>(
useCreateMany<T extends CreateManyArgs<Schema, Model, true>>(
options?: ModelMutationOptions<BatchResult, T>,
): ModelMutationResult<BatchResult, T>;

useCreateManyAndReturn<T extends CreateManyAndReturnArgs<Schema, Model>>(
options?: ModelMutationOptions<ModelResult<Schema, Model, T>[], T>,
useCreateManyAndReturn<T extends CreateManyAndReturnArgs<Schema, Model, true>>(
options?: ModelMutationOptions<SimplifiedModelResult<Schema, Model, T>[], T>,
): ModelMutationModelResult<Schema, Model, T, true>;

useUpdate<T extends UpdateArgs<Schema, Model>>(
options?: ModelMutationOptions<ModelResult<Schema, Model, T>, T>,
useUpdate<T extends UpdateArgs<Schema, Model, true>>(
options?: ModelMutationOptions<SimplifiedModelResult<Schema, Model, T>, T>,
): ModelMutationModelResult<Schema, Model, T>;

useUpdateMany<T extends UpdateManyArgs<Schema, Model>>(
useUpdateMany<T extends UpdateManyArgs<Schema, Model, true>>(
options?: ModelMutationOptions<BatchResult, T>,
): ModelMutationResult<BatchResult, T>;

useUpdateManyAndReturn<T extends UpdateManyAndReturnArgs<Schema, Model>>(
options?: ModelMutationOptions<ModelResult<Schema, Model, T>[], T>,
useUpdateManyAndReturn<T extends UpdateManyAndReturnArgs<Schema, Model, true>>(
options?: ModelMutationOptions<SimplifiedModelResult<Schema, Model, T>[], T>,
): ModelMutationModelResult<Schema, Model, T, true>;

useUpsert<T extends UpsertArgs<Schema, Model>>(
options?: ModelMutationOptions<ModelResult<Schema, Model, T>, T>,
useUpsert<T extends UpsertArgs<Schema, Model, true>>(
options?: ModelMutationOptions<SimplifiedModelResult<Schema, Model, T>, T>,
): ModelMutationModelResult<Schema, Model, T>;

useDelete<T extends DeleteArgs<Schema, Model>>(
options?: ModelMutationOptions<ModelResult<Schema, Model, T>, T>,
useDelete<T extends DeleteArgs<Schema, Model, true>>(
options?: ModelMutationOptions<SimplifiedModelResult<Schema, Model, T>, T>,
): ModelMutationModelResult<Schema, Model, T>;

useDeleteMany<T extends DeleteManyArgs<Schema, Model>>(
useDeleteMany<T extends DeleteManyArgs<Schema, Model, true>>(
options?: ModelMutationOptions<BatchResult, T>,
): ModelMutationResult<BatchResult, T>;

useCount<T extends CountArgs<Schema, Model>>(
useCount<T extends CountArgs<Schema, Model, true>>(
args?: Subset<T, CountArgs<Schema, Model>>,
options?: ModelQueryOptions<CountResult<Schema, Model, T>>,
): ModelQueryResult<CountResult<Schema, Model, T>>;

useSuspenseCount<T extends CountArgs<Schema, Model>>(
useSuspenseCount<T extends CountArgs<Schema, Model, true>>(
args?: Subset<T, CountArgs<Schema, Model>>,
options?: ModelSuspenseQueryOptions<CountResult<Schema, Model, T>>,
): ModelSuspenseQueryResult<CountResult<Schema, Model, T>>;

useAggregate<T extends AggregateArgs<Schema, Model>>(
useAggregate<T extends AggregateArgs<Schema, Model, true>>(
args: Subset<T, AggregateArgs<Schema, Model>>,
options?: ModelQueryOptions<AggregateResult<Schema, Model, T>>,
): ModelQueryResult<AggregateResult<Schema, Model, T>>;

useSuspenseAggregate<T extends AggregateArgs<Schema, Model>>(
useSuspenseAggregate<T extends AggregateArgs<Schema, Model, true>>(
args: Subset<T, AggregateArgs<Schema, Model>>,
options?: ModelSuspenseQueryOptions<AggregateResult<Schema, Model, T>>,
): ModelSuspenseQueryResult<AggregateResult<Schema, Model, T>>;

useGroupBy<T extends GroupByArgs<Schema, Model>>(
useGroupBy<T extends GroupByArgs<Schema, Model, true>>(
args: Subset<T, GroupByArgs<Schema, Model>>,
options?: ModelQueryOptions<GroupByResult<Schema, Model, T>>,
): ModelQueryResult<GroupByResult<Schema, Model, T>>;

useSuspenseGroupBy<T extends GroupByArgs<Schema, Model>>(
useSuspenseGroupBy<T extends GroupByArgs<Schema, Model, true>>(
args: Subset<T, GroupByArgs<Schema, Model>>,
options?: ModelSuspenseQueryOptions<GroupByResult<Schema, Model, T>>,
): ModelSuspenseQueryResult<GroupByResult<Schema, Model, T>>;
Expand Down
91 changes: 47 additions & 44 deletions packages/clients/tanstack-query/src/svelte.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,13 @@ import type {
CreateManyArgs,
DeleteArgs,
DeleteManyArgs,
FindArgs,
FindFirstArgs,
FindManyArgs,
FindUniqueArgs,
GroupByArgs,
GroupByResult,
ModelResult,
SelectIncludeOmit,
SelectSubset,
SimplifiedModelResult,
Subset,
UpdateArgs,
UpdateManyAndReturnArgs,
Expand Down Expand Up @@ -114,14 +114,17 @@ export type ModelMutationResult<T, TArgs> = CreateMutationResult<T, DefaultError
export type ModelMutationModelResult<
Schema extends SchemaDef,
Model extends GetModels<Schema>,
TArgs extends SelectIncludeOmit<Schema, Model, boolean>,
TArgs,
Array extends boolean = false,
> = Readable<
Omit<UnwrapStore<ModelMutationResult<ModelResult<Schema, Model, TArgs>, TArgs>>, 'mutateAsync'> & {
Omit<
UnwrapStore<ModelMutationResult<SimplifiedModelResult<Schema, Model, TArgs, false, Array>, TArgs>>,
'mutateAsync'
> & {
mutateAsync<T extends TArgs>(
args: T,
options?: ModelMutationOptions<ModelResult<Schema, Model, T>, T>,
): Promise<Array extends true ? ModelResult<Schema, Model, T>[] : ModelResult<Schema, Model, T>>;
options?: ModelMutationOptions<SimplifiedModelResult<Schema, Model, T, false, Array>, T>,
): Promise<SimplifiedModelResult<Schema, Model, T, false, Array>>;
}
>;

Expand All @@ -135,73 +138,73 @@ export type ModelQueryHooks<Schema extends SchemaDef, Model extends GetModels<Sc
Schema,
Model,
{
useFindUnique<T extends FindUniqueArgs<Schema, Model>>(
useFindUnique<T extends FindUniqueArgs<Schema, Model, true>>(
args: SelectSubset<T, FindUniqueArgs<Schema, Model>>,
options?: ModelQueryOptions<ModelResult<Schema, Model, T> | null>,
): ModelQueryResult<ModelResult<Schema, Model, T> | null>;

useFindFirst<T extends FindArgs<Schema, Model, false>>(
args?: SelectSubset<T, FindArgs<Schema, Model, false>>,
options?: ModelQueryOptions<ModelResult<Schema, Model, T> | null>,
): ModelQueryResult<ModelResult<Schema, Model, T> | null>;

useFindMany<T extends FindArgs<Schema, Model, true>>(
args?: SelectSubset<T, FindArgs<Schema, Model, true>>,
options?: ModelQueryOptions<ModelResult<Schema, Model, T>[]>,
): ModelQueryResult<ModelResult<Schema, Model, T>[]>;

useInfiniteFindMany<T extends FindArgs<Schema, Model, true>>(
args?: SelectSubset<T, FindArgs<Schema, Model, true>>,
options?: ModelInfiniteQueryOptions<ModelResult<Schema, Model, T>[]>,
): ModelInfiniteQueryResult<InfiniteData<ModelResult<Schema, Model, T>[]>>;

useCreate<T extends CreateArgs<Schema, Model>>(
options?: ModelMutationOptions<ModelResult<Schema, Model, T>, T>,
options?: ModelQueryOptions<SimplifiedModelResult<Schema, Model, T> | null>,
): ModelQueryResult<SimplifiedModelResult<Schema, Model, T> | null>;

useFindFirst<T extends FindFirstArgs<Schema, Model, true>>(
args?: SelectSubset<T, FindFirstArgs<Schema, Model>>,
options?: ModelQueryOptions<SimplifiedModelResult<Schema, Model, T> | null>,
): ModelQueryResult<SimplifiedModelResult<Schema, Model, T> | null>;

useFindMany<T extends FindManyArgs<Schema, Model, true>>(
args?: SelectSubset<T, FindManyArgs<Schema, Model>>,
options?: ModelQueryOptions<SimplifiedModelResult<Schema, Model, T>[]>,
): ModelQueryResult<SimplifiedModelResult<Schema, Model, T>[]>;

useInfiniteFindMany<T extends FindManyArgs<Schema, Model, true>>(
args?: SelectSubset<T, FindManyArgs<Schema, Model>>,
options?: ModelInfiniteQueryOptions<SimplifiedModelResult<Schema, Model, T>[]>,
): ModelInfiniteQueryResult<InfiniteData<SimplifiedModelResult<Schema, Model, T>[]>>;

useCreate<T extends CreateArgs<Schema, Model, true>>(
options?: ModelMutationOptions<SimplifiedModelResult<Schema, Model, T>, T>,
): ModelMutationModelResult<Schema, Model, T>;

useCreateMany<T extends CreateManyArgs<Schema, Model>>(
useCreateMany<T extends CreateManyArgs<Schema, Model, true>>(
options?: ModelMutationOptions<BatchResult, T>,
): ModelMutationResult<BatchResult, T>;

useCreateManyAndReturn<T extends CreateManyAndReturnArgs<Schema, Model>>(
options?: ModelMutationOptions<ModelResult<Schema, Model, T>[], T>,
useCreateManyAndReturn<T extends CreateManyAndReturnArgs<Schema, Model, true>>(
options?: ModelMutationOptions<SimplifiedModelResult<Schema, Model, T>[], T>,
): ModelMutationModelResult<Schema, Model, T, true>;

useUpdate<T extends UpdateArgs<Schema, Model>>(
options?: ModelMutationOptions<ModelResult<Schema, Model, T>, T>,
useUpdate<T extends UpdateArgs<Schema, Model, true>>(
options?: ModelMutationOptions<SimplifiedModelResult<Schema, Model, T>, T>,
): ModelMutationModelResult<Schema, Model, T>;

useUpdateMany<T extends UpdateManyArgs<Schema, Model>>(
useUpdateMany<T extends UpdateManyArgs<Schema, Model, true>>(
options?: ModelMutationOptions<BatchResult, T>,
): ModelMutationResult<BatchResult, T>;

useUpdateManyAndReturn<T extends UpdateManyAndReturnArgs<Schema, Model>>(
options?: ModelMutationOptions<ModelResult<Schema, Model, T>[], T>,
useUpdateManyAndReturn<T extends UpdateManyAndReturnArgs<Schema, Model, true>>(
options?: ModelMutationOptions<SimplifiedModelResult<Schema, Model, T>[], T>,
): ModelMutationModelResult<Schema, Model, T, true>;

useUpsert<T extends UpsertArgs<Schema, Model>>(
options?: ModelMutationOptions<ModelResult<Schema, Model, T>, T>,
useUpsert<T extends UpsertArgs<Schema, Model, true>>(
options?: ModelMutationOptions<SimplifiedModelResult<Schema, Model, T>, T>,
): ModelMutationModelResult<Schema, Model, T>;

useDelete<T extends DeleteArgs<Schema, Model>>(
options?: ModelMutationOptions<ModelResult<Schema, Model, T>, T>,
useDelete<T extends DeleteArgs<Schema, Model, true>>(
options?: ModelMutationOptions<SimplifiedModelResult<Schema, Model, T>, T>,
): ModelMutationModelResult<Schema, Model, T>;

useDeleteMany<T extends DeleteManyArgs<Schema, Model>>(
useDeleteMany<T extends DeleteManyArgs<Schema, Model, true>>(
options?: ModelMutationOptions<BatchResult, T>,
): ModelMutationResult<BatchResult, T>;

useCount<T extends CountArgs<Schema, Model>>(
useCount<T extends CountArgs<Schema, Model, true>>(
args?: Subset<T, CountArgs<Schema, Model>>,
options?: ModelQueryOptions<CountResult<Schema, Model, T>>,
): ModelQueryResult<CountResult<Schema, Model, T>>;

useAggregate<T extends AggregateArgs<Schema, Model>>(
useAggregate<T extends AggregateArgs<Schema, Model, true>>(
args: Subset<T, AggregateArgs<Schema, Model>>,
options?: ModelQueryOptions<AggregateResult<Schema, Model, T>>,
): ModelQueryResult<AggregateResult<Schema, Model, T>>;

useGroupBy<T extends GroupByArgs<Schema, Model>>(
useGroupBy<T extends GroupByArgs<Schema, Model, true>>(
args: Subset<T, GroupByArgs<Schema, Model>>,
options?: ModelQueryOptions<GroupByResult<Schema, Model, T>>,
): ModelQueryResult<GroupByResult<Schema, Model, T>>;
Expand Down
Loading