refactor(client-presence): Rename ExperimentalPresenceManager to PresenceManager + remove all experimental naming from package

.changeset/common-cars-swim.md

@@ -0,0 +1,10 @@
+---
+"@fluidframework/presence": minor
+---
+---
+"section": other
+---
+
+Rename ExperimentalPresenceManager to PresenceManger
+
+Now that Presence package has been promoted from experimental to alpha, we have renamed `ExperimentalPresenceManager` to `PresenceManager` and `ExperimentalPresenceDO` to `PresenceDO`.

examples/service-clients/azure-client/external-controller/src/app.ts

@@ -13,10 +13,7 @@ import {
 import { createDevtoolsLogger, initializeDevtools } from "@fluidframework/devtools/internal";
 // eslint-disable-next-line import/no-internal-modules
 import { ISharedMap, IValueChanged, SharedMap } from "@fluidframework/map/internal";
-import {
-	acquirePresenceViaDataObject,
-	ExperimentalPresenceManager,
-} from "@fluidframework/presence/alpha";
+import { acquirePresenceViaDataObject, PresenceManager } from "@fluidframework/presence/alpha";
 // eslint-disable-next-line import/no-internal-modules
 import { createChildLogger } from "@fluidframework/telemetry-utils/internal";
 // eslint-disable-next-line import/no-internal-modules
@@ -81,7 +78,7 @@ const containerSchema = {
 		map2: SharedMap,
 		// A Presence Manager object temporarily needs to be placed within container schema
 		// https://github.com/microsoft/FluidFramework/blob/main/packages/framework/presence/README.md#onboarding
-		presence: ExperimentalPresenceManager,
+		presence: PresenceManager,
 	},
 } satisfies ContainerSchema;
 type DiceRollerContainerSchema = typeof containerSchema;

packages/framework/presence/CHANGELOG.md

@@ -1,4 +1,4 @@
-# @fluid-experimental/presence
+# @fluidframework/presence
 
 ## 2.5.0
 
@@ -18,11 +18,11 @@ Dependency updates only.
 
 ### Major Changes
 
