Add support for streaming through entities (#5517)

* delete `text` from typing activities which are not streaming

* add support for reading streaming data in `entities`

* refactoring to pass existing html2 test cases

* minimal implementation of entities livestreaming

* Rewrite code flow to check for streamingData first -- draft version (this is pretty rough)

* Change conditionals to be more readable and actually check channelData

* handle case of entities being undefined

* Make channelData optional in entitiesStreamingActivitySchema

* make channelData not optional for entitiesStreamingActivitySchema

* change looseObject back to object

* handle entities being undefined again

* clean up logical flow and include more typing

* Removed common data from schemas for reusability

* read channelData instead of entities

* remove unnecessary field from StreamingData

* typing+final+text activity returns undefined

* further abstraction of schemas

* update unit tests

* edit changelog

* finish changelog

* edit docs

* allow for optional channelData in entities streaming schema

* added jsdoc to StreamingData interface

* fix naming issues

* add sample

* trigger CI

* fix sample

* require type: streaminfo field for streaming data in entities

* fix unit tests to reflect added `entities` field

* Use valibot properly

* Verbiage

* Clean up

* Simplify

* Revert back to original

* Revert test and use permutation

* Update entry

* Add `injectInto`

* Clean up

* Clean up

* Add tests

* Reverting

---------

Co-authored-by: = <=>
Co-authored-by: Kyle Rohn <108435516+kylerohn@users.noreply.github.com>
Co-authored-by: MattB <mattb-msft@hotmail.com>
Co-authored-by: William Wong <compulim@users.noreply.github.com>

Author: 4 people

CHANGELOG.md

@@ -107,6 +107,7 @@ Notes: web developers are advised to use [`~` (tilde range)](https://github.com/
 - Added `disableFileUpload` flag to completelly disable file upload feature, in PR [#5508](https://github.com/microsoft/BotFramework-WebChat/pull/5508), by [@JamesNewbyAtMicrosoft](https://github.com/JamesNewbyAtMicrosoft)
    - Deprecated `hideUploadButton` in favor of `disableFileUpload`.
    - Updated `BasicSendBoxToolbar` to rely solely on `disableFileUpload`.
+- Added support for livestreaming via `entities[type="streaminfo"]` in PR [#5517](https://github.com/microsoft/BotFramework-WebChat/pull/5517) by [@kylerohn](https://github.com/kylerohn) and [@compulim](https://github.com/compulim)
 
 ### Changed
 

docs/LIVESTREAMING.md

@@ -64,6 +64,24 @@ To simplify this documentation, we are using the term "bot" instead of "copilot"
 
 Bot developers would need to implement the livestreaming as outlined in this section. The implementation below will enable livestreaming to both Azure Bot Services and Teams.
 
+> [!NOTE]
+>
+> Web Chat supports livestreaming data in both `channelData` or `entities[type="streaminfo"]` field and can be used interchangeably. The following code snippet shows the livestream data in `entities` field.
+>
+> ```json
+> {
+>    "entities": [
+>       {
+>          "streamSequence": 1,
+>          "streamType": "streaming",
+>          "type": "streaminfo"
+>       }
+>    ],
+>    "text": "...",
+>    "type": "typing"
+> }
+> ```
+
 ### Scenario 1: Livestream from start to end
 
 > In this example, we assume the bot is livestreaming the following sentence to the user: