@upstash/ratelimit 2.0.2 → 2.0.4

package/dist/index.d.mts

@@ -1,10 +1,10 @@
 import { Aggregate } from '@upstash/core-analytics';
-import { Pipeline } from '@upstash/redis';
+import { Redis as Redis$1 } from '@upstash/redis';
 
 /**
  * EphemeralCache is used to block certain identifiers right away in case they have already exceeded the ratelimit.
  */
-interface EphemeralCache {
+type EphemeralCache = {
     isBlocked: (identifier: string) => {
         blocked: boolean;
         reset: number;
@@ -16,16 +16,10 @@ interface EphemeralCache {
     pop: (key: string) => void;
     empty: () => void;
     size: () => number;
-}
+};
 type RegionContext = {
     redis: Redis;
     cache?: EphemeralCache;
-    scriptHashes: {
-        limitHash?: string;
-        getRemainingHash?: string;
-        resetHash?: string;
-    };
-    cacheScripts: boolean;
 };
 type MultiRegionContext = {
     regionContexts: Omit<RegionContext[], "cache">;
@@ -96,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;
@@ -108,17 +101,15 @@ type LimitOptions = {
 /**
  * This is all we need from the redis sdk.
  */
-interface 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 = {
+    sadd: Redis$1["sadd"];
+    hset: Redis$1["hset"];
+    eval: Redis$1["eval"];
+    evalsha: Redis$1["evalsha"];
+    scriptLoad: Redis$1["scriptLoad"];
+    smismember: Redis$1["smismember"];
+    multi: Redis$1["multi"];
+};
 
 type Geo = {
     country?: string;
@@ -570,8 +561,12 @@ type RegionRatelimitConfig = {
      */
     analytics?: boolean;
     /**
-     * If enabled, lua scripts will be sent to Redis with SCRIPT LOAD durint the first request.
-     * In the subsequent requests, hash of the script will be used to invoke it
+     * @deprecated Has no affect since v2.0.3. Instead, hash values of scripts are
+     * hardcoded in the sdk and it attempts to run the script using EVALSHA (with the hash).
+     * If it fails, runs script load.
+     *
+     * Previously, if enabled, lua scripts were sent to Redis with SCRIPT LOAD durint the first request.
+     * In the subsequent requests, hash of the script would be used to invoke the scripts
      *
      * @default true
      */

package/dist/index.d.ts

@@ -1,10 +1,10 @@
 import { Aggregate } from '@upstash/core-analytics';
-import { Pipeline } from '@upstash/redis';
+import { Redis as Redis$1 } from '@upstash/redis';
 
 /**
  * EphemeralCache is used to block certain identifiers right away in case they have already exceeded the ratelimit.
  */
-interface EphemeralCache {
+type EphemeralCache = {
     isBlocked: (identifier: string) => {
         blocked: boolean;
         reset: number;
@@ -16,16 +16,10 @@ interface EphemeralCache {
     pop: (key: string) => void;
     empty: () => void;
     size: () => number;
-}
+};
 type RegionContext = {
     redis: Redis;
     cache?: EphemeralCache;
-    scriptHashes: {
-        limitHash?: string;
-        getRemainingHash?: string;
-        resetHash?: string;
-    };
-    cacheScripts: boolean;
 };
 type MultiRegionContext = {
     regionContexts: Omit<RegionContext[], "cache">;
@@ -96,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;
@@ -108,17 +101,15 @@ type LimitOptions = {
 /**
  * This is all we need from the redis sdk.
  */
-interface 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 = {
+    sadd: Redis$1["sadd"];
+    hset: Redis$1["hset"];
+    eval: Redis$1["eval"];
+    evalsha: Redis$1["evalsha"];
+    scriptLoad: Redis$1["scriptLoad"];
+    smismember: Redis$1["smismember"];
+    multi: Redis$1["multi"];
+};
 
 type Geo = {
     country?: string;
@@ -570,8 +561,12 @@ type RegionRatelimitConfig = {
      */
     analytics?: boolean;
     /**
-     * If enabled, lua scripts will be sent to Redis with SCRIPT LOAD durint the first request.
-     * In the subsequent requests, hash of the script will be used to invoke it
+     * @deprecated Has no affect since v2.0.3. Instead, hash values of scripts are
+     * hardcoded in the sdk and it attempts to run the script using EVALSHA (with the hash).
+     * If it fails, runs script load.
+     *
+     * Previously, if enabled, lua scripts were sent to Redis with SCRIPT LOAD durint the first request.
+     * In the subsequent requests, hash of the script would be used to invoke the scripts
      *
      * @default true
      */