cloudstorm 0.4.0 → 0.4.3

package/dist/connector/DiscordConnector.js

@@ -6,7 +6,6 @@ const events_1 = require("events");
 const BetterWs_1 = __importDefault(require("../structures/BetterWs"));
 const Constants_1 = require("../Constants");
 const Intents_1 = __importDefault(require("../Intents"));
-const ws_1 = __importDefault(require("ws"));
 let reconnecting = false;
 /**
  * Class used for acting based on received events.
@@ -21,51 +20,44 @@ class DiscordConnector extends events_1.EventEmitter {
      */
     constructor(id, client) {
         super();
-        this.betterWs = null;
         this.heartbeatTimeout = null;
         this.heartbeatInterval = 0;
         this._trace = null;
         this.seq = 0;
-        this.status = "init";
+        this.status = "disconnected";
         this.sessionId = null;
         this.lastACKAt = 0;
         this.lastHeartbeatSend = 0;
         this.latency = 0;
+        this._closing = false;
         this.id = id;
         this.client = client;
         this.options = client.options;
         this.reconnect = this.options.reconnect || true;
-    }
-    /**
-     * Connect to Discord.
-     */
-    connect() {
-        if (!this.betterWs) {
-            this.betterWs = new BetterWs_1.default(this.options.endpoint, this.options.ws);
-        }
-        else {
-            this.betterWs.removeAllListeners();
-            this.betterWs.recreateWs(this.options.endpoint, this.options.ws);
-        }
+        this.betterWs = new BetterWs_1.default(this.options.endpoint, this.options.ws);
         this.betterWs.on("ws_open", () => {
             this.status = "connecting";
+            this.emit("stateChange", "connecting");
             reconnecting = false;
         });
         this.betterWs.on("ws_message", msg => this.messageAction(msg));
         this.betterWs.on("ws_close", (code, reason) => this.handleWsClose(code, reason));
-        this.betterWs.on("debug", event => {
-            this.client.emit("debug", event);
-        });
-        this.betterWs.on("debug_send", data => {
-            this.client.emit("rawSend", data);
-        });
+        this.betterWs.on("debug", event => this.client.emit("debug", event));
+        this.betterWs.on("debug_send", data => this.client.emit("rawSend", data));
+    }
+    /**
+     * Connect to Discord.
+     */
+    connect() {
+        this._closing = false;
+        return this.betterWs.connect();
     }
     /**
      * Close the websocket connection and disconnect.
      */
     async disconnect() {
-        var _a;
-        return (_a = this.betterWs) === null || _a === void 0 ? void 0 : _a.close(1000, "Disconnected by User");
+        this._closing = true;
+        return this.betterWs.close(1000, "Disconnected by User");
     }
     /**
      * Called with a parsed Websocket message to execute further actions.
@@ -96,9 +88,8 @@ class DiscordConnector extends events_1.EventEmitter {
                     this.disconnect();
                 break;
             case Constants_1.GATEWAY_OP_CODES.INVALID_SESSION:
-                if (message.d && this.sessionId) {
+                if (message.d && this.sessionId)
                     this.resume();
-                }
                 else {
                     this.seq = 0;
                     this.sessionId = "";
@@ -116,9 +107,8 @@ class DiscordConnector extends events_1.EventEmitter {
                         else
                             this.disconnect();
                     }
-                    else {
+                    else
                         this.heartbeat();
-                    }
                 }, this.heartbeatInterval);
                 this._trace = message.d._trace;
                 this.identify();
@@ -137,24 +127,15 @@ class DiscordConnector extends events_1.EventEmitter {
      * @param resume Whether or not the client intends to send an OP 6 RESUME later.
      */
     async _reconnect(resume = false) {
-        var _a, _b, _c;
         if (resume)
             reconnecting = true;
-        if (((_a = this.betterWs) === null || _a === void 0 ? void 0 : _a.ws.readyState) === ws_1.default.CONNECTING) {
-            this.emit("error", `Client was attempting to ${resume ? "resume" : "reconnect"} while the WebSocket was still in the connecting state. This should never happen.${this.options.reconnect ? " Restarting the connect loop." : ""}`);
-            this.reset();
-            if (this.options.reconnect)
-                this.connect();
-        }
-        // This is for instances where the gateway asks the client to reconnect. The ws would be closed by the time the code reaches here.
-        if (((_b = this.betterWs) === null || _b === void 0 ? void 0 : _b.ws.readyState) === ws_1.default.OPEN)
-            await ((_c = this.betterWs) === null || _c === void 0 ? void 0 : _c.close(resume ? 4000 : 1012, "reconnecting"));
-        if (resume) {
+        if (this.betterWs.status === 2)
+            void this.client.emit("error", `Client was attempting to ${resume ? "resume" : "reconnect"} while the WebSocket was still in the connecting state. This should never happen.`);
+        await this.betterWs.close(resume ? 4000 : 1012, "reconnecting");
+        if (resume)
             this.clearHeartBeat();
-        }
-        else {
+        else
             this.reset();
-        }
         this.connect();
     }
     /**
@@ -181,10 +162,12 @@ class DiscordConnector extends events_1.EventEmitter {
      * @param force Whether CloudStorm should send an OP 2 IDENTIFY even if there's a session that could be resumed.
      */
     async identify(force) {
-        var _a;
-        if (this.sessionId && !force) {
+        if (this.betterWs.status !== 1)
+            void this.client.emit("debug", "Client was attempting to identify when the ws was not open");
+        if (this.sessionId && !force)
             return this.resume();
-        }
+        this.status = "identifying";
+        this.emit("stateChange", "identifying");
         const data = {
             op: Constants_1.GATEWAY_OP_CODES.IDENTIFY,
             d: {
@@ -201,14 +184,17 @@ class DiscordConnector extends events_1.EventEmitter {
         };
         if (this.options.initialPresence)
             Object.assign(data.d, { presence: this._checkPresenceData(this.options.initialPresence) });
-        return (_a = this.betterWs) === null || _a === void 0 ? void 0 : _a.sendMessage(data);
+        return this.betterWs.sendMessage(data);
     }
     /**
      * Send an OP 6 RESUME to the gateway.
      */
     async resume() {
-        var _a;
-        return (_a = this.betterWs) === null || _a === void 0 ? void 0 : _a.sendMessage({
+        if (this.betterWs.status !== 1)
+            void this.client.emit("debug", "Client was attempting to resume when the ws was not open");
+        this.status = "resuming";
+        this.emit("stateChange", "resuming");
+        return this.betterWs.sendMessage({
             op: Constants_1.GATEWAY_OP_CODES.RESUME,
             d: { seq: this.seq, token: this.options.token, session_id: this.sessionId }
         });
@@ -217,10 +203,9 @@ class DiscordConnector extends events_1.EventEmitter {
      * Send an OP 1 HEARTBEAT to the gateway.
      */
     heartbeat() {
-        var _a, _b;
-        if (((_a = this.betterWs) === null || _a === void 0 ? void 0 : _a.ws.readyState) !== ws_1.default.OPEN)
-            return;
-        (_b = this.betterWs) === null || _b === void 0 ? void 0 : _b.sendMessage({ op: Constants_1.GATEWAY_OP_CODES.HEARTBEAT, d: this.seq });
+        if (this.betterWs.status !== 1)
+            void this.client.emit("debug", "Client was attempting to heartbeat when the ws was not open");
+        this.betterWs.sendMessage({ op: Constants_1.GATEWAY_OP_CODES.HEARTBEAT, d: this.seq });
         this.lastHeartbeatSend = Date.now();
     }
     /**
@@ -231,10 +216,10 @@ class DiscordConnector extends events_1.EventEmitter {
         switch (message.t) {
             case "READY":
             case "RESUMED":
-                if (message.t === "READY") {
+                if (message.t === "READY")
                     this.sessionId = message.d.session_id;
-                }
                 this.status = "ready";
+                this.emit("stateChange", "ready");
                 this._trace = message.d._trace;
                 this.emit("ready", message.t === "RESUMED");
                 this.emit("event", message);
@@ -249,94 +234,87 @@ class DiscordConnector extends events_1.EventEmitter {
      * @param reason Close reason if any.
      */
     handleWsClose(code, reason) {
-        var _a;
         let gracefulClose = false;
         this.status = "disconnected";
+        this.emit("stateChange", "disconnected");
         // Disallowed Intents.
-        if (code === 4014) {
-            this.emit("error", "Disallowed Intents, check your client options and application page.");
-        }
+        if (code === 4014)
+            this.client.emit("error", "Disallowed Intents, check your client options and application page.");
         // Invalid Intents.
-        if (code === 4013) {
-            this.emit("error", "Invalid Intents data, check your client options.");
-        }
+        if (code === 4013)
+            this.client.emit("error", "Invalid Intents data, check your client options.");
         // Invalid API version.
-        if (code === 4012) {
-            this.emit("error", "Invalid API version.");
-        }
+        if (code === 4012)
+            this.client.emit("error", "Invalid API version.");
         // Sharding required.
-        if (code === 4011) {
-            this.emit("error", "Shard would be on over 2500 guilds. Add more shards.");
-        }
+        if (code === 4011)
+            this.client.emit("error", "Shard would be on over 2500 guilds. Add more shards.");
         // Invalid shard.
-        if (code === 4010) {
-            this.emit("error", "Invalid sharding data, check your client options.");
-        }
+        if (code === 4010)
+            this.client.emit("error", "Invalid sharding data, check your client options.");
         // Session timed out.
         // force identify if the session is marked as invalid.
         if (code === 4009) {
-            this.emit("error", "Session timed out.");
+            this.client.emit("error", "Session timed out.");
             this.clearHeartBeat();
             this.connect();
         }
         // Rate limited.
         if (code === 4008) {
-            this.emit("error", "You are being rate limited. Wait before sending more packets.");
+            this.client.emit("error", "You are being rate limited. Wait before sending more packets.");
             this.clearHeartBeat();
             this.connect();
         }
         // Invalid sequence.
         if (code === 4007) {
-            this.emit("error", "Invalid sequence. Reconnecting and starting a new session.");
+            this.client.emit("error", "Invalid sequence. Reconnecting and starting a new session.");
             this.reset();
             this.connect();
         }
         // Already authenticated.
         if (code === 4005) {
-            this.emit("error", "You sent more than one OP 2 IDENTIFY payload while the websocket was open.");
+            this.client.emit("error", "You sent more than one OP 2 IDENTIFY payload while the websocket was open.");
             this.clearHeartBeat();
             this.connect();
         }
         // Authentication failed.
-        if (code === 4004) {
-            this.emit("error", "Tried to connect with an invalid token");
-        }
+        if (code === 4004)
+            this.client.emit("error", "Tried to connect with an invalid token");
         // Not authenticated.
         if (code === 4003) {
-            this.emit("error", "You tried to send a packet before sending an OP 2 IDENTIFY or OP 6 RESUME.");
+            this.client.emit("error", "You tried to send a packet before sending an OP 2 IDENTIFY or OP 6 RESUME.");
             this.clearHeartBeat();
             this.connect();
         }
         // Decode error.
         if (code === 4002) {
-            this.emit("error", "You sent an invalid payload");
+            this.client.emit("error", "You sent an invalid payload");
             this.clearHeartBeat();
             this.connect();
         }
         // Invalid opcode.
         if (code === 4001) {
-            this.emit("error", "You sent an invalid opcode or invalid payload for an opcode");
+            this.client.emit("error", "You sent an invalid opcode or invalid payload for an opcode");
             this.clearHeartBeat();
             this.connect();
         }
         // Generic error / safe self closing code.
         if (code === 4000) {
-            if (reconnecting) {
+            if (reconnecting)
                 gracefulClose = true;
-            }
             else {
-                this.emit("error", "Error code 4000 received. Attempting to resume");
+                this.client.emit("error", "Error code 4000 received. Attempting to resume");
                 this.clearHeartBeat();
                 this.connect();
             }
         }
         // Don't try to reconnect when true
-        if (code === 1000 && reason === "Disconnected by User") {
+        if (code === 1000 && this._closing)
             gracefulClose = true;
-        }
+        this._closing = false;
         if (gracefulClose) {
             this.clearHeartBeat();
-            (_a = this.betterWs) === null || _a === void 0 ? void 0 : _a.removeAllListeners();
+            this.betterWs.removeAllListeners();
         }
         this.emit("disconnect", code, reason, gracefulClose);
     }
@@ -345,27 +323,23 @@ class DiscordConnector extends events_1.EventEmitter {
      * @param data Presence data to send.
      */
     async presenceUpdate(data) {
-        var _a;
-        return (_a = this.betterWs) === null || _a === void 0 ? void 0 : _a.sendMessage({ op: Constants_1.GATEWAY_OP_CODES.PRESENCE_UPDATE, d: this._checkPresenceData(data) });
+        return this.betterWs.sendMessage({ op: Constants_1.GATEWAY_OP_CODES.PRESENCE_UPDATE, d: this._checkPresenceData(data) });
     }
     /**
      * Send an OP 4 VOICE_STATE_UPDATE to the gateway.
      * @param data Voice state update data to send.
      */
     async voiceStateUpdate(data) {
-        var _a;
-        if (!data) {
+        if (!data)
             return Promise.resolve();
-        }
-        return (_a = this.betterWs) === null || _a === void 0 ? void 0 : _a.sendMessage({ op: Constants_1.GATEWAY_OP_CODES.VOICE_STATE_UPDATE, d: this._checkVoiceStateUpdateData(data) });
+        return this.betterWs.sendMessage({ op: Constants_1.GATEWAY_OP_CODES.VOICE_STATE_UPDATE, d: this._checkVoiceStateUpdateData(data) });
     }
     /**
      * Send an OP 8 REQUEST_GUILD_MEMBERS to the gateway.
      * @param data Data to send.
      */
     async requestGuildMembers(data) {
-        var _a;
-        return (_a = this.betterWs) === null || _a === void 0 ? void 0 : _a.sendMessage({ op: Constants_1.GATEWAY_OP_CODES.REQUEST_GUILD_MEMBERS, d: this._checkRequestGuildMembersData(data) });
+        return this.betterWs.sendMessage({ op: Constants_1.GATEWAY_OP_CODES.REQUEST_GUILD_MEMBERS, d: this._checkRequestGuildMembersData(data) });
     }
     /**
      * Checks presence data and fills in missing elements.

package/dist/structures/BetterWs.d.ts

@@ -1,10 +1,7 @@
 /// <reference types="node" />
 import { EventEmitter } from "events";
-import zlib from "zlib-sync";
-import WebSocket from "ws";
 import RatelimitBucket from "./RatelimitBucket";
 interface BWSEvents {
-    error: [Error | string];
     ws_open: [];
     ws_close: [number, string];
     ws_message: [import("../Types").IGatewayMessage];
@@ -30,58 +27,24 @@ interface BetterWs {
  * Helper Class for simplifying the websocket connection to Discord.
  */
 declare class BetterWs extends EventEmitter {
-    ws: WebSocket;
+    encoding: "etf" | "json";
+    compress: boolean;
+    address: string;
+    options: import("../Types").IClientWSOptions;
     wsBucket: RatelimitBucket;
     presenceBucket: RatelimitBucket;
-    zlibInflate: zlib.Inflate | null;
-    options: import("../Types").IClientWSOptions;
-    compress: boolean;
-    static readonly default: typeof BetterWs;
-    /**
-     * Create a new BetterWs instance.
-     */
-    constructor(address: string, options?: import("../Types").IClientWSOptions);
-    /**
-     * Get the raw websocket connection currently used.
-     */
-    get rawWs(): WebSocket;
-    /**
-     * Add eventlisteners to a passed websocket connection.
-     * @param ws Websocket.
-     */
-    private bindWs;
-    /**
-     * Create a new websocket connection if the old one was closed/destroyed.
-     * @param address Address to connect to.
-     * @param options Options used by the websocket connection.
-     */
-    recreateWs(address: string, options?: import("../Types").IClientWSOptions): void;
-    /**
-     * Called upon opening of the websocket connection.
-     */
-    private onOpen;
-    /**
-     * Called once a websocket message is received,
-     * uncompresses the message using zlib and parses it via Erlpack or JSON.parse.
-     * @param message Message received by websocket.
-     */
-    private onMessage;
-    /**
-     * Called when the websocket connection closes for some reason.
-     * @param code Websocket close code.
-     * @param reason Reason of the close if any.
-     */
-    private onClose;
-    /**
-     * Send a message to the Discord gateway.
-     * @param data Data to send.
-     */
-    sendMessage(data: any): Promise<void>;
-    /**
-     * Close the current websocket connection.
-     * @param code Websocket close code to use.
-     * @param reason Reason of the disconnect.
-     */
-    close(code?: number, reason?: string): Promise<void>;
+    private _socket;
+    private _internal;
+    private _connecting;
+    constructor(address: string, options: import("../Types").IClientWSOptions);
+    get status(): 2 | 3 | 4 | 1;
+    connect(): Promise<void>;
+    close(code: number, reason?: string): Promise<void>;
+    sendMessage(data: import("../Types").IWSMessage): Promise<void>;
+    private _write;
+    private _onError;
+    private _onClose;
+    private _onReadable;
+    private _processFrame;
 }
 export = BetterWs;