@lidofinance/next-ip-rate-limit 0.10.0

package/README.md

@@ -0,0 +1,46 @@
+# @lidofinance/next-ip-rate-limit
+
+IP rate limit for next server api requests.
+
+## Installation
+
+`yarn add @lidofinance/next-ip-rate-limit`.
+
+## Getting started
+
+### With Next.js API
+
+```ts
+import { ipRateLimit } from '@lidofinance/next-ip-rate-limit'
+import { NextApiRequest, NextApiResponse } from 'next'
+
+// env vars
+const RATE_LIMIT = 60
+const RATE_LIMIT_TIME_FRAME = 60 // 1 min
+
+const someRequest = async (req, res) => {
+  ipRateLimit({
+    req,
+    res,
+    limit: RATE_LIMIT,
+    timeFrame: RATE_LIMIT_TIME_FRAME,
+  })
+
+  await fetch()
+}
+
+export default someRequest
+```
+
+### With @lidofinance/next-api-wrapper
+
+```ts
+import { wrapRequest, API } from '@lidofinance/next-api-wrapper'
+import { ipRateLimit, rateLimitWrapper } from '@lidofinance/next-ip-rate-limit'
+
+const someRequest: API = async (req, res) => await fetch()
+
+export const rateLimit = rateLimitWrapper({ rateLimit: RATE_LIMIT, rateLimitTimeFrame: RATE_LIMIT_TIME_FRAME })
+
+export default wrapRequest([rateLimit, someWrapper])(someRequest)
+```

package/dist/index.cjs

