@tiledesk/tiledesk-tybot-connector 0.1.39 → 0.1.41

package/CHANGELOG.md

@@ -5,6 +5,14 @@
 available on:
  ▶️ https://www.npmjs.com/package/@tiledesk/tiledesk-tybot-connector
 
+### 0.1.41
+- added Filler
+- added Filler to email .to .subject .text attributes
+
+### 0.1.40
+- tiledesk-client => 0.9.5
+- added _tdSendEmail directive
+
 ### 0.1.39 - online
 - ExtApi.sendSupportMessageExt => added support for rejectUnauthorized: false
 

package/models/TiledeskChatbot.js

@@ -413,9 +413,14 @@ class TiledeskChatbot {
   }
 
   static async allParametersStatic(_tdcache, requestId) {
-    const parameters_key = "tilebot:requests:" + requestId + ":parameters";
-    // console.log("allParametersStatic. Paramters key:", parameters_key);
-    return await _tdcache.hgetall(parameters_key);
+    // const parameters_key = "tilebot:requests:" + requestId + ":parameters";
+    return await _tdcache.hgetall(
+      TiledeskChatbot.requestCacheKey(requestId) + ":parameters");
+  }
+
+  static requestCacheKey(requestId) {
+    const request_key = "tilebot:requests:" + requestId;
+    return request_key;
   }
   
   async execWebhook(static_bot_answer, message, bot, context) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tiledesk/tiledesk-tybot-connector",
-  "version": "0.1.39",
+  "version": "0.1.41",
   "description": "Tiledesk Tybot connector",
   "main": "index.js",
   "scripts": {
@@ -14,17 +14,18 @@
     "@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.9.3",
+    "@tiledesk/tiledesk-client": "^0.9.5",
     "axios": "^0.27.2",
     "body-parser": "^1.19.0",
     "cors": "^2.8.5",
+    "dotenv": "^16.0.3",
     "express": "^4.17.1",
     "jsonwebtoken": "^8.5.1",
     "minimist-string": "^1.0.2",
+    "mocha": "^10.2.0",
     "mongoose": "^6.3.5",
     "nanoid": "^3.1.25",
     "redis": "^3.1.2",
-    "uuid": "^3.3.3",
-    "dotenv": "^16.0.3"
+    "uuid": "^3.3.3"
   }
 }

package/test/send_email_directive_test.js

@@ -0,0 +1,91 @@
+var assert = require('assert');
+const { ExtUtil } = require('../ExtUtil');
+const { DirectivesChatbotPlug } = require('../tiledeskChatbotPlugs/DirectivesChatbotPlug');
+const { DirSendEmail } = require('../tiledeskChatbotPlugs/directives/DirSendEmail');
+const supportRequest = require('./support_request.js').request;
+const { TiledeskChatbot } = require('../models/TiledeskChatbot');
+
+describe('Directive DirSendEmail', function() {
+
+  it('test DirSendEmail', async () => {
+    class MockTdClient {
+      async sendEmail(message, callback) {
+        if (callback) {
+          callback(null, message);
+        }
+        return message;
+      }
+    };
+    class MockTdCache {
+      async hgetall(request_parameters_key) {
+        // simulate we already saved sone request variables
+        // with a specific request id: request1
+        const request1_cache_id = TiledeskChatbot.requestCacheKey('request1') + ":parameters";
+        const variables = {}
+        variables[request1_cache_id] = {
+          "fullname": "John B.",
+          "email": "johnb@email.com"
+        }
+        return variables[request_parameters_key];
+      }
+    };
+    send_email_directive = {
+      name: "sendemail",
+      parameter: '--to "${email}" --subject "Hello ${fullname}" --text "Welcome ${fullname}"'
+    };
+    let requestId = "request1";
+    let dir = new DirSendEmail({
+        tdclient: new MockTdClient(),
+        tdcache: new MockTdCache(),
+        requestId: requestId
+    });
+    const message =  await dir.execute(send_email_directive);
+    assert(message);
+    assert(message.to === 'johnb@email.com');
+    assert(message.text === 'Welcome John B.');
+    assert(message.subject === 'Hello John B.');
+  });
+
+  it('test DirSendEmail with missing "to"', async () => {
+    class MockTdClient {
+      async sendEmail(message, callback) {
+        if (callback) {
+          callback(null, message);
+        }
+        return message;
+      }
+    };
+    send_email_directive = {
+      name: "sendemail",
+      parameter: '--subject "test" --text "_test"'
+    };
+    let dir = new DirSendEmail({
+        tdclient: new MockTdClient()
+    });
+    const message =  await dir.execute(send_email_directive)
+    assert(message == null);
+  });
+
+  it('test DirSendEmail in pipeline', async () => {
+    const message_text = `\\_tdsendemail --to "test@test" --subject "_sub" --text "_body"`;
+    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(bot_answer == null);
+    assert(directivesPlug.directives != null);
+    assert(directivesPlug.directives.length == 1);
+    assert(directivesPlug.directives[0].name === "sendemail");
+    assert(directivesPlug.directives[0].parameter === '--to "test@test" --subject "_sub" --text "_body"');
+  });
+    
+});
+
+
+

