@upstash/ratelimit 0.2.0 → 0.3.0-canary.0

package/esm/ratelimit.js

@@ -1,171 +0,0 @@
-import { Cache } from "./cache.js";
-export class TimeoutError extends Error {
-    constructor() {
-        super("Timeout");
-        this.name = "TimeoutError";
-    }
-}
-/**
- * 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 class Ratelimit {
-    constructor(config) {
-        Object.defineProperty(this, "limiter", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "ctx", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "prefix", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "timeout", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        /**
-         * 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"
-         * ```
-         */
-        Object.defineProperty(this, "limit", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: async (identifier) => {
-                const key = [this.prefix, identifier].join(":");
-                let timeoutId = null;
-                try {
-                    const arr = [this.limiter(this.ctx, key)];
-                    if (this.timeout) {
-                        arr.push(new Promise((resolve) => {
-                            timeoutId = setTimeout(() => {
-                                resolve({
-                                    success: true,
-                                    limit: 0,
-                                    remaining: 0,
-                                    reset: 0,
-                                    pending: Promise.resolve(),
-                                });
-                            }, this.timeout);
-                        }));
-                    }
-                    return await Promise.race(arr);
-                }
-                finally {
-                    if (timeoutId) {
-                        clearTimeout(timeoutId);
-                    }
-                }
-            }
-        });
-        /**
-         * 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"
-         * ```
-         */
-        Object.defineProperty(this, "blockUntilReady", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: async (
-            /**
-             * An identifier per user or api.
-             * Choose a userID, or api token, or ip address.
-             *
-             * If you want to limit your api across all users, you can set a constant string.
-             */
-            identifier, 
-            /**
-             * Maximum duration to wait in milliseconds.
-             * After this time the request will be denied.
-             */
-            timeout) => {
-                if (timeout <= 0) {
-                    throw new Error("timeout must be positive");
-                }
-                let res;
-                const deadline = Date.now() + timeout;
-                while (true) {
-                    res = await this.limit(identifier);
-                    if (res.success) {
-                        break;
-                    }
-                    if (res.reset === 0) {
-                        throw new Error("This should not happen");
-                    }
-                    const wait = Math.min(res.reset, deadline) - Date.now();
-                    await new Promise((r) => setTimeout(r, wait));
-                    if (Date.now() > deadline) {
-                        break;
-                    }
-                }
-                return res;
-            }
-        });
-        this.ctx = config.ctx;
-        this.limiter = config.limiter;
-        this.timeout = config.timeout;
-        this.prefix = config.prefix ?? "@upstash/ratelimit";
-        if (config.ephemeralCache instanceof Map) {
-            this.ctx.cache = new Cache(config.ephemeralCache);
-        }
-        else if (typeof config.ephemeralCache === "undefined") {
-            this.ctx.cache = new Cache(new Map());
-        }
-    }
-}

package/esm/single.js

