nestjs-openapi-next 1.0.0

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

@@ -0,0 +1,55 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiDefaultResponse = exports.ApiHttpVersionNotSupportedResponse = exports.ApiGatewayTimeoutResponse = exports.ApiServiceUnavailableResponse = exports.ApiBadGatewayResponse = exports.ApiNotImplementedResponse = exports.ApiInternalServerErrorResponse = exports.ApiTooManyRequestsResponse = exports.ApiPreconditionRequiredResponse = exports.ApiFailedDependencyResponse = exports.ApiUnprocessableEntityResponse = exports.ApiMisdirectedResponse = exports.ApiIAmATeapotResponse = exports.ApiExpectationFailedResponse = exports.ApiRequestedRangeNotSatisfiableResponse = exports.ApiUnsupportedMediaTypeResponse = exports.ApiUriTooLongResponse = exports.ApiPayloadTooLargeResponse = exports.ApiPreconditionFailedResponse = exports.ApiLengthRequiredResponse = exports.ApiGoneResponse = exports.ApiConflictResponse = exports.ApiRequestTimeoutResponse = exports.ApiProxyAuthenticationRequiredResponse = exports.ApiNotAcceptableResponse = exports.ApiMethodNotAllowedResponse = exports.ApiNotFoundResponse = exports.ApiForbiddenResponse = exports.ApiPaymentRequiredResponse = exports.ApiUnauthorizedResponse = exports.ApiBadRequestResponse = exports.ApiPermanentRedirectResponse = exports.ApiTemporaryRedirectResponse = exports.ApiNotModifiedResponse = exports.ApiSeeOtherResponse = exports.ApiFoundResponse = exports.ApiMovedPermanentlyResponse = exports.ApiAmbiguousResponse = exports.ApiPartialContentResponse = exports.ApiResetContentResponse = exports.ApiNoContentResponse = exports.ApiNonAuthoritativeInformationResponse = exports.ApiAcceptedResponse = exports.ApiCreatedResponse = exports.ApiOkResponse = exports.ApiEarlyhintsResponse = exports.ApiProcessingResponse = exports.ApiSwitchingProtocolsResponse = exports.ApiContinueResponse = void 0;
+exports.ApiResponse = ApiResponse;
+const common_1 = require("@nestjs/common");
+const lodash_1 = require("lodash");
+const constants_1 = require("../constants");
+const helpers_1 = require("./helpers");
+function ApiResponse(options, { overrideExisting } = { overrideExisting: true }) {
+    const apiResponseMetadata = options;
+    const [type, isArray] = (0, helpers_1.getTypeIsArrayTuple)(apiResponseMetadata.type, apiResponseMetadata.isArray);
+    apiResponseMetadata.type = type;
+    apiResponseMetadata.isArray = isArray;
+    options.description = options.description ? options.description : '';
+    const groupedMetadata = {
+        [options.status || 'default']: (0, lodash_1.omit)(options, 'status')
+    };
+    return (target, key, descriptor) => {
+        if (descriptor) {
+            const responses = Reflect.getMetadata(constants_1.DECORATORS.API_RESPONSE, descriptor.value);
+            if (responses && !overrideExisting) {
+                return descriptor;
+            }
+            Reflect.defineMetadata(constants_1.DECORATORS.API_RESPONSE, Object.assign(Object.assign({}, responses), groupedMetadata), descriptor.value);
+            return descriptor;
+        }
+        const responses = Reflect.getMetadata(constants_1.DECORATORS.API_RESPONSE, target);
+        if (responses && !overrideExisting) {
+            return descriptor;
+        }
+        Reflect.defineMetadata(constants_1.DECORATORS.API_RESPONSE, Object.assign(Object.assign({}, responses), groupedMetadata), target);
+        return target;
+    };
+}
+const decorators = {};
+const statusList = Object.keys(common_1.HttpStatus)
+    .filter((key) => !isNaN(Number(common_1.HttpStatus[key])))
+    .map((key) => {
+    const functionName = key
+        .split('_')
+        .map((strToken) => `${strToken[0].toUpperCase()}${strToken.slice(1).toLowerCase()}`)
+        .join('');
+    return {
+        code: Number(common_1.HttpStatus[key]),
+        functionName: `Api${functionName}Response`
+    };
+});
+statusList.forEach(({ code, functionName }) => {
+    decorators[functionName] = function (options = {}) {
+        return ApiResponse(Object.assign(Object.assign({}, options), { status: code }));
+    };
+});
+exports.ApiContinueResponse = decorators.ApiContinueResponse, exports.ApiSwitchingProtocolsResponse = decorators.ApiSwitchingProtocolsResponse, exports.ApiProcessingResponse = decorators.ApiProcessingResponse, exports.ApiEarlyhintsResponse = decorators.ApiEarlyhintsResponse, exports.ApiOkResponse = decorators.ApiOkResponse, exports.ApiCreatedResponse = decorators.ApiCreatedResponse, exports.ApiAcceptedResponse = decorators.ApiAcceptedResponse, exports.ApiNonAuthoritativeInformationResponse = decorators.ApiNonAuthoritativeInformationResponse, exports.ApiNoContentResponse = decorators.ApiNoContentResponse, exports.ApiResetContentResponse = decorators.ApiResetContentResponse, exports.ApiPartialContentResponse = decorators.ApiPartialContentResponse, exports.ApiAmbiguousResponse = decorators.ApiAmbiguousResponse, exports.ApiMovedPermanentlyResponse = decorators.ApiMovedPermanentlyResponse, exports.ApiFoundResponse = decorators.ApiFoundResponse, exports.ApiSeeOtherResponse = decorators.ApiSeeOtherResponse, exports.ApiNotModifiedResponse = decorators.ApiNotModifiedResponse, exports.ApiTemporaryRedirectResponse = decorators.ApiTemporaryRedirectResponse, exports.ApiPermanentRedirectResponse = decorators.ApiPermanentRedirectResponse, exports.ApiBadRequestResponse = decorators.ApiBadRequestResponse, exports.ApiUnauthorizedResponse = decorators.ApiUnauthorizedResponse, exports.ApiPaymentRequiredResponse = decorators.ApiPaymentRequiredResponse, exports.ApiForbiddenResponse = decorators.ApiForbiddenResponse, exports.ApiNotFoundResponse = decorators.ApiNotFoundResponse, exports.ApiMethodNotAllowedResponse = decorators.ApiMethodNotAllowedResponse, exports.ApiNotAcceptableResponse = decorators.ApiNotAcceptableResponse, exports.ApiProxyAuthenticationRequiredResponse = decorators.ApiProxyAuthenticationRequiredResponse, exports.ApiRequestTimeoutResponse = decorators.ApiRequestTimeoutResponse, exports.ApiConflictResponse = decorators.ApiConflictResponse, exports.ApiGoneResponse = decorators.ApiGoneResponse, exports.ApiLengthRequiredResponse = decorators.ApiLengthRequiredResponse, exports.ApiPreconditionFailedResponse = decorators.ApiPreconditionFailedResponse, exports.ApiPayloadTooLargeResponse = decorators.ApiPayloadTooLargeResponse, exports.ApiUriTooLongResponse = decorators.ApiUriTooLongResponse, exports.ApiUnsupportedMediaTypeResponse = decorators.ApiUnsupportedMediaTypeResponse, exports.ApiRequestedRangeNotSatisfiableResponse = decorators.ApiRequestedRangeNotSatisfiableResponse, exports.ApiExpectationFailedResponse = decorators.ApiExpectationFailedResponse, exports.ApiIAmATeapotResponse = decorators.ApiIAmATeapotResponse, exports.ApiMisdirectedResponse = decorators.ApiMisdirectedResponse, exports.ApiUnprocessableEntityResponse = decorators.ApiUnprocessableEntityResponse, exports.ApiFailedDependencyResponse = decorators.ApiFailedDependencyResponse, exports.ApiPreconditionRequiredResponse = decorators.ApiPreconditionRequiredResponse, exports.ApiTooManyRequestsResponse = decorators.ApiTooManyRequestsResponse, exports.ApiInternalServerErrorResponse = decorators.ApiInternalServerErrorResponse, exports.ApiNotImplementedResponse = decorators.ApiNotImplementedResponse, exports.ApiBadGatewayResponse = decorators.ApiBadGatewayResponse, exports.ApiServiceUnavailableResponse = decorators.ApiServiceUnavailableResponse, exports.ApiGatewayTimeoutResponse = decorators.ApiGatewayTimeoutResponse, exports.ApiHttpVersionNotSupportedResponse = decorators.ApiHttpVersionNotSupportedResponse;
+const ApiDefaultResponse = (options = {}) => ApiResponse(Object.assign(Object.assign({}, options), { status: 'default' }));
+exports.ApiDefaultResponse = ApiDefaultResponse;

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

