@tiledesk/tiledesk-tybot-connector 0.1.41 → 0.1.42

package/CHANGELOG.md

@@ -5,6 +5,9 @@
 available on:
  ▶️ https://www.npmjs.com/package/@tiledesk/tiledesk-tybot-connector
 
+### 0.1.42
+- added IntentForm pre-set variables skipping
+
 ### 0.1.41
 - added Filler
 - added Filler to email .to .subject .text attributes

package/models/IntentForm.js

@@ -11,6 +11,18 @@ class IntentForm {
     this.CURRENT_FIELD_INDEX_KEY = "tilebot:requests:" + this.requestId + ":currentFieldIndex"
     this.CURRENT_FORM_KEY = "tilebot:requests:" + this.requestId + ":currentForm"
     this.log = options.log;
+    this.requestParameters = options.requestParameters;
+  }
+
+  getParam(paramKey) {
+    if (!this.requestParameters) {
+      return null;
+    }
+    if (this.log) {
+      console.log("this.requestParameters:", this.requestParameters);
+      console.log("this.requestParameters[" + paramKey + "]:", this.requestParameters[paramKey]);
+    }
+    return this.requestParameters[paramKey];
   }
 
   async setValue(key, value) {
@@ -78,9 +90,27 @@ class IntentForm {
     if (current_field == null) {
       if (this.log) {console.log("current_field is undefined")}
       current_field = 0;
+      
+      // first "freeze" the currente form, so that eventual form modifications
+      // do not compromise this form processing.
       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)
+    //   }
+      // set the first field under the "await the response-value" state (=0)
       await this.setValue(this.CURRENT_FIELD_INDEX_KEY, current_field);
-      //this.printdb();
+      // now look for an already set value for this field in request parameters
+      if (this.log) {console.log("params", this.requestParameters);}
+      if (this.log) {console.log("checking field:", this.form.fields[current_field].name);}
+      const is_current_value = this.getParam(this.form.fields[current_field].name);
+      if (is_current_value) {
+        if (this.log) {console.log("is_current_value!", is_current_value);}
+        return await this.getMessage(is_current_value);
+      }
+      if (this.log) {console.log("Form asking fist value. No 'is_current_value' for first form field", is_current_value);}
       if (this.log) {console.log("INTENT_FORM:", this.form);}
       if (this.log) {console.log("CURRENT FIELD:", current_field);}
       let message = {
@@ -92,9 +122,18 @@ class IntentForm {
       }
     }
     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");}
@@ -147,12 +186,23 @@ class IntentForm {
       else {
         if (this.log) {console.log("Processing next field:", current_field)}
         await this.setValue(this.CURRENT_FIELD_INDEX_KEY, current_field);
-        let message = {
-          text: current_form.fields[current_field].label
+
+        if (this.log) {console.log("params", this.requestParameters);}
+        if (this.log) {console.log("checking field:", this.form.fields[current_field].name);}
+        
+        const is_current_value = this.getParam(this.form.fields[current_field].name);
+        if (is_current_value) {
+          if (this.log) {console.log("is_current_value!", is_current_value);}
+            return await this.getMessage(is_current_value);
         }
-        return {
-          message: message
-        };
+        else {
+            return {
+              message: {
+                text: current_form.fields[current_field].label
+              }
+            };
+        }
+        
       }
     }
   }

package/models/{IntentFormStudy.js → IntentForm_no_prefill.js}

@@ -78,19 +78,9 @@ class IntentForm {
     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);
-      }
+      //this.printdb();
       if (this.log) {console.log("INTENT_FORM:", this.form);}
       if (this.log) {console.log("CURRENT FIELD:", current_field);}
       let message = {
@@ -102,18 +92,9 @@ class IntentForm {
       }
     }
     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");}
@@ -166,19 +147,12 @@ class IntentForm {
       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);
+        let message = {
+          text: current_form.fields[current_field].label
         }
-        else {
-            let message = {
-              text: current_form.fields[current_field].label
-            }
-            return {
-              message: message
-            };
-        }
-        
+        return {
+          message: message
+        };
       }
     }
   }

package/models/TiledeskChatbot.js

@@ -436,8 +436,17 @@ class TiledeskChatbot {
   }
 
   async execIntentForm(userInputReply, form) {
-  if (this.log)   {console.log("executing intent form...")}
-    let intentForm = new IntentForm({form: form, requestId: this.requestId, chatbot: this, log: this.log});
+    if (this.log) {console.log("executing intent form...")}
+    let all_parameters = await this.allParameters();
+    if (this.log) {console.log("allParameters for IntentForm:", all_parameters)}
+    let intentForm = new IntentForm(
+      {
+        form: form,
+        requestId: this.requestId,
+        chatbot: this,
+        requestParameters: all_parameters,
+        log: this.log
+      });
     let message = await intentForm.getMessage(userInputReply);
     return message;
   }

package/package.json

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

package/test/intent_form_pre_filled_test.js

