@depup/nestjs__common 11.1.16-depup.1

package/exceptions/conflict.exception.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConflictException = void 0;
+const http_status_enum_1 = require("../enums/http-status.enum");
+const http_exception_1 = require("./http.exception");
+/**
+ * Defines an HTTP exception for *Conflict* type errors.
+ *
+ * @see [Built-in HTTP exceptions](https://docs.nestjs.com/exception-filters#built-in-http-exceptions)
+ *
+ * @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. Nest 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, http_status_enum_1.HttpStatus.CONFLICT), http_status_enum_1.HttpStatus.CONFLICT, httpExceptionOptions);
+    }
+}
+exports.ConflictException = ConflictException;

package/exceptions/forbidden.exception.d.ts

@@ -0,0 +1,35 @@
+import { HttpException, HttpExceptionOptions } from './http.exception';
+/**
+ * Defines an HTTP exception for *Forbidden* type errors.
+ *
+ * @see [Built-in HTTP exceptions](https://docs.nestjs.com/exception-filters#built-in-http-exceptions)
+ *
+ * @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. Nest 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?: any, descriptionOrOptions?: string | HttpExceptionOptions);
+}

package/exceptions/forbidden.exception.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ForbiddenException = void 0;
+const http_status_enum_1 = require("../enums/http-status.enum");
+const http_exception_1 = require("./http.exception");
+/**
+ * Defines an HTTP exception for *Forbidden* type errors.
+ *
+ * @see [Built-in HTTP exceptions](https://docs.nestjs.com/exception-filters#built-in-http-exceptions)
+ *
+ * @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. Nest 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, http_status_enum_1.HttpStatus.FORBIDDEN), http_status_enum_1.HttpStatus.FORBIDDEN, httpExceptionOptions);
+    }
+}
+exports.ForbiddenException = ForbiddenException;

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

@@ -0,0 +1,35 @@
+import { HttpException, HttpExceptionOptions } from './http.exception';
+/**
+ * Defines an HTTP exception for *Gateway Timeout* type errors.
+ *
+ * @see [Built-in HTTP exceptions](https://docs.nestjs.com/exception-filters#built-in-http-exceptions)
+ *
+ * @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. Nest 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?: any, descriptionOrOptions?: string | HttpExceptionOptions);
+}

package/exceptions/gateway-timeout.exception.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GatewayTimeoutException = void 0;
+const http_status_enum_1 = require("../enums/http-status.enum");
+const http_exception_1 = require("./http.exception");
+/**
+ * Defines an HTTP exception for *Gateway Timeout* type errors.
+ *
+ * @see [Built-in HTTP exceptions](https://docs.nestjs.com/exception-filters#built-in-http-exceptions)
+ *
+ * @publicApi
+ */
+class GatewayTimeoutException extends http_exception_1.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. Nest 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 = 'Gateway Timeout') {
+        const { description, httpExceptionOptions } = http_exception_1.HttpException.extractDescriptionAndOptionsFrom(descriptionOrOptions);
+        super(http_exception_1.HttpException.createBody(objectOrError, description, http_status_enum_1.HttpStatus.GATEWAY_TIMEOUT), http_status_enum_1.HttpStatus.GATEWAY_TIMEOUT, httpExceptionOptions);
+    }
+}
+exports.GatewayTimeoutException = GatewayTimeoutException;

package/exceptions/gone.exception.d.ts

