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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tiledesk/tiledesk-tybot-connector",
-  "version": "2.0.9",
+  "version": "2.0.10-rc10",
   "description": "Tiledesk Tybot connector",
   "main": "index.js",
   "scripts": {
@@ -15,7 +15,7 @@
     "@tiledesk/tiledesk-chatbot-client": "^0.5.30",
     "@tiledesk/tiledesk-chatbot-util": "^0.8.39",
     "@tiledesk/tiledesk-client": "^0.10.13",
-    "@tiledesk/tiledesk-multi-worker": "^0.2.1-rc2",
+    "@tiledesk/tiledesk-multi-worker": "^0.3.1-rc12",
     "accept-language-parser": "^1.5.0",
     "app-root-path": "^3.1.0",
     "axios": "^1.7.7",
@@ -29,6 +29,7 @@
     "liquidjs": "^10.8.4",
     "minimist-string": "^1.0.2",
     "mongoose": "^6.3.5",
+    "mqtt": "^5.10.4",
     "multer": "^1.4.5-lts.1",
     "nanoid": "^3.1.25",
     "redis": "^4.7.0",

package/services/AIService.js

@@ -31,7 +31,7 @@ class AiService {
                 else {
                   resolve(resbody)
                 }
-            }, this.LOG
+            }
           );
         }); 
       }

package/tiledeskChatbotPlugs/DirectivesChatbotPlug.js

@@ -57,8 +57,10 @@ const { DirReplaceBotV3 } = require('./directives/DirReplaceBotV3');
 const { DirAiTask, DirAiPrompt } = require('./directives/DirAiPrompt');
 const { DirWebResponse } = require('./directives/DirWebResponse');
 const { DirConnectBlock } = require('./directives/DirConnectBlock');
+const { DirAddKbContent } = require('./directives/DirAddKbContent');
 
 const winston = require('../utils/winston');
