@upstash/redis 0.0.0-ci.efe72030 → 0.0.0-ci.f0c37f55-20231010

package/README.md

@@ -27,7 +27,7 @@ supported.
 
 ### Install
 
-#### npm
+#### Node.js
 
 ```bash
 npm install @upstash/redis
@@ -81,23 +81,12 @@ data  = await redis.spop('animals', 1)
 console.log(data)
 ```
 
-### Upgrading to v1.4.0 **(ReferenceError: fetch is not defined)**
+## Troubleshooting
 
-If you are running on nodejs v17 and earlier, `fetch` will not be natively
-supported. Platforms like Vercel, Netlify, Deno, Fastly etc. provide a polyfill
-for you. But if you are running on bare node, you need to either specify a
-polyfill yourself or change the import path to:
-
-```typescript
-import { Redis } from "@upstash/redis/with-fetch";
-```
-
-### Upgrading from v0.2.0?
-
-Please read the
-[migration guide](https://docs.upstash.com/redis/sdks/javascriptsdk/migration).
-For further explanation we wrote a
-[blog post](https://blog.upstash.com/upstash-redis-sdk-v1).
+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
 
@@ -119,5 +108,18 @@ the url and token
 UPSTASH_REDIS_REST_URL=".." UPSTASH_REDIS_REST_TOKEN=".." deno test -A
 ```
 
-```
+### Telemetry
+
+This library sends anonymous telemetry data to help us improve your experience.
+We collect the following:
+
+- SDK version
+- Platform (Deno, Cloudflare, Vercel)
+- Runtime version (node@18.x)
+
+You can opt out by setting the `UPSTASH_DISABLE_TELEMETRY` environment variable
+to any truthy value.
+
+```sh
+UPSTASH_DISABLE_TELEMETRY=1
 ```

package/esm/deps/deno.land/x/base64@v0.2.1/base.js

@@ -0,0 +1,100 @@
+function getLengths(b64) {
+    const len = b64.length;
+    // if (len % 4 > 0) {
+    //   throw new TypeError("Invalid string. Length must be a multiple of 4");
+    // }
+    // Trim off extra bytes after placeholder bytes are found
+    // See: https://github.com/beatgammit/base64-js/issues/42
+    let validLen = b64.indexOf("=");
+    if (validLen === -1) {
+        validLen = len;
+    }
+    const placeHoldersLen = validLen === len ? 0 : 4 - (validLen % 4);
+    return [validLen, placeHoldersLen];
+}
+export function init(lookup, revLookup, urlsafe = false) {
+    function _byteLength(validLen, placeHoldersLen) {
+        return Math.floor(((validLen + placeHoldersLen) * 3) / 4 - placeHoldersLen);
+    }
+    function tripletToBase64(num) {
+        return (lookup[(num >> 18) & 0x3f] +
+            lookup[(num >> 12) & 0x3f] +
+            lookup[(num >> 6) & 0x3f] +
+            lookup[num & 0x3f]);
+    }
+    function encodeChunk(buf, start, end) {
+        const out = new Array((end - start) / 3);
+        for (let i = start, curTriplet = 0; i < end; i += 3) {
+            out[curTriplet++] = tripletToBase64((buf[i] << 16) + (buf[i + 1] << 8) + buf[i + 2]);
+        }
+        return out.join("");
+    }
+    return {
+        // base64 is 4/3 + up to two characters of the original data
+        byteLength(b64) {
+            return _byteLength.apply(null, getLengths(b64));
+        },
+        toUint8Array(b64) {
+            const [validLen, placeHoldersLen] = getLengths(b64);
+            const buf = new Uint8Array(_byteLength(validLen, placeHoldersLen));
+            // If there are placeholders, only get up to the last complete 4 chars
+            const len = placeHoldersLen ? validLen - 4 : validLen;
+            let tmp;
+            let curByte = 0;
+            let i;
+            for (i = 0; i < len; i += 4) {
+                tmp = (revLookup[b64.charCodeAt(i)] << 18) |
+                    (revLookup[b64.charCodeAt(i + 1)] << 12) |
+                    (revLookup[b64.charCodeAt(i + 2)] << 6) |
+                    revLookup[b64.charCodeAt(i + 3)];
+                buf[curByte++] = (tmp >> 16) & 0xff;
+                buf[curByte++] = (tmp >> 8) & 0xff;
+                buf[curByte++] = tmp & 0xff;
+            }
+            if (placeHoldersLen === 2) {
+                tmp = (revLookup[b64.charCodeAt(i)] << 2) |
+                    (revLookup[b64.charCodeAt(i + 1)] >> 4);
+                buf[curByte++] = tmp & 0xff;
+            }
+            else if (placeHoldersLen === 1) {
+                tmp = (revLookup[b64.charCodeAt(i)] << 10) |
+                    (revLookup[b64.charCodeAt(i + 1)] << 4) |
+                    (revLookup[b64.charCodeAt(i + 2)] >> 2);
+                buf[curByte++] = (tmp >> 8) & 0xff;
+                buf[curByte++] = tmp & 0xff;
+            }
+            return buf;
+        },
+        fromUint8Array(buf) {
+            const maxChunkLength = 16383; // Must be multiple of 3
+            const len = buf.length;
+            const extraBytes = len % 3; // If we have 1 byte left, pad 2 bytes
+            const len2 = len - extraBytes;
+            const parts = new Array(Math.ceil(len2 / maxChunkLength) + (extraBytes ? 1 : 0));
+            let curChunk = 0;
+            let chunkEnd;
+            // Go through the array every three bytes, we'll deal with trailing stuff later
+            for (let i = 0; i < len2; i += maxChunkLength) {
+                chunkEnd = i + maxChunkLength;
+                parts[curChunk++] = encodeChunk(buf, i, chunkEnd > len2 ? len2 : chunkEnd);
+            }
+            let tmp;
+            // Pad the end with zeros, but make sure to not forget the extra bytes
+            if (extraBytes === 1) {
+                tmp = buf[len2];
+                parts[curChunk] = lookup[tmp >> 2] + lookup[(tmp << 4) & 0x3f];
+                if (!urlsafe)
+                    parts[curChunk] += "==";
+            }
+            else if (extraBytes === 2) {
+                tmp = (buf[len2] << 8) | (buf[len2 + 1] & 0xff);
+                parts[curChunk] = lookup[tmp >> 10] +
+                    lookup[(tmp >> 4) & 0x3f] +
+                    lookup[(tmp << 2) & 0x3f];
+                if (!urlsafe)
+                    parts[curChunk] += "=";
+            }
+            return parts.join("");
+        },
+    };
+}

package/esm/deps/deno.land/x/base64@v0.2.1/base64url.js

@@ -0,0 +1,9 @@
+import { init } from "./base.js";
+const lookup = [];
+const revLookup = [];
+const code = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-_";
+for (let i = 0, l = code.length; i < l; ++i) {
+    lookup[i] = code[i];
+    revLookup[code.charCodeAt(i)] = i;
+}
+export const { byteLength, toUint8Array, fromUint8Array } = init(lookup, revLookup, true);

package/esm/deps/deno.land/x/sha1@v1.0.3/deps.js

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

package/esm/deps/deno.land/x/sha1@v1.0.3/mod.js

@@ -0,0 +1,191 @@
+import { encode, decode } from "./deps.js";
+function rotl(x, n) {
+    return (x << n) | (x >>> (32 - n));
+}
+/** Byte length of a SHA1 digest. */
+export const BYTES = 20;
+/**  A class representation of the SHA1 algorithm. */
+export class SHA1 {
+    /** Creates a SHA1 instance. */
+    constructor() {
+        Object.defineProperty(this, "hashSize", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: BYTES
+        });
+        Object.defineProperty(this, "_buf", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: new Uint8Array(64)
+        });
+        Object.defineProperty(this, "_bufIdx", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "_count", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "_K", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: new Uint32Array([0x5a827999, 0x6ed9eba1, 0x8f1bbcdc, 0xca62c1d6])
+        });
+        Object.defineProperty(this, "_H", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "_finalized", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.init();
+    }
+    /** Reduces the four input numbers to a single one. */
+    static F(t, b, c, d) {
+        if (t <= 19) {
+            return (b & c) | (~b & d);
+        }
+        else if (t <= 39) {
+            return b ^ c ^ d;
+        }
+        else if (t <= 59) {
+            return (b & c) | (b & d) | (c & d);
+        }
+        else {
+            return b ^ c ^ d;
+        }
+    }
+    /** Initializes a hash instance. */
+    init() {
+        // prettier-ignore
+        this._H = new Uint32Array([
+            0x67452301, 0xEFCDAB89, 0x98BADCFE, 0x10325476, 0xC3D2E1F0
+        ]);
+        this._bufIdx = 0;
+        this._count = new Uint32Array(2);
+        this._buf.fill(0);
+        this._finalized = false;
+        return this;
+    }
+    /** Updates a hash with additional message data. */
+    update(msg, inputEncoding) {
+        if (msg === null) {
+            throw new TypeError("msg must be a string or Uint8Array.");
+        }
+        else if (typeof msg === "string") {
+            msg = encode(msg, inputEncoding);
+        }
+        // process the msg as many times as possible, the rest is stored in the buffer
+        // message is processed in 512 bit (64 byte chunks)
+        for (let i = 0; i < msg.length; i++) {
+            this._buf[this._bufIdx++] = msg[i];
+            if (this._bufIdx === 64) {
+                this.transform();
+                this._bufIdx = 0;
+            }
+        }
+        // counter update (number of message bits)
+        const c = this._count;
+        if ((c[0] += msg.length << 3) < msg.length << 3) {
+            c[1]++;
+        }
+        c[1] += msg.length >>> 29;
+        return this;
+    }
+    /** Finalizes a hash with additional message data. */
+    digest(outputEncoding) {
+        if (this._finalized) {
+            throw new Error("digest has already been called.");
+        }
+        this._finalized = true;
+        // append '1'
+        const b = this._buf;
+        let idx = this._bufIdx;
+        b[idx++] = 0x80;
+        // zeropad up to byte pos 56
+        while (idx !== 56) {
+            if (idx === 64) {
+                this.transform();
+                idx = 0;
+            }
+            b[idx++] = 0;
+        }
+        // append length in bits
+        const c = this._count;
+        b[56] = (c[1] >>> 24) & 0xff;
+        b[57] = (c[1] >>> 16) & 0xff;
+        b[58] = (c[1] >>> 8) & 0xff;
+        b[59] = (c[1] >>> 0) & 0xff;
+        b[60] = (c[0] >>> 24) & 0xff;
+        b[61] = (c[0] >>> 16) & 0xff;
+        b[62] = (c[0] >>> 8) & 0xff;
+        b[63] = (c[0] >>> 0) & 0xff;
+        this.transform();
+        // return the hash as byte array (20 bytes)
+        const hash = new Uint8Array(BYTES);
+        for (let i = 0; i < 5; i++) {
+            hash[(i << 2) + 0] = (this._H[i] >>> 24) & 0xff;
+            hash[(i << 2) + 1] = (this._H[i] >>> 16) & 0xff;
+            hash[(i << 2) + 2] = (this._H[i] >>> 8) & 0xff;
+            hash[(i << 2) + 3] = (this._H[i] >>> 0) & 0xff;
+        }
+        // clear internal states and prepare for new hash
+        this.init();
+        return outputEncoding ? decode(hash, outputEncoding) : hash;
+    }
+    /** Performs one transformation cycle. */
+    transform() {
+        const h = this._H;
+        let a = h[0];
+        let b = h[1];
+        let c = h[2];
+        let d = h[3];
+        let e = h[4];
+        // convert byte buffer to words
+        const w = new Uint32Array(80);
+        for (let i = 0; i < 16; i++) {
+            w[i] =
+                this._buf[(i << 2) + 3] |
+                    (this._buf[(i << 2) + 2] << 8) |
+                    (this._buf[(i << 2) + 1] << 16) |
+                    (this._buf[i << 2] << 24);
+        }
+        for (let t = 0; t < 80; t++) {
+            if (t >= 16) {
+                w[t] = rotl(w[t - 3] ^ w[t - 8] ^ w[t - 14] ^ w[t - 16], 1);
+            }
+            const tmp = (rotl(a, 5) +
+                SHA1.F(t, b, c, d) +
+                e +
+                w[t] +
+                this._K[Math.floor(t / 20)]) |
+                0;
+            e = d;
+            d = c;
+            c = rotl(b, 30);
+            b = a;
+            a = tmp;
+        }
+        h[0] = (h[0] + a) | 0;
+        h[1] = (h[1] + b) | 0;
+        h[2] = (h[2] + c) | 0;
+        h[3] = (h[3] + d) | 0;
+        h[4] = (h[4] + e) | 0;
+    }
+}
+/** Generates a SHA1 hash of the input data. */
+export function sha1(msg, inputEncoding, outputEncoding) {
+    return new SHA1().update(msg, inputEncoding).digest(outputEncoding);
+}

