forked from LilyRose2798/trpc-openapi
-
Notifications
You must be signed in to change notification settings - Fork 0
/
types.ts
85 lines (75 loc) · 1.97 KB
/
types.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
import { Procedure, ProcedureParams, Router } from '@trpc/server';
import type { RootConfig } from '@trpc/server/dist/core/internals/config';
import type { RouterDef } from '@trpc/server/dist/core/router';
import { TRPC_ERROR_CODE_KEY } from '@trpc/server/dist/rpc';
import {
AnyZodObject,
ZodBigInt,
ZodDate,
ZodEffects,
ZodIssue,
ZodNumber,
ZodString,
ZodTypeAny,
} from 'zod';
export type OpenApiMethod = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
type TRPCMeta = Record<string, unknown>;
export type OpenApiContentType =
| 'application/json'
| 'application/x-www-form-urlencoded'
// eslint-disable-next-line @typescript-eslint/ban-types
| (string & {});
export type OpenApiMeta<TMeta = TRPCMeta> = TMeta & {
openapi?: {
enabled?: boolean;
method: OpenApiMethod;
path: `/${string}`;
summary?: string;
description?: string;
protect?: boolean;
tags?: string[];
contentTypes?: OpenApiContentType[];
deprecated?: boolean;
requestHeaders?: AnyZodObject;
responseHeaders?: AnyZodObject;
successDescription?: string;
errorResponses?: number[] | { [key: number]: string };
};
};
export type OpenApiProcedure<TMeta = TRPCMeta> = Procedure<
'query' | 'mutation',
ProcedureParams<
RootConfig<{
transformer: any;
errorShape: any;
ctx: any;
meta: OpenApiMeta<TMeta>;
}>,
any,
any,
any,
any,
any,
OpenApiMeta<TMeta>
>
>;
export type OpenApiProcedureRecord<TMeta = TRPCMeta> = Record<string, OpenApiProcedure<TMeta>>;
export type OpenApiRouter<TMeta = TRPCMeta> = Router<
RouterDef<
RootConfig<{
transformer: any;
errorShape: any;
ctx: any;
meta: OpenApiMeta<TMeta>;
}>,
any,
any
>
>;
export type OpenApiSuccessResponse<D = any> = D;
export type OpenApiErrorResponse = {
message: string;
code: TRPC_ERROR_CODE_KEY;
issues?: ZodIssue[];
};
export type OpenApiResponse<D = any> = OpenApiSuccessResponse<D> | OpenApiErrorResponse;