@aomex/openapi 0.0.6 → 0.0.7
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 +10 -67
- package/dist/index.d.ts +8 -7
- package/dist/index.js +14 -17
- package/dist/index.js.map +1 -1
- package/package.json +13 -14
package/CHANGELOG.md
CHANGED
|
@@ -1,74 +1,17 @@
|
|
|
1
1
|
# @aomex/openapi
|
|
2
2
|
|
|
3
|
-
## 0.0.
|
|
3
|
+
## 0.0.7
|
|
4
4
|
|
|
5
5
|
### Patch Changes
|
|
6
6
|
|
|
7
|
-
- [`
|
|
7
|
+
- [`bbc8dda`](https://github.com/aomex/aomex/commit/bbc8dda9f0876c3402608133085350cc693def6f) Thanks [@geekact](https://github.com/geekact)! - refactor: rename package helper to utility
|
|
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
|
+
- [`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
|
|
16
10
|
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
-
|
|
22
|
-
|
|
23
|
-
-
|
|
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
|
|
34
|
-
|
|
35
|
-
### Patch Changes
|
|
36
|
-
|
|
37
|
-
- [`6c66ab8`](https://github.com/aomex/aomex/commit/6c66ab86d45fae554404453d718da17f798df45f) Thanks [@geekact](https://github.com/geekact)! - 路由增加 docs 属性
|
|
38
|
-
|
|
39
|
-
- [`91feda4`](https://github.com/aomex/aomex/commit/91feda457dfa8bd8dd2c8f38bfaaf4f7f2f7702f) Thanks [@geekact](https://github.com/geekact)! - 重命名 pathItemInMethod 为 methodItem
|
|
40
|
-
|
|
41
|
-
- Updated dependencies [[`6c66ab8`](https://github.com/aomex/aomex/commit/6c66ab86d45fae554404453d718da17f798df45f), [`121253a`](https://github.com/aomex/aomex/commit/121253a6fc203e427bfd25e82d713bec6ac13b38), [`ee5f8ca`](https://github.com/aomex/aomex/commit/ee5f8ca34df085ab9b5ef2a3525cf361ac46440a), [`59dc183`](https://github.com/aomex/aomex/commit/59dc183bcec9b7221c18865563b38cba5d82869b), [`8cb74fd`](https://github.com/aomex/aomex/commit/8cb74fdd27626037aa9bc80cb2930e4f0d67f8e6), [`d06c1c1`](https://github.com/aomex/aomex/commit/d06c1c1bdfee8657a74bbcbb06a2880263e85529), [`d834392`](https://github.com/aomex/aomex/commit/d834392b1e0f6333d66d11378d9f4ceb813a58a9), [`91feda4`](https://github.com/aomex/aomex/commit/91feda457dfa8bd8dd2c8f38bfaaf4f7f2f7702f)]:
|
|
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
|
|
46
|
-
|
|
47
|
-
## 0.0.3
|
|
48
|
-
|
|
49
|
-
### Patch Changes
|
|
50
|
-
|
|
51
|
-
- Updated dependencies [[`4735157`](https://github.com/aomex/aomex/commit/4735157c52d0abecc41d6c7f416280ebfd6ee696), [`f0b7c9a`](https://github.com/aomex/aomex/commit/f0b7c9a7ce70774080b645c4952ad9b1d0948cf5), [`d6ac7b5`](https://github.com/aomex/aomex/commit/d6ac7b5403334b51fa15dbe82dd6b5b6d048f661), [`9254754`](https://github.com/aomex/aomex/commit/9254754d234fc0062eb5d600284ee8453825306c), [`d1ce4e2`](https://github.com/aomex/aomex/commit/d1ce4e2276f93c44e67ea06666d048917fa94e53), [`6056f55`](https://github.com/aomex/aomex/commit/6056f556577865220d6b5be2a4eafad9e4dbf8d4), [`1c67399`](https://github.com/aomex/aomex/commit/1c673992c4b313c2accb4cbc1fc66537a9886c29), [`352642a`](https://github.com/aomex/aomex/commit/352642abf2ccb3fe97e2d83a691d8428ccfc9758)]:
|
|
52
|
-
- @aomex/web@0.0.3
|
|
53
|
-
- @aomex/console@0.0.2
|
|
54
|
-
- @aomex/core@0.0.2
|
|
55
|
-
- @aomex/web-router@0.0.3
|
|
56
|
-
|
|
57
|
-
## 0.0.2
|
|
58
|
-
|
|
59
|
-
### Patch Changes
|
|
60
|
-
|
|
61
|
-
- Updated dependencies [[`cdb1405`](https://github.com/aomex/aomex/commit/cdb1405ccb557c122fc6b6cfdc8b845caacba87c)]:
|
|
62
|
-
- @aomex/web-router@0.0.2
|
|
63
|
-
- @aomex/web@0.0.2
|
|
64
|
-
|
|
65
|
-
## 0.0.1
|
|
66
|
-
|
|
67
|
-
### Patch Changes
|
|
68
|
-
|
|
69
|
-
- Updated dependencies [[`be095e9`](https://github.com/aomex/aomex/commit/be095e964ec136982581f4ea09024f716ff93a3d)]:
|
|
70
|
-
- @aomex/helper@0.0.1
|
|
71
|
-
- @aomex/web-router@0.0.1
|
|
72
|
-
- @aomex/console@0.0.1
|
|
73
|
-
- @aomex/core@0.0.1
|
|
74
|
-
- @aomex/web@0.0.1
|
|
11
|
+
- 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)]:
|
|
12
|
+
- @aomex/file-parser@0.0.3
|
|
13
|
+
- @aomex/web-router@0.0.7
|
|
14
|
+
- @aomex/console@0.0.6
|
|
15
|
+
- @aomex/utility@0.0.4
|
|
16
|
+
- @aomex/core@0.0.6
|
|
17
|
+
- @aomex/web@0.0.7
|
package/dist/index.d.ts
CHANGED
|
@@ -6,11 +6,11 @@ import { PathToFileOptions } from '@aomex/file-parser';
|
|
|
6
6
|
|
|
7
7
|
interface OpenapiOptions {
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Web api routers
|
|
10
10
|
*/
|
|
11
11
|
routers: PathToFileOptions;
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
13
|
+
* Openapi basic information
|
|
14
14
|
* @see OpenApiDocs
|
|
15
15
|
*/
|
|
16
16
|
docs?: Omit<OpenAPI.Document, 'paths' | 'openapi' | 'info'> & {
|
|
@@ -18,23 +18,24 @@ interface OpenapiOptions {
|
|
|
18
18
|
info?: Partial<OpenAPI.Document['info']>;
|
|
19
19
|
};
|
|
20
20
|
/**
|
|
21
|
-
*
|
|
21
|
+
* Save document to specific file (`*.yaml`|`*.json`). Defaults `openapi.json`
|
|
22
22
|
*/
|
|
23
23
|
output?: false | string;
|
|
24
24
|
/**
|
|
25
|
-
*
|
|
25
|
+
* File mode. Defaults according system
|
|
26
|
+
* @see OpenapiOptions.output
|
|
26
27
|
*/
|
|
27
28
|
fileMode?: Mode;
|
|
28
29
|
/**
|
|
29
|
-
*
|
|
30
|
+
* Format JSON document to human readable. Defaults `false`
|
|
30
31
|
*/
|
|
31
32
|
prettyJson?: boolean;
|
|
32
33
|
/**
|
|
33
|
-
*
|
|
34
|
+
* Fix the document by hand after the full document is generated
|
|
34
35
|
*/
|
|
35
36
|
fix?: (data: OpenAPI.Document) => void;
|
|
36
37
|
/**
|
|
37
|
-
*
|
|
38
|
+
* Log emitter
|
|
38
39
|
*/
|
|
39
40
|
emitter: EventEmitter;
|
|
40
41
|
}
|
package/dist/index.js
CHANGED
|
@@ -6,7 +6,7 @@ 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
11
|
const { status, yargs } = ctx.cli;
|
|
12
12
|
switch (status) {
|
|
@@ -31,9 +31,8 @@ var openapiToHelp = (commandName, summary, description, showInHelp = true) => mi
|
|
|
31
31
|
// src/generate-openapi.ts
|
|
32
32
|
import EventEmitter from "node:events";
|
|
33
33
|
import { readPackageUp } from "read-pkg-up";
|
|
34
|
-
import { filesize } from "filesize";
|
|
35
34
|
import { Chain } from "@aomex/core";
|
|
36
|
-
import { chalk as chalk2, sleep } from "@aomex/
|
|
35
|
+
import { bytes, chalk as chalk2, sleep } from "@aomex/utility";
|
|
37
36
|
import {
|
|
38
37
|
fileToModules,
|
|
39
38
|
pathToFiles
|
|
@@ -48,7 +47,7 @@ var generateOpenapi = async (config) => {
|
|
|
48
47
|
const emitter = config.emitter || new EventEmitter();
|
|
49
48
|
let msg = "";
|
|
50
49
|
emitter.emit("start");
|
|
51
|
-
emitter.emit("msg", "
|
|
50
|
+
emitter.emit("msg", "Initialize");
|
|
52
51
|
const document = JSON.parse(
|
|
53
52
|
JSON.stringify(config.docs || {})
|
|
54
53
|
);
|
|
@@ -56,12 +55,12 @@ var generateOpenapi = async (config) => {
|
|
|
56
55
|
document.openapi ||= "3.0.3";
|
|
57
56
|
document.tags ||= [];
|
|
58
57
|
document.paths = {};
|
|
59
|
-
document.info.title ||= (await readPackageUp())?.packageJson.name || "API
|
|
58
|
+
document.info.title ||= (await readPackageUp())?.packageJson.name || "API documentation";
|
|
60
59
|
document.info.version ||= (await readPackageUp())?.packageJson.version || "0.0.0";
|
|
61
60
|
}
|
|
62
|
-
emitter.emit("msg", msg = "
|
|
61
|
+
emitter.emit("msg", msg = "Search routers");
|
|
63
62
|
const files = await pathToFiles(config.routers);
|
|
64
|
-
emitter.emit("msg", msg = "
|
|
63
|
+
emitter.emit("msg", msg = "Parse router");
|
|
65
64
|
const usedTags = [];
|
|
66
65
|
for (const file of files) {
|
|
67
66
|
emitter.emit("replace", msg + path.relative(process.cwd(), file));
|
|
@@ -112,7 +111,7 @@ var generateOpenapi = async (config) => {
|
|
|
112
111
|
}
|
|
113
112
|
emitter.emit("replace", msg);
|
|
114
113
|
{
|
|
115
|
-
emitter.emit("msg", msg = "
|
|
114
|
+
emitter.emit("msg", msg = "Fix document by hand");
|
|
116
115
|
if (config.fix) {
|
|
117
116
|
config.fix(document);
|
|
118
117
|
} else {
|
|
@@ -120,7 +119,7 @@ var generateOpenapi = async (config) => {
|
|
|
120
119
|
}
|
|
121
120
|
}
|
|
122
121
|
{
|
|
123
|
-
emitter.emit("msg", msg = "
|
|
122
|
+
emitter.emit("msg", msg = "Optimize document");
|
|
124
123
|
const tagDefinitions = document.tags.filter(
|
|
125
124
|
({ name: tag }) => usedTags.includes(tag)
|
|
126
125
|
);
|
|
@@ -135,7 +134,7 @@ var generateOpenapi = async (config) => {
|
|
|
135
134
|
document.tags = tagDefinitions;
|
|
136
135
|
}
|
|
137
136
|
{
|
|
138
|
-
emitter.emit("msg", msg = "
|
|
137
|
+
emitter.emit("msg", msg = "Save to file");
|
|
139
138
|
let distFile = config.output === false ? false : config.output || "openapi.json";
|
|
140
139
|
if (distFile) {
|
|
141
140
|
distFile = path.resolve(distFile);
|
|
@@ -148,24 +147,22 @@ var generateOpenapi = async (config) => {
|
|
|
148
147
|
});
|
|
149
148
|
emitter.emit(
|
|
150
149
|
"replace",
|
|
151
|
-
msg + path.relative(process.cwd(), distFile) + " " +
|
|
152
|
-
spacer: ""
|
|
153
|
-
}),
|
|
150
|
+
msg + path.relative(process.cwd(), distFile) + " " + bytes(Buffer.byteLength(content), { unitSeparator: "" }),
|
|
154
151
|
true
|
|
155
152
|
);
|
|
156
153
|
} else {
|
|
157
154
|
emitter.emit("replace", skip(msg));
|
|
158
155
|
}
|
|
159
156
|
}
|
|
160
|
-
emitter.emit("msg", msg = "
|
|
157
|
+
emitter.emit("msg", msg = "Validate");
|
|
161
158
|
const result = await validate(document);
|
|
162
159
|
{
|
|
163
160
|
const summary = [];
|
|
164
161
|
if (result.errors?.length) {
|
|
165
|
-
summary.push(`${result.errors.length}
|
|
162
|
+
summary.push(`${result.errors.length} errors`);
|
|
166
163
|
}
|
|
167
164
|
if (result.warnings?.length) {
|
|
168
|
-
summary.push(`${result.warnings.length}
|
|
165
|
+
summary.push(`${result.warnings.length} warnings`);
|
|
169
166
|
}
|
|
170
167
|
summary.length && emitter.emit("replace", msg + chalk2.yellow(summary.join("\uFF0C")));
|
|
171
168
|
emitter.emit(
|
|
@@ -181,7 +178,7 @@ var generateOpenapi = async (config) => {
|
|
|
181
178
|
}
|
|
182
179
|
};
|
|
183
180
|
};
|
|
184
|
-
var skip = (message) => message + "
|
|
181
|
+
var skip = (message) => message + " " + chalk2.gray("[skipped]");
|
|
185
182
|
var normalizePath = (uri) => {
|
|
186
183
|
return uri.replace(/:([a-z0-9_?]+)/gi, (_, $1) => {
|
|
187
184
|
return `{${$1.replace(/[?]/g, "")}}`;
|
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-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/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 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 { 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 { 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 * 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 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', '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.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('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 = '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 document'));\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 = '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 emitter.emit(\n 'replace',\n msg +\n path.relative(process.cwd(), distFile) +\n ' ' +\n bytes(Buffer.byteLength(content), { unitSeparator: '' }),\n true,\n );\n } else {\n emitter.emit('replace', skip(msg));\n }\n }\n\n emitter.emit('msg', (msg = 'Validate'));\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} 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 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"],"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,aAAsB;AAC/B,SAAS,OAAO,SAAAC,QAAO,aAAa;AACpC;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;AAiDV,IAAM,kBAAkB,OAC7B,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,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,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,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,mBAAoB;AAC/C,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,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,cAAQ;AAAA,QACN;AAAA,QACA,MACE,KAAK,SAAS,QAAQ,IAAI,GAAG,QAAQ,IACrC,MACA,MAAM,OAAO,WAAW,OAAO,GAAG,EAAE,eAAe,GAAG,CAAC;AAAA,QACzD;AAAA,MACF;AAAA,IACF,OAAO;AACL,cAAQ,KAAK,WAAW,KAAK,GAAG,CAAC;AAAA,IACnC;AAAA,EACF;AAEA,UAAQ,KAAK,OAAQ,MAAM,UAAW;AACtC,QAAM,SAAU,MAAM,SAAS,QAAQ;AAEvC;AACE,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,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,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;;;AF1OO,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"]}
|
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.7",
|
|
4
|
+
"description": "Openapi documentation generator",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
7
7
|
"exports": {
|
|
@@ -26,25 +26,24 @@
|
|
|
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.6",
|
|
30
|
+
"@aomex/core": "^0.0.6",
|
|
31
|
+
"@aomex/web": "^0.0.7",
|
|
32
|
+
"@aomex/web-router": "^0.0.7"
|
|
33
33
|
},
|
|
34
34
|
"dependencies": {
|
|
35
|
-
"@aomex/file-parser": "^0.0.
|
|
36
|
-
"@aomex/
|
|
37
|
-
"
|
|
38
|
-
"ibm-openapi-validator": "^0.97.3",
|
|
35
|
+
"@aomex/file-parser": "^0.0.3",
|
|
36
|
+
"@aomex/utility": "^0.0.4",
|
|
37
|
+
"ibm-openapi-validator": "^0.97.4",
|
|
39
38
|
"ora": "^6.1.2",
|
|
40
39
|
"read-pkg-up": "^9.1.0",
|
|
41
40
|
"yaml": "^2.2.1"
|
|
42
41
|
},
|
|
43
42
|
"devDependencies": {
|
|
44
|
-
"@aomex/console": "^0.0.
|
|
45
|
-
"@aomex/core": "^0.0.
|
|
46
|
-
"@aomex/web": "^0.0.
|
|
47
|
-
"@aomex/web-router": "^0.0.
|
|
43
|
+
"@aomex/console": "^0.0.6",
|
|
44
|
+
"@aomex/core": "^0.0.6",
|
|
45
|
+
"@aomex/web": "^0.0.7",
|
|
46
|
+
"@aomex/web-router": "^0.0.7",
|
|
48
47
|
"@types/ibm-openapi-validator": "^0.15.1"
|
|
49
48
|
},
|
|
50
49
|
"scripts": {}
|