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

package/script/pkg/redis.js

@@ -3,6 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Redis = void 0;
 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.
  */
@@ -31,6 +34,45 @@ class Redis {
             writable: true,
             value: void 0
         });
+        Object.defineProperty(this, "enableTelemetry", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * Wrap a new middleware around the HTTP client.
+         */
+        Object.defineProperty(this, "use", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (middleware) => {
+                const makeRequest = this.client.request.bind(this.client);
+                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) => {
+                if (!this.enableTelemetry) {
+                    return;
+                }
+                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.
          *
@@ -40,7 +82,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
@@ -204,6 +269,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
          */
@@ -312,6 +386,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
          */
@@ -420,6 +504,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
          */
@@ -429,6 +522,15 @@ class Redis {
             writable: true,
             value: (...args) => new mod_js_1.LPopCommand(args, this.opts).exec(this.client)
         });
+        /**
+         * @see https://redis.io/commands/lpos
+         */
+        Object.defineProperty(this, "lpos", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => new mod_js_1.LPosCommand(args, this.opts).exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/lpush
          */
@@ -490,7 +592,12 @@ class Redis {
             enumerable: true,
             configurable: true,
             writable: true,
-            value: (...args) => new mod_js_1.MGetCommand(args, this.opts).exec(this.client)
+            value: (...args) => {
+                const queries = Array.isArray(args[0])
+                    ? args[0]
+                    : args;
+                return new mod_js_1.MGetCommand(queries, this.opts).exec(this.client);
+            }
         });
         /**
          * @see https://redis.io/commands/mset
@@ -771,6 +878,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
          */
@@ -897,6 +1013,24 @@ class Redis {
             writable: true,
             value: (...args) => new mod_js_1.UnlinkCommand(args, this.opts).exec(this.client)
         });
+        /**
+         * @see https://redis.io/commands/xadd
+         */
+        Object.defineProperty(this, "xadd", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => new mod_js_1.XAddCommand(args, this.opts).exec(this.client)
+        });
+        /**
+         * @see https://redis.io/commands/xrange
+         */
+        Object.defineProperty(this, "xrange", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => new mod_js_1.XRangeCommand(args, this.opts).exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/zadd
          */
@@ -929,6 +1063,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
          */
@@ -956,6 +1099,15 @@ class Redis {
             writable: true,
             value: (...args) => new mod_js_1.ZLexCountCommand(args, this.opts).exec(this.client)
         });
+        /**
+         * @see https://redis.io/commands/zmscore
+         */
+        Object.defineProperty(this, "zmscore", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => new zmscore_js_1.ZMScoreCommand(args, this.opts).exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/zpopmax
          */
@@ -1055,6 +1207,15 @@ class Redis {
             writable: true,
             value: (key, member) => new mod_js_1.ZScoreCommand([key, member], this.opts).exec(this.client)
         });
+        /**
+         * @see https://redis.io/commands/zunion
+         */
+        Object.defineProperty(this, "zunion", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: (...args) => new mod_js_1.ZUnionCommand(args, this.opts).exec(this.client)
+        });
         /**
          * @see https://redis.io/commands/zunionstore
          */
@@ -1066,6 +1227,102 @@ class Redis {
         });
         this.client = client;
         this.opts = opts;
