@riktajs/swagger 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +258 -0
- package/dist/constants.d.ts +56 -0
- package/dist/constants.d.ts.map +1 -0
- package/dist/constants.js +61 -0
- package/dist/constants.js.map +1 -0
- package/dist/decorators/api-body.decorator.d.ts +33 -0
- package/dist/decorators/api-body.decorator.d.ts.map +1 -0
- package/dist/decorators/api-body.decorator.js +40 -0
- package/dist/decorators/api-body.decorator.js.map +1 -0
- package/dist/decorators/api-exclude.decorator.d.ts +71 -0
- package/dist/decorators/api-exclude.decorator.d.ts.map +1 -0
- package/dist/decorators/api-exclude.decorator.js +95 -0
- package/dist/decorators/api-exclude.decorator.js.map +1 -0
- package/dist/decorators/api-header.decorator.d.ts +25 -0
- package/dist/decorators/api-header.decorator.d.ts.map +1 -0
- package/dist/decorators/api-header.decorator.js +33 -0
- package/dist/decorators/api-header.decorator.js.map +1 -0
- package/dist/decorators/api-operation.decorator.d.ts +32 -0
- package/dist/decorators/api-operation.decorator.d.ts.map +1 -0
- package/dist/decorators/api-operation.decorator.js +39 -0
- package/dist/decorators/api-operation.decorator.js.map +1 -0
- package/dist/decorators/api-param.decorator.d.ts +28 -0
- package/dist/decorators/api-param.decorator.d.ts.map +1 -0
- package/dist/decorators/api-param.decorator.js +36 -0
- package/dist/decorators/api-param.decorator.js.map +1 -0
- package/dist/decorators/api-property.decorator.d.ts +69 -0
- package/dist/decorators/api-property.decorator.d.ts.map +1 -0
- package/dist/decorators/api-property.decorator.js +76 -0
- package/dist/decorators/api-property.decorator.js.map +1 -0
- package/dist/decorators/api-query.decorator.d.ts +30 -0
- package/dist/decorators/api-query.decorator.d.ts.map +1 -0
- package/dist/decorators/api-query.decorator.js +38 -0
- package/dist/decorators/api-query.decorator.js.map +1 -0
- package/dist/decorators/api-response.decorator.d.ts +70 -0
- package/dist/decorators/api-response.decorator.d.ts.map +1 -0
- package/dist/decorators/api-response.decorator.js +100 -0
- package/dist/decorators/api-response.decorator.js.map +1 -0
- package/dist/decorators/api-security.decorator.d.ts +88 -0
- package/dist/decorators/api-security.decorator.d.ts.map +1 -0
- package/dist/decorators/api-security.decorator.js +119 -0
- package/dist/decorators/api-security.decorator.js.map +1 -0
- package/dist/decorators/api-tags.decorator.d.ts +31 -0
- package/dist/decorators/api-tags.decorator.d.ts.map +1 -0
- package/dist/decorators/api-tags.decorator.js +52 -0
- package/dist/decorators/api-tags.decorator.js.map +1 -0
- package/dist/decorators/index.d.ts +16 -0
- package/dist/decorators/index.d.ts.map +1 -0
- package/dist/decorators/index.js +24 -0
- package/dist/decorators/index.js.map +1 -0
- package/dist/index.d.ts +62 -0
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +68 -0
- package/dist/index.js.map +1 -0
- package/dist/openapi/generator.d.ts +98 -0
- package/dist/openapi/generator.d.ts.map +1 -0
- package/dist/openapi/generator.js +493 -0
- package/dist/openapi/generator.js.map +1 -0
- package/dist/openapi/index.d.ts +8 -0
- package/dist/openapi/index.d.ts.map +1 -0
- package/dist/openapi/index.js +11 -0
- package/dist/openapi/index.js.map +1 -0
- package/dist/openapi/zod-to-openapi.d.ts +52 -0
- package/dist/openapi/zod-to-openapi.d.ts.map +1 -0
- package/dist/openapi/zod-to-openapi.js +172 -0
- package/dist/openapi/zod-to-openapi.js.map +1 -0
- package/dist/plugin/index.d.ts +7 -0
- package/dist/plugin/index.d.ts.map +1 -0
- package/dist/plugin/index.js +7 -0
- package/dist/plugin/index.js.map +1 -0
- package/dist/plugin/swagger.plugin.d.ts +157 -0
- package/dist/plugin/swagger.plugin.d.ts.map +1 -0
- package/dist/plugin/swagger.plugin.js +235 -0
- package/dist/plugin/swagger.plugin.js.map +1 -0
- package/dist/types.d.ts +511 -0
- package/dist/types.d.ts.map +1 -0
- package/dist/types.js +2 -0
- package/dist/types.js.map +1 -0
- package/package.json +61 -0
package/dist/types.d.ts
ADDED
|
@@ -0,0 +1,511 @@
|
|
|
1
|
+
import type { ZodType } from 'zod';
|
|
2
|
+
/**
|
|
3
|
+
* OpenAPI 3.0 data types
|
|
4
|
+
*/
|
|
5
|
+
export type OpenApiDataType = 'string' | 'number' | 'integer' | 'boolean' | 'array' | 'object';
|
|
6
|
+
/**
|
|
7
|
+
* OpenAPI 3.0 string formats
|
|
8
|
+
*/
|
|
9
|
+
export type OpenApiFormat = 'int32' | 'int64' | 'float' | 'double' | 'date' | 'date-time' | 'password' | 'byte' | 'binary' | 'email' | 'uuid' | 'uri' | 'hostname' | 'ipv4' | 'ipv6';
|
|
10
|
+
/**
|
|
11
|
+
* OpenAPI Schema Object (simplified)
|
|
12
|
+
*/
|
|
13
|
+
export interface OpenApiSchemaObject {
|
|
14
|
+
type?: OpenApiDataType;
|
|
15
|
+
format?: string;
|
|
16
|
+
description?: string;
|
|
17
|
+
default?: unknown;
|
|
18
|
+
example?: unknown;
|
|
19
|
+
enum?: unknown[];
|
|
20
|
+
items?: OpenApiSchemaObject;
|
|
21
|
+
properties?: Record<string, OpenApiSchemaObject>;
|
|
22
|
+
required?: string[];
|
|
23
|
+
nullable?: boolean;
|
|
24
|
+
allOf?: OpenApiSchemaObject[];
|
|
25
|
+
oneOf?: OpenApiSchemaObject[];
|
|
26
|
+
anyOf?: OpenApiSchemaObject[];
|
|
27
|
+
not?: OpenApiSchemaObject;
|
|
28
|
+
$ref?: string;
|
|
29
|
+
minimum?: number;
|
|
30
|
+
maximum?: number;
|
|
31
|
+
minLength?: number;
|
|
32
|
+
maxLength?: number;
|
|
33
|
+
pattern?: string;
|
|
34
|
+
additionalProperties?: boolean | OpenApiSchemaObject;
|
|
35
|
+
}
|
|
36
|
+
/**
|
|
37
|
+
* OpenAPI Parameter Location
|
|
38
|
+
*/
|
|
39
|
+
export type ParameterLocation = 'query' | 'path' | 'header' | 'cookie';
|
|
40
|
+
/**
|
|
41
|
+
* OpenAPI Parameter Object
|
|
42
|
+
*/
|
|
43
|
+
export interface OpenApiParameterObject {
|
|
44
|
+
name: string;
|
|
45
|
+
in: ParameterLocation;
|
|
46
|
+
description?: string;
|
|
47
|
+
required?: boolean;
|
|
48
|
+
deprecated?: boolean;
|
|
49
|
+
schema?: OpenApiSchemaObject;
|
|
50
|
+
example?: unknown;
|
|
51
|
+
examples?: Record<string, {
|
|
52
|
+
value: unknown;
|
|
53
|
+
summary?: string;
|
|
54
|
+
}>;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* OpenAPI Request Body Object
|
|
58
|
+
*/
|
|
59
|
+
export interface OpenApiRequestBodyObject {
|
|
60
|
+
description?: string;
|
|
61
|
+
required?: boolean;
|
|
62
|
+
content: Record<string, {
|
|
63
|
+
schema?: OpenApiSchemaObject;
|
|
64
|
+
example?: unknown;
|
|
65
|
+
examples?: Record<string, {
|
|
66
|
+
value: unknown;
|
|
67
|
+
summary?: string;
|
|
68
|
+
}>;
|
|
69
|
+
}>;
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* OpenAPI Response Object
|
|
73
|
+
*/
|
|
74
|
+
export interface OpenApiResponseObject {
|
|
75
|
+
description: string;
|
|
76
|
+
content?: Record<string, {
|
|
77
|
+
schema?: OpenApiSchemaObject;
|
|
78
|
+
example?: unknown;
|
|
79
|
+
}>;
|
|
80
|
+
headers?: Record<string, {
|
|
81
|
+
description?: string;
|
|
82
|
+
schema?: OpenApiSchemaObject;
|
|
83
|
+
}>;
|
|
84
|
+
}
|
|
85
|
+
/**
|
|
86
|
+
* OpenAPI Security Requirement Object
|
|
87
|
+
*/
|
|
88
|
+
export type OpenApiSecurityRequirement = Record<string, string[]>;
|
|
89
|
+
/**
|
|
90
|
+
* OpenAPI Security Scheme Object
|
|
91
|
+
*/
|
|
92
|
+
export interface OpenApiSecurityScheme {
|
|
93
|
+
type: 'apiKey' | 'http' | 'oauth2' | 'openIdConnect';
|
|
94
|
+
description?: string;
|
|
95
|
+
name?: string;
|
|
96
|
+
in?: 'query' | 'header' | 'cookie';
|
|
97
|
+
scheme?: string;
|
|
98
|
+
bearerFormat?: string;
|
|
99
|
+
flows?: {
|
|
100
|
+
implicit?: {
|
|
101
|
+
authorizationUrl: string;
|
|
102
|
+
scopes: Record<string, string>;
|
|
103
|
+
};
|
|
104
|
+
password?: {
|
|
105
|
+
tokenUrl: string;
|
|
106
|
+
scopes: Record<string, string>;
|
|
107
|
+
};
|
|
108
|
+
clientCredentials?: {
|
|
109
|
+
tokenUrl: string;
|
|
110
|
+
scopes: Record<string, string>;
|
|
111
|
+
};
|
|
112
|
+
authorizationCode?: {
|
|
113
|
+
authorizationUrl: string;
|
|
114
|
+
tokenUrl: string;
|
|
115
|
+
scopes: Record<string, string>;
|
|
116
|
+
};
|
|
117
|
+
};
|
|
118
|
+
openIdConnectUrl?: string;
|
|
119
|
+
}
|
|
120
|
+
/**
|
|
121
|
+
* OpenAPI Operation Object
|
|
122
|
+
*/
|
|
123
|
+
export interface OpenApiOperation {
|
|
124
|
+
tags?: string[];
|
|
125
|
+
summary?: string;
|
|
126
|
+
description?: string;
|
|
127
|
+
externalDocs?: {
|
|
128
|
+
url: string;
|
|
129
|
+
description?: string;
|
|
130
|
+
};
|
|
131
|
+
operationId?: string;
|
|
132
|
+
parameters?: Array<{
|
|
133
|
+
name: string;
|
|
134
|
+
in: 'path' | 'query' | 'header' | 'cookie';
|
|
135
|
+
description?: string;
|
|
136
|
+
required?: boolean;
|
|
137
|
+
deprecated?: boolean;
|
|
138
|
+
schema?: OpenApiSchemaObject;
|
|
139
|
+
example?: unknown;
|
|
140
|
+
}>;
|
|
141
|
+
requestBody?: {
|
|
142
|
+
description?: string;
|
|
143
|
+
required?: boolean;
|
|
144
|
+
content: Record<string, {
|
|
145
|
+
schema?: OpenApiSchemaObject;
|
|
146
|
+
example?: unknown;
|
|
147
|
+
}>;
|
|
148
|
+
};
|
|
149
|
+
responses: Record<string, {
|
|
150
|
+
description: string;
|
|
151
|
+
headers?: Record<string, {
|
|
152
|
+
description?: string;
|
|
153
|
+
schema?: OpenApiSchemaObject;
|
|
154
|
+
}>;
|
|
155
|
+
content?: Record<string, {
|
|
156
|
+
schema?: OpenApiSchemaObject;
|
|
157
|
+
example?: unknown;
|
|
158
|
+
}>;
|
|
159
|
+
}>;
|
|
160
|
+
deprecated?: boolean;
|
|
161
|
+
security?: Array<Record<string, string[]>>;
|
|
162
|
+
}
|
|
163
|
+
/**
|
|
164
|
+
* OpenAPI Path Item Object
|
|
165
|
+
*/
|
|
166
|
+
export interface OpenApiPathItem {
|
|
167
|
+
get?: OpenApiOperation;
|
|
168
|
+
put?: OpenApiOperation;
|
|
169
|
+
post?: OpenApiOperation;
|
|
170
|
+
delete?: OpenApiOperation;
|
|
171
|
+
options?: OpenApiOperation;
|
|
172
|
+
head?: OpenApiOperation;
|
|
173
|
+
patch?: OpenApiOperation;
|
|
174
|
+
trace?: OpenApiOperation;
|
|
175
|
+
summary?: string;
|
|
176
|
+
description?: string;
|
|
177
|
+
parameters?: Array<{
|
|
178
|
+
name: string;
|
|
179
|
+
in: 'path' | 'query' | 'header' | 'cookie';
|
|
180
|
+
required?: boolean;
|
|
181
|
+
schema?: OpenApiSchemaObject;
|
|
182
|
+
}>;
|
|
183
|
+
}
|
|
184
|
+
/**
|
|
185
|
+
* OpenAPI Info Object
|
|
186
|
+
*/
|
|
187
|
+
export interface OpenApiInfoObject {
|
|
188
|
+
title: string;
|
|
189
|
+
version: string;
|
|
190
|
+
description?: string;
|
|
191
|
+
termsOfService?: string;
|
|
192
|
+
contact?: {
|
|
193
|
+
name?: string;
|
|
194
|
+
url?: string;
|
|
195
|
+
email?: string;
|
|
196
|
+
};
|
|
197
|
+
license?: {
|
|
198
|
+
name: string;
|
|
199
|
+
url?: string;
|
|
200
|
+
identifier?: string;
|
|
201
|
+
};
|
|
202
|
+
}
|
|
203
|
+
/**
|
|
204
|
+
* OpenAPI Document (root object)
|
|
205
|
+
*/
|
|
206
|
+
export interface OpenApiDocument {
|
|
207
|
+
openapi: string;
|
|
208
|
+
info: OpenApiInfoObject;
|
|
209
|
+
paths: Record<string, OpenApiPathItem>;
|
|
210
|
+
servers?: Array<{
|
|
211
|
+
url: string;
|
|
212
|
+
description?: string;
|
|
213
|
+
variables?: Record<string, {
|
|
214
|
+
default: string;
|
|
215
|
+
description?: string;
|
|
216
|
+
enum?: string[];
|
|
217
|
+
}>;
|
|
218
|
+
}>;
|
|
219
|
+
components?: {
|
|
220
|
+
schemas?: Record<string, OpenApiSchemaObject>;
|
|
221
|
+
securitySchemes?: Record<string, OpenApiSecurityScheme | {
|
|
222
|
+
type: string;
|
|
223
|
+
description?: string;
|
|
224
|
+
name?: string;
|
|
225
|
+
in?: string;
|
|
226
|
+
scheme?: string;
|
|
227
|
+
bearerFormat?: string;
|
|
228
|
+
flows?: unknown;
|
|
229
|
+
}>;
|
|
230
|
+
responses?: Record<string, OpenApiResponseObject>;
|
|
231
|
+
parameters?: Record<string, OpenApiParameterObject>;
|
|
232
|
+
requestBodies?: Record<string, OpenApiRequestBodyObject>;
|
|
233
|
+
};
|
|
234
|
+
security?: Array<Record<string, string[]>>;
|
|
235
|
+
tags?: Array<{
|
|
236
|
+
name: string;
|
|
237
|
+
description?: string;
|
|
238
|
+
externalDocs?: {
|
|
239
|
+
url: string;
|
|
240
|
+
description?: string;
|
|
241
|
+
};
|
|
242
|
+
}>;
|
|
243
|
+
externalDocs?: {
|
|
244
|
+
url: string;
|
|
245
|
+
description?: string;
|
|
246
|
+
};
|
|
247
|
+
}
|
|
248
|
+
/**
|
|
249
|
+
* Options for @ApiOperation() decorator
|
|
250
|
+
*/
|
|
251
|
+
export interface ApiOperationOptions {
|
|
252
|
+
/** Short summary of the operation */
|
|
253
|
+
summary?: string;
|
|
254
|
+
/** Detailed description of the operation (supports Markdown) */
|
|
255
|
+
description?: string;
|
|
256
|
+
/** Unique operation identifier */
|
|
257
|
+
operationId?: string;
|
|
258
|
+
/** Mark operation as deprecated */
|
|
259
|
+
deprecated?: boolean;
|
|
260
|
+
/** Tags for grouping operations */
|
|
261
|
+
tags?: string[];
|
|
262
|
+
}
|
|
263
|
+
/**
|
|
264
|
+
* Options for @ApiResponse() decorator
|
|
265
|
+
*/
|
|
266
|
+
export interface ApiResponseOptions {
|
|
267
|
+
/** HTTP status code */
|
|
268
|
+
status: number;
|
|
269
|
+
/** Description of the response */
|
|
270
|
+
description?: string;
|
|
271
|
+
/** Response schema (Zod schema or OpenAPI schema) */
|
|
272
|
+
schema?: ZodType<unknown> | OpenApiSchemaObject;
|
|
273
|
+
/** Content type (default: application/json) */
|
|
274
|
+
type?: string;
|
|
275
|
+
/** Example response value */
|
|
276
|
+
example?: unknown;
|
|
277
|
+
/** Whether response is an array */
|
|
278
|
+
isArray?: boolean;
|
|
279
|
+
}
|
|
280
|
+
/**
|
|
281
|
+
* Options for @ApiProperty() decorator
|
|
282
|
+
*/
|
|
283
|
+
export interface ApiPropertyOptions {
|
|
284
|
+
/** Property description */
|
|
285
|
+
description?: string;
|
|
286
|
+
/** Example value */
|
|
287
|
+
example?: unknown;
|
|
288
|
+
/** Default value */
|
|
289
|
+
default?: unknown;
|
|
290
|
+
/** Whether the property is required */
|
|
291
|
+
required?: boolean;
|
|
292
|
+
/** Property type */
|
|
293
|
+
type?: OpenApiDataType | string;
|
|
294
|
+
/** Property format */
|
|
295
|
+
format?: OpenApiFormat | string;
|
|
296
|
+
/** Enum values */
|
|
297
|
+
enum?: unknown[];
|
|
298
|
+
/** Whether property can be null */
|
|
299
|
+
nullable?: boolean;
|
|
300
|
+
/** Minimum value (for numbers) */
|
|
301
|
+
minimum?: number;
|
|
302
|
+
/** Maximum value (for numbers) */
|
|
303
|
+
maximum?: number;
|
|
304
|
+
/** Minimum length (for strings/arrays) */
|
|
305
|
+
minLength?: number;
|
|
306
|
+
/** Maximum length (for strings/arrays) */
|
|
307
|
+
maxLength?: number;
|
|
308
|
+
/** Pattern (for strings) */
|
|
309
|
+
pattern?: string;
|
|
310
|
+
/** Mark property as deprecated */
|
|
311
|
+
deprecated?: boolean;
|
|
312
|
+
/** Mark property as read-only */
|
|
313
|
+
readOnly?: boolean;
|
|
314
|
+
/** Mark property as write-only */
|
|
315
|
+
writeOnly?: boolean;
|
|
316
|
+
}
|
|
317
|
+
/**
|
|
318
|
+
* Options for @ApiParam() decorator
|
|
319
|
+
*/
|
|
320
|
+
export interface ApiParamOptions {
|
|
321
|
+
/** Parameter name (must match route parameter) */
|
|
322
|
+
name: string;
|
|
323
|
+
/** Parameter description */
|
|
324
|
+
description?: string;
|
|
325
|
+
/** Whether the parameter is required (default: true for path params) */
|
|
326
|
+
required?: boolean;
|
|
327
|
+
/** Parameter type */
|
|
328
|
+
type?: OpenApiDataType | string;
|
|
329
|
+
/** Parameter format */
|
|
330
|
+
format?: OpenApiFormat | string;
|
|
331
|
+
/** Example value */
|
|
332
|
+
example?: unknown;
|
|
333
|
+
/** Enum values */
|
|
334
|
+
enum?: unknown[];
|
|
335
|
+
/** Mark parameter as deprecated */
|
|
336
|
+
deprecated?: boolean;
|
|
337
|
+
/** Zod schema for validation */
|
|
338
|
+
schema?: ZodType<unknown>;
|
|
339
|
+
}
|
|
340
|
+
/**
|
|
341
|
+
* Options for @ApiQuery() decorator
|
|
342
|
+
*/
|
|
343
|
+
export interface ApiQueryOptions extends Omit<ApiParamOptions, 'required'> {
|
|
344
|
+
/** Whether the query parameter is required (default: false) */
|
|
345
|
+
required?: boolean;
|
|
346
|
+
/** Whether the query parameter is an array */
|
|
347
|
+
isArray?: boolean;
|
|
348
|
+
}
|
|
349
|
+
/**
|
|
350
|
+
* Options for @ApiHeader() decorator
|
|
351
|
+
*/
|
|
352
|
+
export interface ApiHeaderOptions {
|
|
353
|
+
/** Header name */
|
|
354
|
+
name: string;
|
|
355
|
+
/** Header description */
|
|
356
|
+
description?: string;
|
|
357
|
+
/** Whether the header is required */
|
|
358
|
+
required?: boolean;
|
|
359
|
+
/** Header data type */
|
|
360
|
+
type?: OpenApiDataType | string;
|
|
361
|
+
/** Mark header as deprecated */
|
|
362
|
+
deprecated?: boolean;
|
|
363
|
+
/** Example value */
|
|
364
|
+
example?: unknown;
|
|
365
|
+
/** Zod schema for validation */
|
|
366
|
+
schema?: ZodType<unknown>;
|
|
367
|
+
}
|
|
368
|
+
/**
|
|
369
|
+
* Options for @ApiBody() decorator
|
|
370
|
+
*/
|
|
371
|
+
export interface ApiBodyOptions {
|
|
372
|
+
/** Request body description */
|
|
373
|
+
description?: string;
|
|
374
|
+
/** Whether the body is required (default: true) */
|
|
375
|
+
required?: boolean;
|
|
376
|
+
/** Content type (default: application/json) */
|
|
377
|
+
type?: string;
|
|
378
|
+
/** Zod schema or OpenAPI schema for the body */
|
|
379
|
+
schema?: ZodType<unknown> | OpenApiSchemaObject;
|
|
380
|
+
/** Example body value */
|
|
381
|
+
example?: unknown;
|
|
382
|
+
/** Multiple examples */
|
|
383
|
+
examples?: Record<string, {
|
|
384
|
+
value: unknown;
|
|
385
|
+
summary?: string;
|
|
386
|
+
description?: string;
|
|
387
|
+
}>;
|
|
388
|
+
/** Whether body is an array */
|
|
389
|
+
isArray?: boolean;
|
|
390
|
+
}
|
|
391
|
+
/**
|
|
392
|
+
* Options for @ApiSecurity() decorator
|
|
393
|
+
*/
|
|
394
|
+
export interface ApiSecurityOptions {
|
|
395
|
+
/** Security scheme name (must match a defined security scheme) */
|
|
396
|
+
name: string;
|
|
397
|
+
/** Required scopes */
|
|
398
|
+
scopes?: string[];
|
|
399
|
+
}
|
|
400
|
+
/**
|
|
401
|
+
* Server configuration for OpenAPI
|
|
402
|
+
*/
|
|
403
|
+
export interface SwaggerServerConfig {
|
|
404
|
+
/** Server URL */
|
|
405
|
+
url: string;
|
|
406
|
+
/** Server description */
|
|
407
|
+
description?: string;
|
|
408
|
+
/** Server variables */
|
|
409
|
+
variables?: Record<string, {
|
|
410
|
+
default: string;
|
|
411
|
+
description?: string;
|
|
412
|
+
enum?: string[];
|
|
413
|
+
}>;
|
|
414
|
+
}
|
|
415
|
+
/**
|
|
416
|
+
* Contact information for OpenAPI
|
|
417
|
+
*/
|
|
418
|
+
export interface SwaggerContactConfig {
|
|
419
|
+
/** Contact name */
|
|
420
|
+
name?: string;
|
|
421
|
+
/** Contact URL */
|
|
422
|
+
url?: string;
|
|
423
|
+
/** Contact email */
|
|
424
|
+
email?: string;
|
|
425
|
+
}
|
|
426
|
+
/**
|
|
427
|
+
* License information for OpenAPI
|
|
428
|
+
*/
|
|
429
|
+
export interface SwaggerLicenseConfig {
|
|
430
|
+
/** License name */
|
|
431
|
+
name: string;
|
|
432
|
+
/** License URL */
|
|
433
|
+
url?: string;
|
|
434
|
+
/** SPDX License identifier */
|
|
435
|
+
identifier?: string;
|
|
436
|
+
}
|
|
437
|
+
/**
|
|
438
|
+
* External documentation configuration
|
|
439
|
+
*/
|
|
440
|
+
export interface SwaggerExternalDocsConfig {
|
|
441
|
+
/** External documentation URL */
|
|
442
|
+
url: string;
|
|
443
|
+
/** Description */
|
|
444
|
+
description?: string;
|
|
445
|
+
}
|
|
446
|
+
/**
|
|
447
|
+
* Tag configuration
|
|
448
|
+
*/
|
|
449
|
+
export interface SwaggerTagConfig {
|
|
450
|
+
/** Tag name */
|
|
451
|
+
name: string;
|
|
452
|
+
/** Tag description */
|
|
453
|
+
description?: string;
|
|
454
|
+
/** External documentation */
|
|
455
|
+
externalDocs?: SwaggerExternalDocsConfig;
|
|
456
|
+
}
|
|
457
|
+
/**
|
|
458
|
+
* Main Swagger/OpenAPI configuration
|
|
459
|
+
*/
|
|
460
|
+
export interface SwaggerConfig {
|
|
461
|
+
/** API info object (title, version, description, etc.) */
|
|
462
|
+
info?: OpenApiInfoObject;
|
|
463
|
+
/** External documentation */
|
|
464
|
+
externalDocs?: SwaggerExternalDocsConfig;
|
|
465
|
+
/** Server configurations */
|
|
466
|
+
servers?: SwaggerServerConfig[];
|
|
467
|
+
/** Tag definitions */
|
|
468
|
+
tags?: SwaggerTagConfig[];
|
|
469
|
+
/** Security schemes */
|
|
470
|
+
securitySchemes?: Record<string, OpenApiSecurityScheme>;
|
|
471
|
+
/** Global security requirements */
|
|
472
|
+
security?: OpenApiSecurityRequirement[];
|
|
473
|
+
/** Path to serve OpenAPI JSON (default: /docs/json) */
|
|
474
|
+
jsonPath?: string;
|
|
475
|
+
/** Path to serve Swagger UI (default: /docs) */
|
|
476
|
+
uiPath?: string;
|
|
477
|
+
/** OpenAPI version (default: 3.0.3) */
|
|
478
|
+
openApiVersion?: '3.0.0' | '3.0.1' | '3.0.2' | '3.0.3' | '3.1.0';
|
|
479
|
+
/** Whether to include routes without explicit swagger decorators */
|
|
480
|
+
includeUndocumented?: boolean;
|
|
481
|
+
/** Base path prefix for all routes */
|
|
482
|
+
basePath?: string;
|
|
483
|
+
}
|
|
484
|
+
/**
|
|
485
|
+
* Stored response metadata (internal)
|
|
486
|
+
*/
|
|
487
|
+
export interface StoredResponseMetadata extends ApiResponseOptions {
|
|
488
|
+
_stored: true;
|
|
489
|
+
}
|
|
490
|
+
/**
|
|
491
|
+
* Stored parameter metadata (internal)
|
|
492
|
+
*/
|
|
493
|
+
export interface StoredParamMetadata extends ApiParamOptions {
|
|
494
|
+
_stored: true;
|
|
495
|
+
location: ParameterLocation;
|
|
496
|
+
}
|
|
497
|
+
/**
|
|
498
|
+
* Route info extracted from core metadata
|
|
499
|
+
*/
|
|
500
|
+
export interface ExtractedRouteInfo {
|
|
501
|
+
method: string;
|
|
502
|
+
path: string;
|
|
503
|
+
handlerName: string | symbol;
|
|
504
|
+
controllerPrefix: string;
|
|
505
|
+
controllerClass: Function;
|
|
506
|
+
}
|
|
507
|
+
/**
|
|
508
|
+
* Constructor type for class instantiation
|
|
509
|
+
*/
|
|
510
|
+
export type Constructor<T = unknown> = new (...args: any[]) => T;
|
|
511
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,KAAK,CAAC;AAMnC;;GAEG;AACH,MAAM,MAAM,eAAe,GACvB,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,SAAS,GACT,OAAO,GACP,QAAQ,CAAC;AAEb;;GAEG;AACH,MAAM,MAAM,aAAa,GACrB,OAAO,GACP,OAAO,GACP,OAAO,GACP,QAAQ,GACR,MAAM,GACN,WAAW,GACX,UAAU,GACV,MAAM,GACN,QAAQ,GACR,OAAO,GACP,MAAM,GACN,KAAK,GACL,UAAU,GACV,MAAM,GACN,MAAM,CAAC;AAEX;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,IAAI,CAAC,EAAE,eAAe,CAAC;IACvB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC;IACjB,KAAK,CAAC,EAAE,mBAAmB,CAAC;IAC5B,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;IACjD,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,KAAK,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAC9B,KAAK,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAC9B,KAAK,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAC9B,GAAG,CAAC,EAAE,mBAAmB,CAAC;IAC1B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,oBAAoB,CAAC,EAAE,OAAO,GAAG,mBAAmB,CAAC;CACtD;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC;AAEvE;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,IAAI,EAAE,MAAM,CAAC;IACb,EAAE,EAAE,iBAAiB,CAAC;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,MAAM,CAAC,EAAE,mBAAmB,CAAC;IAC7B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,KAAK,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;CACjE;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE;QACtB,MAAM,CAAC,EAAE,mBAAmB,CAAC;QAC7B,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;YAAE,KAAK,EAAE,OAAO,CAAC;YAAC,OAAO,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC,CAAC;KACjE,CAAC,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,WAAW,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QACvB,MAAM,CAAC,EAAE,mBAAmB,CAAC;QAC7B,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,CAAC,CAAC;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QACvB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,CAAC,EAAE,mBAAmB,CAAC;KAC9B,CAAC,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;AAElE;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,QAAQ,GAAG,eAAe,CAAC;IACrD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,EAAE,CAAC,EAAE,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC;IACnC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,KAAK,CAAC,EAAE;QACN,QAAQ,CAAC,EAAE;YACT,gBAAgB,EAAE,MAAM,CAAC;YACzB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;SAChC,CAAC;QACF,QAAQ,CAAC,EAAE;YACT,QAAQ,EAAE,MAAM,CAAC;YACjB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;SAChC,CAAC;QACF,iBAAiB,CAAC,EAAE;YAClB,QAAQ,EAAE,MAAM,CAAC;YACjB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;SAChC,CAAC;QACF,iBAAiB,CAAC,EAAE;YAClB,gBAAgB,EAAE,MAAM,CAAC;YACzB,QAAQ,EAAE,MAAM,CAAC;YACjB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;SAChC,CAAC;KACH,CAAC;IACF,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACrD,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,KAAK,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,EAAE,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC;QAC3C,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,UAAU,CAAC,EAAE,OAAO,CAAC;QACrB,MAAM,CAAC,EAAE,mBAAmB,CAAC;QAC7B,OAAO,CAAC,EAAE,OAAO,CAAC;KACnB,CAAC,CAAC;IACH,WAAW,CAAC,EAAE;QACZ,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE;YACtB,MAAM,CAAC,EAAE,mBAAmB,CAAC;YAC7B,OAAO,CAAC,EAAE,OAAO,CAAC;SACnB,CAAC,CAAC;KACJ,CAAC;IACF,SAAS,EAAE,MAAM,CAAC,MAAM,EAAE;QACxB,WAAW,EAAE,MAAM,CAAC;QACpB,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;YACvB,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,MAAM,CAAC,EAAE,mBAAmB,CAAC;SAC9B,CAAC,CAAC;QACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;YACvB,MAAM,CAAC,EAAE,mBAAmB,CAAC;YAC7B,OAAO,CAAC,EAAE,OAAO,CAAC;SACnB,CAAC,CAAC;KACJ,CAAC,CAAC;IACH,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;CAC5C;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,GAAG,CAAC,EAAE,gBAAgB,CAAC;IACvB,GAAG,CAAC,EAAE,gBAAgB,CAAC;IACvB,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACxB,MAAM,CAAC,EAAE,gBAAgB,CAAC;IAC1B,OAAO,CAAC,EAAE,gBAAgB,CAAC;IAC3B,IAAI,CAAC,EAAE,gBAAgB,CAAC;IACxB,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB,KAAK,CAAC,EAAE,gBAAgB,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,KAAK,CAAC;QACjB,IAAI,EAAE,MAAM,CAAC;QACb,EAAE,EAAE,MAAM,GAAG,OAAO,GAAG,QAAQ,GAAG,QAAQ,CAAC;QAC3C,QAAQ,CAAC,EAAE,OAAO,CAAC;QACnB,MAAM,CAAC,EAAE,mBAAmB,CAAC;KAC9B,CAAC,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,OAAO,CAAC,EAAE;QACR,IAAI,CAAC,EAAE,MAAM,CAAC;QACd,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,OAAO,CAAC,EAAE;QACR,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,CAAC,EAAE,MAAM,CAAC;QACb,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB,CAAC;CACH;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,iBAAiB,CAAC;IACxB,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,CAAC,CAAC;IACvC,OAAO,CAAC,EAAE,KAAK,CAAC;QACd,GAAG,EAAE,MAAM,CAAC;QACZ,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;YACzB,OAAO,EAAE,MAAM,CAAC;YAChB,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;SACjB,CAAC,CAAC;KACJ,CAAC,CAAC;IACH,UAAU,CAAC,EAAE;QACX,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC;QAC9C,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,GAAG;YACvD,IAAI,EAAE,MAAM,CAAC;YACb,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,IAAI,CAAC,EAAE,MAAM,CAAC;YACd,EAAE,CAAC,EAAE,MAAM,CAAC;YACZ,MAAM,CAAC,EAAE,MAAM,CAAC;YAChB,YAAY,CAAC,EAAE,MAAM,CAAC;YACtB,KAAK,CAAC,EAAE,OAAO,CAAC;SACjB,CAAC,CAAC;QACH,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;QAClD,UAAU,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,sBAAsB,CAAC,CAAC;QACpD,aAAa,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;KAC1D,CAAC;IACF,QAAQ,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC;IAC3C,IAAI,CAAC,EAAE,KAAK,CAAC;QACX,IAAI,EAAE,MAAM,CAAC;QACb,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,YAAY,CAAC,EAAE;YAAE,GAAG,EAAE,MAAM,CAAC;YAAC,WAAW,CAAC,EAAE,MAAM,CAAA;SAAE,CAAC;KACtD,CAAC,CAAC;IACH,YAAY,CAAC,EAAE;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,WAAW,CAAC,EAAE,MAAM,CAAC;KACtB,CAAC;CACH;AAMD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,qCAAqC;IACrC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,gEAAgE;IAChE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,kCAAkC;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mCAAmC;IACnC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,mCAAmC;IACnC,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,uBAAuB;IACvB,MAAM,EAAE,MAAM,CAAC;IACf,kCAAkC;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qDAAqD;IACrD,MAAM,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,mBAAmB,CAAC;IAChD,+CAA+C;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,6BAA6B;IAC7B,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,mCAAmC;IACnC,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,2BAA2B;IAC3B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,oBAAoB;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,oBAAoB;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,uCAAuC;IACvC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,oBAAoB;IACpB,IAAI,CAAC,EAAE,eAAe,GAAG,MAAM,CAAC;IAChC,sBAAsB;IACtB,MAAM,CAAC,EAAE,aAAa,GAAG,MAAM,CAAC;IAChC,kBAAkB;IAClB,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC;IACjB,mCAAmC;IACnC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,kCAAkC;IAClC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,kCAAkC;IAClC,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,0CAA0C;IAC1C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,0CAA0C;IAC1C,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,4BAA4B;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,kCAAkC;IAClC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,iCAAiC;IACjC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,kCAAkC;IAClC,SAAS,CAAC,EAAE,OAAO,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,kDAAkD;IAClD,IAAI,EAAE,MAAM,CAAC;IACb,4BAA4B;IAC5B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,wEAAwE;IACxE,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,qBAAqB;IACrB,IAAI,CAAC,EAAE,eAAe,GAAG,MAAM,CAAC;IAChC,uBAAuB;IACvB,MAAM,CAAC,EAAE,aAAa,GAAG,MAAM,CAAC;IAChC,oBAAoB;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,kBAAkB;IAClB,IAAI,CAAC,EAAE,OAAO,EAAE,CAAC;IACjB,mCAAmC;IACnC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,gCAAgC;IAChC,MAAM,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,IAAI,CAAC,eAAe,EAAE,UAAU,CAAC;IACxE,+DAA+D;IAC/D,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,8CAA8C;IAC9C,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,kBAAkB;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,yBAAyB;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,qCAAqC;IACrC,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,uBAAuB;IACvB,IAAI,CAAC,EAAE,eAAe,GAAG,MAAM,CAAC;IAChC,gCAAgC;IAChC,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB,oBAAoB;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,gCAAgC;IAChC,MAAM,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,+BAA+B;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,mDAAmD;IACnD,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,+CAA+C;IAC/C,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,gDAAgD;IAChD,MAAM,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,mBAAmB,CAAC;IAChD,yBAAyB;IACzB,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,wBAAwB;IACxB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QAAE,KAAK,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,MAAM,CAAC;QAAC,WAAW,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IACtF,+BAA+B;IAC/B,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,kEAAkE;IAClE,IAAI,EAAE,MAAM,CAAC;IACb,sBAAsB;IACtB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAC;CACnB;AAMD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,iBAAiB;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,yBAAyB;IACzB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,uBAAuB;IACvB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE;QACzB,OAAO,EAAE,MAAM,CAAC;QAChB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,IAAI,CAAC,EAAE,MAAM,EAAE,CAAC;KACjB,CAAC,CAAC;CACJ;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,mBAAmB;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,kBAAkB;IAClB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,oBAAoB;IACpB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC,mBAAmB;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,kBAAkB;IAClB,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,8BAA8B;IAC9B,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACxC,iCAAiC;IACjC,GAAG,EAAE,MAAM,CAAC;IACZ,kBAAkB;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,eAAe;IACf,IAAI,EAAE,MAAM,CAAC;IACb,sBAAsB;IACtB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,6BAA6B;IAC7B,YAAY,CAAC,EAAE,yBAAyB,CAAC;CAC1C;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,0DAA0D;IAC1D,IAAI,CAAC,EAAE,iBAAiB,CAAC;IACzB,6BAA6B;IAC7B,YAAY,CAAC,EAAE,yBAAyB,CAAC;IACzC,4BAA4B;IAC5B,OAAO,CAAC,EAAE,mBAAmB,EAAE,CAAC;IAChC,sBAAsB;IACtB,IAAI,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAC1B,uBAAuB;IACvB,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;IACxD,mCAAmC;IACnC,QAAQ,CAAC,EAAE,0BAA0B,EAAE,CAAC;IACxC,uDAAuD;IACvD,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,gDAAgD;IAChD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,uCAAuC;IACvC,cAAc,CAAC,EAAE,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,GAAG,OAAO,CAAC;IACjE,oEAAoE;IACpE,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAC9B,sCAAsC;IACtC,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAMD;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,kBAAkB;IAChE,OAAO,EAAE,IAAI,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,mBAAoB,SAAQ,eAAe;IAC1D,OAAO,EAAE,IAAI,CAAC;IACd,QAAQ,EAAE,iBAAiB,CAAC;CAC7B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC;IAC7B,gBAAgB,EAAE,MAAM,CAAC;IACzB,eAAe,EAAE,QAAQ,CAAC;CAC3B;AAED;;GAEG;AAEH,MAAM,MAAM,WAAW,CAAC,CAAC,GAAG,OAAO,IAAI,KAAK,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC"}
|
package/dist/types.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}
|
package/package.json
ADDED
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@riktajs/swagger",
|
|
3
|
+
"version": "0.1.0",
|
|
4
|
+
"description": "Automatic OpenAPI/Swagger documentation generation for Rikta Framework",
|
|
5
|
+
"type": "module",
|
|
6
|
+
"main": "dist/index.js",
|
|
7
|
+
"types": "dist/index.d.ts",
|
|
8
|
+
"files": [
|
|
9
|
+
"dist"
|
|
10
|
+
],
|
|
11
|
+
"scripts": {
|
|
12
|
+
"build": "tsc",
|
|
13
|
+
"dev": "tsc --watch",
|
|
14
|
+
"test": "vitest run",
|
|
15
|
+
"test:watch": "vitest",
|
|
16
|
+
"test:coverage": "vitest run --coverage",
|
|
17
|
+
"prepublishOnly": "npm run build"
|
|
18
|
+
},
|
|
19
|
+
"keywords": [
|
|
20
|
+
"rikta",
|
|
21
|
+
"swagger",
|
|
22
|
+
"openapi",
|
|
23
|
+
"documentation",
|
|
24
|
+
"fastify",
|
|
25
|
+
"typescript",
|
|
26
|
+
"decorators",
|
|
27
|
+
"api-docs"
|
|
28
|
+
],
|
|
29
|
+
"author": "",
|
|
30
|
+
"license": "MIT",
|
|
31
|
+
"peerDependencies": {
|
|
32
|
+
"@riktajs/core": ">=0.4.2",
|
|
33
|
+
"fastify": ">=5.0.0",
|
|
34
|
+
"reflect-metadata": ">=0.2.0",
|
|
35
|
+
"zod": ">=3.20.0"
|
|
36
|
+
},
|
|
37
|
+
"peerDependenciesMeta": {
|
|
38
|
+
"zod": {
|
|
39
|
+
"optional": true
|
|
40
|
+
}
|
|
41
|
+
},
|
|
42
|
+
"dependencies": {
|
|
43
|
+
"@fastify/swagger": "^9.4.2",
|
|
44
|
+
"@fastify/swagger-ui": "^5.2.1",
|
|
45
|
+
"fastify-plugin": "^5.0.1",
|
|
46
|
+
"zod-to-json-schema": "^3.25.1"
|
|
47
|
+
},
|
|
48
|
+
"devDependencies": {
|
|
49
|
+
"@riktajs/core": "*",
|
|
50
|
+
"@types/node": "^22.10.2",
|
|
51
|
+
"@vitest/coverage-v8": "^2.1.9",
|
|
52
|
+
"fastify": "^5.3.2",
|
|
53
|
+
"reflect-metadata": "^0.2.2",
|
|
54
|
+
"typescript": "^5.7.2",
|
|
55
|
+
"vitest": "^2.1.8",
|
|
56
|
+
"zod": "^3.25.76"
|
|
57
|
+
},
|
|
58
|
+
"engines": {
|
|
59
|
+
"node": ">=20.0.0"
|
|
60
|
+
}
|
|
61
|
+
}
|