@midwayjs/swagger 3.0.0-beta.15 → 3.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2013 - Now midwayjs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/dist/documentBuilder.d.ts

@@ -21,6 +21,7 @@ export declare class DocumentBuilder {
     addApiKey(options?: SecuritySchemeObject, name?: string): this;
     addBasicAuth(options?: SecuritySchemeObject, name?: string): this;
     addCookieAuth(cookieName?: string, options?: SecuritySchemeObject, securityName?: string): this;
+    sortTags(): void;
     build(): Omit<OpenAPIObject, 'paths'>;
 }
 //# sourceMappingURL=documentBuilder.d.ts.map

package/dist/documentBuilder.js

@@ -78,7 +78,11 @@ class DocumentBuilder {
         return this;
     }
     getSchema(name) {
-        return this.document.components.schemas[name];
+        var _a, _b;
+        if ((_a = this.document.components) === null || _a === void 0 ? void 0 : _a.schemas) {
+            return (_b = this.document.components) === null || _b === void 0 ? void 0 : _b.schemas[name];
+        }
+        return undefined;
     }
     addTag(name, description = '', externalDocs) {
         if (Array.isArray(name)) {
@@ -187,6 +191,23 @@ class DocumentBuilder {
         });
         return this;
     }
+    sortTags() {
+        const tags = this.document.tags;
+        this.document.tags = tags.sort((a, b) => {
+            const s1 = a.name;
+            const s2 = b.name;
+            const len = s1.length > s2.length ? s2.length : s1.length;
+            for (let i = 0; i < len; i++) {
+                if (s1.charCodeAt(i) > s2.charCodeAt(i)) {
+                    return 1;
+                }
+                else if (s1.charCodeAt(i) < s2.charCodeAt(i)) {
+                    return -1;
+                }
+            }
+            return 0;
+        });
+    }
     build() {
         return this.document;
     }

package/dist/interfaces/index.d.ts

@@ -335,5 +335,10 @@ export interface SwaggerOptions {
      * 访问 swagger ui 的路径
      */
     swaggerPath?: string;
+    /**
+     * 对路由 tag 进行 ascii 排序
+     * 可以使用 1-xxx、2-xxx、3-xxx 来定义 tag
+     */
+    tagSortable?: boolean;
 }
 //# sourceMappingURL=index.d.ts.map

package/dist/swaggerExplorer.js

@@ -63,10 +63,14 @@ let SwaggerExplorer = class SwaggerExplorer {
         }
     }
     scanApp() {
+        var _a;
         const routes = (0, decorator_1.listModule)(decorator_1.CONTROLLER_KEY);
         for (const route of routes) {
             this.generatePath(route);
         }
+        if ((_a = this.swaggerConfig) === null || _a === void 0 ? void 0 : _a.tagSortable) {
+            this.documentBuilder.sortTags();
+        }
     }
     getData() {
         return this.documentBuilder.build();
@@ -99,11 +103,12 @@ let SwaggerExplorer = class SwaggerExplorer {
                     (controllerOption === null || controllerOption === void 0 ? void 0 : controllerOption.routerOptions.description) || tag.name;
             }
             else {
-                tag.name = (controllerOption === null || controllerOption === void 0 ? void 0 : controllerOption.routerOptions.tagName) || 'default';
+                tag.name = controllerOption === null || controllerOption === void 0 ? void 0 : controllerOption.routerOptions.tagName;
                 tag.description =
                     (controllerOption === null || controllerOption === void 0 ? void 0 : controllerOption.routerOptions.description) || tag.name;
             }
             if (tag.name) {
+                strTags.push(tag.name);
                 this.documentBuilder.addTag(tag.name, tag.description);
             }
         }
@@ -197,7 +202,7 @@ let SwaggerExplorer = class SwaggerExplorer {
                     continue;
                 }
             }
