@tiledesk/tiledesk-tybot-connector 0.2.69 → 0.2.71

package/CHANGELOG.md

@@ -5,6 +5,14 @@
 available on:
  ▶️ https://www.npmjs.com/package/@tiledesk/tiledesk-tybot-connector
 
+# v0.2.71
+- Fix. DirReplyV2 "NoInput" bug. Refactored with the introduction of "timeout_id", an ID specific for each noInput timeout: this.chatbot.addParameter(TiledeskChatbotConst.USER_INPUT, timeout_id)
+
+# v0.2.70
+- added DirIfOnlineAgentsV2
+- Fix. TiledeskChatbot: WRONG: await chatbot.addParameter("userInput", true); ====>    FIXED: this.addParameter("userInput", true)
+- Fix. Fixed WRONG addParameter(key, value) invocation in TiledeskChatbot with 3 (instead of key, value) parameters
+
 # v0.2.69
 - added flow attributes in reply action (original)
 

package/models/TiledeskChatbot.js

@@ -9,6 +9,7 @@ const { IntentForm } = require('./IntentForm.js');
 const { TiledeskChatbotUtil } = require('./TiledeskChatbotUtil.js');
 const { DirLockIntent } = require('../tiledeskChatbotPlugs/directives/DirLockIntent');
 const { DirUnlockIntent } = require('../tiledeskChatbotPlugs/directives/DirUnlockIntent');
