@tiledesk/tiledesk-server 2.2.15 → 2.2.16

package/CHANGELOG.md

@@ -1,10 +1,22 @@
-# 2.2.15
 
+
+
+
+# 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 AGGIORNA DOC
+- Added alias /bots for /faq_kb
 
 # 2.2.14
 - Fix Tiledesk Queue 1.1.11 with authEvent.queueEnabled = true 

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,15 +333,15 @@ 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);
 
 //deprecated
 app.use('/:projectid/faq_kb', [passport.authenticate(['basic', 'jwt'], { session: false }), validtoken, roleChecker.hasRoleOrTypes('agent', ['bot','subscription'])], faq_kb);
-// aggiorna doc
 app.use('/:projectid/bots', [passport.authenticate(['basic', 'jwt'], { session: false }), validtoken, roleChecker.hasRoleOrTypes('agent', ['bot','subscription'])], faq_kb);
 
 
@@ -375,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.15",
+  "version": "2.2.16",
   "scripts": {
     "start": "node ./bin/www",
     "pretest": "mongodb-runner start",
@@ -41,10 +41,10 @@
     "@tiledesk-ent/tiledesk-server-payments": "^1.1.5",
     "@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.79",
+    "@tiledesk-ent/tiledesk-server-triggers": "^1.1.82",
     "@tiledesk-ent/tiledesk-server-visitorcounter": "^1.1.1"
   },
   "dependencies": {

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/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/project.js

@@ -50,6 +50,69 @@ router.put('/:projectid', [passport.authenticate(['basic', 'jwt'], { session: fa
     update["settings.email.notification.conversation.pooled"] = req.body["settings.email.notification.conversation.pooled"];
   }
 
+
+
+
+  if (req.body["settings.email.templates.assignedRequest"]!=undefined) {
+    update["settings.email.templates.assignedRequest"] = req.body["settings.email.templates.assignedRequest"];
+  }
+  if (req.body["settings.email.templates.assignedEmailMessage"]!=undefined) {
+    update["settings.email.templates.assignedEmailMessage"] = req.body["settings.email.templates.assignedEmailMessage"];
+  }
+  if (req.body["settings.email.templates.pooledRequest"]!=undefined) {
+    update["settings.email.templates.pooledRequest"] = req.body["settings.email.templates.pooledRequest"];
+  }
+  if (req.body["settings.email.templates.pooledEmailMessage"]!=undefined) {
+    update["settings.email.templates.pooledEmailMessage"] = req.body["settings.email.templates.pooledEmailMessage"];
+  }
+  if (req.body["settings.email.templates.newMessage"]!=undefined) {
+    update["settings.email.templates.newMessage"] = req.body["settings.email.templates.newMessage"];
+  }
+  if (req.body["settings.email.templates.ticket"]!=undefined) {
+    update["settings.email.templates.ticket"] = req.body["settings.email.templates.ticket"];
+  }
+  if (req.body["settings.email.templates.sendTranscript"]!=undefined) {
+    update["settings.email.templates.sendTranscript"] = req.body["settings.email.templates.sendTranscript"];
+  }
+
+
+  if (req.body["settings.email.from"]!=undefined) {
+    update["settings.email.from"] = req.body["settings.email.from"];
+  }
+  if (req.body["settings.email.config.host"]!=undefined) {
+    update["settings.email.config.host"] = req.body["settings.email.config.host"];
+  }
+  if (req.body["settings.email.config.port"]!=undefined) {
+    update["settings.email.config.port"] = req.body["settings.email.config.port"];
+  }
+  if (req.body["settings.email.config.secure"]!=undefined) {
+    update["settings.email.config.secure"] = req.body["settings.email.config.secure"];
+  }
+  if (req.body["settings.email.config.user"]!=undefined) {
+    update["settings.email.config.user"] = req.body["settings.email.config.user"];
+  }
+  if (req.body["settings.email.config.pass"]!=undefined) {
+    update["settings.email.config.pass"] = req.body["settings.email.config.pass"];
+  }
+
+
+  
+  /*
+
+  if (req.body.settings.email.templates.assignedRequest!=undefined) {
+    // if (req.body["settings.email.templates.assignedRequest.html"]!=undefined) {
+    console.log("assignedRequest");
+    update["settings.email.templates.assignedRequest"] = req.body.settings.email.templates.assignedRequest;
+  }
+  if (req.body["settings.email.templates.assignedEmailMessage.html"]!=undefined) {
+    update["settings.email.templates.assignedEmailMessage.html"] = req.body["settings.email.templates.assignedEmailMessage.html"];
+  }
+  if (req.body.settings.email.templates.pooledRequest!=undefined) {
+    console.log("pooledRequest");
+    update["settings.email.templates.pooledRequest"] = req.body.settings.email.templates.pooledRequest;
+  }
+*/
+
   if (req.body["settings.chat_limit_on"]!=undefined) {
     update["settings.chat_limit_on"] = req.body["settings.chat_limit_on"];
   }
@@ -96,7 +159,7 @@ router.put('/:projectid', [passport.authenticate(['basic', 'jwt'], { session: fa
   
   winston.debug('UPDATE PROJECT REQ BODY ', update);
 
-
+  // console.log("update",JSON.stringify(update));
 
   Project.findByIdAndUpdate(req.params.projectid, update, { new: true, upsert: true }, function (err, updatedProject) {
     if (err) {
@@ -143,6 +206,50 @@ router.patch('/:projectid', [passport.authenticate(['basic', 'jwt'], { session:
   }
 
 
+  
+  if (req.body["settings.email.templates.assignedRequest"]!=undefined) {
+    update["settings.email.templates.assignedRequest"] = req.body["settings.email.templates.assignedRequest"];
+  }
+  if (req.body["settings.email.templates.assignedEmailMessage"]!=undefined) {
+    update["settings.email.templates.assignedEmailMessage"] = req.body["settings.email.templates.assignedEmailMessage"];
+  }
+  if (req.body["settings.email.templates.pooledRequest"]!=undefined) {
+    update["settings.email.templates.pooledRequest"] = req.body["settings.email.templates.pooledRequest"];
+  }
+  if (req.body["settings.email.templates.pooledEmailMessage"]!=undefined) {
+    update["settings.email.templates.pooledEmailMessage"] = req.body["settings.email.templates.pooledEmailMessage"];
+  }
+  if (req.body["settings.email.templates.newMessage"]!=undefined) {
+    update["settings.email.templates.newMessage"] = req.body["settings.email.templates.newMessage"];
+  }
+  if (req.body["settings.email.templates.ticket"]!=undefined) {
+    update["settings.email.templates.ticket"] = req.body["settings.email.templates.ticket"];
+  }
+  if (req.body["settings.email.templates.sendTranscript"]!=undefined) {
+    update["settings.email.templates.sendTranscript"] = req.body["settings.email.templates.sendTranscript"];
+  }
+
+
+  if (req.body["settings.email.from"]!=undefined) {
+    update["settings.email.from"] = req.body["settings.email.from"];
+  }
+  if (req.body["settings.email.config.host"]!=undefined) {
+    update["settings.email.config.host"] = req.body["settings.email.config.host"];
+  }
+  if (req.body["settings.email.config.port"]!=undefined) {
+    update["settings.email.config.port"] = req.body["settings.email.config.port"];
+  }
+  if (req.body["settings.email.config.secure"]!=undefined) {
+    update["settings.email.config.secure"] = req.body["settings.email.config.secure"];
+  }
+  if (req.body["settings.email.config.user"]!=undefined) {
+    update["settings.email.config.user"] = req.body["settings.email.config.user"];
+  }
+  if (req.body["settings.email.config.pass"]!=undefined) {
+    update["settings.email.config.pass"] = req.body["settings.email.config.pass"];
+  }
+
+
   if (req.body["settings.chat_limit_on"]!=undefined) {
     update["settings.chat_limit_on"] = req.body["settings.chat_limit_on"];
   }

package/routes/request.js

@@ -184,7 +184,8 @@ router.patch('/:requestid', function (req, res) {
     }
 
     requestEvent.emit("request.update", request);
-    requestEvent.emit("request.update.comment", {comment:"PATCH",request:request});
+    requestEvent.emit("request.update.comment", {comment:"PATCH",request:request}); //Deprecated
+    requestEvent.emit("request.updated", {comment:"PATCH",request:request, patch:  update});
     return res.json(request);
   });
 
@@ -455,7 +456,8 @@ router.patch('/:requestid/attributes',  function (req, res) {
           }
           winston.verbose(" saved request attributes",savedRequest.toObject())
           requestEvent.emit("request.update", savedRequest);
-          requestEvent.emit("request.update.comment", {comment:"ATTRIBUTES_PATCH",request:savedRequest});
+          requestEvent.emit("request.update.comment", {comment:"ATTRIBUTES_PATCH",request:savedRequest});//Deprecated
+          requestEvent.emit("request.updated", {comment:"ATTRIBUTES_PATCH",request:savedRequest, patch:  {attributes:data}});
           requestEvent.emit("request.attributes.update", savedRequest);
             res.json(savedRequest);
           });
@@ -483,7 +485,9 @@ router.post('/:requestid/notes',  function (req, res) {
       return res.status(500).send({ success: false, msg: 'Error adding request object.' });
     }
     requestEvent.emit("request.update", updatedRequest);
-    requestEvent.emit("request.update.comment", {comment:"NOTE_ADD",request:updatedRequest});
+    requestEvent.emit("request.update.comment", {comment:"NOTE_ADD",request:updatedRequest});//Deprecated
+    requestEvent.emit("request.updated", {comment:"NOTE_ADD",request:updatedRequest, patch:  {notes:note}});
+
     return res.json(updatedRequest);
   });
 
@@ -506,7 +510,9 @@ router.delete('/:requestid/notes/:noteid',  function (req, res) {
       return res.status(500).send({ success: false, msg: 'Error adding request object.' });
     }
     requestEvent.emit("request.update", updatedRequest);
-    requestEvent.emit("request.update.comment", {comment:"NOTE_DELETE",request:updatedRequest});
+    requestEvent.emit("request.update.comment", {comment:"NOTE_DELETE",request:updatedRequest});//Deprecated
+    // requestEvent.emit("request.updated", {comment:"NOTE_DELETE",request:updatedRequest, patch:  {notes:req.params.noteid}});
+
     return res.json(updatedRequest);
   });
 

package/routes/user-request.js

@@ -45,7 +45,9 @@ router.patch('/:requestid/rating', function (req, res) {
     }
 
     requestEvent.emit("request.update", request);
-    requestEvent.emit("request.update.comment", {comment:"PATCH",request:request});
+    requestEvent.emit("request.update.comment", {comment:"PATCH",request:request});//Deprecated
+    requestEvent.emit("request.updated", {comment:"PATCH",request:request, patch:  update});
+
     return res.json(request);
   });
 

package/services/emailService.js

@@ -119,6 +119,7 @@ class EmailService {
   }
 
   readTemplate(templateName, settings) {
+    // aggiunsta questo
     var that = this;
     winston.debug('EmailService readTemplate: '+ templateName + '  ' + JSON.stringify(settings)); 
     
@@ -246,11 +247,19 @@ class EmailService {
 
     // send mail with defined transport object
     this.getTransport(mail.config).sendMail(mailOptions, (error, info) => {
-      if (error) {
+      if (error) {    
+        if (mail.callback){
+          mail.callback(error, {info:info});
+        }
         return winston.error("Error sending email ", {error:error,  mailOptions:mailOptions});
       }
       winston.verbose('Email sent:', {info: info});
       winston.debug('Email sent:', {info: info, mailOptions: mailOptions});
+
+      if (mail.callback){
+        mail.callback(error, {info:info});
+      }
+      
       // Preview only available when sending through an Ethereal account
       // winston.debug('Preview URL: %s', nodemailer.getTestMessageUrl(info));
 
@@ -260,7 +269,7 @@ class EmailService {
   }
 
 
-  async sendTest(to) {      
+  async sendTest(to, configEmail, callback) {      
 
     var that = this;
 
@@ -268,19 +277,12 @@ class EmailService {
 
     var template = handlebars.compile(html);
 
-    var replacements = {        
-      user: {name: "andrea"},
-      enabled: true   
+    var replacements = {              
     };
 
     var html = template(replacements);
-
-    that.send({to:to, subject:`TileDesk test email`,html: html});
-
-    //that.send(that.bcc, `TileDesk test email - notification`, html);
-
-
-
+    
+    return that.send({to:to, subject:`TileDesk test email`, config: configEmail, html: html, callback: callback});
     
   }
 

package/services/faqBotHandler.js

@@ -264,10 +264,10 @@ class FaqBotHandler {
 
                                                                                         
                     var url = faq_kb.url+"/parse";
-                    winston.verbose("fulltext search external url " + url);   
+                    winston.debug("fulltext search external url " + url);   
 
                     var json = {text: message.text, language: faq_kb.language, id_project: message.id_project, id_faq_kb: faq_kb._id};
-                    winston.verbose("fulltext search external json", json);   
+                    winston.debug("fulltext search external json", json);   
 
                     var headers = {
                         'Content-Type' : 'application/json', 
@@ -276,14 +276,14 @@ class FaqBotHandler {
                         };
 
                     var res = await httpUtil.call(url, headers, json, "POST")
-                    winston.verbose("res", res);
+                    winston.debug("res", res);
                     
                     if (res && res.intent && res.intent.name) {
                         var intent_name = res.intent.name;
-                        winston.verbose("intent_name", intent_name);
+                        winston.debug("intent_name", intent_name);
                         //filtra su intent name
                         query.intent_display_name = intent_name;
-                        winston.info("query",query);                        
+                        winston.debug("query",query);                        
                     
                     }
                 } else {
@@ -294,7 +294,7 @@ class FaqBotHandler {
                         search_obj["$language"] = faq_kb.language;
                     }
                     query.$text = search_obj;
-                    winston.info("fulltext search query", query);   
+                    winston.debug("fulltext search query", query);   
                     
                     mongoproject = {score: { $meta: "textScore" } };
                     sort = { score: { $meta: "textScore" } } //https://docs.mongodb.com/manual/reference/operator/query/text/#sort-by-text-search-score