@davaux/rate-limit 0.8.0 → 0.8.1

package/dist/index.d.ts

@@ -0,0 +1,64 @@
+import type { MiddlewareFn, RequestContext } from 'davaux';
+export interface RateLimitResult {
+    /** Total hits in the current window. */
+    count: number;
+    /** Unix timestamp (ms) when the current window resets. */
+    resetAt: number;
+}
+/**
+ * Backing store for rate limit counters. The default `MemoryStore` works for
+ * single-process deployments. Implement this interface and pass it via
+ * `options.store` to use Redis, Valkey, or any other backend.
+ */
+export interface RateLimitStore {
+    increment(key: string, windowMs: number): Promise<RateLimitResult>;
+}
+/** In-memory rate-limit counter store. Suitable for single-process deployments. */
+export declare class MemoryStore implements RateLimitStore {
+    private readonly hits;
+    increment(key: string, windowMs: number): Promise<RateLimitResult>;
+}
+export interface RateLimitOptions {
+    /** Time window in milliseconds. */
+    windowMs: number;
+    /** Maximum number of requests allowed per window per key. */
+    max: number;
+    /**
+     * Function that derives the rate-limit key from the request context.
+     * Default: the client's IP address (`req.socket.remoteAddress`).
+     */
+    keyFn?: (ctx: RequestContext) => string;
+    /**
+     * Body of the 429 response.
+     * Default: `'Too Many Requests'`
+     */
+    message?: string;
+    /**
+     * Backing store. Default: `MemoryStore` (suitable for single-process apps).
+     * Pass a custom implementation for Redis or other distributed stores.
+     */
+    store?: RateLimitStore;
+    /**
+     * When `true`, rate-limit headers are sent on every response, not just 429s.
+     * Default: `true`
+     */
+    headers?: boolean;
+    /**
+     * When `true`, the leftmost IP in `X-Forwarded-For` is used as the rate-limit
+     * key instead of `req.socket.remoteAddress`. Only enable when the app runs
+     * behind a trusted reverse proxy — clients can spoof this header otherwise.
+     * Default: `false`
+     */
+    trustProxy?: boolean;
+}
+/**
+ * Rate-limiting middleware. Counts requests per key within a rolling time
+ * window and returns `429 Too Many Requests` when the limit is exceeded.
+ * Standard `RateLimit-*` headers are sent on every response by default.
+ *
+ * @example
+ * import { rateLimit } from '@davaux/rate-limit'
+ * export default rateLimit({ windowMs: 60_000, max: 100 })
+ */
+export declare function rateLimit(options: RateLimitOptions): MiddlewareFn;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,cAAc,EAAE,MAAM,QAAQ,CAAA;AAI1D,MAAM,WAAW,eAAe;IAC9B,wCAAwC;IACxC,KAAK,EAAE,MAAM,CAAA;IACb,0DAA0D;IAC1D,OAAO,EAAE,MAAM,CAAA;CAChB;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAA;CACnE;AAID,mFAAmF;AACnF,qBAAa,WAAY,YAAW,cAAc;IAChD,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAqC;IAEpD,SAAS,CAAC,GAAG,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;CAazE;AAID,MAAM,WAAW,gBAAgB;IAC/B,mCAAmC;IACnC,QAAQ,EAAE,MAAM,CAAA;IAChB,6DAA6D;IAC7D,GAAG,EAAE,MAAM,CAAA;IACX;;;OAGG;IACH,KAAK,CAAC,EAAE,CAAC,GAAG,EAAE,cAAc,KAAK,MAAM,CAAA;IACvC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB;;;OAGG;IACH,KAAK,CAAC,EAAE,cAAc,CAAA;IACtB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB;;;;;OAKG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAID;;;;;;;;GAQG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,gBAAgB,GAAG,YAAY,CA2BjE"}

package/dist/index.js

