@golemio/core 4.1.3 → 4.1.4

package/dist/helpers/rate-limit/IRateLimitOptions.d.ts

@@ -0,0 +1,10 @@
+import { Request } from "express";
+export interface IRateLimitOptions {
+    keyPrefix: string;
+    points: number;
+    durationSeconds: number;
+    blockDurationSeconds?: number;
+    inMemoryBlockOnConsumed?: number;
+    storeClient?: unknown;
+    getKey?: (req: Request) => string;
+}

package/dist/helpers/rate-limit/IRateLimitOptions.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=IRateLimitOptions.js.map

package/dist/helpers/rate-limit/IRateLimitOptions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"IRateLimitOptions.js","sourceRoot":"","sources":["../../../src/helpers/rate-limit/IRateLimitOptions.ts"],"names":[],"mappings":""}

package/dist/helpers/rate-limit/RateLimitMiddleware.d.ts

@@ -0,0 +1,4 @@
+import { ILogger } from "../logger";
+import { RequestHandler } from "express";
+import { IRateLimitOptions } from "./IRateLimitOptions";
+export declare const createRateLimitMiddleware: (options: IRateLimitOptions, logger: ILogger) => RequestHandler;

package/dist/helpers/rate-limit/RateLimitMiddleware.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRateLimitMiddleware = void 0;
+const errors_1 = require("@golemio/errors");
+const rate_limiter_flexible_1 = require("rate-limiter-flexible");
+const MODULE_NAME = "RateLimitMiddleware";
+const MILLISECONDS_IN_SECOND = 1000;
+const UNKNOWN_CLIENT_KEY = "unknown";
+const resolveDefaultKey = (req) => req.ip || req.socket.remoteAddress || UNKNOWN_CLIENT_KEY;
+const createLimiter = (options, logger) => {
+    const baseOptions = {
+        keyPrefix: options.keyPrefix,
+        points: options.points,
+        duration: options.durationSeconds,
+        blockDuration: options.blockDurationSeconds ?? 0,
+    };
+    if (!options.storeClient) {
+        logger.warn("No storeClient provided — the rate limit is enforced per process, not globally across replicas.");
+        return new rate_limiter_flexible_1.RateLimiterMemory(baseOptions);
+    }
+    const inMemoryBlockOnConsumed = options.inMemoryBlockOnConsumed ?? options.points;
+    if (inMemoryBlockOnConsumed < options.points) {
+        throw new errors_1.GeneralError("inMemoryBlockOnConsumed must be greater than or equal to points.", MODULE_NAME);
+    }
+    return new rate_limiter_flexible_1.RateLimiterRedis({
+        ...baseOptions,
+        storeClient: options.storeClient,
+        inMemoryBlockOnConsumed,
+        inMemoryBlockDuration: options.durationSeconds,
+        insuranceLimiter: new rate_limiter_flexible_1.RateLimiterMemory(baseOptions),
+    });
+};
+const setRateLimitHeaders = (res, points, result) => {
+    res.set("X-RateLimit-Limit", String(points));
+    res.set("X-RateLimit-Remaining", String(Math.max(result.remainingPoints, 0)));
+    res.set("X-RateLimit-Reset", String(Math.ceil((Date.now() + result.msBeforeNext) / MILLISECONDS_IN_SECOND)));
+};
+const createRateLimitMiddleware = (options, logger) => {
+    const limiter = createLimiter(options, logger);
+    const getKey = options.getKey ?? resolveDefaultKey;
+    return async (req, res, next) => {
+        try {
+            const result = await limiter.consume(getKey(req), 1);
+            setRateLimitHeaders(res, options.points, result);
+            next();
+        }
+        catch (err) {
+            if (err instanceof rate_limiter_flexible_1.RateLimiterRes) {
+                setRateLimitHeaders(res, options.points, err);
+                res.set("Retry-After", String(Math.ceil(err.msBeforeNext / MILLISECONDS_IN_SECOND)));
+                next(new errors_1.GeneralError("Too many requests.", MODULE_NAME, undefined, 429));
+                return;
+            }
+            logger.error(new errors_1.GeneralError("Rate limit check failed, the request is allowed.", MODULE_NAME, err));
+            next();
+        }
+    };
+};
+exports.createRateLimitMiddleware = createRateLimitMiddleware;
+//# sourceMappingURL=RateLimitMiddleware.js.map

