@joint-ops/hitlimit 1.0.3 → 1.0.5

package/README.md

@@ -6,7 +6,7 @@
 [![TypeScript](https://img.shields.io/badge/TypeScript-Ready-blue.svg)](https://www.typescriptlang.org/)
 [![Bundle Size](https://img.shields.io/bundlephobia/minzip/@joint-ops/hitlimit)](https://bundlephobia.com/package/@joint-ops/hitlimit)
 
-> The fastest rate limiter for Node.js - Express, NestJS, and native HTTP | express-rate-limit alternative
+> The fastest rate limiter for Node.js - Express, Fastify, NestJS, and native HTTP | express-rate-limit alternative
 
 **hitlimit** is a high-performance rate limiting middleware for Node.js applications. Protect your APIs from abuse, prevent brute force attacks, and throttle requests with sub-millisecond overhead. A faster, lighter alternative to express-rate-limit and rate-limiter-flexible.
 
@@ -32,9 +32,9 @@ hitlimit is designed for speed. Here's how it performs:
 
 | Store | Operations/sec | Avg Latency | Use Case |
 |-------|----------------|-------------|----------|
-| **Memory** | 400,000+ | 0.002ms | Single instance, no persistence |
-| **SQLite** | 35,000+ | 0.025ms | Single instance, persistence needed |
-| **Redis** | 12,000+ | 0.08ms | Multi-instance, distributed |
+| **Memory** | 2,320,000+ | 0.43μs | Single instance, no persistence |
+| **SQLite** | 393,000+ | 2.54μs | Single instance, persistence needed |
+| **Redis** | 6,500+ | 153μs | Multi-instance, distributed |
 
 ### vs Competitors
 
@@ -44,6 +44,8 @@ hitlimit is designed for speed. Here's how it performs:
 | rate-limiter-flexible | 1,630,000 | ~155KB |
 | express-rate-limit | 1,220,000 | ~66KB |
 
+> **Note:** Benchmark results vary by hardware and environment. Run your own benchmarks to see results on your specific setup.
+
 ### HTTP Overhead
 
 | Framework | Without Limiter | With hitlimit | Overhead |
@@ -74,6 +76,12 @@ pnpm add @joint-ops/hitlimit
 yarn add @joint-ops/hitlimit
 ```
 
+For Fastify, also install peer dependencies:
+
+```bash
+npm install fastify fastify-plugin
+```
+
 ## Quick Start
 
 ### Express Rate Limiting
@@ -97,6 +105,23 @@ app.get('/api', (req, res) => res.json({ status: 'ok' }))
 app.listen(3000)
 ```
 
+### Fastify Rate Limiting
+
+```typescript
+import Fastify from 'fastify'
+import { hitlimit } from '@joint-ops/hitlimit/fastify'
+
+const app = Fastify()
+
+await app.register(hitlimit, {
+  limit: 100,
+  window: '1m'
+})
+
+app.get('/api', () => ({ status: 'ok' }))
+await app.listen({ port: 3000 })
+```
+
 ### NestJS Rate Limiting
 
 ```typescript
@@ -130,8 +155,12 @@ import { createHitLimit } from '@joint-ops/hitlimit/node'
 const limiter = createHitLimit({ limit: 100, window: '1m' })
 
 const server = http.createServer(async (req, res) => {
-  const result = await limiter(req, res)
-  if (!result.allowed) return // Already sent 429
+  const result = await limiter.check(req)
+  if (!result.allowed) {
+    res.writeHead(429, { 'Content-Type': 'application/json', ...result.headers })
+    res.end(JSON.stringify(result.body))
+    return
+  }
 
   res.writeHead(200)
   res.end('Hello!')
@@ -184,11 +213,12 @@ Rate limit by IP address, user ID, API key, or any custom identifier.
 hitlimit({
   key: (req) => {
     // By API key
-    if (req.headers['x-api-key']) return req.headers['x-api-key']
+    const apiKey = req.headers['x-api-key']
+    if (apiKey) return String(apiKey)
     // By user ID
     if (req.user?.id) return `user:${req.user.id}`
     // Fallback to IP
-    return req.ip
+    return req.ip || 'unknown'
   }
 })
 ```
@@ -216,7 +246,7 @@ hitlimit({
   window: '1m',            // Time window: 30s, 15m, 1h, 1d (default: '1m')
 
   // Custom key extraction
-  key: (req) => req.ip,
+  key: (req) => req.ip || 'unknown',
 
   // Tiered rate limits
   tiers: {
@@ -393,4 +423,4 @@ MIT - Use freely in personal and commercial projects.
 
 ## Keywords
 
-rate limit, rate limiter, rate limiting, express rate limit, express middleware, express-rate-limit, express-rate-limit alternative, nestjs rate limit, nestjs throttler, @nestjs/throttler alternative, nestjs guard, nodejs rate limit, node rate limiter, api rate limiting, throttle requests, request throttling, api throttling, ddos protection, brute force protection, redis rate limit, memory rate limit, sqlite rate limit, sliding window, fixed window, token bucket, leaky bucket, rate-limiter-flexible alternative, api security, request limiter, http rate limit, express slow down, api protection, login protection, authentication rate limit
+rate limit, rate limiter, rate limiting, express rate limit, express middleware, express-rate-limit, express-rate-limit alternative, fastify rate limit, fastify plugin, fastify-rate-limit alternative, nestjs rate limit, nestjs throttler, @nestjs/throttler alternative, nestjs guard, nodejs rate limit, node rate limiter, api rate limiting, throttle requests, request throttling, api throttling, ddos protection, brute force protection, redis rate limit, memory rate limit, sqlite rate limit, sliding window, fixed window, token bucket, leaky bucket, rate-limiter-flexible alternative, api security, request limiter, http rate limit, express slow down, api protection, login protection, authentication rate limit

package/dist/fastify.d.ts

@@ -0,0 +1,6 @@
+import type { FastifyInstance, FastifyRequest } from 'fastify';
+import type { HitLimitOptions } from '@joint-ops/hitlimit-types';
+declare function hitlimitPlugin(fastify: FastifyInstance, options: HitLimitOptions<FastifyRequest>): Promise<void>;
+export declare const hitlimit: typeof hitlimitPlugin;
+export {};
+//# sourceMappingURL=fastify.d.ts.map

package/dist/fastify.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fastify.d.ts","sourceRoot":"","sources":["../src/fastify.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAgB,MAAM,SAAS,CAAA;AAC5E,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,2BAA2B,CAAA;AAShE,iBAAe,cAAc,CAC3B,OAAO,EAAE,eAAe,EACxB,OAAO,EAAE,eAAe,CAAC,cAAc,CAAC,iBA8BzC;AAED,eAAO,MAAM,QAAQ,uBAGnB,CAAA"}

package/dist/fastify.js

@@ -0,0 +1,40 @@
+import fp from 'fastify-plugin';
+import { resolveConfig } from './core/config.js';
+import { checkLimit } from './core/limiter.js';
+import { memoryStore } from './stores/memory.js';
+function getDefaultKey(req) {
+    return req.ip || 'unknown';
+}
+async function hitlimitPlugin(fastify, options) {
+    const store = options.store ?? memoryStore();
+    const config = resolveConfig(options, store, getDefaultKey);
+    fastify.addHook('onRequest', async (request, reply) => {
+        if (config.skip) {
+            const shouldSkip = await config.skip(request);
+            if (shouldSkip)
+                return;
+        }
+        try {
+            const result = await checkLimit(config, request);
+            for (const [key, value] of Object.entries(result.headers)) {
+                reply.header(key, value);
+            }
+            if (!result.allowed) {
+                reply.status(429).send(result.body);
+                return;
+            }
+        }
+        catch (error) {
+            const action = await config.onStoreError(error, request);
+            if (action === 'deny') {
+                reply.status(429).send({ hitlimit: true, message: 'Rate limit error' });
+                return;
+            }
+        }
+    });
+}
+export const hitlimit = fp(hitlimitPlugin, {
+    name: 'hitlimit',
+    fastify: '>=4.0.0'
+});
+//# sourceMappingURL=fastify.js.map

package/dist/fastify.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"fastify.js","sourceRoot":"","sources":["../src/fastify.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,gBAAgB,CAAA;AAG/B,OAAO,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAChD,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAA;AAEhD,SAAS,aAAa,CAAC,GAAmB;IACxC,OAAO,GAAG,CAAC,EAAE,IAAI,SAAS,CAAA;AAC5B,CAAC;AAED,KAAK,UAAU,cAAc,CAC3B,OAAwB,EACxB,OAAwC;IAExC,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,WAAW,EAAE,CAAA;IAC5C,MAAM,MAAM,GAAG,aAAa,CAAC,OAAO,EAAE,KAAK,EAAE,aAAa,CAAC,CAAA;IAE3D,OAAO,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,EAAE,OAAuB,EAAE,KAAmB,EAAE,EAAE;QAClF,IAAI,MAAM,CAAC,IAAI,EAAE,CAAC;YAChB,MAAM,UAAU,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;YAC7C,IAAI,UAAU;gBAAE,OAAM;QACxB,CAAC;QAED,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;YAEhD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC1D,KAAK,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;YAC1B,CAAC;YAED,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;gBACpB,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAA;gBACnC,OAAM;YACR,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,YAAY,CAAC,KAAc,EAAE,OAAO,CAAC,CAAA;YACjE,IAAI,MAAM,KAAK,MAAM,EAAE,CAAC;gBACtB,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,kBAAkB,EAAE,CAAC,CAAA;gBACvE,OAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC,CAAC,CAAA;AACJ,CAAC;AAED,MAAM,CAAC,MAAM,QAAQ,GAAG,EAAE,CAAC,cAAc,EAAE;IACzC,IAAI,EAAE,UAAU;IAChB,OAAO,EAAE,SAAS;CACnB,CAAC,CAAA"}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@joint-ops/hitlimit",
-  "version": "1.0.3",
-  "description": "Fast rate limiting middleware for Express, NestJS & Node.js - API throttling, brute force protection, request limiting",
+  "version": "1.0.5",
+  "description": "Fast rate limiting middleware for Express, Fastify, NestJS & Node.js - API throttling, brute force protection, request limiting",
   "author": {
     "name": "Shayan M Hussain",
     "email": "shayanhussain48@gmail.com",
@@ -32,6 +32,8 @@
     "nest-throttler",
     "fastify",
     "fastify-rate-limit",
+    "fastify-plugin",
+    "fastify-middleware",
     "hono",
     "hono-rate-limit",
     "hono-middleware",
@@ -87,6 +89,14 @@
       "types": "./dist/node.d.ts",
       "import": "./dist/node.js"
     },
+    "./fastify": {
+      "types": "./dist/fastify.d.ts",
+      "import": "./dist/fastify.js"
+    },
+    "./stores/memory": {
+      "types": "./dist/stores/memory.d.ts",
+      "import": "./dist/stores/memory.js"
+    },
     "./stores/sqlite": {
       "types": "./dist/stores/sqlite.d.ts",
       "import": "./dist/stores/sqlite.js"
@@ -119,11 +129,13 @@
     "test:watch": "vitest"
   },
   "dependencies": {
-    "@joint-ops/hitlimit-types": "1.0.3"
+    "@joint-ops/hitlimit-types": "1.0.5"
   },
   "peerDependencies": {
     "@nestjs/common": ">=8.0.0",
     "@nestjs/core": ">=8.0.0",
+    "fastify": ">=4.0.0",
+    "fastify-plugin": ">=4.0.0",
     "better-sqlite3": ">=9.0.0",
     "ioredis": ">=5.0.0",
     "pino": ">=8.0.0",
@@ -136,6 +148,12 @@
     "@nestjs/core": {
       "optional": true
     },
+    "fastify": {
+      "optional": true
+    },
+    "fastify-plugin": {
+      "optional": true
+    },
     "better-sqlite3": {
       "optional": true
     },
@@ -160,6 +178,8 @@
     "@types/supertest": "^6.0.0",
     "better-sqlite3": "^11.0.0",
     "express": "^4.18.0",
+    "fastify": "^5.7.4",
+    "fastify-plugin": "^5.1.0",
     "ioredis": "^5.3.0",
     "pino": "^10.3.0",
     "reflect-metadata": "^0.2.0",