@@ -0,0 +1,6 @@
+import { SchemaObjectMetadata } from '../interfaces/schema-object-metadata.interface';
+export interface ApiSchemaOptions extends Pick<SchemaObjectMetadata, 'name'> {
+    name?: string;
+    description?: string;
+}
+export declare function ApiSchema(options?: ApiSchemaOptions): ClassDecorator;

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

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

package/dist/decorators/api-security-device-flow.decorator.d.ts

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

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

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

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

@@ -0,0 +1,2 @@
+import { SecurityRequirementObject } from '../interfaces/open-api-spec.interface';
+export declare function ApiSecurity(name: string | SecurityRequirementObject, requirements?: string[]): ClassDecorator & MethodDecorator;

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

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiSecurity = ApiSecurity;
+const lodash_1 = require("lodash");
+const constants_1 = require("../constants");
+const extend_metadata_util_1 = require("../utils/extend-metadata.util");
+function ApiSecurity(name, requirements = []) {
+    let metadata;
+    if ((0, lodash_1.isString)(name)) {
+        metadata = [{ [name]: requirements }];
+    }
+    else {
+        metadata = [name];
+    }
+    return (target, key, descriptor) => {
+        if (descriptor) {
+            metadata = (0, extend_metadata_util_1.extendMetadata)(metadata, constants_1.DECORATORS.API_SECURITY, descriptor.value);
+            Reflect.defineMetadata(constants_1.DECORATORS.API_SECURITY, metadata, descriptor.value);
+            return descriptor;
+        }
+        metadata = (0, extend_metadata_util_1.extendMetadata)(metadata, constants_1.DECORATORS.API_SECURITY, target);
+        Reflect.defineMetadata(constants_1.DECORATORS.API_SECURITY, metadata, target);
+        return target;
+    };
+}

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

