Support for rich messages

Author: treml

index.js

@@ -1,8 +1,20 @@
-const DirectLine = require('botframework-directlinejs').DirectLine
+const mime = require('mime-types')
+const { DirectLine, ConnectionStatus } = require('botframework-directlinejs')
 const debug = require('debug')('botium-connector-directline3')
 
 global.XMLHttpRequest = require('xhr2')
 
+const Capabilities = {
+  DIRECTLINE3_SECRET: 'DIRECTLINE3_SECRET',
+  DIRECTLINE3_WEBSOCKET: 'DIRECTLINE3_WEBSOCKET',
+  DIRECTLINE3_POLLINGINTERVAL: 'DIRECTLINE3_POLLINGINTERVAL'
+}
+
+const Defaults = {
+  [Capabilities.DIRECTLINE3_WEBSOCKET]: true,
+  [Capabilities.DIRECTLINE3_POLLINGINTERVAL]: 1000
+}
+
 class BotiumConnectorDirectline3 {
   constructor ({ queueBotSays, caps }) {
     this.queueBotSays = queueBotSays
@@ -11,6 +23,8 @@ class BotiumConnectorDirectline3 {
 
   Validate () {
     debug('Validate called')
+    this.caps = Object.assign({}, Defaults, this.caps)
+
     if (!this.caps['DIRECTLINE3_SECRET']) throw new Error('DIRECTLINE3_SECRET capability required')
 
     return Promise.resolve()
@@ -39,13 +53,81 @@ class BotiumConnectorDirectline3 {
           if (this.receivedMessageIds[message.id]) {
             debug('ignore already received message ', message)
           } else {
-            debug('received message ', message)
+            debug('received message ', JSON.stringify(message, null, 2))
             this.receivedMessageIds[message.id] = true
-            const botMsg = { sender: 'bot', sourceData: message, messageText: message.text }
+            const botMsg = { sender: 'bot', sourceData: message, media: [], buttons: [], cards: [] }
+            botMsg.messageText = message.text || null
+
+            const mapButton = (b) => ({
+              text: b.title,
+              payload: b.value,
+              imageUri: b.image
+            })
+            const mapImage = (i) => ({
+              mediaUri: i.url,
+              mimeType: mime.lookup(i.url) || 'application/unknown',
+              altText: i.alt
+            })
+            const mapMedia = (m) => ({
+              mediaUri: m.url,
+              mimeType: mime.lookup(m.url) || 'application/unknown',
+              altText: m.profile
+            })
+
+            message.attachments && message.attachments.forEach(a => {
+              if (a.contentType === 'application/vnd.microsoft.card.hero') {
+                botMsg.cards.push({
+                  text: a.content.title,
+                  image: a.content.images && a.content.images.length > 0 && [ mapImage(a.content.images[0]) ],
+                  buttons: a.content.buttons && a.content.buttons.map(mapButton)
+                })
+              } else if (a.contentType === 'application/vnd.microsoft.card.adaptive') {
+                // TODO
+              } else if (a.contentType === 'application/vnd.microsoft.card.animation' ||
+                a.contentType === 'application/vnd.microsoft.card.audio' ||
+                a.contentType === 'application/vnd.microsoft.card.video') {
+                botMsg.media = botMsg.media.concat(a.content.media && a.content.media.map(mapMedia))
+                botMsg.buttons = botMsg.buttons.concat(a.content.buttons && a.content.buttons.map(mapButton))
+              } else if (a.contentType === 'application/vnd.microsoft.card.thumbnail') {
+                botMsg.media = botMsg.media.concat(a.content.images && a.content.images.map(mapImage))
+                botMsg.buttons = botMsg.buttons.concat(a.content.buttons && a.content.buttons.map(mapButton))
+              } else if (a.contentType && a.contentUrl) {
+                botMsg.media.push({
+                  mediaUri: a.contentUrl,
+                  mimeType: a.contentType,
+                  altText: a.name
+                })
+              }
+            })
+
             this.queueBotSays(botMsg)
           }
         }
       )
+    this.connSubscription = this.directLine.connectionStatus$
+      .subscribe(connectionStatus => {
+        switch (connectionStatus) {
+          case ConnectionStatus.Uninitialized:
+            debug(`Directline Connection Status: ${connectionStatus} / Uninitialized`)
+            break
+          case ConnectionStatus.Connecting:
+            debug(`Directline Connection Status: ${connectionStatus} / Connecting`)
+            break
+          case ConnectionStatus.Online:
+            debug(`Directline Connection Status: ${connectionStatus} / Online`)
+            break
+          case ConnectionStatus.ExpiredToken:
+            debug(`Directline Connection Status: ${connectionStatus} / ExpiredToken`)
+            break
+          case ConnectionStatus.FailedToConnect:
+            debug(`Directline Connection Status: ${connectionStatus} / FailedToConnect`)
+            break
+          case ConnectionStatus.Ended:
+            debug(`Directline Connection Status: ${connectionStatus} / Ended`)
+            break
+        }
+      })
+
     return Promise.resolve()
   }
 
@@ -83,10 +165,15 @@ class BotiumConnectorDirectline3 {
 
   _stopSubscription () {
     if (this.subscription) {
-      debug('unsubscribing from directline subscription')
+      debug('unsubscribing from directline activity subscription')
       this.subscription.unsubscribe()
       this.subscription = null
     }
+    if (this.connSubscription) {
+      debug('unsubscribing from directline connectionstatus subscription')
+      this.connSubscription.unsubscribe()
+      this.connSubscription = null
+    }
   }
 }
 

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "botium-connector-directline3",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Botium Connector for Bot Framework Direct Line 3 API",
   "main": "dist/botium-connector-directline3-cjs.js",
   "module": "dist/botium-connector-directline3-es.js",
@@ -32,8 +32,9 @@
     "rollup-plugin-node-resolve": "^3.3.0"
   },
   "dependencies": {
-    "botframework-directlinejs": "^0.9.15",
+    "botframework-directlinejs": "^0.9.17",
     "debug": "^3.1.0",
+    "mime-types": "^2.1.20",
     "xhr2": "^0.1.4"
   }
 }

