@nestjs/swagger/dist/swagger-scanner.js

Nest - modern, fast, powerful node.js web framework (@swagger)

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
const constants_1 = require("@nestjs/common/constants");
const lodash_1 = require("lodash");
const model_properties_accessor_1 = require("./services/model-properties-accessor");
const schema_object_factory_1 = require("./services/schema-object-factory");
const swagger_types_mapper_1 = require("./services/swagger-types-mapper");
const swagger_explorer_1 = require("./swagger-explorer");
const swagger_transformer_1 = require("./swagger-transformer");
const strip_last_slash_util_1 = require("./utils/strip-last-slash.util");
class SwaggerScanner {
    constructor() {
        this.transfomer = new swagger_transformer_1.SwaggerTransformer();
        this.schemaObjectFactory = new schema_object_factory_1.SchemaObjectFactory(new model_properties_accessor_1.ModelPropertiesAccessor(), new swagger_types_mapper_1.SwaggerTypesMapper());
        this.explorer = new swagger_explorer_1.SwaggerExplorer(this.schemaObjectFactory);
    }
    scanApplication(app, options) {
        const { deepScanRoutes, include: includedModules = [], extraModels = [], ignoreGlobalPrefix = false } = options;
        const container = app.container;
        const modules = this.getModules(container.getModules(), includedModules);
        const globalPrefix = ignoreGlobalPrefix
            ? strip_last_slash_util_1.stripLastSlash(this.getGlobalPrefix(app))
            : '';
        const denormalizedPaths = modules.map(({ routes, metatype, relatedModules }) => {
            let allRoutes = new Map(routes);
            if (deepScanRoutes) {
                const isGlobal = (module) => !container.isGlobalModule(module);
                Array.from(relatedModules.values())
                    .filter(isGlobal)
                    .map(({ routes: relatedModuleRoutes }) => relatedModuleRoutes)
                    .forEach(relatedModuleRoutes => {
                    allRoutes = new Map([...allRoutes, ...relatedModuleRoutes]);
                });
            }
            const path = metatype
                ? Reflect.getMetadata(constants_1.MODULE_PATH, metatype)
                : undefined;
            return this.scanModuleRoutes(allRoutes, path, globalPrefix);
        });
        const schemas = this.explorer.getSchemas();
        this.addExtraModels(schemas, extraModels);
        return Object.assign(Object.assign({}, this.transfomer.normalizePaths(lodash_1.flatten(denormalizedPaths))), { components: {
                schemas: lodash_1.reduce(this.explorer.getSchemas(), lodash_1.extend)
            } });
    }
    scanModuleRoutes(routes, modulePath, globalPrefix) {
        const denormalizedArray = [...routes.values()].map(ctrl => this.explorer.exploreController(ctrl, modulePath, globalPrefix));
        return lodash_1.flatten(denormalizedArray);
    }
    getModules(modulesContainer, include) {
        if (!include || lodash_1.isEmpty(include)) {
            return [...modulesContainer.values()];
        }
        return [...modulesContainer.values()].filter(({ metatype }) => include.some(item => item === metatype));
    }
    addExtraModels(schemas, extraModels) {
        extraModels.forEach(item => {
            this.schemaObjectFactory.exploreModelSchema(item, schemas);
        });
    }
    getGlobalPrefix(app) {
        const internalConfigRef = app.config;
        return (internalConfigRef && internalConfigRef.getGlobalPrefix()) || '';
    }
}
exports.SwaggerScanner = SwaggerScanner;