@@ -1,375 +0,0 @@
-import { ms } from "./duration.js";
-import { Ratelimit } from "./ratelimit.js";
-/**
- * Ratelimiter using serverless redis from https://upstash.com/
- *
- * @example
- * ```ts
- * const { limit } = new Ratelimit({
- *    redis: Redis.fromEnv(),
- *    limiter: Ratelimit.slidingWindow(
- *      "30 m", // interval of 30 minutes
- *      10,     // Allow 10 requests per window of 30 minutes
- *    )
- * })
- *
- * ```
- */
-export class RegionRatelimit extends Ratelimit {
-    /**
-     * Create a new Ratelimit instance by providing a `@upstash/redis` instance and the algorithn of your choice.
-     */
-    constructor(config) {
-        super({
-            prefix: config.prefix,
-            limiter: config.limiter,
-            timeout: config.timeout,
-            ctx: {
-                redis: config.redis,
-            },
-            ephemeralCache: config.ephemeralCache,
-        });
-    }
-    /**
-     * Each requests inside a fixed time increases a counter.
-     * Once the counter reaches a maxmimum allowed number, all further requests are
-     * rejected.
-     *
-     * **Pro:**
-     *
-     * - Newer requests are not starved by old ones.
-     * - Low storage cost.
-     *
-     * **Con:**
-     *
-     * A burst of requests near the boundary of a window can result in a very
-     * high request rate because two windows will be filled with requests quickly.
-     *
-     * @param tokens - How many requests a user can make in each time window.
-     * @param window - A fixed timeframe
-     */
-    static fixedWindow(
-    /**
-     * How many requests are allowed per window.
-     */
-    tokens, 
-    /**
-     * The duration in which `tokens` requests are allowed.
-     */
-    window) {
-        const windowDuration = ms(window);
-        const script = `
-    local key     = KEYS[1]
-    local window  = ARGV[1]
-    
-    local r = redis.call("INCR", key)
-    if r == 1 then 
-    -- The first time this key is set, the value will be 1.
-    -- So we only need the expire command once
-    redis.call("PEXPIRE", key, window)
-    end
-    
-    return r
-    `;
-        return async function (ctx, identifier) {
-            const bucket = Math.floor(Date.now() / windowDuration);
-            const key = [identifier, bucket].join(":");
-            if (ctx.cache) {
-                const { blocked, reset } = ctx.cache.isBlocked(identifier);
-                if (blocked) {
-                    return {
-                        success: false,
-                        limit: tokens,
-                        remaining: 0,
-                        reset: reset,
-                        pending: Promise.resolve(),
-                    };
-                }
-            }
-            const usedTokensAfterUpdate = (await ctx.redis.eval(script, [key], [windowDuration]));
-            const success = usedTokensAfterUpdate <= tokens;
-            const reset = (bucket + 1) * windowDuration;
-            if (ctx.cache && !success) {
-                ctx.cache.blockUntil(identifier, reset);
-            }
-            return {
-                success,
-                limit: tokens,
-                remaining: tokens - usedTokensAfterUpdate,
-                reset,
-                pending: Promise.resolve(),
-            };
-        };
-    }
-    /**
-     * Combined approach of `slidingLogs` and `fixedWindow` with lower storage
-     * costs than `slidingLogs` and improved boundary behavior by calcualting a
-     * weighted score between two windows.
-     *
-     * **Pro:**
-     *
-     * Good performance allows this to scale to very high loads.
-     *
-     * **Con:**
-     *
-     * Nothing major.
-     *
-     * @param tokens - How many requests a user can make in each time window.
-     * @param window - The duration in which the user can max X requests.
-     */
-    static slidingWindow(
-    /**
-     * How many requests are allowed per window.
-     */
-    tokens, 
-    /**
-     * The duration in which `tokens` requests are allowed.
-     */
-    window) {
-        const script = `
-      local currentKey  = KEYS[1]           -- identifier including prefixes
-      local previousKey = KEYS[2]           -- key of the previous bucket
-      local tokens      = tonumber(ARGV[1]) -- tokens per window
-      local now         = ARGV[2]           -- current timestamp in milliseconds
-      local window      = ARGV[3]           -- interval in milliseconds
-
-      local requestsInCurrentWindow = redis.call("GET", currentKey)
-      if requestsInCurrentWindow == false then
-        requestsInCurrentWindow = 0
-      end
-
-
-      local requestsInPreviousWindow = redis.call("GET", previousKey)
-      if requestsInPreviousWindow == false then
-        requestsInPreviousWindow = 0
-      end
-      local percentageInCurrent = ( now % window) / window
-      if requestsInPreviousWindow * ( 1 - percentageInCurrent ) + requestsInCurrentWindow >= tokens then
-        return 0
-      end
-
-      local newValue = redis.call("INCR", currentKey)
-      if newValue == 1 then 
-        -- The first time this key is set, the value will be 1.
-        -- So we only need the expire command once
-        redis.call("PEXPIRE", currentKey, window * 2 + 1000) -- Enough time to overlap with a new window + 1 second
-      end
-      return tokens - newValue
-      `;
-        const windowSize = ms(window);
-        return async function (ctx, identifier) {
-            const now = Date.now();
-            const currentWindow = Math.floor(now / windowSize);
-            const currentKey = [identifier, currentWindow].join(":");
-            const previousWindow = currentWindow - windowSize;
-            const previousKey = [identifier, previousWindow].join(":");
-            if (ctx.cache) {
-                const { blocked, reset } = ctx.cache.isBlocked(identifier);
-                if (blocked) {
-                    return {
-                        success: false,
-                        limit: tokens,
-                        remaining: 0,
-                        reset: reset,
-                        pending: Promise.resolve(),
-                    };
-                }
-            }
-            const remaining = (await ctx.redis.eval(script, [currentKey, previousKey], [tokens, now, windowSize]));
-            const success = remaining > 0;
-            const reset = (currentWindow + 1) * windowSize;
-            if (ctx.cache && !success) {
-                ctx.cache.blockUntil(identifier, reset);
-            }
-            return {
-                success,
-                limit: tokens,
-                remaining,
-                reset,
-                pending: Promise.resolve(),
-            };
-        };
-    }
-    /**
-     * You have a bucket filled with `{maxTokens}` tokens that refills constantly
-     * at `{refillRate}` per `{interval}`.
-     * Every request will remove one token from the bucket and if there is no
-     * token to take, the request is rejected.
-     *
-     * **Pro:**
-     *
-     * - Bursts of requests are smoothed out and you can process them at a constant
-     * rate.
-     * - Allows to set a higher initial burst limit by setting `maxTokens` higher
-     * than `refillRate`
-     */
-    static tokenBucket(
-    /**
-     * How many tokens are refilled per `interval`
-     *
-     * An interval of `10s` and refillRate of 5 will cause a new token to be added every 2 seconds.
-     */
-    refillRate, 
-    /**
-     * The interval for the `refillRate`
-     */
-    interval, 
-    /**
-     * Maximum number of tokens.
-     * A newly created bucket starts with this many tokens.
-     * Useful to allow higher burst limits.
-     */
-    maxTokens) {
-        const script = `
-        local key         = KEYS[1]           -- identifier including prefixes
-        local maxTokens   = tonumber(ARGV[1]) -- maximum number of tokens
-        local interval    = tonumber(ARGV[2]) -- size of the window in milliseconds
-        local refillRate  = tonumber(ARGV[3]) -- how many tokens are refilled after each interval
-        local now         = tonumber(ARGV[4]) -- current timestamp in milliseconds
-        local remaining   = 0
-        
-        local bucket = redis.call("HMGET", key, "updatedAt", "tokens")
-        
-        if bucket[1] == false then
-          -- The bucket does not exist yet, so we create it and add a ttl.
-          remaining = maxTokens - 1
-          
-          redis.call("HMSET", key, "updatedAt", now, "tokens", remaining)
-          redis.call("PEXPIRE", key, interval)
-  
-          return {remaining, now + interval}
-        end
-
-        -- The bucket does exist
-  
-        local updatedAt = tonumber(bucket[1])
-        local tokens = tonumber(bucket[2])
-  
-        if now >= updatedAt + interval then
-          remaining = math.min(maxTokens, tokens + refillRate) - 1
-          
-          redis.call("HMSET", key, "updatedAt", now, "tokens", remaining)
-          return {remaining, now + interval}
-        end
-  
-        if tokens > 0 then
-          remaining = tokens - 1
-          redis.call("HMSET", key, "updatedAt", now, "tokens", remaining)
-        end
-  
-        return {remaining, updatedAt + interval}
-       `;
-        const intervalDuration = ms(interval);
-        return async function (ctx, identifier) {
-            if (ctx.cache) {
-                const { blocked, reset } = ctx.cache.isBlocked(identifier);
-                if (blocked) {
-                    return {
-                        success: false,
-                        limit: maxTokens,
-                        remaining: 0,
-                        reset: reset,
-                        pending: Promise.resolve(),
-                    };
-                }
-            }
-            const now = Date.now();
-            const key = [identifier, Math.floor(now / intervalDuration)].join(":");
-            const [remaining, reset] = (await ctx.redis.eval(script, [key], [maxTokens, intervalDuration, refillRate, now]));
-            const success = remaining > 0;
-            if (ctx.cache && !success) {
-                ctx.cache.blockUntil(identifier, reset);
-            }
-            return {
-                success,
-                limit: maxTokens,
-                remaining,
-                reset,
-                pending: Promise.resolve(),
-            };
-        };
-    }
-    /**
-     * cachedFixedWindow first uses the local cache to decide if a request may pass and then updates
-     * it asynchronously.
-     * This is experimental and not yet recommended for production use.
-     *
-     * @experimental
-     *
-     * Each requests inside a fixed time increases a counter.
-     * Once the counter reaches a maxmimum allowed number, all further requests are
-     * rejected.
-     *
-     * **Pro:**
-     *
-     * - Newer requests are not starved by old ones.
-     * - Low storage cost.
-     *
-     * **Con:**
-     *
-     * A burst of requests near the boundary of a window can result in a very
-     * high request rate because two windows will be filled with requests quickly.
-     *
-     * @param tokens - How many requests a user can make in each time window.
-     * @param window - A fixed timeframe
-     */
-    static cachedFixedWindow(
-    /**
-     * How many requests are allowed per window.
-     */
-    tokens, 
-    /**
-     * The duration in which `tokens` requests are allowed.
-     */
-    window) {
-        const windowDuration = ms(window);
-        const script = `
-      local key     = KEYS[1]
-      local window  = ARGV[1]
-      
-      local r = redis.call("INCR", key)
-      if r == 1 then 
-      -- The first time this key is set, the value will be 1.
-      -- So we only need the expire command once
-      redis.call("PEXPIRE", key, window)
-      end
-      
-      return r
-      `;
-        return async function (ctx, identifier) {
-            if (!ctx.cache) {
-                throw new Error("This algorithm requires a cache");
-            }
-            const bucket = Math.floor(Date.now() / windowDuration);
-            const key = [identifier, bucket].join(":");
-            const reset = (bucket + 1) * windowDuration;
-            const hit = typeof ctx.cache.get(key) === "number";
-            if (hit) {
-                const cachedTokensAfterUpdate = ctx.cache.incr(key);
-                const success = cachedTokensAfterUpdate < tokens;
-                const pending = success
-                    ? ctx.redis.eval(script, [key], [windowDuration]).then((t) => {
-                        ctx.cache.set(key, t);
-                    })
-                    : Promise.resolve();
-                return {
-                    success,
-                    limit: tokens,
-                    remaining: tokens - cachedTokensAfterUpdate,
-                    reset: reset,
-                    pending,
-                };
-            }
-            const usedTokensAfterUpdate = (await ctx.redis.eval(script, [key], [windowDuration]));
-            ctx.cache.set(key, usedTokensAfterUpdate);
-            const remaining = tokens - usedTokensAfterUpdate;
-            return {
-                success: remaining >= 0,
-                limit: tokens,
-                remaining,
-                reset: reset,
-                pending: Promise.resolve(),
-            };
-        };
-    }
-}

