@fluidframework/fluid-static 1.1.0-76254 → 1.2.0-78837

package/README.md

@@ -2,8 +2,6 @@
 
 The `fluid-static` package provides a simple and powerful way to consume collaborative Fluid data.
 
-This package is marked as experimental and currently under development. The API surface is currently under going drastic braking changes with no guarantees on compatibility.
-
 ## Using fluid-static
 
 The `fluid-static` package contains a container with a pre-created default data object with the ability to create and store additional objects. This is abstracted behind a developer-friendly `FluidContainer` interface that provides configurations for defining the container's initial object and supported dynamic object types, as well as callbacks for creating and fetching DDSes and data objects.

package/api-extractor.json

@@ -1,4 +1,4 @@
 {
   "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-  "extends": "@fluidframework/build-common/api-extractor-common-report.json"
+  "extends": "@fluidframework/build-common/api-extractor-common-strict.json"
 }

package/dist/fluidContainer.d.ts

@@ -9,11 +9,15 @@ import { AttachState, IContainer, ConnectionState } from "@fluidframework/contai
 import { LoadableObjectClass, LoadableObjectRecord } from "./types";
 import { RootDataObject } from "./rootDataObject";
 /**
- * Events emitted from IFluidContainer.
+ * 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.
+ * The "connected" event is emitted when the `IFluidContainer` completes connecting to the Fluid service.
  *
  * #### Listener signature
  *
@@ -23,7 +27,7 @@ import { RootDataObject } from "./rootDataObject";
  *
  * ### "dispose"
  *
- * The dispose event is emitted when the `IFluidContainer` is disposed, which permanently disables it.
+ * The "dispose" event is emitted when the `IFluidContainer` is disposed, which permanently disables it.
  *
  * #### Listener signature
  *
@@ -33,7 +37,7 @@ import { RootDataObject } from "./rootDataObject";
  *
  * ### "disconnected"
  *
- * The disconnected event is emitted when the `IFluidContainer` becomes disconnected from the Fluid service.
+ * The "disconnected" event is emitted when the `IFluidContainer` becomes disconnected from the Fluid service.
  *
  * #### Listener signature
  *
@@ -43,7 +47,7 @@ import { RootDataObject } from "./rootDataObject";
  *
  * ### "saved"
  *
- * The saved event is emitted when the `IFluidContainer` has local changes acknowledged by the service.
+ * The "saved" event is emitted when the `IFluidContainer` has local changes acknowledged by the service.
  *
  * #### Listener signature
  *
@@ -53,7 +57,7 @@ import { RootDataObject } from "./rootDataObject";
  *
  * ### "dirty"
  *
- * The dirty event is emitted when the `IFluidContainer` has local changes that have not yet
+ * The "dirty" event is emitted when the `IFluidContainer` has local changes that have not yet
  * been acknowledged by the service.
  *
  * #### Listener signature
@@ -66,8 +70,8 @@ export interface IFluidContainerEvents extends IEvent {
     (event: "connected" | "dispose" | "disconnected" | "saved" | "dirty", listener: () => void): void;
 }
 /**
- * The IFluidContainer provides an entrypoint into the client side of collaborative Fluid data.  It provides access
- * to the data as well as status on the collaboration session.
+ * Provides an entrypoint into the client side of collaborative Fluid data.
+ * Provides access to the data as well as status on the collaboration session.
  */
 export interface IFluidContainer extends IEventProvider<IFluidContainerEvents> {
     /**
@@ -75,30 +79,30 @@ 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.
-    * 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.
-    *
-    * A container is considered dirty in the following cases:
-    *
-    * 1. The container has been created in the detached state, and either it has not been attached yet or it is
-    * in the process of being attached (container is in `attaching` state). If container is closed prior to being
-    * attached, host may never know if the file was created or not.
-    *
-    * 2. The container was attached, but it has local changes that have not yet been saved to service endpoint.
-    * This occurs as part of normal op flow where pending operation (changes) are awaiting acknowledgement from the
-    * service. In some cases this can be due to lack of network connection. If the network connection is down,
-    * it needs to be restored for the pending changes to be acknowledged.
-    */
+     * A container is considered **dirty** if it has local changes that have not yet been acknowledged by the service.
+     * 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.
+     *
+     * A container is considered dirty in the following cases:
+     *
+     * 1. The container has been created in the detached state, and either it has not been attached yet or it is
+     * in the process of being attached (container is in `attaching` state). If container is closed prior to being
+     * attached, host may never know if the file was created or not.
+     *
+     * 2. The container was attached, but it has local changes that have not yet been saved to service endpoint.
+     * This occurs as part of normal op flow where pending operation (changes) are awaiting acknowledgement from the
+     * service. In some cases this can be due to lack of network connection. If the network connection is down,
+     * it needs to be restored for the pending changes to be acknowledged.
+     */
     readonly isDirty: boolean;
     /**
      * Whether the container is disposed, which permanently disables it.
      */
     readonly disposed: boolean;
     /**
-     * The collection of data objects and DDSes that were specified by the schema. These data objects and DDSes exist
-     * for the lifetime of the container.
+     * 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.
      */
     readonly initialObjects: LoadableObjectRecord;
     /**
@@ -107,23 +111,43 @@ export interface IFluidContainer extends IEventProvider<IFluidContainerEvents> {
      */
     readonly attachState: AttachState;
     /**
-     * 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.
+     * 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
+     * {@link @fluidframework/container-definitions#AttachState.Detatched} state.
+     *
+     * This can be determined by observing {@link IFluidContainer.attachState}.
+     *
      * @returns A promise which resolves when the attach is complete, with the string identifier of the container.
      */
     attach(): Promise<string>;
     /**
-     * Attempts to connect the container to the delta stream and process ops
+     * 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
+     * {@link @fluidframework/container-definitions#ConnectionState.Disconnected} state.
+     *
+     * This can be determined by observing {@link IFluidContainer.connectionState}.
      */
     connect(): void;
     /**
-     * Disconnects the container from the delta stream and stops processing ops
+     * Disconnects the container from the delta stream and stops processing operations.
+     *
+     * @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}.
      */
     disconnect(): void;
     /**
-     * Create a new data object or DDS of the specified type.  In order to share the data object or DDS with other
+     * 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
      * 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
      */
     create<T extends IFluidLoadable>(objectClass: LoadableObjectClass<T>): Promise<T>;
@@ -133,7 +157,10 @@ export interface IFluidContainer extends IEventProvider<IFluidContainerEvents> {
     dispose(): void;
 }
 /**
- * Implementation of the IFluidContainer.
+ * Base {@link IFluidContainer} implementation.
+ *
+ * @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 {
     private readonly container;
@@ -165,7 +192,13 @@ export declare class FluidContainer extends TypedEventEmitter<IFluidContainerEve
      */
     get initialObjects(): LoadableObjectRecord;
     /**
-     * {@inheritDoc IFluidContainer.attach}
+     * Incomplete base implementation of {@link IFluidContainer.attach}.
+     * @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.
+     *
+     * The reason is because externally we are presenting a separation between the service and the `FluidContainer`,
+     * but internally this separation is not there.
      */
     attach(): Promise<string>;
     /**

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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqDG;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;IAEzC;;;;;;;;;;;;;;;;MAgBE;IACF,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE3B;;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;;;;OAIG;IACH,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;IAE1B;;OAEG;IACH,OAAO,IAAI,IAAI,CAAC;IAEhB;;OAEG;IACH,UAAU,IAAI,IAAI,CAAC;IAEnB;;;;;OAKG;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;;GAEG;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;;OAEG;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,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"}

package/dist/fluidContainer.js

@@ -7,7 +7,10 @@ exports.FluidContainer = void 0;
  */
 const common_utils_1 = require("@fluidframework/common-utils");
 /**
- * Implementation of the IFluidContainer.
+ * Base {@link IFluidContainer} implementation.
+ *
+ * @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 {
     constructor(container, rootDataObject) {
@@ -56,7 +59,13 @@ class FluidContainer extends common_utils_1.TypedEventEmitter {
         return this.rootDataObject.initialObjects;
     }
     /**
-     * {@inheritDoc IFluidContainer.attach}
+     * Incomplete base implementation of {@link IFluidContainer.attach}.
+     * @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.
+     *
+     * The reason is because externally we are presenting a separation between the service and the `FluidContainer`,
+     * but internally this separation is not there.
      */
     async attach() {
         throw new Error("Cannot attach container. Container is not in detached state");

package/dist/fluidContainer.js.map

@@ -1 +1 @@
-{"version":3,"file":"fluidContainer.js","sourceRoot":"","sources":["../src/fluidContainer.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,+DAAiE;AA8IjE;;GAEG;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;;OAEG;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;AA7FD,wCA6FC","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 IFluidContainer.\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 * The IFluidContainer provides an entrypoint into the client side of collaborative Fluid data.  It provides access\n * 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 DDSes that were specified by the schema. These data objects and DDSes exist\n     * 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.  Calling attach() uploads the\n     * new container to the service and connects to the collaborative service.\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 ops\n     */\n    connect(): void;\n\n    /**\n     * Disconnects the container from the delta stream and stops processing ops\n     */\n    disconnect(): void;\n\n    /**\n     * Create a new data object or DDS of the specified type.  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     * @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 * Implementation of the IFluidContainer.\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     * {@inheritDoc IFluidContainer.attach}\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;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"]}

package/dist/index.d.ts

@@ -2,6 +2,11 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
+/**
+ * Provides a simple and powerful way to consume collaborative Fluid data.
+ *
+ * @packageDocumentation
+ */
 export * from "./fluidContainer";
 export * from "./rootDataObject";
 export * from "./serviceAudience";

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;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,cAAc,kBAAkB,CAAC;AACjC,cAAc,kBAAkB,CAAC;AACjC,cAAc,mBAAmB,CAAC;AAClC,cAAc,SAAS,CAAC"}

package/dist/index.js

@@ -14,6 +14,11 @@ 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 });
+/**
+ * Provides a simple and powerful way to consume collaborative Fluid data.
+ *
+ * @packageDocumentation
+ */
 __exportStar(require("./fluidContainer"), exports);
 __exportStar(require("./rootDataObject"), exports);
 __exportStar(require("./serviceAudience"), exports);

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;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\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,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"]}

