@tiledesk/tiledesk-tybot-connector 0.4.2 → 0.5.0-rc2

package/tiledeskChatbotPlugs/directives/DirCustomerio.js

@@ -4,7 +4,7 @@ const { Filler } = require("../Filler");
 const { DirIntent } = require("./DirIntent");
 let https = require("https");
 require('dotenv').config();
-
+const winston = require('../../utils/winston');
 
 class DirCustomerio {
 
@@ -21,13 +21,13 @@ class DirCustomerio {
   }
 
   execute(directive, callback) {
-    if (this.log) { console.log("DirCustomerio directive: ", directive); }
+    winston.verbose("Execute Customerio directive");
     let action;
     if (directive.action) {
       action = directive.action;
     }
     else {
-      console.error("DirCustomerio Incorrect directive: ", JSON.stringify(directive));
+      winston.warn("DirCustomerio Incorrect directive: ", directive);
       callback();
       return;
     }
@@ -37,19 +37,18 @@ class DirCustomerio {
   }
 
   async go(action, callback) {
-    if (this.log) { console.log("DirCustomerio action:", JSON.stringify(action)); }
+    winston.debug("(DirCustomerio) Action: ", action);
     if (!this.tdcache) {
-      console.error("Error: DirCustomerio tdcache is mandatory");
+      winston.error("(DirCustomerio) Error: tdcache is mandatory");
       callback();
       return;
     }
 
     let trueIntent = action.trueIntent;
     let falseIntent = action.falseIntent;
-    if (this.log) {
-      console.log("DirCustomerio trueIntent", trueIntent)
-      console.log("DirCustomerio falseIntent", falseIntent)
-    }
+
+    winston.debug("(DirCustomerio) trueIntent " + trueIntent)
+    winston.debug("(DirCustomerio) falseIntent " + falseIntent)
 
     let requestVariables = null;
     requestVariables =
@@ -59,23 +58,22 @@ class DirCustomerio {
 
     let formid = action.formid;
     let bodyParameters = action.bodyParameters;
-    if (this.log) {
-      console.log("DirCustomerio formid: ", formid);
-      console.log("DirCustomerio bodyParameters: ", bodyParameters);
-    }
+
+    winston.debug("(DirCustomerio) formid: " + formid);
+    winston.debug("(DirCustomerio) bodyParameters: ", bodyParameters);
 
     if (!bodyParameters || bodyParameters === '') {
-      if (this.log) { console.error("DirCustomerio ERROR - bodyParameters is undefined or null or empty string") };
+      winston.debug("(DirCustomerio) Error: bodyParameters is undefined or null or empty string");
       callback();
       return;
     }
 
     const customerio_base_url = process.env.CUSTOMERIO_ENDPOINT || "https://track.customer.io/api/v1";
-    if (this.log) { console.log("DirCustomerio customerio_base_url: ", customerio_base_url); }
+    winston.debug("(DirCustomerio) customerio_base_url: " + customerio_base_url); 
 
     let key = await this.getKeyFromIntegrations();
     if (!key) {
-      if (this.log) { console.log("DirCustomerio - Key not found in Integrations."); }
+      winston.debug("(DirCustomerio) - Key not found in Integrations.");
       let status = 422;
       let error = 'Missing customerio access token';
       await this.#assignAttributes(action, status, error);
@@ -88,11 +86,11 @@ class DirCustomerio {
 
     const filler = new Filler();
     for (const [key, value] of Object.entries(bodyParameters)) {
-      if (this.log) { console.log("bodyParam:", key, "value:", value) }
+      winston.debug("(DirCustomerio) bodyParam: " + key + " value: " + value) 
       let filled_value = filler.fill(value, requestVariables);
       bodyParameters[key] = filled_value;
     }
-    if (this.log) { console.log('DirCustomerio bodyParameters filler: ', bodyParameters) }
+    winston.debug("(DirCustomerio)  bodyParameters filler: ", bodyParameters)
 
     let json = {
       data: bodyParameters
@@ -110,16 +108,15 @@ class DirCustomerio {
       json: json,
       method: "POST"
     }
-    if (this.log) { console.log("DirCustomerio CUSTOMERIO_HTTPREQUEST", JSON.stringify(CUSTOMERIO_HTTPREQUEST)); }
+    winston.debug("(DirCustomerio) HttpRequest: ", CUSTOMERIO_HTTPREQUEST); 
 
     this.#myrequest(
       CUSTOMERIO_HTTPREQUEST, async (err, resbody) => {
         if (err) {
           if (callback) {
-            if (this.log) {
-              console.error("(httprequest) DirCustomerio err response:", err.response)
-              console.error("(httprequest) DirCustomerio err data:", err.response.data)
-            };
+            winston.debug("(DirCustomerio) err response:", err.response)
+            winston.debug("(DirCustomerio) err data:", err.response.data)
+
             let status = null;
             let error;
 
@@ -133,10 +130,9 @@ class DirCustomerio {
               error = err.response.data.meta.error;
             }
 
-            if (this.log) {
-              console.error("(httprequest) DirCustomerio err data status:", status);
-              console.error("(httprequest) DirCustomerio err data error:", error);
-            }
+            winston.debug("(DirCustomerio) err data status: " + status);
+            winston.debug("(DirCustomerio) err data error: ", error);
+
             await this.#assignAttributes(action, status, error);
             if (falseIntent) {
               await this.#executeCondition(false, trueIntent, null, falseIntent, null);
@@ -148,7 +144,7 @@ class DirCustomerio {
 
           }
         } else if (callback) {
-          if (this.log) { console.log("DirCustomerio resbody: ", JSON.stringify(resbody, null, 2)); }
+          winston.debug("(DirCustomerio) DirCustomerio resbody: ", resbody); 
 
           let status = 204;
           let error = null;
@@ -167,11 +163,9 @@ class DirCustomerio {
   }
 
   async #assignAttributes(action, status, error) {
-    if (this.log) {
-      console.log("DirCustomerio assignAttributes action:", action)
-      console.log("DirCustomerio assignAttributes status:", status)
-      console.log("DirCustomerio assignAttributes error:", error)
-    }
+    winston.debug("(DirCustomerio)  assignAttributes action: ", action)
+    winston.debug("(DirCustomerio)  assignAttributes status: " + status)
+    winston.debug("(DirCustomerio)  assignAttributes error: ", error)
     if (this.context.tdcache) {
       if (action.assignStatusTo) {
         await TiledeskChatbot.addParameterStatic(this.context.tdcache, this.context.requestId, action.assignStatusTo, status);
@@ -179,22 +173,10 @@ class DirCustomerio {
       if (action.assignErrorTo) {
         await TiledeskChatbot.addParameterStatic(this.context.tdcache, this.context.requestId, action.assignErrorTo, error);
       }
-
-      // Debug log
-      if (this.log) {
-        const all_parameters = await TiledeskChatbot.allParametersStatic(this.context.tdcache, this.context.requestId);
-        for (const [key, value] of Object.entries(all_parameters)) {
-          if (this.log) { console.log("DirCustomerio request parameter:", key, "value:", value, "type:", typeof value) }
-        }
-      }
     }
   }
 
   #myrequest(options, callback) {
-    if (this.log) {
-      console.log("** API URL:", options.url);
-      console.log("** Options:", JSON.stringify(options));
-    }
     let axios_options = {
       url: options.url,
       method: options.method,
@@ -204,9 +186,6 @@ class DirCustomerio {
     if (options.json !== null) {
       axios_options.data = options.json
     }
-    if (this.log) {
-      console.log("axios_options:", JSON.stringify(axios_options));
-    }
     if (options.url.startsWith("https:")) {
       const httpsAgent = new https.Agent({
         rejectUnauthorized: false,
@@ -215,10 +194,6 @@ class DirCustomerio {
     }
     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.status == 204) && (res.data || res.config.data)) {
           if (callback) {
             if (res.data) {
@@ -251,7 +226,6 @@ class DirCustomerio {
     if (falseIntent) {
       falseIntentDirective = DirIntent.intentDirectiveFor(falseIntent, falseIntentAttributes);
     }
-    if (this.log) { console.log('DirCustomerio executeCondition/result', result) }
     if (result === true) {
       if (trueIntentDirective) {
         this.intentDir.execute(trueIntentDirective, () => {
@@ -261,7 +235,7 @@ class DirCustomerio {
         });
       }
       else {
-        if (this.log) { console.log("No trueIntentDirective specified"); }
+        winston.debug("(DirCustomerio) No trueIntentDirective specified");
         if (callback) {
           callback();
         }
@@ -276,7 +250,7 @@ class DirCustomerio {
         });
       }
       else {
-        if (this.log) { console.log("No falseIntentDirective specified"); }
+        winston.debug("(DirCustomerio) No falseIntentDirective specified"); 
         if (callback) {
           callback();
         }
@@ -295,14 +269,13 @@ class DirCustomerio {
         },
         method: "GET"
       }
-      if (this.log) { console.log("Customerio INTEGRATIONS_HTTPREQUEST ", INTEGRATIONS_HTTPREQUEST) }
+      winston.debug("(DirCustomerio) Integration HttpRequest ", INTEGRATIONS_HTTPREQUEST)
 
       this.#myrequest(
         INTEGRATIONS_HTTPREQUEST, async (err, integration) => {
           if (err) {
             resolve(null);
           } else {
-            if (this.log) { console.log('Integration: ', integration); }
             if (integration &&
               integration.value) {
               resolve(integration.value.apikey)

package/tiledeskChatbotPlugs/directives/DirDeflectToHelpCenter.js

@@ -3,6 +3,7 @@ const { TiledeskChatbot } = require('../../models/TiledeskChatbot.js');
 const { TiledeskChatbotConst } = require('../../models/TiledeskChatbotConst');
 const ms = require('minimist-string');
 const { TiledeskClient } = require('@tiledesk/tiledesk-client');
+const winston = require('../../utils/winston');
 
 class DirDeflectToHelpCenter {
 
@@ -24,6 +25,7 @@ class DirDeflectToHelpCenter {
   }
 
   async execute(directive, callback) {
+    winston.verbose("Execute DeflectToHelpCenter directive");
     let action;
     if (directive.action) {
       action = directive.action
@@ -60,12 +62,11 @@ class DirDeflectToHelpCenter {
       url_target = action.urlTarget;
     }
     // let message = pipeline.message;
-    //console.log("help center message", JSON.stringify(message));
     const last_user_text = await TiledeskChatbot.getParameterStatic(
       this.context.tdcache,
       this.context.requestId,
       TiledeskChatbotConst.REQ_LAST_USER_TEXT_KEY);
-    if (this.log) {console.log("last_user_text", last_user_text);}
+      winston.debug("(DirDeflectToHelpCenter) last_user_text", last_user_text);
     if (last_user_text && last_user_text.trim() !== '') {
       const helpcenter = new HelpCenterQuery({
         APIKEY: "__",
@@ -76,30 +77,29 @@ class DirDeflectToHelpCenter {
         helpcenter.APIURL = this.helpcenter_api_endpoint
       }
       if (!workspace_id) {
-        if (this.log) {console.log("No workspaces_id. Listing all workspaces to eventually select the first");}
+        winston.debug("(DirDeflectToHelpCenter) No workspaces_id. Listing all workspaces to eventually select the first");
         try {
           // find/select the first workspace
           const workspaces = await helpcenter.allWorkspaces();
           if (workspaces.length > 0) {
             workspace_id = workspaces[0]._id;
-            // console.log("First Workspace selected", workspaces[0]);
           }
           else {
-            if (this.log) {console.log("No Workspaces found");}
+            winston.debug("(DirDeflectToHelpCenter) No Workspaces found");
             callback(false);
           }
         }
         catch(err) {
-          console.error("deflectToHelpCenter Error (search workspaces):", err);
+          winston.error("(DirDeflectToHelpCenter) Error search workspaces: ", err);
           callback(false);
         }
       }
-      if (this.log) {console.log("searching on workspace_id:", workspace_id);}
+      winston.debug("(DirDeflectToHelpCenter) searching on workspace_id: " + workspace_id);
       try {
         const results = await helpcenter.search(workspace_id, last_user_text, maxresults);
         if (results && results.length > 0) {
-          if (this.log) {console.log("Successfully got results", JSON.stringify(results));}
-          if (this.log) {console.log("Sending hcReply", hc_reply);}
+          winston.debug("(DirDeflectToHelpCenter) Successfully got results ", results);
+          winston.debug("(DirDeflectToHelpCenter) Sending hcReply ", hc_reply);
           // pipeline.message.text = hc_reply;
           let buttons = [];
           results.forEach(content => {
@@ -141,26 +141,26 @@ class DirDeflectToHelpCenter {
             }
           }
 
-          if (this.log) {console.log("HC reply:", JSON.stringify(message))};
+          winston.debug("(DirDeflectToHelpCenter) HC reply: ", message)
           this.tdClient.sendSupportMessage(
             this.context.requestId,
             message,
             (err) => {
               if (err) {
-                console.error("Error sending reply:", err.message);
+                winston.error("(DirDeflectToHelpCenter) Error sending reply: " + err.message);
                 callback(false);
               }
-              if (this.log) {console.log("Reply message sent.");}
+              winston.debug("(DirDeflectToHelpCenter) Reply message sent.");
               callback(true);
           });
         }
         else {
-          if (this.log) {console.log("Nothing found in Help Center. projectId:", project_id, "workspaceId:", workspace_id);}
+          winston.debug("(DirDeflectToHelpCenter) Nothing found in Help Center. projectId: " + project_id + " workspaceId: " + workspace_id);
           callback(false);
         }
       }
       catch(err) {
-        console.error("deflectToHelpCenter Error (searching results):", err);
+        winston.error("(DirDeflectToHelpCenter)  Error (searching results): ", err);
         callback(false);
       }
     }
@@ -172,9 +172,8 @@ class DirDeflectToHelpCenter {
   parseParams(directive_parameter) {
     let workspace_id = null;
     let hc_reply = null;
-    // console.log("ms found:", ms)
+    
     const params = ms(directive_parameter);
-    // console.log("ms decoded params:", params)
     if (params.w) {
       workspace_id = params.w
     }
@@ -183,16 +182,12 @@ class DirDeflectToHelpCenter {
     }
     
     if (params.m) {
-      // console.log("_params.m:", params.m)
       //hc_reply = params.m.replaceAll("\\n", "\n");
       hc_reply = params.m.replace(/\\n/g, "\n");
-      // console.log("hc_reply with replaced slash n regex|replaceAll", hc_reply)
     }
     if (params.message) {
-      // console.log("_params.message:", params.message)
       //hc_reply = params.message.replaceAll("\\n", "\n");
       hc_reply = params.message.replace(/\\n/g, "\n");
-      // console.log("hc_reply -message with replaced slash n replace(/\\n/g", hc_reply)
     }
     return {
       workspace_id: workspace_id,

package/tiledeskChatbotPlugs/directives/DirDeleteVariable.js

@@ -2,6 +2,7 @@ const { param } = require('express/lib/request');
 const ms = require('minimist-string');
 const { TiledeskChatbot } = require('../../models/TiledeskChatbot');
 const { Filler } = require('../Filler');
+const winston = require('../../utils/winston');
 
 class DirDeleteVariable {
 
@@ -14,6 +15,7 @@ class DirDeleteVariable {
   }
 
   async execute(directive, callback) {
+    winston.verbose("Execute DeleteVariable directive");
     let action;
     if (directive.action) {
       action = directive.action
@@ -29,11 +31,11 @@ class DirDeleteVariable {
   }
 
   async go(action, callback) {
-    // let variableName = action.body.variableName;
+    winston.debug("(DirDeleteVariable) Action: ", action);
+
     let variableName = action.variableName;
-    // console.log("DirDeleteVariable:", directive);
     if (!variableName) {
-      if (this.log) {console.log("Error deleting variable. Missing 'variableName' error. Skipping");}
+      winston.error("(DirDeleteVariable) deleting variable. Missing 'variableName' error. Skipping");
       if (callback) {
         callback();
       }
@@ -46,11 +48,9 @@ class DirDeleteVariable {
           await TiledeskChatbot.allParametersStatic(
             this.context.tdcache, this.context.requestId
           );
-          // console.log("All availabe variables before deletion:", variables);
+
           const filler = new Filler();
-          // console.log("delete variable name:", variableName);
           variableName = filler.fill(variableName, variables);
-          // console.log("delete variable name (after filling):", variableName);
           await TiledeskChatbot.deleteParameterStatic(
             this.context.tdcache, this.context.requestId, variableName
           );
@@ -60,7 +60,7 @@ class DirDeleteVariable {
         }
       }
       catch(err) {
-        console.error("DirDeleteVariable error:", err);
+        winston.error("(DirDeleteVariable)  error: ", err);
         if (completion) {
           completion();
         }

package/tiledeskChatbotPlugs/directives/DirDepartment.js

@@ -1,4 +1,5 @@
 const { TiledeskClient } = require("@tiledesk/tiledesk-client");
+const winston = require('../../utils/winston');
 
 class DirDepartment {
 
@@ -21,7 +22,7 @@ class DirDepartment {
   }
 
   execute(directive, callback) {
-    // if (this.log) {console.log("DirDepartment:", dep_name);}
+    winston.verbose("Execute Department directive");
     let action;
     if (directive.action) {
       action = directive.action;
@@ -61,15 +62,15 @@ class DirDepartment {
   // }
 
   go(action, callback) {
-    if (this.log) {console.log("Switching to department:", action.depName);}
+    winston.debug("(DirDepartment) Action: ", action);
     const depName = action.depName;
     this.moveToDepartment(this.requestId, depName, (deps) => {
       if (!deps) {
-        if (this.log) {console.log("Dep not found");}
+        winston.warn("(DirDepartment) Dep not found");
         callback();
         return
       }
-      if (this.log) {console.log("Switched to dept:", depName, "action:", JSON.stringify(action));}
+      winston.debug("(DirDepartment) Switched to dept: " + depName + " action: " + JSON.stringify(action));
       if (action.triggerBot) {
         let dep = null;
         let i;
@@ -81,7 +82,7 @@ class DirDepartment {
           }
         }
         if (dep && dep.hasBot === true && dep.id_bot) {
-          if (this.log) {console.log("Sending hidden /start message to bot in dept");}
+          winston.debug("(DirDepartment) Sending hidden /start message to bot in dept");
           const message = {
             type: "text",
             text: "/start",
@@ -93,15 +94,15 @@ class DirDepartment {
             this.requestId,
             message, (err) => {
               if (err) {
-                console.error("Error sending hidden message:", err.message);
+                winston.error("(DirDepartment) Error sending hidden message: " + err.message)
               }
-              if (this.log) {console.log("Hidden message sent.");}
+              winston.debug("(DirDepartment) Hidden message sent.");
               callback();
           });
         }
       }
       else {
-        if (this.log) {console.log("No action.triggerBot");}
+        winston.debug("(DirDepartment) No action.triggerBot");
         callback();
       }
     });
@@ -109,9 +110,9 @@ class DirDepartment {
 
   moveToDepartment(requestId, depName, callback) {
     this.tdClient.getAllDepartments((err, deps) => {
-      if (this.log) {console.log("deps:", JSON.stringify(deps));}
+      winston.debug("(DirDepartment) deps: ", deps);
       if (err) {
-        console.error("getAllDepartments() error:", err);
+        winston.error("(DirDepartment) getAllDepartments() error: ", err);
         callback();
         return;
       }
@@ -127,11 +128,11 @@ class DirDepartment {
       if (dep) {
         this.tdClient.updateRequestDepartment(requestId, dep._id, null, (err, res) => {
           if (err) {
-            console.error("DirDepartment error:", err);
+            winston.error("(DirDepartment) updatedRequestDepartment error: ", err);
             callback();
           }
           else {
-            if (this.log) { console.log("DirDepartment response:",JSON.stringify(res)); }
+            winston.debug("(DirDepartment) response: ", res); 
             callback(deps);
           }
         });

package/tiledeskChatbotPlugs/directives/DirDisableInputText.js

@@ -1,4 +1,5 @@
 const ms = require('minimist-string');
+const winston = require('../../utils/winston');
 
 // DEPRECATED
 class DirDisableInputText {
@@ -7,7 +8,7 @@ class DirDisableInputText {
   }
 
   execute(directive, pipeline, callback) {
-    // console.log("disable input text...pipeline");
+    winston.verbose("Execute DisableInputText directive");
     let message = pipeline.message
     if (!message.attributes) {
       message.attributes = {}
@@ -15,10 +16,8 @@ class DirDisableInputText {
     message.attributes.disableInputMessage = true;
     if (directive.parameter) {
       const options = this.parseParams(directive.parameter);
-      // console.log("Options", options)
       directive.options = options;
       if (options.label) {
-        // console.log("options.label", options.label)
         message.attributes.inputMessagePlaceholder = options.label;
       }
     }
@@ -28,13 +27,10 @@ class DirDisableInputText {
   parseParams(directive_parameter) {
     let label = null;
     const params = ms(directive_parameter);
-    // console.log("params:", params);
     if (params.l) {
-      // console.log("_param l", params.l);
       label = params.l;
     }
     if (params.label) {
-      // console.log("_param label", params.label);
       label = params.label;
     }
     return {

package/tiledeskChatbotPlugs/directives/DirFireTiledeskEvent.js

@@ -1,5 +1,6 @@
 const { TiledeskClient } = require('@tiledesk/tiledesk-client');
 const ms = require('minimist-string');
+const winston = require('../../utils/winston');
 
 class DirFireTiledeskEvent {
 
@@ -22,6 +23,7 @@ class DirFireTiledeskEvent {
   }
 
   execute(directive, callback) {
+    winston.verbose("Execute FireTiledeskEvent directive");
     if (directive.parameter) {
       const params = this.parseParams(directive.parameter);
       const event_name = params.name;
@@ -31,15 +33,13 @@ class DirFireTiledeskEvent {
       }
       this.tdClient.fireEvent(event, function(err, result) {
           if (err) {
-              console.error("An error occurred invoking an event:", err);
+              winston.error("(FireTiledeskEvent) An error occurred invoking an event: ", err);
           }
           callback();
       });
     }
     else {
-      if (this.log) {
-        console.log("DirFireTiledeskEvent: no parameter");
-      }
+      winston.verbose("(DirFireTiledeskEvent) no parameter");
       callback();
     }
   }