@discordjs/rest 3.0.0-dev.1757116903-f7c77a73d → 3.0.0-dev.1757505703-f1bcff46b

package/dist/index.d.mts

@@ -136,12 +136,18 @@ interface RESTOptions {
      * @defaultValue `3`
      */
     retries: number;
+    /**
+     * The time to exponentially add before retrying a 5xx or aborted request
+     *
+     * @defaultValue `0`
+     */
+    retryBackoff: GetRetryBackoffFunction | number;
     /**
      * The time to wait in milliseconds before a request is aborted
      *
      * @defaultValue `15_000`
      */
-    timeout: number;
+    timeout: GetTimeoutFunction | number;
     /**
      * Extra information to add to the user agent
      *
@@ -221,6 +227,23 @@ type RateLimitQueueFilter = (rateLimitData: RateLimitData) => Awaitable<boolean>
  * A function that determines the rate limit offset for a given request.
  */
 type GetRateLimitOffsetFunction = (route: string) => number;
+/**
+ * A function that determines the backoff for a retry for a given request.
+ *
+ * @param route - The route that has encountered a server-side error
+ * @param statusCode - The status code received or `null` if aborted
+ * @param retryCount - The number of retries that have been attempted so far. The first call will be `0`
+ * @param requestBody - The body that was sent with the request
+ * @returns The delay for the current request or `null` to throw an error instead of retrying
+ */
+type GetRetryBackoffFunction = (route: string, statusCode: number | null, retryCount: number, requestBody: unknown) => number | null;
+/**
+ * A function that determines the timeout for a given request.
+ *
+ * @param route - The route that is being processed
+ * @param body - The body that will be sent with the request
+ */
+type GetTimeoutFunction = (route: string, body: unknown) => number;
 interface APIRequest {
     /**
      * The data that was used to form the body of this request
@@ -413,6 +436,7 @@ declare const DefaultRestOptions: {
     readonly offset: 50;
     readonly rejectOnRateLimit: null;
     readonly retries: 3;
+    readonly retryBackoff: 0;
     readonly timeout: 15000;
     readonly userAgentAppendix: string;
     readonly version: "10";
@@ -925,4 +949,4 @@ declare function calculateUserDefaultAvatarIndex(userId: Snowflake): number;
  */
 declare const version: string;
 
-export { ALLOWED_EXTENSIONS, ALLOWED_SIZES, ALLOWED_STICKER_EXTENSIONS, type APIRequest, AUTH_UUID_NAMESPACE, type AuthData, type BaseImageURLOptions, BurstHandlerMajorIdKey, CDN, type CDNOptions, DefaultRestOptions, DefaultUserAgent, DefaultUserAgentAppendix, DiscordAPIError, type DiscordError, type DiscordErrorData, type DiscordErrorFieldInformation, type DiscordErrorGroupWrapper, type EmojiURLOptions, type EmojiURLOptionsNotWebp, type EmojiURLOptionsWebp, type GetRateLimitOffsetFunction, HTTPError, type HandlerRequestData, type HashData, type IHandler, type ImageExtension, type ImageURLOptions, type InternalRequest, type InvalidRequestWarningData, type OAuthErrorData, OverwrittenMimeTypes, REST, RESTEvents, type RESTOptions, type RateLimitData, RateLimitError, type RateLimitQueueFilter, type RawFile, type RequestBody, type RequestData, type RequestHeaders, RequestMethod, type ResponseLike, type RestEvents, type RestEventsMap, type RouteData, type RouteLike, type StickerExtension, calculateUserDefaultAvatarIndex, makeURLSearchParams, parseResponse, version };
+export { ALLOWED_EXTENSIONS, ALLOWED_SIZES, ALLOWED_STICKER_EXTENSIONS, type APIRequest, AUTH_UUID_NAMESPACE, type AuthData, type BaseImageURLOptions, BurstHandlerMajorIdKey, CDN, type CDNOptions, DefaultRestOptions, DefaultUserAgent, DefaultUserAgentAppendix, DiscordAPIError, type DiscordError, type DiscordErrorData, type DiscordErrorFieldInformation, type DiscordErrorGroupWrapper, type EmojiURLOptions, type EmojiURLOptionsNotWebp, type EmojiURLOptionsWebp, type GetRateLimitOffsetFunction, type GetRetryBackoffFunction, type GetTimeoutFunction, HTTPError, type HandlerRequestData, type HashData, type IHandler, type ImageExtension, type ImageURLOptions, type InternalRequest, type InvalidRequestWarningData, type OAuthErrorData, OverwrittenMimeTypes, REST, RESTEvents, type RESTOptions, type RateLimitData, RateLimitError, type RateLimitQueueFilter, type RawFile, type RequestBody, type RequestData, type RequestHeaders, RequestMethod, type ResponseLike, type RestEvents, type RestEventsMap, type RouteData, type RouteLike, type StickerExtension, calculateUserDefaultAvatarIndex, makeURLSearchParams, parseResponse, version };

package/dist/index.d.ts

@@ -136,12 +136,18 @@ interface RESTOptions {
      * @defaultValue `3`
      */
     retries: number;
+    /**
+     * The time to exponentially add before retrying a 5xx or aborted request
+     *
+     * @defaultValue `0`
+     */
+    retryBackoff: GetRetryBackoffFunction | number;
     /**
      * The time to wait in milliseconds before a request is aborted
      *
      * @defaultValue `15_000`
      */
-    timeout: number;
+    timeout: GetTimeoutFunction | number;
     /**
      * Extra information to add to the user agent
      *
@@ -221,6 +227,23 @@ type RateLimitQueueFilter = (rateLimitData: RateLimitData) => Awaitable<boolean>
  * A function that determines the rate limit offset for a given request.
  */
 type GetRateLimitOffsetFunction = (route: string) => number;
+/**
+ * A function that determines the backoff for a retry for a given request.
+ *
+ * @param route - The route that has encountered a server-side error
+ * @param statusCode - The status code received or `null` if aborted
+ * @param retryCount - The number of retries that have been attempted so far. The first call will be `0`
+ * @param requestBody - The body that was sent with the request
+ * @returns The delay for the current request or `null` to throw an error instead of retrying
+ */
+type GetRetryBackoffFunction = (route: string, statusCode: number | null, retryCount: number, requestBody: unknown) => number | null;
+/**
+ * A function that determines the timeout for a given request.
+ *
+ * @param route - The route that is being processed
+ * @param body - The body that will be sent with the request
+ */
+type GetTimeoutFunction = (route: string, body: unknown) => number;
 interface APIRequest {
     /**
      * The data that was used to form the body of this request
@@ -413,6 +436,7 @@ declare const DefaultRestOptions: {
     readonly offset: 50;
     readonly rejectOnRateLimit: null;
     readonly retries: 3;
+    readonly retryBackoff: 0;
     readonly timeout: 15000;
     readonly userAgentAppendix: string;
     readonly version: "10";
@@ -925,4 +949,4 @@ declare function calculateUserDefaultAvatarIndex(userId: Snowflake): number;
  */
 declare const version: string;
 
-export { ALLOWED_EXTENSIONS, ALLOWED_SIZES, ALLOWED_STICKER_EXTENSIONS, type APIRequest, AUTH_UUID_NAMESPACE, type AuthData, type BaseImageURLOptions, BurstHandlerMajorIdKey, CDN, type CDNOptions, DefaultRestOptions, DefaultUserAgent, DefaultUserAgentAppendix, DiscordAPIError, type DiscordError, type DiscordErrorData, type DiscordErrorFieldInformation, type DiscordErrorGroupWrapper, type EmojiURLOptions, type EmojiURLOptionsNotWebp, type EmojiURLOptionsWebp, type GetRateLimitOffsetFunction, HTTPError, type HandlerRequestData, type HashData, type IHandler, type ImageExtension, type ImageURLOptions, type InternalRequest, type InvalidRequestWarningData, type OAuthErrorData, OverwrittenMimeTypes, REST, RESTEvents, type RESTOptions, type RateLimitData, RateLimitError, type RateLimitQueueFilter, type RawFile, type RequestBody, type RequestData, type RequestHeaders, RequestMethod, type ResponseLike, type RestEvents, type RestEventsMap, type RouteData, type RouteLike, type StickerExtension, calculateUserDefaultAvatarIndex, makeURLSearchParams, parseResponse, version };
+export { ALLOWED_EXTENSIONS, ALLOWED_SIZES, ALLOWED_STICKER_EXTENSIONS, type APIRequest, AUTH_UUID_NAMESPACE, type AuthData, type BaseImageURLOptions, BurstHandlerMajorIdKey, CDN, type CDNOptions, DefaultRestOptions, DefaultUserAgent, DefaultUserAgentAppendix, DiscordAPIError, type DiscordError, type DiscordErrorData, type DiscordErrorFieldInformation, type DiscordErrorGroupWrapper, type EmojiURLOptions, type EmojiURLOptionsNotWebp, type EmojiURLOptionsWebp, type GetRateLimitOffsetFunction, type GetRetryBackoffFunction, type GetTimeoutFunction, HTTPError, type HandlerRequestData, type HashData, type IHandler, type ImageExtension, type ImageURLOptions, type InternalRequest, type InvalidRequestWarningData, type OAuthErrorData, OverwrittenMimeTypes, REST, RESTEvents, type RESTOptions, type RateLimitData, RateLimitError, type RateLimitQueueFilter, type RawFile, type RequestBody, type RequestData, type RequestHeaders, RequestMethod, type ResponseLike, type RestEvents, type RestEventsMap, type RouteData, type RouteLike, type StickerExtension, calculateUserDefaultAvatarIndex, makeURLSearchParams, parseResponse, version };

package/dist/index.js

@@ -139,7 +139,7 @@ var import_v102 = require("discord-api-types/v10");
 // 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, 3.0.0-dev.1757116903-f7c77a73d)`;
+var DefaultUserAgent = `DiscordBot (https://discord.js.org, 3.0.0-dev.1757505703-f1bcff46b)`;
 var DefaultUserAgentAppendix = (0, import_util.getUserAgentAppendix)();
 var DefaultRestOptions = {
   agent: null,
@@ -152,6 +152,7 @@ var DefaultRestOptions = {
   offset: 50,
   rejectOnRateLimit: null,
   retries: 3,
+  retryBackoff: 0,
   timeout: 15e3,
   userAgentAppendix: DefaultUserAgentAppendix,
   version: import_v10.APIVersion,
@@ -681,6 +682,21 @@ function normalizeRateLimitOffset(offset, route) {
   return Math.max(0, result);
 }
 __name(normalizeRateLimitOffset, "normalizeRateLimitOffset");
+function normalizeRetryBackoff(retryBackoff, route, statusCode, retryCount, requestBody) {
+  if (typeof retryBackoff === "number") {
+    return Math.max(0, retryBackoff) * (1 << retryCount);
+  }
+  return retryBackoff(route, statusCode, retryCount, requestBody);
+}
+__name(normalizeRetryBackoff, "normalizeRetryBackoff");
+function normalizeTimeout(timeout, route, requestBody) {
+  if (typeof timeout === "number") {
+    return Math.max(0, timeout);
+  }
+  const result = timeout(route, requestBody);
+  return Math.max(0, result);
+}
+__name(normalizeTimeout, "normalizeTimeout");
 
 // src/lib/handlers/Shared.ts
 var authFalseWarningEmitted = false;
@@ -703,7 +719,10 @@ function incrementInvalidCount(manager) {
 __name(incrementInvalidCount, "incrementInvalidCount");
 async function makeNetworkRequest(manager, routeId, url, options, requestData, retries) {
   const controller = new AbortController();
-  const timeout = setTimeout(() => controller.abort(), manager.options.timeout);
+  const timeout = setTimeout(
+    () => controller.abort(),
+    normalizeTimeout(manager.options.timeout, routeId.bucketRoute, requestData.body)
+  );
   if (requestData.signal) {
     if (requestData.signal.aborted) controller.abort();
     else requestData.signal.addEventListener("abort", () => controller.abort());
@@ -714,6 +733,19 @@ async function makeNetworkRequest(manager, routeId, url, options, requestData, r
   } catch (error) {
     if (!(error instanceof Error)) throw error;
     if (shouldRetry(error) && retries !== manager.options.retries) {
+      const backoff = normalizeRetryBackoff(
+        manager.options.retryBackoff,
+        routeId.bucketRoute,
+        null,
+        retries,
+        requestData.body
+      );
+      if (backoff === null) {
+        throw error;
+      }
+      if (backoff > 0) {
+        await sleep(backoff);
+      }
       return null;
     }
     throw error;
@@ -737,10 +769,23 @@ async function makeNetworkRequest(manager, routeId, url, options, requestData, r
   return res;
 }
 __name(makeNetworkRequest, "makeNetworkRequest");
-async function handleErrors(manager, res, method, url, requestData, retries) {
+async function handleErrors(manager, res, method, url, requestData, retries, routeId) {
   const status = res.status;
   if (status >= 500 && status < 600) {
     if (retries !== manager.options.retries) {
+      const backoff = normalizeRetryBackoff(
+        manager.options.retryBackoff,
+        routeId.bucketRoute,
+        status,
+        retries,
+        requestData.body
+      );
+      if (backoff === null) {
+        throw new HTTPError(status, res.statusText, method, url, requestData);
+      }
+      if (backoff > 0) {
+        await sleep(backoff);
+      }
       return null;
     }
     throw new HTTPError(status, res.statusText, method, url, requestData);
@@ -864,7 +909,7 @@ var BurstHandler = class {
       await sleep(retryAfter);
       return this.runRequest(routeId, url, options, requestData, retries);
     } else {
-      const handled = await handleErrors(this.manager, res, method, url, requestData, retries);
+      const handled = await handleErrors(this.manager, res, method, url, requestData, retries, routeId);
       if (handled === null) {
         return this.runRequest(routeId, url, options, requestData, ++retries);
       }
@@ -1166,7 +1211,7 @@ var SequentialHandler = class {
       }
       return this.runRequest(routeId, url, options, requestData, retries);
     } else {
-      const handled = await handleErrors(this.manager, res, method, url, requestData, retries);
+      const handled = await handleErrors(this.manager, res, method, url, requestData, retries, routeId);
       if (handled === null) {
         return this.runRequest(routeId, url, options, requestData, ++retries);
       }
@@ -1495,7 +1540,7 @@ var REST = class _REST extends import_async_event_emitter.AsyncEventEmitter {
 };
 
 // src/shared.ts
-var version = "3.0.0-dev.1757116903-f7c77a73d";
+var version = "3.0.0-dev.1757505703-f1bcff46b";
 
 // src/index.ts
 setDefaultStrategy((0, import_util2.shouldUseGlobalFetchAndWebSocket)() ? fetch : makeRequest);