@fluidframework/fluid-static 2.0.0-internal.7.3.0 → 2.0.0-internal.8.0.0

package/src/serviceAudience.ts

@@ -8,6 +8,16 @@ import { IAudience, IContainer } from "@fluidframework/container-definitions";
 import { IClient } from "@fluidframework/protocol-definitions";
 import { IServiceAudience, IServiceAudienceEvents, IMember, Myself } from "./types";
 
+/**
+ * @internal
+ */
+export function createServiceAudience<M extends IMember = IMember>(props: {
+	container: IContainer;
+	createServiceMember: (audienceMember: IClient) => M;
+}): IServiceAudience<M> {
+	return new ServiceAudience(props.container, props.createServiceMember);
+}
+
 /**
  * Base class for providing audience information for sessions interacting with {@link IFluidContainer}
  *
@@ -17,15 +27,16 @@ import { IServiceAudience, IServiceAudienceEvents, IMember, Myself } from "./typ
  * the user and client details returned in {@link IMember}.
  *
  * @typeParam M - A service-specific {@link IMember} implementation.
+ * @internal
  */
-export abstract class ServiceAudience<M extends IMember = IMember>
+class ServiceAudience<M extends IMember = IMember>
 	extends TypedEventEmitter<IServiceAudienceEvents<M>>
 	implements IServiceAudience<M>
 {
 	/**
 	 * Audience object which includes all the existing members of the {@link IFluidContainer | container}.
 	 */
-	protected readonly audience: IAudience;
+	private readonly audience: IAudience;
 
 	/**
 	 * Retain the most recent member list.
@@ -44,13 +55,14 @@ export abstract class ServiceAudience<M extends IMember = IMember>
 	 * every `addMember` event. It is mapped `clientId` to `M` to be better work with what the {@link IServiceAudience}
 	 * events provide.
 	 */
-	protected lastMembers = new Map<string, M>();
+	private lastMembers = new Map<string, M>();
 
 	constructor(
 		/**
 		 * Fluid Container to read the audience from.
 		 */
-		protected readonly container: IContainer,
+		private readonly container: IContainer,
+		private readonly createServiceMember: (audienceMember: IClient) => M,
 	) {
 		super();
 		this.audience = container.audience;
@@ -77,13 +89,6 @@ export abstract class ServiceAudience<M extends IMember = IMember>
 		this.container.on("connected", () => this.emit("membersChanged"));
 	}
 
-	/**
-	 * Provides ability for inheriting class to modify/extend the audience object.
-	 *
-	 * @param audienceMember - Record of a specific audience member.
-	 */
-	protected abstract createServiceMember(audienceMember: IClient): M;
-
 	/**
 	 * {@inheritDoc IServiceAudience.getMembers}
 	 */
@@ -152,7 +157,7 @@ export abstract class ServiceAudience<M extends IMember = IMember>
 	 *
 	 * @param member - Member to be included/omitted.
 	 */
-	protected shouldIncludeAsMember(member: IClient): boolean {
+	private shouldIncludeAsMember(member: IClient): boolean {
 		// Include only human members
 		return member.details.capabilities.interactive;
 	}

package/src/types.ts

@@ -5,16 +5,17 @@
 
 import { IEvent, IEventProvider, IFluidLoadable } from "@fluidframework/core-interfaces";
 import { IChannelFactory } from "@fluidframework/datastore-definitions";
-import { IFluidDataStoreFactory } from "@fluidframework/runtime-definitions";
 
 /**
  * A mapping of string identifiers to instantiated `DataObject`s or `SharedObject`s.
+ * @alpha
  */
 export type LoadableObjectRecord = Record<string, IFluidLoadable>;
 
 /**
  * A mapping of string identifiers to classes that will later be used to instantiate a corresponding `DataObject`
  * or `SharedObject` in a {@link LoadableObjectRecord}.
+ * @alpha
  */
 export type LoadableObjectClassRecord = Record<string, LoadableObjectClass<any>>;
 
@@ -22,6 +23,7 @@ export type LoadableObjectClassRecord = Record<string, LoadableObjectClass<any>>
  * A class object of `DataObject` or `SharedObject`.
  *
  * @typeParam T - The class of the `DataObject` or `SharedObject`.
+ * @alpha
  */
 export type LoadableObjectClass<T extends IFluidLoadable> =
 	| DataObjectClass<T>
@@ -32,9 +34,10 @@ export type LoadableObjectClass<T extends IFluidLoadable> =
  * constructor that will return the type of the `DataObject`.
  *
  * @typeParam T - The class of the `DataObject`.
+ * @alpha
  */
 export type DataObjectClass<T extends IFluidLoadable> = {
-	readonly factory: IFluidDataStoreFactory;
+	readonly factory: { IFluidDataStoreFactory: DataObjectClass<T>["factory"] };
 } & LoadableObjectCtor<T>;
 
 /**
@@ -42,6 +45,7 @@ export type DataObjectClass<T extends IFluidLoadable> = {
  * constructor that will return the type of the `DataObject`.
  *
  * @typeParam T - The class of the `SharedObject`.
+ * @alpha
  */
 export type SharedObjectClass<T extends IFluidLoadable> = {
 	readonly getFactory: () => IChannelFactory;
@@ -51,6 +55,7 @@ export type SharedObjectClass<T extends IFluidLoadable> = {
  * An object with a constructor that will return an {@link @fluidframework/core-interfaces#IFluidLoadable}.
  *
  * @typeParam T - The class of the loadable object.
+ * @alpha
  */
 export type LoadableObjectCtor<T extends IFluidLoadable> = new (...args: any[]) => T;
 
@@ -61,6 +66,7 @@ export type LoadableObjectCtor<T extends IFluidLoadable> = new (...args: any[])
  *
  * It includes both the instances of objects that are initially available upon `Container` creation, as well
  * as the types of objects that may be dynamically created throughout the lifetime of the `Container`.
+ * @alpha
  */
 export interface ContainerSchema {
 	/**
@@ -96,11 +102,19 @@ export interface ContainerSchema {
 	dynamicObjectTypes?: LoadableObjectClass<any>[];
 }
 
+/**
+ * @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 {
+export interface IRootDataObject extends IProvideRootDataObject {
 	/**
 	 * Provides a record of the initial objects defined on creation.
 	 */
@@ -123,6 +137,7 @@ export interface IRootDataObject {
  * @param member - The service-specific member object for the client.
  *
  * @see See {@link IServiceAudienceEvents} for usage details.
+ * @alpha
  */
 export type MemberChangedListener<M extends IMember> = (clientId: string, member: M) => void;
 
@@ -135,6 +150,7 @@ export type MemberChangedListener<M extends IMember> = (clientId: string, member
  * {@link IServiceAudience.getMembers} method will emit events.
  *
  * @typeParam M - A service-specific {@link IMember} implementation.
+ * @alpha
  */
 export interface IServiceAudienceEvents<M extends IMember> extends IEvent {
 	/**
@@ -168,6 +184,7 @@ export interface IServiceAudienceEvents<M extends IMember> extends IEvent {
  * details about the connecting client, such as device information, environment, or a username.
  *
  * @typeParam M - A service-specific {@link IMember} type.
+ * @alpha
  */
 export interface IServiceAudience<M extends IMember>
 	extends IEventProvider<IServiceAudienceEvents<M>> {
@@ -188,6 +205,7 @@ export interface IServiceAudience<M extends IMember>
  * Base interface for information for each connection made to the Fluid session.
  *
  * @remarks This interface can be extended to provide additional information specific to each service.
+ * @alpha
  */
 export interface IConnection {
 	/**
@@ -205,6 +223,7 @@ export interface IConnection {
  * Base interface to be implemented to fetch each service's member.
  *
  * @remarks This interface can be extended by each service to provide additional service-specific user metadata.
+ * @alpha
  */
 export interface IMember {
 	/**
@@ -220,5 +239,6 @@ export interface IMember {
 
 /**
  * An extended member object that includes currentConnection
+ * @alpha
  */
 export type Myself<M extends IMember = IMember> = M & { currentConnection: string };

package/src/utils.ts

@@ -4,14 +4,31 @@
  */
 
 import { IChannelFactory } from "@fluidframework/datastore-definitions";
-import { NamedFluidDataStoreRegistryEntry } from "@fluidframework/runtime-definitions";
+import {
+	IFluidDataStoreFactory,
+	NamedFluidDataStoreRegistryEntry,
+} from "@fluidframework/runtime-definitions";
+import { IFluidLoadable } from "@fluidframework/core-interfaces";
 import { ContainerSchema, DataObjectClass, LoadableObjectClass, SharedObjectClass } from "./types";
 
+/**
+ * An internal type used by the internal type guard isDataObjectClass to cast a
+ * DataObjectClass to a type that is strongly coupled to IFluidDataStoreFactory.
+ * Unlike the external and exported type DataObjectClass  which is
+ * weakly coupled to the IFluidDataStoreFactory to prevent leaking internals.
+ */
+export type InternalDataObjectClass<T extends IFluidLoadable> = DataObjectClass<T> &
+	Record<"factory", IFluidDataStoreFactory>;
+
 /**
  * Runtime check to determine if a class is a DataObject type
  */
-export const isDataObjectClass = (obj: any): obj is DataObjectClass<any> => {
-	return obj?.factory !== undefined;
+export const isDataObjectClass = (obj: any): obj is InternalDataObjectClass<IFluidLoadable> => {
+	const maybe: Partial<InternalDataObjectClass<IFluidLoadable>> | undefined = obj;
+	return (
+		maybe?.factory?.IFluidDataStoreFactory !== undefined &&
+		maybe?.factory?.IFluidDataStoreFactory === maybe?.factory
+	);
 };
 
 /**