@tiledesk/tiledesk-tybot-connector 0.2.66-rc3 → 0.2.66

package/CHANGELOG.md

@@ -5,14 +5,15 @@
 available on:
  ▶️ https://www.npmjs.com/package/@tiledesk/tiledesk-tybot-connector
 
-# v0.2.66-rc3
+# v0.2.66
 - changed updateQuotes method
 - fix missing model in updateQuote
+- added ReplyV2
 
 # v0.2.66-rc1
 - fix missing model in updateQuote
 
-# v0.2.65
+# v0.2.65 - online
 - fix OPENAI_APIKEY: removed Bearer prefix
 
 # v0.2.64

package/models/TiledeskChatbot.js

@@ -81,6 +81,7 @@ 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) {

package/models/TiledeskChatbotUtil.js

@@ -336,6 +336,51 @@ class TiledeskChatbotUtil {
         }
     }
 
+    static allReplyButtons(message) {
+        let all_buttons = [];
+        if (message.attributes && message.attributes.commands) {
+            // console.log("message.attributes ok")
+            let commands = message.attributes.commands;
+            if (commands.length > 0) {
+                // console.log("commands ok", commands.length)
+                for (let i = 0; i < commands.length; i++) {
+                    let command = commands[i];
+                    // console.log("got command:", command)s
+                    if (command.type === 'message' && command.message) {
+                        if (command.message.attributes && command.message.attributes.attachment && command.message.attributes.attachment.buttons && command.message.attributes.attachment.buttons.length > 0){
+                            // console.log("command with buttons ok:")
+                            let buttons = command.message.attributes.attachment.buttons;
+                            
+                            buttons.forEach(button => {
+                                if (button.type === "action" || button.type === "text") {
+                                    // console.log("pushing button:", button);
+                                    all_buttons.push(button);
+                                }
+                            });
+                        }
+                    }
+                }
+            }
+        }
+        return all_buttons;
+    }
+
+    static buttonByText(text, buttons) {
+        if (buttons === null || text === null) {
+            return null;
+        }
+        let search_text = text.toLowerCase();
+        let selected_button = null;
+        for (let i = 0; i < buttons.length; i++) {
+            const button = buttons[i];
+            if (button.value !== null && button.value.toLowerCase() === search_text) {
+                selected_button = button;
+                break; 
+            }
+        }
+        return selected_button;
+    }
+    
     static async updateConversationTranscript(chatbot, message) {
         if (!message || !message.senderFullname) { // not a conversation, can it be an Automation invocation?
             return null;
@@ -451,6 +496,7 @@ class TiledeskChatbotUtil {
             }
             
             if (message.text && message.sender !== "_tdinternal") {
+                await chatbot.addParameter("userInput", true); // 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) {

package/package.json

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

package/tiledeskChatbotPlugs/DirectivesChatbotPlug.js

@@ -47,6 +47,7 @@ const { DirCustomerio } = require('./directives/DirCustomerio');
 const { DirBrevo } = require('./directives/DirBrevo');
 const { DirAskGPTV2 } = require('./directives/DirAskGPTV2');
 const { DirAssistant } = require('./directives/DirAssistant');
+const { DirReplyV2 } = require('./directives/DirReplyV2');
 
 class DirectivesChatbotPlug {
 
@@ -293,6 +294,19 @@ class DirectivesChatbotPlug {
         this.process(next_dir);
       });
     }
+    else if (directive_name === Directives.REPLY_V2) {
+      // console.log("...DirReplyV2");
+      new DirReplyV2(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.DTMF_FORM) {
       // console.log("...DirReply");
       new DirReply(context).execute(directive, async () => {

package/tiledeskChatbotPlugs/directives/DirAssistant.js

@@ -125,7 +125,7 @@ class DirAssistant {
     let apikey = await this.getGPT_APIKEY();
     if (this.log) {console.log("apikey:", apikey);}
     if (!apikey) {
-      const reply = "DirAssistant gptkey is mandatory in Integrations";
+      const reply = "OpenAI APIKEY is mandatory for ChatGPT Assistants. Add your personal OpenAI APIKEY in Settings > Integrations";
       if (this.log) { console.error(reply); };
       await TiledeskChatbot.addParameterStatic(this.context.tdcache, this.context.requestId, assignErrorTo, reply);
       if (falseIntent) {

package/tiledeskChatbotPlugs/directives/DirReplyV2.js

@@ -0,0 +1,289 @@
+const { Filler } = require('../Filler');
+const { TiledeskChatbot } = require('../../models/TiledeskChatbot');
+const { TiledeskChatbotConst } = require('../../models/TiledeskChatbotConst');
+const { TiledeskChatbotUtil } = require('../../models/TiledeskChatbotUtil');
+const { DirIntent } = require("./DirIntent");
+
+class DirReplyV2 {
+
+  constructor(context) {
+    if (!context) {
+      throw new Error('context object is mandatory.');
+    }
+    this.context = context;
+    this.projectId = context.projectId;
+    this.requestId = context.requestId;
+    this.token = context.token;
+    this.tdcache = context.tdcache;
+    this.log = context.log;
+    this.intentDir = new DirIntent(context);
+    this.chatbot = context.chatbot;
+    this.reply = context.reply;
+  }
+
+  execute(directive, callback) {
+    let action;
+    if (directive.action) {
+      action = directive.action;
+      if (!action.attributes) {
+        action.attributes = {}
+      }
+      action.attributes.fillParams = true;
+    }
+    else {
+      console.error("Incorrect directive (no action provided):", directive);
+      callback();
+      return;
+    }
+    this.go(action, (stop) => {
+      callback(stop);
+    });
+  }
+
+  async go(action, callback) {
+    if (this.log) { console.log("ReplyV2 action!", JSON.stringify(action)); }
+    const message = action;
+
+    let current; // debug only
+    if (this.log) {
+      if (message.attributes.commands[1].message.text) {
+        current = message.attributes.commands[1].message.text
+      }
+      console.log("current:", current);
+    }
+    let must_stop = false;
+    // fill
+    let requestAttributes = null;
+    if (this.tdcache) {
+      requestAttributes = 
+      await TiledeskChatbot.allParametersStatic(
+        this.tdcache, this.requestId
+      );
+      if (this.log) {
+        for (const [key, value] of Object.entries(requestAttributes)) {
+          const value_type = typeof value;
+        }
+      }
+
+      try {
+        // lock/unlock + no-match
+        // get buttons if available
+        const buttons = TiledeskChatbotUtil.allReplyButtons(message);
+        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 (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"); }
+            const button = TiledeskChatbotUtil.buttonByText(last_user_text, buttons);
+            if (this.log) { console.log("button found", JSON.stringify(button)); }
+            // invoke button
+            if (button && button.action) {
+              if (this.log) { console.log("moving to button action", button.action); }
+              let button_action = DirIntent.intentDirectiveFor(button.action, null);
+              if (this.log) { console.log("action with .intentName:", button_action); }
+              this.intentDir.execute(button_action, () => {
+                if (this.log) { console.log("action invoked", button_action); }
+              });
+              if (this.log) { console.log("callback(true) + return", current); }
+              callback(true); // must_stop = true
+              return;
+            }
+            else { // no match (treating text buttons as no-match for the moment)
+              // if noMatchIntent invoke
+              // const button = TiledeskChatbotUtil.buttonByText("nomatch", buttons);
+              if (this.log) { console.log("nomatch button found", JSON.stringify(button)); }
+              // // invoke button
+              // if (button && button.action) {
+              //   console.log("moving to nomatch action", button.action);
+              //   let button_action = DirIntent.intentDirectiveFor(button.action, null);
+              //   this.intentDir.execute(button_action, () => {
+              //     console.log("nomatch action invoked", button_action);
+              //   });
+              //   console.log("callback(true) + return 2", current);
+              //   callback(true);
+              //   return;
+              // }
+              if (action.noMatchIntent) {
+                if (this.log) { console.log("moving to nomatch action", action.noMatchIntent); }
+                let nomatch_action = DirIntent.intentDirectiveFor(action.noMatchIntent, null);
+                this.intentDir.execute(nomatch_action, () => {
+                  if (this.log) { console.log("nomatch action invoked", nomatch_action); }
+                });
+                if (this.log) { console.log("callback(true) + return no-match", current); }
+                callback(true); // must_stop = true
+                return;
+              }
+              else {
+                // there is no "no-match", go on...
+                if (this.log) { console.log("callback(false) + return 3", current); }
+                callback(false);
+                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) {  onsole.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);
+              }
+            }
+          }
+        }
+      }
+      catch(error) {
+        console.error("Error in DirReplyV2:", error);
+      }
+
+      
+      if (this.log) { console.log("proceding normally to render and send the reply", current); }
+      const filler = new Filler();
+      // fill text attribute
+      message.text = filler.fill(message.text, requestAttributes);
+      if (message.metadata) {
+        if (this.log) {console.log("filling message 'metadata':", JSON.stringify(message.metadata));}
+        if (message.metadata.src) {
+          message.metadata.src = filler.fill(message.metadata.src, requestAttributes);
+        }
+        if (message.metadata.name) {
+          message.metadata.name = filler.fill(message.metadata.name, requestAttributes);
+        }
+      }
+      if (this.log) {console.log("filling commands'. Message:", JSON.stringify(message));}
+      if (message.attributes && message.attributes.commands) {
+        if (this.log) {console.log("filling commands'. commands found.");}
+        let commands = message.attributes.commands;
+        if (this.log) {console.log("commands:", JSON.stringify(commands), commands.length);}
+        if (commands.length > 0) {
+          if (this.log) {console.log("commands' found");}
+          for (let i = 0; i < commands.length; i++) {
+            let command = commands[i];
+            if (command.type === 'message' && command.message && command.message.text) {
+              command.message.text = filler.fill(command.message.text, requestAttributes);
+              TiledeskChatbotUtil.fillCommandAttachments(command, requestAttributes, this.log);
+              if (this.log) {console.log("command filled:", command.message.text);}
+            }
+          }
+        }
+      }
+
+      // EVALUATE EXPRESSION AND REMOVE BASED ON EVALUATION
+      if (this.log) {console.log("message before filters:", JSON.stringify(message));}
+      if (message.attributes && message.attributes.commands) {
+        if (this.log) {console.log("filterOnVariables...on commands", JSON.stringify(message.attributes.commands));}
+        if (this.log) {console.log("filterOnVariables...on attributes", requestAttributes);}
+        // TiledeskChatbotUtil.filterOnVariables(message.attributes.commands, requestAttributes);
+        TiledeskChatbotUtil.filterOnVariables(message, requestAttributes);
+      }
+
+      // temporary send back of reserved attributes
+      if (!message.attributes) {
+        message.attributes = {}
+      }
+      // Reserved names: userEmail, 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;
+      }
+    }
+    // send!
+    let cleanMessage = message;
+    // cleanMessage = TiledeskChatbotUtil.removeEmptyReplyCommands(message);
+    // if (!TiledeskChatbotUtil.isValidReply(cleanMessage)) {
+    //   console.log("invalid message", cleanMessage);
+    //   callback(); // cancel reply operation
+    //   return;
+    // }
+    // console.log("valid message!", cleanMessage);
+    cleanMessage.senderFullname = this.context.chatbot.bot.name;
+    if (this.log) {console.log("Reply:", JSON.stringify(cleanMessage))};
+    await TiledeskChatbotUtil.updateConversationTranscript(this.context.chatbot, cleanMessage);
+    this.context.tdclient.sendSupportMessage(
+      this.requestId,
+      cleanMessage,
+      (err) => {
+        if (err) {
+          console.error("Error sending reply:", err);
+        }
+        if (this.log) {console.log("Reply message sent");}
+        const delay = TiledeskChatbotUtil.totalMessageWait(cleanMessage);
+        // console.log("got total delay:", delay)
+        if (delay > 0 && delay <= 30000) { // prevent long delays
+          if (this.log) { console.log("start timeout callback(" + must_stop + ") for:", current); }
+          setTimeout(async () => {
+            if (this.log) { console.log("callback(" + must_stop + ") after delay", current); }
+            callback(must_stop);
+          }, delay);
+        }
+        else {
+          // console.log("invalid delay.")
+          callback(must_stop);
+        }
+    });
+
+  }
+
+  async lockUnlock(action, callback) {
+    let lockedAction = await this.chatbot.currentLockedAction(this.requestId);
+    // console.log("(DirReplyV2) lockedAction:", lockedAction);
+    if (!lockedAction) {
+      // console.log("(DirReplyV2) !lockedAction");
+      const intent_name = this.reply.attributes.intent_info.intent_name
+      const actionId = action["_tdActionId"];
+      // console.log("(DirReplyV2) intent_name:", intent_name);
+      // console.log("(DirReplyV2) actionId:", actionId);
+      await this.chatbot.lockIntent(this.requestId, intent_name);
+      // console.log("(DirReplyV2) lockIntent");
+      await this.chatbot.lockAction(this.requestId, actionId);
+      // console.log("(DirReplyV2) lockAction");
+      let _lockedAction = await this.chatbot.currentLockedAction(this.requestId);
+      let _lockedIntent = await this.chatbot.currentLockedIntent(this.requestId);
+      // console.log("(DirReplyV2) _lockedAction", _lockedAction);
+      // console.log("(DirReplyV2) _lockedIntent", _lockedIntent);
+      // callback();
+      return true;
+    } else {
+      try {
+        await this.chatbot.unlockIntent(this.requestId);
+        await this.chatbot.unlockAction(this.requestId);
+        // console.log("unlocked ReplyV2");
+        return false;
+      }
+      catch(e) {
+        console.error("Error", e);
+      }
+    }
+  }
+
+}
+
+module.exports = { DirReplyV2 };

package/tiledeskChatbotPlugs/directives/Directives.js

@@ -47,6 +47,7 @@ class Directives {
   static SPEECH_FORM = 'speech_form';
   static PLAY_PROMPT = 'play_prompt';
   static GPT_ASSISTANT = 'gpt_assistant';
+  static REPLY_V2 = 'replyv2';
 
   // 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