@upstash/redis 0.0.0-ci.e256825f-20221010 → 0.0.0-ci.e4fa3be6-20231018

package/esm/pkg/http.js

@@ -25,13 +25,20 @@ export class HttpClient {
             writable: true,
             value: void 0
         });
+        this.options = {
+            backend: config.options?.backend,
+            agent: config.agent,
+            responseEncoding: config.responseEncoding ?? "base64",
+            cache: config.cache,
+        };
         this.baseUrl = config.baseUrl.replace(/\/$/, "");
         this.headers = {
             "Content-Type": "application/json",
-            "Upstash-Encoding": "base64",
             ...config.headers,
         };
-        this.options = { backend: config.options?.backend };
+        if (this.options.responseEncoding === "base64") {
+            this.headers["Upstash-Encoding"] = "base64";
+        }
         if (typeof config?.retry === "boolean" && config?.retry === false) {
             this.retry = {
                 attempts: 1,
@@ -46,12 +53,31 @@ 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),
             keepalive: true,
+            agent: this.options?.agent,
             /**
              * Fastly specific
              */
@@ -74,42 +100,60 @@ 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)}`);
         }
-        return Array.isArray(body) ? body.map(decode) : decode(body);
+        if (this.options?.responseEncoding === "base64") {
+            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;
     }
 }
 function base64decode(b64) {
     let dec = "";
     try {
-        dec = atob(b64).split("").map((c) => "%" + ("00" + c.charCodeAt(0).toString(16)).slice(-2)).join("");
-    }
-    catch (e) {
-        console.warn(`Unable to decode base64 [${dec}]: ${e.message}`);
-        return dec;
-    }
-    try {
-        return decodeURIComponent(dec);
+        /**
+         * Using only atob() is not enough because it doesn't work with unicode characters
+         */
+        const binString = atob(b64);
+        const size = binString.length;
+        const bytes = new Uint8Array(size);
+        for (let i = 0; i < size; i++) {
+            bytes[i] = binString.charCodeAt(i);
+        }
+        dec = new TextDecoder().decode(bytes);
     }
-    catch (e) {
-        console.warn(`Unable to decode URI [${dec}]: ${e.message}`);
-        return dec;
+    catch {
+        dec = b64;
     }
+    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;
+        case "number": {
+            result = raw;
             break;
-        case "object":
-            if (Array.isArray(raw.result)) {
-                result = raw.result.map((v) => typeof v === "string"
+        }
+        case "object": {
+            if (Array.isArray(raw)) {
+                result = raw.map((v) => typeof v === "string"
                     ? base64decode(v)
                     : Array.isArray(v)
-                        ? v.map(base64decode)
+                        ? v.map(decode)
                         : v);
             }
             else {
@@ -118,11 +162,13 @@ function decode(raw) {
                 result = null;
             }
             break;
-        case "string":
-            result = raw.result === "OK" ? "OK" : base64decode(raw.result);
+        }
+        case "string": {
+            result = raw === "OK" ? "OK" : base64decode(raw);
             break;
+        }
         default:
             break;
     }
-    return { result, error: raw.error };
+    return result;
 }

package/esm/pkg/pipeline.js

@@ -1,6 +1,8 @@
-import { AppendCommand, BitCountCommand, BitOpCommand, BitPosCommand, DBSizeCommand, DecrByCommand, DecrCommand, DelCommand, EchoCommand, EvalCommand, EvalshaCommand, ExistsCommand, ExpireAtCommand, ExpireCommand, FlushAllCommand, FlushDBCommand, GetBitCommand, GetCommand, GetRangeCommand, GetSetCommand, HDelCommand, HExistsCommand, HGetAllCommand, HGetCommand, HIncrByCommand, HIncrByFloatCommand, HKeysCommand, HLenCommand, HMGetCommand, HMSetCommand, HScanCommand, HSetCommand, HSetNXCommand, HStrLenCommand, HValsCommand, IncrByCommand, IncrByFloatCommand, IncrCommand, KeysCommand, LIndexCommand, LInsertCommand, LLenCommand, LPopCommand, LPosCommand, LPushCommand, LPushXCommand, LRangeCommand, LRemCommand, LSetCommand, LTrimCommand, MGetCommand, MSetCommand, MSetNXCommand, PersistCommand, PExpireAtCommand, PExpireCommand, PingCommand, PSetEXCommand, PTtlCommand, PublishCommand, RandomKeyCommand, RenameCommand, RenameNXCommand, RPopCommand, RPushCommand, RPushXCommand, SAddCommand, ScanCommand, SCardCommand, ScriptExistsCommand, ScriptFlushCommand, ScriptLoadCommand, SDiffCommand, SDiffStoreCommand, SetBitCommand, SetCommand, SetExCommand, SetNxCommand, SetRangeCommand, SInterCommand, SInterStoreCommand, SIsMemberCommand, SMembersCommand, SMoveCommand, SPopCommand, SRandMemberCommand, SRemCommand, SScanCommand, StrLenCommand, SUnionCommand, SUnionStoreCommand, TimeCommand, TouchCommand, TtlCommand, TypeCommand, UnlinkCommand, ZAddCommand, ZCardCommand, ZCountCommand, ZIncrByCommand, ZInterStoreCommand, ZLexCountCommand, ZPopMaxCommand, ZPopMinCommand, ZRangeCommand, ZRankCommand, ZRemCommand, ZRemRangeByLexCommand, ZRemRangeByRankCommand, ZRemRangeByScoreCommand, ZRevRankCommand, ZScanCommand, ZScoreCommand, ZUnionStoreCommand, } from "./commands/mod.js";
+import { AppendCommand, BitCountCommand, BitOpCommand, BitPosCommand, DBSizeCommand, DecrByCommand, DecrCommand, DelCommand, EchoCommand, EvalCommand, EvalshaCommand, ExistsCommand, ExpireAtCommand, ExpireCommand, FlushAllCommand, FlushDBCommand, GetBitCommand, GetCommand, GetDelCommand, GetRangeCommand, GetSetCommand, HDelCommand, HExistsCommand, HGetAllCommand, HGetCommand, HIncrByCommand, HIncrByFloatCommand, HKeysCommand, HLenCommand, HMGetCommand, HMSetCommand, HScanCommand, HSetCommand, HSetNXCommand, HStrLenCommand, HValsCommand, IncrByCommand, IncrByFloatCommand, IncrCommand, JsonArrAppendCommand, JsonArrIndexCommand, JsonArrInsertCommand, JsonArrLenCommand, JsonArrPopCommand, JsonArrTrimCommand, JsonClearCommand, JsonDelCommand, JsonForgetCommand, JsonGetCommand, JsonMGetCommand, JsonNumIncrByCommand, JsonNumMultByCommand, JsonObjKeysCommand, JsonObjLenCommand, JsonRespCommand, JsonSetCommand, JsonStrAppendCommand, JsonStrLenCommand, JsonToggleCommand, JsonTypeCommand, KeysCommand, LIndexCommand, LInsertCommand, LLenCommand, LMoveCommand, LPopCommand, LPosCommand, LPushCommand, LPushXCommand, LRangeCommand, LRemCommand, LSetCommand, LTrimCommand, MGetCommand, MSetCommand, MSetNXCommand, PersistCommand, PExpireAtCommand, PExpireCommand, PingCommand, PSetEXCommand, PTtlCommand, PublishCommand, RandomKeyCommand, RenameCommand, RenameNXCommand, RPopCommand, RPushCommand, RPushXCommand, SAddCommand, ScanCommand, SCardCommand, ScriptExistsCommand, ScriptFlushCommand, ScriptLoadCommand, SDiffCommand, SDiffStoreCommand, SetBitCommand, SetCommand, SetExCommand, SetNxCommand, SetRangeCommand, SInterCommand, SInterStoreCommand, SIsMemberCommand, SMembersCommand, SMIsMemberCommand, SMoveCommand, SPopCommand, SRandMemberCommand, SRemCommand, SScanCommand, StrLenCommand, SUnionCommand, SUnionStoreCommand, TimeCommand, TouchCommand, TtlCommand, TypeCommand, UnlinkCommand, ZAddCommand, ZCardCommand, ZCountCommand, ZIncrByCommand, ZInterStoreCommand, ZLexCountCommand, ZPopMaxCommand, ZPopMinCommand, ZRangeCommand, ZRankCommand, ZRemCommand, ZRemRangeByLexCommand, ZRemRangeByRankCommand, ZRemRangeByScoreCommand, ZRevRankCommand, ZScanCommand, ZScoreCommand, ZUnionCommand, ZUnionStoreCommand, } from "./commands/mod.js";
 import { UpstashError } from "./error.js";
 import { ZMScoreCommand } from "./commands/zmscore.js";
+import { HRandFieldCommand } from "./commands/hrandfield.js";
+import { ZDiffStoreCommand } from "./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.
@@ -17,7 +19,7 @@ import { ZMScoreCommand } from "./commands/zmscore.js";
  * **Examples:**
  *
  * ```ts
