@fluidframework/fluid-static 2.0.0-rc.1.0.4 → 2.0.0-rc.2.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/fluid-static",
-  "version": "2.0.0-rc.1.0.4",
+  "version": "2.0.0-rc.2.0.0",
   "description": "A tool to enable consumption of Fluid Data Objects without requiring custom container code.",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -11,60 +11,40 @@
   "license": "MIT",
   "author": "Microsoft and contributors",
   "sideEffects": false,
+  "type": "module",
   "exports": {
     ".": {
       "import": {
-        "types": "./lib/index.d.mts",
-        "default": "./lib/index.mjs"
+        "types": "./lib/index.d.ts",
+        "default": "./lib/index.js"
       },
       "require": {
         "types": "./dist/index.d.ts",
         "default": "./dist/index.js"
       }
     },
-    "./alpha": {
-      "import": {
-        "types": "./lib/fluid-static-alpha.d.mts",
-        "default": "./lib/index.mjs"
-      },
-      "require": {
-        "types": "./dist/fluid-static-alpha.d.ts",
-        "default": "./dist/index.js"
-      }
-    },
-    "./beta": {
+    "./public": {
       "import": {
-        "types": "./lib/fluid-static-beta.d.mts",
-        "default": "./lib/index.mjs"
+        "types": "./lib/fluid-static-public.d.ts",
+        "default": "./lib/index.js"
       },
       "require": {
-        "types": "./dist/fluid-static-beta.d.ts",
+        "types": "./dist/fluid-static-public.d.ts",
         "default": "./dist/index.js"
       }
     },
     "./internal": {
       "import": {
-        "types": "./lib/index.d.mts",
-        "default": "./lib/index.mjs"
+        "types": "./lib/index.d.ts",
+        "default": "./lib/index.js"
       },
       "require": {
         "types": "./dist/index.d.ts",
         "default": "./dist/index.js"
       }
-    },
-    "./public": {
-      "import": {
-        "types": "./lib/fluid-static-public.d.mts",
-        "default": "./lib/index.mjs"
-      },
-      "require": {
-        "types": "./dist/fluid-static-public.d.ts",
-        "default": "./dist/index.js"
-      }
     }
   },
   "main": "dist/index.js",
-  "module": "lib/index.mjs",
   "types": "dist/index.d.ts",
   "c8": {
     "all": true,
@@ -87,43 +67,42 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": ">=2.0.0-rc.1.0.4 <2.0.0-rc.1.1.0",
-    "@fluidframework/aqueduct": ">=2.0.0-rc.1.0.4 <2.0.0-rc.1.1.0",
-    "@fluidframework/container-definitions": ">=2.0.0-rc.1.0.4 <2.0.0-rc.1.1.0",
-    "@fluidframework/container-loader": ">=2.0.0-rc.1.0.4 <2.0.0-rc.1.1.0",
-    "@fluidframework/container-runtime": ">=2.0.0-rc.1.0.4 <2.0.0-rc.1.1.0",
-    "@fluidframework/container-runtime-definitions": ">=2.0.0-rc.1.0.4 <2.0.0-rc.1.1.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-rc.1.0.4 <2.0.0-rc.1.1.0",
-    "@fluidframework/datastore-definitions": ">=2.0.0-rc.1.0.4 <2.0.0-rc.1.1.0",
-    "@fluidframework/protocol-definitions": "^3.1.0",
-    "@fluidframework/request-handler": ">=2.0.0-rc.1.0.4 <2.0.0-rc.1.1.0",
-    "@fluidframework/runtime-definitions": ">=2.0.0-rc.1.0.4 <2.0.0-rc.1.1.0",
-    "@fluidframework/runtime-utils": ">=2.0.0-rc.1.0.4 <2.0.0-rc.1.1.0"
+    "@fluid-internal/client-utils": ">=2.0.0-rc.2.0.0 <2.0.0-rc.2.1.0",
+    "@fluidframework/aqueduct": ">=2.0.0-rc.2.0.0 <2.0.0-rc.2.1.0",
+    "@fluidframework/container-definitions": ">=2.0.0-rc.2.0.0 <2.0.0-rc.2.1.0",
+    "@fluidframework/container-loader": ">=2.0.0-rc.2.0.0 <2.0.0-rc.2.1.0",
+    "@fluidframework/container-runtime": ">=2.0.0-rc.2.0.0 <2.0.0-rc.2.1.0",
+    "@fluidframework/container-runtime-definitions": ">=2.0.0-rc.2.0.0 <2.0.0-rc.2.1.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-rc.2.0.0 <2.0.0-rc.2.1.0",
+    "@fluidframework/datastore-definitions": ">=2.0.0-rc.2.0.0 <2.0.0-rc.2.1.0",
+    "@fluidframework/protocol-definitions": "^3.2.0",
+    "@fluidframework/request-handler": ">=2.0.0-rc.2.0.0 <2.0.0-rc.2.1.0",
+    "@fluidframework/runtime-definitions": ">=2.0.0-rc.2.0.0 <2.0.0-rc.2.1.0",
+    "@fluidframework/runtime-utils": ">=2.0.0-rc.2.0.0 <2.0.0-rc.2.1.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.13.3",
-    "@fluid-tools/build-cli": "^0.29.0",
+    "@fluid-internal/mocha-test-setup": ">=2.0.0-rc.2.0.0 <2.0.0-rc.2.1.0",
+    "@fluid-tools/build-cli": "^0.34.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.29.0",
-    "@fluidframework/eslint-config-fluid": "^3.2.0",
+    "@fluidframework/build-tools": "^0.34.0",
+    "@fluidframework/eslint-config-fluid": "^4.0.0",
     "@fluidframework/fluid-static-previous": "npm:@fluidframework/fluid-static@2.0.0-internal.8.0.0",
-    "@fluidframework/map": ">=2.0.0-rc.1.0.4 <2.0.0-rc.1.1.0",
-    "@fluidframework/mocha-test-setup": ">=2.0.0-rc.1.0.4 <2.0.0-rc.1.1.0",
-    "@fluidframework/sequence": ">=2.0.0-rc.1.0.4 <2.0.0-rc.1.1.0",
-    "@microsoft/api-extractor": "^7.38.3",
+    "@fluidframework/map": ">=2.0.0-rc.2.0.0 <2.0.0-rc.2.1.0",
+    "@fluidframework/sequence": ">=2.0.0-rc.2.0.0 <2.0.0-rc.2.1.0",
+    "@microsoft/api-extractor": "^7.42.3",
     "@types/mocha": "^9.1.1",
     "@types/node": "^18.19.0",
     "c8": "^8.0.1",
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
-    "eslint": "~8.50.0",
+    "eslint": "~8.55.0",
     "mocha": "^10.2.0",
     "mocha-json-output-reporter": "^2.0.1",
     "mocha-multi-reporters": "^1.5.1",
     "moment": "^2.21.0",
     "prettier": "~3.0.3",
     "rimraf": "^4.4.0",
-    "tsc-multi": "^1.1.0",
     "typescript": "~5.1.6"
   },
   "fluidBuild": {
@@ -139,18 +118,24 @@
     }
   },
   "typeValidation": {
-    "broken": {}
+    "broken": {
+      "InterfaceDeclaration_ContainerSchema": {
+        "backCompat": false
+      }
+    }
   },
   "scripts": {
     "api": "fluid-build . --task api",
-    "api-extractor:commonjs": "api-extractor run --local",
-    "api-extractor:esnext": "api-extractor run --config ./api-extractor-esm.json",
+    "api-extractor:commonjs": "api-extractor run --config ./api-extractor-cjs.json",
+    "api-extractor:esnext": "api-extractor run --local",
     "build": "fluid-build . --task build",
     "build:commonjs": "fluid-build . --task commonjs",
     "build:compile": "fluid-build . --task compile",
     "build:docs": "fluid-build . --task api",
-    "build:esnext": "tsc-multi --config ../../../common/build/build-common/tsc-multi.esm.json",
-    "build:test": "tsc --project ./src/test/tsconfig.json",
+    "build:esnext": "tsc --project ./tsconfig.json",
+    "build:test": "npm run build:test:esm && npm run build:test:cjs",
+    "build:test:cjs": "fluid-tsc commonjs --project ./src/test/tsconfig.cjs.json",
+    "build:test:esm": "tsc --project ./src/test/tsconfig.json",
     "check:are-the-types-wrong": "attw --pack . --entrypoints .",
     "check:release-tags": "api-extractor run --local --config ./api-extractor-lint.json",
     "ci:build:docs": "api-extractor run",
@@ -164,9 +149,11 @@
     "prettier:fix": "prettier --write . --cache --ignore-path ../../../.prettierignore",
     "test": "npm run test:mocha",
     "test:coverage": "c8 npm test",
-    "test:mocha": "mocha --recursive \"dist/test/**/*.spec.*js\" -r node_modules/@fluidframework/mocha-test-setup",
+    "test:mocha": "npm run test:mocha:esm && echo skipping cjs to avoid overhead - npm run test:mocha:cjs",
+    "test:mocha:cjs": "mocha --recursive \"dist/test/**/*.spec.*js\" --exit -r node_modules/@fluid-internal/mocha-test-setup",
+    "test:mocha:esm": "mocha --recursive \"lib/test/**/*.spec.*js\" --exit -r node_modules/@fluid-internal/mocha-test-setup",
     "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
-    "tsc": "tsc",
+    "tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
     "typetests:gen": "fluid-type-test-generator",
     "typetests:prepare": "flub typetests --dir . --reset --previous --normalize"
   }

