[1.2.0] Fix ratelimiting issues, automerge deps with Renovate

Author: auguwu

index.d.ts

@@ -20,7 +20,8 @@
  * SOFTWARE.
  */
 
-import { HttpMethod, DataLike } from '@augu/orchid';
+import { HttpMethod, DataLike, Response } from '@augu/orchid';
+import { Collection } from '@augu/collections';
 import { EventBus } from '@augu/utils';
 import { Agent } from 'undici';
 
@@ -219,8 +220,19 @@ declare namespace Rest {
     data?: D;
   }
 
+  /**
+   * Represents a file to send on Discord
+   */
   export interface MessageFile {
+    /**
+     * The name of the file
+     * @default 'file.png'
+     */
     name?: string;
+
+    /**
+     * The file contents to send
+     */
     file: Buffer;
   }
 
@@ -272,43 +284,70 @@ declare namespace Rest {
     public lastDispatchAt: number;
 
     /**
-     * If the rest client has been ratelimited or not
+     * Represents the current cancellation token list
      */
-    public ratelimited: boolean;
+    public clsToken: CancellationTokens;
 
     /**
-     * How many requests we can make
+     * List of routes for ratelimiting purposes
      */
-    public remaining: number;
+    public routes: Collection<string, RouteBucket>;
+
+    /**
+     * List of options available
+     */
+    public options: Pick<RestClientOptions, 'baseUrl'> & { token: string | null; agent: Agent | null; };
 
     /**
-     * The reset time
+     * The rest client to create requests to Discord
+     * @param options Any additional options to create this RestClient
      */
-    public resetTime: number;
+    constructor(options: RestClientOptions);
+
+    public get ping(): number;
+    public dispatch<D extends DataLike | unknown = unknown, TReturn = unknown>(options: RequestDispatchOptions<D>): Promise<TReturn>;
+  }
 
+  /**
+   * Represents a ratelimit buckets for specific routes
+   */
+  export class RouteBucket {
     /**
-     * The limit of requests
+     * The global ratelimit promise
      */
-    public limit: number;
+    public static globalRatelimit: Promise<void> | null;
 
     /**
-     * Represents the current cancellation token list
+     * The route this [`RouteBucket`] belongs to
      */
-    public clsToken: CancellationTokens;
+    public readonly route: string;
 
     /**
-     * List of options available
+     * The reset time for ratelimiting purposes
      */
-    public options: Pick<RestClientOptions, 'baseUrl'> & { token: string | null; agent: Agent | null; };
+    public resetTime: number;
 
     /**
-     * The rest client to create requests to Discord
-     * @param options Any additional options to create this RestClient
+     * The remaining times before we reach a 429 status
      */
-    constructor(options: RestClientOptions);
+    public remaining: number;
 
-    public get ping(): number;
-    public dispatch<D extends DataLike | unknown = unknown, TReturn = unknown>(options: RequestDispatchOptions<D>): Promise<TReturn>;
+    /**
+     * If this [`RouteBucket`] has been ratelimited or not
+     */
+    public get ratelimited(): boolean;
+
+    /**
+     * Returns the offset given by Discord's server date and our server date
+     * @param serverDate The date in milliseconds Discord has gaven us
+     */
+    public getOffset(serverDate: string): number;
+
+    /**
+     * Handles the ratelimiting for this [`RouteBucket`]
+     * @param res The orchid response
+     */
+    public handle(res: Response): Promise<void>;
   }
 }