limitly 2.0.0 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (100) hide show
  1. package/README.md +210 -40
  2. package/dist/algorithms/concurrency.d.ts +11 -0
  3. package/dist/algorithms/concurrency.d.ts.map +1 -0
  4. package/dist/algorithms/concurrency.js +19 -0
  5. package/dist/algorithms/concurrency.js.map +1 -0
  6. package/dist/algorithms/factory.d.ts.map +1 -1
  7. package/dist/algorithms/factory.js +6 -0
  8. package/dist/algorithms/factory.js.map +1 -1
  9. package/dist/algorithms/gcra.d.ts +10 -0
  10. package/dist/algorithms/gcra.d.ts.map +1 -0
  11. package/dist/algorithms/gcra.js +15 -0
  12. package/dist/algorithms/gcra.js.map +1 -0
  13. package/dist/index.d.ts +7 -3
  14. package/dist/index.d.ts.map +1 -1
  15. package/dist/index.js +15 -1
  16. package/dist/index.js.map +1 -1
  17. package/dist/limiter.d.ts +4 -0
  18. package/dist/limiter.d.ts.map +1 -1
  19. package/dist/limiter.js +21 -2
  20. package/dist/limiter.js.map +1 -1
  21. package/dist/middleware/bun.d.ts.map +1 -1
  22. package/dist/middleware/bun.js +21 -10
  23. package/dist/middleware/bun.js.map +1 -1
  24. package/dist/middleware/express.d.ts.map +1 -1
  25. package/dist/middleware/express.js +23 -13
  26. package/dist/middleware/express.js.map +1 -1
  27. package/dist/middleware/fastify.d.ts.map +1 -1
  28. package/dist/middleware/fastify.js +19 -8
  29. package/dist/middleware/fastify.js.map +1 -1
  30. package/dist/middleware/hono.d.ts.map +1 -1
  31. package/dist/middleware/hono.js +26 -12
  32. package/dist/middleware/hono.js.map +1 -1
  33. package/dist/middleware/koa.d.ts.map +1 -1
  34. package/dist/middleware/koa.js +24 -13
  35. package/dist/middleware/koa.js.map +1 -1
  36. package/dist/middleware/nest.d.ts.map +1 -1
  37. package/dist/middleware/nest.js +22 -12
  38. package/dist/middleware/nest.js.map +1 -1
  39. package/dist/observability/index.d.ts +4 -0
  40. package/dist/observability/index.d.ts.map +1 -0
  41. package/dist/observability/index.js +10 -0
  42. package/dist/observability/index.js.map +1 -0
  43. package/dist/observability/opentelemetry.d.ts +28 -0
  44. package/dist/observability/opentelemetry.d.ts.map +1 -0
  45. package/dist/observability/opentelemetry.js +85 -0
  46. package/dist/observability/opentelemetry.js.map +1 -0
  47. package/dist/observability/prometheus.d.ts +27 -0
  48. package/dist/observability/prometheus.d.ts.map +1 -0
  49. package/dist/observability/prometheus.js +88 -0
  50. package/dist/observability/prometheus.js.map +1 -0
  51. package/dist/observability/types.d.ts +9 -0
  52. package/dist/observability/types.d.ts.map +1 -0
  53. package/dist/observability/types.js +3 -0
  54. package/dist/observability/types.js.map +1 -0
  55. package/dist/prometheus.d.ts +3 -0
  56. package/dist/prometheus.d.ts.map +1 -0
  57. package/dist/prometheus.js +9 -0
  58. package/dist/prometheus.js.map +1 -0
  59. package/dist/scripts/concurrencyAcquire.lua +34 -0
  60. package/dist/scripts/concurrencyRelease.lua +9 -0
  61. package/dist/scripts/gcra.lua +38 -0
  62. package/dist/stores/factory.d.ts.map +1 -1
  63. package/dist/stores/factory.js +5 -1
  64. package/dist/stores/factory.js.map +1 -1
  65. package/dist/stores/memcached-store.d.ts +3 -0
  66. package/dist/stores/memcached-store.d.ts.map +1 -1
  67. package/dist/stores/memcached-store.js +94 -0
  68. package/dist/stores/memcached-store.js.map +1 -1
  69. package/dist/stores/redis-store.d.ts +8 -1
  70. package/dist/stores/redis-store.d.ts.map +1 -1
  71. package/dist/stores/redis-store.js +46 -3
  72. package/dist/stores/redis-store.js.map +1 -1
  73. package/dist/stores/types.d.ts +3 -0
  74. package/dist/stores/types.d.ts.map +1 -1
  75. package/dist/types/index.d.ts +33 -5
  76. package/dist/types/index.d.ts.map +1 -1
  77. package/dist/utils/defaults.d.ts +3 -1
  78. package/dist/utils/defaults.d.ts.map +1 -1
  79. package/dist/utils/defaults.js +43 -2
  80. package/dist/utils/defaults.js.map +1 -1
  81. package/dist/utils/limit-execution.d.ts +40 -0
  82. package/dist/utils/limit-execution.d.ts.map +1 -0
  83. package/dist/utils/limit-execution.js +50 -0
  84. package/dist/utils/limit-execution.js.map +1 -0
  85. package/dist/utils/memcached.d.ts +1 -0
  86. package/dist/utils/memcached.d.ts.map +1 -1
  87. package/dist/utils/memcached.js +12 -0
  88. package/dist/utils/memcached.js.map +1 -1
  89. package/dist/utils/metrics.d.ts.map +1 -1
  90. package/dist/utils/metrics.js +41 -2
  91. package/dist/utils/metrics.js.map +1 -1
  92. package/dist/utils/redis.d.ts +4 -1
  93. package/dist/utils/redis.d.ts.map +1 -1
  94. package/dist/utils/redis.js +37 -4
  95. package/dist/utils/redis.js.map +1 -1
  96. package/dist/utils/scripts.d.ts +16 -2
  97. package/dist/utils/scripts.d.ts.map +1 -1
  98. package/dist/utils/scripts.js +79 -33
  99. package/dist/utils/scripts.js.map +1 -1
  100. package/package.json +29 -3
@@ -1 +1 @@
1
- {"version":3,"file":"redis-store.js","sourceRoot":"","sources":["../../src/stores/redis-store.ts"],"names":[],"mappings":";;;AAAA,mCAAoC;AAEpC,0CAA0C;AAC1C,8CAAiE;AAGjE,MAAa,UAAU;IAKrB,YACE,MAAmB,EACnB,SAAiB,EACjB,OAAkB,OAAO;QAEzB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;IACnB,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,GAAW,EACX,KAAa,EACb,MAAc;QAEd,MAAM,QAAQ,GAAG,IAAA,gBAAQ,EAAC,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,EAAE,CAAC,CAAC;QACvD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,MAAM,SAAS,GAAG,IAAA,mBAAU,GAAE,CAAC;QAE/B,MAAM,MAAM,GAAG,MAAM,IAAA,oBAAU,EAAC,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC,QAAQ,CAAC,EAAE;YAClE,KAAK;YACL,MAAM;YACN,GAAG;YACH,SAAS;SACV,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;QAEzC,OAAO;YACL,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,SAAS;SAC3C,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,WAAW,CACf,GAAW,EACX,QAAgB,EAChB,UAAkB;QAElB,MAAM,QAAQ,GAAG,IAAA,gBAAQ,EAAC,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,EAAE,CAAC,CAAC;QACvD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAEvB,MAAM,MAAM,GAAG,MAAM,IAAA,oBAAU,EAAC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE;YAChE,QAAQ;YACR,UAAU;YACV,GAAG;SACJ,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;QAEzC,OAAO;YACL,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,SAAS;SAC3C,CAAC;IACJ,CAAC;CACF;AAtED,gCAsEC"}
1
+ {"version":3,"file":"redis-store.js","sourceRoot":"","sources":["../../src/stores/redis-store.ts"],"names":[],"mappings":";;;AAAA,mCAAoC;AAEpC,0CAA0D;AAC1D,8CAAqF;AAGrF,MAAa,UAAU;IAMrB,YACE,MAAmB,EACnB,SAAiB,EACjB,OAAkB,OAAO,EACzB,UAAyD,EAAE;QAE3D,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;QAC3B,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;QACjB,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC,OAAO,CAAC;QAE/B,MAAM,YAAY,GAChB,OAAO,CAAC,aAAa,IAAI,IAAA,sBAAc,EAAC,MAAM,CAAC,CAAC;QAElD,IAAI,YAAY,EAAE,CAAC;YACjB,KAAK,IAAA,4BAAkB,EAAC,MAAM,CAAC,CAAC,KAAK,CAAC,GAAG,EAAE;gBACzC,wEAAwE;YAC1E,CAAC,CAAC,CAAC;QACL,CAAC;IACH,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,GAAW,EACX,KAAa,EACb,MAAc;QAEd,MAAM,QAAQ,GAAG,IAAA,gBAAQ,EAAC,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACrE,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,MAAM,SAAS,GAAG,IAAA,mBAAU,GAAE,CAAC;QAE/B,MAAM,MAAM,GAAG,MAAM,IAAA,oBAAU,EAAC,IAAI,CAAC,MAAM,EAAE,SAAS,EAAE,CAAC,QAAQ,CAAC,EAAE;YAClE,KAAK;YACL,MAAM;YACN,GAAG;YACH,SAAS;SACV,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;QAEzC,OAAO;YACL,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,SAAS;SAC3C,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,WAAW,CACf,GAAW,EACX,QAAgB,EAChB,UAAkB;QAElB,MAAM,QAAQ,GAAG,IAAA,gBAAQ,EAAC,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACrE,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAEvB,MAAM,MAAM,GAAG,MAAM,IAAA,oBAAU,EAAC,IAAI,CAAC,MAAM,EAAE,OAAO,EAAE,CAAC,QAAQ,CAAC,EAAE;YAChE,QAAQ;YACR,UAAU;YACV,GAAG;SACJ,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;QAEzC,OAAO;YACL,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,SAAS;SAC3C,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,kBAAkB,CACtB,GAAW,EACX,KAAa,EACb,GAAW;QAEX,MAAM,QAAQ,GAAG,IAAA,gBAAQ,EAAC,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACrE,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,MAAM,MAAM,GAAG,IAAA,mBAAU,GAAE,CAAC;QAE5B,MAAM,MAAM,GAAG,MAAM,IAAA,oBAAU,EAC7B,IAAI,CAAC,MAAM,EACX,oBAAoB,EACpB,CAAC,QAAQ,CAAC,EACV,CAAC,KAAK,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,CAAC,CAC1B,CAAC;QAEF,MAAM,MAAM,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;QAEzC,OAAO;YACL,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,SAAS;YAC1C,MAAM,EAAE,MAAM,CAAC,MAAM;SACtB,CAAC;IACJ,CAAC;IAED,KAAK,CAAC,kBAAkB,CAAC,GAAW,EAAE,MAAc;QAClD,MAAM,QAAQ,GAAG,IAAA,gBAAQ,EAAC,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACrE,MAAM,IAAA,oBAAU,EAAC,IAAI,CAAC,MAAM,EAAE,oBAAoB,EAAE,CAAC,QAAQ,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5E,CAAC;IAED,KAAK,CAAC,IAAI,CACR,GAAW,EACX,KAAa,EACb,MAAc;QAEd,MAAM,QAAQ,GAAG,IAAA,gBAAQ,EAAC,IAAI,CAAC,SAAS,EAAE,QAAQ,GAAG,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACvE,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QAEvB,MAAM,MAAM,GAAG,MAAM,IAAA,oBAAU,EAAC,IAAI,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,QAAQ,CAAC,EAAE;YAC/D,KAAK;YACL,MAAM;YACN,GAAG;SACJ,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,IAAA,2BAAiB,EAAC,MAAM,CAAC,CAAC;QAEzC,OAAO;YACL,OAAO,EAAE,MAAM,CAAC,OAAO;YACvB,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,SAAS,EAAE,MAAM,CAAC,SAAS;YAC3B,KAAK,EAAE,MAAM,CAAC,KAAK;YACnB,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,SAAS;SAC3C,CAAC;IACJ,CAAC;CACF;AA5ID,gCA4IC"}
@@ -4,5 +4,8 @@ export interface RateLimitStore {
4
4
  readonly type: StoreType;
5
5
  slidingWindow(key: string, limit: number, window: number): Promise<RateLimitResult>;
6
6
  tokenBucket(key: string, capacity: number, refillRate: number): Promise<RateLimitResult>;
7
+ concurrencyAcquire(key: string, limit: number, ttl: number): Promise<RateLimitResult>;
8
+ concurrencyRelease(key: string, slotId: string): Promise<void>;
9
+ gcra(key: string, limit: number, window: number): Promise<RateLimitResult>;
7
10
  }
