voxa/src/platforms/dialogflow/google/GoogleAssistantPlatform.ts

A fsm (state machine) framework for Alexa, Dialogflow, Facebook Messenger and Botframework apps using Node.js

/*
 * Copyright (c) 2019 Rain Agency <contact@rain.agency>
 * Author: Rain Agency <contact@rain.agency>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
 * the Software, and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
 * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
 * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 */

import * as _ from "lodash";
import { IDirectiveClass } from "../../../directives";
import { ITransition } from "../../../StateMachine";
import { VoxaApp } from "../../../VoxaApp";
import { IVoxaEvent } from "../../../VoxaEvent";
import { IVoxaReply } from "../../../VoxaReply";
import { IVoxaPlatformConfig } from "../../VoxaPlatform";
import { DialogflowPlatform } from "../DialogflowPlatform";
import { DialogflowReply } from "../DialogflowReply";
import { ITransactionOptions } from "./apis/ITransactionOptions";
import {
  AccountLinkingCard,
  BasicCard,
  BrowseCarousel,
  Carousel,
  CompletePurchase,
  Confirmation,
  Context,
  DateTime,
  DeepLink,
  LinkOutSuggestion,
  List,
  MediaResponse,
  NewSurface,
  Permission,
  Place,
  RegisterUpdate,
  Say,
  SessionEntity,
  Suggestions,
  Table,
  TransactionDecision,
  TransactionRequirements,
  UpdatePermission,
} from "./directives";
import { GoogleAssistantEvent } from "./GoogleAssistantEvent";

export interface IGoogleAssistantPlatformConfig extends IVoxaPlatformConfig {
  clientId?: string; // id used to verify user's identify from Google Sign-In
  transactionOptions?: ITransactionOptions; // transaction configuration object for purchases
}

export class GoogleAssistantPlatform extends DialogflowPlatform {
  public name = "google";
  protected EventClass = GoogleAssistantEvent;

  constructor(app: VoxaApp, config: IGoogleAssistantPlatformConfig = {}) {
    super(app, config);
    app.onBeforeReplySent(this.saveStorage, true, this.name);
  }

  protected getReply() {
    return new DialogflowReply();
  }

  protected saveStorage(
    voxaEvent: IVoxaEvent,
    reply: IVoxaReply,
    transition: ITransition,
  ) {
    const { conv } = (voxaEvent as GoogleAssistantEvent).dialogflow;
    const dialogflowReply = reply as DialogflowReply;

    if (_.isEmpty(conv.user.storage)) {
      dialogflowReply.payload.google.resetUserStorage = true;
      delete dialogflowReply.payload.google.userStorage;
    } else {
      dialogflowReply.payload.google.userStorage = conv.user._serialize();
    }
  }

  protected getDirectiveHandlers(): IDirectiveClass[] {
    return [
      AccountLinkingCard,
      BasicCard,
      BrowseCarousel,
      Carousel,
      CompletePurchase,
      Confirmation,
      Context,
      DateTime,
      DeepLink,
      LinkOutSuggestion,
      List,
      MediaResponse,
      Permission,
      NewSurface,
      Place,
      RegisterUpdate,
      Suggestions,
      Table,
      TransactionDecision,
      TransactionRequirements,
      UpdatePermission,
      Say,
      SessionEntity,
    ];
  }
}