@tiledesk/tiledesk-server 2.2.11 → 2.2.16

package/CHANGELOG.md

@@ -1,3 +1,36 @@
+
+
+
+
+# 2.2.16
+- Email templates endpoint
+- Created request.updated event for request event and deprecated request.update.comment
+- Added Handlebars template processor for the message transformer module only if message.attributes.templateProcessor=true
+- Email test send endpoint
+- Bugfix widget label
+- Added /intents alias for /faq endpoint
+- The request_id field of the request model has now a unique index
+
+# 2.2.15 -> PROD
+- Added catch messageService.send for bot
+- Added external searcher for bot( ex. Rasa proxy) 
+- Faq language fix taken from bot language for create single and import from csv
+- Lower case reset password fix
+- Added alias /bots for /faq_kb
+
+# 2.2.14
+- Fix Tiledesk Queue 1.1.11 with authEvent.queueEnabled = true 
+
+# 2.2.13
+- Send message validation with empty text
+
+# 2.2.12
+- Add /bot endpoint
+- Bot and subscription can manage bots
+
+# 2.2.11 
+- Logfix
+
 # 2.2.10
 - Native mqtt auth fix
 
@@ -7,7 +40,7 @@
 # 2.2.6
 - Quota license fix
 
-# 2.2.4
+# 2.2.4  -> PROD
 - email invitation fix
 
 # 2.2.3
@@ -114,7 +147,7 @@
 # 2.1.40.31
 - Concierge bot fix to reroute only for temp conversation without a bot. Race condition issue when you try manually route a request for example inside a chatbot webhook 
 
-# 2.1.40.30 -> PROD
+# 2.1.40.30
 - logfix
 
 # 2.1.40.29

package/README.md

@@ -15,7 +15,7 @@ You can find more info here: https://developer.tiledesk.com
 
 # Prerequisites
 
