@nestjs/platform-fastify 9.3.0-beta.3 → 9.3.0

package/adapters/fastify-adapter.d.ts

@@ -1,26 +1,28 @@
 /// <reference types="node" />
 /// <reference types="node" />
+/// <reference types="node" />
 import { RequestMethod, VersioningOptions } from '@nestjs/common';
 import { VersionValue } from '@nestjs/common/interfaces';
 import { CorsOptions, CorsOptionsDelegate } from '@nestjs/common/interfaces/external/cors-options.interface';
 import { AbstractHttpAdapter } from '@nestjs/core/adapters/http-adapter';
-import { FastifyInstance, FastifyLoggerInstance, FastifyPluginAsync, FastifyPluginCallback, FastifyRegister, FastifyReply, FastifyRequest, FastifyServerOptions, RawReplyDefaultExpression, RawRequestDefaultExpression, RawServerBase, RawServerDefault, RequestGenericInterface } from 'fastify';
+import { FastifyBaseLogger, FastifyBodyParser, FastifyInstance, FastifyPluginAsync, FastifyPluginCallback, FastifyRegister, FastifyReply, FastifyRequest, FastifyServerOptions, RawReplyDefaultExpression, RawRequestDefaultExpression, RawServerBase, RawServerDefault, RequestGenericInterface } from 'fastify';
 import * as http2 from 'http2';
 import * as https from 'https';
 import { Chain as LightMyRequestChain, InjectOptions, Response as LightMyRequestResponse } from 'light-my-request';
+import { NestFastifyBodyParserOptions } from '../interfaces';
 import { FastifyStaticOptions, FastifyViewOptions } from '../interfaces/external';
