@tsoa-next/runtime 7.1.0

package/README.MD

@@ -0,0 +1,3 @@
+This package contains the runtime helpers for tsoa.
+
+For a comprehensive Readme, please refer to [the main readme](https://github.com/lukeautry/tsoa#readme).

package/dist/config.d.ts

@@ -0,0 +1,240 @@
+import { Swagger } from './swagger/swagger';
+import { Options as MulterOpts } from 'multer';
+export interface Config {
+    /**
+     * Swagger generation configuration object
+     */
+    spec: SpecConfig;
+    /**
+     * Route generation configuration object
+     */
+    routes: RoutesConfig;
+    /**
+     * Directories to ignore during TypeScript metadata scan
+     */
+    ignore?: string[];
+    /**
+     * The entry point to your API
+     */
+    entryFile: string;
+    /**
+     * An array of path globs that point to your route controllers that you would like to have tsoa include.
+     */
+    controllerPathGlobs?: string[];
+    /**
+     * Modes that allow you to prevent input data from entering into your API. This will document your decision in the swagger.yaml and it will turn on excess-property validation (at runtime) in your routes.
+     */
+    noImplicitAdditionalProperties?: 'throw-on-extras' | 'silently-remove-extras' | 'ignore';
+    /**
+     * Typescript CompilerOptions to be used during generation
+     *
+     * @type {Record<string, unknown>}
+     * @memberof RoutesConfig
+     */
+    compilerOptions?: Record<string, unknown>;
+    /**
+     * Multer's options to generate multer's middleware.
+     * It doesn't support storage option
+     *
+     * @example {
+     *   "dest": "/tmp"
+     * } Allow multer to write to file instead of using Memory's buffer
+     * @deprecated
+     *  since v6.4.0 instroduces RegisterRoutes can pass multerOptions,
+     *  we will quickly remove this options soon at future version.
+     *  (https://github.com/lukeautry/tsoa/issues/1587#issuecomment-2391291433)
+     *  (https://github.com/lukeautry/tsoa/pull/1638)
+     */
+    multerOpts?: MulterOpts;
+    defaultNumberType?: 'double' | 'float' | 'integer' | 'long';
+}
+/**
+ * these options will be removed in a future version since we would prefer consumers to explicitly state their preference that the tsoa validation throws or removes additional properties
+ */
+export type DeprecatedOptionForAdditionalPropertiesHandling = true | false;
+export interface SpecConfig {
+    /**
+     * Generated SwaggerConfig.json will output here
+     */
+    outputDirectory: string;
+    /**
+     * API host, expressTemplate.g. localhost:3000 or myapi.com
+     */
+    host?: string;
+    /**
+     * API servers, expressTemplate.g. [production.api.com, staging.api.com]
+     *
+     * Only available with the specVersion 3
+     */
+    servers?: string[];
+    /**
+     * Base-name of swagger.json or swagger.yaml.
+     *
+     * @default: "swagger"
+     */
+    specFileBaseName?: string;
+    /**
+  
+     * API version number; defaults to npm package version
+     */
+    version?: string;
+    /**
+     * Major OpenAPI version to generate; defaults to version 2 when not specified
+     * Possible values:
+     *  - 2: generates OpenAPI version 2.
+     *  - 3: generates OpenAPI version 3.
+     *  - 3.1: generates OpenAPI version 3.1.
+     */
+    specVersion?: Swagger.SupportedSpecMajorVersion;
+    /**
+     * API name; defaults to npm package name
+     */
+    name?: string;
+    /**
+     * API description; defaults to npm package description
+     */
+    description?: string;
+    /**
+     * Link to the page that describes the terms of service.
+     * Must be in the URL format.
+     */
+    termsOfService?: string;
+    /**
+     * Contact Information
+     */
+    contact?: {
+        /**
+         * The identifying name of the contact person/organization.
+         * @default npm package author
+         */
+        name?: string;
+        /**
+         * The email address of the contact person/organization.
+         * @default npm package author email
+         */
+        email?: string;
+        /**
+         * API Info url
+         * The URL pointing to the contact information.
+         * @default npm package author url
+         */
+        url?: string;
+    };
+    /**
+     * API license; defaults to npm package license
+     */
+    license?: string;
+    /**
+     * Base API path; e.g. the 'v1' in https://myapi.com/v1
+     */
+    basePath?: string;
+    /**
+     * Base API prefix slash toggle
+     * e.g. the 'v1' with toggle true will be https://myapi.comv1
+     * Otherwise, http://myapi.com/v1
+     *
+     * Only available with the specVersion 3
+     */
+    disableBasePathPrefixSlash?: boolean;
+    /**
+     * Extend generated swagger spec with this object
+     * Note that generated properties will always take precedence over what get specified here
+     */
+    spec?: unknown;
+    /**
+     * Alter how the spec is merged to generated swagger spec.
+     * Possible values:
+     *  - 'immediate' is overriding top level elements only thus you can not append a new path or alter an existing value without erasing same level elements.
+     *  - 'recursive' proceed to a deep merge and will concat every branches or override or create new values if needed. @see https://www.npmjs.com/package/merge
+     *  - 'deepmerge' uses `ts-deepmerge` to merge, which will concat object branches and concat arrays as well @see https://www.npmjs.com/package/deepmerge @see https://github.com/voodoocreation/ts-deepmerge
+     * The default is set to immediate so it is not breaking previous versions.
+     * @default 'immediate'
+     */
+    specMerging?: 'immediate' | 'recursive' | 'deepmerge';
+    /**
+     * Template string for generating operation ids.
+     * This should be a valid handlebars template and is provided
+     * with the following context:
+     *   - 'controllerName' - String name of controller class.
+     *   - 'method' - Tsoa.Method object.
+     *
+     * @default '{{titleCase method.name}}'
+     */
+    operationIdTemplate?: string;
+    /**
+     * Security Definitions Object
+     * A declaration of the security schemes available to be used in the
+     * specification. This does not enforce the security schemes on the operations
+     * and only serves to provide the relevant details for each scheme.
+     */
+    securityDefinitions?: {
+        [name: string]: Swagger.SecuritySchemes;
+    };
+    /**
+     * Swagger Tags Information for your API
+     */
+    tags?: Swagger.Tag[];
+    yaml?: boolean;
+    schemes?: Swagger.Protocol[];
+    /**
+     * Enable x-enum-varnames support
+     * @default false
+     */
+    xEnumVarnames?: boolean;
+    /**
+     * Sets a title for inline objects for responses and requestBodies
+     * This helps to generate more consistent clients
+     */
+    useTitleTagsForInlineObjects?: boolean;
+    /**
+     * Applies a default security to the entire API.
+     * Can be overridden with @Security or @NoSecurity decorators on controllers or methods
+     */
+    rootSecurity?: Swagger.Security[];
+}
+export interface RoutesConfig {
+    /**
+     * Routes directory; generated routes.ts (which contains the generated code wiring up routes using middleware of choice) will be dropped here
+     */
+    routesDir: string;
+    /**
+     * Routes filename; the filename of the generated route file ('routes.ts' by default)
+     */
+    routesFileName?: string;
+    /**
+     * Avoid writing the generated route file if the existing file is identical (useful to optimize watch processes); false by default
+     */
+    noWriteIfUnchanged?: boolean;
+    /**
+     * Base API path; e.g. the '/v1' in https://myapi.com/v1
+     */
+    basePath?: string;
+    /**
+     * Middleware provider.
+     */
+    middleware?: 'express' | 'hapi' | 'koa';
+    /**
+     * Override the Middleware template
+     */
+    middlewareTemplate?: string;
+    /**
+     * IOC module; e.g. './inversify/ioc' where IOC container named `iocContainer` is defined (https://github.com/inversify/InversifyJS)
+     */
+    iocModule?: string;
+    /**
+     * Authentication Module for express, hapi and koa
+     */
+    authenticationModule?: string;
+    /**
+     * When enabled, the imports in the routes files will have a `.js` extention to support esm.
+     *
+     * @default false
+     */
+    esm?: boolean;
+    bodyCoercion?: boolean;
+    /**
+     * When enabled, the imports in the routes files will keep having a `.ts` extention to support the TypeScript 5.7 feature rewriteRelativeImportExtensions.
+     * @default false
+     */
+    rewriteRelativeImportExtensions?: boolean;
+}

package/dist/config.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=config.js.map

package/dist/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../src/config.ts"],"names":[],"mappings":""}

package/dist/decorators/customAttribute.d.ts

@@ -0,0 +1 @@
+export declare function CustomAttribute(_name: string, _value: string): PropertyDecorator;

package/dist/decorators/customAttribute.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomAttribute = CustomAttribute;
+function CustomAttribute(_name, _value) {
+    return () => {
+        return;
+    };
+}
+//# sourceMappingURL=customAttribute.js.map

package/dist/decorators/customAttribute.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"customAttribute.js","sourceRoot":"","sources":["../../src/decorators/customAttribute.ts"],"names":[],"mappings":";;AAAA,0CAIC;AAJD,SAAgB,eAAe,CAAC,KAAa,EAAE,MAAc;IAC3D,OAAO,GAAG,EAAE;QACV,OAAM;IACR,CAAC,CAAA;AACH,CAAC"}

