@tsed/swagger 6.87.1 → 6.89.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.
Files changed (122) hide show
  1. package/lib/{SwaggerModule.d.ts → cjs/SwaggerModule.d.ts} +2 -0
  2. package/lib/cjs/SwaggerModule.js +135 -0
  3. package/lib/cjs/SwaggerModule.js.map +1 -0
  4. package/lib/{decorators → cjs/decorators}/docs.d.ts +0 -0
  5. package/lib/cjs/decorators/docs.js +18 -0
  6. package/lib/cjs/decorators/docs.js.map +1 -0
  7. package/lib/{decorators → cjs/decorators}/hidden.d.ts +0 -0
  8. package/lib/cjs/decorators/hidden.js +40 -0
  9. package/lib/cjs/decorators/hidden.js.map +1 -0
  10. package/lib/{index.d.ts → cjs/index.d.ts} +0 -0
  11. package/lib/cjs/index.js +9 -0
  12. package/lib/cjs/index.js.map +1 -0
  13. package/lib/{interfaces → cjs/interfaces}/SwaggerSettings.d.ts +0 -0
  14. package/lib/cjs/interfaces/SwaggerSettings.js +3 -0
  15. package/lib/cjs/interfaces/SwaggerSettings.js.map +1 -0
  16. package/lib/{interfaces → cjs/interfaces}/index.d.ts +0 -0
  17. package/lib/cjs/interfaces/index.js +5 -0
  18. package/lib/cjs/interfaces/index.js.map +1 -0
  19. package/lib/{middlewares → cjs/middlewares}/cssMiddleware.d.ts +0 -0
  20. package/lib/cjs/middlewares/cssMiddleware.js +23 -0
  21. package/lib/cjs/middlewares/cssMiddleware.js.map +1 -0
  22. package/lib/{middlewares → cjs/middlewares}/indexMiddleware.d.ts +0 -0
  23. package/lib/cjs/middlewares/indexMiddleware.js +24 -0
  24. package/lib/cjs/middlewares/indexMiddleware.js.map +1 -0
  25. package/lib/{middlewares → cjs/middlewares}/jsMiddleware.d.ts +0 -0
  26. package/lib/cjs/middlewares/jsMiddleware.js +18 -0
  27. package/lib/cjs/middlewares/jsMiddleware.js.map +1 -0
  28. package/lib/{middlewares → cjs/middlewares}/redirectMiddleware.d.ts +0 -0
  29. package/lib/cjs/middlewares/redirectMiddleware.js +16 -0
  30. package/lib/cjs/middlewares/redirectMiddleware.js.map +1 -0
  31. package/lib/{services → cjs/services}/SwaggerService.d.ts +0 -0
  32. package/lib/cjs/services/SwaggerService.js +103 -0
  33. package/lib/cjs/services/SwaggerService.js.map +1 -0
  34. package/lib/{utils → cjs/utils}/getSpecType.d.ts +0 -0
  35. package/lib/cjs/utils/getSpecType.js +21 -0
  36. package/lib/cjs/utils/getSpecType.js.map +1 -0
  37. package/lib/{utils → cjs/utils}/includeRoute.d.ts +0 -0
  38. package/lib/cjs/utils/includeRoute.js +20 -0
  39. package/lib/cjs/utils/includeRoute.js.map +1 -0
  40. package/lib/{utils → cjs/utils}/index.d.ts +0 -0
  41. package/lib/cjs/utils/index.js +11 -0
  42. package/lib/cjs/utils/index.js.map +1 -0
  43. package/lib/{utils → cjs/utils}/mapOpenSpec.d.ts +0 -0
  44. package/lib/cjs/utils/mapOpenSpec.js +40 -0
  45. package/lib/cjs/utils/mapOpenSpec.js.map +1 -0
  46. package/lib/{utils → cjs/utils}/mapOpenSpec2.d.ts +0 -0
  47. package/lib/cjs/utils/mapOpenSpec2.js +34 -0
  48. package/lib/cjs/utils/mapOpenSpec2.js.map +1 -0
  49. package/lib/{utils → cjs/utils}/mapOpenSpec3.d.ts +0 -0
  50. package/lib/cjs/utils/mapOpenSpec3.js +26 -0
  51. package/lib/cjs/utils/mapOpenSpec3.js.map +1 -0
  52. package/lib/{utils → cjs/utils}/mapOpenSpecInfo.d.ts +0 -0
  53. package/lib/cjs/utils/mapOpenSpecInfo.js +21 -0
  54. package/lib/cjs/utils/mapOpenSpecInfo.js.map +1 -0
  55. package/lib/{utils → cjs/utils}/matchPath.d.ts +0 -0
  56. package/lib/cjs/utils/matchPath.js +10 -0
  57. package/lib/cjs/utils/matchPath.js.map +1 -0
  58. package/lib/esm/SwaggerModule.js +132 -0
  59. package/lib/esm/SwaggerModule.js.map +1 -0
  60. package/lib/esm/decorators/docs.js +14 -0
  61. package/lib/esm/decorators/docs.js.map +1 -0
  62. package/lib/esm/decorators/hidden.js +36 -0
  63. package/lib/esm/decorators/hidden.js.map +1 -0
  64. package/lib/esm/index.js +6 -0
  65. package/lib/esm/index.js.map +1 -0
  66. package/lib/esm/interfaces/SwaggerSettings.js +2 -0
  67. package/lib/esm/interfaces/SwaggerSettings.js.map +1 -0
  68. package/lib/esm/interfaces/index.js +2 -0
  69. package/lib/esm/interfaces/index.js.map +1 -0
  70. package/lib/esm/middlewares/cssMiddleware.js +18 -0
  71. package/lib/esm/middlewares/cssMiddleware.js.map +1 -0
  72. package/lib/esm/middlewares/indexMiddleware.js +20 -0
  73. package/lib/esm/middlewares/indexMiddleware.js.map +1 -0
  74. package/lib/esm/middlewares/jsMiddleware.js +13 -0
  75. package/lib/esm/middlewares/jsMiddleware.js.map +1 -0
  76. package/lib/esm/middlewares/redirectMiddleware.js +12 -0
  77. package/lib/esm/middlewares/redirectMiddleware.js.map +1 -0
  78. package/lib/esm/services/SwaggerService.js +100 -0
  79. package/lib/esm/services/SwaggerService.js.map +1 -0
  80. package/lib/esm/utils/getSpecType.js +16 -0
  81. package/lib/esm/utils/getSpecType.js.map +1 -0
  82. package/lib/esm/utils/includeRoute.js +16 -0
  83. package/lib/esm/utils/includeRoute.js.map +1 -0
  84. package/lib/esm/utils/index.js +8 -0
  85. package/lib/esm/utils/index.js.map +1 -0
  86. package/lib/esm/utils/mapOpenSpec.js +36 -0
  87. package/lib/esm/utils/mapOpenSpec.js.map +1 -0
  88. package/lib/esm/utils/mapOpenSpec2.js +30 -0
  89. package/lib/esm/utils/mapOpenSpec2.js.map +1 -0
  90. package/lib/esm/utils/mapOpenSpec3.js +22 -0
  91. package/lib/esm/utils/mapOpenSpec3.js.map +1 -0
  92. package/lib/esm/utils/mapOpenSpecInfo.js +17 -0
  93. package/lib/esm/utils/mapOpenSpecInfo.js.map +1 -0
  94. package/lib/esm/utils/matchPath.js +5 -0
  95. package/lib/esm/utils/matchPath.js.map +1 -0
  96. package/lib/types/SwaggerModule.d.ts +30 -0
  97. package/lib/types/decorators/docs.d.ts +10 -0
  98. package/lib/types/decorators/hidden.d.ts +32 -0
  99. package/lib/types/index.d.ts +5 -0
  100. package/lib/types/interfaces/SwaggerSettings.d.ts +99 -0
  101. package/lib/types/interfaces/index.d.ts +9 -0
  102. package/lib/types/middlewares/cssMiddleware.d.ts +6 -0
  103. package/lib/types/middlewares/indexMiddleware.d.ts +10 -0
  104. package/lib/types/middlewares/jsMiddleware.d.ts +6 -0
  105. package/lib/types/middlewares/redirectMiddleware.d.ts +6 -0
  106. package/lib/types/services/SwaggerService.d.ts +29 -0
  107. package/lib/types/utils/getSpecType.d.ts +12 -0
  108. package/lib/types/utils/includeRoute.d.ts +3 -0
  109. package/lib/types/utils/index.d.ts +7 -0
  110. package/lib/types/utils/mapOpenSpec.d.ts +10 -0
  111. package/lib/types/utils/mapOpenSpec2.d.ts +9 -0
  112. package/lib/types/utils/mapOpenSpec3.d.ts +8 -0
  113. package/lib/types/utils/mapOpenSpecInfo.d.ts +6 -0
  114. package/lib/types/utils/matchPath.d.ts +1 -0
  115. package/lib/views/index.ejs +145 -0
  116. package/lib/views/index.html +144 -0
  117. package/package.json +22 -18
  118. package/tsconfig.compile.esm.json +24 -0
  119. package/lib/index.js +0 -614
  120. package/lib/index.js.map +0 -1
  121. package/lib/index.modern.js +0 -608
  122. package/lib/index.modern.js.map +0 -1