-* [Nodejs](https://www.npmjs.com/) and npm installed 
+* [Nodejs](https://www.npmjs.com/) and npm installed. Suggested versions are NodeJS 12.20.2 and NPM 6.14.11 
 * [MongoDb](https://www.mongodb.com) installed
 
 # Running Tiledesk Server

package/app.js

@@ -102,6 +102,7 @@ var campaigns = require('./routes/campaigns');
 var logs = require('./routes/logs');
 var requestUtilRoot = require('./routes/requestUtilRoot');
 var urls = require('./routes/urls');
+var email = require('./routes/email');
 
 var bootDataLoader = require('./services/bootDataLoader');
 var settingDataLoader = require('./services/settingDataLoader');
@@ -294,7 +295,6 @@ app.use('/users', [passport.authenticate(['basic', 'jwt'], { session: false }),
 app.use('/logs', logs);
 app.use('/requests_util', [passport.authenticate(['basic', 'jwt'], { session: false }), validtoken], requestUtilRoot);
 
-
 // TODO security issues
 if (process.env.DISABLE_TRANSCRIPT_VIEW_PAGE ) {
   winston.info(" Transcript view page is disabled");
@@ -333,13 +333,16 @@ app.use('/:projectid/departments', department);
 
 channelManager.useUnderProjects(app);
 
-
+//deprecated
 app.use('/:projectid/faq', [passport.authenticate(['basic', 'jwt'], { session: false }), validtoken, roleChecker.hasRole('agent')], faq);
+app.use('/:projectid/intents', [passport.authenticate(['basic', 'jwt'], { session: false }), validtoken, roleChecker.hasRole('agent')], faq);
 
 //Deprecated??
 app.use('/:projectid/faqpub', faqpub);
 
-app.use('/:projectid/faq_kb', [passport.authenticate(['basic', 'jwt'], { session: false }), validtoken, roleChecker.hasRole('agent')], faq_kb);
+//deprecated
+app.use('/:projectid/faq_kb', [passport.authenticate(['basic', 'jwt'], { session: false }), validtoken, roleChecker.hasRoleOrTypes('agent', ['bot','subscription'])], faq_kb);
+app.use('/:projectid/bots', [passport.authenticate(['basic', 'jwt'], { session: false }), validtoken, roleChecker.hasRoleOrTypes('agent', ['bot','subscription'])], faq_kb);
 
 
 
@@ -372,6 +375,8 @@ app.use('/:projectid/labels', [fetchLabels],labels);
 
 app.use('/:projectid/campaigns',[passport.authenticate(['basic', 'jwt'], { session: false }), validtoken, roleChecker.hasRole('agent')], campaigns);
 
+app.use('/:projectid/emails',[passport.authenticate(['basic', 'jwt'], { session: false }), validtoken, roleChecker.hasRole('owner')], email);
+
 
 
 if (pubModulesManager) {

package/config/labels/widget.json

@@ -5,8 +5,8 @@
         "LABEL_PLACEHOLDER": "type your message..",
         "LABEL_START_NW_CONV": "New conversation",
         "LABEL_FIRST_MSG": "Describe shortly your problem, you will be contacted by an agent.",
-        "LABEL_FIRST_MSG_NO_AGENTS": "🤔  All operators are offline at the moment. You can anyway describe your problem. It will be assigned to the support team who will answer you as soon as possible.",
-        "LABEL_FIRST_MSG_OPERATING_HOURS_CLOSED": "🤔  Our offices are closed. You can anyway describe your problem. It will be assigned to the support team who will answer you as soon as possible.",
+        "LABEL_FIRST_MSG_NO_AGENTS": "🤔  All operators are offline at the moment. You can anyway describe your problem. It will be assigned to the support team who will get back to you as soon as possible.",
+        "LABEL_FIRST_MSG_OPERATING_HOURS_CLOSED": "🤔  Our offices are closed. You can anyway describe your problem. It will be assigned to the support team who will get back to you as soon as possible.",
         "LABEL_SELECT_TOPIC": "Select a topic",
         "LABEL_COMPLETE_FORM": "Complete the form to start a conversation with the next available agent.",
         "LABEL_FIELD_NAME": "Name",

package/models/request.js

@@ -43,7 +43,7 @@ var RequestSchema = new Schema({
     type: String,
     required: true,
     index: true,
-    // unique: true        
+    unique: true        
 
   },
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tiledesk/tiledesk-server",
   "description": "The Tiledesk server module",
-  "version": "2.2.11",
+  "version": "2.2.16",
   "scripts": {
     "start": "node ./bin/www",
     "pretest": "mongodb-runner start",
@@ -39,12 +39,12 @@
     "@tiledesk-ent/tiledesk-server-jwthistory": "^1.1.9",
     "@tiledesk-ent/tiledesk-server-mt": "^1.1.7",
     "@tiledesk-ent/tiledesk-server-payments": "^1.1.5",
-    "@tiledesk-ent/tiledesk-server-queue": "^1.1.10",
+    "@tiledesk-ent/tiledesk-server-queue": "^1.1.11",
     "@tiledesk-ent/tiledesk-server-request-history": "^1.1.5",
-    "@tiledesk-ent/tiledesk-server-resthook": "^1.1.51",
+    "@tiledesk-ent/tiledesk-server-resthook": "^1.1.53",
     "@tiledesk-ent/tiledesk-server-routing-queue": "^1.1.11",
     "@tiledesk-ent/tiledesk-server-tags": "^1.1.1",
-    "@tiledesk-ent/tiledesk-server-triggers": "^1.1.78",
+    "@tiledesk-ent/tiledesk-server-triggers": "^1.1.82",
     "@tiledesk-ent/tiledesk-server-visitorcounter": "^1.1.1"
   },
   "dependencies": {

package/public/samples/bot/external/searcher/parse

@@ -0,0 +1,10 @@
+{
+    "text": "question",
+    "intent": { "name": "brutteparole", "confidence": 0.9257488250732422 },
+    "entities": [],
+    "text_tokens": [ [ 0, 8 ] ],
+    "intent_ranking": [
+      { "name": "brutteparole", "confidence": 0.9257488250732422 },
+      { "name": "eta", "confidence": 0.0742512047290802 }
+    ]
+}

package/pubmodules/messageTransformer/index.js

@@ -1,6 +1,9 @@
 const messageTransformerInterceptor = require("./messageTransformerInterceptor");
 const microLanguageTransformerInterceptor = require("./microLanguageAttributesTransformerInterceptor");
+const messageHandlebarsTransformerInterceptor = require("./messageHandlebarsTransformerInterceptor");
 
 
 
-module.exports = {messageTransformerInterceptor:messageTransformerInterceptor, microLanguageTransformerInterceptor:microLanguageTransformerInterceptor};
+module.exports = {messageTransformerInterceptor:messageTransformerInterceptor, 
+                microLanguageTransformerInterceptor:microLanguageTransformerInterceptor,
+                messageHandlebarsTransformerInterceptor: messageHandlebarsTransformerInterceptor};

package/pubmodules/messageTransformer/messageHandlebarsTransformerInterceptor.js

@@ -0,0 +1,83 @@
+
+const messagePromiseEvent = require('../../event/messagePromiseEvent');
+const Request = require('../../models/request');
+var winston = require('../../config/winston');
+var cacheUtil = require('../../utils/cacheUtil');
+var handlebars = require('handlebars');
+
+class MessageHandlebarsTransformerInterceptor {
+
+ 
+
+
+    listen() {
+
+        var that = this;
+        winston.info("MessageHandlebarsTransformerInterceptor listener start ");
+ 
+
+        messagePromiseEvent.on('message.create.simple.before', async (data) => {
+            winston.debug('MessageHandlebarsTransformerInterceptor message.create.simple.before', data); 
+
+            var message = data.beforeMessage;
+            
+            if (!message.text) { //for image i think
+                return data;
+            }
+            if (message.attributes && message.attributes.templateProcessor == true) { 
+
+                // TODO if variables are presents
+
+                var q1 = Request.findOne({request_id:  message.recipient, id_project: message.id_project});
+
+                // if (message.attributes && message.attributes.populateTemplate == true) {
+                    q1.populate('lead').
+                    populate('department').  
+                    populate('participatingBots').
+                    populate('participatingAgents').       
+                    populate({path:'requester',populate:{path:'id_user'}});
+                // }
+
+                var request = await q1.
+                    cache(cacheUtil.defaultTTL, message.id_project+":requests:request_id:"+message.recipient).
+                    exec();
+
+
+
+                var requestJSON = request.toJSON();
+
+                winston.debug('request mti: ', requestJSON);
+
+
+                var template = handlebars.compile(message.text);
+                winston.debug('template: '+ template);
+
+                // var templateSpec = handlebars.precompile(message.text);
+                // winston.info('templateSpec: ', templateSpec);
+
+
+                var replacements = {        
+                  request: requestJSON,
+                };
+            
+                // {{request.first_text}}
+                // {{request.participatingAgents.0.firstname}}
+
+
+                
+
+                var text = template(replacements);
+                winston.debug('text: '+ text);
+                message.text=text;
+
+            }
+            winston.debug('data: ' + JSON.stringify(data) );
+            return data;
+        });
+
+    }
+    
+}
+
+var messageHandlebarsTransformerInterceptor = new MessageHandlebarsTransformerInterceptor();
+module.exports = messageHandlebarsTransformerInterceptor;

package/pubmodules/pubModulesManager.js

@@ -168,6 +168,7 @@ class PubModulesManager {
             try {
                 this.messageTransformer.messageTransformerInterceptor.listen();
                 this.messageTransformer.microLanguageTransformerInterceptor.listen();    
+                this.messageTransformer.messageHandlebarsTransformerInterceptor.listen();
                 winston.info("PubModulesManager messageTransformer started.");   
             } catch(err) {        
                 winston.info("PubModulesManager error starting messageTransformer module", err);            

package/routes/auth.js

@@ -476,8 +476,12 @@ router.get('/pendinginvitationsnoauth/:pendinginvitationid', function (req, res)
 router.put('/requestresetpsw', function (req, res) {
 
   winston.debug('REQUEST RESET PSW - EMAIL REQ BODY ', req.body);
+
+  var email = req.body.email.toLowerCase();
+  winston.debug("email", email);
+
 // auttype
-  User.findOne({ email: req.body.email, status: 100
+  User.findOne({ email: email, status: 100
     // , authType: 'email_password' 
   }, function (err, user) {
     if (err) {

package/routes/email.js

@@ -0,0 +1,32 @@
+var express = require('express');
+
+var router = express.Router();
+
+var emailService = require("../services/emailService");
+var winston = require('../config/winston');
+
+router.get('/templates/:templateid', 
+ async (req, res) => {
+  let templateid = req.params.templateid+".html";
+  winston.debug("templateid",templateid);
+
+  var html = await emailService.readTemplateFile(templateid);
+    res.json({template:html});
+});
+ 
+router.post('/test/send', 
+ async (req, res) => {
+  let to = req.body.to;
+  winston.info("to",to);
+
+  let configEmail = req.body.config;
+  winston.info("configEmail", configEmail);
+
+  emailService.sendTest(to, configEmail, function(err,obj) {
+    // winston.info("sendTest rest", err, obj);
+    res.json({error: err, response:obj});
+  });
+    
+});
+
+module.exports = router;

package/routes/faq.js

@@ -1,6 +1,7 @@
 var express = require('express');
 var router = express.Router();
 var Faq = require("../models/faq");
+var Faq_kb = require("../models/faq_kb");
 var multer = require('multer')
 var upload = multer()
 const faqBotEvent = require('../event/faqBotEvent');
@@ -31,6 +32,16 @@ router.post('/uploadcsv', upload.single('uploadFile'), function (req, res, next)
   // PARSE CSV
  
 
+
+  Faq_kb.findById(id_faq_kb).exec(function(err, faq_kb) {
+    if (err) {
+      return res.status(500).send({ success: false, msg: 'Error getting object.' });
+    }
+    if (!faq_kb) {
+      return res.status(404).send({ success: false, msg: 'Object not found.' });
+    }
+    winston.debug('faq_kb ', faq_kb.toJSON());
+
   // getFaqKbKeyById(req.body.id_faq_kb, function (remote_faqkb_key) {
 
     parsecsv.parseString(csv, { headers: false, delimiter: delimiter })
@@ -57,6 +68,7 @@ router.post('/uploadcsv', upload.single('uploadFile'), function (req, res, next)
           intent_id:intent_id,
           intent_display_name: intent_display_name,
           webhook_enabled: webhook_enabled_boolean,
+          language: faq_kb.language,
           id_project: req.projectid,
           createdBy: req.user.id,
           updatedBy: req.user.id
@@ -81,45 +93,56 @@ router.post('/uploadcsv', upload.single('uploadFile'), function (req, res, next)
         winston.error("PARSE ERROR uploadcsv", err);
         res.json({ success: false, msg: 'Parsing error' });
       });
-  // });
+  });
 });
 
 
 router.post('/', function (req, res) {
 
   winston.debug(req.body);
-  var newFaq = new Faq({
-    id_faq_kb: req.body.id_faq_kb,
-    question: req.body.question,
-    answer: req.body.answer,
-    id_project: req.projectid,
-    topic: req.body.topic,
-    webhook_enabled: req.body.webhook_enabled,
-    intent_display_name: req.body.intent_display_name,
-    createdBy: req.user.id,
-    updatedBy: req.user.id
-  });
 
-  newFaq.save(function (err, savedFaq) {
+  Faq_kb.findById(req.body.id_faq_kb).exec(function(err, faq_kb) {
     if (err) {
-      if (err.code == 11000) {
-        return res.status(409).send({ success: false, msg: 'Duplicate  intent_display_name.' });
-      } else {
-        winston.debug('--- > ERROR ', err)
-        return res.status(500).send({ success: false, msg: 'Error saving object.' });
-      }     
+      return res.status(500).send({ success: false, msg: 'Error getting object.' });
     }
-    winston.debug('1. ID OF THE NEW FAQ CREATED ', savedFaq._id)
-    winston.debug('1. QUESTION OF THE NEW FAQ CREATED ', savedFaq.question)
-    winston.debug('1. ANSWER OF THE NEW FAQ CREATED ', savedFaq.answer)
-    winston.debug('1. ID FAQKB GET IN THE OBJECT OF NEW FAQ CREATED ', savedFaq.id_faq_kb);
+    if (!faq_kb) {
+      return res.status(404).send({ success: false, msg: 'Object not found.' });
+    }
+    winston.debug('faq_kb ', faq_kb.toJSON());
+
+    var newFaq = new Faq({
+      id_faq_kb: req.body.id_faq_kb,
+      question: req.body.question,
+      answer: req.body.answer,
+      id_project: req.projectid,
+      topic: req.body.topic,
+      language: faq_kb.language,
+      webhook_enabled: req.body.webhook_enabled,
+      intent_display_name: req.body.intent_display_name,
+      createdBy: req.user.id,
+      updatedBy: req.user.id
+    });
 
-    faqBotEvent.emit('faq.create', savedFaq);
+    newFaq.save(function (err, savedFaq) {
+      if (err) {
+        if (err.code == 11000) {
+          return res.status(409).send({ success: false, msg: 'Duplicate  intent_display_name.' });
+        } else {
+          winston.debug('--- > ERROR ', err)
+          return res.status(500).send({ success: false, msg: 'Error saving object.' });
+        }     
+      }
+      winston.debug('1. ID OF THE NEW FAQ CREATED ', savedFaq._id)
+      winston.debug('1. QUESTION OF THE NEW FAQ CREATED ', savedFaq.question)
+      winston.debug('1. ANSWER OF THE NEW FAQ CREATED ', savedFaq.answer)
+      winston.debug('1. ID FAQKB GET IN THE OBJECT OF NEW FAQ CREATED ', savedFaq.id_faq_kb);
 
-    res.json(savedFaq);
+      faqBotEvent.emit('faq.create', savedFaq);
 
-  
+      res.json(savedFaq);
 
+    
+    });
   });
 });
 

package/routes/faq_kb.js

@@ -6,8 +6,10 @@ var Department = require("../models/department");
 var faqService = require("../services/faqService");
 const botEvent = require('../event/botEvent');
 var winston = require('../config/winston');
+var httpUtil = require("../utils/httpUtil");
 
 router.post('/', function (req, res) {
+  winston.info('create BOT ', req.body);
   // create(name, url, projectid, user_id, type, description) {
   faqService.create(req.body.name, req.body.url, req.projectid, req.user.id, req.body.type, req.body.description, undefined, undefined,
     req.body.language).then(function(savedFaq_kb) {
@@ -18,6 +20,106 @@ router.post('/', function (req, res) {
 });
 
 
+router.post('/train', function (req, res) {
+
+  winston.info('train BOT ', req.body);
+
+  Faq_kb.findById(req.body.id_faq_kb).exec(function(err, faq_kb) {
+    if (err) {
+      return res.status(500).send({ success: false, msg: 'Error getting object.' });
+    }
+    if (!faq_kb) {
+      return res.status(404).send({ success: false, msg: 'Object not found.' });
+    }
+    winston.debug('faq_kb ', faq_kb.toJSON());
+
+    winston.debug('faq_kb.type :'+ faq_kb.type);
+    if (faq_kb.type =="internal" && faq_kb.url) {
+
+
+
+      var train =   {
+        language:faq_kb.language,
+        nlu:[]
+      };
+      winston.info("train", train);     
+      
+
+      var query = { "id_project": req.projectid, "id_faq_kb": req.body.id_faq_kb};
+
+      Faq.find(query) 
+      .limit(10000)
+      .lean().               
+       exec(async (err, faqs) => {
+         if (err) {
+           return res.status(500).send({ success: false, msg: 'Error getting object.' });
+         }
+         if (faqs && faqs.length>0) {
+          winston.info("faqs exact", faqs);              
+
+          faqs.forEach(function(f) {
+            var intent = {
+              intent:f.intent_display_name,
+              examples:[]
+            }
+            var questions = f.question.split("\n");
+            winston.info("questions", questions);
+
+            questions.forEach(function(q) {
+              winston.info("q", q);
+              intent.examples.push(q);
+            });       
+            winston.info("intent", intent);
+            train.nlu.push(intent);            
+          });
+          winston.info("train", train);
+
+          try {
+            var trainHttp = await httpUtil.call(faq_kb.url+"/trainandload", undefined, train, "POST");
+          }catch(e) {
+            winston.error("error training", e);
+          }
+          
+
+          return res.json({train:train, httpResponse:trainHttp});
+          // return res.json(trainHttp);
+         }else {
+          return res.status(400).send({ success: false, msg: 'no faq to  train on external bot.' });
+         }
+        });
+    } else {
+      winston.debug('external query: ');
+      return res.status(400).send({ success: false, msg: 'you can train a standard internal bot or an external bot.' });
+    }
+
+  });
+
+    /*
+  {
+    "language":"it",
+    "nlu":[
+       {
+          "intent":"eta",
+          "examples":[
+             "quanti anni hai",
+             "dimmi la tua età",
+             "quanto sei grande",
+             "parlami della tua età"
+          ]
+       },
+       {
+          "intent":"brutteparole",
+          "examples":[
+             "non dire parolacce",
+             "le brutte parole non dovrebbero dirsi"
+          ]
+       }
+    ]
+ }
+*/
+
+});
+
 
 router.post('/askbot', function (req, res) {
 

package/routes/message.js

@@ -26,13 +26,21 @@ csv.separator = ';';
 // var roleChecker = require('../middleware/has-role');
 
 router.post('/', 
-// se type image text può essere empty validare meglio.
 // [
-//   check('text').notEmpty(),  
+//   check('text').custom(value => {
+//     console.log("value",value);
+//     console.log("req.body.type",this.type);
+//     if (this.type === "text" && (value == undefined || value == "" ) ) {    
+//       // if (this.type === "text" && ( (!value) || (value === "") ) ) {    
+//       console.log("sono qui ",value);
+//       return Promise.reject('Text field is required for text message');
+//     }else {
+//       console.log("sono qua ",value);
+//       return Promise.resolve();
+//     }
+//   })
 // ],
-// 
 async (req, res)  => {
-// function(req, res) {
 
   winston.debug('req.body post message', req.body);
   winston.debug('req.params: ', req.params);
@@ -95,7 +103,7 @@ async (req, res)  => {
                 winston.debug("queryProjectUser", queryProjectUser);
                 
                 project_user = await Project_user.findOne(queryProjectUser).populate({path:'id_user', select:{'firstname':1, 'lastname':1, 'email':1}})
-                winston.debug("queryProjectUser", queryProjectUser);
+                winston.info("project_user", project_user);
             
                 if (!project_user) {
                   return res.status(403).send({success: false, msg: 'Unauthorized. Project_user not found with user id  : '+ sender });
@@ -130,14 +138,25 @@ async (req, res)  => {
               return leadService.createIfNotExistsWithLeadId(sender || req.user._id, fullname, email, req.projectid, null, req.body.attributes || req.user.attributes)
               .then(function(createdLead) {
 
-
-
+               
               
-                var new_request = {                                     // problema
-                  request_id: req.params.request_id, project_user_id: project_user._id, lead_id: createdLead._id, id_project:req.projectid,
-                  first_text: req.body.text, departmentid: req.body.departmentid, sourcePage:req.body.sourcePage, 
-                  language: req.body.language, userAgent:req.body.userAgent, status:null, createdBy: req.user._id,
-                  attributes: req.body.attributes, subject: req.body.subject, preflight:undefined, channel: req.body.channel, location: req.body.location,
+                var new_request = {                                     
+                  request_id: req.params.request_id, 
+                  project_user_id: project_user._id, 
+                  lead_id: createdLead._id, 
+                  id_project:req.projectid,
+                  first_text: req.body.text, 
+                  departmentid: req.body.departmentid, 
+                  sourcePage:req.body.sourcePage, 
+                  language: req.body.language, 
+                  userAgent:req.body.userAgent, 
+                  status:null, 
+                  createdBy: req.user._id,
+                  attributes: req.body.attributes, 
+                  subject: req.body.subject, 
+                  preflight:undefined, 
+                  channel: req.body.channel, 
+                  location: req.body.location,
                   participants: req.body.participants,
                   lead: createdLead, requester: project_user,
                   priority: req.body.priority
@@ -183,7 +202,15 @@ async (req, res)  => {
                             return res.json(message);
                           });
                         });
-                    });                           
+                    }).catch(function(err){    //pubblica questo
+                      winston.log({
+                        level: 'error',
+                        message: 'Error creating request: '+ JSON.stringify(err) + " " + JSON.stringify(req.body) ,
+                        label: req.projectid
+                      });
+                      // winston.error("Error creating message", err);
+                      return res.status(500).send({success: false, msg: 'Error creating request', err:err });
+                    });                                
                       
                   });