@fluidframework/shared-object-base 2.0.0-internal.7.3.0 → 2.0.0-internal.8.0.0

package/src/remoteObjectHandle.ts

@@ -9,16 +9,9 @@ import {
 	IFluidHandle,
 	IFluidHandleContext,
 	IRequest,
-	IResponse,
 	FluidObject,
-	// eslint-disable-next-line import/no-deprecated
-	IFluidRouter,
 } from "@fluidframework/core-interfaces";
-import {
-	create404Response,
-	exceptionToResponse,
-	responseToException,
-} from "@fluidframework/runtime-utils";
+import { responseToException } from "@fluidframework/runtime-utils";
 
 /**
  * This handle is used to dynamically load a Fluid object on a remote client and is created on parsing a serialized
@@ -28,12 +21,6 @@ import {
  * IFluidHandle can be retrieved by calling `get` on it.
  */
 export class RemoteFluidObjectHandle implements IFluidHandle {
-	/**
-	 * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
-	 */
-	public get IFluidRouter() {
-		return this;
-	}
 	public get IFluidHandleContext() {
 		return this;
 	}
@@ -86,21 +73,4 @@ export class RemoteFluidObjectHandle implements IFluidHandle {
 	public bind(handle: IFluidHandle): void {
 		handle.attachGraph();
 	}
-
-	/**
-	 * @deprecated Will be removed in future major release. Migrate all usage of IFluidRouter to the "entryPoint" pattern. Refer to Removing-IFluidRouter.md
-	 */
-	public async request(request: IRequest): Promise<IResponse> {
-		try {
-			// eslint-disable-next-line import/no-deprecated
-			const object: FluidObject<IFluidRouter> = await this.get();
-			const router = object.IFluidRouter;
-
-			return router === undefined
-				? create404Response(request)
-				: await router.request(request);
-		} catch (error) {
-			return exceptionToResponse(error);
-		}
-	}
 }

package/src/serializer.ts

@@ -12,6 +12,7 @@ import { RemoteFluidObjectHandle } from "./remoteObjectHandle";
 
 /**
  * JSON serialized form of an IFluidHandle
+ * @internal
  */
 export interface ISerializedHandle {
 	// Marker to indicate to JSON.parse that the object is a Fluid handle
@@ -21,9 +22,15 @@ export interface ISerializedHandle {
 	url: string;
 }
 
+/**
+ * @internal
+ */
 export const isSerializedHandle = (value: any): value is ISerializedHandle =>
 	value?.type === "__fluid_handle__";
 
+/**
+ * @alpha
+ */
 export interface IFluidSerializer {
 	/**
 	 * Given a mostly-plain object that may have handle objects embedded within, will return a fully-plain object
@@ -59,6 +66,7 @@ export interface IFluidSerializer {
 
 /**
  * Data Store serializer implementation
+ * @alpha
  */
 export class FluidSerializer implements IFluidSerializer {
 	private readonly root: IFluidHandleContext;

package/src/sharedObject.ts

@@ -40,6 +40,7 @@ import { ISharedObject, ISharedObjectEvents } from "./types";
 
 /**
  * Base class from which all shared objects derive.
+ * @alpha
  */
 export abstract class SharedObjectCore<TEvent extends ISharedObjectEvents = ISharedObjectEvents>
 	extends EventEmitterWithErrorHandling<TEvent>
@@ -543,9 +544,6 @@ export abstract class SharedObjectCore<TEvent extends ISharedObjectEvents = ISha
 	 * attached to them by the consumers of the DDS). It should not be called from outside the class or to emit events
 	 * which are only internal to the DDS. Support for calling it from outside the DDS instance might be removed in the
 	 * future.
-	 *
-	 * @internal
-	 *
 	 * @param event - The event to emit.
 	 * @param args - Arguments to pass to the event listeners.
 	 * @returns `true` if the event had listeners, `false` otherwise.
@@ -583,6 +581,7 @@ export abstract class SharedObjectCore<TEvent extends ISharedObjectEvents = ISha
 /**
  * SharedObject with simplified, synchronous summarization and GC.
  * DDS implementations with async and incremental summarization should extend SharedObjectCore directly instead.
+ * @alpha
  */
 export abstract class SharedObject<
 	TEvent extends ISharedObjectEvents = ISharedObjectEvents,

package/src/summarySerializer.ts

@@ -8,6 +8,7 @@ import { FluidSerializer } from "./serializer";
 
 /**
  * Serializer implementation for serializing handles during summary.
+ * @alpha
  */
 export class SummarySerializer extends FluidSerializer {
 	private readonly serializedRoutes: Set<string> = new Set();

package/src/types.ts

@@ -14,6 +14,7 @@ import { IGarbageCollectionData } from "@fluidframework/runtime-definitions";
 
 /**
  * Events emitted by {@link ISharedObject}.
+ * @alpha
  */
 export interface ISharedObjectEvents extends IErrorEvent {
 	/**
@@ -53,6 +54,7 @@ export interface ISharedObjectEvents extends IErrorEvent {
 
 /**
  * Base interface for shared objects from which other interfaces derive. Implemented by SharedObject
+ * @alpha
  */
 export interface ISharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents>
 	extends IChannel,

package/src/utils.ts

@@ -16,6 +16,7 @@ import { IFluidSerializer } from "./serializer";
  * @param context - The handle context for the container
  * @param bind - Bind any other handles we find in the object against this given handle.
  * @returns Result of strigifying an object
+ * @internal
  */
 export function serializeHandles(
 	value: any,
@@ -37,6 +38,7 @@ export function serializeHandles(
  * @param context - The handle context for the container
  * @param bind - Bind any other handles we find in the object against this given handle.
  * @returns The fully-plain object
+ * @internal
  */
 export function makeHandlesSerializable(
 	value: any,
@@ -54,6 +56,7 @@ export function makeHandlesSerializable(
  * @param serializer - The serializer that knows how to convert serializable-form handles into handle objects
  * @param context - The handle context for the container
  * @returns The mostly-plain object with handle objects within
+ * @internal
  */
 export function parseHandles(value: any, serializer: IFluidSerializer) {
 	// eslint-disable-next-line @typescript-eslint/no-unsafe-return
@@ -65,6 +68,7 @@ export function parseHandles(value: any, serializer: IFluidSerializer) {
  * @param key - the key for the blob in the summary
  * @param content - blob content
  * @returns The summary containing the blob
+ * @internal
  */
 export function createSingleBlobSummary(
 	key: string,

package/src/valueType.ts

@@ -5,6 +5,7 @@
 
 /**
  * enum representing the possible types of a shared object
+ * @internal
  */
 export enum ValueType {
 	/**