@discordjs/rest 2.1.1-dev.1700006959-cab60142f → 2.2.0-dev.1700136223-6df233de1

package/dist/index.d.mts

@@ -184,6 +184,13 @@ interface RateLimitData {
      * The route being hit in this request
      */
     route: string;
+    /**
+     * The scope of the rate limit that was hit.
+     *
+     * This can be `user` for rate limits that are per client, `global` for rate limits that affect all clients or `shared` for rate limits that
+     * are shared per resource.
+     */
+    scope: 'global' | 'shared' | 'user';
     /**
      * The time, in milliseconds, that will need to pass before the sublimit lock for the route resets, and requests that fall under a sublimit
      * can be retried
@@ -728,7 +735,8 @@ declare class RateLimitError extends Error implements RateLimitData {
     global: boolean;
     retryAfter: number;
     sublimitTimeout: number;
-    constructor({ timeToReset, limit, method, hash, url, route, majorParameter, global, retryAfter, sublimitTimeout, }: RateLimitData);
+    scope: RateLimitData['scope'];
+    constructor({ timeToReset, limit, method, hash, url, route, majorParameter, global, retryAfter, sublimitTimeout, scope, }: RateLimitData);
     /**
      * The name of the error
      */

package/dist/index.d.ts

@@ -184,6 +184,13 @@ interface RateLimitData {
      * The route being hit in this request
      */
     route: string;
+    /**
+     * The scope of the rate limit that was hit.
+     *
+     * This can be `user` for rate limits that are per client, `global` for rate limits that affect all clients or `shared` for rate limits that
+     * are shared per resource.
+     */
+    scope: 'global' | 'shared' | 'user';
     /**
      * The time, in milliseconds, that will need to pass before the sublimit lock for the route resets, and requests that fall under a sublimit
      * can be retried
@@ -728,7 +735,8 @@ declare class RateLimitError extends Error implements RateLimitData {
     global: boolean;
     retryAfter: number;
     sublimitTimeout: number;
-    constructor({ timeToReset, limit, method, hash, url, route, majorParameter, global, retryAfter, sublimitTimeout, }: RateLimitData);
+    scope: RateLimitData['scope'];
+    constructor({ timeToReset, limit, method, hash, url, route, majorParameter, global, retryAfter, sublimitTimeout, scope, }: RateLimitData);
     /**
      * The name of the error
      */

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.1.1-dev.1700006959-cab60142f)`;
+var DefaultUserAgent = `DiscordBot (https://discord.js.org, 2.2.0-dev.1700136223-6df233de1)`;
 var DefaultUserAgentAppendix = (0, import_util.getUserAgentAppendix)();
 var DefaultRestOptions = {
   agent: null,
@@ -184,6 +184,7 @@ var RateLimitError = class _RateLimitError extends Error {
   global;
   retryAfter;
   sublimitTimeout;
+  scope;
   constructor({
     timeToReset,
     limit,
@@ -194,7 +195,8 @@ var RateLimitError = class _RateLimitError extends Error {
     majorParameter,
     global,
     retryAfter,
-    sublimitTimeout
+    sublimitTimeout,
+    scope
   }) {
     super();
     this.timeToReset = timeToReset;
@@ -207,6 +209,7 @@ var RateLimitError = class _RateLimitError extends Error {
     this.global = global;
     this.retryAfter = retryAfter;
     this.sublimitTimeout = sublimitTimeout;
+    this.scope = scope;
   }
   /**
    * The name of the error
@@ -788,6 +791,7 @@ var BurstHandler = class {
       return res;
     } else if (status === 429) {
       const isGlobal = res.headers.has("X-RateLimit-Global");
+      const scope = res.headers.get("X-RateLimit-Scope") ?? "user";
       await onRateLimit(this.manager, {
         global: isGlobal,
         method,
@@ -798,7 +802,8 @@ var BurstHandler = class {
         limit: Number.POSITIVE_INFINITY,
         timeToReset: retryAfter,
         retryAfter,
-        sublimitTimeout: 0
+        sublimitTimeout: 0,
+        scope
       });
       this.debug(
         [
@@ -811,7 +816,8 @@ var BurstHandler = class {
           `  Hash           : ${this.hash}`,
           `  Limit          : ${Number.POSITIVE_INFINITY}`,
           `  Retry After    : ${retryAfter}ms`,
-          `  Sublimit       : None`
+          `  Sublimit       : None`,
+          `  Scope          : ${scope}`
         ].join("\n")
       );
       await sleep(retryAfter);
@@ -994,7 +1000,8 @@ var SequentialHandler = class {
         limit: limit2,
         timeToReset: timeout,
         retryAfter: timeout,
-        sublimitTimeout: 0
+        sublimitTimeout: 0,
+        scope: "user"
       };
       this.manager.emit("rateLimited" /* RateLimited */, rateLimitData);
       await onRateLimit(this.manager, rateLimitData);
@@ -1022,6 +1029,7 @@ var SequentialHandler = class {
     const reset = res.headers.get("X-RateLimit-Reset-After");
     const hash = res.headers.get("X-RateLimit-Bucket");
     const retry = res.headers.get("Retry-After");
+    const scope = res.headers.get("X-RateLimit-Scope") ?? "user";
     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();
@@ -1071,7 +1079,8 @@ var SequentialHandler = class {
         limit: limit2,
         timeToReset: timeout,
         retryAfter,
-        sublimitTimeout: sublimitTimeout ?? 0
+        sublimitTimeout: sublimitTimeout ?? 0,
+        scope
       });
       this.debug(
         [
@@ -1084,7 +1093,8 @@ var SequentialHandler = class {
           `  Hash           : ${this.hash}`,
           `  Limit          : ${limit2}`,
           `  Retry After    : ${retryAfter}ms`,
-          `  Sublimit       : ${sublimitTimeout ? `${sublimitTimeout}ms` : "None"}`
+          `  Sublimit       : ${sublimitTimeout ? `${sublimitTimeout}ms` : "None"}`,
+          `  Scope          : ${scope}`
         ].join("\n")
       );
       if (sublimitTimeout) {
@@ -1432,7 +1442,7 @@ var REST = class _REST extends import_async_event_emitter.AsyncEventEmitter {
 };
 
 // src/shared.ts
-var version = "2.1.1-dev.1700006959-cab60142f";
+var version = "2.2.0-dev.1700136223-6df233de1";
 
 // src/index.ts
 globalThis.FormData ??= import_undici2.FormData;