@divine-lab/request 1.2.0 → 1.3.0

package/dist/fastify-helpers/index.d.ts

@@ -4,6 +4,11 @@ import { type FastifyRequest } from "fastify/types/request";
 import { type FastifyReply } from "fastify/types/reply";
 import { type FastifyInstance } from "fastify";
 type httpMethod = "GET" | "POST" | "PUT" | "DELETE" | "PATCH";
+type RateLimitConfig = {
+    max: number;
+    TimeWindow: string;
+    keyGenerator?: (req: FastifyRequest) => string;
+};
 /** Type definition for the success response payload.
  * @property {string} title - short, human-readable summary of the response
  * @property {string} detail - detailed description of the response
@@ -64,10 +69,11 @@ export declare function successResponse(res: FastifyReply, status?: number, { ti
  * });
  * ```
  */
-export declare function REGISTER_ROUTE<BodyType extends TObject, QueryType extends TObject, ParamsType extends TObject>(fastify: FastifyInstance, method: httpMethod, path: string, handler: (req: FastifyRequest<{
+export declare function REGISTER_ROUTE<BodyType extends TObject, QueryType extends TObject, ParamsType extends TObject, RateLimitType extends RateLimitConfig | undefined = undefined>(fastify: FastifyInstance, method: httpMethod, path: string, handler: (req: FastifyRequest<{
     Body: Static<BodyType>;
     Querystring: Static<QueryType>;
     Params: Static<ParamsType>;
+    RateLimit: RateLimitType;
 }>, reply: any) => void, options?: {
     schema?: {
         body?: BodyType;
@@ -75,7 +81,13 @@ export declare function REGISTER_ROUTE<BodyType extends TObject, QueryType exten
         params?: ParamsType;
     };
     preHandler?: Array<(req: FastifyRequest, reply: any) => void> | ((req: FastifyRequest, reply: any) => void);
-}): void;
+} & (RateLimitType extends undefined ? {
+    config?: any;
+} : {
+    config: {
+        rateLimit: RateLimitType;
+    };
+})): void;
 /** Centralized error handler for Fastify.
  * @param error - The error object caught by Fastify
  * @param request - The incoming request object

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@divine-lab/request",
-    "version": "1.2.0",
+    "version": "1.3.0",
     "description": "Simple utility for standardizing request and response objects.",
     "author": {
         "name": "Ishpreet Singh",

package/readme.md

@@ -120,6 +120,7 @@ Additionally if a `400 Bad request` is made, then this handler should handle it
 - 1.1.0: added rate limit error response in backend errors and handling it in global error handler (when using `@fastify/rate-limit`)
 - 1.1.1: fixed data response for the rate-limit in global error handler for fastify.
 - 1.2.0: added support for instance base path in error responses via environment variable.
+- 1.3.0: added support for rate-limiting when registering routes in the REGISTER_ROUTE function.
 
 #### Contact: