@upstash/redis 1.3.0 → 1.3.2-alpha.1

package/script/pkg/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/script/pkg/util.js

@@ -0,0 +1,35 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseResponse = void 0;
+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;
+}
+function parseResponse(result) {
+    try {
+        /**
+         * Try to parse the response if possible
+         */
+        return parseRecursive(result);
+    }
+    catch {
+        return result;
+    }
+}
+exports.parseResponse = parseResponse;

package/script/platforms/cloudflare.js

@@ -0,0 +1,97 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Redis = void 0;
+const core = __importStar(require("../pkg/redis.js"));
+const error_js_1 = require("../pkg/error.js");
+/**
+ * Serverless redis client for upstash.
+ */
+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 });
+    }
+}
+exports.Redis = Redis;
+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 error_js_1.UpstashError(body.error);
+            }
+            return body;
+        },
+    };
+}

package/script/platforms/fastly.js

@@ -0,0 +1,76 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Redis = void 0;
+const core = __importStar(require("../pkg/redis.js"));
+const error_js_1 = require("../pkg/error.js");
+/**
+ * Serverless redis client for upstash.
+ */
+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);
+    }
+}
+exports.Redis = Redis;
+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 error_js_1.UpstashError(body.error);
+            }
+            return body;
+        },
+    };
+}

package/script/platforms/nodejs.js

@@ -0,0 +1,96 @@
+"use strict";
+// deno-lint-ignore-file
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Redis = void 0;
+const core = __importStar(require("../pkg/redis.js"));
+const error_js_1 = require("../pkg/error.js");
+require("isomorphic-fetch");
+/**
+ * Serverless redis client for upstash.
+ */
+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 });
+    }
+}
+exports.Redis = Redis;
+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 error_js_1.UpstashError(body.error);
+            }
+            return body;
+        },
+    };
+}

package/script/platforms/vercel.js

@@ -0,0 +1,95 @@
+"use strict";
+// deno-lint-ignore-file
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Redis = void 0;
+const core = __importStar(require("../pkg/redis.js"));
+const error_js_1 = require("../pkg/error.js");
+/**
+ * Serverless redis client for upstash.
+ */
+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 });
+    }
+}
+exports.Redis = Redis;
+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 error_js_1.UpstashError(body.error);
+            }
+            return body;
+        },
+    };
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/append
+ */
+export declare class AppendCommand extends Command<number, number> {
+    constructor(key: string, value: string);
+}

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

@@ -0,0 +1,8 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/bitcount
+ */
+export declare class BitCountCommand extends Command<number, number> {
+    constructor(key: string, start?: never, end?: never);
+    constructor(key: string, start: number, end: number);
+}

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

@@ -0,0 +1,8 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/bitop
+ */
+export declare class BitOpCommand extends Command<number, number> {
+    constructor(op: "and" | "or" | "xor", destinationKey: string, sourceKey: string, ...sourceKeys: string[]);
+    constructor(op: "not", destinationKey: string, sourceKey: string);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/bitpos
+ */
+export declare class BitPosCommand extends Command<number, number> {
+    constructor(key: string, start: number, end: number);
+}

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

@@ -0,0 +1,23 @@
+import { Requester } from "../http.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.
+ */
+export declare class Command<TData, TResult> {
+    readonly command: string[];
+    deserialize: (result: TResult) => TData;
+    /**
+     * Create a new command instance.
+     *
+     * You can define a custom `deserialize` function. By default we try to deserialize as json.
+     */
+    constructor(command: (string | unknown)[], opts?: {
+        deserialize?: (result: TResult) => TData;
+    });
+    /**
+     * Execute the command using a client.
+     */
+    exec(client: Requester): Promise<TData>;
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/dbsize
+ */
+export declare class DBSizeCommand extends Command<number, number> {
+    constructor();
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/decr
+ */
+export declare class DecrCommand extends Command<number, number> {
+    constructor(key: string);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/decrby
+ */
+export declare class DecrByCommand extends Command<number, number> {
+    constructor(key: string, decrement: number);
+}

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

@@ -0,0 +1,8 @@
+import { NonEmptyArray } from "../types.js";
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/del
+ */
+export declare class DelCommand extends Command<number, number> {
+    constructor(...keys: NonEmptyArray<string>);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/echo
+ */
+export declare class EchoCommand extends Command<string, string> {
+    constructor(message: string);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/eval
+ */
+export declare class EvalCommand<TArgs extends unknown[], TData> extends Command<unknown, TData> {
+    constructor(script: string, keys: string[], args: TArgs);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/evalsha
+ */
+export declare class EvalshaCommand<TArgs extends unknown[], TData> extends Command<unknown, TData> {
+    constructor(sha: string, keys: string[], args?: TArgs);
+}

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

@@ -0,0 +1,8 @@
+import { NonEmptyArray } from "../types.js";
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/exists
+ */
+export declare class ExistsCommand extends Command<number, number> {
+    constructor(...keys: NonEmptyArray<string>);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/expire
+ */
+export declare class ExpireCommand extends Command<0 | 1, "0" | "1"> {
+    constructor(key: string, seconds: number);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/expireat
+ */
+export declare class ExpireAtCommand extends Command<0 | 1, "0" | "1"> {
+    constructor(key: string, unix: number);
+}

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

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/flushall
+ */
+export declare class FlushAllCommand extends Command<"OK", "OK"> {
+    constructor(opts?: {
+        async?: boolean;
+    });
+}

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

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/flushdb
+ */
+export declare class FlushDBCommand extends Command<"OK", "OK"> {
+    constructor(opts?: {
+        async?: boolean;
+    });
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/get
+ */
+export declare class GetCommand<TData = string> extends Command<TData | null, unknown | null> {
+    constructor(key: string);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/getbit
+ */
+export declare class GetBitCommand extends Command<0 | 1, "0" | "1"> {
+    constructor(key: string, offset: number);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/getrange
+ */
+export declare class GetRangeCommand extends Command<string, string> {
+    constructor(key: string, start: number, end: number);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/getset
+ */
+export declare class GetSetCommand<TData = string> extends Command<TData | null, unknown | null> {
+    constructor(key: string, value: TData);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/hdel
+ */
+export declare class HDelCommand extends Command<0 | 1, "0" | "1"> {
+    constructor(key: string, field: string);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/hexists
+ */
+export declare class HExistsCommand extends Command<number, number> {
+    constructor(key: string, field: string);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/hget
+ */
+export declare class HGetCommand<TData> extends Command<TData | null, unknown | null> {
+    constructor(key: string, field: string);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/hgetall
+ */
+export declare class HGetAllCommand<TData extends Record<string, unknown>> extends Command<TData | null, unknown | null> {
+    constructor(key: string);
+}

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

@@ -0,0 +1,7 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/hincrby
+ */
+export declare class HIncrByCommand extends Command<number, number> {
+    constructor(key: string, field: string, increment: number);
+}