@tsoa-next/cli 7.1.0

package/dist/metadataGeneration/metadataGenerator.js

@@ -0,0 +1,220 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MetadataGenerator = void 0;
+const minimatch_1 = require("minimatch");
+const typescript_1 = require("typescript");
+const decoratorUtils_1 = require("../utils/decoratorUtils");
+const importClassesFromDirectories_1 = require("../utils/importClassesFromDirectories");
+const controllerGenerator_1 = require("./controllerGenerator");
+const exceptions_1 = require("./exceptions");
+const typeResolver_1 = require("./typeResolver");
+class MetadataGenerator {
+    compilerOptions;
+    ignorePaths;
+    rootSecurity;
+    defaultNumberType;
+    controllerNodes = new Array();
+    typeChecker;
+    program;
+    referenceTypeMap = {};
+    modelDefinitionPosMap = {};
+    expressionOrigNameMap = {};
+    constructor(entryFile, compilerOptions, ignorePaths, controllers, rootSecurity = [], defaultNumberType = 'double', esm = false) {
+        this.compilerOptions = compilerOptions;
+        this.ignorePaths = ignorePaths;
+        this.rootSecurity = rootSecurity;
+        this.defaultNumberType = defaultNumberType;
+        typeResolver_1.TypeResolver.clearCache();
+        this.program = controllers ? this.setProgramToDynamicControllersFiles(controllers, esm) : (0, typescript_1.createProgram)([entryFile], compilerOptions || {});
+        this.typeChecker = this.program.getTypeChecker();
+    }
+    Generate() {
+        this.extractNodeFromProgramSourceFiles();
+        const controllers = this.buildControllers();
+        this.checkForMethodSignatureDuplicates(controllers);
+        this.checkForPathParamSignatureDuplicates(controllers);
+        return {
+            controllers,
+            referenceTypeMap: this.referenceTypeMap,
+        };
+    }
+    setProgramToDynamicControllersFiles(controllers, esm) {
+        const allGlobFiles = (0, importClassesFromDirectories_1.importClassesFromDirectories)(controllers, esm ? ['.mts', '.ts', '.cts'] : ['.ts']);
+        if (allGlobFiles.length === 0) {
+            throw new exceptions_1.GenerateMetadataError(`[${controllers.join(', ')}] globs found 0 controllers.`);
+        }
+        return (0, typescript_1.createProgram)(allGlobFiles, this.compilerOptions || {});
+    }
+    extractNodeFromProgramSourceFiles() {
+        this.program.getSourceFiles().forEach(sf => {
+            if (this.ignorePaths && this.ignorePaths.length) {
+                for (const path of this.ignorePaths) {
+                    if ((0, minimatch_1.minimatch)(sf.fileName, path)) {
+                        return;
+                    }
+                }
+            }
+            (0, typescript_1.forEachChild)(sf, node => {
+                if ((0, typescript_1.isClassDeclaration)(node) && (0, decoratorUtils_1.getDecorators)(node, identifier => identifier.text === 'Route').length) {
+                    this.controllerNodes.push(node);
+                }
+            });
+        });
+    }
+    checkForMethodSignatureDuplicates = (controllers) => {
+        const map = {};
+        controllers.forEach(controller => {
+            controller.methods.forEach(method => {
+                const signature = method.path ? `@${method.method}(${controller.path}/${method.path})` : `@${method.method}(${controller.path})`;
+                const methodDescription = `${controller.name}#${method.name}`;
+                if (map[signature]) {
+                    map[signature].push(methodDescription);
+                }
+                else {
+                    map[signature] = [methodDescription];
+                }
+            });
+        });
+        let message = '';
+        Object.keys(map).forEach(signature => {
+            const controllers = map[signature];
+            if (controllers.length > 1) {
+                message += `Duplicate method signature ${signature} found in controllers: ${controllers.join(', ')}\n`;
+            }
+        });
+        if (message) {
+            throw new exceptions_1.GenerateMetadataError(message);
+        }
+    };
+    checkForPathParamSignatureDuplicates = (controllers) => {
+        const paramRegExp = new RegExp('{(\\w*)}|:(\\w+)', 'g');
+        let PathDuplicationType;
+        (function (PathDuplicationType) {
+            PathDuplicationType[PathDuplicationType["FULL"] = 0] = "FULL";
+            PathDuplicationType[PathDuplicationType["PARTIAL"] = 1] = "PARTIAL";
+        })(PathDuplicationType || (PathDuplicationType = {}));
+        const collisions = [];
+        function addCollision(type, method, controller, collidesWith) {
+            let existingCollision = collisions.find(collision => collision.type === type && collision.method === method && collision.controller === controller);
+            if (!existingCollision) {
+                existingCollision = {
+                    type,
+                    method,
+                    controller,
+                    collidesWith: [],
+                };
+                collisions.push(existingCollision);
+            }
+            existingCollision.collidesWith.push(collidesWith);
+        }
+        controllers.forEach(controller => {
+            const methodRouteGroup = {};
+            // Group all ts methods with HTTP method decorator into same object in same controller.
+            controller.methods.forEach(method => {
+                if (methodRouteGroup[method.method] === undefined) {
+                    methodRouteGroup[method.method] = [];
+                }
+                const params = method.path.match(paramRegExp);
+                methodRouteGroup[method.method].push({
+                    method, // method.name + ": " + method.path) as any,
+                    path: params?.reduce((s, a) => {
+                        // replace all params with {} placeholder for comparison
+                        return s.replace(a, '{}');
+                    }, method.path) || method.path,
+                });
+            });
+            Object.keys(methodRouteGroup).forEach((key) => {
+                const methodRoutes = methodRouteGroup[key];
+                // check each route with the routes that are defined before it
+                for (let i = 0; i < methodRoutes.length; i += 1) {
+                    for (let j = 0; j < i; j += 1) {
+                        if (methodRoutes[i].path === methodRoutes[j].path) {
+                            // full match
+                            addCollision(PathDuplicationType.FULL, methodRoutes[i].method, controller, methodRoutes[j].method);
+                        }
+                        else if (methodRoutes[i].path.split('/').length === methodRoutes[j].path.split('/').length &&
+                            methodRoutes[j].path
+                                .substr(methodRoutes[j].path.lastIndexOf('/')) // compare only the "last" part of the path
+                                .split('/')
+                                .some(v => !!v) && // ensure the comparison path has a value
+                            methodRoutes[i].path.split('/').every((v, index) => {
+                                const comparisonPathPart = methodRoutes[j].path.split('/')[index];
+                                // if no params, compare values
+                                if (!v.includes('{}')) {
+                                    return v === comparisonPathPart;
+                                }
+                                // otherwise check if route starts with comparison route
+                                return v.startsWith(methodRoutes[j].path.split('/')[index]);
+                            })) {
+                            // partial match - reorder routes!
+                            addCollision(PathDuplicationType.PARTIAL, methodRoutes[i].method, controller, methodRoutes[j].method);
+                        }
+                    }
+                }
+            });
+        });
+        // print warnings for each collision (grouped by route)
+        collisions.forEach(collision => {
+            let message = '';
+            if (collision.type === PathDuplicationType.FULL) {
+                message = `Duplicate path parameter definition signature found in controller `;
+            }
+            else if (collision.type === PathDuplicationType.PARTIAL) {
+                message = `Overlapping path parameter definition signature found in controller `;
+            }
+            message += collision.controller.name;
+            message += ` [ method ${collision.method.method.toUpperCase()} ${collision.method.name} route: ${collision.method.path} ] collides with `;
+            message += collision.collidesWith
+                .map((method) => {
+                return `[ method ${method.method.toUpperCase()} ${method.name} route: ${method.path} ]`;
+            })
+                .join(', ');
+            message += '\n';
+            console.warn(message);
+        });
+    };
+    TypeChecker() {
+        return this.typeChecker;
+    }
+    AddReferenceType(referenceType) {
+        if (!referenceType.refName) {
+            throw new Error('no reference type name found');
+        }
+        this.referenceTypeMap[referenceType.refName] = referenceType;
+    }
+    GetReferenceType(refName) {
+        return this.referenceTypeMap[refName];
+    }
+    CheckModelUnicity(refName, positions) {
+        if (!this.modelDefinitionPosMap[refName]) {
+            this.modelDefinitionPosMap[refName] = positions;
+        }
+        else {
+            const origPositions = this.modelDefinitionPosMap[refName];
+            if (!(origPositions.length === positions.length && positions.every(pos => origPositions.find(origPos => pos.pos === origPos.pos && pos.fileName === origPos.fileName)))) {
+                throw new Error(`Found 2 different model definitions for model ${refName}: orig: ${JSON.stringify(origPositions)}, act: ${JSON.stringify(positions)}`);
+            }
+        }
+    }
+    CheckExpressionUnicity(formattedRefName, refName) {
+        if (!this.expressionOrigNameMap[formattedRefName]) {
+            this.expressionOrigNameMap[formattedRefName] = refName;
+        }
+        else {
+            if (this.expressionOrigNameMap[formattedRefName] !== refName) {
+                throw new Error(`Found 2 different type expressions for formatted name "${formattedRefName}": orig: "${this.expressionOrigNameMap[formattedRefName]}", act: "${refName}"`);
+            }
+        }
+    }
+    buildControllers() {
+        if (this.controllerNodes.length === 0) {
+            throw new Error('no controllers found, check tsoa configuration');
+        }
+        return this.controllerNodes
+            .map(classDeclaration => new controllerGenerator_1.ControllerGenerator(classDeclaration, this, this.rootSecurity))
+            .filter(generator => generator.IsValid())
+            .map(generator => generator.Generate());
+    }
+}
+exports.MetadataGenerator = MetadataGenerator;
+//# sourceMappingURL=metadataGenerator.js.map

