@fluidframework/fluid-static 2.0.0-internal.1.4.1 → 2.0.0-internal.2.0.0

package/lib/types.js.map

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IEvent, IEventProvider } from \"@fluidframework/common-definitions\";\nimport { IFluidLoadable } from \"@fluidframework/core-interfaces\";\nimport { IChannelFactory } from \"@fluidframework/datastore-definitions\";\nimport { IFluidDataStoreFactory } from \"@fluidframework/runtime-definitions\";\n\n/**\n * A mapping of string identifiers to instantiated DataObjects or SharedObjects.\n */\nexport type LoadableObjectRecord = Record<string, IFluidLoadable>;\n\n/**\n * A mapping of string identifiers to classes that will later be used to instantiate a corresponding DataObject\n * or SharedObject in a LoadableObjectRecord.\n */\nexport type LoadableObjectClassRecord = Record<string, LoadableObjectClass<any>>;\n\n/**\n * A LoadableObjectClass is an class object of DataObject or SharedObject\n * @typeParam T - The class of the DataObject or SharedObject\n */\nexport type LoadableObjectClass<T extends IFluidLoadable> = DataObjectClass<T> | SharedObjectClass<T>;\n\n/**\n * A DataObjectClass is a class that has a factory that can create a DataObject and a\n * constructor that will return the type of the DataObject.\n * @typeParam T - The class of the DataObject\n */\nexport type DataObjectClass<T extends IFluidLoadable>\n    = { readonly factory: IFluidDataStoreFactory; } & LoadableObjectCtor<T>;\n\n/**\n * A SharedObjectClass is a class that has a factory that can create a DDS (SharedObject) and a\n * constructor that will return the type of the DataObject.\n * @typeParam T - The class of the SharedObject\n */\nexport type SharedObjectClass<T extends IFluidLoadable>\n    = { readonly getFactory: () => IChannelFactory; } & LoadableObjectCtor<T>;\n\n/**\n * An object with a constructor that will return an `IFluidLoadable`.\n * @typeParam T - The class of the loadable object\n */\nexport type LoadableObjectCtor<T extends IFluidLoadable> = new(...args: any[]) => T;\n\n/**\n * The ContainerSchema declares the Fluid objects that will be available in the container.  It includes both the\n * instances of objects that are initially available upon container creation, as well as the types of objects that may\n * be dynamically created throughout the lifetime of the container.\n */\nexport interface ContainerSchema {\n    /**\n     * Defines loadable objects that will be created when the `Container` is first created.\n     * It uses the key as the id and the value as the loadable object to create.\n     *\n     * @example\n     * In the example below two objects will be created when the Container is first\n     * created. One with id \"map1\" that will return a `SharedMap` and the other with\n     * id \"pair1\" that will return a `KeyValueDataObject`.\n     *\n     * ```\n     * {\n     *   map1: SharedMap,\n     *   pair1: KeyValueDataObject,\n     * }\n     * ```\n     */\n    initialObjects: LoadableObjectClassRecord;\n\n    /**\n     * Dynamic objects are Loadable objects that can be created after the initial Container creation.\n     *\n     * Types defined in `initialObjects` will always be available and are not required to be provided here.\n     *\n     * For best practice it's recommended to define all the dynamic types you create even if they are\n     * included via initialObjects.\n     */\n    dynamicObjectTypes?: LoadableObjectClass<any>[];\n}\n\n/**\n * Events that trigger when the roster of members in the Fluid session change.\n * Only changes that would be reflected in the returned map of {@link IServiceAudience}'s\n * {@link IServiceAudience.getMembers} method will emit events.\n *\n * @remarks\n *\n * The following is the list of events emitted.\n *\n * ### \"membersChanged\"\n *\n * The \"membersChanged\" event is emitted when a member is either added or removed.\n *\n * #### Listener signature\n *\n * ```typescript\n * () => void;\n * ```\n *\n * ### \"memberAdded\"\n *\n * The \"memberAdded\" event is emitted when a member joins the audience.\n *\n * #### Listener signature\n *\n * ```typescript\n * (clientId: string, member: M) => void;\n * ```\n * - `clientId` - A unique identifier for the client\n *\n * - `member` - The service-specific member object for the client\n *\n * ### \"memberRemoved\"\n *\n * The \"memberRemoved\" event is emitted when a member leaves the audience.\n *\n * #### Listener signature\n *\n * ```typescript\n * (clientId: string, member: M) => void;\n * ```\n * - `clientId` - A unique identifier for the client\n *\n * - `member` - The service-specific member object for the client\n * @typeParam M - A service-specific member type.\n */\nexport interface IServiceAudienceEvents<M extends IMember> extends IEvent {\n    (event: \"membersChanged\", listener: () => void): void;\n    (event: \"memberAdded\" | \"memberRemoved\", listener: (clientId: string, member: M) => void): void;\n}\n\n/**\n * Base interface to be implemented to fetch each service's audience. The generic M allows consumers to further\n * extend the client object with service-specific details about the connecting client, such as device information,\n * environment, or a username.\n * @typeParam M - A service-specific member type.\n */\nexport interface IServiceAudience<M extends IMember> extends IEventProvider<IServiceAudienceEvents<M>> {\n    /**\n     * Returns an map of all users currently in the Fluid session where key is the userId and the value is the\n     * member object.  The implementation may choose to exclude certain connections from the returned map.\n     * E.g. ServiceAudience excludes non-interactive connections to represent only the roster of live users.\n     */\n    getMembers(): Map<string, M>;\n\n    /**\n     * Returns the current active user on this client once they are connected. Otherwise, returns undefined.\n     */\n    getMyself(): M | undefined;\n}\n\n/**\n * Base interface for information for each connection made to the Fluid session.  This interface can be extended\n * to provide additional information specific to each service.\n */\nexport interface IConnection {\n    /**\n     * A unique ID for the connection.  A single user may have multiple connections, each with a different ID.\n     */\n    id: string;\n\n    /**\n     * Whether the connection is in read or read/write mode.\n     */\n    mode: \"write\" | \"read\";\n}\n\n/**\n * Base interface to be implemented to fetch each service's member.  This interface can be extended by each service\n * to provide additional service-specific user metadata.\n */\nexport interface IMember {\n    /**\n     * An ID for the user, unique among each individual user connecting to the session.\n     */\n    userId: string;\n\n    /**\n     * The set of connections the user has made, e.g. from multiple tabs or devices.\n     */\n    connections: IConnection[];\n}\n"]}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IEvent, IEventProvider } from \"@fluidframework/common-definitions\";\nimport { IFluidLoadable } from \"@fluidframework/core-interfaces\";\nimport { IChannelFactory } from \"@fluidframework/datastore-definitions\";\nimport { IFluidDataStoreFactory } from \"@fluidframework/runtime-definitions\";\n\n/**\n * A mapping of string identifiers to instantiated `DataObject`s or `SharedObject`s.\n */\nexport type LoadableObjectRecord = Record<string, IFluidLoadable>;\n\n/**\n * A mapping of string identifiers to classes that will later be used to instantiate a corresponding `DataObject`\n * or `SharedObject` in a {@link LoadableObjectRecord}.\n */\nexport type LoadableObjectClassRecord = Record<string, LoadableObjectClass<any>>;\n\n/**\n * A class object of `DataObject` or `SharedObject`.\n *\n * @typeParam T - The class of the `DataObject` or `SharedObject`.\n */\nexport type LoadableObjectClass<T extends IFluidLoadable> = DataObjectClass<T> | SharedObjectClass<T>;\n\n/**\n * A class that has a factory that can create a `DataObject` and a\n * constructor that will return the type of the `DataObject`.\n *\n * @typeParam T - The class of the `DataObject`.\n */\nexport type DataObjectClass<T extends IFluidLoadable>\n    = { readonly factory: IFluidDataStoreFactory; } & LoadableObjectCtor<T>;\n\n/**\n * A class that has a factory that can create a DDSes (`SharedObject`s) and a\n * constructor that will return the type of the `DataObject`.\n *\n * @typeParam T - The class of the `SharedObject`.\n */\nexport type SharedObjectClass<T extends IFluidLoadable>\n    = { readonly getFactory: () => IChannelFactory; } & LoadableObjectCtor<T>;\n\n/**\n * An object with a constructor that will return an {@link @fluidframework/core-interfaces#IFluidLoadable}.\n *\n * @typeParam T - The class of the loadable object.\n */\nexport type LoadableObjectCtor<T extends IFluidLoadable> = new(...args: any[]) => T;\n\n/**\n * Declares the Fluid objects that will be available in the {@link IFluidContainer | Container}.\n *\n * @remarks\n *\n * It includes both the instances of objects that are initially available upon `Container` creation, as well\n * as the types of objects that may be dynamically created throughout the lifetime of the `Container`.\n */\nexport interface ContainerSchema {\n    /**\n     * Defines loadable objects that will be created when the {@link IFluidContainer | Container} is first created.\n     *\n     * @remarks It uses the key as the id and the value as the loadable object to create.\n     *\n     * @example\n     *\n     * In the example below two objects will be created when the `Container` is first\n     * created. One with id \"map1\" that will return a `SharedMap` and the other with\n     * id \"pair1\" that will return a `KeyValueDataObject`.\n     *\n     * ```typescript\n     * {\n     *   map1: SharedMap,\n     *   pair1: KeyValueDataObject,\n     * }\n     * ```\n     */\n    initialObjects: LoadableObjectClassRecord;\n\n    /**\n     * Loadable objects that can be created after the initial {@link IFluidContainer | Container} creation.\n     *\n     * @remarks\n     *\n     * Types defined in `initialObjects` will always be available and are not required to be provided here.\n     *\n     * For best practice it's recommended to define all the dynamic types you create even if they are\n     * included via initialObjects.\n     */\n    dynamicObjectTypes?: LoadableObjectClass<any>[];\n}\n\n/**\n * Signature for {@link IMember} change events.\n *\n * @param clientId - A unique identifier for the client.\n * @param member - The service-specific member object for the client.\n *\n * @see See {@link IServiceAudienceEvents} for usage details.\n */\nexport type MemberChangedListener<M extends IMember> = (clientId: string, member: M) => void;\n\n/**\n * Events that trigger when the roster of members in the Fluid session change.\n *\n * @remarks\n *\n * Only changes that would be reflected in the returned map of {@link IServiceAudience}'s\n * {@link IServiceAudience.getMembers} method will emit events.\n *\n * @typeParam M - A service-specific {@link IMember} implementation.\n */\nexport interface IServiceAudienceEvents<M extends IMember> extends IEvent {\n    /* eslint-disable @typescript-eslint/unified-signatures */\n    /**\n     * Emitted when a {@link IMember | member}(s) are either added or removed.\n     *\n     * @eventProperty\n     */\n    (event: \"membersChanged\", listener: () => void): void;\n\n    /**\n     * Emitted when a {@link IMember | member} joins the audience.\n     *\n     * @eventProperty\n     */\n    (event: \"memberAdded\", listener: MemberChangedListener<M>): void;\n\n    /**\n     * Emitted when a {@link IMember | member} leaves the audience.\n     *\n     * @eventProperty\n     */\n    (event: \"memberRemoved\", listener: MemberChangedListener<M>): void;\n    /* eslint-enable @typescript-eslint/unified-signatures */\n}\n\n/**\n * Base interface to be implemented to fetch each service's audience.\n *\n * @remarks\n *\n * The type parameter `M` allows consumers to further extend the client object with service-specific\n * details about the connecting client, such as device information, environment, or a username.\n *\n * @typeParam M - A service-specific {@link IMember} type.\n */\nexport interface IServiceAudience<M extends IMember> extends IEventProvider<IServiceAudienceEvents<M>> {\n    /**\n     * Returns an map of all users currently in the Fluid session where key is the userId and the value is the\n     * member object.  The implementation may choose to exclude certain connections from the returned map.\n     * E.g. ServiceAudience excludes non-interactive connections to represent only the roster of live users.\n     */\n    getMembers(): Map<string, M>;\n\n    /**\n     * Returns the current active user on this client once they are connected. Otherwise, returns undefined.\n     */\n    getMyself(): M | undefined;\n}\n\n/**\n * Base interface for information for each connection made to the Fluid session.\n *\n * @remarks This interface can be extended to provide additional information specific to each service.\n */\nexport interface IConnection {\n    /**\n     * A unique ID for the connection.  A single user may have multiple connections, each with a different ID.\n     */\n    id: string;\n\n    /**\n     * Whether the connection is in read or read/write mode.\n     */\n    mode: \"write\" | \"read\";\n}\n\n/**\n * Base interface to be implemented to fetch each service's member.\n *\n * @remarks This interface can be extended by each service to provide additional service-specific user metadata.\n */\nexport interface IMember {\n    /**\n     * An ID for the user, unique among each individual user connecting to the session.\n     */\n    userId: string;\n\n    /**\n     * The set of connections the user has made, e.g. from multiple tabs or devices.\n     */\n    connections: IConnection[];\n}\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/fluid-static",
-  "version": "2.0.0-internal.1.4.1",
+  "version": "2.0.0-internal.2.0.0",
   "description": "A tool to enable consumption of Fluid Data Objects without requiring custom container code.",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -38,29 +38,48 @@
     "tsfmt:fix": "tsfmt --replace",
     "typetests:gen": "fluid-type-validator -g -d ."
   },