@@ -0,0 +1,129 @@
+function $parcel$exportWildcard(dest, source) {
+  Object.keys(source).forEach(function(key) {
+    if (key === 'default' || key === '__esModule' || dest.hasOwnProperty(key)) {
+      return;
+    }
+
+    Object.defineProperty(dest, key, {
+      enumerable: true,
+      get: function get() {
+        return source[key];
+      }
+    });
+  });
+
+  return dest;
+}
+function $parcel$export(e, n, v, s) {
+  Object.defineProperty(e, n, {get: v, set: s, enumerable: true, configurable: true});
+}
+var $abe9c276dfd79488$exports = {};
+
+$parcel$export($abe9c276dfd79488$exports, "ipRateLimit", () => $abe9c276dfd79488$export$122bebc9e141287c);
+class $9e3ba9e2f0393d79$export$230ecc6ad0ef6558 {
+    timeoutIds = [];
+    constructor(){
+        this._storage = new Map();
+    }
+    set(key, value, durationSec) {
+        this._storage.set(key, {
+            value: value
+        });
+        if (this._storage.get(key)?.timeoutId) clearTimeout(this._storage.get(key)?.timeoutId);
+        // code based on the work with setTimeouts from the code from the nestjs throttling service
+        // https://github.com/nestjs/throttler/blob/master/src/throttler.service.ts#L25
+        const timeoutId = setTimeout(()=>{
+            clearTimeout(timeoutId);
+            this.timeoutIds = this.timeoutIds.filter((id)=>id != timeoutId);
+            this.delete(key);
+        }, durationSec * 1000);
+        this.timeoutIds.push(timeoutId);
+    }
+    get(key) {
+        return this._storage.get(key)?.value;
+    }
+    inc(key, durationSec) {
+        if (this._storage.has(key)) this.set(key, (this._storage.get(key)?.value || 0) + 1, durationSec);
+        else this.set(key, 1, durationSec);
+        return this.get(key);
+    }
+    delete(key) {
+        if (this._storage.has(key)) this._storage.delete(key);
+    }
+}
+
+
+var $54a02752d7f6015e$exports = {};
+
+$parcel$export($54a02752d7f6015e$exports, "RATE_LIMIT_HEADERS", () => $54a02752d7f6015e$export$a063967512de3ebf);
+$parcel$export($54a02752d7f6015e$exports, "ERROR_MESSAGE", () => $54a02752d7f6015e$export$3f27bc10068ef877);
+const $54a02752d7f6015e$export$a063967512de3ebf = {
+    limit: `X-RateLimit-Limit`,
+    remaining: `X-RateLimit-Remaining`,
+    reset: `X-RateLimit-Reset`
+};
+const $54a02752d7f6015e$export$3f27bc10068ef877 = "API rate limit exceeded for";
+
+
+const $c63185ef25ccfd28$export$67218453e01a0be8 = (req)=>{
+    const cfConnectionIp = req.headers["cf_connecting_ip"];
+    const xff = req.headers["x-forwarded-for"];
+    if (cfConnectionIp) return Array.isArray(cfConnectionIp) ? cfConnectionIp[0] : cfConnectionIp.split(",")[0];
+    return xff ? Array.isArray(xff) ? xff[0] : xff.split(",")[0] : "127.0.0.1";
+};
+const $c63185ef25ccfd28$export$d0a20d44a54350ab = ({ id: id , res: res , req: req  })=>{
+    res.status(429);
+    throw new Error(`${(0, $54a02752d7f6015e$export$3f27bc10068ef877)} ${id} ${req.url || ""}`);
+};
+
+
+
+let $abe9c276dfd79488$var$rateLimitStorage;
+const $abe9c276dfd79488$export$122bebc9e141287c = (data)=>{
+    if (!$abe9c276dfd79488$var$rateLimitStorage) $abe9c276dfd79488$var$rateLimitStorage = new (0, $9e3ba9e2f0393d79$export$230ecc6ad0ef6558)();
+    const { res: res , req: req , limit: limit , timeFrame: timeFrame  } = data;
+    const headers = (0, $54a02752d7f6015e$export$a063967512de3ebf);
+    const id = `ip:${(0, $c63185ef25ccfd28$export$67218453e01a0be8)(req)}`;
+    const time = Math.floor(Date.now() / 1000 / timeFrame);
+    const key = `${id}:${time}`;
+    const callCount = $abe9c276dfd79488$var$rateLimitStorage.inc(key, data.timeFrame);
+    const remaining = limit - (callCount || 0);
+    const reset = (time + 1) * timeFrame;
+    res.setHeader(headers.limit, `${limit}`);
+    res.setHeader(headers.remaining, `${remaining < 0 ? 0 : remaining}`);
+    res.setHeader(headers.reset, `${reset}`);
+    if (remaining < 0) (0, $c63185ef25ccfd28$export$d0a20d44a54350ab)({
+        id: id,
+        res: res,
+        req: req
+    });
+    return res;
+};
+
+
+var $bad81bc593a4351d$exports = {};
+
+$parcel$export($bad81bc593a4351d$exports, "rateLimitWrapper", () => $bad81bc593a4351d$export$1e3e762f475f853);
+
+const $bad81bc593a4351d$export$1e3e762f475f853 = ({ rateLimit: rateLimit , rateLimitTimeFrame: rateLimitTimeFrame  })=>async (req, res, next)=>{
+        (0, $abe9c276dfd79488$export$122bebc9e141287c)({
+            req: req,
+            res: res,
+            limit: rateLimit,
+            timeFrame: rateLimitTimeFrame
+        });
+        await next?.(req, res, next);
+    };
+
+
+
+var $3cbdb2b44a8a698d$exports = {};
+
+
+$parcel$exportWildcard(module.exports, $abe9c276dfd79488$exports);
+$parcel$exportWildcard(module.exports, $bad81bc593a4351d$exports);
+$parcel$exportWildcard(module.exports, $54a02752d7f6015e$exports);
+$parcel$exportWildcard(module.exports, $3cbdb2b44a8a698d$exports);
+
+
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"mappings":";;;;;;;;;;;;;;;;;;;;;;AEEO,MAAM,yCAAgB;IAE3B,AAAQ,UAAU,GAAqB,EAAE,CAAA;IAEzC,aAAc;QACZ,IAAI,CAAC,QAAQ,GAAG,IAAI,GAAG,EAAE;KAC1B;IAED,GAAG,CAAC,GAAW,EAAE,KAAa,EAAE,WAAmB,EAAE;QACnD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE;mBAAE,KAAK;SAAE,CAAC;QAEjC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,SAAS,EACnC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC;QAGjD,2FAA2F;QAC3F,+EAA+E;QAC/E,MAAM,SAAS,GAAG,UAAU,CAAC,IAAM;YACjC,YAAY,CAAC,SAAS,CAAC;YAEvB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,GAAK,EAAE,IAAI,SAAS,CAAC;YACjE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;SACjB,EAAE,WAAW,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC;KAChC;IAED,GAAG,CAAC,GAAW,EAAE;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,KAAK,CAAA;KACrC;IAED,GAAG,CAAC,GAAW,EAAE,WAAmB,EAAE;QACpC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EACxB,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,AAAC,CAAA,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,CAAA,GAAI,CAAC,EAAE,WAAW,CAAC;aAEpE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,WAAW,CAAC;QAG/B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;KACrB;IACD,MAAM,CAAC,GAAW,EAAE;QAClB,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EACxB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC;KAE5B;CACF;;AD9CD;;;;;AGAO,MAAM,yCAAkB,GAAG;IAChC,KAAK,EAAE,CAAC,iBAAiB,CAAC;IAC1B,SAAS,EAAE,CAAC,qBAAqB,CAAC;IAClC,KAAK,EAAE,CAAC,iBAAiB,CAAC;CAC3B;AAEM,MAAM,yCAAa,GAAG,6BAA6B;;ADN1D;AAQO,MAAM,yCAAK,GAAG,CAAC,GAAmB,GAAK;IAC5C,MAAM,cAAc,GAAG,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAC;IACtD,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAC;IAE1C,IAAI,cAAc,EAAE,OAAO,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;IAE3G,OAAO,GAAG,GAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAI,WAAW,CAAA;CAC7E;AAEM,MAAM,yCAAmB,GAAwB,CAAC,MAAE,EAAE,CAAA,OAAE,GAAG,CAAA,OAAE,GAAG,CAAA,EAAE,GAAK;IAC5E,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC;IAEf,MAAM,IAAI,KAAK,CAAC,CAAC,EAAE,CAAA,GAAA,yCAAa,CAAA,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,CAAA;CAC3D;;;;AFhBD,IAAI,sCAAgB,AAAkB;AAE/B,MAAM,yCAAW,GAAc,CAAC,IAAI,GAAK;IAC9C,IAAI,CAAC,sCAAgB,EAAE,sCAAgB,GAAG,IAAI,CAAA,GAAA,yCAAgB,CAAA,EAAE;IAEhE,MAAM,OAAE,GAAG,CAAA,OAAE,GAAG,CAAA,SAAE,KAAK,CAAA,aAAE,SAAS,CAAA,EAAE,GAAG,IAAI;IAC3C,MAAM,OAAO,GAAG,CAAA,GAAA,yCAAkB,CAAA;IAClC,MAAM,EAAE,GAAG,CAAC,GAAG,EAAE,CAAA,GAAA,yCAAK,CAAA,CAAC,GAAG,CAAC,CAAC,CAAC;IAE7B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,GAAG,SAAS,CAAC;IACtD,MAAM,GAAG,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IAE3B,MAAM,SAAS,GAAG,sCAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC;IAC3D,MAAM,SAAS,GAAG,KAAK,GAAI,CAAA,SAAS,IAAI,CAAC,CAAA,AAAC;IAC1C,MAAM,KAAK,GAAG,AAAC,CAAA,IAAI,GAAG,CAAC,CAAA,GAAI,SAAS;IAEpC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;IACxC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,EAAE,SAAS,GAAG,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;IACpE,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;IAExC,IAAI,SAAS,GAAG,CAAC,EAAE,CAAA,GAAA,yCAAmB,CAAA,CAAC;YAAE,EAAE;aAAE,GAAG;aAAE,GAAG;KAAE,CAAC;IAExD,OAAO,GAAG,CAAA;CACX;;AD5BD;;;;AKAA;AAKO,MAAM,wCAAgB,GAC3B,CAAC,aAAE,SAAS,CAAA,sBAAE,kBAAkB,CAAA,EAAwB,GACxD,OAAO,GAAG,EAAE,GAAG,EAAE,IAAI,GAAK;QACxB,CAAA,GAAA,yCAAW,CAAA,CAAC;iBACV,GAAG;iBACH,GAAG;YACH,KAAK,EAAE,SAAS;YAChB,SAAS,EAAE,kBAAkB;SAC9B,CAAC;QAEF,MAAM,IAAI,GAAG,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC;KAC7B;;;;;;","sources":["packages/next/ip-rate-limit/src/index.ts","packages/next/ip-rate-limit/src/ip-rate-limit.ts","packages/next/ip-rate-limit/src/storage.ts","packages/next/ip-rate-limit/src/utils.ts","packages/next/ip-rate-limit/src/constants.ts","packages/next/ip-rate-limit/src/wrapper.ts","packages/next/ip-rate-limit/src/types.ts"],"sourcesContent":["export * from './ip-rate-limit'\nexport * from './wrapper'\nexport * from './constants'\nexport * from './types'\n","import { RateLimitStorage } from './storage'\nimport { getIP, rateLimitedResponse } from './utils'\nimport { RATE_LIMIT_HEADERS } from './constants'\nimport { RateLimit } from './types'\n\nlet rateLimitStorage: RateLimitStorage\n\nexport const ipRateLimit: RateLimit = (data) => {\n  if (!rateLimitStorage) rateLimitStorage = new RateLimitStorage()\n\n  const { res, req, limit, timeFrame } = data\n  const headers = RATE_LIMIT_HEADERS\n  const id = `ip:${getIP(req)}`\n\n  const time = Math.floor(Date.now() / 1000 / timeFrame)\n  const key = `${id}:${time}`\n\n  const callCount = rateLimitStorage.inc(key, data.timeFrame)\n  const remaining = limit - (callCount || 0)\n  const reset = (time + 1) * timeFrame\n\n  res.setHeader(headers.limit, `${limit}`)\n  res.setHeader(headers.remaining, `${remaining < 0 ? 0 : remaining}`)\n  res.setHeader(headers.reset, `${reset}`)\n\n  if (remaining < 0) rateLimitedResponse({ id, res, req })\n\n  return res\n}\n","import { RateLimitStorageType } from './types'\n\nexport class RateLimitStorage {\n  private _storage: RateLimitStorageType\n  private timeoutIds: NodeJS.Timeout[] = []\n\n  constructor() {\n    this._storage = new Map()\n  }\n\n  set(key: string, value: number, durationSec: number) {\n    this._storage.set(key, { value })\n\n    if (this._storage.get(key)?.timeoutId) {\n      clearTimeout(this._storage.get(key)?.timeoutId)\n    }\n\n    // code based on the work with setTimeouts from the code from the nestjs throttling service\n    // https://github.com/nestjs/throttler/blob/master/src/throttler.service.ts#L25\n    const timeoutId = setTimeout(() => {\n      clearTimeout(timeoutId)\n\n      this.timeoutIds = this.timeoutIds.filter((id) => id != timeoutId)\n      this.delete(key)\n    }, durationSec * 1000)\n    this.timeoutIds.push(timeoutId)\n  }\n\n  get(key: string) {\n    return this._storage.get(key)?.value\n  }\n\n  inc(key: string, durationSec: number) {\n    if (this._storage.has(key)) {\n      this.set(key, (this._storage.get(key)?.value || 0) + 1, durationSec)\n    } else {\n      this.set(key, 1, durationSec)\n    }\n\n    return this.get(key)\n  }\n  delete(key: string) {\n    if (this._storage.has(key)) {\n      this._storage.delete(key)\n    }\n  }\n}\n","import { NextApiRequest } from 'next'\nimport { ERROR_MESSAGE } from './constants'\nimport { RateLimitedResponse } from './types'\n\n// now we use headers from \"cloudflare\" and rely on their validity.\n// If there are no \"cloudflare\" headers, we use the \"x-forwarded-for\" header,\n// but keep in mind that these headers can be changed by anyone\n// https://developers.cloudflare.com/fundamentals/get-started/reference/http-request-headers/\nexport const getIP = (req: NextApiRequest) => {\n  const cfConnectionIp = req.headers['cf_connecting_ip']\n  const xff = req.headers['x-forwarded-for']\n\n  if (cfConnectionIp) return Array.isArray(cfConnectionIp) ? cfConnectionIp[0] : cfConnectionIp.split(',')[0]\n\n  return xff ? (Array.isArray(xff) ? xff[0] : xff.split(',')[0]) : '127.0.0.1'\n}\n\nexport const rateLimitedResponse: RateLimitedResponse = ({ id, res, req }) => {\n  res.status(429)\n\n  throw new Error(`${ERROR_MESSAGE} ${id} ${req.url || ''}`)\n}\n","export const RATE_LIMIT_HEADERS = {\n  limit: `X-RateLimit-Limit`,\n  remaining: `X-RateLimit-Remaining`,\n  reset: `X-RateLimit-Reset`,\n}\n\nexport const ERROR_MESSAGE = 'API rate limit exceeded for'\n","import { RequestWrapper } from '@lidofinance/next-api-wrapper'\n\nimport { ipRateLimit } from './ip-rate-limit'\nimport { RateLimitWrapperArgs } from './types'\n\nexport const rateLimitWrapper =\n  ({ rateLimit, rateLimitTimeFrame }: RateLimitWrapperArgs): RequestWrapper =>\n  async (req, res, next) => {\n    ipRateLimit({\n      req,\n      res,\n      limit: rateLimit,\n      timeFrame: rateLimitTimeFrame,\n    })\n\n    await next?.(req, res, next)\n  }\n","import { NextApiResponse, NextApiRequest } from 'next'\n\nexport type RateLimitStorageType = Map<string, { value: number; timeoutId?: NodeJS.Timeout }>\n\nexport type RateLimitedResponse = (data: { res: NextApiResponse; id: string; req: NextApiRequest }) => void\n\nexport type RateLimit = (data: {\n  req: NextApiRequest\n  res: NextApiResponse\n  limit: number\n  timeFrame: number\n}) => NextApiResponse\n\nexport type RateLimitWrapperArgs = {\n  rateLimit: number\n  rateLimitTimeFrame: number\n}\n"],"names":[],"version":3,"file":"index.cjs.map","sourceRoot":"../../../../"}

