Merge pull request #242 from watson-virtual-agents/dev

Dev

Author: ethanwinters

.travis.yml

@@ -25,7 +25,7 @@ notifications:
   email:
     recipients:
       - [email protected]
-      - najimovi@ar.ibm.com
+      - pedemont@us.ibm.com
     on_success: always    # default is change, update if this gets too annoying
     on_failure: always    # default: always
 addons:

dist/chat.js

@@ -1 +1 @@
-{"en":{"prompt":"Enter message...","thinking":"Agent is thinking...","anything_else":"Is there anything else I can help you with?","list_sep":", ","reconnect":"Attempting to reconnect...","basic_err":"I am sorry, I am having difficulties.","loading_failure1":"<span class=\"IBMChat-loading-failure-message-text\">I cannot complete your request. You can try a new request or <a class=\"IBMChat-loading-retry-link\" data-retry=\"true\" href=\"javascript:void(false);\">restart the conversation.</a></span>","loading_failure2":"<span class=\"IBMChat-loading-failure-message-text\">I cannot complete your request. Please <a class=\"IBMChat-loading-retry-link\" data-retry=\"true\" href=\"javascript:void(false);\">restart the conversation.</a></span>","submit":"Submit","cancel":"Cancel","required_field":"This field is required.","placeholder_mon":"MM","placeholder_year":"YYYY","cc_name":"Name on Card","cc_num":"Credit Card Number","cc_exp_mon":"Expiration Date Month","cc_exp_year":"Expiration Date Year","cc_code":"CVV","cc_code_alt":"","cc_use_valid":"Please use a valid card. We accept the following: ","cc_invalid":"Your credit card number is invalid.","cc_invalid_exp":"Your credit card expiration date is invalid.","cc_invalid_code":"Your CVV is invalid.","loc_curr":"Current Location","postal_code":"Zip Code","loc_prompt":"Please share your current location.","loc_share":"Your browser is asking you to share your location...","loc_share_granted":"You have allowed your browser to share your current location.","loc_looking":"Looking up your current location...","loc_share_denied":"You have denied sharing your location on this website.","loc_not_shared_prompt":"Please enable location sharing or continue with your Zip Code.","loc_all":"All Locations","loc_closed_today":"Closed today.","loc_open_today":"Open today.","loc_open_today_more":"<span class=\"{ns}-hours-open\">Open today:</span><span class=\"{ns}-hours-today\"> {open, time, short} &ndash; {close, time, short}</span>","loc_hours_open":"<span class=\"{ns}-days-hours-day\">{openDay, date, weekday_short}:</span>&nbsp;<span class=\"{ns}-days-hours-hours\">{open, time, short} &ndash; {close, time, short}</span>","loc_hours_open_multiday":"<span class=\"{ns}-days-hours-day\">{openDay, date, weekday_short}&ndash;{closeDay, date, weekday_short}:</span>&nbsp;<span class=\"{ns}-days-hours-hours\">{open, time, short} &ndash; {close, time, short}</span>","loc_hours_unknown":"<span class=\"{ns}-days-hours-day\">{day, date, weekday_short}:</span>&nbsp;<span class=\"{ns}-days-hours-hours\">Hours unknown</span>","loc_hours_closed":"<span class=\"{ns}-days-hours-day\">{day, date, weekday_short}:</span>&nbsp;<span class=\"{ns}-days-hours-hours\">Closed</span>","loc_nearby_none":"We could not find any locations close to you.","loc_nearby_single":"Here are the details for this location:","loc_nearby_list":"Here are the locations I found close to you:","google_maps_url":"https://maps.google.com/"}}
+{"en":{"prompt":"Enter message...","thinking":"Agent is thinking...","anything_else":"Is there anything else I can help you with?","edit":"edit","list_sep":", ","reconnect":"Attempting to reconnect...","basic_err":"I am sorry, I am having difficulties.","loading_failure1":"<span class=\"IBMChat-loading-failure-message-text\">I cannot complete your request. You can try a new request or <a class=\"IBMChat-loading-retry-link\" data-retry=\"true\" href=\"javascript:void(false);\">restart the conversation.</a></span>","loading_failure2":"<span class=\"IBMChat-loading-failure-message-text\">I cannot complete your request. Please <a class=\"IBMChat-loading-retry-link\" data-retry=\"true\" href=\"javascript:void(false);\">restart the conversation.</a></span>","submit":"Submit","cancel":"Cancel","required_field":"This field is required.","placeholder_mon":"MM","placeholder_year":"YYYY","cc_name":"Name on Card","cc_num":"Credit Card Number","cc_exp_mon":"Expiration Date Month","cc_exp_year":"Expiration Date Year","cc_code":"CVV","cc_code_alt":"","cc_use_valid":"Please use a valid card. We accept the following: ","cc_invalid":"Your credit card number is invalid.","cc_invalid_exp":"Your credit card expiration date is invalid.","cc_invalid_code":"Your CVV is invalid.","loc_curr":"Current Location","postal_code":"Zip Code","loc_prompt":"Please share your current location.","loc_share":"Your browser is asking you to share your location...","loc_share_granted":"You have allowed your browser to share your current location.","loc_looking":"Looking up your current location...","loc_share_denied":"You have denied sharing your location on this website.","loc_not_shared_prompt":"Please enable location sharing or continue with your Zip Code.","loc_all":"All Locations","loc_closed_today":"Closed today.","loc_open_today":"Open today.","loc_open_today_more":"<span class=\"{ns}-hours-open\">Open today:</span><span class=\"{ns}-hours-today\"> {open, time, short} &ndash; {close, time, short}</span>","loc_hours_open":"<span class=\"{ns}-days-hours-day\">{openDay, date, weekday_short}:</span>&nbsp;<span class=\"{ns}-days-hours-hours\">{open, time, short} &ndash; {close, time, short}</span>","loc_hours_open_multiday":"<span class=\"{ns}-days-hours-day\">{openDay, date, weekday_short}&ndash;{closeDay, date, weekday_short}:</span>&nbsp;<span class=\"{ns}-days-hours-hours\">{open, time, short} &ndash; {close, time, short}</span>","loc_hours_unknown":"<span class=\"{ns}-days-hours-day\">{day, date, weekday_short}:</span>&nbsp;<span class=\"{ns}-days-hours-hours\">Hours unknown</span>","loc_hours_closed":"<span class=\"{ns}-days-hours-day\">{day, date, weekday_short}:</span>&nbsp;<span class=\"{ns}-days-hours-hours\">Closed</span>","loc_nearby_none":"We could not find any locations close to you.","loc_nearby_single":"Here are the details for this location:","loc_nearby_list":"Here are the locations I found close to you:","google_maps_url":"https://maps.google.com/"}}

