@divine-lab/request 1.1.1 → 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/dist/fastify-helpers/index.js

@@ -13,6 +13,8 @@ const APIError_1 = require("../errors/APIError");
 const logger_1 = __importDefault(require("@divine-lab/logger"));
 const API_LOG = process.env.DIVINE_LAB_REQUEST_API_LOG === "true";
 logger_1.default.raw(`${(0, colors_1.colorize)("blue", "[API]")} - API logging is ${API_LOG ? (0, colors_1.colorize)("green", "enabled") : (0, colors_1.colorize)("red", "disabled")} - ${API_LOG ? "API requests and responses will be logged." : `to enable, set ${(0, colors_1.colorize)("yellow", "DIVINE_LAB_REQUEST_API_LOG")}=true in environment variables`}`);
+const INSTANCE_BASE = process.env.DIVINE_LAB_REQUEST_INSTANCE_BASE || "";
+logger_1.default.raw(`${(0, colors_1.colorize)("blue", "[API]")} - API instance base path is set to ${(0, colors_1.colorize)("yellow", INSTANCE_BASE)}. Configure this with the ${(0, colors_1.colorize)("yellow", "DIVINE_LAB_REQUEST_INSTANCE_BASE")} environment variable.`);
 /** Sends a standardized error response.
  * Uses the RFC 9457 Format.
  * @param res - Fastify reply object
@@ -30,7 +32,7 @@ function errorResponse(res, error, { title, detail, type, data, status } = {}) {
         logger_1.default.raw(`${new Date().toISOString()} ${(0, colors_1.colorize)("red", "[API]")} - ${(0, colors_1.colorize)("gray", res.request.ip)} - ${(0, colors_1.colorize)("red", (status || errorDef.status))} - ${res.request.url} : ${(0, colors_1.colorize)("gray", `${title || errorDef.title} - ${detail || errorDef.detail}`)}`);
     res.code(status || errorDef.status).send({
         status: status || errorDef.status,
-        instance: res.request.url,
+        instance: `${INSTANCE_BASE}${res.request.url}`,
         title: title || errorDef.title,
         detail: detail || errorDef.detail,
         type: type || errorDef.type,

package/package.json

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

package/readme.md

@@ -110,13 +110,17 @@ Additionally if a `400 Bad request` is made, then this handler should handle it
 
 ### Environment Variables
 
-Supports API response logging via <a>`@divine-lab/logger`</a>.
-Enable by setting ENV Variable `DIVINE_LAB_REQUEST_API_LOG` to `true`.
+- Supports API response logging via <a>`@divine-lab/logger`</a>.
+  Enable by setting ENV Variable `DIVINE_LAB_REQUEST_API_LOG` to `true`.
+- Supports base path for `instance` property of error responses via `DIVINE_LAB_REQUEST_INSTANCE_BASE`,
+  Defaults to empty string.
 
 #### Updates:
 
 - 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: