@tsoa-next/cli 7.1.0

package/dist/routeGeneration/templates/hapi.hbs

@@ -0,0 +1,267 @@
+/* tslint:disable */
+/* eslint-disable */
+// WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+import type { TsoaRoute } from '@tsoa-next/runtime';
+import { fetchMiddlewares, HapiTemplateService } from '@tsoa-next/runtime';
+{{#each controllers}}
+// WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+import { {{name}} } from '{{modulePath}}';
+{{/each}}
+{{#if authenticationModule}}
+import { hapiAuthentication } from '{{authenticationModule}}';
+// @ts-ignore - no great way to install types from subpackage
+{{/if}}
+{{#if iocModule}}
+import { iocContainer } from '{{iocModule}}';
+import type { IocContainer, IocContainerFactory } from '@tsoa-next/runtime';
+{{/if}}
+import { boomify, isBoom, type Payload } from '@hapi/boom';
+import type { Request, ResponseToolkit, RouteOptionsPreAllOptions } from '@hapi/hapi';
+
+// WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+
+const models: TsoaRoute.Models = {
+    {{#each models}}
+    "{{@key}}": {
+        {{#if enums}}
+        "dataType": "refEnum",
+        "enums": {{{json enums}}},
+        {{/if}}
+        {{#if properties}}
+        "dataType": "refObject",
+        "properties": {
+            {{#each properties}}
+            "{{@key}}": {{{json this}}},
+            {{/each}}
+        },
+        "additionalProperties": {{{json additionalProperties}}},
+        {{/if}}
+        {{#if type}}
+        "dataType": "refAlias",
+        "type": {{{json type}}},
+        {{/if}}
+    },
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    {{/each}}
+};
+const templateService = new HapiTemplateService(
+  models,
+  {{{ json minimalSwaggerConfig }}},
+  { boomify, isBoom },
+);
+
+// WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+
+export function RegisterRoutes(server: any) {
+    // ###########################################################################################################
+    //  NOTE: If you do not see routes for all of your controllers in this file, then you might not have informed tsoa of where to look
+    //      Please look into the "controllerPathGlobs" config option described in the readme: https://github.com/lukeautry/tsoa
+    // ###########################################################################################################
+    {{#each controllers}}
+    {{#each actions}}
+        const args{{../name}}_{{name}}: Record<string, TsoaRoute.ParameterSchema> = {
+          {{#each parameters}}
+            {{@key}}: {{{json this}}},
+          {{/each}}
+        };
+        server.route({
+            method: '{{method}}',
+            path: '{{fullPath}}',
+            options: {
+                pre: [
+                    {{#if security.length}}
+                    {
+                      method: authenticateMiddleware({{json security}})
+                    },
+                    {{/if}}
+                    {{#if uploadFile}}
+                      {{#each uploadFileName}}
+                    {
+                      {{#if multiple}}
+                      method: fileUploadMiddleware('{{name}}', true)
+                      {{else}}
+                      method: fileUploadMiddleware('{{name}}', false)
+                      {{/if}}
+                    },
+                      {{/each}}
+                    {{/if}}
+                    ...(fetchMiddlewares<RouteOptionsPreAllOptions>({{../name}})),
+                    ...(fetchMiddlewares<RouteOptionsPreAllOptions>({{../name}}.prototype.{{name}})),
+                ],
+                {{#if uploadFile}}
+                payload: {
+                  output: 'stream',
+                  parse: true,
+                  multipart: true,
+                  allow: 'multipart/form-data'
+                },
+                {{/if}}
+                handler: {{#if ../../iocModule}}async {{/if}}function {{../name}}_{{name}}(request: Request, h: ResponseToolkit) {
+
+                    let validatedArgs: any[] = [];
+                    try {
+                        validatedArgs = templateService.getValidatedArgs({ args: args{{../name}}_{{name}}, request, h });
+                    } catch (err) {
+                        const error = err as any;
+                        if (isBoom(error)) {
+                            throw error;
+                        }
+
+                        const boomErr = boomify(error instanceof Error ? error : new Error(error.message), { statusCode: error.status || 500 });
+                        boomErr.output.statusCode = error.status || 500;
+                        boomErr.output.payload = {
+                            name: error.name,
+                            fields: error.fields,
+                            message: error.message,
+                        } as unknown as Payload;
+                        throw boomErr;
+                    }
+
+                    {{#if ../../iocModule}}
+                    const container: IocContainer = typeof iocContainer === 'function' ? (iocContainer as IocContainerFactory)(request) : iocContainer;
+
+                    const controller: any = await container.get<{{../name}}>({{../name}});
+                    if (typeof controller['setStatus'] === 'function') {
+                        controller.setStatus(undefined);
+                    }
+                    {{else}}
+                    const controller = new {{../name}}();
+                    {{/if}}
+
+                    return templateService.apiHandler({
+                      methodName: '{{name}}',
+                      controller,
+                      h,
+                      validatedArgs,
+                      successStatus: {{successStatus}},
+                    });
+                }
+            }
+        });
+        // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    {{/each}}
+    {{/each}}
+
+    {{#if useSecurity}}
+
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+
+    function authenticateMiddleware(security: TsoaRoute.Security[] = []) {
+        return async function runAuthenticationMiddleware(request: any, h: any) {
+
+            // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+
+            // keep track of failed auth attempts so we can hand back the most
+            // recent one.  This behavior was previously existing so preserving it
+            // here
+            const failedAttempts: any[] = [];
+            const pushAndRethrow = (error: any) => {
+                failedAttempts.push(error);
+                throw error;
+            };
+
+            const secMethodOrPromises: Promise<any>[] = [];
+            for (const secMethod of security) {
+                if (Object.keys(secMethod).length > 1) {
+                    const secMethodAndPromises: Promise<any>[] = [];
+
+                    for (const name in secMethod) {
+                        secMethodAndPromises.push(
+                            hapiAuthentication(request, name, secMethod[name])
+                                .catch(pushAndRethrow)
+                        );
+                    }
+
+                    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+
+                    secMethodOrPromises.push(Promise.all(secMethodAndPromises)
+                        .then(users => { return users[0]; }));
+                } else {
+                    for (const name in secMethod) {
+                        secMethodOrPromises.push(
+                            hapiAuthentication(request, name, secMethod[name])
+                                .catch(pushAndRethrow)
+                        );
+                    }
+                }
+            }
+
+            // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+
+            try {
+                request['user'] = await Promise.any(secMethodOrPromises);
+                return request['user'];
+            }
+            catch(err) {
+                // Show most recent error as response
+                const error = failedAttempts.pop();
+                if (isBoom(error)) {
+                    throw error;
+                }
+
+                const boomErr = boomify(error instanceof Error ? error : new Error(error.message), { statusCode: error.status || 500 });
+                boomErr.output.statusCode = error.status || 401;
+                boomErr.output.payload = {
+                    name: error.name,
+                    message: error.message,
+                } as unknown as Payload;
+
+                throw boomErr;
+            }
+
+            // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+        }
+    }
+    {{/if}}
+
+    {{#if useFileUploads}}
+    function fileUploadMiddleware(fieldname: string, multiple: boolean = false) {
+      return (request: Request, h: any) => {
+        if (!request.payload[fieldname]) {
+          return h.response(`${fieldname} is a required file(s).`).code(400);
+        }
+
+        const calculateFileInfo = (reqFile: any) => new Promise((resolve, reject) => {
+          const originalname = reqFile.hapi.filename;
+          const headers = reqFile.hapi.headers;
+          const contentTransferEncoding = headers['content-transfer-encoding'];
+          const encoding = contentTransferEncoding &&
+            contentTransferEncoding[0] &&
+            contentTransferEncoding[0].toLowerCase() || '7bit';
+          const mimetype = headers['content-type'] || 'text/plain';
+          const buffer = reqFile._data
+          return resolve({
+            fieldname,
+            originalname,
+            buffer,
+            encoding,
+            mimetype,
+            filename: originalname,
+            size: buffer.toString().length,
+          })
+        });
+
+        if (!multiple) {
+          return calculateFileInfo(request.payload[fieldname])
+            .then(fileMetadata => {
+              request.payload[fieldname] = fileMetadata;
+              return h.continue;
+            })
+            .catch(err => h.response(err.toString()).code(500));
+        } else {
+          const promises = request.payload[fieldname].map((reqFile: any) => calculateFileInfo(reqFile));
+          return Promise.all(promises)
+            .then(filesMetadata => {
+              request.payload[fieldname] = filesMetadata;
+              return h.continue;
+            })
+            .catch(err => h.response(err.toString()).code(500));
+        }
+      };
+    }
+    {{/if}}
+
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+}
+
+// WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa

package/dist/routeGeneration/templates/koa.hbs

@@ -0,0 +1,218 @@
+/* tslint:disable */
+/* eslint-disable */
+// WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+import type { TsoaRoute } from '@tsoa-next/runtime';
+import { fetchMiddlewares, KoaTemplateService } from '@tsoa-next/runtime';
+{{#each controllers}}
+// WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+import { {{name}} } from '{{modulePath}}';
+{{/each}}
+{{#if authenticationModule}}
+import { koaAuthentication } from '{{authenticationModule}}';
+// @ts-ignore - no great way to install types from subpackage
+{{/if}}
+{{#if iocModule}}
+import { iocContainer } from '{{iocModule}}';
+import type { IocContainer, IocContainerFactory } from '@tsoa-next/runtime';
+{{/if}}
+import type { Context, Next, Middleware, Request as KRequest, Response as KResponse } from 'koa';
+import type * as KoaRouter from '@koa/router';
+{{#if useFileUploads}}
+{{#if esm}}
+import multer from '@koa/multer';
+{{else}}
+const multer = require('@koa/multer');
+{{/if}}
+{{/if}}
+{{#if authenticationModule}}
+const koaAuthenticationRecasted = koaAuthentication as (req: KRequest, securityName: string, scopes?: string[], res?: KResponse) => Promise<any>;
+{{/if}}
+
+
+// WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+
+const models: TsoaRoute.Models = {
+    {{#each models}}
+    "{{@key}}": {
+        {{#if enums}}
+        "dataType": "refEnum",
+        "enums": {{{json enums}}},
+        {{/if}}
+        {{#if properties}}
+        "dataType": "refObject",
+        "properties": {
+            {{#each properties}}
+            "{{@key}}": {{{json this}}},
+            {{/each}}
+        },
+        "additionalProperties": {{{json additionalProperties}}},
+        {{/if}}
+        {{#if type}}
+        "dataType": "refAlias",
+        "type": {{{json type}}},
+        {{/if}}
+    },
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    {{/each}}
+};
+const templateService = new KoaTemplateService(models, {{{ json minimalSwaggerConfig }}});
+
+// WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+
+
+{{#if useFileUploads}}
+export function RegisterRoutes(router: KoaRouter,opts?:{multer?:ReturnType<typeof multer>}) {
+{{else}}
+export function RegisterRoutes(router: KoaRouter) {
+{{/if}}
+
+    // ###########################################################################################################
+    //  NOTE: If you do not see routes for all of your controllers in this file, then you might not have informed tsoa of where to look
+    //      Please look into the "controllerPathGlobs" config option described in the readme: https://github.com/lukeautry/tsoa
+    // ###########################################################################################################
+
+    {{#if useFileUploads}}
+    const upload = opts?.multer ||  multer({{{json multerOpts}}});
+    {{/if}}
+
+    {{#each controllers}}
+    {{#each actions}}
+        const args{{../name}}_{{name}}: Record<string, TsoaRoute.ParameterSchema> = {
+            {{#each parameters}}
+                {{@key}}: {{{json this}}},
+            {{/each}}
+        };
+        router.{{method}}('{{fullPath}}',
+            {{#if security.length}}
+            authenticateMiddleware({{json security}}),
+            {{/if}}
+            {{#if uploadFile}}
+            upload.fields([
+                {{#each uploadFileName}}
+                {
+                    name: {{json name}},
+                    {{#if maxCount}}
+                    maxCount: {{maxCount}}
+                    {{/if}}
+                }{{#if @last}}{{else}},{{/if}}
+                {{/each}}
+            ]),
+            {{/if}}
+            ...(fetchMiddlewares<Middleware>({{../name}})),
+            ...(fetchMiddlewares<Middleware>({{../name}}.prototype.{{name}})),
+
+            async function {{../name}}_{{name}}(context: Context, next: Next) {
+
+            let validatedArgs: any[] = [];
+            try {
+              validatedArgs = templateService.getValidatedArgs({ args: args{{../name}}_{{name}}, context, next });
+            } catch (err) {
+              const error = err as any;
+              error.message ||= JSON.stringify({ fields: error.fields });
+              context.status = error.status;
+              context.throw(context.status, error.message, error);
+            }
+
+            {{#if ../../iocModule}}
+            const container: IocContainer = typeof iocContainer === 'function' ? (iocContainer as IocContainerFactory)(context.request) : iocContainer;
+
+            const controller: any = await container.get<{{../name}}>({{../name}});
+            if (typeof controller['setStatus'] === 'function') {
+                controller.setStatus(undefined);
+            }
+            {{else}}
+            const controller = new {{../name}}();
+            {{/if}}
+
+            return templateService.apiHandler({
+              methodName: '{{name}}',
+              controller,
+              context,
+              validatedArgs,
+              successStatus: {{successStatus}},
+            });
+        });
+        // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+    {{/each}}
+    {{/each}}
+
+    {{#if useSecurity}}
+
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+
+    function authenticateMiddleware(security: TsoaRoute.Security[] = []) {
+        return async function runAuthenticationMiddleware(context: any, next: any) {
+
+            // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+
+            // keep track of failed auth attempts so we can hand back the most
+            // recent one.  This behavior was previously existing so preserving it
+            // here
+            const failedAttempts: any[] = [];
+            const pushAndRethrow = (error: any) => {
+                failedAttempts.push(error);
+                throw error;
+            };
+
+            const secMethodOrPromises: Promise<any>[] = [];
+            for (const secMethod of security) {
+                if (Object.keys(secMethod).length > 1) {
+                    const secMethodAndPromises: Promise<any>[] = [];
+
+                    for (const name in secMethod) {
+                        secMethodAndPromises.push(
+                            koaAuthenticationRecasted(context.request, name, secMethod[name], context.response)
+                                .catch(pushAndRethrow)
+                        );
+                    }
+
+                    secMethodOrPromises.push(Promise.all(secMethodAndPromises)
+                        .then(users => { return users[0]; }));
+                } else {
+                    for (const name in secMethod) {
+                        secMethodOrPromises.push(
+                            koaAuthenticationRecasted(context.request, name, secMethod[name], context.response)
+                                .catch(pushAndRethrow)
+                        );
+                    }
+                }
+            }
+
+            // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+
+            let success;
+            try {
+                const user = await Promise.any(secMethodOrPromises);
+                success = true;
+                context.request['user'] = user;
+            }
+            catch(err) {
+                // Response was sent in middleware, abort
+                if(context.response.body) {
+                    return;
+                }
+
+                // Show most recent error as response
+                const error = failedAttempts.pop();
+                context.status = error.status || 401;
+                context.throw(context.status, error.message, error);
+            }
+
+            // Response was sent in middleware, abort
+            if(context.response.body) {
+                return;
+            }
+
+            if (success) {
+                await next();
+            }
+
+            // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+        }
+    }
+    {{/if}}
+
+    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
+}
+
+// WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa

package/dist/swagger/specGenerator.d.ts

@@ -0,0 +1,33 @@
+import { ExtendedSpecConfig } from '../cli';
+import { Tsoa, Swagger } from '@tsoa-next/runtime';
+export declare abstract class SpecGenerator {
+    protected readonly metadata: Tsoa.Metadata;
+    protected readonly config: ExtendedSpecConfig;
+    constructor(metadata: Tsoa.Metadata, config: ExtendedSpecConfig);
+    protected buildAdditionalProperties(type: Tsoa.Type): Swagger.BaseSchema<unknown>;
+    protected buildOperationIdTemplate(inlineTemplate: string): HandlebarsTemplateDelegate<any>;
+    protected getOperationId(controllerName: string, method: Tsoa.Method): string;
+    throwIfNotDataFormat(strToTest: string): Swagger.DataFormat;
+    throwIfNotDataType(strToTest: string): Swagger.DataType;
+    protected getSwaggerType(type: Tsoa.Type, title?: string): Swagger.BaseSchema;
+    protected abstract getSwaggerTypeForUnionType(type: Tsoa.UnionType, title?: string): Swagger.BaseSchema;
+    protected abstract getSwaggerTypeForIntersectionType(type: Tsoa.IntersectionType, title?: string): Swagger.BaseSchema;
+    protected abstract buildProperties(properties: Tsoa.Property[]): {
+        [propertyName: string]: Swagger.Schema2;
+    } | {
+        [propertyName: string]: Swagger.Schema3;
+    } | {
+        [propertyName: string]: Swagger.Schema31;
+    };
+    getSwaggerTypeForObjectLiteral(objectLiteral: Tsoa.NestedObjectLiteralType, title?: string): Swagger.BaseSchema;
+    protected getSwaggerTypeForReferenceType(_referenceType: Tsoa.ReferenceType): Swagger.BaseSchema;
+    protected getSwaggerTypeForVoid(_dataType: 'void' | 'undefined'): Swagger.BaseSchema;
+    protected determineImplicitAdditionalPropertiesValue: () => boolean;
+    protected getSwaggerTypeForPrimitiveType(dataType: Tsoa.PrimitiveTypeLiteral): Swagger.BaseSchema;
+    protected getSwaggerTypeForArrayType(arrayType: Tsoa.ArrayType, title?: string): Swagger.BaseSchema;
+    protected determineTypesUsedInEnum(anEnum: Array<string | number | boolean | null>): Set<"string" | "number" | "boolean">;
+    protected abstract getSwaggerTypeForEnumType(enumType: Tsoa.EnumType, title?: string): Swagger.Schema2 | Swagger.Schema3;
+    protected hasUndefined(property: Tsoa.Property): boolean;
+    protected queriesPropertyToQueryParameter(property: Tsoa.Property): Tsoa.Parameter;
+    protected isRequiredWithoutDefault(prop: Tsoa.Property | Tsoa.Parameter): boolean | undefined;
+}