beniocord.js 2.0.8 → 2.1.0

package/Client.js

@@ -11,29 +11,40 @@ const Channel = require("./structures/Channel");
 const Emoji = require("./structures/Emoji");
 const { MessageEmbed, MessageAttachment } = require("./structures/Util");
 
-class ClientError extends Error {
-  constructor(message, code) {
-    super(message);
-    this.name = 'ClientError';
-    this.code = code;
-  }
-}
-
 let global = {
   token: "",
   apiUrl: "https://api-bots.beniocord.site"
 };
 
-/**
- * @fires Client#ready
- * @fires Client#messageCreate
- * @fires Client#messageDelete
- * @fires Client#messageEdit
- * @fires Client#error
- * @fires Client#disconnect
- * @fires Client#reconnect
- */
 class Client extends EventEmitter {
+  /**
+   * @fires Client#ready
+   * @fires Client#messageCreate
+   * @fires Client#messageDelete
+   * @fires Client#messageEdit
+   * @fires Client#error
+   * @fires Client#disconnect
+   * @fires Client#reconnect
+   * @fires Client#emojiCreate
+   * @fires Client#emojiDelete
+   * @fires Client#stickerCreate
+   * @fires Client#stickerDelete
+   * @fires Client#channelCreate
+   * @fires Client#channelDelete
+   * @fires Client#channelUpdate
+   * @fires Client#channelMemberAdd
+   * @fires Client#channelMemberRemove
+   * @fires Client#channelMemberUpdate
+   * @fires Client#typingStart
+   * @fires Client#typingStop
+   * @class Client
+   * @description Classe principal do BenioCord.js - Gerencia a comunicação com a API e eventos do bot
+   * @param {Object} options - Opções de configuração do cliente
+   * @param {string} options.token - Token do bot para autenticação
+   * @example
+   * const { Client } = require('beniocord.js');
+   * const client = new Client({ token: 'YOUR_BOT_TOKEN' });
+   */
   constructor({ token }) {
     super();
 
@@ -141,6 +152,10 @@ class Client extends EventEmitter {
       await this._joinAllChannelRooms();
 
       this.isReady = true;
+
+      /**
+       * @event Client#ready
+       */
       this.emit("ready", this.user);
 
       return this.user;
@@ -216,7 +231,7 @@ class Client extends EventEmitter {
 
   /**
    * Fetches information about the bot user
-   * @param {boolean} force - Force fetch from API instead of cache
+   * @param {boolean} [force=false] - Force fetch from API instead of cache
    * @returns {Promise<User>} Bot user object
    */
   async fetchMe(force = false) {
@@ -240,7 +255,7 @@ class Client extends EventEmitter {
   /**
    * Fetches a user by ID
    * @param {string} id - User ID
-   * @param {boolean} force - Force fetch from API instead of cache
+   * @param {boolean} [force=false] - Force fetch from API instead of cache
    * @returns {Promise<User>} User object
    */
   async fetchUser(id, force = false) {
@@ -286,7 +301,7 @@ class Client extends EventEmitter {
   /**
    * Fetches a specific channel by ID
    * @param {string} id - Channel ID
-   * @param {boolean} force - Force fetch from API instead of cache
+   * @param {boolean} [force=false] - Force fetch from API instead of cache
    * @returns {Promise<Channel>} Channel object
    */
   async fetchChannel(id, force = false) {
@@ -708,7 +723,7 @@ class Client extends EventEmitter {
   /**
    * Fetches an emoji by ID
    * @param {string} id - Emoji ID
-   * @param {boolean} force - Force fetch from API instead of cache
+   * @param {boolean} [force=false] - Force fetch from API instead of cache
    * @returns {Promise<Emoji>} Emoji object
    */
   async fetchEmoji(id, force = false) {
@@ -760,7 +775,7 @@ class Client extends EventEmitter {
   /**
    * Fetches a sticker by ID
    * @param {string} id - Sticker ID
-   * @param {boolean} force - Force fetch from API instead of cache
+   * @param {boolean} [force=false] - Force fetch from API instead of cache
    * @returns {Promise<Object>} Sticker data
    */
   async fetchSticker(id, force = false) {
@@ -968,6 +983,9 @@ class Client extends EventEmitter {
   _setupSocketHandlers() {
     this._removeSocketHandlers();
 
+    /**
+     * @event Client#messageCreate
+     */
     this.socket.on('message:new', async (data) => {
       try {
         if (this._sentMessages.has(data.id)) {
@@ -983,31 +1001,49 @@ class Client extends EventEmitter {
       }
     });
 
+    /**
+     * @event Client#messageDelete
+     */
     this.socket.on('message:deleted', (data) => {
       const { messageId } = data;
       this._markMessageDeleted(messageId);
       this.emit('messageDelete', data);
     });
 
+    /**
+     * @event Client#messageEdit
+     */
     this.socket.on('message:edited', (data) => {
       const { messageId, content, editedAt } = data;
       this._updateMessageContent(messageId, content, editedAt);
       this.emit('messageEdit', data);
     });
 
+    /**
+     * @event Client#typingStart
+     */
     this.socket.on('typing:user-start', (data) => {
       this.emit('typingStart', data);
     });
 
+    /**
+     * @event Client#typingStop
+     */
     this.socket.on('typing:user-stop', (data) => {
       this.emit('typingStop', data);
     });
 
+    /**
+     * @event Client#userStatusUpdate
+     */
     this.socket.on('user:status-update', (data) => {
       this._updateUserStatus(data);
       this.emit('userStatusUpdate', data);
     });
 
+    /**
+     * @event Client#memberJoin
+     */
     this.socket.on('member:join', async (data) => {
       const member = await this.fetchUser(data.memberId).catch(() => null);
       const channel = this.cache.channels.get(data.channelId);
@@ -1017,6 +1053,9 @@ class Client extends EventEmitter {
       this.emit('memberJoin', { channel, member });
     });
 
+    /**
+     * @event Client#memberLeave
+     */
     this.socket.on('member:leave', async (data) => {
       const channel = this.cache.channels.get(data.channelId);
       const member = this.cache.users.get(data.memberId);
@@ -1032,16 +1071,25 @@ class Client extends EventEmitter {
       this.emit('memberLeave', { channel, member });
     });
 
+    /**
+     * @event Client#channelUpdate
+     */
     this.socket.on('channel:update', (data) => {
       this._updateChannel(data);
       this.emit('channelUpdate', data);
     });
 
+    /**
+     * @event Client#channelDelete
+     */
     this.socket.on('channel:delete', (data) => {
       this.cache.channels.delete(data.channelId);
       this.emit('channelDelete', data);
     });
 
+    /**
+     * @event Client#rateLimited
+     */
     this.socket.on('rate:limited', (data) => {
       this.emit('rateLimited', data);
     });
@@ -1389,6 +1437,19 @@ class Client extends EventEmitter {
   }
 }
 
+class ClientError extends Error {
+  /**
+   * @private
+   * @param {string} message - Error message
+   * @param {string} code - Error code
+  */
+  constructor(message, code) {
+    super(message);
+    this.name = 'ClientError';
+    this.code = code;
+  }
+}
+
 Client.MessageEmbed = MessageEmbed;
-Client.ClientError = ClientError;
+// Client.ClientError = ClientError;
 module.exports = Client;

package/helpers/index.js

@@ -1,6 +1,6 @@
 function formatUrl(url) {
     const base = 'https://api.beniocord.site';
-    if (!url) return undefined;
+    if (!url) return null;
     if (url.startsWith(base) || url.startsWith('http')) return url;
     return base + (url.startsWith('/') ? url : '/' + url);
 }

package/package.json

@@ -1,13 +1,13 @@
 {
   "dependencies": {
+    "@discordjs/collection": "^2.1.1",
     "axios": "^1.12.2",
     "socket.io-client": "^4.8.1"
   },
   "name": "beniocord.js",
-  "version": "2.0.8",
+  "version": "2.1.0",
   "description": "Uma biblioteca leve e intuitiva para integração com APIs de bots em plataformas de mensagens, como Discord. Facilita o envio de mensagens, gerenciamento de canais e interação com usuários, proporcionando uma experiência de desenvolvimento ágil e eficiente.",
   "main": "Client.js",
-  "devDependencies": {},
   "scripts": {
     "test": "node bot.js"
   },

package/structures/Channel.js

@@ -1,6 +1,6 @@
 const { formatUrl } = require('../helpers');
 const MessageCollector = require('./MessageCollector');
-const Collection = require('../collection').Collection;
+const Collection = require('@discordjs/collection').Collection;
 
 let client;
 class Channel {
@@ -8,16 +8,16 @@ class Channel {
     client = clientInstance;
 
     this.id = data.id;
-    this.ownerId = data.created_by;
     this.name = data.name;
     this.description = data.description;
     this.type = data.type || "text";
+    this.iconUrl = formatUrl(data.icon_url) || null;
+    this.ownerId = data.created_by;
     this.isPrivate = data.is_private;
     this.isLocked = data.is_locked;
-    this.iconUrl = formatUrl(data.icon_url) || null;
+    this.memberCount = Number(data.member_count);
     this.createdAt = data.created_at;
     this.updatedAt = data.updated_at;
-    this.memberCount = data.member_count;
 
     this.members = new Collection();
     this.members.fetch = async () => {

package/structures/Message.js

@@ -3,7 +3,32 @@ const Channel = require("./Channel");
 const { formatUrl } = require('../helpers/index');
 
 let client;
+
+/**
+ * Represents a message in a channel.
+ */
 class Message {
+  /**
+   * Creates a new Message instance.
+   * @param {Object} data - Raw message data.
+   * @param {string|number} data.id - The unique ID of the message.
+   * @param {string} data.content - The content of the message.
+   * @param {string} [data.message_type="text"] - The type of the message (text, file, etc.).
+   * @param {string} [data.file_url] - URL of the attached file.
+   * @param {string} [data.file_name] - Name of the attached file.
+   * @param {number} [data.file_size] - Size of the attached file in bytes.
+   * @param {Object} [data.user] - Author user data.
+   * @param {Object} [data.channel] - Channel data where the message was sent.
+   * @param {string|number} [data.reply_to] - ID of the message this is replying to.
+   * @param {string|number} [data.sticker_id] - ID of a sticker attached to the message.
+   * @param {string|number|Date} [data.edited_at] - Timestamp when the message was edited.
+   * @param {string|number|Date} [data.created_at] - Timestamp when the message was created.
+   * @param {Object} clientInstance - The client instance to send/edit/delete messages.
+   * @example
+   * // Creating a message instance
+   * const msg = new Message({ id: 1, content: "Hello!" }, client);
+   * 
+   */
   constructor(data, clientInstance) {
     this.id = data.id;
     this.content = data.content;
@@ -11,12 +36,11 @@ class Message {
     this.fileUrl = formatUrl(data.file_url);
     this.fileName = data.file_name;
     this.fileSize = data.file_size;
+    this.attachments = [];
     this.replyTo = data.reply_to;
+    this.stickerId = data.sticker_id;
     this.editedAt = data.edited_at;
     this.createdAt = data.created_at;
-    this.stickerId = data.sticker_id;
-
-    this.attachments = [];
 
     if (data.file_url) {
       this.attachments.push({
@@ -26,13 +50,21 @@ class Message {
       });
     }
 
-    // this.author = data.user ? new User(data.user, this) : null;
     this.author = data.user ? new User(data.user, clientInstance) : null;
     this.channel = data.channel ? new Channel(data.channel, clientInstance) : null;
-    // this.member = { user: this.author }
     client = clientInstance;
   }
 
+  /**
+   * Replies to this message.
+   * @param {string} content - Content of the reply.
+   * @param {Object} [opts={}] - Additional options for the reply.
+   * @returns {Promise<Message>} The sent reply message.
+   *
+   * @example
+   * // Replying to a message
+   * await msg.reply("Thanks for your message!");
+   */
   async reply(content, opts = {}) {
     return client.sendMessage(this.channel.id, content, {
       replyTo: this.id,
@@ -40,10 +72,27 @@ class Message {
     });
   }
 
+  /**
+   * Edits this message.
+   * @param {string} content - New content for the message.
+   * @returns {Promise<Message>} The edited message.
+   *
+   * @example
+   * // Editing a message
+   * await msg.edit("Updated content!");
+   */
   async edit(content) {
     return client.editMessage(this.id, content);
   }
 
+  /**
+   * Deletes this message.
+   * @returns {Promise<void>}
+   *
+   * @example
+   * // Deleting a message
+   * await msg.delete();
+   */
   async delete() {
     return client.deleteMessage(this.id);
   }

package/structures/User.js

@@ -1,6 +1,21 @@
-const { formatUrl } = require("../helpers");
-
+/**
+ * Represents a user.
+ */
 class User {
+  /**
+   * Creates a new User instance.
+   * @param {Object} data - Raw user data.
+   * @param {string|number} data.id - The unique ID of the user.
+   * @param {string} data.username - The username of the user.
+   * @param {string} data.display_name - The display name of the user.
+   * @param {string} data.avatar_url - The URL of the user's avatar.
+   * @param {string} [data.status='offline'] - The user's status.
+   * @param {Array<string>} [data.emblems=[]] - Array of user emblems.
+   * @param {boolean} data.is_bot - Whether the user is a bot.
+   * @param {string|number|Date} data.last_seen - Last seen timestamp.
+   * @param {string|number|Date} data.created_at - Account creation timestamp.
+   * @param {Object} client - The client instance (optional, internal use).
+   */
   constructor(data, client) {
     this.id = data.id;
     this.username = data.username;
@@ -8,17 +23,15 @@ class User {
     this.avatarUrl = formatUrl(data.avatar_url);
     this.status = data.status || "offline";
     this.emblems = data.emblems || [];
+    this.isBot = data.is_bot;
     this.lastSeen = data.last_seen;
     this.createdAt = data.created_at;
-    this.isBot = data.is_bot;
-    // this.email = data.email;
-    // this.updatedAt = data.updated_at;
   }
 
-  // displayAvatarURL() {
-  //   return this.avatarUrl;
-  // }
-
+  /**
+   * Returns the avatar URL of the user.
+   * @returns {string} The avatar URL.
+   */
   avatarURL() {
     return this.avatarUrl;
   }