@aomex/openapi 0.0.11 → 0.0.13
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/CHANGELOG.md +30 -0
- package/dist/index.d.ts +2 -2
- package/dist/index.js +186 -56
- package/dist/index.js.map +1 -1
- package/package.json +12 -12
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,35 @@
|
|
|
1
1
|
# @aomex/openapi
|
|
2
2
|
|
|
3
|
+
## 0.0.13
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [`1397083`](https://github.com/aomex/aomex/commit/139708353cad69051073511056b77be392fb47ea) Thanks [@geekact](https://github.com/geekact)! - feat(valiator): use named schema
|
|
8
|
+
|
|
9
|
+
- Updated dependencies [[`6e63df8`](https://github.com/aomex/aomex/commit/6e63df84d1b32e713aba8c52451e289a72b57bae), [`67acf4f`](https://github.com/aomex/aomex/commit/67acf4f42cd86bf1f0a7c647a5ff779c7cd0fa10), [`1940dad`](https://github.com/aomex/aomex/commit/1940dad880bb5d85f04c8baed69b5076633fc27d), [`77039d8`](https://github.com/aomex/aomex/commit/77039d8819944f27662866aab238bde6778d9a6f)]:
|
|
10
|
+
- @aomex/web@0.0.13
|
|
11
|
+
- @aomex/router@0.0.13
|
|
12
|
+
- @aomex/console@0.0.12
|
|
13
|
+
- @aomex/core@0.0.12
|
|
14
|
+
|
|
15
|
+
## 0.0.12
|
|
16
|
+
|
|
17
|
+
### Patch Changes
|
|
18
|
+
|
|
19
|
+
- [`da68011`](https://github.com/aomex/aomex/commit/da68011f0b1937505b5c088c0265a7a905a7ad16) Thanks [@geekact](https://github.com/geekact)! - feat(openapi): update operationId
|
|
20
|
+
|
|
21
|
+
- [`9d80649`](https://github.com/aomex/aomex/commit/9d806498f41acaa1de0ec6e98ea885ba50b8a2db) Thanks [@geekact](https://github.com/geekact)! - feat(openapi): put common parameters to components
|
|
22
|
+
|
|
23
|
+
- [`9785608`](https://github.com/aomex/aomex/commit/9785608f065717199cd44b74f705f18cfd2ffe90) Thanks [@geekact](https://github.com/geekact)! - refactor(openapi): replace ibm-openapi-validator with spectral
|
|
24
|
+
|
|
25
|
+
- [`67b9a2d`](https://github.com/aomex/aomex/commit/67b9a2d4f031ec90bd29a3db641c7049718809c6) Thanks [@geekact](https://github.com/geekact)! - feat(openapi): put common schemas to components
|
|
26
|
+
|
|
27
|
+
- Updated dependencies [[`f14eb5f`](https://github.com/aomex/aomex/commit/f14eb5fe7bf06e1e2f64d45e3546c96d6079a2f1), [`7d923cf`](https://github.com/aomex/aomex/commit/7d923cf971b6a23d50113ab104c67041c6489053), [`3c5ad4e`](https://github.com/aomex/aomex/commit/3c5ad4e2f34be7da54c8b63f6fd4b88fd1e593c4), [`6154ee5`](https://github.com/aomex/aomex/commit/6154ee5ed500984f969d4c335ac3ad800c739937), [`92273f9`](https://github.com/aomex/aomex/commit/92273f913e38543f34f41ec5941ff43b6e1caaa9), [`a0fd49e`](https://github.com/aomex/aomex/commit/a0fd49ef276c05f312257521c75887458857bbb7)]:
|
|
28
|
+
- @aomex/web@0.0.12
|
|
29
|
+
- @aomex/core@0.0.11
|
|
30
|
+
- @aomex/router@0.0.12
|
|
31
|
+
- @aomex/console@0.0.11
|
|
32
|
+
|
|
3
33
|
## 0.0.11
|
|
4
34
|
|
|
5
35
|
### Patch Changes
|
package/dist/index.d.ts
CHANGED
|
@@ -7,12 +7,12 @@ import { PathToFileOptions } from '@aomex/utility';
|
|
|
7
7
|
interface OpenapiValidateResultItem {
|
|
8
8
|
path: string[];
|
|
9
9
|
message: string;
|
|
10
|
-
rule: string;
|
|
11
10
|
}
|
|
12
11
|
interface OpenapiValidateResult {
|
|
13
12
|
errors: OpenapiValidateResultItem[];
|
|
14
13
|
warnings: OpenapiValidateResultItem[];
|
|
15
14
|
}
|
|
15
|
+
|
|
16
16
|
interface OpenapiOptions {
|
|
17
17
|
/**
|
|
18
18
|
* Web api routers
|
|
@@ -61,4 +61,4 @@ declare const openapi: (options: Omit<OpenapiOptions, 'emitter'> & {
|
|
|
61
61
|
description?: string;
|
|
62
62
|
}) => _aomex_console.ConsoleChain<object>;
|
|
63
63
|
|
|
64
|
-
export { OpenapiOptions,
|
|
64
|
+
export { OpenapiOptions, generateDocument, openapi };
|
package/dist/index.js
CHANGED
|
@@ -29,7 +29,6 @@ var openapiToHelp = (commandName, summary, description, showInHelp = true) => mi
|
|
|
29
29
|
import EventEmitter from "node:events";
|
|
30
30
|
import { readPackageUp } from "read-pkg-up";
|
|
31
31
|
import snakeCase from "lodash.snakecase";
|
|
32
|
-
import equal from "fast-deep-equal";
|
|
33
32
|
import { Chain } from "@aomex/core";
|
|
34
33
|
import {
|
|
35
34
|
bytes,
|
|
@@ -38,14 +37,107 @@ import {
|
|
|
38
37
|
fileToModules,
|
|
39
38
|
pathToFiles
|
|
40
39
|
} from "@aomex/utility";
|
|
41
|
-
import { METHOD, WebMiddleware } from "@aomex/web";
|
|
40
|
+
import { METHOD as METHOD2, WebMiddleware } from "@aomex/web";
|
|
42
41
|
import { Router } from "@aomex/router";
|
|
43
|
-
import validate from "ibm-openapi-validator";
|
|
44
42
|
import path from "node:path";
|
|
45
43
|
import { mkdir, writeFile } from "node:fs/promises";
|
|
46
44
|
import yaml from "yaml";
|
|
47
45
|
|
|
48
|
-
// src/
|
|
46
|
+
// src/lib/parameter.ts
|
|
47
|
+
import { METHOD } from "@aomex/web";
|
|
48
|
+
var parameterToComponent = (document) => {
|
|
49
|
+
const parametersStringify = [];
|
|
50
|
+
const parametersRef = /* @__PURE__ */ new Map();
|
|
51
|
+
let count = 0;
|
|
52
|
+
document.components ||= {};
|
|
53
|
+
document.components.parameters ||= {};
|
|
54
|
+
const parser = (parameter, index, arr) => {
|
|
55
|
+
if ("$ref" in parameter)
|
|
56
|
+
return;
|
|
57
|
+
const str = JSON.stringify(parameter);
|
|
58
|
+
const replace = (ref) => {
|
|
59
|
+
arr[index] = {
|
|
60
|
+
$ref: "#/components/parameters/" + ref
|
|
61
|
+
};
|
|
62
|
+
};
|
|
63
|
+
if (parametersStringify.includes(str)) {
|
|
64
|
+
let ref = parametersRef.get(str);
|
|
65
|
+
if (typeof ref === "function") {
|
|
66
|
+
const firstReplace = ref;
|
|
67
|
+
const name = parameter.name;
|
|
68
|
+
ref = document.components.parameters[name] ? name + "_" + ++count : name;
|
|
69
|
+
document.components.parameters[ref] = parameter;
|
|
70
|
+
parametersRef.set(str, ref);
|
|
71
|
+
firstReplace(ref);
|
|
72
|
+
}
|
|
73
|
+
replace(ref);
|
|
74
|
+
} else {
|
|
75
|
+
parametersStringify.push(str);
|
|
76
|
+
parametersRef.set(str, replace);
|
|
77
|
+
}
|
|
78
|
+
};
|
|
79
|
+
for (const path2 of Object.values(document.paths)) {
|
|
80
|
+
path2.parameters?.forEach(parser);
|
|
81
|
+
for (const method of methods) {
|
|
82
|
+
const methodItem = path2[method];
|
|
83
|
+
if (!methodItem || !methodItem.parameters)
|
|
84
|
+
continue;
|
|
85
|
+
methodItem.parameters.forEach(parser);
|
|
86
|
+
}
|
|
87
|
+
}
|
|
88
|
+
if (Object.keys(document.components.parameters).length === 0) {
|
|
89
|
+
delete document.components.parameters;
|
|
90
|
+
}
|
|
91
|
+
if (Object.keys(document.components).length === 0) {
|
|
92
|
+
delete document.components;
|
|
93
|
+
}
|
|
94
|
+
};
|
|
95
|
+
var methodParameterToPathParameter = (document) => {
|
|
96
|
+
pathLoop:
|
|
97
|
+
for (const path2 of Object.values(document.paths)) {
|
|
98
|
+
const parametersCallback = {};
|
|
99
|
+
let index = 0;
|
|
100
|
+
for (const method of methods) {
|
|
101
|
+
const methodItem = path2[method];
|
|
102
|
+
if (!methodItem)
|
|
103
|
+
continue;
|
|
104
|
+
if (!methodItem.parameters?.length)
|
|
105
|
+
continue pathLoop;
|
|
106
|
+
++index;
|
|
107
|
+
methodItem.parameters.forEach((parameter, index2, arr) => {
|
|
108
|
+
const str = JSON.stringify(parameter);
|
|
109
|
+
parameter = arr[index2] = JSON.parse(str);
|
|
110
|
+
parametersCallback[str] ||= [];
|
|
111
|
+
parametersCallback[str].push(() => {
|
|
112
|
+
arr.splice(
|
|
113
|
+
arr.findIndex((item) => item === parameter),
|
|
114
|
+
1
|
|
115
|
+
);
|
|
116
|
+
if (!arr.length) {
|
|
117
|
+
delete methodItem.parameters;
|
|
118
|
+
}
|
|
119
|
+
});
|
|
120
|
+
});
|
|
121
|
+
}
|
|
122
|
+
if (index < 2)
|
|
123
|
+
continue pathLoop;
|
|
124
|
+
Object.entries(parametersCallback).forEach(([key, callbacks]) => {
|
|
125
|
+
if (callbacks.length !== index)
|
|
126
|
+
return;
|
|
127
|
+
path2.parameters ||= [];
|
|
128
|
+
path2.parameters.push(JSON.parse(key));
|
|
129
|
+
callbacks.forEach((callback) => callback());
|
|
130
|
+
});
|
|
131
|
+
if (path2.parameters && !path2.parameters.length) {
|
|
132
|
+
delete path2.parameters;
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
};
|
|
136
|
+
var methods = Object.values(METHOD).map(
|
|
137
|
+
(method) => method.toLowerCase()
|
|
138
|
+
);
|
|
139
|
+
|
|
140
|
+
// src/lib/method-to-verb.ts
|
|
49
141
|
var methodToVerb = (method, uri) => {
|
|
50
142
|
method = method.toLowerCase();
|
|
51
143
|
if (method === "get" && !uri.includes(":"))
|
|
@@ -59,6 +151,85 @@ var methodToVerb = (method, uri) => {
|
|
|
59
151
|
return method;
|
|
60
152
|
};
|
|
61
153
|
|
|
154
|
+
// src/lib/schema-to-component.ts
|
|
155
|
+
var schemaToComponent = (document) => {
|
|
156
|
+
document.components ||= {};
|
|
157
|
+
document.components.schemas ||= {};
|
|
158
|
+
const schemaStrings = [];
|
|
159
|
+
const schemaRef = {};
|
|
160
|
+
let count = 0;
|
|
161
|
+
(function loopSearch(docs) {
|
|
162
|
+
if (typeof docs !== "object")
|
|
163
|
+
return;
|
|
164
|
+
Object.entries(docs).forEach(([key, value]) => {
|
|
165
|
+
if (key !== "schema")
|
|
166
|
+
return loopSearch(value);
|
|
167
|
+
if (!isValidSchemaObject(value))
|
|
168
|
+
return;
|
|
169
|
+
const str = JSON.stringify(value);
|
|
170
|
+
const replace = (ref) => {
|
|
171
|
+
docs[key] = {
|
|
172
|
+
$ref: "#/components/schemas/" + ref
|
|
173
|
+
};
|
|
174
|
+
};
|
|
175
|
+
if (schemaStrings.includes(str)) {
|
|
176
|
+
let ref = schemaRef[str];
|
|
177
|
+
if (typeof ref === "function") {
|
|
178
|
+
const firstReplace = ref;
|
|
179
|
+
const schemaName = Array.isArray(value.type) ? value.type.join("_") : String(value.type);
|
|
180
|
+
ref = document.components.schemas[schemaName] ? schemaName + "_" + ++count : schemaName;
|
|
181
|
+
document.components.schemas[ref] = value;
|
|
182
|
+
schemaRef[str] = ref;
|
|
183
|
+
firstReplace(ref);
|
|
184
|
+
}
|
|
185
|
+
replace(ref);
|
|
186
|
+
} else {
|
|
187
|
+
schemaStrings.push(str);
|
|
188
|
+
schemaRef[str] = replace;
|
|
189
|
+
}
|
|
190
|
+
});
|
|
191
|
+
})(document);
|
|
192
|
+
if (Object.keys(document.components.schemas).length === 0) {
|
|
193
|
+
delete document.components.schemas;
|
|
194
|
+
}
|
|
195
|
+
if (Object.keys(document.components).length === 0) {
|
|
196
|
+
delete document.components;
|
|
197
|
+
}
|
|
198
|
+
};
|
|
199
|
+
var isValidSchemaObject = (value) => {
|
|
200
|
+
return typeof value === "object" && "type" in value && !("$ref" in value);
|
|
201
|
+
};
|
|
202
|
+
|
|
203
|
+
// src/lib/validate.ts
|
|
204
|
+
import stoplight from "@stoplight/spectral-core";
|
|
205
|
+
import { DiagnosticSeverity } from "@stoplight/types";
|
|
206
|
+
import { oas } from "@stoplight/spectral-rulesets";
|
|
207
|
+
var spectral = new stoplight.Spectral();
|
|
208
|
+
spectral.setRuleset({
|
|
209
|
+
extends: oas,
|
|
210
|
+
// https://github.com/stoplightio/spectral/blob/develop/packages/rulesets/src/oas/index.ts
|
|
211
|
+
rules: {
|
|
212
|
+
"info-contact": "off",
|
|
213
|
+
"info-description": "off"
|
|
214
|
+
}
|
|
215
|
+
});
|
|
216
|
+
var validate = async (document) => {
|
|
217
|
+
const result = {
|
|
218
|
+
warnings: [],
|
|
219
|
+
errors: []
|
|
220
|
+
};
|
|
221
|
+
const originResult = await spectral.run(
|
|
222
|
+
document
|
|
223
|
+
);
|
|
224
|
+
originResult.forEach((item) => {
|
|
225
|
+
result[item.severity === DiagnosticSeverity.Error ? "errors" : "warnings"].push({
|
|
226
|
+
path: item.path.map(String),
|
|
227
|
+
message: item.message
|
|
228
|
+
});
|
|
229
|
+
});
|
|
230
|
+
return result;
|
|
231
|
+
};
|
|
232
|
+
|
|
62
233
|
// src/generate-document.ts
|
|
63
234
|
var generateDocument = async (config) => {
|
|
64
235
|
const emitter = config.emitter || new EventEmitter();
|
|
@@ -99,7 +270,7 @@ var generateDocument = async (config) => {
|
|
|
99
270
|
for (const uri of builder.uris) {
|
|
100
271
|
const pathItem = document.paths[normalizePath(uri)] ||= {};
|
|
101
272
|
let methods2 = builder.methods;
|
|
102
|
-
if (methods2.includes(
|
|
273
|
+
if (methods2.includes(METHOD2.GET) && methods2.includes(METHOD2.HEAD)) {
|
|
103
274
|
methods2 = methods2.filter((method) => method !== "HEAD");
|
|
104
275
|
}
|
|
105
276
|
for (const method of methods2) {
|
|
@@ -121,9 +292,9 @@ var generateDocument = async (config) => {
|
|
|
121
292
|
}
|
|
122
293
|
methodItem.tags ||= [getTagByFilename(file)];
|
|
123
294
|
methodItem.operationId ||= snakeCase(
|
|
124
|
-
methodToVerb(method, uri) + " " + uri
|
|
295
|
+
methodToVerb(method, uri) + " " + uri.replaceAll(":", "_by_")
|
|
125
296
|
);
|
|
126
|
-
if (method ===
|
|
297
|
+
if (method === METHOD2.POST) {
|
|
127
298
|
methodItem["x-codegen-request-body-name"] = "body";
|
|
128
299
|
}
|
|
129
300
|
if (Object.keys(methodItem.responses).length === 0) {
|
|
@@ -159,51 +330,13 @@ var generateDocument = async (config) => {
|
|
|
159
330
|
}
|
|
160
331
|
}
|
|
161
332
|
{
|
|
162
|
-
emitter.emit("msg", msg = "Optimize
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
continue;
|
|
170
|
-
const parameter = methodItem.parameters;
|
|
171
|
-
if (!parameter || !parameter.length)
|
|
172
|
-
continue pathLoop;
|
|
173
|
-
parameters.push(parameter);
|
|
174
|
-
}
|
|
175
|
-
if (parameters.length < 2)
|
|
176
|
-
continue pathLoop;
|
|
177
|
-
let intersect = parameters[0];
|
|
178
|
-
for (let i = 1; i < parameters.length; ++i) {
|
|
179
|
-
const parameter = parameters[i];
|
|
180
|
-
intersect = intersect.filter((item) => {
|
|
181
|
-
for (let j = 0; j < parameter.length; ++j) {
|
|
182
|
-
if (equal(parameter[j], item)) {
|
|
183
|
-
parameter[j] = item;
|
|
184
|
-
return true;
|
|
185
|
-
}
|
|
186
|
-
}
|
|
187
|
-
return false;
|
|
188
|
-
});
|
|
189
|
-
if (!intersect.length)
|
|
190
|
-
continue pathLoop;
|
|
191
|
-
}
|
|
192
|
-
path2.parameters = intersect;
|
|
193
|
-
intersect.forEach((item) => {
|
|
194
|
-
for (const parameter of parameters) {
|
|
195
|
-
parameter.splice(
|
|
196
|
-
parameter.findIndex((p) => p === item),
|
|
197
|
-
1
|
|
198
|
-
);
|
|
199
|
-
}
|
|
200
|
-
});
|
|
201
|
-
for (const method of methods) {
|
|
202
|
-
if (path2[method] && !path2[method].parameters.length) {
|
|
203
|
-
delete path2[method].parameters;
|
|
204
|
-
}
|
|
205
|
-
}
|
|
206
|
-
}
|
|
333
|
+
emitter.emit("msg", msg = "Optimize parameters");
|
|
334
|
+
methodParameterToPathParameter(document);
|
|
335
|
+
parameterToComponent(document);
|
|
336
|
+
}
|
|
337
|
+
{
|
|
338
|
+
emitter.emit("msg", msg = "Optimize schemas");
|
|
339
|
+
schemaToComponent(document);
|
|
207
340
|
}
|
|
208
341
|
{
|
|
209
342
|
emitter.emit("msg", msg = "Save to file");
|
|
@@ -238,7 +371,7 @@ var generateDocument = async (config) => {
|
|
|
238
371
|
if (result.warnings?.length) {
|
|
239
372
|
summary.push(`${result.warnings.length} warnings`);
|
|
240
373
|
}
|
|
241
|
-
summary.length && emitter.emit("replace", msg + " " + chalk2.yellow(summary.join("
|
|
374
|
+
summary.length && emitter.emit("replace", msg + " " + chalk2.yellow(summary.join(", ")));
|
|
242
375
|
emitter.emit(
|
|
243
376
|
"end",
|
|
244
377
|
result.errors?.length ? "fail" : result.warnings?.length ? "warn" : "ok"
|
|
@@ -252,9 +385,6 @@ var generateDocument = async (config) => {
|
|
|
252
385
|
}
|
|
253
386
|
};
|
|
254
387
|
};
|
|
255
|
-
var methods = Object.values(METHOD).map(
|
|
256
|
-
(method) => method.toLowerCase()
|
|
257
|
-
);
|
|
258
388
|
var skip = (message) => message + " " + chalk2.gray("[skipped]");
|
|
259
389
|
var normalizePath = (uri) => {
|
|
260
390
|
return uri.replace(/:([a-z0-9_?]+)/gi, (_, $1) => {
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/openapi.ts","../src/openapi-to-help.ts","../src/generate-document.ts","../src/method-to-verb.ts"],"sourcesContent":["import EventEmitter from 'node:events';\nimport { chain, middleware } from '@aomex/core';\nimport ora, { type Ora } from 'ora';\nimport { openapiToHelp } from './openapi-to-help';\nimport {\n generateDocument,\n type OpenapiValidateResultItem,\n type OpenapiOptions,\n type OpenapiValidateResult,\n} from './generate-document';\n\nexport const openapi = (\n options: Omit<OpenapiOptions, 'emitter'> & {\n renderWarnings?: boolean;\n commandName?: string;\n showInHelp?: boolean;\n summary?: string;\n description?: string;\n },\n) => {\n const commandName = options.commandName || 'openapi';\n\n return chain.console\n .mount(\n openapiToHelp(\n commandName,\n options.summary,\n options.description,\n options.showInHelp,\n ),\n )\n .mount(\n middleware.console(async (ctx, next) => {\n if (ctx.request.command !== commandName) return next();\n\n ctx.response.commandMatched = true;\n\n const emitter = new EventEmitter();\n const spinner: Ora = ora();\n\n emitter\n .on('msg', (msg) => {\n if (spinner.isSpinning) spinner.succeed();\n spinner.start(msg);\n })\n .on('replace', (msg) => {\n spinner.text = msg;\n })\n .on('end', (status: string) => {\n if (\n status === 'succeed' ||\n status === 'fail' ||\n status === 'warn'\n ) {\n spinner[status]();\n }\n });\n\n let result: OpenapiValidateResult;\n try {\n result = (await generateDocument({ ...options, emitter })).result;\n } catch (e) {\n spinner.fail();\n throw e;\n }\n\n if (result.errors.length) {\n spinner.indent = 2;\n result.errors.forEach((item) => {\n spinner.fail(formatValidateMessage(item));\n });\n }\n\n if (options.renderWarnings && result.warnings.length) {\n spinner.indent = 2;\n result.warnings.forEach((item) => {\n spinner.warn(formatValidateMessage(item));\n });\n }\n }),\n );\n};\n\nconst formatValidateMessage = (item: OpenapiValidateResultItem) => {\n let pathname = item.path.length ? item.path.join('.') : '';\n return `[${pathname || '.'}] ${item.message}`;\n};\n","import { HelpMiddleware, scriptName } from '@aomex/console';\nimport { middleware } from '@aomex/core';\nimport { chalk } from '@aomex/utility';\n\nexport const openapiToHelp = (\n commandName: string,\n summary?: string,\n description?: string,\n showInHelp: boolean = true,\n): HelpMiddleware =>\n middleware.help(async (ctx, next) => {\n return ctx.cli.config({\n all(yargs) {\n yargs.command(\n chalk.yellow(commandName),\n summary || 'Generate openapi v3 documentation',\n );\n },\n detailCommand: () => showInHelp && ctx.request.command === commandName,\n detail(yargs) {\n yargs.usage(\n `${scriptName} ${commandName} [options]${\n description ? '\\n\\n' + chalk.bold(description) : ''\n }`,\n );\n },\n next,\n });\n });\n","import EventEmitter from 'node:events';\nimport type { Mode } from 'node:fs';\nimport { readPackageUp } from 'read-pkg-up';\nimport snakeCase from 'lodash.snakecase';\nimport equal from 'fast-deep-equal';\nimport { Chain, OpenAPI } from '@aomex/core';\nimport {\n bytes,\n chalk,\n sleep,\n fileToModules,\n type PathToFileOptions,\n pathToFiles,\n} from '@aomex/utility';\nimport { METHOD, WebMiddleware } from '@aomex/web';\nimport { Router } from '@aomex/router';\nimport validate from 'ibm-openapi-validator';\nimport path from 'node:path';\nimport { mkdir, writeFile } from 'node:fs/promises';\nimport yaml from 'yaml';\nimport { methodToVerb } from './method-to-verb';\n\nexport interface OpenapiValidateResultItem {\n path: string[];\n message: string;\n rule: string;\n}\n\nexport interface OpenapiValidateResult {\n errors: OpenapiValidateResultItem[];\n warnings: OpenapiValidateResultItem[];\n}\n\nexport interface OpenapiOptions {\n /**\n * Web api routers\n */\n routers: PathToFileOptions;\n /**\n * Openapi basic information\n * @see OpenApiDocs\n */\n docs?: Omit<OpenAPI.Document, 'paths' | 'openapi' | 'info'> & {\n openapi?: `3.0.${0 | 1 | 2 | 3}`;\n info?: Partial<OpenAPI.Document['info']>;\n };\n /**\n * Save document to specific file (`*.yaml`|`*.json`). Defaults `openapi.json`\n */\n output?: false | string;\n /**\n * File mode. Defaults according system\n * @see OpenapiOptions.output\n */\n fileMode?: Mode;\n /**\n * Format JSON document to human readable. Defaults `false`\n */\n prettyJson?: boolean;\n /**\n * Fix the document by hand after the full document is generated\n */\n fix?: (data: OpenAPI.Document) => void;\n /**\n * Log emitter\n */\n emitter: EventEmitter;\n}\n\nexport const generateDocument = async (\n config: OpenapiOptions,\n): Promise<{\n document: OpenAPI.Document;\n result: OpenapiValidateResult;\n}> => {\n const emitter = config.emitter || new EventEmitter();\n let msg = '';\n\n emitter.emit('start');\n emitter.emit('msg', 'Initialize');\n const document: OpenAPI.Document = JSON.parse(\n JSON.stringify(config.docs || {}),\n );\n\n {\n document.openapi ||= '3.0.3';\n document.tags ||= [];\n document.info ||= { title: '', version: '' };\n document.paths = {};\n document.info.title ||=\n (await readPackageUp())?.packageJson.name || 'API documentation';\n document.info.version ||=\n (await readPackageUp())?.packageJson.version || '0.0.0';\n }\n\n emitter.emit('msg', (msg = 'Search routers'));\n const files = await pathToFiles(config.routers);\n emitter.emit('msg', (msg = 'Parse router'));\n const usedTags: string[] = [];\n for (const file of files) {\n emitter.emit(\n 'replace',\n msg +\n ' ' +\n chalk.gray(\n path\n .relative(process.cwd(), file)\n .split(path.sep)\n .join(path.posix.sep),\n ),\n );\n await sleep(50);\n\n const routers = await fileToModules<Router>(\n [file],\n (item) => !!item && item instanceof Router,\n );\n for (const router of routers) {\n const groupMiddlewareList = Chain.flatten(Router.getChain(router));\n const builders = Router.getBuilders(router);\n\n for (const builder of builders) {\n for (const uri of builder.uris) {\n const pathItem = (document.paths[normalizePath(uri)] ||= {});\n let methods = builder.methods;\n\n if (methods.includes(METHOD.GET) && methods.includes(METHOD.HEAD)) {\n methods = methods.filter((method) => method !== 'HEAD');\n }\n\n for (const method of methods) {\n const methodItem: OpenAPI.OperationObject = (pathItem[\n method.toLowerCase() as `${Lowercase<METHOD>}`\n ] = {\n responses: {},\n ...builder.docs,\n });\n\n for (const middleware of groupMiddlewareList.concat(\n Chain.flatten(builder.chain),\n )) {\n if (middleware instanceof WebMiddleware) {\n middleware.toDocument({\n document,\n pathItem,\n methodName: method,\n methodItem,\n });\n }\n }\n\n methodItem.tags ||= [getTagByFilename(file)];\n methodItem.operationId ||= snakeCase(\n methodToVerb(method, uri) + ' ' + uri,\n );\n\n if (method === METHOD.POST) {\n // @ts-expect-error against warning\n methodItem['x-codegen-request-body-name'] = 'body';\n }\n\n if (Object.keys(methodItem.responses).length === 0) {\n methodItem.responses = {\n default: {\n description: '',\n },\n };\n }\n\n usedTags.push(...methodItem.tags!);\n }\n }\n }\n }\n }\n emitter.emit('replace', msg);\n\n {\n const tags = document.tags!;\n const definedTags = tags.map((item) => item.name);\n for (const tag of [...new Set(usedTags)].sort()) {\n if (!definedTags.includes(tag)) {\n emitter.emit('msg', (msg = `Append tag: ${tag}`));\n tags.push({ name: tag });\n }\n }\n }\n\n {\n emitter.emit('msg', (msg = 'Fix document by hand'));\n if (config.fix) {\n config.fix(document);\n } else {\n emitter.emit('replace', skip(msg));\n }\n }\n\n {\n emitter.emit('msg', (msg = 'Optimize common parameters'));\n pathLoop: for (const path of Object.values(document.paths)) {\n const parameters: OpenAPI.ParameterObject[][] = [];\n for (const method of methods) {\n const methodItem = path?.[method];\n if (!methodItem) continue;\n const parameter = methodItem.parameters as\n | OpenAPI.ParameterObject[]\n | undefined;\n if (!parameter || !parameter.length) continue pathLoop;\n parameters.push(parameter);\n }\n if (parameters.length < 2) continue pathLoop;\n let intersect = parameters[0]!;\n for (let i = 1; i < parameters.length; ++i) {\n const parameter = parameters[i]!;\n intersect = intersect.filter((item) => {\n for (let j = 0; j < parameter.length; ++j) {\n if (equal(parameter[j], item)) {\n parameter[j] = item;\n return true;\n }\n }\n return false;\n });\n if (!intersect.length) continue pathLoop;\n }\n path!.parameters = intersect;\n intersect.forEach((item) => {\n for (const parameter of parameters) {\n parameter.splice(\n parameter.findIndex((p) => p === item),\n 1,\n );\n }\n });\n for (const method of methods) {\n if (path![method] && !path![method]!.parameters!.length) {\n delete path![method]!.parameters;\n }\n }\n }\n }\n\n {\n emitter.emit('msg', (msg = 'Save to file'));\n let distFile: typeof config.output =\n config.output === false ? false : config.output || 'openapi.json';\n if (distFile) {\n distFile = path.resolve(distFile);\n await mkdir(path.dirname(distFile), {\n recursive: true,\n });\n\n const content = ['.yml', '.yaml'].includes(path.extname(distFile))\n ? yaml.stringify(document)\n : JSON.stringify(document, null, config.prettyJson ? 2 : undefined);\n\n await writeFile(distFile, content, {\n mode: config.fileMode,\n });\n const size = bytes(Buffer.byteLength(content), { unitSeparator: '' });\n emitter.emit(\n 'replace',\n msg +\n ': ' +\n path.relative(process.cwd(), distFile) +\n chalk.gray(` [size: ${size}]`),\n true,\n );\n } else {\n emitter.emit('replace', skip(msg));\n }\n }\n\n let result: OpenapiValidateResult;\n {\n emitter.emit('msg', (msg = 'Validate'));\n result = (await validate(document)) as OpenapiValidateResult;\n const summary: string[] = [];\n if (result.errors?.length) {\n summary.push(`${result.errors.length} errors`);\n }\n if (result.warnings?.length) {\n summary.push(`${result.warnings.length} warnings`);\n }\n summary.length &&\n emitter.emit('replace', msg + ' ' + chalk.yellow(summary.join(',')));\n\n emitter.emit(\n 'end',\n result.errors?.length ? 'fail' : result.warnings?.length ? 'warn' : 'ok',\n );\n }\n\n return {\n document: JSON.parse(JSON.stringify(document)),\n result: {\n errors: result.errors || [],\n warnings: result.warnings || [],\n },\n };\n};\n\nconst methods = Object.values(METHOD).map((method) =>\n method.toLowerCase(),\n) as OpenAPI.HttpMethods[];\n\nconst skip = (message: string) => message + ' ' + chalk.gray('[skipped]');\n\nconst normalizePath = (uri: string) => {\n return uri.replace(/:([a-z0-9_?]+)/gi, (_, $1) => {\n return `{${$1.replace(/[?]/g, '')}}`;\n });\n};\n\nconst getTagByFilename = (file: string) => {\n return path.basename(file).replace(/\\..+$/, '');\n};\n","// Explain filed `operationId` to against ibm-openapi-validator warning\nexport const methodToVerb = (method: string, uri: string) => {\n method = method.toLowerCase();\n\n if (method === 'get' && !uri.includes(':')) return 'list';\n if (method === 'post') return 'create';\n if (method === 'put') return 'replace';\n if (method === 'patch') return 'update';\n return method;\n};\n"],"mappings":";AAAA,OAAOA,mBAAkB;AACzB,SAAS,OAAO,cAAAC,mBAAkB;AAClC,OAAO,SAAuB;;;ACF9B,SAAyB,kBAAkB;AAC3C,SAAS,kBAAkB;AAC3B,SAAS,aAAa;AAEf,IAAM,gBAAgB,CAC3B,aACA,SACA,aACA,aAAsB,SAEtB,WAAW,KAAK,OAAO,KAAK,SAAS;AACnC,SAAO,IAAI,IAAI,OAAO;AAAA,IACpB,IAAI,OAAO;AACT,YAAM;AAAA,QACJ,MAAM,OAAO,WAAW;AAAA,QACxB,WAAW;AAAA,MACb;AAAA,IACF;AAAA,IACA,eAAe,MAAM,cAAc,IAAI,QAAQ,YAAY;AAAA,IAC3D,OAAO,OAAO;AACZ,YAAM;AAAA,QACJ,GAAG,cAAc,wBACf,cAAc,SAAS,MAAM,KAAK,WAAW,IAAI;AAAA,MAErD;AAAA,IACF;AAAA,IACA;AAAA,EACF,CAAC;AACH,CAAC;;;AC5BH,OAAO,kBAAkB;AAEzB,SAAS,qBAAqB;AAC9B,OAAO,eAAe;AACtB,OAAO,WAAW;AAClB,SAAS,aAAsB;AAC/B;AAAA,EACE;AAAA,EACA,SAAAC;AAAA,EACA;AAAA,EACA;AAAA,EAEA;AAAA,OACK;AACP,SAAS,QAAQ,qBAAqB;AACtC,SAAS,cAAc;AACvB,OAAO,cAAc;AACrB,OAAO,UAAU;AACjB,SAAS,OAAO,iBAAiB;AACjC,OAAO,UAAU;;;AClBV,IAAM,eAAe,CAAC,QAAgB,QAAgB;AAC3D,WAAS,OAAO,YAAY;AAE5B,MAAI,WAAW,SAAS,CAAC,IAAI,SAAS,GAAG;AAAG,WAAO;AACnD,MAAI,WAAW;AAAQ,WAAO;AAC9B,MAAI,WAAW;AAAO,WAAO;AAC7B,MAAI,WAAW;AAAS,WAAO;AAC/B,SAAO;AACT;;;AD4DO,IAAM,mBAAmB,OAC9B,WAII;AACJ,QAAM,UAAU,OAAO,WAAW,IAAI,aAAa;AACnD,MAAI,MAAM;AAEV,UAAQ,KAAK,OAAO;AACpB,UAAQ,KAAK,OAAO,YAAY;AAChC,QAAM,WAA6B,KAAK;AAAA,IACtC,KAAK,UAAU,OAAO,QAAQ,CAAC,CAAC;AAAA,EAClC;AAEA;AACE,aAAS,YAAY;AACrB,aAAS,SAAS,CAAC;AACnB,aAAS,SAAS,EAAE,OAAO,IAAI,SAAS,GAAG;AAC3C,aAAS,QAAQ,CAAC;AAClB,aAAS,KAAK,WACX,MAAM,cAAc,IAAI,YAAY,QAAQ;AAC/C,aAAS,KAAK,aACX,MAAM,cAAc,IAAI,YAAY,WAAW;AAAA,EACpD;AAEA,UAAQ,KAAK,OAAQ,MAAM,gBAAiB;AAC5C,QAAM,QAAQ,MAAM,YAAY,OAAO,OAAO;AAC9C,UAAQ,KAAK,OAAQ,MAAM,cAAe;AAC1C,QAAM,WAAqB,CAAC;AAC5B,aAAW,QAAQ,OAAO;AACxB,YAAQ;AAAA,MACN;AAAA,MACA,MACE,MACAC,OAAM;AAAA,QACJ,KACG,SAAS,QAAQ,IAAI,GAAG,IAAI,EAC5B,MAAM,KAAK,GAAG,EACd,KAAK,KAAK,MAAM,GAAG;AAAA,MACxB;AAAA,IACJ;AACA,UAAM,MAAM,EAAE;AAEd,UAAM,UAAU,MAAM;AAAA,MACpB,CAAC,IAAI;AAAA,MACL,CAAC,SAAS,CAAC,CAAC,QAAQ,gBAAgB;AAAA,IACtC;AACA,eAAW,UAAU,SAAS;AAC5B,YAAM,sBAAsB,MAAM,QAAQ,OAAO,SAAS,MAAM,CAAC;AACjE,YAAM,WAAW,OAAO,YAAY,MAAM;AAE1C,iBAAW,WAAW,UAAU;AAC9B,mBAAW,OAAO,QAAQ,MAAM;AAC9B,gBAAM,WAAY,SAAS,MAAM,cAAc,GAAG,CAAC,MAAM,CAAC;AAC1D,cAAIC,WAAU,QAAQ;AAEtB,cAAIA,SAAQ,SAAS,OAAO,GAAG,KAAKA,SAAQ,SAAS,OAAO,IAAI,GAAG;AACjE,YAAAA,WAAUA,SAAQ,OAAO,CAAC,WAAW,WAAW,MAAM;AAAA,UACxD;AAEA,qBAAW,UAAUA,UAAS;AAC5B,kBAAM,aAAuC,SAC3C,OAAO,YAAY,CACrB,IAAI;AAAA,cACF,WAAW,CAAC;AAAA,cACZ,GAAG,QAAQ;AAAA,YACb;AAEA,uBAAWC,eAAc,oBAAoB;AAAA,cAC3C,MAAM,QAAQ,QAAQ,KAAK;AAAA,YAC7B,GAAG;AACD,kBAAIA,uBAAsB,eAAe;AACvC,gBAAAA,YAAW,WAAW;AAAA,kBACpB;AAAA,kBACA;AAAA,kBACA,YAAY;AAAA,kBACZ;AAAA,gBACF,CAAC;AAAA,cACH;AAAA,YACF;AAEA,uBAAW,SAAS,CAAC,iBAAiB,IAAI,CAAC;AAC3C,uBAAW,gBAAgB;AAAA,cACzB,aAAa,QAAQ,GAAG,IAAI,MAAM;AAAA,YACpC;AAEA,gBAAI,WAAW,OAAO,MAAM;AAE1B,yBAAW,6BAA6B,IAAI;AAAA,YAC9C;AAEA,gBAAI,OAAO,KAAK,WAAW,SAAS,EAAE,WAAW,GAAG;AAClD,yBAAW,YAAY;AAAA,gBACrB,SAAS;AAAA,kBACP,aAAa;AAAA,gBACf;AAAA,cACF;AAAA,YACF;AAEA,qBAAS,KAAK,GAAG,WAAW,IAAK;AAAA,UACnC;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACA,UAAQ,KAAK,WAAW,GAAG;AAE3B;AACE,UAAM,OAAO,SAAS;AACtB,UAAM,cAAc,KAAK,IAAI,CAAC,SAAS,KAAK,IAAI;AAChD,eAAW,OAAO,CAAC,GAAG,IAAI,IAAI,QAAQ,CAAC,EAAE,KAAK,GAAG;AAC/C,UAAI,CAAC,YAAY,SAAS,GAAG,GAAG;AAC9B,gBAAQ,KAAK,OAAQ,MAAM,eAAe,KAAM;AAChD,aAAK,KAAK,EAAE,MAAM,IAAI,CAAC;AAAA,MACzB;AAAA,IACF;AAAA,EACF;AAEA;AACE,YAAQ,KAAK,OAAQ,MAAM,sBAAuB;AAClD,QAAI,OAAO,KAAK;AACd,aAAO,IAAI,QAAQ;AAAA,IACrB,OAAO;AACL,cAAQ,KAAK,WAAW,KAAK,GAAG,CAAC;AAAA,IACnC;AAAA,EACF;AAEA;AACE,YAAQ,KAAK,OAAQ,MAAM,4BAA6B;AACxD;AAAU,iBAAWC,SAAQ,OAAO,OAAO,SAAS,KAAK,GAAG;AAC1D,cAAM,aAA0C,CAAC;AACjD,mBAAW,UAAU,SAAS;AAC5B,gBAAM,aAAaA,QAAO,MAAM;AAChC,cAAI,CAAC;AAAY;AACjB,gBAAM,YAAY,WAAW;AAG7B,cAAI,CAAC,aAAa,CAAC,UAAU;AAAQ,qBAAS;AAC9C,qBAAW,KAAK,SAAS;AAAA,QAC3B;AACA,YAAI,WAAW,SAAS;AAAG,mBAAS;AACpC,YAAI,YAAY,WAAW,CAAC;AAC5B,iBAAS,IAAI,GAAG,IAAI,WAAW,QAAQ,EAAE,GAAG;AAC1C,gBAAM,YAAY,WAAW,CAAC;AAC9B,sBAAY,UAAU,OAAO,CAAC,SAAS;AACrC,qBAAS,IAAI,GAAG,IAAI,UAAU,QAAQ,EAAE,GAAG;AACzC,kBAAI,MAAM,UAAU,CAAC,GAAG,IAAI,GAAG;AAC7B,0BAAU,CAAC,IAAI;AACf,uBAAO;AAAA,cACT;AAAA,YACF;AACA,mBAAO;AAAA,UACT,CAAC;AACD,cAAI,CAAC,UAAU;AAAQ,qBAAS;AAAA,QAClC;AACA,QAAAA,MAAM,aAAa;AACnB,kBAAU,QAAQ,CAAC,SAAS;AAC1B,qBAAW,aAAa,YAAY;AAClC,sBAAU;AAAA,cACR,UAAU,UAAU,CAAC,MAAM,MAAM,IAAI;AAAA,cACrC;AAAA,YACF;AAAA,UACF;AAAA,QACF,CAAC;AACD,mBAAW,UAAU,SAAS;AAC5B,cAAIA,MAAM,MAAM,KAAK,CAACA,MAAM,MAAM,EAAG,WAAY,QAAQ;AACvD,mBAAOA,MAAM,MAAM,EAAG;AAAA,UACxB;AAAA,QACF;AAAA,MACF;AAAA,EACF;AAEA;AACE,YAAQ,KAAK,OAAQ,MAAM,cAAe;AAC1C,QAAI,WACF,OAAO,WAAW,QAAQ,QAAQ,OAAO,UAAU;AACrD,QAAI,UAAU;AACZ,iBAAW,KAAK,QAAQ,QAAQ;AAChC,YAAM,MAAM,KAAK,QAAQ,QAAQ,GAAG;AAAA,QAClC,WAAW;AAAA,MACb,CAAC;AAED,YAAM,UAAU,CAAC,QAAQ,OAAO,EAAE,SAAS,KAAK,QAAQ,QAAQ,CAAC,IAC7D,KAAK,UAAU,QAAQ,IACvB,KAAK,UAAU,UAAU,MAAM,OAAO,aAAa,IAAI,MAAS;AAEpE,YAAM,UAAU,UAAU,SAAS;AAAA,QACjC,MAAM,OAAO;AAAA,MACf,CAAC;AACD,YAAM,OAAO,MAAM,OAAO,WAAW,OAAO,GAAG,EAAE,eAAe,GAAG,CAAC;AACpE,cAAQ;AAAA,QACN;AAAA,QACA,MACE,OACA,KAAK,SAAS,QAAQ,IAAI,GAAG,QAAQ,IACrCH,OAAM,KAAK,WAAW,OAAO;AAAA,QAC/B;AAAA,MACF;AAAA,IACF,OAAO;AACL,cAAQ,KAAK,WAAW,KAAK,GAAG,CAAC;AAAA,IACnC;AAAA,EACF;AAEA,MAAI;AACJ;AACE,YAAQ,KAAK,OAAQ,MAAM,UAAW;AACtC,aAAU,MAAM,SAAS,QAAQ;AACjC,UAAM,UAAoB,CAAC;AAC3B,QAAI,OAAO,QAAQ,QAAQ;AACzB,cAAQ,KAAK,GAAG,OAAO,OAAO,eAAe;AAAA,IAC/C;AACA,QAAI,OAAO,UAAU,QAAQ;AAC3B,cAAQ,KAAK,GAAG,OAAO,SAAS,iBAAiB;AAAA,IACnD;AACA,YAAQ,UACN,QAAQ,KAAK,WAAW,MAAM,MAAMA,OAAM,OAAO,QAAQ,KAAK,QAAG,CAAC,CAAC;AAErE,YAAQ;AAAA,MACN;AAAA,MACA,OAAO,QAAQ,SAAS,SAAS,OAAO,UAAU,SAAS,SAAS;AAAA,IACtE;AAAA,EACF;AAEA,SAAO;AAAA,IACL,UAAU,KAAK,MAAM,KAAK,UAAU,QAAQ,CAAC;AAAA,IAC7C,QAAQ;AAAA,MACN,QAAQ,OAAO,UAAU,CAAC;AAAA,MAC1B,UAAU,OAAO,YAAY,CAAC;AAAA,IAChC;AAAA,EACF;AACF;AAEA,IAAM,UAAU,OAAO,OAAO,MAAM,EAAE;AAAA,EAAI,CAAC,WACzC,OAAO,YAAY;AACrB;AAEA,IAAM,OAAO,CAAC,YAAoB,UAAU,MAAMA,OAAM,KAAK,WAAW;AAExE,IAAM,gBAAgB,CAAC,QAAgB;AACrC,SAAO,IAAI,QAAQ,oBAAoB,CAAC,GAAG,OAAO;AAChD,WAAO,IAAI,GAAG,QAAQ,QAAQ,EAAE;AAAA,EAClC,CAAC;AACH;AAEA,IAAM,mBAAmB,CAAC,SAAiB;AACzC,SAAO,KAAK,SAAS,IAAI,EAAE,QAAQ,SAAS,EAAE;AAChD;;;AFjTO,IAAM,UAAU,CACrB,YAOG;AACH,QAAM,cAAc,QAAQ,eAAe;AAE3C,SAAO,MAAM,QACV;AAAA,IACC;AAAA,MACE;AAAA,MACA,QAAQ;AAAA,MACR,QAAQ;AAAA,MACR,QAAQ;AAAA,IACV;AAAA,EACF,EACC;AAAA,IACCI,YAAW,QAAQ,OAAO,KAAK,SAAS;AACtC,UAAI,IAAI,QAAQ,YAAY;AAAa,eAAO,KAAK;AAErD,UAAI,SAAS,iBAAiB;AAE9B,YAAM,UAAU,IAAIC,cAAa;AACjC,YAAM,UAAe,IAAI;AAEzB,cACG,GAAG,OAAO,CAAC,QAAQ;AAClB,YAAI,QAAQ;AAAY,kBAAQ,QAAQ;AACxC,gBAAQ,MAAM,GAAG;AAAA,MACnB,CAAC,EACA,GAAG,WAAW,CAAC,QAAQ;AACtB,gBAAQ,OAAO;AAAA,MACjB,CAAC,EACA,GAAG,OAAO,CAAC,WAAmB;AAC7B,YACE,WAAW,aACX,WAAW,UACX,WAAW,QACX;AACA,kBAAQ,MAAM,EAAE;AAAA,QAClB;AAAA,MACF,CAAC;AAEH,UAAI;AACJ,UAAI;AACF,kBAAU,MAAM,iBAAiB,EAAE,GAAG,SAAS,QAAQ,CAAC,GAAG;AAAA,MAC7D,SAAS,GAAP;AACA,gBAAQ,KAAK;AACb,cAAM;AAAA,MACR;AAEA,UAAI,OAAO,OAAO,QAAQ;AACxB,gBAAQ,SAAS;AACjB,eAAO,OAAO,QAAQ,CAAC,SAAS;AAC9B,kBAAQ,KAAK,sBAAsB,IAAI,CAAC;AAAA,QAC1C,CAAC;AAAA,MACH;AAEA,UAAI,QAAQ,kBAAkB,OAAO,SAAS,QAAQ;AACpD,gBAAQ,SAAS;AACjB,eAAO,SAAS,QAAQ,CAAC,SAAS;AAChC,kBAAQ,KAAK,sBAAsB,IAAI,CAAC;AAAA,QAC1C,CAAC;AAAA,MACH;AAAA,IACF,CAAC;AAAA,EACH;AACJ;AAEA,IAAM,wBAAwB,CAAC,SAAoC;AACjE,MAAI,WAAW,KAAK,KAAK,SAAS,KAAK,KAAK,KAAK,GAAG,IAAI;AACxD,SAAO,IAAI,YAAY,QAAQ,KAAK;AACtC;","names":["EventEmitter","middleware","chalk","chalk","methods","middleware","path","middleware","EventEmitter"]}
|
|
1
|
+
{"version":3,"sources":["../src/openapi.ts","../src/openapi-to-help.ts","../src/generate-document.ts","../src/lib/parameter.ts","../src/lib/method-to-verb.ts","../src/lib/schema-to-component.ts","../src/lib/validate.ts"],"sourcesContent":["import EventEmitter from 'node:events';\nimport { chain, middleware } from '@aomex/core';\nimport ora, { type Ora } from 'ora';\nimport { openapiToHelp } from './openapi-to-help';\nimport { generateDocument, type OpenapiOptions } from './generate-document';\nimport type { OpenapiValidateResult, OpenapiValidateResultItem } from './lib';\n\nexport const openapi = (\n options: Omit<OpenapiOptions, 'emitter'> & {\n renderWarnings?: boolean;\n commandName?: string;\n showInHelp?: boolean;\n summary?: string;\n description?: string;\n },\n) => {\n const commandName = options.commandName || 'openapi';\n\n return chain.console\n .mount(\n openapiToHelp(\n commandName,\n options.summary,\n options.description,\n options.showInHelp,\n ),\n )\n .mount(\n middleware.console(async (ctx, next) => {\n if (ctx.request.command !== commandName) return next();\n\n ctx.response.commandMatched = true;\n\n const emitter = new EventEmitter();\n const spinner: Ora = ora();\n\n emitter\n .on('msg', (msg) => {\n if (spinner.isSpinning) spinner.succeed();\n spinner.start(msg);\n })\n .on('replace', (msg) => {\n spinner.text = msg;\n })\n .on('end', (status: string) => {\n if (\n status === 'succeed' ||\n status === 'fail' ||\n status === 'warn'\n ) {\n spinner[status]();\n }\n });\n\n let result: OpenapiValidateResult;\n try {\n result = (await generateDocument({ ...options, emitter })).result;\n } catch (e) {\n spinner.fail();\n throw e;\n }\n\n if (result.errors.length) {\n spinner.indent = 2;\n result.errors.forEach((item) => {\n spinner.fail(formatValidateMessage(item));\n });\n }\n\n if (options.renderWarnings && result.warnings.length) {\n spinner.indent = 2;\n result.warnings.forEach((item) => {\n spinner.warn(formatValidateMessage(item));\n });\n }\n }),\n );\n};\n\nconst formatValidateMessage = (item: OpenapiValidateResultItem) => {\n let pathname = item.path.length ? item.path.join('.') : '';\n return `[${pathname || '.'}] ${item.message}`;\n};\n","import { HelpMiddleware, scriptName } from '@aomex/console';\nimport { middleware } from '@aomex/core';\nimport { chalk } from '@aomex/utility';\n\nexport const openapiToHelp = (\n commandName: string,\n summary?: string,\n description?: string,\n showInHelp: boolean = true,\n): HelpMiddleware =>\n middleware.help(async (ctx, next) => {\n return ctx.cli.config({\n all(yargs) {\n yargs.command(\n chalk.yellow(commandName),\n summary || 'Generate openapi v3 documentation',\n );\n },\n detailCommand: () => showInHelp && ctx.request.command === commandName,\n detail(yargs) {\n yargs.usage(\n `${scriptName} ${commandName} [options]${\n description ? '\\n\\n' + chalk.bold(description) : ''\n }`,\n );\n },\n next,\n });\n });\n","import EventEmitter from 'node:events';\nimport type { Mode } from 'node:fs';\nimport { readPackageUp } from 'read-pkg-up';\nimport snakeCase from 'lodash.snakecase';\nimport { Chain, OpenAPI } from '@aomex/core';\nimport {\n bytes,\n chalk,\n sleep,\n fileToModules,\n type PathToFileOptions,\n pathToFiles,\n} from '@aomex/utility';\nimport { METHOD, WebMiddleware } from '@aomex/web';\nimport { Router } from '@aomex/router';\nimport path from 'node:path';\nimport { mkdir, writeFile } from 'node:fs/promises';\nimport yaml from 'yaml';\nimport {\n methodParameterToPathParameter,\n parameterToComponent,\n} from './lib/parameter';\nimport {\n methodToVerb,\n type OpenapiValidateResult,\n schemaToComponent,\n validate,\n} from './lib';\n\nexport interface OpenapiOptions {\n /**\n * Web api routers\n */\n routers: PathToFileOptions;\n /**\n * Openapi basic information\n * @see OpenApiDocs\n */\n docs?: Omit<OpenAPI.Document, 'paths' | 'openapi' | 'info'> & {\n openapi?: `3.0.${0 | 1 | 2 | 3}`;\n info?: Partial<OpenAPI.Document['info']>;\n };\n /**\n * Save document to specific file (`*.yaml`|`*.json`). Defaults `openapi.json`\n */\n output?: false | string;\n /**\n * File mode. Defaults according system\n * @see OpenapiOptions.output\n */\n fileMode?: Mode;\n /**\n * Format JSON document to human readable. Defaults `false`\n */\n prettyJson?: boolean;\n /**\n * Fix the document by hand after the full document is generated\n */\n fix?: (data: OpenAPI.Document) => void;\n /**\n * Log emitter\n */\n emitter: EventEmitter;\n}\n\nexport const generateDocument = async (\n config: OpenapiOptions,\n): Promise<{\n document: OpenAPI.Document;\n result: OpenapiValidateResult;\n}> => {\n const emitter = config.emitter || new EventEmitter();\n let msg = '';\n\n emitter.emit('start');\n emitter.emit('msg', 'Initialize');\n const document: OpenAPI.Document = JSON.parse(\n JSON.stringify(config.docs || {}),\n );\n\n {\n document.openapi ||= '3.0.3';\n document.tags ||= [];\n document.info ||= { title: '', version: '' };\n document.paths = {};\n document.info.title ||=\n (await readPackageUp())?.packageJson.name || 'API documentation';\n document.info.version ||=\n (await readPackageUp())?.packageJson.version || '0.0.0';\n }\n\n emitter.emit('msg', (msg = 'Search routers'));\n const files = await pathToFiles(config.routers);\n emitter.emit('msg', (msg = 'Parse router'));\n const usedTags: string[] = [];\n for (const file of files) {\n emitter.emit(\n 'replace',\n msg +\n ' ' +\n chalk.gray(\n path\n .relative(process.cwd(), file)\n .split(path.sep)\n .join(path.posix.sep),\n ),\n );\n await sleep(50);\n\n const routers = await fileToModules<Router>(\n [file],\n (item) => !!item && item instanceof Router,\n );\n for (const router of routers) {\n const groupMiddlewareList = Chain.flatten(Router.getChain(router));\n const builders = Router.getBuilders(router);\n\n for (const builder of builders) {\n for (const uri of builder.uris) {\n const pathItem = (document.paths[normalizePath(uri)] ||= {});\n let methods = builder.methods;\n\n if (methods.includes(METHOD.GET) && methods.includes(METHOD.HEAD)) {\n methods = methods.filter((method) => method !== 'HEAD');\n }\n\n for (const method of methods) {\n const methodItem: OpenAPI.OperationObject = (pathItem[\n method.toLowerCase() as `${Lowercase<METHOD>}`\n ] = {\n responses: {},\n ...builder.docs,\n });\n\n for (const middleware of groupMiddlewareList.concat(\n Chain.flatten(builder.chain),\n )) {\n if (middleware instanceof WebMiddleware) {\n middleware.toDocument({\n document,\n pathItem,\n methodName: method,\n methodItem,\n });\n }\n }\n\n methodItem.tags ||= [getTagByFilename(file)];\n methodItem.operationId ||= snakeCase(\n methodToVerb(method, uri) + ' ' + uri.replaceAll(':', '_by_'),\n );\n\n if (method === METHOD.POST) {\n // @ts-expect-error against warning\n methodItem['x-codegen-request-body-name'] = 'body';\n }\n\n if (Object.keys(methodItem.responses).length === 0) {\n methodItem.responses = {\n default: {\n description: '',\n },\n };\n }\n\n usedTags.push(...methodItem.tags!);\n }\n }\n }\n }\n }\n emitter.emit('replace', msg);\n\n {\n const tags = document.tags!;\n const definedTags = tags.map((item) => item.name);\n for (const tag of [...new Set(usedTags)].sort()) {\n if (!definedTags.includes(tag)) {\n emitter.emit('msg', (msg = `Append tag: ${tag}`));\n tags.push({ name: tag });\n }\n }\n }\n\n {\n emitter.emit('msg', (msg = 'Fix document by hand'));\n if (config.fix) {\n config.fix(document);\n } else {\n emitter.emit('replace', skip(msg));\n }\n }\n\n {\n emitter.emit('msg', (msg = 'Optimize parameters'));\n methodParameterToPathParameter(document);\n parameterToComponent(document);\n }\n\n {\n emitter.emit('msg', (msg = 'Optimize schemas'));\n schemaToComponent(document);\n }\n\n {\n emitter.emit('msg', (msg = 'Save to file'));\n let distFile: typeof config.output =\n config.output === false ? false : config.output || 'openapi.json';\n if (distFile) {\n distFile = path.resolve(distFile);\n await mkdir(path.dirname(distFile), {\n recursive: true,\n });\n\n const content = ['.yml', '.yaml'].includes(path.extname(distFile))\n ? yaml.stringify(document)\n : JSON.stringify(document, null, config.prettyJson ? 2 : undefined);\n\n await writeFile(distFile, content, {\n mode: config.fileMode,\n });\n const size = bytes(Buffer.byteLength(content), { unitSeparator: '' });\n emitter.emit(\n 'replace',\n msg +\n ': ' +\n path.relative(process.cwd(), distFile) +\n chalk.gray(` [size: ${size}]`),\n true,\n );\n } else {\n emitter.emit('replace', skip(msg));\n }\n }\n\n let result: OpenapiValidateResult;\n {\n emitter.emit('msg', (msg = 'Validate'));\n result = await validate(document);\n const summary: string[] = [];\n if (result.errors?.length) {\n summary.push(`${result.errors.length} errors`);\n }\n if (result.warnings?.length) {\n summary.push(`${result.warnings.length} warnings`);\n }\n summary.length &&\n emitter.emit('replace', msg + ' ' + chalk.yellow(summary.join(', ')));\n emitter.emit(\n 'end',\n result.errors?.length ? 'fail' : result.warnings?.length ? 'warn' : 'ok',\n );\n }\n\n return {\n document: JSON.parse(JSON.stringify(document)),\n result: {\n errors: result.errors || [],\n warnings: result.warnings || [],\n },\n };\n};\n\nconst skip = (message: string) => message + ' ' + chalk.gray('[skipped]');\n\nconst normalizePath = (uri: string) => {\n return uri.replace(/:([a-z0-9_?]+)/gi, (_, $1) => {\n return `{${$1.replace(/[?]/g, '')}}`;\n });\n};\n\nconst getTagByFilename = (file: string) => {\n return path.basename(file).replace(/\\..+$/, '');\n};\n","import type { OpenAPI } from '@aomex/core';\nimport { METHOD } from '@aomex/web';\n\nexport const parameterToComponent = (document: OpenAPI.Document) => {\n const parametersStringify: string[] = [];\n const parametersRef = new Map<string, string | ((ref: string) => void)>();\n let count = 0;\n document.components ||= {};\n document.components.parameters ||= {};\n\n const parser = (\n parameter: OpenAPI.ParameterObject | OpenAPI.ReferenceObject,\n index: number,\n arr: (OpenAPI.ParameterObject | OpenAPI.ReferenceObject)[],\n ) => {\n if ('$ref' in parameter) return;\n const str = JSON.stringify(parameter);\n const replace = (ref: string) => {\n arr[index] = {\n $ref: '#/components/parameters/' + ref,\n };\n };\n if (parametersStringify.includes(str)) {\n let ref = parametersRef.get(str)!;\n if (typeof ref === 'function') {\n const firstReplace = ref;\n const name = (parameter as OpenAPI.ParameterObject).name;\n ref = document.components!.parameters![name]\n ? name + '_' + ++count\n : name;\n document.components!.parameters![ref] = parameter;\n parametersRef.set(str, ref);\n firstReplace(ref);\n }\n replace(ref);\n } else {\n parametersStringify.push(str);\n parametersRef.set(str, replace);\n }\n };\n\n for (const path of Object.values(document.paths)) {\n path!.parameters?.forEach(parser);\n for (const method of methods) {\n const methodItem = path![method];\n if (!methodItem || !methodItem.parameters) continue;\n methodItem.parameters.forEach(parser);\n }\n }\n\n if (Object.keys(document.components.parameters).length === 0) {\n delete document.components.parameters;\n }\n\n if (Object.keys(document.components).length === 0) {\n delete document.components;\n }\n};\n\nexport const methodParameterToPathParameter = (document: OpenAPI.Document) => {\n pathLoop: for (const path of Object.values(document.paths)) {\n const parametersCallback: Record<string, Function[]> = {};\n let index = 0;\n for (const method of methods) {\n const methodItem = path![method];\n if (!methodItem) continue;\n if (!methodItem.parameters?.length) continue pathLoop;\n ++index;\n methodItem.parameters.forEach((parameter, index, arr) => {\n const str = JSON.stringify(parameter);\n // Make sure it's unique\n parameter = arr[index] = JSON.parse(str);\n parametersCallback[str] ||= [];\n parametersCallback[str]!.push(() => {\n arr.splice(\n arr.findIndex((item) => item === parameter),\n 1,\n );\n if (!arr.length) {\n delete methodItem.parameters;\n }\n });\n });\n }\n if (index < 2) continue pathLoop;\n Object.entries(parametersCallback).forEach(([key, callbacks]) => {\n if (callbacks.length !== index) return;\n path!.parameters ||= [];\n path!.parameters.push(JSON.parse(key));\n callbacks.forEach((callback) => callback());\n });\n if (path!.parameters && !path!.parameters.length) {\n delete path!.parameters;\n }\n }\n};\n\nconst methods = Object.values(METHOD).map((method) =>\n method.toLowerCase(),\n) as OpenAPI.HttpMethods[];\n","export const methodToVerb = (method: string, uri: string) => {\n method = method.toLowerCase();\n\n if (method === 'get' && !uri.includes(':')) return 'list';\n if (method === 'post') return 'create';\n if (method === 'put') return 'replace';\n if (method === 'patch') return 'update';\n return method;\n};\n","import type { OpenAPI } from '@aomex/core';\n\nexport const schemaToComponent = (document: OpenAPI.Document) => {\n document.components ||= {};\n document.components.schemas ||= {};\n const schemaStrings: string[] = [];\n const schemaRef: Record<string, string | ((ref: string) => void)> = {};\n let count = 0;\n\n (function loopSearch(docs: Record<string, any>) {\n if (typeof docs !== 'object') return;\n Object.entries(docs).forEach(([key, value]) => {\n if (key !== 'schema') return loopSearch(value);\n if (!isValidSchemaObject(value)) return;\n const str = JSON.stringify(value);\n const replace = (ref: string) => {\n docs[key] = <OpenAPI.ReferenceObject>{\n $ref: '#/components/schemas/' + ref,\n };\n };\n if (schemaStrings.includes(str)) {\n let ref = schemaRef[str]!;\n if (typeof ref === 'function') {\n const firstReplace = ref;\n const schemaName = Array.isArray(value.type)\n ? value.type.join('_')\n : String(value.type);\n ref = document.components!.schemas![schemaName]\n ? schemaName + '_' + ++count\n : schemaName;\n document.components!.schemas![ref] = value;\n schemaRef[str] = ref;\n firstReplace(ref);\n }\n replace(ref);\n } else {\n schemaStrings.push(str);\n schemaRef[str] = replace;\n }\n });\n })(document);\n\n if (Object.keys(document.components.schemas).length === 0) {\n delete document.components.schemas;\n }\n if (Object.keys(document.components).length === 0) {\n delete document.components;\n }\n};\n\nconst isValidSchemaObject = (value: any): value is OpenAPI.SchemaObject => {\n return typeof value === 'object' && 'type' in value && !('$ref' in value);\n};\n","import type { OpenAPI } from '@aomex/core';\nimport stoplight, { type RulesetDefinition } from '@stoplight/spectral-core';\nimport { DiagnosticSeverity } from '@stoplight/types';\nimport { oas } from '@stoplight/spectral-rulesets';\n\nconst spectral = new stoplight.Spectral();\nspectral.setRuleset({\n extends: oas as RulesetDefinition,\n // https://github.com/stoplightio/spectral/blob/develop/packages/rulesets/src/oas/index.ts\n rules: {\n 'info-contact': 'off',\n 'info-description': 'off',\n },\n});\n\nexport interface OpenapiValidateResultItem {\n path: string[];\n message: string;\n}\n\nexport interface OpenapiValidateResult {\n errors: OpenapiValidateResultItem[];\n warnings: OpenapiValidateResultItem[];\n}\n\nexport const validate = async (document: OpenAPI.Document) => {\n const result: OpenapiValidateResult = {\n warnings: [],\n errors: [],\n };\n const originResult = await spectral.run(\n document as unknown as Record<string, unknown>,\n );\n originResult.forEach((item) => {\n result[\n item.severity === DiagnosticSeverity.Error ? 'errors' : 'warnings'\n ].push({\n path: item.path.map(String),\n message: item.message,\n });\n });\n return result;\n};\n"],"mappings":";AAAA,OAAOA,mBAAkB;AACzB,SAAS,OAAO,cAAAC,mBAAkB;AAClC,OAAO,SAAuB;;;ACF9B,SAAyB,kBAAkB;AAC3C,SAAS,kBAAkB;AAC3B,SAAS,aAAa;AAEf,IAAM,gBAAgB,CAC3B,aACA,SACA,aACA,aAAsB,SAEtB,WAAW,KAAK,OAAO,KAAK,SAAS;AACnC,SAAO,IAAI,IAAI,OAAO;AAAA,IACpB,IAAI,OAAO;AACT,YAAM;AAAA,QACJ,MAAM,OAAO,WAAW;AAAA,QACxB,WAAW;AAAA,MACb;AAAA,IACF;AAAA,IACA,eAAe,MAAM,cAAc,IAAI,QAAQ,YAAY;AAAA,IAC3D,OAAO,OAAO;AACZ,YAAM;AAAA,QACJ,GAAG,cAAc,wBACf,cAAc,SAAS,MAAM,KAAK,WAAW,IAAI;AAAA,MAErD;AAAA,IACF;AAAA,IACA;AAAA,EACF,CAAC;AACH,CAAC;;;AC5BH,OAAO,kBAAkB;AAEzB,SAAS,qBAAqB;AAC9B,OAAO,eAAe;AACtB,SAAS,aAAsB;AAC/B;AAAA,EACE;AAAA,EACA,SAAAC;AAAA,EACA;AAAA,EACA;AAAA,EAEA;AAAA,OACK;AACP,SAAS,UAAAC,SAAQ,qBAAqB;AACtC,SAAS,cAAc;AACvB,OAAO,UAAU;AACjB,SAAS,OAAO,iBAAiB;AACjC,OAAO,UAAU;;;AChBjB,SAAS,cAAc;AAEhB,IAAM,uBAAuB,CAAC,aAA+B;AAClE,QAAM,sBAAgC,CAAC;AACvC,QAAM,gBAAgB,oBAAI,IAA8C;AACxE,MAAI,QAAQ;AACZ,WAAS,eAAe,CAAC;AACzB,WAAS,WAAW,eAAe,CAAC;AAEpC,QAAM,SAAS,CACb,WACA,OACA,QACG;AACH,QAAI,UAAU;AAAW;AACzB,UAAM,MAAM,KAAK,UAAU,SAAS;AACpC,UAAM,UAAU,CAAC,QAAgB;AAC/B,UAAI,KAAK,IAAI;AAAA,QACX,MAAM,6BAA6B;AAAA,MACrC;AAAA,IACF;AACA,QAAI,oBAAoB,SAAS,GAAG,GAAG;AACrC,UAAI,MAAM,cAAc,IAAI,GAAG;AAC/B,UAAI,OAAO,QAAQ,YAAY;AAC7B,cAAM,eAAe;AACrB,cAAM,OAAQ,UAAsC;AACpD,cAAM,SAAS,WAAY,WAAY,IAAI,IACvC,OAAO,MAAM,EAAE,QACf;AACJ,iBAAS,WAAY,WAAY,GAAG,IAAI;AACxC,sBAAc,IAAI,KAAK,GAAG;AAC1B,qBAAa,GAAG;AAAA,MAClB;AACA,cAAQ,GAAG;AAAA,IACb,OAAO;AACL,0BAAoB,KAAK,GAAG;AAC5B,oBAAc,IAAI,KAAK,OAAO;AAAA,IAChC;AAAA,EACF;AAEA,aAAWC,SAAQ,OAAO,OAAO,SAAS,KAAK,GAAG;AAChD,IAAAA,MAAM,YAAY,QAAQ,MAAM;AAChC,eAAW,UAAU,SAAS;AAC5B,YAAM,aAAaA,MAAM,MAAM;AAC/B,UAAI,CAAC,cAAc,CAAC,WAAW;AAAY;AAC3C,iBAAW,WAAW,QAAQ,MAAM;AAAA,IACtC;AAAA,EACF;AAEA,MAAI,OAAO,KAAK,SAAS,WAAW,UAAU,EAAE,WAAW,GAAG;AAC5D,WAAO,SAAS,WAAW;AAAA,EAC7B;AAEA,MAAI,OAAO,KAAK,SAAS,UAAU,EAAE,WAAW,GAAG;AACjD,WAAO,SAAS;AAAA,EAClB;AACF;AAEO,IAAM,iCAAiC,CAAC,aAA+B;AAC5E;AAAU,eAAWA,SAAQ,OAAO,OAAO,SAAS,KAAK,GAAG;AAC1D,YAAM,qBAAiD,CAAC;AACxD,UAAI,QAAQ;AACZ,iBAAW,UAAU,SAAS;AAC5B,cAAM,aAAaA,MAAM,MAAM;AAC/B,YAAI,CAAC;AAAY;AACjB,YAAI,CAAC,WAAW,YAAY;AAAQ,mBAAS;AAC7C,UAAE;AACF,mBAAW,WAAW,QAAQ,CAAC,WAAWC,QAAO,QAAQ;AACvD,gBAAM,MAAM,KAAK,UAAU,SAAS;AAEpC,sBAAY,IAAIA,MAAK,IAAI,KAAK,MAAM,GAAG;AACvC,6BAAmB,GAAG,MAAM,CAAC;AAC7B,6BAAmB,GAAG,EAAG,KAAK,MAAM;AAClC,gBAAI;AAAA,cACF,IAAI,UAAU,CAAC,SAAS,SAAS,SAAS;AAAA,cAC1C;AAAA,YACF;AACA,gBAAI,CAAC,IAAI,QAAQ;AACf,qBAAO,WAAW;AAAA,YACpB;AAAA,UACF,CAAC;AAAA,QACH,CAAC;AAAA,MACH;AACA,UAAI,QAAQ;AAAG,iBAAS;AACxB,aAAO,QAAQ,kBAAkB,EAAE,QAAQ,CAAC,CAAC,KAAK,SAAS,MAAM;AAC/D,YAAI,UAAU,WAAW;AAAO;AAChC,QAAAD,MAAM,eAAe,CAAC;AACtB,QAAAA,MAAM,WAAW,KAAK,KAAK,MAAM,GAAG,CAAC;AACrC,kBAAU,QAAQ,CAAC,aAAa,SAAS,CAAC;AAAA,MAC5C,CAAC;AACD,UAAIA,MAAM,cAAc,CAACA,MAAM,WAAW,QAAQ;AAChD,eAAOA,MAAM;AAAA,MACf;AAAA,IACF;AACF;AAEA,IAAM,UAAU,OAAO,OAAO,MAAM,EAAE;AAAA,EAAI,CAAC,WACzC,OAAO,YAAY;AACrB;;;ACnGO,IAAM,eAAe,CAAC,QAAgB,QAAgB;AAC3D,WAAS,OAAO,YAAY;AAE5B,MAAI,WAAW,SAAS,CAAC,IAAI,SAAS,GAAG;AAAG,WAAO;AACnD,MAAI,WAAW;AAAQ,WAAO;AAC9B,MAAI,WAAW;AAAO,WAAO;AAC7B,MAAI,WAAW;AAAS,WAAO;AAC/B,SAAO;AACT;;;ACNO,IAAM,oBAAoB,CAAC,aAA+B;AAC/D,WAAS,eAAe,CAAC;AACzB,WAAS,WAAW,YAAY,CAAC;AACjC,QAAM,gBAA0B,CAAC;AACjC,QAAM,YAA8D,CAAC;AACrE,MAAI,QAAQ;AAEZ,GAAC,SAAS,WAAW,MAA2B;AAC9C,QAAI,OAAO,SAAS;AAAU;AAC9B,WAAO,QAAQ,IAAI,EAAE,QAAQ,CAAC,CAAC,KAAK,KAAK,MAAM;AAC7C,UAAI,QAAQ;AAAU,eAAO,WAAW,KAAK;AAC7C,UAAI,CAAC,oBAAoB,KAAK;AAAG;AACjC,YAAM,MAAM,KAAK,UAAU,KAAK;AAChC,YAAM,UAAU,CAAC,QAAgB;AAC/B,aAAK,GAAG,IAA6B;AAAA,UACnC,MAAM,0BAA0B;AAAA,QAClC;AAAA,MACF;AACA,UAAI,cAAc,SAAS,GAAG,GAAG;AAC/B,YAAI,MAAM,UAAU,GAAG;AACvB,YAAI,OAAO,QAAQ,YAAY;AAC7B,gBAAM,eAAe;AACrB,gBAAM,aAAa,MAAM,QAAQ,MAAM,IAAI,IACvC,MAAM,KAAK,KAAK,GAAG,IACnB,OAAO,MAAM,IAAI;AACrB,gBAAM,SAAS,WAAY,QAAS,UAAU,IAC1C,aAAa,MAAM,EAAE,QACrB;AACJ,mBAAS,WAAY,QAAS,GAAG,IAAI;AACrC,oBAAU,GAAG,IAAI;AACjB,uBAAa,GAAG;AAAA,QAClB;AACA,gBAAQ,GAAG;AAAA,MACb,OAAO;AACL,sBAAc,KAAK,GAAG;AACtB,kBAAU,GAAG,IAAI;AAAA,MACnB;AAAA,IACF,CAAC;AAAA,EACH,GAAG,QAAQ;AAEX,MAAI,OAAO,KAAK,SAAS,WAAW,OAAO,EAAE,WAAW,GAAG;AACzD,WAAO,SAAS,WAAW;AAAA,EAC7B;AACA,MAAI,OAAO,KAAK,SAAS,UAAU,EAAE,WAAW,GAAG;AACjD,WAAO,SAAS;AAAA,EAClB;AACF;AAEA,IAAM,sBAAsB,CAAC,UAA8C;AACzE,SAAO,OAAO,UAAU,YAAY,UAAU,SAAS,EAAE,UAAU;AACrE;;;ACnDA,OAAO,eAA2C;AAClD,SAAS,0BAA0B;AACnC,SAAS,WAAW;AAEpB,IAAM,WAAW,IAAI,UAAU,SAAS;AACxC,SAAS,WAAW;AAAA,EAClB,SAAS;AAAA;AAAA,EAET,OAAO;AAAA,IACL,gBAAgB;AAAA,IAChB,oBAAoB;AAAA,EACtB;AACF,CAAC;AAYM,IAAM,WAAW,OAAO,aAA+B;AAC5D,QAAM,SAAgC;AAAA,IACpC,UAAU,CAAC;AAAA,IACX,QAAQ,CAAC;AAAA,EACX;AACA,QAAM,eAAe,MAAM,SAAS;AAAA,IAClC;AAAA,EACF;AACA,eAAa,QAAQ,CAAC,SAAS;AAC7B,WACE,KAAK,aAAa,mBAAmB,QAAQ,WAAW,UAC1D,EAAE,KAAK;AAAA,MACL,MAAM,KAAK,KAAK,IAAI,MAAM;AAAA,MAC1B,SAAS,KAAK;AAAA,IAChB,CAAC;AAAA,EACH,CAAC;AACD,SAAO;AACT;;;AJuBO,IAAM,mBAAmB,OAC9B,WAII;AACJ,QAAM,UAAU,OAAO,WAAW,IAAI,aAAa;AACnD,MAAI,MAAM;AAEV,UAAQ,KAAK,OAAO;AACpB,UAAQ,KAAK,OAAO,YAAY;AAChC,QAAM,WAA6B,KAAK;AAAA,IACtC,KAAK,UAAU,OAAO,QAAQ,CAAC,CAAC;AAAA,EAClC;AAEA;AACE,aAAS,YAAY;AACrB,aAAS,SAAS,CAAC;AACnB,aAAS,SAAS,EAAE,OAAO,IAAI,SAAS,GAAG;AAC3C,aAAS,QAAQ,CAAC;AAClB,aAAS,KAAK,WACX,MAAM,cAAc,IAAI,YAAY,QAAQ;AAC/C,aAAS,KAAK,aACX,MAAM,cAAc,IAAI,YAAY,WAAW;AAAA,EACpD;AAEA,UAAQ,KAAK,OAAQ,MAAM,gBAAiB;AAC5C,QAAM,QAAQ,MAAM,YAAY,OAAO,OAAO;AAC9C,UAAQ,KAAK,OAAQ,MAAM,cAAe;AAC1C,QAAM,WAAqB,CAAC;AAC5B,aAAW,QAAQ,OAAO;AACxB,YAAQ;AAAA,MACN;AAAA,MACA,MACE,MACAE,OAAM;AAAA,QACJ,KACG,SAAS,QAAQ,IAAI,GAAG,IAAI,EAC5B,MAAM,KAAK,GAAG,EACd,KAAK,KAAK,MAAM,GAAG;AAAA,MACxB;AAAA,IACJ;AACA,UAAM,MAAM,EAAE;AAEd,UAAM,UAAU,MAAM;AAAA,MACpB,CAAC,IAAI;AAAA,MACL,CAAC,SAAS,CAAC,CAAC,QAAQ,gBAAgB;AAAA,IACtC;AACA,eAAW,UAAU,SAAS;AAC5B,YAAM,sBAAsB,MAAM,QAAQ,OAAO,SAAS,MAAM,CAAC;AACjE,YAAM,WAAW,OAAO,YAAY,MAAM;AAE1C,iBAAW,WAAW,UAAU;AAC9B,mBAAW,OAAO,QAAQ,MAAM;AAC9B,gBAAM,WAAY,SAAS,MAAM,cAAc,GAAG,CAAC,MAAM,CAAC;AAC1D,cAAIC,WAAU,QAAQ;AAEtB,cAAIA,SAAQ,SAASC,QAAO,GAAG,KAAKD,SAAQ,SAASC,QAAO,IAAI,GAAG;AACjE,YAAAD,WAAUA,SAAQ,OAAO,CAAC,WAAW,WAAW,MAAM;AAAA,UACxD;AAEA,qBAAW,UAAUA,UAAS;AAC5B,kBAAM,aAAuC,SAC3C,OAAO,YAAY,CACrB,IAAI;AAAA,cACF,WAAW,CAAC;AAAA,cACZ,GAAG,QAAQ;AAAA,YACb;AAEA,uBAAWE,eAAc,oBAAoB;AAAA,cAC3C,MAAM,QAAQ,QAAQ,KAAK;AAAA,YAC7B,GAAG;AACD,kBAAIA,uBAAsB,eAAe;AACvC,gBAAAA,YAAW,WAAW;AAAA,kBACpB;AAAA,kBACA;AAAA,kBACA,YAAY;AAAA,kBACZ;AAAA,gBACF,CAAC;AAAA,cACH;AAAA,YACF;AAEA,uBAAW,SAAS,CAAC,iBAAiB,IAAI,CAAC;AAC3C,uBAAW,gBAAgB;AAAA,cACzB,aAAa,QAAQ,GAAG,IAAI,MAAM,IAAI,WAAW,KAAK,MAAM;AAAA,YAC9D;AAEA,gBAAI,WAAWD,QAAO,MAAM;AAE1B,yBAAW,6BAA6B,IAAI;AAAA,YAC9C;AAEA,gBAAI,OAAO,KAAK,WAAW,SAAS,EAAE,WAAW,GAAG;AAClD,yBAAW,YAAY;AAAA,gBACrB,SAAS;AAAA,kBACP,aAAa;AAAA,gBACf;AAAA,cACF;AAAA,YACF;AAEA,qBAAS,KAAK,GAAG,WAAW,IAAK;AAAA,UACnC;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACA,UAAQ,KAAK,WAAW,GAAG;AAE3B;AACE,UAAM,OAAO,SAAS;AACtB,UAAM,cAAc,KAAK,IAAI,CAAC,SAAS,KAAK,IAAI;AAChD,eAAW,OAAO,CAAC,GAAG,IAAI,IAAI,QAAQ,CAAC,EAAE,KAAK,GAAG;AAC/C,UAAI,CAAC,YAAY,SAAS,GAAG,GAAG;AAC9B,gBAAQ,KAAK,OAAQ,MAAM,eAAe,KAAM;AAChD,aAAK,KAAK,EAAE,MAAM,IAAI,CAAC;AAAA,MACzB;AAAA,IACF;AAAA,EACF;AAEA;AACE,YAAQ,KAAK,OAAQ,MAAM,sBAAuB;AAClD,QAAI,OAAO,KAAK;AACd,aAAO,IAAI,QAAQ;AAAA,IACrB,OAAO;AACL,cAAQ,KAAK,WAAW,KAAK,GAAG,CAAC;AAAA,IACnC;AAAA,EACF;AAEA;AACE,YAAQ,KAAK,OAAQ,MAAM,qBAAsB;AACjD,mCAA+B,QAAQ;AACvC,yBAAqB,QAAQ;AAAA,EAC/B;AAEA;AACE,YAAQ,KAAK,OAAQ,MAAM,kBAAmB;AAC9C,sBAAkB,QAAQ;AAAA,EAC5B;AAEA;AACE,YAAQ,KAAK,OAAQ,MAAM,cAAe;AAC1C,QAAI,WACF,OAAO,WAAW,QAAQ,QAAQ,OAAO,UAAU;AACrD,QAAI,UAAU;AACZ,iBAAW,KAAK,QAAQ,QAAQ;AAChC,YAAM,MAAM,KAAK,QAAQ,QAAQ,GAAG;AAAA,QAClC,WAAW;AAAA,MACb,CAAC;AAED,YAAM,UAAU,CAAC,QAAQ,OAAO,EAAE,SAAS,KAAK,QAAQ,QAAQ,CAAC,IAC7D,KAAK,UAAU,QAAQ,IACvB,KAAK,UAAU,UAAU,MAAM,OAAO,aAAa,IAAI,MAAS;AAEpE,YAAM,UAAU,UAAU,SAAS;AAAA,QACjC,MAAM,OAAO;AAAA,MACf,CAAC;AACD,YAAM,OAAO,MAAM,OAAO,WAAW,OAAO,GAAG,EAAE,eAAe,GAAG,CAAC;AACpE,cAAQ;AAAA,QACN;AAAA,QACA,MACE,OACA,KAAK,SAAS,QAAQ,IAAI,GAAG,QAAQ,IACrCF,OAAM,KAAK,WAAW,OAAO;AAAA,QAC/B;AAAA,MACF;AAAA,IACF,OAAO;AACL,cAAQ,KAAK,WAAW,KAAK,GAAG,CAAC;AAAA,IACnC;AAAA,EACF;AAEA,MAAI;AACJ;AACE,YAAQ,KAAK,OAAQ,MAAM,UAAW;AACtC,aAAS,MAAM,SAAS,QAAQ;AAChC,UAAM,UAAoB,CAAC;AAC3B,QAAI,OAAO,QAAQ,QAAQ;AACzB,cAAQ,KAAK,GAAG,OAAO,OAAO,eAAe;AAAA,IAC/C;AACA,QAAI,OAAO,UAAU,QAAQ;AAC3B,cAAQ,KAAK,GAAG,OAAO,SAAS,iBAAiB;AAAA,IACnD;AACA,YAAQ,UACN,QAAQ,KAAK,WAAW,MAAM,MAAMA,OAAM,OAAO,QAAQ,KAAK,IAAI,CAAC,CAAC;AACtE,YAAQ;AAAA,MACN;AAAA,MACA,OAAO,QAAQ,SAAS,SAAS,OAAO,UAAU,SAAS,SAAS;AAAA,IACtE;AAAA,EACF;AAEA,SAAO;AAAA,IACL,UAAU,KAAK,MAAM,KAAK,UAAU,QAAQ,CAAC;AAAA,IAC7C,QAAQ;AAAA,MACN,QAAQ,OAAO,UAAU,CAAC;AAAA,MAC1B,UAAU,OAAO,YAAY,CAAC;AAAA,IAChC;AAAA,EACF;AACF;AAEA,IAAM,OAAO,CAAC,YAAoB,UAAU,MAAMA,OAAM,KAAK,WAAW;AAExE,IAAM,gBAAgB,CAAC,QAAgB;AACrC,SAAO,IAAI,QAAQ,oBAAoB,CAAC,GAAG,OAAO;AAChD,WAAO,IAAI,GAAG,QAAQ,QAAQ,EAAE;AAAA,EAClC,CAAC;AACH;AAEA,IAAM,mBAAmB,CAAC,SAAiB;AACzC,SAAO,KAAK,SAAS,IAAI,EAAE,QAAQ,SAAS,EAAE;AAChD;;;AF1QO,IAAM,UAAU,CACrB,YAOG;AACH,QAAM,cAAc,QAAQ,eAAe;AAE3C,SAAO,MAAM,QACV;AAAA,IACC;AAAA,MACE;AAAA,MACA,QAAQ;AAAA,MACR,QAAQ;AAAA,MACR,QAAQ;AAAA,IACV;AAAA,EACF,EACC;AAAA,IACCI,YAAW,QAAQ,OAAO,KAAK,SAAS;AACtC,UAAI,IAAI,QAAQ,YAAY;AAAa,eAAO,KAAK;AAErD,UAAI,SAAS,iBAAiB;AAE9B,YAAM,UAAU,IAAIC,cAAa;AACjC,YAAM,UAAe,IAAI;AAEzB,cACG,GAAG,OAAO,CAAC,QAAQ;AAClB,YAAI,QAAQ;AAAY,kBAAQ,QAAQ;AACxC,gBAAQ,MAAM,GAAG;AAAA,MACnB,CAAC,EACA,GAAG,WAAW,CAAC,QAAQ;AACtB,gBAAQ,OAAO;AAAA,MACjB,CAAC,EACA,GAAG,OAAO,CAAC,WAAmB;AAC7B,YACE,WAAW,aACX,WAAW,UACX,WAAW,QACX;AACA,kBAAQ,MAAM,EAAE;AAAA,QAClB;AAAA,MACF,CAAC;AAEH,UAAI;AACJ,UAAI;AACF,kBAAU,MAAM,iBAAiB,EAAE,GAAG,SAAS,QAAQ,CAAC,GAAG;AAAA,MAC7D,SAAS,GAAP;AACA,gBAAQ,KAAK;AACb,cAAM;AAAA,MACR;AAEA,UAAI,OAAO,OAAO,QAAQ;AACxB,gBAAQ,SAAS;AACjB,eAAO,OAAO,QAAQ,CAAC,SAAS;AAC9B,kBAAQ,KAAK,sBAAsB,IAAI,CAAC;AAAA,QAC1C,CAAC;AAAA,MACH;AAEA,UAAI,QAAQ,kBAAkB,OAAO,SAAS,QAAQ;AACpD,gBAAQ,SAAS;AACjB,eAAO,SAAS,QAAQ,CAAC,SAAS;AAChC,kBAAQ,KAAK,sBAAsB,IAAI,CAAC;AAAA,QAC1C,CAAC;AAAA,MACH;AAAA,IACF,CAAC;AAAA,EACH;AACJ;AAEA,IAAM,wBAAwB,CAAC,SAAoC;AACjE,MAAI,WAAW,KAAK,KAAK,SAAS,KAAK,KAAK,KAAK,GAAG,IAAI;AACxD,SAAO,IAAI,YAAY,QAAQ,KAAK;AACtC;","names":["EventEmitter","middleware","chalk","METHOD","path","index","chalk","methods","METHOD","middleware","middleware","EventEmitter"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aomex/openapi",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.13",
|
|
4
4
|
"description": "Openapi documentation generator",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -26,26 +26,26 @@
|
|
|
26
26
|
"homepage": "https://aomex.js.org",
|
|
27
27
|
"license": "MIT",
|
|
28
28
|
"peerDependencies": {
|
|
29
|
-
"@aomex/console": "^0.0.
|
|
30
|
-
"@aomex/core": "^0.0.
|
|
31
|
-
"@aomex/
|
|
32
|
-
"@aomex/
|
|
29
|
+
"@aomex/console": "^0.0.12",
|
|
30
|
+
"@aomex/core": "^0.0.12",
|
|
31
|
+
"@aomex/router": "^0.0.13",
|
|
32
|
+
"@aomex/web": "^0.0.13"
|
|
33
33
|
},
|
|
34
34
|
"dependencies": {
|
|
35
35
|
"@aomex/utility": "^0.0.5",
|
|
36
|
-
"
|
|
37
|
-
"
|
|
36
|
+
"@stoplight/spectral-core": "^1.16.1",
|
|
37
|
+
"@stoplight/spectral-rulesets": "^1.15.0",
|
|
38
|
+
"@stoplight/types": "^13.9.3",
|
|
38
39
|
"lodash.snakecase": "^4.1.1",
|
|
39
40
|
"ora": "^6.1.2",
|
|
40
41
|
"read-pkg-up": "^9.1.0",
|
|
41
42
|
"yaml": "^2.2.1"
|
|
42
43
|
},
|
|
43
44
|
"devDependencies": {
|
|
44
|
-
"@aomex/console": "^0.0.
|
|
45
|
-
"@aomex/core": "^0.0.
|
|
46
|
-
"@aomex/
|
|
47
|
-
"@aomex/
|
|
48
|
-
"@types/ibm-openapi-validator": "^0.15.1",
|
|
45
|
+
"@aomex/console": "^0.0.12",
|
|
46
|
+
"@aomex/core": "^0.0.12",
|
|
47
|
+
"@aomex/router": "^0.0.13",
|
|
48
|
+
"@aomex/web": "^0.0.13",
|
|
49
49
|
"@types/lodash.snakecase": "^4.1.7",
|
|
50
50
|
"strip-ansi": "^7.0.1"
|
|
51
51
|
},
|