forked from kdy1/trpc-openapi
-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathtypes.ts
More file actions
90 lines (80 loc) 路 2.3 KB
/
Copy pathtypes.ts
File metadata and controls
90 lines (80 loc) 路 2.3 KB
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
import { AWSLambdaOptions } from '@trpc/server/adapters/aws-lambda';
import { TRPC_ERROR_CODE_KEY } from '@trpc/server/rpc';
import type {
AnyProcedure,
AnyRootTypes,
CreateRootTypes,
ProcedureBuilder,
Router,
RouterRecord,
} from '@trpc/server/unstable-core-do-not-import';
import type { APIGatewayProxyEvent, APIGatewayProxyEventV2 } from 'aws-lambda';
import { OpenAPIV3 } from 'openapi-types';
export type CreateOpenApiAwsLambdaHandlerOptions<
TRouter extends OpenApiRouter,
TEvent extends APIGatewayProxyEvent | APIGatewayProxyEventV2,
> = Pick<
AWSLambdaOptions<TRouter, TEvent>,
'router' | 'createContext' | 'responseMeta' | 'onError'
>;
export type OpenApiMethod = 'GET' | 'POST' | 'PATCH' | 'PUT' | 'DELETE';
type TRPCMeta = Record<string, unknown>;
export type OpenApiContentType =
| 'application/json'
| 'application/x-www-form-urlencoded'
| (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?: unknown;
response?: unknown;
};
responseHeaders?: Record<string, OpenAPIV3.HeaderObject | OpenAPIV3.ReferenceObject>;
};
};
export type OpenApiProcedure<TMeta = TRPCMeta> = ProcedureBuilder<
any,
TMeta,
any,
any,
any,
any,
any,
any
>;
export type OpenApiProcedureRecord<TMeta = TRPCMeta> = {
[key: string]: AnyProcedure | RouterRecord;
};
export type OpenApiRouter<
TMeta = TRPCMeta,
TRoot extends AnyRootTypes = CreateRootTypes<{
ctx: any;
meta: OpenApiMeta<TMeta>;
errorShape: any;
transformer: any;
}>,
TDef extends RouterRecord = OpenApiProcedureRecord<TMeta>,
> = Router<TRoot, TDef>;
export type OpenApiSuccessResponse<D = any> = D;
export type OpenApiValidationIssue = {
code: string;
message: string;
path: PropertyKey[];
[key: string]: unknown;
};
export type OpenApiErrorResponse = {
message: string;
code: TRPC_ERROR_CODE_KEY;
issues?: OpenApiValidationIssue[];
};
export type OpenApiResponse<D = any> = OpenApiSuccessResponse<D> | OpenApiErrorResponse;