+        this.enableTelemetry = opts?.enableTelemetry ?? true;
+    }
+    get json() {
+        return {
+            /**
+             * @see https://redis.io/commands/json.arrappend
+             */
+            arrappend: (...args) => new mod_js_1.JsonArrAppendCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.arrindex
+             */
+            arrindex: (...args) => new mod_js_1.JsonArrIndexCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.arrinsert
+             */
+            arrinsert: (...args) => new mod_js_1.JsonArrInsertCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.arrlen
+             */
+            arrlen: (...args) => new mod_js_1.JsonArrLenCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.arrpop
+             */
+            arrpop: (...args) => new mod_js_1.JsonArrPopCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.arrtrim
+             */
+            arrtrim: (...args) => new mod_js_1.JsonArrTrimCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.clear
+             */
+            clear: (...args) => new mod_js_1.JsonClearCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.del
+             */
+            del: (...args) => new mod_js_1.JsonDelCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.forget
+             */
+            forget: (...args) => new mod_js_1.JsonForgetCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/geoadd
+             */
+            geoadd: (...args) => new mod_js_1.GeoAddCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.get
+             */
+            get: (...args) => new mod_js_1.JsonGetCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.mget
+             */
+            mget: (...args) => new mod_js_1.JsonMGetCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.numincrby
+             */
+            numincrby: (...args) => new mod_js_1.JsonNumIncrByCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.nummultby
+             */
+            nummultby: (...args) => new mod_js_1.JsonNumMultByCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.objkeys
+             */
+            objkeys: (...args) => new mod_js_1.JsonObjKeysCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.objlen
+             */
+            objlen: (...args) => new mod_js_1.JsonObjLenCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.resp
+             */
+            resp: (...args) => new mod_js_1.JsonRespCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.set
+             */
+            set: (...args) => new mod_js_1.JsonSetCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.strappend
+             */
+            strappend: (...args) => new mod_js_1.JsonStrAppendCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.strlen
+             */
+            strlen: (...args) => new mod_js_1.JsonStrLenCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.toggle
+             */
+            toggle: (...args) => new mod_js_1.JsonToggleCommand(args, this.opts).exec(this.client),
+            /**
+             * @see https://redis.io/commands/json.type
+             */
+            type: (...args) => new mod_js_1.JsonTypeCommand(args, this.opts).exec(this.client),
+        };
+    }
+    createScript(script) {
+        return new script_js_1.Script(this, script);
     }
 }
 exports.Redis = Redis;

package/script/pkg/script.js

@@ -0,0 +1,81 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Script = void 0;
+const mod_js_1 = require("../deps/deno.land/x/sha1@v1.0.3/mod.js");
+/**
+ * Creates a new script.
+ *
+ * Scripts offer the ability to optimistically try to execute a script without having to send the
+ * entire script to the server. If the script is loaded on the server, it tries again by sending
+ * the entire script. Afterwards, the script is cached on the server.
+ *
+ * @example
+ * ```ts
+ * const redis = new Redis({...})
+ *
+ * const script = redis.createScript<string>("return ARGV[1];")
+ * const arg1 = await script.eval([], ["Hello World"])
+ * assertEquals(arg1, "Hello World")
+ * ```
+ */
+class Script {
+    constructor(redis, script) {
+        Object.defineProperty(this, "script", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "sha1", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "redis", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.redis = redis;
+        this.sha1 = this.digest(script);
+        this.script = script;
+    }
+    /**
+     * Send an `EVAL` command to redis.
+     */
+    async eval(keys, args) {
+        return await this.redis.eval(this.script, keys, args);
+    }
+    /**
+     * Calculates the sha1 hash of the script and then calls `EVALSHA`.
+     */
+    async evalsha(keys, args) {
+        return await this.redis.evalsha(this.sha1, keys, args);
+    }
+    /**
+     * Optimistically try to run `EVALSHA` first.
+     * If the script is not loaded in redis, it will fall back and try again with `EVAL`.
+     *
+     * Following calls will be able to use the cached script
+     */
+    async exec(keys, args) {
+        const res = await this.redis.evalsha(this.sha1, keys, args).catch(async (err) => {
+            if (err instanceof Error &&
+                err.message.toLowerCase().includes("noscript")) {
+                return await this.redis.eval(this.script, keys, args);
+            }
+            throw err;
+        });
+        return res;
+    }
+    /**
+     * Compute the sha1 hash of the script and return its hex representation.
+     */
+    digest(s) {
+        const hash = (0, mod_js_1.sha1)(s, "utf8", "hex");
+        return typeof hash === "string" ? hash : new TextDecoder().decode(hash);
+    }
+}
+exports.Script = Script;

package/script/platforms/cloudflare.js

@@ -26,6 +26,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Redis = void 0;
 const core = __importStar(require("../pkg/redis.js"));
 const http_js_1 = require("../pkg/http.js");
+const version_js_1 = require("../version.js");
 /**
  * Serverless redis client for upstash.
  */
@@ -41,7 +42,7 @@ class Redis extends core.Redis {
      * });
      * ```
      */
-    constructor(config) {
+    constructor(config, env) {
         if (config.url.startsWith(" ") ||
             config.url.endsWith(" ") ||
             /\r|\n/.test(config.url)) {
@@ -56,10 +57,17 @@ class Redis extends core.Redis {
             retry: config.retry,
             baseUrl: config.url,
             headers: { authorization: `Bearer ${config.token}` },
+            responseEncoding: config.responseEncoding,
         });
         super(client, {
+            enableTelemetry: !env?.UPSTASH_DISABLE_TELEMETRY,
             automaticDeserialization: config.automaticDeserialization,
         });
+        // This is only added of the user has not disabled telemetry
+        this.addTelemetry({
+            platform: "cloudflare",
+            sdk: `@upstash/redis@${version_js_1.VERSION}`,
+        });
     }
     /*
      * Create a new Upstash Redis instance from environment variables on cloudflare.
@@ -83,7 +91,7 @@ class Redis extends core.Redis {
         if (!token) {
             throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_TOKEN`. Please add it via `wrangler secret put UPSTASH_REDIS_REST_TOKEN`");
         }
