refactor(discordx): discordjs builders support (#1065)

* refactor(discordx): discordjs builders support

* refactor: add doc example

* refactor: bump version

docs/docs/discordx/decorators/command/slash-option.md

@@ -44,6 +44,38 @@ class Example {
 }
 ```
 
+## Create option using discord.js builders
+
+```ts
+import {
+  SlashCommandBuilder,
+  SlashCommandMentionableOption,
+  User,
+  type CommandInteraction,
+} from "discord.js";
+import { Discord, Slash, SlashOption } from "discordx";
+
+const cmd = new SlashCommandBuilder()
+  .setName("hello")
+  .setDescription("Say hello!");
+
+const user_option = new SlashCommandMentionableOption()
+  .setName("user")
+  .setDescription("Mention user to say hello to.")
+  .setRequired(true);
+
+@Discord()
+export class Example {
+  @Slash(cmd)
+  async hello(
+    @SlashOption(user_option) user: User,
+    interaction: CommandInteraction,
+  ): Promise<void> {
+    await interaction.reply(`:wave: ${user}`);
+  }
+}
+```
+
 ## Transformer
 
 Act as middleware for your parameters. Take a look at the following example to see how useful it is.
@@ -81,13 +113,15 @@ function DocumentTransformer(
 export class Example {
   @Slash({ description: "Save input into database", name: "save-input" })
   async withTransformer(
-    @SlashOption({
-      description: "input",
-      name: "input",
-      required: true,
-      transformer: DocumentTransformer,
-      type: ApplicationCommandOptionType.String,
-    })
+    @SlashOption(
+      {
+        description: "input",
+        name: "input",
+        required: true,
+        type: ApplicationCommandOptionType.String,
+      },
+      DocumentTransformer,
+    )
     doc: Document,
     interaction: ChatInputCommandInteraction,
   ): Promise<void> {

packages/discordx/CHANGELOG.md

@@ -1,5 +1,11 @@
 # discordx
 
+## 11.12.0
+
+### Minor Changes
+
+- added support for slash command builder
+
 ## 11.11.3
 
 ### Patch Changes

packages/discordx/examples/builders/commands/autocomplete.ts

@@ -0,0 +1,41 @@
+/*
+ * -------------------------------------------------------------------------------------------------------
+ * Copyright (c) Vijay Meena <[email protected]> (https://github.com/samarmeena). All rights reserved.
+ * Licensed under the Apache License. See License.txt in the project root for license information.
+ * -------------------------------------------------------------------------------------------------------
+ */
+import {
+  AutocompleteInteraction,
+  SlashCommandBuilder,
+  SlashCommandStringOption,
+  type CommandInteraction,
+} from "discord.js";
+import { Discord, Slash, SlashOption } from "discordx";
+
+const cmd = new SlashCommandBuilder()
+  .setName("planet-auto")
+  .setDescription("Select a planet");
+
+const planet_option = new SlashCommandStringOption()
+  .setName("planet")
+  .setDescription("Choose a planet")
+  .setRequired(true)
+  .setAutocomplete(true);
+
+@Discord()
+export class Example {
+  @Slash(cmd)
+  async hello(
+    @SlashOption(planet_option) planet: string,
+    interaction: CommandInteraction | AutocompleteInteraction,
+  ): Promise<void> {
+    if (interaction.isAutocomplete()) {
+      interaction.respond([
+        { name: "Earth", value: "Earth" },
+        { name: "Mars", value: "Mars" },
+      ]);
+    } else {
+      await interaction.reply(`:rocket: going to ${planet}`);
+    }
+  }
+}

packages/discordx/examples/builders/commands/choice.ts

@@ -0,0 +1,36 @@
+/*
+ * -------------------------------------------------------------------------------------------------------
+ * Copyright (c) Vijay Meena <[email protected]> (https://github.com/samarmeena). All rights reserved.
+ * Licensed under the Apache License. See License.txt in the project root for license information.
+ * -------------------------------------------------------------------------------------------------------
+ */
+import {
+  SlashCommandBuilder,
+  SlashCommandStringOption,
+  type CommandInteraction,
+} from "discord.js";
+import { Discord, Slash, SlashOption } from "discordx";
+
+const cmd = new SlashCommandBuilder()
+  .setName("planet")
+  .setDescription("Select a planet");
+
+const planet_option = new SlashCommandStringOption()
+  .setName("planet")
+  .setDescription("Choose a planet")
+  .setRequired(true)
+  .addChoices([
+    { name: "Earth", value: "Earth" },
+    { name: "Mars", value: "Mars" },
+  ]);
+
+@Discord()
+export class Example {
+  @Slash(cmd)
+  async hello(
+    @SlashOption(planet_option) planet: string,
+    interaction: CommandInteraction,
+  ): Promise<void> {
+    await interaction.reply(`:rocket: going to ${planet}`);
+  }
+}

packages/discordx/examples/builders/commands/hello.ts

@@ -0,0 +1,33 @@
+/*
+ * -------------------------------------------------------------------------------------------------------
+ * Copyright (c) Vijay Meena <[email protected]> (https://github.com/samarmeena). All rights reserved.
+ * Licensed under the Apache License. See License.txt in the project root for license information.
+ * -------------------------------------------------------------------------------------------------------
+ */
+import {
+  SlashCommandBuilder,
+  SlashCommandMentionableOption,
+  User,
+  type CommandInteraction,
+} from "discord.js";
+import { Discord, Slash, SlashOption } from "discordx";
+
+const cmd = new SlashCommandBuilder()
+  .setName("hello")
+  .setDescription("Say hello!");
+
+const user_option = new SlashCommandMentionableOption()
+  .setName("user")
+  .setDescription("Mention user to say hello to.")
+  .setRequired(true);
+
+@Discord()
+export class Example {
+  @Slash(cmd)
+  async hello(
+    @SlashOption(user_option) user: User,
+    interaction: CommandInteraction,
+  ): Promise<void> {
+    await interaction.reply(`:wave: ${user}`);
+  }
+}

packages/discordx/examples/builders/commands/ping.ts

@@ -0,0 +1,20 @@
+/*
+ * -------------------------------------------------------------------------------------------------------
+ * Copyright (c) Vijay Meena <[email protected]> (https://github.com/samarmeena). All rights reserved.
+ * Licensed under the Apache License. See License.txt in the project root for license information.
+ * -------------------------------------------------------------------------------------------------------
+ */
+import { SlashCommandBuilder, type CommandInteraction } from "discord.js";
+import { Discord, Slash } from "discordx";
+
+const cmd = new SlashCommandBuilder()
+  .setName("ping")
+  .setDescription("Reply with pong!");
+
+@Discord()
+export class Example {
+  @Slash(cmd)
+  async ping(interaction: CommandInteraction): Promise<void> {
+    await interaction.reply("Pong");
+  }
+}

packages/discordx/examples/builders/main.ts

@@ -0,0 +1,55 @@
+/*
+ * -------------------------------------------------------------------------------------------------------
+ * Copyright (c) Vijay Meena <[email protected]> (https://github.com/samarmeena). All rights reserved.
+ * Licensed under the Apache License. See License.txt in the project root for license information.
+ * -------------------------------------------------------------------------------------------------------
+ */
+import { dirname, importx } from "@discordx/importer";
+import { IntentsBitField } from "discord.js";
+import { Client } from "discordx";
+
+export class Main {
+  private static _client: Client;
+
+  static get Client(): Client {
+    return this._client;
+  }
+
+  static async start(): Promise<void> {
+    this._client = new Client({
+      // botGuilds: [(client) => client.guilds.cache.map((guild) => guild.id)],
+      intents: [
+        IntentsBitField.Flags.Guilds,
+        IntentsBitField.Flags.GuildMessages,
+        IntentsBitField.Flags.GuildMembers,
+      ],
+      silent: false,
+    });
+
+    this._client.once("ready", () => {
+      // An example of how guild commands can be cleared
+      //
+      // await this._client.clearApplicationCommands(
+      //   ...this._client.guilds.cache.map((guild) => guild.id)
+      // );
+
+      void this._client.initApplicationCommands();
+
+      console.log(">> Bot started");
+    });
+
+    this._client.on("interactionCreate", (interaction) => {
+      this._client.executeInteraction(interaction);
+    });
+
+    await importx(`${dirname(import.meta.url)}/commands/**/*.{js,ts}`);
+
+    // let's start the bot
+    if (!process.env.BOT_TOKEN) {
+      throw Error("Could not find BOT_TOKEN in your environment");
+    }
+    await this._client.login(process.env.BOT_TOKEN);
+  }
+}
+
+void Main.start();

packages/discordx/examples/builders/tsconfig.json

@@ -0,0 +1,17 @@
+{
+  "compilerOptions": {
+    "module": "ESNext",
+    "target": "ESNext",
+    "strict": true,
+    "noImplicitAny": true,
+    "outDir": "dist",
+    "emitDecoratorMetadata": false,
+    "experimentalDecorators": true,
+    "strictNullChecks": true,
+    "noUncheckedIndexedAccess": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "Bundler",
+    "esModuleInterop": true
+  },
+  "exclude": ["node_modules", "tests", "examples"]
+}

packages/discordx/examples/slash/commands/transformer.ts

@@ -40,13 +40,15 @@ function DocumentTransformer(
 export class Example {
   @Slash({ description: "Save input into database", name: "save-input" })
   async withTransformer(
-    @SlashOption({
-      description: "input",
-      name: "input",
-      required: true,
-      transformer: DocumentTransformer,
-      type: ApplicationCommandOptionType.String,
-    })
+    @SlashOption(
+      {
+        description: "input",
+        name: "input",
+        required: true,
+        type: ApplicationCommandOptionType.String,
+      },
+      DocumentTransformer,
+    )
     doc: Document,
     interaction: ChatInputCommandInteraction,
   ): Promise<void> {

packages/discordx/package.json

@@ -1,6 +1,6 @@
 {
   "name": "discordx",
-  "version": "11.11.3",
+  "version": "11.12.0",
   "private": false,
   "description": "Create a discord bot with TypeScript and Decorators!",
   "keywords": [

packages/discordx/src/decorators/classes/DApplicationCommand.ts

@@ -18,7 +18,7 @@ import { Method } from "./Method.js";
 
 interface CreateStructure {
   botIds?: string[];
-  defaultMemberPermissions?: PermissionResolvable | null;
+  defaultMemberPermissions?: PermissionResolvable | string | null;
   description: string;
   descriptionLocalizations?: LocalizationMap | null;
   dmPermission?: boolean;
@@ -38,7 +38,7 @@ export class DApplicationCommand extends Method {
   private _nameLocalizations: LocalizationMap | null;
   private _description: string;
   private _descriptionLocalizations: LocalizationMap | null;
-  private _defaultMemberPermissions: PermissionResolvable | null;
+  private _defaultMemberPermissions: PermissionResolvable | string | null;
   private _dmPermission: boolean;
   private _guilds: IGuild[];
   private _group?: string;
@@ -61,7 +61,7 @@ export class DApplicationCommand extends Method {
     this._description = value;
   }
 
-  get defaultMemberPermissions(): PermissionResolvable | null {
+  get defaultMemberPermissions(): PermissionResolvable | string | null {
     return this._defaultMemberPermissions;
   }
   set defaultMemberPermissions(value: PermissionResolvable | null) {

packages/discordx/src/decorators/classes/DApplicationCommandOption.ts

@@ -23,6 +23,7 @@ import type {
 interface CreateStructure {
   autocomplete?: SlashAutoCompleteOption;
   channelType?: ChannelType[];
+  choices?: DApplicationCommandOptionChoice[];
   description: string;
   descriptionLocalizations?: LocalizationMap | null;
   index?: number;
@@ -168,6 +169,7 @@ export class DApplicationCommandOption extends Decorator {
     this._name = data.name;
     this._autocomplete = data.autocomplete;
     this._channelTypes = data.channelType?.sort();
+    this._choices = data.choices ?? [];
     this._description = data.description;
     this._index = data.index;
     this._maxValue = data.maxValue;