Adding a new IVoxaIntentEvent interface (#157)

* Adding a new IVoxaIntentEvent interface

* Couple lint fixes

hello-world/hello-world.js

@@ -52,10 +52,6 @@ app.onBeforeReplySent(request => {
 });
 
 app.onState("likesVoxa?", request => {
-  if (!request.intent) {
-    throw new Error("Not an intent request");
-  }
-
   if (request.intent.name === "YesIntent") {
     return { tell: "doesLikeVoxa" };
   }

src/StateMachine/StateMachine.ts

@@ -24,7 +24,7 @@ import * as bluebird from "bluebird";
 import * as _ from "lodash";
 
 import { UnhandledState, UnknownState } from "../errors";
-import { IVoxaEvent, IVoxaIntent } from "../VoxaEvent";
+import { IVoxaIntent, IVoxaIntentEvent } from "../VoxaEvent";
 import { IVoxaReply } from "../VoxaReply";
 import {
   isState,
@@ -35,18 +35,18 @@ import {
 } from "./transitions";
 
 export type IStateMachineCb = (
-  event: IVoxaEvent,
+  event: IVoxaIntentEvent,
   reply: IVoxaReply,
   transition: ITransition,
 ) => Promise<ITransition>;
 
 export type IUnhandledStateCb = (
-  event: IVoxaEvent,
+  event: IVoxaIntentEvent,
   stateName: string,
 ) => Promise<ITransition>;
 
 export type IOnBeforeStateChangedCB = (
-  event: IVoxaEvent,
+  event: IVoxaIntentEvent,
   reply: IVoxaReply,
   state: IState,
 ) => Promise<void>;
@@ -95,7 +95,7 @@ export class StateMachine {
    * we use the onUnhandledState handler
    */
   public async checkOnUnhandledState(
-    voxaEvent: IVoxaEvent,
+    voxaEvent: IVoxaIntentEvent,
     voxaReply: IVoxaReply,
     transition: ITransition,
   ): Promise<ITransition> {
@@ -131,7 +131,7 @@ export class StateMachine {
    * in the entry controller
    */
   public async checkForEntryFallback(
-    voxaEvent: IVoxaEvent,
+    voxaEvent: IVoxaIntentEvent,
     reply: IVoxaReply,
     transition: ITransition,
   ): Promise<ITransition> {
@@ -142,10 +142,6 @@ export class StateMachine {
 
     if (!transition && this.currentState.name !== "entry") {
       // If no response try falling back to entry
-      if (!voxaEvent.intent) {
-        throw new Error("Running the state machine without an intent");
-      }
-
       voxaEvent.log.debug(
         `No reply for ${voxaEvent.intent.name} in [${
           this.currentState.name
@@ -159,7 +155,7 @@ export class StateMachine {
   }
 
   public async onAfterStateChanged(
-    voxaEvent: IVoxaEvent,
+    voxaEvent: IVoxaIntentEvent,
     reply: IVoxaReply,
     transition: ITransition,
   ): Promise<ITransition> {
@@ -185,7 +181,7 @@ export class StateMachine {
 
   public async runTransition(
     currentStateName: string,
-    voxaEvent: IVoxaEvent,
+    voxaEvent: IVoxaIntentEvent,
     reply: IVoxaReply,
   ): Promise<ITransition> {
     this.currentState = this.getCurrentState(
@@ -231,7 +227,7 @@ export class StateMachine {
   }
 
   public async runCurrentState(
-    voxaEvent: IVoxaEvent,
+    voxaEvent: IVoxaIntentEvent,
     reply: IVoxaReply,
   ): Promise<ITransition> {
     if (!voxaEvent.intent) {
@@ -307,7 +303,7 @@ export class StateMachine {
     return { to: dest };
   }
 
-  protected runCallbacks(fn: IUnhandledStateCb, voxaEvent: IVoxaEvent) {
+  protected runCallbacks(fn: IUnhandledStateCb, voxaEvent: IVoxaIntentEvent) {
     if (!isState(this.currentState)) {
       throw new Error("this.currentState is not a state");
     }
@@ -328,7 +324,7 @@ export class StateMachine {
   }
 
   protected async runOnBeforeStateChanged(
-    voxaEvent: IVoxaEvent,
+    voxaEvent: IVoxaIntentEvent,
     reply: IVoxaReply,
   ) {
     const onBeforeState = this.onBeforeStateChangedCallbacks;
@@ -345,7 +341,7 @@ export class StateMachine {
 
   protected getFinalTransition(
     sysTransition: SystemTransition,
-    voxaEvent: IVoxaEvent,
+    voxaEvent: IVoxaIntentEvent,
     reply: IVoxaReply,
   ) {
     let to;

src/VoxaApp.ts

@@ -51,7 +51,7 @@ import {
   ITransition,
   StateMachine,
 } from "./StateMachine";
-import { IBag, IVoxaEvent } from "./VoxaEvent";
+import { IBag, IVoxaEvent, IVoxaIntentEvent } from "./VoxaEvent";
 import { IVoxaReply } from "./VoxaReply";
 
 export interface IVoxaAppConfig extends IRendererConfig {
@@ -153,7 +153,7 @@ export class VoxaApp {
   }
 
   public async handleOnSessionEnded(
-    event: IVoxaEvent,
+    event: IVoxaIntentEvent,
     response: IVoxaReply,
   ): Promise<IVoxaReply> {
     const sessionEndedHandlers = this.getOnSessionEndedHandlers(
@@ -221,11 +221,13 @@ export class VoxaApp {
               },
             );
 
-            // call all onSessionStarted callbacks serially.
-            await bluebird.mapSeries(
-              this.getOnSessionStartedHandlers(voxaEvent.platform.name),
-              (fn: IEventHandler) => fn(voxaEvent, reply),
-            );
+            if (voxaEvent.session.new) {
+              // call all onSessionStarted callbacks serially.
+              await bluebird.mapSeries(
+                this.getOnSessionStartedHandlers(voxaEvent.platform.name),
+                (fn: IEventHandler) => fn(voxaEvent, reply),
+              );
+            }
             // Route the request to the proper handler which may have been overriden.
             return await requestHandler(voxaEvent, reply);
           }
@@ -428,7 +430,7 @@ export class VoxaApp {
   }
 
   public async runStateMachine(
-    voxaEvent: IVoxaEvent,
+    voxaEvent: IVoxaIntentEvent,
     response: IVoxaReply,
   ): Promise<IVoxaReply> {
     let fromState = voxaEvent.session.new
@@ -487,16 +489,18 @@ export class VoxaApp {
     const directivesKeyOrder = _.map(directiveClasses, "key");
     if (transition.reply) {
       // special handling for `transition.reply`
-      const reply = await voxaEvent.t(transition.reply, {
-        returnObjects: true,
-      });
+      const reply = await voxaEvent.renderer.renderPath(
+        transition.reply,
+        voxaEvent,
+      );
       const replyKeys = _.keys(reply);
       const replyTransition = _(replyKeys)
         .map((key) => {
           return [key, transition.reply + "." + key];
         })
         .fromPairs()
         .value();
+
       transition = _.merge({}, transition, replyTransition);
     }
 

src/VoxaEvent.ts

@@ -39,10 +39,29 @@ export interface IVoxaRequest {
 }
 
 export interface IVoxaEventClass {
-  new(rawEvent: any, logOptions: LambdaLogOptions, context: any): IVoxaEvent;
+  new (rawEvent: any, logOptions: LambdaLogOptions, context: any): IVoxaEvent;
 }
 
-export abstract class IVoxaEvent {
+export interface IVoxaIntentEvent extends IVoxaEvent {
+  intent: IVoxaIntent;
+}
+
+export interface IVoxaEvent {
+  rawEvent: any; // the raw event as sent by the service
+  session: IVoxaSession;
+  intent?: IVoxaIntent;
+  request: IVoxaRequest;
+  model: Model;
+  t: i18n.TranslationFunction;
+  log: LambdaLog;
+  renderer: Renderer;
+  user: IVoxaUser;
+  platform: VoxaPlatform;
+  supportedInterfaces: string[];
+  executionContext?: AWSLambdaContext | AzureContext;
+}
+
+export abstract class VoxaEvent implements IVoxaEvent {
   public abstract get supportedInterfaces(): string[];
   public rawEvent: any; // the raw event as sent by the service
   public session!: IVoxaSession;

src/errors/UnhandledState.ts

@@ -20,14 +20,14 @@
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
-import { IVoxaEvent } from "../VoxaEvent";
+import { IVoxaIntentEvent } from "../VoxaEvent";
 
 export class UnhandledState extends Error {
-  public voxaEvent: IVoxaEvent;
+  public voxaEvent: IVoxaIntentEvent;
   public fromState: string;
   public transition: any;
 
-  constructor(voxaEvent: IVoxaEvent, transition: any, fromState: string) {
+  constructor(voxaEvent: IVoxaIntentEvent, transition: any, fromState: string) {
     let message: string;
     if (voxaEvent.intent) {
       message = `${voxaEvent.intent.name} went unhandled on ${fromState} state`;

src/index.ts

@@ -7,7 +7,7 @@
 
 export { Tell, Say, SayP, Ask, Reprompt } from "./directives";
 export { VoxaPlatform } from "./platforms";
-export { IVoxaEvent, IVoxaIntent } from "./VoxaEvent";
+export { IVoxaEvent, IVoxaIntentEvent, IVoxaIntent } from "./VoxaEvent";
 export { IVoxaReply } from "./VoxaReply";
 export {
   AlexaReply,

src/platforms/alexa/AlexaEvent.ts

@@ -20,12 +20,17 @@
  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  */
 
-import { RequestEnvelope, User as IAlexaUser } from "ask-sdk-model";
+import {
+  canfulfill,
+  IntentRequest,
+  RequestEnvelope,
+  User as IAlexaUser,
+} from "ask-sdk-model";
 import { Context as AWSLambdaContext } from "aws-lambda";
 import { Context as AzureContext } from "azure-functions-ts-essentials";
 import { LambdaLogOptions } from "lambda-log";
 import * as _ from "lodash";
-import { IVoxaEvent, IVoxaIntent, IVoxaSession } from "../../VoxaEvent";
+import { IVoxaIntent, VoxaEvent } from "../../VoxaEvent";
 import { AlexaIntent } from "./AlexaIntent";
 import {
   CustomerContact,
@@ -35,8 +40,9 @@ import {
   Lists,
 } from "./apis";
 
-export class AlexaEvent extends IVoxaEvent {
-  public intent!: IVoxaIntent;
+export class AlexaEvent extends VoxaEvent {
+  public intent?: IVoxaIntent;
+  public rawEvent!: RequestEnvelope;
   public alexa!: {
     customerContact: CustomerContact;
     deviceAddress: DeviceAddress;
@@ -46,25 +52,10 @@ export class AlexaEvent extends IVoxaEvent {
   };
 
   public requestToIntent: any = {
-    "AlexaSkillEvent.SkillDisabled": "AlexaSkillEvent.SkillDisabled",
-    "AlexaSkillEvent.SkillEnabled": "AlexaSkillEvent.SkillEnabled",
-    "AudioPlayer.PlaybackFailed": "AudioPlayer.PlaybackFailed",
-    "AudioPlayer.PlaybackFinished": "AudioPlayer.PlaybackFinished",
-    "AudioPlayer.PlaybackNearlyFinished": "AudioPlayer.PlaybackNearlyFinished",
-    "AudioPlayer.PlaybackStarted": "AudioPlayer.PlaybackStarted",
-    "AudioPlayer.PlaybackStopped": "AudioPlayer.PlaybackStopped",
     "Connections.Response": "Connections.Response",
     "Display.ElementSelected": "Display.ElementSelected",
     "GameEngine.InputHandlerEvent": "GameEngine.InputHandlerEvent",
     "LaunchRequest": "LaunchIntent",
-    "PlaybackController.NextCommandIssued":
-      "PlaybackController.NextCommandIssued",
-    "PlaybackController.PauseCommandIssued":
-      "PlaybackController.PauseCommandIssued",
-    "PlaybackController.PlayCommandIssued":
-      "PlaybackController.PlayCommandIssued",
-    "PlaybackController.PreviousCommandIssued":
-      "PlaybackController.PreviousCommandIssued",
   };
 
   constructor(
@@ -134,13 +125,18 @@ export class AlexaEvent extends IVoxaEvent {
   }
 
   protected initIntents() {
-    if (
-      _.includes(
-        ["IntentRequest", "CanFulfillIntentRequest"],
-        this.request.type,
-      )
-    ) {
-      this.intent = new AlexaIntent(this.rawEvent.request.intent);
+    const { request } = this.rawEvent;
+    if (isIntentRequest(request)) {
+      this.intent = new AlexaIntent(request.intent);
     }
   }
 }
+
+function isIntentRequest(
+  request: any,
+): request is IntentRequest | canfulfill.CanFulfillIntentRequest {
+  return (
+    request.type === "IntentRequest" ||
+    request.type === "CanFulfillIntentRequest"
+  );
+}

src/platforms/alexa/AlexaPlatform.ts

@@ -26,7 +26,7 @@ import { Context as AzureContext } from "azure-functions-ts-essentials";
 import * as _ from "lodash";
 import { OnSessionEndedError } from "../../errors";
 import { VoxaApp } from "../../VoxaApp";
-import { IVoxaEvent } from "../../VoxaEvent";
+import { IVoxaEvent, IVoxaIntentEvent } from "../../VoxaEvent";
 import { IVoxaReply } from "../../VoxaReply";
 import { IVoxaPlatformConfig, VoxaPlatform } from "../VoxaPlatform";
 import { AlexaEvent } from "./AlexaEvent";
@@ -86,7 +86,7 @@ export class AlexaPlatform extends VoxaPlatform {
     this.config = config;
 
     this.app.onCanFulfillIntentRequest(
-      (event: AlexaEvent, reply: AlexaReply) => {
+      (event: IVoxaIntentEvent, reply: AlexaReply) => {
         if (_.includes(this.config.defaultFulfillIntents, event.intent.name)) {
           reply.fulfillIntent("YES");
 
@@ -141,13 +141,9 @@ export class AlexaPlatform extends VoxaPlatform {
   }
 
   protected checkSessionEndedRequest(alexaEvent: AlexaEvent): void {
-    if (
-      alexaEvent.request.type === "SessionEndedRequest" &&
-      alexaEvent.rawEvent.request.reason === "ERROR"
-    ) {
-      throw new OnSessionEndedError(
-        _.get(alexaEvent.rawEvent, "request.error"),
-      );
+    const { request } = alexaEvent.rawEvent;
+    if (request.type === "SessionEndedRequest" && request.reason === "ERROR") {
+      throw new OnSessionEndedError(request.error);
     }
   }
 

src/platforms/botframework/BotFrameworkEvent.ts

@@ -9,7 +9,7 @@ import {
 } from "botbuilder";
 import { LambdaLogOptions } from "lambda-log";
 import * as _ from "lodash";
-import { ITypeMap, IVoxaEvent, IVoxaIntent, IVoxaUser } from "../../VoxaEvent";
+import { ITypeMap, IVoxaIntent, IVoxaUser, VoxaEvent } from "../../VoxaEvent";
 
 const MicrosoftCortanaIntents: ITypeMap = {
   "Microsoft.Launch": "LaunchIntent",
@@ -23,7 +23,7 @@ export interface IBotframeworkPayload {
   intent?: IVoxaIntent;
 }
 
-export class BotFrameworkEvent extends IVoxaEvent {
+export class BotFrameworkEvent extends VoxaEvent {
   public rawEvent!: IBotframeworkPayload;
 
   public requestToRequest: ITypeMap = {