@discordjs/rest 0.2.0-canary.0 → 0.3.0-dev.1644408653.fe11ff5

package/dist/lib/REST.d.ts

@@ -4,6 +4,9 @@ import { CDN } from './CDN';
 import { InternalRequest, RequestData, RequestManager, RouteLike } from './RequestManager';
 import type { AgentOptions } from 'node:https';
 import type { RequestInit, Response } from 'node-fetch';
+import type { HashData } from './RequestManager';
+import type Collection from '@discordjs/collection';
+import type { IHandler } from './handlers/IHandler';
 /**
  * Options to be passed when creating the REST instance
  */
@@ -73,6 +76,21 @@ export interface RESTOptions {
      * @default '9'
      */
     version: string;
+    /**
+     * The amount of time in milliseconds that passes between each hash sweep. (defaults to 4h)
+     * @default 14_400_000
+     */
+    hashSweepInterval: number;
+    /**
+     * The maximum amount of time a hash can exist in milliseconds without being hit with a request (defaults to 24h)
+     * @default 86_400_000
+     */
+    hashLifetime: number;
+    /**
+     * The amount of time in milliseconds that passes between each hash sweep. (defaults to 1h)
+     * @default 3_600_000
+     */
+    handlerSweepInterval: number;
 }
 /**
  * Data emitted on `RESTEvents.RateLimited`
@@ -138,7 +156,7 @@ export interface APIRequest {
     /**
      * The data that was used to form the body of this request
      */
-    data: Pick<InternalRequest, 'attachments' | 'body'>;
+    data: Pick<InternalRequest, 'files' | 'body'>;
     /**
      * The number of times this request has been attempted
      */
@@ -150,7 +168,7 @@ export interface InvalidRequestWarningData {
      */
     count: number;
     /**
-     * Time in ms remaining before the count resets
+     * Time in milliseconds remaining before the count resets
      */
     remainingTime: number;
 }
