@venok/http 1.0.1-canary.0

package/decorators/sse.decorator.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Sse = void 0;
+const constants_1 = require("@venok/http/constants");
+const enums_1 = require("@venok/http/enums");
+/**
+ * Declares this route as a Server-Sent-Events endpoint
+ *
+ * @publicApi
+ */
+function Sse(path) {
+    return (target, key, descriptor) => {
+        path = path && path.length ? path : "/";
+        Reflect.defineMetadata(constants_1.PATH_METADATA, path, descriptor.value);
+        Reflect.defineMetadata(constants_1.METHOD_METADATA, enums_1.RequestMethod.GET, descriptor.value);
+        Reflect.defineMetadata(constants_1.SSE_METADATA, true, descriptor.value);
+        return descriptor;
+    };
+}
+exports.Sse = Sse;

package/decorators/version.decorator.d.ts

@@ -0,0 +1,7 @@
+import { VersionValue } from "../interfaces";
+/**
+ * Sets the version of the endpoint to the passed version
+ *
+ * @publicApi
+ */
+export declare function Version(version: VersionValue): MethodDecorator;

package/decorators/version.decorator.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Version = void 0;
+const constants_1 = require("@venok/http/constants");
+/**
+ * Sets the version of the endpoint to the passed version
+ *
+ * @publicApi
+ */
+function Version(version) {
+    if (Array.isArray(version)) {
+        // Drop duplicated versions
+        version = Array.from(new Set(version));
+    }
+    return (target, key, descriptor) => {
+        Reflect.defineMetadata(constants_1.VERSION_METADATA, version, descriptor.value);
+        return descriptor;
+    };
+}
+exports.Version = Version;

package/enums/http-status.enum.d.ts

@@ -0,0 +1,53 @@
+/**
+ * @publicApi
+ */
+export 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
+}

