@devbro/pashmak 0.1.37 → 0.1.38

package/dist/bin/middlewares.cjs

@@ -32,15 +32,12 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/middlewares.mts
 var middlewares_exports = {};
 __export(middlewares_exports, {
+  RateLimiterMiddleware: () => RateLimiterMiddleware,
   cors: () => cors,
   dbTransaction: () => dbTransaction
 });
 module.exports = __toCommonJS(middlewares_exports);
 
-// src/router.mts
-var import_neko_context = require("@devbro/neko-context");
-var import_errors = require("@devbro/neko-http/errors");
-
 // ../neko-router/dist/CompiledRoute.mjs
 var import_stream = require("stream");
 
@@ -457,6 +454,8 @@ var Router = class {
 };
 
 // src/router.mts
+var import_neko_context = require("@devbro/neko-context");
+var import_errors = require("@devbro/neko-http/errors");
 var import_neko_config = require("@devbro/neko-config");
 
 // src/facades.mts
@@ -756,6 +755,7 @@ var cache = (0, import_neko_helper2.createSingleton)((label) => {
 });
 
 // src/middlewares.mts
+var import_neko_http = require("@devbro/neko-http");
 function cors(options = {}) {
   return async (req, res, next) => {
     const allowedOrigins = options.allowedOrigins || ["*"];
@@ -787,8 +787,65 @@ async function dbTransaction(req, res, next) {
   }
 }
 __name(dbTransaction, "dbTransaction");
+var RateLimiterMiddleware = class _RateLimiterMiddleware extends Middleware {
+  constructor(params) {
+    super();
+    this.params = params;
+  }
+  static {
+    __name(this, "RateLimiterMiddleware");
+  }
+  static singletonInstance = void 0;
+  static getInstance(params = {}) {
+    if (_RateLimiterMiddleware.singletonInstance) {
+      return _RateLimiterMiddleware.singletonInstance;
+    }
+    let default_params = {
+      generateIdentifier: /* @__PURE__ */ __name((req) => req.socket.remoteAddress || "unknown", "generateIdentifier"),
+      maxRequests: 200,
+      windowTimeSize: 30,
+      windowCount: 4
+    };
+    const merged_params = { ...default_params, ...params };
+    return _RateLimiterMiddleware.singletonInstance = new _RateLimiterMiddleware(
+      merged_params
+    );
+  }
+  async call(req, res, next) {
+    let window = parseInt(
+      (Date.now() / 1e3 / this.params.windowTimeSize).toString()
+    );
+    let key = `rate_limiter:${this.params.generateIdentifier(req)}:${window}`;
+    let count = await cache().get(key) || 0;
+    if (!count) {
+      await cache().put(
+        key,
+        1,
+        this.params.windowTimeSize * (this.params.windowCount + 1)
+      );
+      count = 1;
+    } else {
+      count = await cache().increment(key, 1);
+    }
+    for (let i = 1; i < this.params.windowCount; i++) {
+      count += parseInt(
+        await cache().get(
+          `rate_limiter:${this.params.generateIdentifier(req)}:${window - i}`
+        ) || "0"
+      );
+    }
+    if (count > this.params.maxRequests) {
+      throw new import_neko_http.HttpTooManyRequestsError(
+        "Too many requests. Please try again later."
+      );
+    }
+    await next();
+    return;
+  }
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  RateLimiterMiddleware,
   cors,
   dbTransaction
 });

package/dist/middlewares.d.mts

@@ -1,8 +1,51 @@
-import { Request, Response } from '@devbro/neko-router';
+import { Request, Response, Middleware } from '@devbro/neko-router';
 
 declare function cors(options?: {
     allowedOrigins?: (string | RegExp)[];
 }): (req: Request, res: Response, next: () => Promise<void>) => Promise<void>;
 declare function dbTransaction(req: Request, res: Response, next: () => Promise<void>): Promise<void>;
