@tiledesk/tiledesk-tybot-connector 0.2.67 → 0.2.68

package/CHANGELOG.md

@@ -5,6 +5,10 @@
 available on:
  ▶️ https://www.npmjs.com/package/@tiledesk/tiledesk-tybot-connector
 
+# v0.2.68
+- added flow attributes in replyv2
+- ReplyV2 now "re-forwards" the original message when the "no-match" connector is undefined (behaving exactly like the classic Reply)
+
 # v0.2.67
 - console.log crash fixed on noinput
 

package/index.js

@@ -369,49 +369,52 @@ router.get('/ext/reserved/parameters/requests/:requestid', async (req, res) => {
     res.send(parameters);
   }
   else {
-    const RESERVED = [
-      TiledeskChatbotConst.REQ_CHATBOT_NAME_KEY,
-      TiledeskChatbotConst.REQ_CHAT_URL,
-      TiledeskChatbotConst.REQ_CITY_KEY,
-      TiledeskChatbotConst.REQ_COUNTRY_KEY,
-      TiledeskChatbotConst.REQ_DEPARTMENT_ID_KEY,
-      TiledeskChatbotConst.REQ_DEPARTMENT_NAME_KEY,
-      TiledeskChatbotConst.REQ_END_USER_ID_KEY,
-      TiledeskChatbotConst.REQ_END_USER_IP_ADDRESS_KEY,
-      TiledeskChatbotConst.REQ_LAST_MESSAGE_ID_KEY,
-      TiledeskChatbotConst.REQ_LAST_USER_TEXT_KEY,
-      TiledeskChatbotConst.REQ_PROJECT_ID_KEY,
-      TiledeskChatbotConst.REQ_REQUEST_ID_KEY,
-      TiledeskChatbotConst.REQ_USER_AGENT_KEY,
-      TiledeskChatbotConst.REQ_USER_LANGUAGE_KEY,
-      TiledeskChatbotConst.REQ_USER_SOURCE_PAGE_KEY,
-      TiledeskChatbotConst.REQ_LAST_USER_MESSAGE_TYPE_KEY,
-      TiledeskChatbotConst.REQ_TRANSCRIPT_KEY,
-      TiledeskChatbotConst.REQ_LAST_USER_MESSAGE_KEY,
-      "lastUserImageURL", // image
-      "lastUserImageName", // image
-      "lastUserImageWidth", // image
-      "lastUserImageHeight", // image
-      "lastUserImageType", // image
-      "lastUserDocumentURL", // file
-      "lastUserDocumentName", // file
-      "lastUserDocumentType", // file
-      "ticketId",
-      TiledeskChatbotConst.REQ_CHAT_CHANNEL,
-      "user_lead_id",
-      "lastUserText",
-      TiledeskChatbotConst.REQ_REQUESTER_IS_AUTHENTICATED_KEY
-    ]
-    let userParams = {};
-    if (parameters) {
-      for (const [key, value] of Object.entries(parameters)) {
-        // console.log(key, value);
-        // There is a bug that moves the requestId as a key in request attributes, so: && !key.startsWith("support-group-")
-        if (!key.startsWith("_") && !RESERVED.some(e => e === key) && !key.startsWith("support-group-")) {
-          userParams[key] = value;
-        }
-      }
-    }
+    // const RESERVED = [
+    //   TiledeskChatbotConst.REQ_CHATBOT_NAME_KEY,
+    //   TiledeskChatbotConst.REQ_CHAT_URL,
+    //   TiledeskChatbotConst.REQ_CITY_KEY,
+    //   TiledeskChatbotConst.REQ_COUNTRY_KEY,
+    //   TiledeskChatbotConst.REQ_DEPARTMENT_ID_KEY,
+    //   TiledeskChatbotConst.REQ_DEPARTMENT_NAME_KEY,
+    //   TiledeskChatbotConst.REQ_END_USER_ID_KEY,
+    //   TiledeskChatbotConst.REQ_END_USER_IP_ADDRESS_KEY,
+    //   TiledeskChatbotConst.REQ_LAST_MESSAGE_ID_KEY,
+    //   TiledeskChatbotConst.REQ_LAST_USER_TEXT_KEY,
+    //   TiledeskChatbotConst.REQ_PROJECT_ID_KEY,
+    //   TiledeskChatbotConst.REQ_REQUEST_ID_KEY,
+    //   TiledeskChatbotConst.REQ_USER_AGENT_KEY,
+    //   TiledeskChatbotConst.REQ_USER_LANGUAGE_KEY,
+    //   TiledeskChatbotConst.REQ_USER_SOURCE_PAGE_KEY,
+    //   TiledeskChatbotConst.REQ_LAST_USER_MESSAGE_TYPE_KEY,
+    //   TiledeskChatbotConst.REQ_TRANSCRIPT_KEY,
+    //   TiledeskChatbotConst.REQ_LAST_USER_MESSAGE_KEY,
+    //   TiledeskChatbot.REQ_DECODED_JWT_KEY,
+    //   "lastUserImageURL", // image
+    //   "lastUserImageName", // image
+    //   "lastUserImageWidth", // image
+    //   "lastUserImageHeight", // image
+    //   "lastUserImageType", // image
+    //   "lastUserDocumentURL", // file
+    //   "lastUserDocumentName", // file
+    //   "lastUserDocumentType", // file
+    //   "ticketId",
+    //   TiledeskChatbotConst.REQ_CHAT_CHANNEL,
+    //   "user_lead_id",
+    //   "lastUserText",
+    //   TiledeskChatbotConst.REQ_REQUESTER_IS_AUTHENTICATED_KEY,
+    //   "userInput"
+    // ]
+    // let userParams = {};
+    // if (parameters) {
+    //   for (const [key, value] of Object.entries(parameters)) {
+    //     // console.log(key, value);
+    //     // There is a bug that moves the requestId as a key in request attributes, so: && !key.startsWith("support-group-")
+    //     if (!key.startsWith("_") && !RESERVED.some(e => e === key) && !key.startsWith("support-group-")) {
+    //       userParams[key] = value;
+    //     }
+    //   }
+    // }
+    TiledeskChatbotUtil.userFlowAttributes(parameters);
     res.send(userParams);
   }
 });

