limitly 1.0.1 → 2.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.
- package/README.md +301 -22
- package/dist/algorithms/factory.d.ts +3 -2
- package/dist/algorithms/factory.d.ts.map +1 -1
- package/dist/algorithms/factory.js +3 -3
- package/dist/algorithms/factory.js.map +1 -1
- package/dist/algorithms/sliding-window.d.ts +4 -4
- package/dist/algorithms/sliding-window.d.ts.map +1 -1
- package/dist/algorithms/sliding-window.js +3 -23
- package/dist/algorithms/sliding-window.js.map +1 -1
- package/dist/algorithms/token-bucket.d.ts +4 -4
- package/dist/algorithms/token-bucket.d.ts.map +1 -1
- package/dist/algorithms/token-bucket.js +3 -20
- package/dist/algorithms/token-bucket.js.map +1 -1
- package/dist/index.d.ts +15 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +32 -1
- package/dist/index.js.map +1 -1
- package/dist/limiter.d.ts +19 -7
- package/dist/limiter.d.ts.map +1 -1
- package/dist/limiter.js +66 -15
- package/dist/limiter.js.map +1 -1
- package/dist/middleware/bun.d.ts +9 -0
- package/dist/middleware/bun.d.ts.map +1 -0
- package/dist/middleware/bun.js +96 -0
- package/dist/middleware/bun.js.map +1 -0
- package/dist/middleware/express.d.ts.map +1 -1
- package/dist/middleware/express.js +11 -5
- package/dist/middleware/express.js.map +1 -1
- package/dist/middleware/fastify.d.ts +3 -3
- package/dist/middleware/fastify.d.ts.map +1 -1
- package/dist/middleware/fastify.js +19 -13
- package/dist/middleware/fastify.js.map +1 -1
- package/dist/middleware/hono.d.ts +5 -0
- package/dist/middleware/hono.d.ts.map +1 -0
- package/dist/middleware/hono.js +57 -0
- package/dist/middleware/hono.js.map +1 -0
- package/dist/middleware/koa.d.ts +5 -0
- package/dist/middleware/koa.d.ts.map +1 -0
- package/dist/middleware/koa.js +54 -0
- package/dist/middleware/koa.js.map +1 -0
- package/dist/middleware/nest.d.ts +14 -0
- package/dist/middleware/nest.d.ts.map +1 -0
- package/dist/middleware/nest.js +102 -0
- package/dist/middleware/nest.js.map +1 -0
- package/dist/stores/factory.d.ts +5 -0
- package/dist/stores/factory.d.ts.map +1 -0
- package/dist/stores/factory.js +36 -0
- package/dist/stores/factory.js.map +1 -0
- package/dist/stores/memcached-store.d.ts +13 -0
- package/dist/stores/memcached-store.d.ts.map +1 -0
- package/dist/stores/memcached-store.js +117 -0
- package/dist/stores/memcached-store.js.map +1 -0
- package/dist/stores/redis-store.d.ts +12 -0
- package/dist/stores/redis-store.d.ts.map +1 -0
- package/dist/stores/redis-store.js +54 -0
- package/dist/stores/redis-store.js.map +1 -0
- package/dist/stores/types.d.ts +8 -0
- package/dist/stores/types.d.ts.map +1 -0
- package/dist/stores/types.js +3 -0
- package/dist/stores/types.js.map +1 -0
- package/dist/types/index.d.ts +62 -1
- package/dist/types/index.d.ts.map +1 -1
- package/dist/utils/defaults.d.ts +6 -0
- package/dist/utils/defaults.d.ts.map +1 -0
- package/dist/utils/defaults.js +59 -0
- package/dist/utils/defaults.js.map +1 -0
- package/dist/utils/memcached.d.ts +11 -0
- package/dist/utils/memcached.d.ts.map +1 -0
- package/dist/utils/memcached.js +91 -0
- package/dist/utils/memcached.js.map +1 -0
- package/dist/utils/metrics.d.ts +21 -0
- package/dist/utils/metrics.d.ts.map +1 -0
- package/dist/utils/metrics.js +60 -0
- package/dist/utils/metrics.js.map +1 -0
- package/dist/utils/redis.d.ts +1 -0
- package/dist/utils/redis.d.ts.map +1 -1
- package/dist/utils/redis.js +2 -0
- package/dist/utils/redis.js.map +1 -1
- package/package.json +60 -3
|
@@ -0,0 +1,102 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
|
|
3
|
+
var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
|
|
4
|
+
if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
|
|
5
|
+
else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
|
|
6
|
+
return c > 3 && r && Object.defineProperty(target, key, r), r;
|
|
7
|
+
};
|
|
8
|
+
var __metadata = (this && this.__metadata) || function (k, v) {
|
|
9
|
+
if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
|
|
10
|
+
};
|
|
11
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
12
|
+
exports.LimitlyModule = exports.RateLimit = exports.RATE_LIMIT_KEY = void 0;
|
|
13
|
+
exports.createNestGuard = createNestGuard;
|
|
14
|
+
exports.limitlyNestModule = limitlyNestModule;
|
|
15
|
+
const common_1 = require("@nestjs/common");
|
|
16
|
+
const core_1 = require("@nestjs/core");
|
|
17
|
+
const headers_1 = require("../utils/headers");
|
|
18
|
+
const metrics_1 = require("../utils/metrics");
|
|
19
|
+
const DEFAULT_KEY = (req) => req.ip ?? "unknown";
|
|
20
|
+
exports.RATE_LIMIT_KEY = "limitly:rate-limit";
|
|
21
|
+
const RateLimit = (options) => (0, common_1.SetMetadata)(exports.RATE_LIMIT_KEY, options);
|
|
22
|
+
exports.RateLimit = RateLimit;
|
|
23
|
+
function createNestGuard(limiter) {
|
|
24
|
+
return function guard(defaultOptions) {
|
|
25
|
+
let NestGuard = class NestGuard {
|
|
26
|
+
constructor(reflector) {
|
|
27
|
+
this.reflector = reflector;
|
|
28
|
+
}
|
|
29
|
+
async canActivate(context) {
|
|
30
|
+
const metadata = this.reflector.getAllAndOverride(exports.RATE_LIMIT_KEY, [context.getHandler(), context.getClass()]);
|
|
31
|
+
const shouldApply = metadata !== undefined ||
|
|
32
|
+
defaultOptions !== undefined ||
|
|
33
|
+
Object.keys(limiter.getDefaultOptions()).length > 0;
|
|
34
|
+
if (!shouldApply) {
|
|
35
|
+
return true;
|
|
36
|
+
}
|
|
37
|
+
const options = limiter.resolveOptions({
|
|
38
|
+
...defaultOptions,
|
|
39
|
+
...metadata,
|
|
40
|
+
});
|
|
41
|
+
const strategy = limiter.createStrategy(options);
|
|
42
|
+
const http = context.switchToHttp();
|
|
43
|
+
const request = http.getRequest();
|
|
44
|
+
const response = http.getResponse();
|
|
45
|
+
const keyExtractor = (options.key ?? DEFAULT_KEY);
|
|
46
|
+
const key = keyExtractor(request) ?? "unknown";
|
|
47
|
+
const sendHeaders = options.headers !== false;
|
|
48
|
+
const failOpen = options.failOpen ?? true;
|
|
49
|
+
const outcome = await (0, metrics_1.consumeRateLimit)({
|
|
50
|
+
strategy,
|
|
51
|
+
key,
|
|
52
|
+
options,
|
|
53
|
+
failOpen,
|
|
54
|
+
storeType: limiter.getStoreType(),
|
|
55
|
+
context: context,
|
|
56
|
+
});
|
|
57
|
+
if (outcome.status === "error") {
|
|
58
|
+
if (failOpen) {
|
|
59
|
+
return true;
|
|
60
|
+
}
|
|
61
|
+
throw new common_1.ServiceUnavailableException({
|
|
62
|
+
error: "Service Unavailable",
|
|
63
|
+
});
|
|
64
|
+
}
|
|
65
|
+
const result = outcome.result;
|
|
66
|
+
if (sendHeaders) {
|
|
67
|
+
(0, headers_1.setHeaders)(response, (0, headers_1.buildRateLimitHeaders)(result));
|
|
68
|
+
}
|
|
69
|
+
if (result.allowed) {
|
|
70
|
+
return true;
|
|
71
|
+
}
|
|
72
|
+
if (options.onLimitReached) {
|
|
73
|
+
await options.onLimitReached(request, response);
|
|
74
|
+
return false;
|
|
75
|
+
}
|
|
76
|
+
throw new common_1.HttpException({ error: "Too Many Requests" }, common_1.HttpStatus.TOO_MANY_REQUESTS);
|
|
77
|
+
}
|
|
78
|
+
};
|
|
79
|
+
NestGuard = __decorate([
|
|
80
|
+
(0, common_1.Injectable)(),
|
|
81
|
+
__metadata("design:paramtypes", [core_1.Reflector])
|
|
82
|
+
], NestGuard);
|
|
83
|
+
return NestGuard;
|
|
84
|
+
};
|
|
85
|
+
}
|
|
86
|
+
let LimitlyModule = class LimitlyModule {
|
|
87
|
+
};
|
|
88
|
+
exports.LimitlyModule = LimitlyModule;
|
|
89
|
+
exports.LimitlyModule = LimitlyModule = __decorate([
|
|
90
|
+
(0, common_1.Module)({})
|
|
91
|
+
], LimitlyModule);
|
|
92
|
+
function limitlyNestModule(options) {
|
|
93
|
+
const { limiter, global, ...middlewareOptions } = options;
|
|
94
|
+
const Guard = createNestGuard(limiter)(middlewareOptions);
|
|
95
|
+
return {
|
|
96
|
+
module: LimitlyModule,
|
|
97
|
+
providers: [Guard],
|
|
98
|
+
exports: [Guard],
|
|
99
|
+
global: global ?? false,
|
|
100
|
+
};
|
|
101
|
+
}
|
|
102
|
+
//# sourceMappingURL=nest.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"nest.js","sourceRoot":"","sources":["../../src/middleware/nest.ts"],"names":[],"mappings":";;;;;;;;;;;;AA+BA,0CAkFC;AAKD,8CAYC;AAlID,2CAWwB;AACxB,uCAAyC;AAIzC,8CAAqE;AACrE,8CAAoD;AAEpD,MAAM,WAAW,GAAG,CAAC,GAAY,EAAU,EAAE,CAAC,GAAG,CAAC,EAAE,IAAI,SAAS,CAAC;AAErD,QAAA,cAAc,GAAG,oBAAoB,CAAC;AAE5C,MAAM,SAAS,GAAG,CAAC,OAA+B,EAAE,EAAE,CAC3D,IAAA,oBAAW,EAAC,sBAAc,EAAE,OAAO,CAAC,CAAC;AAD1B,QAAA,SAAS,aACiB;AAOvC,SAAgB,eAAe,CAAC,OAAmB;IACjD,OAAO,SAAS,KAAK,CACnB,cAAuC;QAEvC,IACM,SAAS,GADf,MACM,SAAS;YACb,YAA6B,SAAoB;gBAApB,cAAS,GAAT,SAAS,CAAW;YAAG,CAAC;YAErD,KAAK,CAAC,WAAW,CAAC,OAAyB;gBACzC,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,iBAAiB,CAC/C,sBAAc,EACd,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,OAAO,CAAC,QAAQ,EAAE,CAAC,CAC3C,CAAC;gBAEF,MAAM,WAAW,GACf,QAAQ,KAAK,SAAS;oBACtB,cAAc,KAAK,SAAS;oBAC5B,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,iBAAiB,EAAE,CAAC,CAAC,MAAM,GAAG,CAAC,CAAC;gBAEtD,IAAI,CAAC,WAAW,EAAE,CAAC;oBACjB,OAAO,IAAI,CAAC;gBACd,CAAC;gBAED,MAAM,OAAO,GAAG,OAAO,CAAC,cAAc,CAAC;oBACrC,GAAG,cAAc;oBACjB,GAAG,QAAQ;iBACZ,CAAC,CAAC;gBAEH,MAAM,QAAQ,GAAG,OAAO,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC;gBACjD,MAAM,IAAI,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC;gBACpC,MAAM,OAAO,GAAG,IAAI,CAAC,UAAU,EAAW,CAAC;gBAC3C,MAAM,QAAQ,GAAG,IAAI,CAAC,WAAW,EAAY,CAAC;gBAE9C,MAAM,YAAY,GAAG,CAAC,OAAO,CAAC,GAAG,IAAI,WAAW,CAEzB,CAAC;gBACxB,MAAM,GAAG,GAAG,YAAY,CAAC,OAAO,CAAC,IAAI,SAAS,CAAC;gBAC/C,MAAM,WAAW,GAAG,OAAO,CAAC,OAAO,KAAK,KAAK,CAAC;gBAC9C,MAAM,QAAQ,GAAG,OAAO,CAAC,QAAQ,IAAI,IAAI,CAAC;gBAE1C,MAAM,OAAO,GAAG,MAAM,IAAA,0BAAgB,EAAC;oBACrC,QAAQ;oBACR,GAAG;oBACH,OAAO;oBACP,QAAQ;oBACR,SAAS,EAAE,OAAO,CAAC,YAAY,EAAE;oBACjC,OAAO,EAAE,OAAO;iBACjB,CAAC,CAAC;gBAEH,IAAI,OAAO,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;oBAC/B,IAAI,QAAQ,EAAE,CAAC;wBACb,OAAO,IAAI,CAAC;oBACd,CAAC;oBACD,MAAM,IAAI,oCAA2B,CAAC;wBACpC,KAAK,EAAE,qBAAqB;qBAC7B,CAAC,CAAC;gBACL,CAAC;gBAED,MAAM,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC;gBAE9B,IAAI,WAAW,EAAE,CAAC;oBAChB,IAAA,oBAAU,EAAC,QAAQ,EAAE,IAAA,+BAAqB,EAAC,MAAM,CAAC,CAAC,CAAC;gBACtD,CAAC;gBAED,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;oBACnB,OAAO,IAAI,CAAC;gBACd,CAAC;gBAED,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;oBAC3B,MAAM,OAAO,CAAC,cAAc,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;oBAChD,OAAO,KAAK,CAAC;gBACf,CAAC;gBAED,MAAM,IAAI,sBAAa,CACrB,EAAE,KAAK,EAAE,mBAAmB,EAAE,EAC9B,mBAAU,CAAC,iBAAiB,CAC7B,CAAC;YACJ,CAAC;SACF,CAAA;QAzEK,SAAS;YADd,IAAA,mBAAU,GAAE;6CAE6B,gBAAS;WAD7C,SAAS,CAyEd;QAED,OAAO,SAAS,CAAC;IACnB,CAAC,CAAC;AACJ,CAAC;AAGM,IAAM,aAAa,GAAnB,MAAM,aAAa;CAAG,CAAA;AAAhB,sCAAa;wBAAb,aAAa;IADzB,IAAA,eAAM,EAAC,EAAE,CAAC;GACE,aAAa,CAAG;AAE7B,SAAgB,iBAAiB,CAC/B,OAA6B;IAE7B,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,GAAG,iBAAiB,EAAE,GAAG,OAAO,CAAC;IAC1D,MAAM,KAAK,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC,iBAAiB,CAAC,CAAC;IAE1D,OAAO;QACL,MAAM,EAAE,aAAa;QACrB,SAAS,EAAE,CAAC,KAAK,CAAC;QAClB,OAAO,EAAE,CAAC,KAAK,CAAC;QAChB,MAAM,EAAE,MAAM,IAAI,KAAK;KACxB,CAAC;AACJ,CAAC"}
|
|
@@ -0,0 +1,5 @@
|
|
|
1
|
+
import type { RedisLimitOptions } from "../types";
|
|
2
|
+
import type { RateLimitStore, StoreType } from "./types";
|
|
3
|
+
export declare function resolveStoreType(options: RedisLimitOptions): StoreType;
|
|
4
|
+
export declare function createStore(options: RedisLimitOptions): RateLimitStore;
|
|
5
|
+
//# sourceMappingURL=factory.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"factory.d.ts","sourceRoot":"","sources":["../../src/stores/factory.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAC;AAKlD,OAAO,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAIzD,wBAAgB,gBAAgB,CAAC,OAAO,EAAE,iBAAiB,GAAG,SAAS,CAQtE;AAED,wBAAgB,WAAW,CAAC,OAAO,EAAE,iBAAiB,GAAG,cAAc,CA2BtE"}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.resolveStoreType = resolveStoreType;
|
|
4
|
+
exports.createStore = createStore;
|
|
5
|
+
const memcached_1 = require("../utils/memcached");
|
|
6
|
+
const redis_1 = require("../utils/redis");
|
|
7
|
+
const memcached_store_1 = require("./memcached-store");
|
|
8
|
+
const redis_store_1 = require("./redis-store");
|
|
9
|
+
const REDIS_COMPATIBLE_STORES = ["redis", "valkey", "dragonfly"];
|
|
10
|
+
function resolveStoreType(options) {
|
|
11
|
+
if (options.store) {
|
|
12
|
+
return options.store;
|
|
13
|
+
}
|
|
14
|
+
if (options.memcached) {
|
|
15
|
+
return "memcached";
|
|
16
|
+
}
|
|
17
|
+
return "redis";
|
|
18
|
+
}
|
|
19
|
+
function createStore(options) {
|
|
20
|
+
const storeType = resolveStoreType(options);
|
|
21
|
+
const keyPrefix = options.keyPrefix ?? redis_1.DEFAULT_KEY_PREFIX;
|
|
22
|
+
if (storeType === "memcached") {
|
|
23
|
+
if (!options.memcached) {
|
|
24
|
+
throw new Error('Memcached configuration is required when store is "memcached"');
|
|
25
|
+
}
|
|
26
|
+
return new memcached_store_1.MemcachedStore((0, memcached_1.createMemcachedClient)(options.memcached), keyPrefix);
|
|
27
|
+
}
|
|
28
|
+
if (!options.redis) {
|
|
29
|
+
throw new Error(`Redis configuration is required when store is "${storeType}"`);
|
|
30
|
+
}
|
|
31
|
+
if (!REDIS_COMPATIBLE_STORES.includes(storeType)) {
|
|
32
|
+
throw new Error(`Unsupported store type: ${storeType}`);
|
|
33
|
+
}
|
|
34
|
+
return new redis_store_1.RedisStore((0, redis_1.createRedisClient)(options.redis), keyPrefix, storeType);
|
|
35
|
+
}
|
|
36
|
+
//# sourceMappingURL=factory.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"factory.js","sourceRoot":"","sources":["../../src/stores/factory.ts"],"names":[],"mappings":";;AASA,4CAQC;AAED,kCA2BC;AA7CD,kDAA2D;AAC3D,0CAAuE;AACvE,uDAAmD;AACnD,+CAA2C;AAG3C,MAAM,uBAAuB,GAAgB,CAAC,OAAO,EAAE,QAAQ,EAAE,WAAW,CAAC,CAAC;AAE9E,SAAgB,gBAAgB,CAAC,OAA0B;IACzD,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;QAClB,OAAO,OAAO,CAAC,KAAK,CAAC;IACvB,CAAC;IACD,IAAI,OAAO,CAAC,SAAS,EAAE,CAAC;QACtB,OAAO,WAAW,CAAC;IACrB,CAAC;IACD,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,SAAgB,WAAW,CAAC,OAA0B;IACpD,MAAM,SAAS,GAAG,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAC5C,MAAM,SAAS,GAAG,OAAO,CAAC,SAAS,IAAI,0BAAkB,CAAC;IAE1D,IAAI,SAAS,KAAK,WAAW,EAAE,CAAC;QAC9B,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CACb,+DAA+D,CAChE,CAAC;QACJ,CAAC;QACD,OAAO,IAAI,gCAAc,CACvB,IAAA,iCAAqB,EAAC,OAAO,CAAC,SAAS,CAAC,EACxC,SAAS,CACV,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,CAAC;QACnB,MAAM,IAAI,KAAK,CACb,kDAAkD,SAAS,GAAG,CAC/D,CAAC;IACJ,CAAC;IAED,IAAI,CAAC,uBAAuB,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;QACjD,MAAM,IAAI,KAAK,CAAC,2BAA2B,SAAS,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED,OAAO,IAAI,wBAAU,CAAC,IAAA,yBAAiB,EAAC,OAAO,CAAC,KAAK,CAAC,EAAE,SAAS,EAAE,SAAS,CAAC,CAAC;AAChF,CAAC"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import type { RateLimitResult } from "../types";
|
|
2
|
+
import type { MemcachedClient } from "../types";
|
|
3
|
+
import type { RateLimitStore } from "./types";
|
|
4
|
+
export declare class MemcachedStore implements RateLimitStore {
|
|
5
|
+
readonly type: "memcached";
|
|
6
|
+
private readonly client;
|
|
7
|
+
private readonly keyPrefix;
|
|
8
|
+
constructor(client: MemcachedClient, keyPrefix: string);
|
|
9
|
+
getClient(): MemcachedClient;
|
|
10
|
+
slidingWindow(key: string, limit: number, window: number): Promise<RateLimitResult>;
|
|
11
|
+
tokenBucket(key: string, capacity: number, refillRate: number): Promise<RateLimitResult>;
|
|
12
|
+
}
|
|
13
|
+
//# sourceMappingURL=memcached-store.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"memcached-store.d.ts","sourceRoot":"","sources":["../../src/stores/memcached-store.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAChD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,UAAU,CAAC;AAShD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AAI9C,qBAAa,cAAe,YAAW,cAAc;IACnD,QAAQ,CAAC,IAAI,EAAG,WAAW,CAAU;IACrC,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAkB;IACzC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;gBAEvB,MAAM,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM;IAKtD,SAAS,IAAI,eAAe;IAItB,aAAa,CACjB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,eAAe,CAAC;IA4CrB,WAAW,CACf,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,eAAe,CAAC;CAkG5B"}
|
|
@@ -0,0 +1,117 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.MemcachedStore = void 0;
|
|
4
|
+
const redis_1 = require("../utils/redis");
|
|
5
|
+
const memcached_1 = require("../utils/memcached");
|
|
6
|
+
const CAS_RETRIES = 5;
|
|
7
|
+
class MemcachedStore {
|
|
8
|
+
constructor(client, keyPrefix) {
|
|
9
|
+
this.type = "memcached";
|
|
10
|
+
this.client = client;
|
|
11
|
+
this.keyPrefix = keyPrefix;
|
|
12
|
+
}
|
|
13
|
+
getClient() {
|
|
14
|
+
return this.client;
|
|
15
|
+
}
|
|
16
|
+
async slidingWindow(key, limit, window) {
|
|
17
|
+
const baseKey = (0, redis_1.buildKey)(this.keyPrefix, `sw:${key}`);
|
|
18
|
+
const now = Date.now();
|
|
19
|
+
const windowMs = window * 1000;
|
|
20
|
+
const currentWindow = Math.floor(now / windowMs);
|
|
21
|
+
const previousWindow = currentWindow - 1;
|
|
22
|
+
const elapsedRatio = (now % windowMs) / windowMs;
|
|
23
|
+
const currentKey = `${baseKey}:${currentWindow}`;
|
|
24
|
+
const previousKey = `${baseKey}:${previousWindow}`;
|
|
25
|
+
await (0, memcached_1.memcachedAdd)(this.client, currentKey, "0", window * 2);
|
|
26
|
+
const currentCount = await (0, memcached_1.memcachedIncr)(this.client, currentKey, 1);
|
|
27
|
+
const previousRaw = await (0, memcached_1.memcachedGet)(this.client, previousKey);
|
|
28
|
+
const previousCount = previousRaw ? Number(previousRaw) : 0;
|
|
29
|
+
const weightedCount = previousCount * (1 - elapsedRatio) + currentCount;
|
|
30
|
+
const reset = Math.ceil((now + windowMs) / 1000);
|
|
31
|
+
if (weightedCount <= limit) {
|
|
32
|
+
return {
|
|
33
|
+
allowed: true,
|
|
34
|
+
limit,
|
|
35
|
+
remaining: Math.max(0, Math.floor(limit - weightedCount)),
|
|
36
|
+
reset,
|
|
37
|
+
};
|
|
38
|
+
}
|
|
39
|
+
const retryAfter = Math.max(1, Math.ceil((1 - elapsedRatio) * window));
|
|
40
|
+
return {
|
|
41
|
+
allowed: false,
|
|
42
|
+
limit,
|
|
43
|
+
remaining: 0,
|
|
44
|
+
reset,
|
|
45
|
+
retryAfter,
|
|
46
|
+
};
|
|
47
|
+
}
|
|
48
|
+
async tokenBucket(key, capacity, refillRate) {
|
|
49
|
+
const cacheKey = (0, redis_1.buildKey)(this.keyPrefix, `tb:${key}`);
|
|
50
|
+
const now = Date.now();
|
|
51
|
+
const ttl = Math.ceil(capacity / refillRate) + 1;
|
|
52
|
+
for (let attempt = 0; attempt < CAS_RETRIES; attempt++) {
|
|
53
|
+
const existing = await (0, memcached_1.memcachedGets)(this.client, cacheKey);
|
|
54
|
+
let tokens;
|
|
55
|
+
let lastRefill;
|
|
56
|
+
if (!existing) {
|
|
57
|
+
tokens = capacity;
|
|
58
|
+
lastRefill = now;
|
|
59
|
+
}
|
|
60
|
+
else {
|
|
61
|
+
const parsed = JSON.parse(existing.value);
|
|
62
|
+
tokens = parsed.tokens;
|
|
63
|
+
lastRefill = parsed.lastRefill;
|
|
64
|
+
}
|
|
65
|
+
const elapsed = (now - lastRefill) / 1000;
|
|
66
|
+
tokens = Math.min(capacity, tokens + elapsed * refillRate);
|
|
67
|
+
lastRefill = now;
|
|
68
|
+
if (tokens < 1) {
|
|
69
|
+
const retryAfter = Math.max(1, Math.ceil((1 - tokens) / refillRate));
|
|
70
|
+
const reset = Math.ceil(now / 1000) + retryAfter;
|
|
71
|
+
if (!existing) {
|
|
72
|
+
await (0, memcached_1.memcachedAdd)(this.client, cacheKey, JSON.stringify({ tokens, lastRefill }), ttl);
|
|
73
|
+
}
|
|
74
|
+
else {
|
|
75
|
+
await (0, memcached_1.memcachedCas)(this.client, cacheKey, JSON.stringify({ tokens, lastRefill }), existing.cas, ttl);
|
|
76
|
+
}
|
|
77
|
+
return {
|
|
78
|
+
allowed: false,
|
|
79
|
+
limit: capacity,
|
|
80
|
+
remaining: 0,
|
|
81
|
+
reset,
|
|
82
|
+
retryAfter,
|
|
83
|
+
};
|
|
84
|
+
}
|
|
85
|
+
tokens -= 1;
|
|
86
|
+
const payload = JSON.stringify({ tokens, lastRefill });
|
|
87
|
+
if (!existing) {
|
|
88
|
+
try {
|
|
89
|
+
await (0, memcached_1.memcachedAdd)(this.client, cacheKey, payload, ttl);
|
|
90
|
+
return {
|
|
91
|
+
allowed: true,
|
|
92
|
+
limit: capacity,
|
|
93
|
+
remaining: Math.floor(tokens),
|
|
94
|
+
reset: Math.ceil(now / 1000) +
|
|
95
|
+
Math.ceil((capacity - tokens) / refillRate),
|
|
96
|
+
};
|
|
97
|
+
}
|
|
98
|
+
catch {
|
|
99
|
+
continue;
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
const updated = await (0, memcached_1.memcachedCas)(this.client, cacheKey, payload, existing.cas, ttl);
|
|
103
|
+
if (updated) {
|
|
104
|
+
return {
|
|
105
|
+
allowed: true,
|
|
106
|
+
limit: capacity,
|
|
107
|
+
remaining: Math.floor(tokens),
|
|
108
|
+
reset: Math.ceil(now / 1000) +
|
|
109
|
+
Math.ceil((capacity - tokens) / refillRate),
|
|
110
|
+
};
|
|
111
|
+
}
|
|
112
|
+
}
|
|
113
|
+
throw new Error("Token bucket CAS retries exhausted");
|
|
114
|
+
}
|
|
115
|
+
}
|
|
116
|
+
exports.MemcachedStore = MemcachedStore;
|
|
117
|
+
//# sourceMappingURL=memcached-store.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"memcached-store.js","sourceRoot":"","sources":["../../src/stores/memcached-store.ts"],"names":[],"mappings":";;;AAEA,0CAA0C;AAC1C,kDAM4B;AAG5B,MAAM,WAAW,GAAG,CAAC,CAAC;AAEtB,MAAa,cAAc;IAKzB,YAAY,MAAuB,EAAE,SAAiB;QAJ7C,SAAI,GAAG,WAAoB,CAAC;QAKnC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,SAAS,CAAC;IAC7B,CAAC;IAED,SAAS;QACP,OAAO,IAAI,CAAC,MAAM,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,aAAa,CACjB,GAAW,EACX,KAAa,EACb,MAAc;QAEd,MAAM,OAAO,GAAG,IAAA,gBAAQ,EAAC,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,EAAE,CAAC,CAAC;QACtD,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,CAAC;QACvB,MAAM,QAAQ,GAAG,MAAM,GAAG,IAAI,CAAC;QAC/B,MAAM,aAAa,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,GAAG,QAAQ,CAAC,CAAC;QACjD,MAAM,cAAc,GAAG,aAAa,GAAG,CAAC,CAAC;QACzC,MAAM,YAAY,GAAG,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,QAAQ,CAAC;QAEjD,MAAM,UAAU,GAAG,GAAG,OAAO,IAAI,aAAa,EAAE,CAAC;QACjD,MAAM,WAAW,GAAG,GAAG,OAAO,IAAI,cAAc,EAAE,CAAC;QAEnD,MAAM,IAAA,wBAAY,EAAC,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,GAAG,EAAE,MAAM,GAAG,CAAC,CAAC,CAAC;QAC7D,MAAM,YAAY,GAAG,MAAM,IAAA,yBAAa,EAAC,IAAI,CAAC,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC,CAAC;QAErE,MAAM,WAAW,GAAG,MAAM,IAAA,wBAAY,EAAC,IAAI,CAAC,MAAM,EAAE,WAAW,CAAC,CAAC;QACjE,MAAM,aAAa,GAAG,WAAW,CAAC,CAAC,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;QAC5D,MAAM,aAAa,GACjB,aAAa,GAAG,CAAC,CAAC,GAAG,YAAY,CAAC,GAAG,YAAY,CAAC;QAEpD,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,GAAG,GAAG,QAAQ,CAAC,GAAG,IAAI,CAAC,CAAC;QAEjD,IAAI,aAAa,IAAI,KAAK,EAAE,CAAC;YAC3B,OAAO;gBACL,OAAO,EAAE,IAAI;gBACb,KAAK;gBACL,SAAS,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,KAAK,CAAC,KAAK,GAAG,aAAa,CAAC,CAAC;gBACzD,KAAK;aACN,CAAC;QACJ,CAAC;QAED,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CACzB,CAAC,EACD,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,YAAY,CAAC,GAAG,MAAM,CAAC,CACvC,CAAC;QAEF,OAAO;YACL,OAAO,EAAE,KAAK;YACd,KAAK;YACL,SAAS,EAAE,CAAC;YACZ,KAAK;YACL,UAAU;SACX,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;QACvB,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,CAAC;QAEjD,KAAK,IAAI,OAAO,GAAG,CAAC,EAAE,OAAO,GAAG,WAAW,EAAE,OAAO,EAAE,EAAE,CAAC;YACvD,MAAM,QAAQ,GAAG,MAAM,IAAA,yBAAa,EAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,CAAC,CAAC;YAE5D,IAAI,MAAc,CAAC;YACnB,IAAI,UAAkB,CAAC;YAEvB,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,MAAM,GAAG,QAAQ,CAAC;gBAClB,UAAU,GAAG,GAAG,CAAC;YACnB,CAAC;iBAAM,CAAC;gBACN,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,KAAK,CAGvC,CAAC;gBACF,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC;gBACvB,UAAU,GAAG,MAAM,CAAC,UAAU,CAAC;YACjC,CAAC;YAED,MAAM,OAAO,GAAG,CAAC,GAAG,GAAG,UAAU,CAAC,GAAG,IAAI,CAAC;YAC1C,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,GAAG,UAAU,CAAC,CAAC;YAC3D,UAAU,GAAG,GAAG,CAAC;YAEjB,IAAI,MAAM,GAAG,CAAC,EAAE,CAAC;gBACf,MAAM,UAAU,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM,CAAC,GAAG,UAAU,CAAC,CAAC,CAAC;gBACrE,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC,GAAG,UAAU,CAAC;gBAEjD,IAAI,CAAC,QAAQ,EAAE,CAAC;oBACd,MAAM,IAAA,wBAAY,EAChB,IAAI,CAAC,MAAM,EACX,QAAQ,EACR,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,EACtC,GAAG,CACJ,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACN,MAAM,IAAA,wBAAY,EAChB,IAAI,CAAC,MAAM,EACX,QAAQ,EACR,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,EACtC,QAAQ,CAAC,GAAG,EACZ,GAAG,CACJ,CAAC;gBACJ,CAAC;gBAED,OAAO;oBACL,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,QAAQ;oBACf,SAAS,EAAE,CAAC;oBACZ,KAAK;oBACL,UAAU;iBACX,CAAC;YACJ,CAAC;YAED,MAAM,IAAI,CAAC,CAAC;YACZ,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,UAAU,EAAE,CAAC,CAAC;YAEvD,IAAI,CAAC,QAAQ,EAAE,CAAC;gBACd,IAAI,CAAC;oBACH,MAAM,IAAA,wBAAY,EAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,CAAC,CAAC;oBACxD,OAAO;wBACL,OAAO,EAAE,IAAI;wBACb,KAAK,EAAE,QAAQ;wBACf,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;wBAC7B,KAAK,EACH,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC;4BACrB,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,GAAG,MAAM,CAAC,GAAG,UAAU,CAAC;qBAC9C,CAAC;gBACJ,CAAC;gBAAC,MAAM,CAAC;oBACP,SAAS;gBACX,CAAC;YACH,CAAC;YAED,MAAM,OAAO,GAAG,MAAM,IAAA,wBAAY,EAChC,IAAI,CAAC,MAAM,EACX,QAAQ,EACR,OAAO,EACP,QAAQ,CAAC,GAAG,EACZ,GAAG,CACJ,CAAC;YAEF,IAAI,OAAO,EAAE,CAAC;gBACZ,OAAO;oBACL,OAAO,EAAE,IAAI;oBACb,KAAK,EAAE,QAAQ;oBACf,SAAS,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC;oBAC7B,KAAK,EACH,IAAI,CAAC,IAAI,CAAC,GAAG,GAAG,IAAI,CAAC;wBACrB,IAAI,CAAC,IAAI,CAAC,CAAC,QAAQ,GAAG,MAAM,CAAC,GAAG,UAAU,CAAC;iBAC9C,CAAC;YACJ,CAAC;QACH,CAAC;QAED,MAAM,IAAI,KAAK,CAAC,oCAAoC,CAAC,CAAC;IACxD,CAAC;CACF;AApKD,wCAoKC"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
import type { RedisClient } from "../types";
|
|
2
|
+
import type { RateLimitStore, StoreType } from "./types";
|
|
3
|
+
export declare class RedisStore implements RateLimitStore {
|
|
4
|
+
readonly type: StoreType;
|
|
5
|
+
private readonly client;
|
|
6
|
+
private readonly keyPrefix;
|
|
7
|
+
constructor(client: RedisClient, keyPrefix: string, type?: StoreType);
|
|
8
|
+
getClient(): RedisClient;
|
|
9
|
+
slidingWindow(key: string, limit: number, window: number): Promise<import("../types").RateLimitResult>;
|
|
10
|
+
tokenBucket(key: string, capacity: number, refillRate: number): Promise<import("../types").RateLimitResult>;
|
|
11
|
+
}
|
|
12
|
+
//# sourceMappingURL=redis-store.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"redis-store.d.ts","sourceRoot":"","sources":["../../src/stores/redis-store.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,UAAU,CAAC;AAG5C,OAAO,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEzD,qBAAa,UAAW,YAAW,cAAc;IAC/C,QAAQ,CAAC,IAAI,EAAE,SAAS,CAAC;IACzB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;IACrC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAAS;gBAGjC,MAAM,EAAE,WAAW,EACnB,SAAS,EAAE,MAAM,EACjB,IAAI,GAAE,SAAmB;IAO3B,SAAS,IAAI,WAAW;IAIlB,aAAa,CACjB,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,MAAM,EAAE,MAAM,GACb,OAAO,CAAC,OAAO,UAAU,EAAE,eAAe,CAAC;IAuBxC,WAAW,CACf,GAAG,EAAE,MAAM,EACX,QAAQ,EAAE,MAAM,EAChB,UAAU,EAAE,MAAM,GACjB,OAAO,CAAC,OAAO,UAAU,EAAE,eAAe,CAAC;CAoB/C"}
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.RedisStore = void 0;
|
|
4
|
+
const crypto_1 = require("crypto");
|
|
5
|
+
const redis_1 = require("../utils/redis");
|
|
6
|
+
const scripts_1 = require("../utils/scripts");
|
|
7
|
+
class RedisStore {
|
|
8
|
+
constructor(client, keyPrefix, type = "redis") {
|
|
9
|
+
this.client = client;
|
|
10
|
+
this.keyPrefix = keyPrefix;
|
|
11
|
+
this.type = type;
|
|
12
|
+
}
|
|
13
|
+
getClient() {
|
|
14
|
+
return this.client;
|
|
15
|
+
}
|
|
16
|
+
async slidingWindow(key, limit, window) {
|
|
17
|
+
const redisKey = (0, redis_1.buildKey)(this.keyPrefix, `sw:${key}`);
|
|
18
|
+
const now = Date.now();
|
|
19
|
+
const requestId = (0, crypto_1.randomUUID)();
|
|
20
|
+
const result = await (0, scripts_1.evalScript)(this.client, "sliding", [redisKey], [
|
|
21
|
+
limit,
|
|
22
|
+
window,
|
|
23
|
+
now,
|
|
24
|
+
requestId,
|
|
25
|
+
]);
|
|
26
|
+
const parsed = (0, scripts_1.parseScriptResult)(result);
|
|
27
|
+
return {
|
|
28
|
+
allowed: parsed.allowed,
|
|
29
|
+
limit: parsed.limit,
|
|
30
|
+
remaining: parsed.remaining,
|
|
31
|
+
reset: parsed.reset,
|
|
32
|
+
retryAfter: parsed.retryAfter || undefined,
|
|
33
|
+
};
|
|
34
|
+
}
|
|
35
|
+
async tokenBucket(key, capacity, refillRate) {
|
|
36
|
+
const redisKey = (0, redis_1.buildKey)(this.keyPrefix, `tb:${key}`);
|
|
37
|
+
const now = Date.now();
|
|
38
|
+
const result = await (0, scripts_1.evalScript)(this.client, "token", [redisKey], [
|
|
39
|
+
capacity,
|
|
40
|
+
refillRate,
|
|
41
|
+
now,
|
|
42
|
+
]);
|
|
43
|
+
const parsed = (0, scripts_1.parseScriptResult)(result);
|
|
44
|
+
return {
|
|
45
|
+
allowed: parsed.allowed,
|
|
46
|
+
limit: parsed.limit,
|
|
47
|
+
remaining: parsed.remaining,
|
|
48
|
+
reset: parsed.reset,
|
|
49
|
+
retryAfter: parsed.retryAfter || undefined,
|
|
50
|
+
};
|
|
51
|
+
}
|
|
52
|
+
}
|
|
53
|
+
exports.RedisStore = RedisStore;
|
|
54
|
+
//# sourceMappingURL=redis-store.js.map
|
|
@@ -0,0 +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"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import type { RateLimitResult } from "../types";
|
|
2
|
+
export type StoreType = "redis" | "valkey" | "dragonfly" | "memcached";
|
|
3
|
+
export interface RateLimitStore {
|
|
4
|
+
readonly type: StoreType;
|
|
5
|
+
slidingWindow(key: string, limit: number, window: number): Promise<RateLimitResult>;
|
|
6
|
+
tokenBucket(key: string, capacity: number, refillRate: number): Promise<RateLimitResult>;
|
|
7
|
+
}
|
|
8
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +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"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/stores/types.ts"],"names":[],"mappings":""}
|
package/dist/types/index.d.ts
CHANGED
|
@@ -1,4 +1,7 @@
|
|
|
1
1
|
import type { Cluster, Redis, RedisOptions } from "ioredis";
|
|
2
|
+
import type Memcached from "memcached";
|
|
3
|
+
import type { StoreType } from "../stores/types";
|
|
4
|
+
export type { StoreType };
|
|
2
5
|
export type RedisClient = Redis | Cluster;
|
|
3
6
|
export type RedisConfig = RedisClient | string | RedisOptions | {
|
|
4
7
|
nodes: {
|
|
@@ -7,10 +10,26 @@ export type RedisConfig = RedisClient | string | RedisOptions | {
|
|
|
7
10
|
}[];
|
|
8
11
|
options?: RedisOptions;
|
|
9
12
|
};
|
|
13
|
+
export type MemcachedClient = Memcached;
|
|
14
|
+
export type MemcachedOptions = Memcached.options;
|
|
15
|
+
export type MemcachedConfig = MemcachedClient | string | string[] | {
|
|
16
|
+
servers: string | string[];
|
|
17
|
+
options?: MemcachedOptions;
|
|
18
|
+
};
|
|
10
19
|
export interface RedisLimitOptions {
|
|
11
|
-
redis
|
|
20
|
+
/** Storage backend. Defaults to "redis", or "memcached" when memcached config is provided. */
|
|
21
|
+
store?: StoreType;
|
|
22
|
+
/** Redis-compatible connection (Redis, Valkey, DragonflyDB) */
|
|
23
|
+
redis?: RedisConfig;
|
|
24
|
+
/** Memcached server(s) */
|
|
25
|
+
memcached?: MemcachedConfig;
|
|
12
26
|
failOpen?: boolean;
|
|
27
|
+
/** Storage key prefix. Defaults to "limitly". Keys are stored as `{prefix}:sw:{id}` or `{prefix}:tb:{id}`. */
|
|
13
28
|
keyPrefix?: string;
|
|
29
|
+
/** Default rate limit config applied when middleware options omit algorithm settings. */
|
|
30
|
+
default?: MiddlewareOptionsInput;
|
|
31
|
+
/** Global metrics hook applied to all rate limit checks. */
|
|
32
|
+
onMetrics?: RateLimitMetricsHook | RateLimitMetricsHook[];
|
|
14
33
|
}
|
|
15
34
|
export interface RateLimitResult {
|
|
16
35
|
allowed: boolean;
|
|
@@ -33,13 +52,55 @@ export interface TokenBucketConfig {
|
|
|
33
52
|
refillRate: number;
|
|
34
53
|
}
|
|
35
54
|
export type AlgorithmConfig = SlidingWindowConfig | TokenBucketConfig;
|
|
55
|
+
export type RateLimitMetricsEvent = {
|
|
56
|
+
type: "allowed";
|
|
57
|
+
key: string;
|
|
58
|
+
algorithm: AlgorithmConfig["algorithm"];
|
|
59
|
+
result: RateLimitResult;
|
|
60
|
+
durationMs: number;
|
|
61
|
+
store?: StoreType;
|
|
62
|
+
context?: unknown;
|
|
63
|
+
} | {
|
|
64
|
+
type: "blocked";
|
|
65
|
+
key: string;
|
|
66
|
+
algorithm: AlgorithmConfig["algorithm"];
|
|
67
|
+
result: RateLimitResult;
|
|
68
|
+
durationMs: number;
|
|
69
|
+
store?: StoreType;
|
|
70
|
+
context?: unknown;
|
|
71
|
+
} | {
|
|
72
|
+
type: "error";
|
|
73
|
+
key: string;
|
|
74
|
+
algorithm: AlgorithmConfig["algorithm"];
|
|
75
|
+
error: unknown;
|
|
76
|
+
durationMs: number;
|
|
77
|
+
failOpen: boolean;
|
|
78
|
+
store?: StoreType;
|
|
79
|
+
context?: unknown;
|
|
80
|
+
} | {
|
|
81
|
+
type: "fail_open";
|
|
82
|
+
key: string;
|
|
83
|
+
algorithm: AlgorithmConfig["algorithm"];
|
|
84
|
+
durationMs: number;
|
|
85
|
+
store?: StoreType;
|
|
86
|
+
context?: unknown;
|
|
87
|
+
};
|
|
88
|
+
export type RateLimitMetricsHook = (event: RateLimitMetricsEvent) => void | Promise<void>;
|
|
36
89
|
export interface BaseMiddlewareOptions {
|
|
37
90
|
key?: (req: unknown) => string | undefined;
|
|
38
91
|
headers?: boolean;
|
|
39
92
|
onLimitReached?: (req: unknown, res: unknown) => void | Promise<void>;
|
|
93
|
+
onMetrics?: RateLimitMetricsHook | RateLimitMetricsHook[];
|
|
40
94
|
failOpen?: boolean;
|
|
41
95
|
}
|
|
42
96
|
export type MiddlewareOptions = BaseMiddlewareOptions & AlgorithmConfig;
|
|
97
|
+
export type MiddlewareOptionsInput = BaseMiddlewareOptions & {
|
|
98
|
+
algorithm?: "sliding-window" | "token-bucket";
|
|
99
|
+
limit?: number;
|
|
100
|
+
window?: number;
|
|
101
|
+
capacity?: number;
|
|
102
|
+
refillRate?: number;
|
|
103
|
+
};
|
|
43
104
|
export interface RateLimitHeaders {
|
|
44
105
|
"X-RateLimit-Limit": string;
|
|
45
106
|
"X-RateLimit-Remaining": 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;
|
|
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"}
|
|
@@ -0,0 +1,6 @@
|
|
|
1
|
+
import type { AlgorithmConfig, MiddlewareOptions, MiddlewareOptionsInput, SlidingWindowConfig, TokenBucketConfig } from "../types";
|
|
2
|
+
export declare const DEFAULT_SLIDING_WINDOW: SlidingWindowConfig;
|
|
3
|
+
export declare const DEFAULT_TOKEN_BUCKET: TokenBucketConfig;
|
|
4
|
+
export declare function resolveMiddlewareOptions(options?: MiddlewareOptionsInput, defaults?: MiddlewareOptionsInput): MiddlewareOptions;
|
|
5
|
+
export declare function resolveAlgorithmConfig(options?: MiddlewareOptionsInput, defaults?: MiddlewareOptionsInput): AlgorithmConfig;
|
|
6
|
+
//# sourceMappingURL=defaults.d.ts.map
|
|
@@ -0,0 +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"}
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.DEFAULT_TOKEN_BUCKET = exports.DEFAULT_SLIDING_WINDOW = void 0;
|
|
4
|
+
exports.resolveMiddlewareOptions = resolveMiddlewareOptions;
|
|
5
|
+
exports.resolveAlgorithmConfig = resolveAlgorithmConfig;
|
|
6
|
+
exports.DEFAULT_SLIDING_WINDOW = {
|
|
7
|
+
algorithm: "sliding-window",
|
|
8
|
+
limit: 100,
|
|
9
|
+
window: 60,
|
|
10
|
+
};
|
|
11
|
+
exports.DEFAULT_TOKEN_BUCKET = {
|
|
12
|
+
algorithm: "token-bucket",
|
|
13
|
+
capacity: 100,
|
|
14
|
+
refillRate: 10,
|
|
15
|
+
};
|
|
16
|
+
function pickBaseOptions(options) {
|
|
17
|
+
return {
|
|
18
|
+
key: options.key,
|
|
19
|
+
headers: options.headers,
|
|
20
|
+
onLimitReached: options.onLimitReached,
|
|
21
|
+
onMetrics: options.onMetrics,
|
|
22
|
+
failOpen: options.failOpen,
|
|
23
|
+
};
|
|
24
|
+
}
|
|
25
|
+
function resolveMiddlewareOptions(options = {}, defaults = {}) {
|
|
26
|
+
const merged = { ...defaults, ...options };
|
|
27
|
+
const base = pickBaseOptions(merged);
|
|
28
|
+
const algorithm = merged.algorithm ?? exports.DEFAULT_SLIDING_WINDOW.algorithm;
|
|
29
|
+
if (algorithm === "token-bucket") {
|
|
30
|
+
return {
|
|
31
|
+
...base,
|
|
32
|
+
algorithm: "token-bucket",
|
|
33
|
+
capacity: merged.capacity ?? exports.DEFAULT_TOKEN_BUCKET.capacity,
|
|
34
|
+
refillRate: merged.refillRate ?? exports.DEFAULT_TOKEN_BUCKET.refillRate,
|
|
35
|
+
};
|
|
36
|
+
}
|
|
37
|
+
return {
|
|
38
|
+
...base,
|
|
39
|
+
algorithm: "sliding-window",
|
|
40
|
+
limit: merged.limit ?? exports.DEFAULT_SLIDING_WINDOW.limit,
|
|
41
|
+
window: merged.window ?? exports.DEFAULT_SLIDING_WINDOW.window,
|
|
42
|
+
};
|
|
43
|
+
}
|
|
44
|
+
function resolveAlgorithmConfig(options = {}, defaults = {}) {
|
|
45
|
+
const resolved = resolveMiddlewareOptions(options, defaults);
|
|
46
|
+
if (resolved.algorithm === "token-bucket") {
|
|
47
|
+
return {
|
|
48
|
+
algorithm: "token-bucket",
|
|
49
|
+
capacity: resolved.capacity,
|
|
50
|
+
refillRate: resolved.refillRate,
|
|
51
|
+
};
|
|
52
|
+
}
|
|
53
|
+
return {
|
|
54
|
+
algorithm: "sliding-window",
|
|
55
|
+
limit: resolved.limit,
|
|
56
|
+
window: resolved.window,
|
|
57
|
+
};
|
|
58
|
+
}
|
|
59
|
+
//# sourceMappingURL=defaults.js.map
|
|
@@ -0,0 +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"}
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
import type { MemcachedConfig, MemcachedClient } from "../types";
|
|
2
|
+
export declare function createMemcachedClient(config: MemcachedConfig): MemcachedClient;
|
|
3
|
+
export declare function memcachedGet(client: MemcachedClient, key: string): Promise<string | undefined>;
|
|
4
|
+
export declare function memcachedGets(client: MemcachedClient, key: string): Promise<{
|
|
5
|
+
value: string;
|
|
6
|
+
cas: string;
|
|
7
|
+
} | undefined>;
|
|
8
|
+
export declare function memcachedIncr(client: MemcachedClient, key: string, amount?: number): Promise<number>;
|
|
9
|
+
export declare function memcachedAdd(client: MemcachedClient, key: string, value: string, ttl: number): Promise<void>;
|
|
10
|
+
export declare function memcachedCas(client: MemcachedClient, key: string, value: string, cas: string, ttl: number): Promise<boolean>;
|
|
11
|
+
//# sourceMappingURL=memcached.d.ts.map
|
|
@@ -0,0 +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"}
|