@tiledesk/tiledesk-tybot-connector 0.2.22 → 0.2.24

package/CHANGELOG.md

@@ -5,8 +5,18 @@
 available on:
  ▶️ https://www.npmjs.com/package/@tiledesk/tiledesk-tybot-connector
 
+### v0.2.24
+- Patch for the misleading \\start training phrase. Added: if (message.text === "\\start") { message.text = "/start" }
+- Added Qapla action
+- Fixed bug: the 3.5 turbo model was always used in GptTask action 
+
+### v0.2.23
+- Fixed CaptureUserReply. Added Check for missing goToIntent
+- When channelName == "chat21" it will be renamed in "web"
+
 ### v0.2.22
 - Fixed "TildeskChatConst.js is not defined" in index.js
+- added System attribute "channelName"
 
 ### v0.2.21
 - log clean

package/index.js

@@ -147,6 +147,11 @@ router.post('/ext/:botid', async (req, res) => {
     projectId: projectId,
     log: log
   });
+  if (log) {console.log("MESSAGE CONTAINS:", message.text);}
+  if (message.text === "\\\\start") { // patch for the misleading \\start training phrase
+    if (log) {console.log("forced conversion of \\\\start /start");}
+    message.text = "/start";
+  }
   await TiledeskChatbotUtil.updateRequestAttributes(chatbot, message, projectId, requestId);
   await TiledeskChatbotUtil.updateConversationTranscript(chatbot, message);
 

package/models/TiledeskChatbotUtil.js

@@ -338,7 +338,14 @@ class TiledeskChatbotUtil {
         if (message.text && message.sender !== "_tdinternal") {
             await chatbot.addParameter(TiledeskChatbotConst.REQ_LAST_USER_TEXT_KEY, message.text); // DEPRECATED
             await chatbot.addParameter("lastUserText", message.text);
-            
+            if (message.channel) {
+                if (message.channel.name === "chat21") {
+                    await chatbot.addParameter("chatChannel", "web"); // renames the channel in chat21
+                }
+                else {
+                    await chatbot.addParameter("chatChannel", message.channel.name);
+                }
+            }
             await chatbot.addParameter("lastUserMessageType", message.type);
             await chatbot.addParameter("lastUserMessage", TiledeskChatbotUtil.lastUserMessageFrom(message)); // JSON TYPE *NEW
             // get image

package/package.json

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

package/tiledeskChatbotPlugs/DirectivesChatbotPlug.js

@@ -30,6 +30,7 @@ const { DirWebRequestV2 } = require('./directives/DirWebRequestV2');
 const { DirCode } = require('./directives/DirCode');
 const { DirWhatsappByAttribute } = require('./directives/DirWhatsappByAttribute');
 const { DirAskGPT } = require('./directives/DirAskGPT');
+const { DirQapla } = require('./directives/DirQapla');
 
 const { TiledeskChatbot } = require('../models/TiledeskChatbot');
 const { DirIfOnlineAgents } = require('./directives/DirIfOnlineAgents');
@@ -594,6 +595,12 @@ class DirectivesChatbotPlug {
         this.process(next_dir);
       });
     }
