express-rate-limit 7.5.1 → 8.0.0

package/dist/index.d.cts

@@ -1,7 +1,28 @@
-// Generated by dts-bundle-generator v8.0.1
+// Generated by dts-bundle-generator v9.5.1
 
-import { NextFunction, Request, RequestHandler, Response } from 'express';
+import { NextFunction, Request as Request$1, RequestHandler, Response as Response$1 } from 'express';
 
+/**
+ * Returns the IP address itself for IPv4, or a CIDR-notation subnet for IPv6.
+ *
+ * If you write a custom keyGenerator that allows a fallback to IP address for
+ * unauthenticated users, return ipKeyGenerator(req.ip) rather than just req.ip.
+ *
+ * For more infomration, {@see Options.ipv6Subnet}.
+ *
+ * @param ip {string} - The IP address to process, usually request.ip.
+ * @param ipv6Subnet {number | false} - The subnet mask for IPv6 addresses.
+ *
+ * @returns {string} - The key generated from the IP address
+ *
+ * @public
+ */
+export declare function ipKeyGenerator(ip: string, ipv6Subnet?: number | false): string;
+declare const SUPPORTED_DRAFT_VERSIONS: readonly [
+	"draft-6",
+	"draft-7",
+	"draft-8"
+];
 declare const validations: {
 	enabled: {
 		[key: string]: boolean;
@@ -117,13 +138,11 @@ declare const validations: {
 	 * store (or any other store with localKeys.)
 	 */
 	creationStack(store: Store): void;
+	ipv6Subnet(ipv6Subnet?: any): void;
+	ipv6SubnetOrKeyGenerator(options: Partial<Options>): void;
+	keyGeneratorIpFallback(keyGenerator?: ValueDeterminingMiddleware<string>): void;
 };
 export type Validations = typeof validations;
-declare const SUPPORTED_DRAFT_VERSIONS: readonly [
-	"draft-6",
-	"draft-7",
-	"draft-8"
-];
 /**
  * Callback that fires when a client's hit counter is incremented.
  *
@@ -280,7 +299,8 @@ export type Store = {
 	/**
 	 * Optional value that the store prepends to keys
 	 *
-	 * Used by the double-count check to avoid false-positives when a key is counted twice, but with different prefixes
+	 * Used by the double-count check to avoid false-positives when a key is counted
+	 * twice, but with different prefixes.
 	 */
 	prefix?: string;
 };
@@ -372,6 +392,21 @@ export type Options = {
 	 * By default, the client's IP address is used.
 	 */
 	keyGenerator: ValueDeterminingMiddleware<string>;
+	/**
+	 * IPv6 subnet mask applied to IPv6 addresses in the default keyGenerator.
+	 *
+	 * Default is 56. The valid range is technically 1-128 but the value should
+	 * generally be in the 32-64 range.
+	 *
+	 * Smaller numbers are more aggressive, larger numbers are more lenient. Try
+	 * bumping to 60 or 64 if you see evidence of users being blocked incorrectly.
+	 *
+	 * May also be set to a function that returns a number based on the request.
+	 *
+	 * See the documentation for more info:
+	 * https://express-rate-limit.mintlify.app/reference/configuration#ipv6subnet.
+	 */
+	ipv6Subnet: 64 | 60 | 56 | 52 | 50 | 48 | 32 | number | ValueDeterminingMiddleware<number> | false;
 	/**
 	 * Express request handler that sends back a response when a client is
 	 * rate-limited.
@@ -387,7 +422,7 @@ export type Options = {
 	 */
 	skip: ValueDeterminingMiddleware<boolean>;
 	/**
-	 * Method to determine whether or not the request counts as 'succesful'. Used
+	 * Method to determine whether or not the request counts as 'successful'. Used
 	 * when either `skipSuccessfulRequests` or `skipFailedRequests` is set to true.
 	 *
 	 * By default, requests with a response status code less than 400 are considered
@@ -443,18 +478,8 @@ export type RateLimitInfo = {
 	used: number;
 	remaining: number;
 	resetTime: Date | undefined;
+	key: string;
 };
-/**
- *
- * Create an instance of IP rate-limiting middleware for Express.
- *
- * @param passedOptions {Options} - Options to configure the rate limiter.
- *
- * @returns {RateLimitRequestHandler} - The middleware that rate-limits clients based on your configuration.
- *
- * @public
- */
-export declare const rateLimit: (passedOptions?: Partial<Options>) => RateLimitRequestHandler;
 /**
  * The record that stores information about a client - namely, how many times
  * they have hit the endpoint, and when their hit count resets.
@@ -580,6 +605,17 @@ export declare class MemoryStore implements Store {
 	 */
 	private clearExpired;
 }
+/**
+ *
+ * Create an instance of IP rate-limiting middleware for Express.
+ *
+ * @param passedOptions {Options} - Options to configure the rate limiter.
+ *
+ * @returns {RateLimitRequestHandler} - The middleware that rate-limits clients based on your configuration.
+ *
+ * @public
+ */
+export declare const rateLimit: (passedOptions?: Partial<Options>) => RateLimitRequestHandler;
 
 export {
 	rateLimit as default,

package/dist/index.d.mts

@@ -1,7 +1,28 @@
-// Generated by dts-bundle-generator v8.0.1
+// Generated by dts-bundle-generator v9.5.1
 
-import { NextFunction, Request, RequestHandler, Response } from 'express';
+import { NextFunction, Request as Request$1, RequestHandler, Response as Response$1 } from 'express';
 
+/**
+ * Returns the IP address itself for IPv4, or a CIDR-notation subnet for IPv6.
+ *
+ * If you write a custom keyGenerator that allows a fallback to IP address for
+ * unauthenticated users, return ipKeyGenerator(req.ip) rather than just req.ip.
+ *
+ * For more infomration, {@see Options.ipv6Subnet}.
+ *
+ * @param ip {string} - The IP address to process, usually request.ip.
+ * @param ipv6Subnet {number | false} - The subnet mask for IPv6 addresses.
+ *
+ * @returns {string} - The key generated from the IP address
+ *
+ * @public
+ */
+export declare function ipKeyGenerator(ip: string, ipv6Subnet?: number | false): string;
+declare const SUPPORTED_DRAFT_VERSIONS: readonly [
+	"draft-6",
+	"draft-7",
+	"draft-8"
+];
 declare const validations: {
 	enabled: {
 		[key: string]: boolean;
@@ -117,13 +138,11 @@ declare const validations: {
 	 * store (or any other store with localKeys.)
 	 */
 	creationStack(store: Store): void;
+	ipv6Subnet(ipv6Subnet?: any): void;
+	ipv6SubnetOrKeyGenerator(options: Partial<Options>): void;
+	keyGeneratorIpFallback(keyGenerator?: ValueDeterminingMiddleware<string>): void;
 };
 export type Validations = typeof validations;
-declare const SUPPORTED_DRAFT_VERSIONS: readonly [
-	"draft-6",
-	"draft-7",
-	"draft-8"
-];
 /**
  * Callback that fires when a client's hit counter is incremented.
  *
@@ -280,7 +299,8 @@ export type Store = {
 	/**
 	 * Optional value that the store prepends to keys
 	 *
-	 * Used by the double-count check to avoid false-positives when a key is counted twice, but with different prefixes
+	 * Used by the double-count check to avoid false-positives when a key is counted
+	 * twice, but with different prefixes.
 	 */
 	prefix?: string;
 };
@@ -372,6 +392,21 @@ export type Options = {
 	 * By default, the client's IP address is used.
 	 */
 	keyGenerator: ValueDeterminingMiddleware<string>;
+	/**
+	 * IPv6 subnet mask applied to IPv6 addresses in the default keyGenerator.
+	 *
+	 * Default is 56. The valid range is technically 1-128 but the value should
+	 * generally be in the 32-64 range.
+	 *
+	 * Smaller numbers are more aggressive, larger numbers are more lenient. Try
+	 * bumping to 60 or 64 if you see evidence of users being blocked incorrectly.
+	 *
+	 * May also be set to a function that returns a number based on the request.
+	 *
+	 * See the documentation for more info:
+	 * https://express-rate-limit.mintlify.app/reference/configuration#ipv6subnet.
+	 */
+	ipv6Subnet: 64 | 60 | 56 | 52 | 50 | 48 | 32 | number | ValueDeterminingMiddleware<number> | false;
 	/**
 	 * Express request handler that sends back a response when a client is
 	 * rate-limited.
@@ -387,7 +422,7 @@ export type Options = {
 	 */
 	skip: ValueDeterminingMiddleware<boolean>;
 	/**
-	 * Method to determine whether or not the request counts as 'succesful'. Used
+	 * Method to determine whether or not the request counts as 'successful'. Used
 	 * when either `skipSuccessfulRequests` or `skipFailedRequests` is set to true.
 	 *
 	 * By default, requests with a response status code less than 400 are considered
@@ -443,18 +478,8 @@ export type RateLimitInfo = {
 	used: number;
 	remaining: number;
 	resetTime: Date | undefined;
+	key: string;
 };
-/**
- *
- * Create an instance of IP rate-limiting middleware for Express.
- *
- * @param passedOptions {Options} - Options to configure the rate limiter.
- *
- * @returns {RateLimitRequestHandler} - The middleware that rate-limits clients based on your configuration.
- *
- * @public
- */
-export declare const rateLimit: (passedOptions?: Partial<Options>) => RateLimitRequestHandler;
 /**
  * The record that stores information about a client - namely, how many times
  * they have hit the endpoint, and when their hit count resets.
@@ -580,6 +605,17 @@ export declare class MemoryStore implements Store {
 	 */
 	private clearExpired;
 }
+/**
+ *
+ * Create an instance of IP rate-limiting middleware for Express.
+ *
+ * @param passedOptions {Options} - Options to configure the rate limiter.
+ *
+ * @returns {RateLimitRequestHandler} - The middleware that rate-limits clients based on your configuration.
+ *
+ * @public
+ */
+export declare const rateLimit: (passedOptions?: Partial<Options>) => RateLimitRequestHandler;
 
 export {
 	rateLimit as default,

package/dist/index.d.ts

@@ -1,7 +1,28 @@
-// Generated by dts-bundle-generator v8.0.1
+// Generated by dts-bundle-generator v9.5.1
 
-import { NextFunction, Request, RequestHandler, Response } from 'express';
+import { NextFunction, Request as Request$1, RequestHandler, Response as Response$1 } from 'express';
 
+/**
+ * Returns the IP address itself for IPv4, or a CIDR-notation subnet for IPv6.
+ *
+ * If you write a custom keyGenerator that allows a fallback to IP address for
+ * unauthenticated users, return ipKeyGenerator(req.ip) rather than just req.ip.
+ *
+ * For more infomration, {@see Options.ipv6Subnet}.
+ *
+ * @param ip {string} - The IP address to process, usually request.ip.
+ * @param ipv6Subnet {number | false} - The subnet mask for IPv6 addresses.
+ *
+ * @returns {string} - The key generated from the IP address
+ *
+ * @public
+ */
+export declare function ipKeyGenerator(ip: string, ipv6Subnet?: number | false): string;
+declare const SUPPORTED_DRAFT_VERSIONS: readonly [
+	"draft-6",
+	"draft-7",
+	"draft-8"
+];
 declare const validations: {
 	enabled: {
 		[key: string]: boolean;
@@ -117,13 +138,11 @@ declare const validations: {
 	 * store (or any other store with localKeys.)
 	 */
 	creationStack(store: Store): void;
+	ipv6Subnet(ipv6Subnet?: any): void;
+	ipv6SubnetOrKeyGenerator(options: Partial<Options>): void;
+	keyGeneratorIpFallback(keyGenerator?: ValueDeterminingMiddleware<string>): void;
 };
 export type Validations = typeof validations;
-declare const SUPPORTED_DRAFT_VERSIONS: readonly [
-	"draft-6",
-	"draft-7",
-	"draft-8"
-];
 /**
  * Callback that fires when a client's hit counter is incremented.
  *
@@ -280,7 +299,8 @@ export type Store = {
 	/**
 	 * Optional value that the store prepends to keys
 	 *
-	 * Used by the double-count check to avoid false-positives when a key is counted twice, but with different prefixes
+	 * Used by the double-count check to avoid false-positives when a key is counted
+	 * twice, but with different prefixes.
 	 */
 	prefix?: string;
 };
@@ -372,6 +392,21 @@ export type Options = {
 	 * By default, the client's IP address is used.
 	 */
 	keyGenerator: ValueDeterminingMiddleware<string>;
+	/**
+	 * IPv6 subnet mask applied to IPv6 addresses in the default keyGenerator.
+	 *
+	 * Default is 56. The valid range is technically 1-128 but the value should
+	 * generally be in the 32-64 range.
+	 *
+	 * Smaller numbers are more aggressive, larger numbers are more lenient. Try
+	 * bumping to 60 or 64 if you see evidence of users being blocked incorrectly.
+	 *
+	 * May also be set to a function that returns a number based on the request.
+	 *
+	 * See the documentation for more info:
+	 * https://express-rate-limit.mintlify.app/reference/configuration#ipv6subnet.
+	 */
+	ipv6Subnet: 64 | 60 | 56 | 52 | 50 | 48 | 32 | number | ValueDeterminingMiddleware<number> | false;
 	/**
 	 * Express request handler that sends back a response when a client is
 	 * rate-limited.
@@ -387,7 +422,7 @@ export type Options = {
 	 */
 	skip: ValueDeterminingMiddleware<boolean>;
 	/**
-	 * Method to determine whether or not the request counts as 'succesful'. Used
+	 * Method to determine whether or not the request counts as 'successful'. Used
 	 * when either `skipSuccessfulRequests` or `skipFailedRequests` is set to true.
 	 *
 	 * By default, requests with a response status code less than 400 are considered
@@ -443,18 +478,8 @@ export type RateLimitInfo = {
 	used: number;
 	remaining: number;
 	resetTime: Date | undefined;
+	key: string;
 };
-/**
- *
- * Create an instance of IP rate-limiting middleware for Express.
- *
- * @param passedOptions {Options} - Options to configure the rate limiter.
- *
- * @returns {RateLimitRequestHandler} - The middleware that rate-limits clients based on your configuration.
- *
- * @public
- */
-export declare const rateLimit: (passedOptions?: Partial<Options>) => RateLimitRequestHandler;
 /**
  * The record that stores information about a client - namely, how many times
  * they have hit the endpoint, and when their hit count resets.
@@ -580,6 +605,17 @@ export declare class MemoryStore implements Store {
 	 */
 	private clearExpired;
 }
+/**
+ *
+ * Create an instance of IP rate-limiting middleware for Express.
+ *
+ * @param passedOptions {Options} - Options to configure the rate limiter.
+ *
+ * @returns {RateLimitRequestHandler} - The middleware that rate-limits clients based on your configuration.
+ *
+ * @public
+ */
+export declare const rateLimit: (passedOptions?: Partial<Options>) => RateLimitRequestHandler;
 
 export {
 	rateLimit as default,