cloudstorm 0.6.1 → 0.7.0

package/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright 2022 DasWolke
+Copyright 2023 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

@@ -31,25 +31,24 @@ You may wonder how you you are able to get the id of a shard where an event orig
 So an event you receive may look like this:
 ```json
 {
-	"op":0,
-	"t":"PRESENCE_UPDATE",
-	"s":1337,
-	"shard_id":0,
+	"op": 0,
+	"t": "PRESENCE_UPDATE",
+	"s": 1337,
+	"shard_id": 0,
 	"d": {
-		"game": null,
-		"guild_id": "id",
-		"nick": null,
-		"roles": [],
-		"status": "offline",
 		"user": {
 			"id": "id"
-		}
+		},
+		"guild_id": "id",
+		"status": "offline",
+		"activities": [],
+		"client_status": {}
 	}
 }
 ```
 
 ## Sharding for VERY large bots
-CloudStorm supports max_concurrency, but does not automatically attempt to fetch new info related to max_concurrency. You are expected to re-fetch this data at your own discretion as Discord does not recommend caching the data for extended periods as it can change as your client leaves and joins guilds and possibly cause rate limit errors.
+CloudStorm supports max_concurrency and gets this info on initial connect, but does not automatically attempt to fetch new info related to max_concurrency. You are expected to re-fetch this data at your own discretion as Discord does not recommend caching the data for extended periods as it can change as your client leaves and joins guilds and possibly cause rate limit errors.
 
 You should start your clusters 1 by 1 as rate limit info is only fetched on Client.connect or when you manually call Client.fetchConnectInfo when /gateway/bot is fetched
 
@@ -60,6 +59,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 12 or higher and npm installed on your computer.
+To install CloudStorm, make sure that you have node 12 or higher on your computer.
 
 Then run the following command in a terminal `npm install cloudstorm`

package/dist/index.d.ts

@@ -1,5 +1,5 @@
-import * as discord_typings from 'discord-typings';
 import * as snowtransfer from 'snowtransfer';
+import APITypes from 'discord-api-types/v10';
 import * as events from 'events';
 import { EventEmitter } from 'events';
 