package/dist/index.d.ts

@@ -0,0 +1,31 @@
+import { NextApiResponse, NextApiRequest } from "next";
+import { RequestWrapper } from "@lidofinance/next-api-wrapper";
+export type RateLimitStorageType = Map<string, {
+    value: number;
+    timeoutId?: NodeJS.Timeout;
+}>;
+export type RateLimitedResponse = (data: {
+    res: NextApiResponse;
+    id: string;
+    req: NextApiRequest;
+}) => void;
+export type RateLimit = (data: {
+    req: NextApiRequest;
+    res: NextApiResponse;
+    limit: number;
+    timeFrame: number;
+}) => NextApiResponse;
+export type RateLimitWrapperArgs = {
+    rateLimit: number;
+    rateLimitTimeFrame: number;
+};
+export const RATE_LIMIT_HEADERS: {
+    limit: string;
+    remaining: string;
+    reset: string;
+};
+export const ERROR_MESSAGE = "API rate limit exceeded for";
+export const ipRateLimit: RateLimit;
+export const rateLimitWrapper: ({ rateLimit, rateLimitTimeFrame }: RateLimitWrapperArgs) => RequestWrapper;
+
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"mappings":";;AAEA,mCAAmC,GAAG,CAAC,MAAM,EAAE;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,SAAS,CAAC,EAAE,OAAO,OAAO,CAAA;CAAE,CAAC,CAAA;AAE7F,kCAAkC,CAAC,IAAI,EAAE;IAAE,GAAG,EAAE,eAAe,CAAC;IAAC,EAAE,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,cAAc,CAAA;CAAE,KAAK,IAAI,CAAA;AAE3G,wBAAwB,CAAC,IAAI,EAAE;IAC7B,GAAG,EAAE,cAAc,CAAA;IACnB,GAAG,EAAE,eAAe,CAAA;IACpB,KAAK,EAAE,MAAM,CAAA;IACb,SAAS,EAAE,MAAM,CAAA;CAClB,KAAK,eAAe,CAAA;AAErB,mCAAmC;IACjC,SAAS,EAAE,MAAM,CAAA;IACjB,kBAAkB,EAAE,MAAM,CAAA;CAC3B,CAAA;AEhBD,OAAO,MAAM;;;;CAIZ,CAAA;AAED,OAAO,MAAM,6CAA6C,CAAA;AEC1D,OAAO,MAAM,aAAa,SAqBzB,CAAA;ACvBD,OAAO,MAAM,sDACyB,oBAAoB,KAAG,cAU1D,CAAA","sources":["packages/next/ip-rate-limit/src/src/types.ts","packages/next/ip-rate-limit/src/src/storage.ts","packages/next/ip-rate-limit/src/src/constants.ts","packages/next/ip-rate-limit/src/src/utils.ts","packages/next/ip-rate-limit/src/src/ip-rate-limit.ts","packages/next/ip-rate-limit/src/src/wrapper.ts","packages/next/ip-rate-limit/src/src/index.ts","packages/next/ip-rate-limit/src/index.ts"],"sourcesContent":[null,null,null,null,null,null,null,"export * from './ip-rate-limit'\nexport * from './wrapper'\nexport * from './constants'\nexport * from './types'\n"],"names":[],"version":3,"file":"index.d.ts.map","sourceRoot":"../../../../"}

