@upstash/redis 0.0.0-ci.bc3aba1f-20221124 → 0.0.0-ci.bf6288e9-20231018

package/script/pkg/commands/mod.js

@@ -31,6 +31,7 @@ __exportStar(require("./expire.js"), exports);
 __exportStar(require("./expireat.js"), exports);
 __exportStar(require("./flushall.js"), exports);
 __exportStar(require("./flushdb.js"), exports);
+__exportStar(require("./geo_add.js"), exports);
 __exportStar(require("./get.js"), exports);
 __exportStar(require("./getbit.js"), exports);
 __exportStar(require("./getdel.js"), exports);
@@ -55,10 +56,32 @@ __exportStar(require("./hvals.js"), exports);
 __exportStar(require("./incr.js"), exports);
 __exportStar(require("./incrby.js"), exports);
 __exportStar(require("./incrbyfloat.js"), exports);
+__exportStar(require("./json_arrappend.js"), exports);
+__exportStar(require("./json_arrindex.js"), exports);
+__exportStar(require("./json_arrinsert.js"), exports);
+__exportStar(require("./json_arrlen.js"), exports);
+__exportStar(require("./json_arrpop.js"), exports);
+__exportStar(require("./json_arrtrim.js"), exports);
+__exportStar(require("./json_clear.js"), exports);
+__exportStar(require("./json_del.js"), exports);
+__exportStar(require("./json_forget.js"), exports);
+__exportStar(require("./json_get.js"), exports);
+__exportStar(require("./json_mget.js"), exports);
+__exportStar(require("./json_numincrby.js"), exports);
+__exportStar(require("./json_nummultby.js"), exports);
+__exportStar(require("./json_objkeys.js"), exports);
+__exportStar(require("./json_objlen.js"), exports);
+__exportStar(require("./json_resp.js"), exports);
+__exportStar(require("./json_set.js"), exports);
+__exportStar(require("./json_strappend.js"), exports);
+__exportStar(require("./json_strlen.js"), exports);
+__exportStar(require("./json_toggle.js"), exports);
+__exportStar(require("./json_type.js"), exports);
 __exportStar(require("./keys.js"), exports);
 __exportStar(require("./lindex.js"), exports);
 __exportStar(require("./linsert.js"), exports);
 __exportStar(require("./llen.js"), exports);
+__exportStar(require("./lmove.js"), exports);
 __exportStar(require("./lpop.js"), exports);
 __exportStar(require("./lpos.js"), exports);
 __exportStar(require("./lpush.js"), exports);
@@ -100,6 +123,7 @@ __exportStar(require("./sinter.js"), exports);
 __exportStar(require("./sinterstore.js"), exports);
 __exportStar(require("./sismember.js"), exports);
 __exportStar(require("./smembers.js"), exports);
+__exportStar(require("./smismember.js"), exports);
 __exportStar(require("./smove.js"), exports);
 __exportStar(require("./spop.js"), exports);
 __exportStar(require("./srandmember.js"), exports);
@@ -130,4 +154,7 @@ __exportStar(require("./zremrangebyscore.js"), exports);
 __exportStar(require("./zrevrank.js"), exports);
 __exportStar(require("./zscan.js"), exports);
 __exportStar(require("./zscore.js"), exports);
+__exportStar(require("./zunion.js"), exports);
 __exportStar(require("./zunionstore.js"), exports);
+__exportStar(require("./xadd.js"), exports);
+__exportStar(require("./xrange.js"), exports);

package/script/pkg/commands/set.js

@@ -31,7 +31,7 @@ class SetCommand extends command_js_1.Command {
                 command.push("pxat", opts.pxat);
             }
             else if ("keepTtl" in opts && opts.keepTtl) {
-                command.push("keepTtl", opts.keepTtl);
+                command.push("keepTtl");
             }
         }
         super(command, cmdOpts);

package/script/pkg/commands/smismember.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SMIsMemberCommand = void 0;
+const command_js_1 = require("./command.js");
+/**
+ * @see https://redis.io/commands/smismember
+ */
+class SMIsMemberCommand extends command_js_1.Command {
+    constructor(cmd, opts) {
+        super(["smismember", cmd[0], ...cmd[1]], opts);
+    }
+}
+exports.SMIsMemberCommand = SMIsMemberCommand;

