@upstash/ratelimit 0.0.0-ci.e36c7a4668d76e92b9a8650ce5d3967a8d0a7e36-20241006173732 → 0.0.0-ci.e51294002f34d535e9a8cb7fd64dd4940cd67362-20251031125635

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 import { Aggregate } from '@upstash/core-analytics';
-import { Pipeline } from '@upstash/redis';
+import { Redis as Redis$2 } from '@upstash/redis';
 
 /**
  * EphemeralCache is used to block certain identifiers right away in case they have already exceeded the ratelimit.
@@ -12,13 +12,13 @@ type EphemeralCache = {
     blockUntil: (identifier: string, reset: number) => void;
     set: (key: string, value: number) => void;
     get: (key: string) => number | null;
-    incr: (key: string) => number;
+    incr: (key: string, incrementAmount?: number) => number;
     pop: (key: string) => void;
     empty: () => void;
     size: () => number;
 };
 type RegionContext = {
-    redis: Redis;
+    redis: Redis$1;
     cache?: EphemeralCache;
 };
 type MultiRegionContext = {
@@ -90,7 +90,6 @@ type Algorithm<TContext> = () => {
     }>;
     resetTokens: (ctx: TContext, identifier: string) => Promise<void>;
 };
-type IsDenied = 0 | 1;
 type DeniedValue = string | undefined;
 type LimitOptions = {
     geo?: Geo;
@@ -99,20 +98,7 @@ type LimitOptions = {
     userAgent?: string;
     country?: string;
 };
-/**
- * This is all we need from the redis sdk.
- */
-type Redis = {
-    sadd: <TData>(key: string, ...members: TData[]) => Promise<number>;
-    hset: <TValue>(key: string, obj: {
-        [key: string]: TValue;
-    }) => Promise<number>;
-    eval: <TArgs extends unknown[], TData = unknown>(...args: [script: string, keys: string[], args: TArgs]) => Promise<TData>;
-    evalsha: <TArgs extends unknown[], TData = unknown>(...args: [sha1: string, keys: string[], args: TArgs]) => Promise<TData>;
-    scriptLoad: (...args: [script: string]) => Promise<string>;
-    smismember: (key: string, members: string[]) => Promise<IsDenied[]>;
-    multi: () => Pipeline;
-};
+type Redis$1 = Redis$2;
 
 type Geo = {
     country?: string;
@@ -132,7 +118,7 @@ type Event = Geo & {
     success: EventSuccess;
 };
 type AnalyticsConfig = {
-    redis: Redis;
+    redis: Redis$1;
     prefix?: string;
 };
 /**
@@ -259,7 +245,7 @@ declare abstract class Ratelimit<TContext extends Context> {
     protected readonly ctx: TContext;
     protected readonly prefix: string;
     protected readonly timeout: number;
-    protected readonly primaryRedis: Redis;
+    protected readonly primaryRedis: Redis$1;
     protected readonly analytics?: Analytics;
     protected readonly enableProtection: boolean;
     protected readonly denyListThreshold: number;
@@ -384,7 +370,7 @@ type MultiRegionRatelimitConfig = {
      * Instances of `@upstash/redis`
      * @see https://github.com/upstash/upstash-redis#quick-start
      */
-    redis: Redis[];
+    redis: Redis$1[];
     /**
      * The ratelimiter function to use.
      *
@@ -511,6 +497,7 @@ declare class MultiRegionRatelimit extends Ratelimit<MultiRegionContext> {
     window: Duration): Algorithm<MultiRegionContext>;
 }
 
+type Redis = Pick<Redis$1, "evalsha" | "get" | "set">;
 type RegionRatelimitConfig = {
     /**
      * Instance of `@upstash/redis`
@@ -743,7 +730,7 @@ declare class ThresholdError extends Error {
  *  passed, ttl is infferred from current time.
  * @returns list of ips which are not in the deny list
  */
-declare const updateIpDenyList: (redis: Redis, prefix: string, threshold: number, ttl?: number) => Promise<unknown[]>;
+declare const updateIpDenyList: (redis: Redis$1, prefix: string, threshold: number, ttl?: number) => Promise<unknown[]>;
 /**
  * Disables the ip deny list by removing the ip deny list from the all
  * set and removing the ip deny list. Also sets the status key to disabled
@@ -753,7 +740,7 @@ declare const updateIpDenyList: (redis: Redis, prefix: string, threshold: number
  * @param prefix ratelimit prefix
  * @returns
  */
-declare const disableIpDenyList: (redis: Redis, prefix: string) => Promise<unknown[]>;
+declare const disableIpDenyList: (redis: Redis$1, prefix: string) => Promise<unknown[]>;
 
 type ipDenyList_ThresholdError = ThresholdError;
 declare const ipDenyList_ThresholdError: typeof ThresholdError;

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { Aggregate } from '@upstash/core-analytics';
-import { Pipeline } from '@upstash/redis';
+import { Redis as Redis$2 } from '@upstash/redis';
 
 /**
  * EphemeralCache is used to block certain identifiers right away in case they have already exceeded the ratelimit.
@@ -12,13 +12,13 @@ type EphemeralCache = {
     blockUntil: (identifier: string, reset: number) => void;
     set: (key: string, value: number) => void;
     get: (key: string) => number | null;
-    incr: (key: string) => number;
+    incr: (key: string, incrementAmount?: number) => number;
     pop: (key: string) => void;
     empty: () => void;
     size: () => number;
 };
 type RegionContext = {
-    redis: Redis;
+    redis: Redis$1;
     cache?: EphemeralCache;
 };
 type MultiRegionContext = {
@@ -90,7 +90,6 @@ type Algorithm<TContext> = () => {
     }>;
     resetTokens: (ctx: TContext, identifier: string) => Promise<void>;
 };
-type IsDenied = 0 | 1;
 type DeniedValue = string | undefined;
 type LimitOptions = {
     geo?: Geo;
@@ -99,20 +98,7 @@ type LimitOptions = {
     userAgent?: string;
     country?: string;
 };
-/**
- * This is all we need from the redis sdk.
- */
-type Redis = {
-    sadd: <TData>(key: string, ...members: TData[]) => Promise<number>;
-    hset: <TValue>(key: string, obj: {
-        [key: string]: TValue;
-    }) => Promise<number>;
-    eval: <TArgs extends unknown[], TData = unknown>(...args: [script: string, keys: string[], args: TArgs]) => Promise<TData>;
-    evalsha: <TArgs extends unknown[], TData = unknown>(...args: [sha1: string, keys: string[], args: TArgs]) => Promise<TData>;
-    scriptLoad: (...args: [script: string]) => Promise<string>;
-    smismember: (key: string, members: string[]) => Promise<IsDenied[]>;
-    multi: () => Pipeline;
-};
+type Redis$1 = Redis$2;
 
 type Geo = {
     country?: string;
@@ -132,7 +118,7 @@ type Event = Geo & {
     success: EventSuccess;
 };
 type AnalyticsConfig = {
-    redis: Redis;
+    redis: Redis$1;
     prefix?: string;
 };
 /**
@@ -259,7 +245,7 @@ declare abstract class Ratelimit<TContext extends Context> {
     protected readonly ctx: TContext;
     protected readonly prefix: string;
     protected readonly timeout: number;
-    protected readonly primaryRedis: Redis;
+    protected readonly primaryRedis: Redis$1;
     protected readonly analytics?: Analytics;
     protected readonly enableProtection: boolean;
     protected readonly denyListThreshold: number;
@@ -384,7 +370,7 @@ type MultiRegionRatelimitConfig = {
      * Instances of `@upstash/redis`
      * @see https://github.com/upstash/upstash-redis#quick-start
      */
-    redis: Redis[];
+    redis: Redis$1[];
     /**
      * The ratelimiter function to use.
      *
@@ -511,6 +497,7 @@ declare class MultiRegionRatelimit extends Ratelimit<MultiRegionContext> {
     window: Duration): Algorithm<MultiRegionContext>;
 }
 
+type Redis = Pick<Redis$1, "evalsha" | "get" | "set">;
 type RegionRatelimitConfig = {
     /**
      * Instance of `@upstash/redis`
@@ -743,7 +730,7 @@ declare class ThresholdError extends Error {
  *  passed, ttl is infferred from current time.
  * @returns list of ips which are not in the deny list
  */
-declare const updateIpDenyList: (redis: Redis, prefix: string, threshold: number, ttl?: number) => Promise<unknown[]>;
+declare const updateIpDenyList: (redis: Redis$1, prefix: string, threshold: number, ttl?: number) => Promise<unknown[]>;
 /**
  * Disables the ip deny list by removing the ip deny list from the all
  * set and removing the ip deny list. Also sets the status key to disabled
@@ -753,7 +740,7 @@ declare const updateIpDenyList: (redis: Redis, prefix: string, threshold: number
  * @param prefix ratelimit prefix
  * @returns
  */
-declare const disableIpDenyList: (redis: Redis, prefix: string) => Promise<unknown[]>;
+declare const disableIpDenyList: (redis: Redis$1, prefix: string) => Promise<unknown[]>;
 
 type ipDenyList_ThresholdError = ThresholdError;
 declare const ipDenyList_ThresholdError: typeof ThresholdError;