Support Interactions

.gitignore

@@ -1,4 +1,5 @@
 .DS_Store
+.vscode
 docgen
 docs
 node_modules

index.d.ts

@@ -14,6 +14,27 @@ declare namespace Eris {
   export const VERSION: string;
 
   // TYPES
+
+  type InteractionOptions = {
+    allowedMentions?: AllowedMentions;
+    content?: string;
+    embeds?: EmbedOptions;
+    flags?: number;
+    tts?: boolean;
+    type: number;
+  };
+
+  type InteractionContent = Pick<InteractionOptions, "content" | "embeds" | "flags" | "allowedMentions" | "tts">;
+
+  interface InteractionWebhookContent {
+    allowedMentions?: AllowedMentions;
+    content?: string;
+    embeds?: EmbedOptions[];
+    file?: MessageFile | MessageFile[];
+    flags?: number;
+    tts?: boolean;
+  }
+
   // Cache
   type Uncached = { id: string };
 
@@ -65,7 +86,7 @@ declare namespace Eris {
   type MessageContent = string | AdvancedMessageContent;
   type MFALevel = 0 | 1;
   type PossiblyUncachedMessage = Message | { channel: TextableChannel | { id: string; guild?: Uncached }; guildID?: string; id: string };
-  type InteractionType = 1 | 2;
+  type InteractionType = 1 | 2 | 3;
 
   // Permission
   type PermissionType = "role" | "member";
@@ -490,6 +511,7 @@ declare namespace Eris {
     selfStream: boolean;
     selfVideo: boolean;
   }
+
   interface EventListeners<T> {
     (event: "ready" | "disconnect", listener: () => void): T;
     (event: "callCreate" | "callRing" | "callDelete", listener: (call: Call) => void): T;
@@ -525,6 +547,7 @@ declare namespace Eris {
     (event: "guildUnavailable" | "unavailableGuildCreate", listener: (guild: UnavailableGuild) => void): T;
     (event: "guildUpdate", listener: (guild: Guild, oldGuild: OldGuild) => void): T;
     (event: "hello", listener: (trace: string[], id: number) => void): T;
+    (event: "interactionCreate", listener: (interaction: Interaction) => void): T;
     (event: "inviteCreate" | "inviteDelete", listener: (guild: Guild, invite: Invite) => void): T;
     (event: "messageCreate", listener: (message: Message<PossiblyUncachedTextableChannel>) => void): T;
     (event: "messageDelete" | "messageReactionRemoveAll", listener: (message: PossiblyUncachedMessage) => void): T;
@@ -1021,6 +1044,7 @@ declare namespace Eris {
     content?: string;
     embeds?: EmbedOptions[];
     file?: MessageFile | MessageFile[];
+    flags?: number;
     tts?: boolean;
     username?: string;
     wait?: boolean;
@@ -1594,6 +1618,7 @@ declare namespace Eris {
     createGuildEmoji(guildID: string, options: EmojiOptions, reason?: string): Promise<Emoji>;
     createGuildFromTemplate(code: string, name: string, icon?: string): Promise<Guild>;
     createGuildTemplate(guildID: string, name: string, description?: string | null): Promise<GuildTemplate>;
+    createInteractionResponse(interactionID: string, interactionToken: string, options: InteractionOptions): Promise<void>;
     createMessage(channelID: string, content: MessageContent, file?: MessageFile | MessageFile[]): Promise<Message>;
     createRole(guildID: string, options?: RoleOptions | Role, reason?: string): Promise<Role>;
     crosspostMessage(channelID: string, messageID: string): Promise<Message>;
@@ -2172,6 +2197,34 @@ declare namespace Eris {
     toJSON(props?: string[]): JSONCache;
   }
 
+  //Interaction
+  export class Interaction {
+    applicationId: string;
+    channelId: string;
+    data?: {
+      componentType?: number;
+      id?: string;
+      custom_id?: string;
+      name?: string;
+      options?: { name?: string; value: string }
+    };
+    guildId?: string;
+    id: string;
+    member: Member;
+    message: Message;
+    token: string;
+    type: number;
+    version: number;
+    acknowledge(): Promise<void>;
+    createFollowup(content: string | InteractionWebhookContent): Promise<Message<GuildTextableChannel>>;
+    createMessage(content: string | InteractionContent): Promise<void>;
+    defer(flags: number): Promise<void>;
+    deferUpdate(): Promise<void>;
+    delete(messageId: string): Promise<void>;
+    edit(messageId: string, content: string | MessageWebhookContent): Promise<Message<GuildTextableChannel>>;
+    editParent(content: MessageWebhookContent): Promise<Message<GuildTextableChannel>>;
+  }
+
   // If CT (count) is "withMetadata", it will not have count properties
   export class Invite<CT extends "withMetadata" | "withCount" | "withoutCount" = "withMetadata", CH extends InviteChannel = InviteChannel> extends Base {
     channel: CH;
@@ -2181,10 +2234,10 @@ declare namespace Eris {
     guild: CT extends "withMetadata"
       ? Guild // Invite with Metadata always has guild prop
       : CH extends Extract<InviteChannel, GroupChannel> // Invite without Metadata
-        ? never // If the channel is GroupChannel, there is no guild
-        : CH extends Exclude<InviteChannel, InvitePartialChannel> // Invite without Metadata and not GroupChanel
-          ? Guild // If the invite channel is not partial
-          : Guild | undefined; // If the invite channel is partial
+      ? never // If the channel is GroupChannel, there is no guild
+      : CH extends Exclude<InviteChannel, InvitePartialChannel> // Invite without Metadata and not GroupChanel
+      ? Guild // If the invite channel is not partial
+      : Guild | undefined; // If the invite channel is partial
     inviter?: User;
     maxAge: CT extends "withMetadata" ? number : null;
     maxUses: CT extends "withMetadata" ? number : null;
@@ -2540,7 +2593,7 @@ declare namespace Eris {
     addMessageReaction(messageID: string, reaction: string, userID: string): Promise<void>;
     createInvite(options?: CreateInviteOptions, reason?: string): Promise<Invite<"withMetadata", TextChannel>>;
     createMessage(content: MessageContent, file?: MessageFile | MessageFile[]): Promise<Message<TextChannel>>;
-    createWebhook(options: { name: string; avatar?: string | null}, reason?: string): Promise<Webhook>;
+    createWebhook(options: { name: string; avatar?: string | null }, reason?: string): Promise<Webhook>;
     deleteMessage(messageID: string, reason?: string): Promise<void>;
     deleteMessages(messageIDs: string[], reason?: string): Promise<void>;
     edit(options: Omit<EditChannelOptions, "icon" | "ownerID">, reason?: string): Promise<this>;

lib/Client.js

@@ -569,6 +569,26 @@ class Client extends EventEmitter {
         }).then((template) => new GuildTemplate(template, this));
     }
 
+    /**
+    * Respond to the interaction with a message !use createFollowup if you have already responded with a different method
+    * @arg {String} interactionID The interaction ID.
+    * @arg {String} interactionToken The interaction Token.
+    * @arg {Object} options The options object.
+    * @arg {Object} [options.allowedMentions] A list of mentions to allow (overrides default)
+    * @arg {Boolean} [options.allowedMentions.everyone] Whether or not to allow @everyone/@here.
+    * @arg {Boolean | Array<String>} [options.allowedMentions.roles] Whether or not to allow all role mentions, or an array of specific role mentions to allow.
+    * @arg {Boolean | Array<String>} [options.allowedMentions.users] Whether or not to allow all user mentions, or an array of specific user mentions to allow.
+    * @arg {String} [options.content] A content string
+    * @arg {Object} [options.embed] An embed object. See [the official Discord API documentation entry](https://discord.com/developers/docs/resources/channel#embed-object) for object structure
+    * @arg {Boolean} [options.flags] 64 for Ephemeral (Applies to Slash Commands and Message Components)
+    * @arg {Boolean} [options.tts] Set the message TTS flag
+    * @arg {Number} options.type The response type to send [Check Discord docs for valid responses](https://discord.com/developers/docs/interactions/slash-commands#interaction-response-interactioncallbacktype).
+    * @returns {Promise}
+    */
+    createInteractionResponse(interactionID, interactionToken, options) {
+        return this.requestHandler.request("POST", Endpoints.INTERACTION_RESPOND(interactionID, interactionToken), true, options);
+    }
+
     /**
     * Create a message in a channel
     * Note: If you want to DM someone, the user ID is **not** the DM channel ID. use Client.getDMChannel() to get the DM channel for a user
@@ -1532,6 +1552,7 @@ class Client extends EventEmitter {
     * @arg {Object | Array<Object>} [options.file] A file object (or an Array of them)
     * @arg {Buffer} options.file.file A buffer containing file data
     * @arg {String} options.file.name What to name the file
+    * @arg {Number} [options.flags] Flags to execute the webhook with, 64 for ephemeral (Interaction webhooks only)
     * @arg {Boolean} [options.tts=false] Whether the message should be a TTS message or not
     * @arg {String} [options.username] A custom username, defaults to webhook default username if not specified
     * @arg {Boolean} [options.wait=false] Whether to wait for the server to confirm the message create or not
@@ -1547,6 +1568,7 @@ class Client extends EventEmitter {
             username: options.username,
             avatar_url: options.avatarURL,
             tts: options.tts,
+            flags: options.flags,
             allowed_mentions: this._formatAllowedMentions(options.allowedMentions)
         }, options.file).then((response) => options.wait ? new Message(response, this) : undefined);
     }

lib/Constants.js

@@ -256,7 +256,6 @@ module.exports.UserFlags = {
     DISCORD_CERTIFIED_MODERATOR:  1 << 18
 };
 
-
 module.exports.Intents = {
     guilds:                 1 << 0,
     guildMembers:           1 << 1,
@@ -274,3 +273,21 @@ module.exports.Intents = {
     directMessageReactions: 1 << 13,
     directMessageTyping:    1 << 14
 };
+
+module.exports.InteractionFlags = {
+    EPHEMERAL: 1 << 6
+};
+
+module.exports.InteractionTypes = {
+    ping:             1,
+    slashCommand:     2,
+    messageComponent: 3
+};
+
+module.exports.InteractionResponseType = {
+    PONG:                                 1,
+    CHANNEL_MESSAGE_WITH_SOURCE:          4,
+    DEFERRED_CHANNEL_MESSAGE_WITH_SOURCE: 5,
+    DEFERRED_UPDATE_MESSAGE:              6,
+    UPDATE_MESSAGE:                       7
+};

lib/gateway/Shard.js

@@ -13,6 +13,7 @@ const {GATEWAY_VERSION, GatewayOPCodes, ChannelTypes} = require("../Constants");
 const ExtendedUser = require("../structures/ExtendedUser");
 const User = require("../structures/User");
 const Invite = require("../structures/Invite");
+const Interaction = require("../structures/Interaction");
 const Constants = require("../Constants");
 
 const WebSocket = typeof window !== "undefined" ? require("../util/BrowserWebSocket") : require("ws");
@@ -2076,6 +2077,15 @@ class Shard extends EventEmitter {
             case "CHANNEL_PINS_ACK": {
                 break;
             }
+            case "INTERACTION_CREATE": {
+                /**
+                * Fired when an interaction is created
+                * @event Client#interactionCreate
+                * @prop {Interaction} Interaction Interaction that was created
+                */
+                this.emit("interactionCreate", new Interaction(packet.d, this.client));
+                break;
+            }
             default: {
                 /**
                 * Fired when the shard encounters an unknown packet

lib/rest/Endpoints.js

@@ -6,6 +6,9 @@ module.exports.BASE_URL = "/api/v" + REST_VERSION;
 module.exports.CDN_URL = "https://cdn.discordapp.com";
 module.exports.CLIENT_URL = "https://discord.com";
 
+module.exports.APPLICATION_PERMISSIONS =                        (appID, guildID) => `/applications/${appID}/guilds/${guildID}/commands/permissions`;
+module.exports.APPLICATION_COMMAND_PERMISSIONS =         (appID, guildID, cmdID) => `/applications/${appID}/guilds/${guildID}/commands/${cmdID}/permissions`;
+module.exports.ORIGINAL_INTERACTION_RESPONSE =            (appID, interactToken) => `/webhooks/${appID}/${interactToken}`;
 module.exports.CHANNEL =                                                (chanID) => `/channels/${chanID}`;
 module.exports.CHANNEL_BULK_DELETE =                                    (chanID) => `/channels/${chanID}/messages/bulk-delete`;
 module.exports.CHANNEL_CALL_RING =                                      (chanID) => `/channels/${chanID}/call/ring`;
@@ -65,6 +68,7 @@ module.exports.GUILD_WELCOME_SCREEN =                                  (guildID)
 module.exports.GUILD_WIDGET =                                          (guildID) => `/guilds/${guildID}/widget`;
 module.exports.GUILD_VOICE_STATE =                               (guildID, user) => `/guilds/${guildID}/voice-states/${user}`;
 module.exports.GUILDS =                                                             "/guilds";
+module.exports.INTERACTION_RESPOND =                 (interactID, interactToken) => `/interactions/${interactID}/${interactToken}/callback`;
 module.exports.INVITE =                                               (inviteID) => `/invite/${inviteID}`;
 module.exports.OAUTH2_APPLICATION =                                      (appID) => `/oauth2/applications/${appID}`;
 module.exports.USER =                                                   (userID) => `/users/${userID}`;