express-rate-limit 8.3.2 → 8.4.1

package/dist/index.cjs

@@ -201,6 +201,16 @@ var MemoryStore = class {
 // source/rate-limit.ts
 var import_node_net3 = require("node:net");
 
+// source/console-logger.ts
+var ConsoleLogger = {
+  warn(...args) {
+    console.warn(...args.reverse());
+  },
+  error(...args) {
+    console.error(...args.reverse());
+  }
+};
+
 // source/headers.ts
 var import_node_buffer = require("node:buffer");
 var import_node_crypto = require("node:crypto");
@@ -548,7 +558,8 @@ var validations = {
       validate: true,
       headers: true,
       max: true,
-      passOnStoreError: true
+      passOnStoreError: true,
+      logger: true
     };
     const validOptions = Object.keys(optionsMap).concat(
       "draft_polli_ratelimit_headers",
@@ -661,7 +672,15 @@ var validations = {
     }
   }
 };
-var getValidations = (_enabled) => {
+function validateLogger(logger) {
+  if (typeof logger !== "object" || typeof logger.error !== "function" || typeof logger.warn !== "function") {
+    throw new TypeError(
+      "Provided logger does not implement the Logger interface"
+    );
+  }
+}
+var getValidations = (_enabled, logger) => {
+  validateLogger(logger);
   let enabled;
   if (typeof _enabled === "boolean") {
     enabled = {
@@ -687,8 +706,8 @@ var getValidations = (_enabled) => {
             args
           );
         } catch (error) {
-          if (error instanceof ChangeWarning) console.warn(error);
-          else console.error(error);
+          if (error instanceof ChangeWarning) logger.warn(error);
+          else logger.error(error);
         }
       };
   }
@@ -741,7 +760,11 @@ var getOptionsFromConfig = (config) => {
 };
 var parseOptions = (passedOptions) => {
   const notUndefinedOptions = omitUndefinedProperties(passedOptions);
-  const validations2 = getValidations(notUndefinedOptions?.validate ?? true);
+  const logger = passedOptions.logger ?? ConsoleLogger;
+  const validations2 = getValidations(
+    notUndefinedOptions?.validate ?? true,
+    logger
+  );
   validations2.validationsConfig();
   validations2.knownOptions(passedOptions);
   validations2.draftPolliHeaders(
@@ -816,7 +839,8 @@ var parseOptions = (passedOptions) => {
       notUndefinedOptions.store ?? new MemoryStore(validations2)
     ),
     // Print an error to the console if a few known misconfigurations are detected.
-    validations: validations2
+    validations: validations2,
+    logger
   };
   if (typeof config.store.increment !== "function" || typeof config.store.decrement !== "function" || typeof config.store.resetKey !== "function" || config.store.resetAll !== void 0 && typeof config.store.resetAll !== "function" || config.store.init !== void 0 && typeof config.store.init !== "function") {
     throw new TypeError(
@@ -858,9 +882,9 @@ var rateLimit = (passedOptions) => {
         resetTime = incrementResult.resetTime;
       } catch (error) {
         if (config.passOnStoreError) {
-          console.error(
-            "express-rate-limit: error from store, allowing request without rate-limiting.",
-            error
+          config.logger.error(
+            error,
+            "express-rate-limit: error from store, allowing request without rate-limiting."
           );
           next();
           return;

package/dist/index.d.cts

@@ -159,6 +159,26 @@ declare const validations: {
 	windowMs(windowMs: number): void;
 };
 export type Validations = typeof validations;
+/**
+ * Basic logging function
+ *
+ * @param error {unknown} - The error to log
+ * @param message {string | undefined} - Additional details about the error
+ */
+export type LoggerFn = (error: unknown, message?: string) => void;
+/**
+ * Minimal interface for logging warnings and errors
+ */
+export type Logger = {
+	/**
+	 * Function to log an error
+	 */
+	error: LoggerFn;
+	/**
+	 * Function to log a warning
+	 */
+	warn: LoggerFn;
+};
 /**
  * Callback that fires when a client's hit counter is incremented.
  *
@@ -477,6 +497,10 @@ export type Options = {
 	 * If the Store generates an error, allow the request to pass.
 	 */
 	passOnStoreError: boolean;
+	/**
+	 * The logger to use to log errors. If absent, logs to the console.
+	 */
+	logger: Logger;
 };
 /**
  * The extended request object that includes information about the client's

package/dist/index.d.mts

@@ -159,6 +159,26 @@ declare const validations: {
 	windowMs(windowMs: number): void;
 };
 export type Validations = typeof validations;
+/**
+ * Basic logging function
+ *
+ * @param error {unknown} - The error to log
+ * @param message {string | undefined} - Additional details about the error
+ */
+export type LoggerFn = (error: unknown, message?: string) => void;
+/**
+ * Minimal interface for logging warnings and errors
+ */
+export type Logger = {
+	/**
+	 * Function to log an error
+	 */
+	error: LoggerFn;
+	/**
+	 * Function to log a warning
+	 */
+	warn: LoggerFn;
+};
 /**
  * Callback that fires when a client's hit counter is incremented.
  *
@@ -477,6 +497,10 @@ export type Options = {
 	 * If the Store generates an error, allow the request to pass.
 	 */
 	passOnStoreError: boolean;
+	/**
+	 * The logger to use to log errors. If absent, logs to the console.
+	 */
+	logger: Logger;
 };
 /**
  * The extended request object that includes information about the client's

package/dist/index.d.ts

@@ -159,6 +159,26 @@ declare const validations: {
 	windowMs(windowMs: number): void;
 };
 export type Validations = typeof validations;
+/**
+ * Basic logging function
+ *
+ * @param error {unknown} - The error to log
+ * @param message {string | undefined} - Additional details about the error
+ */
+export type LoggerFn = (error: unknown, message?: string) => void;
+/**
+ * Minimal interface for logging warnings and errors
+ */
+export type Logger = {
+	/**
+	 * Function to log an error
+	 */
+	error: LoggerFn;
+	/**
+	 * Function to log a warning
+	 */
+	warn: LoggerFn;
+};
 /**
  * Callback that fires when a client's hit counter is incremented.
  *
@@ -477,6 +497,10 @@ export type Options = {
 	 * If the Store generates an error, allow the request to pass.
 	 */
 	passOnStoreError: boolean;
+	/**
+	 * The logger to use to log errors. If absent, logs to the console.
+	 */
+	logger: Logger;
 };
 /**
  * The extended request object that includes information about the client's

package/dist/index.mjs

@@ -172,6 +172,16 @@ var MemoryStore = class {
 // source/rate-limit.ts
 import { isIPv6 as isIPv62 } from "node:net";
 
+// source/console-logger.ts
+var ConsoleLogger = {
+  warn(...args) {
+    console.warn(...args.reverse());
+  },
+  error(...args) {
+    console.error(...args.reverse());
+  }
+};
+
 // source/headers.ts
 import { Buffer } from "node:buffer";
 import { createHash } from "node:crypto";
@@ -519,7 +529,8 @@ var validations = {
       validate: true,
       headers: true,
       max: true,
-      passOnStoreError: true
+      passOnStoreError: true,
+      logger: true
     };
     const validOptions = Object.keys(optionsMap).concat(
       "draft_polli_ratelimit_headers",
@@ -632,7 +643,15 @@ var validations = {
     }
   }
 };
-var getValidations = (_enabled) => {
+function validateLogger(logger) {
+  if (typeof logger !== "object" || typeof logger.error !== "function" || typeof logger.warn !== "function") {
+    throw new TypeError(
+      "Provided logger does not implement the Logger interface"
+    );
+  }
+}
+var getValidations = (_enabled, logger) => {
+  validateLogger(logger);
   let enabled;
   if (typeof _enabled === "boolean") {
     enabled = {
@@ -658,8 +677,8 @@ var getValidations = (_enabled) => {
             args
           );
         } catch (error) {
-          if (error instanceof ChangeWarning) console.warn(error);
-          else console.error(error);
+          if (error instanceof ChangeWarning) logger.warn(error);
+          else logger.error(error);
         }
       };
   }
@@ -712,7 +731,11 @@ var getOptionsFromConfig = (config) => {
 };
 var parseOptions = (passedOptions) => {
   const notUndefinedOptions = omitUndefinedProperties(passedOptions);
-  const validations2 = getValidations(notUndefinedOptions?.validate ?? true);
+  const logger = passedOptions.logger ?? ConsoleLogger;
+  const validations2 = getValidations(
+    notUndefinedOptions?.validate ?? true,
+    logger
+  );
   validations2.validationsConfig();
   validations2.knownOptions(passedOptions);
   validations2.draftPolliHeaders(
@@ -787,7 +810,8 @@ var parseOptions = (passedOptions) => {
       notUndefinedOptions.store ?? new MemoryStore(validations2)
     ),
     // Print an error to the console if a few known misconfigurations are detected.
-    validations: validations2
+    validations: validations2,
+    logger
   };
   if (typeof config.store.increment !== "function" || typeof config.store.decrement !== "function" || typeof config.store.resetKey !== "function" || config.store.resetAll !== void 0 && typeof config.store.resetAll !== "function" || config.store.init !== void 0 && typeof config.store.init !== "function") {
     throw new TypeError(
@@ -829,9 +853,9 @@ var rateLimit = (passedOptions) => {
         resetTime = incrementResult.resetTime;
       } catch (error) {
         if (config.passOnStoreError) {
-          console.error(
-            "express-rate-limit: error from store, allowing request without rate-limiting.",
-            error
+          config.logger.error(
+            error,
+            "express-rate-limit: error from store, allowing request without rate-limiting."
           );
           next();
           return;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "express-rate-limit",
-	"version": "8.3.2",
+	"version": "8.4.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",

package/readme.md

@@ -66,6 +66,7 @@ default values.
 | [`skipFailedRequests`]     | `boolean`                                 | Uncount 4xx/5xx responses.                                                                      |
 | [`requestWasSuccessful`]   | `function`                                | Used by `skipSuccessfulRequests` and `skipFailedRequests`.                                      |
 | [`validate`]               | `boolean` \| `object`                     | Enable or disable built-in validation checks.                                                   |
+| [`logger`]                 | `Logger`                                  | Custom logger                                                                                   |
 
 ## Thank You
 
@@ -134,3 +135,5 @@ MIT © [Nathan Friedly](http://nfriedly.com/),
 	https://express-rate-limit.mintlify.app/reference/configuration#requestwassuccessful
 [`validate`]:
 	https://express-rate-limit.mintlify.app/reference/configuration#validate
+[`logger`]:
+	https://express-rate-limit.mintlify.app/reference/configuration#logger