@discordeno/rest 19.0.0-next.fda9ef2 → 19.0.0-next.fe00a6f

package/dist/invalidBucket.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="node" />
 /**
  * A invalid request bucket is used in a similar manner as a leaky bucket but a invalid request bucket can be refilled as needed.
  * It's purpose is to make sure the bot does not hit the limit to getting a 1 hr ban.
@@ -14,8 +13,8 @@ export interface InvalidRequestBucketOptions {
     max?: number;
     /** The time that discord allows to make the max number of invalid requests. Defaults to 10 minutes */
     interval?: number;
-    /** timer to reset to 0 */
-    timeoutId?: NodeJS.Timeout;
+    /** When the timeout for the bucket has started at. */
+    resetAt?: number;
     /** how safe to be from max. Defaults to 1 */
     safety?: number;
     /** The request statuses that count as an invalid request. */
@@ -25,19 +24,19 @@ export interface InvalidRequestBucketOptions {
 }
 export interface InvalidRequestBucket {
     /** current invalid amount */
-    current: number;
+    invalidRequests: number;
     /** max invalid requests allowed until ban. Defaults to 10,000 */
     max: number;
     /** The time that discord allows to make the max number of invalid requests. Defaults to 10 minutes */
     interval: number;
-    /** timer to reset to 0 */
-    timeoutId: NodeJS.Timeout | undefined;
+    /** When the timeout for this bucket has started at. */
+    resetAt: number | undefined;
     /** how safe to be from max. Defaults to 1 */
     safety: number;
     /** The request statuses that count as an invalid request. */
     errorStatuses: number[];
     /** The amount of requests that were requested from this bucket. */
-    requested: number;
+    activeRequests: number;
     /** The requests that are currently pending. */
     waiting: Array<(value: void | PromiseLike<void>) => void>;
     /** Whether or not the waiting queue is already processing. */

package/dist/invalidBucket.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"invalidBucket.d.ts","sourceRoot":"","sources":["../src/invalidBucket.ts"],"names":[],"mappings":";AAEA;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,2BAA2B,GAAG,oBAAoB,CAkFrG;AAED,MAAM,WAAW,2BAA2B;IAC1C,6BAA6B;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,iEAAiE;IACjE,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,sGAAsG;IACtG,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,0BAA0B;IAC1B,SAAS,CAAC,EAAE,MAAM,CAAC,OAAO,CAAA;IAC1B,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,6DAA6D;IAC7D,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;IACxB,mEAAmE;IACnE,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC,6BAA6B;IAC7B,OAAO,EAAE,MAAM,CAAA;IACf,iEAAiE;IACjE,GAAG,EAAE,MAAM,CAAA;IACX,sGAAsG;IACtG,QAAQ,EAAE,MAAM,CAAA;IAChB,0BAA0B;IAC1B,SAAS,EAAE,MAAM,CAAC,OAAO,GAAG,SAAS,CAAA;IACrC,6CAA6C;IAC7C,MAAM,EAAE,MAAM,CAAA;IACd,6DAA6D;IAC7D,aAAa,EAAE,MAAM,EAAE,CAAA;IACvB,mEAAmE;IACnE,SAAS,EAAE,MAAM,CAAA;IACjB,+CAA+C;IAC/C,OAAO,EAAE,KAAK,CAAC,CAAC,KAAK,EAAE,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,CAAA;IACzD,8DAA8D;IAC9D,UAAU,EAAE,OAAO,CAAA;IAEnB,+DAA+D;IAC/D,eAAe,EAAE,MAAM,MAAM,CAAA;IAC7B,mDAAmD;IACnD,gBAAgB,EAAE,MAAM,OAAO,CAAA;IAC/B,yCAAyC;IACzC,yBAAyB,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IAC9C,uDAAuD;IACvD,cAAc,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IACnC,iIAAiI;IACjI,sBAAsB,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,KAAK,IAAI,CAAA;CACrE"}
+{"version":3,"file":"invalidBucket.d.ts","sourceRoot":"","sources":["../src/invalidBucket.ts"],"names":[],"mappings":"AAEA;;;;;;GAMG;AACH,wBAAgB,0BAA0B,CAAC,OAAO,EAAE,2BAA2B,GAAG,oBAAoB,CAmFrG;AAED,MAAM,WAAW,2BAA2B;IAC1C,6BAA6B;IAC7B,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,iEAAiE;IACjE,GAAG,CAAC,EAAE,MAAM,CAAA;IACZ,sGAAsG;IACtG,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,sDAAsD;IACtD,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,6CAA6C;IAC7C,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,6DAA6D;IAC7D,aAAa,CAAC,EAAE,MAAM,EAAE,CAAA;IACxB,mEAAmE;IACnE,SAAS,CAAC,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,oBAAoB;IACnC,6BAA6B;IAC7B,eAAe,EAAE,MAAM,CAAA;IACvB,iEAAiE;IACjE,GAAG,EAAE,MAAM,CAAA;IACX,sGAAsG;IACtG,QAAQ,EAAE,MAAM,CAAA;IAChB,uDAAuD;IACvD,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,6CAA6C;IAC7C,MAAM,EAAE,MAAM,CAAA;IACd,6DAA6D;IAC7D,aAAa,EAAE,MAAM,EAAE,CAAA;IACvB,mEAAmE;IACnE,cAAc,EAAE,MAAM,CAAA;IACtB,+CAA+C;IAC/C,OAAO,EAAE,KAAK,CAAC,CAAC,KAAK,EAAE,IAAI,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,IAAI,CAAC,CAAA;IACzD,8DAA8D;IAC9D,UAAU,EAAE,OAAO,CAAA;IAEnB,+DAA+D;IAC/D,eAAe,EAAE,MAAM,MAAM,CAAA;IAC7B,mDAAmD;IACnD,gBAAgB,EAAE,MAAM,OAAO,CAAA;IAC/B,yCAAyC;IACzC,yBAAyB,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IAC9C,uDAAuD;IACvD,cAAc,EAAE,MAAM,OAAO,CAAC,IAAI,CAAC,CAAA;IACnC,iIAAiI;IACjI,sBAAsB,EAAE,CAAC,IAAI,EAAE,MAAM,EAAE,WAAW,EAAE,OAAO,KAAK,IAAI,CAAA;CACrE"}

