beniocord.js 2.0.9 → 2.1.1

package/structures/Channel.js

@@ -3,7 +3,45 @@ const MessageCollector = require('./MessageCollector');
 const Collection = require('@discordjs/collection').Collection;
 
 let client;
+
+/**
+ * @internal
+ */
 class Channel {
+  /**
+   * Creates a new Channel instance.
+   * @param {Object} data - Raw channel data.
+   * @param {string|number} data.id - The unique ID of the channel.
+   * @param {string} data.name - The name of the channel.
+   * @param {string} [data.description] - The channel description.
+   * @param {string} [data.type="text"] - The type of the channel (text, voice, etc.).
+   * @param {string} [data.icon_url] - The URL of the channel icon.
+   * @param {string|number} data.created_by - ID of the channel owner.
+   * @param {boolean} [data.is_private=false] - Whether the channel is private.
+   * @param {boolean} [data.is_locked=false] - Whether the channel is locked.
+   * @param {number|string} [data.member_count=0] - Number of members in the channel.
+   * @param {string|Date} data.created_at - Creation timestamp.
+   * @param {string|Date} data.updated_at - Last update timestamp.
+   * @param {import('./Client')} clientInstance - The client instance.
+   * @returns {Channel} The created Channel instance.
+   * @example
+   * // msg.channel
+   * Channel {
+   *   id: 2,
+   *   name: 'Privado',
+   *   description: 'DM Privada para conversar secretas!\n',
+   *   type: 'text',
+   *   iconUrl: 'https://api.beniocord.site/uploads/1762899895145-938680330.gif',
+   *   ownerId: 1,
+   *   isPrivate: true,
+   *   isLocked: false,
+   *   memberCount: 8,
+   *   createdAt: '2025-09-21T15:28:43.610Z',
+   *   updatedAt: '2025-11-11T23:49:54.906Z',
+   *   members: Collection(0) [Map] { fetch: [AsyncFunction (anonymous)] },
+   *   messages: Collection(0) [Map] { fetch: [AsyncFunction (anonymous)] }
+   * }
+   */
   constructor(data, clientInstance) {
     client = clientInstance;
 
@@ -19,6 +57,10 @@ class Channel {
     this.createdAt = data.created_at;
     this.updatedAt = data.updated_at;
 
+    /**
+     * Cached members of the channel.
+     * @type {Collection<string, import('./User')>}
+     */
     this.members = new Collection();
     this.members.fetch = async () => {
       const members = await client.fetchChannelMembers(this.id);
@@ -29,6 +71,10 @@ class Channel {
       return this.members;
     };
 
+    /**
+     * Cached messages of the channel.
+     * @type {Collection<string, import('./Message')>}
+     */
     this.messages = new Collection();
     this.messages.fetch = async (id) => {
       if (client.fetchMessage) {
@@ -46,22 +92,40 @@ class Channel {
     });
   }
 
+  /**
+   * Sends a message to the channel.
+   * @param {string|Object} content - The content of the message.
+   * @param {Object} [opts] - Optional message options.
+   * @returns {Promise<import('./Message')>} The sent message.
+   */
   async send(content, opts = {}) {
     return client.sendMessage(this.id, content, opts);
   }
 
+  /**
+   * Starts typing indicator in the channel.
+   * @returns {Promise<void>}
+   */
   startTyping() {
     return client.startTyping(this.id);
   }
 
+  /**
+   * Stops typing indicator in the channel.
+   * @returns {Promise<void>}
+   */
   stopTyping() {
     return client.stopTyping(this.id);
   }
 
+  /**
+   * Creates a new message collector in this channel.
+   * @param {Object} [options={}] - Collector options.
+   * @returns {MessageCollector} The created message collector.
+   */
   createMessageCollector(options = {}) {
     return new MessageCollector(this, options, client);
   }
-
 }
 
 module.exports = Channel;

package/structures/Emoji.js

@@ -1,14 +1,59 @@
 const { formatUrl } = require("../helpers");
 
+/**
+ * @internal
+ */
 class Emoji {
+    /**
+     * Creates a new Emoji instance.
+     * @param {Object} data - Raw emoji data.
+     * @param {string|number} data.id - The unique ID of the emoji.
+     * @param {string|number} data.user_id - The ID of the user who uploaded the emoji.
+     * @param {string} data.name - The name of the emoji.
+     * @param {string} data.url - The URL of the emoji image.
+     * @param {string|number|Date} data.created_at - Timestamp when the emoji was created.
+     * @returns {Emoji} The created Emoji instance.
+     * @example 
+     * Emoji {
+     *   id: 1,
+     *   userId: 1,
+     *   name: 'shitcord',
+     *   url: 'https://api.beniocord.site/uploads/emojis/1758982533925-364594757.png',
+     *   createdAt: '2025-09-27T14:15:33.932Z'
+     * }
+     * 
+     */
     constructor(data) {
+        /**
+         * The unique ID of the emoji.
+         * @type {string|number}
+         */
         this.id = data.id;
+
+        /**
+         * The ID of the user who uploaded the emoji.
+         * @type {string|number}
+         */
         this.userId = data.user_id;
+
+        /**
+         * The name of the emoji.
+         * @type {string}
+         */
         this.name = data.name;
+
+        /**
+         * The URL of the emoji image.
+         * @type {string}
+         */
         this.url = formatUrl(data.url);
+
+        /**
+         * Timestamp when the emoji was created.
+         * @type {string|number|Date}
+         */
         this.createdAt = data.created_at;
-        this.updatedAt = data.updated_at;
     }
 }
 
-module.exports = Emoji;
+module.exports = Emoji;

package/structures/Message.js

@@ -3,7 +3,69 @@ const Channel = require("./Channel");
 const { formatUrl } = require('../helpers/index');
 
 let client;
+
+/**
+ * @internal
+ */
 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.
+   * @returns {Message} The created Message instance.
+   * @example
+   * Message {
+   *   id: 20711,
+   *   content: 'Hello World!',
+   *   messageType: 'text',
+   *   fileUrl: null,
+   *   fileName: null,
+   *   fileSize: null,
+   *   attachments: [],
+   *   replyTo: 20709,
+   *   stickerId: null,
+   *   editedAt: null,
+   *   createdAt: '2025-11-16T14:29:40.598Z',
+   *   author: User {
+   *     id: 1,
+   *     username: 'junior9244',
+   *     displayName: 'Junior',
+   *     avatarUrl: 'https://api.beniocord.site/uploads/avatars/1760736025811-629632107.png',
+   *     status: 'online',
+   *     emblems: [],
+   *     isBot: false,
+   *     lastSeen: '2025-11-16T14:29:40.598Z',
+   *     createdAt: '2025-11-16T14:29:40.598Z'
+   *   },
+   *   channel: Channel {
+   *     id: 2,
+   *     name: 'Privado',
+   *     description: 'DM Privada para conversar secretas!\n',
+   *     type: 'text',
+   *     iconUrl: 'https://api.beniocord.site/uploads/1762899895145-938680330.gif',
+   *     ownerId: 1,
+   *     isPrivate: true,
+   *     isLocked: false,
+   *     memberCount: 8,
+   *     createdAt: '2025-09-21T15:28:43.610Z',
+   *     updatedAt: '2025-11-11T23:49:54.906Z',
+   *     members: Collection(0) [Map] { fetch: [AsyncFunction (anonymous)] },
+   *     messages: Collection(0) [Map] { fetch: [AsyncFunction (anonymous)] }
+   *   }
+   * }
+   */
   constructor(data, clientInstance) {
     this.id = data.id;
     this.content = data.content;
@@ -25,13 +87,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,
@@ -39,10 +109,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/MessageCollector.js

@@ -1,45 +1,68 @@
 const EventEmitter = require('events');
 
 class MessageCollector extends EventEmitter {
+  /**
+   * Creates a new MessageCollector.
+   *
+   * @param {Channel} channel - The channel to listen for messages.
+   * @param {Object} [options={}] - Options for the collector.
+   * @param {function(Message): boolean|Promise<boolean>} [options.filter] - Filter function to determine which messages are collected.
+   * @param {number} [options.time=60000] - Time in milliseconds before the collector stops automatically.
+   * @param {number} [options.max=Infinity] - Maximum number of messages to collect before stopping.
+   * @param {Client} client - The client instance to listen for events.
+   *
+   * @example
+   * const collector = new MessageCollector(channel, { filter: msg => msg.content.includes('hello'), time: 30000 }, client);
+   * collector.on('collect', msg => console.log(`Collected message: ${msg.content}`));
+   * collector.on('end', (collected, reason) => console.log(`Collector ended: ${reason}, collected ${collected.length} messages`));
+   */
   constructor(channel, options = {}, client) {
     super();
-    
+
     this.channel = channel;
     this.client = client;
-    // this.client = channel.client;
     this.filter = options.filter || (() => true);
     this.time = options.time || 60000;
     this.max = options.max || Infinity;
     this.collected = [];
     this.ended = false;
-    
+
     this._timeout = null;
     this._handleMessage = this._handleMessage.bind(this);
-    
+
     this._setup();
   }
-  
+
+  /**
+   * Initializes event listeners and timeout for automatic stop.
+   * @private
+   */
   _setup() {
     this.client.on('messageCreate', this._handleMessage);
-    
+
     if (this.time) {
       this._timeout = setTimeout(() => {
         this.stop('time');
       }, this.time);
     }
   }
-  
+
+  /**
+   * Internal handler for incoming messages.
+   * @param {Message} message - The message received.
+   * @private
+   */
   async _handleMessage(message) {
     if (this.ended) return;
     if (message.channel.id !== this.channel.id) return;
-    
+
     try {
       const filterResult = await this.filter(message);
       if (!filterResult) return;
-      
+
       this.collected.push(message);
       this.emit('collect', message);
-      
+
       if (this.collected.length >= this.max) {
         this.stop('limit');
       }
@@ -47,28 +70,40 @@ class MessageCollector extends EventEmitter {
       this.emit('error', error);
     }
   }
-  
-  stop(reason = 'user', ) {
+
+  /**
+   * Stops the collector manually or automatically.
+   *
+   * @param {string} [reason='user'] - Reason for stopping ('user', 'time', 'limit', etc.).
+   * @fires MessageCollector#end
+   */
+  stop(reason = 'user') {
     if (this.ended) return;
-    
+
     this.ended = true;
-    
+
     if (this._timeout) {
       clearTimeout(this._timeout);
       this._timeout = null;
     }
-    
+
     this.client.removeListener('messageCreate', this._handleMessage);
     this.emit('end', this.collected, reason);
   }
-  
+
+  /**
+   * Resets the timer for the collector.
+   *
+   * @param {Object} [options={}] - Options to override current timer.
+   * @param {number} [options.time] - New time in milliseconds to set.
+   */
   resetTimer(options = {}) {
     if (this._timeout) {
       clearTimeout(this._timeout);
     }
-    
+
     const time = options.time || this.time;
-    
+
     if (time) {
       this._timeout = setTimeout(() => {
         this.stop('time');
@@ -77,4 +112,23 @@ class MessageCollector extends EventEmitter {
   }
 }
 
-module.exports = MessageCollector;
+/**
+ * Emitted when a message is successfully collected.
+ * @event MessageCollector#collect
+ * @param {Message} message - The collected message.
+ */
+
+/**
+ * Emitted when the collector ends.
+ * @event MessageCollector#end
+ * @param {Message[]} collected - Array of collected messages.
+ * @param {string} reason - Reason the collector ended.
+ */
+
+/**
+ * Emitted when an error occurs inside the collector.
+ * @event MessageCollector#error
+ * @param {Error} error - The error encountered.
+ */
+
+module.exports = MessageCollector;

package/structures/User.js

@@ -1,7 +1,40 @@
 const { formatUrl } = require("../helpers");
+let client;
 
+/**
+ * @internal
+ */
 class User {
-  constructor(data, client) {
+  /**
+   * 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<Object>} [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 {import('./Client')} clientInstance - The client instance.
+   * @returns {User} The created User instance.
+   * @example
+   * User {
+   *   id: 1,
+   *   username: 'junior9244',
+   *   displayName: 'Junior',
+   *   avatarUrl: 'https://api.beniocord.site/uploads/avatars/1760736025811-629632107.png',
+   *   status: 'online',
+   *   emblems: [ [Object], [Object] ],
+   *   isBot: false,
+   *   lastSeen: '2025-11-16T14:44:19.394Z',
+   *   createdAt: '2025-09-21T15:00:07.753Z'
+   * }
+   */
+  constructor(data, clientInstance) {
+    client = clientInstance;
+
     this.id = data.id;
     this.username = data.username;
     this.displayName = data.display_name;
@@ -11,17 +44,31 @@ class User {
     this.isBot = data.is_bot;
     this.lastSeen = data.last_seen;
     this.createdAt = data.created_at;
-    // 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.
+   * @example
+   * https://api.beniocord.site/uploads/avatars/1760736025811-629632107.png
+   */
   avatarURL() {
     return this.avatarUrl;
   }
+
+  /**
+   * Fetches or refreshes this user from the API.
+   * @param {boolean} [force=false] - Whether to force fetch even if cached.
+   * @returns {Promise<User>} The updated User instance.
+   * @example
+   * const freshUser = await user.fetch();
+   */
+  async fetch(force = false) {
+    if (!client) throw new Error("Client instance not available.");
+    const updatedUser = await client.fetchUser(this.id, force);
+    Object.assign(this, updatedUser);
+    return this;
+  }
 }
 
-module.exports = User;
+module.exports = User;