package/dist/decorators/deprecated.d.ts

@@ -0,0 +1,4 @@
+/**
+ * used to show a method as deprecated on swagger documentation
+ */
+export declare function Deprecated(): PropertyDecorator & ClassDecorator & ParameterDecorator;

package/dist/decorators/deprecated.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Deprecated = Deprecated;
+/**
+ * used to show a method as deprecated on swagger documentation
+ */
+function Deprecated() {
+    return () => {
+        return;
+    };
+}
+//# sourceMappingURL=deprecated.js.map

package/dist/decorators/deprecated.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"deprecated.js","sourceRoot":"","sources":["../../src/decorators/deprecated.ts"],"names":[],"mappings":";;AAGA,gCAIC;AAPD;;GAEG;AACH,SAAgB,UAAU;IACxB,OAAO,GAAG,EAAE;QACV,OAAM;IACR,CAAC,CAAA;AACH,CAAC"}

package/dist/decorators/example.d.ts

@@ -0,0 +1 @@
+export declare function Example<T>(exampleModel: T, exampleLabel?: string): PropertyDecorator;

package/dist/decorators/example.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Example = Example;
+function Example(exampleModel, exampleLabel) {
+    return () => {
+        return;
+    };
+}
+//# sourceMappingURL=example.js.map

package/dist/decorators/example.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"example.js","sourceRoot":"","sources":["../../src/decorators/example.ts"],"names":[],"mappings":";;AAAA,0BAIC;AAJD,SAAgB,OAAO,CAAI,YAAe,EAAE,YAAqB;IAC/D,OAAO,GAAG,EAAE;QACV,OAAM;IACR,CAAC,CAAA;AACH,CAAC"}