+type RateLimiterMiddlewareParams = {
+    generateIdentifier: (req: Request) => string;
+    maxRequests: number;
+    windowTimeSize: number;
+    windowCount: number;
+};
+/**
+ * Rate limiter middleware using a sliding window algorithm.
+ *
+ * This middleware tracks request counts across multiple time windows to prevent abuse.
+ * It uses atomic cache increments to ensure accurate counting in concurrent environments.
+ *
+ * @example
+ * ```typescript
+ * // Basic usage with defaults (200 requests per 2 minutes)
+ * authnedRouter.addGlobalMiddleware(RateLimiterMiddleware);
+ *
+ * // Custom configuration
+ * authnedRouter.addGlobalMiddleware(RateLimiterMiddleware.getInstance({
+ *   generateIdentifier: (req) => req.headers['x-api-key'] || req.socket.remoteAddress,
+ *   maxRequests: 200,      // Allow 200 requests
+ *   windowTimeSize: 30,    // in 30 second windows
+ *   windowCount: 4         // looking back 4 windows (total: 120 seconds)
+ * }));
+ * ```
+ *
+ * @param params.generateIdentifier - Function to generate unique identifier for rate limiting (default: IP address)
+ * @param params.maxRequests - Maximum number of requests allowed across all windows (default: 200)
+ * @param params.windowTimeSize - Size of each time window in seconds (default: 30)
+ * @param params.windowCount - Number of previous windows to check (default: 4)
+ *
+ * The total time period checked is `windowTimeSize * windowCount` seconds.
+ * Default configuration: 200 requests per 120 seconds (30s × 4 windows).
+ *
+ * @throws {HttpTooManyRequestsError} When rate limit is exceeded
+ */
+declare class RateLimiterMiddleware extends Middleware {
+    private params;
+    static singletonInstance: Middleware | undefined;
+    static getInstance(params?: Partial<RateLimiterMiddlewareParams>): Middleware;
+    constructor(params: RateLimiterMiddlewareParams);
+    call(req: Request, res: Response, next: () => Promise<void>): Promise<void>;
+}
 
-export { cors, dbTransaction };
+export { RateLimiterMiddleware, type RateLimiterMiddlewareParams, cors, dbTransaction };

package/dist/middlewares.mjs

@@ -1,6 +1,8 @@
 var __defProp = Object.defineProperty;
 var __name = (target, value) => __defProp(target, "name", { value, configurable: true });
