exisjs 0.7.6 → 0.7.8
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/dist/cli/commands/build.d.ts.map +1 -1
- package/dist/cli/commands/build.js +12 -0
- package/dist/cli/commands/build.js.map +1 -1
- package/dist/cli/commands/clean.d.ts +5 -0
- package/dist/cli/commands/clean.d.ts.map +1 -0
- package/dist/cli/commands/clean.js +30 -0
- package/dist/cli/commands/clean.js.map +1 -0
- package/dist/cli/commands/dev.d.ts.map +1 -1
- package/dist/cli/commands/dev.js +15 -1
- package/dist/cli/commands/dev.js.map +1 -1
- package/dist/cli/commands/generate.d.ts +6 -1
- package/dist/cli/commands/generate.d.ts.map +1 -1
- package/dist/cli/commands/generate.js +57 -2
- package/dist/cli/commands/generate.js.map +1 -1
- package/dist/cli/index.js +16 -2
- package/dist/cli/index.js.map +1 -1
- package/dist/cli/manifest.d.ts +1 -0
- package/dist/cli/manifest.d.ts.map +1 -1
- package/dist/cli/manifest.js +161 -23
- package/dist/cli/manifest.js.map +1 -1
- package/dist/config/config.d.ts.map +1 -1
- package/dist/config/config.js +9 -0
- package/dist/config/config.js.map +1 -1
- package/dist/config/types.d.ts +4 -0
- package/dist/config/types.d.ts.map +1 -1
- package/dist/cron/expressions.d.ts +45 -0
- package/dist/cron/expressions.d.ts.map +1 -0
- package/dist/cron/expressions.js +87 -0
- package/dist/cron/expressions.js.map +1 -0
- package/dist/cron/index.d.ts +6 -0
- package/dist/cron/index.d.ts.map +1 -0
- package/dist/cron/index.js +22 -0
- package/dist/cron/index.js.map +1 -0
- package/dist/cron/job.d.ts +50 -0
- package/dist/cron/job.d.ts.map +1 -0
- package/dist/cron/job.js +247 -0
- package/dist/cron/job.js.map +1 -0
- package/dist/cron/manager.d.ts +105 -0
- package/dist/cron/manager.d.ts.map +1 -0
- package/dist/cron/manager.js +245 -0
- package/dist/cron/manager.js.map +1 -0
- package/dist/cron/parser.d.ts +22 -0
- package/dist/cron/parser.d.ts.map +1 -0
- package/dist/cron/parser.js +269 -0
- package/dist/cron/parser.js.map +1 -0
- package/dist/cron/types.d.ts +76 -0
- package/dist/cron/types.d.ts.map +1 -0
- package/dist/cron/types.js +3 -0
- package/dist/cron/types.js.map +1 -0
- package/dist/decorators/constants.d.ts +2 -0
- package/dist/decorators/constants.d.ts.map +1 -1
- package/dist/decorators/constants.js +3 -1
- package/dist/decorators/constants.js.map +1 -1
- package/dist/decorators/core.d.ts +29 -11
- package/dist/decorators/core.d.ts.map +1 -1
- package/dist/decorators/core.js +49 -11
- package/dist/decorators/core.js.map +1 -1
- package/dist/decorators/cron.d.ts +57 -0
- package/dist/decorators/cron.d.ts.map +1 -0
- package/dist/decorators/cron.js +143 -0
- package/dist/decorators/cron.js.map +1 -0
- package/dist/decorators/index.d.ts +2 -0
- package/dist/decorators/index.d.ts.map +1 -1
- package/dist/decorators/index.js +2 -0
- package/dist/decorators/index.js.map +1 -1
- package/dist/decorators/params.d.ts +97 -2
- package/dist/decorators/params.d.ts.map +1 -1
- package/dist/decorators/params.js +94 -2
- package/dist/decorators/params.js.map +1 -1
- package/dist/decorators/routing.d.ts +81 -16
- package/dist/decorators/routing.d.ts.map +1 -1
- package/dist/decorators/routing.js +81 -16
- package/dist/decorators/routing.js.map +1 -1
- package/dist/docs/content/cron.mdx +196 -0
- package/dist/docs/content/errors.mdx +58 -9
- package/dist/docs/content/structure.mdx +1 -1
- package/dist/docs/content/swagger.mdx +289 -0
- package/dist/docs/reference/cron.mdx +300 -0
- package/dist/docs/reference/decorators.mdx +8 -0
- package/dist/docs/reference/error.mdx +44 -0
- package/dist/docs/reference/swagger.mdx +226 -0
- package/dist/docs/reference/validator.mdx +1 -1
- package/dist/router/boundary.d.ts +24 -2
- package/dist/router/boundary.d.ts.map +1 -1
- package/dist/router/boundary.js +24 -2
- package/dist/router/boundary.js.map +1 -1
- package/dist/router/controller-registrar.d.ts.map +1 -1
- package/dist/router/controller-registrar.js +52 -3
- package/dist/router/controller-registrar.js.map +1 -1
- package/dist/router/route-builder.d.ts +196 -33
- package/dist/router/route-builder.d.ts.map +1 -1
- package/dist/router/route-builder.js +171 -11
- package/dist/router/route-builder.js.map +1 -1
- package/dist/router/route-scanner.d.ts +6 -0
- package/dist/router/route-scanner.d.ts.map +1 -1
- package/dist/router/route-scanner.js +69 -812
- package/dist/router/route-scanner.js.map +1 -1
- package/dist/router/router.d.ts.map +1 -1
- package/dist/router/router.js +27 -0
- package/dist/router/router.js.map +1 -1
- package/dist/router/scanner/boundary-loader.d.ts +18 -0
- package/dist/router/scanner/boundary-loader.d.ts.map +1 -0
- package/dist/router/scanner/boundary-loader.js +539 -0
- package/dist/router/scanner/boundary-loader.js.map +1 -0
- package/dist/router/scanner/cron-mounter.d.ts +15 -0
- package/dist/router/scanner/cron-mounter.d.ts.map +1 -0
- package/dist/router/scanner/cron-mounter.js +216 -0
- package/dist/router/scanner/cron-mounter.js.map +1 -0
- package/dist/router/scanner/error-mounter.d.ts +14 -0
- package/dist/router/scanner/error-mounter.d.ts.map +1 -0
- package/dist/router/scanner/error-mounter.js +200 -0
- package/dist/router/scanner/error-mounter.js.map +1 -0
- package/dist/router/scanner/fs-scanner.d.ts +25 -0
- package/dist/router/scanner/fs-scanner.d.ts.map +1 -0
- package/dist/router/scanner/fs-scanner.js +115 -0
- package/dist/router/scanner/fs-scanner.js.map +1 -0
- package/dist/router/scanner/functional-compiler.d.ts +9 -0
- package/dist/router/scanner/functional-compiler.d.ts.map +1 -0
- package/dist/router/scanner/functional-compiler.js +233 -0
- package/dist/router/scanner/functional-compiler.js.map +1 -0
- package/dist/router/scanner/index.d.ts +9 -0
- package/dist/router/scanner/index.d.ts.map +1 -0
- package/dist/router/scanner/index.js +19 -0
- package/dist/router/scanner/index.js.map +1 -0
- package/dist/router/types.d.ts +15 -0
- package/dist/router/types.d.ts.map +1 -1
- package/dist/server/app.d.ts +2 -0
- package/dist/server/app.d.ts.map +1 -1
- package/dist/server/app.js +3 -0
- package/dist/server/app.js.map +1 -1
- package/dist/server/helpers/body-parser.d.ts +18 -0
- package/dist/server/helpers/body-parser.d.ts.map +1 -0
- package/dist/server/helpers/body-parser.js +246 -0
- package/dist/server/helpers/body-parser.js.map +1 -0
- package/dist/server/helpers/cookie.d.ts +4 -0
- package/dist/server/helpers/cookie.d.ts.map +1 -0
- package/dist/server/helpers/cookie.js +61 -0
- package/dist/server/helpers/cookie.js.map +1 -0
- package/dist/server/helpers/etag.d.ts +3 -0
- package/dist/server/helpers/etag.d.ts.map +1 -0
- package/dist/server/helpers/etag.js +25 -0
- package/dist/server/helpers/etag.js.map +1 -0
- package/dist/server/helpers/index.d.ts +6 -0
- package/dist/server/helpers/index.d.ts.map +1 -0
- package/dist/server/helpers/index.js +21 -0
- package/dist/server/helpers/index.js.map +1 -0
- package/dist/server/helpers/ip.d.ts +9 -0
- package/dist/server/helpers/ip.d.ts.map +1 -0
- package/dist/server/helpers/ip.js +62 -0
- package/dist/server/helpers/ip.js.map +1 -0
- package/dist/server/helpers/stream.d.ts +4 -0
- package/dist/server/helpers/stream.d.ts.map +1 -0
- package/dist/server/helpers/stream.js +193 -0
- package/dist/server/helpers/stream.js.map +1 -0
- package/dist/server/request.d.ts +1 -139
- package/dist/server/request.d.ts.map +1 -1
- package/dist/server/request.js +19 -433
- package/dist/server/request.js.map +1 -1
- package/dist/server/response.d.ts +105 -158
- package/dist/server/response.d.ts.map +1 -1
- package/dist/server/response.js +121 -423
- package/dist/server/response.js.map +1 -1
- package/dist/swagger/decorators.d.ts +81 -0
- package/dist/swagger/decorators.d.ts.map +1 -0
- package/dist/swagger/decorators.js +172 -0
- package/dist/swagger/decorators.js.map +1 -0
- package/dist/swagger/generator.d.ts +19 -0
- package/dist/swagger/generator.d.ts.map +1 -0
- package/dist/swagger/generator.js +344 -0
- package/dist/swagger/generator.js.map +1 -0
- package/dist/swagger/index.d.ts +31 -0
- package/dist/swagger/index.d.ts.map +1 -0
- package/dist/swagger/index.js +53 -0
- package/dist/swagger/index.js.map +1 -0
- package/dist/swagger/mounter.d.ts +7 -0
- package/dist/swagger/mounter.d.ts.map +1 -0
- package/dist/swagger/mounter.js +56 -0
- package/dist/swagger/mounter.js.map +1 -0
- package/dist/swagger/types.d.ts +190 -0
- package/dist/swagger/types.d.ts.map +1 -0
- package/dist/swagger/types.js +3 -0
- package/dist/swagger/types.js.map +1 -0
- package/dist/swagger/ui.d.ts +6 -0
- package/dist/swagger/ui.d.ts.map +1 -0
- package/dist/swagger/ui.js +118 -0
- package/dist/swagger/ui.js.map +1 -0
- package/dist/validator/builder.d.ts +223 -0
- package/dist/validator/builder.d.ts.map +1 -0
- package/dist/validator/builder.js +517 -0
- package/dist/validator/builder.js.map +1 -0
- package/dist/validator/engine.d.ts +19 -0
- package/dist/validator/engine.d.ts.map +1 -0
- package/dist/validator/engine.js +568 -0
- package/dist/validator/engine.js.map +1 -0
- package/dist/validator/error.d.ts +12 -0
- package/dist/validator/error.d.ts.map +1 -0
- package/dist/validator/error.js +63 -0
- package/dist/validator/error.js.map +1 -0
- package/dist/validator/pagination.d.ts +40 -0
- package/dist/validator/pagination.d.ts.map +1 -0
- package/dist/validator/pagination.js +60 -0
- package/dist/validator/pagination.js.map +1 -0
- package/dist/validator/tex.d.ts +6 -158
- package/dist/validator/tex.d.ts.map +1 -1
- package/dist/validator/tex.js +14 -971
- package/dist/validator/tex.js.map +1 -1
- package/dist/validator/types.d.ts +83 -0
- package/dist/validator/types.d.ts.map +1 -0
- package/dist/validator/types.js +3 -0
- package/dist/validator/types.js.map +1 -0
- package/package.json +9 -1
|
@@ -0,0 +1,344 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.normalizeOpenApiPath = normalizeOpenApiPath;
|
|
4
|
+
exports.schemaToOpenApi = schemaToOpenApi;
|
|
5
|
+
exports.generateOpenApiSpec = generateOpenApiSpec;
|
|
6
|
+
/**
|
|
7
|
+
* Normalizes framework path syntax (`/users/:id`, `/posts/[id]`, `/files/*`) into OpenAPI standard `{id}` path parameters.
|
|
8
|
+
*/
|
|
9
|
+
function normalizeOpenApiPath(path) {
|
|
10
|
+
let normalized = path
|
|
11
|
+
// Convert :param to {param}
|
|
12
|
+
.replace(/:([a-zA-Z0-9_]+)/g, '{$1}')
|
|
13
|
+
// Convert [param] and [...param] to {param}
|
|
14
|
+
.replace(/\[\.\.\.([a-zA-Z0-9_]+)\]/g, '{$1}')
|
|
15
|
+
.replace(/\[([a-zA-Z0-9_]+)\]/g, '{$1}')
|
|
16
|
+
// Convert wildcard * to {wildcard}
|
|
17
|
+
.replace(/\/\*$/g, '/{wildcard}');
|
|
18
|
+
if (!normalized.startsWith('/')) {
|
|
19
|
+
normalized = `/${normalized}`;
|
|
20
|
+
}
|
|
21
|
+
return normalized;
|
|
22
|
+
}
|
|
23
|
+
/**
|
|
24
|
+
* Converts a validator or schema object (TexEngine, TexType, Zod, or raw object) to an OpenAPI/JSON Schema.
|
|
25
|
+
*/
|
|
26
|
+
function schemaToOpenApi(validator) {
|
|
27
|
+
if (!validator)
|
|
28
|
+
return { type: 'object' };
|
|
29
|
+
// 1. Tex Native Engine or Type with toOpenApi method
|
|
30
|
+
if (typeof validator.toOpenApi === 'function') {
|
|
31
|
+
return validator.toOpenApi();
|
|
32
|
+
}
|
|
33
|
+
// 2. Direct TexType
|
|
34
|
+
if (validator.constructor &&
|
|
35
|
+
validator.constructor.name === 'TexType' &&
|
|
36
|
+
validator._raw) {
|
|
37
|
+
const raw = validator._raw.split('|')[0].trim();
|
|
38
|
+
const isOptional = raw.endsWith('?');
|
|
39
|
+
const base = raw.replace('?', '');
|
|
40
|
+
let typeObj = { type: 'string' };
|
|
41
|
+
if (base.startsWith('number'))
|
|
42
|
+
typeObj = { type: 'number' };
|
|
43
|
+
else if (base.startsWith('boolean'))
|
|
44
|
+
typeObj = { type: 'boolean' };
|
|
45
|
+
else if (base.startsWith('date'))
|
|
46
|
+
typeObj = { type: 'string', format: 'date-time' };
|
|
47
|
+
else if (base.startsWith('email'))
|
|
48
|
+
typeObj = { type: 'string', format: 'email' };
|
|
49
|
+
else if (base.startsWith('uuid'))
|
|
50
|
+
typeObj = { type: 'string', format: 'uuid' };
|
|
51
|
+
else if (base.startsWith('array<'))
|
|
52
|
+
typeObj = { type: 'array', items: { type: 'string' } };
|
|
53
|
+
return isOptional ? { ...typeObj, nullable: true } : typeObj;
|
|
54
|
+
}
|
|
55
|
+
// 3. Zod-like Duck Typing
|
|
56
|
+
if (typeof validator._def === 'object') {
|
|
57
|
+
const def = validator._def;
|
|
58
|
+
const typeName = def.typeName || '';
|
|
59
|
+
if (typeName === 'ZodString')
|
|
60
|
+
return { type: 'string' };
|
|
61
|
+
if (typeName === 'ZodNumber')
|
|
62
|
+
return { type: 'number' };
|
|
63
|
+
if (typeName === 'ZodBoolean')
|
|
64
|
+
return { type: 'boolean' };
|
|
65
|
+
if (typeName === 'ZodArray') {
|
|
66
|
+
return {
|
|
67
|
+
type: 'array',
|
|
68
|
+
items: schemaToOpenApi(def.type),
|
|
69
|
+
};
|
|
70
|
+
}
|
|
71
|
+
if (typeName === 'ZodObject' && typeof def.shape === 'function') {
|
|
72
|
+
const shape = def.shape();
|
|
73
|
+
const properties = {};
|
|
74
|
+
const required = [];
|
|
75
|
+
for (const [key, val] of Object.entries(shape)) {
|
|
76
|
+
properties[key] = schemaToOpenApi(val);
|
|
77
|
+
if (val?._def?.typeName !== 'ZodOptional' &&
|
|
78
|
+
val?._def?.typeName !== 'ZodNullable') {
|
|
79
|
+
required.push(key);
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
return {
|
|
83
|
+
type: 'object',
|
|
84
|
+
properties,
|
|
85
|
+
...(required.length > 0 ? { required } : {}),
|
|
86
|
+
};
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
// 4. If plain object representation
|
|
90
|
+
if (typeof validator === 'object') {
|
|
91
|
+
if (validator.type &&
|
|
92
|
+
(validator.properties ||
|
|
93
|
+
validator.items ||
|
|
94
|
+
typeof validator.type === 'string')) {
|
|
95
|
+
return validator;
|
|
96
|
+
}
|
|
97
|
+
}
|
|
98
|
+
return { type: 'object' };
|
|
99
|
+
}
|
|
100
|
+
/**
|
|
101
|
+
* Extracts query parameters from route schema into OpenAPI parameter objects.
|
|
102
|
+
*/
|
|
103
|
+
function extractQueryParameters(queryValidator) {
|
|
104
|
+
if (!queryValidator)
|
|
105
|
+
return [];
|
|
106
|
+
const schema = schemaToOpenApi(queryValidator);
|
|
107
|
+
if (schema.type !== 'object' || !schema.properties)
|
|
108
|
+
return [];
|
|
109
|
+
const requiredList = Array.isArray(schema.required)
|
|
110
|
+
? schema.required
|
|
111
|
+
: [];
|
|
112
|
+
return Object.entries(schema.properties).map(([name, propSchema]) => {
|
|
113
|
+
const isRequired = requiredList.includes(name);
|
|
114
|
+
return {
|
|
115
|
+
name,
|
|
116
|
+
in: 'query',
|
|
117
|
+
required: isRequired,
|
|
118
|
+
schema: propSchema,
|
|
119
|
+
};
|
|
120
|
+
});
|
|
121
|
+
}
|
|
122
|
+
/**
|
|
123
|
+
* Extracts path parameters from the URL string and matched schema into OpenAPI parameters.
|
|
124
|
+
*/
|
|
125
|
+
function extractPathParameters(path, paramsValidator) {
|
|
126
|
+
const matches = path.match(/:([a-zA-Z0-9_]+)|\[\.\.\.([a-zA-Z0-9_]+)\]|\[([a-zA-Z0-9_]+)\]|\*/g) || [];
|
|
127
|
+
if (matches.length === 0)
|
|
128
|
+
return [];
|
|
129
|
+
const schema = paramsValidator ? schemaToOpenApi(paramsValidator) : null;
|
|
130
|
+
const properties = schema?.properties || {};
|
|
131
|
+
return matches.map((m) => {
|
|
132
|
+
let name = m.replace(/[:[\]]/g, '').replace(/^\.\.\./, '');
|
|
133
|
+
if (m === '*')
|
|
134
|
+
name = 'wildcard';
|
|
135
|
+
const propSchema = properties[name] || { type: 'string' };
|
|
136
|
+
return {
|
|
137
|
+
name,
|
|
138
|
+
in: 'path',
|
|
139
|
+
required: true,
|
|
140
|
+
schema: propSchema,
|
|
141
|
+
};
|
|
142
|
+
});
|
|
143
|
+
}
|
|
144
|
+
/**
|
|
145
|
+
* Extracts header parameters from route schema.
|
|
146
|
+
*/
|
|
147
|
+
function extractHeaderParameters(headersValidator) {
|
|
148
|
+
if (!headersValidator)
|
|
149
|
+
return [];
|
|
150
|
+
const schema = schemaToOpenApi(headersValidator);
|
|
151
|
+
if (schema.type !== 'object' || !schema.properties)
|
|
152
|
+
return [];
|
|
153
|
+
const requiredList = Array.isArray(schema.required)
|
|
154
|
+
? schema.required
|
|
155
|
+
: [];
|
|
156
|
+
return Object.entries(schema.properties).map(([name, propSchema]) => {
|
|
157
|
+
return {
|
|
158
|
+
name,
|
|
159
|
+
in: 'header',
|
|
160
|
+
required: requiredList.includes(name),
|
|
161
|
+
schema: propSchema,
|
|
162
|
+
};
|
|
163
|
+
});
|
|
164
|
+
}
|
|
165
|
+
/**
|
|
166
|
+
* Generates an OpenAPI 3.1.0 specification object from the registered routes and configuration.
|
|
167
|
+
*/
|
|
168
|
+
function generateOpenApiSpec(routesOrApp, config = {}) {
|
|
169
|
+
let routes = [];
|
|
170
|
+
if (Array.isArray(routesOrApp)) {
|
|
171
|
+
routes = routesOrApp;
|
|
172
|
+
}
|
|
173
|
+
else if (routesOrApp && typeof routesOrApp.getRoutes === 'function') {
|
|
174
|
+
routes = routesOrApp.getRoutes();
|
|
175
|
+
}
|
|
176
|
+
else if (routesOrApp && typeof routesOrApp.getRouter === 'function') {
|
|
177
|
+
routes = routesOrApp.getRouter().getRoutes();
|
|
178
|
+
}
|
|
179
|
+
else if (routesOrApp && Array.isArray(routesOrApp.routes)) {
|
|
180
|
+
routes = routesOrApp.routes;
|
|
181
|
+
}
|
|
182
|
+
const title = config.title || 'ExisJS API Documentation';
|
|
183
|
+
const version = config.version || '1.0.0';
|
|
184
|
+
const description = config.description ||
|
|
185
|
+
'Auto-generated API documentation with native schema validation';
|
|
186
|
+
const paths = {};
|
|
187
|
+
const componentsSchemas = {};
|
|
188
|
+
for (const route of routes) {
|
|
189
|
+
// Check if route or schema is explicitly excluded
|
|
190
|
+
const schema = route.schema;
|
|
191
|
+
if (schema?.excludeFromDocs)
|
|
192
|
+
continue;
|
|
193
|
+
if (route.excludeFromDocs)
|
|
194
|
+
continue;
|
|
195
|
+
const methodLower = route.method.toLowerCase();
|
|
196
|
+
if (methodLower === 'options' || methodLower === 'head')
|
|
197
|
+
continue;
|
|
198
|
+
const methods = methodLower === 'all'
|
|
199
|
+
? ['get', 'post', 'put', 'patch', 'delete']
|
|
200
|
+
: [methodLower];
|
|
201
|
+
const openApiPath = normalizeOpenApiPath(route.path);
|
|
202
|
+
if (!paths[openApiPath]) {
|
|
203
|
+
paths[openApiPath] = {};
|
|
204
|
+
}
|
|
205
|
+
// Parameters
|
|
206
|
+
const pathParams = extractPathParameters(route.path, schema?.params);
|
|
207
|
+
const queryParams = extractQueryParameters(schema?.query);
|
|
208
|
+
const headerParams = extractHeaderParameters(schema?.headers);
|
|
209
|
+
const allParameters = [
|
|
210
|
+
...pathParams,
|
|
211
|
+
...queryParams,
|
|
212
|
+
...headerParams,
|
|
213
|
+
];
|
|
214
|
+
// Request Body
|
|
215
|
+
let requestBody;
|
|
216
|
+
if (schema?.body &&
|
|
217
|
+
(methods.includes('post') ||
|
|
218
|
+
methods.includes('put') ||
|
|
219
|
+
methods.includes('patch'))) {
|
|
220
|
+
const bodySchema = schemaToOpenApi(schema.body);
|
|
221
|
+
requestBody = {
|
|
222
|
+
required: true,
|
|
223
|
+
content: {
|
|
224
|
+
'application/json': {
|
|
225
|
+
schema: bodySchema,
|
|
226
|
+
},
|
|
227
|
+
},
|
|
228
|
+
};
|
|
229
|
+
}
|
|
230
|
+
else if (schema?.upload) {
|
|
231
|
+
requestBody = {
|
|
232
|
+
required: true,
|
|
233
|
+
content: {
|
|
234
|
+
'multipart/form-data': {
|
|
235
|
+
schema: {
|
|
236
|
+
type: 'object',
|
|
237
|
+
properties: {
|
|
238
|
+
file: {
|
|
239
|
+
type: 'string',
|
|
240
|
+
format: 'binary',
|
|
241
|
+
},
|
|
242
|
+
},
|
|
243
|
+
},
|
|
244
|
+
},
|
|
245
|
+
},
|
|
246
|
+
};
|
|
247
|
+
}
|
|
248
|
+
// Responses
|
|
249
|
+
const responses = {};
|
|
250
|
+
if (schema?.responses) {
|
|
251
|
+
for (const [code, respDef] of Object.entries(schema.responses)) {
|
|
252
|
+
const respSchema = respDef.schema
|
|
253
|
+
? schemaToOpenApi(respDef.schema)
|
|
254
|
+
: undefined;
|
|
255
|
+
responses[String(code)] = {
|
|
256
|
+
description: respDef.description || `HTTP ${code} Response`,
|
|
257
|
+
...(respSchema
|
|
258
|
+
? {
|
|
259
|
+
content: {
|
|
260
|
+
'application/json': {
|
|
261
|
+
schema: respSchema,
|
|
262
|
+
},
|
|
263
|
+
},
|
|
264
|
+
}
|
|
265
|
+
: {}),
|
|
266
|
+
};
|
|
267
|
+
}
|
|
268
|
+
}
|
|
269
|
+
if (schema?.response && Object.keys(responses).length === 0) {
|
|
270
|
+
const resSchema = schemaToOpenApi(schema.response);
|
|
271
|
+
responses['200'] = {
|
|
272
|
+
description: 'Successful operation',
|
|
273
|
+
content: {
|
|
274
|
+
'application/json': {
|
|
275
|
+
schema: resSchema,
|
|
276
|
+
},
|
|
277
|
+
},
|
|
278
|
+
};
|
|
279
|
+
}
|
|
280
|
+
if (Object.keys(responses).length === 0) {
|
|
281
|
+
responses['200'] = {
|
|
282
|
+
description: 'Successful operation',
|
|
283
|
+
};
|
|
284
|
+
}
|
|
285
|
+
// Inherited / route tags
|
|
286
|
+
const tags = schema?.tags && Array.isArray(schema.tags)
|
|
287
|
+
? schema.tags
|
|
288
|
+
: deriveDefaultTag(route.path);
|
|
289
|
+
for (const m of methods) {
|
|
290
|
+
const operation = {
|
|
291
|
+
tags,
|
|
292
|
+
summary: schema?.summary || `${m.toUpperCase()} ${route.path}`,
|
|
293
|
+
description: schema?.description,
|
|
294
|
+
operationId: schema?.operationId ||
|
|
295
|
+
`${m}_${route.path.replace(/[^a-zA-Z0-9]/g, '_')}`,
|
|
296
|
+
deprecated: schema?.deprecated,
|
|
297
|
+
parameters: allParameters.length > 0 ? allParameters : undefined,
|
|
298
|
+
requestBody,
|
|
299
|
+
responses,
|
|
300
|
+
security: schema?.security || config.security,
|
|
301
|
+
externalDocs: schema?.externalDocs,
|
|
302
|
+
};
|
|
303
|
+
paths[openApiPath][m] = operation;
|
|
304
|
+
}
|
|
305
|
+
}
|
|
306
|
+
const spec = {
|
|
307
|
+
openapi: '3.1.0',
|
|
308
|
+
info: {
|
|
309
|
+
title,
|
|
310
|
+
version,
|
|
311
|
+
description,
|
|
312
|
+
termsOfService: config.termsOfService,
|
|
313
|
+
contact: config.contact,
|
|
314
|
+
license: config.license,
|
|
315
|
+
},
|
|
316
|
+
servers: config.servers || [{ url: '/', description: 'Default Server' }],
|
|
317
|
+
tags: config.tags,
|
|
318
|
+
paths,
|
|
319
|
+
components: {
|
|
320
|
+
schemas: Object.keys(componentsSchemas).length > 0
|
|
321
|
+
? componentsSchemas
|
|
322
|
+
: undefined,
|
|
323
|
+
securitySchemes: config.securitySchemes,
|
|
324
|
+
},
|
|
325
|
+
security: config.security,
|
|
326
|
+
};
|
|
327
|
+
if (typeof config.transformSpec === 'function') {
|
|
328
|
+
const transformed = config.transformSpec(spec);
|
|
329
|
+
if (transformed)
|
|
330
|
+
return transformed;
|
|
331
|
+
}
|
|
332
|
+
return spec;
|
|
333
|
+
}
|
|
334
|
+
function deriveDefaultTag(path) {
|
|
335
|
+
const parts = path.split('/').filter(Boolean);
|
|
336
|
+
if (parts.length > 0 &&
|
|
337
|
+
!parts[0].startsWith(':') &&
|
|
338
|
+
!parts[0].startsWith('[')) {
|
|
339
|
+
const formatted = parts[0].charAt(0).toUpperCase() + parts[0].slice(1);
|
|
340
|
+
return [formatted];
|
|
341
|
+
}
|
|
342
|
+
return ['General'];
|
|
343
|
+
}
|
|
344
|
+
//# sourceMappingURL=generator.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"generator.js","sourceRoot":"","sources":["../../src/swagger/generator.ts"],"names":[],"mappings":";;AAaA,oDAcC;AAKD,0CAgFC;AAgFD,kDA0LC;AAhXD;;GAEG;AACH,SAAgB,oBAAoB,CAAC,IAAY;IAC/C,IAAI,UAAU,GAAG,IAAI;QACnB,4BAA4B;SAC3B,OAAO,CAAC,mBAAmB,EAAE,MAAM,CAAC;QACrC,4CAA4C;SAC3C,OAAO,CAAC,4BAA4B,EAAE,MAAM,CAAC;SAC7C,OAAO,CAAC,sBAAsB,EAAE,MAAM,CAAC;QACxC,mCAAmC;SAClC,OAAO,CAAC,QAAQ,EAAE,aAAa,CAAC,CAAA;IAEnC,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;QAChC,UAAU,GAAG,IAAI,UAAU,EAAE,CAAA;IAC/B,CAAC;IACD,OAAO,UAAU,CAAA;AACnB,CAAC;AAED;;GAEG;AACH,SAAgB,eAAe,CAAC,SAAc;IAC5C,IAAI,CAAC,SAAS;QAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAA;IAEzC,qDAAqD;IACrD,IAAI,OAAO,SAAS,CAAC,SAAS,KAAK,UAAU,EAAE,CAAC;QAC9C,OAAO,SAAS,CAAC,SAAS,EAAE,CAAA;IAC9B,CAAC;IAED,oBAAoB;IACpB,IACE,SAAS,CAAC,WAAW;QACrB,SAAS,CAAC,WAAW,CAAC,IAAI,KAAK,SAAS;QACxC,SAAS,CAAC,IAAI,EACd,CAAC;QACD,MAAM,GAAG,GAAW,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;QACvD,MAAM,UAAU,GAAG,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAA;QACpC,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,GAAG,EAAE,EAAE,CAAC,CAAA;QAEjC,IAAI,OAAO,GAAwB,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAA;QACrD,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;YAAE,OAAO,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAA;aACtD,IAAI,IAAI,CAAC,UAAU,CAAC,SAAS,CAAC;YAAE,OAAO,GAAG,EAAE,IAAI,EAAE,SAAS,EAAE,CAAA;aAC7D,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;YAC9B,OAAO,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,CAAA;aAC9C,IAAI,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC;YAC/B,OAAO,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,OAAO,EAAE,CAAA;aAC1C,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC;YAC9B,OAAO,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,CAAA;aACzC,IAAI,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC;YAChC,OAAO,GAAG,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,CAAA;QAExD,OAAO,UAAU,CAAC,CAAC,CAAC,EAAE,GAAG,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,OAAO,CAAA;IAC9D,CAAC;IAED,0BAA0B;IAC1B,IAAI,OAAO,SAAS,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QACvC,MAAM,GAAG,GAAG,SAAS,CAAC,IAAI,CAAA;QAC1B,MAAM,QAAQ,GAAG,GAAG,CAAC,QAAQ,IAAI,EAAE,CAAA;QACnC,IAAI,QAAQ,KAAK,WAAW;YAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAA;QACvD,IAAI,QAAQ,KAAK,WAAW;YAAE,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAA;QACvD,IAAI,QAAQ,KAAK,YAAY;YAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,CAAA;QACzD,IAAI,QAAQ,KAAK,UAAU,EAAE,CAAC;YAC5B,OAAO;gBACL,IAAI,EAAE,OAAO;gBACb,KAAK,EAAE,eAAe,CAAC,GAAG,CAAC,IAAI,CAAC;aACjC,CAAA;QACH,CAAC;QACD,IAAI,QAAQ,KAAK,WAAW,IAAI,OAAO,GAAG,CAAC,KAAK,KAAK,UAAU,EAAE,CAAC;YAChE,MAAM,KAAK,GAAG,GAAG,CAAC,KAAK,EAAE,CAAA;YACzB,MAAM,UAAU,GAAwB,EAAE,CAAA;YAC1C,MAAM,QAAQ,GAAa,EAAE,CAAA;YAC7B,KAAK,MAAM,CAAC,GAAG,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;gBAC/C,UAAU,CAAC,GAAG,CAAC,GAAG,eAAe,CAAC,GAAG,CAAC,CAAA;gBACtC,IACG,GAAW,EAAE,IAAI,EAAE,QAAQ,KAAK,aAAa;oBAC7C,GAAW,EAAE,IAAI,EAAE,QAAQ,KAAK,aAAa,EAC9C,CAAC;oBACD,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;gBACpB,CAAC;YACH,CAAC;YACD,OAAO;gBACL,IAAI,EAAE,QAAQ;gBACd,UAAU;gBACV,GAAG,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;aAC7C,CAAA;QACH,CAAC;IACH,CAAC;IAED,oCAAoC;IACpC,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;QAClC,IACE,SAAS,CAAC,IAAI;YACd,CAAC,SAAS,CAAC,UAAU;gBACnB,SAAS,CAAC,KAAK;gBACf,OAAO,SAAS,CAAC,IAAI,KAAK,QAAQ,CAAC,EACrC,CAAC;YACD,OAAO,SAAS,CAAA;QAClB,CAAC;IACH,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAA;AAC3B,CAAC;AAED;;GAEG;AACH,SAAS,sBAAsB,CAAC,cAAmB;IACjD,IAAI,CAAC,cAAc;QAAE,OAAO,EAAE,CAAA;IAC9B,MAAM,MAAM,GAAG,eAAe,CAAC,cAAc,CAAC,CAAA;IAC9C,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,UAAU;QAAE,OAAO,EAAE,CAAA;IAE7D,MAAM,YAAY,GAAa,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC;QAC3D,CAAC,CAAC,MAAM,CAAC,QAAQ;QACjB,CAAC,CAAC,EAAE,CAAA;IAEN,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC,EAAE,EAAE;QAClE,MAAM,UAAU,GAAG,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QAC9C,OAAO;YACL,IAAI;YACJ,EAAE,EAAE,OAAO;YACX,QAAQ,EAAE,UAAU;YACpB,MAAM,EAAE,UAAiC;SAC1C,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC;AAED;;GAEG;AACH,SAAS,qBAAqB,CAC5B,IAAY,EACZ,eAAqB;IAErB,MAAM,OAAO,GACX,IAAI,CAAC,KAAK,CACR,oEAAoE,CACrE,IAAI,EAAE,CAAA;IACT,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAA;IAEnC,MAAM,MAAM,GAAG,eAAe,CAAC,CAAC,CAAC,eAAe,CAAC,eAAe,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;IACxE,MAAM,UAAU,GAAG,MAAM,EAAE,UAAU,IAAI,EAAE,CAAA;IAE3C,OAAO,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACvB,IAAI,IAAI,GAAG,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,SAAS,EAAE,EAAE,CAAC,CAAA;QAC1D,IAAI,CAAC,KAAK,GAAG;YAAE,IAAI,GAAG,UAAU,CAAA;QAEhC,MAAM,UAAU,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAA;QACzD,OAAO;YACL,IAAI;YACJ,EAAE,EAAE,MAAM;YACV,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,UAAU;SACnB,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC;AAED;;GAEG;AACH,SAAS,uBAAuB,CAAC,gBAAsB;IACrD,IAAI,CAAC,gBAAgB;QAAE,OAAO,EAAE,CAAA;IAChC,MAAM,MAAM,GAAG,eAAe,CAAC,gBAAgB,CAAC,CAAA;IAChD,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,IAAI,CAAC,MAAM,CAAC,UAAU;QAAE,OAAO,EAAE,CAAA;IAE7D,MAAM,YAAY,GAAa,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC;QAC3D,CAAC,CAAC,MAAM,CAAC,QAAQ;QACjB,CAAC,CAAC,EAAE,CAAA;IAEN,OAAO,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,UAAU,CAAC,EAAE,EAAE;QAClE,OAAO;YACL,IAAI;YACJ,EAAE,EAAE,QAAQ;YACZ,QAAQ,EAAE,YAAY,CAAC,QAAQ,CAAC,IAAI,CAAC;YACrC,MAAM,EAAE,UAAiC;SAC1C,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC;AAED;;GAEG;AACH,SAAgB,mBAAmB,CACjC,WAE0E,EAC1E,SAAwB,EAAE;IAE1B,IAAI,MAAM,GAAY,EAAE,CAAA;IACxB,IAAI,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;QAC/B,MAAM,GAAG,WAAW,CAAA;IACtB,CAAC;SAAM,IAAI,WAAW,IAAI,OAAO,WAAW,CAAC,SAAS,KAAK,UAAU,EAAE,CAAC;QACtE,MAAM,GAAG,WAAW,CAAC,SAAS,EAAE,CAAA;IAClC,CAAC;SAAM,IAAI,WAAW,IAAI,OAAO,WAAW,CAAC,SAAS,KAAK,UAAU,EAAE,CAAC;QACtE,MAAM,GAAG,WAAW,CAAC,SAAS,EAAE,CAAC,SAAS,EAAE,CAAA;IAC9C,CAAC;SAAM,IAAI,WAAW,IAAI,KAAK,CAAC,OAAO,CAAC,WAAW,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5D,MAAM,GAAG,WAAW,CAAC,MAAM,CAAA;IAC7B,CAAC;IAED,MAAM,KAAK,GAAG,MAAM,CAAC,KAAK,IAAI,0BAA0B,CAAA;IACxD,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,IAAI,OAAO,CAAA;IACzC,MAAM,WAAW,GACf,MAAM,CAAC,WAAW;QAClB,gEAAgE,CAAA;IAElE,MAAM,KAAK,GAAqD,EAAE,CAAA;IAClE,MAAM,iBAAiB,GAAwB,EAAE,CAAA;IAEjD,KAAK,MAAM,KAAK,IAAI,MAAM,EAAE,CAAC;QAC3B,kDAAkD;QAClD,MAAM,MAAM,GAA4B,KAAK,CAAC,MAAM,CAAA;QACpD,IAAI,MAAM,EAAE,eAAe;YAAE,SAAQ;QACrC,IAAK,KAAa,CAAC,eAAe;YAAE,SAAQ;QAE5C,MAAM,WAAW,GAAG,KAAK,CAAC,MAAM,CAAC,WAAW,EAAE,CAAA;QAC9C,IAAI,WAAW,KAAK,SAAS,IAAI,WAAW,KAAK,MAAM;YAAE,SAAQ;QAEjE,MAAM,OAAO,GACX,WAAW,KAAK,KAAK;YACnB,CAAC,CAAC,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,QAAQ,CAAC;YAC3C,CAAC,CAAC,CAAC,WAAW,CAAC,CAAA;QAEnB,MAAM,WAAW,GAAG,oBAAoB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QACpD,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,EAAE,CAAC;YACxB,KAAK,CAAC,WAAW,CAAC,GAAG,EAAE,CAAA;QACzB,CAAC;QAED,aAAa;QACb,MAAM,UAAU,GAAG,qBAAqB,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,EAAE,MAAM,CAAC,CAAA;QACpE,MAAM,WAAW,GAAG,sBAAsB,CAAC,MAAM,EAAE,KAAK,CAAC,CAAA;QACzD,MAAM,YAAY,GAAG,uBAAuB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QAC7D,MAAM,aAAa,GAAuB;YACxC,GAAG,UAAU;YACb,GAAG,WAAW;YACd,GAAG,YAAY;SAChB,CAAA;QAED,eAAe;QACf,IAAI,WAA2C,CAAA;QAC/C,IACE,MAAM,EAAE,IAAI;YACZ,CAAC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC;gBACvB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC;gBACvB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,EAC5B,CAAC;YACD,MAAM,UAAU,GAAG,eAAe,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;YAC/C,WAAW,GAAG;gBACZ,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE;oBACP,kBAAkB,EAAE;wBAClB,MAAM,EAAE,UAAU;qBACnB;iBACF;aACF,CAAA;QACH,CAAC;aAAM,IAAI,MAAM,EAAE,MAAM,EAAE,CAAC;YAC1B,WAAW,GAAG;gBACZ,QAAQ,EAAE,IAAI;gBACd,OAAO,EAAE;oBACP,qBAAqB,EAAE;wBACrB,MAAM,EAAE;4BACN,IAAI,EAAE,QAAQ;4BACd,UAAU,EAAE;gCACV,IAAI,EAAE;oCACJ,IAAI,EAAE,QAAQ;oCACd,MAAM,EAAE,QAAQ;iCACjB;6BACF;yBACF;qBACF;iBACF;aACF,CAAA;QACH,CAAC;QAED,YAAY;QACZ,MAAM,SAAS,GAAoC,EAAE,CAAA;QACrD,IAAI,MAAM,EAAE,SAAS,EAAE,CAAC;YACtB,KAAK,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC/D,MAAM,UAAU,GAAG,OAAO,CAAC,MAAM;oBAC/B,CAAC,CAAC,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC;oBACjC,CAAC,CAAC,SAAS,CAAA;gBACb,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,GAAG;oBACxB,WAAW,EAAE,OAAO,CAAC,WAAW,IAAI,QAAQ,IAAI,WAAW;oBAC3D,GAAG,CAAC,UAAU;wBACZ,CAAC,CAAC;4BACE,OAAO,EAAE;gCACP,kBAAkB,EAAE;oCAClB,MAAM,EAAE,UAAU;iCACnB;6BACF;yBACF;wBACH,CAAC,CAAC,EAAE,CAAC;iBACR,CAAA;YACH,CAAC;QACH,CAAC;QAED,IAAI,MAAM,EAAE,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC5D,MAAM,SAAS,GAAG,eAAe,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAA;YAClD,SAAS,CAAC,KAAK,CAAC,GAAG;gBACjB,WAAW,EAAE,sBAAsB;gBACnC,OAAO,EAAE;oBACP,kBAAkB,EAAE;wBAClB,MAAM,EAAE,SAAS;qBAClB;iBACF;aACF,CAAA;QACH,CAAC;QAED,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACxC,SAAS,CAAC,KAAK,CAAC,GAAG;gBACjB,WAAW,EAAE,sBAAsB;aACpC,CAAA;QACH,CAAC;QAED,yBAAyB;QACzB,MAAM,IAAI,GACR,MAAM,EAAE,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC;YACxC,CAAC,CAAC,MAAM,CAAC,IAAI;YACb,CAAC,CAAC,gBAAgB,CAAC,KAAK,CAAC,IAAI,CAAC,CAAA;QAElC,KAAK,MAAM,CAAC,IAAI,OAAO,EAAE,CAAC;YACxB,MAAM,SAAS,GAAqB;gBAClC,IAAI;gBACJ,OAAO,EAAE,MAAM,EAAE,OAAO,IAAI,GAAG,CAAC,CAAC,WAAW,EAAE,IAAI,KAAK,CAAC,IAAI,EAAE;gBAC9D,WAAW,EAAE,MAAM,EAAE,WAAW;gBAChC,WAAW,EACT,MAAM,EAAE,WAAW;oBACnB,GAAG,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,eAAe,EAAE,GAAG,CAAC,EAAE;gBACpD,UAAU,EAAE,MAAM,EAAE,UAAU;gBAC9B,UAAU,EAAE,aAAa,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,SAAS;gBAChE,WAAW;gBACX,SAAS;gBACT,QAAQ,EAAE,MAAM,EAAE,QAAQ,IAAI,MAAM,CAAC,QAAQ;gBAC7C,YAAY,EAAE,MAAM,EAAE,YAAY;aACnC,CAAA;YAED,KAAK,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,SAAS,CAAA;QACnC,CAAC;IACH,CAAC;IAED,MAAM,IAAI,GAAgB;QACxB,OAAO,EAAE,OAAO;QAChB,IAAI,EAAE;YACJ,KAAK;YACL,OAAO;YACP,WAAW;YACX,cAAc,EAAE,MAAM,CAAC,cAAc;YACrC,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,OAAO,EAAE,MAAM,CAAC,OAAO;SACxB;QACD,OAAO,EAAE,MAAM,CAAC,OAAO,IAAI,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,WAAW,EAAE,gBAAgB,EAAE,CAAC;QACxE,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,KAAK;QACL,UAAU,EAAE;YACV,OAAO,EACL,MAAM,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC,MAAM,GAAG,CAAC;gBACvC,CAAC,CAAC,iBAAiB;gBACnB,CAAC,CAAC,SAAS;YACf,eAAe,EAAE,MAAM,CAAC,eAAe;SACxC;QACD,QAAQ,EAAE,MAAM,CAAC,QAAQ;KAC1B,CAAA;IAED,IAAI,OAAO,MAAM,CAAC,aAAa,KAAK,UAAU,EAAE,CAAC;QAC/C,MAAM,WAAW,GAAG,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,CAAA;QAC9C,IAAI,WAAW;YAAE,OAAO,WAAW,CAAA;IACrC,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC;AAED,SAAS,gBAAgB,CAAC,IAAY;IACpC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,CAAA;IAC7C,IACE,KAAK,CAAC,MAAM,GAAG,CAAC;QAChB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC;QACzB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,GAAG,CAAC,EACzB,CAAC;QACD,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,WAAW,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAA;QACtE,OAAO,CAAC,SAAS,CAAC,CAAA;IACpB,CAAC;IACD,OAAO,CAAC,SAAS,CAAC,CAAA;AACpB,CAAC"}
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
import type { App } from '../server/app';
|
|
2
|
+
import type { SwaggerConfig } from './types';
|
|
3
|
+
export * from './types';
|
|
4
|
+
export * from './generator';
|
|
5
|
+
export * from './ui';
|
|
6
|
+
export * from './mounter';
|
|
7
|
+
export * from './decorators';
|
|
8
|
+
/**
|
|
9
|
+
* Convenience helper to initialize and mount Swagger / OpenAPI documentation on an ExisJS App.
|
|
10
|
+
*
|
|
11
|
+
* @param config Optional Swagger configuration options (title, path, version, tags, etc.)
|
|
12
|
+
* @returns Plugin/middleware function that mounts documentation when invoked
|
|
13
|
+
*
|
|
14
|
+
* @example
|
|
15
|
+
* ```ts
|
|
16
|
+
* import { App } from 'exisjs'
|
|
17
|
+
* import { swagger } from 'exisjs/swagger'
|
|
18
|
+
*
|
|
19
|
+
* const app = new App()
|
|
20
|
+
* swagger({
|
|
21
|
+
* title: 'My Store API',
|
|
22
|
+
* version: '2.0.0',
|
|
23
|
+
* path: '/docs',
|
|
24
|
+
* })(app)
|
|
25
|
+
* ```
|
|
26
|
+
*/
|
|
27
|
+
export declare function swagger(config?: SwaggerConfig): (app: App<any>) => void;
|
|
28
|
+
export declare const defineSwagger: (config: SwaggerConfig) => SwaggerConfig;
|
|
29
|
+
export declare const docs: typeof swagger;
|
|
30
|
+
export declare const defineDocs: (config: SwaggerConfig) => SwaggerConfig;
|
|
31
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/swagger/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,SAAS,CAAA;AAG5C,cAAc,SAAS,CAAA;AACvB,cAAc,aAAa,CAAA;AAC3B,cAAc,MAAM,CAAA;AACpB,cAAc,WAAW,CAAA;AACzB,cAAc,cAAc,CAAA;AAE5B;;;;;;;;;;;;;;;;;;GAkBG;AACH,wBAAgB,OAAO,CAAC,MAAM,CAAC,EAAE,aAAa,IACpC,KAAK,GAAG,CAAC,GAAG,CAAC,KAAG,IAAI,CAG7B;AAED,eAAO,MAAM,aAAa,GAAI,QAAQ,aAAa,KAAG,aAAuB,CAAA;AAC7E,eAAO,MAAM,IAAI,gBAAU,CAAA;AAC3B,eAAO,MAAM,UAAU,WAFe,aAAa,KAAG,aAEf,CAAA"}
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
|
|
3
|
+
if (k2 === undefined) k2 = k;
|
|
4
|
+
var desc = Object.getOwnPropertyDescriptor(m, k);
|
|
5
|
+
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
|
|
6
|
+
desc = { enumerable: true, get: function() { return m[k]; } };
|
|
7
|
+
}
|
|
8
|
+
Object.defineProperty(o, k2, desc);
|
|
9
|
+
}) : (function(o, m, k, k2) {
|
|
10
|
+
if (k2 === undefined) k2 = k;
|
|
11
|
+
o[k2] = m[k];
|
|
12
|
+
}));
|
|
13
|
+
var __exportStar = (this && this.__exportStar) || function(m, exports) {
|
|
14
|
+
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
|
|
15
|
+
};
|
|
16
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
17
|
+
exports.defineDocs = exports.docs = exports.defineSwagger = void 0;
|
|
18
|
+
exports.swagger = swagger;
|
|
19
|
+
const mounter_1 = require("./mounter");
|
|
20
|
+
__exportStar(require("./types"), exports);
|
|
21
|
+
__exportStar(require("./generator"), exports);
|
|
22
|
+
__exportStar(require("./ui"), exports);
|
|
23
|
+
__exportStar(require("./mounter"), exports);
|
|
24
|
+
__exportStar(require("./decorators"), exports);
|
|
25
|
+
/**
|
|
26
|
+
* Convenience helper to initialize and mount Swagger / OpenAPI documentation on an ExisJS App.
|
|
27
|
+
*
|
|
28
|
+
* @param config Optional Swagger configuration options (title, path, version, tags, etc.)
|
|
29
|
+
* @returns Plugin/middleware function that mounts documentation when invoked
|
|
30
|
+
*
|
|
31
|
+
* @example
|
|
32
|
+
* ```ts
|
|
33
|
+
* import { App } from 'exisjs'
|
|
34
|
+
* import { swagger } from 'exisjs/swagger'
|
|
35
|
+
*
|
|
36
|
+
* const app = new App()
|
|
37
|
+
* swagger({
|
|
38
|
+
* title: 'My Store API',
|
|
39
|
+
* version: '2.0.0',
|
|
40
|
+
* path: '/docs',
|
|
41
|
+
* })(app)
|
|
42
|
+
* ```
|
|
43
|
+
*/
|
|
44
|
+
function swagger(config) {
|
|
45
|
+
return (app) => {
|
|
46
|
+
(0, mounter_1.mountDocumentation)(app, config);
|
|
47
|
+
};
|
|
48
|
+
}
|
|
49
|
+
const defineSwagger = (config) => config;
|
|
50
|
+
exports.defineSwagger = defineSwagger;
|
|
51
|
+
exports.docs = swagger;
|
|
52
|
+
exports.defineDocs = exports.defineSwagger;
|
|
53
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/swagger/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AA6BA,0BAIC;AA/BD,uCAA8C;AAE9C,0CAAuB;AACvB,8CAA2B;AAC3B,uCAAoB;AACpB,4CAAyB;AACzB,+CAA4B;AAE5B;;;;;;;;;;;;;;;;;;GAkBG;AACH,SAAgB,OAAO,CAAC,MAAsB;IAC5C,OAAO,CAAC,GAAa,EAAQ,EAAE;QAC7B,IAAA,4BAAkB,EAAC,GAAG,EAAE,MAAM,CAAC,CAAA;IACjC,CAAC,CAAA;AACH,CAAC;AAEM,MAAM,aAAa,GAAG,CAAC,MAAqB,EAAiB,EAAE,CAAC,MAAM,CAAA;AAAhE,QAAA,aAAa,iBAAmD;AAChE,QAAA,IAAI,GAAG,OAAO,CAAA;AACd,QAAA,UAAU,GAAG,qBAAa,CAAA"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import type { App } from '../server/app';
|
|
2
|
+
import type { SwaggerConfig } from './types';
|
|
3
|
+
/**
|
|
4
|
+
* Mounts interactive Swagger/Scalar documentation UI and OpenAPI 3.1 JSON endpoints onto an ExisJS App.
|
|
5
|
+
*/
|
|
6
|
+
export declare function mountDocumentation(app: App<any>, options?: SwaggerConfig): void;
|
|
7
|
+
//# sourceMappingURL=mounter.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"mounter.d.ts","sourceRoot":"","sources":["../../src/swagger/mounter.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,eAAe,CAAA;AACxC,OAAO,KAAK,EAAE,aAAa,EAAe,MAAM,SAAS,CAAA;AAIzD;;GAEG;AACH,wBAAgB,kBAAkB,CAChC,GAAG,EAAE,GAAG,CAAC,GAAG,CAAC,EACb,OAAO,GAAE,aAAkB,GAC1B,IAAI,CAyDN"}
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.mountDocumentation = mountDocumentation;
|
|
4
|
+
const generator_1 = require("./generator");
|
|
5
|
+
const ui_1 = require("./ui");
|
|
6
|
+
/**
|
|
7
|
+
* Mounts interactive Swagger/Scalar documentation UI and OpenAPI 3.1 JSON endpoints onto an ExisJS App.
|
|
8
|
+
*/
|
|
9
|
+
function mountDocumentation(app, options = {}) {
|
|
10
|
+
const docsPath = (options.path || '/docs').replace(/\/+$/, '');
|
|
11
|
+
const specPath = options.specPath || `${docsPath}/json`;
|
|
12
|
+
const resolvedConfig = {
|
|
13
|
+
...options,
|
|
14
|
+
path: docsPath,
|
|
15
|
+
specPath,
|
|
16
|
+
};
|
|
17
|
+
let cachedHtml = null;
|
|
18
|
+
let cachedSpec = null;
|
|
19
|
+
const getHtml = () => {
|
|
20
|
+
if (!cachedHtml) {
|
|
21
|
+
cachedHtml = (0, ui_1.renderDocumentationHtml)(resolvedConfig);
|
|
22
|
+
}
|
|
23
|
+
return cachedHtml;
|
|
24
|
+
};
|
|
25
|
+
const getSpec = () => {
|
|
26
|
+
if (!cachedSpec) {
|
|
27
|
+
const routes = app.getRouter().getRoutes() || [];
|
|
28
|
+
cachedSpec = (0, generator_1.generateOpenApiSpec)(routes, resolvedConfig);
|
|
29
|
+
}
|
|
30
|
+
return cachedSpec;
|
|
31
|
+
};
|
|
32
|
+
// Raw OpenAPI Specification Endpoint (JSON)
|
|
33
|
+
app.get(specPath, { excludeFromDocs: true }, (_req, res) => {
|
|
34
|
+
const spec = getSpec();
|
|
35
|
+
res.setHeader('Content-Type', 'application/json; charset=utf-8');
|
|
36
|
+
return res.send(JSON.stringify(spec));
|
|
37
|
+
});
|
|
38
|
+
// Secondary spec alias (/docs/openapi.json)
|
|
39
|
+
if (specPath !== `${docsPath}/openapi.json`) {
|
|
40
|
+
app.get(`${docsPath}/openapi.json`, { excludeFromDocs: true }, (_req, res) => {
|
|
41
|
+
const spec = getSpec();
|
|
42
|
+
res.setHeader('Content-Type', 'application/json; charset=utf-8');
|
|
43
|
+
return res.send(JSON.stringify(spec));
|
|
44
|
+
});
|
|
45
|
+
}
|
|
46
|
+
// Interactive HTML Documentation UI Endpoints
|
|
47
|
+
const htmlHandler = (_req, res) => {
|
|
48
|
+
res.setHeader('Content-Type', 'text/html; charset=utf-8');
|
|
49
|
+
return res.send(getHtml());
|
|
50
|
+
};
|
|
51
|
+
app.get(docsPath || '/', { excludeFromDocs: true }, htmlHandler);
|
|
52
|
+
if (docsPath) {
|
|
53
|
+
app.get(`${docsPath}/`, { excludeFromDocs: true }, htmlHandler);
|
|
54
|
+
}
|
|
55
|
+
}
|
|
56
|
+
//# sourceMappingURL=mounter.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"mounter.js","sourceRoot":"","sources":["../../src/swagger/mounter.ts"],"names":[],"mappings":";;AAQA,gDA4DC;AAlED,2CAAiD;AACjD,6BAA8C;AAE9C;;GAEG;AACH,SAAgB,kBAAkB,CAChC,GAAa,EACb,UAAyB,EAAE;IAE3B,MAAM,QAAQ,GAAG,CAAC,OAAO,CAAC,IAAI,IAAI,OAAO,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAA;IAC9D,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,GAAG,QAAQ,OAAO,CAAA;IACvD,MAAM,cAAc,GAAkB;QACpC,GAAG,OAAO;QACV,IAAI,EAAE,QAAQ;QACd,QAAQ;KACT,CAAA;IAED,IAAI,UAAU,GAAkB,IAAI,CAAA;IACpC,IAAI,UAAU,GAAuB,IAAI,CAAA;IAEzC,MAAM,OAAO,GAAG,GAAW,EAAE;QAC3B,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,UAAU,GAAG,IAAA,4BAAuB,EAAC,cAAc,CAAC,CAAA;QACtD,CAAC;QACD,OAAO,UAAU,CAAA;IACnB,CAAC,CAAA;IAED,MAAM,OAAO,GAAG,GAAgB,EAAE;QAChC,IAAI,CAAC,UAAU,EAAE,CAAC;YAChB,MAAM,MAAM,GAAG,GAAG,CAAC,SAAS,EAAE,CAAC,SAAS,EAAE,IAAI,EAAE,CAAA;YAChD,UAAU,GAAG,IAAA,+BAAmB,EAAC,MAAM,EAAE,cAAc,CAAC,CAAA;QAC1D,CAAC;QACD,OAAO,UAAU,CAAA;IACnB,CAAC,CAAA;IAED,4CAA4C;IAC5C,GAAG,CAAC,GAAG,CAAC,QAAQ,EAAE,EAAE,eAAe,EAAE,IAAI,EAAS,EAAE,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;QAChE,MAAM,IAAI,GAAG,OAAO,EAAE,CAAA;QACtB,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,iCAAiC,CAAC,CAAA;QAChE,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAA;IACvC,CAAC,CAAC,CAAA;IAEF,4CAA4C;IAC5C,IAAI,QAAQ,KAAK,GAAG,QAAQ,eAAe,EAAE,CAAC;QAC5C,GAAG,CAAC,GAAG,CACL,GAAG,QAAQ,eAAe,EAC1B,EAAE,eAAe,EAAE,IAAI,EAAS,EAChC,CAAC,IAAI,EAAE,GAAG,EAAE,EAAE;YACZ,MAAM,IAAI,GAAG,OAAO,EAAE,CAAA;YACtB,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,iCAAiC,CAAC,CAAA;YAChE,OAAO,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAA;QACvC,CAAC,CACF,CAAA;IACH,CAAC;IAED,8CAA8C;IAC9C,MAAM,WAAW,GAAG,CAAC,IAAS,EAAE,GAAQ,EAAE,EAAE;QAC1C,GAAG,CAAC,SAAS,CAAC,cAAc,EAAE,0BAA0B,CAAC,CAAA;QACzD,OAAO,GAAG,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAA;IAC5B,CAAC,CAAA;IAED,GAAG,CAAC,GAAG,CAAC,QAAQ,IAAI,GAAG,EAAE,EAAE,eAAe,EAAE,IAAI,EAAS,EAAE,WAAW,CAAC,CAAA;IACvE,IAAI,QAAQ,EAAE,CAAC;QACb,GAAG,CAAC,GAAG,CAAC,GAAG,QAAQ,GAAG,EAAE,EAAE,eAAe,EAAE,IAAI,EAAS,EAAE,WAAW,CAAC,CAAA;IACxE,CAAC;AACH,CAAC"}
|