@tsed/swagger 7.0.0-alpha.1 → 7.0.0-beta.10

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 (85) hide show
  1. package/jest.config.js +14 -0
  2. package/lib/cjs/SwaggerModule.js +130 -0
  3. package/lib/cjs/SwaggerModule.js.map +1 -0
  4. package/lib/cjs/decorators/docs.js +18 -0
  5. package/lib/cjs/decorators/docs.js.map +1 -0
  6. package/lib/cjs/decorators/hidden.js +40 -0
  7. package/lib/cjs/decorators/hidden.js.map +1 -0
  8. package/lib/cjs/index.js +19 -0
  9. package/lib/cjs/index.js.map +1 -0
  10. package/lib/cjs/interfaces/SwaggerSettings.js +3 -0
  11. package/lib/cjs/interfaces/SwaggerSettings.js.map +1 -0
  12. package/lib/cjs/interfaces/interfaces.js +3 -0
  13. package/lib/cjs/interfaces/interfaces.js.map +1 -0
  14. package/lib/cjs/middlewares/cssMiddleware.js +23 -0
  15. package/lib/cjs/middlewares/cssMiddleware.js.map +1 -0
  16. package/lib/cjs/middlewares/indexMiddleware.js +24 -0
  17. package/lib/cjs/middlewares/indexMiddleware.js.map +1 -0
  18. package/lib/cjs/middlewares/jsMiddleware.js +18 -0
  19. package/lib/cjs/middlewares/jsMiddleware.js.map +1 -0
  20. package/lib/cjs/middlewares/redirectMiddleware.js +16 -0
  21. package/lib/cjs/middlewares/redirectMiddleware.js.map +1 -0
  22. package/lib/cjs/package.json +3 -0
  23. package/lib/cjs/services/SwaggerService.js +44 -0
  24. package/lib/cjs/services/SwaggerService.js.map +1 -0
  25. package/lib/cjs/utils/includeRoute.js +20 -0
  26. package/lib/cjs/utils/includeRoute.js.map +1 -0
  27. package/lib/cjs/utils/matchPath.js +10 -0
  28. package/lib/cjs/utils/matchPath.js.map +1 -0
  29. package/lib/esm/SwaggerModule.js +127 -0
  30. package/lib/esm/SwaggerModule.js.map +1 -0
  31. package/lib/esm/decorators/docs.js +14 -0
  32. package/lib/esm/decorators/docs.js.map +1 -0
  33. package/lib/esm/decorators/hidden.js +36 -0
  34. package/lib/esm/decorators/hidden.js.map +1 -0
  35. package/lib/esm/index.js +16 -0
  36. package/lib/esm/index.js.map +1 -0
  37. package/lib/esm/interfaces/SwaggerSettings.js +2 -0
  38. package/lib/esm/interfaces/SwaggerSettings.js.map +1 -0
  39. package/lib/esm/interfaces/interfaces.js +2 -0
  40. package/lib/esm/interfaces/interfaces.js.map +1 -0
  41. package/lib/esm/middlewares/cssMiddleware.js +18 -0
  42. package/lib/esm/middlewares/cssMiddleware.js.map +1 -0
  43. package/lib/esm/middlewares/indexMiddleware.js +20 -0
  44. package/lib/esm/middlewares/indexMiddleware.js.map +1 -0
  45. package/lib/esm/middlewares/jsMiddleware.js +13 -0
  46. package/lib/esm/middlewares/jsMiddleware.js.map +1 -0
  47. package/lib/esm/middlewares/redirectMiddleware.js +12 -0
  48. package/lib/esm/middlewares/redirectMiddleware.js.map +1 -0
  49. package/lib/esm/package.json +3 -0
  50. package/lib/esm/services/SwaggerService.js +41 -0
  51. package/lib/esm/services/SwaggerService.js.map +1 -0
  52. package/lib/esm/utils/includeRoute.js +16 -0
  53. package/lib/esm/utils/includeRoute.js.map +1 -0
  54. package/lib/esm/utils/matchPath.js +5 -0
  55. package/lib/esm/utils/matchPath.js.map +1 -0
  56. package/lib/{SwaggerModule.d.ts → types/SwaggerModule.d.ts} +6 -4
  57. package/lib/{decorators → types/decorators}/docs.d.ts +0 -0
  58. package/lib/{decorators → types/decorators}/hidden.d.ts +0 -0
  59. package/lib/types/index.d.ts +15 -0
  60. package/lib/{interfaces → types/interfaces}/SwaggerSettings.d.ts +0 -3
  61. package/lib/{interfaces/index.d.ts → types/interfaces/interfaces.d.ts} +0 -1
  62. package/lib/{middlewares → types/middlewares}/cssMiddleware.d.ts +0 -0
  63. package/lib/{middlewares → types/middlewares}/indexMiddleware.d.ts +0 -0
  64. package/lib/{middlewares → types/middlewares}/jsMiddleware.d.ts +0 -0
  65. package/lib/{middlewares → types/middlewares}/redirectMiddleware.d.ts +0 -0
  66. package/lib/types/services/SwaggerService.d.ts +17 -0
  67. package/lib/{utils → types/utils}/includeRoute.d.ts +1 -1
  68. package/lib/{utils → types/utils}/matchPath.d.ts +0 -0
  69. package/lib/views/index.ejs +145 -0
  70. package/lib/views/index.html +144 -0
  71. package/package.json +34 -24
  72. package/readme.md +71 -85
  73. package/tsconfig.compile.esm.json +24 -0
  74. package/lib/index.d.ts +0 -5
  75. package/lib/index.js +0 -629
  76. package/lib/index.js.map +0 -1
  77. package/lib/index.modern.js +0 -626
  78. package/lib/index.modern.js.map +0 -1
  79. package/lib/services/SwaggerService.d.ts +0 -29
  80. package/lib/utils/getSpecType.d.ts +0 -12
  81. package/lib/utils/index.d.ts +0 -7
  82. package/lib/utils/mapOpenSpec.d.ts +0 -10
  83. package/lib/utils/mapOpenSpec2.d.ts +0 -9
  84. package/lib/utils/mapOpenSpec3.d.ts +0 -8
  85. package/lib/utils/mapOpenSpecInfo.d.ts +0 -6
