@upstash/ratelimit 0.1.0-alpha.0 → 0.1.0

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

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

package/esm/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/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/ratelimiter.js

@@ -130,6 +130,26 @@ export class Ratelimit {
         this.limiter = config.limiter;
         this.prefix = config.prefix ?? "@upstash/ratelimit";
     }
+    // EXPERIMENTAL
+    // static eventualWrite(tokens: number, window: Duration): Ratelimiter {
+    //   const windowDuration = ms(window);
+    //   return async function (ctx: Context, identifier: string) {
+    //     const bucket = Math.floor(Date.now() / windowDuration);
+    //     const key = [identifier, bucket].join(":");
+    //     const usedTokensAfterUpdate = (await ctx.redis.get<number>(key)) ?? 1;
+    //     ctx.redis.incr(key).then((res) => {
+    //       if (res === 1) {
+    //         ctx.redis.expire(key, windowDuration);
+    //       }
+    //     });
+    //     return {
+    //       success: usedTokensAfterUpdate <= tokens,
+    //       limit: tokens,
+    //       remaining: tokens - usedTokensAfterUpdate,
+    //       reset: (bucket + 1) * windowDuration,
+    //     };
+    //   };
+    // }
     /**
      * Each requests inside a fixed time increases a counter.
      * Once the counter reaches a maxmimum allowed number, all further requests are
@@ -183,54 +203,6 @@ export class Ratelimit {
             };
         };
     }
-    // /**
-    //  * For each request all past requests in the last `{window}` are summed up and
-    //  * if they exceed `{tokens}`, the request will be rejected.
-    //  *
-    //  * **Pro:**
-    //  *
-    //  * Does not have the problem of `fixedWindow` at the window boundaries.
-    //  *
-    //  * **Con:**
-    //  *
-    //  * More expensive to store and compute, which makes this unsuitable for apis
-    //  * with very high traffic.
-    //  *
-    //  * @param window - The duration in which the user can max X requests.
-    //  * @param tokens - How many requests a user can make in each time window.
-    //  */
-    // static slidingLogs(window: Duration, tokens: number): Ratelimiter {
-    //   const script = `
-    //   local key         = KEYS[1] -- identifier including prefixes
-    //   local windowStart = ARGV[1] -- timestamp of window start
-    //   local windowEnd   = ARGV[2] -- timestamp of window end
-    //   local tokens      = ARGV[3] -- tokens per window
-    //   local now         = ARGV[4] -- current timestamp
-    //   local count = redis.call("ZCOUNT", key, windowStart, windowEnd)
-    //   if count < tonumber(tokens) then
-    //     -- Log the current request
-    //     redis.call("ZADD", key, now, now)
-    //     -- Remove all previous requests that are outside the window
-    //     redis.call("ZREMRANGEBYSCORE", key, "-inf", windowStart - 1)
-    //   end
-    //   return count
-    //   `;
-    //   return async function (ctx: Context, identifier: string) {
-    //     const windowEnd = Date.now();
-    //     const windowStart = windowEnd - ms(window);
-    //     const count = (await ctx.redis.eval(
-    //       script,
-    //       [identifier],
-    //       [windowStart, windowEnd, tokens, Date.now()]
-    //     )) as number;
-    //     return {
-    //       success: count < tokens,
-    //       limit: tokens,
-    //       remaining: Math.max(0, tokens - count - 1),
-    //       reset: windowEnd,
-    //     };
-    //   };
-    // }
     /**
      * Combined approach of `slidingLogs` and `fixedWindow` with lower storage
      * costs than `slidingLogs` and improved boundary behavior by calcualting a

package/esm/types.js

@@ -1 +1,2 @@
-export {};
+import { Redis } from "./deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/mod.js";
+export { Redis };

package/package.json

@@ -3,7 +3,7 @@
   "main": "./script/mod.js",
   "types": "./types/mod.d.ts",
   "name": "@upstash/ratelimit",
-  "version": "v0.1.0-alpha.0",
+  "version": "v0.1.0",
   "description": "A serverless ratelimiter built on top of Upstash REST API.",
   "repository": {
     "type": "git",
@@ -34,11 +34,11 @@
   "size-limit": [
     {
       "path": "esm/mod.js",
-      "limit": "2 KB"
+      "limit": "15 KB"
     },
     {
       "path": "script/mod.js",
-      "limit": "52 KB"
+      "limit": "15 KB"
     }
   ],
   "exports": {

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

@@ -0,0 +1,73 @@
+"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 http_js_1 = require("./pkg/http.js");
+const core = __importStar(require("./pkg/redis.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 = new http_js_1.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 });
+    }
+}
+exports.Redis = Redis;

package/script/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/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(cmd, opts) {
+        super(["append", ...cmd], opts);
+    }
+}
+exports.AppendCommand = AppendCommand;

package/script/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/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], opts) {
+        const command = ["bitcount", key];
+        if (typeof start === "number") {
+            command.push(start);
+        }
+        if (typeof end === "number") {
+            command.push(end);
+        }
+        super(command, opts);
+    }
+}
+exports.BitCountCommand = BitCountCommand;

package/script/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/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(cmd, opts) {
+        super(["bitop", ...cmd], opts);
+    }
+}
+exports.BitOpCommand = BitOpCommand;

package/script/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/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(cmd, opts) {
+        super(["bitpos", ...cmd], opts);
+    }
+}
+exports.BitPosCommand = BitPosCommand;

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

@@ -0,0 +1,61 @@
+"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");
+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.
+ */
+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 ?? util_js_1.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 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/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/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(opts) {
+        super(["dbsize"], opts);
+    }
+}
+exports.DBSizeCommand = DBSizeCommand;

package/script/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/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(cmd, opts) {
+        super(["decr", ...cmd], opts);
+    }
+}
+exports.DecrCommand = DecrCommand;

package/script/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/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(cmd, opts) {
+        super(["decrby", ...cmd], opts);
+    }
+}
+exports.DecrByCommand = DecrByCommand;

package/script/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/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(cmd, opts) {
+        super(["del", ...cmd], opts);
+    }
+}
+exports.DelCommand = DelCommand;

package/script/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/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(cmd, opts) {
+        super(["echo", ...cmd], opts);
+    }
+}
+exports.EchoCommand = EchoCommand;

package/script/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/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], opts) {
+        super(["eval", script, keys.length, ...keys, ...(args ?? [])], opts);
+    }
+}
+exports.EvalCommand = EvalCommand;

package/script/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/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], opts) {
+        super(["evalsha", sha, keys.length, ...keys, ...(args ?? [])], opts);
+    }
+}
+exports.EvalshaCommand = EvalshaCommand;

package/script/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/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(cmd, opts) {
+        super(["exists", ...cmd], opts);
+    }
+}
+exports.ExistsCommand = ExistsCommand;

package/script/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/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(cmd, opts) {
+        super(["expire", ...cmd], opts);
+    }
+}
+exports.ExpireCommand = ExpireCommand;

package/script/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/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(cmd, opts) {
+        super(["expireat", ...cmd], opts);
+    }
+}
+exports.ExpireAtCommand = ExpireAtCommand;

package/script/deps/deno.land/x/upstash_redis@v1.3.3-alpha.1/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(args, opts) {
+        const command = ["flushall"];
+        if (args && args.length > 0 && args[0].async) {
+            command.push("async");
+        }
+        super(command, opts);
+    }
+}
+exports.FlushAllCommand = FlushAllCommand;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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