@ooneex/rate-limit 0.0.12 → 0.0.13

package/dist/index.js

@@ -1,4 +1,92 @@
 // @bun
-import{Exception as b}from"@ooneex/exception";import{HttpStatus as p}from"@ooneex/http-status";class t extends b{constructor(n,e={}){super(n,{status:p.Code.TooManyRequests,data:e});this.name="RateLimitException"}}class u{client;constructor(n={}){let e=n.connectionString||Bun.env.RATE_LIMIT_REDIS_URL;if(!e)throw new t("Redis connection string is required. Please provide a connection string either through the constructor options or set the RATE_LIMIT_REDIS_URL environment variable.");let{connectionString:o,...r}=n,m={...{connectionTimeout:1e4,idleTimeout:30000,autoReconnect:!0,maxRetries:3,enableOfflineQueue:!0,enableAutoPipelining:!0},...r};this.client=new Bun.RedisClient(e,m)}async connect(){if(!this.client.connected)await this.client.connect()}getKey(n){return`ratelimit:${n}`}async check(n,e,o){try{await this.connect();let r=this.getKey(n),s=await this.client.incr(r);if(s===1)await this.client.expire(r,o);let m=await this.client.ttl(r),a=new Date(Date.now()+m*1000);return{limited:s>e,remaining:Math.max(0,e-s),total:e,resetAt:a}}catch(r){throw new t(`Failed to check rate limit for key "${n}": ${r}`)}}async reset(n){try{await this.connect();let e=this.getKey(n);return await this.client.del(e)>0}catch(e){throw new t(`Failed to reset rate limit for key "${n}": ${e}`)}}async getCount(n){try{await this.connect();let e=this.getKey(n),o=await this.client.get(e);if(o===null)return 0;return Number.parseInt(o,10)}catch(e){throw new t(`Failed to get count for key "${n}": ${e}`)}}}export{u as RedisRateLimiter,t as RateLimitException};
+// src/RateLimitException.ts
+import { Exception } from "@ooneex/exception";
+import { HttpStatus } from "@ooneex/http-status";
 
-//# debugId=DD9E5A2DC9D13F5664756E2164756E21
+class RateLimitException extends Exception {
+  constructor(message, data = {}) {
+    super(message, {
+      status: HttpStatus.Code.TooManyRequests,
+      data
+    });
+    this.name = "RateLimitException";
+  }
+}
+// src/RedisRateLimiter.ts
+class RedisRateLimiter {
+  client;
+  constructor(options = {}) {
+    const connectionString = options.connectionString || Bun.env.RATE_LIMIT_REDIS_URL;
+    if (!connectionString) {
+      throw new RateLimitException("Redis connection string is required. Please provide a connection string either through the constructor options or set the RATE_LIMIT_REDIS_URL environment variable.");
+    }
+    const { connectionString: _, ...userOptions } = options;
+    const defaultOptions = {
+      connectionTimeout: 1e4,
+      idleTimeout: 30000,
+      autoReconnect: true,
+      maxRetries: 3,
+      enableOfflineQueue: true,
+      enableAutoPipelining: true
+    };
+    const clientOptions = { ...defaultOptions, ...userOptions };
+    this.client = new Bun.RedisClient(connectionString, clientOptions);
+  }
+  async connect() {
+    if (!this.client.connected) {
+      await this.client.connect();
+    }
+  }
+  getKey(key) {
+    return `ratelimit:${key}`;
+  }
+  async check(key, limit, windowSeconds) {
+    try {
+      await this.connect();
+      const rateLimitKey = this.getKey(key);
+      const count = await this.client.incr(rateLimitKey);
+      if (count === 1) {
+        await this.client.expire(rateLimitKey, windowSeconds);
+      }
+      const ttl = await this.client.ttl(rateLimitKey);
+      const resetAt = new Date(Date.now() + ttl * 1000);
+      return {
+        limited: count > limit,
+        remaining: Math.max(0, limit - count),
+        total: limit,
+        resetAt
+      };
+    } catch (error) {
+      throw new RateLimitException(`Failed to check rate limit for key "${key}": ${error}`);
+    }
+  }
+  async reset(key) {
+    try {
+      await this.connect();
+      const rateLimitKey = this.getKey(key);
+      const result = await this.client.del(rateLimitKey);
+      return result > 0;
+    } catch (error) {
+      throw new RateLimitException(`Failed to reset rate limit for key "${key}": ${error}`);
+    }
+  }
+  async getCount(key) {
+    try {
+      await this.connect();
+      const rateLimitKey = this.getKey(key);
+      const value = await this.client.get(rateLimitKey);
+      if (value === null) {
+        return 0;
+      }
+      return Number.parseInt(value, 10);
+    } catch (error) {
+      throw new RateLimitException(`Failed to get count for key "${key}": ${error}`);
+    }
+  }
+}
+export {
+  RedisRateLimiter,
+  RateLimitException
+};
+
+//# debugId=8B4110D29147325A64756E2164756E21

