@tiledesk/tiledesk-tybot-connector 0.1.62 → 0.1.64

package/CHANGELOG.md

@@ -5,6 +5,23 @@
 available on:
  ▶️ https://www.npmjs.com/package/@tiledesk/tiledesk-tybot-connector
 
+### 0.1.64 - online
+- Added logs for bug wa-wh test
+
+### 0.1.63 - online
+- Added stopOnConditionMet to DirIfOnlineAgents
+- Removed deprecated Directive Directives.WHEN_OFFLINE_HOURS
+- Removed deprecated Directive Directives.DISABLE_INPUT_TEXT
+- Removed deprecated Directive Directives.WHEN_OPEN
+- Removed deprecated Directive Directives.WHEN_CLOSED
+- Removed deprecated Directive Directives.IF_AGENTS
+- Removed deprecated Directive Directives.IF_NO_AGENTS
+- Added support for intent parameters in DirJSONCondition DirIfOnlineAgents DirIfOpeningHours
+- Added JSONCondition with intent parameters test
+
+### 0.1.63 - online
+- Added support for depId-from-supportRequest in DirMoveToAgent. This fixes no-handoff in test-it-out and from Dialogflow connector
+
 ### 0.1.62
 - Added TiledeskChatbotUtil.fillCommandAttachments() replacing vars in commands.button.link
 

package/index.js

@@ -390,7 +390,11 @@ router.post('/ext/:projectId/requests/:requestId/messages', async (req, res) =>
       id_project: projectId
     }
   }
-  // if (log) {console.log("request....", JSON.stringify(request));}
+  if (log) {
+    console.log("/ext request....", JSON.stringify(request));
+    console.log("/ext APIURL....", APIURL);
+    console.log("/ext process.env.TYBOT_ENDPOINT....", process.env.TYBOT_ENDPOINT);
+  }
   let directivesPlug = new DirectivesChatbotPlug({supportRequest: request, TILEDESK_API_ENDPOINT: APIURL, TILEBOT_ENDPOINT:process.env.TYBOT_ENDPOINT, token: token, log: log, HELP_CENTER_API_ENDPOINT: process.env.HELP_CENTER_API_ENDPOINT, cache: tdcache});
   // PIPELINE-EXT
   // if (log) {console.log("answer to process:", JSON.stringify(answer));}

package/models/MockBotsDataSource.js

@@ -64,7 +64,16 @@ class MockBotsDataSource {
       faq = await this.getByIntentDisplayName(botId, key);
       // console.log("faq found in datasource..:", JSON.stringify(faq));
     }