package/dist/decorators/extension.d.ts

@@ -0,0 +1,4 @@
+export declare function Extension(_name: string, _value: ExtensionType | ExtensionType[]): PropertyDecorator;
+export type ExtensionType = string | number | boolean | null | ExtensionType[] | {
+    [name: string]: ExtensionType | ExtensionType[];
+};

package/dist/decorators/extension.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Extension = Extension;
+function Extension(_name, _value) {
+    return () => {
+        return;
+    };
+}
+//# sourceMappingURL=extension.js.map

package/dist/decorators/extension.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"extension.js","sourceRoot":"","sources":["../../src/decorators/extension.ts"],"names":[],"mappings":";;AAAA,8BAIC;AAJD,SAAgB,SAAS,CAAC,KAAa,EAAE,MAAuC;IAC9E,OAAO,GAAG,EAAE;QACV,OAAM;IACR,CAAC,CAAA;AACH,CAAC"}

package/dist/decorators/methods.d.ts

@@ -0,0 +1,7 @@
+export declare function Options(value?: string): MethodDecorator;
+export declare function Get(value?: string): MethodDecorator;
+export declare function Post(value?: string): MethodDecorator;
+export declare function Put(value?: string): MethodDecorator;
+export declare function Patch(value?: string): MethodDecorator;
+export declare function Delete(value?: string): MethodDecorator;
+export declare function Head(value?: string): MethodDecorator;

package/dist/decorators/methods.js

@@ -0,0 +1,45 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Options = Options;
+exports.Get = Get;
+exports.Post = Post;
+exports.Put = Put;
+exports.Patch = Patch;
+exports.Delete = Delete;
+exports.Head = Head;
+function Options(value) {
+    return () => {
+        return;
+    };
+}
+function Get(value) {
+    return () => {
+        return;
+    };
+}
+function Post(value) {
+    return () => {
+        return;
+    };
+}
+function Put(value) {
+    return () => {
+        return;
+    };
+}
+function Patch(value) {
+    return () => {
+        return;
+    };
+}
+function Delete(value) {
+    return () => {
+        return;
+    };
+}
+function Head(value) {
+    return () => {
+        return;
+    };
+}
+//# sourceMappingURL=methods.js.map

