@canmertinyo/rate-limit-express 1.0.0

package/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+import { rateLimiter } from "./rate.limiter";
+export { rateLimiter as RateLimiter };

package/dist/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RateLimiter = void 0;
+const rate_limiter_1 = require("./rate.limiter");
+Object.defineProperty(exports, "RateLimiter", { enumerable: true, get: function () { return rate_limiter_1.rateLimiter; } });

package/dist/interfaces/rate-limiter-options.interface.d.ts

@@ -0,0 +1,12 @@
+/**
+ * Options for the rate limiter configuration.
+ *
+ * @property ms - The time window in milliseconds for rate limiting.
+ * @property maxRequest - The maximum number of allowed requests in the time window.
+ */
+export interface RateLimiterOptions {
+    /** The time in milliseconds for rate limiting. */
+    ms: number;
+    /** The maximum number of allowed requests in the time window. */
+    maxRequest: number;
+}

package/dist/interfaces/rate-limiter-options.interface.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/rate.limiter.d.ts

@@ -0,0 +1,3 @@
+import { Request, Response, NextFunction } from "express";
+import { RateLimiterOptions } from "./interfaces/rate-limiter-options.interface";
+export declare function rateLimiter(options: RateLimiterOptions): (req: Request, res: Response, next: NextFunction) => void;

package/dist/rate.limiter.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rateLimiter = rateLimiter;
+const utils_1 = require("./utils");
+const store = {};
+function rateLimiter(options) {
+    return (req, res, next) => {
+        const ip = (0, utils_1.getIp)(req);
+        const currentTime = (0, utils_1.getTimestamp)();
+        const startTime = currentTime - options.ms * 1000;
+        if (!store[ip]) {
+            store[ip] = { count: 0, timestamp: currentTime };
+        }
+        if (store[ip].timestamp < startTime) {
+            store[ip].count = 0;
+            store[ip].timestamp = currentTime;
+        }
+        if (store[ip].count < options.maxRequest) {
+            store[ip].count += 1;
+            next();
+        }
+        else {
+            res
+                .status(420)
+                .json({ message: "Too many requests, please try again later." });
+        }
+    };
+}

package/dist/types/store.type.d.ts

@@ -0,0 +1,6 @@
+export type Store = {
+    [key: string]: {
+        count: number;
+        timestamp: number;
+    };
+};

package/dist/types/store.type.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils.d.ts

@@ -0,0 +1,3 @@
+import { Request } from "express";
+export declare const getIp: (req: Request) => string;
+export declare const getTimestamp: () => number;

package/dist/utils.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getTimestamp = exports.getIp = void 0;
+const getIp = (req) => {
+    return req.ip || req.headers["x-forwarded-for"] || "unknown";
+};
+exports.getIp = getIp;
+const getTimestamp = () => {
+    return new Date().getTime();
+};
+exports.getTimestamp = getTimestamp;

package/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "@canmertinyo/rate-limit-express",
+  "description": "A simple rate-limiting middleware for Express.js",
+  "version": "1.0.0",
+  "main": "dist/index.js",
+  "license": "MIT",
+  "types": "dist/index.d.ts",
+    "scripts": {
+    "build": "tsc"
+  },
+  "keywords": ["ratelimiter-express"],
+  "author": "c4nzin",
+  "devDependencies": {
+    "@types/express": "^5.0.0",
+    "typescript": "^5.7.2"
+  },
+  "dependencies": {
+    "express": "^4.21.1"
+  }
+}

package/src/index.ts

@@ -0,0 +1,3 @@
+import { rateLimiter } from "./rate.limiter";
+
+export { rateLimiter as RateLimiter };

package/src/interfaces/rate-limiter-options.interface.ts

@@ -0,0 +1,12 @@
+/**
+ * Options for the rate limiter configuration.
+ *
+ * @property ms - The time window in milliseconds for rate limiting.
+ * @property maxRequest - The maximum number of allowed requests in the time window.
+ */
+export interface RateLimiterOptions {
+  /** The time in milliseconds for rate limiting. */
+  ms: number;
+  /** The maximum number of allowed requests in the time window. */
+  maxRequest: number;
+}

package/src/rate.limiter.ts

@@ -0,0 +1,32 @@
+import { Request, Response, NextFunction } from "express";
+import { getIp, getTimestamp } from "./utils";
+import { Store } from "./types/store.type";
+import { RateLimiterOptions } from "./interfaces/rate-limiter-options.interface";
+
+const store: Store = {};
+
+export function rateLimiter(options: RateLimiterOptions) {
+  return (req: Request, res: Response, next: NextFunction) => {
+    const ip = getIp(req);
+    const currentTime = getTimestamp();
+    const startTime = currentTime - options.ms * 1000;
+
+    if (!store[ip]) {
+      store[ip] = { count: 0, timestamp: currentTime };
+    }
+
+    if (store[ip].timestamp < startTime) {
+      store[ip].count = 0;
+      store[ip].timestamp = currentTime;
+    }
+
+    if (store[ip].count < options.maxRequest) {
+      store[ip].count += 1;
+      next();
+    } else {
+      res
+        .status(420)
+        .json({ message: "Too many requests, please try again later." });
+    }
+  };
+}

package/src/types/store.type.ts

@@ -0,0 +1,3 @@
+export type Store = {
+  [key: string]: { count: number; timestamp: number };
+};

package/src/utils.ts

@@ -0,0 +1,9 @@
+import { Request } from "express";
+
+export const getIp = (req: Request): string => {
+  return req.ip || (req.headers["x-forwarded-for"] as string) || "unknown";
+};
+
+export const getTimestamp = (): number => {
+  return new Date().getTime();
+};

package/tsconfig.json

@@ -0,0 +1,11 @@
+{
+  "compilerOptions": {
+    "target": "ES6",
+    "module": "CommonJS",
+    "declaration": true,
+    "outDir": "./dist",
+    "strict": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}