feat(client-presence): promote to beta #24710

jason-ha · 2025-05-24T00:38:06Z

leaving Notifications at alpha

Copilot

Pull Request Overview

Promote the Fluid Framework presence client APIs to beta support, leaving notifications functionality in alpha. Changes include updating JSDoc support levels, exposing a new beta entrypoint, and refreshing imports and documentation.

Switch public types and interfaces from @alpha to @beta tags.
Add a new @fluidframework/presence/beta export in package.json and corresponding API-extractor configs.
Update README, docs, and example code to import from /beta where appropriate.

Reviewed Changes

Copilot reviewed 40 out of 40 changed files in this pull request and generated 1 comment.

Show a summary per file

File	Description
packages/framework/presence/src/datastorePresenceManagerFactory.ts	Import `PresenceWithNotifications` as the default `Presence`
packages/framework/presence/src/broadcastControls.ts	Bump `@alpha` tags to `@beta` on broadcast controls
packages/framework/presence/src/baseTypes.ts	Bump `@alpha` tag to `@beta` on `ClientConnectionId`
packages/framework/presence/package.json	Add `./beta` export entrypoint and new lint scripts
packages/framework/presence/api-report/presence.beta.api.md	Regenerate public API report for the beta entrypoint
packages/framework/presence/api-report/presence.alpha.api.md	Update alpha API report with new beta-related exports
packages/framework/presence/api-extractor/api-extractor-lint-beta.esm.json	Add ESM lint config for beta
packages/framework/presence/api-extractor/api-extractor-lint-beta.cjs.json	Add CJS lint config for beta
packages/framework/presence/README.md	Document importing from `/beta`
packages/framework/presence/.eslintrc.cjs	Allow linting of `/beta` paths
examples/service-clients/azure-client/external-controller/src/view.ts	Swap imports from `presence/alpha` to `presence/beta`
examples/service-clients/azure-client/external-controller/src/presence.ts	Swap imports from `presence/alpha` to `presence/beta`
examples/service-clients/azure-client/external-controller/src/app.ts	Swap imports from `presence/alpha` to `presence/beta`
examples/apps/presence-tracker/src/reactions.ts	Cast beta `Presence` to `PresenceWithNotifications` in alpha
examples/apps/presence-tracker/src/MouseTracker.ts	Swap imports from `presence/alpha` to `presence/beta`
examples/apps/presence-tracker/src/FocusTracker.ts	Swap imports from `presence/alpha` to `presence/beta`
examples/apps/ai-collab/src/app/presence.ts	Swap imports from `presence/alpha` to `presence/beta`
examples/apps/ai-collab/src/app/page.tsx	Swap imports from `presence/alpha` to `presence/beta`
docs/docs/build/presence.md	Update code sample to import from `presence/beta`
.changeset/fluffy-donkeys-obey.md	Describe beta rollout and notification-alpha note

Comments suppressed due to low confidence (2)

packages/framework/presence/src/datastorePresenceManagerFactory.ts:21

[nitpick] Aliasing PresenceWithNotifications to Presence can blur the distinction between the base presence API and the extended notifications API. Consider importing and using the explicit type name PresenceWithNotifications or updating the default export to avoid confusion.

import type { PresenceWithNotifications as Presence } from "./presence.js";

packages/framework/presence/package.json:16

Consider adding or updating automated tests to verify that the new /beta entrypoint exports the expected API surface and typings to catch regressions early.

"./beta": {

packages/framework/presence/README.md

tylerbutler

Approving for docs. Haven't reviewed code yet.

tylerbutler · 2025-05-24T00:57:05Z

Added release blocking tag to make sure this isn't missed for the next release.

- remove stale internal exports - add /beta exports

github-actions · 2025-05-27T10:26:13Z

🔗 No broken links found! ✅

Your attention to detail is admirable.

linkcheck output


> fluid-framework-docs-site@0.0.0 ci:check-links /home/runner/work/FluidFramework/FluidFramework/docs
> start-server-and-test "npm run serve -- --no-open" 3000 check-links

1: starting server using command "npm run serve -- --no-open"
and when url "[ 'http://127.0.0.1:3000' ]" is responding with HTTP status code 200
running tests using command "npm run check-links"


> fluid-framework-docs-site@0.0.0 serve
> docusaurus serve --no-open

[SUCCESS] Serving "build" directory at: http://localhost:3000/

> fluid-framework-docs-site@0.0.0 check-links
> linkcheck http://localhost:3000 --skip-file skipped-urls.txt

Crawling...

Stats:
  209835 links
    1663 destination URLs
    1895 URLs ignored
       0 warnings
       0 errors

Josmithr · 2025-05-27T15:51:52Z

packages/framework/presence/api-report/presence.alpha.api.md

    readonly states: {
        getWorkspace<StatesSchema extends StatesWorkspaceSchema>(workspaceAddress: WorkspaceAddress, requestedStates: StatesSchema, controls?: BroadcastControlSettings): StatesWorkspace<StatesSchema>;
    };
 }

