Skip to content

feat(clients): add ExtResult support to TanStack Query hooks #2490

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
ymc9 merged 4 commits into from
Mar 18, 2026
Merged

feat(clients): add ExtResult support to TanStack Query hooks #2490

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
a06004e
feat(clients): add ExtResult support to TanStack Query hooks
genu Mar 17, 2026
d6a7bc5
refactor(clients): address review feedback for TanStack Query hooks
genu Mar 17, 2026
346799a
fix(clients): use Options generic consistently in Vue ModelMutationMo…
genu Mar 17, 2026
d5aead0
fix(clients): restore ExtResult for model hooks, keep removed for pro…
genu Mar 18, 2026
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
20 changes: 20 additions & 0 deletions packages/clients/client-helpers/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,28 @@
import type { ClientContract, QueryOptions } from '@zenstackhq/orm';
import type { SchemaDef } from '@zenstackhq/schema';

/**
* A type that represents either a value of type T or a Promise that resolves to type T.
*/
export type MaybePromise<T> = T | Promise<T> | PromiseLike<T>;

/**
* Infers the schema definition from a client contract type, or passes through a raw SchemaDef.
*/
export type InferSchema<T> = T extends { $schema: infer S extends SchemaDef } ? S : T extends SchemaDef ? T : never;

/**
* Extracts the ExtResult type from a client contract, or defaults to `{}`.
*/
export type InferExtResult<T> = T extends ClientContract<any, any, any, any, infer E> ? E : {};

/**
* Infers query options from a client contract type, or defaults to `QueryOptions<Schema>`.
*/
export type InferOptions<T, Schema extends SchemaDef> = T extends { $options: infer O extends QueryOptions<Schema> }
? O
: QueryOptions<Schema>;

