@tiledesk/tiledesk-tybot-connector 0.1.21 → 0.1.23

package/models/TiledeskChatbot.js

@@ -1,8 +1,8 @@
-let Faq = require('./faq');
-let Faq_kb = require('./faq_kb');
-const { ExtApi } = require('../ExtApi.js');
+// let Faq = require('./faq');
+// let Faq_kb = require('./faq_kb');
+// const { ExtApi } = require('../ExtApi.js');
 const { MessagePipeline } = require('../tiledeskChatbotPlugs/MessagePipeline');
-const { DirectivesChatbotPlug } = require('../tiledeskChatbotPlugs/DirectivesChatbotPlug');
+// const { DirectivesChatbotPlug } = require('../tiledeskChatbotPlugs/DirectivesChatbotPlug');
 const { WebhookChatbotPlug } = require('../tiledeskChatbotPlugs/WebhookChatbotPlug');
 const { TiledeskClient } = require('@tiledesk/tiledesk-client');
 const { IntentForm } = require('./IntentForm.js');
@@ -10,9 +10,23 @@ const { IntentForm } = require('./IntentForm.js');
 class TiledeskChatbot {
 
   constructor(config) {
+    if (!config.botsDataSource) {
+      throw new Error("config.botsDataSource is mandatory");
+    }
+    if (!config.intentsFinder) {
+      throw new Error("config.intentsFinder is mandatory");
+    }
+    if (!config.botId) {
+      throw new Error("config.botId is mandatory");
+    }
+    if (!config.bot) {
+      throw new Error("config.bot is mandatory");
+    }
+    this.botsDataSource = config.botsDataSource;
+    this.intentsFinder = config.intentsFinder;
     this.botId = config.botId;
+    this.bot = config.bot;
     this.token = config.token;
-    this.faq_kb = config.faq_kb;
     this.tdcache = config.tdcache;
     this.APIURL = config.APIURL;
     this.APIKEY = config.APIKEY;
@@ -20,161 +34,197 @@ class TiledeskChatbot {
     this.projectId = config.projectId;
     this.log = config.log;
   }
-  
+
   async replyToMessage(message, callback) {
     return new Promise( async (resolve, reject) => {
-
-      const bot = await Faq_kb.findById(this.botId).select('+secret').exec();
-      if (this.log) {console.log("bot:", bot);}
+      // get bot info
+      //let bot;
+      let lead = null;
+      if (message.request) {
+        this.request = message.request;
+        lead = message.request.lead;
+      }
       
+      // Checking locked intent
       const locked_intent = await this.currentLockedIntent(this.requestId);
       if (this.log) {console.log("got locked intent", locked_intent)}
       if (locked_intent) {
         const tdclient = new TiledeskClient({
-          projectId: message.id_project,
+          projectId: this.projectId,
           token: this.token,
           APIURL: this.APIURL,
           APIKEY: this.APIKEY,
           log: false
         });
-        const faqs = await tdclient.getIntents(this.botId, locked_intent, 0, 0, null);
-        if (this.log) {console.log("locked intent. got faqs", faqs)}
-        let reply = await this.execIntent(faqs, this.botId, message, bot);
+        // it only gets the locked_intent
+        const faq = await this.botsDataSource.getByIntentDisplayName(this.botId, locked_intent);
+        if (this.log) {console.log("locked intent. got faqs", faq)}
+        let reply;
+        if (faq) {
+          reply = await this.execIntent(faq, message, lead);//, bot);
+        }
+        else {
+          reply = {
+            "text": "An error occurred while getting locked intent:'" + locked_intent
+          }
+        }
         resolve(reply);
         return;
       }
-      // CREATE TOKEN
-      //var botWithSecret = await Faq_kb.findById(bot._id).select('+secret').exec();
-    /*
-      let signOptions = {
-        issuer:  'https://tiledesk.com',
-        subject:  'bot',
-        audience:  'https://tiledesk.com/bots/'+bot._id,   
-        jwtid: uuidv4()
-      };
-    
-      // DEPRECATED, REMOVE
-      const bot_token = jwt.sign(bot.toObject(), bot.secret, signOptions);
-      //console.log("bot_token:", bot_token);
-      */
-      // SETUP EXACT MATCH
-      let query = { "id_project": this.projectId, "id_faq_kb": this.botId, "question": message.text };
-      // BUT CHECKING ACTION BUTTON...
+
+      let explicit_intent_name = null;
+      // Explicit intent invocation
+      if (message.text.startsWith("/")) {
+        if (this.log) {console.log("Intent was explicitly invoked:", message.text);}
+        let intent_name = message.text.substring(message.text.indexOf("/") + 1);
+        if (this.log) {console.log("Invoked Intent:", intent_name);}
+        explicit_intent_name = intent_name;
+        // if (!message.attributes) {
+        //   message.attributes = {}
+        // }
+        // message.attributes.action = intent_name;
+        // if (this.log) {console.log("Message action:", message.attributes.action)}
+      }
+      
+      // Intent invocation with action
       if (message.attributes && message.attributes.action) {
-        var action = message.attributes.action;
-        var action_parameters_index = action.indexOf("?");
+        if (this.log) {console.log("Message has action:", message.attributes.action)}
+        explicit_intent_name = message.attributes.action;
+        /*let action_parameters_index = action.indexOf("?");
         if (action_parameters_index > -1) {
-            action = action.substring(0, action_parameters_index);
+            intent_name = intent_name.substring(0, action_parameters_index);
+        }*/
+        if (this.log) {console.log("Intent was explicitly invoked with an action:", explicit_intent_name);}
+      }
+
+      // Checking Action button
+      if (explicit_intent_name) {
+        if (this.log) {console.log("Executing explicit intent:", explicit_intent_name)}
+        let faq = await this.botsDataSource.getByIntentDisplayName(this.botId, explicit_intent_name);
+        let reply;
+        if (faq) {
+          if (this.log) {console.log("Got a reply from Intent name:", faq);}
+          try {
+            reply = await this.execIntent(faq, message, lead);//, bot);
+          }
+          catch(error) {
+            console.error("error");
+            reject(error);
+          }
         }
-        query = { "id_project": this.projectId, "id_faq_kb": this.botId, "intent_display_name": action };
+        else {
+          if (this.log) {console.log("No reply found by direct intent invocation:", explicit_intent_name);}
+          reply = {
+            "text": "No reply found by direct intent invocation: *" + explicit_intent_name + "*"
+          }
+        }
+        resolve(reply);
+        return;
       }
-      
+
       // SEARCH INTENTS
-      Faq.find(query).lean().exec(async (err, faqs) => {
-        if (err) {
-          return console.error("Error getting faq object.", err);
+      let faqs;
+      try {
+        faqs = await this.botsDataSource.getByExactMatch(this.botId, message.text);
+      }
+      catch (error) {
+        console.error("An error occurred during exact match:", error);
+      }
+      if (faqs && faqs.length > 0 && faqs[0].answer) {
+        if (this.log) {console.log("EXACT MATCH OR ACTION FAQ:", faqs[0]);}
+        let reply;
+        try {
+          reply = await this.execIntent(faqs[0], message, lead);//, bot);
         }
-        if (faqs && faqs.length > 0 && faqs[0].answer) {
-          if (this.log) {console.log("EXACT MATCH OR ACTION FAQ:", faqs[0]);}
-          let reply = await this.execIntent(faqs, this.botId, message, bot);
-          resolve(reply);
-          //resolve(this.execIntent(faqs, this.botId, message, bot)); // bot_token
+        catch(error) {
+          console.error("error during exact match execIntent():", error);
+          reject(error);
+          return;
         }
-        else { // FULL TEXT
-          if (this.log) {console.log("NLP decode intent...");}
-          query = { "id_project": this.projectId, "id_faq_kb": this.botId };
-          var mongoproject = undefined;
-          var sort = undefined;
-          var search_obj = { "$search": message.text };
-    
-          if (this.faq_kb.language) {
-              search_obj["$language"] = this.faq_kb.language;
-          }
-          query.$text = search_obj;
-          //console.debug("fulltext search query", query);
-    
-          mongoproject = { score: { $meta: "textScore" } };
-          sort = { score: { $meta: "textScore" } } 
-          // DA QUI RECUPERO LA RISPOSTA DATO (ID: SE EXT_AI) (QUERY FULLTEXT SE NATIVE-BASIC-AI)
-          Faq.find(query, mongoproject).sort(sort).lean().exec(async (err, faqs) => {
-            if (this.log) {console.log("Found:", faqs);}
-            if (err) {
-              console.error("Error:", err);
-            }
-            if (faqs && faqs.length > 0 && faqs[0].answer) {
-              let reply = await this.execIntent(faqs, this.botId, message, bot);
-              resolve(reply);
-            }
-            else {
-              // fallback
-              const fallbackIntent = await this.getIntentByDisplayName("defaultFallback", bot);
-              const faqs = [fallbackIntent];
-              let reply = await this.execIntent(faqs, this.botId, message, bot);
-              resolve(reply); // bot_token
-            }
-          });
+        resolve(reply);
+        return;
+      }
+      else { // NLP
+        if (this.log) {console.log("NLP decode intent...");}
+        let intents;
+        try {
+          intents = await this.intentsFinder.decode(this.botId, message.text);
         }
-      });
-    });
-  }
-
-  getIntentByDisplayName(name, bot) {
-    return new Promise((resolve, reject) => {
-      var query = { "id_project": bot.id_project, "id_faq_kb": bot._id, "intent_display_name": name};
-      if (this.log) {console.debug('query', query);}
-      Faq.find(query).lean().exec( (err, faqs) => {
-        if (err) {
-          return reject(err);
+        catch(error) {
+          console.error("An error occurred:", error);
         }
-        if (this.log) {console.debug("faqs", faqs);}
-        if (faqs && faqs.length > 0) {
-          const intent = faqs[0];
-          return resolve(intent);
+        if (this.log) {console.log("NLP decoded found:", intents);}
+        if (intents && intents.length > 0) {
+          let faq = await this.botsDataSource.getByIntentDisplayName(this.botId, intents[0].intent_display_name);
+          let reply;
+          try {
+            reply = await this.execIntent(faq, message, lead);//, bot);
+          }
+          catch(error) {
+            console.error("error during NLP decoding:", error);
+            reject(error);
+            return;
+          }
+          resolve(reply);
+          return;
         }
         else {
-          return resolve(null);
+          // fallback
+          let fallbackIntent = await this.botsDataSource.getByIntentDisplayName(this.botId, "defaultFallback");
+          if (!fallbackIntent) {
+            resolve(null);
+            return;
+          }
+          else {
+            let reply;
+            try {
+              reply = await this.execIntent(fallbackIntent, message, lead);//, bot);
+            }
+            catch(error) {
+              console.error("error during defaultFallback:", error);
+              reject(error);
+              return;
+            }
+            resolve(reply);
+            return;
+          }
         }
-      });
+      }
     });
   }
-
-  async execIntent(faqs, botId, message, bot) {
-    answerObj = faqs[0];
-    let sender = 'bot_' + botId;
-    var answerObj;
-    answerObj.score = 100; //exact search not set score
   
-    const requestId = message.request.request_id;
-    const projectId = message.id_project;
+  async execIntent(faq, message, lead) {//, bot) {
+    let answerObj = faq; // faqs[0];
+    const botId = this.botId;
+    let sender = 'bot_' + botId;
+    //var answerObj;
+    //answerObj.score = 100; // exact search has max score
     if (this.log) {
-      console.log("requestId:", requestId)
+      console.log("requestId:", this.requestId)
       console.log("token:", this.token)
-      console.log("projectId:", projectId)
+      console.log("projectId:", this.projectId)
     }
-    
     if (this.tdcache) {
-      const requestKey = "tilebot:" + requestId
+      const requestKey = "tilebot:" + this.requestId
       // best effort, do not "await", go on, trust redis speed.
-      this.tdcache.setJSON(requestKey, message.request);
+      this.tdcache.setJSON(requestKey, this.request);
     }
     // /ext/:projectId/requests/:requestId/messages ENDPOINT COINCIDES
     // with API_ENDPOINT (APIRURL) ONLY WHEN THE TYBOT ROUTE IS HOSTED
     // ON THE MAIN SERVER. OTHERWISE WE USE TYBOT_ROUTE TO SPECIFY
     // THE ALTERNATIVE ROUTE.
-    let extEndpoint = `${this.APIURL}/modules/tilebot/`;
-    if (process.env.TYBOT_ENDPOINT) {
-      extEndpoint = `${process.env.TYBOT_ENDPOINT}`;
-    }
-    const apiext = new ExtApi({
-      ENDPOINT: extEndpoint,
-      log: this.log
-    });
-    //console.log("the form...")
-    
-    // THE FORM
+    // let extEndpoint = `${this.APIURL}/modules/tilebot/`;
+    // if (process.env.TYBOT_ENDPOINT) {
+    //   extEndpoint = `${process.env.TYBOT_ENDPOINT}`;
+    // }
+    // const apiext = new ExtApi({
+    //   ENDPOINT: extEndpoint,
+    //   log: this.log
+    // });
+    // console.log("the form...")
     
     let intent_name = answerObj.intent_display_name
-  // THE FORM
+    // THE FORM
     if (intent_name === "test_form_intent") {
       answerObj.form = {
         "cancelCommands": ['annulla', 'cancella', 'reset', 'cancel'],
@@ -200,15 +250,16 @@ class TiledeskChatbot {
       };
     }
     let intent_form = answerObj.form;
-    if (intent_form) {
-      await this.lockIntent(requestId, intent_name);
+    if (this.log) {
+      console.log("IntentForm.isValidForm(intent_form)", IntentForm.isValidForm(intent_form));
+    }
+    if (IntentForm.isValidForm(intent_form)) {
+      await this.lockIntent(this.requestId, intent_name);
       const user_reply = message.text;
-      //const intent_answer = answerObj.answer; //req.body.payload.text;
       let form_reply = await this.execIntentForm(user_reply, intent_form);
-      //console.log("got form reply", form_reply)
-      //if (form_reply_message) {
+      console.log("got form reply", form_reply)
       if (!form_reply.canceled && form_reply.message) {
-        //console.log("Form replying for next field...");
+        console.log("Form replying for next field...");
         if (this.log) {console.log("Sending form reply...", form_reply.message)}
         // reply with this message (ex. please enter your fullname)
         if (!form_reply.message.attributes) {
@@ -218,24 +269,21 @@ class TiledeskChatbot {
         form_reply.message.attributes.splits = true;
         form_reply.message.attributes.markbot = true;
         return form_reply.message;
-        //apiext.sendSupportMessageExt(form_reply.message, projectId, requestId, token, () => {
-        //  if (log) {console.log("FORM Message sent.", );}
-        //});
-        //return;
       }
       else if (form_reply.end) {
-        //console.log("Form end.");
         if (this.log) {
-          console.log("Form end.");
-          console.log("Unlocking intent for request", requestId);
+          console.log("FORM end.", );
+          console.log("unlocking intent for request:", this.requestId);
+        }
+        this.unlockIntent(this.requestId);
+        if (lead) {
+          this.populatePrechatFormAndLead(this.requestId, lead._id);
         }
-        this.unlockIntent(requestId);
-        this.populatePrechatFormAndLead(message);
       }
       else if (form_reply.canceled) {
         console.log("Form canceled.");
-        if (this.log) {console.log("unlocking intent due to canceling, for request", requestId);}
-        this.unlockIntent(requestId);
+        if (this.log) {console.log("unlocking intent due to canceling, for request", this.requestId);}
+        this.unlockIntent(this.requestId);
         if (this.log) {console.log("sending form 'cancel' reply...", form_reply.message)}
         // reply with this message (ex. please enter your fullname)
         if (!form_reply.message.attributes) {
@@ -244,27 +292,20 @@ class TiledeskChatbot {
         form_reply.message.attributes.fillParams = true;
         form_reply.message.attributes.splits = true;
         return form_reply.message
-        //apiext.sendSupportMessageExt(form_reply.message, projectId, requestId, token, () => {
-        //  if (log) {console.log("FORM Message sent.", );}
-        //});
-        //return;
       }
-      //console.log("form_reply is", form_reply)
     }
-  
     // FORM END
     
     const context = {
       payload: {
         botId: botId,
-        bot: bot,
+        bot: this.bot,
         message: message, // USER MESSAGE (JSON)
         intent: answerObj
       },
       token: this.token
     };
-
-    //console.log("the static_bot_answer...")
+    
     const static_bot_answer = { // static design of the chatbot reply
       //type: answerObj.type,
       text: answerObj.answer,
@@ -276,10 +317,6 @@ class TiledeskChatbot {
     if (!static_bot_answer.attributes) {
       static_bot_answer.attributes = {}
     }
-    /*let attr = static_bot_answer.attributes;
-    if (!attr) {
-      attr = {};
-    }*/
     var timestamp = Date.now();
     static_bot_answer.attributes['clienttimestamp'] = timestamp;
     if (answerObj && answerObj._id) {
@@ -289,19 +326,15 @@ class TiledeskChatbot {
     // question_payload = clone of user's original message
     let question_payload = Object.assign({}, message);
     delete question_payload.request;
-    let clonedfaqs = faqs.slice();
-    if (clonedfaqs && clonedfaqs.length > 0) {
-        clonedfaqs = clonedfaqs.shift()
-    }
     const intent_info = {
-        intent_name: answerObj.intent_display_name,
-        is_fallback: false,
-        confidence: answerObj.score,
-        question_payload: question_payload,
-        others: clonedfaqs
+      intent_name: answerObj.intent_display_name,
+      is_fallback: false,
+      confidence: answerObj.score,
+      question_payload: question_payload,
+      botId: this.botId,
+      bot: this.bot
     }
     static_bot_answer.attributes.intent_info = intent_info;
-    
     static_bot_answer.attributes.directives = true;
     static_bot_answer.attributes.splits = true;
     static_bot_answer.attributes.markbot = true;
@@ -309,15 +342,8 @@ class TiledeskChatbot {
     static_bot_answer.attributes.webhook = answerObj.webhook_enabled;
 
     // exec webhook (only)
-    const bot_answer = await this.execPipeline(static_bot_answer, message, bot, context, this.token);
-    
-    //bot_answer.text = await fillWithRequestParams(bot_answer.text, requestId); // move to "ext" pipeline
+    const bot_answer = await this.execPipeline(static_bot_answer, message, this.bot, context, this.token);
     return bot_answer;
-    
-    /*apiext.sendSupportMessageExt(bot_answer, projectId, requestId, token, () => {
-      if (log) {console.log("Message sent");}
-    });*/
-    
   }
 
   async lockIntent(requestId, intent_name) {
@@ -325,7 +351,12 @@ class TiledeskChatbot {
   }
   
   async currentLockedIntent(requestId) {
-    return await this.tdcache.get("tilebot:requests:"  + requestId + ":locked");
+    if (this.tdcache) {
+      return await this.tdcache.get("tilebot:requests:"  + requestId + ":locked");
+    }
+    else {
+      return null;
+    }
   }
   
   async unlockIntent(requestId) {
@@ -371,32 +402,27 @@ class TiledeskChatbot {
     return message;
   }
 
-  async populatePrechatFormAndLead(message, callback) {
+  async populatePrechatFormAndLead(leadId, requestId) {
+    if (!leadId && !requestId) {
+      if (this.log) {console.log("(populatePrechatFormAndLead) !leadId && !requestId");}
+      return;
+    }
     const tdclient = new TiledeskClient({
       projectId: this.projectId,
       token: this.token,
       APIURL: this.APIURL,
       APIKEY: this.APIKEY
     });
-    
-    const leadId = message.request.lead._id;
-    const requestId = message.request.request_id;
-  
     const parameters_key = "tilebot:requests:" + requestId + ":parameters";
     const all_parameters = await this.tdcache.hgetall(parameters_key);
-    if (all_parameters) {
-      //console.log("all_parameters['userEmail']", all_parameters['userEmail'])
-      //console.log("all_parameters['userFullname']", all_parameters['userFullname']); 
+    if (all_parameters) { 
       tdclient.updateLeadEmailFullname(leadId, null, all_parameters['userFullname'], () => {
-        if (this.log) {console.log("lead updated.")}
+        if (this.log) {console.log("Lead updated.")}
         tdclient.updateRequestAttributes(requestId, {
           preChatForm: all_parameters,
           updated: Date.now
         }, () => {
-          if (this.log) {console.log("prechat updated.");}
-          if (callback) {
-            callback();
-          }
+          if (this.log) {console.log("Prechat updated.");}
         });
       });
     };

package/models/TiledeskIntentsMachine.js

@@ -0,0 +1,90 @@
+
+let axios = require('axios');
+
+class TiledeskIntentsMachine {
+
+  constructor(config) {
+    if (!config.API_ENDPOINT) {
+      throw new Error("config.API_ENDPOINT is mandatory");
+    }
+    this.API_ENDPOINT = config.API_ENDPOINT;
+    this.log = config.log;
+  }
+
+  /**
+   * intentsFinder Adapter
+   * @param {String} text 
+   * @returns the matching intents' names array
+   */
+  async decode(botId, text) {
+    return new Promise( (resolve, reject) => {
+      if (this.log) {console.log("NLP AI...");}
+      const url = `${this.API_ENDPOINT}/model/parse`;
+      if (this.log) {console.log("AI URL", url);}
+      const HTTPREQUEST = {
+        url: url,
+        headers: {
+          'Content-Type' : 'application/json'
+        },
+        json: {
+          "text": text,
+          "botId": botId
+        },
+        method: 'POST'
+      };
+      this.myrequest(
+        HTTPREQUEST,
+        function(err, resbody) {
+          if (err) {
+            console.error("error:", err)
+            reject(err);
+          }
+          else {
+            resolve(resbody);
+          }
+        }, false
+      );
+    })
+  }
+
+  myrequest(options, callback, log) {
+    if (this.log) {
+      console.log("API URL:", options.url);
+      console.log("** Options:", options);
+    }
+    axios(
+      {
+        url: options.url,
+        method: options.method,
+        data: options.json,
+        params: options.params,
+        headers: options.headers
+      })
+    .then((res) => {
+      if (this.log) {
+        console.log("Response for url:", options.url);
+        console.log("Response headers:\n", res.headers);
+        //console.log("******** Response for url:", 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( (error) => {
+      console.error("An error occurred:", error);
+      if (callback) {
+        callback(error, null, null);
+      }
+    });
+  }
+  
+}
+
+module.exports = { TiledeskIntentsMachine }

package/models/faqKbService.js

@@ -0,0 +1,27 @@
+var Faq_kb = require("./faq_kb");
+
+class FaqKbService {
+
+  async getAll(options) {
+    if (!options) {
+      options = {
+        public: true,
+        certified: true
+      }
+    }
+    console.log("(Service) GET ALL FAQ_KBs");
+    return new Promise((resolve, reject) => {
+      let query = {public: options.public, certified: options.certified};
+      Faq_kb.find(query).lean().exec( (err, bots) => {
+        if (err) {
+          reject(err);
+        }
+        resolve(bots);
+      });
+    });
+  }
+
+}
+
+var faqKbService = new FaqKbService();
+module.exports = faqKbService;

package/models/faqService.js

@@ -0,0 +1,22 @@
+var Faq = require("./faq");
+var Faq_kb = require("./faq_kb");
+
+class FaqService {
+
+  async getAll(faq_kb_id) {
+    console.log("(Service) GET ALL FAQ OF THE BOT ID (req.query): ", faq_kb_id);
+    return new Promise((resolve, reject) => {
+      let query = { id_faq_kb: faq_kb_id};
+      Faq.find(query).lean().exec( (err, faqs) => {
+        if (err) {
+          reject(err);
+        }
+        resolve(faqs);
+      });
+    })
+  }
+
+}
+
+var faqService = new FaqService();
+module.exports = faqService;