package/esm/deps/denopkg.com/chiefbiiko/std-encoding@v1.0.0/mod.js

@@ -0,0 +1,50 @@
+import { toUint8Array, fromUint8Array } from "../../../deno.land/x/base64@v0.2.1/base64url.js";
+const decoder = new TextDecoder();
+const encoder = new TextEncoder();
+/** Serializes a Uint8Array to a hexadecimal string. */
+function toHexString(buf) {
+    return buf.reduce((hex, byte) => `${hex}${byte < 16 ? "0" : ""}${byte.toString(16)}`, "");
+}
+/** Deserializes a Uint8Array from a hexadecimal string. */
+function fromHexString(hex) {
+    const len = hex.length;
+    if (len % 2 || !/^[0-9a-fA-F]+$/.test(hex)) {
+        throw new TypeError("Invalid hex string.");
+    }
+    hex = hex.toLowerCase();
+    const buf = new Uint8Array(Math.floor(len / 2));
+    const end = len / 2;
+    for (let i = 0; i < end; ++i) {
+        buf[i] = parseInt(hex.substr(i * 2, 2), 16);
+    }
+    return buf;
+}
+/** Decodes a Uint8Array to utf8-, base64-, or hex-encoded string. */
+export function decode(buf, encoding = "utf8") {
+    if (/^utf-?8$/i.test(encoding)) {
+        return decoder.decode(buf);
+    }
+    else if (/^base64$/i.test(encoding)) {
+        return fromUint8Array(buf);
+    }
+    else if (/^hex(?:adecimal)?$/i.test(encoding)) {
+        return toHexString(buf);
+    }
+    else {
+        throw new TypeError("Unsupported string encoding.");
+    }
+}
+export function encode(str, encoding = "utf8") {
+    if (/^utf-?8$/i.test(encoding)) {
+        return encoder.encode(str);
+    }
+    else if (/^base64$/i.test(encoding)) {
+        return toUint8Array(str);
+    }
+    else if (/^hex(?:adecimal)?$/i.test(encoding)) {
+        return fromHexString(str);
+    }
+    else {
+        throw new TypeError("Unsupported string encoding.");
+    }
+}

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

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

package/esm/pkg/commands/hgetall.js

@@ -1,8 +1,4 @@
 import { Command } from "./command.js";
-/**
- * @param result De
- * @returns
- */
 function deserialize(result) {
     if (result.length === 0) {
         return null;

package/esm/pkg/commands/hrandfield.js

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

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);
+    }
+}