package/dist/metadataGeneration/metadataGenerator.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"metadataGenerator.js","sourceRoot":"","sources":["../../src/metadataGeneration/metadataGenerator.ts"],"names":[],"mappings":";;;AACA,yCAAqC;AACrC,2CAAyJ;AACzJ,4DAAuD;AACvD,wFAAoF;AACpF,+DAA2D;AAC3D,6CAAoD;AACpD,iDAA6C;AAE7C,MAAa,iBAAiB;IAUT;IACA;IAEA;IACD;IAbF,eAAe,GAAG,IAAI,KAAK,EAAoB,CAAA;IAC/C,WAAW,CAAa;IACvB,OAAO,CAAS;IACzB,gBAAgB,GAA0B,EAAE,CAAA;IAC5C,qBAAqB,GAAiE,EAAE,CAAA;IACxF,qBAAqB,GAA2B,EAAE,CAAA;IAE1D,YACE,SAAiB,EACA,eAAiC,EACjC,WAAsB,EACvC,WAAsB,EACL,eAAgC,EAAE,EACnC,oBAA8D,QAAQ,EACtF,GAAG,GAAG,KAAK;QALM,oBAAe,GAAf,eAAe,CAAkB;QACjC,gBAAW,GAAX,WAAW,CAAW;QAEtB,iBAAY,GAAZ,YAAY,CAAsB;QACnC,sBAAiB,GAAjB,iBAAiB,CAAqD;QAGtF,2BAAY,CAAC,UAAU,EAAE,CAAA;QACzB,IAAI,CAAC,OAAO,GAAG,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC,mCAAmC,CAAC,WAAW,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,IAAA,0BAAa,EAAC,CAAC,SAAS,CAAC,EAAE,eAAe,IAAI,EAAE,CAAC,CAAA;QAC3I,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAA;IAClD,CAAC;IAEM,QAAQ;QACb,IAAI,CAAC,iCAAiC,EAAE,CAAA;QAExC,MAAM,WAAW,GAAG,IAAI,CAAC,gBAAgB,EAAE,CAAA;QAE3C,IAAI,CAAC,iCAAiC,CAAC,WAAW,CAAC,CAAA;QACnD,IAAI,CAAC,oCAAoC,CAAC,WAAW,CAAC,CAAA;QAEtD,OAAO;YACL,WAAW;YACX,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;SACxC,CAAA;IACH,CAAC;IAEO,mCAAmC,CAAC,WAAqB,EAAE,GAAY;QAC7E,MAAM,YAAY,GAAG,IAAA,2DAA4B,EAAC,WAAW,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAA;QACvG,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC9B,MAAM,IAAI,kCAAqB,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,8BAA8B,CAAC,CAAA;QAC3F,CAAC;QAED,OAAO,IAAA,0BAAa,EAAC,YAAY,EAAE,IAAI,CAAC,eAAe,IAAI,EAAE,CAAC,CAAA;IAChE,CAAC;IAEO,iCAAiC;QACvC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC,EAAE;YACzC,IAAI,IAAI,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC,MAAM,EAAE,CAAC;gBAChD,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,WAAW,EAAE,CAAC;oBACpC,IAAI,IAAA,qBAAS,EAAC,EAAE,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,CAAC;wBACjC,OAAM;oBACR,CAAC;gBACH,CAAC;YACH,CAAC;YAED,IAAA,yBAAY,EAAC,EAAE,EAAE,IAAI,CAAC,EAAE;gBACtB,IAAI,IAAA,+BAAkB,EAAC,IAAI,CAAC,IAAI,IAAA,8BAAa,EAAC,IAAI,EAAE,UAAU,CAAC,EAAE,CAAC,UAAU,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC;oBACtG,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;gBACjC,CAAC;YACH,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;IACJ,CAAC;IAEO,iCAAiC,GAAG,CAAC,WAA8B,EAAE,EAAE;QAC7E,MAAM,GAAG,GAA6B,EAAE,CAAA;QACxC,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YAC/B,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;gBAClC,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,MAAM,IAAI,UAAU,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,GAAG,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,MAAM,IAAI,UAAU,CAAC,IAAI,GAAG,CAAA;gBAChI,MAAM,iBAAiB,GAAG,GAAG,UAAU,CAAC,IAAI,IAAI,MAAM,CAAC,IAAI,EAAE,CAAA;gBAE7D,IAAI,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC;oBACnB,GAAG,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAA;gBACxC,CAAC;qBAAM,CAAC;oBACN,GAAG,CAAC,SAAS,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAA;gBACtC,CAAC;YACH,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,IAAI,OAAO,GAAG,EAAE,CAAA;QAChB,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;YACnC,MAAM,WAAW,GAAG,GAAG,CAAC,SAAS,CAAC,CAAA;YAClC,IAAI,WAAW,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBAC3B,OAAO,IAAI,8BAA8B,SAAS,0BAA0B,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAA;YACxG,CAAC;QACH,CAAC,CAAC,CAAA;QAEF,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,IAAI,kCAAqB,CAAC,OAAO,CAAC,CAAA;QAC1C,CAAC;IACH,CAAC,CAAA;IAEO,oCAAoC,GAAG,CAAC,WAA8B,EAAE,EAAE;QAChF,MAAM,WAAW,GAAG,IAAI,MAAM,CAAC,kBAAkB,EAAE,GAAG,CAAC,CAAA;QAQvD,IAAK,mBAGJ;QAHD,WAAK,mBAAmB;YACtB,6DAAI,CAAA;YACJ,mEAAO,CAAA;QACT,CAAC,EAHI,mBAAmB,KAAnB,mBAAmB,QAGvB;QAED,MAAM,UAAU,GAAqB,EAAE,CAAA;QAEvC,SAAS,YAAY,CAAC,IAAyB,EAAE,MAAmB,EAAE,UAA2B,EAAE,YAAyB;YAC1H,IAAI,iBAAiB,GAAG,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,IAAI,KAAK,IAAI,IAAI,SAAS,CAAC,MAAM,KAAK,MAAM,IAAI,SAAS,CAAC,UAAU,KAAK,UAAU,CAAC,CAAA;YACnJ,IAAI,CAAC,iBAAiB,EAAE,CAAC;gBACvB,iBAAiB,GAAG;oBAClB,IAAI;oBACJ,MAAM;oBACN,UAAU;oBACV,YAAY,EAAE,EAAE;iBACjB,CAAA;gBACD,UAAU,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAA;YACpC,CAAC;YAED,iBAAiB,CAAC,YAAY,CAAC,IAAI,CAAC,YAAY,CAAC,CAAA;QACnD,CAAC;QAED,WAAW,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YAC/B,MAAM,gBAAgB,GAKlB,EAAE,CAAA;YACN,uFAAuF;YACvF,UAAU,CAAC,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;gBAClC,IAAI,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,SAAS,EAAE,CAAC;oBAClD,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAA;gBACtC,CAAC;gBAED,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,WAAW,CAAC,CAAA;gBAE7C,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC;oBACnC,MAAM,EAAE,4CAA4C;oBACpD,IAAI,EACF,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE;wBACtB,wDAAwD;wBACxD,OAAO,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,CAAC,CAAA;oBAC3B,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,MAAM,CAAC,IAAI;iBACjC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;YAEF,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,OAAO,CAAC,CAAC,GAAW,EAAE,EAAE;gBACpD,MAAM,YAAY,GAAG,gBAAgB,CAAC,GAAG,CAAC,CAAA;gBAE1C,8DAA8D;gBAC9D,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,YAAY,CAAC,MAAM,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;oBAChD,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC;wBAC9B,IAAI,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;4BAClD,aAAa;4BACb,YAAY,CAAC,mBAAmB,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;wBACpG,CAAC;6BAAM,IACL,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,KAAK,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM;4BACjF,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI;iCACjB,MAAM,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,2CAA2C;iCACzF,KAAK,CAAC,GAAG,CAAC;iCACV,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,yCAAyC;4BAC9D,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE;gCACjD,MAAM,kBAAkB,GAAG,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAA;gCACjE,+BAA+B;gCAC/B,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;oCACtB,OAAO,CAAC,KAAK,kBAAkB,CAAA;gCACjC,CAAC;gCACD,wDAAwD;gCACxD,OAAO,CAAC,CAAC,UAAU,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAA;4BAC7D,CAAC,CAAC,EACF,CAAC;4BACD,kCAAkC;4BAClC,YAAY,CAAC,mBAAmB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,UAAU,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAA;wBACvG,CAAC;oBACH,CAAC;gBACH,CAAC;YACH,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;QAEF,uDAAuD;QACvD,UAAU,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;YAC7B,IAAI,OAAO,GAAG,EAAE,CAAA;YAChB,IAAI,SAAS,CAAC,IAAI,KAAK,mBAAmB,CAAC,IAAI,EAAE,CAAC;gBAChD,OAAO,GAAG,oEAAoE,CAAA;YAChF,CAAC;iBAAM,IAAI,SAAS,CAAC,IAAI,KAAK,mBAAmB,CAAC,OAAO,EAAE,CAAC;gBAC1D,OAAO,GAAG,sEAAsE,CAAA;YAClF,CAAC;YACD,OAAO,IAAI,SAAS,CAAC,UAAU,CAAC,IAAI,CAAA;YACpC,OAAO,IAAI,aAAa,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,SAAS,CAAC,MAAM,CAAC,IAAI,WAAW,SAAS,CAAC,MAAM,CAAC,IAAI,mBAAmB,CAAA;YACzI,OAAO,IAAI,SAAS,CAAC,YAAY;iBAC9B,GAAG,CAAC,CAAC,MAAmB,EAAE,EAAE;gBAC3B,OAAO,YAAY,MAAM,CAAC,MAAM,CAAC,WAAW,EAAE,IAAI,MAAM,CAAC,IAAI,WAAW,MAAM,CAAC,IAAI,IAAI,CAAA;YACzF,CAAC,CAAC;iBACD,IAAI,CAAC,IAAI,CAAC,CAAA;YAEb,OAAO,IAAI,IAAI,CAAA;YACf,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;QACvB,CAAC,CAAC,CAAA;IACJ,CAAC,CAAA;IAEM,WAAW;QAChB,OAAO,IAAI,CAAC,WAAW,CAAA;IACzB,CAAC;IAEM,gBAAgB,CAAC,aAAiC;QACvD,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,CAAC;YAC3B,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAA;QACjD,CAAC;QACD,IAAI,CAAC,gBAAgB,CAAC,aAAa,CAAC,OAAO,CAAC,GAAG,aAAa,CAAA;IAC9D,CAAC;IAEM,gBAAgB,CAAC,OAAe;QACrC,OAAO,IAAI,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAA;IACvC,CAAC;IAEM,iBAAiB,CAAC,OAAe,EAAE,SAAmD;QAC3F,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,EAAE,CAAC;YACzC,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,GAAG,SAAS,CAAA;QACjD,CAAC;aAAM,CAAC;YACN,MAAM,aAAa,GAAG,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,CAAA;YACzD,IAAI,CAAC,CAAC,aAAa,CAAC,MAAM,KAAK,SAAS,CAAC,MAAM,IAAI,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,GAAG,CAAC,GAAG,KAAK,OAAO,CAAC,GAAG,IAAI,GAAG,CAAC,QAAQ,KAAK,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,CAAC;gBACxK,MAAM,IAAI,KAAK,CAAC,iDAAiD,OAAO,WAAW,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,UAAU,IAAI,CAAC,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC,CAAA;YACxJ,CAAC;QACH,CAAC;IACH,CAAC;IAEM,sBAAsB,CAAC,gBAAwB,EAAE,OAAe;QACrE,IAAI,CAAC,IAAI,CAAC,qBAAqB,CAAC,gBAAgB,CAAC,EAAE,CAAC;YAClD,IAAI,CAAC,qBAAqB,CAAC,gBAAgB,CAAC,GAAG,OAAO,CAAA;QACxD,CAAC;aAAM,CAAC;YACN,IAAI,IAAI,CAAC,qBAAqB,CAAC,gBAAgB,CAAC,KAAK,OAAO,EAAE,CAAC;gBAC7D,MAAM,IAAI,KAAK,CAAC,0DAA0D,gBAAgB,aAAa,IAAI,CAAC,qBAAqB,CAAC,gBAAgB,CAAC,YAAY,OAAO,GAAG,CAAC,CAAA;YAC5K,CAAC;QACH,CAAC;IACH,CAAC;IAEO,gBAAgB;QACtB,IAAI,IAAI,CAAC,eAAe,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtC,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAA;QACnE,CAAC;QACD,OAAO,IAAI,CAAC,eAAe;aACxB,GAAG,CAAC,gBAAgB,CAAC,EAAE,CAAC,IAAI,yCAAmB,CAAC,gBAAgB,EAAE,IAAI,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;aAC3F,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;aACxC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAA;IAC3C,CAAC;CACF;AAtPD,8CAsPC"}

