redis-smq-common 1.0.0-rc.6 → 1.0.0-rc.9

package/.codecov.yml

@@ -0,0 +1,5 @@
+coverage:
+  status:
+    patch:
+      default:
+        target: 80%

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # CHANGELOG
 
+## 1.0.0-rc.9 (2022-05-31)
+
+* Improve RedisClient typings (27219a6)
+* Set up codecov (98293bd)
+* Fix type coverage (2f4a722)
+
+## 1.0.0-rc.8 (2022-05-30)
+
+* Add WatchedKeysChangedError class (1e42e80)
+
+## 1.0.0-rc.7 (2022-05-30)
+
+* Fix various redis errors (9349261)
+
 ## 1.0.0-rc.6 (2022-05-30)
 
 * Fix missing RedisClient from package exports (88f90f0)

package/dist/src/redis-client/clients/ioredis-client-multi.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.IoredisClientMulti = void 0;
 const redis_client_error_1 = require("../errors/redis-client.error");
+const watched_keys_changed_error_1 = require("../errors/watched-keys-changed.error");
 class IoredisClientMulti {
     constructor(client) {
         this.multi = client.multi();
@@ -43,7 +44,7 @@ class IoredisClientMulti {
         return this;
     }
     srem(key, element) {
-        this.multi.srem(key, ...element);
+        this.multi.srem(key, ...(typeof element === 'string' ? [element] : element));
         return this;
     }
     hset(key, field, value) {
@@ -63,7 +64,7 @@ class IoredisClientMulti {
         return this;
     }
     del(key) {
-        this.multi.del(...key);
+        this.multi.del(...(typeof key === 'string' ? [key] : key));
         return this;
     }
     exec(cb) {
@@ -71,7 +72,7 @@ class IoredisClientMulti {
             if (err)
                 cb(err);
             else if (!reply)
-                cb(new redis_client_error_1.RedisClientError(`Redis transaction has been abandoned. Try again.`));
+                cb(new watched_keys_changed_error_1.WatchedKeysChangedError());
             else {
                 const lengths = [];
                 let err = null;

package/dist/src/redis-client/clients/ioredis-client.d.ts

@@ -11,7 +11,7 @@ export declare class IoredisClient extends RedisClient {
             value: number;
         };
         exists?: 'NX' | 'XX';
-    }, cb: ICallback<string>): void;
+    }, cb: ICallback<string | null>): void;
     zadd(key: string, score: number, member: string, cb: ICallback<number | string>): void;
     multi(): IoredisClientMulti;
     watch(args: string[], cb: ICallback<string>): void;
@@ -25,25 +25,25 @@ export declare class IoredisClient extends RedisClient {
     smembers(key: string, cb: ICallback<string[]>): void;
     sadd(key: string, member: string, cb: ICallback<number>): void;
     hgetall(key: string, cb: ICallback<Record<string, string>>): void;
-    hget(key: string, field: string, cb: ICallback<string>): void;
+    hget(key: string, field: string, cb: ICallback<string | null>): void;
     hset(key: string, field: string, value: string, cb: ICallback<number>): void;
     hdel(key: string, fields: string | string[], cb: ICallback<number>): void;
     lrange(key: string, start: number, stop: number, cb: ICallback<string[]>): void;
     hkeys(key: string, cb: ICallback<string[]>): void;
     hlen(key: string, cb: ICallback<number>): void;
-    brpoplpush(source: string, destination: string, timeout: number, cb: ICallback<string>): void;
-    rpoplpush(source: string, destination: string, cb: ICallback<string>): void;
+    brpoplpush(source: string, destination: string, timeout: number, cb: ICallback<string | null>): void;
+    rpoplpush(source: string, destination: string, cb: ICallback<string | null>): void;
     zrangebyscorewithscores(source: string, min: number, max: number, cb: ICallback<Record<string, string>>): void;
-    rpop(key: string, cb: ICallback<string>): void;
+    rpop(key: string, cb: ICallback<string | null>): void;
     lrem(key: string, count: number, element: string, cb: ICallback<number>): void;
     publish(channel: string, message: string, cb: ICallback<number>): void;
     flushall(cb: ICallback<string>): void;
     loadScript(script: string, cb: ICallback<string>): void;
     evalsha(hash: string, args: (string | number)[] | string | number, cb: (err?: Error | null, res?: unknown) => void): void;
-    get(key: string, cb: ICallback<string>): void;
+    get(key: string, cb: ICallback<string | null>): void;
     del(key: string | string[], cb: ICallback<number>): void;
     llen(key: string, cb: ICallback<number>): void;
-    lmove(source: string, destination: string, from: 'LEFT' | 'RIGHT', to: 'LEFT' | 'RIGHT', cb: ICallback<string>): void;
+    lmove(source: string, destination: string, from: 'LEFT' | 'RIGHT', to: 'LEFT' | 'RIGHT', cb: ICallback<string | null>): void;
     zremrangebyscore(source: string, min: number | string, max: number | string, cb: ICallback<number>): void;
     hmget(source: string, keys: string[], cb: ICallback<(string | null)[]>): void;
     halt(cb: ICallback<void>): void;

package/dist/src/redis-client/clients/node-redis-v3-client-multi.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NodeRedisV3ClientMulti = void 0;
-const redis_client_error_1 = require("../errors/redis-client.error");
+const watched_keys_changed_error_1 = require("../errors/watched-keys-changed.error");
 class NodeRedisV3ClientMulti {
     constructor(client) {
         this.multi = client.multi();
@@ -71,7 +71,7 @@ class NodeRedisV3ClientMulti {
             if (err)
                 cb(err);
             else if (!reply)
-                cb(new redis_client_error_1.RedisClientError(`Redis transaction has been abandoned. Try again.`));
+                cb(new watched_keys_changed_error_1.WatchedKeysChangedError());
             else
                 cb(null, reply);
         });

package/dist/src/redis-client/clients/node-redis-v3-client.d.ts

@@ -11,7 +11,7 @@ export declare class NodeRedisV3Client extends RedisClient {
             value: number;
         };
         exists?: 'NX' | 'XX';
-    }, cb: ICallback<string>): void;
+    }, cb: ICallback<string | null>): void;
     zadd(key: string, score: number, member: string, cb: ICallback<number | string>): void;
     multi(): NodeRedisV3ClientMulti;
     watch(args: string[], cb: ICallback<string>): void;