package/script/pkg/commands/xadd.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.XAddCommand = void 0;
+const command_js_1 = require("./command.js");
+/**
+ * @see https://redis.io/commands/xadd
+ */
+class XAddCommand extends command_js_1.Command {
+    constructor([key, id, entries, opts], commandOptions) {
+        const command = ["XADD", key];
+        if (opts) {
+            if (opts.nomkStream) {
+                command.push("NOMKSTREAM");
+            }
+            if (opts.trim) {
+                command.push(opts.trim.type, opts.trim.comparison, opts.trim.threshold);
+                if (typeof opts.trim.limit !== "undefined") {
+                    command.push("LIMIT", opts.trim.limit);
+                }
+            }
+        }
+        command.push(id);
+        // entries
+        Object.entries(entries).forEach(([k, v]) => {
+            command.push(k, v);
+        });
+        super(command, commandOptions);
+    }
+}
+exports.XAddCommand = XAddCommand;

package/script/pkg/commands/xrange.js

@@ -0,0 +1,40 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.XRangeCommand = void 0;
+const command_js_1 = require("./command.js");
+function deserialize(result) {
+    const obj = {};
+    for (const e of result) {
+        while (e.length >= 2) {
+            const streamId = e.shift();
+            const entries = e.shift();
+            if (!(streamId in obj)) {
+                obj[streamId] = {};
+            }
+            while (entries.length >= 2) {
+                const field = entries.shift();
+                const value = entries.shift();
+                try {
+                    obj[streamId][field] = JSON.parse(value);
+                }
+                catch {
+                    obj[streamId][field] = value;
+                }
+            }
+        }
+    }
+    return obj;
+}
+class XRangeCommand extends command_js_1.Command {
+    constructor([key, start, end, count], opts) {
+        const command = ["XRANGE", key, start, end];
+        if (typeof count === "number") {
+            command.push("COUNT", count);
+        }
+        super(command, {
+            deserialize: (result) => deserialize(result),
+            ...opts,
+        });
+    }
+}
+exports.XRangeCommand = XRangeCommand;

package/script/pkg/commands/zdiffstore.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZDiffStoreCommand = void 0;
+const command_js_1 = require("./command.js");
+/**
+ * @see https://redis.io/commands/zdiffstore
+ */
+class ZDiffStoreCommand extends command_js_1.Command {
+    constructor(cmd, opts) {
+        super(["zdiffstore", ...cmd], opts);
+    }
+}
+exports.ZDiffStoreCommand = ZDiffStoreCommand;

package/script/pkg/commands/zunion.js

@@ -0,0 +1,34 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ZUnionCommand = void 0;
+const command_js_1 = require("./command.js");
+/**
+ * @see https://redis.io/commands/zunion
+ */
+class ZUnionCommand extends command_js_1.Command {
+    constructor([numKeys, keyOrKeys, opts], cmdOpts) {
+        const command = ["zunion", numKeys];
+        if (Array.isArray(keyOrKeys)) {
+            command.push(...keyOrKeys);
+        }
+        else {
+            command.push(keyOrKeys);
+        }
+        if (opts) {
+            if ("weights" in opts && opts.weights) {
+                command.push("weights", ...opts.weights);
+            }
+            else if ("weight" in opts && typeof opts.weight === "number") {
+                command.push("weights", opts.weight);
+            }
+            if ("aggregate" in opts) {
+                command.push("aggregate", opts.aggregate);
+            }
+            if (opts?.withScores) {
+                command.push("withscores");
+            }
+        }
+        super(command, cmdOpts);
+    }
+}
+exports.ZUnionCommand = ZUnionCommand;

package/script/pkg/http.js

@@ -31,22 +31,14 @@ class HttpClient {
         this.options = {
             backend: config.options?.backend,
             agent: config.agent,
-            responseEncoding: config.responseEncoding ?? "base64", // default to base64
+            responseEncoding: config.responseEncoding ?? "base64",
+            cache: config.cache,
         };
         this.baseUrl = config.baseUrl.replace(/\/$/, "");
         this.headers = {
             "Content-Type": "application/json",
             ...config.headers,
         };
-        if (config.telemetry?.runtime) {
-            this.headers["Upstash-Telemetry-Runtime"] = config.telemetry.runtime;
-        }
-        if (config.telemetry?.platform) {
-            this.headers["Upstash-Telemetry-Platform"] = config.telemetry.platform;
-        }
-        if (config.telemetry?.sdk) {
-            this.headers["Upstash-Telemetry-Sdk"] = config.telemetry.sdk;
-        }
         if (this.options.responseEncoding === "base64") {
             this.headers["Upstash-Encoding"] = "base64";
         }
@@ -64,8 +56,26 @@ class HttpClient {
             };
         }
     }