dist/chat.js.map

@@ -0,0 +1,32 @@
+{
+    "de": {
+      "authorized_users": "Erika Mustermann und Max Mustermann",
+      "agent": "Auf Ihrer Website würden Sie Code ausführen um jetzt mit einem Agent zu verbinden.",
+      "account_settings": "Auf Ihrer Website würden Sie Code ausführen um jetzt die Kontoeinstellungen-Seite zu öffnen."
+    },
+    "en": {
+        "authorized_users": "Bob Everyman and Jane Doe",
+        "agent": "On your own site you would run code to connect to an agent now.",
+        "account_settings": "On your own site you would run code to open the Account Settings page now."
+    },
+    "es": {
+        "authorized_users": "Ana Sanchez y Juan Pérez",
+        "agent": "En su sitio ejecutaría código para hablar con un agente.",
+        "account_settings": "En su sitio ejecutaría código para abrir la pagina de Configuración de Cuentas."
+    },
+    "fr": {
+      "authorized_users": "Jacques Martin et Marie Martin",
+      "agent": "Sur votre site, vous exécuteriez le code pour vous connecter à un agent .",
+      "account_settings": "Sur votre site, vous exécuteriez le code pour accéder à la page des paramètres du compte."
+    },
+    "it": {
+        "authorized_users": "Mario Rossi e Maria Bianchi",
+        "agent": "Sul tuo sito, normalmente ora eseguiresti codice che ti connette ad un agente",
+        "account_settings": "Sul tuo sito, normalmente ora eseguiresti codice per mostrare i settaggi dell'account"
+    },
+    "pt-br": {
+        "authorized_users": "João Silva e Maria Amélia",
+        "agent": "No seu próprio site, você executaria código para conectar a um agente neste ponto",
+        "account_settings": "No seu próprio site, você executaria código para exibir a página de Configurações de Conta neste ponto."
+    }
+}

