@tsed/swagger 8.0.0-beta.8 → 8.0.0-rc.1

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.
Files changed (10) hide show
  1. package/lib/esm/index.js +1 -0
  2. package/lib/esm/index.js.map +1 -1
  3. package/lib/esm/services/SwaggerService.js +3 -2
  4. package/lib/esm/services/SwaggerService.js.map +1 -1
  5. package/lib/esm/utils/readSpec.js +12 -0
  6. package/lib/esm/utils/readSpec.js.map +1 -0
  7. package/lib/types/index.d.ts +1 -0
  8. package/lib/types/interfaces/SwaggerSettings.d.ts +4 -0
  9. package/lib/types/utils/readSpec.d.ts +1 -0
  10. package/package.json +13 -13
package/lib/esm/index.js CHANGED
@@ -14,4 +14,5 @@ export * from "./services/SwaggerService.js";
14
14
  export * from "./SwaggerModule.js";
15
15
  export * from "./utils/includeRoute.js";
16
16
  export * from "./utils/matchPath.js";
17
+ export * from "./utils/readSpec.js";
17
18
  //# sourceMappingURL=index.js.map
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"}
package/lib/esm/services/SwaggerService.js CHANGED
@@ -3,6 +3,7 @@ import { constant, Injectable } from "@tsed/di";
3
3
  import { Platform } from "@tsed/platform-http";
4
4
  import { generateSpec } from "@tsed/schema";
5
5
  import { includeRoute } from "../utils/includeRoute.js";
