@xyph3r/rate-limiter 0.1.0

package/dist/utils/headers.js

@@ -0,0 +1,16 @@
+export function buildRateLimitHeaders(decision) {
+    return {
+        "ratelimit-limit": String(decision.limit),
+        "ratelimit-remaining": String(decision.remaining),
+        "ratelimit-reset": String(Math.max(0, Math.ceil(decision.resetAfterMs / 1000))),
+        "ratelimit-policy": decision.policy,
+        "retry-after": String(decision.retryAfterSeconds),
+    };
+}
+export function applyHeaders(setHeader, decision) {
+    const headers = buildRateLimitHeaders(decision);
+    for (const [name, value] of Object.entries(headers)) {
+        setHeader(name, value);
+    }
+}
+//# sourceMappingURL=headers.js.map

package/dist/utils/headers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"headers.js","sourceRoot":"","sources":["../../src/utils/headers.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,qBAAqB,CACnC,QAA2B;IAE3B,OAAO;QACL,iBAAiB,EAAE,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;QACzC,qBAAqB,EAAE,MAAM,CAAC,QAAQ,CAAC,SAAS,CAAC;QACjD,iBAAiB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,YAAY,GAAG,IAAI,CAAC,CAAC,CAAC;QAC/E,kBAAkB,EAAE,QAAQ,CAAC,MAAM;QACnC,aAAa,EAAE,MAAM,CAAC,QAAQ,CAAC,iBAAiB,CAAC;KAClD,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,YAAY,CAC1B,SAAgD,EAChD,QAA2B;IAE3B,MAAM,OAAO,GAAG,qBAAqB,CAAC,QAAQ,CAAC,CAAC;IAChD,KAAK,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACpD,SAAS,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACzB,CAAC;AACH,CAAC"}

package/dist/utils/http.d.ts

@@ -0,0 +1,11 @@
+export interface HeaderCarrier {
+    headers?: Record<string, string | string[] | undefined>;
+    ip?: string;
+    socket?: {
+        remoteAddress?: string;
+    };
+}
+export declare function getDefaultKeyFromHeaders(getHeader: (name: string) => string | null | undefined): string;
+export declare function getDefaultKeyFromRequest(request: HeaderCarrier): string;
+export declare function getDefaultKeyFromFetchRequest(request: Request): string;
+//# sourceMappingURL=http.d.ts.map

package/dist/utils/http.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.d.ts","sourceRoot":"","sources":["../../src/utils/http.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,aAAa;IAC5B,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,CAAC,CAAC;IACxD,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ,MAAM,CAAC,EAAE;QACP,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB,CAAC;CACH;AAED,wBAAgB,wBAAwB,CACtC,SAAS,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,MAAM,GAAG,IAAI,GAAG,SAAS,GACrD,MAAM,CAiBR;AAED,wBAAgB,wBAAwB,CAAC,OAAO,EAAE,aAAa,GAAG,MAAM,CA2BvE;AAED,wBAAgB,6BAA6B,CAAC,OAAO,EAAE,OAAO,GAAG,MAAM,CAEtE"}

package/dist/utils/http.js

@@ -0,0 +1,41 @@
+export function getDefaultKeyFromHeaders(getHeader) {
+    const forwarded = getHeader("x-forwarded-for");
+    if (forwarded && forwarded.length > 0) {
+        return forwarded.split(",")[0]?.trim() || "anonymous";
+    }
+    const realIp = getHeader("x-real-ip");
+    if (realIp && realIp.length > 0) {
+        return realIp.trim();
+    }
+    const cfConnectingIp = getHeader("cf-connecting-ip");
+    if (cfConnectingIp && cfConnectingIp.length > 0) {
+        return cfConnectingIp.trim();
+    }
+    return "anonymous";
+}
+export function getDefaultKeyFromRequest(request) {
+    const forwarded = request.headers?.["x-forwarded-for"];
+    const realIp = request.headers?.["x-real-ip"];
+    const cfConnectingIp = request.headers?.["cf-connecting-ip"];
+    const key = getDefaultKeyFromHeaders((name) => {
+        if (name === "x-forwarded-for") {
+            if (typeof forwarded === "string") {
+                return forwarded;
+            }
+            return forwarded?.[0];
+        }
+        const candidate = name === "x-real-ip" ? realIp : cfConnectingIp;
+        if (typeof candidate === "string") {
+            return candidate;
+        }
+        return candidate?.[0];
+    });
+    if (key !== "anonymous") {
+        return key;
+    }
+    return request.ip || request.socket?.remoteAddress || "anonymous";
+}
+export function getDefaultKeyFromFetchRequest(request) {
+    return getDefaultKeyFromHeaders((name) => request.headers.get(name));
+}
+//# sourceMappingURL=http.js.map

