@upstash/redis 1.3.0 → 1.3.2-alpha.1

package/esm/pkg/types.js

@@ -0,0 +1 @@
+export {};

package/esm/pkg/util.js

@@ -0,0 +1,31 @@
+function parseRecursive(obj) {
+    const parsed = Array.isArray(obj)
+        ? obj.map((o) => {
+            try {
+                return parseRecursive(o);
+            }
+            catch {
+                return o;
+            }
+        })
+        : JSON.parse(obj);
+    /**
+     * Parsing very large numbers can result in MAX_SAFE_INTEGER
+     * overflow. In that case we return the number as string instead.
+     */
+    if (typeof parsed === "number" && parsed.toString() != obj) {
+        return obj;
+    }
+    return parsed;
+}
+export function parseResponse(result) {
+    try {
+        /**
+         * Try to parse the response if possible
+         */
+        return parseRecursive(result);
+    }
+    catch {
+        return result;
+    }
+}

package/esm/platforms/cloudflare.js

@@ -0,0 +1,70 @@
+import * as core from "../pkg/redis.js";
+import { UpstashError } from "../pkg/error.js";
+/**
+ * Serverless redis client for upstash.
+ */
+export class Redis extends core.Redis {
+    /**
+     * Create a new redis client
+     *
+     * @example
+     * ```typescript
+     * const redis = new Redis({
+     *  url: "<UPSTASH_REDIS_REST_URL>",
+     *  token: "<UPSTASH_REDIS_REST_TOKEN>",
+     * });
+     * ```
+     */
+    constructor(config) {
+        const client = defaultRequester({
+            baseUrl: config.url,
+            headers: { authorization: `Bearer ${config.token}` },
+        });
+        super(client);
+    }
+    /*
+     * Create a new Upstash Redis instance from environment variables on cloudflare.
+     *
+     * This tries to load `UPSTASH_REDIS_REST_URL` and `UPSTASH_REDIS_REST_TOKEN` from
+     * the global namespace
+     *
+     * If you are using a module worker, please pass in the `env` object.
+     * ```ts
+     * const redis = Redis.fromEnv(env)
+     * ```
+     *
+     */
+    static fromEnv(env) {
+        // @ts-ignore These will be defined by cloudflare
+        const url = env?.UPSTASH_REDIS_REST_URL ?? UPSTASH_REDIS_REST_URL;
+        // @ts-ignore These will be defined by cloudflare
+        const token = env?.UPSTASH_REDIS_REST_TOKEN ?? UPSTASH_REDIS_REST_TOKEN;
+        if (!url) {
+            throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_URL`. Please add it via `wrangler secret put UPSTASH_REDIS_REST_URL`");
+        }
+        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({ url, token });
+    }
+}
+function defaultRequester(config) {
+    return {
+        request: async function (req) {
+            if (!req.path) {
+                req.path = [];
+            }
+            const res = await fetch([config.baseUrl, ...req.path].join("/"), {
+                method: "POST",
+                headers: { "Content-Type": "application/json", ...config.headers },
+                body: JSON.stringify(req.body),
+                keepalive: true,
+            });
+            const body = (await res.json());
+            if (!res.ok) {
+                throw new UpstashError(body.error);
+            }
+            return body;
+        },
+    };
+}

package/esm/platforms/fastly.js

@@ -0,0 +1,49 @@
+import * as core from "../pkg/redis.js";
+import { UpstashError } from "../pkg/error.js";
+/**
+ * Serverless redis client for upstash.
+ */
+export class Redis extends core.Redis {
+    /**
+     * Create a new redis client
+     *
+     * @example
+     * ```typescript
+     *    const redis = new Redis({
+     *        url: "<UPSTASH_REDIS_REST_URL>",
+     *        token: "<UPSTASH_REDIS_REST_TOKEN>",
+     *        backend: "upstash-db",
+     *    });
+     * ```
+     */
+    constructor(config) {
+        const client = defaultRequester({
+            baseUrl: config.url,
+            headers: { authorization: `Bearer ${config.token}` },
+            backend: config.backend,
+        });
+        super(client);
+    }
+}
+function defaultRequester(config) {
+    return {
+        request: async function (req) {
+            if (!req.path) {
+                req.path = [];
+            }
+            const res = await fetch([config.baseUrl, ...req.path].join("/"), {
+                method: "POST",
+                headers: { "Content-Type": "application/json", ...config.headers },
+                body: JSON.stringify(req.body),
+                keepalive: true,
+                // @ts-expect-error fastly requires `backend`
+                backend: config.backend,
+            });
+            const body = (await res.json());
+            if (!res.ok) {
+                throw new UpstashError(body.error);
+            }
+            return body;
+        },
+    };
+}

package/esm/platforms/nodejs.js

@@ -0,0 +1,69 @@
+// deno-lint-ignore-file
+import * as core from "../pkg/redis.js";
+import { UpstashError } from "../pkg/error.js";
+import "isomorphic-fetch";
+/**
+ * Serverless redis client for upstash.
+ */
+export class Redis extends core.Redis {
+    constructor(configOrRequester) {
+        if ("request" in configOrRequester) {
+            super(configOrRequester);
+            return;
+        }
+        const client = defaultRequester({
+            baseUrl: configOrRequester.url,
+            headers: { authorization: `Bearer ${configOrRequester.token}` },
+            agent: configOrRequester.agent,
+        });
+        super(client);
+    }
+    /**
+     * Create a new Upstash Redis instance from environment variables.
+     *
+     * Use this to automatically load connection secrets from your environment
+     * variables. For instance when using the Vercel integration.
+     *
+     * This tries to load `UPSTASH_REDIS_REST_URL` and `UPSTASH_REDIS_REST_TOKEN` from
+     * your environment using `process.env`.
+     */
+    static fromEnv(config) {
+        // @ts-ignore process will be defined in node
+        if (typeof process?.env === "undefined") {
+            throw new Error('Unable to get environment variables, `process.env` is undefined. If you are deploying to cloudflare, please import from "@upstash/redis/cloudflare" instead');
+        }
+        // @ts-ignore process will be defined in node
+        const url = process?.env["UPSTASH_REDIS_REST_URL"];
+        if (!url) {
+            throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_URL`");
+        }
+        // @ts-ignore process will be defined in node
+        const token = process?.env["UPSTASH_REDIS_REST_TOKEN"];
+        if (!token) {
+            throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_TOKEN`");
+        }
+        return new Redis({ url, token, ...config });
+    }
+}
+function defaultRequester(config) {
+    return {
+        request: async function (req) {
+            if (!req.path) {
+                req.path = [];
+            }
+            const res = await fetch([config.baseUrl, ...req.path].join("/"), {
+                method: "POST",
+                headers: { "Content-Type": "application/json", ...config.headers },
+                body: JSON.stringify(req.body),
+                keepalive: true,
+                // @ts-ignore
+                agent: config.agent,
+            });
+            const body = (await res.json());
+            if (!res.ok) {
+                throw new UpstashError(body.error);
+            }
+            return body;
+        },
+    };
+}

package/esm/platforms/vercel.js

@@ -0,0 +1,68 @@
+// deno-lint-ignore-file
+import * as core from "../pkg/redis.js";
+import { UpstashError } from "../pkg/error.js";
+/**
+ * Serverless redis client for upstash.
+ */
+export class Redis extends core.Redis {
+    constructor(configOrRequester) {
+        if ("request" in configOrRequester) {
+            super(configOrRequester);
+            return;
+        }
+        const client = defaultRequester({
+            baseUrl: configOrRequester.url,
+            headers: { authorization: `Bearer ${configOrRequester.token}` },
+            agent: configOrRequester.agent,
+        });
+        super(client);
+    }
+    /**
+     * Create a new Upstash Redis instance from environment variables.
+     *
+     * Use this to automatically load connection secrets from your environment
+     * variables. For instance when using the Vercel integration.
+     *
+     * This tries to load `UPSTASH_REDIS_REST_URL` and `UPSTASH_REDIS_REST_TOKEN` from
+     * your environment using `process.env`.
+     */
+    static fromEnv(config) {
+        // @ts-ignore process will be defined in node
+        if (typeof process?.env === "undefined") {
+            throw new Error('Unable to get environment variables, `process.env` is undefined. If you are deploying to cloudflare, please import from "@upstash/redis/cloudflare" instead');
+        }
+        // @ts-ignore process will be defined in node
+        const url = process?.env["UPSTASH_REDIS_REST_URL"];
+        if (!url) {
+            throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_URL`");
+        }
+        // @ts-ignore process will be defined in node
+        const token = process?.env["UPSTASH_REDIS_REST_TOKEN"];
+        if (!token) {
+            throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_TOKEN`");
+        }
+        return new Redis({ url, token, ...config });
+    }
+}
+function defaultRequester(config) {
+    return {
+        request: async function (req) {
+            if (!req.path) {
+                req.path = [];
+            }
+            const res = await fetch([config.baseUrl, ...req.path].join("/"), {
+                method: "POST",
+                headers: { "Content-Type": "application/json", ...config.headers },
+                body: JSON.stringify(req.body),
+                keepalive: true,
+                // @ts-ignore
+                agent: config.agent,
+            });
+            const body = (await res.json());
+            if (!res.ok) {
+                throw new UpstashError(body.error);
+            }
+            return body;
+        },
+    };
+}

package/package.json

@@ -1 +1,90 @@
-{ "name": "@upstash/redis", "version": "v1.3.0", "description": "An HTTP/REST based Redis client built on top of Upstash REST API.", "main": "./index.js", "module": "./index.mjs", "types": "./index.d.ts", "scripts": { "test": "jest -i", "fmt": "rome format .", "build": "tsup && cp package.json ./dist/ && pnpm size-limit" }, "repository": { "type": "git", "url": "git+https://github.com/upstash/upstash-redis.git" }, "keywords": [ "redis", "database", "serverless", "edge", "upstash" ], "author": "Andreas Thomas <andreas.thomas@chronark.com>", "license": "MIT", "bugs": { "url": "https://github.com/upstash/upstash-redis/issues" }, "homepage": "https://github.com/upstash/upstash-redis#readme", "directories": { "examples": "examples" }, "devDependencies": { "@jest/globals": "^27.4.6", "@size-limit/preset-small-lib": "^7.0.8", "@types/jest": "^27.4.0", "@types/node": "^17.0.8", "dotenv": "^12.0.3", "jest": "^27.4.7", "rome": "^0.4.2-next", "size-limit": "^7.0.8", "ts-jest": "^27.1.3", "tsup": "^5.11.11", "typescript": "^4.5.5" }, "dependencies": { "isomorphic-fetch": "^3.0.0" }, "browser": { "isomorphic-fetch": false, "http": false, "https": false }, "size-limit": [ { "path": "dist/index.js", "limit": "6 KB" }, { "path": "dist/index.mjs", "limit": "6 KB" }, { "path": "dist/cloudflare.js", "limit": "6 KB" }, { "path": "dist/cloudflare.mjs", "limit": "6 KB" }, { "path": "dist/nodejs.js", "limit": "6 KB" }, { "path": "dist/nodejs.mjs", "limit": "6 KB" }, { "path": "dist/fastly.js", "limit": "6 KB" }, { "path": "dist/fastly.mjs", "limit": "6 KB" } ] }
+{
+  "module": "./esm/platforms/nodejs.js",
+  "main": "./script/platforms/nodejs.js",
+  "types": "./types/platforms/nodejs.d.ts",
+  "name": "@upstash/redis",
+  "version": "v1.3.2-alpha.1",
+  "description": "An HTTP/REST based Redis client built on top of Upstash REST API.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/upstash/upstash-redis.git"
+  },
+  "keywords": [
+    "redis",
+    "database",
+    "serverless",
+    "edge",
+    "upstash"
+  ],
+  "author": "Andreas Thomas <andreas.thomas@chronark.com>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/upstash/upstash-redis/issues"
+  },
+  "homepage": "https://github.com/upstash/upstash-redis#readme",
+  "browser": {
+    "isomorphic-fetch": false,
+    "http": false,
+    "https": false
+  },
+  "dependencies": {
+    "isomorphic-fetch": "^3.0.0"
+  },
+  "devDependencies": {
+    "@size-limit/preset-small-lib": "latest",
+    "size-limit": "latest"
+  },
+  "size-limit": [
+    {
+      "path": "esm/platforms/nodejs.js",
+      "limit": "5 KB"
+    },
+    {
+      "path": "esm/platforms/fastly.js",
+      "limit": "5 KB"
+    },
+    {
+      "path": "esm/platforms/cloudflare.js",
+      "limit": "5 KB"
+    },
+    {
+      "path": "script/platforms/nodejs.js",
+      "limit": "10 KB"
+    },
+    {
+      "path": "script/platforms/fastly.js",
+      "limit": "10 KB"
+    },
+    {
+      "path": "script/platforms/cloudflare.js",
+      "limit": "10 KB"
+    }
+  ],
+  "exports": {
+    ".": {
+      "import": "./esm/platforms/nodejs.js",
+      "require": "./script/platforms/nodejs.js",
+      "types": "./types/platforms/nodejs.d.ts"
+    },
+    "./nodejs": {
+      "import": "./esm/platforms/nodejs.js",
+      "require": "./script/platforms/nodejs.js",
+      "types": "./types/platforms/nodejs.d.ts"
+    },
+    "./vercel": {
+      "import": "./esm/platforms/vercel.js",
+      "require": "./script/platforms/vercel.js",
+      "types": "./types/platforms/vercel.d.ts"
+    },
+    "./cloudflare": {
+      "import": "./esm/platforms/cloudflare.js",
+      "require": "./script/platforms/cloudflare.js",
+      "types": "./types/platforms/cloudflare.d.ts"
+    },
+    "./fastly": {
+      "import": "./esm/platforms/fastly.js",
+      "require": "./script/platforms/fastly.js",
+      "types": "./types/platforms/fastly.d.ts"
+    }
+  }
+}

package/script/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/script/pkg/commands/append.js

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

package/script/pkg/commands/bitcount.js

@@ -0,0 +1,20 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BitCountCommand = void 0;
+const command_js_1 = require("./command.js");
+/**
+ * @see https://redis.io/commands/bitcount
+ */
+class BitCountCommand extends command_js_1.Command {
+    constructor(key, start, end) {
+        const command = ["bitcount", key];
+        if (typeof start === "number") {
+            command.push(start);
+        }
+        if (typeof end === "number") {
+            command.push(end);
+        }
+        super(command);
+    }
+}
+exports.BitCountCommand = BitCountCommand;

package/script/pkg/commands/bitop.js

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

package/script/pkg/commands/bitpos.js

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

package/script/pkg/commands/command.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Command = void 0;
+const error_js_1 = require("../error.js");
+const util_js_1 = require("../util.js");
+/**
+ * Command offers default (de)serialization and the exec method to all commands.
+ *
+ * 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.
+ */
+class Command {
+    /**
+     * Create a new command instance.
+     *
+     * You can define a custom `deserialize` function. By default we try to deserialize as json.
+     */
+    constructor(command, opts) {
+        Object.defineProperty(this, "command", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "deserialize", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.command = command.map((c) => typeof c === "string" ? c : JSON.stringify(c));
+        this.deserialize = opts?.deserialize ?? util_js_1.parseResponse;
+    }
+    /**
+     * Execute the command using a client.
+     */
+    async exec(client) {
+        const { result, error } = await client.request({
+            body: this.command,
+        });
+        if (error) {
+            throw new error_js_1.UpstashError(error);
+        }
+        if (typeof result === "undefined") {
+            throw new Error(`Request did not return a result`);
+        }
+        return this.deserialize(result);
+    }
+}
+exports.Command = Command;

package/script/pkg/commands/dbsize.js

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

package/script/pkg/commands/decr.js

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

package/script/pkg/commands/decrby.js

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

package/script/pkg/commands/del.js

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

package/script/pkg/commands/echo.js

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

package/script/pkg/commands/eval.js

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

package/script/pkg/commands/evalsha.js

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

package/script/pkg/commands/exists.js

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

package/script/pkg/commands/expire.js

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

package/script/pkg/commands/expireat.js

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

package/script/pkg/commands/flushall.js

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