package/enums/http-status.enum.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpStatus = void 0;
+/**
+ * @publicApi
+ */
+var HttpStatus;
+(function (HttpStatus) {
+    HttpStatus[HttpStatus["CONTINUE"] = 100] = "CONTINUE";
+    HttpStatus[HttpStatus["SWITCHING_PROTOCOLS"] = 101] = "SWITCHING_PROTOCOLS";
+    HttpStatus[HttpStatus["PROCESSING"] = 102] = "PROCESSING";
+    HttpStatus[HttpStatus["EARLYHINTS"] = 103] = "EARLYHINTS";
+    HttpStatus[HttpStatus["OK"] = 200] = "OK";
+    HttpStatus[HttpStatus["CREATED"] = 201] = "CREATED";
+    HttpStatus[HttpStatus["ACCEPTED"] = 202] = "ACCEPTED";
+    HttpStatus[HttpStatus["NON_AUTHORITATIVE_INFORMATION"] = 203] = "NON_AUTHORITATIVE_INFORMATION";
+    HttpStatus[HttpStatus["NO_CONTENT"] = 204] = "NO_CONTENT";
+    HttpStatus[HttpStatus["RESET_CONTENT"] = 205] = "RESET_CONTENT";
+    HttpStatus[HttpStatus["PARTIAL_CONTENT"] = 206] = "PARTIAL_CONTENT";
+    HttpStatus[HttpStatus["AMBIGUOUS"] = 300] = "AMBIGUOUS";
+    HttpStatus[HttpStatus["MOVED_PERMANENTLY"] = 301] = "MOVED_PERMANENTLY";
+    HttpStatus[HttpStatus["FOUND"] = 302] = "FOUND";
+    HttpStatus[HttpStatus["SEE_OTHER"] = 303] = "SEE_OTHER";
+    HttpStatus[HttpStatus["NOT_MODIFIED"] = 304] = "NOT_MODIFIED";
+    HttpStatus[HttpStatus["TEMPORARY_REDIRECT"] = 307] = "TEMPORARY_REDIRECT";
+    HttpStatus[HttpStatus["PERMANENT_REDIRECT"] = 308] = "PERMANENT_REDIRECT";
+    HttpStatus[HttpStatus["BAD_REQUEST"] = 400] = "BAD_REQUEST";
+    HttpStatus[HttpStatus["UNAUTHORIZED"] = 401] = "UNAUTHORIZED";
+    HttpStatus[HttpStatus["PAYMENT_REQUIRED"] = 402] = "PAYMENT_REQUIRED";
+    HttpStatus[HttpStatus["FORBIDDEN"] = 403] = "FORBIDDEN";
+    HttpStatus[HttpStatus["NOT_FOUND"] = 404] = "NOT_FOUND";
+    HttpStatus[HttpStatus["METHOD_NOT_ALLOWED"] = 405] = "METHOD_NOT_ALLOWED";
+    HttpStatus[HttpStatus["NOT_ACCEPTABLE"] = 406] = "NOT_ACCEPTABLE";
+    HttpStatus[HttpStatus["PROXY_AUTHENTICATION_REQUIRED"] = 407] = "PROXY_AUTHENTICATION_REQUIRED";
+    HttpStatus[HttpStatus["REQUEST_TIMEOUT"] = 408] = "REQUEST_TIMEOUT";
+    HttpStatus[HttpStatus["CONFLICT"] = 409] = "CONFLICT";
+    HttpStatus[HttpStatus["GONE"] = 410] = "GONE";
+    HttpStatus[HttpStatus["LENGTH_REQUIRED"] = 411] = "LENGTH_REQUIRED";
+    HttpStatus[HttpStatus["PRECONDITION_FAILED"] = 412] = "PRECONDITION_FAILED";
+    HttpStatus[HttpStatus["PAYLOAD_TOO_LARGE"] = 413] = "PAYLOAD_TOO_LARGE";
+    HttpStatus[HttpStatus["URI_TOO_LONG"] = 414] = "URI_TOO_LONG";
+    HttpStatus[HttpStatus["UNSUPPORTED_MEDIA_TYPE"] = 415] = "UNSUPPORTED_MEDIA_TYPE";
+    HttpStatus[HttpStatus["REQUESTED_RANGE_NOT_SATISFIABLE"] = 416] = "REQUESTED_RANGE_NOT_SATISFIABLE";
+    HttpStatus[HttpStatus["EXPECTATION_FAILED"] = 417] = "EXPECTATION_FAILED";
+    HttpStatus[HttpStatus["I_AM_A_TEAPOT"] = 418] = "I_AM_A_TEAPOT";
+    HttpStatus[HttpStatus["MISDIRECTED"] = 421] = "MISDIRECTED";
+    HttpStatus[HttpStatus["UNPROCESSABLE_ENTITY"] = 422] = "UNPROCESSABLE_ENTITY";
+    HttpStatus[HttpStatus["FAILED_DEPENDENCY"] = 424] = "FAILED_DEPENDENCY";
+    HttpStatus[HttpStatus["PRECONDITION_REQUIRED"] = 428] = "PRECONDITION_REQUIRED";
+    HttpStatus[HttpStatus["TOO_MANY_REQUESTS"] = 429] = "TOO_MANY_REQUESTS";
+    HttpStatus[HttpStatus["INTERNAL_SERVER_ERROR"] = 500] = "INTERNAL_SERVER_ERROR";
+    HttpStatus[HttpStatus["NOT_IMPLEMENTED"] = 501] = "NOT_IMPLEMENTED";
+    HttpStatus[HttpStatus["BAD_GATEWAY"] = 502] = "BAD_GATEWAY";
+    HttpStatus[HttpStatus["SERVICE_UNAVAILABLE"] = 503] = "SERVICE_UNAVAILABLE";
+    HttpStatus[HttpStatus["GATEWAY_TIMEOUT"] = 504] = "GATEWAY_TIMEOUT";
+    HttpStatus[HttpStatus["HTTP_VERSION_NOT_SUPPORTED"] = 505] = "HTTP_VERSION_NOT_SUPPORTED";
+})(HttpStatus || (exports.HttpStatus = HttpStatus = {}));

package/enums/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./request-method.enum";
+export * from "./http-status.enum";
+export * from "./route-paramtypes.enum";
+export * from "./version-type.enum";

package/enums/index.js

@@ -0,0 +1,20 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./request-method.enum"), exports);
+__exportStar(require("./http-status.enum"), exports);
+__exportStar(require("./route-paramtypes.enum"), exports);
+__exportStar(require("./version-type.enum"), exports);

package/enums/request-method.enum.d.ts