-        return new Redis({ ...opts, url, token });
+        return new Redis({ ...opts, url, token }, env);
     }
 }
 exports.Redis = Redis;

package/script/platforms/fastly.js

@@ -26,6 +26,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Redis = void 0;
 const core = __importStar(require("../pkg/redis.js"));
 const http_js_1 = require("../pkg/http.js");
+const version_js_1 = require("../version.js");
 /**
  * Serverless redis client for upstash.
  */
@@ -58,10 +59,15 @@ class Redis extends core.Redis {
             retry: config.retry,
             headers: { authorization: `Bearer ${config.token}` },
             options: { backend: config.backend },
+            responseEncoding: config.responseEncoding,
         });
         super(client, {
             automaticDeserialization: config.automaticDeserialization,
         });
+        this.addTelemetry({
+            sdk: `@upstash/redis@${version_js_1.VERSION}`,
+            platform: "fastly",
+        });
     }
 }
 exports.Redis = Redis;

package/script/platforms/node_with_fetch.js

@@ -27,7 +27,21 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Redis = void 0;
 const core = __importStar(require("../pkg/redis.js"));
 const http_js_1 = require("../pkg/http.js");
+const version_js_1 = require("../version.js");
 require("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.
  */
@@ -51,10 +65,21 @@ class Redis extends core.Redis {
             baseUrl: configOrRequester.url,
             retry: configOrRequester.retry,
             headers: { authorization: `Bearer ${configOrRequester.token}` },
-            // agent: configOrRequester.agent,
+            //  agent: configOrRequester.agent,
+            responseEncoding: configOrRequester.responseEncoding,
         });
         super(client, {
             automaticDeserialization: configOrRequester.automaticDeserialization,
+            enableTelemetry: !process.env.UPSTASH_DISABLE_TELEMETRY,
+        });
+        this.addTelemetry({
+            runtime: `node@${process.version}`,
+            platform: process.env.VERCEL
+                ? "vercel"
+                : process.env.AWS_REGION
+                    ? "aws"
+                    : "unknown",
+            sdk: `@upstash/redis@${version_js_1.VERSION}`,
         });
     }
     /**

package/script/platforms/nodejs.js

@@ -27,6 +27,15 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Redis = void 0;
 const core = __importStar(require("../pkg/redis.js"));
 const http_js_1 = require("../pkg/http.js");
+const version_js_1 = require("../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.
  */