package/dist/utils/http.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http.js","sourceRoot":"","sources":["../../src/utils/http.ts"],"names":[],"mappings":"AAQA,MAAM,UAAU,wBAAwB,CACtC,SAAsD;IAEtD,MAAM,SAAS,GAAG,SAAS,CAAC,iBAAiB,CAAC,CAAC;IAC/C,IAAI,SAAS,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACtC,OAAO,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,WAAW,CAAC;IACxD,CAAC;IAED,MAAM,MAAM,GAAG,SAAS,CAAC,WAAW,CAAC,CAAC;IACtC,IAAI,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChC,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC;IACvB,CAAC;IAED,MAAM,cAAc,GAAG,SAAS,CAAC,kBAAkB,CAAC,CAAC;IACrD,IAAI,cAAc,IAAI,cAAc,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAChD,OAAO,cAAc,CAAC,IAAI,EAAE,CAAC;IAC/B,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,MAAM,UAAU,wBAAwB,CAAC,OAAsB;IAC7D,MAAM,SAAS,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,iBAAiB,CAAC,CAAC;IACvD,MAAM,MAAM,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,WAAW,CAAC,CAAC;IAC9C,MAAM,cAAc,GAAG,OAAO,CAAC,OAAO,EAAE,CAAC,kBAAkB,CAAC,CAAC;IAE7D,MAAM,GAAG,GAAG,wBAAwB,CAAC,CAAC,IAAI,EAAE,EAAE;QAC5C,IAAI,IAAI,KAAK,iBAAiB,EAAE,CAAC;YAC/B,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;gBAClC,OAAO,SAAS,CAAC;YACnB,CAAC;YAED,OAAO,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;QACxB,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,KAAK,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,cAAc,CAAC;QACjE,IAAI,OAAO,SAAS,KAAK,QAAQ,EAAE,CAAC;YAClC,OAAO,SAAS,CAAC;QACnB,CAAC;QAED,OAAO,SAAS,EAAE,CAAC,CAAC,CAAC,CAAC;IACxB,CAAC,CAAC,CAAC;IAEH,IAAI,GAAG,KAAK,WAAW,EAAE,CAAC;QACxB,OAAO,GAAG,CAAC;IACb,CAAC;IAED,OAAO,OAAO,CAAC,EAAE,IAAI,OAAO,CAAC,MAAM,EAAE,aAAa,IAAI,WAAW,CAAC;AACpE,CAAC;AAED,MAAM,UAAU,6BAA6B,CAAC,OAAgB;IAC5D,OAAO,wBAAwB,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;AACvE,CAAC"}

package/dist/utils/math.d.ts

@@ -0,0 +1,4 @@
+export declare function clamp(value: number, min: number, max: number): number;
+export declare function toWholeNumber(value: number): number;
+export declare function normalizeRawRedisResult(raw: unknown, strategyName: string): [string, string, string, string, string, string, string];
+//# sourceMappingURL=math.d.ts.map

package/dist/utils/math.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"math.d.ts","sourceRoot":"","sources":["../../src/utils/math.ts"],"names":[],"mappings":"AAAA,wBAAgB,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAErE;AAED,wBAAgB,aAAa,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAEnD;AAED,wBAAgB,uBAAuB,CACrC,GAAG,EAAE,OAAO,EACZ,YAAY,EAAE,MAAM,GACnB,CAAC,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,CAAC,CAgB1D"}

package/dist/utils/math.js