dist/chat.min.js

@@ -0,0 +1,65 @@
+var langs = require('json!./langs.json');
+
+var config = { instance: null };
+var userProfileVariablesMap = {};
+
+function generateUserProfileVariablesMap() {
+  userProfileVariablesMap = {
+    'bill_amount': Number(42.01).toLocaleString(config.locale),
+    'payment_due_date': (function() {
+      const currentDate = new Date(new Date().getTime() + 24 * 60 * 60 * 1000);
+      return currentDate.toLocaleDateString(config.locale);
+    })(),
+    'authorized_users': config.strings.authorized_users
+  };
+}
+
+function getUserProfileVariables(data) {
+  const variables = data.message.action.args.variables;
+  variables.forEach(function(v) {
+    const value = userProfileVariablesMap[v];
+    (value) ? config.instance.profile.set(v, value) : config.instance.profile.set(v, '[sample data]');
+  });
+  config.instance.sendSilently('success');
+}
+
+function success() {
+  return config.instance.sendSilently('success');
+}
+function agent() {
+  return config.instance.receive(config.strings.agent);
+}
+function accountSettings() {
+  return config.instance.receive(config.strings.account_settings);
+}
+
+function registerActions(instance, locale, _skip) {
+  config.instance = instance;
+  config.locale = locale && locale.toLowerCase() || 'en';
+  config.strings = langs[config.locale];
+  generateUserProfileVariablesMap();
+
+  // subscribe to actions
+  [
+    ['getUserProfileVariables', getUserProfileVariables],
+    ['updateAddress', success],
+    ['updateUserName', success],
+    ['updatePhoneNumber', success],
+    ['updateEmail', success],
+    ['payBill', success],
+    ['sendPaymentReceipt', success],
+    ['agent', agent],
+    ['openAccountSettingsPage', accountSettings]
+  ].forEach(function(action) {
+    var name = action[0];
+    var cb = action[1];
+    if (_skip && _skip.indexOf(name) !== -1) { // skip
+      return;
+    }
+    instance.subscribe('action:' + name, cb);
+  });
+}
+
+module.exports = {
+  registerActions: registerActions
+};

dist/chat.min.js.map

@@ -1,6 +1,6 @@
 # Basic Custom Actions Example
 
