express-rate-limit 7.5.0 → 7.5.1

package/dist/index.cjs

@@ -18,18 +18,22 @@ var __copyProps = (to, from, except, desc) => {
 var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
 
 // source/index.ts
-var source_exports = {};
-__export(source_exports, {
+var index_exports = {};
+__export(index_exports, {
   MemoryStore: () => MemoryStore,
   default: () => lib_default,
   rateLimit: () => lib_default
 });
-module.exports = __toCommonJS(source_exports);
+module.exports = __toCommonJS(index_exports);
 
 // source/headers.ts
-var import_node_buffer = require("buffer");
-var import_node_crypto = require("crypto");
-var SUPPORTED_DRAFT_VERSIONS = ["draft-6", "draft-7", "draft-8"];
+var import_node_buffer = require("node:buffer");
+var import_node_crypto = require("node:crypto");
+var SUPPORTED_DRAFT_VERSIONS = [
+  "draft-6",
+  "draft-7",
+  "draft-8"
+];
 var getResetSeconds = (resetTime, windowMs) => {
   let resetSeconds = void 0;
   if (resetTime) {
@@ -47,8 +51,7 @@ var getPartitionKey = (key) => {
   return import_node_buffer.Buffer.from(partitionKey).toString("base64");
 };
 var setLegacyHeaders = (response, info) => {
-  if (response.headersSent)
-    return;
+  if (response.headersSent) return;
   response.setHeader("X-RateLimit-Limit", info.limit.toString());
   response.setHeader("X-RateLimit-Remaining", info.remaining.toString());
   if (info.resetTime instanceof Date) {
@@ -60,8 +63,7 @@ var setLegacyHeaders = (response, info) => {
   }
 };
 var setDraft6Headers = (response, info, windowMs) => {
-  if (response.headersSent)
-    return;
+  if (response.headersSent) return;
   const windowSeconds = Math.ceil(windowMs / 1e3);
   const resetSeconds = getResetSeconds(info.resetTime);
   response.setHeader("RateLimit-Policy", `${info.limit};w=${windowSeconds}`);
@@ -71,8 +73,7 @@ var setDraft6Headers = (response, info, windowMs) => {
     response.setHeader("RateLimit-Reset", resetSeconds.toString());
 };
 var setDraft7Headers = (response, info, windowMs) => {
-  if (response.headersSent)
-    return;
+  if (response.headersSent) return;
   const windowSeconds = Math.ceil(windowMs / 1e3);
   const resetSeconds = getResetSeconds(info.resetTime, windowMs);
   response.setHeader("RateLimit-Policy", `${info.limit};w=${windowSeconds}`);
@@ -82,8 +83,7 @@ var setDraft7Headers = (response, info, windowMs) => {
   );
 };
 var setDraft8Headers = (response, info, windowMs, name, key) => {
-  if (response.headersSent)
-    return;
+  if (response.headersSent) return;
   const windowSeconds = Math.ceil(windowMs / 1e3);
   const resetSeconds = getResetSeconds(info.resetTime, windowMs);
   const partitionKey = getPartitionKey(key);
@@ -93,14 +93,13 @@ var setDraft8Headers = (response, info, windowMs, name, key) => {
   response.append("RateLimit", `"${name}"; ${header}`);
 };
 var setRetryAfterHeader = (response, info, windowMs) => {
-  if (response.headersSent)
-    return;
+  if (response.headersSent) return;
   const resetSeconds = getResetSeconds(info.resetTime, windowMs);
   response.setHeader("Retry-After", resetSeconds.toString());
 };
 
 // source/validations.ts
-var import_node_net = require("net");
+var import_node_net = require("node:net");
 var ValidationError = class extends Error {
   /**
    * The code must be a string, in snake case and all capital, that starts with
@@ -128,8 +127,7 @@ var validations = {
   },
   // Should be EnabledValidations type, but that's a circular reference
   disable() {
-    for (const k of Object.keys(this.enabled))
-      this.enabled[k] = false;
+    for (const k of Object.keys(this.enabled)) this.enabled[k] = false;
   },
   /**
    * Checks whether the IP address is valid, and that it does not have a port
@@ -302,7 +300,8 @@ var validations = {
    * @returns {void}
    */
   headersDraftVersion(version) {
-    if (typeof version !== "string" || !SUPPORTED_DRAFT_VERSIONS.includes(version)) {
+    if (typeof version !== "string" || // @ts-expect-error This is fine. If version is not in the array, it will just return false.
+    !SUPPORTED_DRAFT_VERSIONS.includes(version)) {
       const versionString = SUPPORTED_DRAFT_VERSIONS.join(", ");
       throw new ValidationError(
         "ERR_ERL_HEADERS_UNSUPPORTED_DRAFT_VERSION",
@@ -400,10 +399,8 @@ var getValidations = (_enabled) => {
             args
           );
         } catch (error) {
-          if (error instanceof ChangeWarning)
-            console.warn(error);
-          else
-            console.error(error);
+          if (error instanceof ChangeWarning) console.warn(error);
+          else console.error(error);
         }
       };
   }
@@ -438,13 +435,11 @@ var MemoryStore = class {
    */
   init(options) {
     this.windowMs = options.windowMs;
-    if (this.interval)
-      clearInterval(this.interval);
+    if (this.interval) clearInterval(this.interval);
     this.interval = setInterval(() => {
       this.clearExpired();
     }, this.windowMs);
-    if (this.interval.unref)
-      this.interval.unref();
+    if (this.interval.unref) this.interval.unref();
   }
   /**
    * Method to fetch a client's hit count and reset time.
@@ -485,8 +480,7 @@ var MemoryStore = class {
    */
   async decrement(key) {
     const client = this.getClient(key);
-    if (client.totalHits > 0)
-      client.totalHits--;
+    if (client.totalHits > 0) client.totalHits--;
   }
   /**
    * Method to reset a client's hit counter.
@@ -544,8 +538,7 @@ var MemoryStore = class {
    * @returns {Client} - The requested client.
    */
   getClient(key) {
-    if (this.current.has(key))
-      return this.current.get(key);
+    if (this.current.has(key)) return this.current.get(key);
     let client;
     if (this.previous.has(key)) {
       client = this.previous.get(key);
@@ -585,8 +578,7 @@ var promisifyStore = (passedStore) => {
         legacyStore.incr(
           key,
           (error, totalHits, resetTime) => {
-            if (error)
-              reject(error);
+            if (error) reject(error);
             resolve({ totalHits, resetTime });
           }
         );
@@ -633,8 +625,7 @@ var parseOptions = (passedOptions) => {
   );
   validations2.onLimitReached(notUndefinedOptions.onLimitReached);
   let standardHeaders = notUndefinedOptions.standardHeaders ?? false;
-  if (standardHeaders === true)
-    standardHeaders = "draft-6";
+  if (standardHeaders === true) standardHeaders = "draft-6";
   const config = {
     windowMs: 60 * 1e3,
     limit: passedOptions.max ?? 5,
@@ -650,14 +641,10 @@ var parseOptions = (passedOptions) => {
       const minutes = config.windowMs / (1e3 * 60);
       const hours = config.windowMs / (1e3 * 60 * 60);
       const days = config.windowMs / (1e3 * 60 * 60 * 24);
-      if (seconds < 60)
-        duration = `${seconds}sec`;
-      else if (minutes < 60)
-        duration = `${minutes}min`;
-      else if (hours < 24)
-        duration = `${hours}hr${hours > 1 ? "s" : ""}`;
-      else
-        duration = `${days}day${days > 1 ? "s" : ""}`;
+      if (seconds < 60) duration = `${seconds}sec`;
+      else if (minutes < 60) duration = `${minutes}min`;
+      else if (hours < 24) duration = `${hours}hr${hours > 1 ? "s" : ""}`;
+      else duration = `${days}day${days > 1 ? "s" : ""}`;
       return `${limit}-in-${duration}`;
     },
     requestPropertyName: "rateLimit",
@@ -682,12 +669,12 @@ var parseOptions = (passedOptions) => {
       }
     },
     passOnStoreError: false,
-    // Allow the default options to be overriden by the passed options.
+    // Allow the default options to be overridden by the passed options.
     ...notUndefinedOptions,
     // `standardHeaders` is resolved into a draft version above, use that.
     standardHeaders,
     // Note that this field is declared after the user's options are spread in,
-    // so that this field doesn't get overriden with an un-promisified store!
+    // so that this field doesn't get overridden with an un-promisified store!
     store: promisifyStore(notUndefinedOptions.store ?? new MemoryStore()),
     // Print an error to the console if a few known misconfigurations are detected.
     validations: validations2
@@ -711,8 +698,7 @@ var rateLimit = (passedOptions) => {
   const options = getOptionsFromConfig(config);
   config.validations.creationStack(config.store);
   config.validations.unsharedStore(config.store);
-  if (typeof config.store.init === "function")
-    config.store.init(options);
+  if (typeof config.store.init === "function") config.store.init(options);
   const middleware = handleAsyncErrors(
     async (request, response, next) => {
       const skip = await config.skip(request, response);
@@ -797,8 +783,7 @@ var rateLimit = (passedOptions) => {
               await decrementKey();
           });
           response.on("close", async () => {
-            if (!response.writableEnded)
-              await decrementKey();
+            if (!response.writableEnded) await decrementKey();
           });
           response.on("error", async () => {
             await decrementKey();

package/dist/index.d.cts

@@ -119,7 +119,11 @@ declare const validations: {
 	creationStack(store: Store): void;
 };
 export type Validations = typeof validations;
-declare const SUPPORTED_DRAFT_VERSIONS: string[];
+declare const SUPPORTED_DRAFT_VERSIONS: readonly [
+	"draft-6",
+	"draft-7",
+	"draft-8"
+];
 /**
  * Callback that fires when a client's hit counter is incremented.
  *

package/dist/index.d.mts

@@ -119,7 +119,11 @@ declare const validations: {
 	creationStack(store: Store): void;
 };
 export type Validations = typeof validations;
-declare const SUPPORTED_DRAFT_VERSIONS: string[];
+declare const SUPPORTED_DRAFT_VERSIONS: readonly [
+	"draft-6",
+	"draft-7",
+	"draft-8"
+];
 /**
  * Callback that fires when a client's hit counter is incremented.
  *

package/dist/index.d.ts

@@ -119,7 +119,11 @@ declare const validations: {
 	creationStack(store: Store): void;
 };
 export type Validations = typeof validations;
-declare const SUPPORTED_DRAFT_VERSIONS: string[];
+declare const SUPPORTED_DRAFT_VERSIONS: readonly [
+	"draft-6",
+	"draft-7",
+	"draft-8"
+];
 /**
  * Callback that fires when a client's hit counter is incremented.
  *

package/dist/index.mjs

@@ -1,7 +1,11 @@
 // source/headers.ts
-import { Buffer } from "buffer";
-import { createHash } from "crypto";
-var SUPPORTED_DRAFT_VERSIONS = ["draft-6", "draft-7", "draft-8"];
+import { Buffer } from "node:buffer";
+import { createHash } from "node:crypto";
+var SUPPORTED_DRAFT_VERSIONS = [
+  "draft-6",
+  "draft-7",
+  "draft-8"
+];
 var getResetSeconds = (resetTime, windowMs) => {
   let resetSeconds = void 0;
   if (resetTime) {
@@ -19,8 +23,7 @@ var getPartitionKey = (key) => {
   return Buffer.from(partitionKey).toString("base64");
 };
 var setLegacyHeaders = (response, info) => {
-  if (response.headersSent)
-    return;
+  if (response.headersSent) return;
   response.setHeader("X-RateLimit-Limit", info.limit.toString());
   response.setHeader("X-RateLimit-Remaining", info.remaining.toString());
   if (info.resetTime instanceof Date) {
@@ -32,8 +35,7 @@ var setLegacyHeaders = (response, info) => {
   }
 };
 var setDraft6Headers = (response, info, windowMs) => {
-  if (response.headersSent)
-    return;
+  if (response.headersSent) return;
   const windowSeconds = Math.ceil(windowMs / 1e3);
   const resetSeconds = getResetSeconds(info.resetTime);
   response.setHeader("RateLimit-Policy", `${info.limit};w=${windowSeconds}`);
@@ -43,8 +45,7 @@ var setDraft6Headers = (response, info, windowMs) => {
     response.setHeader("RateLimit-Reset", resetSeconds.toString());
 };
 var setDraft7Headers = (response, info, windowMs) => {
-  if (response.headersSent)
-    return;
+  if (response.headersSent) return;
   const windowSeconds = Math.ceil(windowMs / 1e3);
   const resetSeconds = getResetSeconds(info.resetTime, windowMs);
   response.setHeader("RateLimit-Policy", `${info.limit};w=${windowSeconds}`);
@@ -54,8 +55,7 @@ var setDraft7Headers = (response, info, windowMs) => {
   );
 };
 var setDraft8Headers = (response, info, windowMs, name, key) => {
-  if (response.headersSent)
-    return;
+  if (response.headersSent) return;
   const windowSeconds = Math.ceil(windowMs / 1e3);
   const resetSeconds = getResetSeconds(info.resetTime, windowMs);
   const partitionKey = getPartitionKey(key);
@@ -65,14 +65,13 @@ var setDraft8Headers = (response, info, windowMs, name, key) => {
   response.append("RateLimit", `"${name}"; ${header}`);
 };
 var setRetryAfterHeader = (response, info, windowMs) => {
-  if (response.headersSent)
-    return;
+  if (response.headersSent) return;
   const resetSeconds = getResetSeconds(info.resetTime, windowMs);
   response.setHeader("Retry-After", resetSeconds.toString());
 };
 
 // source/validations.ts
-import { isIP } from "net";
+import { isIP } from "node:net";
 var ValidationError = class extends Error {
   /**
    * The code must be a string, in snake case and all capital, that starts with
@@ -100,8 +99,7 @@ var validations = {
   },
   // Should be EnabledValidations type, but that's a circular reference
   disable() {
-    for (const k of Object.keys(this.enabled))
-      this.enabled[k] = false;
+    for (const k of Object.keys(this.enabled)) this.enabled[k] = false;
   },
   /**
    * Checks whether the IP address is valid, and that it does not have a port
@@ -274,7 +272,8 @@ var validations = {
    * @returns {void}
    */
   headersDraftVersion(version) {
-    if (typeof version !== "string" || !SUPPORTED_DRAFT_VERSIONS.includes(version)) {
+    if (typeof version !== "string" || // @ts-expect-error This is fine. If version is not in the array, it will just return false.
+    !SUPPORTED_DRAFT_VERSIONS.includes(version)) {
       const versionString = SUPPORTED_DRAFT_VERSIONS.join(", ");
       throw new ValidationError(
         "ERR_ERL_HEADERS_UNSUPPORTED_DRAFT_VERSION",
@@ -372,10 +371,8 @@ var getValidations = (_enabled) => {
             args
           );
         } catch (error) {
-          if (error instanceof ChangeWarning)
-            console.warn(error);
-          else
-            console.error(error);
+          if (error instanceof ChangeWarning) console.warn(error);
+          else console.error(error);
         }
       };
   }
@@ -410,13 +407,11 @@ var MemoryStore = class {
    */
   init(options) {
     this.windowMs = options.windowMs;
-    if (this.interval)
-      clearInterval(this.interval);
+    if (this.interval) clearInterval(this.interval);
     this.interval = setInterval(() => {
       this.clearExpired();
     }, this.windowMs);
-    if (this.interval.unref)
-      this.interval.unref();
+    if (this.interval.unref) this.interval.unref();
   }
   /**
    * Method to fetch a client's hit count and reset time.
@@ -457,8 +452,7 @@ var MemoryStore = class {
    */
   async decrement(key) {
     const client = this.getClient(key);
-    if (client.totalHits > 0)
-      client.totalHits--;
+    if (client.totalHits > 0) client.totalHits--;
   }
   /**
    * Method to reset a client's hit counter.
@@ -516,8 +510,7 @@ var MemoryStore = class {
    * @returns {Client} - The requested client.
    */
   getClient(key) {
-    if (this.current.has(key))
-      return this.current.get(key);
+    if (this.current.has(key)) return this.current.get(key);
     let client;
     if (this.previous.has(key)) {
       client = this.previous.get(key);
@@ -557,8 +550,7 @@ var promisifyStore = (passedStore) => {
         legacyStore.incr(
           key,
           (error, totalHits, resetTime) => {
-            if (error)
-              reject(error);
+            if (error) reject(error);
             resolve({ totalHits, resetTime });
           }
         );
@@ -605,8 +597,7 @@ var parseOptions = (passedOptions) => {
   );
   validations2.onLimitReached(notUndefinedOptions.onLimitReached);
   let standardHeaders = notUndefinedOptions.standardHeaders ?? false;
-  if (standardHeaders === true)
-    standardHeaders = "draft-6";
+  if (standardHeaders === true) standardHeaders = "draft-6";
   const config = {
     windowMs: 60 * 1e3,
     limit: passedOptions.max ?? 5,
@@ -622,14 +613,10 @@ var parseOptions = (passedOptions) => {
       const minutes = config.windowMs / (1e3 * 60);
       const hours = config.windowMs / (1e3 * 60 * 60);
       const days = config.windowMs / (1e3 * 60 * 60 * 24);
-      if (seconds < 60)
-        duration = `${seconds}sec`;
-      else if (minutes < 60)
-        duration = `${minutes}min`;
-      else if (hours < 24)
-        duration = `${hours}hr${hours > 1 ? "s" : ""}`;
-      else
-        duration = `${days}day${days > 1 ? "s" : ""}`;
+      if (seconds < 60) duration = `${seconds}sec`;
+      else if (minutes < 60) duration = `${minutes}min`;
+      else if (hours < 24) duration = `${hours}hr${hours > 1 ? "s" : ""}`;
+      else duration = `${days}day${days > 1 ? "s" : ""}`;
       return `${limit}-in-${duration}`;
     },
     requestPropertyName: "rateLimit",
@@ -654,12 +641,12 @@ var parseOptions = (passedOptions) => {
       }
     },
     passOnStoreError: false,
-    // Allow the default options to be overriden by the passed options.
+    // Allow the default options to be overridden by the passed options.
     ...notUndefinedOptions,
     // `standardHeaders` is resolved into a draft version above, use that.
     standardHeaders,
     // Note that this field is declared after the user's options are spread in,
-    // so that this field doesn't get overriden with an un-promisified store!
+    // so that this field doesn't get overridden with an un-promisified store!
     store: promisifyStore(notUndefinedOptions.store ?? new MemoryStore()),
     // Print an error to the console if a few known misconfigurations are detected.
     validations: validations2
@@ -683,8 +670,7 @@ var rateLimit = (passedOptions) => {
   const options = getOptionsFromConfig(config);
   config.validations.creationStack(config.store);
   config.validations.unsharedStore(config.store);
-  if (typeof config.store.init === "function")
-    config.store.init(options);
+  if (typeof config.store.init === "function") config.store.init(options);
   const middleware = handleAsyncErrors(
     async (request, response, next) => {
       const skip = await config.skip(request, response);
@@ -769,8 +755,7 @@ var rateLimit = (passedOptions) => {
               await decrementKey();
           });
           response.on("close", async () => {
-            if (!response.writableEnded)
-              await decrementKey();
+            if (!response.writableEnded) await decrementKey();
           });
           response.on("error", async () => {
             await decrementKey();

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "express-rate-limit",
-	"version": "7.5.0",
+	"version": "7.5.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",
@@ -74,7 +74,7 @@
 		"prepare": "run-s compile && husky install config/husky"
 	},
 	"peerDependencies": {
-		"express": "^4.11 || 5 || ^5.0.0-beta.1"
+		"express": ">= 4.11"
 	},
 	"devDependencies": {
 		"@express-rate-limit/prettier": "1.1.1",
@@ -86,7 +86,7 @@
 		"@types/supertest": "2.0.15",
 		"del-cli": "5.1.0",
 		"dts-bundle-generator": "8.0.1",
-		"esbuild": "0.19.5",
+		"esbuild": "0.25.0",
 		"express": "4.21.1",
 		"husky": "8.0.3",
 		"jest": "29.7.0",