@marufzak/rlimiter 1.0.0

package/README.md

@@ -0,0 +1 @@
+# rlimiter

package/dist/adapters/koa.d.ts

@@ -0,0 +1,8 @@
+import type { Context, Middleware } from 'koa';
+import type { RateLimiterOpts } from '../index.js';
+export interface KoaRateLimiterMiddlewareOpts extends RateLimiterOpts {
+    getKey: (ctx: Context) => string;
+    onLimit?: (key: string) => void;
+    onProceed?: (key: string) => void;
+}
+export declare const koaRateLimiterMiddleware: ({ maxTokens, refillSeconds, redisClient, getKey, onLimit, onProceed, }: KoaRateLimiterMiddlewareOpts) => Middleware;

package/dist/adapters/koa.js

@@ -0,0 +1,20 @@
+import RateLimiter from '../index.js';
+export const koaRateLimiterMiddleware = ({ maxTokens, refillSeconds, redisClient, getKey, onLimit, onProceed, }) => {
+    const limiter = new RateLimiter({
+        maxTokens,
+        refillSeconds,
+        redisClient,
+    });
+    return async (ctx, next) => {
+        const key = getKey(ctx);
+        const isAllowed = await limiter.check(key);
+        if (!isAllowed) {
+            ctx.status = 429;
+            onLimit?.(key);
+            return;
+        }
+        onProceed?.(key);
+        await next();
+    };
+};
+//# sourceMappingURL=koa.js.map

package/dist/adapters/koa.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"koa.js","sourceRoot":"","sources":["../../src/adapters/koa.ts"],"names":[],"mappings":"AAEA,OAAO,WAAW,MAAM,aAAa,CAAC;AAQtC,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,EACvC,SAAS,EACT,aAAa,EACb,WAAW,EACX,MAAM,EACN,OAAO,EACP,SAAS,GACoB,EAAc,EAAE;IAC7C,MAAM,OAAO,GAAG,IAAI,WAAW,CAAC;QAC9B,SAAS;QACT,aAAa;QACb,WAAW;KACZ,CAAC,CAAC;IAEH,OAAO,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QACzB,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,CAAC;QACxB,MAAM,SAAS,GAAG,MAAM,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;QAE3C,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC;YACjB,OAAO,EAAE,CAAC,GAAG,CAAC,CAAC;YACf,OAAO;QACT,CAAC;QAED,SAAS,EAAE,CAAC,GAAG,CAAC,CAAC;QACjB,MAAM,IAAI,EAAE,CAAC;IACf,CAAC,CAAC;AACJ,CAAC,CAAC"}

package/dist/index.d.ts

@@ -0,0 +1,14 @@
+import type { RedisClientType } from 'redis';
+export interface RateLimiterOpts {
+    maxTokens: number;
+    refillSeconds: number;
+    redisClient: RedisClientType;
+}
+declare class RateLimiter {
+    private maxTokens;
+    private refillSeconds;
+    private redisClient;
+    constructor({ maxTokens, refillSeconds, redisClient }: RateLimiterOpts);
+    check(key: string): Promise<boolean>;
+}
+export default RateLimiter;

package/dist/index.js

@@ -0,0 +1,41 @@
+class RateLimiter {
+    maxTokens = 0;
+    refillSeconds = 0;
+    redisClient;
+    constructor({ maxTokens, refillSeconds, redisClient }) {
+        this.maxTokens = maxTokens;
+        this.refillSeconds = refillSeconds;
+        this.redisClient = redisClient;
+    }
+    async check(key) {
+        const response = Boolean(await this.redisClient.eval(`
+          local countKey = KEYS[1]
+
+          local maxTokens = tonumber(ARGV[1])
+          local refillSeconds = tonumber(ARGV[2])
+
+          local count = tonumber(redis.call("GET", countKey))
+
+          if not count then
+            count = maxTokens
+            redis.call("SETEX", countKey, refillSeconds, maxTokens)
+          end
+
+          count = count - 1
+
+          if count < 0 then
+            return false
+          end
+
+          redis.call("SET", countKey, count, "KEEPTTL")
+
+          return true
+        `, {
+            keys: [key],
+            arguments: [this.maxTokens.toString(), this.refillSeconds.toString()],
+        }));
+        return response;
+    }
+}
+export default RateLimiter;
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAQA,MAAM,WAAW;IACP,SAAS,GAAG,CAAC,CAAC;IACd,aAAa,GAAG,CAAC,CAAC;IAClB,WAAW,CAAkB;IAErC,YAAY,EAAE,SAAS,EAAE,aAAa,EAAE,WAAW,EAAmB;QACpE,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,WAAW,GAAG,WAAW,CAAC;IACjC,CAAC;IAED,KAAK,CAAC,KAAK,CAAC,GAAW;QACrB,MAAM,QAAQ,GAAG,OAAO,CACtB,MAAM,IAAI,CAAC,WAAW,CAAC,IAAI,CACzB;;;;;;;;;;;;;;;;;;;;;;SAsBC,EACD;YACE,IAAI,EAAE,CAAC,GAAG,CAAC;YACX,SAAS,EAAE,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,EAAE,IAAI,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC;SACtE,CACF,CACF,CAAC;QAEF,OAAO,QAAQ,CAAC;IAClB,CAAC;CACF;AAED,eAAe,WAAW,CAAC"}

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@marufzak/rlimiter",
+  "version": "1.0.0",
+  "description": "Rate limiter for NodeJS",
+  "type": "module",
+  "keywords": [
+    "rate-limiter",
+    "nodejs"
+  ],
+  "files": [
+    "dist",
+    "package.json",
+    "README.md"
+  ],
+  "author": "marufzak",
+  "license": "MIT",
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "@testcontainers/redis": "^11.11.0",
+    "@types/koa": "^3.0.1",
+    "@types/node": "^25.2.2",
+    "@types/supertest": "^6.0.3",
+    "eslint": "^10.0.0",
+    "globals": "^17.3.0",
+    "jiti": "^2.6.1",
+    "koa": "^3.1.1",
+    "prettier": "3.8.1",
+    "redis": "^5.10.0",
+    "supertest": "^7.2.2",
+    "tsx": "^4.21.0",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.54.0",
+    "vitest": "^4.0.18"
+  },
+  "scripts": {
+    "dev": "tsx watch src/index.ts",
+    "build": "rm -rf dist && tsc -p ./tsconfig.json",
+    "test": "vitest",
+    "typecheck": "tsc --noEmit -p ./tsconfig.json",
+    "lint:check": "eslint . --ext .ts",
+    "lint:write": "eslint . --ext .ts --fix",
+    "format:write": "prettier --cache --write \"**/*.{ts,json}\"",
+    "format:check": "prettier --cache --check \"**/*.{ts,json}\""
+  }
+}