package/dist/index.js.map

@@ -5,7 +5,7 @@
     "import { Exception } from \"@ooneex/exception\";\nimport { HttpStatus } from \"@ooneex/http-status\";\n\nexport class RateLimitException extends Exception {\n  constructor(message: string, data: Record<string, unknown> = {}) {\n    super(message, {\n      status: HttpStatus.Code.TooManyRequests,\n      data,\n    });\n    this.name = \"RateLimitException\";\n  }\n}\n",
     "import { RateLimitException } from \"./RateLimitException\";\nimport type { IRateLimiter, RateLimitResultType, RedisRateLimiterOptionsType } from \"./types\";\n\nexport class RedisRateLimiter implements IRateLimiter {\n  private client: Bun.RedisClient;\n\n  constructor(options: RedisRateLimiterOptionsType = {}) {\n    const connectionString = options.connectionString || Bun.env.RATE_LIMIT_REDIS_URL;\n\n    if (!connectionString) {\n      throw new RateLimitException(\n        \"Redis connection string is required. Please provide a connection string either through the constructor options or set the RATE_LIMIT_REDIS_URL environment variable.\",\n      );\n    }\n\n    const { connectionString: _, ...userOptions } = options;\n\n    const defaultOptions = {\n      connectionTimeout: 10_000,\n      idleTimeout: 30_000,\n      autoReconnect: true,\n      maxRetries: 3,\n      enableOfflineQueue: true,\n      enableAutoPipelining: true,\n    };\n\n    const clientOptions = { ...defaultOptions, ...userOptions };\n\n    this.client = new Bun.RedisClient(connectionString, clientOptions);\n  }\n\n  private async connect(): Promise<void> {\n    if (!this.client.connected) {\n      await this.client.connect();\n    }\n  }\n\n  private getKey(key: string): string {\n    return `ratelimit:${key}`;\n  }\n\n  public async check(key: string, limit: number, windowSeconds: number): Promise<RateLimitResultType> {\n    try {\n      await this.connect();\n\n      const rateLimitKey = this.getKey(key);\n\n      // Increment counter\n      const count = await this.client.incr(rateLimitKey);\n\n      // Set expiry if this is the first request in window\n      if (count === 1) {\n        await this.client.expire(rateLimitKey, windowSeconds);\n      }\n\n      // Get TTL for reset time calculation\n      const ttl = await this.client.ttl(rateLimitKey);\n      const resetAt = new Date(Date.now() + ttl * 1000);\n\n      return {\n        limited: count > limit,\n        remaining: Math.max(0, limit - count),\n        total: limit,\n        resetAt,\n      };\n    } catch (error) {\n      throw new RateLimitException(`Failed to check rate limit for key \"${key}\": ${error}`);\n    }\n  }\n\n  public async reset(key: string): Promise<boolean> {\n    try {\n      await this.connect();\n\n      const rateLimitKey = this.getKey(key);\n      const result = await this.client.del(rateLimitKey);\n\n      return result > 0;\n    } catch (error) {\n      throw new RateLimitException(`Failed to reset rate limit for key \"${key}\": ${error}`);\n    }\n  }\n\n  public async getCount(key: string): Promise<number> {\n    try {\n      await this.connect();\n\n      const rateLimitKey = this.getKey(key);\n      const value = await this.client.get(rateLimitKey);\n\n      if (value === null) {\n        return 0;\n      }\n\n      return Number.parseInt(value, 10);\n    } catch (error) {\n      throw new RateLimitException(`Failed to get count for key \"${key}\": ${error}`);\n    }\n  }\n}\n"
   ],
