refactor(interactions): Interactions Refactor

esm.mjs

@@ -5,6 +5,7 @@ export default function(token, options) {
 }
 
 export const {
+  ApplicationCommand,
   AutocompleteInteraction,
   Base,
   Bucket,
@@ -53,7 +54,6 @@ export const {
   ThreadChannel,
   ThreadMember,
   UnavailableGuild,
-  UnknownInteraction,
   User,
   VERSION,
   VoiceChannel,

examples/applicationCommands.js

@@ -10,8 +10,6 @@ const bot = new Eris("BOT TOKEN", {
 bot.on("ready", async () => { // When the bot is ready
     console.log("Ready!"); // Log "Ready!"
 
-    //Note: You should use guild commands to test, as they update instantly. Global commands can take up to an hour to update.
-
     const commands = await bot.getCommands();
 
     if(!commands.length) {

index.js

@@ -6,6 +6,7 @@ function Eris(token, options) {
     return new Client(token, options);
 }
 
+Eris.ApplicationCommand = require("./lib/structures/ApplicationCommand");
 Eris.AutocompleteInteraction = require("./lib/structures/AutocompleteInteraction");
 Eris.Base = require("./lib/structures/Base");
 Eris.Bucket = require("./lib/util/Bucket");
@@ -54,7 +55,6 @@ Eris.TextVoiceChannel = require("./lib/structures/TextVoiceChannel");
 Eris.ThreadChannel = require("./lib/structures/ThreadChannel");
 Eris.ThreadMember = require("./lib/structures/ThreadMember");
 Eris.UnavailableGuild = require("./lib/structures/UnavailableGuild");
-Eris.UnknownInteraction = require("./lib/structures/UnknownInteraction");
 Eris.User = require("./lib/structures/User");
 Eris.VERSION = require("./package.json").version;
 Eris.VoiceChannel = require("./lib/structures/VoiceChannel");

lib/gateway/Shard.js

@@ -2338,7 +2338,7 @@ class Shard extends EventEmitter {
                 /**
                 * Fired when an interaction is created
                 * @event Client#interactionCreate
-                * @prop {PingInteraction | CommandInteraction | ComponentInteraction | AutocompleteInteraction | UnknownInteraction} Interaction The Interaction that was created
+                * @prop {CommandInteraction | ComponentInteraction | AutocompleteInteraction} Interaction The Interaction that was created
                 */
                 this.emit("interactionCreate", Interaction.from(packet.d, this.client));
                 break;

lib/structures/ApplicationCommand.js

@@ -0,0 +1,95 @@
+const Base = require("./Base");
+
+/**
+ * Represents an application command
+ * @prop {String} applicationID The ID of the application that this command belongs to
+ * @prop {String?} defaultMemberPermissions The [permissions](https://discord.com/developers/docs/topics/permissions) required by default for this command to be usable
+ * @prop {String} description The description of the command (empty for user & message commands)
+ * @prop {Object?} descriptionLocalizations A map of [locales](https://discord.com/developers/docs/reference#locales) to descriptions for that locale
+ * @prop {Boolean?} dmPermission If this command can be used in direct messages (global commands only)
+ * @prop {String?} guildID The ID of the guild associated with this command (guild commands only)
+ * @prop {String} id The ID of the application command
+ * @prop {String} name The name of the command
+ * @prop {Object?} nameLocalizations A map of [locales](https://discord.com/developers/docs/reference#locales) to names for that locale
+ * @prop {Object[]?} options The [options](https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-structure) associated with this command
+ * @prop {Number} type The [command type](https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-types)
+ * @prop {String} version The id of the version of this command
+ */
+class ApplicationCommand extends Base {
+    constructor(data, client) {
+        super(data.id);
+        this._client = client;
+        this.applicationID = data.application_id;
+        this.name = data.name;
+        this.description = data.description;
+        this.type = data.type;
+        this.version = data.version;
+
+        if(data.guild_id !== undefined) {
+            this.guildID = data.guild_id;
+        }
+
+        if(data.name_localizations !== undefined) {
+            this.nameLocalizations = data.name_localizations;
+        }
+
+        if(data.description_localizations !== undefined) {
+            this.descriptionLocalizations = data.description_localizations;
+        }
+
+        if(data.options !== undefined) {
+            this.options = data.options;
+        }
+
+        if(data.default_member_permissions !== undefined) {
+            this.defaultMemberPermissions = data.default_member_permissions;
+        }
+
+        if(data.dm_permission !== undefined) {
+            this.dmPermission = data.dm_permission;
+        }
+    }
+
+    /**
+     * Delete This command
+     * @returns {Promise}
+     */
+    delete() {
+        return this.guildID === undefined ? this._client.deleteCommand.call(this._client, this.id) : this._client.deleteGuildCommand.call(this._client, this.guildID, this.id);
+    }
+
+    /**
+    * Edit this application command
+    * @arg {Object} options The properties to edit
+    * @arg {String} [options.name] The command name
+    * @arg {Object} [options.nameLocalizations] A map of [locales](https://discord.com/developers/docs/reference#locales) to names for that locale
+    * @arg {String} [options.description] The command description (chat input commands only)
+    * @arg {Object} [options.descriptionLocalizations] A map of [locales](https://discord.com/developers/docs/reference#locales) to descriptions for that locale
+    * @arg {Array<Object>} [options.options] An array of [command options](https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-structure)
+    * @arg {String} [options.defaultMemberPermissions] The [permissions](https://discord.com/developers/docs/topics/permissions) required by default for this command to be usable
+    * @arg {Boolean} [options.dmPermission] If this command can be used in direct messages (global commands only)
+    * @returns {Promise}
+    */
+    edit(options) {
+        return this.guildID === undefined ? this._client.editCommand.call(this._client, this.id, options) : this._client.editGuildCommand.call(this._client, this.id, this.guildID, options);
+    }
+
+    toJSON(props = []) {
+        return super.toJSON([
+            "applicationID",
+            "defaultMemberPermissions",
+            "description",
+            "descriptionLocalizations",
+            "dmPermission",
+            "guildID",
+            "name",
+            "nameLocalizations",
+            "options",
+            "type",
+            "version",
+            ...props
+        ]);
+    }
+}
+
+module.exports = ApplicationCommand;

lib/structures/AutocompleteInteraction.js

@@ -1,62 +1,24 @@
 "use strict";
 
 const Interaction = require("./Interaction");
-const Member = require("./Member");
-const Permission = require("./Permission");
 const {InteractionResponseTypes} = require("../Constants");
 
 /**
 * Represents an application command autocomplete interaction. See Interaction for more properties.
 * @extends Interaction
-* @prop {Permission?} appPermissions The permissions the app or bot has within the channel the interaction was sent from
-* @prop {PrivateChannel | TextChannel | NewsChannel} channel The channel the interaction was created in. Can be partial with only the id if the channel is not cached.
 * @prop {Object} data The data attached to the interaction
 * @prop {String} data.id The ID of the Application Command
 * @prop {String} data.name The command name
 * @prop {Number} data.type The [command type](https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-types)
 * @prop {String?} data.target_id The id the of user or message targetted by a context menu command
 * @prop {Array<Object>?} data.options The run Application Command options
 * @prop {String} data.options[].name The name of the Application Command option
-* @prop {Number} data.options[].type Command option type, 1-10
-* @prop {(String | Number | Boolean)?} data.options[].value The value of the run Application Command (Mutually exclusive with options)
-* @prop {Boolean?} data.options[].focused Whether or not the option is focused
-* @prop {Array<Object>?} data.options[].options The run Application Command options (Mutually exclusive with value)
-* @prop {String?} guildID The ID of the guild in which the interaction was created
-* @prop {Member?} member The member who triggered the interaction (This is only sent when the interaction is invoked within a guild)
-* @prop {User?} user The user who triggered the interaction (This is only sent when the interaction is invoked within a dm)
+* @prop {Number} data.options[].type The [option type](https://discord.com/developers/docs/interactions/application-commands#application-command-object-application-command-option-type)
+* @prop {(String | Number | Boolean)?} data.options[].value The option value (Mutually exclusive with options)
+* @prop {Boolean?} data.options[].focused If the option is focused
+* @prop {Array<Object>?} data.options[].options Sub-options (Mutually exclusive with value, subcommand/subcommandgroup)
 */
 class AutocompleteInteraction extends Interaction {
-    constructor(info, client) {
-        super(info, client);
-
-        this.channel = this._client.getChannel(info.channel_id) || {
-            id: info.channel_id
-        };
-
-        this.data = info.data;
-
-        if(info.guild_id !== undefined) {
-            this.guildID = info.guild_id;
-        }
-
-        if(info.member !== undefined) {
-            if(this.channel.guild) {
-                info.member.id = info.member.user.id;
-                this.member = this.channel.guild.members.update(info.member, this.channel.guild);
-            } else {
-                const guild = this._client.guilds.get(info.guild_id);
-                this.member = new Member(info.member, guild, this._client);
-            }
-        }
-
-        if(info.user !== undefined) {
-            this.user = this._client.users.update(info.user, client);
-        }
-
-        if(info.app_permissions !== undefined) {
-            this.appPermissions = new Permission(info.app_permissions);
-        }
-    }
 
     /**
     * Acknowledges the autocomplete interaction with a result of choices.
@@ -66,7 +28,7 @@ class AutocompleteInteraction extends Interaction {
     * @arg {String} choices[].value The choice value to return to the bot
     * @returns {Promise}
     */
-    async acknowledge(choices) {
+    acknowledge(choices) {
         return this.result(choices);
     }
 
@@ -78,7 +40,7 @@ class AutocompleteInteraction extends Interaction {
     * @arg {String} choices[].value The choice value to return to the bot
     * @returns {Promise}
     */
-    async result(choices) {
+    result(choices) {
         if(this.acknowledged === true) {
             throw new Error("You have already acknowledged this interaction.");
         }
@@ -87,7 +49,6 @@ class AutocompleteInteraction extends Interaction {
             data: {choices}
         }).then(() => this.update());
     }
-
 }
 
 module.exports = AutocompleteInteraction;