- *  const p = redis.pipeline()
+ *  const p = redis.pipeline() // or redis.multi()
  * p.set("key","value")
  * p.get("key")
  * const res = await p.exec()
@@ -29,7 +31,7 @@ import { ZMScoreCommand } from "./commands/zmscore.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()
@@ -40,7 +42,7 @@ import { ZMScoreCommand } from "./commands/zmscore.js";
  * ```
  */
 export class Pipeline {
-    constructor(client, commandOptions) {
+    constructor(opts) {
         Object.defineProperty(this, "client", {
             enumerable: true,
             configurable: true,
@@ -59,14 +61,22 @@ export class Pipeline {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "multiExec", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
         /**
          * Send the pipeline request to upstash.
          *
          * 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", {
@@ -77,8 +87,9 @@ export class Pipeline {
                 if (this.commands.length === 0) {
                     throw new Error("Pipeline is empty");
                 }
+                const path = this.multiExec ? ["multi-exec"] : ["pipeline"];
                 const res = (await this.client.request({
-                    path: ["pipeline"],
+                    path,
                     body: Object.values(this.commands).map((c) => c.command),
                 }));
                 return res.map(({ error, result }, i) => {
@@ -125,6 +136,15 @@ export class Pipeline {
             writable: true,
             value: (...args) => this.chain(new 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 ZDiffStoreCommand(args, this.commandOptions))
+        });
         /**
          * @see https://redis.io/commands/dbsize
          */
@@ -251,6 +271,15 @@ export class Pipeline {
             writable: true,
             value: (...args) => this.chain(new GetBitCommand(args, this.commandOptions))
         });
+        /**
+         * @see https://redis.io/commands/getdel
+         */
+        Object.defineProperty(this, "getdel", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => this.chain(new GetDelCommand(args, this.commandOptions))
+        });
         /**
          * @see https://redis.io/commands/getrange
          */
@@ -359,6 +388,15 @@ export class Pipeline {
             writable: true,
             value: (key, kv) => this.chain(new HMSetCommand([key, kv], this.commandOptions))
         });
+        /**
+         * @see https://redis.io/commands/hrandfield
+         */
+        Object.defineProperty(this, "hrandfield", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (key, count, withValues) => this.chain(new HRandFieldCommand([key, count, withValues], this.commandOptions))
+        });
         /**
          * @see https://redis.io/commands/hscan
          */
@@ -467,6 +505,15 @@ export class Pipeline {
             writable: true,
             value: (...args) => this.chain(new 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 LMoveCommand(args, this.commandOptions))
+        });
         /**
          * @see https://redis.io/commands/lpop
          */
@@ -836,6 +883,15 @@ export class Pipeline {
             writable: true,
             value: (...args) => this.chain(new 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 SMIsMemberCommand([key, members], this.commandOptions))
+        });
         /**
          * @see https://redis.io/commands/smove
          */
@@ -1129,16 +1185,123 @@ export class Pipeline {
             writable: true,
             value: (...args) => this.chain(new ZUnionStoreCommand(args, this.commandOptions))
         });
-        this.client = client;
-        this.commands = [];
-        this.commandOptions = commandOptions;
+        /**
+         * @see https://redis.io/commands/zunion
+         */
+        Object.defineProperty(this, "zunion", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => this.chain(new ZUnionCommand(args, this.commandOptions))
+        });
+        this.client = opts.client;
+        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 JsonArrAppendCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.arrindex
+             */
+            arrindex: (...args) => this.chain(new JsonArrIndexCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.arrinsert
+             */
+            arrinsert: (...args) => this.chain(new JsonArrInsertCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.arrlen
+             */
+            arrlen: (...args) => this.chain(new JsonArrLenCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.arrpop
+             */
+            arrpop: (...args) => this.chain(new JsonArrPopCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.arrtrim
+             */
+            arrtrim: (...args) => this.chain(new JsonArrTrimCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.clear
+             */
+            clear: (...args) => this.chain(new JsonClearCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.del
+             */
+            del: (...args) => this.chain(new JsonDelCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.forget
+             */
+            forget: (...args) => this.chain(new JsonForgetCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.get
+             */
+            get: (...args) => this.chain(new JsonGetCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.mget
+             */
+            mget: (...args) => this.chain(new JsonMGetCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.numincrby
+             */
+            numincrby: (...args) => this.chain(new JsonNumIncrByCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.nummultby
+             */
+            nummultby: (...args) => this.chain(new JsonNumMultByCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.objkeys
+             */
+            objkeys: (...args) => this.chain(new JsonObjKeysCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.objlen
+             */
+            objlen: (...args) => this.chain(new JsonObjLenCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.resp
+             */
+            resp: (...args) => this.chain(new JsonRespCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.set
+             */
+            set: (...args) => this.chain(new JsonSetCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.strappend
+             */
+            strappend: (...args) => this.chain(new JsonStrAppendCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.strlen
+             */
+            strlen: (...args) => this.chain(new JsonStrLenCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.toggle
+             */
+            toggle: (...args) => this.chain(new JsonToggleCommand(args, this.commandOptions)),
+            /**
+             * @see https://redis.io/commands/json.type
+             */
+            type: (...args) => this.chain(new JsonTypeCommand(args, this.commandOptions)),
+        };
     }
 }