package/dist/helpers/rate-limit/RateLimitMiddleware.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RateLimitMiddleware.js","sourceRoot":"","sources":["../../../src/helpers/rate-limit/RateLimitMiddleware.ts"],"names":[],"mappings":";;;AACA,4CAA+C;AAE/C,iEAAiH;AAGjH,MAAM,WAAW,GAAG,qBAAqB,CAAC;AAC1C,MAAM,sBAAsB,GAAG,IAAI,CAAC;AACpC,MAAM,kBAAkB,GAAG,SAAS,CAAC;AAErC,MAAM,iBAAiB,GAAG,CAAC,GAAY,EAAU,EAAE,CAAC,GAAG,CAAC,EAAE,IAAI,GAAG,CAAC,MAAM,CAAC,aAAa,IAAI,kBAAkB,CAAC;AAE7G,MAAM,aAAa,GAAG,CAAC,OAA0B,EAAE,MAAe,EAAuB,EAAE;IACvF,MAAM,WAAW,GAAG;QAChB,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,QAAQ,EAAE,OAAO,CAAC,eAAe;QACjC,aAAa,EAAE,OAAO,CAAC,oBAAoB,IAAI,CAAC;KACnD,CAAC;IAEF,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC;QACvB,MAAM,CAAC,IAAI,CAAC,iGAAiG,CAAC,CAAC;QAC/G,OAAO,IAAI,yCAAiB,CAAC,WAAW,CAAC,CAAC;IAC9C,CAAC;IAED,MAAM,uBAAuB,GAAG,OAAO,CAAC,uBAAuB,IAAI,OAAO,CAAC,MAAM,CAAC;IAClF,IAAI,uBAAuB,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;QAC3C,MAAM,IAAI,qBAAY,CAAC,kEAAkE,EAAE,WAAW,CAAC,CAAC;IAC5G,CAAC;IAED,OAAO,IAAI,wCAAgB,CAAC;QACxB,GAAG,WAAW;QACd,WAAW,EAAE,OAAO,CAAC,WAAW;QAChC,uBAAuB;QACvB,qBAAqB,EAAE,OAAO,CAAC,eAAe;QAC9C,gBAAgB,EAAE,IAAI,yCAAiB,CAAC,WAAW,CAAC;KACvD,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,MAAM,mBAAmB,GAAG,CAAC,GAAa,EAAE,MAAc,EAAE,MAAsB,EAAQ,EAAE;IACxF,GAAG,CAAC,GAAG,CAAC,mBAAmB,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;IAC7C,GAAG,CAAC,GAAG,CAAC,uBAAuB,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC9E,GAAG,CAAC,GAAG,CAAC,mBAAmB,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,MAAM,CAAC,YAAY,CAAC,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAC;AACjH,CAAC,CAAC;AAEK,MAAM,yBAAyB,GAAG,CAAC,OAA0B,EAAE,MAAe,EAAkB,EAAE;IACrG,MAAM,OAAO,GAAG,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC/C,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,IAAI,iBAAiB,CAAC;IAEnD,OAAO,KAAK,EAAE,GAAY,EAAE,GAAa,EAAE,IAAkB,EAAiB,EAAE;QAC5E,IAAI,CAAC;YACD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC;YACrD,mBAAmB,CAAC,GAAG,EAAE,OAAO,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;YACjD,IAAI,EAAE,CAAC;QACX,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACX,IAAI,GAAG,YAAY,sCAAc,EAAE,CAAC;gBAChC,mBAAmB,CAAC,GAAG,EAAE,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;gBAC9C,GAAG,CAAC,GAAG,CAAC,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,YAAY,GAAG,sBAAsB,CAAC,CAAC,CAAC,CAAC;gBACrF,IAAI,CAAC,IAAI,qBAAY,CAAC,oBAAoB,EAAE,WAAW,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC;gBAC1E,OAAO;YACX,CAAC;YAED,MAAM,CAAC,KAAK,CAAC,IAAI,qBAAY,CAAC,kDAAkD,EAAE,WAAW,EAAE,GAAG,CAAC,CAAC,CAAC;YACrG,IAAI,EAAE,CAAC;QACX,CAAC;IACL,CAAC,CAAC;AACN,CAAC,CAAC;AArBW,QAAA,yBAAyB,6BAqBpC"}

