@fluidframework/fluid-static 1.1.0 → 1.2.0

package/lib/rootDataObject.js.map

@@ -1 +1 @@
-{"version":3,"file":"rootDataObject.js","sourceRoot":"","sources":["../src/rootDataObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EACH,2BAA2B,EAC3B,UAAU,EACV,iBAAiB,EACjB,0BAA0B,GAC7B,MAAM,0BAA0B,CAAC;AAGlC,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AASnE,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,iCAAiC,EAAE,MAAM,SAAS,CAAC;AAMpG,MAAM,OAAO,cAAe,SAAQ,UAAkD;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,iBAAiB,CAAC,WAAW,CAAC,EAAE;YAChC,OAAO,IAAI,CAAC,gBAAgB,CAAI,WAAW,CAAC,CAAC;SAChD;aAAM,IAAI,mBAAmB,CAAC,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,kBAAkB,CAAI,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;AAED,MAAM,eAAe,GAAG,UAAU,CAAC;AAEnC;;;GAGG;AACH,MAAM,OAAO,iCAAkC,SAAQ,2BAA2B;IAG9E,YAAY,MAAuB;QAC/B,MAAM,CAAC,eAAe,EAAE,aAAa,CAAC,GAAG,iCAAiC,CAAC,MAAM,CAAC,CAAC;QACnF,MAAM,qBAAqB,GACvB,IAAI,iBAAiB,CACjB,QAAQ,EACR,cAAc,EACd,aAAa,EACb,EAAE,EACF,eAAe,CAClB,CAAC;QACN,KAAK,CAAC,CAAC,qBAAqB,CAAC,aAAa,CAAC,EAAE,SAAS,EAAE,CAAC,0BAA0B,CAAC,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","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,OAAO,EACH,2BAA2B,EAC3B,UAAU,EACV,iBAAiB,EACjB,0BAA0B,GAC7B,MAAM,0BAA0B,CAAC;AAGlC,OAAO,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AASnE,OAAO,EAAE,iBAAiB,EAAE,mBAAmB,EAAE,iCAAiC,EAAE,MAAM,SAAS,CAAC;AAapG;;;;GAIG;AACH,MAAM,OAAO,cAAe,SAAQ,UAAkD;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,iBAAiB,CAAC,WAAW,CAAC,EAAE;YAChC,OAAO,IAAI,CAAC,gBAAgB,CAAI,WAAW,CAAC,CAAC;SAChD;aAAM,IAAI,mBAAmB,CAAC,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,kBAAkB,CAAI,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;AAED,MAAM,eAAe,GAAG,UAAU,CAAC;AAEnC;;;GAGG;AACH,MAAM,OAAO,iCAAkC,SAAQ,2BAA2B;IAO9E,YAAY,MAAuB;QAC/B,MAAM,CAAC,eAAe,EAAE,aAAa,CAAC,GAAG,iCAAiC,CAAC,MAAM,CAAC,CAAC;QACnF,MAAM,qBAAqB,GACvB,IAAI,iBAAiB,CACjB,QAAQ,EACR,cAAc,EACd,aAAa,EACb,EAAE,EACF,eAAe,CAClB,CAAC;QACN,KAAK,CAAC,CAAC,qBAAqB,CAAC,aAAa,CAAC,EAAE,SAAS,EAAE,CAAC,0BAA0B,CAAC,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","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/lib/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/lib/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/lib/serviceAudience.js

@@ -10,7 +10,11 @@ import { TypedEventEmitter } from "@fluidframework/common-utils";
  * @typeParam M - A service-specific member type.
  */
 export class ServiceAudience extends TypedEventEmitter {
-    constructor(container) {
+    constructor(
+    /**
+     * Fluid Container to read the audience from.
+     */
+    container) {
         super();
         this.container = container;
         /**
@@ -92,6 +96,11 @@ export class ServiceAudience extends 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;

package/lib/serviceAudience.js.map

@@ -1 +1 @@
-{"version":3,"file":"serviceAudience.js","sourceRoot":"","sources":["../src/serviceAudience.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAKjE;;;;;GAKG;AACH,MAAM,OAAgB,eACpB,SAAQ,iBAA4C;IAiBpD,YACuB,SAAqB;QAE1C,KAAK,EAAE,CAAC;QAFa,cAAS,GAAT,SAAS,CAAY;QAd5C;;;;;;;;;;WAUG;QACO,gBAAW,GAAmB,IAAI,GAAG,EAAE,CAAC;QAMhD,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC;QAEnC,iFAAiF;QACjF,+EAA+E;QAC/E,IAAI,CAAC,UAAU,EAAE,CAAC;QAElB,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,QAAgB,EAAE,OAAgB,EAAE,EAAE;YACnE,IAAI,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,EAAE;gBACvC,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;gBACxC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;gBAC3C,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;aAC7B;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,cAAc,EAAE,CAAC,QAAgB,EAAE,EAAE;YACpD,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;gBAClC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;gBACrE,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;aAC7B;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACpE,CAAC;IAID;;OAEG;IACI,UAAU;QACf,MAAM,KAAK,GAAG,IAAI,GAAG,EAAa,CAAC;QACnC,MAAM,eAAe,GAAG,IAAI,GAAG,EAAa,CAAC;QAC7C,0DAA0D;QAC1D,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,OAAO,CAAC,CAAC,MAAe,EAAE,QAAgB,EAAE,EAAE;YACvE,IAAI,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE;gBACtC,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,iCAAiC;gBACjC,IAAI,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBAC7B,IAAI,IAAI,KAAK,SAAS,EAAE;oBACtB,IAAI,GAAG,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;oBACxC,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;iBACzB;gBAED,0CAA0C;gBAC1C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;gBAC3D,eAAe,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;aACrC;QACH,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,WAAW,GAAG,eAAe,CAAC;QACnC,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACI,SAAS;QACd,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;QACzC,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC1B,OAAO,SAAS,CAAC;SAClB;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC;IAEO,SAAS,CAAC,QAAgB;QAChC,oEAAoE;QACpE,MAAM,sBAAsB,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QACjE,IAAI,sBAAsB,KAAK,SAAS,EAAE;YACxC,OAAO,SAAS,CAAC;SAClB;QACD,2EAA2E;QAC3E,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QACrC,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAE,IAAI,CAAC,EAAE,CAAC,CAAC;QAC/D,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,MAAM,KAAK,CAAC,6BAA6B,QAAQ,8CAA8C,CAAC,CAAC;SAClG;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAES,qBAAqB,CAAC,MAAe;QAC7C,6BAA6B;QAC7B,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC;IACjD,CAAC;CACF","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { TypedEventEmitter } from \"@fluidframework/common-utils\";\nimport { IAudience, IContainer } from \"@fluidframework/container-definitions\";\nimport { IClient } from \"@fluidframework/protocol-definitions\";\nimport { IServiceAudience, IServiceAudienceEvents, IMember } from \"./types\";\n\n/**\n * Base class for providing audience information for sessions interacting with FluidContainer\n * This can be extended by different service-specific client packages to additional parameters to\n * the user and client details returned in IMember\n * @typeParam M - A service-specific member type.\n */\nexport abstract class ServiceAudience<M extends IMember = IMember>\n  extends TypedEventEmitter<IServiceAudienceEvents<M>>\n  implements IServiceAudience<M> {\n  protected readonly audience: IAudience;\n\n  /**\n   * Retain the most recent member list.  This is so we have more information about a member\n   * leaving the audience in the removeMember event.  It allows us to match the behavior of the\n   * addMember event where it only fires on a change to the members this class exposes (and would\n   * actually produce a change in what getMembers returns).  It also allows us to provide the\n   * client details in the event which makes it easier to find that client connection in a map\n   * keyed on the userId and not clientId.\n   * This map will always be up-to-date in a removeMember event because it is set once at\n   * construction and in every addMember event.\n   * It is mapped clientId to M to be better work with what the IAudience event provides\n   */\n  protected lastMembers: Map<string, M> = new Map();\n\n  constructor(\n      protected readonly container: IContainer,\n  ) {\n    super();\n    this.audience = container.audience;\n\n    // getMembers will assign lastMembers so the removeMember event has what it needs\n    // in case it would fire before getMembers otherwise gets called the first time\n    this.getMembers();\n\n    this.audience.on(\"addMember\", (clientId: string, details: IClient) => {\n      if (this.shouldIncludeAsMember(details)) {\n        const member = this.getMember(clientId);\n        this.emit(\"memberAdded\", clientId, member);\n        this.emit(\"membersChanged\");\n      }\n    });\n\n    this.audience.on(\"removeMember\", (clientId: string) => {\n      if (this.lastMembers.has(clientId)) {\n        this.emit(\"memberRemoved\", clientId, this.lastMembers.get(clientId));\n        this.emit(\"membersChanged\");\n      }\n    });\n\n    this.container.on(\"connected\", () => this.emit(\"membersChanged\"));\n  }\n\n  protected abstract createServiceMember(audienceMember: IClient): M;\n\n  /**\n   * {@inheritDoc IServiceAudience.getMembers}\n   */\n  public getMembers(): Map<string, M> {\n    const users = new Map<string, M>();\n    const clientMemberMap = new Map<string, M>();\n    // Iterate through the members and get the user specifics.\n    this.audience.getMembers().forEach((member: IClient, clientId: string) => {\n      if (this.shouldIncludeAsMember(member)) {\n        const userId = member.user.id;\n        // Ensure we're tracking the user\n        let user = users.get(userId);\n        if (user === undefined) {\n          user = this.createServiceMember(member);\n          users.set(userId, user);\n        }\n\n        // Add this connection to their collection\n        user.connections.push({ id: clientId, mode: member.mode });\n        clientMemberMap.set(clientId, user);\n      }\n    });\n    this.lastMembers = clientMemberMap;\n    return users;\n  }\n\n  /**\n   * {@inheritDoc IServiceAudience.getMyself}\n   */\n  public getMyself(): M | undefined {\n    const clientId = this.container.clientId;\n    if (clientId === undefined) {\n      return undefined;\n    }\n    return this.getMember(clientId);\n  }\n\n  private getMember(clientId: string): M | undefined {\n    // Fetch the user ID assoicated with this client ID from the runtime\n    const internalAudienceMember = this.audience.getMember(clientId);\n    if (internalAudienceMember === undefined) {\n      return undefined;\n    }\n    // Return the member object with any other clients associated for this user\n    const allMembers = this.getMembers();\n    const member = allMembers.get(internalAudienceMember?.user.id);\n    if (member === undefined) {\n      throw Error(`Attempted to fetch client ${clientId} that is not part of the current member list`);\n    }\n    return member;\n  }\n\n  protected shouldIncludeAsMember(member: IClient): boolean {\n    // Include only human members\n    return member.details.capabilities.interactive;\n  }\n}\n"]}
+{"version":3,"file":"serviceAudience.js","sourceRoot":"","sources":["../src/serviceAudience.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,8BAA8B,CAAC;AAKjE;;;;;GAKG;AACH,MAAM,OAAgB,eACpB,SAAQ,iBAA4C;IAoBpD;IACE;;OAEG;IACgB,SAAqB;QAExC,KAAK,EAAE,CAAC;QAFW,cAAS,GAAT,SAAS,CAAY;QAjB1C;;;;;;;;;;WAUG;QACO,gBAAW,GAAmB,IAAI,GAAG,EAAE,CAAC;QAShD,IAAI,CAAC,QAAQ,GAAG,SAAS,CAAC,QAAQ,CAAC;QAEnC,iFAAiF;QACjF,+EAA+E;QAC/E,IAAI,CAAC,UAAU,EAAE,CAAC;QAElB,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,QAAgB,EAAE,OAAgB,EAAE,EAAE;YACnE,IAAI,IAAI,CAAC,qBAAqB,CAAC,OAAO,CAAC,EAAE;gBACvC,MAAM,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;gBACxC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;gBAC3C,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;aAC7B;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC,cAAc,EAAE,CAAC,QAAgB,EAAE,EAAE;YACpD,IAAI,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;gBAClC,IAAI,CAAC,IAAI,CAAC,eAAe,EAAE,QAAQ,EAAE,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,QAAQ,CAAC,CAAC,CAAC;gBACrE,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;aAC7B;QACH,CAAC,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,EAAE,CAAC,WAAW,EAAE,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC,CAAC;IACpE,CAAC;IAQD;;OAEG;IACI,UAAU;QACf,MAAM,KAAK,GAAG,IAAI,GAAG,EAAa,CAAC;QACnC,MAAM,eAAe,GAAG,IAAI,GAAG,EAAa,CAAC;QAC7C,0DAA0D;QAC1D,IAAI,CAAC,QAAQ,CAAC,UAAU,EAAE,CAAC,OAAO,CAAC,CAAC,MAAe,EAAE,QAAgB,EAAE,EAAE;YACvE,IAAI,IAAI,CAAC,qBAAqB,CAAC,MAAM,CAAC,EAAE;gBACtC,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC9B,iCAAiC;gBACjC,IAAI,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;gBAC7B,IAAI,IAAI,KAAK,SAAS,EAAE;oBACtB,IAAI,GAAG,IAAI,CAAC,mBAAmB,CAAC,MAAM,CAAC,CAAC;oBACxC,KAAK,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;iBACzB;gBAED,0CAA0C;gBAC1C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;gBAC3D,eAAe,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;aACrC;QACH,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,WAAW,GAAG,eAAe,CAAC;QACnC,OAAO,KAAK,CAAC;IACf,CAAC;IAED;;OAEG;IACI,SAAS;QACd,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;QACzC,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC1B,OAAO,SAAS,CAAC;SAClB;QACD,OAAO,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IAClC,CAAC;IAEO,SAAS,CAAC,QAAgB;QAChC,oEAAoE;QACpE,MAAM,sBAAsB,GAAG,IAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;QACjE,IAAI,sBAAsB,KAAK,SAAS,EAAE;YACxC,OAAO,SAAS,CAAC;SAClB;QACD,2EAA2E;QAC3E,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC;QACrC,MAAM,MAAM,GAAG,UAAU,CAAC,GAAG,CAAC,sBAAsB,aAAtB,sBAAsB,uBAAtB,sBAAsB,CAAE,IAAI,CAAC,EAAE,CAAC,CAAC;QAC/D,IAAI,MAAM,KAAK,SAAS,EAAE;YACxB,MAAM,KAAK,CAAC,6BAA6B,QAAQ,8CAA8C,CAAC,CAAC;SAClG;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED;;;;OAIG;IACO,qBAAqB,CAAC,MAAe;QAC7C,6BAA6B;QAC7B,OAAO,MAAM,CAAC,OAAO,CAAC,YAAY,CAAC,WAAW,CAAC;IACjD,CAAC;CACF","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { TypedEventEmitter } from \"@fluidframework/common-utils\";\nimport { IAudience, IContainer } from \"@fluidframework/container-definitions\";\nimport { IClient } from \"@fluidframework/protocol-definitions\";\nimport { IServiceAudience, IServiceAudienceEvents, IMember } from \"./types\";\n\n/**\n * Base class for providing audience information for sessions interacting with FluidContainer\n * This can be extended by different service-specific client packages to additional parameters to\n * the user and client details returned in IMember\n * @typeParam M - A service-specific member type.\n */\nexport abstract class ServiceAudience<M extends IMember = IMember>\n  extends TypedEventEmitter<IServiceAudienceEvents<M>>\n  implements IServiceAudience<M> {\n  /**\n   * Audience object which includes all the existing members of the container.\n   */\n  protected readonly audience: IAudience;\n\n  /**\n   * Retain the most recent member list.  This is so we have more information about a member\n   * leaving the audience in the removeMember event.  It allows us to match the behavior of the\n   * addMember event where it only fires on a change to the members this class exposes (and would\n   * actually produce a change in what getMembers returns).  It also allows us to provide the\n   * client details in the event which makes it easier to find that client connection in a map\n   * keyed on the userId and not clientId.\n   * This map will always be up-to-date in a removeMember event because it is set once at\n   * construction and in every addMember event.\n   * It is mapped clientId to M to be better work with what the IAudience event provides\n   */\n  protected lastMembers: Map<string, M> = new Map();\n\n  constructor(\n    /**\n     * Fluid Container to read the audience from.\n     */\n    protected readonly container: IContainer,\n  ) {\n    super();\n    this.audience = container.audience;\n\n    // getMembers will assign lastMembers so the removeMember event has what it needs\n    // in case it would fire before getMembers otherwise gets called the first time\n    this.getMembers();\n\n    this.audience.on(\"addMember\", (clientId: string, details: IClient) => {\n      if (this.shouldIncludeAsMember(details)) {\n        const member = this.getMember(clientId);\n        this.emit(\"memberAdded\", clientId, member);\n        this.emit(\"membersChanged\");\n      }\n    });\n\n    this.audience.on(\"removeMember\", (clientId: string) => {\n      if (this.lastMembers.has(clientId)) {\n        this.emit(\"memberRemoved\", clientId, this.lastMembers.get(clientId));\n        this.emit(\"membersChanged\");\n      }\n    });\n\n    this.container.on(\"connected\", () => this.emit(\"membersChanged\"));\n  }\n\n  /**\n   * Provides ability for inheriting class to modify/extend the audience object.\n   * @param audienceMember - Record of a specific audience member.\n   */\n  protected abstract createServiceMember(audienceMember: IClient): M;\n\n  /**\n   * {@inheritDoc IServiceAudience.getMembers}\n   */\n  public getMembers(): Map<string, M> {\n    const users = new Map<string, M>();\n    const clientMemberMap = new Map<string, M>();\n    // Iterate through the members and get the user specifics.\n    this.audience.getMembers().forEach((member: IClient, clientId: string) => {\n      if (this.shouldIncludeAsMember(member)) {\n        const userId = member.user.id;\n        // Ensure we're tracking the user\n        let user = users.get(userId);\n        if (user === undefined) {\n          user = this.createServiceMember(member);\n          users.set(userId, user);\n        }\n\n        // Add this connection to their collection\n        user.connections.push({ id: clientId, mode: member.mode });\n        clientMemberMap.set(clientId, user);\n      }\n    });\n    this.lastMembers = clientMemberMap;\n    return users;\n  }\n\n  /**\n   * {@inheritDoc IServiceAudience.getMyself}\n   */\n  public getMyself(): M | undefined {\n    const clientId = this.container.clientId;\n    if (clientId === undefined) {\n      return undefined;\n    }\n    return this.getMember(clientId);\n  }\n\n  private getMember(clientId: string): M | undefined {\n    // Fetch the user ID assoicated with this client ID from the runtime\n    const internalAudienceMember = this.audience.getMember(clientId);\n    if (internalAudienceMember === undefined) {\n      return undefined;\n    }\n    // Return the member object with any other clients associated for this user\n    const allMembers = this.getMembers();\n    const member = allMembers.get(internalAudienceMember?.user.id);\n    if (member === undefined) {\n      throw Error(`Attempted to fetch client ${clientId} that is not part of the current member list`);\n    }\n    return member;\n  }\n\n  /**\n   * Provides ability for the inheriting class to include/omit specific members.\n   * An example use case is omitting the summarizer client.\n   * @param member - Member to be included/omitted.\n   */\n  protected shouldIncludeAsMember(member: IClient): boolean {\n    // Include only human members\n    return member.details.capabilities.interactive;\n  }\n}\n"]}

package/lib/types.d.ts

@@ -48,9 +48,10 @@ export declare type LoadableObjectCtor<T extends IFluidLoadable> = new (...args:
  */
 export interface ContainerSchema {
     /**
-     * initialObjects defines loadable objects that will be created when the Container
-     * is first created. It uses the key as the id and the value as the loadable object to create.
+     * Defines loadable objects that will be created when the `Container` is first created.
+     * It uses the key as the id and the value as the loadable object to create.
      *
+     * @example
      * In the example below two objects will be created when the Container is first
      * created. One with id "map1" that will return a `SharedMap` and the other with
      * id "pair1" that will return a `KeyValueDataObject`.
@@ -75,12 +76,16 @@ export interface ContainerSchema {
 }
 /**
  * Events that trigger when the roster of members in the Fluid session change.
- * Only changes that would be reflected in the returned map of IServiceAudience's getMembers method
- * will emit events.
+ * Only changes that would be reflected in the returned map of {@link IServiceAudience}'s
+ * {@link IServiceAudience.getMembers} method will emit events.
+ *
+ * @remarks
+ *
+ * The following is the list of events emitted.
  *
  * ### "membersChanged"
  *
- * The membersChanged event is emitted when a member is either added or removed.
+ * The "membersChanged" event is emitted when a member is either added or removed.
  *
  * #### Listener signature
  *
@@ -90,7 +95,7 @@ export interface ContainerSchema {
  *
  * ### "memberAdded"
  *
- * The memberAdded event is emitted when a member joins the audience.
+ * The "memberAdded" event is emitted when a member joins the audience.
  *
  * #### Listener signature
  *
@@ -103,7 +108,7 @@ export interface ContainerSchema {
  *
  * ### "memberRemoved"
  *
- * The memberRemoved event is emitted when a member leaves the audience.
+ * The "memberRemoved" event is emitted when a member leaves the audience.
  *
  * #### Listener signature
  *

package/lib/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AACxE,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAE7E;;GAEG;AACH,oBAAY,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;AAElE;;;GAGG;AACH,oBAAY,yBAAyB,GAAG,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC;AAEjF;;;GAGG;AACH,oBAAY,mBAAmB,CAAC,CAAC,SAAS,cAAc,IAAI,eAAe,CAAC,CAAC,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;AAEtG;;;;GAIG;AACH,oBAAY,eAAe,CAAC,CAAC,SAAS,cAAc,IAC9C;IAAE,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAC;CAAE,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC;AAE5E;;;;GAIG;AACH,oBAAY,iBAAiB,CAAC,CAAC,SAAS,cAAc,IAChD;IAAE,QAAQ,CAAC,UAAU,EAAE,MAAM,eAAe,CAAC;CAAE,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC;AAE9E;;;GAGG;AACH,oBAAY,kBAAkB,CAAC,CAAC,SAAS,cAAc,IAAI,KAAI,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;AAEpF;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC5B;;;;;;;;;;;;;;OAcG;IACH,cAAc,EAAE,yBAAyB,CAAC;IAE1C;;;;;;;OAOG;IACH,kBAAkB,CAAC,EAAE,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAC;CACnD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,MAAM,WAAW,sBAAsB,CAAC,CAAC,SAAS,OAAO,CAAE,SAAQ,MAAM;IACrE,CAAC,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IACtD,CAAC,KAAK,EAAE,aAAa,GAAG,eAAe,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,KAAK,IAAI,GAAG,IAAI,CAAC;CACnG;AAED;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,OAAO,CAAE,SAAQ,cAAc,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAClG;;;;OAIG;IACH,UAAU,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAE7B;;OAEG;IACH,SAAS,IAAI,CAAC,GAAG,SAAS,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,OAAO,GAAG,MAAM,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,WAAW,EAAE,CAAC;CAC9B"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,oCAAoC,CAAC;AAC5E,OAAO,EAAE,cAAc,EAAE,MAAM,iCAAiC,CAAC;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AACxE,OAAO,EAAE,sBAAsB,EAAE,MAAM,qCAAqC,CAAC;AAE7E;;GAEG;AACH,oBAAY,oBAAoB,GAAG,MAAM,CAAC,MAAM,EAAE,cAAc,CAAC,CAAC;AAElE;;;GAGG;AACH,oBAAY,yBAAyB,GAAG,MAAM,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC;AAEjF;;;GAGG;AACH,oBAAY,mBAAmB,CAAC,CAAC,SAAS,cAAc,IAAI,eAAe,CAAC,CAAC,CAAC,GAAG,iBAAiB,CAAC,CAAC,CAAC,CAAC;AAEtG;;;;GAIG;AACH,oBAAY,eAAe,CAAC,CAAC,SAAS,cAAc,IAC9C;IAAE,QAAQ,CAAC,OAAO,EAAE,sBAAsB,CAAC;CAAE,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC;AAE5E;;;;GAIG;AACH,oBAAY,iBAAiB,CAAC,CAAC,SAAS,cAAc,IAChD;IAAE,QAAQ,CAAC,UAAU,EAAE,MAAM,eAAe,CAAC;CAAE,GAAG,kBAAkB,CAAC,CAAC,CAAC,CAAC;AAE9E;;;GAGG;AACH,oBAAY,kBAAkB,CAAC,CAAC,SAAS,cAAc,IAAI,KAAI,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;AAEpF;;;;GAIG;AACH,MAAM,WAAW,eAAe;IAC5B;;;;;;;;;;;;;;;OAeG;IACH,cAAc,EAAE,yBAAyB,CAAC;IAE1C;;;;;;;OAOG;IACH,kBAAkB,CAAC,EAAE,mBAAmB,CAAC,GAAG,CAAC,EAAE,CAAC;CACnD;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAM,WAAW,sBAAsB,CAAC,CAAC,SAAS,OAAO,CAAE,SAAQ,MAAM;IACrE,CAAC,KAAK,EAAE,gBAAgB,EAAE,QAAQ,EAAE,MAAM,IAAI,GAAG,IAAI,CAAC;IACtD,CAAC,KAAK,EAAE,aAAa,GAAG,eAAe,EAAE,QAAQ,EAAE,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,CAAC,KAAK,IAAI,GAAG,IAAI,CAAC;CACnG;AAED;;;;;GAKG;AACH,MAAM,WAAW,gBAAgB,CAAC,CAAC,SAAS,OAAO,CAAE,SAAQ,cAAc,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAClG;;;;OAIG;IACH,UAAU,IAAI,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;IAE7B;;OAEG;IACH,SAAS,IAAI,CAAC,GAAG,SAAS,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,WAAW;IACxB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,IAAI,EAAE,OAAO,GAAG,MAAM,CAAC;CAC1B;AAED;;;GAGG;AACH,MAAM,WAAW,OAAO;IACpB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,WAAW,EAAE,WAAW,EAAE,CAAC;CAC9B"}

package/lib/types.js.map

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/fluid-static",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "A tool to enable consumption of Fluid Data Objects without requiring custom container code.",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -35,25 +35,25 @@
     "typetests:gen": "fluid-type-validator -g -d ."
   },
   "dependencies": {
-    "@fluidframework/aqueduct": "^1.1.0",
+    "@fluidframework/aqueduct": "^1.2.0",
     "@fluidframework/common-definitions": "^0.20.1",
     "@fluidframework/common-utils": "^0.32.1",
-    "@fluidframework/container-definitions": "^1.1.0",
-    "@fluidframework/container-loader": "^1.1.0",
-    "@fluidframework/container-runtime-definitions": "^1.1.0",
-    "@fluidframework/core-interfaces": "^1.1.0",
-    "@fluidframework/datastore-definitions": "^1.1.0",
+    "@fluidframework/container-definitions": "^1.2.0",
+    "@fluidframework/container-loader": "^1.2.0",
+    "@fluidframework/container-runtime-definitions": "^1.2.0",
+    "@fluidframework/core-interfaces": "^1.2.0",
+    "@fluidframework/datastore-definitions": "^1.2.0",
     "@fluidframework/protocol-definitions": "^0.1028.2000",
-    "@fluidframework/request-handler": "^1.1.0",
-    "@fluidframework/runtime-definitions": "^1.1.0",
-    "@fluidframework/runtime-utils": "^1.1.0"
+    "@fluidframework/request-handler": "^1.2.0",
+    "@fluidframework/runtime-definitions": "^1.2.0",
+    "@fluidframework/runtime-utils": "^1.2.0"
   },
   "devDependencies": {
-    "@fluid-experimental/get-container": "^1.1.0",
+    "@fluid-experimental/get-container": "^1.2.0",
     "@fluidframework/build-common": "^0.24.0",
     "@fluidframework/build-tools": "^0.2.74327",
     "@fluidframework/eslint-config-fluid": "^0.28.2000",
-    "@fluidframework/fluid-static-previous": "npm:@fluidframework/fluid-static@^1.0.0",
+    "@fluidframework/fluid-static-previous": "npm:@fluidframework/fluid-static@1.1.0",
     "@microsoft/api-extractor": "^7.22.2",
     "@rushstack/eslint-config": "^2.5.1",
     "@types/node": "^14.18.0",
@@ -66,7 +66,7 @@
     "typescript-formatter": "7.1.0"
   },
   "typeValidation": {
-    "version": "1.1.0",
+    "version": "1.2.0",
     "broken": {}
   }
 }

package/src/fluidContainer.ts

@@ -10,11 +10,15 @@ 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
  *
@@ -24,7 +28,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
  *
@@ -34,7 +38,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
  *
@@ -44,7 +48,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
  *
@@ -54,7 +58,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
@@ -68,8 +72,8 @@ export interface IFluidContainerEvents extends IEvent {
 }
 
 /**
- * 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> {
     /**
@@ -77,7 +81,7 @@ 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
@@ -94,7 +98,7 @@ export interface IFluidContainer extends IEventProvider<IFluidContainerEvents> {
      * 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;
+    readonly isDirty: boolean;
 
     /**
      * Whether the container is disposed, which permanently disables it.
@@ -102,8 +106,8 @@ export interface IFluidContainer extends IEventProvider<IFluidContainerEvents> {
     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;
 
@@ -114,26 +118,46 @@ 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>;
@@ -145,7 +169,10 @@ export interface IFluidContainer extends IEventProvider<IFluidContainerEvents> {
 }
 
 /**
- * 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 class FluidContainer extends TypedEventEmitter<IFluidContainerEvents> implements IFluidContainer {
     private readonly connectedHandler = () => this.emit("connected");
@@ -202,7 +229,13 @@ export class FluidContainer extends TypedEventEmitter<IFluidContainerEvents> imp
     }
 
     /**
-     * {@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.
      */
     public async attach(): Promise<string> {
         throw new Error("Cannot attach container. Container is not in detached state");

package/src/index.ts

@@ -3,6 +3,12 @@
  * 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/src/rootDataObject.ts

@@ -21,10 +21,22 @@ import {
 } from "./types";
 import { isDataObjectClass, isSharedObjectClass, parseDataObjectsFromSharedObjects } from "./utils";
 
+/**
+ * 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 class RootDataObject extends DataObject<{ InitialState: RootDataObjectProps; }> {
     private readonly initialObjectsDirKey = "initial-objects-key";
     private readonly _initialObjects: LoadableObjectRecord = {};
@@ -37,6 +49,12 @@ export class RootDataObject extends DataObject<{ InitialState: RootDataObjectPro
         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}
+     */
     protected async initializingFirstTime(props: RootDataObjectProps) {
         this.root.createSubDirectory(this.initialObjectsDirKey);
 
@@ -53,6 +71,12 @@ export class RootDataObject extends DataObject<{ InitialState: RootDataObjectPro
         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}
+     */
     protected async hasInitialized() {
         // We will always load the initial objects so they are available to the developer
         const loadInitialObjectsP: Promise<void>[] = [];
@@ -67,6 +91,10 @@ export class RootDataObject extends DataObject<{ InitialState: RootDataObjectPro
         await Promise.all(loadInitialObjectsP);
     }
 
+    /**
+     * Provides a record of the initial objects defined on creation.
+     * See {@link RootDataObject.initializingFirstTime}
+     */
     public get initialObjects(): LoadableObjectRecord {
         if (Object.keys(this._initialObjects).length === 0) {
             throw new Error("Initial Objects were not correctly initialized");
@@ -74,6 +102,10 @@ export class RootDataObject extends DataObject<{ InitialState: RootDataObjectPro
         return this._initialObjects;
     }
 
+    /**
+     * Dynamically creates a new detached collaborative object (DDS/DataObject).
+     * @param objectClass - Type of the collaborative object to be created.
+     */
     public async create<T extends IFluidLoadable>(
         objectClass: LoadableObjectClass<T>,
     ): Promise<T> {
@@ -104,12 +136,16 @@ export class RootDataObject extends DataObject<{ InitialState: RootDataObjectPro
 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.
  */
 export class DOProviderContainerRuntimeFactory extends BaseContainerRuntimeFactory {
-    private readonly rootDataObjectFactory; // type is DataObjectFactory
+    private readonly rootDataObjectFactory: DataObjectFactory<RootDataObject, {
+        InitialState: RootDataObjectProps;
+    }>;
+
     private readonly initialObjects: LoadableObjectClassRecord;
+
     constructor(schema: ContainerSchema) {
         const [registryEntries, sharedObjects] = parseDataObjectsFromSharedObjects(schema);
         const rootDataObjectFactory =
@@ -125,6 +161,9 @@ export class DOProviderContainerRuntimeFactory extends BaseContainerRuntimeFacto
         this.initialObjects = schema.initialObjects;
     }
 
+    /**
+     * {@inheritDoc @fluidframework/aqueduct#BaseContainerRuntimeFactory.containerInitializingFirstTime}
+     */
     protected async containerInitializingFirstTime(runtime: IContainerRuntime) {
         // The first time we create the container we create the RootDataObject
         await this.rootDataObjectFactory.createRootInstance(