@keyv/redis 4.0.1 → 4.0.2

package/README.md

@@ -183,7 +183,9 @@ const cluster = createCluster({
 const keyv = new Keyv({ store: new KeyvRedis(cluster) });
 ```
 
-You can learn more about the `createCluster` function in the [documentation](https://github.com/redis/node-redis/blob/master/docs/clustering.md) at https://github.com/redis/node-redis/tree/master/docs.
+There are some features that are not supported in clustering such as `clear()` and `iterator()`. This is because the `SCAN` command is not supported in clustering. If you need to clear or delete keys you can use the `deleteMany()` method.
+
+You can learn more about the `createCluster` function in the [documentation](https://github.com/redis/node-redis/blob/master/docs/clustering.md) at https://github.com/redis/node-redis/tree/master/docs. 
 
 Here is an example of how to use TLS:
 

package/dist/index.cjs

@@ -37,12 +37,12 @@ __export(src_exports, {
   default: () => KeyvRedis
 });
 module.exports = __toCommonJS(src_exports);
-var import_events = __toESM(require("events"), 1);
+var import_node_events = __toESM(require("events"), 1);
 var import_redis = require("redis");
 var import_keyv = require("keyv");
 var import_redis2 = require("redis");
 var import_keyv2 = require("keyv");
-var KeyvRedis = class extends import_events.default {
+var KeyvRedis = class extends import_node_events.default {
   _client = (0, import_redis.createClient)();
   _namespace;
   _keyPrefixSeparator = "::";
@@ -59,9 +59,9 @@ var KeyvRedis = class extends import_events.default {
       if (typeof connect === "string") {
         this._client = (0, import_redis.createClient)({ url: connect });
       } else if (connect.connect !== void 0) {
-        this._client = connect;
+        this._client = this.isClientCluster(connect) ? connect : connect;
       } else if (connect instanceof Object) {
-        this._client = (0, import_redis.createClient)(connect);
+        this._client = connect.rootNodes === void 0 ? (0, import_redis.createClient)(connect) : (0, import_redis.createCluster)(connect);
       }
     }
     this.setOptions(options);
@@ -84,13 +84,18 @@ var KeyvRedis = class extends import_events.default {
    * Get the options for the adapter.
    */
   get opts() {
-    return {
+    let url = "";
+    if (this._client.options) {
+      url = this._client.options?.url ?? "redis://localhost:6379";
+    }
+    const results = {
       namespace: this._namespace,
       keyPrefixSeparator: this._keyPrefixSeparator,
       clearBatchSize: this._clearBatchSize,
       dialect: "redis",
-      url: this._client?.options?.url ?? "redis://localhost:6379"
+      url
     };
+    return results;
   }
   /**
    * Set the options for the adapter.
@@ -255,11 +260,7 @@ var KeyvRedis = class extends import_events.default {
     const client = await this.getClient();
     key = this.createKeyPrefix(key, this._namespace);
     let deleted = 0;
-    if (this._useUnlink) {
-      deleted = await client.unlink(key);
-    } else {
-      deleted = await client.del(key);
-    }
+    deleted = await (this._useUnlink ? client.unlink(key) : client.del(key));
     return deleted > 0;
   }
   /**
@@ -320,12 +321,31 @@ var KeyvRedis = class extends import_events.default {
     }
     return key;
   }
+  /**
+   * Is the client a cluster.
+   * @returns {boolean} - true if the client is a cluster, false if not
+   */
+  isCluster() {
+    return this.isClientCluster(this._client);
+  }
   /**
    * Get an async iterator for the keys and values in the store. If a namespace is provided, it will only iterate over keys with that namespace.
    * @param {string} [namespace] - the namespace to iterate over
    * @returns {AsyncGenerator<[string, T | undefined], void, unknown>} - async iterator with key value pairs
    */
   async *iterator(namespace) {
+    if (this.isCluster()) {
+      throw new Error("Iterating over keys in a cluster is not supported.");
+    } else {
+      yield* this.iteratorClient(namespace);
+    }
+  }
+  /**
+   * Get an async iterator for the keys and values in the store. If a namespace is provided, it will only iterate over keys with that namespace.
+   * @param {string} [namespace] - the namespace to iterate over
+   * @returns {AsyncGenerator<[string, T | undefined], void, unknown>} - async iterator with key value pairs
+   */
+  async *iteratorClient(namespace) {
     const client = await this.getClient();
     const match = namespace ? `${namespace}${this._keyPrefixSeparator}*` : "*";
     let cursor = "0";
@@ -348,13 +368,13 @@ var KeyvRedis = class extends import_events.default {
   }
   /**
    * Clear all keys in the store.
-   * IMPORTANT: this can cause performance issues if there are a large number of keys in the store. Use with caution as not recommended for production.
+   * IMPORTANT: this can cause performance issues if there are a large number of keys in the store and worse with clusters. Use with caution as not recommended for production.
    * If a namespace is not set it will clear all keys with no prefix.
    * If a namespace is set it will clear all keys with that namespace.
    * @returns {Promise<void>}
    */
   async clear() {
-    await this.clearNamespace(this._namespace);
+    await (this.isCluster() ? this.clearNamespaceCluster(this._namespace) : this.clearNamespace(this._namespace));
   }
   async clearNamespace(namespace) {
     try {
@@ -384,6 +404,15 @@ var KeyvRedis = class extends import_events.default {
       this.emit("error", error);
     }
   }
+  async clearNamespaceCluster(namespace) {
+    throw new Error("Clearing all keys in a cluster is not supported.");
+  }
+  isClientCluster(client) {
+    if (client.options === void 0 && client.scan === void 0) {
+      return true;
+    }
+    return false;
+  }
   setOptions(options) {
     if (!options) {
       return;

package/dist/index.d.cts

@@ -1,6 +1,6 @@
-import EventEmitter from 'events';
-import { RedisClientOptions, RedisClientType } from 'redis';
-export { RedisClientOptions, RedisClientType, createClient, createCluster } from 'redis';
+import EventEmitter from 'node:events';
+import { RedisClientType, RedisClusterType, RedisModules, RedisFunctions, RedisScripts, RedisClientOptions, RedisClusterOptions } from 'redis';
+export { RedisClientOptions, RedisClientType, RedisClusterOptions, RedisClusterType, createClient, createCluster } from 'redis';
 import { KeyvStoreAdapter, Keyv } from 'keyv';
 export { Keyv } from 'keyv';
 
@@ -46,6 +46,7 @@ type KeyvRedisEntry<T> = {
      */
     ttl?: number;
 };
+type RedisClientConnectionType = RedisClientType | RedisClusterType<RedisModules, RedisFunctions, RedisScripts>;
 declare class KeyvRedis extends EventEmitter implements KeyvStoreAdapter {
     private _client;
     private _namespace;
@@ -57,15 +58,15 @@ declare class KeyvRedis extends EventEmitter implements KeyvStoreAdapter {
      * @param {string | RedisClientOptions | RedisClientType} [connect] How to connect to the Redis server. If string pass in the url, if object pass in the options, if RedisClient pass in the client.
      * @param {KeyvRedisOptions} [options] Options for the adapter such as namespace, keyPrefixSeparator, and clearBatchSize.
      */
-    constructor(connect?: string | RedisClientOptions | RedisClientType, options?: KeyvRedisOptions);
+    constructor(connect?: string | RedisClientOptions | RedisClusterOptions | RedisClientConnectionType, options?: KeyvRedisOptions);
     /**
      * Get the Redis client.
      */
-    get client(): RedisClientType;
+    get client(): RedisClientConnectionType;
     /**
      * Set the Redis client.
      */
-    set client(value: RedisClientType);
+    set client(value: RedisClientConnectionType);
     /**
      * Get the options for the adapter.
      */
@@ -113,7 +114,7 @@ declare class KeyvRedis extends EventEmitter implements KeyvStoreAdapter {
     /**
      * Get the Redis URL used to connect to the server. This is used to get a connected client.
      */
-    getClient(): Promise<RedisClientType>;
+    getClient(): Promise<RedisClientConnectionType>;
     /**
      * Set a key value pair in the store. TTL is in milliseconds.
      * @param {string} key - the key to set
@@ -181,21 +182,34 @@ declare class KeyvRedis extends EventEmitter implements KeyvStoreAdapter {
      * @returns {string} - the key without the namespace such as 'key'
      */
     getKeyWithoutPrefix(key: string, namespace?: string): string;
+    /**
+     * Is the client a cluster.
+     * @returns {boolean} - true if the client is a cluster, false if not
+     */
+    isCluster(): boolean;
     /**
      * Get an async iterator for the keys and values in the store. If a namespace is provided, it will only iterate over keys with that namespace.
      * @param {string} [namespace] - the namespace to iterate over
      * @returns {AsyncGenerator<[string, T | undefined], void, unknown>} - async iterator with key value pairs
      */
     iterator<Value>(namespace?: string): AsyncGenerator<[string, Value | undefined], void, unknown>;
+    /**
+     * Get an async iterator for the keys and values in the store. If a namespace is provided, it will only iterate over keys with that namespace.
+     * @param {string} [namespace] - the namespace to iterate over
+     * @returns {AsyncGenerator<[string, T | undefined], void, unknown>} - async iterator with key value pairs
+     */
+    iteratorClient<Value>(namespace?: string): AsyncGenerator<[string, Value | undefined], void, unknown>;
     /**
      * Clear all keys in the store.
-     * IMPORTANT: this can cause performance issues if there are a large number of keys in the store. Use with caution as not recommended for production.
+     * IMPORTANT: this can cause performance issues if there are a large number of keys in the store and worse with clusters. Use with caution as not recommended for production.
      * If a namespace is not set it will clear all keys with no prefix.
      * If a namespace is set it will clear all keys with that namespace.
      * @returns {Promise<void>}
      */
     clear(): Promise<void>;
     private clearNamespace;
+    private clearNamespaceCluster;
+    private isClientCluster;
     private setOptions;
     private initClient;
 }
@@ -207,4 +221,4 @@ declare class KeyvRedis extends EventEmitter implements KeyvStoreAdapter {
  */
 declare function createKeyv(connect?: string | RedisClientOptions | RedisClientType, options?: KeyvRedisOptions): Keyv;
 
-export { type KeyvRedisEntry, type KeyvRedisOptions, type KeyvRedisPropertyOptions, createKeyv, KeyvRedis as default };
+export { type KeyvRedisEntry, type KeyvRedisOptions, type KeyvRedisPropertyOptions, type RedisClientConnectionType, createKeyv, KeyvRedis as default };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-import EventEmitter from 'events';
-import { RedisClientOptions, RedisClientType } from 'redis';
-export { RedisClientOptions, RedisClientType, createClient, createCluster } from 'redis';
+import EventEmitter from 'node:events';
+import { RedisClientType, RedisClusterType, RedisModules, RedisFunctions, RedisScripts, RedisClientOptions, RedisClusterOptions } from 'redis';
+export { RedisClientOptions, RedisClientType, RedisClusterOptions, RedisClusterType, createClient, createCluster } from 'redis';
 import { KeyvStoreAdapter, Keyv } from 'keyv';
 export { Keyv } from 'keyv';
 
@@ -46,6 +46,7 @@ type KeyvRedisEntry<T> = {
      */
     ttl?: number;
 };
+type RedisClientConnectionType = RedisClientType | RedisClusterType<RedisModules, RedisFunctions, RedisScripts>;
 declare class KeyvRedis extends EventEmitter implements KeyvStoreAdapter {
     private _client;
     private _namespace;
@@ -57,15 +58,15 @@ declare class KeyvRedis extends EventEmitter implements KeyvStoreAdapter {
      * @param {string | RedisClientOptions | RedisClientType} [connect] How to connect to the Redis server. If string pass in the url, if object pass in the options, if RedisClient pass in the client.
      * @param {KeyvRedisOptions} [options] Options for the adapter such as namespace, keyPrefixSeparator, and clearBatchSize.
      */
-    constructor(connect?: string | RedisClientOptions | RedisClientType, options?: KeyvRedisOptions);
+    constructor(connect?: string | RedisClientOptions | RedisClusterOptions | RedisClientConnectionType, options?: KeyvRedisOptions);
     /**
      * Get the Redis client.
      */
-    get client(): RedisClientType;
+    get client(): RedisClientConnectionType;
     /**
      * Set the Redis client.
      */
-    set client(value: RedisClientType);
+    set client(value: RedisClientConnectionType);
     /**
      * Get the options for the adapter.
      */
@@ -113,7 +114,7 @@ declare class KeyvRedis extends EventEmitter implements KeyvStoreAdapter {
     /**
      * Get the Redis URL used to connect to the server. This is used to get a connected client.
      */
-    getClient(): Promise<RedisClientType>;
+    getClient(): Promise<RedisClientConnectionType>;
     /**
      * Set a key value pair in the store. TTL is in milliseconds.
      * @param {string} key - the key to set
@@ -181,21 +182,34 @@ declare class KeyvRedis extends EventEmitter implements KeyvStoreAdapter {
      * @returns {string} - the key without the namespace such as 'key'
      */
     getKeyWithoutPrefix(key: string, namespace?: string): string;
+    /**
+     * Is the client a cluster.
+     * @returns {boolean} - true if the client is a cluster, false if not
+     */
+    isCluster(): boolean;
     /**
      * Get an async iterator for the keys and values in the store. If a namespace is provided, it will only iterate over keys with that namespace.
      * @param {string} [namespace] - the namespace to iterate over
      * @returns {AsyncGenerator<[string, T | undefined], void, unknown>} - async iterator with key value pairs
      */
     iterator<Value>(namespace?: string): AsyncGenerator<[string, Value | undefined], void, unknown>;
+    /**
+     * Get an async iterator for the keys and values in the store. If a namespace is provided, it will only iterate over keys with that namespace.
+     * @param {string} [namespace] - the namespace to iterate over
+     * @returns {AsyncGenerator<[string, T | undefined], void, unknown>} - async iterator with key value pairs
+     */
+    iteratorClient<Value>(namespace?: string): AsyncGenerator<[string, Value | undefined], void, unknown>;
     /**
      * Clear all keys in the store.
-     * IMPORTANT: this can cause performance issues if there are a large number of keys in the store. Use with caution as not recommended for production.
+     * IMPORTANT: this can cause performance issues if there are a large number of keys in the store and worse with clusters. Use with caution as not recommended for production.
      * If a namespace is not set it will clear all keys with no prefix.
      * If a namespace is set it will clear all keys with that namespace.
      * @returns {Promise<void>}
      */
     clear(): Promise<void>;
     private clearNamespace;
+    private clearNamespaceCluster;
+    private isClientCluster;
     private setOptions;
     private initClient;
 }
@@ -207,4 +221,4 @@ declare class KeyvRedis extends EventEmitter implements KeyvStoreAdapter {
  */
 declare function createKeyv(connect?: string | RedisClientOptions | RedisClientType, options?: KeyvRedisOptions): Keyv;
 
-export { type KeyvRedisEntry, type KeyvRedisOptions, type KeyvRedisPropertyOptions, createKeyv, KeyvRedis as default };
+export { type KeyvRedisEntry, type KeyvRedisOptions, type KeyvRedisPropertyOptions, type RedisClientConnectionType, createKeyv, KeyvRedis as default };

package/dist/index.js

@@ -1,10 +1,13 @@
 // src/index.ts
-import EventEmitter from "events";
-import { createClient } from "redis";
+import EventEmitter from "node:events";
+import {
+  createClient,
+  createCluster
+} from "redis";
 import { Keyv } from "keyv";
 import {
   createClient as createClient2,
-  createCluster
+  createCluster as createCluster2
 } from "redis";
 import {
   Keyv as Keyv2
@@ -26,9 +29,9 @@ var KeyvRedis = class extends EventEmitter {
       if (typeof connect === "string") {
         this._client = createClient({ url: connect });
       } else if (connect.connect !== void 0) {
-        this._client = connect;
+        this._client = this.isClientCluster(connect) ? connect : connect;
       } else if (connect instanceof Object) {
-        this._client = createClient(connect);
+        this._client = connect.rootNodes === void 0 ? createClient(connect) : createCluster(connect);
       }
     }
     this.setOptions(options);
@@ -51,13 +54,18 @@ var KeyvRedis = class extends EventEmitter {
    * Get the options for the adapter.
    */
   get opts() {
-    return {
+    let url = "";
+    if (this._client.options) {
+      url = this._client.options?.url ?? "redis://localhost:6379";
+    }
+    const results = {
       namespace: this._namespace,
       keyPrefixSeparator: this._keyPrefixSeparator,
       clearBatchSize: this._clearBatchSize,
       dialect: "redis",
-      url: this._client?.options?.url ?? "redis://localhost:6379"
+      url
     };
+    return results;
   }
   /**
    * Set the options for the adapter.
@@ -222,11 +230,7 @@ var KeyvRedis = class extends EventEmitter {
     const client = await this.getClient();
     key = this.createKeyPrefix(key, this._namespace);
     let deleted = 0;
-    if (this._useUnlink) {
-      deleted = await client.unlink(key);
-    } else {
-      deleted = await client.del(key);
-    }
+    deleted = await (this._useUnlink ? client.unlink(key) : client.del(key));
     return deleted > 0;
   }
   /**
@@ -287,12 +291,31 @@ var KeyvRedis = class extends EventEmitter {
     }
     return key;
   }
+  /**
+   * Is the client a cluster.
+   * @returns {boolean} - true if the client is a cluster, false if not
+   */
+  isCluster() {
+    return this.isClientCluster(this._client);
+  }
   /**
    * Get an async iterator for the keys and values in the store. If a namespace is provided, it will only iterate over keys with that namespace.
    * @param {string} [namespace] - the namespace to iterate over
    * @returns {AsyncGenerator<[string, T | undefined], void, unknown>} - async iterator with key value pairs
    */
   async *iterator(namespace) {
+    if (this.isCluster()) {
+      throw new Error("Iterating over keys in a cluster is not supported.");
+    } else {
+      yield* this.iteratorClient(namespace);
+    }
+  }
+  /**
+   * Get an async iterator for the keys and values in the store. If a namespace is provided, it will only iterate over keys with that namespace.
+   * @param {string} [namespace] - the namespace to iterate over
+   * @returns {AsyncGenerator<[string, T | undefined], void, unknown>} - async iterator with key value pairs
+   */
+  async *iteratorClient(namespace) {
     const client = await this.getClient();
     const match = namespace ? `${namespace}${this._keyPrefixSeparator}*` : "*";
     let cursor = "0";
@@ -315,13 +338,13 @@ var KeyvRedis = class extends EventEmitter {
   }
   /**
    * Clear all keys in the store.
-   * IMPORTANT: this can cause performance issues if there are a large number of keys in the store. Use with caution as not recommended for production.
+   * IMPORTANT: this can cause performance issues if there are a large number of keys in the store and worse with clusters. Use with caution as not recommended for production.
    * If a namespace is not set it will clear all keys with no prefix.
    * If a namespace is set it will clear all keys with that namespace.
    * @returns {Promise<void>}
    */
   async clear() {
-    await this.clearNamespace(this._namespace);
+    await (this.isCluster() ? this.clearNamespaceCluster(this._namespace) : this.clearNamespace(this._namespace));
   }
   async clearNamespace(namespace) {
     try {
@@ -351,6 +374,15 @@ var KeyvRedis = class extends EventEmitter {
       this.emit("error", error);
     }
   }
+  async clearNamespaceCluster(namespace) {
+    throw new Error("Clearing all keys in a cluster is not supported.");
+  }
+  isClientCluster(client) {
+    if (client.options === void 0 && client.scan === void 0) {
+      return true;
+    }
+    return false;
+  }
   setOptions(options) {
     if (!options) {
       return;
@@ -382,7 +414,7 @@ function createKeyv(connect, options) {
 export {
   Keyv2 as Keyv,
   createClient2 as createClient,
-  createCluster,
+  createCluster2 as createCluster,
   createKeyv,
   KeyvRedis as default
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@keyv/redis",
-  "version": "4.0.1",
+  "version": "4.0.2",
   "description": "Redis storage adapter for Keyv",
   "type": "module",
   "main": "dist/index.cjs",
@@ -12,23 +12,6 @@
       "import": "./dist/index.js"
     }
   },
-  "xo": {
-    "rules": {
-      "import/no-named-as-default": "off",
-      "unicorn/prefer-module": "off",
-      "unicorn/prefer-event-target": "off",
-      "unicorn/prefer-node-protocol": "off",
-      "unicorn/no-typeof-undefined": "off",
-      "import/extensions": "off",
-      "@typescript-eslint/no-unsafe-call": "off",
-      "@typescript-eslint/no-unsafe-assignment": "off",
-      "@typescript-eslint/no-unsafe-return": "off",
-      "unicorn/prefer-ternary": "off",
-      "unicorn/no-array-callback-reference": "off",
-      "import/no-extraneous-dependencies": "off",
-      "@typescript-eslint/no-confusing-void-expression": "off"
-    }
-  },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/jaredwray/keyv.git"
@@ -51,14 +34,16 @@
   },
   "homepage": "https://github.com/jaredwray/keyv",
   "dependencies": {
-    "redis": "^4.7.0",
-    "keyv": "*"
+    "keyv": "*",
+    "redis": "^4.7.0"
   },
   "devDependencies": {
     "@keyv/test-suite": "*",
+    "@vitest/coverage-v8": "^2.1.5",
     "rimraf": "^6.0.1",
     "timekeeper": "^2.3.1",
     "tsd": "^0.31.2",
+    "vitest": "^2.1.5",
     "xo": "^0.59.3"
   },
   "tsd": {