package/dist/helpers/rate-limit/index.d.ts

@@ -0,0 +1,2 @@
+export { createRateLimitMiddleware } from "./RateLimitMiddleware";
+export type { IRateLimitOptions } from "./IRateLimitOptions";

package/dist/helpers/rate-limit/index.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createRateLimitMiddleware = void 0;
+var RateLimitMiddleware_1 = require("./RateLimitMiddleware");
+Object.defineProperty(exports, "createRateLimitMiddleware", { enumerable: true, get: function () { return RateLimitMiddleware_1.createRateLimitMiddleware; } });
+//# sourceMappingURL=index.js.map

package/dist/helpers/rate-limit/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/helpers/rate-limit/index.ts"],"names":[],"mappings":";;;AAAA,6DAAkE;AAAzD,gIAAA,yBAAyB,OAAA"}

package/dist/index.d.ts

@@ -4,3 +4,4 @@ export * as OutputGateway from "./output-gateway/index";
 export * as SchemaDefinitions from "./schema-definitions/index";
 export * as AzureHelpers from "./helpers/data-access/azure/index";
 export * as OpenSearchHelpers from "./helpers/data-access/opensearch/index";
+export * as RateLimitHelpers from "./helpers/rate-limit/index";

package/dist/index.js

@@ -33,7 +33,7 @@ var __importStar = (this && this.__importStar) || (function () {
     };
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OpenSearchHelpers = exports.AzureHelpers = exports.SchemaDefinitions = exports.OutputGateway = exports.IntegrationEngine = exports.InputGateway = void 0;
+exports.RateLimitHelpers = exports.OpenSearchHelpers = exports.AzureHelpers = exports.SchemaDefinitions = exports.OutputGateway = exports.IntegrationEngine = exports.InputGateway = void 0;
 // Library exports
 exports.InputGateway = __importStar(require("./input-gateway/index"));
 exports.IntegrationEngine = __importStar(require("./integration-engine/index"));
@@ -41,4 +41,5 @@ exports.OutputGateway = __importStar(require("./output-gateway/index"));
 exports.SchemaDefinitions = __importStar(require("./schema-definitions/index"));
 exports.AzureHelpers = __importStar(require("./helpers/data-access/azure/index"));
 exports.OpenSearchHelpers = __importStar(require("./helpers/data-access/opensearch/index"));
+exports.RateLimitHelpers = __importStar(require("./helpers/rate-limit/index"));
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kBAAkB;AAClB,sEAA0C;AAC1C,gFAA+C;AAC/C,wEAA2C;AAC3C,gFAAgD;AAChD,kFAAiE;AACjE,4FAA2E"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,kBAAkB;AAClB,sEAA0C;AAC1C,gFAA+C;AAC/C,wEAA2C;AAC3C,gFAAgD;AAChD,kFAAiE;AACjE,4FAA2E;AAC3E,+EAA8D"}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@golemio/core",
-    "version": "4.1.3",
+    "version": "4.1.4",
     "description": "Golemio Core Module",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
@@ -119,6 +119,7 @@
         "pino-pretty": "^10.3.1",
         "prom-client": "^14.0.0",
         "qs": "^6.14.1",
+        "rate-limiter-flexible": "^11.2.1",
         "redis-rstream": "^1.0.1",
         "redis-semaphore": "^5.6.0",
         "redis-wstream": "^1.0.0",