@@ -25,25 +25,25 @@ export declare class NodeRedisV3Client extends RedisClient {
     smembers(key: string, cb: ICallback<string[]>): void;
     sadd(key: string, member: string, cb: ICallback<number>): void;
     hgetall(key: string, cb: ICallback<Record<string, string>>): void;
-    hget(key: string, field: string, cb: ICallback<string>): void;
+    hget(key: string, field: string, cb: ICallback<string | null>): void;
     hset(key: string, field: string, value: string, cb: ICallback<number>): void;
     hdel(key: string, fields: string | string[], cb: ICallback<number>): void;
     lrange(key: string, start: number, stop: number, cb: ICallback<string[]>): void;
     hkeys(key: string, cb: ICallback<string[]>): void;
     hlen(key: string, cb: ICallback<number>): void;
-    brpoplpush(source: string, destination: string, timeout: number, cb: ICallback<string>): void;
-    rpoplpush(source: string, destination: string, cb: ICallback<string>): void;
+    brpoplpush(source: string, destination: string, timeout: number, cb: ICallback<string | null>): void;
+    rpoplpush(source: string, destination: string, cb: ICallback<string | null>): void;
     zrangebyscorewithscores(source: string, min: number, max: number, cb: ICallback<Record<string, string>>): void;
-    rpop(key: string, cb: ICallback<string>): void;
+    rpop(key: string, cb: ICallback<string | null>): void;
     lrem(key: string, count: number, element: string, cb: ICallback<number>): void;
     publish(channel: string, message: string, cb: ICallback<number>): void;
     flushall(cb: ICallback<string>): void;
     loadScript(script: string, cb: ICallback<string>): void;
     evalsha(hash: string, args: (string | number)[] | string | number, cb: (err?: Error | null, res?: unknown) => void): void;
-    get(key: string, cb: ICallback<string>): void;
+    get(key: string, cb: ICallback<string | null>): void;
     del(key: string | string[], cb: ICallback<number>): void;
     llen(key: string, cb: ICallback<number>): void;
-    lmove(source: string, destination: string, from: 'LEFT' | 'RIGHT', to: 'LEFT' | 'RIGHT', cb: ICallback<string>): void;
+    lmove(source: string, destination: string, from: 'LEFT' | 'RIGHT', to: 'LEFT' | 'RIGHT', cb: ICallback<string | null>): void;
     zremrangebyscore(source: string, min: number | string, max: number | string, cb: ICallback<number>): void;
     hmget(source: string, keys: string[], cb: ICallback<(string | null)[]>): void;
     halt(cb: ICallback<void>): void;

package/dist/src/redis-client/clients/node-redis-v3-client.js

@@ -110,7 +110,7 @@ class NodeRedisV3Client extends redis_client_1.RedisClient {
         this.client.hset(key, field, value, cb);
     }
     hdel(key, fields, cb) {
-        this.client.hdel(key, fields, cb);
+        this.client.hdel(key, ...(typeof fields === 'string' ? [fields] : fields), cb);
     }
     lrange(key, start, stop, cb) {
         this.client.lrange(key, start, stop, cb);
@@ -166,7 +166,7 @@ class NodeRedisV3Client extends redis_client_1.RedisClient {
         this.client.get(key, cb);
     }
     del(key, cb) {
-        this.client.del(key, cb);
+        this.client.del(...(typeof key === 'string' ? [key] : key), cb);
     }
     llen(key, cb) {
         this.client.llen(key, cb);

package/dist/src/redis-client/clients/node-redis-v4-client-multi.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NodeRedisV4ClientMulti = void 0;
+const client_1 = require("@redis/client");
+const watched_keys_changed_error_1 = require("../errors/watched-keys-changed.error");
 class NodeRedisV4ClientMulti {
     constructor(client) {
         this.multi = client.multi();
@@ -69,7 +71,12 @@ class NodeRedisV4ClientMulti {
         this.multi
             .exec()
             .then((reply) => cb(null, reply))
-            .catch(cb);
+            .catch((err) => {
+            if (err instanceof client_1.WatchError)
+                cb(new watched_keys_changed_error_1.WatchedKeysChangedError());
+            else
+                cb(err);
+        });
     }
 }
 exports.NodeRedisV4ClientMulti = NodeRedisV4ClientMulti;

package/dist/src/redis-client/clients/node-redis-v4-client.d.ts

@@ -11,7 +11,7 @@ export declare class NodeRedisV4Client extends RedisClient {
             value: number;
         };
         exists?: 'NX' | 'XX';
-    }, cb: ICallback<string>): void;
+    }, cb: ICallback<string | null>): void;
     zadd(key: string, score: number, member: string, cb: ICallback<number | string>): void;
     multi(): NodeRedisV4ClientMulti;
     watch(args: string[], cb: ICallback<string>): void;