package/dist/decorators/methods.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"methods.js","sourceRoot":"","sources":["../../src/decorators/methods.ts"],"names":[],"mappings":";;AAAA,0BAIC;AAED,kBAIC;AAED,oBAIC;AAED,kBAIC;AAED,sBAIC;AAED,wBAIC;AAED,oBAIC;AAxCD,SAAgB,OAAO,CAAC,KAAc;IACpC,OAAO,GAAG,EAAE;QACV,OAAM;IACR,CAAC,CAAA;AACH,CAAC;AAED,SAAgB,GAAG,CAAC,KAAc;IAChC,OAAO,GAAG,EAAE;QACV,OAAM;IACR,CAAC,CAAA;AACH,CAAC;AAED,SAAgB,IAAI,CAAC,KAAc;IACjC,OAAO,GAAG,EAAE;QACV,OAAM;IACR,CAAC,CAAA;AACH,CAAC;AAED,SAAgB,GAAG,CAAC,KAAc;IAChC,OAAO,GAAG,EAAE;QACV,OAAM;IACR,CAAC,CAAA;AACH,CAAC;AAED,SAAgB,KAAK,CAAC,KAAc;IAClC,OAAO,GAAG,EAAE;QACV,OAAM;IACR,CAAC,CAAA;AACH,CAAC;AAED,SAAgB,MAAM,CAAC,KAAc;IACnC,OAAO,GAAG,EAAE;QACV,OAAM;IACR,CAAC,CAAA;AACH,CAAC;AAED,SAAgB,IAAI,CAAC,KAAc;IACjC,OAAO,GAAG,EAAE;QACV,OAAM;IACR,CAAC,CAAA;AACH,CAAC"}

package/dist/decorators/middlewares.d.ts

@@ -0,0 +1,15 @@
+type Middleware<T extends CallableFunction | object> = T;
+/**
+ * Install middlewares to the Controller or a specific method.
+ * @param middlewares
+ * @returns
+ */
+export declare function Middlewares<T extends CallableFunction | object>(...mws: Array<Middleware<T>>): ClassDecorator & MethodDecorator;
+/**
+ * Internal function used to retrieve installed middlewares
+ * in controller and methods (used during routes generation)
+ * @param target
+ * @returns list of middlewares
+ */
+export declare function fetchMiddlewares<T extends CallableFunction | object>(target: any): Array<Middleware<T>>;
+export {};

package/dist/decorators/middlewares.js

@@ -0,0 +1,53 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Middlewares = Middlewares;
+exports.fetchMiddlewares = fetchMiddlewares;
+const TSOA_MIDDLEWARES = Symbol('@tsoa:middlewares');
+/**
+ * Helper function to create a decorator
+ * that can act as a class and method decorator.
+ * @param fn a callback function that accepts
+ *           the subject of the decorator
+ *           either the constructor or the
+ *           method
+ * @returns
+ */
+function decorator(fn) {
+    return (...args) => {
+        // class decorator
+        if (args.length === 1) {
+            fn(args[0]);
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+        }
+        else if (args.length === 3 && args[2].value) {
+            // method decorator
+            const descriptor = args[2];
+            if (descriptor.value) {
+                fn(descriptor.value);
+            }
+        }
+    };
+}
+/**
+ * Install middlewares to the Controller or a specific method.
+ * @param middlewares
+ * @returns
+ */
+function Middlewares(...mws) {
+    return decorator(target => {
+        if (mws) {
+            const current = fetchMiddlewares(target);
+            Reflect.defineMetadata(TSOA_MIDDLEWARES, [...current, ...mws], target);
+        }
+    });
+}
+/**
+ * Internal function used to retrieve installed middlewares
+ * in controller and methods (used during routes generation)
+ * @param target
+ * @returns list of middlewares
+ */
+function fetchMiddlewares(target) {
+    return Reflect.getMetadata(TSOA_MIDDLEWARES, target) || [];
+}
+//# sourceMappingURL=middlewares.js.map

