@fedify/redis 2.0.2-dev.407 → 2.1.0-dev.405

package/dist/codec.d.cts

@@ -2,45 +2,45 @@ import { Buffer } from "node:buffer";
 
 //#region src/codec.d.ts
 /**
-* Encode and decodes JavaScript objects to and from binary data.
-*/
+ * Encode and decodes JavaScript objects to and from binary data.
+ */
 interface Codec {
   /**
-  * Encodes a JavaScript object to binary data.
-  * @param value The JavaScript object to encode.
-  * @returns The encoded binary data.
-  * @throws {EncodingError} If the JavaScript object cannot be encoded.
-  */
+   * Encodes a JavaScript object to binary data.
+   * @param value The JavaScript object to encode.
+   * @returns The encoded binary data.
+   * @throws {EncodingError} If the JavaScript object cannot be encoded.
+   */
   encode(value: unknown): Buffer;
   /**
-  * Decodes a JavaScript object from binary data.
-  * @param encoded The binary data to decode.
-  * @returns The decoded JavaScript object.
-  * @throws {DecodingError} If the binary data is invalid.
-  */
+   * Decodes a JavaScript object from binary data.
+   * @param encoded The binary data to decode.
+   * @returns The decoded JavaScript object.
+   * @throws {DecodingError} If the binary data is invalid.
+   */
   decode(encoded: Buffer): unknown;
 }
 /**
-* An error that occurs when encoding or decoding data.
-*/
+ * An error that occurs when encoding or decoding data.
+ */
 declare class CodecError extends Error {
   constructor(message: string);
 }
 /**
-* An error that occurs when encoding data.
-*/
+ * An error that occurs when encoding data.
+ */
 declare class EncodingError extends CodecError {
   constructor(message: string);
 }
 /**
-* An error that occurs when decoding data.
-*/
+ * An error that occurs when decoding data.
+ */
 declare class DecodingError extends CodecError {
   constructor(message: string);
 }
 /**
-* A codec that encodes and decodes JavaScript objects to and from JSON.
-*/
+ * A codec that encodes and decodes JavaScript objects to and from JSON.
+ */
 declare class JsonCodec implements Codec {
   #private;
   encode(value: unknown): Buffer;

package/dist/codec.d.ts

@@ -3,45 +3,45 @@ import { Buffer } from "node:buffer";
 
 //#region src/codec.d.ts
 /**
-* Encode and decodes JavaScript objects to and from binary data.
-*/
+ * Encode and decodes JavaScript objects to and from binary data.
+ */
 interface Codec {
   /**
-  * Encodes a JavaScript object to binary data.
-  * @param value The JavaScript object to encode.
-  * @returns The encoded binary data.
-  * @throws {EncodingError} If the JavaScript object cannot be encoded.
-  */
+   * Encodes a JavaScript object to binary data.
+   * @param value The JavaScript object to encode.
+   * @returns The encoded binary data.
+   * @throws {EncodingError} If the JavaScript object cannot be encoded.
+   */
   encode(value: unknown): Buffer;
   /**
-  * Decodes a JavaScript object from binary data.
-  * @param encoded The binary data to decode.
-  * @returns The decoded JavaScript object.
-  * @throws {DecodingError} If the binary data is invalid.
-  */
+   * Decodes a JavaScript object from binary data.
+   * @param encoded The binary data to decode.
+   * @returns The decoded JavaScript object.
+   * @throws {DecodingError} If the binary data is invalid.
+   */
   decode(encoded: Buffer): unknown;
 }
 /**
-* An error that occurs when encoding or decoding data.
-*/
+ * An error that occurs when encoding or decoding data.
+ */
 declare class CodecError extends Error {
   constructor(message: string);
 }
 /**
-* An error that occurs when encoding data.
-*/
+ * An error that occurs when encoding data.
+ */
 declare class EncodingError extends CodecError {
   constructor(message: string);
 }
 /**
-* An error that occurs when decoding data.
-*/
+ * An error that occurs when decoding data.
+ */
 declare class DecodingError extends CodecError {
   constructor(message: string);
 }
 /**
-* A codec that encodes and decodes JavaScript objects to and from JSON.
-*/
+ * A codec that encodes and decodes JavaScript objects to and from JSON.
+ */
 declare class JsonCodec implements Codec {
   #private;
   encode(value: unknown): Buffer;

package/dist/kv.d.cts

@@ -4,62 +4,62 @@ import { Cluster, Redis, RedisKey } from "ioredis";
 
 //#region src/kv.d.ts
 /**
-* Options for {@link RedisKvStore} class.
-*/
+ * Options for {@link RedisKvStore} class.
+ */
 interface RedisKvStoreOptions {
   /**
-  * The prefix to use for all keys in the key–value store in Redis.
-  * Defaults to `"fedify::"`.
-  */
+   * The prefix to use for all keys in the key–value store in Redis.
+   * Defaults to `"fedify::"`.
+   */
   readonly keyPrefix?: RedisKey;
   /**
-  * The codec to use for encoding and decoding values in the key–value store.
-  * Defaults to {@link JsonCodec}.
-  */
+   * The codec to use for encoding and decoding values in the key–value store.
+   * Defaults to {@link JsonCodec}.
+   */
   readonly codec?: Codec;
 }
 /**
-* A key–value store that uses Redis as the underlying storage.
-*
-* @example
-* ```ts ignore
-* import { createFederation } from "@fedify/fedify";
-* import { RedisKvStore } from "@fedify/redis";
-* 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),
-* });
-* ```
-*/
+ * A key–value store that uses Redis as the underlying storage.
+ *
+ * @example
+ * ```ts ignore
+ * import { createFederation } from "@fedify/fedify";
+ * import { RedisKvStore } from "@fedify/redis";
+ * 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 (standalone or cluster) to use.
-  * @param options The options for the key–value store.
-  */
+   * Creates a new Redis key–value store.
+   * @param redis The Redis client (standalone or cluster) to use.
+   * @param options The options for the key–value store.
+   */
   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>;
   /**
-  * {@inheritDoc KvStore.list}
-  * @since 1.10.0
-  */
+   * {@inheritDoc KvStore.list}
+   * @since 1.10.0
+   */
   list(prefix?: KvKey): AsyncIterable<KvStoreListEntry>;
 }
 //#endregion

package/dist/kv.d.ts

@@ -5,62 +5,62 @@ import { Cluster, Redis, RedisKey } from "ioredis";
 
 //#region src/kv.d.ts
 /**
-* Options for {@link RedisKvStore} class.
-*/
+ * Options for {@link RedisKvStore} class.
+ */
 interface RedisKvStoreOptions {
   /**
-  * The prefix to use for all keys in the key–value store in Redis.
-  * Defaults to `"fedify::"`.
-  */
+   * The prefix to use for all keys in the key–value store in Redis.
+   * Defaults to `"fedify::"`.
+   */
   readonly keyPrefix?: RedisKey;
   /**
-  * The codec to use for encoding and decoding values in the key–value store.
-  * Defaults to {@link JsonCodec}.
-  */
+   * The codec to use for encoding and decoding values in the key–value store.
+   * Defaults to {@link JsonCodec}.
+   */
   readonly codec?: Codec;
 }
 /**
-* A key–value store that uses Redis as the underlying storage.
-*
-* @example
-* ```ts ignore
-* import { createFederation } from "@fedify/fedify";
-* import { RedisKvStore } from "@fedify/redis";
-* 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),
-* });
-* ```
-*/
+ * A key–value store that uses Redis as the underlying storage.
+ *
+ * @example
+ * ```ts ignore
+ * import { createFederation } from "@fedify/fedify";
+ * import { RedisKvStore } from "@fedify/redis";
+ * 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 (standalone or cluster) to use.
-  * @param options The options for the key–value store.
-  */
+   * Creates a new Redis key–value store.
+   * @param redis The Redis client (standalone or cluster) to use.
+   * @param options The options for the key–value store.
+   */
   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>;
   /**
-  * {@inheritDoc KvStore.list}
-  * @since 1.10.0
-  */
+   * {@inheritDoc KvStore.list}
+   * @since 1.10.0
+   */
   list(prefix?: KvKey): AsyncIterable<KvStoreListEntry>;
 }
 //#endregion