package/dist/rootDataObject.d.ts

@@ -6,30 +6,65 @@ import { BaseContainerRuntimeFactory, DataObject } from "@fluidframework/aqueduc
 import { IContainerRuntime } from "@fluidframework/container-runtime-definitions";
 import { IFluidLoadable } from "@fluidframework/core-interfaces";
 import { ContainerSchema, LoadableObjectClass, LoadableObjectClassRecord, LoadableObjectRecord } from "./types";
+/**
+ * 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}
+     */
     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.
+ */
 export declare class RootDataObject extends DataObject<{
     InitialState: RootDataObjectProps;
 }> {
     private readonly initialObjectsDirKey;
     private readonly _initialObjects;
     private get initialObjectsDir();
+    /**
+     * 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}
+     */
     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}
+     */
     protected hasInitialized(): Promise<void>;
+    /**
+     * Provides a record of the initial objects defined on creation.
+     * See {@link RootDataObject.initializingFirstTime}
+     */
     get initialObjects(): LoadableObjectRecord;
+    /**
+     * Dynamically creates a new detached collaborative object (DDS/DataObject).
+     * @param objectClass - Type of the collaborative object to be created.
+     */
     create<T extends IFluidLoadable>(objectClass: LoadableObjectClass<T>): Promise<T>;
     private createDataObject;
     private createSharedObject;
 }
 /**
- * The DOProviderContainerRuntimeFactory is container code that provides a single RootDataObject.  This data object is
+ * 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.
  */
 export declare class DOProviderContainerRuntimeFactory extends BaseContainerRuntimeFactory {
     private readonly rootDataObjectFactory;
     private readonly initialObjects;
     constructor(schema: ContainerSchema);
+    /**
+     * {@inheritDoc @fluidframework/aqueduct#BaseContainerRuntimeFactory.containerInitializingFirstTime}
+     */
     protected containerInitializingFirstTime(runtime: IContainerRuntime): Promise<void>;
 }
 //# sourceMappingURL=rootDataObject.d.ts.map

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;AAEjE,OAAO,EACH,eAAe,EAEf,mBAAmB,EACnB,yBAAyB,EACzB,oBAAoB,EAEvB,MAAM,SAAS,CAAC;AAGjB,MAAM,WAAW,mBAAmB;IAChC,cAAc,EAAE,yBAAyB,CAAC;CAC7C;AAED,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;cAEe,qBAAqB,CAAC,KAAK,EAAE,mBAAmB;cAgBhD,cAAc;IAc9B,IAAW,cAAc,IAAI,oBAAoB,CAKhD;IAEY,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,CAAC;IACvC,OAAO,CAAC,QAAQ,CAAC,cAAc,CAA4B;gBAC/C,MAAM,EAAE,eAAe;cAenB,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,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;IAenC;;OAEG;cACa,8BAA8B,CAAC,OAAO,EAAE,iBAAiB;CAO5E"}

