hono-rate-limiter 0.1.2 → 0.2.0

package/README.md

@@ -34,7 +34,7 @@ app.use(limiter);
 
 # Data Stores
 
-Express-rate-limit supports external data stores to synchronize hit counts across multiple processes and servers.
+`hono-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 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.
 
@@ -51,7 +51,7 @@ Here is a list of stores:
 | [`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.                                                                                                                                  |
+| [`@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,6 +1,6 @@
 {
   "name": "hono-rate-limiter",
-  "version": "0.1.2",
+  "version": "0.2.0",
   "type": "module",
   "license": "MIT",
   "keywords": [
@@ -24,9 +24,6 @@
   "bugs": {
     "url": "https://github.com/rhinobase/hono-rate-limiter/issues"
   },
-  "dependencies": {
-    "@swc/helpers": "~0.5.2"
-  },
   "peerDependencies": {
     "hono": "^4.1.1"
   },

package/src/{core/index.d.ts → core.d.ts}

@@ -1,5 +1,5 @@
 import type { Env, Input } from "hono";
-import type { ConfigType } from "../types";
+import type { ConfigType } from "./types.js";
 /**
  *
  * Create an instance of IP rate-limiting middleware for Hono.

package/src/core.js

@@ -0,0 +1 @@
+import{createMiddleware}from"hono/factory";import{defaultKeyGenerator}from"./defaultKeyGenerator.js";import{setDraft6Headers,setDraft7Headers,setRetryAfterHeader}from"./headers.js";import MemoryStore from"./memoryStore.js";import{isValidStore}from"./validations.js";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/headers.d.ts → headers.d.ts}

@@ -1,5 +1,5 @@
 import type { Context } from "hono";
-import type { RateLimitInfo } from "../types";
+import type { RateLimitInfo } from "./types.js";
 /**
  * Sets `RateLimit-*`` headers based on the sixth draft of the IETF specification.
  * See https://datatracker.ietf.org/doc/html/draft-ietf-httpapi-ratelimit-headers-06.

package/src/index.d.ts

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

package/src/index.js

@@ -1 +1 @@
-export{rateLimiter as default,rateLimiter}from"./core";
+export{rateLimiter as default,rateLimiter}from"./core.js";

package/src/{memory-store/index.d.ts → memoryStore.d.ts}

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import type { ClientRateLimitInfo, ConfigType, Store } from "../types";
+import type { ClientRateLimitInfo, ConfigType, Store } from "./types.js";
 /**
  * The record that stores information about a client - namely, how many times
  * they have hit the endpoint, and when their hit count resets.

package/src/{types/config.d.ts → types.d.ts}

@@ -1,7 +1,26 @@
 import type { Context, Env, Input, Next } from "hono";
 import type { StatusCode } from "hono/utils/http-status";
-import type { Promisify } from "./promisify";
-import type { Store } from "./store";
+/**
+ * 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 type ClientRateLimitInfo = {
+    totalHits: number;
+    resetTime?: Date;
+};
+export type Promisify<T> = T | Promise<T>;
+/**
+ * The rate limit related information for each client included in the
+ * Hono context object.
+ */
+export type RateLimitInfo = {
+    limit: number;
+    used: number;
+    remaining: number;
+    resetTime: Date | undefined;
+};
 /**
  * Hono request handler that sends back a response when a client is
  * rate-limited.
@@ -110,3 +129,66 @@ export type ConfigType<E extends Env = any, P extends string = any, I extends In
      */
     store: Store;
 };
