@fedify/redis 0.1.1 → 0.2.0

package/README.md

@@ -13,6 +13,17 @@ implementations for Redis:
  -  [`RedisKvStore`]
  -  [`RedisMessageQueue`]
 
+~~~~ typescript
+import { createFederation } from "@fedify/fedify";
+import { RedisKvStore, RedisMessageQueue } from "@fedify/redis";
+import { Redis } from "ioredis";
+
+const federation = createFederation({
+  kv: new RedisKvStore(new Redis()),
+  queue: new RedisMessageQueue(() => new Redis()),
+});
+~~~~
+
 [JSR]: https://jsr.io/@fedify/redis
 [JSR badge]: https://jsr.io/badges/@fedify/redis
 [npm]: https://www.npmjs.com/package/@fedify/redis
@@ -26,9 +37,39 @@ implementations for Redis:
 [`RedisMessageQueue`]: https://jsr.io/@fedify/redis/doc/mq/~/RedisMessageQueue
 
 
+Installation
+------------
+
+### Deno
+
+~~~~ sh
+deno add @fedify/redis
+~~~~
+
+### Node.js
+
+~~~~ sh
+npm install @fedify/redis
+~~~~
+
+### Bun
+
+~~~~ sh
+bun add @fedify/redis
+~~~~
+
+
 Changelog
 ---------
 
+### Version 0.2.0
+
+Released on September 26, 2024.
+
+ -  Let `RedisMessageQueue` follow up the latest `MessageQueue` interface,
+    which was updated in Fedify 1.0.0.
+ -  Added some example code.
+
 ### Version 0.1.1
 
 Released on June 22, 2024.

package/esm/src/kv.js