-  "mappings": ";AAAA,oBAAS,0BACT,qBAAS,4BAEF,MAAM,UAA2B,CAAU,CAChD,WAAW,CAAC,EAAiB,EAAgC,CAAC,EAAG,CAC/D,MAAM,EAAS,CACb,OAAQ,EAAW,KAAK,gBACxB,MACF,CAAC,EACD,KAAK,KAAO,qBAEhB,CCRO,MAAM,CAAyC,CAC5C,OAER,WAAW,CAAC,EAAuC,CAAC,EAAG,CACrD,IAAM,EAAmB,EAAQ,kBAAoB,IAAI,IAAI,qBAE7D,GAAI,CAAC,EACH,MAAM,IAAI,EACR,sKACF,EAGF,IAAQ,iBAAkB,KAAM,GAAgB,EAW1C,EAAgB,IATC,CACrB,kBAAmB,IACnB,YAAa,MACb,cAAe,GACf,WAAY,EACZ,mBAAoB,GACpB,qBAAsB,EACxB,KAE8C,CAAY,EAE1D,KAAK,OAAS,IAAI,IAAI,YAAY,EAAkB,CAAa,OAGrD,QAAO,EAAkB,CACrC,GAAI,CAAC,KAAK,OAAO,UACf,MAAM,KAAK,OAAO,QAAQ,EAItB,MAAM,CAAC,EAAqB,CAClC,MAAO,aAAa,SAGT,MAAK,CAAC,EAAa,EAAe,EAAqD,CAClG,GAAI,CACF,MAAM,KAAK,QAAQ,EAEnB,IAAM,EAAe,KAAK,OAAO,CAAG,EAG9B,EAAQ,MAAM,KAAK,OAAO,KAAK,CAAY,EAGjD,GAAI,IAAU,EACZ,MAAM,KAAK,OAAO,OAAO,EAAc,CAAa,EAItD,IAAM,EAAM,MAAM,KAAK,OAAO,IAAI,CAAY,EACxC,EAAU,IAAI,KAAK,KAAK,IAAI,EAAI,EAAM,IAAI,EAEhD,MAAO,CACL,QAAS,EAAQ,EACjB,UAAW,KAAK,IAAI,EAAG,EAAQ,CAAK,EACpC,MAAO,EACP,SACF,EACA,MAAO,EAAO,CACd,MAAM,IAAI,EAAmB,uCAAuC,OAAS,GAAO,QAI3E,MAAK,CAAC,EAA+B,CAChD,GAAI,CACF,MAAM,KAAK,QAAQ,EAEnB,IAAM,EAAe,KAAK,OAAO,CAAG,EAGpC,OAFe,MAAM,KAAK,OAAO,IAAI,CAAY,EAEjC,EAChB,MAAO,EAAO,CACd,MAAM,IAAI,EAAmB,uCAAuC,OAAS,GAAO,QAI3E,SAAQ,CAAC,EAA8B,CAClD,GAAI,CACF,MAAM,KAAK,QAAQ,EAEnB,IAAM,EAAe,KAAK,OAAO,CAAG,EAC9B,EAAQ,MAAM,KAAK,OAAO,IAAI,CAAY,EAEhD,GAAI,IAAU,KACZ,MAAO,GAGT,OAAO,OAAO,SAAS,EAAO,EAAE,EAChC,MAAO,EAAO,CACd,MAAM,IAAI,EAAmB,gCAAgC,OAAS,GAAO,GAGnF",
-  "debugId": "DD9E5A2DC9D13F5664756E2164756E21",
+  "mappings": ";;AAAA;AACA;AAAA;AAEO,MAAM,2BAA2B,UAAU;AAAA,EAChD,WAAW,CAAC,SAAiB,OAAgC,CAAC,GAAG;AAAA,IAC/D,MAAM,SAAS;AAAA,MACb,QAAQ,WAAW,KAAK;AAAA,MACxB;AAAA,IACF,CAAC;AAAA,IACD,KAAK,OAAO;AAAA;AAEhB;;ACRO,MAAM,iBAAyC;AAAA,EAC5C;AAAA,EAER,WAAW,CAAC,UAAuC,CAAC,GAAG;AAAA,IACrD,MAAM,mBAAmB,QAAQ,oBAAoB,IAAI,IAAI;AAAA,IAE7D,IAAI,CAAC,kBAAkB;AAAA,MACrB,MAAM,IAAI,mBACR,sKACF;AAAA,IACF;AAAA,IAEA,QAAQ,kBAAkB,MAAM,gBAAgB;AAAA,IAEhD,MAAM,iBAAiB;AAAA,MACrB,mBAAmB;AAAA,MACnB,aAAa;AAAA,MACb,eAAe;AAAA,MACf,YAAY;AAAA,MACZ,oBAAoB;AAAA,MACpB,sBAAsB;AAAA,IACxB;AAAA,IAEA,MAAM,gBAAgB,KAAK,mBAAmB,YAAY;AAAA,IAE1D,KAAK,SAAS,IAAI,IAAI,YAAY,kBAAkB,aAAa;AAAA;AAAA,OAGrD,QAAO,GAAkB;AAAA,IACrC,IAAI,CAAC,KAAK,OAAO,WAAW;AAAA,MAC1B,MAAM,KAAK,OAAO,QAAQ;AAAA,IAC5B;AAAA;AAAA,EAGM,MAAM,CAAC,KAAqB;AAAA,IAClC,OAAO,aAAa;AAAA;AAAA,OAGT,MAAK,CAAC,KAAa,OAAe,eAAqD;AAAA,IAClG,IAAI;AAAA,MACF,MAAM,KAAK,QAAQ;AAAA,MAEnB,MAAM,eAAe,KAAK,OAAO,GAAG;AAAA,MAGpC,MAAM,QAAQ,MAAM,KAAK,OAAO,KAAK,YAAY;AAAA,MAGjD,IAAI,UAAU,GAAG;AAAA,QACf,MAAM,KAAK,OAAO,OAAO,cAAc,aAAa;AAAA,MACtD;AAAA,MAGA,MAAM,MAAM,MAAM,KAAK,OAAO,IAAI,YAAY;AAAA,MAC9C,MAAM,UAAU,IAAI,KAAK,KAAK,IAAI,IAAI,MAAM,IAAI;AAAA,MAEhD,OAAO;AAAA,QACL,SAAS,QAAQ;AAAA,QACjB,WAAW,KAAK,IAAI,GAAG,QAAQ,KAAK;AAAA,QACpC,OAAO;AAAA,QACP;AAAA,MACF;AAAA,MACA,OAAO,OAAO;AAAA,MACd,MAAM,IAAI,mBAAmB,uCAAuC,SAAS,OAAO;AAAA;AAAA;AAAA,OAI3E,MAAK,CAAC,KAA+B;AAAA,IAChD,IAAI;AAAA,MACF,MAAM,KAAK,QAAQ;AAAA,MAEnB,MAAM,eAAe,KAAK,OAAO,GAAG;AAAA,MACpC,MAAM,SAAS,MAAM,KAAK,OAAO,IAAI,YAAY;AAAA,MAEjD,OAAO,SAAS;AAAA,MAChB,OAAO,OAAO;AAAA,MACd,MAAM,IAAI,mBAAmB,uCAAuC,SAAS,OAAO;AAAA;AAAA;AAAA,OAI3E,SAAQ,CAAC,KAA8B;AAAA,IAClD,IAAI;AAAA,MACF,MAAM,KAAK,QAAQ;AAAA,MAEnB,MAAM,eAAe,KAAK,OAAO,GAAG;AAAA,MACpC,MAAM,QAAQ,MAAM,KAAK,OAAO,IAAI,YAAY;AAAA,MAEhD,IAAI,UAAU,MAAM;AAAA,QAClB,OAAO;AAAA,MACT;AAAA,MAEA,OAAO,OAAO,SAAS,OAAO,EAAE;AAAA,MAChC,OAAO,OAAO;AAAA,MACd,MAAM,IAAI,mBAAmB,gCAAgC,SAAS,OAAO;AAAA;AAAA;AAGnF;",
+  "debugId": "8B4110D29147325A64756E2164756E21",
   "names": []
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ooneex/rate-limit",
   "description": "Rate limiting middleware for API request throttling and abuse prevention",
-  "version": "0.0.12",
+  "version": "0.0.13",
   "type": "module",
   "files": [
     "dist",