@@ -0,0 +1,11 @@
+export declare enum RequestMethod {
+    GET = 0,
+    POST = 1,
+    PUT = 2,
+    DELETE = 3,
+    PATCH = 4,
+    ALL = 5,
+    OPTIONS = 6,
+    HEAD = 7,
+    SEARCH = 8
+}

package/enums/request-method.enum.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RequestMethod = void 0;
+var RequestMethod;
+(function (RequestMethod) {
+    RequestMethod[RequestMethod["GET"] = 0] = "GET";
+    RequestMethod[RequestMethod["POST"] = 1] = "POST";
+    RequestMethod[RequestMethod["PUT"] = 2] = "PUT";
+    RequestMethod[RequestMethod["DELETE"] = 3] = "DELETE";
+    RequestMethod[RequestMethod["PATCH"] = 4] = "PATCH";
+    RequestMethod[RequestMethod["ALL"] = 5] = "ALL";
+    RequestMethod[RequestMethod["OPTIONS"] = 6] = "OPTIONS";
+    RequestMethod[RequestMethod["HEAD"] = 7] = "HEAD";
+    RequestMethod[RequestMethod["SEARCH"] = 8] = "SEARCH";
+})(RequestMethod || (exports.RequestMethod = RequestMethod = {}));

package/enums/route-paramtypes.enum.d.ts

@@ -0,0 +1,14 @@
+export declare enum RouteParamtypes {
+    REQUEST = 0,
+    RESPONSE = 1,
+    NEXT = 2,
+    BODY = 3,
+    QUERY = 4,
+    PARAM = 5,
+    HEADERS = 6,
+    SESSION = 7,
+    FILE = 8,
+    FILES = 9,
+    HOST = 10,
+    IP = 11
+}

package/enums/route-paramtypes.enum.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RouteParamtypes = void 0;
+var RouteParamtypes;
+(function (RouteParamtypes) {
+    RouteParamtypes[RouteParamtypes["REQUEST"] = 0] = "REQUEST";
+    RouteParamtypes[RouteParamtypes["RESPONSE"] = 1] = "RESPONSE";
+    RouteParamtypes[RouteParamtypes["NEXT"] = 2] = "NEXT";
+    RouteParamtypes[RouteParamtypes["BODY"] = 3] = "BODY";
+    RouteParamtypes[RouteParamtypes["QUERY"] = 4] = "QUERY";
+    RouteParamtypes[RouteParamtypes["PARAM"] = 5] = "PARAM";
+    RouteParamtypes[RouteParamtypes["HEADERS"] = 6] = "HEADERS";
+    RouteParamtypes[RouteParamtypes["SESSION"] = 7] = "SESSION";
+    RouteParamtypes[RouteParamtypes["FILE"] = 8] = "FILE";
+    RouteParamtypes[RouteParamtypes["FILES"] = 9] = "FILES";
+    RouteParamtypes[RouteParamtypes["HOST"] = 10] = "HOST";
+    RouteParamtypes[RouteParamtypes["IP"] = 11] = "IP";
+})(RouteParamtypes || (exports.RouteParamtypes = RouteParamtypes = {}));

package/enums/version-type.enum.d.ts

@@ -0,0 +1,9 @@
+/**
+ * @publicApi
+ */
+export declare enum VersioningType {
+    URI = 0,
+    HEADER = 1,
+    MEDIA_TYPE = 2,
+    CUSTOM = 3
+}

package/enums/version-type.enum.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VersioningType = void 0;
+/**
+ * @publicApi
+ */
+var VersioningType;
+(function (VersioningType) {
+    VersioningType[VersioningType["URI"] = 0] = "URI";
+    VersioningType[VersioningType["HEADER"] = 1] = "HEADER";
+    VersioningType[VersioningType["MEDIA_TYPE"] = 2] = "MEDIA_TYPE";
+    VersioningType[VersioningType["CUSTOM"] = 3] = "CUSTOM";
+})(VersioningType || (exports.VersioningType = VersioningType = {}));

package/errors/bad-gateway.exception.d.ts

