Skip to content

fix(tanstack): improve mutation mutateAsync typing #368

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 2 commits into from
Nov 5, 2025
Merged

fix(tanstack): improve mutation mutateAsync typing #368

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9ce9cee
fix(tanstack): improve mutation mutateAsync typing
ymc9 Nov 5, 2025
88c5cc4
simplify typing
ymc9 Nov 5, 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
2 changes: 1 addition & 1 deletion packages/clients/tanstack-query/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,8 +67,8 @@
},
"devDependencies": {
"@tanstack/react-query": "catalog:",
"@tanstack/svelte-query": "5.90.2",
"@tanstack/vue-query": "5.90.6",
"@tanstack/svelte-query": "5.90.2",
"@testing-library/dom": "^10.4.1",
"@testing-library/react": "^16.3.0",
"@types/react": "catalog:",
Expand Down
251 changes: 137 additions & 114 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 @@ -36,6 +36,7 @@ import type {
GroupByArgs,
GroupByResult,
ModelResult,
SelectIncludeOmit,
SelectSubset,
Subset,
UpdateArgs,
Expand All @@ -56,6 +57,7 @@ import {
type ExtraMutationOptions,
type ExtraQueryOptions,
} from './utils/common';
import type { TrimDelegateModelOperations } from './utils/types';

export type { FetchFn } from './utils/common';

Expand Down Expand Up @@ -119,126 +121,144 @@ export type ModelMutationOptions<T, TArgs> = Omit<UseMutationOptions<T, DefaultE

export type ModelMutationResult<T, TArgs> = UseMutationResult<T, DefaultError, TArgs>;

export type SchemaHooks<Schema extends SchemaDef> = {
[Model in GetModels<Schema> as `${Uncapitalize<Model>}`]: ModelQueryHooks<Schema, Model>;
};

export type ModelQueryHooks<Schema extends SchemaDef, Model extends GetModels<Schema>> = {
useFindUnique<T extends FindUniqueArgs<Schema, Model>>(
args: SelectSubset<T, FindUniqueArgs<Schema, Model>>,
options?: ModelQueryOptions<ModelResult<Schema, Model, T> | null>,
): ModelQueryResult<ModelResult<Schema, Model, T> | null>;

useSuspenseFindUnique<T extends FindUniqueArgs<Schema, Model>>(
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>,
): ModelMutationResult<ModelResult<Schema, Model, T>, T>;

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

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

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

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

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

useUpsert<T extends UpsertArgs<Schema, Model>>(
export type ModelMutationModelResult<
Schema extends SchemaDef,
Model extends GetModels<Schema>,
TArgs extends SelectIncludeOmit<Schema, Model, boolean>,
Array extends boolean = false,
> = Omit<ModelMutationResult<ModelResult<Schema, Model, TArgs>, TArgs>, 'mutateAsync'> & {
mutateAsync<T extends TArgs>(
args: T,
options?: ModelMutationOptions<ModelResult<Schema, Model, T>, T>,
): ModelMutationResult<ModelResult<Schema, Model, T>, T>;
): Promise<Array extends true ? ModelResult<Schema, Model, T>[] : ModelResult<Schema, Model, T>>;
};

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

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

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

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

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

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

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

useSuspenseGroupBy<T extends GroupByArgs<Schema, Model>>(
args: Subset<T, GroupByArgs<Schema, Model>>,
options?: ModelSuspenseQueryOptions<GroupByResult<Schema, Model, T>>,
): ModelSuspenseQueryResult<GroupByResult<Schema, Model, T>>;
export type ClientHooks<Schema extends SchemaDef> = {
[Model in GetModels<Schema> as `${Uncapitalize<Model>}`]: ModelQueryHooks<Schema, Model>;
};

// Note that we can potentially use TypeScript's mapped type to directly map from ORM contract, but that seems
// to significantly slow down tsc performance ...
export type ModelQueryHooks<Schema extends SchemaDef, Model extends GetModels<Schema>> = TrimDelegateModelOperations<
Schema,
Model,
{
useFindUnique<T extends FindUniqueArgs<Schema, Model>>(
args: SelectSubset<T, FindUniqueArgs<Schema, Model>>,
options?: ModelQueryOptions<ModelResult<Schema, Model, T> | null>,
): ModelQueryResult<ModelResult<Schema, Model, T> | null>;

useSuspenseFindUnique<T extends FindUniqueArgs<Schema, Model>>(
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>,
): ModelMutationModelResult<Schema, Model, T>;

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

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

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

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

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

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

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

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

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

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

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

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

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

useSuspenseGroupBy<T extends GroupByArgs<Schema, Model>>(
args: Subset<T, GroupByArgs<Schema, Model>>,
options?: ModelSuspenseQueryOptions<GroupByResult<Schema, Model, T>>,
): ModelSuspenseQueryResult<GroupByResult<Schema, Model, T>>;
}
>;

/**
* Gets data query hooks for all models in the schema.
*/
export function useClientQueries<Schema extends SchemaDef>(schema: Schema): SchemaHooks<Schema> {
export function useClientQueries<Schema extends SchemaDef>(schema: Schema): ClientHooks<Schema> {
return Object.keys(schema.models).reduce((acc, model) => {
(acc as any)[lowerCaseFirst(model)] = useModelQueries(schema, model as GetModels<Schema>);
return acc;
}, {} as SchemaHooks<Schema>);
}, {} as ClientHooks<Schema>);
}

/**
Expand Down Expand Up @@ -401,11 +421,14 @@ export function useInternalInfiniteQuery<TQueryFnData, TData>(
model: string,
operation: string,
args: unknown,
options: Omit<
UseInfiniteQueryOptions<TQueryFnData, DefaultError, InfiniteData<TData>>,
'queryKey' | 'initialPageParam'
>,
options:
| Omit<
UseInfiniteQueryOptions<TQueryFnData, DefaultError, InfiniteData<TData>>,
'queryKey' | 'initialPageParam'
>
| undefined,
) {
options = options ?? { getNextPageParam: () => undefined };
const { endpoint, fetch } = useHooksContext();
const queryKey = getQueryKey(model, operation, args, { infinite: true, optimisticUpdate: false });
return {
Expand Down
Loading