--   Experimental Presence package added ([#22499](https://github.com/microsoft/FluidFramework/pull/22499)) [42b323cdbf1](https://github.com/microsoft/FluidFramework/commit/42b323cdbf129c897cf9bb51c1f1b9de5642ef8a)
+-   Presence package added ([#22499](https://github.com/microsoft/FluidFramework/pull/22499)) [42b323cdbf1](https://github.com/microsoft/FluidFramework/commit/42b323cdbf129c897cf9bb51c1f1b9de5642ef8a)
 
-    **[@fluid-experimental/presence](https://github.com/microsoft/FluidFramework/tree/main/packages/framework/presence#readme)** is now available for investigation. The new package is meant to support presence of collaborators connected to the same container. Use this library to quickly share simple, non-persisted data among all clients or send/receive fire and forget notifications.
+    **[@fluidframework/presence](https://github.com/microsoft/FluidFramework/tree/main/packages/framework/presence#readme)** is now available for investigation. The new package is meant to support presence of collaborators connected to the same container. Use this library to quickly share simple, non-persisted data among all clients or send/receive fire and forget notifications.
 
-    API documentation for **@fluid-experimental/presence** is available at <https://fluidframework.com/docs/apis/presence>.
+    API documentation for **@fluidframework/presence** is available at <https://fluidframework.com/docs/apis/presence>.
 
     There are some limitations; see the README.md of installed package for most relevant notes.
 

packages/framework/presence/README.md

@@ -80,14 +80,14 @@ Notifications value managers are special case where no data is retained during a
 
 ## Onboarding
 
-While this package is developing as experimental and other Fluid Framework internals are being updated to accommodate it, a temporary Shared Object must be added within container to gain access.
+While this package is developing and other Fluid Framework internals are being updated to accommodate it, a temporary Shared Object must be added within container to gain access.
 
 ```typescript
-import { acquirePresenceViaDataObject, ExperimentalPresenceManager } from "@fluidframework/presence/alpha";
+import { acquirePresenceViaDataObject, PresenceManager } from "@fluidframework/presence/alpha";
 
 const containerSchema = {
 	initialObjects: {
-        presence: ExperimentalPresenceManager
+        presence: PresenceManager
     }
 } satisfies ContainerSchema;
 

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

@@ -8,7 +8,7 @@
 export function acquirePresence(fluidContainer: IFluidContainer): IPresence;
 
 // @alpha
-export function acquirePresenceViaDataObject(fluidLoadable: ExperimentalPresenceDO): IPresence;
+export function acquirePresenceViaDataObject(fluidLoadable: PresenceDO): IPresence;
 
 // @alpha
 export type ClientConnectionId = string;
@@ -18,13 +18,6 @@ export type ClientSessionId = SessionId & {
     readonly ClientSessionId: "ClientSessionId";
 };
 
-// @alpha @sealed
-export class ExperimentalPresenceDO {
-}
-
-// @alpha
-export const ExperimentalPresenceManager: SharedObjectKind<IFluidLoadable & ExperimentalPresenceDO>;
-
 // @alpha @sealed
 export interface IPresence {
     readonly events: ISubscribable<PresenceEvents>;
@@ -168,6 +161,10 @@ export type NotificationSubscriptions<E extends InternalUtilityTypes.Notificatio
     [K in string & keyof InternalUtilityTypes.NotificationEvents<E>]: (sender: ISessionClient, ...args: InternalUtilityTypes.JsonDeserializedParameters<E[K]>) => void;
 };
 
+// @alpha @sealed
+export class PresenceDO {
+}
+
 // @alpha @sealed (undocumented)
 export interface PresenceEvents {
     // @eventProperty
@@ -177,6 +174,9 @@ export interface PresenceEvents {
     workspaceActivated: (workspaceAddress: PresenceWorkspaceAddress, type: "States" | "Notifications" | "Unknown") => void;
 }
 
+// @alpha
+export const PresenceManager: SharedObjectKind<IFluidLoadable & PresenceDO>;
+
 // @alpha @sealed
 export type PresenceNotifications<TSchema extends PresenceNotificationsSchema> = PresenceStates<TSchema, NotificationsManager<any>>;
 

packages/framework/presence/src/datastorePresenceManagerFactory.ts

@@ -53,7 +53,7 @@ class PresenceManagerDataObject extends LoadableFluidObject {
  * Factory class to create {@link IPresence} in own data store.
  */
 class PresenceManagerFactory {
-	public is(value: IFluidLoadable | ExperimentalPresenceDO): value is ExperimentalPresenceDO {
+	public is(value: IFluidLoadable | PresenceDO): value is PresenceDO {
 		return value instanceof PresenceManagerDataObject;
 	}
 
@@ -64,16 +64,16 @@ class PresenceManagerFactory {
 }
 
 /**
- * Brand for Experimental Presence Data Object.
+ * Brand for Presence Data Object.
  *
  * @remarks
  * See {@link acquirePresenceViaDataObject} for example usage.
  *
  * @sealed
  * @alpha
  */
-export declare class ExperimentalPresenceDO {
-	private readonly _self: ExperimentalPresenceDO;
+export declare class PresenceDO {
+	private readonly _self: PresenceDO;
 }
 
 /**
@@ -82,10 +82,9 @@ export declare class ExperimentalPresenceDO {
  *
  * @alpha
  */
-export const ExperimentalPresenceManager =
-	new PresenceManagerFactory() as unknown as SharedObjectKind<
-		IFluidLoadable & ExperimentalPresenceDO
-	>;
+export const PresenceManager = new PresenceManagerFactory() as unknown as SharedObjectKind<
+	IFluidLoadable & PresenceDO
+>;
 
 /**
  * Acquire IPresence from a DataStore based Presence Manager
@@ -94,25 +93,23 @@ export const ExperimentalPresenceManager =
  * ```typescript
  * const containerSchema = {
  * 	initialObjects: {
- * 		experimentalPresence: ExperimentalPresenceDO,
+ * 		presence: PresenceDO,
  * 	},
  * } satisfies ContainerSchema;
  * ```
  * then
  * ```typescript
  * const presence = acquirePresenceViaDataObject(
- * 	container.initialObjects.experimentalPresence,
+ * 	container.initialObjects.presence,
  * 	);
  * ```
  *
  * @alpha
  */
-export function acquirePresenceViaDataObject(
-	fluidLoadable: ExperimentalPresenceDO,
-): IPresence {
+export function acquirePresenceViaDataObject(fluidLoadable: PresenceDO): IPresence {
 	if (fluidLoadable instanceof PresenceManagerDataObject) {
 		return fluidLoadable.presenceManager();
 	}
 
-	throw new Error("Incompatible loadable; make sure to use ExperimentalPresenceManager");
+	throw new Error("Incompatible loadable; make sure to use PresenceManager");
 }

packages/framework/presence/src/index.ts

@@ -4,7 +4,7 @@
  */
 
 /**
- * Experimental package for client presence within a connected session.
+ * Package for client presence within a connected session.
  *
  * See {@link https://github.com/microsoft/FluidFramework/tree/main/packages/framework/presence#readme | README.md } for an overview of the package.
  *
@@ -49,8 +49,8 @@ export { acquirePresence } from "./experimentalAccess.js";
 
 export {
 	acquirePresenceViaDataObject,
-	type ExperimentalPresenceDO,
-	ExperimentalPresenceManager,
+	type PresenceDO,
+	PresenceManager,
 } from "./datastorePresenceManagerFactory.js";
 
 export type { LatestValueControls } from "./latestValueControls.js";