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

package/tiledeskChatbotPlugs/directives/DirCaptureUserReply.js

@@ -2,6 +2,7 @@ const { Filler } = require('../Filler');
 const { TiledeskChatbot } = require('../../engine/TiledeskChatbot');
 const { DirIntent } = require('./DirIntent');
 const winston = require('../../utils/winston');
+const { Logger } = require('../../Logger');
 
 class DirCaptureUserReply {
   constructor(context) {
@@ -15,17 +16,20 @@ class DirCaptureUserReply {
     this.chatbot = context.chatbot;
     this.tdcache = context.tdcache;
     this.requestId = context.requestId;
+    
     this.intentDir = new DirIntent(context);
-    this.log = context.log;
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest?.draft, intent_id: this.context.reply?.attributes?.intent_info?.intent_id });
   }
 
   execute(directive, callback) {
+    this.logger.info("[Capture User Reply] Executing action");
     winston.verbose("Execute CaptureUserReply directive");
     let action;
     if (directive.action) {
       action = directive.action;
     }
     else {
+      this.logger.error("Incorrect action for ", directive.name, directive)
       winston.warn("DirCaptureUserReply Incorrect directive: ", directive);
       callback();
       return;
@@ -44,6 +48,7 @@ class DirCaptureUserReply {
       const actionId = action["_tdActionId"];;
       await this.chatbot.lockIntent(this.requestId, intent_name);
       await this.chatbot.lockAction(this.requestId, actionId);
+      this.logger.info("[Capture User Reply] Waiting for user reply...");
       callback();
       return;
     } else {
@@ -58,6 +63,7 @@ class DirCaptureUserReply {
     }
     try {
       const user_reply = this.message.text;
+      this.logger.info("[Capture User Reply] User replied with: ", user_reply);
       if (this.context.tdcache) {
         if (action.assignResultTo) {
           winston.debug("(DirCaptureUserReply) assign assignResultTo: " + action.assignResultTo);
@@ -68,16 +74,19 @@ class DirCaptureUserReply {
       if (callback) {
         if (goToIntent) {
           this.#executeGoTo(goToIntent, () => {
+            this.logger.info("[Capture User Reply] Action completed");
             callback(); // continue the flow
           });
         }
         else {
+          this.logger.info("[Capture User Reply] Action completed");
           callback(); // continue the flow
         }
         
       }
     }
     catch(error) {
+      this.logger.error("[Capture User Reply] Error: ", error);
       winston.error("(DirCaptureUserReply) error: ", error);
     }
   }

package/tiledeskChatbotPlugs/directives/DirClearTranscript.js

@@ -1,4 +1,5 @@
 
+const { Logger } = require('../../Logger');
 const { TiledeskChatbotUtil } = require('../../utils/TiledeskChatbotUtil');
 
 class DirClearTranscript {
@@ -9,10 +10,14 @@ class DirClearTranscript {
         }
         this.context = context;
         this.requestId = context.requestId;
+        
+        this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest?.draft, intent_id: this.context.reply?.attributes?.intent_info?.intent_id });
     }
     
     execute(directive, callback) {
+        this.logger.info("[Clear Transcript] Executing action");
         TiledeskChatbotUtil.clearConversationTranscript(this.context.chatbot, () => {
+            this.logger.info("[Clear Transcript] Action completed");
             callback();
         });
     }

package/tiledeskChatbotPlugs/directives/DirClose.js

@@ -2,6 +2,7 @@
 const { TiledeskClient } = require("@tiledesk/tiledesk-client");
 const { TiledeskChatbotConst } = require("../../engine/TiledeskChatbotConst");
 const winston = require('../../utils/winston');
+const { Logger } = require("../../Logger");
 
 class DirClose {
 
@@ -13,26 +14,24 @@ class DirClose {
         this.requestId = context.requestId;
         this.chatbot = context.chatbot;
         this.API_ENDPOINT = context.API_ENDPOINT;
-        this.log = context.log;
-
-        this.tdClient = new TiledeskClient({
-            projectId: this.context.projectId,
-            token: this.context.token,
-            APIURL: this.API_ENDPOINT,
-            APIKEY: "___",
-            log: this.log
-        });
+        
+        this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest?.draft, intent_id: this.context.reply?.attributes?.intent_info?.intent_id });
+        this.tdClient = new TiledeskClient({ projectId: this.context.projectId, token: this.context.token, APIURL: this.API_ENDPOINT, APIKEY: "___" });
     }
     
     execute(directive, callback) {
+        this.logger.info("[Close] Executing action");
         winston.verbose("Execute Close directive");
         this.tdClient.closeRequest(this.requestId, async (err) => {
             if (err) {
+                this.logger.error("[Close] Closing request");
                 winston.error("(DirClose) Error: ", err);
             }
             else {
+                this.logger.verbose("[Close] Request closed");
                 await this.chatbot.deleteParameter(TiledeskChatbotConst.USER_INPUT);
             }
+            this.logger.info("[Close] Action completed");
             callback();
         });
     }

