express-rate-limit 7.2.0 → 7.3.0

package/dist/index.cjs

@@ -99,6 +99,7 @@ var ValidationError = class extends Error {
 };
 var ChangeWarning = class extends ValidationError {
 };
+var usedStores = /* @__PURE__ */ new Set();
 var singleCountKeys = /* @__PURE__ */ new WeakMap();
 var validations = {
   // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
@@ -182,6 +183,19 @@ var validations = {
       );
     }
   },
+  /**
+   * Ensures a single store instance is not used with multiple express-rate-limit instances
+   */
+  unsharedStore(store) {
+    if (usedStores.has(store)) {
+      const maybeUniquePrefix = store?.localKeys ? "" : " (with a unique prefix)";
+      throw new ValidationError(
+        "ERR_ERL_STORE_REUSE",
+        `A Store instance must not be shared across multiple rate limiters. Create a new instance of ${store.constructor.name}${maybeUniquePrefix} for each limiter instead.`
+      );
+    }
+    usedStores.add(store);
+  },
   /**
    * Ensures a given key is incremented only once per request.
    *
@@ -631,6 +645,7 @@ var rateLimit = (passedOptions) => {
   const config = parseOptions(passedOptions ?? {});
   const options = getOptionsFromConfig(config);
   config.validations.creationStack();
+  config.validations.unsharedStore(config.store);
   if (typeof config.store.init === "function")
     config.store.init(options);
   const middleware = handleAsyncErrors(

package/dist/index.d.cts

@@ -45,6 +45,10 @@ declare const validations: {
 	 * @param hits {any} - The `totalHits` returned by the store.
 	 */
 	positiveHits(hits: any): void;
+	/**
+	 * Ensures a single store instance is not used with multiple express-rate-limit instances
+	 */
+	unsharedStore(store: Store): void;
 	/**
 	 * Ensures a given key is incremented only once per request.
 	 *

package/dist/index.d.mts

@@ -45,6 +45,10 @@ declare const validations: {
 	 * @param hits {any} - The `totalHits` returned by the store.
 	 */
 	positiveHits(hits: any): void;
+	/**
+	 * Ensures a single store instance is not used with multiple express-rate-limit instances
+	 */
+	unsharedStore(store: Store): void;
 	/**
 	 * Ensures a given key is incremented only once per request.
 	 *

package/dist/index.d.ts

@@ -45,6 +45,10 @@ declare const validations: {
 	 * @param hits {any} - The `totalHits` returned by the store.
 	 */
 	positiveHits(hits: any): void;
+	/**
+	 * Ensures a single store instance is not used with multiple express-rate-limit instances
+	 */
+	unsharedStore(store: Store): void;
 	/**
 	 * Ensures a given key is incremented only once per request.
 	 *

package/dist/index.mjs

@@ -71,6 +71,7 @@ var ValidationError = class extends Error {
 };
 var ChangeWarning = class extends ValidationError {
 };
+var usedStores = /* @__PURE__ */ new Set();
 var singleCountKeys = /* @__PURE__ */ new WeakMap();
 var validations = {
   // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
@@ -154,6 +155,19 @@ var validations = {
       );
     }
   },
+  /**
+   * Ensures a single store instance is not used with multiple express-rate-limit instances
+   */
+  unsharedStore(store) {
+    if (usedStores.has(store)) {
+      const maybeUniquePrefix = store?.localKeys ? "" : " (with a unique prefix)";
+      throw new ValidationError(
+        "ERR_ERL_STORE_REUSE",
+        `A Store instance must not be shared across multiple rate limiters. Create a new instance of ${store.constructor.name}${maybeUniquePrefix} for each limiter instead.`
+      );
+    }
+    usedStores.add(store);
+  },
   /**
    * Ensures a given key is incremented only once per request.
    *
@@ -603,6 +617,7 @@ var rateLimit = (passedOptions) => {
   const config = parseOptions(passedOptions ?? {});
   const options = getOptionsFromConfig(config);
   config.validations.creationStack();
+  config.validations.unsharedStore(config.store);
   if (typeof config.store.init === "function")
     config.store.init(options);
   const middleware = handleAsyncErrors(

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "express-rate-limit",
-	"version": "7.2.0",
+	"version": "7.3.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",
@@ -87,7 +87,7 @@
 		"del-cli": "5.1.0",
 		"dts-bundle-generator": "8.0.1",
 		"esbuild": "0.19.5",
-		"express": "4.18.2",
+		"express": "4.19.2",
 		"husky": "8.0.3",
 		"jest": "29.7.0",
 		"lint-staged": "15.0.2",

package/readme.md

@@ -71,6 +71,15 @@ Gateway for developers. Add
 authentication and more to any API in minutes. Learn more at
 [zuplo.com](https://zuplo.link/express-rate-limit)
 
+<p align="center">
+<a href="https://zuplo.link/express-rate-limit">
+<picture width="322">
+  <source media="(prefers-color-scheme: dark)" srcset="https://github.com/express-rate-limit/express-rate-limit/assets/114976/cd2f6fa7-eae1-4fbb-be7d-b17df4c6f383">
+  <img alt="zuplo-logo" src="https://github.com/express-rate-limit/express-rate-limit/assets/114976/66fd75fa-b39e-4a8c-8d7a-52369bf244dc" width="322">
+</picture>
+</a>
+</p>
+
 ---
 
 Thanks to Mintlify for hosting the documentation at
@@ -90,7 +99,7 @@ Finally, thank you to everyone who's contributed to this project in any way!
 
 If you encounter a bug or want to see something added/changed, please go ahead
 and
-[open an issue](https://github.com/nfriexpress-rate-limitedly/express-rate-limit/issues/new)!
+[open an issue](https://github.com/express-rate-limit/express-rate-limit/issues/new)!
 If you need help with something, feel free to
 [start a discussion](https://github.com/express-rate-limit/express-rate-limit/discussions/new)!