@divine-lab/request 1.0.4 → 1.1.0

package/dist/errors/BackendErrors.d.ts

@@ -52,6 +52,12 @@ export declare const SERVER_ERRORS: {
         readonly title: "Conflict";
         readonly detail: "The request conflicts with the current state of the server.";
     };
+    readonly TOO_MANY_REQUESTS: {
+        readonly status: 429;
+        readonly type: "about:blank";
+        readonly title: "Too Many Requests";
+        readonly detail: "The user has sent too many requests in a given amount of time.";
+    };
 };
 export type ServerErrorKey = keyof typeof SERVER_ERRORS;
 export type ServerErrorOptions = {

package/dist/errors/BackendErrors.js

@@ -55,4 +55,10 @@ exports.SERVER_ERRORS = {
         title: "Conflict",
         detail: "The request conflicts with the current state of the server.",
     },
+    TOO_MANY_REQUESTS: {
+        status: 429,
+        type: "about:blank",
+        title: "Too Many Requests",
+        detail: "The user has sent too many requests in a given amount of time.",
+    },
 };

package/dist/fastify-helpers/index.js

@@ -100,8 +100,14 @@ function REGISTER_ROUTE(fastify, method, path, handler, options) {
 async function globalErrorHandler(error, _request, reply) {
     if (error instanceof APIError_1.APIError)
         return errorResponse(reply, error.error, { title: error.title, detail: error.detail, type: error.type, data: error.data, status: error.status });
-    if (error.validation)
-        return errorResponse(reply, "BAD_REQUEST", { detail: error.message, data: null });
+    if (error.statusCode && error.statusCode === 429)
+        return errorResponse(reply, "TOO_MANY_REQUESTS", { title: "Too Many Requests", detail: "You have sent too many requests in a given amount of time. Please try again later.", data: error.message.match(/\d+\s+\w+/)?.[0], status: 429 });
+    if (error.validation) {
+        const data = [];
+        for (const err of error.validation)
+            data.push({ property: err.instancePath ? err.instancePath.substring(1) : err.params.missingProperty || "unknown", message: `${error.validationContext} ${err.message}` });
+        return errorResponse(reply, "BAD_REQUEST", { detail: "Invalid request data, try again with proper formatting", data: data });
+    }
     logger_1.default.error(`Error processing request: ${error.message}`);
     return errorResponse(reply, "INTERNAL_SERVER_ERROR", { title: "Internal Server Error", detail: "An unexpected error occurred", type: "about:blank", data: null, status: 500 });
 }

package/package.json

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

package/readme.md

@@ -14,7 +14,7 @@ success response and error response both follow a defined standard.
 These functions are defined to be used with fastify for now.
 
 ```ts
-import { successResponse } from "@divine-lab/request/fastify-helpers"
+import { successResponse } from "@divine-lab/request/fastify-helpers";
 
 // Mock type
 type SuccessResponse = {
@@ -22,22 +22,22 @@ type SuccessResponse = {
     title: string;
     detail: string;
     data: any;
-}
+};
 
 // Example of a success response:
 const userCreatedResponse: SuccessResponse = {
     success: true,
     title: "Account created successfully",
-    detail: "You will recieve a email confirming the account creation in a 5-10 minutes."
-    data: { id: 1, name: "user", age: 21 }
-}
+    detail: "You will recieve a email confirming the account creation in a 5-10 minutes.",
+    data: { id: 1, name: "user", age: 21 },
+};
 
 // Example success response
-successResponse(res, 200, userCreatedResponse)
+successResponse(res, 200, userCreatedResponse);
 ```
 
 ```ts
-import { errorResponse } from "@divine-lab/request/fastify-helpers"
+import { errorResponse } from "@divine-lab/request/fastify-helpers";
 
 // Mock type
 type ErrorResponse = {
@@ -47,7 +47,7 @@ type ErrorResponse = {
     type: string;
     instance: string;
     data: any;
-}
+};
 
 // Example of Error Response
 const userNotFoundError: ErrorResponse = {
@@ -55,12 +55,12 @@ const userNotFoundError: ErrorResponse = {
     title: "User Not Found",
     detail: "The User with the user id '1' not found in our database, please contact customer support if this is a mistake.",
     type: "http://example-errors.com/404/user-not-found",
-    instance: "/users/1"
-    data: null
-}
+    instance: "/users/1",
+    data: null,
+};
 
 // example error response
-errorResponse(res, "UNKNOWN", userNotFoundError)
+errorResponse(res, "UNKNOWN", userNotFoundError);
 ```
 
 Note: RFC9457 requires error responses to contain `instance` in the response. Right now all error responses automatically attach the request url as the instance.
@@ -115,4 +115,4 @@ Enable by setting ENV Variable `DIVINE_LAB_REQUEST_API_LOG` to `true`.
 
 #### Contact:
 
-- mail: <a href="mailto:ishpreet7521@gmail.com">ishpreet7521@gmail.com<a>
+- mail: <a href="mailto:ishpreet@appshala.com">ishpreet@appshala.com<a>