express-rate-limit 5.4.1 → 6.0.1

package/dist/cjs/memory-store.js

@@ -0,0 +1,167 @@
+"use strict";
+// /source/memory-store.ts
+// A memory store for hit counts
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+exports.__esModule = true;
+/**
+ * Calculates the time when all hit counters will be reset.
+ *
+ * @param windowMs {number} - The duration of a window (in milliseconds)
+ *
+ * @returns {Date}
+ *
+ * @private
+ */
+var calculateNextResetTime = function (windowMs) {
+    var resetTime = new Date();
+    resetTime.setMilliseconds(resetTime.getMilliseconds() + windowMs);
+    return resetTime;
+};
+/**
+ * A {@link Store} that stores the hit count for each client in
+ * memory.
+ *
+ * @public
+ */
+var MemoryStore = /** @class */ (function () {
+    function MemoryStore() {
+    }
+    /**
+     * Method that initializes the store.
+     *
+     * @param options {Options} - The options used to setup the middleware
+     */
+    MemoryStore.prototype.init = function (options) {
+        var _this = this;
+        // Get the duration of a window from the options
+        this.windowMs = options.windowMs;
+        // Then calculate the reset time using that
+        this.resetTime = calculateNextResetTime(this.windowMs);
+        // Initialise the hit counter map
+        this.hits = {};
+        // Reset hit counts for ALL clients every `windowMs` - this will also
+        // re-calculate the `resetTime`
+        var interval = setInterval(function () { return __awaiter(_this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.resetAll()];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        }); }, this.windowMs);
+        if (interval.unref) {
+            interval.unref();
+        }
+    };
+    /**
+     * Method to increment a client's hit counter.
+     *
+     * @param key {string} - The identifier for a client
+     *
+     * @returns {IncrementResponse} - The number of hits and reset time for that client
+     *
+     * @public
+     */
+    MemoryStore.prototype.increment = function (key) {
+        var _a;
+        return __awaiter(this, void 0, void 0, function () {
+            var totalHits;
+            return __generator(this, function (_b) {
+                totalHits = ((_a = this.hits[key]) !== null && _a !== void 0 ? _a : 0) + 1;
+                this.hits[key] = totalHits;
+                return [2 /*return*/, {
+                        totalHits: totalHits,
+                        resetTime: this.resetTime
+                    }];
+            });
+        });
+    };
+    /**
+     * Method to decrement a client's hit counter.
+     *
+     * @param key {string} - The identifier for a client
+     *
+     * @public
+     */
+    MemoryStore.prototype.decrement = function (key) {
+        return __awaiter(this, void 0, void 0, function () {
+            var current;
+            return __generator(this, function (_a) {
+                current = this.hits[key];
+                if (current) {
+                    this.hits[key] = current - 1;
+                }
+                return [2 /*return*/];
+            });
+        });
+    };
+    /**
+     * Method to reset a client's hit counter.
+     *
+     * @param key {string} - The identifier for a client
+     *
+     * @public
+     */
+    MemoryStore.prototype.resetKey = function (key) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                delete this.hits[key];
+                return [2 /*return*/];
+            });
+        });
+    };
+    /**
+     * Method to reset everyone's hit counter.
+     *
+     * @public
+     */
+    MemoryStore.prototype.resetAll = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                this.hits = {};
+                this.resetTime = calculateNextResetTime(this.windowMs);
+                return [2 /*return*/];
+            });
+        });
+    };
+    return MemoryStore;
+}());
+exports["default"] = MemoryStore;
+//# sourceMappingURL=memory-store.js.map