@@ -0,0 +1,7 @@
+import { Type } from '@nestjs/common';
+import { ApiResponseCommonMetadata } from './api-response.decorator';
+export interface ApiStreamingResponseOptions extends Omit<ApiResponseCommonMetadata, 'type' | 'isArray' | 'content'> {
+    contentType: string;
+    type: () => Type<unknown> | Function | [Function] | string;
+}
+export declare function ApiStreamingResponse(options: ApiStreamingResponseOptions): MethodDecorator & ClassDecorator;

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

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiStreamingResponse = ApiStreamingResponse;
+const api_response_decorator_1 = require("./api-response.decorator");
+function ApiStreamingResponse(options) {
+    var _a;
+    const resolvedType = (_a = options.type) === null || _a === void 0 ? void 0 : _a.call(options);
+    return (0, api_response_decorator_1.ApiResponse)(Object.assign(Object.assign({}, options), { type: resolvedType, isStreaming: true, contentType: options.contentType }));
+}

package/dist/decorators/api-tag-group.decorator.d.ts

@@ -0,0 +1,11 @@
+import { TagObject } from '../interfaces/open-api-spec.interface';
+export type ApiTagGroupKind = 'audience' | 'badge' | 'nav' | (string & {});
+export interface ApiTagGroupOptions extends Pick<TagObject, 'name' | 'summary' | 'description' | 'externalDocs' | 'parent' | 'kind'> {
+    name: string;
+    summary?: string;
+    description?: string;
+    externalDocs?: TagObject['externalDocs'];
+    parent?: string;
+    kind?: ApiTagGroupKind;
+}
+export declare function ApiTagGroup(options: ApiTagGroupOptions): ClassDecorator;

package/dist/decorators/api-tag-group.decorator.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiTagGroup = ApiTagGroup;
+const constants_1 = require("../constants");
+const api_use_tags_decorator_1 = require("./api-use-tags.decorator");
+function ApiTagGroup(options) {
+    return (target) => {
+        const previous = Reflect.getMetadata(constants_1.DECORATORS.API_TAG_GROUP, target) || [];
+        Reflect.defineMetadata(constants_1.DECORATORS.API_TAG_GROUP, [...previous, options], target);
+        (0, api_use_tags_decorator_1.ApiTags)(options.name)(target);
+        return target;
+    };
+}

package/dist/decorators/api-use-tags.decorator.d.ts

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

package/dist/decorators/api-use-tags.decorator.js

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

