Merge pull request #36 from codeforequity-at/develop

Version 0.0.16

Author: Botium

README.md

@@ -89,6 +89,19 @@ The parameters are:
 2. The path to the activity field
 3. The value of the activity field
 
+Another option for having full control over the activity is to use the **DIRECTLINE3_ACTIVITY_TEMPLATE** capability. It is a JSON structure used as a template when sending an activity to the bot.
+
+```
+    ...
+    "DIRECTLINE3_ACTIVITY_TEMPLATE": {
+      "channelData": {
+        "my-special-channel-data": "..."
+      }
+    }
+    ...
+```
+
+
 ## Supported Capabilities
 
 Set the capability __CONTAINERMODE__ to __directline3__ to activate this connector.
@@ -143,6 +156,11 @@ When using activity types other than _message_, this capability maps the activit
 
 By default, for _event_ activities the _name_ attribute is used as message text, for other activity types the activity type itself.
 
+### DIRECTLINE3_ACTIVITY_TEMPLATE
+_default: {}_
+
+JSON object holding the activity template used for sending activities to the bot.
+
 # Current Restrictions
 
 * Only HTTP Polling supported (WebSocket not available in Node.js)

index.js

@@ -25,7 +25,8 @@ const Capabilities = {
   DIRECTLINE3_BUTTON_TYPE: 'DIRECTLINE3_BUTTON_TYPE',
   DIRECTLINE3_BUTTON_VALUE_FIELD: 'DIRECTLINE3_BUTTON_VALUE_FIELD',
   DIRECTLINE3_HANDLE_ACTIVITY_TYPES: 'DIRECTLINE3_HANDLE_ACTIVITY_TYPES',
-  DIRECTLINE3_ACTIVITY_VALUE_MAP: 'DIRECTLINE3_ACTIVITY_VALUE_MAP'
+  DIRECTLINE3_ACTIVITY_VALUE_MAP: 'DIRECTLINE3_ACTIVITY_VALUE_MAP',
+  DIRECTLINE3_ACTIVITY_TEMPLATE: 'DIRECTLINE3_ACTIVITY_TEMPLATE'
 }
 
 const Defaults = {
@@ -56,6 +57,17 @@ class BotiumConnectorDirectline3 {
     if (!this.caps.DIRECTLINE3_BUTTON_VALUE_FIELD) throw new Error('DIRECTLINE3_BUTTON_VALUE_FIELD capability required')
     if (!this.caps.DIRECTLINE3_HANDLE_ACTIVITY_TYPES) throw new Error('DIRECTLINE3_HANDLE_ACTIVITY_TYPES capability required')
 
+    if (this.caps.DIRECTLINE3_ACTIVITY_VALUE_MAP) {
+      if (_.isString(this.caps.DIRECTLINE3_ACTIVITY_VALUE_MAP)) {
+        this.caps.DIRECTLINE3_ACTIVITY_VALUE_MAP = JSON.parse(this.caps.DIRECTLINE3_ACTIVITY_VALUE_MAP)
+      }
+    }
+    if (this.caps.DIRECTLINE3_ACTIVITY_TEMPLATE) {
+      if (_.isString(this.caps.DIRECTLINE3_ACTIVITY_TEMPLATE)) {
+        this.caps.DIRECTLINE3_ACTIVITY_TEMPLATE = JSON.parse(this.caps.DIRECTLINE3_ACTIVITY_TEMPLATE)
+      }
+    }
+
     return Promise.resolve()
   }
 
@@ -243,15 +255,15 @@ class BotiumConnectorDirectline3 {
   UserSays (msg) {
     debug('UserSays called')
     return new Promise(async (resolve, reject) => { // eslint-disable-line no-async-promise-executor
-      const activity = msg.sourceData || {}
+      const activity = Object.assign({}, msg.sourceData || this.caps.DIRECTLINE3_ACTIVITY_TEMPLATE || {})
       if (msg.buttons && msg.buttons.length > 0 && (msg.buttons[0].text || msg.buttons[0].payload)) {
         let payload = msg.buttons[0].payload || msg.buttons[0].text
         try {
           payload = JSON.parse(payload)
         } catch (err) {
         }
         activity.type = this.caps[Capabilities.DIRECTLINE3_BUTTON_TYPE]
-        activity[this.caps[Capabilities.DIRECTLINE3_BUTTON_VALUE_FIELD]] = payload
+        _.set(activity, this.caps[Capabilities.DIRECTLINE3_BUTTON_VALUE_FIELD], payload)
       } else {
         if (!activity.type) {
           activity.type = 'message'
@@ -265,9 +277,9 @@ class BotiumConnectorDirectline3 {
       }
 
       if (msg.forms) {
-        activity.value = {}
+        activity.value = activity.value || {}
         msg.forms.forEach(f => {
-          activity.value[f.name] = f.value
+          _.set(activity.value, f.name, f.value)
         })
       }
 
@@ -279,14 +291,14 @@ class BotiumConnectorDirectline3 {
 
       if (msg.media && msg.media.length > 0) {
         debug('Posting activity with attachments ', JSON.stringify(activity, null, 2))
+        msg.sourceData = Object.assign(msg.sourceData || {}, { activity })
+
         const formData = new FormData()
 
-        if (activity.text) {
-          formData.append('activity', Buffer.from(JSON.stringify(activity)), {
-            contentType: 'application/vnd.microsoft.activity',
-            filename: 'blob'
-          })
-        }
+        formData.append('activity', Buffer.from(JSON.stringify(activity)), {
+          contentType: 'application/vnd.microsoft.activity',
+          filename: 'blob'
+        })
 
         for (let i = 0; i < msg.media.length; i++) {
           const attachment = msg.media[i]
@@ -298,11 +310,11 @@ class BotiumConnectorDirectline3 {
               filename: attachmentName
             })
           } else {
-            const { body } = await fetch(attachment.mediaUri)
+            const res = await fetch(attachment.mediaUri)
+            const body = await res.buffer()
 
             formData.append('file', body, {
-              filename: attachmentName,
-              contentType: 'image/png'
+              filename: attachmentName
             })
           }
         }
@@ -313,8 +325,7 @@ class BotiumConnectorDirectline3 {
         fetch(uploadUrl, {
           method: 'POST',
           headers: {
-            Authorization: `Bearer ${this.directLine.token}`,
-            'Content-Type': 'multipart/form-data'
+            Authorization: `Bearer ${this.directLine.token}`
           },
           body: formData
         }).then(async (res) => {
@@ -327,10 +338,11 @@ class BotiumConnectorDirectline3 {
           }
         }).catch(err => {
           debug('Error posting activity with attachments', err)
-          reject(new Error(`Error posting activity: ${err.message}`))
+          reject(new Error(`Error posting activity: ${err.message || err}`))
         })
       } else {
         debug('Posting activity ', JSON.stringify(activity, null, 2))
+        msg.sourceData = Object.assign(msg.sourceData || {}, { activity })
 
         this.directLine.postActivity(activity).subscribe(
           id => {
@@ -339,7 +351,7 @@ class BotiumConnectorDirectline3 {
           },
           err => {
             debug('Error posting activity', err)
-            reject(new Error(`Error posting activity: ${err}`))
+            reject(new Error(`Error posting activity: ${err.message || err}`))
           }
         )
       }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "botium-connector-directline3",
-  "version": "0.0.15",
+  "version": "0.0.16",
   "description": "Botium Connector for Bot Framework Direct Line 3 API",
   "main": "dist/botium-connector-directline3-cjs.js",
   "module": "dist/botium-connector-directline3-es.js",

samples/convo/botium.json

@@ -6,7 +6,12 @@
       "DIRECTLINE3_SECRET": "my-directline-secret",
       "DIRECTLINE3_BUTTON_TYPE": "message",
       "DIRECTLINE3_BUTTON_VALUE_FIELD": "text",
-      "DIRECTLINE3_HANDLE_ACTIVITY_TYPES": "message,event"
+      "DIRECTLINE3_HANDLE_ACTIVITY_TYPES": "message,event",
+      "DIRECTLINE3_ACTIVITY_TEMPLATE": {
+        "channelData": {
+          "my-special-channel-data": "..."
+        }
+      }
     }
   }
 }