package/test/single_test.sh

@@ -2,5 +2,6 @@
 #npx mocha ./test/mock_query_test.js
 #npx mocha ./test/disable_input_text_directive_test.js
 #npx mocha ./test/close_directive_test.js
-npx mocha ./test/conversation1-test.js --exit
+#npx mocha ./test/conversation1-test.js --exit
 #npx mocha ./test/intent_form_test.js --exit
+npx mocha ./test/send_email_directive_test.js --exit

package/tiledeskChatbotPlugs/DirectivesChatbotPlug.js

@@ -15,6 +15,7 @@ const { DirDisableInputText } = require('./directives/DirDisableInputText');
 const { DirClose } = require('./directives/DirClose');
 const { DirIfAvailableAgents } = require('./directives/DirIfAvailableAgents');
 const { DirFireTiledeskEvent } = require('./directives/DirFireTiledeskEvent');
+const { DirSendEmail } = require('./directives/DirSendEmail');
 const { Directives } = require('./directives/Directives');
 
 class DirectivesChatbotPlug {
@@ -267,6 +268,16 @@ class DirectivesChatbotPlug {
           process(nextDirective());
         });
       }
+      else if (directive_name === Directives.SEND_EMAIL) {
+        new DirSendEmail(
+          {
+            tdclient: tdclient,
+            tdcache: tdcache,
+            requestId: requestId
+          }).execute(directive, () => {
+            process(nextDirective());
+        });
+      }
       else {
         //console.log("Unhandled Post-message Directive:", directive_name);
         process(nextDirective());

package/tiledeskChatbotPlugs/Filler.js

@@ -0,0 +1,14 @@
+class Filler {
+
+  fill(text, parameters) {
+    if (parameters) {
+      for (const [key, value] of Object.entries(parameters)) {
+        text = text.replace(new RegExp("(\\$\\{" + key + "\\})", 'i'), parameters[key]);
+      }
+    }
+    return text;
+  }
+  
+}
+
+module.exports = { Filler };

package/tiledeskChatbotPlugs/directives/DirSendEmail.js

@@ -0,0 +1,87 @@
+const { HelpCenterQuery } = require('@tiledesk/helpcenter-query-client');
+const { param } = require('express/lib/request');
+const ms = require('minimist-string');
+const { TiledeskChatbot } = require('../../models/TiledeskChatbot');
+const { Filler } = require('../Filler');
+
+class DirSendEmail {
+
+  constructor(config) {
+    if (!config.tdclient) {
+      throw new Error('config.tdclient (TiledeskClient) is mandatory.');
+    }
+    this.tdclient = config.tdclient;
+    this.tdcache = config.tdcache;
+    this.requestId = config.requestId;
+    this.log = config.log;
+  }
+
+  async execute(directive, completion) {
+      let params = null;
+      if (directive.parameter) {
+        params = this.parseParams(directive.parameter);
+      }
+      else {
+        const error = new Error("sendEmail missing 'parameter' error. Skipping");
+        if (completion) {
+          completion(error);
+        }
+      }
+      if (params.subject && params.text && params.to) {
+        try {
+          let requestVariables = null;
+          if (this.tdcache) {
+            requestVariables = 
+            await TiledeskChatbot.allParametersStatic(
+              this.tdcache, this.requestId
+            );
+          }
+          const filler = new Filler();
+          const message_echo = await this.tdclient.sendEmail({
+            subject: filler.fill(params.subject, requestVariables),
+            text: filler.fill(params.text, requestVariables),
+            to: filler.fill(params.to, requestVariables)
+          });
+          if (completion) {
+            completion(null, message_echo);
+          }
+          return message_echo;
+        }
+        catch(err) {
+          console.error("sendEmail error:", err);
+          if (completion) {
+            completion(err);
+          }
+        }
+      }
+      else {
+        const error = new Error("sendEmail missing mandatory parameters (to|subject|text)");
+        if (completion) {
+          completion(error);
+        }
+      }
+  }
+
+  parseParams(directive_parameter) {
+    let subject = null;
+    let text = null;
+    let to = null
+    const params = ms(directive_parameter);
+    if (params.subject) {
+      subject = params.subject
+    }
+    if (params.text) {
+      text = params.text.replace(/\\n/g, "\n");
+    }    
+    if (params.to) {
+      to = params.to;
+    }
+    return {
+      subject: subject,
+      to: to,
+      text: text
+    }
+  }
+}
+
+module.exports = { DirSendEmail };

package/tiledeskChatbotPlugs/directives/Directives.js

@@ -22,6 +22,7 @@ class Directives {
   static LOCK_INTENT = "lockintent";
   static UNLOCK_INTENT = "unlockintent";
   static FIRE_TILEDESK_EVENT = "firetiledeskevent";
+  static SEND_EMAIL = "sendemail";
 }
 
 module.exports = { Directives };