Initial commit from discordx

Author: PatatoBit

.gitignore

@@ -0,0 +1,10 @@
+# files
+.vscode
+.env
+.env.local
+package-lock.json
+yarn.lock
+
+# folders
+build
+node_modules

Dockerfile

@@ -0,0 +1,36 @@
+## build runner
+FROM node:lts-alpine as build-runner
+
+# Set temp directory
+WORKDIR /tmp/app
+
+# Move package.json
+COPY package.json .
+
+# Install dependencies
+RUN npm install
+
+# Move source files
+COPY src ./src
+COPY tsconfig.json   .
+
+# Build project
+RUN npm run build
+
+## producation runner
+FROM node:lts-alpine as prod-runner
+
+# Set work directory
+WORKDIR /app
+
+# Copy package.json from build-runner
+COPY --from=build-runner /tmp/app/package.json /app/package.json
+
+# Install dependencies
+RUN npm install --only=production
+
+# Move build files
+COPY --from=build-runner /tmp/app/build /app/build
+
+# Start bot
+CMD [ "npm", "run", "start" ]

README.md

@@ -0,0 +1,99 @@
+<div>
+  <p align="center">
+    <a href="https://discordx.js.org" target="_blank" rel="nofollow">
+      <img src="https://discordx.js.org/discordx.svg" width="546" />
+    </a>
+  </p>
+  <p align="center">
+    <a href="https://discordx.js.org/discord"
+      ><img
+        src="https://img.shields.io/discord/874802018361950248?color=5865F2&logo=discord&logoColor=white"
+        alt="Discord server"
+    /></a>
+    <a href="https://www.npmjs.com/package/discordx"
+      ><img
+        src="https://img.shields.io/npm/v/discordx.svg?maxAge=3600"
+        alt="NPM version"
+    /></a>
+    <a href="https://www.npmjs.com/package/discordx"
+      ><img
+        src="https://img.shields.io/npm/dt/discordx.svg?maxAge=3600"
+        alt="NPM downloads"
+    /></a>
+    <a href="https://github.com/oceanroleplay/discord.ts/actions"
+      ><img
+        src="https://github.com/oceanroleplay/discord.ts/workflows/Build/badge.svg"
+        alt="Build status"
+    /></a>
+    <a href="https://www.paypal.me/vijayxmeena"
+      ><img
+        src="https://img.shields.io/badge/donate-paypal-F96854.svg"
+        alt="paypal"
+    /></a>
+  </p>
+  <p align="center">
+    <b> Create a discord bot with TypeScript and Decorators! </b>
+  </p>
+</div>
+
+# 📖 Introduction
+
+A starter template equipped with several interaction commands and one event.
+
+# 🏗 Development
+
+```
+npm install
+npm run dev
+```
+
+If you want to use [Nodemon](https://nodemon.io/) to auto-reload while in development:
+
+```
+npm run watch
+```
+
+# 💻 Production
+
+```
+npm install --production
+npm run build
+npm run start
+```
+
+# 🐋 Docker
+
+To start your application:
+
+```
+docker-compose up -d
+```
+
+To shut down your application:
+
+```
+docker-compose down
+```
+
+To view your application's logs:
+
+```
+docker-compose logs
+```
+
+For the full command list please view the [Docker Documentation](https://docs.docker.com/engine/reference/commandline/cli/).
+
+# 📜 Documentation
+
+- [discordx.js.org](https://discordx.js.org)
+- [Tutorials (dev.to)](https://dev.to/oceanroleplay/series/14317)
+
+# ☎️ Need help?
+
+- [Check frequently asked questions](https://discordx.js.org/docs/faq)
+- [Check examples](https://github.com/oceanroleplay/discord.ts/tree/main/packages/discordx/examples)
+- Ask in the community [Discord server](https://discordx.js.org/discord)
+
+# 💖 Thank you
+
+You can support [discordx](https://www.npmjs.com/package/discordx) by giving it a [GitHub](https://github.com/oceanroleplay/discord.ts) star.

docker-compose.yml

@@ -0,0 +1,7 @@
+version: "3"
+services:
+  app:
+    build: .
+    command: node build/main.js
+    environment:
+      - BOT_TOKEN=${BOT_TOKEN}

package.json

@@ -0,0 +1,32 @@
+{
+  "name": "botsofcode",
+  "version": "1.0.0",
+  "private": true,
+  "license": "MIT",
+  "type": "module",
+  "main": "build/main.js",
+  "scripts": {
+    "build": "tsc",
+    "build:changelog": "npx @discordx/changelog --root=src",
+    "dev": "ts-node-esm src/main.ts",
+    "start": "node build/main.js",
+    "watch": "nodemon --exec ts-node-esm src/main.ts"
+  },
+  "dependencies": {
+    "@discordx/importer": "^1.1.10",
+    "@discordx/pagination": "^3.2.0",
+    "discord.js": "^14.4.0",
+    "discordx": "^11.3.0"
+  },
+  "devDependencies": {
+    "@types/node": "^18.7.18",
+    "nodemon": "^2.0.20",
+    "prettier": "^2.7.1",
+    "ts-node": "^10.9.1",
+    "typescript": "4.8.3"
+  },
+  "engines": {
+    "node": ">=16.0.0",
+    "npm": ">=7.0.0"
+  }
+}

src/commands/choices.ts

@@ -0,0 +1,37 @@
+import type { CommandInteraction } from "discord.js";
+import { ApplicationCommandOptionType } from "discord.js";
+import { Discord, Slash, SlashChoice, SlashOption } from "discordx";
+
+@Discord()
+export class Example {
+  @Slash({ description: "choose" })
+  choose(
+    @SlashChoice("Human", "Astronaut", "Dev")
+    @SlashOption({
+      description: "What are you?",
+      name: "what",
+      required: true,
+      type: ApplicationCommandOptionType.String,
+    })
+    what: string,
+    interaction: CommandInteraction
+  ): void {
+    interaction.reply(what);
+  }
+
+  @Slash({ description: "choose1" })
+  choose1(
+    @SlashChoice({ name: "are you okay?", value: "okay" })
+    @SlashChoice({ name: "are you good?", value: "good" })
+    @SlashOption({
+      description: "what1",
+      name: "what1",
+      required: true,
+      type: ApplicationCommandOptionType.String,
+    })
+    what: string,
+    interaction: CommandInteraction
+  ): void {
+    interaction.reply(what);
+  }
+}

src/commands/context.ts

@@ -0,0 +1,22 @@
+import type {
+  MessageContextMenuCommandInteraction,
+  UserContextMenuCommandInteraction,
+} from "discord.js";
+import { ApplicationCommandType } from "discord.js";
+import { ContextMenu, Discord } from "discordx";
+
+@Discord()
+export class Example {
+  @ContextMenu({
+    name: "message context",
+    type: ApplicationCommandType.Message,
+  })
+  messageHandler(interaction: MessageContextMenuCommandInteraction): void {
+    interaction.reply("I am user context handler");
+  }
+
+  @ContextMenu({ name: "user context", type: ApplicationCommandType.User })
+  userHandler(interaction: UserContextMenuCommandInteraction): void {
+    interaction.reply("I am user context handler");
+  }
+}

src/commands/menu.ts

@@ -0,0 +1,59 @@
+import type {
+  CommandInteraction,
+  MessageActionRowComponentBuilder,
+  SelectMenuInteraction,
+} from "discord.js";
+import { ActionRowBuilder, SelectMenuBuilder } from "discord.js";
+import { Discord, SelectMenuComponent, Slash } from "discordx";
+
+const roles = [
+  { label: "Principal", value: "principal" },
+  { label: "Teacher", value: "teacher" },
+  { label: "Student", value: "student" },
+];
+
+@Discord()
+export class Example {
+  @SelectMenuComponent({ id: "role-menu" })
+  async handle(interaction: SelectMenuInteraction): Promise<unknown> {
+    await interaction.deferReply();
+
+    // extract selected value by member
+    const roleValue = interaction.values?.[0];
+
+    // if value not found
+    if (!roleValue) {
+      return interaction.followUp("invalid role id, select again");
+    }
+
+    await interaction.followUp(
+      `you have selected role: ${
+        roles.find((r) => r.value === roleValue)?.label ?? "unknown"
+      }`
+    );
+    return;
+  }
+
+  @Slash({ description: "roles menu", name: "my_roles" })
+  async myRoles(interaction: CommandInteraction): Promise<unknown> {
+    await interaction.deferReply();
+
+    // create menu for roles
+    const menu = new SelectMenuBuilder()
+      .addOptions(roles)
+      .setCustomId("role-menu");
+
+    // create a row for message actions
+    const buttonRow =
+      new ActionRowBuilder<MessageActionRowComponentBuilder>().addComponents(
+        menu
+      );
+
+    // send it
+    interaction.editReply({
+      components: [buttonRow],
+      content: "select your role!",
+    });
+    return;
+  }
+}

src/commands/simple command.ts

@@ -0,0 +1,47 @@
+import type { CommandInteraction, Message } from "discord.js";
+import type { SimpleCommandMessage } from "discordx";
+import {
+  Discord,
+  SimpleCommand,
+  SimpleCommandOption,
+  SimpleCommandOptionType,
+  Slash,
+} from "discordx";
+
+@Discord()
+export class Example {
+  @SimpleCommand({ aliases: ["hi"] })
+  hello(command: SimpleCommandMessage): void {
+    command.message.reply(`👋 ${command.message.member}`);
+  }
+
+  @SimpleCommand({ argSplitter: "+" })
+  sum(
+    @SimpleCommandOption({ name: "num1", type: SimpleCommandOptionType.Number })
+    num1: number | undefined,
+    @SimpleCommandOption({ name: "num2", type: SimpleCommandOptionType.Number })
+    num2: number | undefined,
+    command: SimpleCommandMessage
+  ): void {
+    if (!num1 || !num2) {
+      command.sendUsageSyntax();
+      return;
+    }
+    command.message.reply(`total = ${num1 + num2}`);
+  }
+
+  // make single handler for simple and slash command
+  likeIt(command: CommandInteraction | Message): void {
+    command.reply("I like it, Thanks");
+  }
+
+  @SimpleCommand({ name: "like-it" })
+  simpleLikeIt(command: SimpleCommandMessage): void {
+    this.likeIt(command.message);
+  }
+
+  @Slash({ description: "like-ite", name: "like-it" })
+  slashLikeIt(command: CommandInteraction): void {
+    this.likeIt(command);
+  }
+}