used pattern from fluid for exposing internal implementation details

James Hunt · James Hunt · commit 6fc6ec1fd65a · 2024-07-01T15:15:51.000-05:00
diff --git a/packages/live-share-canvas/src/core/LiveCanvas.ts b/packages/live-share-canvas/src/core/LiveCanvas.ts
@@ -34,15 +34,17 @@ import {
 } from "./Geometry";
 import { IStroke, Stroke, StrokeType } from "./Stroke";
 import {
-    LiveEventScope,
-    LiveEventTarget,
     UserMeetingRole,
-    DynamicObjectRegistry,
-    LiveDataObject,
     LiveTelemetryLogger,
     ILiveEvent,
     LiveDataObjectInitializeState,
 } from "@microsoft/live-share";
+import {
+    LiveEventScope,
+    LiveEventTarget,
+    DynamicObjectRegistry,
+    LiveDataObject,
+} from "@microsoft/live-share/internal";
 import { IBrush } from "./Brush";
 import { BasicColors, IColor, lightenColor, toCssRgbaColor } from "./Colors";
 import { TelemetryEvents } from "./internals";
diff --git a/packages/live-share-media/src/LiveMediaSession.ts b/packages/live-share-media/src/LiveMediaSession.ts
@@ -8,13 +8,15 @@ import {
     createDataObjectKind,
 } from "@fluidframework/aqueduct/internal";
 import {
-    DynamicObjectRegistry,
-    LiveDataObject,
     LiveDataObjectInitializeNotNeededError,
     LiveDataObjectInitializeState,
     LiveTelemetryLogger,
     UserMeetingRole,
 } from "@microsoft/live-share";
