@upstash/redis 0.0.0-ci.608697de-20221215 → 0.0.0-ci.64609219-20231017

package/README.md

@@ -27,7 +27,7 @@ supported.
 
 ### Install
 
-#### npm
+#### Node.js
 
 ```bash
 npm install @upstash/redis
@@ -81,6 +81,13 @@ data  = await redis.spop('animals', 1)
 console.log(data)
 ```
 
+## Troubleshooting
+
+We have a
+[dedicated page](https://docs.upstash.com/redis/sdks/javascriptsdk/troubleshooting)
+for common problems. If you can't find a solution, please
+[open an issue](https://github.com/upstash/upstash-redis/issues/new).
+
 ## Docs
 
 See [the documentation](https://docs.upstash.com/features/javascriptsdk) for

package/esm/pkg/commands/command.js

@@ -1,6 +1,15 @@
 import { UpstashError } from "../error.js";
 import { parseResponse } from "../util.js";
-const defaultSerializer = (c) => typeof c === "string" ? c : JSON.stringify(c);
+const defaultSerializer = (c) => {
+    switch (typeof c) {
+        case "string":
+        case "number":
+        case "boolean":
+            return c;
+        default:
+            return JSON.stringify(c);
+    }
+};
 /**
  * Command offers default (de)serialization and the exec method to all commands.
  *
@@ -37,7 +46,7 @@ export class Command {
             opts.automaticDeserialization
             ? opts?.deserialize ?? parseResponse
             : (x) => x;
-        this.command = command.map(this.serialize);
+        this.command = command.map((c) => this.serialize(c));
     }
     /**
      * Execute the command using a client.
@@ -50,7 +59,7 @@ export class Command {
             throw new UpstashError(error);
         }
         if (typeof result === "undefined") {
-            throw new Error(`Request did not return a result`);
+            throw new Error("Request did not return a result");
         }
         return this.deserialize(result);
     }

package/esm/pkg/commands/geo_add.js

@@ -0,0 +1,27 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/geoadd
+ */
+export class GeoAddCommand extends Command {
+    constructor([key, arg1, ...arg2], opts) {
+        const command = ["geoadd", key];
+        if ("nx" in arg1 && arg1.nx) {
+            command.push("nx");
+        }
+        else if ("xx" in arg1 && arg1.xx) {
+            command.push("xx");
+        }
+        if ("ch" in arg1 && arg1.ch) {
+            command.push("ch");
+        }
+        if ("latitude" in arg1 && arg1.latitude) {
+            command.push(arg1.longitude, arg1.latitude, arg1.member);
+        }
+        command.push(...arg2.flatMap(({ latitude, longitude, member }) => [
+            longitude,
+            latitude,
+            member,
+        ]));
+        super(command, opts);
+    }
+}

package/esm/pkg/commands/json_arrappend.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.arrappend
+ */
+export class JsonArrAppendCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.ARRAPPEND", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_arrindex.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.arrindex
+ */
+export class JsonArrIndexCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.ARRINDEX", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_arrinsert.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.arrinsert
+ */
+export class JsonArrInsertCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.ARRINSERT", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_arrlen.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.arrlen
+ */
+export class JsonArrLenCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.ARRLEN", cmd[0], cmd[1] ?? "$"], opts);
+    }
+}

package/esm/pkg/commands/json_arrpop.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.arrpop
+ */
+export class JsonArrPopCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.ARRPOP", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_arrtrim.js

@@ -0,0 +1,12 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.arrtrim
+ */
+export class JsonArrTrimCommand extends Command {
+    constructor(cmd, opts) {
+        const path = cmd[1] ?? "$";
+        const start = cmd[2] ?? 0;
+        const stop = cmd[3] ?? 0;
+        super(["JSON.ARRTRIM", cmd[0], path, start, stop], opts);
+    }
+}

package/esm/pkg/commands/json_clear.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.clear
+ */
+export class JsonClearCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.CLEAR", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_del.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.del
+ */
+export class JsonDelCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.DEL", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_forget.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.forget
+ */
+export class JsonForgetCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.FORGET", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_get.js

@@ -0,0 +1,30 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.get
+ */
+export class JsonGetCommand extends Command {
+    constructor(cmd, opts) {
+        const command = ["JSON.GET"];
+        if (typeof cmd[1] === "string") {
+            // @ts-ignore - we know this is a string
+            command.push(...cmd);
+        }
+        else {
+            command.push(cmd[0]);
+            if (cmd[1]) {
+                if (cmd[1].indent) {
+                    command.push("INDENT", cmd[1].indent);
+                }
+                if (cmd[1].newline) {
+                    command.push("NEWLINE", cmd[1].newline);
+                }
+                if (cmd[1].space) {
+                    command.push("SPACE", cmd[1].space);
+                }
+            }
+            // @ts-ignore - we know this is a string
+            command.push(...cmd.slice(2));
+        }
+        super(command, opts);
+    }
+}

package/esm/pkg/commands/json_mget.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.mget
+ */
+export class JsonMGetCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.MGET", ...cmd[0], cmd[1]], opts);
+    }
+}

