@jnode/discord 1.0.6 → 1.0.8

package/README.md

@@ -1,2 +1,119 @@
 # JustDiscord
+
 Simple Discord API package for Node.js.
+
+```shell
+npm install @jnode/discord
+```
+
+## Basic usage
+
+```js
+// import JustDiscord
+const discord = require('@jnode/discord');
+
+// create a client
+const client = new discord.Client('YOUR_BOT_TOKEN');
+
+// connect to Discord gateway
+client.connectGateway((gateway) => {
+    // receive Discord gateway "READY" event
+    gateway.on('READY', (d) => {
+        console.log('Connected to Discord.');
+    });
+});
+```
+
+## DiscordClient
+
+### Constructor
+
+```js
+constructor(token, options = {})
+```
+
+*   `token`: Your Discord bot token.
+*   `options`: An object containing client options.
+    *   `apiVersion`: The Discord API version to use. (default: `10`)
+    *   `apiBase`: The base URL for the Discord API. (default: `'discord.com/api'`)
+    *   `apiAutoRetry`: Whether to automatically retry requests when receiving a 429 status code. (default: `true`)
+    *   `apiThrowError`: Whether to throw an error when an API request returns a status code outside of the 2xx range. (default: `true`)
+    *   `gatewayIntents`: The gateway intents to use. (default: `0b11111111111111111000110011`)
+    *   `gatewayUrl`: The URL for the Discord gateway. (default: `'wss://gateway.discord.gg'`)
+    *   `gatewayReconnectDelay`: The delay in milliseconds before attempting to reconnect to the gateway. (default: `5000`)
+    *   `gatewayConnectTimeout`: The timeout in milliseconds for the gateway connection. (default: `5000`)
+    *    `gatewayThrowError`: Whether to throw an error when the gateway encounters an issue. (default: `true`)
+
+### Methods
+
+#### `apiUrl(path)`
+
+Returns the full API URL with the base, version, and provided path.
+
+*   `path`: The API endpoint path.
+
+#### `async apiRequest(method = 'GET', path = '/', body)`
+
+Makes a request to the Discord API.
+
+*   `method`: The HTTP method (`GET`, `POST`, `PUT`, `PATCH`, `DELETE`). (default: `'GET'`)
+*   `path`: The API endpoint path. (default: `'/'`)
+*   `body`: The request body (will be stringified to JSON). (optional)
+
+#### `async apiRequestMultipart(method = 'GET', path = '/', body, attachments = [])`
+
+Makes a multipart request to the Discord API.
+
+*    `method`: The HTTP method (`GET`, `POST`, `PUT`, `PATCH`, `DELETE`). (default: `'GET'`)
+*   `path`: The API endpoint path. (default: `'/'`)
+*   `body`: The request body (will be stringified to JSON).
+*   `attachments`: An array of attachment objects. Each attachment object should have the following properties:
+    *   `name`: The file name.
+    *   `type`: The content type of the file.
+    *   `data`: The file data (Buffer or Uint8Array).
+	*	`encoded`: Boolean, should be true if the data has already been encoded.
+
+#### `async connectGateway(cb)`
+
+Connects to the Discord gateway.
+
+*   `cb`: A callback function that will be called with the `DiscordGateway` instance.
+
+## DiscordGateway
+
+### Events
+
+*   `socketOpened`: Emitted when the WebSocket connection is opened.
+*   `socketClosed`: Emitted when the WebSocket connection is closed.
+*   `socketError`: Emitted when an error occurs with the WebSocket connection.
+*   `socketMessage`: Emitted when a message is received from the WebSocket.
+*   `message`: Emitted when a message with json data is received from the WebSocket.
+*   `READY`: Emitted when the gateway sends a `READY` event.
+*	 Other events may be emitted depending on the received `t` value, such as `MESSAGE_CREATE`, `GUILD_CREATE`.
+
+### Methods
+
+#### `async getGatewayUrl()`
+
+Gets the gateway URL from the Discord API.
+
+#### `connect()`
+
+Connects to the Discord gateway.
+
+#### `sendMessage(op, d = null)`
+
+Sends a message to the Discord gateway.
+
+*   `op`: The opcode of the message.
+*   `d`: The data of the message. (optional)
+
+## Errors
+
+### DiscordAPIError
+
+Thrown when an API request returns a status code outside of the 2xx range.
+
+*   `code`: The HTTP status code.
+*   `body`: The response body.
+*   `headers`: The response headers.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jnode/discord",
-  "version": "1.0.6",
+  "version": "1.0.8",
   "description": "Simple Discord API package for Node.js.",
   "main": "src/index.js",
   "scripts": {
@@ -25,6 +25,6 @@
     "node": ">=22.4.0"
   },
   "dependencies": {
-    "@jnode/request": "1.x.x"
+    "@jnode/request": ">=1.0.4 <2.0.0"
   }
 }