-    return faq;
+    // clones the faq to avoid modifying original object
+    // console.log("faq is:", faq)
+    let json_faq;
+    if (faq !== null && faq !== undefined) {
+      let string_faq = JSON.stringify(faq)
+      // console.log("string faq is:", string_faq)
+      json_faq = JSON.parse(string_faq);
+      // console.log("json faq is:", json_faq)
+    }
+    return json_faq;
   }
 
   /**

package/models/MongodbBotsDataSource.js

@@ -85,31 +85,34 @@ class MongodbBotsDataSource {
    * @returns a single Intent
    */
   async getByIntentDisplayName(botId, key) {
+    if (this.log) {console.log("Quering intent by botId:", botId, "key:", key );}
     return new Promise((resolve, reject) => {
       // var query = { "id_project": this.projectId, "id_faq_kb": botId, "intent_display_name": name};
       let query = null;
       key = key.trim();
       if (key.startsWith("#")) {
         let intent_id = key.substring(key.indexOf("#") + 1);
-        // console.log("Query by intent_id:", intent_id );
+        if (this.log) {console.log("Query by intent_id:", intent_id );}
         query = { "id_faq_kb": botId, "intent_id": intent_id };
       }
       else {
-        // console.log("Query by intent name:", key );
+        if (this.log) {console.log("Query by intent name:", key);}
         query = { "id_faq_kb": botId, "intent_display_name": key };
-      }
-      
+      }      
       if (this.log) {console.debug('query', query);}
       Faq.find(query).lean().exec( (err, faqs) => {
         if (err) {
+          console.error("error getting faqs", err);
           return reject(err);
         }
         if (this.log) {console.debug("getByIntentDisplayName faqs", JSON.stringify(faqs));}
         if (faqs && faqs.length > 0) {
           const intent = faqs[0];
+          if (this.log) {console.debug("intent found:", JSON.stringify(intent));}
           return resolve(intent);
         }
         else {
+          if (this.log) {console.debug("No intent found");}
           return resolve(null);
         }
       });

package/models/TiledeskChatbot.js

@@ -580,7 +580,7 @@ class TiledeskChatbot {
     if (static_bot_answer.attributes && static_bot_answer.attributes.webhook && static_bot_answer.attributes.webhook === true) {
       const variables = await this.allParameters();
       context.variables = variables;
-      if (this.log) {console.log("adding variables to webhook context:", context.variables);}
+      if (this.log) {console.log("adding variables to webhook context:", JSON.stringify(context.variables));}
     }
     const messagePipeline = new MessagePipeline(static_bot_answer, context);
     const webhookurl = bot.webhook_url;
@@ -625,7 +625,7 @@ class TiledeskChatbot {
     });
     // const parameters_key = "tilebot:requests:" + requestId + ":parameters";
     const all_parameters = await this.allParameters();//this.tdcache.hgetall(parameters_key);
-    if (this.log) {console.log("(populatePrechatFormAndLead) parameters_key:", all_parameters);}
+    if (this.log) {console.log("(populatePrechatFormAndLead) parameters_key:", JSON.stringify(all_parameters));}
     if (all_parameters) {
       if (this.log) {console.log("(populatePrechatFormAndLead) userEmail:", all_parameters['userEmail']);}
       if (this.log) {console.log("(populatePrechatFormAndLead) userFullname:", all_parameters['userFullname']);}

package/models/TiledeskChatbotUtil.js

@@ -207,6 +207,9 @@ class TiledeskChatbotUtil {
                 }
             });
         }
+        else if (log) {
+            console.log("No attachments to fill in command")
+        }
     }
 
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tiledesk/tiledesk-tybot-connector",
-  "version": "0.1.62",
+  "version": "0.1.64",
   "description": "Tiledesk Tybot connector",
   "main": "index.js",
   "scripts": {

package/test/conversation-form-test.js

@@ -138,55 +138,55 @@ describe('Conversation1 - Form filling', async () => {
     });
   });
 
