chore: add missing types in JSDoc/TSDoc (ClientOptions, ClientInfo, MessageSendOptions, Session) (#286)

* chore: add ClientOptions and ClientInfo in JSDoc

* chore: add MessageSendOptions type

* chore: add ClientSession type in JSDoc

* chore: remove @todo from createGroup (was already solved)

Co-authored-by: Pedro Lopez <pedroslopez@me.com>

src/structures/Chat.js

@@ -63,7 +63,7 @@ class Chat extends Base {
     /**
      * Send a message to this chat
      * @param {string|MessageMedia|Location} content
-     * @param {object} options 
+     * @param {MessageSendOptions} [options] 
      * @returns {Promise<Message>} Message that was just sent
      */
     async sendMessage(content, options) {
@@ -119,7 +119,7 @@ class Chat extends Base {
     async mute(unmuteDate) {
         return this.client.muteChat(this.id._serialized, unmuteDate);
     }
-    
+
     /**
      * Unmutes this chat
      */
@@ -134,18 +134,18 @@ class Chat extends Base {
      * @returns {Promise<Array<Message>>}
      */
     async fetchMessages(searchOptions) {
-        if(!searchOptions || !searchOptions.limit) {
-            searchOptions = {limit: 50};
+        if (!searchOptions || !searchOptions.limit) {
+            searchOptions = { limit: 50 };
         }
         let messages = await this.client.pupPage.evaluate(async (chatId, limit) => {
             const msgFilter = m => !m.isNotification; // dont include notification messages
-            
+
             const chat = window.Store.Chat.get(chatId);
             let msgs = chat.msgs.models.filter(msgFilter);
-            
-            while(msgs.length < limit) {
+
+            while (msgs.length < limit) {
                 const loadedMessages = await chat.loadEarlierMsgs();
-                if(!loadedMessages) break;
+                if (!loadedMessages) break;
                 msgs = [...loadedMessages.filter(msgFilter), ...msgs];
             }
 
@@ -156,7 +156,7 @@ class Chat extends Base {
 
         return messages.map(m => new Message(this.client, m));
     }
-   
+
     /**
      * Simulate typing in chat. This will last for 25 seconds.
      */
@@ -166,7 +166,7 @@ class Chat extends Base {
             return true;
         }, this.id._serialized);
     }
-    
+
     /**
      * Simulate recording audio in chat. This will last for 25 seconds.
      */
@@ -176,7 +176,7 @@ class Chat extends Base {
             return true;
         }, this.id._serialized);
     }
-    
+
     /**
      * Stops typing or recording in chat immediately.
      */

src/structures/Message.js

@@ -13,7 +13,7 @@ class Message extends Base {
     constructor(client, data) {
         super(client);
 
-        if(data) this._patch(data);
+        if (data) this._patch(data);
     }
 
     _patch(data) {
@@ -98,7 +98,7 @@ class Message extends Base {
          * @type {boolean}
          */
         this.fromMe = data.id.fromMe;
-        
+
         /**
          * Indicates if the message was sent as a reply to another message.
          * @type {boolean}
@@ -173,11 +173,11 @@ class Message extends Base {
      * in the same Chat as the original message was sent.
      * 
      * @param {string|MessageMedia|Location} content 
-     * @param {?string} chatId 
-     * @param {object} options
+     * @param {string} [chatId] 
+     * @param {MessageSendOptions} [options]
      * @returns {Promise<Message>}
      */
-    async reply(content, chatId, options={}) {
+    async reply(content, chatId, options = {}) {
         if (!chatId) {
             chatId = this._getChatId();
         }
@@ -201,13 +201,13 @@ class Message extends Base {
 
         const result = await this.client.pupPage.evaluate(async (msgId) => {
             const msg = window.Store.Msg.get(msgId);
-            
-            if(msg.mediaData.mediaStage != 'RESOLVED') {
+
+            if (msg.mediaData.mediaStage != 'RESOLVED') {
                 // try to resolve media
                 await msg.downloadMedia(true, 1);
             }
-            
-            if(msg.mediaData.mediaStage.includes('ERROR')) {
+
+            if (msg.mediaData.mediaStage.includes('ERROR')) {
                 // media could not be downloaded
                 return undefined;
             }
@@ -215,7 +215,7 @@ class Message extends Base {
             const buffer = await window.WWebJS.downloadBuffer(msg.clientUrl);
             const decrypted = await window.Store.CryptoLib.decryptE2EMedia(msg.type, buffer, msg.mediaKey, msg.mimetype);
             const data = await window.WWebJS.readBlobAsync(decrypted._blob);
-            
+
             return {
                 data: data.split(',')[1],
                 mimetype: msg.mimetype,
@@ -224,7 +224,7 @@ class Message extends Base {
 
         }, this.id._serialized);
 
-        if(!result) return undefined;
+        if (!result) return undefined;
         return new MessageMedia(result.mimetype, result.data, result.filename);
     }
 
@@ -236,10 +236,10 @@ class Message extends Base {
         await this.client.pupPage.evaluate((msgId, everyone) => {
             let msg = window.Store.Msg.get(msgId);
 
-            if(everyone && msg.id.fromMe && msg.canRevoke()) {
+            if (everyone && msg.id.fromMe && msg.canRevoke()) {
                 return window.Store.Cmd.sendRevokeMsgs(msg.chat, [msg], true);
-            } 
-            
+            }
+
             return window.Store.Cmd.sendDeleteMsgs(msg.chat, [msg], true);
         }, this.id._serialized, everyone);
     }