@tiledesk/tiledesk-tybot-connector 0.1.21 → 0.1.23

package/models/faq_kb.js

@@ -1,7 +1,5 @@
 var mongoose = require('mongoose');
 var Schema = mongoose.Schema;
-//const uuidv4 = require('uuid/v4');
-//const uuidv4 = require('uuid');
 
 var Faq_kbSchema = new Schema({
   name: {
@@ -10,16 +8,13 @@ var Faq_kbSchema = new Schema({
     index:true
   },
   description: {
-    type: String,
-    // index:true
+    type: String
   },
   url: { 
-    type: String,
-    // required: true
+    type: String
   },
   webhook_url: {
-    type: String,
-    // required: true
+    type: String
   },
   webhook_enabled: { 
     type: Boolean,
@@ -31,18 +26,11 @@ var Faq_kbSchema = new Schema({
     required: true,
     index: true
   },
-  // kbkey_remote: { //serve?
-  //   type: String,
-  // },  
   type: {
     type: String,
     default: 'internal',
     index: true
   },
-  // external: {
-  //   type: Boolean,
-  //   default: false
-  // },
   trashed: {
     type: Boolean,
     index: true
@@ -57,7 +45,14 @@ var Faq_kbSchema = new Schema({
     type: String,
     required: false,
     default: 'en'
-    // index: true
+  },
+  public: {
+    type: Boolean,
+    index: true
+  },
+  certified: {
+    type: Boolean,
+    index: true
   },
   attributes: {
     type: Object,
@@ -71,18 +66,6 @@ var Faq_kbSchema = new Schema({
 }
 );
 
-Faq_kbSchema.virtual('fullName').get(function () {
-  // winston.debug("faq_kb fullName virtual called");
-  return (this.name);
-});
-
 var faq_kb = mongoose.model('faq_kb', Faq_kbSchema);
 
-if (process.env.MONGOOSE_SYNCINDEX) {
-  faq_kb.syncIndexes();
-  console.log("faq_kb syncIndexes");
-}
-
-
-
 module.exports = faq_kb

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tiledesk/tiledesk-tybot-connector",
-  "version": "0.1.21",
+  "version": "0.1.23",
   "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.36",
+    "@tiledesk/tiledesk-client": "^0.8.38",
     "axios": "^0.27.2",
     "body-parser": "^1.19.0",
     "cors": "^2.8.5",

package/test/close_directive_test.js

@@ -0,0 +1,49 @@
+var assert = require('assert');
+const { ExtUtil } = require('../ExtUtil');
+const { DirectivesChatbotPlug } = require('../tiledeskChatbotPlugs/DirectivesChatbotPlug');
+const { DirClose } = require('../tiledeskChatbotPlugs/directives/DirClose');
+const supportRequest = require('./support_request.js').request;
+
+describe('Directive DirClose', function() {
+
+  it('test directive DirClose', async () => {
+    class MockTdClient {
+      closeRequest(request_id, callback) {
+          callback(null, {});
+      }
+    };
+    close_directive = {
+      name: "close"
+    };
+    let dir = new DirClose({
+        tdclient: new MockTdClient()
+    });
+    dir.execute(close_directive, "A-REQUEST-ID", () => {
+    });
+  });
+
+  it('test directive DirClose in pipeline', async () => {
+    const message_text = `\\_tdclose`;
+    const answer = {
+      text: message_text,
+      attributes: {
+          splits: true,
+          directives: true,
+          markbot: true
+      }
+    }
+    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(directivesPlug.directives != null);
+    assert(directivesPlug.directives.length == 1);
+    assert(directivesPlug.directives[0].name === "close");
+  });
+    
+});
+
+
+

package/test/directives_test.js

@@ -3,37 +3,35 @@ const { ExtUtil } = require('../ExtUtil');
 const { DirectivesChatbotPlug } = require('../tiledeskChatbotPlugs/DirectivesChatbotPlug');
 const supportRequest = require('./support_request.js').request;
 
-describe('MessagePipeline', function() {
-   
-        it('test directives and splits', async () => {
-            const message_text = `message1
+describe('Directives', function() {
+  
+  it('test directives and splits', async () => {
+    const message_text = `message1
 
 message2
 * button1
 \\_tdWait`;
-            const answer = {
-                text: message_text,
-                attributes: {
-                    splits: true,
-                    directives: true,
-                    markbot: true,
-                    disableInputMessage: true,
-                    inputMessagePlaceholder: 'Compile the form before proceeding'
-                }
-            }
-            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 as obj", bot_answer);
-            console.log("bot", JSON.stringify(bot_answer));
-            assert.strictEqual(bot_answer.text, "message1\n\nmessage2");
-            assert(bot_answer.attributes.commands != null);
-            assert(bot_answer.attributes.commands.length == 3);
+    const answer = {
+      text: message_text,
+      attributes: {
+          splits: true,
+          directives: true,
+          markbot: true
+      }
+    }
+    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 as obj", bot_answer);
+    // console.log("bot", JSON.stringify(bot_answer));
+    assert.strictEqual(bot_answer.text, "message1\n\nmessage2");
+    assert(bot_answer.attributes.commands != null);
+    assert(bot_answer.attributes.commands.length == 3);
 
-            console.log("Directives:", directivesPlug.directives)
-            assert(directivesPlug.directives != null);
-            assert(directivesPlug.directives.length == 1);
-            assert(directivesPlug.directives[0].name.toLowerCase() == "wait");
-        });
+    // console.log("Directives:", directivesPlug.directives)
+    assert(directivesPlug.directives != null);
+    assert(directivesPlug.directives.length == 1);
+    assert(directivesPlug.directives[0].name.toLowerCase() == "wait");
+  });
     
 });
 

package/test/disable_input_text_directive_test.js

@@ -0,0 +1,88 @@
+var assert = require('assert');
+const { ExtUtil } = require('../ExtUtil');
+const { DirectivesChatbotPlug } = require('../tiledeskChatbotPlugs/DirectivesChatbotPlug');
+const supportRequest = require('./support_request.js').request;
+
+describe('Directive DirDisableInputText', function() {
+
+  it('test directive DisableInputText (basic)', async () => {
+    const message_text = `message1
+message2
+* button1
+\\_tddisableinputtext`;
+    const answer = {
+      text: message_text,
+      attributes: {
+          splits: true,
+          directives: true,
+          markbot: true
+      }
+    }
+    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);
+    assert.strictEqual(bot_answer.text, "message1\nmessage2");
+    assert(bot_answer.attributes.commands == null);
+    assert(bot_answer.attributes.disableInputMessage == true);
+    assert(directivesPlug.directives != null);
+    assert(directivesPlug.directives.length == 1);
+    assert(directivesPlug.directives[0].name.toLowerCase() == "disableinputtext");
+  });
+
+  it('test directive DisableInputText (placeholder message option: --label)', async () => {
+    const message_text = `message1
+message2
+* button1
+\\_tddisableinputtext --label "Press a button to reply"`;
+    const answer = {
+      text: message_text,
+      attributes: {
+          splits: true,
+          directives: true,
+          markbot: true
+      }
+    }
+    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 as obj", bot_answer);
+    // console.log("bot", JSON.stringify(bot_answer));
+    assert.strictEqual(bot_answer.text, "message1\nmessage2");
+    assert(bot_answer.attributes.commands == null);
+    assert(bot_answer.attributes.disableInputMessage == true);
+    assert(bot_answer.attributes.inputMessagePlaceholder === "Press a button to reply");
+    // console.log("Directives:", directivesPlug.directives)
+    assert(directivesPlug.directives != null);
+    assert(directivesPlug.directives.length == 1);
+    assert(directivesPlug.directives[0].name.toLowerCase() == "disableinputtext");
+  });
+
+  it('test directive DisableInputText (placeholder message, short form option: -l)', async () => {
+    const message_text = `message1
+message2
+* button1
+\\_tddisableinputtext -l "Press a button to reply"`;
+    const answer = {
+      text: message_text,
+      attributes: {
+          splits: true,
+          directives: true,
+          markbot: true
+      }
+    }
+    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 as obj", bot_answer);
+    // console.log("bot", JSON.stringify(bot_answer));
+    assert.strictEqual(bot_answer.text, "message1\nmessage2");
+    assert(bot_answer.attributes.commands == null);
+    assert(bot_answer.attributes.disableInputMessage == true);
+    assert(bot_answer.attributes.inputMessagePlaceholder === "Press a button to reply");
+    // console.log("Directives:", directivesPlug.directives)
+    assert(directivesPlug.directives != null);
+    assert(directivesPlug.directives.length == 1);
+    assert(directivesPlug.directives[0].name.toLowerCase() == "disableinputtext");
+  });
+    
+});
+
+
+

package/test/mock_query_test.js

@@ -0,0 +1,276 @@
+
+var assert = require('assert');
+const { TiledeskChatbot } = require('../models/TiledeskChatbot.js');
+const { MockBotsDataSource } = require('../models/MockBotsDataSource.js');
+const { MockIntentsMachine } = require('../models/MockIntentsMachine.js');
+
+const testBots = {
+  "bots": {
+    "bot1": {
+      "webhook_enabled": false,
+      "_id": 'bot1',
+      "name": 'test bot',
+      "id_project": 'project1',
+      "intents": {
+        "intent1": {
+          intent_display_name: "intent1",
+          questions: [
+            "intent1 question1",
+            "intent1 question2"
+          ],
+          answer: "reply to intent1"
+        },
+        "intent2": {
+          intent_display_name: "intent1",
+          questions: [
+            "intent2 question1",
+            "intent2 question2"
+          ],
+          answer: "reply to intent2"
+        },
+        "intent3": {
+          intent_display_name: "intent3",
+          questions: [
+            "intent3 question1",
+            "intent3 question2"
+          ],
+          answer: "reply to intent3"
+        }
+      },
+      "questions_intent": {
+      
+        "intent1 question1": "intent1",
+        "intent1 question2": "intent1",
+        
+        "intent2 question1": "intent2",
+        "intent2 question2": "intent2",
+      
+        "intent3 question1": "intent3",
+        "intent3 question2": "intent3"
+      },
+      "intents_nlp" : {
+        "query1": {
+          "intent_display_name": "intent1"
+        },
+        "query2": {
+          "intent_display_name": "intent2"
+        }
+      }
+    }
+  }
+}
+
+describe('Basic Tilebot', function() {
+  it('create TiledeskChatbot instance',async () => {
+    const chatbot = new TiledeskChatbot({
+      botsDataSource: {},
+      intentsFinder: {},
+      botId: "bot1",
+      bot: {},
+      token: "token",
+      APIURL: "APIURL",
+      APIKEY: "___",
+      tdcache: null,
+      requestId: "request1",
+      projectId: "project1",
+      log: false
+    });
+    assert(chatbot != null);
+  });
+
+  it('query intent-action', async () => {
+    const dataSource = new MockBotsDataSource(testBots);
+    const botId = "bot1";
+    const bot = await dataSource.getBotById(botId);
+    const chatbot = new TiledeskChatbot({
+      botsDataSource: dataSource,
+      intentsFinder: {},
+      botId: botId,
+      bot: bot,
+      token: "token",
+      APIURL: "APIURL",
+      APIKEY: "___",
+      tdcache: null,
+      requestId: "requestId",
+      projectId: "projectId",
+      log: false
+    });
+    assert(chatbot != null);
+    const message = {
+      text: "not important",
+      attributes: {
+          action: "intent1"
+      },
+      request: {
+          request_id: "requestId"
+      }
+    }
+    const reply = await chatbot.replyToMessage(message);
+    assert(reply);
+    assert(reply.text === testBots.bots[botId].intents.intent1.answer);
+  });
+
+  it('query exact match', async () => {
+    const dataSource = new MockBotsDataSource(testBots);
+    const botId = "bot1";
+    const bot = await dataSource.getBotById(botId);
+    const chatbot = new TiledeskChatbot({
+      botsDataSource: dataSource,
+      intentsFinder: {},
+      botId: botId,
+      bot: bot,
+      token: "token",
+      APIURL: "APIURL",
+      APIKEY: "___",
+      tdcache: null,
+      requestId: "requestId",
+      projectId: "projectId",
+      log: false
+    });
+    assert(chatbot != null);
+    const message = {
+      text: "intent1 question1",
+      request: {
+          request_id: "requestId"
+      }
+    }
+    const reply = await chatbot.replyToMessage(message);
+    assert(reply);
+    assert(reply.text === testBots.bots[botId].intents.intent1.answer);
+    assert(reply.attributes.intent_info.intent_name === testBots.bots[botId].intents.intent1.intent_display_name);
+  });
+
+  it('query with /intent_name query syntax', async () => {
+    const dataSource = new MockBotsDataSource(testBots);
+    const botId = "bot1";
+    const bot = await dataSource.getBotById(botId);
+    const chatbot = new TiledeskChatbot({
+      botsDataSource: dataSource,
+      intentsFinder: {},
+      botId: botId,
+      bot: bot,
+      token: "token",
+      APIURL: "APIURL",
+      APIKEY: "___",
+      tdcache: null,
+      requestId: "requestId",
+      projectId: "projectId",
+      log: false
+    });
+    assert(chatbot != null);
+    const message = {
+      text: "/intent1",
+      request: {
+          request_id: "requestId"
+      }
+    }
+    const reply = await chatbot.replyToMessage(message);
+    assert(reply);
+    assert(reply.text === testBots.bots[botId].intents.intent1.answer);
+    assert(reply.attributes.intent_info.intent_name === testBots.bots[botId].intents.intent1.intent_display_name);
+  });
+
+  it('query NLP', async () => {
+    const dataSource = new MockBotsDataSource(testBots);
+    const intentsMachine = new MockIntentsMachine(testBots);
+    const botId = "bot1";
+    const bot = await dataSource.getBotById(botId);
+    const chatbot = new TiledeskChatbot({
+      botsDataSource: dataSource,
+      intentsFinder: intentsMachine,
+      botId: botId,
+      bot: bot,
+      token: "token",
+      APIURL: "APIURL",
+      APIKEY: "___",
+      tdcache: null,
+      requestId: "requestId",
+      projectId: "projectId",
+      log: false
+    });
+    assert(chatbot != null);
+    const message = {
+      text: "query1",
+      request: {
+          request_id: "requestId"
+      }
+    }
+    const reply = await chatbot.replyToMessage(message);
+    assert(reply);
+    assert(reply.text === testBots.bots[botId].intents.intent1.answer);
+    assert(reply.attributes.intent_info.intent_name === testBots.bots[botId].intents.intent1.intent_display_name);
+  });
+
+  it('query with defaultFallback', async () => {
+    // clone and add defaultFallback
+    let testIntents_with_defaultFallback = JSON.parse(JSON.stringify(testBots));
+    // This doesn't work. Objects are copied by reference. Only first level properties are cloned.
+    //let testIntentsDataSource_with_defaultFallback = Object.assign({}, testIntentsDataSource);
+    // added defaultFallback intent
+    const botId = "bot1";
+    testIntents_with_defaultFallback.bots[botId].intents["defaultFallback"] = {
+      intent_display_name: "defaultFallback",
+      questions: [],
+      answer: "reply for defaultFallback"
+    }
+    const dataSource = new MockBotsDataSource(testIntents_with_defaultFallback);
+    const bot = await dataSource.getBotById(botId);
+    const intentsMachine = new MockIntentsMachine(testBots);
+    const chatbot = new TiledeskChatbot({
+      botsDataSource: dataSource,
+      intentsFinder: intentsMachine,
+      botId: botId,
+      bot: bot,
+      token: "token",
+      APIURL: "APIURL",
+      APIKEY: "___",
+      tdcache: null,
+      requestId: "requestId",
+      projectId: "projectId",
+      log: false
+    });
+    assert(chatbot != null);
+    const message = {
+      text: "query unknown",
+      request: {
+          request_id: "requestId"
+      }
+    }
+    const reply = await chatbot.replyToMessage(message);
+    assert(reply);
+    assert(reply.text === testIntents_with_defaultFallback.bots[botId].intents["defaultFallback"].answer);
+  });
+
+  it('query with missing defaultFallback', async () => {
+    const dataSource = new MockBotsDataSource(testBots);
+    const botId = "bot1";
+    const bot = await dataSource.getBotById(botId);
+    const intentsMachine = new MockIntentsMachine(testBots);
+    const chatbot = new TiledeskChatbot({
+      botsDataSource: dataSource,
+      intentsFinder: intentsMachine,
+      botId: botId,
+      bot: bot,
+      token: "token",
+      APIURL: "APIURL",
+      APIKEY: "___",
+      tdcache: null,
+      requestId: "requestId",
+      projectId: "projectId",
+      log: false
+    });
+    assert(chatbot != null);
+    const message = {
+      text: "query unknown",
+      request: {
+          request_id: "requestId"
+      }
+    }
+    const reply = await chatbot.replyToMessage(message);
+    assert(reply == null);
+  });
+
+});
+
+
+

package/test/single_test.sh

@@ -0,0 +1,4 @@
+#npx mocha ./test/*.js --grep "_test 17_" --timeout 10000 --exit
+#npx mocha ./test/mock_query_test.js
+#npx mocha ./test/disable_input_text_directive_test.js
+npx mocha ./test/close_directive_test.js