package/dist/decorators/helpers.d.ts

@@ -0,0 +1,8 @@
+export declare function createMethodDecorator<T = any>(metakey: string, metadata: T, { overrideExisting }?: {
+    overrideExisting: boolean;
+}): MethodDecorator;
+export declare function createClassDecorator<T extends Array<any> = any>(metakey: string, metadata?: T): ClassDecorator;
+export declare function createPropertyDecorator<T extends Record<string, any> = any>(metakey: string, metadata: T, overrideExisting?: boolean): PropertyDecorator;
+export declare function createMixedDecorator<T = any>(metakey: string, metadata: T): MethodDecorator & ClassDecorator;
+export declare function createParamDecorator<T extends Record<string, any> = any>(metadata: T, initial: Partial<T>): MethodDecorator & ClassDecorator;
+export declare function getTypeIsArrayTuple(input: Function | [Function] | undefined | string | Record<string, any>, isArrayFlag: boolean): [Function | undefined, boolean];

package/dist/decorators/helpers.js

@@ -0,0 +1,123 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createMethodDecorator = createMethodDecorator;
+exports.createClassDecorator = createClassDecorator;
+exports.createPropertyDecorator = createPropertyDecorator;
+exports.createMixedDecorator = createMixedDecorator;
+exports.createParamDecorator = createParamDecorator;
+exports.getTypeIsArrayTuple = getTypeIsArrayTuple;
+const constants_1 = require("@nestjs/common/constants");
+const shared_utils_1 = require("@nestjs/common/utils/shared.utils");
+const lodash_1 = require("lodash");
+const constants_2 = require("../constants");
+const plugin_constants_1 = require("../plugin/plugin-constants");
+function createMethodDecorator(metakey, metadata, { overrideExisting } = { overrideExisting: true }) {
+    return (target, key, descriptor) => {
+        if (typeof metadata === 'object') {
+            const prevValue = Reflect.getMetadata(metakey, descriptor.value);
+            if (prevValue && !overrideExisting) {
+                return descriptor;
+            }
+            Reflect.defineMetadata(metakey, Object.assign(Object.assign({}, prevValue), metadata), descriptor.value);
+            return descriptor;
+        }
+        Reflect.defineMetadata(metakey, metadata, descriptor.value);
+        return descriptor;
+    };
+}
+function createClassDecorator(metakey, metadata = []) {
+    return (target) => {
+        const prevValue = Reflect.getMetadata(metakey, target) || [];
+        Reflect.defineMetadata(metakey, [...prevValue, ...metadata], target);
+        return target;
+    };
+}
+function createPropertyDecorator(metakey, metadata, overrideExisting = true) {
+    return (target, propertyKey) => {
+        var _a, _b, _c, _d;
+        const properties = Reflect.getMetadata(constants_2.DECORATORS.API_MODEL_PROPERTIES_ARRAY, target) || [];
+        const key = `:${propertyKey}`;
+        if (!properties.includes(key)) {
+            Reflect.defineMetadata(constants_2.DECORATORS.API_MODEL_PROPERTIES_ARRAY, [...properties, `:${propertyKey}`], target);
+        }
+        const existingMetadata = Reflect.getMetadata(metakey, target, propertyKey);
+        if (existingMetadata) {
+            const newMetadata = (0, lodash_1.pickBy)(metadata, (0, lodash_1.negate)(lodash_1.isUndefined));
+            const metadataToSave = overrideExisting
+                ? Object.assign(Object.assign({}, existingMetadata), newMetadata) : Object.assign(Object.assign({}, newMetadata), existingMetadata);
+            Reflect.defineMetadata(metakey, metadataToSave, target, propertyKey);
+        }
+        else {
+            const type = (_d = (_c = (_b = (_a = target === null || target === void 0 ? void 0 : target.constructor) === null || _a === void 0 ? void 0 : _a[plugin_constants_1.METADATA_FACTORY_NAME]) === null || _b === void 0 ? void 0 : _b.call(_a)[propertyKey]) === null || _c === void 0 ? void 0 : _c.type) !== null && _d !== void 0 ? _d : Reflect.getMetadata('design:type', target, propertyKey);
+            Reflect.defineMetadata(metakey, Object.assign({ type }, (0, lodash_1.pickBy)(metadata, (0, lodash_1.negate)(lodash_1.isUndefined))), target, propertyKey);
+        }
+    };
+}
+function createMixedDecorator(metakey, metadata) {
+    return (target, key, descriptor) => {
+        if (descriptor) {
+            let metadatas;
+            if (Array.isArray(metadata)) {
+                const previousMetadata = Reflect.getMetadata(metakey, descriptor.value) || [];
+                metadatas = [...previousMetadata, ...metadata];
+            }
+            else {
+                const previousMetadata = Reflect.getMetadata(metakey, descriptor.value) || {};
+                metadatas = Object.assign(Object.assign({}, previousMetadata), metadata);
+            }
+            Reflect.defineMetadata(metakey, metadatas, descriptor.value);
+            return descriptor;
+        }
+        let metadatas;
+        if (Array.isArray(metadata)) {
+            const previousMetadata = Reflect.getMetadata(metakey, target) || [];
+            metadatas = [...previousMetadata, ...metadata];
+        }
+        else {
+            const previousMetadata = Reflect.getMetadata(metakey, target) || {};
+            metadatas = Object.assign(Object.assign({}, previousMetadata), metadata);
+        }
+        Reflect.defineMetadata(metakey, metadatas, target);
+        return target;
+    };
+}
+function createParamDecorator(metadata, initial) {
+    return (target, key, descriptor) => {
+        const paramOptions = Object.assign(Object.assign({}, initial), (0, lodash_1.pickBy)(metadata, (0, lodash_1.negate)(lodash_1.isUndefined)));
+        if (descriptor) {
+            const parameters = Reflect.getMetadata(constants_2.DECORATORS.API_PARAMETERS, descriptor.value) || [];
+            Reflect.defineMetadata(constants_2.DECORATORS.API_PARAMETERS, [...parameters, paramOptions], descriptor.value);
+            return descriptor;
+        }
+        if (typeof target === 'object') {
+            return target;
+        }
+        const propertyKeys = Object.getOwnPropertyNames(target.prototype);
+        for (const propertyKey of propertyKeys) {
+            if ((0, shared_utils_1.isConstructor)(propertyKey)) {
+                continue;
+            }
+            const methodDescriptor = Object.getOwnPropertyDescriptor(target.prototype, propertyKey);
+            if (!methodDescriptor) {
+                continue;
+            }
+            const isApiMethod = Reflect.hasMetadata(constants_1.METHOD_METADATA, methodDescriptor.value);
+            if (!isApiMethod) {
+                continue;
+            }
+            const parameters = Reflect.getMetadata(constants_2.DECORATORS.API_PARAMETERS, methodDescriptor.value) || [];
+            Reflect.defineMetadata(constants_2.DECORATORS.API_PARAMETERS, [...parameters, paramOptions], methodDescriptor.value);
+        }
+    };
+}
+function getTypeIsArrayTuple(input, isArrayFlag) {
+    if (!input) {
+        return [input, isArrayFlag];
+    }
+    if (isArrayFlag) {
+        return [input, isArrayFlag];
+    }
+    const isInputArray = (0, lodash_1.isArray)(input);
+    const type = isInputArray ? input[0] : input;
+    return [type, isInputArray];
+}