package/esm/types.js

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

package/script/_dnt.shims.js

@@ -1,66 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.dntGlobalThis = exports.crypto = void 0;
-const shim_crypto_1 = require("@deno/shim-crypto");
-var shim_crypto_2 = require("@deno/shim-crypto");
-Object.defineProperty(exports, "crypto", { enumerable: true, get: function () { return shim_crypto_2.crypto; } });
-const dntGlobals = {
-    crypto: shim_crypto_1.crypto,
-};
-exports.dntGlobalThis = createMergeProxy(globalThis, dntGlobals);
-// deno-lint-ignore ban-types
-function createMergeProxy(baseObj, extObj) {
-    return new Proxy(baseObj, {
-        get(_target, prop, _receiver) {
-            if (prop in extObj) {
-                return extObj[prop];
-            }
-            else {
-                return baseObj[prop];
-            }
-        },
-        set(_target, prop, value) {
-            if (prop in extObj) {
-                delete extObj[prop];
-            }
-            baseObj[prop] = value;
-            return true;
-        },
-        deleteProperty(_target, prop) {
-            let success = false;
-            if (prop in extObj) {
-                delete extObj[prop];
-                success = true;
-            }
-            if (prop in baseObj) {
-                delete baseObj[prop];
-                success = true;
-            }
-            return success;
-        },
-        ownKeys(_target) {
-            const baseKeys = Reflect.ownKeys(baseObj);
-            const extKeys = Reflect.ownKeys(extObj);
-            const extKeysSet = new Set(extKeys);
-            return [...baseKeys.filter((k) => !extKeysSet.has(k)), ...extKeys];
-        },
-        defineProperty(_target, prop, desc) {
-            if (prop in extObj) {
-                delete extObj[prop];
-            }
-            Reflect.defineProperty(baseObj, prop, desc);
-            return true;
-        },
-        getOwnPropertyDescriptor(_target, prop) {
-            if (prop in extObj) {
-                return Reflect.getOwnPropertyDescriptor(extObj, prop);
-            }
-            else {
-                return Reflect.getOwnPropertyDescriptor(baseObj, prop);
-            }
-        },
-        has(_target, prop) {
-            return prop in extObj || prop in baseObj;
-        },
-    });
-}

