express-rate-limit 6.4.0 → 6.6.0

package/changelog.md

@@ -6,6 +6,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [6.5.0](https://github.com/nfriedly/express-rate-limit/releases/tag/v6.5.0)
+
+## Changed
+
+- The message option can now be a (sync/asynx) function that returns a value
+  (#311)
+- Updated all dependencies
+
 ## [6.4.0](https://github.com/nfriedly/express-rate-limit/releases/tag/v6.3.0)
 
 ### Added

package/dist/index.cjs

@@ -1,3 +1,4 @@
+"use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;
@@ -36,12 +37,11 @@ var MemoryStore = class {
     this.windowMs = options.windowMs;
     this.resetTime = calculateNextResetTime(this.windowMs);
     this.hits = {};
-    const interval = setInterval(async () => {
+    this.interval = setInterval(async () => {
       await this.resetAll();
     }, this.windowMs);
-    if (interval.unref) {
-      interval.unref();
-    }
+    if (this.interval.unref)
+      this.interval.unref();
   }
   async increment(key) {
     var _a;
@@ -54,9 +54,8 @@ var MemoryStore = class {
   }
   async decrement(key) {
     const current = this.hits[key];
-    if (current) {
+    if (current)
       this.hits[key] = current - 1;
-    }
   }
   async resetKey(key) {
     delete this.hits[key];
@@ -65,6 +64,9 @@ var MemoryStore = class {
     this.hits = {};
     this.resetTime = calculateNextResetTime(this.windowMs);
   }
+  shutdown() {
+    clearInterval(this.interval);
+  }
 };
 
 // source/lib.ts
@@ -118,8 +120,12 @@ var parseOptions = (passedOptions) => {
       }
       return request.ip;
     },
-    handler(_request, response, _next, _optionsUsed) {
-      response.status(config.statusCode).send(config.message);
+    async handler(request, response, _next, _optionsUsed) {
+      response.status(config.statusCode);
+      const message = typeof config.message === "function" ? await config.message(request, response) : config.message;
+      if (!response.writableEnded) {
+        response.send(message != null ? message : "Too many requests, please try again later.");
+      }
     },
     onLimitReached(_request, _response, _optionsUsed) {
     },

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-// Generated by dts-bundle-generator v6.8.0
+// Generated by dts-bundle-generator v6.12.0
 
 import { NextFunction, Request, RequestHandler, Response } from 'express';
 
@@ -126,6 +126,10 @@ export interface Store {
 	 * Method to reset everyone's hit counter.
 	 */
 	resetAll?: () => Promise<void> | void;
+	/**
+	 * Method to shutdown the store, stop timers, and release all resources.
+	 */
+	shutdown?: () => Promise<void> | void;
 }
 /**
  * The configuration options for the rate limiter.
@@ -152,7 +156,7 @@ export interface Options {
 	 *
 	 * Defaults to `'Too many requests, please try again later.'`
 	 */
-	readonly message: any;
+	readonly message: any | ValueDeterminingMiddleware<any>;
 	/**
 	 * The HTTP status code to send back when a client is rate limited.
 	 *
@@ -276,7 +280,7 @@ export interface RateLimitInfo {
  *
  * @public
  */
-export declare const rateLimit: (passedOptions?: Partial<Options> | undefined) => RateLimitRequestHandler;
+export declare const rateLimit: (passedOptions?: Partial<Options>) => RateLimitRequestHandler;
 /**
  * A `Store` that stores the hit count for each client in memory.
  *
@@ -297,6 +301,10 @@ export declare class MemoryStore implements Store {
 	 * The time at which all hit counts will be reset.
 	 */
 	resetTime: Date;
+	/**
+	 * Reference to the active timer.
+	 */
+	interval?: NodeJS.Timer;
 	/**
 	 * Method that initializes the store.
 	 *
@@ -335,6 +343,13 @@ export declare class MemoryStore implements Store {
 	 * @public
 	 */
 	resetAll(): Promise<void>;
+	/**
+	 * Method to stop the timer (if currently running) and prevent any memory
+	 * leaks.
+	 *
+	 * @public
+	 */
+	shutdown(): void;
 }
 
 export {

package/dist/index.mjs

@@ -9,12 +9,11 @@ var MemoryStore = class {
     this.windowMs = options.windowMs;
     this.resetTime = calculateNextResetTime(this.windowMs);
     this.hits = {};
-    const interval = setInterval(async () => {
+    this.interval = setInterval(async () => {
       await this.resetAll();
     }, this.windowMs);
-    if (interval.unref) {
-      interval.unref();
-    }
+    if (this.interval.unref)
+      this.interval.unref();
   }
   async increment(key) {
     var _a;
@@ -27,9 +26,8 @@ var MemoryStore = class {
   }
   async decrement(key) {
     const current = this.hits[key];
-    if (current) {
+    if (current)
       this.hits[key] = current - 1;
-    }
   }
   async resetKey(key) {
     delete this.hits[key];
@@ -38,6 +36,9 @@ var MemoryStore = class {
     this.hits = {};
     this.resetTime = calculateNextResetTime(this.windowMs);
   }
+  shutdown() {
+    clearInterval(this.interval);
+  }
 };
 
 // source/lib.ts
@@ -91,8 +92,12 @@ var parseOptions = (passedOptions) => {
       }
       return request.ip;
     },
-    handler(_request, response, _next, _optionsUsed) {
-      response.status(config.statusCode).send(config.message);
+    async handler(request, response, _next, _optionsUsed) {
+      response.status(config.statusCode);
+      const message = typeof config.message === "function" ? await config.message(request, response) : config.message;
+      if (!response.writableEnded) {
+        response.send(message != null ? message : "Too many requests, please try again later.");
+      }
     },
     onLimitReached(_request, _response, _optionsUsed) {
     },

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "express-rate-limit",
-	"version": "6.4.0",
+	"version": "6.6.0",
 	"description": "Basic IP rate-limiting middleware for Express. Use to limit repeated requests to public APIs and/or endpoints such as password reset.",
 	"author": {
 		"name": "Nathan Friedly",
@@ -30,6 +30,7 @@
 	"type": "module",
 	"exports": {
 		".": {
+			"types": "./dist/index.d.ts",
 			"import": "./dist/index.mjs",
 			"require": "./dist/index.cjs"
 		}
@@ -70,25 +71,25 @@
 		"express": "^4 || ^5"
 	},
 	"devDependencies": {
-		"@jest/globals": "27.4.6",
+		"@jest/globals": "28.1.3",
 		"@types/express": "4.17.13",
-		"@types/jest": "27.4.1",
-		"@types/node": "16.11.27",
+		"@types/jest": "28.1.6",
+		"@types/node": "18.0.6",
 		"@types/supertest": "2.0.12",
 		"cross-env": "7.0.3",
 		"del-cli": "4.0.1",
-		"dts-bundle-generator": "6.8.0",
-		"esbuild": "0.14.38",
-		"express": "4.17.3",
-		"husky": "7.0.4",
-		"jest": "27.5.1",
-		"lint-staged": "12.4.0",
+		"dts-bundle-generator": "6.12.0",
+		"esbuild": "0.14.49",
+		"express": "4.18.1",
+		"husky": "8.0.1",
+		"jest": "28.1.3",
+		"lint-staged": "13.0.3",
 		"npm-run-all": "4.1.5",
-		"supertest": "6.2.2",
-		"ts-jest": "27.1.4",
-		"ts-node": "10.7.0",
-		"typescript": "4.6.3",
-		"xo": "0.48.0"
+		"supertest": "6.2.4",
+		"ts-jest": "28.0.7",
+		"ts-node": "10.9.1",
+		"typescript": "4.7.4",
+		"xo": "0.49.0"
 	},
 	"xo": {
 		"prettier": true,

package/readme.md

@@ -239,11 +239,30 @@ const limiter = rateLimit({
 The response body to send back when a client is rate limited.
 
 May be a `string`, JSON object, or any other value that Express's
-[response.send](https://expressjs.com/en/4x/api.html#response.send) method
-supports.
+[`response.send`](https://expressjs.com/en/4x/api.html#res.send) method
+supports. It can also be a (sync/async) function that accepts the Express
+request and response objects and then returns a `string`, JSON object or any
+other value the Express `response.send` function accepts.
 
 Defaults to `'Too many requests, please try again later.'`
 
+An example of using a function:
+
+```ts
+const isPremium = async (user) => {
+	// ...
+}
+
+const limiter = rateLimit({
+	// ...
+	message: async (request, response) => {
+		if (await isPremium(request.user))
+			return 'You can only make 10 requests every hour.'
+		else return 'You can only make 5 requests every hour.'
+	},
+})
+```
+
 ### `statusCode`
 
 > `number`
@@ -348,7 +367,8 @@ const limiter = rateLimit({
 Express request handler that sends back a response when a client is
 rate-limited.
 
-By default, sends back the `statusCode` and `message` set via the options:
+By default, sends back the `statusCode` and `message` set via the `options`,
+similar to this:
 
 ```ts
 const limiter = rateLimit({