@tiledesk/tiledesk-tybot-connector 0.2.17 → 0.2.20

package/CHANGELOG.md

@@ -5,6 +5,16 @@
 available on:
  ▶️ https://www.npmjs.com/package/@tiledesk/tiledesk-tybot-connector
 
+### v0.2.20
+- updateRequestVariables renamed in updateRequestAttributes
+- Added TildeskChatbot instance method async getParameter(parameter_name)
+- Added "transcript" attribute
+
+### 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

package/index.js

@@ -27,6 +27,7 @@ const { DirectivesChatbotPlug } = require('./tiledeskChatbotPlugs/DirectivesChat
 // THE IMPORT
 let mongoose = require('mongoose');
 const { Directives } = require('./tiledeskChatbotPlugs/directives/Directives.js');
+const { TiledeskChatbotUtil } = require('./models/TiledeskChatbotUtil.js'); //require('@tiledesk/tiledesk-chatbot-util');
 let APIURL = null;
 let staticBots;
 
@@ -146,7 +147,8 @@ router.post('/ext/:botid', async (req, res) => {
     projectId: projectId,
     log: log
   });
-  await updateRequestVariables(chatbot, message, projectId, requestId);
+  await updateRequestAttributes(chatbot, message, projectId, requestId);
+  await TiledeskChatbotUtil.updateConversationTranscript(chatbot, message);
 
   let reply = await chatbot.replyToMessage(message);
   if (!reply) {
@@ -216,36 +218,7 @@ router.post('/ext/:botid', async (req, res) => {
   
 });
 
-// async function botById(botId, projectId, tdcache, botsDS) {
-//   let bot = null;
-//   // let botCacheKey = "cacheman:cachegoose-cache:" + projectId + ":faq_kbs:id:" + botId;
-//   let botCacheKey = "cacheman:cachegoose-cache:faq_kbs:id:" + botId;
-//   try {
-//     let _bot_as_string = await tdcache.get(botCacheKey);
-//     const value_type = typeof _bot_as_string;
-//     console.log("_bot_as_string found in chache:", _bot_as_string);
-//     console.log("value_type:", value_type);
-//     if (_bot_as_string) {
-//       bot = JSON.parse(_bot_as_string);
-//       console.log("got bot from cache:", JSON.stringify(bot));
-//     }
-//     else {
-//       console.log("bot not found, getting from datasource...");
-//       bot = await botsDS.getBotById(botId);
-//       console.log("bot found in datasource:", JSON.stringify(bot));
-//       await tdcache.set(botCacheKey, JSON.stringify(bot));
-//       // DEBUG CODE REMOVE
-//       let bot_ = await tdcache.get(botCacheKey);
-//       console.log("_bot_as_string from cache debug:", bot_)
-//     }
-//   }
-//   catch(err) {
-//     console.error("error getting bot by id:", err);
-//   }
-//   return bot;
-// }
-
-async function updateRequestVariables(chatbot, message, projectId, requestId) {
+async function updateRequestAttributes(chatbot, message, projectId, requestId) {
   // update request context
   if (chatbot.log) {console.log("Updating request variables. Message:", JSON.stringify(message));}
   const messageId = message._id;
@@ -261,6 +234,7 @@ 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) {

package/models/TiledeskChatbot.js

@@ -275,10 +275,11 @@ 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 on IntentsFinder.decode() (/model/parse error):", error.message);
@@ -289,8 +290,9 @@ class TiledeskChatbot {
             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;
@@ -577,6 +579,14 @@ class TiledeskChatbot {
     await TiledeskChatbot.addParameterStatic(this.tdcache, this.requestId, parameter_name, parameter_value);
   }
 
+  async getParameter(parameter_name) {
+    // console.log("this.tdcache::", this.tdcache)
+    // console.log("this.requestId::", this.requestId)
+    // console.log("parameter_name::", parameter_name)
+    
+    return await TiledeskChatbot.getParameterStatic(this.tdcache, this.requestId, parameter_name);
+  }
+
   async deleteParameter(parameter_name) {
     await TiledeskChatbot.deleteParameterStatic(this.tdcache, this.requestId, parameter_name);
   }
@@ -594,8 +604,8 @@ class TiledeskChatbot {
   static async allParametersStatic(_tdcache, requestId) {
     const parameters_key = TiledeskChatbot.requestCacheKey(requestId) + ":parameters";
     const attributes__as_string_map = await _tdcache.hgetall(parameters_key);
-    console.log("** getting parameters for requestId:", requestId);
-    console.log("** for key:", parameters_key, "parameters:", JSON.stringify(attributes__as_string_map));
+    // console.log("** getting parameters for requestId:", requestId);
+    // console.log("** for key:", parameters_key, "parameters:", JSON.stringify(attributes__as_string_map));
     let attributes_native_values = {};
     if (attributes__as_string_map !== null) {
       for (const [key, value] of Object.entries(attributes__as_string_map)) {

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))
@@ -254,6 +273,31 @@ class TiledeskChatbotUtil {
         }
     }
 
+    static async updateConversationTranscript(chatbot, message) {
+        // console.log("transcript updating with:", message)
+        if (message && message.text && message.text.trim() !== "" && message.sender !== "_tdinternal" && !this.isHiddenMessage(message)) {
+            let transcript = await chatbot.getParameter("transcript");
+            // console.log("transcript got:", transcript);
+            if (transcript) {
+                transcript = transcript + "\n[" + message.senderFullname + "] says: " + message.text;
+            }
+            else {
+                transcript = "[" + message.senderFullname + "] says: " + message.text;
+            }
+            // console.log("transcript update:", transcript);
+            await chatbot.addParameter("transcript", transcript);
+            let transcript2 = await chatbot.getParameter("transcript");
+            // console.log("transcript updated:", transcript2);
+        }
+    }
+
+    static isHiddenMessage(message) {
+        if (message && message.attributes && message.attributes.subtype === "info") {
+            return true;
+        }
+        return false;
+    }
+
 }
 
 module.exports = { TiledeskChatbotUtil };

package/models/TiledeskIntentsMachine.js

@@ -37,13 +37,14 @@ class TiledeskIntentsMachine {
       };
       this.myrequest(
         HTTPREQUEST,
-        function(err, resbody) {
+        (err, resbody) => {
           if (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
       }

package/package.json

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

package/tiledeskChatbotPlugs/directives/DirReply.js

@@ -97,7 +97,9 @@ 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);
     this.context.tdclient.sendSupportMessage(
       this.requestId,
       message,
@@ -106,7 +108,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(