@nestjs/platform-fastify 11.1.3 → 11.1.5

package/adapters/fastify-adapter.d.ts

@@ -47,11 +47,16 @@ export declare class FastifyAdapter<TServer extends RawServerBase = RawServerDef
     protected readonly instance: TInstance;
     protected _pathPrefix?: string;
     private _isParserRegistered;
+    private onRequestHook?;
+    private onResponseHook?;
     private isMiddieRegistered;
+    private pendingMiddlewares;
     private versioningOptions?;
     private readonly versionConstraint;
     get isParserRegistered(): boolean;
     constructor(instanceOrOptions?: TInstance | FastifyHttp2Options<any> | FastifyHttp2SecureOptions<any> | FastifyHttpsOptions<any> | FastifyHttpOptions<any> | FastifyAdapterBaseOptions<TServer>);
+    setOnRequestHook(hook: (request: TRequest, reply: TReply, done: (err?: Error) => void) => void | Promise<void>): void;
+    setOnResponseHook(hook: (request: TRequest, reply: TReply, done: (err?: Error) => void) => void | Promise<void>): void;
     init(): Promise<void>;
     listen(port: string | number, callback?: () => void): void;
     listen(port: string | number, hostname: string, callback?: () => void): void;
@@ -102,6 +107,7 @@ export declare class FastifyAdapter<TServer extends RawServerBase = RawServerDef
     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;
