@fluidframework/fluid-static 2.41.0-338401 → 2.41.0

package/src/rootDataObject.ts

@@ -14,8 +14,16 @@ import {
 	FluidDataStoreRegistry,
 	type MinimumVersionForCollab,
 } from "@fluidframework/container-runtime/internal";
-import type { IContainerRuntime } from "@fluidframework/container-runtime-definitions/internal";
-import type { FluidObject, IFluidLoadable } from "@fluidframework/core-interfaces";
+import type {
+	IContainerRuntime,
+	IContainerRuntimeInternal,
+} from "@fluidframework/container-runtime-definitions/internal";
+import type {
+	FluidObject,
+	FluidObjectKeys,
+	IFluidLoadable,
+} from "@fluidframework/core-interfaces";
+import { assert } from "@fluidframework/core-utils/internal";
 import type { IChannelFactory } from "@fluidframework/datastore-definitions/internal";
 import type { IDirectory } from "@fluidframework/map/internal";
 import type { IFluidDataStoreRegistry } from "@fluidframework/runtime-definitions/internal";
@@ -29,6 +37,7 @@ import type {
 	CompatibilityMode,
 	ContainerSchema,
 	IRootDataObject,
+	IStaticEntryPoint,
 	LoadableObjectKind,
 	LoadableObjectKindRecord,
 	LoadableObjectRecord,
@@ -59,18 +68,22 @@ interface RootDataObjectProps {
 	readonly initialObjects: LoadableObjectKindRecord;
 }
 
+interface IProvideRootDataObject {
+	readonly RootDataObject: RootDataObject;
+}
+
 /**
  * The entry-point/root collaborative object of the {@link IFluidContainer | Fluid Container}.
  * Abstracts the dynamic code required to build a Fluid Container into a static representation for end customers.
  */
 class RootDataObject
 	extends DataObject<{ InitialState: RootDataObjectProps }>
-	implements IRootDataObject
+	implements IRootDataObject, IProvideRootDataObject
 {
 	private readonly initialObjectsDirKey = "initial-objects-key";
 	private readonly _initialObjects: LoadableObjectRecord = {};
 
-	public get IRootDataObject(): IRootDataObject {
+	public get RootDataObject(): RootDataObject {
 		return this;
 	}
 
@@ -173,8 +186,9 @@ const rootDataStoreId = "rootDOId";
 
 /**
  * Creates an {@link @fluidframework/aqueduct#BaseContainerRuntimeFactory} which constructs containers
- * with a single {@link IRootDataObject} as their entry point, where the root data object's registry
- * and initial objects are configured based on the provided schema (and optionally, data store registry).
+ * with an entry point containing single IRootDataObject (entry point is opaque to caller),
+ * where the root data object's registry and initial objects are configured based on the provided
+ * schema (and optionally, data store registry).
  *
  * @internal
  */
@@ -203,9 +217,35 @@ export function createDOProviderContainerRuntimeFactory(props: {
 	);
 }
 
+function makeFluidObject<T extends object, K extends FluidObjectKeys<T> = FluidObjectKeys<T>>(
+	object: Omit<T, K>,
+	providerKey: K,
+): T {
+	return Object.defineProperty(object, providerKey, { value: object }) as T;
+}
+
+async function provideEntryPoint(
+	containerRuntime: IContainerRuntime,
+): Promise<IStaticEntryPoint> {
+	const entryPoint = await containerRuntime.getAliasedDataStoreEntryPoint(rootDataStoreId);
+	if (entryPoint === undefined) {
+		throw new Error(`default dataStore [${rootDataStoreId}] must exist`);
+	}
+	const rootDataObject = ((await entryPoint.get()) as FluidObject<RootDataObject>)
+		.RootDataObject;
+	assert(rootDataObject !== undefined, 0xb9f /* entryPoint must be of type RootDataObject */);
+	return makeFluidObject<IStaticEntryPoint>(
+		{
+			rootDataObject,
+			extensionStore: containerRuntime as IContainerRuntimeInternal,
+		},
+		"IStaticEntryPoint",
+	);
+}
+
 /**
- * Factory for Container Runtime instances that provide a single {@link IRootDataObject}
- * as their entry point.
+ * Factory for Container Runtime instances that provide a {@link IStaticEntryPoint}
+ * (containing single {@link IRootDataObject}) as their entry point.
  */
 class DOProviderContainerRuntimeFactory extends BaseContainerRuntimeFactory {
 	private readonly rootDataObjectFactory: DataObjectFactory<
@@ -239,16 +279,6 @@ class DOProviderContainerRuntimeFactory extends BaseContainerRuntimeFactory {
 			{ InitialState: RootDataObjectProps }
 		>,
 	) {
-		const provideEntryPoint = async (
-			containerRuntime: IContainerRuntime,
-			// eslint-disable-next-line unicorn/consistent-function-scoping
-		): Promise<FluidObject> => {
-			const entryPoint = await containerRuntime.getAliasedDataStoreEntryPoint(rootDataStoreId);
-			if (entryPoint === undefined) {
-				throw new Error(`default dataStore [${rootDataStoreId}] must exist`);
-			}
-			return entryPoint.get();
-		};
 		super({
 			registryEntries: [rootDataObjectFactory.registryEntry],
 			runtimeOptions: compatibilityModeRuntimeOptions[compatibilityMode],

package/src/types.ts

@@ -4,6 +4,7 @@
  */
 
 import type { DataObjectKind } from "@fluidframework/aqueduct/internal";
+import type { ContainerExtensionStore } from "@fluidframework/container-runtime-definitions/internal";
 import type { IEvent, IEventProvider, IFluidLoadable } from "@fluidframework/core-interfaces";
 import type { SharedObjectKind } from "@fluidframework/shared-object-base";
 import type { ISharedObjectKind } from "@fluidframework/shared-object-base/internal";
@@ -94,19 +95,12 @@ export interface ContainerSchema {
 	readonly dynamicObjectTypes?: readonly SharedObjectKind[];
 }
 
-/**
- * @internal
- */
-export interface IProvideRootDataObject {
-	readonly IRootDataObject: IRootDataObject;
-}
-
 /**
  * Holds the collection of objects that the container was initially created with, as well as provides the ability
  * to dynamically create further objects during usage.
  * @internal
  */
-export interface IRootDataObject extends IProvideRootDataObject {
+export interface IRootDataObject {
 	/**
 	 * Provides a record of the initial objects defined on creation.
 	 */
@@ -122,6 +116,18 @@ export interface IRootDataObject extends IProvideRootDataObject {
 	create<T>(objectClass: SharedObjectKind<T>): Promise<T>;
 }
 
+interface IProvideStaticEntryPoint {
+	readonly IStaticEntryPoint: IStaticEntryPoint;
+}
+
+/**
+ * @internal
+ */
+export interface IStaticEntryPoint extends IProvideStaticEntryPoint {
+	readonly rootDataObject: IRootDataObject;
+	readonly extensionStore: ContainerExtensionStore;
+}
+
 /**
  * Signature for {@link IMember} change events.
  *