limitly 2.0.0 → 3.0.0

package/README.md

@@ -12,6 +12,12 @@ npm install limitly ioredis
 # Memcached backend
 npm install limitly memcached
 
+# OpenTelemetry
+npm install limitly ioredis @opentelemetry/api
+
+# Prometheus
+npm install limitly ioredis prom-client
+
 # NestJS
 npm install limitly ioredis @nestjs/common @nestjs/core
 ```
@@ -39,14 +45,7 @@ const app = express();
 const redis = new Redis();
 const limiter = createLimiter({ redis });
 
-app.use(
-  limiter.middleware({
-    algorithm: "sliding-window",
-    limit: 100,
-    window: 60,
-    key: (req) => req.ip,
-  }),
-);
+app.use(limiter.middleware({ key: (req) => req.ip }));
 ```
 
 ### Fastify
@@ -77,15 +76,7 @@ import { createLimiter } from "limitly";
 const app = new Hono();
 const limiter = createLimiter({ redis: new Redis() });
 
-app.use(
-  "*",
-  limiter.honoMiddleware({
-    algorithm: "sliding-window",
-    limit: 100,
-    window: 60,
-    key: (c) => c.req.header("x-api-key"),
-  })
-);
+app.use("*", limiter.honoMiddleware({ key: (c) => c.req.header("x-api-key") }));
 ```
 
 ### Koa
@@ -98,14 +89,7 @@ import { createLimiter } from "limitly";
 const app = new Koa();
 const limiter = createLimiter({ redis: new Redis() });
 
-app.use(
-  limiter.koaMiddleware({
-    algorithm: "sliding-window",
-    limit: 100,
-    window: 60,
-    key: (ctx) => ctx.ip,
-  })
-);
+app.use(limiter.koaMiddleware({ key: (ctx) => ctx.ip }));
 ```
 
 ### Bun
@@ -117,9 +101,6 @@ import { composeBunHandler, createLimiter } from "limitly";
 const limiter = createLimiter({ redis: new Redis() });
 
 const rateLimit = limiter.bunMiddleware({
-  algorithm: "sliding-window",
-  limit: 100,
-  window: 60,
   key: (req) => req.headers.get("x-api-key"),
 });
 
