@nestjs/common 9.1.5 → 9.2.0

package/Readme.md

@@ -90,7 +90,9 @@ Nest is an MIT-licensed open source project. It can grow thanks to the sponsors
 <a href="https://www.castlecraft.in" target="_blank"><img src="https://nestjs.com/img/castlecraft-logo.png" width="150" valign="middle" /></td>
 <td><a href="https://www.tinystacks.com" target="_blank"><img src="https://nestjs.com/img/tinystacks-logo.png#1" width="140" valign="middle" /></td>
 <td><a href="https://n.inc" target="_blank"><img src="https://nestjs.com/img/n-inc-logo.svg" width="120" valign="middle" /></td></tr><tr>
-<td><a href="https://bilberrry.com/" target="_blank"><img src="https://nestjs.com/img/bilberrry-logo.svg" width="180" valign="middle" /></td></tr></table>
+<td><a href="https://bilberrry.com/" target="_blank"><img src="https://nestjs.com/img/bilberrry-logo.svg" width="180" valign="middle" /></td>
+<td><a href="https://ipinfo.ai/" target="_blank"><img src="https://nestjs.com/img/ipinfo-logo.png" width="130" valign="middle" /></td></tr>
+</table>
 
 #### Sponsors
 

package/cache/cache.providers.js

