forked from jlalmes/trpc-openapi
-
Notifications
You must be signed in to change notification settings - Fork 0
/
types.ts
114 lines (103 loc) 路 2.41 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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
import type {
Procedure,
ProcedureParams,
Router,
RootConfig,
AnyRootConfig,
ProcedureRouterRecord,
} from '@trpc/server';
import type { TRPC_ERROR_CODE_KEY } from '@trpc/server/rpc';
import { OpenAPIV3 } from 'openapi-types';
import type { ZodIssue } from 'zod';
// from @trpc/server/core/router
export interface RouterDef<
TConfig extends AnyRootConfig,
TRecord extends ProcedureRouterRecord,
/**
* @deprecated
*/
TOld = any,
> {
_config: TConfig;
router: true;
procedures: TRecord;
record: TRecord;
/**
* V9 queries
* @deprecated
*/
queries: any;
/**
* V9 mutations
* @deprecated
*/
mutations: any;
/**
* V9 subscriptions
* @deprecated
*/
subscriptions: any;
}
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[];
headers?: (OpenAPIV3.ParameterBaseObject & { name: string; in?: 'header' })[];
contentTypes?: OpenApiContentType[];
deprecated?: boolean;
example?: {
request?: Record<string, any>;
response?: Record<string, any>;
};
responseHeaders?: Record<string, OpenAPIV3.HeaderObject | OpenAPIV3.ReferenceObject>;
};
};
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;