scure-dialogflow/src/lib/common.js

Javascript engine for creating conversational adventures with Dialogflow / GoogleAssistant through SCURE

const forceItemsToBeArray = (items) => {
  if (items && typeof items === 'object' && typeof items.length === 'number') return items;
  return [items];
};

const substitute = (sentence, args) => {
  const replacer = (s1, s2) => s1.replace(`{${s2}}`, args[s2]);
  return Object.keys(args).reduce(replacer, sentence);
};

exports.getArgument = (args, argName) => {
  const value = args[argName];
  if (!value) return null;
  if (typeof value === 'object' && typeof value.length === 'number') return value[0];
  return value;
};

exports.getArgumentList = (args, argName) => forceItemsToBeArray(args[argName]);

exports.isEmptyArg = (arg) => {
  if (!arg) return true;
  if (typeof arg.length !== 'undefined' && arg.length === 0) return true;
  if (JSON.stringify(arg).trim() === '[]') return true;
  if (JSON.stringify(arg).trim() === '{}') return true;
  if (arg.trim && (arg.trim() === '')) return true;
  return false;
};

exports.overwriteDataFrom = (scureResponse, conv) => {
  if (scureResponse.data) {
    conv.data = scureResponse.data;
  }
};

exports.isTimeOver = (data, scure) => {
  const startTime = new Date(JSON.parse(data.startTime || JSON.stringify(new Date())));
  const currentTime = new Date();
  return (currentTime.getTime() - startTime.getTime()) > (scure.data.init.totalMinutes * 60 * 1000);
};

exports.cleanData = (conv) => {
  conv.data.numCommands = 0;
  conv.data.roomId = null;
  conv.data.startTime = null;
  conv.data.inventory = [];
  conv.data.picked = [];
  return conv;
};

exports.baseChars = str => str.toLowerCase().replace(/[áäàÀÁÂÃÄÅ]/g, 'a')
  .replace(/[èéèÈÉÊË]/g, 'e')
  .replace(/[íìIÎ]/g, 'i')
  .replace(/[óòÓÔ]/g, 'o')
  .replace(/[úùüÙ]/g, 'u')
  .replace(/[çÇ]/g, 'c')
  .replace(/[ñÑ]/g, 'n')
  .replace(/[-\\?]/g, '');

exports.processContext = (conv) => {
  if (conv.data.lastContext) {
    conv.contexts.set(conv.data.lastContext, 1);
    conv.contexts.set('use-followup', 1);
    conv.data.lastContext = undefined;
  }
};

const shouldNotIncludeQuestion = sentence =>
  (sentence.lastIndexOf('?') >= sentence.length - 10) || (sentence.indexOf('<speak>') >= 0);

const getFinalSentence = (scure, conv, finalSentence) => {
  const timeLeft = scure.getLeftTimeFrom(conv.data.startTime);
  const remainingTime =
    scure.sentences.get('ending-remaining-time', { timeLeft });
  return substitute(finalSentence.description, { remainingTime });
};

const speak = (sentence, conv) => {
  if ((sentence.indexOf("<audio") >= 0) && (sentence.indexOf("<speak") === -1)) {
    conv.ask(`<speak>${sentence}</speak>`);
  } else {
    conv.ask(`${sentence}`);
  }
};

exports.sendResponse = (conv, scure, scureResponse) => {
  const finalSentence = scureResponse.sentence;
  if (finalSentence.isEndingScene) {
    const finalWords = getFinalSentence(scure, conv, finalSentence);
    conv.close(finalWords);
  } else if (shouldNotIncludeQuestion(finalSentence)) {
    speak(finalSentence, conv);
  } else {
    const finalQuestion = scure.sentences.get('final-question');
    speak(`${finalSentence} ${finalQuestion}`, conv);
  }
};