@upstash/ratelimit 0.1.0-alpha.0 → 0.1.0

package/README.md

@@ -96,7 +96,10 @@ export type RatelimitResponse = {
 
 In case you don't want to reject a request immediately but wait until it can be
 processed, we also provide
-`ratelimit.blockUntilReady(identifier: stirng, timeout: number): Promise<RatelimitResponse>`
+
+```ts
+ratelimit.blockUntilReady(identifier: string, timeout: number): Promise<RatelimitResponse>
+```
 
 It is very similar to the `limit` method and takes an identifier and returns the
 same response. However if the current limit has already been exceeded, it will

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/mod.js

@@ -0,0 +1,46 @@
+import { HttpClient } from "./pkg/http.js";
+import * as core from "./pkg/redis.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 = new HttpClient({
+            baseUrl: config.url,
+            headers: { authorization: `Bearer ${config.token}` },
+        });
+        super(client, {
+            automaticDeserialization: config.automaticDeserialization,
+        });
+    }
+    /*
+     * Create a new Upstash Redis instance from environment variables on Deno.
+  
+     *
+     */
+    static fromEnv(opts) {
+        /**
+         * These should be injected by Deno.
+         */
+        const url = Deno.env.get("UPSTASH_REDIS_REST_URL");
+        if (!url) {
+            throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_URL`.");
+        }
+        const token = Deno.env.get("UPSTASH_REDIS_REST_TOKEN");
+        if (!token) {
+            throw new Error("Unable to find environment variable: `UPSTASH_REDIS_REST_TOKEN`.");
+        }
+        return new Redis({ url, token, ...opts });
+    }
+}

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/append.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/bitcount.js

@@ -0,0 +1,16 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/bitcount
+ */
+export class BitCountCommand extends Command {
+    constructor([key, start, end], opts) {
+        const command = ["bitcount", key];
+        if (typeof start === "number") {
+            command.push(start);
+        }
+        if (typeof end === "number") {
+            command.push(end);
+        }
+        super(command, opts);
+    }
+}

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/bitop.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/bitpos.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/command.js

@@ -0,0 +1,57 @@
+import { UpstashError } from "../error.js";
+import { parseResponse } from "../util.js";
+const defaultSerializer = (c) => typeof c === "string" ? c : JSON.stringify(c);
+/**
+ * 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 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, "serialize", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "deserialize", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.serialize = defaultSerializer;
+        this.deserialize = typeof opts?.automaticDeserialization === "undefined" ||
+            opts.automaticDeserialization
+            ? opts?.deserialize ?? parseResponse
+            : (x) => x;
+        this.command = command.map(this.serialize);
+    }
+    /**
+     * Execute the command using a client.
+     */
+    async exec(client) {
+        const { result, error } = await client.request({
+            body: this.command,
+        });
+        if (error) {
+            throw new UpstashError(error);
+        }
+        if (typeof result === "undefined") {
+            throw new Error(`Request did not return a result`);
+        }
+        return this.deserialize(result);
+    }
+}

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/dbsize.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/decr.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/decrby.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/del.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/echo.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/eval.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/eval
+ */
+export class EvalCommand extends Command {
+    constructor([script, keys, args], opts) {
+        super(["eval", script, keys.length, ...keys, ...(args ?? [])], opts);
+    }
+}

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/evalsha.js

@@ -0,0 +1,9 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/evalsha
+ */
+export class EvalshaCommand extends Command {
+    constructor([sha, keys, args], opts) {
+        super(["evalsha", sha, keys.length, ...keys, ...(args ?? [])], opts);
+    }
+}

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/exists.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/expire.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/expireat.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/flushall.js

@@ -0,0 +1,13 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/flushall
+ */
+export class FlushAllCommand extends Command {
+    constructor(args, opts) {
+        const command = ["flushall"];
+        if (args && args.length > 0 && args[0].async) {
+            command.push("async");
+        }
+        super(command, opts);
+    }
+}

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/flushdb.js

@@ -0,0 +1,13 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/flushdb
+ */
+export class FlushDBCommand extends Command {
+    constructor([opts], cmdOpts) {
+        const command = ["flushdb"];
+        if (opts?.async) {
+            command.push("async");
+        }
+        super(command, cmdOpts);
+    }
+}

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/get.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/getbit.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/getrange.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/getset.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/hdel.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/hexists.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/hget.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/hgetall.js

@@ -0,0 +1,33 @@
+import { Command } from "./command.js";
+/**
+ * @param result De
+ * @returns
+ */
+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/hgetall
+ */
+export class HGetAllCommand extends Command {
+    constructor(cmd, opts) {
+        super(["hgetall", ...cmd], {
+            deserialize: (result) => deserialize(result),
+            ...opts,
+        });
+    }
+}

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/hincrby.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/hincrbyfloat.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/hkeys.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/hlen.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/hmget.js

@@ -0,0 +1,35 @@
+import { Command } from "./command.js";
+function deserialize(fields, result) {
+    if (result.length === 0 || result.every((field) => field === null)) {
+        return null;
+    }
+    const obj = {};
+    for (let i = 0; i < fields.length; i++) {
+        try {
+            obj[fields[i]] = JSON.parse(result[i]);
+        }
+        catch {
+            obj[fields[i]] = result[i];
+        }
+    }
+    return obj;
+}
+/**
+ * hmget returns an object of all requested fields from a hash
+ * The field values are returned as an object like this:
+ * ```ts
+ * {[fieldName: string]: T | null}
+ * ```
+ *
+ * In case the hash does not exist or all fields are empty `null` is returned
+ *
+ * @see https://redis.io/commands/hmget
+ */
+export class HMGetCommand extends Command {
+    constructor([key, ...fields], opts) {
+        super(["hmget", key, ...fields], {
+            deserialize: (result) => deserialize(fields, result),
+            ...opts,
+        });
+    }
+}

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/hmset.js

@@ -0,0 +1,13 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/hmset
+ */
+export class HMSetCommand extends Command {
+    constructor([key, kv], opts) {
+        super([
+            "hmset",
+            key,
+            ...Object.entries(kv).flatMap(([field, value]) => [field, value]),
+        ], opts);
+    }
+}

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/hscan.js

@@ -0,0 +1,16 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/hscan
+ */
+export class HScanCommand extends Command {
+    constructor([key, cursor, cmdOpts], opts) {
+        const command = ["hscan", key, cursor];
+        if (cmdOpts?.match) {
+            command.push("match", cmdOpts.match);
+        }
+        if (typeof cmdOpts?.count === "number") {
+            command.push("count", cmdOpts.count);
+        }
+        super(command, opts);
+    }
+}

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/hset.js

@@ -0,0 +1,13 @@
+import { Command } from "./command.js";
+/**
+ * @see https://redis.io/commands/hset
+ */
+export class HSetCommand extends Command {
+    constructor([key, kv], opts) {
+        super([
+            "hset",
+            key,
+            ...Object.entries(kv).flatMap(([field, value]) => [field, value]),
+        ], opts);
+    }
+}

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/hsetnx.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/hstrlen.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/hvals.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/incr.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/incrby.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/incrbyfloat.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/keys.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/lindex.js

@@ -0,0 +1,6 @@
+import { Command } from "./command.js";
+export class LIndexCommand extends Command {
+    constructor(cmd, opts) {
+        super(["lindex", ...cmd], opts);
+    }
+}

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/linsert.js

@@ -0,0 +1,6 @@
+import { Command } from "./command.js";
+export class LInsertCommand extends Command {
+    constructor(cmd, opts) {
+        super(["linsert", ...cmd], opts);
+    }
+}

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/llen.js

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/pkg/commands/lpop.js

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