package/src/fluidContainer.ts

@@ -3,14 +3,23 @@
  * Licensed under the MIT License.
  */
 import { TypedEventEmitter } from "@fluid-internal/client-utils";
-import { IEvent, IEventProvider, IFluidLoadable } from "@fluidframework/core-interfaces";
+import {
+	type IEvent,
+	type IEventProvider,
+	type IFluidLoadable,
+} from "@fluidframework/core-interfaces";
 import {
 	AttachState,
-	IContainer,
-	ICriticalContainerError,
-	ConnectionState,
+	type IContainer,
+	type ICriticalContainerError,
+	type ConnectionState,
 } from "@fluidframework/container-definitions";
-import type { ContainerSchema, IRootDataObject, LoadableObjectClass } from "./types";
+import type {
+	ContainerSchema,
+	ContainerAttachProps,
+	IRootDataObject,
+	LoadableObjectClass,
+} from "./types.js";
 
 /**
  * Extract the type of 'initialObjects' from the given {@link ContainerSchema} type.
@@ -18,7 +27,7 @@ import type { ContainerSchema, IRootDataObject, LoadableObjectClass } from "./ty
  */
 export type InitialObjects<T extends ContainerSchema> = {
 	// Construct a LoadableObjectRecord type by enumerating the keys of
-	// 'ContainerSchema.initialObjects' and infering the value type of each key.
+	// 'ContainerSchema.initialObjects' and inferring the value type of each key.
 	//
 	// The '? TChannel : never' is required because infer can only be used in
 	// a conditional 'extends' expression.
@@ -99,6 +108,7 @@ export interface IFluidContainerEvents extends IEvent {
  * @typeparam TContainerSchema - Used to determine the type of 'initialObjects'.
  *
  * @remarks Note: external implementations of this interface are not supported.
+ *
  * @sealed
  * @public
  */
@@ -166,7 +176,7 @@ export interface IFluidContainer<TContainerSchema extends ContainerSchema = Cont
 	 *
 	 * @returns A promise which resolves when the attach is complete, with the string identifier of the container.
 	 */
-	attach(): Promise<string>;
+	attach(props?: ContainerAttachProps): Promise<string>;
 
 	/**
 	 * Attempts to connect the container to the delta stream and process operations.
@@ -176,7 +186,7 @@ export interface IFluidContainer<TContainerSchema extends ContainerSchema = Cont
 	 * @remarks
 	 *
 	 * This should only be called when the container is in the
-	 * {@link @fluidframework/container-definitions#ConnectionState.Disconnected} state.
+	 * {@link @fluidframework/container-definitions#(ConnectionState:namespace).Disconnected} state.
 	 *
 	 * This can be determined by observing {@link IFluidContainer.connectionState}.
 	 */
@@ -188,7 +198,7 @@ export interface IFluidContainer<TContainerSchema extends ContainerSchema = Cont
 	 * @remarks
 	 *
 	 * This should only be called when the container is in the
-	 * {@link @fluidframework/container-definitions#ConnectionState.Connected} state.
+	 * {@link @fluidframework/container-definitions#(ConnectionState:namespace).Connected} state.
 	 *
 	 * This can be determined by observing {@link IFluidContainer.connectionState}.
 	 */
@@ -216,6 +226,8 @@ export interface IFluidContainer<TContainerSchema extends ContainerSchema = Cont
 }
 
 /**
+ * Creates an {@link IFluidContainer} from the provided `container` and `rootDataObject`.
+ *
  * @internal
  */
 export function createFluidContainer<
@@ -242,12 +254,12 @@ class FluidContainer<TContainerSchema extends ContainerSchema = ContainerSchema>
 	extends TypedEventEmitter<IFluidContainerEvents>
 	implements IFluidContainer<TContainerSchema>
 {
-	private readonly connectedHandler = () => this.emit("connected");
-	private readonly disconnectedHandler = () => this.emit("disconnected");
-	private readonly disposedHandler = (error?: ICriticalContainerError) =>
+	private readonly connectedHandler = (): boolean => this.emit("connected");
+	private readonly disconnectedHandler = (): boolean => this.emit("disconnected");
+	private readonly disposedHandler = (error?: ICriticalContainerError): boolean =>
 		this.emit("disposed", error);
-	private readonly savedHandler = () => this.emit("saved");
-	private readonly dirtyHandler = () => this.emit("dirty");
+	private readonly savedHandler = (): boolean => this.emit("saved");
+	private readonly dirtyHandler = (): boolean => this.emit("dirty");
 
 	public constructor(
 		private readonly container: IContainer,
@@ -278,7 +290,7 @@ class FluidContainer<TContainerSchema extends ContainerSchema = ContainerSchema>
 	/**
 	 * {@inheritDoc IFluidContainer.disposed}
 	 */
-	public get disposed() {
+	public get disposed(): boolean {
 		return this.container.closed;
 	}
 
@@ -308,7 +320,7 @@ class FluidContainer<TContainerSchema extends ContainerSchema = ContainerSchema>
 	 * The reason is because externally we are presenting a separation between the service and the `FluidContainer`,
 	 * but internally this separation is not there.
 	 */
-	public async attach(): Promise<string> {
+	public async attach(props?: ContainerAttachProps): Promise<string> {
 		if (this.container.attachState !== AttachState.Detached) {
 			throw new Error("Cannot attach container. Container is not in detached state.");
 		}
@@ -339,7 +351,7 @@ class FluidContainer<TContainerSchema extends ContainerSchema = ContainerSchema>
 	/**
 	 * {@inheritDoc IFluidContainer.dispose}
 	 */
-	public dispose() {
+	public dispose(): void {
 		this.container.close();
 		this.container.off("connected", this.connectedHandler);
 		this.container.off("closed", this.disposedHandler);

package/src/index.ts

@@ -11,26 +11,27 @@
 
 export {
 	createFluidContainer,
-	IFluidContainer,
-	IFluidContainerEvents,
-	InitialObjects,
-} from "./fluidContainer";
-export { createDOProviderContainerRuntimeFactory } from "./rootDataObject";
-export { createServiceAudience } from "./serviceAudience";
+	type IFluidContainer,
+	type IFluidContainerEvents,
+	type InitialObjects,
+} from "./fluidContainer.js";
+export { createDOProviderContainerRuntimeFactory } from "./rootDataObject.js";
+export { createServiceAudience } from "./serviceAudience.js";
 export {
-	ContainerSchema,
-	DataObjectClass,
-	IConnection,
-	IMember,
-	IRootDataObject,
-	IServiceAudience,
-	IServiceAudienceEvents,
-	LoadableObjectClass,
-	LoadableObjectClassRecord,
-	LoadableObjectCtor,
-	LoadableObjectRecord,
-	MemberChangedListener,
-	Myself,
-	SharedObjectClass,
-	IProvideRootDataObject,
-} from "./types";
+	type ContainerSchema,
+	type ContainerAttachProps,
+	type DataObjectClass,
+	type IConnection,
+	type IMember,
+	type IRootDataObject,
+	type IServiceAudience,
+	type IServiceAudienceEvents,
+	type LoadableObjectClass,
+	type LoadableObjectClassRecord,
+	type LoadableObjectCtor,
+	type LoadableObjectRecord,
+	type MemberChangedListener,
+	type Myself,
+	type SharedObjectClass,
+	type IProvideRootDataObject,
+} from "./types.js";

package/src/rootDataObject.ts

@@ -7,26 +7,33 @@ import {
 	DataObject,
 	DataObjectFactory,
 } from "@fluidframework/aqueduct";
-import { IContainerRuntime } from "@fluidframework/container-runtime-definitions";
-import { IFluidLoadable, IRequest } from "@fluidframework/core-interfaces";
+import { type IContainerRuntime } from "@fluidframework/container-runtime-definitions";
+import {
+	type FluidObject,
+	type IFluidLoadable,
+	type IRequest,
+	type IResponse,
+} from "@fluidframework/core-interfaces";
 import { FlushMode } from "@fluidframework/runtime-definitions";
-import { IRuntimeFactory } from "@fluidframework/container-definitions";
+import { type IRuntimeFactory } from "@fluidframework/container-definitions";
 import { RequestParser } from "@fluidframework/runtime-utils";
-import { ContainerRuntime } from "@fluidframework/container-runtime";
+import { type ContainerRuntime } from "@fluidframework/container-runtime";
+import { type IDirectory } from "@fluidframework/map";
+
 import {
-	ContainerSchema,
-	IRootDataObject,
-	LoadableObjectClass,
-	LoadableObjectClassRecord,
-	LoadableObjectRecord,
-	SharedObjectClass,
-} from "./types";
+	type ContainerSchema,
+	type IRootDataObject,
+	type LoadableObjectClass,
+	type LoadableObjectClassRecord,
+	type LoadableObjectRecord,
+	type SharedObjectClass,
+} from "./types.js";
 import {
-	InternalDataObjectClass,
+	type InternalDataObjectClass,
 	isDataObjectClass,
 	isSharedObjectClass,
 	parseDataObjectsFromSharedObjects,
-} from "./utils";
+} from "./utils.js";
 
 /**
  * Input props for {@link RootDataObject.initializingFirstTime}.
@@ -50,11 +57,12 @@ class RootDataObject
 {
 	private readonly initialObjectsDirKey = "initial-objects-key";
 	private readonly _initialObjects: LoadableObjectRecord = {};
-	public get IRootDataObject() {
+
+	public get IRootDataObject(): IRootDataObject {
 		return this;
 	}
 
-	private get initialObjectsDir() {
+	private get initialObjectsDir(): IDirectory {
 		const dir = this.root.getSubDirectory(this.initialObjectsDirKey);
 		if (dir === undefined) {
 			throw new Error("InitialObjects sub-directory was not initialized");
@@ -68,18 +76,18 @@ class RootDataObject
 	 *
 	 * @see {@link @fluidframework/aqueduct#PureDataObject.initializingFirstTime}
 	 */
-	protected async initializingFirstTime(props: RootDataObjectProps) {
+	protected async initializingFirstTime(props: RootDataObjectProps): Promise<void> {
 		this.root.createSubDirectory(this.initialObjectsDirKey);
 
 		// Create initial objects provided by the developer
 		const initialObjectsP: Promise<void>[] = [];
-		Object.entries(props.initialObjects).forEach(([id, objectClass]) => {
-			const createObject = async () => {
-				const obj = await this.create(objectClass);
+		for (const [id, objectClass] of Object.entries(props.initialObjects)) {
+			const createObject = async (): Promise<void> => {
+				const obj = await this.create<IFluidLoadable>(objectClass);
 				this.initialObjectsDir.set(id, obj.handle);
 			};
 			initialObjectsP.push(createObject());
-		});
+		}
 
 		await Promise.all(initialObjectsP);
 	}
@@ -90,12 +98,13 @@ class RootDataObject
 	 *
 	 * @see {@link @fluidframework/aqueduct#PureDataObject.hasInitialized}
 	 */
-	protected async hasInitialized() {
+	protected async hasInitialized(): Promise<void> {
 		// We will always load the initial objects so they are available to the developer
 		const loadInitialObjectsP: Promise<void>[] = [];
-		for (const [key, value] of Array.from(this.initialObjectsDir.entries())) {
-			const loadDir = async () => {
-				const obj = await value.get();
+		for (const [key, value] of this.initialObjectsDir.entries()) {
+			const loadDir = async (): Promise<void> => {
+				// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access, @typescript-eslint/no-unsafe-call
+				const obj: unknown = await value.get();
 				Object.assign(this._initialObjects, { [key]: obj });
 			};
 			loadInitialObjectsP.push(loadDir());
@@ -148,6 +157,9 @@ class RootDataObject
 const rootDataStoreId = "rootDOId";
 
 /**
+ * Creates an {@link @fluidframework/aqueduct#BaseContainerRuntimeFactory} for a container with a single
+ * {@link IRootDataObject}, which is constructed from the provided schema.
+ *
  * @internal
  */
 export function createDOProviderContainerRuntimeFactory(props: {
@@ -176,7 +188,7 @@ class DOProviderContainerRuntimeFactory extends BaseContainerRuntimeFactory {
 
 	private readonly initialObjects: LoadableObjectClassRecord;
 
-	constructor(schema: ContainerSchema) {
+	public constructor(schema: ContainerSchema) {
 		const [registryEntries, sharedObjects] = parseDataObjectsFromSharedObjects(schema);
 		const rootDataObjectFactory = new DataObjectFactory(
 			"rootDO",
@@ -185,7 +197,10 @@ class DOProviderContainerRuntimeFactory extends BaseContainerRuntimeFactory {
 			{},
 			registryEntries,
 		);
-		const provideEntryPoint = async (containerRuntime: IContainerRuntime) => {
+		const provideEntryPoint = async (
+			containerRuntime: IContainerRuntime,
+			// eslint-disable-next-line unicorn/consistent-function-scoping
+		): Promise<FluidObject> => {
 			const entryPoint =
 				await containerRuntime.getAliasedDataStoreEntryPoint(rootDataStoreId);
 			if (entryPoint === undefined) {
@@ -193,7 +208,11 @@ class DOProviderContainerRuntimeFactory extends BaseContainerRuntimeFactory {
 			}
 			return entryPoint.get();
 		};
-		const getDefaultObject = async (request: IRequest, runtime: IContainerRuntime) => {
+		const getDefaultObject = async (
+			request: IRequest,
+			runtime: IContainerRuntime,
+			// eslint-disable-next-line unicorn/consistent-function-scoping
+		): Promise<IResponse | undefined> => {
 			const parser = RequestParser.create(request);
 			if (parser.pathParts.length === 0) {
 				// This cast is safe as ContainerRuntime.loadRuntime is called in the base class
@@ -212,7 +231,7 @@ class DOProviderContainerRuntimeFactory extends BaseContainerRuntimeFactory {
 				// resolution progress is tracked by the Feature 465 work item in AzDO
 				flushMode: FlushMode.Immediate,
 				// The runtime compressor is required to be on to use @fluidframework/tree.
-				enableRuntimeIdCompressor: true,
+				enableRuntimeIdCompressor: "on",
 			},
 			provideEntryPoint,
 		});
@@ -223,7 +242,7 @@ class DOProviderContainerRuntimeFactory extends BaseContainerRuntimeFactory {
 	/**
 	 * {@inheritDoc @fluidframework/aqueduct#BaseContainerRuntimeFactory.containerInitializingFirstTime}
 	 */
-	protected async containerInitializingFirstTime(runtime: IContainerRuntime) {
+	protected async containerInitializingFirstTime(runtime: IContainerRuntime): Promise<void> {
 		// The first time we create the container we create the RootDataObject
 		await this.rootDataObjectFactory.createRootInstance(rootDataStoreId, runtime, {
 			initialObjects: this.initialObjects,

package/src/serviceAudience.ts

@@ -4,17 +4,29 @@
  */
 
 import { TypedEventEmitter } from "@fluid-internal/client-utils";
-import { IAudience, IContainer } from "@fluidframework/container-definitions";
-import { IClient } from "@fluidframework/protocol-definitions";
-import { IServiceAudience, IServiceAudienceEvents, IMember, Myself } from "./types";
+import { type IAudience, type IContainer } from "@fluidframework/container-definitions";
+import { type IClient } from "@fluidframework/protocol-definitions";
+import {
+	type IServiceAudience,
+	type IServiceAudienceEvents,
+	type IMember,
+	type Myself,
+} from "./types.js";
 
 /**
+ * Creates a service audience for the provided container.
+ *
+ * @param container - The container with which the audience is associated.
+ * @param createServiceMember - A function for creating audience members.
+ *
+ * @typeParam TMember - The {@link IMember} representation used by the audience.
+ *
  * @internal
  */
-export function createServiceAudience<M extends IMember = IMember>(props: {
+export function createServiceAudience<TMember extends IMember = IMember>(props: {
 	container: IContainer;
-	createServiceMember: (audienceMember: IClient) => M;
-}): IServiceAudience<M> {
+	createServiceMember: (audienceMember: IClient) => TMember;
+}): IServiceAudience<TMember> {
 	return new ServiceAudience(props.container, props.createServiceMember);
 }
 
@@ -26,12 +38,13 @@ export function createServiceAudience<M extends IMember = IMember>(props: {
  * This can be extended by different service-specific client packages to additional parameters to
  * the user and client details returned in {@link IMember}.
  *
- * @typeParam M - A service-specific {@link IMember} implementation.
+ * @typeParam TMember - A service-specific {@link IMember} implementation.
+ *
  * @internal
  */
-class ServiceAudience<M extends IMember = IMember>
-	extends TypedEventEmitter<IServiceAudienceEvents<M>>
-	implements IServiceAudience<M>
+class ServiceAudience<TMember extends IMember = IMember>
+	extends TypedEventEmitter<IServiceAudienceEvents<TMember>>
+	implements IServiceAudience<TMember>
 {
 	/**
 	 * Audience object which includes all the existing members of the {@link IFluidContainer | container}.
@@ -55,14 +68,14 @@ 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.
 	 */
-	private lastMembers = new Map<string, M>();
+	private lastMembers = new Map<string, TMember>();
 
-	constructor(
+	public constructor(
 		/**
 		 * Fluid Container to read the audience from.
 		 */
 		private readonly container: IContainer,
-		private readonly createServiceMember: (audienceMember: IClient) => M,
+		private readonly createServiceMember: (audienceMember: IClient) => TMember,
 	) {
 		super();
 		this.audience = container.audience;
@@ -92,11 +105,11 @@ class ServiceAudience<M extends IMember = IMember>
 	/**
 	 * {@inheritDoc IServiceAudience.getMembers}
 	 */
-	public getMembers(): Map<string, M> {
-		const users = new Map<string, M>();
-		const clientMemberMap = new Map<string, M>();
+	public getMembers(): Map<string, TMember> {
+		const users = new Map<string, TMember>();
+		const clientMemberMap = new Map<string, TMember>();
 		// Iterate through the members and get the user specifics.
-		this.audience.getMembers().forEach((member: IClient, clientId: string) => {
+		for (const [clientId, member] of this.audience.getMembers()) {
 			if (this.shouldIncludeAsMember(member)) {
 				const userId = member.user.id;
 				// Ensure we're tracking the user
@@ -110,7 +123,7 @@ class ServiceAudience<M extends IMember = IMember>
 				user.connections.push({ id: clientId, mode: member.mode });
 				clientMemberMap.set(clientId, user);
 			}
-		});
+		}
 		this.lastMembers = clientMemberMap;
 		return users;
 	}
@@ -118,7 +131,7 @@ class ServiceAudience<M extends IMember = IMember>
 	/**
 	 * {@inheritDoc IServiceAudience.getMyself}
 	 */
-	public getMyself(): Myself<M> | undefined {
+	public getMyself(): Myself<TMember> | undefined {
 		const clientId = this.container.clientId;
 		if (clientId === undefined) {
 			return undefined;
@@ -129,12 +142,12 @@ class ServiceAudience<M extends IMember = IMember>
 			return undefined;
 		}
 
-		const myself: Myself<M> = { ...member, currentConnection: clientId };
+		const myself: Myself<TMember> = { ...member, currentConnection: clientId };
 
 		return myself;
 	}
 
-	private getMember(clientId: string): M | undefined {
+	private getMember(clientId: string): TMember | undefined {
 		// Fetch the user ID assoicated with this client ID from the runtime
 		const internalAudienceMember = this.audience.getMember(clientId);
 		if (internalAudienceMember === undefined) {
@@ -144,7 +157,7 @@ class ServiceAudience<M extends IMember = IMember>
 		const allMembers = this.getMembers();
 		const member = allMembers.get(internalAudienceMember?.user.id);
 		if (member === undefined) {
-			throw Error(
+			throw new Error(
 				`Attempted to fetch client ${clientId} that is not part of the current member list`,
 			);
 		}