@tiledesk/tiledesk-tybot-connector 0.2.25 → 0.2.27

package/CHANGELOG.md

@@ -5,6 +5,13 @@
 available on:
  ▶️ https://www.npmjs.com/package/@tiledesk/tiledesk-tybot-connector
 
+### v0.2.27
+- Added support for removing empty text from replies: TiledeskChatbotUtil.removeEmptyReplyCommands()
+- Removed non-user-defined attributes from /ext/parameters method
+
+### v0.2.26
+- Updated Qapla Action (tracking number from filler)
+
 ### v0.2.25
 - added support for native connect to block
 - added TiledeskChatbotUtil.addConnectAction()

package/index.js

@@ -221,6 +221,11 @@ router.post('/ext/:botid', async (req, res) => {
   
 });
 
+router.post('/hooks/:hookid', async (req, res) => {
+  // chatbot_id + intend_id
+
+});
+
 router.post('/ext/:projectId/requests/:requestId/messages', async (req, res) => {
   res.json({success:true});
   const projectId = req.params.projectId;
@@ -359,7 +364,18 @@ router.get('/ext/parameters/requests/:requestid', async (req, res) => {
       TiledeskChatbotConst.REQ_REQUEST_ID_KEY,
       TiledeskChatbotConst.REQ_USER_AGENT_KEY,
       TiledeskChatbotConst.REQ_USER_LANGUAGE_KEY,
-      TiledeskChatbotConst.REQ_USER_SOURCE_PAGE_KEY
+      TiledeskChatbotConst.REQ_USER_SOURCE_PAGE_KEY,
+      TiledeskChatbotConst.REQ_LAST_USER_MESSAGE_TYPE_KEY,
+      TiledeskChatbotConst.REQ_TRANSCRIPT_KEY,
+      TiledeskChatbotConst.REQ_LAST_USER_MESSAGE_KEY,
+      "lastUserImageURL", // image
+      "lastUserImageName", // image
+      "lastUserImageWidth", // image
+      "lastUserImageHeight", // image
+      "lastUserImageType", // image
+      "lastUserDocumentURL", // file
+      "lastUserDocumentName", // file
+      "lastUserDocumentType" // file
     ]
     let userParams = {};
     if (parameters) {

package/models/TiledeskChatbotConst.js

@@ -5,6 +5,7 @@ class TiledeskChatbotConst {
     static REQ_REQUEST_ID_KEY = "conversation_id";
     static REQ_CHATBOT_NAME_KEY = "chatbot_name";
     static REQ_LAST_USER_TEXT_KEY = "last_user_text";
+    static REQ_LAST_USER_TEXT_v2_KEY = "lastUserText";
     static REQ_LAST_MESSAGE_ID_KEY = "last_message_id";
     static REQ_COUNTRY_KEY = "user_country";
     static REQ_CITY_KEY = "user_city";
@@ -15,6 +16,10 @@ class TiledeskChatbotConst {
     static REQ_END_USER_ID_KEY = "user_id";
     static REQ_END_USER_IP_ADDRESS_KEY = "user_ip_address";
     static REQ_CHAT_URL = "chat_url";
+    static REQ_LAST_USER_MESSAGE_TYPE_KEY = "lastUserMessageType";
+    static REQ_TRANSCRIPT_KEY = "transcript";
+    static REQ_LAST_USER_MESSAGE_KEY = "lastUserMessage";
+    static REQ_CHAT_CHANNEL = "chatChannel";
 
     // static REQ_DEPARTMENT_ID_KEY = "tdDepartmentId";
     // static REQ_PROJECT_ID_KEY = "projectId";

package/models/TiledeskChatbotUtil.js

@@ -237,6 +237,57 @@ class TiledeskChatbotUtil {
         }
     }
 
+    static removeEmptyReplyCommands(message) {
+        try {
+            if (message && message.attributes && message.attributes.commands && message.attributes.commands.length > 0) {
+                let commands = message.attributes.commands;
+                
+                for (let i = commands.length - 1; i >= 0; i--) {
+                    // console.log("...commands[" + i + "]");
+                    if (commands[i].type === "message") { // is a message, not a "wait"
+                        // console.log("commands[i]:", commands[i].message.text);
+                        // let textEmpty = false;
+                        if (commands[i].message) {
+                            if (commands[i].message.type === "text") { // check text commands
+                                if (( commands[i].message.text && commands[i].message.text.trim() === "") || !commands[i].message.text) {
+                                    console.log("deleting command:", commands[i]);
+                                    commands.splice(i, 1);
+                                    if (commands[i-1]) {
+                                        if (commands[i-1].type === "wait") {
+                                            commands.splice(i-1, 1);
+                                            i--;
+                                            console.log("deleted wait");
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    }
+                }
+            // for (let i = 0; i < commands.length; i++) {
+            //   if (commands[i].type === 'message' && commands[i].message && commands[i].message.text) {
+            //     if (this.log) {console.log("[" + commands[i].message.lang + "]commands[i].message.text:", commands[i].message.text);}
+            //   }
+            // }
+            }
+        }
+        catch(error) {
+            log.error("error while checking", error)
+        }
+        return message;
+    }
+
+    /*
+    returns true if a valid message for a reply (i.e. at least one valid - non empty - message command)
+    */
+    static isValidReply(message) {
+        if (message && message.attributes && message.attributes.commands && message.attributes.commands.length > 0) {
+            return true;
+        } else {
+            return false;
+        }
+    }
+
     static totalMessageWait(message) {
         if (!message) {
           return;
@@ -337,17 +388,17 @@ class TiledeskChatbotUtil {
         
         if (message.text && message.sender !== "_tdinternal") {
             await chatbot.addParameter(TiledeskChatbotConst.REQ_LAST_USER_TEXT_KEY, message.text); // DEPRECATED
-            await chatbot.addParameter("lastUserText", message.text);
+            await chatbot.addParameter(TiledeskChatbotConst.REQ_LAST_USER_TEXT_v2_KEY, message.text);
             if (message.channel) {
                 if (message.channel.name === "chat21") {
-                    await chatbot.addParameter("chatChannel", "web"); // renames the channel in chat21
+                    await chatbot.addParameter(TiledeskChatbotConst.REQ_CHAT_CHANNEL, "web"); // renames the channel in chat21
                 }
                 else {
-                    await chatbot.addParameter("chatChannel", message.channel.name);
+                    await chatbot.addParameter(TiledeskChatbotConst.REQ_CHAT_CHANNEL, message.channel.name);
                 }
             }
-            await chatbot.addParameter("lastUserMessageType", message.type);
-            await chatbot.addParameter("lastUserMessage", TiledeskChatbotUtil.lastUserMessageFrom(message)); // JSON TYPE *NEW
+            await chatbot.addParameter(TiledeskChatbotConst.REQ_LAST_USER_MESSAGE_TYPE_KEY, message.type);
+            await chatbot.addParameter(TiledeskChatbotConst.REQ_LAST_USER_MESSAGE_KEY, TiledeskChatbotUtil.lastUserMessageFrom(message)); // JSON TYPE *NEW
             // get image
             if (message.type && message.type === "image" && message.metadata) {
                 // "text": "\nimage text",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tiledesk/tiledesk-tybot-connector",
-  "version": "0.2.25",
+  "version": "0.2.27",
   "description": "Tiledesk Tybot connector",
   "main": "index.js",
   "scripts": {

package/tiledeskChatbotPlugs/directives/DirQapla.js

@@ -53,16 +53,17 @@ class DirQapla {
       }
     }
 
-    let tracking_number = await this.context.chatbot.getParameter(action.trackingNumber);
+    const filler = new Filler();
+    const tracking_number = filler.fill(action.trackingNumber, requestVariables);
+    // let tracking_number = await this.context.chatbot.getParameter(action.trackingNumber);
     if (this.log) {console.log("DirQapla tracking number: ", tracking_number); }
 
-    if (!tracking_number) {
-      console.error("DirQapla ERROR - tracking number is undefined or null");
+    if (!tracking_number || tracking_number === '') {
+      console.error("DirQapla ERROR - tracking number is undefined or null or empty string");
       callback();
     }
 
     const qapla_base_url = process.env.QAPLA_ENDPOINT || "https://api.qapla.it/1.2"
-    // https://api.qapla.it/1.2/getShipment/?apiKey=3b9839c954168e861f2b63d79920ec3a3ff92aab674de9f3930df60b8a40c495&trackingNumber=123456
     if (this.log) { console.log("DirQapla QaplaEndpoint URL: ", qapla_base_url); }
     const QAPLA_HTTPREQUEST = {
       url: qapla_base_url + "/getShipment/",

package/tiledeskChatbotPlugs/directives/DirReply.js

@@ -97,18 +97,24 @@ class DirReply {
       }
     }
     // send!
-    message.senderFullname = this.context.chatbot.bot.name;
-    if (this.log) {console.log("Reply:", JSON.stringify(message))};
-    await TiledeskChatbotUtil.updateConversationTranscript(this.context.chatbot, message);
+    const cleanMessage = TiledeskChatbotUtil.removeEmptyReplyCommands(message);
+    if (!TiledeskChatbotUtil.isValidReply(cleanMessage)) {
+      console.log("invalid message", cleanMessage);
+      callback(); // cancel reply operation
+    }
+    // console.log("valid message!", cleanMessage);
+    cleanMessage.senderFullname = this.context.chatbot.bot.name;
+    if (this.log) {console.log("Reply:", JSON.stringify(cleanMessage))};
+    await TiledeskChatbotUtil.updateConversationTranscript(this.context.chatbot, cleanMessage);
     this.context.tdclient.sendSupportMessage(
       this.requestId,
-      message,
+      cleanMessage,
       (err) => {
         if (err) {
           console.error("Error sending reply:", err);
         }
         if (this.log) {console.log("Reply message sent");}
-        const delay = TiledeskChatbotUtil.totalMessageWait(message);
+        const delay = TiledeskChatbotUtil.totalMessageWait(cleanMessage);
         // console.log("got total delay:", delay)
         if (delay > 0 && delay <= 30000) { // prevent long delays
           setTimeout(() => {