package/tiledeskChatbotPlugs/directives/DirCode.js

@@ -2,6 +2,7 @@ const { TiledeskChatbot } = require('../../engine/TiledeskChatbot');
 const { TiledeskExpression } = require('../../TiledeskExpression');
 const { TiledeskRequestVariables } = require('../TiledeskRequestVariables');
 const winston = require('../../utils/winston');
+const { Logger } = require('../../Logger');
 
 class DirCode {
 
@@ -10,21 +11,26 @@ class DirCode {
       throw new Error('context object is mandatory.');
     }
     this.context = context;
-    this.log = context.log;
+    this.requestId = this.context.requestId;
+    
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest?.draft, intent_id: this.context.reply?.attributes?.intent_info?.intent_id });
   }
 
   execute(directive, callback) {
+    this.logger.info("[Code] Executing action");
     winston.verbose("Execute Code directive");
     let action;
     if (directive.action) {
       action = directive.action
     }
     else {
+      this.logger.error("Incorrect action for ", directive.name, directive)
       winston.warn("DirCode Incorrect directive: ", directive);
       callback();
       return;
     }
     this.go(action, (stop) => {
+      this.logger.info("[Code] Action completed");
       callback(stop);
     });
     
@@ -34,6 +40,7 @@ class DirCode {
     winston.debug("(DirCode) Action: ", action);
     const source_code = action.source;
     if (!source_code || source_code.trim() === "") {
+      this.logger.warn("[Code] Invalid source_code");
       winston.error("(DirCode) Invalid source_code");
       callback();
       return;
@@ -74,6 +81,7 @@ class DirCode {
 
     }
     catch(err) {
+      this.logger.error("[Code] An error occurred: ", err);
       winston.error("(DirCode)  An error occurred: ", err);
     }
     callback();

package/tiledeskChatbotPlugs/directives/DirCondition.js

@@ -3,6 +3,7 @@ const { TiledeskChatbot } = require('../../engine/TiledeskChatbot');
 const { TiledeskExpression } = require('../../TiledeskExpression');
 const ms = require('minimist-string');
 const winston = require('../../utils/winston');
+const { Logger } = require('../../Logger');
 
 class DirCondition {
 
@@ -11,11 +12,14 @@ class DirCondition {
       throw new Error('context object is mandatory.');
     }
     this.context = context;
+    this.requestId = this.context.requestId;
+    
     this.intentDir = new DirIntent(context);
-    this.log = context.log;
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest?.draft, intent_id: this.context.reply?.attributes?.intent_info?.intent_id });
   }
 
   execute(directive, callback) {
+    this.logger.info("[Condition] Executing action");
     winston.verbose("Execute Condition directive");
     let action;
     if (directive.action) {
@@ -35,11 +39,13 @@ class DirCondition {
       }
     }
     else {
+      this.logger.error("Incorrect action for ", directive.name, directive)
       winston.warn("DirCondition Incorrect directive: ", directive);
       callback();
       return;
     }
     this.go(action, (stop) => {
+      this.logger.info("[Condition] Action completed");
       callback(stop);
     });
     
@@ -64,21 +70,25 @@ class DirCondition {
     }
     winston.debug("(DirCondition) condition action: ", action);
     if (!trueIntent && !falseIntent) {
+      this.logger.error("[Condition] Invalid condition, no intents specified");
       winston.error("(DirCondition) Invalid condition, no intents specified");
       callback();
       return;
     }
     if (scriptCondition === null && jsonCondition === null) {
+      this.logger.error("[Condition] Invalid condition, scriptCondition & jsonCondition null");
       winston.error("(DirCondition) Invalid condition, scriptCondition & jsonCondition null");
       callback();
       return;
     }
     if (scriptCondition !== null && scriptCondition.trim === "") {
+      this.logger.error("[Condition] Invalid condition, scriptCondition is empty");
       winston.error("(DirCondition) Invalid condition, scriptCondition is empty");
       callback();
       return;
     }
     else if (jsonCondition && jsonCondition.groups === null) {
+      this.logger.error("[Condition] Invalid jsonCondition, no groups");
       winston.error("(DirCondition) Invalid jsonCondition, no groups:", jsonCondition);
       callback();
       return;
@@ -121,6 +131,7 @@ class DirCondition {
         });
       }
       else {
+        this.logger.debug("[Condition] No trueIntentDirective specified");
         winston.debug("(DirCondition) No trueIntentDirective specified");
         callback();
         return;
@@ -133,6 +144,7 @@ class DirCondition {
         });
       }
       else {
+        this.logger.debug("[Condition] No falseIntentDirective specified");
         winston.debug("(DirCondition) No falseIntentDirective specified");
         callback();
         return;

package/tiledeskChatbotPlugs/directives/DirContactUpdate.js

@@ -5,6 +5,7 @@ let axios = require('axios');
 const { TiledeskChatbotConst } = require('../../engine/TiledeskChatbotConst');
 const { TiledeskClient } = require('@tiledesk/tiledesk-client');
 const winston = require('../../utils/winston');
+const { Logger } = require('../../Logger');
 
 class DirContactUpdate {
 
@@ -19,18 +20,13 @@ class DirContactUpdate {
     this.token = context.token;
     this.tdcache = context.tdcache;
     this.API_ENDPOINT = context.API_ENDPOINT;
-    this.log = context.log;
-
-    this.tdClient = new TiledeskClient({
-      projectId: this.context.projectId,
-      token: this.context.token,
-      APIURL: this.API_ENDPOINT,
-      APIKEY: "___",
-      log: this.log
-    });
+    
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest?.draft, intent_id: this.context.reply?.attributes?.intent_info?.intent_id });
+    this.tdClient = new TiledeskClient({ projectId: this.context.projectId, token: this.context.token, APIURL: this.API_ENDPOINT, APIKEY: "___" });
   }
 
   execute(directive, callback) {
+    this.logger.info("[Lead Update] Executing action");
     winston.verbose("Execute ContactUpdate directive")
     let action;
     if (directive.action) {
@@ -41,11 +37,13 @@ class DirContactUpdate {
       action.attributes.fillParams = true;
     }
     else {
+      this.logger.error("Incorrect action for ", directive.name, directive)
       winston.warn("DirContactUpdate Incorrect directive: ", directive);
       callback();
       return;
     }
     this.go(action, () => {
+      this.logger.info("[Lead Update] Action completed");
       callback();
     });
   }

package/tiledeskChatbotPlugs/directives/DirCustomerio.js

@@ -6,6 +6,7 @@ let https = require("https");
 require('dotenv').config();
 const winston = require('../../utils/winston');
 const integrationService = require("../../services/IntegrationService");
+const { Logger } = require("../../Logger");
 
 class DirCustomerio {
 
@@ -18,23 +19,27 @@ class DirCustomerio {
     this.requestId = this.context.requestId;
     this.projectId = this.context.projectId;
     this.token = this.context.token;
-    this.intentDir = new DirIntent(context);
     this.API_ENDPOINT = this.context.API_ENDPOINT;
-    this.log = context.log;
+    
+    this.intentDir = new DirIntent(context);
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest?.draft, intent_id: this.context.reply?.attributes?.intent_info?.intent_id });
   }
 
   execute(directive, callback) {
+    this.logger.info("[Customer.io] Executing action");
     winston.verbose("Execute Customerio directive");
     let action;
     if (directive.action) {
       action = directive.action;
     }
     else {
+      this.logger.error("Incorrect action for ", directive.name, directive)
       winston.warn("DirCustomerio Incorrect directive: ", directive);
       callback();
       return;
     }
     this.go(action, (stop) => {
+      this.logger.info("[Customer.io] Action completed");
       callback(stop);
     })
   }
