/* Copyright (c) 2017-present, salesforce.com, inc. All rights reserved */
/* Licensed under BSD 3-Clause - see LICENSE.txt or git.io/sfdc-license */
const FlowScriptCompiler = require('./flowScriptCompiler.js');
/**
* Creates List Widgets for Voice - supports the common use case when a user
* needs to interact with one of multiple items.
*
* @module violetList
*
* @param {Violet} violet - the pointer to the violet instance so that we can
* hook in appropriately to script resources. This plugin does expect that
* the calling script defineGoal with goal name as given by the
* <code>interactionGoal</code> method.
* @param {string} dataType - a string representing the type for the contents
* of this widget. This widget is called by setting the list in question with
* name being the same as the <code>dataType</code> and calling the
* <code>respondWithItems</code> method.
* @param {string} humanName - what to refer to an item in this list when
* speaking to the user.
* @param {string} humanNamePl - what to refer to mutliple items in this list
* when speaking to the user.
* @param {string} itemTextProp - how to get the itemText (the main name) of a
* list item.
*/
/**
* Core object returned by the plugin
*
* @class
*/
class ListWidget {
constructor(dataType, humanName, humanNamePl, itemTextProp) {
this.dataType = dataType;
this.humanName = humanName;
this.humanNamePl = humanNamePl;
this.itemTextProp = itemTextProp;
}
/**
* Returns the goal that will be called when the user can interact with an
* item. This method should be called to define a goal in the parent script.
*/
interactionGoal() {
return `interactWith${this.dataType}`;
}
/**
* Returns the text to speak to describe the target itemTextProp. This
* method is called by the widget and can be redefined to customize the
* the interaction with the user.
*
* @param {number} ndx - what is the item number being spoken
* @param {Object[]} results - array of items being spoken
* @returns {string} by default `${humanName} ${ndx+1} is ${results[ndx][itemTextProp]}. `
*/
getItemText(ndx, results) {
var listItemObj = results[ndx];
return `${this.humanName} ${ndx+1} is ${listItemObj[this.itemTextProp]}. `;
}
/**
* When this method is called it launches the widget. It lists the first 3
* items and asks the user it he wants to hear more items or if he wants to
* interact with an item.
*
* @param {response} response - so that the widget can prompt the user
* @param {Object[]} results - array of items that need to be spoken
*/
respondWithItems(response, results) {
var out = 'I found ' + results.length + ' ' + this.humanNamePl + '. '
for(var ndx=0; ndx<3 && ndx<results.length; ndx++) {
out += this.getItemText(ndx, results);
}
response.say(out);
if (results.length>3)
response.addGoal(`hearPastThree${this.dataType}`)
response.addGoal(`interactWith${this.dataType}`)
}
/**
* Used by the widget to list the next 7 items till the 17th item.
*
* @param {response} response - so that the widget can prompt the user
* @param {Object[]} results - array of items that need to be spoken
* @param {Object[]} start - array of items that need to be spoken
*/
respondWithMoreItems(response, results, start=0) {
var out = '';
for(var ndx=3+start; ndx<10+start && ndx<results.length; ndx++) {
out += this.getItemText(ndx, results);
}
response.say(out);
if (results.length>10 && start==0) // we dont speak past 17 cases
response.addGoal(`hearPastTen${this.dataType}`)
response.addGoal(`interactWith${this.dataType}`)
}
/**
* Will get an item from the result set, giving an error to the user if the
* requested item is not in the array.
*
* @param {response} response - so that the widget can prompt the user
* @param {number} itemNo - index of the item to be retrieved
* @returns {Object} object that is desired or undefined if itemNo is
* invalid
*/
getItemFromResults(response, itemNo) {
const errMgrNotFoundItems = `Could not find ${this.humanNamePl}`;
const errMgrNotFoundTgtItem = `Could not find ${this.humanName} ${itemNo}`;
const errMgrInvalidItemNo = `Invalid ${this.humanName} Number`;
if (itemNo) {
itemNo = parseInt(itemNo)-1;
}
if (itemNo == undefined || itemNo == null || itemNo<0 || itemNo>17)
return response.say(errMgrInvalidItemNo);
var results = response.get(this.dataType);
if (results == undefined || results == null || !Array.isArray(results))
return response.say(errMgrNotFoundItems);
if (results.length<itemNo)
return response.say(errMgrNotFoundTgtItem);
return results[itemNo];
}
};
module.exports = (violet) => {
return {
register: ({dataType, widgetType, humanName, humanNamePl, widgetTag, itemTextProp, interactionFlow}) =>{
const listWidget = new ListWidget(dataType, humanName, humanNamePl, itemTextProp);
console.log(`Defining goals: hearPastThree${listWidget.dataType} and hearPastTen${listWidget.dataType}`)
violet.defineGoal({
goal: `hearPastThree${listWidget.dataType}`,
prompt: [`Do you want to hear more ${listWidget.humanNamePl}?`],
respondTo: [{
name: `${listWidget.dataType}YesHearPastThree`,
expecting: ['Yes', 'Hear more'],
resolve: (response) => {
response.say(`Getting more ${listWidget.humanNamePl}.`);
var results = response.get(dataType);
listWidget.respondWithMoreItems(response, results);
}}, {
name: `${listWidget.dataType}DontHearPastThree`,
expecting: ['No'],
resolve: (response) => {
response.addGoal(`interactWith${listWidget.dataType}`);
}}]
});
violet.defineGoal({
goal: `hearPastTen${listWidget.dataType}`,
prompt: [`Do you want to hear more ${listWidget.humanNamePl}?`],
respondTo: [{
name: `${listWidget.dataType}YesHearPastTen`,
expecting: ['Yes'],
resolve: (response) => {
response.say(`Getting more ${listWidget.humanNamePl}.`);
var results = response.get(dataType);
listWidget.respondWithMoreItems(response, results, 10);
}}, {
name: `${listWidget.dataType}DontHearPastTen`,
expecting: ['No'],
resolve: (response) => {
response.addGoal(`interactWith${listWidget.dataType}`);
}}]
});
var ifDoc = FlowScriptCompiler.load(interactionFlow);
ifDoc.selector('decision')[0].setAttrib('id', listWidget.interactionGoal());
// FlowScriptCompiler.dump(ifDoc);
FlowScriptCompiler.compile(ifDoc, violet.getScriptControllers(), violet, 'listWidget');
FlowScriptCompiler.registerNonNestableWidgetImpl(widgetType, (response, flowScriptDoc, elNode)=>{
var data = response.get(dataType);
listWidget.respondWithItems(response, data);
});
return listWidget;
}
};
};