@fedify/redis 1.9.0-dev.1408 → 1.9.0-dev.1415

package/README.md

@@ -16,12 +16,27 @@ implementations for Redis:
 ~~~~ typescript
 import { createFederation } from "@fedify/fedify";
 import { RedisKvStore, RedisMessageQueue } from "@fedify/redis";
-import { Redis } from "ioredis";
+import { Redis, Cluster } from "ioredis";
 
+// Using a standalone Redis instance:
 const federation = createFederation({
   kv: new RedisKvStore(new Redis()),
   queue: new RedisMessageQueue(() => new Redis()),
 });
+
+// Using a Redis Cluster:
+const federation = createFederation({
+  kv: new RedisKvStore(new Cluster([
+    { host: "127.0.0.1", port: 7000 },
+    { host: "127.0.0.1", port: 7001 },
+    { host: "127.0.0.1", port: 7002 },
+  ])),
+  queue: new RedisMessageQueue(() => new Cluster([
+    { host: "127.0.0.1", port: 7000 },
+    { host: "127.0.0.1", port: 7001 },
+    { host: "127.0.0.1", port: 7002 },
+  ])),
+});
 ~~~~
 
 [JSR]: https://jsr.io/@fedify/redis

package/dist/kv.d.ts

@@ -1,7 +1,7 @@
 import { Temporal } from "@js-temporal/polyfill";
 import { Codec } from "./codec.js";
 import { KvKey, KvStore, KvStoreSetOptions } from "@fedify/fedify";