@@ -8,7 +8,7 @@ type IntentResolvable = number | Array<number> | keyof IntentFlags | Array<keyof
 declare const flags: {
     GUILDS: number;
     GUILD_MEMBERS: number;
-    GUILD_BANS: number;
+    GUILD_MODERATION: number;
     GUILD_EMOJIS_AND_STICKERS: number;
     GUILD_INTEGRATIONS: number;
     GUILD_WEBHOOKS: number;
@@ -23,13 +23,15 @@ declare const flags: {
     DIRECT_MESSAGE_TYPING: number;
     MESSAGE_CONTENT: number;
     GUILD_SCHEDULED_EVENTS: number;
+    AUTO_MODERATION_CONFIGURATION: number;
+    AUTO_MODERATION_EXECUTION: number;
 };
 declare function resolve(bit?: IntentResolvable): number;
 declare const _default: {
     flags: {
         GUILDS: number;
         GUILD_MEMBERS: number;
-        GUILD_BANS: number;
+        GUILD_MODERATION: number;
         GUILD_EMOJIS_AND_STICKERS: number;
         GUILD_INTEGRATIONS: number;
         GUILD_WEBHOOKS: number;
@@ -44,6 +46,8 @@ declare const _default: {
         DIRECT_MESSAGE_TYPING: number;
         MESSAGE_CONTENT: number;
         GUILD_SCHEDULED_EVENTS: number;
+        AUTO_MODERATION_CONFIGURATION: number;
+        AUTO_MODERATION_EXECUTION: number;
     };
     privileged: number;
     all: number;
@@ -51,15 +55,12 @@ declare const _default: {
     resolve: typeof resolve;
 };
 
-interface IWSMessage {
-    op: discord_typings.GatewayOpcode;
-    d?: any;
-    s?: number;
-    t?: discord_typings.GatewayEvent;
-}
-interface IGatewayMessage extends IWSMessage {
+type IGatewayMessage = APITypes.GatewayReceivePayload & {
     shard_id: number;
-}
+};
+type IGatewayDispatch = APITypes.GatewayDispatchPayload & {
+    shard_id: number;
+};
 interface IClientOptions {
     largeGuildThreshold?: number;
     /**
@@ -74,7 +75,7 @@ interface IClientOptions {
      */
     totalShards?: number;
     reconnect?: boolean;
-    initialPresence?: discord_typings.GatewayPresenceUpdate;
+    initialPresence?: APITypes.GatewayPresenceUpdateData;
     intents?: IntentResolvable;
     snowtransferInstance?: snowtransfer.SnowTransfer;
     ws?: IClientWSOptions;
@@ -128,8 +129,8 @@ declare class RatelimitBucket {
 interface BWSEvents {
     ws_open: [];
     ws_close: [number, string];
-    ws_message: [IGatewayMessage];
-    debug_send: [IWSMessage];
+    ws_receive: [APITypes.GatewayReceivePayload];
+    ws_send: [APITypes.GatewaySendPayload];
     debug: [string];
 }
 interface BetterWs {
@@ -164,7 +165,7 @@ declare class BetterWs extends EventEmitter {
     get status(): 1 | 2 | 3 | 4;
     connect(): Promise<void>;
     close(code: number, reason?: string): Promise<void>;
-    sendMessage(data: IWSMessage): Promise<void>;
+    sendMessage(data: APITypes.GatewaySendPayload): Promise<void>;
     private _write;
     private _onError;
     private _onClose;
@@ -174,7 +175,6 @@ declare class BetterWs extends EventEmitter {
 
 interface ConnectorEvents {
     queueIdentify: [number];
-    event: [IWSMessage];
     ready: [boolean];
     disconnect: [number, string, boolean];
     stateChange: ["connecting" | "identifying" | "resuming" | "ready" | "disconnected"];
@@ -220,6 +220,7 @@ declare class DiscordConnector extends EventEmitter {
     private _closing;
     identifyAddress: string;
     resumeAddress: string | null;
+    reconnecting: boolean;
     static readonly default: typeof DiscordConnector;
     /**
      * Create a new Discord Connector.
@@ -266,7 +267,7 @@ declare class DiscordConnector extends EventEmitter {
     /**
      * Send an OP 6 RESUME to the gateway.
      */
-    private resume;
+    resume(): Promise<void>;
     /**
      * Send an OP 1 HEARTBEAT to the gateway.
      */
@@ -286,12 +287,12 @@ declare class DiscordConnector extends EventEmitter {
      * Send an OP 3 PRESENCE_UPDATE to the gateway.
      * @param data Presence data to send.
      */
-    presenceUpdate(data: discord_typings.GatewayPresenceUpdate): Promise<void>;
+    presenceUpdate(data: Partial<APITypes.GatewayPresenceUpdateData>): Promise<void>;
     /**
      * Send an OP 4 VOICE_STATE_UPDATE to the gateway.
      * @param data Voice state update data to send.
      */
-    voiceStateUpdate(data: discord_typings.VoiceStateUpdatePayload & {
+    voiceStateUpdate(data: APITypes.GatewayVoiceStateUpdateData & {
         self_deaf?: boolean;
         self_mute?: boolean;
     }): Promise<void>;
@@ -299,7 +300,7 @@ declare class DiscordConnector extends EventEmitter {
      * Send an OP 8 REQUEST_GUILD_MEMBERS to the gateway.
      * @param data Data to send.
      */
-    requestGuildMembers(data: discord_typings.GuildRequestMembersPayload & {
+    requestGuildMembers(data: APITypes.GatewayRequestGuildMembersData & {
         limit?: number;
     }): Promise<void>;
     /**
@@ -379,22 +380,17 @@ declare class Shard extends EventEmitter {
      * Send an OP 3 PRESENCE_UPDATE to Discord.
      * @param data Data to send.
      */
-    presenceUpdate(data: discord_typings.GatewayPresenceUpdate): Promise<void>;
+    presenceUpdate(data: Parameters<Shard["connector"]["presenceUpdate"]>["0"]): Promise<void>;
     /**
      * Send an OP 4 VOICE_STATE_UPDATE to Discord.
      * @param data Data to send
      */
-    voiceStateUpdate(data: discord_typings.VoiceStateUpdatePayload & {
-        self_deaf?: boolean;
-        self_mute?: boolean;
-    }): Promise<void>;
+    voiceStateUpdate(data: Parameters<Shard["connector"]["voiceStateUpdate"]>["0"]): Promise<void>;
     /**
      * Send an OP 8 REQUEST_GUILD_MEMBERS to Discord.
      * @param data Data to send.
      */
-    requestGuildMembers(data: discord_typings.GuildRequestMembersPayload & {
-        limit?: number;
-    }): Promise<void>;
+    requestGuildMembers(data: Parameters<Shard["connector"]["requestGuildMembers"]>["0"]): Promise<void>;
 }
 
 /**
@@ -444,44 +440,38 @@ 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: discord_typings.GatewayPresenceUpdate): Promise<void>;
+    presenceUpdate(data: Parameters<Shard["presenceUpdate"]>["0"]): 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: discord_typings.GatewayPresenceUpdate): Promise<void>;
+    shardPresenceUpdate(shardId: number, data: Parameters<Shard["presenceUpdate"]>["0"]): 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: discord_typings.VoiceStateUpdatePayload & {
-        self_deaf?: boolean;
-        self_mute?: boolean;
-    }): Promise<void>;
+    voiceStateUpdate(shardId: number, data: Parameters<Shard["voiceStateUpdate"]>["0"]): 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: discord_typings.GuildRequestMembersPayload & {
-        limit?: number;
-    }): Promise<void>;
+    requestGuildMembers(shardId: number, data: Parameters<Shard["requestGuildMembers"]>["0"]): Promise<void>;
 }
 
 interface ClientEvents {
     debug: [string];
-    rawSend: [IWSMessage];
-    rawReceive: [IGatewayMessage];
+    rawSend: [APITypes.GatewaySendPayload];
+    rawReceive: [APITypes.GatewayReceivePayload];
+    error: [string];
     event: [IGatewayMessage];
-    dispatch: [IGatewayMessage];
-    voiceStateUpdate: [IGatewayMessage];
+    dispatch: [IGatewayDispatch];
     shardReady: [{
         id: number;
         ready: boolean;
     }];
-    error: [string];
     ready: [];
     disconnected: [];
 }
@@ -538,11 +528,7 @@ declare class Client extends EventEmitter {
      * Get the GatewayData including recommended amount of shards and other helpful info.
      * @returns Object with url and shards to use to connect to discord.
      */
-    getGatewayBot(): Promise<{
-        url: string;
-        shards: number;
-        session_start_limit: discord_typings.SessionStartLimit;
-    }>;
+    getGatewayBot(): Promise<APITypes.RESTGetAPIGatewayBotResult>;
     /**
      * Disconnect the bot gracefully,
      * you will receive a 'disconnected' event once the ShardManager successfully closes all shard websocket connections.
@@ -553,17 +539,17 @@ declare class Client extends EventEmitter {
      * @returns Promise that's resolved once all shards have sent the websocket payload.
      *
      * @example
-     * // Connect to Discord and set status to do not disturb and game to "Memes are Dreams".
+     * // Connect to Discord and set status to do not disturb and activity to "Memes are Dreams".
      * const CloudStorm = require("cloudstorm"); // CloudStorm also supports import statements.
      * const token = "token";
      * const client = new CloudStorm.Client(token);
      * client.connect();
      * client.once("ready", () => {
      * 	// Client is connected to Discord and is ready, so we can update the status.
-     * 	client.presenceUpdate({ status: "dnd", game: { name: "Memes are Dreams" } });
+     * 	client.presenceUpdate({ status: "dnd", activities: [{ name: "Memes are Dreams", type: 0 }] });
      * });
      */
-    presenceUpdate(data: discord_typings.GatewayPresenceUpdate): Promise<void>;
+    presenceUpdate(data: Parameters<Client["shardManager"]["presenceUpdate"]>["0"]): 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.
@@ -571,17 +557,17 @@ declare class Client extends EventEmitter {
      * @returns Promise that's resolved once the shard has sent the websocket payload.
      *
      * @example
-     * // Connect to Discord and set status to do not disturb and game to "Im shard 0".
+     * // Connect to Discord and set status to do not disturb and activity to "Im shard 0".
      * const CloudStorm = require("cloudstorm"); // CloudStorm also supports import statements.
      * const token = "token";
      * const client = new CloudStorm.Client(token);
      * client.connect();
      * client.once("ready", () => {
      * 	// Client is connected to Discord and is ready, so we can update the status of shard 0.
-     * 	client.shardPresenceUpdate(0, { status: "dnd", game: { name: "Im shard 0" } });
+     * 	client.shardPresenceUpdate(0, { status: "dnd", activities: [{ name: "Im shard 0", type: 0 }] });
      * });
      */
-    shardStatusUpdate(shardId: number, data: discord_typings.GatewayPresenceUpdate): Promise<void>;
+    shardStatusUpdate(shardId: number, data: Parameters<Client["shardManager"]["shardPresenceUpdate"]>["1"]): 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.
@@ -601,10 +587,7 @@ declare class Client extends EventEmitter {
      * 	client.voiceStateUpdate(0, { guild_id: "id", channel_id: "id", self_mute: false, self_deaf: false });
      * });
      */
-    voiceStateUpdate(shardId: number, data: discord_typings.VoiceStateUpdatePayload & {
-        self_deaf?: boolean;
-        self_mute?: boolean;
-    }): Promise<void>;
+    voiceStateUpdate(shardId: number, data: Parameters<Client["shardManager"]["voiceStateUpdate"]>["1"]): Promise<void>;
     /**
      * Send an OP 8 REQUEST_GUILD_MEMBERS to Discord.
      * @param shardId id of the shard that should send the payload.
@@ -623,9 +606,7 @@ declare class Client extends EventEmitter {
      * 	client.requestGuildMembers(0, { guild_id: "id" });
      * });
      */
-    requestGuildMembers(shardId: number, data: discord_typings.GuildRequestMembersPayload & {
-        limit?: number;
-    }): Promise<void>;
+    requestGuildMembers(shardId: number, data: Parameters<Client["shardManager"]["requestGuildMembers"]>["1"]): Promise<void>;
     /**
      * Update the endpoint shard websockets will connect to.
      * @param gatewayUrl Base gateway wss url to update the cached endpoint to.
@@ -683,4 +664,4 @@ declare const Constants: {
     GATEWAY_VERSION: 10;
 };
 
-export { Client, Constants, IClientOptions, IClientWSOptions, IGatewayMessage, IWSMessage, _default as Intents, Shard, ShardManager };
+export { Client, Constants, IClientOptions, IClientWSOptions, IGatewayDispatch, IGatewayMessage, _default as Intents, Shard, ShardManager };