cloudstorm 0.3.2 → 0.4.2

package/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright 2021 DasWolke
+Copyright 2022 DasWolke
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

package/README.md

@@ -17,9 +17,7 @@ const { Client } = require("cloudstorm");
 const bot = new Client(token, { intents: ["GUILDS"] });
 const startup = async () => {
 	await bot.connect();
-	bot.on("ready", () => {
-		console.log("Bot received ready event");
-	});
+	bot.on("ready", () => console.log("Bot received ready event"););
 };
 startup().catch(e => {
 	console.error("Error on startup!");
@@ -44,7 +42,7 @@ So an event you receive may look like this:
 		"roles": [],
 		"status": "offline",
 		"user": {
-		"id": "id"
+			"id": "id"
 		}
 	}
 }
@@ -56,6 +54,6 @@ I've written a general whitepaper on the idea of microservice bots, which you ca
 You can find the docs at [https://daswolke.github.io/CloudStorm/](https://daswolke.github.io/CloudStorm/)
 
 ### Installation:
-To install CloudStorm, make sure that you have node 8 or higher and npm installed on your computer.
+To install CloudStorm, make sure that you have node 12 or higher and npm installed on your computer.
 
 Then run the following command in a terminal `npm install cloudstorm`

package/dist/Client.d.ts

@@ -41,7 +41,7 @@ declare class Client extends EventEmitter {
         endpoint?: string;
     };
     shardManager: ShardManager;
-    version: any;
+    version: string;
     private _restClient;
     static readonly default: typeof Client;
     /**
@@ -63,7 +63,11 @@ declare class Client extends EventEmitter {
      * Get the GatewayData including recommended amount of shards.
      * @returns Object with url and shards to use to connect to discord.
      */
-    getGatewayBot(): Promise<any>;
+    getGatewayBot(): Promise<{
+        url: string;
+        shards: number;
+        session_start_limit: import("discord-typings").SessionStartLimit;
+    }>;
     /**
      * Disconnect the bot gracefully,
      * you will receive a 'disconnected' event once the ShardManager successfully closes all shard websocket connections.
@@ -84,7 +88,7 @@ declare class Client extends EventEmitter {
      * 	client.presenceUpdate({ status: "dnd", game: { name: "Memes are Dreams" } });
      * });
      */
-    presenceUpdate(data: import("./Types").IPresence): Promise<void>;
+    presenceUpdate(data: import("discord-typings").GatewayPresenceUpdate): Promise<void>;
     /**
      * Send an OP 3 PRESENCE_UPDATE to Discord, which updates the status of a single shard facilitated by this client's ShardManager.
      * @param shardId id of the shard that should update it's status.
@@ -102,7 +106,7 @@ declare class Client extends EventEmitter {
      * 	client.shardPresenceUpdate(0, { status: "dnd", game: { name: "Im shard 0" } });
      * });
      */
-    shardStatusUpdate(shardId: number, data: import("./Types").IPresence): Promise<void>;
+    shardStatusUpdate(shardId: number, data: import("discord-typings").GatewayPresenceUpdate): Promise<void>;
     /**
      * Send an OP 4 VOICE_STATE_UPDATE to Discord. this does **not** allow you to send audio with CloudStorm itself,
      * it just provides the necessary data for another application to send audio data to Discord.
@@ -122,7 +126,10 @@ declare class Client extends EventEmitter {
      * 	client.voiceStateUpdate(0, { guild_id: "id", channel_id: "id", self_mute: false, self_deaf: false });
      * });
      */
-    voiceStateUpdate(shardId: number, data: import("./Types").IVoiceStateUpdate): Promise<void>;
+    voiceStateUpdate(shardId: number, data: import("discord-typings").VoiceStateUpdatePayload & {
+        self_deaf?: boolean;
+        self_mute?: boolean;
+    }): Promise<void>;
     /**
      * Send an OP 8 REQUEST_GUILD_MEMBERS to Discord.
      * @param shardId id of the shard that should send the payload.
@@ -141,7 +148,9 @@ declare class Client extends EventEmitter {
      * 	client.requestGuildMembers(0, { guild_id: "id" });
      * });
      */
-    requestGuildMembers(shardId: number, data: import("./Types").IRequestGuildMembers): Promise<void>;
+    requestGuildMembers(shardId: number, data: import("discord-typings").GuildRequestMembersPayload & {
+        limit?: number;
+    }): Promise<void>;
     /**
      * Update the endpoint shard websockets will connect to.
      * @param gatewayUrl Base gateway wss url to update the cached endpoint to.

package/dist/Client.js

@@ -4,13 +4,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 const version = require("../package.json").version;
 const events_1 = require("events");
-let Erlpack;
-try {
-    Erlpack = require("erlpack");
-}
-catch (e) {
-    Erlpack = null;
-}
 const Constants_1 = __importDefault(require("./Constants"));
 const snowtransfer_1 = require("snowtransfer");
 const ShardManager_1 = __importDefault(require("./ShardManager"));
@@ -24,9 +17,8 @@ class Client extends events_1.EventEmitter {
      */
     constructor(token, options = {}) {
         super();
-        if (!token) {
+        if (!token)
             throw new Error("Missing token!");
-        }
         this.options = {
             largeGuildThreshold: 250,
             firstShardId: 0,
@@ -37,7 +29,7 @@ class Client extends events_1.EventEmitter {
             token: "",
             ws: {
                 compress: true,
-                socket: undefined
+                encoding: "json"
             }
         };
         this._restClient = options.snowtransferInstance ? options.snowtransferInstance : new snowtransfer_1.SnowTransfer(token);
@@ -53,8 +45,8 @@ class Client extends events_1.EventEmitter {
      * @returns This function returns a promise which is solely used for awaiting the getGateway() method's return value.
      */
     async connect() {
-        const gatewayUrl = await this.getGateway();
-        this._updateEndpoint(gatewayUrl);
+        const gateway = await this.getGateway();
+        this._updateEndpoint(gateway);
         this.shardManager.spawn();
     }
     /**
@@ -95,8 +87,7 @@ class Client extends events_1.EventEmitter {
      * });
      */
     async presenceUpdate(data) {
-        await this.shardManager.presenceUpdate(data);
-        void undefined;
+        return this.shardManager.presenceUpdate(data);
     }
     /**
      * Send an OP 3 PRESENCE_UPDATE to Discord, which updates the status of a single shard facilitated by this client's ShardManager.
@@ -159,9 +150,8 @@ class Client extends events_1.EventEmitter {
      * });
      */
     requestGuildMembers(shardId, data) {
-        if (!data.guild_id) {
+        if (!data.guild_id)
             throw new Error("You need to pass a guild_id");
-        }
         return this.shardManager.requestGuildMembers(shardId, data);
     }
     /**
@@ -169,8 +159,8 @@ class Client extends events_1.EventEmitter {
      * @param gatewayUrl Base gateway wss url to update the cached endpoint to.
      */
     _updateEndpoint(gatewayUrl) {
-        var _a;
-        this.options.endpoint = `${gatewayUrl}?v=${Constants_1.default.GATEWAY_VERSION}&encoding=${Erlpack ? "etf" : "json"}${((_a = this.options.ws) === null || _a === void 0 ? void 0 : _a.compress) ? "&compress=zlib-stream" : ""}`;
+        var _a, _b;
+        this.options.endpoint = `${gatewayUrl}?v=${Constants_1.default.GATEWAY_VERSION}&encoding=${((_a = this.options.ws) === null || _a === void 0 ? void 0 : _a.encoding) === "etf" ? "etf" : "json"}${((_b = this.options.ws) === null || _b === void 0 ? void 0 : _b.compress) ? "&compress=zlib-stream" : ""}`;
     }
 }
 Client.default = Client;

package/dist/Constants.d.ts

@@ -44,6 +44,6 @@ export declare const GATEWAY_OP_CODES: {
      */
     HEARTBEAT_ACK: 11;
 };
-export declare const GATEWAY_VERSION = 9;
+export declare const GATEWAY_VERSION = 10;
 declare const _default: typeof import("./Constants");
 export default _default;

package/dist/Constants.js

@@ -47,5 +47,5 @@ exports.GATEWAY_OP_CODES = {
      */
     HEARTBEAT_ACK: 11
 };
-exports.GATEWAY_VERSION = 9;
+exports.GATEWAY_VERSION = 10;
 exports.default = exports;

package/dist/Intents.d.ts

@@ -14,6 +14,8 @@ export declare const flags: {
     DIRECT_MESSAGES: number;
     DIRECT_MESSAGE_REACTIONS: number;
     DIRECT_MESSAGE_TYPING: number;
+    MESSAGE_CONTENT: number;
+    GUILD_SCHEDULED_EVENTS: number;
 };
 export declare const privileged: number;
 export declare const all: number;

package/dist/Intents.js

@@ -17,8 +17,10 @@ exports.flags = {
     DIRECT_MESSAGES: 1 << 12,
     DIRECT_MESSAGE_REACTIONS: 1 << 13,
     DIRECT_MESSAGE_TYPING: 1 << 14,
+    MESSAGE_CONTENT: 1 << 15,
+    GUILD_SCHEDULED_EVENTS: 1 >> 16
 };
-exports.privileged = exports.flags.GUILD_MEMBERS | exports.flags.GUILD_PRESENCES | exports.flags.GUILD_MESSAGES;
+exports.privileged = exports.flags.GUILD_MEMBERS | exports.flags.GUILD_PRESENCES | exports.flags.MESSAGE_CONTENT;
 exports.all = Object.values(exports.flags).reduce((acc, p) => acc | p, 0);
 exports.non_privileged = exports.all & ~exports.privileged;
 function resolve(bit = 0) {

package/dist/Shard.d.ts

@@ -3,7 +3,6 @@ import { EventEmitter } from "events";
 import DiscordConnector from "./connector/DiscordConnector";
 interface ShardEvents {
     disconnect: [number, string, boolean];
-    error: [string];
     ready: [boolean];
     queueIdentify: [number];
 }
@@ -55,16 +54,21 @@ declare class Shard extends EventEmitter {
      * Send an OP 3 PRESENCE_UPDATE to Discord.
      * @param data Data to send.
      */
-    presenceUpdate(data: import("./Types").IPresence): Promise<void>;
+    presenceUpdate(data: import("discord-typings").GatewayPresenceUpdate): Promise<void>;
     /**
      * Send an OP 4 VOICE_STATE_UPDATE to Discord.
      * @param data Data to send
      */
-    voiceStateUpdate(data: import("./Types").IVoiceStateUpdate): Promise<void>;
+    voiceStateUpdate(data: import("discord-typings").VoiceStateUpdatePayload & {
+        self_deaf?: boolean;
+        self_mute?: boolean;
+    }): Promise<void>;
     /**
      * Send an OP 8 REQUEST_GUILD_MEMBERS to Discord.
      * @param data Data to send.
      */
-    requestGuildMembers(data: import("./Types").IRequestGuildMembers): Promise<void>;
+    requestGuildMembers(data: import("discord-typings").GuildRequestMembersPayload & {
+        limit?: number;
+    }): Promise<void>;
 }
 export = Shard;

package/dist/Shard.js

@@ -40,15 +40,8 @@ class Shard extends events_1.EventEmitter {
             this.ready = false;
             this.emit("disconnect", ...args);
         });
-        this.connector.on("error", (err) => {
-            this.emit("error", err);
-        });
-        this.connector.on("ready", (resume) => {
-            this.emit("ready", resume);
-        });
-        this.connector.on("queueIdentify", () => {
-            this.emit("queueIdentify", this.id);
-        });
+        this.connector.on("ready", (resume) => this.emit("ready", resume));
+        this.connector.on("queueIdentify", () => this.emit("queueIdentify", this.id));
     }
     /**
      * Time in ms it took for Discord to ackknowledge an OP 1 HEARTBEAT.

package/dist/ShardManager.d.ts

@@ -56,24 +56,29 @@ declare class ShardManager {
      * Update the status of all currently connected shards which have been spawned by this manager.
      * @param data Data to send.
      */
-    presenceUpdate(data?: import("./Types").IPresence): Promise<void>;
+    presenceUpdate(data: import("discord-typings").GatewayPresenceUpdate): Promise<void>;
     /**
      * Update the status of a single connected shard which has been spawned by this manager.
      * @param shardId id of the shard.
      * @param data Data to send.
      */
-    shardPresenceUpdate(shardId: number, data?: import("./Types").IPresence): Promise<void>;
+    shardPresenceUpdate(shardId: number, data: import("discord-typings").GatewayPresenceUpdate): Promise<void>;
     /**
      * Send an OP 4 VOICE_STATE_UPDATE with a certain shard.
      * @param shardId id of the shard.
      * @param data Data to send.
      */
-    voiceStateUpdate(shardId: number, data: import("./Types").IVoiceStateUpdate): Promise<void>;
+    voiceStateUpdate(shardId: number, data: import("discord-typings").VoiceStateUpdatePayload & {
+        self_deaf?: boolean;
+        self_mute?: boolean;
+    }): Promise<void>;
     /**
      * Send an OP 8 REQUEST_GUILD_MEMBERS with a certain shard.
      * @param shardId id of the shard.
      * @param data Data to send.
      */
-    requestGuildMembers(shardId: number, data: import("./Types").IRequestGuildMembers): Promise<void>;
+    requestGuildMembers(shardId: number, data: import("discord-typings").GuildRequestMembersPayload & {
+        limit?: number;
+    }): Promise<void>;
 }
 export = ShardManager;

package/dist/ShardManager.js

@@ -15,9 +15,8 @@ class ShardManager {
     constructor(client) {
         this.client = client;
         this.options = client.options;
-        if (!this.options.connectQueueInterval) {
+        if (!this.options.connectQueueInterval)
             this.options.connectQueueInterval = 1000 * 5;
-        }
         this.shards = {};
         this.connectQueue = [];
         this.lastConnectionAttempt = null;
@@ -92,9 +91,6 @@ class ShardManager {
             this.client.emit("shardReady", { id: shard.id, ready: !resume });
             this._checkReady();
         });
-        shard.on("error", (error) => {
-            this.client.emit("error", error);
-        });
         shard.on("disconnect", (code, reason, gracefulClose) => {
             this.client.emit("debug", `Websocket of shard ${shard.id} closed with code ${code} and reason: ${reason ? reason : "None"}`);
             if (code === 1000 && gracefulClose) {
@@ -117,9 +113,8 @@ class ShardManager {
     _checkReady() {
         for (const shardId in this.shards) {
             if (this.shards[shardId]) {
-                if (!this.shards[shardId].ready) {
+                if (!this.shards[shardId].ready)
                     return;
-                }
             }
         }
         this.client.emit("ready");
@@ -130,9 +125,8 @@ class ShardManager {
     _checkDisconnect() {
         for (const shardId in this.shards) {
             if (this.shards[shardId]) {
-                if (this.shards[shardId].connector.status !== "disconnected") {
+                if (this.shards[shardId].connector.status !== "disconnected")
                     return;
-                }
             }
         }
         this.client.emit("disconnected");
@@ -141,7 +135,7 @@ class ShardManager {
      * Update the status of all currently connected shards which have been spawned by this manager.
      * @param data Data to send.
      */
-    async presenceUpdate(data = {}) {
+    async presenceUpdate(data) {
         for (const shardKey in this.shards) {
             if (this.shards[shardKey]) {
                 const shard = this.shards[shardKey];
@@ -154,17 +148,13 @@ class ShardManager {
      * @param shardId id of the shard.
      * @param data Data to send.
      */
-    shardPresenceUpdate(shardId, data = {}) {
+    shardPresenceUpdate(shardId, data) {
         return new Promise((res, rej) => {
             const shard = this.shards[shardId];
-            if (!shard) {
+            if (!shard)
                 rej(new Error(`Shard ${shardId} does not exist`));
-            }
-            if (!shard.ready) {
-                shard.once("ready", () => {
-                    shard.presenceUpdate(data).then(result => res(result)).catch(e => rej(e));
-                });
-            }
+            if (!shard.ready)
+                shard.once("ready", () => shard.presenceUpdate(data).then(result => res(result)).catch(e => rej(e)));
             shard.presenceUpdate(data).then(result => res(result)).catch(e => rej(e));
         });
     }
@@ -176,14 +166,10 @@ class ShardManager {
     voiceStateUpdate(shardId, data) {
         return new Promise((res, rej) => {
             const shard = this.shards[shardId];
-            if (!shard) {
+            if (!shard)
                 rej(new Error(`Shard ${shardId} does not exist`));
-            }
-            if (!shard.ready) {
-                shard.once("ready", () => {
-                    shard.voiceStateUpdate(data).then(result => res(result)).catch(e => rej(e));
-                });
-            }
+            if (!shard.ready)
+                shard.once("ready", () => shard.voiceStateUpdate(data).then(result => res(result)).catch(e => rej(e)));
             shard.voiceStateUpdate(data).then(result => res(result)).catch(e => rej(e));
         });
     }
@@ -195,14 +181,10 @@ class ShardManager {
     requestGuildMembers(shardId, data) {
         return new Promise((res, rej) => {
             const shard = this.shards[shardId];
-            if (!shard) {
+            if (!shard)
                 rej(new Error(`Shard ${shardId} does not exist`));
-            }
-            if (!shard.ready) {
-                shard.once("ready", () => {
-                    shard.requestGuildMembers(data).then(result => res(result)).catch(e => rej(e));
-                });
-            }
+            if (!shard.ready)
+                shard.once("ready", () => shard.requestGuildMembers(data).then(result => res(result)).catch(e => rej(e)));
             shard.requestGuildMembers(data).then(result => res(result)).catch(e => rej(e));
         });
     }

package/dist/Types.d.ts

@@ -1,4 +1,3 @@
-import Constants from "./Constants";
 export interface IntentFlags {
     GUILDS: number;
     GUILD_MEMBERS: number;
@@ -18,53 +17,27 @@ export interface IntentFlags {
 }
 export declare type IntentResolvable = number | Array<number> | keyof IntentFlags | Array<keyof IntentFlags>;
 export interface IWSMessage {
-    op: typeof Constants["GATEWAY_OP_CODES"][keyof typeof Constants.GATEWAY_OP_CODES];
+    op: import("discord-typings").GatewayOpcode;
     d?: any;
     s?: number;
-    t?: string;
+    t?: import("discord-typings").GatewayEvent;
 }
 export interface IGatewayMessage extends IWSMessage {
     shard_id: number;
 }
-export interface IPresenceActivity {
-    name: string;
-    type?: 0 | 1 | 2 | 3 | 5;
-    url?: string;
-}
-export interface IPresence {
-    status?: "online" | "idle" | "dnd" | "offline";
-    afk?: boolean;
-    since?: boolean;
-    activities?: Array<IPresenceActivity> | null;
-}
 export interface IClientOptions {
     largeGuildThreshold?: number;
     firstShardId?: number;
     lastShardId?: number;
     shardAmount?: number;
     reconnect?: boolean;
-    initialPresence?: IPresence;
+    initialPresence?: import("discord-typings").GatewayPresenceUpdate;
     intents?: IntentResolvable;
     connectQueueInterval?: number;
     snowtransferInstance?: import("snowtransfer").SnowTransfer;
     ws?: IClientWSOptions;
 }
-export interface IVoiceStateUpdate {
-    guild_id: string;
-    channel_id?: string | null;
-    self_mute?: boolean;
-    self_deaf?: boolean;
-}
-export interface IRequestGuildMembers {
-    guild_id: string;
-    query?: string | null;
-    limit?: number;
-}
-export interface IShardReady {
-    id: number;
-    ready: boolean;
-}
 export interface IClientWSOptions {
     compress?: boolean;
-    socket?: import("ws").ClientOptions;
+    encoding?: "etf" | "json";
 }

package/dist/connector/DiscordConnector.d.ts

@@ -5,8 +5,8 @@ interface ConnectorEvents {
     queueIdentify: [number];
     event: [import("../Types").IWSMessage];
     ready: [boolean];
-    error: [string];
     disconnect: [number, string, boolean];
+    stateChange: ["connecting" | "identifying" | "resuming" | "ready" | "disconnected"];
 }
 interface DiscordConnector {
     addListener<E extends keyof ConnectorEvents>(event: E, listener: (...args: ConnectorEvents[E]) => any): this;
@@ -33,12 +33,12 @@ declare class DiscordConnector extends EventEmitter {
     client: import("../Client");
     options: import("../Client")["options"];
     reconnect: boolean;
-    betterWs: BetterWs | null;
+    betterWs: BetterWs;
     heartbeatTimeout: NodeJS.Timeout | null;
     heartbeatInterval: number;
     _trace: string | null;
     seq: number;
-    status: string;
+    status: "connecting" | "identifying" | "resuming" | "ready" | "disconnected";
     sessionId: string | null;
     lastACKAt: number;
     lastHeartbeatSend: number;
@@ -53,7 +53,7 @@ declare class DiscordConnector extends EventEmitter {
     /**
      * Connect to Discord.
      */
-    connect(): void;
+    connect(): Promise<void>;
     /**
      * Close the websocket connection and disconnect.
      */
@@ -104,17 +104,22 @@ declare class DiscordConnector extends EventEmitter {
      * Send an OP 3 PRESENCE_UPDATE to the gateway.
      * @param data Presence data to send.
      */
-    presenceUpdate(data?: import("../Types").IPresence): Promise<void>;
+    presenceUpdate(data: import("discord-typings").GatewayPresenceUpdate): Promise<void>;
     /**
      * Send an OP 4 VOICE_STATE_UPDATE to the gateway.
      * @param data Voice state update data to send.
      */
-    voiceStateUpdate(data: import("../Types").IVoiceStateUpdate): Promise<void>;
+    voiceStateUpdate(data: import("discord-typings").VoiceStateUpdatePayload & {
+        self_deaf?: boolean;
+        self_mute?: boolean;
+    }): Promise<void>;
     /**
      * Send an OP 8 REQUEST_GUILD_MEMBERS to the gateway.
      * @param data Data to send.
      */
-    requestGuildMembers(data: import("../Types").IRequestGuildMembers): Promise<void>;
+    requestGuildMembers(data: import("discord-typings").GuildRequestMembersPayload & {
+        limit?: number;
+    }): Promise<void>;
     /**
      * Checks presence data and fills in missing elements.
      * @param data Data to send.