hono-rate-limiter 0.1.0 → 0.1.2

package/README.md

@@ -12,6 +12,9 @@
 Rate limiting middleware for [Hono](https://hono.dev/). Use to
 limit repeated requests to public APIs and/or endpoints such as password reset.
 
+> [!WARNING]  
+> The `keyGenerator` function is currently under construction and needs to be defined for `hono-rate-limiter` to work properly in your environment. Please ensure that you define the `keyGenerator` function according to the documentation before using the library.
+
 ## Usage
 
 ```ts
@@ -20,7 +23,8 @@ import { rateLimiter } from "hono-rate-limiter";
 const limiter = rateLimiter({
   windowMs: 15 * 60 * 1000, // 15 minutes
   limit: 100, // Limit each IP to 100 requests per `window` (here, per 15 minutes).
-  standardHeaders: "draft-7", // draft-6: `RateLimit-*` headers; draft-7: combined `RateLimit` header
+  standardHeaders: "draft-6", // draft-6: `RateLimit-*` headers; draft-7: combined `RateLimit` header
+  keyGenerator: () => "<unique_key>", // Method to generate custom identifiers for clients.
   // store: ... , // Redis, MemoryStore, etc. See below.
 });
 
@@ -30,18 +34,24 @@ app.use(limiter);
 
 # Data Stores
 
-Express-rate-limit supports external data stores to sychronize hit counts across multiple processes and servers.
+Express-rate-limit supports external data stores to synchronize hit counts across multiple processes and servers.
 
-By default, `MemoryStore` is used. This one does not synchronize it’s state across instances. It’s simple to deploy, and often sufficient for basic abuse prevention, but will be inconnsistent across reboots or in deployments with multiple process or servers.
+By default, `MemoryStore` is used. This one does not synchronize its state across instances. It’s simple to deploy, and often sufficient for basic abuse prevention, but will be inconnsistent across reboots or in deployments with multiple process or servers.
 
 Deployments requiring more consistently enforced rate limits should use an external store.
 
 Here is a list of stores:
 
-| Name        | Description                                                                                         |
-| ----------- | --------------------------------------------------------------------------------------------------- |
-| MemoryStore | (default) Simple in-memory option. Does not share state when app has multiple processes or servers. |
-| RedisStore  | A [Redis](https://redis.io/)-backed store, more suitable for large or demanding deployments.        |
+| Name                                                                                 | Description                                                                                                                                                                                        |
+| ------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| MemoryStore                                                                          | (default) Simple in-memory option. Does not share state when the app has multiple processes or servers.                                                                                            |
+| [`rate-limit-redis`](https://npm.im/rate-limit-redis)                                | A [Redis](https://redis.io/)-backed store, more suitable for large or demanding deployments.                                                                                                       |
+| [`rate-limit-postresql`](https://www.npm.im/@acpr/rate-limit-postgresql)             | A [PostgreSQL](https://www.postgresql.org/)-backed store.                                                                                                                                          |
+| [`rate-limit-memecached`](https://npmjs.org/package/rate-limit-memcached)            | A [Memcached](https://memcached.org/)-backed store.                                                                                                                                                |
+| [`cluster-memory-store`](https://npm.im/@express-rate-limit/cluster-memory-store)    | A memory-store wrapper that shares state across all processes on a single server via the [node:cluster](https://nodejs.org/api/cluster.html) module. Does not share state across multiple servers. |
+| [`precise-memory-rate-limit`](https://www.npm.im/precise-memory-rate-limit)          | A memory store similar to the built-in one, except that it stores a distinct timestamp for each key.                                                                                               |
+| [`typeorm-rate-limit-store`](https://www.npmjs.com/package/typeorm-rate-limit-store) | Supports a variety of databases via [TypeORM](https://typeorm.io/): MySQL, MariaDB, CockroachDB, SQLite, Microsoft SQL Server, Oracle, SAP Hana, and more.                                         |
+| [`@rlimit/storage`](<(https://www.npmjs.com/package/@rlimit/storage)>)               | A distributed rlimit store, ideal for multi-regional deployments.                                                                                                                                  |
 
 Take a look at this [guide](https://express-rate-limit.mintlify.app/guides/creating-a-store) if you wish to create your own store.
 

package/package.json

@@ -1,22 +1,36 @@
 {
   "name": "hono-rate-limiter",
-  "version": "0.1.0",
-  "type": "commonjs",
+  "version": "0.1.2",
+  "type": "module",
+  "license": "MIT",
+  "keywords": [
+    "hono",
+    "api",
+    "middleware",
+    "rest-api",
+    "rate-limiting",
+    "rate-limiter",
+    "honojs"
+  ],
+  "homepage": "https://github.com/rhinobase/hono-rate-limiter",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/rhinobase/hono-rate-limiter.git",
+    "directory": "packages/ui"
+  },
+  "bugs": {
+    "url": "https://github.com/rhinobase/hono-rate-limiter/issues"
+  },
   "dependencies": {
     "@swc/helpers": "~0.5.2"
   },
   "peerDependencies": {
     "hono": "^4.1.1"
   },
-  "exports": {
-    ".": {
-      "default": "./src/index.js",
-      "types": "./src/index.d.ts"
-    },
-    "./redis": {
-      "default": "./src/redis/index.js",
-      "types": "./src/redis/index.d.ts"
-    }
-  },
-  "main": "./src/index.js"
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts",
+  "module": "./src/index.js"
 }

package/src/core/defaultKeyGenerator.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:true});Object.defineProperty(exports,"defaultKeyGenerator",{enumerable:true,get:function(){return defaultKeyGenerator}});const _adapter=require("hono/adapter");function defaultKeyGenerator(c){const runtime=(0,_adapter.getRuntimeKey)();let key=null;switch(runtime){case"workerd":key=c.req.raw.headers.get("CF-Connecting-IP");break;case"fastly":key=c.req.raw.headers.get("Fastly-Client-IP");break;case"other":key=c.req.raw.headers.get("x-real-ip");break;default:break}return key!=null?key:""}
+import{getRuntimeKey}from"hono/adapter";export function defaultKeyGenerator(c){const runtime=getRuntimeKey();let key=null;switch(runtime){case"workerd":key=c.req.raw.headers.get("CF-Connecting-IP");break;case"fastly":key=c.req.raw.headers.get("Fastly-Client-IP");break;case"other":key=c.req.raw.headers.get("x-real-ip");break;default:break}return key??""}

package/src/core/headers.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:true});function _export(target,all){for(var name in all)Object.defineProperty(target,name,{enumerable:true,get:all[name]})}_export(exports,{setDraft6Headers:function(){return setDraft6Headers},setDraft7Headers:function(){return setDraft7Headers},setRetryAfterHeader:function(){return setRetryAfterHeader}});const getResetSeconds=(resetTime,windowMs)=>{let resetSeconds;if(resetTime){const deltaSeconds=Math.ceil((resetTime.getTime()-Date.now())/1e3);resetSeconds=Math.max(0,deltaSeconds)}else if(windowMs){resetSeconds=Math.ceil(windowMs/1e3)}return resetSeconds};const setDraft6Headers=(context,info,windowMs)=>{if(context.finalized)return;const windowSeconds=Math.ceil(windowMs/1e3);const resetSeconds=getResetSeconds(info.resetTime);context.header("RateLimit-Policy",`${info.limit};w=${windowSeconds}`);context.header("RateLimit-Limit",info.limit.toString());context.header("RateLimit-Remaining",info.remaining.toString());if(resetSeconds)context.header("RateLimit-Reset",resetSeconds.toString())};const setDraft7Headers=(context,info,windowMs)=>{if(context.finalized)return;const windowSeconds=Math.ceil(windowMs/1e3);const resetSeconds=getResetSeconds(info.resetTime,windowMs);context.header("RateLimit-Policy",`${info.limit};w=${windowSeconds}`);context.header("RateLimit",`limit=${info.limit}, remaining=${info.remaining}, reset=${resetSeconds}`)};const setRetryAfterHeader=(context,info,windowMs)=>{if(context.finalized)return;const resetSeconds=getResetSeconds(info.resetTime,windowMs);context.header("Retry-After",resetSeconds==null?void 0:resetSeconds.toString())};
+const getResetSeconds=(resetTime,windowMs)=>{let resetSeconds;if(resetTime){const deltaSeconds=Math.ceil((resetTime.getTime()-Date.now())/1e3);resetSeconds=Math.max(0,deltaSeconds)}else if(windowMs){resetSeconds=Math.ceil(windowMs/1e3)}return resetSeconds};export const setDraft6Headers=(context,info,windowMs)=>{if(context.finalized)return;const windowSeconds=Math.ceil(windowMs/1e3);const resetSeconds=getResetSeconds(info.resetTime);context.header("RateLimit-Policy",`${info.limit};w=${windowSeconds}`);context.header("RateLimit-Limit",info.limit.toString());context.header("RateLimit-Remaining",info.remaining.toString());if(resetSeconds)context.header("RateLimit-Reset",resetSeconds.toString())};export const setDraft7Headers=(context,info,windowMs)=>{if(context.finalized)return;const windowSeconds=Math.ceil(windowMs/1e3);const resetSeconds=getResetSeconds(info.resetTime,windowMs);context.header("RateLimit-Policy",`${info.limit};w=${windowSeconds}`);context.header("RateLimit",`limit=${info.limit}, remaining=${info.remaining}, reset=${resetSeconds}`)};export const setRetryAfterHeader=(context,info,windowMs)=>{if(context.finalized)return;const resetSeconds=getResetSeconds(info.resetTime,windowMs);context.header("Retry-After",resetSeconds?.toString())};

package/src/core/index.d.ts

@@ -10,4 +10,4 @@ import type { ConfigType } from "../types";
  *
  * @public
  */
-export declare function rateLimiter<E extends Env, P extends string, I extends Input>(config?: Partial<ConfigType<E, P, I>>): import("hono").MiddlewareHandler<E, P, I>;
+export declare function rateLimiter<E extends Env = Env, P extends string = string, I extends Input = Input>(config?: Partial<ConfigType<E, P, I>>): import("hono").MiddlewareHandler<E, P, I>;

package/src/core/index.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:true});Object.defineProperty(exports,"rateLimiter",{enumerable:true,get:function(){return rateLimiter}});const _interop_require_default=require("@swc/helpers/_/_interop_require_default");const _factory=require("hono/factory");const _memorystore=_interop_require_default._(require("../memory-store"));const _defaultKeyGenerator=require("./defaultKeyGenerator");const _headers=require("./headers");const _validations=require("./validations");function rateLimiter(config){const{windowMs=6e4,limit=5,message="Too many requests, please try again later.",statusCode=429,standardHeaders="draft-6",requestPropertyName="rateLimit",skipFailedRequests=false,skipSuccessfulRequests=false,keyGenerator=_defaultKeyGenerator.defaultKeyGenerator,skip=()=>false,requestWasSuccessful=c=>c.res.status<400,handler=async(c,_next,options)=>{c.status(options.statusCode);const responseMessage=typeof options.message==="function"?await options.message(c):options.message;if(typeof responseMessage==="string")return c.text(responseMessage);return c.json(responseMessage)},store=new _memorystore.default}=config!=null?config:{};const options={windowMs,limit,message,statusCode,standardHeaders,requestPropertyName,skipFailedRequests,skipSuccessfulRequests,keyGenerator,skip,requestWasSuccessful,handler,store};if(!(0,_validations.isValidStore)(store))throw new Error("The store is not correctly implmented!");if(typeof store.init==="function")store.init(options);return(0,_factory.createMiddleware)(async(c,next)=>{const isSkippable=await skip(c);if(isSkippable){await next();return}const key=await keyGenerator(c);const{totalHits,resetTime}=await store.increment(key);const retrieveLimit=typeof limit==="function"?limit(c):limit;const _limit=await retrieveLimit;const info={limit:_limit,used:totalHits,remaining:Math.max(_limit-totalHits,0),resetTime};c.set(requestPropertyName,info);if(standardHeaders&&!c.finalized){if(standardHeaders==="draft-7"){(0,_headers.setDraft7Headers)(c,info,windowMs)}else{(0,_headers.setDraft6Headers)(c,info,windowMs)}}let decremented=false;const decrementKey=async()=>{if(!decremented){await store.decrement(key);decremented=true}};const shouldSkipRequest=async()=>{if(skipFailedRequests||skipSuccessfulRequests){const wasRequestSuccessful=await requestWasSuccessful(c);if(skipFailedRequests&&!wasRequestSuccessful||skipSuccessfulRequests&&wasRequestSuccessful)await decrementKey()}};if(totalHits>_limit){if(standardHeaders){(0,_headers.setRetryAfterHeader)(c,info,windowMs)}await shouldSkipRequest();return handler(c,next,options)}try{await next();await shouldSkipRequest()}catch(error){if(skipFailedRequests)await decrementKey()}finally{if(!c.finalized)await decrementKey()}})}
+import{createMiddleware}from"hono/factory";import MemoryStore from"../memory-store";import{defaultKeyGenerator}from"./defaultKeyGenerator";import{setDraft6Headers,setDraft7Headers,setRetryAfterHeader}from"./headers";import{isValidStore}from"./validations";export function rateLimiter(config){const{windowMs=6e4,limit=5,message="Too many requests, please try again later.",statusCode=429,standardHeaders="draft-6",requestPropertyName="rateLimit",requestStorePropertyName="rateLimitStore",skipFailedRequests=false,skipSuccessfulRequests=false,keyGenerator=defaultKeyGenerator,skip=()=>false,requestWasSuccessful=c=>c.res.status<400,handler=async(c,_next,options)=>{c.status(options.statusCode);const responseMessage=typeof options.message==="function"?await options.message(c):options.message;if(typeof responseMessage==="string")return c.text(responseMessage);return c.json(responseMessage)},store=new MemoryStore}=config??{};const options={windowMs,limit,message,statusCode,standardHeaders,requestPropertyName,requestStorePropertyName,skipFailedRequests,skipSuccessfulRequests,keyGenerator,skip,requestWasSuccessful,handler,store};if(!isValidStore(store))throw new Error("The store is not correctly implmented!");if(typeof store.init==="function")store.init(options);return createMiddleware(async(c,next)=>{const isSkippable=await skip(c);if(isSkippable){await next();return}const key=await keyGenerator(c);const{totalHits,resetTime}=await store.increment(key);const retrieveLimit=typeof limit==="function"?limit(c):limit;const _limit=await retrieveLimit;const info={limit:_limit,used:totalHits,remaining:Math.max(_limit-totalHits,0),resetTime};c.set(requestPropertyName,info);c.set(requestStorePropertyName,{getKey:store.get?.bind(store),resetKey:store.resetKey.bind(store)});if(standardHeaders&&!c.finalized){if(standardHeaders==="draft-7"){setDraft7Headers(c,info,windowMs)}else{setDraft6Headers(c,info,windowMs)}}let decremented=false;const decrementKey=async()=>{if(!decremented){await store.decrement(key);decremented=true}};const shouldSkipRequest=async()=>{if(skipFailedRequests||skipSuccessfulRequests){const wasRequestSuccessful=await requestWasSuccessful(c);if(skipFailedRequests&&!wasRequestSuccessful||skipSuccessfulRequests&&wasRequestSuccessful)await decrementKey()}};if(totalHits>_limit){if(standardHeaders){setRetryAfterHeader(c,info,windowMs)}await shouldSkipRequest();return handler(c,next,options)}try{await next();await shouldSkipRequest()}catch(error){if(skipFailedRequests)await decrementKey()}finally{if(!c.finalized)await decrementKey()}})}

package/src/core/validations.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:true});Object.defineProperty(exports,"isValidStore",{enumerable:true,get:function(){return isValidStore}});const isValidStore=value=>!!(value==null?void 0:value.increment);
+export const isValidStore=value=>!!value?.increment;

package/src/index.d.ts

@@ -1,2 +1,2 @@
-export * from "./core";
+export { rateLimiter as default, rateLimiter } from "./core";
 export type * from "./types";

package/src/index.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:true});const _export_star=require("@swc/helpers/_/_export_star");_export_star._(require("./core"),exports);
+export{rateLimiter as default,rateLimiter}from"./core";

package/src/memory-store/index.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:true});function _export(target,all){for(var name in all)Object.defineProperty(target,name,{enumerable:true,get:all[name]})}_export(exports,{MemoryStore:function(){return MemoryStore},default:function(){return _default}});let MemoryStore=class MemoryStore{init(options){this.windowMs=options.windowMs;if(this.interval)clearInterval(this.interval);this.interval=setInterval(()=>{this.clearExpired()},this.windowMs);if(this.interval.unref)this.interval.unref()}async get(key){var _this_current_get;return(_this_current_get=this.current.get(key))!=null?_this_current_get:this.previous.get(key)}async increment(key){const client=this.getClient(key);const now=Date.now();if(client.resetTime.getTime()<=now){this.resetClient(client,now)}client.totalHits++;return client}async decrement(key){const client=this.getClient(key);if(client.totalHits>0)client.totalHits--}async resetKey(key){this.current.delete(key);this.previous.delete(key)}async resetAll(){this.current.clear();this.previous.clear()}shutdown(){clearInterval(this.interval);void this.resetAll()}resetClient(client,now=Date.now()){client.totalHits=0;client.resetTime.setTime(now+this.windowMs);return client}getClient(key){if(this.current.has(key))return this.current.get(key);let client;if(this.previous.has(key)){client=this.previous.get(key);this.previous.delete(key)}else{client={totalHits:0,resetTime:new Date};this.resetClient(client)}this.current.set(key,client);return client}clearExpired(){this.previous=this.current;this.current=new Map}constructor(){this.previous=new Map;this.current=new Map;this.localKeys=true}};const _default=MemoryStore;
+export class MemoryStore{init(options){this.windowMs=options.windowMs;if(this.interval)clearInterval(this.interval);this.interval=setInterval(()=>{this.clearExpired()},this.windowMs);if(this.interval.unref)this.interval.unref()}async get(key){return this.current.get(key)??this.previous.get(key)}async increment(key){const client=this.getClient(key);const now=Date.now();if(client.resetTime.getTime()<=now){this.resetClient(client,now)}client.totalHits++;return client}async decrement(key){const client=this.getClient(key);if(client.totalHits>0)client.totalHits--}async resetKey(key){this.current.delete(key);this.previous.delete(key)}async resetAll(){this.current.clear();this.previous.clear()}shutdown(){clearInterval(this.interval);void this.resetAll()}resetClient(client,now=Date.now()){client.totalHits=0;client.resetTime.setTime(now+this.windowMs);return client}getClient(key){if(this.current.has(key))return this.current.get(key);let client;if(this.previous.has(key)){client=this.previous.get(key);this.previous.delete(key)}else{client={totalHits:0,resetTime:new Date};this.resetClient(client)}this.current.set(key,client);return client}clearExpired(){this.previous=this.current;this.current=new Map}constructor(){this.previous=new Map;this.current=new Map;this.localKeys=true}}export default MemoryStore;

package/src/types/clientRateLimitInfo.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:true});
+export{};

package/src/types/config.d.ts

@@ -36,7 +36,7 @@ export type ConfigType<E extends Env = any, P extends string = any, I extends In
      *
      * Defaults to `'Too many requests, please try again later.'`
      */
-    message: string | JSON | ((c: Context<E, P, I>) => Promisify<string | JSON>);
+    message: string | Record<string, unknown> | ((c: Context<E, P, I>) => Promisify<string | Record<string, unknown>>);
     /**
      * The HTTP status code to send back when a client is rate limited.
      *
@@ -50,11 +50,17 @@ export type ConfigType<E extends Env = any, P extends string = any, I extends In
      */
     standardHeaders: boolean | "draft-6" | "draft-7";
     /**
-     * The name of the property on the request object to store the rate limit info.
+     * The name of the property on the context object to store the rate limit info.
      *
      * Defaults to `rateLimit`.
      */
     requestPropertyName: string;
+    /**
+     * The name of the property on the context object to store the Data Store instance.
+     *
+     * Defaults to `rateLimitStore`.
+     */
+    requestStorePropertyName: string;
     /**
      * If `true`, the library will (by default) skip all requests that have a 4XX
      * or 5XX status.

package/src/types/config.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:true});
+export{};

package/src/types/index.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:true});
+export{};

package/src/types/promisify.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:true});
+export{};

package/src/types/rateLimitExceededEventHandler.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:true});
+export{};

package/src/types/rateLimitInfo.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:true});
+export{};

package/src/types/store.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:true});
+export{};

package/src/redis/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./types.js";
-export { default, RedisStore } from "./store.js";

package/src/redis/index.js

@@ -1 +0,0 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:true});function _export(target,all){for(var name in all)Object.defineProperty(target,name,{enumerable:true,get:all[name]})}_export(exports,{RedisStore:function(){return _store.RedisStore},default:function(){return _store.default}});const _export_star=require("@swc/helpers/_/_export_star");const _interop_require_wildcard=require("@swc/helpers/_/_interop_require_wildcard");_export_star._(require("./types.js"),exports);const _store=_interop_require_wildcard._(require("./store.js"));

package/src/redis/scripts.d.ts

@@ -1,9 +0,0 @@
-/**
- * The lua scripts, used to make consecutive queries on the same key and avoid
- * race conditions by doing all the work on the redis server.
- */
-declare const scripts: {
-    increment: string;
-    get: string;
-};
-export default scripts;

package/src/redis/scripts.js

@@ -1,16 +0,0 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:true});Object.defineProperty(exports,"default",{enumerable:true,get:function(){return _default}});const scripts={increment:`
-      local totalHits = redis.call("INCR", KEYS[1])
-      local timeToExpire = redis.call("PTTL", KEYS[1])
-      if timeToExpire <= 0 or ARGV[1] == "1"
-      then
-        redis.call("PEXPIRE", KEYS[1], tonumber(ARGV[2]))
-        timeToExpire = tonumber(ARGV[2])
-      end
-
-      return { totalHits, timeToExpire }
-		`.replaceAll(/^\s+/gm,"").trim(),get:`
-      local totalHits = redis.call("GET", KEYS[1])
-      local timeToExpire = redis.call("PTTL", KEYS[1])
-
-      return { totalHits, timeToExpire }
-		`.replaceAll(/^\s+/gm,"").trim()};const _default=scripts;

package/src/redis/store.d.ts

@@ -1,92 +0,0 @@
-import type { ClientRateLimitInfo, IncrementResponse, ConfigType as RateLimitConfiguration, Store } from "../types";
-import type { Options, RedisReply, SendCommandFn } from "./types.js";
-/**
- * A `Store` for the `express-rate-limit` package that stores hit counts in
- * Redis.
- */
-export declare class RedisStore implements Store {
-    /**
-     * The function used to send raw commands to Redis.
-     */
-    sendCommand: SendCommandFn;
-    /**
-     * The text to prepend to the key in Redis.
-     */
-    prefix: string;
-    /**
-     * Whether to reset the expiry for a particular key whenever its hit count
-     * changes.
-     */
-    resetExpiryOnChange: boolean;
-    /**
-     * Stores the loaded SHA1s of the LUA scripts used for executing the increment
-     * and get key operations.
-     */
-    incrementScriptSha: Promise<string>;
-    getScriptSha: Promise<string>;
-    /**
-     * The number of milliseconds to remember that user's requests.
-     */
-    windowMs: number;
-    /**
-     * @constructor for `RedisStore`.
-     *
-     * @param options {Options} - The configuration options for the store.
-     */
-    constructor(options: Options);
-    /**
-     * Loads the script used to increment a client's hit count.
-     */
-    loadIncrementScript(): Promise<string>;
-    /**
-     * Loads the script used to fetch a client's hit count and expiry time.
-     */
-    loadGetScript(): Promise<string>;
-    /**
-     * Runs the increment command, and retries it if the script is not loaded.
-     */
-    retryableIncrement(key: string): Promise<RedisReply>;
-    /**
-     * Method to prefix the keys with the given text.
-     *
-     * @param key {string} - The key.
-     *
-     * @returns {string} - The text + the key.
-     */
-    prefixKey(key: string): string;
-    /**
-     * Method that actually initializes the store.
-     *
-     * @param options {RateLimitConfiguration} - The options used to setup the middleware.
-     */
-    init(options: RateLimitConfiguration): void;
-    /**
-     * Method to fetch a client's hit count and reset time.
-     *
-     * @param key {string} - The identifier for a client.
-     *
-     * @returns {ClientRateLimitInfo | undefined} - The number of hits and reset time for that client.
-     */
-    get(key: string): Promise<ClientRateLimitInfo | undefined>;
-    /**
-     * 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>;
-    /**
-     * Method to decrement a client's hit counter.
-     *
-     * @param key {string} - The identifier for a client
-     */
-    decrement(key: string): Promise<void>;
-    /**
-     * Method to reset a client's hit counter.
-     *
-     * @param key {string} - The identifier for a client
-     */
-    resetKey(key: string): Promise<void>;
-}
-export default RedisStore;

package/src/redis/store.js

@@ -1 +0,0 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:true});function _export(target,all){for(var name in all)Object.defineProperty(target,name,{enumerable:true,get:all[name]})}_export(exports,{RedisStore:function(){return RedisStore},default:function(){return _default}});const _interop_require_default=require("@swc/helpers/_/_interop_require_default");const _scripts=_interop_require_default._(require("./scripts.js"));const toInt=input=>{if(typeof input==="number")return input;return Number.parseInt((input!=null?input:"").toString(),10)};const parseScriptResponse=results=>{if(!Array.isArray(results))throw new TypeError("Expected result to be array of values");if(results.length!==2)throw new Error(`Expected 2 replies, got ${results.length}`);const totalHits=results[0]===false?0:toInt(results[0]);const timeToExpire=toInt(results[1]);const resetTime=new Date(Date.now()+timeToExpire);return{totalHits,resetTime}};let RedisStore=class RedisStore{async loadIncrementScript(){const result=await this.sendCommand("SCRIPT","LOAD",_scripts.default.increment);if(typeof result!=="string"){throw new TypeError("unexpected reply from redis client")}return result}async loadGetScript(){const result=await this.sendCommand("SCRIPT","LOAD",_scripts.default.get);if(typeof result!=="string"){throw new TypeError("unexpected reply from redis client")}return result}async retryableIncrement(key){const evalCommand=async()=>this.sendCommand("EVALSHA",await this.incrementScriptSha,"1",this.prefixKey(key),this.resetExpiryOnChange?"1":"0",this.windowMs.toString());try{const result=await evalCommand();return result}catch(e){this.incrementScriptSha=this.loadIncrementScript();return evalCommand()}}prefixKey(key){return`${this.prefix}${key}`}init(options){this.windowMs=options.windowMs}async get(key){const results=await this.sendCommand("EVALSHA",await this.getScriptSha,"1",this.prefixKey(key));return parseScriptResponse(results)}async increment(key){const results=await this.retryableIncrement(key);return parseScriptResponse(results)}async decrement(key){await this.sendCommand("DECR",this.prefixKey(key))}async resetKey(key){await this.sendCommand("DEL",this.prefixKey(key))}constructor(options){this.sendCommand=options.sendCommand;var _options_prefix;this.prefix=(_options_prefix=options.prefix)!=null?_options_prefix:"rl:";var _options_resetExpiryOnChange;this.resetExpiryOnChange=(_options_resetExpiryOnChange=options.resetExpiryOnChange)!=null?_options_resetExpiryOnChange:false;this.incrementScriptSha=this.loadIncrementScript();this.getScriptSha=this.loadGetScript()}};const _default=RedisStore;

package/src/redis/types.d.ts

@@ -1,29 +0,0 @@
-/**
- * The type of data Redis might return to us.
- */
-type Data = boolean | number | string;
-export type RedisReply = Data | Data[];
-/**
- * The library sends Redis raw commands, so all we need to know are the
- * 'raw-command-sending' functions for each redis client.
- */
-export type SendCommandFn = (...args: string[]) => Promise<RedisReply>;
-/**
- * The configuration options for the store.
- */
-export type Options = {
-    /**
-     * The function used to send commands to Redis.
-     */
-    readonly sendCommand: SendCommandFn;
-    /**
-     * The text to prepend to the key in Redis.
-     */
-    readonly prefix?: string;
-    /**
-     * Whether to reset the expiry for a particular key whenever its hit count
-     * changes.
-     */
-    readonly resetExpiryOnChange?: boolean;
-};
-export {};

package/src/redis/types.js

@@ -1 +0,0 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:true});