+const { DirFlowLog } = require('./directives/DirFlowLog');
 
 class DirectivesChatbotPlug {
 
@@ -73,7 +75,6 @@ class DirectivesChatbotPlug {
     this.API_ENDPOINT = config.API_ENDPOINT;
     this.TILEBOT_ENDPOINT = config.TILEBOT_ENDPOINT;
     this.token = config.token;
-    this.log = config.log;
     this.HELP_CENTER_API_ENDPOINT = config.HELP_CENTER_API_ENDPOINT;
     this.tdcache = config.cache;
     this.directives = config.directives;
@@ -142,8 +143,7 @@ class DirectivesChatbotPlug {
         projectId: projectId,
         token: token,
         APIURL: API_ENDPOINT,
-        APIKEY: "___",
-        log: this.log
+        APIKEY: "___"
       });
     }
     catch(err) {
@@ -162,8 +162,7 @@ class DirectivesChatbotPlug {
       TILEBOT_ENDPOINT: TILEBOT_ENDPOINT,
       departmentId: depId,
       tdcache: tdcache,
-      HELP_CENTER_API_ENDPOINT: this.HELP_CENTER_API_ENDPOINT,
-      log: this.log
+      HELP_CENTER_API_ENDPOINT: this.HELP_CENTER_API_ENDPOINT
     }
     winston.debug("(DirectivesChatbotPlug) this.context.departmentId: " + this.context.departmentId);
     
@@ -177,9 +176,7 @@ class DirectivesChatbotPlug {
 
   async nextDirective(directives) {
     winston.debug("(DirectivesChatbotPlug) ....nextDirective() checkStep()");
-    const go_on = await TiledeskChatbot.checkStep(
-      this.context.tdcache, this.context.requestId, this.chatbot?.MAX_STEPS,  this.chatbot?.MAX_EXECUTION_TIME, this.log
-    );
+    const go_on = await TiledeskChatbot.checkStep(this.context.tdcache, this.context.requestId, this.chatbot?.MAX_STEPS,  this.chatbot?.MAX_EXECUTION_TIME);
 
     if (go_on.error) {
       winston.debug("(DirectivesChatbotPlug) go_on == false! nextDirective() Stopped!");
@@ -222,14 +219,13 @@ class DirectivesChatbotPlug {
       directive_name = directive.name.toLowerCase();
     }
     if (directive && directive.action) {
-        const action_id = directive.action["_tdActionId"];
-        const locked_action_id = await this.chatbot.currentLockedAction(this.supportRequest.request_id);
-        if ( locked_action_id && (locked_action_id !== action_id) ) {
-          let next_dir = await this.nextDirective(this.directives);
-          this.process(next_dir);
-          return;
-        }
-      
+      const action_id = directive.action["_tdActionId"];
+      const locked_action_id = await this.chatbot.currentLockedAction(this.supportRequest.request_id);
+      if ( locked_action_id && (locked_action_id !== action_id) ) {
+        let next_dir = await this.nextDirective(this.directives);
+        this.process(next_dir);
+        return;
+      }      
     }
     if (directive == null || (directive !== null && directive["name"] === undefined)) {
       winston.debug("(DirectivesChatbotPlug) stop process(). directive is (null?): ", directive);
@@ -701,12 +697,37 @@ class DirectivesChatbotPlug {
         }
       });
     }
+    else if (directive_name === Directives.WEBHOOK) {
+      // console.log(".....DirIntent")
+      new DirIntent(context).execute(directive, async (stop) => {
+        if (stop) {
+          if (context.log) { console.log("Stopping Actions on:", JSON.stringify(directive));}
+          this.theend();
+        }
+        else {
+          let next_dir = await this.nextDirective(this.directives);
+          this.process(next_dir);
+        }
+      });
+    }
     else if (directive_name === Directives.WEB_RESPONSE) {
       new DirWebResponse(context).execute(directive, async () => {
         let next_dir = await this.nextDirective(this.directives);
         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 if (directive_name === Directives.ADD_KB_CONTENT) {
+      new DirAddKbContent(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);
@@ -733,8 +754,7 @@ class DirectivesChatbotPlug {
       projectId: projectId,
       token: token,
       APIURL: API_ENDPOINT,
-      APIKEY: "___",
-      log: false
+      APIKEY: "___"
     });
     let i = -1;
     winston.debug("(DirectivesChatbotPlug) processing Inline directives: ", directives);

package/tiledeskChatbotPlugs/FillParamsChatbotPlug.js

@@ -11,8 +11,7 @@ class FillParamsChatbotPlug {
    * 
    */
 
-  constructor(request, tdcache, log) {
-    this.log = log;
+  constructor(request, tdcache) {
     this.tdcache = tdcache;
     this.request = request;
   }

package/tiledeskChatbotPlugs/MarkbotChatbotPlug.js

@@ -10,9 +10,7 @@ class MarkbotChatbotPlug {
    * 
    */
 
-  constructor(log) {
-    this.log = log;
-  }
+  constructor() {}
 
   exec(pipeline) {
     let message = pipeline.message;

package/tiledeskChatbotPlugs/SplitsChatbotPlug.js

@@ -10,9 +10,7 @@ class SplitsChatbotPlug {
    * 
    */
 
-  constructor(log) {
-    this.log = log;
-  }
+  constructor() {}
 
   exec(pipeline) {
     let message = pipeline.message;

package/tiledeskChatbotPlugs/WebhookChatbotPlug.js

@@ -3,11 +3,10 @@ const winston = require('../utils/winston');
 
 class WebhookChatbotPlug {
 
-  constructor(supportRequest, webhookurl, token, log) {
+  constructor(supportRequest, webhookurl, token) {
     this.supportRequest = supportRequest;
     this.webhookurl = webhookurl;
     this.token = token;
-    this.log = log;
   }
 
   exec(pipeline) {
@@ -101,19 +100,18 @@ class WebhookChatbotPlug {
             callback(null, res.data);
           }
         }
-      }, this.log
-    );
+      });
   }
 
   // ************************************************
   // ****************** HTTP REQUEST ****************
   // ************************************************
 
-  static myrequest(options, callback, log) {
-    if (log) {
+  static myrequest(options, callback) {
+
       winston.debug("(WebhookChatbotPlug) myrequest API URL:" + options.url);
       winston.debug("(WebhookChatbotPlug) myrequest Options:", options);
-    }
+
     axios(
       {
         url: options.url,
@@ -122,11 +120,11 @@ class WebhookChatbotPlug {
         headers: options.headers
       })
     .then(function (res) {
-      if (log) {
+
         winston.debug("(WebhookChatbotPlug) myrequest Response for url:", options.url);
         winston.debug("(WebhookChatbotPlug) myrequest Response headers:\n", res.headers);
         winston.debug("(WebhookChatbotPlug) myrequest Response body:\n", res.data);
-      }
+
       if (callback) {
         callback(null, res);
       }

package/tiledeskChatbotPlugs/directives/DEPRECATED_DirIfNotOpenHours.js

@@ -12,8 +12,7 @@ class DirIfNotOpenHours {
       projectId: context.projectId,
       token: context.token,
       APIURL: context.TILEDESK_APIURL,
-      APIKEY: "___",
-      log: context.log
+      APIKEY: "___"
     });
     // this.intentDir = config.intentDir;
     // let context =  {
@@ -22,19 +21,16 @@ class DirIfNotOpenHours {
     //   requestId: supportRequest,
     //   APIURL: API_URL,
     //   TILEBOT_ENDPOINT:TILEBOT_ENDPOINT,
-    //   departmentId: depId,
-    //   log: false
+    //   departmentId: depId
     // }
     this.intentDir = new DirIntent(
       {
         API_ENDPOINT: context.TILEDESK_APIURL,
         TILEBOT_ENDPOINT: context.TILEBOT_ENDPOINT,
         supportRequest: context.supportRequest,
-        token: context.token,
-        log: context.log
+        token: context.token
       }
     );
-    this.log = context.log;
   }
 
   execute(directive, callback) {
@@ -58,7 +54,6 @@ class DirIfNotOpenHours {
   go(action, callback) {
     const intentName = action.body.intentName;
     if (!intentName) {
-      if (this.log) {console.log("Invalid intent name for If-open-hours");}
       callback();
     }
     let intentDirective = {
@@ -69,13 +64,11 @@ class DirIfNotOpenHours {
       }
     }
     this.tdclient.openNow((err, result) => {
-      if (this.log) {console.log("openNow():", result);}
       if (err) {
         console.error("DirIfNotOpenHours Error:", err);
         callback();
       }
       else if (result && !result.isopen) {
-        if (this.log) {console.log("executing the action on 'closed'");}
         this.intentDir.execute(intentDirective, () => {
           callback();
         });

package/tiledeskChatbotPlugs/directives/DEPRECATED_DirIfOpenHours.js

@@ -12,8 +12,7 @@ class DirIfOpenHours {
       projectId: context.projectId,
       token: context.token,
       APIURL: context.TILEDESK_APIURL,
-      APIKEY: "___",
-      log: context.log
+      APIKEY: "___"
     });
     // let context =  {
     //   projectId: projectId,
@@ -22,7 +21,6 @@ class DirIfOpenHours {
     //   APIURL: API_URL,
     //   TILEBOT_ENDPOINT:TILEBOT_ENDPOINT,
     //   departmentId: depId,
-    //   log: false
     // }
     this.intentDir = new DirIntent(
       {
@@ -30,10 +28,8 @@ class DirIfOpenHours {
         TILEBOT_ENDPOINT: context.TILEBOT_ENDPOINT,
         supportRequest: context.supportRequest,
         token: context.token,
-        log: context.log
       }
-    );
-    this.log = context.log;
+    )
   }
 
   execute(directive, callback) {
@@ -56,7 +52,6 @@ class DirIfOpenHours {
   go(action, callback) {
     const intentName = action.body.intentName;
     if (!intentName) {
-      if (this.log) {console.log("Invalid intent name for If-open-hours");}
       callback();
     }
     let intentDirective = {
@@ -67,13 +62,11 @@ class DirIfOpenHours {
       }
     }
     this.tdclient.openNow((err, result) => {
-      if (this.log) {console.log("openNow():", result);}
       if (err) {
         console.error("DirIfOpenHours Error:", err);
         callback();
       }
       else if (result && result.isopen) {
-        if (this.log) {console.log("executing the action on 'open'");}
         this.intentDir.execute(intentDirective, () => {
           callback();
         });

package/tiledeskChatbotPlugs/directives/DirAddKbContent.js

@@ -0,0 +1,332 @@
+const axios = require("axios").default;
+const { TiledeskChatbot } = require('../../engine/TiledeskChatbot');
+const { Filler } = require('../Filler');
+let https = require("https");
+const { DirIntent } = require("./DirIntent");
+const { TiledeskChatbotConst } = require("../../engine/TiledeskChatbotConst");
+const { TiledeskChatbotUtil } = require("../../utils/TiledeskChatbotUtil");
+const assert = require("assert");
+require('dotenv').config();
+const winston = require('../../utils/winston');
+const httpUtils = require("../../utils/HttpUtils");
+const integrationService = require("../../services/IntegrationService");
+const { Logger } = require("../../Logger");
+
+class DirAddKbContent {
+
+  constructor(context) {
+    if (!context) {
+      throw new Error('context object is mandatory');
+    }
+    this.context = context;
+    this.chatbot = context.chatbot;
+    this.tdcache = this.context.tdcache;
+    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.logger = new Logger({ request_id: this.requestId, dev: this.context.supportRequest.draft });
+  }
+
+  execute(directive, callback) {
+    this.logger.info("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);
+    })
+  }
+
+  async go(action, callback) {
+    winston.debug("[DirAddKbContent] action:", action);
+    if (!this.tdcache) {
+      winston.error("[DirAddKbContent] Error: tdcache is mandatory");
+      callback();
+      return;
+    }
+
+    let publicKey = false;
+    let type = action.type;
+    let name = action.name;
+    let content = action.content;
+    let engine;
+
+    // default values
+    let namespace = this.context.projectId;
+
+    if (action.namespace) {
+      namespace = action.namespace;
+    }
+
+    let requestVariables = null;
+    requestVariables =
+      await TiledeskChatbot.allParametersStatic(
+        this.tdcache, this.requestId
+      );
+
+    const filler = new Filler();
+    const filled_content = filler.fill(content, requestVariables);
+    const filled_name = filler.fill(name, requestVariables);
+
+    const kb_endpoint = process.env.API_ENDPOINT;
+    winston.verbose("[DirAddKbContent] KbEndpoint URL: " + kb_endpoint);
+
+    let key = await integrationService.getKeyFromIntegrations(this.projectId, 'openai', this.token);
+    if (!key) {
+      this.logger.debug("[DirAddKbContent] OpenAI key not found in Integration. Using shared OpenAI key");
+      winston.verbose("[DirAddKbContent] - Key not found in Integrations. Searching in kb settings...");
+      key = await this.getKeyFromKbSettings();
+    }
+
+    if (!key) {
+      winston.verbose("[DirAddKbContent] - Retrieve public gptkey")
+      key = process.env.GPTKEY;
+      publicKey = true;
+    } else {
+      this.logger.debug("[DirAddKbContent] use your own OpenAI key")
+    }
+
+    if (!key) {
+      winston.info("[DirAddKbContent] Error: gptkey is mandatory");
+      await this.chatbot.addParameter("flowError", "[DirAddKbContent] Error: gptkey is mandatory");
+      callback();
+      return;
+    }
+
+    if (publicKey === true) {
+      let keep_going = await this.checkQuoteAvailability();
+      if (keep_going === false) {
+        this.logger.warn("[DirAddKbContent] Tokens quota exceeded. Skip the action")
+        winston.verbose("[DirAddKbContent] - Quota exceeded for tokens. Skip the action")
+        await this.chatbot.addParameter("flowError", "[DirAddKbContent] Error: tokens quota exceeded");
+        callback(true);  
+        return;
+      }
+    }
+
+    let ns;
+
+    if (action.namespaceAsName) {
+      // Namespace could be an attribute
+      const filled_namespace = filler.fill(action.namespace, requestVariables)
+      this.logger.debug("[DirAddKbContent] Searching namespace by name ", filled_namespace);
+      ns = await this.getNamespace(filled_namespace, null);
+      namespace = ns?.id;
+      winston.verbose("[DirAddKbContent] - Retrieved namespace id from name " + namespace);
+    } else {
+      this.logger.debug("[DirAddKbContent] Searching namespace by id ", namespace);
+      ns = await this.getNamespace(null, namespace);
+    }
+
+    if (!ns) {
+      this.logger.error("[DirAddKbContent] Namespace not found");
+      await this.chatbot.addParameter("flowError", "[DirAddKbContent] Error: namespace not found");
+      callback();
+      return;
+    }
+
+    if (ns.engine) {
+      engine = ns.engine;
+    } else {
+      engine = await this.setDefaultEngine()
+    }
+    
+    if (!namespace) {
+      this.logger.error("[DirAddKbContent] Namespace is undefined")
+      winston.verbose("[DirAddKbContent] - Error: namespace is undefined")
+      await this.chatbot.addParameter("flowError", "[DirAddKbContent] Error: namespace is undefined");
+      callback(true);
+      return;
+    }
+
+    let json = {
+      content: filled_content,
+      namespace: namespace,
+      type: type,
+      name: filled_name,
+      source: filled_name
+    };
+    
+    winston.debug("[DirAddKbContent] json:", json);
+
+    const HTTPREQUEST = {
+      url: kb_endpoint + "/" + this.projectId + "/kb",
+      headers: {
+        'Content-Type': 'application/json',
+        'Authorization': 'JWT ' + this.context.token
+      },
+      json: json,
+      method: "POST"
+    }
+    winston.debug("[DirAddKbContent] HttpRequest: ", HTTPREQUEST);
+
+    httpUtils.request(
+      HTTPREQUEST, async (err, resbody) => {
+        
+        if (err) {
+          this.logger.error("[DirAddKbContent] error: " + JSON.stringify(err?.response));
+          winston.error("[DirAddKbContent] error: ", err?.response);
+          if (callback) {
+            callback();
+            return;
+          }
+        }
+        else if (resbody.success === true) {
+          winston.debug("[DirAddKbContent] resbody: ", resbody);
+          callback();
+          return;
+        } else {
+          callback();
+          return;
+        }
+      }
+    )
+  }
+
+  async getKeyFromKbSettings() {
+    return new Promise((resolve) => {
+
+      const KB_HTTPREQUEST = {
+        url: this.API_ENDPOINT + "/" + this.context.projectId + "/kbsettings",
+        headers: {
+          'Content-Type': 'application/json',
+          'Authorization': 'JWT ' + this.context.token
+        },
+        method: "GET"
+      }
+      winston.debug("DirAskGPTV2 KB HttpRequest", KB_HTTPREQUEST);
+
+      httpUtils.request(
+        KB_HTTPREQUEST, async (err, resbody) => {
+          if (err) {
+            winston.error("DirAskGPTV2 Get kb settings error ", err?.response?.data);
+            resolve(null);
+          } else {
+            if (!resbody.gptkey) {
+              resolve(null);
+            } else {
+              resolve(resbody.gptkey);
+            }
+          }
+        }
+      )
+    })
+  }
+
+  async checkQuoteAvailability() {
+    return new Promise((resolve) => {
+
+      const HTTPREQUEST = {
+        url: this.API_ENDPOINT + "/" + this.context.projectId + "/quotes/tokens",
+        headers: {
+          'Content-Type': 'application/json',
+          'Authorization': 'JWT ' + this.context.token
+        },
+        method: "GET"
+      }
+      winston.debug("DirAskGPTV2 check quote availability HttpRequest", HTTPREQUEST);
+
+      httpUtils.request(
+        HTTPREQUEST, async (err, resbody) => {
+          if (err) {
+            winston.error("DirAskGPTV2 Check quote availability err: ", err);
+            resolve(true)
+          } else {
+            if (resbody.isAvailable === true) {
+              resolve(true)
+            } else {
+              resolve(false)
+            }
+          }
+        }
+      )
+    })
+  }
+
+  async updateQuote(tokens_usage) {
+    return new Promise((resolve, reject) => {
+
+      const HTTPREQUEST = {
+        url: this.API_ENDPOINT + "/" + this.context.projectId + "/quotes/incr/tokens",
+        headers: {
+          'Content-Type': 'application/json',
+          'Authorization': 'JWT ' + this.context.token
+        },
+        json: tokens_usage,
+        method: "POST"
+      }
+      winston.debug("DirAskGPTV2 update quote HttpRequest ", HTTPREQUEST);
+
+      httpUtils.request(
+        HTTPREQUEST, async (err, resbody) => {
+          if (err) {
+            winston.error("DirAskGPTV2 Increment tokens quote err: ", err);
+            reject(false)
+          } else {
+            resolve(true);
+          }
+        }
+      )
+    })
+  }
+
+  async getNamespace(name, id) {
+    return new Promise((resolve) => {
+      const HTTPREQUEST = {
+        url: this.API_ENDPOINT + "/" + this.context.projectId + "/kb/namespace/all",
+        headers: {
+          'Content-Type': 'application/json',
+          'Authorization': 'JWT ' + this.context.token
+        },
+        method: "GET"
+      }
+      winston.debug("DirAskGPTV2 get all namespaces HttpRequest", HTTPREQUEST);
+      httpUtils.request(
+        HTTPREQUEST, async (err, namespaces) => {
+          if (err) {
+            winston.error("DirAskGPTV2 get all namespaces err: ", err);
+            resolve(null)
+          } else {
+            winston.debug("DirAskGPTV2 get all namespaces resbody: ", namespaces);
+            if (name) {
+              let namespace = namespaces.find(n => n.name === name);
+              resolve(namespace);
+            } else {
+              let namespace = namespaces.find(n => n.id === id);
+              resolve(namespace);
+            }
+
+          }
+        }
+      )
+    })
+  }
+
+  async setDefaultEngine() {
+    return new Promise((resolve) => {
+      let engine = {
+        name: "pinecone",
+        type: process.env.PINECONE_TYPE,
+        apikey: "",
+        vector_size: 1536,
+        index_name: process.env.PINECONE_INDEX
+      }
+      resolve(engine);
+    })
+  }
+
+}
+
+module.exports = { DirAddKbContent }