feat: Send buttons and Lists (#756)

src/structures/Buttons.js

@@ -0,0 +1,68 @@
+'use strict';
+
+const MessageMedia = require('./MessageMedia');
+const Util = require('../util/Util');
+
+/**
+ * Message type buttons
+ */
+class Buttons {
+    /**
+     * @param {string|MessageMedia} body
+     * @param {Array<Array<string>>} buttons
+     * @param {string?} title
+     * @param {string?} footer
+     */
+    constructor(body, buttons, title, footer) {
+        /**
+         * Message body
+         * @type {string|MessageMedia}
+         */
+        this.body = body;
+
+        /**
+         * title of message
+         * @type {string}
+         */
+        this.title = title;
+        
+        /**
+         * footer of message
+         * @type {string}
+         */
+        this.footer = footer;
+
+        if (body instanceof MessageMedia) {
+            this.type = 'media';
+            this.title = '';
+        }else{
+            this.type = 'chat';
+        }
+
+        /**
+         * buttons of message
+         * @type {Array<Array<string>>}
+         */
+        this.buttons = this._format(buttons);
+        if(!this.buttons.length){ throw '[BT01] No buttons';}
+                
+    }
+
+    /**
+     * Creates button array from simple array
+     * @param {Array<Array<string>>} buttons
+     * @returns {Array<Array<string>>}
+     * @example 
+     * Input: [{id:'customId',body:'button1'},{body:'button2'},{body:'button3'},{body:'button4'}]
+     * Returns: [{ buttonId:'customId',buttonText:{'displayText':'button1'},type: 1 },{buttonId:'n3XKsL',buttonText:{'displayText':'button2'},type:1},{buttonId:'NDJk0a',buttonText:{'displayText':'button3'},type:1}]
+     */
+    _format(buttons){
+        buttons = buttons.slice(0,3); // phone users can only see 3 buttons, so lets limit this
+        return buttons.map((btn) => {
+            return {'buttonId':btn.id ? btn.id : Util.generateHash(6),'buttonText':{'displayText':btn.body},'type':1};
+        });
+    }
+    
+}
+
+module.exports = Buttons;

src/structures/List.js

@@ -0,0 +1,79 @@
+'use strict';
+
+const Util = require('../util/Util');
+
+/**
+ * Message type List
+ */
+class List {
+    /**
+     * @param {string} body
+     * @param {string} buttonText
+     * @param {Array<any>} sections
+     * @param {string?} title
+     * @param {string?} footer
+     */
+    constructor(body, buttonText, sections, title, footer) {
+        /**
+         * Message body
+         * @type {string}
+         */
+        this.description = body;
+
+        /**
+         * List button text
+         * @type {string}
+         */
+        this.buttonText = buttonText;
+        
+        /**
+         * title of message
+         * @type {string}
+         */
+        this.title = title;
+        
+
+        /**
+         * footer of message
+         * @type {string}
+         */
+        this.footer = footer;
+
+        /**
+         * sections of message
+         * @type {Array<any>}
+         */
+        this.sections = this._format(sections);
+        
+    }
+    
+    /**
+     * Creates section array from simple array
+     * @param {Array<any>} sections
+     * @returns {Array<any>}
+     * @example
+     * Input: [{title:'sectionTitle',rows:[{id:'customId', title:'ListItem2', description: 'desc'},{title:'ListItem2'}]}}]
+     * Returns: [{'title':'sectionTitle','rows':[{'rowId':'customId','title':'ListItem1','description':'desc'},{'rowId':'oGSRoD','title':'ListItem2','description':''}]}]
+     */
+    _format(sections){
+        if(!sections.length){throw '[LT02] List without sections';}
+        if(sections.length > 1){throw '[LT05] Lists with more than one section are having problems';}
+        return sections.map( (section) =>{
+            if(!section.rows.length){throw '[LT03] Section without rows';}
+            return {
+                title: section.title ? section.title : undefined,
+                rows: section.rows.map( (row) => {
+                    if(!row.title){throw '[LT04] Row without title';}
+                    return {
+                        rowId: row.id ? row.id : Util.generateHash(6),
+                        title: row.title,
+                        description: row.description ? row.description : ''
+                    };
+                })
+            };
+        });
+    }
+    
+}
+
+module.exports = List;

src/structures/Message.js

@@ -206,6 +206,21 @@ class Message extends Base {
          */
         this.links = data.links;
 
+        /** Buttons */
+        if (data.dynamicReplyButtons) {
+            this.dynamicReplyButtons = data.dynamicReplyButtons;
+        }
+        
+        /** Selected Button Id **/
+        if (data.selectedButtonId) {
+            this.selectedButtonId = data.selectedButtonId;
+        }
+
+        /** Selected List row Id **/
+        if (data.listResponse && data.listResponse.singleSelectReply.selectedRowId) {
+            this.selectedRowId = data.listResponse.singleSelectReply.selectedRowId;
+        }
+        
         return super._patch(data);
     }
 

src/structures/index.js

@@ -15,5 +15,7 @@ module.exports = {
     Order: require('./Order'),
     Product: require('./Product'),
     Call: require('./Call'),
+    Buttons: require('./Buttons'),
+    List: require('./List'),
     Payment: require('./Payment')
-};
+};