@blocklet/rate-limit 1.16.45-beta-20250626-115702-00b49b4c

package/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2018-2025 ArcBlock
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -0,0 +1,5 @@
+# @blocklet/rate-limit
+
+Rate Limit middleware for blocklet.
+
+See [https://developer.blocklet.io/docs/](https://developer.blocklet.io/docs/)

package/lib/index.d.ts

@@ -0,0 +1,35 @@
+import { type Store, type Options, ClientRateLimitInfo } from 'express-rate-limit';
+type RateLimitStoreOptions = {
+    windowMs: number;
+    prefix?: string;
+    redisUrl?: string;
+    sqlitePath?: string;
+};
+/**
+ * Store for rate limit
+ */
+export declare class RateLimitStore implements Store {
+    private windowMs;
+    private dbCache;
+    constructor(options: RateLimitStoreOptions);
+    get(key: string): Promise<{
+        totalHits: number;
+        resetTime: Date;
+    }>;
+    set(key: string, limitInfo: ClientRateLimitInfo): Promise<void>;
+    increment(key: string): Promise<{
+        totalHits: number;
+        resetTime: Date;
+    }>;
+    decrement(key: string): Promise<void>;
+    resetKey(key: string): Promise<void>;
+}
+/**
+ * express-rate-limit middleware with custom store
+ */
+export declare function createRateLimiter(options: Partial<Options> & {
+    prefix?: string;
+    redisUrl?: string;
+    sqlitePath?: string;
+}): import("express-rate-limit").RateLimitRequestHandler;
+export {};

package/lib/index.js

@@ -0,0 +1,118 @@
+"use strict";
+/* eslint-disable require-await */
+/* eslint-disable @typescript-eslint/no-unused-vars */
+/* eslint-disable @typescript-eslint/indent */
+/* eslint-disable max-classes-per-file */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RateLimitStore = void 0;
+exports.createRateLimiter = createRateLimiter;
+const db_cache_1 = require("@abtnode/db-cache");
+const express_rate_limit_1 = require("express-rate-limit");
+const node_path_1 = __importDefault(require("node:path"));
+/**
+ * Store for rate limit
+ */
+class RateLimitStore {
+    constructor(options) {
+        const serverUrls = (0, db_cache_1.getAbtNodeRedisAndSQLiteUrl)();
+        this.dbCache = new db_cache_1.DBCache(() => ({
+            prefix: `rate-limit-${options.prefix || 'default'}`,
+            ttl: options.windowMs || 1000 * 60,
+            redisUrl: options.redisUrl || serverUrls.redisUrl,
+            sqlitePath: options.sqlitePath || serverUrls.sqlitePath || node_path_1.default.join(process.env.BLOCKLET_APP_DATA_DIR, 'rate-limit.db'),
+        }));
+        this.windowMs = options.windowMs;
+    }
+    async get(key) {
+        try {
+            const row = (await this.dbCache.get(key));
+            return row
+                ? {
+                    totalHits: row.totalHits,
+                    resetTime: new Date(row.resetTime),
+                }
+                : null;
+        }
+        catch (error) {
+            console.error('[RateLimit] Error in get:', error);
+            return null;
+        }
+    }
+    async set(key, limitInfo) {
+        try {
+            await this.dbCache.set(key, {
+                totalHits: limitInfo.totalHits,
+                resetTime: limitInfo.resetTime.getTime(),
+            });
+        }
+        catch (error) {
+            console.error('[RateLimit] Error in set:', error);
+        }
+    }
+    async increment(key) {
+        const defaultLimitInfo = {
+            totalHits: 1,
+            resetTime: new Date(Date.now() + this.windowMs),
+        };
+        try {
+            let limitInfo = await this.get(key);
+            // reset row if expired
+            if (!limitInfo || limitInfo.resetTime.getTime() < Date.now()) {
+                limitInfo = defaultLimitInfo;
+            }
+            else {
+                limitInfo.totalHits += 1;
+            }
+            await this.set(key, limitInfo);
+            return limitInfo;
+        }
+        catch (error) {
+            console.error('[RateLimit] Error in increment:', error);
+            return defaultLimitInfo;
+        }
+    }
+    async decrement(key) {
+        try {
+            const row = await this.get(key);
+            if (row) {
+                await this.set(key, {
+                    totalHits: Math.max(0, row.totalHits - 1),
+                    resetTime: row.resetTime,
+                });
+            }
+        }
+        catch (error) {
+            console.error('[RateLimit] Error in decrement:', error);
+        }
+    }
+    async resetKey(key) {
+        try {
+            await this.dbCache.del(key);
+        }
+        catch (error) {
+            console.error('[RateLimit] Error in resetKey:', error);
+        }
+    }
+}
+exports.RateLimitStore = RateLimitStore;
+/**
+ * express-rate-limit middleware with custom store
+ */
+function createRateLimiter(options) {
+    const store = new RateLimitStore({
+        prefix: options.prefix,
+        windowMs: options.windowMs || 1000 * 60,
+        redisUrl: options.redisUrl,
+        sqlitePath: options.sqlitePath,
+    });
+    return (0, express_rate_limit_1.rateLimit)({
+        store,
+        windowMs: 1000 * 60,
+        limit: 10,
+        legacyHeaders: false,
+        ...options,
+    });
+}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@blocklet/rate-limit",
+  "publishConfig": {
+    "access": "public"
+  },
+  "version": "1.16.45-beta-20250626-115702-00b49b4c",
+  "description": "rate limit middleware",
+  "main": "lib/index.js",
+  "typings": "lib/index.d.ts",
+  "files": [
+    "lib"
+  ],
+  "scripts": {
+    "verify": "npm run lint:fix && npm run test && npm run build",
+    "lint": "eslint src tests",
+    "lint:fix": "npm run lint -- --fix",
+    "test": "jest --forceExit --detectOpenHandles",
+    "coverage": "npm run test -- --coverage",
+    "clean": "rm -fr lib",
+    "prebuild": "npm run clean",
+    "build:blocklet-rate-limit": "npm run build",
+    "build": "tsc",
+    "build:watch": "npm run build -- -w"
+  },
+  "author": "blocklet<blocklet@arcblock.io>",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "@abtnode/db-cache": "1.16.45-beta-20250626-115702-00b49b4c",
+    "express-rate-limit": "^7.5.1"
+  },
+  "devDependencies": {
+    "@arcblock/eslint-config-ts": "^0.3.3",
+    "@types/express": "^5.0.0",
+    "@types/jest": "^29.5.13",
+    "@types/json-stable-stringify": "^1.0.36",
+    "@types/node": "^22.7.5",
+    "@typescript-eslint/eslint-plugin": "^5.42.0",
+    "@typescript-eslint/parser": "^5.42.0",
+    "detect-port": "^1.5.1",
+    "eslint": "^8.57.0",
+    "jest": "^29.7.0",
+    "json-stable-stringify": "^1.0.1",
+    "prettier": "^3.3.2",
+    "ts-jest": "^29.2.5",
+    "ts-node": "^10.9.1",
+    "typescript": "^5.6.3"
+  },
+  "gitHead": "8a70f88f034e2926185d4d0b9503ab8430a772a1"
+}