zenstack/packages/clients/tanstack-query/test/react-typing-test.ts
Yiming Cao 81924d9e55
fix(tanstack): query result $optimistic typing (#372)
* fix(tanstack): query result $optimistic typing

* update
2025-11-05 19:45:15 -08:00

113 lines
3.5 KiB
TypeScript

import { useClientQueries } from '../src/react';
import { schema } from './schemas/basic/schema-lite';
const client = useClientQueries(schema);
// @ts-expect-error missing args
client.user.useFindUnique();
check(client.user.useFindUnique({ where: { id: '1' } }).data?.email);
check(client.user.useFindUnique({ where: { id: '1' } }).queryKey);
check(client.user.useFindUnique({ where: { id: '1' } }, { optimisticUpdate: true, enabled: false }));
// @ts-expect-error unselected field
check(client.user.useFindUnique({ select: { email: true } }).data.name);
check(client.user.useFindUnique({ where: { id: '1' }, include: { posts: true } }).data?.posts[0]?.title);
check(client.user.useFindFirst().data?.email);
check(client.user.useFindFirst().data?.$optimistic);
check(client.user.useFindMany().data?.[0]?.email);
check(client.user.useFindMany().data?.[0]?.$optimistic);
check(client.user.useInfiniteFindMany().data?.pages[0]?.[0]?.email);
check(
client.user.useInfiniteFindMany(
{},
{
getNextPageParam: () => ({ id: '2' }),
},
).data?.pages[1]?.[0]?.email,
);
// @ts-expect-error
check(client.user.useInfiniteFindMany().data?.pages[0]?.[0]?.$optimistic);
check(client.user.useSuspenseFindMany().data[0]?.email);
check(client.user.useSuspenseInfiniteFindMany().data.pages[0]?.[0]?.email);
check(client.user.useCount().data?.toFixed(2));
check(client.user.useCount({ select: { email: true } }).data?.email.toFixed(2));
check(client.user.useAggregate({ _max: { email: true } }).data?._max.email);
check(client.user.useGroupBy({ by: ['email'], _max: { name: true } }).data?.[0]?._max.name);
// @ts-expect-error missing args
client.user.useCreate().mutate();
client.user.useCreate().mutate({ data: { email: 'test@example.com' } });
client.user
.useCreate({ optimisticUpdate: true, invalidateQueries: false, retry: 3 })
.mutate({ data: { email: 'test@example.com' } });
client.user
.useCreate()
.mutateAsync({ data: { email: 'test@example.com' }, include: { posts: true } })
.then((d) => check(d.posts[0]?.title));
client.user
.useCreateMany()
.mutateAsync({
data: [{ email: 'test@example.com' }, { email: 'test2@example.com' }],
skipDuplicates: true,
})
.then((d) => d.count);
client.user
.useCreateManyAndReturn()
.mutateAsync({
data: [{ email: 'test@example.com' }],
})
.then((d) => check(d[0]?.name));
client.user
.useCreateManyAndReturn()
.mutateAsync({
data: [{ email: 'test@example.com' }],
select: { email: true },
})
// @ts-expect-error unselected field
.then((d) => check(d[0].name));
client.user.useUpdate().mutate(
{ data: { email: 'updated@example.com' }, where: { id: '1' } },
{
onSuccess: (d) => {
check(d.email);
},
},
);
client.user.useUpdateMany().mutate({ data: { email: 'updated@example.com' } });
client.user
.useUpdateManyAndReturn()
.mutateAsync({ data: { email: 'updated@example.com' } })
.then((d) => check(d[0]?.email));
client.user
.useUpsert()
.mutate({ where: { id: '1' }, create: { email: 'new@example.com' }, update: { email: 'updated@example.com' } });
client.user.useDelete().mutate({ where: { id: '1' }, include: { posts: true } });
client.user.useDeleteMany().mutate({ where: { email: 'test@example.com' } });
function check(_value: unknown) {
// noop
}
// @ts-expect-error delegate model
client.foo.useCreate();
client.foo.useUpdate();
client.bar.useCreate();