[DOCS] improving some files documentation

[DOCS] improving some files documentation

Author: carlos3g

src/Alice.js

@@ -1,10 +1,13 @@
 const { Session } = require('./auth');
-const { Parse } = require('./utils');
 const { Commands } = require('./build');
+const { Parse } = require('./utils');
 
 const session = new Session();
 const commands = new Commands();
 
+/**
+ * @param {object[]} commandsArray
+ */
 class Alice {
   constructor(commandsArray) {
     this.events = [
@@ -24,12 +27,6 @@ class Alice {
   }
 
   init() {
-    if (session.exists) {
-      session.load();
-    } else {
-      session.create();
-    }
-
     this.events.forEach((e) => {
       session.on(e.name, e.callback);
     });
@@ -49,6 +46,7 @@ class Alice {
 
   static async onJoinedGroup(notification) {
     const contacts = await notification.getRecipients();
+
     contacts.forEach(async (c) => {
       const chat = await c.getChat();
       await chat.sendMessage(

src/auth/index.js

@@ -1,15 +1,12 @@
-const { Client } = require('whatsapp-web.js');
-const qrcode = require('qrcode-terminal');
 const fs = require('fs');
 const path = require('path');
-
-const FILE_NAME = 'session.json';
+const qrcode = require('qrcode-terminal');
+const { Client } = require('whatsapp-web.js');
 
 /**
  * Starting point for interacting with the WhatsApp Web API.
- * @param {string} SESSION_FILE_PATH - Path to `session.json` file.
- * @see https://docs.wwebjs.dev/Client.html
  * @extends {Client}
+ * @see https://docs.wwebjs.dev/Client.html
  */
 class Session extends Client {
   constructor() {
@@ -19,19 +16,20 @@ class Session extends Client {
       },
     });
 
-    this.SESSION_FILE_PATH = path.join(__dirname, FILE_NAME);
+    this.SESSION_FILE_PATH = path.join(__dirname, 'session.json');
   }
 
   /**
-   * Checks if the `session.json` file already exists.
-   * @returns {boolean} - `True` if exists, `False` if not.
+   * Checks if the `session.json` file exists.
+   * @returns {boolean} - `true` if exists, `false` if not.
    */
   get exists() {
     return fs.existsSync(this.SESSION_FILE_PATH);
   }
 
   /**
    * Throws the QR-Code to authenticate the session. When the QR-Code is read, the session file is written.
+   * @private
    */
   create() {
     this.on('qr', (qr) => {
@@ -42,15 +40,16 @@ class Session extends Client {
 
   /**
    * Writes the session in a .json file (`this.SESSION_FILE_PATH`)
-   * @param {object} session - The session file returned in the authentication.
+   * @private
+   * @param {object} session - The session object.
    */
   save(session) {
     fs.writeFileSync(this.SESSION_FILE_PATH, JSON.stringify(session));
-    console.log('⚠ The current session has been saved ⚠');
   }
 
   /**
    * Loads the saved session file.
+   * @private
    */
   load() {
     if (!this.exists) {
@@ -60,18 +59,21 @@ class Session extends Client {
     const raw = fs.readFileSync(this.SESSION_FILE_PATH);
     const data = JSON.parse(raw);
     this.options.session = data;
-
-    console.log('⚠ The previous session was loaded ⚠');
   }
 
   /**
-   * Starts the session.
+   * Starts the session (Creates it if doesn't exists).
    */
   start() {
+    if (this.exists) {
+      this.load();
+    } else {
+      this.create();
+    }
+
     this.on('ready', () => {
       console.log('Client is ready!');
     });
-
     this.initialize();
   }
 }

src/build/Commands.js

@@ -1,17 +1,14 @@
 /**
- * Commands wrapper
- * @param {object} commands - Object that contains the commands.
- * @param {object} commands.* - A command. The key and value must be, respectively, the command name and a callback function for the command.
+ * Commands wrapper.
  */
 class Commands {
   constructor() {
     this.commands = {};
   }
 
   /**
-   * Sets a command in Commands instance.
-   * @param {string} name - Command's name.
-   * @param {function} callback - Callback to command.
+   * Sets an command in Commands instance.
+   * @param {object} cmd - A command.
    */
   register(cmd) {
     if (!Commands.isValid(cmd)) {
@@ -22,19 +19,19 @@ class Commands {
   }
 
   /**
-   * Checks if a command is set in Commands instance.
+   * Checks if an command is set in Commands instance.
    * @param {string} cmdName - The command's name.
-   * @returns {boolean} `True` if the command is set in Commands instance, `False` if not.
+   * @returns {boolean} `true` if the command is set in Commands instance, `false` if not.
    */
   has(cmdName) {
     const availableCommands = Object.keys(this.commands);
     return availableCommands.includes(cmdName);
   }
 
   /**
-   * Checks if a command is valid.
+   * Checks if an command is valid.
    * @param {any} cmd - The command instance.
-   * @returns {boolean} `True` if the command is valid, `False` if not.
+   * @returns {boolean} `true` if the command is valid, `false` if not.
    */
   static isValid(cmd) {
     if (cmd.name && cmd.execute && typeof cmd.execute === 'function') {
@@ -45,15 +42,15 @@ class Commands {
 
   /**
    * Calls (executes) a command.
+   * @see https://docs.wwebjs.dev/Message.html
+   * @see https://docs.wwebjs.dev/Client.html
    * @param {object} data - The data extracted from the message that called the command.
-   * @param {string} data.command - The command's name extracted from the message.
-   * @param {string[]} data.args - The args extracted from the message.
-   * @param {object} data.kwargs - The kwargs extracted from the message.
-   * @param {string} data.text - The text extracted from the message. This text NOT includes command's name, args and kwargs.
+   * @param {string} data.command - The command's name.
+   * @param {string[]} data.args - The command's args.
+   * @param {object} data.kwargs - The command's kwargs.
+   * @param {string} data.text - The text. This text NOT includes command's name, args and kwargs.
    * @param {Message} message - The message that called the command.
    * @param {Session} client - The whatsapp web session.
-   * @see https://docs.wwebjs.dev/Message.html
-   * @see https://docs.wwebjs.dev/Client.html
    */
   async call(data, message, client) {
     if (!this.has(data.command)) {

src/commands/cron.js

@@ -48,9 +48,9 @@ class Cron {
   }
 
   async execute(data, message) {
-    const isAdm = await chattools.isAdm(message);
+    const isFromAdm = await chattools.isFromAdm(message);
 
-    if (!isAdm) {
+    if (!isFromAdm) {
       message.reply('staff only.');
       return;
     }

src/commands/everyone.js

@@ -20,9 +20,9 @@ class Everyone {
 
   async execute(data, message) {
     const { args } = data;
-    const isAdm = await chattools.isAdm(message);
+    const isFromAdm = await chattools.isFromAdm(message);
 
-    if (!isAdm) {
+    if (!isFromAdm) {
       message.reply('staff only.');
       return;
     }

src/utils/Command.js

@@ -21,7 +21,7 @@ class Command {
   }
 
   /**
-   * For a given object of information about a command, returns a help message.
+   * For a given object of information about an command, returns a help message.
    * @param {object} commandInfo - Information about the command.
    * @param {string} commandInfo.description - The command's description.
    * @param {string} commandInfo.usage - The command's usage.

src/utils/Parse.js

@@ -15,7 +15,7 @@ class Parse {
     this.rawText = text.trim();
 
     /**
-     * A collection of regular expressions used in the extraction of data from the `this.rawText`.
+     * A collection of regular expressions used in the extraction of data.
      * @property {string} REGEXP.command - Regular expression for commands. Ex: !command
      * @property {string[]} REGEXP.args - Regular expression for args. Ex: --arg1
      * @property {object} REGEXP.kwargs - Regular expression for kwargs. Ex: --kwarg=1
@@ -28,7 +28,7 @@ class Parse {
   }
 
   /**
-   * Gets the command extracted from the `this.rawText`.
+   * Gets the command extracted.
    * @returns {string}
    */
   get command() {
@@ -37,7 +37,7 @@ class Parse {
   }
 
   /**
-   * Gets the args extracted from `this.rawText`.
+   * Gets the args extracted.
    * @returns {string[]}
    */
   get args() {
@@ -48,7 +48,7 @@ class Parse {
   }
 
   /**
-   * Gets the kwargs extracted from `this.rawText`.
+   * Gets the kwargs extracted.
    * @returns {object}
    */
   get kwargs() {
@@ -64,7 +64,7 @@ class Parse {
   }
 
   /**
-   * Gets the text extracted from `this.rawText`.
+   * Gets the text extracted.
    * @returns {string}
    */
   get text() {

src/utils/chattools.js

@@ -1,55 +1,55 @@
 /**
  * Get serialized phone number from a given array of users.
- * @param {Contact[]} users - Whatsapp users.
  * @see https://docs.wwebjs.dev/Contact.html
+ * @param {Contact[]} users - Whatsapp users.
  * @returns {string[]} - Serialized phone numbers.
  */
-function getSerialList(users) {
+function getSerials(users) {
   // eslint-disable-next-line no-underscore-dangle
-  const serialList = users.map((u) => u.id._serialized);
-  return serialList;
+  const serials = users.map((u) => u.id._serialized);
+  return serials;
 }
 
 /**
  * Get serialized phone number of all members from a given group.
- * @param {Chat} chat - A whatsapp chat.
  * @see https://docs.wwebjs.dev/Chat.html
+ * @param {Chat} chat - A whatsapp chat.
  * @returns {string[]} - Serialized phone numbers of all members.
  */
-async function getMembersList(chat) {
+async function getMembers(chat) {
   const members = await chat.participants;
-  const membersSerialList = getSerialList(members);
-  return membersSerialList;
+  const membersSerials = getSerials(members);
+  return membersSerials;
 }
 
 /**
  * Get serialized phone number of all administrators from a given group.
- * @param {Chat} chat - A whatsapp chat.
  * @see https://docs.wwebjs.dev/Chat.html
+ * @param {Chat} chat - A whatsapp chat.
  * @returns {string[]} - Serialized phone numbers of all administrators.
  */
-async function getAdmsList(chat) {
+function getAdms(chat) {
   if (!chat.isGroup) {
     throw new Error(`This chat isn't a group.`);
   }
 
-  const members = await chat.participants;
-  const admsIdList = members.filter((id) => id.isAdmin);
-  const admsSerialList = getSerialList(admsIdList);
-  return admsSerialList;
+  const { participants } = chat;
+  const admsIds = participants.filter((id) => id.isAdmin);
+  const admsSerials = getSerials(admsIds);
+  return admsSerials;
 }
 
 /**
- * Checks if a message is from an ADM.
- * @param {Message} message - Message to check if is from an ADM.
+ * Checks if an message is from an ADM.
  * @see https://docs.wwebjs.dev/Message.html
+ * @param {Message} message - Message to check if is from an ADM.
  * @returns {boolean}
  */
-async function isAdm(message) {
+async function isFromAdm(message) {
   const chat = await message.getChat();
-  const admList = await getAdmsList(chat);
+  const adms = getAdms(chat);
   const { author } = message;
-  return admList.includes(author);
+  return adms.includes(author);
 }
 
 /**
@@ -70,9 +70,9 @@ function userID(phoneNumber) {
 }
 
 module.exports = {
-  getAdmsList,
-  getMembersList,
-  getSerialList,
-  isAdm,
+  getAdms,
+  getMembers,
+  getSerials,
+  isFromAdm,
   userID,
 };