@venok/http 1.1.0 → 2.0.0

package/dist/index.d.ts

@@ -0,0 +1,2117 @@
+/**
+* Thanks for using Venloc Venok <3
+* https://github.com/venloc-tech/svm
+*/
+import * as _venok_core from '@venok/core';
+import { Type, VenokExceptionFilterContext, VenokContainer, ApplicationConfig, VenokParamsFactoryInterface, ScopeOptions, PipeTransform, ExceptionFilter, ArgumentsHost, VenokModule, ModulesContainer, CoreModule, DynamicModule } from '@venok/core';
+import * as _venok_integration from '@venok/integration';
+
+/**
+ * @publicApi
+ */
+interface MiddlewareConfigProxy {
+    /**
+     * Excludes routes from the currently processed middleware.
+     *
+     * @param {(string | RouteInfo)[]} routes
+     * @returns {MiddlewareConfigProxy}
+     */
+    exclude(...routes: (string | RouteInfo)[]): MiddlewareConfigProxy;
+    /**
+     * Attaches passed either routes or controllers to the currently configured middleware.
+     * If you pass a class, Venok would attach middleware to every path defined within this controller.
+     *
+     * @param {(string | Type | RouteInfo)[]} routes
+     * @returns {HttpMiddlewareConsumer}
+     */
+    to(...routes: (string | Type | RouteInfo)[]): HttpMiddlewareConsumer;
+}
+
+/**
+ * Interface defining method for applying user defined middleware to routes.
+ *
+ * @publicApi
+ */
+interface HttpMiddlewareConsumer {
+    /**
+     * @param {...(Type | Function)} middleware middleware class/function or array of classes/functions
+     * to be attached to the passed routes.
+     *
+     * @returns {MiddlewareConfigProxy}
+     */
+    apply(...middleware: (Type | Function)[]): MiddlewareConfigProxy;
+}
+
+declare enum HttpMethod {
+    GET = 0,
+    POST = 1,
+    PUT = 2,
+    DELETE = 3,
+    PATCH = 4,
+    ALL = 5,
+    OPTIONS = 6,
+    HEAD = 7,
+    SEARCH = 8
+}
+
+type RouteDefinition = {
+    paths: string[];
+    requestMethod: HttpMethod;
+    targetCallback: (...args: any[]) => void;
+    methodName: string;
+    version?: VersionValue;
+};
+
+interface ExcludeRouteMetadata {
+    /**
+     * Route path.
+     */
+    path: string;
+    /**
+     * Regular expression representing the route path.
+     */
+    pathRegex: RegExp;
+    /**
+     * HTTP request method (e.g., GET, POST).
+     */
+    requestMethod: HttpMethod;
+}
+
+interface RouteInfo {
+    path: string;
+    method: HttpMethod;
+    version?: VersionValue;
+}
+
+interface RoutePathMetadata {
+    /**
+     * Controller-level path (e.g., @Controller('resource') = "resource").
+     */
+    controllerPath?: string;
+    /**
+     * Method-level path (e.g., @Get('resource') = "resource").
+     */
+    methodPath?: string;
+    /**
+     * Global route prefix specified with the "VenokApplication#setGlobalPrefix" method.
+     */
+    globalPrefix?: string;
+    /**
+     * Module-level path registered through the "RouterModule".
+     */
+    modulePath?: string;
+    /**
+     * Controller-level version (e.g., @Controller({ version: '1.0' }) = "1.0").
+     */
+    controllerVersion?: VersionValue;
+    /**
+     * Method-level version (e.g., @Version('1.0') = "1.0").
+     */
+    methodVersion?: VersionValue;
+    /**
+     * API versioning options object.
+     */
+    versioningOptions?: VersioningOptions;
+}
+
+interface RouteTree {
+    path: string;
+    module?: Type;
+    children?: Routes | Type[];
+}
+type Routes = RouteTree[];
+
+declare enum HttpVersioningType {
+    URI = 0,
+    HEADER = 1,
+    MEDIA_TYPE = 2,
+    CUSTOM = 3
+}
+
+/**
+ * Indicates that this will work for any version passed in the request, or no version.
+ */
+declare const VERSION_NEUTRAL: unique symbol;
+type VersionValue = string | typeof VERSION_NEUTRAL | Array<string | typeof VERSION_NEUTRAL>;
+interface VersionOptions {
+    /**
+     * Specifies an optional API Version. When configured, methods
+     * within the controller will only be routed if the request version
+     * matches the specified value.
+     *
+     * Supported only by HTTP-based application.
+     *
+     */
+    version?: VersionValue;
+}
+interface HeaderVersioningOptions {
+    type: HttpVersioningType.HEADER;
+    /**
+     * The name of the Request Header that contains the version.
+     */
+    header: string;
+}
+interface UriVersioningOptions {
+    type: HttpVersioningType.URI;
+    /**
+     * Optional prefix that will prepend the version within the URI.
+     *
+     * Defaults to `v`.
+     *
+     * Ex. Assuming a version of `1`, for `/api/v1/route`, `v` is the prefix.
+     */
+    prefix?: string | false;
+}
+interface MediaTypeVersioningOptions {
+    type: HttpVersioningType.MEDIA_TYPE;
+    /**
+     * The key within the Media Type Header to determine the version from.
+     *
+     * Ex. For `application/json;v=1`, the key is `v=`.
+     */
+    key: string;
+}
+interface CustomVersioningOptions {
+    type: HttpVersioningType.CUSTOM;
+    /**
+     * A function that accepts a context and returns a single version value or
+     * an ordered array of versions, in order from HIGHEST to LOWEST.
+     *
+     * Ex. Returned version array = ['3.1', '3.0', '2.5', '2', '1.9']
+     *
+     * Use type assertion or narrowing to identify the specific request type.
+     */
+    extractor: (context: unknown[]) => string | string[];
+}
+interface VersioningCommonOptions {
+    /**
+     * The default version to be used as a fallback when you did not provide some
+     * version to `@Controller()` nor `@Version()`.
+     */
+    defaultVersion?: VersionOptions["version"];
+}
+type VersioningOptions = VersioningCommonOptions & (HeaderVersioningOptions | UriVersioningOptions | MediaTypeVersioningOptions | CustomVersioningOptions);
+
+type AdapterRouteMetadata = {
+    useVersionFilter: boolean;
+    useHostFilter: boolean;
+    method: HttpMethod;
+    versioningOptions?: VersioningOptions;
+    hosts?: {
+        regexp: RegExp;
+        keys: any[];
+    }[];
+    handlers: {
+        version?: VersionValue;
+        handler: Function;
+    }[];
+};
+type AdapterPathMiddlewareMetadata = {
+    use: Function;
+    method: HttpMethod;
+    excludedPaths?: Exclude<RouteInfo, "version">[];
+};
+type AdapterInstanceRouteMetadata = {
+    handler: ((...args: any[]) => Promise<void>);
+    method: HttpMethod;
+};
+type AdapterMiddlewareMetadata = {
+    path: string;
+    handlers: AdapterPathMiddlewareMetadata[];
+};
+
+type HttpExceptionBodyMessage = string | string[];
+interface HttpExceptionBody {
+    message?: HttpExceptionBodyMessage;
+    error: string;
+    statusCode: number;
+}
+interface HttpExceptionOptions {
+    /** original cause of the error */
+    cause?: unknown;
+    description?: string;
+}
+interface DescriptionAndOptions {
+    description: string;
+    httpExceptionOptions?: HttpExceptionOptions;
+}
+
+declare const VENOK_ADAPTER_BUILD: unique symbol;
+declare const VENOK_ADAPTER_ADD_ROUTE: unique symbol;
+declare const VENOK_ADAPTER_ADD_MIDDLEWARE: unique symbol;
+declare const VENOK_ADAPTER_SET_EXCEPTION_FILTER: unique symbol;
+declare const VENOK_APPLY_ROUTES_TO_INSTANCE: unique symbol;
+declare const VENOK_ADAPTER_RESPONSE: unique symbol;
+declare const VENOK_ADAPTER_TRANSFORM_NATIVE_ARGS_TO_CONTEXT: unique symbol;
+
+declare abstract class AbstractHttpAdapter<Instance = any, Context extends any[] = any[]> {
+    #private;
+    constructor(instance: Instance);
+    get instance(): Instance;
+    protected readonly routes: Map<string, AdapterRouteMetadata>;
+    protected readonly globalVenokMiddlewares: Set<Function>;
+    protected readonly exactVenokMiddlewares: Map<string, AdapterPathMiddlewareMetadata[]>;
+    protected readonly patternVenokMiddlewares: Map<string, AdapterPathMiddlewareMetadata[]>;
+    private convertMiddlewares;
+    private applyMiddlewareFilterToHandler;
+    private applyHostFilterToHandler;
+    private applyVersionFilterToHandler;
+    private runChain;
+    protected createExceptionHandler(callback: (...args: any[]) => void): ReturnType<VenokExceptionFilterContext["create"]>;
+    abstract listen(port: number, hostname: string, callback: (...args: any[]) => Promise<void>): Promise<void>;
+    abstract close(): Promise<void>;
+    abstract [VENOK_APPLY_ROUTES_TO_INSTANCE](routes: Map<string, AdapterInstanceRouteMetadata>): void;
+    [VENOK_ADAPTER_SET_EXCEPTION_FILTER](container: VenokContainer, config: ApplicationConfig): void;
+    [VENOK_ADAPTER_BUILD](): Map<string, AdapterInstanceRouteMetadata>;
+    use(handler: Function): any;
+    use(path: string, handler: Function): any;
+    get(path: string, handler: (...args: any[]) => any): any;
+    post(path: string, handler: (...args: any[]) => any): any;
+    put(path: string, handler: (...args: any[]) => any): any;
+    delete(path: string, handler: (...args: any[]) => any): any;
+    patch(path: string, handler: (...args: any[]) => any): any;
+    all(path: string, handler: (...args: any[]) => any): any;
+    options(path: string, handler: (...args: any[]) => any): any;
+    head(path: string, handler: (...args: any[]) => any): any;
+    search(path: string, handler: (...args: any[]) => any): any;
+    [VENOK_ADAPTER_ADD_ROUTE](path: string, info: AdapterRouteMetadata): any;
+    [VENOK_ADAPTER_ADD_MIDDLEWARE](path: string, metadata: AdapterPathMiddlewareMetadata): this;
+    private addUserMiddleware;
+    private addUserRoute;
+    abstract [VENOK_ADAPTER_TRANSFORM_NATIVE_ARGS_TO_CONTEXT](...args: any[]): Context;
+    abstract getParamsFactory(): VenokParamsFactoryInterface;
+    abstract isResponseHandled(ctx: Context): boolean;
+    abstract getStatusByMethod(requestMethod: HttpMethod): number;
+    abstract addAdditionalProp(ctx: Context, key: string, value: any): void;
+    abstract getRequestMethod(ctx: Context): HttpMethod;
+    abstract getRequestUrl(ctx: Context): string;
+    abstract getRequestHostname(ctx: Context): string;
+    abstract getRequestHeaders(ctx: Context): Record<string, string>;
+    abstract setResponseStatus(ctx: Context, statusCode: number): any;
+    abstract setResponseRedirect(ctx: Context, statusCode: number, url: string): any;
+    abstract setResponseHeader(ctx: Context, name: string, value: string): any;
+    abstract setResponseReply(ctx: Context, result: any, statusCode?: number): any;
+    abstract registerNotFoundHandler(): void;
+    abstract registerExceptionHandler(): void;
+}
+
+declare class HttpConfig<T extends AbstractHttpAdapter = AbstractHttpAdapter> {
+    private readonly options;
+    private globalPrefix;
+    private globalPrefixOptions;
+    private versioningOptions;
+    private adapter;
+    constructor(options: Required<HttpAppOptions>);
+    setHttpAdapter(httpAdapter: T): void;
+    getHttpAdapterRef(): T;
+    setGlobalPrefix(prefix: string): void;
+    getGlobalPrefix(): string;
+    setGlobalPrefixOptions(options: GlobalPrefixOptions<ExcludeRouteMetadata>): void;
+    getGlobalPrefixOptions(): GlobalPrefixOptions<ExcludeRouteMetadata>;
+    enableVersioning(options: VersioningOptions): void;
+    getVersioning(): VersioningOptions | undefined;
+}
+
+interface HttpAppOptions {
+    port: number;
+    hostname?: string;
+    listenCallback?: (...args: any[]) => Promise<void>;
+    callback: (app: HttpConfig<any>) => void;
+    adapter: AbstractHttpAdapter;
+}
+
+interface GlobalPrefixOptions<T = string | RouteInfo> {
+    exclude?: T[];
+}
+
+/**
+ * Interface defining options that can be passed to `@Controller()` decorator
+ *
+ * @publicApi
+ */
+interface ControllerOptions extends ScopeOptions, VersionOptions {
+    /**
+     * Specifies an optional `route path prefix`.  The prefix is pre-pended to the
+     * path specified in any request decorator in the class.
+     *
+     * Supported only by HTTP-based application (does not apply to non-HTTP microservices).
+     */
+    path?: string | string[];
+    /**
+     * Specifies an optional HTTP Request host filter. When configured, methods
+     * within the controller will only be routed if the request host matches the
+     * specified value.
+     */
+    host?: string | RegExp | Array<string | RegExp>;
+}
+/**
+ * Decorator that marks a class as a Venok controller that can receive inbound
+ * requests and produce responses.
+ *
+ * An HTTP Controller responds to inbound HTTP Requests and produces HTTP Responses.
+ * It defines a class that provides the context for one or more related route
+ * handlers that correspond to HTTP request methods and associated routes
+ * for example `GET /api/profile`, `POST /users/resume`.
+ *
+ * A Microservice Controller responds to requests as well as events, running over
+ * a variety of transports. It defines a class that provides a context for
+ * one or more message or event handlers.
+ *
+ * @publicApi
+ */
+declare function Controller(): ClassDecorator;
+/**
+ * Decorator that marks a class as a Venok controller that can receive inbound
+ * requests and produce responses.
+ *
+ * An HTTP Controller responds to inbound HTTP Requests and produces HTTP Responses.
+ * It defines a class that provides the context for one or more related route
+ * handlers that correspond to HTTP request methods and associated routes
+ * for example `GET /api/profile`, `POST /users/resume`.
+ *
+ * A Microservice Controller responds to requests as well as events, running over
+ * a variety of transports. It defines a class that provides a context for
+ * one or more message or event handlers.
+ *
+ * @param {string|Array} prefix string that defines a `route path prefix`.  The prefix
+ * is pre-pended to the path specified in any request decorator in the class.
+ *
+ * @publicApi
+ */
+declare function Controller(prefix: string | string[]): ClassDecorator;
+/**
+ * Decorator that marks a class as a Venok controller that can receive inbound
+ * requests and produce responses.
+ *
+ * An HTTP Controller responds to inbound HTTP Requests and produces HTTP Responses.
+ * It defines a class that provides the context for one or more related route
+ * handlers that correspond to HTTP request methods and associated routes
+ * for example `GET /api/profile`, `POST /users/resume`.
+ *
+ * A Microservice Controller responds to requests as well as events, running over
+ * a variety of transports. It defines a class that provides a context for
+ * one or more message or event handlers.
+ *
+ * @param {object} options configuration object specifying:
+ *
+ * - `scope` - symbol that determines the lifetime of a Controller instance.
+ * See Scope for more details.
+ * - `prefix` - string that defines a `route path prefix`.  The prefix
+ * is pre-pended to the path specified in any request decorator in the class.
+ * - `version` - string, array of strings, or Symbol that defines the version
+ * of all routes in the class. See Versioning for more details.
+ *
+ * @publicApi
+ */
+declare function Controller(options: ControllerOptions): ClassDecorator;
+declare namespace Controller {
+    var KEY: string;
+}
+
+/**
+ * Request method Decorator.  Sets a response header.
+ *
+ * For example:
+ * `@Header('Cache-Control', 'none')`
+ *
+ * @param name string to be used for header name
+ * @param value string to be used for header value
+ *
+ * @publicApi
+ */
+declare function Header(name: string, value: string): MethodDecorator;
+
+/**
+ * Request method Decorator. Defines the HTTP response status code.  Overrides
+ * default status code for the decorated request method.
+ *
+ * @param statusCode HTTP response code to be returned by route handler.
+ *
+ * @publicApi
+ */
+declare const HttpCode: _venok_core.ReflectableMethodDecorator<number, number>;
+
+interface ResponseDecoratorOptions {
+    /**
+     * Determines whether the response will be sent manually within the route handler,
+     * with the use of native response handling methods exposed by the platform-specific response object,
+     * or if it should pass through Venok response processing pipeline.
+     *
+     * @default false
+     */
+    passthrough: boolean;
+}
+/**
+ * Route handler parameter decorator. Extracts the `Context`
+ * object from the execution context and populates the decorated
+ * parameter with the value of `Context`.
+ *
+ * Example: `logout(@Context() ctx)`
+ *
+ * @publicApi
+ */
+declare const HttpContext: (options?: {
+    response?: ResponseDecoratorOptions;
+}) => ParameterDecorator;
+/**
+ * Route handler parameter decorator. Extracts the `Ip` property
+ * from the `req` object and populates the decorated
+ * parameter with the value of `ip`.
+ *
+ * @publicApi
+ */
+declare const Ip: () => ParameterDecorator;
+/**
+ * Route handler parameter decorator. Extracts the file object from context
+ * and populates the decorated parameter with the value of `file`.
+ * Used in conjunction with multer middleware
+ *
+ * For example:
+ * ```ts
+ * uploadFile(@UploadedFile("image") file) {
+ *   console.log(file);
+ * }
+ * ```
+ *
+ * @param fileKey {string} File key from request body
+ *
+ * @publicApi
+ */
+declare function UploadedFile(fileKey: string): ParameterDecorator;
+/**
+ * Route handler parameter decorator. Extracts the file objects from context
+ * and populates the decorated parameter with the value of `files`.
+ *
+ * For example:
+ * ```ts
+ * uploadFile(@UploadedFiles("images") files) {
+ *   console.log(files);
+ * }
+ * ```
+ *
+ * @param filesKey {string} Files key from request body
+ *
+ * @publicApi
+ */
+declare function UploadedFiles(filesKey: string): ParameterDecorator;
+/**
+ * Route handler parameter decorator. Extracts the file objects from context
+ * and populates the decorated parameter with the value of `files`.
+ *
+ * If fields not specified all files from context will return
+ *
+ * For example:
+ * ```ts
+ * uploadFile(@MultipleUploadedFiles("videos") files) {
+ *   console.log(files);
+ * }
+ * ```
+ *
+ * @param fields Array of file keys from request body
+ *
+ * @publicApi
+ */
+declare function MultipleUploadedFiles(fields?: {
+    field: string;
+}[]): ParameterDecorator;
+/**
+ * Route handler parameter decorator. Extracts the file objects from context
+ * and populates the decorated parameter with the value of `files`.
+ *
+ * If fields not specified all files from context will return
+ *
+ * For example:
+ * ```ts
+ * uploadFile(@MultipleUploadedFiles() files) {
+ *   console.log(files);
+ * }
+ * ```
+ *
+ * @param fields Array of file keys from request body
+ * @param pipes One or more pipes to apply to the files
+ *
+ * @publicApi
+ */
+declare function MultipleUploadedFiles(fields?: {
+    field: string;
+}[], ...pipes: (Type<PipeTransform> | PipeTransform)[]): ParameterDecorator;
+/**
+ * Route handler parameter decorator. Extracts the `headers`
+ * property from the `req` object and populates the decorated
+ * parameter with the value of `headers`.
+ *
+ * For example: `async update(@Headers('Cache-Control') cacheControl: string)`
+ *
+ * @param property name of single header property to extract.
+ *
+ * @publicApi
+ */
+declare const Headers: (property?: string) => ParameterDecorator;
+/**
+ * Route handler parameter decorator. Extracts the `query`
+ * property from the `req` object and populates the decorated
+ * parameter with the value of `query`. May also apply pipes to the bound
+ * query parameter.
+ *
+ * For example:
+ * ```ts
+ * async find(@Query('user') user: string)
+ * ```
+ *
+ * @publicApi
+ */
+declare function Query(): ParameterDecorator;
+/**
+ * Route handler parameter decorator. Extracts the `query`
+ * property from the `req` object and populates the decorated
+ * parameter with the value of `query`. May also apply pipes to the bound
+ * query parameter.
+ *
+ * For example:
+ * ```ts
+ * async find(@Query('user') user: string)
+ * ```
+ *
+ * @param pipes one or more pipes to apply to the bound query parameter
+ *
+ * @publicApi
+ */
+declare function Query(...pipes: (Type<PipeTransform> | PipeTransform)[]): ParameterDecorator;
+/**
+ * Route handler parameter decorator. Extracts the `query`
+ * property from the `req` object and populates the decorated
+ * parameter with the value of `query`. May also apply pipes to the bound
+ * query parameter.
+ *
+ * For example:
+ * ```ts
+ * async find(@Query('user') user: string)
+ * ```
+ *
+ * @param property name of single property to extract from the `query` object
+ * @param pipes one or more pipes to apply to the bound query parameter
+ *
+ * @publicApi
+ */
+declare function Query(property: string, ...pipes: (Type<PipeTransform> | PipeTransform)[]): ParameterDecorator;
+/**
+ * Route handler parameter decorator. Extracts the entire `body`
+ * object from the `req` object and populates the decorated
+ * parameter with the value of `body`.
+ *
+ * For example:
+ * ```ts
+ * async create(@Body() createDto: CreateCatDto)
+ * ```
+ *
+ * @publicApi
+ */
+declare function Body(): ParameterDecorator;
+/**
+ * Route handler parameter decorator. Extracts the entire `body`
+ * object from the `req` object and populates the decorated
+ * parameter with the value of `body`. Also applies the specified
+ * pipes to that parameter.
+ *
+ * For example:
+ * ```ts
+ * async create(@Body(new ValidationPipe()) createDto: CreateCatDto)
+ * ```
+ *
+ * @param pipes one or more pipes - either instances or classes - to apply to
+ * the bound body parameter.
+ *
+ * @publicApi
+ */
+declare function Body(...pipes: (Type<PipeTransform> | PipeTransform)[]): ParameterDecorator;
+/**
+ * Route handler parameter decorator. Extracts a single property from
+ * the `body` object property of the `req` object and populates the decorated
+ * parameter with the value of that property. Also applies pipes to the bound
+ * body parameter.
+ *
+ * For example:
+ * ```ts
+ * async create(@Body('role', new ValidationPipe()) role: string)
+ * ```
+ *
+ * @param property name of single property to extract from the `body` object
+ * @param pipes one or more pipes - either instances or classes - to apply to
+ * the bound body parameter.
+ *
+ * @publicApi
+ */
+declare function Body(property: string, ...pipes: (Type<PipeTransform> | PipeTransform)[]): ParameterDecorator;
+/**
+ * Route handler parameter decorator. Extracts the `params`
+ * property from the `req` object and populates the decorated
+ * parameter with the value of `params`. May also apply pipes to the bound
+ * parameter.
+ *
+ * For example, extracting all params:
+ * ```ts
+ * findOne(@Param() params: string[])
+ * ```
+ *
+ * For example, extracting a single param:
+ * ```ts
+ * findOne(@Param('id') id: string)
+ * ```
+ *
+ * @publicApi
+ */
+declare function Param(): ParameterDecorator;
+/**
+ * Route handler parameter decorator. Extracts the `params`
+ * property from the `req` object and populates the decorated
+ * parameter with the value of `params`. May also apply pipes to the bound
+ * parameter.
+ *
+ * For example, extracting all params:
+ * ```ts
+ * findOne(@Param() params: string[])
+ * ```
+ *
+ * For example, extracting a single param:
+ * ```ts
+ * findOne(@Param('id') id: string)
+ * ```
+ *
+ * @param pipes one or more pipes - either instances or classes - to apply to
+ * the bound parameter.
+ *
+ * @publicApi
+ */
+declare function Param(...pipes: (Type<PipeTransform> | PipeTransform)[]): ParameterDecorator;
+/**
+ * Route handler parameter decorator. Extracts the `params`
+ * property from the `req` object and populates the decorated
+ * parameter with the value of `params`. May also apply pipes to the bound
+ * parameter.
+ *
+ * For example, extracting all params:
+ * ```ts
+ * findOne(@Param() params: string[])
+ * ```
+ *
+ * For example, extracting a single param:
+ * ```ts
+ * findOne(@Param('id') id: string)
+ * ```
+ *
+ * @param property name of single property to extract from the `req` object
+ * @param pipes one or more pipes - either instances or classes - to apply to
+ * the bound parameter.
+ *
+ * @publicApi
+ */
+declare function Param(property: string, ...pipes: (Type<PipeTransform> | PipeTransform)[]): ParameterDecorator;
+/**
+ * Route handler parameter decorator. Extracts the `hosts`
+ * property from the `req` object and populates the decorated
+ * parameter with the value of `hosts`. May also apply pipes to the bound
+ * parameter.
+ *
+ * For example, extracting all params:
+ * ```ts
+ * findOne(@HostParam() params: string[])
+ * ```
+ *
+ * For example, extracting a single param:
+ * ```ts
+ * findOne(@HostParam('id') id: string)
+ * ```
+ *
+ * @publicApi
+ */
+declare function HostParam(): ParameterDecorator;
+/**
+ * Route handler parameter decorator. Extracts the `hosts`
+ * property from the `req` object and populates the decorated
+ * parameter with the value of `hosts`. May also apply pipes to the bound
+ * parameter.
+ *
+ * For example, extracting all params:
+ * ```ts
+ * findOne(@HostParam() params: string[])
+ * ```
+ *
+ * For example, extracting a single param:
+ * ```ts
+ * findOne(@HostParam('id') id: string)
+ * ```
+ * @param property name of single property to extract from the `req` object
+ *
+ * @publicApi
+ */
+declare function HostParam(property: string): ParameterDecorator;
+
+declare const HOST_METADATA = "host";
+declare const PATH_METADATA = "path";
+declare const HEADERS_METADATA = "__headers__";
+declare const REDIRECT_METADATA = "__redirect__";
+declare const RESPONSE_PASSTHROUGH_METADATA = "__responsePassthrough__";
+declare const VERSION_METADATA = "__version__";
+declare const METHOD_METADATA = "method";
+
+interface MethodMappingMetadata {
+    path?: string | string[];
+    method?: HttpMethod;
+}
+type RequestMappingDecorator = {
+    [PATH_METADATA]: string | string[];
+    [METHOD_METADATA]: HttpMethod;
+};
+declare const MethodMapping: _venok_core.ReflectableMethodDecorator<MethodMappingMetadata, RequestMappingDecorator>;
+/**
+ * Route handler (method) Decorator. Routes HTTP POST requests to the specified path.
+ *
+ * @publicApi
+ */
+declare const Post: (path?: string | string[]) => MethodDecorator;
+/**
+ * Route handler (method) Decorator. Routes HTTP GET requests to the specified path.
+ *
+ * @publicApi
+ */
+declare const Get: (path?: string | string[]) => MethodDecorator;
+/**
+ * Route handler (method) Decorator. Routes HTTP DELETE requests to the specified path.
+ *
+ * @publicApi
+ */
+declare const Delete: (path?: string | string[]) => MethodDecorator;
+/**
+ * Route handler (method) Decorator. Routes HTTP PUT requests to the specified path.
+ *
+ * @publicApi
+ */
+declare const Put: (path?: string | string[]) => MethodDecorator;
+/**
+ * Route handler (method) Decorator. Routes HTTP PATCH requests to the specified path.
+ *
+ * @publicApi
+ */
+declare const Patch: (path?: string | string[]) => MethodDecorator;
+/**
+ * Route handler (method) Decorator. Routes HTTP OPTIONS requests to the specified path.
+ *
+ * @publicApi
+ */
+declare const Options: (path?: string | string[]) => MethodDecorator;
+/**
+ * Route handler (method) Decorator. Routes HTTP HEAD requests to the specified path.
+ *
+ * @publicApi
+ */
+declare const Head: (path?: string | string[]) => MethodDecorator;
+/**
+ * Route handler (method) Decorator. Routes all HTTP requests to the specified path.
+ *
+ * @publicApi
+ */
+declare const All: (path?: string | string[]) => MethodDecorator;
+/**
+ * Route handler (method) Decorator. Routes all HTTP requests to the specified path.
+ *
+ * @publicApi
+ */
+declare const Search: (path?: string | string[]) => MethodDecorator;
+
+type RedirectOptions = {
+    url: string;
+    statusCode?: number;
+};
+declare const Redirect: (url: string, statusCode?: number) => MethodDecorator;
+
+/**
+ * Sets the version of the endpoint to the passed version
+ *
+ * @publicApi
+ */
+declare const Version: _venok_core.ReflectableMethodDecorator<VersionValue, VersionValue>;
+
+declare enum HttpParamtypes {
+    CONTEXT = 0,
+    BODY = 1,
+    QUERY = 2,
+    PARAM = 3,
+    HEADERS = 4,
+    FILE = 5,
+    FILES = 6,
+    MULTIPLE_FILES = 7,
+    HOST = 8,
+    IP = 9
+}
+
+declare enum HttpStatus {
+    CONTINUE = 100,
+    SWITCHING_PROTOCOLS = 101,
+    PROCESSING = 102,
+    EARLYHINTS = 103,
+    OK = 200,
+    CREATED = 201,
+    ACCEPTED = 202,
+    NON_AUTHORITATIVE_INFORMATION = 203,
+    NO_CONTENT = 204,
+    RESET_CONTENT = 205,
+    PARTIAL_CONTENT = 206,
+    AMBIGUOUS = 300,
+    MOVED_PERMANENTLY = 301,
+    FOUND = 302,
+    SEE_OTHER = 303,
+    NOT_MODIFIED = 304,
+    TEMPORARY_REDIRECT = 307,
+    PERMANENT_REDIRECT = 308,
+    BAD_REQUEST = 400,
+    UNAUTHORIZED = 401,
+    PAYMENT_REQUIRED = 402,
+    FORBIDDEN = 403,
+    NOT_FOUND = 404,
+    METHOD_NOT_ALLOWED = 405,
+    NOT_ACCEPTABLE = 406,
+    PROXY_AUTHENTICATION_REQUIRED = 407,
+    REQUEST_TIMEOUT = 408,
+    CONFLICT = 409,
+    GONE = 410,
+    LENGTH_REQUIRED = 411,
+    PRECONDITION_FAILED = 412,
+    PAYLOAD_TOO_LARGE = 413,
+    URI_TOO_LONG = 414,
+    UNSUPPORTED_MEDIA_TYPE = 415,
+    REQUESTED_RANGE_NOT_SATISFIABLE = 416,
+    EXPECTATION_FAILED = 417,
+    I_AM_A_TEAPOT = 418,
+    MISDIRECTED = 421,
+    UNPROCESSABLE_ENTITY = 422,
+    FAILED_DEPENDENCY = 424,
+    PRECONDITION_REQUIRED = 428,
+    TOO_MANY_REQUESTS = 429,
+    INTERNAL_SERVER_ERROR = 500,
+    NOT_IMPLEMENTED = 501,
+    BAD_GATEWAY = 502,
+    SERVICE_UNAVAILABLE = 503,
+    GATEWAY_TIMEOUT = 504,
+    HTTP_VERSION_NOT_SUPPORTED = 505
+}
+
+/**
+ * Defines the base Venok HTTP exception, which is handled by the default
+ * Exceptions Handler.
+ *
+ * @publicApi
+ */
+declare class HttpException extends Error {
+    private readonly info;
+    private readonly status;
+    private readonly options?;
+    /**
+     * Instantiate a plain HTTP Exception.
+     *
+     * @example
+     * throw new HttpException()
+     * throw new HttpException('message', HttpStatus.BAD_REQUEST)
+     * throw new HttpException('custom message', HttpStatus.BAD_REQUEST, {
+     *  cause: new Error('Cause Error'),
+     *  description: "Validation Error",
+     * })
+     * throw new HttpException({ status: 400, custom: "Hello innovators" })
+     *
+     * @usageNotes
+     * The constructor arguments define the response message and the HTTP response status code.
+     * - The `info` argument (required) argument defines JSON object or the message string.
+     * - The `status` argument (required) defines the HTTP Status Code.
+     * - The `options` argument (optional) defines additional error options. Currently, it supports the `cause` attribute,
+     *  and can be used as an alternative way to specify the error cause: `const error = new HttpException('description', 400, { cause: new Error() });`
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: the Http Status Code.
+     * - `message`: a short description of the HTTP error by default; override this
+     * by supplying a string in the `response` parameter.
+     *
+     * To override the entire JSON response body, pass an object to the `createBody`
+     * method. Venok will serialize the object and return it as the JSON response body.
+     *
+     * The `status` argument is required, and should be a valid HTTP status code.
+     * Best practice is to use the `HttpStatus` enum.
+     *
+     * @param info JSON object or message string describing the error condition
+     * @param status HTTP response status code.
+     * @param options An object used to add an error cause.
+     */
+    constructor(info: string | Record<string, any>, status: number, options?: HttpExceptionOptions | undefined);
+    cause: unknown;
+    /**
+     * Configures error chaining support
+     *
+     * @see https://nodejs.org/en/blog/release/v16.9.0/#error-cause
+     * @see https://github.com/microsoft/TypeScript/issues/45167
+     */
+    initCause(): void;
+    initMessage(): void;
+    initName(): void;
+    getInfo(): string | object;
+    /**
+     * @deprecated
+     */
+    getResponse(): string | object;
+    getStatus(): number;
+    static createBody(nothing: null | "" | any, message: HttpExceptionBodyMessage, statusCode: number): HttpExceptionBody;
+    static createBody(message: HttpExceptionBodyMessage, error: string, statusCode: number): HttpExceptionBody;
+    static createBody<Body extends Record<string, unknown>>(custom: Body): Body;
+    static getDescriptionFrom(descriptionOrOptions: string | HttpExceptionOptions): string;
+    static getHttpExceptionOptionsFrom(descriptionOrOptions: string | HttpExceptionOptions): HttpExceptionOptions;
+    /**
+     * Utility method used to extract the error description and httpExceptionOptions from the given argument.
+     * This is used by inheriting classes to correctly parse both options.
+     * @returns the error description and the httpExceptionOptions as an object.
+     */
+    static extractDescriptionAndOptionsFrom(descriptionOrOptions: string | HttpExceptionOptions, fallbackDescription?: string): DescriptionAndOptions;
+}
+
+/**
+ * Defines an HTTP exception for *Bad Gateway* type errors.
+ *
+ * @publicApi
+ */
+declare class BadGatewayException extends HttpException {
+    /**
+     * Instantiate a `BadGatewayException` Exception.
+     *
+     * @example
+     * `throw new BadGatewayException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 502.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 502.
+     * - `message`: the string `'Bad Gateway'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *Bad Request* type errors.
+ *
+ * @publicApi
+ */
+declare class BadRequestException extends HttpException {
+    /**
+     * Instantiate a `BadRequestException` Exception.
+     *
+     * @example
+     * `throw new BadRequestException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 400.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 400.
+     * - `message`: the string `'Bad Request'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *Conflict* type errors.
+ *
+ * @publicApi
+ */
+declare class ConflictException extends HttpException {
+    /**
+     * Instantiate a `ConflictException` Exception.
+     *
+     * @example
+     * `throw new ConflictException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 409.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 409.
+     * - `message`: the string `'Conflict'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *Expectation Failed* type errors.
+ *
+ * @publicApi
+ */
+declare class ExpectationFailedException extends HttpException {
+    /**
+     * Instantiate a `ExpectationFailedException` Exception.
+     *
+     * @example
+     * `throw new ExpectationFailedException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 417.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 417.
+     * - `message`: the string `'Expectation Failed'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *Failed Dependency* type errors.
+ *
+ * @publicApi
+ */
+declare class FailedDependencyException extends HttpException {
+    /**
+     * Instantiate a `FailedDependencyException` Exception.
+     *
+     * @example
+     * `throw new FailedDependencyException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 424.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 424.
+     * - `message`: the string `'Failed Dependency'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *Forbidden* type errors.
+ *
+ * @publicApi
+ */
+declare class ForbiddenException extends HttpException {
+    /**
+     * Instantiate a `ForbiddenException` Exception.
+     *
+     * @example
+     * `throw new ForbiddenException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 403.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 403.
+     * - `message`: the string `'Forbidden'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *Gateway Timeout* type errors.
+ *
+ * @publicApi
+ */
+declare class GatewayTimeoutException extends HttpException {
+    /**
+     * Instantiate a `GatewayTimeoutException` Exception.
+     *
+     * @example
+     * `throw new GatewayTimeoutException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 504.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 504.
+     * - `message`: the string `'Gateway Timeout'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *Gone* type errors.
+ *
+ * @publicApi
+ */
+declare class GoneException extends HttpException {
+    /**
+     * Instantiate a `GoneException` Exception.
+     *
+     * @example
+     * `throw new GoneException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 410.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 410.
+     * - `message`: the string `'Gone'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *HTTP Version Not Supported* type errors.
+ *
+ * @publicApi
+ */
+declare class HttpVersionNotSupportedException extends HttpException {
+    /**
+     * Instantiate a `HttpVersionNotSupportedException` Exception.
+     *
+     * @example
+     * `throw new HttpVersionNotSupportedException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 505.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 505.
+     * - `message`: the string `'HTTP Version Not Supported'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *I'm a teapot* type errors.
+ *
+ * @publicApi
+ */
+declare class ImATeapotException extends HttpException {
+    /**
+     * Instantiate a `ImATeapotException` Exception.
+     *
+     * @example
+     * `throw new ImATeapotException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 418.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 418.
+     * - `message`: the string `'I'm a teapot'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *Internal Server Error* type errors.
+ *
+ * @publicApi
+ */
+declare class InternalServerErrorException extends HttpException {
+    /**
+     * Instantiate a `InternalServerErrorException` Exception.
+     *
+     * @example
+     * `throw new InternalServerErrorException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 500.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 500.
+     * - `message`: the string `'Internal Server Error'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *Length Required* type errors.
+ *
+ * @publicApi
+ */
+declare class LengthRequiredException extends HttpException {
+    /**
+     * Instantiate a `LengthRequiredException` Exception.
+     *
+     * @example
+     * `throw new LengthRequiredException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 411.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 411.
+     * - `message`: the string `'Length Required'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *Method Not Allowed* type errors.
+ *
+ * @publicApi
+ */
+declare class MethodNotAllowedException extends HttpException {
+    /**
+     * Instantiate a `MethodNotAllowedException` Exception.
+     *
+     * @example
+     * `throw new MethodNotAllowedException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 405.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 405.
+     * - `message`: the string `'Method Not Allowed'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *Misdirected* type errors.
+ *
+ * @publicApi
+ */
+declare class MisdirectedException extends HttpException {
+    /**
+     * Instantiate a `MisdirectedException` Exception.
+     *
+     * @example
+     * `throw new MisdirectedException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 421.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 421.
+     * - `message`: the string `'Misdirected'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *Not Acceptable* type errors.
+ *
+ * @publicApi
+ */
+declare class NotAcceptableException extends HttpException {
+    /**
+     * Instantiate a `NotAcceptableException` Exception.
+     *
+     * @example
+     * `throw new NotAcceptableException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 406.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 406.
+     * - `message`: the string `'Not Acceptable'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *Not Found* type errors.
+ *
+ * @publicApi
+ */
+declare class NotFoundException extends HttpException {
+    /**
+     * Instantiate a `NotFoundException` Exception.
+     *
+     * @example
+     * `throw new NotFoundException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 404.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 404.
+     * - `message`: the string `'Not Found'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *Not Implemented* type errors.
+ *
+ * @publicApi
+ */
+declare class NotImplementedException extends HttpException {
+    /**
+     * Instantiate a `NotImplementedException` Exception.
+     *
+     * @example
+     * `throw new NotImplementedException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 501.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 501.
+     * - `message`: the string `'Not Implemented'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *Payload Too Large* type errors.
+ *
+ * @publicApi
+ */
+declare class PayloadTooLargeException extends HttpException {
+    /**
+     * Instantiate a `PayloadTooLargeException` Exception.
+     *
+     * @example
+     * `throw new PayloadTooLargeException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 413.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 413.
+     * - `message`: the string `'Payload Too Large'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *Payment Required* type errors.
+ *
+ * @publicApi
+ */
+declare class PaymentRequiredException extends HttpException {
+    /**
+     * Instantiate a `PaymentRequiredException` Exception.
+     *
+     * @example
+     * `throw new PaymentRequiredException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 402.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 402.
+     * - `message`: the string `'Payment Required'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *Precondition Failed* type errors.
+ *
+ * @publicApi
+ */
+declare class PreconditionFailedException extends HttpException {
+    /**
+     * Instantiate a `PreconditionFailedException` Exception.
+     *
+     * @example
+     * `throw new PreconditionFailedException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 412.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 412.
+     * - `message`: the string `'Precondition Failed'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *Precondition Required* type errors.
+ *
+ * @publicApi
+ */
+declare class PreconditionRequiredException extends HttpException {
+    /**
+     * Instantiate a `PreconditionRequiredException` Exception.
+     *
+     * @example
+     * `throw new PreconditionRequiredException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 428.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 428.
+     * - `message`: the string `'Precondition Required'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *Proxy Authentication Required* type errors.
+ *
+ * @publicApi
+ */
+declare class ProxyAuthenticationRequiredException extends HttpException {
+    /**
+     * Instantiate a `ProxyAuthenticationRequiredException` Exception.
+     *
+     * @example
+     * `throw new ProxyAuthenticationRequiredException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 407.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 407.
+     * - `message`: the string `'Proxy Authentication Required'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *Request Timeout* type errors.
+ *
+ * @publicApi
+ */
+declare class RequestTimeoutException extends HttpException {
+    /**
+     * Instantiate a `RequestTimeoutException` Exception.
+     *
+     * @example
+     * `throw new RequestTimeoutException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 408.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 408.
+     * - `message`: the string `'Request Timeout'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *Requested Range Not Satisfiable* type errors.
+ *
+ * @publicApi
+ */
+declare class RequestedRangeNotSatisfiableException extends HttpException {
+    /**
+     * Instantiate a `RequestedRangeNotSatisfiableException` Exception.
+     *
+     * @example
+     * `throw new RequestedRangeNotSatisfiableException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 416.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 416.
+     * - `message`: the string `'Requested Range Not Satisfiable'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *Service Unavailable* type errors.
+ *
+ * @publicApi
+ */
+declare class ServiceUnavailableException extends HttpException {
+    /**
+     * Instantiate a `ServiceUnavailableException` Exception.
+     *
+     * @example
+     * `throw new ServiceUnavailableException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 503.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 503.
+     * - `message`: the string `'Service Unavailable'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *Too Many Requests* type errors.
+ *
+ * @publicApi
+ */
+declare class TooManyRequestsException extends HttpException {
+    /**
+     * Instantiate a `TooManyRequestsException` Exception.
+     *
+     * @example
+     * `throw new TooManyRequestsException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 429.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 429.
+     * - `message`: the string `'Too Many Requests'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *Unauthorized* type errors.
+ *
+ * @publicApi
+ */
+declare class UnauthorizedException extends HttpException {
+    /**
+     * Instantiate a `UnauthorizedException` Exception.
+     *
+     * @example
+     * `throw new UnauthorizedException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 401.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 401.
+     * - `message`: the string `'Unauthorized'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *Unprocessable Entity* type errors.
+ *
+ * @publicApi
+ */
+declare class UnprocessableEntityException extends HttpException {
+    /**
+     * Instantiate a `UnprocessableEntityException` Exception.
+     *
+     * @example
+     * `throw new UnprocessableEntityException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 422.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 422.
+     * - `message`: the string `'Unprocessable Entity'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *Unsupported Media Type* type errors.
+ *
+ * @publicApi
+ */
+declare class UnsupportedMediaTypeException extends HttpException {
+    /**
+     * Instantiate a `UnsupportedMediaTypeException` Exception.
+     *
+     * @example
+     * `throw new UnsupportedMediaTypeException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 415.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 415.
+     * - `message`: the string `'Unsupported Media Type'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+/**
+ * Defines an HTTP exception for *URI Too Long* type errors.
+ *
+ * @publicApi
+ */
+declare class UriTooLongException extends HttpException {
+    /**
+     * Instantiate a `UriTooLongException` Exception.
+     *
+     * @example
+     * `throw new UriTooLongException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 414.
+     * - The `info` argument defines JSON object or the message string.
+     * - The `descriptionOrOptions` argument contains either a short description of
+     *   the HTTP error or an options object used to provide an underlying error cause.
+     *
+     * By default, the JSON response body contains two properties:
+     * - `statusCode`: this will be the value 414.
+     * - `message`: the string `'URI Too Long'` by default;
+     *    override this by supplying a string in the `descriptionOrOptions` parameter.
+     *
+     * If the parameter `info` is a string, the body will contain an
+     * additional property, `message`.
+     *
+     * By default, `error` will contain a string with a short description of the HTTP error.
+     * To override the entire JSON response body, pass an object instead.
+     * Venok will serialize the object and return it as the JSON response body.
+     *
+     * @param info string or object describing the error condition.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
+     */
+    constructor(info?: string | object, descriptionOrOptions?: string | HttpExceptionOptions);
+}
+
+declare class HttpExceptionFilter<T = any> implements ExceptionFilter<T> {
+    protected readonly container: VenokContainer;
+    private static readonly logger;
+    private readonly context;
+    constructor(container: VenokContainer);
+    catch(exception: T, host: ArgumentsHost): void;
+    handleUnknownError(exception: T, host: ArgumentsHost, applicationRef: AbstractHttpAdapter): void;
+    isExceptionObject(err: any): err is Error;
+    /**
+     * Checks if the thrown error comes from the "http-errors" library.
+     * @param err error object
+     */
+    isHttpError(err: any): err is {
+        statusCode: number;
+        message: string;
+    };
+}
+
+declare const mapToExcludeRoute: (routes: (string | RouteInfo)[]) => ExcludeRouteMetadata[];
+declare const filterMiddleware: <T extends Function | Type = any>(middleware: T[]) => Type<any>[];
+declare const mapToClass: <T extends Function | Type<any>>(middleware: T) => Type<any>;
+declare const isMiddlewareClass: (middleware: any) => middleware is Type;
+declare const assignToken: (metatype: Type, token?: string) => Type;
+
+declare const addLeadingSlash: (path?: string) => string;
+declare const normalizePath: (path?: string) => string;
+declare const stripEndSlash: (path: string) => string;
+declare const isWildcard: (path: string) => boolean;
+declare const isParam: (path: string) => boolean;
+declare const isOptionalParam: (path: string) => boolean;
+type PathType = "static" | "param" | "optional-param" | "wildcard";
+declare const getPathType: (path: string) => PathType;
+
+declare const isRequestMethodAll: (method: HttpMethod) => boolean;
+declare const isRouteExcluded: (excludedRoutes: ExcludeRouteMetadata[], path: string, requestMethod?: HttpMethod) => boolean;
+declare const flattenRoutePaths: (routes: Routes) => {
+    module: any;
+    path: string;
+}[];
+
+declare const HttpConfigurableModuleClass: _venok_integration.ConfigurableModuleCls<HttpAppOptions, "register", "create", object>;
+
+declare class HttpModule extends HttpConfigurableModuleClass {
+}
+
+declare abstract class HttpMiddlewareModule implements VenokModule {
+    abstract configure(consumer: HttpMiddlewareConsumer): void | Promise<void>;
+}
+
+declare const ROUTES: unique symbol;
+declare const targetModulesByContainer: WeakMap<ModulesContainer, WeakSet<CoreModule>>;
+/**
+ * @publicApi
+ */
+declare class RouterModule {
+    private readonly modulesContainer;
+    private readonly routes;
+    constructor(modulesContainer: ModulesContainer, routes: Routes);
+    static register(routes: Routes): DynamicModule;
+    private deepCloneRoutes;
+    private initialize;
+    private registerModulePathMetadata;
+    private updateTargetModulesCache;
+}
+
+export { AbstractHttpAdapter, type AdapterInstanceRouteMetadata, type AdapterMiddlewareMetadata, type AdapterPathMiddlewareMetadata, type AdapterRouteMetadata, All, BadGatewayException, BadRequestException, Body, ConflictException, Controller, type ControllerOptions, type CustomVersioningOptions, Delete, type DescriptionAndOptions, type ExcludeRouteMetadata, ExpectationFailedException, FailedDependencyException, ForbiddenException, GatewayTimeoutException, Get, type GlobalPrefixOptions, GoneException, HEADERS_METADATA, HOST_METADATA, Head, Header, type HeaderVersioningOptions, Headers, HostParam, type HttpAppOptions, HttpCode, HttpConfig, HttpContext, HttpException, type HttpExceptionBody, type HttpExceptionBodyMessage, HttpExceptionFilter, type HttpExceptionOptions, HttpMethod, type HttpMiddlewareConsumer, HttpMiddlewareModule, HttpModule, HttpParamtypes, HttpStatus, HttpVersionNotSupportedException, HttpVersioningType, ImATeapotException, InternalServerErrorException, Ip, LengthRequiredException, METHOD_METADATA, type MediaTypeVersioningOptions, MethodMapping, type MethodMappingMetadata, MethodNotAllowedException, type MiddlewareConfigProxy, MisdirectedException, MultipleUploadedFiles, NotAcceptableException, NotFoundException, NotImplementedException, Options, PATH_METADATA, Param, Patch, PayloadTooLargeException, PaymentRequiredException, Post, PreconditionFailedException, PreconditionRequiredException, ProxyAuthenticationRequiredException, Put, Query, REDIRECT_METADATA, RESPONSE_PASSTHROUGH_METADATA, ROUTES, Redirect, type RedirectOptions, RequestTimeoutException, RequestedRangeNotSatisfiableException, type ResponseDecoratorOptions, type RouteDefinition, type RouteInfo, type RoutePathMetadata, type RouteTree, RouterModule, type Routes, Search, ServiceUnavailableException, TooManyRequestsException, UnauthorizedException, UnprocessableEntityException, UnsupportedMediaTypeException, UploadedFile, UploadedFiles, UriTooLongException, type UriVersioningOptions, VENOK_ADAPTER_RESPONSE, VENOK_ADAPTER_TRANSFORM_NATIVE_ARGS_TO_CONTEXT, VENOK_APPLY_ROUTES_TO_INSTANCE, VERSION_METADATA, VERSION_NEUTRAL, Version, type VersionOptions, type VersionValue, type VersioningOptions, addLeadingSlash, assignToken, filterMiddleware, flattenRoutePaths, getPathType, isMiddlewareClass, isOptionalParam, isParam, isRequestMethodAll, isRouteExcluded, isWildcard, mapToClass, mapToExcludeRoute, normalizePath, stripEndSlash, targetModulesByContainer };