express-rate-limit 6.0.0 → 6.0.1

package/changelog.md

@@ -6,7 +6,7 @@ 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.0.0
+## [6.0.0](https://github.com/nfriedly/express-rate-limit/releases/v6.0.0)
 
 ### Added
 
@@ -24,6 +24,7 @@ and this project adheres to
 - Rename the `headers` option to `legacyHeaders`.
 - `Retry-After` header is now sent if either `legacyHeaders` or
   `standardHeaders` is set.
+- Allow `keyGenerator` to be an async function/return a promise.
 - Change the way custom stores are defined.
   - Add the `init` method for stores to set themselves up using options passed
     to the middleware.
@@ -32,7 +33,8 @@ and this project adheres to
     return a promise.
   - Old stores will automatically be promisified and used.
 - The package can now only be used with NodeJS version 12.9.0 or greater.
-- The `onLimitReached` configuration option is now deprecated. Replace it with a custom `handler` that checks the number of hits.
+- The `onLimitReached` configuration option is now deprecated. Replace it with a
+  custom `handler` that checks the number of hits.
 
 ### Removed
 

package/dist/cjs/package.json

@@ -0,0 +1,12 @@
+{
+	"types": "./index.d.ts",
+	"exports": {
+		".": "./index.js"
+	},
+	"engines": {
+		"node": ">= 12.9.0"
+	},
+	"peerDependencies": {
+		"express": "^4"
+	}
+}

package/dist/esm/package.json

@@ -0,0 +1,13 @@
+{
+	"type": "module",
+	"types": "./index.d.ts",
+	"exports": {
+		".": "./index.js"
+	},
+	"engines": {
+		"node": ">= 12.9.0"
+	},
+	"peerDependencies": {
+		"express": "^4"
+	}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "express-rate-limit",
-	"version": "6.0.0",
+	"version": "6.0.1",
 	"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",
@@ -28,33 +28,17 @@
 		"attack"
 	],
 	"type": "module",
-	"module": "dist/esm/index.js",
-	"main": "dist/cjs/index.js",
+	"types": "./dist/esm/index.d.ts",
 	"exports": {
 		".": {
 			"import": "./dist/esm/index.js",
 			"require": "./dist/cjs/index.js"
-		},
-		"./memory-store": {
-			"import": "./dist/esm/memory-store.js",
-			"require": "./dist/cjs/memory-store.js"
-		}
-	},
-	"typesVersions": {
-		"*": {
-			".": [
-				"./dist/esm/index.d.ts"
-			],
-			"./memory-store": [
-				"./dist/esm/memory-store.d.ts"
-			]
 		}
 	},
 	"files": [
 		"dist/",
 		"tsconfig.json",
 		"package.json",
-		"package-lock.json",
 		"readme.md",
 		"license.md",
 		"changelog.md"
@@ -64,8 +48,8 @@
 	},
 	"scripts": {
 		"clean": "del-cli dist/ coverage/ *.log *.tmp *.bak *.tgz",
-		"build:cjs": "tsc --project config/typescript/cjs.json",
-		"build:esm": "tsc --project config/typescript/esm.json",
+		"build:cjs": "tsc --project config/typescript/cjs.json && cpy --rename package.json config/node/cjs.json dist/cjs/",
+		"build:esm": "tsc --project config/typescript/esm.json && cpy --rename package.json config/node/esm.json dist/esm/",
 		"build": "run-p build:*",
 		"compile": "run-s clean build",
 		"lint": "xo",
@@ -85,6 +69,7 @@
 		"@types/jest": "^27.0.3",
 		"@types/node": "^16.11.17",
 		"@types/supertest": "^2.0.11",
+		"cpy-cli": "^3.1.1",
 		"cross-env": "^7.0.3",
 		"del-cli": "^4.0.1",
 		"express": "^4.17.1",

package/readme.md

@@ -275,7 +275,7 @@ const keyGenerator = (request /*, response*/) => request.ip
 
 The function to handle requests once the max limit is exceeded. It receives the
 `request` and the `response` objects. The `next` param is available if you need
-to pass to the next middleware/route. Finally, the `optionsUsed` param has all
+to pass to the next middleware/route. Finally, the `options` param has all
 of the options that originally passed in when creating the current limiter and
 the default values for other options.
 
@@ -285,7 +285,7 @@ requests and, if the store provides it, a `resetTime` Date object.
 Defaults to:
 
 ```ts
-const handler = (request, response, next, optionsUsed) => {
+const handler = (request, response, next, options) => {
 	response.status(options.statusCode).send(options.message)
 }
 ```