package/dist/decorators/index.d.ts

@@ -0,0 +1,28 @@
+export * from './api-basic.decorator';
+export * from './api-bearer.decorator';
+export * from './api-body.decorator';
+export * from './api-consumes.decorator';
+export * from './api-cookie.decorator';
+export * from './api-default-getter.decorator';
+export * from './api-exclude-endpoint.decorator';
+export * from './api-exclude-controller.decorator';
+export * from './api-extra-models.decorator';
+export * from './api-header.decorator';
+export * from './api-hide-property.decorator';
+export * from './api-link.decorator';
+export * from './api-oauth2.decorator';
+export * from './api-operation.decorator';
+export * from './api-param.decorator';
+export * from './api-produces.decorator';
+export { ApiProperty, ApiPropertyOptional, ApiPropertyOptions, ApiResponseProperty } from './api-property.decorator';
+export * from './api-query.decorator';
+export * from './api-query-method.decorator';
+export * from './api-response.decorator';
+export * from './api-streaming-response.decorator';
+export * from './api-security.decorator';
+export * from './api-security-device-flow.decorator';
+export * from './api-use-tags.decorator';
+export * from './api-tag-group.decorator';
+export * from './api-callbacks.decorator';
+export * from './api-extension.decorator';
+export * from './api-schema.decorator';