@@ -0,0 +1,21 @@
+export function clamp(value, min, max) {
+    return Math.min(Math.max(value, min), max);
+}
+export function toWholeNumber(value) {
+    return Number.isFinite(value) ? Math.max(0, Math.floor(value + 1e-9)) : 0;
+}
+export function normalizeRawRedisResult(raw, strategyName) {
+    if (!Array.isArray(raw) || raw.length < 7) {
+        throw new TypeError(`Redis program for "${strategyName}" returned an unexpected result.`);
+    }
+    return [
+        String(raw[0]),
+        String(raw[1]),
+        String(raw[2]),
+        String(raw[3]),
+        String(raw[4]),
+        String(raw[5]),
+        String(raw[6]),
+    ];
+}
+//# sourceMappingURL=math.js.map

package/dist/utils/math.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"math.js","sourceRoot":"","sources":["../../src/utils/math.ts"],"names":[],"mappings":"AAAA,MAAM,UAAU,KAAK,CAAC,KAAa,EAAE,GAAW,EAAE,GAAW;IAC3D,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;AAC7C,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,KAAa;IACzC,OAAO,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AAC5E,CAAC;AAED,MAAM,UAAU,uBAAuB,CACrC,GAAY,EACZ,YAAoB;IAEpB,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC1C,MAAM,IAAI,SAAS,CACjB,sBAAsB,YAAY,kCAAkC,CACrE,CAAC;IACJ,CAAC;IAED,OAAO;QACL,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACd,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACd,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACd,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACd,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACd,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;QACd,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;KACf,CAAC;AACJ,CAAC"}

package/package.json

@@ -0,0 +1,94 @@
+{
+  "name": "@xyph3r/rate-limiter",
+  "version": "0.1.0",
+  "description": "Framework-agnostic rate limiting for Node.js with sliding window and token bucket strategies.",
+  "author": "xyph3r",
+  "license": "MIT",
+  "type": "module",
+  "sideEffects": false,
+  "packageManager": "npm@10.8.2",
+  "files": [
+    "dist"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    },
+    "./adapters/express": {
+      "types": "./dist/adapters/express.d.ts",
+      "import": "./dist/adapters/express.js"
+    },
+    "./adapters/fastify": {
+      "types": "./dist/adapters/fastify.d.ts",
+      "import": "./dist/adapters/fastify.js"
+    },
+    "./adapters/fetch": {
+      "types": "./dist/adapters/fetch.d.ts",
+      "import": "./dist/adapters/fetch.js"
+    },
+    "./adapters/hono": {
+      "types": "./dist/adapters/hono.d.ts",
+      "import": "./dist/adapters/hono.js"
+    },
+    "./adapters/next": {
+      "types": "./dist/adapters/next.d.ts",
+      "import": "./dist/adapters/next.js"
+    },
+    "./adapters/nest": {
+      "types": "./dist/adapters/nest.d.ts",
+      "import": "./dist/adapters/nest.js"
+    },
+    "./stores/redis": {
+      "types": "./dist/stores/redis-store.d.ts",
+      "import": "./dist/stores/redis-store.js"
+    },
+    "./stores/memory": {
+      "types": "./dist/stores/memory-store.d.ts",
+      "import": "./dist/stores/memory-store.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/faisalahmedsifat/rate-limiter.git"
+  },
+  "bugs": {
+    "url": "https://github.com/faisalahmedsifat/rate-limiter/issues"
+  },
+  "homepage": "https://github.com/faisalahmedsifat/rate-limiter#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "typecheck": "tsc -p tsconfig.build.json --noEmit",
+    "test": "bun test test/*.test.ts",
+    "test:node": "rm -rf .test-dist && tsc -p tsconfig.test.json && node --test .test-dist/test/*.test.js",
+    "prepack": "node ./node_modules/typescript/bin/tsc -p tsconfig.build.json",
+    "prepublishOnly": "rm -rf .test-dist && node ./node_modules/typescript/bin/tsc -p tsconfig.test.json && node --test .test-dist/test/*.test.js"
+  },
+  "devDependencies": {
+    "typescript": "^5.6.3"
+  },
+  "keywords": [
+    "rate-limit",
+    "rate-limiter",
+    "ratelimit",
+    "ratelimiter",
+    "redis",
+    "bun",
+    "hono",
+    "nextjs",
+    "nestjs",
+    "express",
+    "fastify",
+    "token-bucket",
+    "sliding-window"
+  ]
+}