@upstash/ratelimit 1.2.1 → 2.0.0

package/dist/index.mjs

@@ -560,6 +560,14 @@ var Ratelimit = class {
     const pattern = [this.prefix, identifier].join(":");
     await this.limiter().resetTokens(this.ctx, pattern);
   };
+  /**
+   * Returns the remaining token count together with a reset timestamps
+   * 
+   * @param identifier identifir to check
+   * @returns object with `remaining` and reset fields. `remaining` denotes
+   *          the remaining tokens and reset denotes the timestamp when the
+   *          tokens reset.
+   */
   getRemaining = async (identifier) => {
     const pattern = [this.prefix, identifier].join(":");
     return await this.limiter().getRemaining(this.ctx, pattern);
@@ -844,7 +852,10 @@ var MultiRegionRatelimit = class extends Ratelimit {
           }
           return accTokens + parsedToken;
         }, 0);
-        return Math.max(0, tokens - usedTokens);
+        return {
+          remaining: Math.max(0, tokens - usedTokens),
+          reset: (bucket + 1) * windowDuration
+        };
       },
       async resetTokens(ctx, identifier) {
         const pattern = [identifier, "*"].join(":");
@@ -1006,7 +1017,10 @@ var MultiRegionRatelimit = class extends Ratelimit {
           )
         }));
         const usedTokens = await Promise.any(dbs.map((s) => s.request));
-        return Math.max(0, tokens - usedTokens);
+        return {
+          remaining: Math.max(0, tokens - usedTokens),
+          reset: (currentWindow + 1) * windowSize
+        };
       },
       async resetTokens(ctx, identifier) {
         const pattern = [identifier, "*"].join(":");
@@ -1145,17 +1159,18 @@ var tokenBucketLimitScript = `
   redis.call("PEXPIRE", key, expireAt)
   return {remaining, refilledAt + interval}
 `;
+var tokenBucketIdentifierNotFound = -1;
 var tokenBucketRemainingTokensScript = `
   local key         = KEYS[1]
   local maxTokens   = tonumber(ARGV[1])
         
-  local bucket = redis.call("HMGET", key, "tokens")
+  local bucket = redis.call("HMGET", key, "refilledAt", "tokens")
 
   if bucket[1] == false then
-    return maxTokens
+    return {maxTokens, ${tokenBucketIdentifierNotFound}}
   end
         
-  return tonumber(bucket[1])
+  return {tonumber(bucket[2]), tonumber(bucket[1])}
 `;
 var cachedFixedWindowLimitScript = `
   local key     = KEYS[1]
@@ -1272,7 +1287,10 @@ var RegionRatelimit = class extends Ratelimit {
           [key],
           [null]
         );
-        return Math.max(0, tokens - usedTokens);
+        return {
+          remaining: Math.max(0, tokens - usedTokens),
+          reset: (bucket + 1) * windowDuration
+        };
       },
       async resetTokens(ctx, identifier) {
         const pattern = [identifier, "*"].join(":");
@@ -1361,7 +1379,10 @@ var RegionRatelimit = class extends Ratelimit {
           [currentKey, previousKey],
           [now, windowSize]
         );
-        return Math.max(0, tokens - usedTokens);
+        return {
+          remaining: Math.max(0, tokens - usedTokens),
+          reset: (currentWindow + 1) * windowSize
+        };
       },
       async resetTokens(ctx, identifier) {
         const pattern = [identifier, "*"].join(":");
@@ -1430,14 +1451,19 @@ var RegionRatelimit = class extends Ratelimit {
         };
       },
       async getRemaining(ctx, identifier) {
-        const remainingTokens = await safeEval(
+        const [remainingTokens, refilledAt] = await safeEval(
           ctx,
           tokenBucketRemainingTokensScript,
           "getRemainingHash",
           [identifier],
           [maxTokens]
         );
-        return remainingTokens;
+        const freshRefillAt = Date.now() + intervalDuration;
+        const identifierRefillsAt = refilledAt + intervalDuration;
+        return {
+          remaining: remainingTokens,
+          reset: refilledAt === tokenBucketIdentifierNotFound ? freshRefillAt : identifierRefillsAt
+        };
       },
       async resetTokens(ctx, identifier) {
         const pattern = identifier;
@@ -1534,7 +1560,10 @@ var RegionRatelimit = class extends Ratelimit {
         const hit = typeof ctx.cache.get(key) === "number";
         if (hit) {
           const cachedUsedTokens = ctx.cache.get(key) ?? 0;
-          return Math.max(0, tokens - cachedUsedTokens);
+          return {
+            remaining: Math.max(0, tokens - cachedUsedTokens),
+            reset: (bucket + 1) * windowDuration
+          };
         }
         const usedTokens = await safeEval(
           ctx,
@@ -1543,7 +1572,10 @@ var RegionRatelimit = class extends Ratelimit {
           [key],
           [null]
         );
-        return Math.max(0, tokens - usedTokens);
+        return {
+          remaining: Math.max(0, tokens - usedTokens),
+          reset: (bucket + 1) * windowDuration
+        };
       },
       async resetTokens(ctx, identifier) {
         if (!ctx.cache) {