package/dist/rootDataObject.js

@@ -8,6 +8,11 @@ exports.DOProviderContainerRuntimeFactory = exports.RootDataObject = void 0;
 const aqueduct_1 = require("@fluidframework/aqueduct");
 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.
+ */
 class RootDataObject extends aqueduct_1.DataObject {
     constructor() {
         super(...arguments);
@@ -21,6 +26,12 @@ class RootDataObject extends aqueduct_1.DataObject {
         }
         return dir;
     }
+    /**
+     * 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}
+     */
     async initializingFirstTime(props) {
         this.root.createSubDirectory(this.initialObjectsDirKey);
         // Create initial objects provided by the developer
@@ -34,6 +45,12 @@ class RootDataObject extends aqueduct_1.DataObject {
         });
         await Promise.all(initialObjectsP);
     }
+    /**
+     * 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}
+     */
     async hasInitialized() {
         // We will always load the initial objects so they are available to the developer
         const loadInitialObjectsP = [];
@@ -46,12 +63,20 @@ class RootDataObject extends aqueduct_1.DataObject {
         }
         await Promise.all(loadInitialObjectsP);
     }
+    /**
+     * Provides a record of the initial objects defined on creation.
+     * See {@link RootDataObject.initializingFirstTime}
+     */
     get initialObjects() {
         if (Object.keys(this._initialObjects).length === 0) {
             throw new Error("Initial Objects were not correctly initialized");
         }
         return this._initialObjects;
     }