package/dist/decorators/index.js

@@ -0,0 +1,48 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ApiResponseProperty = exports.ApiPropertyOptional = exports.ApiProperty = void 0;
+__exportStar(require("./api-basic.decorator"), exports);
+__exportStar(require("./api-bearer.decorator"), exports);
+__exportStar(require("./api-body.decorator"), exports);
+__exportStar(require("./api-consumes.decorator"), exports);
+__exportStar(require("./api-cookie.decorator"), exports);
+__exportStar(require("./api-default-getter.decorator"), exports);
+__exportStar(require("./api-exclude-endpoint.decorator"), exports);
+__exportStar(require("./api-exclude-controller.decorator"), exports);
+__exportStar(require("./api-extra-models.decorator"), exports);
+__exportStar(require("./api-header.decorator"), exports);
+__exportStar(require("./api-hide-property.decorator"), exports);
+__exportStar(require("./api-link.decorator"), exports);
+__exportStar(require("./api-oauth2.decorator"), exports);
+__exportStar(require("./api-operation.decorator"), exports);
+__exportStar(require("./api-param.decorator"), exports);
+__exportStar(require("./api-produces.decorator"), exports);
+var api_property_decorator_1 = require("./api-property.decorator");
+Object.defineProperty(exports, "ApiProperty", { enumerable: true, get: function () { return api_property_decorator_1.ApiProperty; } });
+Object.defineProperty(exports, "ApiPropertyOptional", { enumerable: true, get: function () { return api_property_decorator_1.ApiPropertyOptional; } });
+Object.defineProperty(exports, "ApiResponseProperty", { enumerable: true, get: function () { return api_property_decorator_1.ApiResponseProperty; } });
+__exportStar(require("./api-query.decorator"), exports);
+__exportStar(require("./api-query-method.decorator"), exports);
+__exportStar(require("./api-response.decorator"), exports);
+__exportStar(require("./api-streaming-response.decorator"), exports);
+__exportStar(require("./api-security.decorator"), exports);
+__exportStar(require("./api-security-device-flow.decorator"), exports);
+__exportStar(require("./api-use-tags.decorator"), exports);
+__exportStar(require("./api-tag-group.decorator"), exports);
+__exportStar(require("./api-callbacks.decorator"), exports);
+__exportStar(require("./api-extension.decorator"), exports);
+__exportStar(require("./api-schema.decorator"), exports);

package/dist/document-builder.d.ts

@@ -0,0 +1,29 @@
+import { ApiResponseOptions } from './decorators/api-response.decorator';
+import { OpenAPIObject } from './interfaces';
+import { ExtensionLocation, ExternalDocumentationObject, ParameterObject, SecurityRequirementObject, SecuritySchemeObject, ServerVariableObject } from './interfaces/open-api-spec.interface';
+export declare class DocumentBuilder {
+    private readonly logger;
+    private readonly document;
+    setTitle(title: string): this;
+    setDescription(description: string): this;
+    setVersion(version: string): this;
+    setTermsOfService(termsOfService: string): this;
+    setContact(name: string, url: string, email: string): this;
+    setLicense(name: string, url: string): this;
+    setOpenAPIVersion(version: string): this;
+    addServer(url: string, description?: string, variables?: Record<string, ServerVariableObject>): this;
+    setExternalDoc(description: string, url: string): this;
+    setBasePath(path: string): this;
+    addTag(name: string, description?: string, externalDocs?: ExternalDocumentationObject, summary?: string): this;
+    addExtension(extensionKey: string, extensionProperties: any, location?: ExtensionLocation): this;
+    addSecurity(name: string, options: SecuritySchemeObject): this;
+    addGlobalResponse(...respones: ApiResponseOptions[]): this;
+    addGlobalParameters(...parameters: Omit<ParameterObject, 'example' | 'examples'>[]): this;
+    addSecurityRequirements(name: string | SecurityRequirementObject, requirements?: string[]): this;
+    addBearerAuth(options?: SecuritySchemeObject, name?: string): this;
+    addOAuth2(options?: SecuritySchemeObject, name?: string): this;
+    addApiKey(options?: SecuritySchemeObject, name?: string): this;
+    addBasicAuth(options?: SecuritySchemeObject, name?: string): this;
+    addCookieAuth(cookieName?: string, options?: SecuritySchemeObject, securityName?: string): this;
+    build(): Omit<OpenAPIObject, 'paths'>;
+}

