@tiledesk/tiledesk-server 2.2.30 → 2.2.31

package/CHANGELOG.md

@@ -1,4 +1,19 @@
 
+
+
+# 2.2.31 (compatible with: Dashboard 2.2.37, Widget 5.0.25)
+- Fix email template reading from project.
+- Added transcript webpage for users without system messages
+- Fix export messages to csv
+- Fix ip address resolver
+- Exclude poweredBy field from widget endpoint
+- Bugfix when a conversation has a first_text with \agent
+- Added rasa chatbot chatbot type 
+- Added visitor email and fullname in the fulltext index 
+
+# 2.2.30 -> PROD 
+- Log fix
+
 # 2.2.29 
 - Added endpoint to find requests created by users and guests
 - Log fix
@@ -20,7 +35,7 @@
 - Added endpoint to close a request by guest
 
 
-# 2.2.26 -> PROD (compatible with dasboard ver. 2.2.35)
+# 2.2.26 (compatible with dasboard ver. 2.2.35)
 - Tag fix for 2.2.25
 
 # 2.2.25

package/app.js

@@ -320,7 +320,10 @@ var projectSetter = function (req, res, next) {
 
 
 function customDetection (req)  {
-  const ip = req.headers['x-forwarded-for'] || req.connection.remoteAddress;
+  // const ip = req.headers['x-forwarded-for'] || req.connection.remoteAddress;  
+  const ip = (req.headers['x-forwarded-for'] || '').split(',').pop().trim() ||        //https://stackoverflow.com/questions/8107856/how-to-determine-a-users-ip-address-in-node
+    req.socket.remoteAddress
+
   winston.info("standard ip: "+ip); // ip address of the user
   return ip;
 }

package/models/request.js

@@ -254,6 +254,7 @@ var RequestSchema = new Schema({
     required: false
   },
   location: LocationSchema,
+  
   id_project: {
     type: String,
     required: true,
@@ -417,7 +418,9 @@ RequestSchema.index({ id_project: 1, request_id: 1 }
 // https://docs.mongodb.com/manual/reference/text-search-languages/#text-search-languages
 
 //TODO cambiare dummy con language? attento che il codice deve essere compatibile
-RequestSchema.index({transcript: 'text', rating_message: 'text', subject: 'text', "tags.tag": 'text', "notes.text": 'text'},  
+
+
+RequestSchema.index({transcript: 'text', rating_message: 'text', subject: 'text', "tags.tag": 'text', "notes.text": 'text', "snapshot.lead.email": 'text', "snapshot.lead.fullname": 'text' },  
  {"name":"request_fulltext","default_language": defaultFullTextLanguage,"language_override": "dummy"}); // schema level
 
 //  let query = {id_project: operatorSelectedEvent.id_project, participants: { $exists: true, $ne: [] }};
@@ -431,6 +434,9 @@ RequestSchema.index({ id_project: 1, preflight:1, updatedAt: -1 }); // used quer
 
 RequestSchema.index({ hasBot: 1, createdAt: 1 }); // suggested by atlas
 
+RequestSchema.index({ id_project: 1, ticket_id: 1 });
+
+
 
 //   cannot index parallel arrays [agents] [participants] {"driv
 // RequestSchema.index({ id_project: 1, status: 1, preflight:1, participants:1, "agents.id_user":1, updatedAt: -1 }); //NN LO APPLICA

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tiledesk/tiledesk-server",
   "description": "The Tiledesk server module",
-  "version": "2.2.30",
+  "version": "2.2.31",
   "scripts": {
     "start": "node ./bin/www",
     "pretest": "mongodb-runner start",

package/publiccode.yml

@@ -0,0 +1,110 @@
+# This repository adheres to the publiccode.yml standard by including this 
+# metadata file that makes public software easily discoverable.
+# More info at https://github.com/italia/publiccode.yml
+
+publiccodeYmlVersion: '0.2'
+categories:
+  - customer-service-and-support
+  - communications
+  - marketing
+  - mobile-marketing
+description:
+  it:
+    apiDocumentation: 'https://developer.tiledesk.com/apis/rest-api'
+    documentation: 'https://gethelp.tiledesk.com'
+    features:
+      - live chat widget
+      - chatbot
+      - 'integration with DialogFlow, Rasa and all major AI solutions'
+      - ticketing
+      - multi-project management
+      - SLAs setting
+      - 'smart assignment of the queues '
+      - seamless conversation
+      - dashboard
+      - knowledge base
+      - mobile apps
+    genericName: Live chat with integrated chatbots
+    longDescription: |
+      To have fully satisfied customers is complex. Conversation’s actors
+      (chatbots and humans) should handoff to each other many times during a
+      chat to address customers needs. 
+
+
+      Tiledesk provides a solution **orchestrating instant, asynchronous and
+      multichannel communication among all stakeholders of a typical
+      conversational architecture**: chatbots, support operators, end users,
+      colleagues, applications, etc.  
+
+
+      **Main Features**: 
+
+
+      - Live Chat Widget with full multichannel experience on Web and Mobile; 
+
+      - Resolution Bot to automate customer support; 
+
+      - Easy Integration with all major AI-platforms, cloud and Open source,
+      from DialogFlow to RASA; 
+
+      - Ticketing Management system fully integrated into the platform and
+      instant conversation flow; 
+
+      - Team Organization with multi-project management, SLAs setting, smart
+      assignment of the 
+       queues, departments organization and much more; 
+      - Seamless conversation to “jump” between different channels in a
+      transparent way for end 
+       customers and agents; 
+      - Chat Tools like typing indicator, off-line access, delivery receipts,
+      contact list and much more; 
+
+      - Dashboard with real time analytics; 
+
+      - Knowledge base.
+
+           
+
+      Tiledesk is an **open source **project, made with passion in Salento
+      (Southern Italy).
+    shortDescription: |-
+      Tiledesk delivers scalable customer service to your mobile apps and your
+      website. It is a conversational platform that connects chatbots and
+      humans 
+developmentStatus: stable
+it:
+  conforme:
+    gdpr: false
+    lineeGuidaDesign: false
+    misureMinimeSicurezza: false
+    modelloInteroperabilita: false
+  countryExtensionVersion: '0.2'
+  piattaforme:
+    anpr: false
+    cie: false
+    pagopa: false
+    spid: false
+landingURL: 'https://tiledesk.com/install'
+legal:
+  license: AGPL-3.0-only
+localisation:
+  availableLanguages:
+    - it
+    - en
+    - es
+    - fr
+    - pt
+    - de
+    - ru
+    - tr
+  localisationReady: true
+maintenance:
+  contacts:
+    - name: Andrea Sponziello
+  type: internal
+name: Tiledesk
+platforms:
+  - web
+releaseDate: '2022-06-15'
+softwareType: standalone/web
+url: 'https://github.com/Tiledesk/tiledesk-deployment'

package/pubmodules/pubModulesManager.js

@@ -18,6 +18,8 @@ class PubModulesManager {
         this.messageTransformer = undefined;
 
         this.scheduler = undefined;
+
+        this.rasa = undefined;
     }
 
   
@@ -140,6 +142,21 @@ class PubModulesManager {
         }
 
 
+        try {
+            this.rasa = require('./rasa');
+            winston.debug("this.rasa:"+ this.rasa);    
+            this.rasa.listener.listen();      
+            winston.info("PubModulesManager initialized rasa.");
+        } catch(err) {
+            if (err.code == 'MODULE_NOT_FOUND') { 
+                winston.info("PubModulesManager init rasa module not found");
+            }else {
+                winston.info("PubModulesManager error initializing init rasa module", err);
+            }
+        }
+
+
+
       
         
     }

package/pubmodules/rasa/index.js

@@ -0,0 +1,3 @@
+const listener = require("./listener");
+
+module.exports = {listener:listener };

package/pubmodules/rasa/listener.js

@@ -0,0 +1,51 @@
+const botEvent = require('../../event/botEvent');
+var Faq_kb = require("../../models/faq_kb");
+var winston = require('../../config/winston');
+
+const BOT_RASA_ENDPOINT = process.env.BOT_RASA_ENDPOINT;
+winston.debug("BOT_RASA_ENDPOINT: " + BOT_RASA_ENDPOINT);
+
+if (BOT_RASA_ENDPOINT) {
+  winston.info("Rasa endpoint: " + BOT_RASA_ENDPOINT);
+} else {
+   winston.info("Rasa endpoint not configured");
+}
+
+
+class Listener {
+
+    listen() {
+
+        winston.debug('rasa Listener listen');   
+
+        var that = this;
+
+        botEvent.on('faqbot.create', function(bot) {
+            if (BOT_RASA_ENDPOINT) {
+
+                winston.info('bot.type:'+bot.type); 
+                if (bot.type==="rasa") {
+
+                    winston.info('qui.type:'+bot.type); 
+
+
+                    Faq_kb.findByIdAndUpdate(bot.id, {"url":BOT_RASA_ENDPOINT}, { new: true, upsert: true }, function (err, savedFaq_kb) {
+
+                    // bot.save(function (err, savedFaq_kb) {
+                        if (err) {
+                         return winston.error('error saving faqkb rasa ', err)
+                        }
+                        winston.verbose('Saved faqkb rasa', savedFaq_kb.toObject())      
+                    });
+                }
+            }
+        });
+        
+    }
+
+}
+
+var listener = new Listener();
+
+
+module.exports = listener;

package/pubmodules/rules/conciergeBot.js

@@ -338,6 +338,7 @@ devi mandare un messaggio welcome tu altrimenti il bot inserito successivamente
                     if (request.subject) {
                         touchText = request.subject;
                     }
+                    touchText.replace("\\",""); //Bugfix when a conversation has a first_text with \agent
 
                         // messageService.send(sender, senderFullname, recipient, text, id_project, createdBy, attributes, type);
                         messageService.send(

package/routes/message.js

@@ -139,7 +139,7 @@ async (req, res)  => {
               .then(function(createdLead) {
 
                
-              
+            
                 var new_request = {                                     
                   request_id: req.params.request_id, 
                   project_user_id: project_user._id, 
@@ -312,9 +312,20 @@ async (req, res)  => {
 //     });
 //   });
 
+  router.get('/csv', function(req, res) {
+
+    // console.log("csv");
+
+
+    return Message.find({"recipient": req.params.request_id, id_project: req.projectid}).sort({createdAt: 'asc'}).exec(function(err, messages) { 
+      if (err) return next(err);
+      res.csv(messages, true);
+    });
+  });
+
   router.get('/:messageid', function(req, res) {
   
-    console.log(req.body);
+    // console.log(req.body);
     
     Message.findById(req.params.messageid, function(err, message) {
       if (err) {
@@ -337,13 +348,7 @@ router.get('/', function(req, res) {
     });
 });
 
-router.get('/csv', function(req, res) {
 
-  return Message.find({"recipient": req.params.request_id, id_project: req.projectid}).sort({createdAt: 'asc'}).exec(function(err, messages) { 
-      if (err) return next(err);
-      res.csv(messages, true);
-    });
-});
 
 
 module.exports = router;

package/routes/project_user.js

@@ -367,7 +367,7 @@ router.get('/:project_userid', [passport.authenticate(['basic', 'jwt'], { sessio
 
 
 router.get('/users/search', [passport.authenticate(['basic', 'jwt'], { session: false }), validtoken, roleChecker.hasRoleOrTypes('agent', ['subscription'])], async (req, res, next) => {
-  winston.info("--> users search  ");
+  winston.debug("--> users search  ");
 
   if (!req.project) {
     return res.status(404).send({ success: false, msg: 'Project not found.' });
@@ -376,10 +376,10 @@ router.get('/users/search', [passport.authenticate(['basic', 'jwt'], { session:
 
   let query =  {email: req.query.email};
   
-  winston.info('query: ', query);
+  winston.debug('query: ', query);
   
   let user = await User.findOne(query).exec();
-  winston.info('user: ', user);
+  winston.debug('user: ', user);
   
   if (!user) {
     return res.status(404).send({ success: false, msg: 'Object not found.' });
@@ -387,7 +387,7 @@ router.get('/users/search', [passport.authenticate(['basic', 'jwt'], { session:
  
 
   let project_user = await Project_user.findOne({id_user: user._id, id_project: req.projectid}).exec();
-  winston.info('project_user: ', project_user);
+  winston.debug('project_user: ', project_user);
   
   if (!project_user) {
     return res.status(403).json({msg: "Unauthorized. This is not a your teammate." });

package/routes/widget.js

@@ -114,10 +114,38 @@ router.get('/', function(req, res, next) {
 
   }
 
+
+  var getProject = function(req) {
+    winston.info('getProject.');
+
+    return new Promise(function (resolve, reject) {
+
+       //@DISABLED_CACHE .cache(cacheUtil.queryTTL, "projects:query:id:status:100:"+req.projectid+":select:-settings")            
+      
+      Project.findOne({_id: req.projectid, status: 100}).select('-settings -ipFilter -ipFilterEnabled').exec(function(err, project) {
+        // not use .lean I need project.trialExpired 
+
+          if (err) {
+            return reject({err: "Project Not Found"});        
+          }
+
+          if (project && project.profile && (project.profile.type === 'free' && project.trialExpired === true) || (project.profile.type === 'payment' && project.isActiveSubscription === false)) {
+            winston.info('getProject remove poweredBy tag', project);
+            project.widget.poweredBy = undefined;
+            project.widget.baloonImage = undefined;            
+          }
+
+        return resolve(project);
+      });        
+
+    });
+
+  }
+
 // TOOD add labels
     Promise.all([
-        Project.findOne({_id: req.projectid, status: 100}).select('-settings')
-        //@DISABLED_CACHE .cache(cacheUtil.queryTTL, "projects:query:id:status:100:"+req.projectid+":select:-settings")        
+
+        getProject(req)
       ,
         availableUsers()
       ,

package/services/emailService.js

@@ -98,13 +98,13 @@ class EmailService {
     this.host = process.env.EMAIL_HOST || config.host;
     winston.info('EmailService host: ' + this.host);
 
-    this.secure  = process.env.EMAIL_SECURE || false;
+    this.secure  = process.env.EMAIL_SECURE || false;     
     winston.info('EmailService secure: ' + this.secure);
 
     this.user  = process.env.EMAIL_USERNAME || config.username;
     winston.info('EmailService username: ' + this.user);
 
-    this.port  = process.env.EMAIL_PORT;
+    this.port  = process.env.EMAIL_PORT;  //default is 587
     winston.info('EmailService port: ' + this.port);
 
 
@@ -123,11 +123,19 @@ class EmailService {
     var that = this;
     winston.debug('EmailService readTemplate: '+ templateName + '  ' + JSON.stringify(settings)); 
     
+
       if (settings && settings.email && settings.email.templates) {
+
        var templates = settings.email.templates;
        winston.debug('EmailService templates: ',templates); 
-       var template = templates[templateName];
+
+       var templateDbName = templateName.replace(".html", "");
+       winston.debug('EmailService templateDbName: '+templateDbName); 
+
+
+       var template = templates[templateDbName];
        winston.debug('EmailService template: '+template); 
+
         if (template) {
         // that.callback(template);
           return new Promise(function (resolve, reject) {
@@ -240,7 +248,6 @@ class EmailService {
     };
 
     winston.debug('mailOptions', mailOptions);
-
     if (!mail.to) {
       return winston.warn("EmailService send method. to field is not defined", mailOptions);
     }
@@ -273,7 +280,7 @@ class EmailService {
 
     var that = this;
 
-    var html = await this.readTemplateFile('test.html');
+    var html = await this.readTemplate('test.html',{ "email" : {"templates": {test: "123"}}});
 
     var template = handlebars.compile(html);
 
@@ -282,7 +289,7 @@ class EmailService {
 
     var html = template(replacements);
     
-    return that.send({to:to, subject:`TileDesk test email`, config: configEmail, html: html, callback: callback});
+    return that.send({to:to, subject:`Tiledesk test email`, config: configEmail, html: html, callback: callback});
     
   }
 
@@ -399,10 +406,12 @@ class EmailService {
       }
     }
 
-    let subject = `[TileDesk ${project ? project.name : '-'}] New Assigned Chat`;
+
+
+    let subject = `[Tiledesk ${project ? project.name : '-'}] New Assigned Chat`;
 
     if (request.subject) {
-      subject = `[TileDesk ${project ? project.name : '-'}] ${request.subject}`;
+      subject = `[Tiledesk ${project ? project.name : '-'}] ${request.subject}`;
     }
 
     // if (request.ticket_id) {
@@ -546,10 +555,10 @@ class EmailService {
     }
 
 
-    let subject = `[TileDesk ${project ? project.name : '-'}] New message`;
+    let subject = `[Tiledesk ${project ? project.name : '-'}] New message`;
 
     if (request.subject) {
-      subject = `[TileDesk ${project ? project.name : '-'}] ${request.subject}`;
+      subject = `[Tiledesk ${project ? project.name : '-'}] ${request.subject}`;
     }
     if (request.ticket_id) {
       subject = `[Ticket #${request.ticket_id}] New message`;
@@ -690,10 +699,10 @@ class EmailService {
       }
     }
 
-    let subject = `[TileDesk ${project ? project.name : '-'}] New Pooled Chat`;
+    let subject = `[Tiledesk ${project ? project.name : '-'}] New Pooled Chat`;
 
     if (request.subject) {
-      subject = `[TileDesk ${project ? project.name : '-'}] ${request.subject}`;
+      subject = `[Tiledesk ${project ? project.name : '-'}] ${request.subject}`;
     }
     // if (request.ticket_id) {
     //   subject = `[Ticket #${request.ticket_id}] New Pooled Chat`;
@@ -831,10 +840,10 @@ class EmailService {
     }
 
 
-    let subject = `[TileDesk ${project ? project.name : '-'}] New Message`;
+    let subject = `[Tiledesk ${project ? project.name : '-'}] New Message`;
 
     if (request.subject) {
-      subject = `[TileDesk ${project ? project.name : '-'}] ${request.subject}`;
+      subject = `[Tiledesk ${project ? project.name : '-'}] ${request.subject}`;
     }
     if (request.ticket_id) {
       subject = `[Ticket #${request.ticket_id}] New Message`;
@@ -982,7 +991,7 @@ class EmailService {
       replyTo: replyTo, 
       inReplyTo: inReplyTo,
       references: references,
-      subject:`[TileDesk ${project ? project.name : '-'}] New Offline Message`, 
+      subject:`[Tiledesk ${project ? project.name : '-'}] New Offline Message`, 
       html:html, 
       config:configEmail, 
       headers: headers
@@ -997,7 +1006,7 @@ class EmailService {
       replyTo: replyTo,
       inReplyTo: inReplyTo, 
       references: references,
-      subject: `[TileDesk ${project ? project.name : '-'}] New Offline Message - notification`, 
+      subject: `[Tiledesk ${project ? project.name : '-'}] New Offline Message - notification`, 
       html:html, 
       headers: headers
     });
@@ -1247,8 +1256,8 @@ class EmailService {
     var html = template(replacements);
 
 
-    that.send({to: to, subject: '[TileDesk] Password reset request', html:html});
-    that.send({to:that.bcc, subject: '[TileDesk] Password reset request - notification', html:html });
+    that.send({to: to, subject: '[Tiledesk] Password reset request', html:html});
+    that.send({to:that.bcc, subject: '[Tiledesk] Password reset request - notification', html:html });
 
   }
 
@@ -1285,8 +1294,8 @@ class EmailService {
     var html = template(replacements);
 
 
-    that.send({to: to, subject:'[TileDesk] Your password has been changed', html:html });
-    that.send({to: that.bcc, subject: '[TileDesk] Your password has been changed - notification', html: html });
+    that.send({to: to, subject:'[Tiledesk] Your password has been changed', html:html });
+    that.send({to: that.bcc, subject: '[Tiledesk] Your password has been changed - notification', html: html });
 
   }
 
@@ -1332,8 +1341,8 @@ class EmailService {
     var html = template(replacements);
 
 
-    that.send({to:to, subject: `[TileDesk] You have been invited to the '${projectName}' project`, html:html});
-    that.send({to: that.bcc, subject: `[TileDesk] You have been invited to the '${projectName}' project - notification`, html: html});
+    that.send({to:to, subject: `[Tiledesk] You have been invited to the '${projectName}' project`, html:html});
+    that.send({to: that.bcc, subject: `[Tiledesk] You have been invited to the '${projectName}' project - notification`, html: html});
   }
 
     // ok
@@ -1376,8 +1385,8 @@ class EmailService {
 
     var html = template(replacements);
 
-    that.send({to:to, subject: `[TileDesk] You have been invited to the '${projectName}' project`, html:html });
-    that.send({to: that.bcc, subject: `[TileDesk] You have been invited to the '${projectName}' project - notification`, html: html});
+    that.send({to:to, subject: `[Tiledesk] You have been invited to the '${projectName}' project`, html:html });
+    that.send({to: that.bcc, subject: `[Tiledesk] You have been invited to the '${projectName}' project - notification`, html: html});
 
   }
 
@@ -1415,8 +1424,8 @@ class EmailService {
     var html = template(replacements);
 
 
-    that.send({to: to, subject: `[TileDesk] Verify your email address`, html:html });
-    that.send({to: that.bcc, subject: `[TileDesk] Verify your email address `+to + " - notification", html:html });
+    that.send({to: to, subject: `[Tiledesk] Verify your email address`, html:html });
+    that.send({to: that.bcc, subject: `[Tiledesk] Verify your email address `+to + " - notification", html:html });
 
   }
 
@@ -1483,8 +1492,8 @@ async sendRequestTranscript(to, messages, request, project) {
       winston.verbose("custom email setting found: ", configEmail);
     }
 
-    that.send({to:to, subject: '[TileDesk] Transcript', html:html, config: configEmail});
-    that.send({to: that.bcc, subject: '[TileDesk] Transcript - notification', html:html });
+    that.send({to:to, subject: '[Tiledesk] Transcript', html:html, config: configEmail});
+    that.send({to: that.bcc, subject: '[Tiledesk] Transcript - notification', html:html });
 
 }
 
@@ -1496,6 +1505,6 @@ async sendRequestTranscript(to, messages, request, project) {
 
 var emailService = new EmailService();
 
-//emailService.sendTest("al@f21.it");
+// emailService.sendTest("al@f21.it");
 
 module.exports = emailService;