@aomex/openapi 0.0.6 → 0.0.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/CHANGELOG.md +26 -54
- package/dist/index.d.ts +22 -8
- package/dist/index.js +127 -56
- package/dist/index.js.map +1 -1
- package/package.json +18 -15
package/CHANGELOG.md
CHANGED
|
@@ -1,74 +1,46 @@
|
|
|
1
1
|
# @aomex/openapi
|
|
2
2
|
|
|
3
|
-
## 0.0.
|
|
3
|
+
## 0.0.8
|
|
4
4
|
|
|
5
5
|
### Patch Changes
|
|
6
6
|
|
|
7
|
-
- [`
|
|
7
|
+
- [`be02395`](https://github.com/aomex/aomex/commit/be02395503ad81a6205209b4c8e1ad377bfc4227) Thanks [@geekact](https://github.com/geekact)! - fix(openapi): forget to set commandMatched
|
|
8
8
|
|
|
9
|
-
-
|
|
10
|
-
- @aomex/web@0.0.6
|
|
11
|
-
- @aomex/file-parser@0.0.2
|
|
12
|
-
- @aomex/console@0.0.5
|
|
13
|
-
- @aomex/helper@0.0.3
|
|
14
|
-
- @aomex/web-router@0.0.6
|
|
15
|
-
- @aomex/core@0.0.5
|
|
9
|
+
- [`436e856`](https://github.com/aomex/aomex/commit/436e856c62ca01cc34e90c8ce27a38e5cbbd7aee) Thanks [@geekact](https://github.com/geekact)! - feat(openapi): append tags before fix operation
|
|
16
10
|
|
|
17
|
-
|
|
11
|
+
- [`4bd8e01`](https://github.com/aomex/aomex/commit/4bd8e01e0bb6d0e02c9a1ea4716ae43279b36952) Thanks [@geekact](https://github.com/geekact)! - feat(openapi): it's unnecessary to remove unused tags
|
|
18
12
|
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
- [`cd9369f`](https://github.com/aomex/aomex/commit/cd9369f585053b0003a121fe5fee71c44d78587e) Thanks [@geekact](https://github.com/geekact)! - feat(console): 导出 scriptName 变量
|
|
22
|
-
|
|
23
|
-
- [`956bba9`](https://github.com/aomex/aomex/commit/956bba9e5b954f34486ad5f2b45a5277c1f980c9) Thanks [@geekact](https://github.com/geekact)! - feat(helper): 新的 sleep 函数
|
|
24
|
-
|
|
25
|
-
- Updated dependencies [[`1a2800d`](https://github.com/aomex/aomex/commit/1a2800d3a27f2b45fd5db314c1ca81295831b77d), [`cd9369f`](https://github.com/aomex/aomex/commit/cd9369f585053b0003a121fe5fee71c44d78587e), [`d8debb9`](https://github.com/aomex/aomex/commit/d8debb9b6319d30e48cb77d97103b5559c57789c), [`64c10e1`](https://github.com/aomex/aomex/commit/64c10e17ff92251bb2d9f45e0bddde5cba8a3b20), [`6a57463`](https://github.com/aomex/aomex/commit/6a57463c1107c38a8b8cf5fa00ff3289bf629c0a), [`956bba9`](https://github.com/aomex/aomex/commit/956bba9e5b954f34486ad5f2b45a5277c1f980c9), [`f6bbf24`](https://github.com/aomex/aomex/commit/f6bbf247a81d20c14598c1046169c2e6e1e48fec), [`8857115`](https://github.com/aomex/aomex/commit/88571153b7e84ec6d66d37970c3ef7b4e1924a03), [`ba93deb`](https://github.com/aomex/aomex/commit/ba93debfd2c39a3a4e79c9f3a23be3ef54bb360d), [`68b1365`](https://github.com/aomex/aomex/commit/68b13655922a0714bcdd2101ce659da382d44e8b), [`b51a81a`](https://github.com/aomex/aomex/commit/b51a81a65313073dff5307b310b6656da2ad5186), [`6849b03`](https://github.com/aomex/aomex/commit/6849b03dc1e0dc9b707d89dfe98327c9f120dc7f), [`ee021e3`](https://github.com/aomex/aomex/commit/ee021e342814f12777e538c06a19971e1020f201), [`b5aaec5`](https://github.com/aomex/aomex/commit/b5aaec540e3d732868a270a969a94ccd6ff9ac6a), [`56a5e1f`](https://github.com/aomex/aomex/commit/56a5e1fffe3e1cec863e52c21d122979d121c630), [`fd6ae40`](https://github.com/aomex/aomex/commit/fd6ae40577bd9a62c211d4615483fc5dd58f5865)]:
|
|
26
|
-
- @aomex/console@0.0.4
|
|
27
|
-
- @aomex/web@0.0.5
|
|
28
|
-
- @aomex/helper@0.0.2
|
|
29
|
-
- @aomex/file-parser@0.0.1
|
|
30
|
-
- @aomex/web-router@0.0.5
|
|
31
|
-
- @aomex/core@0.0.4
|
|
32
|
-
|
|
33
|
-
## 0.0.4
|
|
13
|
+
- [`dc52b7a`](https://github.com/aomex/aomex/commit/dc52b7a3ab23541c3d69ced2d14f7e5e7f59eb60) Thanks [@geekact](https://github.com/geekact)! - feat(openapi): add field x-codegen-request-body-name for post method
|
|
34
14
|
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
- [`6c66ab8`](https://github.com/aomex/aomex/commit/6c66ab86d45fae554404453d718da17f798df45f) Thanks [@geekact](https://github.com/geekact)! - 路由增加 docs 属性
|
|
15
|
+
- [`96e41e4`](https://github.com/aomex/aomex/commit/96e41e4ba2534d522c273f36e648e00eac2dfaa9) Thanks [@geekact](https://github.com/geekact)! - feat(openapi): rise common parameters to path object
|
|
38
16
|
|
|
39
|
-
- [`
|
|
17
|
+
- [`fc7008e`](https://github.com/aomex/aomex/commit/fc7008e889a55e6a0a268bb77cab5be0f0bd9d30) Thanks [@geekact](https://github.com/geekact)! - refactor(web,web-router): move method enum from web-router to web
|
|
40
18
|
|
|
41
|
-
-
|
|
42
|
-
- @aomex/web-router@0.0.4
|
|
43
|
-
- @aomex/web@0.0.4
|
|
44
|
-
- @aomex/console@0.0.3
|
|
45
|
-
- @aomex/core@0.0.3
|
|
19
|
+
- [`0c4d62e`](https://github.com/aomex/aomex/commit/0c4d62eda0a3009b288dc87494ac1d083d5c4a90) Thanks [@geekact](https://github.com/geekact)! - feat(openapi): generate operationId to get rid of warning
|
|
46
20
|
|
|
47
|
-
|
|
21
|
+
- [`d542656`](https://github.com/aomex/aomex/commit/d54265655c88fb93a7cbaf905acd977f051f8061) Thanks [@geekact](https://github.com/geekact)! - chore(openapi): upgrade ibm-openapi-validator from 0.97.4 to 0.97.5
|
|
48
22
|
|
|
49
|
-
|
|
23
|
+
- [`af26d9c`](https://github.com/aomex/aomex/commit/af26d9c65cff07c7213cee1cf50dfec8aef0f366) Thanks [@geekact](https://github.com/geekact)! - fix(openapi): relative router file path use forward slash
|
|
50
24
|
|
|
51
|
-
- Updated dependencies [[`
|
|
52
|
-
- @aomex/
|
|
53
|
-
- @aomex/
|
|
54
|
-
- @aomex/
|
|
55
|
-
- @aomex/web-router@0.0.
|
|
25
|
+
- Updated dependencies [[`b7313d5`](https://github.com/aomex/aomex/commit/b7313d56bdb93cabde8dc5b872a94b590f45b655), [`dcf2f4b`](https://github.com/aomex/aomex/commit/dcf2f4b6a13228d4731e4969e6abff9bef8ef0e2), [`d788ce7`](https://github.com/aomex/aomex/commit/d788ce731af885eae3819683813b2a9502742cea), [`01f90ab`](https://github.com/aomex/aomex/commit/01f90abec716427b7ccde3ab566067a4ba3293c8), [`c6fe6cb`](https://github.com/aomex/aomex/commit/c6fe6cb2f21acf74bc06db1509deff4aa35c48b3), [`a2727fb`](https://github.com/aomex/aomex/commit/a2727fb7619341dc3b23736e5dc11cee7d65e0bc), [`4253004`](https://github.com/aomex/aomex/commit/42530043854956a42d16be090b89fbac70e2fa17), [`fc7008e`](https://github.com/aomex/aomex/commit/fc7008e889a55e6a0a268bb77cab5be0f0bd9d30), [`c4bb0f4`](https://github.com/aomex/aomex/commit/c4bb0f424e7d2d2f8610583e106cbaef73077278), [`6c6cda2`](https://github.com/aomex/aomex/commit/6c6cda26522176c44761a738f2bc106a1889497b), [`d80df1a`](https://github.com/aomex/aomex/commit/d80df1a07eb92214a9c3c7fa15c629ea1ee88c43)]:
|
|
26
|
+
- @aomex/file-parser@0.0.4
|
|
27
|
+
- @aomex/web@0.0.8
|
|
28
|
+
- @aomex/console@0.0.7
|
|
29
|
+
- @aomex/web-router@0.0.8
|
|
30
|
+
- @aomex/core@0.0.7
|
|
56
31
|
|
|
57
|
-
## 0.0.
|
|
32
|
+
## 0.0.7
|
|
58
33
|
|
|
59
34
|
### Patch Changes
|
|
60
35
|
|
|
61
|
-
-
|
|
62
|
-
- @aomex/web-router@0.0.2
|
|
63
|
-
- @aomex/web@0.0.2
|
|
36
|
+
- [`bbc8dda`](https://github.com/aomex/aomex/commit/bbc8dda9f0876c3402608133085350cc693def6f) Thanks [@geekact](https://github.com/geekact)! - refactor: rename package helper to utility
|
|
64
37
|
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
### Patch Changes
|
|
38
|
+
- [`8f09dbe`](https://github.com/aomex/aomex/commit/8f09dbe4c1232ffcfd174abd27523b64bd30e8e2) Thanks [@geekact](https://github.com/geekact)! - chore(openapi): upgrade ibm-openapi-validator from 0.97.3 to 0.97.4
|
|
68
39
|
|
|
69
|
-
- Updated dependencies [[`
|
|
70
|
-
- @aomex/
|
|
71
|
-
- @aomex/web-router@0.0.
|
|
72
|
-
- @aomex/console@0.0.
|
|
73
|
-
- @aomex/
|
|
74
|
-
- @aomex/
|
|
40
|
+
- Updated dependencies [[`589243d`](https://github.com/aomex/aomex/commit/589243da955f3e4296d30fdfe05eac0c45714281), [`24d45f0`](https://github.com/aomex/aomex/commit/24d45f02966cfd936d493de5844bcae73caa6d10), [`0b6d4e7`](https://github.com/aomex/aomex/commit/0b6d4e7bd68d28b682de87d2540a89329afef408), [`cab01c6`](https://github.com/aomex/aomex/commit/cab01c63d60e73a7e24018e6872080d5656c29e2), [`bbc8dda`](https://github.com/aomex/aomex/commit/bbc8dda9f0876c3402608133085350cc693def6f), [`9866b9e`](https://github.com/aomex/aomex/commit/9866b9e63abb71e1197ff8002c38bac04a36dd62), [`ceb2d82`](https://github.com/aomex/aomex/commit/ceb2d8269755dca3f79b755224259b8a99bc65d0)]:
|
|
41
|
+
- @aomex/file-parser@0.0.3
|
|
42
|
+
- @aomex/web-router@0.0.7
|
|
43
|
+
- @aomex/console@0.0.6
|
|
44
|
+
- @aomex/utility@0.0.4
|
|
45
|
+
- @aomex/core@0.0.6
|
|
46
|
+
- @aomex/web@0.0.7
|
package/dist/index.d.ts
CHANGED
|
@@ -4,13 +4,22 @@ import { Mode } from 'node:fs';
|
|
|
4
4
|
import { OpenAPI } from '@aomex/core';
|
|
5
5
|
import { PathToFileOptions } from '@aomex/file-parser';
|
|
6
6
|
|
|
7
|
+
interface OpenapiValidateResultItem {
|
|
8
|
+
path: string[];
|
|
9
|
+
message: string;
|
|
10
|
+
rule: string;
|
|
11
|
+
}
|
|
12
|
+
interface OpenapiValidateResult {
|
|
13
|
+
errors: OpenapiValidateResultItem[];
|
|
14
|
+
warnings: OpenapiValidateResultItem[];
|
|
15
|
+
}
|
|
7
16
|
interface OpenapiOptions {
|
|
8
17
|
/**
|
|
9
|
-
*
|
|
18
|
+
* Web api routers
|
|
10
19
|
*/
|
|
11
20
|
routers: PathToFileOptions;
|
|
12
21
|
/**
|
|
13
|
-
*
|
|
22
|
+
* Openapi basic information
|
|
14
23
|
* @see OpenApiDocs
|
|
15
24
|
*/
|
|
16
25
|
docs?: Omit<OpenAPI.Document, 'paths' | 'openapi' | 'info'> & {
|
|
@@ -18,26 +27,31 @@ interface OpenapiOptions {
|
|
|
18
27
|
info?: Partial<OpenAPI.Document['info']>;
|
|
19
28
|
};
|
|
20
29
|
/**
|
|
21
|
-
*
|
|
30
|
+
* Save document to specific file (`*.yaml`|`*.json`). Defaults `openapi.json`
|
|
22
31
|
*/
|
|
23
32
|
output?: false | string;
|
|
24
33
|
/**
|
|
25
|
-
*
|
|
34
|
+
* File mode. Defaults according system
|
|
35
|
+
* @see OpenapiOptions.output
|
|
26
36
|
*/
|
|
27
37
|
fileMode?: Mode;
|
|
28
38
|
/**
|
|
29
|
-
*
|
|
39
|
+
* Format JSON document to human readable. Defaults `false`
|
|
30
40
|
*/
|
|
31
41
|
prettyJson?: boolean;
|
|
32
42
|
/**
|
|
33
|
-
*
|
|
43
|
+
* Fix the document by hand after the full document is generated
|
|
34
44
|
*/
|
|
35
45
|
fix?: (data: OpenAPI.Document) => void;
|
|
36
46
|
/**
|
|
37
|
-
*
|
|
47
|
+
* Log emitter
|
|
38
48
|
*/
|
|
39
49
|
emitter: EventEmitter;
|
|
40
50
|
}
|
|
51
|
+
declare const generateDocument: (config: OpenapiOptions) => Promise<{
|
|
52
|
+
document: OpenAPI.Document;
|
|
53
|
+
result: OpenapiValidateResult;
|
|
54
|
+
}>;
|
|
41
55
|
|
|
42
56
|
declare const openapi: (options: Omit<OpenapiOptions, 'emitter'> & {
|
|
43
57
|
renderWarnings?: boolean;
|
|
@@ -47,4 +61,4 @@ declare const openapi: (options: Omit<OpenapiOptions, 'emitter'> & {
|
|
|
47
61
|
description?: string;
|
|
48
62
|
}) => _aomex_console.ConsoleChain<object>;
|
|
49
63
|
|
|
50
|
-
export { openapi };
|
|
64
|
+
export { OpenapiOptions, OpenapiValidateResult, OpenapiValidateResultItem, generateDocument, openapi };
|
package/dist/index.js
CHANGED
|
@@ -6,65 +6,83 @@ import ora from "ora";
|
|
|
6
6
|
// src/openapi-to-help.ts
|
|
7
7
|
import { scriptName } from "@aomex/console";
|
|
8
8
|
import { middleware } from "@aomex/core";
|
|
9
|
-
import { chalk } from "@aomex/
|
|
9
|
+
import { chalk } from "@aomex/utility";
|
|
10
10
|
var openapiToHelp = (commandName, summary, description, showInHelp = true) => middleware.help(async (ctx, next) => {
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
11
|
+
return ctx.cli.config({
|
|
12
|
+
all(yargs) {
|
|
13
|
+
yargs.command(
|
|
14
|
+
chalk.yellow(commandName),
|
|
15
|
+
summary || "Generate openapi v3 documentation"
|
|
16
|
+
);
|
|
17
|
+
},
|
|
18
|
+
detailCommand: () => showInHelp && ctx.request.command === commandName,
|
|
19
|
+
detail(yargs) {
|
|
20
20
|
yargs.usage(
|
|
21
21
|
`${scriptName} ${commandName} [options]${description ? "\n\n" + chalk.bold(description) : ""}`
|
|
22
22
|
);
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
const _ = status;
|
|
27
|
-
assert(_);
|
|
28
|
-
}
|
|
23
|
+
},
|
|
24
|
+
next
|
|
25
|
+
});
|
|
29
26
|
});
|
|
30
27
|
|
|
31
|
-
// src/generate-
|
|
28
|
+
// src/generate-document.ts
|
|
32
29
|
import EventEmitter from "node:events";
|
|
33
30
|
import { readPackageUp } from "read-pkg-up";
|
|
34
|
-
import
|
|
31
|
+
import snakeCase from "lodash.snakecase";
|
|
32
|
+
import equal from "fast-deep-equal";
|
|
35
33
|
import { Chain } from "@aomex/core";
|
|
36
|
-
import { chalk as chalk2, sleep } from "@aomex/
|
|
34
|
+
import { bytes, chalk as chalk2, sleep } from "@aomex/utility";
|
|
37
35
|
import {
|
|
38
36
|
fileToModules,
|
|
39
37
|
pathToFiles
|
|
40
38
|
} from "@aomex/file-parser";
|
|
41
|
-
import { WebMiddleware } from "@aomex/web";
|
|
39
|
+
import { METHOD, WebMiddleware } from "@aomex/web";
|
|
42
40
|
import { Router } from "@aomex/web-router";
|
|
43
41
|
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
|
+
|
|
46
|
+
// src/method-to-verb.ts
|
|
47
|
+
var methodToVerb = (method, uri) => {
|
|
48
|
+
method = method.toLowerCase();
|
|
49
|
+
if (method === "get" && !uri.includes(":"))
|
|
50
|
+
return "list";
|
|
51
|
+
if (method === "post")
|
|
52
|
+
return "create";
|
|
53
|
+
if (method === "put")
|
|
54
|
+
return "replace";
|
|
55
|
+
if (method === "patch")
|
|
56
|
+
return "update";
|
|
57
|
+
return method;
|
|
58
|
+
};
|
|
59
|
+
|
|
60
|
+
// src/generate-document.ts
|
|
61
|
+
var generateDocument = async (config) => {
|
|
48
62
|
const emitter = config.emitter || new EventEmitter();
|
|
49
63
|
let msg = "";
|
|
50
64
|
emitter.emit("start");
|
|
51
|
-
emitter.emit("msg", "
|
|
65
|
+
emitter.emit("msg", "Initialize");
|
|
52
66
|
const document = JSON.parse(
|
|
53
67
|
JSON.stringify(config.docs || {})
|
|
54
68
|
);
|
|
55
69
|
{
|
|
56
70
|
document.openapi ||= "3.0.3";
|
|
57
71
|
document.tags ||= [];
|
|
72
|
+
document.info ||= { title: "", version: "" };
|
|
58
73
|
document.paths = {};
|
|
59
|
-
document.info.title ||= (await readPackageUp())?.packageJson.name || "API
|
|
74
|
+
document.info.title ||= (await readPackageUp())?.packageJson.name || "API documentation";
|
|
60
75
|
document.info.version ||= (await readPackageUp())?.packageJson.version || "0.0.0";
|
|
61
76
|
}
|
|
62
|
-
emitter.emit("msg", msg = "
|
|
77
|
+
emitter.emit("msg", msg = "Search routers");
|
|
63
78
|
const files = await pathToFiles(config.routers);
|
|
64
|
-
emitter.emit("msg", msg = "
|
|
79
|
+
emitter.emit("msg", msg = "Parse router");
|
|
65
80
|
const usedTags = [];
|
|
66
81
|
for (const file of files) {
|
|
67
|
-
emitter.emit(
|
|
82
|
+
emitter.emit(
|
|
83
|
+
"replace",
|
|
84
|
+
msg + " " + chalk2.gray(path.posix.join(path.relative(process.cwd(), file)))
|
|
85
|
+
);
|
|
68
86
|
await sleep(50);
|
|
69
87
|
const routers = await fileToModules(
|
|
70
88
|
[file],
|
|
@@ -76,13 +94,12 @@ var generateOpenapi = async (config) => {
|
|
|
76
94
|
for (const builder of builders) {
|
|
77
95
|
for (const uri of builder.uris) {
|
|
78
96
|
const pathItem = document.paths[normalizePath(uri)] ||= {};
|
|
79
|
-
let
|
|
80
|
-
if (
|
|
81
|
-
|
|
97
|
+
let methods2 = builder.methods;
|
|
98
|
+
if (methods2.includes(METHOD.GET) && methods2.includes(METHOD.HEAD)) {
|
|
99
|
+
methods2 = methods2.filter((method) => method !== "HEAD");
|
|
82
100
|
}
|
|
83
|
-
for (const method of
|
|
101
|
+
for (const method of methods2) {
|
|
84
102
|
const methodItem = pathItem[method.toLowerCase()] = {
|
|
85
|
-
tags: [getTagByFilename(file)],
|
|
86
103
|
responses: {},
|
|
87
104
|
...builder.docs
|
|
88
105
|
};
|
|
@@ -93,10 +110,18 @@ var generateOpenapi = async (config) => {
|
|
|
93
110
|
middleware3.toDocument({
|
|
94
111
|
document,
|
|
95
112
|
pathItem,
|
|
113
|
+
methodName: method,
|
|
96
114
|
methodItem
|
|
97
115
|
});
|
|
98
116
|
}
|
|
99
117
|
}
|
|
118
|
+
methodItem.tags ||= [getTagByFilename(file)];
|
|
119
|
+
methodItem.operationId ||= snakeCase(
|
|
120
|
+
methodToVerb(method, uri) + " " + uri
|
|
121
|
+
);
|
|
122
|
+
if (method === METHOD.POST) {
|
|
123
|
+
methodItem["x-codegen-request-body-name"] = "body";
|
|
124
|
+
}
|
|
100
125
|
if (Object.keys(methodItem.responses).length === 0) {
|
|
101
126
|
methodItem.responses = {
|
|
102
127
|
default: {
|
|
@@ -112,7 +137,17 @@ var generateOpenapi = async (config) => {
|
|
|
112
137
|
}
|
|
113
138
|
emitter.emit("replace", msg);
|
|
114
139
|
{
|
|
115
|
-
|
|
140
|
+
const tags = document.tags;
|
|
141
|
+
const definedTags = tags.map((item) => item.name);
|
|
142
|
+
for (const tag of [...new Set(usedTags)].sort()) {
|
|
143
|
+
if (!definedTags.includes(tag)) {
|
|
144
|
+
emitter.emit("msg", msg = `Append tag: ${tag}`);
|
|
145
|
+
tags.push({ name: tag });
|
|
146
|
+
}
|
|
147
|
+
}
|
|
148
|
+
}
|
|
149
|
+
{
|
|
150
|
+
emitter.emit("msg", msg = "Fix document by hand");
|
|
116
151
|
if (config.fix) {
|
|
117
152
|
config.fix(document);
|
|
118
153
|
} else {
|
|
@@ -120,22 +155,54 @@ var generateOpenapi = async (config) => {
|
|
|
120
155
|
}
|
|
121
156
|
}
|
|
122
157
|
{
|
|
123
|
-
emitter.emit("msg", msg = "
|
|
124
|
-
|
|
125
|
-
(
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
158
|
+
emitter.emit("msg", msg = "Optimize common parameters");
|
|
159
|
+
pathLoop:
|
|
160
|
+
for (const path2 of Object.values(document.paths)) {
|
|
161
|
+
const parameters = [];
|
|
162
|
+
for (const method of methods) {
|
|
163
|
+
const methodItem = path2?.[method];
|
|
164
|
+
if (!methodItem)
|
|
165
|
+
continue;
|
|
166
|
+
const parameter = methodItem.parameters;
|
|
167
|
+
if (!parameter || !parameter.length)
|
|
168
|
+
continue pathLoop;
|
|
169
|
+
parameters.push(parameter);
|
|
170
|
+
}
|
|
171
|
+
if (parameters.length < 2)
|
|
172
|
+
continue pathLoop;
|
|
173
|
+
let intersect = parameters[0];
|
|
174
|
+
for (let i = 1; i < parameters.length; ++i) {
|
|
175
|
+
const parameter = parameters[i];
|
|
176
|
+
intersect = intersect.filter((item) => {
|
|
177
|
+
for (let j = 0; j < parameter.length; ++j) {
|
|
178
|
+
if (equal(parameter[j], item)) {
|
|
179
|
+
parameter[j] = item;
|
|
180
|
+
return true;
|
|
181
|
+
}
|
|
182
|
+
}
|
|
183
|
+
return false;
|
|
184
|
+
});
|
|
185
|
+
if (!intersect.length)
|
|
186
|
+
continue pathLoop;
|
|
187
|
+
}
|
|
188
|
+
path2.parameters = intersect;
|
|
189
|
+
intersect.forEach((item) => {
|
|
190
|
+
for (const parameter of parameters) {
|
|
191
|
+
parameter.splice(
|
|
192
|
+
parameter.findIndex((p) => p === item),
|
|
193
|
+
1
|
|
194
|
+
);
|
|
195
|
+
}
|
|
132
196
|
});
|
|
197
|
+
for (const method of methods) {
|
|
198
|
+
if (path2[method] && !path2[method].parameters.length) {
|
|
199
|
+
delete path2[method].parameters;
|
|
200
|
+
}
|
|
201
|
+
}
|
|
133
202
|
}
|
|
134
|
-
});
|
|
135
|
-
document.tags = tagDefinitions;
|
|
136
203
|
}
|
|
137
204
|
{
|
|
138
|
-
emitter.emit("msg", msg = "
|
|
205
|
+
emitter.emit("msg", msg = "Save to file");
|
|
139
206
|
let distFile = config.output === false ? false : config.output || "openapi.json";
|
|
140
207
|
if (distFile) {
|
|
141
208
|
distFile = path.resolve(distFile);
|
|
@@ -146,28 +213,28 @@ var generateOpenapi = async (config) => {
|
|
|
146
213
|
await writeFile(distFile, content, {
|
|
147
214
|
mode: config.fileMode
|
|
148
215
|
});
|
|
216
|
+
const size = bytes(Buffer.byteLength(content), { unitSeparator: "" });
|
|
149
217
|
emitter.emit(
|
|
150
218
|
"replace",
|
|
151
|
-
msg + path.relative(process.cwd(), distFile) +
|
|
152
|
-
spacer: ""
|
|
153
|
-
}),
|
|
219
|
+
msg + ": " + path.relative(process.cwd(), distFile) + chalk2.gray(` [size: ${size}]`),
|
|
154
220
|
true
|
|
155
221
|
);
|
|
156
222
|
} else {
|
|
157
223
|
emitter.emit("replace", skip(msg));
|
|
158
224
|
}
|
|
159
225
|
}
|
|
160
|
-
|
|
161
|
-
const result = await validate(document);
|
|
226
|
+
let result;
|
|
162
227
|
{
|
|
228
|
+
emitter.emit("msg", msg = "Validate");
|
|
229
|
+
result = await validate(document);
|
|
163
230
|
const summary = [];
|
|
164
231
|
if (result.errors?.length) {
|
|
165
|
-
summary.push(`${result.errors.length}
|
|
232
|
+
summary.push(`${result.errors.length} errors`);
|
|
166
233
|
}
|
|
167
234
|
if (result.warnings?.length) {
|
|
168
|
-
summary.push(`${result.warnings.length}
|
|
235
|
+
summary.push(`${result.warnings.length} warnings`);
|
|
169
236
|
}
|
|
170
|
-
summary.length && emitter.emit("replace", msg + chalk2.yellow(summary.join("\uFF0C")));
|
|
237
|
+
summary.length && emitter.emit("replace", msg + " " + chalk2.yellow(summary.join("\uFF0C")));
|
|
171
238
|
emitter.emit(
|
|
172
239
|
"end",
|
|
173
240
|
result.errors?.length ? "fail" : result.warnings?.length ? "warn" : "ok"
|
|
@@ -181,7 +248,10 @@ var generateOpenapi = async (config) => {
|
|
|
181
248
|
}
|
|
182
249
|
};
|
|
183
250
|
};
|
|
184
|
-
var
|
|
251
|
+
var methods = Object.values(METHOD).map(
|
|
252
|
+
(method) => method.toLowerCase()
|
|
253
|
+
);
|
|
254
|
+
var skip = (message) => message + " " + chalk2.gray("[skipped]");
|
|
185
255
|
var normalizePath = (uri) => {
|
|
186
256
|
return uri.replace(/:([a-z0-9_?]+)/gi, (_, $1) => {
|
|
187
257
|
return `{${$1.replace(/[?]/g, "")}}`;
|
|
@@ -205,6 +275,7 @@ var openapi = (options) => {
|
|
|
205
275
|
middleware2.console(async (ctx, next) => {
|
|
206
276
|
if (ctx.request.command !== commandName)
|
|
207
277
|
return next();
|
|
278
|
+
ctx.response.commandMatched = true;
|
|
208
279
|
const emitter = new EventEmitter2();
|
|
209
280
|
const spinner = ora();
|
|
210
281
|
emitter.on("msg", (msg) => {
|
|
@@ -220,7 +291,7 @@ var openapi = (options) => {
|
|
|
220
291
|
});
|
|
221
292
|
let result;
|
|
222
293
|
try {
|
|
223
|
-
result = (await
|
|
294
|
+
result = (await generateDocument({ ...options, emitter })).result;
|
|
224
295
|
} catch (e) {
|
|
225
296
|
spinner.fail();
|
|
226
297
|
throw e;
|
|
@@ -242,10 +313,10 @@ var openapi = (options) => {
|
|
|
242
313
|
};
|
|
243
314
|
var formatValidateMessage = (item) => {
|
|
244
315
|
let pathname = item.path.length ? item.path.join(".") : "";
|
|
245
|
-
|
|
246
|
-
return `${pathname}${item.message}`;
|
|
316
|
+
return `[${pathname || "."}] ${item.message}`;
|
|
247
317
|
};
|
|
248
318
|
export {
|
|
319
|
+
generateDocument,
|
|
249
320
|
openapi
|
|
250
321
|
};
|
|
251
322
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/openapi.ts","../src/openapi-to-help.ts","../src/generate-openapi.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 generateOpenapi,\n type OpenapiValidateResultItem,\n type OpenapiOptions,\n type OpenapiValidateResult,\n} from './generate-openapi';\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 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 generateOpenapi({ ...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 pathname =\n pathname && !item.message.includes(`\"${pathname}\"`) ? `[${pathname}] ` : '';\n return `${pathname}${item.message}`;\n};\n","import { HelpMiddleware, scriptName } from '@aomex/console';\nimport { middleware } from '@aomex/core';\nimport { chalk } from '@aomex/helper';\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 const { status, yargs } = ctx.cli;\n\n switch (status) {\n case 'show-all':\n yargs.command(commandName, summary || '生成openapi标准文档');\n return next();\n case 'show-detail':\n if (!showInHelp || ctx.request.command !== commandName) {\n return next();\n }\n\n yargs.usage(\n `${scriptName} ${commandName} [options]${\n description ? '\\n\\n' + chalk.bold(description) : ''\n }`,\n );\n ctx.response.commandMatched = true;\n return;\n default:\n const _: never = status;\n assert(_);\n }\n });\n","import EventEmitter from 'node:events';\nimport type { Mode } from 'node:fs';\nimport { readPackageUp } from 'read-pkg-up';\nimport { filesize } from 'filesize';\nimport { Chain, OpenAPI } from '@aomex/core';\nimport { chalk, sleep } from '@aomex/helper';\nimport {\n fileToModules,\n type PathToFileOptions,\n pathToFiles,\n} from '@aomex/file-parser';\nimport { WebMiddleware } from '@aomex/web';\nimport { Router } from '@aomex/web-router';\nimport validate from 'ibm-openapi-validator';\nimport path from 'node:path';\nimport { mkdir, writeFile } from 'node:fs/promises';\nimport yaml from 'yaml';\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 * 路由所在目录,与创建WebApp时提供的一致\n */\n routers: PathToFileOptions;\n /**\n * 文档的一些基础信息\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 * 输出到指定文件,支持JSON和yaml格式。默认:`openapi.json`\n */\n output?: false | string;\n /**\n * 输出文件的权限\n */\n fileMode?: Mode;\n /**\n * 如果是JSON文件,内容是否需要格式化以方便调试,代价是文件体积增加了,默认:false\n */\n prettyJson?: boolean;\n /**\n * 内容写入文件前的修正回调。如果是框架的问题,请提交issue\n */\n fix?: (data: OpenAPI.Document) => void;\n /**\n * 执行日志流输出\n */\n emitter: EventEmitter;\n}\n\nexport const generateOpenapi = 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', '初始化');\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.paths = {};\n document.info.title ||=\n (await readPackageUp())?.packageJson.name || 'API文档';\n document.info.version ||=\n (await readPackageUp())?.packageJson.version || '0.0.0';\n }\n\n emitter.emit('msg', (msg = '搜索路由文件'));\n const files = await pathToFiles(config.routers);\n emitter.emit('msg', (msg = '解析路由'));\n const usedTags: string[] = [];\n for (const file of files) {\n emitter.emit('replace', msg + path.relative(process.cwd(), file));\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('GET') && methods.includes('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<typeof method>}`\n ] = {\n tags: [getTagByFilename(file)],\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 methodItem,\n });\n }\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 emitter.emit('msg', (msg = '手动修复文档'));\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 = '文档内容清理并整合'));\n const tagDefinitions = document.tags!.filter(({ name: tag }) =>\n usedTags.includes(tag),\n );\n const definedTags = tagDefinitions.map((item) => item.name);\n [...new Set(usedTags)].sort().forEach((tag) => {\n if (!definedTags.includes(tag)) {\n tagDefinitions.push({\n name: tag,\n });\n }\n });\n document.tags = tagDefinitions;\n }\n\n {\n emitter.emit('msg', (msg = '保存到文件'));\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 emitter.emit(\n 'replace',\n msg +\n path.relative(process.cwd(), distFile) +\n ' ' +\n filesize(Buffer.byteLength(content), {\n spacer: '',\n }),\n true,\n );\n } else {\n emitter.emit('replace', skip(msg));\n }\n }\n\n emitter.emit('msg', (msg = '验证openapi文档'));\n const result = (await validate(document)) as OpenapiValidateResult;\n\n {\n const summary: string[] = [];\n if (result.errors?.length) {\n summary.push(`${result.errors.length}个错误`);\n }\n if (result.warnings?.length) {\n summary.push(`${result.warnings.length}个警告`);\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 skip = (message: string) => message + ':' + chalk.gray('[跳过]');\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"],"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,QAAM,EAAE,QAAQ,MAAM,IAAI,IAAI;AAE9B,UAAQ,QAAQ;AAAA,IACd,KAAK;AACH,YAAM,QAAQ,aAAa,WAAW,6CAAe;AACrD,aAAO,KAAK;AAAA,IACd,KAAK;AACH,UAAI,CAAC,cAAc,IAAI,QAAQ,YAAY,aAAa;AACtD,eAAO,KAAK;AAAA,MACd;AAEA,YAAM;AAAA,QACJ,GAAG,cAAc,wBACf,cAAc,SAAS,MAAM,KAAK,WAAW,IAAI;AAAA,MAErD;AACA,UAAI,SAAS,iBAAiB;AAC9B;AAAA,IACF;AACE,YAAM,IAAW;AACjB,aAAO,CAAC;AAAA,EACZ;AACF,CAAC;;;ACjCH,OAAO,kBAAkB;AAEzB,SAAS,qBAAqB;AAC9B,SAAS,gBAAgB;AACzB,SAAS,aAAsB;AAC/B,SAAS,SAAAC,QAAO,aAAa;AAC7B;AAAA,EACE;AAAA,EAEA;AAAA,OACK;AACP,SAAS,qBAAqB;AAC9B,SAAS,cAAc;AACvB,OAAO,cAAc;AACrB,OAAO,UAAU;AACjB,SAAS,OAAO,iBAAiB;AACjC,OAAO,UAAU;AAgDV,IAAM,kBAAkB,OAC7B,WAII;AACJ,QAAM,UAAU,OAAO,WAAW,IAAI,aAAa;AACnD,MAAI,MAAM;AAEV,UAAQ,KAAK,OAAO;AACpB,UAAQ,KAAK,OAAO,oBAAK;AACzB,QAAM,WAA6B,KAAK;AAAA,IACtC,KAAK,UAAU,OAAO,QAAQ,CAAC,CAAC;AAAA,EAClC;AAEA;AACE,aAAS,YAAY;AACrB,aAAS,SAAS,CAAC;AACnB,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,sCAAS;AACpC,QAAM,QAAQ,MAAM,YAAY,OAAO,OAAO;AAC9C,UAAQ,KAAK,OAAQ,MAAM,0BAAO;AAClC,QAAM,WAAqB,CAAC;AAC5B,aAAW,QAAQ,OAAO;AACxB,YAAQ,KAAK,WAAW,MAAM,KAAK,SAAS,QAAQ,IAAI,GAAG,IAAI,CAAC;AAChE,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,cAAI,UAAU,QAAQ;AAEtB,cAAI,QAAQ,SAAS,KAAK,KAAK,QAAQ,SAAS,MAAM,GAAG;AACvD,sBAAU,QAAQ,OAAO,CAAC,WAAW,WAAW,MAAM;AAAA,UACxD;AAEA,qBAAW,UAAU,SAAS;AAC5B,kBAAM,aAAuC,SAC3C,OAAO,YAAY,CACrB,IAAI;AAAA,cACF,MAAM,CAAC,iBAAiB,IAAI,CAAC;AAAA,cAC7B,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;AAAA,gBACF,CAAC;AAAA,cACH;AAAA,YACF;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,YAAQ,KAAK,OAAQ,MAAM,sCAAS;AACpC,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,wDAAY;AACvC,UAAM,iBAAiB,SAAS,KAAM;AAAA,MAAO,CAAC,EAAE,MAAM,IAAI,MACxD,SAAS,SAAS,GAAG;AAAA,IACvB;AACA,UAAM,cAAc,eAAe,IAAI,CAAC,SAAS,KAAK,IAAI;AAC1D,KAAC,GAAG,IAAI,IAAI,QAAQ,CAAC,EAAE,KAAK,EAAE,QAAQ,CAAC,QAAQ;AAC7C,UAAI,CAAC,YAAY,SAAS,GAAG,GAAG;AAC9B,uBAAe,KAAK;AAAA,UAClB,MAAM;AAAA,QACR,CAAC;AAAA,MACH;AAAA,IACF,CAAC;AACD,aAAS,OAAO;AAAA,EAClB;AAEA;AACE,YAAQ,KAAK,OAAQ,MAAM,gCAAQ;AACnC,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,cAAQ;AAAA,QACN;AAAA,QACA,MACE,KAAK,SAAS,QAAQ,IAAI,GAAG,QAAQ,IACrC,MACA,SAAS,OAAO,WAAW,OAAO,GAAG;AAAA,UACnC,QAAQ;AAAA,QACV,CAAC;AAAA,QACH;AAAA,MACF;AAAA,IACF,OAAO;AACL,cAAQ,KAAK,WAAW,KAAK,GAAG,CAAC;AAAA,IACnC;AAAA,EACF;AAEA,UAAQ,KAAK,OAAQ,MAAM,iCAAc;AACzC,QAAM,SAAU,MAAM,SAAS,QAAQ;AAEvC;AACE,UAAM,UAAoB,CAAC;AAC3B,QAAI,OAAO,QAAQ,QAAQ;AACzB,cAAQ,KAAK,GAAG,OAAO,OAAO,0BAAW;AAAA,IAC3C;AACA,QAAI,OAAO,UAAU,QAAQ;AAC3B,cAAQ,KAAK,GAAG,OAAO,SAAS,0BAAW;AAAA,IAC7C;AACA,YAAQ,UACN,QAAQ,KAAK,WAAW,MAAMD,OAAM,OAAO,QAAQ,KAAK,QAAG,CAAC,CAAC;AAE/D,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,WAAMA,OAAM,KAAK,gBAAM;AAEnE,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;;;AF5OO,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,IACCE,YAAW,QAAQ,OAAO,KAAK,SAAS;AACtC,UAAI,IAAI,QAAQ,YAAY;AAAa,eAAO,KAAK;AAErD,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,gBAAgB,EAAE,GAAG,SAAS,QAAQ,CAAC,GAAG;AAAA,MAC5D,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,aACE,YAAY,CAAC,KAAK,QAAQ,SAAS,IAAI,WAAW,IAAI,IAAI,eAAe;AAC3E,SAAO,GAAG,WAAW,KAAK;AAC5B;","names":["EventEmitter","middleware","chalk","middleware","middleware","EventEmitter"]}
|
|
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 { bytes, chalk, sleep } from '@aomex/utility';\nimport {\n fileToModules,\n type PathToFileOptions,\n pathToFiles,\n} from '@aomex/file-parser';\nimport { METHOD, WebMiddleware } from '@aomex/web';\nimport { Router } from '@aomex/web-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(path.posix.join(path.relative(process.cwd(), file))),\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,SAAS,OAAO,SAAAC,QAAO,aAAa;AACpC;AAAA,EACE;AAAA,EAEA;AAAA,OACK;AACP,SAAS,QAAQ,qBAAqB;AACtC,SAAS,cAAc;AACvB,OAAO,cAAc;AACrB,OAAO,UAAU;AACjB,SAAS,OAAO,iBAAiB;AACjC,OAAO,UAAU;;;AChBV,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;;;AD0DO,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,KAAK,KAAK,MAAM,KAAK,KAAK,SAAS,QAAQ,IAAI,GAAG,IAAI,CAAC,CAAC;AAAA,IAClE;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;;;AF1SO,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"]}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aomex/openapi",
|
|
3
|
-
"version": "0.0.
|
|
4
|
-
"description": "",
|
|
3
|
+
"version": "0.0.8",
|
|
4
|
+
"description": "Openapi documentation generator",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"exports": {
|
|
@@ -26,26 +26,29 @@
|
|
|
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/web": "^0.0.
|
|
32
|
-
"@aomex/web-router": "^0.0.
|
|
29
|
+
"@aomex/console": "^0.0.7",
|
|
30
|
+
"@aomex/core": "^0.0.7",
|
|
31
|
+
"@aomex/web": "^0.0.8",
|
|
32
|
+
"@aomex/web-router": "^0.0.8"
|
|
33
33
|
},
|
|
34
34
|
"dependencies": {
|
|
35
|
-
"@aomex/file-parser": "^0.0.
|
|
36
|
-
"@aomex/
|
|
37
|
-
"
|
|
38
|
-
"ibm-openapi-validator": "^0.97.
|
|
35
|
+
"@aomex/file-parser": "^0.0.4",
|
|
36
|
+
"@aomex/utility": "^0.0.4",
|
|
37
|
+
"fast-deep-equal": "^3.1.3",
|
|
38
|
+
"ibm-openapi-validator": "^0.97.5",
|
|
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/web": "^0.0.
|
|
47
|
-
"@aomex/web-router": "^0.0.
|
|
48
|
-
"@types/ibm-openapi-validator": "^0.15.1"
|
|
45
|
+
"@aomex/console": "^0.0.7",
|
|
46
|
+
"@aomex/core": "^0.0.7",
|
|
47
|
+
"@aomex/web": "^0.0.8",
|
|
48
|
+
"@aomex/web-router": "^0.0.8",
|
|
49
|
+
"@types/ibm-openapi-validator": "^0.15.1",
|
|
50
|
+
"@types/lodash.snakecase": "^4.1.7",
|
|
51
|
+
"strip-ansi": "^7.0.1"
|
|
49
52
|
},
|
|
50
53
|
"scripts": {}
|
|
51
54
|
}
|