+  "nyc": {
+    "all": true,
+    "cache-dir": "nyc/.cache",
+    "exclude": [
+      "src/test/**/*.ts",
+      "dist/test/**/*.js"
+    ],
+    "exclude-after-remap": false,
+    "include": [
+      "src/**/*.ts",
+      "dist/**/*.js"
+    ],
+    "report-dir": "nyc/report",
+    "reporter": [
+      "cobertura",
+      "html",
+      "text"
+    ],
+    "temp-directory": "nyc/.nyc_output"
+  },
   "dependencies": {
-    "@fluidframework/aqueduct": "^2.0.0-internal.1.4.1",
+    "@fluidframework/aqueduct": "^2.0.0-internal.2.0.0",
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^1.0.0",
-    "@fluidframework/container-definitions": "^2.0.0-internal.1.4.1",
-    "@fluidframework/container-loader": "^2.0.0-internal.1.4.1",
-    "@fluidframework/container-runtime-definitions": "^2.0.0-internal.1.4.1",
-    "@fluidframework/core-interfaces": "^2.0.0-internal.1.4.1",
-    "@fluidframework/datastore-definitions": "^2.0.0-internal.1.4.1",
-    "@fluidframework/protocol-definitions": "^1.0.0",
-    "@fluidframework/request-handler": "^2.0.0-internal.1.4.1",
-    "@fluidframework/runtime-definitions": "^2.0.0-internal.1.4.1",
-    "@fluidframework/runtime-utils": "^2.0.0-internal.1.4.1"
+    "@fluidframework/container-definitions": "^2.0.0-internal.2.0.0",
+    "@fluidframework/container-loader": "^2.0.0-internal.2.0.0",
+    "@fluidframework/container-runtime-definitions": "^2.0.0-internal.2.0.0",
+    "@fluidframework/core-interfaces": "^2.0.0-internal.2.0.0",
+    "@fluidframework/datastore-definitions": "^2.0.0-internal.2.0.0",
+    "@fluidframework/protocol-definitions": "^1.1.0",
+    "@fluidframework/request-handler": "^2.0.0-internal.2.0.0",
+    "@fluidframework/runtime-definitions": "^2.0.0-internal.2.0.0",
+    "@fluidframework/runtime-utils": "^2.0.0-internal.2.0.0"
   },
   "devDependencies": {
-    "@fluid-experimental/get-container": "^2.0.0-internal.1.4.1",
     "@fluidframework/build-common": "^1.0.0",
-    "@fluidframework/build-tools": "^0.4.4000",
+    "@fluidframework/build-tools": "^0.4.6000",
     "@fluidframework/eslint-config-fluid": "^1.0.0",
-    "@fluidframework/fluid-static-previous": "npm:@fluidframework/fluid-static@^1.0.0",
-    "@fluidframework/map": "^2.0.0-internal.1.4.1",
-    "@fluidframework/mocha-test-setup": "^2.0.0-internal.1.4.1",
-    "@fluidframework/sequence": "^2.0.0-internal.1.4.1",
+    "@fluidframework/fluid-static-previous": "npm:@fluidframework/fluid-static@>=2.0.0-internal.1.4.0 <2.0.0-internal.2.0.0",
+    "@fluidframework/map": "^2.0.0-internal.2.0.0",
+    "@fluidframework/mocha-test-setup": "^2.0.0-internal.2.0.0",
+    "@fluidframework/sequence": "^2.0.0-internal.2.0.0",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/mocha": "^9.1.1",

package/src/fluidContainer.ts

@@ -5,7 +5,12 @@
 import { TypedEventEmitter } from "@fluidframework/common-utils";
 import { IFluidLoadable } from "@fluidframework/core-interfaces";
 import { IEvent, IEventProvider } from "@fluidframework/common-definitions";
-import { AttachState, IContainer, ConnectionState } from "@fluidframework/container-definitions";
+import {
+    AttachState,
+    IContainer,
+    ICriticalContainerError,
+    ConnectionState,
+} from "@fluidframework/container-definitions";
 import { LoadableObjectClass, LoadableObjectRecord } from "./types";
 import { RootDataObject } from "./rootDataObject";
 
@@ -26,9 +31,9 @@ import { RootDataObject } from "./rootDataObject";
  * () => void;
  * ```
  *
- * ### "dispose"
+ * ### "disposed"
  *
- * The "dispose" event is emitted when the `IFluidContainer` is disposed, which permanently disables it.
+ * The "disposed" event is emitted when the `IFluidContainer` is disposed, which permanently disables it.
  *
  * #### Listener signature
  *
@@ -68,7 +73,22 @@ import { RootDataObject } from "./rootDataObject";
  * ```
  */
 export interface IFluidContainerEvents extends IEvent {
-    (event: "connected" | "dispose" | "disconnected" | "saved" | "dirty", listener: () => void): void;
+    /**
+     * **connected** & **disconnected** events reflect connection state changes against the (delta)
+     * service acknowledging ops/edits.
+     */
+    (event: "connected" | "disconnected", listener: () => void): void;
+    /**
+     * **saved** event is raised when all local changes/edits have been acknowledged by the service.
+     * **dirty** event is raised when first local change has been made, following a "saved" state.
+     */
+    // eslint-disable-next-line @typescript-eslint/unified-signatures
+    (event: "saved" | "dirty", listener: () => void): void;
+    /**
+     * Disposed event is raised when container is closed. If container was closed due to error
+     * (vs explicit **dispose** action), optional argument contains further details about the error.
+     */
+    (event: "disposed", listener: (error?: ICriticalContainerError) => void);
 }
 
 /**
@@ -83,6 +103,9 @@ export interface IFluidContainer extends IEventProvider<IFluidContainerEvents> {
 
     /**
      * A container is considered **dirty** if it has local changes that have not yet been acknowledged by the service.
+     *
+     * @remarks
+     *
      * You should always check the `isDirty` flag before closing the container or navigating away from the page.
      * Closing the container while `isDirty === true` may result in the loss of operations that have not yet been
      * acknowledged by the service.
@@ -101,18 +124,23 @@ export interface IFluidContainer extends IEventProvider<IFluidContainerEvents> {
     readonly isDirty: boolean;
 
     /**
-     * Whether the container is disposed, which permanently disables it.
+     * Whether or not the container is disposed, which permanently disables it.
      */
     readonly disposed: boolean;
 
     /**
      * The collection of data objects and Distributed Data Stores (DDSes) that were specified by the schema.
-     * These data objects and DDSes exist for the lifetime of the container.
+     *
+     * @remarks These data objects and DDSes exist for the lifetime of the container.
      */
     readonly initialObjects: LoadableObjectRecord;
 
     /**
-     * The current attachment state of the container.  Once a container has been attached, it remains attached.
+     * The current attachment state of the container.
+     *
+     * @remarks
+     *
+     * Once a container has been attached, it remains attached.
      * When loading an existing container, it will already be attached.
      */
     readonly attachState: AttachState;
@@ -121,7 +149,9 @@ export interface IFluidContainer extends IEventProvider<IFluidContainerEvents> {
      * A newly created container starts detached from the collaborative service.
      * Calling `attach()` uploads the new container to the service and connects to the collaborative service.
      *
-     * @remarks This should only be called when the container is in the
+     * @remarks
+     *
+     * This should only be called when the container is in the
      * {@link @fluidframework/container-definitions#AttachState.Detatched} state.
      *
      * This can be determined by observing {@link IFluidContainer.attachState}.
@@ -134,7 +164,9 @@ export interface IFluidContainer extends IEventProvider<IFluidContainerEvents> {
      * Attempts to connect the container to the delta stream and process operations.
      * Will throw an error if unsuccessful.
      *
-     * @remarks This should only be called when the container is in the
+     * @remarks
+     *
+     * This should only be called when the container is in the
      * {@link @fluidframework/container-definitions#ConnectionState.Disconnected} state.
      *
      * This can be determined by observing {@link IFluidContainer.connectionState}.
@@ -144,7 +176,9 @@ export interface IFluidContainer extends IEventProvider<IFluidContainerEvents> {
     /**
      * Disconnects the container from the delta stream and stops processing operations.
      *
-     * @remarks This should only be called when the container is in the
+     * @remarks
+     *
+     * This should only be called when the container is in the
      * {@link @fluidframework/container-definitions#ConnectionState.Connected} state.
      *
      * This can be determined by observing {@link IFluidContainer.connectionState}.
@@ -154,11 +188,15 @@ export interface IFluidContainer extends IEventProvider<IFluidContainerEvents> {
     /**
      * Create a new data object or Distributed Data Store (DDS) of the specified type.
      *
-     * @remarks In order to share the data object or DDS with other
+     * @remarks
+     *
+     * In order to share the data object or DDS with other
      * collaborators and retrieve it later, store its handle in a collection like a SharedDirectory from your
      * initialObjects.
      *
-     * @param objectClass - The class of data object or DDS to create
+     * @param objectClass - The class of the `DataObject` or `SharedObject` to create.
+     *
+     * @typeParam T - The class of the `DataObject` or `SharedObject`.
      */
     create<T extends IFluidLoadable>(objectClass: LoadableObjectClass<T>): Promise<T>;
 
@@ -171,13 +209,15 @@ export interface IFluidContainer extends IEventProvider<IFluidContainerEvents> {
 /**
  * Base {@link IFluidContainer} implementation.
  *
- * @remarks Note: this implementation is not complete. Consumers who rely on {@link IFluidContainer.attach}
+ * @remarks
+ *
+ * Note: this implementation is not complete. Consumers who rely on {@link IFluidContainer.attach}
  * will need to utilize or provide a service-specific implementation of this type that implements that method.
  */
 export class FluidContainer extends TypedEventEmitter<IFluidContainerEvents> implements IFluidContainer {
     private readonly connectedHandler = () => this.emit("connected");
     private readonly disconnectedHandler = () => this.emit("disconnected");
-    private readonly disposedHandler = () => this.emit("disposed");
+    private readonly disposedHandler = (error?: ICriticalContainerError) => this.emit("disposed", error);
     private readonly savedHandler = () => this.emit("saved");
     private readonly dirtyHandler = () => this.emit("dirty");
 
@@ -196,7 +236,7 @@ export class FluidContainer extends TypedEventEmitter<IFluidContainerEvents> imp
     /**
      * {@inheritDoc IFluidContainer.isDirty}
      */
-     public get isDirty(): boolean {
+    public get isDirty(): boolean {
         return this.container.isDirty;
     }
 
@@ -217,7 +257,7 @@ export class FluidContainer extends TypedEventEmitter<IFluidContainerEvents> imp
     /**
      * {@inheritDoc IFluidContainer.connectionState}
      */
-     public get connectionState(): ConnectionState {
+    public get connectionState(): ConnectionState {
         return this.container.connectionState;
     }
 
@@ -230,7 +270,10 @@ export class FluidContainer extends TypedEventEmitter<IFluidContainerEvents> imp
 
     /**
      * Incomplete base implementation of {@link IFluidContainer.attach}.
-     * @remarks Note: this implementation will unconditionally throw.
+     *
+     * @remarks
+     *
+     * Note: this implementation will unconditionally throw.
      * Consumers who rely on this will need to utilize or provide a service specific implementation of this base type
      * that provides an implementation of this method.
      *
@@ -238,7 +281,10 @@ export class FluidContainer extends TypedEventEmitter<IFluidContainerEvents> imp
      * but internally this separation is not there.
      */
     public async attach(): Promise<string> {
-        throw new Error("Cannot attach container. Container is not in detached state");
+        if (this.container.attachState !== AttachState.Detached) {
+            throw new Error("Cannot attach container. Container is not in detached state.");
+        }
+        throw new Error("Cannot attach container. Attach method not provided.");
     }
 
     /**

package/src/rootDataObject.ts

@@ -23,20 +23,20 @@ import {
 import { isDataObjectClass, isSharedObjectClass, parseDataObjectsFromSharedObjects } from "./utils";
 
 /**
- * Input props for {@link RootDataObject.initializingFirstTime}
+ * Input props for {@link RootDataObject.initializingFirstTime}.
  */
 export interface RootDataObjectProps {
     /**
      * Initial object structure with which the {@link RootDataObject} will be first-time initialized.
-     * See {@link RootDataObject.initializingFirstTime}
+     *
+     * @see {@link RootDataObject.initializingFirstTime}
      */
     initialObjects: LoadableObjectClassRecord;
 }
 
 /**
- * The entry-point/root collaborative object of the Fluid Container.
- * This class abstracts the dynamic code required to build a Fluid Container into a static representation
- * for end customers.
+ * 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.
  */
 export class RootDataObject extends DataObject<{ InitialState: RootDataObjectProps; }> {
     private readonly initialObjectsDirKey = "initial-objects-key";
@@ -54,7 +54,7 @@ export class RootDataObject extends DataObject<{ InitialState: RootDataObjectPro
      * The first time this object is initialized, creates each object identified in
      * {@link RootDataObjectProps.initialObjects} and stores them as unique values in the root directory.
      *
-     * See {@link @fluidframework/aqueduct#PureDataObject.initializingFirstTime}
+     * @see {@link @fluidframework/aqueduct#PureDataObject.initializingFirstTime}
      */
     protected async initializingFirstTime(props: RootDataObjectProps) {
         this.root.createSubDirectory(this.initialObjectsDirKey);
@@ -76,7 +76,7 @@ export class RootDataObject extends DataObject<{ InitialState: RootDataObjectPro
      * Every time an instance is initialized, loads all of the initial objects in the root directory so they can be
      * accessed immediately.
      *
-     * See {@link @fluidframework/aqueduct#PureDataObject.hasInitialized}
+     * @see {@link @fluidframework/aqueduct#PureDataObject.hasInitialized}
      */
     protected async hasInitialized() {
         // We will always load the initial objects so they are available to the developer
@@ -94,7 +94,8 @@ export class RootDataObject extends DataObject<{ InitialState: RootDataObjectPro
 
     /**
      * Provides a record of the initial objects defined on creation.
-     * See {@link RootDataObject.initializingFirstTime}
+     *
+     * @see {@link RootDataObject.initializingFirstTime}
      */
     public get initialObjects(): LoadableObjectRecord {
         if (Object.keys(this._initialObjects).length === 0) {
@@ -105,7 +106,10 @@ export class RootDataObject extends DataObject<{ InitialState: RootDataObjectPro
 
     /**
      * Dynamically creates a new detached collaborative object (DDS/DataObject).
+     *
      * @param objectClass - Type of the collaborative object to be created.
+     *
+     * @typeParam T - The class of the `DataObject` or `SharedObject`.
      */
     public async create<T extends IFluidLoadable>(
         objectClass: LoadableObjectClass<T>,
@@ -137,8 +141,12 @@ export class RootDataObject extends DataObject<{ InitialState: RootDataObjectPro
 const rootDataStoreId = "rootDOId";
 
 /**
- * Container code that provides a single {@link RootDataObject}.  This data object is
- * dynamically customized (registry and initial objects) based on the schema provided to the container runtime factory.
+ * Container code that provides a single {@link RootDataObject}.
+ *
+ * @remarks
+ *
+ * This data object is dynamically customized (registry and initial objects) based on the schema provided.
+ * to the container runtime factory.
  */
 export class DOProviderContainerRuntimeFactory extends BaseContainerRuntimeFactory {
     private readonly rootDataObjectFactory: DataObjectFactory<RootDataObject, {

package/src/serviceAudience.ts

@@ -9,29 +9,39 @@ import { IClient } from "@fluidframework/protocol-definitions";
 import { IServiceAudience, IServiceAudienceEvents, IMember } from "./types";
 
 /**
- * Base class for providing audience information for sessions interacting with FluidContainer
+ * Base class for providing audience information for sessions interacting with {@link IFluidContainer}
+ *
+ * @remarks
+ *
  * This can be extended by different service-specific client packages to additional parameters to
- * the user and client details returned in IMember
- * @typeParam M - A service-specific member type.
+ * the user and client details returned in {@link IMember}.
+ *
+ * @typeParam M - A service-specific {@link IMember} implementation.
  */
 export abstract class ServiceAudience<M extends IMember = IMember>
   extends TypedEventEmitter<IServiceAudienceEvents<M>>
   implements IServiceAudience<M> {
   /**
-   * Audience object which includes all the existing members of the container.
+   * Audience object which includes all the existing members of the {@link IFluidContainer | container}.
    */
   protected readonly audience: IAudience;
 
   /**
-   * Retain the most recent member list.  This is so we have more information about a member
-   * leaving the audience in the removeMember event.  It allows us to match the behavior of the
-   * addMember event where it only fires on a change to the members this class exposes (and would
-   * actually produce a change in what getMembers returns).  It also allows us to provide the
-   * client details in the event which makes it easier to find that client connection in a map
-   * keyed on the userId and not clientId.
-   * This map will always be up-to-date in a removeMember event because it is set once at
-   * construction and in every addMember event.
-   * It is mapped clientId to M to be better work with what the IAudience event provides
+   * Retain the most recent member list.
+   *
+   * @remarks
+   *
+   * This is so we have more information about a member leaving the audience in the `removeMember` event.
+   *
+   * It allows us to match the behavior of the `addMember` event where it only fires on a change to the members this
+   * class exposes (and would actually produce a change in what `getMembers` returns).
+   *
+   * It also allows us to provide the client details in the event which makes it easier to find that client connection
+   * in a map keyed on the `userId` and not `clientId`.
+   *
+   * This map will always be up-to-date in a `removeMember` event because it is set once at construction and in
+   * every `addMember` event. It is mapped `clientId` to `M` to be better work with what the {@link IServiceAudience}
+   * events provide.
    */
   protected lastMembers: Map<string, M> = new Map();
 
@@ -68,6 +78,7 @@ export abstract class ServiceAudience<M extends IMember = IMember>
 
   /**
    * 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;
@@ -127,6 +138,7 @@ export abstract class ServiceAudience<M extends IMember = IMember>
   /**
    * Provides ability for the inheriting class to include/omit specific members.
    * An example use case is omitting the summarizer client.
+   *
    * @param member - Member to be included/omitted.
    */
   protected shouldIncludeAsMember(member: IClient): boolean {