@tsoa-next/runtime 8.0.4 → 8.0.5-dev.58.3748c499

package/dist/config.d.ts

@@ -1,12 +1,13 @@
 import { Options as MulterOpts } from 'multer';
 import { Swagger } from './swagger/swagger';
+/** Root tsoa-next configuration consumed by the CLI and programmatic generators. */
 export interface Config {
     /**
-     * Swagger generation configuration object
+     * OpenAPI generation configuration.
      */
     spec: SpecConfig;
     /**
-     * Route generation configuration object
+     * Route generation configuration.
      */
     routes: RoutesConfig;
     /**
@@ -40,38 +41,45 @@ export interface Config {
      */
     compilerOptions?: Record<string, unknown>;
     /**
-     * Multer's options to generate multer's middleware.
-     * It doesn't support storage option
+     * Legacy multer options forwarded into generated middleware.
+     * The `storage` option is not supported.
      *
      * @example {
      *   "dest": "/tmp"
-     * } Allow multer to write to file instead of using Memory's buffer
+     * } Allows multer to write files to disk instead of keeping them in memory.
      * @deprecated
-     *  since v6.4.0 instroduces RegisterRoutes can pass multerOptions,
-     *  we will quickly remove this options soon at future version.
+     *  Since v6.4.0, `RegisterRoutes` can receive `multerOptions` directly.
+     *  This config-level option will be removed in a future release.
      *  (https://github.com/tsoa-next/tsoa-next/issues/1587#issuecomment-2391291433)
      *  (https://github.com/tsoa-next/tsoa-next/pull/1638)
      */
     multerOpts?: MulterOpts;
+    /**
+     * OpenAPI number type to use for TypeScript `number` when no narrower annotation is present.
+     * @default double
+     */
     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
+ * Legacy boolean form of `noImplicitAdditionalProperties`.
+ *
+ * @deprecated Use the explicit string options instead.
  */
 export type DeprecatedOptionForAdditionalPropertiesHandling = true | false;
+/** OpenAPI generation settings. */
 export interface SpecConfig {
     /**
-     * Generated SwaggerConfig.json will output here
+     * Directory where the generated spec file should be written.
      */
     outputDirectory: string;
     /**
-     * API host, expressTemplate.g. localhost:3000 or myapi.com
+     * API host name for Swagger 2 output, for example `localhost:3000`.
      */
     host?: string;
     /**
-     * API servers, expressTemplate.g. [production.api.com, staging.api.com]
+     * Server URLs for OpenAPI 3 output.
      *
-     * Only available with the specVersion 3
+     * Only available with spec version 3 or 3.1.
      */
     servers?: string[];
     /**
@@ -80,10 +88,7 @@ export interface SpecConfig {
      * @default: "swagger"
      */
     specFileBaseName?: string;
-    /**
-  
-     * API version number; defaults to npm package version
-     */
+    /** API version number; defaults to the package version. */
     version?: string;
     /**
      * Major OpenAPI version to generate; defaults to version 2 when not specified
@@ -107,7 +112,7 @@ export interface SpecConfig {
      */
     termsOfService?: string;
     /**
-     * Contact Information
+     * Contact information for the published API.
      */
     contact?: {
         /**
@@ -121,8 +126,7 @@ export interface SpecConfig {
          */
         email?: string;
         /**
-         * API Info url
-         * The URL pointing to the contact information.
+         * URL pointing to the contact information.
          * @default npm package author url
          */
         url?: string;
@@ -136,25 +140,22 @@ export interface SpecConfig {
      */
     basePath?: string;
     /**
-     * Base API prefix slash toggle
-     * e.g. the 'v1' with toggle true will be https://myapi.comv1
-     * Otherwise, http://myapi.com/v1
+     * Controls whether `basePath` is prefixed with `/` when composing OpenAPI 3 server URLs.
      *
-     * Only available with the specVersion 3
+     * Only available with spec version 3 or 3.1.
      */
     disableBasePathPrefixSlash?: boolean;
     /**
-     * Extend generated swagger spec with this object
-     * Note that generated properties will always take precedence over what get specified here
+     * Object merged into the generated spec.
+     * Generated properties always take precedence over values provided here.
      */
     spec?: unknown;
     /**
-     * Alter how the spec is merged to generated swagger spec.
+     * Controls how `spec` is merged into the generated document.
      * 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.
+     *  - 'immediate' overrides only top-level elements.
+     *  - 'recursive' performs a deep merge using `merge`.
+     *  - 'deepmerge' performs a deep merge using `ts-deepmerge`, including arrays.
      * @default 'immediate'
      */
     specMerging?: 'immediate' | 'recursive' | 'deepmerge';
@@ -169,19 +170,18 @@ export interface SpecConfig {
      */
     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.
+     * Security schemes declared for the specification.
      */
     securityDefinitions?: {
         [name: string]: Swagger.SecuritySchemes;
     };
     /**
-     * Swagger Tags Information for your API
+     * Top-level tag metadata for the generated specification.
      */
     tags?: Swagger.Tag[];
+    /** Writes the generated spec as YAML instead of JSON. */
     yaml?: boolean;
+    /** Supported protocols for Swagger 2 output. */
     schemes?: Swagger.Protocol[];
     /**
      * Enable x-enum-varnames support
@@ -189,8 +189,7 @@ export interface SpecConfig {
      */
     xEnumVarnames?: boolean;
     /**
-     * Sets a title for inline objects for responses and requestBodies
-     * This helps to generate more consistent clients
+     * Adds titles to inline response and request-body object schemas to improve client generation.
      */
     useTitleTagsForInlineObjects?: boolean;
     /**
@@ -201,15 +200,15 @@ export interface SpecConfig {
 }
 export interface RoutesConfig {
     /**
-     * Routes directory; generated routes.ts (which contains the generated code wiring up routes using middleware of choice) will be dropped here
+     * Directory where generated route files are written.
      */
     routesDir: string;
     /**
-     * Routes filename; the filename of the generated route file ('routes.ts' by default)
+     * Filename for the generated route module.
      */
     routesFileName?: string;
     /**
-     * Avoid writing the generated route file if the existing file is identical (useful to optimize watch processes); false by default
+     * Skips writing the route file when the generated content matches the existing file.
      */
     noWriteIfUnchanged?: boolean;
     /**
@@ -221,26 +220,32 @@ export interface RoutesConfig {
      */
     middleware?: 'express' | 'hapi' | 'koa';
     /**
-     * Override the Middleware template
+     * Custom Handlebars template path used instead of the built-in middleware template.
      */
     middlewareTemplate?: string;
     /**
-     * IOC module; e.g. './inversify/ioc' where IOC container named `iocContainer` is defined (https://github.com/inversify/InversifyJS)
+     * IoC module path, for example `./inversify/ioc`.
      */
     iocModule?: string;
     /**
-     * Authentication Module for express, hapi and koa
+     * Authentication module path used by generated routes.
      */
     authenticationModule?: string;
     /**
-     * When enabled, the imports in the routes files will have a `.js` extention to support esm.
+     * When enabled, generated route imports use `.js` extensions for ESM output.
      *
      * @default false
      */
     esm?: boolean;
+    /**
+     * Whether to implicitly coerce body parameters into an accepted type.
+     *
+     * @default true
+     */
     bodyCoercion?: boolean;
     /**
-     * When enabled, the imports in the routes files will keep having a `.ts` extention to support the TypeScript 5.7 feature rewriteRelativeImportExtensions.
+     * When enabled, generated route imports keep `.ts` extensions to support TypeScript 5.7 `rewriteRelativeImportExtensions`.
+     *
      * @default false
      */
     rewriteRelativeImportExtensions?: boolean;

package/dist/decorators/customAttribute.d.ts

@@ -1 +1,7 @@
+/**
+ * Adds a custom metadata attribute to a model property.
+ *
+ * @param _name The custom attribute name.
+ * @param _value The string value stored for the attribute.
+ */
 export declare function CustomAttribute(_name: string, _value: string): PropertyDecorator;

package/dist/decorators/customAttribute.js

@@ -1,6 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CustomAttribute = CustomAttribute;
+/**
+ * Adds a custom metadata attribute to a model property.
+ *
+ * @param _name The custom attribute name.
+ * @param _value The string value stored for the attribute.
+ */
 function CustomAttribute(_name, _value) {
     return () => {
         return;

package/dist/decorators/customAttribute.js.map

@@ -1 +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"}
+{"version":3,"file":"customAttribute.js","sourceRoot":"","sources":["../../src/decorators/customAttribute.ts"],"names":[],"mappings":";;AAMA,0CAIC;AAVD;;;;;GAKG;AACH,SAAgB,eAAe,CAAC,KAAa,EAAE,MAAc;IAC3D,OAAO,GAAG,EAAE;QACV,OAAM;IACR,CAAC,CAAA;AACH,CAAC"}

package/dist/decorators/deprecated.d.ts

@@ -1,4 +1,4 @@
 /**
- * used to show a method as deprecated on swagger documentation
+ * Marks a reflected API element as deprecated in generated documentation.
  */
 export declare function Deprecated(): PropertyDecorator & ClassDecorator & ParameterDecorator;

package/dist/decorators/deprecated.js

@@ -2,7 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Deprecated = Deprecated;
 /**
- * used to show a method as deprecated on swagger documentation
+ * Marks a reflected API element as deprecated in generated documentation.
  */
 function Deprecated() {
     return () => {

package/dist/decorators/example.d.ts

@@ -1 +1,7 @@
+/**
+ * Attaches an example value to a model property.
+ *
+ * @param _exampleModel The example value to include in generated schema metadata.
+ * @param _exampleLabel Optional label used when multiple examples are present.
+ */
 export declare function Example<T>(_exampleModel: T, _exampleLabel?: string): PropertyDecorator;

package/dist/decorators/example.js

@@ -1,6 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Example = Example;
+/**
+ * Attaches an example value to a model property.
+ *
+ * @param _exampleModel The example value to include in generated schema metadata.
+ * @param _exampleLabel Optional label used when multiple examples are present.
+ */
 function Example(_exampleModel, _exampleLabel) {
     return () => {
         return;

package/dist/decorators/example.js.map

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

package/dist/decorators/extension.d.ts

@@ -1,4 +1,11 @@
+/**
+ * Adds an OpenAPI specification extension to a model property.
+ *
+ * @param _name The extension key, typically beginning with `x-`.
+ * @param _value The extension value.
+ */
 export declare function Extension(_name: string, _value: ExtensionType | ExtensionType[]): PropertyDecorator;
+/** Value types supported by OpenAPI specification extensions. */
 export type ExtensionType = string | number | boolean | null | ExtensionType[] | {
     [name: string]: ExtensionType | ExtensionType[];
 };

package/dist/decorators/extension.js

@@ -1,6 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Extension = Extension;
+/**
+ * Adds an OpenAPI specification extension to a model property.
+ *
+ * @param _name The extension key, typically beginning with `x-`.
+ * @param _value The extension value.
+ */
 function Extension(_name, _value) {
     return () => {
         return;

package/dist/decorators/extension.js.map

@@ -1 +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"}
+{"version":3,"file":"extension.js","sourceRoot":"","sources":["../../src/decorators/extension.ts"],"names":[],"mappings":";;AAMA,8BAIC;AAVD;;;;;GAKG;AACH,SAAgB,SAAS,CAAC,KAAa,EAAE,MAAuC;IAC9E,OAAO,GAAG,EAAE;QACV,OAAM;IACR,CAAC,CAAA;AACH,CAAC"}

package/dist/decorators/methods.d.ts

@@ -1,7 +1,14 @@
+/** Marks a controller method as handling HTTP `OPTIONS` requests for the given relative path. */
 export declare function Options(_value?: string): MethodDecorator;
+/** Marks a controller method as handling HTTP `GET` requests for the given relative path. */
 export declare function Get(_value?: string): MethodDecorator;
+/** Marks a controller method as handling HTTP `POST` requests for the given relative path. */
 export declare function Post(_value?: string): MethodDecorator;
+/** Marks a controller method as handling HTTP `PUT` requests for the given relative path. */
 export declare function Put(_value?: string): MethodDecorator;
+/** Marks a controller method as handling HTTP `PATCH` requests for the given relative path. */
 export declare function Patch(_value?: string): MethodDecorator;
+/** Marks a controller method as handling HTTP `DELETE` requests for the given relative path. */
 export declare function Delete(_value?: string): MethodDecorator;
+/** Marks a controller method as handling HTTP `HEAD` requests for the given relative path. */
 export declare function Head(_value?: string): MethodDecorator;

package/dist/decorators/methods.js

@@ -8,24 +8,31 @@ exports.Patch = Patch;
 exports.Delete = Delete;
 exports.Head = Head;
 const noop_1 = require("./noop");
+/** Marks a controller method as handling HTTP `OPTIONS` requests for the given relative path. */
 function Options(_value) {
     return (0, noop_1.createNoopMethodDecorator)('options');
 }
+/** Marks a controller method as handling HTTP `GET` requests for the given relative path. */
 function Get(_value) {
     return (0, noop_1.createNoopMethodDecorator)('get');
 }
+/** Marks a controller method as handling HTTP `POST` requests for the given relative path. */
 function Post(_value) {
     return (0, noop_1.createNoopMethodDecorator)('post');
 }
+/** Marks a controller method as handling HTTP `PUT` requests for the given relative path. */
 function Put(_value) {
     return (0, noop_1.createNoopMethodDecorator)('put');
 }
+/** Marks a controller method as handling HTTP `PATCH` requests for the given relative path. */
 function Patch(_value) {
     return (0, noop_1.createNoopMethodDecorator)('patch');
 }
+/** Marks a controller method as handling HTTP `DELETE` requests for the given relative path. */
 function Delete(_value) {
     return (0, noop_1.createNoopMethodDecorator)('delete');
 }
+/** Marks a controller method as handling HTTP `HEAD` requests for the given relative path. */
 function Head(_value) {
     return (0, noop_1.createNoopMethodDecorator)('head');
 }

package/dist/decorators/methods.js.map

@@ -1 +1 @@
-{"version":3,"file":"methods.js","sourceRoot":"","sources":["../../src/decorators/methods.ts"],"names":[],"mappings":";;AAEA,0BAEC;AAED,kBAEC;AAED,oBAEC;AAED,kBAEC;AAED,sBAEC;AAED,wBAEC;AAED,oBAEC;AA5BD,iCAAkD;AAElD,SAAgB,OAAO,CAAC,MAAe;IACrC,OAAO,IAAA,gCAAyB,EAAC,SAAS,CAAC,CAAA;AAC7C,CAAC;AAED,SAAgB,GAAG,CAAC,MAAe;IACjC,OAAO,IAAA,gCAAyB,EAAC,KAAK,CAAC,CAAA;AACzC,CAAC;AAED,SAAgB,IAAI,CAAC,MAAe;IAClC,OAAO,IAAA,gCAAyB,EAAC,MAAM,CAAC,CAAA;AAC1C,CAAC;AAED,SAAgB,GAAG,CAAC,MAAe;IACjC,OAAO,IAAA,gCAAyB,EAAC,KAAK,CAAC,CAAA;AACzC,CAAC;AAED,SAAgB,KAAK,CAAC,MAAe;IACnC,OAAO,IAAA,gCAAyB,EAAC,OAAO,CAAC,CAAA;AAC3C,CAAC;AAED,SAAgB,MAAM,CAAC,MAAe;IACpC,OAAO,IAAA,gCAAyB,EAAC,QAAQ,CAAC,CAAA;AAC5C,CAAC;AAED,SAAgB,IAAI,CAAC,MAAe;IAClC,OAAO,IAAA,gCAAyB,EAAC,MAAM,CAAC,CAAA;AAC1C,CAAC"}
+{"version":3,"file":"methods.js","sourceRoot":"","sources":["../../src/decorators/methods.ts"],"names":[],"mappings":";;AAGA,0BAEC;AAGD,kBAEC;AAGD,oBAEC;AAGD,kBAEC;AAGD,sBAEC;AAGD,wBAEC;AAGD,oBAEC;AAnCD,iCAAkD;AAElD,iGAAiG;AACjG,SAAgB,OAAO,CAAC,MAAe;IACrC,OAAO,IAAA,gCAAyB,EAAC,SAAS,CAAC,CAAA;AAC7C,CAAC;AAED,6FAA6F;AAC7F,SAAgB,GAAG,CAAC,MAAe;IACjC,OAAO,IAAA,gCAAyB,EAAC,KAAK,CAAC,CAAA;AACzC,CAAC;AAED,8FAA8F;AAC9F,SAAgB,IAAI,CAAC,MAAe;IAClC,OAAO,IAAA,gCAAyB,EAAC,MAAM,CAAC,CAAA;AAC1C,CAAC;AAED,6FAA6F;AAC7F,SAAgB,GAAG,CAAC,MAAe;IACjC,OAAO,IAAA,gCAAyB,EAAC,KAAK,CAAC,CAAA;AACzC,CAAC;AAED,+FAA+F;AAC/F,SAAgB,KAAK,CAAC,MAAe;IACnC,OAAO,IAAA,gCAAyB,EAAC,OAAO,CAAC,CAAA;AAC3C,CAAC;AAED,gGAAgG;AAChG,SAAgB,MAAM,CAAC,MAAe;IACpC,OAAO,IAAA,gCAAyB,EAAC,QAAQ,CAAC,CAAA;AAC5C,CAAC;AAED,8FAA8F;AAC9F,SAAgB,IAAI,CAAC,MAAe;IAClC,OAAO,IAAA,gCAAyB,EAAC,MAAM,CAAC,CAAA;AAC1C,CAAC"}

package/dist/decorators/middlewares.d.ts

@@ -1,16 +1,15 @@
 type Middleware<T extends CallableFunction | object> = T;
 type MiddlewareTarget = CallableFunction | object;
 /**
- * Install middlewares to the Controller or a specific method.
- * @param middlewares
- * @returns
+ * Attaches one or more runtime middleware handlers to a controller or action.
+ *
+ * @param mws The middleware functions or middleware objects to install.
  */
 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
+ * Returns middleware metadata previously attached with {@link Middlewares}.
+ *
+ * @param target The controller class or method function to inspect.
  */
 export declare function fetchMiddlewares<T extends CallableFunction | object>(target: MiddlewareTarget): Array<Middleware<T>>;
 export {};

package/dist/decorators/middlewares.js

@@ -32,9 +32,9 @@ function decorator(fn) {
     };
 }
 /**
- * Install middlewares to the Controller or a specific method.
- * @param middlewares
- * @returns
+ * Attaches one or more runtime middleware handlers to a controller or action.
+ *
+ * @param mws The middleware functions or middleware objects to install.
  */
 function Middlewares(...mws) {
     return decorator(target => {
@@ -45,10 +45,9 @@ function Middlewares(...mws) {
     });
 }
 /**
- * Internal function used to retrieve installed middlewares
- * in controller and methods (used during routes generation)
- * @param target
- * @returns list of middlewares
+ * Returns middleware metadata previously attached with {@link Middlewares}.
+ *
+ * @param target The controller class or method function to inspect.
  */
 function fetchMiddlewares(target) {
     return Reflect.getMetadata(TSOA_MIDDLEWARES, target) ?? [];

package/dist/decorators/middlewares.js.map

@@ -1 +1 @@
-{"version":3,"file":"middlewares.js","sourceRoot":"","sources":["../../src/decorators/middlewares.ts"],"names":[],"mappings":";;AAwCA,kCAOC;AAQD,4CAEC;AArDD,MAAM,gBAAgB,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAA;AAEpD,SAAS,kBAAkB,CAAC,KAAc;IACxC,OAAO,OAAO,KAAK,KAAK,UAAU,IAAI,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC,CAAA;AACrF,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,SAAS,CAAC,EAAqC;IACtD,OAAO,CAAC,GAAG,IAA6B,EAAE,EAAE;QAC1C,kBAAkB;QAClB,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,CAAA;YACrB,EAAE,CAAC,MAAM,CAAC,CAAA;QACZ,CAAC;aAAM,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,mBAAmB;YACnB,MAAM,CAAC,EAAE,AAAD,EAAG,UAAU,CAAC,GAAG,IAAI,CAAA;YAC7B,IAAI,kBAAkB,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzC,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,MAAwB;IAC5F,OAAQ,OAAO,CAAC,WAAW,CAAC,gBAAgB,EAAE,MAAM,CAAsC,IAAI,EAAE,CAAA;AAClG,CAAC"}
+{"version":3,"file":"middlewares.js","sourceRoot":"","sources":["../../src/decorators/middlewares.ts"],"names":[],"mappings":";;AAwCA,kCAOC;AAOD,4CAEC;AApDD,MAAM,gBAAgB,GAAG,MAAM,CAAC,mBAAmB,CAAC,CAAA;AAEpD,SAAS,kBAAkB,CAAC,KAAc;IACxC,OAAO,OAAO,KAAK,KAAK,UAAU,IAAI,CAAC,OAAO,KAAK,KAAK,QAAQ,IAAI,KAAK,KAAK,IAAI,CAAC,CAAA;AACrF,CAAC;AAED;;;;;;;;GAQG;AACH,SAAS,SAAS,CAAC,EAAqC;IACtD,OAAO,CAAC,GAAG,IAA6B,EAAE,EAAE;QAC1C,kBAAkB;QAClB,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YACtB,MAAM,CAAC,MAAM,CAAC,GAAG,IAAI,CAAA;YACrB,EAAE,CAAC,MAAM,CAAC,CAAA;QACZ,CAAC;aAAM,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;YAC7B,mBAAmB;YACnB,MAAM,CAAC,EAAE,AAAD,EAAG,UAAU,CAAC,GAAG,IAAI,CAAA;YAC7B,IAAI,kBAAkB,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;gBACzC,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;;;;GAIG;AACH,SAAgB,gBAAgB,CAAsC,MAAwB;IAC5F,OAAQ,OAAO,CAAC,WAAW,CAAC,gBAAgB,EAAE,MAAM,CAAsC,IAAI,EAAE,CAAA;AAClG,CAAC"}

package/dist/decorators/operationid.d.ts

@@ -1 +1,6 @@
+/**
+ * Overrides the generated OpenAPI operation id for an action.
+ *
+ * @param _value The explicit operation id to emit into the specification.
+ */
 export declare function OperationId(_value: string): MethodDecorator;

package/dist/decorators/operationid.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OperationId = OperationId;
+/**
+ * Overrides the generated OpenAPI operation id for an action.
+ *
+ * @param _value The explicit operation id to emit into the specification.
+ */
 function OperationId(_value) {
     return () => {
         return;

package/dist/decorators/operationid.js.map

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

package/dist/decorators/parameter.d.ts

@@ -1,73 +1,71 @@
 /**
- * Inject http Body
- *  @param {string} [name] properties name in body object
+ * Binds the full HTTP request body to a controller parameter.
  */
 export declare function Body(): ParameterDecorator;
 /**
- * Inject value from body
+ * Binds a single property from the request body to a controller parameter.
  *
- * @param {string} [name] The name of the body parameter
+ * @param _name The property name to read from the request body. Defaults to the parameter name.
  */
 export declare function BodyProp(_name?: string): ParameterDecorator;
 /**
- * Inject http request
+ * Injects the underlying runtime request object.
  */
 export declare function Request(): ParameterDecorator;
 /**
- * Inject value from request
+ * Binds a property from the underlying runtime request object.
  *
- * @param {name} [name] The name of the request parameter
+ * @param _name The request property name to read. Defaults to the parameter name.
  */
 export declare function RequestProp(_name?: string): ParameterDecorator;
 /**
- * Inject value from Path
+ * Binds a path parameter from the request URL.
  *
- * @param {string} [name] The name of the path parameter
+ * @param _name The path parameter name. Defaults to the parameter name.
  */
 export declare function Path(_name?: string): ParameterDecorator;
 /**
- * Inject value from query string
+ * Binds a query-string value to a controller parameter.
  *
- * @param {string} [name] The name of the query parameter
+ * @param _name The query parameter name. Defaults to the parameter name.
  */
 export declare function Query(_name?: string): ParameterDecorator;
 /**
- * Inject all query values in a single object
+ * Binds the entire query object to a single controller parameter.
  */
 export declare function Queries(): ParameterDecorator;
 /**
- * Inject value from Http header
+ * Binds an HTTP header value to a controller parameter.
  *
- * @param {string} [name] The name of the header parameter
+ * @param _name The header name. Defaults to the parameter name.
  */
 export declare function Header(_name?: string): ParameterDecorator;
 /**
- * Mark parameter as manually injected, which will not be generated
+ * Marks a parameter as injected by user code so tsoa skips route-generation metadata for it.
  */
 export declare function Inject(): ParameterDecorator;
 /**
- * Inject uploaded file
+ * Binds a single uploaded file from a multipart/form-data request.
  *
- * @param {string} [name] The name of the uploaded file parameter
+ * @param _name The multipart field name. Defaults to the parameter name.
  */
 export declare function UploadedFile(_name?: string): ParameterDecorator;
 /**
- * Inject uploaded files
+ * Binds multiple uploaded files from a multipart/form-data request.
  *
- * @param {string} [name] The name of the uploaded files parameter
+ * @param _name The multipart field name. Defaults to the parameter name.
  */
 export declare function UploadedFiles(_name?: string): ParameterDecorator;
 /**
- * Inject uploaded files
+ * Binds a regular multipart form field from a multipart/form-data request.
  *
- * @param {string} [name] The name of the uploaded files parameter
+ * @param _name The multipart field name. Defaults to the parameter name.
  */
 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.
+ * Overrides the media type used to document a request body for a single action.
  *
+ * @param _value The request body media type, for example `application/json`.
  * @link https://swagger.io/docs/specification/describing-request-body/
  */
 export declare function Consumes(_value: string): MethodDecorator;