nestjs-openapi-next 1.0.0

package/dist/constants.d.ts

@@ -0,0 +1,23 @@
+export declare const DECORATORS_PREFIX = "swagger";
+export declare const DECORATORS: {
+    API_OPERATION: string;
+    API_RESPONSE: string;
+    API_PRODUCES: string;
+    API_CONSUMES: string;
+    API_TAGS: string;
+    API_TAG_GROUP: string;
+    API_QUERY_METHOD: string;
+    API_CALLBACKS: 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_EXTRA_MODELS: string;
+    API_EXTENSION: string;
+    API_SCHEMA: string;
+    API_DEFAULT_GETTER: string;
+    API_LINK: string;
+};

package/dist/constants.js

@@ -0,0 +1,26 @@
+"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_PRODUCES: `${exports.DECORATORS_PREFIX}/apiProduces`,
+    API_CONSUMES: `${exports.DECORATORS_PREFIX}/apiConsumes`,
+    API_TAGS: `${exports.DECORATORS_PREFIX}/apiUseTags`,
+    API_TAG_GROUP: `${exports.DECORATORS_PREFIX}/apiTagGroup`,
+    API_QUERY_METHOD: `${exports.DECORATORS_PREFIX}/apiQueryMethod`,
+    API_CALLBACKS: `${exports.DECORATORS_PREFIX}/apiCallbacks`,
+    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_EXTRA_MODELS: `${exports.DECORATORS_PREFIX}/apiExtraModels`,
+    API_EXTENSION: `${exports.DECORATORS_PREFIX}/apiExtension`,
+    API_SCHEMA: `${exports.DECORATORS_PREFIX}/apiSchema`,
+    API_DEFAULT_GETTER: `${exports.DECORATORS_PREFIX}/apiDefaultGetter`,
+    API_LINK: `${exports.DECORATORS_PREFIX}/apiLink`
+};

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

@@ -0,0 +1 @@
+export declare function ApiBasicAuth(name?: string): ClassDecorator & MethodDecorator;

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

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

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

@@ -0,0 +1 @@
+export declare function ApiBearerAuth(name?: string): ClassDecorator & MethodDecorator;

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

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

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

@@ -0,0 +1,16 @@
+import { Type } from '@nestjs/common';
+import { ExamplesObject, ReferenceObject, RequestBodyObject, SchemaObject } from '../interfaces/open-api-spec.interface';
+import { SwaggerEnumType } from '../types/swagger-enum.type';
+type RequestBodyOptions = Omit<RequestBodyObject, 'content'>;
+interface ApiBodyMetadata extends RequestBodyOptions {
+    type?: Type<unknown> | Function | [Function] | string;
+    isArray?: boolean;
+    enum?: SwaggerEnumType;
+}
+interface ApiBodySchemaHost extends RequestBodyOptions {
+    schema: SchemaObject | ReferenceObject;
+    examples?: ExamplesObject;
+}
+export type ApiBodyOptions = ApiBodyMetadata | ApiBodySchemaHost;
+export declare function ApiBody(options: ApiBodyOptions): MethodDecorator;
+export {};

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

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiBody = ApiBody;
+const lodash_1 = require("lodash");
+const enum_utils_1 = require("../utils/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 = Object.assign(Object.assign({ in: 'body' }, (0, lodash_1.omit)(options, 'enum')), { 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);
+}

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

@@ -0,0 +1,2 @@
+import { CallBackObject } from '../interfaces/callback-object.interface';
+export declare function ApiCallbacks(...callbackObject: Array<CallBackObject<any>>): MethodDecorator & ClassDecorator;

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

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiCallbacks = ApiCallbacks;
+const constants_1 = require("../constants");
+const helpers_1 = require("./helpers");
+function ApiCallbacks(...callbackObject) {
+    return (0, helpers_1.createMixedDecorator)(constants_1.DECORATORS.API_CALLBACKS, callbackObject);
+}

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

@@ -0,0 +1 @@
+export declare function ApiConsumes(...mimeTypes: string[]): MethodDecorator & ClassDecorator;

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

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiConsumes = ApiConsumes;
+const constants_1 = require("../constants");
+const helpers_1 = require("./helpers");
+function ApiConsumes(...mimeTypes) {
+    return (0, helpers_1.createMixedDecorator)(constants_1.DECORATORS.API_CONSUMES, mimeTypes);
+}

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