package/dist/cjs/memory-store.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"memory-store.js","sourceRoot":"","sources":["../../source/memory-store.ts"],"names":[],"mappings":";AAAA,0BAA0B;AAC1B,gCAAgC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAIhC;;;;;;;;GAQG;AACH,IAAM,sBAAsB,GAAG,UAAC,QAAgB;IAC/C,IAAM,SAAS,GAAG,IAAI,IAAI,EAAE,CAAA;IAC5B,SAAS,CAAC,eAAe,CAAC,SAAS,CAAC,eAAe,EAAE,GAAG,QAAQ,CAAC,CAAA;IACjE,OAAO,SAAS,CAAA;AACjB,CAAC,CAAA;AAED;;;;;GAKG;AACH;IAAA;IA+FA,CAAC;IA7EA;;;;OAIG;IACH,0BAAI,GAAJ,UAAK,OAAgB;QAArB,iBAiBC;QAhBA,gDAAgD;QAChD,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,CAAA;QAChC,2CAA2C;QAC3C,IAAI,CAAC,SAAS,GAAG,sBAAsB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAEtD,iCAAiC;QACjC,IAAI,CAAC,IAAI,GAAG,EAAE,CAAA;QAEd,qEAAqE;QACrE,+BAA+B;QAC/B,IAAM,QAAQ,GAAG,WAAW,CAAC;;;4BAC5B,qBAAM,IAAI,CAAC,QAAQ,EAAE,EAAA;;wBAArB,SAAqB,CAAA;;;;aACrB,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAA;QACjB,IAAI,QAAQ,CAAC,KAAK,EAAE;YACnB,QAAQ,CAAC,KAAK,EAAE,CAAA;SAChB;IACF,CAAC;IAED;;;;;;;;OAQG;IACG,+BAAS,GAAf,UAAgB,GAAW;;;;;gBACpB,SAAS,GAAG,CAAC,MAAA,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,mCAAI,CAAC,CAAC,GAAG,CAAC,CAAA;gBAC3C,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,SAAS,CAAA;gBAE1B,sBAAO;wBACN,SAAS,WAAA;wBACT,SAAS,EAAE,IAAI,CAAC,SAAS;qBACzB,EAAA;;;KACD;IAED;;;;;;OAMG;IACG,+BAAS,GAAf,UAAgB,GAAW;;;;gBACpB,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;gBAC9B,IAAI,OAAO,EAAE;oBACZ,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,OAAO,GAAG,CAAC,CAAA;iBAC5B;;;;KACD;IAED;;;;;;OAMG;IACG,8BAAQ,GAAd,UAAe,GAAW;;;gBACzB,OAAO,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;;;;KACrB;IAED;;;;OAIG;IACG,8BAAQ,GAAd;;;gBACC,IAAI,CAAC,IAAI,GAAG,EAAE,CAAA;gBACd,IAAI,CAAC,SAAS,GAAG,sBAAsB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;;;;KACtD;IACF,kBAAC;AAAD,CAAC,AA/FD,IA+FC","sourcesContent":["// /source/memory-store.ts\n// A memory store for hit counts\n\nimport { Store, Options, IncrementResponse } from './types.js'\n\n/**\n * Calculates the time when all hit counters will be reset.\n *\n * @param windowMs {number} - The duration of a window (in milliseconds)\n *\n * @returns {Date}\n *\n * @private\n */\nconst calculateNextResetTime = (windowMs: number): Date => {\n\tconst resetTime = new Date()\n\tresetTime.setMilliseconds(resetTime.getMilliseconds() + windowMs)\n\treturn resetTime\n}\n\n/**\n * A {@link Store} that stores the hit count for each client in\n * memory.\n *\n * @public\n */\nexport default class MemoryStore implements Store {\n\t/**\n\t * The duration of time before which all hit counts are reset (in milliseconds).\n\t */\n\twindowMs!: number\n\n\t/**\n\t * The map that stores the number of hits for each client in memory.\n\t */\n\thits!: {\n\t\t[key: string]: number | undefined\n\t}\n\n\t/**\n\t * The time at which all hit counts will be reset.\n\t */\n\tresetTime!: Date\n\n\t/**\n\t * Method that initializes the store.\n\t *\n\t * @param options {Options} - The options used to setup the middleware\n\t */\n\tinit(options: Options): void {\n\t\t// Get the duration of a window from the options\n\t\tthis.windowMs = options.windowMs\n\t\t// Then calculate the reset time using that\n\t\tthis.resetTime = calculateNextResetTime(this.windowMs)\n\n\t\t// Initialise the hit counter map\n\t\tthis.hits = {}\n\n\t\t// Reset hit counts for ALL clients every `windowMs` - this will also\n\t\t// re-calculate the `resetTime`\n\t\tconst interval = setInterval(async () => {\n\t\t\tawait this.resetAll()\n\t\t}, this.windowMs)\n\t\tif (interval.unref) {\n\t\t\tinterval.unref()\n\t\t}\n\t}\n\n\t/**\n\t * Method to increment a client's hit counter.\n\t *\n\t * @param key {string} - The identifier for a client\n\t *\n\t * @returns {IncrementResponse} - The number of hits and reset time for that client\n\t *\n\t * @public\n\t */\n\tasync increment(key: string): Promise<IncrementResponse> {\n\t\tconst totalHits = (this.hits[key] ?? 0) + 1\n\t\tthis.hits[key] = totalHits\n\n\t\treturn {\n\t\t\ttotalHits,\n\t\t\tresetTime: this.resetTime,\n\t\t}\n\t}\n\n\t/**\n\t * Method to decrement a client's hit counter.\n\t *\n\t * @param key {string} - The identifier for a client\n\t *\n\t * @public\n\t */\n\tasync decrement(key: string): Promise<void> {\n\t\tconst current = this.hits[key]\n\t\tif (current) {\n\t\t\tthis.hits[key] = current - 1\n\t\t}\n\t}\n\n\t/**\n\t * Method to reset a client's hit counter.\n\t *\n\t * @param key {string} - The identifier for a client\n\t *\n\t * @public\n\t */\n\tasync resetKey(key: string): Promise<void> {\n\t\tdelete this.hits[key]\n\t}\n\n\t/**\n\t * Method to reset everyone's hit counter.\n\t *\n\t * @public\n\t */\n\tasync resetAll(): Promise<void> {\n\t\tthis.hits = {}\n\t\tthis.resetTime = calculateNextResetTime(this.windowMs)\n\t}\n}\n"]}

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/cjs/types.d.ts