package/dist/metadataGeneration/methodGenerator.d.ts

@@ -0,0 +1,45 @@
+import * as ts from 'typescript';
+import { MetadataGenerator } from './metadataGenerator';
+import { Tsoa } from '@tsoa-next/runtime';
+type HttpMethod = 'options' | 'get' | 'post' | 'put' | 'patch' | 'delete' | 'head';
+export declare class MethodGenerator {
+    private readonly node;
+    private readonly current;
+    private readonly commonResponses;
+    private readonly parentPath?;
+    private readonly parentTags?;
+    private readonly parentSecurity?;
+    private readonly isParentHidden?;
+    protected method?: HttpMethod;
+    protected path?: string;
+    private produces?;
+    private consumes?;
+    constructor(node: ts.MethodDeclaration, current: MetadataGenerator, commonResponses: Tsoa.Response[], parentPath?: string | undefined, parentTags?: string[] | undefined, parentSecurity?: Tsoa.Security[] | undefined, isParentHidden?: boolean | undefined);
+    IsValid(): this is {
+        method: HttpMethod;
+        path: string;
+    };
+    Generate(): Tsoa.Method;
+    private buildParameters;
+    private validateBodyParameters;
+    private validateQueryParameters;
+    private getExtensions;
+    private getCurrentLocation;
+    private processMethodDecorators;
+    private getProduces;
+    private getConsumes;
+    private getMethodResponses;
+    private getMethodSuccessResponse;
+    private getHeadersFromDecorator;
+    private getSchemaFromDecorator;
+    private getMethodSuccessExamples;
+    private supportsPathMethod;
+    private getIsDeprecated;
+    private getOperationId;
+    private getTags;
+    private getSecurity;
+    private getIsHidden;
+    private getDecoratorsByIdentifier;
+    private getProducesAdapter;
+}
+export {};

