@nestjs/common 9.0.0-next.1 → 9.0.1

package/Readme.md

@@ -65,19 +65,20 @@ Nest is an MIT-licensed open source project. It can grow thanks to the sponsors
 <td>
 <a href="https://nx.dev" target="_blank"><img src="https://nestjs.com/img/nx-logo.png" height="45" valign="middle" /></a></td>
     <td>
-<a href="https://valor-software.com/" target="_blank"><img src="https://docs.nestjs.com/assets/sponsors/valor-software.png" width="170" valign="middle" /></a></td>
+<a href="https://valor-software.com/" target="_blank"><img src="https://docs.nestjs.com/assets/sponsors/valor-software.png" width="170" valign="middle" /></a></td><td>
+<a href="https://amplication.com/" target="_blank"><img src="https://nestjs.com/img/amplication-logo.svg" width="190" valign="middle" /></a></td>
 </tr></table>
 
 #### Gold Sponsors
 
 <table style="text-align:center;"><tr><td>
-  <a href="https://careers.labster.com/departments/platform" target="_blank"><img src="https://nestjs.com/img/labster-logo.png" width="170" valign="middle" /></a></td><td>
 <a href="https://weld.app/" target="_blank"><img src="https://nestjs.com/img/weld-logo.svg" width="140" valign="middle" /></a></td>
 <td>
 <a href="https://intrinsic.ventures/" target="_blank"><img src="https://nestjs.com/img/intrinisic-logo.png" width="210" valign="middle" /></a></td>
  <td>
 <a href="https://jetbrains.com/" target="_blank"><img src="https://nestjs.com/img/jetbrains-logo.svg" width="110" valign="middle" /></a></td><td>
-<a href="https://snyk.co/nestjs" target="_blank"><img src="https://nestjs.com/img/snyk-logo-black.png" width="185" valign="middle" /></a></td></</tr></table>
+<a href="https://snyk.co/nestjs" target="_blank"><img src="https://nestjs.com/img/snyk-logo-black.png" width="185" valign="middle" /></a></td><td>
+<a href="https://fuseautotech.com/" target="_blank"><img src="https://nestjs.com/img/fuse-logo.svg" width="105" valign="middle" /></a></td></</tr></table>
 
 #### Silver Sponsors
 
@@ -127,6 +128,8 @@ Nest is an MIT-licensed open source project. It can grow thanks to the sponsors
      <td align="center" valign="middle"><a href="https://polygon-software.ch/" target="_blank"><img src="https://nestjs.com/img/polygon-logo.svg" width="120" valign="middle" /></a></td>
    <td align="center" valign="middle"><a href="https://mobilereality.pl/" target="_blank"><img src="https://nestjs.com/img/mobile-reality-logo.png" width="45" valign="middle" /></a></td>
      <td align="center" valign="middle"><a href="https://boringowl.io/" target="_blank"><img src="https://nestjs.com/img/boringowl-logo.svg" width="120" valign="middle" /></a></td>
+ <td align="center" valign="middle"><a href="https://www.mobilefactory.jp/" target="_blank"><img src="https://nestjs.com/img/mobilefactory-logo.png" width="100" valign="middle" /></a></td>
+ <td align="center" valign="middle"><a href="https://db.nordbot.app/" target="_blank"><img src="https://nestjs.com/img/nord-logo.png" width="50" valign="middle" /></a></td>
   </tr></table>
 
 ## Backers

package/exceptions/http.exception.d.ts

