@aomex/rate-limit 0.0.19 → 0.0.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/dist/index.d.ts +7 -6
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/package.json +5 -5
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,19 @@
|
|
|
1
1
|
# @aomex/rate-limit
|
|
2
2
|
|
|
3
|
+
## 0.0.21
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- Updated dependencies [[`e9996cb`](https://github.com/aomex/aomex/commit/e9996cb33cc0ef70b42147be02fbbe2b4954e022)]:
|
|
8
|
+
- @aomex/web@0.0.22
|
|
9
|
+
- @aomex/core@0.0.21
|
|
10
|
+
|
|
11
|
+
## 0.0.20
|
|
12
|
+
|
|
13
|
+
### Patch Changes
|
|
14
|
+
|
|
15
|
+
- [`5a33ba1`](https://github.com/aomex/aomex/commit/5a33ba1134abafa7d8bf38bd258e30f05473cfaf) Thanks [@geekact](https://github.com/geekact)! - refactor(rate-limit)!: rename option cache to driver
|
|
16
|
+
|
|
3
17
|
## 0.0.19
|
|
4
18
|
|
|
5
19
|
### Patch Changes
|
package/dist/index.d.ts
CHANGED
|
@@ -5,15 +5,17 @@ interface RateLimitOptions {
|
|
|
5
5
|
/**
|
|
6
6
|
* The database powering the backing rate-limiter package.
|
|
7
7
|
*/
|
|
8
|
-
|
|
8
|
+
driver?: Cache;
|
|
9
9
|
/**
|
|
10
10
|
* The length of a single limiting period. This value is expressed
|
|
11
|
-
* in milliseconds
|
|
11
|
+
* in milliseconds. Defaults `3600 * 1000`(1 hour)
|
|
12
12
|
*/
|
|
13
13
|
duration?: number;
|
|
14
14
|
/**
|
|
15
15
|
* The maximum amount of requests a client (see the `id` field) may
|
|
16
|
-
* make during a limiting period.
|
|
16
|
+
* make during a limiting period.
|
|
17
|
+
*
|
|
18
|
+
* @see duration
|
|
17
19
|
*/
|
|
18
20
|
max?: number;
|
|
19
21
|
/**
|
|
@@ -22,13 +24,12 @@ interface RateLimitOptions {
|
|
|
22
24
|
*/
|
|
23
25
|
id?: (ctx: WebContext) => string | false;
|
|
24
26
|
/**
|
|
25
|
-
* Whether or not to disable the usage of rate limit headers.
|
|
26
|
-
* to **false**.
|
|
27
|
+
* Whether or not to disable the usage of rate limit headers. Defaults `false`
|
|
27
28
|
*/
|
|
28
29
|
disableHeader?: boolean;
|
|
29
30
|
/**
|
|
30
31
|
* The message used on the response body if a client is rate-limited. There is
|
|
31
|
-
* a default message
|
|
32
|
+
* a default message which includes when they should try again.
|
|
32
33
|
*/
|
|
33
34
|
errorMessage?: string;
|
|
34
35
|
/**
|
package/dist/index.js
CHANGED
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { middleware, Cache, MemoryCache } from '@aomex/core';\nimport type { WebContext, WebMiddleware } from '@aomex/web';\nimport microtime from 'microtime';\nimport ms from 'ms';\n\nexport interface RateLimitOptions {\n /**\n * The database powering the backing rate-limiter package.\n */\n
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { middleware, Cache, MemoryCache } from '@aomex/core';\nimport type { WebContext, WebMiddleware } from '@aomex/web';\nimport microtime from 'microtime';\nimport ms from 'ms';\n\nexport interface RateLimitOptions {\n /**\n * The database powering the backing rate-limiter package.\n */\n driver?: Cache;\n\n /**\n * The length of a single limiting period. This value is expressed\n * in milliseconds. Defaults `3600 * 1000`(1 hour)\n */\n duration?: number;\n\n /**\n * The maximum amount of requests a client (see the `id` field) may\n * make during a limiting period.\n *\n * @see duration\n */\n max?: number;\n\n /**\n * Get the unique-identifier for a request. This defaults to the\n * client's IP address. Returning \"false\" will skip rate-limiting.\n */\n id?: (ctx: WebContext) => string | false;\n\n /**\n * Whether or not to disable the usage of rate limit headers. Defaults `false`\n */\n disableHeader?: boolean;\n\n /**\n * The message used on the response body if a client is rate-limited. There is\n * a default message which includes when they should try again.\n */\n errorMessage?: string;\n\n /**\n * Whether or not to throw an error upon being rate-limited. This uses\n * the `ctx.throw()`.\n */\n throw?: boolean;\n\n /**\n * A relation of header to the header's display name.\n */\n headers?: {\n /**\n * The amount of requests remaining in the current limiting period.\n */\n remaining?: string;\n\n /**\n * The time, expressed as a UNIX epoch timestamp, at which your rate-limit expires.\n */\n reset?: string;\n\n /**\n * The total amount of requests a client may make during a limiting period.\n */\n total?: string;\n };\n\n /**\n * If function returns true, middleware exits before limiting\n */\n allowList?: (ctx: WebContext) => boolean | Promise<boolean>;\n\n /**\n * If function returns true, 403 error is thrown\n */\n denyList?: (ctx: WebContext) => boolean | Promise<boolean>;\n}\n\ninterface LimitState {\n id: string;\n reset: number;\n current: number;\n total: number;\n}\n\nconst getState = async (\n cache: Cache,\n id: string,\n max: number,\n duration: number,\n) => {\n const key = `ratelimit:${id}`;\n let state = await cache.get<LimitState>(key);\n const now = microtime.now();\n const expired = state && state.reset * 1e6 < now;\n\n if (!state || expired) {\n state = {\n id,\n reset: (now + duration * 1e3) / 1e6,\n current: max,\n total: max,\n };\n } else {\n state.current = state.current > 0 ? state.current - 1 : 0;\n }\n\n await cache.set(key, state);\n return state!;\n};\n\nexport const rateLimit = (options: RateLimitOptions = {}): WebMiddleware => {\n const {\n driver: cache = new MemoryCache(),\n duration = 3600 * 1000, // 1 hour\n max = 2500,\n id: getId = (ctx) => ctx.request.ip,\n headers = {},\n disableHeader = false,\n denyList,\n allowList,\n } = options;\n\n const {\n remaining = 'X-RateLimit-Remaining',\n reset = 'X-RateLimit-Reset',\n total = 'X-RateLimit-Limit',\n } = headers;\n\n return middleware.web(async (ctx, next) => {\n if (denyList && (await denyList(ctx))) {\n ctx.throw(403);\n }\n\n const id = getId(ctx);\n if (id === false || (allowList && (await allowList(ctx)))) {\n return next();\n }\n\n const { response } = ctx;\n const state = await getState(cache, id, max, duration);\n let headers: Record<string, number> = {};\n if (!disableHeader) {\n headers = {\n [remaining]: state.current > 0 ? state.current - 1 : 0,\n [reset]: state.reset,\n [total]: state.total,\n };\n response.setHeaders(headers);\n }\n\n if (state.current) return next();\n\n const now = Date.now();\n const delta = Math.round(state.reset * 1e3 - now);\n const after = Math.round(state.reset - now / 1e3);\n const status = 429;\n const body =\n options.errorMessage ||\n `Rate limit exceeded, retry in ${ms(delta, { long: true })}.`;\n\n response.setHeader('Retry-After', after);\n response.statusCode = status;\n\n if (options.throw) {\n ctx.throw(status, body, { headers });\n } else {\n ctx.send(body);\n }\n });\n};\n"],"mappings":";AAAA,SAAS,YAAmB,mBAAmB;AAE/C,OAAO,eAAe;AACtB,OAAO,QAAQ;AAmFf,IAAM,WAAW,OACf,OACA,IACA,KACA,aACG;AACH,QAAM,MAAM,aAAa;AACzB,MAAI,QAAQ,MAAM,MAAM,IAAgB,GAAG;AAC3C,QAAM,MAAM,UAAU,IAAI;AAC1B,QAAM,UAAU,SAAS,MAAM,QAAQ,MAAM;AAE7C,MAAI,CAAC,SAAS,SAAS;AACrB,YAAQ;AAAA,MACN;AAAA,MACA,QAAQ,MAAM,WAAW,OAAO;AAAA,MAChC,SAAS;AAAA,MACT,OAAO;AAAA,IACT;AAAA,EACF,OAAO;AACL,UAAM,UAAU,MAAM,UAAU,IAAI,MAAM,UAAU,IAAI;AAAA,EAC1D;AAEA,QAAM,MAAM,IAAI,KAAK,KAAK;AAC1B,SAAO;AACT;AAEO,IAAM,YAAY,CAAC,UAA4B,CAAC,MAAqB;AAC1E,QAAM;AAAA,IACJ,QAAQ,QAAQ,IAAI,YAAY;AAAA,IAChC,WAAW,OAAO;AAAA;AAAA,IAClB,MAAM;AAAA,IACN,IAAI,QAAQ,CAAC,QAAQ,IAAI,QAAQ;AAAA,IACjC,UAAU,CAAC;AAAA,IACX,gBAAgB;AAAA,IAChB;AAAA,IACA;AAAA,EACF,IAAI;AAEJ,QAAM;AAAA,IACJ,YAAY;AAAA,IACZ,QAAQ;AAAA,IACR,QAAQ;AAAA,EACV,IAAI;AAEJ,SAAO,WAAW,IAAI,OAAO,KAAK,SAAS;AACzC,QAAI,YAAa,MAAM,SAAS,GAAG,GAAI;AACrC,UAAI,MAAM,GAAG;AAAA,IACf;AAEA,UAAM,KAAK,MAAM,GAAG;AACpB,QAAI,OAAO,SAAU,aAAc,MAAM,UAAU,GAAG,GAAK;AACzD,aAAO,KAAK;AAAA,IACd;AAEA,UAAM,EAAE,SAAS,IAAI;AACrB,UAAM,QAAQ,MAAM,SAAS,OAAO,IAAI,KAAK,QAAQ;AACrD,QAAIA,WAAkC,CAAC;AACvC,QAAI,CAAC,eAAe;AAClB,MAAAA,WAAU;AAAA,QACR,CAAC,SAAS,GAAG,MAAM,UAAU,IAAI,MAAM,UAAU,IAAI;AAAA,QACrD,CAAC,KAAK,GAAG,MAAM;AAAA,QACf,CAAC,KAAK,GAAG,MAAM;AAAA,MACjB;AACA,eAAS,WAAWA,QAAO;AAAA,IAC7B;AAEA,QAAI,MAAM;AAAS,aAAO,KAAK;AAE/B,UAAM,MAAM,KAAK,IAAI;AACrB,UAAM,QAAQ,KAAK,MAAM,MAAM,QAAQ,MAAM,GAAG;AAChD,UAAM,QAAQ,KAAK,MAAM,MAAM,QAAQ,MAAM,GAAG;AAChD,UAAM,SAAS;AACf,UAAM,OACJ,QAAQ,gBACR,iCAAiC,GAAG,OAAO,EAAE,MAAM,KAAK,CAAC;AAE3D,aAAS,UAAU,eAAe,KAAK;AACvC,aAAS,aAAa;AAEtB,QAAI,QAAQ,OAAO;AACjB,UAAI,MAAM,QAAQ,MAAM,EAAE,SAAAA,SAAQ,CAAC;AAAA,IACrC,OAAO;AACL,UAAI,KAAK,IAAI;AAAA,IACf;AAAA,EACF,CAAC;AACH;","names":["headers"]}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aomex/rate-limit",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.21",
|
|
4
4
|
"description": "Web request rate limit",
|
|
5
5
|
"repository": "git@github.com:aomex/aomex.git",
|
|
6
6
|
"homepage": "https://aomex.js.org",
|
|
@@ -26,17 +26,17 @@
|
|
|
26
26
|
"access": "public"
|
|
27
27
|
},
|
|
28
28
|
"peerDependencies": {
|
|
29
|
-
"@aomex/core": "^0.0.
|
|
30
|
-
"@aomex/web": "^0.0.
|
|
29
|
+
"@aomex/core": "^0.0.21",
|
|
30
|
+
"@aomex/web": "^0.0.22"
|
|
31
31
|
},
|
|
32
32
|
"dependencies": {
|
|
33
33
|
"microtime": "^3.1.1",
|
|
34
34
|
"ms": "^2.1.3"
|
|
35
35
|
},
|
|
36
36
|
"devDependencies": {
|
|
37
|
-
"@aomex/core": "^0.0.
|
|
37
|
+
"@aomex/core": "^0.0.21",
|
|
38
38
|
"@aomex/utility": "^0.0.7",
|
|
39
|
-
"@aomex/web": "^0.0.
|
|
39
|
+
"@aomex/web": "^0.0.22",
|
|
40
40
|
"@types/microtime": "^2.1.0",
|
|
41
41
|
"@types/ms": "^0.7.31"
|
|
42
42
|
},
|