Merge pull request #8 from Mimickal/djs-v14

Author: Mimickal

README.md

@@ -4,17 +4,20 @@
 src="https://www.gnu.org/graphics/lgplv3-with-text-154x68.png">
 </a>
 
+_**NOTE: version 2.x of this library supports discord.js v14. If you still need
+v13 support, use an older 1.x version of this library.**_
+
 This is a data structure that lets you define Discord.js slash commands,
 register them with Discord's API, and route Discord.js Interaction events to
 your handler for that command.
 
 Currently Discord.js separates slash command creation into three different,
 weirdly disjoined processes. They want you to:
-1. [Define your commands with a builder](https://github.com/discordjs/builders/blob/main/docs/examples/Slash%20Command%20Builders.md),
+1. [Define your commands with a builder](https://github.com/discordjs/discord.js/tree/main/packages/builders),
 which is only used to construct the data of an HTTP call.
-1. [Deploy them with a separate HTTP PUT call](https://discordjs.guide/creating-your-bot/creating-commands.html#command-deployment-script),
+1. [Deploy them with a separate HTTP PUT call](https://discordjs.guide/creating-your-bot/command-deployment.html#guild-commands),
 which uses an entirely separate library that directly relies on the Discord API
-1. [Set up a fairly complicated file structure for each command](https://github.com/discordjs/builders/blob/main/docs/examples/Slash%20Command%20Builders.md),
+1. [Set up a fairly complicated file structure for each command](https://discordjs.guide/creating-your-bot/slash-commands.html),
 which still requires you to write your own router and juggle your own handlers
 
 This library simplifies this process by letting you do this all in one place.
@@ -202,29 +205,23 @@ const commands = new SlashCommandRegistry()
     );
 ```
 
-## Other stuff from `@discordjs/builders`
+## Helpers
 
 The Discord.js builders package [has a lot of neat
-helper functions](https://discordjs.guide/popular-topics/builders.html). The
-command registry passes all of these functions through, so they can be included
-directly (preventing the need to add / import `@discordjs/builders`).
+helper functions](https://discord.js.org/docs/packages/builders/main#/docs/discord.js/14.9.0/general/welcome).
+The command registry passes all of these functions through, so they can be
+included directly (preventing the need to add / import `@discordjs/builders`).
 
 ```js
 const { bold, hyperlink, time } = require('discord-command-registry');
 ```
 
 ## Dependencies
 
-This library is built using the following libraries. You will, of course, need
-Node and Discord.js, but you don't need any of the others. This library
-downloads these dependencies for you, and you interact with them through this
-library.
+This library is built using the following libraries:
 
-- Node 16.6.0 (or above)
-- [discord.js 13.x](https://discord.js.org/#/docs/main/13.3.1/general/welcome)
-- [@discordjs/builders](https://www.npmjs.com/package/@discordjs/builders)
-- [@discordjs/rest 0.1.0-canary.0](https://www.npmjs.com/package/@discordjs/rest)
-- [discord-api-types v9](https://www.npmjs.com/package/discord-api-types)
+- Node 16.9.0 (or above)
+- [discord.js 14.x](https://discord.js.org/#/docs/discord.js/14.9.0/general/welcome)
 
 ## License
 

index.js

@@ -8,10 +8,6 @@
  * <https://www.gnu.org/licenses/lgpl-3.0.en.html> for more information.
  ******************************************************************************/
 
-/**
- * @external CommandInteraction
- * @see https://discord.js.org/#/docs/main/stable/class/CommandInteraction
- */
 /**
  * The function called during command execution.
  *
@@ -22,7 +18,7 @@
 
 const {
 	Application,
-	Interaction,
+	BaseInteraction,
 	Snowflake,
 	CommandInteraction,
 } = require('discord.js');
@@ -38,6 +34,8 @@ const {
 	SlashCommandSubcommandGroupBuilder,
 } = require('@discordjs/builders');
 
+const API_VERSION = '10';
+
 /**
  * Sets a handler function called when this command is executed.
  *
@@ -63,7 +61,8 @@ SlashCommandSubcommandGroupBuilder.prototype.setHandler = setHandler;
 
 /**
  * A collection of Discord.js commands that registers itself with Discord's API
- * and routes Discord.js Interaction events to the appropriate command handlers.
+ * and routes Discord.js {@link BaseInteraction} events to the appropriate
+ * command handlers.
  */
 class SlashCommandRegistry {
 
@@ -96,11 +95,11 @@ class SlashCommandRegistry {
 	 * Creates a new {@link SlashCommandRegistry}.
 	 */
 	constructor() {
-		this.#rest = new REST({ version: '9' });
+		this.#rest = new REST({ version: API_VERSION });
 	}
 
 	/**
-	 * Defines a new command from a builder.
+	 * Defines a new slash command from a builder.
 	 * Commands defined here can also be registered with Discord's API.
 	 *
 	 * @param {SlashCommandBuilder|Function<SlashCommandBuilder>} input
@@ -211,24 +210,24 @@ class SlashCommandRegistry {
 	}
 
 	/**
-	 * Attempts to execute the given Discord.js Interaction using the most
-	 * specific handler provided. For example, if an individual subcommand does
-	 * not have a handler but the parent command does, the parent's handler will
-	 * be called. If no builder matches the interaction, the default handler is
-	 * called (if provided).
+	 * Attempts to execute the given Discord.js {@link BaseInteraction} using
+	 * the most specific handler provided. For example, if an individual
+	 * subcommand does not have a handler but the parent command does, the
+	 * parent's handler will be called. If no builder matches the interaction,
+	 * the default handler is called (if provided).
 	 *
 	 * This function is a no-op if:
-	 * - The interaction is not a supported {@link Interaction} type. We
+	 * - The interaction is not a supported {@link BaseInteraction} type. We
 	 *   currently support:
 	 *     - {@link CommandInteraction}
 	 *     - {@link ContextMenuInteraction}
 	 * - No builder matches the interaction and no default handler is set.
 	 *
 	 * This function is set up so it can be directly used as the handler for
-	 * Discord.js' `interactionCreate` event (but you may consider a thin wrapper
-	 * for logging).
+	 * Discord.js' `interactionCreate` event (but you may consider a thin
+	 * wrapper for logging).
 	 *
-	 * @param {Interaction} interaction A Discord.js Interaction object.
+	 * @param {BaseInteraction} interaction A Discord.js interaction object.
 	 * @return {Promise<*>} Fulfills based on command execution.
 	 * @resolve The value returned from the {@link Handler}.
 	 * @reject
@@ -238,12 +237,11 @@ class SlashCommandRegistry {
 	 * - Any Error that occurs during handler execution.
 	 */
 	async execute(interaction) {
-		// TODO maybe allow "non-strict" interaction matching?
-		if (!(interaction instanceof Interaction)) {
-			throw new Error('given value was not a Discord.js Interaction');
+		if (!(typeof interaction?.isCommand === 'function')) {
+			throw new Error(`given value was not a Discord.js command`);
 		}
 
-		if (!interaction.isCommand() && !interaction.isContextMenu()) {
+		if (!interaction.isCommand?.() && !interaction.isContextMenuCommand?.()) {
 			return;
 		}
 
@@ -357,7 +355,7 @@ class SlashCommandRegistry {
  */
 async function getApplication(interaction, opt_name, required=false) {
 	const app_id = interaction.options.getString(opt_name, required);
-	return new REST({ version: '10' })
+	return new REST({ version: API_VERSION })
 		.setToken('ignored')
 		.get(`/applications/${app_id}/rpc`) // NOTE: undocumented endpoint!
 		.then(data => new Application(interaction.client, data))