forked from LilyRose2798/trpc-openapi
-
Notifications
You must be signed in to change notification settings - Fork 14
/
Copy pathtypes.ts
69 lines (58 loc) · 1.72 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
import { TRPC_ERROR_CODE_KEY } from '@trpc/server/rpc';
import type {
CreateRootTypes,
Procedure,
ProcedureType,
Router,
RouterRecord,
} from '@trpc/server/unstable-core-do-not-import';
import type { AnyZodObject, ZodIssue } from 'zod';
export { type OpenAPIObject, type SecuritySchemeObject } from 'openapi3-ts/oas31';
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[] | Record<number, string>;
};
};
export type OpenApiProcedure = Procedure<
ProcedureType,
{
input: any; // AnyZodObject[] | Parser[] | undefined;
output: any; // Parser | undefined;
}
>;
export type OpenApiProcedureRecord = Record<string, OpenApiProcedure | RouterRecord>;
export type OpenApiRouter = Router<
CreateRootTypes<{
ctx: any;
meta: TRPCMeta;
errorShape: any;
transformer: any;
}>,
RouterRecord
>;
export type OpenApiSuccessResponse<D = any> = D;
export interface OpenApiErrorResponse {
message: string;
code: TRPC_ERROR_CODE_KEY;
issues?: ZodIssue[];
}
export type OpenApiResponse<D = any> = OpenApiSuccessResponse<D> | OpenApiErrorResponse;