@harshror77/rate-limiter-sdk 1.0.0 → 1.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@harshror77/rate-limiter-sdk",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "type": "module",
   "main": "src/index.js",
   "dependencies": {

package/src/RateLimiterClient.js

@@ -1,23 +1,42 @@
 import axios from 'axios';
+import fs from 'fs';
+import path from 'path';
 
-export class RateLimiterClient{
-    constructor({serviceUrl, apiKey, timeout=3000}){
+// Extract the project name from the host environment ONCE when the SDK is initialized
+let autoProjectName = 'Unknown Project';
+try {
+    const pkgPath = path.resolve(process.cwd(), 'package.json');
+    if (fs.existsSync(pkgPath)) {
+        const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf8'));
+        if (pkg.name) {
+            autoProjectName = pkg.name;
+        }
+    }
+} catch (e) {
+    // Fail silently if package.json cannot be read, default to 'Unknown Project'
+}
+
+export class RateLimiterClient {
+    constructor({ serviceUrl, apiKey, timeout = 3000 }) {
         this.serviceUrl = serviceUrl;
         this.apiKey = apiKey;
         this.http = axios.create({
-            baseURL:serviceUrl,
+            baseURL: serviceUrl,
             timeout
         });
     }
 
-    async check(request={}){
-        try{
-            const response = await this.http.post('/api/check', request,{
-                headers:{'x-api-key':this.apiKey},
-            })
+    async check(request = {}) {
+        try {
+            const response = await this.http.post('/api/check', request, {
+                headers: { 
+                    'x-api-key': this.apiKey,
+                    'x-client-name': autoProjectName // <-- Send the extracted name
+                },
+            });
             return response.data;
-        }catch(err){
-            if(err.response){
+        } catch (err) {
+            if (err.response) {
                 return err.response.data;
             }
             throw err;

package/src/RateLimiterMiddleware.js

@@ -1,29 +1,66 @@
 import { RateLimiterClient } from './RateLimiterClient.js';
 
-export function RateLimiterMiddleware({ serviceUrl, apiKey, timeout }) {
+export function RateLimiterMiddleware({ serviceUrl, apiKey, timeout, onLimitExceeded } = {}) {
   const client = new RateLimiterClient({ serviceUrl, apiKey, timeout });
 
   return async function (req, res, next) {
     try {
       const result = await client.check({
         ip: req.ip,
-        userId: req.userId,
+        userId: req.user?.id || req.userId,
       });
 
+      res.setHeader('X-RateLimit-Remaining', result.remaining ?? 0);
+      res.setHeader('X-RateLimit-Reset', result.resetAt ?? 0);
+      res.setHeader('X-RateLimit-Denied-By', result.deniedBy || '');
+
       if (!result.allowed) {
-        res.setHeader('X-RateLimit-Remaining', result.remaining ?? 0);
+        const resetTime = result.resetAt
+          ? new Date(result.resetAt).toISOString()
+          : null;
+
+        const retryAfterSeconds = result.resetAt
+          ? Math.ceil((result.resetAt - Date.now()) / 1000)
+          : 60;
+
+        res.setHeader('Retry-After', retryAfterSeconds);
+
+        if (onLimitExceeded) {
+          return onLimitExceeded(req, res, result);
+        }
+
         return res.status(429).json({
-          error: 'Rate limit exceeded',
+          error: 'Too Many Requests',
+          message: buildMessage(result.deniedBy, retryAfterSeconds),
           deniedBy: result.deniedBy,
-          remaining: result.remaining,
+          remaining: result.remaining ?? 0,
           resetAt: result.resetAt,
+          retryAfter: `${retryAfterSeconds} seconds`,
+          retryAfterISO: resetTime,
         });
       }
 
-      res.setHeader('X-RateLimit-Remaining', result.remaining ?? 0);
       next();
     } catch (err) {
+      console.warn('[RateShield] Service unreachable, failing open:', err.message);
       next();
     }
   };
+}
+
+function buildMessage(deniedBy, retryAfterSeconds) {
+  const retry = retryAfterSeconds > 60
+    ? `${Math.ceil(retryAfterSeconds / 60)} minute(s)`
+    : `${retryAfterSeconds} second(s)`;
+
+  switch (deniedBy) {
+    case 'plan':
+      return `You have exceeded your plan's request limit. Please try again in ${retry}.`;
+    case 'ip':
+      return `Too many requests from your IP address. Please try again in ${retry}.`;
+    case 'user':
+      return `You are sending requests too quickly. Please slow down and try again in ${retry}.`;
+    default:
+      return `Rate limit exceeded. Please try again in ${retry}.`;
+  }
 }