+import {
+    DynamicObjectRegistry,
+    LiveDataObject,
+} from "@microsoft/live-share/internal";
 import { MediaPlayerSynchronizer } from "./MediaPlayerSynchronizer";
 import { ITriggerActionEvent, TelemetryEvents } from "./internals";
 import {
diff --git a/packages/live-share-media/src/LiveMediaSessionCoordinator.ts b/packages/live-share-media/src/LiveMediaSessionCoordinator.ts
@@ -4,19 +4,21 @@
  */
 
 import {
-    LiveEventScope,
     LiveTelemetryLogger,
-    LiveEventTarget,
-    IRuntimeSignaler,
     TimeInterval,
     UserMeetingRole,
-    LiveShareRuntime,
     LiveDataObjectInitializeState,
     LiveDataObjectInitializeNotNeededError,
     LiveDataObjectNotInitializedError,
-    LiveObjectSynchronizer,
     ILiveEvent,
 } from "@microsoft/live-share";
+import {
+    IRuntimeSignaler,
+    LiveEventScope,
+    LiveEventTarget,
+    LiveObjectSynchronizer,
+    LiveShareRuntime,
+} from "@microsoft/live-share/internal";
 import {
     CoordinationWaitPoint,
     ExtendedMediaMetadata,
diff --git a/packages/live-share-media/src/MediaPlayerSynchronizer.ts b/packages/live-share-media/src/MediaPlayerSynchronizer.ts
@@ -2,11 +2,8 @@
  * Copyright (c) Microsoft Corporation. All rights reserved.
  * Licensed under the Microsoft Live Share SDK License.
  */
-import {
-    LiveTelemetryLogger,
-    ILiveEvent,
-    IRuntimeSignaler,
-} from "@microsoft/live-share";
+import { LiveTelemetryLogger, ILiveEvent } from "@microsoft/live-share";
+import { IRuntimeSignaler } from "@microsoft/live-share/internal";
 import {
     ExtendedMediaSessionAction,
     ExtendedMediaSessionPlaybackState,
diff --git a/packages/live-share-media/src/internals/GroupCoordinatorState.ts b/packages/live-share-media/src/internals/GroupCoordinatorState.ts
@@ -6,11 +6,13 @@
 import {
     ILiveEvent,
     TimeInterval,
-    IRuntimeSignaler,
     LiveTelemetryLogger,
-    LiveShareRuntime,
     IEvent,
 } from "@microsoft/live-share";
+import {
+    IRuntimeSignaler,
+    LiveShareRuntime,
+} from "@microsoft/live-share/internal";
 import {
     ExtendedMediaMetadata,
     CoordinationWaitPoint,
diff --git a/packages/live-share-media/src/internals/GroupPlaybackPosition.ts b/packages/live-share-media/src/internals/GroupPlaybackPosition.ts
@@ -3,11 +3,11 @@
  * Licensed under the Microsoft Live Share SDK License.
  */
 
+import { TimeInterval } from "@microsoft/live-share";
 import {
     IRuntimeSignaler,
-    TimeInterval,
     LiveShareRuntime,
-} from "@microsoft/live-share";
+} from "@microsoft/live-share/internal";
 import { GroupTransportState } from "./GroupTransportState";
 import { GroupPlaybackTrackEvents } from "./GroupPlaybackTrack";
 import {
diff --git a/packages/live-share-media/src/internals/GroupTransportState.ts b/packages/live-share-media/src/internals/GroupTransportState.ts
@@ -3,7 +3,7 @@
  * Licensed under the Microsoft Live Share SDK License.
  */
 
-import { LiveShareRuntime } from "@microsoft/live-share";
+import { LiveShareRuntime } from "@microsoft/live-share/internal";
 import { TypedEventEmitter } from "@fluid-internal/client-utils";
 import { IMediaPlayerState } from "../LiveMediaSessionCoordinator";
 import {
diff --git a/packages/live-share-media/src/test/GroupPlaybackPosition.spec.ts b/packages/live-share-media/src/test/GroupPlaybackPosition.spec.ts
@@ -18,12 +18,11 @@ import {
     ICurrentPlaybackPosition,
     ITransportState,
 } from "../internals";
+import { TestLiveShareHost, TimeInterval } from "@microsoft/live-share";
 import {
     IRuntimeSignaler,
-    TestLiveShareHost,
-    TimeInterval,
-} from "@microsoft/live-share";
-import { MockLiveShareRuntime } from "@microsoft/live-share/src/internals/test/MockLiveShareRuntime";
+    MockLiveShareRuntime,
+} from "@microsoft/live-share/internal";
 import { IMediaPlayerState } from "../LiveMediaSessionCoordinator";
 
 function createTransportUpdate(
diff --git a/packages/live-share-media/src/test/GroupPlaybackTrack.spec.ts b/packages/live-share-media/src/test/GroupPlaybackTrack.spec.ts
@@ -11,7 +11,7 @@ import {
     IPlaybackTrackChangeEvent,
 } from "../internals/GroupPlaybackTrack";
 import { ExtendedMediaMetadata } from "../MediaSessionExtensions";
-import { Deferred } from "@microsoft/live-share/src/internals/Deferred";
+import { Deferred } from "@microsoft/live-share/internal";
 
 describe("GroupPlaybackTrack", () => {
     const track1 = {
diff --git a/packages/live-share-media/src/test/LiveMediaSession_ManualActionHandler.spec.ts b/packages/live-share-media/src/test/LiveMediaSession_ManualActionHandler.spec.ts
@@ -4,7 +4,6 @@
  */
 
 import { TestLiveMediaSession, TestMediaTimeStampProvider } from "./TestUtils";
-import { Deferred } from "@microsoft/live-share/src/internals/Deferred";
 import { strict as assert } from "assert";
 import {
     ITestObjectProvider,
@@ -13,15 +12,18 @@ import {
 } from "@fluidframework/test-utils/internal";
 import {
     ITimestampProvider,
-    LiveEventScope,
-    LiveEventTarget,
     LocalTimestampProvider,
     UserMeetingRole,
+    TestLiveShareHost,
 } from "@microsoft/live-share";
-import { TestLiveShareHost } from "@microsoft/live-share";
-import { getLiveDataObjectKind } from "@microsoft/live-share";
-import { waitForDelay } from "@microsoft/live-share/src/internals/utils";
-import { MockLiveShareRuntime } from "@microsoft/live-share/src/internals/test/MockLiveShareRuntime";
+import {
+    getLiveDataObjectKind,
+    LiveEventScope,
+    LiveEventTarget,
+    MockLiveShareRuntime,
+    waitForDelay,
+    Deferred,
+} from "@microsoft/live-share/internal";
 import {
     ExtendedMediaMetadata,
     ExtendedMediaSessionActionDetails,
diff --git a/packages/live-share-media/src/test/LiveMediaSession_Synchronizer.spec.ts b/packages/live-share-media/src/test/LiveMediaSession_Synchronizer.spec.ts
@@ -8,23 +8,25 @@ import {
     TestMediaPlayer,
     TestMediaTimeStampProvider,
 } from "./TestUtils";
-import { Deferred } from "@microsoft/live-share/src/internals/Deferred";
 import { strict as assert } from "assert";
 import {
-    ITestObjectProvider,
-    fluidEntryPoint,
     getContainerEntryPointBackCompat,
+    fluidEntryPoint,
+    ITestObjectProvider,
 } from "@fluidframework/test-utils/internal";
 import {
     ITimestampProvider,
     LocalTimestampProvider,
     UserMeetingRole,
 } from "@microsoft/live-share";
 import { TestLiveShareHost } from "@microsoft/live-share";
-import { getLiveDataObjectKind } from "@microsoft/live-share";
-import { waitForDelay } from "@microsoft/live-share/src/internals/utils";
-import { MockLiveShareRuntime } from "@microsoft/live-share/src/internals/test/MockLiveShareRuntime";
-import { isErrorLike } from "@microsoft/live-share/src/internals/type-guards";
+import { getLiveDataObjectKind } from "@microsoft/live-share/internal";
+import {
+    Deferred,
+    isErrorLike,
+    MockLiveShareRuntime,
+    waitForDelay,
+} from "@microsoft/live-share/internal";
 import {
     ExtendedMediaMetadata,
     ExtendedMediaSessionAction,
diff --git a/packages/live-share-media/src/test/TestUtils.ts b/packages/live-share-media/src/test/TestUtils.ts
@@ -4,13 +4,13 @@
  */
 
 import { IMediaPlayer } from "../IMediaPlayer";
-import { Deferred } from "@microsoft/live-share/src/internals/Deferred";
 import { LiveMediaSession } from "../LiveMediaSession";
+import { ITimestampProvider } from "@microsoft/live-share";
 import {
+    Deferred,
     IRuntimeSignaler,
-    ITimestampProvider,
     LiveShareRuntime,
-} from "@microsoft/live-share";
+} from "@microsoft/live-share/internal";
 
 export class TestMediaPlayer implements IMediaPlayer {
     private done = new Deferred<string>();
diff --git a/packages/live-share-media/src/test/VolumeManager.spec.ts b/packages/live-share-media/src/test/VolumeManager.spec.ts
@@ -1,8 +1,7 @@
 import { strict as assert } from "assert";
 import { IMediaPlayer } from "../IMediaPlayer";
 import { LimitLevelType, VolumeManager } from "../VolumeManager";
-import { Deferred } from "@microsoft/live-share/src/internals/Deferred";
-import { waitForDelay } from "@microsoft/live-share/src/internals/utils";
+import { Deferred, waitForDelay } from "@microsoft/live-share/internal";
 
 // few millis more than max timeout callback in scheduleAnimationFrame
 const milliTolerance = 25;
diff --git a/packages/live-share-react/src/providers/AzureProvider.tsx b/packages/live-share-react/src/providers/AzureProvider.tsx
@@ -14,10 +14,8 @@ import {
     ISharedStateRegistryResponse,
     useSharedStateRegistry,
 } from "../shared-hooks";
-import {
-    BaseLiveShareClient,
-    AzureLiveShareClient,
-} from "@microsoft/live-share";
+import { AzureLiveShareClient } from "@microsoft/live-share";
+import { BaseLiveShareClient } from "@microsoft/live-share/internal";
 
 /**
  * React Context provider values for `<AzureProvider>` and `<LiveShareProvider>`.
diff --git a/packages/live-share-react/src/shared-hooks/useSharedStateRegistry.ts b/packages/live-share-react/src/shared-hooks/useSharedStateRegistry.ts
@@ -22,7 +22,7 @@ import {
     getRootDirectory,
     TurboDirectory,
     TurboStateMap,
-} from "@microsoft/live-share";
+} from "@microsoft/live-share/internal";
 
 /**
  * Response for the {@link useSharedStateRegistry} hook.
diff --git a/packages/live-share/internal.ts b/packages/live-share/internal.ts
@@ -0,0 +1,17 @@
+// Exposed for other live share libs, or advanced use cases.
+export * from "./bin/internals/BaseLiveShareClient";
+export * from "./bin/internals/Deferred";
+export * from "./bin/internals/DynamicObjectRegistry";
+export * from "./bin/internals/DynamicObjectManager";
+export * from "./bin/internals/LiveDataObject";
+export * from "./bin/internals/LiveEventScope";
+export * from "./bin/internals/LiveEventSource";
+export * from "./bin/internals/LiveEventTarget";
+export * from "./bin/internals/LiveObjectSynchronizer";
+export * from "./bin/internals/LiveShareRuntime";
+export * from "./bin/internals/schema-injection-utils";
+export * from "./bin/internals/smuggle";
+
+export { waitForDelay, waitUntilConnected } from "./bin/internals/utils";
+export { MockLiveShareRuntime } from "./bin/internals/mock/MockLiveShareRuntime";
+export { isErrorLike } from "./bin/internals/type-guards";
diff --git a/packages/live-share/src/index.ts b/packages/live-share/src/index.ts
@@ -20,16 +20,3 @@ export * from "./LocalTimestampProvider";
 export * from "./TestLiveShareHost";
 export * from "./TimeInterval";
 export * from "./TimestampProvider";
-
-// Exposed for other live share libs, or advanced use cases.
-export * from "./internals/BaseLiveShareClient";
-export * from "./internals/DynamicObjectRegistry";
-export * from "./internals/DynamicObjectManager";
-export * from "./internals/LiveDataObject";
-export * from "./internals/LiveEventScope";
-export * from "./internals/LiveEventSource";
-export * from "./internals/LiveEventTarget";
-export * from "./internals/LiveObjectSynchronizer";
-export * from "./internals/LiveShareRuntime";
-export * from "./internals/schema-injection-utils";
-export * from "./internals/smuggle";
diff --git a/packages/live-share/src/internals/mock/MockContainerRuntimeSignaler.ts b/packages/live-share/src/internals/mock/MockContainerRuntimeSignaler.ts
diff --git a/packages/live-share/src/internals/mock/MockLiveShareRuntime.ts b/packages/live-share/src/internals/mock/MockLiveShareRuntime.ts
diff --git a/packages/live-share/src/internals/mock/MockRoleVerifier.ts b/packages/live-share/src/internals/mock/MockRoleVerifier.ts
@@ -14,7 +14,7 @@ export class MockRoleVerifier implements IRoleVerifier {
 
     public blocked = false;
     public called = false;
-    public clientId: string;
+    public clientId: string = "";
 
     public verifyRolesAllowed(
         clientId: string,
diff --git a/packages/live-share/src/internals/mock/MockRuntimeSignaler.ts b/packages/live-share/src/internals/mock/MockRuntimeSignaler.ts
diff --git a/packages/live-share/src/internals/mock/MockTimestampProvider.ts b/packages/live-share/src/internals/mock/MockTimestampProvider.ts
@@ -3,7 +3,7 @@
  * Licensed under the Microsoft Live Share SDK License.
  */
 
-import { ITimestampProvider } from "../interfaces";
+import { ITimestampProvider } from "../../interfaces";
 
 export class MockTimestampProvider implements ITimestampProvider {
     public called = false;
diff --git a/packages/live-share/src/internals/test/LiveEventScope.spec.ts b/packages/live-share/src/internals/test/LiveEventScope.spec.ts
@@ -6,9 +6,9 @@
 import { strict as assert } from "assert";
 import { LiveEventScope } from "../LiveEventScope";
 import { UserMeetingRole } from "../../interfaces";
-import { MockRuntimeSignaler } from "./MockRuntimeSignaler";
-import { MockRoleVerifier } from "./MockRoleVerifier";
-import { MockTimestampProvider } from "../../test/MockTimestampProvider";
+import { MockRuntimeSignaler } from "../mock/MockRuntimeSignaler";
+import { MockRoleVerifier } from "../mock/MockRoleVerifier";
+import { MockTimestampProvider } from "../mock/MockTimestampProvider";
 import { LocalTimestampProvider } from "../../LocalTimestampProvider";
 import { TestLiveShareHost } from "../../TestLiveShareHost";
 import { LiveShareRuntime } from "../LiveShareRuntime";
diff --git a/packages/live-share/src/internals/test/LiveEventSource.spec.ts b/packages/live-share/src/internals/test/LiveEventSource.spec.ts
@@ -6,7 +6,7 @@
 import { strict as assert } from "assert";
 import { LiveEventScope } from "../LiveEventScope";
 import { LiveEventSource } from "../LiveEventSource";
-import { MockRuntimeSignaler } from "../test/MockRuntimeSignaler";
+import { MockRuntimeSignaler } from "../mock/MockRuntimeSignaler";
 import { LiveShareRuntime } from "../LiveShareRuntime";
 import { TestLiveShareHost } from "../../TestLiveShareHost";
 import { LocalTimestampProvider } from "../../LocalTimestampProvider";
diff --git a/packages/live-share/src/internals/test/LiveEventTarget.spec.ts b/packages/live-share/src/internals/test/LiveEventTarget.spec.ts
@@ -6,7 +6,7 @@
 import { strict as assert } from "assert";
 import { LiveEventScope } from "../LiveEventScope";
 import { LiveEventTarget } from "../LiveEventTarget";
-import { MockRuntimeSignaler } from "../test/MockRuntimeSignaler";
+import { MockRuntimeSignaler } from "../mock/MockRuntimeSignaler";
 import { LiveShareRuntime } from "../LiveShareRuntime";
 import { TestLiveShareHost } from "../../TestLiveShareHost";
 import { LocalTimestampProvider } from "../../LocalTimestampProvider";
diff --git a/packages/live-share/src/internals/test/LiveObjectSynchronizer.spec.ts b/packages/live-share/src/internals/test/LiveObjectSynchronizer.spec.ts
@@ -5,10 +5,10 @@
 
 import { strict as assert } from "assert";
 import { LiveObjectSynchronizer } from "../LiveObjectSynchronizer";
-import { MockRuntimeSignaler } from "./MockRuntimeSignaler";
+import { MockRuntimeSignaler } from "../mock/MockRuntimeSignaler";
 import { Deferred } from "../Deferred";
 import { waitForDelay } from "../utils";
-import { MockLiveShareRuntime } from "./MockLiveShareRuntime";
+import { MockLiveShareRuntime } from "../mock/MockLiveShareRuntime";
 
 interface ITestState {
     client: "local" | "remote";
diff --git a/packages/live-share/src/test/LiveEvent.spec.ts b/packages/live-share/src/test/LiveEvent.spec.ts
@@ -10,8 +10,8 @@ import {
     getContainerEntryPointBackCompat,
 } from "@fluidframework/test-utils/internal";
 import { LiveEvent } from "../LiveEvent";
-import { MockTimestampProvider } from "./MockTimestampProvider";
-import { MockRoleVerifier } from "../internals/test/MockRoleVerifier";
+import { MockTimestampProvider } from "../internals/mock/MockTimestampProvider";
+import { MockRoleVerifier } from "../internals/mock/MockRoleVerifier";
 import { LocalTimestampProvider } from "../LocalTimestampProvider";
 import { UserMeetingRole, ILiveEvent } from "../interfaces";
 import { TestLiveShareHost } from "../TestLiveShareHost";
diff --git a/packages/live-share/src/test/LiveFollowMode.spec.ts b/packages/live-share/src/test/LiveFollowMode.spec.ts
@@ -16,7 +16,7 @@ import {
     LiveFollowMode,
 } from "../LiveFollowMode";
 import { getLiveDataObjectKind } from "../internals/schema-injection-utils";
-import { MockLiveShareRuntime } from "../internals/test/MockLiveShareRuntime";
+import { MockLiveShareRuntime } from "../internals/mock/MockLiveShareRuntime";
 import { LivePresenceUser } from "../LivePresenceUser";
 import { describeCompat } from "@live-share-private/test-utils";
 import { waitForDelay } from "../internals/utils";
diff --git a/packages/live-share/src/test/LivePresence.spec.ts b/packages/live-share/src/test/LivePresence.spec.ts
@@ -23,7 +23,7 @@ import {
 } from "../interfaces";
 import { TestLiveShareHost } from "../TestLiveShareHost";
 import { getLiveDataObjectKind } from "../internals/schema-injection-utils";
-import { MockLiveShareRuntime } from "../internals/test/MockLiveShareRuntime";
+import { MockLiveShareRuntime } from "../internals/mock/MockLiveShareRuntime";
 import { describeCompat } from "@live-share-private/test-utils";
 
 class TestLivePresence<
diff --git a/packages/live-share/src/test/LiveState.spec.ts b/packages/live-share/src/test/LiveState.spec.ts
@@ -12,7 +12,7 @@ import {
 import { LiveState } from "../LiveState";
 import { Deferred } from "../internals/Deferred";
 import { getLiveDataObjectKind } from "../internals/schema-injection-utils";
-import { MockLiveShareRuntime } from "../internals/test/MockLiveShareRuntime";
+import { MockLiveShareRuntime } from "../internals/mock/MockLiveShareRuntime";
 import { describeCompat } from "@live-share-private/test-utils";
 
 interface TestStateData {
diff --git a/packages/live-share/src/test/LiveTimer.spec.ts b/packages/live-share/src/test/LiveTimer.spec.ts
diff --git a/packages/live-share/tsconfig.build.json b/packages/live-share/tsconfig.build.json
diff --git a/packages/live-share/tsconfig.json b/packages/live-share/tsconfig.json
