@fluidframework/datastore 2.0.0-internal.6.4.0 → 2.0.0-internal.7.1.0

package/src/dataStoreRuntime.ts

@@ -63,7 +63,6 @@ import {
 	createResponseError,
 	exceptionToResponse,
 	GCDataBuilder,
-	requestFluidObject,
 	unpackChildNodesUsedRoutes,
 } from "@fluidframework/runtime-utils";
 import {
@@ -82,12 +81,18 @@ import {
 import { RemoteChannelContext } from "./remoteChannelContext";
 import { FluidObjectHandle } from "./fluidHandle";
 
+/**
+ * @public
+ */
 export enum DataStoreMessageType {
 	// Creates a new channel
 	Attach = "attach",
 	ChannelOp = "op",
 }
 
+/**
+ * @public
+ */
 export interface ISharedObjectRegistry {
 	// TODO consider making this async. A consequence is that either the creation of a distributed data type
 	// is async or we need a new API to split the synchronous vs. asynchronous creation.
@@ -96,6 +101,8 @@ export interface ISharedObjectRegistry {
 
 /**
  * Base data store class
+ *
+ * @public
  */
 export class FluidDataStoreRuntime
 	extends TypedEventEmitter<IFluidDataStoreRuntimeEvents>
@@ -118,14 +125,14 @@ export class FluidDataStoreRuntime
 			context,
 			sharedObjectRegistry,
 			existing,
-			async (dataStoreRuntime) => requestFluidObject(dataStoreRuntime, "/"),
+			async (dataStoreRuntime) => dataStoreRuntime.entryPoint,
 		);
 	}
 
 	/**
 	 * {@inheritDoc @fluidframework/datastore-definitions#IFluidDataStoreRuntime.entryPoint}
 	 */
-	public readonly entryPoint?: IFluidHandle<FluidObject>;
+	public readonly entryPoint: IFluidHandle<FluidObject>;
 
 	/**
 	 * @deprecated - Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
@@ -235,7 +242,7 @@ export class FluidDataStoreRuntime
 	 * @param dataStoreContext - Context object for the runtime.
 	 * @param sharedObjectRegistry - The registry of shared objects that this data store will be able to instantiate.
 	 * @param existing - Pass 'true' if loading this datastore from an existing file; pass 'false' otherwise.
-	 * @param initializeEntryPoint - Function to initialize the entryPoint object for the data store runtime. The
+	 * @param provideEntryPoint - Function to initialize the entryPoint object for the data store runtime. The
 	 * handle to this data store runtime will point to the object returned by this function. If this function is not
 	 * provided, the handle will be left undefined. This is here so we can start making handles a first-class citizen
 	 * and the primary way of interacting with some Fluid objects, and should be used if possible.
@@ -244,7 +251,7 @@ export class FluidDataStoreRuntime
 		private readonly dataStoreContext: IFluidDataStoreContext,
 		private readonly sharedObjectRegistry: ISharedObjectRegistry,
 		existing: boolean,
-		initializeEntryPoint?: (runtime: IFluidDataStoreRuntime) => Promise<FluidObject>,
+		provideEntryPoint: (runtime: IFluidDataStoreRuntime) => Promise<FluidObject>,
 	) {
 		super();
 
@@ -329,14 +336,11 @@ export class FluidDataStoreRuntime
 			});
 		}
 
-		if (initializeEntryPoint) {
-			const promise = new LazyPromise(async () => initializeEntryPoint(this));
-			this.entryPoint = new FluidObjectHandle<FluidObject>(
-				promise,
-				"",
-				this.objectsRoutingContext,
-			);
-		}
+		this.entryPoint = new FluidObjectHandle<FluidObject>(
+			new LazyPromise(async () => provideEntryPoint(this)),
+			"",
+			this.objectsRoutingContext,
+		);
 
 		this.attachListener();
 		this._attachState = dataStoreContext.attachState;
@@ -525,17 +529,6 @@ export class FluidDataStoreRuntime
 		this.makeVisibleAndAttachGraph();
 	}
 
-	/**
-	 * @deprecated - Not necessary if consumers add a new dataStore to the container by storing its handle.
-	 * Binds this runtime to the container
-	 * This includes the following:
-	 * 1. Sending an Attach op that includes all existing state
-	 * 2. Attaching the graph if the data store becomes attached.
-	 */
-	public bindToContext() {
-		this.makeVisibleAndAttachGraph();
-	}
-
 	public bind(handle: IFluidHandle): void {
 		// If visible, attach the incoming handle's graph. Else, this will be done when we become visible.
 		if (this.visibilityState !== VisibilityState.NotVisible) {
@@ -1129,6 +1122,8 @@ export class FluidDataStoreRuntime
  * Request handler is only called when data store can't resolve request, i.e. for custom requests.
  * @param Base - base class, inherits from FluidDataStoreRuntime
  * @param requestHandler - request handler to mix in
+ *
+ * @public
  */
 export const mixinRequestHandler = (
 	requestHandler: (request: IRequest, runtime: FluidDataStoreRuntime) => Promise<IResponse>,
@@ -1149,6 +1144,8 @@ export const mixinRequestHandler = (
  * @param handler - handler that returns info about blob to be added to summary.
  * Or undefined not to add anything to summary.
  * @param Base - base class, inherits from FluidDataStoreRuntime
+ *
+ * @public
  */
 export const mixinSummaryHandler = (
 	handler: (

package/src/fluidHandle.ts

@@ -8,6 +8,8 @@ import { generateHandleContextPath } from "@fluidframework/runtime-utils";
 
 /**
  * Handle for a shared {@link @fluidframework/core-interfaces#FluidObject}.
+ *
+ * @public
  */
 export class FluidObjectHandle<T extends FluidObject = FluidObject> implements IFluidHandle {
 	private readonly pendingHandlesToMakeVisible: Set<IFluidHandle> = new Set();