@upstash/redis 0.0.0-ci.e3757170 → 0.0.0-ci.e5c2b594-20231017

package/README.md

@@ -23,29 +23,11 @@ See
 [the list of APIs](https://docs.upstash.com/features/restapi#rest---redis-api-compatibility)
 supported.
 
-## Upgrading to v1.4.0 **(ReferenceError: fetch is not defined)**
-
-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://github.com/upstash/upstash-redis#migrating-to-v1). For
-further explanation we wrote a
-[blog post](https://blog.upstash.com/upstash-redis-sdk-v1).
-
 ## Quick Start
 
 ### Install
 
-#### npm
+#### Node.js
 
 ```bash
 npm install @upstash/redis
@@ -61,133 +43,7 @@ import { Redis } from "https://deno.land/x/upstash_redis/mod.ts";
 
 Create a new redis database on [upstash](https://console.upstash.com/)
 
-### Environments
-
-We support various platforms, such as nodejs, cloudflare and fastly. Platforms
-differ slightly when it comes to environment variables and their `fetch` api.
-Please use the correct import when deploying to special platforms.
-
-#### Node.js
-
-Examples: Vercel, Netlify, AWS Lambda
-
-If you are running on nodejs you can set `UPSTASH_REDIS_REST_URL` and
-`UPSTASH_REDIS_REST_TOKEN` as environment variable and create a redis instance
-like this:
-
-```ts
-import { Redis } from "@upstash/redis"
-
-const redis = new Redis({
-  url: <UPSTASH_REDIS_REST_URL>,
-  token: <UPSTASH_REDIS_REST_TOKEN>,
-})
-
-// or load directly from env
-const redis = Redis.fromEnv()
-```
-
-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";
-```
-
-- [Code example](https://github.com/upstash/upstash-redis/blob/main/examples/nodejs)
-
-#### Cloudflare Workers
-
-Cloudflare handles environment variables differently than nodejs. Please add
-`UPSTASH_REDIS_REST_URL` and `UPSTASH_REDIS_REST_TOKEN` using
-`wrangler secret put ...` or in the cloudflare dashboard.
-
-Afterwards you can create a redis instance:
-
-```ts
-import { Redis } from "@upstash/redis/cloudflare"
-
-const redis = new Redis({
-  url: <UPSTASH_REDIS_REST_URL>,
-  token: <UPSTASH_REDIS_REST_TOKEN>,
-})
-
-
-// or load directly from global env
-
-// service worker
-const redis = Redis.fromEnv()
-
-
-// module worker
-export default {
-  async fetch(request: Request, env: Bindings) {
-    const redis = Redis.fromEnv(env)
-    // ...
-  }
-}
-```
-
-- [Code example Wrangler 2](https://github.com/upstash/upstash-redis/tree/main/examples/cloudflare-workers)
-- [Code example Wrangler 1](https://github.com/upstash/upstash-redis/tree/main/examples/cloudflare-workers-with-wrangler-1)
-- [Documentation](https://docs.upstash.com/redis/tutorials/cloudflare_workers_with_redis)
-
-#### Fastly
-
-Fastly introduces a concept called
-[backend](https://developer.fastly.com/reference/api/services/backend/). You
-need to configure a backend in your `fastly.toml`. An example can be found
-[here](https://github.com/upstash/upstash-redis/blob/main/examples/fastly/fastly.toml).
-Until the fastly api stabilizes we recommend creating an instance manually:
-
-```ts
-import { Redis } from "@upstash/redis/fastly"
-
-const redis = new Redis({
-  url: <UPSTASH_REDIS_REST_URL>,
-  token: <UPSTASH_REDIS_REST_TOKEN>,
-  backend: <BACKEND_NAME>,
-})
-```
-
-- [Code example](https://github.com/upstash/upstash-redis/tree/main/examples/fastly)
-- [Documentation](https://blog.upstash.com/fastly-compute-edge-with-redi)
-
-#### Deno
-
-Examples: [Deno Deploy](https://deno.com/deploy),
-[Netlify Edge](https://www.netlify.com/products/edge/)
-
-```ts
-import { Redis } from "https://deno.land/x/upstash_redis/mod.ts"
-
-const redis = new Redis({
-  url: <UPSTASH_REDIS_REST_URL>,
-  token: <UPSTASH_REDIS_REST_TOKEN>,
-})
-
-// or
-const redis = Redis.fromEnv();
-```
-
-### Working with types
-
-Most commands allow you to provide a type to make working with typescript
-easier.
-
-```ts
-const data = await redis.get<MyCustomType>("key");
-// data is typed as `MyCustomType`
-```
-
-## Migrating to v1
-
-### Explicit authentication
-
-The library is no longer automatically trying to load connection secrets from
-environment variables. You must either supply them yourself:
+## Basic Usage:
 
 ```ts
 import { Redis } from "@upstash/redis"
@@ -196,146 +52,41 @@ const redis = new Redis({
   url: <UPSTASH_REDIS_REST_URL>,
   token: <UPSTASH_REDIS_REST_TOKEN>,
 })
-```
-
-Or use one of the static constructors to load from environment variables:
-
-```ts
-// Nodejs
-import { Redis } from "@upstash/redis";
-const redis = Redis.fromEnv();
-```
-
-```ts
-// or when deploying to cloudflare workers
-import { Redis } from "@upstash/redis/cloudflare";
-const redis = Redis.fromEnv();
-```
-
-### Error handling
-
-Errors are now thrown automatically instead of being returned to you.
-
-```ts
-// old
-const { data, error } = await set("key", "value");
-if (error) {
-  throw new Error(error);
-}
-
-// new
-const data = await redis.set("key", "value"); // error is thrown automatically
-```
-
-## Pipeline
-
-`v1.0.0` introduces redis pipelines. Pipelining commands allows you to send a
-single http request with multiple commands.
-
-```ts
-import { Redis } from "@upstash/redis";
-
-const redis = new Redis({
-  /* auth */
-});
-
-const p = redis.pipeline();
-
-// Now you can chain multiple commands to create your pipeline:
-
-p.set("key", 2);
-p.incr("key");
-
-// or inline:
-p.hset("key2", "field", { hello: "world" }).hvals("key2");
-
-// Execute the pipeline once you are done building it:
-// `exec` returns an array where each element represents the response of a command in the pipeline.
-// You can optionally provide a type like this to get a typed response.
-const res = await p.exec<[Type1, Type2, Type3]>();
-```
-
-For more information about pipelines using REST see
-[here](https://blog.upstash.com/pipeline).
-
-### Advanced
-
-A low level `Command` class can be imported from `@upstash/redis` in case you
-need more control about types and or (de)serialization.
-
-By default all objects you are storing in redis are serialized using
-`JSON.stringify` and recursively deserialized as well. Here's an example how you
-could customize that behaviour. Keep in mind that you need to provide a `fetch`
-polyfill if you are running on nodejs. We recommend
-[isomorphic-fetch](https://www.npmjs.com/package/isomorphic-fetch).
-
-```ts
-import { Command } from "@upstash/redis/commands"
-import { HttpClient } from "@upstash/redis/http"
-
-/**
- * TData represents what the user will enter or receive,
- * TResult is the raw data returned from upstash, which may need to be
- * transformed or parsed.
- */
-const deserialize: (raw: TResult) => TData = ...
-
-class CustomGetCommand<TData, TResult> extends Command<TData | null, TResult | null> {
-  constructor(key: string, ) {
-    super(["get", key], { deserialize })
-  }
-}
-
-const client = new HttpClient({
-  baseUrl: <UPSTASH_REDIS_REST_URL>,
-  headers: {
-    authorization: `Bearer ${<UPSTASH_REDIS_REST_TOKEN>}`,
-  },
-})
-
-const res = new CustomGetCommand("key").exec(client)
-```
 
-### Additional information
+// string
+await redis.set('key', 'value');
+let data = await redis.get('key');
+console.log(data)
 
-#### `keepalive`
+await redis.set('key2', 'value2', {ex: 1});
 
-`@upstash/redis` is capable of reusing connections where possible to minimize
-latency. Connections can be reused if the client is stored in memory and not
-initialized with every new function invocation. The easiest way to achieve this
-is by creating the client outside of your handler and adding an https agent:
+// sorted set
+await redis.zadd('scores', { score: 1, member: 'team1' })
+data = await redis.zrange('scores', 0, 100 )
+console.log(data)
 
-```ts
-// Nextjs api route
-import { Redis } from "@upstash/redis";
-import https from "https";
+// list
+await redis.lpush('elements', 'magnesium')
+data = await redis.lrange('elements', 0, 100 )
+console.log(data)
 
-const redis = Redis.fromEnv({
-  agent: new https.Agent({ keepAlive: true }),
-});
+// hash
+await redis.hset('people', {name: 'joe'})
+data = await redis.hget('people', 'name' )
+console.log(data)
 
-export default async function (req, res) {
-  // use redis here
-}
+// sets
+await redis.sadd('animals', 'cat')
+data  = await redis.spop('animals', 1)
+console.log(data)
 ```
 
-Whenever your hot lambda receives a new request the client is already
-initialized and the previously established connection to upstash is reused.
+## Troubleshooting
 
-#### Javascript MAX_SAFE_INTEGER
-
-Javascript can not handle numbers larger than `2^53 -1` safely and would return
-wrong results when trying to deserialize them. In these cases the default
-deserializer will return them as string instead. This might cause a mismatch
-with your custom types.
-
-```ts
-await redis.set("key", "101600000000150081467");
-const res = await redis<number>("get");
-```
-
-In this example `res` will still be a string despite the type annotation. Please
-keep that in mind and adjust accordingly.
+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
 
@@ -357,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);
+}