@tiledesk/tiledesk-tybot-connector 0.1.51 → 0.1.52

package/CHANGELOG.md

@@ -5,6 +5,13 @@
 available on:
  ▶️ https://www.npmjs.com/package/@tiledesk/tiledesk-tybot-connector
 
+### 0.1.52
+- added tdChatbotName to request variables
+- removed _ from _td prefix in tiledeskVariables (i.e. _tdDepartmentId => tdDepartmentId)
+- added tdcache.hget()
+- fixed bug on DirAgentHandoff. this.dirId missed on intent-to-intent crashed the application. Getting tdDepartmentId from Redis
+- removed projectId from query getByIntentDisplayName(botId)
+
 ### 0.1.51
 - only debug on pre
 

package/TdCache.js

@@ -198,6 +198,26 @@ class TdCache {
         });
       });
     }
+
+    async hget(dict_key, key, callback) {
+      //console.log("hgetting dics", dict_key);
+      return new Promise( async (resolve, reject) => {
+        this.client.hget(dict_key, key, (err, value) => {
+          if (err) {
+            reject(err);
+            if (callback) {
+              callback(err, null);
+            }
+          }
+          else {
+            if (callback) {
+              callback(null, value);
+            }
+            resolve(value);
+          }
+        });
+      });
+    }
     
     async getJSON(key, callback) {
       const value = await this.get(key);

package/index.js

@@ -18,6 +18,7 @@ const { MongodbIntentsMachine } = require('./models/MongodbIntentsMachine.js');
 const { TiledeskIntentsMachine } = require('./models/TiledeskIntentsMachine.js');
 // const { MockActions } = require('./MockActions');
 const { MockBotsDataSource } = require('./models/MockBotsDataSource.js');
+const { TiledeskChatbotConst } = require('./models/TiledeskChatbotConst');
 
 //router.use(cors());
 router.use(bodyParser.json({limit: '50mb'}));
@@ -200,29 +201,33 @@ router.post('/ext/:botid', async (req, res) => {
 async function updateRequestVariables(chatbot, message, projectId, requestId) {
   // update request context
   const messageId = message._id;
-  await chatbot.addParameter("_tdProjectId", projectId);
-  await chatbot.addParameter("_tdRequestId", requestId);
+  await chatbot.addParameter(TiledeskChatbotConst.REQ_PROJECT_ID_KEY, projectId);
+  // TODO add projectName too
+  await chatbot.addParameter(TiledeskChatbotConst.REQ_REQUEST_ID_KEY, requestId);
+  if (chatbot.bot) {
+    await chatbot.addParameter(TiledeskChatbotConst.REQ_CHATBOT_NAME_KEY, chatbot.bot.name);
+  }
   if (message.text) {
-    await chatbot.addParameter("_tdLastUserText", message.text);
+    await chatbot.addParameter(TiledeskChatbotConst.REQ_LAST_USER_TEXT_KEY, message.text);
   }
-  await chatbot.addParameter("_tdLastMessageId", messageId);
+  await chatbot.addParameter(TiledeskChatbotConst.REQ_LAST_MESSAGE_ID_KEY, messageId);
   if (message.request && message.request.location && message.request.location.country) {
-    await chatbot.addParameter("_tdCountry", message.request.location.country);
+    await chatbot.addParameter(TiledeskChatbotConst.REQ_COUNTRY_KEY, message.request.location.country);
   }
   if (message.request && message.request.location && message.request.location.city) {
-    await chatbot.addParameter("_tdCity", message.request.location.city);
+    await chatbot.addParameter(TiledeskChatbotConst.REQ_CITY_KEY, message.request.location.city);
   }
   // console.log("message.request.language", message.request["language"])
   if (message.request) {
-    await chatbot.addParameter("_tdUserSourcePage", message.request.sourcePage);
-    await chatbot.addParameter("_tdUserLanguage", message.request["language"]);
-    await chatbot.addParameter("_tdUserAgent", message.request.userAgent);
+    await chatbot.addParameter(TiledeskChatbotConst.REQ_USER_SOURCE_PAGE_KEY, message.request.sourcePage);
+    await chatbot.addParameter(TiledeskChatbotConst.REQ_USER_LANGUAGE_KEY, message.request["language"]);
+    await chatbot.addParameter(TiledeskChatbotConst.REQ_USER_AGENT_KEY, message.request.userAgent);
   }
   if (message.attributes) {
-    await chatbot.addParameter("_tdRequestDepartmentId", message.attributes.departmentId);
-    await chatbot.addParameter("_tdRequestDepartmentName", message.attributes.departmentName);
-    await chatbot.addParameter("_tdRequestRequesterId", message.attributes.requester_id);
-    await chatbot.addParameter("_tdRequestIpAddress", message.attributes.ipAddress);
+    await chatbot.addParameter(TiledeskChatbotConst.REQ_DEPARTMENT_ID_KEY, message.attributes.departmentId);
+    await chatbot.addParameter(TiledeskChatbotConst.REQ_DEPARTMENT_NAME_KEY, message.attributes.departmentName);
+    await chatbot.addParameter(TiledeskChatbotConst.REQ_END_USER_ID_KEY, message.attributes.requester_id);
+    await chatbot.addParameter(TiledeskChatbotConst.REQ_END_USER_IP_ADDRESS_KEY, message.attributes.ipAddress);
     if (message.attributes.payload) {
       try {
         for (const [key, value] of Object.entries(message.attributes.payload)) {
@@ -420,7 +425,7 @@ router.get('/ext/parameters/requests/:requestid', async (req, res) => {
     if (parameters) {
       for (const [key, value] of Object.entries(parameters)) {
         // console.log(key, value);
-        if (!key.startsWith("_td")) {
+        if (!key.startsWith("td")) {
           userParams[key] = value;
         }
       }

package/models/MongodbBotsDataSource.js

@@ -50,7 +50,8 @@ class MongodbBotsDataSource {
    */
   async getByIntentDisplayName(botId, name) {
     return new Promise((resolve, reject) => {
-      var query = { "id_project": this.projectId, "id_faq_kb": botId, "intent_display_name": name};
+      // var query = { "id_project": this.projectId, "id_faq_kb": botId, "intent_display_name": name};
+      var query = { "id_faq_kb": botId, "intent_display_name": name };
       if (this.log) {console.debug('query', query);}
       Faq.find(query).lean().exec( (err, faqs) => {
         if (err) {

package/models/TiledeskChatbot.js

@@ -536,6 +536,12 @@ class TiledeskChatbot {
       TiledeskChatbot.requestCacheKey(requestId) + ":parameters");
   }
 
+  static async getParameterStatic(_tdcache, requestId, key) {
+    // const parameters_key = "tilebot:requests:" + requestId + ":parameters";
+    return await _tdcache.hget(
+      TiledeskChatbot.requestCacheKey(requestId) + ":parameters", key);
+  }
+  
   static async deleteParameterStatic(_tdcache, requestId, paramName) {
     return await _tdcache.hdel(
       TiledeskChatbot.requestCacheKey(requestId) + ":parameters", paramName);

package/models/TiledeskChatbotConst.js

@@ -0,0 +1,20 @@
+class TiledeskChatbotConst {
+    
+    static REQ_DEPARTMENT_ID_KEY = "tdDepartmentId";
+    static REQ_PROJECT_ID_KEY = "tdProjectId";
+    static REQ_REQUEST_ID_KEY = "tdRequestId";
+    static REQ_CHATBOT_NAME_KEY = "tdChatbotName";
+    static REQ_LAST_USER_TEXT_KEY = "tdLastUserText";
+    static REQ_LAST_MESSAGE_ID_KEY = "tdLastMessageId";
+    static REQ_COUNTRY_KEY = "tdCountry";
+    static REQ_CITY_KEY = "tdCity";
+    static REQ_USER_SOURCE_PAGE_KEY = "tdUserSourcePage";
+    static REQ_USER_LANGUAGE_KEY = "tdUserLanguage";
+    static REQ_USER_AGENT_KEY = "tdUserAgent";
+    static REQ_DEPARTMENT_NAME_KEY = "tdDepartmentName";
+    static REQ_END_USER_ID_KEY = "tdEndUserId";
+    static REQ_END_USER_IP_ADDRESS_KEY = "tdEndUserIpAddress";
+    
+}
+
+module.exports = { TiledeskChatbotConst };

package/models/TiledeskChatbotUtil.js

@@ -50,15 +50,15 @@ class TiledeskChatbotUtil {
         }
         if (commands.length > 0) {
           for (let i = commands.length - 1; i >= 0; i--) {
-            console.log("...commands[" + i + "]");
+            // console.log("...commands[" + i + "]");
             if (commands[i].type === "message") { // is a message, not wait
-                console.log("commands[i]:", commands[i].message.lang);
+                // console.log("commands[i]:", commands[i].message.lang);
                 // console.log("commands[i]:", lang, (commands[i].message["lang"] === lang));
                 if (commands[i].message["lang"] && !(commands[i].message["lang"] === lang)) { // if there is a filter and the filter is false, remove
-                    console.log("commands[i]lang:", commands[i]);
+                    // console.log("commands[i]lang:", commands[i]);
                     commands.splice(i, 1);
                     if (commands[i-1]) {
-                        console.log("commands[i-1]?:", commands[i-1]);
+                        // console.log("commands[i-1]?:", commands[i-1]);
                         if (commands[i-1].type === "wait") {
                             commands.splice(i-1, 1);
                             i--;

package/package.json

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

package/test/conversation-actions-test.js

@@ -83,8 +83,8 @@ describe('Conversation for actions test', async () => {
         else {
           // console.log("params /start:", params);
           assert(params);
-          assert(params["_tdLastMessageId"] === message_id);
-          assert(params["_tdProjectId"] === PROJECT_ID);
+          assert(params["tdLastMessageId"] === message_id);
+          assert(params["tdProjectId"] === PROJECT_ID);
           listener.close(() => {
             done();
           });

package/test/conversation-form-test.js

@@ -105,8 +105,8 @@ describe('Conversation1 - Form filling', async () => {
         else {
           // console.log("params /start:", params);
           assert(params);
-          assert(params["_tdLastMessageId"] === message_id);
-          assert(params["_tdProjectId"] === PROJECT_ID);
+          assert(params["tdLastMessageId"] === message_id);
+          assert(params["tdProjectId"] === PROJECT_ID);
           listener.close(() => {
             done();
           });
@@ -231,8 +231,8 @@ describe('Conversation1 - Form filling', async () => {
           else {
             // console.log("params2:", params);
             assert(params);
-            assert(params["_tdLastMessageId"] === message_id);
-            assert(params["_tdProjectId"] === PROJECT_ID);
+            assert(params["tdLastMessageId"] === message_id);
+            assert(params["tdProjectId"] === PROJECT_ID);
             assert(params["your_fullname"] === reply_text);
             assert(params["_tdTypeOf:your_fullname"]);
             listener.close(() => {
@@ -818,7 +818,7 @@ describe('Conversation1 - Form filling', async () => {
             // console.log("params /condition:", params);
             assert(params);
             // assert(params["city"] === "Milan");
-            assert(params["_tdCountry"] === "IT");
+            assert(params["tdCountry"] === "IT");
             let request = {
               "payload": {
                 "_id": uuidv4(),
@@ -859,7 +859,7 @@ describe('Conversation1 - Form filling', async () => {
           "type": "text",
           "sender": "A-SENDER",
           "recipient": REQUEST_ID,
-          "text": "/assign_params{\"_tdCountry\": \"IT\"}",
+          "text": "/assign_params{\"tdCountry\": \"IT\"}",
           "id_project": PROJECT_ID,
           "request": {
             "request_id": REQUEST_ID,
@@ -894,7 +894,7 @@ describe('Conversation1 - Form filling', async () => {
             // console.log("params /if_you_live_IT:", params);
             assert(params);
             // assert(params["city"] === "Milan");
-            assert(params["_tdCountry"] === "US");
+            assert(params["tdCountry"] === "US");
             let request = {
               "payload": {
                 "_id": uuidv4(),
@@ -935,7 +935,7 @@ describe('Conversation1 - Form filling', async () => {
           "type": "text",
           "sender": "A-SENDER",
           "recipient": REQUEST_ID,
-          "text": "/assign_params{\"_tdCountry\": \"US\"}",
+          "text": "/assign_params{\"tdCountry\": \"US\"}",
           "id_project": PROJECT_ID,
           "request": {
             "request_id": REQUEST_ID,

package/test/conversation-form_bot.js

@@ -770,7 +770,7 @@ const bot = {
 		"enabled": true,
 		"actions": [],
 		"question": "***",
-		"answer": "you live in ${_tdCity} (${_tdCountry})",
+		"answer": "you live in ${tdCity} (${tdCountry})",
 		"language": "en",
 		"intent_display_name": "location"
 	}, {
@@ -778,7 +778,7 @@ const bot = {
 		"enabled": true,
 		"actions": [],
 		"question": "***",
-		"answer": "\\_tdcondition --condition \"$_tdCountry === \\\"IT\\\"\" --trueIntent \"live_in_italy\" --falseIntent \"live_outside_italy\"",
+		"answer": "\\_tdcondition --condition \"$tdCountry === \\\"IT\\\"\" --trueIntent \"live_in_italy\" --falseIntent \"live_outside_italy\"",
 		"language": "en",
 		"intent_display_name": "if_you_live_IT"
 	}, {

package/test/filter_commands_test.js

@@ -343,7 +343,7 @@ describe('filter commands()', function() {
     ];
 
     TiledeskChatbotUtil.filterOnLanguage(commands, "en");
-    console.log("commands after", commands);
+    // console.log("commands after", commands);
     // assert(commands.length == 6);
   });
 });

package/tiledeskChatbotPlugs/DirectivesChatbotPlug.js

@@ -249,9 +249,17 @@ class DirectivesChatbotPlug {
     }
     else if (directive_name === Directives.CONDITION) {
       // console.log("...DirCondition");
-      new DirCondition(context).execute(directive, async () => {
-        let next_dir = await this.nextDirective(this.directives);
-        this.process(next_dir);
+      new DirCondition(context).execute(directive, async (stop) => {
+        if (stop == true) {
+          if (context.log) { console.log("Stopping Actions on:", directive);}
+          this.theend();
+        }
+        else {
+          let next_dir = await this.nextDirective(this.directives);
+          this.process(next_dir);
+        }
+        // let next_dir = await this.nextDirective(this.directives);
+        // this.process(next_dir);
       });
     }
     else if (directive_name === Directives.ASSIGN) {

package/tiledeskChatbotPlugs/directives/DirCondition.js

@@ -75,6 +75,8 @@ class DirCondition {
     const condition = action.condition;
     let trueIntent = action.trueIntent;
     let falseIntent = action.falseIntent;
+    let stopOnConditionMet = action.stopOnConditionMet;
+    console.log("executing action:", action);
     if (trueIntent && trueIntent.trim() === "") {
       trueIntent = null;
     }
@@ -131,7 +133,7 @@ class DirCondition {
     if (result === true) {
       if (trueIntentDirective) {
         this.intentDir.execute(trueIntentDirective, () => {
-          callback();
+          callback(stopOnConditionMet);
         });
       }
       else {
@@ -143,7 +145,7 @@ class DirCondition {
     else {
       if (falseIntentDirective) {
         this.intentDir.execute(falseIntentDirective, () => {
-          callback();
+          callback(stopOnConditionMet);
         });
       }
       else {

package/tiledeskChatbotPlugs/directives/DirIfOnlineAgents.js

@@ -1,4 +1,4 @@
-const { TiledeskClient } = require('@tiledesk/tiledesk-client');
+// const { TiledeskClient } = require('@tiledesk/tiledesk-client');
 const { DirIntent } = require('./DirIntent');
 const ms = require('minimist-string');
 

package/tiledeskChatbotPlugs/directives/DirIfOpenHours.js

@@ -1,4 +1,4 @@
-const { TiledeskClient } = require('@tiledesk/tiledesk-client');
+// const { TiledeskClient } = require('@tiledesk/tiledesk-client');
 const { DirIntent } = require('./DirIntent');
 const ms = require('minimist-string');
 

package/tiledeskChatbotPlugs/directives/DirIntent.js

@@ -65,73 +65,57 @@ class DirIntent {
   go(action, callback) {
     // console.log("action intent:", action);
     const intentName = action.intentName;
+    const intentId = action.intentId;
     const projectId = this.supportRequest.id_project;
     const requestId = this.supportRequest.request_id;
     const botId = this.supportRequest.bot_id;
+    let intent_command;
     if (intentName) {
-      let intent_command = "/" + intentName;
-      let intent_command_request = {
-        "payload": {
-          "_id": uuidv4(),
-          "senderFullname": "_tdinternal",
-          "type": "text",
-          "sender": "_tdinternal",
-          "recipient": requestId,
-          "text": intent_command,
-          "id_project": projectId,
-          "request": {
-            "request_id": requestId,
-            "id_project": projectId
-          }
-        },
-        "token": this.token
-      }
-
-      // let intent_command_message = {
-      //   //sender: "_tdsender", // bot doesn't reply to "himself" and "system"
-      //   text: intent_command,
-      //   attributes: {
-      //     subtype: "info"
-      //   }
-      // };
-      // send message to /ext/botId
-      // const req_body = {
-      //   payload: message_to_bot,
-      //   token: token
-      // }
-      // let extEndpoint = `${this.API_ENDPOINT}/modules/tilebot`;
-      // if (this.TILEBOT_ENDPOINT) {
-      //   extEndpoint = `${this.TILEBOT_ENDPOINT}`;
-      // }
-      // const extapi = new ExtApi({
-      //   ENDPOINT: extEndpoint,
-      //   log: this.log
-      // });
-      if (this.log) {console.log("move to intent message:", intent_command_request);}
-      // extapi.sendSupportMessageExt(intent_command_message, projectId, requestId, token, () => {
-      //   if (this.log) {console.log("command " + intent_command + " sent.");}
-      //   callback();
-      // });
-      let TILEBOT_ENDPOINT;
-      // if (process.env.CHATBOT_ENDPOINT) {
-      //   CHATBOT_ENDPOINT = process.env.CHATBOT_ENDPOINT;
-      // }
-      // else 
-      if (this.TILEBOT_ENDPOINT) {
-        TILEBOT_ENDPOINT = this.TILEBOT_ENDPOINT;
-      }
-      else {
-        TILEBOT_ENDPOINT = `${this.API_ENDPOINT}/modules/tilebot`
-      }
-      
-      this.sendMessageToBot(TILEBOT_ENDPOINT, intent_command_request, botId, () => {
-        // console.log("sendMessageToBot() req_body sent:", intent_command_request);
-        callback();
-      });
+      intent_command = "/" + intentName;
+    }
+    else if (intentId) {
+      intent_command = "/#" + intentId;
     }
     else {
+      console.error("Invalid intent");
       callback();
     }
+
+    // if (intentName) {
+    //   let intent_command = "/" + intentName;
+    let intent_command_request = {
+      "payload": {
+        "_id": uuidv4(),
+        "senderFullname": "_tdinternal",
+        "type": "text",
+        "sender": "_tdinternal",
+        "recipient": requestId,
+        "text": intent_command,
+        "id_project": projectId,
+        "request": {
+          "request_id": requestId,
+          "id_project": projectId
+        }
+      },
+      "token": this.token
+    }
+    if (this.log) {console.log("move to intent message:", intent_command_request);}
+    let TILEBOT_ENDPOINT;
+    if (this.TILEBOT_ENDPOINT) {
+      TILEBOT_ENDPOINT = this.TILEBOT_ENDPOINT;
+    }
+    else {
+      TILEBOT_ENDPOINT = `${this.API_ENDPOINT}/modules/tilebot`
+    }
+    this.sendMessageToBot(TILEBOT_ENDPOINT, intent_command_request, botId, () => {
+      // console.log("sendMessageToBot() req_body sent:", intent_command_request);
+      callback();
+    });
+
+    // }
+    // else {
+    //   callback();
+    // }
   }
 
   static intentDirectiveFor(intent) {

package/tiledeskChatbotPlugs/directives/DirMoveToAgent.js

@@ -1,5 +1,7 @@
-const { TiledeskClient } = require('@tiledesk/tiledesk-client');
+// const { TiledeskClient } = require('@tiledesk/tiledesk-client');
 const { Directives } = require('./Directives');
+const { TiledeskChatbot } = require('../../models/TiledeskChatbot');
+const { TiledeskChatbotConst } = require('../../models/TiledeskChatbotConst');
 
 class DirMoveToAgent {
 
@@ -29,7 +31,7 @@ class DirMoveToAgent {
     this.tdclient = context.tdclient;
     this.tdcache = context.tdcache;
     this.requestId = context.requestId;
-    this.depId = context.departmentId;
+    // this.depId = context.departmentId;
     this.log = context.log;
   }
 
@@ -44,24 +46,34 @@ class DirMoveToAgent {
       callback();
     });
   }
-  go(action, callback) {
+
+  async go(action, callback) {
     if (action.whenOnlineOnly === true) {
-      this.tdclient.openNow((err, result) => {
+      this.tdclient.openNow( async (err, result) => {
         if (err) {
           console.error("Agent in DirOfflineHours Error:", err);
           callback();
         }
         else {
           if (result && result.isopen) {
-            this.tdclient.agent(this.requestId, this.depId, (err) => {
-              if (err) {
-                console.error("Error moving to agent during online hours:", err);
-              }
-              else {
-                //console.log("Successfully moved to agent during online hours");
-              }
+            if (this.tdcache) {
+              depId = 
+              await TiledeskChatbot.getParameterStatic(
+                this.tdcache, this.requestId, TiledeskChatbotConst.REQ_DEPARTMENT_ID_KEY
+              );
+              this.tdclient.agent(this.requestId, depId, (err) => {
+                if (err) {
+                  console.error("Error moving to agent during online hours:", err);
+                }
+                else {
+                  //console.log("Successfully moved to agent during online hours");
+                }
+                callback();
+              });
+            }
+            else {
               callback();
-            });
+            }
           }
           else {
             callback();
@@ -70,15 +82,24 @@ class DirMoveToAgent {
       });
     }
     else {
-      this.tdclient.agent(this.requestId, this.depId, (err) => {
-        if (err) {
-          console.error("Error moving to agent:", err);
-        }
-        else {
-          //console.log("Successfully moved to agent");
-        }
+      if (this.tdcache) {
+        const depId = 
+        await TiledeskChatbot.getParameterStatic(
+          this.tdcache, this.requestId, TiledeskChatbotConst.REQ_DEPARTMENT_ID_KEY
+        );
+        this.tdclient.agent(this.requestId, depId, (err) => {
+          if (err) {
+            console.error("Error moving to agent:", err);
+          }
+          else {
+            //console.log("Successfully moved to agent");
+          }
+          callback();
+        });
+      }
+      else {
         callback();
-      });
+      }
     }
   }