Skip to content

fix(trpc): make input arg's optionality consistent with Prisma #1730

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 1 commit into from
Sep 23, 2024
Merged

fix(trpc): make input arg's optionality consistent with Prisma #1730

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 17 additions & 13 deletions packages/plugins/trpc/src/helpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,9 @@ function getPrismaOperationTypes(model: string, operation: string) {

let argsType: string;
let resultType: string;
const argsOptional = ['findMany', 'findFirst', 'findFirstOrThrow', 'createMany', 'deleteMany', 'count'].includes(
operation
);

switch (operation) {
case 'findUnique':
Expand Down Expand Up @@ -178,7 +181,7 @@ function getPrismaOperationTypes(model: string, operation: string) {
throw new PluginError(name, `Unsupported operation: "${operation}"`);
}

return { genericBase, argsType, resultType };
return { genericBase, argsType, resultType, argsOptional };
}

/**
Expand All @@ -192,22 +195,23 @@ export function generateRouterTyping(
version: string
) {
const procType = getProcedureTypeByOpName(baseOpType);
const { genericBase, argsType, resultType } = getPrismaOperationTypes(modelName, opType);
const { genericBase, argsType, argsOptional, resultType } = getPrismaOperationTypes(modelName, opType);
const errorType = `TRPCClientErrorLike<AppRouter>`;
const inputOptional = argsOptional ? '?' : '';

writer.block(() => {
if (procType === 'query') {
if (version === 'v10') {
writer.writeLine(`
useQuery: <T extends ${genericBase}, TData = ${resultType}>(
input: ${argsType},
input${inputOptional}: ${argsType},
opts?: UseTRPCQueryOptions<string, T, ${resultType}, TData, Error>
) => UseTRPCQueryResult<
TData,
${errorType}
>;
useInfiniteQuery: <T extends ${genericBase}>(
input: Omit<${argsType}, 'cursor'>,
input${inputOptional}: Omit<${argsType}, 'cursor'>,
opts?: UseTRPCInfiniteQueryOptions<string, T, ${resultType}, Error>
) => UseTRPCInfiniteQueryResult<
${resultType},
Expand All @@ -217,26 +221,26 @@ export function generateRouterTyping(
} else {
writer.writeLine(`
useQuery: <T extends ${genericBase}, TData = ${resultType}>(
input: ${argsType},
input${inputOptional}: ${argsType},
opts?: UseTRPCQueryOptions<${resultType}, TData, Error>
) => UseTRPCQueryResult<
TData,
${errorType}
>;
useInfiniteQuery: <T extends ${genericBase}>(
input: Omit<${argsType}, 'cursor'>,
input${inputOptional}: Omit<${argsType}, 'cursor'>,
opts?: UseTRPCInfiniteQueryOptions<T, ${resultType}, Error>
) => UseTRPCInfiniteQueryResult<
${resultType},
${errorType},
T
>;
useSuspenseQuery: <T extends ${genericBase}, TData = ${resultType}>(
input: ${argsType},
input${inputOptional}: ${argsType},
opts?: UseTRPCSuspenseQueryOptions<${resultType}, TData, Error>
) => UseTRPCSuspenseQueryResult<TData, ${errorType}>;
useSuspenseInfiniteQuery: <T extends ${genericBase}>(
input: Omit<${argsType}, 'cursor'>,
input${inputOptional}: Omit<${argsType}, 'cursor'>,
opts?: UseTRPCSuspenseInfiniteQueryOptions<T, ${resultType}, Error>
) => UseTRPCSuspenseInfiniteQueryResult<${resultType}, ${errorType}, T>;
`);
Expand Down Expand Up @@ -298,10 +302,10 @@ export const getInputSchemaByOpName = (opName: string, modelName: string) => {
inputType = `$Schema.${capModelName}InputSchema.findUnique`;
break;
case 'findFirst':
inputType = `$Schema.${capModelName}InputSchema.findFirst`;
inputType = `$Schema.${capModelName}InputSchema.findFirst.optional()`;
break;
case 'findMany':
inputType = `$Schema.${capModelName}InputSchema.findMany`;
inputType = `$Schema.${capModelName}InputSchema.findMany.optional()`;
break;
case 'findRaw':
inputType = `$Schema.${capModelName}InputSchema.findRawObject`;
Expand All @@ -310,7 +314,7 @@ export const getInputSchemaByOpName = (opName: string, modelName: string) => {
inputType = `$Schema.${capModelName}InputSchema.create`;
break;
case 'createMany':
inputType = `$Schema.${capModelName}InputSchema.createMany`;
inputType = `$Schema.${capModelName}InputSchema.createMany.optional()`;
break;
case 'deleteOne':
inputType = `$Schema.${capModelName}InputSchema.delete`;
Expand All @@ -319,7 +323,7 @@ export const getInputSchemaByOpName = (opName: string, modelName: string) => {
inputType = `$Schema.${capModelName}InputSchema.update`;
break;
case 'deleteMany':
inputType = `$Schema.${capModelName}InputSchema.deleteMany`;
inputType = `$Schema.${capModelName}InputSchema.deleteMany.optional()`;
break;
case 'updateMany':
inputType = `$Schema.${capModelName}InputSchema.updateMany`;
Expand All @@ -337,7 +341,7 @@ export const getInputSchemaByOpName = (opName: string, modelName: string) => {
inputType = `$Schema.${capModelName}InputSchema.groupBy`;
break;
case 'count':
inputType = `$Schema.${capModelName}InputSchema.count`;
inputType = `$Schema.${capModelName}InputSchema.count.optional()`;
break;
default:
break;
Expand Down
28 changes: 14 additions & 14 deletions ...s/trpc/tests/projects/t3-trpc-v10/src/server/api/routers/generated/routers/Post.router.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,19 @@ export default function createRouter<Config extends BaseConfig>(router: RouterFa

aggregate: procedure.input($Schema.PostInputSchema.aggregate).query(({ ctx, input }) => checkRead(db(ctx).post.aggregate(input as any))),

createMany: procedure.input($Schema.PostInputSchema.createMany).mutation(async ({ ctx, input }) => checkMutate(db(ctx).post.createMany(input as any))),
createMany: procedure.input($Schema.PostInputSchema.createMany.optional()).mutation(async ({ ctx, input }) => checkMutate(db(ctx).post.createMany(input as any))),

create: procedure.input($Schema.PostInputSchema.create).mutation(async ({ ctx, input }) => checkMutate(db(ctx).post.create(input as any))),

deleteMany: procedure.input($Schema.PostInputSchema.deleteMany).mutation(async ({ ctx, input }) => checkMutate(db(ctx).post.deleteMany(input as any))),
deleteMany: procedure.input($Schema.PostInputSchema.deleteMany.optional()).mutation(async ({ ctx, input }) => checkMutate(db(ctx).post.deleteMany(input as any))),

delete: procedure.input($Schema.PostInputSchema.delete).mutation(async ({ ctx, input }) => checkMutate(db(ctx).post.delete(input as any))),

findFirst: procedure.input($Schema.PostInputSchema.findFirst).query(({ ctx, input }) => checkRead(db(ctx).post.findFirst(input as any))),
findFirst: procedure.input($Schema.PostInputSchema.findFirst.optional()).query(({ ctx, input }) => checkRead(db(ctx).post.findFirst(input as any))),

findFirstOrThrow: procedure.input($Schema.PostInputSchema.findFirst).query(({ ctx, input }) => checkRead(db(ctx).post.findFirstOrThrow(input as any))),
findFirstOrThrow: procedure.input($Schema.PostInputSchema.findFirst.optional()).query(({ ctx, input }) => checkRead(db(ctx).post.findFirstOrThrow(input as any))),

findMany: procedure.input($Schema.PostInputSchema.findMany).query(({ ctx, input }) => checkRead(db(ctx).post.findMany(input as any))),
findMany: procedure.input($Schema.PostInputSchema.findMany.optional()).query(({ ctx, input }) => checkRead(db(ctx).post.findMany(input as any))),

findUnique: procedure.input($Schema.PostInputSchema.findUnique).query(({ ctx, input }) => checkRead(db(ctx).post.findUnique(input as any))),

Expand All @@ -39,7 +39,7 @@ export default function createRouter<Config extends BaseConfig>(router: RouterFa

upsert: procedure.input($Schema.PostInputSchema.upsert).mutation(async ({ ctx, input }) => checkMutate(db(ctx).post.upsert(input as any))),

count: procedure.input($Schema.PostInputSchema.count).query(({ ctx, input }) => checkRead(db(ctx).post.count(input as any))),
count: procedure.input($Schema.PostInputSchema.count.optional()).query(({ ctx, input }) => checkRead(db(ctx).post.count(input as any))),

}
);
Expand Down Expand Up @@ -123,14 +123,14 @@ export interface ClientType<AppRouter extends AnyRouter, Context = AppRouter['_d
findFirst: {

useQuery: <T extends Prisma.PostFindFirstArgs, TData = Prisma.PostGetPayload<T>>(
input: Prisma.SelectSubset<T, Prisma.PostFindFirstArgs>,
input?: Prisma.SelectSubset<T, Prisma.PostFindFirstArgs>,
opts?: UseTRPCQueryOptions<string, T, Prisma.PostGetPayload<T>, TData, Error>
) => UseTRPCQueryResult<
TData,
TRPCClientErrorLike<AppRouter>
>;
useInfiniteQuery: <T extends Prisma.PostFindFirstArgs>(
input: Omit<Prisma.SelectSubset<T, Prisma.PostFindFirstArgs>, 'cursor'>,
input?: Omit<Prisma.SelectSubset<T, Prisma.PostFindFirstArgs>, 'cursor'>,
opts?: UseTRPCInfiniteQueryOptions<string, T, Prisma.PostGetPayload<T>, Error>
) => UseTRPCInfiniteQueryResult<
Prisma.PostGetPayload<T>,
Expand All @@ -141,14 +141,14 @@ export interface ClientType<AppRouter extends AnyRouter, Context = AppRouter['_d
findFirstOrThrow: {

useQuery: <T extends Prisma.PostFindFirstOrThrowArgs, TData = Prisma.PostGetPayload<T>>(
input: Prisma.SelectSubset<T, Prisma.PostFindFirstOrThrowArgs>,
input?: Prisma.SelectSubset<T, Prisma.PostFindFirstOrThrowArgs>,
opts?: UseTRPCQueryOptions<string, T, Prisma.PostGetPayload<T>, TData, Error>
) => UseTRPCQueryResult<
TData,
TRPCClientErrorLike<AppRouter>
>;
useInfiniteQuery: <T extends Prisma.PostFindFirstOrThrowArgs>(
input: Omit<Prisma.SelectSubset<T, Prisma.PostFindFirstOrThrowArgs>, 'cursor'>,
input?: Omit<Prisma.SelectSubset<T, Prisma.PostFindFirstOrThrowArgs>, 'cursor'>,
opts?: UseTRPCInfiniteQueryOptions<string, T, Prisma.PostGetPayload<T>, Error>
) => UseTRPCInfiniteQueryResult<
Prisma.PostGetPayload<T>,
Expand All @@ -159,14 +159,14 @@ export interface ClientType<AppRouter extends AnyRouter, Context = AppRouter['_d
findMany: {

useQuery: <T extends Prisma.PostFindManyArgs, TData = Array<Prisma.PostGetPayload<T>>>(
input: Prisma.SelectSubset<T, Prisma.PostFindManyArgs>,
input?: Prisma.SelectSubset<T, Prisma.PostFindManyArgs>,
opts?: UseTRPCQueryOptions<string, T, Array<Prisma.PostGetPayload<T>>, TData, Error>
) => UseTRPCQueryResult<
TData,
TRPCClientErrorLike<AppRouter>
>;
useInfiniteQuery: <T extends Prisma.PostFindManyArgs>(
input: Omit<Prisma.SelectSubset<T, Prisma.PostFindManyArgs>, 'cursor'>,
input?: Omit<Prisma.SelectSubset<T, Prisma.PostFindManyArgs>, 'cursor'>,
opts?: UseTRPCInfiniteQueryOptions<string, T, Array<Prisma.PostGetPayload<T>>, Error>
) => UseTRPCInfiniteQueryResult<
Array<Prisma.PostGetPayload<T>>,
Expand Down Expand Up @@ -389,7 +389,7 @@ export interface ClientType<AppRouter extends AnyRouter, Context = AppRouter['_d
? number
: Prisma.GetScalarType<T['select'], Prisma.PostCountAggregateOutputType>
: number>(
input: Prisma.Subset<T, Prisma.PostCountArgs>,
input?: Prisma.Subset<T, Prisma.PostCountArgs>,
opts?: UseTRPCQueryOptions<string, T, 'select' extends keyof T
? T['select'] extends true
? number
Expand All @@ -400,7 +400,7 @@ export interface ClientType<AppRouter extends AnyRouter, Context = AppRouter['_d
TRPCClientErrorLike<AppRouter>
>;
useInfiniteQuery: <T extends Prisma.PostCountArgs>(
input: Omit<Prisma.Subset<T, Prisma.PostCountArgs>, 'cursor'>,
input?: Omit<Prisma.Subset<T, Prisma.PostCountArgs>, 'cursor'>,
opts?: UseTRPCInfiniteQueryOptions<string, T, 'select' extends keyof T
? T['select'] extends true
? number
Expand Down
28 changes: 14 additions & 14 deletions ...s/trpc/tests/projects/t3-trpc-v10/src/server/api/routers/generated/routers/User.router.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,19 +13,19 @@ export default function createRouter<Config extends BaseConfig>(router: RouterFa

aggregate: procedure.input($Schema.UserInputSchema.aggregate).query(({ ctx, input }) => checkRead(db(ctx).user.aggregate(input as any))),

createMany: procedure.input($Schema.UserInputSchema.createMany).mutation(async ({ ctx, input }) => checkMutate(db(ctx).user.createMany(input as any))),
createMany: procedure.input($Schema.UserInputSchema.createMany.optional()).mutation(async ({ ctx, input }) => checkMutate(db(ctx).user.createMany(input as any))),

create: procedure.input($Schema.UserInputSchema.create).mutation(async ({ ctx, input }) => checkMutate(db(ctx).user.create(input as any))),

deleteMany: procedure.input($Schema.UserInputSchema.deleteMany).mutation(async ({ ctx, input }) => checkMutate(db(ctx).user.deleteMany(input as any))),
deleteMany: procedure.input($Schema.UserInputSchema.deleteMany.optional()).mutation(async ({ ctx, input }) => checkMutate(db(ctx).user.deleteMany(input as any))),

delete: procedure.input($Schema.UserInputSchema.delete).mutation(async ({ ctx, input }) => checkMutate(db(ctx).user.delete(input as any))),

findFirst: procedure.input($Schema.UserInputSchema.findFirst).query(({ ctx, input }) => checkRead(db(ctx).user.findFirst(input as any))),
findFirst: procedure.input($Schema.UserInputSchema.findFirst.optional()).query(({ ctx, input }) => checkRead(db(ctx).user.findFirst(input as any))),

findFirstOrThrow: procedure.input($Schema.UserInputSchema.findFirst).query(({ ctx, input }) => checkRead(db(ctx).user.findFirstOrThrow(input as any))),
findFirstOrThrow: procedure.input($Schema.UserInputSchema.findFirst.optional()).query(({ ctx, input }) => checkRead(db(ctx).user.findFirstOrThrow(input as any))),

findMany: procedure.input($Schema.UserInputSchema.findMany).query(({ ctx, input }) => checkRead(db(ctx).user.findMany(input as any))),
findMany: procedure.input($Schema.UserInputSchema.findMany.optional()).query(({ ctx, input }) => checkRead(db(ctx).user.findMany(input as any))),

findUnique: procedure.input($Schema.UserInputSchema.findUnique).query(({ ctx, input }) => checkRead(db(ctx).user.findUnique(input as any))),

Expand All @@ -39,7 +39,7 @@ export default function createRouter<Config extends BaseConfig>(router: RouterFa

upsert: procedure.input($Schema.UserInputSchema.upsert).mutation(async ({ ctx, input }) => checkMutate(db(ctx).user.upsert(input as any))),

count: procedure.input($Schema.UserInputSchema.count).query(({ ctx, input }) => checkRead(db(ctx).user.count(input as any))),
count: procedure.input($Schema.UserInputSchema.count.optional()).query(({ ctx, input }) => checkRead(db(ctx).user.count(input as any))),

}
);
Expand Down Expand Up @@ -123,14 +123,14 @@ export interface ClientType<AppRouter extends AnyRouter, Context = AppRouter['_d
findFirst: {

useQuery: <T extends Prisma.UserFindFirstArgs, TData = Prisma.UserGetPayload<T>>(
input: Prisma.SelectSubset<T, Prisma.UserFindFirstArgs>,
input?: Prisma.SelectSubset<T, Prisma.UserFindFirstArgs>,
opts?: UseTRPCQueryOptions<string, T, Prisma.UserGetPayload<T>, TData, Error>
) => UseTRPCQueryResult<
TData,
TRPCClientErrorLike<AppRouter>
>;
useInfiniteQuery: <T extends Prisma.UserFindFirstArgs>(
input: Omit<Prisma.SelectSubset<T, Prisma.UserFindFirstArgs>, 'cursor'>,
input?: Omit<Prisma.SelectSubset<T, Prisma.UserFindFirstArgs>, 'cursor'>,
opts?: UseTRPCInfiniteQueryOptions<string, T, Prisma.UserGetPayload<T>, Error>
) => UseTRPCInfiniteQueryResult<
Prisma.UserGetPayload<T>,
Expand All @@ -141,14 +141,14 @@ export interface ClientType<AppRouter extends AnyRouter, Context = AppRouter['_d
findFirstOrThrow: {

useQuery: <T extends Prisma.UserFindFirstOrThrowArgs, TData = Prisma.UserGetPayload<T>>(
input: Prisma.SelectSubset<T, Prisma.UserFindFirstOrThrowArgs>,
input?: Prisma.SelectSubset<T, Prisma.UserFindFirstOrThrowArgs>,
opts?: UseTRPCQueryOptions<string, T, Prisma.UserGetPayload<T>, TData, Error>
) => UseTRPCQueryResult<
TData,
TRPCClientErrorLike<AppRouter>
>;
useInfiniteQuery: <T extends Prisma.UserFindFirstOrThrowArgs>(
input: Omit<Prisma.SelectSubset<T, Prisma.UserFindFirstOrThrowArgs>, 'cursor'>,
input?: Omit<Prisma.SelectSubset<T, Prisma.UserFindFirstOrThrowArgs>, 'cursor'>,
opts?: UseTRPCInfiniteQueryOptions<string, T, Prisma.UserGetPayload<T>, Error>
) => UseTRPCInfiniteQueryResult<
Prisma.UserGetPayload<T>,
Expand All @@ -159,14 +159,14 @@ export interface ClientType<AppRouter extends AnyRouter, Context = AppRouter['_d
findMany: {

useQuery: <T extends Prisma.UserFindManyArgs, TData = Array<Prisma.UserGetPayload<T>>>(
input: Prisma.SelectSubset<T, Prisma.UserFindManyArgs>,
input?: Prisma.SelectSubset<T, Prisma.UserFindManyArgs>,
opts?: UseTRPCQueryOptions<string, T, Array<Prisma.UserGetPayload<T>>, TData, Error>
) => UseTRPCQueryResult<
TData,
TRPCClientErrorLike<AppRouter>
>;
useInfiniteQuery: <T extends Prisma.UserFindManyArgs>(
input: Omit<Prisma.SelectSubset<T, Prisma.UserFindManyArgs>, 'cursor'>,
input?: Omit<Prisma.SelectSubset<T, Prisma.UserFindManyArgs>, 'cursor'>,
opts?: UseTRPCInfiniteQueryOptions<string, T, Array<Prisma.UserGetPayload<T>>, Error>
) => UseTRPCInfiniteQueryResult<
Array<Prisma.UserGetPayload<T>>,
Expand Down Expand Up @@ -389,7 +389,7 @@ export interface ClientType<AppRouter extends AnyRouter, Context = AppRouter['_d
? number
: Prisma.GetScalarType<T['select'], Prisma.UserCountAggregateOutputType>
: number>(
input: Prisma.Subset<T, Prisma.UserCountArgs>,
input?: Prisma.Subset<T, Prisma.UserCountArgs>,
opts?: UseTRPCQueryOptions<string, T, 'select' extends keyof T
? T['select'] extends true
? number
Expand All @@ -400,7 +400,7 @@ export interface ClientType<AppRouter extends AnyRouter, Context = AppRouter['_d
TRPCClientErrorLike<AppRouter>
>;
useInfiniteQuery: <T extends Prisma.UserCountArgs>(
input: Omit<Prisma.Subset<T, Prisma.UserCountArgs>, 'cursor'>,
input?: Omit<Prisma.Subset<T, Prisma.UserCountArgs>, 'cursor'>,
opts?: UseTRPCInfiniteQueryOptions<string, T, 'select' extends keyof T
? T['select'] extends true
? number
Expand Down
Loading