simple-discord-bot.js 0.1.2 → 0.1.4

package/README.md

@@ -0,0 +1,354 @@
+simple-discord-bot.js
+
+""npm version" (https://img.shields.io/npm/v/simple-discord-bot.js.svg)" (https://www.npmjs.com/package/simple-discord-bot.js)
+""npm downloads" (https://img.shields.io/npm/dm/simple-discord-bot.js.svg)" (https://www.npmjs.com/package/simple-discord-bot.js)
+""License" (https://img.shields.io/npm/l/simple-discord-bot.js.svg)" (https://www.npmjs.com/package/simple-discord-bot.js)
+""Node.js" (https://img.shields.io/badge/Node.js-18%2B-brightgreen.svg)" (https://nodejs.org/)
+
+A simple and lightweight Discord bot library for Node.js
+
+Built to make Discord bot development easier while keeping the API simple and beginner friendly
+
+---
+
+✨ Features
+
+- ⚡ Lightweight
+- 🧩 Simple API
+- 🤖 Discord bot support
+- 💬 Message events
+- ⚙️ Slash commands
+- 📝 Slash command options
+- 🎨 EmbedBuilder
+- 🔐 Permission checking
+- 💓 Gateway heartbeat
+- 🛑 Clean bot shutdown
+- 📦 Available through npm
+- 🟢 Easy to learn
+
+---
+
+📦 Installation
+
+Install the latest version with npm
+
+npm install simple-discord-bot.js
+
+---
+
+🚀 Quick Start
+
+Create a simple bot in just a few lines
+
+const { Client } = require("simple-discord-bot.js")
+
+const client = new Client()
+
+client.command("ping", interaction => {
+  interaction.reply("Pong!")
+}, {
+  description: "Replies with Pong!"
+})
+
+client.on("ready", () => {
+  console.log("Bot is online!")
+})
+
+client.login("YOUR_BOT_TOKEN")
+
+Start your bot
+
+node index.js
+
+---
+
+⚙️ Slash Commands
+
+Create commands with "client.command()"
+
+client.command("hello", interaction => {
+  interaction.reply("Hello!")
+}, {
+  description: "Says hello"
+})
+
+---
+
+🧩 Command Options
+
+Commands can have options
+
+client.command("say", interaction => {
+  interaction.reply(interaction.options.message)
+}, {
+  description: "Make the bot say something",
+  options: [
+    {
+      name: "message",
+      description: "The message to send",
+      type: 3,
+      required: true
+    }
+  ]
+})
+
+The option can then be accessed with
+
+interaction.options.message
+
+---
+
+🎨 Embeds
+
+Create beautiful Discord embeds with "EmbedBuilder"
+
+const { EmbedBuilder } = require("simple-discord-bot.js")
+
+const embed = new EmbedBuilder()
+  .setTitle("Hello")
+  .setDescription("This is an embed!")
+  .setColor("5865F2")
+  .setFooter("Made with SimpleDiscord.js")
+  .setTimestamp()
+
+interaction.reply(embed)
+
+Embed Methods
+
+Title
+
+.setTitle("Hello")
+
+Description
+
+.setDescription("This is my description")
+
+Color
+
+Hex colors are supported
+
+.setColor("FF0000")
+
+URL
+
+.setURL("https://example.com")
+
+Footer
+
+.setFooter("Made with SimpleDiscord.js")
+
+Footer Icon
+
+.setFooter(
+  "Made with SimpleDiscord.js",
+  "https://example.com/icon.png"
+)
+
+Author
+
+.setAuthor("SimpleBot")
+
+Author Icon
+
+.setAuthor(
+  "SimpleBot",
+  "https://example.com/icon.png"
+)
+
+Thumbnail
+
+.setThumbnail("https://example.com/image.png")
+
+Image
+
+.setImage("https://example.com/image.png")
+
+Timestamp
+
+.setTimestamp()
+
+---
+
+🔐 Permissions
+
+Check Discord permissions easily
+
+client.command("admin", interaction => {
+  if (!interaction.member?.permissions.has("Administrator")) {
+    return interaction.reply("You need Administrator")
+  }
+
+  interaction.reply("You have Administrator permission!")
+}, {
+  description: "Administrator only command"
+})
+
+---
+
+💬 Messages
+
+Listen for messages
+
+client.on("message", message => {
+  console.log(message.content)
+})
+
+Reply to messages
+
+message.reply("Hello!")
+
+---
+
+📡 Events
+
+SimpleDiscord.js currently supports:
+
+Event| Description
+"ready"| Bot is ready
+"message"| A message was created
+"error"| Gateway error
+"disconnect"| Bot disconnected
+
+Example
+
+client.on("ready", () => {
+  console.log("Bot is online!")
+})
+
+---
+
+🛠️ API
+
+Client
+
+const { Client } = require("simple-discord-bot.js")
+
+const client = new Client()
+
+"client.login(token)"
+
+Connect your bot to Discord
+
+client.login("YOUR_BOT_TOKEN")
+
+"client.command(name, handler, options)"
+
+Create a slash command
+
+client.command(
+  "ping",
+  interaction => {
+    interaction.reply("Pong!")
+  },
+  {
+    description: "Replies with Pong!"
+  }
+)
+
+"client.destroy()"
+
+Disconnect the bot
+
+client.destroy()
+
+---
+
+📊 Current Status
+
+SimpleDiscord.js is currently in early development
+
+Current version:
+
+0.1.2
+
+The API may change as the library develops
+
+---
+
+🗺️ Roadmap
+
+✅ Completed
+
+- [x] Discord Gateway connection
+- [x] Gateway heartbeat
+- [x] Bot login
+- [x] Clean shutdown
+- [x] Ready event
+- [x] Message events
+- [x] Message replies
+- [x] Slash commands
+- [x] Slash command options
+- [x] Permission checking
+- [x] EmbedBuilder
+- [x] npm publishing
+
+🚧 Planned
+
+- [ ] Embed fields
+- [ ] Buttons
+- [ ] Select menus
+- [ ] More interaction types
+- [ ] Channel objects
+- [ ] Guild objects
+- [ ] User objects
+- [ ] Message editing
+- [ ] Message deletion
+- [ ] More permission helpers
+- [ ] Better error handling
+- [ ] Automatic reconnection
+- [ ] Gateway resume support
+- [ ] More Discord API features
+
+---
+
+📚 Why SimpleDiscord.js?
+
+Discord libraries can become complicated when you're just starting
+
+SimpleDiscord.js focuses on keeping things straightforward
+
+Instead of learning a huge API you can start with:
+
+const { Client } = require("simple-discord-bot.js")
+
+const client = new Client()
+
+client.command("ping", interaction => {
+  interaction.reply("Pong!")
+})
+
+client.login("YOUR_BOT_TOKEN")
+
+Simple
+
+Lightweight
+
+Beginner friendly
+
+---
+
+📦 npm
+
+Install the package from npm
+
+npm install simple-discord-bot.js
+
+---
+
+🤝 Contributing
+
+Contributions and suggestions are welcome
+
+If you find a bug or have an idea for a feature you can open an issue or submit a pull request
+
+---
+
+📄 License
+
+MIT License
+
+---
+
+Made with ❤️ and JavaScript
+
+simple-discord-bot.js

package/client.js

@@ -46,11 +46,13 @@ class Permissions {
   has(permission) {
     const flag = PermissionFlags[permission]
 
-    if (flag === undefined) {
+    if (!flag) {
       return false
     }
 
-    if ((this.bitfield & PermissionFlags.Administrator) !== 0n) {
+    if (
+      (this.bitfield & PermissionFlags.Administrator) !== 0n
+    ) {
       return true
     }
 
@@ -75,79 +77,131 @@ class Client extends EventEmitter {
     })
 
     this.on("rawInteraction", data => {
-      if (data.type !== 2) return
+      if (data.type === 2) {
+        this.handleCommandInteraction(data)
+        return
+      }
 
-      const command = this.commands.get(data.data.name)
+      if (data.type === 3) {
+        this.handleComponentInteraction(data)
+      }
+    })
 
-      if (!command) return
+    process.on("SIGINT", () => {
+      if (this.stopping) return
 
-      const member = data.member
+      this.stopping = true
+      this.destroy()
 
-      const interaction = {
-        id: data.id,
-        token: data.token,
+      setTimeout(() => {
+        process.exit(0)
+      }, 1000)
+    })
+  }
 
-        commandName: data.data.name,
+  handleCommandInteraction(data) {
+    const command = this.commands.get(data.data.name)
 
-        user: member?.user || data.user,
+    if (!command) return
 
-        member: member ? {
-          ...member,
+    const member = data.member
 
-          permissions: new Permissions(member.permissions)
-        } : null,
+    const interaction = {
+      id: data.id,
+      token: data.token,
+      type: "command",
+      commandName: data.data.name,
+      user: member?.user || data.user,
 
-        channelId: data.channel_id,
+      member: member
+        ? {
+            ...member,
+            permissions: new Permissions(
+              member.permissions
+            )
+          }
+        : null,
 
-        guildId: data.guild_id || null,
+      channelId: data.channel_id,
+      guildId: data.guild_id || null,
+      options: {},
 
-        options: {},
+      reply: content => {
+        return this.replyToInteraction(data, content)
+      }
+    }
 
-        reply: content => {
-          const messageData = {}
+    for (const option of data.data.options || []) {
+      interaction.options[option.name] = option.value
+    }
 
-          if (typeof content === "string") {
-            messageData.content = content
-          } else if (
-            content &&
-            typeof content.toJSON === "function"
-          ) {
-            messageData.embeds = [content.toJSON()]
-          } else if (content && typeof content === "object") {
-            Object.assign(messageData, content)
-          }
+    command.handler(interaction)
+  }
 
-          return this.api.request(
-            "POST",
-            `/interactions/${data.id}/${data.token}/callback`,
-            {
-              type: 4,
-              data: messageData
-            }
-          )
-        }
-      }
+  handleComponentInteraction(data) {
+    const componentType = data.data.component_type
 
-      for (const option of data.data.options || []) {
-        interaction.options[option.name] = option.value
-      }
+    let type = "selectMenu"
 
-      command.handler(interaction)
-    })
+    if (componentType === 2) {
+      type = "button"
+    }
 
-    process.on("SIGINT", () => {
-      if (this.stopping) return
+    const interaction = {
+      id: data.id,
+      token: data.token,
+      type: type,
+      componentType: componentType,
+      customId: data.data.custom_id,
+
+      user: data.member?.user || data.user,
+
+      member: data.member
+        ? {
+            ...data.member,
+            permissions: new Permissions(
+              data.member.permissions
+            )
+          }
+        : null,
 
-      this.stopping = true
+      channelId: data.channel_id,
+      guildId: data.guild_id || null,
+      values: data.data.values || [],
+
+      reply: content => {
+        return this.replyToInteraction(data, content)
+      }
+    }
 
-      console.log("Stopping bot...")
+    this.emit("interaction", interaction)
+  }
 
-      this.destroy()
+  replyToInteraction(data, content) {
+    const messageData = {}
+
+    if (typeof content === "string") {
+      messageData.content = content
+    } else if (
+      content &&
+      typeof content.toJSON === "function"
+    ) {
+      messageData.embeds = [content.toJSON()]
+    } else if (
+      content &&
+      typeof content === "object"
+    ) {
+      Object.assign(messageData, content)
+    }
 
-      setTimeout(() => {
-        process.exit(0)
-      }, 1000)
-    })
+    return this.api.request(
+      "POST",
+      `/interactions/${data.id}/${data.token}/callback`,
+      {
+        type: 4,
+        data: messageData
+      }
+    )
   }
 
   login(token) {
@@ -166,10 +220,11 @@ class Client extends EventEmitter {
     this.commands.set(name, {
       command: {
         name: name,
-        description: options.description || "No description",
+        description:
+          options.description || "No description",
         options: options.options || []
       },
-      handler
+      handler: handler
     })
   }
 }

package/gateway.js

@@ -13,11 +13,13 @@ class Gateway {
     )
 
     this.ws.on("open", () => {
+      console.log("Connected to Discord Gateway")
+
       this.ws.send(JSON.stringify({
         op: 2,
         d: {
           token: token,
-          intents: 33281,
+          intents: 33281 | 32768,
           properties: {
             os: "android",
             browser: "SimpleDiscord.js",
@@ -28,23 +30,33 @@ class Gateway {
     })
 
     this.ws.on("message", data => {
-      const packet = JSON.parse(data)
+      try {
+        const packet = JSON.parse(data)
 
-      if (packet.op === 10) {
-        this.startHeartbeat(packet.d.heartbeat_interval)
-      }
+        if (packet.op === 10) {
+          console.log("Gateway connected")
+          this.startHeartbeat(packet.d.heartbeat_interval)
+        }
 
-      if (packet.t === "READY") {
-        this.client.user = packet.d.user
-        this.client.emit("ready", packet.d)
-      }
+        if (packet.op === 9) {
+          console.error("Discord rejected the Gateway connection")
+          return
+        }
 
-      if (packet.t === "MESSAGE_CREATE") {
-        this.client.emit("rawMessage", packet.d)
-      }
+        if (packet.t === "READY") {
+          this.client.user = packet.d.user
+          this.client.emit("ready", packet.d)
+        }
+
+        if (packet.t === "MESSAGE_CREATE") {
+          this.client.emit("rawMessage", packet.d)
+        }
 
-      if (packet.t === "INTERACTION_CREATE") {
-        this.client.emit("rawInteraction", packet.d)
+        if (packet.t === "INTERACTION_CREATE") {
+          this.client.emit("rawInteraction", packet.d)
+        }
+      } catch (error) {
+        this.client.emit("error", error)
       }
     })
 
@@ -57,6 +69,8 @@ class Gateway {
       this.ws = null
       this.client.emit("disconnect")
     })
+
+    return this.ws
   }
 
   startHeartbeat(interval) {
@@ -84,6 +98,7 @@ class Gateway {
 
     if (this.ws) {
       this.ws.close(1000, "Bot stopped")
+      this.ws = null
     }
   }
 }

package/index.js

@@ -1,7 +1,11 @@
 const Client = require("./client")
 const EmbedBuilder = require("./structures/EmbedBuilder")
+const ButtonBuilder = require("./structures/ButtonBuilder")
+const SelectMenuBuilder = require("./structures/SelectMenuBuilder")
 
 module.exports = {
   Client,
-  EmbedBuilder
-}
+  EmbedBuilder,
+  ButtonBuilder,
+  SelectMenuBuilder
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "simple-discord-bot.js",
-  "version": "0.1.2",
+  "version": "0.1.4",
   "description": "A simple Discord bot library",
   "main": "index.js",
   "license": "MIT",

package/structures/ButtonBuilder.js

@@ -0,0 +1,50 @@
+class ButtonBuilder {
+  constructor() {
+    this.data = {
+      type: 2
+    }
+  }
+
+  setCustomId(customId) {
+    this.data.custom_id = customId
+    return this
+  }
+
+  setLabel(label) {
+    this.data.label = label
+    return this
+  }
+
+  setStyle(style) {
+    const styles = {
+      primary: 1,
+      secondary: 2,
+      success: 3,
+      danger: 4,
+      link: 5
+    }
+
+    if (typeof style === "string") {
+      style = styles[style.toLowerCase()]
+    }
+
+    this.data.style = style
+    return this
+  }
+
+  setURL(url) {
+    this.data.url = url
+    return this
+  }
+
+  setDisabled(disabled = true) {
+    this.data.disabled = disabled
+    return this
+  }
+
+  toJSON() {
+    return this.data
+  }
+}
+
+module.exports = ButtonBuilder

package/structures/EmbedBuilder.js

@@ -16,7 +16,12 @@ class EmbedBuilder {
   setColor(color) {
     if (typeof color === "string") {
       color = color.replace("#", "")
-      color = parseInt(color, 16)
+
+      if (/^[0-9a-fA-F]{6}$/.test(color)) {
+        color = parseInt(color, 16)
+      } else {
+        color = 0
+      }
     }
 
     this.data.color = color
@@ -28,11 +33,47 @@ class EmbedBuilder {
     return this
   }
 
-  setFooter(text) {
+  setFooter(text, iconURL = null) {
     this.data.footer = {
       text: text
     }
 
+    if (iconURL) {
+      this.data.footer.icon_url = iconURL
+    }
+
+    return this
+  }
+
+  setAuthor(name, iconURL = null, url = null) {
+    this.data.author = {
+      name: name
+    }
+
+    if (iconURL) {
+      this.data.author.icon_url = iconURL
+    }
+
+    if (url) {
+      this.data.author.url = url
+    }
+
+    return this
+  }
+
+  setThumbnail(url) {
+    this.data.thumbnail = {
+      url: url
+    }
+
+    return this
+  }
+
+  setImage(url) {
+    this.data.image = {
+      url: url
+    }
+
     return this
   }
 
@@ -41,6 +82,40 @@ class EmbedBuilder {
     return this
   }
 
+  addField(name, value, inline = false) {
+    if (!this.data.fields) {
+      this.data.fields = []
+    }
+
+    this.data.fields.push({
+      name: name,
+      value: value,
+      inline: inline
+    })
+
+    return this
+  }
+
+  addFields(...fields) {
+    for (const field of fields) {
+      if (
+        !field ||
+        typeof field.name !== "string" ||
+        typeof field.value !== "string"
+      ) {
+        continue
+      }
+
+      this.addField(
+        field.name,
+        field.value,
+        field.inline || false
+      )
+    }
+
+    return this
+  }
+
   toJSON() {
     return this.data
   }

package/structures/Message.js

@@ -1,22 +1,53 @@
 class Message {
   constructor(client, data) {
     this.client = client
-
     this.id = data.id
-    this.content = data.content
+    this.content = data.content || ""
     this.channelId = data.channel_id
-    this.guildId = data.guild_id
-    this.author = data.author
+    this.guildId = data.guild_id || null
+    this.author = data.author || null
   }
 
-  reply(content) {
-    return this.client.api.request(
+  async reply(content) {
+    const data = await this.client.api.request(
       "POST",
       `/channels/${this.channelId}/messages`,
       {
         content: content
       }
     )
+
+    if (!data || !data.id) {
+      throw new Error(
+        "Discord did not return a valid message: " +
+        JSON.stringify(data)
+      )
+    }
+
+    return new Message(this.client, data)
+  }
+
+  async edit(content) {
+    const data = await this.client.api.request(
+      "PATCH",
+      `/channels/${this.channelId}/messages/${this.id}`,
+      {
+        content: content
+      }
+    )
+
+    this.content = data.content || content
+
+    return this
+  }
+
+  async delete() {
+    await this.client.api.request(
+      "DELETE",
+      `/channels/${this.channelId}/messages/${this.id}`
+    )
+
+    return true
   }
 }
 

package/structures/SelectMenuBuilder.js

@@ -0,0 +1,68 @@
+class SelectMenuBuilder {
+  constructor() {
+    this.data = {
+      type: 3,
+      options: []
+    }
+  }
+
+  setCustomId(customId) {
+    this.data.custom_id = customId
+    return this
+  }
+
+  setPlaceholder(placeholder) {
+    this.data.placeholder = placeholder
+    return this
+  }
+
+  addOptions(...options) {
+    for (const option of options) {
+      if (!option || !option.label || !option.value) {
+        continue
+      }
+
+      const data = {
+        label: option.label,
+        value: option.value
+      }
+
+      if (option.description) {
+        data.description = option.description
+      }
+
+      if (option.emoji) {
+        data.emoji = option.emoji
+      }
+
+      if (option.default) {
+        data.default = true
+      }
+
+      this.data.options.push(data)
+    }
+
+    return this
+  }
+
+  setMinValues(min) {
+    this.data.min_values = min
+    return this
+  }
+
+  setMaxValues(max) {
+    this.data.max_values = max
+    return this
+  }
+
+  setDisabled(disabled = true) {
+    this.data.disabled = disabled
+    return this
+  }
+
+  toJSON() {
+    return this.data
+  }
+}
+
+module.exports = SelectMenuBuilder