@@ -25,25 +25,25 @@ export declare class NodeRedisV4Client extends RedisClient {
     smembers(key: string, cb: ICallback<string[]>): void;
     sadd(key: string, member: string, cb: ICallback<number>): void;
     hgetall(key: string, cb: ICallback<Record<string, string>>): void;
-    hget(key: string, field: string, cb: ICallback<string>): void;
+    hget(key: string, field: string, cb: ICallback<string | null>): void;
     hset(key: string, field: string, value: string, cb: ICallback<number>): void;
     hdel(key: string, fields: string | string[], cb: ICallback<number>): void;
     lrange(key: string, start: number, stop: number, cb: ICallback<string[]>): void;
     hkeys(key: string, cb: ICallback<string[]>): void;
     hlen(key: string, cb: ICallback<number>): void;
-    brpoplpush(source: string, destination: string, timeout: number, cb: ICallback<string>): void;
-    rpoplpush(source: string, destination: string, cb: ICallback<string>): void;
+    brpoplpush(source: string, destination: string, timeout: number, cb: ICallback<string | null>): void;
+    rpoplpush(source: string, destination: string, cb: ICallback<string | null>): void;
     zrangebyscorewithscores(source: string, min: number, max: number, cb: ICallback<Record<string, string>>): void;
-    rpop(key: string, cb: ICallback<string>): void;
+    rpop(key: string, cb: ICallback<string | null>): void;
     lrem(key: string, count: number, element: string, cb: ICallback<number>): void;
     publish(channel: string, message: string, cb: ICallback<number>): void;
     flushall(cb: ICallback<string>): void;
     loadScript(script: string, cb: ICallback<string>): void;
     evalsha(hash: string, args: (string | number)[] | string | number, cb: (err?: Error | null, res?: unknown) => void): void;
-    get(key: string, cb: ICallback<string>): void;
+    get(key: string, cb: ICallback<string | null>): void;
     del(key: string | string[], cb: ICallback<number>): void;
     llen(key: string, cb: ICallback<number>): void;
-    lmove(source: string, destination: string, from: 'LEFT' | 'RIGHT', to: 'LEFT' | 'RIGHT', cb: ICallback<string>): void;
+    lmove(source: string, destination: string, from: 'LEFT' | 'RIGHT', to: 'LEFT' | 'RIGHT', cb: ICallback<string | null>): void;
     zremrangebyscore(source: string, min: number | string, max: number | string, cb: ICallback<number>): void;
     hmget(source: string, keys: string[], cb: ICallback<(string | null)[]>): void;
     halt(cb: ICallback<void>): void;

package/dist/src/redis-client/clients/node-redis-v4-client.js

@@ -101,7 +101,7 @@ class NodeRedisV4Client extends redis_client_1.RedisClient {
     hget(key, field, cb) {
         this.client
             .hGet(key, field)
-            .then((reply) => cb(null, reply))
+            .then((reply) => cb(null, reply !== null && reply !== void 0 ? reply : null))
             .catch(cb);
     }
     hset(key, field, value, cb) {
@@ -215,8 +215,8 @@ class NodeRedisV4Client extends redis_client_1.RedisClient {
     }
     del(key, cb) {
         this.client
-            .sendCommand(['del', ...(Array.isArray(key) ? key : [key])])
-            .then((reply) => cb(null, Number(reply)))
+            .del(key)
+            .then((reply) => cb(null, reply))
             .catch(cb);
     }
     llen(key, cb) {

package/dist/src/redis-client/errors/watched-keys-changed.error.d.ts

@@ -0,0 +1,4 @@
+import { RedisClientError } from './redis-client.error';
+export declare class WatchedKeysChangedError extends RedisClientError {
+    constructor(msg?: string);
+}

package/dist/src/redis-client/errors/watched-keys-changed.error.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WatchedKeysChangedError = void 0;
+const redis_client_error_1 = require("./redis-client.error");
+class WatchedKeysChangedError extends redis_client_error_1.RedisClientError {
+    constructor(msg = 'One (or more) of the watched keys has been changed') {
+        super(msg);
+    }
+}
+exports.WatchedKeysChangedError = WatchedKeysChangedError;
+//# sourceMappingURL=watched-keys-changed.error.js.map

package/dist/src/redis-client/redis-client.d.ts

@@ -19,7 +19,7 @@ export declare abstract class RedisClient extends EventEmitter {
             value: number;
         };
         exists?: 'NX' | 'XX';
-    }, cb: ICallback<string>): void;
+    }, cb: ICallback<string | null>): void;
     abstract zadd(key: string, score: number, member: string, cb: ICallback<number | string>): void;
     abstract multi(): IRedisClientMulti;
     abstract watch(args: string[], cb: ICallback<string>): void;