@@ -0,0 +1,59 @@
+// ─── In-memory store ──────────────────────────────────────────────────────────
+/** In-memory rate-limit counter store. Suitable for single-process deployments. */
+export class MemoryStore {
+    hits = new Map();
+    async increment(key, windowMs) {
+        const now = Date.now();
+        const entry = this.hits.get(key);
+        if (!entry || now >= entry.resetAt) {
+            const result = { count: 1, resetAt: now + windowMs };
+            this.hits.set(key, result);
+            return result;
+        }
+        entry.count++;
+        return { count: entry.count, resetAt: entry.resetAt };
+    }
+}
+// ─── Middleware ───────────────────────────────────────────────────────────────
+/**
+ * Rate-limiting middleware. Counts requests per key within a rolling time
+ * window and returns `429 Too Many Requests` when the limit is exceeded.
+ * Standard `RateLimit-*` headers are sent on every response by default.
+ *
+ * @example
+ * import { rateLimit } from '@davaux/rate-limit'
+ * export default rateLimit({ windowMs: 60_000, max: 100 })
+ */
+export function rateLimit(options) {
+    const store = options.store ?? new MemoryStore();
+    const keyFn = options.keyFn ?? ((ctx) => defaultKey(ctx, options.trustProxy));
+    const message = options.message ?? 'Too Many Requests';
+    const sendHeaders = options.headers !== false;
+    return async (ctx, next) => {
+        const key = keyFn(ctx);
+        const { count, resetAt } = await store.increment(key, options.windowMs);
+        const remaining = Math.max(0, options.max - count);
+        const resetSecs = Math.ceil((resetAt - Date.now()) / 1000);
+        if (sendHeaders) {
+            ctx.res.setHeader('RateLimit-Limit', String(options.max));
+            ctx.res.setHeader('RateLimit-Remaining', String(remaining));
+            ctx.res.setHeader('RateLimit-Reset', String(resetSecs));
+        }
+        if (count > options.max) {
+            ctx.res.setHeader('Retry-After', String(resetSecs));
+            ctx.res.writeHead(429, { 'Content-Type': 'text/plain; charset=utf-8' });
+            ctx.res.end(message);
+            return;
+        }
+        await next();
+    };
+}
+function defaultKey(ctx, trustProxy) {
+    if (trustProxy) {
+        const xff = ctx.req.headers['x-forwarded-for'];
+        if (xff)
+            return xff.split(',')[0].trim();
+    }
+    return ctx.req.socket.remoteAddress ?? 'unknown';
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAoBA,iFAAiF;AAEjF,mFAAmF;AACnF,MAAM,OAAO,WAAW;IACL,IAAI,GAAG,IAAI,GAAG,EAA2B,CAAA;IAE1D,KAAK,CAAC,SAAS,CAAC,GAAW,EAAE,QAAgB;QAC3C,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAA;QACtB,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAA;QAEhC,IAAI,CAAC,KAAK,IAAI,GAAG,IAAI,KAAK,CAAC,OAAO,EAAE,CAAC;YACnC,MAAM,MAAM,GAAoB,EAAE,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,GAAG,GAAG,QAAQ,EAAE,CAAA;YACrE,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAA;YAC1B,OAAO,MAAM,CAAA;QACf,CAAC;QAED,KAAK,CAAC,KAAK,EAAE,CAAA;QACb,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,KAAK,EAAE,OAAO,EAAE,KAAK,CAAC,OAAO,EAAE,CAAA;IACvD,CAAC;CACF;AAsCD,iFAAiF;AAEjF;;;;;;;;GAQG;AACH,MAAM,UAAU,SAAS,CAAC,OAAyB;IACjD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,IAAI,WAAW,EAAE,CAAA;IAChD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,UAAU,CAAC,GAAG,EAAE,OAAO,CAAC,UAAU,CAAC,CAAC,CAAA;IAC7E,MAAM,OAAO,GAAG,OAAO,CAAC,OAAO,IAAI,mBAAmB,CAAA;IACtD,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,KAAK,KAAK,CAAA;IAE7C,OAAO,KAAK,EAAE,GAAG,EAAE,IAAI,EAAE,EAAE;QACzB,MAAM,GAAG,GAAG,KAAK,CAAC,GAAG,CAAC,CAAA;QACtB,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,MAAM,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE,OAAO,CAAC,QAAQ,CAAC,CAAA;QACvE,MAAM,SAAS,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,CAAC,GAAG,GAAG,KAAK,CAAC,CAAA;QAClD,MAAM,SAAS,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,OAAO,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC,GAAG,IAAI,CAAC,CAAA;QAE1D,IAAI,WAAW,EAAE,CAAC;YAChB,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,iBAAiB,EAAE,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAA;YACzD,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,qBAAqB,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAA;YAC3D,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,iBAAiB,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAA;QACzD,CAAC;QAED,IAAI,KAAK,GAAG,OAAO,CAAC,GAAG,EAAE,CAAC;YACxB,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,aAAa,EAAE,MAAM,CAAC,SAAS,CAAC,CAAC,CAAA;YACnD,GAAG,CAAC,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,cAAc,EAAE,2BAA2B,EAAE,CAAC,CAAA;YACvE,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAA;YACpB,OAAM;QACR,CAAC;QAED,MAAM,IAAI,EAAE,CAAA;IACd,CAAC,CAAA;AACH,CAAC;AAED,SAAS,UAAU,CAAC,GAAmB,EAAE,UAAoB;IAC3D,IAAI,UAAU,EAAE,CAAC;QACf,MAAM,GAAG,GAAG,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,iBAAiB,CAAuB,CAAA;QACpE,IAAI,GAAG;YAAE,OAAO,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,EAAE,CAAA;IAC1C,CAAC;IACD,OAAO,GAAG,CAAC,GAAG,CAAC,MAAM,CAAC,aAAa,IAAI,SAAS,CAAA;AAClD,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@davaux/rate-limit",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "description": "Rate limiting middleware for Davaux",
   "type": "module",
   "author": "David L Dyess II",
@@ -13,6 +13,9 @@
     "url": "https://codeberg.org/davaux/davaux/issues"
   },
   "homepage": "https://codeberg.org/davaux/davaux#readme",
