@midwayjs/swagger 3.0.0-beta.10 → 3.0.0-beta.14

package/CHANGELOG.md

@@ -3,6 +3,50 @@
 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.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)
 
 

package/dist/decorators/api-body.decorator.d.ts

@@ -1,10 +1,18 @@
 import { ContentObject, ExamplesObject, ReferenceObject, RequestBodyObject, SchemaObject, SwaggerEnumType } from '../interfaces';
 declare type RequestBodyOptions = Omit<RequestBodyObject, 'content'>;
+export declare enum BodyContentType {
+    FormUrlEncoded = "application/x-www-form-urlencoded",
+    JSON = "application/json",
+    Multipart = "multipart/form-data",
+    MultipartMixed = "multipart/mixed",
+    OctetStream = "application/octet-stream"
+}
 interface ApiBodyMetadata extends RequestBodyOptions {
     type?: any;
     isArray?: boolean;
     enum?: SwaggerEnumType;
     content?: ContentObject;
+    contentType?: BodyContentType;
 }
 interface ApiBodySchemaHost extends RequestBodyOptions {
     schema: SchemaObject | ReferenceObject;

package/dist/decorators/api-body.decorator.js

@@ -1,8 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ApiBody = void 0;
+exports.ApiBody = exports.BodyContentType = void 0;
 const enum_utils_1 = require("../common/enum.utils");
 const helpers_1 = require("./helpers");
+var BodyContentType;
+(function (BodyContentType) {
+    BodyContentType["FormUrlEncoded"] = "application/x-www-form-urlencoded";
+    BodyContentType["JSON"] = "application/json";
+    BodyContentType["Multipart"] = "multipart/form-data";
+    BodyContentType["MultipartMixed"] = "multipart/mixed";
+    BodyContentType["OctetStream"] = "application/octet-stream";
+})(BodyContentType = exports.BodyContentType || (exports.BodyContentType = {}));
 const defaultBodyMetadata = {
     type: String,
     required: true,

package/dist/decorators/api-exclude-controller.decorator.js

@@ -4,9 +4,7 @@ exports.ApiExcludeController = void 0;
 const decorator_1 = require("@midwayjs/decorator");
 const constants_1 = require("../constants");
 function ApiExcludeController(disable = true) {
-    return (0, decorator_1.createCustomMethodDecorator)(constants_1.DECORATORS.API_EXCLUDE_CONTROLLER, [
-        disable,
-    ]);
+    return (0, decorator_1.createCustomMethodDecorator)(constants_1.DECORATORS.API_EXCLUDE_CONTROLLER, [disable], false);
 }
 exports.ApiExcludeController = ApiExcludeController;
 //# sourceMappingURL=api-exclude-controller.decorator.js.map

package/dist/decorators/api-exclude-endpoint.decorator.js

@@ -6,7 +6,7 @@ const constants_1 = require("../constants");
 function ApiExcludeEndpoint(disable = true) {
     return (0, decorator_1.createCustomMethodDecorator)(constants_1.DECORATORS.API_EXCLUDE_ENDPOINT, {
         disable,
-    });
+    }, false);
 }
 exports.ApiExcludeEndpoint = ApiExcludeEndpoint;
 //# sourceMappingURL=api-exclude-endpoint.decorator.js.map

package/dist/decorators/api-header.decorator.js

@@ -30,7 +30,7 @@ function ApiHeader(options) {
         if (descriptor) {
             return (0, helpers_1.createParamDecorator)(param, defaultHeaderOptions)(target, key, descriptor);
         }
-        return (0, decorator_1.createCustomMethodDecorator)(constants_1.DECORATORS.API_HEADERS, param)(target, undefined, undefined);
+        return (0, decorator_1.createCustomMethodDecorator)(constants_1.DECORATORS.API_HEADERS, param, false)(target, undefined, undefined);
     };
 }
 exports.ApiHeader = ApiHeader;

package/dist/decorators/api-operation.decorator.js

@@ -10,7 +10,7 @@ function ApiOperation(options) {
     return (0, decorator_1.createCustomMethodDecorator)(constants_1.DECORATORS.API_OPERATION, {
         ...defaultOperationOptions,
         ...options,
-    });
+    }, false);
 }
 exports.ApiOperation = ApiOperation;
 //# sourceMappingURL=api-operation.decorator.js.map

package/dist/decorators/api-property.decorator.js

