@ooneex/rate-limit 1.1.3 → 1.2.1

package/dist/index.d.ts

@@ -1,8 +1,5 @@
-import { Exception } from "@ooneex/exception";
-declare class RateLimitException extends Exception {
-	constructor(message: string, data?: Record<string, unknown>);
-}
-import { AppEnv } from "@ooneex/app-env";
+import { EContainerScope } from "@ooneex/container";
+import { Duration } from "@upstash/ratelimit";
 type RateLimiterClassType = new (...args: any[]) => IRateLimiter;
 type RedisRateLimiterOptionsType = {
 	connectionString?: string;
@@ -14,6 +11,27 @@ type RedisRateLimiterOptionsType = {
 	enableAutoPipelining?: boolean;
 	tls?: boolean | object;
 };
+type UpstashAlgorithmType = {
+	type: "fixedWindow";
+	limit: number;
+	window: Duration;
+} | {
+	type: "slidingWindow";
+	limit: number;
+	window: Duration;
+} | {
+	type: "tokenBucket";
+	refillRate: number;
+	interval: Duration;
+	maxTokens: number;
+};
+type UpstashRedisRateLimiterOptionsType = {
+	url?: string;
+	token?: string;
+	algorithm?: UpstashAlgorithmType;
+	prefix?: string;
+	analytics?: boolean;
+};
 type RateLimitResultType = {
 	limited: boolean;
 	remaining: number;
@@ -21,18 +39,40 @@ type RateLimitResultType = {
 	resetAt: Date;
 };
 interface IRateLimiter {
-	check: (key: string, limit: number, windowSeconds: number) => Promise<RateLimitResultType>;
+	check: (key: string) => Promise<RateLimitResultType>;
+	isLimited: (key: string) => Promise<boolean>;
 	reset: (key: string) => Promise<boolean>;
 	getCount: (key: string) => Promise<number>;
 }
+declare const decorator: {
+	rateLimit: (scope?: EContainerScope) => (target: RateLimiterClassType) => void;
+};
+import { Exception } from "@ooneex/exception";
+declare class RateLimitException extends Exception {
+	constructor(message: string, key: string, data?: Record<string, unknown>);
+}
+import { AppEnv } from "@ooneex/app-env";
 declare class RedisRateLimiter implements IRateLimiter {
 	private readonly env;
 	private client;
 	constructor(env: AppEnv, options?: RedisRateLimiterOptionsType);
 	private connect;
 	private getKey;
-	check(key: string, limit: number, windowSeconds: number): Promise<RateLimitResultType>;
+	check(key: string): Promise<RateLimitResultType>;
+	isLimited(key: string): Promise<boolean>;
+	reset(key: string): Promise<boolean>;
+	getCount(key: string): Promise<number>;
+}
+import { AppEnv as AppEnv2 } from "@ooneex/app-env";
+declare class UpstashRedisRateLimiter implements IRateLimiter {
+	private readonly env;
+	private ratelimit;
+	private static readonly DEFAULT_ALGORITHM;
+	constructor(env: AppEnv2, options?: UpstashRedisRateLimiterOptionsType);
+	private buildLimiter;
+	check(key: string): Promise<RateLimitResultType>;
+	isLimited(key: string): Promise<boolean>;
 	reset(key: string): Promise<boolean>;
 	getCount(key: string): Promise<number>;
 }
-export { RedisRateLimiterOptionsType, RedisRateLimiter, RateLimiterClassType, RateLimitResultType, RateLimitException, IRateLimiter };
+export { decorator, UpstashRedisRateLimiterOptionsType, UpstashRedisRateLimiter, UpstashAlgorithmType, RedisRateLimiterOptionsType, RedisRateLimiter, RateLimiterClassType, RateLimitResultType, RateLimitException, IRateLimiter };