@@ -33,28 +33,28 @@ export declare abstract class RedisClient extends EventEmitter {
     abstract smembers(key: string, cb: ICallback<string[]>): void;
     abstract sadd(key: string, member: string, cb: ICallback<number>): void;
     abstract hgetall(key: string, cb: ICallback<Record<string, string>>): void;
-    abstract hget(key: string, field: string, cb: ICallback<string>): void;
+    abstract hget(key: string, field: string, cb: ICallback<string | null>): void;
     abstract hset(key: string, field: string, value: string, cb: ICallback<number>): void;
     abstract hdel(key: string, fields: string | string[], cb: ICallback<number>): void;
     abstract lrange(key: string, start: number, stop: number, cb: ICallback<string[]>): void;
     abstract hkeys(key: string, cb: ICallback<string[]>): void;
     abstract hlen(key: string, cb: ICallback<number>): void;
-    abstract brpoplpush(source: string, destination: string, timeout: number, cb: ICallback<string>): void;
-    abstract rpoplpush(source: string, destination: string, cb: ICallback<string>): void;
+    abstract brpoplpush(source: string, destination: string, timeout: number, cb: ICallback<string | null>): void;
+    abstract rpoplpush(source: string, destination: string, cb: ICallback<string | null>): void;
     zpophgetrpush(source: string, sourceHash: string, destination: string, cb: ICallback<string>): void;
     lpoprpushextra(source: string, destination: string, listSize: number, expire: number, cb: ICallback<string>): void;
-    lpoprpush(source: string, destination: string, cb: ICallback<string>): void;
+    lpoprpush(source: string, destination: string, cb: ICallback<string | null>): void;
     abstract zrangebyscorewithscores(source: string, min: number, max: number, cb: ICallback<Record<string, string>>): void;
-    abstract rpop(key: string, cb: ICallback<string>): void;
+    abstract rpop(key: string, cb: ICallback<string | null>): void;
     abstract lrem(key: string, count: number, element: string, cb: ICallback<number>): void;
     abstract publish(channel: string, message: string, cb: ICallback<number>): void;
     abstract flushall(cb: ICallback<string>): void;
     abstract loadScript(script: string, cb: ICallback<string>): void;
     abstract evalsha(hash: string, args: (string | number)[] | string | number, cb: (err?: Error | null, res?: unknown) => void): void;
-    abstract get(key: string, cb: ICallback<string>): void;
+    abstract get(key: string, cb: ICallback<string | null>): void;
     abstract del(key: string | string[], cb: ICallback<number>): void;
     abstract llen(key: string, cb: ICallback<number>): void;
-    abstract lmove(source: string, destination: string, from: 'LEFT' | 'RIGHT', to: 'LEFT' | 'RIGHT', cb: ICallback<string>): void;
+    abstract lmove(source: string, destination: string, from: 'LEFT' | 'RIGHT', to: 'LEFT' | 'RIGHT', cb: ICallback<string | null>): void;
     abstract zremrangebyscore(source: string, min: number | string, max: number | string, cb: ICallback<number>): void;
     abstract hmget(source: string, keys: string[], cb: ICallback<(string | null)[]>): void;
     abstract halt(cb: ICallback<void>): void;

package/dist/types/index.d.ts

@@ -56,8 +56,7 @@ declare module 'ioredis' {
     }
 }
 export interface ICallback<T> {
-    (err?: Error | null, reply?: T | null): void;
-    (err: null | undefined, reply: T): void;
+    (err?: Error | null, reply?: T): void;
 }
 export declare type TFunction<TReturn = void, TArgs = any> = (...args: TArgs[]) => TReturn;
 export declare type TUnaryFunction<T, E = void> = (reply: T) => E;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "redis-smq-common",
-  "version": "1.0.0-rc.6",
+  "version": "1.0.0-rc.9",
   "description": "RedisSMQ shared components that may be used by integrated applications and extensions.",
   "author": "Weyoss <weyoss@protonmail.com>",
   "license": "MIT",