@nestjs/common 8.3.1 → 8.4.0

package/Readme.md

@@ -54,7 +54,7 @@ With official support, you can get expert help straight from Nest core team. We
 
 ## Support
 
-Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
+Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support from the amazing backers. If you'd like to join them, please [read more here](https://docs.nestjs.com/support).
 
 #### Principal Sponsors
 <table style="text-align:center;"><tr>

package/decorators/core/catch.decorator.d.ts

@@ -1,4 +1,4 @@
-import { Type } from '../../interfaces';
+import { Type, Abstract } from '../../interfaces';
 /**
  * Decorator that marks a class as a Nest exception filter. An exception filter
  * handles exceptions thrown by or not handled by your application code.
@@ -16,4 +16,4 @@ import { Type } from '../../interfaces';
  *
  * @publicApi
  */
-export declare function Catch(...exceptions: Type<any>[]): ClassDecorator;
+export declare function Catch(...exceptions: Array<Type<any> | Abstract<any>>): ClassDecorator;

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

@@ -4,5 +4,6 @@
 export declare enum VersioningType {
     URI = 0,
     HEADER = 1,
-    MEDIA_TYPE = 2
+    MEDIA_TYPE = 2,
+    CUSTOM = 3
 }

package/enums/version-type.enum.js

@@ -9,4 +9,5 @@ var 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 || (exports.VersioningType = {}));

package/file-stream/streamable-file.d.ts

@@ -10,5 +10,6 @@ export declare class StreamableFile {
     getHeaders(): {
         type: string;
         disposition: string;
+        length: number;
     };
 }

package/file-stream/streamable-file.js

@@ -20,8 +20,12 @@ class StreamableFile {
         return this.stream;
     }
     getHeaders() {
-        const { type = 'application/octet-stream', disposition = null } = this.options;
-        return { type, disposition };
+        const { type = 'application/octet-stream', disposition = undefined, length = undefined, } = this.options;
+        return {
+            type,
+            disposition,
+            length,
+        };
     }
 }
 exports.StreamableFile = StreamableFile;

package/file-stream/streamable-options.interface.d.ts

@@ -1,4 +1,5 @@
 export interface StreamableFileOptions {
     type?: string;
     disposition?: string;
+    length?: number;
 }

package/index.d.ts

@@ -5,7 +5,7 @@ export * from './enums';
 export * from './exceptions';
 export * from './file-stream';
 export * from './http';
-export { Abstract, ArgumentMetadata, ArgumentsHost, BeforeApplicationShutdown, CallHandler, CanActivate, ClassProvider, ContextType, DynamicModule, ExceptionFilter, ExecutionContext, ExistingProvider, FactoryProvider, ForwardReference, HttpServer, INestApplication, INestApplicationContext, INestMicroservice, IntrospectionResult, MessageEvent, MiddlewareConsumer, ModuleMetadata, NestApplicationOptions, NestHybridApplicationOptions, NestInterceptor, NestMiddleware, NestModule, OnApplicationBootstrap, OnApplicationShutdown, OnModuleDestroy, OnModuleInit, Paramtype, PipeTransform, Provider, RpcExceptionFilter, Scope, ScopeOptions, Type, ValidationError, ValueProvider, VersioningOptions, VERSION_NEUTRAL, WebSocketAdapter, WsExceptionFilter, WsMessageHandler, } from './interfaces';
+export { Abstract, ArgumentMetadata, ArgumentsHost, BeforeApplicationShutdown, CallHandler, CanActivate, ClassProvider, ContextType, DynamicModule, ExceptionFilter, ExecutionContext, ExistingProvider, FactoryProvider, ForwardReference, HttpServer, INestApplication, INestApplicationContext, INestMicroservice, InjectionToken, IntrospectionResult, MessageEvent, MiddlewareConsumer, ModuleMetadata, NestApplicationOptions, NestHybridApplicationOptions, NestInterceptor, NestMiddleware, NestModule, OnApplicationBootstrap, OnApplicationShutdown, OnModuleDestroy, OnModuleInit, OptionalFactoryDependency, Paramtype, PipeTransform, Provider, RpcExceptionFilter, Scope, ScopeOptions, Type, ValidationError, ValueProvider, VersioningOptions, VERSION_NEUTRAL, WebSocketAdapter, WsExceptionFilter, WsMessageHandler, } from './interfaces';
 export * from './pipes';
 export * from './serializer';
 export * from './services';

package/interfaces/middleware/nest-middleware.interface.d.ts

@@ -1,3 +1,3 @@
 export interface NestMiddleware<TRequest = any, TResponse = any> {
-    use(req: TRequest, res: TResponse, next: () => void): any;
+    use(req: TRequest, res: TResponse, next: (error?: Error | any) => void): any;
 }

package/interfaces/modules/index.d.ts

@@ -1,6 +1,8 @@
 export * from './dynamic-module.interface';
 export * from './forward-reference.interface';
+export * from './injection-token.interface';
 export * from './introspection-result.interface';
 export * from './module-metadata.interface';
 export * from './nest-module.interface';
+export * from './optional-factory-dependency.interface';
 export * from './provider.interface';