@@ -0,0 +1,239 @@
+import Express from 'express';
+/**
+ * Callback that fires when a client's hit counter is incremented.
+ *
+ * @param error {Error | undefined} - The error that occurred, if any
+ * @param totalHits {number} - The number of hits for that client so far
+ * @param resetTime {Date | undefined} - The time when the counter resets
+ */
+export declare type IncrementCallback = (error: Error | undefined, totalHits: number, resetTime: Date | undefined) => void;
+/**
+ * Method (in the form of middleware) to generate/retrieve a value based on the
+ * incoming request
+ *
+ * @param request {Express.Request} - The Express request object
+ * @param response {Express.Response} - The Express response object
+ *
+ * @returns {T} - The value needed
+ */
+export declare type ValueDeterminingMiddleware<T> = (request: Express.Request, response: Express.Response) => T | Promise<T>;
+/**
+ * Express request handler that sends back a response when a client is
+ * rate-limited.
+ *
+ * @param request {Express.Request} - The Express request object
+ * @param response {Express.Response} - The Express response object
+ * @param next {Express.NextFunction} - The Express `next` function, can be called to skip responding
+ * @param optionsUsed {Options} - The options used to set up the middleware
+ */
+export declare type RateLimitExceededEventHandler = (request: Express.Request, response: Express.Response, next: Express.NextFunction, optionsUsed: Options) => void;
+/**
+ * Event callback that is triggered on a client's first request that exceeds the limit
+ * but not for subsequent requests. May be used for logging, etc. Should *not*
+ * send a response.
+ *
+ * @param request {Express.Request} - The Express request object
+ * @param response {Express.Response} - The Express response object
+ * @param optionsUsed {Options} - The options used to set up the middleware
+ */
+export declare type RateLimitReachedEventHandler = (request: Express.Request, response: Express.Response, optionsUsed: Options) => void;
+/**
+ * Data returned from the `Store` when a client's hit counter is incremented.
+ *
+ * @property totalHits {number} - The number of hits for that client so far
+ * @property resetTime {Date | undefined} - The time when the counter resets
+ */
+export declare type IncrementResponse = {
+    totalHits: number;
+    resetTime: Date | undefined;
+};
+/**
+ * A modified Express request handler with the rate limit functions.
+ */
+export declare type RateLimitRequestHandler = Express.RequestHandler & {
+    /**
+     * Method to reset a client's hit counter.
+     *
+     * @param key {string} - The identifier for a client
+     */
+    resetKey: (key: string) => void;
+};
+/**
+ * An interface that all hit counter stores must implement.
+ *
+ * @deprecated 6.x - Implement the `Store` interface instead.
+ */
+export interface LegacyStore {
+    /**
+     * Method to increment a client's hit counter.
+     *
+     * @param key {string} - The identifier for a client
+     * @param callback {IncrementCallback} - The callback to call once the counter is incremented
+     */
+    incr: (key: string, callback: IncrementCallback) => void;
+    /**
+     * Method to decrement a client's hit counter.
+     *
+     * @param key {string} - The identifier for a client
+     */
+    decrement: (key: string) => void;
+    /**
+     * Method to reset a client's hit counter.
+     *
+     * @param key {string} - The identifier for a client
+     */
+    resetKey: (key: string) => void;
+    /**
+     * Method to reset everyone's hit counter.
+     */
+    resetAll?: () => void;
+}
+/**
+ * An interface that all hit counter stores must implement.
+ */
+export interface Store {
+    /**
+     * Method that initializes the store, and has access to the options passed to
+     * the middleware too.
+     *
+     * @param options {Options} - The options used to setup the middleware
+     */
+    init?: (options: Options) => void;
+    /**
+     * Method to increment a client's hit counter.
+     *
+     * @param key {string} - The identifier for a client
+     *
+     * @returns {IncrementResponse} - The number of hits and reset time for that client
+     */
+    increment: (key: string) => Promise<IncrementResponse> | IncrementResponse;
+    /**
+     * Method to decrement a client's hit counter.
+     *
+     * @param key {string} - The identifier for a client
+     */
+    decrement: (key: string) => Promise<void> | void;
+    /**
+     * Method to reset a client's hit counter.
+     *
+     * @param key {string} - The identifier for a client
+     */
+    resetKey: (key: string) => Promise<void> | void;
+    /**
+     * Method to reset everyone's hit counter.
+     */
+    resetAll?: () => Promise<void> | void;
+}
+/**
+ * The configuration options for the rate limiter.
+ */
+export interface Options {
+    /**
+     * How long we should remember the requests.
+     */
+    readonly windowMs: number;
+    /**
+     * The maximum number of connection to allow during the `window` before
+     * rate limiting the client.
+     *
+     * Can be the limit itself as a number or express middleware that parses
+     * the request and then figures out the limit.
+     */
+    readonly max: number | ValueDeterminingMiddleware<number>;
+    /**
+     * The response body to send back when a client is rate limited.
+     */
+    readonly message: any;
+    /**
+     * The HTTP status code to send back when a client is rate limited.
+     *
+     * Defaults to `HTTP 429 Too Many Requests` (RFC 6585).
+     */
+    readonly statusCode: number;
+    /**
+     * Whether to send `X-RateLimit-*` headers with the rate limit and the number
+     * of requests.
+     */
+    readonly legacyHeaders: boolean;
+    /**
+     * Whether to enable support for the rate limit standardization headers (`RateLimit-*`).
+     */
+    readonly standardHeaders: boolean;
+    /**
+     * The name of the property on the request object to store the rate limit info.
+     *
+     * Defaults to `rateLimit`.
+     */
+    readonly requestPropertyName: string;
+    /**
+     * If `true`, the library will (by default) skip all requests that have a 4XX
+     * or 5XX status.
+     */
+    readonly skipFailedRequests: boolean;
+    /**
+     * If `true`, the library will (by default) skip all requests that have a
+     * status code less than 400.
+     */
+    readonly skipSuccessfulRequests: boolean;
+    /**
+     * Method to determine whether or not the request counts as 'succesful'. Used
+     * when either `skipSuccessfulRequests` or `skipFailedRequests` is set to true.
+     */
+    readonly requestWasSuccessful: ValueDeterminingMiddleware<boolean>;
+    /**
+     * Method to generate custom identifiers for clients.
+     *
+     * By default, the client's IP address is used.
+     */
+    readonly keyGenerator: ValueDeterminingMiddleware<string>;
+    /**
+     * Method (in the form of middleware) to determine whether or not this request
+     * counts towards a client's quota.
+     */
+    readonly skip: ValueDeterminingMiddleware<boolean>;
+    /**
+     * Express request handler that sends back a response when a client is
+     * rate-limited.
+     */
+    readonly handler: RateLimitExceededEventHandler;
+    /**
+     * Express request handler that sends back a response when a client has
+     * reached their rate limit, and will be rate limited on their next request.
+     */
+    readonly onLimitReached: RateLimitReachedEventHandler;
+    /**
+     * The {@link Store} to use to store the hit count for each client.
+     */
+    store: Store;
+    /**
+     * Whether to send `X-RateLimit-*` headers with the rate limit and the number
+     * of requests.
+     *
+     * @deprecated 6.x - This option was renamed to `legacyHeaders`.
+     */
+    headers?: boolean;
+    /**
+     * Whether to send `RateLimit-*` headers with the rate limit and the number
+     * of requests.
+     *
+     * @deprecated 6.x - This option was renamed to `standardHeaders`.
+     */
+    draft_polli_ratelimit_headers?: boolean;
+}
+/**
+ * The extended request object that includes information about the client's
+ * rate limit.
+ */
+export declare type AugmentedRequest = Express.Request & {
+    [key: string]: RateLimitInfo;
+};
+/**
+ * The rate limit related information for each client included in the
+ * Express request object.
+ */
+export interface RateLimitInfo {
+    readonly limit: number;
+    readonly current: number;
+    readonly remaining: number;
+    readonly resetTime: Date | undefined;
+}