8
11
  //# sourceMappingURL=types.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/stores/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAEhD,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,QAAQ,GAAG,WAAW,GAAG,WAAW,CAAC;AAEvE,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,aAAa,CACX,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,eAAe,CAAC,CAAC;IAC5B,WAAW,CACT,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,eAAe,CAAC,CAAC;CAC7B"}
1
+ {"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/stores/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAEhD,MAAM,MAAM,SAAS,GAAG,OAAO,GAAG,QAAQ,GAAG,WAAW,GAAG,WAAW,CAAC;AAEvE,MAAM,WAAW,cAAc;IAC7B,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,aAAa,CACX,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,eAAe,CAAC,CAAC;IAC5B,WAAW,CACT,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,eAAe,CAAC,CAAC;IAC5B,kBAAkB,CAChB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,eAAe,CAAC,CAAC;IAC5B,kBAAkB,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC/D,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;CAC5E"}
@@ -1,15 +1,17 @@
1
- import type { Cluster, Redis, RedisOptions } from "ioredis";
1
+ import type { Cluster, ClusterOptions, Redis, RedisOptions } from "ioredis";
2
2
  import type Memcached from "memcached";
3
+ import type { RateLimitTracer } from "../observability/types";
3
4
  import type { StoreType } from "../stores/types";
4
5
  export type { StoreType };
5
6
  export type RedisClient = Redis | Cluster;