package/script/cache.js

@@ -1,44 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Cache = void 0;
-class Cache {
-    constructor(cache) {
-        /**
-         * Stores identifier -> reset (in milliseconds)
-         */
-        Object.defineProperty(this, "cache", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.cache = cache;
-    }
-    isBlocked(identifier) {
-        if (!this.cache.has(identifier)) {
-            return { blocked: false, reset: 0 };
-        }
-        const reset = this.cache.get(identifier);
-        if (reset < Date.now()) {
-            this.cache.delete(identifier);
-            return { blocked: false, reset: 0 };
-        }
-        return { blocked: true, reset: reset };
-    }
-    blockUntil(identifier, reset) {
-        this.cache.set(identifier, reset);
-    }
-    set(key, value) {
-        this.cache.set(key, value);
-    }
-    get(key) {
-        return this.cache.get(key) || null;
-    }
-    incr(key) {
-        let value = this.cache.get(key) ?? 0;
-        value += 1;
-        this.cache.set(key, value);
-        return value;
-    }
-}
-exports.Cache = Cache;

package/script/duration.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ms = void 0;
-/**
- * Convert a human readable duration to milliseconds
- */
-function ms(d) {
-    const [timeString, duration] = d.split(" ");
-    const time = parseFloat(timeString);
-    switch (duration) {
-        case "ms":
-            return time;
-        case "s":
-            return time * 1000;
-        case "m":
-            return time * 1000 * 60;
-        case "h":
-            return time * 1000 * 60 * 60;
-        case "d":
-            return time * 1000 * 60 * 60 * 24;
-        default:
-            throw new Error(`Unable to parse window size: ${d}`);
-    }
-}
-exports.ms = ms;

package/script/mod.js

@@ -1,7 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.MultiRegionRatelimit = exports.Ratelimit = void 0;
-var single_js_1 = require("./single.js");
-Object.defineProperty(exports, "Ratelimit", { enumerable: true, get: function () { return single_js_1.RegionRatelimit; } });
-var multi_js_1 = require("./multi.js");
-Object.defineProperty(exports, "MultiRegionRatelimit", { enumerable: true, get: function () { return multi_js_1.MultiRegionRatelimit; } });