Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

#2461 Add isomorphic-react and isomorphic-react-dom packages #2478

Merged
merged 16 commits into from
Oct 18, 2019
Merged
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ about: Create a report to help us improve
title: ''
labels: Bug, Pending, customer-reported, Bot Services
assignees: ''

---

<!-- ATTENTION: Bot Framework internals, please remove the `customer-reported` and `Bot Services` labels before submitting this issue. -->
Expand Down
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ about: Suggest an idea for this project
title: ''
labels: Enhancement, Pending, customer-reported, Bot Services
assignees: ''

---

<!-- ATTENTION: Bot Framework internals, please remove the `customer-reported` and `Bot Services` labels before submitting this issue. -->
Expand Down
1 change: 0 additions & 1 deletion .github/ISSUE_TEMPLATE/question-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ about: Ask a question not related to implementation here
title: ''
labels: Question, Pending, customer-reported, Bot Services
assignees: ''

---

🚨 The issue tracker is not for implementation questions 🚨
Expand Down
26 changes: 13 additions & 13 deletions ACTIVITYTYPES.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,22 @@

First, see the [Activities overview](https://docs.microsoft.com/en-us/azure/bot-service/dotnet/bot-builder-dotnet-activities?view=azure-bot-service-3.0) documentation to learn about what activities types are available in Bot Framework.

This document will discuss what Bot Framework activity types that Web Chat is prepared to handle *as a client*. To see documentation on which activity types are supported by different channels, please see the [Activities by Channel](https://github.com/microsoft/botframework-sdk/issues/5294) discussion.
This document will discuss what Bot Framework activity types that Web Chat is prepared to handle _as a client_. To see documentation on which activity types are supported by different channels, please see the [Activities by Channel](https://github.com/microsoft/botframework-sdk/issues/5294) discussion.

Although the Direct Line channel and Web Chat channel support the following activity types, Web Chat is only designed to support the following activities:

| Direct Line Channel supported Activity | Channel :left_right_arrow: Bot Activity | `Activity.type` |
|---------------------------------------- |---------------------------------------- |------------------- |
| `message` | | :heavy_check_mark: |
| `conversationUpdate` | :heavy_check_mark: | |
| `event` | | :heavy_check_mark: |
| `event.TokenResponse` | :heavy_check_mark: | |
| `endOfConversation` | | |
| `typing` | | :heavy_check_mark: |
| `installationUpdate` | :heavy_check_mark: | |

- `installationUpdate`, `event.TokenResponse` and `conversationUpdate` are activities sent between the bot and the channel. The channel does not send these events to Web Chat.
- `endOfConversation` is not currently handled or rendered by Web Chat. See the Web Chat conversation on [Activity Types](https://github.com/microsoft/BotFramework-WebChat/issues/1808) to learn more.
| Direct Line Channel supported Activity | Channel :left_right_arrow: Bot Activity | `Activity.type` |
| -------------------------------------- | --------------------------------------- | ------------------ |
| `message` | | :heavy_check_mark: |
| `conversationUpdate` | :heavy_check_mark: | |
| `event` | | :heavy_check_mark: |
| `event.TokenResponse` | :heavy_check_mark: | |
| `endOfConversation` | | |
| `typing` | | :heavy_check_mark: |
| `installationUpdate` | :heavy_check_mark: | |

- `installationUpdate`, `event.TokenResponse` and `conversationUpdate` are activities sent between the bot and the channel. The channel does not send these events to Web Chat.
- `endOfConversation` is not currently handled or rendered by Web Chat. See the Web Chat conversation on [Activity Types](https://github.com/microsoft/BotFramework-WebChat/issues/1808) to learn more.

When developing your bot's web page, you may discover that the bot sends an activity type that needs to be supported by Web Chat. Luckily, it is possible to create renderers for different activities through the [`activityMiddleware`](https://github.com/microsoft/BotFramework-WebChat#web-chat-api-reference). To learn more, check out the following tutorials:

Expand Down
48 changes: 25 additions & 23 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
-->

## [Unreleased]
- Added missing Norwegian (nb-NO) translations, by [@taarskog](https://github.com/taarskog)
- Added missing Italian (it-IT) translations, by [@AntoT84](https://github.com/AntoT84)

### Breaking changes

Expand All @@ -41,22 +39,22 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- `*`: Bumps Docker container for headless Chrome to `selenium/standalone-chrome:3.141.59-radium`, by [@compulim](https://github.com/compulim), in PR [#2182](https://github.com/microsoft/BotFramework-WebChat/pull/2182)
- `*`: Moves from [`babel-plugin-version-transform`](https://www.npmjs.com/package/babel-plugin-version-transform) to [`babel-plugin-transform-inline-environment-variables`](https://www.npmjs.com/package/babel-plugin-transform-inline-environment-variables), by [@compulim](https://github.com/compulim), in PR [#2182](https://github.com/microsoft/BotFramework-WebChat/pull/2182)
- `*`: Bumps ESLint and related dependencies to latest version, by [@compulim](https://github.com/compulim), in PR [#2185](https://github.com/microsoft/BotFramework-WebChat/pull/2185)
- [`[email protected]`](https://www.npmjs.com/package/eslint-plugin-react)
- [`[email protected]`](https://www.npmjs.com/package/eslint)
- [`[email protected]`](https://www.npmjs.com/package/eslint-plugin-react)
- [`[email protected]`](https://www.npmjs.com/package/eslint)
- `*`: Bumps React, Redux and their related dependencies to latest version, by [@compulim](https://github.com/compulim), in PR [#2184](https://github.com/microsoft/BotFramework-WebChat/pull/2184)
- [`[email protected]`](https://www.npmjs.com/package/react-dom)
- [`[email protected]`](https://www.npmjs.com/package/react-redux)
- [`[email protected]`](https://www.npmjs.com/package/react)
- [`[email protected]`](https://www.npmjs.com/package/redux)
- Removed [`redux-promise-middleware`](https://www.npmjs.com/package/redux-promise-middleware)
- [`[email protected]`](https://www.npmjs.com/package/react-dom)
- [`[email protected]`](https://www.npmjs.com/package/react-redux)
- [`[email protected]`](https://www.npmjs.com/package/react)
- [`[email protected]`](https://www.npmjs.com/package/redux)
- Removed [`redux-promise-middleware`](https://www.npmjs.com/package/redux-promise-middleware)
- `*`: Bumps `lodash-*`(https://www.npmjs.com/package/lodash), by [@compulim](https://github.com/compulim), in PR [#2199](https://github.com/microsoft/BotFramework-WebChat/pull/2199)
- [`[email protected]`](https://www.npmjs.com/package/lodash)
- [`[email protected]`](https://www.npmjs.com/package/lodash.mergewith)
- [`[email protected]`](https://www.npmjs.com/package/lodash.template)
- [`[email protected]`](https://www.npmjs.com/package/lodash.template)
- [`[email protected]`](https://www.npmjs.com/package/mixin-deep)
- [`[email protected]`](https://www.npmjs.com/package/set-value)
- [`[email protected]`](https://www.npmjs.com/package/union-value)
- [`[email protected]`](https://www.npmjs.com/package/lodash)
- [`[email protected]`](https://www.npmjs.com/package/lodash.mergewith)
- [`[email protected]`](https://www.npmjs.com/package/lodash.template)
- [`[email protected]`](https://www.npmjs.com/package/lodash.template)
- [`[email protected]`](https://www.npmjs.com/package/mixin-deep)
- [`[email protected]`](https://www.npmjs.com/package/set-value)
- [`[email protected]`](https://www.npmjs.com/package/union-value)
- Bumps [`[email protected]`](https://www.npmjs.com/package/web-speech-cognitive-services), by [@compulim](https://github.com/compulim) in PR [#2246](https://github.com/microsoft/BotFramework-WebChat/pull/2246), PR [#2274](https://github.com/microsoft/BotFramework-WebChat/pull/2274), and PR [#2338](https://github.com/microsoft/BotFramework-WebChat/pull/2338)
- Fix for React hooks constraints: both app and component must share the same reference of [`react`](https://www.npmjs.com/package/react) and [`react-dom`](https://www.npmjs.com/package/react-dom), in PR [#2274](https://github.com/microsoft/BotFramework-WebChat/pull/2274)
- `/`: Install [`react`](https://www.npmjs.com/package/react) and [`react-dom`](https://www.npmjs.com/package/react-dom) to `devDependencies`
Expand Down Expand Up @@ -91,6 +89,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- Fix [#2360](https://github.com/microsoft/BotFramework-WebChat/issues/2360). Timestamp should update on language change, by [@compulim](https://github.com/compulim) in PR [#2414](https://github.com/microsoft/BotFramework-WebChat/pull/2414)
- Fix [#2428](https://github.com/microsoft/BotFramework-WebChat/issues/2428). Should interrupt speech synthesis after microphone button is clicked, by [@compulim](https://github.com/compulim) in PR [#2429](https://github.com/microsoft/BotFramework-WebChat/pull/2429)
- Fix [#2435](https://github.com/microsoft/BotFramework-WebChat/issues/2435). Fix microphone button getting stuck on voice-triggered expecting input hint without a speech synthesis engine, by [@compulim](https://github.com/compulim) in PR [#2445](https://github.com/microsoft/BotFramework-WebChat/pull/2445)
- Fix [#2472](https://github.com/microsoft/BotFramework-WebChat/issues/2472). Update samples to use repo's version of React, by [@corinagum](https://github.com/corinagum) in PR [#2478](https://github.com/microsoft/BotFramework-WebChat/pull/2478)

### Added

Expand All @@ -102,6 +101,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- `embed`: Added ES5 polyfills and dev server, by [@compulim](https://github.com/compulim), in PR [#2315](https://github.com/microsoft/BotFramework-WebChat/pull/2315)
- Fix [#2380](https://github.com/microsoft/BotFramework-WebChat/issues/2380). Added `botAvatarBackgroundColor` and `userAvatarBackgroundColor` to the default style options, by [@tdurnford](https://github.com/tdurnford) in PR [#2384](https://github.com/microsoft/BotFramework-WebChat/pull/2384)
- Added full screen capability to `IFRAME` in the `YouTubeContent` and `VimeoContent` components by [@tdurnford](https://github.com/tdurnford) in PR [#2399](https://github.com/microsoft/BotFramework-WebChat/pull/2399)
- Fix [#2461](https://github.com/Microsoft/BotFramework-WebChat/issues/2461), added `isomorphic-react` and `isomorphic-react-dom` packages, by [@compulim](https://github.com/compulim) and [@corinagum](https://github.com/corinagum), in PR [#2478](https://github.com/microsoft/BotFramework-WebChat/pull/2478)
- Added missing Norwegian (nb-NO) translations, by [@taarskog](https://github.com/taarskog)
- Added missing Italian (it-IT) translations, by [@AntoT84](https://github.com/AntoT84)

### Samples

Expand All @@ -114,8 +116,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
### Changed

- `bundle`: Bumped DirectLineJS to support metadata when uploading attachments, in PR [#2433](https://github.com/microsoft/BotFramework-WebChat/pull/2433)
- [`[email protected]`](https://www.npmjs.com/package/botframework-directlinejs)
- Removed DirectLineJS as a dev dependency for `component` because it was not referenced
- [`[email protected]`](https://www.npmjs.com/package/botframework-directlinejs)
- Removed DirectLineJS as a dev dependency for `component` because it was not referenced

### Fixed

Expand All @@ -126,11 +128,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
### Added

- Make thumbnails when uploading GIF/JPEG/PNG and store it in `channelData.attachmentThumbnails`, by [@compulim](https://github.com/compulim), in PR [#2206](https://github.com/microsoft/BotFramework-WebChat/pull/2206), requires modern browsers with following features:
- [Web Workers API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API)
- [`createImageBitmap`](https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/createImageBitmap)
- [`MessageChannel`](https://developer.mozilla.org/en-US/docs/Web/API/MessageChannel)/[`MessagePort`](https://developer.mozilla.org/en-US/docs/Web/API/MessagePort)
- [`OffscreenCanvas`](https://developer.mozilla.org/en-US/docs/Web/API/OffscreenCanvas)
- Specifically [`OffscreenCanvas.getContext('2d')`](https://developer.mozilla.org/en-US/docs/Web/API/OffscreenCanvas/getContext)
- [Web Workers API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API)
- [`createImageBitmap`](https://developer.mozilla.org/en-US/docs/Web/API/WindowOrWorkerGlobalScope/createImageBitmap)
- [`MessageChannel`](https://developer.mozilla.org/en-US/docs/Web/API/MessageChannel)/[`MessagePort`](https://developer.mozilla.org/en-US/docs/Web/API/MessagePort)
- [`OffscreenCanvas`](https://developer.mozilla.org/en-US/docs/Web/API/OffscreenCanvas)
- Specifically [`OffscreenCanvas.getContext('2d')`](https://developer.mozilla.org/en-US/docs/Web/API/OffscreenCanvas/getContext)
- Render thumbnail for image attachments using `activity.attachments[].thumbnailUrl`, by [@compulim](https://github.com/compulim) in PR [#2433](https://github.com/microsoft/BotFramework-WebChat/pull/2433)

## [4.5.2] - 2019-08-07
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,13 +140,13 @@ You can use Cognitive Services Speech Services to add bi-directional speech func

Web Chat is designed to be customizable without forking the source code. The table below outlines what kind of customizations you can achieve when you are importing Web Chat in different ways. This list is not exhaustive.

| | CDN bundle | React |
| | CDN bundle | React |
| ----------------------------- | :--------: | :------: |
| Change colors | &#10004; | &#10004; |
| Change sizes | &#10004; | &#10004; |
| Update/replace CSS styles | &#10004; | &#10004; |
| Listen to events | &#10004; | &#10004; |
| Interact with hosting webpage | &#10004; | &#10004; |
| Change colors | &#10004; | &#10004; |
| Change sizes | &#10004; | &#10004; |
| Update/replace CSS styles | &#10004; | &#10004; |
| Listen to events | &#10004; | &#10004; |
| Interact with hosting webpage | &#10004; | &#10004; |
| Custom render activities | | &#10004; |
| Custom render attachments | | &#10004; |
| Add new UI components | | &#10004; |
Expand All @@ -155,6 +155,7 @@ Web Chat is designed to be customizable without forking the source code. The tab
See more about [customizing Web Chat](https://github.com/microsoft/BotFramework-WebChat/blob/master/SAMPLES.md) to learn more on customization.

## Supported Activity Types on the Web Chat Client

Please refer to [`ACTIVITYTYPES.md`](https://github.com/microsoft/BotFramework-WebChat/blob/master/ACTIVITYTYPES.md) for list of Web Chat supported activity types.

## Speech changes in Web Chat 4.5
Expand Down Expand Up @@ -249,7 +250,6 @@ Please note, however:
- Web Chat has no plan to support samples for IE11 (ES5).
- For customers who wish to manually rewrite our other samples to work in IE11, we recommend looking into converting code from ES6+ to ES5 using polyfills and transpilers like [`babel`](https://babeljs.io/docs/en/next/babel-standalone.html).


# How to connect client app to bot

Web Chat provides UI on top of the Direct Line Channel. There are two ways to connect to your bot through HTTP calls from the client: by sending the Bot secret or generating a token via the secret.
Expand Down
Loading