@tiledesk/tiledesk-tybot-connector 0.1.23 → 0.1.26

package/CHANGELOG.md

@@ -5,6 +5,15 @@
 available on:
  ▶️ https://www.npmjs.com/package/@tiledesk/tiledesk-tybot-connector
 
+### 0.1.26 - online
+- no message is sent when there is no message for markbot out of the pipeline. Only directives are admitted.
+
+### 0.1.25
+- introduced new \_tdIfNoAgents \_tdIfAgents (DirIfAvailableAgents)
+
+### 0.1.24
+- @tiledesk/tiledesk-client => 0.8.39
+
 ### 0.1.23
 - introduced new DirClose \_tdClose
 - introduced new DirWhenOpen \_tdWhenOpen \_tdWhenClosed

package/ExtApi.js

@@ -74,35 +74,35 @@ class ExtApi {
    * @param {string} botId. Tiledesk botId
    * @param {string} token. User token
    */
-  sendMessageToBot(message, botId, token, callback) {
-    const jwt_token = this.fixToken(token);
-    const url = `${this.ENDPOINT}/ext/${botId}`;
-    if (this.log) {console.log("sendMessageToBot URL", url);}
-    const HTTPREQUEST = {
-      url: url,
-      headers: {
-        'Content-Type' : 'application/json',
-        'Authorization': jwt_token
-      },
-      json: message,
-      method: 'POST'
-    };
-    this.myrequest(
-      HTTPREQUEST,
-      function(err, resbody) {
-        if (err) {
-          if (callback) {
-            callback(err);
-          }
-        }
-        else {
-          if (callback) {
-            callback(null, resbody);
-          }
-        }
-      }, this.log
-    );
-  }
+  // sendMessageToBot(message, botId, token, callback) {
+  //   const jwt_token = this.fixToken(token);
+  //   const url = `${this.ENDPOINT}/ext/${botId}`;
+  //   if (this.log) {console.log("sendMessageToBot URL", url);}
+  //   const HTTPREQUEST = {
+  //     url: url,
+  //     headers: {
+  //       'Content-Type' : 'application/json',
+  //       'Authorization': jwt_token
+  //     },
+  //     json: message,
+  //     method: 'POST'
+  //   };
+  //   this.myrequest(
+  //     HTTPREQUEST,
+  //     function(err, resbody) {
+  //       if (err) {
+  //         if (callback) {
+  //           callback(err);
+  //         }
+  //       }
+  //       else {
+  //         if (callback) {
+  //           callback(null, resbody);
+  //         }
+  //       }
+  //     }, this.log
+  //   );
+  // }
 
   myrequest(options, callback, log) {
     if (this.log) {

package/index.js

@@ -46,7 +46,7 @@ let connection;
 let APIURL = null;
 
 router.post('/ext/:botid', async (req, res) => {
-  console.log("REQUEST BODY:", JSON.stringify(req.body));
+  if (log) {console.log("REQUEST BODY:", JSON.stringify(req.body));}
   res.status(200).send({"success":true});
 
   const botId = req.params.botid;
@@ -107,13 +107,11 @@ router.post('/ext/:botid', async (req, res) => {
     tdcache: tdcache,
     requestId: requestId,
     projectId: projectId,
-    log: true
+    log: log
   });
 
   const parameters_key = "tilebot:requests:" + requestId + ":parameters";
   await chatbot.addParameter(requestId, "tdMessageId", messageId);
-  //all_params = await chatbot.allParameters(requestId);
-  //console.log("Allparams", all_params);
   let reply = await chatbot.replyToMessage(message);
   if (!reply) {
     reply = {
@@ -172,11 +170,44 @@ router.post('/ext/:projectId/requests/:requestId/messages', async (req, res) =>
   // PIPELINE-EXT
   const bot_answer = await ExtUtil.execPipelineExt(request, answer, directivesPlug, tdcache, log);
   //const bot_answer = answer;
-  tdclient.sendSupportMessage(requestId, bot_answer, () => {
-    directivesPlug.processDirectives(bot_answer, () => {
-      if (log) {console.log("After message execute directives end.");}
+  console.log("bot_answer to send:", bot_answer);
+  // empty answer
+  // let b = {
+  //      text: '',
+  //      attributes: {
+  //        clienttimestamp: 1670571497092,
+  //        _answerid: '638c7b0c1db44900351104b1',
+  //        intent_info: {
+  //          intent_name: 'wantagent',
+  //          is_fallback: false,
+  //          question_payload: [Object],
+  //          botId: '638c78d71db44900351101c2',
+  //          bot: [Object]
+  //        },
+  //        directives: true,
+  //        splits: true,
+  //        markbot: true,
+  //        fillParams: true,
+  //        webhook: false
+  //      },
+  //      triggeredByMessageId: '6392e5e8408e0000437aa383'
+  //    }
+  if (bot_answer) {
+    tdclient.sendSupportMessage(requestId, bot_answer, (err, response) => {
+      if (err) {
+        console.error("Error sending message", err);
+      }
+      directivesPlug.processDirectives( () => {
+        if (log) {console.log("After message - Directives executed.");}
+      });
     });
-  });
+  }
+  else {
+    directivesPlug.processDirectives( () => {
+      if (log) {console.log("Directives executed.");}
+    });
+  }
+  
 });
 
 router.get('/message/context/:messageid', async (req, res) => {

package/models/TiledeskChatbot.js

@@ -229,6 +229,7 @@ class TiledeskChatbot {
       answerObj.form = {
         "cancelCommands": ['annulla', 'cancella', 'reset', 'cancel'],
         "cancelReply": "Ok annullato!",
+        "cancelReplyIntent": "formCanceled", // TODO IDEA
         "fields": [
           {
             "name": "userFullname",

package/models/faq_kb.js

@@ -54,6 +54,10 @@ var Faq_kbSchema = new Schema({
     type: Boolean,
     index: true
   },
+  mainCategory: {
+    type: String,
+    required: false
+  },
   attributes: {
     type: Object,
   },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tiledesk/tiledesk-tybot-connector",
-  "version": "0.1.23",
+  "version": "0.1.26",
   "description": "Tiledesk Tybot connector",
   "main": "index.js",
   "scripts": {
@@ -14,7 +14,7 @@
     "@tiledesk/helpcenter-query-client": "^0.1.8",
     "@tiledesk/tiledesk-chatbot-client": "^0.5.30",
     "@tiledesk/tiledesk-chatbot-util": "^0.8.38",
-    "@tiledesk/tiledesk-client": "^0.8.38",
+    "@tiledesk/tiledesk-client": "^0.8.39",
     "axios": "^0.27.2",
     "body-parser": "^1.19.0",
     "cors": "^2.8.5",

package/test/close_directive_test.js

@@ -34,10 +34,7 @@ describe('Directive DirClose', function() {
     }
     let directivesPlug = new DirectivesChatbotPlug({supportRequest: supportRequest, TILEDESK_API_ENDPOINT: "APIURL", token: "token", log: false, HELP_CENTER_API_ENDPOINT: "HELP_CENTER_API_ENDPOINT"});
     const bot_answer = await ExtUtil.execPipelineExt(supportRequest, answer, directivesPlug, null, false);
-    // console.log("bot_answer:", bot_answer);
-    // console.log("directivesPlug.directives:", directivesPlug.directives);
-    assert.strictEqual(bot_answer.text, "");
-    assert(bot_answer.attributes.commands == null);
+    assert(bot_answer == null);
     assert(directivesPlug.directives != null);
     assert(directivesPlug.directives.length == 1);
     assert(directivesPlug.directives[0].name === "close");

package/tiledeskChatbotPlugs/DirectivesChatbotPlug.js

@@ -13,6 +13,7 @@ const { DirIntent } = require('./directives/DirIntent');
 const { DirWhenOpen } = require('./directives/DirWhenOpen');
 const { DirDisableInputText } = require('./directives/DirDisableInputText');
 const { DirClose } = require('./directives/DirClose');
+const { DirIfAvailableAgents } = require('./directives/DirIfAvailableAgents');
 const { Directives } = require('./directives/Directives');
 // const { ExtApi } = require('../ExtApi.js');
 
@@ -68,8 +69,8 @@ class DirectivesChatbotPlug {
 
   }
 
-  processDirectives(message, theend) {
-    if (this.log) { console.log("Directives on message:", message); }
+  processDirectives(theend) {
+    // if (this.log) { console.log("Directives on message:", JSON.stringify(message)); }
     const directives = this.directives;
     if (!directives || directives.length === 0) {
       if (this.log) { console.log("No directives to process."); }
@@ -143,7 +144,7 @@ class DirectivesChatbotPlug {
             log: false
           }
         );
-        intentDir.execute(directive, message, projectId, requestId, token, () => {
+        intentDir.execute(directive, projectId, requestId, token, () => {
           process(nextDirective());
         });
       }
@@ -152,7 +153,7 @@ class DirectivesChatbotPlug {
           {
             API_ENDPOINT: API_URL,
             TILEBOT_ENDPOINT:TILEBOT_ENDPOINT,
-            log: true
+            log: false
           }
         );
         messageDir.execute(directive, projectId, requestId, token, () => {
@@ -162,7 +163,8 @@ class DirectivesChatbotPlug {
       else if (directive_name === Directives.WHEN_OPEN) {
         const whenOpenDir = new DirWhenOpen(
           {
-            tdclient: tdclient // matches open hours
+            tdclient: tdclient, // matches open hours
+            log: true
           });
         whenOpenDir.execute(directive, directives, curr_directive_index, () => {
           process(nextDirective());
@@ -172,12 +174,35 @@ class DirectivesChatbotPlug {
         const whenOpenDir = new DirWhenOpen(
           {
             tdclient: tdclient,
-            checkOpen: false // matches closed hours
+            checkOpen: false, // matches closed hours
+            log: true
           });
         whenOpenDir.execute(directive, directives, curr_directive_index, () => {
           process(nextDirective());
         });
       }
+      else if (directive_name === Directives.IF_AGENTS) {
+        const ifNoAgentsDir = new DirIfAvailableAgents(
+          {
+            tdclient: tdclient,
+            checkAgents: true, // check available agents > 0
+            log: false
+          });
+        ifNoAgentsDir.execute(directive, directives, curr_directive_index, () => {
+          process(nextDirective());
+        });
+      }
+      else if (directive_name === Directives.IF_NO_AGENTS) {
+        const ifNoAgentsDir = new DirIfAvailableAgents(
+          {
+            tdclient: tdclient,
+            checkAgents: false, // check no available agents
+            log: false
+          });
+        ifNoAgentsDir.execute(directive, directives, curr_directive_index, () => {
+          process(nextDirective());
+        });
+      }
       else if (directive_name === Directives.AGENT) {
         const agentDir = new DirMoveToAgent(tdclient);
         directive.whenOnlineOnly = false;

package/tiledeskChatbotPlugs/FillParamsChatbotPlug.js

@@ -16,64 +16,56 @@ class FillParamsChatbotPlug {
   }
 
   async exec(pipeline) {
-    if (this.log) {console.log("fillParams...")}
     let message = pipeline.message;
-    if (this.log) {console.log("fill params message", message)}
-    if (message.attributes && (message.attributes.fillParams == undefined || message.attributes.fillParams == false)) { // defaults to disabled
-      if (this.log) {console.log("fillParams disabled.");}
-      pipeline.nextplug();
-      return;
-    }
-    if (this.log) {
-      console.log("fillParams: true");
-    }
-    const requestId = this.request.request_id;
-    //const parameters_key = "tilebot:requests:" + requestId + ":parameters";
-    //this.tdcache.hgetall(parameters_key, (err, all_parameters) => {
-    if (this.log) {console.log("all_parameters of requestId:", requestId)}
-    const all_parameters = await TiledeskChatbot.allParametersStatic(this.tdcache, requestId);
-    if (this.log) {console.log("--got parameters", all_parameters);}
-    if (!all_parameters) {
-      pipeline.nextplug();
-      return;
-    }
-    //all_parameters["tdMessageId"] = message.triggeredByMessageId;
-    //console.log("FillParamsChatbotPlug message:", message);
-    //console.log("all_parameters[tdMessageId]:", all_parameters["tdMessageId"]);
-    //if (err) {
-    //  console.error("An error occurred while filling paprameters:", err);
-    //}
-    const filled_message_text = this.fillWithRequestParams(message.text, all_parameters);
-    message.text = filled_message_text;
-    //console.log("message filled_message_text:", message)
-    if (!message.attributes) {
-      message.attributes = {}
-    }
-    // Reserved names: userEmail, userFullname (and firstMessage)
-    if (all_parameters['userEmail']) {
-       message.attributes.updateUserEmail = all_parameters['userEmail'];
-    }
-    if (all_parameters['userFullname']) {
-      message.attributes.updateUserFullname = all_parameters['userFullname'];
-    }
-
-    if (message.attributes && message.attributes.commands) {
-      let commands = message.attributes.commands;
-      if (this.log) {console.log("commands for fillMessage:", commands);}
-      if (commands.length > 1) {
-        for (let i = 0; i < commands.length; i++) {
-          if (commands[i].type === 'message' && commands[i].message && commands[i].message.text) {
-            let filled_reply = this.fillWithRequestParams(commands[i].message.text, all_parameters);
-            commands[i].message.text = filled_reply;
+    if (message) {
+      if (message.attributes && (message.attributes.fillParams == undefined || message.attributes.fillParams == false)) { // defaults to disabled
+        if (this.log) {console.log("fillParams disabled.");}
+        pipeline.nextplug();
+        return;
+      }
+      if (this.log) {
+        console.log("fillParams: true");
+      }
+      const requestId = this.request.request_id;
+      if (this.log) {console.log("all_parameters of requestId:", requestId)}
+      const all_parameters = await TiledeskChatbot.allParametersStatic(this.tdcache, requestId);
+      if (this.log) {console.log("--got parameters", all_parameters);}
+      if (!all_parameters) {
+        pipeline.nextplug();
+        return;
+      }
+      const filled_message_text = this.fillWithRequestParams(message.text, all_parameters);
+      message.text = filled_message_text;
+      //console.log("message filled_message_text:", message)
+      if (!message.attributes) {
+        message.attributes = {}
+      }
+      // Reserved names: userEmail, userFullname (and firstMessage)
+      if (all_parameters['userEmail']) {
+         message.attributes.updateUserEmail = all_parameters['userEmail'];
+      }
+      if (all_parameters['userFullname']) {
+        message.attributes.updateUserFullname = all_parameters['userFullname'];
+      }
+  
+      if (message.attributes && message.attributes.commands) {
+        let commands = message.attributes.commands;
+        // if (this.log) {console.log("commands for fillMessage:", JSON.stringify(commands));}
+        if (commands.length > 1) {
+          for (let i = 0; i < commands.length; i++) {
+            if (commands[i].type === 'message' && commands[i].message && commands[i].message.text) {
+              let filled_reply = this.fillWithRequestParams(commands[i].message.text, all_parameters);
+              commands[i].message.text = filled_reply;
+            }
           }
         }
       }
+      pipeline.nextplug();
     }
-    if (this.log) {
-      console.log("Message out of fillAttributes plugin:", JSON.stringify(message));
+    else {
+      if (this.log) {console.log("Fillparams. No message.");}
+      pipeline.nextplug();
     }
-    pipeline.nextplug();
-    //});
     
   }
 

package/tiledeskChatbotPlugs/MarkbotChatbotPlug.js

@@ -15,20 +15,35 @@ class MarkbotChatbotPlug {
 
   exec(pipeline) {
     let message = pipeline.message;
-    //console.log("markbot, message.attributes", message.attributes)
+    console.log("markbot on message", message)
     if (message.attributes && (message.attributes.markbot == undefined || message.attributes.markbot == false)) { // defaults to disabled
       if (this.log) {console.log("markbot disabled")}
       pipeline.nextplug();
       return;
     }
-    
+
+    let incoming_message_text = message.text.trim();
+
+    let commands = null;
+    if (message.attributes && message.attributes.commands) {
+      commands = message.attributes.commands;
+    }
+    console.log("before taking decision:");
+    console.log("message.text:", incoming_message_text);
+    console.log("message commands:", commands)
+    if (incoming_message_text === "" && !commands) {
+      console.log("message with no content. Ignoring");
+      pipeline.message = null;
+      pipeline.nextplug();
+      return;
+    }
+
     if (!message.attributes) {
       message.attributes = {}
     }
-    
-    if (message.text) {
+    if (incoming_message_text !== "") {
       if (this.log) {console.log("markbotting main message...");}
-      let parsed_reply = TiledeskChatbotUtil.parseReply(message.text);
+      let parsed_reply = TiledeskChatbotUtil.parseReply(incoming_message_text);
       if (this.log) {console.log("parsed", JSON.stringify(parsed_reply));}
       if (parsed_reply) {
         message.text = parsed_reply.message.text;
@@ -49,9 +64,14 @@ class MarkbotChatbotPlug {
         }
       }
     }
+    else {
+      console.log("no message text:", message.text);
+    }
     
-    if (message.attributes && message.attributes.commands) {
-      let commands = message.attributes.commands;
+    // let commands = null;
+    // if (message.attributes && message.attributes.commands) {
+    //   commands = message.attributes.commands;
+    if (commands) {
       if (this.log) {console.log("commands for markbot:", commands);}
       if (commands.length > 1) {
         for (let i = 0; i < commands.length; i++) {
@@ -63,6 +83,9 @@ class MarkbotChatbotPlug {
         }
       }
     }
+    else if (message.attributes && !message.attributes.commands) {
+      console.log("no message commands.");
+    }
     if (this.log) {console.log("Message out of Markbot:", JSON.stringify(message));}
     pipeline.nextplug();
     

package/tiledeskChatbotPlugs/directives/DirIfAvailableAgents.js

@@ -0,0 +1,108 @@
+const { param } = require("express/lib/request");
+
+class DirIfAvailableAgents {
+
+  constructor(config) {
+    if (!config.tdclient) {
+      throw new Error('config.tdclient (TiledeskClient) object is mandatory.');
+    }
+    this.tdclient = config.tdclient;
+    if (config.checkAgents == null || config.checkAgents === true) {
+      // null => defaults to checkNoAgents
+      this.checkAgents = true;
+    }
+    else {
+      this.checkAgents = false;
+    }
+    this.log = config.log;
+  }
+
+  execute(directive, directives, current_directive_index, callback) {
+    this.tdclient.openNow((err, result) => {
+      if (this.log) {console.log("openNow():", result);}
+      if (err) {
+        console.error("Agent in DirWhenOpen Error:", err);
+        callback();
+        return;
+      }
+      else {
+        if (directive.parameter) {
+          if (result && result.isopen) {
+            this.tdclient.getProjectAvailableAgents((err, agents) => {
+              if (this.log) {console.log("Agents on 'open'", agents);}
+              if (this.log) {console.log("Checking agents:", this.checkAgents);}
+              if (err || !agents) {
+                console.error("Error getting available agents in DirWhenAvailableAgents", err);
+                callback();
+              }
+              else {
+                if (this.log) {console.log("Agents count:", agents.length);}
+                if (agents.length === 0 && !this.checkAgents) { // check no agents
+                  let directive_to_execute = this.directiveFromParameter(directive.parameter);
+                  if (this.log) {console.log("directive_to_execute:", directive_to_execute);}
+                  if (directive_to_execute) {
+                    directives.splice(current_directive_index + 1, 0, directive_to_execute);
+                  }
+                  callback();
+                  return;
+                }
+                else if (agents.length > 0 && this.checkAgents) { // check agents
+                  let directive_to_execute = this.directiveFromParameter(directive.parameter);
+                  if (this.log) {console.log("directive_to_execute:", directive_to_execute);}
+                  if (directive_to_execute) {
+                    directives.splice(current_directive_index + 1, 0, directive_to_execute);
+                  }
+                  callback();
+                  return;
+                }
+                else {
+                  callback();
+                  return;
+                }
+              }
+            });
+          }
+          else {
+            callback();
+            return;
+          }
+        }
+        else {
+          if (this.log) {console.log("no directive to execute.");}
+          callback();
+        }
+      }
+    });
+  }
+
+  directiveFromParameter(parameter) {
+    const DIRECTIVE_PREFIX = "_td";
+    const AGENT_DIRECTIVE_CMD = "\\agent"
+    const directive_pattern = /((\\{1}_td[a-zA-Z_0-9]*)|(\\agent))[ ]*(.*)[\r\n]*/m;
+    let match = null;
+    let directive = null;
+    match = directive_pattern.exec(parameter);
+    if (match && match.length >= 1) {
+      let final_msg_text = parameter.substring(0, match.index) + parameter.substring(match.index + match[0].length);
+      if (match.length >= 2) {
+        let directive_name = match[1];
+        if (directive_name !== AGENT_DIRECTIVE_CMD) {
+          // REMOVES THE "DIRECTIVE_PREFIX" from the directive name
+          directive_name = match[1].substring(DIRECTIVE_PREFIX.length + 1)
+        }
+        else if (directive_name === AGENT_DIRECTIVE_CMD) {
+          directive_name = this.AGENT_DIRECTIVE
+        }
+        directive = {
+          name: directive_name
+        };
+        if (match[1] !== AGENT_DIRECTIVE_CMD && match.length >= 5 && match[4] && match[4].trim().length > 0) {
+          directive.parameter = match[4];
+        }
+      }
+    }
+    return directive;
+  }
+}
+
+module.exports = { DirIfAvailableAgents };

package/tiledeskChatbotPlugs/directives/DirIntent.js

@@ -8,38 +8,47 @@ class DirIntent {
     }
     this.API_ENDPOINT = settings.API_ENDPOINT;
     this.TILEBOT_ENDPOINT = settings.TILEBOT_ENDPOINT;
+    this.log = settings.log;
   }
 
-  execute(directive, message, projectId, requestId, token, callback) {
+  execute(directive, projectId, requestId, token, callback) {
     if (directive.parameter) {
       let intent_name = directive.parameter.trim();
-      let message_to_bot = {
-        sender: "system22", // bot doesn't reply to himself
-        text: "/" + intent_name,
-        request: {
-          request_id: requestId
-        },
-        id_project: projectId
+      let intent_command = "/" + intent_name;
+      let intent_command_message = {
+        sender: "_tdsender", // bot doesn't reply to "himself" and "system"
+        text: intent_command,
+        attributes: {
+          subtype: "info"
+        }
+        // request: {
+        //   request_id: requestId
+        // },
+        // id_project: projectId
       };
       // send message to /ext/botId
-      const req_body = {
-        payload: message_to_bot,
-        token: token
-      }
+      // const req_body = {
+      //   payload: message_to_bot,
+      //   token: token
+      // }
       let extEndpoint = `${this.API_ENDPOINT}/modules/tilebot`;
       if (this.TILEBOT_ENDPOINT) {
         extEndpoint = `${this.TILEBOT_ENDPOINT}`;
       }
       const extapi = new ExtApi({
         ENDPOINT: extEndpoint,
-        log: true
+        log: this.log
       });
-      console.log("(sending to bot) incoming message:", message);
-      console.log("(sending to bot) the req_body:", req_body);
-      extapi.sendMessageToBot(req_body, message.attributes.intent_info.botId, token, () => {
-        console.log("sendMessageToBot() req_body sent:", req_body);
+      if (this.log) {console.log("move to intent message:", intent_command_message);}
+      // console.log("(sending to bot) the req_body:", req_body);
+      extapi.sendSupportMessageExt(intent_command_message, projectId, requestId, token, () => {
+        if (this.log) {console.log("command " + intent_command + " sent.");}
         callback();
       });
+      // extapi.sendMessageToBot(req_body, message.attributes.intent_info.botId, token, () => {
+      //   console.log("sendMessageToBot() req_body sent:", req_body);
+      //   callback();
+      // });
     }
     else {
       callback();

package/tiledeskChatbotPlugs/directives/Directives.js

@@ -15,6 +15,8 @@ class Directives {
   static DISABLE_INPUT_TEXT = "disableinputtext";
   static WHEN_OPEN = "whenopen";
   static WHEN_CLOSED = "whenclosed";
+  static IF_NO_AGENTS = "ifnoagents";
+  static IF_AGENTS = "ifagents";
   static DEFLECT_TO_HELP_CENTER = "deflecttohelpcenter";
   static WAIT = "wait";
   static LOCK_INTENT = "lockintent";