@the-node-forge/api-rate-limit 1.0.7

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 The Node Forge
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,166 @@
+<div align="center">
+   
+  # API Rate Limiter 
+  
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+![Made with TypeScript](https://img.shields.io/badge/Made%20with-TypeScript-007acc)
+
+[![NPM Version](https://img.shields.io/npm/v/@the-node-forge/url-validator)](https://www.npmjs.com/package/@the-node-forge/api-rate-limit)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/the-node-forge/api-rate-limit/ci.yaml?branch=main)](https://github.com/The-Node-Forge/api-rate-limit/actions)
+![Platform](https://img.shields.io/badge/platform-node.js%20%7C%20browser-brightgreen)
+
+[Live Documentation](https://the-node-forge.github.io/api-rate-limit/)
+
+</div>
+ 
+A **simple and efficient API rate limiter** for JavaScript/TypeScript applications. This package helps developers **limit API requests per user**, preventing abuse and excessive usage.
+
+## ✨ Features
+
+- ✅ **Configurable Limits** – Set max requests per second, minute, or hour.
+- ✅ **In-Memory Storage** – Fast and lightweight.
+- ✅ **Express Middleware** – Easily integrate with Express.
+- ✅ **Multiple Users** – Tracks each user separately.
+
+---
+
+## 📦 Installation
+
+```sh
+npm install @the-node-forge/api-rate-limit
+```
+
+or using Yarn:
+
+```sh
+yarn add @the-node-forge/api-rate-limit
+```
+
+---
+
+## 🛠️ Basic Usage
+
+### **1️⃣ 🌐 JavaScript/TypeScript Example**
+
+Easily integrate with **JavaScript/TypeScript**.
+
+```javascript
+// Javascript
+import RateLimiter from '@the-node-forge/api-rate-limit';
+
+// Create a rate limiter allowing 5 requests per minute
+const limiter = new RateLimiter({ windowMs: 60000, maxRequests: 5 });
+
+const userId = 'user123'; // Could be an API key or IP
+
+if (limiter.isAllowed(userId)) {
+  console.log('Request allowed ✅');
+} else {
+  console.log('Too many requests ❌');
+}
+```
+
+---
+
+### 2️⃣ 🌐 Express Middleware Example - Global
+
+Easily integrate with an **Express API**.
+
+```typescript
+import express from 'express';
+import { RateLimiter, rateLimitMiddleware } from '@the-node-forge/api-rate-limit';
+
+const app = express();
+
+// Set up rate limiter (10 requests per minute)
+const limiter = new RateLimiter({ windowMs: 60000, maxRequests: 10 });
+
+// Apply middleware globally
+app.use(rateLimitMiddleware(limiter));
+
+app.get('/', (req, res) => {
+  res.send('Welcome to my API!');
+});
+
+app.listen(3000, () => console.log('Server running on port 3000'));
+```
+
+---
+
+### 3️⃣ 🌐 Express Middleware Example - Specific
+
+Easily integrate with an **Express API**.
+
+```typescript
+import express from 'express';
+import { RateLimiter, rateLimitMiddleware } from '@the-node-forge/api-rate-limit';
+
+const app = express();
+
+const limiterFiveReq = new RateLimiter({ windowMs: 60000, maxRequests: 5 });
+const limiterTenReq = new RateLimiter({ windowMs: 60000, maxRequests: 10 });
+
+// Apply rate limiting to only specific routes
+app.get('/public', (req, res) => {
+  res.send('This route has no rate limiting!');
+});
+
+// Apply rate limiting only to this route
+app.get('/limited', rateLimitMiddleware(limiterFiveReq), (req, res) => {
+  res.send('This route is rate-limited to 5 requests!');
+});
+
+app.post('/submit', rateLimitMiddleware(limiterTenReq), (req, res) => {
+  res.send('This POST request is also rate-limited to ten requests!');
+});
+
+app.listen(3000, () => console.log('Server running on port 3000'));
+```
+
+---
+
+## ✅ **API Reference**
+
+### **RateLimiter Class**
+
+```typescript
+new RateLimiter({ windowMs: number, maxRequests: number });
+```
+
+| Parameter     | Type     | Description                                              |
+| ------------- | -------- | -------------------------------------------------------- |
+| `windowMs`    | `number` | Time window in milliseconds (e.g., `60000` for 1 minute) |
+| `maxRequests` | `number` | Maximum allowed requests in the given window             |
+
+#### **Methods**
+
+```typescript
+isAllowed(userId: string): boolean
+```
+
+| Method              | Returns   | Description                                                                 |
+| ------------------- | --------- | --------------------------------------------------------------------------- |
+| `isAllowed(userId)` | `boolean` | Returns `true` if the user is allowed to make a request, otherwise `false`. |
+
+---
+
+### 💡 **Contributing**
+
+Contributions are welcome! Please submit
+[issues](https://github.com/The-Node-Forge/api-rate-limit/issues) or
+[pull requests](https://github.com/The-Node-Forge/api-rate-limit/pulls).
+
+---
+
+### ⭐ Support
+
+If you find this package useful, please \*\*give it a ⭐ on
+[GitHub](https://github.com/The-Node-Forge/api-rate-limit 'GitHub Repository')
+
+---
+
+### 🔗 **Links**
+
+- 📦 [NPM Package](https://www.npmjs.com/package/@the-node-forge/api-rate-limit)
+- 🏗 [The-Node-Forge](https://github.com/The-Node-Forge)

package/dist/RateLimiter.d.ts

@@ -0,0 +1,12 @@
+export interface RateLimitOptions {
+    windowMs: number;
+    maxRequests: number;
+}
+declare class RateLimiter {
+    private requests;
+    private windowMs;
+    private maxRequests;
+    constructor(options: RateLimitOptions);
+    isAllowed(userId: string): boolean;
+}
+export default RateLimiter;

package/dist/RateLimiter.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class RateLimiter {
+    constructor(options) {
+        this.windowMs = options.windowMs;
+        this.maxRequests = options.maxRequests;
+        this.requests = new Map();
+    }
+    isAllowed(userId) {
+        const now = Date.now();
+        const timestamps = this.requests.get(userId) || [];
+        const filteredTimestamps = timestamps.filter((timestamp) => now - timestamp < this.windowMs);
+        if (filteredTimestamps.length >= this.maxRequests) {
+            return false;
+        }
+        filteredTimestamps.push(now);
+        this.requests.set(userId, filteredTimestamps);
+        return true;
+    }
+}
+exports.default = RateLimiter;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+import RateLimiter from './RateLimiter';
+import { rateLimitMiddleware } from './middleware';
+export { RateLimiter, rateLimitMiddleware };

package/dist/index.js

@@ -0,0 +1,10 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rateLimitMiddleware = exports.RateLimiter = void 0;
+const RateLimiter_1 = __importDefault(require("./RateLimiter"));
+exports.RateLimiter = RateLimiter_1.default;
+const middleware_1 = require("./middleware");
+Object.defineProperty(exports, "rateLimitMiddleware", { enumerable: true, get: function () { return middleware_1.rateLimitMiddleware; } });

package/dist/middleware.d.ts

@@ -0,0 +1,3 @@
+import { Request, Response, NextFunction } from 'express';
+import RateLimiter from './RateLimiter';
+export declare const rateLimitMiddleware: (limiter: RateLimiter) => (req: Request, res: Response, next: NextFunction) => Response<any, Record<string, any>> | undefined;

package/dist/middleware.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.rateLimitMiddleware = void 0;
+const HTTP_STATUS = {
+    TOO_MANY_REQUESTS: 429,
+};
+const rateLimitMiddleware = (limiter) => {
+    return (req, res, next) => {
+        const userId = req.ip || '';
+        if (!limiter.isAllowed(userId)) {
+            return res
+                .status(HTTP_STATUS.TOO_MANY_REQUESTS)
+                .json({ message: 'Too many requests, please try again later.' });
+        }
+        next();
+    };
+};
+exports.rateLimitMiddleware = rateLimitMiddleware;

package/package.json

@@ -0,0 +1,83 @@
+{
+  "name": "@the-node-forge/api-rate-limit",
+  "version": "1.0.7",
+  "description": "A simple and efficient API rate limiter for JavaScript/TypeScript applications",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    "import": "./dist/index.js",
+    "require": "./dist/index.js"
+  },
+  "scripts": {
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "test:coverage": "jest --coverage",
+    "format": "prettier --write .",
+    "format:check": "prettier --check .",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "prepublishOnly": "npm run build",
+    "build": "tsc",
+    "docs:generate": "typedoc --plugin typedoc-plugin-markdown --out docs/api src/index.ts",
+    "docs:build": "npm run docs:generate && cd docs && npm run build",
+    "docs:start": "npm run docs:generate && cd docs && npm start",
+    "docs:clean": "rm -rf docs/build && npm run docs:generate && npm run docs:build",
+    "docs:deploy": "cd docs && npm run deploy"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/The-Node-Forge/api-rate-limit"
+  },
+  "keywords": [
+    "rate-limit",
+    "api",
+    "express",
+    "typescript",
+    "npm-package",
+    "request-throttling",
+    "http",
+    "middleware",
+    "express-middleware",
+    "throttle",
+    "rate-limiter",
+    "web-security",
+    "api-protection",
+    "ddos-protection",
+    "request-limiting",
+    "nodejs",
+    "backend"
+  ],
+  "author": {
+    "name": "Lanny MacMillan",
+    "url": "https://github.com/Lanny-MacMillan"
+  },
+  "license": "MIT",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "devDependencies": {
+    "@eslint/compat": "^1.2.5",
+    "@eslint/eslintrc": "^3.2.0",
+    "@eslint/js": "^9.19.0",
+    "@types/express": "^5.0.0",
+    "@types/jest": "^29.5.14",
+    "@typescript-eslint/eslint-plugin": "^8.22.0",
+    "@typescript-eslint/parser": "^8.22.0",
+    "eslint": "^9.19.0",
+    "eslint-config-prettier": "^10.0.1",
+    "eslint-import-resolver-typescript": "^3.7.0",
+    "eslint-plugin-import": "^2.31.0",
+    "eslint-plugin-prettier": "^5.2.3",
+    "globals": "^15.14.0",
+    "jest": "^29.7.0",
+    "prettier": "^3.4.2",
+    "ts-jest": "^29.2.5",
+    "typedoc": "^0.27.6",
+    "typedoc-plugin-markdown": "^4.4.1",
+    "typescript": "^5.7.3"
+  },
+  "dependencies": {
+    "express": "^4.21.2"
+  }
+}