@jellyfungus/hono-rate-limiter 0.1.0 → 0.3.0

package/dist/websocket.js

@@ -0,0 +1,151 @@
+// src/index.ts
+var MemoryStore = class {
+  entries = /* @__PURE__ */ new Map();
+  windowMs = 6e4;
+  cleanupTimer;
+  init(windowMs) {
+    this.windowMs = windowMs;
+    this.cleanupTimer = setInterval(() => {
+      const now = Date.now();
+      for (const [key, entry] of this.entries) {
+        if (entry.reset <= now) {
+          this.entries.delete(key);
+        }
+      }
+    }, 6e4);
+    if (typeof this.cleanupTimer.unref === "function") {
+      this.cleanupTimer.unref();
+    }
+  }
+  increment(key) {
+    const now = Date.now();
+    const existing = this.entries.get(key);
+    if (!existing || existing.reset <= now) {
+      const reset = now + this.windowMs;
+      this.entries.set(key, { count: 1, reset });
+      return { count: 1, reset };
+    }
+    existing.count++;
+    return { count: existing.count, reset: existing.reset };
+  }
+  get(key) {
+    const entry = this.entries.get(key);
+    if (!entry || entry.reset <= Date.now()) {
+      return void 0;
+    }
+    return { count: entry.count, reset: entry.reset };
+  }
+  decrement(key) {
+    const entry = this.entries.get(key);
+    if (entry && entry.count > 0) {
+      entry.count--;
+    }
+  }
+  resetKey(key) {
+    this.entries.delete(key);
+  }
+  resetAll() {
+    this.entries.clear();
+  }
+  shutdown() {
+    if (this.cleanupTimer) {
+      clearInterval(this.cleanupTimer);
+    }
+    this.entries.clear();
+  }
+};
+
+// src/websocket.ts
+async function checkSlidingWindow(store, key, limit, windowMs) {
+  const now = Date.now();
+  const currentWindowStart = Math.floor(now / windowMs) * windowMs;
+  const previousWindowStart = currentWindowStart - windowMs;
+  const previousKey = `ws:${key}:${previousWindowStart}`;
+  const currentKey = `ws:${key}:${currentWindowStart}`;
+  const current = await store.increment(currentKey);
+  let previousCount = 0;
+  if (store.get) {
+    const prev = await store.get(previousKey);
+    previousCount = prev?.count ?? 0;
+  }
+  const elapsedMs = now - currentWindowStart;
+  const weight = (windowMs - elapsedMs) / windowMs;
+  const estimatedCount = Math.floor(previousCount * weight) + current.count;
+  const remaining = Math.max(0, limit - estimatedCount);
+  const allowed = estimatedCount <= limit;
+  const reset = currentWindowStart + windowMs;
+  return {
+    allowed,
+    info: { limit, remaining, reset }
+  };
+}
+async function checkFixedWindow(store, key, limit, windowMs) {
+  const now = Date.now();
+  const windowStart = Math.floor(now / windowMs) * windowMs;
+  const windowKey = `ws:${key}:${windowStart}`;
+  const { count, reset } = await store.increment(windowKey);
+  const remaining = Math.max(0, limit - count);
+  const allowed = count <= limit;
+  return {
+    allowed,
+    info: { limit, remaining, reset }
+  };
+}
+var wsDefaultStore;
+function webSocketLimiter(options) {
+  const {
+    limit = 100,
+    windowMs = 6e4,
+    algorithm = "sliding-window",
+    store = wsDefaultStore ??= new MemoryStore(),
+    keyGenerator,
+    handler = (ws, info) => {
+      const retryAfter = Math.ceil((info.reset - Date.now()) / 1e3);
+      ws.close(1008, `Rate limit exceeded. Retry after ${retryAfter}s`);
+    },
+    skip
+  } = options;
+  let initialized = false;
+  return (createEvents) => {
+    return async (c) => {
+      if (!initialized && store.init) {
+        await store.init(windowMs);
+        initialized = true;
+      }
+      const key = await keyGenerator(c);
+      const currentLimit = typeof limit === "function" ? await limit(c) : limit;
+      const events = await createEvents(c);
+      return {
+        ...events,
+        onMessage: async (event, ws) => {
+          if (skip) {
+            const shouldSkip = await skip(event, ws);
+            if (shouldSkip) {
+              await events.onMessage?.(event, ws);
+              return;
+            }
+          }
+          const { allowed, info } = algorithm === "sliding-window" ? await checkSlidingWindow(store, key, currentLimit, windowMs) : await checkFixedWindow(store, key, currentLimit, windowMs);
+          if (!allowed) {
+            handler(ws, info);
+            return;
+          }
+          await events.onMessage?.(event, ws);
+        },
+        onOpen: async (event, ws) => {
+          await events.onOpen?.(event, ws);
+        },
+        onClose: async (event, ws) => {
+          await events.onClose?.(event, ws);
+        },
+        onError: async (event, ws) => {
+          await events.onError?.(event, ws);
+        }
+      };
+    };
+  };
+}
+export {
+  webSocketLimiter
+};
+//# sourceMappingURL=websocket.js.map

