v1.0.0 release - Live Share is generally available!
What's changed
Live Share is officially generally available! This means Microsoft can now recommend for production scenarios. We have published the v1.0.0 version of @microsoft/live-share
, @microsoft/live-share-media
, and @microsoft/live-share-canvas
to npm. Since we use semantic versioning, this means that we are committed to no breaking changes to our interfaces until our next major release (2.0.0).
Our general availability comes with the following officially supported LiveDataObject
classes:
LivePresence
LiveState
LiveTimer
LiveEvent
LiveMediaSession
LiveCanvas
For those still using our Preview versions of the SDK, please refer to previous release notes for guides on how to upgrade. A lot of APIs were renamed, removed, or reworked (for example, updatePresence
was renamed to update
in LivePresence
, and now returns Promise<void>
instead of void
). If you need any help, feel free to ask us questions in our discussion board.
Our general availability has been a long time coming, and we're so excited to see what apps you release in the coming months.
Changes from this release (compared to preview.23
)
userId
,clientId
,state
, anddata
were replaced with alocalUser
getter inLivePresence
.- We have updated our license to reflect our general availability.
Known issues
- When using the
teams-js
LiveShareHost
,LivePresenceUser
'sdisplayName
field will currently show as undefined. This will change in the next week or two once the Teams desktop client completes its May rollout. - Similar to above, the
userId
ofLivePresenceUser
will temporarily be equal toclientId
. This will be replaced with a realuserId
once the Teams desktop client completes its May rollout. Guest
users in calendar & meet now meetings (aka "anonymous" users) will not be supported until the Teams desktop client completes its May rollout.Guest
users in channel meetings are not yet supported.- Like other Teams platform capabilities, Live Share does not yet support "the new Teams", with availability planned for later this summer.
Live Share Turbo and React previews
While the three packages mentioned above are generally available, live-share-turbo
and live-share-react
remain in preview. Those are published as as version 1.0.0-preview.24
. We will keep the minor versions in sync with the core SDK versions (e.g., 1.0.1
of live-share
will be released as 1.0.1-preview.1
of live-share-react
). We hope to make those packages generally available in the coming months, so please give it a try and let us know what you think!
Commits since last release notes
- Added command to test for race conditions by @huntj88 in #586
- Sample updates 5.12 by @ryanbliss in #576
- Release 1.0.0 preview.17 by @ryanbliss in #589
- Release v1.0.0 preview.23 by @ryanbliss in #593
- readme updates by @ryanbliss in #599
- Updated README with workaround for tinylicious error by @ryanbliss in #604
- updated IReceiveLiveEvent response by @ryanbliss in #606
- Updated license for production by @ryanbliss in #605
- Dependency updgrades by @ryanbliss in #607
- Changed how local information is exposed in LivePresence by @huntj88 in #608
- Release v1.0.0 by @ryanbliss in #609
Full Changelog: v1.0.0-preview.15...v1.0.0