package.json

@@ -3,7 +3,7 @@
     "Capabilities": {
       "PROJECTNAME": "Directline3 Plugin Sample",
       "CONTAINERMODE": "directline3",
-      "DIRECTLINE3_SECRET": "zzeQkmbq1Ow.cwA.a4U.tYSACzDiYQ0t-Bu2oJlZp1C33787DnISOSi85hZMAdA",
+      "DIRECTLINE3_SECRET": "my-directline-secret",
       "DIRECTLINE3_WEBSOCKET": true,
       "DIRECTLINE3_POLLINGINTERVAL": 1000
     }

samples/botium.json

@@ -1,13 +1,14 @@
 const BotDriver = require('botium-core').BotDriver
 
 const driver = new BotDriver()
-  
- driver.BuildFluent()
+
+driver.BuildFluent()
   .Start()
-  .UserSaysText('Start')
-  .WaitBotSaysText(console.log)
-  .UserSaysText('Hallo')
+  .UserSaysText('Hello')
   .WaitBotSaysText(console.log)
+  .WaitBotSays((msg) => console.log(JSON.stringify(msg, null, 2)))
+  .WaitBotSays((msg) => console.log(JSON.stringify(msg, null, 2)))
+  .WaitBotSays((msg) => console.log(JSON.stringify(msg, null, 2)))
   .Stop()
   .Clean()
   .Exec()
@@ -16,4 +17,4 @@ const driver = new BotDriver()
   })
   .catch((err) => {
     console.log('ERROR: ', err)
-  })  
+  })

samples/botiumFluent.js

@@ -11,6 +11,6 @@
   "license": "ISC",
   "dependencies": {
     "botium-connector-directline3": "../",
-    "botium-core": "^1.3.18"
+    "botium-core": "*"
   }
 }