-declare type FastifyHttp2SecureOptions<Server extends http2.Http2SecureServer, Logger extends FastifyLoggerInstance = FastifyLoggerInstance> = FastifyServerOptions<Server, Logger> & {
+type FastifyHttp2SecureOptions<Server extends http2.Http2SecureServer, Logger extends FastifyBaseLogger = FastifyBaseLogger> = FastifyServerOptions<Server, Logger> & {
     http2: true;
     https: http2.SecureServerOptions;
 };
-declare type FastifyHttp2Options<Server extends http2.Http2Server, Logger extends FastifyLoggerInstance = FastifyLoggerInstance> = FastifyServerOptions<Server, Logger> & {
+type FastifyHttp2Options<Server extends http2.Http2Server, Logger extends FastifyBaseLogger = FastifyBaseLogger> = FastifyServerOptions<Server, Logger> & {
     http2: true;
     http2SessionTimeout?: number;
 };
-declare type FastifyHttpsOptions<Server extends https.Server, Logger extends FastifyLoggerInstance = FastifyLoggerInstance> = FastifyServerOptions<Server, Logger> & {
+type FastifyHttpsOptions<Server extends https.Server, Logger extends FastifyBaseLogger = FastifyBaseLogger> = FastifyServerOptions<Server, Logger> & {
     https: https.ServerOptions;
 };
-declare type VersionedRoute<TRequest, TResponse> = ((req: TRequest, res: TResponse, next: Function) => Function) & {
+type VersionedRoute<TRequest, TResponse> = ((req: TRequest, res: TResponse, next: Function) => Function) & {
     version: VersionValue;
     versioningOptions: VersioningOptions;
 };
@@ -30,7 +32,7 @@ declare type VersionedRoute<TRequest, TResponse> = ((req: TRequest, res: TRespon
  * ref https://github.com/fastify/middie/pull/16
  * ref https://github.com/fastify/fastify/pull/559
  */
-declare type FastifyRawRequest<TServer extends RawServerBase> = RawRequestDefaultExpression<TServer> & {
+type FastifyRawRequest<TServer extends RawServerBase> = RawRequestDefaultExpression<TServer> & {
     originalUrl?: string;
 };
 export declare class FastifyAdapter<TServer extends RawServerBase = RawServerDefault, TRawRequest extends FastifyRawRequest<TServer> = FastifyRawRequest<TServer>, TRawResponse extends RawReplyDefaultExpression<TServer> = RawReplyDefaultExpression<TServer>, TRequest extends FastifyRequest<RequestGenericInterface, TServer, TRawRequest> = FastifyRequest<RequestGenericInterface, TServer, TRawRequest>, TReply extends FastifyReply<TServer, TRawRequest, TRawResponse> = FastifyReply<TServer, TRawRequest, TRawResponse>, TInstance extends FastifyInstance<TServer, TRawRequest, TRawResponse> = FastifyInstance<TServer, TRawRequest, TRawResponse>> extends AbstractHttpAdapter<TServer, TRequest, TReply> {
@@ -44,13 +46,13 @@ export declare class FastifyAdapter<TServer extends RawServerBase = RawServerDef
     init(): Promise<void>;
     listen(port: string | number, callback?: () => void): void;
     listen(port: string | number, hostname: string, callback?: () => void): void;
-    get(...args: any[]): FastifyInstance<TServer, TRawRequest, TRawResponse, import("fastify").FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault>;
-    post(...args: any[]): FastifyInstance<TServer, TRawRequest, TRawResponse, import("fastify").FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault>;
-    head(...args: any[]): FastifyInstance<TServer, TRawRequest, TRawResponse, import("fastify").FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault>;
-    delete(...args: any[]): FastifyInstance<TServer, TRawRequest, TRawResponse, import("fastify").FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault>;
-    put(...args: any[]): FastifyInstance<TServer, TRawRequest, TRawResponse, import("fastify").FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault>;
-    patch(...args: any[]): FastifyInstance<TServer, TRawRequest, TRawResponse, import("fastify").FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault>;
-    options(...args: any[]): FastifyInstance<TServer, TRawRequest, TRawResponse, import("fastify").FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault>;
+    get(...args: any[]): FastifyInstance<TServer, TRawRequest, TRawResponse, FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault>;
+    post(...args: any[]): FastifyInstance<TServer, TRawRequest, TRawResponse, FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault>;
+    head(...args: any[]): FastifyInstance<TServer, TRawRequest, TRawResponse, FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault>;
+    delete(...args: any[]): FastifyInstance<TServer, TRawRequest, TRawResponse, FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault>;
+    put(...args: any[]): FastifyInstance<TServer, TRawRequest, TRawResponse, FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault>;
+    patch(...args: any[]): FastifyInstance<TServer, TRawRequest, TRawResponse, FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault>;
+    options(...args: any[]): FastifyInstance<TServer, TRawRequest, TRawResponse, FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault>;
     applyVersionFilter(handler: Function, version: VersionValue, versioningOptions: VersioningOptions): VersionedRoute<TRequest, TReply>;
     reply(response: TRawResponse | TReply, body: any, statusCode?: number): FastifyReply<TServer, TRawRequest, TRawResponse, import("fastify").RouteGenericInterface, unknown, import("fastify").FastifySchema, import("fastify").FastifyTypeProviderDefault, unknown>;
     status(response: TRawResponse | TReply, statusCode: number): TRawResponse | FastifyReply<TServer, TRawRequest, TRawResponse, import("fastify").RouteGenericInterface, unknown, import("fastify").FastifySchema, import("fastify").FastifyTypeProviderDefault, unknown>;
@@ -59,17 +61,17 @@ export declare class FastifyAdapter<TServer extends RawServerBase = RawServerDef
         view: Function;
     }, view: string, options: any): any;
     redirect(response: TReply, statusCode: number, url: string): FastifyReply<TServer, TRawRequest, TRawResponse, import("fastify").RouteGenericInterface, unknown, import("fastify").FastifySchema, import("fastify").FastifyTypeProviderDefault, unknown>;
-    setErrorHandler(handler: Parameters<TInstance['setErrorHandler']>[0]): FastifyInstance<TServer, TRawRequest, TRawResponse, import("fastify").FastifyBaseLogger, import("fastify").FastifyTypeProvider>;
-    setNotFoundHandler(handler: Function): FastifyInstance<TServer, TRawRequest, TRawResponse, import("fastify").FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault>;
+    setErrorHandler(handler: Parameters<TInstance['setErrorHandler']>[0]): FastifyInstance<TServer, TRawRequest, TRawResponse, FastifyBaseLogger, import("fastify").FastifyTypeProvider>;
+    setNotFoundHandler(handler: Function): FastifyInstance<TServer, TRawRequest, TRawResponse, FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault>;
     getHttpServer<T = TServer>(): T;
     getInstance<T = TInstance>(): T;
-    register<TRegister extends Parameters<FastifyRegister<TInstance>>>(plugin: TRegister['0'], opts?: TRegister['1']): FastifyInstance<TServer, TRawRequest, TRawResponse, import("fastify").FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault> & PromiseLike<undefined>;
+    register<TRegister extends Parameters<FastifyRegister<TInstance>>>(plugin: TRegister['0'], opts?: TRegister['1']): FastifyInstance<TServer, TRawRequest, TRawResponse, FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault> & PromiseLike<undefined>;
     inject(): LightMyRequestChain;
     inject(opts: InjectOptions | string): Promise<LightMyRequestResponse>;
     close(): Promise<undefined>;
     initHttpServer(): void;
-    useStaticAssets(options: FastifyStaticOptions): FastifyInstance<TServer, TRawRequest, TRawResponse, import("fastify").FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault> & PromiseLike<undefined>;
-    setViewEngine(options: FastifyViewOptions | string): FastifyInstance<TServer, TRawRequest, TRawResponse, import("fastify").FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault> & PromiseLike<undefined>;
+    useStaticAssets(options: FastifyStaticOptions): FastifyInstance<TServer, TRawRequest, TRawResponse, FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault> & PromiseLike<undefined>;
+    setViewEngine(options: FastifyViewOptions | string): FastifyInstance<TServer, TRawRequest, TRawResponse, FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault> & PromiseLike<undefined>;
     isHeadersSent(response: TReply): boolean;
     setHeader(response: TReply, name: string, value: string): FastifyReply<TServer, TRawRequest, TRawResponse, import("fastify").RouteGenericInterface, unknown, import("fastify").FastifySchema, import("fastify").FastifyTypeProviderDefault, unknown>;
     getRequestHostname(request: TRequest): string;
@@ -78,13 +80,14 @@ export declare class FastifyAdapter<TServer extends RawServerBase = RawServerDef
     getRequestUrl(request: TRawRequest): string;
     enableCors(options: CorsOptions | CorsOptionsDelegate<TRequest>): void;
     registerParserMiddleware(prefix?: string, rawBody?: boolean): void;
+    useBodyParser(type: string | string[] | RegExp, rawBody: boolean, options?: NestFastifyBodyParserOptions, parser?: FastifyBodyParser<Buffer, TServer>): void;
     createMiddlewareFactory(requestMethod: RequestMethod): Promise<(path: string, callback: Function) => any>;
     getType(): string;
     protected registerWithPrefix(factory: FastifyPluginCallback<any> | FastifyPluginAsync<any> | Promise<{
         default: FastifyPluginCallback<any>;
     }> | Promise<{
         default: FastifyPluginAsync<any>;
-    }>, prefix?: string): FastifyInstance<TServer, TRawRequest, TRawResponse, import("fastify").FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault> & PromiseLike<undefined>;
+    }>, prefix?: string): FastifyInstance<TServer, TRawRequest, TRawResponse, FastifyBaseLogger, import("fastify").FastifyTypeProviderDefault> & PromiseLike<undefined>;
     private isNativeResponse;
     private registerJsonContentParser;
     private registerUrlencodedContentParser;

package/adapters/fastify-adapter.js

@@ -7,9 +7,13 @@ const shared_utils_1 = require("@nestjs/common/utils/shared.utils");
 const http_adapter_1 = require("@nestjs/core/adapters/http-adapter");
 const fastify_1 = require("fastify");
 const Reply = require("fastify/lib/reply");
+const symbols_1 = require("fastify/lib/symbols");
 // `querystring` is used internally in fastify for registering urlencoded body parser.
 const querystring_1 = require("querystring");
 class FastifyAdapter extends http_adapter_1.AbstractHttpAdapter {
+    get isParserRegistered() {
+        return !!this._isParserRegistered;
+    }
     constructor(instanceOrOptions) {
         super();
         this.versionConstraint = {
@@ -84,21 +88,28 @@ class FastifyAdapter extends http_adapter_1.AbstractHttpAdapter {
                 } }, instanceOrOptions));
         this.setInstance(instance);
     }
-    get isParserRegistered() {
-        return !!this._isParserRegistered;
-    }
     async init() {
         if (this.isMiddieRegistered) {
             return;
         }
         await this.registerMiddie();
     }
-    listen(port, ...args) {
+    listen(listenOptions, ...args) {
         const isFirstArgTypeofFunction = typeof args[0] === 'function';
         const callback = isFirstArgTypeofFunction ? args[0] : args[1];
-        const options = {
-            port: +port,
-        };
+        let options;
+        if (typeof listenOptions === 'object' &&
+            (listenOptions.host !== undefined ||
+                listenOptions.port !== undefined ||
+                listenOptions.path !== undefined)) {
+            // First parameter is an object with a path, port and/or host attributes
+            options = listenOptions;
+        }
+        else {
+            options = {
+                port: +listenOptions,
+            };
+        }
         if (!isFirstArgTypeofFunction) {
             options.host = args[0];
         }
@@ -136,7 +147,7 @@ class FastifyAdapter extends http_adapter_1.AbstractHttpAdapter {
     reply(response, body, statusCode) {
         const fastifyReply = this.isNativeResponse(response)
             ? new Reply(response, {
-                context: {
+                [symbols_1.kRouteContext]: {
                     preSerialization: null,
                     preValidation: [],
                     preHandler: [],
@@ -252,6 +263,22 @@ class FastifyAdapter extends http_adapter_1.AbstractHttpAdapter {
         this.registerJsonContentParser(rawBody);
         this._isParserRegistered = true;
     }
+    useBodyParser(type, rawBody, options, parser) {
+        const parserOptions = Object.assign(Object.assign({}, (options || {})), { parseAs: 'buffer' });
+        this.getInstance().addContentTypeParser(type, parserOptions, (req, body, done) => {
+            if (rawBody === true && Buffer.isBuffer(body)) {
+                req.rawBody = body;
+            }
+            if (parser) {
+                parser(req, body, done);
+                return;
+            }
+            done(null, body);
+        });
+        // To avoid the Nest application init to override our custom
+        // body parser, we mark the parsers as registered.
+        this._isParserRegistered = true;
+    }
     async createMiddlewareFactory(requestMethod) {
         if (!this.isMiddieRegistered) {
             await this.registerMiddie();
@@ -277,22 +304,20 @@ class FastifyAdapter extends http_adapter_1.AbstractHttpAdapter {
         return !('status' in response);
     }
     registerJsonContentParser(rawBody) {
+        const contentType = 'application/json';
+        const withRawBody = !!rawBody;
         const { bodyLimit } = this.getInstance().initialConfig;
-        this.getInstance().addContentTypeParser('application/json', { parseAs: 'buffer', bodyLimit }, (req, body, done) => {
-            if (rawBody === true && Buffer.isBuffer(body)) {
-                req.rawBody = body;
-            }
+        this.useBodyParser(contentType, withRawBody, { bodyLimit }, (req, body, done) => {
             const { onProtoPoisoning, onConstructorPoisoning } = this.instance.initialConfig;
             const defaultJsonParser = this.instance.getDefaultJsonParser(onProtoPoisoning || 'error', onConstructorPoisoning || 'error');
             defaultJsonParser(req, body, done);
         });
     }
     registerUrlencodedContentParser(rawBody) {
+        const contentType = 'application/x-www-form-urlencoded';
+        const withRawBody = !!rawBody;
         const { bodyLimit } = this.getInstance().initialConfig;
-        this.getInstance().addContentTypeParser('application/x-www-form-urlencoded', { parseAs: 'buffer', bodyLimit }, (req, body, done) => {
-            if (rawBody === true && Buffer.isBuffer(body)) {
-                req.rawBody = body;
-            }
+        this.useBodyParser(contentType, withRawBody, { bodyLimit }, (_req, body, done) => {
             done(null, (0, querystring_1.parse)(body.toString()));
         });
     }

package/interfaces/index.d.ts

@@ -1 +1,2 @@
 export * from './nest-fastify-application.interface';
+export * from './nest-fastify-body-parser-options.interface';

package/interfaces/index.js

@@ -2,3 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./nest-fastify-application.interface"), exports);
+tslib_1.__exportStar(require("./nest-fastify-body-parser-options.interface"), exports);

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

@@ -1,7 +1,9 @@
+/// <reference types="node" />
 import { INestApplication } from '@nestjs/common';
-import { FastifyInstance, FastifyPluginAsync, FastifyPluginCallback, FastifyPluginOptions, FastifyRegisterOptions } from 'fastify';
+import { FastifyBodyParser, FastifyInstance, FastifyPluginAsync, FastifyPluginCallback, FastifyPluginOptions, FastifyRegisterOptions, RawServerBase } from 'fastify';
 import { Chain as LightMyRequestChain, InjectOptions, Response as LightMyRequestResponse } from 'light-my-request';
 import { FastifyStaticOptions, FastifyViewOptions } from './external';
+import { NestFastifyBodyParserOptions } from './nest-fastify-body-parser-options.interface';
 export interface NestFastifyApplication extends INestApplication {
     /**
      * A wrapper function around native `fastify.register()` method.
@@ -13,6 +15,22 @@ export interface NestFastifyApplication extends INestApplication {
     }> | Promise<{
         default: FastifyPluginAsync<Options>;
     }>, opts?: FastifyRegisterOptions<Options>): Promise<FastifyInstance>;
+    /**
+     * Register Fastify body parsers on the fly. Will respect
+     * the application's `rawBody` option.
+     *
+     * @example
+     * const app = await NestFactory.create<NestFastifyApplication>(
+     *   AppModule,
+     *   new FastifyAdapter(),
+     *   { rawBody: true }
+     * );
+     * // enable the json parser with a parser limit of 50mb
+     * app.useBodyParser('application/json', { bodyLimit: 50 * 1000 * 1024 });
+     *
+     * @returns {this}
+     */
+    useBodyParser<TServer extends RawServerBase = RawServerBase>(type: string | string[] | RegExp, options?: NestFastifyBodyParserOptions, parser?: FastifyBodyParser<Buffer, TServer>): this;
     /**
      * Sets a base directory for public assets.
      * Example `app.useStaticAssets({ root: 'public' })`

package/interfaces/nest-fastify-body-parser-options.interface.d.ts

@@ -0,0 +1,2 @@
+import type { AddContentTypeParser } from 'fastify';
+export type NestFastifyBodyParserOptions = Omit<Parameters<AddContentTypeParser>[1], 'parseAs'>;

package/interfaces/nest-fastify-body-parser-options.interface.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestjs/platform-fastify",
-  "version": "9.3.0-beta.3",
+  "version": "9.3.0",
   "description": "Nest - modern, fast, powerful node.js web framework (@platform-fastify)",
   "author": "Kamil Mysliwiec",
   "license": "MIT",
@@ -20,7 +20,7 @@
     "@fastify/cors": "8.2.0",
     "@fastify/formbody": "7.4.0",
     "@fastify/middie": "8.1.0",
-    "fastify": "4.11.0",
+    "fastify": "4.12.0",
     "light-my-request": "5.8.0",
     "path-to-regexp": "3.2.0",
     "tslib": "2.4.1"