package/dist/mq.d.cts

@@ -4,78 +4,78 @@ import { Cluster, Redis, RedisKey } from "ioredis";
 
 //#region src/mq.d.ts
 /**
-* Options for {@link RedisMessageQueue} class.
-*/
+ * Options for {@link RedisMessageQueue} class.
+ */
 interface RedisMessageQueueOptions {
   /**
-  * The unique identifier for the worker that is processing messages from the
-  * queue.  If this is not specified, a random identifier will be generated.
-  * This is used to prevent multiple workers from processing the same message,
-  * so it should be unique for each worker.
-  */
+   * The unique identifier for the worker that is processing messages from the
+   * queue.  If this is not specified, a random identifier will be generated.
+   * This is used to prevent multiple workers from processing the same message,
+   * so it should be unique for each worker.
+   */
   readonly workerId?: string;
   /**
-  * The Pub/Sub channel key to use for the message queue.  `"fedify_channel"`
-  * by default.
-  * @default `"fedify_channel"`
-  */
+   * The Pub/Sub channel key to use for the message queue.  `"fedify_channel"`
+   * by default.
+   * @default `"fedify_channel"`
+   */
   readonly channelKey?: RedisKey;
   /**
-  * The Sorted Set key to use for the delayed message queue.  `"fedify_queue"`
-  * by default.
-  * @default `"fedify_queue"`
-  */
+   * The Sorted Set key to use for the delayed message queue.  `"fedify_queue"`
+   * by default.
+   * @default `"fedify_queue"`
+   */
   readonly queueKey?: RedisKey;
   /**
-  * The key to use for locking the message queue.  `"fedify_lock"` by default.
-  * @default `"fedify_lock"`
-  */
+   * The key to use for locking the message queue.  `"fedify_lock"` by default.
+   * @default `"fedify_lock"`
+   */
   readonly lockKey?: RedisKey;
   /**
-  * The codec to use for encoding and decoding messages in the key–value store.
-  * Defaults to {@link JsonCodec}.
-  * @default {@link JsonCodec}
-  */
+   * The codec to use for encoding and decoding messages in the key–value store.
+   * Defaults to {@link JsonCodec}.
+   * @default {@link JsonCodec}
+   */
   readonly codec?: Codec;
   /**
-  * The poll interval for the message queue.  5 seconds by default.
-  * @default `{ seconds: 5 }`
-  */
+   * The poll interval for the message queue.  5 seconds by default.
+   * @default `{ seconds: 5 }`
+   */
   readonly pollInterval?: Temporal.Duration | Temporal.DurationLike;
 }
 /**
-* A message queue that uses Redis as the underlying storage.
-*
-* @example
-* ```ts ignore
-* import { createFederation } from "@fedify/fedify";
-* import { RedisMessageQueue } from "@fedify/redis";
-* 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 },
-*   ])),
-* });
-* ```
-*/
+ * A message queue that uses Redis as the underlying storage.
+ *
+ * @example
+ * ```ts ignore
+ * import { createFederation } from "@fedify/fedify";
+ * import { RedisMessageQueue } from "@fedify/redis";
+ * 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 {
   #private;
   /**
-  * Creates a new Redis message queue.
-  * @param redis The Redis client factory.
-  * @param options The options for the message queue.
-  */
+   * Creates a new Redis message queue.
+   * @param redis The Redis client factory.
+   * @param options The options for the message queue.
+   */
   constructor(redis: () => Redis | Cluster, options?: RedisMessageQueueOptions);
   enqueue(message: any, options?: MessageQueueEnqueueOptions): Promise<void>;
   enqueueMany(messages: readonly any[], options?: MessageQueueEnqueueOptions): Promise<void>;

package/dist/mq.d.ts

@@ -5,78 +5,78 @@ import { Cluster, Redis, RedisKey } from "ioredis";
 
 //#region src/mq.d.ts
 /**
-* Options for {@link RedisMessageQueue} class.
-*/
+ * Options for {@link RedisMessageQueue} class.
+ */
 interface RedisMessageQueueOptions {
   /**
-  * The unique identifier for the worker that is processing messages from the
-  * queue.  If this is not specified, a random identifier will be generated.
-  * This is used to prevent multiple workers from processing the same message,
-  * so it should be unique for each worker.
-  */
+   * The unique identifier for the worker that is processing messages from the
+   * queue.  If this is not specified, a random identifier will be generated.
+   * This is used to prevent multiple workers from processing the same message,
+   * so it should be unique for each worker.
+   */
   readonly workerId?: string;
   /**
-  * The Pub/Sub channel key to use for the message queue.  `"fedify_channel"`
-  * by default.
-  * @default `"fedify_channel"`
-  */
+   * The Pub/Sub channel key to use for the message queue.  `"fedify_channel"`
+   * by default.
+   * @default `"fedify_channel"`
+   */
   readonly channelKey?: RedisKey;
   /**
-  * The Sorted Set key to use for the delayed message queue.  `"fedify_queue"`
-  * by default.
-  * @default `"fedify_queue"`
-  */
+   * The Sorted Set key to use for the delayed message queue.  `"fedify_queue"`
+   * by default.
+   * @default `"fedify_queue"`
+   */
   readonly queueKey?: RedisKey;
   /**
-  * The key to use for locking the message queue.  `"fedify_lock"` by default.
-  * @default `"fedify_lock"`
-  */
+   * The key to use for locking the message queue.  `"fedify_lock"` by default.
+   * @default `"fedify_lock"`
+   */
   readonly lockKey?: RedisKey;
   /**
-  * The codec to use for encoding and decoding messages in the key–value store.
-  * Defaults to {@link JsonCodec}.
-  * @default {@link JsonCodec}
-  */
+   * The codec to use for encoding and decoding messages in the key–value store.
+   * Defaults to {@link JsonCodec}.
+   * @default {@link JsonCodec}
+   */
   readonly codec?: Codec;
   /**
-  * The poll interval for the message queue.  5 seconds by default.
-  * @default `{ seconds: 5 }`
-  */
+   * The poll interval for the message queue.  5 seconds by default.
+   * @default `{ seconds: 5 }`
+   */
   readonly pollInterval?: Temporal.Duration | Temporal.DurationLike;
 }
 /**
-* A message queue that uses Redis as the underlying storage.
-*
-* @example
-* ```ts ignore
-* import { createFederation } from "@fedify/fedify";
-* import { RedisMessageQueue } from "@fedify/redis";
-* 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 },
-*   ])),
-* });
-* ```
-*/
+ * A message queue that uses Redis as the underlying storage.
+ *
+ * @example
+ * ```ts ignore
+ * import { createFederation } from "@fedify/fedify";
+ * import { RedisMessageQueue } from "@fedify/redis";
+ * 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 {
   #private;
   /**
-  * Creates a new Redis message queue.
-  * @param redis The Redis client factory.
-  * @param options The options for the message queue.
-  */
+   * Creates a new Redis message queue.
+   * @param redis The Redis client factory.
+   * @param options The options for the message queue.
+   */
   constructor(redis: () => Redis | Cluster, options?: RedisMessageQueueOptions);
   enqueue(message: any, options?: MessageQueueEnqueueOptions): Promise<void>;
   enqueueMany(messages: readonly any[], options?: MessageQueueEnqueueOptions): Promise<void>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fedify/redis",
-  "version": "2.0.2-dev.407+6f4b2e28",
+  "version": "2.1.0-dev.405+f4e278ae",
   "description": "Redis drivers for Fedify",
   "keywords": [
     "fedify",
@@ -82,15 +82,15 @@
   },
   "peerDependencies": {
     "ioredis": "^5.8.2",
-    "@fedify/fedify": "^2.0.2-dev.407+6f4b2e28"
+    "@fedify/fedify": "^2.1.0-dev.405+f4e278ae"
   },
   "devDependencies": {
     "@std/async": "npm:@jsr/std__async@^1.0.13",
     "@types/node": "^22.17.0",
     "tsdown": "^0.12.9",
     "typescript": "^5.9.3",
-    "@fedify/testing": "^2.0.2-dev.407+6f4b2e28",
-    "@fedify/fixture": "^2.0.0"
+    "@fedify/fixture": "^2.0.0",
+    "@fedify/testing": "^2.1.0-dev.405+f4e278ae"
   },
   "scripts": {
     "build:self": "tsdown",