@tiledesk/tiledesk-server 2.4.50 → 2.4.52

package/app.js

@@ -113,6 +113,7 @@ var key = require('./routes/key');
 var widgets = require('./routes/widget');
 var widgetsLoader = require('./routes/widgetLoader');
 var openai_kbs = require('./routes/openai_kbs');
+var kbsettings = require('./routes/kbsettings');
 
 // var admin = require('./routes/admin');
 var faqpub = require('./routes/faqpub');
@@ -551,6 +552,8 @@ app.use('/:projectid/emails',[passport.authenticate(['basic', 'jwt'], { session:
 app.use('/:projectid/properties',[passport.authenticate(['basic', 'jwt'], { session: false }), validtoken, roleChecker.hasRoleOrTypes('agent', ['bot','subscription'])], property);
 
 app.use('/:projectid/openai_kbs', [passport.authenticate(['basic', 'jwt'], { session: false }), validtoken, roleChecker.hasRoleOrTypes('agent')], openai_kbs);
+app.use('/:projectid/kbsettings', [passport.authenticate(['basic', 'jwt'], { session: false }), validtoken, roleChecker.hasRoleOrTypes('agent', ['bot','subscription'])], kbsettings);
+
 
 
 

package/models/kb_setting.js

@@ -0,0 +1,48 @@
+var mongoose = require('mongoose');
+var Schema = mongoose.Schema;
+var winston = require('../config/winston');
+
+var KBSchema = new Schema({
+  name: {
+    type: String,
+    required: true
+  },
+  url: {
+    type: String,
+    required: true
+  },
+  createdAt: {
+    type: Date,
+    default: Date.now,
+  },
+  status: {
+    type: Number,
+    required: false,
+    default: -1
+  }
+})
+
+var KBSettingSchema = new Schema({
+  id_project: {
+    type: String,
+    required: true,
+    index: true
+  },
+  gptkey: {
+    type: String,
+    //required: true
+  },
+  maxKbsNumber: {
+    type: Number,
+    default: 3
+  },
+  maxPagesNumber: {
+    type: Number,
+    default: 1000
+  },
+  kbs: [ KBSchema ]
+});
+
+
+module.exports = mongoose.model('KBSettings', KBSettingSchema);
+// module.exports = mongoose.model('KB', KBSchema)

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tiledesk/tiledesk-server",
   "description": "The Tiledesk server module",
-  "version": "2.4.50",
+  "version": "2.4.52",
   "scripts": {
     "start": "node ./bin/www",
     "pretest": "mongodb-runner start",
@@ -44,7 +44,7 @@
     "@tiledesk/tiledesk-kaleyra-proxy": "^0.1.7",
     "@tiledesk/tiledesk-messenger-connector": "0.1.9",
     "@tiledesk/tiledesk-rasa-connector": "^1.0.10",
-    "@tiledesk/tiledesk-tybot-connector": "^0.1.91",
+    "@tiledesk/tiledesk-tybot-connector": "^0.1.93",
     "@tiledesk/tiledesk-whatsapp-connector": "^0.1.51",
     "amqplib": "^0.5.5",
     "app-root-path": "^3.0.0",

package/routes/kbsettings.js

@@ -0,0 +1,128 @@
+var express = require('express');
+var KBSettings = require('../models/kb_setting');
+// var KB = require('../models/kb_setting')
+var router = express.Router();
+var winston = require('../config/winston');
+
+router.get('/', async (req, res) => {
+    let project_id = req.projectid;
+
+    KBSettings.findOne({ id_project: project_id }, (err, kb_setting) => {
+        if (err) {
+            winston.error("find knoledge base settings error: ", err);
+            return res.status(500).send({ success: false, error: err });
+        } 
+        else if (!kb_setting) {
+            // Automatically creates the kb settings object if it does not exist
+            let new_settings = new KBSettings({
+                id_project: req.projectid
+            })
+            new_settings.save(function (err, savedKbSettings) {
+                if (err) {
+                    winston.error("save new kbs error: ", err);
+                    return res.status(500).send({ success: false, error: err});
+                } else {
+                    return res.status(200).send(savedKbSettings);
+                }
+            })
+        }
+        else {
+            return res.status(200).send(kb_setting)
+        }
+    })
+})
+
+
+// Never used?
+router.post('/', async (req, res) => {
+
+    let body = req.body;
+
+    let new_settings = new KBSettings({
+        id_project: req.projectid,
+        // gptkey: body.gptkey
+        // others params are set with default values
+    })
+
+    new_settings.save(function (err, savedKbSettings) {
+        if (err) {
+            winston.error("save new kbs error: ", err);
+            return res.status(500).send({ success: false, error: err});
+        } else {
+            return res.status(200).send(savedKbSettings);
+        }
+    })
+})
+
+router.post('/:settings_id', async (req, res) => {
+
+    let settings_id = req.params.settings_id;
+    let body = req.body;
+
+    KBSettings.findById(settings_id, (err, settings) => {
+        if (err) {
+            winston.error("find knoledge base error: ", err);
+            return res.status(500).send({ success: false, error: err});
+        } else {
+
+            let new_kb = {
+                name: body.name,
+                url: body.url
+            }
+            settings.kbs.push(new_kb);
+
+            KBSettings.findByIdAndUpdate( settings_id, settings, { new: true }, (err, savedSettings) => {
+                if (err) {
+                    winston.err("findByIdAndUpdate error: ", err);
+                    res.status(500).send({ success: false, error: err });
+                } else {
+                    res.status(200).send(savedSettings);
+                }
+            })
+        }
+    })
+})
+
+router.put('/:settings_id', async (req, res) => {
+
+    let settings_id = req.params.settings_id;
+    let update = {};
+
+    if (req.body.gptkey != undefined) {
+        update.gptkey = req.body.gptkey
+    }
+    // check if it is eligible
+    // if (req.body.maxKbsNumber != undefined) {
+    //     update.maxKbsNumber = req.body.maxKbsNumber
+    // }
+    // if (req.body.maxPagesNumber != undefined) {
+    //     update.maxPagesNumber = req.body.maxPagesNumber
+    // }
+
+    winston.debug("update: ", update);
+    KBSettings.findByIdAndUpdate(settings_id, update, { new: true }, (err, settings) => {
+        if (err) {
+            winston.error("findByIdAndUpdate error: ", err);
+            res.status(500).send({ success: false, error: err });
+        } else {
+            res.status(200).send(settings);
+        }
+    })
+})
+
+router.delete('/:settings_id/:kb_id', async (req, res) => {
+    
+    let settings_id = req.params.settings_id;
+    let kb_id = req.params.kb_id;
+
+    KBSettings.findByIdAndUpdate(settings_id, { $pull: { kbs: { _id: kb_id }}}, { new: true}, (err, settings) => {
+        if (err) {
+            winston.error("delete kb from list error: ", err);
+            res.status(500).send({ success: false, error: err });
+        } else {
+            res.status(200).send(settings);
+        }
+    })
+})
+
+module.exports = router;

package/test/kbsettingsRoute.js

@@ -0,0 +1,253 @@
+//During the test the env variable is set to test
+process.env.NODE_ENV = 'test';
+
+var userService = require('../services/userService');
+var projectService = require('../services/projectService');
+
+let log = false;
+
+//Require the dev-dependencies
+let chai = require('chai');
+let chaiHttp = require('chai-http');
+let server = require('../app');
+let should = chai.should();
+var fs = require('fs');
+const path = require('path');
+
+// chai.config.includeStack = true;
+
+var expect = chai.expect;
+var assert = chai.assert;
+
+chai.use(chaiHttp);
+
+describe('KbSettingsRoute', () => {
+
+    describe('/create', () => {
+
+        it('create kb settings', (done) => {
+
+            var email = "test-signup-" + Date.now() + "@email.com";
+            var pwd = "pwd";
+
+            userService.signup(email, pwd, "Test Firstname", "Test lastname").then(function (savedUser) {
+                projectService.create("test-faqkb-create", savedUser._id).then(function (savedProject) {
+
+                    chai.request(server)
+                        .post('/' + savedProject._id + '/kbsettings')
+                        .auth(email, pwd)
+                        .send({}) // can be empty
+                        .end((err, res) => {
+                            if (log) { console.log("create kbsettings res.body: ", res.body); }
+                            res.should.have.status(200);
+                            res.body.should.be.a('object');
+                            expect(res.body.id_project).to.equal(savedProject._id.toString());
+
+                            chai.request(server)
+                                .get('/' + savedProject._id + "/kbsettings")
+                                .auth(email, pwd)
+                                .end((err, res) => {
+                                    if (log) { console.log("get kbsettings res.body: ", res.body); }
+                                    res.should.have.status(200);
+                                    res.body.should.be.a('object');
+                                    expect(res.body.id_project).to.equal(savedProject._id.toString())
+                                    expect(res.body.maxKbsNumber).to.equal(3);
+                                    expect(res.body.maxPagesNumber).to.equal(1000);
+                                    expect(res.body.kbs).is.an('array').that.is.empty;
+
+                                    done();
+                                })
+
+                        })
+
+                });
+            });
+
+        });
+
+        it('create kb settings if not exists', (done) => {
+
+            var email = "test-signup-" + Date.now() + "@email.com";
+            var pwd = "pwd";
+
+            userService.signup(email, pwd, "Test Firstname", "Test lastname").then(function (savedUser) {
+                projectService.create("test-faqkb-create", savedUser._id).then(function (savedProject) {
+
+                    chai.request(server)
+                        .get('/' + savedProject._id + "/kbsettings")
+                        .auth(email, pwd)
+                        .end((err, res) => {
+                            if (log) { console.log("get kbsettings res.body: ", res.body); }
+                            res.should.have.status(200);
+                            res.body.should.be.a('object');
+                            expect(res.body.id_project).to.equal(savedProject._id.toString())
+                            expect(res.body.maxKbsNumber).to.equal(3);
+                            expect(res.body.maxPagesNumber).to.equal(1000);
+                            expect(res.body.kbs).is.an('array').that.is.empty;
+
+                            done();
+                        })
+                });
+            });
+
+        });
+
+
+        it('add kb to kb settings', (done) => {
+
+            var email = "test-signup-" + Date.now() + "@email.com";
+            var pwd = "pwd";
+
+            userService.signup(email, pwd, "Test Firstname", "Test lastname").then(function (savedUser) {
+                projectService.create("test-faqkb-create", savedUser._id).then(function (savedProject) {
+
+                    chai.request(server)
+                        .post('/' + savedProject._id + '/kbsettings')
+                        .auth(email, pwd)
+                        .send({}) // can be empty
+                        .end((err, res) => {
+                            if (log) { console.log("create kbsettings res.body: ", res.body); }
+                            res.should.have.status(200);
+                            res.body.should.be.a('object');
+                            expect(res.body.id_project).to.equal(savedProject._id.toString());
+
+                            chai.request(server)
+                                .post('/' + savedProject._id + "/kbsettings/" + res.body._id)
+                                .auth(email, pwd)
+                                .send({ name: "exampleurl.com/kb/", url: "https://exampleurl.com/kb/" })
+                                .end((err, res) => {
+                                    if (log) { console.log("add kb to kb settings res.body: ", res.body); }
+                                    res.should.have.status(200);
+                                    res.body.should.be.a('object');
+                                    expect(res.body.kbs).to.have.length(1)
+
+                                    chai.request(server)
+                                        .post('/' + savedProject._id + "/kbsettings/" + res.body._id)
+                                        .auth(email, pwd)
+                                        .send({ name: "secondurl.com/support/", url: "https://secondurl.com/support/" })
+                                        .end((err, res) => {
+                                            if (log) { console.log("add kb to kb settings res.body: ", res.body); }
+                                            res.should.have.status(200);
+                                            res.body.should.be.a('object');
+                                            expect(res.body.kbs).to.have.length(2)
+
+                                            done();
+                                        })
+
+                                })
+                        })
+
+                });
+            });
+
+        });
+
+        it('update kb settings', (done) => {
+
+            var email = "test-signup-" + Date.now() + "@email.com";
+            var pwd = "pwd";
+
+            userService.signup(email, pwd, "Test Firstname", "Test lastname").then(function (savedUser) {
+                projectService.create("test-faqkb-create", savedUser._id).then(function (savedProject) {
+
+                    chai.request(server)
+                        .post('/' + savedProject._id + '/kbsettings')
+                        .auth(email, pwd)
+                        .send({}) // can be empty
+                        .end((err, res) => {
+                            if (log) { console.log("create kbsettings res.body: ", res.body); }
+                            res.should.have.status(200);
+                            res.body.should.be.a('object');
+
+                            chai.request(server)
+                                .put('/' + savedProject._id + "/kbsettings/" + res.body._id)
+                                .auth(email, pwd)
+                                .send({ gptkey: "sk-12345678" })
+                                .end((err, res) => {
+                                    if (log) { console.log("add kb to kb settings res.body: ", res.body); }
+                                    res.should.have.status(200);
+                                    res.body.should.be.a('object');
+
+                                    done();
+
+                                })
+                        })
+
+                });
+            });
+
+        });
+
+        it('delete kb from list', (done) => {
+
+            var email = "test-signup-" + Date.now() + "@email.com";
+            var pwd = "pwd";
+
+            userService.signup(email, pwd, "Test Firstname", "Test lastname").then(function (savedUser) {
+                projectService.create("test-faqkb-create", savedUser._id).then(function (savedProject) {
+
+                    chai.request(server)
+                        .post('/' + savedProject._id + '/kbsettings')
+                        .auth(email, pwd)
+                        .send({}) // can be empty
+                        .end((err, res) => {
+                            if (log) { console.log("create kbsettings res.body: ", res.body); }
+                            res.should.have.status(200);
+                            res.body.should.be.a('object');
+                            expect(res.body.id_project).to.equal(savedProject._id.toString());
+
+                            let settings_id = res.body._id;
+
+                            chai.request(server)
+                                .post('/' + savedProject._id + "/kbsettings/" + settings_id)
+                                .auth(email, pwd)
+                                .send({ name: "exampleurl.com/kb/", url: "https://exampleurl.com/kb/" })
+                                .end((err, res) => {
+                                    if (log) { console.log("add kb to kb settings res.body: ", res.body); }
+                                    res.should.have.status(200);
+                                    res.body.should.be.a('object');
+                                    expect(res.body.kbs).to.have.length(1)
+
+                                    let kb_to_delete_id = res.body.kbs[0]._id;
+
+                                    chai.request(server)
+                                        .post('/' + savedProject._id + "/kbsettings/" + settings_id)
+                                        .auth(email, pwd)
+                                        .send({ name: "secondurl.com/support/", url: "https://secondurl.com/support/" })
+                                        .end((err, res) => {
+                                            if (log) { console.log("add kb to kb settings res.body: ", res.body); }
+                                            res.should.have.status(200);
+                                            res.body.should.be.a('object');
+                                            expect(res.body.kbs).to.have.length(2)
+
+                                            chai.request(server)
+                                                .delete('/' + savedProject._id + "/kbsettings/" + settings_id + "/" + kb_to_delete_id)
+                                                .auth(email, pwd)
+                                                .end((err, res) => {
+                                                    if (log) { console.log("delete kb res.body: ", res.body); };
+                                                    res.should.have.status(200);
+                                                    res.body.should.be.a('object');
+                                                    expect(res.body.kbs).to.have.length(1)
+                                                    expect(res.body.kbs[0].name).to.equal("secondurl.com/support/");
+                                                    expect(res.body.kbs[0].url).to.equal("https://secondurl.com/support/");
+
+                                                    done();
+                                                })
+                                        })
+
+                                })
+                        })
+                });
+            });
+
+        });
+
+
+
+
+
+    });
+
+});
+
+