Move to gateway v8, add requestApplicationCommands

- Changed gateway version to v8
-> This requires intents now
- Added GATEWAY_INTENTS_ALL, GATEWAY_INTENTS_ALL_DIRECT_MESSAGES, GATEWAY_INTENTS_ALL_GUILD to constants
- Sending in '*' as the intents will use GATEWAY_INTENTS_ALL
- Added a few new events to GatewayDispatchEvents

Author: cakedan

package.json

@@ -1,6 +1,6 @@
 {
   "name": "detritus-client-socket",
-  "version": "0.6.1",
+  "version": "0.7.0",
   "description": "A TypeScript NodeJS library to interact with Discord's Gateway",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
@@ -9,16 +9,15 @@
   ],
   "dependencies": {
     "detritus-utils": "^0.3.0",
-    "ws": "^7.3.1"
+    "ws": "^7.4.0"
   },
   "devDependencies": {
-    "@types/node": "^14.0.27",
-    "typedoc": "^0.17.8",
-    "typescript": "^3.9.7"
+    "@types/node": "^14.14.9",
+    "typedoc": "^0.19.2"
   },
   "peerDependencies": {
     "erlpack": "^0.1.3",
-    "libsodium-wrappers": "^0.7.6",
+    "libsodium-wrappers": "^0.7.8",
     "pako": "^1.0.11",
     "sodium": "^3.0.2",
     "tweetnacl": "^1.0.3",

src/basesocket.ts

@@ -5,17 +5,18 @@ import {
   SocketEventsBase,
 } from './constants';
 
-export const DependencyTypes = Object.freeze({
-  UWS: 'uws',
-  WS: 'ws',
-});
+
+export enum DependencyTypes {
+  UWS = 'uws',
+  WS = 'ws',
+}
 
 export const WebsocketDependency: {
   module: any,
-  type: string,
+  type: null | DependencyTypes,
 } = {
   module: null,
-  type: '',
+  type: null,
 };
 
 [
@@ -68,7 +69,10 @@ export class BaseSocket extends EventSpewer {
     return this.socket.readyState === this.socket.CONNECTING;
   }
 
-  get using(): string {
+  get using(): DependencyTypes {
+    if (!WebsocketDependency.type) {
+      throw new Error(`Missing a WebSocket Dependency, pick one: ${JSON.stringify(Object.values(DependencyTypes))}`);
+    }
     return WebsocketDependency.type;
   }
 
@@ -137,4 +141,8 @@ export class BaseSocket extends EventSpewer {
       });
     });
   }
+
+  terminate() {
+    return this.socket.terminate();
+  }
 }

src/constants.ts

@@ -1,18 +1,11 @@
 export const Package = Object.freeze({
   URL: 'https://github.com/detritusjs/client-socket',
-  VERSION: '0.6.1',
+  VERSION: '0.7.0',
 });
 
-function normalize(object: {[key: string]: any}) {
-  for (let key in object) {
-    object[key] = key;
-  }
-  return Object.freeze(object);
-}
-
 
 export const ApiVersions = Object.freeze({
-  GATEWAY: 6,
+  GATEWAY: 8,
   MEDIA_GATEWAY: 5,
 });
 