@@ -0,0 +1 @@
+export declare function ApiCookieAuth(name?: string): ClassDecorator & MethodDecorator;

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

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

package/dist/decorators/api-default-getter.decorator.d.ts

@@ -0,0 +1,2 @@
+import { Type } from '@nestjs/common';
+export declare function ApiDefaultGetter(type: Type<unknown> | Function, parameter: string): MethodDecorator;

package/dist/decorators/api-default-getter.decorator.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiDefaultGetter = ApiDefaultGetter;
+const constants_1 = require("../constants");
+function ApiDefaultGetter(type, parameter) {
+    return (prototype, key, descriptor) => {
+        if (type.prototype) {
+            Reflect.defineMetadata(constants_1.DECORATORS.API_DEFAULT_GETTER, { getter: descriptor.value, parameter, prototype }, type.prototype);
+        }
+        return descriptor;
+    };
+}

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

@@ -0,0 +1 @@
+export declare function ApiExcludeController(disable?: boolean): ClassDecorator;

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

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiExcludeController = ApiExcludeController;
+const constants_1 = require("../constants");
+const helpers_1 = require("./helpers");
+function ApiExcludeController(disable = true) {
+    return (0, helpers_1.createClassDecorator)(constants_1.DECORATORS.API_EXCLUDE_CONTROLLER, [disable]);
+}

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

@@ -0,0 +1 @@
+export declare function ApiExcludeEndpoint(disable?: boolean): MethodDecorator;

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

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiExcludeEndpoint = ApiExcludeEndpoint;
+const constants_1 = require("../constants");
+const helpers_1 = require("./helpers");
+function ApiExcludeEndpoint(disable = true) {
+    return (0, helpers_1.createMethodDecorator)(constants_1.DECORATORS.API_EXCLUDE_ENDPOINT, {
+        disable
+    });
+}

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

@@ -0,0 +1 @@
+export declare function ApiExtension(extensionKey: string, extensionProperties: any): (target: object | Function, key?: string | symbol, descriptor?: TypedPropertyDescriptor<any>) => any;

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

@@ -0,0 +1,38 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiExtension = ApiExtension;
+const constants_1 = require("@nestjs/common/constants");
+const constants_2 = require("../constants");
+const lodash_1 = require("lodash");
+const shared_utils_1 = require("@nestjs/common/utils/shared.utils");
+function applyExtension(target, key, value) {
+    const extensions = Reflect.getMetadata(constants_2.DECORATORS.API_EXTENSION, target) || {};
+    Reflect.defineMetadata(constants_2.DECORATORS.API_EXTENSION, Object.assign({ [key]: value }, extensions), target);
+}
+function ApiExtension(extensionKey, extensionProperties) {
+    if (!extensionKey.startsWith('x-')) {
+        throw new Error('Extension key is not prefixed. Please ensure you prefix it with `x-`.');
+    }
+    return (target, key, descriptor) => {
+        const extensionValue = (0, lodash_1.clone)(extensionProperties);
+        if (descriptor) {
+            applyExtension(descriptor.value, extensionKey, extensionValue);
+            return descriptor;
+        }
+        if (typeof target === 'object') {
+            return target;
+        }
+        const apiMethods = Object.getOwnPropertyNames(target.prototype)
+            .filter((propertyKey) => !(0, shared_utils_1.isConstructor)(propertyKey))
+            .map((propertyKey) => { var _a; return (_a = Object.getOwnPropertyDescriptor(target.prototype, propertyKey)) === null || _a === void 0 ? void 0 : _a.value; })
+            .filter((methodDescriptor) => methodDescriptor !== undefined &&
+            Reflect.hasMetadata(constants_1.METHOD_METADATA, methodDescriptor));
+        if (apiMethods.length > 0) {
+            apiMethods.forEach((method) => applyExtension(method, extensionKey, extensionValue));
+        }
+        else {
+            applyExtension(target, extensionKey, extensionValue);
+        }
+        return target;
+    };
+}

package/dist/decorators/api-extra-models.decorator.d.ts