package/interfaces/modules/index.js

@@ -3,7 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./dynamic-module.interface"), exports);
 tslib_1.__exportStar(require("./forward-reference.interface"), exports);
+tslib_1.__exportStar(require("./injection-token.interface"), exports);
 tslib_1.__exportStar(require("./introspection-result.interface"), exports);
 tslib_1.__exportStar(require("./module-metadata.interface"), exports);
 tslib_1.__exportStar(require("./nest-module.interface"), exports);
+tslib_1.__exportStar(require("./optional-factory-dependency.interface"), exports);
 tslib_1.__exportStar(require("./provider.interface"), exports);

package/interfaces/modules/injection-token.interface.d.ts

@@ -0,0 +1,3 @@
+import { Abstract } from '../abstract.interface';
+import { Type } from '../type.interface';
+export declare type InjectionToken = string | symbol | Type<any> | Abstract<any> | Function;

package/interfaces/modules/injection-token.interface.js

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

package/interfaces/modules/optional-factory-dependency.interface.d.ts

@@ -0,0 +1,5 @@
+import { InjectionToken } from './injection-token.interface';
+export declare type OptionalFactoryDependency = {
+    token: InjectionToken;
+    optional: boolean;
+};

package/interfaces/modules/optional-factory-dependency.interface.js

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

package/interfaces/modules/provider.interface.d.ts

@@ -1,6 +1,7 @@
-import { Abstract } from '../abstract.interface';
 import { Scope } from '../scope-options.interface';
 import { Type } from '../type.interface';
+import { InjectionToken } from './injection-token.interface';
+import { OptionalFactoryDependency } from './optional-factory-dependency.interface';
 /**
  *
  * @publicApi
@@ -29,7 +30,7 @@ export interface ClassProvider<T = any> {
     /**
      * Injection token
      */
-    provide: string | symbol | Type<any> | Abstract<any> | Function;
+    provide: InjectionToken;
     /**
      * Type (class name) of provider (instance to be injected).
      */
@@ -58,7 +59,7 @@ export interface ValueProvider<T = any> {
     /**
      * Injection token
      */
-    provide: string | symbol | Type<any> | Abstract<any> | Function;
+    provide: InjectionToken;
     /**
      * Instance of a provider to be injected.
      */
@@ -88,7 +89,7 @@ export interface FactoryProvider<T = any> {
     /**
      * Injection token
      */
-    provide: string | symbol | Type<any> | Abstract<any> | Function;
+    provide: InjectionToken;
     /**
      * Factory function that returns an instance of the provider to be injected.
      */
@@ -96,7 +97,7 @@ export interface FactoryProvider<T = any> {
     /**
      * Optional list of providers to be injected into the context of the Factory function.
      */
-    inject?: Array<Type<any> | string | symbol | Abstract<any> | Function>;
+    inject?: Array<InjectionToken | OptionalFactoryDependency>;
     /**
      * Optional enum defining lifetime of the provider that is returned by the Factory function.
      */
@@ -121,7 +122,7 @@ export interface ExistingProvider<T = any> {
     /**
      * Injection token
      */
-    provide: string | symbol | Type<any> | Abstract<any> | Function;
+    provide: InjectionToken;
     /**
      * Provider to be aliased by the Injection token.
      */

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

@@ -48,6 +48,18 @@ export interface MediaTypeVersioningOptions {
      */
     key: string;
 }
+export interface CustomVersioningOptions {
+    type: VersioningType.CUSTOM;
+    /**
+     * A function that accepts a request object (specific to the underlying platform, ie Express or Fastify)
+     * and returns a single version value or an ordered array of versions, in order from HIGHEST to LOWEST.
+     *
+     * Ex. Returned version array = ['3.1', '3.0', '2.5', '2', '1.9']
+     *
+     * Use type assertion or narrowing to identify the specific request type.
+     */
+    extractor: (request: unknown) => string | string[];
+}
 interface VersioningCommonOptions {
     /**
      * The default version to be used as a fallback when you did not provide some
@@ -58,5 +70,5 @@ interface VersioningCommonOptions {
 /**
  * @publicApi
  */
-export declare type VersioningOptions = VersioningCommonOptions & (HeaderVersioningOptions | UriVersioningOptions | MediaTypeVersioningOptions);
+export declare type VersioningOptions = VersioningCommonOptions & (HeaderVersioningOptions | UriVersioningOptions | MediaTypeVersioningOptions | CustomVersioningOptions);
 export {};

package/package.json

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

package/CHANGELOG.md

@@ -1,18 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-<a name="8.2.0"></a>
-# [8.2.0](https://github.com/nestjs/nest/compare/v8.1.2...v8.2.0) (2021-11-08)
-
-
-### Bug Fixes
-
-* **deps:** update dependency axios to v0.24.0 ([fc77e4f](https://github.com/nestjs/nest/commit/fc77e4f))
-
-
-### Features
-
-* **common:** add the ability to set some extra metadata about returned files ([5100573](https://github.com/nestjs/nest/commit/5100573))
-* **common:** allow to swap out class-validator and class-transformer ([2a1cc62](https://github.com/nestjs/nest/commit/2a1cc62))