@@ -54,6 +47,9 @@ export enum GatewayActivityFlags {
   JOIN_REQUEST = 1 << 3,
   SYNC = 1 << 4,
   PLAY = 1 << 5,
+  PARTY_PRIVACY_FRIENDS = 1 << 6,
+  PARTY_PRIVACY_VOICE_CHANNEL = 1 << 7,
+  PARTY_EMBEDDED = 1 << 8,
 }
 
 export enum GatewayActivityTypes {
@@ -64,92 +60,96 @@ export enum GatewayActivityTypes {
   CUSTOM_STATUS = 4,
 }
 
-export const GatewayDispatchEvents = normalize({
-  READY: null,
-  RESUMED: null,
-  ACTIVITY_JOIN_INVITE: null,
-  ACTIVITY_JOIN_REQUEST: null,
-  ACTIVITY_START: null,
-  BRAINTREE_POPUP_BRIDGE_CALLBACK: null,
-  CALL_CREATE: null,
-  CALL_DELETE: null,
-  CALL_UPDATE: null,
-  CHANNEL_CREATE: null,
-  CHANNEL_DELETE: null,
-  CHANNEL_UPDATE: null,
-  CHANNEL_PINS_ACK: null,
-  CHANNEL_PINS_UPDATE: null,
-  CHANNEL_RECIPIENT_ADD: null,
-  CHANNEL_RECIPIENT_REMOVE: null,
-  ENTITLEMENT_CREATE: null,
-  ENTITLEMENT_DELETE: null,
-  ENTITLEMENT_UPDATE: null,
-  FRIEND_SUGGESTION_CREATE: null,
-  FRIEND_SUGGESTION_DELETE: null,
-  GIFT_CODE_UPDATE: null,
-  GUILD_BAN_ADD: null,
-  GUILD_BAN_REMOVE: null,
-  GUILD_CREATE: null,
-  GUILD_DELETE: null,
-  GUILD_UPDATE: null,
-  GUILD_EMOJIS_UPDATE: null,
-  GUILD_INTEGRATIONS_UPDATE: null,
-  GUILD_MEMBER_ADD: null,
-  GUILD_MEMBER_LIST_UPDATE: null,
-  GUILD_MEMBER_REMOVE: null,
-  GUILD_MEMBER_UPDATE: null,
-  GUILD_MEMBERS_CHUNK: null,
-  GUILD_ROLE_CREATE: null,
-  GUILD_ROLE_DELETE: null,
-  GUILD_ROLE_UPDATE: null,
-  INVITE_CREATE: null,
-  INVITE_DELETE: null,
-  LIBRARY_APPLICATION_UPDATE: null,
-  LOBBY_CREATE: null,
-  LOBBY_DELETE: null,
-  LOBBY_UPDATE: null,
-  LOBBY_MEMBER_CONNECT: null,
-  LOBBY_MEMBER_DISCONNECT: null,
-  LOBBY_MEMBER_UPDATE: null,
-  LOBBY_MESSAGE: null,
-  LOBBY_VOICE_SERVER_UPDATE: null,
-  LOBBY_VOICE_STATE_UPDATE: null,
-  MESSAGE_ACK: null,
-  MESSAGE_CREATE: null,
-  MESSAGE_DELETE: null,
-  MESSAGE_DELETE_BULK: null,
-  MESSAGE_REACTION_ADD: null,
-  MESSAGE_REACTION_REMOVE: null,
-  MESSAGE_REACTION_REMOVE_ALL: null,
-  MESSAGE_REACTION_REMOVE_EMOJI: null,
-  MESSAGE_UPDATE: null,
-  OAUTH2_TOKEN_REMOVE: null,
-  PRESENCES_REPLACE: null,
-  PRESENCE_UPDATE: null,
-  RECENT_MENTION_DELETE: null,
-  RELATIONSHIP_ADD: null,
-  RELATIONSHIP_REMOVE: null,
-  SESSIONS_REPLACE: null,
-  STREAM_CREATE: null,
-  STREAM_DELETE: null,
-  STREAM_SERVER_UPDATE: null,
-  STREAM_UPDATE: null,
-  TYPING_START: null,
-  USER_ACHIEVEMENT_UPDATE: null,
-  USER_CONNECTIONS_UPDATE: null,
-  USER_FEED_SETTINGS_UPDATE: null,
-  USER_GUILD_SETTINGS_UPDATE: null,
-  USER_NOTE_UPDATE: null,
-  USER_PAYMENT_SOURCES_UPDATE: null,
-  USER_PAYMENTS_UPDATE: null,
-  USER_SETTINGS_UPDATE: null,
-  USER_SUBSCRIPTIONS_UPDATE: null,
-  USER_REQUIRED_ACTION_UPDATE: null,
-  USER_UPDATE: null,
-  VOICE_SERVER_UPDATE: null,
-  VOICE_STATE_UPDATE: null,
-  WEBHOOKS_UPDATE: null,
-});
+export enum GatewayDispatchEvents {
+  READY = 'READY',
+  RESUMED = 'RESUMED',
+  ACTIVITY_JOIN_INVITE = 'ACTIVITY_JOIN_INVITE',
+  ACTIVITY_JOIN_REQUEST = 'ACTIVITY_JOIN_REQUEST',
+  ACTIVITY_START = 'ACTIVITY_START',
+  BRAINTREE_POPUP_BRIDGE_CALLBACK = 'BRAINTREE_POPUP_BRIDGE_CALLBACK',
+  CALL_CREATE = 'CALL_CREATE',
+  CALL_DELETE = 'CALL_DELETE',
+  CALL_UPDATE = 'CALL_UPDATE',
+  CHANNEL_CREATE = 'CHANNEL_CREATE',
+  CHANNEL_DELETE = 'CHANNEL_DELETE',
+  CHANNEL_UPDATE = 'CHANNEL_UPDATE',
+  CHANNEL_PINS_ACK = 'CHANNEL_PINS_ACK',
+  CHANNEL_PINS_UPDATE = 'CHANNEL_PINS_UPDATE',
+  CHANNEL_RECIPIENT_ADD = 'CHANNEL_RECIPIENT_ADD',
+  CHANNEL_RECIPIENT_REMOVE = 'CHANNEL_RECIPIENT_REMOVE',
+  ENTITLEMENT_CREATE = 'ENTITLEMENT_CREATE',
+  ENTITLEMENT_DELETE = 'ENTITLEMENT_DELETE',
+  ENTITLEMENT_UPDATE = 'ENTITLEMENT_UPDATE',
+  FRIEND_SUGGESTION_CREATE = 'FRIEND_SUGGESTION_CREATE',
+  FRIEND_SUGGESTION_DELETE = 'FRIEND_SUGGESTION_DELETE',
+  GIFT_CODE_UPDATE = 'GIFT_CODE_UPDATE',
+  GUILD_APPLICATION_COMMANDS_UPDATE = 'GUILD_APPLICATION_COMMANDS_UPDATE',
+  GUILD_BAN_ADD = 'GUILD_BAN_ADD',
+  GUILD_BAN_REMOVE = 'GUILD_BAN_REMOVE',
+  GUILD_CREATE = 'GUILD_CREATE',
+  GUILD_DELETE = 'GUILD_DELETE',
+  GUILD_UPDATE = 'GUILD_UPDATE',
+  GUILD_EMOJIS_UPDATE = 'GUILD_EMOJIS_UPDATE',
+  GUILD_INTEGRATIONS_UPDATE = 'GUILD_INTEGRATIONS_UPDATE',
+  GUILD_MEMBER_ADD = 'GUILD_MEMBER_ADD',
+  GUILD_MEMBER_LIST_UPDATE = 'GUILD_MEMBER_LIST_UPDATE',
+  GUILD_MEMBER_REMOVE = 'GUILD_MEMBER_REMOVE',
+  GUILD_MEMBER_UPDATE = 'GUILD_MEMBER_UPDATE',
+  GUILD_MEMBERS_CHUNK = 'GUILD_MEMBERS_CHUNK',
+  GUILD_ROLE_CREATE = 'GUILD_ROLE_CREATE',
+  GUILD_ROLE_DELETE = 'GUILD_ROLE_DELETE',
+  GUILD_ROLE_UPDATE = 'GUILD_ROLE_UPDATE',
+  INVITE_CREATE = 'INVITE_CREATE',
+  INVITE_DELETE = 'INVITE_DELETE',
+  LIBRARY_APPLICATION_UPDATE = 'LIBRARY_APPLICATION_UPDATE',
+  LOBBY_CREATE = 'LOBBY_CREATE',
+  LOBBY_DELETE = 'LOBBY_DELETE',
+  LOBBY_UPDATE = 'LOBBY_UPDATE',
+  LOBBY_MEMBER_CONNECT = 'LOBBY_MEMBER_CONNECT',
+  LOBBY_MEMBER_DISCONNECT = 'LOBBY_MEMBER_DISCONNECT',
+  LOBBY_MEMBER_UPDATE = 'LOBBY_MEMBER_UPDATE',
+  LOBBY_MESSAGE = 'LOBBY_MESSAGE',
+  LOBBY_VOICE_SERVER_UPDATE = 'LOBBY_VOICE_SERVER_UPDATE',
+  LOBBY_VOICE_STATE_UPDATE = 'LOBBY_VOICE_STATE_UPDATE',
+  MESSAGE_ACK = 'MESSAGE_ACK',
+  MESSAGE_CREATE = 'MESSAGE_CREATE',
+  MESSAGE_DELETE = 'MESSAGE_DELETE',
+  MESSAGE_DELETE_BULK = 'MESSAGE_DELETE_BULK',
+  MESSAGE_REACTION_ADD = 'MESSAGE_REACTION_ADD',
+  MESSAGE_REACTION_REMOVE = 'MESSAGE_REACTION_REMOVE',
+  MESSAGE_REACTION_REMOVE_ALL = 'MESSAGE_REACTION_REMOVE_ALL',
+  MESSAGE_REACTION_REMOVE_EMOJI = 'MESSAGE_REACTION_REMOVE_EMOJI',
+  MESSAGE_UPDATE = 'MESSAGE_UPDATE',
+  OAUTH2_TOKEN_REMOVE = 'OAUTH2_TOKEN_REMOVE',
+  PRESENCES_REPLACE = 'PRESENCES_REPLACE',
+  PRESENCE_UPDATE = 'PRESENCE_UPDATE',
+  RECENT_MENTION_DELETE = 'RECENT_MENTION_DELETE',
+  RELATIONSHIP_ADD = 'RELATIONSHIP_ADD',
+  RELATIONSHIP_REMOVE = 'RELATIONSHIP_REMOVE',
+  SESSIONS_REPLACE = 'SESSIONS_REPLACE',
+  STREAM_CREATE = 'STREAM_CREATE',
+  STREAM_DELETE = 'STREAM_DELETE',
+  STREAM_SERVER_UPDATE = 'STREAM_SERVER_UPDATE',
+  STREAM_UPDATE = 'STREAM_UPDATE',
+  TYPING_START = 'TYPING_START',
+  USER_ACHIEVEMENT_UPDATE = 'USER_ACHIEVEMENT_UPDATE',
+  USER_CONNECTIONS_UPDATE = 'USER_CONNECTIONS_UPDATE',
+  USER_FEED_SETTINGS_UPDATE = 'USER_FEED_SETTINGS_UPDATE',
+  USER_GUILD_SETTINGS_UPDATE = 'USER_GUILD_SETTINGS_UPDATE',
+  USER_NOTE_UPDATE = 'USER_NOTE_UPDATE',
+  USER_PAYMENT_SOURCES_UPDATE = 'USER_PAYMENT_SOURCES_UPDATE',
+  USER_PAYMENTS_UPDATE = 'USER_PAYMENTS_UPDATE',
+  USER_PREMIUM_GUILD_SUBSCRIPTION_SLOT_CREATE = 'USER_PREMIUM_GUILD_SUBSCRIPTION_SLOT_CREATE',
+  USER_PREMIUM_GUILD_SUBSCRIPTION_SLOT_UPDATE = 'USER_PREMIUM_GUILD_SUBSCRIPTION_SLOT_UPDATE',
+  USER_REQUIRED_ACTION_UPDATE = 'USER_REQUIRED_ACTION_UPDATE',
+  USER_SETTINGS_UPDATE = 'USER_SETTINGS_UPDATE',
+  USER_SUBSCRIPTIONS_UPDATE = 'USER_SUBSCRIPTIONS_UPDATE',
+  USER_STICKER_PACK_UPDATE = 'USER_STICKER_PACK_UPDATE',
+  USER_UPDATE = 'USER_UPDATE',
+  VOICE_SERVER_UPDATE = 'VOICE_SERVER_UPDATE',
+  VOICE_STATE_UPDATE = 'VOICE_STATE_UPDATE',
+  WEBHOOKS_UPDATE = 'WEBHOOKS_UPDATE'
+}
 
 export enum GatewayIntents {
   GUILDS = 1 << 0,
@@ -169,6 +169,45 @@ export enum GatewayIntents {
   DIRECT_MESSAGE_TYPING = 1 << 14,
 }
 
+export const GATEWAY_INTENTS_ALL = [
+  GatewayIntents.GUILDS,
+  GatewayIntents.GUILD_MEMBERS,
+  GatewayIntents.GUILD_BANS,
+  GatewayIntents.GUILD_EMOJIS,
+  GatewayIntents.GUILD_INTEGRATIONS,
+  GatewayIntents.GUILD_WEBHOOKS,
+  GatewayIntents.GUILD_INVITES,
+  GatewayIntents.GUILD_VOICE_STATES,
+  GatewayIntents.GUILD_PRESENCES,
+  GatewayIntents.GUILD_MESSAGES,
+  GatewayIntents.GUILD_MESSAGE_REACTIONS,
+  GatewayIntents.GUILD_MESSAGE_TYPING,
+  GatewayIntents.DIRECT_MESSAGES,
+  GatewayIntents.DIRECT_MESSAGE_REACTIONS,
+  GatewayIntents.DIRECT_MESSAGE_TYPING,
+].reduce((x, total) => total | x);
+
+export const GATEWAY_INTENTS_DIRECT_MESSAGES = [
+  GatewayIntents.DIRECT_MESSAGES,
+  GatewayIntents.DIRECT_MESSAGE_REACTIONS,
+  GatewayIntents.DIRECT_MESSAGE_TYPING,
+].reduce((x, total) => total | x);
+
+export const GATEWAY_INTENTS_ALL_GUILD = [
+  GatewayIntents.GUILDS,
+  GatewayIntents.GUILD_MEMBERS,
+  GatewayIntents.GUILD_BANS,
+  GatewayIntents.GUILD_EMOJIS,
+  GatewayIntents.GUILD_INTEGRATIONS,
+  GatewayIntents.GUILD_WEBHOOKS,
+  GatewayIntents.GUILD_INVITES,
+  GatewayIntents.GUILD_VOICE_STATES,
+  GatewayIntents.GUILD_PRESENCES,
+  GatewayIntents.GUILD_MESSAGES,
+  GatewayIntents.GUILD_MESSAGE_REACTIONS,
+  GatewayIntents.GUILD_MESSAGE_TYPING,
+].reduce((x, total) => total | x);
+
 export enum GatewayOpCodes {
   DISPATCH = 0,
   HEARTBEAT = 1,
@@ -193,6 +232,7 @@ export enum GatewayOpCodes {
   STREAM_WATCH = 20,
   STREAM_PING = 21,
   STREAM_SET_PAUSED = 22,
+  REQUEST_APPLICATION_COMMANDS = 24,
 }
 
 export enum GatewayPresenceStatuses {
@@ -302,7 +342,7 @@ export enum SocketEvents {
 export enum SocketEventsBase {
   CLOSE = 'close',
   ERROR = 'error',
-  MESSAGE = 'messsage',
+  MESSAGE = 'message',
   OPEN = 'open',
   PING = 'ping',
   PONG = 'pong',
@@ -326,6 +366,8 @@ export enum SocketCloseCodes {
 }
 
 export enum SocketInternalCloseCodes {
+  CONNECTION_ERROR = -1,
+
   INVALID_DATA = 4800,
   RECONNECTING = 4801,
   HEARTBEAT_ACK = 4802,
@@ -335,6 +377,7 @@ export enum SocketInternalCloseCodes {
 }
 
 export const SocketInternalCloseReasons = Object.freeze({
+  [SocketInternalCloseCodes.CONNECTION_ERROR]: 'Gateway Error, check `warn` listener',
   [SocketInternalCloseCodes.INVALID_DATA]: 'Invalid data received, reconnecting',
   [SocketInternalCloseCodes.RECONNECTING]: 'Reconnecting',
   [SocketInternalCloseCodes.HEARTBEAT_ACK]: 'Heartbeat ACK never arrived',