+  "files": [
+    "dist"
+  ],
   "exports": {
     ".": {
       "import": "./dist/index.js",
@@ -24,11 +27,11 @@
     "typecheck": "tsc --noEmit"
   },
   "peerDependencies": {
-    "davaux": ">=0.8.0"
+    "davaux": ">=0.8.1"
   },
   "devDependencies": {
     "@types/node": "^25.0.0",
     "davaux": "*",
     "typescript": "^6.0.3"
   }
-}
+}

package/CLAUDE.md

@@ -1,95 +0,0 @@
-<!-- pka-generated -->
-# @davaux/rate-limit
-
-> Generated by Project Knowledge Analyzer on 2026-06-06T21:53:10.395Z
-
-## Overview
-
-Rate limiting middleware for Davaux
-
-**Version**: 0.8.0
-**Author**: David L Dyess II
-**License**: MIT
-**Repository**: https://codeberg.org/davaux/davaux#readme
-
-## Tech Stack
-
-- **Language**: TypeScript
-- **Module System**: ESM (`type: module`)
-
-## Commands
-
-- `npm run build` — tsc
-- `npm run typecheck` — tsc --noEmit
-
-## Project Structure
-
-```
-├── CLAUDE.md
-├── README.md
-├── package.json
-├── tsconfig.json
-└── src/
-    └── index.ts
-
-```
-
-## Entry Points
-
-- `src/index.ts`
-
-## Files by Type
-
-### Documentation (2)
-- `CLAUDE.md`
-- `README.md`
-
-### Config (2)
-- `package.json`
-- `tsconfig.json`
-
-### Module (1)
-- `src/index.ts`
-
-
-## Git
-- **Branch**: main
-- **Last Commit**: chore: Add alpha status note to README
-- **Author**: David Dyess II
-- **Date**: 2026-06-06 15:52:27 -0600
-- **Remote**: https://codeberg.org/davaux/davaux.git
-
-### Recent Commits
-```
-f527031 chore: Add alpha status note to README
-90c819e chore: Add repo info to package.json files
-b200d9d feat(davaux)!: Add OmlCacheConfig - opt-in with includes option or opt-out with excludes option; Fix OML implementation to follow OML spec - use output instead of return
-3bce0c2 chore: Update and add READMEs to packages; update ROADMAP
-fc27c20 fix(davaux): Remove old dist folder on new builds; fix server port per DavauxConfig
-c760659 feat(davaux): Add minify CSS in production builds
-c899ab8 fix(davaux): Added method JS and JSX extenstion to scanner
-7d99f04 feat(davaux): Add support for declarative partial updates
-3b47f37 chore: Bump package versions to 0.8.0
-aa0460f chore: Add CHANGELOG.md
-```
-
-## Dependencies
-
-
-### Development
-@types/node, davaux, typescript
-
-
-
-
-
-
-
-
-
-## Exported Symbols
-
-**`src/index.ts`**
-`MemoryStore`, `rateLimit`, `RateLimitResult`, `RateLimitStore`, `RateLimitOptions`
-
-

package/src/index.ts

