@lytjs/middleware-rate-limit 6.6.0

package/README.md

@@ -0,0 +1,40 @@
+# @lytjs/middleware-rate-limit
+
+> LytJS 限流中间件。
+
+[![npm version](https://img.shields.io/npm/v/@lytjs/middleware-rate-limit.svg)](https://www.npmjs.com/package/@lytjs/middleware-rate-limit)
+[![license](https://img.shields.io/npm/l/@lytjs/middleware-rate-limit.svg)](https://gitee.com/lytjs/lytjs/blob/main/LICENSE)
+
+## 简介
+
+`@lytjs/middleware-rate-limit` 是 LytJS 框架的限流中间件，支持多种限流策略。
+
+### 核心特性
+
+- **滑动窗口算法**：支持滑动窗口限流
+- **自定义键生成**：可自定义限流键
+- **存储抽象**：支持自定义存储
+- **零依赖**：不引入任何外部依赖
+
+## 安装
+
+```bash
+npm install @lytjs/middleware-rate-limit
+```
+
+或使用 pnpm：
+
+```bash
+pnpm add @lytjs/middleware-rate-limit
+```
+
+## 许可证
+
+MIT License - [查看许可证](https://gitee.com/lytjs/lytjs/blob/main/LICENSE)
+
+## 贡献指南
+
+欢迎提交 Issue 和 Pull Request！
+
+- [Gitee 仓库](https://gitee.com/lytjs/lytjs)
+- [问题反馈](https://gitee.com/lytjs/lytjs/issues)

package/dist/index.cjs

@@ -0,0 +1,48 @@
+'use strict';
+
+var commonRateLimit = require('@lytjs/common-rate-limit');
+
+// src/rate-limit.ts
+function createRateLimitMiddleware(options) {
+  const limiter = commonRateLimit.createRateLimiter({
+    max: options.max,
+    windowMs: options.windowMs
+  });
+  const keyGenerator = options.keyGenerator || ((request, _ctx) => request.headers.get("x-forwarded-for") || "unknown");
+  return async (request, ctx, next) => {
+    const key = keyGenerator(request, ctx);
+    const now = Date.now();
+    const result = limiter.check(key);
+    const info = {
+      remaining: result.remaining,
+      reset: result.reset,
+      limit: result.limit
+    };
+    ctx.rateLimit = info;
+    if (!result.allowed) {
+      const headers = new Headers({
+        "X-RateLimit-Limit": String(info.limit),
+        "X-RateLimit-Remaining": String(info.remaining),
+        "X-RateLimit-Reset": String(info.reset),
+        "Retry-After": String(Math.ceil((result.reset - now) / 1e3)),
+        "Content-Type": "application/json"
+      });
+      return new Response(JSON.stringify({ error: "\u8BF7\u6C42\u8FC7\u591A" }), {
+        status: 429,
+        headers
+      });
+    }
+    await next();
+    if (ctx.response) {
+      const newResponse = new Response(ctx.response.body, ctx.response);
+      newResponse.headers.set("X-RateLimit-Limit", String(info.limit));
+      newResponse.headers.set("X-RateLimit-Remaining", String(info.remaining));
+      newResponse.headers.set("X-RateLimit-Reset", String(info.reset));
+      return newResponse;
+    }
+  };
+}
+
+exports.createRateLimitMiddleware = createRateLimitMiddleware;
+//# sourceMappingURL=index.cjs.map
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/rate-limit.ts"],"names":["createRateLimiter"],"mappings":";;;;;AAaO,SAAS,0BAA0B,OAAA,EAAuC;AAC/E,EAAA,MAAM,UAAUA,iCAAA,CAAkB;AAAA,IAChC,KAAK,OAAA,CAAQ,GAAA;AAAA,IACb,UAAU,OAAA,CAAQ;AAAA,GACnB,CAAA;AACD,EAAA,MAAM,YAAA,GACJ,OAAA,CAAQ,YAAA,KACP,CAAC,OAAA,EAAkB,SAClB,OAAA,CAAQ,OAAA,CAAQ,GAAA,CAAI,iBAAiB,CAAA,IAAK,SAAA,CAAA;AAE9C,EAAA,OAAO,OAAO,OAAA,EAAkB,GAAA,EAAwB,IAAA,KAA8B;AACpF,IAAA,MAAM,GAAA,GAAM,YAAA,CAAa,OAAA,EAAS,GAAG,CAAA;AACrC,IAAA,MAAM,GAAA,GAAM,KAAK,GAAA,EAAI;AACrB,IAAA,MAAM,MAAA,GAAS,OAAA,CAAQ,KAAA,CAAM,GAAG,CAAA;AAEhC,IAAA,MAAM,IAAA,GAAsB;AAAA,MAC1B,WAAW,MAAA,CAAO,SAAA;AAAA,MAClB,OAAO,MAAA,CAAO,KAAA;AAAA,MACd,OAAO,MAAA,CAAO;AAAA,KAChB;AAEA,IAAA,GAAA,CAAI,SAAA,GAAY,IAAA;AAEhB,IAAA,IAAI,CAAC,OAAO,OAAA,EAAS;AACnB,MAAA,MAAM,OAAA,GAAU,IAAI,OAAA,CAAQ;AAAA,QAC1B,mBAAA,EAAqB,MAAA,CAAO,IAAA,CAAK,KAAK,CAAA;AAAA,QACtC,uBAAA,EAAyB,MAAA,CAAO,IAAA,CAAK,SAAS,CAAA;AAAA,QAC9C,mBAAA,EAAqB,MAAA,CAAO,IAAA,CAAK,KAAK,CAAA;AAAA,QACtC,aAAA,EAAe,OAAO,IAAA,CAAK,IAAA,CAAA,CAAM,OAAO,KAAA,GAAQ,GAAA,IAAO,GAAI,CAAC,CAAA;AAAA,QAC5D,cAAA,EAAgB;AAAA,OACjB,CAAA;AAED,MAAA,OAAO,IAAI,SAAS,IAAA,CAAK,SAAA,CAAU,EAAE,KAAA,EAAO,0BAAA,EAAQ,CAAA,EAAG;AAAA,QACrD,MAAA,EAAQ,GAAA;AAAA,QACR;AAAA,OACD,CAAA;AAAA,IACH;AAEA,IAAA,MAAM,IAAA,EAAK;AAEX,IAAA,IAAI,IAAI,QAAA,EAAU;AAChB,MAAA,MAAM,cAAc,IAAI,QAAA,CAAS,IAAI,QAAA,CAAS,IAAA,EAAM,IAAI,QAAQ,CAAA;AAChE,MAAA,WAAA,CAAY,QAAQ,GAAA,CAAI,mBAAA,EAAqB,MAAA,CAAO,IAAA,CAAK,KAAK,CAAC,CAAA;AAC/D,MAAA,WAAA,CAAY,QAAQ,GAAA,CAAI,uBAAA,EAAyB,MAAA,CAAO,IAAA,CAAK,SAAS,CAAC,CAAA;AACvE,MAAA,WAAA,CAAY,QAAQ,GAAA,CAAI,mBAAA,EAAqB,MAAA,CAAO,IAAA,CAAK,KAAK,CAAC,CAAA;AAE/D,MAAA,OAAO,WAAA;AAAA,IACT;AAAA,EACF,CAAA;AACF","file":"index.cjs","sourcesContent":["/**\n * 限流中间件实现\n */\nimport type { RateLimitOptions, RateLimitInfo } from './types';\nimport type { Middleware, MiddlewareContext } from '@lytjs/middleware';\nimport { createRateLimiter } from '@lytjs/common-rate-limit';\n\n/**\n * 创建限流中间件\n *\n * @param options - 限流配置选项\n * @returns 限流中间件函数\n */\nexport function createRateLimitMiddleware(options: RateLimitOptions): Middleware {\n  const limiter = createRateLimiter({\n    max: options.max,\n    windowMs: options.windowMs,\n  });\n  const keyGenerator =\n    options.keyGenerator ||\n    ((request: Request, _ctx: MiddlewareContext) =>\n      request.headers.get('x-forwarded-for') || 'unknown');\n\n  return async (request: Request, ctx: MiddlewareContext, next: () => Promise<void>) => {\n    const key = keyGenerator(request, ctx);\n    const now = Date.now();\n    const result = limiter.check(key);\n\n    const info: RateLimitInfo = {\n      remaining: result.remaining,\n      reset: result.reset,\n      limit: result.limit,\n    };\n\n    ctx.rateLimit = info;\n\n    if (!result.allowed) {\n      const headers = new Headers({\n        'X-RateLimit-Limit': String(info.limit),\n        'X-RateLimit-Remaining': String(info.remaining),\n        'X-RateLimit-Reset': String(info.reset),\n        'Retry-After': String(Math.ceil((result.reset - now) / 1000)),\n        'Content-Type': 'application/json',\n      });\n\n      return new Response(JSON.stringify({ error: '请求过多' }), {\n        status: 429,\n        headers,\n      });\n    }\n\n    await next();\n\n    if (ctx.response) {\n      const newResponse = new Response(ctx.response.body, ctx.response);\n      newResponse.headers.set('X-RateLimit-Limit', String(info.limit));\n      newResponse.headers.set('X-RateLimit-Remaining', String(info.remaining));\n      newResponse.headers.set('X-RateLimit-Reset', String(info.reset));\n\n      return newResponse;\n    }\n  };\n}\n"]}

package/dist/index.mjs

@@ -0,0 +1,46 @@
+import { createRateLimiter } from '@lytjs/common-rate-limit';
+
+// src/rate-limit.ts
+function createRateLimitMiddleware(options) {
+  const limiter = createRateLimiter({
+    max: options.max,
+    windowMs: options.windowMs
+  });
+  const keyGenerator = options.keyGenerator || ((request, _ctx) => request.headers.get("x-forwarded-for") || "unknown");
+  return async (request, ctx, next) => {
+    const key = keyGenerator(request, ctx);
+    const now = Date.now();
+    const result = limiter.check(key);
+    const info = {
+      remaining: result.remaining,
+      reset: result.reset,
+      limit: result.limit
+    };
+    ctx.rateLimit = info;
+    if (!result.allowed) {
+      const headers = new Headers({
+        "X-RateLimit-Limit": String(info.limit),
+        "X-RateLimit-Remaining": String(info.remaining),
+        "X-RateLimit-Reset": String(info.reset),
+        "Retry-After": String(Math.ceil((result.reset - now) / 1e3)),
+        "Content-Type": "application/json"
+      });
+      return new Response(JSON.stringify({ error: "\u8BF7\u6C42\u8FC7\u591A" }), {
+        status: 429,
+        headers
+      });
+    }
+    await next();
+    if (ctx.response) {
+      const newResponse = new Response(ctx.response.body, ctx.response);
+      newResponse.headers.set("X-RateLimit-Limit", String(info.limit));
+      newResponse.headers.set("X-RateLimit-Remaining", String(info.remaining));
+      newResponse.headers.set("X-RateLimit-Reset", String(info.reset));
+      return newResponse;
+    }
+  };
+}
+
+export { createRateLimitMiddleware };
+//# sourceMappingURL=index.mjs.map
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/rate-limit.ts"],"names":[],"mappings":";;;AAaO,SAAS,0BAA0B,OAAA,EAAuC;AAC/E,EAAA,MAAM,UAAU,iBAAA,CAAkB;AAAA,IAChC,KAAK,OAAA,CAAQ,GAAA;AAAA,IACb,UAAU,OAAA,CAAQ;AAAA,GACnB,CAAA;AACD,EAAA,MAAM,YAAA,GACJ,OAAA,CAAQ,YAAA,KACP,CAAC,OAAA,EAAkB,SAClB,OAAA,CAAQ,OAAA,CAAQ,GAAA,CAAI,iBAAiB,CAAA,IAAK,SAAA,CAAA;AAE9C,EAAA,OAAO,OAAO,OAAA,EAAkB,GAAA,EAAwB,IAAA,KAA8B;AACpF,IAAA,MAAM,GAAA,GAAM,YAAA,CAAa,OAAA,EAAS,GAAG,CAAA;AACrC,IAAA,MAAM,GAAA,GAAM,KAAK,GAAA,EAAI;AACrB,IAAA,MAAM,MAAA,GAAS,OAAA,CAAQ,KAAA,CAAM,GAAG,CAAA;AAEhC,IAAA,MAAM,IAAA,GAAsB;AAAA,MAC1B,WAAW,MAAA,CAAO,SAAA;AAAA,MAClB,OAAO,MAAA,CAAO,KAAA;AAAA,MACd,OAAO,MAAA,CAAO;AAAA,KAChB;AAEA,IAAA,GAAA,CAAI,SAAA,GAAY,IAAA;AAEhB,IAAA,IAAI,CAAC,OAAO,OAAA,EAAS;AACnB,MAAA,MAAM,OAAA,GAAU,IAAI,OAAA,CAAQ;AAAA,QAC1B,mBAAA,EAAqB,MAAA,CAAO,IAAA,CAAK,KAAK,CAAA;AAAA,QACtC,uBAAA,EAAyB,MAAA,CAAO,IAAA,CAAK,SAAS,CAAA;AAAA,QAC9C,mBAAA,EAAqB,MAAA,CAAO,IAAA,CAAK,KAAK,CAAA;AAAA,QACtC,aAAA,EAAe,OAAO,IAAA,CAAK,IAAA,CAAA,CAAM,OAAO,KAAA,GAAQ,GAAA,IAAO,GAAI,CAAC,CAAA;AAAA,QAC5D,cAAA,EAAgB;AAAA,OACjB,CAAA;AAED,MAAA,OAAO,IAAI,SAAS,IAAA,CAAK,SAAA,CAAU,EAAE,KAAA,EAAO,0BAAA,EAAQ,CAAA,EAAG;AAAA,QACrD,MAAA,EAAQ,GAAA;AAAA,QACR;AAAA,OACD,CAAA;AAAA,IACH;AAEA,IAAA,MAAM,IAAA,EAAK;AAEX,IAAA,IAAI,IAAI,QAAA,EAAU;AAChB,MAAA,MAAM,cAAc,IAAI,QAAA,CAAS,IAAI,QAAA,CAAS,IAAA,EAAM,IAAI,QAAQ,CAAA;AAChE,MAAA,WAAA,CAAY,QAAQ,GAAA,CAAI,mBAAA,EAAqB,MAAA,CAAO,IAAA,CAAK,KAAK,CAAC,CAAA;AAC/D,MAAA,WAAA,CAAY,QAAQ,GAAA,CAAI,uBAAA,EAAyB,MAAA,CAAO,IAAA,CAAK,SAAS,CAAC,CAAA;AACvE,MAAA,WAAA,CAAY,QAAQ,GAAA,CAAI,mBAAA,EAAqB,MAAA,CAAO,IAAA,CAAK,KAAK,CAAC,CAAA;AAE/D,MAAA,OAAO,WAAA;AAAA,IACT;AAAA,EACF,CAAA;AACF","file":"index.mjs","sourcesContent":["/**\n * 限流中间件实现\n */\nimport type { RateLimitOptions, RateLimitInfo } from './types';\nimport type { Middleware, MiddlewareContext } from '@lytjs/middleware';\nimport { createRateLimiter } from '@lytjs/common-rate-limit';\n\n/**\n * 创建限流中间件\n *\n * @param options - 限流配置选项\n * @returns 限流中间件函数\n */\nexport function createRateLimitMiddleware(options: RateLimitOptions): Middleware {\n  const limiter = createRateLimiter({\n    max: options.max,\n    windowMs: options.windowMs,\n  });\n  const keyGenerator =\n    options.keyGenerator ||\n    ((request: Request, _ctx: MiddlewareContext) =>\n      request.headers.get('x-forwarded-for') || 'unknown');\n\n  return async (request: Request, ctx: MiddlewareContext, next: () => Promise<void>) => {\n    const key = keyGenerator(request, ctx);\n    const now = Date.now();\n    const result = limiter.check(key);\n\n    const info: RateLimitInfo = {\n      remaining: result.remaining,\n      reset: result.reset,\n      limit: result.limit,\n    };\n\n    ctx.rateLimit = info;\n\n    if (!result.allowed) {\n      const headers = new Headers({\n        'X-RateLimit-Limit': String(info.limit),\n        'X-RateLimit-Remaining': String(info.remaining),\n        'X-RateLimit-Reset': String(info.reset),\n        'Retry-After': String(Math.ceil((result.reset - now) / 1000)),\n        'Content-Type': 'application/json',\n      });\n\n      return new Response(JSON.stringify({ error: '请求过多' }), {\n        status: 429,\n        headers,\n      });\n    }\n\n    await next();\n\n    if (ctx.response) {\n      const newResponse = new Response(ctx.response.body, ctx.response);\n      newResponse.headers.set('X-RateLimit-Limit', String(info.limit));\n      newResponse.headers.set('X-RateLimit-Remaining', String(info.remaining));\n      newResponse.headers.set('X-RateLimit-Reset', String(info.reset));\n\n      return newResponse;\n    }\n  };\n}\n"]}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@lytjs/middleware-rate-limit",
+  "version": "6.6.0",
+  "description": "LytJS 速率限制中间件",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "sideEffects": false,
+  "scripts": {
+    "dev": "tsup --watch",
+    "build": "tsup",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "type-check": "tsc --noEmit",
+    "lint": "eslint \"src/**/*.ts\" \"tests/**/*.ts\"",
+    "clean": "rm -rf dist node_modules .turbo"
+  },
+  "dependencies": {
+    "@lytjs/common-is": "workspace:*",
+    "@lytjs/common-rate-limit": "workspace:*"
+  },
+  "devDependencies": {
+    "tsup": "^8.3.6",
+    "typescript": "^5.7.3",
+    "vitest": "^3.0.0"
+  },
+  "peerDependencies": {},
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitee.com/lytjs/lytjs.git",
+    "directory": "packages/ecosystem/packages/web-framework/packages/middleware-rate-limit"
+  },
+  "keywords": [
+    "lytjs",
+    "middleware",
+    "rate-limit",
+    "throttle"
+  ],
+  "author": "LytJS Team",
+  "license": "MIT"
+}