@upstash/ratelimit 0.0.0-ci.b1700114539281dffd8cdc735b109024d3062db7-20241010102154 → 0.0.0-ci.b7f9ea418a9003054c47927b12f4b106261fb65b-20251023085337

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;

package/dist/index.js

@@ -115,9 +115,9 @@ var Cache = class {
   get(key) {
     return this.cache.get(key) || null;
   }
-  incr(key) {
+  incr(key, incrementAmount = 1) {
     let value = this.cache.get(key) ?? 0;
-    value += 1;
+    value += incrementAmount;
     this.cache.set(key, value);
     return value;
   }
@@ -168,13 +168,7 @@ var safeEval = async (ctx, script, keys, args) => {
     return await ctx.redis.evalsha(script.hash, keys, args);
   } catch (error) {
     if (`${error}`.includes("NOSCRIPT")) {
-      const hash = await ctx.redis.scriptLoad(script.script);
-      if (hash !== script.hash) {
-        console.warn(
-          "Upstash Ratelimit: Expected hash and the hash received from Redis are different. Ratelimit will work as usual but performance will be reduced."
-        );
-      }
-      return await ctx.redis.evalsha(hash, keys, args);
+      return await ctx.redis.eval(script.script, keys, args);
     }
     throw error;
   }
@@ -600,7 +594,7 @@ var updateIpDenyList = async (redis, prefix, threshold, ttl) => {
   const transaction = redis.multi();
   transaction.sdiffstore(allDenyLists, allDenyLists, ipDenyList);
   transaction.del(ipDenyList);
-  transaction.sadd(ipDenyList, ...allIps);
+  transaction.sadd(ipDenyList, allIps.at(0), ...allIps.slice(1));
   transaction.sdiffstore(ipDenyList, ipDenyList, allDenyLists);
   transaction.sunionstore(allDenyLists, allDenyLists, ipDenyList);
   transaction.set(statusKey, "valid", { px: ttl ?? getIpListTTL() });
@@ -925,7 +919,7 @@ var Ratelimit = class {
    */
   getDefinedMembers = (identifier, req) => {
     const members = [identifier, req?.ip, req?.userAgent, req?.country];
-    return members.filter((item) => Boolean(item));
+    return members.filter(Boolean);
   };
 };
 
@@ -1580,7 +1574,7 @@ var RegionRatelimit = class extends Ratelimit {
         const incrementBy = rate ? Math.max(1, rate) : 1;
         const hit = typeof ctx.cache.get(key) === "number";
         if (hit) {
-          const cachedTokensAfterUpdate = ctx.cache.incr(key);
+          const cachedTokensAfterUpdate = ctx.cache.incr(key, incrementBy);
           const success = cachedTokensAfterUpdate < tokens;
           const pending = success ? safeEval(
             ctx,