@discordjs/rest 2.2.1-dev.1705968584-bfc7bb556 → 2.3.0-dev.1706616235-278396e81

package/dist/index.d.mts

@@ -112,7 +112,7 @@ interface RESTOptions {
      *
      * @defaultValue `50`
      */
-    offset: number;
+    offset: GetRateLimitOffsetFunction | number;
     /**
      * Determines how rate limiting and pre-emptive throttling should be handled.
      * When an array of strings, each element is treated as a prefix for the request route
@@ -210,6 +210,10 @@ interface RateLimitData {
  * A function that determines whether the rate limit hit should throw an Error
  */
 type RateLimitQueueFilter = (rateLimitData: RateLimitData) => Awaitable<boolean>;
+/**
+ * A function that determines the rate limit offset for a given request.
+ */
+type GetRateLimitOffsetFunction = (route: string) => number;
 interface APIRequest {
     /**
      * The data that was used to form the body of this request
@@ -897,4 +901,4 @@ declare function calculateUserDefaultAvatarIndex(userId: Snowflake): number;
  */
 declare const version: string;
 
-export { ALLOWED_EXTENSIONS, ALLOWED_SIZES, ALLOWED_STICKER_EXTENSIONS, APIRequest, BaseImageURLOptions, BurstHandlerMajorIdKey, CDN, DEPRECATION_WARNING_PREFIX, DefaultRestOptions, DefaultUserAgent, DefaultUserAgentAppendix, DiscordAPIError, DiscordErrorData, HTTPError, HandlerRequestData, HashData, ImageExtension, ImageSize, ImageURLOptions, InternalRequest, InvalidRequestWarningData, MakeURLOptions, OAuthErrorData, OverwrittenMimeTypes, REST, RESTEvents, RESTOptions, RateLimitData, RateLimitError, RateLimitQueueFilter, RawFile, RequestBody, RequestData, RequestHeaders, RequestMethod, ResponseLike, RestEvents, RestEventsMap, RouteData, RouteLike, StickerExtension, calculateUserDefaultAvatarIndex, makeURLSearchParams, parseResponse, version };
+export { ALLOWED_EXTENSIONS, ALLOWED_SIZES, ALLOWED_STICKER_EXTENSIONS, APIRequest, BaseImageURLOptions, BurstHandlerMajorIdKey, CDN, DEPRECATION_WARNING_PREFIX, DefaultRestOptions, DefaultUserAgent, DefaultUserAgentAppendix, DiscordAPIError, DiscordErrorData, GetRateLimitOffsetFunction, HTTPError, HandlerRequestData, HashData, ImageExtension, ImageSize, ImageURLOptions, InternalRequest, InvalidRequestWarningData, MakeURLOptions, OAuthErrorData, OverwrittenMimeTypes, REST, RESTEvents, RESTOptions, RateLimitData, RateLimitError, RateLimitQueueFilter, RawFile, RequestBody, RequestData, RequestHeaders, RequestMethod, ResponseLike, RestEvents, RestEventsMap, RouteData, RouteLike, StickerExtension, calculateUserDefaultAvatarIndex, makeURLSearchParams, parseResponse, version };

package/dist/index.d.ts

@@ -112,7 +112,7 @@ interface RESTOptions {
      *
      * @defaultValue `50`
      */
-    offset: number;
+    offset: GetRateLimitOffsetFunction | number;
     /**
      * Determines how rate limiting and pre-emptive throttling should be handled.
      * When an array of strings, each element is treated as a prefix for the request route
@@ -210,6 +210,10 @@ interface RateLimitData {
  * A function that determines whether the rate limit hit should throw an Error
  */
 type RateLimitQueueFilter = (rateLimitData: RateLimitData) => Awaitable<boolean>;
+/**
+ * A function that determines the rate limit offset for a given request.
+ */
+type GetRateLimitOffsetFunction = (route: string) => number;
 interface APIRequest {
     /**
      * The data that was used to form the body of this request
@@ -897,4 +901,4 @@ declare function calculateUserDefaultAvatarIndex(userId: Snowflake): number;
  */
 declare const version: string;
 
-export { ALLOWED_EXTENSIONS, ALLOWED_SIZES, ALLOWED_STICKER_EXTENSIONS, APIRequest, BaseImageURLOptions, BurstHandlerMajorIdKey, CDN, DEPRECATION_WARNING_PREFIX, DefaultRestOptions, DefaultUserAgent, DefaultUserAgentAppendix, DiscordAPIError, DiscordErrorData, HTTPError, HandlerRequestData, HashData, ImageExtension, ImageSize, ImageURLOptions, InternalRequest, InvalidRequestWarningData, MakeURLOptions, OAuthErrorData, OverwrittenMimeTypes, REST, RESTEvents, RESTOptions, RateLimitData, RateLimitError, RateLimitQueueFilter, RawFile, RequestBody, RequestData, RequestHeaders, RequestMethod, ResponseLike, RestEvents, RestEventsMap, RouteData, RouteLike, StickerExtension, calculateUserDefaultAvatarIndex, makeURLSearchParams, parseResponse, version };
+export { ALLOWED_EXTENSIONS, ALLOWED_SIZES, ALLOWED_STICKER_EXTENSIONS, APIRequest, BaseImageURLOptions, BurstHandlerMajorIdKey, CDN, DEPRECATION_WARNING_PREFIX, DefaultRestOptions, DefaultUserAgent, DefaultUserAgentAppendix, DiscordAPIError, DiscordErrorData, GetRateLimitOffsetFunction, HTTPError, HandlerRequestData, HashData, ImageExtension, ImageSize, ImageURLOptions, InternalRequest, InvalidRequestWarningData, MakeURLOptions, OAuthErrorData, OverwrittenMimeTypes, REST, RESTEvents, RESTOptions, RateLimitData, RateLimitError, RateLimitQueueFilter, RawFile, RequestBody, RequestData, RequestHeaders, RequestMethod, ResponseLike, RestEvents, RestEventsMap, RouteData, RouteLike, StickerExtension, calculateUserDefaultAvatarIndex, makeURLSearchParams, parseResponse, version };

package/dist/index.js

@@ -124,7 +124,7 @@ __name(resolveBody, "resolveBody");
 // src/lib/utils/constants.ts
 var import_util = require("@discordjs/util");
 var import_v10 = require("discord-api-types/v10");
-var DefaultUserAgent = `DiscordBot (https://discord.js.org, 2.2.1-dev.1705968584-bfc7bb556)`;
+var DefaultUserAgent = `DiscordBot (https://discord.js.org, 2.3.0-dev.1706616235-278396e81)`;
 var DefaultUserAgentAppendix = (0, import_util.getUserAgentAppendix)();
 var DefaultRestOptions = {
   agent: null,
@@ -321,6 +321,14 @@ function deprecationWarning(message) {
   }
 }
 __name(deprecationWarning, "deprecationWarning");
+function normalizeRateLimitOffset(offset, route) {
+  if (typeof offset === "number") {
+    return Math.max(0, offset);
+  }
+  const result = offset(route);
+  return Math.max(0, result);
+}
+__name(normalizeRateLimitOffset, "normalizeRateLimitOffset");
 
 // src/lib/CDN.ts
 var deprecationEmittedForEmoji = false;
@@ -782,8 +790,9 @@ var BurstHandler = class {
     const status = res.status;
     let retryAfter = 0;
     const retry = res.headers.get("Retry-After");
+    const offset = normalizeRateLimitOffset(this.manager.options.offset, routeId.bucketRoute);
     if (retry)
-      retryAfter = Number(retry) * 1e3 + this.manager.options.offset;
+      retryAfter = Number(retry) * 1e3 + offset;
     if (status === 401 || status === 403 || status === 429) {
       incrementInvalidCount(this.manager);
     }
@@ -908,8 +917,9 @@ var SequentialHandler = class {
   /**
    * The time until queued requests can continue
    */
-  get timeToReset() {
-    return this.reset + this.manager.options.offset - Date.now();
+  getTimeToReset(routeId) {
+    const offset = normalizeRateLimitOffset(this.manager.options.offset, routeId.bucketRoute);
+    return this.reset + offset - Date.now();
   }
   /**
    * Emits a debug message
@@ -979,15 +989,16 @@ var SequentialHandler = class {
       let timeout;
       let delay;
       if (isGlobal) {
+        const offset2 = normalizeRateLimitOffset(this.manager.options.offset, routeId.bucketRoute);
         limit2 = this.manager.options.globalRequestsPerSecond;
-        timeout = this.manager.globalReset + this.manager.options.offset - Date.now();
+        timeout = this.manager.globalReset + offset2 - Date.now();
         if (!this.manager.globalDelay) {
           this.manager.globalDelay = this.globalDelayFor(timeout);
         }
         delay = this.manager.globalDelay;
       } else {
         limit2 = this.limit;
-        timeout = this.timeToReset;
+        timeout = this.getTimeToReset(routeId);
         delay = sleep(timeout);
       }
       const rateLimitData = {
@@ -1030,11 +1041,12 @@ var SequentialHandler = class {
     const hash = res.headers.get("X-RateLimit-Bucket");
     const retry = res.headers.get("Retry-After");
     const scope = res.headers.get("X-RateLimit-Scope") ?? "user";
+    const offset = normalizeRateLimitOffset(this.manager.options.offset, routeId.bucketRoute);
     this.limit = limit ? Number(limit) : Number.POSITIVE_INFINITY;
     this.remaining = remaining ? Number(remaining) : 1;
-    this.reset = reset ? Number(reset) * 1e3 + Date.now() + this.manager.options.offset : Date.now();
+    this.reset = reset ? Number(reset) * 1e3 + Date.now() + offset : Date.now();
     if (retry)
-      retryAfter = Number(retry) * 1e3 + this.manager.options.offset;
+      retryAfter = Number(retry) * 1e3 + offset;
     if (hash && hash !== this.hash) {
       this.debug(["Received bucket hash update", `  Old Hash  : ${this.hash}`, `  New Hash  : ${hash}`].join("\n"));
       this.manager.hashes.set(`${method}:${routeId.bucketRoute}`, { value: hash, lastAccess: Date.now() });
@@ -1063,11 +1075,12 @@ var SequentialHandler = class {
       let limit2;
       let timeout;
       if (isGlobal) {
+        const offset2 = normalizeRateLimitOffset(this.manager.options.offset, routeId.bucketRoute);
         limit2 = this.manager.options.globalRequestsPerSecond;
-        timeout = this.manager.globalReset + this.manager.options.offset - Date.now();
+        timeout = this.manager.globalReset + offset2 - Date.now();
       } else {
         limit2 = this.limit;
-        timeout = this.timeToReset;
+        timeout = this.getTimeToReset(routeId);
       }
       await onRateLimit(this.manager, {
         global: isGlobal,
@@ -1165,7 +1178,6 @@ var REST = class _REST extends import_async_event_emitter.AsyncEventEmitter {
     super();
     this.cdn = new CDN(options.cdn ?? DefaultRestOptions.cdn);
     this.options = { ...DefaultRestOptions, ...options };
-    this.options.offset = Math.max(0, this.options.offset);
     this.globalRemaining = Math.max(1, this.options.globalRequestsPerSecond);
     this.agent = options.agent ?? null;
     this.setupSweepers();
@@ -1442,7 +1454,7 @@ var REST = class _REST extends import_async_event_emitter.AsyncEventEmitter {
 };
 
 // src/shared.ts
-var version = "2.2.1-dev.1705968584-bfc7bb556";
+var version = "2.3.0-dev.1706616235-278396e81";
 
 // src/index.ts
 globalThis.FormData ??= import_undici2.FormData;