6
+ import { readSpec } from "../utils/readSpec.js";
6
7
  let SwaggerService = class SwaggerService {
7
8
  #specs = new Map();
8
9
  constructor(platform) {
@@ -17,10 +18,10 @@ let SwaggerService = class SwaggerService {
17
18
  .getMountedControllers()
18
19
  .filter(({ routes, provider }) => [...routes.values()].some((route) => includeRoute(route, provider, conf)))
19
20
  .map(({ route, provider }) => ({ token: provider.token, rootPath: route }));
20
- const spec = await generateSpec({
21
+ const spec = generateSpec({
21
22
  tokens,
22
23
  ...conf,
23
- specPath,
24
+ fileSpec: specPath ? await readSpec(specPath) : {},
24
25
  version,
25
26
  acceptMimes
26
27
  });
package/lib/esm/services/SwaggerService.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"SwaggerService.js","sourceRoot":"","sources":["../../../src/services/SwaggerService.ts"],"names":[],"mappings":";AACA,OAAO,EAAC,QAAQ,EAAE,UAAU,EAAC,MAAM,UAAU,CAAC;AAE9C,OAAO,EAAC,QAAQ,EAAC,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAC,YAAY,EAAC,MAAM,cAAc,CAAC;AAG1C,OAAO,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAC;AAG/C,IAAM,cAAc,GAApB,MAAM,cAAc;IACzB,MAAM,GAAuC,IAAI,GAAG,EAAE,CAAC;IAEvD,YAAoB,QAAkB;QAAlB,aAAQ,GAAR,QAAQ,CAAU;IAAG,CAAC;IASnC,KAAK,CAAC,cAAc,CAAC,IAAqB;QAC/C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,MAAM,OAAO,GAAG,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YAC7C,MAAM,WAAW,GAAG,QAAQ,CAAS,aAAa,CAAC,CAAC;YACpD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;YAE/B,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,KAAa,EAAE,QAAQ,EAAE,KAAK,EAAC,CAAC,CAAC,CAAC;YAElF,MAAM,IAAI,GAAG,MAAM,YAAY,CAAC;gBAC9B,MAAM;gBACN,GAAG,IAAI;gBACP,QAAQ;gBACR,OAAO;gBACP,WAAW;aACZ,CAAC,CAAC;YAEH,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACnC,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;CACF,CAAA;AApCY,cAAc;IAD1B,UAAU,EAAE;qCAImB,QAAQ;GAH3B,cAAc,CAoC1B"}
1
+ {"version":3,"file":"SwaggerService.js","sourceRoot":"","sources":["../../../src/services/SwaggerService.ts"],"names":[],"mappings":";AACA,OAAO,EAAC,QAAQ,EAAE,UAAU,EAAC,MAAM,UAAU,CAAC;AAE9C,OAAO,EAAC,QAAQ,EAAC,MAAM,qBAAqB,CAAC;AAC7C,OAAO,EAAC,YAAY,EAAC,MAAM,cAAc,CAAC;AAG1C,OAAO,EAAC,YAAY,EAAC,MAAM,0BAA0B,CAAC;AACtD,OAAO,EAAC,QAAQ,EAAC,MAAM,sBAAsB,CAAC;AAGvC,IAAM,cAAc,GAApB,MAAM,cAAc;IACzB,MAAM,GAAuC,IAAI,GAAG,EAAE,CAAC;IAEvD,YAAoB,QAAkB;QAAlB,aAAQ,GAAR,QAAQ,CAAU;IAAG,CAAC;IASnC,KAAK,CAAC,cAAc,CAAC,IAAqB;QAC/C,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;YAChC,MAAM,OAAO,GAAG,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;YAC7C,MAAM,WAAW,GAAG,QAAQ,CAAS,aAAa,CAAC,CAAC;YACpD,MAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC;YAE/B,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,KAAa,EAAE,QAAQ,EAAE,KAAK,EAAC,CAAC,CAAC,CAAC;YAElF,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;QACnC,CAAC;QAED,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;CACF,CAAA;AApCY,cAAc;IAD1B,UAAU,EAAE;qCAImB,QAAQ;GAH3B,cAAc,CAoC1B"}
package/lib/esm/utils/readSpec.js ADDED
@@ -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
package/lib/esm/utils/readSpec.js.map ADDED
@@ -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,CAAC;QACxB,IAAI,CAAC;YACH,OAAO,MAAM,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAC,QAAQ,EAAE,MAAM,EAAC,CAAC,CAAC;QACrD,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC,CAAA,CAAC;IAChB,CAAC;IAED,0BAA0B;IAC1B,OAAO,EAAE,CAAC;AACZ,CAAC"}
package/lib/types/index.d.ts CHANGED
@@ -14,3 +14,4 @@ export * from "./services/SwaggerService.js";
14
14
  export * from "./SwaggerModule.js";
15
15
  export * from "./utils/includeRoute.js";
16
16
  export * from "./utils/matchPath.js";
17
+ export * from "./utils/readSpec.js";
package/lib/types/interfaces/SwaggerSettings.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
  */
package/lib/types/utils/readSpec.d.ts ADDED
@@ -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": "module",
5
- "version": "8.0.0-beta.8",
5
+ "version": "8.0.0-rc.1",
6
6
  "source": "./src/index.ts",
7
7
  "main": "./lib/esm/index.js",
8
8
  "module": "./lib/esm/index.js",
@@ -25,23 +25,23 @@
25
25
  "test:ci": "vitest run --coverage.thresholds.autoUpdate=true"
26
26
  },
27
27
  "dependencies": {
28
- "@tsed/normalize-path": "8.0.0-beta.8",
29
- "@tsed/openspec": "8.0.0-beta.8",
28
+ "@tsed/normalize-path": "8.0.0-rc.1",
29
+ "@tsed/openspec": "8.0.0-rc.1",
30
30
  "fs-extra": "11.2.0",
31
31
  "micromatch": "4.0.8",
32
32
  "swagger-ui-dist": ">=5.17.14",
33
33
  "tslib": "2.7.0"
34
34
  },
35
35
  "devDependencies": {
36
- "@tsed/barrels": "8.0.0-beta.8",
37
- "@tsed/core": "8.0.0-beta.8",
38
- "@tsed/di": "8.0.0-beta.8",
39
- "@tsed/json-mapper": "8.0.0-beta.8",
36
+ "@tsed/barrels": "8.0.0-rc.1",
37
+ "@tsed/core": "8.0.0-rc.1",
38
+ "@tsed/di": "8.0.0-rc.1",
39
+ "@tsed/json-mapper": "8.0.0-rc.1",
40
40
  "@tsed/monorepo-utils": "2.3.9",
41
- "@tsed/openspec": "8.0.0-beta.8",
42
- "@tsed/platform-http": "8.0.0-beta.8",
43
- "@tsed/schema": "8.0.0-beta.8",
44
- "@tsed/typescript": "8.0.0-beta.8",
41
+ "@tsed/openspec": "8.0.0-rc.1",
42
+ "@tsed/platform-http": "8.0.0-rc.1",
43
+ "@tsed/schema": "8.0.0-rc.1",
44
+ "@tsed/typescript": "8.0.0-rc.1",
45
45
  "@types/swagger-ui-dist": "3.30.5",
46
46
  "eslint": "9.12.0",
47
47
  "ts-node": "10.9.2",
@@ -49,7 +49,7 @@
49
49
  "vitest": "2.1.2"
50
50
  },
51
51
  "peerDependencies": {
52
- "@tsed/platform-http": "8.0.0-beta.8"
52
+ "@tsed/platform-http": "8.0.0-rc.1"
53
53
  },
54
54
  "peerDependenciesMeta": {
55
55
  "@tsed/common": {
@@ -64,6 +64,6 @@
64
64
  "author": "Romain Lenzotti",
65
65
  "license": "MIT",
66
66
  "publishConfig": {
67
- "tag": "beta"
67
+ "tag": "rc"
68
68
  }
69
69
  }