@upstash/redis 0.0.0-ci.b1e842dc-20220903 → 0.0.0-ci.b8efaf97-20230119

package/esm/platforms/node_with_fetch.js

@@ -1,7 +1,21 @@
 // deno-lint-ignore-file
 import * as core from "../pkg/redis.js";
 import { HttpClient, } from "../pkg/http.js";
+import { VERSION } from "../version.js";
 import "isomorphic-fetch";
+// @ts-ignore Deno can't compile
+// import https from "https";
+// @ts-ignore Deno can't compile
+// import http from "http";
+// import "isomorphic-fetch";
+/**
+ * Workaround for nodejs 14, where atob is not included in the standardlib
+ */
+if (typeof atob === "undefined") {
+    global.atob = function (b64) {
+        return Buffer.from(b64, "base64").toString("utf-8");
+    };
+}
 /**
  * Serverless redis client for upstash.
  */
@@ -21,11 +35,23 @@ export class Redis extends core.Redis {
             /\r|\n/.test(configOrRequester.token)) {
             console.warn("The redis token contains whitespace or newline, which can cause errors!");
         }
+        const telemetry = {};
+        if (!process.env.UPSTASH_DISABLE_TELEMETRY) {
+            telemetry.runtime = `node@${process.version}`;
+            telemetry.platform = process.env.VERCEL
+                ? "vercel"
+                : process.env.AWS_REGION
+                    ? "aws"
+                    : "unknown";
+            telemetry.sdk = `@upstash/redis@${VERSION}`;
+        }
         const client = new HttpClient({
             baseUrl: configOrRequester.url,
             retry: configOrRequester.retry,
             headers: { authorization: `Bearer ${configOrRequester.token}` },
-            // agent: configOrRequester.agent,
+            //  agent: configOrRequester.agent,
+            responseEncoding: configOrRequester.responseEncoding,
+            telemetry,
         });
         super(client, {
             automaticDeserialization: configOrRequester.automaticDeserialization,

package/esm/platforms/nodejs.js

@@ -1,6 +1,15 @@
 // deno-lint-ignore-file
 import * as core from "../pkg/redis.js";
 import { HttpClient, } from "../pkg/http.js";
+import { VERSION } from "../version.js";
+/**
+ * Workaround for nodejs 14, where atob is not included in the standardlib
+ */
+if (typeof atob === "undefined") {
+    global.atob = function (b64) {
+        return Buffer.from(b64, "base64").toString("utf-8");
+    };
+}
 /**
  * Serverless redis client for upstash.
  */
@@ -20,11 +29,23 @@ export class Redis extends core.Redis {
             /\r|\n/.test(configOrRequester.token)) {
             console.warn("The redis token contains whitespace or newline, which can cause errors!");
         }
+        const telemetry = {};
+        if (!process.env.UPSTASH_DISABLE_TELEMETRY) {
+            telemetry.runtime = `node@${process.version}`;
+            telemetry.platform = process.env.VERCEL
+                ? "vercel"
+                : process.env.AWS_REGION
+                    ? "aws"
+                    : "unknown";
+            telemetry.sdk = `@upstash/redis@${VERSION}`;
+        }
         const client = new HttpClient({
             baseUrl: configOrRequester.url,
             retry: configOrRequester.retry,
             headers: { authorization: `Bearer ${configOrRequester.token}` },
-            // agent: configOrRequester.agent,
+            agent: configOrRequester.agent,
+            responseEncoding: configOrRequester.responseEncoding,
+            telemetry,
         });
         super(client, {
             automaticDeserialization: configOrRequester.automaticDeserialization,

package/esm/version.js

@@ -0,0 +1 @@
+export const VERSION = "v0.0.0-ci.b8efaf97-20230119";

package/package.json

@@ -3,7 +3,7 @@
   "main": "./script/platforms/nodejs.js",
   "types": "./types/platforms/nodejs.d.ts",
   "name": "@upstash/redis",
-  "version": "v0.0.0-ci.b1e842dc-20220903",
+  "version": "v0.0.0-ci.b8efaf97-20230119",
   "description": "An HTTP/REST based Redis client built on top of Upstash REST API.",
   "repository": {
     "type": "git",

package/script/pkg/commands/getdel.js

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

package/script/pkg/commands/hgetall.js

@@ -2,10 +2,6 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HGetAllCommand = void 0;
 const command_js_1 = require("./command.js");
-/**
- * @param result De
- * @returns
- */
 function deserialize(result) {
     if (result.length === 0) {
         return null;

package/script/pkg/commands/hrandfield.js

@@ -0,0 +1,43 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.HRandFieldCommand = void 0;
+const command_js_1 = require("./command.js");
+function deserialize(result) {
+    if (result.length === 0) {
+        return null;
+    }
+    const obj = {};
+    while (result.length >= 2) {
+        const key = result.shift();
+        const value = result.shift();
+        try {
+            obj[key] = JSON.parse(value);
+        }
+        catch {
+            obj[key] = value;
+        }
+    }
+    return obj;
+}
+/**
+ * @see https://redis.io/commands/hrandfield
+ */
+class HRandFieldCommand extends command_js_1.Command {
+    constructor(cmd, opts) {
+        const command = ["hrandfield", cmd[0]];
+        if (typeof cmd[1] === "number") {
+            command.push(cmd[1]);
+        }
+        if (cmd[2]) {
+            command.push("WITHVALUES");
+        }
+        super(command, {
+            // @ts-ignore TODO:
+            deserialize: cmd[2]
+                ? (result) => deserialize(result)
+                : opts?.deserialize,
+            ...opts,
+        });
+    }
+}
+exports.HRandFieldCommand = HRandFieldCommand;

package/script/pkg/commands/lmove.js

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

package/script/pkg/commands/mod.js

@@ -33,11 +33,13 @@ __exportStar(require("./flushall.js"), exports);
 __exportStar(require("./flushdb.js"), exports);
 __exportStar(require("./get.js"), exports);
 __exportStar(require("./getbit.js"), exports);
+__exportStar(require("./getdel.js"), exports);
 __exportStar(require("./getrange.js"), exports);
 __exportStar(require("./getset.js"), exports);
 __exportStar(require("./hdel.js"), exports);
 __exportStar(require("./hexists.js"), exports);
 __exportStar(require("./hget.js"), exports);
+__exportStar(require("./smismember.js"), exports);
 __exportStar(require("./hgetall.js"), exports);
 __exportStar(require("./hincrby.js"), exports);
 __exportStar(require("./hincrbyfloat.js"), exports);
@@ -45,6 +47,7 @@ __exportStar(require("./hkeys.js"), exports);
 __exportStar(require("./hlen.js"), exports);
 __exportStar(require("./hmget.js"), exports);
 __exportStar(require("./hmset.js"), exports);
+__exportStar(require("./hrandfield.js"), exports);
 __exportStar(require("./hscan.js"), exports);
 __exportStar(require("./hset.js"), exports);
 __exportStar(require("./hsetnx.js"), exports);
@@ -57,6 +60,7 @@ __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);

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/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/zmscore.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ZMScoreCommand = void 0;
 const command_js_1 = require("./command.js");
 /**
- * @see https://redis.io/commands/zscore
+ * @see https://redis.io/commands/zmscore
  */
 class ZMScoreCommand extends command_js_1.Command {
     constructor(cmd, opts) {

package/script/pkg/http.js

@@ -28,9 +28,28 @@ class HttpClient {
             writable: true,
             value: void 0
         });
+        this.options = {
+            backend: config.options?.backend,
+            agent: config.agent,
+            responseEncoding: config.responseEncoding ?? "base64", // default to base64
+        };
         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 (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";
+        }
         if (typeof config?.retry === "boolean" && config?.retry === false) {
             this.retry = {
                 attempts: 1,
@@ -45,12 +64,30 @@ 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 = {
             method: "POST",
             headers: this.headers,
             body: JSON.stringify(req.body),
             keepalive: true,
+            agent: this.options?.agent,
             /**
              * Fastly specific
              */
@@ -75,7 +112,67 @@ class HttpClient {
         if (!res.ok) {
             throw new error_js_1.UpstashError(body.error);
         }
+        if (this.options?.responseEncoding === "base64") {
+            return Array.isArray(body) ? body.map(decode) : decode(body);
+        }
         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.result) {
+        case "undefined":
+            return raw;
+        case "number": {
+            result = raw.result;
+            break;
+        }
+        case "object": {
+            if (Array.isArray(raw.result)) {
+                result = raw.result.map((v) => typeof v === "string"
+                    ? base64decode(v)
+                    : Array.isArray(v)
+                        ? v.map(base64decode)
+                        : 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.result === "OK" ? "OK" : base64decode(raw.result);
+            break;
+        }
+        default:
+            break;
+    }
+    return { result, error: raw.error };
+}

package/script/pkg/pipeline.js

@@ -4,6 +4,8 @@ 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.
@@ -20,7 +22,7 @@ const zmscore_js_1 = require("./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()
@@ -43,7 +45,7 @@ const zmscore_js_1 = require("./commands/zmscore.js");
  * ```
  */
 class Pipeline {
-    constructor(client, commandOptions) {
+    constructor(opts) {
         Object.defineProperty(this, "client", {
             enumerable: true,
             configurable: true,
@@ -62,6 +64,12 @@ 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.
          *
@@ -80,8 +88,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) => {
@@ -128,6 +137,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
          */
@@ -254,6 +272,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
          */
@@ -362,6 +389,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
          */
@@ -470,6 +506,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
          */
@@ -839,6 +884,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
          */
@@ -1132,9 +1186,10 @@ class Pipeline {
             writable: true,
             value: (...args) => this.chain(new mod_js_1.ZUnionStoreCommand(args, this.commandOptions))
         });
-        this.client = client;
+        this.client = opts.client;
         this.commands = [];
-        this.commandOptions = commandOptions;
+        this.commandOptions = opts.commandOptions;
+        this.multiExec = opts.multiExec ?? false;
     }
     /**
      * Pushes a command into the pipelien and returns a chainable instance of the

package/script/pkg/redis.js

@@ -5,6 +5,7 @@ const mod_js_1 = require("./commands/mod.js");
 const pipeline_js_1 = require("./pipeline.js");
 const script_js_1 = require("./script.js");
 const zmscore_js_1 = require("./commands/zmscore.js");
+const zdiffstore_js_1 = require("./commands/zdiffstore.js");
 /**
  * Serverless redis client for upstash.
  */
@@ -45,6 +46,24 @@ class Redis {
                 this.client.request = (req) => middleware(req, makeRequest);
             }
         });
+        /**
+         * Technically this is not private, we can hide it from intellisense by doing this
+         */
+        Object.defineProperty(this, "addTelemetry", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (telemetry) => {
+                try {
+                    // @ts-ignore - The `Requester` interface does not know about this method but it will be there
+                    // as long as the user uses the standard HttpClient
+                    this.client.mergeTelemetry(telemetry);
+                }
+                catch {
+                    // ignore
+                }
+            }
+        });
         /**
          * Create a new pipeline that allows you to send requests in bulk.
          *
@@ -54,7 +73,30 @@ class Redis {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: () => new pipeline_js_1.Pipeline(this.client, this.opts)
+            value: () => new pipeline_js_1.Pipeline({
+                client: this.client,
+                commandOptions: this.opts,
+                multiExec: false,
+            })
+        });
+        /**
+         * Create a new transaction to allow executing multiple steps atomically.
+         *
+         * All the commands in a transaction are serialized and executed sequentially. A request sent by
+         * another client will never be served in the middle of the execution of a Redis Transaction. This
+         * guarantees that the commands are executed as a single isolated operation.
+         *
+         * @see {@link Pipeline}
+         */
+        Object.defineProperty(this, "multi", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: () => new pipeline_js_1.Pipeline({
+                client: this.client,
+                commandOptions: this.opts,
+                multiExec: true,
+            })
         });
         /**
          * @see https://redis.io/commands/append
@@ -218,6 +260,15 @@ class Redis {
             writable: true,
             value: (...args) => new mod_js_1.GetBitCommand(args, this.opts).exec(this.client)
         });
+        /**
+         * @see https://redis.io/commands/getdel
+         */
+        Object.defineProperty(this, "getdel", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => new mod_js_1.GetDelCommand(args, this.opts).exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/getrange
          */
@@ -326,6 +377,16 @@ class Redis {
             writable: true,
             value: (key, kv) => new mod_js_1.HMSetCommand([key, kv], this.opts).exec(this.client)
         });
+        /**
+         * @see https://redis.io/commands/hrandfield
+         */
+        Object.defineProperty(this, "hrandfield", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (key, count, withValues) => new mod_js_1.HRandFieldCommand([key, count, withValues], this.opts)
+                .exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/hscan
          */
@@ -434,6 +495,15 @@ class Redis {
             writable: true,
             value: (...args) => new mod_js_1.LLenCommand(args, this.opts).exec(this.client)
         });
+        /**
+         * @see https://redis.io/commands/lmove
+         */
+        Object.defineProperty(this, "lmove", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => new mod_js_1.LMoveCommand(args, this.opts).exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/lpop
          */
@@ -794,6 +864,15 @@ class Redis {
             writable: true,
             value: (key, member) => new mod_js_1.SIsMemberCommand([key, member], this.opts).exec(this.client)
         });
+        /**
+         * @see https://redis.io/commands/smismember
+         */
+        Object.defineProperty(this, "smismember", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (key, members) => new mod_js_1.SMIsMemberCommand([key, members], this.opts).exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/smembers
          */
@@ -952,6 +1031,15 @@ class Redis {
             writable: true,
             value: (...args) => new mod_js_1.ZCountCommand(args, this.opts).exec(this.client)
         });
+        /**
+         * @see https://redis.io/commands/zdiffstore
+         */
+        Object.defineProperty(this, "zdiffstore", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => new zdiffstore_js_1.ZDiffStoreCommand(args, this.opts).exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/zincrby
          */