@tiledesk/tiledesk-tybot-connector 2.0.9-rc1 → 2.0.10-rc1

package/package.json

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

package/tiledeskChatbotPlugs/DirectivesChatbotPlug.js

@@ -59,6 +59,7 @@ const { DirWebResponse } = require('./directives/DirWebResponse');
 const { DirConnectBlock } = require('./directives/DirConnectBlock');
 
 const winston = require('../utils/winston');
+const { DirFlowLog } = require('./directives/DirFlowLog');
 
 class DirectivesChatbotPlug {
 
@@ -714,6 +715,12 @@ class DirectivesChatbotPlug {
         this.process(next_dir);
       });
     }
+    else if (directive_name === Directives.FLOW_LOG) {
+      new DirFlowLog(context).execute(directive, async () => {
+        let next_dir = await this.nextDirective(this.directives);
+        this.process(next_dir);
+      })
+    }
     else {
       let next_dir = await this.nextDirective(this.directives);
       this.process(next_dir);

package/tiledeskChatbotPlugs/directives/DirAddTags.js

@@ -8,6 +8,7 @@ const { TiledeskChatbotUtil } = require("../../utils/TiledeskChatbotUtil");
 const req = require("express/lib/request");
 const { update } = require("../../models/faq");
 const { TiledeskClient } = require("@tiledesk/tiledesk-client");
+const { Logger } = require("../../Logger");
 require('dotenv').config();
 const winston = require('../../utils/winston');
 const httpUtils = require("../../utils/HttpUtils");
@@ -23,6 +24,8 @@ class DirAddTags {
     this.tdcache = this.context.tdcache;
     this.requestId = this.context.requestId;
     this.API_ENDPOINT = this.context.API_ENDPOINT;
+    this.log = context.log;
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest.draft });
 
     this.tdClient = new TiledeskClient({
       projectId: this.context.projectId,
@@ -33,17 +36,20 @@ class DirAddTags {
   }
 
   execute(directive, callback) {
-    winston.verbose("Execute AddTags directive");
+    winston.verbose("Execute AddTags action");
+    this.logger.error("Execute AddTags directive")
     let action;
     if (directive.action) {
       action = directive.action;
     }
     else {
-      winston.warn("Incorrect directive: ", directive);
+      this.logger.error("Incorrect action for ", directive.name, directive)
+      winston.debug("Incorrect directive: ", directive);
       callback();
       return;
     }
     this.go(action, (stop) => {
+      this.logger.info("Acion AddTag completed");
       callback(stop);
     })
   }
@@ -64,6 +70,7 @@ class DirAddTags {
     pushToList = action.pushToList
 
     if (!action.tags || action.tags === '') {
+      this.logger.error("Add tags Error: tags attribute is mandatory");
       winston.error("(DirAddTags) Error: tags attribute is mandatory")
       await this.chatbot.addParameter("flowError", "Add tags Error: tags attribute is mandatory");
       callback();
@@ -84,6 +91,7 @@ class DirAddTags {
     if(target === 'request'){
       
       let newTags = filled_tags.split(',').filter(tag => tag !== '').map(el => el.trim())
+      this.logger.debug("Adding following tags to conversation: ", newTags)
 
       if(action.pushToList){
         newTags.forEach(async (tag) => {
@@ -97,6 +105,7 @@ class DirAddTags {
 
       winston.debug('(DirAddTags) UPDATE request with newTags', newTags)
       let updatedRequest = await this.updateRequestWithTags(newTags)
+      this.logger.info("Tags added to conversation")
       if(!updatedRequest){
         callback();
         return;
@@ -107,6 +116,7 @@ class DirAddTags {
     /** use case: LEAD */
     if(target === 'lead'){
       let newTags = filled_tags.split(',').filter(tag => tag !== '').map(el => el.trim())
+      this.logger.debug("Adding following tags to lead: ", newTags)
 
       let request = await this.tdClient.getRequestById(this.requestId);
       winston.debug('(DirAddTags) request detail: ', request)
@@ -128,6 +138,7 @@ class DirAddTags {
 
       winston.debug('(DirAddTags) UPDATE lead with newTags ', newTags)
       let updatedLead = await this.updateLeadWithTags(request.lead._id, newTags)
+      this.logger.info("Tags added to lead")
       if(!updatedLead){
         callback();
         return;
@@ -172,6 +183,7 @@ class DirAddTags {
       httpUtils.request(
         HTTPREQUEST, async (err, resbody) => {
           if (err) {
+            this.logger.error("Add tags to list error ", err?.response?.data)
             winston.error("(httprequest) DirAddTags add tags to list err: ", err);
             resolve(true)
           } else {
@@ -206,6 +218,7 @@ class DirAddTags {
       httpUtils.request(
         HTTPREQUEST, async (err, resbody) => {
           if (err) {
+            this.logger.error("Add tag to conversation error ", err?.response?.data);
             winston.error("(httprequest) DirAddTags patch request with new tags err: ", err);
             resolve(true)
           } else {
@@ -235,6 +248,7 @@ class DirAddTags {
       httpUtils.request(
         HTTPREQUEST, async (err, resbody) => {
           if (err) {
+            this.logger.error("Add tag to lead error ", err?.response?.data);
             winston.error("(httprequest) DirAddTags put lead with new tags err: ", err);
             resolve(true)
           } else {

package/tiledeskChatbotPlugs/directives/DirAiPrompt.js

@@ -11,6 +11,7 @@ const Utils = require("../../utils/HttpUtils");
 const utils = require("../../utils/HttpUtils");
 const httpUtils = require("../../utils/HttpUtils");
 const integrationService = require("../../services/IntegrationService");
+const { Logger } = require("../../Logger");
 
 
 class DirAiPrompt {
@@ -27,20 +28,25 @@ class DirAiPrompt {
     this.token = this.context.token;
     this.intentDir = new DirIntent(context);
     this.API_ENDPOINT = this.context.API_ENDPOINT;
+    this.log = context.log;
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest.draft });
   }
 
   execute(directive, callback) {
     winston.verbose("Execute AiPrompt directive");
+    this.logger.error("AiPrompt: executing action");
     let action;
     if (directive.action) {
       action = directive.action;
     }
     else {
+      this.logger.error("AiPrompt incorrect action ", directive)
       winston.debug("DirAiPrompt Incorrect directive: ", directive);
       callback();
       return;
     }
     this.go(action, (stop) => {
+      this.logger.info("AiPrompt: action completed");
       callback(stop);
     })
   }
@@ -64,6 +70,7 @@ class DirAiPrompt {
     winston.debug("DirAskGPTV2 falseIntent", falseIntent)
 
     await this.checkMandatoryParameters(action).catch( async (missing_param) => {
+      this.logger.error(`AiPrompt: missing attribute '${missing_param}'`);
       await this.chatbot.addParameter("flowError", "AiPrompt Error: '" + missing_param + "' attribute is undefined");
       if (falseIntent) {
         await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
@@ -85,6 +92,7 @@ class DirAiPrompt {
     const filled_context = filler.fill(action.context, requestVariables);
 
     if (action.history) {
+      this.logger.info("AiPrompt: using chat transcript");
       let transcript_string = await TiledeskChatbot.getParameterStatic(
         this.context.tdcache,
         this.context.requestId,
@@ -95,6 +103,7 @@ class DirAiPrompt {
         transcript = await TiledeskChatbotUtil.transcriptJSON(transcript_string);
         winston.debug("DirAiPrompt transcript: ", transcript)
       } else {
+        this.logger.warn("AiPrompt: no chat transcript found, skipping history translation");
         winston.verbose("DirAiPrompt transcript_string is undefined. Skip JSON translation for chat history")
       }
     }
@@ -111,6 +120,7 @@ class DirAiPrompt {
 
     if (action.llm === 'ollama') {
       ollama_integration = await integrationService.getIntegration(this.projectId, action.llm, this.token).catch( async (err) => {
+        this.logger.error("AiPrompt: Error getting ollama integration.")
         winston.error("DirAiPrompt Error getting ollama integration: ", err);
         await this.chatbot.addParameter("flowError", "Ollama integration not found");
         if (falseIntent) {
@@ -126,6 +136,7 @@ class DirAiPrompt {
       key = await integrationService.getKeyFromIntegrations(this.projectId, action.llm, this.token);
   
       if (!key) {
+        this.logger.error("AiPrompt: llm key not found in integrations");
         winston.error("Error: DirAiPrompt llm key not found in integrations");
         await this.chatbot.addParameter("flowError", "AiPrompt Error: missing key for llm " + action.llm);
         if (falseIntent) {
@@ -188,6 +199,7 @@ class DirAiPrompt {
           } else {
             error = JSON.stringify(err.response.data);
           }
+          this.logger.error("AiPrompt: error executing action: ", error);
           if (falseIntent) {
             await this.chatbot.addParameter("flowError", "AiPrompt Error: " + error);
             await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
@@ -200,6 +212,7 @@ class DirAiPrompt {
 
           winston.debug("DirAiPrompt resbody: ", resbody);
           answer = resbody.answer;
+          this.logger.info("AiPrompt: answer: ", answer);
         
           await this.#assignAttributes(action, answer);
 
@@ -287,6 +300,7 @@ class DirAiPrompt {
     }
     if (result === true) {
       if (trueIntentDirective) {
+        this.logger.info("AiPrompt: executing true condition");
         this.intentDir.execute(trueIntentDirective, () => {
           if (callback) {
             callback();
@@ -294,6 +308,7 @@ class DirAiPrompt {
         })
       }
       else {
+        this.logger.info("AiPrompt: no block connected to true condition");
         winston.debug("DirAiPrompt No trueIntentDirective specified");
         if (callback) {
           callback();
@@ -302,6 +317,7 @@ class DirAiPrompt {
     }
     else {
       if (falseIntentDirective) {
+        this.logger.info("AiPrompt: executing false condition");
         this.intentDir.execute(falseIntentDirective, () => {
           if (callback) {
             callback();
@@ -309,6 +325,7 @@ class DirAiPrompt {
         });
       }
       else {
+        this.logger.info("AiPrompt: no block connected to false condition");
         winston.debug("DirAiPrompt No falseIntentDirective specified");
         if (callback) {
           callback();

package/tiledeskChatbotPlugs/directives/DirAskGPTV2.js

@@ -10,6 +10,7 @@ require('dotenv').config();
 const winston = require('../../utils/winston');
 const httpUtils = require("../../utils/HttpUtils");
 const integrationService = require("../../services/IntegrationService");
+const { Logger } = require("../../Logger");
 
 class DirAskGPTV2 {
 
@@ -25,20 +26,25 @@ class DirAskGPTV2 {
     this.token = this.context.token;
     this.intentDir = new DirIntent(context);
     this.API_ENDPOINT = this.context.API_ENDPOINT;
+    this.log = context.log;
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest.draft });
   }
 
   execute(directive, callback) {
+    this.logger.error("Execute AskKnowledgeBase action")
     winston.debug("DirAskGPTV2 directive: ", directive);
     let action;
     if (directive.action) {
       action = directive.action;
     }
     else {
+      this.logger.error("Incorrect action for ", directive.name, directive)
       winston.debug("DirAskGPTV2 Incorrect directive: ", directive);
       callback();
       return;
     }
     this.go(action, (stop) => {
+      this.logger.info("Acion AskKnowledgeBase completed");
       callback(stop);
     })
   }
@@ -86,6 +92,7 @@ class DirAskGPTV2 {
     let source = null;
 
     if (!action.question || action.question === '') {
+      this.logger.error("AskKnowledgeBase question attribute is mandatory");
       winston.error("DirAskGPTV2 Error: question attribute is mandatory. Executing condition false...");
       await this.#assignAttributes(action, answer, source);
       if (falseIntent) {
@@ -129,6 +136,7 @@ class DirAskGPTV2 {
     const filled_context = filler.fill(action.context, requestVariables)
 
     if (action.history) {
+      this.logger.info("AskKnowledgeBase: use chat transcript")
       let transcript_string = await TiledeskChatbot.getParameterStatic(
         this.context.tdcache,
         this.context.requestId,
@@ -140,6 +148,7 @@ class DirAskGPTV2 {
         transcript = await TiledeskChatbotUtil.transcriptJSON(transcript_string);
         winston.debug("DirAskGPTV2 transcript ", transcript)
       } else {
+        this.logger.warn("AskKnowledgeBase: chat transcript is undefined. Skip JSON translation for chat history.");
         winston.verbose("DirAskGPT transcript_string is undefined. Skip JSON translation for chat history")
       }
     }
@@ -149,6 +158,7 @@ class DirAskGPTV2 {
 
     let key = await integrationService.getKeyFromIntegrations(this.projectId, 'openai', this.token);
     if (!key) {
+      this.logger.debug("AskKnowledgeBase OpenAI key not found in Integration. Using shared OpenAI key");
       winston.verbose("DirAskGPTV2 - Key not found in Integrations. Searching in kb settings...");
       key = await this.getKeyFromKbSettings();
     }
@@ -157,6 +167,8 @@ class DirAskGPTV2 {
       winston.verbose("DirAskGPTV2 - Retrieve public gptkey")
       key = process.env.GPTKEY;
       publicKey = true;
+    } else {
+      this.logger.debug("AskKnowledgeBase use your own OpenAI key")
     }
 
     if (!key) {
@@ -174,6 +186,7 @@ class DirAskGPTV2 {
     if (publicKey === true) {
       let keep_going = await this.checkQuoteAvailability();
       if (keep_going === false) {
+        this.logger.warn("AskKnowledgeBase Tokens quota exceeded. Skip the action")
         winston.verbose("DirAskGPTV2 - Quota exceeded for tokens. Skip the action")
         await this.chatbot.addParameter("flowError", "AskGPT Error: tokens quota exceeded");
         await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
@@ -187,14 +200,17 @@ class DirAskGPTV2 {
     if (action.namespaceAsName) {
       // Namespace could be an attribute
       const filled_namespace = filler.fill(action.namespace, requestVariables)
+      this.logger.debug("AskKnowledgeBase Searching namespace by name ", filled_namespace);
       ns = await this.getNamespace(filled_namespace, null);
       namespace = ns?.id;
       winston.verbose("DirAskGPTV2 - Retrieved namespace id from name " + namespace);
     } else {
+      this.logger.debug("AskKnowledgeBase Searching namespace by id ", namespace);
       ns = await this.getNamespace(null, namespace);
     }
 
     if (!ns) {
+      this.logger.error("AskKnowledgeBase Namespace not found")
       await this.#assignAttributes(action, answer);
       await this.chatbot.addParameter("flowError", "AskGPT Error: namespace not found");
       if (falseIntent) {
@@ -213,6 +229,7 @@ class DirAskGPTV2 {
     }
     
     if (!namespace) {
+      this.logger.error("AskKnowledgeBase Namespace is undefined")
       winston.verbose("DirAskGPTV2 - Error: namespace is undefined")
       if (falseIntent) {
         await this.chatbot.addParameter("flowError", "AskGPT Error: namespace is undefined");

package/tiledeskChatbotPlugs/directives/DirFlowLog.js

@@ -0,0 +1,76 @@
+
+
+const { Logger } = require('../../Logger');
+const winston = require('../../utils/winston');
+let levels = ['error', 'warn', 'info', 'debug'];
+
+class DirFlowLog {
+
+  constructor(context) {
+    if (!context) {
+      throw new Error('context object is mandatory.');
+    }
+    this.context = context;
+    this.chatbot = context.chatbot;
+    this.tdcache = context.tdcache;
+    this.requestId = context.requestId;
+    this.log = context.log;
+
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest.draft });
+  }
+
+  execute(directive, callback) {
+    winston.verbose("Execute FlowLog directive");
+    let action;
+    if (directive.action) {
+      action = directive.action;
+    }
+    else {
+      winston.warn("DirGptTask Incorrect directive: ", directive);
+      callback();
+      return;
+    }
+
+    this.go(action, () => {
+      callback();
+    })
+  }
+
+  async go(action, callback) {
+    winston.debug("(DirFlowLog) Action: ", action);
+    console.log("(DirFlowLog) Action: ", action);
+
+    let level = action.level || 'info';
+    if (!levels.includes(level)) {
+      winston.warn("Invalid log level " + level);
+      this.logger.error("Invalid log level: " + level);
+      callback();
+    }
+
+    if (!action.log) {
+      winston.debug("Log text is empty");
+      callback();
+    }
+
+    if (level === 'error') {
+      winston.info("Adding log " + action.log + " with level " + level);
+      this.logger.error(action.log);
+    }
+    else if (level === 'warn') {
+      winston.info("Adding log " + action.log + " with level " + level);
+      this.logger.warn(action.log);
+    }
+    else if (level === 'info') {
+      winston.info("Adding log " + action.log + " with level " + level);
+      this.logger.info(action.log);
+    }
+    else if (level === 'debug') {
+      winston.info("Adding log " + action.log + " with level " + level);
+      this.logger.debug(action.log);
+    }
+
+    callback();
+  }
+}
+
+module.exports = { DirFlowLog };

package/tiledeskChatbotPlugs/directives/DirWebRequestV2.js

@@ -4,6 +4,7 @@ const { Filler } = require('../Filler');
 const { TiledeskChatbot } = require('../../engine/TiledeskChatbot');
 const { DirIntent } = require('./DirIntent');
 const winston = require('../../utils/winston');
+const { Logger } = require('../../Logger');
 
 class DirWebRequestV2 {
 
@@ -16,6 +17,8 @@ class DirWebRequestV2 {
     this.requestId = context.requestId;
     this.chatbot = context.chatbot;
     this.intentDir = new DirIntent(context);
+    this.log = context.log;
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest.draft });
   }
 
   execute(directive, callback) {
@@ -29,7 +32,9 @@ class DirWebRequestV2 {
       callback();
       return;
     }
+    this.logger.info("Executing WebRequest action ", directive.action)
     this.go(action, (stop) => {
+      this.logger.info("WebRequest action terminated")
       callback(stop);
     }).catch((err) => {
       // do not nothing
@@ -64,6 +69,7 @@ class DirWebRequestV2 {
     const url = filler.fill(action.url, requestAttributes);
 
     let headers = await this.getHeadersFromAction(action, filler, requestAttributes).catch( async (err) => {
+      this.logger.error("WebRequest: error getting headers");
       await this.chatbot.addParameter("flowError", "Error getting headers");
       if (falseIntent) {
         await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
@@ -75,6 +81,7 @@ class DirWebRequestV2 {
     });
 
     let json = await this.getJsonFromAction(action, filler, requestAttributes).catch( async (err) => {
+      this.logger.error("WebRequest: error parsing json body");
       await this.chatbot.addParameter("flowError", "Error parsing json body");
       if (falseIntent) {
         await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
@@ -106,8 +113,10 @@ class DirWebRequestV2 {
         let error = res.error;
         await this.#assignAttributes(action, resbody, status, error)
         winston.debug("DirWebRequestV2 resbody:", resbody);
+        this.logger.info("WebRequest resbody: ", resbody);
         
         if (err) {
+          this.logger.error("WebRequest error: ", err);
           winston.log("webRequest error: ", err);
           if (callback) {
             if (falseIntent) {
@@ -129,6 +138,7 @@ class DirWebRequestV2 {
           return;
         }
         else {
+          this.logger.warn("WebRequest status ", status);
           if (falseIntent) {
             await this.#executeCondition(false, trueIntent, trueIntentAttributes, falseIntent, falseIntentAttributes);
             callback(true);
@@ -227,6 +237,7 @@ class DirWebRequestV2 {
     }
     if (result === true) {
       if (trueIntentDirective) {
+        this.logger.info("WebRequest: executing true condition");
         this.intentDir.execute(trueIntentDirective, () => {
           if (callback) {
             callback();
@@ -234,6 +245,7 @@ class DirWebRequestV2 {
         });
       }
       else {
+        this.logger.info("WebRequest: no block connected to true condition");
         winston.debug("DirWebRequestV2 No trueIntentDirective specified");
         if (callback) {
           callback();
@@ -242,6 +254,7 @@ class DirWebRequestV2 {
     }
     else {
       if (falseIntentDirective) {
+        this.logger.info("WebRequest: executing false condition");
         this.intentDir.execute(falseIntentDirective, () => {
           if (callback) {
             callback();
@@ -249,6 +262,7 @@ class DirWebRequestV2 {
         });
       }
       else {
+        this.logger.info("WebRequest: no block connected to false condition");
         winston.debug("DirWebRequestV2 No falseIntentDirective specified");
         if (callback) {
           callback();

package/tiledeskChatbotPlugs/directives/Directives.js

@@ -60,6 +60,7 @@ class Directives {
   static ADD_TAGS = 'add_tags'
   static WEBHOOK = 'webhook';
   static WEB_RESPONSE = "web_response";
+  static FLOW_LOG = "flow_log";
 
   // 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