@tiledesk/tiledesk-tybot-connector 0.1.40 → 0.1.41

package/CHANGELOG.md

@@ -5,6 +5,10 @@
 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

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.40",
+  "version": "0.1.41",
   "description": "Tiledesk Tybot connector",
   "main": "index.js",
   "scripts": {
@@ -18,13 +18,14 @@
     "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

@@ -3,10 +3,11 @@ 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 directive DirSendEmail', async () => {
+  it('test DirSendEmail', async () => {
     class MockTdClient {
       async sendEmail(message, callback) {
         if (callback) {
@@ -15,24 +16,37 @@ describe('Directive DirSendEmail', function() {
         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 "test@test" --subject "test" --text "test"'
+      parameter: '--to "${email}" --subject "Hello ${fullname}" --text "Welcome ${fullname}"'
     };
+    let requestId = "request1";
     let dir = new DirSendEmail({
-        tdclient: new MockTdClient()
+        tdclient: new MockTdClient(),
+        tdcache: new MockTdCache(),
+        requestId: requestId
     });
-    let requestId = null;
-    const message =  await dir.execute(send_email_directive, requestId) //, "err").to.be.null;
-    // console.error("Was expecting an error for the 'to' missing parameter");
-    console.log("message:", message);
+    const message =  await dir.execute(send_email_directive);
     assert(message);
-    assert(message.to);
-    assert(message.text);
-    assert(message.subject);
+    assert(message.to === 'johnb@email.com');
+    assert(message.text === 'Welcome John B.');
+    assert(message.subject === 'Hello John B.');
   });
 
-  it('test directive DirSendEmail with missing "to"', async () => {
+  it('test DirSendEmail with missing "to"', async () => {
     class MockTdClient {
       async sendEmail(message, callback) {
         if (callback) {
@@ -48,21 +62,11 @@ describe('Directive DirSendEmail', function() {
     let dir = new DirSendEmail({
         tdclient: new MockTdClient()
     });
-    let requestId = null;
-    // try {
-      const message =  await dir.execute(send_email_directive, requestId) //, "err").to.be.null;
-      // console.error("Was expecting an error for the 'to' missing parameter");
-      assert(message == null);
-    // }
-    // catch(err) {
-    //   //console.log("Error is ok", err);
-    //   if (!err.message.startsWith("sendEmail missing mandatory parameters")) {
-    //     assert.ok(false);
-    //   }
-    // }
+    const message =  await dir.execute(send_email_directive)
+    assert(message == null);
   });
 
-  it('test directive DirSendEmail in pipeline', async () => {
+  it('test DirSendEmail in pipeline', async () => {
     const message_text = `\\_tdsendemail --to "test@test" --subject "_sub" --text "_body"`;
     const answer = {
       text: message_text,

package/tiledeskChatbotPlugs/DirectivesChatbotPlug.js

@@ -269,8 +269,13 @@ class DirectivesChatbotPlug {
         });
       }
       else if (directive_name === Directives.SEND_EMAIL) {
-        new DirSendEmail({tdclient: tdclient}).execute(directive, requestId, () => {
-          process(nextDirective());
+        new DirSendEmail(
+          {
+            tdclient: tdclient,
+            tdcache: tdcache,
+            requestId: requestId
+          }).execute(directive, () => {
+            process(nextDirective());
         });
       }
       else {

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

@@ -1,47 +1,50 @@
-//const { HelpCenter } = require('./HelpCenter');
 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) object is mandatory.');
+      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, requestId, completion) {
-    // return new Promise( (resolve, reject) => {
+  async execute(directive, completion) {
       let params = null;
       if (directive.parameter) {
-        // console.log("processing sendEmail parameters");
         params = this.parseParams(directive.parameter);
-        // console.log("parameters found", params);
       }
       else {
-        console.log("sendEmail missing parameter error. Skipping");
         const error = new Error("sendEmail missing 'parameter' error. Skipping");
         if (completion) {
           completion(error);
         }
-        // reject(error);
-        // throw 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: params.subject,
-            text: params.text,
-            to: params.to
+            subject: filler.fill(params.subject, requestVariables),
+            text: filler.fill(params.text, requestVariables),
+            to: filler.fill(params.to, requestVariables)
           });
-          // console.log("echo", message_echo)
           if (completion) {
             completion(null, message_echo);
           }
-          // resolve(message_echo);
           return message_echo;
         }
         catch(err) {
@@ -49,20 +52,14 @@ class DirSendEmail {
           if (completion) {
             completion(err);
           }
-          // reject(error);
-          // throw err;
         }
       }
       else {
-        // console.log("sendEmail missing mandatory parameters (to|subject|text):");
         const error = new Error("sendEmail missing mandatory parameters (to|subject|text)");
         if (completion) {
           completion(error);
         }
-        // reject(err);
-        // throw error;
       }
-    // });
   }
 
   parseParams(directive_parameter) {