Merge pull request #2173 from botpress/fl_channel_teams

feat(channel-teams): added MS Teams channel

docs/guide/docs/channels/teams.md

@@ -0,0 +1,76 @@
+---
+id: teams
+title: Microsoft Teams
+---
+
+## Requirements
+
+- Microsoft account with access to Azure
+- Microsoft account with access to Teams
+- [Enable the `channel-teams` module](docs/next/main/module#enabling-or-disabling-modules)
+- Configured a valid **HTTPS** external url ([configuration](docs/advanced/configuration/#exposing-your-bot-on-the-internet))
+
+## Before getting started...
+
+Since the framework V4 is still in active development, some of these instructions may be a little bit different. If you ever get stuck, have a look at the [Official Bot Framework documentation](https://docs.microsoft.com/en-us/microsoftteams/platform/concepts/bots/bots-create).
+
+## Step by step instructions
+
+These instructions will guide you through any steps required to be up and running with that channel.
+
+### 1. Create a new application & generate a password
+
+1. Log on to your account on [Microsoft Azure](https://azure.microsoft.com)
+
+1. In the Azure portal, open the [App registrations](https://portal.azure.com/#blade/Microsoft_AAD_RegisteredApps/ApplicationsListBlade) page.
+
+1. Click on `New registration`, then choose a name for your application.
+
+1. In the section `Supported account types`, choose `Accounts in any organizational directory and personal Microsoft accounts`, then click on `Register`.
+
+1. Write down the value of `Application (client) ID`, we'll need it later for the channel configuration.
+
+1. Click on `Certificates & secrets`, then click on `New client secret`, then fill in the required fields.
+
+1. Write down the value of the generated secret, **you can't access it later**
+
+### 2. Create your bot
+
+1. Navigate to the [Bot Framework Registration Page](https://dev.botframework.com/bots/new) and fill the required informations:
+
+- Display name
+- Bot handle
+- The Microsoft App ID (that we generated in step 1)
+- Messaging endpoint (keep it blank for now - more on that later)
+
+You can also fill the other fields as you wish, but they will not impact Botpress.
+
+1. Click on `Register`
+
+1. On the next page (`Connect to channels`), under the section `Add a featured channel`, click on `Configure Microsoft Teams Channel`, then click on `Save`. No other configuration is needed at this point.
+
+### 3. Configure the channel on Botpress
+
+1. Open MS Teams (either the web version or the desktop client), then start a new conversation. In the search bar, paste your microsoft App Id. You should see your registered bot.
+
+1. Try talking to your bot. If you get a message saying that your bot has been disabled by administrator, you have to enable App sideloading in your microsoft admin portal. See this [article](https://docs.microsoft.com/en-us/microsoftteams/enable-features-office-365) for more details.
+
+You can now continue to next [section](#setting-up-ms-teams-channel-from-an-already-configured-ms-bot-with-an-appid-and-password).
+
+1. Copy the file `data/global/config/channel-teams.json` to your bot-specific configuration folder:
+
+   > data/bots/YOUR_BOT_ID/config/channel-teams.json
+
+1. Open the file, then set `enabled` to `true`, and set your `appId` and `appPassword` created in step 1
+
+### 4. Final configuration
+
+1. Start Botpress, then you should see your Messaging Endpoint in the startup logs.
+
+1. Open the [Bot Framework](https://dev.botframework.com/bots) page, then click on the name of your bot.
+
+1. Click on the `Settings` tab, then scroll down to `Messaging endpoint`.
+
+1. Set the value of the endpoint that was displayed in the logs. If it is missing, it should looks like that:
+
+> YOUR_BASE_URL/api/v1/bots/YOUR_BOT_ID/mod/channel-teams/api/messages

docs/guide/website/sidebars.json

@@ -27,7 +27,14 @@
       "advanced/cluster",
       "advanced/monitoring"
     ],
-    "Channels": ["channels/web", "channels/messenger", "channels/telegram", "channels/converse", "channels/faq"],
+    "Channels": [
+      "channels/web",
+      "channels/messenger",
+      "channels/telegram",
+      "channels/converse",
+      "channels/faq",
+      "channels/teams"
+    ],
     "Tutorials": [
       "tutorials/intent-matching",
       "tutorials/proactive",

modules/builtin/src/content-types/carousel.js

@@ -162,7 +162,7 @@ function renderSlack(data) {
 }
 
 function renderElement(data, channel) {
-  if (channel === 'web' || channel === 'api' || channel === 'telegram') {
+  if (channel === 'web' || channel === 'api' || channel === 'telegram' || channel === 'teams') {
     return render(data)
   } else if (channel === 'messenger') {
     return renderMessenger(data)

modules/builtin/src/content-types/image.js

@@ -90,6 +90,30 @@ function renderSlack(data) {
   ]
 }
 
+function renderTeams(data) {
+  const events = []
+
+  if (data.typing) {
+    events.push({
+      type: 'typing'
+    })
+  }
+
+  return [
+    ...events,
+    {
+      type: 'message',
+      attachments: [
+        {
+          name: data.title,
+          contentType: 'image/png',
+          contentUrl: url.resolve(data.BOT_URL, data.image)
+        }
+      ]
+    }
+  ]
+}
+
 function renderElement(data, channel) {
   if (channel === 'web' || channel === 'api') {
     return render(data)
@@ -99,6 +123,8 @@ function renderElement(data, channel) {
     return renderTelegram(data)
   } else if (channel === 'slack') {
     return renderSlack(data)
+  } else if (channel === 'teams') {
+    return renderTeams(data)
   }
 
   return [] // TODO Handle channel not supported

modules/builtin/src/content-types/single_choice.js

@@ -77,7 +77,7 @@ function renderSlack(data) {
 }
 
 function renderElement(data, channel) {
-  if (channel === 'web' || channel === 'api' || channel === 'telegram') {
+  if (channel === 'web' || channel === 'api' || channel === 'telegram' || channel === 'teams') {
     return render(data)
   } else if (channel === 'messenger') {
     return renderMessenger(data)

modules/builtin/src/content-types/text.js

@@ -38,11 +38,31 @@ function renderMessenger(data) {
   ]
 }
 
+function renderTeams(data) {
+  const events = []
+
+  if (data.typing) {
+    events.push({
+      type: 'typing'
+    })
+  }
+
+  return [
+    ...events,
+    {
+      type: 'message',
+      text: data.text
+    }
+  ]
+}
+
 function renderElement(data, channel) {
   if (channel === 'web' || channel === 'api' || channel === 'telegram' || channel === 'slack') {
     return render(data)
   } else if (channel === 'messenger') {
     return renderMessenger(data)
+  } else if (channel === 'teams') {
+    return renderTeams(data)
   }
 
   return [] // TODO

modules/channel-teams/.gitignore

@@ -0,0 +1,7 @@
+/bin
+/node_modules
+/dist
+/assets/web/
+/assets/config.schema.json
+botpress.d.ts
+global.d.ts