@tiledesk/tiledesk-tybot-connector 0.2.16 → 0.2.19

package/CHANGELOG.md

@@ -5,6 +5,17 @@
 available on:
  ▶️ https://www.npmjs.com/package/@tiledesk/tiledesk-tybot-connector
 
+### v0.2.19
+- Added native attribute lastUserMessageType
+- Added integration with external intents decode engine
+- Added support for automatic wait time on each reply
+
+### v0.2.17
+- Added lastUserMessage JSON native attribute
+- Added attributes to access image and file properties from incoming messages
+- Added support for JSON attributes in conditions
+- Added backupIntentsFinder based on Fulltext in TiledeskChatbot
+
 ### v0.2.16
 - update whatsapp api url for pre environment
 

package/TiledeskExpression.js

@@ -230,9 +230,9 @@ class TiledeskExpression {
     }
 
     evaluateJavascriptExpression(expression, context) {
-        // console.log("evaluating:", expression)
+        // console.log("(evaluateJavascriptExpression) evaluating:", expression)
         // console.log("context:", context)
-        let res;
+        let res = null;
         try {
             const vm = new VM({
                 timeout: 200,
@@ -240,9 +240,10 @@ class TiledeskExpression {
                 sandbox: context
             });
             res = vm.run(`let $data = this;${expression}`);
+            // console.log("res=", res)
         }
         catch (err) {
-            console.error("TiledeskExpression.evaluate() error:", err.message, "evaluating expression: '" + expression + "'");
+            console.error("(evaluateJavascriptExpression) TiledeskExpression.evaluate() error:", err.message, "evaluating expression: '" + expression + "'");
         }
         return res;
     }
@@ -324,11 +325,13 @@ class TiledeskExpression {
         // console.log("applyPattern:", applyPattern);
         let operand1_s;
         let is_valid_operand1 = TiledeskExpression.validateVariableName(condition.operand1);
+        // console.log("is_valid_operand1:", condition.operand1, is_valid_operand1);
         if (is_valid_operand1) {
             operand1_s = TiledeskExpression.variableOperand(condition.operand1);
+            // console.log("operand1_s:", operand1_s);
         }
         else {
-            // console.error("Condition evaluation stopped because of invalid operand", condition.operand1);
+            console.error("Condition evaluation stopped because of invalid operand", condition.operand1);
             return null;
         }
         
@@ -343,24 +346,26 @@ class TiledeskExpression {
                 operand2_s = TiledeskExpression.variableOperand(condition.operand2.name);
             }
             else {
-                // console.error("Condition evaluation stopped because of invalid operand2", condition.operand2);
+                console.error("Condition evaluation stopped because of invalid operand2", condition.operand2);
                 return null;
             }
         }
         else {
-            // console.error("Condition evaluation stopped because of: No operand2", JSON.stringify(condition));
+            console.error("Condition evaluation stopped because of: No operand2", JSON.stringify(condition));
             return null;
         }
         
-        // console.log("operand2_s:", operand2_s);
+        // console.log("operand1_s, operand2_s:",operand1_s, operand2_s);
         const expression = 
             applyPattern
                 .replace("#1", operand1_s)
                 .replace("#2", operand2_s);
+        // console.log("expression is:", expression);
         return expression;
     }
 
     static JSONGroupToExpression(group, variables) {
+        // console.log("attributes:", variables);
         let conditions = group.conditions;
         let group_expression = "";
         // console.log("conditions:", conditions)
@@ -368,6 +373,7 @@ class TiledeskExpression {
             let part = conditions[i];
             if (part.type === "condition") {
                 let expression = TiledeskExpression.JSONConditionToExpression(part, variables);
+                // console.log("returned expression:", expression);
                 if (expression === null) {
                     // console.error("Invalid JSON expression", JSON.stringify(part));
                     return null;
@@ -412,7 +418,8 @@ class TiledeskExpression {
     static validateVariableName(variableName) {
         // console.log("variableName", variableName)
         // console.log("type of variableName:", typeof variableName);
-        let matches = variableName.match(/^[a-zA-Z_]*[a-zA-Z_]+[a-zA-Z0-9_]*$/gm);
+        // let matches = variableName.match(/^[a-zA-Z_]*[a-zA-Z_]+[a-zA-Z0-9_]*$/gm);
+        let matches = variableName.match(/^[a-zA-Z_]+.*$/gm);
         // console.log("matches:", matches)
         if (matches !== null) {
             return true;

package/index.js

@@ -102,8 +102,11 @@ router.post('/ext/:botid', async (req, res) => {
   if (log) {console.log("bot found:", JSON.stringify(bot));}
   
   let intentsMachine;
+  let backupMachine;
   if (!staticBots) {
     intentsMachine = IntentsMachineFactory.getMachine(bot, botId, projectId, log);
+    backupMachine = IntentsMachineFactory.getBackupMachine(bot, botId, projectId, log);
+    console.log("Created backupMachine:", backupMachine);
   }
   else {
     intentsMachine = {}
@@ -132,6 +135,7 @@ router.post('/ext/:botid', async (req, res) => {
   const chatbot = new TiledeskChatbot({
     botsDataSource: botsDS,
     intentsFinder: intentsMachine,
+    backupIntentsFinder: backupMachine,
     botId: botId,
     bot: bot,
     token: token,
@@ -257,7 +261,60 @@ async function updateRequestVariables(chatbot, message, projectId, requestId) {
   }
   if (message.text && message.sender !== "_tdinternal") {
     await chatbot.addParameter(TiledeskChatbotConst.REQ_LAST_USER_TEXT_KEY, message.text);
+    await chatbot.addParameter("lastUserMessageType", message.type);
+    await chatbot.addParameter("lastUserMessage", lastUserMessageFrom(message)); // JSON TYPE *NEW
+    // get image
+    if (message.type && message.type === "image" && message.metadata) {
+      // "text": "\nimage text",
+      // "id_project": "65203e12f8c0cf002cf4110b",
+      // "createdBy": "8ac52a30-133f-4ee1-8b4b-96055bb81757",
+      // "metadata": {
+      //     "height": 905,
+      //     "name": "tiledesk_Open graph_general.png",
+      //     "src": "https://firebasestorage.googleapis.com/v0/b/chat21-pre-01.appspot.com/o/public%2Fimages%2F8ac52a30-133f-4ee1-8b4b-96055bb81757%2Fda5bbc8d-5174-49a8-a041-3d9355242da5%2Ftiledesk_Open%20graph_general.png?alt=media&token=be82fecb-3cd1-45b9-a135-c2c57a932862",
+      //     "type": "image/png",
+      //     "uid": "lo68iyq5",
+      //     "width": 1724
+      // }
+      if (message.metadata.src) {
+        await chatbot.addParameter("lastUserImageURL", message.metadata.src);
+        await chatbot.addParameter("lastUserImageName", message.metadata.name);
+        await chatbot.addParameter("lastUserImageWidth", message.metadata.width);
+        await chatbot.addParameter("lastUserImageHeight", message.metadata.height);
+        await chatbot.addParameter("lastUserImageType", message.metadata.type);
+      }
+    }
+    else {
+      await chatbot.addParameter("lastUserImageURL", null);
+        await chatbot.addParameter("lastUserImageName", null);
+        await chatbot.addParameter("lastUserImageWidth", null);
+        await chatbot.addParameter("lastUserImageHeight", null);
+        await chatbot.addParameter("lastUserImageType", null);
+    }
+    // get document
+    if (message.type && message.type === "file" && message.metadata) {
+      // "type": "file",
+      // "text": "[LIBRETTO-WEB-ISTRUZIONI-GENITORI.pdf](https://firebasestorage.googleapis.com/v0/b/chat21-pre-01.appspot.com/o/public%2Fimages%2F8ac52a30-133f-4ee1-8b4b-96055bb81757%2F502265ee-4f4a-47a4-9375-172bb0e6bf39%2FLIBRETTO-WEB-ISTRUZIONI-GENITORI.pdf?alt=media&token=a09d065a-9b56-4507-8960-344cc294e4d1)\nistruzioni",
+      // "metadata": {
+      //     "name": "LIBRETTO-WEB-ISTRUZIONI-GENITORI.pdf",
+      //     "src": "https://firebasestorage.googleapis.com/v0/b/chat21-pre-01.appspot.com/o/public%2Fimages%2F8ac52a30-133f-4ee1-8b4b-96055bb81757%2F502265ee-4f4a-47a4-9375-172bb0e6bf39%2FLIBRETTO-WEB-ISTRUZIONI-GENITORI.pdf?alt=media&token=a09d065a-9b56-4507-8960-344cc294e4d1",
+      //     "type": "application/pdf",
+      //     "uid": "lo68oz8i"
+      // }
+      if (message.metadata.src) {
+        await chatbot.addParameter("lastUserDocumentURL", message.metadata.src);
+        await chatbot.addParameter("lastUserDocumentName", message.metadata.name);
+        await chatbot.addParameter("lastUserDocumentType", message.metadata.type);
+      }
+    }
+    else {
+      await chatbot.addParameter("lastUserDocumentURL", null);
+        await chatbot.addParameter("lastUserDocumentName", null);
+        await chatbot.addParameter("lastUserDocumentType", null);
+    }
   }
+  
+
   await chatbot.addParameter(TiledeskChatbotConst.REQ_LAST_MESSAGE_ID_KEY, messageId);
   if (message.request && message.request.location && message.request.location.country) {
     await chatbot.addParameter(TiledeskChatbotConst.REQ_COUNTRY_KEY, message.request.location.country);
@@ -325,7 +382,7 @@ async function updateRequestVariables(chatbot, message, projectId, requestId) {
     }
   }
   if (chatbot.log) {
-    console.log("tdcache:", chatbot.tdcache);
+    // console.log("tdcache:", chatbot.tdcache);
     console.log("requestId:", requestId);
     console.log("KEY:", TiledeskChatbotConst.REQ_PROJECT_ID_KEY);
     let proj_ = await TiledeskChatbot.getParameterStatic(chatbot.tdcache, requestId, TiledeskChatbotConst.REQ_PROJECT_ID_KEY);
@@ -366,6 +423,23 @@ async function updateRequestVariables(chatbot, message, projectId, requestId) {
   //   }
 }
 
+function lastUserMessageFrom(msg) {
+  let message = {};
+  message["senderFullname"] = msg["senderFullname"]; // ex. "Bot"
+  message["type"] = msg["type"]; // ex. "text",
+  message["channel_type"] = msg["channel_type"]; // ex. "group",
+  message["status"] = msg["status"]; // ex. 0,
+  message["id"] = msg["_id"]; // ex. "6538cda46cb4d8002cf2317a",
+  message["sender"] = msg["sender"]; // ex. "system",
+  message["recipient"] = msg["recipient"]; // ex. "support-group-65203e12f8c0cf002cf4110b-4066a69c8b464646a3ff25f9f41575bb",
+  message["text"] = msg["text"]; // ex. "\\start",
+  message["createdBy"] = msg["createdBy"]; // ex. "system",
+  message["attributes"] = msg["attributes"]; // ex. { "subtype": "info" }
+  message["metadata"] = msg["metadata"];
+  message["channel"] = msg["channel"]; // ex. { "name": "chat21" }
+  return message;
+}
+
 function actionsToDirectives(actions) {
   let directives = [];
   if (actions && actions.length > 0) {

package/models/IntentsMachineFactory.js

@@ -13,12 +13,18 @@ class IntentsMachineFactory {
           });
       }
       else {
-        console.log("bot.intentsEngine is null");
         if (log) {console.log("Setting MongodbIntentsMachine with bot:", JSON.stringify(bot));}
         machine = new MongodbIntentsMachine({projectId: projectId, language: bot.language, log});
       }
       return machine;
     }
+
+    static getBackupMachine(bot, botId, projectId, log) {
+      let machine;
+      if (log) {console.log("Setting MongodbIntentsMachine as Backup Intents Machine on bot:", JSON.stringify(bot));}
+      machine = new MongodbIntentsMachine({projectId: projectId, language: bot.language, log});
+      return machine;
+    }
   }
   
   module.exports = { IntentsMachineFactory }

package/models/TiledeskChatbot.js

@@ -29,6 +29,7 @@ class TiledeskChatbot {
     }
     this.botsDataSource = config.botsDataSource;
     this.intentsFinder = config.intentsFinder;
+    this.backupIntentsFinder = config.backupIntentsFinder;
     this.botId = config.botId;
     this.bot = config.bot;
     this.token = config.token;
@@ -79,7 +80,7 @@ class TiledeskChatbot {
             if (this.log) {console.log("RESETTING LOCKED INTENT. Intent was explicitly invoked with an action:", message.attributes.action);}
             await this.unlockIntent(this.requestId);
             await this.unlockAction(this.requestId);
-            if (this.log) {console.log("RESET LOCKED INTENT. Intent was explicitly invoked with an action:", message.attributes.action);}
+            if (this.log) {console.log("RESET LOCKED INTENT. Intent was explicitly  invoked with an action:", message.attributes.action);}
           }
         }
         catch(error) {
@@ -151,7 +152,7 @@ class TiledeskChatbot {
 
       let explicit_intent_name = null;
       // Explicit intent invocation
-      if (message.text.startsWith("/")) {
+      if (message.text && message.text.startsWith("/")) {
         if (this.log) {console.log("Intent was explicitly invoked:", message.text);}
         let intent_name = message.text.substring(message.text.indexOf("/") + 1);
         if (this.log) {console.log("Invoked Intent:", intent_name);}
@@ -274,16 +275,24 @@ class TiledeskChatbot {
         return;
       }
       else { // NLP
-        if (this.log) {console.log("Chatbot NLP decode intent...");}
+        if (this.log) {console.log("Chatbot NLP decoding intent...");}
         let intents;
         try {
           intents = await this.intentsFinder.decode(this.botId, message.text);
+          if (this.log) {console.log("Tiledesk AI intents found:", intents);}
         }
         catch(error) {
-          console.error("An error occurred:", error);
+          console.error("An error occurred on IntentsFinder.decode() (/model/parse error):", error.message);
+          // recover on fulltext
+          if (this.backupIntentsFinder) {
+            if (this.log) {console.log("using backup Finder:", this.backupIntentsFinder);}
+            intents = await this.backupIntentsFinder.decode(this.botId, message.text);
+            if (this.log) {console.log("Got intents from backup finder:", intents);}
+          }
         }
-        if (this.log) {console.log("NLP decoded found:", intents);}
+        if (this.log) {console.log("NLP intents found:", intents);}
         if (intents && intents.length > 0) {
+          console.log("Matching intents found.");
           // let faq = await this.botsDataSource.getByIntentDisplayName(this.botId, intents[0].intent_display_name);
           let faq = await this.botsDataSource.getByIntentDisplayNameCache(this.botId, intents[0].intent_display_name, this.tdcache);
           let reply;

package/models/TiledeskChatbotUtil.js

@@ -233,6 +233,25 @@ class TiledeskChatbotUtil {
         }
     }
 
+    static totalMessageWait(message) {
+        if (!message) {
+          return;
+        }
+        console.log("compute delay...", message)
+        if (message.attributes.commands.length > 0) {
+            console.log("going on delay")
+            let commands = message.attributes.commands;
+            console.log("got commands", commands)
+            let totalWaitTime = 0;
+            for (let i = commands.length - 1; i >= 0; i--) {
+                if (commands[i].type === "wait") { // is a wait
+                    totalWaitTime += commands[i].time;
+                }
+            }
+            return totalWaitTime;
+        }
+    }
+
     static fillCommandAttachments(command, variables, log) {
         if (log) {
             console.log("filling command button:", JSON.stringify(command))

package/models/TiledeskIntentsMachine.js

@@ -37,13 +37,14 @@ class TiledeskIntentsMachine {
       };
       this.myrequest(
         HTTPREQUEST,
-        function(err, resbody) {
+        (err, resbody) => {
           if (err) {
-            console.error("error:", err)
+            // console.error("An error occurred on /model/parse:", err)
             reject(err);
           }
           else {
-            resolve(resbody);
+            console.log("Tiledesk AI replied:", resbody)
+            resolve(this.translateForTiledesk(resbody));
           }
         }, false
       );
@@ -83,7 +84,7 @@ class TiledeskIntentsMachine {
     // }
     let intents_array = intents.intent_ranking;
     let tiledesk_intents = [];
-    for (i = 0; i < intents_array.length; i++) {
+    for (let i = 0; i < intents_array.length; i++) {
       let td_intent = {
         "intent_display_name": intents_array[i].name
       }
@@ -123,7 +124,7 @@ class TiledeskIntentsMachine {
       }
     })
     .catch( (error) => {
-      console.error("An error occurred:", error);
+      // console.error("An error occurred:", error);
       if (callback) {
         callback(error, null, null);
       }

package/package.json

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

package/tiledeskChatbotPlugs/directives/DirIntent.js

@@ -80,6 +80,7 @@ class DirIntent {
     else {
       console.error("Invalid intent");
       callback();
+      return;
     }
 
     // if (intentName) {

package/tiledeskChatbotPlugs/directives/DirReply.js

@@ -106,7 +106,18 @@ class DirReply {
           console.error("Error sending reply:", err);
         }
         if (this.log) {console.log("Reply message sent");}
-        callback();
+        const delay = TiledeskChatbotUtil.totalMessageWait(message);
+        console.log("got total delay:", delay)
+        if (delay > 0 && delay <= 30000) { // prevent long delays
+          setTimeout(() => {
+            console.log("callback after delay")
+            callback();
+          }, delay);
+        }
+        else {
+          console.log("invalid delay.")
+          callback();
+        }
     });
 
     // this.sendSupportMessage(