@tiledesk/tiledesk-tybot-connector 0.2.86 → 0.2.90

package/CHANGELOG.md

@@ -5,6 +5,21 @@
 available on:
  ▶️ https://www.npmjs.com/package/@tiledesk/tiledesk-tybot-connector
 
+# v0.2.90
+- Added voice flow attributes: dnis, callId, ani
+
+# v0.2.89
+- Added convertToNumber to operations in setAttribute
+- Added setAttributeV2 test
+
+# 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

package/TiledeskExpression.js

@@ -218,6 +218,10 @@ class TiledeskExpression {
             name: "roundAsNumber",
             applyPattern: "TiledeskMath.round(Number(#1))"
         },
+        "convertToNumber": {
+            name: "convertToNumber",
+            applyPattern: "Number(#1)"
+        },
         "JSONparse": {
             name: "JSONparse",
             applyPattern: "JSON.parse(String(#1))"

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,14 +597,26 @@ 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#")) {
+                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);
                     }
@@ -700,7 +715,7 @@ class TiledeskChatbotUtil {
                             const value_type = typeof value;
                             //if (projectId === "641864da99c1fb00131ba495") {console.log("641864da99c1fb00131ba495 > importing payload parameter:", key, "value:", value, "type:", value_type);}
                             //await chatbot.addParameter(key, String(value));
-                            console.log("Adding from message.attributes:", key, "->", value);
+                            // console.log("Adding from message.attributes:", key, "->", value);
                             await chatbot.addParameter(key, value);
                         }
                     }
@@ -708,6 +723,17 @@ class TiledeskChatbotUtil {
                         console.error("Error importing message payload in request variables:", err);
                     }
                 }
+
+                // voice-vxml attributes
+                if (message.attributes.dnis) {
+                    await chatbot.addParameter("dnis", message.attributes.dnis);
+                }
+                if (message.attributes.callId) {
+                    await chatbot.addParameter("callId", message.attributes.callId);
+                }
+                if (message.attributes.ani) {
+                    await chatbot.addParameter("ani", message.attributes.ani);
+                }
             }
             
             const _bot = chatbot.bot; // aka FaqKB

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tiledesk/tiledesk-tybot-connector",
-  "version": "0.2.86",
+  "version": "0.2.90",
   "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,22 @@ 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;
+      // it's important that all the lead's properties are immediatly updated in the current flow invocation so the updated values will be available in the next actions
+      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, () => {

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;

package/tiledeskChatbotPlugs/directives/DirSetAttributeV2.js

@@ -97,10 +97,28 @@ class DirSetAttributeV2 {
 
     async go(action, callback) {
         if (this.log) {console.log("(DirSetAttribute) action before filling:", JSON.stringify(action));}
+        if (action && !action.operation) {
+            if (this.log) {console.log("(SetAttributeV2) Error operation is mandatory");}
+            callback();
+        }
         if (action && action.operation && action.operation.operands) {
-            if (this.log) {console.log("filling in setattribute...");}
+            if (this.log) {console.log("(SetAttributeV2) filling in setattribute...");}
             await this.fillValues(action.operation.operands);
         }
+        console.log("action.operation.operands.length", action.operation.operands.length);
+        console.log("action.operation.operands[0].type", action.operation.operands[0].type);
+        
+        // FUN FACT: THIS TOOK A LOT OF EFFERT BUT IT WAS NEVER USED. YOU CAN SIMPLY CREATE A JSON ATTRIBUTE APPLYING
+        // JSONparse FUNCTION TO AN ATTRIBUTE.
+        if (action.operation.operands && action.operation.operands.length === 1 && action.operation.operands[0].type === "json") {
+            if (this.log) {console.log("(SetAttributeV2) setting json value...");}
+            console.log("(SetAttributeV2) setting json value... destination:", action.destination);
+            const json_value = JSON.parse(action.operation.operands[0].value);
+            console.log("(SetAttributeV2) json_value:", json_value);
+            await TiledeskChatbot.addParameterStatic(this.context.tdcache, this.context.requestId, action.destination, json_value);
+            callback();
+            return; // on json types no operations are permitted beyond assignment
+        }
         if (this.log) {console.log("filled in setattribute:", action.operation);}
         // let res = validate(action, schema);
         // if (res.errors) {
@@ -201,6 +219,44 @@ class DirSetAttributeV2 {
             console.error("Error while filling operands:", error);
         }
     }
+
+    convertOperandValues(operands) {
+        console.log("Converting operands:", operands);
+        // operation: {
+        //     operators: ["addAsNumber", "subtractAsNumber", "divideAsNumber", "multiplyAsNumber"],
+        //     operands: [
+        //         {
+        //             value: "previous",
+        //             isVariable: true,
+        //             type: "string"
+        //         }
+        //     ]
+        try {
+            operands.forEach(operand => {
+                if (operand.type) {
+                    console.log("Converting operands - operand.type:", operand.type.toLowerCase());
+                    if (operand.type.toLowerCase() === "number") {
+                        console.log("Converting operands - number");
+                        operand.value = Number(operand.value);
+                        console.log("new value:", operand.value);
+                        console.log("new value type:", typeof operand.value);
+                    }
+                    else if (operand.type.toLowerCase() === "json") {
+                        console.log("Converting operands - json, value =", operand.value);
+                        operand.value = JSON.parse(operand.value);
+                        console.log("new value:", operand.value);
+                        console.log("new value type:", typeof operand.value);
+                    }
+                    else {
+                        console.log("Converting operands - ??");
+                    }
+                }
+            });
+        }
+        catch(error) {
+            console.error("Error while converting operands:", error);
+        }
+    }
 }
 
 module.exports = { DirSetAttributeV2 };