Skip to content

Commit 23c87eb

Browse files
ymc9ymc9
authored
fix(trpc): make input arg's optionality consistent with Prisma (#1730)
1 parent b8d8902 commit 23c87eb

File tree

5 files changed

+89
-85
lines changed

5 files changed

+89
-85
lines changed

‎packages/plugins/trpc/src/helpers.ts‎

Lines changed: 17 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,9 @@ function getPrismaOperationTypes(model: string, operation: string) {
4848

4949
let argsType: string;
5050
let resultType: string;
51+
const argsOptional = ['findMany', 'findFirst', 'findFirstOrThrow', 'createMany', 'deleteMany', 'count'].includes(
52+
operation
53+
);
5154

5255
switch (operation) {
5356
case 'findUnique':
@@ -178,7 +181,7 @@ function getPrismaOperationTypes(model: string, operation: string) {
178181
throw new PluginError(name, `Unsupported operation: "${operation}"`);
179182
}
180183

181-
return { genericBase, argsType, resultType };
184+
return { genericBase, argsType, resultType, argsOptional };
182185
}
183186

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

198202
writer.block(() => {
199203
if (procType === 'query') {
200204
if (version === 'v10') {
201205
writer.writeLine(`
202206
useQuery: <T extends ${genericBase}, TData = ${resultType}>(
203-
input: ${argsType},
207+
input${inputOptional}: ${argsType},
204208
opts?: UseTRPCQueryOptions<string, T, ${resultType}, TData, Error>
205209
) => UseTRPCQueryResult<
206210
TData,
207211
${errorType}
208212
>;
209213
useInfiniteQuery: <T extends ${genericBase}>(
210-
input: Omit<${argsType}, 'cursor'>,
214+
input${inputOptional}: Omit<${argsType}, 'cursor'>,
211215
opts?: UseTRPCInfiniteQueryOptions<string, T, ${resultType}, Error>
212216
) => UseTRPCInfiniteQueryResult<
213217
${resultType},
@@ -217,26 +221,26 @@ export function generateRouterTyping(
217221
} else {
218222
writer.writeLine(`
219223
useQuery: <T extends ${genericBase}, TData = ${resultType}>(
220-
input: ${argsType},
224+
input${inputOptional}: ${argsType},
221225
opts?: UseTRPCQueryOptions<${resultType}, TData, Error>
222226
) => UseTRPCQueryResult<
223227
TData,
224228
${errorType}
225229
>;
226230
useInfiniteQuery: <T extends ${genericBase}>(
227-
input: Omit<${argsType}, 'cursor'>,
231+
input${inputOptional}: Omit<${argsType}, 'cursor'>,
228232
opts?: UseTRPCInfiniteQueryOptions<T, ${resultType}, Error>
229233
) => UseTRPCInfiniteQueryResult<
230234
${resultType},
231235
${errorType},
232236
T
233237
>;
234238
useSuspenseQuery: <T extends ${genericBase}, TData = ${resultType}>(
235-
input: ${argsType},
239+
input${inputOptional}: ${argsType},
236240
opts?: UseTRPCSuspenseQueryOptions<${resultType}, TData, Error>
237241
) => UseTRPCSuspenseQueryResult<TData, ${errorType}>;
238242
useSuspenseInfiniteQuery: <T extends ${genericBase}>(
239-
input: Omit<${argsType}, 'cursor'>,
243+
input${inputOptional}: Omit<${argsType}, 'cursor'>,
240244
opts?: UseTRPCSuspenseInfiniteQueryOptions<T, ${resultType}, Error>
241245
) => UseTRPCSuspenseInfiniteQueryResult<${resultType}, ${errorType}, T>;
242246
`);
@@ -298,10 +302,10 @@ export const getInputSchemaByOpName = (opName: string, modelName: string) => {
298302
inputType = `$Schema.${capModelName}InputSchema.findUnique`;
299303
break;
300304
case 'findFirst':
301-
inputType = `$Schema.${capModelName}InputSchema.findFirst`;
305+
inputType = `$Schema.${capModelName}InputSchema.findFirst.optional()`;
302306
break;
303307
case 'findMany':
304-
inputType = `$Schema.${capModelName}InputSchema.findMany`;
308+
inputType = `$Schema.${capModelName}InputSchema.findMany.optional()`;
305309
break;
306310
case 'findRaw':
307311
inputType = `$Schema.${capModelName}InputSchema.findRawObject`;
@@ -310,7 +314,7 @@ export const getInputSchemaByOpName = (opName: string, modelName: string) => {
310314
inputType = `$Schema.${capModelName}InputSchema.create`;
311315
break;
312316
case 'createMany':
313-
inputType = `$Schema.${capModelName}InputSchema.createMany`;
317+
inputType = `$Schema.${capModelName}InputSchema.createMany.optional()`;
314318
break;
315319
case 'deleteOne':
316320
inputType = `$Schema.${capModelName}InputSchema.delete`;
@@ -319,7 +323,7 @@ export const getInputSchemaByOpName = (opName: string, modelName: string) => {
319323
inputType = `$Schema.${capModelName}InputSchema.update`;
320324
break;
321325
case 'deleteMany':
322-
inputType = `$Schema.${capModelName}InputSchema.deleteMany`;
326+
inputType = `$Schema.${capModelName}InputSchema.deleteMany.optional()`;
323327
break;
324328
case 'updateMany':
325329
inputType = `$Schema.${capModelName}InputSchema.updateMany`;
@@ -337,7 +341,7 @@ export const getInputSchemaByOpName = (opName: string, modelName: string) => {
337341
inputType = `$Schema.${capModelName}InputSchema.groupBy`;
338342
break;
339343
case 'count':
340-
inputType = `$Schema.${capModelName}InputSchema.count`;
344+
inputType = `$Schema.${capModelName}InputSchema.count.optional()`;
341345
break;
342346
default:
343347
break;

‎packages/plugins/trpc/tests/projects/t3-trpc-v10/src/server/api/routers/generated/routers/Post.router.ts‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,19 @@ export default function createRouter<Config extends BaseConfig>(router: RouterFa
1313

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

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

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

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

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

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

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

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

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

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

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

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

4444
}
4545
);
@@ -123,14 +123,14 @@ export interface ClientType<AppRouter extends AnyRouter, Context = AppRouter['_d
123123
findFirst: {
124124

125125
useQuery: <T extends Prisma.PostFindFirstArgs, TData = Prisma.PostGetPayload<T>>(
126-
input: Prisma.SelectSubset<T, Prisma.PostFindFirstArgs>,
126+
input?: Prisma.SelectSubset<T, Prisma.PostFindFirstArgs>,
127127
opts?: UseTRPCQueryOptions<string, T, Prisma.PostGetPayload<T>, TData, Error>
128128
) => UseTRPCQueryResult<
129129
TData,
130130
TRPCClientErrorLike<AppRouter>
131131
>;
132132
useInfiniteQuery: <T extends Prisma.PostFindFirstArgs>(
133-
input: Omit<Prisma.SelectSubset<T, Prisma.PostFindFirstArgs>, 'cursor'>,
133+
input?: Omit<Prisma.SelectSubset<T, Prisma.PostFindFirstArgs>, 'cursor'>,
134134
opts?: UseTRPCInfiniteQueryOptions<string, T, Prisma.PostGetPayload<T>, Error>
135135
) => UseTRPCInfiniteQueryResult<
136136
Prisma.PostGetPayload<T>,
@@ -141,14 +141,14 @@ export interface ClientType<AppRouter extends AnyRouter, Context = AppRouter['_d
141141
findFirstOrThrow: {
142142

143143
useQuery: <T extends Prisma.PostFindFirstOrThrowArgs, TData = Prisma.PostGetPayload<T>>(
144-
input: Prisma.SelectSubset<T, Prisma.PostFindFirstOrThrowArgs>,
144+
input?: Prisma.SelectSubset<T, Prisma.PostFindFirstOrThrowArgs>,
145145
opts?: UseTRPCQueryOptions<string, T, Prisma.PostGetPayload<T>, TData, Error>
146146
) => UseTRPCQueryResult<
147147
TData,
148148
TRPCClientErrorLike<AppRouter>
149149
>;
150150
useInfiniteQuery: <T extends Prisma.PostFindFirstOrThrowArgs>(
151-
input: Omit<Prisma.SelectSubset<T, Prisma.PostFindFirstOrThrowArgs>, 'cursor'>,
151+
input?: Omit<Prisma.SelectSubset<T, Prisma.PostFindFirstOrThrowArgs>, 'cursor'>,
152152
opts?: UseTRPCInfiniteQueryOptions<string, T, Prisma.PostGetPayload<T>, Error>
153153
) => UseTRPCInfiniteQueryResult<
154154
Prisma.PostGetPayload<T>,
@@ -159,14 +159,14 @@ export interface ClientType<AppRouter extends AnyRouter, Context = AppRouter['_d
159159
findMany: {
160160

161161
useQuery: <T extends Prisma.PostFindManyArgs, TData = Array<Prisma.PostGetPayload<T>>>(
162-
input: Prisma.SelectSubset<T, Prisma.PostFindManyArgs>,
162+
input?: Prisma.SelectSubset<T, Prisma.PostFindManyArgs>,
163163
opts?: UseTRPCQueryOptions<string, T, Array<Prisma.PostGetPayload<T>>, TData, Error>
164164
) => UseTRPCQueryResult<
165165
TData,
166166
TRPCClientErrorLike<AppRouter>
167167
>;
168168
useInfiniteQuery: <T extends Prisma.PostFindManyArgs>(
169-
input: Omit<Prisma.SelectSubset<T, Prisma.PostFindManyArgs>, 'cursor'>,
169+
input?: Omit<Prisma.SelectSubset<T, Prisma.PostFindManyArgs>, 'cursor'>,
170170
opts?: UseTRPCInfiniteQueryOptions<string, T, Array<Prisma.PostGetPayload<T>>, Error>
171171
) => UseTRPCInfiniteQueryResult<
172172
Array<Prisma.PostGetPayload<T>>,
@@ -389,7 +389,7 @@ export interface ClientType<AppRouter extends AnyRouter, Context = AppRouter['_d
389389
? number
390390
: Prisma.GetScalarType<T['select'], Prisma.PostCountAggregateOutputType>
391391
: number>(
392-
input: Prisma.Subset<T, Prisma.PostCountArgs>,
392+
input?: Prisma.Subset<T, Prisma.PostCountArgs>,
393393
opts?: UseTRPCQueryOptions<string, T, 'select' extends keyof T
394394
? T['select'] extends true
395395
? number
@@ -400,7 +400,7 @@ export interface ClientType<AppRouter extends AnyRouter, Context = AppRouter['_d
400400
TRPCClientErrorLike<AppRouter>
401401
>;
402402
useInfiniteQuery: <T extends Prisma.PostCountArgs>(
403-
input: Omit<Prisma.Subset<T, Prisma.PostCountArgs>, 'cursor'>,
403+
input?: Omit<Prisma.Subset<T, Prisma.PostCountArgs>, 'cursor'>,
404404
opts?: UseTRPCInfiniteQueryOptions<string, T, 'select' extends keyof T
405405
? T['select'] extends true
406406
? number

‎packages/plugins/trpc/tests/projects/t3-trpc-v10/src/server/api/routers/generated/routers/User.router.ts‎

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,19 +13,19 @@ export default function createRouter<Config extends BaseConfig>(router: RouterFa
1313

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

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

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

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

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

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

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

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

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

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

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

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

4444
}
4545
);
@@ -123,14 +123,14 @@ export interface ClientType<AppRouter extends AnyRouter, Context = AppRouter['_d
123123
findFirst: {
124124

125125
useQuery: <T extends Prisma.UserFindFirstArgs, TData = Prisma.UserGetPayload<T>>(
126-
input: Prisma.SelectSubset<T, Prisma.UserFindFirstArgs>,
126+
input?: Prisma.SelectSubset<T, Prisma.UserFindFirstArgs>,
127127
opts?: UseTRPCQueryOptions<string, T, Prisma.UserGetPayload<T>, TData, Error>
128128
) => UseTRPCQueryResult<
129129
TData,
130130
TRPCClientErrorLike<AppRouter>
131131
>;
132132
useInfiniteQuery: <T extends Prisma.UserFindFirstArgs>(
133-
input: Omit<Prisma.SelectSubset<T, Prisma.UserFindFirstArgs>, 'cursor'>,
133+
input?: Omit<Prisma.SelectSubset<T, Prisma.UserFindFirstArgs>, 'cursor'>,
134134
opts?: UseTRPCInfiniteQueryOptions<string, T, Prisma.UserGetPayload<T>, Error>
135135
) => UseTRPCInfiniteQueryResult<
136136
Prisma.UserGetPayload<T>,
@@ -141,14 +141,14 @@ export interface ClientType<AppRouter extends AnyRouter, Context = AppRouter['_d
141141
findFirstOrThrow: {
142142

143143
useQuery: <T extends Prisma.UserFindFirstOrThrowArgs, TData = Prisma.UserGetPayload<T>>(
144-
input: Prisma.SelectSubset<T, Prisma.UserFindFirstOrThrowArgs>,
144+
input?: Prisma.SelectSubset<T, Prisma.UserFindFirstOrThrowArgs>,
145145
opts?: UseTRPCQueryOptions<string, T, Prisma.UserGetPayload<T>, TData, Error>
146146
) => UseTRPCQueryResult<
147147
TData,
148148
TRPCClientErrorLike<AppRouter>
149149
>;
150150
useInfiniteQuery: <T extends Prisma.UserFindFirstOrThrowArgs>(
151-
input: Omit<Prisma.SelectSubset<T, Prisma.UserFindFirstOrThrowArgs>, 'cursor'>,
151+
input?: Omit<Prisma.SelectSubset<T, Prisma.UserFindFirstOrThrowArgs>, 'cursor'>,
152152
opts?: UseTRPCInfiniteQueryOptions<string, T, Prisma.UserGetPayload<T>, Error>
153153
) => UseTRPCInfiniteQueryResult<
154154
Prisma.UserGetPayload<T>,
@@ -159,14 +159,14 @@ export interface ClientType<AppRouter extends AnyRouter, Context = AppRouter['_d
159159
findMany: {
160160

161161
useQuery: <T extends Prisma.UserFindManyArgs, TData = Array<Prisma.UserGetPayload<T>>>(
162-
input: Prisma.SelectSubset<T, Prisma.UserFindManyArgs>,
162+
input?: Prisma.SelectSubset<T, Prisma.UserFindManyArgs>,
163163
opts?: UseTRPCQueryOptions<string, T, Array<Prisma.UserGetPayload<T>>, TData, Error>
164164
) => UseTRPCQueryResult<
165165
TData,
166166
TRPCClientErrorLike<AppRouter>
167167
>;
168168
useInfiniteQuery: <T extends Prisma.UserFindManyArgs>(
169-
input: Omit<Prisma.SelectSubset<T, Prisma.UserFindManyArgs>, 'cursor'>,
169+
input?: Omit<Prisma.SelectSubset<T, Prisma.UserFindManyArgs>, 'cursor'>,
170170
opts?: UseTRPCInfiniteQueryOptions<string, T, Array<Prisma.UserGetPayload<T>>, Error>
171171
) => UseTRPCInfiniteQueryResult<
172172
Array<Prisma.UserGetPayload<T>>,
@@ -389,7 +389,7 @@ export interface ClientType<AppRouter extends AnyRouter, Context = AppRouter['_d
389389
? number
390390
: Prisma.GetScalarType<T['select'], Prisma.UserCountAggregateOutputType>
391391
: number>(
392-
input: Prisma.Subset<T, Prisma.UserCountArgs>,
392+
input?: Prisma.Subset<T, Prisma.UserCountArgs>,
393393
opts?: UseTRPCQueryOptions<string, T, 'select' extends keyof T
394394
? T['select'] extends true
395395
? number
@@ -400,7 +400,7 @@ export interface ClientType<AppRouter extends AnyRouter, Context = AppRouter['_d
400400
TRPCClientErrorLike<AppRouter>
401401
>;
402402
useInfiniteQuery: <T extends Prisma.UserCountArgs>(
403-
input: Omit<Prisma.Subset<T, Prisma.UserCountArgs>, 'cursor'>,
403+
input?: Omit<Prisma.Subset<T, Prisma.UserCountArgs>, 'cursor'>,
404404
opts?: UseTRPCInfiniteQueryOptions<string, T, 'select' extends keyof T
405405
? T['select'] extends true
406406
? number

0 commit comments

Comments
 (0)