@@ -0,0 +1 @@
+export declare function ApiExtraModels(...models: Function[]): (target: object, key?: string | symbol, descriptor?: TypedPropertyDescriptor<any>) => any;

package/dist/decorators/api-extra-models.decorator.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiExtraModels = ApiExtraModels;
+const constants_1 = require("../constants");
+function ApiExtraModels(...models) {
+    return (target, key, descriptor) => {
+        if (descriptor) {
+            const extraModels = Reflect.getMetadata(constants_1.DECORATORS.API_EXTRA_MODELS, descriptor.value) ||
+                [];
+            Reflect.defineMetadata(constants_1.DECORATORS.API_EXTRA_MODELS, [...extraModels, ...models], descriptor.value);
+            return descriptor;
+        }
+        const extraModels = Reflect.getMetadata(constants_1.DECORATORS.API_EXTRA_MODELS, target) || [];
+        Reflect.defineMetadata(constants_1.DECORATORS.API_EXTRA_MODELS, [...extraModels, ...models], target);
+        return target;
+    };
+}

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

@@ -0,0 +1,7 @@
+import { ParameterObject } from '../interfaces/open-api-spec.interface';
+import { SwaggerEnumType } from '../types/swagger-enum.type';
+export interface ApiHeaderOptions extends Omit<ParameterObject, 'in'> {
+    enum?: SwaggerEnumType;
+}
+export declare function ApiHeader(options: ApiHeaderOptions): MethodDecorator & ClassDecorator;
+export declare const ApiHeaders: (headers: ApiHeaderOptions[]) => MethodDecorator & ClassDecorator;

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

