@tsed/swagger 7.83.3 → 7.84.0
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/lib/cjs/index.js +1 -0
- package/lib/cjs/index.js.map +1 -1
- package/lib/cjs/services/SwaggerService.js +3 -2
- package/lib/cjs/services/SwaggerService.js.map +1 -1
- package/lib/cjs/utils/readSpec.js +16 -0
- package/lib/cjs/utils/readSpec.js.map +1 -0
- package/lib/esm/index.js +1 -0
- package/lib/esm/index.js.map +1 -1
- package/lib/esm/services/SwaggerService.js +3 -2
- package/lib/esm/services/SwaggerService.js.map +1 -1
- package/lib/esm/utils/readSpec.js +12 -0
- package/lib/esm/utils/readSpec.js.map +1 -0
- package/lib/types/index.d.ts +1 -0
- package/lib/types/interfaces/SwaggerSettings.d.ts +4 -0
- package/lib/types/utils/readSpec.d.ts +1 -0
- package/lib/types-esm/index.d.ts +1 -0
- package/lib/types-esm/interfaces/SwaggerSettings.d.ts +4 -0
- package/lib/types-esm/utils/readSpec.d.ts +1 -0
- package/package.json +12 -12
package/lib/cjs/index.js
CHANGED
|
@@ -17,4 +17,5 @@ tslib_1.__exportStar(require("./services/SwaggerService.js"), exports);
|
|
|
17
17
|
tslib_1.__exportStar(require("./SwaggerModule.js"), exports);
|
|
18
18
|
tslib_1.__exportStar(require("./utils/includeRoute.js"), exports);
|
|
19
19
|
tslib_1.__exportStar(require("./utils/matchPath.js"), exports);
|
|
20
|
+
tslib_1.__exportStar(require("./utils/readSpec.js"), exports);
|
|
20
21
|
//# sourceMappingURL=index.js.map
|
package/lib/cjs/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,yDAA+B;AAC/B,+DAAqC;AACrC,iEAAuC;AACvC,qEAA2C;AAC3C,0EAAgD;AAChD,yEAA+C;AAC/C,2EAAiD;AACjD,wEAA8C;AAC9C,8EAAoD;AACpD,uEAA6C;AAC7C,6DAAmC;AACnC,kEAAwC;AACxC,+DAAqC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";;;AAAA;;GAEG;AACH,yDAA+B;AAC/B,+DAAqC;AACrC,iEAAuC;AACvC,qEAA2C;AAC3C,0EAAgD;AAChD,yEAA+C;AAC/C,2EAAiD;AACjD,wEAA8C;AAC9C,8EAAoD;AACpD,uEAA6C;AAC7C,6DAAmC;AACnC,kEAAwC;AACxC,+DAAqC;AACrC,8DAAoC"}
|
|
@@ -5,6 +5,7 @@ const tslib_1 = require("tslib");
|
|
|
5
5
|
const common_1 = require("@tsed/common");
|
|
6
6
|
const schema_1 = require("@tsed/schema");
|
|
7
7
|
const includeRoute_js_1 = require("../utils/includeRoute.js");
|
|
8
|
+
const readSpec_js_1 = require("../utils/readSpec.js");
|
|
8
9
|
let SwaggerService = class SwaggerService {
|
|
9
10
|
#specs;
|
|
10
11
|
constructor(injectorService, platform, configuration) {
|
|
@@ -21,10 +22,10 @@ let SwaggerService = class SwaggerService {
|
|
|
21
22
|
.getMountedControllers()
|
|
22
23
|
.filter(({ routes, provider }) => [...routes.values()].some((route) => (0, includeRoute_js_1.includeRoute)(route, provider, conf)))
|
|
23
24
|
.map(({ route, provider }) => ({ token: provider.token, rootPath: route }));
|
|
24
|
-
const spec =
|
|
25
|
+
const spec = (0, schema_1.generateSpec)({
|
|
25
26
|
tokens,
|
|
26
27
|
...conf,
|
|
27
|
-
specPath,
|
|
28
|
+
fileSpec: specPath ? await (0, readSpec_js_1.readSpec)(specPath) : {},
|
|
28
29
|
version,
|
|
29
30
|
acceptMimes
|
|
30
31
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SwaggerService.js","sourceRoot":"","sources":["../../../src/services/SwaggerService.ts"],"names":[],"mappings":";;;;AAAA,yCAAkF;AAElF,yCAA0C;AAE1C,8DAAsD;
|
|
1
|
+
{"version":3,"file":"SwaggerService.js","sourceRoot":"","sources":["../../../src/services/SwaggerService.ts"],"names":[],"mappings":";;;;AAAA,yCAAkF;AAElF,yCAA0C;AAE1C,8DAAsD;AACtD,sDAA6C;AAGtC,IAAM,cAAc,GAApB,MAAM,cAAc;IACzB,MAAM,CAAiD;IAEvD,YACU,eAAgC,EAChC,QAAkB,EACD,aAA4B;QAF7C,oBAAe,GAAf,eAAe,CAAiB;QAChC,aAAQ,GAAR,QAAQ,CAAU;QACD,kBAAa,GAAb,aAAa,CAAe;QALvD,WAAM,GAAuC,IAAI,GAAG,EAAE,CAAC;IAMpD,CAAC;IASG,KAAK,CAAC,cAAc,CAAC,IAAqB;QAC/C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC/B,MAAM,EAAC,OAAO,GAAG,OAAO,EAAE,WAAW,EAAC,GAAG,IAAI,CAAC,aAAa,CAAC;YAC5D,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;YAE3F,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ;iBACzB,qBAAqB,EAAE;iBACvB,MAAM,CAAC,CAAC,EAAC,MAAM,EAAE,QAAQ,EAAC,EAAE,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,IAAA,8BAAY,EAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;iBACzG,GAAG,CAAC,CAAC,EAAC,KAAK,EAAE,QAAQ,EAAC,EAAE,EAAE,CAAC,CAAC,EAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAC,CAAC,CAAC,CAAC;YAE1E,MAAM,IAAI,GAAG,IAAA,qBAAY,EAAC;gBACxB,MAAM;gBACN,GAAG,IAAI;gBACP,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,MAAM,IAAA,sBAAQ,EAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE;gBAClD,OAAO;gBACP,WAAW;aACZ,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;SAClC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;CACF,CAAA;AAvCY,cAAc;IAD1B,IAAA,mBAAU,GAAE;IAOR,mBAAA,IAAA,sBAAa,GAAE,CAAA;6CAFS,wBAAe;QACtB,iBAAQ;GALjB,cAAc,CAuC1B;AAvCY,wCAAc"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.readSpec = void 0;
|
|
4
|
+
async function readSpec(path) {
|
|
5
|
+
const { default: fs } = await import("fs-extra");
|
|
6
|
+
if (fs.existsSync(path)) {
|
|
7
|
+
try {
|
|
8
|
+
return await fs.readJSON(path, { encoding: "utf8" });
|
|
9
|
+
}
|
|
10
|
+
catch (e) { }
|
|
11
|
+
}
|
|
12
|
+
/* istanbul ignore next */
|
|
13
|
+
return {};
|
|
14
|
+
}
|
|
15
|
+
exports.readSpec = readSpec;
|
|
16
|
+
//# sourceMappingURL=readSpec.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"readSpec.js","sourceRoot":"","sources":["../../../src/utils/readSpec.ts"],"names":[],"mappings":";;;AAAO,KAAK,UAAU,QAAQ,CAAC,IAAY;IACzC,MAAM,EAAC,OAAO,EAAE,EAAE,EAAC,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,CAAC;IAC/C,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;QACvB,IAAI;YACF,OAAO,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAC,CAAC,CAAC;SACpD;QAAC,OAAO,CAAC,EAAE,GAAE;KACf;IAED,0BAA0B;IAC1B,OAAO,EAAE,CAAC;AACZ,CAAC;AAVD,4BAUC"}
|
package/lib/esm/index.js
CHANGED
package/lib/esm/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iCAAiC,CAAC;AAChD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AACjD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qCAAqC,CAAC;AACpD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,cAAc,gBAAgB,CAAC;AAC/B,cAAc,sBAAsB,CAAC;AACrC,cAAc,wBAAwB,CAAC;AACvC,cAAc,4BAA4B,CAAC;AAC3C,cAAc,iCAAiC,CAAC;AAChD,cAAc,gCAAgC,CAAC;AAC/C,cAAc,kCAAkC,CAAC;AACjD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,qCAAqC,CAAC;AACpD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,qBAAqB,CAAC"}
|
|
@@ -2,6 +2,7 @@ import { __decorate, __metadata, __param } from "tslib";
|
|
|
2
2
|
import { Configuration, Injectable, InjectorService, Platform } from "@tsed/common";
|
|
3
3
|
import { generateSpec } from "@tsed/schema";
|
|
4
4
|
import { includeRoute } from "../utils/includeRoute.js";
|
|
5
|
+
import { readSpec } from "../utils/readSpec.js";
|
|
5
6
|
let SwaggerService = class SwaggerService {
|
|
6
7
|
#specs;
|
|
7
8
|
constructor(injectorService, platform, configuration) {
|
|
@@ -18,10 +19,10 @@ let SwaggerService = class SwaggerService {
|
|
|
18
19
|
.getMountedControllers()
|
|
19
20
|
.filter(({ routes, provider }) => [...routes.values()].some((route) => includeRoute(route, provider, conf)))
|
|
20
21
|
.map(({ route, provider }) => ({ token: provider.token, rootPath: route }));
|
|
21
|
-
const spec =
|
|
22
|
+
const spec = generateSpec({
|
|
22
23
|
tokens,
|
|
23
24
|
...conf,
|
|
24
|
-
specPath,
|
|
25
|
+
fileSpec: specPath ? await readSpec(specPath) : {},
|
|
25
26
|
version,
|
|
26
27
|
acceptMimes
|
|
27
28
|
});
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"SwaggerService.js","sourceRoot":"","sources":["../../../src/services/SwaggerService.ts"],"names":[],"mappings":";AAAA,OAAO,EAAC,aAAa,EAAE,UAAU,EAAE,eAAe,EAAE,QAAQ,EAAC,MAAM,cAAc,CAAC;AAElF,OAAO,EAAC,YAAY,EAAC,MAAM,cAAc,CAAC;AAE1C,OAAO,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAC;
|
|
1
|
+
{"version":3,"file":"SwaggerService.js","sourceRoot":"","sources":["../../../src/services/SwaggerService.ts"],"names":[],"mappings":";AAAA,OAAO,EAAC,aAAa,EAAE,UAAU,EAAE,eAAe,EAAE,QAAQ,EAAC,MAAM,cAAc,CAAC;AAElF,OAAO,EAAC,YAAY,EAAC,MAAM,cAAc,CAAC;AAE1C,OAAO,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAC,QAAQ,EAAC,MAAM,sBAAsB,CAAA;AAGtC,IAAM,cAAc,GAApB,MAAM,cAAc;IACzB,MAAM,CAAiD;IAEvD,YACU,eAAgC,EAChC,QAAkB,EACD,aAA4B;QAF7C,oBAAe,GAAf,eAAe,CAAiB;QAChC,aAAQ,GAAR,QAAQ,CAAU;QACD,kBAAa,GAAb,aAAa,CAAe;QALvD,WAAM,GAAuC,IAAI,GAAG,EAAE,CAAC;IAMpD,CAAC;IASG,KAAK,CAAC,cAAc,CAAC,IAAqB;QAC/C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;YAC/B,MAAM,EAAC,OAAO,GAAG,OAAO,EAAE,WAAW,EAAC,GAAG,IAAI,CAAC,aAAa,CAAC;YAC5D,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC;YAE3F,MAAM,MAAM,GAAG,IAAI,CAAC,QAAQ;iBACzB,qBAAqB,EAAE;iBACvB,MAAM,CAAC,CAAC,EAAC,MAAM,EAAE,QAAQ,EAAC,EAAE,EAAE,CAAC,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,KAAK,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC;iBACzG,GAAG,CAAC,CAAC,EAAC,KAAK,EAAE,QAAQ,EAAC,EAAE,EAAE,CAAC,CAAC,EAAC,KAAK,EAAE,QAAQ,CAAC,KAAK,EAAE,QAAQ,EAAE,KAAK,EAAC,CAAC,CAAC,CAAC;YAE1E,MAAM,IAAI,GAAG,YAAY,CAAC;gBACxB,MAAM;gBACN,GAAG,IAAI;gBACP,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,MAAM,QAAQ,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE;gBAClD,OAAO;gBACP,WAAW;aACZ,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;SAClC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;CACF,CAAA;AAvCY,cAAc;IAD1B,UAAU,EAAE;IAOR,WAAA,aAAa,EAAE,CAAA;qCAFS,eAAe;QACtB,QAAQ;GALjB,cAAc,CAuC1B;SAvCY,cAAc"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
export async function readSpec(path) {
|
|
2
|
+
const { default: fs } = await import("fs-extra");
|
|
3
|
+
if (fs.existsSync(path)) {
|
|
4
|
+
try {
|
|
5
|
+
return await fs.readJSON(path, { encoding: "utf8" });
|
|
6
|
+
}
|
|
7
|
+
catch (e) { }
|
|
8
|
+
}
|
|
9
|
+
/* istanbul ignore next */
|
|
10
|
+
return {};
|
|
11
|
+
}
|
|
12
|
+
//# sourceMappingURL=readSpec.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"readSpec.js","sourceRoot":"","sources":["../../../src/utils/readSpec.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,KAAK,UAAU,QAAQ,CAAC,IAAY;IACzC,MAAM,EAAC,OAAO,EAAE,EAAE,EAAC,GAAG,MAAM,MAAM,CAAC,UAAU,CAAC,CAAC;IAC/C,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE;QACvB,IAAI;YACF,OAAO,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAC,CAAC,CAAC;SACpD;QAAC,OAAO,CAAC,EAAE,GAAE;KACf;IAED,0BAA0B;IAC1B,OAAO,EAAE,CAAC;AACZ,CAAC"}
|
package/lib/types/index.d.ts
CHANGED
|
@@ -62,6 +62,10 @@ export interface SwaggerSettingsBase {
|
|
|
62
62
|
* Write the `swagger.json` spec documentation on the specified path.
|
|
63
63
|
*/
|
|
64
64
|
outFile?: string;
|
|
65
|
+
/**
|
|
66
|
+
* Sort paths by alphabetical order
|
|
67
|
+
*/
|
|
68
|
+
sortPaths?: boolean;
|
|
65
69
|
/**
|
|
66
70
|
* A function to generate the operationId.
|
|
67
71
|
*/
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function readSpec(path: string): Promise<any>;
|
package/lib/types-esm/index.d.ts
CHANGED
|
@@ -62,6 +62,10 @@ export interface SwaggerSettingsBase {
|
|
|
62
62
|
* Write the `swagger.json` spec documentation on the specified path.
|
|
63
63
|
*/
|
|
64
64
|
outFile?: string;
|
|
65
|
+
/**
|
|
66
|
+
* Sort paths by alphabetical order
|
|
67
|
+
*/
|
|
68
|
+
sortPaths?: boolean;
|
|
65
69
|
/**
|
|
66
70
|
* A function to generate the operationId.
|
|
67
71
|
*/
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function readSpec(path: string): Promise<any>;
|
package/package.json
CHANGED
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"name": "@tsed/swagger",
|
|
3
3
|
"description": "Swagger package for Ts.ED framework",
|
|
4
4
|
"type": "commonjs",
|
|
5
|
-
"version": "7.
|
|
5
|
+
"version": "7.84.0",
|
|
6
6
|
"source": "./src/index.ts",
|
|
7
7
|
"main": "./lib/cjs/index.js",
|
|
8
8
|
"module": "./lib/esm/index.js",
|
|
@@ -26,23 +26,23 @@
|
|
|
26
26
|
"test:ci": "vitest run --coverage.thresholds.autoUpdate=true"
|
|
27
27
|
},
|
|
28
28
|
"dependencies": {
|
|
29
|
-
"@tsed/normalize-path": "7.
|
|
30
|
-
"@tsed/openspec": "7.
|
|
29
|
+
"@tsed/normalize-path": "7.84.0",
|
|
30
|
+
"@tsed/openspec": "7.84.0",
|
|
31
31
|
"fs-extra": "11.2.0",
|
|
32
32
|
"micromatch": "4.0.8",
|
|
33
33
|
"swagger-ui-dist": ">=5.17.1",
|
|
34
34
|
"tslib": "2.6.1"
|
|
35
35
|
},
|
|
36
36
|
"devDependencies": {
|
|
37
|
-
"@tsed/barrels": "7.
|
|
38
|
-
"@tsed/common": "7.
|
|
39
|
-
"@tsed/core": "7.
|
|
40
|
-
"@tsed/di": "7.
|
|
41
|
-
"@tsed/json-mapper": "7.
|
|
37
|
+
"@tsed/barrels": "7.84.0",
|
|
38
|
+
"@tsed/common": "7.84.0",
|
|
39
|
+
"@tsed/core": "7.84.0",
|
|
40
|
+
"@tsed/di": "7.84.0",
|
|
41
|
+
"@tsed/json-mapper": "7.84.0",
|
|
42
42
|
"@tsed/monorepo-utils": "2.3.5",
|
|
43
|
-
"@tsed/openspec": "7.
|
|
44
|
-
"@tsed/schema": "7.
|
|
45
|
-
"@tsed/typescript": "7.
|
|
43
|
+
"@tsed/openspec": "7.84.0",
|
|
44
|
+
"@tsed/schema": "7.84.0",
|
|
45
|
+
"@tsed/typescript": "7.84.0",
|
|
46
46
|
"@types/swagger-ui-dist": "3.30.4",
|
|
47
47
|
"eslint": "^8.57.0",
|
|
48
48
|
"ts-node": "10.9.2",
|
|
@@ -50,7 +50,7 @@
|
|
|
50
50
|
"vitest": "2.0.4"
|
|
51
51
|
},
|
|
52
52
|
"peerDependencies": {
|
|
53
|
-
"@tsed/common": "7.
|
|
53
|
+
"@tsed/common": "7.84.0"
|
|
54
54
|
},
|
|
55
55
|
"peerDependenciesMeta": {
|
|
56
56
|
"@tsed/common": {
|