@midwayjs/swagger 3.9.9 → 3.10.0

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

@@ -1,5 +1,5 @@
 import { ContentObject, ExamplesObject, ReferenceObject, RequestBodyObject, SchemaObject, SwaggerEnumType } from '../interfaces';
-declare type RequestBodyOptions = Omit<RequestBodyObject, 'content'>;
+type RequestBodyOptions = Omit<RequestBodyObject, 'content'>;
 export declare enum BodyContentType {
     FormUrlEncoded = "application/x-www-form-urlencoded",
     JSON = "application/json",
@@ -18,7 +18,7 @@ interface ApiBodySchemaHost extends RequestBodyOptions {
     schema: SchemaObject | ReferenceObject;
     examples?: ExamplesObject;
 }
-export declare type ApiBodyOptions = ApiBodyMetadata | ApiBodySchemaHost;
+export type ApiBodyOptions = ApiBodyMetadata | ApiBodySchemaHost;
 export declare function ApiBody(options: ApiBodyOptions): MethodDecorator;
 export {};
 //# sourceMappingURL=api-body.decorator.d.ts.map

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

@@ -1,4 +1,4 @@
 import { OperationObject } from '../interfaces';
-export declare type ApiOperationOptions = Partial<OperationObject>;
+export type ApiOperationOptions = Partial<OperationObject>;
 export declare function ApiOperation(options: ApiOperationOptions): MethodDecorator;
 //# sourceMappingURL=api-operation.decorator.d.ts.map

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

@@ -1,5 +1,5 @@
 import { Type, ParameterObject, SchemaObject, SwaggerEnumType } from '../interfaces';
-declare type ParameterOptions = Omit<ParameterObject, 'in' | 'schema'>;
+type ParameterOptions = Omit<ParameterObject, 'in' | 'schema'>;
 interface ApiParamMetadata extends ParameterOptions {
     type?: Type | string;
     format?: string;
@@ -9,7 +9,7 @@ interface ApiParamMetadata extends ParameterOptions {
 interface ApiParamSchemaHost extends ParameterOptions {
     schema: SchemaObject;
 }
-export declare type ApiParamOptions = ApiParamMetadata | ApiParamSchemaHost;
+export type ApiParamOptions = ApiParamMetadata | ApiParamSchemaHost;
 export declare function ApiParam(options: ApiParamOptions): MethodDecorator;
 export {};
 //# sourceMappingURL=api-param.decorator.d.ts.map

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

@@ -1,5 +1,5 @@
 import { Type, ParameterObject, ReferenceObject, SchemaObject, SwaggerEnumType } from '../interfaces';
-declare type ParameterOptions = Omit<ParameterObject, 'in' | 'schema' | 'name'>;
+type ParameterOptions = Omit<ParameterObject, 'in' | 'schema' | 'name'>;
 interface ApiQueryMetadata extends ParameterOptions {
     name?: string;
     type?: Type | string;
@@ -11,7 +11,7 @@ interface ApiQuerySchemaHost extends ParameterOptions {
     name?: string;
     schema: SchemaObject | ReferenceObject;
 }
-export declare type ApiQueryOptions = ApiQueryMetadata | ApiQuerySchemaHost;
+export type ApiQueryOptions = ApiQueryMetadata | ApiQuerySchemaHost;
 export declare function ApiQuery(options: ApiQueryOptions): MethodDecorator;
 export {};
 //# sourceMappingURL=api-query.decorator.d.ts.map

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

@@ -10,7 +10,7 @@ export interface ApiResponseSchemaHost extends Omit<ResponseObject, 'description
     status?: number;
     description?: string;
 }
-export declare type ApiResponseOptions = ApiResponseMetadata | ApiResponseSchemaHost;
+export type ApiResponseOptions = ApiResponseMetadata | ApiResponseSchemaHost;
 export declare function ApiResponse(options: ApiResponseOptions): any;
 export declare const ApiOkResponse: (options?: ApiResponseOptions) => any;
 export declare const ApiCreatedResponse: (options?: ApiResponseOptions) => any;

package/dist/interfaces/index.d.ts

@@ -50,7 +50,7 @@ export interface ComponentsObject {
     links?: Record<string, LinkObject | ReferenceObject>;
     callbacks?: Record<string, CallbackObject | ReferenceObject>;
 }
-export declare type PathsObject = Record<string, PathItemObject>;
+export type PathsObject = Record<string, PathItemObject>;
 export interface PathItemObject {
     $ref?: string;
     summary?: string;
@@ -84,8 +84,8 @@ export interface ExternalDocumentationObject {
     description?: string;
     url: string;
 }
-export declare type ParameterLocation = 'query' | 'header' | 'path' | 'cookie';
-export declare type ParameterStyle = 'matrix' | 'label' | 'form' | 'simple' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject';
+export type ParameterLocation = 'query' | 'header' | 'path' | 'cookie';
+export type ParameterStyle = 'matrix' | 'label' | 'form' | 'simple' | 'spaceDelimited' | 'pipeDelimited' | 'deepObject';
 export interface BaseParameterObject {
     description?: string;
     required?: boolean;
@@ -108,14 +108,14 @@ export interface RequestBodyObject {
     content: ContentObject;
     required?: boolean;
 }
-export declare type ContentObject = Record<string, MediaTypeObject>;
+export type ContentObject = Record<string, MediaTypeObject>;
 export interface MediaTypeObject {
     schema?: SchemaObject | ReferenceObject;
     examples?: ExamplesObject;
     example?: any;
     encoding?: EncodingObject;
 }
-export declare type EncodingObject = Record<string, EncodingPropertyObject>;
+export type EncodingObject = Record<string, EncodingPropertyObject>;
 export interface EncodingPropertyObject {
     contentType?: string;
     headers?: Record<string, HeaderObject | ReferenceObject>;
@@ -132,16 +132,16 @@ export interface ResponseObject {
     content?: ContentObject;
     links?: LinksObject;
 }
-export declare type CallbacksObject = Record<string, CallbackObject | ReferenceObject>;
-export declare type CallbackObject = Record<string, PathItemObject>;
-export declare type HeadersObject = Record<string, HeaderObject | ReferenceObject>;
+export type CallbacksObject = Record<string, CallbackObject | ReferenceObject>;
+export type CallbackObject = Record<string, PathItemObject>;
+export type HeadersObject = Record<string, HeaderObject | ReferenceObject>;
 export interface ExampleObject {
     summary?: string;
     description?: string;
     value?: any;
     externalValue?: string;
 }
-export declare type LinksObject = Record<string, LinkObject | ReferenceObject>;
+export type LinksObject = Record<string, LinkObject | ReferenceObject>;
 export interface LinkObject {
     operationRef?: string;
     operationId?: string;
@@ -150,14 +150,14 @@ export interface LinkObject {
     description?: string;
     server?: ServerObject;
 }
-export declare type LinkParametersObject = Record<string, any>;
-export declare type HeaderObject = BaseParameterObject;
+export type LinkParametersObject = Record<string, any>;
+export type HeaderObject = BaseParameterObject;
 export interface TagObject {
     name: string;
     description?: string;
     externalDocs?: ExternalDocumentationObject;
 }
-export declare type ExamplesObject = Record<string, ExampleObject | ReferenceObject>;
+export type ExamplesObject = Record<string, ExampleObject | ReferenceObject>;
 export interface ReferenceObject {
     $ref: string | (() => string);
 }
@@ -171,7 +171,7 @@ export interface SchemaObject {
     example?: any;
     examples?: any[] | Record<string, any>;
     deprecated?: boolean;
-    type?: string;
+    type?: string | (new (...args: any[]) => any) | (() => new (...args: any[]) => any);
     allOf?: (SchemaObject | ReferenceObject)[];
     oneOf?: (SchemaObject | ReferenceObject)[];
     anyOf?: (SchemaObject | ReferenceObject)[];
@@ -200,7 +200,7 @@ export interface SchemaObject {
     required?: string[];
     enum?: any[];
 }
-export declare type SchemasObject = Record<string, SchemaObject>;
+export type SchemasObject = Record<string, SchemaObject>;
 export interface DiscriminatorObject {
     propertyName: string;
     mapping?: Record<string, string>;
@@ -212,7 +212,7 @@ export interface XmlObject {
     attribute?: boolean;
     wrapped?: boolean;
 }
-export declare type SecuritySchemeType = 'apiKey' | 'http' | 'oauth2' | 'openIdConnect';
+export type SecuritySchemeType = 'apiKey' | 'http' | 'oauth2' | 'openIdConnect';
 export interface SecuritySchemeObject {
     type: SecuritySchemeType;
     description?: string;
@@ -235,12 +235,12 @@ export interface OAuthFlowObject {
     refreshUrl?: string;
     scopes: ScopesObject;
 }
-export declare type ScopesObject = Record<string, any>;
-export declare type SecurityRequirementObject = Record<string, string[]>;
+export type ScopesObject = Record<string, any>;
+export type SecurityRequirementObject = Record<string, string[]>;
 /**
  * 非 open api spec
  */
-export declare type SwaggerEnumType = string[] | number[] | (string | number)[] | Record<number, string>;
+export type SwaggerEnumType = string[] | number[] | (string | number)[] | Record<number, string>;
 export interface Type<T = any> extends Function {
     new (...args: any[]): T;
 }
@@ -251,7 +251,7 @@ export interface SchemaObjectMetadata extends Omit<SchemaObject, 'type' | 'requi
     name?: string;
     enumName?: string;
 }
-export declare type AuthType = 'basic' | 'bearer' | 'cookie' | 'oauth2' | 'apikey' | 'custom';
+export type AuthType = 'basic' | 'bearer' | 'cookie' | 'oauth2' | 'apikey' | 'custom';
 /**
  * 继承自 https://swagger.io/specification/#security-scheme-object
  */

package/dist/swaggerExplorer.d.ts

@@ -23,6 +23,7 @@ export declare class SwaggerExplorer {
      * @param clzz
      */
     private parseExtraModel;
+    protected parseSubPropertyType(metadata: any): any;
     /**
      * 解析类型的 ApiProperty
      * @param clzz

package/dist/swaggerExplorer.js

@@ -499,6 +499,104 @@ let SwaggerExplorer = class SwaggerExplorer {
             }
         }
     }
+    parseSubPropertyType(metadata) {
+        var _a, _b, _c;
+        let typeMeta;
+        if (metadata === null || metadata === void 0 ? void 0 : metadata.enum) {
+            typeMeta = {
+                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) {
+                typeMeta.description = metadata === null || metadata === void 0 ? void 0 : metadata.description;
+            }
+            return typeMeta;
+        }
+        if ((_a = metadata === null || metadata === void 0 ? void 0 : metadata.items) === null || _a === void 0 ? void 0 : _a.enum) {
+            typeMeta = {
+                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) {
+                typeMeta.description = metadata === null || metadata === void 0 ? void 0 : metadata.description;
+            }
+            return typeMeta;
+        }
+        let isArray = false;
+        let currentType = parseTypeSchema(metadata === null || metadata === void 0 ? void 0 : metadata.type);
+        metadata === null || metadata === void 0 ? true : delete metadata.type;
+        if (currentType === 'array') {
+            isArray = true;
+            currentType = parseTypeSchema((_b = metadata === null || metadata === void 0 ? void 0 : metadata.items) === null || _b === void 0 ? void 0 : _b.type);
+            metadata === null || metadata === void 0 ? true : delete metadata.items.type;
+        }
+        if (metadata === null || metadata === void 0 ? void 0 : metadata.oneOf) {
+            typeMeta = {
+                oneOf: [],
+            };
+            metadata === null || metadata === void 0 ? void 0 : metadata.oneOf.forEach((item) => {
+                typeMeta.push(this.parseSubPropertyType(item));
+            });
+            metadata === null || metadata === void 0 ? true : delete metadata.oneOf;
+        }
+        if (core_1.Types.isClass(currentType)) {
+            this.parseClzz(currentType);
+            if (isArray) {
+                typeMeta = {
+                    type: 'array',
+                    items: {
+                        $ref: '#/components/schemas/' + (currentType === null || currentType === void 0 ? void 0 : currentType.name),
+                    },
+                };
+            }
+            else {
+                typeMeta = {
+                    $ref: '#/components/schemas/' + (currentType === null || currentType === void 0 ? void 0 : currentType.name),
+                };
+            }
+            delete metadata.items;
+        }
+        else {
+            if (isArray) {
+                // 没有配置类型则认为自己配置了 items 内容
+                if (!currentType) {
+                    if ((_c = metadata === null || metadata === void 0 ? void 0 : metadata.items) === null || _c === void 0 ? void 0 : _c['$ref']) {
+                        metadata.items['$ref'] = parseTypeSchema(metadata.items['$ref']);
+                    }
+                    typeMeta = {
+                        type: 'array',
+                        items: metadata === null || metadata === void 0 ? void 0 : metadata.items,
+                    };
+                }
+                else {
+                    typeMeta = {
+                        type: 'array',
+                        items: {
+                            type: convertSchemaType((currentType === null || currentType === void 0 ? void 0 : currentType.name) || currentType),
+                        },
+                    };
+                }
+                delete metadata.items;
+            }
+            else {
+                typeMeta = {
+                    type: currentType,
+                    format: metadata === null || metadata === void 0 ? void 0 : metadata.format,
+                };
+                // Date 类型支持
+                if (typeMeta.type === 'Date') {
+                    typeMeta.type = 'string';
+                    if (!typeMeta.format) {
+                        typeMeta.format = 'date';
+                    }
+                }
+                delete metadata.format;
+            }
+        }
+        return Object.assign(typeMeta, metadata);
+    }
     /**
      * 解析类型的 ApiProperty
      * @param clzz
@@ -553,9 +651,19 @@ let SwaggerExplorer = class SwaggerExplorer {
                 metadata === null || metadata === void 0 ? true : delete metadata.type;
                 if (currentType === 'array') {
                     isArray = true;
-                    currentType = (_b = metadata === null || metadata === void 0 ? void 0 : metadata.items) === null || _b === void 0 ? void 0 : _b.type;
+                    currentType = parseTypeSchema((_b = metadata === null || metadata === void 0 ? void 0 : metadata.items) === null || _b === void 0 ? void 0 : _b.type);
                     metadata === null || metadata === void 0 ? true : delete metadata.items.type;
                 }
+                if (metadata === null || metadata === void 0 ? void 0 : metadata.oneOf) {
+                    tt.properties[key] = {
+                        oneOf: [],
+                    };
+                    metadata === null || metadata === void 0 ? void 0 : metadata.oneOf.forEach((meta) => {
+                        tt.properties[key].oneOf.push(this.parseSubPropertyType(meta));
+                    });
+                    metadata === null || metadata === void 0 ? true : delete metadata.oneOf;
+                    return;
+                }
                 if (core_1.Types.isClass(currentType)) {
                     this.parseClzz(currentType);
                     if (isArray) {
@@ -756,9 +864,18 @@ function getNotEmptyValue(...args) {
     }
 }
 function parseTypeSchema(ref) {
-    if (typeof ref === 'function' && !core_1.Types.isClass(ref)) {
-        ref = ref();
+    switch (ref) {
+        case String:
+            return 'string';
+        case Number:
+            return 'number';
+        case Boolean:
+            return 'boolean';
+        default:
+            if (typeof ref === 'function' && !core_1.Types.isClass(ref)) {
+                ref = ref();
+            }
+            return ref;
     }
-    return ref;
 }
 //# sourceMappingURL=swaggerExplorer.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/swagger",
-  "version": "3.9.9",
+  "version": "3.10.0",
   "main": "dist/index",
   "typings": "index.d.ts",
   "files": [
@@ -9,10 +9,10 @@
     "index.d.ts"
   ],
   "devDependencies": {
-    "@midwayjs/core": "^3.9.0",
-    "@midwayjs/koa": "^3.9.9",
-    "@midwayjs/mock": "^3.9.0",
-    "@midwayjs/validate": "^3.9.9",
+    "@midwayjs/core": "^3.10.0",
+    "@midwayjs/koa": "^3.10.0",
+    "@midwayjs/mock": "^3.10.0",
+    "@midwayjs/validate": "^3.10.0",
     "swagger-ui-dist": "4.15.5"
   },
   "author": "Kurten Chan <chinkurten@gmail.com>",
@@ -27,5 +27,5 @@
     "type": "git",
     "url": "https://github.com/midwayjs/midway.git"
   },
-  "gitHead": "95bb5b3f23b41f685372c45d1c3bb12a3e31b4e0"
+  "gitHead": "33d28f1a020963404488e866432916fd15c0952c"
 }