/**
* List of ORM write actions.
*/
Expand Down
162 changes: 94 additions & 68 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 @@ -19,13 +19,14 @@ import {
type UseSuspenseQueryOptions,
type UseSuspenseQueryResult,
} from '@tanstack/react-query';
import { createInvalidator, createOptimisticUpdater, DEFAULT_QUERY_ENDPOINT } from '@zenstackhq/client-helpers';
import { createInvalidator, createOptimisticUpdater, DEFAULT_QUERY_ENDPOINT, type InferExtResult, type InferOptions, type InferSchema } from '@zenstackhq/client-helpers';
import { fetcher, makeUrl, marshal } from '@zenstackhq/client-helpers/fetch';
import { lowerCaseFirst } from '@zenstackhq/common-helpers';
import type {
AggregateArgs,
AggregateResult,
BatchResult,
ClientContract,
CountArgs,
CountResult,
CreateArgs,
Expand All @@ -34,6 +35,7 @@ import type {
DeleteArgs,
DeleteManyArgs,
ExistsArgs,
ExtResultBase,
FindFirstArgs,
FindManyArgs,
FindUniqueArgs,
Expand Down Expand Up @@ -68,6 +70,8 @@ import type {
WithOptimistic,
} from './common/types.js';
export type { FetchFn } from '@zenstackhq/client-helpers/fetch';
export type { InferExtResult, InferOptions, InferSchema } from '@zenstackhq/client-helpers';
export type { SchemaDef } from '@zenstackhq/schema';

type ProcedureHookFn<
Schema extends SchemaDef,
Expand Down Expand Up @@ -142,15 +146,20 @@ export type ModelMutationModelResult<
TArgs,
Array extends boolean = false,
Options extends QueryOptions<Schema> = QueryOptions<Schema>,
> = Omit<ModelMutationResult<SimplifiedResult<Schema, Model, TArgs, Options, false, Array>, TArgs>, 'mutateAsync'> & {
ExtResult extends ExtResultBase<Schema> = {},
> = Omit<ModelMutationResult<SimplifiedResult<Schema, Model, TArgs, Options, false, Array, ExtResult>, TArgs>, 'mutateAsync'> & {
mutateAsync<T extends TArgs>(
args: T,
options?: ModelMutationOptions<SimplifiedResult<Schema, Model, T, Options, false, Array>, T>,
): Promise<SimplifiedResult<Schema, Model, T, Options, false, Array>>;
options?: ModelMutationOptions<SimplifiedResult<Schema, Model, T, Options, false, Array, ExtResult>, T>,
): Promise<SimplifiedResult<Schema, Model, T, Options, false, Array, ExtResult>>;
};

export type ClientHooks<Schema extends SchemaDef, Options extends QueryOptions<Schema> = QueryOptions<Schema>> = {
[Model in GetSlicedModels<Schema, Options> as `${Uncapitalize<Model>}`]: ModelQueryHooks<Schema, Model, Options>;
export type ClientHooks<
Schema extends SchemaDef,
Options extends QueryOptions<Schema> = QueryOptions<Schema>,
ExtResult extends ExtResultBase<Schema> = {},
> = {
[Model in GetSlicedModels<Schema, Options> as `${Uncapitalize<Model>}`]: ModelQueryHooks<Schema, Model, Options, ExtResult>;
} & ProcedureHooks<Schema, Options>;

type ProcedureHookGroup<Schema extends SchemaDef, Options extends QueryOptions<Schema>> = {
Expand Down Expand Up @@ -213,87 +222,88 @@ export type ModelQueryHooks<
Schema extends SchemaDef,
Model extends GetModels<Schema>,
Options extends QueryOptions<Schema> = QueryOptions<Schema>,
ExtResult extends ExtResultBase<Schema> = {},
> = TrimSlicedOperations<
Schema,
Model,
Options,
{
useFindUnique<T extends FindUniqueArgs<Schema, Model, Options>>(
args: SelectSubset<T, FindUniqueArgs<Schema, Model, Options>>,
options?: ModelQueryOptions<SimplifiedPlainResult<Schema, Model, T, Options> | null>,
): ModelQueryResult<SimplifiedPlainResult<Schema, Model, T, Options> | null>;

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

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

useSuspenseFindFirst<T extends FindFirstArgs<Schema, Model, Options>>(
args?: SelectSubset<T, FindFirstArgs<Schema, Model, Options>>,
options?: ModelSuspenseQueryOptions<SimplifiedPlainResult<Schema, Model, T, Options> | null>,
): ModelSuspenseQueryResult<SimplifiedPlainResult<Schema, Model, T, Options> | null>;
useFindUnique<T extends FindUniqueArgs<Schema, Model, Options, {}, ExtResult>>(
args: SelectSubset<T, FindUniqueArgs<Schema, Model, Options, {}, ExtResult>>,
options?: ModelQueryOptions<SimplifiedPlainResult<Schema, Model, T, Options, ExtResult> | null>,
): ModelQueryResult<SimplifiedPlainResult<Schema, Model, T, Options, ExtResult> | null>;

useSuspenseFindUnique<T extends FindUniqueArgs<Schema, Model, Options, {}, ExtResult>>(
args: SelectSubset<T, FindUniqueArgs<Schema, Model, Options, {}, ExtResult>>,
options?: ModelSuspenseQueryOptions<SimplifiedPlainResult<Schema, Model, T, Options, ExtResult> | null>,
): ModelSuspenseQueryResult<SimplifiedPlainResult<Schema, Model, T, Options, ExtResult> | null>;

useFindFirst<T extends FindFirstArgs<Schema, Model, Options, {}, ExtResult>>(
args?: SelectSubset<T, FindFirstArgs<Schema, Model, Options, {}, ExtResult>>,
options?: ModelQueryOptions<SimplifiedPlainResult<Schema, Model, T, Options, ExtResult> | null>,
): ModelQueryResult<SimplifiedPlainResult<Schema, Model, T, Options, ExtResult> | null>;

useSuspenseFindFirst<T extends FindFirstArgs<Schema, Model, Options, {}, ExtResult>>(
args?: SelectSubset<T, FindFirstArgs<Schema, Model, Options, {}, ExtResult>>,
options?: ModelSuspenseQueryOptions<SimplifiedPlainResult<Schema, Model, T, Options, ExtResult> | null>,
): ModelSuspenseQueryResult<SimplifiedPlainResult<Schema, Model, T, Options, ExtResult> | null>;

useExists<T extends ExistsArgs<Schema, Model, Options>>(
args?: Subset<T, ExistsArgs<Schema, Model, Options>>,
options?: ModelQueryOptions<boolean>,
): ModelQueryResult<boolean>;

useFindMany<T extends FindManyArgs<Schema, Model, Options>>(
args?: SelectSubset<T, FindManyArgs<Schema, Model, Options>>,
options?: ModelQueryOptions<SimplifiedPlainResult<Schema, Model, T, Options>[]>,
): ModelQueryResult<SimplifiedPlainResult<Schema, Model, T, Options>[]>;
useFindMany<T extends FindManyArgs<Schema, Model, Options, {}, ExtResult>>(
args?: SelectSubset<T, FindManyArgs<Schema, Model, Options, {}, ExtResult>>,
options?: ModelQueryOptions<SimplifiedPlainResult<Schema, Model, T, Options, ExtResult>[]>,
): ModelQueryResult<SimplifiedPlainResult<Schema, Model, T, Options, ExtResult>[]>;

useSuspenseFindMany<T extends FindManyArgs<Schema, Model, Options>>(
args?: SelectSubset<T, FindManyArgs<Schema, Model, Options>>,
options?: ModelSuspenseQueryOptions<SimplifiedPlainResult<Schema, Model, T, Options>[]>,
): ModelSuspenseQueryResult<SimplifiedPlainResult<Schema, Model, T, Options>[]>;
useSuspenseFindMany<T extends FindManyArgs<Schema, Model, Options, {}, ExtResult>>(
args?: SelectSubset<T, FindManyArgs<Schema, Model, Options, {}, ExtResult>>,
options?: ModelSuspenseQueryOptions<SimplifiedPlainResult<Schema, Model, T, Options, ExtResult>[]>,
): ModelSuspenseQueryResult<SimplifiedPlainResult<Schema, Model, T, Options, ExtResult>[]>;

useInfiniteFindMany<T extends FindManyArgs<Schema, Model, Options>>(
args?: SelectSubset<T, FindManyArgs<Schema, Model, Options>>,
options?: ModelInfiniteQueryOptions<SimplifiedPlainResult<Schema, Model, T, Options>[]>,
): ModelInfiniteQueryResult<InfiniteData<SimplifiedPlainResult<Schema, Model, T, Options>[]>>;
useInfiniteFindMany<T extends FindManyArgs<Schema, Model, Options, {}, ExtResult>>(
args?: SelectSubset<T, FindManyArgs<Schema, Model, Options, {}, ExtResult>>,
options?: ModelInfiniteQueryOptions<SimplifiedPlainResult<Schema, Model, T, Options, ExtResult>[]>,
): ModelInfiniteQueryResult<InfiniteData<SimplifiedPlainResult<Schema, Model, T, Options, ExtResult>[]>>;

useSuspenseInfiniteFindMany<T extends FindManyArgs<Schema, Model, Options>>(
args?: SelectSubset<T, FindManyArgs<Schema, Model, Options>>,
options?: ModelSuspenseInfiniteQueryOptions<SimplifiedPlainResult<Schema, Model, T, Options>[]>,
): ModelSuspenseInfiniteQueryResult<InfiniteData<SimplifiedPlainResult<Schema, Model, T, Options>[]>>;
useSuspenseInfiniteFindMany<T extends FindManyArgs<Schema, Model, Options, {}, ExtResult>>(
args?: SelectSubset<T, FindManyArgs<Schema, Model, Options, {}, ExtResult>>,
options?: ModelSuspenseInfiniteQueryOptions<SimplifiedPlainResult<Schema, Model, T, Options, ExtResult>[]>,
): ModelSuspenseInfiniteQueryResult<InfiniteData<SimplifiedPlainResult<Schema, Model, T, Options, ExtResult>[]>>;

useCreate<T extends CreateArgs<Schema, Model, Options>>(
options?: ModelMutationOptions<SimplifiedPlainResult<Schema, Model, T, Options>, T>,
): ModelMutationModelResult<Schema, Model, T, false, Options>;
useCreate<T extends CreateArgs<Schema, Model, Options, {}, ExtResult>>(
options?: ModelMutationOptions<SimplifiedPlainResult<Schema, Model, T, Options, ExtResult>, T>,
): ModelMutationModelResult<Schema, Model, T, false, Options, ExtResult>;

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

useCreateManyAndReturn<T extends CreateManyAndReturnArgs<Schema, Model, Options>>(
options?: ModelMutationOptions<SimplifiedPlainResult<Schema, Model, T, Options>[], T>,
): ModelMutationModelResult<Schema, Model, T, true, Options>;
useCreateManyAndReturn<T extends CreateManyAndReturnArgs<Schema, Model, Options, {}, ExtResult>>(
options?: ModelMutationOptions<SimplifiedPlainResult<Schema, Model, T, Options, ExtResult>[], T>,
): ModelMutationModelResult<Schema, Model, T, true, Options, ExtResult>;

useUpdate<T extends UpdateArgs<Schema, Model, Options>>(
options?: ModelMutationOptions<SimplifiedPlainResult<Schema, Model, T, Options>, T>,
): ModelMutationModelResult<Schema, Model, T, false, Options>;
useUpdate<T extends UpdateArgs<Schema, Model, Options, {}, ExtResult>>(
options?: ModelMutationOptions<SimplifiedPlainResult<Schema, Model, T, Options, ExtResult>, T>,
): ModelMutationModelResult<Schema, Model, T, false, Options, ExtResult>;

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

useUpdateManyAndReturn<T extends UpdateManyAndReturnArgs<Schema, Model, Options>>(
options?: ModelMutationOptions<SimplifiedPlainResult<Schema, Model, T, Options>[], T>,
): ModelMutationModelResult<Schema, Model, T, true, Options>;
useUpdateManyAndReturn<T extends UpdateManyAndReturnArgs<Schema, Model, Options, {}, ExtResult>>(
options?: ModelMutationOptions<SimplifiedPlainResult<Schema, Model, T, Options, ExtResult>[], T>,
): ModelMutationModelResult<Schema, Model, T, true, Options, ExtResult>;

useUpsert<T extends UpsertArgs<Schema, Model, Options>>(
options?: ModelMutationOptions<SimplifiedPlainResult<Schema, Model, T, Options>, T>,
): ModelMutationModelResult<Schema, Model, T, false, Options>;
useUpsert<T extends UpsertArgs<Schema, Model, Options, {}, ExtResult>>(
options?: ModelMutationOptions<SimplifiedPlainResult<Schema, Model, T, Options, ExtResult>, T>,
): ModelMutationModelResult<Schema, Model, T, false, Options, ExtResult>;

useDelete<T extends DeleteArgs<Schema, Model, Options>>(
options?: ModelMutationOptions<SimplifiedPlainResult<Schema, Model, T, Options>, T>,
): ModelMutationModelResult<Schema, Model, T, false, Options>;
useDelete<T extends DeleteArgs<Schema, Model, Options, {}, ExtResult>>(
options?: ModelMutationOptions<SimplifiedPlainResult<Schema, Model, T, Options, ExtResult>, T>,
): ModelMutationModelResult<Schema, Model, T, false, Options, ExtResult>;

useDeleteMany<T extends DeleteManyArgs<Schema, Model, Options>>(
options?: ModelMutationOptions<BatchResult, T>,
Expand Down Expand Up @@ -334,23 +344,38 @@ export type ModelQueryHooks<
/**
* Gets data query hooks for all models in the schema.
*
* Accepts either a raw `SchemaDef` or a `ClientContract` type (e.g. `typeof db`) as the generic parameter.
* When a `ClientContract` type is provided, computed fields from plugins are reflected in the result types.
*
* @example
* ```typescript
* // Basic usage with schema
* const client = useClientQueries(schema)
*
* // With server client type for computed field support
* import type { DbType } from '~/server/db'
* const client = useClientQueries<DbType>(schema)
* ```
*
* @param schema The schema.
* @param options Options for all queries originated from this hook.
*/
export function useClientQueries<Schema extends SchemaDef, Options extends QueryOptions<Schema> = QueryOptions<Schema>>(
schema: Schema,
export function useClientQueries<
SchemaOrClient extends SchemaDef | ClientContract<any, any, any, any, any>,
>(
schema: InferSchema<SchemaOrClient>,
options?: QueryContext,
): ClientHooks<Schema, Options> {
): ClientHooks<InferSchema<SchemaOrClient>, InferOptions<SchemaOrClient, InferSchema<SchemaOrClient>>, InferExtResult<SchemaOrClient> extends ExtResultBase<InferSchema<SchemaOrClient>> ? InferExtResult<SchemaOrClient> : {}> {
const result = Object.keys(schema.models).reduce(
(acc, model) => {
(acc as any)[lowerCaseFirst(model)] = useModelQueries<Schema, GetModels<Schema>, Options>(
schema,
model as GetModels<Schema>,
(acc as any)[lowerCaseFirst(model)] = useModelQueries(
schema as any,
model as any,
options,
);
return acc;
},
{} as ClientHooks<Schema, Options>,
{} as any,
);

const procedures = (schema as any).procedures as Record<string, { mutation?: boolean }> | undefined;
Expand Down Expand Up @@ -407,7 +432,8 @@ export function useModelQueries<
Schema extends SchemaDef,
Model extends GetModels<Schema>,
Options extends QueryOptions<Schema>,
>(schema: Schema, model: Model, rootOptions?: QueryContext): ModelQueryHooks<Schema, Model, Options> {
ExtResult extends ExtResultBase<Schema> = {},
>(schema: Schema, model: Model, rootOptions?: QueryContext): ModelQueryHooks<Schema, Model, Options, ExtResult> {
const modelDef = Object.values(schema.models).find((m) => m.name.toLowerCase() === model.toLowerCase());
if (!modelDef) {
throw new Error(`Model "${model}" not found in schema`);
Expand Down Expand Up @@ -517,7 +543,7 @@ export function useModelQueries<
useSuspenseGroupBy: (args: any, options?: any) => {
return useInternalSuspenseQuery(schema, modelName, 'groupBy', args, { ...rootOptions, ...options });
},
} as ModelQueryHooks<Schema, Model, Options>;
} as ModelQueryHooks<Schema, Model, Options, ExtResult>;
}

export function useInternalQuery<TQueryFnData, TData>(
Expand Down
Loading
Loading