whereby / sdk

MIT License
10 stars 2 forks source link

browser-sdk: Add toggleBreakout(), and togglePeople() to embed element #285

Closed nrolls closed 3 months ago

nrolls commented 3 months ago

Description

Summary: Add support for new commands: openBreakout, closeBreakout, and togglePeople. Syntax fix in toggleChat command definition

Related Issue: Reliant on this PR https://github.com/whereby/pwa/pull/4100

Testing

In sdk repo, apps/embed-element-app example

Then in terminal: yarn dev:embed-element-app

Screenshots/GIFs (if applicable)

Checklist

Additional Information

Gotcha: The openBreakout() command will still work for non-host participants. However, the user can't actually edit or initiate any breakout settings.

The above note will be clarified in our documentation and expected that customers development teams manage this from their side. i.e., if (host = true){show/enable button} else {don't show}

changeset-bot[bot] commented 3 months ago

🦋 Changeset detected

Latest commit: 4d389621e78b39e08d14bef3d59121de2cbe8f54

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package | Name | Type | | ------------------------ | ----- | | @whereby.com/browser-sdk | Minor |

Not sure what this means? Click here to learn what changesets are.

[Click here if you're a maintainer who wants to add another changeset to this PR](https://github.com/whereby/sdk/new/nrolls/add-breakout-command?filename=.changeset/heavy-years-check.md&value=---%0A%22embed-element-app%22%3A%20patch%0A%22%40whereby.com%2Fbrowser-sdk%22%3A%20patch%0A---%0A%0Abrowser-sdk%3A%20Add%20toggleBreakout()%2C%20and%20togglePeople()%20to%20embed%20element%0A)

nrolls commented 3 months ago

For the record, the "Test / Test (pull_request)" is failing do to an flagging of the use of 'event' in this line: https://github.com/whereby/sdk/blob/db7a3eada3bf3f28be0ba36f5df2f9907970b247/apps/embed-element-app/src/App.tsx#L52

That's not code I've written or anything I changed, so figured we can move past it for now and try to refactor later

nrolls commented 3 months ago

This has been deployed: https://github.com/whereby/pwa/pull/4100

merging