@upstash/redis 0.0.0-ci.e3757170 → 0.0.0-ci.e4fa3be6-20231018

package/script/pkg/http.js

@@ -28,9 +28,20 @@ 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", ...config.headers };
-        this.options = { backend: config.options?.backend };
+        this.headers = {
+            "Content-Type": "application/json",
+            ...config.headers,
+        };
+        if (this.options.responseEncoding === "base64") {
+            this.headers["Upstash-Encoding"] = "base64";
+        }
         if (typeof config?.retry === "boolean" && config?.retry === false) {
             this.retry = {
                 attempts: 1,
@@ -45,12 +56,31 @@ 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
              */
@@ -73,9 +103,76 @@ 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") {
+            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;
     }
 }
 exports.HttpClient = HttpClient;
+function base64decode(b64) {
+    let dec = "";
+    try {
+        /**
+         * 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 {
+        dec = b64;
+    }
+    return dec;
+    // try {
+    //   return decodeURIComponent(dec);
+    // } catch {
+    //   return dec;
+    // }
+}
+function decode(raw) {
+    let result = undefined;
+    switch (typeof raw) {
+        case "undefined":
+            return raw;
+        case "number": {
+            result = raw;
+            break;
+        }
+        case "object": {
+            if (Array.isArray(raw)) {
+                result = raw.map((v) => typeof v === "string"
+                    ? base64decode(v)
+                    : Array.isArray(v)
+                        ? v.map(decode)
+                        : v);
+            }
+            else {
+                // If it's not an array it must be null
+                // Apparently null is an object in javascript
+                result = null;
+            }
+            break;
+        }
+        case "string": {
+            result = raw === "OK" ? "OK" : base64decode(raw);
+            break;
+        }
+        default:
+            break;
+    }
+    return result;
+}

package/script/pkg/pipeline.js

@@ -3,6 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Pipeline = void 0;
 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.
@@ -19,7 +22,7 @@ const error_js_1 = require("./error.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()
@@ -31,7 +34,7 @@ const error_js_1 = require("./error.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()
@@ -42,7 +45,7 @@ const error_js_1 = require("./error.js");
  * ```
  */
 class Pipeline {
-    constructor(client, commandOptions) {
+    constructor(opts) {
         Object.defineProperty(this, "client", {
             enumerable: true,
             configurable: true,
@@ -61,14 +64,22 @@ 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", {
@@ -79,8 +90,9 @@ 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) => {
@@ -127,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
          */
@@ -253,6 +274,15 @@ class Pipeline {
             writable: true,
             value: (...args) => this.chain(new mod_js_1.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 mod_js_1.GetDelCommand(args, this.commandOptions))
+        });
         /**
          * @see https://redis.io/commands/getrange
          */
@@ -361,6 +391,15 @@ class Pipeline {
             writable: true,
             value: (key, kv) => this.chain(new mod_js_1.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 hrandfield_js_1.HRandFieldCommand([key, count, withValues], this.commandOptions))
+        });
         /**
          * @see https://redis.io/commands/hscan
          */
@@ -469,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
          */
@@ -478,6 +526,15 @@ class Pipeline {
             writable: true,
             value: (...args) => this.chain(new mod_js_1.LPopCommand(args, this.commandOptions))
         });
+        /**
+         * @see https://redis.io/commands/lpos
+         */
+        Object.defineProperty(this, "lpos", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => this.chain(new mod_js_1.LPosCommand(args, this.commandOptions))
+        });
         /**
          * @see https://redis.io/commands/lpush
          */
@@ -829,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
          */
@@ -1005,6 +1071,15 @@ class Pipeline {
             writable: true,
             value: (...args) => this.chain(new mod_js_1.ZLexCountCommand(args, this.commandOptions))
         });
+        /**
+         * @see https://redis.io/commands/zmscore
+         */
+        Object.defineProperty(this, "zmscore", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => this.chain(new zmscore_js_1.ZMScoreCommand(args, this.commandOptions))
+        });
         /**
          * @see https://redis.io/commands/zpopmax
          */
@@ -1113,17 +1188,124 @@ class Pipeline {
             writable: true,
             value: (...args) => this.chain(new mod_js_1.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 mod_js_1.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;
+    }
+    /**
+     * Returns the length of pipeline before the execution
+     */
+    length() {
+        return this.commands.length;
     }
     /**
-     * Pushes a command into the pipelien and returns a chainable instance of the
+     * 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;