@upstash/ratelimit 0.1.0 → 0.1.1

package/types/ratelimit.d.ts

@@ -0,0 +1,85 @@
+import type { Algorithm, Context, RatelimitResponse } from "./types.js";
+export declare type RatelimitConfig<TContext> = {
+    /**
+     * The ratelimiter function to use.
+     *
+     * Choose one of the predefined ones or implement your own.
+     * Available algorithms are exposed via static methods:
+     * - Ratelimiter.fixedWindow
+     * - Ratelimiter.slidingLogs
+     * - Ratelimiter.slidingWindow
+     * - Ratelimiter.tokenBucket
+     */
+    limiter: Algorithm<TContext>;
+    ctx: TContext;
+    /**
+     * All keys in redis are prefixed with this.
+     *
+     * @default `@upstash/ratelimit`
+     */
+    prefix?: string;
+};
+/**
+ * Ratelimiter using serverless redis from https://upstash.com/
+ *
+ * @example
+ * ```ts
+ * const { limit } = new Ratelimit({
+ *    redis: Redis.fromEnv(),
+ *    limiter: Ratelimit.slidingWindow(
+ *      10,     // Allow 10 requests per window of 30 minutes
+ *      "30 m", // interval of 30 minutes
+ *    )
+ * })
+ *
+ * ```
+ */
+export declare abstract class Ratelimit<TContext extends Context> {
+    protected readonly limiter: Algorithm<TContext>;
+    protected readonly ctx: TContext;
+    protected readonly prefix: string;
+    constructor(config: RatelimitConfig<TContext>);
+    /**
+     * Determine if a request should pass or be rejected based on the identifier and previously chosen ratelimit.
+     *
+     * Use this if you want to reject all requests that you can not handle right now.
+     *
+     * @example
+     * ```ts
+     *  const ratelimit = new Ratelimit({
+     *    redis: Redis.fromEnv(),
+     *    limiter: Ratelimit.slidingWindow(10, "10 s")
+     *  })
+     *
+     *  const { success } = await ratelimit.limit(id)
+     *  if (!success){
+     *    return "Nope"
+     *  }
+     *  return "Yes"
+     * ```
+     */
+    limit: (identifier: string) => Promise<RatelimitResponse>;
+    /**
+     * Block until the request may pass or timeout is reached.
+     *
+     * This method returns a promsie that resolves as soon as the request may be processed
+     * or after the timeoue has been reached.
+     *
+     * Use this if you want to delay the request until it is ready to get processed.
+     *
+     * @example
+     * ```ts
+     *  const ratelimit = new Ratelimit({
+     *    redis: Redis.fromEnv(),
+     *    limiter: Ratelimit.slidingWindow(10, "10 s")
+     *  })
+     *
+     *  const { success } = await ratelimit.blockUntilReady(id, 60_000)
+     *  if (!success){
+     *    return "Nope"
+     *  }
+     *  return "Yes"
+     * ```
+     */
+    blockUntilReady: (identifier: string, timeout: number) => Promise<RatelimitResponse>;
+}

package/types/{ratelimiter.d.ts → region.d.ts}

@@ -1,6 +1,8 @@
 import type { Duration } from "./duration.js";