package/dist/index.mjs

@@ -0,0 +1,110 @@
+function $parcel$export(e, n, v, s) {
+  Object.defineProperty(e, n, {get: v, set: s, enumerable: true, configurable: true});
+}
+var $4a980b7982e8368e$exports = {};
+
+$parcel$export($4a980b7982e8368e$exports, "ipRateLimit", () => $4a980b7982e8368e$export$122bebc9e141287c);
+class $a5fb111f145df95d$export$230ecc6ad0ef6558 {
+    timeoutIds = [];
+    constructor(){
+        this._storage = new Map();
+    }
+    set(key, value, durationSec) {
+        this._storage.set(key, {
+            value: value
+        });
+        if (this._storage.get(key)?.timeoutId) clearTimeout(this._storage.get(key)?.timeoutId);
+        // code based on the work with setTimeouts from the code from the nestjs throttling service
+        // https://github.com/nestjs/throttler/blob/master/src/throttler.service.ts#L25
+        const timeoutId = setTimeout(()=>{
+            clearTimeout(timeoutId);
+            this.timeoutIds = this.timeoutIds.filter((id)=>id != timeoutId);
+            this.delete(key);
+        }, durationSec * 1000);
+        this.timeoutIds.push(timeoutId);
+    }
+    get(key) {
+        return this._storage.get(key)?.value;
+    }
+    inc(key, durationSec) {
+        if (this._storage.has(key)) this.set(key, (this._storage.get(key)?.value || 0) + 1, durationSec);
+        else this.set(key, 1, durationSec);
+        return this.get(key);
+    }
+    delete(key) {
+        if (this._storage.has(key)) this._storage.delete(key);
+    }
+}
+
+
+var $1022f9b28fec0213$exports = {};
+
+$parcel$export($1022f9b28fec0213$exports, "RATE_LIMIT_HEADERS", () => $1022f9b28fec0213$export$a063967512de3ebf);
+$parcel$export($1022f9b28fec0213$exports, "ERROR_MESSAGE", () => $1022f9b28fec0213$export$3f27bc10068ef877);
+const $1022f9b28fec0213$export$a063967512de3ebf = {
+    limit: `X-RateLimit-Limit`,
+    remaining: `X-RateLimit-Remaining`,
+    reset: `X-RateLimit-Reset`
+};
+const $1022f9b28fec0213$export$3f27bc10068ef877 = "API rate limit exceeded for";
+
+
+const $15f73ba5d70a67f1$export$67218453e01a0be8 = (req)=>{
+    const cfConnectionIp = req.headers["cf_connecting_ip"];
+    const xff = req.headers["x-forwarded-for"];
+    if (cfConnectionIp) return Array.isArray(cfConnectionIp) ? cfConnectionIp[0] : cfConnectionIp.split(",")[0];
+    return xff ? Array.isArray(xff) ? xff[0] : xff.split(",")[0] : "127.0.0.1";
+};
+const $15f73ba5d70a67f1$export$d0a20d44a54350ab = ({ id: id , res: res , req: req  })=>{
+    res.status(429);
+    throw new Error(`${(0, $1022f9b28fec0213$export$3f27bc10068ef877)} ${id} ${req.url || ""}`);
+};
+
+
+
+let $4a980b7982e8368e$var$rateLimitStorage;
+const $4a980b7982e8368e$export$122bebc9e141287c = (data)=>{
+    if (!$4a980b7982e8368e$var$rateLimitStorage) $4a980b7982e8368e$var$rateLimitStorage = new (0, $a5fb111f145df95d$export$230ecc6ad0ef6558)();
+    const { res: res , req: req , limit: limit , timeFrame: timeFrame  } = data;
+    const headers = (0, $1022f9b28fec0213$export$a063967512de3ebf);
+    const id = `ip:${(0, $15f73ba5d70a67f1$export$67218453e01a0be8)(req)}`;
+    const time = Math.floor(Date.now() / 1000 / timeFrame);
+    const key = `${id}:${time}`;
+    const callCount = $4a980b7982e8368e$var$rateLimitStorage.inc(key, data.timeFrame);
+    const remaining = limit - (callCount || 0);
+    const reset = (time + 1) * timeFrame;
+    res.setHeader(headers.limit, `${limit}`);
+    res.setHeader(headers.remaining, `${remaining < 0 ? 0 : remaining}`);
+    res.setHeader(headers.reset, `${reset}`);
+    if (remaining < 0) (0, $15f73ba5d70a67f1$export$d0a20d44a54350ab)({
+        id: id,
+        res: res,
+        req: req
+    });
+    return res;
+};
+
+
+var $f6440f950b4feda9$exports = {};
+
+$parcel$export($f6440f950b4feda9$exports, "rateLimitWrapper", () => $f6440f950b4feda9$export$1e3e762f475f853);
+
+const $f6440f950b4feda9$export$1e3e762f475f853 = ({ rateLimit: rateLimit , rateLimitTimeFrame: rateLimitTimeFrame  })=>async (req, res, next)=>{
+        (0, $4a980b7982e8368e$export$122bebc9e141287c)({
+            req: req,
+            res: res,
+            limit: rateLimit,
+            timeFrame: rateLimitTimeFrame
+        });
+        await next?.(req, res, next);
+    };
+
+
+
+var $4f28aa0b2d7963de$exports = {};
+
+
+
+
+export {$4a980b7982e8368e$export$122bebc9e141287c as ipRateLimit, $f6440f950b4feda9$export$1e3e762f475f853 as rateLimitWrapper, $1022f9b28fec0213$export$a063967512de3ebf as RATE_LIMIT_HEADERS, $1022f9b28fec0213$export$3f27bc10068ef877 as ERROR_MESSAGE};
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"mappings":";;;;;;AEEO,MAAM,yCAAgB;IAE3B,AAAQ,UAAU,GAAqB,EAAE,CAAA;IAEzC,aAAc;QACZ,IAAI,CAAC,QAAQ,GAAG,IAAI,GAAG,EAAE;KAC1B;IAED,GAAG,CAAC,GAAW,EAAE,KAAa,EAAE,WAAmB,EAAE;QACnD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,EAAE;mBAAE,KAAK;SAAE,CAAC;QAEjC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,SAAS,EACnC,YAAY,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC;QAGjD,2FAA2F;QAC3F,+EAA+E;QAC/E,MAAM,SAAS,GAAG,UAAU,CAAC,IAAM;YACjC,YAAY,CAAC,SAAS,CAAC;YAEvB,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,GAAK,EAAE,IAAI,SAAS,CAAC;YACjE,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC;SACjB,EAAE,WAAW,GAAG,IAAI,CAAC;QACtB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,SAAS,CAAC;KAChC;IAED,GAAG,CAAC,GAAW,EAAE;QACf,OAAO,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,KAAK,CAAA;KACrC;IAED,GAAG,CAAC,GAAW,EAAE,WAAmB,EAAE;QACpC,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EACxB,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,AAAC,CAAA,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,KAAK,IAAI,CAAC,CAAA,GAAI,CAAC,EAAE,WAAW,CAAC;aAEpE,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,WAAW,CAAC;QAG/B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;KACrB;IACD,MAAM,CAAC,GAAW,EAAE;QAClB,IAAI,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,GAAG,CAAC,EACxB,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC;KAE5B;CACF;;AD9CD;;;;;AGAO,MAAM,yCAAkB,GAAG;IAChC,KAAK,EAAE,CAAC,iBAAiB,CAAC;IAC1B,SAAS,EAAE,CAAC,qBAAqB,CAAC;IAClC,KAAK,EAAE,CAAC,iBAAiB,CAAC;CAC3B;AAEM,MAAM,yCAAa,GAAG,6BAA6B;;ADN1D;AAQO,MAAM,yCAAK,GAAG,CAAC,GAAmB,GAAK;IAC5C,MAAM,cAAc,GAAG,GAAG,CAAC,OAAO,CAAC,kBAAkB,CAAC;IACtD,MAAM,GAAG,GAAG,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAC;IAE1C,IAAI,cAAc,EAAE,OAAO,KAAK,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,cAAc,CAAC,CAAC,CAAC,GAAG,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;IAE3G,OAAO,GAAG,GAAI,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAI,WAAW,CAAA;CAC7E;AAEM,MAAM,yCAAmB,GAAwB,CAAC,MAAE,EAAE,CAAA,OAAE,GAAG,CAAA,OAAE,GAAG,CAAA,EAAE,GAAK;IAC5E,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC;IAEf,MAAM,IAAI,KAAK,CAAC,CAAC,EAAE,CAAA,GAAA,yCAAa,CAAA,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC,CAAA;CAC3D;;;;AFhBD,IAAI,sCAAgB,AAAkB;AAE/B,MAAM,yCAAW,GAAc,CAAC,IAAI,GAAK;IAC9C,IAAI,CAAC,sCAAgB,EAAE,sCAAgB,GAAG,IAAI,CAAA,GAAA,yCAAgB,CAAA,EAAE;IAEhE,MAAM,OAAE,GAAG,CAAA,OAAE,GAAG,CAAA,SAAE,KAAK,CAAA,aAAE,SAAS,CAAA,EAAE,GAAG,IAAI;IAC3C,MAAM,OAAO,GAAG,CAAA,GAAA,yCAAkB,CAAA;IAClC,MAAM,EAAE,GAAG,CAAC,GAAG,EAAE,CAAA,GAAA,yCAAK,CAAA,CAAC,GAAG,CAAC,CAAC,CAAC;IAE7B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,GAAG,SAAS,CAAC;IACtD,MAAM,GAAG,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC;IAE3B,MAAM,SAAS,GAAG,sCAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,CAAC;IAC3D,MAAM,SAAS,GAAG,KAAK,GAAI,CAAA,SAAS,IAAI,CAAC,CAAA,AAAC;IAC1C,MAAM,KAAK,GAAG,AAAC,CAAA,IAAI,GAAG,CAAC,CAAA,GAAI,SAAS;IAEpC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;IACxC,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC,EAAE,SAAS,GAAG,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC,CAAC,CAAC;IACpE,GAAG,CAAC,SAAS,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC;IAExC,IAAI,SAAS,GAAG,CAAC,EAAE,CAAA,GAAA,yCAAmB,CAAA,CAAC;YAAE,EAAE;aAAE,GAAG;aAAE,GAAG;KAAE,CAAC;IAExD,OAAO,GAAG,CAAA;CACX;;AD5BD;;;;AKAA;AAKO,MAAM,wCAAgB,GAC3B,CAAC,aAAE,SAAS,CAAA,sBAAE,kBAAkB,CAAA,EAAwB,GACxD,OAAO,GAAG,EAAE,GAAG,EAAE,IAAI,GAAK;QACxB,CAAA,GAAA,yCAAW,CAAA,CAAC;iBACV,GAAG;iBACH,GAAG;YACH,KAAK,EAAE,SAAS;YAChB,SAAS,EAAE,kBAAkB;SAC9B,CAAC;QAEF,MAAM,IAAI,GAAG,GAAG,EAAE,GAAG,EAAE,IAAI,CAAC;KAC7B;;;;;;","sources":["packages/next/ip-rate-limit/src/index.ts","packages/next/ip-rate-limit/src/ip-rate-limit.ts","packages/next/ip-rate-limit/src/storage.ts","packages/next/ip-rate-limit/src/utils.ts","packages/next/ip-rate-limit/src/constants.ts","packages/next/ip-rate-limit/src/wrapper.ts","packages/next/ip-rate-limit/src/types.ts"],"sourcesContent":["export * from './ip-rate-limit'\nexport * from './wrapper'\nexport * from './constants'\nexport * from './types'\n","import { RateLimitStorage } from './storage'\nimport { getIP, rateLimitedResponse } from './utils'\nimport { RATE_LIMIT_HEADERS } from './constants'\nimport { RateLimit } from './types'\n\nlet rateLimitStorage: RateLimitStorage\n\nexport const ipRateLimit: RateLimit = (data) => {\n  if (!rateLimitStorage) rateLimitStorage = new RateLimitStorage()\n\n  const { res, req, limit, timeFrame } = data\n  const headers = RATE_LIMIT_HEADERS\n  const id = `ip:${getIP(req)}`\n\n  const time = Math.floor(Date.now() / 1000 / timeFrame)\n  const key = `${id}:${time}`\n\n  const callCount = rateLimitStorage.inc(key, data.timeFrame)\n  const remaining = limit - (callCount || 0)\n  const reset = (time + 1) * timeFrame\n\n  res.setHeader(headers.limit, `${limit}`)\n  res.setHeader(headers.remaining, `${remaining < 0 ? 0 : remaining}`)\n  res.setHeader(headers.reset, `${reset}`)\n\n  if (remaining < 0) rateLimitedResponse({ id, res, req })\n\n  return res\n}\n","import { RateLimitStorageType } from './types'\n\nexport class RateLimitStorage {\n  private _storage: RateLimitStorageType\n  private timeoutIds: NodeJS.Timeout[] = []\n\n  constructor() {\n    this._storage = new Map()\n  }\n\n  set(key: string, value: number, durationSec: number) {\n    this._storage.set(key, { value })\n\n    if (this._storage.get(key)?.timeoutId) {\n      clearTimeout(this._storage.get(key)?.timeoutId)\n    }\n\n    // code based on the work with setTimeouts from the code from the nestjs throttling service\n    // https://github.com/nestjs/throttler/blob/master/src/throttler.service.ts#L25\n    const timeoutId = setTimeout(() => {\n      clearTimeout(timeoutId)\n\n      this.timeoutIds = this.timeoutIds.filter((id) => id != timeoutId)\n      this.delete(key)\n    }, durationSec * 1000)\n    this.timeoutIds.push(timeoutId)\n  }\n\n  get(key: string) {\n    return this._storage.get(key)?.value\n  }\n\n  inc(key: string, durationSec: number) {\n    if (this._storage.has(key)) {\n      this.set(key, (this._storage.get(key)?.value || 0) + 1, durationSec)\n    } else {\n      this.set(key, 1, durationSec)\n    }\n\n    return this.get(key)\n  }\n  delete(key: string) {\n    if (this._storage.has(key)) {\n      this._storage.delete(key)\n    }\n  }\n}\n","import { NextApiRequest } from 'next'\nimport { ERROR_MESSAGE } from './constants'\nimport { RateLimitedResponse } from './types'\n\n// now we use headers from \"cloudflare\" and rely on their validity.\n// If there are no \"cloudflare\" headers, we use the \"x-forwarded-for\" header,\n// but keep in mind that these headers can be changed by anyone\n// https://developers.cloudflare.com/fundamentals/get-started/reference/http-request-headers/\nexport const getIP = (req: NextApiRequest) => {\n  const cfConnectionIp = req.headers['cf_connecting_ip']\n  const xff = req.headers['x-forwarded-for']\n\n  if (cfConnectionIp) return Array.isArray(cfConnectionIp) ? cfConnectionIp[0] : cfConnectionIp.split(',')[0]\n\n  return xff ? (Array.isArray(xff) ? xff[0] : xff.split(',')[0]) : '127.0.0.1'\n}\n\nexport const rateLimitedResponse: RateLimitedResponse = ({ id, res, req }) => {\n  res.status(429)\n\n  throw new Error(`${ERROR_MESSAGE} ${id} ${req.url || ''}`)\n}\n","export const RATE_LIMIT_HEADERS = {\n  limit: `X-RateLimit-Limit`,\n  remaining: `X-RateLimit-Remaining`,\n  reset: `X-RateLimit-Reset`,\n}\n\nexport const ERROR_MESSAGE = 'API rate limit exceeded for'\n","import { RequestWrapper } from '@lidofinance/next-api-wrapper'\n\nimport { ipRateLimit } from './ip-rate-limit'\nimport { RateLimitWrapperArgs } from './types'\n\nexport const rateLimitWrapper =\n  ({ rateLimit, rateLimitTimeFrame }: RateLimitWrapperArgs): RequestWrapper =>\n  async (req, res, next) => {\n    ipRateLimit({\n      req,\n      res,\n      limit: rateLimit,\n      timeFrame: rateLimitTimeFrame,\n    })\n\n    await next?.(req, res, next)\n  }\n","import { NextApiResponse, NextApiRequest } from 'next'\n\nexport type RateLimitStorageType = Map<string, { value: number; timeoutId?: NodeJS.Timeout }>\n\nexport type RateLimitedResponse = (data: { res: NextApiResponse; id: string; req: NextApiRequest }) => void\n\nexport type RateLimit = (data: {\n  req: NextApiRequest\n  res: NextApiResponse\n  limit: number\n  timeFrame: number\n}) => NextApiResponse\n\nexport type RateLimitWrapperArgs = {\n  rateLimit: number\n  rateLimitTimeFrame: number\n}\n"],"names":[],"version":3,"file":"index.mjs.map","sourceRoot":"../../../../"}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@lidofinance/next-ip-rate-limit",
+  "description": "IP rate limit for next server api requests",
+  "repository": "git@github.com:lidofinance/warehouse.git",
+  "license": "MIT",
+  "version": "0.10.0",
+  "files": [
+    "dist"
+  ],
+  "engines": {
+    "node": ">= 16"
+  },
+  "source": "./src/index.ts",
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "parcel build",
+    "format": "prettier --check src",
+    "format:fix": "yarn format --write",
+    "types": "tsc --noEmit",
+    "test": "jest"
+  },
+  "peerDependencies": {
+    "next": "^12.2.0"
+  },
+  "devDependencies": {
+    "@lidofinance/config-prettier": "~0.10.0",
+    "@types/jest": "^28.0.0",
+    "@types/node": "^18.11.2",
+    "jest": "^28.0.0",
+    "next": "^12.3.1",
+    "ts-jest": "^28.0.0"
+  },
+  "dependencies": {
+    "@lidofinance/next-api-wrapper": "~0.10.0"
+  }
+}