@ooneex/rate-limit 0.0.1 → 0.0.5

package/dist/index.d.ts

@@ -0,0 +1,36 @@
+import { Exception } from "@ooneex/exception";
+declare class RateLimitException extends Exception {
+	constructor(message: string, data?: Record<string, unknown>);
+}
+type RateLimiterClassType = new (...args: any[]) => IRateLimiter;
+type RedisRateLimiterOptionsType = {
+	connectionString?: string;
+	connectionTimeout?: number;
+	idleTimeout?: number;
+	autoReconnect?: boolean;
+	maxRetries?: number;
+	enableOfflineQueue?: boolean;
+	enableAutoPipelining?: boolean;
+	tls?: boolean | object;
+};
+type RateLimitResultType = {
+	limited: boolean;
+	remaining: number;
+	total: number;
+	resetAt: Date;
+};
+interface IRateLimiter {
+	check: (key: string, limit: number, windowSeconds: number) => Promise<RateLimitResultType>;
+	reset: (key: string) => Promise<boolean>;
+	getCount: (key: string) => Promise<number>;
+}
+declare class RedisRateLimiter implements IRateLimiter {
+	private client;
+	constructor(options?: RedisRateLimiterOptionsType);
+	private connect;
+	private getKey;
+	check(key: string, limit: number, windowSeconds: number): Promise<RateLimitResultType>;
+	reset(key: string): Promise<boolean>;
+	getCount(key: string): Promise<number>;
+}
+export { RedisRateLimiterOptionsType, RedisRateLimiter, RateLimiterClassType, RateLimitResultType, RateLimitException, IRateLimiter };

package/dist/index.js

@@ -1,4 +1,4 @@
 // @bun
-var c=void 0;export{c as default};
+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};
 
-//# debugId=739F3CA43E7B60FB64756E2164756E21
+//# debugId=DD9E5A2DC9D13F5664756E2164756E21

package/dist/index.js.map

@@ -1,9 +1,11 @@
 {
   "version": 3,
-  "sources": [],
+  "sources": ["src/RateLimitException.ts", "src/RedisRateLimiter.ts"],
   "sourcesContent": [
+    "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": "",
-  "debugId": "739F3CA43E7B60FB64756E2164756E21",
+  "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",
   "names": []
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ooneex/rate-limit",
-  "description": "",
-  "version": "0.0.1",
+  "description": "Rate limiting middleware for API request throttling and abuse prevention",
+  "version": "0.0.5",
   "type": "module",
   "files": [
     "dist",
@@ -10,9 +10,13 @@
     "package.json"
   ],
   "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
-      "import": "./dist/index.js"
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
     },
     "./package.json": "./package.json"
   },
@@ -21,10 +25,23 @@
     "test": "bun test tests",
     "build": "bunup",
     "lint": "tsgo --noEmit && bunx biome lint",
-    "publish:prod": "bun publish --tolerate-republish --access public",
-    "publish:pack": "bun pm pack --destination ./dist",
-    "publish:dry": "bun publish --dry-run"
+    "npm:publish": "bun publish --tolerate-republish --access public"
   },
-  "devDependencies": {},
-  "peerDependencies": {}
+  "peerDependencies": {
+    "@ooneex/exception": "0.0.1",
+    "@ooneex/http-status": "0.0.1"
+  },
+  "dependencies": {
+    "@ooneex/exception": "0.0.1",
+    "@ooneex/http-status": "0.0.1"
+  },
+  "keywords": [
+    "api",
+    "bun",
+    "ooneex",
+    "rate-limit",
+    "rate-limiting",
+    "throttle",
+    "typescript"
+  ]
 }