@@ -66,6 +71,7 @@ class DirCustomerio {
     winston.debug("(DirCustomerio) bodyParameters: ", bodyParameters);
 
     if (!bodyParameters || bodyParameters === '') {
+      this.logger.error("[Customer.io] bodyParameters is undefined or null or empty string");
       winston.debug("(DirCustomerio) Error: bodyParameters is undefined or null or empty string");
       callback();
       return;
@@ -76,6 +82,7 @@ class DirCustomerio {
 
     let key = await integrationService.getKeyFromIntegrations(this.projectId, 'customerio', this.token);
     if (!key) {
+      this.logger.error("[Customer.io] Key not found in Integrations");
       winston.debug("(DirCustomerio) - Key not found in Integrations.");
       let status = 422;
       let error = 'Missing customerio access token';
@@ -117,6 +124,7 @@ class DirCustomerio {
       CUSTOMERIO_HTTPREQUEST, async (err, resbody) => {
         if (err) {
           if (callback) {
+            this.logger.error("[Customer.io] Error response: ", err.response);
             winston.debug("(DirCustomerio) err response:", err.response)
             winston.debug("(DirCustomerio) err data:", err.response.data)
 
@@ -151,6 +159,7 @@ class DirCustomerio {
 
           let status = 204;
           let error = null;
+          this.logger.error("[Customer.io] Response status: ", status);
           await this.#assignAttributes(action, status, error);
           if (trueIntent) {
             await this.#executeCondition(true, trueIntent, null, falseIntent, null);

package/tiledeskChatbotPlugs/directives/DirDeflectToHelpCenter.js

@@ -15,13 +15,7 @@ class DirDeflectToHelpCenter {
     this.API_ENDPOINT = context.API_ENDPOINT;
     this.log = context.log;
 
-    this.tdClient = new TiledeskClient({
-      projectId: this.context.projectId,
-      token: this.context.token,
-      APIURL: this.API_ENDPOINT,
-      APIKEY: "___",
-      log: this.log
-    });
+    this.tdClient = new TiledeskClient({ projectId: this.context.projectId, token: this.context.token, APIURL: this.API_ENDPOINT, APIKEY: "___", log: this.log });
   }
 
   async execute(directive, callback) {

package/tiledeskChatbotPlugs/directives/DirDeleteVariable.js

@@ -3,6 +3,7 @@ const ms = require('minimist-string');
 const { TiledeskChatbot } = require('../../engine/TiledeskChatbot');
 const { Filler } = require('../Filler');
 const winston = require('../../utils/winston');
+const { Logger } = require('../../Logger');
 
 class DirDeleteVariable {
 
@@ -11,10 +12,13 @@ class DirDeleteVariable {
       throw new Error('context object is mandatory.');
     }
     this.context = context;
-    this.log = context.log;
+    this.requestId = this.context.requestId;
+
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest?.draft, intent_id: this.context.reply?.attributes?.intent_info?.intent_id });
   }
 
   async execute(directive, callback) {
+    this.logger.info("[Delete Attribute] Executing action");
     winston.verbose("Execute DeleteVariable directive");
     let action;
     if (directive.action) {
@@ -25,7 +29,14 @@ class DirDeleteVariable {
         variableName: directive.parameter
       }
     }
+    else {
+      this.logger.error("Incorrect action for ", directive.name, directive)
+      winston.warn("(DirDeleteVariable) Incorrect directive: ", directive);
+      callback();
+      return;
+    }
     this.go(action, () => {
+      this.logger.info("[Delete Attribute] Action completed");
       callback();
     });
   }
@@ -35,6 +46,7 @@ class DirDeleteVariable {
 
     let variableName = action.variableName;
     if (!variableName) {
+      this.logger.warn("[Delete Attribute] Missing 'variableName'. Skip")
       winston.error("(DirDeleteVariable) deleting variable. Missing 'variableName' error. Skipping");
       if (callback) {
         callback();
@@ -60,6 +72,7 @@ class DirDeleteVariable {
         }
       }
       catch(err) {
+        this.logger.error("[Delete Attribute] Error deleting attribute");
         winston.error("(DirDeleteVariable)  error: ", err);
         if (completion) {
           completion();

package/tiledeskChatbotPlugs/directives/DirDepartment.js

@@ -1,5 +1,6 @@
 const { TiledeskClient } = require("@tiledesk/tiledesk-client");
 const winston = require('../../utils/winston');
+const { Logger } = require("../../Logger");
 
 class DirDepartment {
 
@@ -11,17 +12,13 @@ class DirDepartment {
     this.requestId = context.requestId;
     this.API_ENDPOINT = context.API_ENDPOINT;
     this.log = context.log;
-
-    this.tdClient = new TiledeskClient({
-      projectId: this.context.projectId,
-      token: this.context.token,
-      APIURL: this.API_ENDPOINT,
-      APIKEY: "___",
-      log: this.log
-    });
+    
+    this.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest?.draft, intent_id: this.context.reply?.attributes?.intent_info?.intent_id });
+    this.tdClient = new TiledeskClient({ projectId: this.context.projectId, token: this.context.token, APIURL: this.API_ENDPOINT, APIKEY: "___" });
   }
 
   execute(directive, callback) {
+    this.logger.info("[Change Department] Executing action");
     winston.verbose("Execute Department directive");
     let action;
     if (directive.action) {
@@ -37,6 +34,7 @@ class DirDepartment {
       }
     }
     this.go(action, () => {
+      this.logger.info("[Change Department] Action executed");
       callback();
     });
     
@@ -66,6 +64,7 @@ class DirDepartment {
     const depName = action.depName;
     this.moveToDepartment(this.requestId, depName, (deps) => {
       if (!deps) {
+        this.logger.warn("[Change Department] Department not found");
         winston.warn("(DirDepartment) Dep not found");
         callback();
         return
@@ -94,14 +93,19 @@ class DirDepartment {
             this.requestId,
             message, (err) => {
               if (err) {
+                this.logger.error("[Change Department] Unable to trigger bot");
                 winston.error("(DirDepartment) Error sending hidden message: " + err.message)
+              } else {
+                this.logger.verbose("[Change Department] Bot triggered");
+                winston.debug("(DirDepartment) Hidden message sent.");
+
               }
-              winston.debug("(DirDepartment) Hidden message sent.");
               callback();
           });
         }
       }
       else {
+        this.logger.verbose("[Change Department] No triggering bot");
         winston.debug("(DirDepartment) No action.triggerBot");
         callback();
       }

package/tiledeskChatbotPlugs/directives/DirFireTiledeskEvent.js

@@ -11,15 +11,9 @@ class DirFireTiledeskEvent {
 
     this.context = context;
     this.log = context.log;
-
     this.API_ENDPOINT = context.API_ENDPOINT;
-    this.tdClient = new TiledeskClient({
-      projectId: this.context.projectId,
-      token: this.context.token,
-      APIURL: this.API_ENDPOINT,
-      APIKEY: "___",
-      log: this.log
-    });
+    
+    this.tdClient = new TiledeskClient({ projectId: this.context.projectId, token: this.context.token, APIURL: this.API_ENDPOINT, APIKEY: "___", log: this.log });
   }
 
   execute(directive, callback) {

package/tiledeskChatbotPlugs/directives/DirFlowLog.js

@@ -0,0 +1,88 @@
+
+
+const { Logger } = require('../../Logger');
+const { TiledeskChatbot } = require('../../engine/TiledeskChatbot');
+const { Filler } = require('../Filler');
+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);
+
+    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();
+    }
+
+    let requestVariables = null;
+    requestVariables =
+      await TiledeskChatbot.allParametersStatic(
+        this.tdcache, this.requestId
+      );
+
+    const filler = new Filler();
+    const filled_log = filler.fill(action.log, requestVariables);
+    winston.debug("(DirFlowLog) fille log: ", filled_log);
+
+    if (level === 'error') {
+      winston.info("Adding log '" + filled_log + "' with level " + level);
+      this.logger.error(filled_log);
+    }
+    else if (level === 'warn') {
+      winston.info("Adding log '" + filled_log + "' with level " + level);
+      this.logger.warn(filled_log);
+    }
+    else if (level === 'info') {
+      winston.info("Adding log '" + filled_log + "' with level " + level);
+      this.logger.info(filled_log);
+    }
+    else if (level === 'debug') {
+      winston.info("Adding log '" + filled_log + "' with level " + level);
+      this.logger.debug(filled_log);
+    }
+
+    callback();
+  }
+}
+
+module.exports = { DirFlowLog };

package/tiledeskChatbotPlugs/directives/DirForm.js

@@ -14,18 +14,11 @@ class DirForm {
     this.chatbot = context.chatbot;
     this.tdcache = context.tdcache;
     this.requestId = context.requestId;
-    this.intentDir = new DirIntent(context);
     this.log = context.log;
-
     this.API_ENDPOINT = context.API_ENDPOINT;
-    this.tdClient = new TiledeskClient({
-      projectId: this.context.projectId,
-      token: this.context.token,
-      APIURL: this.API_ENDPOINT,
-      APIKEY: "___",
-      log: this.log
-    });
-
+    
+    this.intentDir = new DirIntent(context);
+    this.tdClient = new TiledeskClient({ projectId: this.context.projectId, token: this.context.token, APIURL: this.API_ENDPOINT, APIKEY: "___", log: this.log });
   }
 
   execute(directive, callback) {