package/lib/services/SwaggerService.d.ts DELETED
@@ -1,29 +0,0 @@
1
- import { Configuration, ControllerProvider, InjectorService, Platform } from "@tsed/common";
2
- import { OpenSpec2, OpenSpec3 } from "@tsed/openspec";
3
- import { SpecSerializerOptions } from "@tsed/schema";
4
- import { SwaggerOS2Settings, SwaggerOS3Settings, SwaggerSettings } from "../interfaces/SwaggerSettings";
5
- export declare class SwaggerService {
6
- #private;
7
- private injectorService;
8
- private platform;
9
- private configuration;
10
- constructor(injectorService: InjectorService, platform: Platform, configuration: Configuration);
11
- /**
12
- * Generate Spec for the given configuration
13
- * @returns {Spec}
14
- */
15
- getOpenAPISpec(conf: SwaggerOS3Settings): OpenSpec3;
16
- getOpenAPISpec(conf: SwaggerOS2Settings): OpenSpec2;
17
- getOpenAPISpec(conf: SwaggerSettings): OpenSpec2;
18
- /**
19
- * Return the global api information.
20
- */
21
- protected getDefaultSpec(conf: Partial<SwaggerSettings>): Partial<OpenSpec2 | OpenSpec3>;
22
- protected readSpecPath(path: string): any;
23
- /**
24
- *
25
- * @param ctrl
26
- * @param options
27
- */
28
- protected buildRoutes(ctrl: ControllerProvider, options: SpecSerializerOptions): Partial<OpenSpec2>;
29
- }
package/lib/utils/getSpecType.d.ts DELETED
@@ -1,12 +0,0 @@
1
- import { OpenSpec2, OpenSpec3 } from "@tsed/openspec";
2
- import { SpecTypes } from "@tsed/schema";
3
- /**
4
- * @ignore
5
- * @param version
6
- */
7
- export declare function getSpecType(version: string): SpecTypes.SWAGGER | SpecTypes.OPENAPI;
8
- /**
9
- * @ignore
10
- * @param spec
11
- */
12
- export declare function getSpecTypeFromSpec(spec: Partial<OpenSpec2 | OpenSpec3>): SpecTypes.SWAGGER | SpecTypes.OPENAPI;
package/lib/utils/index.d.ts DELETED
@@ -1,7 +0,0 @@
1
- export * from "./getSpecType";
2
- export * from "./mapOpenSpec";
3
- export * from "./mapOpenSpec2";
4
- export * from "./mapOpenSpec3";
5
- export * from "./mapOpenSpecInfo";
6
- export * from "./mapOpenSpecInfo";
7
- export * from "./matchPath";
package/lib/utils/mapOpenSpec.d.ts DELETED
@@ -1,10 +0,0 @@
1
- import { OpenSpec2, OpenSpec3 } from "@tsed/openspec";
2
- /**
3
- * @ignore
4
- * @param spec
5
- * @param fileSpec
6
- * @param version
7
- * @param acceptMimes
8
- * @param specVersion
9
- */
10
- export declare function mapOpenSpec(spec: any, { fileSpec, acceptMimes, specVersion, version }: any): Partial<OpenSpec2 | OpenSpec3>;
package/lib/utils/mapOpenSpec2.d.ts DELETED
@@ -1,9 +0,0 @@
1
- import { OpenSpec2 } from "@tsed/openspec";
2
- /**
3
- * @ignore
4
- * @param spec
5
- * @param version
6
- * @param specVersion
7
- * @param acceptMimes
8
- */
9
- export declare function mapOpenSpec2(spec: Partial<OpenSpec2>, { version, specVersion, acceptMimes }: any): Partial<OpenSpec2>;
package/lib/utils/mapOpenSpec3.d.ts DELETED
@@ -1,8 +0,0 @@
1
- import { OpenSpec3 } from "@tsed/openspec";
2
- /**
3
- * @ignore
4
- * @param spec
5
- * @param version
6
- * @param specVersion
7
- */
8
- export declare function mapOpenSpec3(spec: any, { specVersion }: any): Partial<OpenSpec3>;
package/lib/utils/mapOpenSpecInfo.d.ts DELETED
@@ -1,6 +0,0 @@
1
- import { OpenSpecInfo } from "@tsed/openspec";
2
- /**
3
- * @ignore
4
- * @param info
5
- */
6
- export declare function mapOpenSpecInfo(info: Partial<OpenSpecInfo>): OpenSpecInfo;