@tiledesk/tiledesk-tybot-connector 0.1.37 → 0.1.38

package/CHANGELOG.md

@@ -5,6 +5,9 @@
 available on:
  ▶️ https://www.npmjs.com/package/@tiledesk/tiledesk-tybot-connector
 
+### 0.1.38 - online
+- tiledesk-client => 0.9.3
+
 ### 0.1.37 - online
 - log clean
 

package/index.js

@@ -52,7 +52,7 @@ router.post('/ext/:botid', async (req, res) => {
     TiledeskClient.version09();
   }
   res.status(200).send({"success":true});
-
+  
   const botId = req.params.botid;
   if (log) {console.log("query botId:", botId);}
   const message = req.body.payload;
@@ -62,7 +62,16 @@ router.post('/ext/:botid', async (req, res) => {
   const requestId = message.request.request_id;
   const projectId = message.id_project;
 
+  let requestSourcePage = null;
+  let requestLanguage = null; 
+  let requestUserAgent = null;
 
+  if (message.payload) {
+    requestSourcePage = message.payload.sourcePage;
+    requestLanguage = message.payload.language;
+    requestUserAgent = message.payload.userAgent;
+  }
+  
   // NEXTTTTTTT
   const message_context = {
     projectId: projectId,
@@ -117,9 +126,20 @@ router.post('/ext/:botid', async (req, res) => {
     projectId: projectId,
     log: log
   });
-
+  
+  // initial request context
   await chatbot.addParameter("_tdLastMessageId", messageId);
   await chatbot.addParameter("_tdProjectId", projectId);
+  if (requestSourcePage) {
+    await chatbot.addParameter("requestSourcePage", sourcePage);
+  }
+  if (requestLanguage) {
+    await chatbot.addParameter("requestLanguage", language);
+  }
+  if (requestUserAgent) {
+    await chatbot.addParameter("requestUserAgent", userAgent);
+  }
+
   let reply = await chatbot.replyToMessage(message);
   if (!reply) {
     reply = {
@@ -135,7 +155,7 @@ router.post('/ext/:botid', async (req, res) => {
     ENDPOINT: extEndpoint,
     log: log
   });
-
+  
   apiext.sendSupportMessageExt(reply, projectId, requestId, token, () => {
     if (log) {
       console.log("SupportMessageExt() reply sent:", reply);
@@ -264,8 +284,8 @@ router.get('/message/context/:messageid', async (req, res) => {
 router.get('/ext/parameters/requests/:requestid', async (req, res) => {
   const requestId = req.params.requestid;
   const parameters = await TiledeskChatbot.allParametersStatic(tdcache, requestId);
-  console.log("parameters:", parameters);
-  console.log("req.query.all:", req.query.all);
+  // console.log("parameters:", parameters);
+  // console.log("req.query.all:", req.query.all);
   if (req.query.all != null) {
     res.send(parameters);
   }
@@ -273,7 +293,7 @@ router.get('/ext/parameters/requests/:requestid', async (req, res) => {
     let userParams = {};
     if (parameters) {
       for (const [key, value] of Object.entries(parameters)) {
-        console.log(key, value);
+        // console.log(key, value);
         if (!key.startsWith("_td")) {
           userParams[key] = value;
         }

package/models/IntentFormStudy.js

@@ -0,0 +1,213 @@
+//const CURRENT_FIELD_K = "tilebot:requests:forms:currentField"; // form field index
+const CURRENT_FORM_K = "CURRENT_FORM"; // form json
+
+class IntentForm {
+
+  constructor(options) {
+    this.db = options.chatbot.tdcache;
+    this.chatbot = options.chatbot;
+    this.requestId = options.requestId;
+    this.form = options.form;
+    this.CURRENT_FIELD_INDEX_KEY = "tilebot:requests:" + this.requestId + ":currentFieldIndex"
+    this.CURRENT_FORM_KEY = "tilebot:requests:" + this.requestId + ":currentForm"
+    this.log = options.log;
+  }
+
+  async setValue(key, value) {
+    await this.db.set(key, value);
+  }
+
+  async getValue(key) {
+    const value = await this.db.get(key);
+    return value;
+  }
+
+  async delValue(key) {
+    await this.db.del(key);
+  }
+
+  /**
+    intent_text: Used to send final text when the form is completed.
+    example form schema
+    the_form = {
+      "name": "form_name",
+      "id": "form_id",
+      "fields": [
+        {
+          "name": "userFullname",
+          "type": "text",
+          "label": "Your name"
+        },
+        {
+          "name": "userEmail",
+          "type": "text",
+          "regex": "/^(?=.{1,254}$)(?=.{1,64}@)[-!#$%&'*+/0-9=?A-Z^_`a-z{|}~]+(.[-!#$%&'*+/0-9=?A-Z^_`a-z{|}~]+)*@[A-Za-z0-9]([A-Za-z0-9-]{0,61}[A-Za-z0-9])?(.[A-Za-z0-9]([A-Za-z0-9-]{0,61}[A-Za-z0-9])?)+$/",
+          "label": "Your email",
+          "errorLabel": "Invalid email address"
+        }
+      ]
+    }
+  */
+  async getMessage(user_text) {
+    //console.log("get message:", user_text)
+    if (
+    this.form &&
+    this.form.cancelCommands &&
+    this.form.cancelCommands.includes(user_text.toLowerCase())) {
+      const cancelReply = this.form.cancelReply ? this.form.cancelReply : "Canceled"
+      await this.delValue(this.CURRENT_FIELD_INDEX_KEY)
+      await this.delValue(this.CURRENT_FORM_KEY)
+      return {
+        canceled: true,
+        message: {
+          text: cancelReply
+        }
+      };
+    }
+    let current_field = null;
+    const _current_field = await this.getValue(this.CURRENT_FIELD_INDEX_KEY);
+    if (_current_field) {
+      current_field = Number(_current_field);
+    }
+    let current_form = null;
+    const _current_form = await this.getValue(this.CURRENT_FORM_KEY);
+    if (_current_form) {
+      current_form = JSON.parse(_current_form);
+    }
+    //console.log("CURRENT FORM IS", current_form);
+    if (current_field == null) {
+      if (this.log) {console.log("current_field is undefined")}
+      current_field = 0;
+      
+      await this.setValue(this.CURRENT_FORM_KEY, JSON.stringify(this.form));
+    //   if (getParam(this.form.fields[current_field].name)) {
+    //     //current_field++;
+    //     await this.setValue(this.CURRENT_FIELD_INDEX_KEY, current_field); //=0
+    //     return this.getMessage(current_value)
+    //   }
+      
+      await this.setValue(this.CURRENT_FIELD_INDEX_KEY, current_field);
+      const is_current_value = getParam(this.form.fields[current_field].name);
+      if (is_current_value) {
+        return await this.getMessage(is_current_value);
+      }
+      if (this.log) {console.log("INTENT_FORM:", this.form);}
+      if (this.log) {console.log("CURRENT FIELD:", current_field);}
+      let message = {
+        text: this.form.fields[current_field].label
+      }
+      if (this.log) {console.log("form reply message:", message);}
+      return {
+        message: message
+      }
+    }
+    else {
+        // = 0
+        // current++ (1) y? => 
+        // 
+        //inc(current_field)=1 getMessage(null)
+        // == 1?
+        // n => continue => 
+        // param[1] n? => continue
+        // == 2? => set fields[2].name => user_text
+      //console.log("current_form:", current_form);
+      if (this.log) {console.log("current_field:", current_field);}
+      
+      
+      if (current_form.fields[current_field].regex) {
+        if (!this.validate(user_text, current_form.fields[current_field].regex)) {
+          if (this.log) {console.log("text is invalid");}
+          // send error message
+          let error_reply_text = this.form.fields[current_field].label;
+          if (this.log) {console.log("text is invalid label", error_reply_text);}
+          if (current_form.fields[current_field].errorLabel) {
+            if (this.log) {console.log("text is invalid errorLabel", current_form.fields[current_field].errorLabel);}
+            error_reply_text = current_form.fields[current_field].errorLabel;
+          }
+          let message = {
+            text: error_reply_text // Error
+          }
+          if (this.log) {console.log("IntentForm error message:", message);}
+          return {
+            message: message
+          };
+        }
+      }
+      else {
+        if (this.log) {console.log("no regex validation requested. next field...")}
+      }
+      
+      // text ok?
+      //   y: set value for current_field = text
+      //.     inc current_field, send message[current_field]
+      //.  n: send error message => error[current_field]
+      //.     no inc, no changes in status
+      //await this.setValue(FIELD_VALUE_K, user_text);
+
+      // persist parameter
+      const parameter_name = current_form.fields[current_field].name;
+      const parameter_value = user_text;
+      if (this.log) {console.log("adding parameters, name:", parameter_name, "value:", parameter_value)}
+      await this.chatbot.addParameter(parameter_name, parameter_value);
+      if (current_form.fields[current_field].type) { // adding type
+        await this.chatbot.addParameter("_tdTypeOf:" + parameter_name, current_form.fields[current_field].type);
+      }
+      if (this.log) {console.log("next field...");}
+
+      current_field += 1;
+      if (current_field === current_form.fields.length) {
+        // Form completed!
+        await this.delValue(this.CURRENT_FIELD_INDEX_KEY)
+        await this.delValue(this.CURRENT_FORM_KEY)
+        return {
+          end: true
+        };
+      }
+      else {
+        if (this.log) {console.log("Processing next field:", current_field)}
+        await this.setValue(this.CURRENT_FIELD_INDEX_KEY, current_field);
+        const is_current_value = getParam(this.form.fields[current_field].name);
+        if (is_current_value) {
+            return await this.getMessage(is_current_value);
+        }
+        else {
+            let message = {
+              text: current_form.fields[current_field].label
+            }
+            return {
+              message: message
+            };
+        }
+        
+      }
+    }
+  }
+  
+  validate(text, regex) {
+    let _regex = regex;
+    if (regex.startsWith("/")) {
+      // removing leading and trailing / if regex is sorrounded by (legacy support, to be removed)
+      _regex = regex.substring(1, regex.length-1);
+    }
+    if (this.log) {console.log("Validating using regex:", _regex);}
+    const rg = new RegExp(_regex, "g");
+    return rg.test(text);
+  }
+
+  static isValidForm(form) {
+    let is_valid = true;
+    if (!form) {
+      is_valid = false;
+    }
+    else if (form && !form.fields) {
+      is_valid = false;
+    }
+    else if (form && form.fields.length === 0) {
+      is_valid = false;
+    }
+    return is_valid;
+  }
+
+}
+
+module.exports = { IntentForm };

package/models/TiledeskChatbot.js

@@ -316,6 +316,7 @@ class TiledeskChatbot {
         }
         form_reply.message.attributes.fillParams = true;
         form_reply.message.attributes.splits = true;
+        form_reply.message.attributes.directives = true;
         return form_reply.message
       }
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tiledesk/tiledesk-tybot-connector",
-  "version": "0.1.37",
+  "version": "0.1.38",
   "description": "Tiledesk Tybot connector",
   "main": "index.js",
   "scripts": {
@@ -14,7 +14,7 @@
     "@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.2",
+    "@tiledesk/tiledesk-client": "^0.9.3",
     "axios": "^0.27.2",
     "body-parser": "^1.19.0",
     "cors": "^2.8.5",

package/test/conversation1-test.js

@@ -49,7 +49,7 @@ before( () => {
 
 after(function(done) {
   app_listener.close( () => {
-    console.log('app_listener closed.');
+    // console.log('app_listener closed.');
     done();
   });
 });
@@ -63,7 +63,7 @@ describe('Conversation1', 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.text === "Hello");
@@ -87,7 +87,7 @@ describe('Conversation1', async() => {
             assert.ok(false);
           }
           else {
-            console.log("params /start:", params);
+            // console.log("params /start:", params);
             assert(params);
             assert(params["_tdLastMessageId"] === message_id);
             assert(params["_tdProjectId"] === PROJECT_ID);
@@ -100,7 +100,7 @@ describe('Conversation1', async() => {
       });
       
       listener = endpointServer.listen(10002, '0.0.0.0', function () {
-        // console.log('endpointServer started', listener.address());
+        //console.log('endpointServer started', listener.address());
       });
       let request = {
         "payload": {
@@ -119,7 +119,7 @@ describe('Conversation1', async() => {
         "token": CHATBOT_TOKEN
       }
       sendMessageToBot(request, BOT_ID, CHATBOT_TOKEN, () => {
-        // console.log("Message sent.");
+        //console.log("Message sent.");
       });
     });
     
@@ -213,7 +213,7 @@ describe('Conversation1', async() => {
               assert.ok(false);
             }
             else {
-              console.log("params:", params);
+              // console.log("params:", params);
               assert(params);
               assert(params["_tdLastMessageId"] === message_id);
               assert(params["_tdProjectId"] === PROJECT_ID);
@@ -258,6 +258,87 @@ describe('Conversation1', async() => {
       });
     });
 
+    it('/splitted', (done) => {
+      // console.log("/splitted...");
+      const message_id = uuidv4();
+      const reply_text = "Andrea";
+      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;
+        // console.log("message:", JSON.stringify(message));
+        if (message.attributes.commands) {
+          assert(message.attributes.commands.length === 5);
+          assert(message.attributes.commands[0].type === "message");
+          assert(message.attributes.commands[0].message.text === "Row1");
+          assert(message.attributes.commands[0].message.type === "text");
+          
+          assert(message.attributes.commands[1].type === "wait");
+          assert(message.attributes.commands[1].time === 500);
+
+          assert(message.attributes.commands[2].type === "message");
+          assert(message.attributes.commands[2].message.text === "Row2");
+          assert(message.attributes.commands[2].message.type === "image");
+          assert(message.attributes.commands[2].message.metadata);
+
+          assert(message.attributes.commands[3].type === "wait");
+          assert(message.attributes.commands[3].time === 500);
+
+          assert(message.attributes.commands[4].type === "message");
+          assert(message.attributes.commands[4].message.text === "Row4");
+          assert(message.attributes.commands[4].message.type === "text");
+          assert(message.attributes.commands[4].message.attributes);
+          assert(message.attributes.commands[4].message.attributes.attachment);
+          assert(message.attributes.commands[4].message.attributes.attachment.type === 'template');          
+          assert(message.attributes.commands[4].message.attributes.attachment.buttons.length === 1);
+          assert(message.attributes.commands[4].message.attributes.attachment.buttons[0].type === 'text');
+          assert(message.attributes.commands[4].message.attributes.attachment.buttons[0].value === '/start');
+          
+          const expected_raw_message = 'Row1\n' +
+          '\n' +
+          'Row2\n' +
+          'tdImage:https://nypost.com/wp-content/uploads/sites/2/2020/03/covid-tiger-01.jpg?quality=75&strip=all&w=1488\n' +
+          '\n' +
+          'Row4\n' +
+          '* /start';
+          assert(message.attributes._raw_message === expected_raw_message);
+          done();
+        }
+        else {
+          console.error("Unexpected message.");
+          assert.ok(false);
+        }
+        
+      });
+      
+      listener = endpointServer.listen(10002, '0.0.0.0', function () {
+        // console.log('endpointServer started', listener.address());
+        // console.log("REQUEST_ID:", REQUEST_ID);
+        let request = {
+          "payload": {
+            "_id": uuidv4(),
+            "senderFullname": "guest#367e",
+            "type": "text",
+            "sender": "A-SENDER",
+            "recipient": REQUEST_ID,
+            "text": "/splitted",
+            "id_project": PROJECT_ID,
+            "request": {
+              "request_id": REQUEST_ID,
+              "id_project": PROJECT_ID
+            }
+          },
+          "token": CHATBOT_TOKEN
+        }
+        sendMessageToBot(request, BOT_ID, CHATBOT_TOKEN, () => {
+          // console.log("Message sent.");
+        });
+      });
+    });
+
 });
 
 // function createRequest(projectId, callback) {
@@ -337,7 +418,7 @@ function sendMessageToBot(message, botId, token, callback) {
           callback(null, resbody);
         }
       }
-    }, true
+    }, false
   );
 }
 
@@ -370,12 +451,12 @@ function sendMessageToBot(message, botId, token, callback) {
           callback(null, resbody);
         }
       }
-    }, true
+    }, false
   );
 }
 
 function myrequest(options, callback, log) {
-  if (this.log) {
+  if (log) {
     console.log("API URL:", options.url);
     console.log("** Options:", options);
   }
@@ -388,7 +469,7 @@ function myrequest(options, callback, log) {
       headers: options.headers
     })
   .then((res) => {
-    if (this.log) {
+    if (log) {
       console.log("Response for url:", options.url);
       console.log("Response headers:\n", res.headers);
       //console.log("******** Response for url:", res);

package/test/single_test.sh

@@ -2,5 +2,5 @@
 #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/intent_form_test.js --exit
+npx mocha ./test/conversation1-test.js --exit
+#npx mocha ./test/intent_form_test.js --exit

package/tiledeskChatbotPlugs/directives/DirDeflectToHelpCenter.js

@@ -20,14 +20,14 @@ class DirDeflectToHelpCenter {
     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")
+      // console.log("processing parameters")
       const params = this.parseParams(directive.parameter);
-      console.log("parameters found", params);
+      // console.log("parameters found", params);
       workspace_id = params.workspace_id;
-      console.log("workspaceid found", workspace_id);
+      // console.log("workspaceid found", workspace_id);
       if (params.hc_reply) {
         hc_reply = params.hc_reply;
-        console.log("hc_reply found", hc_reply);
+        // console.log("hc_reply found", hc_reply);
       }
     }
     else {
@@ -52,10 +52,10 @@ class DirDeflectToHelpCenter {
           const workspaces = await helpcenter.allWorkspaces();
           if (workspaces.length > 0) {
             workspace_id = workspaces[0]._id;
-            console.log("First Workspace selected", workspaces[0]);
+            // console.log("First Workspace selected", workspaces[0]);
           }
           else {
-            console.log("No Workspace found");
+            // console.log("No Workspace found");
             completion();
           }
         }
@@ -64,12 +64,12 @@ class DirDeflectToHelpCenter {
           completion();
         }
       }
-      console.log("searching on workspace_id:", workspace_id);
+      // console.log("searching on workspace_id:", workspace_id);
       try {
         const results = await helpcenter.search(workspace_id, original_text, maxresults);
         if (results && results.length > 0) {
-          console.log("Successfully got results", results);
-          console.log("Sending REPL", hc_reply);
+          // console.log("Successfully got results", results);
+          // console.log("Sending REPL", hc_reply);
           pipeline.message.text = hc_reply;
           results.forEach(content => {
             if (content.url.charAt(content.url.length -1) != "/") {
@@ -93,9 +93,9 @@ class DirDeflectToHelpCenter {
   parseParams(directive_parameter) {
     let workspace_id = null;
     let hc_reply = null;
-    console.log("ms found:", ms)
+    // console.log("ms found:", ms)
     const params = ms(directive_parameter);
-    console.log("ms decoded params:", params)
+    // console.log("ms decoded params:", params)
     if (params.w) {
       workspace_id = params.w
     }
@@ -104,16 +104,16 @@ class DirDeflectToHelpCenter {
     }
     
     if (params.m) {
-      console.log("_params.m:", params.m)
+      // console.log("_params.m:", params.m)
       //hc_reply = params.m.replaceAll("\\n", "\n");
       hc_reply = params.m.replace(/\\n/g, "\n");
-      console.log("hc_reply with replaced slash n regex|replaceAll", hc_reply)
+      // console.log("hc_reply with replaced slash n regex|replaceAll", hc_reply)
     }
     if (params.message) {
-      console.log("_params.message:", params.message)
+      // console.log("_params.message:", params.message)
       //hc_reply = params.message.replaceAll("\\n", "\n");
       hc_reply = params.message.replace(/\\n/g, "\n");
-      console.log("hc_reply -message with replaced slash n replace(/\\n/g", hc_reply)
+      // console.log("hc_reply -message with replaced slash n replace(/\\n/g", hc_reply)
     }
     return {
       workspace_id: workspace_id,