@@ -0,0 +1,260 @@
+var assert = require('assert');
+const { ExtUtil } = require('../ExtUtil');
+const { IntentForm } = require('../models/IntentForm');
+const { MockTdCache } = require('../models/MockTdCache');
+const { v4: uuidv4 } = require('uuid');
+
+const TYPE_PREFIX = "_tdTypeOf:";
+
+describe('IntentForm', function() {
+
+  it('basic form with 1 field, pre-filled', async () => {
+    const form = {
+      "fields": [
+        {
+          "name": "userFullname",
+          "type": "string",
+          "label": "What is your name?"
+        }
+      ]
+    };
+
+    const REQUEST_ID = "support-group-PROJECT_X-" + uuidv4().replace(/-/g, "");
+
+    const chatbot = new Chatbot();
+    await chatbot.addParameter('userFullname', "Already Andrea");
+    let all_parameters = await chatbot.allParameters();
+    // console.log("executing intent form...")
+    let intentForm = new IntentForm(
+      {
+        form: form,
+        requestId: REQUEST_ID,
+        chatbot: chatbot,
+        requestParameters: all_parameters,
+        log: false
+      }
+    );
+    let form_reply1 = await intentForm.getMessage("Trigger message");
+    // console.log("Got form first field label:", form_reply1)
+    assert(form_reply1 !== null);
+    assert(!form_reply1.canceled);
+    assert(form_reply1.end);
+    assert(all_parameters[form.fields[0].name] === "Already Andrea");
+    assert(all_parameters[TYPE_PREFIX + form.fields[0].name] === form.fields[0].type);
+  });
+
+  it('basic form with 2 fields, both pre-filled', async () => {
+    const form = {
+      "fields": [
+        {
+          "name": "userFullname",
+          "type": "string",
+          "label": "What is your name?"
+        },
+        {
+          "name": "userEmail",
+          "type": "string",
+          "label": "What is your email?"
+        }
+      ]
+    };
+
+    const REQUEST_ID = "support-group-PROJECT_X-" + uuidv4().replace(/-/g, "");
+
+    const chatbot = new Chatbot();
+    await chatbot.addParameter('userFullname', "Already Andrea");
+    await chatbot.addParameter('userEmail', "Already Email");
+    let all_parameters = await chatbot.allParameters();
+    // console.log("executing intent form...")
+    let intentForm = new IntentForm(
+      {
+        form: form,
+        requestId: REQUEST_ID,
+        chatbot: chatbot,
+        requestParameters: all_parameters,
+        log: false
+      }
+    );
+    let form_reply1 = await intentForm.getMessage("Trigger message");
+    // console.log("Got form first field label:", form_reply1)
+    assert(form_reply1 !== null);
+    assert(!form_reply1.canceled);
+    assert(form_reply1.end);
+    assert(all_parameters[form.fields[0].name] === "Already Andrea");
+    assert(all_parameters[TYPE_PREFIX + form.fields[0].name] === form.fields[0].type);
+    assert(all_parameters[form.fields[1].name] === "Already Email");
+    assert(all_parameters[TYPE_PREFIX + form.fields[1].name] === form.fields[1].type);
+  });
+
+  it('basic form with 3 fields, only 1st & 2nd pre-filled', async () => {
+    const form = {
+      "fields": [
+        {
+          "name": "userFullname",
+          "type": "string",
+          "label": "What is your name?"
+        },
+        {
+          "name": "userEmail",
+          "type": "string",
+          "label": "What is your email?"
+        },
+        {
+          "name": "companyName",
+          "type": "longString",
+          "label": "Company name?"
+        }
+      ]
+    };
+
+    const REQUEST_ID = "support-group-PROJECT_X-" + uuidv4().replace(/-/g, "");
+
+    const chatbot = new Chatbot();
+    await chatbot.addParameter('userFullname', "Already Andrea");
+    await chatbot.addParameter('userEmail', "Already Email");
+    let all_parameters = await chatbot.allParameters();
+    // console.log("executing intent form...")
+    let intentForm = new IntentForm(
+      {
+        form: form,
+        requestId: REQUEST_ID,
+        chatbot: chatbot,
+        requestParameters: all_parameters,
+        log: false
+      }
+    );
+    let form_reply1 = await intentForm.getMessage("Trigger message");
+    // console.log("Got form first field label:", form_reply1)
+    assert(form_reply1 !== null);
+    assert(!form_reply1.canceled);
+    assert(form_reply1.message.text === form.fields[2].label);
+    
+    let form_reply2 = await intentForm.getMessage("Tiledesk");
+    // console.log("Got form second field label:", form_reply2)
+    assert(form_reply2 !== null);
+    assert(!form_reply2.canceled);
+    assert(form_reply2.end);
+    assert(all_parameters[form.fields[2].name] === "Tiledesk");
+    assert(all_parameters[TYPE_PREFIX + form.fields[2].name] === form.fields[2].type);
+    
+    assert(all_parameters[form.fields[0].name] === "Already Andrea");
+    assert(all_parameters[TYPE_PREFIX + form.fields[0].name] === form.fields[0].type);
+    assert(all_parameters[form.fields[1].name] === "Already Email");
+    assert(all_parameters[TYPE_PREFIX + form.fields[1].name] === form.fields[1].type);
+    assert(all_parameters[form.fields[2].name] === "Tiledesk");
+    assert(all_parameters[TYPE_PREFIX + form.fields[2].name] === form.fields[2].type);
+    // console.log("All params:", all_parameters);
+  });
+
+  it('basic form with 6 fields, 1st & 2nd pre-filled, 3rd not pre-filled, 4th (tel) pre-filled, 5th not pre-filled, 6th (age) pre-filled', async () => {
+    const form = {
+      "fields": [
+        {
+          "name": "userFullname",
+          "type": "string",
+          "label": "What is your name?"
+        },
+        {
+          "name": "userEmail",
+          "type": "string",
+          "label": "What is your email?"
+        },
+        {
+          "name": "companyName",
+          "type": "string",
+          "label": "Company name?"
+        },
+        {
+          "name": "tel",
+          "type": "longString",
+          "label": "Your phone number?"
+        },
+        {
+          "name": "SSN",
+          "type": "longString",
+          "label": "Your SSN?"
+        },
+        {
+          "name": "age",
+          "type": "number",
+          "label": "Your age?"
+        }
+      ]
+    };
+
+    const REQUEST_ID = "support-group-PROJECT_X-" + uuidv4().replace(/-/g, "");
+
+    const chatbot = new Chatbot();
+    await chatbot.addParameter('userFullname', "Already Andrea");
+    await chatbot.addParameter('userEmail', "Already Email");
+    await chatbot.addParameter('tel', "0000");
+    await chatbot.addParameter('age', "49");
+    
+    let all_parameters = await chatbot.allParameters();
+    // console.log("executing intent form...")
+    let intentForm = new IntentForm(
+      {
+        form: form,
+        requestId: REQUEST_ID,
+        chatbot: chatbot,
+        requestParameters: all_parameters,
+        log: false
+      }
+    );
+    let form_reply1 = await intentForm.getMessage("Trigger message");
+    // console.log("Got form first field label:", form_reply1)
+    assert(form_reply1 !== null);
+    assert(!form_reply1.canceled);
+    assert(form_reply1.message.text === form.fields[2].label);
+    
+    let form_reply2 = await intentForm.getMessage("Tiledesk");
+    // console.log("Got form 'companyName' field label:", form_reply2);
+    assert(form_reply2 !== null);
+    assert(!form_reply2.canceled);
+    assert(form_reply2.message);
+    assert(form_reply2.message.text === form.fields[4].label) // asks the next "editable" field's label (SSN)
+    assert(all_parameters[form.fields[2].name] === "Tiledesk");
+    assert(all_parameters[TYPE_PREFIX + form.fields[2].name] === form.fields[2].type);
+
+    let form_reply3 = await intentForm.getMessage("SPNNDR0000");
+    // console.log("Got form 'SSN' field label:", form_reply3);
+    assert(form_reply3 !== null);
+    assert(!form_reply3.canceled);
+    assert(form_reply3.end);
+    
+    assert(all_parameters[form.fields[0].name] === "Already Andrea");
+    assert(all_parameters[TYPE_PREFIX + form.fields[0].name] === form.fields[0].type);
+    assert(all_parameters[form.fields[1].name] === "Already Email");
+    assert(all_parameters[TYPE_PREFIX + form.fields[1].name] === form.fields[1].type);
+    assert(all_parameters[form.fields[2].name] === "Tiledesk");
+    assert(all_parameters[TYPE_PREFIX + form.fields[2].name] === form.fields[2].type);
+    assert(all_parameters[form.fields[3].name] === "0000");
+    assert(all_parameters[TYPE_PREFIX + form.fields[3].name] === form.fields[3].type);
+    assert(all_parameters[form.fields[4].name] === "SPNNDR0000");
+    assert(all_parameters[TYPE_PREFIX + form.fields[4].name] === form.fields[4].type);
+    assert(all_parameters[form.fields[5].name] === "49");
+    assert(all_parameters[TYPE_PREFIX + form.fields[5].name] === form.fields[5].type);
+    // console.log("All params:", all_parameters);
+  });
+    
+});
+
+class Chatbot {
+      
+  constructor() {
+    this.tdcache = new MockTdCache();
+    this.requestParameters = {};
+  }
+
+  async addParameter(parameter_name, parameter_value) {
+    this.requestParameters[parameter_name] = parameter_value;
+    return true;
+  }
+
+  async allParameters() {
+    return new Promise( (resolve) => {
+      resolve(this.requestParameters);
+    });
+  }
+  
+}

package/test/intent_form_test.js

@@ -12,7 +12,6 @@ describe('IntentForm', function() {
     const form = {
       "cancelCommands": ['annulla', 'cancella', 'reset', 'cancel'],
       "cancelReply": "Form canceled!",
-      "cancelReplyIntent": "formCanceled", // TODO IDEA
       "fields": [
         {
           "name": "userFullname",

package/test/single_test.sh

@@ -3,5 +3,6 @@
 #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/send_email_directive_test.js --exit
+npx mocha ./test/intent_form_test.js --exit
+#npx mocha ./test/send_email_directive_test.js --exit
+#npx mocha ./test/intent_form_pre_filled_test.js --exit