6
- export type RedisConfig = RedisClient | string | RedisOptions | {
7
+ export type RedisClusterConfig = {
7
8
  nodes: {
8
9
  host: string;
9
10
  port: number;
10
11
  }[];
11
- options?: RedisOptions;
12
+ options?: ClusterOptions;
12
13
  };
14
+ export type RedisConfig = RedisClient | string | RedisOptions | RedisClusterConfig;
13
15
  export type MemcachedClient = Memcached;
14
16
  export type MemcachedOptions = Memcached.options;
15
17
  export type MemcachedConfig = MemcachedClient | string | string[] | {
@@ -26,10 +28,19 @@ export interface RedisLimitOptions {
26
28
  failOpen?: boolean;
27
29
  /** Storage key prefix. Defaults to "limitly". Keys are stored as `{prefix}:sw:{id}` or `{prefix}:tb:{id}`. */
28
30
  keyPrefix?: string;
31
+ /**
32
+ * Redis Cluster hash tag for slot pinning. Keys become `{tag}:{prefix}:sw:{id}`.
33
+ * Leave unset to distribute keys across slots (recommended for throughput).
34
+ */
35
+ hashTag?: string;
36
+ /** Preload Lua scripts on all cluster masters at startup. Defaults to `true` for cluster. */
37
+ warmupScripts?: boolean;
29
38
  /** Default rate limit config applied when middleware options omit algorithm settings. */
30
39
  default?: MiddlewareOptionsInput;
31
40
  /** Global metrics hook applied to all rate limit checks. */
32
41
  onMetrics?: RateLimitMetricsHook | RateLimitMetricsHook[];
42
+ /** Global tracer for distributed tracing of rate limit checks. */
43
+ tracer?: RateLimitTracer;
33
44
  }
34
45
  export interface RateLimitResult {
35
46
  allowed: boolean;
@@ -37,9 +48,12 @@ export interface RateLimitResult {
37
48
  remaining: number;
38
49
  reset: number;
39
50
  retryAfter?: number;
51
+ /** Present when a concurrency slot was acquired. */
52
+ slotId?: string;
40
53
  }
41
54
  export interface RateLimitStrategy {
42
55
  consume(key: string): Promise<RateLimitResult>;
56
+ release?(key: string, slotId: string): Promise<void>;
43
57
  }
44
58
  export interface SlidingWindowConfig {
45
59
  algorithm: "sliding-window";
@@ -51,7 +65,19 @@ export interface TokenBucketConfig {
51
65
  capacity: number;
52
66
  refillRate: number;
53
67
  }
54
- export type AlgorithmConfig = SlidingWindowConfig | TokenBucketConfig;
68
+ export interface ConcurrencyConfig {
69
+ algorithm: "concurrency";
70
+ /** Maximum in-flight requests per key. */
71
+ limit: number;
72
+ /** Lease TTL in seconds for stale slot cleanup. Defaults to 300. */
73
+ ttl?: number;
74
+ }
75
+ export interface GcraConfig {
76
+ algorithm: "gcra";
77
+ limit: number;
78
+ window: number;
79
+ }
80
+ export type AlgorithmConfig = SlidingWindowConfig | TokenBucketConfig | ConcurrencyConfig | GcraConfig;
55
81
  export type RateLimitMetricsEvent = {
56
82
  type: "allowed";
57
83
  key: string;
@@ -91,15 +117,17 @@ export interface BaseMiddlewareOptions {
91
117
  headers?: boolean;
92
118
  onLimitReached?: (req: unknown, res: unknown) => void | Promise<void>;
93
119
  onMetrics?: RateLimitMetricsHook | RateLimitMetricsHook[];
120
+ tracer?: RateLimitTracer;
94
121
  failOpen?: boolean;
95
122
  }
96
123
  export type MiddlewareOptions = BaseMiddlewareOptions & AlgorithmConfig;
97
124
  export type MiddlewareOptionsInput = BaseMiddlewareOptions & {
98
- algorithm?: "sliding-window" | "token-bucket";
125
+ algorithm?: "sliding-window" | "token-bucket" | "concurrency" | "gcra";
99
126
  limit?: number;
100
127
  window?: number;
101
128
  capacity?: number;
102
129
  refillRate?: number;
130
+ ttl?: number;
103
131
  };
104
132
  export interface RateLimitHeaders {
105
133
  "X-RateLimit-Limit": string;
@@ -1 +1 @@
1
- {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAC5D,OAAO,KAAK,SAAS,MAAM,WAAW,CAAC;AACvC,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAGjD,YAAY,EAAE,SAAS,EAAE,CAAC;AAE1B,MAAM,MAAM,WAAW,GAAG,KAAK,GAAG,OAAO,CAAC;AAE1C,MAAM,MAAM,WAAW,GACnB,WAAW,GACX,MAAM,GACN,YAAY,GACZ;IAAE,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IAAC,OAAO,CAAC,EAAE,YAAY,CAAA;CAAE,CAAC;AAExE,MAAM,MAAM,eAAe,GAAG,SAAS,CAAC;AAExC,MAAM,MAAM,gBAAgB,GAAG,SAAS,CAAC,OAAO,CAAC;AAEjD,MAAM,MAAM,eAAe,GACvB,eAAe,GACf,MAAM,GACN,MAAM,EAAE,GACR;IAAE,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAAC,OAAO,CAAC,EAAE,gBAAgB,CAAA;CAAE,CAAC;AAE/D,MAAM,WAAW,iBAAiB;IAChC,8FAA8F;IAC9F,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,+DAA+D;IAC/D,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,0BAA0B;IAC1B,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,8GAA8G;IAC9G,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,yFAAyF;IACzF,OAAO,CAAC,EAAE,sBAAsB,CAAC;IACjC,4DAA4D;IAC5D,SAAS,CAAC,EAAE,oBAAoB,GAAG,oBAAoB,EAAE,CAAC;CAC3D;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;CAChD;AAED,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,gBAAgB,CAAC;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,cAAc,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,MAAM,eAAe,GAAG,mBAAmB,GAAG,iBAAiB,CAAC;AAEtE,MAAM,MAAM,qBAAqB,GAC7B;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,eAAe,CAAC,WAAW,CAAC,CAAC;IACxC,MAAM,EAAE,eAAe,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,GACD;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,eAAe,CAAC,WAAW,CAAC,CAAC;IACxC,MAAM,EAAE,eAAe,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,GACD;IACE,IAAI,EAAE,OAAO,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,eAAe,CAAC,WAAW,CAAC,CAAC;IACxC,KAAK,EAAE,OAAO,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,GACD;IACE,IAAI,EAAE,WAAW,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,eAAe,CAAC,WAAW,CAAC,CAAC;IACxC,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEN,MAAM,MAAM,oBAAoB,GAAG,CACjC,KAAK,EAAE,qBAAqB,KACzB,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAE1B,MAAM,WAAW,qBAAqB;IACpC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,MAAM,GAAG,SAAS,CAAC;IAC3C,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,cAAc,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtE,SAAS,CAAC,EAAE,oBAAoB,GAAG,oBAAoB,EAAE,CAAC;IAC1D,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,MAAM,iBAAiB,GAAG,qBAAqB,GAAG,eAAe,CAAC;AAExE,MAAM,MAAM,sBAAsB,GAAG,qBAAqB,GAAG;IAC3D,SAAS,CAAC,EAAE,gBAAgB,GAAG,cAAc,CAAC;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB,CAAC;AAEF,MAAM,WAAW,gBAAgB;IAC/B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,uBAAuB,EAAE,MAAM,CAAC;IAChC,mBAAmB,EAAE,MAAM,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB"}
1
+ {"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,cAAc,EAAE,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AAC5E,OAAO,KAAK,SAAS,MAAM,WAAW,CAAC;AACvC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAGjD,YAAY,EAAE,SAAS,EAAE,CAAC;AAE1B,MAAM,MAAM,WAAW,GAAG,KAAK,GAAG,OAAO,CAAC;AAE1C,MAAM,MAAM,kBAAkB,GAAG;IAC/B,KAAK,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;IACxC,OAAO,CAAC,EAAE,cAAc,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,WAAW,GACnB,WAAW,GACX,MAAM,GACN,YAAY,GACZ,kBAAkB,CAAC;AAEvB,MAAM,MAAM,eAAe,GAAG,SAAS,CAAC;AAExC,MAAM,MAAM,gBAAgB,GAAG,SAAS,CAAC,OAAO,CAAC;AAEjD,MAAM,MAAM,eAAe,GACvB,eAAe,GACf,MAAM,GACN,MAAM,EAAE,GACR;IAAE,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAAC,OAAO,CAAC,EAAE,gBAAgB,CAAA;CAAE,CAAC;AAE/D,MAAM,WAAW,iBAAiB;IAChC,8FAA8F;IAC9F,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,+DAA+D;IAC/D,KAAK,CAAC,EAAE,WAAW,CAAC;IACpB,0BAA0B;IAC1B,SAAS,CAAC,EAAE,eAAe,CAAC;IAC5B,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB,8GAA8G;IAC9G,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,6FAA6F;IAC7F,aAAa,CAAC,EAAE,OAAO,CAAC;IACxB,yFAAyF;IACzF,OAAO,CAAC,EAAE,sBAAsB,CAAC;IACjC,4DAA4D;IAC5D,SAAS,CAAC,EAAE,oBAAoB,GAAG,oBAAoB,EAAE,CAAC;IAC1D,kEAAkE;IAClE,MAAM,CAAC,EAAE,eAAe,CAAC;CAC1B;AAED,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,OAAO,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,oDAAoD;IACpD,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,iBAAiB;IAChC,OAAO,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,eAAe,CAAC,CAAC;IAC/C,OAAO,CAAC,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CACtD;AAED,MAAM,WAAW,mBAAmB;IAClC,SAAS,EAAE,gBAAgB,CAAC;IAC5B,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,cAAc,CAAC;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,iBAAiB;IAChC,SAAS,EAAE,aAAa,CAAC;IACzB,0CAA0C;IAC1C,KAAK,EAAE,MAAM,CAAC;IACd,oEAAoE;IACpE,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,UAAU;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,MAAM,eAAe,GACvB,mBAAmB,GACnB,iBAAiB,GACjB,iBAAiB,GACjB,UAAU,CAAC;AAEf,MAAM,MAAM,qBAAqB,GAC7B;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,eAAe,CAAC,WAAW,CAAC,CAAC;IACxC,MAAM,EAAE,eAAe,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,GACD;IACE,IAAI,EAAE,SAAS,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,eAAe,CAAC,WAAW,CAAC,CAAC;IACxC,MAAM,EAAE,eAAe,CAAC;IACxB,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,GACD;IACE,IAAI,EAAE,OAAO,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,eAAe,CAAC,WAAW,CAAC,CAAC;IACxC,KAAK,EAAE,OAAO,CAAC;IACf,UAAU,EAAE,MAAM,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;IAClB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,GACD;IACE,IAAI,EAAE,WAAW,CAAC;IAClB,GAAG,EAAE,MAAM,CAAC;IACZ,SAAS,EAAE,eAAe,CAAC,WAAW,CAAC,CAAC;IACxC,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,SAAS,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,CAAC;AAEN,MAAM,MAAM,oBAAoB,GAAG,CACjC,KAAK,EAAE,qBAAqB,KACzB,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;AAE1B,MAAM,WAAW,qBAAqB;IACpC,GAAG,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,KAAK,MAAM,GAAG,SAAS,CAAC;IAC3C,OAAO,CAAC,EAAE,OAAO,CAAC;IAClB,cAAc,CAAC,EAAE,CAAC,GAAG,EAAE,OAAO,EAAE,GAAG,EAAE,OAAO,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtE,SAAS,CAAC,EAAE,oBAAoB,GAAG,oBAAoB,EAAE,CAAC;IAC1D,MAAM,CAAC,EAAE,eAAe,CAAC;IACzB,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,MAAM,iBAAiB,GAAG,qBAAqB,GAAG,eAAe,CAAC;AAExE,MAAM,MAAM,sBAAsB,GAAG,qBAAqB,GAAG;IAC3D,SAAS,CAAC,EAAE,gBAAgB,GAAG,cAAc,GAAG,aAAa,GAAG,MAAM,CAAC;IACvE,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,GAAG,CAAC,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,WAAW,gBAAgB;IAC/B,mBAAmB,EAAE,MAAM,CAAC;IAC5B,uBAAuB,EAAE,MAAM,CAAC;IAChC,mBAAmB,EAAE,MAAM,CAAC;IAC5B,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB"}
@@ -1,6 +1,8 @@
1
- import type { AlgorithmConfig, MiddlewareOptions, MiddlewareOptionsInput, SlidingWindowConfig, TokenBucketConfig } from "../types";
1
+ import type { AlgorithmConfig, ConcurrencyConfig, GcraConfig, MiddlewareOptions, MiddlewareOptionsInput, SlidingWindowConfig, TokenBucketConfig } from "../types";
2
2
  export declare const DEFAULT_SLIDING_WINDOW: SlidingWindowConfig;
3
3
  export declare const DEFAULT_TOKEN_BUCKET: TokenBucketConfig;
4
+ export declare const DEFAULT_CONCURRENCY: ConcurrencyConfig;
5
+ export declare const DEFAULT_GCRA: GcraConfig;
4
6
  export declare function resolveMiddlewareOptions(options?: MiddlewareOptionsInput, defaults?: MiddlewareOptionsInput): MiddlewareOptions;
5
7
  export declare function resolveAlgorithmConfig(options?: MiddlewareOptionsInput, defaults?: MiddlewareOptionsInput): AlgorithmConfig;
6
8
  //# sourceMappingURL=defaults.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"defaults.d.ts","sourceRoot":"","sources":["../../src/utils/defaults.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EAEf,iBAAiB,EACjB,sBAAsB,EACtB,mBAAmB,EACnB,iBAAiB,EAClB,MAAM,UAAU,CAAC;AAElB,eAAO,MAAM,sBAAsB,EAAE,mBAIpC,CAAC;AAEF,eAAO,MAAM,oBAAoB,EAAE,iBAIlC,CAAC;AAcF,wBAAgB,wBAAwB,CACtC,OAAO,GAAE,sBAA2B,EACpC,QAAQ,GAAE,sBAA2B,GACpC,iBAAiB,CAoBnB;AAED,wBAAgB,sBAAsB,CACpC,OAAO,GAAE,sBAA2B,EACpC,QAAQ,GAAE,sBAA2B,GACpC,eAAe,CAejB"}
1
+ {"version":3,"file":"defaults.d.ts","sourceRoot":"","sources":["../../src/utils/defaults.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,eAAe,EAEf,iBAAiB,EACjB,UAAU,EACV,iBAAiB,EACjB,sBAAsB,EACtB,mBAAmB,EACnB,iBAAiB,EAClB,MAAM,UAAU,CAAC;AAElB,eAAO,MAAM,sBAAsB,EAAE,mBAIpC,CAAC;AAEF,eAAO,MAAM,oBAAoB,EAAE,iBAIlC,CAAC;AAEF,eAAO,MAAM,mBAAmB,EAAE,iBAIjC,CAAC;AAEF,eAAO,MAAM,YAAY,EAAE,UAI1B,CAAC;AAeF,wBAAgB,wBAAwB,CACtC,OAAO,GAAE,sBAA2B,EACpC,QAAQ,GAAE,sBAA2B,GACpC,iBAAiB,CAsCnB;AAED,wBAAgB,sBAAsB,CACpC,OAAO,GAAE,sBAA2B,EACpC,QAAQ,GAAE,sBAA2B,GACpC,eAAe,CA+BjB"}
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.DEFAULT_TOKEN_BUCKET = exports.DEFAULT_SLIDING_WINDOW = void 0;
3
+ exports.DEFAULT_GCRA = exports.DEFAULT_CONCURRENCY = exports.DEFAULT_TOKEN_BUCKET = exports.DEFAULT_SLIDING_WINDOW = void 0;
4
4
  exports.resolveMiddlewareOptions = resolveMiddlewareOptions;
5
5
  exports.resolveAlgorithmConfig = resolveAlgorithmConfig;
6
6
  exports.DEFAULT_SLIDING_WINDOW = {
@@ -13,19 +13,30 @@ exports.DEFAULT_TOKEN_BUCKET = {
13
13
  capacity: 100,
14
14
  refillRate: 10,
15
15
  };
16
+ exports.DEFAULT_CONCURRENCY = {
17
+ algorithm: "concurrency",
18
+ limit: 10,
19
+ ttl: 300,
20
+ };
21
+ exports.DEFAULT_GCRA = {
22
+ algorithm: "gcra",
23
+ limit: 100,
24
+ window: 60,
25
+ };
16
26
  function pickBaseOptions(options) {
17
27
  return {
18
28
  key: options.key,
19
29
  headers: options.headers,
20
30
  onLimitReached: options.onLimitReached,
21
31
  onMetrics: options.onMetrics,
32
+ tracer: options.tracer,
22
33
  failOpen: options.failOpen,
23
34
  };
24
35
  }
25
36
  function resolveMiddlewareOptions(options = {}, defaults = {}) {
26
37
  const merged = { ...defaults, ...options };
27
38
  const base = pickBaseOptions(merged);
28
- const algorithm = merged.algorithm ?? exports.DEFAULT_SLIDING_WINDOW.algorithm;
39
+ const algorithm = merged.algorithm ?? exports.DEFAULT_GCRA.algorithm;
29
40
  if (algorithm === "token-bucket") {
30
41
  return {
31
42
  ...base,
@@ -34,6 +45,22 @@ function resolveMiddlewareOptions(options = {}, defaults = {}) {
34
45
  refillRate: merged.refillRate ?? exports.DEFAULT_TOKEN_BUCKET.refillRate,
35
46
  };
36
47
  }
48
+ if (algorithm === "concurrency") {
49
+ return {
50
+ ...base,
51
+ algorithm: "concurrency",
52
+ limit: merged.limit ?? exports.DEFAULT_CONCURRENCY.limit,
53
+ ttl: merged.ttl ?? exports.DEFAULT_CONCURRENCY.ttl,
54
+ };
55
+ }
56
+ if (algorithm === "gcra") {
57
+ return {
58
+ ...base,
59
+ algorithm: "gcra",
60
+ limit: merged.limit ?? exports.DEFAULT_GCRA.limit,
61
+ window: merged.window ?? exports.DEFAULT_GCRA.window,
62
+ };
63
+ }
37
64
  return {
38
65
  ...base,
39
66
  algorithm: "sliding-window",
@@ -50,6 +77,20 @@ function resolveAlgorithmConfig(options = {}, defaults = {}) {
50
77
  refillRate: resolved.refillRate,
51
78
  };
52
79
  }
80
+ if (resolved.algorithm === "concurrency") {
81
+ return {
82
+ algorithm: "concurrency",
83
+ limit: resolved.limit,
84
+ ttl: resolved.ttl ?? exports.DEFAULT_CONCURRENCY.ttl,
85
+ };
86
+ }
87
+ if (resolved.algorithm === "gcra") {
88
+ return {
89
+ algorithm: "gcra",
90
+ limit: resolved.limit,
91
+ window: resolved.window,
92
+ };
93
+ }
53
94
  return {
54
95
  algorithm: "sliding-window",
55
96
  limit: resolved.limit,
@@ -1 +1 @@
1
- {"version":3,"file":"defaults.js","sourceRoot":"","sources":["../../src/utils/defaults.ts"],"names":[],"mappings":";;;AAiCA,4DAuBC;AAED,wDAkBC;AAnEY,QAAA,sBAAsB,GAAwB;IACzD,SAAS,EAAE,gBAAgB;IAC3B,KAAK,EAAE,GAAG;IACV,MAAM,EAAE,EAAE;CACX,CAAC;AAEW,QAAA,oBAAoB,GAAsB;IACrD,SAAS,EAAE,cAAc;IACzB,QAAQ,EAAE,GAAG;IACb,UAAU,EAAE,EAAE;CACf,CAAC;AAEF,SAAS,eAAe,CACtB,OAA+B;IAE/B,OAAO;QACL,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,cAAc,EAAE,OAAO,CAAC,cAAc;QACtC,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,QAAQ,EAAE,OAAO,CAAC,QAAQ;KAC3B,CAAC;AACJ,CAAC;AAED,SAAgB,wBAAwB,CACtC,UAAkC,EAAE,EACpC,WAAmC,EAAE;IAErC,MAAM,MAAM,GAA2B,EAAE,GAAG,QAAQ,EAAE,GAAG,OAAO,EAAE,CAAC;IACnE,MAAM,IAAI,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;IACrC,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,IAAI,8BAAsB,CAAC,SAAS,CAAC;IAEvE,IAAI,SAAS,KAAK,cAAc,EAAE,CAAC;QACjC,OAAO;YACL,GAAG,IAAI;YACP,SAAS,EAAE,cAAc;YACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,4BAAoB,CAAC,QAAQ;YAC1D,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,4BAAoB,CAAC,UAAU;SACjE,CAAC;IACJ,CAAC;IAED,OAAO;QACL,GAAG,IAAI;QACP,SAAS,EAAE,gBAAgB;QAC3B,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,8BAAsB,CAAC,KAAK;QACnD,MAAM,EAAE,MAAM,CAAC,MAAM,IAAI,8BAAsB,CAAC,MAAM;KACvD,CAAC;AACJ,CAAC;AAED,SAAgB,sBAAsB,CACpC,UAAkC,EAAE,EACpC,WAAmC,EAAE;IAErC,MAAM,QAAQ,GAAG,wBAAwB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC7D,IAAI,QAAQ,CAAC,SAAS,KAAK,cAAc,EAAE,CAAC;QAC1C,OAAO;YACL,SAAS,EAAE,cAAc;YACzB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;YAC3B,UAAU,EAAE,QAAQ,CAAC,UAAU;SAChC,CAAC;IACJ,CAAC;IAED,OAAO;QACL,SAAS,EAAE,gBAAgB;QAC3B,KAAK,EAAE,QAAQ,CAAC,KAAK;QACrB,MAAM,EAAE,QAAQ,CAAC,MAAM;KACxB,CAAC;AACJ,CAAC"}
1
+ {"version":3,"file":"defaults.js","sourceRoot":"","sources":["../../src/utils/defaults.ts"],"names":[],"mappings":";;;AAgDA,4DAyCC;AAED,wDAkCC;AAlHY,QAAA,sBAAsB,GAAwB;IACzD,SAAS,EAAE,gBAAgB;IAC3B,KAAK,EAAE,GAAG;IACV,MAAM,EAAE,EAAE;CACX,CAAC;AAEW,QAAA,oBAAoB,GAAsB;IACrD,SAAS,EAAE,cAAc;IACzB,QAAQ,EAAE,GAAG;IACb,UAAU,EAAE,EAAE;CACf,CAAC;AAEW,QAAA,mBAAmB,GAAsB;IACpD,SAAS,EAAE,aAAa;IACxB,KAAK,EAAE,EAAE;IACT,GAAG,EAAE,GAAG;CACT,CAAC;AAEW,QAAA,YAAY,GAAe;IACtC,SAAS,EAAE,MAAM;IACjB,KAAK,EAAE,GAAG;IACV,MAAM,EAAE,EAAE;CACX,CAAC;AAEF,SAAS,eAAe,CACtB,OAA+B;IAE/B,OAAO;QACL,GAAG,EAAE,OAAO,CAAC,GAAG;QAChB,OAAO,EAAE,OAAO,CAAC,OAAO;QACxB,cAAc,EAAE,OAAO,CAAC,cAAc;QACtC,SAAS,EAAE,OAAO,CAAC,SAAS;QAC5B,MAAM,EAAE,OAAO,CAAC,MAAM;QACtB,QAAQ,EAAE,OAAO,CAAC,QAAQ;KAC3B,CAAC;AACJ,CAAC;AAED,SAAgB,wBAAwB,CACtC,UAAkC,EAAE,EACpC,WAAmC,EAAE;IAErC,MAAM,MAAM,GAA2B,EAAE,GAAG,QAAQ,EAAE,GAAG,OAAO,EAAE,CAAC;IACnE,MAAM,IAAI,GAAG,eAAe,CAAC,MAAM,CAAC,CAAC;IACrC,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,IAAI,oBAAY,CAAC,SAAS,CAAC;IAE7D,IAAI,SAAS,KAAK,cAAc,EAAE,CAAC;QACjC,OAAO;YACL,GAAG,IAAI;YACP,SAAS,EAAE,cAAc;YACzB,QAAQ,EAAE,MAAM,CAAC,QAAQ,IAAI,4BAAoB,CAAC,QAAQ;YAC1D,UAAU,EAAE,MAAM,CAAC,UAAU,IAAI,4BAAoB,CAAC,UAAU;SACjE,CAAC;IACJ,CAAC;IAED,IAAI,SAAS,KAAK,aAAa,EAAE,CAAC;QAChC,OAAO;YACL,GAAG,IAAI;YACP,SAAS,EAAE,aAAa;YACxB,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,2BAAmB,CAAC,KAAK;YAChD,GAAG,EAAE,MAAM,CAAC,GAAG,IAAI,2BAAmB,CAAC,GAAG;SAC3C,CAAC;IACJ,CAAC;IAED,IAAI,SAAS,KAAK,MAAM,EAAE,CAAC;QACzB,OAAO;YACL,GAAG,IAAI;YACP,SAAS,EAAE,MAAM;YACjB,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,oBAAY,CAAC,KAAK;YACzC,MAAM,EAAE,MAAM,CAAC,MAAM,IAAI,oBAAY,CAAC,MAAM;SAC7C,CAAC;IACJ,CAAC;IAED,OAAO;QACL,GAAG,IAAI;QACP,SAAS,EAAE,gBAAgB;QAC3B,KAAK,EAAE,MAAM,CAAC,KAAK,IAAI,8BAAsB,CAAC,KAAK;QACnD,MAAM,EAAE,MAAM,CAAC,MAAM,IAAI,8BAAsB,CAAC,MAAM;KACvD,CAAC;AACJ,CAAC;AAED,SAAgB,sBAAsB,CACpC,UAAkC,EAAE,EACpC,WAAmC,EAAE;IAErC,MAAM,QAAQ,GAAG,wBAAwB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;IAC7D,IAAI,QAAQ,CAAC,SAAS,KAAK,cAAc,EAAE,CAAC;QAC1C,OAAO;YACL,SAAS,EAAE,cAAc;YACzB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;YAC3B,UAAU,EAAE,QAAQ,CAAC,UAAU;SAChC,CAAC;IACJ,CAAC;IAED,IAAI,QAAQ,CAAC,SAAS,KAAK,aAAa,EAAE,CAAC;QACzC,OAAO;YACL,SAAS,EAAE,aAAa;YACxB,KAAK,EAAE,QAAQ,CAAC,KAAK;YACrB,GAAG,EAAE,QAAQ,CAAC,GAAG,IAAI,2BAAmB,CAAC,GAAG;SAC7C,CAAC;IACJ,CAAC;IAED,IAAI,QAAQ,CAAC,SAAS,KAAK,MAAM,EAAE,CAAC;QAClC,OAAO;YACL,SAAS,EAAE,MAAM;YACjB,KAAK,EAAE,QAAQ,CAAC,KAAK;YACrB,MAAM,EAAE,QAAQ,CAAC,MAAM;SACxB,CAAC;IACJ,CAAC;IAED,OAAO;QACL,SAAS,EAAE,gBAAgB;QAC3B,KAAK,EAAE,QAAQ,CAAC,KAAK;QACrB,MAAM,EAAE,QAAQ,CAAC,MAAM;KACxB,CAAC;AACJ,CAAC"}
@@ -0,0 +1,40 @@
1
+ import type { RedisLimit } from "../limiter";
2
+ import type { ConcurrencyConfig, MiddlewareOptions, RateLimitResult, RateLimitStrategy } from "../types";
3
+ export declare function isConcurrencyAlgorithm(options: MiddlewareOptions): options is MiddlewareOptions & ConcurrencyConfig;
4
+ export type LimitRequestOutcome = {
5
+ status: "allowed";
6
+ result: RateLimitResult;
7
+ slotId?: string;
8
+ } | {
9
+ status: "blocked";
10
+ result: RateLimitResult;
11
+ } | {
12
+ status: "error";
13
+ failOpen: boolean;
14
+ error: unknown;
15
+ };
16
+ export declare function processLimitRequest(params: {
17
+ limiter: RedisLimit;
18
+ strategy: RateLimitStrategy;
19
+ key: string;
20
+ options: MiddlewareOptions;
21
+ failOpen: boolean;
22
+ context?: unknown;
23
+ }): Promise<LimitRequestOutcome>;
24
+ type ReleaseEmitter = {
25
+ on?(event: "finish" | "close", listener: () => void): void;
26
+ addListener?(event: "finish" | "close", listener: () => void): void;
27
+ };
28
+ export declare function bindConcurrencyRelease(params: {
29
+ strategy: RateLimitStrategy;
30
+ key: string;
31
+ slotId: string;
32
+ emitter: ReleaseEmitter;
33
+ }): void;
34
+ export declare function releaseConcurrencySlot(params: {
35
+ strategy: RateLimitStrategy;
36
+ key: string;
37
+ slotId: string;
38
+ }): Promise<void>;
39
+ export {};
40
+ //# sourceMappingURL=limit-execution.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"limit-execution.d.ts","sourceRoot":"","sources":["../../src/utils/limit-execution.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,KAAK,EACV,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EAClB,MAAM,UAAU,CAAC;AAGlB,wBAAgB,sBAAsB,CACpC,OAAO,EAAE,iBAAiB,GACzB,OAAO,IAAI,iBAAiB,GAAG,iBAAiB,CAElD;AAED,MAAM,MAAM,mBAAmB,GAC3B;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,eAAe,CAAC;IAAC,MAAM,CAAC,EAAE,MAAM,CAAA;CAAE,GAC/D;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,eAAe,CAAA;CAAE,GAC9C;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,OAAO,CAAA;CAAE,CAAC;AAE3D,wBAAsB,mBAAmB,CAAC,MAAM,EAAE;IAChD,OAAO,EAAE,UAAU,CAAC;IACpB,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,iBAAiB,CAAC;IAC3B,QAAQ,EAAE,OAAO,CAAC;IAClB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,GAAG,OAAO,CAAC,mBAAmB,CAAC,CAyB/B;AAED,KAAK,cAAc,GAAG;IACpB,EAAE,CAAC,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IAC3D,WAAW,CAAC,CAAC,KAAK,EAAE,QAAQ,GAAG,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;CACrE,CAAC;AAEF,wBAAgB,sBAAsB,CAAC,MAAM,EAAE;IAC7C,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,cAAc,CAAC;CACzB,GAAG,IAAI,CAcP;AAED,wBAAsB,sBAAsB,CAAC,MAAM,EAAE;IACnD,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,MAAM,CAAC;CAChB,GAAG,OAAO,CAAC,IAAI,CAAC,CAEhB"}
@@ -0,0 +1,50 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.isConcurrencyAlgorithm = isConcurrencyAlgorithm;
4
+ exports.processLimitRequest = processLimitRequest;
5
+ exports.bindConcurrencyRelease = bindConcurrencyRelease;
6
+ exports.releaseConcurrencySlot = releaseConcurrencySlot;
7
+ const metrics_1 = require("./metrics");
8
+ function isConcurrencyAlgorithm(options) {
9
+ return options.algorithm === "concurrency";
10
+ }
11
+ async function processLimitRequest(params) {
12
+ const { limiter, strategy, key, options, failOpen, context } = params;
13
+ const outcome = await (0, metrics_1.consumeRateLimit)({
14
+ strategy,
15
+ key,
16
+ options,
17
+ failOpen,
18
+ storeType: limiter.getStoreType(),
19
+ context,
20
+ });
21
+ if (outcome.status === "error") {
22
+ return { status: "error", failOpen, error: outcome.error };
23
+ }
24
+ const result = outcome.result;
25
+ if (!result.allowed) {
26
+ return { status: "blocked", result };
27
+ }
28
+ return {
29
+ status: "allowed",
30
+ result,
31
+ slotId: result.slotId,
32
+ };
33
+ }
34
+ function bindConcurrencyRelease(params) {
35
+ let released = false;
36
+ const release = () => {
37
+ if (released) {
38
+ return;
39
+ }
40
+ released = true;
41
+ void params.strategy.release?.(params.key, params.slotId);
42
+ };
43
+ const attach = params.emitter.on ?? params.emitter.addListener;
44
+ attach?.call(params.emitter, "finish", release);
45
+ attach?.call(params.emitter, "close", release);
46
+ }
47
+ async function releaseConcurrencySlot(params) {
48
+ await params.strategy.release?.(params.key, params.slotId);
49
+ }
50
+ //# sourceMappingURL=limit-execution.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"limit-execution.js","sourceRoot":"","sources":["../../src/utils/limit-execution.ts"],"names":[],"mappings":";;AASA,wDAIC;AAOD,kDAgCC;AAOD,wDAmBC;AAED,wDAMC;AA/ED,uCAA6C;AAE7C,SAAgB,sBAAsB,CACpC,OAA0B;IAE1B,OAAO,OAAO,CAAC,SAAS,KAAK,aAAa,CAAC;AAC7C,CAAC;AAOM,KAAK,UAAU,mBAAmB,CAAC,MAOzC;IACC,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IACtE,MAAM,OAAO,GAAG,MAAM,IAAA,0BAAgB,EAAC;QACrC,QAAQ;QACR,GAAG;QACH,OAAO;QACP,QAAQ;QACR,SAAS,EAAE,OAAO,CAAC,YAAY,EAAE;QACjC,OAAO;KACR,CAAC,CAAC;IAEH,IAAI,OAAO,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;QAC/B,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,EAAE,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,CAAC;IAC7D,CAAC;IAED,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAC9B,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,CAAC;IACvC,CAAC;IAED,OAAO;QACL,MAAM,EAAE,SAAS;QACjB,MAAM;QACN,MAAM,EAAE,MAAM,CAAC,MAAM;KACtB,CAAC;AACJ,CAAC;AAOD,SAAgB,sBAAsB,CAAC,MAKtC;IACC,IAAI,QAAQ,GAAG,KAAK,CAAC;IAErB,MAAM,OAAO,GAAG,GAAG,EAAE;QACnB,IAAI,QAAQ,EAAE,CAAC;YACb,OAAO;QACT,CAAC;QACD,QAAQ,GAAG,IAAI,CAAC;QAChB,KAAK,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAC5D,CAAC,CAAC;IAEF,MAAM,MAAM,GAAG,MAAM,CAAC,OAAO,CAAC,EAAE,IAAI,MAAM,CAAC,OAAO,CAAC,WAAW,CAAC;IAC/D,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,CAAC,CAAC;IAChD,MAAM,EAAE,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;AACjD,CAAC;AAEM,KAAK,UAAU,sBAAsB,CAAC,MAI5C;IACC,MAAM,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,CAAC,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;AAC7D,CAAC"}
@@ -6,6 +6,7 @@ export declare function memcachedGets(client: MemcachedClient, key: string): Pro
6
6
  cas: string;
7
7
  } | undefined>;
8
8
  export declare function memcachedIncr(client: MemcachedClient, key: string, amount?: number): Promise<number>;
9
+ export declare function memcachedDecr(client: MemcachedClient, key: string, amount?: number): Promise<number>;
9
10
  export declare function memcachedAdd(client: MemcachedClient, key: string, value: string, ttl: number): Promise<void>;
10
11
  export declare function memcachedCas(client: MemcachedClient, key: string, value: string, cas: string, ttl: number): Promise<boolean>;
11
12
  //# sourceMappingURL=memcached.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"memcached.d.ts","sourceRoot":"","sources":["../../src/utils/memcached.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAEjE,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,eAAe,GAAG,eAAe,CAU9E;AAWD,wBAAgB,YAAY,CAC1B,MAAM,EAAE,eAAe,EACvB,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAU7B;AAED,wBAAgB,aAAa,CAC3B,MAAM,EAAE,eAAe,EACvB,GAAG,EAAE,MAAM,GACV,OAAO,CAAC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAAC,CAcrD;AAED,wBAAgB,aAAa,CAC3B,MAAM,EAAE,eAAe,EACvB,GAAG,EAAE,MAAM,EACX,MAAM,SAAI,GACT,OAAO,CAAC,MAAM,CAAC,CAUjB;AAED,wBAAgB,YAAY,CAC1B,MAAM,EAAE,eAAe,EACvB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,IAAI,CAAC,CAUf;AAED,wBAAgB,YAAY,CAC1B,MAAM,EAAE,eAAe,EACvB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,OAAO,CAAC,CAclB"}
1
+ {"version":3,"file":"memcached.d.ts","sourceRoot":"","sources":["../../src/utils/memcached.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAEjE,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,eAAe,GAAG,eAAe,CAU9E;AAWD,wBAAgB,YAAY,CAC1B,MAAM,EAAE,eAAe,EACvB,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC,CAU7B;AAED,wBAAgB,aAAa,CAC3B,MAAM,EAAE,eAAe,EACvB,GAAG,EAAE,MAAM,GACV,OAAO,CAAC;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,GAAG,SAAS,CAAC,CAcrD;AAED,wBAAgB,aAAa,CAC3B,MAAM,EAAE,eAAe,EACvB,GAAG,EAAE,MAAM,EACX,MAAM,SAAI,GACT,OAAO,CAAC,MAAM,CAAC,CAUjB;AAED,wBAAgB,aAAa,CAC3B,MAAM,EAAE,eAAe,EACvB,GAAG,EAAE,MAAM,EACX,MAAM,SAAI,GACT,OAAO,CAAC,MAAM,CAAC,CAUjB;AAED,wBAAgB,YAAY,CAC1B,MAAM,EAAE,eAAe,EACvB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,IAAI,CAAC,CAUf;AAED,wBAAgB,YAAY,CAC1B,MAAM,EAAE,eAAe,EACvB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,GAAG,EAAE,MAAM,EACX,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,OAAO,CAAC,CAclB"}
@@ -7,6 +7,7 @@ exports.createMemcachedClient = createMemcachedClient;
7
7
  exports.memcachedGet = memcachedGet;
8
8
  exports.memcachedGets = memcachedGets;
9
9
  exports.memcachedIncr = memcachedIncr;
10
+ exports.memcachedDecr = memcachedDecr;
10
11
  exports.memcachedAdd = memcachedAdd;
11
12
  exports.memcachedCas = memcachedCas;
12
13
  const memcached_1 = __importDefault(require("memcached"));
@@ -62,6 +63,17 @@ function memcachedIncr(client, key, amount = 1) {
62
63
  });
63
64
  });
64
65
  }
66
+ function memcachedDecr(client, key, amount = 1) {
67
+ return new Promise((resolve, reject) => {
68
+ client.decr(key, amount, (err, result) => {
69
+ if (err) {
70
+ reject(err);
71
+ return;
72
+ }
73
+ resolve(Number(result));
74
+ });
75
+ });
76
+ }
65
77
  function memcachedAdd(client, key, value, ttl) {
66
78
  return new Promise((resolve, reject) => {
67
79
  client.add(key, value, ttl, (err) => {
@@ -1 +1 @@
1
- {"version":3,"file":"memcached.js","sourceRoot":"","sources":["../../src/utils/memcached.ts"],"names":[],"mappings":";;;;;AAGA,sDAUC;AAWD,oCAaC;AAED,sCAiBC;AAED,sCAcC;AAED,oCAeC;AAED,oCAoBC;AA/GD,0DAAkC;AAGlC,SAAgB,qBAAqB,CAAC,MAAuB;IAC3D,IAAI,iBAAiB,CAAC,MAAM,CAAC,EAAE,CAAC;QAC9B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACxD,OAAO,IAAI,mBAAS,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;IAED,OAAO,IAAI,mBAAS,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;AACvD,CAAC;AAED,SAAS,iBAAiB,CAAC,MAAuB;IAChD,OAAO,CACL,OAAO,MAAM,KAAK,QAAQ;QAC1B,MAAM,KAAK,IAAI;QACf,MAAM,IAAI,MAAM;QAChB,OAAQ,MAA0B,CAAC,IAAI,KAAK,UAAU,CACvD,CAAC;AACJ,CAAC;AAED,SAAgB,YAAY,CAC1B,MAAuB,EACvB,GAAW;IAEX,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAsB,EAAE,IAAwB,EAAE,EAAE;YACnE,IAAI,GAAG,EAAE,CAAC;gBACR,MAAM,CAAC,GAAG,CAAC,CAAC;gBACZ,OAAO;YACT,CAAC;YACD,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,aAAa,CAC3B,MAAuB,EACvB,GAAW;IAEX,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,GAAsB,EAAE,IAAsC,EAAE,EAAE;YAClF,IAAI,GAAG,EAAE,CAAC;gBACR,MAAM,CAAC,GAAG,CAAC,CAAC;gBACZ,OAAO;YACT,CAAC;YACD,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;gBACjB,OAAO,CAAC,SAAS,CAAC,CAAC;gBACnB,OAAO;YACT,CAAC;YACD,OAAO,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,aAAa,CAC3B,MAAuB,EACvB,GAAW,EACX,MAAM,GAAG,CAAC;IAEV,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,GAAsB,EAAE,MAAyB,EAAE,EAAE;YAC7E,IAAI,GAAG,EAAE,CAAC;gBACR,MAAM,CAAC,GAAG,CAAC,CAAC;gBACZ,OAAO;YACT,CAAC;YACD,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,YAAY,CAC1B,MAAuB,EACvB,GAAW,EACX,KAAa,EACb,GAAW;IAEX,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,GAAsC,EAAE,EAAE;YACrE,IAAI,GAAG,IAAK,GAA6B,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC5D,MAAM,CAAC,GAAG,CAAC,CAAC;gBACZ,OAAO;YACT,CAAC;YACD,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,YAAY,CAC1B,MAAuB,EACvB,GAAW,EACX,KAAa,EACb,GAAW,EACX,GAAW;IAEX,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,GAAsC,EAAE,EAAE;YAC1E,IAAI,GAAG,EAAE,CAAC;gBACR,IAAK,GAA6B,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBACrD,OAAO,CAAC,KAAK,CAAC,CAAC;oBACf,OAAO;gBACT,CAAC;gBACD,MAAM,CAAC,GAAG,CAAC,CAAC;gBACZ,OAAO;YACT,CAAC;YACD,OAAO,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC"}
1
+ {"version":3,"file":"memcached.js","sourceRoot":"","sources":["../../src/utils/memcached.ts"],"names":[],"mappings":";;;;;AAGA,sDAUC;AAWD,oCAaC;AAED,sCAiBC;AAED,sCAcC;AAED,sCAcC;AAED,oCAeC;AAED,oCAoBC;AA/HD,0DAAkC;AAGlC,SAAgB,qBAAqB,CAAC,MAAuB;IAC3D,IAAI,iBAAiB,CAAC,MAAM,CAAC,EAAE,CAAC;QAC9B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;QACxD,OAAO,IAAI,mBAAS,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;IAED,OAAO,IAAI,mBAAS,CAAC,MAAM,CAAC,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;AACvD,CAAC;AAED,SAAS,iBAAiB,CAAC,MAAuB;IAChD,OAAO,CACL,OAAO,MAAM,KAAK,QAAQ;QAC1B,MAAM,KAAK,IAAI;QACf,MAAM,IAAI,MAAM;QAChB,OAAQ,MAA0B,CAAC,IAAI,KAAK,UAAU,CACvD,CAAC;AACJ,CAAC;AAED,SAAgB,YAAY,CAC1B,MAAuB,EACvB,GAAW;IAEX,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,GAAsB,EAAE,IAAwB,EAAE,EAAE;YACnE,IAAI,GAAG,EAAE,CAAC;gBACR,MAAM,CAAC,GAAG,CAAC,CAAC;gBACZ,OAAO;YACT,CAAC;YACD,OAAO,CAAC,IAAI,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC5B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,aAAa,CAC3B,MAAuB,EACvB,GAAW;IAEX,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,GAAsB,EAAE,IAAsC,EAAE,EAAE;YAClF,IAAI,GAAG,EAAE,CAAC;gBACR,MAAM,CAAC,GAAG,CAAC,CAAC;gBACZ,OAAO;YACT,CAAC;YACD,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC;gBACjB,OAAO,CAAC,SAAS,CAAC,CAAC;gBACnB,OAAO;YACT,CAAC;YACD,OAAO,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,GAAG,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;QACnE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,aAAa,CAC3B,MAAuB,EACvB,GAAW,EACX,MAAM,GAAG,CAAC;IAEV,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,GAAsB,EAAE,MAAyB,EAAE,EAAE;YAC7E,IAAI,GAAG,EAAE,CAAC;gBACR,MAAM,CAAC,GAAG,CAAC,CAAC;gBACZ,OAAO;YACT,CAAC;YACD,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,aAAa,CAC3B,MAAuB,EACvB,GAAW,EACX,MAAM,GAAG,CAAC;IAEV,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,EAAE,CAAC,GAAsB,EAAE,MAAyB,EAAE,EAAE;YAC7E,IAAI,GAAG,EAAE,CAAC;gBACR,MAAM,CAAC,GAAG,CAAC,CAAC;gBACZ,OAAO;YACT,CAAC;YACD,OAAO,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,YAAY,CAC1B,MAAuB,EACvB,GAAW,EACX,KAAa,EACb,GAAW;IAEX,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,GAAsC,EAAE,EAAE;YACrE,IAAI,GAAG,IAAK,GAA6B,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;gBAC5D,MAAM,CAAC,GAAG,CAAC,CAAC;gBACZ,OAAO;YACT,CAAC;YACD,OAAO,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC;AAED,SAAgB,YAAY,CAC1B,MAAuB,EACvB,GAAW,EACX,KAAa,EACb,GAAW,EACX,GAAW;IAEX,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;QACrC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,EAAE,CAAC,GAAsC,EAAE,EAAE;YAC1E,IAAI,GAAG,EAAE,CAAC;gBACR,IAAK,GAA6B,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBACrD,OAAO,CAAC,KAAK,CAAC,CAAC;oBACf,OAAO;gBACT,CAAC;gBACD,MAAM,CAAC,GAAG,CAAC,CAAC;gBACZ,OAAO;YACT,CAAC;YACD,OAAO,CAAC,IAAI,CAAC,CAAC;QAChB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC"}
@@ -1 +1 @@
1
- {"version":3,"file":"metrics.d.ts","sourceRoot":"","sources":["../../src/utils/metrics.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAEV,iBAAiB,EAGjB,eAAe,EACf,iBAAiB,EACjB,SAAS,EACV,MAAM,UAAU,CAAC;AAElB,MAAM,MAAM,qBAAqB,GAC7B;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,eAAe,CAAA;CAAE,GAC9C;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,eAAe,CAAA;CAAE,GAC9C;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAA;CAAE,CAAC;AAkB3D,wBAAsB,gBAAgB,CAAC,MAAM,EAAE;IAC7C,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,iBAAiB,CAAC;IAC3B,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAkDjC"}
1
+ {"version":3,"file":"metrics.d.ts","sourceRoot":"","sources":["../../src/utils/metrics.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAEV,iBAAiB,EAGjB,eAAe,EACf,iBAAiB,EACjB,SAAS,EACV,MAAM,UAAU,CAAC;AAElB,MAAM,MAAM,qBAAqB,GAC7B;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,eAAe,CAAA;CAAE,GAC9C;IAAE,MAAM,EAAE,SAAS,CAAC;IAAC,MAAM,EAAE,eAAe,CAAA;CAAE,GAC9C;IAAE,MAAM,EAAE,OAAO,CAAC;IAAC,KAAK,EAAE,OAAO,CAAC;IAAC,QAAQ,EAAE,OAAO,CAAA;CAAE,CAAC;AA2E3D,wBAAsB,gBAAgB,CAAC,MAAM,EAAE;IAC7C,QAAQ,EAAE,iBAAiB,CAAC;IAC5B,GAAG,EAAE,MAAM,CAAC;IACZ,OAAO,EAAE,iBAAiB,CAAC;IAC3B,QAAQ,EAAE,OAAO,CAAC;IAClB,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAwDjC"}
@@ -11,15 +11,53 @@ async function emitMetrics(hooks, event) {
11
11
  const handlers = Array.isArray(hooks) ? hooks : [hooks];
12
12
  await Promise.all(handlers.map((hook) => hook(event)));
13
13
  }
14
+ function startTraceSpan(options, params) {
15
+ const tracer = options.tracer;
16
+ if (!tracer) {
17
+ return undefined;
18
+ }
19
+ const attributes = {
20
+ "limitly.algorithm": params.algorithm,
21
+ };
22
+ if (params.storeType) {
23
+ attributes["limitly.store"] = params.storeType;
24
+ }
25
+ return tracer.startSpan("limitly.check", attributes);
26
+ }
27
+ function finishTraceSpan(span, params) {
28
+ if (!span) {
29
+ return;
30
+ }
31
+ span.setAttribute("limitly.outcome", params.outcome);
32
+ if (params.result) {
33
+ span.setAttribute("limitly.limit", params.result.limit);
34
+ span.setAttribute("limitly.remaining", params.result.remaining);
35
+ span.setAttribute("limitly.allowed", params.result.allowed);
36
+ }
37
+ if (params.error) {
38
+ const message = params.error instanceof Error ? params.error.message : String(params.error);
39
+ span.setStatus(false, message);
40
+ }
41
+ else if (params.outcome === "error") {
42
+ span.setStatus(false, "rate limit store error");
43
+ }
44
+ else {
45
+ span.setStatus(true);
46
+ }
47
+ span.end();
48
+ }
14
49
  async function consumeRateLimit(params) {
15
50
  const { strategy, key, options, failOpen, storeType, context } = params;
16
51
  const algorithm = getAlgorithm(options);
17
52
  const startedAt = performance.now();
53
+ const span = startTraceSpan(options, { algorithm, key, storeType });
18
54
  try {
19
55
  const result = await strategy.consume(key);
20
56
  const durationMs = performance.now() - startedAt;
57
+ const outcome = result.allowed ? "allowed" : "blocked";
58
+ finishTraceSpan(span, { outcome, result });
21
59
  await emitMetrics(options.onMetrics, {
22
- type: result.allowed ? "allowed" : "blocked",
60
+ type: outcome,
23
61
  key,
24
62
  algorithm,
25
63
  result,
@@ -28,12 +66,13 @@ async function consumeRateLimit(params) {
28
66
  context,
29
67
  });
30
68
  return {
31
- status: result.allowed ? "allowed" : "blocked",
69
+ status: outcome,
32
70
  result,
33
71
  };
34
72
  }
35
73
  catch (error) {
36
74
  const durationMs = performance.now() - startedAt;
75
+ finishTraceSpan(span, { outcome: "error", error });
37
76
  await emitMetrics(options.onMetrics, {
38
77
  type: "error",
39
78
  key,
@@ -1 +1 @@
1
- {"version":3,"file":"metrics.js","sourceRoot":"","sources":["../../src/utils/metrics.ts"],"names":[],"mappings":";;AA+BA,4CAyDC;AAzED,SAAS,YAAY,CAAC,OAA0B;IAC9C,OAAO,OAAO,CAAC,SAAS,CAAC;AAC3B,CAAC;AAED,KAAK,UAAU,WAAW,CACxB,KAAgE,EAChE,KAA4B;IAE5B,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO;IACT,CAAC;IAED,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IACxD,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACzD,CAAC;AAEM,KAAK,UAAU,gBAAgB,CAAC,MAOtC;IACC,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IACxE,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IACxC,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IAEpC,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3C,MAAM,UAAU,GAAG,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;QAEjD,MAAM,WAAW,CAAC,OAAO,CAAC,SAAS,EAAE;YACnC,IAAI,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;YAC5C,GAAG;YACH,SAAS;YACT,MAAM;YACN,UAAU;YACV,KAAK,EAAE,SAAS;YAChB,OAAO;SACR,CAAC,CAAC;QAEH,OAAO;YACL,MAAM,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS;YAC9C,MAAM;SACP,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,UAAU,GAAG,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;QAEjD,MAAM,WAAW,CAAC,OAAO,CAAC,SAAS,EAAE;YACnC,IAAI,EAAE,OAAO;YACb,GAAG;YACH,SAAS;YACT,KAAK;YACL,UAAU;YACV,QAAQ;YACR,KAAK,EAAE,SAAS;YAChB,OAAO;SACR,CAAC,CAAC;QAEH,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,WAAW,CAAC,OAAO,CAAC,SAAS,EAAE;gBACnC,IAAI,EAAE,WAAW;gBACjB,GAAG;gBACH,SAAS;gBACT,UAAU;gBACV,KAAK,EAAE,SAAS;gBAChB,OAAO;aACR,CAAC,CAAC;QACL,CAAC;QAED,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;IAC9C,CAAC;AACH,CAAC"}
1
+ {"version":3,"file":"metrics.js","sourceRoot":"","sources":["../../src/utils/metrics.ts"],"names":[],"mappings":";;AAyFA,4CA+DC;AAxID,SAAS,YAAY,CAAC,OAA0B;IAC9C,OAAO,OAAO,CAAC,SAAS,CAAC;AAC3B,CAAC;AAED,KAAK,UAAU,WAAW,CACxB,KAAgE,EAChE,KAA4B;IAE5B,IAAI,CAAC,KAAK,EAAE,CAAC;QACX,OAAO;IACT,CAAC;IAED,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC;IACxD,MAAM,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACzD,CAAC;AAED,SAAS,cAAc,CACrB,OAA0B,EAC1B,MAIC;IAED,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;IAC9B,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,UAAU,GAA8C;QAC5D,mBAAmB,EAAE,MAAM,CAAC,SAAS;KACtC,CAAC;IAEF,IAAI,MAAM,CAAC,SAAS,EAAE,CAAC;QACrB,UAAU,CAAC,eAAe,CAAC,GAAG,MAAM,CAAC,SAAS,CAAC;IACjD,CAAC;IAED,OAAO,MAAM,CAAC,SAAS,CAAC,eAAe,EAAE,UAAU,CAAC,CAAC;AACvD,CAAC;AAED,SAAS,eAAe,CACtB,IAA+B,EAC/B,MAIC;IAED,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO;IACT,CAAC;IAED,IAAI,CAAC,YAAY,CAAC,iBAAiB,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IAErD,IAAI,MAAM,CAAC,MAAM,EAAE,CAAC;QAClB,IAAI,CAAC,YAAY,CAAC,eAAe,EAAE,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACxD,IAAI,CAAC,YAAY,CAAC,mBAAmB,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAChE,IAAI,CAAC,YAAY,CAAC,iBAAiB,EAAE,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;IAC9D,CAAC;IAED,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;QACjB,MAAM,OAAO,GACX,MAAM,CAAC,KAAK,YAAY,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC9E,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IACjC,CAAC;SAAM,IAAI,MAAM,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;QACtC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,wBAAwB,CAAC,CAAC;IAClD,CAAC;SAAM,CAAC;QACN,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IACvB,CAAC;IAED,IAAI,CAAC,GAAG,EAAE,CAAC;AACb,CAAC;AAEM,KAAK,UAAU,gBAAgB,CAAC,MAOtC;IACC,MAAM,EAAE,QAAQ,EAAE,GAAG,EAAE,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;IACxE,MAAM,SAAS,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;IACxC,MAAM,SAAS,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;IACpC,MAAM,IAAI,GAAG,cAAc,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,CAAC;IAEpE,IAAI,CAAC;QACH,MAAM,MAAM,GAAG,MAAM,QAAQ,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC3C,MAAM,UAAU,GAAG,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;QACjD,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC;QAEvD,eAAe,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,MAAM,EAAE,CAAC,CAAC;QAE3C,MAAM,WAAW,CAAC,OAAO,CAAC,SAAS,EAAE;YACnC,IAAI,EAAE,OAAO;YACb,GAAG;YACH,SAAS;YACT,MAAM;YACN,UAAU;YACV,KAAK,EAAE,SAAS;YAChB,OAAO;SACR,CAAC,CAAC;QAEH,OAAO;YACL,MAAM,EAAE,OAAO;YACf,MAAM;SACP,CAAC;IACJ,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,UAAU,GAAG,WAAW,CAAC,GAAG,EAAE,GAAG,SAAS,CAAC;QAEjD,eAAe,CAAC,IAAI,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC,CAAC;QAEnD,MAAM,WAAW,CAAC,OAAO,CAAC,SAAS,EAAE;YACnC,IAAI,EAAE,OAAO;YACb,GAAG;YACH,SAAS;YACT,KAAK;YACL,UAAU;YACV,QAAQ;YACR,KAAK,EAAE,SAAS;YAChB,OAAO;SACR,CAAC,CAAC;QAEH,IAAI,QAAQ,EAAE,CAAC;YACb,MAAM,WAAW,CAAC,OAAO,CAAC,SAAS,EAAE;gBACnC,IAAI,EAAE,WAAW;gBACjB,GAAG;gBACH,SAAS;gBACT,UAAU;gBACV,KAAK,EAAE,SAAS;gBAChB,OAAO;aACR,CAAC,CAAC;QACL,CAAC;QAED,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;IAC9C,CAAC;AACH,CAAC"}
@@ -1,5 +1,8 @@
1
+ import { Cluster, type ClusterOptions } from "ioredis";
1
2
  import type { RedisClient, RedisConfig } from "../types";
2
3
  export declare const DEFAULT_KEY_PREFIX = "limitly";
4
+ export declare const DEFAULT_CLUSTER_OPTIONS: ClusterOptions;
5
+ export declare function isRedisCluster(client: RedisClient): client is Cluster;
3
6
  export declare function createRedisClient(config: RedisConfig): RedisClient;
4
- export declare function buildKey(prefix: string, key: string): string;
7
+ export declare function buildKey(prefix: string, key: string, hashTag?: string): string;
5
8
  //# sourceMappingURL=redis.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"redis.d.ts","sourceRoot":"","sources":["../../src/utils/redis.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAEzD,eAAO,MAAM,kBAAkB,YAAY,CAAC;AAE5C,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,WAAW,GAAG,WAAW,CAclE;AAiBD,wBAAgB,QAAQ,CAAC,MAAM,EAAE,MAAM,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,CAE5D"}
1
+ {"version":3,"file":"redis.d.ts","sourceRoot":"","sources":["../../src/utils/redis.ts"],"names":[],"mappings":"AAAA,OAAc,EAAE,OAAO,EAAE,KAAK,cAAc,EAAE,MAAM,SAAS,CAAC;AAC9D,OAAO,KAAK,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAGzD,eAAO,MAAM,kBAAkB,YAAY,CAAC;AAE5C,eAAO,MAAM,uBAAuB,EAAE,cAWrC,CAAC;AAEF,wBAAgB,cAAc,CAAC,MAAM,EAAE,WAAW,GAAG,MAAM,IAAI,OAAO,CAErE;AAED,wBAAgB,iBAAiB,CAAC,MAAM,EAAE,WAAW,GAAG,WAAW,CA0BlE;AAiBD,wBAAgB,QAAQ,CACtB,MAAM,EAAE,MAAM,EACd,GAAG,EAAE,MAAM,EACX,OAAO,CAAC,EAAE,MAAM,GACf,MAAM,CAQR"}
@@ -33,11 +33,28 @@ var __importStar = (this && this.__importStar) || (function () {
33
33
  };
34
34
  })();
35
35
  Object.defineProperty(exports, "__esModule", { value: true });
36
- exports.DEFAULT_KEY_PREFIX = void 0;
36
+ exports.DEFAULT_CLUSTER_OPTIONS = exports.DEFAULT_KEY_PREFIX = void 0;
37
+ exports.isRedisCluster = isRedisCluster;
37
38
  exports.createRedisClient = createRedisClient;
38
39
  exports.buildKey = buildKey;
39
40
  const ioredis_1 = __importStar(require("ioredis"));
41
+ const scripts_1 = require("./scripts");
40
42
  exports.DEFAULT_KEY_PREFIX = "limitly";
43
+ exports.DEFAULT_CLUSTER_OPTIONS = {
44
+ scaleReads: "master",
45
+ enableReadyCheck: true,
46
+ maxRedirections: 16,
47
+ retryDelayOnFailover: 100,
48
+ retryDelayOnClusterDown: 300,
49
+ slotsRefreshTimeout: 2000,
50
+ enableAutoPipelining: true,
51
+ redisOptions: {
52
+ maxRetriesPerRequest: null,
53
+ },
54
+ };
55
+ function isRedisCluster(client) {
56
+ return client instanceof ioredis_1.Cluster || client.isCluster === true;
57
+ }
41
58
  function createRedisClient(config) {
42
59
  if (isRedisClient(config)) {
43
60
  return config;
@@ -46,7 +63,19 @@ function createRedisClient(config) {
46
63
  return new ioredis_1.default(config);
47
64
  }
48
65
  if (isClusterConfig(config)) {
49
- return new ioredis_1.Cluster(config.nodes, config.options);
66
+ const { nodes, options } = config;
67
+ return new ioredis_1.Cluster(nodes, {
68
+ ...exports.DEFAULT_CLUSTER_OPTIONS,
69
+ ...options,
70
+ scripts: {
71
+ ...(0, scripts_1.getClusterScriptDefinitions)(),
72
+ ...options?.scripts,
73
+ },
74
+ redisOptions: {
75
+ ...exports.DEFAULT_CLUSTER_OPTIONS.redisOptions,
76
+ ...options?.redisOptions,
77
+ },
78
+ });
50
79
  }
51
80
  return new ioredis_1.default(config);
52
81
  }
@@ -59,7 +88,11 @@ function isClusterConfig(config) {
59
88
  "nodes" in config &&
60
89
  Array.isArray(config.nodes));
61
90
  }
62
- function buildKey(prefix, key) {
63
- return `${prefix}:${key}`;
91
+ function buildKey(prefix, key, hashTag) {
92
+ const namespaced = `${prefix}:${key}`;
93
+ if (!hashTag) {
94
+ return namespaced;
95
+ }
96
+ return `{${hashTag}}:${namespaced}`;
64
97
  }
65
98
  //# sourceMappingURL=redis.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"redis.js","sourceRoot":"","sources":["../../src/utils/redis.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAKA,8CAcC;AAiBD,4BAEC;AAtCD,mDAA4D;AAG/C,QAAA,kBAAkB,GAAG,SAAS,CAAC;AAE5C,SAAgB,iBAAiB,CAAC,MAAmB;IACnD,IAAI,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,IAAI,iBAAK,CAAC,MAAM,CAAC,CAAC;IAC3B,CAAC;IAED,IAAI,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5B,OAAO,IAAI,iBAAO,CAAC,MAAM,CAAC,KAAK,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;IACnD,CAAC;IAED,OAAO,IAAI,iBAAK,CAAC,MAAM,CAAC,CAAC;AAC3B,CAAC;AAED,SAAS,aAAa,CAAC,MAAmB;IACxC,OAAO,MAAM,YAAY,iBAAK,IAAI,MAAM,YAAY,iBAAO,CAAC;AAC9D,CAAC;AAED,SAAS,eAAe,CACtB,MAAmB;IAEnB,OAAO,CACL,OAAO,MAAM,KAAK,QAAQ;QAC1B,MAAM,KAAK,IAAI;QACf,OAAO,IAAI,MAAM;QACjB,KAAK,CAAC,OAAO,CAAE,MAA6B,CAAC,KAAK,CAAC,CACpD,CAAC;AACJ,CAAC;AAED,SAAgB,QAAQ,CAAC,MAAc,EAAE,GAAW;IAClD,OAAO,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC;AAC5B,CAAC"}
1
+ {"version":3,"file":"redis.js","sourceRoot":"","sources":["../../src/utils/redis.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAmBA,wCAEC;AAED,8CA0BC;AAiBD,4BAYC;AA9ED,mDAA8D;AAE9D,uCAAwD;AAE3C,QAAA,kBAAkB,GAAG,SAAS,CAAC;AAE/B,QAAA,uBAAuB,GAAmB;IACrD,UAAU,EAAE,QAAQ;IACpB,gBAAgB,EAAE,IAAI;IACtB,eAAe,EAAE,EAAE;IACnB,oBAAoB,EAAE,GAAG;IACzB,uBAAuB,EAAE,GAAG;IAC5B,mBAAmB,EAAE,IAAI;IACzB,oBAAoB,EAAE,IAAI;IAC1B,YAAY,EAAE;QACZ,oBAAoB,EAAE,IAAI;KAC3B;CACF,CAAC;AAEF,SAAgB,cAAc,CAAC,MAAmB;IAChD,OAAO,MAAM,YAAY,iBAAO,IAAI,MAAM,CAAC,SAAS,KAAK,IAAI,CAAC;AAChE,CAAC;AAED,SAAgB,iBAAiB,CAAC,MAAmB;IACnD,IAAI,aAAa,CAAC,MAAM,CAAC,EAAE,CAAC;QAC1B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QAC/B,OAAO,IAAI,iBAAK,CAAC,MAAM,CAAC,CAAC;IAC3B,CAAC;IAED,IAAI,eAAe,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5B,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,MAAM,CAAC;QAClC,OAAO,IAAI,iBAAO,CAAC,KAAK,EAAE;YACxB,GAAG,+BAAuB;YAC1B,GAAG,OAAO;YACV,OAAO,EAAE;gBACP,GAAG,IAAA,qCAA2B,GAAE;gBAChC,GAAG,OAAO,EAAE,OAAO;aACpB;YACD,YAAY,EAAE;gBACZ,GAAG,+BAAuB,CAAC,YAAY;gBACvC,GAAG,OAAO,EAAE,YAAY;aACzB;SACF,CAAC,CAAC;IACL,CAAC;IAED,OAAO,IAAI,iBAAK,CAAC,MAAM,CAAC,CAAC;AAC3B,CAAC;AAED,SAAS,aAAa,CAAC,MAAmB;IACxC,OAAO,MAAM,YAAY,iBAAK,IAAI,MAAM,YAAY,iBAAO,CAAC;AAC9D,CAAC;AAED,SAAS,eAAe,CACtB,MAAmB;IAEnB,OAAO,CACL,OAAO,MAAM,KAAK,QAAQ;QAC1B,MAAM,KAAK,IAAI;QACf,OAAO,IAAI,MAAM;QACjB,KAAK,CAAC,OAAO,CAAE,MAA6B,CAAC,KAAK,CAAC,CACpD,CAAC;AACJ,CAAC;AAED,SAAgB,QAAQ,CACtB,MAAc,EACd,GAAW,EACX,OAAgB;IAEhB,MAAM,UAAU,GAAG,GAAG,MAAM,IAAI,GAAG,EAAE,CAAC;IAEtC,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,OAAO,IAAI,OAAO,KAAK,UAAU,EAAE,CAAC;AACtC,CAAC"}
@@ -1,11 +1,25 @@
1
1
  import type { RedisClient } from "../types";
2
- export declare function loadScriptSha(redis: RedisClient, name: string): Promise<string>;
3
- export declare function evalScript(redis: RedisClient, name: string, keys: string[], args: (string | number)[]): Promise<(string | number)[]>;
2
+ export declare const SCRIPT_COMMANDS: {
3
+ readonly sliding: "limitlySliding";
4
+ readonly token: "limitlyToken";
5
+ readonly concurrencyAcquire: "limitlyConcurrencyAcquire";
6
+ readonly concurrencyRelease: "limitlyConcurrencyRelease";
7
+ readonly gcra: "limitlyGcra";
8
+ };
9
+ export type ScriptName = keyof typeof SCRIPT_COMMANDS;
10
+ export declare function getClusterScriptDefinitions(): Record<string, {
11
+ lua: string;
12
+ numberOfKeys: number;
13
+ }>;
14
+ export declare function registerRedisScripts(redis: RedisClient): void;
15
+ export declare function warmupRedisScripts(redis: RedisClient): Promise<void>;
16
+ export declare function evalScript(redis: RedisClient, name: ScriptName, keys: string[], args: (string | number)[]): Promise<(string | number)[]>;
4
17
  export declare function parseScriptResult(result: (string | number)[]): {
5
18
  allowed: boolean;
6
19
  limit: number;
7
20
  remaining: number;
8
21
  reset: number;
9
22
  retryAfter: number;
23
+ slotId?: string;
10
24
  };
11
25
  //# sourceMappingURL=scripts.d.ts.map