package/dist/decorators/middlewares.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"middlewares.js","sourceRoot":"","sources":["../../src/decorators/middlewares.ts"],"names":[],"mappings":";;AAkCA,kCAOC;AAQD,4CAEC;AAjDD,MAAM,gBAAgB,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAA;AAEpD;;;;;;;;GAQG;AACH,SAAS,SAAS,CAAC,EAAwB;IACzC,OAAO,CAAC,GAAG,IAAW,EAAE,EAAE;QACxB,kBAAkB;QAClB,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;YACX,sEAAsE;QACxE,CAAC;aAAM,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC;YAC9C,mBAAmB;YACnB,MAAM,UAAU,GAAG,IAAI,CAAC,CAAC,CAAuB,CAAA;YAChD,IAAI,UAAU,CAAC,KAAK,EAAE,CAAC;gBACrB,EAAE,CAAC,UAAU,CAAC,KAAK,CAAC,CAAA;YACtB,CAAC;QACH,CAAC;IACH,CAAC,CAAA;AACH,CAAC;AAED;;;;GAIG;AACH,SAAgB,WAAW,CAAsC,GAAG,GAAyB;IAC3F,OAAO,SAAS,CAAC,MAAM,CAAC,EAAE;QACxB,IAAI,GAAG,EAAE,CAAC;YACR,MAAM,OAAO,GAAG,gBAAgB,CAAI,MAAM,CAAC,CAAA;YAC3C,OAAO,CAAC,cAAc,CAAC,gBAAgB,EAAE,CAAC,GAAG,OAAO,EAAE,GAAG,GAAG,CAAC,EAAE,MAAM,CAAC,CAAA;QACxE,CAAC;IACH,CAAC,CAAC,CAAA;AACJ,CAAC;AAED;;;;;GAKG;AACH,SAAgB,gBAAgB,CAAsC,MAAW;IAC/E,OAAO,OAAO,CAAC,WAAW,CAAC,gBAAgB,EAAE,MAAM,CAAC,IAAI,EAAE,CAAA;AAC5D,CAAC"}

package/dist/decorators/operationid.d.ts

@@ -0,0 +1 @@
+export declare function OperationId(value: string): MethodDecorator;

package/dist/decorators/operationid.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OperationId = OperationId;
+function OperationId(value) {
+    return () => {
+        return;
+    };
+}
+//# sourceMappingURL=operationid.js.map

package/dist/decorators/operationid.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"operationid.js","sourceRoot":"","sources":["../../src/decorators/operationid.ts"],"names":[],"mappings":";;AAAA,kCAIC;AAJD,SAAgB,WAAW,CAAC,KAAa;IACvC,OAAO,GAAG,EAAE;QACV,OAAM;IACR,CAAC,CAAA;AACH,CAAC"}

package/dist/decorators/parameter.d.ts

@@ -0,0 +1,73 @@
+/**
+ * Inject http Body
+ *  @param {string} [name] properties name in body object
+ */
+export declare function Body(): ParameterDecorator;
+/**
+ * Inject value from body
+ *
+ * @param {string} [name] The name of the body parameter
+ */
+export declare function BodyProp(name?: string): ParameterDecorator;
+/**
+ * Inject http request
+ */
+export declare function Request(): ParameterDecorator;
+/**
+ * Inject value from request
+ *
+ * @param {name} [name] The name of the request parameter
+ */
+export declare function RequestProp(name?: string): ParameterDecorator;
+/**
+ * Inject value from Path
+ *
+ * @param {string} [name] The name of the path parameter
+ */
+export declare function Path(name?: string): ParameterDecorator;
+/**
+ * Inject value from query string
+ *
+ * @param {string} [name] The name of the query parameter
+ */
+export declare function Query(name?: string): ParameterDecorator;
+/**
+ * Inject all query values in a single object
+ */
+export declare function Queries(): ParameterDecorator;
+/**
+ * Inject value from Http header
+ *
+ * @param {string} [name] The name of the header parameter
+ */
+export declare function Header(name?: string): ParameterDecorator;
+/**
+ * Mark parameter as manually injected, which will not be generated
+ */
+export declare function Inject(): ParameterDecorator;
+/**
+ * Inject uploaded file
+ *
+ * @param {string} [name] The name of the uploaded file parameter
+ */
+export declare function UploadedFile(name?: string): ParameterDecorator;
+/**
+ * Inject uploaded files
+ *
+ * @param {string} [name] The name of the uploaded files parameter
+ */
+export declare function UploadedFiles(name?: string): ParameterDecorator;
+/**
+ * Inject uploaded files
+ *
+ * @param {string} [name] The name of the uploaded files parameter
+ */
+export declare function FormField(name?: string): ParameterDecorator;
+/**
+ * Overrides the default media type of request body.
+ * Can be used on specific method.
+ * Can't be used on controller level.
+ *
+ * @link https://swagger.io/docs/specification/describing-request-body/
+ */
+export declare function Consumes(value: string): MethodDecorator;