@@ -0,0 +1,35 @@
+import { HttpException, HttpExceptionOptions } from './http.exception';
+/**
+ * Defines an HTTP exception for *Gone* type errors.
+ *
+ * @see [Built-in HTTP exceptions](https://docs.nestjs.com/exception-filters#built-in-http-exceptions)
+ *
+ * @publicApi
+ */
+export declare class GoneException extends HttpException {
+    /**
+     * Instantiate a `GoneException` Exception.
+     *
+     * @example
+     * `throw new GoneException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 410.
+     * - 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 410.
+     * - `message`: the string `'Gone'` 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. Nest 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?: any, descriptionOrOptions?: string | HttpExceptionOptions);
+}

package/exceptions/gone.exception.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GoneException = void 0;
+const http_status_enum_1 = require("../enums/http-status.enum");
+const http_exception_1 = require("./http.exception");
+/**
+ * Defines an HTTP exception for *Gone* type errors.
+ *
+ * @see [Built-in HTTP exceptions](https://docs.nestjs.com/exception-filters#built-in-http-exceptions)
+ *
+ * @publicApi
+ */
+class GoneException extends http_exception_1.HttpException {
+    /**
+     * Instantiate a `GoneException` Exception.
+     *
+     * @example
+     * `throw new GoneException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 410.
+     * - 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 410.
+     * - `message`: the string `'Gone'` 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. Nest 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 = 'Gone') {
+        const { description, httpExceptionOptions } = http_exception_1.HttpException.extractDescriptionAndOptionsFrom(descriptionOrOptions);
+        super(http_exception_1.HttpException.createBody(objectOrError, description, http_status_enum_1.HttpStatus.GONE), http_status_enum_1.HttpStatus.GONE, httpExceptionOptions);
+    }
+}
+exports.GoneException = GoneException;

package/exceptions/http-version-not-supported.exception.d.ts

@@ -0,0 +1,35 @@
+import { HttpException, HttpExceptionOptions } from './http.exception';
+/**
+ * Defines an HTTP exception for *Http Version Not Supported* type errors.
+ *
+ * @see [Built-in HTTP exceptions](https://docs.nestjs.com/exception-filters#built-in-http-exceptions)
+ *
+ * @publicApi
+ */
+export declare class HttpVersionNotSupportedException extends HttpException {
+    /**
+     * Instantiate a `HttpVersionNotSupportedException` Exception.
+     *
+     * @example
+     * `throw new HttpVersionNotSupportedException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 505.
+     * - 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 505.
+     * - `message`: the string `'HTTP Version Not Supported'` 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. Nest 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?: any, descriptionOrOptions?: string | HttpExceptionOptions);
+}

package/exceptions/http-version-not-supported.exception.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpVersionNotSupportedException = void 0;
+const http_status_enum_1 = require("../enums/http-status.enum");
+const http_exception_1 = require("./http.exception");
+/**
+ * Defines an HTTP exception for *Http Version Not Supported* type errors.
+ *
+ * @see [Built-in HTTP exceptions](https://docs.nestjs.com/exception-filters#built-in-http-exceptions)
+ *
+ * @publicApi
+ */
+class HttpVersionNotSupportedException extends http_exception_1.HttpException {
+    /**
+     * Instantiate a `HttpVersionNotSupportedException` Exception.
+     *
+     * @example
+     * `throw new HttpVersionNotSupportedException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 505.
+     * - 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 505.
+     * - `message`: the string `'HTTP Version Not Supported'` 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. Nest 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 = 'HTTP Version Not Supported') {
+        const { description, httpExceptionOptions } = http_exception_1.HttpException.extractDescriptionAndOptionsFrom(descriptionOrOptions);
+        super(http_exception_1.HttpException.createBody(objectOrError, description, http_status_enum_1.HttpStatus.HTTP_VERSION_NOT_SUPPORTED), http_status_enum_1.HttpStatus.HTTP_VERSION_NOT_SUPPORTED, httpExceptionOptions);
+    }
+}
+exports.HttpVersionNotSupportedException = HttpVersionNotSupportedException;

package/exceptions/http.exception.d.ts

@@ -0,0 +1,85 @@
+import { HttpExceptionBody, HttpExceptionBodyMessage } from '../interfaces/http/http-exception-body.interface';
+import { IntrinsicException } from './intrinsic.exception';
+export interface HttpExceptionOptions {
+    /** original cause of the error */
+    cause?: unknown;
+    description?: string;
+}
+export interface DescriptionAndOptions {
+    description?: string;
+    httpExceptionOptions?: HttpExceptionOptions;
+}
+/**
+ * Defines the base Nest HTTP exception, which is handled by the default
+ * Exceptions Handler.
+ *
+ * @see [Built-in HTTP exceptions](https://docs.nestjs.com/exception-filters#built-in-http-exceptions)
+ *
+ * @publicApi
+ */
+export declare class HttpException extends IntrinsicException {
+    private readonly response;
+    private readonly status;
+    private readonly options?;
+    /**
+     * Exception cause. Indicates the specific original cause of the error.
+     * It is used when catching and re-throwing an error with a more-specific or useful error message in order to still have access to the original error.
+     */
+    cause: unknown;
+    /**
+     * Instantiate a plain HTTP Exception.
+     *
+     * @example
+     * throw new HttpException('message', HttpStatus.BAD_REQUEST)
+     * throw new HttpException('custom message', HttpStatus.BAD_REQUEST, {
+     *  cause: new Error('Cause Error'),
+     * })
+     *
+     *
+     * @usageNotes
+     * The constructor arguments define the response and the HTTP response status code.
+     * - The `response` argument (required) defines the JSON response body. alternatively, it can also be
+     *  an error object that is used to define an error [cause](https://nodejs.org/en/blog/release/v16.9.0/#error-cause).
+     * - 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. Nest 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 imported from `nestjs/common`.
+     *
+     * @param response string, object describing the error condition or the error cause.
+     * @param status HTTP response status code.
+     * @param options An object used to add an error cause.
+     */
+    constructor(response: string | Record<string, any>, status: number, options?: HttpExceptionOptions | undefined);
+    /**
+     * 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;
+    getResponse(): string | object;
+    getStatus(): number;
+    static createBody(nil: null | '', 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): DescriptionAndOptions;
+}

package/exceptions/http.exception.js

@@ -0,0 +1,133 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HttpException = void 0;
+const shared_utils_1 = require("../utils/shared.utils");
+const intrinsic_exception_1 = require("./intrinsic.exception");
+/**
+ * Defines the base Nest HTTP exception, which is handled by the default
+ * Exceptions Handler.
+ *
+ * @see [Built-in HTTP exceptions](https://docs.nestjs.com/exception-filters#built-in-http-exceptions)
+ *
+ * @publicApi
+ */
+class HttpException extends intrinsic_exception_1.IntrinsicException {
+    /**
+     * Instantiate a plain HTTP Exception.
+     *
+     * @example
+     * throw new HttpException('message', HttpStatus.BAD_REQUEST)
+     * throw new HttpException('custom message', HttpStatus.BAD_REQUEST, {
+     *  cause: new Error('Cause Error'),
+     * })
+     *
+     *
+     * @usageNotes
+     * The constructor arguments define the response and the HTTP response status code.
+     * - The `response` argument (required) defines the JSON response body. alternatively, it can also be
+     *  an error object that is used to define an error [cause](https://nodejs.org/en/blog/release/v16.9.0/#error-cause).
+     * - 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. Nest 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 imported from `nestjs/common`.
+     *
+     * @param response string, object describing the error condition or the error cause.
+     * @param status HTTP response status code.
+     * @param options An object used to add an error cause.
+     */
+    constructor(response, status, options) {
+        super();
+        this.response = response;
+        this.status = status;
+        this.options = options;
+        this.initMessage();
+        this.initName();
+        this.initCause();
+    }
+    /**
+     * 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() {
+        if (this.options?.cause) {
+            this.cause = this.options.cause;
+            return;
+        }
+    }
+    initMessage() {
+        if ((0, shared_utils_1.isString)(this.response)) {
+            this.message = this.response;
+        }
+        else if ((0, shared_utils_1.isObject)(this.response) && (0, shared_utils_1.isString)(this.response.message)) {
+            this.message = this.response.message;
+        }
+        else if (this.constructor) {
+            this.message =
+                this.constructor.name.match(/[A-Z][a-z]+|[0-9]+/g)?.join(' ') ??
+                    'Error';
+        }
+    }
+    initName() {
+        this.name = this.constructor.name;
+    }
+    getResponse() {
+        return this.response;
+    }
+    getStatus() {
+        return this.status;
+    }
+    static createBody(arg0, arg1, statusCode) {
+        if (!arg0) {
+            return {
+                message: arg1,
+                statusCode: statusCode,
+            };
+        }
+        if ((0, shared_utils_1.isString)(arg0) || Array.isArray(arg0) || (0, shared_utils_1.isNumber)(arg0)) {
+            return {
+                message: arg0,
+                error: arg1,
+                statusCode: statusCode,
+            };
+        }
+        return arg0;
+    }
+    static getDescriptionFrom(descriptionOrOptions) {
+        return (0, shared_utils_1.isString)(descriptionOrOptions)
+            ? descriptionOrOptions
+            : descriptionOrOptions?.description;
+    }
+    static getHttpExceptionOptionsFrom(descriptionOrOptions) {
+        return (0, shared_utils_1.isString)(descriptionOrOptions) ? {} : descriptionOrOptions;
+    }
+    /**
+     * 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) {
+        const description = (0, shared_utils_1.isString)(descriptionOrOptions)
+            ? descriptionOrOptions
+            : descriptionOrOptions?.description;
+        const httpExceptionOptions = (0, shared_utils_1.isString)(descriptionOrOptions)
+            ? {}
+            : descriptionOrOptions;
+        return {
+            description,
+            httpExceptionOptions,
+        };
+    }
+}
+exports.HttpException = HttpException;

package/exceptions/im-a-teapot.exception.d.ts

@@ -0,0 +1,38 @@
+import { HttpException, HttpExceptionOptions } from './http.exception';
+/**
+ * Defines an HTTP exception for *ImATeapotException* type errors.
+ *
+ * Any attempt to brew coffee with a teapot should result in the error code
+ * "418 I'm a teapot". The resulting entity body MAY be short and stout.
+ *
+ * @see [Built-in HTTP exceptions](https://docs.nestjs.com/exception-filters#built-in-http-exceptions)
+ *
+ * @publicApi
+ */
+export declare class ImATeapotException extends HttpException {
+    /**
+     * Instantiate an `ImATeapotException` Exception.
+     *
+     * @example
+     * `throw new ImATeapotException()`
+     *
+     * @usageNotes
+     * The HTTP response status code will be 418.
+     * - 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 418.
+     * - `message`: the string `"I'm a Teapot"` 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. Nest 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?: any, descriptionOrOptions?: string | HttpExceptionOptions);
+}