+export type IncrementResponse = ClientRateLimitInfo;
+/**
+ * An interface that all hit counter stores must implement.
+ */
+export type Store = {
+    /**
+     * Method that initializes the store, and has access to the options passed to
+     * the middleware too.
+     *
+     * @param options {ConfigType} - The options used to setup the middleware.
+     */
+    init?: (options: ConfigType) => void;
+    /**
+     * Method to fetch a client's hit count and reset time.
+     *
+     * @param key {string} - The identifier for a client.
+     *
+     * @returns {ClientRateLimitInfo} - The number of hits and reset time for that client.
+     */
+    get?: (key: string) => Promise<ClientRateLimitInfo | undefined> | ClientRateLimitInfo | undefined;
+    /**
+     * Method to increment a client's hit counter.
+     *
+     * @param key {string} - The identifier for a client.
+     *
+     * @returns {IncrementResponse | undefined} - 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;
+    /**
+     * Method to shutdown the store, stop timers, and release all resources.
+     */
+    shutdown?: () => Promise<void> | void;
+    /**
+     * Flag to indicate that keys incremented in one instance of this store can
+     * not affect other instances. Typically false if a database is used, true for
+     * MemoryStore.
+     *
+     * Used to help detect double-counting misconfigurations.
+     */
+    localKeys?: boolean;
+    /**
+     * 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
+     */
+    prefix?: string;
+};

package/src/{core/validations.d.ts → validations.d.ts}

@@ -1,2 +1,2 @@
-import type { Store } from "../types";
+import type { Store } from "./types";
 export declare const isValidStore: (value: Store) => value is Store;

package/src/core/index.js

@@ -1 +0,0 @@
-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/types/clientRateLimitInfo.d.ts

@@ -1,4 +0,0 @@
-export type ClientRateLimitInfo = {
-    totalHits: number;
-    resetTime?: Date;
-};

package/src/types/config.js

@@ -1 +0,0 @@
-export{};

package/src/types/index.d.ts

@@ -1,5 +0,0 @@
-export type * from "./store";
-export type * from "./promisify";
-export type * from "./config";
-export type * from "./clientRateLimitInfo";
-export type * from "./rateLimitInfo";

package/src/types/index.js

@@ -1 +0,0 @@
-export{};

package/src/types/promisify.d.ts

@@ -1 +0,0 @@
-export type Promisify<T> = T | Promise<T>;

package/src/types/promisify.js

@@ -1 +0,0 @@
-export{};

package/src/types/rateLimitExceededEventHandler.d.ts

@@ -1 +0,0 @@
-export {};

package/src/types/rateLimitExceededEventHandler.js

@@ -1 +0,0 @@
-export{};

package/src/types/rateLimitInfo.d.ts

@@ -1,10 +0,0 @@
-/**
- * The rate limit related information for each client included in the
- * Hono context object.
- */
-export type RateLimitInfo = {
-    limit: number;
-    used: number;
-    remaining: number;
-    resetTime: Date | undefined;
-};

package/src/types/rateLimitInfo.js

@@ -1 +0,0 @@
-export{};

package/src/types/store.d.ts

@@ -1,65 +0,0 @@
-import type { ClientRateLimitInfo } from "./clientRateLimitInfo";
-import type { ConfigType } from "./config";
-export type IncrementResponse = ClientRateLimitInfo;
-/**
- * An interface that all hit counter stores must implement.
- */
-export type Store = {
-    /**
-     * Method that initializes the store, and has access to the options passed to
-     * the middleware too.
-     *
-     * @param options {ConfigType} - The options used to setup the middleware.
-     */
-    init?: (options: ConfigType) => void;
-    /**
-     * Method to fetch a client's hit count and reset time.
-     *
-     * @param key {string} - The identifier for a client.
-     *
-     * @returns {ClientRateLimitInfo} - The number of hits and reset time for that client.
-     */
-    get?: (key: string) => Promise<ClientRateLimitInfo | undefined> | ClientRateLimitInfo | undefined;
-    /**
-     * Method to increment a client's hit counter.
-     *
-     * @param key {string} - The identifier for a client.
-     *
-     * @returns {IncrementResponse | undefined} - 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;
-    /**
-     * Method to shutdown the store, stop timers, and release all resources.
-     */
-    shutdown?: () => Promise<void> | void;
-    /**
-     * Flag to indicate that keys incremented in one instance of this store can
-     * not affect other instances. Typically false if a database is used, true for
-     * MemoryStore.
-     *
-     * Used to help detect double-counting misconfigurations.
-     */
-    localKeys?: boolean;
-    /**
-     * 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
-     */
-    prefix?: string;
-};

package/src/types/store.js

@@ -1 +0,0 @@
-export{};