@visulima/jsdoc-open-api 2.0.6 → 2.0.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +26 -0
- package/dist/{chunk-2KU2KUBE.mjs → chunk-LBK736U7.mjs} +2 -2
- package/dist/{chunk-YYHCZXEJ.js → chunk-QPIZ6QWT.js} +4 -4
- package/dist/{chunk-GY2ZTL3E.mjs → chunk-RMC27EXI.mjs} +1 -1
- package/dist/chunk-RMC27EXI.mjs.map +1 -0
- package/dist/{chunk-DZ3JYZZA.js → chunk-T6JDVCNR.js} +1 -1
- package/dist/chunk-T6JDVCNR.js.map +1 -0
- package/dist/cli/commander/index.js +3 -3
- package/dist/cli/commander/index.mjs +2 -2
- package/dist/cli/index.js +4 -4
- package/dist/cli/index.mjs +2 -2
- package/dist/index.js +7 -7
- package/dist/index.mjs +2 -2
- package/package.json +10 -10
- package/dist/chunk-DZ3JYZZA.js.map +0 -1
- package/dist/chunk-GY2ZTL3E.mjs.map +0 -1
- /package/dist/{chunk-2KU2KUBE.mjs.map → chunk-LBK736U7.mjs.map} +0 -0
- /package/dist/{chunk-YYHCZXEJ.js.map → chunk-QPIZ6QWT.js.map} +0 -0
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,29 @@
|
|
|
1
|
+
## @visulima/jsdoc-open-api [2.0.8](https://github.com/visulima/visulima/compare/@visulima/jsdoc-open-api@2.0.7...@visulima/jsdoc-open-api@2.0.8) (2023-11-02)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Bug Fixes
|
|
5
|
+
|
|
6
|
+
* added node 21 support ([#226](https://github.com/visulima/visulima/issues/226)) ([bc2e6f2](https://github.com/visulima/visulima/commit/bc2e6f2ca6652c11c9fde8d52912492b5fcc502e))
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
### Dependencies
|
|
11
|
+
|
|
12
|
+
* **@visulima/readdir:** upgraded to 2.0.7
|
|
13
|
+
|
|
14
|
+
## @visulima/jsdoc-open-api [2.0.7](https://github.com/visulima/visulima/compare/@visulima/jsdoc-open-api@2.0.6...@visulima/jsdoc-open-api@2.0.7) (2023-10-30)
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
### Bug Fixes
|
|
18
|
+
|
|
19
|
+
* update dependencies in pnpm-lock.yaml ([d3a5626](https://github.com/visulima/visulima/commit/d3a5626d2c751c3e14f592db62b583b28046dcc7))
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
### Dependencies
|
|
24
|
+
|
|
25
|
+
* **@visulima/readdir:** upgraded to 2.0.6
|
|
26
|
+
|
|
1
27
|
## @visulima/jsdoc-open-api [2.0.6](https://github.com/visulima/visulima/compare/@visulima/jsdoc-open-api@2.0.5...@visulima/jsdoc-open-api@2.0.6) (2023-10-24)
|
|
2
28
|
|
|
3
29
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { d, c, a, e, f } from './chunk-
|
|
1
|
+
import { d, c, a, e, f } from './chunk-RMC27EXI.mjs';
|
|
2
2
|
import { lstatSync, mkdirSync, writeFileSync, existsSync, realpathSync } from 'fs';
|
|
3
3
|
import { normalize, dirname } from 'path';
|
|
4
4
|
import { pathToFileURL } from 'url';
|
|
@@ -47,4 +47,4 @@ Swagger specification is ready, check the "${a$1}" file.`);},q=O;var A=(n,l=proc
|
|
|
47
47
|
|
|
48
48
|
export { q as a, X as b };
|
|
49
49
|
//# sourceMappingURL=out.js.map
|
|
50
|
-
//# sourceMappingURL=chunk-
|
|
50
|
+
//# sourceMappingURL=chunk-LBK736U7.mjs.map
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
var
|
|
3
|
+
var chunkT6JDVCNR_js = require('./chunk-T6JDVCNR.js');
|
|
4
4
|
var fs = require('fs');
|
|
5
5
|
var path = require('path');
|
|
6
6
|
var url = require('url');
|
|
@@ -13,8 +13,8 @@ function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
|
|
|
13
13
|
var P__default = /*#__PURE__*/_interopDefault(P);
|
|
14
14
|
|
|
15
15
|
var $=async(n,l,e)=>{let o={exclude:[],swaggerDefinition:{}};try{let s=await import(url.pathToFileURL(path.normalize(e.config??n)).href);s?.default&&(s=s.default),o=s;}catch{throw new Error(`No config file found, on: ${e.config??".openapirc.js"}
|
|
16
|
-
`)}let r=new cliProgress.MultiBar({clearOnComplete:!1,format:"{value}/{total} | {bar} | {filename}",hideCursor:!0},cliProgress.Presets.shades_grey),t=new
|
|
17
|
-
Found ${i.length} files in ${s}`),e.veryVerbose&&console.log(i);let y=r.create(i.length,0);i.forEach(c=>{e.verbose&&console.log(`Parsing file ${c}`),y.increment(1,{filename:s});let w=
|
|
16
|
+
`)}let r=new cliProgress.MultiBar({clearOnComplete:!1,format:"{value}/{total} | {bar} | {filename}",hideCursor:!0},cliProgress.Presets.shades_grey),t=new chunkT6JDVCNR_js.d(o.swaggerDefinition);for await(let s of l){fs.lstatSync(s).isDirectory();let i=await readdir.collect(s,{extensions:o.extensions??[".js",".cjs",".mjs",".ts",".tsx",".jsx",".yaml",".yml"],followSymlinks:o.followSymlinks??!1,match:o.include,minimatchOptions:{match:{debug:e.verbose,matchBase:!0},skip:{debug:e.verbose,matchBase:!0}},skip:[...o.exclude,"node_modules/**"]});(e.verbose??e.veryVerbose)&&console.log(`
|
|
17
|
+
Found ${i.length} files in ${s}`),e.veryVerbose&&console.log(i);let y=r.create(i.length,0);i.forEach(c=>{e.verbose&&console.log(`Parsing file ${c}`),y.increment(1,{filename:s});let w=chunkT6JDVCNR_js.c(c,chunkT6JDVCNR_js.a,e.verbose);t.addData(w.map(m=>m.spec));let j=chunkT6JDVCNR_js.c(c,chunkT6JDVCNR_js.e,e.verbose);t.addData(j.map(m=>m.spec));});}e.verbose&&console.log("Validating swagger spec"),e.veryVerbose&&console.log(JSON.stringify(t,null,2)),await chunkT6JDVCNR_js.f(JSON.parse(JSON.stringify(t)));let a=e.output??"swagger.json";r.stop(),e.verbose&&console.log(`Written swagger spec to "${a}" file`),fs.mkdirSync(path.dirname(a),{recursive:!0}),fs.writeFileSync(a,JSON.stringify(t,null,2)),console.log(`
|
|
18
18
|
Swagger specification is ready, check the "${a}" file.`);},W=$;var V=(n,l=process.cwd())=>{if(fs.existsSync(n))throw new Error("Config file already exists");let e=P__default.default.sync({cwd:fs.realpathSync(l)}),o="module.exports =";if(e){let{packageJson:r,path:t}=e;console.info(`Found package.json at "${t}"`),r.type==="module"&&(console.info("Found package.json with type: module, using ES6 as export for the config file"),o="export default");}else console.info("No package.json found");fs.writeFileSync(n,`${o} {
|
|
19
19
|
exclude: [
|
|
20
20
|
'coverage/**',
|
|
@@ -54,4 +54,4 @@ Swagger specification is ready, check the "${a}" file.`);},W=$;var V=(n,l=proces
|
|
|
54
54
|
exports.a = W;
|
|
55
55
|
exports.b = Q;
|
|
56
56
|
//# sourceMappingURL=out.js.map
|
|
57
|
-
//# sourceMappingURL=chunk-
|
|
57
|
+
//# sourceMappingURL=chunk-QPIZ6QWT.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/jsdoc/comments-to-open-api.ts","../src/util/customizer.ts","../src/util/yaml-loc.ts","../src/parse-file.ts","../src/util/object-merge.ts","../src/spec-builder.ts","../src/swagger-jsdoc/comments-to-open-api.ts","../src/swagger-jsdoc/utils.ts","../src/swagger-jsdoc/organize-swagger-object.ts","../src/validate.ts"],"names":["parseComments","mergeWith","customizer","objectValue","sourceValue","customizer_default","fixSecurityObject","thing","primitiveTypes","formatMap","parseDescription","tag","rawType","isArray","parsedType","isPrimitive","isFormat","defaultValue","rootType","schema","description","tagsToObjects","tags","verbose","parsedResponse","nameAndDescription","contentType","example","status","header","link","security","scopeItem","scope","commentsToOpenApi","fileContents","openAPIRegex","comment","loc","result","method","path","pathsObject","spec","comments_to_open_api_default","yamlLoc","string","line","yaml_loc_default","readFileSync","yaml","ALLOWED_KEYS","ParseError","parseFile","file","fileContent","extension","invalidKeys","key","error","parse_file_default","objectMerge","a","b","subKey","object_merge_default","SpecBuilder","baseDefinition","parsedFile","components","paths","rest","value","spec_builder_default","mergeDeep","first","second","hasEmptyProperty","object","keyObject","isTagPresentInTags","targetTag","getSwaggerVersionFromSpec","organizeSwaggerObject","swaggerObject","annotation","property","definition","organize_swagger_object_default","specificationTemplate","specs","parsed","newError","errorString","parsedDocument","specification","SwaggerParser","validate","validate_default"],"mappings":"AACA,OAAS,SAASA,MAAqB,iBAEvC,OAAOC,MAAe,mBCHtB,IAAMC,EAAa,CAACC,EAAsBC,IAAkD,CACxF,GAAI,MAAM,QAAQD,CAAW,EACzB,MAAO,CAAC,GAAGA,EAAa,GAAGC,CAAW,CAI9C,EAEOC,EAAQH,EDCf,IAAMI,EAAqBC,GAAe,CAClCA,EAAM,WAENA,EAAM,SAAW,OAAO,KAAKA,EAAM,QAAQ,EAAE,IAAK,IACvC,CACH,CAAC,CAAC,EAAGA,EAAM,SAAS,CAAC,CACzB,EACH,EAET,EAEMC,EAAiB,IAAI,IAAI,CAAC,UAAW,SAAU,SAAU,UAAW,SAAU,OAAO,CAAC,EAEtFC,EAAoC,CACtC,OAAQ,SACR,KAAM,SACN,KAAM,SACN,YAAa,SACb,OAAQ,SACR,MAAO,SACP,MAAO,UACP,MAAO,UACP,SAAU,QACd,EAEMC,EAAoBC,GAAiI,CACvJ,IAAMC,EAAUD,EAAI,KACdE,EAAUD,EAAQ,SAAS,IAAI,EAE/BE,EAAaF,EAAQ,QAAQ,OAAQ,EAAE,EAEvCG,EAAcP,EAAe,IAAIM,CAAU,EAC3CE,EAAW,OAAO,KAAKP,CAAS,EAAE,SAASK,CAAU,EAEvDG,EAEJ,GAAIN,EAAI,QACJ,OAAQG,EAAY,CAChB,IAAK,UACL,IAAK,QACL,IAAK,QAAS,CACVG,EAAe,OAAO,SAASN,EAAI,QAAS,EAAE,EAC9C,KACJ,CACA,IAAK,SACL,IAAK,SACL,IAAK,QAAS,CACVM,EAAe,OAAO,WAAWN,EAAI,OAAO,EAC5C,KACJ,CACA,QAAS,CACLM,EAAeN,EAAI,QACnB,KACJ,CACJ,CAGJ,IAAIO,EAEAH,EACAG,EAAW,CAAE,QAASD,EAAc,KAAMH,CAAW,EAC9CE,EACPE,EAAW,CACP,QAASD,EACT,OAAQH,EACR,KAAML,EAAUK,CAAU,CAC9B,EAEAI,EAAW,CAAE,KAAM,wBAAwBJ,CAAU,EAAG,EAG5D,IAAIK,EAA6BN,EAC3B,CACI,MAAO,CACH,GAAGK,CACP,EACA,KAAM,OACV,EACA,CACI,GAAGA,CACP,EAEFJ,IAAe,KACfK,EAAS,QAIb,IAAIC,EAAkCT,EAAI,YAAY,KAAK,EAAE,QAAQ,OAAQ,EAAE,EAE/E,OAAIS,IAAgB,KAChBA,EAAc,QAGX,CACH,YAAAA,EACA,KAAMT,EAAI,KACV,QAAAC,EACA,SAAU,CAACD,EAAI,SACf,OAAAQ,CACJ,CACJ,EAIME,EAAgB,CAACC,EAAcC,IACjCD,EAAK,IAAKX,GAAQ,CACd,IAAMa,EAAiBd,EAAiBC,CAAG,EAIvCc,EAAqB,GAUzB,OARID,EAAe,OACfC,GAAsBD,EAAe,MAGrCA,EAAe,cACfC,GAAsB,IAAID,EAAe,YAAY,KAAK,CAAC,IAGvDb,EAAI,IAAK,CACb,IAAK,cACL,IAAK,UACL,IAAK,cACD,MAAO,CAAE,CAACA,EAAI,GAAG,EAAGc,CAAmB,EAG3C,IAAK,aACD,MAAO,CAAE,WAAY,EAAK,EAG9B,IAAK,eACD,MAAO,CACH,aAAc,CACV,YAAaD,EAAe,YAC5B,IAAKA,EAAe,IACxB,CACJ,EAGJ,IAAK,SACD,MAAO,CACH,QAAS,CACL,CACI,YAAaA,EAAe,YAC5B,IAAKA,EAAe,IACxB,CACJ,CACJ,EAGJ,IAAK,MACD,MAAO,CAAE,KAAM,CAACC,CAAkB,CAAE,EAGxC,IAAK,cACL,IAAK,cACL,IAAK,aACL,IAAK,YACD,MAAO,CACH,WAAY,CACR,CACI,YAAaD,EAAe,YAC5B,GAAIb,EAAI,IAAI,QAAQ,UAAW,EAAE,EACjC,KAAMa,EAAe,KACrB,SAAUA,EAAe,SACzB,OAAQA,EAAe,MAC3B,CACJ,CACJ,EAGJ,IAAK,cACD,MAAO,CACH,YAAa,CACT,QAAS,CACL,CAACA,EAAe,KAAK,QAAQ,QAAS,KAAK,CAAC,EAAG,CAC3C,OAAQA,EAAe,MAC3B,CACJ,CACJ,CACJ,EAGJ,IAAK,cAAe,CAChB,GAAM,CAACE,EAAaC,CAAO,EAAIH,EAAe,KAAK,MAAM,GAAG,EAE5D,MAAO,CACH,YAAa,CACT,QAAS,CACL,CAACE,CAAqB,EAAG,CACrB,SAAU,CACN,CAACC,CAAiB,EAAG,CACjB,KAAM,yBAAyBH,EAAe,OAAO,EACzD,CACJ,CACJ,CACJ,CACJ,CACJ,CACJ,CAEA,IAAK,kBACD,MAAO,CAAE,YAAa,CAAE,YAAaC,CAAmB,CAAE,EAG9D,IAAK,eACD,MAAO,CAAE,YAAa,CAAE,SAAU,EAAK,CAAE,EAG7C,IAAK,WACD,MAAO,CACH,UAAW,CACP,CAACD,EAAe,IAAI,EAAG,CACnB,YAAaA,EAAe,WAChC,CACJ,CACJ,EAGJ,IAAK,WACD,MAAO,CACH,UAAW,CACP,CAACA,EAAe,IAAI,EAAG,CACnB,KAAM,0BAA0BA,EAAe,OAAO,EAC1D,CACJ,CACJ,EAGJ,IAAK,kBAAmB,CACpB,GAAM,CAACI,EAAQF,CAAW,EAAIF,EAAe,KAAK,MAAM,GAAG,EAE3D,MAAO,CACH,UAAW,CACP,CAACI,CAAgB,EAAG,CAChB,QAAS,CACL,CAACF,CAAqB,EAAG,CACrB,OAAQF,EAAe,MAC3B,CACJ,CACJ,CACJ,CACJ,CACJ,CAEA,IAAK,0BAA2B,CAC5B,GAAM,CAACI,EAAQC,CAAM,EAAIL,EAAe,KAAK,MAAM,GAAG,EAEtD,MAAO,CACH,UAAW,CACP,CAACI,CAAgB,EAAG,CAChB,QAAS,CACL,CAACC,CAAgB,EAAG,CAChB,KAAM,wBAAwBL,EAAe,OAAO,EACxD,CACJ,CACJ,CACJ,CACJ,CACJ,CAEA,IAAK,iBAAkB,CACnB,GAAM,CAACI,EAAQC,CAAM,EAAIL,EAAe,KAAK,MAAM,GAAG,EAEtD,MAAO,CACH,UAAW,CACP,CAACI,CAAgB,EAAG,CAChB,QAAS,CACL,CAACC,CAAgB,EAAG,CAChB,YAAaL,EAAe,YAC5B,OAAQA,EAAe,MAC3B,CACJ,CACJ,CACJ,CACJ,CACJ,CAEA,IAAK,kBAAmB,CACpB,GAAM,CAACI,EAAQF,EAAaC,CAAO,EAAIH,EAAe,KAAK,MAAM,GAAG,EAEpE,MAAO,CACH,UAAW,CACP,CAACI,CAAgB,EAAG,CAChB,QAAS,CACL,CAACF,CAAqB,EAAG,CACrB,SAAU,CACN,CAACC,CAAiB,EAAG,CACjB,KAAM,yBAAyBH,EAAe,OAAO,EACzD,CACJ,CACJ,CACJ,CACJ,CACJ,CACJ,CACJ,CAEA,IAAK,eAAgB,CACjB,GAAM,CAACI,EAAQE,CAAI,EAAIN,EAAe,KAAK,MAAM,GAAG,EAEpD,MAAO,CACH,UAAW,CACP,CAACI,CAAgB,EAAG,CAChB,MAAO,CACH,CAACE,CAAc,EAAG,CACd,KAAM,sBAAsBN,EAAe,OAAO,EACtD,CACJ,CACJ,CACJ,CACJ,CACJ,CAEA,IAAK,gBACD,MAAO,CACH,YAAa,CACT,KAAM,8BAA8BA,EAAe,OAAO,EAC9D,CACJ,EAGJ,IAAK,oBACD,MAAO,CACH,UAAW,CACP,CAACA,EAAe,IAAI,EAAG,CACnB,KAAM,0BAA0BA,EAAe,OAAO,EAC1D,CACJ,CACJ,EAGJ,IAAK,iBACD,MAAO,CACH,WAAY,CAAC,CAAE,KAAM,2BAA2BA,EAAe,OAAO,EAAG,CAAC,CAC9E,EAGJ,IAAK,WAAY,CACb,GAAM,CAACO,EAAUC,CAAS,EAAIR,EAAe,KAAK,MAAM,GAAG,EAEvDS,EAAkB,CAAC,EAEvB,OAAID,IACAC,EAAQ,CAACD,CAAS,GAGf,CACH,SAAU,CAAE,CAACD,CAAkB,EAAGE,CAAM,CAC5C,CACJ,CAEA,QACI,MAAO,CAAC,CAEhB,CACJ,CAAC,EAECC,EAAoB,CAACC,EAAsBZ,IAA8D,CAE3G,IAAMa,EAAe,wDAKrB,OAH2BpC,EAAcmC,EAAc,CAAE,QAAS,UAAW,CAAC,EAIzE,OAAQE,GAAYD,EAAa,KAAKC,EAAQ,YAAY,KAAK,CAAC,CAAC,EACjE,IAAKA,GAAY,CAId,IAAMC,EAAMD,EAAQ,KAAK,OAAS,EAE5BE,EAAStC,EAAU,CAAC,EAAG,GAAGoB,EAAcgB,EAAQ,KAAMd,CAAO,EAAGlB,CAAU,EAEhFC,EAAkBiC,CAAM,EAExB,GAAM,CAACC,EAAQC,CAAI,EAAcJ,EAAQ,YAAY,MAAM,GAAG,EAExDK,EAA2B,CAC7B,CAAED,EAAgB,KAAK,CAAC,EAAG,CACvB,CAAED,EAAkB,YAAY,EAAE,KAAK,CAAC,EAAG,CACvC,GAAGD,CACP,CACJ,CACJ,EAGMI,EAAO,KAAK,MAAM,KAAK,UAAU,CAAE,MAAOD,CAAY,CAAC,CAAC,EAE9D,MAAO,CACH,IAAAJ,EACA,KAAAK,CACJ,CACJ,CAAC,CACT,EAEOC,GAAQV,EEvZf,IAAMW,EAAWC,GAECA,EAAO,MAAM,aAAa,EAEjB,OAAQC,GAGvB,yBAAyB,KAAKA,CAAI,EAC3B,GAGJA,EAAK,KAAK,EAAE,OAAS,CAC/B,EAEe,OAGbC,EAAQH,ECjBf,OAAS,gBAAAI,MAAoB,KAC7B,OAAOR,MAAU,OAEjB,OAAOS,MAAU,OAKjB,IAAMC,EAAe,IAAI,IAAI,CAAC,UAAW,OAAQ,UAAW,WAAY,OAAQ,eAAgB,aAAc,OAAO,CAAC,EAEhHC,EAAN,cAAyB,KAAM,CAE/B,EAEMC,EAAY,CACdC,EACApB,EACAX,IACyC,CAEzC,IAAMgC,EAAcN,EAAaK,EAAM,CAAE,SAAU,MAAO,CAAC,EACrDE,EAAYf,EAAK,QAAQa,CAAI,EAEnC,GAAIE,IAAc,SAAWA,IAAc,OAAQ,CAC/C,IAAMb,EAAOO,EAAK,MAAMK,CAAW,EAC7BE,EAAc,OAAO,KAAKd,CAAI,EAAE,OAAQe,GAAQ,CAACP,EAAa,IAAIO,CAAG,CAAC,EAE5E,GAAID,EAAY,OAAS,EAAG,CACxB,IAAME,EAAQ,IAAIP,EAAW,oBAAoBK,EAAY,KAAK,IAAI,CAAC,EAAE,EAEzE,MAAAE,EAAM,SAAWL,EAEXK,CACV,CAEA,OAAI,OAAO,KAAKhB,CAAI,EAAE,KAAMe,GAAQP,EAAa,IAAIO,CAAG,CAAC,EAG9C,CAAC,CAAE,IAFEV,EAAQO,CAAW,EAEhB,KAAAZ,CAAK,CAAC,EAGlB,CAAC,CACZ,CAEA,GAAI,CACA,OAAOT,EAAkBqB,EAAahC,CAAO,CACjD,OAASoC,EAAY,CACjB,MAAAA,EAAM,SAAWL,EAEXK,CACV,CACJ,EAEOC,GAAQP,ECrDf,IAAMQ,EAAc,CAAIC,EAAMC,IAAe,CACzC,OAAO,KAAKA,CAAW,EAAE,QAASL,GAAQ,CAElCI,EAAEJ,CAAqB,IAAM,OAE7BI,EAAEJ,CAAqB,EAAI,CACvB,GAAGK,EAAEL,CAAqB,CAC9B,EAEA,OAAO,KAAKK,EAAEL,CAAqB,CAAW,EAAE,QAASM,GAAW,CAE/DF,EAAEJ,CAAqB,EAA6BM,CAAM,EAAI,CAC3D,GAAIF,EAAEJ,CAAqB,EAA6BM,CAAM,EAC9D,GAAID,EAAEL,CAAqB,EAA6BM,CAAM,CAClE,CACJ,CAAC,CAET,CAAC,CACL,EAEOC,EAAQJ,ECPf,IAAMK,EAAN,KAA2C,CAiBhC,YAAYC,EAAgC,CAC/C,KAAK,QAAUA,EAAe,QAC9B,KAAK,KAAOA,EAAe,KAC3B,KAAK,QAAUA,EAAe,QAC9B,KAAK,MAAQA,EAAe,OAAS,CAAC,EACtC,KAAK,WAAaA,EAAe,WACjC,KAAK,SAAWA,EAAe,SAC/B,KAAK,KAAOA,EAAe,KAC3B,KAAK,aAAeA,EAAe,YACvC,CAEO,QAAQC,EAAmC,CAC9CA,EAAW,QAASd,GAAS,CACzB,GAAM,CAAE,WAAAe,EAAY,MAAAC,EAAO,GAAGC,CAAK,EAAIjB,EAGvCW,EAAY,KAAM,CACd,WAAYI,GAAc,CAAC,EAC3B,MAAOC,GAAS,CAAC,CACrB,CAAkB,EAGlB,OAAO,QAAQC,CAAI,EAAE,QAAQ,CAAC,CAACb,EAAKc,CAAK,IAAM,CAE3C,KAAKd,CAA0B,EAAIc,CACvC,CAAC,CACL,CAAC,CACL,CACJ,EAEOC,GAAQP,EC3Df,OAAS,SAASlE,MAAqB,iBAEvC,OAAOC,MAAe,mBAEtB,OAAOiD,MAAU,OCHjB,OAAOjD,MAAe,mBASf,IAAMyE,EAAY,CAACC,EAAgBC,IAA4B3E,EAAU,CAAC,EAAG0E,EAAOC,EAAQ,CAACd,EAAGC,IAAOA,IAAM,KAAOD,EAAI,MAAU,EAO5He,EAAoBC,GAC7B,OAAO,KAAKA,CAAM,EAEb,IAAKpB,GAAQoB,EAAOpB,CAAG,CAAC,EACxB,MAAOqB,GAAc,OAAOA,GAAc,UAAY,OAAO,KAAKA,CAAS,EAAE,MAAOrB,GAAQ,EAAEA,KAAOqB,EAAU,CAAC,EAO5GC,EAAqB,CAACrE,EAAWW,IAA0BA,EAAK,KAAM2D,GAActE,EAAI,OAASsE,EAAU,IAAI,EAE/GC,EAA6BvE,GAAkC,CACxE,OAAQA,EAAI,IAAK,CACb,IAAK,UACD,MAAO,KAEX,IAAK,WACD,MAAO,KAEX,IAAK,UACD,MAAO,KAEX,QACI,MAAO,IAEf,CACJ,ECtCA,IAAMwE,EAAwB,CAACC,EAAoCC,EAAiCC,IAA2B,CAY3H,GARIA,IAAa,eAEbF,EAAcE,CAAQ,EAAID,EAAWC,CAAQ,GAM7CA,EAAS,WAAW,IAAI,EACxB,OAgBJ,GAbyB,CACrB,aACA,WACA,WACA,QACA,UACA,sBACA,YACA,aACA,cACA,UACJ,EAEqB,SAASA,CAAQ,EAClC,OAAO,KAAKD,EAAWC,CAAQ,CAAC,EAAE,QAASC,GAAe,CAEtDH,EAAcE,CAAQ,EAAEC,CAAU,EAAIb,EAAUU,EAAcE,CAAQ,EAAEC,CAAU,EAAGF,EAAWC,CAAQ,EAAEC,CAAU,CAAC,CACzH,CAAC,UACMD,IAAa,OAAQ,CAC5B,GAAM,CAAE,KAAAhE,CAAK,EAAI+D,EAEb,MAAM,QAAQ/D,CAAI,EAClBA,EAAK,QAASX,GAAQ,CACbqE,EAAmBrE,EAAKyE,EAAc,IAAO,GAC9CA,EAAc,KAAQ,KAAKzE,CAAG,CAEtC,CAAC,EACOqE,EAAmB1D,EAAM8D,EAAc,IAAO,GACtDA,EAAc,KAAQ,KAAK9D,CAAI,CAEvC,SAAWgE,IAAa,WAAY,CAChC,GAAM,CAAE,SAAAvD,CAAS,EAAIsD,EAGrBD,EAAc,SAAcrD,CAChC,MAAWuD,EAAS,WAAW,GAAG,IAG9BF,EAAc,MAASE,CAAQ,EAAIZ,EAAUU,EAAc,MAASE,CAAQ,EAAGD,EAAWC,CAAQ,CAAC,EAE3G,EAEOE,EAAQL,EFtDf,IAAMM,EAAwB,CAC1B,GAAI,CAAC,QAAS,cAAe,YAAa,aAAc,qBAAqB,EAC7E,GAAI,CAAC,QAAS,cAAe,YAAa,aAAc,sBAAuB,YAAY,EAC3F,GAAI,CAAC,aAAc,UAAU,CACjC,EAIMpE,EAAgB,CAACqE,EAAenE,IAClCmE,EAAM,IAAK/C,GAAe,CACtB,IAAKA,EAAK,MAAQ,WAAaA,EAAK,MAAQ,WAAaA,EAAK,MAAQ,aAAeA,EAAK,cAAgB,GAAI,CAC1G,IAAMgD,EAASzC,EAAK,cAAcP,EAAK,WAAW,EAElD,GAAIgD,EAAO,OAAO,OAAS,EAAG,CAC1BA,EAAO,OAAO,IAAwBhC,GAAU,CAC5C,IAAMiC,EAA8BjC,EAEpC,OAAAiC,EAAS,WAAajD,EAAK,YAEpBiD,CACX,CAAC,EAED,IAAIC,EAAc,uCAElB,MAAAA,GAAetE,EACRoE,EAAO,OAEH,IAAKhC,GAAU,GAAGA,EAAM,SAAS,CAAC;AAAA;AAAA;AAAA,IAAiCA,EAAM,YAAY,QAAQ,OAAQ;AAAA,GAAM,CAAC;AAAA,OAAU,EACtH,KAAK;AAAA,CAAI,EAEdgC,EAAO,OAAO,IAAKhC,GAAUA,EAAM,SAAS,CAAC,EAAE,KAAK;AAAA,CAAI,EAExD,IAAI,MAAMkC,CAAW,CAC/B,CAEA,IAAMC,EAAiBH,EAAO,OAAO,EAC/BI,EAAqC,CACvC,KAAM,CAAC,CACX,EAEA,OAAAN,EAAsBP,EAA0BvC,CAAI,CAAC,EAAE,QAAS2C,GAAa,CACzES,EAAcT,CAAQ,EAAIS,EAAcT,CAAQ,GAAK,CAAC,CAC1D,CAAC,EAED,OAAO,KAAKQ,CAAc,EAAE,QAASR,GAAa,CAC9CE,EAAsBO,EAAeD,EAAgBR,CAAQ,CACjE,CAAC,EAEMS,CACX,CAEA,MAAO,CAAC,CACZ,CAAC,EAEC7D,EAAoB,CAACC,EAAsBZ,IAClBvB,EAAcmC,EAAc,CAAE,QAAS,UAAW,CAAC,EAGpD,IAAKE,GAAY,CAIvC,IAAMC,EAAMD,EAAQ,KAAK,OAAS,EAC5BE,EAAStC,EAAU,CAAC,EAAG,GAAGoB,EAAcgB,EAAQ,KAAMd,CAAO,EAAGlB,CAAU,EAEhF,CAAC,cAAe,YAAa,aAAc,sBAAuB,aAAc,MAAM,EAAE,QAASiF,GAAa,CACtG/C,EAAO+C,CAAQ,IAAM,QAAaT,EAAiBtC,EAAO+C,CAAQ,CAAC,GAEnE,OAAO/C,EAAO+C,CAAQ,CAE9B,CAAC,EAGD,IAAM3C,EAAO,KAAK,MAAM,KAAK,UAAUJ,CAAM,CAAC,EAE9C,MAAO,CACH,IAAAD,EACA,KAAAK,CACJ,CACJ,CAAC,EAGEC,GAAQV,EG9Ff,OAAO8D,MAAmB,8BAI1B,IAAMC,EAAW,MAAOtD,GAAiD,CACrE,MAAMqD,EAAc,SAASrD,CAAgC,CACjE,EAEOuD,GAAQD","sourcesContent":["import type { Spec } from \"comment-parser\";\nimport { parse as parseComments } from \"comment-parser\";\n// eslint-disable-next-line no-restricted-imports\nimport mergeWith from \"lodash.mergewith\";\n\nimport type { OpenApiObject, PathsObject } from \"../exported.d\";\nimport customizer from \"../util/customizer\";\n\n// The security object has a bizare setup...\nconst fixSecurityObject = (thing: any) => {\n if (thing.security) {\n // eslint-disable-next-line no-param-reassign\n thing.security = Object.keys(thing.security).map((s) => {\n return {\n [s]: thing.security[s],\n };\n });\n }\n};\n\nconst primitiveTypes = new Set([\"integer\", \"number\", \"string\", \"boolean\", \"object\", \"array\"]);\n\nconst formatMap: Record<string, string> = {\n binary: \"string\",\n byte: \"string\",\n date: \"string\",\n \"date-time\": \"string\",\n double: \"number\",\n float: \"number\",\n int32: \"integer\",\n int64: \"integer\",\n password: \"string\",\n};\n\nconst parseDescription = (tag: Spec): { description: string | undefined; name: string; rawType: string; required: boolean; schema: object | undefined } => {\n const rawType = tag.type;\n const isArray = rawType.endsWith(\"[]\");\n // eslint-disable-next-line regexp/strict\n const parsedType = rawType.replace(/\\[]$/, \"\");\n\n const isPrimitive = primitiveTypes.has(parsedType);\n const isFormat = Object.keys(formatMap).includes(parsedType);\n\n let defaultValue;\n\n if (tag.default) {\n switch (parsedType) {\n case \"integer\":\n case \"int32\":\n case \"int64\": {\n defaultValue = Number.parseInt(tag.default, 10);\n break;\n }\n case \"number\":\n case \"double\":\n case \"float\": {\n defaultValue = Number.parseFloat(tag.default);\n break;\n }\n default: {\n defaultValue = tag.default;\n break;\n }\n }\n }\n\n let rootType;\n\n if (isPrimitive) {\n rootType = { default: defaultValue, type: parsedType };\n } else if (isFormat) {\n rootType = {\n default: defaultValue,\n format: parsedType,\n type: formatMap[parsedType],\n };\n } else {\n rootType = { $ref: `#/components/schemas/${parsedType}` };\n }\n\n let schema: object | undefined = isArray\n ? {\n items: {\n ...rootType,\n },\n type: \"array\",\n }\n : {\n ...rootType,\n };\n\n if (parsedType === \"\") {\n schema = undefined;\n }\n\n // remove the optional dash from the description.\n let description: string | undefined = tag.description.trim().replace(/^- /u, \"\");\n\n if (description === \"\") {\n description = undefined;\n }\n\n return {\n description,\n name: tag.name,\n rawType,\n required: !tag.optional,\n schema,\n };\n};\n\n// @ts-expect-error\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\nconst tagsToObjects = (tags: Spec[], verbose?: boolean) =>\n tags.map((tag) => {\n const parsedResponse = parseDescription(tag);\n\n // Some ops only have a `description`, merge `name` and `description`\n // for these.\n let nameAndDescription = \"\";\n\n if (parsedResponse.name) {\n nameAndDescription += parsedResponse.name;\n }\n\n if (parsedResponse.description) {\n nameAndDescription += ` ${parsedResponse.description.trim()}`;\n }\n\n switch (tag.tag) {\n case \"operationId\":\n case \"summary\":\n case \"description\": {\n return { [tag.tag]: nameAndDescription };\n }\n\n case \"deprecated\": {\n return { deprecated: true };\n }\n\n case \"externalDocs\": {\n return {\n externalDocs: {\n description: parsedResponse.description,\n url: parsedResponse.name,\n },\n };\n }\n\n case \"server\": {\n return {\n servers: [\n {\n description: parsedResponse.description,\n url: parsedResponse.name,\n },\n ],\n };\n }\n\n case \"tag\": {\n return { tags: [nameAndDescription] };\n }\n\n case \"cookieParam\":\n case \"headerParam\":\n case \"queryParam\":\n case \"pathParam\": {\n return {\n parameters: [\n {\n description: parsedResponse.description,\n in: tag.tag.replace(/Param$/u, \"\"),\n name: parsedResponse.name,\n required: parsedResponse.required,\n schema: parsedResponse.schema,\n },\n ],\n };\n }\n\n case \"bodyContent\": {\n return {\n requestBody: {\n content: {\n [parsedResponse.name.replace(\"*\\\\/*\", \"*/*\")]: {\n schema: parsedResponse.schema,\n },\n },\n },\n };\n }\n\n case \"bodyExample\": {\n const [contentType, example] = parsedResponse.name.split(\".\");\n\n return {\n requestBody: {\n content: {\n [contentType as string]: {\n examples: {\n [example as string]: {\n $ref: `#/components/examples/${parsedResponse.rawType}`,\n },\n },\n },\n },\n },\n };\n }\n\n case \"bodyDescription\": {\n return { requestBody: { description: nameAndDescription } };\n }\n\n case \"bodyRequired\": {\n return { requestBody: { required: true } };\n }\n\n case \"response\": {\n return {\n responses: {\n [parsedResponse.name]: {\n description: parsedResponse.description,\n },\n },\n };\n }\n\n case \"callback\": {\n return {\n callbacks: {\n [parsedResponse.name]: {\n $ref: `#/components/callbacks/${parsedResponse.rawType}`,\n },\n },\n };\n }\n\n case \"responseContent\": {\n const [status, contentType] = parsedResponse.name.split(\".\");\n\n return {\n responses: {\n [status as string]: {\n content: {\n [contentType as string]: {\n schema: parsedResponse.schema,\n },\n },\n },\n },\n };\n }\n\n case \"responseHeaderComponent\": {\n const [status, header] = parsedResponse.name.split(\".\");\n\n return {\n responses: {\n [status as string]: {\n headers: {\n [header as string]: {\n $ref: `#/components/headers/${parsedResponse.rawType}`,\n },\n },\n },\n },\n };\n }\n\n case \"responseHeader\": {\n const [status, header] = parsedResponse.name.split(\".\");\n\n return {\n responses: {\n [status as string]: {\n headers: {\n [header as string]: {\n description: parsedResponse.description,\n schema: parsedResponse.schema,\n },\n },\n },\n },\n };\n }\n\n case \"responseExample\": {\n const [status, contentType, example] = parsedResponse.name.split(\".\");\n\n return {\n responses: {\n [status as string]: {\n content: {\n [contentType as string]: {\n examples: {\n [example as string]: {\n $ref: `#/components/examples/${parsedResponse.rawType}`,\n },\n },\n },\n },\n },\n },\n };\n }\n\n case \"responseLink\": {\n const [status, link] = parsedResponse.name.split(\".\");\n\n return {\n responses: {\n [status as string]: {\n links: {\n [link as string]: {\n $ref: `#/components/links/${parsedResponse.rawType}`,\n },\n },\n },\n },\n };\n }\n\n case \"bodyComponent\": {\n return {\n requestBody: {\n $ref: `#/components/requestBodies/${parsedResponse.rawType}`,\n },\n };\n }\n\n case \"responseComponent\": {\n return {\n responses: {\n [parsedResponse.name]: {\n $ref: `#/components/responses/${parsedResponse.rawType}`,\n },\n },\n };\n }\n\n case \"paramComponent\": {\n return {\n parameters: [{ $ref: `#/components/parameters/${parsedResponse.rawType}` }],\n };\n }\n\n case \"security\": {\n const [security, scopeItem] = parsedResponse.name.split(\".\");\n\n let scope: string[] = [];\n\n if (scopeItem) {\n scope = [scopeItem];\n }\n\n return {\n security: { [security as string]: scope },\n };\n }\n\n default: {\n return {};\n }\n }\n });\n\nconst commentsToOpenApi = (fileContents: string, verbose?: boolean): { loc: number; spec: OpenApiObject }[] => {\n // eslint-disable-next-line regexp/no-unused-capturing-group\n const openAPIRegex = /^(GET|PUT|POST|DELETE|OPTIONS|HEAD|PATCH|TRACE) \\/.*$/;\n\n const jsDocumentComments = parseComments(fileContents, { spacing: \"preserve\" });\n\n // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n return jsDocumentComments\n .filter((comment) => openAPIRegex.test(comment.description.trim()))\n .map((comment) => {\n // Line count, number of tags + 1 for description.\n // - Don't count line-breaking due to long descriptions\n // - Don't count empty lines\n const loc = comment.tags.length + 1;\n\n const result = mergeWith({}, ...tagsToObjects(comment.tags, verbose), customizer);\n\n fixSecurityObject(result);\n\n const [method, path]: string[] = comment.description.split(\" \");\n\n const pathsObject: PathsObject = {\n [(path as string).trim()]: {\n [(method as string).toLowerCase().trim()]: {\n ...result,\n },\n },\n };\n\n // Purge all undefined objects/arrays.\n const spec = JSON.parse(JSON.stringify({ paths: pathsObject }));\n\n return {\n loc,\n spec,\n };\n });\n};\n\nexport default commentsToOpenApi;\n","const customizer = (objectValue: unknown, sourceValue: unknown[]): unknown[] | undefined => {\n if (Array.isArray(objectValue)) {\n return [...objectValue, ...sourceValue] as unknown[];\n }\n\n return undefined;\n};\n\nexport default customizer;\n","const yamlLoc = (string: string): number => {\n // Break string into lines.\n const split = string.split(/\\r\\n|\\r|\\n/u);\n\n const filtered = split.filter((line) => {\n // Remove comments.\n // eslint-disable-next-line security/detect-unsafe-regex,regexp/no-unused-capturing-group\n if (/^\\s*(#\\s*(?:\\S.*)?)?$/u.test(line)) {\n return false;\n }\n // Remove empty lines.\n return line.trim().length > 0;\n });\n\n return filtered.length;\n};\n\nexport default yamlLoc;\n","import { readFileSync } from \"node:fs\";\nimport path from \"node:path\";\n\nimport yaml from \"yaml\";\n\nimport type { OpenApiObject } from \"./exported.d\";\nimport yamlLoc from \"./util/yaml-loc\";\n\nconst ALLOWED_KEYS = new Set([\"openapi\", \"info\", \"servers\", \"security\", \"tags\", \"externalDocs\", \"components\", \"paths\"]);\n\nclass ParseError extends Error {\n public filePath?: string;\n}\n\nconst parseFile = (\n file: string,\n commentsToOpenApi: (fileContent: string, verbose?: boolean) => { loc: number; spec: OpenApiObject }[],\n verbose?: boolean,\n): { loc: number; spec: OpenApiObject }[] => {\n // eslint-disable-next-line security/detect-non-literal-fs-filename\n const fileContent = readFileSync(file, { encoding: \"utf8\" });\n const extension = path.extname(file);\n\n if (extension === \".yaml\" || extension === \".yml\") {\n const spec = yaml.parse(fileContent);\n const invalidKeys = Object.keys(spec).filter((key) => !ALLOWED_KEYS.has(key));\n\n if (invalidKeys.length > 0) {\n const error = new ParseError(`Unexpected keys: ${invalidKeys.join(\", \")}`);\n\n error.filePath = file;\n\n throw error;\n }\n\n if (Object.keys(spec).some((key) => ALLOWED_KEYS.has(key))) {\n const loc = yamlLoc(fileContent);\n\n return [{ loc, spec }];\n }\n\n return [];\n }\n\n try {\n return commentsToOpenApi(fileContent, verbose);\n } catch (error: any) {\n error.filePath = file;\n\n throw error;\n }\n};\n\nexport default parseFile;\n","const objectMerge = <T>(a: T, b: T): void => {\n Object.keys(b as object).forEach((key) => {\n // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n if (a[key as keyof typeof b] === undefined) {\n // eslint-disable-next-line no-param-reassign\n a[key as keyof typeof b] = {\n ...b[key as keyof typeof b],\n };\n } else {\n Object.keys(b[key as keyof typeof b] as object).forEach((subKey) => {\n // eslint-disable-next-line no-param-reassign\n (a[key as keyof typeof b] as Record<string, object>)[subKey] = {\n ...(a[key as keyof typeof b] as Record<string, object>)[subKey],\n ...(b[key as keyof typeof b] as Record<string, object>)[subKey],\n };\n });\n }\n });\n};\n\nexport default objectMerge;\n","import type {\n BaseDefinition,\n ComponentsObject,\n ExternalDocumentationObject,\n InfoObject,\n OpenApiObject,\n PathsObject,\n SecurityRequirementObject,\n ServerObject,\n TagObject,\n} from \"./exported.d\";\nimport objectMerge from \"./util/object-merge\";\n\nclass SpecBuilder implements OpenApiObject {\n public components?: ComponentsObject;\n\n public externalDocs?: ExternalDocumentationObject;\n\n public info: InfoObject;\n\n public openapi: string;\n\n public paths: PathsObject;\n\n public security?: SecurityRequirementObject[];\n\n public servers?: ServerObject[];\n\n public tags?: TagObject[];\n\n public constructor(baseDefinition: BaseDefinition) {\n this.openapi = baseDefinition.openapi;\n this.info = baseDefinition.info;\n this.servers = baseDefinition.servers;\n this.paths = baseDefinition.paths ?? {};\n this.components = baseDefinition.components;\n this.security = baseDefinition.security;\n this.tags = baseDefinition.tags;\n this.externalDocs = baseDefinition.externalDocs;\n }\n\n public addData(parsedFile: OpenApiObject[]): void {\n parsedFile.forEach((file) => {\n const { components, paths, ...rest } = file;\n\n // only merge paths and components\n objectMerge(this, {\n components: components ?? {},\n paths: paths ?? {},\n } as OpenApiObject);\n\n // overwrite everything else:\n Object.entries(rest).forEach(([key, value]) => {\n // @ts-expect-error\n this[key as keyof OpenApiObject] = value;\n });\n });\n }\n}\n\nexport default SpecBuilder;\n","import type { Spec } from \"comment-parser\";\nimport { parse as parseComments } from \"comment-parser\";\n// eslint-disable-next-line no-restricted-imports\nimport mergeWith from \"lodash.mergewith\";\nimport type { YAMLError } from \"yaml\";\nimport yaml from \"yaml\";\n\nimport type { OpenApiObject } from \"../exported.d\";\nimport customizer from \"../util/customizer\";\nimport organizeSwaggerObject from \"./organize-swagger-object\";\nimport { getSwaggerVersionFromSpec, hasEmptyProperty } from \"./utils\";\n\nconst specificationTemplate = {\n v2: [\"paths\", \"definitions\", \"responses\", \"parameters\", \"securityDefinitions\"],\n v3: [\"paths\", \"definitions\", \"responses\", \"parameters\", \"securityDefinitions\", \"components\"],\n v4: [\"components\", \"channels\"],\n};\n\ntype ExtendedYAMLError = YAMLError & { annotation?: string };\n\nconst tagsToObjects = (specs: Spec[], verbose?: boolean) =>\n specs.map((spec: Spec) => {\n if ((spec.tag === \"openapi\" || spec.tag === \"swagger\" || spec.tag === \"asyncapi\") && spec.description !== \"\") {\n const parsed = yaml.parseDocument(spec.description);\n\n if (parsed.errors.length > 0) {\n parsed.errors.map<ExtendedYAMLError>((error) => {\n const newError: ExtendedYAMLError = error;\n\n newError.annotation = spec.description;\n\n return newError;\n });\n\n let errorString = \"Error parsing YAML in @openapi spec:\";\n\n errorString += verbose\n ? (parsed.errors as ExtendedYAMLError[])\n // eslint-disable-next-line @typescript-eslint/no-base-to-string\n .map((error) => `${error.toString()}\\nImbedded within:\\n\\`\\`\\`\\n ${error.annotation?.replace(/\\n/gu, \"\\n \")}\\n\\`\\`\\``)\n .join(\"\\n\")\n : // eslint-disable-next-line @typescript-eslint/no-base-to-string\n parsed.errors.map((error) => error.toString()).join(\"\\n\");\n\n throw new Error(errorString);\n }\n\n const parsedDocument = parsed.toJSON();\n const specification: Record<string, any> = {\n tags: [],\n };\n\n specificationTemplate[getSwaggerVersionFromSpec(spec)].forEach((property) => {\n specification[property] = specification[property] || {};\n });\n\n Object.keys(parsedDocument).forEach((property) => {\n organizeSwaggerObject(specification, parsedDocument, property);\n });\n\n return specification;\n }\n\n return {};\n });\n\nconst commentsToOpenApi = (fileContents: string, verbose?: boolean): { loc: number; spec: OpenApiObject }[] => {\n const jsDocumentComments = parseComments(fileContents, { spacing: \"preserve\" });\n\n // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n return jsDocumentComments.map((comment) => {\n // Line count, number of tags + 1 for description.\n // - Don't count line-breaking due to long descriptions\n // - Don't count empty lines\n const loc = comment.tags.length + 1;\n const result = mergeWith({}, ...tagsToObjects(comment.tags, verbose), customizer);\n\n [\"definitions\", \"responses\", \"parameters\", \"securityDefinitions\", \"components\", \"tags\"].forEach((property) => {\n if (result[property] !== undefined && hasEmptyProperty(result[property])) {\n // eslint-disable-next-line @typescript-eslint/no-dynamic-delete\n delete result[property];\n }\n });\n\n // Purge all undefined objects/arrays.\n const spec = JSON.parse(JSON.stringify(result));\n\n return {\n loc,\n spec,\n };\n });\n};\n\nexport default commentsToOpenApi;\n","import type { Spec } from \"comment-parser\";\n// eslint-disable-next-line no-restricted-imports\nimport mergeWith from \"lodash.mergewith\";\n\n/**\n * A recursive deep-merge that ignores null values when merging.\n * This returns the merged object and does not mutate.\n * @param {object} first the first object to get merged\n * @param {object} second the second object to get merged\n */\n// eslint-disable-next-line @typescript-eslint/no-unsafe-return\nexport const mergeDeep = (first?: object, second?: object): object => mergeWith({}, first, second, (a, b) => (b === null ? a : undefined));\n\n/**\n * Checks if there is any properties of the input object which are an empty object\n * @param {object} object - the object to check\n * @returns boolean\n */\nexport const hasEmptyProperty = (object: Record<string, any>): boolean =>\n Object.keys(object)\n // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n .map((key) => object[key])\n .every((keyObject) => typeof keyObject === \"object\" && Object.keys(keyObject).every((key) => !(key in keyObject)));\n\n/**\n * @param {object} tag\n * @param {array} tags\n * @returns boolean\n */\nexport const isTagPresentInTags = (tag: Spec, tags: Spec[]): boolean => tags.some((targetTag) => tag.name === targetTag.name);\n\nexport const getSwaggerVersionFromSpec = (tag: Spec): \"v2\" | \"v3\" | \"v4\" => {\n switch (tag.tag) {\n case \"openapi\": {\n return \"v3\";\n }\n case \"asyncapi\": {\n return \"v4\";\n }\n case \"swagger\": {\n return \"v2\";\n }\n default: {\n return \"v2\";\n }\n }\n};\n","import { isTagPresentInTags, mergeDeep } from \"./utils\";\n\n/**\n * @param {object} swaggerObject\n * @param {object} annotation\n * @param {string} property\n */\n\nconst organizeSwaggerObject = (swaggerObject: Record<string, any>, annotation: Record<string, any>, property: string): void => {\n // Root property on purpose.\n // eslint-disable-next-line no-secrets/no-secrets\n // @see https://github.com/OAI/OpenAPI-Specification/blob/master/proposals/002_Webhooks.md#proposed-solution\n if (property === \"x-webhooks\") {\n // eslint-disable-next-line no-param-reassign\n swaggerObject[property] = annotation[property];\n }\n\n // Other extensions can be in varying places depending on different vendors and opinions.\n // The following return makes it so that they are not put in `paths` in the last case.\n // New specific extensions will need to be handled on case-by-case if to be included in `paths`.\n if (property.startsWith(\"x-\")) {\n return;\n }\n\n const commonProperties = [\n \"components\",\n \"consumes\",\n \"produces\",\n \"paths\",\n \"schemas\",\n \"securityDefinitions\",\n \"responses\",\n \"parameters\",\n \"definitions\",\n \"channels\",\n ];\n\n if (commonProperties.includes(property)) {\n Object.keys(annotation[property]).forEach((definition) => {\n // eslint-disable-next-line no-param-reassign\n swaggerObject[property][definition] = mergeDeep(swaggerObject[property][definition], annotation[property][definition]);\n });\n } else if (property === \"tags\") {\n const { tags } = annotation;\n\n if (Array.isArray(tags)) {\n tags.forEach((tag) => {\n if (!isTagPresentInTags(tag, swaggerObject[\"tags\"])) {\n swaggerObject[\"tags\"].push(tag);\n }\n });\n } else if (!isTagPresentInTags(tags, swaggerObject[\"tags\"])) {\n swaggerObject[\"tags\"].push(tags);\n }\n } else if (property === \"security\") {\n const { security } = annotation;\n\n // eslint-disable-next-line no-param-reassign\n swaggerObject[\"security\"] = security;\n } else if (property.startsWith(\"/\")) {\n // Paths which are not defined as \"paths\" property, starting with a slash \"/\"\n // eslint-disable-next-line no-param-reassign\n swaggerObject[\"paths\"][property] = mergeDeep(swaggerObject[\"paths\"][property], annotation[property]);\n }\n};\n\nexport default organizeSwaggerObject;\n","import SwaggerParser from \"@apidevtools/swagger-parser\";\n// eslint-disable-next-line import/no-named-as-default\nimport type OpenAPI from \"openapi-types\";\n\nconst validate = async (spec: Record<string, unknown>): Promise<void> => {\n await SwaggerParser.validate(spec as OpenAPI.OpenAPI.Document);\n};\n\nexport default validate;\n"]}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/jsdoc/comments-to-open-api.ts","../src/util/customizer.ts","../src/util/yaml-loc.ts","../src/parse-file.ts","../src/util/object-merge.ts","../src/spec-builder.ts","../src/swagger-jsdoc/comments-to-open-api.ts","../src/swagger-jsdoc/utils.ts","../src/swagger-jsdoc/organize-swagger-object.ts","../src/validate.ts"],"names":["parseComments","mergeWith","customizer","objectValue","sourceValue","customizer_default","fixSecurityObject","thing","primitiveTypes","formatMap","parseDescription","tag","rawType","isArray","parsedType","isPrimitive","isFormat","defaultValue","rootType","schema","description","tagsToObjects","tags","verbose","parsedResponse","nameAndDescription","contentType","example","status","header","link","security","scopeItem","scope","commentsToOpenApi","fileContents","openAPIRegex","comment","loc","result","method","path","pathsObject","spec","comments_to_open_api_default","yamlLoc","string","line","yaml_loc_default","readFileSync","yaml","ALLOWED_KEYS","ParseError","parseFile","file","fileContent","extension","invalidKeys","key","error","parse_file_default","objectMerge","a","b","subKey","object_merge_default","SpecBuilder","baseDefinition","parsedFile","components","paths","rest","value","spec_builder_default","mergeDeep","first","second","hasEmptyProperty","object","keyObject","isTagPresentInTags","targetTag","getSwaggerVersionFromSpec","organizeSwaggerObject","swaggerObject","annotation","property","definition","organize_swagger_object_default","specificationTemplate","specs","parsed","newError","errorString","parsedDocument","specification","SwaggerParser","validate","validate_default"],"mappings":"AACA,OAAS,SAASA,MAAqB,iBAEvC,OAAOC,MAAe,mBCHtB,IAAMC,EAAa,CAACC,EAAsBC,IAAkD,CACxF,GAAI,MAAM,QAAQD,CAAW,EACzB,MAAO,CAAC,GAAGA,EAAa,GAAGC,CAAW,CAI9C,EAEOC,EAAQH,EDCf,IAAMI,EAAqBC,GAAe,CAClCA,EAAM,WAENA,EAAM,SAAW,OAAO,KAAKA,EAAM,QAAQ,EAAE,IAAK,IACvC,CACH,CAAC,CAAC,EAAGA,EAAM,SAAS,CAAC,CACzB,EACH,EAET,EAEMC,EAAiB,IAAI,IAAI,CAAC,UAAW,SAAU,SAAU,UAAW,SAAU,OAAO,CAAC,EAEtFC,EAAoC,CACtC,OAAQ,SACR,KAAM,SACN,KAAM,SACN,YAAa,SACb,OAAQ,SACR,MAAO,SACP,MAAO,UACP,MAAO,UACP,SAAU,QACd,EAEMC,EAAoBC,GAAiI,CACvJ,IAAMC,EAAUD,EAAI,KACdE,EAAUD,EAAQ,SAAS,IAAI,EAE/BE,EAAaF,EAAQ,QAAQ,OAAQ,EAAE,EAEvCG,EAAcP,EAAe,IAAIM,CAAU,EAC3CE,EAAW,OAAO,KAAKP,CAAS,EAAE,SAASK,CAAU,EAEvDG,EAEJ,GAAIN,EAAI,QACJ,OAAQG,EAAY,CAChB,IAAK,UACL,IAAK,QACL,IAAK,QAAS,CACVG,EAAe,OAAO,SAASN,EAAI,QAAS,EAAE,EAC9C,KACJ,CACA,IAAK,SACL,IAAK,SACL,IAAK,QAAS,CACVM,EAAe,OAAO,WAAWN,EAAI,OAAO,EAC5C,KACJ,CACA,QAAS,CACLM,EAAeN,EAAI,QACnB,KACJ,CACJ,CAGJ,IAAIO,EAEAH,EACAG,EAAW,CAAE,QAASD,EAAc,KAAMH,CAAW,EAC9CE,EACPE,EAAW,CACP,QAASD,EACT,OAAQH,EACR,KAAML,EAAUK,CAAU,CAC9B,EAEAI,EAAW,CAAE,KAAM,wBAAwBJ,CAAU,EAAG,EAG5D,IAAIK,EAA6BN,EAC3B,CACI,MAAO,CACH,GAAGK,CACP,EACA,KAAM,OACV,EACA,CACI,GAAGA,CACP,EAEFJ,IAAe,KACfK,EAAS,QAIb,IAAIC,EAAkCT,EAAI,YAAY,KAAK,EAAE,QAAQ,OAAQ,EAAE,EAE/E,OAAIS,IAAgB,KAChBA,EAAc,QAGX,CACH,YAAAA,EACA,KAAMT,EAAI,KACV,QAAAC,EACA,SAAU,CAACD,EAAI,SACf,OAAAQ,CACJ,CACJ,EAIME,EAAgB,CAACC,EAAcC,IACjCD,EAAK,IAAKX,GAAQ,CACd,IAAMa,EAAiBd,EAAiBC,CAAG,EAIvCc,EAAqB,GAUzB,OARID,EAAe,OACfC,GAAsBD,EAAe,MAGrCA,EAAe,cACfC,GAAsB,IAAID,EAAe,YAAY,KAAK,CAAC,IAGvDb,EAAI,IAAK,CACb,IAAK,cACL,IAAK,UACL,IAAK,cACD,MAAO,CAAE,CAACA,EAAI,GAAG,EAAGc,CAAmB,EAG3C,IAAK,aACD,MAAO,CAAE,WAAY,EAAK,EAG9B,IAAK,eACD,MAAO,CACH,aAAc,CACV,YAAaD,EAAe,YAC5B,IAAKA,EAAe,IACxB,CACJ,EAGJ,IAAK,SACD,MAAO,CACH,QAAS,CACL,CACI,YAAaA,EAAe,YAC5B,IAAKA,EAAe,IACxB,CACJ,CACJ,EAGJ,IAAK,MACD,MAAO,CAAE,KAAM,CAACC,CAAkB,CAAE,EAGxC,IAAK,cACL,IAAK,cACL,IAAK,aACL,IAAK,YACD,MAAO,CACH,WAAY,CACR,CACI,YAAaD,EAAe,YAC5B,GAAIb,EAAI,IAAI,QAAQ,UAAW,EAAE,EACjC,KAAMa,EAAe,KACrB,SAAUA,EAAe,SACzB,OAAQA,EAAe,MAC3B,CACJ,CACJ,EAGJ,IAAK,cACD,MAAO,CACH,YAAa,CACT,QAAS,CACL,CAACA,EAAe,KAAK,QAAQ,QAAS,KAAK,CAAC,EAAG,CAC3C,OAAQA,EAAe,MAC3B,CACJ,CACJ,CACJ,EAGJ,IAAK,cAAe,CAChB,GAAM,CAACE,EAAaC,CAAO,EAAIH,EAAe,KAAK,MAAM,GAAG,EAE5D,MAAO,CACH,YAAa,CACT,QAAS,CACL,CAACE,CAAqB,EAAG,CACrB,SAAU,CACN,CAACC,CAAiB,EAAG,CACjB,KAAM,yBAAyBH,EAAe,OAAO,EACzD,CACJ,CACJ,CACJ,CACJ,CACJ,CACJ,CAEA,IAAK,kBACD,MAAO,CAAE,YAAa,CAAE,YAAaC,CAAmB,CAAE,EAG9D,IAAK,eACD,MAAO,CAAE,YAAa,CAAE,SAAU,EAAK,CAAE,EAG7C,IAAK,WACD,MAAO,CACH,UAAW,CACP,CAACD,EAAe,IAAI,EAAG,CACnB,YAAaA,EAAe,WAChC,CACJ,CACJ,EAGJ,IAAK,WACD,MAAO,CACH,UAAW,CACP,CAACA,EAAe,IAAI,EAAG,CACnB,KAAM,0BAA0BA,EAAe,OAAO,EAC1D,CACJ,CACJ,EAGJ,IAAK,kBAAmB,CACpB,GAAM,CAACI,EAAQF,CAAW,EAAIF,EAAe,KAAK,MAAM,GAAG,EAE3D,MAAO,CACH,UAAW,CACP,CAACI,CAAgB,EAAG,CAChB,QAAS,CACL,CAACF,CAAqB,EAAG,CACrB,OAAQF,EAAe,MAC3B,CACJ,CACJ,CACJ,CACJ,CACJ,CAEA,IAAK,0BAA2B,CAC5B,GAAM,CAACI,EAAQC,CAAM,EAAIL,EAAe,KAAK,MAAM,GAAG,EAEtD,MAAO,CACH,UAAW,CACP,CAACI,CAAgB,EAAG,CAChB,QAAS,CACL,CAACC,CAAgB,EAAG,CAChB,KAAM,wBAAwBL,EAAe,OAAO,EACxD,CACJ,CACJ,CACJ,CACJ,CACJ,CAEA,IAAK,iBAAkB,CACnB,GAAM,CAACI,EAAQC,CAAM,EAAIL,EAAe,KAAK,MAAM,GAAG,EAEtD,MAAO,CACH,UAAW,CACP,CAACI,CAAgB,EAAG,CAChB,QAAS,CACL,CAACC,CAAgB,EAAG,CAChB,YAAaL,EAAe,YAC5B,OAAQA,EAAe,MAC3B,CACJ,CACJ,CACJ,CACJ,CACJ,CAEA,IAAK,kBAAmB,CACpB,GAAM,CAACI,EAAQF,EAAaC,CAAO,EAAIH,EAAe,KAAK,MAAM,GAAG,EAEpE,MAAO,CACH,UAAW,CACP,CAACI,CAAgB,EAAG,CAChB,QAAS,CACL,CAACF,CAAqB,EAAG,CACrB,SAAU,CACN,CAACC,CAAiB,EAAG,CACjB,KAAM,yBAAyBH,EAAe,OAAO,EACzD,CACJ,CACJ,CACJ,CACJ,CACJ,CACJ,CACJ,CAEA,IAAK,eAAgB,CACjB,GAAM,CAACI,EAAQE,CAAI,EAAIN,EAAe,KAAK,MAAM,GAAG,EAEpD,MAAO,CACH,UAAW,CACP,CAACI,CAAgB,EAAG,CAChB,MAAO,CACH,CAACE,CAAc,EAAG,CACd,KAAM,sBAAsBN,EAAe,OAAO,EACtD,CACJ,CACJ,CACJ,CACJ,CACJ,CAEA,IAAK,gBACD,MAAO,CACH,YAAa,CACT,KAAM,8BAA8BA,EAAe,OAAO,EAC9D,CACJ,EAGJ,IAAK,oBACD,MAAO,CACH,UAAW,CACP,CAACA,EAAe,IAAI,EAAG,CACnB,KAAM,0BAA0BA,EAAe,OAAO,EAC1D,CACJ,CACJ,EAGJ,IAAK,iBACD,MAAO,CACH,WAAY,CAAC,CAAE,KAAM,2BAA2BA,EAAe,OAAO,EAAG,CAAC,CAC9E,EAGJ,IAAK,WAAY,CACb,GAAM,CAACO,EAAUC,CAAS,EAAIR,EAAe,KAAK,MAAM,GAAG,EAEvDS,EAAkB,CAAC,EAEvB,OAAID,IACAC,EAAQ,CAACD,CAAS,GAGf,CACH,SAAU,CAAE,CAACD,CAAkB,EAAGE,CAAM,CAC5C,CACJ,CAEA,QACI,MAAO,CAAC,CAEhB,CACJ,CAAC,EAECC,EAAoB,CAACC,EAAsBZ,IAA8D,CAE3G,IAAMa,EAAe,wDAKrB,OAH2BpC,EAAcmC,EAAc,CAAE,QAAS,UAAW,CAAC,EAIzE,OAAQE,GAAYD,EAAa,KAAKC,EAAQ,YAAY,KAAK,CAAC,CAAC,EACjE,IAAKA,GAAY,CAId,IAAMC,EAAMD,EAAQ,KAAK,OAAS,EAE5BE,EAAStC,EAAU,CAAC,EAAG,GAAGoB,EAAcgB,EAAQ,KAAMd,CAAO,EAAGlB,CAAU,EAEhFC,EAAkBiC,CAAM,EAExB,GAAM,CAACC,EAAQC,CAAI,EAAcJ,EAAQ,YAAY,MAAM,GAAG,EAExDK,EAA2B,CAC7B,CAAED,EAAgB,KAAK,CAAC,EAAG,CACvB,CAAED,EAAkB,YAAY,EAAE,KAAK,CAAC,EAAG,CACvC,GAAGD,CACP,CACJ,CACJ,EAGMI,EAAO,KAAK,MAAM,KAAK,UAAU,CAAE,MAAOD,CAAY,CAAC,CAAC,EAE9D,MAAO,CACH,IAAAJ,EACA,KAAAK,CACJ,CACJ,CAAC,CACT,EAEOC,EAAQV,EEvZf,IAAMW,EAAWC,GAECA,EAAO,MAAM,aAAa,EAEjB,OAAQC,GAGvB,yBAAyB,KAAKA,CAAI,EAC3B,GAGJA,EAAK,KAAK,EAAE,OAAS,CAC/B,EAEe,OAGbC,EAAQH,ECjBf,OAAS,gBAAAI,MAAoB,KAC7B,OAAOR,MAAU,OAEjB,OAAOS,MAAU,OAKjB,IAAMC,EAAe,IAAI,IAAI,CAAC,UAAW,OAAQ,UAAW,WAAY,OAAQ,eAAgB,aAAc,OAAO,CAAC,EAEhHC,EAAN,cAAyB,KAAM,CAE/B,EAEMC,EAAY,CACdC,EACApB,EACAX,IACyC,CAEzC,IAAMgC,EAAcN,EAAaK,EAAM,CAAE,SAAU,MAAO,CAAC,EACrDE,EAAYf,EAAK,QAAQa,CAAI,EAEnC,GAAIE,IAAc,SAAWA,IAAc,OAAQ,CAC/C,IAAMb,EAAOO,EAAK,MAAMK,CAAW,EAC7BE,EAAc,OAAO,KAAKd,CAAI,EAAE,OAAQe,GAAQ,CAACP,EAAa,IAAIO,CAAG,CAAC,EAE5E,GAAID,EAAY,OAAS,EAAG,CACxB,IAAME,EAAQ,IAAIP,EAAW,oBAAoBK,EAAY,KAAK,IAAI,CAAC,EAAE,EAEzE,MAAAE,EAAM,SAAWL,EAEXK,CACV,CAEA,OAAI,OAAO,KAAKhB,CAAI,EAAE,KAAMe,GAAQP,EAAa,IAAIO,CAAG,CAAC,EAG9C,CAAC,CAAE,IAFEV,EAAQO,CAAW,EAEhB,KAAAZ,CAAK,CAAC,EAGlB,CAAC,CACZ,CAEA,GAAI,CACA,OAAOT,EAAkBqB,EAAahC,CAAO,CACjD,OAASoC,EAAY,CACjB,MAAAA,EAAM,SAAWL,EAEXK,CACV,CACJ,EAEOC,GAAQP,ECrDf,IAAMQ,EAAc,CAAIC,EAAMC,IAAe,CACzC,OAAO,KAAKA,CAAW,EAAE,QAASL,GAAQ,CAElCI,EAAEJ,CAAqB,IAAM,OAE7BI,EAAEJ,CAAqB,EAAI,CACvB,GAAGK,EAAEL,CAAqB,CAC9B,EAEA,OAAO,KAAKK,EAAEL,CAAqB,CAAW,EAAE,QAASM,GAAW,CAE/DF,EAAEJ,CAAqB,EAA6BM,CAAM,EAAI,CAC3D,GAAIF,EAAEJ,CAAqB,EAA6BM,CAAM,EAC9D,GAAID,EAAEL,CAAqB,EAA6BM,CAAM,CAClE,CACJ,CAAC,CAET,CAAC,CACL,EAEOC,EAAQJ,ECPf,IAAMK,EAAN,KAA2C,CAiBhC,YAAYC,EAAgC,CAC/C,KAAK,QAAUA,EAAe,QAC9B,KAAK,KAAOA,EAAe,KAC3B,KAAK,QAAUA,EAAe,QAC9B,KAAK,MAAQA,EAAe,OAAS,CAAC,EACtC,KAAK,WAAaA,EAAe,WACjC,KAAK,SAAWA,EAAe,SAC/B,KAAK,KAAOA,EAAe,KAC3B,KAAK,aAAeA,EAAe,YACvC,CAEO,QAAQC,EAAmC,CAC9CA,EAAW,QAASd,GAAS,CACzB,GAAM,CAAE,WAAAe,EAAY,MAAAC,EAAO,GAAGC,CAAK,EAAIjB,EAGvCW,EAAY,KAAM,CACd,WAAYI,GAAc,CAAC,EAC3B,MAAOC,GAAS,CAAC,CACrB,CAAkB,EAGlB,OAAO,QAAQC,CAAI,EAAE,QAAQ,CAAC,CAACb,EAAKc,CAAK,IAAM,CAE3C,KAAKd,CAA0B,EAAIc,CACvC,CAAC,CACL,CAAC,CACL,CACJ,EAEOC,GAAQP,EC3Df,OAAS,SAASlE,MAAqB,iBAEvC,OAAOC,MAAe,mBAEtB,OAAOiD,MAAU,OCHjB,OAAOjD,MAAe,mBASf,IAAMyE,EAAY,CAACC,EAAgBC,IAA4B3E,EAAU,CAAC,EAAG0E,EAAOC,EAAQ,CAACd,EAAGC,IAAOA,IAAM,KAAOD,EAAI,MAAU,EAO5He,EAAoBC,GAC7B,OAAO,KAAKA,CAAM,EAEb,IAAKpB,GAAQoB,EAAOpB,CAAG,CAAC,EACxB,MAAOqB,GAAc,OAAOA,GAAc,UAAY,OAAO,KAAKA,CAAS,EAAE,MAAOrB,GAAQ,EAAEA,KAAOqB,EAAU,CAAC,EAO5GC,EAAqB,CAACrE,EAAWW,IAA0BA,EAAK,KAAM2D,GAActE,EAAI,OAASsE,EAAU,IAAI,EAE/GC,EAA6BvE,GAAkC,CACxE,OAAQA,EAAI,IAAK,CACb,IAAK,UACD,MAAO,KAEX,IAAK,WACD,MAAO,KAEX,IAAK,UACD,MAAO,KAEX,QACI,MAAO,IAEf,CACJ,ECtCA,IAAMwE,EAAwB,CAACC,EAAoCC,EAAiCC,IAA2B,CAY3H,GARIA,IAAa,eAEbF,EAAcE,CAAQ,EAAID,EAAWC,CAAQ,GAM7CA,EAAS,WAAW,IAAI,EACxB,OAgBJ,GAbyB,CACrB,aACA,WACA,WACA,QACA,UACA,sBACA,YACA,aACA,cACA,UACJ,EAEqB,SAASA,CAAQ,EAClC,OAAO,KAAKD,EAAWC,CAAQ,CAAC,EAAE,QAASC,GAAe,CAEtDH,EAAcE,CAAQ,EAAEC,CAAU,EAAIb,EAAUU,EAAcE,CAAQ,EAAEC,CAAU,EAAGF,EAAWC,CAAQ,EAAEC,CAAU,CAAC,CACzH,CAAC,UACMD,IAAa,OAAQ,CAC5B,GAAM,CAAE,KAAAhE,CAAK,EAAI+D,EAEb,MAAM,QAAQ/D,CAAI,EAClBA,EAAK,QAASX,GAAQ,CACbqE,EAAmBrE,EAAKyE,EAAc,IAAO,GAC9CA,EAAc,KAAQ,KAAKzE,CAAG,CAEtC,CAAC,EACOqE,EAAmB1D,EAAM8D,EAAc,IAAO,GACtDA,EAAc,KAAQ,KAAK9D,CAAI,CAEvC,SAAWgE,IAAa,WAAY,CAChC,GAAM,CAAE,SAAAvD,CAAS,EAAIsD,EAGrBD,EAAc,SAAcrD,CAChC,MAAWuD,EAAS,WAAW,GAAG,IAG9BF,EAAc,MAASE,CAAQ,EAAIZ,EAAUU,EAAc,MAASE,CAAQ,EAAGD,EAAWC,CAAQ,CAAC,EAE3G,EAEOE,EAAQL,EFtDf,IAAMM,EAAwB,CAC1B,GAAI,CAAC,QAAS,cAAe,YAAa,aAAc,qBAAqB,EAC7E,GAAI,CAAC,QAAS,cAAe,YAAa,aAAc,sBAAuB,YAAY,EAC3F,GAAI,CAAC,aAAc,UAAU,CACjC,EAIMpE,EAAgB,CAACqE,EAAenE,IAClCmE,EAAM,IAAK/C,GAAe,CACtB,IAAKA,EAAK,MAAQ,WAAaA,EAAK,MAAQ,WAAaA,EAAK,MAAQ,aAAeA,EAAK,cAAgB,GAAI,CAC1G,IAAMgD,EAASzC,EAAK,cAAcP,EAAK,WAAW,EAElD,GAAIgD,EAAO,OAAO,OAAS,EAAG,CAC1BA,EAAO,OAAO,IAAwBhC,GAAU,CAC5C,IAAMiC,EAA8BjC,EAEpC,OAAAiC,EAAS,WAAajD,EAAK,YAEpBiD,CACX,CAAC,EAED,IAAIC,EAAc,uCAElB,MAAAA,GAAetE,EACRoE,EAAO,OAEH,IAAKhC,GAAU,GAAGA,EAAM,SAAS,CAAC;AAAA;AAAA;AAAA,IAAiCA,EAAM,YAAY,QAAQ,OAAQ;AAAA,GAAM,CAAC;AAAA,OAAU,EACtH,KAAK;AAAA,CAAI,EAEdgC,EAAO,OAAO,IAAKhC,GAAUA,EAAM,SAAS,CAAC,EAAE,KAAK;AAAA,CAAI,EAExD,IAAI,MAAMkC,CAAW,CAC/B,CAEA,IAAMC,EAAiBH,EAAO,OAAO,EAC/BI,EAAqC,CACvC,KAAM,CAAC,CACX,EAEA,OAAAN,EAAsBP,EAA0BvC,CAAI,CAAC,EAAE,QAAS2C,GAAa,CACzES,EAAcT,CAAQ,EAAIS,EAAcT,CAAQ,GAAK,CAAC,CAC1D,CAAC,EAED,OAAO,KAAKQ,CAAc,EAAE,QAASR,GAAa,CAC9CE,EAAsBO,EAAeD,EAAgBR,CAAQ,CACjE,CAAC,EAEMS,CACX,CAEA,MAAO,CAAC,CACZ,CAAC,EAEC7D,EAAoB,CAACC,EAAsBZ,IAClBvB,EAAcmC,EAAc,CAAE,QAAS,UAAW,CAAC,EAGpD,IAAKE,GAAY,CAIvC,IAAMC,EAAMD,EAAQ,KAAK,OAAS,EAC5BE,EAAStC,EAAU,CAAC,EAAG,GAAGoB,EAAcgB,EAAQ,KAAMd,CAAO,EAAGlB,CAAU,EAEhF,CAAC,cAAe,YAAa,aAAc,sBAAuB,aAAc,MAAM,EAAE,QAASiF,GAAa,CACtG/C,EAAO+C,CAAQ,IAAM,QAAaT,EAAiBtC,EAAO+C,CAAQ,CAAC,GAEnE,OAAO/C,EAAO+C,CAAQ,CAE9B,CAAC,EAGD,IAAM3C,EAAO,KAAK,MAAM,KAAK,UAAUJ,CAAM,CAAC,EAE9C,MAAO,CACH,IAAAD,EACA,KAAAK,CACJ,CACJ,CAAC,EAGEC,GAAQV,EG9Ff,OAAO8D,MAAmB,8BAI1B,IAAMC,EAAW,MAAOtD,GAAiD,CACrE,MAAMqD,EAAc,SAASrD,CAAgC,CACjE,EAEOuD,GAAQD","sourcesContent":["import type { Spec } from \"comment-parser\";\nimport { parse as parseComments } from \"comment-parser\";\n// eslint-disable-next-line no-restricted-imports\nimport mergeWith from \"lodash.mergewith\";\n\nimport type { OpenApiObject, PathsObject } from \"../exported.d\";\nimport customizer from \"../util/customizer\";\n\n// The security object has a bizare setup...\nconst fixSecurityObject = (thing: any) => {\n if (thing.security) {\n // eslint-disable-next-line no-param-reassign\n thing.security = Object.keys(thing.security).map((s) => {\n return {\n [s]: thing.security[s],\n };\n });\n }\n};\n\nconst primitiveTypes = new Set([\"integer\", \"number\", \"string\", \"boolean\", \"object\", \"array\"]);\n\nconst formatMap: Record<string, string> = {\n binary: \"string\",\n byte: \"string\",\n date: \"string\",\n \"date-time\": \"string\",\n double: \"number\",\n float: \"number\",\n int32: \"integer\",\n int64: \"integer\",\n password: \"string\",\n};\n\nconst parseDescription = (tag: Spec): { description: string | undefined; name: string; rawType: string; required: boolean; schema: object | undefined } => {\n const rawType = tag.type;\n const isArray = rawType.endsWith(\"[]\");\n // eslint-disable-next-line regexp/strict\n const parsedType = rawType.replace(/\\[]$/, \"\");\n\n const isPrimitive = primitiveTypes.has(parsedType);\n const isFormat = Object.keys(formatMap).includes(parsedType);\n\n let defaultValue;\n\n if (tag.default) {\n switch (parsedType) {\n case \"integer\":\n case \"int32\":\n case \"int64\": {\n defaultValue = Number.parseInt(tag.default, 10);\n break;\n }\n case \"number\":\n case \"double\":\n case \"float\": {\n defaultValue = Number.parseFloat(tag.default);\n break;\n }\n default: {\n defaultValue = tag.default;\n break;\n }\n }\n }\n\n let rootType;\n\n if (isPrimitive) {\n rootType = { default: defaultValue, type: parsedType };\n } else if (isFormat) {\n rootType = {\n default: defaultValue,\n format: parsedType,\n type: formatMap[parsedType],\n };\n } else {\n rootType = { $ref: `#/components/schemas/${parsedType}` };\n }\n\n let schema: object | undefined = isArray\n ? {\n items: {\n ...rootType,\n },\n type: \"array\",\n }\n : {\n ...rootType,\n };\n\n if (parsedType === \"\") {\n schema = undefined;\n }\n\n // remove the optional dash from the description.\n let description: string | undefined = tag.description.trim().replace(/^- /u, \"\");\n\n if (description === \"\") {\n description = undefined;\n }\n\n return {\n description,\n name: tag.name,\n rawType,\n required: !tag.optional,\n schema,\n };\n};\n\n// @ts-expect-error\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\nconst tagsToObjects = (tags: Spec[], verbose?: boolean) =>\n tags.map((tag) => {\n const parsedResponse = parseDescription(tag);\n\n // Some ops only have a `description`, merge `name` and `description`\n // for these.\n let nameAndDescription = \"\";\n\n if (parsedResponse.name) {\n nameAndDescription += parsedResponse.name;\n }\n\n if (parsedResponse.description) {\n nameAndDescription += ` ${parsedResponse.description.trim()}`;\n }\n\n switch (tag.tag) {\n case \"operationId\":\n case \"summary\":\n case \"description\": {\n return { [tag.tag]: nameAndDescription };\n }\n\n case \"deprecated\": {\n return { deprecated: true };\n }\n\n case \"externalDocs\": {\n return {\n externalDocs: {\n description: parsedResponse.description,\n url: parsedResponse.name,\n },\n };\n }\n\n case \"server\": {\n return {\n servers: [\n {\n description: parsedResponse.description,\n url: parsedResponse.name,\n },\n ],\n };\n }\n\n case \"tag\": {\n return { tags: [nameAndDescription] };\n }\n\n case \"cookieParam\":\n case \"headerParam\":\n case \"queryParam\":\n case \"pathParam\": {\n return {\n parameters: [\n {\n description: parsedResponse.description,\n in: tag.tag.replace(/Param$/u, \"\"),\n name: parsedResponse.name,\n required: parsedResponse.required,\n schema: parsedResponse.schema,\n },\n ],\n };\n }\n\n case \"bodyContent\": {\n return {\n requestBody: {\n content: {\n [parsedResponse.name.replace(\"*\\\\/*\", \"*/*\")]: {\n schema: parsedResponse.schema,\n },\n },\n },\n };\n }\n\n case \"bodyExample\": {\n const [contentType, example] = parsedResponse.name.split(\".\");\n\n return {\n requestBody: {\n content: {\n [contentType as string]: {\n examples: {\n [example as string]: {\n $ref: `#/components/examples/${parsedResponse.rawType}`,\n },\n },\n },\n },\n },\n };\n }\n\n case \"bodyDescription\": {\n return { requestBody: { description: nameAndDescription } };\n }\n\n case \"bodyRequired\": {\n return { requestBody: { required: true } };\n }\n\n case \"response\": {\n return {\n responses: {\n [parsedResponse.name]: {\n description: parsedResponse.description,\n },\n },\n };\n }\n\n case \"callback\": {\n return {\n callbacks: {\n [parsedResponse.name]: {\n $ref: `#/components/callbacks/${parsedResponse.rawType}`,\n },\n },\n };\n }\n\n case \"responseContent\": {\n const [status, contentType] = parsedResponse.name.split(\".\");\n\n return {\n responses: {\n [status as string]: {\n content: {\n [contentType as string]: {\n schema: parsedResponse.schema,\n },\n },\n },\n },\n };\n }\n\n case \"responseHeaderComponent\": {\n const [status, header] = parsedResponse.name.split(\".\");\n\n return {\n responses: {\n [status as string]: {\n headers: {\n [header as string]: {\n $ref: `#/components/headers/${parsedResponse.rawType}`,\n },\n },\n },\n },\n };\n }\n\n case \"responseHeader\": {\n const [status, header] = parsedResponse.name.split(\".\");\n\n return {\n responses: {\n [status as string]: {\n headers: {\n [header as string]: {\n description: parsedResponse.description,\n schema: parsedResponse.schema,\n },\n },\n },\n },\n };\n }\n\n case \"responseExample\": {\n const [status, contentType, example] = parsedResponse.name.split(\".\");\n\n return {\n responses: {\n [status as string]: {\n content: {\n [contentType as string]: {\n examples: {\n [example as string]: {\n $ref: `#/components/examples/${parsedResponse.rawType}`,\n },\n },\n },\n },\n },\n },\n };\n }\n\n case \"responseLink\": {\n const [status, link] = parsedResponse.name.split(\".\");\n\n return {\n responses: {\n [status as string]: {\n links: {\n [link as string]: {\n $ref: `#/components/links/${parsedResponse.rawType}`,\n },\n },\n },\n },\n };\n }\n\n case \"bodyComponent\": {\n return {\n requestBody: {\n $ref: `#/components/requestBodies/${parsedResponse.rawType}`,\n },\n };\n }\n\n case \"responseComponent\": {\n return {\n responses: {\n [parsedResponse.name]: {\n $ref: `#/components/responses/${parsedResponse.rawType}`,\n },\n },\n };\n }\n\n case \"paramComponent\": {\n return {\n parameters: [{ $ref: `#/components/parameters/${parsedResponse.rawType}` }],\n };\n }\n\n case \"security\": {\n const [security, scopeItem] = parsedResponse.name.split(\".\");\n\n let scope: string[] = [];\n\n if (scopeItem) {\n scope = [scopeItem];\n }\n\n return {\n security: { [security as string]: scope },\n };\n }\n\n default: {\n return {};\n }\n }\n });\n\nconst commentsToOpenApi = (fileContents: string, verbose?: boolean): { loc: number; spec: OpenApiObject }[] => {\n // eslint-disable-next-line regexp/no-unused-capturing-group\n const openAPIRegex = /^(GET|PUT|POST|DELETE|OPTIONS|HEAD|PATCH|TRACE) \\/.*$/;\n\n const jsDocumentComments = parseComments(fileContents, { spacing: \"preserve\" });\n\n // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n return jsDocumentComments\n .filter((comment) => openAPIRegex.test(comment.description.trim()))\n .map((comment) => {\n // Line count, number of tags + 1 for description.\n // - Don't count line-breaking due to long descriptions\n // - Don't count empty lines\n const loc = comment.tags.length + 1;\n\n const result = mergeWith({}, ...tagsToObjects(comment.tags, verbose), customizer);\n\n fixSecurityObject(result);\n\n const [method, path]: string[] = comment.description.split(\" \");\n\n const pathsObject: PathsObject = {\n [(path as string).trim()]: {\n [(method as string).toLowerCase().trim()]: {\n ...result,\n },\n },\n };\n\n // Purge all undefined objects/arrays.\n const spec = JSON.parse(JSON.stringify({ paths: pathsObject }));\n\n return {\n loc,\n spec,\n };\n });\n};\n\nexport default commentsToOpenApi;\n","const customizer = (objectValue: unknown, sourceValue: unknown[]): unknown[] | undefined => {\n if (Array.isArray(objectValue)) {\n return [...objectValue, ...sourceValue] as unknown[];\n }\n\n return undefined;\n};\n\nexport default customizer;\n","const yamlLoc = (string: string): number => {\n // Break string into lines.\n const split = string.split(/\\r\\n|\\r|\\n/u);\n\n const filtered = split.filter((line) => {\n // Remove comments.\n // eslint-disable-next-line security/detect-unsafe-regex,regexp/no-unused-capturing-group\n if (/^\\s*(#\\s*(?:\\S.*)?)?$/u.test(line)) {\n return false;\n }\n // Remove empty lines.\n return line.trim().length > 0;\n });\n\n return filtered.length;\n};\n\nexport default yamlLoc;\n","import { readFileSync } from \"node:fs\";\nimport path from \"node:path\";\n\nimport yaml from \"yaml\";\n\nimport type { OpenApiObject } from \"./exported.d\";\nimport yamlLoc from \"./util/yaml-loc\";\n\nconst ALLOWED_KEYS = new Set([\"openapi\", \"info\", \"servers\", \"security\", \"tags\", \"externalDocs\", \"components\", \"paths\"]);\n\nclass ParseError extends Error {\n public filePath?: string;\n}\n\nconst parseFile = (\n file: string,\n commentsToOpenApi: (fileContent: string, verbose?: boolean) => { loc: number; spec: OpenApiObject }[],\n verbose?: boolean,\n): { loc: number; spec: OpenApiObject }[] => {\n // eslint-disable-next-line security/detect-non-literal-fs-filename\n const fileContent = readFileSync(file, { encoding: \"utf8\" });\n const extension = path.extname(file);\n\n if (extension === \".yaml\" || extension === \".yml\") {\n const spec = yaml.parse(fileContent);\n const invalidKeys = Object.keys(spec).filter((key) => !ALLOWED_KEYS.has(key));\n\n if (invalidKeys.length > 0) {\n const error = new ParseError(`Unexpected keys: ${invalidKeys.join(\", \")}`);\n\n error.filePath = file;\n\n throw error;\n }\n\n if (Object.keys(spec).some((key) => ALLOWED_KEYS.has(key))) {\n const loc = yamlLoc(fileContent);\n\n return [{ loc, spec }];\n }\n\n return [];\n }\n\n try {\n return commentsToOpenApi(fileContent, verbose);\n } catch (error: any) {\n error.filePath = file;\n\n throw error;\n }\n};\n\nexport default parseFile;\n","const objectMerge = <T>(a: T, b: T): void => {\n Object.keys(b as object).forEach((key) => {\n // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n if (a[key as keyof typeof b] === undefined) {\n // eslint-disable-next-line no-param-reassign\n a[key as keyof typeof b] = {\n ...b[key as keyof typeof b],\n };\n } else {\n Object.keys(b[key as keyof typeof b] as object).forEach((subKey) => {\n // eslint-disable-next-line no-param-reassign\n (a[key as keyof typeof b] as Record<string, object>)[subKey] = {\n ...(a[key as keyof typeof b] as Record<string, object>)[subKey],\n ...(b[key as keyof typeof b] as Record<string, object>)[subKey],\n };\n });\n }\n });\n};\n\nexport default objectMerge;\n","import type {\n BaseDefinition,\n ComponentsObject,\n ExternalDocumentationObject,\n InfoObject,\n OpenApiObject,\n PathsObject,\n SecurityRequirementObject,\n ServerObject,\n TagObject,\n} from \"./exported.d\";\nimport objectMerge from \"./util/object-merge\";\n\nclass SpecBuilder implements OpenApiObject {\n public components?: ComponentsObject;\n\n public externalDocs?: ExternalDocumentationObject;\n\n public info: InfoObject;\n\n public openapi: string;\n\n public paths: PathsObject;\n\n public security?: SecurityRequirementObject[];\n\n public servers?: ServerObject[];\n\n public tags?: TagObject[];\n\n public constructor(baseDefinition: BaseDefinition) {\n this.openapi = baseDefinition.openapi;\n this.info = baseDefinition.info;\n this.servers = baseDefinition.servers;\n this.paths = baseDefinition.paths ?? {};\n this.components = baseDefinition.components;\n this.security = baseDefinition.security;\n this.tags = baseDefinition.tags;\n this.externalDocs = baseDefinition.externalDocs;\n }\n\n public addData(parsedFile: OpenApiObject[]): void {\n parsedFile.forEach((file) => {\n const { components, paths, ...rest } = file;\n\n // only merge paths and components\n objectMerge(this, {\n components: components ?? {},\n paths: paths ?? {},\n } as OpenApiObject);\n\n // overwrite everything else:\n Object.entries(rest).forEach(([key, value]) => {\n // @ts-expect-error\n this[key as keyof OpenApiObject] = value;\n });\n });\n }\n}\n\nexport default SpecBuilder;\n","import type { Spec } from \"comment-parser\";\nimport { parse as parseComments } from \"comment-parser\";\n// eslint-disable-next-line no-restricted-imports\nimport mergeWith from \"lodash.mergewith\";\nimport type { YAMLError } from \"yaml\";\nimport yaml from \"yaml\";\n\nimport type { OpenApiObject } from \"../exported.d\";\nimport customizer from \"../util/customizer\";\nimport organizeSwaggerObject from \"./organize-swagger-object\";\nimport { getSwaggerVersionFromSpec, hasEmptyProperty } from \"./utils\";\n\nconst specificationTemplate = {\n v2: [\"paths\", \"definitions\", \"responses\", \"parameters\", \"securityDefinitions\"],\n v3: [\"paths\", \"definitions\", \"responses\", \"parameters\", \"securityDefinitions\", \"components\"],\n v4: [\"components\", \"channels\"],\n};\n\ntype ExtendedYAMLError = YAMLError & { annotation?: string };\n\nconst tagsToObjects = (specs: Spec[], verbose?: boolean) =>\n specs.map((spec: Spec) => {\n if ((spec.tag === \"openapi\" || spec.tag === \"swagger\" || spec.tag === \"asyncapi\") && spec.description !== \"\") {\n const parsed = yaml.parseDocument(spec.description);\n\n if (parsed.errors.length > 0) {\n parsed.errors.map<ExtendedYAMLError>((error) => {\n const newError: ExtendedYAMLError = error;\n\n newError.annotation = spec.description;\n\n return newError;\n });\n\n let errorString = \"Error parsing YAML in @openapi spec:\";\n\n errorString += verbose\n ? (parsed.errors as ExtendedYAMLError[])\n // eslint-disable-next-line @typescript-eslint/no-base-to-string\n .map((error) => `${error.toString()}\\nImbedded within:\\n\\`\\`\\`\\n ${error.annotation?.replace(/\\n/gu, \"\\n \")}\\n\\`\\`\\``)\n .join(\"\\n\")\n : // eslint-disable-next-line @typescript-eslint/no-base-to-string\n parsed.errors.map((error) => error.toString()).join(\"\\n\");\n\n throw new Error(errorString);\n }\n\n const parsedDocument = parsed.toJSON();\n const specification: Record<string, any> = {\n tags: [],\n };\n\n specificationTemplate[getSwaggerVersionFromSpec(spec)].forEach((property) => {\n specification[property] = specification[property] || {};\n });\n\n Object.keys(parsedDocument).forEach((property) => {\n organizeSwaggerObject(specification, parsedDocument, property);\n });\n\n return specification;\n }\n\n return {};\n });\n\nconst commentsToOpenApi = (fileContents: string, verbose?: boolean): { loc: number; spec: OpenApiObject }[] => {\n const jsDocumentComments = parseComments(fileContents, { spacing: \"preserve\" });\n\n // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n return jsDocumentComments.map((comment) => {\n // Line count, number of tags + 1 for description.\n // - Don't count line-breaking due to long descriptions\n // - Don't count empty lines\n const loc = comment.tags.length + 1;\n const result = mergeWith({}, ...tagsToObjects(comment.tags, verbose), customizer);\n\n [\"definitions\", \"responses\", \"parameters\", \"securityDefinitions\", \"components\", \"tags\"].forEach((property) => {\n if (result[property] !== undefined && hasEmptyProperty(result[property])) {\n // eslint-disable-next-line @typescript-eslint/no-dynamic-delete\n delete result[property];\n }\n });\n\n // Purge all undefined objects/arrays.\n const spec = JSON.parse(JSON.stringify(result));\n\n return {\n loc,\n spec,\n };\n });\n};\n\nexport default commentsToOpenApi;\n","import type { Spec } from \"comment-parser\";\n// eslint-disable-next-line no-restricted-imports\nimport mergeWith from \"lodash.mergewith\";\n\n/**\n * A recursive deep-merge that ignores null values when merging.\n * This returns the merged object and does not mutate.\n * @param {object} first the first object to get merged\n * @param {object} second the second object to get merged\n */\n// eslint-disable-next-line @typescript-eslint/no-unsafe-return\nexport const mergeDeep = (first?: object, second?: object): object => mergeWith({}, first, second, (a, b) => (b === null ? a : undefined));\n\n/**\n * Checks if there is any properties of the input object which are an empty object\n * @param {object} object - the object to check\n * @returns boolean\n */\nexport const hasEmptyProperty = (object: Record<string, any>): boolean =>\n Object.keys(object)\n // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n .map((key) => object[key])\n .every((keyObject) => typeof keyObject === \"object\" && Object.keys(keyObject).every((key) => !(key in keyObject)));\n\n/**\n * @param {object} tag\n * @param {array} tags\n * @returns boolean\n */\nexport const isTagPresentInTags = (tag: Spec, tags: Spec[]): boolean => tags.some((targetTag) => tag.name === targetTag.name);\n\nexport const getSwaggerVersionFromSpec = (tag: Spec): \"v2\" | \"v3\" | \"v4\" => {\n switch (tag.tag) {\n case \"openapi\": {\n return \"v3\";\n }\n case \"asyncapi\": {\n return \"v4\";\n }\n case \"swagger\": {\n return \"v2\";\n }\n default: {\n return \"v2\";\n }\n }\n};\n","import { isTagPresentInTags, mergeDeep } from \"./utils\";\n\n/**\n * @param {object} swaggerObject\n * @param {object} annotation\n * @param {string} property\n */\n\nconst organizeSwaggerObject = (swaggerObject: Record<string, any>, annotation: Record<string, any>, property: string): void => {\n // Root property on purpose.\n // eslint-disable-next-line no-secrets/no-secrets\n // @see https://github.com/OAI/OpenAPI-Specification/blob/master/proposals/002_Webhooks.md#proposed-solution\n if (property === \"x-webhooks\") {\n // eslint-disable-next-line no-param-reassign\n swaggerObject[property] = annotation[property];\n }\n\n // Other extensions can be in varying places depending on different vendors and opinions.\n // The following return makes it so that they are not put in `paths` in the last case.\n // New specific extensions will need to be handled on case-by-case if to be included in `paths`.\n if (property.startsWith(\"x-\")) {\n return;\n }\n\n const commonProperties = [\n \"components\",\n \"consumes\",\n \"produces\",\n \"paths\",\n \"schemas\",\n \"securityDefinitions\",\n \"responses\",\n \"parameters\",\n \"definitions\",\n \"channels\",\n ];\n\n if (commonProperties.includes(property)) {\n Object.keys(annotation[property]).forEach((definition) => {\n // eslint-disable-next-line no-param-reassign\n swaggerObject[property][definition] = mergeDeep(swaggerObject[property][definition], annotation[property][definition]);\n });\n } else if (property === \"tags\") {\n const { tags } = annotation;\n\n if (Array.isArray(tags)) {\n tags.forEach((tag) => {\n if (!isTagPresentInTags(tag, swaggerObject[\"tags\"])) {\n swaggerObject[\"tags\"].push(tag);\n }\n });\n } else if (!isTagPresentInTags(tags, swaggerObject[\"tags\"])) {\n swaggerObject[\"tags\"].push(tags);\n }\n } else if (property === \"security\") {\n const { security } = annotation;\n\n // eslint-disable-next-line no-param-reassign\n swaggerObject[\"security\"] = security;\n } else if (property.startsWith(\"/\")) {\n // Paths which are not defined as \"paths\" property, starting with a slash \"/\"\n // eslint-disable-next-line no-param-reassign\n swaggerObject[\"paths\"][property] = mergeDeep(swaggerObject[\"paths\"][property], annotation[property]);\n }\n};\n\nexport default organizeSwaggerObject;\n","import SwaggerParser from \"@apidevtools/swagger-parser\";\n// eslint-disable-next-line import/no-named-as-default\nimport type OpenAPI from \"openapi-types\";\n\nconst validate = async (spec: Record<string, unknown>): Promise<void> => {\n await SwaggerParser.validate(spec as OpenAPI.OpenAPI.Document);\n};\n\nexport default validate;\n"]}
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
var
|
|
4
|
-
require('../../chunk-
|
|
3
|
+
var chunkQPIZ6QWT_js = require('../../chunk-QPIZ6QWT.js');
|
|
4
|
+
require('../../chunk-T6JDVCNR.js');
|
|
5
5
|
var process = require('process');
|
|
6
6
|
|
|
7
|
-
var c=(o,e="generate",t=".openapirc.js")=>{o.command(e).description("Generates OpenAPI (Swagger) documentation from JSDoc's").usage("[options] <path ...>").argument("[path ...]","Paths to files or directories to parse").option("-c, --config [.openapirc.js]","@visulima/jsdoc-open-api config file path.").option("-o, --output [swaggerSpec.json]","Output swagger specification.").option("-v, --verbose","Verbose output.").option("-vv, --very-verbose","Very verbose output.").action(async(r,a)=>{try{await
|
|
7
|
+
var c=(o,e="generate",t=".openapirc.js")=>{o.command(e).description("Generates OpenAPI (Swagger) documentation from JSDoc's").usage("[options] <path ...>").argument("[path ...]","Paths to files or directories to parse").option("-c, --config [.openapirc.js]","@visulima/jsdoc-open-api config file path.").option("-o, --output [swaggerSpec.json]","Output swagger specification.").option("-v, --verbose","Verbose output.").option("-vv, --very-verbose","Very verbose output.").action(async(r,a)=>{try{await chunkQPIZ6QWT_js.a(t,r,a);}catch(p){console.error(p),process.exit(1);}});},d=c;var u=(o,e="init",t="Inits a pre-configured @visulima/jsdoc-open-api config file.",r=".openapirc.js")=>{o.command(e).description(t).action(()=>{try{chunkQPIZ6QWT_js.b(r);}catch(a){console.error(a),process.exit(1);}});},g=u;
|
|
8
8
|
|
|
9
9
|
exports.generateCommand = d;
|
|
10
10
|
exports.initCommand = g;
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { a, b } from '../../chunk-
|
|
2
|
-
import '../../chunk-
|
|
1
|
+
import { a, b } from '../../chunk-LBK736U7.mjs';
|
|
2
|
+
import '../../chunk-RMC27EXI.mjs';
|
|
3
3
|
import { exit } from 'process';
|
|
4
4
|
|
|
5
5
|
var d=(o,e="generate",t=".openapirc.js")=>{o.command(e).description("Generates OpenAPI (Swagger) documentation from JSDoc's").usage("[options] <path ...>").argument("[path ...]","Paths to files or directories to parse").option("-c, --config [.openapirc.js]","@visulima/jsdoc-open-api config file path.").option("-o, --output [swaggerSpec.json]","Output swagger specification.").option("-v, --verbose","Verbose output.").option("-vv, --very-verbose","Very verbose output.").action(async(r,a$1)=>{try{await a(t,r,a$1);}catch(s){console.error(s),exit(1);}});},f=d;var g=(o,e="init",t="Inits a pre-configured @visulima/jsdoc-open-api config file.",r=".openapirc.js")=>{o.command(e).description(t).action(()=>{try{b(r);}catch(a){console.error(a),exit(1);}});},l=g;
|
package/dist/cli/index.js
CHANGED
|
@@ -1,17 +1,17 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
var
|
|
4
|
-
require('../chunk-
|
|
3
|
+
var chunkQPIZ6QWT_js = require('../chunk-QPIZ6QWT.js');
|
|
4
|
+
require('../chunk-T6JDVCNR.js');
|
|
5
5
|
|
|
6
6
|
|
|
7
7
|
|
|
8
8
|
Object.defineProperty(exports, 'generateCommand', {
|
|
9
9
|
enumerable: true,
|
|
10
|
-
get: function () { return
|
|
10
|
+
get: function () { return chunkQPIZ6QWT_js.a; }
|
|
11
11
|
});
|
|
12
12
|
Object.defineProperty(exports, 'initCommand', {
|
|
13
13
|
enumerable: true,
|
|
14
|
-
get: function () { return
|
|
14
|
+
get: function () { return chunkQPIZ6QWT_js.b; }
|
|
15
15
|
});
|
|
16
16
|
//# sourceMappingURL=out.js.map
|
|
17
17
|
//# sourceMappingURL=index.js.map
|
package/dist/cli/index.mjs
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export { a as generateCommand, b as initCommand } from '../chunk-
|
|
2
|
-
import '../chunk-
|
|
1
|
+
export { a as generateCommand, b as initCommand } from '../chunk-LBK736U7.mjs';
|
|
2
|
+
import '../chunk-RMC27EXI.mjs';
|
|
3
3
|
//# sourceMappingURL=out.js.map
|
|
4
4
|
//# sourceMappingURL=index.mjs.map
|
package/dist/index.js
CHANGED
|
@@ -1,32 +1,32 @@
|
|
|
1
1
|
'use strict';
|
|
2
2
|
|
|
3
|
-
var
|
|
3
|
+
var chunkT6JDVCNR_js = require('./chunk-T6JDVCNR.js');
|
|
4
4
|
var fs = require('fs');
|
|
5
5
|
var path = require('path');
|
|
6
6
|
var process = require('process');
|
|
7
7
|
var readdir = require('@visulima/readdir');
|
|
8
8
|
|
|
9
|
-
var B=["coverage/**",".github/**","packages/*/test{,s}/**","**/*.d.ts","test{,s}/**","test{,-*}.{js,cjs,mjs,ts,tsx,jsx,yaml,yml}","**/*{.,-}test.{js,cjs,mjs,ts,tsx,jsx,yaml,yml}","**/__tests__/**","**/{ava,babel,nyc}.config.{js,cjs,mjs}","**/jest.config.{js,cjs,mjs,ts}","**/{karma,rollup,webpack}.config.js","**/.{eslint,mocha}rc.{js,cjs}","**/.{travis,yarnrc}.yml","**/{docker-compose,docker}.yml","**/.yamllint.{yaml,yml}","**/node_modules/**","**/pnpm-lock.yaml","**/pnpm-workspace.yaml","**/{package,package-lock}.json","**/yarn.lock","**/package.json5","**/.next/**"],b=t=>{t&&(console.error(t),process.exit(1));},d=class{constructor(r,u,i,e){this.assetsPath=r,this.swaggerDefinition=i,this.sources=u,this.verbose=e.verbose??!1,this.ignore=e.ignore??[];}apply(r){r.hooks.make.tapAsync("SwaggerCompilerPlugin",async(u,i)=>{console.log("Build paused, switching to swagger build");let e=new
|
|
9
|
+
var B=["coverage/**",".github/**","packages/*/test{,s}/**","**/*.d.ts","test{,s}/**","test{,-*}.{js,cjs,mjs,ts,tsx,jsx,yaml,yml}","**/*{.,-}test.{js,cjs,mjs,ts,tsx,jsx,yaml,yml}","**/__tests__/**","**/{ava,babel,nyc}.config.{js,cjs,mjs}","**/jest.config.{js,cjs,mjs,ts}","**/{karma,rollup,webpack}.config.js","**/.{eslint,mocha}rc.{js,cjs}","**/.{travis,yarnrc}.yml","**/{docker-compose,docker}.yml","**/.yamllint.{yaml,yml}","**/node_modules/**","**/pnpm-lock.yaml","**/pnpm-workspace.yaml","**/{package,package-lock}.json","**/yarn.lock","**/package.json5","**/.next/**"],b=t=>{t&&(console.error(t),process.exit(1));},d=class{constructor(r,u,i,e){this.assetsPath=r,this.swaggerDefinition=i,this.sources=u,this.verbose=e.verbose??!1,this.ignore=e.ignore??[];}apply(r){r.hooks.make.tapAsync("SwaggerCompilerPlugin",async(u,i)=>{console.log("Build paused, switching to swagger build");let e=new chunkT6JDVCNR_js.d(this.swaggerDefinition);for await(let s of this.sources){let a=await readdir.collect(s,{extensions:[".js",".cjs",".mjs",".ts",".tsx",".jsx",".yaml",".yml"],includeDirs:!1,minimatchOptions:{match:{debug:this.verbose,matchBase:!0},skip:{debug:this.verbose,matchBase:!0}},skip:[...this.ignore,...B]});this.verbose&&(console.log(`Found ${a.length} files in ${s}`),console.log(a)),a.forEach(n=>{this.verbose&&console.log(`Parsing file ${n}`);try{let l=chunkT6JDVCNR_js.c(n,chunkT6JDVCNR_js.a,this.verbose);e.addData(l.map(c=>c.spec));let j=chunkT6JDVCNR_js.c(n,chunkT6JDVCNR_js.e,this.verbose);e.addData(j.map(c=>c.spec));}catch(l){console.error(l),process.exit(1);}});}try{this.verbose&&(console.log("Validating swagger spec"),console.log(JSON.stringify(e,null,2))),await chunkT6JDVCNR_js.f(JSON.parse(JSON.stringify(e)));}catch(s){console.error(s.toJSON()),process.exit(1);}let{assetsPath:y}=this;fs.mkdir(path.dirname(y),{recursive:!0},s=>{s&&b(s),fs.writeFile(y,JSON.stringify(e,null,2),b);}),this.verbose&&console.log(`Written swagger spec to "${this.assetsPath}" file`),console.log("switching back to normal build"),i();});}},J=d;
|
|
10
10
|
|
|
11
11
|
Object.defineProperty(exports, 'SpecBuilder', {
|
|
12
12
|
enumerable: true,
|
|
13
|
-
get: function () { return
|
|
13
|
+
get: function () { return chunkT6JDVCNR_js.d; }
|
|
14
14
|
});
|
|
15
15
|
Object.defineProperty(exports, 'jsDocumentCommentsToOpenApi', {
|
|
16
16
|
enumerable: true,
|
|
17
|
-
get: function () { return
|
|
17
|
+
get: function () { return chunkT6JDVCNR_js.a; }
|
|
18
18
|
});
|
|
19
19
|
Object.defineProperty(exports, 'parseFile', {
|
|
20
20
|
enumerable: true,
|
|
21
|
-
get: function () { return
|
|
21
|
+
get: function () { return chunkT6JDVCNR_js.c; }
|
|
22
22
|
});
|
|
23
23
|
Object.defineProperty(exports, 'swaggerJsDocumentCommentsToOpenApi', {
|
|
24
24
|
enumerable: true,
|
|
25
|
-
get: function () { return
|
|
25
|
+
get: function () { return chunkT6JDVCNR_js.e; }
|
|
26
26
|
});
|
|
27
27
|
Object.defineProperty(exports, 'yamlLoc', {
|
|
28
28
|
enumerable: true,
|
|
29
|
-
get: function () { return
|
|
29
|
+
get: function () { return chunkT6JDVCNR_js.b; }
|
|
30
30
|
});
|
|
31
31
|
exports.SwaggerCompilerPlugin = J;
|
|
32
32
|
//# sourceMappingURL=out.js.map
|
package/dist/index.mjs
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import { d as d$1, c, a, e, f } from './chunk-
|
|
2
|
-
export { d as SpecBuilder, a as jsDocumentCommentsToOpenApi, c as parseFile, e as swaggerJsDocumentCommentsToOpenApi, b as yamlLoc } from './chunk-
|
|
1
|
+
import { d as d$1, c, a, e, f } from './chunk-RMC27EXI.mjs';
|
|
2
|
+
export { d as SpecBuilder, a as jsDocumentCommentsToOpenApi, c as parseFile, e as swaggerJsDocumentCommentsToOpenApi, b as yamlLoc } from './chunk-RMC27EXI.mjs';
|
|
3
3
|
import { mkdir, writeFile } from 'fs';
|
|
4
4
|
import { dirname } from 'path';
|
|
5
5
|
import { exit } from 'process';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@visulima/jsdoc-open-api",
|
|
3
|
-
"version": "2.0.
|
|
3
|
+
"version": "2.0.8",
|
|
4
4
|
"description": "Generates swagger doc based on JSDoc.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"visulima",
|
|
@@ -103,22 +103,22 @@
|
|
|
103
103
|
},
|
|
104
104
|
"dependencies": {
|
|
105
105
|
"@apidevtools/swagger-parser": "^10.1.0",
|
|
106
|
-
"@visulima/readdir": "2.0.
|
|
107
|
-
"comment-parser": "^1.4.
|
|
106
|
+
"@visulima/readdir": "2.0.7",
|
|
107
|
+
"comment-parser": "^1.4.1",
|
|
108
108
|
"lodash.mergewith": "^4.6.2",
|
|
109
109
|
"read-pkg-up": "^7.0.1",
|
|
110
110
|
"yaml": "^2.3.3"
|
|
111
111
|
},
|
|
112
112
|
"devDependencies": {
|
|
113
|
-
"@anolilab/eslint-config": "^
|
|
114
|
-
"@anolilab/prettier-config": "^5.0.
|
|
115
|
-
"@anolilab/semantic-release-preset": "^8.0.
|
|
113
|
+
"@anolilab/eslint-config": "^15.0.2",
|
|
114
|
+
"@anolilab/prettier-config": "^5.0.13",
|
|
115
|
+
"@anolilab/semantic-release-preset": "^8.0.2",
|
|
116
116
|
"@babel/core": "^7.23.2",
|
|
117
117
|
"@rushstack/eslint-plugin-security": "^0.7.1",
|
|
118
118
|
"@types/cli-progress": "^3.11.4",
|
|
119
119
|
"@types/http-errors": "^2.0.3",
|
|
120
120
|
"@types/lodash.mergewith": "^4.6.8",
|
|
121
|
-
"@types/node": "18.18.
|
|
121
|
+
"@types/node": "18.18.8",
|
|
122
122
|
"@types/webpack": "^5.28.4",
|
|
123
123
|
"@vitest/coverage-v8": "^0.34.6",
|
|
124
124
|
"cli-progress": "^3.12.0",
|
|
@@ -127,14 +127,14 @@
|
|
|
127
127
|
"eslint": "^8.52.0",
|
|
128
128
|
"eslint-plugin-deprecation": "^2.0.0",
|
|
129
129
|
"eslint-plugin-etc": "^2.0.3",
|
|
130
|
-
"eslint-plugin-import": "npm:eslint-plugin-i@^2.
|
|
130
|
+
"eslint-plugin-import": "npm:eslint-plugin-i@^2.29.0",
|
|
131
131
|
"eslint-plugin-mdx": "^2.2.0",
|
|
132
132
|
"eslint-plugin-vitest": "^0.3.8",
|
|
133
133
|
"eslint-plugin-vitest-globals": "^1.4.0",
|
|
134
134
|
"openapi-types": "^12.1.3",
|
|
135
135
|
"prettier": "^3.0.3",
|
|
136
136
|
"rimraf": "^5.0.5",
|
|
137
|
-
"semantic-release": "^22.0.
|
|
137
|
+
"semantic-release": "^22.0.6",
|
|
138
138
|
"sort-package-json": "^2.6.0",
|
|
139
139
|
"tsup": "^7.2.0",
|
|
140
140
|
"typescript": "^5.2.2",
|
|
@@ -147,7 +147,7 @@
|
|
|
147
147
|
"webpack": "^5.89.0"
|
|
148
148
|
},
|
|
149
149
|
"engines": {
|
|
150
|
-
"node": ">=18.* <=
|
|
150
|
+
"node": ">=18.* <=21.*"
|
|
151
151
|
},
|
|
152
152
|
"publishConfig": {
|
|
153
153
|
"access": "public",
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/jsdoc/comments-to-open-api.ts","../src/util/customizer.ts","../src/util/yaml-loc.ts","../src/parse-file.ts","../src/util/object-merge.ts","../src/spec-builder.ts","../src/swagger-jsdoc/comments-to-open-api.ts","../src/swagger-jsdoc/utils.ts","../src/swagger-jsdoc/organize-swagger-object.ts","../src/validate.ts"],"names":["parseComments","mergeWith","customizer","objectValue","sourceValue","customizer_default","fixSecurityObject","thing","primitiveTypes","formatMap","parseDescription","tag","rawType","isArray","parsedType","isPrimitive","isFormat","defaultValue","rootType","schema","description","tagsToObjects","tags","verbose","parsedResponse","nameAndDescription","contentType","example","status","header","link","security","scopeItem","scope","commentsToOpenApi","fileContents","openAPIRegex","comment","loc","result","method","path","pathsObject","spec","comments_to_open_api_default","yamlLoc","string","line","yaml_loc_default","readFileSync","yaml","ALLOWED_KEYS","ParseError","parseFile","file","fileContent","extension","invalidKeys","key","error","parse_file_default","objectMerge","a","b","subKey","object_merge_default","SpecBuilder","baseDefinition","parsedFile","components","paths","rest","value","spec_builder_default","mergeDeep","first","second","hasEmptyProperty","object","keyObject","isTagPresentInTags","targetTag","getSwaggerVersionFromSpec","organizeSwaggerObject","swaggerObject","annotation","property","definition","organize_swagger_object_default","specificationTemplate","specs","parsed","newError","errorString","parsedDocument","specification","SwaggerParser","validate","validate_default"],"mappings":"AACA,OAAS,SAASA,MAAqB,iBAEvC,OAAOC,MAAe,mBCHtB,IAAMC,EAAa,CAACC,EAAsBC,IAAkD,CACxF,GAAI,MAAM,QAAQD,CAAW,EACzB,MAAO,CAAC,GAAGA,EAAa,GAAGC,CAAW,CAI9C,EAEOC,EAAQH,EDCf,IAAMI,EAAqBC,GAAe,CAClCA,EAAM,WAENA,EAAM,SAAW,OAAO,KAAKA,EAAM,QAAQ,EAAE,IAAK,IACvC,CACH,CAAC,CAAC,EAAGA,EAAM,SAAS,CAAC,CACzB,EACH,EAET,EAEMC,EAAiB,IAAI,IAAI,CAAC,UAAW,SAAU,SAAU,UAAW,SAAU,OAAO,CAAC,EAEtFC,EAAoC,CACtC,OAAQ,SACR,KAAM,SACN,KAAM,SACN,YAAa,SACb,OAAQ,SACR,MAAO,SACP,MAAO,UACP,MAAO,UACP,SAAU,QACd,EAEMC,EAAoBC,GAAiI,CACvJ,IAAMC,EAAUD,EAAI,KACdE,EAAUD,EAAQ,SAAS,IAAI,EAE/BE,EAAaF,EAAQ,QAAQ,OAAQ,EAAE,EAEvCG,EAAcP,EAAe,IAAIM,CAAU,EAC3CE,EAAW,OAAO,KAAKP,CAAS,EAAE,SAASK,CAAU,EAEvDG,EAEJ,GAAIN,EAAI,QACJ,OAAQG,EAAY,CAChB,IAAK,UACL,IAAK,QACL,IAAK,QAAS,CACVG,EAAe,OAAO,SAASN,EAAI,QAAS,EAAE,EAC9C,KACJ,CACA,IAAK,SACL,IAAK,SACL,IAAK,QAAS,CACVM,EAAe,OAAO,WAAWN,EAAI,OAAO,EAC5C,KACJ,CACA,QAAS,CACLM,EAAeN,EAAI,QACnB,KACJ,CACJ,CAGJ,IAAIO,EAEAH,EACAG,EAAW,CAAE,QAASD,EAAc,KAAMH,CAAW,EAC9CE,EACPE,EAAW,CACP,QAASD,EACT,OAAQH,EACR,KAAML,EAAUK,CAAU,CAC9B,EAEAI,EAAW,CAAE,KAAM,wBAAwBJ,CAAU,EAAG,EAG5D,IAAIK,EAA6BN,EAC3B,CACI,MAAO,CACH,GAAGK,CACP,EACA,KAAM,OACV,EACA,CACI,GAAGA,CACP,EAEFJ,IAAe,KACfK,EAAS,QAIb,IAAIC,EAAkCT,EAAI,YAAY,KAAK,EAAE,QAAQ,OAAQ,EAAE,EAE/E,OAAIS,IAAgB,KAChBA,EAAc,QAGX,CACH,YAAAA,EACA,KAAMT,EAAI,KACV,QAAAC,EACA,SAAU,CAACD,EAAI,SACf,OAAAQ,CACJ,CACJ,EAIME,EAAgB,CAACC,EAAcC,IACjCD,EAAK,IAAKX,GAAQ,CACd,IAAMa,EAAiBd,EAAiBC,CAAG,EAIvCc,EAAqB,GAUzB,OARID,EAAe,OACfC,GAAsBD,EAAe,MAGrCA,EAAe,cACfC,GAAsB,IAAID,EAAe,YAAY,KAAK,CAAC,IAGvDb,EAAI,IAAK,CACb,IAAK,cACL,IAAK,UACL,IAAK,cACD,MAAO,CAAE,CAACA,EAAI,GAAG,EAAGc,CAAmB,EAG3C,IAAK,aACD,MAAO,CAAE,WAAY,EAAK,EAG9B,IAAK,eACD,MAAO,CACH,aAAc,CACV,YAAaD,EAAe,YAC5B,IAAKA,EAAe,IACxB,CACJ,EAGJ,IAAK,SACD,MAAO,CACH,QAAS,CACL,CACI,YAAaA,EAAe,YAC5B,IAAKA,EAAe,IACxB,CACJ,CACJ,EAGJ,IAAK,MACD,MAAO,CAAE,KAAM,CAACC,CAAkB,CAAE,EAGxC,IAAK,cACL,IAAK,cACL,IAAK,aACL,IAAK,YACD,MAAO,CACH,WAAY,CACR,CACI,YAAaD,EAAe,YAC5B,GAAIb,EAAI,IAAI,QAAQ,UAAW,EAAE,EACjC,KAAMa,EAAe,KACrB,SAAUA,EAAe,SACzB,OAAQA,EAAe,MAC3B,CACJ,CACJ,EAGJ,IAAK,cACD,MAAO,CACH,YAAa,CACT,QAAS,CACL,CAACA,EAAe,KAAK,QAAQ,QAAS,KAAK,CAAC,EAAG,CAC3C,OAAQA,EAAe,MAC3B,CACJ,CACJ,CACJ,EAGJ,IAAK,cAAe,CAChB,GAAM,CAACE,EAAaC,CAAO,EAAIH,EAAe,KAAK,MAAM,GAAG,EAE5D,MAAO,CACH,YAAa,CACT,QAAS,CACL,CAACE,CAAqB,EAAG,CACrB,SAAU,CACN,CAACC,CAAiB,EAAG,CACjB,KAAM,yBAAyBH,EAAe,OAAO,EACzD,CACJ,CACJ,CACJ,CACJ,CACJ,CACJ,CAEA,IAAK,kBACD,MAAO,CAAE,YAAa,CAAE,YAAaC,CAAmB,CAAE,EAG9D,IAAK,eACD,MAAO,CAAE,YAAa,CAAE,SAAU,EAAK,CAAE,EAG7C,IAAK,WACD,MAAO,CACH,UAAW,CACP,CAACD,EAAe,IAAI,EAAG,CACnB,YAAaA,EAAe,WAChC,CACJ,CACJ,EAGJ,IAAK,WACD,MAAO,CACH,UAAW,CACP,CAACA,EAAe,IAAI,EAAG,CACnB,KAAM,0BAA0BA,EAAe,OAAO,EAC1D,CACJ,CACJ,EAGJ,IAAK,kBAAmB,CACpB,GAAM,CAACI,EAAQF,CAAW,EAAIF,EAAe,KAAK,MAAM,GAAG,EAE3D,MAAO,CACH,UAAW,CACP,CAACI,CAAgB,EAAG,CAChB,QAAS,CACL,CAACF,CAAqB,EAAG,CACrB,OAAQF,EAAe,MAC3B,CACJ,CACJ,CACJ,CACJ,CACJ,CAEA,IAAK,0BAA2B,CAC5B,GAAM,CAACI,EAAQC,CAAM,EAAIL,EAAe,KAAK,MAAM,GAAG,EAEtD,MAAO,CACH,UAAW,CACP,CAACI,CAAgB,EAAG,CAChB,QAAS,CACL,CAACC,CAAgB,EAAG,CAChB,KAAM,wBAAwBL,EAAe,OAAO,EACxD,CACJ,CACJ,CACJ,CACJ,CACJ,CAEA,IAAK,iBAAkB,CACnB,GAAM,CAACI,EAAQC,CAAM,EAAIL,EAAe,KAAK,MAAM,GAAG,EAEtD,MAAO,CACH,UAAW,CACP,CAACI,CAAgB,EAAG,CAChB,QAAS,CACL,CAACC,CAAgB,EAAG,CAChB,YAAaL,EAAe,YAC5B,OAAQA,EAAe,MAC3B,CACJ,CACJ,CACJ,CACJ,CACJ,CAEA,IAAK,kBAAmB,CACpB,GAAM,CAACI,EAAQF,EAAaC,CAAO,EAAIH,EAAe,KAAK,MAAM,GAAG,EAEpE,MAAO,CACH,UAAW,CACP,CAACI,CAAgB,EAAG,CAChB,QAAS,CACL,CAACF,CAAqB,EAAG,CACrB,SAAU,CACN,CAACC,CAAiB,EAAG,CACjB,KAAM,yBAAyBH,EAAe,OAAO,EACzD,CACJ,CACJ,CACJ,CACJ,CACJ,CACJ,CACJ,CAEA,IAAK,eAAgB,CACjB,GAAM,CAACI,EAAQE,CAAI,EAAIN,EAAe,KAAK,MAAM,GAAG,EAEpD,MAAO,CACH,UAAW,CACP,CAACI,CAAgB,EAAG,CAChB,MAAO,CACH,CAACE,CAAc,EAAG,CACd,KAAM,sBAAsBN,EAAe,OAAO,EACtD,CACJ,CACJ,CACJ,CACJ,CACJ,CAEA,IAAK,gBACD,MAAO,CACH,YAAa,CACT,KAAM,8BAA8BA,EAAe,OAAO,EAC9D,CACJ,EAGJ,IAAK,oBACD,MAAO,CACH,UAAW,CACP,CAACA,EAAe,IAAI,EAAG,CACnB,KAAM,0BAA0BA,EAAe,OAAO,EAC1D,CACJ,CACJ,EAGJ,IAAK,iBACD,MAAO,CACH,WAAY,CAAC,CAAE,KAAM,2BAA2BA,EAAe,OAAO,EAAG,CAAC,CAC9E,EAGJ,IAAK,WAAY,CACb,GAAM,CAACO,EAAUC,CAAS,EAAIR,EAAe,KAAK,MAAM,GAAG,EAEvDS,EAAkB,CAAC,EAEvB,OAAID,IACAC,EAAQ,CAACD,CAAS,GAGf,CACH,SAAU,CAAE,CAACD,CAAkB,EAAGE,CAAM,CAC5C,CACJ,CAEA,QACI,MAAO,CAAC,CAEhB,CACJ,CAAC,EAECC,EAAoB,CAACC,EAAsBZ,IAA8D,CAE3G,IAAMa,EAAe,wDAKrB,OAH2BpC,EAAcmC,EAAc,CAAE,QAAS,UAAW,CAAC,EAIzE,OAAQE,GAAYD,EAAa,KAAKC,EAAQ,YAAY,KAAK,CAAC,CAAC,EACjE,IAAKA,GAAY,CAId,IAAMC,EAAMD,EAAQ,KAAK,OAAS,EAE5BE,EAAStC,EAAU,CAAC,EAAG,GAAGoB,EAAcgB,EAAQ,KAAMd,CAAO,EAAGlB,CAAU,EAEhFC,EAAkBiC,CAAM,EAExB,GAAM,CAACC,EAAQC,CAAI,EAAcJ,EAAQ,YAAY,MAAM,GAAG,EAExDK,EAA2B,CAC7B,CAAED,EAAgB,KAAK,CAAC,EAAG,CACvB,CAAED,EAAkB,YAAY,EAAE,KAAK,CAAC,EAAG,CACvC,GAAGD,CACP,CACJ,CACJ,EAGMI,EAAO,KAAK,MAAM,KAAK,UAAU,CAAE,MAAOD,CAAY,CAAC,CAAC,EAE9D,MAAO,CACH,IAAAJ,EACA,KAAAK,CACJ,CACJ,CAAC,CACT,EAEOC,EAAQV,EEvZf,IAAMW,EAAWC,GAECA,EAAO,MAAM,aAAa,EAEjB,OAAQC,GAGvB,yBAAyB,KAAKA,CAAI,EAC3B,GAGJA,EAAK,KAAK,EAAE,OAAS,CAC/B,EAEe,OAGbC,EAAQH,ECjBf,OAAS,gBAAAI,MAAoB,KAC7B,OAAOR,MAAU,OAEjB,OAAOS,MAAU,OAKjB,IAAMC,EAAe,IAAI,IAAI,CAAC,UAAW,OAAQ,UAAW,WAAY,OAAQ,eAAgB,aAAc,OAAO,CAAC,EAEhHC,EAAN,cAAyB,KAAM,CAE/B,EAEMC,EAAY,CACdC,EACApB,EACAX,IACyC,CAEzC,IAAMgC,EAAcN,EAAaK,EAAM,CAAE,SAAU,MAAO,CAAC,EACrDE,EAAYf,EAAK,QAAQa,CAAI,EAEnC,GAAIE,IAAc,SAAWA,IAAc,OAAQ,CAC/C,IAAMb,EAAOO,EAAK,MAAMK,CAAW,EAC7BE,EAAc,OAAO,KAAKd,CAAI,EAAE,OAAQe,GAAQ,CAACP,EAAa,IAAIO,CAAG,CAAC,EAE5E,GAAID,EAAY,OAAS,EAAG,CACxB,IAAME,EAAQ,IAAIP,EAAW,oBAAoBK,EAAY,KAAK,IAAI,CAAC,EAAE,EAEzE,MAAAE,EAAM,SAAWL,EAEXK,CACV,CAEA,OAAI,OAAO,KAAKhB,CAAI,EAAE,KAAMe,GAAQP,EAAa,IAAIO,CAAG,CAAC,EAG9C,CAAC,CAAE,IAFEV,EAAQO,CAAW,EAEhB,KAAAZ,CAAK,CAAC,EAGlB,CAAC,CACZ,CAEA,GAAI,CACA,OAAOT,EAAkBqB,EAAahC,CAAO,CACjD,OAASoC,EAAY,CACjB,MAAAA,EAAM,SAAWL,EAEXK,CACV,CACJ,EAEOC,GAAQP,ECrDf,IAAMQ,EAAc,CAAIC,EAAMC,IAAe,CACzC,OAAO,KAAKA,CAAW,EAAE,QAASL,GAAQ,CAElCI,EAAEJ,CAAqB,IAAM,OAE7BI,EAAEJ,CAAqB,EAAI,CACvB,GAAGK,EAAEL,CAAqB,CAC9B,EAEA,OAAO,KAAKK,EAAEL,CAAqB,CAAW,EAAE,QAASM,GAAW,CAE/DF,EAAEJ,CAAqB,EAA6BM,CAAM,EAAI,CAC3D,GAAIF,EAAEJ,CAAqB,EAA6BM,CAAM,EAC9D,GAAID,EAAEL,CAAqB,EAA6BM,CAAM,CAClE,CACJ,CAAC,CAET,CAAC,CACL,EAEOC,EAAQJ,ECPf,IAAMK,EAAN,KAA2C,CAiBhC,YAAYC,EAAgC,CAC/C,KAAK,QAAUA,EAAe,QAC9B,KAAK,KAAOA,EAAe,KAC3B,KAAK,QAAUA,EAAe,QAC9B,KAAK,MAAQA,EAAe,OAAS,CAAC,EACtC,KAAK,WAAaA,EAAe,WACjC,KAAK,SAAWA,EAAe,SAC/B,KAAK,KAAOA,EAAe,KAC3B,KAAK,aAAeA,EAAe,YACvC,CAEO,QAAQC,EAAmC,CAC9CA,EAAW,QAASd,GAAS,CACzB,GAAM,CAAE,WAAAe,EAAY,MAAAC,EAAO,GAAGC,CAAK,EAAIjB,EAGvCW,EAAY,KAAM,CACd,WAAYI,GAAc,CAAC,EAC3B,MAAOC,GAAS,CAAC,CACrB,CAAkB,EAGlB,OAAO,QAAQC,CAAI,EAAE,QAAQ,CAAC,CAACb,EAAKc,CAAK,IAAM,CAE3C,KAAKd,CAA0B,EAAIc,CACvC,CAAC,CACL,CAAC,CACL,CACJ,EAEOC,GAAQP,EC3Df,OAAS,SAASlE,MAAqB,iBAEvC,OAAOC,MAAe,mBAEtB,OAAOiD,MAAU,OCHjB,OAAOjD,MAAe,mBASf,IAAMyE,EAAY,CAACC,EAAgBC,IAA4B3E,EAAU,CAAC,EAAG0E,EAAOC,EAAQ,CAACd,EAAGC,IAAOA,IAAM,KAAOD,EAAI,MAAU,EAO5He,EAAoBC,GAC7B,OAAO,KAAKA,CAAM,EAEb,IAAKpB,GAAQoB,EAAOpB,CAAG,CAAC,EACxB,MAAOqB,GAAc,OAAOA,GAAc,UAAY,OAAO,KAAKA,CAAS,EAAE,MAAOrB,GAAQ,EAAEA,KAAOqB,EAAU,CAAC,EAO5GC,EAAqB,CAACrE,EAAWW,IAA0BA,EAAK,KAAM2D,GAActE,EAAI,OAASsE,EAAU,IAAI,EAE/GC,EAA6BvE,GAAkC,CACxE,OAAQA,EAAI,IAAK,CACb,IAAK,UACD,MAAO,KAEX,IAAK,WACD,MAAO,KAEX,IAAK,UACD,MAAO,KAEX,QACI,MAAO,IAEf,CACJ,ECtCA,IAAMwE,EAAwB,CAACC,EAAoCC,EAAiCC,IAA2B,CAY3H,GARIA,IAAa,eAEbF,EAAcE,CAAQ,EAAID,EAAWC,CAAQ,GAM7CA,EAAS,WAAW,IAAI,EACxB,OAgBJ,GAbyB,CACrB,aACA,WACA,WACA,QACA,UACA,sBACA,YACA,aACA,cACA,UACJ,EAEqB,SAASA,CAAQ,EAClC,OAAO,KAAKD,EAAWC,CAAQ,CAAC,EAAE,QAASC,GAAe,CAEtDH,EAAcE,CAAQ,EAAEC,CAAU,EAAIb,EAAUU,EAAcE,CAAQ,EAAEC,CAAU,EAAGF,EAAWC,CAAQ,EAAEC,CAAU,CAAC,CACzH,CAAC,UACMD,IAAa,OAAQ,CAC5B,GAAM,CAAE,KAAAhE,CAAK,EAAI+D,EAEb,MAAM,QAAQ/D,CAAI,EAClBA,EAAK,QAASX,GAAQ,CACbqE,EAAmBrE,EAAKyE,EAAc,IAAO,GAC9CA,EAAc,KAAQ,KAAKzE,CAAG,CAEtC,CAAC,EACOqE,EAAmB1D,EAAM8D,EAAc,IAAO,GACtDA,EAAc,KAAQ,KAAK9D,CAAI,CAEvC,SAAWgE,IAAa,WAAY,CAChC,GAAM,CAAE,SAAAvD,CAAS,EAAIsD,EAGrBD,EAAc,SAAcrD,CAChC,MAAWuD,EAAS,WAAW,GAAG,IAG9BF,EAAc,MAASE,CAAQ,EAAIZ,EAAUU,EAAc,MAASE,CAAQ,EAAGD,EAAWC,CAAQ,CAAC,EAE3G,EAEOE,EAAQL,EFtDf,IAAMM,EAAwB,CAC1B,GAAI,CAAC,QAAS,cAAe,YAAa,aAAc,qBAAqB,EAC7E,GAAI,CAAC,QAAS,cAAe,YAAa,aAAc,sBAAuB,YAAY,EAC3F,GAAI,CAAC,aAAc,UAAU,CACjC,EAIMpE,EAAgB,CAACqE,EAAenE,IAClCmE,EAAM,IAAK/C,GAAe,CACtB,IAAKA,EAAK,MAAQ,WAAaA,EAAK,MAAQ,WAAaA,EAAK,MAAQ,aAAeA,EAAK,cAAgB,GAAI,CAC1G,IAAMgD,EAASzC,EAAK,cAAcP,EAAK,WAAW,EAElD,GAAIgD,EAAO,OAAO,OAAS,EAAG,CAC1BA,EAAO,OAAO,IAAwBhC,GAAU,CAC5C,IAAMiC,EAA8BjC,EAEpC,OAAAiC,EAAS,WAAajD,EAAK,YAEpBiD,CACX,CAAC,EAED,IAAIC,EAAc,uCAElB,MAAAA,GAAetE,EACRoE,EAAO,OAEH,IAAKhC,GAAU,GAAGA,EAAM,SAAS,CAAC;AAAA;AAAA;AAAA,IAAiCA,EAAM,YAAY,QAAQ,OAAQ;AAAA,GAAM,CAAC;AAAA,OAAU,EACtH,KAAK;AAAA,CAAI,EAEdgC,EAAO,OAAO,IAAKhC,GAAUA,EAAM,SAAS,CAAC,EAAE,KAAK;AAAA,CAAI,EAExD,IAAI,MAAMkC,CAAW,CAC/B,CAEA,IAAMC,EAAiBH,EAAO,OAAO,EAC/BI,EAAqC,CACvC,KAAM,CAAC,CACX,EAEA,OAAAN,EAAsBP,EAA0BvC,CAAI,CAAC,EAAE,QAAS2C,GAAa,CACzES,EAAcT,CAAQ,EAAIS,EAAcT,CAAQ,GAAK,CAAC,CAC1D,CAAC,EAED,OAAO,KAAKQ,CAAc,EAAE,QAASR,GAAa,CAC9CE,EAAsBO,EAAeD,EAAgBR,CAAQ,CACjE,CAAC,EAEMS,CACX,CAEA,MAAO,CAAC,CACZ,CAAC,EAEC7D,EAAoB,CAACC,EAAsBZ,IAClBvB,EAAcmC,EAAc,CAAE,QAAS,UAAW,CAAC,EAGpD,IAAKE,GAAY,CAIvC,IAAMC,EAAMD,EAAQ,KAAK,OAAS,EAC5BE,EAAStC,EAAU,CAAC,EAAG,GAAGoB,EAAcgB,EAAQ,KAAMd,CAAO,EAAGlB,CAAU,EAEhF,CAAC,cAAe,YAAa,aAAc,sBAAuB,aAAc,MAAM,EAAE,QAASiF,GAAa,CACtG/C,EAAO+C,CAAQ,IAAM,QAAaT,EAAiBtC,EAAO+C,CAAQ,CAAC,GAEnE,OAAO/C,EAAO+C,CAAQ,CAE9B,CAAC,EAGD,IAAM3C,EAAO,KAAK,MAAM,KAAK,UAAUJ,CAAM,CAAC,EAE9C,MAAO,CACH,IAAAD,EACA,KAAAK,CACJ,CACJ,CAAC,EAGEC,GAAQV,EG9Ff,OAAO8D,MAAmB,8BAI1B,IAAMC,EAAW,MAAOtD,GAAiD,CACrE,MAAMqD,EAAc,SAASrD,CAAgC,CACjE,EAEOuD,GAAQD","sourcesContent":["import type { Spec } from \"comment-parser\";\nimport { parse as parseComments } from \"comment-parser\";\n// eslint-disable-next-line no-restricted-imports\nimport mergeWith from \"lodash.mergewith\";\n\nimport type { OpenApiObject, PathsObject } from \"../exported.d\";\nimport customizer from \"../util/customizer\";\n\n// The security object has a bizare setup...\nconst fixSecurityObject = (thing: any) => {\n if (thing.security) {\n // eslint-disable-next-line no-param-reassign\n thing.security = Object.keys(thing.security).map((s) => {\n return {\n [s]: thing.security[s],\n };\n });\n }\n};\n\nconst primitiveTypes = new Set([\"integer\", \"number\", \"string\", \"boolean\", \"object\", \"array\"]);\n\nconst formatMap: Record<string, string> = {\n binary: \"string\",\n byte: \"string\",\n date: \"string\",\n \"date-time\": \"string\",\n double: \"number\",\n float: \"number\",\n int32: \"integer\",\n int64: \"integer\",\n password: \"string\",\n};\n\nconst parseDescription = (tag: Spec): { description: string | undefined; name: string; rawType: string; required: boolean; schema: object | undefined } => {\n const rawType = tag.type;\n const isArray = rawType.endsWith(\"[]\");\n // eslint-disable-next-line require-unicode-regexp,regexp/strict\n const parsedType = rawType.replace(/\\[]$/, \"\");\n\n const isPrimitive = primitiveTypes.has(parsedType);\n const isFormat = Object.keys(formatMap).includes(parsedType);\n\n let defaultValue;\n\n if (tag.default) {\n switch (parsedType) {\n case \"integer\":\n case \"int32\":\n case \"int64\": {\n defaultValue = Number.parseInt(tag.default, 10);\n break;\n }\n case \"number\":\n case \"double\":\n case \"float\": {\n defaultValue = Number.parseFloat(tag.default);\n break;\n }\n default: {\n defaultValue = tag.default;\n break;\n }\n }\n }\n\n let rootType;\n\n if (isPrimitive) {\n rootType = { default: defaultValue, type: parsedType };\n } else if (isFormat) {\n rootType = {\n default: defaultValue,\n format: parsedType,\n type: formatMap[parsedType],\n };\n } else {\n rootType = { $ref: `#/components/schemas/${parsedType}` };\n }\n\n let schema: object | undefined = isArray\n ? {\n items: {\n ...rootType,\n },\n type: \"array\",\n }\n : {\n ...rootType,\n };\n\n if (parsedType === \"\") {\n schema = undefined;\n }\n\n // remove the optional dash from the description.\n let description: string | undefined = tag.description.trim().replace(/^- /u, \"\");\n\n if (description === \"\") {\n description = undefined;\n }\n\n return {\n description,\n name: tag.name,\n rawType,\n required: !tag.optional,\n schema,\n };\n};\n\n// @ts-expect-error\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\nconst tagsToObjects = (tags: Spec[], verbose?: boolean) =>\n tags.map((tag) => {\n const parsedResponse = parseDescription(tag);\n\n // Some ops only have a `description`, merge `name` and `description`\n // for these.\n let nameAndDescription = \"\";\n\n if (parsedResponse.name) {\n nameAndDescription += parsedResponse.name;\n }\n\n if (parsedResponse.description) {\n nameAndDescription += ` ${parsedResponse.description.trim()}`;\n }\n\n switch (tag.tag) {\n case \"operationId\":\n case \"summary\":\n case \"description\": {\n return { [tag.tag]: nameAndDescription };\n }\n\n case \"deprecated\": {\n return { deprecated: true };\n }\n\n case \"externalDocs\": {\n return {\n externalDocs: {\n description: parsedResponse.description,\n url: parsedResponse.name,\n },\n };\n }\n\n case \"server\": {\n return {\n servers: [\n {\n description: parsedResponse.description,\n url: parsedResponse.name,\n },\n ],\n };\n }\n\n case \"tag\": {\n return { tags: [nameAndDescription] };\n }\n\n case \"cookieParam\":\n case \"headerParam\":\n case \"queryParam\":\n case \"pathParam\": {\n return {\n parameters: [\n {\n description: parsedResponse.description,\n in: tag.tag.replace(/Param$/u, \"\"),\n name: parsedResponse.name,\n required: parsedResponse.required,\n schema: parsedResponse.schema,\n },\n ],\n };\n }\n\n case \"bodyContent\": {\n return {\n requestBody: {\n content: {\n [parsedResponse.name.replace(\"*\\\\/*\", \"*/*\")]: {\n schema: parsedResponse.schema,\n },\n },\n },\n };\n }\n\n case \"bodyExample\": {\n const [contentType, example] = parsedResponse.name.split(\".\");\n\n return {\n requestBody: {\n content: {\n [contentType as string]: {\n examples: {\n [example as string]: {\n $ref: `#/components/examples/${parsedResponse.rawType}`,\n },\n },\n },\n },\n },\n };\n }\n\n case \"bodyDescription\": {\n return { requestBody: { description: nameAndDescription } };\n }\n\n case \"bodyRequired\": {\n return { requestBody: { required: true } };\n }\n\n case \"response\": {\n return {\n responses: {\n [parsedResponse.name]: {\n description: parsedResponse.description,\n },\n },\n };\n }\n\n case \"callback\": {\n return {\n callbacks: {\n [parsedResponse.name]: {\n $ref: `#/components/callbacks/${parsedResponse.rawType}`,\n },\n },\n };\n }\n\n case \"responseContent\": {\n const [status, contentType] = parsedResponse.name.split(\".\");\n\n return {\n responses: {\n [status as string]: {\n content: {\n [contentType as string]: {\n schema: parsedResponse.schema,\n },\n },\n },\n },\n };\n }\n\n case \"responseHeaderComponent\": {\n const [status, header] = parsedResponse.name.split(\".\");\n\n return {\n responses: {\n [status as string]: {\n headers: {\n [header as string]: {\n $ref: `#/components/headers/${parsedResponse.rawType}`,\n },\n },\n },\n },\n };\n }\n\n case \"responseHeader\": {\n const [status, header] = parsedResponse.name.split(\".\");\n\n return {\n responses: {\n [status as string]: {\n headers: {\n [header as string]: {\n description: parsedResponse.description,\n schema: parsedResponse.schema,\n },\n },\n },\n },\n };\n }\n\n case \"responseExample\": {\n const [status, contentType, example] = parsedResponse.name.split(\".\");\n\n return {\n responses: {\n [status as string]: {\n content: {\n [contentType as string]: {\n examples: {\n [example as string]: {\n $ref: `#/components/examples/${parsedResponse.rawType}`,\n },\n },\n },\n },\n },\n },\n };\n }\n\n case \"responseLink\": {\n const [status, link] = parsedResponse.name.split(\".\");\n\n return {\n responses: {\n [status as string]: {\n links: {\n [link as string]: {\n $ref: `#/components/links/${parsedResponse.rawType}`,\n },\n },\n },\n },\n };\n }\n\n case \"bodyComponent\": {\n return {\n requestBody: {\n $ref: `#/components/requestBodies/${parsedResponse.rawType}`,\n },\n };\n }\n\n case \"responseComponent\": {\n return {\n responses: {\n [parsedResponse.name]: {\n $ref: `#/components/responses/${parsedResponse.rawType}`,\n },\n },\n };\n }\n\n case \"paramComponent\": {\n return {\n parameters: [{ $ref: `#/components/parameters/${parsedResponse.rawType}` }],\n };\n }\n\n case \"security\": {\n const [security, scopeItem] = parsedResponse.name.split(\".\");\n\n let scope: string[] = [];\n\n if (scopeItem) {\n scope = [scopeItem];\n }\n\n return {\n security: { [security as string]: scope },\n };\n }\n\n default: {\n return {};\n }\n }\n });\n\nconst commentsToOpenApi = (fileContents: string, verbose?: boolean): { loc: number; spec: OpenApiObject }[] => {\n // eslint-disable-next-line regexp/no-unused-capturing-group,require-unicode-regexp\n const openAPIRegex = /^(GET|PUT|POST|DELETE|OPTIONS|HEAD|PATCH|TRACE) \\/.*$/;\n\n const jsDocumentComments = parseComments(fileContents, { spacing: \"preserve\" });\n\n // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n return jsDocumentComments\n .filter((comment) => openAPIRegex.test(comment.description.trim()))\n .map((comment) => {\n // Line count, number of tags + 1 for description.\n // - Don't count line-breaking due to long descriptions\n // - Don't count empty lines\n const loc = comment.tags.length + 1;\n\n const result = mergeWith({}, ...tagsToObjects(comment.tags, verbose), customizer);\n\n fixSecurityObject(result);\n\n const [method, path]: string[] = comment.description.split(\" \");\n\n const pathsObject: PathsObject = {\n [(path as string).trim()]: {\n [(method as string).toLowerCase().trim()]: {\n ...result,\n },\n },\n };\n\n // Purge all undefined objects/arrays.\n const spec = JSON.parse(JSON.stringify({ paths: pathsObject }));\n\n return {\n loc,\n spec,\n };\n });\n};\n\nexport default commentsToOpenApi;\n","const customizer = (objectValue: unknown, sourceValue: unknown[]): unknown[] | undefined => {\n if (Array.isArray(objectValue)) {\n return [...objectValue, ...sourceValue] as unknown[];\n }\n\n return undefined;\n};\n\nexport default customizer;\n","const yamlLoc = (string: string): number => {\n // Break string into lines.\n const split = string.split(/\\r\\n|\\r|\\n/u);\n\n const filtered = split.filter((line) => {\n // Remove comments.\n // eslint-disable-next-line security/detect-unsafe-regex,regexp/no-unused-capturing-group\n if (/^\\s*(#\\s*(?:\\S.*)?)?$/u.test(line)) {\n return false;\n }\n // Remove empty lines.\n return line.trim().length > 0;\n });\n\n return filtered.length;\n};\n\nexport default yamlLoc;\n","import { readFileSync } from \"node:fs\";\nimport path from \"node:path\";\n\nimport yaml from \"yaml\";\n\nimport type { OpenApiObject } from \"./exported.d\";\nimport yamlLoc from \"./util/yaml-loc\";\n\nconst ALLOWED_KEYS = new Set([\"openapi\", \"info\", \"servers\", \"security\", \"tags\", \"externalDocs\", \"components\", \"paths\"]);\n\nclass ParseError extends Error {\n public filePath?: string;\n}\n\nconst parseFile = (\n file: string,\n commentsToOpenApi: (fileContent: string, verbose?: boolean) => { loc: number; spec: OpenApiObject }[],\n verbose?: boolean,\n): { loc: number; spec: OpenApiObject }[] => {\n // eslint-disable-next-line security/detect-non-literal-fs-filename\n const fileContent = readFileSync(file, { encoding: \"utf8\" });\n const extension = path.extname(file);\n\n if (extension === \".yaml\" || extension === \".yml\") {\n const spec = yaml.parse(fileContent);\n const invalidKeys = Object.keys(spec).filter((key) => !ALLOWED_KEYS.has(key));\n\n if (invalidKeys.length > 0) {\n const error = new ParseError(`Unexpected keys: ${invalidKeys.join(\", \")}`);\n\n error.filePath = file;\n\n throw error;\n }\n\n if (Object.keys(spec).some((key) => ALLOWED_KEYS.has(key))) {\n const loc = yamlLoc(fileContent);\n\n return [{ loc, spec }];\n }\n\n return [];\n }\n\n try {\n return commentsToOpenApi(fileContent, verbose);\n } catch (error: any) {\n error.filePath = file;\n\n throw error;\n }\n};\n\nexport default parseFile;\n","const objectMerge = <T>(a: T, b: T): void => {\n Object.keys(b as object).forEach((key) => {\n // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n if (a[key as keyof typeof b] === undefined) {\n // eslint-disable-next-line no-param-reassign\n a[key as keyof typeof b] = {\n ...b[key as keyof typeof b],\n };\n } else {\n Object.keys(b[key as keyof typeof b] as object).forEach((subKey) => {\n // eslint-disable-next-line no-param-reassign\n (a[key as keyof typeof b] as Record<string, object>)[subKey] = {\n ...(a[key as keyof typeof b] as Record<string, object>)[subKey],\n ...(b[key as keyof typeof b] as Record<string, object>)[subKey],\n };\n });\n }\n });\n};\n\nexport default objectMerge;\n","import type {\n BaseDefinition,\n ComponentsObject,\n ExternalDocumentationObject,\n InfoObject,\n OpenApiObject,\n PathsObject,\n SecurityRequirementObject,\n ServerObject,\n TagObject,\n} from \"./exported.d\";\nimport objectMerge from \"./util/object-merge\";\n\nclass SpecBuilder implements OpenApiObject {\n public components?: ComponentsObject;\n\n public externalDocs?: ExternalDocumentationObject;\n\n public info: InfoObject;\n\n public openapi: string;\n\n public paths: PathsObject;\n\n public security?: SecurityRequirementObject[];\n\n public servers?: ServerObject[];\n\n public tags?: TagObject[];\n\n public constructor(baseDefinition: BaseDefinition) {\n this.openapi = baseDefinition.openapi;\n this.info = baseDefinition.info;\n this.servers = baseDefinition.servers;\n this.paths = baseDefinition.paths ?? {};\n this.components = baseDefinition.components;\n this.security = baseDefinition.security;\n this.tags = baseDefinition.tags;\n this.externalDocs = baseDefinition.externalDocs;\n }\n\n public addData(parsedFile: OpenApiObject[]): void {\n parsedFile.forEach((file) => {\n const { components, paths, ...rest } = file;\n\n // only merge paths and components\n objectMerge(this, {\n components: components ?? {},\n paths: paths ?? {},\n } as OpenApiObject);\n\n // overwrite everything else:\n Object.entries(rest).forEach(([key, value]) => {\n // @ts-expect-error\n this[key as keyof OpenApiObject] = value;\n });\n });\n }\n}\n\nexport default SpecBuilder;\n","import type { Spec } from \"comment-parser\";\nimport { parse as parseComments } from \"comment-parser\";\n// eslint-disable-next-line no-restricted-imports\nimport mergeWith from \"lodash.mergewith\";\nimport type { YAMLError } from \"yaml\";\nimport yaml from \"yaml\";\n\nimport type { OpenApiObject } from \"../exported.d\";\nimport customizer from \"../util/customizer\";\nimport organizeSwaggerObject from \"./organize-swagger-object\";\nimport { getSwaggerVersionFromSpec, hasEmptyProperty } from \"./utils\";\n\nconst specificationTemplate = {\n v2: [\"paths\", \"definitions\", \"responses\", \"parameters\", \"securityDefinitions\"],\n v3: [\"paths\", \"definitions\", \"responses\", \"parameters\", \"securityDefinitions\", \"components\"],\n v4: [\"components\", \"channels\"],\n};\n\ntype ExtendedYAMLError = YAMLError & { annotation?: string };\n\nconst tagsToObjects = (specs: Spec[], verbose?: boolean) =>\n specs.map((spec: Spec) => {\n if ((spec.tag === \"openapi\" || spec.tag === \"swagger\" || spec.tag === \"asyncapi\") && spec.description !== \"\") {\n const parsed = yaml.parseDocument(spec.description);\n\n if (parsed.errors.length > 0) {\n parsed.errors.map<ExtendedYAMLError>((error) => {\n const newError: ExtendedYAMLError = error;\n\n newError.annotation = spec.description;\n\n return newError;\n });\n\n let errorString = \"Error parsing YAML in @openapi spec:\";\n\n errorString += verbose\n ? (parsed.errors as ExtendedYAMLError[])\n // eslint-disable-next-line @typescript-eslint/no-base-to-string\n .map((error) => `${error.toString()}\\nImbedded within:\\n\\`\\`\\`\\n ${error.annotation?.replace(/\\n/gu, \"\\n \")}\\n\\`\\`\\``)\n .join(\"\\n\")\n : // eslint-disable-next-line @typescript-eslint/no-base-to-string\n parsed.errors.map((error) => error.toString()).join(\"\\n\");\n\n throw new Error(errorString);\n }\n\n const parsedDocument = parsed.toJSON();\n const specification: Record<string, any> = {\n tags: [],\n };\n\n specificationTemplate[getSwaggerVersionFromSpec(spec)].forEach((property) => {\n specification[property] = specification[property] || {};\n });\n\n Object.keys(parsedDocument).forEach((property) => {\n organizeSwaggerObject(specification, parsedDocument, property);\n });\n\n return specification;\n }\n\n return {};\n });\n\nconst commentsToOpenApi = (fileContents: string, verbose?: boolean): { loc: number; spec: OpenApiObject }[] => {\n const jsDocumentComments = parseComments(fileContents, { spacing: \"preserve\" });\n\n // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n return jsDocumentComments.map((comment) => {\n // Line count, number of tags + 1 for description.\n // - Don't count line-breaking due to long descriptions\n // - Don't count empty lines\n const loc = comment.tags.length + 1;\n const result = mergeWith({}, ...tagsToObjects(comment.tags, verbose), customizer);\n\n [\"definitions\", \"responses\", \"parameters\", \"securityDefinitions\", \"components\", \"tags\"].forEach((property) => {\n if (result[property] !== undefined && hasEmptyProperty(result[property])) {\n // eslint-disable-next-line @typescript-eslint/no-dynamic-delete\n delete result[property];\n }\n });\n\n // Purge all undefined objects/arrays.\n const spec = JSON.parse(JSON.stringify(result));\n\n return {\n loc,\n spec,\n };\n });\n};\n\nexport default commentsToOpenApi;\n","import type { Spec } from \"comment-parser\";\n// eslint-disable-next-line no-restricted-imports\nimport mergeWith from \"lodash.mergewith\";\n\n/**\n * A recursive deep-merge that ignores null values when merging.\n * This returns the merged object and does not mutate.\n * @param {object} first the first object to get merged\n * @param {object} second the second object to get merged\n */\n// eslint-disable-next-line @typescript-eslint/no-unsafe-return\nexport const mergeDeep = (first?: object, second?: object): object => mergeWith({}, first, second, (a, b) => (b === null ? a : undefined));\n\n/**\n * Checks if there is any properties of the input object which are an empty object\n * @param {object} object - the object to check\n * @returns boolean\n */\nexport const hasEmptyProperty = (object: Record<string, any>): boolean =>\n Object.keys(object)\n // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n .map((key) => object[key])\n .every((keyObject) => typeof keyObject === \"object\" && Object.keys(keyObject).every((key) => !(key in keyObject)));\n\n/**\n * @param {object} tag\n * @param {array} tags\n * @returns boolean\n */\nexport const isTagPresentInTags = (tag: Spec, tags: Spec[]): boolean => tags.some((targetTag) => tag.name === targetTag.name);\n\nexport const getSwaggerVersionFromSpec = (tag: Spec): \"v2\" | \"v3\" | \"v4\" => {\n switch (tag.tag) {\n case \"openapi\": {\n return \"v3\";\n }\n case \"asyncapi\": {\n return \"v4\";\n }\n case \"swagger\": {\n return \"v2\";\n }\n default: {\n return \"v2\";\n }\n }\n};\n","import { isTagPresentInTags, mergeDeep } from \"./utils\";\n\n/**\n * @param {object} swaggerObject\n * @param {object} annotation\n * @param {string} property\n */\n\nconst organizeSwaggerObject = (swaggerObject: Record<string, any>, annotation: Record<string, any>, property: string): void => {\n // Root property on purpose.\n // eslint-disable-next-line no-secrets/no-secrets\n // @see https://github.com/OAI/OpenAPI-Specification/blob/master/proposals/002_Webhooks.md#proposed-solution\n if (property === \"x-webhooks\") {\n // eslint-disable-next-line no-param-reassign\n swaggerObject[property] = annotation[property];\n }\n\n // Other extensions can be in varying places depending on different vendors and opinions.\n // The following return makes it so that they are not put in `paths` in the last case.\n // New specific extensions will need to be handled on case-by-case if to be included in `paths`.\n if (property.startsWith(\"x-\")) {\n return;\n }\n\n const commonProperties = [\n \"components\",\n \"consumes\",\n \"produces\",\n \"paths\",\n \"schemas\",\n \"securityDefinitions\",\n \"responses\",\n \"parameters\",\n \"definitions\",\n \"channels\",\n ];\n\n if (commonProperties.includes(property)) {\n Object.keys(annotation[property]).forEach((definition) => {\n // eslint-disable-next-line no-param-reassign\n swaggerObject[property][definition] = mergeDeep(swaggerObject[property][definition], annotation[property][definition]);\n });\n } else if (property === \"tags\") {\n const { tags } = annotation;\n\n if (Array.isArray(tags)) {\n tags.forEach((tag) => {\n if (!isTagPresentInTags(tag, swaggerObject[\"tags\"])) {\n swaggerObject[\"tags\"].push(tag);\n }\n });\n } else if (!isTagPresentInTags(tags, swaggerObject[\"tags\"])) {\n swaggerObject[\"tags\"].push(tags);\n }\n } else if (property === \"security\") {\n const { security } = annotation;\n\n // eslint-disable-next-line no-param-reassign\n swaggerObject[\"security\"] = security;\n } else if (property.startsWith(\"/\")) {\n // Paths which are not defined as \"paths\" property, starting with a slash \"/\"\n // eslint-disable-next-line no-param-reassign\n swaggerObject[\"paths\"][property] = mergeDeep(swaggerObject[\"paths\"][property], annotation[property]);\n }\n};\n\nexport default organizeSwaggerObject;\n","import SwaggerParser from \"@apidevtools/swagger-parser\";\n// eslint-disable-next-line import/no-named-as-default\nimport type OpenAPI from \"openapi-types\";\n\nconst validate = async (spec: Record<string, unknown>): Promise<void> => {\n await SwaggerParser.validate(spec as OpenAPI.OpenAPI.Document);\n};\n\nexport default validate;\n"]}
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/jsdoc/comments-to-open-api.ts","../src/util/customizer.ts","../src/util/yaml-loc.ts","../src/parse-file.ts","../src/util/object-merge.ts","../src/spec-builder.ts","../src/swagger-jsdoc/comments-to-open-api.ts","../src/swagger-jsdoc/utils.ts","../src/swagger-jsdoc/organize-swagger-object.ts","../src/validate.ts"],"names":["parseComments","mergeWith","customizer","objectValue","sourceValue","customizer_default","fixSecurityObject","thing","primitiveTypes","formatMap","parseDescription","tag","rawType","isArray","parsedType","isPrimitive","isFormat","defaultValue","rootType","schema","description","tagsToObjects","tags","verbose","parsedResponse","nameAndDescription","contentType","example","status","header","link","security","scopeItem","scope","commentsToOpenApi","fileContents","openAPIRegex","comment","loc","result","method","path","pathsObject","spec","comments_to_open_api_default","yamlLoc","string","line","yaml_loc_default","readFileSync","yaml","ALLOWED_KEYS","ParseError","parseFile","file","fileContent","extension","invalidKeys","key","error","parse_file_default","objectMerge","a","b","subKey","object_merge_default","SpecBuilder","baseDefinition","parsedFile","components","paths","rest","value","spec_builder_default","mergeDeep","first","second","hasEmptyProperty","object","keyObject","isTagPresentInTags","targetTag","getSwaggerVersionFromSpec","organizeSwaggerObject","swaggerObject","annotation","property","definition","organize_swagger_object_default","specificationTemplate","specs","parsed","newError","errorString","parsedDocument","specification","SwaggerParser","validate","validate_default"],"mappings":"AACA,OAAS,SAASA,MAAqB,iBAEvC,OAAOC,MAAe,mBCHtB,IAAMC,EAAa,CAACC,EAAsBC,IAAkD,CACxF,GAAI,MAAM,QAAQD,CAAW,EACzB,MAAO,CAAC,GAAGA,EAAa,GAAGC,CAAW,CAI9C,EAEOC,EAAQH,EDCf,IAAMI,EAAqBC,GAAe,CAClCA,EAAM,WAENA,EAAM,SAAW,OAAO,KAAKA,EAAM,QAAQ,EAAE,IAAK,IACvC,CACH,CAAC,CAAC,EAAGA,EAAM,SAAS,CAAC,CACzB,EACH,EAET,EAEMC,EAAiB,IAAI,IAAI,CAAC,UAAW,SAAU,SAAU,UAAW,SAAU,OAAO,CAAC,EAEtFC,EAAoC,CACtC,OAAQ,SACR,KAAM,SACN,KAAM,SACN,YAAa,SACb,OAAQ,SACR,MAAO,SACP,MAAO,UACP,MAAO,UACP,SAAU,QACd,EAEMC,EAAoBC,GAAiI,CACvJ,IAAMC,EAAUD,EAAI,KACdE,EAAUD,EAAQ,SAAS,IAAI,EAE/BE,EAAaF,EAAQ,QAAQ,OAAQ,EAAE,EAEvCG,EAAcP,EAAe,IAAIM,CAAU,EAC3CE,EAAW,OAAO,KAAKP,CAAS,EAAE,SAASK,CAAU,EAEvDG,EAEJ,GAAIN,EAAI,QACJ,OAAQG,EAAY,CAChB,IAAK,UACL,IAAK,QACL,IAAK,QAAS,CACVG,EAAe,OAAO,SAASN,EAAI,QAAS,EAAE,EAC9C,KACJ,CACA,IAAK,SACL,IAAK,SACL,IAAK,QAAS,CACVM,EAAe,OAAO,WAAWN,EAAI,OAAO,EAC5C,KACJ,CACA,QAAS,CACLM,EAAeN,EAAI,QACnB,KACJ,CACJ,CAGJ,IAAIO,EAEAH,EACAG,EAAW,CAAE,QAASD,EAAc,KAAMH,CAAW,EAC9CE,EACPE,EAAW,CACP,QAASD,EACT,OAAQH,EACR,KAAML,EAAUK,CAAU,CAC9B,EAEAI,EAAW,CAAE,KAAM,wBAAwBJ,CAAU,EAAG,EAG5D,IAAIK,EAA6BN,EAC3B,CACI,MAAO,CACH,GAAGK,CACP,EACA,KAAM,OACV,EACA,CACI,GAAGA,CACP,EAEFJ,IAAe,KACfK,EAAS,QAIb,IAAIC,EAAkCT,EAAI,YAAY,KAAK,EAAE,QAAQ,OAAQ,EAAE,EAE/E,OAAIS,IAAgB,KAChBA,EAAc,QAGX,CACH,YAAAA,EACA,KAAMT,EAAI,KACV,QAAAC,EACA,SAAU,CAACD,EAAI,SACf,OAAAQ,CACJ,CACJ,EAIME,EAAgB,CAACC,EAAcC,IACjCD,EAAK,IAAKX,GAAQ,CACd,IAAMa,EAAiBd,EAAiBC,CAAG,EAIvCc,EAAqB,GAUzB,OARID,EAAe,OACfC,GAAsBD,EAAe,MAGrCA,EAAe,cACfC,GAAsB,IAAID,EAAe,YAAY,KAAK,CAAC,IAGvDb,EAAI,IAAK,CACb,IAAK,cACL,IAAK,UACL,IAAK,cACD,MAAO,CAAE,CAACA,EAAI,GAAG,EAAGc,CAAmB,EAG3C,IAAK,aACD,MAAO,CAAE,WAAY,EAAK,EAG9B,IAAK,eACD,MAAO,CACH,aAAc,CACV,YAAaD,EAAe,YAC5B,IAAKA,EAAe,IACxB,CACJ,EAGJ,IAAK,SACD,MAAO,CACH,QAAS,CACL,CACI,YAAaA,EAAe,YAC5B,IAAKA,EAAe,IACxB,CACJ,CACJ,EAGJ,IAAK,MACD,MAAO,CAAE,KAAM,CAACC,CAAkB,CAAE,EAGxC,IAAK,cACL,IAAK,cACL,IAAK,aACL,IAAK,YACD,MAAO,CACH,WAAY,CACR,CACI,YAAaD,EAAe,YAC5B,GAAIb,EAAI,IAAI,QAAQ,UAAW,EAAE,EACjC,KAAMa,EAAe,KACrB,SAAUA,EAAe,SACzB,OAAQA,EAAe,MAC3B,CACJ,CACJ,EAGJ,IAAK,cACD,MAAO,CACH,YAAa,CACT,QAAS,CACL,CAACA,EAAe,KAAK,QAAQ,QAAS,KAAK,CAAC,EAAG,CAC3C,OAAQA,EAAe,MAC3B,CACJ,CACJ,CACJ,EAGJ,IAAK,cAAe,CAChB,GAAM,CAACE,EAAaC,CAAO,EAAIH,EAAe,KAAK,MAAM,GAAG,EAE5D,MAAO,CACH,YAAa,CACT,QAAS,CACL,CAACE,CAAqB,EAAG,CACrB,SAAU,CACN,CAACC,CAAiB,EAAG,CACjB,KAAM,yBAAyBH,EAAe,OAAO,EACzD,CACJ,CACJ,CACJ,CACJ,CACJ,CACJ,CAEA,IAAK,kBACD,MAAO,CAAE,YAAa,CAAE,YAAaC,CAAmB,CAAE,EAG9D,IAAK,eACD,MAAO,CAAE,YAAa,CAAE,SAAU,EAAK,CAAE,EAG7C,IAAK,WACD,MAAO,CACH,UAAW,CACP,CAACD,EAAe,IAAI,EAAG,CACnB,YAAaA,EAAe,WAChC,CACJ,CACJ,EAGJ,IAAK,WACD,MAAO,CACH,UAAW,CACP,CAACA,EAAe,IAAI,EAAG,CACnB,KAAM,0BAA0BA,EAAe,OAAO,EAC1D,CACJ,CACJ,EAGJ,IAAK,kBAAmB,CACpB,GAAM,CAACI,EAAQF,CAAW,EAAIF,EAAe,KAAK,MAAM,GAAG,EAE3D,MAAO,CACH,UAAW,CACP,CAACI,CAAgB,EAAG,CAChB,QAAS,CACL,CAACF,CAAqB,EAAG,CACrB,OAAQF,EAAe,MAC3B,CACJ,CACJ,CACJ,CACJ,CACJ,CAEA,IAAK,0BAA2B,CAC5B,GAAM,CAACI,EAAQC,CAAM,EAAIL,EAAe,KAAK,MAAM,GAAG,EAEtD,MAAO,CACH,UAAW,CACP,CAACI,CAAgB,EAAG,CAChB,QAAS,CACL,CAACC,CAAgB,EAAG,CAChB,KAAM,wBAAwBL,EAAe,OAAO,EACxD,CACJ,CACJ,CACJ,CACJ,CACJ,CAEA,IAAK,iBAAkB,CACnB,GAAM,CAACI,EAAQC,CAAM,EAAIL,EAAe,KAAK,MAAM,GAAG,EAEtD,MAAO,CACH,UAAW,CACP,CAACI,CAAgB,EAAG,CAChB,QAAS,CACL,CAACC,CAAgB,EAAG,CAChB,YAAaL,EAAe,YAC5B,OAAQA,EAAe,MAC3B,CACJ,CACJ,CACJ,CACJ,CACJ,CAEA,IAAK,kBAAmB,CACpB,GAAM,CAACI,EAAQF,EAAaC,CAAO,EAAIH,EAAe,KAAK,MAAM,GAAG,EAEpE,MAAO,CACH,UAAW,CACP,CAACI,CAAgB,EAAG,CAChB,QAAS,CACL,CAACF,CAAqB,EAAG,CACrB,SAAU,CACN,CAACC,CAAiB,EAAG,CACjB,KAAM,yBAAyBH,EAAe,OAAO,EACzD,CACJ,CACJ,CACJ,CACJ,CACJ,CACJ,CACJ,CAEA,IAAK,eAAgB,CACjB,GAAM,CAACI,EAAQE,CAAI,EAAIN,EAAe,KAAK,MAAM,GAAG,EAEpD,MAAO,CACH,UAAW,CACP,CAACI,CAAgB,EAAG,CAChB,MAAO,CACH,CAACE,CAAc,EAAG,CACd,KAAM,sBAAsBN,EAAe,OAAO,EACtD,CACJ,CACJ,CACJ,CACJ,CACJ,CAEA,IAAK,gBACD,MAAO,CACH,YAAa,CACT,KAAM,8BAA8BA,EAAe,OAAO,EAC9D,CACJ,EAGJ,IAAK,oBACD,MAAO,CACH,UAAW,CACP,CAACA,EAAe,IAAI,EAAG,CACnB,KAAM,0BAA0BA,EAAe,OAAO,EAC1D,CACJ,CACJ,EAGJ,IAAK,iBACD,MAAO,CACH,WAAY,CAAC,CAAE,KAAM,2BAA2BA,EAAe,OAAO,EAAG,CAAC,CAC9E,EAGJ,IAAK,WAAY,CACb,GAAM,CAACO,EAAUC,CAAS,EAAIR,EAAe,KAAK,MAAM,GAAG,EAEvDS,EAAkB,CAAC,EAEvB,OAAID,IACAC,EAAQ,CAACD,CAAS,GAGf,CACH,SAAU,CAAE,CAACD,CAAkB,EAAGE,CAAM,CAC5C,CACJ,CAEA,QACI,MAAO,CAAC,CAEhB,CACJ,CAAC,EAECC,EAAoB,CAACC,EAAsBZ,IAA8D,CAE3G,IAAMa,EAAe,wDAKrB,OAH2BpC,EAAcmC,EAAc,CAAE,QAAS,UAAW,CAAC,EAIzE,OAAQE,GAAYD,EAAa,KAAKC,EAAQ,YAAY,KAAK,CAAC,CAAC,EACjE,IAAKA,GAAY,CAId,IAAMC,EAAMD,EAAQ,KAAK,OAAS,EAE5BE,EAAStC,EAAU,CAAC,EAAG,GAAGoB,EAAcgB,EAAQ,KAAMd,CAAO,EAAGlB,CAAU,EAEhFC,EAAkBiC,CAAM,EAExB,GAAM,CAACC,EAAQC,CAAI,EAAcJ,EAAQ,YAAY,MAAM,GAAG,EAExDK,EAA2B,CAC7B,CAAED,EAAgB,KAAK,CAAC,EAAG,CACvB,CAAED,EAAkB,YAAY,EAAE,KAAK,CAAC,EAAG,CACvC,GAAGD,CACP,CACJ,CACJ,EAGMI,EAAO,KAAK,MAAM,KAAK,UAAU,CAAE,MAAOD,CAAY,CAAC,CAAC,EAE9D,MAAO,CACH,IAAAJ,EACA,KAAAK,CACJ,CACJ,CAAC,CACT,EAEOC,GAAQV,EEvZf,IAAMW,EAAWC,GAECA,EAAO,MAAM,aAAa,EAEjB,OAAQC,GAGvB,yBAAyB,KAAKA,CAAI,EAC3B,GAGJA,EAAK,KAAK,EAAE,OAAS,CAC/B,EAEe,OAGbC,EAAQH,ECjBf,OAAS,gBAAAI,MAAoB,KAC7B,OAAOR,MAAU,OAEjB,OAAOS,MAAU,OAKjB,IAAMC,EAAe,IAAI,IAAI,CAAC,UAAW,OAAQ,UAAW,WAAY,OAAQ,eAAgB,aAAc,OAAO,CAAC,EAEhHC,EAAN,cAAyB,KAAM,CAE/B,EAEMC,EAAY,CACdC,EACApB,EACAX,IACyC,CAEzC,IAAMgC,EAAcN,EAAaK,EAAM,CAAE,SAAU,MAAO,CAAC,EACrDE,EAAYf,EAAK,QAAQa,CAAI,EAEnC,GAAIE,IAAc,SAAWA,IAAc,OAAQ,CAC/C,IAAMb,EAAOO,EAAK,MAAMK,CAAW,EAC7BE,EAAc,OAAO,KAAKd,CAAI,EAAE,OAAQe,GAAQ,CAACP,EAAa,IAAIO,CAAG,CAAC,EAE5E,GAAID,EAAY,OAAS,EAAG,CACxB,IAAME,EAAQ,IAAIP,EAAW,oBAAoBK,EAAY,KAAK,IAAI,CAAC,EAAE,EAEzE,MAAAE,EAAM,SAAWL,EAEXK,CACV,CAEA,OAAI,OAAO,KAAKhB,CAAI,EAAE,KAAMe,GAAQP,EAAa,IAAIO,CAAG,CAAC,EAG9C,CAAC,CAAE,IAFEV,EAAQO,CAAW,EAEhB,KAAAZ,CAAK,CAAC,EAGlB,CAAC,CACZ,CAEA,GAAI,CACA,OAAOT,EAAkBqB,EAAahC,CAAO,CACjD,OAASoC,EAAY,CACjB,MAAAA,EAAM,SAAWL,EAEXK,CACV,CACJ,EAEOC,GAAQP,ECrDf,IAAMQ,EAAc,CAAIC,EAAMC,IAAe,CACzC,OAAO,KAAKA,CAAW,EAAE,QAASL,GAAQ,CAElCI,EAAEJ,CAAqB,IAAM,OAE7BI,EAAEJ,CAAqB,EAAI,CACvB,GAAGK,EAAEL,CAAqB,CAC9B,EAEA,OAAO,KAAKK,EAAEL,CAAqB,CAAW,EAAE,QAASM,GAAW,CAE/DF,EAAEJ,CAAqB,EAA6BM,CAAM,EAAI,CAC3D,GAAIF,EAAEJ,CAAqB,EAA6BM,CAAM,EAC9D,GAAID,EAAEL,CAAqB,EAA6BM,CAAM,CAClE,CACJ,CAAC,CAET,CAAC,CACL,EAEOC,EAAQJ,ECPf,IAAMK,EAAN,KAA2C,CAiBhC,YAAYC,EAAgC,CAC/C,KAAK,QAAUA,EAAe,QAC9B,KAAK,KAAOA,EAAe,KAC3B,KAAK,QAAUA,EAAe,QAC9B,KAAK,MAAQA,EAAe,OAAS,CAAC,EACtC,KAAK,WAAaA,EAAe,WACjC,KAAK,SAAWA,EAAe,SAC/B,KAAK,KAAOA,EAAe,KAC3B,KAAK,aAAeA,EAAe,YACvC,CAEO,QAAQC,EAAmC,CAC9CA,EAAW,QAASd,GAAS,CACzB,GAAM,CAAE,WAAAe,EAAY,MAAAC,EAAO,GAAGC,CAAK,EAAIjB,EAGvCW,EAAY,KAAM,CACd,WAAYI,GAAc,CAAC,EAC3B,MAAOC,GAAS,CAAC,CACrB,CAAkB,EAGlB,OAAO,QAAQC,CAAI,EAAE,QAAQ,CAAC,CAACb,EAAKc,CAAK,IAAM,CAE3C,KAAKd,CAA0B,EAAIc,CACvC,CAAC,CACL,CAAC,CACL,CACJ,EAEOC,GAAQP,EC3Df,OAAS,SAASlE,MAAqB,iBAEvC,OAAOC,MAAe,mBAEtB,OAAOiD,MAAU,OCHjB,OAAOjD,MAAe,mBASf,IAAMyE,EAAY,CAACC,EAAgBC,IAA4B3E,EAAU,CAAC,EAAG0E,EAAOC,EAAQ,CAACd,EAAGC,IAAOA,IAAM,KAAOD,EAAI,MAAU,EAO5He,EAAoBC,GAC7B,OAAO,KAAKA,CAAM,EAEb,IAAKpB,GAAQoB,EAAOpB,CAAG,CAAC,EACxB,MAAOqB,GAAc,OAAOA,GAAc,UAAY,OAAO,KAAKA,CAAS,EAAE,MAAOrB,GAAQ,EAAEA,KAAOqB,EAAU,CAAC,EAO5GC,EAAqB,CAACrE,EAAWW,IAA0BA,EAAK,KAAM2D,GAActE,EAAI,OAASsE,EAAU,IAAI,EAE/GC,EAA6BvE,GAAkC,CACxE,OAAQA,EAAI,IAAK,CACb,IAAK,UACD,MAAO,KAEX,IAAK,WACD,MAAO,KAEX,IAAK,UACD,MAAO,KAEX,QACI,MAAO,IAEf,CACJ,ECtCA,IAAMwE,EAAwB,CAACC,EAAoCC,EAAiCC,IAA2B,CAY3H,GARIA,IAAa,eAEbF,EAAcE,CAAQ,EAAID,EAAWC,CAAQ,GAM7CA,EAAS,WAAW,IAAI,EACxB,OAgBJ,GAbyB,CACrB,aACA,WACA,WACA,QACA,UACA,sBACA,YACA,aACA,cACA,UACJ,EAEqB,SAASA,CAAQ,EAClC,OAAO,KAAKD,EAAWC,CAAQ,CAAC,EAAE,QAASC,GAAe,CAEtDH,EAAcE,CAAQ,EAAEC,CAAU,EAAIb,EAAUU,EAAcE,CAAQ,EAAEC,CAAU,EAAGF,EAAWC,CAAQ,EAAEC,CAAU,CAAC,CACzH,CAAC,UACMD,IAAa,OAAQ,CAC5B,GAAM,CAAE,KAAAhE,CAAK,EAAI+D,EAEb,MAAM,QAAQ/D,CAAI,EAClBA,EAAK,QAASX,GAAQ,CACbqE,EAAmBrE,EAAKyE,EAAc,IAAO,GAC9CA,EAAc,KAAQ,KAAKzE,CAAG,CAEtC,CAAC,EACOqE,EAAmB1D,EAAM8D,EAAc,IAAO,GACtDA,EAAc,KAAQ,KAAK9D,CAAI,CAEvC,SAAWgE,IAAa,WAAY,CAChC,GAAM,CAAE,SAAAvD,CAAS,EAAIsD,EAGrBD,EAAc,SAAcrD,CAChC,MAAWuD,EAAS,WAAW,GAAG,IAG9BF,EAAc,MAASE,CAAQ,EAAIZ,EAAUU,EAAc,MAASE,CAAQ,EAAGD,EAAWC,CAAQ,CAAC,EAE3G,EAEOE,EAAQL,EFtDf,IAAMM,EAAwB,CAC1B,GAAI,CAAC,QAAS,cAAe,YAAa,aAAc,qBAAqB,EAC7E,GAAI,CAAC,QAAS,cAAe,YAAa,aAAc,sBAAuB,YAAY,EAC3F,GAAI,CAAC,aAAc,UAAU,CACjC,EAIMpE,EAAgB,CAACqE,EAAenE,IAClCmE,EAAM,IAAK/C,GAAe,CACtB,IAAKA,EAAK,MAAQ,WAAaA,EAAK,MAAQ,WAAaA,EAAK,MAAQ,aAAeA,EAAK,cAAgB,GAAI,CAC1G,IAAMgD,EAASzC,EAAK,cAAcP,EAAK,WAAW,EAElD,GAAIgD,EAAO,OAAO,OAAS,EAAG,CAC1BA,EAAO,OAAO,IAAwBhC,GAAU,CAC5C,IAAMiC,EAA8BjC,EAEpC,OAAAiC,EAAS,WAAajD,EAAK,YAEpBiD,CACX,CAAC,EAED,IAAIC,EAAc,uCAElB,MAAAA,GAAetE,EACRoE,EAAO,OAEH,IAAKhC,GAAU,GAAGA,EAAM,SAAS,CAAC;AAAA;AAAA;AAAA,IAAiCA,EAAM,YAAY,QAAQ,OAAQ;AAAA,GAAM,CAAC;AAAA,OAAU,EACtH,KAAK;AAAA,CAAI,EAEdgC,EAAO,OAAO,IAAKhC,GAAUA,EAAM,SAAS,CAAC,EAAE,KAAK;AAAA,CAAI,EAExD,IAAI,MAAMkC,CAAW,CAC/B,CAEA,IAAMC,EAAiBH,EAAO,OAAO,EAC/BI,EAAqC,CACvC,KAAM,CAAC,CACX,EAEA,OAAAN,EAAsBP,EAA0BvC,CAAI,CAAC,EAAE,QAAS2C,GAAa,CACzES,EAAcT,CAAQ,EAAIS,EAAcT,CAAQ,GAAK,CAAC,CAC1D,CAAC,EAED,OAAO,KAAKQ,CAAc,EAAE,QAASR,GAAa,CAC9CE,EAAsBO,EAAeD,EAAgBR,CAAQ,CACjE,CAAC,EAEMS,CACX,CAEA,MAAO,CAAC,CACZ,CAAC,EAEC7D,EAAoB,CAACC,EAAsBZ,IAClBvB,EAAcmC,EAAc,CAAE,QAAS,UAAW,CAAC,EAGpD,IAAKE,GAAY,CAIvC,IAAMC,EAAMD,EAAQ,KAAK,OAAS,EAC5BE,EAAStC,EAAU,CAAC,EAAG,GAAGoB,EAAcgB,EAAQ,KAAMd,CAAO,EAAGlB,CAAU,EAEhF,CAAC,cAAe,YAAa,aAAc,sBAAuB,aAAc,MAAM,EAAE,QAASiF,GAAa,CACtG/C,EAAO+C,CAAQ,IAAM,QAAaT,EAAiBtC,EAAO+C,CAAQ,CAAC,GAEnE,OAAO/C,EAAO+C,CAAQ,CAE9B,CAAC,EAGD,IAAM3C,EAAO,KAAK,MAAM,KAAK,UAAUJ,CAAM,CAAC,EAE9C,MAAO,CACH,IAAAD,EACA,KAAAK,CACJ,CACJ,CAAC,EAGEC,GAAQV,EG9Ff,OAAO8D,MAAmB,8BAI1B,IAAMC,EAAW,MAAOtD,GAAiD,CACrE,MAAMqD,EAAc,SAASrD,CAAgC,CACjE,EAEOuD,GAAQD","sourcesContent":["import type { Spec } from \"comment-parser\";\nimport { parse as parseComments } from \"comment-parser\";\n// eslint-disable-next-line no-restricted-imports\nimport mergeWith from \"lodash.mergewith\";\n\nimport type { OpenApiObject, PathsObject } from \"../exported.d\";\nimport customizer from \"../util/customizer\";\n\n// The security object has a bizare setup...\nconst fixSecurityObject = (thing: any) => {\n if (thing.security) {\n // eslint-disable-next-line no-param-reassign\n thing.security = Object.keys(thing.security).map((s) => {\n return {\n [s]: thing.security[s],\n };\n });\n }\n};\n\nconst primitiveTypes = new Set([\"integer\", \"number\", \"string\", \"boolean\", \"object\", \"array\"]);\n\nconst formatMap: Record<string, string> = {\n binary: \"string\",\n byte: \"string\",\n date: \"string\",\n \"date-time\": \"string\",\n double: \"number\",\n float: \"number\",\n int32: \"integer\",\n int64: \"integer\",\n password: \"string\",\n};\n\nconst parseDescription = (tag: Spec): { description: string | undefined; name: string; rawType: string; required: boolean; schema: object | undefined } => {\n const rawType = tag.type;\n const isArray = rawType.endsWith(\"[]\");\n // eslint-disable-next-line require-unicode-regexp,regexp/strict\n const parsedType = rawType.replace(/\\[]$/, \"\");\n\n const isPrimitive = primitiveTypes.has(parsedType);\n const isFormat = Object.keys(formatMap).includes(parsedType);\n\n let defaultValue;\n\n if (tag.default) {\n switch (parsedType) {\n case \"integer\":\n case \"int32\":\n case \"int64\": {\n defaultValue = Number.parseInt(tag.default, 10);\n break;\n }\n case \"number\":\n case \"double\":\n case \"float\": {\n defaultValue = Number.parseFloat(tag.default);\n break;\n }\n default: {\n defaultValue = tag.default;\n break;\n }\n }\n }\n\n let rootType;\n\n if (isPrimitive) {\n rootType = { default: defaultValue, type: parsedType };\n } else if (isFormat) {\n rootType = {\n default: defaultValue,\n format: parsedType,\n type: formatMap[parsedType],\n };\n } else {\n rootType = { $ref: `#/components/schemas/${parsedType}` };\n }\n\n let schema: object | undefined = isArray\n ? {\n items: {\n ...rootType,\n },\n type: \"array\",\n }\n : {\n ...rootType,\n };\n\n if (parsedType === \"\") {\n schema = undefined;\n }\n\n // remove the optional dash from the description.\n let description: string | undefined = tag.description.trim().replace(/^- /u, \"\");\n\n if (description === \"\") {\n description = undefined;\n }\n\n return {\n description,\n name: tag.name,\n rawType,\n required: !tag.optional,\n schema,\n };\n};\n\n// @ts-expect-error\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\nconst tagsToObjects = (tags: Spec[], verbose?: boolean) =>\n tags.map((tag) => {\n const parsedResponse = parseDescription(tag);\n\n // Some ops only have a `description`, merge `name` and `description`\n // for these.\n let nameAndDescription = \"\";\n\n if (parsedResponse.name) {\n nameAndDescription += parsedResponse.name;\n }\n\n if (parsedResponse.description) {\n nameAndDescription += ` ${parsedResponse.description.trim()}`;\n }\n\n switch (tag.tag) {\n case \"operationId\":\n case \"summary\":\n case \"description\": {\n return { [tag.tag]: nameAndDescription };\n }\n\n case \"deprecated\": {\n return { deprecated: true };\n }\n\n case \"externalDocs\": {\n return {\n externalDocs: {\n description: parsedResponse.description,\n url: parsedResponse.name,\n },\n };\n }\n\n case \"server\": {\n return {\n servers: [\n {\n description: parsedResponse.description,\n url: parsedResponse.name,\n },\n ],\n };\n }\n\n case \"tag\": {\n return { tags: [nameAndDescription] };\n }\n\n case \"cookieParam\":\n case \"headerParam\":\n case \"queryParam\":\n case \"pathParam\": {\n return {\n parameters: [\n {\n description: parsedResponse.description,\n in: tag.tag.replace(/Param$/u, \"\"),\n name: parsedResponse.name,\n required: parsedResponse.required,\n schema: parsedResponse.schema,\n },\n ],\n };\n }\n\n case \"bodyContent\": {\n return {\n requestBody: {\n content: {\n [parsedResponse.name.replace(\"*\\\\/*\", \"*/*\")]: {\n schema: parsedResponse.schema,\n },\n },\n },\n };\n }\n\n case \"bodyExample\": {\n const [contentType, example] = parsedResponse.name.split(\".\");\n\n return {\n requestBody: {\n content: {\n [contentType as string]: {\n examples: {\n [example as string]: {\n $ref: `#/components/examples/${parsedResponse.rawType}`,\n },\n },\n },\n },\n },\n };\n }\n\n case \"bodyDescription\": {\n return { requestBody: { description: nameAndDescription } };\n }\n\n case \"bodyRequired\": {\n return { requestBody: { required: true } };\n }\n\n case \"response\": {\n return {\n responses: {\n [parsedResponse.name]: {\n description: parsedResponse.description,\n },\n },\n };\n }\n\n case \"callback\": {\n return {\n callbacks: {\n [parsedResponse.name]: {\n $ref: `#/components/callbacks/${parsedResponse.rawType}`,\n },\n },\n };\n }\n\n case \"responseContent\": {\n const [status, contentType] = parsedResponse.name.split(\".\");\n\n return {\n responses: {\n [status as string]: {\n content: {\n [contentType as string]: {\n schema: parsedResponse.schema,\n },\n },\n },\n },\n };\n }\n\n case \"responseHeaderComponent\": {\n const [status, header] = parsedResponse.name.split(\".\");\n\n return {\n responses: {\n [status as string]: {\n headers: {\n [header as string]: {\n $ref: `#/components/headers/${parsedResponse.rawType}`,\n },\n },\n },\n },\n };\n }\n\n case \"responseHeader\": {\n const [status, header] = parsedResponse.name.split(\".\");\n\n return {\n responses: {\n [status as string]: {\n headers: {\n [header as string]: {\n description: parsedResponse.description,\n schema: parsedResponse.schema,\n },\n },\n },\n },\n };\n }\n\n case \"responseExample\": {\n const [status, contentType, example] = parsedResponse.name.split(\".\");\n\n return {\n responses: {\n [status as string]: {\n content: {\n [contentType as string]: {\n examples: {\n [example as string]: {\n $ref: `#/components/examples/${parsedResponse.rawType}`,\n },\n },\n },\n },\n },\n },\n };\n }\n\n case \"responseLink\": {\n const [status, link] = parsedResponse.name.split(\".\");\n\n return {\n responses: {\n [status as string]: {\n links: {\n [link as string]: {\n $ref: `#/components/links/${parsedResponse.rawType}`,\n },\n },\n },\n },\n };\n }\n\n case \"bodyComponent\": {\n return {\n requestBody: {\n $ref: `#/components/requestBodies/${parsedResponse.rawType}`,\n },\n };\n }\n\n case \"responseComponent\": {\n return {\n responses: {\n [parsedResponse.name]: {\n $ref: `#/components/responses/${parsedResponse.rawType}`,\n },\n },\n };\n }\n\n case \"paramComponent\": {\n return {\n parameters: [{ $ref: `#/components/parameters/${parsedResponse.rawType}` }],\n };\n }\n\n case \"security\": {\n const [security, scopeItem] = parsedResponse.name.split(\".\");\n\n let scope: string[] = [];\n\n if (scopeItem) {\n scope = [scopeItem];\n }\n\n return {\n security: { [security as string]: scope },\n };\n }\n\n default: {\n return {};\n }\n }\n });\n\nconst commentsToOpenApi = (fileContents: string, verbose?: boolean): { loc: number; spec: OpenApiObject }[] => {\n // eslint-disable-next-line regexp/no-unused-capturing-group,require-unicode-regexp\n const openAPIRegex = /^(GET|PUT|POST|DELETE|OPTIONS|HEAD|PATCH|TRACE) \\/.*$/;\n\n const jsDocumentComments = parseComments(fileContents, { spacing: \"preserve\" });\n\n // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n return jsDocumentComments\n .filter((comment) => openAPIRegex.test(comment.description.trim()))\n .map((comment) => {\n // Line count, number of tags + 1 for description.\n // - Don't count line-breaking due to long descriptions\n // - Don't count empty lines\n const loc = comment.tags.length + 1;\n\n const result = mergeWith({}, ...tagsToObjects(comment.tags, verbose), customizer);\n\n fixSecurityObject(result);\n\n const [method, path]: string[] = comment.description.split(\" \");\n\n const pathsObject: PathsObject = {\n [(path as string).trim()]: {\n [(method as string).toLowerCase().trim()]: {\n ...result,\n },\n },\n };\n\n // Purge all undefined objects/arrays.\n const spec = JSON.parse(JSON.stringify({ paths: pathsObject }));\n\n return {\n loc,\n spec,\n };\n });\n};\n\nexport default commentsToOpenApi;\n","const customizer = (objectValue: unknown, sourceValue: unknown[]): unknown[] | undefined => {\n if (Array.isArray(objectValue)) {\n return [...objectValue, ...sourceValue] as unknown[];\n }\n\n return undefined;\n};\n\nexport default customizer;\n","const yamlLoc = (string: string): number => {\n // Break string into lines.\n const split = string.split(/\\r\\n|\\r|\\n/u);\n\n const filtered = split.filter((line) => {\n // Remove comments.\n // eslint-disable-next-line security/detect-unsafe-regex,regexp/no-unused-capturing-group\n if (/^\\s*(#\\s*(?:\\S.*)?)?$/u.test(line)) {\n return false;\n }\n // Remove empty lines.\n return line.trim().length > 0;\n });\n\n return filtered.length;\n};\n\nexport default yamlLoc;\n","import { readFileSync } from \"node:fs\";\nimport path from \"node:path\";\n\nimport yaml from \"yaml\";\n\nimport type { OpenApiObject } from \"./exported.d\";\nimport yamlLoc from \"./util/yaml-loc\";\n\nconst ALLOWED_KEYS = new Set([\"openapi\", \"info\", \"servers\", \"security\", \"tags\", \"externalDocs\", \"components\", \"paths\"]);\n\nclass ParseError extends Error {\n public filePath?: string;\n}\n\nconst parseFile = (\n file: string,\n commentsToOpenApi: (fileContent: string, verbose?: boolean) => { loc: number; spec: OpenApiObject }[],\n verbose?: boolean,\n): { loc: number; spec: OpenApiObject }[] => {\n // eslint-disable-next-line security/detect-non-literal-fs-filename\n const fileContent = readFileSync(file, { encoding: \"utf8\" });\n const extension = path.extname(file);\n\n if (extension === \".yaml\" || extension === \".yml\") {\n const spec = yaml.parse(fileContent);\n const invalidKeys = Object.keys(spec).filter((key) => !ALLOWED_KEYS.has(key));\n\n if (invalidKeys.length > 0) {\n const error = new ParseError(`Unexpected keys: ${invalidKeys.join(\", \")}`);\n\n error.filePath = file;\n\n throw error;\n }\n\n if (Object.keys(spec).some((key) => ALLOWED_KEYS.has(key))) {\n const loc = yamlLoc(fileContent);\n\n return [{ loc, spec }];\n }\n\n return [];\n }\n\n try {\n return commentsToOpenApi(fileContent, verbose);\n } catch (error: any) {\n error.filePath = file;\n\n throw error;\n }\n};\n\nexport default parseFile;\n","const objectMerge = <T>(a: T, b: T): void => {\n Object.keys(b as object).forEach((key) => {\n // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition\n if (a[key as keyof typeof b] === undefined) {\n // eslint-disable-next-line no-param-reassign\n a[key as keyof typeof b] = {\n ...b[key as keyof typeof b],\n };\n } else {\n Object.keys(b[key as keyof typeof b] as object).forEach((subKey) => {\n // eslint-disable-next-line no-param-reassign\n (a[key as keyof typeof b] as Record<string, object>)[subKey] = {\n ...(a[key as keyof typeof b] as Record<string, object>)[subKey],\n ...(b[key as keyof typeof b] as Record<string, object>)[subKey],\n };\n });\n }\n });\n};\n\nexport default objectMerge;\n","import type {\n BaseDefinition,\n ComponentsObject,\n ExternalDocumentationObject,\n InfoObject,\n OpenApiObject,\n PathsObject,\n SecurityRequirementObject,\n ServerObject,\n TagObject,\n} from \"./exported.d\";\nimport objectMerge from \"./util/object-merge\";\n\nclass SpecBuilder implements OpenApiObject {\n public components?: ComponentsObject;\n\n public externalDocs?: ExternalDocumentationObject;\n\n public info: InfoObject;\n\n public openapi: string;\n\n public paths: PathsObject;\n\n public security?: SecurityRequirementObject[];\n\n public servers?: ServerObject[];\n\n public tags?: TagObject[];\n\n public constructor(baseDefinition: BaseDefinition) {\n this.openapi = baseDefinition.openapi;\n this.info = baseDefinition.info;\n this.servers = baseDefinition.servers;\n this.paths = baseDefinition.paths ?? {};\n this.components = baseDefinition.components;\n this.security = baseDefinition.security;\n this.tags = baseDefinition.tags;\n this.externalDocs = baseDefinition.externalDocs;\n }\n\n public addData(parsedFile: OpenApiObject[]): void {\n parsedFile.forEach((file) => {\n const { components, paths, ...rest } = file;\n\n // only merge paths and components\n objectMerge(this, {\n components: components ?? {},\n paths: paths ?? {},\n } as OpenApiObject);\n\n // overwrite everything else:\n Object.entries(rest).forEach(([key, value]) => {\n // @ts-expect-error\n this[key as keyof OpenApiObject] = value;\n });\n });\n }\n}\n\nexport default SpecBuilder;\n","import type { Spec } from \"comment-parser\";\nimport { parse as parseComments } from \"comment-parser\";\n// eslint-disable-next-line no-restricted-imports\nimport mergeWith from \"lodash.mergewith\";\nimport type { YAMLError } from \"yaml\";\nimport yaml from \"yaml\";\n\nimport type { OpenApiObject } from \"../exported.d\";\nimport customizer from \"../util/customizer\";\nimport organizeSwaggerObject from \"./organize-swagger-object\";\nimport { getSwaggerVersionFromSpec, hasEmptyProperty } from \"./utils\";\n\nconst specificationTemplate = {\n v2: [\"paths\", \"definitions\", \"responses\", \"parameters\", \"securityDefinitions\"],\n v3: [\"paths\", \"definitions\", \"responses\", \"parameters\", \"securityDefinitions\", \"components\"],\n v4: [\"components\", \"channels\"],\n};\n\ntype ExtendedYAMLError = YAMLError & { annotation?: string };\n\nconst tagsToObjects = (specs: Spec[], verbose?: boolean) =>\n specs.map((spec: Spec) => {\n if ((spec.tag === \"openapi\" || spec.tag === \"swagger\" || spec.tag === \"asyncapi\") && spec.description !== \"\") {\n const parsed = yaml.parseDocument(spec.description);\n\n if (parsed.errors.length > 0) {\n parsed.errors.map<ExtendedYAMLError>((error) => {\n const newError: ExtendedYAMLError = error;\n\n newError.annotation = spec.description;\n\n return newError;\n });\n\n let errorString = \"Error parsing YAML in @openapi spec:\";\n\n errorString += verbose\n ? (parsed.errors as ExtendedYAMLError[])\n // eslint-disable-next-line @typescript-eslint/no-base-to-string\n .map((error) => `${error.toString()}\\nImbedded within:\\n\\`\\`\\`\\n ${error.annotation?.replace(/\\n/gu, \"\\n \")}\\n\\`\\`\\``)\n .join(\"\\n\")\n : // eslint-disable-next-line @typescript-eslint/no-base-to-string\n parsed.errors.map((error) => error.toString()).join(\"\\n\");\n\n throw new Error(errorString);\n }\n\n const parsedDocument = parsed.toJSON();\n const specification: Record<string, any> = {\n tags: [],\n };\n\n specificationTemplate[getSwaggerVersionFromSpec(spec)].forEach((property) => {\n specification[property] = specification[property] || {};\n });\n\n Object.keys(parsedDocument).forEach((property) => {\n organizeSwaggerObject(specification, parsedDocument, property);\n });\n\n return specification;\n }\n\n return {};\n });\n\nconst commentsToOpenApi = (fileContents: string, verbose?: boolean): { loc: number; spec: OpenApiObject }[] => {\n const jsDocumentComments = parseComments(fileContents, { spacing: \"preserve\" });\n\n // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n return jsDocumentComments.map((comment) => {\n // Line count, number of tags + 1 for description.\n // - Don't count line-breaking due to long descriptions\n // - Don't count empty lines\n const loc = comment.tags.length + 1;\n const result = mergeWith({}, ...tagsToObjects(comment.tags, verbose), customizer);\n\n [\"definitions\", \"responses\", \"parameters\", \"securityDefinitions\", \"components\", \"tags\"].forEach((property) => {\n if (result[property] !== undefined && hasEmptyProperty(result[property])) {\n // eslint-disable-next-line @typescript-eslint/no-dynamic-delete\n delete result[property];\n }\n });\n\n // Purge all undefined objects/arrays.\n const spec = JSON.parse(JSON.stringify(result));\n\n return {\n loc,\n spec,\n };\n });\n};\n\nexport default commentsToOpenApi;\n","import type { Spec } from \"comment-parser\";\n// eslint-disable-next-line no-restricted-imports\nimport mergeWith from \"lodash.mergewith\";\n\n/**\n * A recursive deep-merge that ignores null values when merging.\n * This returns the merged object and does not mutate.\n * @param {object} first the first object to get merged\n * @param {object} second the second object to get merged\n */\n// eslint-disable-next-line @typescript-eslint/no-unsafe-return\nexport const mergeDeep = (first?: object, second?: object): object => mergeWith({}, first, second, (a, b) => (b === null ? a : undefined));\n\n/**\n * Checks if there is any properties of the input object which are an empty object\n * @param {object} object - the object to check\n * @returns boolean\n */\nexport const hasEmptyProperty = (object: Record<string, any>): boolean =>\n Object.keys(object)\n // eslint-disable-next-line @typescript-eslint/no-unsafe-return\n .map((key) => object[key])\n .every((keyObject) => typeof keyObject === \"object\" && Object.keys(keyObject).every((key) => !(key in keyObject)));\n\n/**\n * @param {object} tag\n * @param {array} tags\n * @returns boolean\n */\nexport const isTagPresentInTags = (tag: Spec, tags: Spec[]): boolean => tags.some((targetTag) => tag.name === targetTag.name);\n\nexport const getSwaggerVersionFromSpec = (tag: Spec): \"v2\" | \"v3\" | \"v4\" => {\n switch (tag.tag) {\n case \"openapi\": {\n return \"v3\";\n }\n case \"asyncapi\": {\n return \"v4\";\n }\n case \"swagger\": {\n return \"v2\";\n }\n default: {\n return \"v2\";\n }\n }\n};\n","import { isTagPresentInTags, mergeDeep } from \"./utils\";\n\n/**\n * @param {object} swaggerObject\n * @param {object} annotation\n * @param {string} property\n */\n\nconst organizeSwaggerObject = (swaggerObject: Record<string, any>, annotation: Record<string, any>, property: string): void => {\n // Root property on purpose.\n // eslint-disable-next-line no-secrets/no-secrets\n // @see https://github.com/OAI/OpenAPI-Specification/blob/master/proposals/002_Webhooks.md#proposed-solution\n if (property === \"x-webhooks\") {\n // eslint-disable-next-line no-param-reassign\n swaggerObject[property] = annotation[property];\n }\n\n // Other extensions can be in varying places depending on different vendors and opinions.\n // The following return makes it so that they are not put in `paths` in the last case.\n // New specific extensions will need to be handled on case-by-case if to be included in `paths`.\n if (property.startsWith(\"x-\")) {\n return;\n }\n\n const commonProperties = [\n \"components\",\n \"consumes\",\n \"produces\",\n \"paths\",\n \"schemas\",\n \"securityDefinitions\",\n \"responses\",\n \"parameters\",\n \"definitions\",\n \"channels\",\n ];\n\n if (commonProperties.includes(property)) {\n Object.keys(annotation[property]).forEach((definition) => {\n // eslint-disable-next-line no-param-reassign\n swaggerObject[property][definition] = mergeDeep(swaggerObject[property][definition], annotation[property][definition]);\n });\n } else if (property === \"tags\") {\n const { tags } = annotation;\n\n if (Array.isArray(tags)) {\n tags.forEach((tag) => {\n if (!isTagPresentInTags(tag, swaggerObject[\"tags\"])) {\n swaggerObject[\"tags\"].push(tag);\n }\n });\n } else if (!isTagPresentInTags(tags, swaggerObject[\"tags\"])) {\n swaggerObject[\"tags\"].push(tags);\n }\n } else if (property === \"security\") {\n const { security } = annotation;\n\n // eslint-disable-next-line no-param-reassign\n swaggerObject[\"security\"] = security;\n } else if (property.startsWith(\"/\")) {\n // Paths which are not defined as \"paths\" property, starting with a slash \"/\"\n // eslint-disable-next-line no-param-reassign\n swaggerObject[\"paths\"][property] = mergeDeep(swaggerObject[\"paths\"][property], annotation[property]);\n }\n};\n\nexport default organizeSwaggerObject;\n","import SwaggerParser from \"@apidevtools/swagger-parser\";\n// eslint-disable-next-line import/no-named-as-default\nimport type OpenAPI from \"openapi-types\";\n\nconst validate = async (spec: Record<string, unknown>): Promise<void> => {\n await SwaggerParser.validate(spec as OpenAPI.OpenAPI.Document);\n};\n\nexport default validate;\n"]}
|
|
File without changes
|
|
File without changes
|