package/dist/metadataGeneration/methodGenerator.js

@@ -0,0 +1,367 @@
+"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 __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MethodGenerator = void 0;
+const ts = __importStar(require("typescript"));
+const path = __importStar(require("path"));
+const isVoidType_1 = require("../utils/isVoidType");
+const decoratorUtils_1 = require("./../utils/decoratorUtils");
+const jsDocUtils_1 = require("./../utils/jsDocUtils");
+const extension_1 = require("./extension");
+const exceptions_1 = require("./exceptions");
+const parameterGenerator_1 = require("./parameterGenerator");
+const typeResolver_1 = require("./typeResolver");
+const headerTypeHelpers_1 = require("../utils/headerTypeHelpers");
+class MethodGenerator {
+    node;
+    current;
+    commonResponses;
+    parentPath;
+    parentTags;
+    parentSecurity;
+    isParentHidden;
+    method;
+    path;
+    produces;
+    consumes;
+    constructor(node, current, commonResponses, parentPath, parentTags, parentSecurity, isParentHidden) {
+        this.node = node;
+        this.current = current;
+        this.commonResponses = commonResponses;
+        this.parentPath = parentPath;
+        this.parentTags = parentTags;
+        this.parentSecurity = parentSecurity;
+        this.isParentHidden = isParentHidden;
+        this.processMethodDecorators();
+    }
+    IsValid() {
+        return this.method !== undefined && this.path !== undefined;
+    }
+    Generate() {
+        if (!this.IsValid()) {
+            throw new exceptions_1.GenerateMetadataError("This isn't a valid a controller method.");
+        }
+        let nodeType = this.node.type;
+        if (!nodeType) {
+            const typeChecker = this.current.typeChecker;
+            const signature = typeChecker.getSignatureFromDeclaration(this.node);
+            const implicitType = typeChecker.getReturnTypeOfSignature(signature);
+            nodeType = typeChecker.typeToTypeNode(implicitType, undefined, ts.NodeBuilderFlags.NoTruncation);
+        }
+        const type = new typeResolver_1.TypeResolver(nodeType, this.current).resolve();
+        const responses = this.commonResponses.concat(this.getMethodResponses());
+        const { response: successResponse, status: successStatus } = this.getMethodSuccessResponse(type);
+        responses.push(successResponse);
+        const parameters = this.buildParameters();
+        const additionalResponses = parameters.filter((p) => p.in === 'res');
+        responses.push(...additionalResponses);
+        return {
+            extensions: this.getExtensions(),
+            deprecated: this.getIsDeprecated(),
+            description: (0, jsDocUtils_1.getJSDocDescription)(this.node),
+            isHidden: this.getIsHidden(),
+            method: this.method,
+            name: this.node.name.text,
+            operationId: this.getOperationId(),
+            parameters,
+            path: this.path,
+            produces: this.produces,
+            consumes: this.consumes,
+            responses,
+            successStatus,
+            security: this.getSecurity(),
+            summary: (0, jsDocUtils_1.getJSDocComment)(this.node, 'summary'),
+            tags: this.getTags(),
+            type,
+        };
+    }
+    buildParameters() {
+        if (!this.IsValid()) {
+            throw new exceptions_1.GenerateMetadataError("This isn't a valid a controller method.");
+        }
+        const fullPath = path.join(this.parentPath || '', this.path);
+        const method = this.method;
+        const parameters = this.node.parameters
+            .map(p => {
+            try {
+                return new parameterGenerator_1.ParameterGenerator(p, method, fullPath, this.current).Generate();
+            }
+            catch (e) {
+                const methodId = this.node.name;
+                const controllerId = this.node.parent.name;
+                const message = e instanceof Error ? e.message : String(e);
+                throw new exceptions_1.GenerateMetadataError(`${message} \n in '${controllerId.text}.${methodId.text}'`);
+            }
+        })
+            .reduce((flattened, params) => [...flattened, ...params], []);
+        this.validateBodyParameters(parameters);
+        this.validateQueryParameters(parameters);
+        return parameters;
+    }
+    validateBodyParameters(parameters) {
+        const bodyParameters = parameters.filter(p => p.in === 'body');
+        const bodyProps = parameters.filter(p => p.in === 'body-prop');
+        const hasFormDataParameters = parameters.some(p => p.in === 'formData');
+        const hasBodyParameter = bodyProps.length + bodyParameters.length > 0;
+        if (bodyParameters.length > 1) {
+            throw new exceptions_1.GenerateMetadataError(`Only one body parameter allowed in '${this.getCurrentLocation()}' method.`);
+        }
+        if (bodyParameters.length > 0 && bodyProps.length > 0) {
+            throw new exceptions_1.GenerateMetadataError(`Choose either during @Body or @BodyProp in '${this.getCurrentLocation()}' method.`);
+        }
+        if (hasBodyParameter && hasFormDataParameters) {
+            throw new Error(`@Body or @BodyProp cannot be used with @FormField, @UploadedFile, or @UploadedFiles in '${this.getCurrentLocation()}' method.`);
+        }
+    }
+    validateQueryParameters(parameters) {
+        const queryParameters = parameters.filter(p => p.in === 'query');
+        const queriesParameters = parameters.filter(p => p.in === 'queries');
+        if (queriesParameters.length > 1) {
+            throw new exceptions_1.GenerateMetadataError(`Only one queries parameter allowed in '${this.getCurrentLocation()}' method.`);
+        }
+        if (queriesParameters.length > 0 && queryParameters.length > 0) {
+            throw new exceptions_1.GenerateMetadataError(`Choose either during @Query or @Queries in '${this.getCurrentLocation()}' method.`);
+        }
+    }
+    getExtensions() {
+        const extensionDecorators = this.getDecoratorsByIdentifier(this.node, 'Extension');
+        if (!extensionDecorators || !extensionDecorators.length) {
+            return [];
+        }
+        return (0, extension_1.getExtensions)(extensionDecorators, this.current);
+    }
+    getCurrentLocation() {
+        const methodId = this.node.name;
+        const controllerId = this.node.parent.name;
+        return `${controllerId.text}.${methodId.text}`;
+    }
+    processMethodDecorators() {
+        const pathDecorators = (0, decoratorUtils_1.getDecorators)(this.node, identifier => this.supportsPathMethod(identifier.text));
+        if (!pathDecorators || !pathDecorators.length) {
+            return;
+        }
+        if (pathDecorators.length > 1) {
+            throw new exceptions_1.GenerateMetadataError(`Only one path decorator in '${this.getCurrentLocation()}' method, Found: ${pathDecorators.map(d => d.text).join(', ')}`);
+        }
+        const decorator = pathDecorators[0];
+        this.method = decorator.text.toLowerCase();
+        // if you don't pass in a path to the method decorator, we'll just use the base route
+        // todo: what if someone has multiple no argument methods of the same type in a single controller?
+        // we need to throw an error there
+        this.path = (0, decoratorUtils_1.getPath)(decorator, this.current.typeChecker);
+        this.produces = this.getProduces();
+        this.consumes = this.getConsumes();
+    }
+    getProduces() {
+        const produces = (0, decoratorUtils_1.getProduces)(this.node, this.current.typeChecker);
+        return produces.length ? produces : undefined;
+    }
+    getConsumes() {
+        const consumesDecorators = this.getDecoratorsByIdentifier(this.node, 'Consumes');
+        if (!consumesDecorators || !consumesDecorators.length) {
+            return;
+        }
+        if (consumesDecorators.length > 1) {
+            throw new exceptions_1.GenerateMetadataError(`Only one Consumes decorator in '${this.getCurrentLocation()}' method, Found: ${consumesDecorators.map(d => d.text).join(', ')}`);
+        }
+        const [decorator] = consumesDecorators;
+        const [consumes] = (0, decoratorUtils_1.getDecoratorValues)(decorator, this.current.typeChecker);
+        return consumes;
+    }
+    getMethodResponses() {
+        const responseExamplesByName = {};
+        const decorators = this.getDecoratorsByIdentifier(this.node, 'Response');
+        if (!decorators || !decorators.length) {
+            return [];
+        }
+        return decorators.map(decorator => {
+            const [name, description, example, produces] = (0, decoratorUtils_1.getDecoratorValues)(decorator, this.current.typeChecker);
+            if (example !== undefined) {
+                responseExamplesByName[name] = responseExamplesByName[name] ? [...responseExamplesByName[name], example] : [example];
+            }
+            return {
+                description: description || '',
+                examples: responseExamplesByName[name] || undefined,
+                name: name || '200',
+                produces: this.getProducesAdapter(produces),
+                schema: this.getSchemaFromDecorator(decorator, 0),
+                headers: this.getHeadersFromDecorator(decorator, 1),
+            };
+        });
+    }
+    getMethodSuccessResponse(type) {
+        const decorators = this.getDecoratorsByIdentifier(this.node, 'SuccessResponse');
+        const examplesWithLabels = this.getMethodSuccessExamples();
+        if (!decorators || !decorators.length) {
+            const returnsDescription = (0, jsDocUtils_1.getJSDocComment)(this.node, 'returns') || 'Ok';
+            return {
+                response: {
+                    description: (0, isVoidType_1.isVoidType)(type) ? 'No content' : returnsDescription,
+                    examples: examplesWithLabels?.map(ex => ex.example),
+                    exampleLabels: examplesWithLabels?.map(ex => ex.label),
+                    name: (0, isVoidType_1.isVoidType)(type) ? '204' : '200',
+                    produces: this.produces,
+                    schema: type,
+                },
+            };
+        }
+        if (decorators.length > 1) {
+            throw new exceptions_1.GenerateMetadataError(`Only one SuccessResponse decorator allowed in '${this.getCurrentLocation()}' method.`);
+        }
+        const [firstDecorator] = decorators;
+        const [name, description, produces] = (0, decoratorUtils_1.getDecoratorValues)(firstDecorator, this.current.typeChecker);
+        const headers = this.getHeadersFromDecorator(firstDecorator, 0);
+        return {
+            response: {
+                description: description || '',
+                examples: examplesWithLabels?.map(ex => ex.example),
+                exampleLabels: examplesWithLabels?.map(ex => ex.label),
+                name: name || '200',
+                produces: this.getProducesAdapter(produces),
+                schema: type,
+                headers,
+            },
+            status: name && /^\d+$/.test(name) ? parseInt(name, 10) : undefined,
+        };
+    }
+    getHeadersFromDecorator({ parent: expression }, headersIndex) {
+        if (!ts.isCallExpression(expression)) {
+            return undefined;
+        }
+        return (0, headerTypeHelpers_1.getHeaderType)(expression.typeArguments, headersIndex, this.current);
+    }
+    getSchemaFromDecorator({ parent: expression }, schemaIndex) {
+        if (!ts.isCallExpression(expression) || !expression.typeArguments?.length) {
+            return undefined;
+        }
+        return new typeResolver_1.TypeResolver(expression.typeArguments[schemaIndex], this.current).resolve();
+    }
+    getMethodSuccessExamples() {
+        const exampleDecorators = this.getDecoratorsByIdentifier(this.node, 'Example');
+        if (!exampleDecorators || !exampleDecorators.length) {
+            return undefined;
+        }
+        const examples = exampleDecorators.map(exampleDecorator => {
+            const [example, label] = (0, decoratorUtils_1.getDecoratorValues)(exampleDecorator, this.current.typeChecker);
+            return { example, label };
+        });
+        return examples || undefined;
+    }
+    supportsPathMethod(method) {
+        return ['options', 'get', 'post', 'put', 'patch', 'delete', 'head'].some(m => m === method.toLowerCase());
+    }
+    getIsDeprecated() {
+        if ((0, jsDocUtils_1.isExistJSDocTag)(this.node, tag => tag.tagName.text === 'deprecated')) {
+            return true;
+        }
+        const depDecorators = this.getDecoratorsByIdentifier(this.node, 'Deprecated');
+        if (!depDecorators || !depDecorators.length) {
+            return false;
+        }
+        if (depDecorators.length > 1) {
+            throw new exceptions_1.GenerateMetadataError(`Only one Deprecated decorator allowed in '${this.getCurrentLocation()}' method.`);
+        }
+        return true;
+    }
+    getOperationId() {
+        const opDecorators = this.getDecoratorsByIdentifier(this.node, 'OperationId');
+        if (!opDecorators || !opDecorators.length) {
+            return undefined;
+        }
+        if (opDecorators.length > 1) {
+            throw new exceptions_1.GenerateMetadataError(`Only one OperationId decorator allowed in '${this.getCurrentLocation()}' method.`);
+        }
+        const values = (0, decoratorUtils_1.getDecoratorValues)(opDecorators[0], this.current.typeChecker);
+        return values && values[0];
+    }
+    getTags() {
+        const tagsDecorators = this.getDecoratorsByIdentifier(this.node, 'Tags');
+        if (!tagsDecorators || !tagsDecorators.length) {
+            return this.parentTags;
+        }
+        if (tagsDecorators.length > 1) {
+            throw new exceptions_1.GenerateMetadataError(`Only one Tags decorator allowed in '${this.getCurrentLocation()}' method.`);
+        }
+        const tags = (0, decoratorUtils_1.getDecoratorValues)(tagsDecorators[0], this.current.typeChecker);
+        if (tags && this.parentTags) {
+            tags.push(...this.parentTags);
+        }
+        return tags;
+    }
+    getSecurity() {
+        const noSecurityDecorators = this.getDecoratorsByIdentifier(this.node, 'NoSecurity');
+        const securityDecorators = this.getDecoratorsByIdentifier(this.node, 'Security');
+        if (noSecurityDecorators?.length > 1) {
+            throw new exceptions_1.GenerateMetadataError(`Only one NoSecurity decorator allowed in '${this.getCurrentLocation()}' method.`);
+        }
+        if (noSecurityDecorators?.length && securityDecorators?.length) {
+            throw new exceptions_1.GenerateMetadataError(`NoSecurity decorator cannot be used in conjunction with Security decorator in '${this.getCurrentLocation()}' method.`);
+        }
+        if (noSecurityDecorators?.length) {
+            return [];
+        }
+        if (!securityDecorators || !securityDecorators.length) {
+            return this.parentSecurity || [];
+        }
+        return securityDecorators.map(d => (0, decoratorUtils_1.getSecurites)(d, this.current.typeChecker));
+    }
+    getIsHidden() {
+        const hiddenDecorators = this.getDecoratorsByIdentifier(this.node, 'Hidden');
+        if (!hiddenDecorators || !hiddenDecorators.length) {
+            return !!this.isParentHidden;
+        }
+        if (this.isParentHidden) {
+            throw new exceptions_1.GenerateMetadataError(`Hidden decorator cannot be set on '${this.getCurrentLocation()}' it is already defined on the controller`);
+        }
+        if (hiddenDecorators.length > 1) {
+            throw new exceptions_1.GenerateMetadataError(`Only one Hidden decorator allowed in '${this.getCurrentLocation()}' method.`);
+        }
+        return true;
+    }
+    getDecoratorsByIdentifier(node, id) {
+        return (0, decoratorUtils_1.getDecorators)(node, identifier => identifier.text === id);
+    }
+    getProducesAdapter(produces) {
+        if (Array.isArray(produces)) {
+            return produces;
+        }
+        else if (typeof produces === 'string') {
+            return [produces];
+        }
+        return;
+    }
+}
+exports.MethodGenerator = MethodGenerator;
+//# sourceMappingURL=methodGenerator.js.map