@@ -1,124 +0,0 @@
-import type { MiddlewareFn, RequestContext } from 'davaux'
-
-// ─── Store interface ───────────────────────────────────────────────────────────
-
-export interface RateLimitResult {
-  /** Total hits in the current window. */
-  count: number
-  /** Unix timestamp (ms) when the current window resets. */
-  resetAt: number
-}
-
-/**
- * Backing store for rate limit counters. The default `MemoryStore` works for
- * single-process deployments. Implement this interface and pass it via
- * `options.store` to use Redis, Valkey, or any other backend.
- */
-export interface RateLimitStore {
-  increment(key: string, windowMs: number): Promise<RateLimitResult>
-}
-
-// ─── In-memory store ──────────────────────────────────────────────────────────
-
-/** In-memory rate-limit counter store. Suitable for single-process deployments. */
-export class MemoryStore implements RateLimitStore {
-  private readonly hits = new Map<string, RateLimitResult>()
-
-  async increment(key: string, windowMs: number): Promise<RateLimitResult> {
-    const now = Date.now()
-    const entry = this.hits.get(key)
-
-    if (!entry || now >= entry.resetAt) {
-      const result: RateLimitResult = { count: 1, resetAt: now + windowMs }
-      this.hits.set(key, result)
-      return result
-    }
-
-    entry.count++
-    return { count: entry.count, resetAt: entry.resetAt }
-  }
-}
-
-// ─── Options ──────────────────────────────────────────────────────────────────
-
-export interface RateLimitOptions {
-  /** Time window in milliseconds. */
-  windowMs: number
-  /** Maximum number of requests allowed per window per key. */
-  max: number
-  /**
-   * Function that derives the rate-limit key from the request context.
-   * Default: the client's IP address (`req.socket.remoteAddress`).
-   */
-  keyFn?: (ctx: RequestContext) => string
-  /**
-   * Body of the 429 response.
-   * Default: `'Too Many Requests'`
-   */
-  message?: string
-  /**
-   * Backing store. Default: `MemoryStore` (suitable for single-process apps).
-   * Pass a custom implementation for Redis or other distributed stores.
-   */
-  store?: RateLimitStore
-  /**
-   * When `true`, rate-limit headers are sent on every response, not just 429s.
-   * Default: `true`
-   */
-  headers?: boolean
-  /**
-   * When `true`, the leftmost IP in `X-Forwarded-For` is used as the rate-limit
-   * key instead of `req.socket.remoteAddress`. Only enable when the app runs
-   * behind a trusted reverse proxy — clients can spoof this header otherwise.
-   * Default: `false`
-   */
-  trustProxy?: boolean
-}
-
-// ─── Middleware ───────────────────────────────────────────────────────────────
-
-/**
- * Rate-limiting middleware. Counts requests per key within a rolling time
- * window and returns `429 Too Many Requests` when the limit is exceeded.
- * Standard `RateLimit-*` headers are sent on every response by default.
- *
- * @example
- * import { rateLimit } from '@davaux/rate-limit'
- * export default rateLimit({ windowMs: 60_000, max: 100 })
- */
-export function rateLimit(options: RateLimitOptions): MiddlewareFn {
-  const store = options.store ?? new MemoryStore()
-  const keyFn = options.keyFn ?? ((ctx) => defaultKey(ctx, options.trustProxy))
-  const message = options.message ?? 'Too Many Requests'
-  const sendHeaders = options.headers !== false
-
-  return async (ctx, next) => {
-    const key = keyFn(ctx)
-    const { count, resetAt } = await store.increment(key, options.windowMs)
-    const remaining = Math.max(0, options.max - count)
-    const resetSecs = Math.ceil((resetAt - Date.now()) / 1000)
-
-    if (sendHeaders) {
-      ctx.res.setHeader('RateLimit-Limit', String(options.max))
-      ctx.res.setHeader('RateLimit-Remaining', String(remaining))
-      ctx.res.setHeader('RateLimit-Reset', String(resetSecs))
-    }
-
-    if (count > options.max) {
-      ctx.res.setHeader('Retry-After', String(resetSecs))
-      ctx.res.writeHead(429, { 'Content-Type': 'text/plain; charset=utf-8' })
-      ctx.res.end(message)
-      return
-    }
-
-    await next()
-  }
-}
-
-function defaultKey(ctx: RequestContext, trustProxy?: boolean): string {
-  if (trustProxy) {
-    const xff = ctx.req.headers['x-forwarded-for'] as string | undefined
-    if (xff) return xff.split(',')[0].trim()
-  }
-  return ctx.req.socket.remoteAddress ?? 'unknown'
-}

package/tsconfig.json

@@ -1,17 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ESNext",
-    "module": "NodeNext",
-    "moduleResolution": "NodeNext",
-    "strict": true,
-    "declaration": true,
-    "declarationMap": true,
-    "sourceMap": true,
-    "outDir": "./dist",
-    "rootDir": "./src",
-    "skipLibCheck": true,
-    "lib": ["ESNext"],
-    "types": ["node"]
-  },
-  "include": ["src/**/*"]
-}