+    /**
+     * Dynamically creates a new detached collaborative object (DDS/DataObject).
+     * @param objectClass - Type of the collaborative object to be created.
+     */
     async create(objectClass) {
         if ((0, utils_1.isDataObjectClass)(objectClass)) {
             return this.createDataObject(objectClass);
@@ -76,7 +101,7 @@ class RootDataObject extends aqueduct_1.DataObject {
 exports.RootDataObject = RootDataObject;
 const rootDataStoreId = "rootDOId";
 /**
- * The DOProviderContainerRuntimeFactory is container code that provides a single RootDataObject.  This data object is
+ * 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.
  */
 class DOProviderContainerRuntimeFactory extends aqueduct_1.BaseContainerRuntimeFactory {
@@ -87,6 +112,9 @@ class DOProviderContainerRuntimeFactory extends aqueduct_1.BaseContainerRuntimeF
         this.rootDataObjectFactory = rootDataObjectFactory;
         this.initialObjects = schema.initialObjects;
     }
+    /**
+     * {@inheritDoc @fluidframework/aqueduct#BaseContainerRuntimeFactory.containerInitializingFirstTime}
+     */
     async containerInitializingFirstTime(runtime) {
         // The first time we create the container we create the RootDataObject
         await this.rootDataObjectFactory.createRootInstance(rootDataStoreId, runtime, { initialObjects: this.initialObjects });

package/dist/rootDataObject.js.map

@@ -1 +1 @@
-{"version":3,"file":"rootDataObject.js","sourceRoot":"","sources":["../src/rootDataObject.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,uDAKkC;AAGlC,iEAAmE;AASnE,mCAAoG;AAMpG,MAAa,cAAe,SAAQ,qBAAkD;IAAtF;;QACqB,yBAAoB,GAAG,qBAAqB,CAAC;QAC7C,oBAAe,GAAyB,EAAE,CAAC;IAwEhE,CAAC;IAtEG,IAAY,iBAAiB;QACzB,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QACjE,IAAI,GAAG,KAAK,SAAS,EAAE;YACnB,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;SACvE;QACD,OAAO,GAAG,CAAC;IACf,CAAC;IAES,KAAK,CAAC,qBAAqB,CAAC,KAA0B;QAC5D,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAExD,mDAAmD;QACnD,MAAM,eAAe,GAAoB,EAAE,CAAC;QAC5C,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,WAAW,CAAC,EAAE,EAAE;YAC/D,MAAM,YAAY,GAAG,KAAK,IAAI,EAAE;gBAC5B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;gBAC3C,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;YAC/C,CAAC,CAAC;YACF,eAAe,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IACvC,CAAC;IAES,KAAK,CAAC,cAAc;QAC1B,iFAAiF;QACjF,MAAM,mBAAmB,GAAoB,EAAE,CAAC;QAChD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,CAAC,EAAE;YACrE,MAAM,OAAO,GAAG,KAAK,IAAI,EAAE;gBACvB,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,CAAC;gBAC9B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;YACxD,CAAC,CAAC;YACF,mBAAmB,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;SACvC;QAED,MAAM,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;IAC3C,CAAC;IAED,IAAW,cAAc;QACrB,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;YAChD,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;SACrE;QACD,OAAO,IAAI,CAAC,eAAe,CAAC;IAChC,CAAC;IAEM,KAAK,CAAC,MAAM,CACf,WAAmC;QAEnC,IAAI,IAAA,yBAAiB,EAAC,WAAW,CAAC,EAAE;YAChC,OAAO,IAAI,CAAC,gBAAgB,CAAI,WAAW,CAAC,CAAC;SAChD;aAAM,IAAI,IAAA,2BAAmB,EAAC,WAAW,CAAC,EAAE;YACzC,OAAO,IAAI,CAAC,kBAAkB,CAAI,WAAW,CAAC,CAAC;SAClD;QACD,MAAM,IAAI,KAAK,CAAC,wEAAwE,CAAC,CAAC;IAC9F,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAA2B,eAAmC;QACxF,MAAM,OAAO,GAAG,eAAe,CAAC,OAAO,CAAC;QACxC,MAAM,WAAW,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;QAChE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;QAChF,OAAO,IAAA,kCAAkB,EAAI,MAAM,EAAE,GAAG,CAAC,CAAC;IAC9C,CAAC;IAEO,kBAAkB,CACtB,iBAAuC;QAEvC,MAAM,OAAO,GAAG,iBAAiB,CAAC,UAAU,EAAE,CAAC;QAC/C,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;QAChE,OAAO,GAAmB,CAAC;IAC/B,CAAC;CACJ;AA1ED,wCA0EC;AAED,MAAM,eAAe,GAAG,UAAU,CAAC;AAEnC;;;GAGG;AACH,MAAa,iCAAkC,SAAQ,sCAA2B;IAG9E,YAAY,MAAuB;QAC/B,MAAM,CAAC,eAAe,EAAE,aAAa,CAAC,GAAG,IAAA,yCAAiC,EAAC,MAAM,CAAC,CAAC;QACnF,MAAM,qBAAqB,GACvB,IAAI,4BAAiB,CACjB,QAAQ,EACR,cAAc,EACd,aAAa,EACb,EAAE,EACF,eAAe,CAClB,CAAC;QACN,KAAK,CAAC,CAAC,qBAAqB,CAAC,aAAa,CAAC,EAAE,SAAS,EAAE,CAAC,IAAA,qCAA0B,EAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QACvG,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;QACnD,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;IAChD,CAAC;IAES,KAAK,CAAC,8BAA8B,CAAC,OAA0B;QACrE,sEAAsE;QACtE,MAAM,IAAI,CAAC,qBAAqB,CAAC,kBAAkB,CAC/C,eAAe,EACf,OAAO,EACP,EAAE,cAAc,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC;IACjD,CAAC;CACJ;AAzBD,8EAyBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport {\n    BaseContainerRuntimeFactory,\n    DataObject,\n    DataObjectFactory,\n    defaultRouteRequestHandler,\n} from \"@fluidframework/aqueduct\";\nimport { IContainerRuntime } from \"@fluidframework/container-runtime-definitions\";\nimport { IFluidLoadable } from \"@fluidframework/core-interfaces\";\nimport { requestFluidObject } from \"@fluidframework/runtime-utils\";\nimport {\n    ContainerSchema,\n    DataObjectClass,\n    LoadableObjectClass,\n    LoadableObjectClassRecord,\n    LoadableObjectRecord,\n    SharedObjectClass,\n} from \"./types\";\nimport { isDataObjectClass, isSharedObjectClass, parseDataObjectsFromSharedObjects } from \"./utils\";\n\nexport interface RootDataObjectProps {\n    initialObjects: LoadableObjectClassRecord;\n}\n\nexport class RootDataObject extends DataObject<{ InitialState: RootDataObjectProps; }> {\n    private readonly initialObjectsDirKey = \"initial-objects-key\";\n    private readonly _initialObjects: LoadableObjectRecord = {};\n\n    private get initialObjectsDir() {\n        const dir = this.root.getSubDirectory(this.initialObjectsDirKey);\n        if (dir === undefined) {\n            throw new Error(\"InitialObjects sub-directory was not initialized\");\n        }\n        return dir;\n    }\n\n    protected async initializingFirstTime(props: RootDataObjectProps) {\n        this.root.createSubDirectory(this.initialObjectsDirKey);\n\n        // Create initial objects provided by the developer\n        const initialObjectsP: Promise<void>[] = [];\n        Object.entries(props.initialObjects).forEach(([id, objectClass]) => {\n            const createObject = async () => {\n                const obj = await this.create(objectClass);\n                this.initialObjectsDir.set(id, obj.handle);\n            };\n            initialObjectsP.push(createObject());\n        });\n\n        await Promise.all(initialObjectsP);\n    }\n\n    protected async hasInitialized() {\n        // We will always load the initial objects so they are available to the developer\n        const loadInitialObjectsP: Promise<void>[] = [];\n        for (const [key, value] of Array.from(this.initialObjectsDir.entries())) {\n            const loadDir = async () => {\n                const obj = await value.get();\n                Object.assign(this._initialObjects, { [key]: obj });\n            };\n            loadInitialObjectsP.push(loadDir());\n        }\n\n        await Promise.all(loadInitialObjectsP);\n    }\n\n    public get initialObjects(): LoadableObjectRecord {\n        if (Object.keys(this._initialObjects).length === 0) {\n            throw new Error(\"Initial Objects were not correctly initialized\");\n        }\n        return this._initialObjects;\n    }\n\n    public async create<T extends IFluidLoadable>(\n        objectClass: LoadableObjectClass<T>,\n    ): Promise<T> {\n        if (isDataObjectClass(objectClass)) {\n            return this.createDataObject<T>(objectClass);\n        } else if (isSharedObjectClass(objectClass)) {\n            return this.createSharedObject<T>(objectClass);\n        }\n        throw new Error(\"Could not create new Fluid object because an unknown object was passed\");\n    }\n\n    private async createDataObject<T extends IFluidLoadable>(dataObjectClass: DataObjectClass<T>): Promise<T> {\n        const factory = dataObjectClass.factory;\n        const packagePath = [...this.context.packagePath, factory.type];\n        const router = await this.context.containerRuntime.createDataStore(packagePath);\n        return requestFluidObject<T>(router, \"/\");\n    }\n\n    private createSharedObject<T extends IFluidLoadable>(\n        sharedObjectClass: SharedObjectClass<T>,\n    ): T {\n        const factory = sharedObjectClass.getFactory();\n        const obj = this.runtime.createChannel(undefined, factory.type);\n        return obj as unknown as T;\n    }\n}\n\nconst rootDataStoreId = \"rootDOId\";\n\n/**\n * The DOProviderContainerRuntimeFactory is container code that provides a single RootDataObject.  This data object is\n * dynamically customized (registry and initial objects) based on the schema provided to the container runtime factory.\n */\nexport class DOProviderContainerRuntimeFactory extends BaseContainerRuntimeFactory {\n    private readonly rootDataObjectFactory; // type is DataObjectFactory\n    private readonly initialObjects: LoadableObjectClassRecord;\n    constructor(schema: ContainerSchema) {\n        const [registryEntries, sharedObjects] = parseDataObjectsFromSharedObjects(schema);\n        const rootDataObjectFactory =\n            new DataObjectFactory(\n                \"rootDO\",\n                RootDataObject,\n                sharedObjects,\n                {},\n                registryEntries,\n            );\n        super([rootDataObjectFactory.registryEntry], undefined, [defaultRouteRequestHandler(rootDataStoreId)]);\n        this.rootDataObjectFactory = rootDataObjectFactory;\n        this.initialObjects = schema.initialObjects;\n    }\n\n    protected async containerInitializingFirstTime(runtime: IContainerRuntime) {\n        // The first time we create the container we create the RootDataObject\n        await this.rootDataObjectFactory.createRootInstance(\n            rootDataStoreId,\n            runtime,\n            { initialObjects: this.initialObjects });\n    }\n}\n"]}
+{"version":3,"file":"rootDataObject.js","sourceRoot":"","sources":["../src/rootDataObject.ts"],"names":[],"mappings":";;;AAAA;;;GAGG;AACH,uDAKkC;AAGlC,iEAAmE;AASnE,mCAAoG;AAapG;;;;GAIG;AACH,MAAa,cAAe,SAAQ,qBAAkD;IAAtF;;QACqB,yBAAoB,GAAG,qBAAqB,CAAC;QAC7C,oBAAe,GAAyB,EAAE,CAAC;IA4FhE,CAAC;IA1FG,IAAY,iBAAiB;QACzB,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QACjE,IAAI,GAAG,KAAK,SAAS,EAAE;YACnB,MAAM,IAAI,KAAK,CAAC,kDAAkD,CAAC,CAAC;SACvE;QACD,OAAO,GAAG,CAAC;IACf,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,qBAAqB,CAAC,KAA0B;QAC5D,IAAI,CAAC,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;QAExD,mDAAmD;QACnD,MAAM,eAAe,GAAoB,EAAE,CAAC;QAC5C,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,cAAc,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,EAAE,WAAW,CAAC,EAAE,EAAE;YAC/D,MAAM,YAAY,GAAG,KAAK,IAAI,EAAE;gBAC5B,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;gBAC3C,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,EAAE,EAAE,GAAG,CAAC,MAAM,CAAC,CAAC;YAC/C,CAAC,CAAC;YACF,eAAe,CAAC,IAAI,CAAC,YAAY,EAAE,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,MAAM,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,CAAC;IACvC,CAAC;IAED;;;;;OAKG;IACO,KAAK,CAAC,cAAc;QAC1B,iFAAiF;QACjF,MAAM,mBAAmB,GAAoB,EAAE,CAAC;QAChD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,iBAAiB,CAAC,OAAO,EAAE,CAAC,EAAE;YACrE,MAAM,OAAO,GAAG,KAAK,IAAI,EAAE;gBACvB,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE,CAAC;gBAC9B,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,eAAe,EAAE,EAAE,CAAC,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC,CAAC;YACxD,CAAC,CAAC;YACF,mBAAmB,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;SACvC;QAED,MAAM,OAAO,CAAC,GAAG,CAAC,mBAAmB,CAAC,CAAC;IAC3C,CAAC;IAED;;;OAGG;IACH,IAAW,cAAc;QACrB,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,MAAM,KAAK,CAAC,EAAE;YAChD,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;SACrE;QACD,OAAO,IAAI,CAAC,eAAe,CAAC;IAChC,CAAC;IAED;;;OAGG;IACI,KAAK,CAAC,MAAM,CACf,WAAmC;QAEnC,IAAI,IAAA,yBAAiB,EAAC,WAAW,CAAC,EAAE;YAChC,OAAO,IAAI,CAAC,gBAAgB,CAAI,WAAW,CAAC,CAAC;SAChD;aAAM,IAAI,IAAA,2BAAmB,EAAC,WAAW,CAAC,EAAE;YACzC,OAAO,IAAI,CAAC,kBAAkB,CAAI,WAAW,CAAC,CAAC;SAClD;QACD,MAAM,IAAI,KAAK,CAAC,wEAAwE,CAAC,CAAC;IAC9F,CAAC;IAEO,KAAK,CAAC,gBAAgB,CAA2B,eAAmC;QACxF,MAAM,OAAO,GAAG,eAAe,CAAC,OAAO,CAAC;QACxC,MAAM,WAAW,GAAG,CAAC,GAAG,IAAI,CAAC,OAAO,CAAC,WAAW,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;QAChE,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;QAChF,OAAO,IAAA,kCAAkB,EAAI,MAAM,EAAE,GAAG,CAAC,CAAC;IAC9C,CAAC;IAEO,kBAAkB,CACtB,iBAAuC;QAEvC,MAAM,OAAO,GAAG,iBAAiB,CAAC,UAAU,EAAE,CAAC;QAC/C,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,SAAS,EAAE,OAAO,CAAC,IAAI,CAAC,CAAC;QAChE,OAAO,GAAmB,CAAC;IAC/B,CAAC;CACJ;AA9FD,wCA8FC;AAED,MAAM,eAAe,GAAG,UAAU,CAAC;AAEnC;;;GAGG;AACH,MAAa,iCAAkC,SAAQ,sCAA2B;IAO9E,YAAY,MAAuB;QAC/B,MAAM,CAAC,eAAe,EAAE,aAAa,CAAC,GAAG,IAAA,yCAAiC,EAAC,MAAM,CAAC,CAAC;QACnF,MAAM,qBAAqB,GACvB,IAAI,4BAAiB,CACjB,QAAQ,EACR,cAAc,EACd,aAAa,EACb,EAAE,EACF,eAAe,CAClB,CAAC;QACN,KAAK,CAAC,CAAC,qBAAqB,CAAC,aAAa,CAAC,EAAE,SAAS,EAAE,CAAC,IAAA,qCAA0B,EAAC,eAAe,CAAC,CAAC,CAAC,CAAC;QACvG,IAAI,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;QACnD,IAAI,CAAC,cAAc,GAAG,MAAM,CAAC,cAAc,CAAC;IAChD,CAAC;IAED;;OAEG;IACO,KAAK,CAAC,8BAA8B,CAAC,OAA0B;QACrE,sEAAsE;QACtE,MAAM,IAAI,CAAC,qBAAqB,CAAC,kBAAkB,CAC/C,eAAe,EACf,OAAO,EACP,EAAE,cAAc,EAAE,IAAI,CAAC,cAAc,EAAE,CAAC,CAAC;IACjD,CAAC;CACJ;AAhCD,8EAgCC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nimport {\n    BaseContainerRuntimeFactory,\n    DataObject,\n    DataObjectFactory,\n    defaultRouteRequestHandler,\n} from \"@fluidframework/aqueduct\";\nimport { IContainerRuntime } from \"@fluidframework/container-runtime-definitions\";\nimport { IFluidLoadable } from \"@fluidframework/core-interfaces\";\nimport { requestFluidObject } from \"@fluidframework/runtime-utils\";\nimport {\n    ContainerSchema,\n    DataObjectClass,\n    LoadableObjectClass,\n    LoadableObjectClassRecord,\n    LoadableObjectRecord,\n    SharedObjectClass,\n} from \"./types\";\nimport { isDataObjectClass, isSharedObjectClass, parseDataObjectsFromSharedObjects } from \"./utils\";\n\n/**\n * Input props for {@link RootDataObject.initializingFirstTime}\n */\nexport interface RootDataObjectProps {\n    /**\n     * Initial object structure with which the {@link RootDataObject} will be first-time initialized.\n     * See {@link RootDataObject.initializingFirstTime}\n     */\n    initialObjects: LoadableObjectClassRecord;\n}\n\n/**\n * The entry-point/root collaborative object of the Fluid Container.\n * This class abstracts the dynamic code required to build a Fluid Container into a static representation\n * for end customers.\n */\nexport class RootDataObject extends DataObject<{ InitialState: RootDataObjectProps; }> {\n    private readonly initialObjectsDirKey = \"initial-objects-key\";\n    private readonly _initialObjects: LoadableObjectRecord = {};\n\n    private get initialObjectsDir() {\n        const dir = this.root.getSubDirectory(this.initialObjectsDirKey);\n        if (dir === undefined) {\n            throw new Error(\"InitialObjects sub-directory was not initialized\");\n        }\n        return dir;\n    }\n\n    /**\n     * The first time this object is initialized, creates each object identified in\n     * {@link RootDataObjectProps.initialObjects} and stores them as unique values in the root directory.\n     *\n     * See {@link @fluidframework/aqueduct#PureDataObject.initializingFirstTime}\n     */\n    protected async initializingFirstTime(props: RootDataObjectProps) {\n        this.root.createSubDirectory(this.initialObjectsDirKey);\n\n        // Create initial objects provided by the developer\n        const initialObjectsP: Promise<void>[] = [];\n        Object.entries(props.initialObjects).forEach(([id, objectClass]) => {\n            const createObject = async () => {\n                const obj = await this.create(objectClass);\n                this.initialObjectsDir.set(id, obj.handle);\n            };\n            initialObjectsP.push(createObject());\n        });\n\n        await Promise.all(initialObjectsP);\n    }\n\n    /**\n     * Every time an instance is initialized, loads all of the initial objects in the root directory so they can be\n     * accessed immediately.\n     *\n     * See {@link @fluidframework/aqueduct#PureDataObject.hasInitialized}\n     */\n    protected async hasInitialized() {\n        // We will always load the initial objects so they are available to the developer\n        const loadInitialObjectsP: Promise<void>[] = [];\n        for (const [key, value] of Array.from(this.initialObjectsDir.entries())) {\n            const loadDir = async () => {\n                const obj = await value.get();\n                Object.assign(this._initialObjects, { [key]: obj });\n            };\n            loadInitialObjectsP.push(loadDir());\n        }\n\n        await Promise.all(loadInitialObjectsP);\n    }\n\n    /**\n     * Provides a record of the initial objects defined on creation.\n     * See {@link RootDataObject.initializingFirstTime}\n     */\n    public get initialObjects(): LoadableObjectRecord {\n        if (Object.keys(this._initialObjects).length === 0) {\n            throw new Error(\"Initial Objects were not correctly initialized\");\n        }\n        return this._initialObjects;\n    }\n\n    /**\n     * Dynamically creates a new detached collaborative object (DDS/DataObject).\n     * @param objectClass - Type of the collaborative object to be created.\n     */\n    public async create<T extends IFluidLoadable>(\n        objectClass: LoadableObjectClass<T>,\n    ): Promise<T> {\n        if (isDataObjectClass(objectClass)) {\n            return this.createDataObject<T>(objectClass);\n        } else if (isSharedObjectClass(objectClass)) {\n            return this.createSharedObject<T>(objectClass);\n        }\n        throw new Error(\"Could not create new Fluid object because an unknown object was passed\");\n    }\n\n    private async createDataObject<T extends IFluidLoadable>(dataObjectClass: DataObjectClass<T>): Promise<T> {\n        const factory = dataObjectClass.factory;\n        const packagePath = [...this.context.packagePath, factory.type];\n        const router = await this.context.containerRuntime.createDataStore(packagePath);\n        return requestFluidObject<T>(router, \"/\");\n    }\n\n    private createSharedObject<T extends IFluidLoadable>(\n        sharedObjectClass: SharedObjectClass<T>,\n    ): T {\n        const factory = sharedObjectClass.getFactory();\n        const obj = this.runtime.createChannel(undefined, factory.type);\n        return obj as unknown as T;\n    }\n}\n\nconst rootDataStoreId = \"rootDOId\";\n\n/**\n * Container code that provides a single {@link RootDataObject}.  This data object is\n * dynamically customized (registry and initial objects) based on the schema provided to the container runtime factory.\n */\nexport class DOProviderContainerRuntimeFactory extends BaseContainerRuntimeFactory {\n    private readonly rootDataObjectFactory: DataObjectFactory<RootDataObject, {\n        InitialState: RootDataObjectProps;\n    }>;\n\n    private readonly initialObjects: LoadableObjectClassRecord;\n\n    constructor(schema: ContainerSchema) {\n        const [registryEntries, sharedObjects] = parseDataObjectsFromSharedObjects(schema);\n        const rootDataObjectFactory =\n            new DataObjectFactory(\n                \"rootDO\",\n                RootDataObject,\n                sharedObjects,\n                {},\n                registryEntries,\n            );\n        super([rootDataObjectFactory.registryEntry], undefined, [defaultRouteRequestHandler(rootDataStoreId)]);\n        this.rootDataObjectFactory = rootDataObjectFactory;\n        this.initialObjects = schema.initialObjects;\n    }\n\n    /**\n     * {@inheritDoc @fluidframework/aqueduct#BaseContainerRuntimeFactory.containerInitializingFirstTime}\n     */\n    protected async containerInitializingFirstTime(runtime: IContainerRuntime) {\n        // The first time we create the container we create the RootDataObject\n        await this.rootDataObjectFactory.createRootInstance(\n            rootDataStoreId,\n            runtime,\n            { initialObjects: this.initialObjects });\n    }\n}\n"]}

package/dist/serviceAudience.d.ts

@@ -13,7 +13,13 @@ import { IServiceAudience, IServiceAudienceEvents, IMember } from "./types";
  * @typeParam M - A service-specific member type.
  */
 export declare abstract class ServiceAudience<M extends IMember = IMember> extends TypedEventEmitter<IServiceAudienceEvents<M>> implements IServiceAudience<M> {
+    /**
+     * Fluid Container to read the audience from.
+     */
     protected readonly container: IContainer;
+    /**
+     * Audience object which includes all the existing members of the container.
+     */
     protected readonly audience: IAudience;
     /**
      * Retain the most recent member list.  This is so we have more information about a member
@@ -27,7 +33,15 @@ export declare abstract class ServiceAudience<M extends IMember = IMember> exten
      * It is mapped clientId to M to be better work with what the IAudience event provides
      */
     protected lastMembers: Map<string, M>;
-    constructor(container: IContainer);
+    constructor(
+    /**
+     * Fluid Container to read the audience from.
+     */
+    container: IContainer);
+    /**
+     * Provides ability for inheriting class to modify/extend the audience object.
+     * @param audienceMember - Record of a specific audience member.
+     */
     protected abstract createServiceMember(audienceMember: IClient): M;
     /**
      * {@inheritDoc IServiceAudience.getMembers}
@@ -38,6 +52,11 @@ export declare abstract class ServiceAudience<M extends IMember = IMember> exten
      */
     getMyself(): M | undefined;
     private getMember;
+    /**
+     * 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;
 }
 //# sourceMappingURL=serviceAudience.d.ts.map

package/dist/serviceAudience.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"serviceAudience.d.ts","sourceRoot":"","sources":["../src/serviceAudience.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,uCAAuC,CAAC;AAC9E,OAAO,EAAE,OAAO,EAAE,MAAM,sCAAsC,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAE5E;;;;;GAKG;AACH,8BAAsB,eAAe,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,CAC/D,SAAQ,iBAAiB,CAAC,sBAAsB,CAAC,CAAC,CAAC,CACnD,YAAW,gBAAgB,CAAC,CAAC,CAAC;IAiB1B,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,UAAU;IAhB5C,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;IAEvC;;;;;;;;;;OAUG;IACH,SAAS,CAAC,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAa;gBAG3B,SAAS,EAAE,UAAU;IA2B5C,SAAS,CAAC,QAAQ,CAAC,mBAAmB,CAAC,cAAc,EAAE,OAAO,GAAG,CAAC;IAElE;;OAEG;IACI,UAAU,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;IAuBnC;;OAEG;IACI,SAAS,IAAI,CAAC,GAAG,SAAS;IAQjC,OAAO,CAAC,SAAS;IAejB,SAAS,CAAC,qBAAqB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO;CAI1D"}
+{"version":3,"file":"serviceAudience.d.ts","sourceRoot":"","sources":["../src/serviceAudience.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,uCAAuC,CAAC;AAC9E,OAAO,EAAE,OAAO,EAAE,MAAM,sCAAsC,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAE,sBAAsB,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAE5E;;;;;GAKG;AACH,8BAAsB,eAAe,CAAC,CAAC,SAAS,OAAO,GAAG,OAAO,CAC/D,SAAQ,iBAAiB,CAAC,sBAAsB,CAAC,CAAC,CAAC,CACnD,YAAW,gBAAgB,CAAC,CAAC,CAAC;IAoB5B;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,SAAS,EAAE,UAAU;IAtB1C;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;IAEvC;;;;;;;;;;OAUG;IACH,SAAS,CAAC,WAAW,EAAE,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAa;;IAGhD;;OAEG;IACgB,SAAS,EAAE,UAAU;IA2B1C;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,mBAAmB,CAAC,cAAc,EAAE,OAAO,GAAG,CAAC;IAElE;;OAEG;IACI,UAAU,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC;IAuBnC;;OAEG;IACI,SAAS,IAAI,CAAC,GAAG,SAAS;IAQjC,OAAO,CAAC,SAAS;IAejB;;;;OAIG;IACH,SAAS,CAAC,qBAAqB,CAAC,MAAM,EAAE,OAAO,GAAG,OAAO;CAI1D"}

package/dist/serviceAudience.js

@@ -13,7 +13,11 @@ const common_utils_1 = require("@fluidframework/common-utils");
  * @typeParam M - A service-specific member type.
  */
 class ServiceAudience extends common_utils_1.TypedEventEmitter {
-    constructor(container) {
+    constructor(
+    /**
+     * Fluid Container to read the audience from.
+     */
+    container) {
         super();
         this.container = container;
         /**
@@ -95,6 +99,11 @@ class ServiceAudience extends common_utils_1.TypedEventEmitter {
         }
         return member;
     }
+    /**
+     * 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.
+     */
     shouldIncludeAsMember(member) {
         // Include only human members
         return member.details.capabilities.interactive;