+const { TiledeskChatbotConst } = require('./TiledeskChatbotConst.js');
 
 class TiledeskChatbot {
 
@@ -53,11 +54,13 @@ class TiledeskChatbot {
         lead = message.request.lead;
         if (lead && lead.fullname) {
           if (this.log) {console.log("lead.fullname => params.userFullname:", lead.fullname)}
-          await this.addParameter(this.requestId, "userFullname", lead.fullname);
+          // await this.addParameter(this.requestId, "userFullname", lead.fullname);
+          await this.addParameter("userFullname", lead.fullname);
         }
         if (lead && lead.email) {
           if (this.log) {console.log("lead.email => params.userEmail:", lead.email)}
-          await this.addParameter(this.requestId, "userEmail", lead.email);
+          // await this.addParameter(this.requestId, "userEmail", lead.email);
+          await this.addParameter("userEmail", lead.email);
         }
       }
       if (this.log) {
@@ -81,7 +84,6 @@ class TiledeskChatbot {
             await this.unlockIntent(this.requestId);
             await this.unlockAction(this.requestId);
             // console.log("RESET LOCKED INTENT.");
-            await chatbot.addParameter("userInput", true); // set userInput
             if (this.log) {console.log("RESET LOCKED INTENT. Intent was explicitly  invoked with an action:", message.attributes.action);}
           }
         } catch(error) {
@@ -89,6 +91,18 @@ class TiledeskChatbot {
         }
       }
 
+      // resetting any noInput timeout setting userInput = true
+      // if (message.sender != "_tdinternal") {
+      //   if (this.log) {console.log("resetting any noInput timeout setting userInput = (false?)", await this.getParameter(TiledeskChatbotConst.USER_INPUT) );}
+      //   try {
+      //     // await this.addParameter(TiledeskChatbotConst.USER_INPUT, true); // set userInput
+      //     await this.deleteParameter(TiledeskChatbotConst.USER_INPUT); // reset userInput
+      //     if (this.log) {console.log("userInput?", await this.getParameter(TiledeskChatbotConst.USER_INPUT) );}
+      //   } catch(error) {
+      //     console.error("Error resetting userInput:", error);
+      //   }
+      // }
+
       // any external invocation restarts the steps counter
       try {
         if (message.sender != "_tdinternal") {

package/models/TiledeskChatbotConst.js

@@ -22,6 +22,7 @@ class TiledeskChatbotConst {
     static REQ_CHAT_CHANNEL = "chatChannel";
     static REQ_DECODED_JWT_KEY = "decodedCustomJWT";
     static REQ_REQUESTER_IS_AUTHENTICATED_KEY = "strongAuthenticated";
+    static USER_INPUT = "_userInput";
 
     // static REQ_DEPARTMENT_ID_KEY = "tdDepartmentId";
     // static REQ_PROJECT_ID_KEY = "projectId";

package/models/TiledeskChatbotUtil.js

@@ -496,7 +496,8 @@ class TiledeskChatbotUtil {
             }
             
             if (message.text && message.sender !== "_tdinternal") {
-                await chatbot.addParameter("userInput", true); // set userInput
+                // await chatbot.addParameter(TiledeskChatbotConst.USER_INPUT, true); // set userInput
+                await chatbot.deleteParameter(TiledeskChatbotConst.USER_INPUT); // set userInput
                 await chatbot.addParameter(TiledeskChatbotConst.REQ_LAST_USER_TEXT_KEY, message.text); // DEPRECATED
                 await chatbot.addParameter(TiledeskChatbotConst.REQ_LAST_USER_TEXT_v2_KEY, message.text);
                 if (message.channel) {
@@ -835,7 +836,7 @@ class TiledeskChatbotUtil {
             "userLeadId",
             "lastUserText",
             TiledeskChatbotConst.REQ_REQUESTER_IS_AUTHENTICATED_KEY,
-            "userInput"
+            TiledeskChatbotConst.USER_INPUT
           ]
           let userParams = {};
           if (flowAttributes) {

package/package.json

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

package/tiledeskChatbotPlugs/DirectivesChatbotPlug.js

@@ -48,6 +48,7 @@ const { DirBrevo } = require('./directives/DirBrevo');
 const { DirAskGPTV2 } = require('./directives/DirAskGPTV2');
 const { DirAssistant } = require('./directives/DirAssistant');
 const { DirReplyV2 } = require('./directives/DirReplyV2');
+const { DirIfOnlineAgentsV2 } = require('./directives/DirIfOnlineAgentsV2');
 
 class DirectivesChatbotPlug {
 
@@ -378,6 +379,19 @@ class DirectivesChatbotPlug {
         // this.process(next_dir);
       });
     }
+    else if (directive_name === Directives.IF_ONLINE_AGENTS_V2) {
+      // console.log("...DirIfOnlineAgents")
+      new DirIfOnlineAgentsV2(context).execute(directive, async (stop) => {
+        if (stop) {
+          if (context.log) { console.log("Stopping Actions on:", JSON.stringify(directive));}
+          this.theend();
+        }
+        else {
+          let next_dir = await this.nextDirective(this.directives);
+          this.process(next_dir);
+        }
+      });
+    }
     else if (directive_name === Directives.FUNCTION_VALUE) {
       // console.log("...DirAssignFromFunction")
       new DirAssignFromFunction(context).execute(directive, async () => {

package/tiledeskChatbotPlugs/directives/DirIfOnlineAgentsV2.js

@@ -0,0 +1,399 @@
+// const { TiledeskClient } = require('@tiledesk/tiledesk-client');
+const { rejects } = require('assert');
+const { DirIntent } = require('./DirIntent');
+const axios = require("axios").default;
+let https = require("https");
+
+class DirIfOnlineAgentsV2 {
+
+  constructor(context) {
+    if (!context) {
+      throw new Error('context object is mandatory.');
+    }
+    this.context = context;
+    this.chatbot = context.chatbot;
+    this.tdclient = context.tdclient;
+    this.intentDir = new DirIntent(context);
+    this.log = context.log;
+  }
+
+  execute(directive, callback) {
+    let action;
+    if (directive.action) {
+      action = directive.action
+    }
+    else {
+      callback();
+      return;
+    }
+    this.go(action, (stop) => {
+      callback(stop);
+    });
+  }
+
+  async go(action, callback) {
+    console.log("(DirIfOnlineAgents) action:", action);
+    if (!action.trueIntent && !action.falseIntent) {
+      if (this.log) {
+        console.log("Error DirIfOnlineAgents: missing both action.trueIntent & action.falseIntent");
+      }
+      callback();
+      return;
+    }
+    const trueIntent = action.trueIntent;
+    const falseIntent = action.falseIntent;
+    if (this.log) {
+      console.log("(DirIfOnlineAgents) IfOnlineAgents:trueIntent:", trueIntent);
+      console.log("(DirIfOnlineAgents) IfOnlineAgents:falseIntent:", falseIntent);
+    }
+    const trueIntentAttributes = action.trueIntentAttributes;
+    const falseIntentAttributes = action.falseIntentAttributes;
+    let stopOnConditionMet = true; //action.stopOnConditionMet;
+
+    try {
+      const result = await this.openNow();
+      if (result && result.isopen) {
+        const selectedOption = action.selectedOption;
+        
+        let agents;
+        if (selectedOption === "currentDep") {
+          console.log("(DirIfOnlineAgents) selectedOption === currentDep. Current department:", this.context.departmentId);
+          agents = await this.getDepartmentAvailableAgents(this.context.departmentId);
+          console.log("(DirIfOnlineAgents) agents:", agents);
+        }
+        else if (selectedOption === "selectedDep") {
+          console.log("(DirIfOnlineAgents) selectedOption === selectedDep", action.selectedDepartmentId);
+          agents = await this.getDepartmentAvailableAgents(action.selectedDepartmentId);
+          console.log("(DirIfOnlineAgents) agents:", agents);
+        }
+        else { // if (checkAll) => go project-wide
+          console.log("(DirIfOnlineAgents) selectedOption === all");
+          agents = await this.getProjectAvailableAgents();
+          console.log("(DirIfOnlineAgents) agents:", agents);
+        }
+
+        if (agents && agents.length > 0) {
+          if (trueIntent) {
+            let intentDirective = DirIntent.intentDirectiveFor(trueIntent, trueIntentAttributes);
+            if (this.log) {console.log("agents (openHours) => trueIntent");}
+            this.intentDir.execute(intentDirective, () => {
+              callback(stopOnConditionMet);
+            });
+          }
+          else {
+            console.log("(DirIfOnlineAgents) No IfOnlineAgents trueIntent defined. callback()") // prod
+            this.chatbot.addParameter("flowError", "(If online Agents) No IfOnlineAgents success path defined.");
+            callback();
+            return;
+          }
+        }
+        else if (falseIntent) { // no agents available
+          let intentDirective = DirIntent.intentDirectiveFor(falseIntent, falseIntentAttributes);
+          if (this.log) {console.log("(DirIfOnlineAgents) !agents (openHours) => falseIntent", intentDirective);}
+          this.intentDir.execute(intentDirective, () => {
+            callback(stopOnConditionMet);
+          });
+        }
+        else {
+          if (this.log) {console.log("(DirIfOnlineAgents) Error: No falseIntent defined", intentDirective);}
+          this.chatbot.addParameter("flowError", "(If online Agents) No path for 'no available agents' defined.");
+          callback();
+        }
+      }
+    }
+    catch(err) {
+      console.error("(DirIfOnlineAgents) An error occurred:", err);
+      this.chatbot.addParameter("flowError", "(If online Agents) An error occurred: " + err);
+      callback();
+    }
+  }
+
+  async openNow() {
+    return new Promise( (resolve, reject) => {
+      this.tdclient.openNow(async (err, result) => {
+        if (this.log) {console.log("(DirIfOnlineAgents) openNow():", result);}
+        if (err) {
+          reject(err);
+        }
+        else {
+          resolve(result);
+        }
+      });
+    });
+  }
+
+  async getProjectAvailableAgents() {
+    return new Promise( (resolve, reject) => {
+      this.tdclient.getProjectAvailableAgents((err, agents) => {
+        if (err) {
+          reject(err);
+        }
+        else {
+          resolve(agents);
+        }
+      });
+    })
+  }
+
+  async getDepartmentAvailableAgents(depId) {
+    return new Promise( (resolve, reject) => {
+      this.tdclient.getDepartment(depId, async (error, dep) => {
+        if (error) {
+          reject(error);
+        }
+        else {
+          console.log("(DirIfOnlineAgents) got department:", JSON.stringify(dep));
+          const groupId = dep.id_group;
+          console.log("(DirIfOnlineAgents) department.groupId:", groupId);
+          try {
+            if (groupId) {
+              const group = await this.getGroup(groupId);
+              console.log("(DirIfOnlineAgents) got group info:", group);
+              if (group) {
+                if (group.members) {
+                  console.log("(DirIfOnlineAgents) group members ids:", group.members);
+                  // let group_members = await getTeammates(group.members);
+                  // console.log("group members details:", group_members);
+                  let all_teammates = await this.getAllTeammates();
+                  console.log("(DirIfOnlineAgents) all teammates:", all_teammates);
+                  if (all_teammates && all_teammates.length > 0){
+                    // [
+                    //   {
+                    //       "user_available": false,
+                    // ...
+                    //       "id_user": {
+                    //           "status": 100,
+                    //           "email": "michele@tiledesk.com",
+                    //           "firstname": "Michele",
+                    //           "lastname": "Pomposo",
+                    // ...
+                    //       },
+                    //       "role": "admin",
+                    //       "tags": [],
+                    //       "presence": {
+                    //           "status": "offline",
+                    //           "changedAt": "2023-11-16T12:37:31.990Z"
+                    //       },
+                    //       "isBusy": false
+                    //   }, ... ]
+                    // filter on availability
+                    console.log("(DirIfOnlineAgents) filtering available agents for group:", groupId);
+                    let available_agents = [];
+                    all_teammates.forEach((agent) => {
+                      console.log("Checking teammate:", agent.id_user._id, "(", agent.id_user.email ,") Available:", agent.user_available, ") with members:",group.members );
+                      if (agent.user_available === true && group.members.includes(agent.id_user._id)) {
+                        console.log("Adding teammate:", agent.id_user._id);
+                        available_agents.push(agent);
+                      }
+                    });
+                    console.log("(DirIfOnlineAgents) available agents in group:", available_agents);
+                    resolve(available_agents);
+                  }
+                }
+                else {
+                  this.chatbot.addParameter("flowError", "(If online Agents) Empty group:" + groupId);
+                  resolve([]);
+                }
+              }
+              else {
+                this.chatbot.addParameter("flowError", "(If online Agents) Error: no group for groupId:" + groupId);
+                resolve([]);
+              }
+            }
+            else {
+              // no group => assigned to all teammates
+              const agents = await this.getProjectAvailableAgents();
+              resolve(agents);
+            }
+          }
+          catch(error) {
+            console.error("(DirIfOnlineAgents) Error:", error);
+            reject(error);
+          }
+        }
+      });
+    });
+  }
+
+  // async getGroup(groupId, callback) {
+  //   return new Promise ( (resolve, reject) => {
+  //     const URL = `${this.APIURL}/${this.projectId}/groups/${groupId}`
+  //     const HTTPREQUEST = {
+  //       url: URL,
+  //       headers: {
+  //         'Content-Type' : 'application/json',
+  //         'Authorization': this.context.token
+  //       },
+  //       method: 'GET',
+  //       httpsOptions: this.httpsOptions
+  //     };
+  //     TiledeskClient.myrequest(
+  //       HTTPREQUEST,
+  //       function(err, resbody) {
+  //         if (err) {
+  //           reject(err);
+  //           if (callback) {
+  //             callback(err);
+  //           }
+  //         }
+  //         else {
+  //           resolve(resbody);
+  //           if (callback) {
+  //             callback(null, resbody);
+  //           }
+  //         }
+  //       }, this.log
+  //     );
+  //   });
+  // }
+
+  async getGroup(groupId, callback) {
+    return new Promise ( (resolve, reject) => {
+      const URL = `${this.context.TILEDESK_APIURL}/${this.context.projectId}/groups/${groupId}`
+      const HTTPREQUEST = {
+        url: URL,
+        headers: {
+          'Content-Type' : 'application/json',
+          'Authorization': this.fixToken(this.context.token)
+        },
+        method: 'GET',
+        httpsOptions: this.httpsOptions
+      };
+      this.#myrequest(
+        HTTPREQUEST,
+        function(err, resbody) {
+          if (err) {
+            reject(err);
+            if (callback) {
+              callback(err);
+            }
+          }
+          else {
+          //   {
+          //     "members": [
+          //         "62b317986993970035f0697e",
+          //         "5aaa99024c3b110014b478f0"
+          //     ],
+          //     "_id": "65ddec23fd8dc3003295cdd7",
+          //     "name": "Sales",
+          //     "trashed": false,
+          //     "id_project": "65203e12f8c0cf002cf4110b",
+          //     "createdBy": "5e09d16d4d36110017506d7f",
+          //     "createdAt": "2024-02-27T14:05:23.373Z",
+          //     "updatedAt": "2024-02-27T14:05:29.137Z",
+          //     "__v": 0
+          // }
+            resolve(resbody);
+            if (callback) {
+              callback(null, resbody);
+            }
+          }
+        }, this.log
+      );
+    });
+  }
+
+  async getAllTeammates(members, callback) {
+    return new Promise ( (resolve, reject) => {
+      const URL = `${this.context.TILEDESK_APIURL}/${this.context.projectId}/project_users`
+      const HTTPREQUEST = {
+        url: URL,
+        headers: {
+          'Content-Type' : 'application/json',
+          'Authorization': this.fixToken(this.context.token)
+        },
+        method: 'GET',
+        httpsOptions: this.httpsOptions
+      };
+      this.#myrequest(
+        HTTPREQUEST,
+        function(err, resbody) {
+          if (err) {
+            reject(err);
+            if (callback) {
+              callback(err);
+            }
+          }
+          else {
+          //   {
+          //     "members": [
+          //         "62b317986993970035f0697e",
+          //         "5aaa99024c3b110014b478f0"
+          //     ],
+          //     "_id": "65ddec23fd8dc3003295cdd7",
+          //     "name": "Sales",
+          //     "trashed": false,
+          //     "id_project": "65203e12f8c0cf002cf4110b",
+          //     "createdBy": "5e09d16d4d36110017506d7f",
+          //     "createdAt": "2024-02-27T14:05:23.373Z",
+          //     "updatedAt": "2024-02-27T14:05:29.137Z",
+          //     "__v": 0
+          // }
+            resolve(resbody);
+            if (callback) {
+              callback(null, resbody);
+            }
+          }
+        }, this.log
+      );
+    });
+  }
+
+  #myrequest(options, callback) {
+    if (this.log) {
+      console.log("API URL:", options.url);
+      console.log("** Options:", JSON.stringify(options));
+    }
+    let axios_options = {
+      url: options.url,
+      method: options.method,
+      params: options.params,
+      headers: options.headers
+    }
+    if (options.json !== null) {
+      axios_options.data = options.json
+    }
+    if (this.log) {
+      console.log("axios_options:", JSON.stringify(axios_options));
+    }
+    if (options.url.startsWith("https:")) {
+      const httpsAgent = new https.Agent({
+        rejectUnauthorized: false,
+      });
+      axios_options.httpsAgent = httpsAgent;
+    }
+    axios(axios_options)
+      .then((res) => {
+        if (this.log) {
+          console.log("Response for url:", options.url);
+          console.log("Response headers:\n", JSON.stringify(res.headers));
+        }
+        if (res && res.status == 200 && res.data) {
+          if (callback) {
+            callback(null, res.data);
+          }
+        }
+        else {
+          if (callback) {
+            callback(new Error("Response status is not 200"), null);
+          }
+        }
+      })
+      .catch((error) => {
+        if (callback) {
+          callback(error, null);
+        }
+      });
+  }
+
+  fixToken(token) {
+    if (token.startsWith('JWT ')) {
+      return token
+    }
+    else {
+      return 'JWT ' + token
+    }
+  }
+}
+
+module.exports = { DirIfOnlineAgentsV2 };

package/tiledeskChatbotPlugs/directives/DirReplyV2.js

@@ -3,8 +3,9 @@ const { TiledeskChatbot } = require('../../models/TiledeskChatbot');
 const { TiledeskChatbotConst } = require('../../models/TiledeskChatbotConst');
 const { TiledeskChatbotUtil } = require('../../models/TiledeskChatbotUtil');
 const { DirIntent } = require("./DirIntent");
-const { defaultOptions } = require('liquidjs');
+// const { defaultOptions } = require('liquidjs');
 const { DirMessageToBot } = require('./DirMessageToBot');
+const { v4: uuidv4 } = require('uuid');
 
 class DirReplyV2 {
 
@@ -84,13 +85,15 @@ class DirReplyV2 {
               const noInputIntent = action.noInputIntent;
               const noInputTimeout = action.noInputTimeout;
               if (this.log) { console.log("noInputTimeout found:", noInputTimeout); }
-              if (noInputTimeout > 0 && noInputTimeout < 300000) {
-                await this.chatbot.addParameter("userInput", false); // control variable. On each user input is set to true
-                if (this.log) {  console.log("Set userInput: false, checking...", await this.chatbot.getParameter("userInput")); }
+              if (noInputTimeout > 0 && noInputTimeout < 7776000) {
+                const timeout_id = uuidv4();
+                await this.chatbot.addParameter(TiledeskChatbotConst.USER_INPUT, timeout_id); // control variable. On each user input is removed
+                if (this.log) {  console.log("Set userInput: false, checking...", await this.chatbot.getParameter(TiledeskChatbotConst.USER_INPUT)); }
                 setTimeout(async () => {
                   if (this.log) { console.log("noinput timeout triggered!"); }
-                  let userInput = await this.chatbot.getParameter("userInput");
-                  if (!userInput) {
+                  const userInput = await this.chatbot.getParameter(TiledeskChatbotConst.USER_INPUT);
+                  if (this.log) {  console.log("got 'userInput':", userInput); }
+                  if (userInput && userInput === timeout_id) {
                     if (this.log) {  console.log("no 'userInput'. Executing noinput action:", noInputIntent); }
                     await this.chatbot.unlockIntent(this.requestId);
                     await this.chatbot.unlockAction(this.requestId);
@@ -100,6 +103,9 @@ class DirReplyV2 {
                       if (this.log) {  console.log("noinput action invoked", noinput_action); }
                     });
                   }
+                  else {
+                    if (this.log) {  console.log("skipping noinput action because of userInput", userInput); }
+                  }
                 }, noInputTimeout);
               }
             }

package/tiledeskChatbotPlugs/directives/Directives.js

@@ -48,6 +48,7 @@ class Directives {
   static PLAY_PROMPT = 'play_prompt';
   static GPT_ASSISTANT = 'gpt_assistant';
   static REPLY_V2 = 'replyv2';
+  static IF_ONLINE_AGENTS_V2 = "ifonlineagentsv2";
 
   // static WHEN_ONLINE_MOVE_TO_AGENT = "whenonlinemovetoagent"; // DEPRECATED?
   // static WHEN_OFFLINE_HOURS = "whenofflinehours"; // DEPRECATED // adds a message on top of the original message when offline hours opts: --replace