hono-rate-limiter 0.1.3 → 0.2.0

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hono-rate-limiter",
-  "version": "0.1.3",
-  "type": "commonjs",
+  "version": "0.2.0",
+  "type": "module",
   "license": "MIT",
   "keywords": [
     "hono",
@@ -24,12 +24,10 @@
   "bugs": {
     "url": "https://github.com/rhinobase/hono-rate-limiter/issues"
   },
-  "dependencies": {
-    "@swc/helpers": "~0.5.2"
-  },
   "peerDependencies": {
     "hono": "^4.1.1"
   },
   "main": "./src/index.js",
-  "typings": "./src/index.d.ts"
+  "typings": "./src/index.d.ts",
+  "module": "./src/index.js"
 }

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/defaultKeyGenerator.js

@@ -0,0 +1 @@
+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.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/headers.js

@@ -0,0 +1 @@
+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/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 @@
-"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,{default:function(){return _core.rateLimiter},rateLimiter:function(){return _core.rateLimiter}});const _core=require("./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/memoryStore.js

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

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

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/validations.js

@@ -0,0 +1 @@
+export const isValidStore=value=>!!value?.increment;

package/src/core/defaultKeyGenerator.js

@@ -1 +0,0 @@
-"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??""}

package/src/core/headers.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,{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?.toString())};

package/src/core/index.js

@@ -1 +0,0 @@
-"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",requestStorePropertyName="rateLimitStore",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??{};const options={windowMs,limit,message,statusCode,standardHeaders,requestPropertyName,requestStorePropertyName,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);c.set(requestStorePropertyName,{getKey:store.get?.bind(store),resetKey:store.resetKey.bind(store)});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()}})}

package/src/core/validations.js

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

package/src/memory-store/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,{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){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}};const _default=MemoryStore;

package/src/types/clientRateLimitInfo.d.ts

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

package/src/types/clientRateLimitInfo.js

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

package/src/types/config.js

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

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 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:true});

package/src/types/promisify.d.ts

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

package/src/types/promisify.js

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

package/src/types/rateLimitExceededEventHandler.d.ts

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

package/src/types/rateLimitExceededEventHandler.js

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

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 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:true});

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 @@
-"use strict";Object.defineProperty(exports,"__esModule",{value:true});