package/dist/document-builder.js

@@ -0,0 +1,142 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DocumentBuilder = void 0;
+const common_1 = require("@nestjs/common");
+const lodash_1 = require("lodash");
+const document_base_1 = require("./fixtures/document.base");
+const global_parameters_storage_1 = require("./storages/global-parameters.storage");
+const global_responses_storage_1 = require("./storages/global-responses.storage");
+class DocumentBuilder {
+    constructor() {
+        this.logger = new common_1.Logger(DocumentBuilder.name);
+        this.document = (0, document_base_1.buildDocumentBase)();
+    }
+    setTitle(title) {
+        this.document.info.title = title;
+        return this;
+    }
+    setDescription(description) {
+        this.document.info.description = description;
+        return this;
+    }
+    setVersion(version) {
+        this.document.info.version = version;
+        return this;
+    }
+    setTermsOfService(termsOfService) {
+        this.document.info.termsOfService = termsOfService;
+        return this;
+    }
+    setContact(name, url, email) {
+        this.document.info.contact = { name, url, email };
+        return this;
+    }
+    setLicense(name, url) {
+        this.document.info.license = { name, url };
+        return this;
+    }
+    setOpenAPIVersion(version) {
+        if (version.match(/^\d\.\d\.\d$/)) {
+            this.document.openapi = version;
+        }
+        else {
+            this.logger.warn('The OpenApi version is invalid. Expecting format "x.x.x"');
+        }
+        return this;
+    }
+    addServer(url, description, variables) {
+        this.document.servers.push({ url, description, variables });
+        return this;
+    }
+    setExternalDoc(description, url) {
+        this.document.externalDocs = { description, url };
+        return this;
+    }
+    setBasePath(path) {
+        this.logger.warn('The "setBasePath" method has been deprecated. Now, a global prefix is populated automatically. If you want to ignore it, take a look here: https://docs.nestjs.com/recipes/swagger#global-prefix. Alternatively, you can use "addServer" method to set up multiple different paths.');
+        return this;
+    }
+    addTag(name, description = '', externalDocs, summary) {
+        this.document.tags = this.document.tags.concat((0, lodash_1.pickBy)({
+            name,
+            summary,
+            description,
+            externalDocs
+        }, (0, lodash_1.negate)(lodash_1.isUndefined)));
+        return this;
+    }
+    addExtension(extensionKey, extensionProperties, location = 'root') {
+        if (!extensionKey.startsWith('x-')) {
+            throw new Error('Extension key is not prefixed. Please ensure you prefix it with `x-`.');
+        }
+        if (location === 'root') {
+            this.document[extensionKey] = (0, lodash_1.clone)(extensionProperties);
+        }
+        else {
+            this.document[location][extensionKey] = (0, lodash_1.clone)(extensionProperties);
+        }
+        return this;
+    }
+    addSecurity(name, options) {
+        this.document.components.securitySchemes = Object.assign(Object.assign({}, (this.document.components.securitySchemes || {})), { [name]: options });
+        return this;
+    }
+    addGlobalResponse(...respones) {
+        const groupedByStatus = respones.reduce((acc, response) => {
+            const { status = 'default' } = response;
+            acc[status] = (0, lodash_1.omit)(response, 'status');
+            return acc;
+        }, {});
+        global_responses_storage_1.GlobalResponsesStorage.add(groupedByStatus);
+        return this;
+    }
+    addGlobalParameters(...parameters) {
+        global_parameters_storage_1.GlobalParametersStorage.add(...parameters);
+        return this;
+    }
+    addSecurityRequirements(name, requirements = []) {
+        let securityRequirement;
+        if ((0, lodash_1.isString)(name)) {
+            securityRequirement = { [name]: requirements };
+        }
+        else {
+            securityRequirement = name;
+        }
+        this.document.security = (this.document.security || []).concat(Object.assign({}, securityRequirement));
+        return this;
+    }
+    addBearerAuth(options = {
+        type: 'http'
+    }, name = 'bearer') {
+        this.addSecurity(name, Object.assign({ scheme: 'bearer', bearerFormat: 'JWT' }, options));
+        return this;
+    }
+    addOAuth2(options = {
+        type: 'oauth2'
+    }, name = 'oauth2') {
+        this.addSecurity(name, Object.assign({ type: 'oauth2', flows: {} }, options));
+        return this;
+    }
+    addApiKey(options = {
+        type: 'apiKey'
+    }, name = 'api_key') {
+        this.addSecurity(name, Object.assign({ type: 'apiKey', in: 'header', name }, options));
+        return this;
+    }
+    addBasicAuth(options = {
+        type: 'http'
+    }, name = 'basic') {
+        this.addSecurity(name, Object.assign({ type: 'http', scheme: 'basic' }, options));
+        return this;
+    }
+    addCookieAuth(cookieName = 'connect.sid', options = {
+        type: 'apiKey'
+    }, securityName = 'cookie') {
+        this.addSecurity(securityName, Object.assign({ type: 'apiKey', in: 'cookie', name: cookieName }, options));
+        return this;
+    }
+    build() {
+        return this.document;
+    }
+}
+exports.DocumentBuilder = DocumentBuilder;

