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

package/dist/decorators/parameter.js

@@ -15,99 +15,97 @@ exports.FormField = FormField;
 exports.Consumes = Consumes;
 const noop_1 = require("./noop");
 /**
- * Inject http Body
- *  @param {string} [name] properties name in body object
+ * Binds the full HTTP request body to a controller parameter.
  */
 function Body() {
     return (0, noop_1.createNoopParameterDecorator)('body');
 }
 /**
- * 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.
  */
 function BodyProp(_name) {
     return (0, noop_1.createNoopParameterDecorator)('body-prop');
 }
 /**
- * Inject http request
+ * Injects the underlying runtime request object.
  */
 function Request() {
     return (0, noop_1.createNoopParameterDecorator)('request');
 }
 /**
- * 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.
  */
 function RequestProp(_name) {
     return (0, noop_1.createNoopParameterDecorator)('request-prop');
 }
 /**
- * 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.
  */
 function Path(_name) {
     return (0, noop_1.createNoopParameterDecorator)('path');
 }
 /**
- * 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.
  */
 function Query(_name) {
     return (0, noop_1.createNoopParameterDecorator)('query');
 }
 /**
- * Inject all query values in a single object
+ * Binds the entire query object to a single controller parameter.
  */
 function Queries() {
     return (0, noop_1.createNoopParameterDecorator)('queries');
 }
 /**
- * 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.
  */
 function Header(_name) {
     return (0, noop_1.createNoopParameterDecorator)('header');
 }
 /**
- * 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.
  */
 function Inject() {
     return (0, noop_1.createNoopParameterDecorator)('inject');
 }
 /**
- * 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.
  */
 function UploadedFile(_name) {
     return (0, noop_1.createNoopParameterDecorator)('uploaded-file');
 }
 /**
- * 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.
  */
 function UploadedFiles(_name) {
     return (0, noop_1.createNoopParameterDecorator)('uploaded-files');
 }
 /**
- * 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.
  */
 function FormField(_name) {
     return (0, noop_1.createNoopParameterDecorator)('form-field');
 }
 /**
- * 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/
  */
 function Consumes(_value) {

package/dist/decorators/parameter.js.map

@@ -1 +1 @@
-{"version":3,"file":"parameter.js","sourceRoot":"","sources":["../../src/decorators/parameter.ts"],"names":[],"mappings":";;AAMA,oBAEC;AAOD,4BAEC;AAKD,0BAEC;AAOD,kCAEC;AAOD,oBAEC;AAOD,sBAEC;AAKD,0BAEC;AAOD,wBAEC;AAKD,wBAEC;AAOD,oCAEC;AAOD,sCAEC;AAOD,8BAEC;AASD,4BAEC;AAhHD,iCAAgF;AAEhF;;;GAGG;AACH,SAAgB,IAAI;IAClB,OAAO,IAAA,mCAA4B,EAAC,MAAM,CAAC,CAAA;AAC7C,CAAC;AAED;;;;GAIG;AACH,SAAgB,QAAQ,CAAC,KAAc;IACrC,OAAO,IAAA,mCAA4B,EAAC,WAAW,CAAC,CAAA;AAClD,CAAC;AAED;;GAEG;AACH,SAAgB,OAAO;IACrB,OAAO,IAAA,mCAA4B,EAAC,SAAS,CAAC,CAAA;AAChD,CAAC;AAED;;;;GAIG;AACH,SAAgB,WAAW,CAAC,KAAc;IACxC,OAAO,IAAA,mCAA4B,EAAC,cAAc,CAAC,CAAA;AACrD,CAAC;AAED;;;;GAIG;AACH,SAAgB,IAAI,CAAC,KAAc;IACjC,OAAO,IAAA,mCAA4B,EAAC,MAAM,CAAC,CAAA;AAC7C,CAAC;AAED;;;;GAIG;AACH,SAAgB,KAAK,CAAC,KAAc;IAClC,OAAO,IAAA,mCAA4B,EAAC,OAAO,CAAC,CAAA;AAC9C,CAAC;AAED;;GAEG;AACH,SAAgB,OAAO;IACrB,OAAO,IAAA,mCAA4B,EAAC,SAAS,CAAC,CAAA;AAChD,CAAC;AAED;;;;GAIG;AACH,SAAgB,MAAM,CAAC,KAAc;IACnC,OAAO,IAAA,mCAA4B,EAAC,QAAQ,CAAC,CAAA;AAC/C,CAAC;AAED;;GAEG;AACH,SAAgB,MAAM;IACpB,OAAO,IAAA,mCAA4B,EAAC,QAAQ,CAAC,CAAA;AAC/C,CAAC;AAED;;;;GAIG;AACH,SAAgB,YAAY,CAAC,KAAc;IACzC,OAAO,IAAA,mCAA4B,EAAC,eAAe,CAAC,CAAA;AACtD,CAAC;AAED;;;;GAIG;AACH,SAAgB,aAAa,CAAC,KAAc;IAC1C,OAAO,IAAA,mCAA4B,EAAC,gBAAgB,CAAC,CAAA;AACvD,CAAC;AAED;;;;GAIG;AACH,SAAgB,SAAS,CAAC,KAAc;IACtC,OAAO,IAAA,mCAA4B,EAAC,YAAY,CAAC,CAAA;AACnD,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,QAAQ,CAAC,MAAc;IACrC,OAAO,IAAA,gCAAyB,EAAC,UAAU,CAAC,CAAA;AAC9C,CAAC"}
+{"version":3,"file":"parameter.js","sourceRoot":"","sources":["../../src/decorators/parameter.ts"],"names":[],"mappings":";;AAKA,oBAEC;AAOD,4BAEC;AAKD,0BAEC;AAOD,kCAEC;AAOD,oBAEC;AAOD,sBAEC;AAKD,0BAEC;AAOD,wBAEC;AAKD,wBAEC;AAOD,oCAEC;AAOD,sCAEC;AAOD,8BAEC;AAQD,4BAEC;AA9GD,iCAAgF;AAEhF;;GAEG;AACH,SAAgB,IAAI;IAClB,OAAO,IAAA,mCAA4B,EAAC,MAAM,CAAC,CAAA;AAC7C,CAAC;AAED;;;;GAIG;AACH,SAAgB,QAAQ,CAAC,KAAc;IACrC,OAAO,IAAA,mCAA4B,EAAC,WAAW,CAAC,CAAA;AAClD,CAAC;AAED;;GAEG;AACH,SAAgB,OAAO;IACrB,OAAO,IAAA,mCAA4B,EAAC,SAAS,CAAC,CAAA;AAChD,CAAC;AAED;;;;GAIG;AACH,SAAgB,WAAW,CAAC,KAAc;IACxC,OAAO,IAAA,mCAA4B,EAAC,cAAc,CAAC,CAAA;AACrD,CAAC;AAED;;;;GAIG;AACH,SAAgB,IAAI,CAAC,KAAc;IACjC,OAAO,IAAA,mCAA4B,EAAC,MAAM,CAAC,CAAA;AAC7C,CAAC;AAED;;;;GAIG;AACH,SAAgB,KAAK,CAAC,KAAc;IAClC,OAAO,IAAA,mCAA4B,EAAC,OAAO,CAAC,CAAA;AAC9C,CAAC;AAED;;GAEG;AACH,SAAgB,OAAO;IACrB,OAAO,IAAA,mCAA4B,EAAC,SAAS,CAAC,CAAA;AAChD,CAAC;AAED;;;;GAIG;AACH,SAAgB,MAAM,CAAC,KAAc;IACnC,OAAO,IAAA,mCAA4B,EAAC,QAAQ,CAAC,CAAA;AAC/C,CAAC;AAED;;GAEG;AACH,SAAgB,MAAM;IACpB,OAAO,IAAA,mCAA4B,EAAC,QAAQ,CAAC,CAAA;AAC/C,CAAC;AAED;;;;GAIG;AACH,SAAgB,YAAY,CAAC,KAAc;IACzC,OAAO,IAAA,mCAA4B,EAAC,eAAe,CAAC,CAAA;AACtD,CAAC;AAED;;;;GAIG;AACH,SAAgB,aAAa,CAAC,KAAc;IAC1C,OAAO,IAAA,mCAA4B,EAAC,gBAAgB,CAAC,CAAA;AACvD,CAAC;AAED;;;;GAIG;AACH,SAAgB,SAAS,CAAC,KAAc;IACtC,OAAO,IAAA,mCAA4B,EAAC,YAAY,CAAC,CAAA;AACnD,CAAC;AAED;;;;;GAKG;AACH,SAAgB,QAAQ,CAAC,MAAc;IACrC,OAAO,IAAA,gCAAyB,EAAC,UAAU,CAAC,CAAA;AAC9C,CAAC"}

package/dist/decorators/response.d.ts

@@ -1,17 +1,32 @@
 import { IsValidHeader } from '../utils/isHeaderType';
 import { HttpStatusCodeLiteral, HttpStatusCodeStringLiteral, OtherValidOpenApiHttpStatusCode } from '../interfaces/response';
+/**
+ * Declares the successful response status, description, and media types for an operation.
+ *
+ * @param _name The HTTP status code returned when the operation succeeds.
+ * @param _description The response description shown in the generated OpenAPI document.
+ * @param _produces The response media type or media types.
+ */
 export declare function SuccessResponse<HeaderType extends IsValidHeader<HeaderType> = object>(_name: string | number, _description?: string, _produces?: string | string[]): MethodDecorator;
+/**
+ * Adds a documented response that can be attached to a method or a controller.
+ *
+ * @param _name The HTTP status code, OpenAPI response range, or `default`.
+ * @param _description The response description shown in the generated OpenAPI document.
+ * @param _example An example payload for the response schema.
+ * @param _produces The response media type or media types.
+ */
 export declare function Response<ExampleType, HeaderType extends IsValidHeader<HeaderType> = object>(_name: HttpStatusCodeLiteral | HttpStatusCodeStringLiteral | OtherValidOpenApiHttpStatusCode, _description?: string, _example?: ExampleType, _produces?: string | string[]): MethodDecorator & ClassDecorator;
 /**
  * Inject a library-agnostic responder function that can be used to construct type-checked (usually error-) responses.
  *
- * The type of the responder function should be annotated `TsoaResponse<Status, Data, Headers>` in order to support OpenAPI documentation.
+ * Annotate the parameter as `TsoaResponse<Status, Data, Headers>` so tsoa can infer the documented response.
  */
 export declare function Res(): ParameterDecorator;
 /**
- * Overrides the default media type of response.
- * Can be used on controller level or only for specific method
+ * Overrides the response media type on a controller or a single action.
  *
+ * @param _value The response media type, for example `application/json`.
  * @link https://swagger.io/docs/specification/media-types/
  */
 export declare function Produces(_value: string): MethodDecorator & ClassDecorator;

package/dist/decorators/response.js

@@ -5,24 +5,39 @@ exports.Response = Response;
 exports.Res = Res;
 exports.Produces = Produces;
 const noop_1 = require("./noop");
+/**
+ * Declares the successful response status, description, and media types for an operation.
+ *
+ * @param _name The HTTP status code returned when the operation succeeds.
+ * @param _description The response description shown in the generated OpenAPI document.
+ * @param _produces The response media type or media types.
+ */
 function SuccessResponse(_name, _description, _produces) {
     return (0, noop_1.createNoopMethodDecorator)('success-response');
 }
+/**
+ * Adds a documented response that can be attached to a method or a controller.
+ *
+ * @param _name The HTTP status code, OpenAPI response range, or `default`.
+ * @param _description The response description shown in the generated OpenAPI document.
+ * @param _example An example payload for the response schema.
+ * @param _produces The response media type or media types.
+ */
 function Response(_name, _description, _example, _produces) {
     return (0, noop_1.createNoopClassMethodDecorator)('response');
 }
 /**
  * Inject a library-agnostic responder function that can be used to construct type-checked (usually error-) responses.
  *
- * The type of the responder function should be annotated `TsoaResponse<Status, Data, Headers>` in order to support OpenAPI documentation.
+ * Annotate the parameter as `TsoaResponse<Status, Data, Headers>` so tsoa can infer the documented response.
  */
 function Res() {
     return (0, noop_1.createNoopParameterDecorator)('res');
 }
 /**
- * Overrides the default media type of response.
- * Can be used on controller level or only for specific method
+ * Overrides the response media type on a controller or a single action.
  *
+ * @param _value The response media type, for example `application/json`.
  * @link https://swagger.io/docs/specification/media-types/
  */
 function Produces(_value) {

package/dist/decorators/response.js.map

@@ -1 +1 @@
-{"version":3,"file":"response.js","sourceRoot":"","sources":["../../src/decorators/response.ts"],"names":[],"mappings":";;AAIA,0CAEC;AAED,4BAOC;AAOD,kBAEC;AAQD,4BAEC;AAhCD,iCAAgH;AAEhH,SAAgB,eAAe,CAAwD,KAAsB,EAAE,YAAqB,EAAE,SAA6B;IACjK,OAAO,IAAA,gCAAyB,EAAC,kBAAkB,CAAC,CAAA;AACtD,CAAC;AAED,SAAgB,QAAQ,CACtB,KAA4F,EAC5F,YAAqB,EACrB,QAAsB,EACtB,SAA6B;IAE7B,OAAO,IAAA,qCAA8B,EAAC,UAAU,CAAC,CAAA;AACnD,CAAC;AAED;;;;GAIG;AACH,SAAgB,GAAG;IACjB,OAAO,IAAA,mCAA4B,EAAC,KAAK,CAAC,CAAA;AAC5C,CAAC;AAED;;;;;GAKG;AACH,SAAgB,QAAQ,CAAC,MAAc;IACrC,OAAO,IAAA,qCAA8B,EAAC,UAAU,CAAC,CAAA;AACnD,CAAC"}
+{"version":3,"file":"response.js","sourceRoot":"","sources":["../../src/decorators/response.ts"],"names":[],"mappings":";;AAWA,0CAEC;AAUD,4BAOC;AAOD,kBAEC;AAQD,4BAEC;AA/CD,iCAAgH;AAEhH;;;;;;GAMG;AACH,SAAgB,eAAe,CAAwD,KAAsB,EAAE,YAAqB,EAAE,SAA6B;IACjK,OAAO,IAAA,gCAAyB,EAAC,kBAAkB,CAAC,CAAA;AACtD,CAAC;AAED;;;;;;;GAOG;AACH,SAAgB,QAAQ,CACtB,KAA4F,EAC5F,YAAqB,EACrB,QAAsB,EACtB,SAA6B;IAE7B,OAAO,IAAA,qCAA8B,EAAC,UAAU,CAAC,CAAA;AACnD,CAAC;AAED;;;;GAIG;AACH,SAAgB,GAAG;IACjB,OAAO,IAAA,mCAA4B,EAAC,KAAK,CAAC,CAAA;AAC5C,CAAC;AAED;;;;;GAKG;AACH,SAAgB,QAAQ,CAAC,MAAc;IACrC,OAAO,IAAA,qCAA8B,EAAC,UAAU,CAAC,CAAA;AACnD,CAAC"}

package/dist/decorators/route.d.ts

@@ -1,5 +1,10 @@
+/**
+ * Declares the base route path for a controller.
+ *
+ * @param _name The controller path segment relative to the configured API base path.
+ */
 export declare function Route(_name?: string): ClassDecorator;
 /**
- * can be used to entirely hide an method from documentation
+ * Hides a controller, action, or parameter from generated OpenAPI metadata.
  */
 export declare function Hidden(): ClassDecorator & MethodDecorator & ParameterDecorator;

package/dist/decorators/route.js

@@ -3,11 +3,16 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Route = Route;
 exports.Hidden = Hidden;
 const noop_1 = require("./noop");
+/**
+ * Declares the base route path for a controller.
+ *
+ * @param _name The controller path segment relative to the configured API base path.
+ */
 function Route(_name) {
     return (0, noop_1.createNoopClassDecorator)('route');
 }
 /**
- * can be used to entirely hide an method from documentation
+ * Hides a controller, action, or parameter from generated OpenAPI metadata.
  */
 function Hidden() {
     return (0, noop_1.createNoopHiddenDecorator)('hidden');

package/dist/decorators/route.js.map

@@ -1 +1 @@
-{"version":3,"file":"route.js","sourceRoot":"","sources":["../../src/decorators/route.ts"],"names":[],"mappings":";;AAEA,sBAEC;AAKD,wBAEC;AAXD,iCAA4E;AAE5E,SAAgB,KAAK,CAAC,KAAc;IAClC,OAAO,IAAA,+BAAwB,EAAC,OAAO,CAAC,CAAA;AAC1C,CAAC;AAED;;GAEG;AACH,SAAgB,MAAM;IACpB,OAAO,IAAA,gCAAyB,EAAC,QAAQ,CAAC,CAAA;AAC5C,CAAC"}
+{"version":3,"file":"route.js","sourceRoot":"","sources":["../../src/decorators/route.ts"],"names":[],"mappings":";;AAOA,sBAEC;AAKD,wBAEC;AAhBD,iCAA4E;AAE5E;;;;GAIG;AACH,SAAgB,KAAK,CAAC,KAAc;IAClC,OAAO,IAAA,+BAAwB,EAAC,OAAO,CAAC,CAAA;AAC1C,CAAC;AAED;;GAEG;AACH,SAAgB,MAAM;IACpB,OAAO,IAAA,gCAAyB,EAAC,QAAQ,CAAC,CAAA;AAC5C,CAAC"}

package/dist/decorators/security.d.ts

@@ -1,9 +1,12 @@
 /**
- * Can be used to indicate that a method requires no security.
+ * Clears inherited security requirements for a controller or action.
  */
 export declare function NoSecurity(): ClassDecorator & MethodDecorator;
 /**
- * @param {name} security name from securityDefinitions
+ * Declares the security requirement for a controller or action.
+ *
+ * @param _name The security scheme name, or a full security requirement object.
+ * @param _scopes OAuth scopes required by the scheme when `_name` is a string.
  */
 export declare function Security(_name: string | {
     [name: string]: string[];

package/dist/decorators/security.js

@@ -4,13 +4,16 @@ exports.NoSecurity = NoSecurity;
 exports.Security = Security;
 const noop_1 = require("./noop");
 /**
- * Can be used to indicate that a method requires no security.
+ * Clears inherited security requirements for a controller or action.
  */
 function NoSecurity() {
     return (0, noop_1.createNoopClassMethodDecorator)('no-security');
 }
 /**
- * @param {name} security name from securityDefinitions
+ * Declares the security requirement for a controller or action.
+ *
+ * @param _name The security scheme name, or a full security requirement object.
+ * @param _scopes OAuth scopes required by the scheme when `_name` is a string.
  */
 function Security(_name, _scopes) {
     return (0, noop_1.createNoopClassMethodDecorator)('security');

package/dist/decorators/security.js.map

@@ -1 +1 @@
-{"version":3,"file":"security.js","sourceRoot":"","sources":["../../src/decorators/security.ts"],"names":[],"mappings":";;AAKA,gCAEC;AAKD,4BAEC;AAdD,iCAAuD;AAEvD;;GAEG;AACH,SAAgB,UAAU;IACxB,OAAO,IAAA,qCAA8B,EAAC,aAAa,CAAC,CAAA;AACtD,CAAC;AAED;;GAEG;AACH,SAAgB,QAAQ,CAAC,KAA4C,EAAE,OAAkB;IACvF,OAAO,IAAA,qCAA8B,EAAC,UAAU,CAAC,CAAA;AACnD,CAAC"}
+{"version":3,"file":"security.js","sourceRoot":"","sources":["../../src/decorators/security.ts"],"names":[],"mappings":";;AAKA,gCAEC;AAQD,4BAEC;AAjBD,iCAAuD;AAEvD;;GAEG;AACH,SAAgB,UAAU;IACxB,OAAO,IAAA,qCAA8B,EAAC,aAAa,CAAC,CAAA;AACtD,CAAC;AAED;;;;;GAKG;AACH,SAAgB,QAAQ,CAAC,KAA4C,EAAE,OAAkB;IACvF,OAAO,IAAA,qCAA8B,EAAC,UAAU,CAAC,CAAA;AACnD,CAAC"}

package/dist/decorators/specPath.d.ts

@@ -1,13 +1,19 @@
 import { Readable } from 'node:stream';
 import { Swagger } from '../swagger/swagger';
+/** Supported runtimes for built-in {@link SpecPath} targets. */
 export type SpecRuntime = 'express' | 'koa' | 'hapi';
+/** Built-in documentation targets supported by {@link SpecPath}. */
 export type BuiltinSpecPathTarget = 'json' | 'yaml' | 'swagger' | 'redoc' | 'rapidoc';
+/** Serialized OpenAPI formats that can be requested from a {@link SpecGenerator}. */
 export type SpecDocumentFormat = 'json' | 'yaml';
+/** Response body types accepted from built-in and custom {@link SpecPath} handlers. */
 export type SpecResponseValue = string | Readable;
+/** Describes the runtime contract needed to rebuild an OpenAPI document on demand. */
 export interface SpecGenerator {
     getSpecObject(): Promise<Swagger.Spec>;
     getSpecString(format: SpecDocumentFormat): Promise<string>;
 }
+/** Context passed to spec-response caches. */
 export interface SpecCacheContext {
     cacheKey: string;
     controllerClass: object;
@@ -17,27 +23,42 @@ export interface SpecCacheContext {
     target: BuiltinSpecPathTarget | 'custom';
     format?: SpecDocumentFormat | 'html';
 }
+/** Request-scoped context passed to custom {@link SpecPath} handlers. */
 export interface SpecRequestContext extends SpecCacheContext {
     request?: unknown;
     response?: unknown;
     getSpecObject(): Promise<Swagger.Spec>;
     getSpecString(format: SpecDocumentFormat): Promise<string>;
 }
+/** Custom handler used by {@link SpecPath} to serve spec content. */
 export type SpecResponseHandler = (context: SpecRequestContext) => SpecResponseValue | Promise<SpecResponseValue>;
+/** Cache adapter used by {@link SpecPath} to memoize generated responses. */
 export interface SpecCacheHandler {
     get(context: SpecCacheContext): SpecResponseValue | Promise<SpecResponseValue | undefined> | undefined;
     set(context: SpecCacheContext, value: string): void | Promise<void>;
 }
+/** Route target supported by {@link SpecPath}. */
 export type SpecPathTarget = BuiltinSpecPathTarget | SpecResponseHandler;
+/** Cache strategy supported by {@link SpecPath}. */
 export type SpecPathCache = 'none' | 'memory' | SpecCacheHandler;
+/** Stored definition for a single declared {@link SpecPath}. */
 export interface SpecPathDefinition {
     path: string;
     normalizedPath: string;
     target: SpecPathTarget;
     cache: SpecPathCache;
 }
+/**
+ * Registers a controller-local route that serves the generated OpenAPI document or a custom derived response.
+ *
+ * @param path The relative route path. Defaults to `spec`.
+ * @param target The built-in documentation target or a custom response handler.
+ * @param cache Cache strategy for generated responses. Defaults to in-memory caching.
+ */
 export declare function SpecPath(path?: string, target?: SpecPathTarget, cache?: SpecPathCache): ClassDecorator;
+/** Returns the spec-path definitions declared on a controller. */
 export declare function fetchSpecPaths(target: object): readonly SpecPathDefinition[];
+/** Produces a human-readable summary of a spec-path definition for logging and diagnostics. */
 export declare function describeSpecPath(specPath: SpecPathDefinition): {
     cache: string;
     path: string;

package/dist/decorators/specPath.js

@@ -29,6 +29,13 @@ function defineSpecPaths(target, specPaths) {
 function normalizeSpecPath(path) {
     return (0, pathUtils_1.normalisePath)(path ?? 'spec', '/');
 }
+/**
+ * Registers a controller-local route that serves the generated OpenAPI document or a custom derived response.
+ *
+ * @param path The relative route path. Defaults to `spec`.
+ * @param target The built-in documentation target or a custom response handler.
+ * @param cache Cache strategy for generated responses. Defaults to in-memory caching.
+ */
 function SpecPath(path = 'spec', target = 'json', cache = 'memory') {
     return classTarget => {
         const normalizedPath = normalizeSpecPath(path);
@@ -46,9 +53,11 @@ function SpecPath(path = 'spec', target = 'json', cache = 'memory') {
         defineSpecPaths(classTarget, existing);
     };
 }
+/** Returns the spec-path definitions declared on a controller. */
 function fetchSpecPaths(target) {
     return getExistingSpecPaths(target);
 }
+/** Produces a human-readable summary of a spec-path definition for logging and diagnostics. */
 function describeSpecPath(specPath) {
     return {
         cache: getCacheDescription(specPath.cache),

package/dist/decorators/specPath.js.map

@@ -1 +1 @@
-{"version":3,"file":"specPath.js","sourceRoot":"","sources":["../../src/decorators/specPath.ts"],"names":[],"mappings":";;AAgFA,4BAmBC;AAED,wCAEC;AAED,4CAMC;AA7GD,kDAAkD;AA8ClD,MAAM,iBAAiB,GAAG,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAA;AAE7D,SAAS,mBAAmB,CAAC,MAAsB;IACjD,OAAO,OAAO,MAAM,KAAK,QAAQ,CAAA;AACnC,CAAC;AAED,SAAS,oBAAoB,CAAC,MAAsB;IAClD,OAAO,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,gBAAgB,CAAA;AAChE,CAAC;AAED,SAAS,mBAAmB,CAAC,KAAoB;IAC/C,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,cAAc,CAAA;AAC3D,CAAC;AAED,SAAS,oBAAoB,CAAC,MAAc;IAC1C,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,iBAAiB,CAAqC,CAAA;IAC3F,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;AACtC,CAAC;AAED,SAAS,eAAe,CAAC,MAAc,EAAE,SAA+B;IACtE,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,iBAAiB,EAAE;QAChD,YAAY,EAAE,IAAI;QAClB,UAAU,EAAE,KAAK;QACjB,KAAK,EAAE,SAAS;QAChB,QAAQ,EAAE,IAAI;KACf,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,iBAAiB,CAAC,IAAwB;IACjD,OAAO,IAAA,yBAAa,EAAC,IAAI,IAAI,MAAM,EAAE,GAAG,CAAC,CAAA;AAC3C,CAAC;AAED,SAAgB,QAAQ,CAAC,IAAI,GAAG,MAAM,EAAE,SAAyB,MAAM,EAAE,QAAuB,QAAQ;IACtG,OAAO,WAAW,CAAC,EAAE;QACnB,MAAM,cAAc,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAA;QAC9C,MAAM,QAAQ,GAAG,oBAAoB,CAAC,WAAW,CAAC,CAAA;QAElD,IAAI,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,cAAc,KAAK,cAAc,CAAC,EAAE,CAAC;YAC1E,MAAM,SAAS,GAAG,OAAO,WAAW,KAAK,UAAU,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,sBAAsB,CAAA;YACnH,MAAM,IAAI,KAAK,CAAC,wBAAwB,IAAI,gBAAgB,SAAS,+DAA+D,CAAC,CAAA;QACvI,CAAC;QAED,QAAQ,CAAC,IAAI,CAAC;YACZ,KAAK;YACL,cAAc;YACd,IAAI;YACJ,MAAM;SACP,CAAC,CAAA;QAEF,eAAe,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAA;IACxC,CAAC,CAAA;AACH,CAAC;AAED,SAAgB,cAAc,CAAC,MAAc;IAC3C,OAAO,oBAAoB,CAAC,MAAM,CAAC,CAAA;AACrC,CAAC;AAED,SAAgB,gBAAgB,CAAC,QAA4B;IAC3D,OAAO;QACL,KAAK,EAAE,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAC;QAC1C,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,MAAM,EAAE,oBAAoB,CAAC,QAAQ,CAAC,MAAM,CAAC;KAC9C,CAAA;AACH,CAAC"}
+{"version":3,"file":"specPath.js","sourceRoot":"","sources":["../../src/decorators/specPath.ts"],"names":[],"mappings":";;AAmGA,4BAmBC;AAGD,wCAEC;AAGD,4CAMC;AAlID,kDAAkD;AA0DlD,MAAM,iBAAiB,GAAG,MAAM,CAAC,GAAG,CAAC,uBAAuB,CAAC,CAAA;AAE7D,SAAS,mBAAmB,CAAC,MAAsB;IACjD,OAAO,OAAO,MAAM,KAAK,QAAQ,CAAA;AACnC,CAAC;AAED,SAAS,oBAAoB,CAAC,MAAsB;IAClD,OAAO,mBAAmB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,gBAAgB,CAAA;AAChE,CAAC;AAED,SAAS,mBAAmB,CAAC,KAAoB;IAC/C,OAAO,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,cAAc,CAAA;AAC3D,CAAC;AAED,SAAS,oBAAoB,CAAC,MAAc;IAC1C,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,MAAM,EAAE,iBAAiB,CAAqC,CAAA;IAC3F,OAAO,QAAQ,CAAC,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;AACtC,CAAC;AAED,SAAS,eAAe,CAAC,MAAc,EAAE,SAA+B;IACtE,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,iBAAiB,EAAE;QAChD,YAAY,EAAE,IAAI;QAClB,UAAU,EAAE,KAAK;QACjB,KAAK,EAAE,SAAS;QAChB,QAAQ,EAAE,IAAI;KACf,CAAC,CAAA;AACJ,CAAC;AAED,SAAS,iBAAiB,CAAC,IAAwB;IACjD,OAAO,IAAA,yBAAa,EAAC,IAAI,IAAI,MAAM,EAAE,GAAG,CAAC,CAAA;AAC3C,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,QAAQ,CAAC,IAAI,GAAG,MAAM,EAAE,SAAyB,MAAM,EAAE,QAAuB,QAAQ;IACtG,OAAO,WAAW,CAAC,EAAE;QACnB,MAAM,cAAc,GAAG,iBAAiB,CAAC,IAAI,CAAC,CAAA;QAC9C,MAAM,QAAQ,GAAG,oBAAoB,CAAC,WAAW,CAAC,CAAA;QAElD,IAAI,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,CAAC,cAAc,KAAK,cAAc,CAAC,EAAE,CAAC;YAC1E,MAAM,SAAS,GAAG,OAAO,WAAW,KAAK,UAAU,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC,sBAAsB,CAAA;YACnH,MAAM,IAAI,KAAK,CAAC,wBAAwB,IAAI,gBAAgB,SAAS,+DAA+D,CAAC,CAAA;QACvI,CAAC;QAED,QAAQ,CAAC,IAAI,CAAC;YACZ,KAAK;YACL,cAAc;YACd,IAAI;YACJ,MAAM;SACP,CAAC,CAAA;QAEF,eAAe,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAA;IACxC,CAAC,CAAA;AACH,CAAC;AAED,kEAAkE;AAClE,SAAgB,cAAc,CAAC,MAAc;IAC3C,OAAO,oBAAoB,CAAC,MAAM,CAAC,CAAA;AACrC,CAAC;AAED,+FAA+F;AAC/F,SAAgB,gBAAgB,CAAC,QAA4B;IAC3D,OAAO;QACL,KAAK,EAAE,mBAAmB,CAAC,QAAQ,CAAC,KAAK,CAAC;QAC1C,IAAI,EAAE,QAAQ,CAAC,IAAI;QACnB,MAAM,EAAE,oBAAoB,CAAC,QAAQ,CAAC,MAAM,CAAC;KAC9C,CAAA;AACH,CAAC"}

package/dist/decorators/tags.d.ts

@@ -1 +1,6 @@
+/**
+ * Adds OpenAPI tags to a controller or action.
+ *
+ * @param _values One or more tag names to attach.
+ */
 export declare function Tags(..._values: string[]): ClassDecorator & MethodDecorator;

package/dist/decorators/tags.js

@@ -1,6 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Tags = Tags;
+/**
+ * Adds OpenAPI tags to a controller or action.
+ *
+ * @param _values One or more tag names to attach.
+ */
 function Tags(..._values) {
     return () => {
         return;

package/dist/decorators/tags.js.map

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

package/dist/decorators/validate.d.ts

@@ -5,5 +5,10 @@ type ValidateDecoratorConfig = {
 };
 type DecoratorPropertyKey = string | symbol | undefined;
 export declare function getParameterExternalValidatorMetadata(target: object, propertyKey: DecoratorPropertyKey, parameterIndex: number): ValidateDecoratorConfig | undefined;
+/**
+ * Attaches external-schema validation metadata to a controller parameter.
+ *
+ * Supported forms are `@Validate(schema)`, `@Validate(kind, schema)`, and `@Validate({ kind, schema })`.
+ */
 export declare function Validate(...args: unknown[]): ParameterDecorator;
 export {};

package/dist/decorators/validate.js

@@ -98,6 +98,11 @@ function getParameterExternalValidatorMetadata(target, propertyKey, parameterInd
     }
     return undefined;
 }
+/**
+ * Attaches external-schema validation metadata to a controller parameter.
+ *
+ * Supported forms are `@Validate(schema)`, `@Validate(kind, schema)`, and `@Validate({ kind, schema })`.
+ */
 function Validate(...args) {
     const normalized = normalizeValidateDecoratorArgs(args);
     return (target, propertyKey, parameterIndex) => {

package/dist/decorators/validate.js.map

@@ -1 +1 @@
-{"version":3,"file":"validate.js","sourceRoot":"","sources":["../../src/decorators/validate.ts"],"names":[],"mappings":";;AAsHA,sFAeC;AAED,4BAWC;AAhJD,MAAM,qBAAqB,GAAG,MAAM,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAA;AACvE,MAAM,oBAAoB,GAAG,iBAAiB,CAAA;AAW9C,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC1C,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,MAAM,SAAS,GAAG,MAAiC,CAAA;IAEnD,IAAI,OAAO,SAAS,CAAC,SAAS,KAAK,UAAU,EAAE,CAAC;QAC9C,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,OAAO,SAAS,CAAC,MAAM,KAAK,UAAU,IAAI,OAAO,SAAS,CAAC,MAAM,KAAK,UAAU,IAAI,OAAO,SAAS,CAAC,EAAE,KAAK,UAAU,EAAE,CAAC;QAC3H,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,IAAI,OAAO,SAAS,CAAC,YAAY,KAAK,UAAU,IAAI,OAAO,SAAS,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;QAC7F,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,SAAS,CAAC,KAAK,KAAK,IAAI,IAAI,CAAC,OAAO,SAAS,CAAC,QAAQ,KAAK,UAAU,IAAI,SAAS,CAAC,OAAO,IAAI,OAAO,SAAS,CAAC,IAAI,KAAK,QAAQ,CAAC,EAAE,CAAC;QACtI,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,OAAO,SAAS,CAAC,SAAS,KAAK,UAAU,IAAI,OAAO,SAAS,CAAC,OAAO,KAAK,UAAU,IAAI,OAAO,SAAS,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC/H,OAAO,aAAa,CAAA;IACtB,CAAC;IAED,OAAO,SAAS,CAAA;AAClB,CAAC;AAED,SAAS,wBAAwB,CAAC,KAAc;IAC9C,OAAO,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,IAAI,KAAK,IAAI,QAAQ,IAAI,KAAK,CAAA;AACrF,CAAC;AAED,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,IAAI,SAAS,CAAC,oCAAoC,CAAC,CAAA;IAC3D,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAED,SAAS,mCAAmC,CAAC,KAAc;IACzD,IAAI,wBAAwB,CAAC,KAAK,CAAC,EAAE,CAAC;QACpC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,KAAK,CAAA;QAC9B,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,SAAS,CAAC,kDAAkD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACzF,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAA;IACrD,CAAC;IAED,IAAI,uBAAuB,CAAC,KAAK,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,SAAS,CAAC,cAAc,KAAK,qCAAqC,CAAC,CAAA;IAC/E,CAAC;IAED,MAAM,YAAY,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAA;IAC9C,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,MAAM,IAAI,SAAS,CAAC,4FAA4F,CAAC,CAAA;IACnH,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,CAAA;AAC9C,CAAC;AAED,SAAS,0BAA0B,CAAC,IAAa,EAAE,MAAe;IAChE,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,SAAS,CAAC,kDAAkD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACzF,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAA;AACrD,CAAC;AAED,SAAS,8BAA8B,CAAC,IAAe;IACrD,QAAQ,IAAI,CAAC,MAAM,EAAE,CAAC;QACpB,KAAK,CAAC;YACJ,MAAM,IAAI,SAAS,CAAC,uCAAuC,CAAC,CAAA;QAC9D,KAAK,CAAC;YACJ,OAAO,mCAAmC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;QACrD,KAAK,CAAC;YACJ,OAAO,0BAA0B,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;QACrD;YACE,MAAM,IAAI,SAAS,CAAC,yEAAyE,CAAC,CAAA;IAClG,CAAC;AACH,CAAC;AAED,SAAS,uBAAuB,CAAC,KAAc;IAC7C,OAAO,KAAK,KAAK,KAAK,IAAI,KAAK,KAAK,KAAK,IAAI,KAAK,KAAK,KAAK,IAAI,KAAK,KAAK,aAAa,IAAI,KAAK,KAAK,OAAO,CAAA;AAC9G,CAAC;AAED,SAAS,cAAc,CAAC,WAAiC;IACvD,OAAO,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;AAC/E,CAAC;AAED,SAAS,wBAAwB,CAAC,MAAc;IAC9C,MAAM,QAAQ,GAAG,OAAO,CAAC,cAAc,CAAC,qBAAqB,EAAE,MAAM,CAAsC,CAAA;IAC3G,IAAI,QAAQ,EAAE,CAAC;QACb,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED,MAAM,OAAO,GAA0B,EAAE,CAAA;IACzC,OAAO,CAAC,cAAc,CAAC,qBAAqB,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;IAC9D,OAAO,OAAO,CAAA;AAChB,CAAC;AAED,SAAgB,qCAAqC,CAAC,MAAc,EAAE,WAAiC,EAAE,cAAsB;IAC7H,MAAM,SAAS,GAAG,cAAc,CAAC,WAAW,CAAC,CAAA;IAC7C,IAAI,aAAa,GAAkB,MAAM,CAAA;IAEzC,OAAO,aAAa,EAAE,CAAC;QACrB,MAAM,KAAK,GAAG,OAAO,CAAC,cAAc,CAAC,qBAAqB,EAAE,aAAa,CAAsC,CAAA;QAC/G,MAAM,iBAAiB,GAAG,KAAK,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,cAAc,CAAC,CAAA;QAC9D,IAAI,iBAAiB,EAAE,CAAC;YACtB,OAAO,iBAAiB,CAAA;QAC1B,CAAC;QAED,aAAa,GAAG,MAAM,CAAC,cAAc,CAAC,aAAa,CAAkB,CAAA;IACvE,CAAC;IAED,OAAO,SAAS,CAAA;AAClB,CAAC;AAED,SAAgB,QAAQ,CAAC,GAAG,IAAe;IACzC,MAAM,UAAU,GAAG,8BAA8B,CAAC,IAAI,CAAC,CAAA;IAEvD,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE,EAAE;QAC7C,MAAM,KAAK,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAAA;QAC9C,MAAM,SAAS,GAAG,cAAc,CAAC,WAAW,CAAC,CAAA;QAC7C,MAAM,aAAa,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,CAAA;QAC5C,aAAa,CAAC,cAAc,CAAC,GAAG,UAAU,CAAA;QAC1C,KAAK,CAAC,SAAS,CAAC,GAAG,aAAa,CAAA;QAChC,OAAO,CAAC,cAAc,CAAC,qBAAqB,EAAE,KAAK,EAAE,MAAM,CAAC,CAAA;IAC9D,CAAC,CAAA;AACH,CAAC"}
+{"version":3,"file":"validate.js","sourceRoot":"","sources":["../../src/decorators/validate.ts"],"names":[],"mappings":";;AAsHA,sFAeC;AAOD,4BAWC;AArJD,MAAM,qBAAqB,GAAG,MAAM,CAAC,GAAG,CAAC,6BAA6B,CAAC,CAAA;AACvE,MAAM,oBAAoB,GAAG,iBAAiB,CAAA;AAW9C,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,CAAC,MAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC1C,OAAO,SAAS,CAAA;IAClB,CAAC;IAED,MAAM,SAAS,GAAG,MAAiC,CAAA;IAEnD,IAAI,OAAO,SAAS,CAAC,SAAS,KAAK,UAAU,EAAE,CAAC;QAC9C,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,OAAO,SAAS,CAAC,MAAM,KAAK,UAAU,IAAI,OAAO,SAAS,CAAC,MAAM,KAAK,UAAU,IAAI,OAAO,SAAS,CAAC,EAAE,KAAK,UAAU,EAAE,CAAC;QAC3H,OAAO,OAAO,CAAA;IAChB,CAAC;IAED,IAAI,OAAO,SAAS,CAAC,YAAY,KAAK,UAAU,IAAI,OAAO,SAAS,CAAC,QAAQ,KAAK,UAAU,EAAE,CAAC;QAC7F,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,SAAS,CAAC,KAAK,KAAK,IAAI,IAAI,CAAC,OAAO,SAAS,CAAC,QAAQ,KAAK,UAAU,IAAI,SAAS,CAAC,OAAO,IAAI,OAAO,SAAS,CAAC,IAAI,KAAK,QAAQ,CAAC,EAAE,CAAC;QACtI,OAAO,KAAK,CAAA;IACd,CAAC;IAED,IAAI,OAAO,SAAS,CAAC,SAAS,KAAK,UAAU,IAAI,OAAO,SAAS,CAAC,OAAO,KAAK,UAAU,IAAI,OAAO,SAAS,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;QAC/H,OAAO,aAAa,CAAA;IACtB,CAAC;IAED,OAAO,SAAS,CAAA;AAClB,CAAC;AAED,SAAS,wBAAwB,CAAC,KAAc;IAC9C,OAAO,CAAC,CAAC,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,MAAM,IAAI,KAAK,IAAI,QAAQ,IAAI,KAAK,CAAA;AACrF,CAAC;AAED,SAAS,kBAAkB,CAAC,MAAe;IACzC,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QACzB,MAAM,IAAI,SAAS,CAAC,oCAAoC,CAAC,CAAA;IAC3D,CAAC;IAED,OAAO,MAAM,CAAA;AACf,CAAC;AAED,SAAS,mCAAmC,CAAC,KAAc;IACzD,IAAI,wBAAwB,CAAC,KAAK,CAAC,EAAE,CAAC;QACpC,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,KAAK,CAAA;QAC9B,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,EAAE,CAAC;YACnC,MAAM,IAAI,SAAS,CAAC,kDAAkD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QACzF,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAA;IACrD,CAAC;IAED,IAAI,uBAAuB,CAAC,KAAK,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,SAAS,CAAC,cAAc,KAAK,qCAAqC,CAAC,CAAA;IAC/E,CAAC;IAED,MAAM,YAAY,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAA;IAC9C,IAAI,CAAC,YAAY,EAAE,CAAC;QAClB,MAAM,IAAI,SAAS,CAAC,4FAA4F,CAAC,CAAA;IACnH,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,YAAY,EAAE,MAAM,EAAE,KAAK,EAAE,CAAA;AAC9C,CAAC;AAED,SAAS,0BAA0B,CAAC,IAAa,EAAE,MAAe;IAChE,IAAI,CAAC,uBAAuB,CAAC,IAAI,CAAC,EAAE,CAAC;QACnC,MAAM,IAAI,SAAS,CAAC,kDAAkD,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IACzF,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,MAAM,EAAE,kBAAkB,CAAC,MAAM,CAAC,EAAE,CAAA;AACrD,CAAC;AAED,SAAS,8BAA8B,CAAC,IAAe;IACrD,QAAQ,IAAI,CAAC,MAAM,EAAE,CAAC;QACpB,KAAK,CAAC;YACJ,MAAM,IAAI,SAAS,CAAC,uCAAuC,CAAC,CAAA;QAC9D,KAAK,CAAC;YACJ,OAAO,mCAAmC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;QACrD,KAAK,CAAC;YACJ,OAAO,0BAA0B,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAA;QACrD;YACE,MAAM,IAAI,SAAS,CAAC,yEAAyE,CAAC,CAAA;IAClG,CAAC;AACH,CAAC;AAED,SAAS,uBAAuB,CAAC,KAAc;IAC7C,OAAO,KAAK,KAAK,KAAK,IAAI,KAAK,KAAK,KAAK,IAAI,KAAK,KAAK,KAAK,IAAI,KAAK,KAAK,aAAa,IAAI,KAAK,KAAK,OAAO,CAAA;AAC9G,CAAC;AAED,SAAS,cAAc,CAAC,WAAiC;IACvD,OAAO,WAAW,KAAK,SAAS,CAAC,CAAC,CAAC,oBAAoB,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAA;AAC/E,CAAC;AAED,SAAS,wBAAwB,CAAC,MAAc;IAC9C,MAAM,QAAQ,GAAG,OAAO,CAAC,cAAc,CAAC,qBAAqB,EAAE,MAAM,CAAsC,CAAA;IAC3G,IAAI,QAAQ,EAAE,CAAC;QACb,OAAO,QAAQ,CAAA;IACjB,CAAC;IAED,MAAM,OAAO,GAA0B,EAAE,CAAA;IACzC,OAAO,CAAC,cAAc,CAAC,qBAAqB,EAAE,OAAO,EAAE,MAAM,CAAC,CAAA;IAC9D,OAAO,OAAO,CAAA;AAChB,CAAC;AAED,SAAgB,qCAAqC,CAAC,MAAc,EAAE,WAAiC,EAAE,cAAsB;IAC7H,MAAM,SAAS,GAAG,cAAc,CAAC,WAAW,CAAC,CAAA;IAC7C,IAAI,aAAa,GAAkB,MAAM,CAAA;IAEzC,OAAO,aAAa,EAAE,CAAC;QACrB,MAAM,KAAK,GAAG,OAAO,CAAC,cAAc,CAAC,qBAAqB,EAAE,aAAa,CAAsC,CAAA;QAC/G,MAAM,iBAAiB,GAAG,KAAK,EAAE,CAAC,SAAS,CAAC,EAAE,CAAC,cAAc,CAAC,CAAA;QAC9D,IAAI,iBAAiB,EAAE,CAAC;YACtB,OAAO,iBAAiB,CAAA;QAC1B,CAAC;QAED,aAAa,GAAG,MAAM,CAAC,cAAc,CAAC,aAAa,CAAkB,CAAA;IACvE,CAAC;IAED,OAAO,SAAS,CAAA;AAClB,CAAC;AAED;;;;GAIG;AACH,SAAgB,QAAQ,CAAC,GAAG,IAAe;IACzC,MAAM,UAAU,GAAG,8BAA8B,CAAC,IAAI,CAAC,CAAA;IAEvD,OAAO,CAAC,MAAM,EAAE,WAAW,EAAE,cAAc,EAAE,EAAE;QAC7C,MAAM,KAAK,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAAA;QAC9C,MAAM,SAAS,GAAG,cAAc,CAAC,WAAW,CAAC,CAAA;QAC7C,MAAM,aAAa,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,EAAE,CAAA;QAC5C,aAAa,CAAC,cAAc,CAAC,GAAG,UAAU,CAAA;QAC1C,KAAK,CAAC,SAAS,CAAC,GAAG,aAAa,CAAA;QAChC,OAAO,CAAC,cAAc,CAAC,qBAAqB,EAAE,KAAK,EAAE,MAAM,CAAC,CAAA;IAC9D,CAAC,CAAA;AACH,CAAC"}

package/dist/interfaces/controller.d.ts

@@ -1,14 +1,21 @@
 import type { OutgoingHttpHeaders } from 'node:http';
 type HeaderNames = keyof OutgoingHttpHeaders;
 type HeaderValue<H extends HeaderNames> = OutgoingHttpHeaders[H];
+/**
+ * Base controller class that lets actions override the eventual status code and headers.
+ */
 export declare class Controller {
     private statusCode?;
     private headers;
+    /** Sets the HTTP status code that the generated route handler should return. */
     setStatus(statusCode: number): void;
+    /** Returns the HTTP status code set through {@link setStatus}, if any. */
     getStatus(): number | undefined;
     setHeader<H extends HeaderNames>(name: H, value?: HeaderValue<H>): void;
     setHeader(name: string, value?: string | string[]): void;
+    /** Returns a previously assigned response header value. */
     getHeader(name: string): string | string[] | undefined;
+    /** Returns all response headers assigned on the controller instance. */
     getHeaders(): {
         [name: string]: string | string[] | undefined;
     };

package/dist/interfaces/controller.js

@@ -1,21 +1,29 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Controller = void 0;
+/**
+ * Base controller class that lets actions override the eventual status code and headers.
+ */
 class Controller {
     statusCode = undefined;
     headers = {};
+    /** Sets the HTTP status code that the generated route handler should return. */
     setStatus(statusCode) {
         this.statusCode = statusCode;
     }
+    /** Returns the HTTP status code set through {@link setStatus}, if any. */
     getStatus() {
         return this.statusCode;
     }
+    /** Stores a response header value that the generated route handler should emit. */
     setHeader(name, value) {
         this.headers[name] = value;
     }
+    /** Returns a previously assigned response header value. */
     getHeader(name) {
         return this.headers[name];
     }
+    /** Returns all response headers assigned on the controller instance. */
     getHeaders() {
         return this.headers;
     }

package/dist/interfaces/controller.js.map

@@ -1 +1 @@
-{"version":3,"file":"controller.js","sourceRoot":"","sources":["../../src/interfaces/controller.ts"],"names":[],"mappings":";;;AAKA,MAAa,UAAU;IACb,UAAU,GAAY,SAAS,CAAA;IAC/B,OAAO,GAAG,EAAuD,CAAA;IAElE,SAAS,CAAC,UAAkB;QACjC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;IAC9B,CAAC;IAEM,SAAS;QACd,OAAO,IAAI,CAAC,UAAU,CAAA;IACxB,CAAC;IAKM,SAAS,CAAC,IAAY,EAAE,KAAyB;QACtD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAA;IAC5B,CAAC;IAEM,SAAS,CAAC,IAAY;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IAC3B,CAAC;IAEM,UAAU;QACf,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;CACF;AA1BD,gCA0BC"}
+{"version":3,"file":"controller.js","sourceRoot":"","sources":["../../src/interfaces/controller.ts"],"names":[],"mappings":";;;AAKA;;GAEG;AACH,MAAa,UAAU;IACb,UAAU,GAAY,SAAS,CAAA;IAC/B,OAAO,GAAG,EAAuD,CAAA;IAEzE,gFAAgF;IACzE,SAAS,CAAC,UAAkB;QACjC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAA;IAC9B,CAAC;IAED,0EAA0E;IACnE,SAAS;QACd,OAAO,IAAI,CAAC,UAAU,CAAA;IACxB,CAAC;IAKD,mFAAmF;IAC5E,SAAS,CAAC,IAAY,EAAE,KAAyB;QACtD,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,KAAK,CAAA;IAC5B,CAAC;IAED,2DAA2D;IACpD,SAAS,CAAC,IAAY;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,CAAA;IAC3B,CAAC;IAED,wEAAwE;IACjE,UAAU;QACf,OAAO,IAAI,CAAC,OAAO,CAAA;IACrB,CAAC;CACF;AA/BD,gCA+BC"}

package/dist/interfaces/iocModule.d.ts

@@ -1,9 +1,13 @@
+/** Constructor type used for IoC container lookups. */
 export type Newable<T = unknown, TArgs extends unknown[] = unknown[]> = new (...args: TArgs) => T;
+/** Identifier types accepted by tsoa IoC container integrations. */
 export type ServiceIdentifier<T = unknown> = string | symbol | Newable<T> | Function;
+/** Minimal runtime container contract used to resolve controller instances. */
 export interface IocContainer {
     get<T>(controller: ServiceIdentifier<T>): T;
     get<T>(controller: ServiceIdentifier<T>): Promise<T>;
 }
+/** Factory signature used to build an {@link IocContainer} per incoming request. */
 export type IocContainerFactory<T = unknown> = {
     bivarianceHack(request: T): IocContainer;
 }['bivarianceHack'];

package/dist/interfaces/response.d.ts

@@ -1,5 +1,13 @@
 import { IsValidHeader } from '../utils/isHeaderType';
+/** Enumerates the concrete HTTP status codes accepted by tsoa response helpers. */
 export type HttpStatusCodeLiteral = 100 | 101 | 102 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 226 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 422 | 423 | 424 | 425 | 426 | 428 | 429 | 431 | 451 | 500 | 501 | 502 | 503 | 504 | 505 | 506 | 507 | 508 | 510 | 511;
+/** String form of the supported concrete HTTP status codes. */
 export type HttpStatusCodeStringLiteral = `${HttpStatusCodeLiteral}`;
+/** Additional OpenAPI response keys supported by {@link Response}. */
 export type OtherValidOpenApiHttpStatusCode = '1XX' | '2XX' | '3XX' | '4XX' | '5XX' | 'default';
+/**
+ * Responder function shape injected by {@link Res}.
+ *
+ * Call the function with a status code, payload, and optional headers to short-circuit the action and send a typed response.
+ */
 export type TsoaResponse<T extends HttpStatusCodeLiteral, BodyType, HeaderType extends IsValidHeader<HeaderType> = object, ReturnType = never> = (status: T, data: BodyType, headers?: HeaderType) => ReturnType;

package/dist/metadataGeneration/tsoa.d.ts

@@ -1,6 +1,7 @@
 import { ExtensionType } from '../decorators/extension';
 import type { Swagger } from '../swagger/swagger';
 import { Validator } from '..';
+/** Public metadata model produced by tsoa during controller and schema analysis. */
 export declare namespace Tsoa {
     export type ExternalValidatorKind = 'zod' | 'joi' | 'yup' | 'superstruct' | 'io-ts';
     export type ValidationStrategy = 'standard' | 'external';

package/dist/routeGeneration/additionalProps.d.ts

@@ -1,5 +1,6 @@
 import { Config, RoutesConfig } from '../config';
 import type { Tsoa } from '../metadataGeneration/tsoa';
+/** Runtime validation options passed into generated route template services. */
 export interface AdditionalProps {
     noImplicitAdditionalProperties: Exclude<Config['noImplicitAdditionalProperties'], undefined>;
     bodyCoercion: Exclude<RoutesConfig['bodyCoercion'], undefined>;

package/dist/routeGeneration/externalValidation.d.ts

@@ -1,4 +1,5 @@
 import type { Tsoa } from '../metadataGeneration/tsoa';
+/** Result returned by a runtime adapter for an external validation library. */
 export type RuntimeSchemaAdapterResult<T = unknown> = {
     ok: true;
     value: T;
@@ -6,8 +7,10 @@ export type RuntimeSchemaAdapterResult<T = unknown> = {
     ok: false;
     failure: Tsoa.ValidationFailure;
 };
+/** Adapter contract used to execute validation with external schema libraries at runtime. */
 export interface RuntimeSchemaAdapter {
     kind: Tsoa.ExternalValidatorKind;
     validate(value: unknown, schema: unknown, context: Tsoa.ValidationContext): RuntimeSchemaAdapterResult;
 }
+/** Validates a value with the runtime adapter for the selected external schema library. */
 export declare function validateExternalSchema(kind: Tsoa.ExternalValidatorKind, schema: unknown, value: unknown, context?: Tsoa.ValidationContext): RuntimeSchemaAdapterResult;

package/dist/routeGeneration/externalValidation.js

@@ -226,6 +226,7 @@ const adapterRegistry = {
     yup: yupAdapter,
     zod: zodAdapter,
 };
+/** Validates a value with the runtime adapter for the selected external schema library. */
 function validateExternalSchema(kind, schema, value, context = {}) {
     return adapterRegistry[kind].validate(value, schema, context);
 }