@@ -14,7 +14,6 @@ function createApiPropertyDecorator(options = {}) {
     options = {
         ...options,
         type,
-        isArray,
     };
     if (isEnumArray(options)) {
         options.type = 'array';

package/dist/decorators/api-response.decorator.js

@@ -13,7 +13,7 @@ function ApiResponse(options) {
     const groupedMetadata = {
         [options.status || 'default']: options,
     };
-    return (0, decorator_1.createCustomMethodDecorator)(constants_1.DECORATORS.API_RESPONSE, groupedMetadata);
+    return (0, decorator_1.createCustomMethodDecorator)(constants_1.DECORATORS.API_RESPONSE, groupedMetadata, false);
 }
 exports.ApiResponse = ApiResponse;
 const ApiOkResponse = (options = {}) => ApiResponse({

package/dist/decorators/api-security.decorator.js

@@ -11,7 +11,7 @@ function ApiSecurity(name, requirements = []) {
     else {
         metadata = name;
     }
-    return (0, decorator_1.createCustomMethodDecorator)(constants_1.DECORATORS.API_SECURITY, metadata);
+    return (0, decorator_1.createCustomMethodDecorator)(constants_1.DECORATORS.API_SECURITY, metadata, false);
 }
 exports.ApiSecurity = ApiSecurity;
 //# sourceMappingURL=api-security.decorator.js.map

package/dist/decorators/helpers.js

@@ -4,18 +4,18 @@ exports.getSchemaPath = exports.getTypeIsArrayTuple = exports.createParamDecorat
 const decorator_1 = require("@midwayjs/decorator");
 const constants_1 = require("../constants");
 function createPropertyDecorator(metakey, metadata) {
-    return (0, decorator_1.createCustomPropertyDecorator)(metakey, metadata);
+    return (0, decorator_1.createCustomPropertyDecorator)(metakey, metadata, false);
 }
 exports.createPropertyDecorator = createPropertyDecorator;
 function createMixedDecorator(metakey, metadata) {
-    return (0, decorator_1.createCustomMethodDecorator)(metakey, metadata);
+    return (0, decorator_1.createCustomMethodDecorator)(metakey, metadata, false);
 }
 exports.createMixedDecorator = createMixedDecorator;
 function createParamDecorator(metadata, initial) {
     return (0, decorator_1.createCustomMethodDecorator)(constants_1.DECORATORS.API_PARAMETERS, {
         ...initial,
         ...metadata,
-    });
+    }, false);
 }
 exports.createParamDecorator = createParamDecorator;
 function getTypeIsArrayTuple(input, isArrayFlag) {

package/dist/swaggerExplorer.js

@@ -209,16 +209,19 @@ let SwaggerExplorer = class SwaggerExplorer {
             }
             this.parseFromParamsToP(params[params.length - 1 - arg.parameterIndex], p);
             if (p.in === 'body') {
+                if (!p.content) {
+                    p.content = {};
+                    p.content[p.contentType || 'application/json'] = {
+                        schema: p.schema,
+                    };
+                }
                 const requestBody = {
                     required: true,
                     description: p.description || p.name,
-                    content: p.content || {
-                        'application/json': {
-                            schema: p.schema,
-                        },
-                    },
+                    content: p.content,
                 };
                 opts[webRouter.requestMethod].requestBody = requestBody;
+                delete p.contentType;
                 delete p.content;
                 // in body 不需要处理
                 continue;
@@ -316,6 +319,9 @@ let SwaggerExplorer = class SwaggerExplorer {
                 if (param.deprecated) {
                     p.deprecated = param.deprecated;
                 }
+                if (param.contentType) {
+                    p.contentType = param.contentType;
+                }
                 p.in = (_a = param === null || param === void 0 ? void 0 : param.in) !== null && _a !== void 0 ? _a : p.in;
                 p.required = (_b = param === null || param === void 0 ? void 0 : param.required) !== null && _b !== void 0 ? _b : p.required;
                 if (p.in === 'query') {
@@ -380,42 +386,55 @@ let SwaggerExplorer = class SwaggerExplorer {
         };
         if (props) {
             Object.keys(props).forEach(key => {
-                var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p, _q, _r, _s, _t;
-                if ((_a = props[key].metadata) === null || _a === void 0 ? void 0 : _a.example) {
+                var _a, _b;
+                const metadata = props[key].metadata;
+                if (metadata === null || metadata === void 0 ? void 0 : metadata.example) {
                     if (!tt.example) {
                         tt.example = {};
                     }
-                    tt.example[key] = (_b = props[key].metadata) === null || _b === void 0 ? void 0 : _b.example;
+                    tt.example[key] = metadata === null || metadata === void 0 ? void 0 : metadata.example;
+                    delete metadata.example;
                 }
-                if (((_c = props[key].metadata) === null || _c === void 0 ? void 0 : _c.required) !== false) {
+                if ((metadata === null || metadata === void 0 ? void 0 : metadata.required) !== false) {
                     if (!tt.required) {
                         tt.required = [];
                     }
                     tt.required.push(key);
+                    delete metadata.required;
                 }
-                if ((_d = props[key].metadata) === null || _d === void 0 ? void 0 : _d.enum) {
+                if (metadata === null || metadata === void 0 ? void 0 : metadata.enum) {
                     tt.properties[key] = {
-                        type: (_e = props[key].metadata) === null || _e === void 0 ? void 0 : _e.type,
-                        enum: (_f = props[key].metadata) === null || _f === void 0 ? void 0 : _f.enum,
-                        default: (_g = props[key].metadata) === null || _g === void 0 ? void 0 : _g.default,
+                        type: metadata === null || metadata === void 0 ? void 0 : metadata.type,
+                        enum: metadata === null || metadata === void 0 ? void 0 : metadata.enum,
+                        default: metadata === null || metadata === void 0 ? void 0 : metadata.default,
                     };
+                    if (metadata === null || metadata === void 0 ? void 0 : metadata.description) {
+                        tt.properties[key].description = metadata === null || metadata === void 0 ? void 0 : metadata.description;
+                    }
                     return;
                 }
-                if ((_j = (_h = props[key].metadata) === null || _h === void 0 ? void 0 : _h.items) === null || _j === void 0 ? void 0 : _j.enum) {
+                if ((_a = metadata === null || metadata === void 0 ? void 0 : metadata.items) === null || _a === void 0 ? void 0 : _a.enum) {
                     tt.properties[key] = {
-                        type: (_k = props[key].metadata) === null || _k === void 0 ? void 0 : _k.type,
-                        items: (_l = props[key].metadata) === null || _l === void 0 ? void 0 : _l.items,
-                        default: (_m = props[key].metadata) === null || _m === void 0 ? void 0 : _m.default,
+                        type: metadata === null || metadata === void 0 ? void 0 : metadata.type,
+                        items: metadata === null || metadata === void 0 ? void 0 : metadata.items,
+                        default: metadata === null || metadata === void 0 ? void 0 : metadata.default,
                     };
+                    if (metadata === null || metadata === void 0 ? void 0 : metadata.description) {
+                        tt.properties[key].description = metadata === null || metadata === void 0 ? void 0 : metadata.description;
+                    }
                     return;
                 }
-                let currentType = (_o = props[key].metadata) === null || _o === void 0 ? void 0 : _o.type;
+                let isArray = false;
+                let currentType = metadata === null || metadata === void 0 ? void 0 : metadata.type;
+                metadata === null || metadata === void 0 ? true : delete metadata.type;
                 if (currentType === 'array') {
-                    currentType = (_q = (_p = props[key].metadata) === null || _p === void 0 ? void 0 : _p.items) === null || _q === void 0 ? void 0 : _q.type;
+                    isArray = true;
+                    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)) {
                     this.parseClzz(currentType);
-                    if (((_r = props[key].metadata) === null || _r === void 0 ? void 0 : _r.type) === 'array') {
+                    if (isArray) {
                         tt.properties[key] = {
                             type: 'array',
                             items: {
@@ -430,7 +449,7 @@ let SwaggerExplorer = class SwaggerExplorer {
                     }
                 }
                 else {
-                    if (((_s = props[key].metadata) === null || _s === void 0 ? void 0 : _s.type) === 'array') {
+                    if (isArray) {
                         tt.properties[key] = {
                             type: 'array',
                             items: {
@@ -441,10 +460,12 @@ let SwaggerExplorer = class SwaggerExplorer {
                     else {
                         tt.properties[key] = {
                             type: (0, decorator_1.getPropertyType)(clzz.prototype, key).name,
-                            format: (_t = props[key].metadata) === null || _t === void 0 ? void 0 : _t.format,
+                            format: metadata === null || metadata === void 0 ? void 0 : metadata.format,
                         };
+                        delete metadata.format;
                     }
                 }
+                Object.assign(tt.properties[key], metadata);
             });
         }
         this.documentBuilder.addSchema({

package/dist/swaggerMiddleware.d.ts

@@ -5,5 +5,6 @@ export declare class SwaggerMiddleware implements IMiddleware<IMidwayContext, Ne
     private swaggerExplorer;
     init(): Promise<void>;
     resolve(app: IMidwayApplication): (req: any, res: any, next: NextFunction) => Promise<any>;
+    static getName(): string;
 }
 //# sourceMappingURL=swaggerMiddleware.d.ts.map

package/dist/swaggerMiddleware.js

@@ -100,6 +100,9 @@ let SwaggerMiddleware = class SwaggerMiddleware {
             };
         }
     }
+    static getName() {
+        return 'swagger';
+    }
 };
 __decorate([
     (0, decorator_1.Config)('swagger'),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/swagger",
-  "version": "3.0.0-beta.10",
+  "version": "3.0.0-beta.14",
   "main": "dist/index",
   "typings": "index.d.ts",
   "files": [
@@ -9,11 +9,11 @@
     "index.d.ts"
   ],
   "devDependencies": {
-    "@midwayjs/core": "^3.0.0-beta.10",
-    "@midwayjs/decorator": "^3.0.0-beta.10",
-    "@midwayjs/koa": "^3.0.0-beta.10",
-    "@midwayjs/mock": "^3.0.0-beta.10",
-    "swagger-ui-dist": "^3.34.0"
+    "@midwayjs/core": "^3.0.0-beta.14",
+    "@midwayjs/decorator": "^3.0.0-beta.14",
+    "@midwayjs/koa": "^3.0.0-beta.14",
+    "@midwayjs/mock": "^3.0.0-beta.14",
+    "swagger-ui-dist": "4.1.3"
   },
   "author": "Kurten Chan <chinkurten@gmail.com>",
   "license": "MIT",
@@ -27,5 +27,5 @@
     "type": "git",
     "url": "https://github.com/midwayjs/midway.git"
   },
-  "gitHead": "153870f2e2dd6b17673ec7591e49224a6bd51b36"
+  "gitHead": "95695ada36190cf376e93a1a8866b3fb6dde06bc"
 }