-// @alpha @sealed (undocumented)
+// @beta @sealed (undocumented)


There appear to be a fair number of new @beta exports that are reported as undocumented. It would probably be worth a pass to fill in those gaps. Doesn't have to be in this PR IMO, but we should make sure it gets done.

Looks like the only top-level APIs that don't have comments are Events interfaces. Will fast follow with updates.

Josmithr

API changes look good, at least in terms of the promotion mechanics. It would probably be good to review the architecture with the team again sometime between now and the promotion to public.

- removes @internal where API is not package exported and adding real notes where none were. - adds documentation to exported APIs Follow-up for microsoft#24399 and microsoft#24710

adds documentation to beta APIs that are not `@system` nor `attendees` or `states` properties of `Presence` Follow-up for microsoft#24710

adds documentation to beta APIs that are not `@system` nor `attendees` or `states` properties of `Presence` Follow-up for #24710

- removes `@internal` where API is not package exported and adding real notes where none were. - adds documentation to exported APIs Follow-up for #24399 and #24710

feat(client-presence): promote to beta

86784ba

leaving Notifications at alpha

Copilot AI review requested due to automatic review settings May 24, 2025 00:38

jason-ha requested review from a team as code owners May 24, 2025 00:38

jason-ha requested review from nmsimons, tylerbutler and WillieHabi May 24, 2025 00:38

Copilot AI reviewed May 24, 2025

View reviewed changes

packages/framework/presence/README.md Show resolved Hide resolved

tylerbutler approved these changes May 24, 2025

View reviewed changes

tylerbutler added the release-blocking Must be addressed before we cut and publish the next release label May 24, 2025

fix(client-presence): CommonJs package.json

a8be12e

- remove stale internal exports - add /beta exports

Josmithr reviewed May 27, 2025

View reviewed changes

Josmithr approved these changes May 27, 2025

View reviewed changes

jason-ha merged commit 6fce410 into microsoft:main May 27, 2025
50 checks passed

github-actions bot mentioned this pull request May 27, 2025

Upcoming Release: FluidFramework v2.43.0 #22101

Open

jason-ha deleted the presence/promote-to-beta branch May 27, 2025 21:30

jason-ha mentioned this pull request May 28, 2025

docs(client): missing comments and @internal use fixes #24718

Merged

jason-ha added a commit to jason-ha/FluidFramework that referenced this pull request May 28, 2025

docs(client-presence): missing API comments

3f0aa29

adds documentation to beta APIs that are not `@system` nor `attendees` or `states` properties of `Presence` Follow-up for microsoft#24710

jason-ha mentioned this pull request May 28, 2025

docs(client-presence): missing API comments #24724

Merged

jason-ha added a commit that referenced this pull request May 29, 2025

docs(client-presence): missing API comments (#24724)

101047b

adds documentation to beta APIs that are not `@system` nor `attendees` or `states` properties of `Presence` Follow-up for #24710

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat(client-presence): promote to beta #24710

feat(client-presence): promote to beta #24710

Uh oh!

jason-ha commented May 24, 2025 •

edited by azure-boards bot

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

tylerbutler left a comment

Uh oh!

tylerbutler commented May 24, 2025

Uh oh!

github-actions bot commented May 27, 2025

Uh oh!

Josmithr May 27, 2025

Uh oh!

Josmithr May 27, 2025

Uh oh!

jason-ha May 27, 2025

Uh oh!

Josmithr left a comment

Uh oh!

Uh oh!

Uh oh!

feat(client-presence): promote to beta #24710

feat(client-presence): promote to beta #24710

Uh oh!

Conversation

jason-ha commented May 24, 2025 • edited by azure-boards bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

tylerbutler left a comment

Choose a reason for hiding this comment

Uh oh!

tylerbutler commented May 24, 2025

Uh oh!

github-actions bot commented May 27, 2025

linkcheck output

Uh oh!

Josmithr May 27, 2025

Choose a reason for hiding this comment

Uh oh!

Josmithr May 27, 2025

Choose a reason for hiding this comment

Uh oh!

jason-ha May 27, 2025

Choose a reason for hiding this comment

Uh oh!

Josmithr left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jason-ha commented May 24, 2025 •

edited by azure-boards bot

Loading