@@ -142,7 +123,6 @@ import { RateLimit } from "limitly/nest";
 
 const limiter = createLimiter({ redis: new Redis() });
 const NestGuard = limiter.nestGuard({
-  algorithm: "sliding-window",
   limit: 100,
   window: 60,
   key: (req) => req.ip,
@@ -163,7 +143,7 @@ import { RateLimit } from "limitly/nest";
 @Controller("api")
 export class ApiController {
   @Get()
-  @RateLimit({ algorithm: "sliding-window", limit: 10, window: 60 })
+  @RateLimit({ limit: 10, window: 60 })
   findAll() {
     return { ok: true };
   }
@@ -191,7 +171,7 @@ export class AppModule {}
 
 ## Default Algorithm
 
-If you omit algorithm options, limitly uses **sliding-window** with `limit: 100` and `window: 60`:
+If you omit algorithm options, limitly uses **GCRA** with `limit: 100` and `window: 60`:
 
 ```typescript
 const limiter = createLimiter({ redis: new Redis() });
@@ -201,7 +181,7 @@ app.use(limiter.middleware({ key: (req) => req.ip }));
 // equivalent to:
 app.use(
   limiter.middleware({
-    algorithm: "sliding-window",
+    algorithm: "gcra",
     limit: 100,
     window: 60,
     key: (req) => req.ip,
@@ -226,7 +206,6 @@ Use `limiter.check()` outside middleware — useful for login guards, background
 
 ```typescript
 const result = await limiter.check(req.ip ?? "unknown", {
-  algorithm: "sliding-window",
   limit: 5,
   window: 10,
 });
@@ -243,6 +222,20 @@ if (!result.allowed) {
 
 ## Algorithms
 
+### GCRA (default)
+
+Generic Cell Rate Algorithm — smooth rate limiting with controlled bursts. Uses a single TAT (theoretical arrival time) per key, so it's memory-efficient compared to sliding window:
+
+```typescript
+limiter.middleware({
+  limit: 100,
+  window: 60, // seconds — algorithm defaults to gcra
+  key: (req) => req.ip,
+});
+```
+
+GCRA enforces an average rate of `limit / window` while allowing short bursts up to `limit`. Ideal when you want token-bucket-like behavior with predictable storage costs.
+
 ### Sliding Window
 
 Uses Redis Sorted Sets (or Memcached counters) for rate limiting over a rolling time window.
@@ -267,6 +260,45 @@ limiter.middleware({
 });
 ```
 
+### Concurrency
+
+Limits simultaneous in-flight requests per key. Slots are acquired on entry and released when the response finishes (middleware handles this automatically):
+
+```typescript
+limiter.middleware({
+  algorithm: "concurrency",
+  limit: 10, // max concurrent requests
+  ttl: 300, // lease TTL in seconds for stale slot cleanup
+  key: (req) => req.ip,
+});
+```
+
+For manual acquire/release outside middleware:
+
+```typescript
+const acquired = await limiter.acquire("job-42", {
+  algorithm: "concurrency",
+  limit: 5,
+  ttl: 120,
+});
+
+if (!acquired.allowed) {
+  throw new Error("Too many concurrent jobs");
+}
+
+try {
+  await runJob();
+} finally {
+  await limiter.release("job-42", acquired.slotId!, {
+    algorithm: "concurrency",
+    limit: 5,
+    ttl: 120,
+  });
+}
+```
+
+Storage keys use the `cc:` prefix: `{keyPrefix}:cc:{id}`.
+
 ## Storage Backends
 
 limitly supports Redis, Valkey, DragonflyDB (Redis-compatible), and Memcached.
@@ -287,13 +319,35 @@ createLimiter({ store: "valkey", redis: "redis://localhost:6379" });
 // DragonflyDB
 createLimiter({ store: "dragonfly", redis: { host: "localhost", port: 6379 } });
 
-// Cluster
+// Cluster (auto-pipelining, script warmup, master reads)
 createLimiter({
   store: "redis",
+  redis: {
+    nodes: [
+      { host: "127.0.0.1", port: 7000 },
+      { host: "127.0.0.1", port: 7001 },
+    ],
+    options: {
+      redisOptions: { password: "secret" },
+    },
+  },
+});
+
+// Optional: pin all keys to one slot (use only when you need co-location)
+createLimiter({
   redis: { nodes: [{ host: "127.0.0.1", port: 7000 }] },
+  hashTag: "limitly",
 });
 ```
 
+Cluster optimizations built into limitly:
+
+- **ioredis `defineCommand`** — Lua scripts are registered cluster-aware, avoiding per-node `NOSCRIPT` fallbacks
+- **Script warmup** — scripts are preloaded on all master nodes at startup (disable with `warmupScripts: false`)
+- **Auto-pipelining** — enabled by default for higher throughput under concurrent load
+- **Hash tags** — optional `hashTag` for slot pinning; leave unset to spread keys across slots (recommended)
+- **Master reads** — `scaleReads: "master"` by default so checks always hit the authoritative node
+
 ### Memcached
 
 Memcached uses counter-based sliding window and CAS token bucket (no Lua required):
@@ -349,6 +403,8 @@ Key format:
 ```
 {keyPrefix}:sw:{id}   — sliding window
 {keyPrefix}:tb:{id}   — token bucket
+{keyPrefix}:gcra:{id} — GCRA
+{keyPrefix}:cc:{id}   — concurrency
 ```
 
 ## Response Headers
@@ -368,9 +424,6 @@ Disable with `headers: false`.
 
 ```typescript
 limiter.middleware({
-  algorithm: "sliding-window",
-  limit: 100,
-  window: 60,
   onLimitReached(req, res) {
     res.status(429).json({ code: "RATE_LIMITED" });
   },
@@ -391,9 +444,6 @@ const limiter = createLimiter({
 
 // Per-route override
 limiter.middleware({
-  algorithm: "sliding-window",
-  limit: 100,
-  window: 60,
   onMetrics: (event) => metrics.increment(`ratelimit.${event.type}`),
 });
 ```
@@ -417,6 +467,123 @@ onMetrics: [logToConsole, sendToDatadog]
 
 `limiter.check()` and all framework middleware use the same metrics pipeline.
 
+## OpenTelemetry
+
+Use the `limitly/otel` helpers to emit OTEL metrics and traces. Only `@opentelemetry/api` is required — bring your own SDK/exporter:
+
+```typescript
+import Redis from "ioredis";
+import { createLimiter } from "limitly";
+import { createOpenTelemetryInstrumentation } from "limitly/otel";
+
+const otel = createOpenTelemetryInstrumentation();
+
+const limiter = createLimiter({
+  redis: new Redis(),
+  tracer: otel.tracer,
+  onMetrics: otel.onMetrics,
+});
+
+app.use(limiter.middleware({ key: (req) => req.ip }));
+```
+
+`createOpenTelemetryInstrumentation()` returns:
+
+- **`tracer`** — creates `limitly.check` spans with `limitly.algorithm`, `limitly.store`, `limitly.outcome`, `limitly.limit`, and `limitly.remaining` attributes
+- **`onMetrics`** — records `limitly.check.total` (counter) and `limitly.check.duration` (histogram, ms)
+
+Use the pieces independently when needed:
+
+```typescript
+import {
+  createOpenTelemetryMetricsHook,
+  createOpenTelemetryTracer,
+} from "limitly/otel";
+
+const limiter = createLimiter({
+  redis: new Redis(),
+  tracer: createOpenTelemetryTracer(),
+  onMetrics: createOpenTelemetryMetricsHook({ includeKey: false }),
+});
+```
+
+Combine with custom hooks:
+
+```typescript
+onMetrics: [otel.onMetrics, customHook]
+```
+
+## Prometheus
+
+Use `limitly/prometheus` to expose rate limit metrics for scraping:
+
+```typescript
+import express from "express";
+import Redis from "ioredis";
+import { createLimiter } from "limitly";
+import {
+  createPrometheusExporter,
+  createPrometheusHandler,
+} from "limitly/prometheus";
+
+const app = express();
+const prometheus = createPrometheusExporter();
+
+const limiter = createLimiter({
+  redis: new Redis(),
+  onMetrics: prometheus.onMetrics,
+});
+
+app.use(limiter.middleware({ key: (req) => req.ip }));
+app.get("/metrics", createPrometheusHandler(prometheus));
+```
+
+Metrics exposed:
+
+| Metric | Type | Labels |
+|--------|------|--------|
+| `limitly_check_total` | Counter | `algorithm`, `outcome`, `store` |
+| `limitly_check_duration_seconds` | Histogram | `algorithm`, `outcome`, `store` |
+
+`outcome` is one of `allowed`, `blocked`, `error`, or `fail_open`.
+
+Options:
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `register` | new `Registry` | Prometheus registry |
+| `prefix` | `"limitly"` | Metric name prefix |
+| `includeKey` | `false` | Add rate limit key as a label (high cardinality) |
+| `durationBuckets` | `[0.001, 0.005, 0.01, …, 1]` | Histogram buckets (seconds) |
+
+Use a shared registry with your existing metrics:
+
+```typescript
+import { Registry } from "prom-client";
+
+const register = new Registry();
+const prometheus = createPrometheusExporter({ register });
+
+onMetrics: [prometheus.onMetrics, otherHook];
+```
+
+Scrape manually without HTTP middleware:
+
+```typescript
+const body = await prometheus.getMetrics();
+```
+
+Use `createPrometheusMetricsHook` when you only need the `onMetrics` hook without the HTTP handler:
+
+```typescript
+import { createPrometheusMetricsHook } from "limitly/prometheus";
+
+const limiter = createLimiter({
+  redis: new Redis(),
+  onMetrics: createPrometheusMetricsHook({ prefix: "api" }),
+});
+```
+
 ## Fail Open / Closed
 
 When Redis is unavailable:
@@ -436,9 +603,12 @@ Implement custom algorithms with the `RateLimitStrategy` interface:
 ```typescript
 interface RateLimitStrategy {
   consume(key: string): Promise<RateLimitResult>;
+  release?(key: string, slotId: string): Promise<void>;
 }
 ```
 
+`release` is optional — only needed for concurrency-style strategies that hold a slot until the response finishes.
+
 ## Performance
 
 - Atomic operations via Lua scripts (`EVALSHA`)

package/dist/algorithms/concurrency.d.ts

@@ -0,0 +1,11 @@
+import type { ConcurrencyConfig, RateLimitResult, RateLimitStrategy } from "../types";
+import type { RateLimitStore } from "../stores/types";
+export declare class ConcurrencyStrategy implements RateLimitStrategy {
+    private readonly store;
+    private readonly limit;
+    private readonly ttl;
+    constructor(store: RateLimitStore, config: ConcurrencyConfig);
+    consume(key: string): Promise<RateLimitResult>;
+    release(key: string, slotId: string): Promise<void>;
+}
+//# sourceMappingURL=concurrency.d.ts.map

package/dist/algorithms/concurrency.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"concurrency.d.ts","sourceRoot":"","sources":["../../src/algorithms/concurrency.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EAClB,MAAM,UAAU,CAAC;AAClB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAGtD,qBAAa,mBAAoB,YAAW,iBAAiB;IAC3D,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAiB;IACvC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAS;gBAEjB,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,iBAAiB;IAMtD,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;IAI9C,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;CAG1D"}

package/dist/algorithms/concurrency.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConcurrencyStrategy = void 0;
+const defaults_1 = require("../utils/defaults");
+class ConcurrencyStrategy {
+    constructor(store, config) {
+        this.store = store;
+        this.limit = config.limit;
+        this.ttl = config.ttl ?? defaults_1.DEFAULT_CONCURRENCY.ttl;
+    }
+    async consume(key) {
+        return this.store.concurrencyAcquire(key, this.limit, this.ttl);
+    }
+    async release(key, slotId) {
+        await this.store.concurrencyRelease(key, slotId);
+    }
+}
+exports.ConcurrencyStrategy = ConcurrencyStrategy;
+//# sourceMappingURL=concurrency.js.map

package/dist/algorithms/concurrency.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"concurrency.js","sourceRoot":"","sources":["../../src/algorithms/concurrency.ts"],"names":[],"mappings":";;;AAMA,gDAAwD;AAExD,MAAa,mBAAmB;IAK9B,YAAY,KAAqB,EAAE,MAAyB;QAC1D,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAC1B,IAAI,CAAC,GAAG,GAAG,MAAM,CAAC,GAAG,IAAI,8BAAmB,CAAC,GAAI,CAAC;IACpD,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,GAAW;QACvB,OAAO,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC;IAClE,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,GAAW,EAAE,MAAc;QACvC,MAAM,IAAI,CAAC,KAAK,CAAC,kBAAkB,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACnD,CAAC;CACF;AAlBD,kDAkBC"}

package/dist/algorithms/factory.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../src/algorithms/factory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AACnE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAItD,wBAAgB,cAAc,CAC5B,KAAK,EAAE,cAAc,EACrB,MAAM,EAAE,eAAe,GACtB,iBAAiB,CAanB"}
+{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../src/algorithms/factory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AACnE,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAMtD,wBAAgB,cAAc,CAC5B,KAAK,EAAE,cAAc,EACrB,MAAM,EAAE,eAAe,GACtB,iBAAiB,CAiBnB"}

package/dist/algorithms/factory.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createStrategy = createStrategy;
+const concurrency_1 = require("./concurrency");
+const gcra_1 = require("./gcra");
 const sliding_window_1 = require("./sliding-window");
 const token_bucket_1 = require("./token-bucket");
 function createStrategy(store, config) {
@@ -9,6 +11,10 @@ function createStrategy(store, config) {
             return new sliding_window_1.SlidingWindowStrategy(store, config);
         case "token-bucket":
             return new token_bucket_1.TokenBucketStrategy(store, config);
+        case "concurrency":
+            return new concurrency_1.ConcurrencyStrategy(store, config);
+        case "gcra":
+            return new gcra_1.GcraStrategy(store, config);
         default: {
             const exhaustive = config;
             throw new Error(`Unknown algorithm: ${exhaustive.algorithm}`);

package/dist/algorithms/factory.js.map

@@ -1 +1 @@
-{"version":3,"file":"factory.js","sourceRoot":"","sources":["../../src/algorithms/factory.ts"],"names":[],"mappings":";;AAKA,wCAgBC;AAnBD,qDAAyD;AACzD,iDAAqD;AAErD,SAAgB,cAAc,CAC5B,KAAqB,EACrB,MAAuB;IAEvB,QAAQ,MAAM,CAAC,SAAS,EAAE,CAAC;QACzB,KAAK,gBAAgB;YACnB,OAAO,IAAI,sCAAqB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAClD,KAAK,cAAc;YACjB,OAAO,IAAI,kCAAmB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAChD,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,UAAU,GAAU,MAAM,CAAC;YACjC,MAAM,IAAI,KAAK,CACb,sBAAuB,UAA8B,CAAC,SAAS,EAAE,CAClE,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC"}
+{"version":3,"file":"factory.js","sourceRoot":"","sources":["../../src/algorithms/factory.ts"],"names":[],"mappings":";;AAOA,wCAoBC;AAzBD,+CAAoD;AACpD,iCAAsC;AACtC,qDAAyD;AACzD,iDAAqD;AAErD,SAAgB,cAAc,CAC5B,KAAqB,EACrB,MAAuB;IAEvB,QAAQ,MAAM,CAAC,SAAS,EAAE,CAAC;QACzB,KAAK,gBAAgB;YACnB,OAAO,IAAI,sCAAqB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAClD,KAAK,cAAc;YACjB,OAAO,IAAI,kCAAmB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAChD,KAAK,aAAa;YAChB,OAAO,IAAI,iCAAmB,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QAChD,KAAK,MAAM;YACT,OAAO,IAAI,mBAAY,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;QACzC,OAAO,CAAC,CAAC,CAAC;YACR,MAAM,UAAU,GAAU,MAAM,CAAC;YACjC,MAAM,IAAI,KAAK,CACb,sBAAuB,UAA8B,CAAC,SAAS,EAAE,CAClE,CAAC;QACJ,CAAC;IACH,CAAC;AACH,CAAC"}

package/dist/algorithms/gcra.d.ts

@@ -0,0 +1,10 @@
+import type { GcraConfig, RateLimitResult, RateLimitStrategy } from "../types";
+import type { RateLimitStore } from "../stores/types";
+export declare class GcraStrategy implements RateLimitStrategy {
+    private readonly store;
+    private readonly limit;
+    private readonly window;
+    constructor(store: RateLimitStore, config: GcraConfig);
+    consume(key: string): Promise<RateLimitResult>;
+}
+//# sourceMappingURL=gcra.d.ts.map

package/dist/algorithms/gcra.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gcra.d.ts","sourceRoot":"","sources":["../../src/algorithms/gcra.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,eAAe,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAC/E,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,iBAAiB,CAAC;AAEtD,qBAAa,YAAa,YAAW,iBAAiB;IACpD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAiB;IACvC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAS;IAC/B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;gBAEpB,KAAK,EAAE,cAAc,EAAE,MAAM,EAAE,UAAU;IAM/C,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC;CAGrD"}

package/dist/algorithms/gcra.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GcraStrategy = void 0;
+class GcraStrategy {
+    constructor(store, config) {
+        this.store = store;
+        this.limit = config.limit;
+        this.window = config.window;
+    }
+    async consume(key) {
+        return this.store.gcra(key, this.limit, this.window);
+    }
+}
+exports.GcraStrategy = GcraStrategy;
+//# sourceMappingURL=gcra.js.map

package/dist/algorithms/gcra.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"gcra.js","sourceRoot":"","sources":["../../src/algorithms/gcra.ts"],"names":[],"mappings":";;;AAGA,MAAa,YAAY;IAKvB,YAAY,KAAqB,EAAE,MAAkB;QACnD,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;QACnB,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC,KAAK,CAAC;QAC1B,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;IAC9B,CAAC;IAED,KAAK,CAAC,OAAO,CAAC,GAAW;QACvB,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC;IACvD,CAAC;CACF;AAdD,oCAcC"}

package/dist/index.d.ts

@@ -7,16 +7,20 @@ export { applyRateLimitHeaders, composeBunHandler, createBunMiddleware, jsonResp
 export type { BunMiddleware, BunNext } from "./middleware/bun";
 export { createNestGuard, limitlyNestModule, LimitlyModule, RateLimit, RATE_LIMIT_KEY, } from "./middleware/nest";
 export type { NestRateLimitOptions } from "./middleware/nest";
+export { ConcurrencyStrategy } from "./algorithms/concurrency";
+export { GcraStrategy } from "./algorithms/gcra";
 export { SlidingWindowStrategy } from "./algorithms/sliding-window";
 export { TokenBucketStrategy } from "./algorithms/token-bucket";
 export type { RateLimitStrategy } from "./algorithms/strategy";
-export { DEFAULT_KEY_PREFIX } from "./utils/redis";
-export { DEFAULT_SLIDING_WINDOW, DEFAULT_TOKEN_BUCKET, resolveAlgorithmConfig, resolveMiddlewareOptions, } from "./utils/defaults";
+export { DEFAULT_CLUSTER_OPTIONS, DEFAULT_KEY_PREFIX, buildKey, createRedisClient, isRedisCluster, } from "./utils/redis";
+export { getClusterScriptDefinitions, registerRedisScripts, warmupRedisScripts, } from "./utils/scripts";
+export { DEFAULT_CONCURRENCY, DEFAULT_GCRA, DEFAULT_SLIDING_WINDOW, DEFAULT_TOKEN_BUCKET, resolveAlgorithmConfig, resolveMiddlewareOptions, } from "./utils/defaults";
 export { consumeRateLimit } from "./utils/metrics";
 export type { RateLimitCheckOutcome } from "./utils/metrics";
+export type { RateLimitSpan, RateLimitTracer } from "./observability/types";
 export { createStore, resolveStoreType } from "./stores/factory";
 export { RedisStore } from "./stores/redis-store";
 export { MemcachedStore } from "./stores/memcached-store";
 export type { RateLimitStore, StoreType } from "./stores/types";
-export type { AlgorithmConfig, BaseMiddlewareOptions, MemcachedClient, MemcachedConfig, MemcachedOptions, MiddlewareOptions, MiddlewareOptionsInput, RateLimitHeaders, RateLimitMetricsEvent, RateLimitMetricsHook, RateLimitResult, RedisClient, RedisConfig, RedisLimitOptions, SlidingWindowConfig, TokenBucketConfig, } from "./types";
+export type { AlgorithmConfig, ConcurrencyConfig, GcraConfig, BaseMiddlewareOptions, MemcachedClient, MemcachedConfig, MemcachedOptions, MiddlewareOptions, MiddlewareOptionsInput, RateLimitHeaders, RateLimitMetricsEvent, RateLimitMetricsHook, RateLimitResult, RedisClient, RedisClusterConfig, RedisConfig, RedisLimitOptions, SlidingWindowConfig, TokenBucketConfig, } from "./types";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AACtD,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAC7E,OAAO,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EACL,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACnB,YAAY,GACb,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC/D,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,aAAa,EACb,SAAS,EACT,cAAc,GACf,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAChE,YAAY,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC/D,OAAO,EAAE,kBAAkB,EAAE,MAAM,eAAe,CAAC;AACnD,OAAO,EACL,sBAAsB,EACtB,oBAAoB,EACpB,sBAAsB,EACtB,wBAAwB,GACzB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,YAAY,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAC7D,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChE,YAAY,EACV,eAAe,EACf,qBAAqB,EACrB,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,iBAAiB,EACjB,sBAAsB,EACtB,gBAAgB,EAChB,qBAAqB,EACrB,oBAAoB,EACpB,eAAe,EACf,WAAW,EACX,WAAW,EACX,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,GAClB,MAAM,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AACtD,OAAO,EAAE,uBAAuB,EAAE,MAAM,sBAAsB,CAAC;AAC/D,OAAO,EAAE,mBAAmB,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AAC7E,OAAO,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AACzD,OAAO,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACvD,OAAO,EACL,qBAAqB,EACrB,iBAAiB,EACjB,mBAAmB,EACnB,YAAY,GACb,MAAM,kBAAkB,CAAC;AAC1B,YAAY,EAAE,aAAa,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAC;AAC/D,OAAO,EACL,eAAe,EACf,iBAAiB,EACjB,aAAa,EACb,SAAS,EACT,cAAc,GACf,MAAM,mBAAmB,CAAC;AAC3B,YAAY,EAAE,oBAAoB,EAAE,MAAM,mBAAmB,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC;AAC/D,OAAO,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC;AACjD,OAAO,EAAE,qBAAqB,EAAE,MAAM,6BAA6B,CAAC;AACpE,OAAO,EAAE,mBAAmB,EAAE,MAAM,2BAA2B,CAAC;AAChE,YAAY,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAC/D,OAAO,EACL,uBAAuB,EACvB,kBAAkB,EAClB,QAAQ,EACR,iBAAiB,EACjB,cAAc,GACf,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,2BAA2B,EAC3B,oBAAoB,EACpB,kBAAkB,GACnB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EACL,mBAAmB,EACnB,YAAY,EACZ,sBAAsB,EACtB,oBAAoB,EACpB,sBAAsB,EACtB,wBAAwB,GACzB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,iBAAiB,CAAC;AACnD,YAAY,EAAE,qBAAqB,EAAE,MAAM,iBAAiB,CAAC;AAC7D,YAAY,EAAE,aAAa,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACjE,OAAO,EAAE,UAAU,EAAE,MAAM,sBAAsB,CAAC;AAClD,OAAO,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAC1D,YAAY,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAChE,YAAY,EACV,eAAe,EACf,iBAAiB,EACjB,UAAU,EACV,qBAAqB,EACrB,eAAe,EACf,eAAe,EACf,gBAAgB,EAChB,iBAAiB,EACjB,sBAAsB,EACtB,gBAAgB,EAChB,qBAAqB,EACrB,oBAAoB,EACpB,eAAe,EACf,WAAW,EACX,kBAAkB,EAClB,WAAW,EACX,iBAAiB,EACjB,mBAAmB,EACnB,iBAAiB,GAClB,MAAM,SAAS,CAAC"}

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MemcachedStore = exports.RedisStore = exports.resolveStoreType = exports.createStore = exports.consumeRateLimit = exports.resolveMiddlewareOptions = exports.resolveAlgorithmConfig = exports.DEFAULT_TOKEN_BUCKET = exports.DEFAULT_SLIDING_WINDOW = exports.DEFAULT_KEY_PREFIX = exports.TokenBucketStrategy = exports.SlidingWindowStrategy = exports.RATE_LIMIT_KEY = exports.RateLimit = exports.LimitlyModule = exports.limitlyNestModule = exports.createNestGuard = exports.jsonResponse = exports.createBunMiddleware = exports.composeBunHandler = exports.applyRateLimitHeaders = exports.createKoaMiddleware = exports.createHonoMiddleware = exports.redisLimitPlugin = exports.createFastifyPlugin = exports.createExpressMiddleware = exports.createLimiter = exports.RedisLimit = void 0;
+exports.MemcachedStore = exports.RedisStore = exports.resolveStoreType = exports.createStore = exports.consumeRateLimit = exports.resolveMiddlewareOptions = exports.resolveAlgorithmConfig = exports.DEFAULT_TOKEN_BUCKET = exports.DEFAULT_SLIDING_WINDOW = exports.DEFAULT_GCRA = exports.DEFAULT_CONCURRENCY = exports.warmupRedisScripts = exports.registerRedisScripts = exports.getClusterScriptDefinitions = exports.isRedisCluster = exports.createRedisClient = exports.buildKey = exports.DEFAULT_KEY_PREFIX = exports.DEFAULT_CLUSTER_OPTIONS = exports.TokenBucketStrategy = exports.SlidingWindowStrategy = exports.GcraStrategy = exports.ConcurrencyStrategy = exports.RATE_LIMIT_KEY = exports.RateLimit = exports.LimitlyModule = exports.limitlyNestModule = exports.createNestGuard = exports.jsonResponse = exports.createBunMiddleware = exports.composeBunHandler = exports.applyRateLimitHeaders = exports.createKoaMiddleware = exports.createHonoMiddleware = exports.redisLimitPlugin = exports.createFastifyPlugin = exports.createExpressMiddleware = exports.createLimiter = exports.RedisLimit = void 0;
 var limiter_1 = require("./limiter");
 Object.defineProperty(exports, "RedisLimit", { enumerable: true, get: function () { return limiter_1.RedisLimit; } });
 Object.defineProperty(exports, "createLimiter", { enumerable: true, get: function () { return limiter_1.createLimiter; } });
@@ -24,13 +24,27 @@ Object.defineProperty(exports, "limitlyNestModule", { enumerable: true, get: fun
 Object.defineProperty(exports, "LimitlyModule", { enumerable: true, get: function () { return nest_1.LimitlyModule; } });
 Object.defineProperty(exports, "RateLimit", { enumerable: true, get: function () { return nest_1.RateLimit; } });
 Object.defineProperty(exports, "RATE_LIMIT_KEY", { enumerable: true, get: function () { return nest_1.RATE_LIMIT_KEY; } });
+var concurrency_1 = require("./algorithms/concurrency");
+Object.defineProperty(exports, "ConcurrencyStrategy", { enumerable: true, get: function () { return concurrency_1.ConcurrencyStrategy; } });
+var gcra_1 = require("./algorithms/gcra");
+Object.defineProperty(exports, "GcraStrategy", { enumerable: true, get: function () { return gcra_1.GcraStrategy; } });
 var sliding_window_1 = require("./algorithms/sliding-window");
 Object.defineProperty(exports, "SlidingWindowStrategy", { enumerable: true, get: function () { return sliding_window_1.SlidingWindowStrategy; } });
 var token_bucket_1 = require("./algorithms/token-bucket");
 Object.defineProperty(exports, "TokenBucketStrategy", { enumerable: true, get: function () { return token_bucket_1.TokenBucketStrategy; } });
 var redis_1 = require("./utils/redis");
+Object.defineProperty(exports, "DEFAULT_CLUSTER_OPTIONS", { enumerable: true, get: function () { return redis_1.DEFAULT_CLUSTER_OPTIONS; } });
 Object.defineProperty(exports, "DEFAULT_KEY_PREFIX", { enumerable: true, get: function () { return redis_1.DEFAULT_KEY_PREFIX; } });
+Object.defineProperty(exports, "buildKey", { enumerable: true, get: function () { return redis_1.buildKey; } });
+Object.defineProperty(exports, "createRedisClient", { enumerable: true, get: function () { return redis_1.createRedisClient; } });
+Object.defineProperty(exports, "isRedisCluster", { enumerable: true, get: function () { return redis_1.isRedisCluster; } });
+var scripts_1 = require("./utils/scripts");
+Object.defineProperty(exports, "getClusterScriptDefinitions", { enumerable: true, get: function () { return scripts_1.getClusterScriptDefinitions; } });
+Object.defineProperty(exports, "registerRedisScripts", { enumerable: true, get: function () { return scripts_1.registerRedisScripts; } });
+Object.defineProperty(exports, "warmupRedisScripts", { enumerable: true, get: function () { return scripts_1.warmupRedisScripts; } });
 var defaults_1 = require("./utils/defaults");
+Object.defineProperty(exports, "DEFAULT_CONCURRENCY", { enumerable: true, get: function () { return defaults_1.DEFAULT_CONCURRENCY; } });
+Object.defineProperty(exports, "DEFAULT_GCRA", { enumerable: true, get: function () { return defaults_1.DEFAULT_GCRA; } });
 Object.defineProperty(exports, "DEFAULT_SLIDING_WINDOW", { enumerable: true, get: function () { return defaults_1.DEFAULT_SLIDING_WINDOW; } });
 Object.defineProperty(exports, "DEFAULT_TOKEN_BUCKET", { enumerable: true, get: function () { return defaults_1.DEFAULT_TOKEN_BUCKET; } });
 Object.defineProperty(exports, "resolveAlgorithmConfig", { enumerable: true, get: function () { return defaults_1.resolveAlgorithmConfig; } });

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,qCAAsD;AAA7C,qGAAA,UAAU,OAAA;AAAE,wGAAA,aAAa,OAAA;AAClC,gDAA+D;AAAtD,kHAAA,uBAAuB,OAAA;AAChC,gDAA6E;AAApE,8GAAA,mBAAmB,OAAA;AAAE,2GAAA,gBAAgB,OAAA;AAC9C,0CAAyD;AAAhD,4GAAA,oBAAoB,OAAA;AAC7B,wCAAuD;AAA9C,0GAAA,mBAAmB,OAAA;AAC5B,wCAK0B;AAJxB,4GAAA,qBAAqB,OAAA;AACrB,wGAAA,iBAAiB,OAAA;AACjB,0GAAA,mBAAmB,OAAA;AACnB,mGAAA,YAAY,OAAA;AAGd,0CAM2B;AALzB,uGAAA,eAAe,OAAA;AACf,yGAAA,iBAAiB,OAAA;AACjB,qGAAA,aAAa,OAAA;AACb,iGAAA,SAAS,OAAA;AACT,sGAAA,cAAc,OAAA;AAGhB,8DAAoE;AAA3D,uHAAA,qBAAqB,OAAA;AAC9B,0DAAgE;AAAvD,mHAAA,mBAAmB,OAAA;AAE5B,uCAAmD;AAA1C,2GAAA,kBAAkB,OAAA;AAC3B,6CAK0B;AAJxB,kHAAA,sBAAsB,OAAA;AACtB,gHAAA,oBAAoB,OAAA;AACpB,kHAAA,sBAAsB,OAAA;AACtB,oHAAA,wBAAwB,OAAA;AAE1B,2CAAmD;AAA1C,2GAAA,gBAAgB,OAAA;AAEzB,4CAAiE;AAAxD,sGAAA,WAAW,OAAA;AAAE,2GAAA,gBAAgB,OAAA;AACtC,oDAAkD;AAAzC,yGAAA,UAAU,OAAA;AACnB,4DAA0D;AAAjD,iHAAA,cAAc,OAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,qCAAsD;AAA7C,qGAAA,UAAU,OAAA;AAAE,wGAAA,aAAa,OAAA;AAClC,gDAA+D;AAAtD,kHAAA,uBAAuB,OAAA;AAChC,gDAA6E;AAApE,8GAAA,mBAAmB,OAAA;AAAE,2GAAA,gBAAgB,OAAA;AAC9C,0CAAyD;AAAhD,4GAAA,oBAAoB,OAAA;AAC7B,wCAAuD;AAA9C,0GAAA,mBAAmB,OAAA;AAC5B,wCAK0B;AAJxB,4GAAA,qBAAqB,OAAA;AACrB,wGAAA,iBAAiB,OAAA;AACjB,0GAAA,mBAAmB,OAAA;AACnB,mGAAA,YAAY,OAAA;AAGd,0CAM2B;AALzB,uGAAA,eAAe,OAAA;AACf,yGAAA,iBAAiB,OAAA;AACjB,qGAAA,aAAa,OAAA;AACb,iGAAA,SAAS,OAAA;AACT,sGAAA,cAAc,OAAA;AAGhB,wDAA+D;AAAtD,kHAAA,mBAAmB,OAAA;AAC5B,0CAAiD;AAAxC,oGAAA,YAAY,OAAA;AACrB,8DAAoE;AAA3D,uHAAA,qBAAqB,OAAA;AAC9B,0DAAgE;AAAvD,mHAAA,mBAAmB,OAAA;AAE5B,uCAMuB;AALrB,gHAAA,uBAAuB,OAAA;AACvB,2GAAA,kBAAkB,OAAA;AAClB,iGAAA,QAAQ,OAAA;AACR,0GAAA,iBAAiB,OAAA;AACjB,uGAAA,cAAc,OAAA;AAEhB,2CAIyB;AAHvB,sHAAA,2BAA2B,OAAA;AAC3B,+GAAA,oBAAoB,OAAA;AACpB,6GAAA,kBAAkB,OAAA;AAEpB,6CAO0B;AANxB,+GAAA,mBAAmB,OAAA;AACnB,wGAAA,YAAY,OAAA;AACZ,kHAAA,sBAAsB,OAAA;AACtB,gHAAA,oBAAoB,OAAA;AACpB,kHAAA,sBAAsB,OAAA;AACtB,oHAAA,wBAAwB,OAAA;AAE1B,2CAAmD;AAA1C,2GAAA,gBAAgB,OAAA;AAGzB,4CAAiE;AAAxD,sGAAA,WAAW,OAAA;AAAE,2GAAA,gBAAgB,OAAA;AACtC,oDAAkD;AAAzC,yGAAA,UAAU,OAAA;AACnB,4DAA0D;AAAjD,iHAAA,cAAc,OAAA"}

package/dist/limiter.d.ts

@@ -15,6 +15,10 @@ export declare class RedisLimit {
     getMemcached(): MemcachedClient;
     createStrategy(config: AlgorithmConfig): RateLimitStrategy;
     createStrategyFromOptions(options?: MiddlewareOptionsInput): RateLimitStrategy;
+    acquire(key: string, config?: MiddlewareOptionsInput, options?: {
+        failOpen?: boolean;
+    }): Promise<RateLimitResult>;
+    release(key: string, slotId: string, config?: MiddlewareOptionsInput): Promise<void>;
     check(key: string, config?: MiddlewareOptionsInput, options?: {
         failOpen?: boolean;
     }): Promise<RateLimitResult>;

package/dist/limiter.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"limiter.d.ts","sourceRoot":"","sources":["../src/limiter.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAQrD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAClD,OAAO,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,KAAK,EACV,eAAe,EACf,eAAe,EACf,iBAAiB,EACjB,sBAAsB,EACtB,eAAe,EACf,iBAAiB,EACjB,WAAW,EACX,iBAAiB,EAClB,MAAM,SAAS,CAAC;AAEjB,qBAAa,UAAU;IACrB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAiB;IACvC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAU;IACnC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAyB;gBAE5C,OAAO,EAAE,iBAAiB;IAStC,QAAQ,IAAI,cAAc;IAI1B,YAAY,IAAI,cAAc,CAAC,MAAM,CAAC;IAItC,iBAAiB,IAAI,sBAAsB;IAI3C,cAAc,CAAC,OAAO,GAAE,sBAA2B,GAAG,iBAAiB;IAIvE,QAAQ,IAAI,WAAW;IASvB,YAAY,IAAI,eAAe;IAS/B,cAAc,CAAC,MAAM,EAAE,eAAe,GAAG,iBAAiB;IAI1D,yBAAyB,CACvB,OAAO,GAAE,sBAA2B,GACnC,iBAAiB;IAOd,KAAK,CACT,GAAG,EAAE,MAAM,EACX,MAAM,GAAE,sBAA2B,EACnC,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,GAC/B,OAAO,CAAC,eAAe,CAAC;IAsB3B,UAAU,CAAC,OAAO,GAAE,sBAA2B;IAI/C,cAAc,CAAC,OAAO,GAAE,sBAA2B;IAInD,aAAa,CAAC,OAAO,GAAE,sBAA2B;IAIlD,aAAa,CAAC,OAAO,GAAE,sBAA2B;IAIlD,IAAI,aAAa,IAAI,kBAAkB,CAAC,sBAAsB,CAAC,CAE9D;IAED,SAAS,CAAC,cAAc,GAAE,sBAA2B,GAAG,IAAI,CAAC,WAAW,CAAC;IAIzE,OAAO,CAAC,oBAAoB;CAW7B;AAED,wBAAgB,aAAa,CAAC,OAAO,EAAE,iBAAiB,GAAG,UAAU,CAEpE;AAED,YAAY,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,CAAC"}
+{"version":3,"file":"limiter.d.ts","sourceRoot":"","sources":["../src/limiter.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAQrD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,SAAS,CAAC;AAClD,OAAO,KAAK,EAAE,WAAW,EAAE,IAAI,EAAE,MAAM,gBAAgB,CAAC;AACxD,OAAO,KAAK,EACV,eAAe,EACf,eAAe,EACf,iBAAiB,EACjB,sBAAsB,EACtB,eAAe,EACf,iBAAiB,EACjB,WAAW,EACX,iBAAiB,EAClB,MAAM,SAAS,CAAC;AAEjB,qBAAa,UAAU;IACrB,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAiB;IACvC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAU;IACnC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAyB;gBAE5C,OAAO,EAAE,iBAAiB;IAUtC,QAAQ,IAAI,cAAc;IAI1B,YAAY,IAAI,cAAc,CAAC,MAAM,CAAC;IAItC,iBAAiB,IAAI,sBAAsB;IAI3C,cAAc,CAAC,OAAO,GAAE,sBAA2B,GAAG,iBAAiB;IAIvE,QAAQ,IAAI,WAAW;IASvB,YAAY,IAAI,eAAe;IAS/B,cAAc,CAAC,MAAM,EAAE,eAAe,GAAG,iBAAiB;IAI1D,yBAAyB,CACvB,OAAO,GAAE,sBAA2B,GACnC,iBAAiB;IAOd,OAAO,CACX,GAAG,EAAE,MAAM,EACX,MAAM,GAAE,sBAA2B,EACnC,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,GAC/B,OAAO,CAAC,eAAe,CAAC;IAIrB,OAAO,CACX,GAAG,EAAE,MAAM,EACX,MAAM,EAAE,MAAM,EACd,MAAM,GAAE,sBAA2B,GAClC,OAAO,CAAC,IAAI,CAAC;IAgBV,KAAK,CACT,GAAG,EAAE,MAAM,EACX,MAAM,GAAE,sBAA2B,EACnC,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAE,GAC/B,OAAO,CAAC,eAAe,CAAC;IAwB3B,UAAU,CAAC,OAAO,GAAE,sBAA2B;IAI/C,cAAc,CAAC,OAAO,GAAE,sBAA2B;IAInD,aAAa,CAAC,OAAO,GAAE,sBAA2B;IAIlD,aAAa,CAAC,OAAO,GAAE,sBAA2B;IAIlD,IAAI,aAAa,IAAI,kBAAkB,CAAC,sBAAsB,CAAC,CAE9D;IAED,SAAS,CAAC,cAAc,GAAE,sBAA2B,GAAG,IAAI,CAAC,WAAW,CAAC;IAIzE,OAAO,CAAC,oBAAoB;CAe7B;AAED,wBAAgB,aAAa,CAAC,OAAO,EAAE,iBAAiB,GAAG,UAAU,CAEpE;AAED,YAAY,EAAE,iBAAiB,EAAE,sBAAsB,EAAE,CAAC"}

package/dist/limiter.js

@@ -18,6 +18,7 @@ class RedisLimit {
         this.failOpen = options.failOpen ?? true;
         this.defaultOptions = {
             onMetrics: options.onMetrics,
+            tracer: options.tracer,
             ...options.default,
         };
     }
@@ -51,9 +52,23 @@ class RedisLimit {
     createStrategyFromOptions(options = {}) {
         return (0, factory_1.createStrategy)(this.store, (0, defaults_1.resolveAlgorithmConfig)(options, this.defaultOptions));
     }
+    async acquire(key, config = {}, options) {
+        return this.check(key, config, options);
+    }
+    async release(key, slotId, config = {}) {
+        const resolved = this.resolveOptions(config);
+        if (resolved.algorithm !== "concurrency") {
+            throw new Error('release() requires algorithm: "concurrency"');
+        }
+        const strategy = this.createStrategy((0, defaults_1.resolveAlgorithmConfig)(config, this.defaultOptions));
+        if (!strategy.release) {
+            throw new Error("Configured strategy does not support release()");
+        }
+        await strategy.release(key, slotId);
+    }
     async check(key, config = {}, options) {
         const resolved = this.resolveOptions(config);
-        const strategy = this.createStrategy(resolved);
+        const strategy = this.createStrategy((0, defaults_1.resolveAlgorithmConfig)(config, this.defaultOptions));
         const shouldFailOpen = options?.failOpen ?? this.failOpen;
         const outcome = await (0, metrics_1.consumeRateLimit)({
             strategy,
@@ -89,7 +104,11 @@ class RedisLimit {
         return (0, nest_1.createNestGuard)(this)(defaultOptions);
     }
     createFailOpenResult(config) {
-        const limit = config.algorithm === "sliding-window" ? config.limit : config.capacity;
+        const limit = config.algorithm === "sliding-window" ||
+            config.algorithm === "concurrency" ||
+            config.algorithm === "gcra"
+            ? config.limit
+            : config.capacity;
         return {
             allowed: true,
             limit,

package/dist/limiter.js.map

@@ -1 +1 @@
-{"version":3,"file":"limiter.js","sourceRoot":"","sources":["../src/limiter.ts"],"names":[],"mappings":";;;AAyJA,sCAEC;AA3JD,kDAAsD;AACtD,kDAA+D;AAC/D,kDAA2D;AAC3D,4CAAyD;AACzD,0CAAuD;AACvD,0CAAuD;AACvD,4CAAoD;AACpD,8CAA+C;AAI/C,+CAG0B;AAC1B,6CAAmD;AAcnD,MAAa,UAAU;IAKrB,YAAY,OAA0B;QACpC,IAAI,CAAC,KAAK,GAAG,IAAA,qBAAW,EAAC,OAAO,CAAC,CAAC;QAClC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC;QACzC,IAAI,CAAC,cAAc,GAAG;YACpB,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,GAAG,OAAO,CAAC,OAAO;SACnB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,YAAY;QACV,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;IACzB,CAAC;IAED,iBAAiB;QACf,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED,cAAc,CAAC,UAAkC,EAAE;QACjD,OAAO,IAAA,mCAAwB,EAAC,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IAChE,CAAC;IAED,QAAQ;QACN,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;YACpC,MAAM,IAAI,KAAK,CACb,+CAA+C,IAAI,CAAC,KAAK,CAAC,IAAI,SAAS,CACxE,CAAC;QACJ,CAAC;QACD,OAAQ,IAAI,CAAC,KAAoB,CAAC,SAAS,EAAE,CAAC;IAChD,CAAC;IAED,YAAY;QACV,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;YACpC,MAAM,IAAI,KAAK,CACb,mEAAmE,CACpE,CAAC;QACJ,CAAC;QACD,OAAQ,IAAI,CAAC,KAAwB,CAAC,SAAS,EAAE,CAAC;IACpD,CAAC;IAED,cAAc,CAAC,MAAuB;QACpC,OAAO,IAAA,wBAAc,EAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAC5C,CAAC;IAED,yBAAyB,CACvB,UAAkC,EAAE;QAEpC,OAAO,IAAA,wBAAc,EACnB,IAAI,CAAC,KAAK,EACV,IAAA,iCAAsB,EAAC,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,CACrD,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,KAAK,CACT,GAAW,EACX,SAAiC,EAAE,EACnC,OAAgC;QAEhC,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC;QAC/C,MAAM,cAAc,GAAG,OAAO,EAAE,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC;QAC1D,MAAM,OAAO,GAAG,MAAM,IAAA,0BAAgB,EAAC;YACrC,QAAQ;YACR,GAAG;YACH,OAAO,EAAE,QAAQ;YACjB,QAAQ,EAAE,cAAc;YACxB,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI;SAC3B,CAAC,CAAC;QAEH,IAAI,OAAO,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;YAC/B,IAAI,cAAc,EAAE,CAAC;gBACnB,OAAO,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;YAC7C,CAAC;YACD,MAAM,OAAO,CAAC,KAAK,CAAC;QACtB,CAAC;QAED,OAAO,OAAO,CAAC,MAAM,CAAC;IACxB,CAAC;IAED,UAAU,CAAC,UAAkC,EAAE;QAC7C,OAAO,IAAA,iCAAuB,EAAC,IAAI,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,cAAc,CAAC,UAAkC,EAAE;QACjD,OAAO,IAAA,2BAAoB,EAAC,IAAI,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;IAClE,CAAC;IAED,aAAa,CAAC,UAAkC,EAAE;QAChD,OAAO,IAAA,yBAAmB,EAAC,IAAI,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;IACjE,CAAC;IAED,aAAa,CAAC,UAAkC,EAAE;QAChD,OAAO,IAAA,yBAAmB,EAAC,IAAI,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;IACjE,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAA,6BAAmB,EAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAED,SAAS,CAAC,iBAAyC,EAAE;QACnD,OAAO,IAAA,sBAAe,EAAC,IAAI,CAAC,CAAC,cAAc,CAAC,CAAC;IAC/C,CAAC;IAEO,oBAAoB,CAAC,MAAuB;QAClD,MAAM,KAAK,GACT,MAAM,CAAC,SAAS,KAAK,gBAAgB,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC;QAEzE,OAAO;YACL,OAAO,EAAE,IAAI;YACb,KAAK;YACL,SAAS,EAAE,KAAK;YAChB,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,GAAG,EAAE;SACzC,CAAC;IACJ,CAAC;CACF;AA1HD,gCA0HC;AAED,SAAgB,aAAa,CAAC,OAA0B;IACtD,OAAO,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC;AACjC,CAAC"}
+{"version":3,"file":"limiter.js","sourceRoot":"","sources":["../src/limiter.ts"],"names":[],"mappings":";;;AA4LA,sCAEC;AA9LD,kDAAsD;AACtD,kDAA+D;AAC/D,kDAA2D;AAC3D,4CAAyD;AACzD,0CAAuD;AACvD,0CAAuD;AACvD,4CAAoD;AACpD,8CAA+C;AAI/C,+CAG0B;AAC1B,6CAAmD;AAcnD,MAAa,UAAU;IAKrB,YAAY,OAA0B;QACpC,IAAI,CAAC,KAAK,GAAG,IAAA,qBAAW,EAAC,OAAO,CAAC,CAAC;QAClC,IAAI,CAAC,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC;QACzC,IAAI,CAAC,cAAc,GAAG;YACpB,SAAS,EAAE,OAAO,CAAC,SAAS;YAC5B,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,GAAG,OAAO,CAAC,OAAO;SACnB,CAAC;IACJ,CAAC;IAED,QAAQ;QACN,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;IAED,YAAY;QACV,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;IACzB,CAAC;IAED,iBAAiB;QACf,OAAO,IAAI,CAAC,cAAc,CAAC;IAC7B,CAAC;IAED,cAAc,CAAC,UAAkC,EAAE;QACjD,OAAO,IAAA,mCAAwB,EAAC,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;IAChE,CAAC;IAED,QAAQ;QACN,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;YACpC,MAAM,IAAI,KAAK,CACb,+CAA+C,IAAI,CAAC,KAAK,CAAC,IAAI,SAAS,CACxE,CAAC;QACJ,CAAC;QACD,OAAQ,IAAI,CAAC,KAAoB,CAAC,SAAS,EAAE,CAAC;IAChD,CAAC;IAED,YAAY;QACV,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,KAAK,WAAW,EAAE,CAAC;YACpC,MAAM,IAAI,KAAK,CACb,mEAAmE,CACpE,CAAC;QACJ,CAAC;QACD,OAAQ,IAAI,CAAC,KAAwB,CAAC,SAAS,EAAE,CAAC;IACpD,CAAC;IAED,cAAc,CAAC,MAAuB;QACpC,OAAO,IAAA,wBAAc,EAAC,IAAI,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;IAC5C,CAAC;IAED,yBAAyB,CACvB,UAAkC,EAAE;QAEpC,OAAO,IAAA,wBAAc,EACnB,IAAI,CAAC,KAAK,EACV,IAAA,iCAAsB,EAAC,OAAO,EAAE,IAAI,CAAC,cAAc,CAAC,CACrD,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,OAAO,CACX,GAAW,EACX,SAAiC,EAAE,EACnC,OAAgC;QAEhC,OAAO,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IAC1C,CAAC;IAED,KAAK,CAAC,OAAO,CACX,GAAW,EACX,MAAc,EACd,SAAiC,EAAE;QAEnC,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAC7C,IAAI,QAAQ,CAAC,SAAS,KAAK,aAAa,EAAE,CAAC;YACzC,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAC;QACjE,CAAC;QAED,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAClC,IAAA,iCAAsB,EAAC,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,CACpD,CAAC;QACF,IAAI,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC;YACtB,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;QACpE,CAAC;QAED,MAAM,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACtC,CAAC;IAED,KAAK,CAAC,KAAK,CACT,GAAW,EACX,SAAiC,EAAE,EACnC,OAAgC;QAEhC,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,CAAC;QAC7C,MAAM,QAAQ,GAAG,IAAI,CAAC,cAAc,CAClC,IAAA,iCAAsB,EAAC,MAAM,EAAE,IAAI,CAAC,cAAc,CAAC,CACpD,CAAC;QACF,MAAM,cAAc,GAAG,OAAO,EAAE,QAAQ,IAAI,IAAI,CAAC,QAAQ,CAAC;QAC1D,MAAM,OAAO,GAAG,MAAM,IAAA,0BAAgB,EAAC;YACrC,QAAQ;YACR,GAAG;YACH,OAAO,EAAE,QAAQ;YACjB,QAAQ,EAAE,cAAc;YACxB,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI;SAC3B,CAAC,CAAC;QAEH,IAAI,OAAO,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;YAC/B,IAAI,cAAc,EAAE,CAAC;gBACnB,OAAO,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,CAAC;YAC7C,CAAC;YACD,MAAM,OAAO,CAAC,KAAK,CAAC;QACtB,CAAC;QAED,OAAO,OAAO,CAAC,MAAM,CAAC;IACxB,CAAC;IAED,UAAU,CAAC,UAAkC,EAAE;QAC7C,OAAO,IAAA,iCAAuB,EAAC,IAAI,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;IACrE,CAAC;IAED,cAAc,CAAC,UAAkC,EAAE;QACjD,OAAO,IAAA,2BAAoB,EAAC,IAAI,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;IAClE,CAAC;IAED,aAAa,CAAC,UAAkC,EAAE;QAChD,OAAO,IAAA,yBAAmB,EAAC,IAAI,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;IACjE,CAAC;IAED,aAAa,CAAC,UAAkC,EAAE;QAChD,OAAO,IAAA,yBAAmB,EAAC,IAAI,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;IACjE,CAAC;IAED,IAAI,aAAa;QACf,OAAO,IAAA,6BAAmB,EAAC,IAAI,CAAC,CAAC;IACnC,CAAC;IAED,SAAS,CAAC,iBAAyC,EAAE;QACnD,OAAO,IAAA,sBAAe,EAAC,IAAI,CAAC,CAAC,cAAc,CAAC,CAAC;IAC/C,CAAC;IAEO,oBAAoB,CAAC,MAAuB;QAClD,MAAM,KAAK,GACT,MAAM,CAAC,SAAS,KAAK,gBAAgB;YACrC,MAAM,CAAC,SAAS,KAAK,aAAa;YAClC,MAAM,CAAC,SAAS,KAAK,MAAM;YACzB,CAAC,CAAC,MAAM,CAAC,KAAK;YACd,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC;QAEtB,OAAO;YACL,OAAO,EAAE,IAAI;YACb,KAAK;YACL,SAAS,EAAE,KAAK;YAChB,KAAK,EAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,GAAG,EAAE;SACzC,CAAC;IACJ,CAAC;CACF;AA7JD,gCA6JC;AAED,SAAgB,aAAa,CAAC,OAA0B;IACtD,OAAO,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC;AACjC,CAAC"}