-import { db } from "./facades.mjs";
+import { Middleware } from "@devbro/neko-router";
+import { db, cache } from "./facades.mjs";
+import { HttpTooManyRequestsError } from "@devbro/neko-http";
 function cors(options = {}) {
   return async (req, res, next) => {
     const allowedOrigins = options.allowedOrigins || ["*"];
@@ -32,7 +34,64 @@ async function dbTransaction(req, res, next) {
   }
 }
 __name(dbTransaction, "dbTransaction");
+class RateLimiterMiddleware extends Middleware {
+  constructor(params) {
+    super();
+    this.params = params;
+  }
+  static {
+    __name(this, "RateLimiterMiddleware");
+  }
+  static singletonInstance = void 0;
+  static getInstance(params = {}) {
+    if (RateLimiterMiddleware.singletonInstance) {
+      return RateLimiterMiddleware.singletonInstance;
+    }
+    let default_params = {
+      generateIdentifier: /* @__PURE__ */ __name((req) => req.socket.remoteAddress || "unknown", "generateIdentifier"),
+      maxRequests: 200,
+      windowTimeSize: 30,
+      windowCount: 4
+    };
+    const merged_params = { ...default_params, ...params };
+    return RateLimiterMiddleware.singletonInstance = new RateLimiterMiddleware(
+      merged_params
+    );
+  }
+  async call(req, res, next) {
+    let window = parseInt(
+      (Date.now() / 1e3 / this.params.windowTimeSize).toString()
+    );
+    let key = `rate_limiter:${this.params.generateIdentifier(req)}:${window}`;
+    let count = await cache().get(key) || 0;
+    if (!count) {
+      await cache().put(
+        key,
+        1,
+        this.params.windowTimeSize * (this.params.windowCount + 1)
+      );
+      count = 1;
+    } else {
+      count = await cache().increment(key, 1);
+    }
+    for (let i = 1; i < this.params.windowCount; i++) {
+      count += parseInt(
+        await cache().get(
+          `rate_limiter:${this.params.generateIdentifier(req)}:${window - i}`
+        ) || "0"
+      );
+    }
+    if (count > this.params.maxRequests) {
+      throw new HttpTooManyRequestsError(
+        "Too many requests. Please try again later."
+      );
+    }
+    await next();
+    return;
+  }
+}
 export {
+  RateLimiterMiddleware,
   cors,
   dbTransaction
 };

package/dist/middlewares.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/middlewares.mts"],"sourcesContent":["import { Request, Response } from \"@devbro/neko-router\";\nimport { logger, db } from \"./facades.mjs\";\n\nexport function cors(\n  options: { allowedOrigins?: (string | RegExp)[] } = {},\n): (req: Request, res: Response, next: () => Promise<void>) => Promise<void> {\n  return async (\n    req: Request,\n    res: Response,\n    next: () => Promise<void>,\n  ): Promise<void> => {\n    const allowedOrigins = options.allowedOrigins || [\"*\"];\n    const origin = req.headers.origin || \"*\";\n\n    for (const allowedOrigin of allowedOrigins) {\n      if (typeof allowedOrigin === \"string\" && allowedOrigin === origin) {\n        res.setHeader(\"Access-Control-Allow-Origin\", allowedOrigin);\n        break;\n      } else if (\n        allowedOrigin instanceof RegExp &&\n        allowedOrigin.test(origin)\n      ) {\n        res.setHeader(\"Access-Control-Allow-Origin\", origin);\n        break;\n      } else if (allowedOrigin === \"*\") {\n        res.setHeader(\"Access-Control-Allow-Origin\", \"*\");\n        break;\n      }\n    }\n\n    res.setHeader(\"Access-Control-Allow-Headers\", \"*\");\n    await next();\n  };\n}\n\nexport async function dbTransaction(\n  req: Request,\n  res: Response,\n  next: () => Promise<void>,\n): Promise<void> {\n  try {\n    await db().beginTransaction();\n    await next();\n    await db().commit();\n  } finally {\n    await db().rollback();\n  }\n}\n"],"mappings":";;AACA,SAAiB,UAAU;AAEpB,SAAS,KACd,UAAoD,CAAC,GACsB;AAC3E,SAAO,OACL,KACA,KACA,SACkB;AAClB,UAAM,iBAAiB,QAAQ,kBAAkB,CAAC,GAAG;AACrD,UAAM,SAAS,IAAI,QAAQ,UAAU;AAErC,eAAW,iBAAiB,gBAAgB;AAC1C,UAAI,OAAO,kBAAkB,YAAY,kBAAkB,QAAQ;AACjE,YAAI,UAAU,+BAA+B,aAAa;AAC1D;AAAA,MACF,WACE,yBAAyB,UACzB,cAAc,KAAK,MAAM,GACzB;AACA,YAAI,UAAU,+BAA+B,MAAM;AACnD;AAAA,MACF,WAAW,kBAAkB,KAAK;AAChC,YAAI,UAAU,+BAA+B,GAAG;AAChD;AAAA,MACF;AAAA,IACF;AAEA,QAAI,UAAU,gCAAgC,GAAG;AACjD,UAAM,KAAK;AAAA,EACb;AACF;AA9BgB;AAgChB,eAAsB,cACpB,KACA,KACA,MACe;AACf,MAAI;AACF,UAAM,GAAG,EAAE,iBAAiB;AAC5B,UAAM,KAAK;AACX,UAAM,GAAG,EAAE,OAAO;AAAA,EACpB,UAAE;AACA,UAAM,GAAG,EAAE,SAAS;AAAA,EACtB;AACF;AAZsB;","names":[]}
+{"version":3,"sources":["../src/middlewares.mts"],"sourcesContent":["import { Middleware, Request, Response } from \"@devbro/neko-router\";\nimport { logger, db, cache } from \"./facades.mjs\";\nimport { HttpTooManyRequestsError } from \"@devbro/neko-http\";\n\nexport function cors(\n  options: { allowedOrigins?: (string | RegExp)[] } = {},\n): (req: Request, res: Response, next: () => Promise<void>) => Promise<void> {\n  return async (\n    req: Request,\n    res: Response,\n    next: () => Promise<void>,\n  ): Promise<void> => {\n    const allowedOrigins = options.allowedOrigins || [\"*\"];\n    const origin = req.headers.origin || \"*\";\n\n    for (const allowedOrigin of allowedOrigins) {\n      if (typeof allowedOrigin === \"string\" && allowedOrigin === origin) {\n        res.setHeader(\"Access-Control-Allow-Origin\", allowedOrigin);\n        break;\n      } else if (\n        allowedOrigin instanceof RegExp &&\n        allowedOrigin.test(origin)\n      ) {\n        res.setHeader(\"Access-Control-Allow-Origin\", origin);\n        break;\n      } else if (allowedOrigin === \"*\") {\n        res.setHeader(\"Access-Control-Allow-Origin\", \"*\");\n        break;\n      }\n    }\n\n    res.setHeader(\"Access-Control-Allow-Headers\", \"*\");\n    await next();\n  };\n}\n\nexport async function dbTransaction(\n  req: Request,\n  res: Response,\n  next: () => Promise<void>,\n): Promise<void> {\n  try {\n    await db().beginTransaction();\n    await next();\n    await db().commit();\n  } finally {\n    await db().rollback();\n  }\n}\n\nexport type RateLimiterMiddlewareParams = {\n  generateIdentifier: (req: Request) => string;\n  maxRequests: number;\n  windowTimeSize: number;\n  windowCount: number;\n};\n\n/**\n * Rate limiter middleware using a sliding window algorithm.\n *\n * This middleware tracks request counts across multiple time windows to prevent abuse.\n * It uses atomic cache increments to ensure accurate counting in concurrent environments.\n *\n * @example\n * ```typescript\n * // Basic usage with defaults (200 requests per 2 minutes)\n * authnedRouter.addGlobalMiddleware(RateLimiterMiddleware);\n *\n * // Custom configuration\n * authnedRouter.addGlobalMiddleware(RateLimiterMiddleware.getInstance({\n *   generateIdentifier: (req) => req.headers['x-api-key'] || req.socket.remoteAddress,\n *   maxRequests: 200,      // Allow 200 requests\n *   windowTimeSize: 30,    // in 30 second windows\n *   windowCount: 4         // looking back 4 windows (total: 120 seconds)\n * }));\n * ```\n *\n * @param params.generateIdentifier - Function to generate unique identifier for rate limiting (default: IP address)\n * @param params.maxRequests - Maximum number of requests allowed across all windows (default: 200)\n * @param params.windowTimeSize - Size of each time window in seconds (default: 30)\n * @param params.windowCount - Number of previous windows to check (default: 4)\n *\n * The total time period checked is `windowTimeSize * windowCount` seconds.\n * Default configuration: 200 requests per 120 seconds (30s × 4 windows).\n *\n * @throws {HttpTooManyRequestsError} When rate limit is exceeded\n */\nexport class RateLimiterMiddleware extends Middleware {\n  static singletonInstance: Middleware | undefined = undefined;\n  static getInstance(\n    params: Partial<RateLimiterMiddlewareParams> = {},\n  ): Middleware {\n    if (RateLimiterMiddleware.singletonInstance) {\n      return RateLimiterMiddleware.singletonInstance;\n    }\n    let default_params: RateLimiterMiddlewareParams = {\n      generateIdentifier: (req: Request) =>\n        req.socket.remoteAddress || \"unknown\",\n      maxRequests: 200,\n      windowTimeSize: 30,\n      windowCount: 4,\n    };\n    const merged_params = { ...default_params, ...params };\n    return (RateLimiterMiddleware.singletonInstance = new RateLimiterMiddleware(\n      merged_params,\n    ));\n  }\n\n  constructor(private params: RateLimiterMiddlewareParams) {\n    super();\n  }\n\n  async call(\n    req: Request,\n    res: Response,\n    next: () => Promise<void>,\n  ): Promise<void> {\n    let window = parseInt(\n      (Date.now() / 1000 / this.params.windowTimeSize).toString(),\n    );\n    let key = `rate_limiter:${this.params.generateIdentifier(req)}:${window}`;\n    let count: number = (await cache().get(key)) || 0;\n    if (!count) {\n      await cache().put(\n        key,\n        1,\n        this.params.windowTimeSize * (this.params.windowCount + 1),\n      );\n      count = 1;\n    } else {\n      count = await cache().increment(key, 1);\n    }\n\n    for (let i = 1; i < this.params.windowCount; i++) {\n      count += parseInt(\n        (await cache().get(\n          `rate_limiter:${this.params.generateIdentifier(req)}:${window - i}`,\n        )) || \"0\",\n      );\n    }\n\n    if (count > this.params.maxRequests) {\n      throw new HttpTooManyRequestsError(\n        \"Too many requests. Please try again later.\",\n      );\n    }\n\n    await next();\n    return;\n  }\n}\n"],"mappings":";;AAAA,SAAS,kBAAqC;AAC9C,SAAiB,IAAI,aAAa;AAClC,SAAS,gCAAgC;AAElC,SAAS,KACd,UAAoD,CAAC,GACsB;AAC3E,SAAO,OACL,KACA,KACA,SACkB;AAClB,UAAM,iBAAiB,QAAQ,kBAAkB,CAAC,GAAG;AACrD,UAAM,SAAS,IAAI,QAAQ,UAAU;AAErC,eAAW,iBAAiB,gBAAgB;AAC1C,UAAI,OAAO,kBAAkB,YAAY,kBAAkB,QAAQ;AACjE,YAAI,UAAU,+BAA+B,aAAa;AAC1D;AAAA,MACF,WACE,yBAAyB,UACzB,cAAc,KAAK,MAAM,GACzB;AACA,YAAI,UAAU,+BAA+B,MAAM;AACnD;AAAA,MACF,WAAW,kBAAkB,KAAK;AAChC,YAAI,UAAU,+BAA+B,GAAG;AAChD;AAAA,MACF;AAAA,IACF;AAEA,QAAI,UAAU,gCAAgC,GAAG;AACjD,UAAM,KAAK;AAAA,EACb;AACF;AA9BgB;AAgChB,eAAsB,cACpB,KACA,KACA,MACe;AACf,MAAI;AACF,UAAM,GAAG,EAAE,iBAAiB;AAC5B,UAAM,KAAK;AACX,UAAM,GAAG,EAAE,OAAO;AAAA,EACpB,UAAE;AACA,UAAM,GAAG,EAAE,SAAS;AAAA,EACtB;AACF;AAZsB;AAmDf,MAAM,8BAA8B,WAAW;AAAA,EAqBpD,YAAoB,QAAqC;AACvD,UAAM;AADY;AAAA,EAEpB;AAAA,EA9GF,OAuFsD;AAAA;AAAA;AAAA,EACpD,OAAO,oBAA4C;AAAA,EACnD,OAAO,YACL,SAA+C,CAAC,GACpC;AACZ,QAAI,sBAAsB,mBAAmB;AAC3C,aAAO,sBAAsB;AAAA,IAC/B;AACA,QAAI,iBAA8C;AAAA,MAChD,oBAAoB,wBAAC,QACnB,IAAI,OAAO,iBAAiB,WADV;AAAA,MAEpB,aAAa;AAAA,MACb,gBAAgB;AAAA,MAChB,aAAa;AAAA,IACf;AACA,UAAM,gBAAgB,EAAE,GAAG,gBAAgB,GAAG,OAAO;AACrD,WAAQ,sBAAsB,oBAAoB,IAAI;AAAA,MACpD;AAAA,IACF;AAAA,EACF;AAAA,EAMA,MAAM,KACJ,KACA,KACA,MACe;AACf,QAAI,SAAS;AAAA,OACV,KAAK,IAAI,IAAI,MAAO,KAAK,OAAO,gBAAgB,SAAS;AAAA,IAC5D;AACA,QAAI,MAAM,gBAAgB,KAAK,OAAO,mBAAmB,GAAG,CAAC,IAAI,MAAM;AACvE,QAAI,QAAiB,MAAM,MAAM,EAAE,IAAI,GAAG,KAAM;AAChD,QAAI,CAAC,OAAO;AACV,YAAM,MAAM,EAAE;AAAA,QACZ;AAAA,QACA;AAAA,QACA,KAAK,OAAO,kBAAkB,KAAK,OAAO,cAAc;AAAA,MAC1D;AACA,cAAQ;AAAA,IACV,OAAO;AACL,cAAQ,MAAM,MAAM,EAAE,UAAU,KAAK,CAAC;AAAA,IACxC;AAEA,aAAS,IAAI,GAAG,IAAI,KAAK,OAAO,aAAa,KAAK;AAChD,eAAS;AAAA,QACN,MAAM,MAAM,EAAE;AAAA,UACb,gBAAgB,KAAK,OAAO,mBAAmB,GAAG,CAAC,IAAI,SAAS,CAAC;AAAA,QACnE,KAAM;AAAA,MACR;AAAA,IACF;AAEA,QAAI,QAAQ,KAAK,OAAO,aAAa;AACnC,YAAM,IAAI;AAAA,QACR;AAAA,MACF;AAAA,IACF;AAEA,UAAM,KAAK;AACX;AAAA,EACF;AACF;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@devbro/pashmak",
-  "version": "0.1.37",
+  "version": "0.1.38",
   "description": "testing application for the entire repo",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",