@midwayjs/swagger 1.0.7 → 3.0.0-beta.9

package/README.md

@@ -1,28 +1,12 @@
-# midway swagger component
+# midwayjs swagger module
 
-## How to use
+[![Package Quality](http://npm.packagequality.com/shield/midway-core.svg)](http://packagequality.com/#?package=midway-core)
+[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](https://github.com/midwayjs/midway/pulls)
 
-```js
-npm install @midwayjs/swagger --save
-npm install swagger-ui-dist --save-dev   // If you view swagger documentation on in local env
+this is a sub package for midway.
 
-npm install swagger-ui-dist --save       // If you want view swagger documentation on the server
-```
+Document: [https://midwayjs.org/midway](https://midwayjs.org/midway)
 
-## Support
+## License
 
-**Default and Auto**
-
-- [x] api name
-- [x] api args name
-- [x] api tag(prefix)
-- [x] api args type
-    - [x] DTO generate definition schema
-    - [x] body(object)
-
-**Need add Code**
-
-- [x] api description and summary
-- [x] api args required
-- [x] api args example
-- [x] api response code and result format
+[MIT]((http://github.com/midwayjs/midway/blob/master/LICENSE))

package/dist/common/enum.utils.d.ts

@@ -0,0 +1,9 @@
+import { SchemaObjectMetadata, SwaggerEnumType } from '../interfaces';
+export declare function getEnumValues(enumType: SwaggerEnumType): string[] | number[];
+export declare function getEnumType(values: (string | number)[]): 'string' | 'number';
+export declare function addEnumArraySchema(paramDefinition: Partial<Record<'schema' | 'isArray' | 'enumName', any>>, decoratorOptions: Partial<Record<'enum' | 'enumName', any>>): void;
+export declare function addEnumSchema(paramDefinition: Partial<Record<string, any>>, decoratorOptions: Partial<Record<string, any>>): void;
+export declare const isEnumArray: <T extends Partial<Record<"enum" | "isArray", any>>>(obj: Record<string, any>) => obj is T;
+export declare const isEnumDefined: <T extends Partial<Record<"enum", any>>>(obj: Record<string, any>) => obj is T;
+export declare const isEnumMetadata: (metadata: SchemaObjectMetadata) => any;
+//# sourceMappingURL=enum.utils.d.ts.map

package/dist/common/enum.utils.js

@@ -0,0 +1,63 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isEnumMetadata = exports.isEnumDefined = exports.isEnumArray = exports.addEnumSchema = exports.addEnumArraySchema = exports.getEnumType = exports.getEnumValues = void 0;
+function getEnumValues(enumType) {
+    if (Array.isArray(enumType)) {
+        return enumType;
+    }
+    if (typeof enumType !== 'object') {
+        return [];
+    }
+    const values = [];
+    const uniqueValues = {};
+    for (const key in enumType) {
+        const value = enumType[key];
+        /* eslint-disable no-prototype-builtins */
+        // filter out cases where enum key also becomes its value (A: B, B: A)
+        if (!uniqueValues.hasOwnProperty(value) &&
+            !uniqueValues.hasOwnProperty(key)) {
+            values.push(value);
+            uniqueValues[value] = value;
+        }
+    }
+    return values;
+}
+exports.getEnumValues = getEnumValues;
+function getEnumType(values) {
+    const hasString = values.filter(s => typeof s === 'string').length > 0;
+    return hasString ? 'string' : 'number';
+}
+exports.getEnumType = getEnumType;
+function addEnumArraySchema(paramDefinition, decoratorOptions) {
+    const paramSchema = paramDefinition.schema || {};
+    paramDefinition.schema = paramSchema;
+    paramSchema.type = 'array';
+    delete paramDefinition.isArray;
+    const enumValues = getEnumValues(decoratorOptions.enum);
+    paramSchema.items = {
+        type: getEnumType(enumValues),
+        enum: enumValues,
+    };
+    if (decoratorOptions.enumName) {
+        paramDefinition.enumName = decoratorOptions.enumName;
+    }
+}
+exports.addEnumArraySchema = addEnumArraySchema;
+function addEnumSchema(paramDefinition, decoratorOptions) {
+    const paramSchema = paramDefinition.schema || {};
+    const enumValues = getEnumValues(decoratorOptions.enum);
+    paramDefinition.schema = paramSchema;
+    paramSchema.enum = enumValues;
+    paramSchema.type = getEnumType(enumValues);
+    if (decoratorOptions.enumName) {
+        paramDefinition.enumName = decoratorOptions.enumName;
+    }
+}
+exports.addEnumSchema = addEnumSchema;
+const isEnumArray = (obj) => obj.isArray && obj.enum;
+exports.isEnumArray = isEnumArray;
+const isEnumDefined = (obj) => obj.enum;
+exports.isEnumDefined = isEnumDefined;
+const isEnumMetadata = (metadata) => { var _a; return metadata.enum || (metadata.isArray && ((_a = metadata.items) === null || _a === void 0 ? void 0 : _a['enum'])); };
+exports.isEnumMetadata = isEnumMetadata;
+//# sourceMappingURL=enum.utils.js.map

package/dist/common/httpStatus.d.ts

@@ -0,0 +1,51 @@
+export declare enum HttpStatus {
+    CONTINUE = 100,
+    SWITCHING_PROTOCOLS = 101,
+    PROCESSING = 102,
+    EARLYHINTS = 103,
+    OK = 200,
+    CREATED = 201,
+    ACCEPTED = 202,
+    NON_AUTHORITATIVE_INFORMATION = 203,
+    NO_CONTENT = 204,
+    RESET_CONTENT = 205,
+    PARTIAL_CONTENT = 206,
+    AMBIGUOUS = 300,
+    MOVED_PERMANENTLY = 301,
+    FOUND = 302,
+    SEE_OTHER = 303,
+    NOT_MODIFIED = 304,
+    TEMPORARY_REDIRECT = 307,
+    PERMANENT_REDIRECT = 308,
+    BAD_REQUEST = 400,
+    UNAUTHORIZED = 401,
+    PAYMENT_REQUIRED = 402,
+    FORBIDDEN = 403,
+    NOT_FOUND = 404,
+    METHOD_NOT_ALLOWED = 405,
+    NOT_ACCEPTABLE = 406,
+    PROXY_AUTHENTICATION_REQUIRED = 407,
+    REQUEST_TIMEOUT = 408,
+    CONFLICT = 409,
+    GONE = 410,
+    LENGTH_REQUIRED = 411,
+    PRECONDITION_FAILED = 412,
+    PAYLOAD_TOO_LARGE = 413,
+    URI_TOO_LONG = 414,
+    UNSUPPORTED_MEDIA_TYPE = 415,
+    REQUESTED_RANGE_NOT_SATISFIABLE = 416,
+    EXPECTATION_FAILED = 417,
+    I_AM_A_TEAPOT = 418,
+    MISDIRECTED = 421,
+    UNPROCESSABLE_ENTITY = 422,
+    FAILED_DEPENDENCY = 424,
+    PRECONDITION_REQUIRED = 428,
+    TOO_MANY_REQUESTS = 429,
+    INTERNAL_SERVER_ERROR = 500,
+    NOT_IMPLEMENTED = 501,
+    BAD_GATEWAY = 502,
+    SERVICE_UNAVAILABLE = 503,
+    GATEWAY_TIMEOUT = 504,
+    HTTP_VERSION_NOT_SUPPORTED = 505
+}
+//# sourceMappingURL=httpStatus.d.ts.map

package/dist/common/httpStatus.js

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpStatus = void 0;
+var HttpStatus;
+(function (HttpStatus) {
+    HttpStatus[HttpStatus["CONTINUE"] = 100] = "CONTINUE";
+    HttpStatus[HttpStatus["SWITCHING_PROTOCOLS"] = 101] = "SWITCHING_PROTOCOLS";
+    HttpStatus[HttpStatus["PROCESSING"] = 102] = "PROCESSING";
+    HttpStatus[HttpStatus["EARLYHINTS"] = 103] = "EARLYHINTS";
+    HttpStatus[HttpStatus["OK"] = 200] = "OK";
+    HttpStatus[HttpStatus["CREATED"] = 201] = "CREATED";
+    HttpStatus[HttpStatus["ACCEPTED"] = 202] = "ACCEPTED";
+    HttpStatus[HttpStatus["NON_AUTHORITATIVE_INFORMATION"] = 203] = "NON_AUTHORITATIVE_INFORMATION";
+    HttpStatus[HttpStatus["NO_CONTENT"] = 204] = "NO_CONTENT";
+    HttpStatus[HttpStatus["RESET_CONTENT"] = 205] = "RESET_CONTENT";
+    HttpStatus[HttpStatus["PARTIAL_CONTENT"] = 206] = "PARTIAL_CONTENT";
+    HttpStatus[HttpStatus["AMBIGUOUS"] = 300] = "AMBIGUOUS";
+    HttpStatus[HttpStatus["MOVED_PERMANENTLY"] = 301] = "MOVED_PERMANENTLY";
+    HttpStatus[HttpStatus["FOUND"] = 302] = "FOUND";
+    HttpStatus[HttpStatus["SEE_OTHER"] = 303] = "SEE_OTHER";
+    HttpStatus[HttpStatus["NOT_MODIFIED"] = 304] = "NOT_MODIFIED";
+    HttpStatus[HttpStatus["TEMPORARY_REDIRECT"] = 307] = "TEMPORARY_REDIRECT";
+    HttpStatus[HttpStatus["PERMANENT_REDIRECT"] = 308] = "PERMANENT_REDIRECT";
+    HttpStatus[HttpStatus["BAD_REQUEST"] = 400] = "BAD_REQUEST";
+    HttpStatus[HttpStatus["UNAUTHORIZED"] = 401] = "UNAUTHORIZED";
+    HttpStatus[HttpStatus["PAYMENT_REQUIRED"] = 402] = "PAYMENT_REQUIRED";
+    HttpStatus[HttpStatus["FORBIDDEN"] = 403] = "FORBIDDEN";
+    HttpStatus[HttpStatus["NOT_FOUND"] = 404] = "NOT_FOUND";
+    HttpStatus[HttpStatus["METHOD_NOT_ALLOWED"] = 405] = "METHOD_NOT_ALLOWED";
+    HttpStatus[HttpStatus["NOT_ACCEPTABLE"] = 406] = "NOT_ACCEPTABLE";
+    HttpStatus[HttpStatus["PROXY_AUTHENTICATION_REQUIRED"] = 407] = "PROXY_AUTHENTICATION_REQUIRED";
+    HttpStatus[HttpStatus["REQUEST_TIMEOUT"] = 408] = "REQUEST_TIMEOUT";
+    HttpStatus[HttpStatus["CONFLICT"] = 409] = "CONFLICT";
+    HttpStatus[HttpStatus["GONE"] = 410] = "GONE";
+    HttpStatus[HttpStatus["LENGTH_REQUIRED"] = 411] = "LENGTH_REQUIRED";
+    HttpStatus[HttpStatus["PRECONDITION_FAILED"] = 412] = "PRECONDITION_FAILED";
+    HttpStatus[HttpStatus["PAYLOAD_TOO_LARGE"] = 413] = "PAYLOAD_TOO_LARGE";
+    HttpStatus[HttpStatus["URI_TOO_LONG"] = 414] = "URI_TOO_LONG";
+    HttpStatus[HttpStatus["UNSUPPORTED_MEDIA_TYPE"] = 415] = "UNSUPPORTED_MEDIA_TYPE";
+    HttpStatus[HttpStatus["REQUESTED_RANGE_NOT_SATISFIABLE"] = 416] = "REQUESTED_RANGE_NOT_SATISFIABLE";
+    HttpStatus[HttpStatus["EXPECTATION_FAILED"] = 417] = "EXPECTATION_FAILED";
+    HttpStatus[HttpStatus["I_AM_A_TEAPOT"] = 418] = "I_AM_A_TEAPOT";
+    HttpStatus[HttpStatus["MISDIRECTED"] = 421] = "MISDIRECTED";
+    HttpStatus[HttpStatus["UNPROCESSABLE_ENTITY"] = 422] = "UNPROCESSABLE_ENTITY";
+    HttpStatus[HttpStatus["FAILED_DEPENDENCY"] = 424] = "FAILED_DEPENDENCY";
+    HttpStatus[HttpStatus["PRECONDITION_REQUIRED"] = 428] = "PRECONDITION_REQUIRED";
+    HttpStatus[HttpStatus["TOO_MANY_REQUESTS"] = 429] = "TOO_MANY_REQUESTS";
+    HttpStatus[HttpStatus["INTERNAL_SERVER_ERROR"] = 500] = "INTERNAL_SERVER_ERROR";
+    HttpStatus[HttpStatus["NOT_IMPLEMENTED"] = 501] = "NOT_IMPLEMENTED";
+    HttpStatus[HttpStatus["BAD_GATEWAY"] = 502] = "BAD_GATEWAY";
+    HttpStatus[HttpStatus["SERVICE_UNAVAILABLE"] = 503] = "SERVICE_UNAVAILABLE";
+    HttpStatus[HttpStatus["GATEWAY_TIMEOUT"] = 504] = "GATEWAY_TIMEOUT";
+    HttpStatus[HttpStatus["HTTP_VERSION_NOT_SUPPORTED"] = 505] = "HTTP_VERSION_NOT_SUPPORTED";
+})(HttpStatus = exports.HttpStatus || (exports.HttpStatus = {}));
+//# sourceMappingURL=httpStatus.js.map

package/dist/config/config.default.d.ts

@@ -1,9 +1,3 @@
-declare const _default: {
-    swagger: {
-        title: string;
-        description: string;
-        version: string;
-    };
-};
-export default _default;
+import { SwaggerOptions } from '../interfaces';
+export declare const swagger: SwaggerOptions;
 //# sourceMappingURL=config.default.d.ts.map

package/dist/config/config.default.js

@@ -1,10 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = {
-    swagger: {
-        title: 'My Project',
-        description: 'This is a swagger-ui for midwayjs project',
-        version: '1.0.0',
-    },
+exports.swagger = void 0;
+exports.swagger = {
+    title: 'My Project',
+    description: 'This is a swagger-ui for midwayjs project',
+    version: '1.0.0',
+    swaggerPath: '/swagger-ui',
 };
 //# sourceMappingURL=config.default.js.map

package/dist/configuration.d.ts

@@ -1,4 +1,6 @@
-export declare class AutoConfiguration {
-    onReady(container: any): Promise<void>;
+import { ILifeCycle, IMidwayContainer, MidwayApplicationManager } from '@midwayjs/core';
+export declare class SwaggerConfiguration implements ILifeCycle {
+    applicationManager: MidwayApplicationManager;
+    onReady(container: IMidwayContainer): Promise<void>;
 }
 //# sourceMappingURL=configuration.d.ts.map

package/dist/configuration.js

@@ -5,23 +5,39 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AutoConfiguration = void 0;
+exports.SwaggerConfiguration = void 0;
+const core_1 = require("@midwayjs/core");
 const decorator_1 = require("@midwayjs/decorator");
-const path_1 = require("path");
-let AutoConfiguration = class AutoConfiguration {
+const _1 = require(".");
+const DefaultConfig = require("./config/config.default");
+let SwaggerConfiguration = class SwaggerConfiguration {
     async onReady(container) {
-        if (process.env.MIDWAY_SWAGGER_DEBUG === 'true') {
-            const swaggerGenerator = await container.getAsync('swagger:swaggerGenerator');
-            console.log(JSON.stringify(swaggerGenerator.generate()));
-        }
+        this.applicationManager
+            .getApplications(['express', 'koa', 'egg', 'faas'])
+            .forEach(app => {
+            app.useMiddleware(_1.SwaggerMiddleware);
+        });
+        const explorer = await container.getAsync(_1.SwaggerExplorer);
+        explorer.scanApp();
     }
 };
-AutoConfiguration = __decorate([
-    decorator_1.Configuration({
+__decorate([
+    (0, decorator_1.Inject)(),
+    __metadata("design:type", core_1.MidwayApplicationManager)
+], SwaggerConfiguration.prototype, "applicationManager", void 0);
+SwaggerConfiguration = __decorate([
+    (0, decorator_1.Configuration)({
+        importConfigs: [
+            {
+                default: DefaultConfig,
+            },
+        ],
         namespace: 'swagger',
-        importConfigs: [path_1.join(__dirname, 'config')],
     })
-], AutoConfiguration);
-exports.AutoConfiguration = AutoConfiguration;
+], SwaggerConfiguration);
+exports.SwaggerConfiguration = SwaggerConfiguration;
 //# sourceMappingURL=configuration.js.map

package/dist/constants.d.ts

@@ -0,0 +1,15 @@
+export declare const DECORATORS_PREFIX = "swagger";
+export declare const DECORATORS: {
+    API_OPERATION: string;
+    API_RESPONSE: string;
+    API_TAGS: string;
+    API_PARAMETERS: string;
+    API_HEADERS: string;
+    API_MODEL_PROPERTIES: string;
+    API_MODEL_PROPERTIES_ARRAY: string;
+    API_SECURITY: string;
+    API_EXCLUDE_ENDPOINT: string;
+    API_EXCLUDE_CONTROLLER: string;
+    API_EXTENSION: string;
+};
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DECORATORS = exports.DECORATORS_PREFIX = void 0;
+exports.DECORATORS_PREFIX = 'swagger';
+exports.DECORATORS = {
+    API_OPERATION: `${exports.DECORATORS_PREFIX}/apiOperation`,
+    API_RESPONSE: `${exports.DECORATORS_PREFIX}/apiResponse`,
+    API_TAGS: `${exports.DECORATORS_PREFIX}/apiUseTags`,
+    API_PARAMETERS: `${exports.DECORATORS_PREFIX}/apiParameters`,
+    API_HEADERS: `${exports.DECORATORS_PREFIX}/apiHeaders`,
+    API_MODEL_PROPERTIES: `${exports.DECORATORS_PREFIX}/apiModelProperties`,
+    API_MODEL_PROPERTIES_ARRAY: `${exports.DECORATORS_PREFIX}/apiModelPropertiesArray`,
+    API_SECURITY: `${exports.DECORATORS_PREFIX}/apiSecurity`,
+    API_EXCLUDE_ENDPOINT: `${exports.DECORATORS_PREFIX}/apiExcludeEndpoint`,
+    API_EXCLUDE_CONTROLLER: `${exports.DECORATORS_PREFIX}/apiExcludeController`,
+    API_EXTENSION: `${exports.DECORATORS_PREFIX}/apiExtension`,
+};
+//# sourceMappingURL=constants.js.map

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

@@ -0,0 +1,2 @@
+export declare function ApiBasicAuth(name?: string): any;
+//# sourceMappingURL=api-basic.decorator.d.ts.map

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

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiBasicAuth = void 0;
+const api_security_decorator_1 = require("./api-security.decorator");
+function ApiBasicAuth(name = 'basic') {
+    return (0, api_security_decorator_1.ApiSecurity)(name);
+}
+exports.ApiBasicAuth = ApiBasicAuth;
+//# sourceMappingURL=api-basic.decorator.js.map

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

@@ -0,0 +1,2 @@
+export declare function ApiBearerAuth(name?: string): any;
+//# sourceMappingURL=api-bearer.decorator.d.ts.map

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

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiBearerAuth = void 0;
+const api_security_decorator_1 = require("./api-security.decorator");
+function ApiBearerAuth(name = 'bearer') {
+    return (0, api_security_decorator_1.ApiSecurity)(name);
+}
+exports.ApiBearerAuth = ApiBearerAuth;
+//# sourceMappingURL=api-bearer.decorator.js.map

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

@@ -0,0 +1,16 @@
+import { ContentObject, ExamplesObject, ReferenceObject, RequestBodyObject, SchemaObject, SwaggerEnumType } from '../interfaces';
+declare type RequestBodyOptions = Omit<RequestBodyObject, 'content'>;
+interface ApiBodyMetadata extends RequestBodyOptions {
+    type?: any;
+    isArray?: boolean;
+    enum?: SwaggerEnumType;
+    content?: ContentObject;
+}
+interface ApiBodySchemaHost extends RequestBodyOptions {
+    schema: SchemaObject | ReferenceObject;
+    examples?: ExamplesObject;
+}
+export declare type ApiBodyOptions = ApiBodyMetadata | ApiBodySchemaHost;
+export declare function ApiBody(options: ApiBodyOptions): MethodDecorator;
+export {};
+//# sourceMappingURL=api-body.decorator.d.ts.map

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

@@ -0,0 +1,27 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiBody = void 0;
+const enum_utils_1 = require("../common/enum.utils");
+const helpers_1 = require("./helpers");
+const defaultBodyMetadata = {
+    type: String,
+    required: true,
+};
+function ApiBody(options) {
+    const [type, isArray] = (0, helpers_1.getTypeIsArrayTuple)(options.type, options.isArray);
+    const param = {
+        in: 'body',
+        ...options,
+        type,
+        isArray,
+    };
+    if ((0, enum_utils_1.isEnumArray)(options)) {
+        (0, enum_utils_1.addEnumArraySchema)(param, options);
+    }
+    else if ((0, enum_utils_1.isEnumDefined)(options)) {
+        (0, enum_utils_1.addEnumSchema)(param, options);
+    }
+    return (0, helpers_1.createParamDecorator)(param, defaultBodyMetadata);
+}
+exports.ApiBody = ApiBody;
+//# sourceMappingURL=api-body.decorator.js.map

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

@@ -0,0 +1,2 @@
+export declare function ApiCookieAuth(name?: string): any;
+//# sourceMappingURL=api-cookie.decorator.d.ts.map

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

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiCookieAuth = void 0;
+const api_security_decorator_1 = require("./api-security.decorator");
+function ApiCookieAuth(name = 'cookie') {
+    return (0, api_security_decorator_1.ApiSecurity)(name);
+}
+exports.ApiCookieAuth = ApiCookieAuth;
+//# sourceMappingURL=api-cookie.decorator.js.map

package/dist/decorators/api-exclude-controller.decorator.d.ts

@@ -0,0 +1,2 @@
+export declare function ApiExcludeController(disable?: boolean): any;
+//# sourceMappingURL=api-exclude-controller.decorator.d.ts.map

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

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+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,
+    ]);
+}
+exports.ApiExcludeController = ApiExcludeController;
+//# sourceMappingURL=api-exclude-controller.decorator.js.map

package/dist/decorators/api-exclude-endpoint.decorator.d.ts

@@ -0,0 +1,2 @@
+export declare function ApiExcludeEndpoint(disable?: boolean): MethodDecorator;
+//# sourceMappingURL=api-exclude-endpoint.decorator.d.ts.map

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

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiExcludeEndpoint = void 0;
+const decorator_1 = require("@midwayjs/decorator");
+const constants_1 = require("../constants");
+function ApiExcludeEndpoint(disable = true) {
+    return (0, decorator_1.createCustomMethodDecorator)(constants_1.DECORATORS.API_EXCLUDE_ENDPOINT, {
+        disable,
+    });
+}
+exports.ApiExcludeEndpoint = ApiExcludeEndpoint;
+//# sourceMappingURL=api-exclude-endpoint.decorator.js.map

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

@@ -0,0 +1,2 @@
+export declare function ApiExtension(extensionKey: string, extensionProperties: any): any;
+//# sourceMappingURL=api-extension.decorator.d.ts.map

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

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiExtension = void 0;
+const constants_1 = require("../constants");
+const helpers_1 = require("./helpers");
+function ApiExtension(extensionKey, extensionProperties) {
+    if (!extensionKey.startsWith('x-')) {
+        throw new Error('Extension key is not prefixed. Please ensure you prefix it with `x-`.');
+    }
+    const extensionObject = {
+        [extensionKey]: JSON.parse(JSON.stringify(extensionProperties)),
+    };
+    return (0, helpers_1.createMixedDecorator)(constants_1.DECORATORS.API_EXTENSION, extensionObject);
+}
+exports.ApiExtension = ApiExtension;
+//# sourceMappingURL=api-extension.decorator.js.map

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

@@ -0,0 +1,7 @@
+import { SwaggerEnumType, ParameterObject } from '../interfaces';
+export interface ApiHeaderOptions extends Omit<ParameterObject, 'in'> {
+    enum?: SwaggerEnumType;
+}
+export declare function ApiHeader(options: ApiHeaderOptions): any;
+export declare const ApiHeaders: (headers: ApiHeaderOptions[]) => MethodDecorator & ClassDecorator;
+//# sourceMappingURL=api-header.decorator.d.ts.map

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

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiHeaders = exports.ApiHeader = void 0;
+const constants_1 = require("../constants");
+const enum_utils_1 = require("../common/enum.utils");
+const helpers_1 = require("./helpers");
+const decorator_1 = require("@midwayjs/decorator");
+const defaultHeaderOptions = {
+    name: '',
+};
+function ApiHeader(options) {
+    const param = {
+        name: !options.name ? defaultHeaderOptions.name : options.name,
+        in: 'header',
+        description: options.description,
+        required: options.required,
+        schema: {
+            ...(options.schema || {}),
+            type: 'string',
+        },
+    };
+    if (options.enum) {
+        const enumValues = (0, enum_utils_1.getEnumValues)(options.enum);
+        param.schema = {
+            enum: enumValues,
+            type: (0, enum_utils_1.getEnumType)(enumValues),
+        };
+    }
+    return (target, key, descriptor) => {
+        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);
+    };
+}
+exports.ApiHeader = ApiHeader;
+const ApiHeaders = (headers) => {
+    return (target, key, descriptor) => {
+        headers.forEach(options => ApiHeader(options)(target, key, descriptor));
+    };
+};
+exports.ApiHeaders = ApiHeaders;
+//# sourceMappingURL=api-header.decorator.js.map

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

@@ -0,0 +1,2 @@
+export declare function ApiOAuth2(scopes: string[], name?: string): any;
+//# sourceMappingURL=api-oauth2.decorator.d.ts.map

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

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiOAuth2 = void 0;
+const api_security_decorator_1 = require("./api-security.decorator");
+function ApiOAuth2(scopes, name = 'oauth2') {
+    return (0, api_security_decorator_1.ApiSecurity)(name, scopes);
+}
+exports.ApiOAuth2 = ApiOAuth2;
+//# sourceMappingURL=api-oauth2.decorator.js.map

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

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

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

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiOperation = void 0;
+const decorator_1 = require("@midwayjs/decorator");
+const constants_1 = require("../constants");
+const defaultOperationOptions = {
+    summary: '',
+};
+function ApiOperation(options) {
+    return (0, decorator_1.createCustomMethodDecorator)(constants_1.DECORATORS.API_OPERATION, {
+        ...defaultOperationOptions,
+        ...options,
+    });
+}
+exports.ApiOperation = ApiOperation;
+//# sourceMappingURL=api-operation.decorator.js.map

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

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

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

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiParam = void 0;
+const helpers_1 = require("./helpers");
+const enum_utils_1 = require("../common/enum.utils");
+const defaultParamOptions = {
+    name: '',
+    required: true,
+};
+function ApiParam(options) {
+    const param = {
+        name: !options.name ? defaultParamOptions.name : options.name,
+        in: 'path',
+        ...options,
+    };
+    const apiParamMetadata = options;
+    if (apiParamMetadata.enum) {
+        param.schema = param.schema || {};
+        const paramSchema = param.schema;
+        const enumValues = (0, enum_utils_1.getEnumValues)(apiParamMetadata.enum);
+        paramSchema.type = (0, enum_utils_1.getEnumType)(enumValues);
+        paramSchema.enum = enumValues;
+        if (apiParamMetadata.enumName) {
+            param.enumName = apiParamMetadata.enumName;
+        }
+    }
+    return (0, helpers_1.createParamDecorator)(param, defaultParamOptions);
+}
+exports.ApiParam = ApiParam;
+//# sourceMappingURL=api-param.decorator.js.map