package/lib/views/index.ejs ADDED
@@ -0,0 +1,145 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <title>Swagger UI</title>
6
+ <link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700|Source+Code+Pro:300,600|Titillium+Web:400,600,700"
7
+ rel="stylesheet">
8
+ <link rel="stylesheet" type="text/css" href="./swagger-ui.css">
9
+ <link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32"/>
10
+ <link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16"/>
11
+ <style>
12
+ html {
13
+ box-sizing: border-box;
14
+ overflow: -moz-scrollbars-vertical;
15
+ overflow-y: scroll;
16
+ }
17
+
18
+ *,
19
+ *:before,
20
+ *:after {
21
+ box-sizing: inherit;
22
+ }
23
+
24
+ body {
25
+ margin: 0;
26
+ background: #fafafa;
27
+ }
28
+
29
+ <% if (!showExplorer) { %>
30
+ .swagger-ui .topbar .download-url-wrapper {
31
+ display: none
32
+ }
33
+
34
+ <% } %>
35
+ </style>
36
+ <% if (cssPath) { %>
37
+ <link rel="stylesheet" type="text/css" href="./main.css">
38
+ <% } %>
39
+ </head>
40
+
41
+ <body>
42
+ <div id="swagger-ui"></div>
43
+
44
+ <script src="./swagger-ui-bundle.js"></script>
45
+ <script src="./swagger-ui-standalone-preset.js"></script>
46
+ <script>
47
+ if (typeof Object.assign !== 'function') {
48
+ // Must be writable: true, enumerable: false, configurable: true
49
+ Object.defineProperty(Object, "assign", {
50
+ value: function assign(target, varArgs) { // .length of function is 2
51
+ 'use strict';
52
+ if (target == null) { // TypeError if undefined or null
53
+ throw new TypeError('Cannot convert undefined or null to object');
54
+ }
55
+
56
+ var to = Object(target);
57
+
58
+ for (var index = 1; index < arguments.length; index++) {
59
+ var nextSource = arguments[index];
60
+
61
+ if (nextSource != null) { // Skip over if undefined or null
62
+ for (var nextKey in nextSource) {
63
+ // Avoid bugs when hasOwnProperty is shadowed
64
+ if (Object.prototype.hasOwnProperty.call(nextSource, nextKey)) {
65
+ to[nextKey] = nextSource[nextKey];
66
+ }
67
+ }
68
+ }
69
+ }
70
+ return to;
71
+ },
72
+ writable: true,
73
+ configurable: true
74
+ });
75
+ }
76
+ </script>
77
+ <script>
78
+ const origin = window.location.origin;
79
+ const initialOptions = <%- JSON.stringify(swaggerOptions) %>;
80
+ const currentUrl = origin + "<%- url %>";
81
+ const urls = <%- JSON.stringify(urls) %>
82
+ .map(function (o) {
83
+ if (!o.url.match(/^https?:/)) {
84
+ const url = origin + o.url;
85
+ return {
86
+ name: o.name,
87
+ url: url,
88
+ selected: url === currentUrl
89
+ }
90
+ }
91
+ return o;
92
+ })
93
+ .sort(function (a, b) {
94
+ return a.selected ? -1 : 1
95
+ });
96
+
97
+ const SwaggerUIBuilder = {
98
+ config: Object.assign({
99
+ urls: urls,
100
+ dom_id: '#swagger-ui',
101
+ deepLinking: true,
102
+ presets: [
103
+ SwaggerUIBundle.presets.apis,
104
+ SwaggerUIStandalonePreset
105
+ ],
106
+ plugins: [
107
+ SwaggerUIBundle.plugins.DownloadUrl
108
+ ],
109
+ layout: "StandaloneLayout",
110
+ oauth2RedirectUrl: currentUrl.replace('swagger.json', 'oauth2-redirect.html'),
111
+ validatorUrl: origin.match('0.0.0.0') || origin.match('localhost') ? null : undefined
112
+ }, initialOptions),
113
+ /**
114
+ *
115
+ */
116
+ init: function () {
117
+ this.ui = SwaggerUIBundle(this.config);
118
+
119
+ if (this.config.oauth) {
120
+ this.ui.initOAuth(this.config.oauth);
121
+ }
122
+
123
+ if (this.config.authorize) {
124
+ this.ui.authActions.authorize(this.config.authorize);
125
+ }
126
+
127
+ window.ui = this.ui;
128
+
129
+ const event = new Event('swagger.init');
130
+ document.dispatchEvent(event);
131
+ }
132
+ }
133
+
134
+ </script>
135
+ <% if (jsPath) { %>
136
+ <script src="./main.js"></script>
137
+ <% } %>
138
+ <script>
139
+ window.onload = function () {
140
+ SwaggerUIBuilder.init();
141
+ }
142
+ </script>
143
+
144
+ </body>
145
+ </html>
package/lib/views/index.html ADDED
@@ -0,0 +1,144 @@
1
+ <!DOCTYPE html>
2
+ <html lang="en">
3
+ <head>
4
+ <meta charset="UTF-8">
5
+ <title>Swagger UI</title>
6
+ <link href="https://fonts.googleapis.com/css?family=Open+Sans:400,700|Source+Code+Pro:300,600|Titillium+Web:400,600,700"
7
+ rel="stylesheet">
8
+ <link rel="stylesheet" type="text/css" href="./swagger-ui.css">
9
+ <link rel="icon" type="image/png" href="./favicon-32x32.png" sizes="32x32"/>
10
+ <link rel="icon" type="image/png" href="./favicon-16x16.png" sizes="16x16"/>
11
+ <style>
12
+ html {
13
+ box-sizing: border-box;
14
+ overflow: -moz-scrollbars-vertical;
15
+ overflow-y: scroll;
16
+ }
17
+
18
+ *,
19
+ *:before,
20
+ *:after {
21
+ box-sizing: inherit;
22
+ }
23
+
24
+ body {
25
+ margin: 0;
26
+ background: #fafafa;
27
+ }
28
+
29
+
30
+ .swagger-ui .topbar .download-url-wrapper {
31
+ display: none
32
+ }
33
+
34
+
35
+ </style>
36
+
37
+ <link rel="stylesheet" type="text/css" href="./main.css">
38
+
39
+ </head>
40
+
41
+ <body>
42
+ <div id="swagger-ui"></div>
43
+
44
+ <script src="./swagger-ui-bundle.js"></script>
45
+ <script src="./swagger-ui-standalone-preset.js"></script>
46
+ <script>
47
+ if (typeof Object.assign !== 'function') {
48
+ // Must be writable: true, enumerable: false, configurable: true
49
+ Object.defineProperty(Object, "assign", {
50
+ value: function assign(target, varArgs) { // .length of function is 2
51
+ 'use strict';
52
+ if (target == null) { // TypeError if undefined or null
53
+ throw new TypeError('Cannot convert undefined or null to object');
54
+ }
55
+
56
+ var to = Object(target);
57
+
58
+ for (var index = 1; index < arguments.length; index++) {
59
+ var nextSource = arguments[index];
60
+
61
+ if (nextSource != null) { // Skip over if undefined or null
62
+ for (var nextKey in nextSource) {
63
+ // Avoid bugs when hasOwnProperty is shadowed
64
+ if (Object.prototype.hasOwnProperty.call(nextSource, nextKey)) {
65
+ to[nextKey] = nextSource[nextKey];
66
+ }
67
+ }
68
+ }
69
+ }
70
+ return to;
71
+ },
72
+ writable: true,
73
+ configurable: true
74
+ });
75
+ }
76
+ </script>
77
+ <script>
78
+ const origin = window.location.origin;
79
+ const initialOptions = {};
80
+ const currentUrl = origin + "/doc/swagger.json";
81
+ const urls = []
82
+ .map(function (o) {
83
+ if (!o.url.match(/^https?:/)) {
84
+ const url = origin + o.url;
85
+ return {
86
+ name: o.name,
87
+ url: url,
88
+ selected: url === currentUrl
89
+ }
90
+ }
91
+ return o;
92
+ })
93
+ .sort(function (a, b) {
94
+ return a.selected ? -1 : 1
95
+ });
96
+
97
+ const SwaggerUIBuilder = {
98
+ config: Object.assign({
99
+ urls: urls,
100
+ dom_id: '#swagger-ui',
101
+ deepLinking: true,
102
+ presets: [
103
+ SwaggerUIBundle.presets.apis,
104
+ SwaggerUIStandalonePreset
105
+ ],
106
+ plugins: [
107
+ SwaggerUIBundle.plugins.DownloadUrl
108
+ ],
109
+ layout: "StandaloneLayout",
110
+ validatorUrl: origin.match('0.0.0.0') || origin.match('localhost') ? null : undefined
111
+ }, initialOptions),
112
+ /**
113
+ *
114
+ */
115
+ init: function () {
116
+ this.ui = SwaggerUIBundle(this.config);
117
+
118
+ if (this.config.oauth) {
119
+ this.ui.initOAuth(this.config.oauth);
120
+ }
121
+
122
+ if (this.config.authorize) {
123
+ this.ui.authActions.authorize(this.config.authorize);
124
+ }
125
+
126
+ window.ui = this.ui;
127
+
128
+ const event = new Event('swagger.init');
129
+ document.dispatchEvent(event);
130
+ }
131
+ }
132
+
133
+ </script>
134
+
135
+ <script src="./main.js"></script>
136
+
137
+ <script>
138
+ window.onload = function () {
139
+ SwaggerUIBuilder.init();
140
+ }
141
+ </script>
142
+
143
+ </body>
144
+ </html>
package/package.json CHANGED
@@ -1,17 +1,21 @@
1
1
  {
2
2
  "name": "@tsed/swagger",
3
- "version": "6.87.1",
3
+ "version": "6.89.0",
4
4
  "description": "Swagger package for Ts.ED framework",
5
5
  "private": false,
6
6
  "source": "./src/index.ts",
7
- "main": "./lib/index.js",
8
- "typings": "./lib/index.d.ts",
7
+ "main": "./lib/cjs/index.js",
8
+ "typings": "./lib/types/index.d.ts",
9
9
  "exports": {
10
- "require": "./lib/index.js",
11
- "default": "./lib/index.modern.js"
10
+ "types": "./lib/types/index.d.ts",
11
+ "import": "./lib/esm/index.js",
12
+ "require": "./lib/cjs/index.js",
13
+ "default": "./lib/esm/index.js"
12
14
  },
13
15
  "scripts": {
14
- "build": "microbundle --target node --no-compress --format modern,cjs --tsconfig ./tsconfig.compile.json",
16
+ "build": "yarn run build:esm && yarn run build:cjs && cp -r ./views ./lib/views",
17
+ "build:cjs": "tsc --build tsconfig.compile.json",
18
+ "build:esm": "tsc --build tsconfig.compile.esm.json",
15
19
  "start": "ts-node -r tsconfig-paths/register test/app/index.ts"
16
20
  },
17
21
  "dependencies": {
@@ -21,20 +25,20 @@
21
25
  "tslib": "2.2.0"
22
26
  },
23
27
  "devDependencies": {
24
- "@tsed/common": "6.87.1",
25
- "@tsed/core": "6.87.1",
26
- "@tsed/di": "6.87.1",
27
- "@tsed/json-mapper": "6.87.1",
28
- "@tsed/openspec": "6.87.1",
29
- "@tsed/schema": "6.87.1"
28
+ "@tsed/common": "6.89.0",
29
+ "@tsed/core": "6.89.0",
30
+ "@tsed/di": "6.89.0",
31
+ "@tsed/json-mapper": "6.89.0",
32
+ "@tsed/openspec": "6.89.0",
33
+ "@tsed/schema": "6.89.0"
30
34
  },
31
35
  "peerDependencies": {
32
- "@tsed/common": "^6.87.1",
33
- "@tsed/core": "^6.87.1",
34
- "@tsed/di": "^6.87.1",
35
- "@tsed/json-mapper": "^6.87.1",
36
- "@tsed/openspec": "^6.87.1",
37
- "@tsed/schema": "^6.87.1"
36
+ "@tsed/common": "^6.89.0",
37
+ "@tsed/core": "^6.89.0",
38
+ "@tsed/di": "^6.89.0",
39
+ "@tsed/json-mapper": "^6.89.0",
40
+ "@tsed/openspec": "^6.89.0",
41
+ "@tsed/schema": "^6.89.0"
38
42
  },
39
43
  "repository": "https://github.com/tsedio/tsed",
40
44
  "bugs": {
package/tsconfig.compile.esm.json ADDED
@@ -0,0 +1,24 @@
1
+ {
2
+ "extends": "./tsconfig.compile.json",
3
+ "compilerOptions": {
4
+ "baseUrl": ".",
5
+ "module": "ES2020",
6
+ "rootDir": "src",
7
+ "outDir": "./lib/esm",
8
+ "declaration": true,
9
+ "declarationDir": "./lib/types"
10
+ },
11
+ "exclude": [
12
+ "node_modules",
13
+ "test",
14
+ "lib",
15
+ "benchmark",
16
+ "coverage",
17
+ "spec",
18
+ "views",
19
+ "**/*.benchmark.ts",
20
+ "**/*.spec.ts",
21
+ "keys",
22
+ "jest.config.js"
23
+ ]
24
+ }