@@ -0,0 +1,37 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiHeaders = void 0;
+exports.ApiHeader = ApiHeader;
+const lodash_1 = require("lodash");
+const constants_1 = require("../constants");
+const enum_utils_1 = require("../utils/enum.utils");
+const helpers_1 = require("./helpers");
+const defaultHeaderOptions = {
+    name: ''
+};
+function ApiHeader(options) {
+    const param = (0, lodash_1.pickBy)({
+        name: (0, lodash_1.isNil)(options.name) ? defaultHeaderOptions.name : options.name,
+        in: 'header',
+        description: options.description,
+        required: options.required,
+        examples: options.examples,
+        schema: Object.assign({ type: 'string' }, (options.schema || {}))
+    }, (0, lodash_1.negate)(lodash_1.isUndefined));
+    if (options.enum) {
+        const enumValues = (0, enum_utils_1.getEnumValues)(options.enum);
+        param.schema = Object.assign(Object.assign({}, 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, helpers_1.createClassDecorator)(constants_1.DECORATORS.API_HEADERS, [param])(target);
+    };
+}
+const ApiHeaders = (headers) => {
+    return (target, key, descriptor) => {
+        headers.forEach((options) => ApiHeader(options)(target, key, descriptor));
+    };
+};
+exports.ApiHeaders = ApiHeaders;

package/dist/decorators/api-hide-property.decorator.d.ts

@@ -0,0 +1 @@
+export declare function ApiHideProperty(): PropertyDecorator;

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

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiHideProperty = ApiHideProperty;
+function ApiHideProperty() {
+    return (target, propertyKey) => { };
+}

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

@@ -0,0 +1,7 @@
+import { Type } from '@nestjs/common';
+export interface ApiLinkOptions {
+    from: Type<unknown> | Function;
+    fromField?: string;
+    routeParam: string;
+}
+export declare function ApiLink({ from, fromField, routeParam }: ApiLinkOptions): MethodDecorator;

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

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiLink = ApiLink;
+const constants_1 = require("../constants");
+function ApiLink({ from, fromField = 'id', routeParam }) {
+    return (controllerPrototype, key, descriptor) => {
+        var _a;
+        const { prototype } = from;
+        if (prototype) {
+            const links = (_a = Reflect.getMetadata(constants_1.DECORATORS.API_LINK, prototype)) !== null && _a !== void 0 ? _a : [];
+            links.push({
+                method: descriptor.value,
+                prototype: controllerPrototype,
+                field: fromField,
+                parameter: routeParam
+            });
+            Reflect.defineMetadata(constants_1.DECORATORS.API_LINK, links, prototype);
+        }
+        return descriptor;
+    };
+}

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

@@ -0,0 +1 @@
+export declare function ApiOAuth2(scopes: string[], name?: string): ClassDecorator & MethodDecorator;

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

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

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

@@ -0,0 +1,5 @@
+import { OperationObject } from '../interfaces/open-api-spec.interface';
+export type ApiOperationOptions = Partial<OperationObject>;
+export declare function ApiOperation(options: ApiOperationOptions, { overrideExisting }?: {
+    overrideExisting: boolean;
+}): MethodDecorator;

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

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiOperation = ApiOperation;
+const lodash_1 = require("lodash");
+const constants_1 = require("../constants");
+const helpers_1 = require("./helpers");
+const defaultOperationOptions = {
+    summary: ''
+};
+function ApiOperation(options, { overrideExisting } = { overrideExisting: true }) {
+    return (0, helpers_1.createMethodDecorator)(constants_1.DECORATORS.API_OPERATION, (0, lodash_1.pickBy)(Object.assign(Object.assign({}, defaultOperationOptions), options), (0, lodash_1.negate)(lodash_1.isUndefined)), { overrideExisting });
+}

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

@@ -0,0 +1,22 @@
+import { Type } from '@nestjs/common';
+import { EnumSchemaAttributes } from '../interfaces/enum-schema-attributes.interface';
+import { ParameterObject, SchemaObject } from '../interfaces/open-api-spec.interface';
+import { SwaggerEnumType } from '../types/swagger-enum.type';
+type ParameterOptions = Omit<ParameterObject, 'in' | 'schema'>;
+interface ApiParamCommonMetadata extends ParameterOptions {
+    type?: Type<unknown> | Function | [Function] | string;
+    format?: string;
+    enum?: SwaggerEnumType;
+    enumName?: string;
+    enumSchema?: EnumSchemaAttributes;
+}
+type ApiParamMetadata = ApiParamCommonMetadata | (ApiParamCommonMetadata & {
+    enumName: string;
+    enumSchema?: EnumSchemaAttributes;
+});
+interface ApiParamSchemaHost extends ParameterOptions {
+    schema: SchemaObject;
+}
+export type ApiParamOptions = ApiParamMetadata | ApiParamSchemaHost;
+export declare function ApiParam(options: ApiParamOptions): MethodDecorator & ClassDecorator;
+export {};

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

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiParam = ApiParam;
+const lodash_1 = require("lodash");
+const enum_utils_1 = require("../utils/enum.utils");
+const helpers_1 = require("./helpers");
+const defaultParamOptions = {
+    name: '',
+    required: true
+};
+function ApiParam(options) {
+    const param = Object.assign({ name: (0, lodash_1.isNil)(options.name) ? defaultParamOptions.name : options.name, in: 'path' }, (0, lodash_1.omit)(options, 'enum'));
+    if ((0, enum_utils_1.isEnumDefined)(options)) {
+        (0, enum_utils_1.addEnumSchema)(param, options);
+    }
+    return (0, helpers_1.createParamDecorator)(param, defaultParamOptions);
+}

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

@@ -0,0 +1 @@
+export declare function ApiProduces(...mimeTypes: string[]): MethodDecorator & ClassDecorator;

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

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiProduces = ApiProduces;
+const constants_1 = require("../constants");
+const helpers_1 = require("./helpers");
+function ApiProduces(...mimeTypes) {
+    return (0, helpers_1.createMixedDecorator)(constants_1.DECORATORS.API_PRODUCES, mimeTypes);
+}

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

@@ -0,0 +1,15 @@
+import { Type } from '@nestjs/common';
+import { EnumSchemaAttributes } from '../interfaces/enum-schema-attributes.interface';
+import { SchemaObjectMetadata } from '../interfaces/schema-object-metadata.interface';
+export type ApiPropertyCommonOptions = SchemaObjectMetadata & {
+    'x-enumNames'?: string[];
+    link?: () => Type<unknown> | Function;
+};
+export type ApiPropertyOptions = ApiPropertyCommonOptions | (ApiPropertyCommonOptions & {
+    enumName: string;
+    enumSchema?: EnumSchemaAttributes;
+});
+export declare function ApiProperty(options?: ApiPropertyOptions): PropertyDecorator;
+export declare function createApiPropertyDecorator(options?: ApiPropertyOptions, overrideExisting?: boolean): PropertyDecorator;
+export declare function ApiPropertyOptional(options?: ApiPropertyOptions): PropertyDecorator;
+export declare function ApiResponseProperty(options?: Pick<ApiPropertyOptions, 'type' | 'example' | 'format' | 'deprecated' | 'enum'>): PropertyDecorator;

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

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiProperty = ApiProperty;
+exports.createApiPropertyDecorator = createApiPropertyDecorator;
+exports.ApiPropertyOptional = ApiPropertyOptional;
+exports.ApiResponseProperty = ApiResponseProperty;
+const constants_1 = require("../constants");
+const enum_utils_1 = require("../utils/enum.utils");
+const helpers_1 = require("./helpers");
+const isEnumArray = (opts) => opts.isArray && 'enum' in opts && opts.enum !== undefined;
+function ApiProperty(options = {}) {
+    return createApiPropertyDecorator(options);
+}
+function createApiPropertyDecorator(options = {}, overrideExisting = true) {
+    const [type, isArray] = (0, helpers_1.getTypeIsArrayTuple)(options.type, options.isArray);
+    options = Object.assign(Object.assign({}, options), { type,
+        isArray });
+    if (isEnumArray(options)) {
+        options.type = 'array';
+        const enumValues = (0, enum_utils_1.getEnumValues)(options.enum);
+        options.items = {
+            type: (0, enum_utils_1.getEnumType)(enumValues),
+            enum: enumValues
+        };
+        delete options.enum;
+    }
+    else if ('enum' in options && options.enum !== undefined) {
+        const enumValues = (0, enum_utils_1.getEnumValues)(options.enum);
+        options.enum = enumValues;
+        options.type = (0, enum_utils_1.getEnumType)(enumValues);
+    }
+    if (Array.isArray(options.type)) {
+        options.type = 'array';
+        options.items = {
+            type: 'array',
+            items: {
+                type: options.type[0]
+            }
+        };
+    }
+    return (0, helpers_1.createPropertyDecorator)(constants_1.DECORATORS.API_MODEL_PROPERTIES, options, overrideExisting);
+}
+function ApiPropertyOptional(options = {}) {
+    return ApiProperty(Object.assign(Object.assign({}, options), { required: false }));
+}
+function ApiResponseProperty(options = {}) {
+    return ApiProperty(Object.assign({ readOnly: true }, options));
+}

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

@@ -0,0 +1 @@
+export declare function ApiQueryMethod(): MethodDecorator;

package/dist/decorators/api-query-method.decorator.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiQueryMethod = ApiQueryMethod;
+const constants_1 = require("../constants");
+const helpers_1 = require("./helpers");
+function ApiQueryMethod() {
+    return (0, helpers_1.createMethodDecorator)(constants_1.DECORATORS.API_QUERY_METHOD, true);
+}

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

@@ -0,0 +1,24 @@
+import { Type } from '@nestjs/common';
+import { EnumSchemaAttributes } from '../interfaces/enum-schema-attributes.interface';
+import { ParameterObject, ReferenceObject, SchemaObject } from '../interfaces/open-api-spec.interface';
+import { SwaggerEnumType } from '../types/swagger-enum.type';
+type ParameterOptions = Omit<ParameterObject, 'in' | 'schema' | 'name'>;
+interface ApiQueryCommonMetadata extends ParameterOptions {
+    type?: Type<unknown> | Function | [Function] | string;
+    isArray?: boolean;
+    enum?: SwaggerEnumType;
+}
+export type ApiQueryMetadata = ApiQueryCommonMetadata | ({
+    name: string;
+} & ApiQueryCommonMetadata & Omit<SchemaObject, 'required'>) | ({
+    name?: string;
+    enumName: string;
+    enumSchema?: EnumSchemaAttributes;
+} & ApiQueryCommonMetadata);
+interface ApiQuerySchemaHost extends ParameterOptions {
+    name?: string;
+    schema: SchemaObject | ReferenceObject;
+}
+export type ApiQueryOptions = ApiQueryMetadata | ApiQuerySchemaHost;
+export declare function ApiQuery(options: ApiQueryOptions): MethodDecorator & ClassDecorator;
+export {};

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

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiQuery = ApiQuery;
+const lodash_1 = require("lodash");
+const enum_utils_1 = require("../utils/enum.utils");
+const helpers_1 = require("./helpers");
+const defaultQueryOptions = {
+    name: '',
+    required: true
+};
+function ApiQuery(options) {
+    const apiQueryMetadata = options;
+    const [type, isArray] = (0, helpers_1.getTypeIsArrayTuple)(apiQueryMetadata.type, apiQueryMetadata.isArray);
+    const param = Object.assign(Object.assign({ name: 'name' in options ? options.name : defaultQueryOptions.name, in: 'query' }, (0, lodash_1.omit)(options, 'enum')), { type });
+    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);
+    }
+    if (isArray) {
+        param.isArray = isArray;
+    }
+    return (0, helpers_1.createParamDecorator)(param, defaultQueryOptions);
+}

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