package/dist/cjs/types.js

@@ -0,0 +1,5 @@
+"use strict";
+// /source/types.ts
+// All the types used by this package
+exports.__esModule = true;
+//# sourceMappingURL=types.js.map

package/dist/cjs/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../source/types.ts"],"names":[],"mappings":";AAAA,mBAAmB;AACnB,qCAAqC","sourcesContent":["// /source/types.ts\n// All the types used by this package\n\nimport Express from 'express'\n\n/**\n * Callback that fires when a client's hit counter is incremented.\n *\n * @param error {Error | undefined} - The error that occurred, if any\n * @param totalHits {number} - The number of hits for that client so far\n * @param resetTime {Date | undefined} - The time when the counter resets\n */\nexport type IncrementCallback = (\n\terror: Error | undefined,\n\ttotalHits: number,\n\tresetTime: Date | undefined,\n) => void\n\n/**\n * Method (in the form of middleware) to generate/retrieve a value based on the\n * incoming request\n *\n * @param request {Express.Request} - The Express request object\n * @param response {Express.Response} - The Express response object\n *\n * @returns {T} - The value needed\n */\nexport type ValueDeterminingMiddleware<T> = (\n\trequest: Express.Request,\n\tresponse: Express.Response,\n) => T | Promise<T>\n\n/**\n * Express request handler that sends back a response when a client is\n * rate-limited.\n *\n * @param request {Express.Request} - The Express request object\n * @param response {Express.Response} - The Express response object\n * @param next {Express.NextFunction} - The Express `next` function, can be called to skip responding\n * @param optionsUsed {Options} - The options used to set up the middleware\n */\nexport type RateLimitExceededEventHandler = (\n\trequest: Express.Request,\n\tresponse: Express.Response,\n\tnext: Express.NextFunction,\n\toptionsUsed: Options,\n) => void\n\n/**\n * Event callback that is triggered on a client's first request that exceeds the limit\n * but not for subsequent requests. May be used for logging, etc. Should *not*\n * send a response.\n *\n * @param request {Express.Request} - The Express request object\n * @param response {Express.Response} - The Express response object\n * @param optionsUsed {Options} - The options used to set up the middleware\n */\nexport type RateLimitReachedEventHandler = (\n\trequest: Express.Request,\n\tresponse: Express.Response,\n\toptionsUsed: Options,\n) => void\n\n/**\n * Data returned from the `Store` when a client's hit counter is incremented.\n *\n * @property totalHits {number} - The number of hits for that client so far\n * @property resetTime {Date | undefined} - The time when the counter resets\n */\nexport type IncrementResponse = {\n\ttotalHits: number\n\tresetTime: Date | undefined\n}\n\n/**\n * A modified Express request handler with the rate limit functions.\n */\nexport type RateLimitRequestHandler = Express.RequestHandler & {\n\t/**\n\t * Method to reset a client's hit counter.\n\t *\n\t * @param key {string} - The identifier for a client\n\t */\n\tresetKey: (key: string) => void\n}\n\n/**\n * An interface that all hit counter stores must implement.\n *\n * @deprecated 6.x - Implement the `Store` interface instead.\n */\nexport interface LegacyStore {\n\t/**\n\t * Method to increment a client's hit counter.\n\t *\n\t * @param key {string} - The identifier for a client\n\t * @param callback {IncrementCallback} - The callback to call once the counter is incremented\n\t */\n\tincr: (key: string, callback: IncrementCallback) => void\n\n\t/**\n\t * Method to decrement a client's hit counter.\n\t *\n\t * @param key {string} - The identifier for a client\n\t */\n\tdecrement: (key: string) => void\n\n\t/**\n\t * Method to reset a client's hit counter.\n\t *\n\t * @param key {string} - The identifier for a client\n\t */\n\tresetKey: (key: string) => void\n\n\t/**\n\t * Method to reset everyone's hit counter.\n\t */\n\tresetAll?: () => void\n}\n\n/**\n * An interface that all hit counter stores must implement.\n */\nexport interface Store {\n\t/**\n\t * Method that initializes the store, and has access to the options passed to\n\t * the middleware too.\n\t *\n\t * @param options {Options} - The options used to setup the middleware\n\t */\n\tinit?: (options: Options) => void\n\n\t/**\n\t * Method to increment a client's hit counter.\n\t *\n\t * @param key {string} - The identifier for a client\n\t *\n\t * @returns {IncrementResponse} - The number of hits and reset time for that client\n\t */\n\tincrement: (key: string) => Promise<IncrementResponse> | IncrementResponse\n\n\t/**\n\t * Method to decrement a client's hit counter.\n\t *\n\t * @param key {string} - The identifier for a client\n\t */\n\tdecrement: (key: string) => Promise<void> | void\n\n\t/**\n\t * Method to reset a client's hit counter.\n\t *\n\t * @param key {string} - The identifier for a client\n\t */\n\tresetKey: (key: string) => Promise<void> | void\n\n\t/**\n\t * Method to reset everyone's hit counter.\n\t */\n\tresetAll?: () => Promise<void> | void\n}\n\n/**\n * The configuration options for the rate limiter.\n */\nexport interface Options {\n\t/**\n\t * How long we should remember the requests.\n\t */\n\treadonly windowMs: number\n\n\t/**\n\t * The maximum number of connection to allow during the `window` before\n\t * rate limiting the client.\n\t *\n\t * Can be the limit itself as a number or express middleware that parses\n\t * the request and then figures out the limit.\n\t */\n\treadonly max: number | ValueDeterminingMiddleware<number>\n\n\t/**\n\t * The response body to send back when a client is rate limited.\n\t */\n\treadonly message: any\n\n\t/**\n\t * The HTTP status code to send back when a client is rate limited.\n\t *\n\t * Defaults to `HTTP 429 Too Many Requests` (RFC 6585).\n\t */\n\treadonly statusCode: number\n\n\t/**\n\t * Whether to send `X-RateLimit-*` headers with the rate limit and the number\n\t * of requests.\n\t */\n\treadonly legacyHeaders: boolean\n\n\t/**\n\t * Whether to enable support for the rate limit standardization headers (`RateLimit-*`).\n\t */\n\treadonly standardHeaders: boolean\n\n\t/**\n\t * The name of the property on the request object to store the rate limit info.\n\t *\n\t * Defaults to `rateLimit`.\n\t */\n\treadonly requestPropertyName: string\n\n\t/**\n\t * If `true`, the library will (by default) skip all requests that have a 4XX\n\t * or 5XX status.\n\t */\n\treadonly skipFailedRequests: boolean\n\n\t/**\n\t * If `true`, the library will (by default) skip all requests that have a\n\t * status code less than 400.\n\t */\n\treadonly skipSuccessfulRequests: boolean\n\n\t/**\n\t * Method to determine whether or not the request counts as 'succesful'. Used\n\t * when either `skipSuccessfulRequests` or `skipFailedRequests` is set to true.\n\t */\n\treadonly requestWasSuccessful: ValueDeterminingMiddleware<boolean>\n\n\t/**\n\t * Method to generate custom identifiers for clients.\n\t *\n\t * By default, the client's IP address is used.\n\t */\n\treadonly keyGenerator: ValueDeterminingMiddleware<string>\n\n\t/**\n\t * Method (in the form of middleware) to determine whether or not this request\n\t * counts towards a client's quota.\n\t */\n\treadonly skip: ValueDeterminingMiddleware<boolean>\n\n\t/**\n\t * Express request handler that sends back a response when a client is\n\t * rate-limited.\n\t */\n\treadonly handler: RateLimitExceededEventHandler\n\n\t/**\n\t * Express request handler that sends back a response when a client has\n\t * reached their rate limit, and will be rate limited on their next request.\n\t */\n\treadonly onLimitReached: RateLimitReachedEventHandler\n\n\t/**\n\t * The {@link Store} to use to store the hit count for each client.\n\t */\n\tstore: Store\n\n\t/**\n\t * Whether to send `X-RateLimit-*` headers with the rate limit and the number\n\t * of requests.\n\t *\n\t * @deprecated 6.x - This option was renamed to `legacyHeaders`.\n\t */\n\theaders?: boolean\n\n\t/**\n\t * Whether to send `RateLimit-*` headers with the rate limit and the number\n\t * of requests.\n\t *\n\t * @deprecated 6.x - This option was renamed to `standardHeaders`.\n\t */\n\tdraft_polli_ratelimit_headers?: boolean\n}\n\n/**\n * The extended request object that includes information about the client's\n * rate limit.\n */\nexport type AugmentedRequest = Express.Request & {\n\t[key: string]: RateLimitInfo\n}\n\n/**\n * The rate limit related information for each client included in the\n * Express request object.\n */\nexport interface RateLimitInfo {\n\treadonly limit: number\n\treadonly current: number\n\treadonly remaining: number\n\treadonly resetTime: Date | undefined\n}\n"]}

package/dist/esm/index.d.ts

@@ -0,0 +1,2 @@
+export * from './types.js';
+export { default } from './lib.js';

package/dist/esm/index.js

@@ -0,0 +1,5 @@
+// /source/index.ts
+// Export away!
+export * from './types.js';
+export { default } from './lib.js';
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../source/index.ts"],"names":[],"mappings":"AAAA,mBAAmB;AACnB,eAAe;AAEf,cAAc,YAAY,CAAA;AAC1B,OAAO,EAAE,OAAO,EAAE,MAAM,UAAU,CAAA","sourcesContent":["// /source/index.ts\n// Export away!\n\nexport * from './types.js'\nexport { default } from './lib.js'\n"]}

package/dist/esm/lib.d.ts

@@ -0,0 +1,15 @@
+import { Options, RateLimitRequestHandler, LegacyStore, Store } from './types.js';
+/**
+ *
+ * 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
+ */
+declare const rateLimit: (passedOptions?: (Omit<Partial<Options>, "store"> & {
+    store?: LegacyStore | Store | undefined;
+}) | undefined) => RateLimitRequestHandler;
+export default rateLimit;