-This example shows how to use "actions" as part of your flow in the chat widget. We will be using actions to update a users address.
+This example shows how to use "actions" as part of your flow in the chat widget. We will be using actions to update a users address. Simply type "update address" in the example and follow the prompts.
 
 ## Installing and Running Locally
   1. set the `botID`, `XIBMClientID` and `XIBMClientSecret` parameters in [src/index.js](./src/index.js) (see [Getting Started](https://github.com/watson-virtual-agents/chat-widget/blob/master/README.md#getting-started) for further details on this):

dist/lang/en.json

@@ -6,7 +6,7 @@
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "webpack -minify -production",
-    "start": "webpack-dev-server --port 3030"
+    "start": "webpack-dev-server --host 0.0.0.0 --port 3030"
   },
   "license": "Apache-2.0",
   "author": "IBM Corp",

examples/_mock_actions/langs.json

@@ -13,6 +13,7 @@
 */
 
 var IBMChat = require('@watson-virtual-agent/chat-widget');
+var mockActions = require('../../_mock_actions/main.js');
 
 // initialize chat widget. Set botID, XIBMClientID and XIBMClientSecret
 // with the corresponding values.
@@ -22,35 +23,39 @@ IBMChat.init({
   botID: '',              // replace with Bot ID
   XIBMClientID: '',       // replace with Client ID
   XIBMClientSecret: ''    // replace with Client Secret
-});
+})
+.then(function() {
+  // mock some actions in order to make the example for useful (but skip `updateAddress` -- see below)
+  mockActions.registerActions(IBMChat, null, ['updateAddress']);
 
-IBMChat.subscribe('action:updateAddress', function(data){
-  var addressType = data.message.action.args.address_type;
-  var address = {
-    type: data.message.action.args.address_type, //e.g. billing or home. The user selected this by clicking a button
-    /*
-      when WVA called the form layout, it also included a "store" array to populate the form.
-      when the form is submitted, the form data by the keys in the store array and added to
-      IBMChat.profile. You can recall them from IBMChat.profile as below.
-    */
-    address1: IBMChat.profile.get('user_street_address1'),
-    address2: IBMChat.profile.get('user_street_address2'),
-    city: IBMChat.profile.get('user_locality'),
-    region: IBMChat.profile.get('user_state_or_province'),
-    postalCode: IBMChat.profile.get('user_zipcode')
-  }
-  function error() {
-    //IBMChat.sendSilently will send a message to WVA, but not show up in the chat console.
-    // when there is an error, WVA expects you to respond with "failure". "success" and "cancel" are other potential options here.
-    IBMChat.sendSilently('failure');
-  }
-  function success() {
-    //IBMChat.sendSilently will send a message to WVA, but not show up in the chat console.
-    // when everything goes as planned, WVA expects you to respond with "success". "failure" and "cancel" are other potential options here.
-    IBMChat.sendSilently('success');
-  }
-  //send your data to your own datastore.
-  myFakePostCommand(address, error, success);
+  // add a custom action handle for `updateAddress`
+  IBMChat.subscribe('action:updateAddress', function(data) {
+    var address = {
+      type: data.message.action.args.address_type, //e.g. billing or home. The user selected this by clicking a button
+      /*
+        when WVA called the form layout, it also included a "store" array to populate the form.
+        when the form is submitted, the form data by the keys in the store array and added to
+        IBMChat.profile. You can recall them from IBMChat.profile as below.
+      */
+      address1: IBMChat.profile.get('user_street_address1'),
+      address2: IBMChat.profile.get('user_street_address2'),
+      city: IBMChat.profile.get('user_locality'),
+      region: IBMChat.profile.get('user_state_or_province'),
+      postalCode: IBMChat.profile.get('user_zipcode')
+    };
+    function error() {
+      //IBMChat.sendSilently will send a message to WVA, but not show up in the chat console.
+      // when there is an error, WVA expects you to respond with "failure". "success" and "cancel" are other potential options here.
+      IBMChat.sendSilently('failure');
+    }
+    function success() {
+      //IBMChat.sendSilently will send a message to WVA, but not show up in the chat console.
+      // when everything goes as planned, WVA expects you to respond with "success". "failure" and "cancel" are other potential options here.
+      IBMChat.sendSilently('success');
+    }
+    //send your data to your own datastore.
+    myFakePostCommand(address, error, success);
+  });
 });
 
 function myFakePostCommand(data, errorCallback, successCallback) {
@@ -60,8 +65,15 @@ function myFakePostCommand(data, errorCallback, successCallback) {
       return true;
     return false;
   }
-  if (isNotEmpty(data.type) && isNotEmpty(data.address1) && isNotEmpty(data.city) && isNotEmpty(data.region) && isNotEmpty(data.postalCode))
+  if (isNotEmpty(data.type) &&
+      isNotEmpty(data.address1) &&
+      isNotEmpty(data.city) &&
+      isNotEmpty(data.region) &&
+      isNotEmpty(data.postalCode)) {
+    console.log('Successfully updated user\'s address:', data);
     successCallback(); //let the WVA know everything went well
-  else
+  } else {
+    console.error('There was an error updating user\'s address. Missing info.')
     errorCallback(); // let the WVA know that the attempt to save failed
+  }
 }

examples/_mock_actions/main.js

@@ -6,7 +6,7 @@
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "webpack -minify -production",
-    "start": "webpack-dev-server --port 3030"
+    "start": "webpack-dev-server --host 0.0.0.0 --port 3030"
   },
   "license": "Apache-2.0",
   "author": "IBM Corp",

examples/basic-actions-example/README.md

@@ -13,6 +13,7 @@
 */
 
 var IBMChat = require('@watson-virtual-agent/chat-widget');
+var mockActions = require('../../_mock_actions/main.js');
 
 /**
  * This example shows how to create a custom layout to replace the chat widget's
@@ -157,4 +158,7 @@ IBMChat.init({
   botID: '',              // replace with Bot ID
   XIBMClientID: '',       // replace with Client ID
   XIBMClientSecret: ''    // replace with Client Secret
+}).then(function() {
+  // mock some actions in order to make the example for useful
+  mockActions.registerActions(IBMChat);
 });

examples/basic-actions-example/package.json

@@ -6,7 +6,7 @@
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
     "build": "webpack -minify -production",
-    "start": "webpack-dev-server --port 3030"
+    "start": "webpack-dev-server --host 0.0.0.0 --port 3030"
   },
   "license": "Apache-2.0",
   "author": "IBM Corp",

examples/basic-actions-example/src/index.js

@@ -17,6 +17,7 @@
  */
 
 var IBMChat = require('@watson-virtual-agent/chat-widget');
+var mockActions = require('../../_mock_actions/main.js');
 // load a single or multi-language bundle of translated strings
 var langs = require('json-loader!@watson-virtual-agent/chat-widget/dist/lang/es.json');
 var locale = 'es';
@@ -36,4 +37,7 @@ IBMChat.init({
   botID: '',              // replace with Bot ID
   XIBMClientID: '',       // replace with Client ID
   XIBMClientSecret: ''    // replace with Client Secret
+}).then(function() {
+  // mock some actions in order to make the example for useful
+  mockActions.registerActions(IBMChat, locale);
 });

examples/basic-custom-layout/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@watson-virtual-agent/chat-widget",
-  "version": "1.6.0",
+  "version": "1.6.1",
   "description": "Watson Virtual Agent Chat Widget",
   "homepage": "https://github.com/watson-virtual-agents/chat-widget",
   "main": "dist/chat.js",
@@ -36,7 +36,7 @@
     "Watson Virtual Agent"
   ],
   "license": "Apache-2.0",
