@tiledesk/tiledesk-tybot-connector 0.5.0 → 2.0.0

package/tiledeskChatbotPlugs/directives/DirSendWhatsapp.js

@@ -1,7 +1,9 @@
 const axios = require("axios").default;
-const { TiledeskChatbot } = require('../../models/TiledeskChatbot');
+const { TiledeskChatbot } = require('../../engine/TiledeskChatbot');
 const { Filler } = require("../Filler");
 const { DirIntent } = require("./DirIntent");
+const winston = require('../../utils/winston');
+const httpUtils = require("../../utils/HttpUtils");
 
 let whatsapp_api_url;
 
@@ -21,13 +23,13 @@ class DirSendWhatsapp {
   }
 
   execute(directive, callback) {
-    if (this.log) { console.log("DirWhatsappStatic directive: ", directive); }
+    winston.verbose("Execute SendWhatsapp directive");
     let action;
     if (directive.action) {
       action = directive.action;
     }
     else {
-      console.error("Incorrect directive: ", JSON.stringify(directive));
+      winston.warn("DirSendWhatsapp Incorrect directive: ", directive);
       callback();
       return;
     }
@@ -38,9 +40,9 @@ class DirSendWhatsapp {
 
   async go(action, callback) {
 
-    if (this.log) { console.log("DirWhatsappStatic action: ", JSON.stringify(action)) }
+    winston.debug("(DirSendWhatsapp) Action: ", action);
     if (!this.tdcache) {
-      console.error("Error: DirAskGPT tdcache is mandatory");
+      winston.error("(DirSendWhatsapp) Error: tdcache is mandatory");
       callback();
       return;
     }
@@ -80,7 +82,7 @@ class DirSendWhatsapp {
     } else {
       whatsapp_api_url = this.API_ENDPOINT + "/modules/whatsapp/api"
     }
-    if (this.log) { console.log("DirSendWhatsapp whatsapp_api_url: ", whatsapp_api_url); };
+    winston.debug("(DirSendWhatsapp) whatsapp_api_url: " + whatsapp_api_url);
 
     const HTTPREQUEST = {
       url: whatsapp_api_url + "/tiledesk/broadcast",
@@ -91,12 +93,12 @@ class DirSendWhatsapp {
       method: 'POST'
     }
 
-    if (this.log) { console.log("DirSendWhatsapp HTTPREQUEST:  ", HTTPREQUEST); }
+    winston.debug("(DirSendWhatsapp) HttpRequest:  ", HTTPREQUEST);
 
-    this.#myrequest(
+    httpUtils.request(
       HTTPREQUEST, async (err, resbody) => {
         if (err) {
-          console.error("DirSendWhatsapp error: ", err);
+          winston.error("(DirSendWhatsapp)  error: ", err)
           await this.chatbot.addParameter("flowError", "SendWhatsapp Error: " + err);
           if (callback) {
             if (falseIntent) {
@@ -118,7 +120,7 @@ class DirSendWhatsapp {
             return;
           }
         } else {
-          if (this.log) { console.log("DirSendWhatsapp unexpected resbody: ", resbody); }
+          winston.debug("(DirSendWhatsapp) unexpected resbody: ", resbody);
           if (callback) {
             if (falseIntent) {
               await this.#executeCondition(false, trueIntent, null, falseIntent, null);
@@ -151,7 +153,7 @@ class DirSendWhatsapp {
         })
       }
       else {
-        if (this.log) { console.log("No trueIntentDirective specified"); }
+        winston.debug("(DirSendWhatsapp) No trueIntentDirective specified");
         if (callback) {
           callback();
         }
@@ -166,7 +168,7 @@ class DirSendWhatsapp {
         });
       }
       else {
-        if (this.log) { console.log("No falseIntentDirective specified"); }
+        winston.debug("(DirSendWhatsapp) No falseIntentDirective specified");
         if (callback) {
           callback();
         }
@@ -209,39 +211,12 @@ class DirSendWhatsapp {
         resolve(receiver);
 
       } catch(err) {
-        console.error("DirSendWhatsapp fillWholeReceiver error: ", err)
+        winston.error("(DirSendWhatsapp) fillWholeReceiver error: ", err)
         resolve(null);
       }
 
     })
   }
-
-  // HTTP REQUEST
-  async #myrequest(options, callback, log) {
-    return await axios({
-      url: options.url,
-      method: options.method,
-      data: options.json,
-      params: options.params,
-      headers: options.headers
-    }).then((res) => {
-      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((err) => {
-      console.error("(tybot request) An error occured: ", err);
-      if (callback) {
-        callback(err, null, null);
-      }
-    })
-  }
 }
 
 module.exports = { DirSendWhatsapp }

package/tiledeskChatbotPlugs/directives/DirSetAttribute.js

@@ -1,9 +1,10 @@
-const { TiledeskChatbot } = require('../../models/TiledeskChatbot');
+const { TiledeskChatbot } = require('../../engine/TiledeskChatbot');
 const { TiledeskExpression } = require('../../TiledeskExpression');
 const { TiledeskMath } = require('../../TiledeskMath');
 const { TiledeskString } = require('../../TiledeskString');
 const { Filler } = require('../Filler');
 const validate = require('jsonschema').validate;
+const winston = require('../../utils/winston');
 
 const schema = {
     "type": "object",
@@ -80,37 +81,39 @@ class DirSetAttribute {
     }
 
     execute(directive, callback) {
+        winston.verbose("Execute SetAttribute directive");
         let action;
         if (directive.action) {
             action = directive.action
         }
         else {
+            winston.warn("DirSetAttribute Incorrect directive: ", directive);
             callback();
             return;
         }
-        // console.log("go DirAssign with action:", action);
         this.go(action, () => {
             callback();
         });
     }
 
     async go(action, callback) {
+        winston.debug("(DirSetAttribute) Action: ", action);
         let res = validate(action, schema);
         if (!res.valid) {
-            if (this.log) {console.error("(DirSetAttribute) Invalid action:", res.errors)};
+            winston.error("(DirSetAttribute) Invalid action:", res.errors);
             callback();
             return;
         }
 
         if(action.operation.operators === undefined && action.operation.operands.length !== 1) {
-            if (this.log) {console.error("(DirSetAttribute) Invalid action: operators === undefined && operands.length !== 1")};
+            winston.error("(DirSetAttribute) Invalid action: operators === undefined && operands.length !== 1");
             callback();
             return;
         }
 
         
         if (action.operation.operators !== undefined && action.operation.operators.length !== action.operation.operands.length - 1) {
-            if (this.log) {console.error("(DirSetAttribute) Invalid action: operators.length !== operands.length - 1")};
+            winston.error("(DirSetAttribute) Invalid action: operators.length !== operands.length - 1");
             callback();
             return;
         }

package/tiledeskChatbotPlugs/directives/DirSetAttributeV2.js

@@ -1,9 +1,11 @@
-const { TiledeskChatbot } = require('../../models/TiledeskChatbot');
+const { TiledeskChatbot } = require('../../engine/TiledeskChatbot');
 const { TiledeskExpression } = require('../../TiledeskExpression');
 const { TiledeskMath } = require('../../TiledeskMath');
 const { TiledeskString } = require('../../TiledeskString');
 const { Filler } = require('../Filler');
 const validate = require('jsonschema').validate;
+const winston = require('../../utils/winston');
+const httpUtils = require('../../utils/HttpUtils');
 
 const schema = {
     "type": "object",
@@ -81,86 +83,66 @@ class DirSetAttributeV2 {
     }
 
     execute(directive, callback) {
+        winston.verbose("Execute SetAttributeV2 directive");
         let action;
         if (directive.action) {
             action = directive.action
         }
         else {
+            winston.warn("DirSetAttributeV2 Incorrect directive: ", directive);
             callback();
             return;
         }
-        // console.log("go DirAssign with action:", action);
         this.go(action, () => {
             callback();
         });
     }
 
     async go(action, callback) {
-        if (this.log) {console.log("(DirSetAttribute) action before filling:", JSON.stringify(action));}
-        // if (!action) {
-        //     if (this.log) {console.log("(SetAttributeV2) Error 'action' is missing");}
-        //     callback();
-        //     return;
-        // }
+        winston.debug("(DirSetAttributeV2) Action: ", action);
+      
         if (action && !action.operation) {
-            if (this.log) {console.log("(SetAttributeV2) Error operation is mandatory");}
+            winston.error("(DirSetAttributeV2) Error operation is mandatory");
             callback();
+            return;
         }
         if (action && action.operation && action.operation.operands) {
-            if (this.log) {console.log("(SetAttributeV2) filling in setattribute...");}
+            winston.debug("(DirSetAttributeV2) filling in setattribute...");
             await this.fillValues(action.operation.operands);
         }
-        if (this.log) { console.log("action.operation.operands.length", action.operation.operands.length); }
-        if (this.log) { console.log("action.operation.operands[0].type", action.operation.operands[0].type); }
         
         // FUN FACT: THIS TOOK A LOT OF EFFORT BUT IT WAS NEVER USED. YOU CAN SIMPLY CREATE A JSON ATTRIBUTE APPLYING
         // JSONparse FUNCTION TO AN ATTRIBUTE.
         // DEPRECATED because type = json is not available in the UI!
         if (action.operation.operands && action.operation.operands.length === 1 && action.operation.operands[0].type === "json") {
-            if (this.log) {console.log("(SetAttributeV2) setting json value...");}
-            if (this.log) { console.log("(SetAttributeV2) setting json value... destination:", action.destination); }
             const json_value = JSON.parse(action.operation.operands[0].value);
-            if (this.log) { console.log("(SetAttributeV2) json_value:", json_value); }
             await this.saveAttribute(action.destination, json_value);
             // await TiledeskChatbot.addParameterStatic(this.context.tdcache, this.context.requestId, action.destination, json_value);
             callback();
             return; // on json types no operations are permitted beyond assignment
         }
-        if (this.log) {console.log("filled in setattribute:", action.operation);}
-        // let res = validate(action, schema);
-        // if (res.errors) {
-        //     console.log("(DirSetAttribute) failed validation action:", JSON.stringify(action));
-        //     console.log("DirSetAttribute validation errors:", res.errors);
-        // }
-        // if (!res.valid) {
-        //     if (this.log) {console.error("(DirSetAttribute) Invalid action:", res.errors)};
-        //     callback();
-        //     return;
-        // }
+        winston.debug("(DirSetAttributeV2) filled in setattribute:", action.operation);
+       
         if (action.operation?.operators === undefined && action.operation?.operands?.length !== 1) {
-            if (this.log) {console.error("(DirSetAttribute) Invalid action: operators === undefined && operands.length !== 1")};
+            winston.error("(DirSetAttributeV2) Invalid action: operators === undefined && operands.length !== 1")
             callback();
             return;
         }
         if (action.operation?.operators !== undefined && action.operation?.operators?.length !== action.operation?.operands?.length - 1) {
-            if (this.log) {console.error("(DirSetAttribute) Invalid action: operators.length !== operands.length - 1")};
+            winston.error("(DirSetAttributeV2) Invalid action: operators.length !== operands.length - 1")
             callback();
             return;
         }
         // if (action && action.operation && action.operation.operands) {
-        //     console.log("filling in setattribute...");
         //     await this.fillValues(action.operation.operands);
         // }
-        // console.log("dirsetattribute, action.operation.operands:", action.operation.operands);
         try {
             const expression = TiledeskExpression.JSONOperationToExpression(action.operation?.operators, action.operation?.operands);
             const attributes = await TiledeskChatbot.allParametersStatic(this.context.tdcache, this.context.requestId);
-            // console.log("dirsetattribute, attributes:", attributes);
             if (attributes) {
                 attributes.TiledeskMath = TiledeskMath;
                 attributes.TiledeskString = TiledeskString;
                 const result = new TiledeskExpression().evaluateJavascriptExpression(expression, attributes);
-                // console.log("filling in setattribute, result:", result);
                 // THE GOAL OF ATTRIBUTE-FILLING THE "DESTINATION" FIELD IS TO SUPPORT DYNAMIC ATTRIBUTES
                 // (ATTRS WHOSE NAME IS UNKNOWN AD DESIGN-TIME)
                 // STILL UNSUPPORTED IN UI
@@ -169,7 +151,7 @@ class DirSetAttributeV2 {
             }
         }
         catch(err) {
-            console.error("SetAttributeV2 error:", err);
+            winston.error("(DirSetAttributeV2)  error:", err);
         }
         
         // await TiledeskChatbot.addParameterStatic(this.context.tdcache, this.context.requestId, destination, result);
@@ -177,12 +159,9 @@ class DirSetAttributeV2 {
     }
 
     async saveAttribute(key, value, persist) {
-        if (this.log) {
-            console.log("SetAttributeV2 saving attribute:", key, value, persist);
-        }
+        winston.debug("(DirSetAttributeV2) saving attribute: " + key + " " + value + " " + persist);
         await TiledeskChatbot.addParameterStatic(this.context.tdcache, this.context.requestId, key, value);
         // if (persist) {
-        //     console.log("SetAttributeV2 persisting...");
         //     await this.persistOnTiledesk(destination, result);
         // }
         
@@ -216,19 +195,15 @@ class DirSetAttributeV2 {
             json: json,
             method: 'POST'
         }
-        if (this.log) { console.log("SetAttribute. HTTPREQUEST: ", HTTPREQUEST); }
-        this.#myrequest(
+        winston.debug("(DirSetAttributeV2) HttpRequest: ", HTTPREQUEST);
+        httpUtils.request(
             HTTPREQUEST, async (err, resbody) => {
                 if (err) {
                     if (this.log) {
-                        console.error("SetAttribute. persistOnTiledesk() error:", err);
+                        winston.error("(DirSetAttributeV2) persistOnTiledesk() error: ", err);
                     }
-                    // callback();
-                    // return;
                 } else {
-                    if (this.log) { console.log("SetAttribute. Attributes saved.", JSON.stringify(resbody)); }
-                    // callback();
-                    // return;
+                    winston.debug("(DirSetAttributeV2) Attributes saved: ", resbody);
                 }
             }
         );
@@ -237,13 +212,10 @@ class DirSetAttributeV2 {
 
     async fillDestination(destination) {
         if (this.tdcache) {
-            // console.log("tdcache in setattribute...", this.tdcache);
             const requestAttributes = 
                 await TiledeskChatbot.allParametersStatic(this.tdcache, this.context.requestId);
-            // console.log("requestAttributes in setattribute...", requestAttributes);
             const filler = new Filler();
             destination = filler.fill(destination, requestAttributes);
-            // console.log("setattribute, final destination:", destination);
         }
         return destination
     }
@@ -276,27 +248,21 @@ class DirSetAttributeV2 {
         //     ]
         try {
             if (this.tdcache) {
-                // console.log("tdcache in setattribute...", this.tdcache);
                 const requestAttributes = 
                     await TiledeskChatbot.allParametersStatic(this.tdcache, this.context.requestId);
-                // console.log("requestAttributes in setattribute...", requestAttributes);
                 const filler = new Filler();
                 operands.forEach(operand => {
-                    // if (!operand.isVariable) {
-                        // console.log("setattribute, liquid operand:", operand);
-                        operand.value = filler.fill(operand.value, requestAttributes);
-                        // console.log("setattribute, final operand:", operand);
-                    // }
+                    operand.value = filler.fill(operand.value, requestAttributes);
                 });
             }
         }
         catch(error) {
-            console.error("Error while filling operands:", error);
+            winston.error("(DirSetAttributeV2) Error while filling operands: ", error);
         }
     }
 
     convertOperandValues(operands) {
-        console.log("Converting operands:", operands);
+        winston.debug("(DirSetAttributeV2) Converting operands:", operands);
         // operation: {
         //     operators: ["addAsNumber", "subtractAsNumber", "divideAsNumber", "multiplyAsNumber"],
         //     operands: [
@@ -309,75 +275,21 @@ class DirSetAttributeV2 {
         try {
             operands.forEach(operand => {
                 if (operand.type) {
-                    console.log("Converting operands - operand.type:", operand.type.toLowerCase());
                     if (operand.type.toLowerCase() === "number") {
-                        console.log("Converting operands - number");
                         operand.value = Number(operand.value);
-                        console.log("new value:", operand.value);
-                        console.log("new value type:", typeof operand.value);
                     }
                     else if (operand.type.toLowerCase() === "json") {
-                        console.log("Converting operands - json, value =", operand.value);
                         operand.value = JSON.parse(operand.value);
-                        console.log("new value:", operand.value);
-                        console.log("new value type:", typeof operand.value);
                     }
                     else {
-                        console.log("Converting operands - ??");
+                        winston.warn("Converting operands - ??");
                     }
                 }
             });
         }
         catch(error) {
-            console.error("Error while converting operands:", error);
-        }
-    }
-
-    #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,
-          params: options.params,
-          headers: options.headers
-        }
-        if (options.json !== null) {
-          axios_options.data = options.json
+            winston.error("(DirSetAttributeV2) Error while converting operands: ", error);
         }
-        if (this.log) {
-          console.log("axios_options:", JSON.stringify(axios_options));
-        }
-        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(new Error("Response status is not 200"), null);
-                }
-            }
-        })
-        .catch((error) => {
-            if (callback) {
-                callback(error, null);
-            }
-        });
     }
 
     fixToken(token) {

package/tiledeskChatbotPlugs/directives/DirSetConversationTags.js

@@ -1,5 +1,6 @@
 const { TiledeskClient } = require('@tiledesk/tiledesk-client');
 const { Filler } = require('../Filler');
+const winston = require('../../utils/winston');
 
 class DirSetConversationTags {
 
@@ -22,11 +23,13 @@ class DirSetConversationTags {
   }
 
   execute(directive, callback) {
+    winston.verbose("Execute SetConversationTags directive");
     let action;
     if (directive.action) {
         action = directive.action
     }
     else {
+        winston.warn("DirSetAttribute Incorrect directive: ", directive);
         callback();
         return;
     }
@@ -36,11 +39,11 @@ class DirSetConversationTags {
   }
 
   async go(action, callback) {
-    if (this.log) {console.log("(DirSetConversationTags) Adding conversation tags:", action.depName);}
+    winston.debug("(DirSetConversationTags) Action: ", action);
     let tagsString = action.tags;
     tagsString = tagsString.replace(/ /g,"");
     if (tagsString.length === 0) {
-      if (this.log) {console.error("(DirSetConversationTags) Invalid action: tags string is empty")};
+      winston.debug("(DirSetConversationTags) Invalid action: tags string is empty");
       callback();
       return;
     }
@@ -53,15 +56,15 @@ class DirSetConversationTags {
       }
     }
     catch(error) {
-        console.error("Error while filling operands:", error);
+      winston.error("(DirSetConversationTags) Error while filling operands: ", error);
     }
     this.moveToDepartment(this.requestId, depName, (deps) => {
       if (!deps) {
-        if (this.log) {console.log("Dep not found");}
+        winston.debug("(DirSetConversationTags) Dep not found");
         callback();
         return
       }
-      if (this.log) {console.log("Switched to dept:", depName, "action:", JSON.stringify(action));}
+      winston.debug("(DirSetConversationTags) Switched to dept: " + depName + " action: ", JSON.stringify(action));
       if (action.triggerBot) {
         let dep = null;
         let i;
@@ -73,7 +76,7 @@ class DirSetConversationTags {
           }
         }
         if (dep && dep.hasBot === true && dep.id_bot) {
-          if (this.log) {console.log("Sending hidden /start message to bot in dept");}
+          winston.debug("(DirSetConversationTags) Sending hidden /start message to bot in dept");
           const message = {
             type: "text",
             text: "/start",
@@ -85,15 +88,14 @@ class DirSetConversationTags {
             this.requestId,
             message, (err) => {
               if (err) {
-                console.error("Error sending hidden message:", err.message);
+                winston.error("(DirSetConversationTags) Error sending hidden message: " + err.message);
               }
-              if (this.log) {console.log("Hidden message sent.");}
               callback();
           });
         }
       }
       else {
-        if (this.log) {console.log("No action.triggerBot");}
+        winston.debug("(DirSetConversationTags) No action.triggerBot");
         callback();
       }
     });
@@ -101,9 +103,8 @@ class DirSetConversationTags {
 
   moveToDepartment(requestId, depName, callback) {
     this.tdClient.getAllDepartments((err, deps) => {
-      if (this.log) {console.log("deps:", JSON.stringify(deps));}
       if (err) {
-        console.error("getAllDepartments() error:", err);
+        winston.error("(DirSetConversationTags) getAllDepartments() error: ", err);
         callback();
         return;
       }
@@ -119,11 +120,11 @@ class DirSetConversationTags {
       if (dep) {
         this.tdClient.updateRequestDepartment(requestId, dep._id, null, (err, res) => {
           if (err) {
-            console.error("DirDepartment error:", err);
+            winston.debug("(DirSetConversationTags) error:", err);
             callback();
           }
           else {
-            console.log("DirDepartment response:",JSON.stringify(res));
+            winston.debug("(DirSetConversationTags) response: ", res);
             callback(deps);
           }
         });

package/tiledeskChatbotPlugs/directives/DirUnlockIntent.js

@@ -1,3 +1,4 @@
+const winston = require('../../utils/winston');
 
 class DirUnlockIntent {
 
@@ -14,6 +15,7 @@ class DirUnlockIntent {
   }
 
   async execute(directive, callback) {
+    winston.verbose("Execute UnlockIntent directive");
     let action;
     if (directive.action) {
       action = directive.action;
@@ -21,13 +23,13 @@ class DirUnlockIntent {
     else {
       action = {}
     }
-    if (this.log) {console.log("Unlocking current intent");}
     this.go(action, () => {
       callback();
     });
   }
 
   async go(action, callback) {
+    winston.debug("(DirUnlockIntent) Action: ", action);
     await DirUnlockIntent.unlockIntent(this.tdcache, this.context.requestId);
     if (callback) {
       callback();
@@ -35,7 +37,6 @@ class DirUnlockIntent {
   }
 
   // async execute(requestId, callback) {
-  //   console.log("Unocking intent");
   //   await this.unlockIntent(requestId);
   //   callback();
   // }
@@ -43,7 +44,6 @@ class DirUnlockIntent {
   static async unlockIntent(tdcache, requestId) {
     await tdcache.del("tilebot:requests:"  + requestId + ":locked");
     // await this.tdcache.del("tilebot:requests:"  + requestId + ":locked");
-    // console.log("unlocked.")
   }
   
 }

package/tiledeskChatbotPlugs/directives/DirWait.js

@@ -1,5 +1,6 @@
 
-const { TiledeskChatbot } = require('../../models/TiledeskChatbot');
+const { TiledeskChatbot } = require('../../engine/TiledeskChatbot');
+const winston = require('../../utils/winston');
 
 class DirWait {
 
@@ -16,6 +17,7 @@ class DirWait {
 
   execute(directive, callback) {
     //  500ms < wait-time < 10.000ms
+    winston.verbose("Execute Wait directive");
     let action;
     if (directive.action) {
       action = directive.action;
@@ -41,22 +43,19 @@ class DirWait {
         millis: 500
       }
     }
-    // console.log("____-----_", action)
+
     this.go(action, () => {
-      // console.log("YES", callback)
       callback();
     })
   }
 
   async go(action, callback) {
+    winston.debug("(DirWait) Action: ", action);
     // reset step?
     // const step_key = TiledeskChatbot.requestCacheKey(this.requestId) + ":step";
-    // console.log("step_key:", step_key);
     if (action && action.millis >= 1000) {//2000 * 60) { // at list 2 minutes waiting time to reset the steps counter
       // await this.tdcache.set(step_key, 0);
-      // console.log("resetting steps counter");
       await TiledeskChatbot.resetStep(this.tdcache, this.requestId);
-      // console.log("step_key after:", await this.tdcache.get( step_key ));
     }
     setTimeout(() => {
       callback();