+    mergeTelemetry(telemetry) {
+        function merge(obj, key, value) {
+            if (!value) {
+                return obj;
+            }
+            if (obj[key]) {
+                obj[key] = [obj[key], value].join(",");
+            }
+            else {
+                obj[key] = value;
+            }
+            return obj;
+        }
+        this.headers = merge(this.headers, "Upstash-Telemetry-Runtime", telemetry.runtime);
+        this.headers = merge(this.headers, "Upstash-Telemetry-Platform", telemetry.platform);
+        this.headers = merge(this.headers, "Upstash-Telemetry-Sdk", telemetry.sdk);
+    }
     async request(req) {
         const requestOptions = {
+            cache: this.options.cache,
             method: "POST",
             headers: this.headers,
             body: JSON.stringify(req.body),
@@ -93,10 +103,17 @@ class HttpClient {
         }
         const body = (await res.json());
         if (!res.ok) {
-            throw new error_js_1.UpstashError(body.error);
+            throw new error_js_1.UpstashError(`${body.error}, command was: ${JSON.stringify(req.body)}`);
         }
         if (this.options?.responseEncoding === "base64") {
-            return Array.isArray(body) ? body.map(decode) : decode(body);
+            if (Array.isArray(body)) {
+                return body.map(({ result, error }) => ({
+                    result: decode(result),
+                    error,
+                }));
+            }
+            const result = decode(body.result);
+            return { result, error: body.error };
         }
         return body;
     }
@@ -119,28 +136,28 @@ function base64decode(b64) {
     catch {
         dec = b64;
     }
-    try {
-        return decodeURIComponent(dec);
-    }
-    catch {
-        return dec;
-    }
+    return dec;
+    // try {
+    //   return decodeURIComponent(dec);
+    // } catch {
+    //   return dec;
+    // }
 }
 function decode(raw) {
     let result = undefined;
-    switch (typeof raw.result) {
+    switch (typeof raw) {
         case "undefined":
             return raw;
         case "number": {
-            result = raw.result;
+            result = raw;
             break;
         }
         case "object": {
-            if (Array.isArray(raw.result)) {
-                result = raw.result.map((v) => typeof v === "string"
+            if (Array.isArray(raw)) {
+                result = raw.map((v) => typeof v === "string"
                     ? base64decode(v)
                     : Array.isArray(v)
-                        ? v.map(base64decode)
+                        ? v.map(decode)
                         : v);
             }
             else {
@@ -151,11 +168,11 @@ function decode(raw) {
             break;
         }
         case "string": {
-            result = raw.result === "OK" ? "OK" : base64decode(raw.result);
+            result = raw === "OK" ? "OK" : base64decode(raw);
             break;
         }
         default:
             break;
     }
-    return { result, error: raw.error };
+    return result;
 }

package/script/pkg/pipeline.js

@@ -5,6 +5,7 @@ const mod_js_1 = require("./commands/mod.js");
 const error_js_1 = require("./error.js");
 const zmscore_js_1 = require("./commands/zmscore.js");
 const hrandfield_js_1 = require("./commands/hrandfield.js");
+const zdiffstore_js_1 = require("./commands/zdiffstore.js");
 /**
  * Upstash REST API supports command pipelining to send multiple commands in
  * batch, instead of sending each command one by one and waiting for a response.
@@ -33,7 +34,7 @@ const hrandfield_js_1 = require("./commands/hrandfield.js");
  * const res = await p.set("key","value").get("key").exec()
  * ```
  *
- * It's not possible to infer correct types with a dynamic pipeline, so you can
+ * Return types are inferred if all commands are chained, but you can still
  * override the response type manually:
  * ```ts
  *  redis.pipeline()
@@ -74,9 +75,11 @@ class Pipeline {
          *
          * Returns an array with the results of all pipelined commands.
          *
-         * You can define a return type manually to make working in typescript easier
+         * If all commands are statically chained from start to finish, types are inferred. You can still define a return type manually if necessary though:
          * ```ts
-         * redis.pipeline().get("key").exec<[{ greeting: string }]>()
+         * const p = redis.pipeline()
+         * p.get("key")
+         * const result = p.exec<[{ greeting: string }]>()
          * ```
          */
         Object.defineProperty(this, "exec", {
@@ -136,6 +139,15 @@ class Pipeline {
             writable: true,
             value: (...args) => this.chain(new mod_js_1.BitPosCommand(args, this.commandOptions))
         });
+        /**
+         * @see https://redis.io/commands/zdiffstore
+         */
+        Object.defineProperty(this, "zdiffstore", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => this.chain(new zdiffstore_js_1.ZDiffStoreCommand(args, this.commandOptions))
+        });
         /**
          * @see https://redis.io/commands/dbsize
          */
@@ -496,6 +508,15 @@ class Pipeline {
             writable: true,
             value: (...args) => this.chain(new mod_js_1.LLenCommand(args, this.commandOptions))
         });
+        /**
+         * @see https://redis.io/commands/lmove
+         */
+        Object.defineProperty(this, "lmove", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => this.chain(new mod_js_1.LMoveCommand(args, this.commandOptions))
+        });
         /**
          * @see https://redis.io/commands/lpop
          */
@@ -865,6 +886,15 @@ class Pipeline {
             writable: true,
             value: (...args) => this.chain(new mod_js_1.SMembersCommand(args, this.commandOptions))
         });
+        /**
+         * @see https://redis.io/commands/smismember
+         */
+        Object.defineProperty(this, "smismember", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (key, members) => this.chain(new mod_js_1.SMIsMemberCommand([key, members], this.commandOptions))
+        });
         /**
          * @see https://redis.io/commands/smove
          */
@@ -1158,18 +1188,124 @@ class Pipeline {
             writable: true,
             value: (...args) => this.chain(new mod_js_1.ZUnionStoreCommand(args, this.commandOptions))
         });
+        /**
+         * @see https://redis.io/commands/zunion
+         */
+        Object.defineProperty(this, "zunion", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => this.chain(new mod_js_1.ZUnionCommand(args, this.commandOptions))
+        });
         this.client = opts.client;