-  "publishConfig":{
+  "publishConfig": {
     "registry": "https://registry.npmjs.org"
   },
   "author": "IBM Corp",
@@ -90,6 +90,7 @@
     "rewire": "2.5.2",
     "rewire-webpack": "1.0.1",
     "selenium-download": "2.0.7",
+    "selfsigned": "1.9.1",
     "semver": "5.3.0",
     "sinon": "1.17.6",
     "sinon-chai": "2.8.0",

examples/basic-custom-layout/src/index.js

@@ -5,7 +5,9 @@ var utils = require('../../utils');
 
 function reset() {
   events.publish('clear-error');
+  events.publish('clear');
   events.publish('scroll-to-bottom');
+  events.publish('enable-loading');
   return new window.Promise(function(resolve, reject) {
     var current = state.get();
     var SDKconfig = utils.getSDKConfig(current);
@@ -23,7 +25,6 @@ function reset() {
       .configure( SDKconfig )
       .start( current.botID )
       .then( function(res) {
-        events.publish('clear');
         events.publish('chatID', res.chatID);
         events.publish('receive', res);
       })['catch']( function(err) {

examples/basic-i18n-example/package.json

@@ -13,6 +13,7 @@
 */
 
 var events = require('../../events');
+var i18n = require('../../utils/i18n');
 var state = require('../../state');
 
 function _addDataSet(data) {
@@ -50,15 +51,18 @@ function layoutError(layout) {
 
 function intent(data) {
   var element = data.element;
+  var label = document.createElement('label');
   var link = document.createElement('a');
   link.setAttribute('href', 'javascript:void(0)');
+  link.textContent = i18n('edit');
   if (data.private) {
-    link.textContent = '#' + data.intent;
+    label.textContent = '#' + data.intent;
     link.setAttribute('data-private', data.intent);
   } else {
-    link.textContent = data.blueprint.label;
+    label.textContent = data.blueprint.label;
     link.setAttribute('data-intent', _addDataSet(data));
   }
+  element.appendChild(label);
   element.appendChild(link);
 }
 

examples/basic-i18n-example/src/index.js

@@ -9,6 +9,7 @@ en:
     anything_else: 'Is there anything else I can help you with?'
 
     # general
+    edit: 'edit'
     ## test: Currently only used when generating a list of credit cards (see `cc_use_valid`).
     list_sep: ', '