@tiledesk/tiledesk-tybot-connector 0.1.76 → 0.1.78

package/CHANGELOG.md

@@ -5,6 +5,14 @@
 available on:
  ▶️ https://www.npmjs.com/package/@tiledesk/tiledesk-tybot-connector
 
+### 0.1.78
+- web request assign to fix
+- fix filter on messages: groups removed
+
+### 0.1.77
+- Refactored DirDeflectToHelpcenter. Added projectId option (to allow search from workspaces in different projects)
+- increased MAX_STEPS for MAX ACTIONS EXEEDED error, from 20 to 200
+
 ### 0.1.76
 - added projectId debug log for production
 

package/models/TiledeskChatbot.js

@@ -12,7 +12,7 @@ const { DirUnlockIntent } = require('../tiledeskChatbotPlugs/directives/DirUnloc
 
 class TiledeskChatbot {
 
-  static MAX_STEPS = 20;
+  static MAX_STEPS = 200;
 
   constructor(config) {
     if (!config.botsDataSource) {
@@ -490,11 +490,11 @@ class TiledeskChatbot {
     await _tdcache.hset(parameter_key, parameter_name, parameter_value);
   }
 
-  static async checkStep(_tdcache, requestId, max_steps) {
-    // console.log("CHECKING ON MAX_STEPS:", max_steps);
+  static async checkStep(_tdcache, requestId, max_steps, log) {
+    if (log) {console.log("CHECKING ON MAX_STEPS:", max_steps);}
     let go_on = true; // continue
     const parameter_key = TiledeskChatbot.requestCacheKey(requestId) + ":step";
-    // console.log("__parameter_key:", parameter_key);
+    if (log) {console.log("__parameter_key:", parameter_key);}
     await _tdcache.incr(parameter_key);
     // console.log("incr-ed");
     let _current_step = await _tdcache.get(parameter_key);
@@ -505,8 +505,9 @@ class TiledeskChatbot {
     // current_step += 1;
     // await _tdcache.set(parameter_key, current_step); // increment step
     // console.log("CURRENT-STEP:", current_step);
-    if (current_step > max_steps) { // max_steps limit just violated
-      // console.log("CURRENT-STEP > MAX_STEPS!", current_step);
+    if (current_step > max_steps) {
+      if (log) {console.log("max_steps limit just violated");}
+      if (log) {console.log("CURRENT-STEP > MAX_STEPS!", current_step);}
       // await TiledeskChatbot.resetStep(_tdcache, requestId);
       // go_on = 1; // stop execution, send error message
       go_on = false

package/models/TiledeskChatbotUtil.js

@@ -161,7 +161,8 @@ class TiledeskChatbotUtil {
                 const jsonCondition = commands[i].message["_tdJSONCondition"];
                 // console.log("jsonCondition:", jsonCondition);
                 if (jsonCondition) {
-                    const expression = TiledeskExpression.JSONGroupsToExpression(jsonCondition.groups);
+                    // const expression = TiledeskExpression.JSONGroupsToExpression(jsonCondition.groups);
+                    const expression = TiledeskExpression.JSONGroupToExpression(jsonCondition);
                     // console.log("full json condition expression eval on command.message:", expression);
                     const conditionResult = new TiledeskExpression().evaluateStaticExpression(expression, variables);
                     console.log("conditionResult:", conditionResult);

package/package.json

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

package/tiledeskChatbotPlugs/DirectivesChatbotPlug.js

@@ -130,6 +130,7 @@ class DirectivesChatbotPlug {
       departmentId: depId,
       tdcache: tdcache,
       tdclient: tdclient,
+      HELP_CENTER_API_ENDPOINT: this.HELP_CENTER_API_ENDPOINT,
       log: this.log
     }
     if (this.log) {console.log("this.context.departmentId is:", this.context.departmentId);}
@@ -143,14 +144,14 @@ class DirectivesChatbotPlug {
   }
 
   async nextDirective(directives) {
-    // console.log("....nextDirective() checkStep():");
+    if (this.log) {console.log("....nextDirective() checkStep():");}
     const go_on = await TiledeskChatbot.checkStep(
-      this.context.tdcache, this.context.requestId, TiledeskChatbot.MAX_STEPS
+      this.context.tdcache, this.context.requestId, TiledeskChatbot.MAX_STEPS, this.log
     );
     // const current_step = await TiledeskChatbot.currentStep(this.context.tdcache, this.context.requestId);
-    // console.log("........nextDirective() currentStep:", current_step);
+    // if (this.log) {console.log("........nextDirective() currentStep:", current_step);}
     if (go_on == false) {
-      // console.log("..nextDirective() Stopped!");
+      if (this.log) {console.log("go_on == false! nextDirective() Stopped!");}
       return this.errorMessage("Request error: anomaly detection. MAX ACTIONS exeeded.");
     }
     // else if (go_on == 2) {
@@ -225,7 +226,7 @@ class DirectivesChatbotPlug {
     else if (directive_name === Directives.MESSAGE) {
       new DirMessage(context).execute(directive, async (stop) => {
         if (stop) {
-          if (context.log) { console.log("Stopping Actions on:", directive);}
+          if (context.log) { console.log("Stopping Actions on:", JSON.stringify(directive));}
           this.theend();
         }
         else {
@@ -251,7 +252,7 @@ class DirectivesChatbotPlug {
     else if (directive_name === Directives.IF_OPEN_HOURS) {
       new DirIfOpenHours(context).execute(directive, async (stop) => {
         if (stop) {
-          if (context.log) { console.log("Stopping Actions on:", directive);}
+          if (context.log) { console.log("Stopping Actions on:", JSON.stringify(directive));}
           this.theend();
         }
         else {
@@ -266,7 +267,7 @@ class DirectivesChatbotPlug {
       // console.log("...DirIfOnlineAgents")
       new DirIfOnlineAgents(context).execute(directive, async () => {
         if (stop) {
-          if (context.log) { console.log("Stopping Actions on:", directive);}
+          if (context.log) { console.log("Stopping Actions on:", JSON.stringify(directive));}
           this.theend();
         }
         else {
@@ -289,7 +290,7 @@ class DirectivesChatbotPlug {
       new DirCondition(context).execute(directive, async (stop) => {
         if (context.log) { console.log("stop on condition?", stop);}
         if (stop == true) {
-          if (context.log) { console.log("Stopping Actions on:", directive);}
+          if (context.log) { console.log("Stopping Actions on:", JSON.stringify(directive));}
           this.theend();
         }
         else {
@@ -303,7 +304,7 @@ class DirectivesChatbotPlug {
       new DirJSONCondition(context).execute(directive, async (stop) => {
         // console.log("stop on condition?", stop);
         if (stop == true) {
-          if (context.log) { console.log("Stopping Actions on:", directive);}
+          if (context.log) { console.log("Stopping Actions on:", JSON.stringify(directive));}
           this.theend();
         }
         else {
@@ -478,6 +479,19 @@ class DirectivesChatbotPlug {
         this.process(next_dir);
       });
     }
+    else if (directive_name === Directives.ASK_HELP_CENTER) {
+      new DirDeflectToHelpCenter(context).execute(directive, async (stop) => {
+        if (context.log) { console.log("DeflectToHelpCenter stop?", stop);}
+        if (stop == true) {
+          if (context.log) { console.log("Stopping Actions on:", JSON.stringify(directive));}
+          this.theend();
+        }
+        else {
+          let next_dir = await this.nextDirective(this.directives);
+          this.process(next_dir);
+        }
+      });
+    }
     else {
       //console.log("Unhandled Post-message Directive:", directive_name);
       let next_dir = await this.nextDirective(this.directives);
@@ -485,6 +499,7 @@ class DirectivesChatbotPlug {
     }
   }
 
+  // DEPRECATED
   processInlineDirectives(pipeline, theend) {
     const directives = this.directives;
     if (!directives || directives.length === 0) {

package/tiledeskChatbotPlugs/directives/DirDeflectToHelpCenter.js

@@ -1,52 +1,72 @@
-//const { HelpCenter } = require('./HelpCenter');
 const { HelpCenterQuery } = require('@tiledesk/helpcenter-query-client');
+const { TiledeskChatbot } = require('../../models/TiledeskChatbot.js');
+const { TiledeskChatbotConst } = require('../../models/TiledeskChatbotConst');
 const ms = require('minimist-string');
 
 class DirDeflectToHelpCenter {
 
-  constructor(config) {
-    if (!config.projectId) {
-      throw new Error('projectId is mandatory.');
+  constructor(context) {
+    if (!context) {
+      throw new Error('context object is mandatory.');
     }
-    if (config.HELP_CENTER_API_ENDPOINT) {
-      this.helpcenter_api_endpoint = config.HELP_CENTER_API_ENDPOINT;
-    }
-    //console.log("Using helpcenter_api_endpoint:", this.helpcenter_api_endpoint)
-    this.projectId = config.projectId;
+    this.context = context;
+    this.log = context.log;
   }
 
-  async execute(directive, pipeline, maxresults, completion) {
-    let workspace_id = null;
-    let default_hc_reply = "No matching reply but...\n\nI found something interesting in the Help Center 🧐\n\nTake a look 👇";
-    let hc_reply = default_hc_reply;
-    if (directive.parameter) {
-      // console.log("processing parameters")
+  async execute(directive, callback) {
+    let action;
+    if (directive.action) {
+      action = directive.action
+    }
+    else if (directive.parameter) {
       const params = this.parseParams(directive.parameter);
-      // console.log("parameters found", params);
       workspace_id = params.workspace_id;
-      // console.log("workspaceid found", workspace_id);
       if (params.hc_reply) {
         hc_reply = params.hc_reply;
-        // console.log("hc_reply found", hc_reply);
       }
     }
-    else {
-      hc_reply = default_hc_reply;
+    this.go(action, (stop) => {
+      callback(stop);
+    });
+  }
+
+  async go(action, callback) { //directive, pipeline, maxresults, completion) {
+    let default_hc_reply = "No matching reply but...\n\nI found something interesting in the Help Center 🧐\n\nTake a look 👇";
+    let hc_reply = default_hc_reply;
+    if (action.hcReply) {
+      hc_reply = action.hcReply;
+    }
+    let workspace_id = action.workspaceId;
+    let project_id = this.context.projectId;
+    if (action.projectId) {
+      project_id = action.projectId;
+    }
+    let maxresults = 3;
+    if (action.maxresults) {
+      maxresults = action.maxresults;
     }
-    //console.log("workspace_id param:", workspace_id);
-    //console.log("hc_reply param:", hc_reply);
-    let message = pipeline.message;
+    let url_target = "blank";
+    if (action.urlTarget) {
+      url_target = action.urlTarget;
+    }
+    // let message = pipeline.message;
     //console.log("help center message", JSON.stringify(message));
-    const original_text = message.attributes.intent_info.question_payload.text;
-    //console.log("original_text", original_text);
-    if (original_text && original_text.trim() != '') {
+    const last_user_text = await TiledeskChatbot.getParameterStatic(
+      this.context.tdcache,
+      this.context.requestId,
+      TiledeskChatbotConst.REQ_LAST_USER_TEXT_KEY);
+    if (this.log) {console.log("last_user_text", last_user_text);}
+    if (last_user_text && last_user_text.trim() !== '') {
       const helpcenter = new HelpCenterQuery({
         APIKEY: "__",
-        APIURL: this.helpcenter_api_endpoint,
-        projectId: this.projectId,
+        projectId: project_id,
         log: false
       });
+      if (this.helpcenter_api_endpoint) {
+        helpcenter.APIURL = this.helpcenter_api_endpoint
+      }
       if (!workspace_id) {
+        if (this.log) {console.log("No workspaces_id. Listing all workspaces to eventually select the first");}
         try {
           // find/select the first workspace
           const workspaces = await helpcenter.allWorkspaces();
@@ -55,38 +75,87 @@ class DirDeflectToHelpCenter {
             // console.log("First Workspace selected", workspaces[0]);
           }
           else {
-            // console.log("No Workspace found");
-            completion();
+            if (this.log) {console.log("No Workspaces found");}
+            callback(false);
           }
         }
         catch(err) {
           console.error("deflectToHelpCenter Error (search workspaces):", err);
-          completion();
+          callback(false);
         }
       }
-      // console.log("searching on workspace_id:", workspace_id);
+      if (this.log) {console.log("searching on workspace_id:", workspace_id);}
       try {
-        const results = await helpcenter.search(workspace_id, original_text, maxresults);
+        const results = await helpcenter.search(workspace_id, last_user_text, maxresults);
         if (results && results.length > 0) {
-          // console.log("Successfully got results", results);
-          // console.log("Sending REPL", hc_reply);
-          pipeline.message.text = hc_reply;
+          if (this.log) {console.log("Successfully got results", JSON.stringify(results));}
+          if (this.log) {console.log("Sending hcReply", hc_reply);}
+          // pipeline.message.text = hc_reply;
+          let buttons = [];
           results.forEach(content => {
-            if (content.url.charAt(content.url.length -1) != "/") {
-                content.url = content.url + "/"
+            const button = {
+							"type": "url",
+							"value": content.title,
+							"link": content.url,
+							"target": url_target
+						}
+            buttons.push(button);
+            // if (content.url.charAt(content.url.length -1) != "/") {
+            //     content.url = content.url + "/"
+            // }
+            // pipeline.message.text += "\n* " + content.title + " > " + content.url;
+          });
+          const message = {
+            "text": hc_reply,
+            "attributes": {
+              "disableInputMessage": false,
+              "commands": [
+                {
+                  "type": "wait",
+                  "time": 0
+                },
+                {
+                  "type": "message",
+                  "message": {
+                    "type": "text",
+                    "text": hc_reply,
+                    "attributes": {
+                      "attachment": {
+                        "type": "template",
+                        "buttons": buttons
+                      }
+                    }
+                  }
+                }
+              ]
             }
-            pipeline.message.text += "\n* " + content.title + " > " + content.url;
+          }
+
+          if (this.log) {console.log("HC reply:", JSON.stringify(message))};
+          this.context.tdclient.sendSupportMessage(
+            this.context.requestId,
+            message,
+            (err) => {
+              if (err) {
+                console.error("Error sending reply:", err.message);
+                callback(false);
+              }
+              if (this.log) {console.log("Reply message sent.");}
+              callback(true);
           });
         }
-        completion();
+        else {
+          if (this.log) {console.log("Nothing found in Help Center. projectId:", project_id, "workspaceId:", workspace_id);}
+          callback(false);
+        }
       }
       catch(err) {
         console.error("deflectToHelpCenter Error (searching results):", err);
-        completion();
+        callback(false);
       }
     }
     else {
-      completion();
+      callback(false);
     }
   }
 

package/tiledeskChatbotPlugs/directives/DirDeleteVariable.js

@@ -1,4 +1,3 @@
-const { HelpCenterQuery } = require('@tiledesk/helpcenter-query-client');
 const { param } = require('express/lib/request');
 const ms = require('minimist-string');
 const { TiledeskChatbot } = require('../../models/TiledeskChatbot');

package/tiledeskChatbotPlugs/directives/DirSendEmail.js

@@ -1,4 +1,3 @@
-const { HelpCenterQuery } = require('@tiledesk/helpcenter-query-client');
 const { param } = require('express/lib/request');
 const ms = require('minimist-string');
 const { TiledeskChatbot } = require('../../models/TiledeskChatbot');

package/tiledeskChatbotPlugs/directives/Directives.js

@@ -18,7 +18,7 @@ class Directives {
   static IF_NO_AGENTS = "ifnoagents"; // DEPRECATED
   static IF_AGENTS = "ifagents"; // DEPRECATED
 
-  static DEFLECT_TO_HELP_CENTER = "deflecttohelpcenter";
+  static ASK_HELP_CENTER = "askhelpcenter";
   static WAIT = "wait";
   static LOCK_INTENT = "lockintent";
   static UNLOCK_INTENT = "unlockintent";
@@ -30,9 +30,9 @@ class Directives {
   static IF_ONLINE_AGENTS = "ifonlineagents";
   static IF_NOT_OPEN_HOURS = "ifnotopenhours"; // DEPRECATED
   static FUNCTION_VALUE = "functionvalue";
-  static CONDITION = "condition";
+  static CONDITION = "condition"; // DEPRECATED
   static JSON_CONDITION = "jsoncondition";
-  static ASSIGN = "assign";
+  static ASSIGN = "assign"; // DEPRECATED
   static SET_ATTRIBUTE = "setattribute";
   // static IF_AVAILABLE_AGENTS = "ifavailableagents"; // TODO
   // static IF_NO_AVAILABLE_AGENTS = "ifnotavailableagents"; // TODO