package/esm/pkg/commands/json_numincrby.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.numincrby
+ */
+export class JsonNumIncrByCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.NUMINCRBY", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_nummultby.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.nummultby
+ */
+export class JsonNumMultByCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.NUMMULTBY", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_objkeys.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.objkeys
+ */
+export class JsonObjKeysCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.OBJKEYS", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_objlen.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.objlen
+ */
+export class JsonObjLenCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.OBJLEN", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_resp.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.resp
+ */
+export class JsonRespCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.RESP", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_set.js

@@ -0,0 +1,18 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.set
+ */
+export class JsonSetCommand extends Command {
+    constructor(cmd, opts) {
+        const command = ["JSON.SET", cmd[0], cmd[1], cmd[2]];
+        if (cmd[3]) {
+            if (cmd[3].nx) {
+                command.push("NX");
+            }
+            else if (cmd[3].xx) {
+                command.push("XX");
+            }
+        }
+        super(command, opts);
+    }
+}

package/esm/pkg/commands/json_strappend.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.strappend
+ */
+export class JsonStrAppendCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.STRAPPEND", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_strlen.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.strlen
+ */
+export class JsonStrLenCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.STRLEN", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_toggle.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.toggle
+ */
+export class JsonToggleCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.TOGGLE", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/json_type.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/json.type
+ */
+export class JsonTypeCommand extends Command {
+    constructor(cmd, opts) {
+        super(["JSON.TYPE", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/lmove.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/lmove
+ */
+export class LMoveCommand extends Command {
+    constructor(cmd, opts) {
+        super(["lmove", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/mod.js

@@ -15,6 +15,7 @@ export * from "./expire.js";
 export * from "./expireat.js";
 export * from "./flushall.js";
 export * from "./flushdb.js";
+export * from "./geo_add.js";
 export * from "./get.js";
 export * from "./getbit.js";
 export * from "./getdel.js";
@@ -39,10 +40,32 @@ export * from "./hvals.js";
 export * from "./incr.js";
 export * from "./incrby.js";
 export * from "./incrbyfloat.js";
+export * from "./json_arrappend.js";
+export * from "./json_arrindex.js";
+export * from "./json_arrinsert.js";
+export * from "./json_arrlen.js";
+export * from "./json_arrpop.js";
+export * from "./json_arrtrim.js";
+export * from "./json_clear.js";
+export * from "./json_del.js";
+export * from "./json_forget.js";
+export * from "./json_get.js";
+export * from "./json_mget.js";
+export * from "./json_numincrby.js";
+export * from "./json_nummultby.js";
+export * from "./json_objkeys.js";
+export * from "./json_objlen.js";
+export * from "./json_resp.js";
+export * from "./json_set.js";
+export * from "./json_strappend.js";
+export * from "./json_strlen.js";
+export * from "./json_toggle.js";
+export * from "./json_type.js";
 export * from "./keys.js";
 export * from "./lindex.js";
 export * from "./linsert.js";
 export * from "./llen.js";
+export * from "./lmove.js";
 export * from "./lpop.js";
 export * from "./lpos.js";
 export * from "./lpush.js";
@@ -84,6 +107,7 @@ export * from "./sinter.js";
 export * from "./sinterstore.js";
 export * from "./sismember.js";
 export * from "./smembers.js";
+export * from "./smismember.js";
 export * from "./smove.js";
 export * from "./spop.js";
 export * from "./srandmember.js";
@@ -114,4 +138,7 @@ export * from "./zremrangebyscore.js";
 export * from "./zrevrank.js";
 export * from "./zscan.js";
 export * from "./zscore.js";
+export * from "./zunion.js";
 export * from "./zunionstore.js";
+export * from "./xadd.js";
+export * from "./xrange.js";

package/esm/pkg/commands/set.js

@@ -28,7 +28,7 @@ export class SetCommand extends 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/esm/pkg/commands/smismember.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/smismember
+ */
+export class SMIsMemberCommand extends Command {
+    constructor(cmd, opts) {
+        super(["smismember", cmd[0], ...cmd[1]], opts);
+    }
+}

package/esm/pkg/commands/xadd.js

@@ -0,0 +1,26 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/xadd
+ */
+export class XAddCommand extends 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);
+    }
+}

package/esm/pkg/commands/xrange.js

@@ -0,0 +1,36 @@
+import { Command } from "./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;
+}
+export class XRangeCommand extends 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,
+        });
+    }
+}

package/esm/pkg/commands/zdiffstore.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/zdiffstore
+ */
+export class ZDiffStoreCommand extends Command {
+    constructor(cmd, opts) {
+        super(["zdiffstore", ...cmd], opts);
+    }
+}

package/esm/pkg/commands/zunion.js

@@ -0,0 +1,30 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/zunion
+ */
+export class ZUnionCommand extends 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);
+    }
+}

package/esm/pkg/http.js

@@ -28,22 +28,14 @@ export 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";
         }
@@ -61,8 +53,26 @@ export 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),
@@ -90,10 +100,17 @@ export class HttpClient {
         }
         const body = (await res.json());
         if (!res.ok) {
-            throw new UpstashError(body.error);
+            throw new 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;
     }
@@ -115,28 +132,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 {
@@ -147,11 +164,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;
 }