@aomex/openapi 0.0.7 → 0.0.9

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 CHANGED
@@ -1,5 +1,34 @@
1
1
  # @aomex/openapi
2
2
 
3
+ ## 0.0.9
4
+
5
+ ### Patch Changes
6
+
7
+ - [`be02395`](https://github.com/aomex/aomex/commit/be02395503ad81a6205209b4c8e1ad377bfc4227) Thanks [@geekact](https://github.com/geekact)! - fix(openapi): forget to set commandMatched
8
+
9
+ - [`436e856`](https://github.com/aomex/aomex/commit/436e856c62ca01cc34e90c8ce27a38e5cbbd7aee) Thanks [@geekact](https://github.com/geekact)! - feat(openapi): append tags before fix operation
10
+
11
+ - [`4bd8e01`](https://github.com/aomex/aomex/commit/4bd8e01e0bb6d0e02c9a1ea4716ae43279b36952) Thanks [@geekact](https://github.com/geekact)! - feat(openapi): it's unnecessary to remove unused tags
12
+
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
14
+
15
+ - [`96e41e4`](https://github.com/aomex/aomex/commit/96e41e4ba2534d522c273f36e648e00eac2dfaa9) Thanks [@geekact](https://github.com/geekact)! - feat(openapi): rise common parameters to path object
16
+
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
18
+
19
+ - [`0c4d62e`](https://github.com/aomex/aomex/commit/0c4d62eda0a3009b288dc87494ac1d083d5c4a90) Thanks [@geekact](https://github.com/geekact)! - feat(openapi): generate operationId to get rid of warning
20
+
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
22
+
23
+ - [`9da842a`](https://github.com/aomex/aomex/commit/9da842a203412c711dd135efdb52c821639cfc29) Thanks [@geekact](https://github.com/geekact)! - fix(openapi): relative router file path use forward slash
24
+
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), [`912ed81`](https://github.com/aomex/aomex/commit/912ed81c12a3ff12c13607732107dec66c586a38), [`6c6cda2`](https://github.com/aomex/aomex/commit/6c6cda26522176c44761a738f2bc106a1889497b), [`d80df1a`](https://github.com/aomex/aomex/commit/d80df1a07eb92214a9c3c7fa15c629ea1ee88c43)]:
26
+ - @aomex/file-parser@0.0.5
27
+ - @aomex/web@0.0.9
28
+ - @aomex/console@0.0.8
29
+ - @aomex/web-router@0.0.9
30
+ - @aomex/core@0.0.8
31
+
3
32
  ## 0.0.7
4
33
 
5
34
  ### Patch Changes
package/dist/index.d.ts CHANGED
@@ -4,6 +4,15 @@ 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
@@ -39,6 +48,10 @@ interface OpenapiOptions {
39
48
  */
40
49
  emitter: EventEmitter;
41
50
  }
51
+ declare const generateDocument: (config: OpenapiOptions) => Promise<{
52
+ document: OpenAPI.Document;
53
+ result: OpenapiValidateResult;
54
+ }>;
42
55
 
43
56
  declare const openapi: (options: Omit<OpenapiOptions, 'emitter'> & {
44
57
  renderWarnings?: boolean;
@@ -48,4 +61,4 @@ declare const openapi: (options: Omit<OpenapiOptions, 'emitter'> & {
48
61
  description?: string;
49
62
  }) => _aomex_console.ConsoleChain<object>;
50
63
 
51
- export { openapi };
64
+ export { OpenapiOptions, OpenapiValidateResult, OpenapiValidateResultItem, generateDocument, openapi };
package/dist/index.js CHANGED
@@ -8,42 +8,57 @@ import { scriptName } from "@aomex/console";
8
8
  import { middleware } from "@aomex/core";
9
9
  import { chalk } from "@aomex/utility";
10
10
  var openapiToHelp = (commandName, summary, description, showInHelp = true) => middleware.help(async (ctx, next) => {
11
- const { status, yargs } = ctx.cli;
12
- switch (status) {
13
- case "show-all":
14
- yargs.command(commandName, summary || "\u751F\u6210openapi\u6807\u51C6\u6587\u6863");
15
- return next();
16
- case "show-detail":
17
- if (!showInHelp || ctx.request.command !== commandName) {
18
- return next();
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
- ctx.response.commandMatched = true;
24
- return;
25
- default:
26
- const _ = status;
27
- assert(_);
28
- }
23
+ },
24
+ next
25
+ });
29
26
  });
30
27
 
31
- // src/generate-openapi.ts
28
+ // src/generate-document.ts
32
29
  import EventEmitter from "node:events";
33
30
  import { readPackageUp } from "read-pkg-up";
31
+ import snakeCase from "lodash.snakecase";
32
+ import equal from "fast-deep-equal";
34
33
  import { Chain } from "@aomex/core";
35
34
  import { bytes, chalk as chalk2, sleep } from "@aomex/utility";
36
35
  import {
37
36
  fileToModules,
38
37
  pathToFiles
39
38
  } from "@aomex/file-parser";
40
- import { WebMiddleware } from "@aomex/web";
39
+ import { METHOD, WebMiddleware } from "@aomex/web";
41
40
  import { Router } from "@aomex/web-router";
42
41
  import validate from "ibm-openapi-validator";
43
42
  import path from "node:path";
44
43
  import { mkdir, writeFile } from "node:fs/promises";
45
44
  import yaml from "yaml";
46
- var generateOpenapi = async (config) => {
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) => {
47
62
  const emitter = config.emitter || new EventEmitter();
48
63
  let msg = "";
49
64
  emitter.emit("start");
@@ -54,6 +69,7 @@ var generateOpenapi = async (config) => {
54
69
  {
55
70
  document.openapi ||= "3.0.3";
56
71
  document.tags ||= [];
72
+ document.info ||= { title: "", version: "" };
57
73
  document.paths = {};
58
74
  document.info.title ||= (await readPackageUp())?.packageJson.name || "API documentation";
59
75
  document.info.version ||= (await readPackageUp())?.packageJson.version || "0.0.0";
@@ -63,7 +79,12 @@ var generateOpenapi = async (config) => {
63
79
  emitter.emit("msg", msg = "Parse router");
64
80
  const usedTags = [];
65
81
  for (const file of files) {
66
- emitter.emit("replace", msg + path.relative(process.cwd(), file));
82
+ emitter.emit(
83
+ "replace",
84
+ msg + " " + chalk2.gray(
85
+ path.relative(process.cwd(), file).split(path.sep).join(path.posix.sep)
86
+ )
87
+ );
67
88
  await sleep(50);
68
89
  const routers = await fileToModules(
69
90
  [file],
@@ -75,13 +96,12 @@ var generateOpenapi = async (config) => {
75
96
  for (const builder of builders) {
76
97
  for (const uri of builder.uris) {
77
98
  const pathItem = document.paths[normalizePath(uri)] ||= {};
78
- let methods = builder.methods;
79
- if (methods.includes("GET") && methods.includes("HEAD")) {
80
- methods = methods.filter((method) => method !== "HEAD");
99
+ let methods2 = builder.methods;
100
+ if (methods2.includes(METHOD.GET) && methods2.includes(METHOD.HEAD)) {
101
+ methods2 = methods2.filter((method) => method !== "HEAD");
81
102
  }
82
- for (const method of methods) {
103
+ for (const method of methods2) {
83
104
  const methodItem = pathItem[method.toLowerCase()] = {
84
- tags: [getTagByFilename(file)],
85
105
  responses: {},
86
106
  ...builder.docs
87
107
  };
@@ -92,10 +112,18 @@ var generateOpenapi = async (config) => {
92
112
  middleware3.toDocument({
93
113
  document,
94
114
  pathItem,
115
+ methodName: method,
95
116
  methodItem
96
117
  });
97
118
  }
98
119
  }
120
+ methodItem.tags ||= [getTagByFilename(file)];
121
+ methodItem.operationId ||= snakeCase(
122
+ methodToVerb(method, uri) + " " + uri
123
+ );
124
+ if (method === METHOD.POST) {
125
+ methodItem["x-codegen-request-body-name"] = "body";
126
+ }
99
127
  if (Object.keys(methodItem.responses).length === 0) {
100
128
  methodItem.responses = {
101
129
  default: {
@@ -110,6 +138,16 @@ var generateOpenapi = async (config) => {
110
138
  }
111
139
  }
112
140
  emitter.emit("replace", msg);
141
+ {
142
+ const tags = document.tags;
143
+ const definedTags = tags.map((item) => item.name);
144
+ for (const tag of [...new Set(usedTags)].sort()) {
145
+ if (!definedTags.includes(tag)) {
146
+ emitter.emit("msg", msg = `Append tag: ${tag}`);
147
+ tags.push({ name: tag });
148
+ }
149
+ }
150
+ }
113
151
  {
114
152
  emitter.emit("msg", msg = "Fix document by hand");
115
153
  if (config.fix) {
@@ -119,19 +157,51 @@ var generateOpenapi = async (config) => {
119
157
  }
120
158
  }
121
159
  {
122
- emitter.emit("msg", msg = "Optimize document");
123
- const tagDefinitions = document.tags.filter(
124
- ({ name: tag }) => usedTags.includes(tag)
125
- );
126
- const definedTags = tagDefinitions.map((item) => item.name);
127
- [...new Set(usedTags)].sort().forEach((tag) => {
128
- if (!definedTags.includes(tag)) {
129
- tagDefinitions.push({
130
- name: tag
160
+ emitter.emit("msg", msg = "Optimize common parameters");
161
+ pathLoop:
162
+ for (const path2 of Object.values(document.paths)) {
163
+ const parameters = [];
164
+ for (const method of methods) {
165
+ const methodItem = path2?.[method];
166
+ if (!methodItem)
167
+ continue;
168
+ const parameter = methodItem.parameters;
169
+ if (!parameter || !parameter.length)
170
+ continue pathLoop;
171
+ parameters.push(parameter);
172
+ }
173
+ if (parameters.length < 2)
174
+ continue pathLoop;
175
+ let intersect = parameters[0];
176
+ for (let i = 1; i < parameters.length; ++i) {
177
+ const parameter = parameters[i];
178
+ intersect = intersect.filter((item) => {
179
+ for (let j = 0; j < parameter.length; ++j) {
180
+ if (equal(parameter[j], item)) {
181
+ parameter[j] = item;
182
+ return true;
183
+ }
184
+ }
185
+ return false;
186
+ });
187
+ if (!intersect.length)
188
+ continue pathLoop;
189
+ }
190
+ path2.parameters = intersect;
191
+ intersect.forEach((item) => {
192
+ for (const parameter of parameters) {
193
+ parameter.splice(
194
+ parameter.findIndex((p) => p === item),
195
+ 1
196
+ );
197
+ }
131
198
  });
199
+ for (const method of methods) {
200
+ if (path2[method] && !path2[method].parameters.length) {
201
+ delete path2[method].parameters;
202
+ }
203
+ }
132
204
  }
133
- });
134
- document.tags = tagDefinitions;
135
205
  }
136
206
  {
137
207
  emitter.emit("msg", msg = "Save to file");
@@ -145,18 +215,20 @@ var generateOpenapi = async (config) => {
145
215
  await writeFile(distFile, content, {
146
216
  mode: config.fileMode
147
217
  });
218
+ const size = bytes(Buffer.byteLength(content), { unitSeparator: "" });
148
219
  emitter.emit(
149
220
  "replace",
150
- msg + path.relative(process.cwd(), distFile) + " " + bytes(Buffer.byteLength(content), { unitSeparator: "" }),
221
+ msg + ": " + path.relative(process.cwd(), distFile) + chalk2.gray(` [size: ${size}]`),
151
222
  true
152
223
  );
153
224
  } else {
154
225
  emitter.emit("replace", skip(msg));
155
226
  }
156
227
  }
157
- emitter.emit("msg", msg = "Validate");
158
- const result = await validate(document);
228
+ let result;
159
229
  {
230
+ emitter.emit("msg", msg = "Validate");
231
+ result = await validate(document);
160
232
  const summary = [];
161
233
  if (result.errors?.length) {
162
234
  summary.push(`${result.errors.length} errors`);
@@ -164,7 +236,7 @@ var generateOpenapi = async (config) => {
164
236
  if (result.warnings?.length) {
165
237
  summary.push(`${result.warnings.length} warnings`);
166
238
  }
167
- summary.length && emitter.emit("replace", msg + chalk2.yellow(summary.join("\uFF0C")));
239
+ summary.length && emitter.emit("replace", msg + " " + chalk2.yellow(summary.join("\uFF0C")));
168
240
  emitter.emit(
169
241
  "end",
170
242
  result.errors?.length ? "fail" : result.warnings?.length ? "warn" : "ok"
@@ -178,6 +250,9 @@ var generateOpenapi = async (config) => {
178
250
  }
179
251
  };
180
252
  };
253
+ var methods = Object.values(METHOD).map(
254
+ (method) => method.toLowerCase()
255
+ );
181
256
  var skip = (message) => message + " " + chalk2.gray("[skipped]");
182
257
  var normalizePath = (uri) => {
183
258
  return uri.replace(/:([a-z0-9_?]+)/gi, (_, $1) => {
@@ -202,6 +277,7 @@ var openapi = (options) => {
202
277
  middleware2.console(async (ctx, next) => {
203
278
  if (ctx.request.command !== commandName)
204
279
  return next();
280
+ ctx.response.commandMatched = true;
205
281
  const emitter = new EventEmitter2();
206
282
  const spinner = ora();
207
283
  emitter.on("msg", (msg) => {
@@ -217,7 +293,7 @@ var openapi = (options) => {
217
293
  });
218
294
  let result;
219
295
  try {
220
- result = (await generateOpenapi({ ...options, emitter })).result;
296
+ result = (await generateDocument({ ...options, emitter })).result;
221
297
  } catch (e) {
222
298
  spinner.fail();
223
299
  throw e;
@@ -239,10 +315,10 @@ var openapi = (options) => {
239
315
  };
240
316
  var formatValidateMessage = (item) => {
241
317
  let pathname = item.path.length ? item.path.join(".") : "";
242
- pathname = pathname && !item.message.includes(`"${pathname}"`) ? `[${pathname}] ` : "";
243
- return `${pathname}${item.message}`;
318
+ return `[${pathname || "."}] ${item.message}`;
244
319
  };
245
320
  export {
321
+ generateDocument,
246
322
  openapi
247
323
  };
248
324
  //# 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/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"]}
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(\n path\n .relative(process.cwd(), file)\n .split(path.sep)\n .join(path.posix.sep),\n ),\n );\n await sleep(50);\n\n const routers = await fileToModules<Router>(\n [file],\n (item) => !!item && item instanceof Router,\n );\n for (const router of routers) {\n const groupMiddlewareList = Chain.flatten(Router.getChain(router));\n const builders = Router.getBuilders(router);\n\n for (const builder of builders) {\n for (const uri of builder.uris) {\n const pathItem = (document.paths[normalizePath(uri)] ||= {});\n let methods = builder.methods;\n\n if (methods.includes(METHOD.GET) && methods.includes(METHOD.HEAD)) {\n methods = methods.filter((method) => method !== 'HEAD');\n }\n\n for (const method of methods) {\n const methodItem: OpenAPI.OperationObject = (pathItem[\n method.toLowerCase() as `${Lowercase<METHOD>}`\n ] = {\n responses: {},\n ...builder.docs,\n });\n\n for (const middleware of groupMiddlewareList.concat(\n Chain.flatten(builder.chain),\n )) {\n if (middleware instanceof WebMiddleware) {\n middleware.toDocument({\n document,\n pathItem,\n methodName: method,\n methodItem,\n });\n }\n }\n\n methodItem.tags ||= [getTagByFilename(file)];\n methodItem.operationId ||= snakeCase(\n methodToVerb(method, uri) + ' ' + uri,\n );\n\n if (method === METHOD.POST) {\n // @ts-expect-error against warning\n methodItem['x-codegen-request-body-name'] = 'body';\n }\n\n if (Object.keys(methodItem.responses).length === 0) {\n methodItem.responses = {\n default: {\n description: '',\n },\n };\n }\n\n usedTags.push(...methodItem.tags!);\n }\n }\n }\n }\n }\n emitter.emit('replace', msg);\n\n {\n const tags = document.tags!;\n const definedTags = tags.map((item) => item.name);\n for (const tag of [...new Set(usedTags)].sort()) {\n if (!definedTags.includes(tag)) {\n emitter.emit('msg', (msg = `Append tag: ${tag}`));\n tags.push({ name: tag });\n }\n }\n }\n\n {\n emitter.emit('msg', (msg = 'Fix document by hand'));\n if (config.fix) {\n config.fix(document);\n } else {\n emitter.emit('replace', skip(msg));\n }\n }\n\n {\n emitter.emit('msg', (msg = 'Optimize common parameters'));\n pathLoop: for (const path of Object.values(document.paths)) {\n const parameters: OpenAPI.ParameterObject[][] = [];\n for (const method of methods) {\n const methodItem = path?.[method];\n if (!methodItem) continue;\n const parameter = methodItem.parameters as\n | OpenAPI.ParameterObject[]\n | undefined;\n if (!parameter || !parameter.length) continue pathLoop;\n parameters.push(parameter);\n }\n if (parameters.length < 2) continue pathLoop;\n let intersect = parameters[0]!;\n for (let i = 1; i < parameters.length; ++i) {\n const parameter = parameters[i]!;\n intersect = intersect.filter((item) => {\n for (let j = 0; j < parameter.length; ++j) {\n if (equal(parameter[j], item)) {\n parameter[j] = item;\n return true;\n }\n }\n return false;\n });\n if (!intersect.length) continue pathLoop;\n }\n path!.parameters = intersect;\n intersect.forEach((item) => {\n for (const parameter of parameters) {\n parameter.splice(\n parameter.findIndex((p) => p === item),\n 1,\n );\n }\n });\n for (const method of methods) {\n if (path![method] && !path![method]!.parameters!.length) {\n delete path![method]!.parameters;\n }\n }\n }\n }\n\n {\n emitter.emit('msg', (msg = 'Save to file'));\n let distFile: typeof config.output =\n config.output === false ? false : config.output || 'openapi.json';\n if (distFile) {\n distFile = path.resolve(distFile);\n await mkdir(path.dirname(distFile), {\n recursive: true,\n });\n\n const content = ['.yml', '.yaml'].includes(path.extname(distFile))\n ? yaml.stringify(document)\n : JSON.stringify(document, null, config.prettyJson ? 2 : undefined);\n\n await writeFile(distFile, content, {\n mode: config.fileMode,\n });\n const size = bytes(Buffer.byteLength(content), { unitSeparator: '' });\n emitter.emit(\n 'replace',\n msg +\n ': ' +\n path.relative(process.cwd(), distFile) +\n chalk.gray(` [size: ${size}]`),\n true,\n );\n } else {\n emitter.emit('replace', skip(msg));\n }\n }\n\n let result: OpenapiValidateResult;\n {\n emitter.emit('msg', (msg = 'Validate'));\n result = (await validate(document)) as OpenapiValidateResult;\n const summary: string[] = [];\n if (result.errors?.length) {\n summary.push(`${result.errors.length} errors`);\n }\n if (result.warnings?.length) {\n summary.push(`${result.warnings.length} warnings`);\n }\n summary.length &&\n emitter.emit('replace', msg + ' ' + chalk.yellow(summary.join(',')));\n\n emitter.emit(\n 'end',\n result.errors?.length ? 'fail' : result.warnings?.length ? 'warn' : 'ok',\n );\n }\n\n return {\n document: JSON.parse(JSON.stringify(document)),\n result: {\n errors: result.errors || [],\n warnings: result.warnings || [],\n },\n };\n};\n\nconst methods = Object.values(METHOD).map((method) =>\n method.toLowerCase(),\n) as OpenAPI.HttpMethods[];\n\nconst skip = (message: string) => message + ' ' + chalk.gray('[skipped]');\n\nconst normalizePath = (uri: string) => {\n return uri.replace(/:([a-z0-9_?]+)/gi, (_, $1) => {\n return `{${$1.replace(/[?]/g, '')}}`;\n });\n};\n\nconst getTagByFilename = (file: string) => {\n return path.basename(file).replace(/\\..+$/, '');\n};\n","// Explain filed `operationId` to against ibm-openapi-validator warning\nexport const methodToVerb = (method: string, uri: string) => {\n method = method.toLowerCase();\n\n if (method === 'get' && !uri.includes(':')) return 'list';\n if (method === 'post') return 'create';\n if (method === 'put') return 'replace';\n if (method === 'patch') return 'update';\n return method;\n};\n"],"mappings":";AAAA,OAAOA,mBAAkB;AACzB,SAAS,OAAO,cAAAC,mBAAkB;AAClC,OAAO,SAAuB;;;ACF9B,SAAyB,kBAAkB;AAC3C,SAAS,kBAAkB;AAC3B,SAAS,aAAa;AAEf,IAAM,gBAAgB,CAC3B,aACA,SACA,aACA,aAAsB,SAEtB,WAAW,KAAK,OAAO,KAAK,SAAS;AACnC,SAAO,IAAI,IAAI,OAAO;AAAA,IACpB,IAAI,OAAO;AACT,YAAM;AAAA,QACJ,MAAM,OAAO,WAAW;AAAA,QACxB,WAAW;AAAA,MACb;AAAA,IACF;AAAA,IACA,eAAe,MAAM,cAAc,IAAI,QAAQ,YAAY;AAAA,IAC3D,OAAO,OAAO;AACZ,YAAM;AAAA,QACJ,GAAG,cAAc,wBACf,cAAc,SAAS,MAAM,KAAK,WAAW,IAAI;AAAA,MAErD;AAAA,IACF;AAAA,IACA;AAAA,EACF,CAAC;AACH,CAAC;;;AC5BH,OAAO,kBAAkB;AAEzB,SAAS,qBAAqB;AAC9B,OAAO,eAAe;AACtB,OAAO,WAAW;AAClB,SAAS,aAAsB;AAC/B,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;AAAA,QACJ,KACG,SAAS,QAAQ,IAAI,GAAG,IAAI,EAC5B,MAAM,KAAK,GAAG,EACd,KAAK,KAAK,MAAM,GAAG;AAAA,MACxB;AAAA,IACJ;AACA,UAAM,MAAM,EAAE;AAEd,UAAM,UAAU,MAAM;AAAA,MACpB,CAAC,IAAI;AAAA,MACL,CAAC,SAAS,CAAC,CAAC,QAAQ,gBAAgB;AAAA,IACtC;AACA,eAAW,UAAU,SAAS;AAC5B,YAAM,sBAAsB,MAAM,QAAQ,OAAO,SAAS,MAAM,CAAC;AACjE,YAAM,WAAW,OAAO,YAAY,MAAM;AAE1C,iBAAW,WAAW,UAAU;AAC9B,mBAAW,OAAO,QAAQ,MAAM;AAC9B,gBAAM,WAAY,SAAS,MAAM,cAAc,GAAG,CAAC,MAAM,CAAC;AAC1D,cAAIC,WAAU,QAAQ;AAEtB,cAAIA,SAAQ,SAAS,OAAO,GAAG,KAAKA,SAAQ,SAAS,OAAO,IAAI,GAAG;AACjE,YAAAA,WAAUA,SAAQ,OAAO,CAAC,WAAW,WAAW,MAAM;AAAA,UACxD;AAEA,qBAAW,UAAUA,UAAS;AAC5B,kBAAM,aAAuC,SAC3C,OAAO,YAAY,CACrB,IAAI;AAAA,cACF,WAAW,CAAC;AAAA,cACZ,GAAG,QAAQ;AAAA,YACb;AAEA,uBAAWC,eAAc,oBAAoB;AAAA,cAC3C,MAAM,QAAQ,QAAQ,KAAK;AAAA,YAC7B,GAAG;AACD,kBAAIA,uBAAsB,eAAe;AACvC,gBAAAA,YAAW,WAAW;AAAA,kBACpB;AAAA,kBACA;AAAA,kBACA,YAAY;AAAA,kBACZ;AAAA,gBACF,CAAC;AAAA,cACH;AAAA,YACF;AAEA,uBAAW,SAAS,CAAC,iBAAiB,IAAI,CAAC;AAC3C,uBAAW,gBAAgB;AAAA,cACzB,aAAa,QAAQ,GAAG,IAAI,MAAM;AAAA,YACpC;AAEA,gBAAI,WAAW,OAAO,MAAM;AAE1B,yBAAW,6BAA6B,IAAI;AAAA,YAC9C;AAEA,gBAAI,OAAO,KAAK,WAAW,SAAS,EAAE,WAAW,GAAG;AAClD,yBAAW,YAAY;AAAA,gBACrB,SAAS;AAAA,kBACP,aAAa;AAAA,gBACf;AAAA,cACF;AAAA,YACF;AAEA,qBAAS,KAAK,GAAG,WAAW,IAAK;AAAA,UACnC;AAAA,QACF;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACA,UAAQ,KAAK,WAAW,GAAG;AAE3B;AACE,UAAM,OAAO,SAAS;AACtB,UAAM,cAAc,KAAK,IAAI,CAAC,SAAS,KAAK,IAAI;AAChD,eAAW,OAAO,CAAC,GAAG,IAAI,IAAI,QAAQ,CAAC,EAAE,KAAK,GAAG;AAC/C,UAAI,CAAC,YAAY,SAAS,GAAG,GAAG;AAC9B,gBAAQ,KAAK,OAAQ,MAAM,eAAe,KAAM;AAChD,aAAK,KAAK,EAAE,MAAM,IAAI,CAAC;AAAA,MACzB;AAAA,IACF;AAAA,EACF;AAEA;AACE,YAAQ,KAAK,OAAQ,MAAM,sBAAuB;AAClD,QAAI,OAAO,KAAK;AACd,aAAO,IAAI,QAAQ;AAAA,IACrB,OAAO;AACL,cAAQ,KAAK,WAAW,KAAK,GAAG,CAAC;AAAA,IACnC;AAAA,EACF;AAEA;AACE,YAAQ,KAAK,OAAQ,MAAM,4BAA6B;AACxD;AAAU,iBAAWC,SAAQ,OAAO,OAAO,SAAS,KAAK,GAAG;AAC1D,cAAM,aAA0C,CAAC;AACjD,mBAAW,UAAU,SAAS;AAC5B,gBAAM,aAAaA,QAAO,MAAM;AAChC,cAAI,CAAC;AAAY;AACjB,gBAAM,YAAY,WAAW;AAG7B,cAAI,CAAC,aAAa,CAAC,UAAU;AAAQ,qBAAS;AAC9C,qBAAW,KAAK,SAAS;AAAA,QAC3B;AACA,YAAI,WAAW,SAAS;AAAG,mBAAS;AACpC,YAAI,YAAY,WAAW,CAAC;AAC5B,iBAAS,IAAI,GAAG,IAAI,WAAW,QAAQ,EAAE,GAAG;AAC1C,gBAAM,YAAY,WAAW,CAAC;AAC9B,sBAAY,UAAU,OAAO,CAAC,SAAS;AACrC,qBAAS,IAAI,GAAG,IAAI,UAAU,QAAQ,EAAE,GAAG;AACzC,kBAAI,MAAM,UAAU,CAAC,GAAG,IAAI,GAAG;AAC7B,0BAAU,CAAC,IAAI;AACf,uBAAO;AAAA,cACT;AAAA,YACF;AACA,mBAAO;AAAA,UACT,CAAC;AACD,cAAI,CAAC,UAAU;AAAQ,qBAAS;AAAA,QAClC;AACA,QAAAA,MAAM,aAAa;AACnB,kBAAU,QAAQ,CAAC,SAAS;AAC1B,qBAAW,aAAa,YAAY;AAClC,sBAAU;AAAA,cACR,UAAU,UAAU,CAAC,MAAM,MAAM,IAAI;AAAA,cACrC;AAAA,YACF;AAAA,UACF;AAAA,QACF,CAAC;AACD,mBAAW,UAAU,SAAS;AAC5B,cAAIA,MAAM,MAAM,KAAK,CAACA,MAAM,MAAM,EAAG,WAAY,QAAQ;AACvD,mBAAOA,MAAM,MAAM,EAAG;AAAA,UACxB;AAAA,QACF;AAAA,MACF;AAAA,EACF;AAEA;AACE,YAAQ,KAAK,OAAQ,MAAM,cAAe;AAC1C,QAAI,WACF,OAAO,WAAW,QAAQ,QAAQ,OAAO,UAAU;AACrD,QAAI,UAAU;AACZ,iBAAW,KAAK,QAAQ,QAAQ;AAChC,YAAM,MAAM,KAAK,QAAQ,QAAQ,GAAG;AAAA,QAClC,WAAW;AAAA,MACb,CAAC;AAED,YAAM,UAAU,CAAC,QAAQ,OAAO,EAAE,SAAS,KAAK,QAAQ,QAAQ,CAAC,IAC7D,KAAK,UAAU,QAAQ,IACvB,KAAK,UAAU,UAAU,MAAM,OAAO,aAAa,IAAI,MAAS;AAEpE,YAAM,UAAU,UAAU,SAAS;AAAA,QACjC,MAAM,OAAO;AAAA,MACf,CAAC;AACD,YAAM,OAAO,MAAM,OAAO,WAAW,OAAO,GAAG,EAAE,eAAe,GAAG,CAAC;AACpE,cAAQ;AAAA,QACN;AAAA,QACA,MACE,OACA,KAAK,SAAS,QAAQ,IAAI,GAAG,QAAQ,IACrCH,OAAM,KAAK,WAAW,OAAO;AAAA,QAC/B;AAAA,MACF;AAAA,IACF,OAAO;AACL,cAAQ,KAAK,WAAW,KAAK,GAAG,CAAC;AAAA,IACnC;AAAA,EACF;AAEA,MAAI;AACJ;AACE,YAAQ,KAAK,OAAQ,MAAM,UAAW;AACtC,aAAU,MAAM,SAAS,QAAQ;AACjC,UAAM,UAAoB,CAAC;AAC3B,QAAI,OAAO,QAAQ,QAAQ;AACzB,cAAQ,KAAK,GAAG,OAAO,OAAO,eAAe;AAAA,IAC/C;AACA,QAAI,OAAO,UAAU,QAAQ;AAC3B,cAAQ,KAAK,GAAG,OAAO,SAAS,iBAAiB;AAAA,IACnD;AACA,YAAQ,UACN,QAAQ,KAAK,WAAW,MAAM,MAAMA,OAAM,OAAO,QAAQ,KAAK,QAAG,CAAC,CAAC;AAErE,YAAQ;AAAA,MACN;AAAA,MACA,OAAO,QAAQ,SAAS,SAAS,OAAO,UAAU,SAAS,SAAS;AAAA,IACtE;AAAA,EACF;AAEA,SAAO;AAAA,IACL,UAAU,KAAK,MAAM,KAAK,UAAU,QAAQ,CAAC;AAAA,IAC7C,QAAQ;AAAA,MACN,QAAQ,OAAO,UAAU,CAAC;AAAA,MAC1B,UAAU,OAAO,YAAY,CAAC;AAAA,IAChC;AAAA,EACF;AACF;AAEA,IAAM,UAAU,OAAO,OAAO,MAAM,EAAE;AAAA,EAAI,CAAC,WACzC,OAAO,YAAY;AACrB;AAEA,IAAM,OAAO,CAAC,YAAoB,UAAU,MAAMA,OAAM,KAAK,WAAW;AAExE,IAAM,gBAAgB,CAAC,QAAgB;AACrC,SAAO,IAAI,QAAQ,oBAAoB,CAAC,GAAG,OAAO;AAChD,WAAO,IAAI,GAAG,QAAQ,QAAQ,EAAE;AAAA,EAClC,CAAC;AACH;AAEA,IAAM,mBAAmB,CAAC,SAAiB;AACzC,SAAO,KAAK,SAAS,IAAI,EAAE,QAAQ,SAAS,EAAE;AAChD;;;AF/SO,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,6 +1,6 @@
1
1
  {
2
2
  "name": "@aomex/openapi",
3
- "version": "0.0.7",
3
+ "version": "0.0.9",
4
4
  "description": "Openapi documentation generator",
5
5
  "type": "module",
6
6
  "types": "dist/index.d.ts",
@@ -26,25 +26,29 @@
26
26
  "homepage": "https://aomex.js.org",
27
27
  "license": "MIT",
28
28
  "peerDependencies": {
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"
29
+ "@aomex/console": "^0.0.8",
30
+ "@aomex/core": "^0.0.8",
31
+ "@aomex/web": "^0.0.9",
32
+ "@aomex/web-router": "^0.0.9"
33
33
  },
34
34
  "dependencies": {
35
- "@aomex/file-parser": "^0.0.3",
35
+ "@aomex/file-parser": "^0.0.5",
36
36
  "@aomex/utility": "^0.0.4",
37
- "ibm-openapi-validator": "^0.97.4",
37
+ "fast-deep-equal": "^3.1.3",
38
+ "ibm-openapi-validator": "^0.97.5",
39
+ "lodash.snakecase": "^4.1.1",
38
40
  "ora": "^6.1.2",
39
41
  "read-pkg-up": "^9.1.0",
40
42
  "yaml": "^2.2.1"
41
43
  },
42
44
  "devDependencies": {
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",
47
- "@types/ibm-openapi-validator": "^0.15.1"
45
+ "@aomex/console": "^0.0.8",
46
+ "@aomex/core": "^0.0.8",
47
+ "@aomex/web": "^0.0.9",
48
+ "@aomex/web-router": "^0.0.9",
49
+ "@types/ibm-openapi-validator": "^0.15.1",
50
+ "@types/lodash.snakecase": "^4.1.7",
51
+ "strip-ansi": "^7.0.1"
48
52
  },
49
53
  "scripts": {}
50
54
  }