-import type { Ratelimiter, RatelimitResponse, Redis } from "./types.js";
-export declare type RatelimitConfig = {
+import type { Algorithm, RegionContext } from "./types.js";
+import type { Redis } from "./types.js";
+import { Ratelimit } from "./ratelimit.js";
+export declare type RegionRatelimitConfig = {
     /**
      * Instance of `@upstash/redis`
      * @see https://github.com/upstash/upstash-redis#quick-start
@@ -16,7 +18,7 @@ export declare type RatelimitConfig = {
      * - Ratelimiter.slidingWindow
      * - Ratelimiter.tokenBucket
      */
-    limiter: Ratelimiter;
+    limiter: Algorithm<RegionContext>;
     /**
      * All keys in redis are prefixed with this.
      *
@@ -39,57 +41,11 @@ export declare type RatelimitConfig = {
  *
  * ```
  */
-export declare class Ratelimit {
-    private readonly redis;
-    private readonly limiter;
-    private readonly prefix;
+export declare class RegionRatelimit extends Ratelimit<RegionContext> {
     /**
      * Create a new Ratelimit instance by providing a `@upstash/redis` instance and the algorithn of your choice.
      */
-    constructor(config: RatelimitConfig);
-    /**
-     * Determine if a request should pass or be rejected based on the identifier and previously chosen ratelimit.
-     *
-     * Use this if you want to reject all requests that you can not handle right now.
-     *
-     * @example
-     * ```ts
-     *  const ratelimit = new Ratelimit({
-     *    redis: Redis.fromEnv(),
-     *    limiter: Ratelimit.slidingWindow(10, "10 s")
-     *  })
-     *
-     *  const { success } = await ratelimit.limit(id)
-     *  if (!success){
-     *    return "Nope"
-     *  }
-     *  return "Yes"
-     * ```
-     */
-    limit: (identifier: string) => Promise<RatelimitResponse>;
-    /**
-     * Block until the request may pass or timeout is reached.
-     *
-     * This method returns a promsie that resolves as soon as the request may be processed
-     * or after the timeoue has been reached.
-     *
-     * Use this if you want to delay the request until it is ready to get processed.
-     *
-     * @example
-     * ```ts
-     *  const ratelimit = new Ratelimit({
-     *    redis: Redis.fromEnv(),
-     *    limiter: Ratelimit.slidingWindow(10, "10 s")
-     *  })
-     *
-     *  const { success } = await ratelimit.blockUntilReady(id, 60_000)
-     *  if (!success){
-     *    return "Nope"
-     *  }
-     *  return "Yes"
-     * ```
-     */
-    blockUntilReady: (identifier: string, timeout: number) => Promise<RatelimitResponse>;
+    constructor(config: RegionRatelimitConfig);
     /**
      * Each requests inside a fixed time increases a counter.
      * Once the counter reaches a maxmimum allowed number, all further requests are
@@ -116,7 +72,7 @@ export declare class Ratelimit {
     /**
      * The duration in which `tokens` requests are allowed.
      */
-    window: Duration): Ratelimiter;
+    window: Duration): Algorithm<RegionContext>;
     /**
      * Combined approach of `slidingLogs` and `fixedWindow` with lower storage
      * costs than `slidingLogs` and improved boundary behavior by calcualting a
@@ -141,7 +97,7 @@ export declare class Ratelimit {
     /**
      * The duration in which `tokens` requests are allowed.
      */
-    window: Duration): Ratelimiter;
+    window: Duration): Algorithm<RegionContext>;
     /**
      * You have a bucket filled with `{maxTokens}` tokens that refills constantly
      * at `{refillRate}` per `{interval}`.
@@ -173,5 +129,5 @@ export declare class Ratelimit {
      * A newly created bucket starts with this many tokens.
      * Useful to allow higher burst limits.
      */
-    maxTokens: number): Ratelimiter;
+    maxTokens: number): Algorithm<RegionContext>;
 }

package/types/types.d.ts

@@ -1,8 +1,14 @@
-import { Redis } from "./deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/mod.js";
-export { Redis };
-export declare type Context = {
+export interface Redis {
+    eval: (script: string, keys: string[], values: unknown[]) => Promise<unknown>;
+    sadd: (key: string, ...members: string[]) => Promise<number>;
+}
+export declare type RegionContext = {
     redis: Redis;
 };
+export declare type GlobalContext = {
+    redis: Redis[];
+};
+export declare type Context = RegionContext | GlobalContext;
 export declare type RatelimitResponse = {
     /**
      * Whether the request may pass(true) or exceeded the limit(false)
@@ -21,4 +27,4 @@ export declare type RatelimitResponse = {
      */
     reset: number;
 };
-export declare type Ratelimiter = (ctx: Context, identifier: string) => Promise<RatelimitResponse>;
+export declare type Algorithm<TContext> = (ctx: TContext, identifier: string) => Promise<RatelimitResponse>;

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

@@ -1,46 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,16 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,57 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,13 +0,0 @@
-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

@@ -1,13 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,33 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

@@ -1,9 +0,0 @@
-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

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