@@ -13,19 +13,25 @@ const default_options_1 = require("./default-options");
 function createCacheManager() {
     return {
         provide: cache_constants_1.CACHE_MANAGER,
-        useFactory: (options) => {
+        useFactory: async (options) => {
             const cacheManager = (0, load_package_util_1.loadPackage)('cache-manager', 'CacheModule', () => require('cache-manager'));
-            // eslint-disable-next-line @typescript-eslint/no-var-requires
-            const cacheManagerVersion = require('cache-manager/package.json').version;
-            const cacheManagerMajor = cacheManagerVersion.split('.')[0];
-            const cachingFactory = (store, options) => {
-                if (cacheManagerMajor < 5) {
+            const cacheManagerIsv5OrGreater = 'memoryStore' in cacheManager;
+            const cachingFactory = async (store, options) => {
+                if (!cacheManagerIsv5OrGreater) {
                     return cacheManager.caching(Object.assign(Object.assign({}, default_options_1.defaultCacheOptions), Object.assign(Object.assign({}, options), { store })));
                 }
-                return cacheManager.caching(store !== null && store !== void 0 ? store : 'memory', Object.assign(Object.assign({}, default_options_1.defaultCacheOptions), options));
+                let cache = 'memory';
+                default_options_1.defaultCacheOptions.ttl *= 1000;
+                if (typeof store === 'object' && 'create' in store) {
+                    cache = store.create;
+                }
+                else if (typeof store === 'function') {
+                    cache = store;
+                }
+                return cacheManager.caching(cache, Object.assign(Object.assign({}, default_options_1.defaultCacheOptions), options));
             };
             return Array.isArray(options)
-                ? cacheManager.multiCaching(options.map(option => cachingFactory(options.store, option)))
+                ? cacheManager.multiCaching(await Promise.all(options.map(option => cachingFactory(option.store, option))))
                 : cachingFactory(options.store, options);
         },
         inject: [cache_module_definition_1.MODULE_OPTIONS_TOKEN],

package/cache/interfaces/cache-manager.interface.d.ts

@@ -14,7 +14,7 @@ export interface CacheStore {
      * @param key cache key
      * @param value cache value
      */
-    set<T>(key: string, value: T, options?: CacheStoreSetOptions<T>): Promise<void> | void;
+    set<T>(key: string, value: T, options?: CacheStoreSetOptions<T> | number): Promise<void> | void;
     /**
      * Retrieve a key/value pair from the cache.
      *
@@ -62,9 +62,10 @@ export interface CacheManagerOptions {
      */
     store?: string | CacheStoreFactory | CacheStore;
     /**
-     * Time to live - amount of time in seconds that a response is cached before it
+     * Time to live - amount of time that a response is cached before it
      * is deleted. Subsequent request will call through the route handler and refresh
-     * the cache.  Defaults to 5 seconds.
+     * the cache.  Defaults to 5 seconds. In `cache-manager@^4` this value is in seconds.
+     * In `cache-manager@^5` this value is in milliseconds.
      */
     ttl?: number;
     /**

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

@@ -1,4 +1,4 @@
-import { HttpException } from './http.exception';
+import { HttpException, HttpExceptionOptions } from './http.exception';
 /**
  * Defines an HTTP exception for *Bad Gateway* type errors.
  *
@@ -16,7 +16,7 @@ export declare class BadGatewayException extends HttpException {
      * @usageNotes
      * The HTTP response status code will be 502.
      * - The `objectOrError` argument defines the JSON response body or the message string.
-     * - The `description` argument contains a short description of the HTTP error.
+     * - 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.
@@ -29,7 +29,7 @@ export declare class BadGatewayException extends HttpException {
      * and return it as the JSON response body.
      *
      * @param objectOrError string or object describing the error condition.
-     * @param description a short description of the HTTP error.
+     * @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, description?: string);
+    constructor(objectOrError?: string | object | any, descriptionOrOptions?: string | HttpExceptionOptions);
 }

package/exceptions/bad-gateway.exception.js

@@ -20,7 +20,7 @@ class BadGatewayException extends http_exception_1.HttpException {
      * @usageNotes
      * The HTTP response status code will be 502.
      * - The `objectOrError` argument defines the JSON response body or the message string.
-     * - The `description` argument contains a short description of the HTTP error.
+     * - 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.
@@ -33,10 +33,11 @@ class BadGatewayException extends http_exception_1.HttpException {
      * and return it as the JSON response body.
      *
      * @param objectOrError string or object describing the error condition.
-     * @param description a short description of the HTTP error.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
      */
-    constructor(objectOrError, description = 'Bad Gateway') {
-        super(http_exception_1.HttpException.createBody(objectOrError, description, http_status_enum_1.HttpStatus.BAD_GATEWAY), http_status_enum_1.HttpStatus.BAD_GATEWAY);
+    constructor(objectOrError, descriptionOrOptions = 'Bad Gateway') {
+        const { description, httpExceptionOptions } = http_exception_1.HttpException.extractDescriptionAndOptionsFrom(descriptionOrOptions);
+        super(http_exception_1.HttpException.createBody(objectOrError, description, http_status_enum_1.HttpStatus.BAD_GATEWAY), http_status_enum_1.HttpStatus.BAD_GATEWAY, httpExceptionOptions);
     }
 }
 exports.BadGatewayException = BadGatewayException;

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

@@ -1,4 +1,4 @@
-import { HttpException } from './http.exception';
+import { HttpException, HttpExceptionOptions } from './http.exception';
 /**
  * Defines an HTTP exception for *Bad Request* type errors.
  *
@@ -16,7 +16,7 @@ export declare class BadRequestException extends HttpException {
      * @usageNotes
      * The HTTP response status code will be 400.
      * - The `objectOrError` argument defines the JSON response body or the message string.
-     * - The `description` argument contains a short description of the HTTP error.
+     * - 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.
@@ -29,7 +29,7 @@ export declare class BadRequestException extends HttpException {
      * and return it as the JSON response body.
      *
      * @param objectOrError string or object describing the error condition.
-     * @param description a short description of the HTTP error.
+     * @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, description?: string);
+    constructor(objectOrError?: string | object | any, descriptionOrOptions?: string | HttpExceptionOptions);
 }

package/exceptions/bad-request.exception.js

@@ -20,7 +20,7 @@ class BadRequestException extends http_exception_1.HttpException {
      * @usageNotes
      * The HTTP response status code will be 400.
      * - The `objectOrError` argument defines the JSON response body or the message string.
-     * - The `description` argument contains a short description of the HTTP error.
+     * - 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.
@@ -33,10 +33,11 @@ class BadRequestException extends http_exception_1.HttpException {
      * and return it as the JSON response body.
      *
      * @param objectOrError string or object describing the error condition.
-     * @param description a short description of the HTTP error.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
      */
-    constructor(objectOrError, description = 'Bad Request') {
-        super(http_exception_1.HttpException.createBody(objectOrError, description, http_status_enum_1.HttpStatus.BAD_REQUEST), http_status_enum_1.HttpStatus.BAD_REQUEST);
+    constructor(objectOrError, descriptionOrOptions = 'Bad Request') {
+        const { description, httpExceptionOptions } = http_exception_1.HttpException.extractDescriptionAndOptionsFrom(descriptionOrOptions);
+        super(http_exception_1.HttpException.createBody(objectOrError, description, http_status_enum_1.HttpStatus.BAD_REQUEST), http_status_enum_1.HttpStatus.BAD_REQUEST, httpExceptionOptions);
     }
 }
 exports.BadRequestException = BadRequestException;

package/exceptions/conflict.exception.d.ts

@@ -1,4 +1,4 @@
-import { HttpException } from './http.exception';
+import { HttpException, HttpExceptionOptions } from './http.exception';
 /**
  * Defines an HTTP exception for *Conflict* type errors.
  *
@@ -16,7 +16,7 @@ export declare class ConflictException extends HttpException {
      * @usageNotes
      * The HTTP response status code will be 409.
      * - The `objectOrError` argument defines the JSON response body or the message string.
-     * - The `description` argument contains a short description of the HTTP error.
+     * - 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.
@@ -29,7 +29,7 @@ export declare class ConflictException extends HttpException {
      * and return it as the JSON response body.
      *
      * @param objectOrError string or object describing the error condition.
-     * @param description a short description of the HTTP error.
+     * @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, description?: string);
+    constructor(objectOrError?: string | object | any, descriptionOrOptions?: string | HttpExceptionOptions);
 }

package/exceptions/conflict.exception.js

@@ -20,7 +20,7 @@ class ConflictException extends http_exception_1.HttpException {
      * @usageNotes
      * The HTTP response status code will be 409.
      * - The `objectOrError` argument defines the JSON response body or the message string.
-     * - The `description` argument contains a short description of the HTTP error.
+     * - 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.
@@ -33,10 +33,11 @@ class ConflictException extends http_exception_1.HttpException {
      * and return it as the JSON response body.
      *
      * @param objectOrError string or object describing the error condition.
-     * @param description a short description of the HTTP error.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
      */
-    constructor(objectOrError, description = 'Conflict') {
-        super(http_exception_1.HttpException.createBody(objectOrError, description, http_status_enum_1.HttpStatus.CONFLICT), http_status_enum_1.HttpStatus.CONFLICT);
+    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

@@ -1,4 +1,4 @@
-import { HttpException } from './http.exception';
+import { HttpException, HttpExceptionOptions } from './http.exception';
 /**
  * Defines an HTTP exception for *Forbidden* type errors.
  *
@@ -16,7 +16,7 @@ export declare class ForbiddenException extends HttpException {
      * @usageNotes
      * The HTTP response status code will be 403.
      * - The `objectOrError` argument defines the JSON response body or the message string.
-     * - The `description` argument contains a short description of the HTTP error.
+     * - 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.
@@ -29,7 +29,7 @@ export declare class ForbiddenException extends HttpException {
      * and return it as the JSON response body.
      *
      * @param objectOrError string or object describing the error condition.
-     * @param description a short description of the HTTP error.
+     * @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, description?: string);
+    constructor(objectOrError?: string | object | any, descriptionOrOptions?: string | HttpExceptionOptions);
 }

package/exceptions/forbidden.exception.js

@@ -20,7 +20,7 @@ class ForbiddenException extends http_exception_1.HttpException {
      * @usageNotes
      * The HTTP response status code will be 403.
      * - The `objectOrError` argument defines the JSON response body or the message string.
-     * - The `description` argument contains a short description of the HTTP error.
+     * - 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.
@@ -33,10 +33,11 @@ class ForbiddenException extends http_exception_1.HttpException {
      * and return it as the JSON response body.
      *
      * @param objectOrError string or object describing the error condition.
-     * @param description a short description of the HTTP error.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
      */
-    constructor(objectOrError, description = 'Forbidden') {
-        super(http_exception_1.HttpException.createBody(objectOrError, description, http_status_enum_1.HttpStatus.FORBIDDEN), http_status_enum_1.HttpStatus.FORBIDDEN);
+    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

@@ -1,4 +1,4 @@
-import { HttpException } from './http.exception';
+import { HttpException, HttpExceptionOptions } from './http.exception';
 /**
  * Defines an HTTP exception for *Gateway Timeout* type errors.
  *
@@ -16,7 +16,7 @@ export declare class GatewayTimeoutException extends HttpException {
      * @usageNotes
      * The HTTP response status code will be 504.
      * - The `objectOrError` argument defines the JSON response body or the message string.
-     * - The `description` argument contains a short description of the HTTP error.
+     * - 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.
@@ -29,7 +29,7 @@ export declare class GatewayTimeoutException extends HttpException {
      * and return it as the JSON response body.
      *
      * @param objectOrError string or object describing the error condition.
-     * @param description a short description of the HTTP error.
+     * @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, description?: string);
+    constructor(objectOrError?: string | object | any, descriptionOrOptions?: string | HttpExceptionOptions);
 }

package/exceptions/gateway-timeout.exception.js

@@ -20,7 +20,7 @@ class GatewayTimeoutException extends http_exception_1.HttpException {
      * @usageNotes
      * The HTTP response status code will be 504.
      * - The `objectOrError` argument defines the JSON response body or the message string.
-     * - The `description` argument contains a short description of the HTTP error.
+     * - 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.
@@ -33,10 +33,11 @@ class GatewayTimeoutException extends http_exception_1.HttpException {
      * and return it as the JSON response body.
      *
      * @param objectOrError string or object describing the error condition.
-     * @param description a short description of the HTTP error.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
      */
-    constructor(objectOrError, description = 'Gateway Timeout') {
-        super(http_exception_1.HttpException.createBody(objectOrError, description, http_status_enum_1.HttpStatus.GATEWAY_TIMEOUT), http_status_enum_1.HttpStatus.GATEWAY_TIMEOUT);
+    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

@@ -1,4 +1,4 @@
-import { HttpException } from './http.exception';
+import { HttpException, HttpExceptionOptions } from './http.exception';
 /**
  * Defines an HTTP exception for *Gone* type errors.
  *
@@ -16,7 +16,7 @@ export declare class GoneException extends HttpException {
      * @usageNotes
      * The HTTP response status code will be 410.
      * - The `objectOrError` argument defines the JSON response body or the message string.
-     * - The `description` argument contains a short description of the HTTP error.
+     * - 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.
@@ -29,7 +29,7 @@ export declare class GoneException extends HttpException {
      * and return it as the JSON response body.
      *
      * @param objectOrError string or object describing the error condition.
-     * @param description a short description of the HTTP error.
+     * @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, description?: string);
+    constructor(objectOrError?: string | object | any, descriptionOrOptions?: string | HttpExceptionOptions);
 }

package/exceptions/gone.exception.js

@@ -20,7 +20,7 @@ class GoneException extends http_exception_1.HttpException {
      * @usageNotes
      * The HTTP response status code will be 410.
      * - The `objectOrError` argument defines the JSON response body or the message string.
-     * - The `description` argument contains a short description of the HTTP error.
+     * - 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.
@@ -33,10 +33,11 @@ class GoneException extends http_exception_1.HttpException {
      * and return it as the JSON response body.
      *
      * @param objectOrError string or object describing the error condition.
-     * @param description a short description of the HTTP error.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
      */
-    constructor(objectOrError, description = 'Gone') {
-        super(http_exception_1.HttpException.createBody(objectOrError, description, http_status_enum_1.HttpStatus.GONE), http_status_enum_1.HttpStatus.GONE);
+    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

@@ -1,4 +1,4 @@
-import { HttpException } from './http.exception';
+import { HttpException, HttpExceptionOptions } from './http.exception';
 /**
  * Defines an HTTP exception for *Http Version Not Supported* type errors.
  *
@@ -16,7 +16,7 @@ export declare class HttpVersionNotSupportedException extends HttpException {
      * @usageNotes
      * The HTTP response status code will be 505.
      * - The `objectOrError` argument defines the JSON response body or the message string.
-     * - The `description` argument contains a short description of the HTTP error.
+     * - 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.
@@ -29,7 +29,7 @@ export declare class HttpVersionNotSupportedException extends HttpException {
      * and return it as the JSON response body.
      *
      * @param objectOrError string or object describing the error condition.
-     * @param description a short description of the HTTP error.
+     * @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, description?: string);
+    constructor(objectOrError?: string | object | any, descriptionOrOptions?: string | HttpExceptionOptions);
 }

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

@@ -20,7 +20,7 @@ class HttpVersionNotSupportedException extends http_exception_1.HttpException {
      * @usageNotes
      * The HTTP response status code will be 505.
      * - The `objectOrError` argument defines the JSON response body or the message string.
-     * - The `description` argument contains a short description of the HTTP error.
+     * - 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.
@@ -33,10 +33,11 @@ class HttpVersionNotSupportedException extends http_exception_1.HttpException {
      * and return it as the JSON response body.
      *
      * @param objectOrError string or object describing the error condition.
-     * @param description a short description of the HTTP error.
+     * @param descriptionOrOptions either a short description of the HTTP error or an options object used to provide an underlying error cause
      */
-    constructor(objectOrError, description = 'HTTP Version Not Supported') {
-        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);
+    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

@@ -1,3 +1,11 @@
+export interface HttpExceptionOptions {
+    cause?: Error;
+    description?: string;
+}
+export interface DescriptionAndOptions {
+    description?: string;
+    httpExceptionOptions?: HttpExceptionOptions;
+}
 /**
  * Defines the base Nest HTTP exception, which is handled by the default
  * Exceptions Handler.
@@ -9,16 +17,27 @@
 export declare class HttpException extends Error {
     private readonly response;
     private readonly status;
+    private readonly options?;
     /**
      * Instantiate a plain HTTP Exception.
      *
      * @example
-     * `throw new HttpException()`
+     * throw new HttpException()
+     * throw new HttpException('message', HttpStatus.BAD_REQUEST)
+     * throw new HttpException({ reason: 'this can be a human readable reason' }, HttpStatus.BAD_REQUEST)
+     * throw new HttpException(new Error('Cause Error'), 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.
+     * - 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.
@@ -31,10 +50,11 @@ export declare class HttpException extends Error {
      * 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 or object describing the error condition.
+     * @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);
+    constructor(response: string | Record<string, any>, status: number, options?: HttpExceptionOptions);
     cause: Error | undefined;
     /**
      * Configures error chaining support
@@ -48,5 +68,13 @@ export declare class HttpException extends Error {
     initName(): void;
     getResponse(): string | object;
     getStatus(): number;
-    static createBody(objectOrError: object | string, description?: string, statusCode?: number): object;
+    static createBody(objectOrErrorMessage: object | string, description?: string, statusCode?: number): object;
+    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

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HttpException = void 0;
+const services_1 = require("../services");
 const shared_utils_1 = require("../utils/shared.utils");
 /**
  * Defines the base Nest HTTP exception, which is handled by the default
@@ -15,12 +16,22 @@ class HttpException extends Error {
      * Instantiate a plain HTTP Exception.
      *
      * @example
-     * `throw new HttpException()`
+     * throw new HttpException()
+     * throw new HttpException('message', HttpStatus.BAD_REQUEST)
+     * throw new HttpException({ reason: 'this can be a human readable reason' }, HttpStatus.BAD_REQUEST)
+     * throw new HttpException(new Error('Cause Error'), 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.
+     * - 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.
@@ -33,13 +44,15 @@ class HttpException extends Error {
      * 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 or object describing the error condition.
+     * @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) {
+    constructor(response, status, options) {
         super();
         this.response = response;
         this.status = status;
+        this.options = options;
         this.initMessage();
         this.initName();
         this.initCause();
@@ -52,7 +65,13 @@ class HttpException extends Error {
      * - https://github.com/microsoft/TypeScript/issues/45167
      */
     initCause() {
+        var _a;
+        if ((_a = this.options) === null || _a === void 0 ? void 0 : _a.cause) {
+            this.cause = this.options.cause;
+            return;
+        }
         if (this.response instanceof Error) {
+            services_1.Logger.warn('DEPRECATED! Passing the error cause as the first argument to HttpException constructor is deprecated. You should use the "options" parameter instead: new HttpException("message", 400, { cause: new Error("Some Error") }) ');
             this.cause = this.response;
         }
     }
@@ -79,13 +98,39 @@ class HttpException extends Error {
     getStatus() {
         return this.status;
     }
-    static createBody(objectOrError, description, statusCode) {
-        if (!objectOrError) {
+    static createBody(objectOrErrorMessage, description, statusCode) {
+        if (!objectOrErrorMessage) {
             return { statusCode, message: description };
         }
-        return (0, shared_utils_1.isObject)(objectOrError) && !Array.isArray(objectOrError)
-            ? objectOrError
-            : { statusCode, message: objectOrError, error: description };
+        return (0, shared_utils_1.isObject)(objectOrErrorMessage) &&
+            !Array.isArray(objectOrErrorMessage)
+            ? objectOrErrorMessage
+            : { statusCode, message: objectOrErrorMessage, error: description };
+    }
+    static getDescriptionFrom(descriptionOrOptions) {
+        return (0, shared_utils_1.isString)(descriptionOrOptions)
+            ? descriptionOrOptions
+            : descriptionOrOptions === null || descriptionOrOptions === void 0 ? void 0 : 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 === null || descriptionOrOptions === void 0 ? void 0 : 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

@@ -1,4 +1,4 @@
-import { HttpException } from './http.exception';
+import { HttpException, HttpExceptionOptions } from './http.exception';
 /**
  * Defines an HTTP exception for *ImATeapotException* type errors.
  *
@@ -19,7 +19,7 @@ export declare class ImATeapotException extends HttpException {
      * @usageNotes
      * The HTTP response status code will be 418.
      * - The `objectOrError` argument defines the JSON response body or the message string.
-     * - The `description` argument contains a short description of the HTTP error.
+     * - 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.
@@ -32,7 +32,7 @@ export declare class ImATeapotException extends HttpException {
      * and return it as the JSON response body.
      *
      * @param objectOrError string or object describing the error condition.
-     * @param description a short description of the HTTP error.
+     * @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, description?: string);
+    constructor(objectOrError?: string | object | any, descriptionOrOptions?: string | HttpExceptionOptions);
 }