@@ -162,18 +180,15 @@ export interface RestEvents {
     response: [request: APIRequest, response: Response];
     newListener: [name: string, listener: (...args: any) => void];
     removeListener: [name: string, listener: (...args: any) => void];
+    hashSweep: [sweptHashes: Collection<string, HashData>];
+    handlerSweep: [sweptHandlers: Collection<string, IHandler>];
 }
 export interface REST {
-    on<K extends keyof RestEvents>(event: K, listener: (...args: RestEvents[K]) => void): this;
-    on<S extends string | symbol>(event: Exclude<S, keyof RestEvents>, listener: (...args: any[]) => void): this;
-    once<K extends keyof RestEvents>(event: K, listener: (...args: RestEvents[K]) => void): this;
-    once<S extends string | symbol>(event: Exclude<S, keyof RestEvents>, listener: (...args: any[]) => void): this;
-    emit<K extends keyof RestEvents>(event: K, ...args: RestEvents[K]): boolean;
-    emit<S extends string | symbol>(event: Exclude<S, keyof RestEvents>, ...args: any[]): boolean;
-    off<K extends keyof RestEvents>(event: K, listener: (...args: RestEvents[K]) => void): this;
-    off<S extends string | symbol>(event: Exclude<S, keyof RestEvents>, listener: (...args: any[]) => void): this;
-    removeAllListeners<K extends keyof RestEvents>(event?: K): this;
-    removeAllListeners<S extends string | symbol>(event?: Exclude<S, keyof RestEvents>): this;
+    on: (<K extends keyof RestEvents>(event: K, listener: (...args: RestEvents[K]) => void) => this) & (<S extends string | symbol>(event: Exclude<S, keyof RestEvents>, listener: (...args: any[]) => void) => this);
+    once: (<K extends keyof RestEvents>(event: K, listener: (...args: RestEvents[K]) => void) => this) & (<S extends string | symbol>(event: Exclude<S, keyof RestEvents>, listener: (...args: any[]) => void) => this);
+    emit: (<K extends keyof RestEvents>(event: K, ...args: RestEvents[K]) => boolean) & (<S extends string | symbol>(event: Exclude<S, keyof RestEvents>, ...args: any[]) => boolean);
+    off: (<K extends keyof RestEvents>(event: K, listener: (...args: RestEvents[K]) => void) => this) & (<S extends string | symbol>(event: Exclude<S, keyof RestEvents>, listener: (...args: any[]) => void) => this);
+    removeAllListeners: (<K extends keyof RestEvents>(event?: K) => this) & (<S extends string | symbol>(event?: Exclude<S, keyof RestEvents>) => this);
 }
 export declare class REST extends EventEmitter {
     readonly cdn: CDN;

package/dist/lib/RequestManager.d.ts

@@ -1,39 +1,36 @@
 /// <reference types="node" />
 import Collection from '@discordjs/collection';
 import { EventEmitter } from 'node:events';
+import type { BodyInit } from 'node-fetch';
 import type { IHandler } from './handlers/IHandler';
 import type { RESTOptions, RestEvents } from './REST';
 /**
- * Represents an attachment to be added to the request
+ * Represents a file to be added to the request
  */
-export interface RawAttachment {
+export interface RawFile {
     /**
      * The name of the file
      */
-    fileName: string;
+    name: string;
     /**
-     * An explicit key to use for key of the formdata field for this attachment.
-     * When not provided, the index of the file in the attachments array is used in the form `files[${index}]`.
+     * An explicit key to use for key of the formdata field for this file.
+     * When not provided, the index of the file in the files array is used in the form `files[${index}]`.
      * If you wish to alter the placeholder snowflake, you must provide this property in the same form (`files[${placeholder}]`)
      */
     key?: string;
     /**
-     * The actual data for the attachment
+     * The actual data for the file
      */
-    rawBuffer: Buffer;
+    data: string | number | boolean | Buffer;
 }
 /**
  * Represents possible data to be given to an endpoint
  */
 export interface RequestData {
     /**
-     * Whether to append JSON data to form data instead of `payload_json` when sending attachments
+     * Whether to append JSON data to form data instead of `payload_json` when sending files
      */
     appendToFormData?: boolean;
-    /**
-     * Files to be attached to this request
-     */
-    attachments?: RawAttachment[] | undefined;
     /**
      * If this request needs the `Authorization` header
      * @default true
@@ -45,13 +42,23 @@ export interface RequestData {
      */
     authPrefix?: 'Bot' | 'Bearer';
     /**
-     * The body to send to this request
+     * The body to send to this request.
+     * If providing as BodyInit, set `passThroughBody: true`
      */
-    body?: unknown;
+    body?: BodyInit | unknown;
+    /**
+     * Files to be attached to this request
+     */
+    files?: RawFile[] | undefined;
     /**
      * Additional headers to add to this request
      */
     headers?: Record<string, string>;
+    /**
+     * Whether to pass-through the body property directly to `fetch()`.
+     * <warn>This only applies when files is NOT present</warn>
+     */
+    passThroughBody?: boolean;
     /**
      * Query string parameters to append to the called endpoint
      */
@@ -104,17 +111,21 @@ export interface RouteData {
     bucketRoute: string;
     original: RouteLike;
 }
+/**
+ * Represents a hash and its associated fields
+ *
+ * @internal
+ */
+export interface HashData {
+    value: string;
+    lastAccess: number;
+}
 export interface RequestManager {
-    on<K extends keyof RestEvents>(event: K, listener: (...args: RestEvents[K]) => void): this;
-    on<S extends string | symbol>(event: Exclude<S, keyof RestEvents>, listener: (...args: any[]) => void): this;
-    once<K extends keyof RestEvents>(event: K, listener: (...args: RestEvents[K]) => void): this;
-    once<S extends string | symbol>(event: Exclude<S, keyof RestEvents>, listener: (...args: any[]) => void): this;
-    emit<K extends keyof RestEvents>(event: K, ...args: RestEvents[K]): boolean;
-    emit<S extends string | symbol>(event: Exclude<S, keyof RestEvents>, ...args: any[]): boolean;
-    off<K extends keyof RestEvents>(event: K, listener: (...args: RestEvents[K]) => void): this;
-    off<S extends string | symbol>(event: Exclude<S, keyof RestEvents>, listener: (...args: any[]) => void): this;
-    removeAllListeners<K extends keyof RestEvents>(event?: K): this;
-    removeAllListeners<S extends string | symbol>(event?: Exclude<S, keyof RestEvents>): this;
+    on: (<K extends keyof RestEvents>(event: K, listener: (...args: RestEvents[K]) => void) => this) & (<S extends string | symbol>(event: Exclude<S, keyof RestEvents>, listener: (...args: any[]) => void) => this);
+    once: (<K extends keyof RestEvents>(event: K, listener: (...args: RestEvents[K]) => void) => this) & (<S extends string | symbol>(event: Exclude<S, keyof RestEvents>, listener: (...args: any[]) => void) => this);
+    emit: (<K extends keyof RestEvents>(event: K, ...args: RestEvents[K]) => boolean) & (<S extends string | symbol>(event: Exclude<S, keyof RestEvents>, ...args: any[]) => boolean);
+    off: (<K extends keyof RestEvents>(event: K, listener: (...args: RestEvents[K]) => void) => this) & (<S extends string | symbol>(event: Exclude<S, keyof RestEvents>, listener: (...args: any[]) => void) => this);
+    removeAllListeners: (<K extends keyof RestEvents>(event?: K) => this) & (<S extends string | symbol>(event?: Exclude<S, keyof RestEvents>) => this);
 }
 /**
  * Represents the class that manages handlers for endpoints
@@ -136,13 +147,17 @@ export declare class RequestManager extends EventEmitter {
     /**
      * API bucket hashes that are cached from provided routes
      */
-    readonly hashes: Collection<string, string>;
+    readonly hashes: Collection<string, HashData>;
     /**
      * Request handlers created from the bucket hash and the major parameters
      */
     readonly handlers: Collection<string, IHandler>;
+    private hashTimer;
+    private handlerTimer;
+    private agent;
     readonly options: RESTOptions;
     constructor(options: Partial<RESTOptions>);
+    private setupSweepers;
     /**
      * Sets the authorization token that should be used for requests
      * @param token The authorization token to use
@@ -166,6 +181,14 @@ export declare class RequestManager extends EventEmitter {
      * @param request The request data
      */
     private resolveRequest;
+    /**
+     * Stops the hash sweeping interval
+     */
+    clearHashSweeper(): void;
+    /**
+     * Stops the request handler sweeping interval
+     */
+    clearHandlerSweeper(): void;
     /**
      * Generates route data for an endpoint:method
      * @param endpoint The raw endpoint to generalize

package/dist/lib/errors/DiscordAPIError.d.ts

@@ -1,4 +1,4 @@
-import type { InternalRequest, RawAttachment } from '../RequestManager';
+import type { InternalRequest, RawFile } from '../RequestManager';
 interface DiscordErrorFieldInformation {
     code: string;
     message: string;
@@ -14,8 +14,12 @@ export interface DiscordErrorData {
     message: string;
     errors?: DiscordError;
 }
+export interface OAuthErrorData {
+    error: string;
+    error_description?: string;
+}
 export interface RequestBody {
-    attachments: RawAttachment[] | undefined;
+    files: RawFile[] | undefined;
     json: unknown | undefined;
 }
 /**
@@ -23,8 +27,8 @@ export interface RequestBody {
  * @extends Error
  */
 export declare class DiscordAPIError extends Error {
-    rawError: DiscordErrorData;
-    code: number;
+    rawError: DiscordErrorData | OAuthErrorData;
+    code: number | string;
     status: number;
     method: string;
     url: string;
@@ -37,7 +41,7 @@ export declare class DiscordAPIError extends Error {
      * @param url The url of the request that erred
      * @param bodyData The unparsed data for the request that errored
      */
-    constructor(rawError: DiscordErrorData, code: number, status: number, method: string, url: string, bodyData: Pick<InternalRequest, 'attachments' | 'body'>);
+    constructor(rawError: DiscordErrorData | OAuthErrorData, code: number | string, status: number, method: string, url: string, bodyData: Pick<InternalRequest, 'files' | 'body'>);
     /**
      * The name of the error
      */

package/dist/lib/errors/HTTPError.d.ts

@@ -17,5 +17,5 @@ export declare class HTTPError extends Error {
      * @param url The url of the request that erred
      * @param bodyData The unparsed data for the request that errored
      */
-    constructor(message: string, name: string, status: number, method: string, url: string, bodyData: Pick<InternalRequest, 'attachments' | 'body'>);
+    constructor(message: string, name: string, status: number, method: string, url: string, bodyData: Pick<InternalRequest, 'files' | 'body'>);
 }

package/dist/lib/handlers/IHandler.d.ts

@@ -1,5 +1,7 @@
 import type { RequestInit } from 'node-fetch';
 import type { InternalRequest, RouteData } from '../RequestManager';
 export interface IHandler {
-    queueRequest(routeId: RouteData, url: string, options: RequestInit, bodyData: Pick<InternalRequest, 'attachments' | 'body'>): Promise<unknown>;
+    queueRequest: (routeId: RouteData, url: string, options: RequestInit, bodyData: Pick<InternalRequest, 'files' | 'body'>) => Promise<unknown>;
+    readonly inactive: boolean;
+    readonly id: string;
 }

package/dist/lib/handlers/SequentialHandler.d.ts

@@ -69,7 +69,7 @@ export declare class SequentialHandler {
      * @param options All the information needed to make a request
      * @param bodyData The data that was used to form the body, passed to any errors generated and for determining whether to sublimit
      */
-    queueRequest(routeId: RouteData, url: string, options: RequestInit, bodyData: Pick<InternalRequest, 'attachments' | 'body'>): Promise<unknown>;
+    queueRequest(routeId: RouteData, url: string, options: RequestInit, bodyData: Pick<InternalRequest, 'files' | 'body'>): Promise<unknown>;
     /**
      * The method that actually makes the request to the api, and updates info about the bucket accordingly
      * @param routeId The generalized api route with literal ids for major parameters

package/dist/lib/utils/constants.d.ts

@@ -9,7 +9,9 @@ export declare const enum RESTEvents {
     InvalidRequestWarning = "invalidRequestWarning",
     RateLimited = "rateLimited",
     Request = "request",
-    Response = "response"
+    Response = "response",
+    HashSweep = "hashSweep",
+    HandlerSweep = "handlerSweep"
 }
 export declare const ALLOWED_EXTENSIONS: readonly ["webp", "png", "jpg", "jpeg", "gif"];
 export declare const ALLOWED_STICKER_EXTENSIONS: readonly ["png", "json"];

package/package.json

@@ -1,65 +1,90 @@
 {
-	"name": "@discordjs/rest",
-	"version": "0.2.0-canary.0",
-	"description": "The REST API for discord.js",
-	"scripts": {
-		"test": "echo \"Error: run tests from root\" && exit 1",
-		"build": "tsup && tsc --emitDeclarationOnly"
-	},
-	"main": "./dist/index.js",
-	"module": "./dist/index.mjs",
-	"typings": "./dist/index.d.ts",
-	"exports": {
-		"import": "./dist/index.mjs",
-		"require": "./dist/index.js"
-	},
-	"directories": {
-		"lib": "src",
-		"test": "__tests__"
-	},
-	"files": [
-		"dist"
-	],
-	"contributors": [
-		"Crawl <icrawltogo@gmail.com>",
-		"Amish Shah <amishshah.2k@gmail.com>",
-		"SpaceEEC <spaceeec@yahoo.com>",
-		"Vlad Frangu <kingdgrizzle@gmail.com>",
-		"Antonio Roman <kyradiscord@gmail.com>"
-	],
-	"license": "Apache-2.0",
-	"keywords": [
-		"discord",
-		"api",
-		"rest",
-		"discordapp",
-		"discordjs"
-	],
-	"repository": {
-		"type": "git",
-		"url": "git+https://github.com/discordjs/discord.js-modules.git"
-	},
-	"bugs": {
-		"url": "https://github.com/discordjs/discord.js-modules/issues"
-	},
-	"homepage": "https://github.com/discordjs/discord.js-modules/tree/main/packages/rest",
-	"dependencies": {
-		"@discordjs/collection": "^0.3.2",
-		"@sapphire/async-queue": "^1.1.9",
-		"@sapphire/snowflake": "^3.0.0",
-		"discord-api-types": "^0.25.2",
-		"form-data": "^4.0.0",
-		"node-fetch": "^2.6.5",
-		"tslib": "^2.3.1"
-	},
-	"devDependencies": {
-		"@types/node-fetch": "^2.5.10"
-	},
-	"engines": {
-		"node": ">=16.0.0"
-	},
-	"publishConfig": {
-		"access": "public"
-	},
-	"gitHead": "d006f270fd911e178b0b6f83cbfa88aa2ef626b7"
-}
+  "name": "@discordjs/rest",
+  "version": "0.3.0-dev.1644408653.fe11ff5",
+  "description": "The REST API for discord.js",
+  "scripts": {
+    "build": "tsup && tsc --emitDeclarationOnly --incremental",
+    "test": "jest --pass-with-no-tests --collect-coverage",
+    "lint": "prettier --check . && eslint src __tests__ --ext mjs,js,ts",
+    "format": "prettier --write . && eslint src __tests__ --ext mjs,js,ts --fix",
+    "docs": "typedoc --json docs/typedoc-out.json src/index.ts && node scripts/docs.mjs",
+    "prepublishOnly": "yarn build && yarn lint && yarn test",
+    "changelog": "git cliff --prepend ./CHANGELOG.md -u -c ./cliff.toml -r ../../ --include-path 'packages/rest/*'"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "typings": "./dist/index.d.ts",
+  "exports": {
+    "import": "./dist/index.mjs",
+    "require": "./dist/index.js"
+  },
+  "directories": {
+    "lib": "src",
+    "test": "__tests__"
+  },
+  "files": [
+    "dist"
+  ],
+  "contributors": [
+    "Crawl <icrawltogo@gmail.com>",
+    "Amish Shah <amishshah.2k@gmail.com>",
+    "SpaceEEC <spaceeec@yahoo.com>",
+    "Vlad Frangu <kingdgrizzle@gmail.com>",
+    "Antonio Roman <kyradiscord@gmail.com>"
+  ],
+  "license": "Apache-2.0",
+  "keywords": [
+    "discord",
+    "api",
+    "rest",
+    "discordapp",
+    "discordjs"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/discordjs/discord.js.git"
+  },
+  "bugs": {
+    "url": "https://github.com/discordjs/discord.js/issues"
+  },
+  "homepage": "https://discord.js.org",
+  "dependencies": {
+    "@discordjs/collection": "^0.6.0-dev",
+    "@sapphire/async-queue": "^1.2.0",
+    "@sapphire/snowflake": "^3.1.0",
+    "@types/node-fetch": "^2.5.12",
+    "discord-api-types": "^0.26.1",
+    "form-data": "^4.0.0",
+    "node-fetch": "^2.6.7",
+    "tslib": "^2.3.1"
+  },
+  "devDependencies": {
+    "@babel/core": "^7.17.0",
+    "@babel/plugin-proposal-decorators": "^7.17.0",
+    "@babel/preset-env": "^7.16.11",
+    "@babel/preset-typescript": "^7.16.7",
+    "@discordjs/ts-docgen": "^0.3.4",
+    "@types/jest": "^27.4.0",
+    "@typescript-eslint/eslint-plugin": "^5.10.2",
+    "@typescript-eslint/parser": "^5.10.2",
+    "babel-plugin-const-enum": "^1.2.0",
+    "babel-plugin-transform-typescript-metadata": "^0.3.2",
+    "eslint": "^8.8.0",
+    "eslint-config-marine": "^9.3.2",
+    "eslint-config-prettier": "^8.3.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "jest": "^27.4.7",
+    "nock": "^13.2.4",
+    "prettier": "^2.5.1",
+    "tsup": "^5.11.13",
+    "typedoc": "^0.22.11",
+    "typescript": "^4.5.5"
+  },
+  "engines": {
+    "node": ">=16.9.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "stableVersion": "0.3.0-dev"
+}