@fluidframework/fluid-static 2.0.0-dev.1.4.6.106135 → 2.0.0-dev.2.3.0.115467

package/.eslintrc.js

@@ -5,7 +5,7 @@
 
 module.exports = {
     "extends": [
-        require.resolve("@fluidframework/eslint-config-fluid")
+        require.resolve("@fluidframework/eslint-config-fluid"), "prettier"
     ],
     "parserOptions": {
         "project": ["./tsconfig.json", "./src/test/tsconfig.json"]

package/dist/fluidContainer.d.ts

@@ -5,73 +5,67 @@
 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 { LoadableObjectClass, LoadableObjectRecord } from "./types";
-import { RootDataObject } from "./rootDataObject";
+import { AttachState, IContainer, ICriticalContainerError, ConnectionState } from "@fluidframework/container-definitions";
+import type { IRootDataObject, LoadableObjectClass, LoadableObjectRecord } from "./types";
 /**
  * Events emitted from {@link IFluidContainer}.
- *
- * @remarks
- *
- * The following is the list of events emitted.
- *
- * ### "connected"
- *
- * The "connected" event is emitted when the `IFluidContainer` completes connecting to the Fluid service.
- *
- * #### Listener signature
- *
- * ```typescript
- * () => void;
- * ```
- *
- * ### "dispose"
- *
- * The "dispose" event is emitted when the `IFluidContainer` is disposed, which permanently disables it.
- *
- * #### Listener signature
- *
- * ```typescript
- * () => void;
- * ```
- *
- * ### "disconnected"
- *
- * The "disconnected" event is emitted when the `IFluidContainer` becomes disconnected from the Fluid service.
- *
- * #### Listener signature
- *
- * ```typescript
- * () => void;
- * ```
- *
- * ### "saved"
- *
- * The "saved" event is emitted when the `IFluidContainer` has local changes acknowledged by the service.
- *
- * #### Listener signature
- *
- * ```typescript
- * () => void
- * ```
- *
- * ### "dirty"
- *
- * The "dirty" event is emitted when the `IFluidContainer` has local changes that have not yet
- * been acknowledged by the service.
- *
- * #### Listener signature
- *
- * ```typescript
- * () => void
- * ```
  */
 export interface IFluidContainerEvents extends IEvent {
-    (event: "connected" | "dispose" | "disconnected" | "saved" | "dirty", listener: () => void): void;
+    /**
+     * Emitted when the {@link IFluidContainer} completes connecting to the Fluid service.
+     *
+     * @remarks Reflects connection state changes against the (delta) service acknowledging ops/edits.
+     *
+     * @see
+     *
+     * - {@link IFluidContainer.connectionState}
+     *
+     * - {@link IFluidContainer.connect}
+     */
+    (event: "connected", listener: () => void): void;
+    /**
+     * Emitted when the {@link IFluidContainer} becomes disconnected from the Fluid service.
+     *
+     * @remarks Reflects connection state changes against the (delta) service acknowledging ops/edits.
+     *
+     * @see
+     *
+     * - {@link IFluidContainer.connectionState}
+     *
+     * - {@link IFluidContainer.disconnect}
+     */
+    (event: "disconnected", listener: () => void): void;
+    /**
+     * Emitted when all local changes/edits have been acknowledged by the service.
+     *
+     * @remarks "dirty" event will be emitted when the next local change has been made.
+     *
+     * @see {@link IFluidContainer.isDirty}
+     */
+    (event: "saved", listener: () => void): void;
+    /**
+     * Emitted when the first local change has been made, following a "saved" event.
+     *
+     * @remarks "saved" event will be emitted once all local changes have been acknowledged by the service.
+     *
+     * @see {@link IFluidContainer.isDirty}
+     */
+    (event: "dirty", listener: () => void): void;
+    /**
+     * Emitted when the {@link IFluidContainer} is closed, which permanently disables it.
+     *
+     * @remarks Listener parameters:
+     *
+     * - `error`: If the container was closed due to error (as opposed to an explicit call to
+     * {@link IFluidContainer.dispose}), this will contain details about the error that caused it.
+     */
+    (event: "disposed", listener: (error?: ICriticalContainerError) => void): any;
 }
 /**
  * Provides an entrypoint into the client side of collaborative Fluid data.
  * Provides access to the data as well as status on the collaboration session.
+ *
+ * @remarks Note: external implementations of this interface are not supported.
  */
 export interface IFluidContainer extends IEventProvider<IFluidContainerEvents> {
     /**
@@ -80,6 +74,9 @@ export interface IFluidContainer extends IEventProvider<IFluidContainerEvents> {
     readonly connectionState: ConnectionState;
     /**
      * 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.
@@ -97,16 +94,21 @@ 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;
@@ -114,7 +116,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}.
@@ -124,9 +128,12 @@ export interface IFluidContainer extends IEventProvider<IFluidContainerEvents> {
     attach(): Promise<string>;
     /**
      * 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
+     * @throws Will throw an error if connection is unsuccessful.
+     *
+     * @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}.
@@ -135,7 +142,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}.
@@ -144,11 +153,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>;
     /**
@@ -159,7 +172,9 @@ 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 declare class FluidContainer extends TypedEventEmitter<IFluidContainerEvents> implements IFluidContainer {
@@ -170,7 +185,7 @@ export declare class FluidContainer extends TypedEventEmitter<IFluidContainerEve
     private readonly disposedHandler;
     private readonly savedHandler;
     private readonly dirtyHandler;
-    constructor(container: IContainer, rootDataObject: RootDataObject);
+    constructor(container: IContainer, rootDataObject: IRootDataObject);
     /**
      * {@inheritDoc IFluidContainer.isDirty}
      */
@@ -193,7 +208,10 @@ export declare class FluidContainer extends TypedEventEmitter<IFluidContainerEve
     get initialObjects(): LoadableObjectRecord;
     /**
      * 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.
      *
@@ -217,5 +235,16 @@ export declare class FluidContainer extends TypedEventEmitter<IFluidContainerEve
      * {@inheritDoc IFluidContainer.dispose}
      */
     dispose(): void;
+    /**
+     * FOR INTERNAL USE ONLY. NOT FOR EXTERNAL USE.
+     * We make no stability guarantees here whatsoever.
+     *
+     * Gets the underlying {@link @fluidframework/container-definitions#IContainer}.
+     *
+     * @remarks Used to power debug tooling.
+     *
+     * @internal
+     */
+    readonly INTERNAL_CONTAINER_DO_NOT_USE?: () => IContainer;
 }
 //# sourceMappingURL=fluidContainer.d.ts.map

package/dist/fluidContainer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"fluidContainer.d.ts","sourceRoot":"","sources":["../src/fluidContainer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AACjG,OAAO,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AACpE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDG;AACH,MAAM,WAAW,qBAAsB,SAAQ,MAAM;IACjD,CAAC,KAAK,EAAE,WAAW,GAAG,SAAS,GAAG,cAAc,GAAG,OAAO,GAAG,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;CACrG;AAED;;;GAGG;AACH,MAAM,WAAW,eAAgB,SAAQ,cAAc,CAAC,qBAAqB,CAAC;IAC1E;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;IAE1C;;;;;;;;;;;;;;;;OAgBG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAE3B;;;OAGG;IACH,QAAQ,CAAC,cAAc,EAAE,oBAAoB,CAAC;IAE9C;;;OAGG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC;;;;;;;;;;OAUG;IACH,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAE1B;;;;;;;;OAQG;IACH,OAAO,IAAI,IAAI,CAAC;IAEhB;;;;;;;OAOG;IACH,UAAU,IAAI,IAAI,CAAC;IAEnB;;;;;;;;OAQG;IACH,MAAM,CAAC,CAAC,SAAS,cAAc,EAAE,WAAW,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAElF;;OAEG;IACH,OAAO,IAAI,IAAI,CAAC;CACnB;AAED;;;;;GAKG;AACH,qBAAa,cAAe,SAAQ,iBAAiB,CAAC,qBAAqB,CAAE,YAAW,eAAe;IAQ/F,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,cAAc;IARnC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAgC;IACjE,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAmC;IACvE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA+B;IAC/D,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA4B;IACzD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA4B;gBAGpC,SAAS,EAAE,UAAU,EACrB,cAAc,EAAE,cAAc;IAUnD;;OAEG;IACF,IAAW,OAAO,IAAI,OAAO,CAE7B;IAED;;OAEG;IACH,IAAW,WAAW,IAAI,WAAW,CAEpC;IAED;;OAEG;IACH,IAAW,QAAQ,YAElB;IAED;;OAEG;IACF,IAAW,eAAe,IAAI,eAAe,CAE7C;IAED;;OAEG;IACH,IAAW,cAAc,yBAExB;IAED;;;;;;;;OAQG;IACU,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC;IAItC;;OAEG;IACU,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrC;;OAEG;IACU,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAIxC;;OAEG;IACU,MAAM,CAAC,CAAC,SAAS,cAAc,EAAE,WAAW,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAI9F;;OAEG;IACI,OAAO;CAQjB"}
+{"version":3,"file":"fluidContainer.d.ts","sourceRoot":"","sources":["../src/fluidContainer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EACH,WAAW,EACX,UAAU,EACV,uBAAuB,EACvB,eAAe,EAClB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,KAAK,EAAE,eAAe,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,SAAS,CAAC;AAE1F;;GAEG;AAEH,MAAM,WAAW,qBAAsB,SAAQ,MAAM;IACjD;;;;;;;;;;OAUG;IACH,CAAC,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IAEjD;;;;;;;;;;OAUG;IACH,CAAC,KAAK,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IAEpD;;;;;;OAMG;IACH,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IAE7C;;;;;;OAMG;IACH,CAAC,KAAK,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IAE7C;;;;;;;OAOG;IACH,CAAC,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,CAAC,KAAK,CAAC,EAAE,uBAAuB,KAAK,IAAI,OAAE;CAC5E;AAGD;;;;;GAKG;AACH,MAAM,WAAW,eAAgB,SAAQ,cAAc,CAAC,qBAAqB,CAAC;IAC1E;;OAEG;IACH,QAAQ,CAAC,eAAe,EAAE,eAAe,CAAC;IAE1C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,cAAc,EAAE,oBAAoB,CAAC;IAE9C;;;;;;;OAOG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC;;;;;;;;;;;;OAYG;IACH,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAE1B;;;;;;;;;;;OAWG;IACH,OAAO,IAAI,IAAI,CAAC;IAEhB;;;;;;;;;OASG;IACH,UAAU,IAAI,IAAI,CAAC;IAEnB;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,CAAC,SAAS,cAAc,EAAE,WAAW,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;IAElF;;OAEG;IACH,OAAO,IAAI,IAAI,CAAC;CACnB;AAED;;;;;;;GAOG;AACH,qBAAa,cAAe,SAAQ,iBAAiB,CAAC,qBAAqB,CAAE,YAAW,eAAe;IAQ/F,OAAO,CAAC,QAAQ,CAAC,SAAS;IAC1B,OAAO,CAAC,QAAQ,CAAC,cAAc;IARnC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAgC;IACjE,OAAO,CAAC,QAAQ,CAAC,mBAAmB,CAAmC;IACvE,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAqE;IACrG,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA4B;IACzD,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA4B;gBAGpC,SAAS,EAAE,UAAU,EACrB,cAAc,EAAE,eAAe;IAUpD;;OAEG;IACH,IAAW,OAAO,IAAI,OAAO,CAE5B;IAED;;OAEG;IACH,IAAW,WAAW,IAAI,WAAW,CAEpC;IAED;;OAEG;IACH,IAAW,QAAQ,YAElB;IAED;;OAEG;IACH,IAAW,eAAe,IAAI,eAAe,CAE5C;IAED;;OAEG;IACH,IAAW,cAAc,yBAExB;IAED;;;;;;;;;;;OAWG;IACU,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC;IAOtC;;OAEG;IACU,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAIrC;;OAEG;IACU,UAAU,IAAI,OAAO,CAAC,IAAI,CAAC;IAIxC;;OAEG;IACU,MAAM,CAAC,CAAC,SAAS,cAAc,EAAE,WAAW,EAAE,mBAAmB,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAI9F;;OAEG;IACI,OAAO;IASd;;;;;;;;;OASG;IACH,SAAgB,6BAA6B,CAAC,EAAE,MAAM,UAAU,CAE/D;CACJ"}

package/dist/fluidContainer.js

@@ -6,10 +6,13 @@ exports.FluidContainer = void 0;
  * Licensed under the MIT License.
  */
 const common_utils_1 = require("@fluidframework/common-utils");
+const container_definitions_1 = require("@fluidframework/container-definitions");
 /**
  * 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.
  */
 class FluidContainer extends common_utils_1.TypedEventEmitter {
@@ -19,9 +22,22 @@ class FluidContainer extends common_utils_1.TypedEventEmitter {
         this.rootDataObject = rootDataObject;
         this.connectedHandler = () => this.emit("connected");
         this.disconnectedHandler = () => this.emit("disconnected");
-        this.disposedHandler = () => this.emit("disposed");
+        this.disposedHandler = (error) => this.emit("disposed", error);
         this.savedHandler = () => this.emit("saved");
         this.dirtyHandler = () => this.emit("dirty");
+        /**
+         * FOR INTERNAL USE ONLY. NOT FOR EXTERNAL USE.
+         * We make no stability guarantees here whatsoever.
+         *
+         * Gets the underlying {@link @fluidframework/container-definitions#IContainer}.
+         *
+         * @remarks Used to power debug tooling.
+         *
+         * @internal
+         */
+        this.INTERNAL_CONTAINER_DO_NOT_USE = () => {
+            return this.container;
+        };
         container.on("connected", this.connectedHandler);
         container.on("closed", this.disposedHandler);
         container.on("disconnected", this.disconnectedHandler);
@@ -60,7 +76,10 @@ class FluidContainer extends common_utils_1.TypedEventEmitter {
     }
     /**
      * 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.
      *
@@ -68,7 +87,10 @@ class FluidContainer extends common_utils_1.TypedEventEmitter {
      * but internally this separation is not there.
      */
     async attach() {
-        throw new Error("Cannot attach container. Container is not in detached state");
+        if (this.container.attachState !== container_definitions_1.AttachState.Detached) {
+            throw new Error("Cannot attach container. Container is not in detached state.");
+        }
+        throw new Error("Cannot attach container. Attach method not provided.");
     }
     /**
      * {@inheritDoc IFluidContainer.connect}

package/dist/fluidContainer.js.map

@@ -1 +1 @@
-{"version":3,"file":"fluidContainer.js","sourceRoot":"","sources":["../src/fluidContainer.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,+DAAiE;AAsKjE;;;;;GAKG;AACH,MAAa,cAAe,SAAQ,gCAAwC;IAOxE,YACqB,SAAqB,EACrB,cAA8B;QAE/C,KAAK,EAAE,CAAC;QAHS,cAAS,GAAT,SAAS,CAAY;QACrB,mBAAc,GAAd,cAAc,CAAgB;QARlC,qBAAgB,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAChD,wBAAmB,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACtD,oBAAe,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC9C,iBAAY,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxC,iBAAY,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAOrD,SAAS,CAAC,EAAE,CAAC,WAAW,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACjD,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC7C,SAAS,CAAC,EAAE,CAAC,cAAc,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAC;QACvD,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QACzC,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAC7C,CAAC;IAED;;OAEG;IACF,IAAW,OAAO;QACf,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,IAAW,WAAW;QAClB,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;IACtC,CAAC;IAED;;OAEG;IACH,IAAW,QAAQ;QACf,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;IACjC,CAAC;IAED;;OAEG;IACF,IAAW,eAAe;QACvB,OAAO,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,IAAW,cAAc;QACrB,OAAO,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC;IAC9C,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,MAAM;QACf,MAAM,IAAI,KAAK,CAAC,6DAA6D,CAAC,CAAC;IACnF,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAO;;QAChB,MAAA,MAAA,IAAI,CAAC,SAAS,EAAC,OAAO,kDAAI,CAAC;IAC/B,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,UAAU;;QACnB,MAAA,MAAA,IAAI,CAAC,SAAS,EAAC,UAAU,kDAAI,CAAC;IAClC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,MAAM,CAA2B,WAAmC;QAC7E,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACI,OAAO;QACV,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QACvB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACvD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QACnD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,cAAc,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC7D,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAC/C,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IACnD,CAAC;CACJ;AAnGD,wCAmGC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { TypedEventEmitter } from \"@fluidframework/common-utils\";\nimport { IFluidLoadable } from \"@fluidframework/core-interfaces\";\nimport { IEvent, IEventProvider } from \"@fluidframework/common-definitions\";\nimport { AttachState, IContainer, ConnectionState } from \"@fluidframework/container-definitions\";\nimport { LoadableObjectClass, LoadableObjectRecord } from \"./types\";\nimport { RootDataObject } from \"./rootDataObject\";\n\n/**\n * Events emitted from {@link IFluidContainer}.\n *\n * @remarks\n *\n * The following is the list of events emitted.\n *\n * ### \"connected\"\n *\n * The \"connected\" event is emitted when the `IFluidContainer` completes connecting to the Fluid service.\n *\n * #### Listener signature\n *\n * ```typescript\n * () => void;\n * ```\n *\n * ### \"dispose\"\n *\n * The \"dispose\" event is emitted when the `IFluidContainer` is disposed, which permanently disables it.\n *\n * #### Listener signature\n *\n * ```typescript\n * () => void;\n * ```\n *\n * ### \"disconnected\"\n *\n * The \"disconnected\" event is emitted when the `IFluidContainer` becomes disconnected from the Fluid service.\n *\n * #### Listener signature\n *\n * ```typescript\n * () => void;\n * ```\n *\n * ### \"saved\"\n *\n * The \"saved\" event is emitted when the `IFluidContainer` has local changes acknowledged by the service.\n *\n * #### Listener signature\n *\n * ```typescript\n * () => void\n * ```\n *\n * ### \"dirty\"\n *\n * The \"dirty\" event is emitted when the `IFluidContainer` has local changes that have not yet\n * been acknowledged by the service.\n *\n * #### Listener signature\n *\n * ```typescript\n * () => void\n * ```\n */\nexport interface IFluidContainerEvents extends IEvent {\n    (event: \"connected\" | \"dispose\" | \"disconnected\" | \"saved\" | \"dirty\", listener: () => void): void;\n}\n\n/**\n * Provides an entrypoint into the client side of collaborative Fluid data.\n * Provides access to the data as well as status on the collaboration session.\n */\nexport interface IFluidContainer extends IEventProvider<IFluidContainerEvents> {\n    /**\n     * Provides the current connected state of the container\n     */\n    readonly connectionState: ConnectionState;\n\n    /**\n     * A container is considered **dirty** if it has local changes that have not yet been acknowledged by the service.\n     * You should always check the `isDirty` flag before closing the container or navigating away from the page.\n     * Closing the container while `isDirty === true` may result in the loss of operations that have not yet been\n     * acknowledged by the service.\n     *\n     * A container is considered dirty in the following cases:\n     *\n     * 1. The container has been created in the detached state, and either it has not been attached yet or it is\n     * in the process of being attached (container is in `attaching` state). If container is closed prior to being\n     * attached, host may never know if the file was created or not.\n     *\n     * 2. The container was attached, but it has local changes that have not yet been saved to service endpoint.\n     * This occurs as part of normal op flow where pending operation (changes) are awaiting acknowledgement from the\n     * service. In some cases this can be due to lack of network connection. If the network connection is down,\n     * it needs to be restored for the pending changes to be acknowledged.\n     */\n    readonly isDirty: boolean;\n\n    /**\n     * Whether the container is disposed, which permanently disables it.\n     */\n    readonly disposed: boolean;\n\n    /**\n     * The collection of data objects and Distributed Data Stores (DDSes) that were specified by the schema.\n     * These data objects and DDSes exist for the lifetime of the container.\n     */\n    readonly initialObjects: LoadableObjectRecord;\n\n    /**\n     * The current attachment state of the container.  Once a container has been attached, it remains attached.\n     * When loading an existing container, it will already be attached.\n     */\n    readonly attachState: AttachState;\n\n    /**\n     * A newly created container starts detached from the collaborative service.\n     * Calling `attach()` uploads the new container to the service and connects to the collaborative service.\n     *\n     * @remarks This should only be called when the container is in the\n     * {@link @fluidframework/container-definitions#AttachState.Detatched} state.\n     *\n     * This can be determined by observing {@link IFluidContainer.attachState}.\n     *\n     * @returns A promise which resolves when the attach is complete, with the string identifier of the container.\n     */\n    attach(): Promise<string>;\n\n    /**\n     * Attempts to connect the container to the delta stream and process operations.\n     * Will throw an error if unsuccessful.\n     *\n     * @remarks This should only be called when the container is in the\n     * {@link @fluidframework/container-definitions#ConnectionState.Disconnected} state.\n     *\n     * This can be determined by observing {@link IFluidContainer.connectionState}.\n     */\n    connect(): void;\n\n    /**\n     * Disconnects the container from the delta stream and stops processing operations.\n     *\n     * @remarks This should only be called when the container is in the\n     * {@link @fluidframework/container-definitions#ConnectionState.Connected} state.\n     *\n     * This can be determined by observing {@link IFluidContainer.connectionState}.\n     */\n    disconnect(): void;\n\n    /**\n     * Create a new data object or Distributed Data Store (DDS) of the specified type.\n     *\n     * @remarks In order to share the data object or DDS with other\n     * collaborators and retrieve it later, store its handle in a collection like a SharedDirectory from your\n     * initialObjects.\n     *\n     * @param objectClass - The class of data object or DDS to create\n     */\n    create<T extends IFluidLoadable>(objectClass: LoadableObjectClass<T>): Promise<T>;\n\n    /**\n     * Dispose of the container instance, permanently disabling it.\n     */\n    dispose(): void;\n}\n\n/**\n * Base {@link IFluidContainer} implementation.\n *\n * @remarks Note: this implementation is not complete. Consumers who rely on {@link IFluidContainer.attach}\n * will need to utilize or provide a service-specific implementation of this type that implements that method.\n */\nexport class FluidContainer extends TypedEventEmitter<IFluidContainerEvents> implements IFluidContainer {\n    private readonly connectedHandler = () => this.emit(\"connected\");\n    private readonly disconnectedHandler = () => this.emit(\"disconnected\");\n    private readonly disposedHandler = () => this.emit(\"disposed\");\n    private readonly savedHandler = () => this.emit(\"saved\");\n    private readonly dirtyHandler = () => this.emit(\"dirty\");\n\n    public constructor(\n        private readonly container: IContainer,\n        private readonly rootDataObject: RootDataObject,\n    ) {\n        super();\n        container.on(\"connected\", this.connectedHandler);\n        container.on(\"closed\", this.disposedHandler);\n        container.on(\"disconnected\", this.disconnectedHandler);\n        container.on(\"saved\", this.savedHandler);\n        container.on(\"dirty\", this.dirtyHandler);\n    }\n\n    /**\n     * {@inheritDoc IFluidContainer.isDirty}\n     */\n     public get isDirty(): boolean {\n        return this.container.isDirty;\n    }\n\n    /**\n     * {@inheritDoc IFluidContainer.attachState}\n     */\n    public get attachState(): AttachState {\n        return this.container.attachState;\n    }\n\n    /**\n     * {@inheritDoc IFluidContainer.disposed}\n     */\n    public get disposed() {\n        return this.container.closed;\n    }\n\n    /**\n     * {@inheritDoc IFluidContainer.connectionState}\n     */\n     public get connectionState(): ConnectionState {\n        return this.container.connectionState;\n    }\n\n    /**\n     * {@inheritDoc IFluidContainer.initialObjects}\n     */\n    public get initialObjects() {\n        return this.rootDataObject.initialObjects;\n    }\n\n    /**\n     * Incomplete base implementation of {@link IFluidContainer.attach}.\n     * @remarks Note: this implementation will unconditionally throw.\n     * Consumers who rely on this will need to utilize or provide a service specific implementation of this base type\n     * that provides an implementation of this method.\n     *\n     * The reason is because externally we are presenting a separation between the service and the `FluidContainer`,\n     * but internally this separation is not there.\n     */\n    public async attach(): Promise<string> {\n        throw new Error(\"Cannot attach container. Container is not in detached state\");\n    }\n\n    /**\n     * {@inheritDoc IFluidContainer.connect}\n     */\n    public async connect(): Promise<void> {\n        this.container.connect?.();\n    }\n\n    /**\n     * {@inheritDoc IFluidContainer.connect}\n     */\n    public async disconnect(): Promise<void> {\n        this.container.disconnect?.();\n    }\n\n    /**\n     * {@inheritDoc IFluidContainer.create}\n     */\n    public async create<T extends IFluidLoadable>(objectClass: LoadableObjectClass<T>): Promise<T> {\n        return this.rootDataObject.create(objectClass);\n    }\n\n    /**\n     * {@inheritDoc IFluidContainer.dispose}\n     */\n    public dispose() {\n        this.container.close();\n        this.container.off(\"connected\", this.connectedHandler);\n        this.container.off(\"closed\", this.disposedHandler);\n        this.container.off(\"disconnected\", this.disconnectedHandler);\n        this.container.off(\"saved\", this.savedHandler);\n        this.container.off(\"dirty\", this.dirtyHandler);\n    }\n}\n"]}
+{"version":3,"file":"fluidContainer.js","sourceRoot":"","sources":["../src/fluidContainer.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,+DAAiE;AAGjE,iFAK+C;AAsL/C;;;;;;;GAOG;AACH,MAAa,cAAe,SAAQ,gCAAwC;IAOxE,YACqB,SAAqB,EACrB,cAA+B;QAEhD,KAAK,EAAE,CAAC;QAHS,cAAS,GAAT,SAAS,CAAY;QACrB,mBAAc,GAAd,cAAc,CAAiB;QARnC,qBAAgB,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;QAChD,wBAAmB,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACtD,oBAAe,GAAG,CAAC,KAA+B,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;QACpF,iBAAY,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACxC,iBAAY,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAqGzD;;;;;;;;;WASG;QACa,kCAA6B,GAAsB,GAAG,EAAE;YACpE,OAAO,IAAI,CAAC,SAAS,CAAC;QAC1B,CAAC,CAAA;QA1GG,SAAS,CAAC,EAAE,CAAC,WAAW,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACjD,SAAS,CAAC,EAAE,CAAC,QAAQ,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QAC7C,SAAS,CAAC,EAAE,CAAC,cAAc,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAC;QACvD,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QACzC,SAAS,CAAC,EAAE,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IAC7C,CAAC;IAED;;OAEG;IACH,IAAW,OAAO;QACd,OAAO,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;IAClC,CAAC;IAED;;OAEG;IACH,IAAW,WAAW;QAClB,OAAO,IAAI,CAAC,SAAS,CAAC,WAAW,CAAC;IACtC,CAAC;IAED;;OAEG;IACH,IAAW,QAAQ;QACf,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC;IACjC,CAAC;IAED;;OAEG;IACH,IAAW,eAAe;QACtB,OAAO,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC;IAC1C,CAAC;IAED;;OAEG;IACH,IAAW,cAAc;QACrB,OAAO,IAAI,CAAC,cAAc,CAAC,cAAc,CAAC;IAC9C,CAAC;IAED;;;;;;;;;;;OAWG;IACI,KAAK,CAAC,MAAM;QACf,IAAI,IAAI,CAAC,SAAS,CAAC,WAAW,KAAK,mCAAW,CAAC,QAAQ,EAAE;YACrD,MAAM,IAAI,KAAK,CAAC,8DAA8D,CAAC,CAAC;SACnF;QACD,MAAM,IAAI,KAAK,CAAC,sDAAsD,CAAC,CAAC;IAC5E,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,OAAO;;QAChB,MAAA,MAAA,IAAI,CAAC,SAAS,EAAC,OAAO,kDAAI,CAAC;IAC/B,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,UAAU;;QACnB,MAAA,MAAA,IAAI,CAAC,SAAS,EAAC,UAAU,kDAAI,CAAC;IAClC,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,MAAM,CAA2B,WAAmC;QAC7E,OAAO,IAAI,CAAC,cAAc,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;IACnD,CAAC;IAED;;OAEG;IACI,OAAO;QACV,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QACvB,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,WAAW,EAAE,IAAI,CAAC,gBAAgB,CAAC,CAAC;QACvD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,eAAe,CAAC,CAAC;QACnD,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,cAAc,EAAE,IAAI,CAAC,mBAAmB,CAAC,CAAC;QAC7D,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;QAC/C,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,EAAE,IAAI,CAAC,YAAY,CAAC,CAAC;IACnD,CAAC;CAeJ;AAvHD,wCAuHC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport { TypedEventEmitter } from \"@fluidframework/common-utils\";\nimport { IFluidLoadable } from \"@fluidframework/core-interfaces\";\nimport { IEvent, IEventProvider } from \"@fluidframework/common-definitions\";\nimport {\n    AttachState,\n    IContainer,\n    ICriticalContainerError,\n    ConnectionState,\n} from \"@fluidframework/container-definitions\";\nimport type { IRootDataObject, LoadableObjectClass, LoadableObjectRecord } from \"./types\";\n\n/**\n * Events emitted from {@link IFluidContainer}.\n */\n/* eslint-disable @typescript-eslint/unified-signatures */\nexport interface IFluidContainerEvents extends IEvent {\n    /**\n     * Emitted when the {@link IFluidContainer} completes connecting to the Fluid service.\n     *\n     * @remarks Reflects connection state changes against the (delta) service acknowledging ops/edits.\n     *\n     * @see\n     *\n     * - {@link IFluidContainer.connectionState}\n     *\n     * - {@link IFluidContainer.connect}\n     */\n    (event: \"connected\", listener: () => void): void;\n\n    /**\n     * Emitted when the {@link IFluidContainer} becomes disconnected from the Fluid service.\n     *\n     * @remarks Reflects connection state changes against the (delta) service acknowledging ops/edits.\n     *\n     * @see\n     *\n     * - {@link IFluidContainer.connectionState}\n     *\n     * - {@link IFluidContainer.disconnect}\n     */\n    (event: \"disconnected\", listener: () => void): void;\n\n    /**\n     * Emitted when all local changes/edits have been acknowledged by the service.\n     *\n     * @remarks \"dirty\" event will be emitted when the next local change has been made.\n     *\n     * @see {@link IFluidContainer.isDirty}\n     */\n    (event: \"saved\", listener: () => void): void;\n\n    /**\n     * Emitted when the first local change has been made, following a \"saved\" event.\n     *\n     * @remarks \"saved\" event will be emitted once all local changes have been acknowledged by the service.\n     *\n     * @see {@link IFluidContainer.isDirty}\n     */\n    (event: \"dirty\", listener: () => void): void;\n\n    /**\n     * Emitted when the {@link IFluidContainer} is closed, which permanently disables it.\n     *\n     * @remarks Listener parameters:\n     *\n     * - `error`: If the container was closed due to error (as opposed to an explicit call to\n     * {@link IFluidContainer.dispose}), this will contain details about the error that caused it.\n     */\n    (event: \"disposed\", listener: (error?: ICriticalContainerError) => void);\n}\n/* eslint-enable @typescript-eslint/unified-signatures */\n\n/**\n * Provides an entrypoint into the client side of collaborative Fluid data.\n * Provides access to the data as well as status on the collaboration session.\n *\n * @remarks Note: external implementations of this interface are not supported.\n */\nexport interface IFluidContainer extends IEventProvider<IFluidContainerEvents> {\n    /**\n     * Provides the current connected state of the container\n     */\n    readonly connectionState: ConnectionState;\n\n    /**\n     * A container is considered **dirty** if it has local changes that have not yet been acknowledged by the service.\n     *\n     * @remarks\n     *\n     * You should always check the `isDirty` flag before closing the container or navigating away from the page.\n     * Closing the container while `isDirty === true` may result in the loss of operations that have not yet been\n     * acknowledged by the service.\n     *\n     * A container is considered dirty in the following cases:\n     *\n     * 1. The container has been created in the detached state, and either it has not been attached yet or it is\n     * in the process of being attached (container is in `attaching` state). If container is closed prior to being\n     * attached, host may never know if the file was created or not.\n     *\n     * 2. The container was attached, but it has local changes that have not yet been saved to service endpoint.\n     * This occurs as part of normal op flow where pending operation (changes) are awaiting acknowledgement from the\n     * service. In some cases this can be due to lack of network connection. If the network connection is down,\n     * it needs to be restored for the pending changes to be acknowledged.\n     */\n    readonly isDirty: boolean;\n\n    /**\n     * Whether or not the container is disposed, which permanently disables it.\n     */\n    readonly disposed: boolean;\n\n    /**\n     * The collection of data objects and Distributed Data Stores (DDSes) that were specified by the schema.\n     *\n     * @remarks These data objects and DDSes exist for the lifetime of the container.\n     */\n    readonly initialObjects: LoadableObjectRecord;\n\n    /**\n     * The current attachment state of the container.\n     *\n     * @remarks\n     *\n     * Once a container has been attached, it remains attached.\n     * When loading an existing container, it will already be attached.\n     */\n    readonly attachState: AttachState;\n\n    /**\n     * A newly created container starts detached from the collaborative service.\n     * Calling `attach()` uploads the new container to the service and connects to the collaborative service.\n     *\n     * @remarks\n     *\n     * This should only be called when the container is in the\n     * {@link @fluidframework/container-definitions#AttachState.Detatched} state.\n     *\n     * This can be determined by observing {@link IFluidContainer.attachState}.\n     *\n     * @returns A promise which resolves when the attach is complete, with the string identifier of the container.\n     */\n    attach(): Promise<string>;\n\n    /**\n     * Attempts to connect the container to the delta stream and process operations.\n     *\n     * @throws Will throw an error if connection is unsuccessful.\n     *\n     * @remarks\n     *\n     * This should only be called when the container is in the\n     * {@link @fluidframework/container-definitions#ConnectionState.Disconnected} state.\n     *\n     * This can be determined by observing {@link IFluidContainer.connectionState}.\n     */\n    connect(): void;\n\n    /**\n     * Disconnects the container from the delta stream and stops processing operations.\n     *\n     * @remarks\n     *\n     * This should only be called when the container is in the\n     * {@link @fluidframework/container-definitions#ConnectionState.Connected} state.\n     *\n     * This can be determined by observing {@link IFluidContainer.connectionState}.\n     */\n    disconnect(): void;\n\n    /**\n     * Create a new data object or Distributed Data Store (DDS) of the specified type.\n     *\n     * @remarks\n     *\n     * In order to share the data object or DDS with other\n     * collaborators and retrieve it later, store its handle in a collection like a SharedDirectory from your\n     * initialObjects.\n     *\n     * @param objectClass - The class of the `DataObject` or `SharedObject` to create.\n     *\n     * @typeParam T - The class of the `DataObject` or `SharedObject`.\n     */\n    create<T extends IFluidLoadable>(objectClass: LoadableObjectClass<T>): Promise<T>;\n\n    /**\n     * Dispose of the container instance, permanently disabling it.\n     */\n    dispose(): void;\n}\n\n/**\n * Base {@link IFluidContainer} implementation.\n *\n * @remarks\n *\n * Note: this implementation is not complete. Consumers who rely on {@link IFluidContainer.attach}\n * will need to utilize or provide a service-specific implementation of this type that implements that method.\n */\nexport class FluidContainer extends TypedEventEmitter<IFluidContainerEvents> implements IFluidContainer {\n    private readonly connectedHandler = () => this.emit(\"connected\");\n    private readonly disconnectedHandler = () => this.emit(\"disconnected\");\n    private readonly disposedHandler = (error?: ICriticalContainerError) => this.emit(\"disposed\", error);\n    private readonly savedHandler = () => this.emit(\"saved\");\n    private readonly dirtyHandler = () => this.emit(\"dirty\");\n\n    public constructor(\n        private readonly container: IContainer,\n        private readonly rootDataObject: IRootDataObject,\n    ) {\n        super();\n        container.on(\"connected\", this.connectedHandler);\n        container.on(\"closed\", this.disposedHandler);\n        container.on(\"disconnected\", this.disconnectedHandler);\n        container.on(\"saved\", this.savedHandler);\n        container.on(\"dirty\", this.dirtyHandler);\n    }\n\n    /**\n     * {@inheritDoc IFluidContainer.isDirty}\n     */\n    public get isDirty(): boolean {\n        return this.container.isDirty;\n    }\n\n    /**\n     * {@inheritDoc IFluidContainer.attachState}\n     */\n    public get attachState(): AttachState {\n        return this.container.attachState;\n    }\n\n    /**\n     * {@inheritDoc IFluidContainer.disposed}\n     */\n    public get disposed() {\n        return this.container.closed;\n    }\n\n    /**\n     * {@inheritDoc IFluidContainer.connectionState}\n     */\n    public get connectionState(): ConnectionState {\n        return this.container.connectionState;\n    }\n\n    /**\n     * {@inheritDoc IFluidContainer.initialObjects}\n     */\n    public get initialObjects() {\n        return this.rootDataObject.initialObjects;\n    }\n\n    /**\n     * Incomplete base implementation of {@link IFluidContainer.attach}.\n     *\n     * @remarks\n     *\n     * Note: this implementation will unconditionally throw.\n     * Consumers who rely on this will need to utilize or provide a service specific implementation of this base type\n     * that provides an implementation of this method.\n     *\n     * The reason is because externally we are presenting a separation between the service and the `FluidContainer`,\n     * but internally this separation is not there.\n     */\n    public async attach(): Promise<string> {\n        if (this.container.attachState !== AttachState.Detached) {\n            throw new Error(\"Cannot attach container. Container is not in detached state.\");\n        }\n        throw new Error(\"Cannot attach container. Attach method not provided.\");\n    }\n\n    /**\n     * {@inheritDoc IFluidContainer.connect}\n     */\n    public async connect(): Promise<void> {\n        this.container.connect?.();\n    }\n\n    /**\n     * {@inheritDoc IFluidContainer.connect}\n     */\n    public async disconnect(): Promise<void> {\n        this.container.disconnect?.();\n    }\n\n    /**\n     * {@inheritDoc IFluidContainer.create}\n     */\n    public async create<T extends IFluidLoadable>(objectClass: LoadableObjectClass<T>): Promise<T> {\n        return this.rootDataObject.create(objectClass);\n    }\n\n    /**\n     * {@inheritDoc IFluidContainer.dispose}\n     */\n    public dispose() {\n        this.container.close();\n        this.container.off(\"connected\", this.connectedHandler);\n        this.container.off(\"closed\", this.disposedHandler);\n        this.container.off(\"disconnected\", this.disconnectedHandler);\n        this.container.off(\"saved\", this.savedHandler);\n        this.container.off(\"dirty\", this.dirtyHandler);\n    }\n\n    /**\n     * FOR INTERNAL USE ONLY. NOT FOR EXTERNAL USE.\n     * We make no stability guarantees here whatsoever.\n     *\n     * Gets the underlying {@link @fluidframework/container-definitions#IContainer}.\n     *\n     * @remarks Used to power debug tooling.\n     *\n     * @internal\n     */\n    public readonly INTERNAL_CONTAINER_DO_NOT_USE?: () => IContainer = () => {\n        return this.container;\n    }\n}\n"]}

package/dist/index.d.ts

@@ -7,8 +7,8 @@
  *
  * @packageDocumentation
  */
-export * from "./fluidContainer";
-export * from "./rootDataObject";
-export * from "./serviceAudience";
-export * from "./types";
+export { FluidContainer, IFluidContainer, IFluidContainerEvents } from "./fluidContainer";
+export { DOProviderContainerRuntimeFactory, RootDataObject, RootDataObjectProps } from "./rootDataObject";
+export { ServiceAudience } from "./serviceAudience";
+export { ContainerSchema, DataObjectClass, IConnection, IMember, IRootDataObject, IServiceAudience, IServiceAudienceEvents, LoadableObjectClass, LoadableObjectClassRecord, LoadableObjectCtor, LoadableObjectRecord, MemberChangedListener, SharedObjectClass, Myself, } from "./types";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;GAIG;AAEH,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,SAAS,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;GAIG;AAEH,OAAO,EAAE,cAAc,EAAE,eAAe,EAAE,qBAAqB,EAAE,MAAM,kBAAkB,CAAC;AAC1F,OAAO,EAAE,iCAAiC,EAAE,cAAc,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAC1G,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EACN,eAAe,EACf,eAAe,EACf,WAAW,EACX,OAAO,EACP,eAAe,EACf,gBAAgB,EAChB,sBAAsB,EACtB,mBAAmB,EACnB,yBAAyB,EACzB,kBAAkB,EAClB,oBAAoB,EACpB,qBAAqB,EACrB,iBAAiB,EACd,MAAM,GACT,MAAM,SAAS,CAAC"}

package/dist/index.js

@@ -3,24 +3,18 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.ServiceAudience = exports.RootDataObject = exports.DOProviderContainerRuntimeFactory = exports.FluidContainer = void 0;
 /**
  * Provides a simple and powerful way to consume collaborative Fluid data.
  *
  * @packageDocumentation
  */
-__exportStar(require("./fluidContainer"), exports);
-__exportStar(require("./rootDataObject"), exports);
-__exportStar(require("./serviceAudience"), exports);
-__exportStar(require("./types"), exports);
+var fluidContainer_1 = require("./fluidContainer");
+Object.defineProperty(exports, "FluidContainer", { enumerable: true, get: function () { return fluidContainer_1.FluidContainer; } });
+var rootDataObject_1 = require("./rootDataObject");
+Object.defineProperty(exports, "DOProviderContainerRuntimeFactory", { enumerable: true, get: function () { return rootDataObject_1.DOProviderContainerRuntimeFactory; } });
+Object.defineProperty(exports, "RootDataObject", { enumerable: true, get: function () { return rootDataObject_1.RootDataObject; } });
+var serviceAudience_1 = require("./serviceAudience");
+Object.defineProperty(exports, "ServiceAudience", { enumerable: true, get: function () { return serviceAudience_1.ServiceAudience; } });
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;AAEH;;;;GAIG;AAEH,mDAAiC;AACjC,mDAAiC;AACjC,oDAAkC;AAClC,0CAAwB","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Provides a simple and powerful way to consume collaborative Fluid data.\n *\n * @packageDocumentation\n */\n\nexport * from \"./fluidContainer\";\nexport * from \"./rootDataObject\";\nexport * from \"./serviceAudience\";\nexport * from \"./types\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;;;GAIG;AAEH,mDAA0F;AAAjF,gHAAA,cAAc,OAAA;AACvB,mDAA0G;AAAjG,mIAAA,iCAAiC,OAAA;AAAE,gHAAA,cAAc,OAAA;AAC1D,qDAAoD;AAA3C,kHAAA,eAAe,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * Provides a simple and powerful way to consume collaborative Fluid data.\n *\n * @packageDocumentation\n */\n\nexport { FluidContainer, IFluidContainer, IFluidContainerEvents } from \"./fluidContainer\";\nexport { DOProviderContainerRuntimeFactory, RootDataObject, RootDataObjectProps } from \"./rootDataObject\";\nexport { ServiceAudience } from \"./serviceAudience\";\nexport {\n\tContainerSchema,\n\tDataObjectClass,\n\tIConnection,\n\tIMember,\n\tIRootDataObject,\n\tIServiceAudience,\n\tIServiceAudienceEvents,\n\tLoadableObjectClass,\n\tLoadableObjectClassRecord,\n\tLoadableObjectCtor,\n\tLoadableObjectRecord,\n\tMemberChangedListener,\n\tSharedObjectClass,\n    Myself,\n} from \"./types\";\n"]}

package/dist/rootDataObject.d.ts

@@ -5,25 +5,25 @@
 import { BaseContainerRuntimeFactory, DataObject } from "@fluidframework/aqueduct";
 import { IContainerRuntime } from "@fluidframework/container-runtime-definitions";
 import { IFluidLoadable } from "@fluidframework/core-interfaces";
-import { ContainerSchema, LoadableObjectClass, LoadableObjectClassRecord, LoadableObjectRecord } from "./types";
+import { ContainerSchema, IRootDataObject, LoadableObjectClass, LoadableObjectClassRecord, LoadableObjectRecord } from "./types";
 /**
- * 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 declare class RootDataObject extends DataObject<{
     InitialState: RootDataObjectProps;
-}> {
+}> implements IRootDataObject {
     private readonly initialObjectsDirKey;
     private readonly _initialObjects;
     private get initialObjectsDir();
@@ -31,32 +31,34 @@ export declare class RootDataObject extends DataObject<{
      * 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 initializingFirstTime(props: RootDataObjectProps): Promise<void>;
     /**
      * 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 hasInitialized(): Promise<void>;
     /**
-     * Provides a record of the initial objects defined on creation.
-     * See {@link RootDataObject.initializingFirstTime}
+     * {@inheritDoc IRootDataObject.initialObjects}
      */
     get initialObjects(): LoadableObjectRecord;
     /**
-     * Dynamically creates a new detached collaborative object (DDS/DataObject).
-     * @param objectClass - Type of the collaborative object to be created.
+     * {@inheritDoc IRootDataObject.create}
      */
     create<T extends IFluidLoadable>(objectClass: LoadableObjectClass<T>): Promise<T>;
     private createDataObject;
     private createSharedObject;
 }
 /**
- * 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 declare class DOProviderContainerRuntimeFactory extends BaseContainerRuntimeFactory {
     private readonly rootDataObjectFactory;

package/dist/rootDataObject.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"rootDataObject.d.ts","sourceRoot":"","sources":["../src/rootDataObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EACH,2BAA2B,EAC3B,UAAU,EAGb,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAClF,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AAGjE,OAAO,EACH,eAAe,EAEf,mBAAmB,EACnB,yBAAyB,EACzB,oBAAoB,EAEvB,MAAM,SAAS,CAAC;AAGjB;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC;;;OAGG;IACH,cAAc,EAAE,yBAAyB,CAAC;CAC7C;AAED;;;;GAIG;AACH,qBAAa,cAAe,SAAQ,UAAU,CAAC;IAAE,YAAY,EAAE,mBAAmB,CAAC;CAAE,CAAC;IAClF,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAyB;IAC9D,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA4B;IAE5D,OAAO,KAAK,iBAAiB,GAM5B;IAED;;;;;OAKG;cACa,qBAAqB,CAAC,KAAK,EAAE,mBAAmB;IAgBhE;;;;;OAKG;cACa,cAAc;IAc9B;;;OAGG;IACH,IAAW,cAAc,IAAI,oBAAoB,CAKhD;IAED;;;OAGG;IACU,MAAM,CAAC,CAAC,SAAS,cAAc,EACxC,WAAW,EAAE,mBAAmB,CAAC,CAAC,CAAC,GACpC,OAAO,CAAC,CAAC,CAAC;YASC,gBAAgB;IAO9B,OAAO,CAAC,kBAAkB;CAO7B;AAID;;;GAGG;AACH,qBAAa,iCAAkC,SAAQ,2BAA2B;IAC9E,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAEnC;IAEH,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA4B;gBAE/C,MAAM,EAAE,eAAe;IAsBnC;;OAEG;cACa,8BAA8B,CAAC,OAAO,EAAE,iBAAiB;CAO5E"}
+{"version":3,"file":"rootDataObject.d.ts","sourceRoot":"","sources":["../src/rootDataObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EACH,2BAA2B,EAC3B,UAAU,EAGb,MAAM,0BAA0B,CAAC;AAClC,OAAO,EAAE,iBAAiB,EAAE,MAAM,+CAA+C,CAAC;AAClF,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AAEjE,OAAO,EACH,eAAe,EAEf,eAAe,EACf,mBAAmB,EACnB,yBAAyB,EACzB,oBAAoB,EAEvB,MAAM,SAAS,CAAC;AAGjB;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAChC;;;;OAIG;IACH,cAAc,EAAE,yBAAyB,CAAC;CAC7C;AAED;;;GAGG;AACH,qBAAa,cAAe,SAAQ,UAAU,CAAC;IAAE,YAAY,EAAE,mBAAmB,CAAC;CAAE,CAAE,YAAW,eAAe;IAC7G,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAyB;IAC9D,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA4B;IAE5D,OAAO,KAAK,iBAAiB,GAM5B;IAED;;;;;OAKG;cACa,qBAAqB,CAAC,KAAK,EAAE,mBAAmB;IAgBhE;;;;;OAKG;cACa,cAAc;IAc9B;;OAEG;IACH,IAAW,cAAc,IAAI,oBAAoB,CAKhD;IAED;;OAEG;IACU,MAAM,CAAC,CAAC,SAAS,cAAc,EACxC,WAAW,EAAE,mBAAmB,CAAC,CAAC,CAAC,GACpC,OAAO,CAAC,CAAC,CAAC;YASC,gBAAgB;IAQ9B,OAAO,CAAC,kBAAkB;CAO7B;AAID;;;;;;;GAOG;AACH,qBAAa,iCAAkC,SAAQ,2BAA2B;IAC9E,OAAO,CAAC,QAAQ,CAAC,qBAAqB,CAEnC;IAEH,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA4B;gBAE/C,MAAM,EAAE,eAAe;IAsBnC;;OAEG;cACa,8BAA8B,CAAC,OAAO,EAAE,iBAAiB;CAO5E"}

package/dist/rootDataObject.js

@@ -7,12 +7,10 @@ exports.DOProviderContainerRuntimeFactory = exports.RootDataObject = void 0;
  */
 const aqueduct_1 = require("@fluidframework/aqueduct");
 const runtime_definitions_1 = require("@fluidframework/runtime-definitions");
-const runtime_utils_1 = require("@fluidframework/runtime-utils");
 const utils_1 = require("./utils");
 /**
- * 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.
  */
 class RootDataObject extends aqueduct_1.DataObject {
     constructor() {
@@ -31,7 +29,7 @@ class RootDataObject extends aqueduct_1.DataObject {
      * 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}
      */
     async initializingFirstTime(props) {
         this.root.createSubDirectory(this.initialObjectsDirKey);
@@ -50,7 +48,7 @@ class RootDataObject extends aqueduct_1.DataObject {
      * 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}
      */
     async hasInitialized() {
         // We will always load the initial objects so they are available to the developer
@@ -65,8 +63,7 @@ class RootDataObject extends aqueduct_1.DataObject {
         await Promise.all(loadInitialObjectsP);
     }
     /**
-     * Provides a record of the initial objects defined on creation.
-     * See {@link RootDataObject.initializingFirstTime}
+     * {@inheritDoc IRootDataObject.initialObjects}
      */
     get initialObjects() {
         if (Object.keys(this._initialObjects).length === 0) {
@@ -75,8 +72,7 @@ class RootDataObject extends aqueduct_1.DataObject {
         return this._initialObjects;
     }
     /**
-     * Dynamically creates a new detached collaborative object (DDS/DataObject).
-     * @param objectClass - Type of the collaborative object to be created.
+     * {@inheritDoc IRootDataObject.create}
      */
     async create(objectClass) {
         if ((0, utils_1.isDataObjectClass)(objectClass)) {
@@ -88,10 +84,12 @@ class RootDataObject extends aqueduct_1.DataObject {
         throw new Error("Could not create new Fluid object because an unknown object was passed");
     }
     async createDataObject(dataObjectClass) {
+        var _a;
         const factory = dataObjectClass.factory;
         const packagePath = [...this.context.packagePath, factory.type];
-        const router = await this.context.containerRuntime.createDataStore(packagePath);
-        return (0, runtime_utils_1.requestFluidObject)(router, "/");
+        const dataStore = await this.context.containerRuntime.createDataStore(packagePath);
+        const entryPoint = await ((_a = dataStore.entryPoint) === null || _a === void 0 ? void 0 : _a.get());
+        return entryPoint;
     }
     createSharedObject(sharedObjectClass) {
         const factory = sharedObjectClass.getFactory();
@@ -102,8 +100,12 @@ class RootDataObject extends aqueduct_1.DataObject {
 exports.RootDataObject = RootDataObject;
 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.
  */
 class DOProviderContainerRuntimeFactory extends aqueduct_1.BaseContainerRuntimeFactory {
     constructor(schema) {