+    use(...args: any[]): any;
     protected registerWithPrefix(factory: FastifyPluginCallback<any> | FastifyPluginAsync<any> | Promise<{
         default: FastifyPluginCallback<any>;
     }> | Promise<{

package/adapters/fastify-adapter.js

@@ -23,6 +23,7 @@ class FastifyAdapter extends http_adapter_1.AbstractHttpAdapter {
     constructor(instanceOrOptions) {
         super();
         this.logger = new common_1.Logger(FastifyAdapter.name);
+        this.pendingMiddlewares = [];
         this.versionConstraint = {
             name: 'version',
             validate(value) {
@@ -99,12 +100,41 @@ class FastifyAdapter extends http_adapter_1.AbstractHttpAdapter {
         if (instanceOrOptions?.skipMiddie) {
             this.isMiddieRegistered = true;
         }
+        this.instance.addHook('onRequest', (request, reply, done) => {
+            if (this.onRequestHook) {
+                this.onRequestHook(request, reply, done);
+            }
+            else {
+                done();
+            }
+        });
+        this.instance.addHook('onResponse', (request, reply, done) => {
+            if (this.onResponseHook) {
+                this.onResponseHook(request, reply, done);
+            }
+            else {
+                done();
+            }
+        });
+    }
+    setOnRequestHook(hook) {
+        this.onRequestHook = hook;
+    }
+    setOnResponseHook(hook) {
+        this.onResponseHook = hook;
     }
     async init() {
         if (this.isMiddieRegistered) {
             return;
         }
         await this.registerMiddie();
+        // Register any pending middlewares that were added before init
+        if (this.pendingMiddlewares.length > 0) {
+            for (const { args } of this.pendingMiddlewares) {
+                this.instance.use(...args);
+            }
+            this.pendingMiddlewares = [];
+        }
     }
     listen(listenOptions, ...args) {
         const isFirstArgTypeofFunction = typeof args[0] === 'function';
@@ -381,6 +411,15 @@ class FastifyAdapter extends http_adapter_1.AbstractHttpAdapter {
     getType() {
         return 'fastify';
     }
+    use(...args) {
+        // Fastify requires @fastify/middie plugin to be registered before middleware can be used.
+        // If middie is not registered yet, we queue the middleware and register it later during init.
+        if (!this.isMiddieRegistered) {
+            this.pendingMiddlewares.push({ args });
+            return this;
+        }
+        return this.instance.use(...args);
+    }
     registerWithPrefix(factory, prefix = '/') {
         return this.instance.register(factory, { prefix });
     }
@@ -418,8 +457,10 @@ class FastifyAdapter extends http_adapter_1.AbstractHttpAdapter {
             handlerRef.version !== common_1.VERSION_NEUTRAL;
         const routeConfig = Reflect.getMetadata(constants_1.FASTIFY_ROUTE_CONFIG_METADATA, handlerRef);
         const routeConstraints = Reflect.getMetadata(constants_1.FASTIFY_ROUTE_CONSTRAINTS_METADATA, handlerRef);
+        const routeSchema = Reflect.getMetadata(constants_1.FASTIFY_ROUTE_SCHEMA_METADATA, handlerRef);
         const hasConfig = !(0, shared_utils_1.isUndefined)(routeConfig);
         const hasConstraints = !(0, shared_utils_1.isUndefined)(routeConstraints);
+        const hasSchema = !(0, shared_utils_1.isUndefined)(routeSchema);
         const routeToInject = {
             method: routerMethodKey,
             url: args[0],
@@ -428,7 +469,7 @@ class FastifyAdapter extends http_adapter_1.AbstractHttpAdapter {
         if (this.instance.supportedMethods.indexOf(routerMethodKey) === -1) {
             this.instance.addHttpMethod(routerMethodKey, { hasBody: true });
         }
-        if (isVersioned || hasConstraints || hasConfig) {
+        if (isVersioned || hasConstraints || hasConfig || hasSchema) {
             const isPathAndRouteTuple = args.length === 2;
             if (isPathAndRouteTuple) {
                 const constraints = {
@@ -444,6 +485,9 @@ class FastifyAdapter extends http_adapter_1.AbstractHttpAdapter {
                             ...routeConfig,
                         },
                     }),
+                    ...(hasSchema && {
+                        schema: routeSchema,
+                    }),
                 };
                 const routeToInjectWithOptions = { ...routeToInject, ...options };
                 return this.instance.route(routeToInjectWithOptions);

package/constants.d.ts

@@ -1,2 +1,3 @@
 export declare const FASTIFY_ROUTE_CONFIG_METADATA = "__fastify_route_config__";
 export declare const FASTIFY_ROUTE_CONSTRAINTS_METADATA = "__fastify_route_constraints__";
+export declare const FASTIFY_ROUTE_SCHEMA_METADATA = "__fastify_route_schema__";

package/constants.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.FASTIFY_ROUTE_CONSTRAINTS_METADATA = exports.FASTIFY_ROUTE_CONFIG_METADATA = void 0;
+exports.FASTIFY_ROUTE_SCHEMA_METADATA = exports.FASTIFY_ROUTE_CONSTRAINTS_METADATA = exports.FASTIFY_ROUTE_CONFIG_METADATA = void 0;
 exports.FASTIFY_ROUTE_CONFIG_METADATA = '__fastify_route_config__';
 exports.FASTIFY_ROUTE_CONSTRAINTS_METADATA = '__fastify_route_constraints__';
+exports.FASTIFY_ROUTE_SCHEMA_METADATA = '__fastify_route_schema__';

package/decorators/index.d.ts

@@ -1,2 +1,3 @@
 export * from './route-config.decorator';
 export * from './route-constraints.decorator';
+export * from './route-schema.decorator';

package/decorators/index.js

@@ -3,3 +3,4 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const tslib_1 = require("tslib");
 tslib_1.__exportStar(require("./route-config.decorator"), exports);
 tslib_1.__exportStar(require("./route-constraints.decorator"), exports);
+tslib_1.__exportStar(require("./route-schema.decorator"), exports);

package/decorators/route-schema.decorator.d.ts

@@ -0,0 +1,11 @@
+import { FastifySchema } from 'fastify';
+/**
+ * @publicApi
+ * Allows setting the schema for the route. Schema is an object that can contain the following properties:
+ * - body: JsonSchema
+ * - querystring or query: JsonSchema
+ * - params: JsonSchema
+ * - response: Record<HttpStatusCode, JsonSchema>
+ * @param schema See {@link https://fastify.dev/docs/latest/Reference/Routes/#routes-options}
+ */
+export declare const RouteSchema: (schema: FastifySchema) => import("@nestjs/common").CustomDecorator<string>;

package/decorators/route-schema.decorator.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RouteSchema = void 0;
+const common_1 = require("@nestjs/common");
+const constants_1 = require("../constants");
+/**
+ * @publicApi
+ * Allows setting the schema for the route. Schema is an object that can contain the following properties:
+ * - body: JsonSchema
+ * - querystring or query: JsonSchema
+ * - params: JsonSchema
+ * - response: Record<HttpStatusCode, JsonSchema>
+ * @param schema See {@link https://fastify.dev/docs/latest/Reference/Routes/#routes-options}
+ */
+const RouteSchema = (schema) => (0, common_1.SetMetadata)(constants_1.FASTIFY_ROUTE_SCHEMA_METADATA, schema);
+exports.RouteSchema = RouteSchema;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nestjs/platform-fastify",
-  "version": "11.1.3",
+  "version": "11.1.5",
   "description": "Nest - modern, fast, powerful node.js web framework (@platform-fastify)",
   "author": "Kamil Mysliwiec",
   "license": "MIT",
@@ -22,7 +22,7 @@
     "@fastify/formbody": "8.0.2",
     "@fastify/middie": "9.0.3",
     "fast-querystring": "1.1.2",
-    "fastify": "5.3.3",
+    "fastify": "5.4.0",
     "light-my-request": "6.6.0",
     "path-to-regexp": "8.2.0",
     "tslib": "2.8.1"