-            if ((0, decorator_1.isClass)(currentType)) {
+            if (decorator_1.Types.isClass(currentType)) {
                 this.parseClzz(currentType);
                 p.schema = {
                     $ref: '#/components/schemas/' + currentType.name,
@@ -213,6 +218,7 @@ let SwaggerExplorer = class SwaggerExplorer {
                 // 这里兼容一下 @File()、@Files()、@Fields() 装饰器
                 if (((_j = arg.metadata) === null || _j === void 0 ? void 0 : _j.type) === decorator_1.RouteParamTypes.FILESSTREAM) {
                     p.schema = {
+                        type: 'object',
                         properties: {
                             files: {
                                 type: 'array',
@@ -228,6 +234,7 @@ let SwaggerExplorer = class SwaggerExplorer {
                 }
                 if (((_k = arg.metadata) === null || _k === void 0 ? void 0 : _k.type) === decorator_1.RouteParamTypes.FILESTREAM) {
                     p.schema = {
+                        type: 'object',
                         properties: {
                             file: {
                                 type: 'string',
@@ -289,7 +296,7 @@ let SwaggerExplorer = class SwaggerExplorer {
                 // 这里是引用，赋值可以直接更改
                 const tt = resp[k];
                 if (tt.type) {
-                    if ((0, decorator_1.isClass)(tt.type)) {
+                    if (decorator_1.Types.isClass(tt.type)) {
                         this.parseClzz(tt.type);
                         if (tt.isArray) {
                             tt.content = {
@@ -389,7 +396,7 @@ let SwaggerExplorer = class SwaggerExplorer {
                 }
                 else {
                     if (param.type) {
-                        if ((0, decorator_1.isClass)(param.type)) {
+                        if (decorator_1.Types.isClass(param.type)) {
                             this.parseClzz(param.type);
                             p.schema = {
                                 $ref: '#/components/schemas/' + param.type.name,
@@ -425,6 +432,9 @@ let SwaggerExplorer = class SwaggerExplorer {
      * @param clzz
      */
     parseClzz(clzz) {
+        if (this.documentBuilder.getSchema(clzz.name)) {
+            return;
+        }
         const props = (0, decorator_1.getClassMetadata)(decorator_1.INJECT_CUSTOM_PROPERTY, clzz);
         const tt = {
             type: 'object',
@@ -478,7 +488,7 @@ let SwaggerExplorer = class SwaggerExplorer {
                     currentType = (_b = metadata === null || metadata === void 0 ? void 0 : metadata.items) === null || _b === void 0 ? void 0 : _b.type;
                     delete metadata.items;
                 }
-                if ((0, decorator_1.isClass)(currentType)) {
+                if (decorator_1.Types.isClass(currentType)) {
                     this.parseClzz(currentType);
                     if (isArray) {
                         tt.properties[key] = {
@@ -644,7 +654,7 @@ function convertSchemaType(value) {
         case 'String':
             return 'string';
         default:
-            return 'object';
+            return value;
     }
 }
 //# sourceMappingURL=swaggerExplorer.js.map

package/index.d.ts

@@ -3,6 +3,6 @@ export * from './dist/index';
 
 declare module '@midwayjs/core/dist/interface' {
   interface MidwayConfig {
-    swagger: Partial<SwaggerOptions>;
+    swagger?: Partial<SwaggerOptions>;
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/swagger",
-  "version": "3.0.0-beta.15",
+  "version": "3.0.0",
   "main": "dist/index",
   "typings": "index.d.ts",
   "files": [
@@ -9,23 +9,23 @@
     "index.d.ts"
   ],
   "devDependencies": {
-    "@midwayjs/core": "^3.0.0-beta.15",
-    "@midwayjs/decorator": "^3.0.0-beta.15",
-    "@midwayjs/koa": "^3.0.0-beta.15",
-    "@midwayjs/mock": "^3.0.0-beta.15",
-    "swagger-ui-dist": "4.1.3"
+    "@midwayjs/core": "^3.0.0",
+    "@midwayjs/decorator": "^3.0.0",
+    "@midwayjs/koa": "^3.0.0",
+    "@midwayjs/mock": "^3.0.0",
+    "swagger-ui-dist": "4.2.1"
   },
   "author": "Kurten Chan <chinkurten@gmail.com>",
   "license": "MIT",
   "scripts": {
     "build": "tsc",
     "jest": "node --require=ts-node/register ../../node_modules/jest/bin/jest.js",
-    "test": "node --require=ts-node/register ../../node_modules/.bin/jest",
-    "cov": "node --require=ts-node/register ../../node_modules/.bin/jest --coverage --forceExit"
+    "test": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand",
+    "cov": "node --require=ts-node/register ../../node_modules/.bin/jest --runInBand --coverage --forceExit"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/midwayjs/midway.git"
   },
-  "gitHead": "6b9778557289d9e8b562c7ce6127736db1248973"
+  "gitHead": "55c26029bccf7bbb739fa1597e8f418dafa2caa0"
 }

package/CHANGELOG.md

@@ -1,68 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-# [3.0.0-beta.15](https://github.com/midwayjs/midway/compare/v3.0.0-beta.14...v3.0.0-beta.15) (2022-01-07)
-
-
-### Features
-
-* compatible with @File/@Files/@Fields ([#1527](https://github.com/midwayjs/midway/issues/1527)) ([3fe983f](https://github.com/midwayjs/midway/commit/3fe983f2a67c366af370c41df98510adf5dab289))
-
-
-
-
-
-# [3.0.0-beta.14](https://github.com/midwayjs/midway/compare/v3.0.0-beta.13...v3.0.0-beta.14) (2022-01-04)
-
-**Note:** Version bump only for package @midwayjs/swagger
-
-
-
-
-
-# [3.0.0-beta.13](https://github.com/midwayjs/midway/compare/v3.0.0-beta.12...v3.0.0-beta.13) (2021-12-30)
-
-
-### Features
-
-* add custom decorator filter ([#1477](https://github.com/midwayjs/midway/issues/1477)) ([97501a9](https://github.com/midwayjs/midway/commit/97501a989abc211b0c7400b1df45e050bb237c6a))
-
-
-
-
-
-# [3.0.0-beta.12](https://github.com/midwayjs/midway/compare/v3.0.0-beta.11...v3.0.0-beta.12) (2021-12-28)
-
-
-### Bug Fixes
-
-* 3.x copy all properties ([#1444](https://github.com/midwayjs/midway/issues/1444)) ([21ec8b6](https://github.com/midwayjs/midway/commit/21ec8b6a85b6ba3f4fbff0c8a571484aaa078788))
-
-
-### Features
-
-* add fileupload support ([#1439](https://github.com/midwayjs/midway/issues/1439)) ([0a81e72](https://github.com/midwayjs/midway/commit/0a81e720f525ddab0718301f44f80fce376f9bfe))
-* support throw err status ([#1440](https://github.com/midwayjs/midway/issues/1440)) ([7b98110](https://github.com/midwayjs/midway/commit/7b98110d65c5287a8fcb3eb5356dea2d7a32cee9))
-
-
-
-
-
-# [3.0.0-beta.11](https://github.com/midwayjs/midway/compare/v3.0.0-beta.10...v3.0.0-beta.11) (2021-12-21)
-
-**Note:** Version bump only for package @midwayjs/swagger
-
-
-
-
-
-# [3.0.0-beta.10](https://github.com/midwayjs/midway/compare/v3.0.0-beta.9...v3.0.0-beta.10) (2021-12-20)
-
-
-### Features
-
-* 3.x swagger ([#1409](https://github.com/midwayjs/midway/issues/1409)) ([e00fbbf](https://github.com/midwayjs/midway/commit/e00fbbf7a494f300a53f3bd8635966364cfd96a9))
-* add swagger doc & fix bug ([#1427](https://github.com/midwayjs/midway/issues/1427)) ([82dc6f1](https://github.com/midwayjs/midway/commit/82dc6f10f7244a75f58922edda1b0625fc6cb90e))
-* support express ([61e73db](https://github.com/midwayjs/midway/commit/61e73db509bfea21c8251855fccb02a4ce09988f))