package/dist/invalidBucket.js

@@ -7,21 +7,25 @@ import { delay, logger } from '@discordeno/utils';
  * @returns RefillingBucket
  */ export function createInvalidRequestBucket(options) {
     const bucket = {
-        current: options.current ?? 0,
+        invalidRequests: options.current ?? 0,
         max: options.max ?? 10000,
-        interval: options.interval ?? 600000,
-        timeoutId: options.timeoutId,
+        interval: options.interval ?? 600_000,
+        resetAt: options.resetAt,
         safety: options.safety ?? 1,
         errorStatuses: options.errorStatuses ?? [
             401,
             403,
             429
         ],
-        requested: options.requested ?? 0,
+        activeRequests: options.requested ?? 0,
         processing: false,
         waiting: [],
         requestsAllowed: function() {
-            return bucket.max - bucket.current - bucket.requested - bucket.safety;
+            if (bucket.resetAt !== undefined && Date.now() >= bucket.resetAt) {
+                bucket.invalidRequests = 0;
+                bucket.resetAt = Date.now() + bucket.interval;
+            }
+            return bucket.max - bucket.invalidRequests - bucket.activeRequests - bucket.safety;
         },
         isRequestAllowed: function() {
             return bucket.requestsAllowed() > 0;
@@ -31,7 +35,7 @@ import { delay, logger } from '@discordeno/utils';
             return await new Promise(async (resolve)=>{
                 // If whatever amount of requests is left is more than the safety margin, allow the request
                 if (bucket.isRequestAllowed()) {
-                    bucket.requested++;
+                    bucket.activeRequests += 1;
                     resolve();
                 } else {
                     bucket.waiting.push(resolve);
@@ -41,41 +45,35 @@ import { delay, logger } from '@discordeno/utils';
         },
         processWaiting: async function() {
             // If already processing, that loop will handle all waiting requests.
-            if (bucket.processing) {
-                return;
-            }
+            if (bucket.processing) return;
             // Mark as processing so other loops don't start
             bucket.processing = true;
             while(bucket.waiting.length > 0){
-                logger.info(`[InvalidBucket] processing waiting queue while loop ran with ${bucket.waiting.length} remaining.`);
-                if (bucket.isRequestAllowed()) {
-                    bucket.requested++;
-                    // Resolve the next item in the queue
-                    bucket.waiting.shift()?.();
-                } else {
-                    await delay(1000);
+                logger.info(`[InvalidBucket] processing waiting queue while loop ran with ${bucket.waiting.length} pending requests to be made. ${JSON.stringify(bucket)}`);
+                if (!bucket.isRequestAllowed() && bucket.resetAt !== undefined) {
+                    logger.warn(`[InvalidBucket] processing waiting queue is now paused until more requests are available. ${bucket.waiting.length} pending requests. ${JSON.stringify(bucket)}`);
+                    await delay(bucket.resetAt - Date.now());
                 }
+                bucket.activeRequests += 1;
+                // Resolve the next item in the queue
+                bucket.waiting.shift()?.();
             }
             // Mark as false so next pending request can be triggered by new loop.
             bucket.processing = false;
         },
         handleCompletedRequest: function(code, sharedScope) {
             // Since request is complete, we can remove one from requested.
-            bucket.requested--;
+            bucket.activeRequests -= 1;
             // Since it is as a valid request, we don't need to do anything
             if (!bucket.errorStatuses.includes(code)) return;
             // Shared scope is not considered invalid
             if (code === 429 && sharedScope) return;
             // INVALID REQUEST WAS MADE
-            // Mark a request has been invalid
-            bucket.current++;
-            // If a timeout was not started, start a timeout to reset this bucket
-            if (bucket.timeoutId === undefined) {
-                bucket.timeoutId = setTimeout(()=>{
-                    bucket.current = 0;
-                    bucket.timeoutId = undefined;
-                }, bucket.interval);
+            if (bucket.resetAt === undefined) {
+                bucket.resetAt = Date.now() + bucket.interval;
             }
+            bucket.invalidRequests += 1;
+            logger.warn(`[InvalidBucket] an invalid request was made. Increasing invalidRequests count to ${bucket.invalidRequests}`);
         }
     };
     return bucket;

package/dist/invalidBucket.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/invalidBucket.ts"],"sourcesContent":["import { delay, logger } from '@discordeno/utils'\n\n/**\n * A invalid request bucket is used in a similar manner as a leaky bucket but a invalid request bucket can be refilled as needed.\n * It's purpose is to make sure the bot does not hit the limit to getting a 1 hr ban.\n *\n * @param options The options used to configure this bucket.\n * @returns RefillingBucket\n */\nexport function createInvalidRequestBucket(options: InvalidRequestBucketOptions): InvalidRequestBucket {\n  const bucket: InvalidRequestBucket = {\n    current: options.current ?? 0,\n    max: options.max ?? 10000,\n    interval: options.interval ?? 600000,\n    timeoutId: options.timeoutId,\n    safety: options.safety ?? 1,\n    errorStatuses: options.errorStatuses ?? [401, 403, 429],\n    requested: options.requested ?? 0,\n    processing: false,\n\n    waiting: [],\n\n    requestsAllowed: function () {\n      return bucket.max - bucket.current - bucket.requested - bucket.safety\n    },\n\n    isRequestAllowed: function () {\n      return bucket.requestsAllowed() > 0\n    },\n\n    waitUntilRequestAvailable: async function () {\n      // eslint-disable-next-line no-async-promise-executor\n      return await new Promise(async (resolve) => {\n        // If whatever amount of requests is left is more than the safety margin, allow the request\n        if (bucket.isRequestAllowed()) {\n          bucket.requested++\n          resolve()\n        } else {\n          bucket.waiting.push(resolve)\n          await bucket.processWaiting()\n        }\n      })\n    },\n\n    processWaiting: async function () {\n      // If already processing, that loop will handle all waiting requests.\n      if (bucket.processing) {\n        return\n      }\n\n      // Mark as processing so other loops don't start\n      bucket.processing = true\n\n      while (bucket.waiting.length > 0) {\n        logger.info(`[InvalidBucket] processing waiting queue while loop ran with ${bucket.waiting.length} remaining.`)\n        if (bucket.isRequestAllowed()) {\n          bucket.requested++\n          // Resolve the next item in the queue\n          bucket.waiting.shift()?.()\n        } else {\n          await delay(1000)\n        }\n      }\n\n      // Mark as false so next pending request can be triggered by new loop.\n      bucket.processing = false\n    },\n\n    handleCompletedRequest: function (code, sharedScope) {\n      // Since request is complete, we can remove one from requested.\n      bucket.requested--\n      // Since it is as a valid request, we don't need to do anything\n      if (!bucket.errorStatuses.includes(code)) return\n      // Shared scope is not considered invalid\n      if (code === 429 && sharedScope) return\n\n      // INVALID REQUEST WAS MADE\n\n      // Mark a request has been invalid\n      bucket.current++\n      // If a timeout was not started, start a timeout to reset this bucket\n      if (bucket.timeoutId === undefined) {\n        bucket.timeoutId = setTimeout(() => {\n          bucket.current = 0\n          bucket.timeoutId = undefined\n        }, bucket.interval)\n      }\n    },\n  }\n\n  return bucket\n}\n\nexport interface InvalidRequestBucketOptions {\n  /** current invalid amount */\n  current?: number\n  /** max invalid requests allowed until ban. Defaults to 10,000 */\n  max?: number\n  /** The time that discord allows to make the max number of invalid requests. Defaults to 10 minutes */\n  interval?: number\n  /** timer to reset to 0 */\n  timeoutId?: NodeJS.Timeout\n  /** how safe to be from max. Defaults to 1 */\n  safety?: number\n  /** The request statuses that count as an invalid request. */\n  errorStatuses?: number[]\n  /** The amount of requests that were requested from this bucket. */\n  requested?: number\n}\n\nexport interface InvalidRequestBucket {\n  /** current invalid amount */\n  current: number\n  /** max invalid requests allowed until ban. Defaults to 10,000 */\n  max: number\n  /** The time that discord allows to make the max number of invalid requests. Defaults to 10 minutes */\n  interval: number\n  /** timer to reset to 0 */\n  timeoutId: NodeJS.Timeout | undefined\n  /** how safe to be from max. Defaults to 1 */\n  safety: number\n  /** The request statuses that count as an invalid request. */\n  errorStatuses: number[]\n  /** The amount of requests that were requested from this bucket. */\n  requested: number\n  /** The requests that are currently pending. */\n  waiting: Array<(value: void | PromiseLike<void>) => void>\n  /** Whether or not the waiting queue is already processing. */\n  processing: boolean\n\n  /** Gives the number of requests that are currently allowed. */\n  requestsAllowed: () => number\n  /** Checks if a request is allowed at this time. */\n  isRequestAllowed: () => boolean\n  /** Waits until a request is available */\n  waitUntilRequestAvailable: () => Promise<void>\n  /** Begins processing the waiting queue of requests. */\n  processWaiting: () => Promise<void>\n  /** Handler for whenever a request is validated. This should update the requested values or trigger any other necessary stuff. */\n  handleCompletedRequest: (code: number, sharedScope: boolean) => void\n}\n"],"names":["delay","logger","createInvalidRequestBucket","options","bucket","current","max","interval","timeoutId","safety","errorStatuses","requested","processing","waiting","requestsAllowed","isRequestAllowed","waitUntilRequestAvailable","Promise","resolve","push","processWaiting","length","info","shift","handleCompletedRequest","code","sharedScope","includes","undefined","setTimeout"],"mappings":"AAAA,SAASA,KAAK,EAAEC,MAAM,QAAQ,oBAAmB;AAEjD;;;;;;CAMC,GACD,OAAO,SAASC,2BAA2BC,OAAoC,EAAwB;IACrG,MAAMC,SAA+B;QACnCC,SAASF,QAAQE,OAAO,IAAI;QAC5BC,KAAKH,QAAQG,GAAG,IAAI;QACpBC,UAAUJ,QAAQI,QAAQ,IAAI;QAC9BC,WAAWL,QAAQK,SAAS;QAC5BC,QAAQN,QAAQM,MAAM,IAAI;QAC1BC,eAAeP,QAAQO,aAAa,IAAI;YAAC;YAAK;YAAK;SAAI;QACvDC,WAAWR,QAAQQ,SAAS,IAAI;QAChCC,YAAY,KAAK;QAEjBC,SAAS,EAAE;QAEXC,iBAAiB,WAAY;YAC3B,OAAOV,OAAOE,GAAG,GAAGF,OAAOC,OAAO,GAAGD,OAAOO,SAAS,GAAGP,OAAOK,MAAM;QACvE;QAEAM,kBAAkB,WAAY;YAC5B,OAAOX,OAAOU,eAAe,KAAK;QACpC;QAEAE,2BAA2B,iBAAkB;YAC3C,qDAAqD;YACrD,OAAO,MAAM,IAAIC,QAAQ,OAAOC,UAAY;gBAC1C,2FAA2F;gBAC3F,IAAId,OAAOW,gBAAgB,IAAI;oBAC7BX,OAAOO,SAAS;oBAChBO;gBACF,OAAO;oBACLd,OAAOS,OAAO,CAACM,IAAI,CAACD;oBACpB,MAAMd,OAAOgB,cAAc;gBAC7B,CAAC;YACH;QACF;QAEAA,gBAAgB,iBAAkB;YAChC,qEAAqE;YACrE,IAAIhB,OAAOQ,UAAU,EAAE;gBACrB;YACF,CAAC;YAED,gDAAgD;YAChDR,OAAOQ,UAAU,GAAG,IAAI;YAExB,MAAOR,OAAOS,OAAO,CAACQ,MAAM,GAAG,EAAG;gBAChCpB,OAAOqB,IAAI,CAAC,CAAC,6DAA6D,EAAElB,OAAOS,OAAO,CAACQ,MAAM,CAAC,WAAW,CAAC;gBAC9G,IAAIjB,OAAOW,gBAAgB,IAAI;oBAC7BX,OAAOO,SAAS;oBAChB,qCAAqC;oBACrCP,OAAOS,OAAO,CAACU,KAAK;gBACtB,OAAO;oBACL,MAAMvB,MAAM;gBACd,CAAC;YACH;YAEA,sEAAsE;YACtEI,OAAOQ,UAAU,GAAG,KAAK;QAC3B;QAEAY,wBAAwB,SAAUC,IAAI,EAAEC,WAAW,EAAE;YACnD,+DAA+D;YAC/DtB,OAAOO,SAAS;YAChB,+DAA+D;YAC/D,IAAI,CAACP,OAAOM,aAAa,CAACiB,QAAQ,CAACF,OAAO;YAC1C,yCAAyC;YACzC,IAAIA,SAAS,OAAOC,aAAa;YAEjC,2BAA2B;YAE3B,kCAAkC;YAClCtB,OAAOC,OAAO;YACd,qEAAqE;YACrE,IAAID,OAAOI,SAAS,KAAKoB,WAAW;gBAClCxB,OAAOI,SAAS,GAAGqB,WAAW,IAAM;oBAClCzB,OAAOC,OAAO,GAAG;oBACjBD,OAAOI,SAAS,GAAGoB;gBACrB,GAAGxB,OAAOG,QAAQ;YACpB,CAAC;QACH;IACF;IAEA,OAAOH;AACT,CAAC"}
+{"version":3,"sources":["../src/invalidBucket.ts"],"sourcesContent":["import { delay, logger } from '@discordeno/utils'\n\n/**\n * A invalid request bucket is used in a similar manner as a leaky bucket but a invalid request bucket can be refilled as needed.\n * It's purpose is to make sure the bot does not hit the limit to getting a 1 hr ban.\n *\n * @param options The options used to configure this bucket.\n * @returns RefillingBucket\n */\nexport function createInvalidRequestBucket(options: InvalidRequestBucketOptions): InvalidRequestBucket {\n  const bucket: InvalidRequestBucket = {\n    invalidRequests: options.current ?? 0,\n    max: options.max ?? 10000,\n    interval: options.interval ?? 600_000, // 10 minutes\n    resetAt: options.resetAt,\n    safety: options.safety ?? 1,\n    errorStatuses: options.errorStatuses ?? [401, 403, 429],\n    activeRequests: options.requested ?? 0,\n    processing: false,\n\n    waiting: [],\n\n    requestsAllowed: function () {\n      if (bucket.resetAt !== undefined && Date.now() >= bucket.resetAt) {\n        bucket.invalidRequests = 0\n        bucket.resetAt = Date.now() + bucket.interval\n      }\n\n      return bucket.max - bucket.invalidRequests - bucket.activeRequests - bucket.safety\n    },\n\n    isRequestAllowed: function () {\n      return bucket.requestsAllowed() > 0\n    },\n\n    waitUntilRequestAvailable: async function () {\n      // eslint-disable-next-line no-async-promise-executor\n      return await new Promise(async (resolve) => {\n        // If whatever amount of requests is left is more than the safety margin, allow the request\n        if (bucket.isRequestAllowed()) {\n          bucket.activeRequests += 1\n          resolve()\n        } else {\n          bucket.waiting.push(resolve)\n          await bucket.processWaiting()\n        }\n      })\n    },\n\n    processWaiting: async function () {\n      // If already processing, that loop will handle all waiting requests.\n      if (bucket.processing) return\n\n      // Mark as processing so other loops don't start\n      bucket.processing = true\n\n      while (bucket.waiting.length > 0) {\n        logger.info(`[InvalidBucket] processing waiting queue while loop ran with ${bucket.waiting.length} pending requests to be made. ${JSON.stringify(bucket)}`)\n\n        if (!bucket.isRequestAllowed() && bucket.resetAt !== undefined) {\n          logger.warn(`[InvalidBucket] processing waiting queue is now paused until more requests are available. ${bucket.waiting.length} pending requests. ${JSON.stringify(bucket)}`)\n          await delay(bucket.resetAt - Date.now())\n        }\n\n        bucket.activeRequests += 1\n        // Resolve the next item in the queue\n        bucket.waiting.shift()?.()\n      }\n\n      // Mark as false so next pending request can be triggered by new loop.\n      bucket.processing = false\n    },\n\n    handleCompletedRequest: function (code, sharedScope) {\n      // Since request is complete, we can remove one from requested.\n      bucket.activeRequests -= 1\n      // Since it is as a valid request, we don't need to do anything\n      if (!bucket.errorStatuses.includes(code)) return\n      // Shared scope is not considered invalid\n      if (code === 429 && sharedScope) return\n\n      // INVALID REQUEST WAS MADE\n      if (bucket.resetAt === undefined) {\n        bucket.resetAt = Date.now() + bucket.interval\n      }\n\n      bucket.invalidRequests += 1\n      logger.warn(`[InvalidBucket] an invalid request was made. Increasing invalidRequests count to ${bucket.invalidRequests}`)\n    },\n  }\n\n  return bucket\n}\n\nexport interface InvalidRequestBucketOptions {\n  /** current invalid amount */\n  current?: number\n  /** max invalid requests allowed until ban. Defaults to 10,000 */\n  max?: number\n  /** The time that discord allows to make the max number of invalid requests. Defaults to 10 minutes */\n  interval?: number\n  /** When the timeout for the bucket has started at. */\n  resetAt?: number\n  /** how safe to be from max. Defaults to 1 */\n  safety?: number\n  /** The request statuses that count as an invalid request. */\n  errorStatuses?: number[]\n  /** The amount of requests that were requested from this bucket. */\n  requested?: number\n}\n\nexport interface InvalidRequestBucket {\n  /** current invalid amount */\n  invalidRequests: number\n  /** max invalid requests allowed until ban. Defaults to 10,000 */\n  max: number\n  /** The time that discord allows to make the max number of invalid requests. Defaults to 10 minutes */\n  interval: number\n  /** When the timeout for this bucket has started at. */\n  resetAt: number | undefined\n  /** how safe to be from max. Defaults to 1 */\n  safety: number\n  /** The request statuses that count as an invalid request. */\n  errorStatuses: number[]\n  /** The amount of requests that were requested from this bucket. */\n  activeRequests: number\n  /** The requests that are currently pending. */\n  waiting: Array<(value: void | PromiseLike<void>) => void>\n  /** Whether or not the waiting queue is already processing. */\n  processing: boolean\n\n  /** Gives the number of requests that are currently allowed. */\n  requestsAllowed: () => number\n  /** Checks if a request is allowed at this time. */\n  isRequestAllowed: () => boolean\n  /** Waits until a request is available */\n  waitUntilRequestAvailable: () => Promise<void>\n  /** Begins processing the waiting queue of requests. */\n  processWaiting: () => Promise<void>\n  /** Handler for whenever a request is validated. This should update the requested values or trigger any other necessary stuff. */\n  handleCompletedRequest: (code: number, sharedScope: boolean) => void\n}\n"],"names":["delay","logger","createInvalidRequestBucket","options","bucket","invalidRequests","current","max","interval","resetAt","safety","errorStatuses","activeRequests","requested","processing","waiting","requestsAllowed","undefined","Date","now","isRequestAllowed","waitUntilRequestAvailable","Promise","resolve","push","processWaiting","length","info","JSON","stringify","warn","shift","handleCompletedRequest","code","sharedScope","includes"],"mappings":"AAAA,SAASA,KAAK,EAAEC,MAAM,QAAQ,oBAAmB;AAEjD;;;;;;CAMC,GACD,OAAO,SAASC,2BAA2BC,OAAoC,EAAwB;IACrG,MAAMC,SAA+B;QACnCC,iBAAiBF,QAAQG,OAAO,IAAI;QACpCC,KAAKJ,QAAQI,GAAG,IAAI;QACpBC,UAAUL,QAAQK,QAAQ,IAAI;QAC9BC,SAASN,QAAQM,OAAO;QACxBC,QAAQP,QAAQO,MAAM,IAAI;QAC1BC,eAAeR,QAAQQ,aAAa,IAAI;YAAC;YAAK;YAAK;SAAI;QACvDC,gBAAgBT,QAAQU,SAAS,IAAI;QACrCC,YAAY,KAAK;QAEjBC,SAAS,EAAE;QAEXC,iBAAiB,WAAY;YAC3B,IAAIZ,OAAOK,OAAO,KAAKQ,aAAaC,KAAKC,GAAG,MAAMf,OAAOK,OAAO,EAAE;gBAChEL,OAAOC,eAAe,GAAG;gBACzBD,OAAOK,OAAO,GAAGS,KAAKC,GAAG,KAAKf,OAAOI,QAAQ;YAC/C,CAAC;YAED,OAAOJ,OAAOG,GAAG,GAAGH,OAAOC,eAAe,GAAGD,OAAOQ,cAAc,GAAGR,OAAOM,MAAM;QACpF;QAEAU,kBAAkB,WAAY;YAC5B,OAAOhB,OAAOY,eAAe,KAAK;QACpC;QAEAK,2BAA2B,iBAAkB;YAC3C,qDAAqD;YACrD,OAAO,MAAM,IAAIC,QAAQ,OAAOC,UAAY;gBAC1C,2FAA2F;gBAC3F,IAAInB,OAAOgB,gBAAgB,IAAI;oBAC7BhB,OAAOQ,cAAc,IAAI;oBACzBW;gBACF,OAAO;oBACLnB,OAAOW,OAAO,CAACS,IAAI,CAACD;oBACpB,MAAMnB,OAAOqB,cAAc;gBAC7B,CAAC;YACH;QACF;QAEAA,gBAAgB,iBAAkB;YAChC,qEAAqE;YACrE,IAAIrB,OAAOU,UAAU,EAAE;YAEvB,gDAAgD;YAChDV,OAAOU,UAAU,GAAG,IAAI;YAExB,MAAOV,OAAOW,OAAO,CAACW,MAAM,GAAG,EAAG;gBAChCzB,OAAO0B,IAAI,CAAC,CAAC,6DAA6D,EAAEvB,OAAOW,OAAO,CAACW,MAAM,CAAC,8BAA8B,EAAEE,KAAKC,SAAS,CAACzB,QAAQ,CAAC;gBAE1J,IAAI,CAACA,OAAOgB,gBAAgB,MAAMhB,OAAOK,OAAO,KAAKQ,WAAW;oBAC9DhB,OAAO6B,IAAI,CAAC,CAAC,0FAA0F,EAAE1B,OAAOW,OAAO,CAACW,MAAM,CAAC,mBAAmB,EAAEE,KAAKC,SAAS,CAACzB,QAAQ,CAAC;oBAC5K,MAAMJ,MAAMI,OAAOK,OAAO,GAAGS,KAAKC,GAAG;gBACvC,CAAC;gBAEDf,OAAOQ,cAAc,IAAI;gBACzB,qCAAqC;gBACrCR,OAAOW,OAAO,CAACgB,KAAK;YACtB;YAEA,sEAAsE;YACtE3B,OAAOU,UAAU,GAAG,KAAK;QAC3B;QAEAkB,wBAAwB,SAAUC,IAAI,EAAEC,WAAW,EAAE;YACnD,+DAA+D;YAC/D9B,OAAOQ,cAAc,IAAI;YACzB,+DAA+D;YAC/D,IAAI,CAACR,OAAOO,aAAa,CAACwB,QAAQ,CAACF,OAAO;YAC1C,yCAAyC;YACzC,IAAIA,SAAS,OAAOC,aAAa;YAEjC,2BAA2B;YAC3B,IAAI9B,OAAOK,OAAO,KAAKQ,WAAW;gBAChCb,OAAOK,OAAO,GAAGS,KAAKC,GAAG,KAAKf,OAAOI,QAAQ;YAC/C,CAAC;YAEDJ,OAAOC,eAAe,IAAI;YAC1BJ,OAAO6B,IAAI,CAAC,CAAC,iFAAiF,EAAE1B,OAAOC,eAAe,CAAC,CAAC;QAC1H;IACF;IAEA,OAAOD;AACT,CAAC"}

package/dist/manager.d.ts

@@ -1,3 +1,12 @@
 import type { CreateRestManagerOptions, RestManager } from './types.js';
+export declare const DISCORD_API_VERSION = 10;
+export declare const DISCORD_API_URL = "https://discord.com/api";
+export declare const AUDIT_LOG_REASON_HEADER = "x-audit-log-reason";
+export declare const RATE_LIMIT_REMAINING_HEADER = "x-ratelimit-remaining";
+export declare const RATE_LIMIT_RESET_AFTER_HEADER = "x-ratelimit-reset-after";
+export declare const RATE_LIMIT_GLOBAL_HEADER = "x-ratelimit-global";
+export declare const RATE_LIMIT_BUCKET_HEADER = "x-ratelimit-bucket";
+export declare const RATE_LIMIT_LIMIT_HEADER = "x-ratelimit-limit";
+export declare const RATE_LIMIT_SCOPE_HEADER = "x-ratelimit-scope";
 export declare function createRestManager(options: CreateRestManagerOptions): RestManager;
 //# sourceMappingURL=manager.d.ts.map

package/dist/manager.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"manager.d.ts","sourceRoot":"","sources":["../src/manager.ts"],"names":[],"mappings":"AAkDA,OAAO,KAAK,EAA4B,wBAAwB,EAAE,WAAW,EAAsB,MAAM,YAAY,CAAA;AAMrH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,wBAAwB,GAAG,WAAW,CAwnChF"}
+{"version":3,"file":"manager.d.ts","sourceRoot":"","sources":["../src/manager.ts"],"names":[],"mappings":"AAkDA,OAAO,KAAK,EAA4B,wBAAwB,EAAE,WAAW,EAAsB,MAAM,YAAY,CAAA;AAKrH,eAAO,MAAM,mBAAmB,KAAK,CAAA;AACrC,eAAO,MAAM,eAAe,4BAA4B,CAAA;AAExD,eAAO,MAAM,uBAAuB,uBAAuB,CAAA;AAC3D,eAAO,MAAM,2BAA2B,0BAA0B,CAAA;AAClE,eAAO,MAAM,6BAA6B,4BAA4B,CAAA;AACtE,eAAO,MAAM,wBAAwB,uBAAuB,CAAA;AAC5D,eAAO,MAAM,wBAAwB,uBAAuB,CAAA;AAC5D,eAAO,MAAM,uBAAuB,sBAAsB,CAAA;AAC1D,eAAO,MAAM,uBAAuB,sBAAsB,CAAA;AAE1D,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,wBAAwB,GAAG,WAAW,CAuqChF"}

package/dist/manager.js

@@ -1,29 +1,39 @@
-/* eslint-disable @typescript-eslint/restrict-template-expressions */ /* eslint-disable no-const-assign */ import { InteractionResponseTypes } from '@discordeno/types';
-import { calculateBits, camelize, camelToSnakeCase, delay, getBotIdFromToken, logger, processReactionString, urlToBase64 } from '@discordeno/utils';
-import fetch from 'node-fetch';
+/* eslint-disable @typescript-eslint/restrict-template-expressions */ /* eslint-disable no-const-assign */ import { calculateBits, camelToSnakeCase, camelize, delay, getBotIdFromToken, logger, processReactionString, urlToBase64 } from '@discordeno/utils';
 import { createInvalidRequestBucket } from './invalidBucket.js';
 import { Queue } from './queue.js';
+import { InteractionResponseTypes } from '@discordeno/types';
 import { createRoutes } from './routes.js';
 // TODO: make dynamic based on package.json file
 const version = '19.0.0-alpha.1';
+export const DISCORD_API_VERSION = 10;
+export const DISCORD_API_URL = 'https://discord.com/api';
+export const AUDIT_LOG_REASON_HEADER = 'x-audit-log-reason';
+export const RATE_LIMIT_REMAINING_HEADER = 'x-ratelimit-remaining';
+export const RATE_LIMIT_RESET_AFTER_HEADER = 'x-ratelimit-reset-after';
+export const RATE_LIMIT_GLOBAL_HEADER = 'x-ratelimit-global';
+export const RATE_LIMIT_BUCKET_HEADER = 'x-ratelimit-bucket';
+export const RATE_LIMIT_LIMIT_HEADER = 'x-ratelimit-limit';
+export const RATE_LIMIT_SCOPE_HEADER = 'x-ratelimit-scope';
 export function createRestManager(options) {
     const applicationId = options.applicationId ? BigInt(options.applicationId) : options.token ? getBotIdFromToken(options.token) : undefined;
     if (!applicationId) {
         throw new Error('`applicationId` was not provided and was not able to extract the id from the bots token. Please explicitly pass `applicationId` to the rest manager.');
     }
+    const baseUrl = options.proxy?.baseUrl ?? DISCORD_API_URL;
     const rest = {
-        token: options.token,
         applicationId,
-        version: options.version ?? 10,
-        baseUrl: options.proxy?.baseUrl ?? 'https://discord.com/api',
-        maxRetryCount: Infinity,
+        authorization: options.proxy?.authorization,
+        baseUrl,
+        deleteQueueDelay: 60000,
         globallyRateLimited: false,
+        invalidBucket: createInvalidRequestBucket({}),
+        isProxied: !baseUrl.startsWith(DISCORD_API_URL),
+        maxRetryCount: Infinity,
         processingRateLimitedPaths: false,
-        deleteQueueDelay: 60000,
         queues: new Map(),
         rateLimitedPaths: new Map(),
-        invalidBucket: createInvalidRequestBucket({}),
-        authorization: options.proxy?.authorization,
+        token: options.token,
+        version: options.version ?? DISCORD_API_VERSION,
         routes: createRoutes(),
         checkRateLimits (url) {
             const ratelimited = rest.rateLimitedPaths.get(url);
@@ -45,20 +55,27 @@ export function createRestManager(options) {
                 }
                 const newObj = {};
                 for (const key of Object.keys(obj)){
-                    // Keys that dont require snake casing
-                    if ([
-                        'permissions',
-                        'allow',
-                        'deny'
-                    ].includes(key)) {
-                        newObj[key] = calculateBits(obj[key]);
-                        continue;
-                    }
-                    if (key === 'defaultMemberPermissions') {
-                        newObj.default_member_permissions = calculateBits(obj[key]);
-                        continue;
+                    const value = obj[key];
+                    // Some falsy values should be allowed like null or 0
+                    if (value !== undefined) {
+                        switch(key){
+                            case 'permissions':
+                            case 'allow':
+                            case 'deny':
+                                newObj[key] = calculateBits(value);
+                                continue;
+                            case 'defaultMemberPermissions':
+                                newObj.default_member_permissions = calculateBits(value);
+                                continue;
+                            case 'nameLocalizations':
+                                newObj.name_localizations = value;
+                                continue;
+                            case 'descriptionLocalizations':
+                                newObj.description_localizations = value;
+                                continue;
+                        }
                     }
-                    newObj[camelToSnakeCase(key)] = rest.changeToDiscordFormat(obj[key]);
+                    newObj[camelToSnakeCase(key)] = rest.changeToDiscordFormat(value);
                 }
                 return newObj;
             }
@@ -72,7 +89,7 @@ export function createRestManager(options) {
             if (options?.unauthorized !== false) headers.authorization = `Bot ${rest.token}`;
             // IF A REASON IS PROVIDED ENCODE IT IN HEADERS
             if (options?.reason !== undefined) {
-                headers['x-audit-log-reason'] = encodeURIComponent(options?.reason);
+                headers[AUDIT_LOG_REASON_HEADER] = encodeURIComponent(options?.reason);
             }
             let body;
             // TODO: check if we need to add specific check for GET method
@@ -138,13 +155,13 @@ export function createRestManager(options) {
         /** Processes the rate limit headers and determines if it needs to be rate limited and returns the bucket id if available */ processHeaders (url, headers) {
             let rateLimited = false;
             // GET ALL NECESSARY HEADERS
-            const remaining = headers.get('x-ratelimit-remaining');
-            const retryAfter = headers.get('x-ratelimit-reset-after');
+            const remaining = headers.get(RATE_LIMIT_REMAINING_HEADER);
+            const retryAfter = headers.get(RATE_LIMIT_RESET_AFTER_HEADER);
             const reset = Date.now() + Number(retryAfter) * 1000;
-            const global = headers.get('x-ratelimit-global');
+            const global = headers.get(RATE_LIMIT_GLOBAL_HEADER);
             // undefined override null needed for typings
-            const bucketId = headers.get('x-ratelimit-bucket') ?? undefined;
-            const limit = headers.get('x-ratelimit-limit');
+            const bucketId = headers.get(RATE_LIMIT_BUCKET_HEADER) ?? undefined;
+            const limit = headers.get(RATE_LIMIT_LIMIT_HEADER);
             rest.queues.get(url)?.handleCompletedRequest({
                 remaining: remaining ? Number(remaining) : undefined,
                 interval: retryAfter ? Number(retryAfter) * 1000 : undefined,
@@ -199,7 +216,7 @@ export function createRestManager(options) {
             return rateLimited ? bucketId : undefined;
         },
         async sendRequest (options) {
-            const url = options.url.startsWith('https://') ? options.url : `${rest.baseUrl}/v${rest.version}${options.url}`;
+            const url = `${rest.baseUrl}/v${rest.version}${options.route}`;
             const payload = rest.createRequestBody(options.method, options.requestBodyOptions);
             logger.debug(`sending request to ${url}`, 'with payload:', {
                 ...payload,
@@ -208,49 +225,57 @@ export function createRestManager(options) {
                     authorization: 'Bot tokenhere'
                 }
             });
-            const response = await fetch(url, payload);
+            const response = await fetch(url, payload).catch(async (error)=>{
+                logger.error(error);
+                // Mark request and completed
+                rest.invalidBucket.handleCompletedRequest(999, false);
+                options.reject({
+                    ok: false,
+                    status: 999,
+                    error: 'Possible network or request shape issue occurred. If this is rare, its a network glitch. If it occurs a lot something is wrong.'
+                });
+                throw error;
+            });
             logger.debug(`request fetched from ${url} with status ${response.status} & ${response.statusText}`);
+            // Mark request and completed
+            rest.invalidBucket.handleCompletedRequest(response.status, response.headers.get(RATE_LIMIT_SCOPE_HEADER) === 'shared');
             // Set the bucket id if it was available on the headers
-            const bucketId = rest.processHeaders(rest.simplifyUrl(options.url, options.method), response.headers);
+            const bucketId = rest.processHeaders(rest.simplifyUrl(options.route, options.method), response.headers);
             if (bucketId) options.bucketId = bucketId;
             if (response.status < 200 || response.status >= 400) {
                 logger.debug(`Request to ${url} failed.`);
-                if (response.status === 429) {
-                    logger.debug(`Request to ${url} was ratelimited.`);
-                    // Too many attempts, get rid of request from queue.
-                    if (options.retryCount++ >= rest.maxRetryCount) {
-                        logger.debug(`Request to ${url} exceeded the maximum allowed retries.`, 'with payload:', payload);
-                        // rest.debug(`[REST - RetriesMaxed] ${JSON.stringify(options)}`)
-                        // Remove item from queue to prevent retry
-                        options.reject({
-                            ok: false,
-                            status: response.status,
-                            error: 'The options was rate limited and it maxed out the retries limit.'
-                        });
-                        return;
-                    }
-                    // Rate limited, add back to queue
-                    rest.invalidBucket.handleCompletedRequest(response.status, response.headers.get('X-RateLimit-Scope') === 'shared');
-                    const resetAfter = response.headers.get('x-ratelimit-reset-after');
-                    if (resetAfter) await delay(Number(resetAfter) * 1000);
-                    // process the response to prevent mem leak
-                    await response.json();
-                    return await options.retryRequest?.(options);
+                if (response.status !== 429) {
+                    options.reject({
+                        ok: false,
+                        status: response.status,
+                        body: await response.text()
+                    });
+                    return;
                 }
-                options.reject({
-                    ok: false,
-                    status: response.status,
-                    body: JSON.stringify(await response.json())
-                });
-                return;
+                logger.debug(`Request to ${url} was ratelimited.`);
+                // Too many attempts, get rid of request from queue.
+                if (options.retryCount >= rest.maxRetryCount) {
+                    logger.debug(`Request to ${url} exceeded the maximum allowed retries.`, 'with payload:', payload);
+                    // rest.debug(`[REST - RetriesMaxed] ${JSON.stringify(options)}`)
+                    options.reject({
+                        ok: false,
+                        status: response.status,
+                        error: 'The request was rate limited and it maxed out the retries limit.'
+                    });
+                    return;
+                }
+                options.retryCount += 1;
+                const resetAfter = response.headers.get(RATE_LIMIT_RESET_AFTER_HEADER);
+                if (resetAfter) await delay(Number(resetAfter) * 1000);
+                // process the response to prevent mem leak
+                await response.arrayBuffer();
+                return await options.retryRequest?.(options);
             }
-            const is204 = response.status === 204;
-            const json = is204 ? undefined : await response.json();
-            // Discord sometimes sends no response with 204 code
+            // Discord sometimes sends no response with no content.
             options.resolve({
                 ok: true,
                 status: response.status,
-                body: JSON.stringify(json)
+                body: response.status === 204 ? undefined : await response.text()
             });
         },
         simplifyUrl (url, method) {
@@ -275,15 +300,7 @@ export function createRestManager(options) {
             return parts.join('/');
         },
         async processRequest (request) {
-            const route = request.url.substring(request.url.indexOf('api/'));
-            const parts = route.split('/');
-            // Remove the api/
-            parts.shift();
-            // Removes the /v#/
-            if (parts[0]?.startsWith('v')) parts.shift();
-            // Set the full url to discord api in case it was recieved in a proxy rest
-            request.url = `${rest.baseUrl}/v${rest.version}/${parts.join('/')}`;
-            const url = rest.simplifyUrl(request.url, request.method);
+            const url = rest.simplifyUrl(request.route, request.method);
             if (request.runThroughQueue === false) {
                 await rest.sendRequest(request);
                 return;
@@ -303,9 +320,14 @@ export function createRestManager(options) {
                 rest.queues.set(url, bucketQueue);
             }
         },
-        async makeRequest (method, url, options) {
-            if (!rest.baseUrl.startsWith('https://discord.com') && url[0] === '/') {
-                const result = await fetch(`${rest.baseUrl}${url}`, rest.createRequestBody(method, options));
+        async makeRequest (method, route, options) {
+            if (rest.isProxied) {
+                if (rest.authorization !== undefined) {
+                    options ??= {};
+                    options.headers ??= {};
+                    options.headers.authorization = rest.authorization;
+                }
+                const result = await fetch(`${rest.baseUrl}/v${rest.version}${route}`, rest.createRequestBody(method, options));
                 if (!result.ok) {
                     const err = await result.json().catch(()=>{});
                     // Legacy Handling to not break old code or when body is missing
@@ -317,7 +339,7 @@ export function createRestManager(options) {
             // eslint-disable-next-line no-async-promise-executor
             return await new Promise(async (resolve, reject)=>{
                 const payload = {
-                    url,
+                    route,
                     method,
                     requestBodyOptions: options,
                     retryCount: 0,
@@ -669,7 +691,8 @@ export function createRestManager(options) {
         },
         async editMessage (channelId, messageId, body) {
             return await rest.patch(rest.routes.channels.message(channelId, messageId), {
-                body
+                body,
+                files: body.files
             });
         },
         async editOriginalInteractionResponse (token, body) {
@@ -1082,9 +1105,35 @@ export function createRestManager(options) {
             return await rest.put(rest.routes.interactions.commands.guilds.all(rest.applicationId, guildId), {
                 body
             });
+        },
+        preferSnakeCase (enabled) {
+            const camelizer = enabled ? (x)=>x : camelize;
+            rest.get = async (url, options)=>{
+                return camelizer(await rest.makeRequest('GET', url, options));
+            };
+            rest.post = async (url, options)=>{
+                return camelizer(await rest.makeRequest('POST', url, options));
+            };
+            rest.delete = async (url, options)=>{
+                camelizer(await rest.makeRequest('DELETE', url, options));
+            };
+            rest.patch = async (url, options)=>{
+                return camelizer(await rest.makeRequest('PATCH', url, options));
+            };
+            rest.put = async (url, options)=>{
+                return camelizer(await rest.makeRequest('PUT', url, options));
+            };
+            return rest;
         }
     };
     return rest;
 }
+var HttpResponseCode;
+(function(HttpResponseCode) {
+    HttpResponseCode[HttpResponseCode[/** Minimum value of a code in oder to consider that it was successful. */ "Success"] = 200] = "Success";
+    HttpResponseCode[HttpResponseCode[/** Request completed successfully, but Discord returned an empty body. */ "NoContent"] = 204] = "NoContent";
+    HttpResponseCode[HttpResponseCode[/** Minimum value of a code in order to consider that something went wrong. */ "Error"] = 400] = "Error";
+    HttpResponseCode[HttpResponseCode[/** This request got rate limited. */ "TooManyRequests"] = 429] = "TooManyRequests";
+})(HttpResponseCode || (HttpResponseCode = {}));
 
 //# sourceMappingURL=manager.js.map