@@ -14,6 +14,18 @@ import { Buffer } from "node:buffer";
 import { JsonCodec } from "./codec.js";
 /**
  * A key-value store that uses Redis as the underlying storage.
+ *
+ * @example
+ * ```ts
+ * import { createFederation } from "@fedify/fedify";
+ * import { RedisKvStore } from "@fedify/redis";
+ * import { Redis } from "ioredis";
+ *
+ * const federation = createFederation({
+ *   // ...
+ *   kv: new RedisKvStore(new Redis()),
+ * });
+ * ```
  */
 export class RedisKvStore {
     /**

package/esm/src/mq.js

@@ -15,6 +15,18 @@ import * as dntShim from "../_dnt.shims.js";
 import { JsonCodec } from "./codec.js";
 /**
  * A message queue that uses Redis as the underlying storage.
+ *
+ * @example
+ * ```ts
+ * import { createFederation } from "@fedify/fedify";
+ * import { RedisMessageQueue } from "@fedify/redis";
+ * import { Redis } from "ioredis";
+ *
+ * const federation = createFederation({
+ *   // ...
+ *   queue: new RedisMessageQueue(() => new Redis()),
+ * });
+ * ```
  */
 export class RedisMessageQueue {
     /**
@@ -51,22 +63,33 @@ export class RedisMessageQueue {
         if (ts < 1)
             __classPrivateFieldGet(this, _RedisMessageQueue_redis, "f").publish(__classPrivateFieldGet(this, _RedisMessageQueue_channelKey, "f"), "");
     }
-    listen(handler) {
+    listen(handler, options = {}) {
         if (__classPrivateFieldGet(this, _RedisMessageQueue_loopHandle, "f") != null) {
             throw new Error("Already listening");
         }
+        const signal = options.signal;
         __classPrivateFieldSet(this, _RedisMessageQueue_loopHandle, setInterval(async () => {
             const message = await __classPrivateFieldGet(this, _RedisMessageQueue_instances, "m", _RedisMessageQueue_poll).call(this);
             if (message === undefined)
                 return;
             await handler(message);
         }, __classPrivateFieldGet(this, _RedisMessageQueue_loopInterval, "f").total({ unit: "milliseconds" })), "f");
-        __classPrivateFieldGet(this, _RedisMessageQueue_subRedis, "f").subscribe(__classPrivateFieldGet(this, _RedisMessageQueue_channelKey, "f"), () => {
-            __classPrivateFieldGet(this, _RedisMessageQueue_subRedis, "f").on("message", async () => {
+        const promise = __classPrivateFieldGet(this, _RedisMessageQueue_subRedis, "f").subscribe(__classPrivateFieldGet(this, _RedisMessageQueue_channelKey, "f"), () => {
+            const onMessage = async () => {
                 const message = await __classPrivateFieldGet(this, _RedisMessageQueue_instances, "m", _RedisMessageQueue_poll).call(this);
                 if (message === undefined)
                     return;
                 await handler(message);
+            };
+            __classPrivateFieldGet(this, _RedisMessageQueue_subRedis, "f").on("message", onMessage);
+            signal?.addEventListener("abort", () => {
+                __classPrivateFieldGet(this, _RedisMessageQueue_subRedis, "f").off("message", onMessage);
+            });
+        });
+        return new Promise((resolve) => {
+            signal?.addEventListener("abort", () => {
+                clearInterval(__classPrivateFieldGet(this, _RedisMessageQueue_loopHandle, "f"));
+                promise.then(() => resolve());
             });
         });
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/redis",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Redis drivers for Fedify",
   "keywords": [
     "fedify",
@@ -55,8 +55,11 @@
       }
     }
   },
+  "funding": [
+    "https://github.com/sponsors/dahlia"
+  ],
   "dependencies": {
-    "@fedify/fedify": "^0.10.0",
+    "@fedify/fedify": "^1.0.0",
     "ioredis": "^5.4.0",
     "@deno/shim-deno": "~0.18.0",
     "@js-temporal/polyfill": "^0.4.4"

package/script/src/kv.js

@@ -17,6 +17,18 @@ const node_buffer_1 = require("node:buffer");
 const codec_js_1 = require("./codec.js");
 /**
  * A key-value store that uses Redis as the underlying storage.
+ *
+ * @example
+ * ```ts
+ * import { createFederation } from "@fedify/fedify";
+ * import { RedisKvStore } from "@fedify/redis";
+ * import { Redis } from "ioredis";
+ *
+ * const federation = createFederation({
+ *   // ...
+ *   kv: new RedisKvStore(new Redis()),
+ * });
+ * ```
  */
 class RedisKvStore {
     /**

package/script/src/mq.js

@@ -41,6 +41,18 @@ const dntShim = __importStar(require("../_dnt.shims.js"));
 const codec_js_1 = require("./codec.js");
 /**
  * A message queue that uses Redis as the underlying storage.
+ *
+ * @example
+ * ```ts
+ * import { createFederation } from "@fedify/fedify";
+ * import { RedisMessageQueue } from "@fedify/redis";
+ * import { Redis } from "ioredis";
+ *
+ * const federation = createFederation({
+ *   // ...
+ *   queue: new RedisMessageQueue(() => new Redis()),
+ * });
+ * ```
  */
 class RedisMessageQueue {
     /**
@@ -77,22 +89,33 @@ class RedisMessageQueue {
         if (ts < 1)
             __classPrivateFieldGet(this, _RedisMessageQueue_redis, "f").publish(__classPrivateFieldGet(this, _RedisMessageQueue_channelKey, "f"), "");
     }
-    listen(handler) {
+    listen(handler, options = {}) {
         if (__classPrivateFieldGet(this, _RedisMessageQueue_loopHandle, "f") != null) {
             throw new Error("Already listening");
         }
+        const signal = options.signal;
         __classPrivateFieldSet(this, _RedisMessageQueue_loopHandle, setInterval(async () => {
             const message = await __classPrivateFieldGet(this, _RedisMessageQueue_instances, "m", _RedisMessageQueue_poll).call(this);
             if (message === undefined)
                 return;
             await handler(message);
         }, __classPrivateFieldGet(this, _RedisMessageQueue_loopInterval, "f").total({ unit: "milliseconds" })), "f");
-        __classPrivateFieldGet(this, _RedisMessageQueue_subRedis, "f").subscribe(__classPrivateFieldGet(this, _RedisMessageQueue_channelKey, "f"), () => {
-            __classPrivateFieldGet(this, _RedisMessageQueue_subRedis, "f").on("message", async () => {
+        const promise = __classPrivateFieldGet(this, _RedisMessageQueue_subRedis, "f").subscribe(__classPrivateFieldGet(this, _RedisMessageQueue_channelKey, "f"), () => {
+            const onMessage = async () => {
                 const message = await __classPrivateFieldGet(this, _RedisMessageQueue_instances, "m", _RedisMessageQueue_poll).call(this);
                 if (message === undefined)
                     return;
                 await handler(message);
+            };
+            __classPrivateFieldGet(this, _RedisMessageQueue_subRedis, "f").on("message", onMessage);
+            signal?.addEventListener("abort", () => {
+                __classPrivateFieldGet(this, _RedisMessageQueue_subRedis, "f").off("message", onMessage);
+            });
+        });
+        return new Promise((resolve) => {
+            signal?.addEventListener("abort", () => {
+                clearInterval(__classPrivateFieldGet(this, _RedisMessageQueue_loopHandle, "f"));
+                promise.then(() => resolve());
             });
         });
     }

package/types/src/codec.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 import { Buffer } from "node:buffer";
 /**
  * Encode and decodes JavaScript objects to and from binary data.

package/types/src/codec.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"codec.d.ts","sourceRoot":"","sources":["../../src/src/codec.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;;;;OAKG;IACH,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAAC;IAE/B;;;;;OAKG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC;CAClC;AAED;;GAEG;AACH,qBAAa,UAAW,SAAQ,KAAK;gBACvB,OAAO,EAAE,MAAM;CAI5B;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,UAAU;gBAC/B,OAAO,EAAE,MAAM;CAI5B;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,UAAU;gBAC/B,OAAO,EAAE,MAAM;CAI5B;AAED;;GAEG;AACH,qBAAa,SAAU,YAAW,KAAK;;IAIrC,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM;IAW9B,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;CASjC"}
+{"version":3,"file":"codec.d.ts","sourceRoot":"","sources":["../../src/src/codec.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC;;GAEG;AACH,MAAM,WAAW,KAAK;IACpB;;;;;OAKG;IACH,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,CAAC;IAE/B;;;;;OAKG;IACH,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAC;CAClC;AAED;;GAEG;AACH,qBAAa,UAAW,SAAQ,KAAK;gBACvB,OAAO,EAAE,MAAM;CAI5B;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,UAAU;gBAC/B,OAAO,EAAE,MAAM;CAI5B;AAED;;GAEG;AACH,qBAAa,aAAc,SAAQ,UAAU;gBAC/B,OAAO,EAAE,MAAM;CAI5B;AAED;;GAEG;AACH,qBAAa,SAAU,YAAW,KAAK;;IAIrC,MAAM,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM;IAW9B,MAAM,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO;CASjC"}

package/types/src/kv.d.ts

@@ -18,6 +18,18 @@ export interface RedisKvStoreOptions {
 }
 /**
  * A key-value store that uses Redis as the underlying storage.
+ *
+ * @example
+ * ```ts
+ * import { createFederation } from "@fedify/fedify";
+ * import { RedisKvStore } from "@fedify/redis";
+ * import { Redis } from "ioredis";
+ *
+ * const federation = createFederation({
+ *   // ...
+ *   kv: new RedisKvStore(new Redis()),
+ * });
+ * ```
  */
 export declare class RedisKvStore implements KvStore {
     #private;

package/types/src/kv.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"kv.d.ts","sourceRoot":"","sources":["../../src/src/kv.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACxE,OAAO,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAE/C,OAAO,EAAE,KAAK,KAAK,EAAa,MAAM,YAAY,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,SAAS,CAAC,EAAE,QAAQ,CAAC;IAErB;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;CACf;AAED;;GAEG;AACH,qBAAa,YAAa,YAAW,OAAO;;IAM1C;;;;OAIG;gBACS,KAAK,EAAE,KAAK,EAAE,OAAO,GAAE,mBAAwB;IAiBrD,GAAG,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,EAAE,KAAK,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAOpD,GAAG,CACP,GAAG,EAAE,KAAK,EACV,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE,iBAAiB,GAAG,SAAS,GACtC,OAAO,CAAC,IAAI,CAAC;IAcV,MAAM,CAAC,GAAG,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;CAIxC"}
+{"version":3,"file":"kv.d.ts","sourceRoot":"","sources":["../../src/src/kv.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACxE,OAAO,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAE/C,OAAO,EAAE,KAAK,KAAK,EAAa,MAAM,YAAY,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,SAAS,CAAC,EAAE,QAAQ,CAAC;IAErB;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;CACf;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,YAAa,YAAW,OAAO;;IAM1C;;;;OAIG;gBACS,KAAK,EAAE,KAAK,EAAE,OAAO,GAAE,mBAAwB;IAiBrD,GAAG,CAAC,CAAC,GAAG,OAAO,EAAE,GAAG,EAAE,KAAK,GAAG,OAAO,CAAC,CAAC,GAAG,SAAS,CAAC;IAOpD,GAAG,CACP,GAAG,EAAE,KAAK,EACV,KAAK,EAAE,OAAO,EACd,OAAO,CAAC,EAAE,iBAAiB,GAAG,SAAS,GACtC,OAAO,CAAC,IAAI,CAAC;IAcV,MAAM,CAAC,GAAG,EAAE,KAAK,GAAG,OAAO,CAAC,IAAI,CAAC;CAIxC"}

package/types/src/mq.d.ts

@@ -1,6 +1,5 @@
-/// <reference types="node" />
 import * as dntShim from "../_dnt.shims.js";
-import type { MessageQueue, MessageQueueEnqueueOptions } from "@fedify/fedify";
+import type { MessageQueue, MessageQueueEnqueueOptions, MessageQueueListenOptions } from "@fedify/fedify";
 import type { Redis, RedisKey } from "ioredis";
 import { type Codec } from "./codec.js";
 /**
@@ -45,6 +44,18 @@ export interface RedisMessageQueueOptions {
 }
 /**
  * A message queue that uses Redis as the underlying storage.
+ *
+ * @example
+ * ```ts
+ * import { createFederation } from "@fedify/fedify";
+ * import { RedisMessageQueue } from "@fedify/redis";
+ * import { Redis } from "ioredis";
+ *
+ * const federation = createFederation({
+ *   // ...
+ *   queue: new RedisMessageQueue(() => new Redis()),
+ * });
+ * ```
  */
 export declare class RedisMessageQueue implements MessageQueue, Disposable {
     #private;
@@ -55,7 +66,7 @@ export declare class RedisMessageQueue implements MessageQueue, Disposable {
      */
     constructor(redis: () => Redis, options?: RedisMessageQueueOptions);
     enqueue(message: any, options?: MessageQueueEnqueueOptions): Promise<void>;
-    listen(handler: (message: any) => void | Promise<void>): void;
+    listen(handler: (message: any) => void | Promise<void>, options?: MessageQueueListenOptions): Promise<void>;
     [Symbol.dispose](): void;
 }
 //# sourceMappingURL=mq.d.ts.map

package/types/src/mq.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mq.d.ts","sourceRoot":"","sources":["../../src/src/mq.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAC;AAE5C,OAAO,KAAK,EAAE,YAAY,EAAE,0BAA0B,EAAE,MAAM,gBAAgB,CAAC;AAC/E,OAAO,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAC/C,OAAO,EAAE,KAAK,KAAK,EAAa,MAAM,YAAY,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,UAAU,CAAC,EAAE,QAAQ,CAAC;IAEtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,QAAQ,CAAC;IAEnB;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;IAEd;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC;CAC9C;AAED;;GAEG;AACH,qBAAa,iBAAkB,YAAW,YAAY,EAAE,UAAU;;IAWhE;;;;OAIG;gBACS,KAAK,EAAE,MAAM,KAAK,EAAE,OAAO,GAAE,wBAA6B;IAahE,OAAO,CACX,OAAO,EAAE,GAAG,EACZ,OAAO,CAAC,EAAE,0BAA0B,GACnC,OAAO,CAAC,IAAI,CAAC;IA+BhB,MAAM,CAAC,OAAO,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,GAAG,IAAI;IAkB7D,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI;CAKzB"}
+{"version":3,"file":"mq.d.ts","sourceRoot":"","sources":["../../src/src/mq.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,OAAO,MAAM,kBAAkB,CAAC;AAE5C,OAAO,KAAK,EACV,YAAY,EACZ,0BAA0B,EAC1B,yBAAyB,EAC1B,MAAM,gBAAgB,CAAC;AACxB,OAAO,KAAK,EAAE,KAAK,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAC/C,OAAO,EAAE,KAAK,KAAK,EAAa,MAAM,YAAY,CAAC;AAEnD;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,UAAU,CAAC,EAAE,QAAQ,CAAC;IAEtB;;;OAGG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;IAEpB;;OAEG;IACH,OAAO,CAAC,EAAE,QAAQ,CAAC;IAEnB;;;OAGG;IACH,KAAK,CAAC,EAAE,KAAK,CAAC;IAEd;;;;;;;OAOG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC;CAC9C;AAED;;;;;;;;;;;;;;GAcG;AACH,qBAAa,iBAAkB,YAAW,YAAY,EAAE,UAAU;;IAWhE;;;;OAIG;gBACS,KAAK,EAAE,MAAM,KAAK,EAAE,OAAO,GAAE,wBAA6B;IAahE,OAAO,CACX,OAAO,EAAE,GAAG,EACZ,OAAO,CAAC,EAAE,0BAA0B,GACnC,OAAO,CAAC,IAAI,CAAC;IA+BhB,MAAM,CACJ,OAAO,EAAE,CAAC,OAAO,EAAE,GAAG,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,EAC/C,OAAO,GAAE,yBAA8B,GACtC,OAAO,CAAC,IAAI,CAAC;IA6BhB,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,IAAI;CAKzB"}