@jnode/discord 1.0.0 → 1.0.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jnode/discord",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "Simple Discord API package for Node.js.",
   "main": "src/index.js",
   "scripts": {

package/src/client.js

@@ -0,0 +1,124 @@
+/*
+JustDiscord/client.js
+v.1.0.0
+
+Simple Discord API package for Node.js.
+Must use Node.js v22.4.0 or later for WebSocket (Discord gateway).
+
+by JustNode Dev Team / JustApple
+*/
+
+//load jnode packages
+const request = require('@jnode/request');
+
+//load classes and functions
+const DiscordGateway = require('./gateway.js');
+const error = require('./error.js');
+
+//error types
+//errors from Discord API
+class DiscordAPIError extends Error {
+	constructor(code, body, headers) {
+		super(`Discord API respond with code ${code}.`);
+		this.body = body;
+		this.headers = headers;
+	}
+}
+
+//Discord Client, everything starts here
+class DiscordClient  {
+	constructor(token, options = {}) {
+		this.token = token;
+		
+		//client api options
+		this.apiVersion = options.apiVersion ?? 10;
+		this.apiBase = options.apiBase ?? 'discord.com/api';
+		this.apiAutoRetry = options.apiAutoRetry ?? true;
+		this.apiThrowError = options.apiThrowError ?? true; //throw error while api status code is not 2xx
+		
+		//client gateway options
+		this.gatewayIntents = options.gatewayIntents ?? 0b11111111111111111000110011;
+		this.gatewayUrl = options.gatewayUrl ?? 'wss://gateway.discord.gg';
+		this.gatewayOriginalUrl = this.gatewayUrl;
+		this.gatewayReconnectDelay = options.gatewayReconnectDelay ?? 5000; //less than 0 to disable auto reconnect
+		this.gatewayConnectTimeout = options.gatewayConnectTimeout ?? 5000; //less than 0 to disable connect timeout (may cause error)
+		this.gatewayThrowError = options.gatewayThrowError ?? true; //throw error while gateway went something wrong
+		
+		//gateway
+		this.gateway = new DiscordGateway(this);
+	}
+	
+	//get full api url with base, version and path
+	apiUrl(path) {
+		return `https://${this.apiBase}/v${this.apiVersion}${path}`;
+	}
+	
+	//make an request to Discord
+	async apiRequest(method = 'GET', path = '/', body) {
+		const res = await request.request(method, this.apiUrl(path), {
+			'Authorization': `Bot ${this.token}`,
+			'User-Agent': 'DiscordBot',
+			'Content-Type': (body !== undefined) ? 'application/json' : null
+		}, (body !== undefined) ? JSON.stringify(body) : undefined); //make an request
+		
+		if ((res.code === 429) && this.apiAutoRetry) { //retry if recieved 429
+			await delay(res.json.retry_after);
+			return this.apiRequest(method, path, body);
+		}
+		
+		if (((res.code > 299) || (res.code < 200)) && this.apiThrowError) { //throw error if not 2xx
+			throw new DiscordAPIError(res.code, res.json ?? res.body, res.headers);
+		}
+		
+		return res;
+	}
+	
+	//make an multi part request to Discord
+	async apiRequestMultipart(method = 'GET', path = '/', body, attachments = []) {
+		let parts = [];
+		parts.push({ //json data
+			disposition: 'name="payload_json"',
+			contentType: 'application/json',
+			data: JSON.stringify(body)
+		});
+		
+		for (let i = 0; i < attachments.length; i++) { //add every attachment
+			parts.push({
+				disposition: `name="files[${i}]"; filename="${encodeURIComponent(attachments[i].name)}"`,
+				contentType: attachments[i].type,
+				data: attachments[i].data,
+				encoded: attachments[i].encoded
+			});
+		}
+		
+		const res = await request(method, this.apiUrl(path), {
+			'Authorization': `Bot ${this.token}`,
+			'User-Agent': 'DiscordBot',
+			'Content-Type': 'multipart/form-data; boundary=----JustDiscordFormBoundary'
+		}, request.generateMultipartBody(parts)); //make an request
+		
+		if ((res.code === 429) && this.apiAutoRetry) { //retry if recieved 429
+			await delay(res.json.retry_after);
+			return this.apiRequest(method, path, body, multipart, true);
+		}
+		
+		if (((res.code > 299) || (res.code < 200)) && this.apiThrowError) { //throw error if not 2xx
+			throw new DiscordAPIError(res.code, res.json ?? res.body, res.headers);
+		}
+		
+		return res;
+	}
+	
+	async connectGateway() {
+		await this.gateway.getGatewayUrl();
+		this.gateway.connect();
+		return this.gateway;
+	}
+}
+
+//wait time (ms)
+function delay(ms) {
+	return new Promise((resolve, reject) => { setTimeout(resolve, ms); });
+}
+
+module.exports = DiscordClient;

package/src/gateway.js

@@ -0,0 +1,151 @@
+/*
+JustDiscord/gateway.js
+v.1.0.0
+
+Simple Discord API package for Node.js.
+Must use Node.js v22.4.0 or later for WebSocket (Discord gateway).
+
+by JustNode Dev Team / JustApple
+*/
+
+//load classes and functions
+//errors from Discord Gateway
+class DiscordGatewayError extends Error { constructor(...i) { super(...i); } }
+
+//load node packages
+const EventEmitter = require('events');
+
+//Discord Gateway, recieve live messages with WebSocket
+class DiscordGateway extends EventEmitter {
+	constructor(client) {
+		super();
+		
+		this.client = client;
+		this.socket = {};
+		this.s = null;
+	}
+	
+	//get gateway url from api
+	async getGatewayUrl() {
+		const res = await this.client.apiRequest('GET', '/gateway/bot'); //make an api request
+		this.client.gatewayUrl = res.json.url;
+		this.client.gatewayOriginalUrl = res.json.url;
+		return res.json.url;
+	}
+	
+	//connect to gateway
+	connect() {
+		if ((this.socket.readyState !== 3) && this.socket.close) this.socket.close(); //close privous connect
+		
+		this.socket = new WebSocket(`${this.client.gatewayUrl}?v=${this.client.apiVersion}&encoding=json`); //connect
+		
+		if (this.client.gatewayConnectTimeout !== 0) { //set connect timeout
+			this.connectTimeout = setTimeout(() => {
+				this.socket.close(); //close socket
+				this.emit('timeout');
+				
+				if (this.client.gatewayReconnectDelay >= 0) { //if auto reconnect is allowed
+					setTimeout(() => {
+						this.connect();
+					}, this.client.gatewayReconnectDelay); //reconnect after specific time
+				}
+			}, this.client.gatewayConnectTimeout);
+		}
+		
+		this.socket.addEventListener('open', (event) => { //socket opened
+			this.emit('socketOpened', event); //send event with socket event
+			clearTimeout(this.connectTimeout); //clear timeout if successfully connected
+		});
+		
+		this.socket.addEventListener('close', (event) => { //socket closed
+			this.emit('socketClosed', event); //send event with event (may have close code and reason)
+			clearInterval(this.heartbeatInterval); //clear heatbeat interval
+			
+			
+			if (this.client.gatewayReconnectDelay >= 0) { //if auto reconnect is allowed
+				setTimeout(() => {
+					this.connect();
+				}, this.client.gatewayReconnectDelay); //reconnect after specific time
+			}
+		});
+		
+		this.socket.addEventListener('error', (event) => { //socket error
+			this.emit('socketError', event); //send event with event (may have error info)
+		});
+		
+		this.socket.addEventListener('message', (event) => { //recieve gateway message
+			try {
+				this.emit('socketMessage', event); //send event with event (may have data and more)
+				
+				const data = JSON.parse(event.data); //parse json data
+				this.emit('message', data); //send event with json data
+				
+				//auto handle by op
+				switch (data.op) {
+					case 0: //Dispatch
+						this.emit(data.t, data.d); //send t event with d
+						this.s = data.s ?? this.s; //save s number there is
+						
+						//auto handle by t
+						switch (data.t) {
+							case 'READY': //save resume data
+								this.sessionId = data.d['session_id'];
+								this.client.gatewayUrl = data.d['resume_gateway_url'];
+								break;
+							default:
+								break;
+						}
+						break;
+					case 7: //Reconnect, need to reconnect
+						this.socket.close(); //close socket
+						break;
+					case 9: //Invalid Session, need to reconnect
+						this.client.gatewayUrl = this.client.gatewayOriginalUrl; //reset url
+						this.sessionId = undefined; //reset session id
+						this.socket.close(); //close socket
+						break;
+					case 10: //Hello
+						this.heartbeatIntervalMS = data.d['heartbeat_interval'] * 0.9; //save heart beat interval time
+						this.sendMessage(1); //send first heartbeat
+						
+						clearInterval(this.heartbeatInterval); //clear old interval
+						this.heartbeatInterval = setInterval(() => { //start heartbeat interval
+							this.sendMessage(1);
+						}, this.heartbeatIntervalMS);
+						
+						if (this.sessionId) { //may be resumed
+							this.sendMessage(6, { //Resume
+								token: this.client.token,
+								session_id: this.sessionId,
+								seq: this.s
+							});
+						} else { //start new session
+							this.sendMessage(2, { //Identify
+								token: this.client.token,
+								properties: {
+									os: process.platform,
+									browser: 'Node.js',
+									device: 'JustDiscord'
+								},
+								intents: this.client.gatewayIntents
+							});
+						}
+						break;
+					default:
+						break;
+				}
+			} catch (err) {
+				if (this.client.gatewayThrowError) { //throw gateway error
+					err.name = 'DiscordGatewayError'; //change the name of the error
+					throw err;
+				}
+			}
+		});
+	}
+	
+	sendMessage(op, d = null) {
+		this.socket.send(JSON.stringify({ op, d }));
+	}
+}
+
+module.exports = DiscordGateway;

package/src/index.js

@@ -1,5 +1,5 @@
 /*
-JustDiscord
+JustDiscord/index.js
 v.1.0.0
 
 Simple Discord API package for Node.js.
@@ -8,4 +8,10 @@ Must use Node.js v22.4.0 or later for WebSocket (Discord gateway).
 by JustNode Dev Team / JustApple
 */
 
-require('@jnode/request')
+//load node packages
+const EventEmitter = require('events');
+
+module.exports = {
+	client: require('./client.js'),
+	gateway: require('./gateway.js')
+};