@@ -0,0 +1,33 @@
+import { HttpException, HttpExceptionOptions } from "./http.exception";
+/**
+ * Defines an HTTP exception for *Bad Gateway* type errors.
+ *
+ * @publicApi
+ */
+export declare class BadGatewayException extends HttpException {
+    /**
+     * Instantiate a `BadGatewayException` Exception.
+     *
+     * @example
+     * `throw new BadGatewayException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 502.
+     * - The `objectOrError` argument defines the JSON response body 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 `objectOrError` parameter.
+     *
+     * If the parameter `objectOrError` is a string, the response body will contain an
+     * additional property, `error`, 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 objectOrError 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(objectOrError?: string | object | any, descriptionOrOptions?: string | HttpExceptionOptions);
+}

package/errors/bad-gateway.exception.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BadGatewayException = void 0;
+const enums_1 = require("../enums");
+const http_exception_1 = require("./http.exception");
+/**
+ * Defines an HTTP exception for *Bad Gateway* type errors.
+ *
+ * @publicApi
+ */
+class BadGatewayException extends http_exception_1.HttpException {
+    /**
+     * Instantiate a `BadGatewayException` Exception.
+     *
+     * @example
+     * `throw new BadGatewayException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 502.
+     * - The `objectOrError` argument defines the JSON response body 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 `objectOrError` parameter.
+     *
+     * If the parameter `objectOrError` is a string, the response body will contain an
+     * additional property, `error`, 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 objectOrError 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(objectOrError, descriptionOrOptions = "Bad Gateway") {
+        const { description, httpExceptionOptions } = http_exception_1.HttpException.extractDescriptionAndOptionsFrom(descriptionOrOptions);
+        super(http_exception_1.HttpException.createBody(objectOrError, description, enums_1.HttpStatus.BAD_GATEWAY), enums_1.HttpStatus.BAD_GATEWAY, httpExceptionOptions);
+    }
+}
+exports.BadGatewayException = BadGatewayException;

package/errors/bad-request.exception.d.ts

@@ -0,0 +1,33 @@
+import { HttpException, HttpExceptionOptions } from "./http.exception";
+/**
+ * Defines an HTTP exception for *Bad Request* type errors.
+ *
+ * @publicApi
+ */
+export declare class BadRequestException extends HttpException {
+    /**
+     * Instantiate a `BadRequestException` Exception.
+     *
+     * @example
+     * `throw new BadRequestException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 400.
+     * - The `objectOrError` argument defines the JSON response body 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 `objectOrError` parameter.
+     *
+     * If the parameter `objectOrError` is a string, the response body will contain an
+     * additional property, `error`, 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 objectOrError 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(objectOrError?: string | object | any, descriptionOrOptions?: string | HttpExceptionOptions);
+}

package/errors/bad-request.exception.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BadRequestException = void 0;
+const enums_1 = require("../enums");
+const http_exception_1 = require("./http.exception");
+/**
+ * Defines an HTTP exception for *Bad Request* type errors.
+ *
+ * @publicApi
+ */
+class BadRequestException extends http_exception_1.HttpException {
+    /**
+     * Instantiate a `BadRequestException` Exception.
+     *
+     * @example
+     * `throw new BadRequestException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 400.
+     * - The `objectOrError` argument defines the JSON response body 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 `objectOrError` parameter.
+     *
+     * If the parameter `objectOrError` is a string, the response body will contain an
+     * additional property, `error`, 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 objectOrError 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(objectOrError, descriptionOrOptions = "Bad Request") {
+        const { description, httpExceptionOptions } = http_exception_1.HttpException.extractDescriptionAndOptionsFrom(descriptionOrOptions);
+        super(http_exception_1.HttpException.createBody(objectOrError, description, enums_1.HttpStatus.BAD_REQUEST), enums_1.HttpStatus.BAD_REQUEST, httpExceptionOptions);
+    }
+}
+exports.BadRequestException = BadRequestException;

package/errors/conflict.exception.d.ts

@@ -0,0 +1,33 @@
+import { HttpException, HttpExceptionOptions } from "./http.exception";
+/**
+ * Defines an HTTP exception for *Conflict* type errors.
+ *
+ * @publicApi
+ */
+export declare class ConflictException extends HttpException {
+    /**
+     * Instantiate a `ConflictException` Exception.
+     *
+     * @example
+     * `throw new ConflictException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 409.
+     * - The `objectOrError` argument defines the JSON response body 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 `objectOrError` parameter.
+     *
+     * If the parameter `objectOrError` is a string, the response body will contain an
+     * additional property, `error`, 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 objectOrError 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(objectOrError?: string | object | any, descriptionOrOptions?: string | HttpExceptionOptions);
+}

package/errors/conflict.exception.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConflictException = void 0;
+const enums_1 = require("../enums");
+const http_exception_1 = require("./http.exception");
+/**
+ * Defines an HTTP exception for *Conflict* type errors.
+ *
+ * @publicApi
+ */
+class ConflictException extends http_exception_1.HttpException {
+    /**
+     * Instantiate a `ConflictException` Exception.
+     *
+     * @example
+     * `throw new ConflictException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 409.
+     * - The `objectOrError` argument defines the JSON response body 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 `objectOrError` parameter.
+     *
+     * If the parameter `objectOrError` is a string, the response body will contain an
+     * additional property, `error`, 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 objectOrError 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(objectOrError, descriptionOrOptions = "Conflict") {
+        const { description, httpExceptionOptions } = http_exception_1.HttpException.extractDescriptionAndOptionsFrom(descriptionOrOptions);
+        super(http_exception_1.HttpException.createBody(objectOrError, description, enums_1.HttpStatus.CONFLICT), enums_1.HttpStatus.CONFLICT, httpExceptionOptions);
+    }
+}
+exports.ConflictException = ConflictException;

package/errors/forbidden.exception.d.ts

@@ -0,0 +1,33 @@
+import { HttpException, HttpExceptionOptions } from "./http.exception";
+/**
+ * Defines an HTTP exception for *Forbidden* type errors.
+ *
+ * @publicApi
+ */
+export declare class ForbiddenException extends HttpException {
+    /**
+     * Instantiate a `ForbiddenException` Exception.
+     *
+     * @example
+     * `throw new ForbiddenException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 403.
+     * - The `objectOrError` argument defines the JSON response body 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 `objectOrError` parameter.
+     *
+     * If the parameter `objectOrError` is a string, the response body will contain an
+     * additional property, `error`, 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 objectOrError 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(objectOrError?: string | object | any, descriptionOrOptions?: string | HttpExceptionOptions);
+}

package/errors/forbidden.exception.js

@@ -0,0 +1,41 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ForbiddenException = void 0;
+const enums_1 = require("../enums");
+const http_exception_1 = require("./http.exception");
+/**
+ * Defines an HTTP exception for *Forbidden* type errors.
+ *
+ * @publicApi
+ */
+class ForbiddenException extends http_exception_1.HttpException {
+    /**
+     * Instantiate a `ForbiddenException` Exception.
+     *
+     * @example
+     * `throw new ForbiddenException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 403.
+     * - The `objectOrError` argument defines the JSON response body 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 `objectOrError` parameter.
+     *
+     * If the parameter `objectOrError` is a string, the response body will contain an
+     * additional property, `error`, 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 objectOrError 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(objectOrError, descriptionOrOptions = "Forbidden") {
+        const { description, httpExceptionOptions } = http_exception_1.HttpException.extractDescriptionAndOptionsFrom(descriptionOrOptions);
+        super(http_exception_1.HttpException.createBody(objectOrError, description, enums_1.HttpStatus.FORBIDDEN), enums_1.HttpStatus.FORBIDDEN, httpExceptionOptions);
+    }
+}
+exports.ForbiddenException = ForbiddenException;

package/errors/gateway-timeout.exception.d.ts

@@ -0,0 +1,33 @@
+import { HttpException, HttpExceptionOptions } from "./http.exception";
+/**
+ * Defines an HTTP exception for *Gateway Timeout* type errors.
+ *
+ * @publicApi
+ */
+export declare class GatewayTimeoutException extends HttpException {
+    /**
+     * Instantiate a `GatewayTimeoutException` Exception.
+     *
+     * @example
+     * `throw new GatewayTimeoutException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 504.
+     * - The `objectOrError` argument defines the JSON response body 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 `objectOrError` parameter.
+     *
+     * If the parameter `objectOrError` is a string, the response body will contain an
+     * additional property, `error`, 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 objectOrError 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(objectOrError?: string | object | any, descriptionOrOptions?: string | HttpExceptionOptions);
+}