omenocal / voxa-opearlo

An adapter that allows opearlo logging for Alexa skills implemented with voxa

Voxa Opearlo

An Opearlo plugin for voxa

Installation

Just install from npm

npm install --save voxa-opearlo

Usage

const voxaOpearlo = require('voxa-opearlo');

const opearloConfig = {
  userId: 'userId',
  appName: 'appName',
  apiKey: 'apiKey',
  suppressSending: false, // A flag to supress sending hits. Useful while developing on the skill
};

voxaOpearlo(skill, opearloConfig);

What you get

Once you register the Voxa plugin, it will handle logging all incoming intents automatically. Additionally, each state will be logged as a CustomEvent. Thus out of the box you'll get a pathway that looks like:

Suppressing State Events

Sometimes smaller intermediary states can flood the pathways diagram. Suppress a state from logging as follows:

skill.onState('my-state',alexaEvent => {
  alexaEvent.opearlo.ignore();
  return {reply: 'Greeting', to: 'my-next-state'};
})

Logging variables

You can also add additional values which will be logged along with the state custom event

skill.onState('my-state',alexaEvent => {
  alexaEvent.opearlo.variables.myVariable = 'hello'
  return {reply: 'Greeting', to: 'my-next-state'};
})

Custom Events

You can also log custom events from a state.

skill.onState('my-state',alexaEvent => {
  alexaEvent.opearlo.log('my-custom-event',{myVariable: 'hello'});
  return {reply: 'Greeting', to: 'my-next-state'};
})