-        this.commands = [];
+        this.commands = []; // the TCommands generic in the class definition is only used for carrying through chained command types and should never be explicitly set when instantiating the class
         this.commandOptions = opts.commandOptions;
         this.multiExec = opts.multiExec ?? false;
     }
     /**
-     * Pushes a command into the pipelien and returns a chainable instance of the
+     * Returns the length of pipeline before the execution
+     */
+    length() {
+        return this.commands.length;
+    }
+    /**
+     * Pushes a command into the pipeline and returns a chainable instance of the
      * pipeline
      */
     chain(command) {
         this.commands.push(command);
-        return this;
+        return this; // TS thinks we're returning Pipeline<[]> here, because we're not creating a new instance of the class, hence the cast
+    }
+    /**
+     * @see https://redis.io/commands/?group=json
+     */
+    get json() {
+        return {
+            /**
+             * @see https://redis.io/commands/json.arrappend
+             */
+            arrappend: (...args) => this.chain(new mod_js_1.JsonArrAppendCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.arrindex
+             */
+            arrindex: (...args) => this.chain(new mod_js_1.JsonArrIndexCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.arrinsert
+             */
+            arrinsert: (...args) => this.chain(new mod_js_1.JsonArrInsertCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.arrlen
+             */
+            arrlen: (...args) => this.chain(new mod_js_1.JsonArrLenCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.arrpop
+             */
+            arrpop: (...args) => this.chain(new mod_js_1.JsonArrPopCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.arrtrim
+             */
+            arrtrim: (...args) => this.chain(new mod_js_1.JsonArrTrimCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.clear
+             */
+            clear: (...args) => this.chain(new mod_js_1.JsonClearCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.del
+             */
+            del: (...args) => this.chain(new mod_js_1.JsonDelCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.forget
+             */
+            forget: (...args) => this.chain(new mod_js_1.JsonForgetCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.get
+             */
+            get: (...args) => this.chain(new mod_js_1.JsonGetCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.mget
+             */
+            mget: (...args) => this.chain(new mod_js_1.JsonMGetCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.numincrby
+             */
+            numincrby: (...args) => this.chain(new mod_js_1.JsonNumIncrByCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.nummultby
+             */
+            nummultby: (...args) => this.chain(new mod_js_1.JsonNumMultByCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.objkeys
+             */
+            objkeys: (...args) => this.chain(new mod_js_1.JsonObjKeysCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.objlen
+             */
+            objlen: (...args) => this.chain(new mod_js_1.JsonObjLenCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.resp
+             */
+            resp: (...args) => this.chain(new mod_js_1.JsonRespCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.set
+             */
+            set: (...args) => this.chain(new mod_js_1.JsonSetCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.strappend
+             */
+            strappend: (...args) => this.chain(new mod_js_1.JsonStrAppendCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.strlen
+             */
+            strlen: (...args) => this.chain(new mod_js_1.JsonStrLenCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.toggle
+             */
+            toggle: (...args) => this.chain(new mod_js_1.JsonToggleCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.type
+             */
+            type: (...args) => this.chain(new mod_js_1.JsonTypeCommand(args, this.commandOptions)),
+        };
     }
 }
 exports.Pipeline = Pipeline;