Additional modes (#39)

* Detect and handle SIGN_IN intent
* Detect and handle NEW_SURFACE intent

Author: adamcohenrose

src/actions-on-google.ts

@@ -47,6 +47,11 @@ i18n.configure({
     defaultLocale: DEFAULT_LOCALE,
 })
 
+const INTENT_NAMES = {
+  NEW_SURFACE: 'actions.intent.NEW_SURFACE',
+  SIGN_IN: 'actions.intent.SIGN_IN',
+}
+
 const PROTO_ROOT_DIR = protoFiles.getProtoPath('..')
 const embeddedAssistantPb = grpc.load({
     root: PROTO_ROOT_DIR,
@@ -232,7 +237,13 @@ export interface AssistResponse {
         headers: string[],
         rows: AssistResponseTableRow[],
     }
+    newSurface?: {
+        capabilities: string[],
+        context: string,
+        notificationTitle: string,
+    }
     deviceAction?: string
+    signInIntent?: boolean
 }
 
 /**
@@ -531,6 +542,12 @@ export class ActionsOnGoogle {
                     if (possibleIntents) {
                         const possibleIntent = possibleIntents[0]
                         const inputValueData = possibleIntent.inputValueData
+                        if (possibleIntent.intent === INTENT_NAMES.SIGN_IN) {
+                            assistResponse.signInIntent = true
+                        } else if (possibleIntent.intent === INTENT_NAMES.NEW_SURFACE) {
+                            const { capabilities, context, notificationTitle } = inputValueData
+                            assistResponse.newSurface = { capabilities, context, notificationTitle }
+                        }
                         if (inputValueData) {
                             const carouselSelect = inputValueData.carouselSelect
                             const listSelect = inputValueData.listSelect

src/test/expected.ts

@@ -860,4 +860,82 @@ export const CONVERSATION_TABLE = {
     },
   },
   userStorage: '{\"data\":{}}',
-}
+}
+
+export const CONVERSATION_SIGN_IN = {
+  conversationToken: '[\"_actions_on_google\"]',
+  expectUserResponse: true,
+  expectedInputs: [
+    {
+      inputPrompt: {
+        richInitialPrompt: {
+          items: [
+            {
+              simpleResponse: {
+                textToSpeech: 'You\'ll need to sign in',
+              },
+            },
+          ],
+        },
+      },
+      possibleIntents: [
+        {
+          intent: 'actions.intent.SIGN_IN',
+          inputValueData: {
+            '@type': 'type.googleapis.com/google.actions.v2.SignInValueSpec',
+          },
+        },
+      ],
+    },
+  ],
+  responseMetadata: {
+    status: {
+      message: 'Success (200)',
+    },
+    queryMatchInfo: {
+      queryMatched: true,
+      intent: '4aca4776-5110-4f19-a76c-d96d7f4d5b18',
+    },
+  },
+  userStorage: '{\data\:{}}',
+}
+
+export const CONVERSATION_NEW_SURFACE = {
+  conversationToken: '[\"_actions_on_google\"]',
+  expectUserResponse: true,
+  expectedInputs: [
+    {
+      inputPrompt: {
+        richInitialPrompt: {
+          items: [
+            {
+              simpleResponse: {
+                textToSpeech: 'I\u0027m sorry. I\u0027m having trouble connecting to your account. Please try again later.',
+              },
+            },
+          ],
+        },
+      },
+      possibleIntents: [
+        {
+          intent: 'actions.intent.NEW_SURFACE',
+          inputValueData: {
+            '@type': 'type.googleapis.com/google.actions.v2.NewSurfaceValueSpec',
+            capabilities: ['actions.capability.SCREEN_OUTPUT'],
+            context: 'There is more information available.',
+            notificationTitle: 'Transferring to your phone',
+          },
+        },
+      ],
+    },
+  ],
+  responseMetadata: {
+    status: {
+      message: 'Success (200)',
+    },
+    queryMatchInfo: {
+      queryMatched: true,
+      intent: 'a457499e-b810-4aa7-b523-2ac5fa6b7e48',
+    },
+  },
+}

src/test/test.ts

@@ -381,3 +381,35 @@ test.serial('verifies parsing a table', t => {
       mockResponse.restore()
     })
 })
+
+test.serial('verifies parsing a sign in intent', t => {
+  const action = new ActionsOnGoogleAva(testCredentials)
+  const mockResponse = sinon.stub(action._client, 'assist')
+  mockResponse.callsFake(() => {
+    const conversation = getMockConversation(Sample.CONVERSATION_SIGN_IN)
+    return conversation
+  })
+
+  return action!.start('')
+    .then((res: AssistResponse) => {
+      t.is(res.signInIntent, true)
+      mockResponse.restore()
+    })
+})
+
+test.serial('verifies parsing a new surface intent', t => {
+  const action = new ActionsOnGoogleAva(testCredentials)
+  const mockResponse = sinon.stub(action._client, 'assist')
+  mockResponse.callsFake(() => {
+    const conversation = getMockConversation(Sample.CONVERSATION_NEW_SURFACE)
+    return conversation
+  })
+
+  return action!.start('')
+    .then((res: AssistResponse) => {
+      t.deepEqual(res.newSurface!.capabilities, ['actions.capability.SCREEN_OUTPUT'])
+      t.is(res.newSurface!.context, 'There is more information available.')
+      t.is(res.newSurface!.notificationTitle, 'Transferring to your phone')
+      mockResponse.restore()
+    })
+})