package/dist/explorers/api-callbacks.explorer.d.ts

@@ -0,0 +1,2 @@
+import { Type } from '@nestjs/common';
+export declare const exploreApiCallbacksMetadata: (instance: object, prototype: Type<unknown>, method: object) => any;

package/dist/explorers/api-callbacks.explorer.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exploreApiCallbacksMetadata = void 0;
+const constants_1 = require("../constants");
+const utils_1 = require("../utils");
+const exploreApiCallbacksMetadata = (instance, prototype, method) => {
+    const callbacksData = Reflect.getMetadata(constants_1.DECORATORS.API_CALLBACKS, method);
+    if (!callbacksData)
+        return callbacksData;
+    return callbacksData.reduce((acc, callbackData) => {
+        const { name: eventName, callbackUrl, method: callbackMethod, requestBody, expectedResponse } = callbackData;
+        return Object.assign(Object.assign({}, acc), { [eventName]: {
+                [callbackUrl]: {
+                    [callbackMethod]: {
+                        requestBody: {
+                            required: true,
+                            content: {
+                                'application/json': {
+                                    schema: {
+                                        $ref: (0, utils_1.getSchemaPath)(requestBody.type)
+                                    }
+                                }
+                            }
+                        },
+                        responses: {
+                            [expectedResponse.status]: {
+                                description: expectedResponse.description ||
+                                    'Your server returns this code if it accepts the callback'
+                            }
+                        }
+                    }
+                }
+            } });
+    }, {});
+};
+exports.exploreApiCallbacksMetadata = exploreApiCallbacksMetadata;

package/dist/explorers/api-consumes.explorer.d.ts

@@ -0,0 +1,5 @@
+import { Type } from '@nestjs/common';
+export declare const exploreGlobalApiConsumesMetadata: (metatype: Type<unknown>) => {
+    consumes: any;
+};
+export declare const exploreApiConsumesMetadata: (instance: object, prototype: Type<unknown>, method: object) => string[] | undefined;

package/dist/explorers/api-consumes.explorer.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exploreApiConsumesMetadata = exports.exploreGlobalApiConsumesMetadata = void 0;
+const constants_1 = require("../constants");
+const exploreGlobalApiConsumesMetadata = (metatype) => {
+    const consumes = Reflect.getMetadata(constants_1.DECORATORS.API_CONSUMES, metatype);
+    return consumes ? { consumes } : undefined;
+};
+exports.exploreGlobalApiConsumesMetadata = exploreGlobalApiConsumesMetadata;
+const exploreApiConsumesMetadata = (instance, prototype, method) => Reflect.getMetadata(constants_1.DECORATORS.API_CONSUMES, method);
+exports.exploreApiConsumesMetadata = exploreApiConsumesMetadata;

package/dist/explorers/api-exclude-controller.explorer.d.ts

@@ -0,0 +1,2 @@
+import { Type } from '@nestjs/common';
+export declare const exploreApiExcludeControllerMetadata: (metatype: Type<unknown>) => boolean;

package/dist/explorers/api-exclude-controller.explorer.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exploreApiExcludeControllerMetadata = void 0;
+const constants_1 = require("../constants");
+const exploreApiExcludeControllerMetadata = (metatype) => {
+    var _a;
+    return ((_a = Reflect.getMetadata(constants_1.DECORATORS.API_EXCLUDE_CONTROLLER, metatype)) === null || _a === void 0 ? void 0 : _a[0]) ===
+        true;
+};
+exports.exploreApiExcludeControllerMetadata = exploreApiExcludeControllerMetadata;