@@ -35,6 +35,15 @@ export declare class HttpException extends Error {
      * @param status HTTP response status code.
      */
     constructor(response: string | Record<string, any>, status: number);
+    cause: Error | undefined;
+    /**
+     * Configures error chaining support
+     *
+     * See:
+     * - https://nodejs.org/en/blog/release/v16.9.0/#error-cause
+     * - https://github.com/microsoft/TypeScript/issues/45167
+     */
+    initCause(): void;
     initMessage(): void;
     initName(): void;
     getResponse(): string | object;

package/exceptions/http.exception.js

@@ -42,6 +42,19 @@ class HttpException extends Error {
         this.status = status;
         this.initMessage();
         this.initName();
+        this.initCause();
+    }
+    /**
+     * Configures error chaining support
+     *
+     * See:
+     * - https://nodejs.org/en/blog/release/v16.9.0/#error-cause
+     * - https://github.com/microsoft/TypeScript/issues/45167
+     */
+    initCause() {
+        if (this.response instanceof Error) {
+            this.cause = this.response;
+        }
     }
     initMessage() {
         if ((0, shared_utils_1.isString)(this.response)) {

package/interfaces/http/http-server.interface.d.ts

@@ -27,8 +27,10 @@ export interface HttpServer<TRequest = any, TResponse = any> {
     listen(port: number | string, hostname: string, callback?: () => void): any;
     reply(response: any, body: any, statusCode?: number): any;
     status(response: any, statusCode: number): any;
+    end(response: any, message?: string): any;
     render(response: any, view: string, options: any): any;
     redirect(response: any, statusCode: number, url: string): any;
+    isHeadersSent(response: any): boolean;
     setHeader(response: any, name: string, value: string): any;
     setErrorHandler?(handler: Function, prefix?: string): any;
     setNotFoundHandler?(handler: Function, prefix?: string): any;

package/interfaces/nest-application-context.interface.d.ts

@@ -61,7 +61,7 @@ export interface INestApplicationContext {
      */
     enableShutdownHooks(signals?: ShutdownSignal[] | string[]): this;
     /**
-     * Initalizes the Nest application.
+     * Initializes the Nest application.
      * Calls the Nest lifecycle events.
      * It isn't mandatory to call this method directly.
      *

package/interfaces/version-options.interface.d.ts

@@ -12,7 +12,7 @@ export declare type VersionValue = string | typeof VERSION_NEUTRAL | Array<strin
 export interface VersionOptions {
     /**
      * Specifies an optional API Version. When configured, methods
-     * withing the controller will only be routed if the request version
+     * within the controller will only be routed if the request version
      * matches the specified value.
      *
      * Supported only by HTTP-based applications (does not apply to non-HTTP microservices).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestjs/common",
-  "version": "9.0.0-next.1",
+  "version": "9.0.1",
   "description": "Nest - modern, fast, powerful node.js web framework (@common)",
   "author": "Kamil Mysliwiec",
   "homepage": "https://nestjs.com",

package/pipes/file/file-type.validator.d.ts

@@ -0,0 +1,19 @@
+import { FileValidator } from './file-validator.interface';
+export declare type FileTypeValidatorOptions = {
+    fileType: string | RegExp;
+};
+/**
+ * Defines the built-in FileType File Validator. It validates incoming files mime-type
+ * matching a string or a regular expression. Note that this validator uses a naive strategy
+ * to check the mime-type and could be fooled if the client provided a file with renamed extension.
+ * (for instance, renaming a 'malicious.bat' to 'malicious.jpeg'). To handle such security issues
+ * with more reliability, consider checking against the file's [magic-numbers](https://en.wikipedia.org/wiki/Magic_number_%28programming%29)
+ *
+ * @see [File Validators](https://docs.nestjs.com/techniques/file-upload#validators)
+ *
+ * @publicApi
+ */
+export declare class FileTypeValidator extends FileValidator<FileTypeValidatorOptions> {
+    buildErrorMessage(): string;
+    isValid(file: any): boolean;
+}

package/pipes/file/file-type.validator.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileTypeValidator = void 0;
+const file_validator_interface_1 = require("./file-validator.interface");
+/**
+ * Defines the built-in FileType File Validator. It validates incoming files mime-type
+ * matching a string or a regular expression. Note that this validator uses a naive strategy
+ * to check the mime-type and could be fooled if the client provided a file with renamed extension.
+ * (for instance, renaming a 'malicious.bat' to 'malicious.jpeg'). To handle such security issues
+ * with more reliability, consider checking against the file's [magic-numbers](https://en.wikipedia.org/wiki/Magic_number_%28programming%29)
+ *
+ * @see [File Validators](https://docs.nestjs.com/techniques/file-upload#validators)
+ *
+ * @publicApi
+ */
+class FileTypeValidator extends file_validator_interface_1.FileValidator {
+    buildErrorMessage() {
+        return `Validation failed (expected type is ${this.validationOptions.fileType})`;
+    }
+    isValid(file) {
+        if (!this.validationOptions) {
+            return true;
+        }
+        if (!file.mimetype) {
+            return false;
+        }
+        return Boolean(file.mimetype.match(this.validationOptions.fileType));
+    }
+}
+exports.FileTypeValidator = FileTypeValidator;

package/pipes/file/file-validator.interface.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Interface describing FileValidators, which can be added to a {@link ParseFilePipe}.
+ */
+export declare abstract class FileValidator<TValidationOptions = Record<string, any>> {
+    protected readonly validationOptions: TValidationOptions;
+    constructor(validationOptions: TValidationOptions);
+    /**
+     * Indicates if this file should be considered valid, according to the options passed in the constructor.
+     * @param file the file from the request object
+     */
+    abstract isValid(file?: any): boolean | Promise<boolean>;
+    /**
+     * Builds an error message in case the validation fails.
+     * @param file the file from the request object
+     */
+    abstract buildErrorMessage(file: any): string;
+}

package/pipes/file/file-validator.interface.js

@@ -0,0 +1,12 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileValidator = void 0;
+/**
+ * Interface describing FileValidators, which can be added to a {@link ParseFilePipe}.
+ */
+class FileValidator {
+    constructor(validationOptions) {
+        this.validationOptions = validationOptions;
+    }
+}
+exports.FileValidator = FileValidator;

package/pipes/file/index.d.ts

@@ -0,0 +1,6 @@
+export * from './file-type.validator';
+export * from './file-validator.interface';
+export * from './max-file-size.validator';
+export * from './parse-file-options.interface';
+export * from './parse-file.pipe';
+export * from './parse-file-pipe.builder';

package/pipes/file/index.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+tslib_1.__exportStar(require("./file-type.validator"), exports);
+tslib_1.__exportStar(require("./file-validator.interface"), exports);
+tslib_1.__exportStar(require("./max-file-size.validator"), exports);
+tslib_1.__exportStar(require("./parse-file-options.interface"), exports);
+tslib_1.__exportStar(require("./parse-file.pipe"), exports);
+tslib_1.__exportStar(require("./parse-file-pipe.builder"), exports);

package/pipes/file/max-file-size.validator.d.ts

@@ -0,0 +1,15 @@
+import { FileValidator } from './file-validator.interface';
+export declare type MaxFileSizeValidatorOptions = {
+    maxSize: number;
+};
+/**
+ * Defines the built-in MaxSize File Validator
+ *
+ * @see [File Validators](https://docs.nestjs.com/techniques/file-upload#validators)
+ *
+ * @publicApi
+ */
+export declare class MaxFileSizeValidator extends FileValidator<MaxFileSizeValidatorOptions> {
+    buildErrorMessage(): string;
+    isValid(file: any): boolean;
+}

package/pipes/file/max-file-size.validator.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MaxFileSizeValidator = void 0;
+const file_validator_interface_1 = require("./file-validator.interface");
+/**
+ * Defines the built-in MaxSize File Validator
+ *
+ * @see [File Validators](https://docs.nestjs.com/techniques/file-upload#validators)
+ *
+ * @publicApi
+ */
+class MaxFileSizeValidator extends file_validator_interface_1.FileValidator {
+    buildErrorMessage() {
+        return `Validation failed (expected size is less than ${this.validationOptions.maxSize})`;
+    }
+    isValid(file) {
+        if (!this.validationOptions) {
+            return true;
+        }
+        return file.size < this.validationOptions.maxSize;
+    }
+}
+exports.MaxFileSizeValidator = MaxFileSizeValidator;

package/pipes/file/parse-file-options.interface.d.ts

@@ -0,0 +1,7 @@
+import { ErrorHttpStatusCode } from '../../utils/http-error-by-code.util';
+import { FileValidator } from './file-validator.interface';
+export interface ParseFileOptions {
+    validators?: FileValidator[];
+    errorHttpStatusCode?: ErrorHttpStatusCode;
+    exceptionFactory?: (error: string) => any;
+}

package/pipes/file/parse-file-options.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/pipes/file/parse-file-pipe.builder.d.ts

@@ -0,0 +1,10 @@
+import { FileTypeValidatorOptions } from './file-type.validator';
+import { MaxFileSizeValidatorOptions } from './max-file-size.validator';
+import { ParseFileOptions } from './parse-file-options.interface';
+import { ParseFilePipe } from './parse-file.pipe';
+export declare class ParseFilePipeBuilder {
+    private validators;
+    addMaxSizeValidator(options: MaxFileSizeValidatorOptions): this;
+    addFileTypeValidator(options: FileTypeValidatorOptions): this;
+    build(additionalOptions?: Omit<ParseFileOptions, 'validators'>): ParseFilePipe;
+}

package/pipes/file/parse-file-pipe.builder.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParseFilePipeBuilder = void 0;
+const file_type_validator_1 = require("./file-type.validator");
+const max_file_size_validator_1 = require("./max-file-size.validator");
+const parse_file_pipe_1 = require("./parse-file.pipe");
+class ParseFilePipeBuilder {
+    constructor() {
+        this.validators = [];
+    }
+    addMaxSizeValidator(options) {
+        this.validators.push(new max_file_size_validator_1.MaxFileSizeValidator(options));
+        return this;
+    }
+    addFileTypeValidator(options) {
+        this.validators.push(new file_type_validator_1.FileTypeValidator(options));
+        return this;
+    }
+    build(additionalOptions) {
+        const parseFilePipe = new parse_file_pipe_1.ParseFilePipe(Object.assign(Object.assign({}, additionalOptions), { validators: this.validators }));
+        this.validators = [];
+        return parseFilePipe;
+    }
+}
+exports.ParseFilePipeBuilder = ParseFilePipeBuilder;

package/pipes/file/parse-file.pipe.d.ts

@@ -0,0 +1,25 @@
+import { PipeTransform } from '../../interfaces/features/pipe-transform.interface';
+import { ParseFileOptions } from './parse-file-options.interface';
+import { FileValidator } from './file-validator.interface';
+/**
+ * Defines the built-in ParseFile Pipe. This pipe can be used to validate incoming files
+ * with `@UploadedFile()` decorator. You can use either other specific built-in validators
+ * or provide one of your own, simply implementing it through {@link FileValidator}
+ * interface and adding it to ParseFilePipe's constructor.
+ *
+ * @see [Built-in Pipes](https://docs.nestjs.com/pipes#built-in-pipes)
+ *
+ * @publicApi
+ */
+export declare class ParseFilePipe implements PipeTransform<any> {
+    protected exceptionFactory: (error: string) => any;
+    private readonly validators;
+    constructor(options?: ParseFileOptions);
+    transform(value: any): Promise<any>;
+    protected validate(file: any): Promise<any>;
+    private validateOrThrow;
+    /**
+     * @returns list of validators used in this pipe.
+     */
+    getValidators(): FileValidator<Record<string, any>>[];
+}

package/pipes/file/parse-file.pipe.js

@@ -0,0 +1,57 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ParseFilePipe = void 0;
+const tslib_1 = require("tslib");
+const core_1 = require("../../decorators/core");
+const enums_1 = require("../../enums");
+const http_error_by_code_util_1 = require("../../utils/http-error-by-code.util");
+/**
+ * Defines the built-in ParseFile Pipe. This pipe can be used to validate incoming files
+ * with `@UploadedFile()` decorator. You can use either other specific built-in validators
+ * or provide one of your own, simply implementing it through {@link FileValidator}
+ * interface and adding it to ParseFilePipe's constructor.
+ *
+ * @see [Built-in Pipes](https://docs.nestjs.com/pipes#built-in-pipes)
+ *
+ * @publicApi
+ */
+let ParseFilePipe = class ParseFilePipe {
+    constructor(options = {}) {
+        const { exceptionFactory, errorHttpStatusCode = enums_1.HttpStatus.BAD_REQUEST, validators = [], } = options;
+        this.exceptionFactory =
+            exceptionFactory ||
+                (error => new http_error_by_code_util_1.HttpErrorByCode[errorHttpStatusCode](error));
+        this.validators = validators;
+    }
+    async transform(value) {
+        if (this.validators.length) {
+            await this.validate(value);
+        }
+        return value;
+    }
+    async validate(file) {
+        for (const validator of this.validators) {
+            await this.validateOrThrow(file, validator);
+        }
+        return file;
+    }
+    async validateOrThrow(file, validator) {
+        const isValid = await validator.isValid(file);
+        if (!isValid) {
+            const errorMessage = validator.buildErrorMessage(file);
+            throw this.exceptionFactory(errorMessage);
+        }
+    }
+    /**
+     * @returns list of validators used in this pipe.
+     */
+    getValidators() {
+        return this.validators;
+    }
+};
+ParseFilePipe = tslib_1.__decorate([
+    (0, core_1.Injectable)(),
+    tslib_1.__param(0, (0, core_1.Optional)()),
+    tslib_1.__metadata("design:paramtypes", [Object])
+], ParseFilePipe);
+exports.ParseFilePipe = ParseFilePipe;

package/pipes/index.d.ts

@@ -6,3 +6,4 @@ export * from './parse-float.pipe';
 export * from './parse-enum.pipe';
 export * from './parse-uuid.pipe';
 export * from './validation.pipe';
+export * from './file';

package/pipes/index.js

@@ -9,3 +9,4 @@ tslib_1.__exportStar(require("./parse-float.pipe"), exports);
 tslib_1.__exportStar(require("./parse-enum.pipe"), exports);
 tslib_1.__exportStar(require("./parse-uuid.pipe"), exports);
 tslib_1.__exportStar(require("./validation.pipe"), exports);
+tslib_1.__exportStar(require("./file"), exports);

package/pipes/validation.pipe.d.ts

@@ -34,7 +34,7 @@ export declare class ValidationPipe implements PipeTransform<any> {
     protected toValidate(metadata: ArgumentMetadata): boolean;
     protected transformPrimitive(value: any, metadata: ArgumentMetadata): any;
     protected toEmptyIfNil<T = any, R = any>(value: T): R | {};
-    protected stripProtoKeys(value: Record<string, any>): void;
+    protected stripProtoKeys(value: any): void;
     protected isPrimitive(value: unknown): boolean;
     protected validate(object: object, validatorOptions?: ValidatorOptions): Promise<ValidationError[]> | ValidationError[];
     protected flattenValidationErrors(validationErrors: ValidationError[]): string[];

package/pipes/validation.pipe.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ValidationPipe = void 0;
 const tslib_1 = require("tslib");
 const iterare_1 = require("iterare");
+const util_1 = require("util");
 const decorators_1 = require("../decorators");
 const core_1 = require("../decorators/core");
 const http_status_enum_1 = require("../enums/http-status.enum");
@@ -118,11 +119,21 @@ let ValidationPipe = class ValidationPipe {
         return (0, shared_utils_1.isNil)(value) ? {} : value;
     }
     stripProtoKeys(value) {
+        if (value == null ||
+            typeof value !== 'object' ||
+            util_1.types.isTypedArray(value)) {
+            return;
+        }
+        if (Array.isArray(value)) {
+            for (const v of value) {
+                this.stripProtoKeys(v);
+            }
+            return;
+        }
         delete value.__proto__;
-        const keys = Object.keys(value);
-        (0, iterare_1.iterate)(keys)
-            .filter(key => (0, shared_utils_1.isObject)(value[key]) && value[key])
-            .forEach(key => this.stripProtoKeys(value[key]));
+        for (const key in value) {
+            this.stripProtoKeys(value[key]);
+        }
     }
     isPrimitive(value) {
         return ['number', 'boolean', 'string'].includes(typeof value);

package/services/console-logger.service.js

@@ -119,8 +119,8 @@ let ConsoleLogger = ConsoleLogger_1 = class ConsoleLogger {
             const contextMessage = context ? (0, cli_colors_util_1.yellow)(`[${context}] `) : '';
             const timestampDiff = this.updateAndGetTimestampDiff();
             const formattedLogLevel = logLevel.toUpperCase().padStart(7, ' ');
-            const formatedMessage = this.formatMessage(logLevel, message, pidMessage, formattedLogLevel, contextMessage, timestampDiff);
-            process[writeStreamType !== null && writeStreamType !== void 0 ? writeStreamType : 'stdout'].write(formatedMessage);
+            const formattedMessage = this.formatMessage(logLevel, message, pidMessage, formattedLogLevel, contextMessage, timestampDiff);
+            process[writeStreamType !== null && writeStreamType !== void 0 ? writeStreamType : 'stdout'].write(formattedMessage);
         });
     }
     formatPid(pid) {

package/services/logger.service.js

@@ -122,7 +122,7 @@ let Logger = Logger_1 = class Logger {
         }
         if ((0, shared_utils_1.isObject)(logger)) {
             if (logger instanceof Logger_1 && logger.constructor !== Logger_1) {
-                const errorMessage = `Using the "extends Logger" instruction is not allowed in Nest v8. Please, use "extends ConsoleLogger" instead.`;
+                const errorMessage = `Using the "extends Logger" instruction is not allowed in Nest v9. Please, use "extends ConsoleLogger" instead.`;
                 this.staticInstanceRef.error(errorMessage);
                 throw new Error(errorMessage);
             }

package/utils/cli-colors.util.d.ts

@@ -1,4 +1,5 @@
 export declare const clc: {
+    bold: (text: string) => string;
     green: (text: string) => string;
     yellow: (text: string) => string;
     red: (text: string) => string;

package/utils/cli-colors.util.js

@@ -4,6 +4,7 @@ exports.yellow = exports.clc = void 0;
 const isColorAllowed = () => !process.env.NO_COLOR;
 const colorIfAllowed = (colorFn) => (text) => isColorAllowed() ? colorFn(text) : text;
 exports.clc = {
+    bold: colorIfAllowed((text) => `\x1B[1m${text}\x1B[0m`),
     green: colorIfAllowed((text) => `\x1B[32m${text}\x1B[39m`),
     yellow: colorIfAllowed((text) => `\x1B[33m${text}\x1B[39m`),
     red: colorIfAllowed((text) => `\x1B[31m${text}\x1B[39m`),