Use peer dependency for Redis and cast the object to prevent conflict (#129)

* fix: use peer dep instead

* chore: remove comment

* chore: lint fix

* fix: remove multi field from config redis object to prevent conflicts

* fix: change omit to pick

Author: ytkimirti

bun.lockb

@@ -14,16 +14,18 @@
   },
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "^8.4.0",
-    "@upstash/redis": "^1.34.3",
     "bun-types": "latest",
     "eslint": "^9.10.0",
     "eslint-plugin-unicorn": "^55.0.0",
     "tsup": "^7.2.0",
     "turbo": "^1.10.15",
     "typescript": "^5.0.0"
   },
+  "peerDependencies": {
+    "@upstash/redis": "^1.34.3"
+  },
   "license": "MIT",
   "dependencies": {
     "@upstash/core-analytics": "^0.0.10"
   }
-}
+}

package.json

@@ -405,6 +405,6 @@ export abstract class Ratelimit<TContext extends Context> {
     req?: Pick<LimitOptions, "ip" | "userAgent" | "country">
   ): string[] => {
     const members = [identifier, req?.ip, req?.userAgent, req?.country];
-    return members.filter((item): item is string => Boolean(item));
+    return (members as string[]).filter(Boolean);
   }
 }

src/ratelimit.ts

@@ -6,7 +6,10 @@ import { tokenBucketIdentifierNotFound } from "./lua-scripts/single";
 
 import { Ratelimit } from "./ratelimit";
 import type { Algorithm, RegionContext } from "./types";
-import type { Redis } from "./types";
+import type { Redis as RedisCore } from "./types";
+
+// Fix for https://github.com/upstash/ratelimit-js/issues/125
+type Redis = Pick<RedisCore, "get" | "set">
 
 export type RegionRatelimitConfig = {
   /**
@@ -114,7 +117,7 @@ export class RegionRatelimit extends Ratelimit<RegionContext> {
       timeout: config.timeout,
       analytics: config.analytics,
       ctx: {
-        redis: config.redis,
+        redis: config.redis as RedisCore,
       },
       ephemeralCache: config.ephemeralCache,
       enableProtection: config.enableProtection,

src/single.ts

@@ -119,21 +119,4 @@ export type LimitOptions = {
   country?: string
 }
 
-/**
- * This is all we need from the redis sdk.
- */
-export type Redis = {
-  sadd: RedisCore["sadd"]
-
-  hset: RedisCore["hset"]
-
-  eval: RedisCore["eval"]
-
-  evalsha: RedisCore["evalsha"]
-
-  scriptLoad: RedisCore["scriptLoad"]
-
-  smismember: RedisCore["smismember"]
-
-  multi: RedisCore["multi"]
-}
+export type Redis = RedisCore