v1.0.0-preview.12 release - major features, major breaking changes!!!

[ryanbliss]

What's Changed

This is a big change which includes breaking changes and some exciting new features. This release makes the final set of major changes before our v1.0.0 release this May.

@microsoft/live-share changes

• We changed our dependency model so that you will have more flexibility with what Fluid Framework version you use. To accomplish this, we have moved fluid-framework: ^1.2.3 and @fluidframework/azure-client: ^1.0.0 in as peerDependencies. If this results in a build error for your application, please include those dependencies in your dependencies within your package.json.
• The LivePresence initialize() function no longer accepts userId as the first prop, which will be a breaking change for apps that use this class in their applications. To fix this issue, remove this prop. If you still want to broadcast a custom userId with LivePresence, then you can simply include it in the optional custom data object.
• Fixed a security gap in LivePresence which made it possible to "hijack" another user's LivePresenceUser record simply by claiming their userId.
• LivePresenceUser now includes a displayName field. For now, this field will only be populated up to Teams Developer Preview, but will be generally available by May 24th. Until then, regular Teams users displayName field will appear as undefined. This display name is un-spoofable, making it ideal for sensitive situations where you want accountability & visibility into whom is taking what action in your app.
• LivePresenceUser now has a roles field, which replaces the asynchronous getRoles() API. This should make it easier to know which user has what role, without the additional complexity caused by that async API. For apps using the getRoles() API, this is a breaking change. Replace await user.getRoles() with user.roles.
• LivePresence's updatePresence() method was deprecated in favor of update(). This is more aligned with our other DDS naming. We've had feedback that data is more commonly set than the state prop, so in this new method the order goes update(data?: TData, state?: PresenceState). The old API will continue to work until we remove it in v1.0.0.
• LiveEvent's sendEvent() method was deprecated in favor of send(), which is more aligned with other DDS naming.
• LiveEvent.setTimestampProvider() and LiveEvent.setRoleVerifier() were moved to LiveShareClient. If you use these static methods in your application, this will be a breaking change.
• You can now add a filter to the .toArray() method in LivePresence, such as const onlineUsers = presence.toArray(PresenceState.online).
• When a participant's UserMeetingRole changes, that will now be updated in our cache much faster than before. The role cache is set to expire every 4 seconds.

@microsoft/live-share-canvas changes

• We changed our dependency model so that you will have more flexibility with what Fluid Framework version you use, as well as to avoid issues from conflicting dependencies. To accomplish this, we have moved fluid-framework: ^1.2.3 and @microsoft/live-share: 1.0.0-preview.12 in as peerDependencies. If this results in a build error for your application, please include those dependencies in your dependencies within your package.json.
• LiveCanvas now supports un-spoofable names in cursors by default.
• The onGetLocalUserInfo(): IUserInfo | undefined method in LiveCanvas was replaced with onGetLocalUserPictureUrl(): string | undefined.
• For apps using LiveCanvas in a regular Fluid container (e.g., not using LiveShareClient), this will result in the displayName appearing as the first 4 characters of the user's clientId. We are working on a workaround for this that we will release before our v1.0.0 release.

@microsoft/live-share-media

• We changed our dependency model so that you will have more flexibility with what Fluid Framework version you use, as well as to avoid issues from conflicting dependencies. To accomplish this, we have moved fluid-framework: ^1.2.3 and @microsoft/live-share: 1.0.0-preview.12 in as peerDependencies. If this results in a build error for your application, please include those dependencies in your dependencies within your package.json.

@microsoft/live-share-react

• We changed our dependency model so that you will have more flexibility with what Fluid Framework version you use, as well as to avoid issues from conflicting dependencies. To accomplish this, we have moved fluid-framework: ^1.2.3, @fluidframework/azure-client: ^1.0.0, @microsoft/live-share: 1.0.0-preview.12, @microsoft/live-share-media: 1.0.0-preview.12, and @microsoft/live-share-canvas: 1.0.0-preview.12 in as peerDependencies. If this results in a build error for your application, please include those dependencies in your dependencies within your package.json.
• userId is no longer a prop in useLivePresence.
• updatePresence callback returned by useLivePresence now has data as first prop and state as second prop, to align with new LivePresence changes.
• localUserCursor prop was replaced with localUserProfilePictureUrl.

@microsoft/live-share-turbo

• We changed our dependency model so that you will have more flexibility with what Fluid Framework version you use, as well as to avoid issues from conflicting dependencies. To accomplish this, we have moved fluid-framework: ^1.2.3, @fluidframework/azure-client: ^1.0.0, and @microsoft/live-share: 1.0.0-preview.12 in as peerDependencies. If this results in a build error for your application, please include those dependencies in your dependencies within your package.json.

Workspace changes

• We migrated from Lerna to NPM workspaces, which improves performance and reliability of our monorepo. We recommend deleting node_modules before you try to re-build any packages or samples.
• To build only the packages, you can now run npm run:packages.

Known issues

• You may encounter issues using Live Share with @fluidframework/azure-client version ^1.1.0 while using your app in Teams. This is because of a breaking change they released in that version. We have a server-side fix coming soon that will address this issue. Until then, you can use ~1.0.2 in your package.json.
• Until our LivePresence dependencies are merged into the Teams client ahead of May 24th, regular Teams users (not in developer preview) will appear with a userId equal to their clientId. If they join from multiple devices, that means they will appear as separate users. This will be fixed automatically once our Teams client dependency becomes generally available.

Commits

• RoleVerifier and LivePresence v2 by @huntj88 in RoleVerifier and LivePresence v2 #516
• v1.0.0 preview.12 release by @ryanbliss in v1.0.0 preview.12 release #557

Full Changelog: v1.0.0-preview.10...v1.0.0-preview.12

---

This discussion was created from the release v1.0.0-preview.12 release - major features, major breaking changes!!!.