-  it('/disable_input', (done) => {
-    // console.log("/disable_input...");
-    let listener;
-    let endpointServer = express();
-    endpointServer.use(bodyParser.json());
-    endpointServer.post('/:projectId/requests/:requestId/messages', function (req, res) {
-      // console.log("req.body....:", JSON.stringify(req.body));
-      res.send({ success: true });
-      const message = req.body;
+  // it('/disable_input', (done) => {
+  //   // console.log("/disable_input...");
+  //   let listener;
+  //   let endpointServer = express();
+  //   endpointServer.use(bodyParser.json());
+  //   endpointServer.post('/:projectId/requests/:requestId/messages', function (req, res) {
+  //     // console.log("req.body....:", JSON.stringify(req.body));
+  //     res.send({ success: true });
+  //     const message = req.body;
 
-      assert(message["text"] !== "");
-      assert(message["attributes"] !== "");
-      assert(message["attributes"]["disableInputMessage"] === true);
+  //     assert(message["text"] !== "");
+  //     assert(message["attributes"] !== "");
+  //     assert(message["attributes"]["disableInputMessage"] === true);
 
-      listener.close(() => {
-        // console.log('closed.');
-        done();
-      });
+  //     listener.close(() => {
+  //       // console.log('closed.');
+  //       done();
+  //     });
 
-    });
+  //   });
 
-    listener = endpointServer.listen(10002, '0.0.0.0', function () {
-      // console.log('endpointServer started', listener.address());
-      // const botId = process.env.TEST_BOT_ID;
-      // const PROJECT_ID = process.env.TEST_PROJECT_ID;
-      // console.log("botId:", botId);
-      // console.log("REQUEST_ID:", REQUEST_ID);
-      let request = {
-        "payload": {
-          "_id": uuidv4(),
-          "senderFullname": "guest#367e",
-          "type": "text",
-          "sender": "A-SENDER",
-          "recipient": REQUEST_ID,
-          "text": "/disable_input",
-          "id_project": PROJECT_ID,
-          "metadata": "",
-          "request": {
-            "request_id": REQUEST_ID,
-            "id_project": PROJECT_ID
-          }
-        },
-        "token": CHATBOT_TOKEN
-      }
-      sendMessageToBot(request, BOT_ID, CHATBOT_TOKEN, () => {
-        // console.log("Message sent.");
-      });
-    });
-  });
+  //   listener = endpointServer.listen(10002, '0.0.0.0', function () {
+  //     // console.log('endpointServer started', listener.address());
+  //     // const botId = process.env.TEST_BOT_ID;
+  //     // const PROJECT_ID = process.env.TEST_PROJECT_ID;
+  //     // console.log("botId:", botId);
+  //     // console.log("REQUEST_ID:", REQUEST_ID);
+  //     let request = {
+  //       "payload": {
+  //         "_id": uuidv4(),
+  //         "senderFullname": "guest#367e",
+  //         "type": "text",
+  //         "sender": "A-SENDER",
+  //         "recipient": REQUEST_ID,
+  //         "text": "/disable_input",
+  //         "id_project": PROJECT_ID,
+  //         "metadata": "",
+  //         "request": {
+  //           "request_id": REQUEST_ID,
+  //           "id_project": PROJECT_ID
+  //         }
+  //       },
+  //       "token": CHATBOT_TOKEN
+  //     }
+  //     sendMessageToBot(request, BOT_ID, CHATBOT_TOKEN, () => {
+  //       // console.log("Message sent.");
+  //     });
+  //   });
+  // });
 
   it('/good_form', (done) => {
     // console.log("/good_form...");

package/test/json_condition-actions_bot.js

@@ -213,8 +213,7 @@ const bot = {
 		"actions": [{
 			"_tdActionTitle": null,
 			"_tdActionType": "jsoncondition",
-			"jsonCondition": {
-				"groups": [{
+			"groups": [{
 					"type": "expression",
 					"conditions": [{
 						"type": "condition",
@@ -226,15 +225,13 @@ const bot = {
 							"name": ""
 						}
 					}]
-				}]
-			},
+			}],
 			"stopOnConditionMet": true,
 			"trueIntent": "#d19b1b7a-7146-481d-a7d5-6b9cce8fcb50"
 		}, {
 			"_tdActionTitle": null,
 			"_tdActionType": "jsoncondition",
-			"jsonCondition": {
-				"groups": [{
+			"groups": [{
 					"type": "expression",
 					"conditions": [{
 						"type": "condition",
@@ -246,15 +243,13 @@ const bot = {
 							"name": ""
 						}
 					}]
-				}]
-			},
+			}],
 			"stopOnConditionMet": true,
 			"trueIntent": "#16240c0b-9618-40cd-87e7-6319e5c3e392"
 		}, {
 			"_tdActionTitle": null,
 			"_tdActionType": "jsoncondition",
-			"jsonCondition": {
-				"groups": [{
+			"groups": [{
 					"type": "expression",
 					"conditions": [{
 						"type": "condition",
@@ -278,8 +273,8 @@ const bot = {
 							"name": ""
 						}
 					}]
-				}]
-			},
+			}],
+			
 			"stopOnConditionMet": false,
 			"trueIntent": "#98dd1994-83ef-4863-8179-07c48d2194b9"
 		}],

package/test/json_condition-conversation_test.js

@@ -59,7 +59,7 @@ describe('Conversation for JSONCondition test', async () => {
     let endpointServer = express();
     endpointServer.use(bodyParser.json());
     endpointServer.post('/:projectId/requests/:requestId/messages', function (req, res) {
-      // console.log("...req.body:", JSON.stringify(req.body));
+      console.log("...req.body:", JSON.stringify(req.body));
       res.send({ success: true });
       const message = req.body;
       assert(message.attributes.commands !== null);

package/test/json_condition-with-intent-params-conversation_test.js

@@ -0,0 +1,282 @@
+var assert = require('assert');
+let axios = require('axios');
+const tybot = require("../");
+const tybotRoute = tybot.router;
+var express = require('express');
+var app = express();
+app.use("/", tybotRoute);
+app.use((err, req, res, next) => {
+  console.error("General error", err);
+});
+require('dotenv').config();
+const bodyParser = require('body-parser');
+const { v4: uuidv4 } = require('uuid');
+const bots_data = require('./json_condition-with-intent-params_bot.js').bots_data;
+
+const PROJECT_ID = "projectID"; //process.env.TEST_ACTIONS_PROJECT_ID;
+const REQUEST_ID = "support-group-" + PROJECT_ID + "-" + uuidv4().replace(/-/g, "");
+const BOT_ID = "botID"; //process.env.TEST_ACTIONS_BOT_ID;
+const CHATBOT_TOKEN = "XXX"; //process.env.ACTIONS_CHATBOT_TOKEN;
+
+describe('Conversation for JSONCondition with intent params test', async () => {
+
+  let app_listener;
+
+  before(() => {
+    return new Promise(async (resolve, reject) => {
+      console.log("Starting tilebot server...");
+      tybot.startApp(
+        {
+          // MONGODB_URI: process.env.mongoUrl,
+          bots: bots_data,
+          API_ENDPOINT: process.env.API_ENDPOINT,
+          REDIS_HOST: process.env.REDIS_HOST,
+          REDIS_PORT: process.env.REDIS_PORT,
+          REDIS_PASSWORD: process.env.REDIS_PASSWORD,
+          log: process.env.API_LOG
+        }, () => {
+          console.log("Tilebot route successfully started.");
+          var port = process.env.PORT || 10001;
+          app_listener = app.listen(port, () => {
+            console.log('Tilebot connector listening on port ', port);
+            resolve();
+          });
+        });
+    })
+  });
+
+  after(function (done) {
+    app_listener.close(() => {
+      // console.log('ACTIONS app_listener closed.');
+      done();
+    });
+  });
+
+  it('/condition with params{"star_type":"supernova"}', (done) => {
+    console.log('/condition with params{"star_type":"supernova"}');
+    // let message_id = uuidv4();
+    let listener;
+    let endpointServer = express();
+    endpointServer.use(bodyParser.json());
+    endpointServer.post('/:projectId/requests/:requestId/messages', function (req, res) {
+      console.log("...req.body:", JSON.stringify(req.body));
+      res.send({ success: true });
+      const message = req.body;
+      assert(message.attributes.commands !== null);
+      assert(message.attributes.commands.length === 2);
+      const command2 = message.attributes.commands[1];
+    
+      assert(command2.type === "message");
+      assert(command2.message.text === "My name is supernova and I'm 2B km large");
+      getChatbotParameters(REQUEST_ID, (err, params) => {
+        if (err) {
+          assert.ok(false);
+        }
+        else {
+          assert(params);
+        //   assert(params["last_message_id"] === message_id);
+          assert(params["project_id"] === PROJECT_ID);
+          assert(params["star_type"] === "supernova");
+          assert(params["my_name"] === "supernova");
+          assert(params["size"] === "2B");
+          listener.close(() => {
+            done();
+          });
+        }
+      });
+
+    });
+
+    listener = endpointServer.listen(10002, '0.0.0.0', () => {
+      // console.log('endpointServer started', listener.address());
+      let request = {
+        "payload": {
+        //   "_id": message_id,
+          "senderFullname": "guest#367e",
+          "type": "text",
+          "sender": "A-SENDER",
+          "recipient": REQUEST_ID,
+          "text": '/condition with params{"star_type":"supernova"}',
+          "id_project": PROJECT_ID,
+          "metadata": "",
+          "request": {
+            "request_id": REQUEST_ID
+          }
+        },
+        "token": CHATBOT_TOKEN
+      }
+      sendMessageToBot(request, BOT_ID, () => {
+        // console.log("Message sent:\n", request);
+      });
+    });
+  });
+
+  it('/condition with params{"star_type":"nebula"}', (done) => {
+    console.log('/condition with params{"star_type":"nebula"}');
+    // let message_id = uuidv4();
+    let listener;
+    let endpointServer = express();
+    endpointServer.use(bodyParser.json());
+    endpointServer.post('/:projectId/requests/:requestId/messages', function (req, res) {
+      console.log("...req.body:", JSON.stringify(req.body));
+      res.send({ success: true });
+      const message = req.body;
+      assert(message.attributes.commands !== null);
+      assert(message.attributes.commands.length === 2);
+      const command2 = message.attributes.commands[1];
+    
+      assert(command2.type === "message");
+      assert(command2.message.text === "My name is nebula and I'm 500k km large");
+      getChatbotParameters(REQUEST_ID, (err, params) => {
+        if (err) {
+          assert.ok(false);
+        }
+        else {
+          console.log("params:", params)
+          assert(params);
+        //   assert(params["last_message_id"] === message_id);
+          assert(params["project_id"] === PROJECT_ID);
+          assert(params["star_type"] === "nebula");
+          assert(params["my_name"] === "nebula");
+          assert(params["size"] === "500k");
+          listener.close(() => {
+            done();
+          });
+        }
+      });
+
+    });
+
+    listener = endpointServer.listen(10002, '0.0.0.0', () => {
+      // console.log('endpointServer started', listener.address());
+      let request = {
+        "payload": {
+        //   "_id": message_id,
+          "senderFullname": "guest#367e",
+          "type": "text",
+          "sender": "A-SENDER",
+          "recipient": REQUEST_ID,
+          "text": '/condition with params{"star_type":"nebula"}',
+          "id_project": PROJECT_ID,
+          "metadata": "",
+          "request": {
+            "request_id": REQUEST_ID
+          }
+        },
+        "token": CHATBOT_TOKEN
+      }
+      sendMessageToBot(request, BOT_ID, () => {
+        // console.log("Message sent:\n", request);
+      });
+    });
+  });
+
+});
+
+/**
+ * A stub to send message to the "ext/botId" endpoint, hosted by tilebot on:
+ * /${TILEBOT_ROUTE}/ext/${botId}
+ *
+ * @param {Object} message. The message to send
+ * @param {string} botId. Tiledesk botId
+ * @param {string} token. User token
+ */
+function sendMessageToBot(message, botId, callback) {
+  // const jwt_token = this.fixToken(token);
+  const url = `${process.env.TYBOT_ENDPOINT}/ext/${botId}`;
+  // console.log("sendMessageToBot URL", url);
+  const HTTPREQUEST = {
+    url: url,
+    headers: {
+      'Content-Type': 'application/json'
+    },
+    json: message,
+    method: 'POST'
+  };
+  myrequest(
+    HTTPREQUEST,
+    function (err, resbody) {
+      if (err) {
+        if (callback) {
+          callback(err);
+        }
+      }
+      else {
+        if (callback) {
+          callback(null, resbody);
+        }
+      }
+    }, false
+  );
+}
+
+/**
+ * A stub to get the request parameters, hosted by tilebot on:
+ * /${TILEBOT_ROUTE}/ext/parameters/requests/${requestId}?all
+ *
+ * @param {string} requestId. Tiledesk chatbot/requestId parameters
+ */
+function getChatbotParameters(requestId, callback) {
+  // const jwt_token = this.fixToken(token);
+  const url = `${process.env.TYBOT_ENDPOINT}/ext/parameters/requests/${requestId}?all`;
+  const HTTPREQUEST = {
+    url: url,
+    headers: {
+      'Content-Type': 'application/json'
+    },
+    method: 'get'
+  };
+  myrequest(
+    HTTPREQUEST,
+    function (err, resbody) {
+      if (err) {
+        if (callback) {
+          callback(err);
+        }
+      }
+      else {
+        if (callback) {
+          callback(null, resbody);
+        }
+      }
+    }, false
+  );
+}
+
+function myrequest(options, callback, log) {
+  if (log) {
+    console.log("API URL:", options.url);
+    console.log("** Options:", JSON.stringify(options));
+  }
+  axios(
+    {
+      url: options.url,
+      method: options.method,
+      data: options.json,
+      params: options.params,
+      headers: options.headers
+    })
+    .then((res) => {
+      if (log) {
+        console.log("Response for url:", options.url);
+        console.log("Response headers:\n", JSON.stringify(res.headers));
+        //console.log("******** Response for url:", res);
+      }
+      if (res && res.status == 200 && res.data) {
+        if (callback) {
+          callback(null, res.data);
+        }
+      }
+      else {
+        if (callback) {
+          callback(TiledeskClient.getErr({ message: "Response status not 200" }, options, res), null, null);
+        }
+      }
+    })
+    .catch((error) => {
+      console.error("An error occurred:", error);
+      if (callback) {
+        callback(error, null, null);
+      }
+    });
+}