package/dist/websocket.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../src/websocket.ts"],"sourcesContent":["/**\n * @module\n * Rate Limit Middleware for Hono.\n */\n\nimport type { Context, Env, MiddlewareHandler } from \"hono\";\n\n// ============================================================================\n// Types\n// ============================================================================\n\n/**\n * Rate limit information for a single request\n */\nexport type RateLimitInfo = {\n  /** Maximum requests allowed in window */\n  limit: number;\n  /** Remaining requests in current window */\n  remaining: number;\n  /** Unix timestamp (ms) when window resets */\n  reset: number;\n};\n\n/**\n * Result from store increment operation\n */\nexport type StoreResult = {\n  /** Current request count in window */\n  count: number;\n  /** When the window resets (Unix timestamp ms) */\n  reset: number;\n};\n\n/**\n * Quota unit for IETF standard headers.\n * @see https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/\n */\nexport type QuotaUnit = \"requests\" | \"content-bytes\" | \"concurrent-requests\";\n\n/**\n * Header format options.\n *\n * ## \"legacy\" (default)\n * Common X-RateLimit-* headers used by GitHub, Twitter, and most APIs:\n * - `X-RateLimit-Limit`: max requests in window\n * - `X-RateLimit-Remaining`: remaining requests\n * - `X-RateLimit-Reset`: Unix timestamp (seconds) when window resets\n *\n * ## \"draft-6\"\n * IETF draft-06 format with individual RateLimit-* headers:\n * - `RateLimit-Policy`: policy description (e.g., `100;w=60`)\n * - `RateLimit-Limit`: max requests\n * - `RateLimit-Remaining`: remaining requests\n * - `RateLimit-Reset`: seconds until reset\n *\n * ## \"draft-7\"\n * IETF draft-07 format with combined RateLimit header:\n * - `RateLimit-Policy`: policy description\n * - `RateLimit`: combined (e.g., `limit=100, remaining=50, reset=30`)\n *\n * ## \"standard\"\n * Current IETF draft-08+ format with structured field values (RFC 9651):\n * - `RateLimit-Policy`: `\"name\";q=100;w=60`\n * - `RateLimit`: `\"name\";r=50;t=30`\n *\n * ## false\n * Disable all rate limit headers.\n *\n * @see https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/\n */\nexport type HeadersFormat =\n  | \"legacy\" // X-RateLimit-* headers (GitHub/Twitter style)\n  | \"draft-6\" // IETF draft-06: individual RateLimit-* headers\n  | \"draft-7\" // IETF draft-07: combined RateLimit header\n  | \"standard\" // IETF draft-08+: structured field format (current)\n  | false; // Disable headers\n\n/**\n * Rate limit algorithm\n */\nexport type Algorithm = \"fixed-window\" | \"sliding-window\";\n\n/**\n * Store interface for rate limit state\n */\nexport type RateLimitStore = {\n  /**\n   * Initialize store. Called once before first use.\n   */\n  init?: (windowMs: number) => void | Promise<void>;\n\n  /**\n   * Increment counter for key and return current state.\n   */\n  increment: (key: string) => StoreResult | Promise<StoreResult>;\n\n  /**\n   * Decrement counter for key.\n   */\n  decrement?: (key: string) => void | Promise<void>;\n\n  /**\n   * Reset a specific key.\n   */\n  resetKey: (key: string) => void | Promise<void>;\n\n  /**\n   * Reset all keys.\n   */\n  resetAll?: () => void | Promise<void>;\n\n  /**\n   * Get current state for key.\n   */\n  get?: (\n    key: string,\n  ) => StoreResult | Promise<StoreResult | undefined> | undefined;\n\n  /**\n   * Graceful shutdown.\n   */\n  shutdown?: () => void | Promise<void>;\n};\n\n/**\n * Store access interface exposed in context\n */\nexport type RateLimitStoreAccess = {\n  /** Get rate limit info for a key */\n  getKey: (\n    key: string,\n  ) => StoreResult | Promise<StoreResult | undefined> | undefined;\n  /** Reset rate limit for a key */\n  resetKey: (key: string) => void | Promise<void>;\n};\n\n/**\n * Options for rate limit middleware\n */\nexport type RateLimitOptions<E extends Env = Env> = {\n  /**\n   * Maximum requests allowed in the time window.\n   * @default 60\n   */\n  limit?: number | ((c: Context<E>) => number | Promise<number>);\n\n  /**\n   * Time window in milliseconds.\n   * @default 60000 (1 minute)\n   */\n  windowMs?: number;\n\n  /**\n   * Rate limiting algorithm.\n   * @default 'sliding-window'\n   */\n  algorithm?: Algorithm;\n\n  /**\n   * Storage backend for rate limit state.\n   * @default MemoryStore\n   */\n  store?: RateLimitStore;\n\n  /**\n   * Generate unique key for each client.\n   * @default IP address from headers\n   */\n  keyGenerator?: (c: Context<E>) => string | Promise<string>;\n\n  /**\n   * Handler called when rate limit is exceeded.\n   */\n  handler?: (\n    c: Context<E>,\n    info: RateLimitInfo,\n  ) => Response | Promise<Response>;\n\n  /**\n   * HTTP header format to use.\n   *\n   * - \"legacy\": X-RateLimit-* headers (GitHub/Twitter style, default)\n   * - \"draft-6\": IETF draft-06 individual headers\n   * - \"draft-7\": IETF draft-07 combined header\n   * - \"standard\": IETF draft-08+ structured fields (current spec)\n   * - false: Disable headers\n   *\n   * @default 'legacy'\n   */\n  headers?: HeadersFormat;\n\n  /**\n   * Policy identifier for IETF headers (draft-6+).\n   * Used in RateLimit and RateLimit-Policy headers.\n   * @default 'default'\n   */\n  identifier?: string;\n\n  /**\n   * Quota unit for IETF standard headers.\n   * Only included in \"standard\" format when not \"requests\".\n   * @default 'requests'\n   */\n  quotaUnit?: QuotaUnit;\n\n  /**\n   * Skip rate limiting for certain requests.\n   */\n  skip?: (c: Context<E>) => boolean | Promise<boolean>;\n\n  /**\n   * Don't count successful (2xx) requests against limit.\n   * @default false\n   */\n  skipSuccessfulRequests?: boolean;\n\n  /**\n   * Don't count failed (4xx, 5xx) requests against limit.\n   * @default false\n   */\n  skipFailedRequests?: boolean;\n\n  /**\n   * Callback when a request is rate limited.\n   */\n  onRateLimited?: (c: Context<E>, info: RateLimitInfo) => void | Promise<void>;\n};\n\n/**\n * Cloudflare Rate Limiting binding interface\n */\nexport type RateLimitBinding = {\n  limit: (options: { key: string }) => Promise<{ success: boolean }>;\n};\n\n/**\n * Options for Cloudflare Rate Limiting binding\n */\nexport type CloudflareRateLimitOptions<E extends Env = Env> = {\n  /**\n   * Cloudflare Rate Limiting binding from env\n   */\n  binding: RateLimitBinding | ((c: Context<E>) => RateLimitBinding);\n\n  /**\n   * Generate unique key for each client.\n   */\n  keyGenerator: (c: Context<E>) => string | Promise<string>;\n\n  /**\n   * Handler called when rate limit is exceeded.\n   */\n  handler?: (c: Context<E>) => Response | Promise<Response>;\n\n  /**\n   * Skip rate limiting for certain requests.\n   */\n  skip?: (c: Context<E>) => boolean | Promise<boolean>;\n};\n\n// ============================================================================\n// Context Variable Type Extension\n// ============================================================================\n\ndeclare module \"hono\" {\n  interface ContextVariableMap {\n    rateLimit?: RateLimitInfo;\n    rateLimitStore?: RateLimitStoreAccess;\n  }\n}\n\n// ============================================================================\n// Memory Store\n// ============================================================================\n\ntype MemoryEntry = {\n  count: number;\n  reset: number;\n};\n\n/**\n * In-memory store for rate limiting.\n * Suitable for single-instance deployments.\n */\nexport class MemoryStore implements RateLimitStore {\n  private entries = new Map<string, MemoryEntry>();\n  private windowMs = 60_000;\n  private cleanupTimer?: ReturnType<typeof setInterval>;\n\n  init(windowMs: number): void {\n    this.windowMs = windowMs;\n\n    // Cleanup expired entries every minute\n    this.cleanupTimer = setInterval(() => {\n      const now = Date.now();\n      for (const [key, entry] of this.entries) {\n        if (entry.reset <= now) {\n          this.entries.delete(key);\n        }\n      }\n    }, 60_000);\n\n    // Don't keep process alive for cleanup\n    if (typeof this.cleanupTimer.unref === \"function\") {\n      this.cleanupTimer.unref();\n    }\n  }\n\n  increment(key: string): StoreResult {\n    const now = Date.now();\n    const existing = this.entries.get(key);\n\n    if (!existing || existing.reset <= now) {\n      // New window\n      const reset = now + this.windowMs;\n      this.entries.set(key, { count: 1, reset });\n      return { count: 1, reset };\n    }\n\n    // Increment existing\n    existing.count++;\n    return { count: existing.count, reset: existing.reset };\n  }\n\n  get(key: string): StoreResult | undefined {\n    const entry = this.entries.get(key);\n    if (!entry || entry.reset <= Date.now()) {\n      return undefined;\n    }\n    return { count: entry.count, reset: entry.reset };\n  }\n\n  decrement(key: string): void {\n    const entry = this.entries.get(key);\n    if (entry && entry.count > 0) {\n      entry.count--;\n    }\n  }\n\n  resetKey(key: string): void {\n    this.entries.delete(key);\n  }\n\n  resetAll(): void {\n    this.entries.clear();\n  }\n\n  shutdown(): void {\n    if (this.cleanupTimer) {\n      clearInterval(this.cleanupTimer);\n    }\n    this.entries.clear();\n  }\n}\n\n// Singleton default store\nlet defaultStore: MemoryStore | undefined;\n\n// ============================================================================\n// Header Generation\n// ============================================================================\n\n/**\n * Set rate limit response headers based on the configured format.\n *\n * @see https://datatracker.ietf.org/doc/draft-ietf-httpapi-ratelimit-headers/\n */\nfunction setHeaders(\n  c: Context,\n  info: RateLimitInfo,\n  format: HeadersFormat,\n  windowMs: number,\n  identifier: string,\n  quotaUnit: QuotaUnit,\n): void {\n  if (format === false) {\n    return;\n  }\n\n  const windowSeconds = Math.ceil(windowMs / 1000);\n  const resetSeconds = Math.max(0, Math.ceil((info.reset - Date.now()) / 1000));\n\n  switch (format) {\n    case \"standard\":\n      // IETF draft-08+ (current): Structured field values per RFC 9651\n      // RateLimit-Policy: describes the quota policy\n      // Format: \"name\";q=<quota>;w=<window>[;qu=\"<unit>\"]\n      {\n        let policy = `\"${identifier}\";q=${info.limit};w=${windowSeconds}`;\n        if (quotaUnit !== \"requests\") {\n          policy += `;qu=\"${quotaUnit}\"`;\n        }\n        c.header(\"RateLimit-Policy\", policy);\n        // RateLimit: describes current service limits\n        // Format: \"name\";r=<remaining>;t=<reset>\n        c.header(\n          \"RateLimit\",\n          `\"${identifier}\";r=${info.remaining};t=${resetSeconds}`,\n        );\n      }\n      break;\n\n    case \"draft-7\":\n      // IETF draft-07: Combined RateLimit header with comma-separated values\n      c.header(\"RateLimit-Policy\", `${info.limit};w=${windowSeconds}`);\n      c.header(\n        \"RateLimit\",\n        `limit=${info.limit}, remaining=${info.remaining}, reset=${resetSeconds}`,\n      );\n      break;\n\n    case \"draft-6\":\n      // IETF draft-06: Individual RateLimit-* headers\n      c.header(\"RateLimit-Policy\", `${info.limit};w=${windowSeconds}`);\n      c.header(\"RateLimit-Limit\", String(info.limit));\n      c.header(\"RateLimit-Remaining\", String(info.remaining));\n      c.header(\"RateLimit-Reset\", String(resetSeconds));\n      break;\n\n    case \"legacy\":\n    default:\n      // Common X-RateLimit-* headers (GitHub, Twitter, most APIs)\n      // Uses Unix timestamp for reset (seconds since epoch)\n      c.header(\"X-RateLimit-Limit\", String(info.limit));\n      c.header(\"X-RateLimit-Remaining\", String(info.remaining));\n      c.header(\"X-RateLimit-Reset\", String(Math.ceil(info.reset / 1000)));\n      break;\n  }\n}\n\n// ============================================================================\n// Default Key Generator\n// ============================================================================\n\nfunction getClientIP(c: Context): string {\n  // Platform-specific headers (most reliable)\n  const cfIP = c.req.header(\"cf-connecting-ip\");\n  if (cfIP) {\n    return cfIP;\n  }\n\n  const xRealIP = c.req.header(\"x-real-ip\");\n  if (xRealIP) {\n    return xRealIP;\n  }\n\n  // X-Forwarded-For - take first IP\n  const xff = c.req.header(\"x-forwarded-for\");\n  if (xff) {\n    return xff.split(\",\")[0].trim();\n  }\n\n  return \"unknown\";\n}\n\n// ============================================================================\n// Default Handler\n// ============================================================================\n\nfunction createDefaultResponse(info: RateLimitInfo): Response {\n  const retryAfter = Math.max(0, Math.ceil((info.reset - Date.now()) / 1000));\n\n  return new Response(\"Rate limit exceeded\", {\n    status: 429,\n    headers: {\n      \"Content-Type\": \"text/plain\",\n      \"Retry-After\": String(retryAfter),\n    },\n  });\n}\n\n// ============================================================================\n// Sliding Window Algorithm\n// ============================================================================\n\nasync function checkSlidingWindow(\n  store: RateLimitStore,\n  key: string,\n  limit: number,\n  windowMs: number,\n): Promise<{ allowed: boolean; info: RateLimitInfo }> {\n  const now = Date.now();\n  const currentWindowStart = Math.floor(now / windowMs) * windowMs;\n  const previousWindowStart = currentWindowStart - windowMs;\n\n  const previousKey = `${key}:${previousWindowStart}`;\n  const currentKey = `${key}:${currentWindowStart}`;\n\n  // Increment current window\n  const current = await store.increment(currentKey);\n\n  // Get previous window (may not exist)\n  let previousCount = 0;\n  if (store.get) {\n    const prev = await store.get(previousKey);\n    previousCount = prev?.count ?? 0;\n  }\n\n  // Cloudflare's weighted formula\n  const elapsedMs = now - currentWindowStart;\n  const weight = (windowMs - elapsedMs) / windowMs;\n  const estimatedCount = Math.floor(previousCount * weight) + current.count;\n\n  const remaining = Math.max(0, limit - estimatedCount);\n  const allowed = estimatedCount <= limit;\n  const reset = currentWindowStart + windowMs;\n\n  return {\n    allowed,\n    info: { limit, remaining, reset },\n  };\n}\n\n// ============================================================================\n// Fixed Window Algorithm\n// ============================================================================\n\nasync function checkFixedWindow(\n  store: RateLimitStore,\n  key: string,\n  limit: number,\n  windowMs: number,\n): Promise<{ allowed: boolean; info: RateLimitInfo }> {\n  const now = Date.now();\n  const windowStart = Math.floor(now / windowMs) * windowMs;\n  const windowKey = `${key}:${windowStart}`;\n\n  const { count, reset } = await store.increment(windowKey);\n\n  const remaining = Math.max(0, limit - count);\n  const allowed = count <= limit;\n\n  return {\n    allowed,\n    info: { limit, remaining, reset },\n  };\n}\n\n// ============================================================================\n// Main Middleware\n// ============================================================================\n\n/**\n * Rate Limit Middleware for Hono.\n *\n * @param {RateLimitOptions} [options] - Configuration options\n * @returns {MiddlewareHandler} Middleware handler\n *\n * @example\n * ```ts\n * import { Hono } from 'hono'\n * import { rateLimiter } from '@jellyfungus/hono-rate-limiter'\n *\n * const app = new Hono()\n *\n * // Basic usage - 60 requests per minute\n * app.use(rateLimiter())\n *\n * // Custom configuration\n * app.use('/api/*', rateLimiter({\n *   limit: 100,\n *   windowMs: 60 * 1000,\n * }))\n * ```\n */\nexport const rateLimiter = <E extends Env = Env>(\n  options?: RateLimitOptions<E>,\n): MiddlewareHandler<E> => {\n  // Merge with defaults\n  const opts = {\n    limit: 60 as number | ((c: Context<E>) => number | Promise<number>),\n    windowMs: 60_000,\n    algorithm: \"sliding-window\" as Algorithm,\n    store: undefined as RateLimitStore | undefined,\n    keyGenerator: getClientIP as (c: Context<E>) => string | Promise<string>,\n    handler: undefined as\n      | ((c: Context<E>, info: RateLimitInfo) => Response | Promise<Response>)\n      | undefined,\n    headers: \"legacy\" as HeadersFormat,\n    identifier: \"default\",\n    quotaUnit: \"requests\" as QuotaUnit,\n    skip: undefined as\n      | ((c: Context<E>) => boolean | Promise<boolean>)\n      | undefined,\n    skipSuccessfulRequests: false,\n    skipFailedRequests: false,\n    onRateLimited: undefined as\n      | ((c: Context<E>, info: RateLimitInfo) => void | Promise<void>)\n      | undefined,\n    ...options,\n  };\n\n  // Use default store if none provided\n  const store = opts.store ?? (defaultStore ??= new MemoryStore());\n\n  // Track initialization\n  let initialized = false;\n\n  return async function rateLimiter(c, next) {\n    // Initialize store on first request\n    if (!initialized && store.init) {\n      await store.init(opts.windowMs);\n      initialized = true;\n    }\n\n    // Check if should skip\n    if (opts.skip) {\n      const shouldSkip = await opts.skip(c);\n      if (shouldSkip) {\n        return next();\n      }\n    }\n\n    // Generate key\n    const key = await opts.keyGenerator(c);\n\n    // Get limit (may be dynamic)\n    const limit =\n      typeof opts.limit === \"function\" ? await opts.limit(c) : opts.limit;\n\n    // Check rate limit\n    const { allowed, info } =\n      opts.algorithm === \"sliding-window\"\n        ? await checkSlidingWindow(store, key, limit, opts.windowMs)\n        : await checkFixedWindow(store, key, limit, opts.windowMs);\n\n    // Set context variable for downstream middleware\n    c.set(\"rateLimit\", info);\n\n    // Expose store access in context\n    c.set(\"rateLimitStore\", {\n      getKey: store.get?.bind(store) ?? (() => undefined),\n      resetKey: store.resetKey.bind(store),\n    });\n\n    // Set headers\n    setHeaders(\n      c,\n      info,\n      opts.headers,\n      opts.windowMs,\n      opts.identifier,\n      opts.quotaUnit,\n    );\n\n    // Handle rate limited\n    if (!allowed) {\n      // Fire callback\n      if (opts.onRateLimited) {\n        await opts.onRateLimited(c, info);\n      }\n\n      // Custom handler or default\n      if (opts.handler) {\n        return opts.handler(c, info);\n      }\n      return createDefaultResponse(info);\n    }\n\n    // Continue\n    await next();\n\n    // Handle skip options after response\n    if (opts.skipSuccessfulRequests || opts.skipFailedRequests) {\n      const status = c.res.status;\n      const shouldDecrement =\n        (opts.skipSuccessfulRequests && status >= 200 && status < 300) ||\n        (opts.skipFailedRequests && status >= 400);\n\n      if (shouldDecrement && store.decrement) {\n        const windowStart =\n          Math.floor(Date.now() / opts.windowMs) * opts.windowMs;\n        const windowKey = `${key}:${windowStart}`;\n        await store.decrement(windowKey);\n      }\n    }\n  };\n};\n\n// ============================================================================\n// Cloudflare Rate Limiting Binding Middleware\n// ============================================================================\n\n/**\n * Rate limiter using Cloudflare's built-in Rate Limiting binding.\n *\n * This uses Cloudflare's globally distributed rate limiting infrastructure,\n * which is ideal for high-traffic applications.\n *\n * @example\n * ```ts\n * import { cloudflareRateLimiter } from '@jellyfungus/hono-rate-limiter'\n *\n * type Bindings = { RATE_LIMITER: RateLimitBinding }\n *\n * const app = new Hono<{ Bindings: Bindings }>()\n *\n * app.use(cloudflareRateLimiter({\n *   binding: (c) => c.env.RATE_LIMITER,\n *   keyGenerator: (c) => c.req.header('cf-connecting-ip') ?? 'unknown',\n * }))\n * ```\n */\nexport const cloudflareRateLimiter = <E extends Env = Env>(\n  options: CloudflareRateLimitOptions<E>,\n): MiddlewareHandler<E> => {\n  const { binding, keyGenerator, handler, skip } = options;\n\n  return async function cloudflareRateLimiter(c, next) {\n    // Check if should skip\n    if (skip) {\n      const shouldSkip = await skip(c);\n      if (shouldSkip) {\n        return next();\n      }\n    }\n\n    // Get binding (may be dynamic)\n    const rateLimitBinding =\n      typeof binding === \"function\" ? binding(c) : binding;\n\n    // Generate key\n    const key = await keyGenerator(c);\n\n    // Check rate limit\n    const { success } = await rateLimitBinding.limit({ key });\n\n    if (!success) {\n      if (handler) {\n        return handler(c);\n      }\n      return new Response(\"Rate limit exceeded\", {\n        status: 429,\n        headers: { \"Content-Type\": \"text/plain\" },\n      });\n    }\n\n    return next();\n  };\n};\n\n// ============================================================================\n// Exports\n// ============================================================================\n\nexport { getClientIP };\n","/**\n * @module\n * WebSocket Rate Limiting for Hono.\n */\n\nimport type { Context, Env } from \"hono\";\nimport type { WSContext, WSEvents } from \"hono/ws\";\nimport {\n  MemoryStore,\n  type RateLimitStore,\n  type RateLimitInfo,\n  type StoreResult,\n  type Algorithm,\n} from \"./index\";\n\n// ============================================================================\n// Types\n// ============================================================================\n\n/**\n * Options for WebSocket rate limiting\n */\nexport type WSRateLimitOptions<E extends Env = Env> = {\n  /**\n   * Maximum messages allowed in the time window.\n   * @default 100\n   */\n  limit?: number | ((c: Context<E>) => number | Promise<number>);\n\n  /**\n   * Time window in milliseconds.\n   * @default 60000 (1 minute)\n   */\n  windowMs?: number;\n\n  /**\n   * Rate limiting algorithm.\n   * @default 'sliding-window'\n   */\n  algorithm?: Algorithm;\n\n  /**\n   * Storage backend for rate limit state.\n   * @default MemoryStore\n   */\n  store?: RateLimitStore;\n\n  /**\n   * Generate unique key for each client.\n   * Required for WebSocket rate limiting.\n   */\n  keyGenerator: (c: Context<E>) => string | Promise<string>;\n\n  /**\n   * Handler called when rate limit is exceeded.\n   * Default: closes connection with code 1008.\n   */\n  handler?: (ws: WSContext, info: RateLimitInfo) => void;\n\n  /**\n   * Skip rate limiting for certain messages.\n   */\n  skip?: (event: MessageEvent, ws: WSContext) => boolean | Promise<boolean>;\n};\n\n// ============================================================================\n// Sliding Window Algorithm (adapted for WS)\n// ============================================================================\n\nasync function checkSlidingWindow(\n  store: RateLimitStore,\n  key: string,\n  limit: number,\n  windowMs: number,\n): Promise<{ allowed: boolean; info: RateLimitInfo }> {\n  const now = Date.now();\n  const currentWindowStart = Math.floor(now / windowMs) * windowMs;\n  const previousWindowStart = currentWindowStart - windowMs;\n\n  const previousKey = `ws:${key}:${previousWindowStart}`;\n  const currentKey = `ws:${key}:${currentWindowStart}`;\n\n  // Increment current window\n  const current = await store.increment(currentKey);\n\n  // Get previous window (may not exist)\n  let previousCount = 0;\n  if (store.get) {\n    const prev = await store.get(previousKey);\n    previousCount = prev?.count ?? 0;\n  }\n\n  // Cloudflare's weighted formula\n  const elapsedMs = now - currentWindowStart;\n  const weight = (windowMs - elapsedMs) / windowMs;\n  const estimatedCount = Math.floor(previousCount * weight) + current.count;\n\n  const remaining = Math.max(0, limit - estimatedCount);\n  const allowed = estimatedCount <= limit;\n  const reset = currentWindowStart + windowMs;\n\n  return {\n    allowed,\n    info: { limit, remaining, reset },\n  };\n}\n\n// ============================================================================\n// Fixed Window Algorithm (adapted for WS)\n// ============================================================================\n\nasync function checkFixedWindow(\n  store: RateLimitStore,\n  key: string,\n  limit: number,\n  windowMs: number,\n): Promise<{ allowed: boolean; info: RateLimitInfo }> {\n  const now = Date.now();\n  const windowStart = Math.floor(now / windowMs) * windowMs;\n  const windowKey = `ws:${key}:${windowStart}`;\n\n  const { count, reset } = await store.increment(windowKey);\n\n  const remaining = Math.max(0, limit - count);\n  const allowed = count <= limit;\n\n  return {\n    allowed,\n    info: { limit, remaining, reset },\n  };\n}\n\n// ============================================================================\n// WebSocket Rate Limiter\n// ============================================================================\n\n// Singleton default store for WebSocket\nlet wsDefaultStore: MemoryStore | undefined;\n\n/**\n * WebSocket rate limiting middleware for Hono.\n *\n * Wraps your WebSocket event handlers to add rate limiting on messages.\n *\n * @example\n * ```ts\n * import { Hono } from 'hono'\n * import { createBunWebSocket } from 'hono/bun'\n * import { webSocketLimiter } from '@jellyfungus/hono-rate-limiter/websocket'\n *\n * const { upgradeWebSocket, websocket } = createBunWebSocket()\n *\n * const app = new Hono()\n *\n * const wsLimiter = webSocketLimiter({\n *   limit: 100,\n *   windowMs: 60_000,\n *   keyGenerator: (c) => c.req.header('cf-connecting-ip') ?? 'unknown',\n * })\n *\n * app.get('/ws', upgradeWebSocket(wsLimiter((c) => ({\n *   onMessage(event, ws) {\n *     ws.send('Hello!')\n *   },\n * }))))\n *\n * export default { port: 3000, fetch: app.fetch, websocket }\n * ```\n */\nexport function webSocketLimiter<E extends Env = Env>(\n  options: WSRateLimitOptions<E>,\n): (\n  createEvents: (c: Context<E>) => WSEvents | Promise<WSEvents>,\n) => (c: Context<E>) => Promise<WSEvents> {\n  const {\n    limit = 100,\n    windowMs = 60_000,\n    algorithm = \"sliding-window\",\n    store = (wsDefaultStore ??= new MemoryStore()),\n    keyGenerator,\n    handler = (ws, info) => {\n      const retryAfter = Math.ceil((info.reset - Date.now()) / 1000);\n      ws.close(1008, `Rate limit exceeded. Retry after ${retryAfter}s`);\n    },\n    skip,\n  } = options;\n\n  // Track initialization\n  let initialized = false;\n\n  return (createEvents: (c: Context<E>) => WSEvents | Promise<WSEvents>) => {\n    return async (c: Context<E>): Promise<WSEvents> => {\n      // Initialize store on first use\n      if (!initialized && store.init) {\n        await store.init(windowMs);\n        initialized = true;\n      }\n\n      // Get the key for this connection\n      const key = await keyGenerator(c);\n\n      // Get the limit (may be dynamic)\n      const currentLimit = typeof limit === \"function\" ? await limit(c) : limit;\n\n      // Get the original events\n      const events = await createEvents(c);\n\n      return {\n        ...events,\n\n        onMessage: async (event, ws) => {\n          // Check if should skip\n          if (skip) {\n            const shouldSkip = await skip(event, ws);\n            if (shouldSkip) {\n              await events.onMessage?.(event, ws);\n              return;\n            }\n          }\n\n          // Check rate limit\n          const { allowed, info } =\n            algorithm === \"sliding-window\"\n              ? await checkSlidingWindow(store, key, currentLimit, windowMs)\n              : await checkFixedWindow(store, key, currentLimit, windowMs);\n\n          if (!allowed) {\n            handler(ws, info);\n            return;\n          }\n\n          // Call original handler\n          await events.onMessage?.(event, ws);\n        },\n\n        onOpen: async (event, ws) => {\n          await events.onOpen?.(event, ws);\n        },\n\n        onClose: async (event, ws) => {\n          await events.onClose?.(event, ws);\n        },\n\n        onError: async (event, ws) => {\n          await events.onError?.(event, ws);\n        },\n      };\n    };\n  };\n}\n"],"mappings":";AA4RO,IAAM,cAAN,MAA4C;AAAA,EACzC,UAAU,oBAAI,IAAyB;AAAA,EACvC,WAAW;AAAA,EACX;AAAA,EAER,KAAK,UAAwB;AAC3B,SAAK,WAAW;AAGhB,SAAK,eAAe,YAAY,MAAM;AACpC,YAAM,MAAM,KAAK,IAAI;AACrB,iBAAW,CAAC,KAAK,KAAK,KAAK,KAAK,SAAS;AACvC,YAAI,MAAM,SAAS,KAAK;AACtB,eAAK,QAAQ,OAAO,GAAG;AAAA,QACzB;AAAA,MACF;AAAA,IACF,GAAG,GAAM;AAGT,QAAI,OAAO,KAAK,aAAa,UAAU,YAAY;AACjD,WAAK,aAAa,MAAM;AAAA,IAC1B;AAAA,EACF;AAAA,EAEA,UAAU,KAA0B;AAClC,UAAM,MAAM,KAAK,IAAI;AACrB,UAAM,WAAW,KAAK,QAAQ,IAAI,GAAG;AAErC,QAAI,CAAC,YAAY,SAAS,SAAS,KAAK;AAEtC,YAAM,QAAQ,MAAM,KAAK;AACzB,WAAK,QAAQ,IAAI,KAAK,EAAE,OAAO,GAAG,MAAM,CAAC;AACzC,aAAO,EAAE,OAAO,GAAG,MAAM;AAAA,IAC3B;AAGA,aAAS;AACT,WAAO,EAAE,OAAO,SAAS,OAAO,OAAO,SAAS,MAAM;AAAA,EACxD;AAAA,EAEA,IAAI,KAAsC;AACxC,UAAM,QAAQ,KAAK,QAAQ,IAAI,GAAG;AAClC,QAAI,CAAC,SAAS,MAAM,SAAS,KAAK,IAAI,GAAG;AACvC,aAAO;AAAA,IACT;AACA,WAAO,EAAE,OAAO,MAAM,OAAO,OAAO,MAAM,MAAM;AAAA,EAClD;AAAA,EAEA,UAAU,KAAmB;AAC3B,UAAM,QAAQ,KAAK,QAAQ,IAAI,GAAG;AAClC,QAAI,SAAS,MAAM,QAAQ,GAAG;AAC5B,YAAM;AAAA,IACR;AAAA,EACF;AAAA,EAEA,SAAS,KAAmB;AAC1B,SAAK,QAAQ,OAAO,GAAG;AAAA,EACzB;AAAA,EAEA,WAAiB;AACf,SAAK,QAAQ,MAAM;AAAA,EACrB;AAAA,EAEA,WAAiB;AACf,QAAI,KAAK,cAAc;AACrB,oBAAc,KAAK,YAAY;AAAA,IACjC;AACA,SAAK,QAAQ,MAAM;AAAA,EACrB;AACF;;;AC5RA,eAAe,mBACb,OACA,KACA,OACA,UACoD;AACpD,QAAM,MAAM,KAAK,IAAI;AACrB,QAAM,qBAAqB,KAAK,MAAM,MAAM,QAAQ,IAAI;AACxD,QAAM,sBAAsB,qBAAqB;AAEjD,QAAM,cAAc,MAAM,GAAG,IAAI,mBAAmB;AACpD,QAAM,aAAa,MAAM,GAAG,IAAI,kBAAkB;AAGlD,QAAM,UAAU,MAAM,MAAM,UAAU,UAAU;AAGhD,MAAI,gBAAgB;AACpB,MAAI,MAAM,KAAK;AACb,UAAM,OAAO,MAAM,MAAM,IAAI,WAAW;AACxC,oBAAgB,MAAM,SAAS;AAAA,EACjC;AAGA,QAAM,YAAY,MAAM;AACxB,QAAM,UAAU,WAAW,aAAa;AACxC,QAAM,iBAAiB,KAAK,MAAM,gBAAgB,MAAM,IAAI,QAAQ;AAEpE,QAAM,YAAY,KAAK,IAAI,GAAG,QAAQ,cAAc;AACpD,QAAM,UAAU,kBAAkB;AAClC,QAAM,QAAQ,qBAAqB;AAEnC,SAAO;AAAA,IACL;AAAA,IACA,MAAM,EAAE,OAAO,WAAW,MAAM;AAAA,EAClC;AACF;AAMA,eAAe,iBACb,OACA,KACA,OACA,UACoD;AACpD,QAAM,MAAM,KAAK,IAAI;AACrB,QAAM,cAAc,KAAK,MAAM,MAAM,QAAQ,IAAI;AACjD,QAAM,YAAY,MAAM,GAAG,IAAI,WAAW;AAE1C,QAAM,EAAE,OAAO,MAAM,IAAI,MAAM,MAAM,UAAU,SAAS;AAExD,QAAM,YAAY,KAAK,IAAI,GAAG,QAAQ,KAAK;AAC3C,QAAM,UAAU,SAAS;AAEzB,SAAO;AAAA,IACL;AAAA,IACA,MAAM,EAAE,OAAO,WAAW,MAAM;AAAA,EAClC;AACF;AAOA,IAAI;AAgCG,SAAS,iBACd,SAGwC;AACxC,QAAM;AAAA,IACJ,QAAQ;AAAA,IACR,WAAW;AAAA,IACX,YAAY;AAAA,IACZ,QAAS,mBAAmB,IAAI,YAAY;AAAA,IAC5C;AAAA,IACA,UAAU,CAAC,IAAI,SAAS;AACtB,YAAM,aAAa,KAAK,MAAM,KAAK,QAAQ,KAAK,IAAI,KAAK,GAAI;AAC7D,SAAG,MAAM,MAAM,oCAAoC,UAAU,GAAG;AAAA,IAClE;AAAA,IACA;AAAA,EACF,IAAI;AAGJ,MAAI,cAAc;AAElB,SAAO,CAAC,iBAAkE;AACxE,WAAO,OAAO,MAAqC;AAEjD,UAAI,CAAC,eAAe,MAAM,MAAM;AAC9B,cAAM,MAAM,KAAK,QAAQ;AACzB,sBAAc;AAAA,MAChB;AAGA,YAAM,MAAM,MAAM,aAAa,CAAC;AAGhC,YAAM,eAAe,OAAO,UAAU,aAAa,MAAM,MAAM,CAAC,IAAI;AAGpE,YAAM,SAAS,MAAM,aAAa,CAAC;AAEnC,aAAO;AAAA,QACL,GAAG;AAAA,QAEH,WAAW,OAAO,OAAO,OAAO;AAE9B,cAAI,MAAM;AACR,kBAAM,aAAa,MAAM,KAAK,OAAO,EAAE;AACvC,gBAAI,YAAY;AACd,oBAAM,OAAO,YAAY,OAAO,EAAE;AAClC;AAAA,YACF;AAAA,UACF;AAGA,gBAAM,EAAE,SAAS,KAAK,IACpB,cAAc,mBACV,MAAM,mBAAmB,OAAO,KAAK,cAAc,QAAQ,IAC3D,MAAM,iBAAiB,OAAO,KAAK,cAAc,QAAQ;AAE/D,cAAI,CAAC,SAAS;AACZ,oBAAQ,IAAI,IAAI;AAChB;AAAA,UACF;AAGA,gBAAM,OAAO,YAAY,OAAO,EAAE;AAAA,QACpC;AAAA,QAEA,QAAQ,OAAO,OAAO,OAAO;AAC3B,gBAAM,OAAO,SAAS,OAAO,EAAE;AAAA,QACjC;AAAA,QAEA,SAAS,OAAO,OAAO,OAAO;AAC5B,gBAAM,OAAO,UAAU,OAAO,EAAE;AAAA,QAClC;AAAA,QAEA,SAAS,OAAO,OAAO,OAAO;AAC5B,gBAAM,OAAO,UAAU,OAAO,EAAE;AAAA,QAClC;AAAA,MACF;AAAA,IACF;AAAA,EACF;AACF;","names":[]}

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@jellyfungus/hono-rate-limiter",
-  "version": "0.1.0",
-  "description": "Rate limiting middleware for Hono web framework",
+  "version": "0.3.0",
+  "description": "Production-ready rate limiting middleware for Hono web framework",
   "type": "module",
   "main": "./dist/index.cjs",
   "module": "./dist/index.js",
@@ -21,6 +21,11 @@
       "types": "./dist/store/cloudflare-kv.d.ts",
       "import": "./dist/store/cloudflare-kv.js",
       "require": "./dist/store/cloudflare-kv.cjs"
+    },
+    "./websocket": {
+      "types": "./dist/websocket.d.ts",
+      "import": "./dist/websocket.js",
+      "require": "./dist/websocket.cjs"
     }
   },
   "files": [
@@ -43,7 +48,9 @@
     "workers",
     "deno",
     "bun",
-    "node"
+    "node",
+    "sliding-window",
+    "websocket"
   ],
   "author": "",
   "license": "MIT",