-import { Redis, RedisKey } from "ioredis";
+import { Cluster, Redis, RedisKey } from "ioredis";
 
 //#region src/kv.d.ts
 /**
@@ -26,22 +26,34 @@ interface RedisKvStoreOptions {
  * ```ts ignore
  * import { createFederation } from "@fedify/fedify";
  * import { RedisKvStore } from "@fedify/redis";
- * import { Redis } from "ioredis";
+ * import { Redis, Cluster } from "ioredis";
  *
+ * // Using a standalone Redis instance:
  * const federation = createFederation({
  *   // ...
  *   kv: new RedisKvStore(new Redis()),
  * });
+ *
+ * // Using a Redis Cluster:
+ * const cluster = new Cluster([
+ *   { host: "127.0.0.1", port: 7000 },
+ *   { host: "127.0.0.1", port: 7001 },
+ *   { host: "127.0.0.1", port: 7002 },
+ * ]);
+ * const federation = createFederation({
+ *   // ...
+ *   kv: new RedisKvStore(cluster),
+ * });
  * ```
  */
 declare class RedisKvStore implements KvStore {
   #private;
   /**
    * Creates a new Redis key–value store.
-   * @param redis The Redis client to use.
+   * @param redis The Redis client (standalone or cluster) to use.
    * @param options The options for the key–value store.
    */
-  constructor(redis: Redis, options?: RedisKvStoreOptions);
+  constructor(redis: Redis | Cluster, options?: RedisKvStoreOptions);
   get<T = unknown>(key: KvKey): Promise<T | undefined>;
   set(key: KvKey, value: unknown, options?: KvStoreSetOptions | undefined): Promise<void>;
   delete(key: KvKey): Promise<void>;

package/dist/kv.js

@@ -12,12 +12,24 @@ import { Buffer } from "node:buffer";
 * ```ts ignore
 * import { createFederation } from "@fedify/fedify";
 * import { RedisKvStore } from "@fedify/redis";
-* import { Redis } from "ioredis";
+* import { Redis, Cluster } from "ioredis";
 *
+* // Using a standalone Redis instance:
 * const federation = createFederation({
 *   // ...
 *   kv: new RedisKvStore(new Redis()),
 * });
+*
+* // Using a Redis Cluster:
+* const cluster = new Cluster([
+*   { host: "127.0.0.1", port: 7000 },
+*   { host: "127.0.0.1", port: 7001 },
+*   { host: "127.0.0.1", port: 7002 },
+* ]);
+* const federation = createFederation({
+*   // ...
+*   kv: new RedisKvStore(cluster),
+* });
 * ```
 */
 var RedisKvStore = class {
@@ -27,7 +39,7 @@ var RedisKvStore = class {
 	#textEncoder = new TextEncoder();
 	/**
 	* Creates a new Redis key–value store.
-	* @param redis The Redis client to use.
+	* @param redis The Redis client (standalone or cluster) to use.
 	* @param options The options for the key–value store.
 	*/
 	constructor(redis, options = {}) {

package/dist/mq.d.ts

@@ -1,7 +1,7 @@
 import { Temporal } from "@js-temporal/polyfill";
 import { Codec } from "./codec.js";
 import { MessageQueue, MessageQueueEnqueueOptions, MessageQueueListenOptions } from "@fedify/fedify";
-import { Redis, RedisKey } from "ioredis";
+import { Cluster, Redis, RedisKey } from "ioredis";
 
 //#region src/mq.d.ts
 /**
@@ -51,12 +51,23 @@ interface RedisMessageQueueOptions {
  * ```ts ignore
  * import { createFederation } from "@fedify/fedify";
  * import { RedisMessageQueue } from "@fedify/redis";
- * import { Redis } from "ioredis";
+ * import { Redis, Cluster } from "ioredis";
  *
+ * // Using a standalone Redis instance:
  * const federation = createFederation({
  *   // ...
  *   queue: new RedisMessageQueue(() => new Redis()),
  * });
+ *
+ * // Using a Redis Cluster:
+ * const federation = createFederation({
+ *   // ...
+ *   queue: new RedisMessageQueue(() => new Cluster([
+ *     { host: "127.0.0.1", port: 7000 },
+ *     { host: "127.0.0.1", port: 7001 },
+ *     { host: "127.0.0.1", port: 7002 },
+ *   ])),
+ * });
  * ```
  */
 declare class RedisMessageQueue implements MessageQueue, Disposable {
@@ -66,7 +77,7 @@ declare class RedisMessageQueue implements MessageQueue, Disposable {
    * @param redis The Redis client factory.
    * @param options The options for the message queue.
    */
-  constructor(redis: () => Redis, options?: RedisMessageQueueOptions);
+  constructor(redis: () => Redis | Cluster, options?: RedisMessageQueueOptions);
   enqueue(message: any, options?: MessageQueueEnqueueOptions): Promise<void>;
   enqueueMany(messages: any[], options?: MessageQueueEnqueueOptions): Promise<void>;
   listen(handler: (message: any) => void | Promise<void>, options?: MessageQueueListenOptions): Promise<void>;

package/dist/mq.js

@@ -17,12 +17,23 @@ const logger = getLogger([
 * ```ts ignore
 * import { createFederation } from "@fedify/fedify";
 * import { RedisMessageQueue } from "@fedify/redis";
-* import { Redis } from "ioredis";
+* import { Redis, Cluster } from "ioredis";
 *
+* // Using a standalone Redis instance:
 * const federation = createFederation({
 *   // ...
 *   queue: new RedisMessageQueue(() => new Redis()),
 * });
+*
+* // Using a Redis Cluster:
+* const federation = createFederation({
+*   // ...
+*   queue: new RedisMessageQueue(() => new Cluster([
+*     { host: "127.0.0.1", port: 7000 },
+*     { host: "127.0.0.1", port: 7001 },
+*     { host: "127.0.0.1", port: 7002 },
+*   ])),
+* });
 * ```
 */
 var RedisMessageQueue = class {
@@ -104,9 +115,24 @@ var RedisMessageQueue = class {
 			}
 		};
 		const promise = this.#subRedis.subscribe(this.#channelKey, () => {
-			this.#subRedis.on("message", poll);
+			/**
+			* Cast to Redis for event methods. Both Redis and Cluster extend EventEmitter
+			* and get the same methods via applyMixin at runtime, but their TypeScript
+			* interfaces are incompatible:
+			* - Redis declares specific overloads: on(event: "message", cb: (channel, message) => void)
+			* - Cluster only has generic: on(event: string | symbol, listener: Function)
+			*
+			* This makes the union type Redis | Cluster incompatible for these method calls.
+			* The cast is safe because both classes use applyMixin(Class, EventEmitter) which
+			* copies all EventEmitter prototype methods, giving them identical pub/sub functionality.
+			*
+			* @see https://github.com/redis/ioredis/blob/main/lib/Redis.ts#L863 (has specific overloads)
+			* @see https://github.com/redis/ioredis/blob/main/lib/cluster/index.ts#L1110 (empty interface)
+			*/
+			const subRedis = this.#subRedis;
+			subRedis.on("message", poll);
 			signal?.addEventListener("abort", () => {
-				this.#subRedis.off("message", poll);
+				subRedis.off("message", poll);
 			});
 		});
 		signal?.addEventListener("abort", () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/redis",
-  "version": "1.9.0-dev.1408+7c78ce1a",
+  "version": "1.9.0-dev.1415+1d51c69c",
   "description": "Redis drivers for Fedify",
   "keywords": [
     "fedify",
@@ -62,7 +62,7 @@
   },
   "peerDependencies": {
     "ioredis": "^5.6.1",
-    "@fedify/fedify": "1.9.0-dev.1408+7c78ce1a"
+    "@fedify/fedify": "1.9.0-dev.1415+1d51c69c"
   },
   "devDependencies": {
     "@std/async": "npm:@jsr/std__async@^1.0.13",