@tiledesk/tiledesk-tybot-connector 0.2.85 → 0.2.88

package/CHANGELOG.md

@@ -5,6 +5,18 @@
 available on:
  ▶️ https://www.npmjs.com/package/@tiledesk/tiledesk-tybot-connector
 
+# v0.2.88
+- Added DirContactUpdate (aka LeadUpdate). No test case added for LeadUpdate. Only testable with a validation test.
+- Fixed: Attribute parameters userFullname & userEmail now are able to "bypass" the request.lead not correctly updating on the same conversation. If updated in the flow (through LeadUpdate action), they will maintain their own value through the current conversation flow.
+
+# v0.2.87
+- Fixed DirAssistant empty error {}
+- Added to DirAssistant "lastMessageData" attribute (The message content original JSON structure useful to get annotations in messages, message type etc.)
+
+# v0.2.86
+- Added to ifOnlineAgents Action: ignoreProjectWideOperatingHours = action.ignoreOperatingHours;
+- Updated ifOnlineAgents with get available agents with 'raw' option
+
 # v0.2.85
 - Improved "If operating hours" action with time slots
 - Other fix (?)

package/models/MockBotsDataSource.js

@@ -78,7 +78,7 @@ class MockBotsDataSource {
   async getByIntentDisplayNameCache(botId, key, tdcache) {
     let faq = null;
     if (tdcache) {
-      // console.log("mock chache. anyway in mock getting faq from datasource...");
+      // console.log("mock cache. anyway in mock getting faq from datasource...");
       faq = await this.getByIntentDisplayName(botId, key);
       // console.log("faq found in datasource.:", JSON.stringify(faq));
     }

package/models/TiledeskChatbotUtil.js

@@ -436,6 +436,9 @@ class TiledeskChatbotUtil {
             if (fullName.trim() === chatbot_name) {
                 fullName = "bot:" + fullName;
             }
+            else {
+                fullName = "user:" + fullName;
+            }
             return "<" + fullName + ">";
         }
     }
@@ -594,23 +597,36 @@ class TiledeskChatbotUtil {
             //     await chatbot.addParameter("lastUserDocumentType", null);
             // }
             if (message && message.request && message.request.lead) {
-                console.log("lead found. lead.email:", message.request.lead.email, "lead.fullname:", message.request.lead.fullname)
-                if (message.request.lead.email) {
-                    await chatbot.addParameter(TiledeskChatbotConst.REQ_LEAD_EMAIL_KEY, message.request.lead.email);
+                if (chatbot.log) {console.log("lead found. lead.email:", message.request.lead.email, "lead.fullname:", message.request.lead.fullname)}
+                let currentLeadEmail = await chatbot.getParameter(TiledeskChatbotConst.REQ_LEAD_EMAIL_KEY);
+                if (chatbot.log) {console.log("You lead email from attributes:", currentLeadEmail, "message.request.lead.email:", message.request.lead.email);}
+                if (message.request.lead.email && !currentLeadEmail) {
+                    // worth saving
+                    if (chatbot.log) {console.log("worth saving email. lead found. lead.email:", message.request.lead.email, "lead.fullname:", message.request.lead.fullname)}
+                    try {
+                        await chatbot.addParameter(TiledeskChatbotConst.REQ_LEAD_EMAIL_KEY, message.request.lead.email);
+                    }
+                    catch(error) {
+                        console.error("Error on setting userEmail:", error);
+                    }
                 }
-                // if (message.request.lead.fullname && !message.request.lead.fullname.startsWith("guest#")) {
-                if (message.request.lead.fullname) {
+                let currentLeadName = await chatbot.getParameter(TiledeskChatbotConst.REQ_LEAD_USERFULLNAME_KEY);
+                if (chatbot.log) {console.log("You lead name from attributes:", currentLeadName, "message.request.lead.fullname:", message.request.lead.fullname)}
+                // if (message.request.lead.fullname && message.request.lead.fullname.startsWith("guest#") && !currentLeadName) {
+                // if (message.request.lead.fullname) {
+                if (message.request.lead.fullname && !currentLeadName) {
                     // worth saving
-                    console.log("worth saving. lead found. lead.email:", message.request.lead.email, "lead.fullname:", message.request.lead.fullname)
+                    if (chatbot.log) {console.log("worth saving fullname. lead found. lead.email:", message.request.lead.email, "lead.fullname:", message.request.lead.fullname)}
                     try {
                         await chatbot.addParameter(TiledeskChatbotConst.REQ_LEAD_USERFULLNAME_KEY, message.request.lead.fullname);
                     }
                     catch(error) {
                         console.error("Error on setting userFullname:", error);
                     }
-                }
-                else {
-                    // console.log("!lead.fullname");
+                // }
+                // else {
+                //     // console.log("!lead.fullname");
+                // }
                 }
                 // console.log("Getting userPhone:", JSON.stringify(message.request));
                 if (message.request.lead.phone) {

package/package.json

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

package/tiledeskChatbotPlugs/directives/DirAssistant.js

@@ -170,6 +170,7 @@ class DirAssistant {
       // process.exit(0);
       if (lastMessage !== null) {
         await TiledeskChatbot.addParameterStatic(this.context.tdcache, this.context.requestId, assignResultTo, lastMessage);
+        await TiledeskChatbot.addParameterStatic(this.context.tdcache, this.context.requestId, "lastMessageData", messages.data[0].content); // content is an array, see on this source end for messages structure example, including content. Ex get annotation[0]: content[0].text.annotations[0]
         if (trueIntent) {
           await this.#executeCondition(true, trueIntent, null, falseIntent, null);
           callback(true);
@@ -624,11 +625,11 @@ class DirAssistant {
             data =  err.response.data;
           }
           callback(
-            null, {
+            {
               status: status,
               data: data,
               error: errorMessage
-            }
+            }, data
           );
         }
       });
@@ -642,4 +643,88 @@ class DirAssistant {
 
 
 
-module.exports = { DirAssistant };
+module.exports = { DirAssistant };
+
+// Messages list response example
+
+/*
+{
+  "object": "list",
+  "data": [
+      {
+          "id": "msg_FfKaNU82uBYQU9gANFkKJ5Wi",
+          "object": "thread.message",
+          "created_at": 1721681044,
+          "assistant_id": null,
+          "thread_id": "thread_fN0rAdyJlPmN9uteMP0yWsCl",
+          "run_id": null,
+          "role": "user",
+          "content": [
+              {
+                  "type": "text",
+                  "text": {
+                      "value": "vendete sedie di altezza superiore o uguale a 50 cm?",
+                      "annotations": []
+                  }
+              }
+          ],
+          "file_ids": [],
+          "metadata": {}
+      },
+      {
+          "id": "msg_Ddxnqi7M9vvLdS9YYO4FHjVt",
+          "object": "thread.message",
+          "created_at": 1721680934,
+          "assistant_id": "asst_qNjiwCVxo3kL2mnN1QyP50Zb",
+          "thread_id": "thread_fN0rAdyJlPmN9uteMP0yWsCl",
+          "run_id": "run_k8mPIrZPnsO0hAiezD9y2f1t",
+          "role": "assistant",
+          "content": [
+              {
+                  "type": "text",
+                  "text": {
+                      "value": "Una delle best practices raccomandate per garantire un alto livello di sicurezza informatica per la linea di prodotti \"boss\" è la seguente:\n\n- Aggiornare i dispositivi con l'ultima versione del firmware disponibile. È possibile consultare il portale KSA per verificare la disponibilità degli aggiornamenti【6:0†source】.\n\nSe hai altri dubbi o necessiti di ulteriori informazioni, non esitare a chiedere!",
+                      "annotations": [
+                          {
+                              "type": "file_citation",
+                              "text": "【6:0†source】",
+                              "start_index": 305,
+                              "end_index": 317,
+                              "file_citation": {
+                                  "file_id": "file-dwR6qSwVUIrhImd9espzExGw",
+                                  "quote": ""
+                              }
+                          }
+                      ]
+                  }
+              }
+          ],
+          "file_ids": [],
+          "metadata": {}
+      },
+      {
+          "id": "msg_ng244T4mymroFWZ912r9DvWZ",
+          "object": "thread.message",
+          "created_at": 1721680931,
+          "assistant_id": null,
+          "thread_id": "thread_fN0rAdyJlPmN9uteMP0yWsCl",
+          "run_id": null,
+          "role": "user",
+          "content": [
+              {
+                  "type": "text",
+                  "text": {
+                      "value": "dimmi una delle best practices  che conosci",
+                      "annotations": []
+                  }
+              }
+          ],
+          "file_ids": [],
+          "metadata": {}
+      }
+  ],
+  "first_id": "msg_FfKaNU82uBYQU9gANFkKJ5Wi",
+  "last_id": "msg_ng244T4mymroFWZ912r9DvWZ",
+  "has_more": false
+}
+*/

package/tiledeskChatbotPlugs/directives/DirContactUpdate.js

@@ -54,8 +54,21 @@ class DirContactUpdate {
     const filler = new Filler();
     let updateProperties = {}
     for (const [key, value] of Object.entries(contactProperties)) {
-      updateProperties[key] = filler.fill(value, requestAttributes);
-      if (this.log) {console.log("(DirContactUpdate) updating property:", key, "value:", value); }
+      let filled_value = filler.fill(value, requestAttributes);
+      if (this.log) {console.log("(DirContactUpdate) setting property key:",key, "with value:", value, "filled value:", filled_value); }
+      updateProperties[key] = filled_value;
+      if (key === "fullname") {
+        await this.context.chatbot.addParameter(TiledeskChatbotConst.REQ_LEAD_USERFULLNAME_KEY, filled_value);
+        if (this.log) {console.log("(DirContactUpdate) updating attribute:",TiledeskChatbotConst.REQ_LEAD_USERFULLNAME_KEY, "with property key:", key, "and value:", filled_value); }
+      }
+      else if ( key === "email") {
+        await this.context.chatbot.addParameter(TiledeskChatbotConst.REQ_LEAD_EMAIL_KEY, filled_value);
+        if (this.log) {console.log("(DirContactUpdate) updating attribute:",TiledeskChatbotConst.REQ_LEAD_EMAIL_KEY, "with property key:", key, "and value:", filled_value); }
+      }
+      // else if (key === "phone") {
+      //   static REQ_USER_PHONE_KEY = "userPhone";
+      // }
+      if (this.log) {console.log("(DirContactUpdate) updating property:", key, "value:", filled_value); }
     }
     const leadId = requestAttributes[TiledeskChatbotConst.REQ_USER_LEAD_ID_KEY];
     this.tdclient.updateLead(leadId, updateProperties, null, null, () => {
@@ -63,33 +76,34 @@ class DirContactUpdate {
       // send hidden info to update widget lead fullname only if it is a conversation!
       if (this.log) {console.log("(DirContactUpdate) requestId:", this.requestId); }
       if (this.log) {console.log("(DirContactUpdate) updateProperties:", updateProperties); }
-      if (this.log) {console.log("(DirContactUpdate) updateProperties['userFullname']:", updateProperties['userFullname']); }
-      if (this.requestId.startsWith("support-group") && updateProperties['userFullname']) {
-        if (this.log) {console.log("(DirContactUpdate) send hidden info to update widget lead fullname"); }
-        const userFullname = updateProperties['userFullname'];
-        const updateLeadDataOnWidgetMessage = {
-          type: "text",
-          text: "Updated lead fullname on widget with: " + userFullname,
-          attributes: {
-            // subtype: "info",
-            updateUserFullname: userFullname
-          }
-        };
-        if (this.log) {console.log("(DirContactUpdate) sending updateLeadDataOnWidgetMessage:", updateLeadDataOnWidgetMessage); }
-        this.context.tdclient.sendSupportMessage(
-          this.requestId,
-          updateLeadDataOnWidgetMessage,
-          (err) => {
-            if (err) {
-              console.error("(DirContactUpdate) Error sending reply:", err);
-            }
-            if (this.log) {console.log("(DirContactUpdate) hidden message sent:", updateLeadDataOnWidgetMessage);}
-            callback();
-        });
-      }
-      else {
-        callback();
-      }
+      if (this.log) {console.log("(DirContactUpdate) updateProperties['fullname']:", updateProperties['fullname']); }
+      callback();
+      // if (this.requestId.startsWith("support-group") && updateProperties['userFullname']) {
+      //   if (this.log) {console.log("(DirContactUpdate) send hidden info to update widget lead fullname"); }
+      //   const userFullname = updateProperties['fullname'];
+      //   const updateLeadDataOnWidgetMessage = {
+      //     type: "text",
+      //     text: "Updated lead fullname on widget with: " + userFullname,
+      //     attributes: {
+      //       // subtype: "info",
+      //       updateUserFullname: userFullname
+      //     }
+      //   };
+      //   if (this.log) {console.log("(DirContactUpdate) sending updateLeadDataOnWidgetMessage:", updateLeadDataOnWidgetMessage); }
+      //   this.context.tdclient.sendSupportMessage(
+      //     this.requestId,
+      //     updateLeadDataOnWidgetMessage,
+      //     (err) => {
+      //       if (err) {
+      //         console.error("(DirContactUpdate) Error sending reply:", err);
+      //       }
+      //       if (this.log) {console.log("(DirContactUpdate) hidden message sent:", updateLeadDataOnWidgetMessage);}
+      //       callback();
+      //   });
+      // }
+      // else {
+      //   callback();
+      // }
     });
   }
 }

package/tiledeskChatbotPlugs/directives/DirIfOnlineAgentsV2.js

@@ -52,8 +52,24 @@ class DirIfOnlineAgentsV2 {
     let stopOnConditionMet = true; //action.stopOnConditionMet;
 
     try {
-      const result = await this.openNow();
-      if (result && result.isopen) {
+      const ignoreProjectWideOperatingHours = action.ignoreOperatingHours;
+      let isOpen = false;
+      if (ignoreProjectWideOperatingHours === true) {
+        // always go on to only check agents availability
+        isOpen = true;
+      }
+      else {
+        const result = await this.openNow();
+        if (result && result.isopen) {
+          isOpen = true;
+        }
+        else {
+          isOpen = false;
+        }
+      }
+      
+      // if (result && result.isopen) {
+      if (isOpen === true) { // always true if ignoreProjectWideOperatingHours = true
         const selectedOption = action.selectedOption;
         
         let agents;
@@ -102,11 +118,10 @@ class DirIfOnlineAgentsV2 {
         }
         else { // if (checkAll) => go project-wide
           if (this.log) {console.log("(DirIfOnlineAgents) selectedOption === all"); }
-          agents = await this.getProjectAvailableAgents();
+          agents = await this.getProjectAvailableAgents(true);
           if (this.log) {console.log("(DirIfOnlineAgents) agents:", agents); }
         }
 
-        console.log("anyway qui...");
         if (agents && agents.length > 0) {
           if (trueIntent) {
             let intentDirective = DirIntent.intentDirectiveFor(trueIntent, trueIntentAttributes);
@@ -134,6 +149,18 @@ class DirIfOnlineAgentsV2 {
           this.chatbot.addParameter("flowError", "(If online Agents) No path for 'no available agents' defined.");
           callback();
         }
+      } else {
+        if (falseIntent) {
+          let intentDirective = DirIntent.intentDirectiveFor(falseIntent, falseIntentAttributes);
+          if (this.log) {console.log("!agents (!openHours) => falseIntent");}
+          console.log("!agents (!openHours) => falseIntent BECAUSE CLOSED"); //PROD
+          this.intentDir.execute(intentDirective, () => {
+            callback();
+          });
+        }
+        else {
+          callback();
+        }
       }
     }
     catch(err) {
@@ -157,19 +184,51 @@ class DirIfOnlineAgentsV2 {
     });
   }
 
-  async getProjectAvailableAgents() {
+  async getProjectAvailableAgents(raw, callback) {
     return new Promise( (resolve, reject) => {
-      this.tdclient.getProjectAvailableAgents((err, agents) => {
-        if (err) {
-          reject(err);
-        }
-        else {
-          resolve(agents);
-        }
-      });
-    })
+      const URL = `${this.context.TILEDESK_APIURL}/projects/${this.context.projectId}/users/availables?raw=${raw}`
+      const HTTPREQUEST = {
+        url: URL,
+        headers: {
+          'Content-Type' : 'application/json',
+          'Authorization': this.fixToken(this.context.token)
+        },
+        // json: true,
+        method: 'GET',
+      };
+      this.#myrequest(
+        HTTPREQUEST,
+        function(err, resbody) {
+          if (err) {
+            if (callback) {
+              callback(err);
+            }
+            reject(err);
+          }
+          else {
+            if (callback) {
+              callback(null, resbody);
+            }
+            resolve(resbody);
+          }
+        }, this.log);
+    });
+    
   }
 
+  // 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) => {
@@ -237,7 +296,7 @@ class DirIfOnlineAgentsV2 {
             }
             else {
               // no group => assigned to all teammates
-              const agents = await this.getProjectAvailableAgents();
+              const agents = await this.getProjectAvailableAgents(true);
               resolve(agents);
             }
           }

package/tiledeskChatbotPlugs/directives/DirIfOpenHours.js

@@ -1,6 +1,7 @@
 // const { TiledeskClient } = require('@tiledesk/tiledesk-client');
 let axios = require('axios');
 const { DirIntent } = require('./DirIntent');
+let https = require("https");
 const ms = require('minimist-string');
 
 class DirIfOpenHours {
@@ -91,8 +92,8 @@ class DirIfOpenHours {
     }
     
     let slot_id = null;
-    if (action.slot_id) {
-      slot_id = action.slot_id;
+    if (action.slotId) {
+      slot_id = action.slotId;
     }
     
     const server_base_url = process.env.API_ENDPOINT || process.env.API_URL;

package/tiledeskChatbotPlugs/directives/DirRandomReply.js

@@ -78,12 +78,12 @@ class DirRandomReply {
         message.attributes = {}
       }
       // Reserved names: userEmail, userFullname
-      if (requestVariables['userEmail']) {
-          message.attributes.updateUserEmail = requestVariables['userEmail'];
-      }
-      if (requestVariables['userFullname']) {
-        message.attributes.updateUserFullname = requestVariables['userFullname'];
-      }
+      // if (requestVariables['userEmail']) {
+      //     message.attributes.updateUserEmail = requestVariables['userEmail'];
+      // }
+      // if (requestVariables['userFullname']) {
+      //   message.attributes.updateUserFullname = requestVariables['userFullname'];
+      // }
     }
     // send!
     if (this.log) {console.log("Reply:", JSON.stringify(message))};

package/tiledeskChatbotPlugs/directives/DirReply.js

@@ -94,12 +94,12 @@ class DirReply {
         message.attributes = {}
       }
       // Reserved names: userEmail, userFullname
-      if (requestAttributes['userEmail']) {
-          message.attributes.updateUserEmail = requestAttributes['userEmail'];
-      }
-      if (requestAttributes['userFullname']) {
-        message.attributes.updateUserFullname = requestAttributes['userFullname'];
-      }
+      // if (requestAttributes['userEmail']) {
+      //     message.attributes.updateUserEmail = requestAttributes['userEmail'];
+      // }
+      // if (requestAttributes['userFullname']) {
+      //   message.attributes.updateUserFullname = requestAttributes['userFullname'];
+      // }
       // intent_info
       if (this.context.reply && this.context.reply.attributes && this.context.reply.attributes.intent_info) {
         message.attributes.intentName = this.context.reply.attributes.intent_info.intent_name;

package/tiledeskChatbotPlugs/directives/DirReplyV2.js

@@ -234,12 +234,12 @@ class DirReplyV2 {
         message.attributes = {}
       }
       // Reserved names: userEmail, userFullname
-      if (requestAttributes['userEmail']) {
-          message.attributes.updateUserEmail = requestAttributes['userEmail'];
-      }
-      if (requestAttributes['userFullname']) {
-        message.attributes.updateUserFullname = requestAttributes['userFullname'];
-      }
+      // if (requestAttributes['userEmail']) {
+      //     message.attributes.updateUserEmail = requestAttributes['userEmail'];
+      // }
+      // if (requestAttributes['userFullname']) {
+      //   message.attributes.updateUserFullname = requestAttributes['userFullname'];
+      // }
       // intent_info
       if (this.context.reply && this.context.reply.attributes && this.context.reply.attributes.intent_info) {
         message.attributes.intentName = this.context.reply.attributes.intent_info.intent_name;