@@ -0,0 +1,39 @@
+import { Type } from '@nestjs/common';
+import { ReferenceObject, ResponseObject, SchemaObject } from '../interfaces/open-api-spec.interface';
+type ApiResponseExampleValue = any;
+export interface ApiResponseExamples {
+    summary: string;
+    value: ApiResponseExampleValue;
+}
+export interface ApiResponseCommonMetadata extends Omit<ResponseObject, 'description'> {
+    status?: number | 'default' | '1XX' | '2XX' | '3XX' | '4XX' | '5XX';
+    type?: Type<unknown> | Function | [Function] | string;
+    isArray?: boolean;
+    description?: string;
+}
+export type ApiResponseMetadata = (ApiResponseCommonMetadata & {
+    example?: ApiResponseExampleValue;
+}) | (ApiResponseCommonMetadata & {
+    examples?: {
+        [key: string]: ApiResponseExamples;
+    };
+});
+export interface ApiResponseSchemaHost extends Omit<ResponseObject, 'description'> {
+    schema: SchemaObject & Partial<ReferenceObject>;
+    status?: number | 'default' | '1XX' | '2XX' | '3XX' | '4XX' | '5XX';
+    description?: string;
+}
+export type ApiResponseOptions = ApiResponseMetadata | ApiResponseSchemaHost;
+export type ApiResponseNoStatusOptions = (Omit<ApiResponseCommonMetadata, 'status'> & {
+    example?: ApiResponseExampleValue;
+}) | (Omit<ApiResponseCommonMetadata, 'status'> & {
+    examples?: {
+        [key: string]: ApiResponseExamples;
+    };
+}) | Omit<ApiResponseSchemaHost, 'status'>;
+export declare function ApiResponse(options: ApiResponseOptions, { overrideExisting }?: {
+    overrideExisting: boolean;
+}): MethodDecorator & ClassDecorator;
+export declare const ApiContinueResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiSwitchingProtocolsResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiProcessingResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiEarlyhintsResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiOkResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiCreatedResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiAcceptedResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiNonAuthoritativeInformationResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiNoContentResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiResetContentResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiPartialContentResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiAmbiguousResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiMovedPermanentlyResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiFoundResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiSeeOtherResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiNotModifiedResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiTemporaryRedirectResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiPermanentRedirectResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiBadRequestResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiUnauthorizedResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiPaymentRequiredResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiForbiddenResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiNotFoundResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiMethodNotAllowedResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiNotAcceptableResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiProxyAuthenticationRequiredResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiRequestTimeoutResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiConflictResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiGoneResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiLengthRequiredResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiPreconditionFailedResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiPayloadTooLargeResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiUriTooLongResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiUnsupportedMediaTypeResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiRequestedRangeNotSatisfiableResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiExpectationFailedResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiIAmATeapotResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiMisdirectedResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiUnprocessableEntityResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiFailedDependencyResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiPreconditionRequiredResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiTooManyRequestsResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiInternalServerErrorResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiNotImplementedResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiBadGatewayResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiServiceUnavailableResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiGatewayTimeoutResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator, ApiHttpVersionNotSupportedResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator;
+export declare const ApiDefaultResponse: (options?: ApiResponseNoStatusOptions) => MethodDecorator & ClassDecorator;
+export {};