+    else if (directive_name === Directives.QAPLA) {
+      new DirQapla(context).execute(directive, async () => {
+        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);

package/tiledeskChatbotPlugs/directives/DirCaptureUserReply.js

@@ -103,9 +103,15 @@ class DirCaptureUserReply {
   
       if (callback) {
         // console.log("(DirCaptureUserReply) #executeGoTo(goToIntent)", goToIntent)
-        this.#executeGoTo(goToIntent, () => {
+        if (goToIntent) {
+          this.#executeGoTo(goToIntent, () => {
+            callback(); // continue the flow
+          });
+        }
+        else {
           callback(); // continue the flow
-        });
+        }
+        
       }
     }
     catch(error) {

package/tiledeskChatbotPlugs/directives/DirGptTask.js

@@ -21,6 +21,7 @@ class DirGptTask {
     let action;
     if (directive.action) {
       action = directive.action;
+      console.log("-----> GPT TASK ACTION: \n", action);
     }
     else {
       console.error("Incorrect directive: ", JSON.stringify(directive));
@@ -34,6 +35,8 @@ class DirGptTask {
 
   async go(action, callback) {
     if (this.log) { console.log("GptTask action:", JSON.stringify(action)); }
+    console.log("GptTask action:", JSON.stringify(action));
+    console.log("GptTask action model:", action.model);
     if (!this.tdcache) {
       console.error("Error: DirGptTask tdcache is mandatory");
       callback();
@@ -94,7 +97,7 @@ class DirGptTask {
           }
         } else if (callback) {
           if (this.log) {
-            console.log("Get KnowledgeBase resbody:", resbody);
+            console.log("Get KnowledgeBase settings resbody:", resbody);
             console.log("gptkey: ", resbody.gptkey);
           }
 
@@ -106,7 +109,7 @@ class DirGptTask {
           } else {
 
             let json = {
-              "model": "gpt-3.5-turbo",
+              "model": action.model,
               "messages": [
                 {
                   "role": "user",

package/tiledeskChatbotPlugs/directives/DirQapla.js

@@ -0,0 +1,191 @@
+const axios = require("axios").default;
+const { TiledeskChatbot } = require("../../models/TiledeskChatbot");
+const { Filler } = require("../Filler");
+let https = require("https");
+require('dotenv').config();
+
+class DirQapla {
+
+  constructor(context) {
+    if (!context) {
+      throw new Error('context object is mandatory');
+    }
+    this.context = context;
+    this.tdcache = this.context.tdcache;
+    this.requestId = this.context.requestId;
+    this.log = context.log;
+  }
+
+  execute(directive, callback) {
+    if (this.log) { console.log("DirQapla directive: ", directive); }
+    let action;
+    if (directive.action) {
+      action = directive.action;
+    }
+    else {
+      console.error("DirQapla Incorrect directive: ", JSON.stringify(directive));
+      callback();
+      return;
+    }
+    this.go(action, () => {
+      callback();
+    })
+  }
+
+  async go(action, callback) {
+    if (this.log) { console.log("DirQapla action:", JSON.stringify(action)); }
+    if (!this.tdcache) {
+      console.error("Error: DirQapla tdcache is mandatory");
+      callback();
+      return;
+    }
+
+    let requestVariables = null;
+    requestVariables =
+      await TiledeskChatbot.allParametersStatic(
+        this.tdcache, this.requestId
+      )
+
+    if (this.log) {
+      const all_parameters = await TiledeskChatbot.allParametersStatic(this.context.tdcache, this.context.requestId);
+      for (const [key, value] of Object.entries(all_parameters)) {
+        if (this.log) { console.log("DirQapla request parameter:", key, "value:", value, "type:", typeof value) }
+      }
+    }
+
+    let tracking_number = await this.context.chatbot.getParameter(action.trackingNumber);
+    if (this.log) {console.log("DirQapla tracking number: ", tracking_number); }
+
+    if (!tracking_number) {
+      console.error("DirQapla ERROR - tracking number is undefined or null");
+      callback();
+    }
+
+    const qapla_base_url = process.env.QAPLA_ENDPOINT || "https://api.qapla.it/1.2"
+    // https://api.qapla.it/1.2/getShipment/?apiKey=3b9839c954168e861f2b63d79920ec3a3ff92aab674de9f3930df60b8a40c495&trackingNumber=123456
+    if (this.log) { console.log("DirQapla QaplaEndpoint URL: ", qapla_base_url); }
+    const QAPLA_HTTPREQUEST = {
+      url: qapla_base_url + "/getShipment/",
+      headers: {
+        'Content-Type': 'application/json'
+      },
+      params: {
+        apiKey: action.apiKey,
+        trackingNumber: tracking_number
+      },
+      method: "GET"
+    }
+    if (this.log) { console.log("DirQapla QAPLA_HTTPREQUEST", QAPLA_HTTPREQUEST); }
+
+    this.#myrequest(
+      QAPLA_HTTPREQUEST, async (err, resbody) => {
+        if (err) {
+          if (callback) {
+            console.error("(httprequest) DirQapla getShipment err:", err);
+            callback();
+          }
+        } else if (callback) {
+          if (this.log) { console.log("DirQapla getShipment resbody: ", resbody); }
+
+          let status = null;;
+          let result;
+          let error;
+
+          if (resbody.getShipment &&
+              resbody.getShipment.shipments &&
+              resbody.getShipment.shipments[0] &&
+              resbody.getShipment.shipments[0].status &&
+              resbody.getShipment.shipments[0].status.qaplaStatus &&
+              resbody.getShipment.shipments[0].status.qaplaStatus.status) {
+                status = resbody.getShipment.shipments[0].status.qaplaStatus.status;
+              }
+          
+          result = resbody.getShipment.result;
+          error = resbody.getShipment.error;
+          await this.#assignAttributes(action, status, result, error);
+          callback();
+        }
+      }
+    )
+
+  }
+
+
+  async #assignAttributes(action, status, result, error) {
+    if (this.log) {
+      console.log("DirQapla assignAttributes action:", action)
+      console.log("DirQapla assignAttributes status:", status)
+      console.log("DirQapla assignAttributes result:", result)
+      console.log("DirQapla assignAttributes error:", error)
+    }
+    if (this.context.tdcache) {
+      if (action.assignStatusTo) {
+        await TiledeskChatbot.addParameterStatic(this.context.tdcache, this.context.requestId, action.assignStatusTo, status);
+      }
+      if (action.assignResultTo && result) {
+        await TiledeskChatbot.addParameterStatic(this.context.tdcache, this.context.requestId, action.assignResultTo, result);
+      }
+      if (action.assignErrorTo) {
+        await TiledeskChatbot.addParameterStatic(this.context.tdcache, this.context.requestId, action.assignErrorTo, error);
+      }
+
+      // Debug log
+      if (this.log) {
+        const all_parameters = await TiledeskChatbot.allParametersStatic(this.context.tdcache, this.context.requestId);
+        for (const [key, value] of Object.entries(all_parameters)) {
+          if (this.log) { console.log("DirQapla request parameter:", key, "value:", value, "type:", typeof value) }
+        }
+      }
+    }
+  }
+
+  #myrequest(options, callback) {
+    if (this.log) {
+      console.log("API URL:", options.url);
+      console.log("** Options:", JSON.stringify(options));
+    }
+    let axios_options = {
+      url: options.url,
+      method: options.method,
+      params: options.params,
+      headers: options.headers
+    }
+    if (options.json !== null) {
+      axios_options.data = options.json
+    }
+    if (this.log) {
+      console.log("axios_options:", JSON.stringify(axios_options));
+    }
+    if (options.url.startsWith("https:")) {
+      const httpsAgent = new https.Agent({
+        rejectUnauthorized: false,
+      });
+      axios_options.httpsAgent = httpsAgent;
+    }
+    axios(axios_options)
+      .then((res) => {
+        if (this.log) {
+          console.log("Response for url:", options.url);
+          console.log("Response headers:\n", JSON.stringify(res.headers));
+        }
+        if (res && res.status == 200 && res.data) {
+          if (callback) {
+            callback(null, res.data);
+          }
+        }
+        else {
+          if (callback) {
+            callback(new Error("Response status is not 200"), null);
+          }
+        }
+      })
+      .catch((error) => {
+        // console.error("An error occurred:", JSON.stringify(error.data));
+        if (callback) {
+          callback(error, null);
+        }
+      });
+  }
+}
+
+module.exports = { DirQapla }

package/tiledeskChatbotPlugs/directives/Directives.js

@@ -30,6 +30,7 @@ class Directives {
   static GPT_TASK = "gpt_task";
   static FORM = "form";
   static CAPTURE_USER_REPLY = "capture_user_reply";
+  static QAPLA = 'qapla';
 
   // static WHEN_ONLINE_MOVE_TO_AGENT = "whenonlinemovetoagent"; // DEPRECATED?
   // static WHEN_OFFLINE_HOURS = "whenofflinehours"; // DEPRECATED // adds a message on top of the original message when offline hours opts: --replace