package/models/MockBotsDataSource.js

@@ -34,8 +34,12 @@ class MockBotsDataSource {
    * @returns an Array of matches
    */
   async getByExactMatch(botId, text) {
+    // console.log("text is:", text);
+    // console.log("this.data.bots[botId]:", this.data.bots[botId]);
     const intent_display_name = this.data.bots[botId].questions_intent[text];
+    // console.log("intent_display_name:", intent_display_name);
     if (intent_display_name) {
+      // console.log("intent by display name:", this.data.bots[botId].intents[intent_display_name]);
       return [this.data.bots[botId].intents[intent_display_name]];
     }
     return null;

package/models/TiledeskChatbot.js

@@ -254,6 +254,7 @@ class TiledeskChatbot {
       let faqs;
       try {
         faqs = await this.botsDataSource.getByExactMatch(this.botId, message.text);
+        if (this.log) {console.log("got faq by EXACT MATCH", faqs);}
       }
       catch (error) {
         console.error("An error occurred during exact match:", error);

package/models/TiledeskChatbotUtil.js

@@ -352,7 +352,7 @@ class TiledeskChatbotUtil {
                             let buttons = command.message.attributes.attachment.buttons;
                             
                             buttons.forEach(button => {
-                                if (button.type === "action" || button.type === "text") {
+                                if (button.type === "action") {
                                     // console.log("pushing button:", button);
                                     all_buttons.push(button);
                                 }
@@ -800,6 +800,56 @@ class TiledeskChatbotUtil {
         return isValid;
     }
 
+    static userFlowAttributes(flowAttributes) {
+        const RESERVED = [
+            TiledeskChatbotConst.REQ_CHATBOT_NAME_KEY,
+            TiledeskChatbotConst.REQ_CHAT_URL,
+            TiledeskChatbotConst.REQ_CITY_KEY,
+            TiledeskChatbotConst.REQ_COUNTRY_KEY,
+            TiledeskChatbotConst.REQ_DEPARTMENT_ID_KEY,
+            TiledeskChatbotConst.REQ_DEPARTMENT_NAME_KEY,
+            TiledeskChatbotConst.REQ_END_USER_ID_KEY,
+            TiledeskChatbotConst.REQ_END_USER_IP_ADDRESS_KEY,
+            TiledeskChatbotConst.REQ_LAST_MESSAGE_ID_KEY,
+            TiledeskChatbotConst.REQ_LAST_USER_TEXT_KEY,
+            TiledeskChatbotConst.REQ_PROJECT_ID_KEY,
+            TiledeskChatbotConst.REQ_REQUEST_ID_KEY,
+            TiledeskChatbotConst.REQ_USER_AGENT_KEY,
+            TiledeskChatbotConst.REQ_USER_LANGUAGE_KEY,
+            TiledeskChatbotConst.REQ_USER_SOURCE_PAGE_KEY,
+            TiledeskChatbotConst.REQ_LAST_USER_MESSAGE_TYPE_KEY,
+            TiledeskChatbotConst.REQ_TRANSCRIPT_KEY,
+            TiledeskChatbotConst.REQ_LAST_USER_MESSAGE_KEY,
+            TiledeskChatbotConst.REQ_DECODED_JWT_KEY,
+            "lastUserImageURL", // image
+            "lastUserImageName", // image
+            "lastUserImageWidth", // image
+            "lastUserImageHeight", // image
+            "lastUserImageType", // image
+            "lastUserDocumentURL", // file
+            "lastUserDocumentName", // file
+            "lastUserDocumentType", // file
+            "ticketId",
+            TiledeskChatbotConst.REQ_CHAT_CHANNEL,
+            "user_lead_id",
+            "userLeadId",
+            "lastUserText",
+            TiledeskChatbotConst.REQ_REQUESTER_IS_AUTHENTICATED_KEY,
+            "userInput"
+          ]
+          let userParams = {};
+          if (flowAttributes) {
+            for (const [key, value] of Object.entries(flowAttributes)) {
+              // console.log(key, value);
+              // There is a bug that moves the requestId as a key in request attributes, so: && !key.startsWith("support-group-")
+              if (!key.startsWith("_") && !RESERVED.some(e => e === key) && !key.startsWith("support-group-")) {
+                userParams[key] = value;
+              }
+            }
+          }
+          return userParams;
+    }
+
     /**
      * A stub to get the request parameters, hosted by tilebot on:
      * /${TILEBOT_ROUTE}/ext/parameters/requests/${requestId}?all

package/package.json

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

package/tiledeskChatbotPlugs/TildeskContextForCodeOrchestrator.js

@@ -0,0 +1,8 @@
+/**
+ * Only prototype code for the new "Code orchestrator"
+ */
+class Context {
+    constructor(env) {this.attributes = env;this.ops = {set: {},del: {} } }  setAttribute(key, value) { this.ops.set[key] = value; }
+    deleteAttribute(key) { this.ops.del[key] = true; }
+    allAttributes() { return this.attributes; }
+}

package/tiledeskChatbotPlugs/directives/DirMessageToBot.js

@@ -0,0 +1,154 @@
+let axios = require('axios');
+let https = require("https");
+const { v4: uuidv4 } = require('uuid');
+
+class DirMessageToBot {
+
+  constructor(context) {
+    if (!context) {
+      throw new Error('context object is mandatory.');
+    }
+    this.context = context;
+    this.API_ENDPOINT = context.TILEDESK_APIURL,
+    this.TILEBOT_ENDPOINT = context.TILEBOT_ENDPOINT;
+    this.supportRequest = context.supportRequest;
+    this.token = context.token;
+    this.log = context.log;
+    // let context =  {
+    //   projectId: projectId,
+    //   token: token,
+    //   supportRequest: supportRequest,
+    //   requestId: supportRequest.request_id,
+    //   TILEDESK_APIURL: API_URL,
+    //   TILEBOT_ENDPOINT: TILEBOT_ENDPOINT,
+    //   departmentId: depId,
+    //   tdcache: tdcache,
+    //   tdclient: tdclient,
+    //   log: true
+    // }
+  }
+
+  execute(directive, callback) {
+    // console.log("exec intent:", JSON.stringify(directive));
+    let action;
+    if (directive.action) {
+      // console.log("got intent action:", JSON.stringify(directive.action));
+      action = directive.action;
+    }
+    else {
+      console.error("Incorrect directive:", directive);
+      callback();
+      return;
+    }
+    this.go(action, (stop) => {
+      callback(stop);
+    });
+  }
+
+  go(action, callback) {
+    // console.log("message action intent:", action);
+    const message = action.message;
+    // const projectId = this.supportRequest.id_project;
+    // const requestId = this.supportRequest.request_id;
+    const botId = this.supportRequest.bot_id;
+
+    let outgoing_message = {
+      "payload": message,
+      "token": this.token
+    }
+    if (this.log) {console.log("sending message:", JSON.stringify(outgoing_message));}
+    let TILEBOT_ENDPOINT;
+    if (this.TILEBOT_ENDPOINT) {
+      TILEBOT_ENDPOINT = this.TILEBOT_ENDPOINT;
+    }
+    else {
+      TILEBOT_ENDPOINT = `${this.API_ENDPOINT}/modules/tilebot`
+    }
+    this.sendMessageToBot(TILEBOT_ENDPOINT, outgoing_message, botId, () => {
+      // console.log("(DirMessageToBot) sendMessageToBot() req_body sent");
+      callback(true);
+    });
+  }
+
+  /**
+   * A stub to send message to the "ext/botId" endpoint, hosted by tilebot on:
+   * /${TILEBOT_ROUTE}/ext/${botId}
+   *
+   * @param {Object} message. The message to send
+   * @param {string} botId. Tiledesk botId
+   * @param {string} token. User token
+   */
+  sendMessageToBot(CHATBOT_ENDPOINT, message, botId, callback) {
+    // const jwt_token = this.fixToken(token);
+    const url = `${CHATBOT_ENDPOINT}/ext/${botId}`;
+    // console.log("sendMessageToBot URL", url);
+    const HTTPREQUEST = {
+      url: url,
+      headers: {
+        'Content-Type' : 'application/json'
+      },
+      json: message,
+      method: 'POST'
+    };
+    this.myrequest(
+      HTTPREQUEST,
+      function(err, resbody) {
+        if (err) {
+          if (callback) {
+            callback(err);
+          }
+        }
+        else {
+          if (callback) {
+            callback(null, resbody);
+          }
+        }
+      }, false
+    );
+  }
+
+  myrequest(options, callback, log) {
+    if (this.log) {
+      console.log("API URL:", options.url);
+      console.log("** Options:", JSON.stringify(options));
+    }
+    let axios_options = {
+      url: options.url,
+      method: options.method,
+      data: options.json,
+      params: options.params,
+      headers: options.headers
+    }
+    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(TiledeskClient.getErr({message: "Response status not 200"}, options, res), null, null);
+        }
+      }
+    })
+    .catch( (error) => {
+      console.error("An error occurred:", error);
+      if (callback) {
+        callback(error, null, null);
+      }
+    });
+  }
+}
+
+module.exports = { DirMessageToBot };

package/tiledeskChatbotPlugs/directives/DirReplyV2.js

@@ -3,6 +3,8 @@ const { TiledeskChatbot } = require('../../models/TiledeskChatbot');
 const { TiledeskChatbotConst } = require('../../models/TiledeskChatbotConst');
 const { TiledeskChatbotUtil } = require('../../models/TiledeskChatbotUtil');
 const { DirIntent } = require("./DirIntent");
+const { defaultOptions } = require('liquidjs');
+const { DirMessageToBot } = require('./DirMessageToBot');
 
 class DirReplyV2 {
 
@@ -19,6 +21,7 @@ class DirReplyV2 {
     this.intentDir = new DirIntent(context);
     this.chatbot = context.chatbot;
     this.reply = context.reply;
+    this.originalMessage = context.message;
   }
 
   execute(directive, callback) {
@@ -72,7 +75,36 @@ class DirReplyV2 {
         if (this.log) { console.log("Action Buttons:", JSON.stringify(buttons)); }
         if (buttons && buttons.length > 0) {
           const locked = await this.lockUnlock(action); // first execution returns locked, then unlocked
-          if (!locked) {
+          if (locked) { // fist execution returns (just) locked
+            if (this.log) { console.log("first time pass!"); }
+            must_stop = true; // you must stop after next callbacks (in this flow) if there are buttons
+            // console.log("action:", action);
+            if (action.noInputIntent) {
+              if (this.log) { console.log("NoInputIntent found:", action.noInputIntent); }
+              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")); }
+                setTimeout(async () => {
+                  if (this.log) { console.log("noinput timeout triggered!"); }
+                  let userInput = await this.chatbot.getParameter("userInput");
+                  if (!userInput) {
+                    if (this.log) {  console.log("no 'userInput'. Executing noinput action:", noInputIntent); }
+                    await this.chatbot.unlockIntent(this.requestId);
+                    await this.chatbot.unlockAction(this.requestId);
+                    if (this.log) {  console.log("unlocked (for noInput) ReplyV2"); }
+                    let noinput_action = DirIntent.intentDirectiveFor(noInputIntent, null);
+                    this.intentDir.execute(noinput_action, () => {
+                      if (this.log) {  console.log("noinput action invoked", noinput_action); }
+                    });
+                  }
+                }, noInputTimeout);
+              }
+            }
+          }
+          else { // second execution
             if (this.log) { console.log("second pass! unlocked!"); }
             const last_user_text = await this.chatbot.getParameter(TiledeskChatbotConst.REQ_LAST_USER_TEXT_v2_KEY);
             if (this.log) { console.log("got last user text"); }
@@ -116,39 +148,31 @@ class DirReplyV2 {
                 return;
               }
               else {
-                // there is no "no-match", go on...
-                if (this.log) { console.log("callback(false) + return 3", current); }
-                callback(false);
+                // const defaultFallbackAction = { action: { intentName: "defaultFallback" } };
+
+                // console.log("re-send original message:",JSON.stringify(this.originalMessage));
+                const messageDir = new DirMessageToBot(this.context);
+                messageDir.execute( { action: { message: this.originalMessage }  }, () => {
+                  if (this.log) { console.log("messageDir invoked"); }
+                });
+                if (this.log) { console.log("callback(true) + return no-match", current); }
+                callback(true); // must_stop = true
                 return;
-              }
-            }
-          }
-          else {
-            if (this.log) { console.log("first time pass!"); }
-            must_stop = true; // you must stop after next callbacks (in this flow) if there are buttons
-            // console.log("action:", action);
-            if (action.noInputIntent) {
-              if (this.log) { console.log("NoInputIntent found:", action.noInputIntent); }
-              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")); }
-                setTimeout(async () => {
-                  if (this.log) { console.log("noinput timeout triggered!"); }
-                  let userInput = await this.chatbot.getParameter("userInput");
-                  if (!userInput) {
-                    if (this.log) {  console.log("no 'userInput'. Executing noinput action:", noInputIntent); }
-                    await this.chatbot.unlockIntent(this.requestId);
-                    await this.chatbot.unlockAction(this.requestId);
-                    if (this.log) {  console.log("unlocked (for noInput) ReplyV2"); }
-                    let noinput_action = DirIntent.intentDirectiveFor(noInputIntent, null);
-                    this.intentDir.execute(noinput_action, () => {
-                      if (this.log) {  console.log("noinput action invoked", noinput_action); }
-                    });
-                  }
-                }, noInputTimeout);
+
+                // const textAction = { action: { text: last_user_text } };
+                // console.log("textAction invoked:",textAction ); //, defaultFallbackAction);
+                // this.intentDir.execute( textAction, () => {
+                //   if (this.log) { console.log("textAction invoked", textAction); }
+                // });
+                // if (this.log) { console.log("callback(true) + return no-match", current); }
+                // callback(true); // must_stop = true
+                // return;
+
+
+                // // there is no "no-match", go on...
+                // if (this.log) { console.log("callback(false) + return 3", current); }
+                // callback(false);
+                // return;
               }
             }
           }
@@ -214,6 +238,12 @@ class DirReplyV2 {
       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;
       }
+      // userFlowAttributes
+      let userFlowAttributes = TiledeskChatbotUtil.userFlowAttributes(requestAttributes);
+      if (this.log) { console.log("userFlowAttributes:", userFlowAttributes); }
+      if (userFlowAttributes) {
+        message.attributes["flowAttributes"] = userFlowAttributes;
+      }
     }
     // send!
     let cleanMessage = message;
@@ -252,6 +282,7 @@ class DirReplyV2 {
 
   }
 
+
   async lockUnlock(action, callback) {
     let lockedAction = await this.chatbot.currentLockedAction(this.requestId);
     // console.log("(DirReplyV2) lockedAction:", lockedAction);