@@ -50,10 +59,24 @@ class Redis extends core.Redis {
             baseUrl: configOrRequester.url,
             retry: configOrRequester.retry,
             headers: { authorization: `Bearer ${configOrRequester.token}` },
-            // agent: configOrRequester.agent,
+            agent: configOrRequester.agent,
+            responseEncoding: configOrRequester.responseEncoding,
+            cache: configOrRequester.cache || "no-store",
         });
         super(client, {
             automaticDeserialization: configOrRequester.automaticDeserialization,
+            enableTelemetry: !process.env.UPSTASH_DISABLE_TELEMETRY,
+        });
+        this.addTelemetry({
+            runtime: typeof EdgeRuntime === "string"
+                ? "edge-light"
+                : `node@${process.version}`,
+            platform: process.env.VERCEL
+                ? "vercel"
+                : process.env.AWS_REGION
+                    ? "aws"
+                    : "unknown",
+            sdk: `@upstash/redis@${version_js_1.VERSION}`,
         });
     }
     /**

package/script/version.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VERSION = void 0;
+exports.VERSION = "v0.0.0-ci.e4fa3be6-20231018";

package/types/deps/deno.land/x/base64@v0.2.1/base.d.ts

@@ -0,0 +1,5 @@
+export declare function init(lookup: string[], revLookup: number[], urlsafe?: boolean): {
+    byteLength(b64: string): number;
+    toUint8Array(b64: string): Uint8Array;
+    fromUint8Array(buf: Uint8Array): string;
+};

package/types/deps/deno.land/x/base64@v0.2.1/base64url.d.ts

@@ -0,0 +1 @@
+export declare const byteLength: (b64: string) => number, toUint8Array: (b64: string) => Uint8Array, fromUint8Array: (buf: Uint8Array) => string;

package/types/deps/deno.land/x/sha1@v1.0.3/deps.d.ts

@@ -0,0 +1 @@
+export { encode, decode } from "../../../denopkg.com/chiefbiiko/std-encoding@v1.0.0/mod.js";

package/types/deps/deno.land/x/sha1@v1.0.3/mod.d.ts

@@ -0,0 +1,26 @@
+/** Byte length of a SHA1 digest. */
+export declare const BYTES: number;
+/**  A class representation of the SHA1 algorithm. */
+export declare class SHA1 {
+    readonly hashSize: number;
+    private _buf;
+    private _bufIdx;
+    private _count;
+    private _K;
+    private _H;
+    private _finalized;
+    /** Creates a SHA1 instance. */
+    constructor();
+    /** Reduces the four input numbers to a single one. */
+    protected static F(t: number, b: number, c: number, d: number): number;
+    /** Initializes a hash instance. */
+    init(): SHA1;
+    /** Updates a hash with additional message data. */
+    update(msg: string | Uint8Array, inputEncoding?: string): SHA1;
+    /** Finalizes a hash with additional message data. */
+    digest(outputEncoding?: string): string | Uint8Array;
+    /** Performs one transformation cycle. */
+    private transform;
+}
+/** Generates a SHA1 hash of the input data. */
+export declare function sha1(msg: string | Uint8Array, inputEncoding?: string, outputEncoding?: string): string | Uint8Array;

package/types/deps/denopkg.com/chiefbiiko/std-encoding@v1.0.0/mod.d.ts

@@ -0,0 +1,3 @@
+/** Decodes a Uint8Array to utf8-, base64-, or hex-encoded string. */
+export declare function decode(buf: Uint8Array, encoding?: string): string;
+export declare function encode(str: string, encoding?: string): Uint8Array;

package/types/pkg/commands/bitop.d.ts

@@ -6,7 +6,6 @@ export declare class BitOpCommand extends Command<number, number> {
     constructor(cmd: [
         op: "and" | "or" | "xor",
         destinationKey: string,
-        sourceKey: string,
         ...sourceKeys: string[]
     ], opts?: CommandOptions<number, number>);
     constructor(cmd: [op: "not", destinationKey: string, sourceKey: string], opts?: CommandOptions<number, number>);

package/types/pkg/commands/bitpos.d.ts

@@ -3,5 +3,5 @@ import { Command, CommandOptions } from "./command.js";
  * @see https://redis.io/commands/bitpos
  */
 export declare class BitPosCommand extends Command<number, number> {
-    constructor(cmd: [key: string, start: number, end: number], opts?: CommandOptions<number, number>);
+    constructor(cmd: [key: string, bit: 0 | 1, start?: number, end?: number], opts?: CommandOptions<number, number>);
 }