refactor(client-presence): split files for encapsulated support (microsoft#26237)

1. Separate types where there might be multiple internal uses -
especially potentially across layers

origin -> new types location
-------------------------------
broadcastControls.ts -> broadcastControlsTypes.ts 
notificationsManager.ts -> notificationsManagerTypes.ts

2. Break up internalTypes.ts

type -> new location
-----------------------
ExtensionRuntimeProperties, ExtensionHost, IEphemeralRuntime ->
runtimeTypes.ts
ClientRecord -> stateDatastore.ts
PostUpdateAction, ValueManager -> statesManagerTypes.ts
Validatable* -> validatableTypes.ts

Author: jason-ha

packages/framework/presence/src/broadcastControls.ts

@@ -3,61 +3,7 @@
  * Licensed under the MIT License.
  */
 
-/**
- * Common controls for States objects.
- *
- * @sealed
- * @beta
- */
-export interface BroadcastControls {
-	/**
-	 * Maximum time in milliseconds that a local value update is allowed
-	 * to remain pending before it must be broadcast.
-	 *
-	 * @remarks
-	 * There is no guarantee of broadcast within time allowed
-	 * as other conditions such as disconnect or service throttling may
-	 * cause a delay.
-	 *
-	 * Setting to `undefined` will restore to a system default.
-	 */
-	allowableUpdateLatencyMs: number | undefined;
-
-	/**
-	 * Target time in milliseconds between oldest changed local state
-	 * has been broadcast and forced rebroadcast of all local values.
-	 * A value of less than 10 disables forced refresh.
-	 *
-	 * @privateRemarks
-	 * Any time less than 10 milliseconds is likely to generate too
-	 * many signals. Ideally this feature becomes obsolete as
-	 * we understand the system better and account for holes.
-	 */
-	// forcedRefreshIntervalMs is removed until it is supported.
-	// forcedRefreshIntervalMs: number | undefined;
-}
-
-/**
- * Value set to configure {@link BroadcastControls}.
- *
- * @beta
- */
-export interface BroadcastControlSettings {
-	/**
-	 * {@inheritdoc BroadcastControls.allowableUpdateLatencyMs}
-	 *
-	 * @defaultValue 60 [milliseconds]
-	 */
-	readonly allowableUpdateLatencyMs?: number;
-
-	/**
-	 * {@inheritdoc BroadcastControls.forcedRefreshIntervalMs}
-	 *
-	 * @defaultValue 0 (disabled)
-	 */
-	// forcedRefreshIntervalMs is removed until it is supported.
-	// readonly forcedRefreshIntervalMs?: number;
-}
+import type { BroadcastControls, BroadcastControlSettings } from "./broadcastControlsTypes.js";
 
 class ForcedRefreshControl
 	implements

packages/framework/presence/src/broadcastControlsTypes.ts

@@ -0,0 +1,60 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+/**
+ * Common controls for States objects.
+ *
+ * @sealed
+ * @beta
+ */
+export interface BroadcastControls {
+	/**
+	 * Maximum time in milliseconds that a local value update is allowed
+	 * to remain pending before it must be broadcast.
+	 *
+	 * @remarks
+	 * There is no guarantee of broadcast within time allowed
+	 * as other conditions such as disconnect or service throttling may
+	 * cause a delay.
+	 *
+	 * Setting to `undefined` will restore to a system default.
+	 */
+	allowableUpdateLatencyMs: number | undefined;
+
+	/**
+	 * Target time in milliseconds between oldest changed local state
+	 * has been broadcast and forced rebroadcast of all local values.
+	 * A value of less than 10 disables forced refresh.
+	 *
+	 * @privateRemarks
+	 * Any time less than 10 milliseconds is likely to generate too
+	 * many signals. Ideally this feature becomes obsolete as
+	 * we understand the system better and account for holes.
+	 */
+	// forcedRefreshIntervalMs is removed until it is supported.
+	// forcedRefreshIntervalMs: number | undefined;
+}
+
+/**
+ * Value set to configure {@link BroadcastControls}.
+ *
+ * @beta
+ */
+export interface BroadcastControlSettings {
+	/**
+	 * {@inheritdoc BroadcastControls.allowableUpdateLatencyMs}
+	 *
+	 * @defaultValue 60 [milliseconds]
+	 */
+	readonly allowableUpdateLatencyMs?: number;
+
+	/**
+	 * {@inheritdoc BroadcastControls.forcedRefreshIntervalMs}
+	 *
+	 * @defaultValue 0 (disabled)
+	 */
+	// forcedRefreshIntervalMs is removed until it is supported.
+	// readonly forcedRefreshIntervalMs?: number;
+}

packages/framework/presence/src/getPresence.ts

@@ -20,12 +20,12 @@ import type {
 	IFluidDataStoreContext,
 } from "@fluidframework/runtime-definitions/internal";
 
-import type { ExtensionHost, ExtensionRuntimeProperties } from "./internalTypes.js";
 import { pkgVersion } from "./packageVersion.js";
 import type { Presence, PresenceWithNotifications } from "./presence.js";
 import type { PresenceExtensionInterface } from "./presenceManager.js";
 import { createPresenceManager } from "./presenceManager.js";
 import type { SignalMessages } from "./protocol.js";
+import type { ExtensionHost, ExtensionRuntimeProperties } from "./runtimeTypes.js";
 
 const presenceCompatibility = {
 	generation: 1,

packages/framework/presence/src/index.ts

@@ -36,7 +36,7 @@ export {
 export type {
 	BroadcastControls,
 	BroadcastControlSettings,
-} from "./broadcastControls.js";
+} from "./broadcastControlsTypes.js";
 
 export {
 	getPresence,
@@ -78,14 +78,14 @@ export type {
 	ValueAccessor,
 } from "./latestValueTypes.js";
 
-export {
-	type NotificationEmitter,
-	type NotificationListenable,
-	type NotificationSubscriptions,
-	Notifications,
-	type NotificationsManager,
-	type NotificationsManagerEvents,
-} from "./notificationsManager.js";
+export { Notifications } from "./notificationsManager.js";
+export type {
+	NotificationEmitter,
+	NotificationListenable,
+	NotificationSubscriptions,
+	NotificationsManager,
+	NotificationsManagerEvents,
+} from "./notificationsManagerTypes.js";
 
 export { StateFactory } from "./stateFactory.js";
 

packages/framework/presence/src/internalUtils.ts

@@ -12,7 +12,10 @@ import type {
 	OpaqueJsonSerializable,
 } from "@fluidframework/core-interfaces/internal";
 
-import type { ValidatableOptionalState, ValidatableRequiredState } from "./internalTypes.js";
+import type {
+	ValidatableOptionalState,
+	ValidatableRequiredState,
+} from "./validatableTypes.js";
 
 /**
  * Returns union of types of values in a record.

packages/framework/presence/src/latestMapValueManager.ts

@@ -12,14 +12,9 @@ import type {
 	JsonSerializable,
 } from "@fluidframework/core-interfaces/internal/exposedUtilityTypes";
 
-import type { BroadcastControls, BroadcastControlSettings } from "./broadcastControls.js";
 import { OptionalBroadcastControl } from "./broadcastControls.js";
+import type { BroadcastControls, BroadcastControlSettings } from "./broadcastControlsTypes.js";
 import type { InternalTypes } from "./exposedInternalTypes.js";
-import type {
-	PostUpdateAction,
-	ValidatableOptionalState,
-	ValueManager,
-} from "./internalTypes.js";
 import {
 	asDeeplyReadonly,
 	asDeeplyReadonlyDeserializedJson,
@@ -40,6 +35,8 @@ import type {
 } from "./latestValueTypes.js";
 import type { AttendeeId, Attendee, Presence, SpecificAttendee } from "./presence.js";
 import { datastoreFromHandle, type StateDatastore } from "./stateDatastore.js";
+import type { PostUpdateAction, ValueManager } from "./statesManagerTypes.js";
+import type { ValidatableOptionalState } from "./validatableTypes.js";
 import { brandIVM } from "./valueManager.js";
 
 /**

packages/framework/presence/src/latestValueManager.ts

@@ -12,10 +12,9 @@ import type {
 } from "@fluidframework/core-interfaces/internal/exposedUtilityTypes";
 import { shallowCloneObject } from "@fluidframework/core-utils/internal";
 
-import type { BroadcastControls, BroadcastControlSettings } from "./broadcastControls.js";
 import { OptionalBroadcastControl } from "./broadcastControls.js";
+import type { BroadcastControls, BroadcastControlSettings } from "./broadcastControlsTypes.js";
 import type { InternalTypes } from "./exposedInternalTypes.js";
-import type { PostUpdateAction, ValueManager } from "./internalTypes.js";
 import type { FlattenUnionWithOptionals } from "./internalUtils.js";
 import {
 	asDeeplyReadonly,
@@ -34,6 +33,7 @@ import type {
 } from "./latestValueTypes.js";
 import type { Attendee, Presence } from "./presence.js";
 import { datastoreFromHandle, type StateDatastore } from "./stateDatastore.js";
+import type { PostUpdateAction, ValueManager } from "./statesManagerTypes.js";
 import { brandIVM } from "./valueManager.js";
 
 /**

packages/framework/presence/src/latestValueTypes.ts

@@ -9,9 +9,9 @@ import type {
 	OpaqueJsonDeserialized,
 } from "@fluidframework/core-interfaces/internal/exposedUtilityTypes";
 
-import type { ValidatableRequiredState } from "./internalTypes.js";
 import { asDeeplyReadonlyDeserializedJson } from "./internalUtils.js";
 import type { Attendee } from "./presence.js";
+import type { ValidatableRequiredState } from "./validatableTypes.js";
 
 /**
  * Metadata for the value state.