npm - @fluidframework/fluid-static - Versions diffs - 2.53.1 → 2.61.0-355054 - Mend

@fluidframework/fluid-static 2.53.1 → 2.61.0-355054

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (25) hide show

package/.mocharc.cjs +1 -2
package/CHANGELOG.md +4 -0
package/api-extractor.json +1 -1
package/api-report/{fluid-static.alpha.api.md → fluid-static.legacy.beta.api.md} +3 -3
package/dist/legacy.d.ts +4 -2
package/dist/public.d.ts +2 -1
package/dist/treeRootDataObject.d.ts +1 -1
package/dist/treeRootDataObject.js +1 -1
package/dist/treeRootDataObject.js.map +1 -1
package/dist/types.d.ts +1 -1
package/dist/types.js.map +1 -1
package/internal.d.ts +1 -1
package/legacy.d.ts +1 -1
package/lib/legacy.d.ts +4 -2
package/lib/public.d.ts +2 -1
package/lib/treeRootDataObject.d.ts +1 -1
package/lib/treeRootDataObject.js +1 -1
package/lib/treeRootDataObject.js.map +1 -1
package/lib/tsdoc-metadata.json +1 -1
package/lib/types.d.ts +1 -1
package/lib/types.js.map +1 -1
package/package.json +30 -30
package/src/treeRootDataObject.ts +1 -1
package/src/types.ts +1 -1
package/api-report/fluid-static.legacy.alpha.api.md +0 -100

package/.mocharc.cjs CHANGED Viewed

@@ -7,6 +7,5 @@
 const getFluidTestMochaConfig = require("@fluid-internal/mocha-test-setup/mocharc-common");
-const packageDir = __dirname;
-const config = getFluidTestMochaConfig(packageDir);
+const config = getFluidTestMochaConfig(__dirname);
 module.exports = config;

package/CHANGELOG.md CHANGED Viewed

@@ -1,5 +1,9 @@
 # @fluidframework/fluid-static
+## 2.60.0
+Dependency updates only.
 ## 2.53.0
 Dependency updates only.

package/api-extractor.json CHANGED Viewed

@@ -1,4 +1,4 @@
 {
 	"$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-	"extends": "../../../common/build/build-common/api-extractor-base.esm.no-legacy.json"
+	"extends": "../../../common/build/build-common/api-extractor-model.esm.json"
 }

package/api-report/{fluid-static.alpha.api.md → fluid-static.legacy.beta.api.md} RENAMED Viewed

@@ -1,4 +1,4 @@
-## Alpha API Report File for "@fluidframework/fluid-static"
+## Beta API Report File for "@fluidframework/fluid-static"
 > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
@@ -16,7 +16,7 @@ export interface ContainerSchema {
     readonly initialObjects: Record<string, SharedObjectKind>;
 }
-// @alpha @legacy
+// @beta @legacy
 export function createTreeContainerRuntimeFactory(props: {
     readonly schema: TreeContainerSchema;
     readonly compatibilityMode: CompatibilityMode;
@@ -89,7 +89,7 @@ export type Myself<M extends IMember = IMember> = M & {
     readonly currentConnection: string;
 };
-// @alpha @legacy
+// @beta @legacy
 export interface TreeContainerSchema extends ContainerSchema {
     // (undocumented)
     readonly initialObjects: {

package/dist/legacy.d.ts CHANGED Viewed

@@ -15,7 +15,7 @@
  */
 export {
-	// @public APIs
+	// #region @public APIs
 	CompatibilityMode,
 	ContainerAttachProps,
 	ContainerSchema,
@@ -28,8 +28,10 @@ export {
 	InitialObjects,
 	MemberChangedListener,
 	Myself,
+	// #endregion
-	// @legacy APIs
+	// #region @legacyBeta APIs
 	TreeContainerSchema,
 	createTreeContainerRuntimeFactory
+	// #endregion
 } from "./index.js";

package/dist/public.d.ts CHANGED Viewed

@@ -15,7 +15,7 @@
  */
 export {
-	// @public APIs
+	// #region @public APIs
 	CompatibilityMode,
 	ContainerAttachProps,
 	ContainerSchema,
@@ -28,4 +28,5 @@ export {
 	InitialObjects,
 	MemberChangedListener,
 	Myself
+	// #endregion
 } from "./index.js";

package/dist/treeRootDataObject.d.ts CHANGED Viewed

@@ -15,7 +15,7 @@ import type { CompatibilityMode, TreeContainerSchema } from "./types.js";
  * The root data object's registry and shared objects are configured based on the provided
  * SharedTree and optionally data store registry.
  *
- * @legacy @alpha
+ * @legacy @beta
  */
 export declare function createTreeContainerRuntimeFactory(props: {
     /**

package/dist/treeRootDataObject.js CHANGED Viewed

@@ -142,7 +142,7 @@ class TreeRootDataObjectFactory extends internal_1.TreeDataObjectFactory {
  * The root data object's registry and shared objects are configured based on the provided
  * SharedTree and optionally data store registry.
  *
- * @legacy @alpha
+ * @legacy @beta
  */
 function createTreeContainerRuntimeFactory(props) {
     const { compatibilityMode, minVersionForCollabOverride, rootDataStoreRegistry, runtimeOptionOverrides, schema, } = props;

package/dist/treeRootDataObject.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"treeRootDataObject.js","sourceRoot":"","sources":["../src/treeRootDataObject.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;AAEH,gEAI2C;AAG3C,yEAIoD;AAUpD,kEAA6D;AAK7D,mFAAkF;AASlF,yCAQoB;AAEpB;;;;;;GAMG;AAEH;;;;;GAKG;AACH,MAAM,kBAAmB,SAAQ,yBAAc;IAC9C,YAAmB,KAAuB;QACzC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,IAAW,kBAAkB;QAC5B,OAAO,IAAI,CAAC;IACb,CAAC;IAED,sHAAsH;IACtH,yEAAyE;IACzE,IAAW,cAAc;QACxB,OAAO;YACN,IAAI,EAAE,IAAI,CAAC,IAAI;SACf,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,MAAM,CAAI,WAAgC;QACtD,MAAM,QAAQ,GAAG,WAAgE,CAAC;QAClF,IAAI,IAAA,2BAAgB,EAAC,QAAQ,CAAC,EAAE,CAAC;YAChC,OAAO,IAAA,2BAAgB,EAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACjD,CAAC;aAAM,IAAI,IAAA,6BAAkB,EAAC,QAAQ,CAAC,EAAE,CAAC;YACzC,OAAO,IAAA,6BAAkB,EAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACnD,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,wEAAwE,CAAC,CAAC;IAC3F,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,IAAqB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;CACD;AAED,MAAM,mBAAmB,GAAG,cAAc,CAAC;AAE3C;;;GAGG;AACH,MAAM,sBAAsB,GAAG,YAAY,CAAC;AAE5C,KAAK,UAAU,iBAAiB,CAC/B,gBAAmC;IAEnC,MAAM,UAAU,GAAG,MAAM,gBAAgB,CAAC,6BAA6B,CAAC,mBAAmB,CAAC,CAAC;IAC7F,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC9B,MAAM,IAAI,KAAK,CAAC,sBAAsB,mBAAmB,cAAc,CAAC,CAAC;IAC1E,CAAC;IACD,MAAM,kBAAkB,GAAI,CAAC,MAAM,UAAU,CAAC,GAAG,EAAE,CAAqC;SACtF,kBAAkB,CAAC;IACrB,IAAA,iBAAM,EACL,kBAAkB,KAAK,SAAS,EAChC,KAAK,CAAC,mDAAmD,CACzD,CAAC;IACF,OAAO,IAAA,0BAAe,EACrB;QACC,cAAc,EAAE,kBAAkB;QAClC,cAAc,EAAE,gBAA6C;KAC7D,EACD,mBAAmB,CACnB,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,2BAA4B,SAAQ,sCAA2B;IAIpE,YACC,iBAAoC,EACpC,yBAAoE,EACpE,SAGE;QAEF,KAAK,CAAC;YACL,eAAe,EAAE,CAAC,yBAAyB,CAAC,aAAa,CAAC;YAC1D,cAAc,EAAE;gBACf,GAAG,+DAA+B,CAAC,iBAAiB,CAAC;gBACrD,GAAG,SAAS,EAAE,cAAc;aAC5B;YACD,iBAAiB;YACjB,mBAAmB,EAClB,SAAS,EAAE,mBAAmB;gBAC9B,iDAAsC,CAAC,iBAAiB,CAAC;SAC1D,CAAC,CAAC;QArBJ,iCAAiC;QACxB,yEAAsE;QAqB9E,uBAAA,IAAI,0DAA8B,yBAAyB,MAAA,CAAC;IAC7D,CAAC;IAES,KAAK,CAAC,8BAA8B,CAAC,OAA0B;QACxE,sEAAsE;QACtE,MAAM,uBAAA,IAAI,8DAA2B,CAAC,kBAAkB,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;CACD;;AAED;;GAEG;AACH,MAAM,yBAA0B,SAAQ,gCAAyC;IAChF,YACC,gBAA4C,EAAE,EAC7B,iBAA0C;QAG3D,MAAM,IAAI,GAAS,UAAU,MAAM;YAClC,iEAAiE;YACjE,OAAO,IAAI,kBAAkB,CAAC;gBAC7B,GAAG,MAAM;gBACT,8CAA8C;aAC9C,CAAC,CAAC;QACJ,CAAoB,CAAC;QAErB,uGAAuG;QACvG,+GAA+G;QAC/G,KAAK,CAAC;YACL,IAAI,EAAE,sBAAsB;YAC5B,IAAI;YACJ,aAAa;SACb,CAAC,CAAC;QAjBc,sBAAiB,GAAjB,iBAAiB,CAAyB;IAkB5D,CAAC;IAED,IAAW,uBAAuB;QACjC,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAC/B,CAAC;CACD;AAED;;;;;;;;;;GAUG;AACH,SAAgB,iCAAiC,CAAC,KA2BjD;IACA,MAAM,EACL,iBAAiB,EACjB,2BAA2B,EAC3B,qBAAqB,EACrB,sBAAsB,EACtB,MAAM,GACN,GAAG,KAAK,CAAC;IAEV,MAAM,CAAC,eAAe,EAAE,aAAa,CAAC,GAAG,IAAA,4CAAiC,EAAC,MAAM,CAAC,CAAC;IACnF,MAAM,QAAQ,GAAG,qBAAqB,IAAI,IAAI,iCAAsB,CAAC,eAAe,CAAC,CAAC;IAEtF,OAAO,IAAI,2BAA2B,CACrC,iBAAiB,EACjB,IAAI,yBAAyB,CAAC,aAAa,EAAE,QAAQ,CAAC,EACtD;QACC,cAAc,EAAE,sBAAsB;QACtC,mBAAmB,EAAE,2BAA2B;KAChD,CACD,CAAC;AACH,CAAC;AA/CD,8EA+CC","sourcesContent":["/!\n Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n /\n\nimport {\n\tBaseContainerRuntimeFactory,\n\tTreeDataObject,\n\tTreeDataObjectFactory,\n} from \"@fluidframework/aqueduct/internal\";\nimport type { IDataObjectProps } from \"@fluidframework/aqueduct/internal\";\nimport type { IRuntimeFactory } from \"@fluidframework/container-definitions/internal\";\nimport {\n\tFluidDataStoreRegistry,\n\ttype IContainerRuntimeOptions,\n\ttype MinimumVersionForCollab,\n} from \"@fluidframework/container-runtime/internal\";\nimport type {\n\tIContainerRuntime,\n\tIContainerRuntimeInternal,\n} from \"@fluidframework/container-runtime-definitions/internal\";\nimport type {\n\tFluidObject,\n\tIFluidHandle,\n\tIFluidLoadable,\n} from \"@fluidframework/core-interfaces\";\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport type { IChannelFactory } from \"@fluidframework/datastore-definitions/internal\";\nimport type { IFluidDataStoreRegistry } from \"@fluidframework/runtime-definitions/internal\";\nimport type { SharedObjectKind } from \"@fluidframework/shared-object-base/internal\";\n\nimport { compatibilityModeRuntimeOptions } from \"./compatibilityConfiguration.js\";\nimport type {\n\tCompatibilityMode,\n\tIRootDataObject,\n\tIStaticEntryPoint,\n\tLoadableObjectKind,\n\tLoadableObjectRecord,\n\tTreeContainerSchema,\n} from \"./types.js\";\nimport {\n\tcompatibilityModeToMinVersionForCollab,\n\tcreateDataObject,\n\tcreateSharedObject,\n\tisDataObjectKind,\n\tisSharedObjectKind,\n\tmakeFluidObject,\n\tparseDataObjectsFromSharedObjects,\n} from \"./utils.js\";\n\n/\n This module contains types and factories for creating tree-based root data objects.\n * They exist as an alternative to the APIs in `rootDataObject.ts`.\n \n These APIs are currently shaped to parallel `RootDataObject`, but this is not intended as the long-term design.\n * The current shape is a short-term solution to allow for easier migration from the old APIs.\n /\n\n/\n The entry-point/root collaborative object of the {@link IFluidContainer \| Fluid Container}.\n \n @remarks\n * Abstracts the dynamic code required to build a Fluid Container into a static representation for end customers.\n /\nclass TreeRootDataObject extends TreeDataObject implements IRootDataObject {\n\tpublic constructor(props: IDataObjectProps) {\n\t\tsuper(props);\n\t}\n\n\tpublic get TreeRootDataObject(): TreeRootDataObject {\n\t\treturn this;\n\t}\n\n\t// TODO: longer term, it would be better to not have to fit into the `initialObjects` model for tree-based containers.\n\t// But in the short term, fitting into this model makes migration easier.\n\tpublic get initialObjects(): LoadableObjectRecord {\n\t\treturn {\n\t\t\ttree: this.tree,\n\t\t};\n\t}\n\n\tpublic async create<T>(objectClass: SharedObjectKind<T>): Promise<T> {\n\t\tconst internal = objectClass as unknown as LoadableObjectKind<T & IFluidLoadable>;\n\t\tif (isDataObjectKind(internal)) {\n\t\t\treturn createDataObject(internal, this.context);\n\t\t} else if (isSharedObjectKind(internal)) {\n\t\t\treturn createSharedObject(internal, this.runtime);\n\t\t}\n\t\tthrow new Error(\"Could not create new Fluid object because an unknown object was passed\");\n\t}\n\n\tpublic async uploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>> {\n\t\treturn this.runtime.uploadBlob(blob);\n\t}\n}\n\nconst treeRootDataStoreId = \"treeRootDOId\";\n\n/\n Type of the {@link TreeRootDataObject}.\n * @remarks Used in the PureDataObjectFactory to create the root data object.\n /\nconst treeRootDataObjectType = \"treeRootDO\";\n\nasync function provideEntryPoint(\n\tcontainerRuntime: IContainerRuntime,\n): Promise<IStaticEntryPoint> {\n\tconst entryPoint = await containerRuntime.getAliasedDataStoreEntryPoint(treeRootDataStoreId);\n\tif (entryPoint === undefined) {\n\t\tthrow new Error(`default dataStore [${treeRootDataStoreId}] must exist`);\n\t}\n\tconst treeRootDataObject = ((await entryPoint.get()) as FluidObject<TreeRootDataObject>)\n\t\t.TreeRootDataObject;\n\tassert(\n\t\ttreeRootDataObject !== undefined,\n\t\t0xbe7 / entryPoint must be of type TreeRootDataObject /,\n\t);\n\treturn makeFluidObject<IStaticEntryPoint>(\n\t\t{\n\t\t\trootDataObject: treeRootDataObject,\n\t\t\textensionStore: containerRuntime as IContainerRuntimeInternal,\n\t\t},\n\t\t\"IStaticEntryPoint\",\n\t);\n}\n\n/\n Factory for Container Runtime instances that provide a {@link IStaticEntryPoint}\n * (containing single {@link IRootDataObject}) as their entry point.\n /\nclass TreeContainerRuntimeFactory extends BaseContainerRuntimeFactory {\n\t// TODO: use for runtime factory.\n\treadonly #treeRootDataObjectFactory: TreeDataObjectFactory<TreeRootDataObject>;\n\n\tpublic constructor(\n\t\tcompatibilityMode: CompatibilityMode,\n\t\ttreeRootDataObjectFactory: TreeDataObjectFactory<TreeRootDataObject>,\n\t\toverrides?: Partial<{\n\t\t\truntimeOptions: Partial<IContainerRuntimeOptions>;\n\t\t\tminVersionForCollab: MinimumVersionForCollab;\n\t\t}>,\n\t) {\n\t\tsuper({\n\t\t\tregistryEntries: [treeRootDataObjectFactory.registryEntry],\n\t\t\truntimeOptions: {\n\t\t\t\t...compatibilityModeRuntimeOptions[compatibilityMode],\n\t\t\t\t...overrides?.runtimeOptions,\n\t\t\t},\n\t\t\tprovideEntryPoint,\n\t\t\tminVersionForCollab:\n\t\t\t\toverrides?.minVersionForCollab ??\n\t\t\t\tcompatibilityModeToMinVersionForCollab[compatibilityMode],\n\t\t});\n\t\tthis.#treeRootDataObjectFactory = treeRootDataObjectFactory;\n\t}\n\n\tprotected async containerInitializingFirstTime(runtime: IContainerRuntime): Promise<void> {\n\t\t// The first time we create the container we create the RootDataObject\n\t\tawait this.#treeRootDataObjectFactory.createRootInstance(treeRootDataStoreId, runtime);\n\t}\n}\n\n/\n Factory that creates instances of a tree-based root data object.\n /\nclass TreeRootDataObjectFactory extends TreeDataObjectFactory<TreeRootDataObject> {\n\tpublic constructor(\n\t\tsharedObjects: readonly IChannelFactory[] = [],\n\t\tprivate readonly dataStoreRegistry: IFluidDataStoreRegistry,\n\t) {\n\t\ttype Ctor = new (props: IDataObjectProps) => TreeRootDataObject;\n\t\tconst ctor: Ctor = function (_props) {\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-argument\n\t\t\treturn new TreeRootDataObject({\n\t\t\t\t..._props,\n\t\t\t\t// Add any additional injected properties here\n\t\t\t});\n\t\t} as unknown as Ctor;\n\n\t\t// Note: we're not specifying registry entries to the base class, so it won't create a registry itself,\n\t\t// and instead we override the necessary methods in this class to use the registry received in the constructor.\n\t\tsuper({\n\t\t\ttype: treeRootDataObjectType,\n\t\t\tctor,\n\t\t\tsharedObjects,\n\t\t});\n\t}\n\n\tpublic get IFluidDataStoreRegistry(): IFluidDataStoreRegistry {\n\t\treturn this.dataStoreRegistry;\n\t}\n}\n\n/\n Creates an {@link @fluidframework/aqueduct#IRuntimeFactory} which constructs containers\n * with an entry point containing single tree-based root data object.\n \n @remarks\n * The entry point is opaque to caller.\n * The root data object's registry and shared objects are configured based on the provided\n * SharedTree and optionally data store registry.\n \n @legacy @alpha\n /\nexport function createTreeContainerRuntimeFactory(props: {\n\t/\n\t The schema for the container.\n\t /\n\treadonly schema: TreeContainerSchema;\n\n\t/\n\t See {@link CompatibilityMode} and compatibilityModeRuntimeOptions for more details.\n\t /\n\treadonly compatibilityMode: CompatibilityMode;\n\t/\n\t Optional registry of data stores to pass to the DataObject factory.\n\t * If not provided, one will be created based on the schema.\n\t /\n\treadonly rootDataStoreRegistry?: IFluidDataStoreRegistry;\n\t/\n\t Optional overrides for the container runtime options.\n\t * If not provided, only the default options for the given compatibilityMode will be used.\n\t /\n\treadonly runtimeOptionOverrides?: Partial<IContainerRuntimeOptions>;\n\t/\n\t Optional override for minimum version for collab.\n\t * If not provided, the default for the given compatibilityMode will be used.\n\t * @remarks\n\t * This is useful when runtime options are overridden and change the minimum version for collab.\n\t */\n\treadonly minVersionForCollabOverride?: MinimumVersionForCollab;\n}): IRuntimeFactory {\n\tconst {\n\t\tcompatibilityMode,\n\t\tminVersionForCollabOverride,\n\t\trootDataStoreRegistry,\n\t\truntimeOptionOverrides,\n\t\tschema,\n\t} = props;\n\n\tconst [registryEntries, sharedObjects] = parseDataObjectsFromSharedObjects(schema);\n\tconst registry = rootDataStoreRegistry ?? new FluidDataStoreRegistry(registryEntries);\n\n\treturn new TreeContainerRuntimeFactory(\n\t\tcompatibilityMode,\n\t\tnew TreeRootDataObjectFactory(sharedObjects, registry),\n\t\t{\n\t\t\truntimeOptions: runtimeOptionOverrides,\n\t\t\tminVersionForCollab: minVersionForCollabOverride,\n\t\t},\n\t);\n}\n"]}
1	+ {"version":3,"file":"treeRootDataObject.js","sourceRoot":"","sources":["../src/treeRootDataObject.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;AAEH,gEAI2C;AAG3C,yEAIoD;AAUpD,kEAA6D;AAK7D,mFAAkF;AASlF,yCAQoB;AAEpB;;;;;;GAMG;AAEH;;;;;GAKG;AACH,MAAM,kBAAmB,SAAQ,yBAAc;IAC9C,YAAmB,KAAuB;QACzC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,IAAW,kBAAkB;QAC5B,OAAO,IAAI,CAAC;IACb,CAAC;IAED,sHAAsH;IACtH,yEAAyE;IACzE,IAAW,cAAc;QACxB,OAAO;YACN,IAAI,EAAE,IAAI,CAAC,IAAI;SACf,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,MAAM,CAAI,WAAgC;QACtD,MAAM,QAAQ,GAAG,WAAgE,CAAC;QAClF,IAAI,IAAA,2BAAgB,EAAC,QAAQ,CAAC,EAAE,CAAC;YAChC,OAAO,IAAA,2BAAgB,EAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACjD,CAAC;aAAM,IAAI,IAAA,6BAAkB,EAAC,QAAQ,CAAC,EAAE,CAAC;YACzC,OAAO,IAAA,6BAAkB,EAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACnD,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,wEAAwE,CAAC,CAAC;IAC3F,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,IAAqB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;CACD;AAED,MAAM,mBAAmB,GAAG,cAAc,CAAC;AAE3C;;;GAGG;AACH,MAAM,sBAAsB,GAAG,YAAY,CAAC;AAE5C,KAAK,UAAU,iBAAiB,CAC/B,gBAAmC;IAEnC,MAAM,UAAU,GAAG,MAAM,gBAAgB,CAAC,6BAA6B,CAAC,mBAAmB,CAAC,CAAC;IAC7F,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC9B,MAAM,IAAI,KAAK,CAAC,sBAAsB,mBAAmB,cAAc,CAAC,CAAC;IAC1E,CAAC;IACD,MAAM,kBAAkB,GAAI,CAAC,MAAM,UAAU,CAAC,GAAG,EAAE,CAAqC;SACtF,kBAAkB,CAAC;IACrB,IAAA,iBAAM,EACL,kBAAkB,KAAK,SAAS,EAChC,KAAK,CAAC,mDAAmD,CACzD,CAAC;IACF,OAAO,IAAA,0BAAe,EACrB;QACC,cAAc,EAAE,kBAAkB;QAClC,cAAc,EAAE,gBAA6C;KAC7D,EACD,mBAAmB,CACnB,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,2BAA4B,SAAQ,sCAA2B;IAIpE,YACC,iBAAoC,EACpC,yBAAoE,EACpE,SAGE;QAEF,KAAK,CAAC;YACL,eAAe,EAAE,CAAC,yBAAyB,CAAC,aAAa,CAAC;YAC1D,cAAc,EAAE;gBACf,GAAG,+DAA+B,CAAC,iBAAiB,CAAC;gBACrD,GAAG,SAAS,EAAE,cAAc;aAC5B;YACD,iBAAiB;YACjB,mBAAmB,EAClB,SAAS,EAAE,mBAAmB;gBAC9B,iDAAsC,CAAC,iBAAiB,CAAC;SAC1D,CAAC,CAAC;QArBJ,iCAAiC;QACxB,yEAAsE;QAqB9E,uBAAA,IAAI,0DAA8B,yBAAyB,MAAA,CAAC;IAC7D,CAAC;IAES,KAAK,CAAC,8BAA8B,CAAC,OAA0B;QACxE,sEAAsE;QACtE,MAAM,uBAAA,IAAI,8DAA2B,CAAC,kBAAkB,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;CACD;;AAED;;GAEG;AACH,MAAM,yBAA0B,SAAQ,gCAAyC;IAChF,YACC,gBAA4C,EAAE,EAC7B,iBAA0C;QAG3D,MAAM,IAAI,GAAS,UAAU,MAAM;YAClC,iEAAiE;YACjE,OAAO,IAAI,kBAAkB,CAAC;gBAC7B,GAAG,MAAM;gBACT,8CAA8C;aAC9C,CAAC,CAAC;QACJ,CAAoB,CAAC;QAErB,uGAAuG;QACvG,+GAA+G;QAC/G,KAAK,CAAC;YACL,IAAI,EAAE,sBAAsB;YAC5B,IAAI;YACJ,aAAa;SACb,CAAC,CAAC;QAjBc,sBAAiB,GAAjB,iBAAiB,CAAyB;IAkB5D,CAAC;IAED,IAAW,uBAAuB;QACjC,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAC/B,CAAC;CACD;AAED;;;;;;;;;;GAUG;AACH,SAAgB,iCAAiC,CAAC,KA2BjD;IACA,MAAM,EACL,iBAAiB,EACjB,2BAA2B,EAC3B,qBAAqB,EACrB,sBAAsB,EACtB,MAAM,GACN,GAAG,KAAK,CAAC;IAEV,MAAM,CAAC,eAAe,EAAE,aAAa,CAAC,GAAG,IAAA,4CAAiC,EAAC,MAAM,CAAC,CAAC;IACnF,MAAM,QAAQ,GAAG,qBAAqB,IAAI,IAAI,iCAAsB,CAAC,eAAe,CAAC,CAAC;IAEtF,OAAO,IAAI,2BAA2B,CACrC,iBAAiB,EACjB,IAAI,yBAAyB,CAAC,aAAa,EAAE,QAAQ,CAAC,EACtD;QACC,cAAc,EAAE,sBAAsB;QACtC,mBAAmB,EAAE,2BAA2B;KAChD,CACD,CAAC;AACH,CAAC;AA/CD,8EA+CC","sourcesContent":["/!\n Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n /\n\nimport {\n\tBaseContainerRuntimeFactory,\n\tTreeDataObject,\n\tTreeDataObjectFactory,\n} from \"@fluidframework/aqueduct/internal\";\nimport type { IDataObjectProps } from \"@fluidframework/aqueduct/internal\";\nimport type { IRuntimeFactory } from \"@fluidframework/container-definitions/internal\";\nimport {\n\tFluidDataStoreRegistry,\n\ttype IContainerRuntimeOptions,\n\ttype MinimumVersionForCollab,\n} from \"@fluidframework/container-runtime/internal\";\nimport type {\n\tIContainerRuntime,\n\tIContainerRuntimeInternal,\n} from \"@fluidframework/container-runtime-definitions/internal\";\nimport type {\n\tFluidObject,\n\tIFluidHandle,\n\tIFluidLoadable,\n} from \"@fluidframework/core-interfaces\";\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport type { IChannelFactory } from \"@fluidframework/datastore-definitions/internal\";\nimport type { IFluidDataStoreRegistry } from \"@fluidframework/runtime-definitions/internal\";\nimport type { SharedObjectKind } from \"@fluidframework/shared-object-base/internal\";\n\nimport { compatibilityModeRuntimeOptions } from \"./compatibilityConfiguration.js\";\nimport type {\n\tCompatibilityMode,\n\tIRootDataObject,\n\tIStaticEntryPoint,\n\tLoadableObjectKind,\n\tLoadableObjectRecord,\n\tTreeContainerSchema,\n} from \"./types.js\";\nimport {\n\tcompatibilityModeToMinVersionForCollab,\n\tcreateDataObject,\n\tcreateSharedObject,\n\tisDataObjectKind,\n\tisSharedObjectKind,\n\tmakeFluidObject,\n\tparseDataObjectsFromSharedObjects,\n} from \"./utils.js\";\n\n/\n This module contains types and factories for creating tree-based root data objects.\n * They exist as an alternative to the APIs in `rootDataObject.ts`.\n \n These APIs are currently shaped to parallel `RootDataObject`, but this is not intended as the long-term design.\n * The current shape is a short-term solution to allow for easier migration from the old APIs.\n /\n\n/\n The entry-point/root collaborative object of the {@link IFluidContainer \| Fluid Container}.\n \n @remarks\n * Abstracts the dynamic code required to build a Fluid Container into a static representation for end customers.\n /\nclass TreeRootDataObject extends TreeDataObject implements IRootDataObject {\n\tpublic constructor(props: IDataObjectProps) {\n\t\tsuper(props);\n\t}\n\n\tpublic get TreeRootDataObject(): TreeRootDataObject {\n\t\treturn this;\n\t}\n\n\t// TODO: longer term, it would be better to not have to fit into the `initialObjects` model for tree-based containers.\n\t// But in the short term, fitting into this model makes migration easier.\n\tpublic get initialObjects(): LoadableObjectRecord {\n\t\treturn {\n\t\t\ttree: this.tree,\n\t\t};\n\t}\n\n\tpublic async create<T>(objectClass: SharedObjectKind<T>): Promise<T> {\n\t\tconst internal = objectClass as unknown as LoadableObjectKind<T & IFluidLoadable>;\n\t\tif (isDataObjectKind(internal)) {\n\t\t\treturn createDataObject(internal, this.context);\n\t\t} else if (isSharedObjectKind(internal)) {\n\t\t\treturn createSharedObject(internal, this.runtime);\n\t\t}\n\t\tthrow new Error(\"Could not create new Fluid object because an unknown object was passed\");\n\t}\n\n\tpublic async uploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>> {\n\t\treturn this.runtime.uploadBlob(blob);\n\t}\n}\n\nconst treeRootDataStoreId = \"treeRootDOId\";\n\n/\n Type of the {@link TreeRootDataObject}.\n * @remarks Used in the PureDataObjectFactory to create the root data object.\n /\nconst treeRootDataObjectType = \"treeRootDO\";\n\nasync function provideEntryPoint(\n\tcontainerRuntime: IContainerRuntime,\n): Promise<IStaticEntryPoint> {\n\tconst entryPoint = await containerRuntime.getAliasedDataStoreEntryPoint(treeRootDataStoreId);\n\tif (entryPoint === undefined) {\n\t\tthrow new Error(`default dataStore [${treeRootDataStoreId}] must exist`);\n\t}\n\tconst treeRootDataObject = ((await entryPoint.get()) as FluidObject<TreeRootDataObject>)\n\t\t.TreeRootDataObject;\n\tassert(\n\t\ttreeRootDataObject !== undefined,\n\t\t0xbe7 / entryPoint must be of type TreeRootDataObject /,\n\t);\n\treturn makeFluidObject<IStaticEntryPoint>(\n\t\t{\n\t\t\trootDataObject: treeRootDataObject,\n\t\t\textensionStore: containerRuntime as IContainerRuntimeInternal,\n\t\t},\n\t\t\"IStaticEntryPoint\",\n\t);\n}\n\n/\n Factory for Container Runtime instances that provide a {@link IStaticEntryPoint}\n * (containing single {@link IRootDataObject}) as their entry point.\n /\nclass TreeContainerRuntimeFactory extends BaseContainerRuntimeFactory {\n\t// TODO: use for runtime factory.\n\treadonly #treeRootDataObjectFactory: TreeDataObjectFactory<TreeRootDataObject>;\n\n\tpublic constructor(\n\t\tcompatibilityMode: CompatibilityMode,\n\t\ttreeRootDataObjectFactory: TreeDataObjectFactory<TreeRootDataObject>,\n\t\toverrides?: Partial<{\n\t\t\truntimeOptions: Partial<IContainerRuntimeOptions>;\n\t\t\tminVersionForCollab: MinimumVersionForCollab;\n\t\t}>,\n\t) {\n\t\tsuper({\n\t\t\tregistryEntries: [treeRootDataObjectFactory.registryEntry],\n\t\t\truntimeOptions: {\n\t\t\t\t...compatibilityModeRuntimeOptions[compatibilityMode],\n\t\t\t\t...overrides?.runtimeOptions,\n\t\t\t},\n\t\t\tprovideEntryPoint,\n\t\t\tminVersionForCollab:\n\t\t\t\toverrides?.minVersionForCollab ??\n\t\t\t\tcompatibilityModeToMinVersionForCollab[compatibilityMode],\n\t\t});\n\t\tthis.#treeRootDataObjectFactory = treeRootDataObjectFactory;\n\t}\n\n\tprotected async containerInitializingFirstTime(runtime: IContainerRuntime): Promise<void> {\n\t\t// The first time we create the container we create the RootDataObject\n\t\tawait this.#treeRootDataObjectFactory.createRootInstance(treeRootDataStoreId, runtime);\n\t}\n}\n\n/\n Factory that creates instances of a tree-based root data object.\n /\nclass TreeRootDataObjectFactory extends TreeDataObjectFactory<TreeRootDataObject> {\n\tpublic constructor(\n\t\tsharedObjects: readonly IChannelFactory[] = [],\n\t\tprivate readonly dataStoreRegistry: IFluidDataStoreRegistry,\n\t) {\n\t\ttype Ctor = new (props: IDataObjectProps) => TreeRootDataObject;\n\t\tconst ctor: Ctor = function (_props) {\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-argument\n\t\t\treturn new TreeRootDataObject({\n\t\t\t\t..._props,\n\t\t\t\t// Add any additional injected properties here\n\t\t\t});\n\t\t} as unknown as Ctor;\n\n\t\t// Note: we're not specifying registry entries to the base class, so it won't create a registry itself,\n\t\t// and instead we override the necessary methods in this class to use the registry received in the constructor.\n\t\tsuper({\n\t\t\ttype: treeRootDataObjectType,\n\t\t\tctor,\n\t\t\tsharedObjects,\n\t\t});\n\t}\n\n\tpublic get IFluidDataStoreRegistry(): IFluidDataStoreRegistry {\n\t\treturn this.dataStoreRegistry;\n\t}\n}\n\n/\n Creates an {@link @fluidframework/aqueduct#IRuntimeFactory} which constructs containers\n * with an entry point containing single tree-based root data object.\n \n @remarks\n * The entry point is opaque to caller.\n * The root data object's registry and shared objects are configured based on the provided\n * SharedTree and optionally data store registry.\n \n @legacy @beta\n /\nexport function createTreeContainerRuntimeFactory(props: {\n\t/\n\t The schema for the container.\n\t /\n\treadonly schema: TreeContainerSchema;\n\n\t/\n\t See {@link CompatibilityMode} and compatibilityModeRuntimeOptions for more details.\n\t /\n\treadonly compatibilityMode: CompatibilityMode;\n\t/\n\t Optional registry of data stores to pass to the DataObject factory.\n\t * If not provided, one will be created based on the schema.\n\t /\n\treadonly rootDataStoreRegistry?: IFluidDataStoreRegistry;\n\t/\n\t Optional overrides for the container runtime options.\n\t * If not provided, only the default options for the given compatibilityMode will be used.\n\t /\n\treadonly runtimeOptionOverrides?: Partial<IContainerRuntimeOptions>;\n\t/\n\t Optional override for minimum version for collab.\n\t * If not provided, the default for the given compatibilityMode will be used.\n\t * @remarks\n\t * This is useful when runtime options are overridden and change the minimum version for collab.\n\t */\n\treadonly minVersionForCollabOverride?: MinimumVersionForCollab;\n}): IRuntimeFactory {\n\tconst {\n\t\tcompatibilityMode,\n\t\tminVersionForCollabOverride,\n\t\trootDataStoreRegistry,\n\t\truntimeOptionOverrides,\n\t\tschema,\n\t} = props;\n\n\tconst [registryEntries, sharedObjects] = parseDataObjectsFromSharedObjects(schema);\n\tconst registry = rootDataStoreRegistry ?? new FluidDataStoreRegistry(registryEntries);\n\n\treturn new TreeContainerRuntimeFactory(\n\t\tcompatibilityMode,\n\t\tnew TreeRootDataObjectFactory(sharedObjects, registry),\n\t\t{\n\t\t\truntimeOptions: runtimeOptionOverrides,\n\t\t\tminVersionForCollab: minVersionForCollabOverride,\n\t\t},\n\t);\n}\n"]}

package/dist/types.d.ts CHANGED Viewed

@@ -91,7 +91,7 @@ export interface ContainerSchema {
  * It includes both the kind of `SharedTree` that will be initially available upon `Container` creation, as well
  * as the types of objects that may be dynamically created throughout the lifetime of the `Container`.
  *
- * @legacy @alpha
+ * @legacy @beta
  */
 export interface TreeContainerSchema extends ContainerSchema {
     readonly initialObjects: {

package/dist/types.js.map CHANGED Viewed

	@@ -1 +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 type { DataObjectKind } from \"@fluidframework/aqueduct/internal\";\nimport type { ContainerExtensionStore } from \"@fluidframework/container-runtime-definitions/internal\";\nimport type {\n\tIEvent,\n\tIEventProvider,\n\tIFluidHandle,\n\tIFluidLoadable,\n} from \"@fluidframework/core-interfaces\";\nimport type {\n\tISharedObjectKind,\n\tSharedObjectKind,\n} from \"@fluidframework/shared-object-base/internal\";\nimport type { ITree } from \"@fluidframework/tree\";\n\n/\n Determines the set of runtime options that Fluid Framework will use when running.\n * In \"1\" mode we support full interop between 2.x clients and 1.x clients,\n * while in \"2\" mode we only support interop between 2.x clients.\n \n @public\n /\nexport type CompatibilityMode = \"1\" \| \"2\";\n\n/\n A mapping of string identifiers to instantiated `DataObject`s or `SharedObject`s.\n /\nexport type LoadableObjectRecord = Record<string, IFluidLoadable>;\n\n/\n A mapping of string identifiers to classes that will later be used to instantiate a corresponding `DataObject`\n * or `SharedObject`.\n /\nexport type LoadableObjectKindRecord = Record<string, SharedObjectKind>;\n\n/\n A kind of `DataObject` or `SharedObject`.\n \n @typeParam T - The kind of `DataObject` or `SharedObject`.\n \n @privateRemarks\n * There are some edge cases in TypeScript where the order of the members in a union matter.\n * Once such edge case is when multiple members of a generic union partially match, and the type parameter is being inferred.\n * In this case, its better to have the desired match and/or the simpler type first.\n * In this case placing ISharedObjectKind fixed one usage and didn't break anything, and generally seems more likely to work than the reverse, so this is the order being used.\n * This is likely (a bug in TypeScript)[https://github.com/microsoft/TypeScript/issues/45809].\n /\nexport type LoadableObjectKind<T extends IFluidLoadable = IFluidLoadable> =\n\t\| ISharedObjectKind<T>\n\t\| DataObjectKind<T>;\n\n/\n Represents properties that can be attached to a container.\n * @public\n /\nexport type ContainerAttachProps<T = unknown> = T;\n\n/\n Declares the Fluid objects that will be available in the {@link IFluidContainer \| Container}.\n \n @remarks\n \n It includes both the instances of objects that are initially available upon `Container` creation, as well\n * as the types of objects that may be dynamically created throughout the lifetime of the `Container`.\n * @public\n /\nexport interface ContainerSchema {\n\t/\n\t Defines loadable objects that will be created when the {@link IFluidContainer \| Container} is first created.\n\t \n\t @remarks It uses the key as the id and the value as the loadable object to create.\n\t \n\t @example\n\t \n\t In the example below two objects will be created when the `Container` is first\n\t * created. One with id \"map1\" that will return a `SharedMap` and the other with\n\t * id \"pair1\" that will return a `KeyValueDataObject`.\n\t \n\t ```typescript\n\t * {\n\t * map1: SharedMap,\n\t * pair1: KeyValueDataObject,\n\t * }\n\t * ```\n\t /\n\treadonly initialObjects: Record<string, SharedObjectKind>;\n\n\t/\n\t Loadable objects that can be created after the initial {@link IFluidContainer \| Container} creation.\n\t \n\t @remarks\n\t \n\t Types defined in `initialObjects` will always be available and are not required to be provided here.\n\t \n\t For best practice it's recommended to define all the dynamic types you create even if they are\n\t * included via initialObjects.\n\t /\n\treadonly dynamicObjectTypes?: readonly SharedObjectKind[];\n}\n\n/\n Declares the Fluid objects that will be available in the {@link IFluidContainer \| Container}.\n \n @remarks\n \n It includes both the kind of `SharedTree` that will be initially available upon `Container` creation, as well\n * as the types of objects that may be dynamically created throughout the lifetime of the `Container`.\n \n @legacy @~~alpha~~\n /\nexport interface TreeContainerSchema extends ContainerSchema {\n\t// TODO: longer term, it would be better to not have to fit into the `initialObjects` model for tree-based containers.\n\t// But in the short term, fitting into this model makes migration easier.\n\treadonly initialObjects: {\n\t\treadonly tree: SharedObjectKind<ITree>;\n\t};\n}\n\n/\n Holds the collection of objects that the container was initially created with.\n * Additionally provides the ability to dynamically create further objects during usage.\n /\nexport interface IRootDataObject {\n\t/\n\t Dynamically creates a new detached collaborative object (DDS/DataObject).\n\t \n\t @param objectClass - Type of the collaborative object to be created.\n\t \n\t @typeParam T - The class of the `DataObject` or `SharedObject`.\n\t /\n\tcreate<T>(objectClass: SharedObjectKind<T>): Promise<T>;\n\n\t/\n\t Upload a blob of data.\n\t * Although it is marked as internal, there is external usage of this function for experimental purposes.\n\t * Please contact yunho-microsoft or vladsud if you need to change it.\n\t * @param blob - blob to be uploaded.\n\t \n\t @remarks This method is used to expose uploadBlob to the IFluidContainer level. UploadBlob will upload data to server side (as of now, ODSP only). There is no downloadBlob provided as it is not needed(blob lifetime managed by server).\n\t /\n\tuploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>>;\n\n\t/\n\t Provides a record of the initial objects defined on creation.\n\t /\n\treadonly initialObjects: LoadableObjectRecord;\n}\n\ninterface IProvideStaticEntryPoint {\n\treadonly IStaticEntryPoint: IStaticEntryPoint;\n}\n\n/\n This is the internal entry point fluid-static creates.\n /\nexport interface IStaticEntryPoint extends IProvideStaticEntryPoint {\n\treadonly rootDataObject: IRootDataObject;\n\treadonly extensionStore: ContainerExtensionStore;\n}\n\n/\n Signature for {@link IMember} change events.\n \n @param clientId - A unique identifier for the client.\n * @param member - The service-specific member object for the client.\n \n @see See {@link IServiceAudienceEvents} for usage details.\n * @public\n /\nexport type MemberChangedListener<M extends IMember> = (clientId: string, member: M) => void;\n\n/\n Events that trigger when the roster of members in the Fluid session change.\n \n @remarks\n \n Only changes that would be reflected in the returned map of {@link IServiceAudience}'s\n * {@link IServiceAudience.getMembers} method will emit events.\n \n @typeParam M - A service-specific {@link IMember} implementation.\n * @public\n /\nexport interface IServiceAudienceEvents<M extends IMember> extends IEvent {\n\t/\n\t Emitted when a {@link IMember \| member}(s) are either added or removed.\n\t \n\t @eventProperty\n\t /\n\t(event: \"membersChanged\", listener: () => void): void;\n\n\t/\n\t Emitted when a {@link IMember \| member} joins the audience.\n\t \n\t @eventProperty\n\t /\n\t(event: \"memberAdded\", listener: MemberChangedListener<M>): void;\n\n\t/\n\t Emitted when a {@link IMember \| member} leaves the audience.\n\t \n\t @eventProperty\n\t /\n\t(event: \"memberRemoved\", listener: MemberChangedListener<M>): void;\n}\n\n/\n Base interface to be implemented to fetch each service's audience.\n \n @remarks\n \n The type parameter `M` allows consumers to further extend the client object with service-specific\n * details about the connecting client, such as device information, environment, or a username.\n \n @typeParam M - A service-specific {@link IMember} type.\n * @public\n /\nexport interface IServiceAudience<M extends IMember>\n\textends IEventProvider<IServiceAudienceEvents<M>> {\n\t/\n\t Returns an map of all users currently in the Fluid session where key is the userId and the value is the\n\t * member object. The implementation may choose to exclude certain connections from the returned map.\n\t * E.g. ServiceAudience excludes non-interactive connections to represent only the roster of live users.\n\t /\n\tgetMembers(): ReadonlyMap<string, M>;\n\n\t/\n\t Returns the current active user on this client once they are connected. Otherwise, returns undefined.\n\t /\n\tgetMyself(): Myself<M> \| undefined;\n}\n\n/\n Base interface for information for each connection made to the Fluid session.\n \n @remarks This interface can be extended to provide additional information specific to each service.\n * @public\n /\nexport interface IConnection {\n\t/\n\t A unique ID for the connection. A single user may have multiple connections, each with a different ID.\n\t /\n\treadonly id: string;\n\n\t/\n\t Whether the connection is in read or read/write mode.\n\t /\n\treadonly mode: \"write\" \| \"read\";\n}\n\n/\n Base interface to be implemented to fetch each service's member.\n \n @remarks This interface can be extended by each service to provide additional service-specific user metadata.\n * @public\n /\nexport interface IMember {\n\t/\n\t An ID for the user, unique among each individual user connecting to the session.\n\t /\n\treadonly id: string;\n\n\t/\n\t The set of connections the user has made, e.g. from multiple tabs or devices.\n\t /\n\treadonly connections: IConnection[];\n}\n\n/\n An extended member object that includes currentConnection\n * @public\n */\nexport type Myself<M extends IMember = IMember> = M & { readonly currentConnection: string };\n"]}
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 type { DataObjectKind } from \"@fluidframework/aqueduct/internal\";\nimport type { ContainerExtensionStore } from \"@fluidframework/container-runtime-definitions/internal\";\nimport type {\n\tIEvent,\n\tIEventProvider,\n\tIFluidHandle,\n\tIFluidLoadable,\n} from \"@fluidframework/core-interfaces\";\nimport type {\n\tISharedObjectKind,\n\tSharedObjectKind,\n} from \"@fluidframework/shared-object-base/internal\";\nimport type { ITree } from \"@fluidframework/tree\";\n\n/\n Determines the set of runtime options that Fluid Framework will use when running.\n * In \"1\" mode we support full interop between 2.x clients and 1.x clients,\n * while in \"2\" mode we only support interop between 2.x clients.\n \n @public\n /\nexport type CompatibilityMode = \"1\" \| \"2\";\n\n/\n A mapping of string identifiers to instantiated `DataObject`s or `SharedObject`s.\n /\nexport type LoadableObjectRecord = Record<string, IFluidLoadable>;\n\n/\n A mapping of string identifiers to classes that will later be used to instantiate a corresponding `DataObject`\n * or `SharedObject`.\n /\nexport type LoadableObjectKindRecord = Record<string, SharedObjectKind>;\n\n/\n A kind of `DataObject` or `SharedObject`.\n \n @typeParam T - The kind of `DataObject` or `SharedObject`.\n \n @privateRemarks\n * There are some edge cases in TypeScript where the order of the members in a union matter.\n * Once such edge case is when multiple members of a generic union partially match, and the type parameter is being inferred.\n * In this case, its better to have the desired match and/or the simpler type first.\n * In this case placing ISharedObjectKind fixed one usage and didn't break anything, and generally seems more likely to work than the reverse, so this is the order being used.\n * This is likely (a bug in TypeScript)[https://github.com/microsoft/TypeScript/issues/45809].\n /\nexport type LoadableObjectKind<T extends IFluidLoadable = IFluidLoadable> =\n\t\| ISharedObjectKind<T>\n\t\| DataObjectKind<T>;\n\n/\n Represents properties that can be attached to a container.\n * @public\n /\nexport type ContainerAttachProps<T = unknown> = T;\n\n/\n Declares the Fluid objects that will be available in the {@link IFluidContainer \| Container}.\n \n @remarks\n \n It includes both the instances of objects that are initially available upon `Container` creation, as well\n * as the types of objects that may be dynamically created throughout the lifetime of the `Container`.\n * @public\n /\nexport interface ContainerSchema {\n\t/\n\t Defines loadable objects that will be created when the {@link IFluidContainer \| Container} is first created.\n\t \n\t @remarks It uses the key as the id and the value as the loadable object to create.\n\t \n\t @example\n\t \n\t In the example below two objects will be created when the `Container` is first\n\t * created. One with id \"map1\" that will return a `SharedMap` and the other with\n\t * id \"pair1\" that will return a `KeyValueDataObject`.\n\t \n\t ```typescript\n\t * {\n\t * map1: SharedMap,\n\t * pair1: KeyValueDataObject,\n\t * }\n\t * ```\n\t /\n\treadonly initialObjects: Record<string, SharedObjectKind>;\n\n\t/\n\t Loadable objects that can be created after the initial {@link IFluidContainer \| Container} creation.\n\t \n\t @remarks\n\t \n\t Types defined in `initialObjects` will always be available and are not required to be provided here.\n\t \n\t For best practice it's recommended to define all the dynamic types you create even if they are\n\t * included via initialObjects.\n\t /\n\treadonly dynamicObjectTypes?: readonly SharedObjectKind[];\n}\n\n/\n Declares the Fluid objects that will be available in the {@link IFluidContainer \| Container}.\n \n @remarks\n \n It includes both the kind of `SharedTree` that will be initially available upon `Container` creation, as well\n * as the types of objects that may be dynamically created throughout the lifetime of the `Container`.\n \n @legacy @beta\n /\nexport interface TreeContainerSchema extends ContainerSchema {\n\t// TODO: longer term, it would be better to not have to fit into the `initialObjects` model for tree-based containers.\n\t// But in the short term, fitting into this model makes migration easier.\n\treadonly initialObjects: {\n\t\treadonly tree: SharedObjectKind<ITree>;\n\t};\n}\n\n/\n Holds the collection of objects that the container was initially created with.\n * Additionally provides the ability to dynamically create further objects during usage.\n /\nexport interface IRootDataObject {\n\t/\n\t Dynamically creates a new detached collaborative object (DDS/DataObject).\n\t \n\t @param objectClass - Type of the collaborative object to be created.\n\t \n\t @typeParam T - The class of the `DataObject` or `SharedObject`.\n\t /\n\tcreate<T>(objectClass: SharedObjectKind<T>): Promise<T>;\n\n\t/\n\t Upload a blob of data.\n\t * Although it is marked as internal, there is external usage of this function for experimental purposes.\n\t * Please contact yunho-microsoft or vladsud if you need to change it.\n\t * @param blob - blob to be uploaded.\n\t \n\t @remarks This method is used to expose uploadBlob to the IFluidContainer level. UploadBlob will upload data to server side (as of now, ODSP only). There is no downloadBlob provided as it is not needed(blob lifetime managed by server).\n\t /\n\tuploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>>;\n\n\t/\n\t Provides a record of the initial objects defined on creation.\n\t /\n\treadonly initialObjects: LoadableObjectRecord;\n}\n\ninterface IProvideStaticEntryPoint {\n\treadonly IStaticEntryPoint: IStaticEntryPoint;\n}\n\n/\n This is the internal entry point fluid-static creates.\n /\nexport interface IStaticEntryPoint extends IProvideStaticEntryPoint {\n\treadonly rootDataObject: IRootDataObject;\n\treadonly extensionStore: ContainerExtensionStore;\n}\n\n/\n Signature for {@link IMember} change events.\n \n @param clientId - A unique identifier for the client.\n * @param member - The service-specific member object for the client.\n \n @see See {@link IServiceAudienceEvents} for usage details.\n * @public\n /\nexport type MemberChangedListener<M extends IMember> = (clientId: string, member: M) => void;\n\n/\n Events that trigger when the roster of members in the Fluid session change.\n \n @remarks\n \n Only changes that would be reflected in the returned map of {@link IServiceAudience}'s\n * {@link IServiceAudience.getMembers} method will emit events.\n \n @typeParam M - A service-specific {@link IMember} implementation.\n * @public\n /\nexport interface IServiceAudienceEvents<M extends IMember> extends IEvent {\n\t/\n\t Emitted when a {@link IMember \| member}(s) are either added or removed.\n\t \n\t @eventProperty\n\t /\n\t(event: \"membersChanged\", listener: () => void): void;\n\n\t/\n\t Emitted when a {@link IMember \| member} joins the audience.\n\t \n\t @eventProperty\n\t /\n\t(event: \"memberAdded\", listener: MemberChangedListener<M>): void;\n\n\t/\n\t Emitted when a {@link IMember \| member} leaves the audience.\n\t \n\t @eventProperty\n\t /\n\t(event: \"memberRemoved\", listener: MemberChangedListener<M>): void;\n}\n\n/\n Base interface to be implemented to fetch each service's audience.\n \n @remarks\n \n The type parameter `M` allows consumers to further extend the client object with service-specific\n * details about the connecting client, such as device information, environment, or a username.\n \n @typeParam M - A service-specific {@link IMember} type.\n * @public\n /\nexport interface IServiceAudience<M extends IMember>\n\textends IEventProvider<IServiceAudienceEvents<M>> {\n\t/\n\t Returns an map of all users currently in the Fluid session where key is the userId and the value is the\n\t * member object. The implementation may choose to exclude certain connections from the returned map.\n\t * E.g. ServiceAudience excludes non-interactive connections to represent only the roster of live users.\n\t /\n\tgetMembers(): ReadonlyMap<string, M>;\n\n\t/\n\t Returns the current active user on this client once they are connected. Otherwise, returns undefined.\n\t /\n\tgetMyself(): Myself<M> \| undefined;\n}\n\n/\n Base interface for information for each connection made to the Fluid session.\n \n @remarks This interface can be extended to provide additional information specific to each service.\n * @public\n /\nexport interface IConnection {\n\t/\n\t A unique ID for the connection. A single user may have multiple connections, each with a different ID.\n\t /\n\treadonly id: string;\n\n\t/\n\t Whether the connection is in read or read/write mode.\n\t /\n\treadonly mode: \"write\" \| \"read\";\n}\n\n/\n Base interface to be implemented to fetch each service's member.\n \n @remarks This interface can be extended by each service to provide additional service-specific user metadata.\n * @public\n /\nexport interface IMember {\n\t/\n\t An ID for the user, unique among each individual user connecting to the session.\n\t /\n\treadonly id: string;\n\n\t/\n\t The set of connections the user has made, e.g. from multiple tabs or devices.\n\t /\n\treadonly connections: IConnection[];\n}\n\n/\n An extended member object that includes currentConnection\n * @public\n */\nexport type Myself<M extends IMember = IMember> = M & { readonly currentConnection: string };\n"]}

package/internal.d.ts CHANGED Viewed

@@ -8,4 +8,4 @@
  * Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
  */
-export * from "./lib/index.js";
+export * from "lib/index.js";

package/legacy.d.ts CHANGED Viewed

@@ -8,4 +8,4 @@
  * Generated by "flub generate entrypoints" in @fluid-tools/build-cli.
  */
-export * from "./lib/legacy.js";
+export * from "lib/legacy.js";

package/lib/legacy.d.ts CHANGED Viewed

@@ -15,7 +15,7 @@
  */
 export {
-	// @public APIs
+	// #region @public APIs
 	CompatibilityMode,
 	ContainerAttachProps,
 	ContainerSchema,
@@ -28,8 +28,10 @@ export {
 	InitialObjects,
 	MemberChangedListener,
 	Myself,
+	// #endregion
-	// @legacy APIs
+	// #region @legacyBeta APIs
 	TreeContainerSchema,
 	createTreeContainerRuntimeFactory
+	// #endregion
 } from "./index.js";

package/lib/public.d.ts CHANGED Viewed

@@ -15,7 +15,7 @@
  */
 export {
-	// @public APIs
+	// #region @public APIs
 	CompatibilityMode,
 	ContainerAttachProps,
 	ContainerSchema,
@@ -28,4 +28,5 @@ export {
 	InitialObjects,
 	MemberChangedListener,
 	Myself
+	// #endregion
 } from "./index.js";

package/lib/treeRootDataObject.d.ts CHANGED Viewed

@@ -15,7 +15,7 @@ import type { CompatibilityMode, TreeContainerSchema } from "./types.js";
  * The root data object's registry and shared objects are configured based on the provided
  * SharedTree and optionally data store registry.
  *
- * @legacy @alpha
+ * @legacy @beta
  */
 export declare function createTreeContainerRuntimeFactory(props: {
     /**

package/lib/treeRootDataObject.js CHANGED Viewed

@@ -139,7 +139,7 @@ class TreeRootDataObjectFactory extends TreeDataObjectFactory {
  * The root data object's registry and shared objects are configured based on the provided
  * SharedTree and optionally data store registry.
  *
- * @legacy @alpha
+ * @legacy @beta
  */
 export function createTreeContainerRuntimeFactory(props) {
     const { compatibilityMode, minVersionForCollabOverride, rootDataStoreRegistry, runtimeOptionOverrides, schema, } = props;

package/lib/treeRootDataObject.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"treeRootDataObject.js","sourceRoot":"","sources":["../src/treeRootDataObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;;;;;;;;;;;;;AAEH,OAAO,EACN,2BAA2B,EAC3B,cAAc,EACd,qBAAqB,GACrB,MAAM,mCAAmC,CAAC;AAG3C,OAAO,EACN,sBAAsB,GAGtB,MAAM,4CAA4C,CAAC;AAUpD,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAK7D,OAAO,EAAE,+BAA+B,EAAE,MAAM,iCAAiC,CAAC;AASlF,OAAO,EACN,sCAAsC,EACtC,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,iCAAiC,GACjC,MAAM,YAAY,CAAC;AAEpB;;;;;;GAMG;AAEH;;;;;GAKG;AACH,MAAM,kBAAmB,SAAQ,cAAc;IAC9C,YAAmB,KAAuB;QACzC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,IAAW,kBAAkB;QAC5B,OAAO,IAAI,CAAC;IACb,CAAC;IAED,sHAAsH;IACtH,yEAAyE;IACzE,IAAW,cAAc;QACxB,OAAO;YACN,IAAI,EAAE,IAAI,CAAC,IAAI;SACf,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,MAAM,CAAI,WAAgC;QACtD,MAAM,QAAQ,GAAG,WAAgE,CAAC;QAClF,IAAI,gBAAgB,CAAC,QAAQ,CAAC,EAAE,CAAC;YAChC,OAAO,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACjD,CAAC;aAAM,IAAI,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC;YACzC,OAAO,kBAAkB,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACnD,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,wEAAwE,CAAC,CAAC;IAC3F,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,IAAqB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;CACD;AAED,MAAM,mBAAmB,GAAG,cAAc,CAAC;AAE3C;;;GAGG;AACH,MAAM,sBAAsB,GAAG,YAAY,CAAC;AAE5C,KAAK,UAAU,iBAAiB,CAC/B,gBAAmC;IAEnC,MAAM,UAAU,GAAG,MAAM,gBAAgB,CAAC,6BAA6B,CAAC,mBAAmB,CAAC,CAAC;IAC7F,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC9B,MAAM,IAAI,KAAK,CAAC,sBAAsB,mBAAmB,cAAc,CAAC,CAAC;IAC1E,CAAC;IACD,MAAM,kBAAkB,GAAI,CAAC,MAAM,UAAU,CAAC,GAAG,EAAE,CAAqC;SACtF,kBAAkB,CAAC;IACrB,MAAM,CACL,kBAAkB,KAAK,SAAS,EAChC,KAAK,CAAC,mDAAmD,CACzD,CAAC;IACF,OAAO,eAAe,CACrB;QACC,cAAc,EAAE,kBAAkB;QAClC,cAAc,EAAE,gBAA6C;KAC7D,EACD,mBAAmB,CACnB,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,2BAA4B,SAAQ,2BAA2B;IAIpE,YACC,iBAAoC,EACpC,yBAAoE,EACpE,SAGE;QAEF,KAAK,CAAC;YACL,eAAe,EAAE,CAAC,yBAAyB,CAAC,aAAa,CAAC;YAC1D,cAAc,EAAE;gBACf,GAAG,+BAA+B,CAAC,iBAAiB,CAAC;gBACrD,GAAG,SAAS,EAAE,cAAc;aAC5B;YACD,iBAAiB;YACjB,mBAAmB,EAClB,SAAS,EAAE,mBAAmB;gBAC9B,sCAAsC,CAAC,iBAAiB,CAAC;SAC1D,CAAC,CAAC;QArBJ,iCAAiC;QACxB,yEAAsE;QAqB9E,uBAAA,IAAI,0DAA8B,yBAAyB,MAAA,CAAC;IAC7D,CAAC;IAES,KAAK,CAAC,8BAA8B,CAAC,OAA0B;QACxE,sEAAsE;QACtE,MAAM,uBAAA,IAAI,8DAA2B,CAAC,kBAAkB,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;CACD;;AAED;;GAEG;AACH,MAAM,yBAA0B,SAAQ,qBAAyC;IAChF,YACC,gBAA4C,EAAE,EAC7B,iBAA0C;QAG3D,MAAM,IAAI,GAAS,UAAU,MAAM;YAClC,iEAAiE;YACjE,OAAO,IAAI,kBAAkB,CAAC;gBAC7B,GAAG,MAAM;gBACT,8CAA8C;aAC9C,CAAC,CAAC;QACJ,CAAoB,CAAC;QAErB,uGAAuG;QACvG,+GAA+G;QAC/G,KAAK,CAAC;YACL,IAAI,EAAE,sBAAsB;YAC5B,IAAI;YACJ,aAAa;SACb,CAAC,CAAC;QAjBc,sBAAiB,GAAjB,iBAAiB,CAAyB;IAkB5D,CAAC;IAED,IAAW,uBAAuB;QACjC,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAC/B,CAAC;CACD;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,iCAAiC,CAAC,KA2BjD;IACA,MAAM,EACL,iBAAiB,EACjB,2BAA2B,EAC3B,qBAAqB,EACrB,sBAAsB,EACtB,MAAM,GACN,GAAG,KAAK,CAAC;IAEV,MAAM,CAAC,eAAe,EAAE,aAAa,CAAC,GAAG,iCAAiC,CAAC,MAAM,CAAC,CAAC;IACnF,MAAM,QAAQ,GAAG,qBAAqB,IAAI,IAAI,sBAAsB,CAAC,eAAe,CAAC,CAAC;IAEtF,OAAO,IAAI,2BAA2B,CACrC,iBAAiB,EACjB,IAAI,yBAAyB,CAAC,aAAa,EAAE,QAAQ,CAAC,EACtD;QACC,cAAc,EAAE,sBAAsB;QACtC,mBAAmB,EAAE,2BAA2B;KAChD,CACD,CAAC;AACH,CAAC","sourcesContent":["/!\n Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n /\n\nimport {\n\tBaseContainerRuntimeFactory,\n\tTreeDataObject,\n\tTreeDataObjectFactory,\n} from \"@fluidframework/aqueduct/internal\";\nimport type { IDataObjectProps } from \"@fluidframework/aqueduct/internal\";\nimport type { IRuntimeFactory } from \"@fluidframework/container-definitions/internal\";\nimport {\n\tFluidDataStoreRegistry,\n\ttype IContainerRuntimeOptions,\n\ttype MinimumVersionForCollab,\n} from \"@fluidframework/container-runtime/internal\";\nimport type {\n\tIContainerRuntime,\n\tIContainerRuntimeInternal,\n} from \"@fluidframework/container-runtime-definitions/internal\";\nimport type {\n\tFluidObject,\n\tIFluidHandle,\n\tIFluidLoadable,\n} from \"@fluidframework/core-interfaces\";\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport type { IChannelFactory } from \"@fluidframework/datastore-definitions/internal\";\nimport type { IFluidDataStoreRegistry } from \"@fluidframework/runtime-definitions/internal\";\nimport type { SharedObjectKind } from \"@fluidframework/shared-object-base/internal\";\n\nimport { compatibilityModeRuntimeOptions } from \"./compatibilityConfiguration.js\";\nimport type {\n\tCompatibilityMode,\n\tIRootDataObject,\n\tIStaticEntryPoint,\n\tLoadableObjectKind,\n\tLoadableObjectRecord,\n\tTreeContainerSchema,\n} from \"./types.js\";\nimport {\n\tcompatibilityModeToMinVersionForCollab,\n\tcreateDataObject,\n\tcreateSharedObject,\n\tisDataObjectKind,\n\tisSharedObjectKind,\n\tmakeFluidObject,\n\tparseDataObjectsFromSharedObjects,\n} from \"./utils.js\";\n\n/\n This module contains types and factories for creating tree-based root data objects.\n * They exist as an alternative to the APIs in `rootDataObject.ts`.\n \n These APIs are currently shaped to parallel `RootDataObject`, but this is not intended as the long-term design.\n * The current shape is a short-term solution to allow for easier migration from the old APIs.\n /\n\n/\n The entry-point/root collaborative object of the {@link IFluidContainer \| Fluid Container}.\n \n @remarks\n * Abstracts the dynamic code required to build a Fluid Container into a static representation for end customers.\n /\nclass TreeRootDataObject extends TreeDataObject implements IRootDataObject {\n\tpublic constructor(props: IDataObjectProps) {\n\t\tsuper(props);\n\t}\n\n\tpublic get TreeRootDataObject(): TreeRootDataObject {\n\t\treturn this;\n\t}\n\n\t// TODO: longer term, it would be better to not have to fit into the `initialObjects` model for tree-based containers.\n\t// But in the short term, fitting into this model makes migration easier.\n\tpublic get initialObjects(): LoadableObjectRecord {\n\t\treturn {\n\t\t\ttree: this.tree,\n\t\t};\n\t}\n\n\tpublic async create<T>(objectClass: SharedObjectKind<T>): Promise<T> {\n\t\tconst internal = objectClass as unknown as LoadableObjectKind<T & IFluidLoadable>;\n\t\tif (isDataObjectKind(internal)) {\n\t\t\treturn createDataObject(internal, this.context);\n\t\t} else if (isSharedObjectKind(internal)) {\n\t\t\treturn createSharedObject(internal, this.runtime);\n\t\t}\n\t\tthrow new Error(\"Could not create new Fluid object because an unknown object was passed\");\n\t}\n\n\tpublic async uploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>> {\n\t\treturn this.runtime.uploadBlob(blob);\n\t}\n}\n\nconst treeRootDataStoreId = \"treeRootDOId\";\n\n/\n Type of the {@link TreeRootDataObject}.\n * @remarks Used in the PureDataObjectFactory to create the root data object.\n /\nconst treeRootDataObjectType = \"treeRootDO\";\n\nasync function provideEntryPoint(\n\tcontainerRuntime: IContainerRuntime,\n): Promise<IStaticEntryPoint> {\n\tconst entryPoint = await containerRuntime.getAliasedDataStoreEntryPoint(treeRootDataStoreId);\n\tif (entryPoint === undefined) {\n\t\tthrow new Error(`default dataStore [${treeRootDataStoreId}] must exist`);\n\t}\n\tconst treeRootDataObject = ((await entryPoint.get()) as FluidObject<TreeRootDataObject>)\n\t\t.TreeRootDataObject;\n\tassert(\n\t\ttreeRootDataObject !== undefined,\n\t\t0xbe7 / entryPoint must be of type TreeRootDataObject /,\n\t);\n\treturn makeFluidObject<IStaticEntryPoint>(\n\t\t{\n\t\t\trootDataObject: treeRootDataObject,\n\t\t\textensionStore: containerRuntime as IContainerRuntimeInternal,\n\t\t},\n\t\t\"IStaticEntryPoint\",\n\t);\n}\n\n/\n Factory for Container Runtime instances that provide a {@link IStaticEntryPoint}\n * (containing single {@link IRootDataObject}) as their entry point.\n /\nclass TreeContainerRuntimeFactory extends BaseContainerRuntimeFactory {\n\t// TODO: use for runtime factory.\n\treadonly #treeRootDataObjectFactory: TreeDataObjectFactory<TreeRootDataObject>;\n\n\tpublic constructor(\n\t\tcompatibilityMode: CompatibilityMode,\n\t\ttreeRootDataObjectFactory: TreeDataObjectFactory<TreeRootDataObject>,\n\t\toverrides?: Partial<{\n\t\t\truntimeOptions: Partial<IContainerRuntimeOptions>;\n\t\t\tminVersionForCollab: MinimumVersionForCollab;\n\t\t}>,\n\t) {\n\t\tsuper({\n\t\t\tregistryEntries: [treeRootDataObjectFactory.registryEntry],\n\t\t\truntimeOptions: {\n\t\t\t\t...compatibilityModeRuntimeOptions[compatibilityMode],\n\t\t\t\t...overrides?.runtimeOptions,\n\t\t\t},\n\t\t\tprovideEntryPoint,\n\t\t\tminVersionForCollab:\n\t\t\t\toverrides?.minVersionForCollab ??\n\t\t\t\tcompatibilityModeToMinVersionForCollab[compatibilityMode],\n\t\t});\n\t\tthis.#treeRootDataObjectFactory = treeRootDataObjectFactory;\n\t}\n\n\tprotected async containerInitializingFirstTime(runtime: IContainerRuntime): Promise<void> {\n\t\t// The first time we create the container we create the RootDataObject\n\t\tawait this.#treeRootDataObjectFactory.createRootInstance(treeRootDataStoreId, runtime);\n\t}\n}\n\n/\n Factory that creates instances of a tree-based root data object.\n /\nclass TreeRootDataObjectFactory extends TreeDataObjectFactory<TreeRootDataObject> {\n\tpublic constructor(\n\t\tsharedObjects: readonly IChannelFactory[] = [],\n\t\tprivate readonly dataStoreRegistry: IFluidDataStoreRegistry,\n\t) {\n\t\ttype Ctor = new (props: IDataObjectProps) => TreeRootDataObject;\n\t\tconst ctor: Ctor = function (_props) {\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-argument\n\t\t\treturn new TreeRootDataObject({\n\t\t\t\t..._props,\n\t\t\t\t// Add any additional injected properties here\n\t\t\t});\n\t\t} as unknown as Ctor;\n\n\t\t// Note: we're not specifying registry entries to the base class, so it won't create a registry itself,\n\t\t// and instead we override the necessary methods in this class to use the registry received in the constructor.\n\t\tsuper({\n\t\t\ttype: treeRootDataObjectType,\n\t\t\tctor,\n\t\t\tsharedObjects,\n\t\t});\n\t}\n\n\tpublic get IFluidDataStoreRegistry(): IFluidDataStoreRegistry {\n\t\treturn this.dataStoreRegistry;\n\t}\n}\n\n/\n Creates an {@link @fluidframework/aqueduct#IRuntimeFactory} which constructs containers\n * with an entry point containing single tree-based root data object.\n \n @remarks\n * The entry point is opaque to caller.\n * The root data object's registry and shared objects are configured based on the provided\n * SharedTree and optionally data store registry.\n \n @legacy @alpha\n /\nexport function createTreeContainerRuntimeFactory(props: {\n\t/\n\t The schema for the container.\n\t /\n\treadonly schema: TreeContainerSchema;\n\n\t/\n\t See {@link CompatibilityMode} and compatibilityModeRuntimeOptions for more details.\n\t /\n\treadonly compatibilityMode: CompatibilityMode;\n\t/\n\t Optional registry of data stores to pass to the DataObject factory.\n\t * If not provided, one will be created based on the schema.\n\t /\n\treadonly rootDataStoreRegistry?: IFluidDataStoreRegistry;\n\t/\n\t Optional overrides for the container runtime options.\n\t * If not provided, only the default options for the given compatibilityMode will be used.\n\t /\n\treadonly runtimeOptionOverrides?: Partial<IContainerRuntimeOptions>;\n\t/\n\t Optional override for minimum version for collab.\n\t * If not provided, the default for the given compatibilityMode will be used.\n\t * @remarks\n\t * This is useful when runtime options are overridden and change the minimum version for collab.\n\t */\n\treadonly minVersionForCollabOverride?: MinimumVersionForCollab;\n}): IRuntimeFactory {\n\tconst {\n\t\tcompatibilityMode,\n\t\tminVersionForCollabOverride,\n\t\trootDataStoreRegistry,\n\t\truntimeOptionOverrides,\n\t\tschema,\n\t} = props;\n\n\tconst [registryEntries, sharedObjects] = parseDataObjectsFromSharedObjects(schema);\n\tconst registry = rootDataStoreRegistry ?? new FluidDataStoreRegistry(registryEntries);\n\n\treturn new TreeContainerRuntimeFactory(\n\t\tcompatibilityMode,\n\t\tnew TreeRootDataObjectFactory(sharedObjects, registry),\n\t\t{\n\t\t\truntimeOptions: runtimeOptionOverrides,\n\t\t\tminVersionForCollab: minVersionForCollabOverride,\n\t\t},\n\t);\n}\n"]}
1	+ {"version":3,"file":"treeRootDataObject.js","sourceRoot":"","sources":["../src/treeRootDataObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;;;;;;;;;;;;;AAEH,OAAO,EACN,2BAA2B,EAC3B,cAAc,EACd,qBAAqB,GACrB,MAAM,mCAAmC,CAAC;AAG3C,OAAO,EACN,sBAAsB,GAGtB,MAAM,4CAA4C,CAAC;AAUpD,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAK7D,OAAO,EAAE,+BAA+B,EAAE,MAAM,iCAAiC,CAAC;AASlF,OAAO,EACN,sCAAsC,EACtC,gBAAgB,EAChB,kBAAkB,EAClB,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,iCAAiC,GACjC,MAAM,YAAY,CAAC;AAEpB;;;;;;GAMG;AAEH;;;;;GAKG;AACH,MAAM,kBAAmB,SAAQ,cAAc;IAC9C,YAAmB,KAAuB;QACzC,KAAK,CAAC,KAAK,CAAC,CAAC;IACd,CAAC;IAED,IAAW,kBAAkB;QAC5B,OAAO,IAAI,CAAC;IACb,CAAC;IAED,sHAAsH;IACtH,yEAAyE;IACzE,IAAW,cAAc;QACxB,OAAO;YACN,IAAI,EAAE,IAAI,CAAC,IAAI;SACf,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,MAAM,CAAI,WAAgC;QACtD,MAAM,QAAQ,GAAG,WAAgE,CAAC;QAClF,IAAI,gBAAgB,CAAC,QAAQ,CAAC,EAAE,CAAC;YAChC,OAAO,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACjD,CAAC;aAAM,IAAI,kBAAkB,CAAC,QAAQ,CAAC,EAAE,CAAC;YACzC,OAAO,kBAAkB,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;QACnD,CAAC;QACD,MAAM,IAAI,KAAK,CAAC,wEAAwE,CAAC,CAAC;IAC3F,CAAC;IAEM,KAAK,CAAC,UAAU,CAAC,IAAqB;QAC5C,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC;CACD;AAED,MAAM,mBAAmB,GAAG,cAAc,CAAC;AAE3C;;;GAGG;AACH,MAAM,sBAAsB,GAAG,YAAY,CAAC;AAE5C,KAAK,UAAU,iBAAiB,CAC/B,gBAAmC;IAEnC,MAAM,UAAU,GAAG,MAAM,gBAAgB,CAAC,6BAA6B,CAAC,mBAAmB,CAAC,CAAC;IAC7F,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC9B,MAAM,IAAI,KAAK,CAAC,sBAAsB,mBAAmB,cAAc,CAAC,CAAC;IAC1E,CAAC;IACD,MAAM,kBAAkB,GAAI,CAAC,MAAM,UAAU,CAAC,GAAG,EAAE,CAAqC;SACtF,kBAAkB,CAAC;IACrB,MAAM,CACL,kBAAkB,KAAK,SAAS,EAChC,KAAK,CAAC,mDAAmD,CACzD,CAAC;IACF,OAAO,eAAe,CACrB;QACC,cAAc,EAAE,kBAAkB;QAClC,cAAc,EAAE,gBAA6C;KAC7D,EACD,mBAAmB,CACnB,CAAC;AACH,CAAC;AAED;;;GAGG;AACH,MAAM,2BAA4B,SAAQ,2BAA2B;IAIpE,YACC,iBAAoC,EACpC,yBAAoE,EACpE,SAGE;QAEF,KAAK,CAAC;YACL,eAAe,EAAE,CAAC,yBAAyB,CAAC,aAAa,CAAC;YAC1D,cAAc,EAAE;gBACf,GAAG,+BAA+B,CAAC,iBAAiB,CAAC;gBACrD,GAAG,SAAS,EAAE,cAAc;aAC5B;YACD,iBAAiB;YACjB,mBAAmB,EAClB,SAAS,EAAE,mBAAmB;gBAC9B,sCAAsC,CAAC,iBAAiB,CAAC;SAC1D,CAAC,CAAC;QArBJ,iCAAiC;QACxB,yEAAsE;QAqB9E,uBAAA,IAAI,0DAA8B,yBAAyB,MAAA,CAAC;IAC7D,CAAC;IAES,KAAK,CAAC,8BAA8B,CAAC,OAA0B;QACxE,sEAAsE;QACtE,MAAM,uBAAA,IAAI,8DAA2B,CAAC,kBAAkB,CAAC,mBAAmB,EAAE,OAAO,CAAC,CAAC;IACxF,CAAC;CACD;;AAED;;GAEG;AACH,MAAM,yBAA0B,SAAQ,qBAAyC;IAChF,YACC,gBAA4C,EAAE,EAC7B,iBAA0C;QAG3D,MAAM,IAAI,GAAS,UAAU,MAAM;YAClC,iEAAiE;YACjE,OAAO,IAAI,kBAAkB,CAAC;gBAC7B,GAAG,MAAM;gBACT,8CAA8C;aAC9C,CAAC,CAAC;QACJ,CAAoB,CAAC;QAErB,uGAAuG;QACvG,+GAA+G;QAC/G,KAAK,CAAC;YACL,IAAI,EAAE,sBAAsB;YAC5B,IAAI;YACJ,aAAa;SACb,CAAC,CAAC;QAjBc,sBAAiB,GAAjB,iBAAiB,CAAyB;IAkB5D,CAAC;IAED,IAAW,uBAAuB;QACjC,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAC/B,CAAC;CACD;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,iCAAiC,CAAC,KA2BjD;IACA,MAAM,EACL,iBAAiB,EACjB,2BAA2B,EAC3B,qBAAqB,EACrB,sBAAsB,EACtB,MAAM,GACN,GAAG,KAAK,CAAC;IAEV,MAAM,CAAC,eAAe,EAAE,aAAa,CAAC,GAAG,iCAAiC,CAAC,MAAM,CAAC,CAAC;IACnF,MAAM,QAAQ,GAAG,qBAAqB,IAAI,IAAI,sBAAsB,CAAC,eAAe,CAAC,CAAC;IAEtF,OAAO,IAAI,2BAA2B,CACrC,iBAAiB,EACjB,IAAI,yBAAyB,CAAC,aAAa,EAAE,QAAQ,CAAC,EACtD;QACC,cAAc,EAAE,sBAAsB;QACtC,mBAAmB,EAAE,2BAA2B;KAChD,CACD,CAAC;AACH,CAAC","sourcesContent":["/!\n Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n /\n\nimport {\n\tBaseContainerRuntimeFactory,\n\tTreeDataObject,\n\tTreeDataObjectFactory,\n} from \"@fluidframework/aqueduct/internal\";\nimport type { IDataObjectProps } from \"@fluidframework/aqueduct/internal\";\nimport type { IRuntimeFactory } from \"@fluidframework/container-definitions/internal\";\nimport {\n\tFluidDataStoreRegistry,\n\ttype IContainerRuntimeOptions,\n\ttype MinimumVersionForCollab,\n} from \"@fluidframework/container-runtime/internal\";\nimport type {\n\tIContainerRuntime,\n\tIContainerRuntimeInternal,\n} from \"@fluidframework/container-runtime-definitions/internal\";\nimport type {\n\tFluidObject,\n\tIFluidHandle,\n\tIFluidLoadable,\n} from \"@fluidframework/core-interfaces\";\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport type { IChannelFactory } from \"@fluidframework/datastore-definitions/internal\";\nimport type { IFluidDataStoreRegistry } from \"@fluidframework/runtime-definitions/internal\";\nimport type { SharedObjectKind } from \"@fluidframework/shared-object-base/internal\";\n\nimport { compatibilityModeRuntimeOptions } from \"./compatibilityConfiguration.js\";\nimport type {\n\tCompatibilityMode,\n\tIRootDataObject,\n\tIStaticEntryPoint,\n\tLoadableObjectKind,\n\tLoadableObjectRecord,\n\tTreeContainerSchema,\n} from \"./types.js\";\nimport {\n\tcompatibilityModeToMinVersionForCollab,\n\tcreateDataObject,\n\tcreateSharedObject,\n\tisDataObjectKind,\n\tisSharedObjectKind,\n\tmakeFluidObject,\n\tparseDataObjectsFromSharedObjects,\n} from \"./utils.js\";\n\n/\n This module contains types and factories for creating tree-based root data objects.\n * They exist as an alternative to the APIs in `rootDataObject.ts`.\n \n These APIs are currently shaped to parallel `RootDataObject`, but this is not intended as the long-term design.\n * The current shape is a short-term solution to allow for easier migration from the old APIs.\n /\n\n/\n The entry-point/root collaborative object of the {@link IFluidContainer \| Fluid Container}.\n \n @remarks\n * Abstracts the dynamic code required to build a Fluid Container into a static representation for end customers.\n /\nclass TreeRootDataObject extends TreeDataObject implements IRootDataObject {\n\tpublic constructor(props: IDataObjectProps) {\n\t\tsuper(props);\n\t}\n\n\tpublic get TreeRootDataObject(): TreeRootDataObject {\n\t\treturn this;\n\t}\n\n\t// TODO: longer term, it would be better to not have to fit into the `initialObjects` model for tree-based containers.\n\t// But in the short term, fitting into this model makes migration easier.\n\tpublic get initialObjects(): LoadableObjectRecord {\n\t\treturn {\n\t\t\ttree: this.tree,\n\t\t};\n\t}\n\n\tpublic async create<T>(objectClass: SharedObjectKind<T>): Promise<T> {\n\t\tconst internal = objectClass as unknown as LoadableObjectKind<T & IFluidLoadable>;\n\t\tif (isDataObjectKind(internal)) {\n\t\t\treturn createDataObject(internal, this.context);\n\t\t} else if (isSharedObjectKind(internal)) {\n\t\t\treturn createSharedObject(internal, this.runtime);\n\t\t}\n\t\tthrow new Error(\"Could not create new Fluid object because an unknown object was passed\");\n\t}\n\n\tpublic async uploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>> {\n\t\treturn this.runtime.uploadBlob(blob);\n\t}\n}\n\nconst treeRootDataStoreId = \"treeRootDOId\";\n\n/\n Type of the {@link TreeRootDataObject}.\n * @remarks Used in the PureDataObjectFactory to create the root data object.\n /\nconst treeRootDataObjectType = \"treeRootDO\";\n\nasync function provideEntryPoint(\n\tcontainerRuntime: IContainerRuntime,\n): Promise<IStaticEntryPoint> {\n\tconst entryPoint = await containerRuntime.getAliasedDataStoreEntryPoint(treeRootDataStoreId);\n\tif (entryPoint === undefined) {\n\t\tthrow new Error(`default dataStore [${treeRootDataStoreId}] must exist`);\n\t}\n\tconst treeRootDataObject = ((await entryPoint.get()) as FluidObject<TreeRootDataObject>)\n\t\t.TreeRootDataObject;\n\tassert(\n\t\ttreeRootDataObject !== undefined,\n\t\t0xbe7 / entryPoint must be of type TreeRootDataObject /,\n\t);\n\treturn makeFluidObject<IStaticEntryPoint>(\n\t\t{\n\t\t\trootDataObject: treeRootDataObject,\n\t\t\textensionStore: containerRuntime as IContainerRuntimeInternal,\n\t\t},\n\t\t\"IStaticEntryPoint\",\n\t);\n}\n\n/\n Factory for Container Runtime instances that provide a {@link IStaticEntryPoint}\n * (containing single {@link IRootDataObject}) as their entry point.\n /\nclass TreeContainerRuntimeFactory extends BaseContainerRuntimeFactory {\n\t// TODO: use for runtime factory.\n\treadonly #treeRootDataObjectFactory: TreeDataObjectFactory<TreeRootDataObject>;\n\n\tpublic constructor(\n\t\tcompatibilityMode: CompatibilityMode,\n\t\ttreeRootDataObjectFactory: TreeDataObjectFactory<TreeRootDataObject>,\n\t\toverrides?: Partial<{\n\t\t\truntimeOptions: Partial<IContainerRuntimeOptions>;\n\t\t\tminVersionForCollab: MinimumVersionForCollab;\n\t\t}>,\n\t) {\n\t\tsuper({\n\t\t\tregistryEntries: [treeRootDataObjectFactory.registryEntry],\n\t\t\truntimeOptions: {\n\t\t\t\t...compatibilityModeRuntimeOptions[compatibilityMode],\n\t\t\t\t...overrides?.runtimeOptions,\n\t\t\t},\n\t\t\tprovideEntryPoint,\n\t\t\tminVersionForCollab:\n\t\t\t\toverrides?.minVersionForCollab ??\n\t\t\t\tcompatibilityModeToMinVersionForCollab[compatibilityMode],\n\t\t});\n\t\tthis.#treeRootDataObjectFactory = treeRootDataObjectFactory;\n\t}\n\n\tprotected async containerInitializingFirstTime(runtime: IContainerRuntime): Promise<void> {\n\t\t// The first time we create the container we create the RootDataObject\n\t\tawait this.#treeRootDataObjectFactory.createRootInstance(treeRootDataStoreId, runtime);\n\t}\n}\n\n/\n Factory that creates instances of a tree-based root data object.\n /\nclass TreeRootDataObjectFactory extends TreeDataObjectFactory<TreeRootDataObject> {\n\tpublic constructor(\n\t\tsharedObjects: readonly IChannelFactory[] = [],\n\t\tprivate readonly dataStoreRegistry: IFluidDataStoreRegistry,\n\t) {\n\t\ttype Ctor = new (props: IDataObjectProps) => TreeRootDataObject;\n\t\tconst ctor: Ctor = function (_props) {\n\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-argument\n\t\t\treturn new TreeRootDataObject({\n\t\t\t\t..._props,\n\t\t\t\t// Add any additional injected properties here\n\t\t\t});\n\t\t} as unknown as Ctor;\n\n\t\t// Note: we're not specifying registry entries to the base class, so it won't create a registry itself,\n\t\t// and instead we override the necessary methods in this class to use the registry received in the constructor.\n\t\tsuper({\n\t\t\ttype: treeRootDataObjectType,\n\t\t\tctor,\n\t\t\tsharedObjects,\n\t\t});\n\t}\n\n\tpublic get IFluidDataStoreRegistry(): IFluidDataStoreRegistry {\n\t\treturn this.dataStoreRegistry;\n\t}\n}\n\n/\n Creates an {@link @fluidframework/aqueduct#IRuntimeFactory} which constructs containers\n * with an entry point containing single tree-based root data object.\n \n @remarks\n * The entry point is opaque to caller.\n * The root data object's registry and shared objects are configured based on the provided\n * SharedTree and optionally data store registry.\n \n @legacy @beta\n /\nexport function createTreeContainerRuntimeFactory(props: {\n\t/\n\t The schema for the container.\n\t /\n\treadonly schema: TreeContainerSchema;\n\n\t/\n\t See {@link CompatibilityMode} and compatibilityModeRuntimeOptions for more details.\n\t /\n\treadonly compatibilityMode: CompatibilityMode;\n\t/\n\t Optional registry of data stores to pass to the DataObject factory.\n\t * If not provided, one will be created based on the schema.\n\t /\n\treadonly rootDataStoreRegistry?: IFluidDataStoreRegistry;\n\t/\n\t Optional overrides for the container runtime options.\n\t * If not provided, only the default options for the given compatibilityMode will be used.\n\t /\n\treadonly runtimeOptionOverrides?: Partial<IContainerRuntimeOptions>;\n\t/\n\t Optional override for minimum version for collab.\n\t * If not provided, the default for the given compatibilityMode will be used.\n\t * @remarks\n\t * This is useful when runtime options are overridden and change the minimum version for collab.\n\t */\n\treadonly minVersionForCollabOverride?: MinimumVersionForCollab;\n}): IRuntimeFactory {\n\tconst {\n\t\tcompatibilityMode,\n\t\tminVersionForCollabOverride,\n\t\trootDataStoreRegistry,\n\t\truntimeOptionOverrides,\n\t\tschema,\n\t} = props;\n\n\tconst [registryEntries, sharedObjects] = parseDataObjectsFromSharedObjects(schema);\n\tconst registry = rootDataStoreRegistry ?? new FluidDataStoreRegistry(registryEntries);\n\n\treturn new TreeContainerRuntimeFactory(\n\t\tcompatibilityMode,\n\t\tnew TreeRootDataObjectFactory(sharedObjects, registry),\n\t\t{\n\t\t\truntimeOptions: runtimeOptionOverrides,\n\t\t\tminVersionForCollab: minVersionForCollabOverride,\n\t\t},\n\t);\n}\n"]}

package/lib/tsdoc-metadata.json CHANGED Viewed

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.52.8"
+      "packageVersion": "7.52.11"
     }
   ]
 }

package/lib/types.d.ts CHANGED Viewed

@@ -91,7 +91,7 @@ export interface ContainerSchema {
  * It includes both the kind of `SharedTree` that will be initially available upon `Container` creation, as well
  * as the types of objects that may be dynamically created throughout the lifetime of the `Container`.
  *
- * @legacy @alpha
+ * @legacy @beta
  */
 export interface TreeContainerSchema extends ContainerSchema {
     readonly initialObjects: {

package/lib/types.js.map CHANGED Viewed

	@@ -1 +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 type { DataObjectKind } from \"@fluidframework/aqueduct/internal\";\nimport type { ContainerExtensionStore } from \"@fluidframework/container-runtime-definitions/internal\";\nimport type {\n\tIEvent,\n\tIEventProvider,\n\tIFluidHandle,\n\tIFluidLoadable,\n} from \"@fluidframework/core-interfaces\";\nimport type {\n\tISharedObjectKind,\n\tSharedObjectKind,\n} from \"@fluidframework/shared-object-base/internal\";\nimport type { ITree } from \"@fluidframework/tree\";\n\n/\n Determines the set of runtime options that Fluid Framework will use when running.\n * In \"1\" mode we support full interop between 2.x clients and 1.x clients,\n * while in \"2\" mode we only support interop between 2.x clients.\n \n @public\n /\nexport type CompatibilityMode = \"1\" \| \"2\";\n\n/\n A mapping of string identifiers to instantiated `DataObject`s or `SharedObject`s.\n /\nexport type LoadableObjectRecord = Record<string, IFluidLoadable>;\n\n/\n A mapping of string identifiers to classes that will later be used to instantiate a corresponding `DataObject`\n * or `SharedObject`.\n /\nexport type LoadableObjectKindRecord = Record<string, SharedObjectKind>;\n\n/\n A kind of `DataObject` or `SharedObject`.\n \n @typeParam T - The kind of `DataObject` or `SharedObject`.\n \n @privateRemarks\n * There are some edge cases in TypeScript where the order of the members in a union matter.\n * Once such edge case is when multiple members of a generic union partially match, and the type parameter is being inferred.\n * In this case, its better to have the desired match and/or the simpler type first.\n * In this case placing ISharedObjectKind fixed one usage and didn't break anything, and generally seems more likely to work than the reverse, so this is the order being used.\n * This is likely (a bug in TypeScript)[https://github.com/microsoft/TypeScript/issues/45809].\n /\nexport type LoadableObjectKind<T extends IFluidLoadable = IFluidLoadable> =\n\t\| ISharedObjectKind<T>\n\t\| DataObjectKind<T>;\n\n/\n Represents properties that can be attached to a container.\n * @public\n /\nexport type ContainerAttachProps<T = unknown> = T;\n\n/\n Declares the Fluid objects that will be available in the {@link IFluidContainer \| Container}.\n \n @remarks\n \n It includes both the instances of objects that are initially available upon `Container` creation, as well\n * as the types of objects that may be dynamically created throughout the lifetime of the `Container`.\n * @public\n /\nexport interface ContainerSchema {\n\t/\n\t Defines loadable objects that will be created when the {@link IFluidContainer \| Container} is first created.\n\t \n\t @remarks It uses the key as the id and the value as the loadable object to create.\n\t \n\t @example\n\t \n\t In the example below two objects will be created when the `Container` is first\n\t * created. One with id \"map1\" that will return a `SharedMap` and the other with\n\t * id \"pair1\" that will return a `KeyValueDataObject`.\n\t \n\t ```typescript\n\t * {\n\t * map1: SharedMap,\n\t * pair1: KeyValueDataObject,\n\t * }\n\t * ```\n\t /\n\treadonly initialObjects: Record<string, SharedObjectKind>;\n\n\t/\n\t Loadable objects that can be created after the initial {@link IFluidContainer \| Container} creation.\n\t \n\t @remarks\n\t \n\t Types defined in `initialObjects` will always be available and are not required to be provided here.\n\t \n\t For best practice it's recommended to define all the dynamic types you create even if they are\n\t * included via initialObjects.\n\t /\n\treadonly dynamicObjectTypes?: readonly SharedObjectKind[];\n}\n\n/\n Declares the Fluid objects that will be available in the {@link IFluidContainer \| Container}.\n \n @remarks\n \n It includes both the kind of `SharedTree` that will be initially available upon `Container` creation, as well\n * as the types of objects that may be dynamically created throughout the lifetime of the `Container`.\n \n @legacy @~~alpha~~\n /\nexport interface TreeContainerSchema extends ContainerSchema {\n\t// TODO: longer term, it would be better to not have to fit into the `initialObjects` model for tree-based containers.\n\t// But in the short term, fitting into this model makes migration easier.\n\treadonly initialObjects: {\n\t\treadonly tree: SharedObjectKind<ITree>;\n\t};\n}\n\n/\n Holds the collection of objects that the container was initially created with.\n * Additionally provides the ability to dynamically create further objects during usage.\n /\nexport interface IRootDataObject {\n\t/\n\t Dynamically creates a new detached collaborative object (DDS/DataObject).\n\t \n\t @param objectClass - Type of the collaborative object to be created.\n\t \n\t @typeParam T - The class of the `DataObject` or `SharedObject`.\n\t /\n\tcreate<T>(objectClass: SharedObjectKind<T>): Promise<T>;\n\n\t/\n\t Upload a blob of data.\n\t * Although it is marked as internal, there is external usage of this function for experimental purposes.\n\t * Please contact yunho-microsoft or vladsud if you need to change it.\n\t * @param blob - blob to be uploaded.\n\t \n\t @remarks This method is used to expose uploadBlob to the IFluidContainer level. UploadBlob will upload data to server side (as of now, ODSP only). There is no downloadBlob provided as it is not needed(blob lifetime managed by server).\n\t /\n\tuploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>>;\n\n\t/\n\t Provides a record of the initial objects defined on creation.\n\t /\n\treadonly initialObjects: LoadableObjectRecord;\n}\n\ninterface IProvideStaticEntryPoint {\n\treadonly IStaticEntryPoint: IStaticEntryPoint;\n}\n\n/\n This is the internal entry point fluid-static creates.\n /\nexport interface IStaticEntryPoint extends IProvideStaticEntryPoint {\n\treadonly rootDataObject: IRootDataObject;\n\treadonly extensionStore: ContainerExtensionStore;\n}\n\n/\n Signature for {@link IMember} change events.\n \n @param clientId - A unique identifier for the client.\n * @param member - The service-specific member object for the client.\n \n @see See {@link IServiceAudienceEvents} for usage details.\n * @public\n /\nexport type MemberChangedListener<M extends IMember> = (clientId: string, member: M) => void;\n\n/\n Events that trigger when the roster of members in the Fluid session change.\n \n @remarks\n \n Only changes that would be reflected in the returned map of {@link IServiceAudience}'s\n * {@link IServiceAudience.getMembers} method will emit events.\n \n @typeParam M - A service-specific {@link IMember} implementation.\n * @public\n /\nexport interface IServiceAudienceEvents<M extends IMember> extends IEvent {\n\t/\n\t Emitted when a {@link IMember \| member}(s) are either added or removed.\n\t \n\t @eventProperty\n\t /\n\t(event: \"membersChanged\", listener: () => void): void;\n\n\t/\n\t Emitted when a {@link IMember \| member} joins the audience.\n\t \n\t @eventProperty\n\t /\n\t(event: \"memberAdded\", listener: MemberChangedListener<M>): void;\n\n\t/\n\t Emitted when a {@link IMember \| member} leaves the audience.\n\t \n\t @eventProperty\n\t /\n\t(event: \"memberRemoved\", listener: MemberChangedListener<M>): void;\n}\n\n/\n Base interface to be implemented to fetch each service's audience.\n \n @remarks\n \n The type parameter `M` allows consumers to further extend the client object with service-specific\n * details about the connecting client, such as device information, environment, or a username.\n \n @typeParam M - A service-specific {@link IMember} type.\n * @public\n /\nexport interface IServiceAudience<M extends IMember>\n\textends IEventProvider<IServiceAudienceEvents<M>> {\n\t/\n\t Returns an map of all users currently in the Fluid session where key is the userId and the value is the\n\t * member object. The implementation may choose to exclude certain connections from the returned map.\n\t * E.g. ServiceAudience excludes non-interactive connections to represent only the roster of live users.\n\t /\n\tgetMembers(): ReadonlyMap<string, M>;\n\n\t/\n\t Returns the current active user on this client once they are connected. Otherwise, returns undefined.\n\t /\n\tgetMyself(): Myself<M> \| undefined;\n}\n\n/\n Base interface for information for each connection made to the Fluid session.\n \n @remarks This interface can be extended to provide additional information specific to each service.\n * @public\n /\nexport interface IConnection {\n\t/\n\t A unique ID for the connection. A single user may have multiple connections, each with a different ID.\n\t /\n\treadonly id: string;\n\n\t/\n\t Whether the connection is in read or read/write mode.\n\t /\n\treadonly mode: \"write\" \| \"read\";\n}\n\n/\n Base interface to be implemented to fetch each service's member.\n \n @remarks This interface can be extended by each service to provide additional service-specific user metadata.\n * @public\n /\nexport interface IMember {\n\t/\n\t An ID for the user, unique among each individual user connecting to the session.\n\t /\n\treadonly id: string;\n\n\t/\n\t The set of connections the user has made, e.g. from multiple tabs or devices.\n\t /\n\treadonly connections: IConnection[];\n}\n\n/\n An extended member object that includes currentConnection\n * @public\n */\nexport type Myself<M extends IMember = IMember> = M & { readonly currentConnection: string };\n"]}
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 type { DataObjectKind } from \"@fluidframework/aqueduct/internal\";\nimport type { ContainerExtensionStore } from \"@fluidframework/container-runtime-definitions/internal\";\nimport type {\n\tIEvent,\n\tIEventProvider,\n\tIFluidHandle,\n\tIFluidLoadable,\n} from \"@fluidframework/core-interfaces\";\nimport type {\n\tISharedObjectKind,\n\tSharedObjectKind,\n} from \"@fluidframework/shared-object-base/internal\";\nimport type { ITree } from \"@fluidframework/tree\";\n\n/\n Determines the set of runtime options that Fluid Framework will use when running.\n * In \"1\" mode we support full interop between 2.x clients and 1.x clients,\n * while in \"2\" mode we only support interop between 2.x clients.\n \n @public\n /\nexport type CompatibilityMode = \"1\" \| \"2\";\n\n/\n A mapping of string identifiers to instantiated `DataObject`s or `SharedObject`s.\n /\nexport type LoadableObjectRecord = Record<string, IFluidLoadable>;\n\n/\n A mapping of string identifiers to classes that will later be used to instantiate a corresponding `DataObject`\n * or `SharedObject`.\n /\nexport type LoadableObjectKindRecord = Record<string, SharedObjectKind>;\n\n/\n A kind of `DataObject` or `SharedObject`.\n \n @typeParam T - The kind of `DataObject` or `SharedObject`.\n \n @privateRemarks\n * There are some edge cases in TypeScript where the order of the members in a union matter.\n * Once such edge case is when multiple members of a generic union partially match, and the type parameter is being inferred.\n * In this case, its better to have the desired match and/or the simpler type first.\n * In this case placing ISharedObjectKind fixed one usage and didn't break anything, and generally seems more likely to work than the reverse, so this is the order being used.\n * This is likely (a bug in TypeScript)[https://github.com/microsoft/TypeScript/issues/45809].\n /\nexport type LoadableObjectKind<T extends IFluidLoadable = IFluidLoadable> =\n\t\| ISharedObjectKind<T>\n\t\| DataObjectKind<T>;\n\n/\n Represents properties that can be attached to a container.\n * @public\n /\nexport type ContainerAttachProps<T = unknown> = T;\n\n/\n Declares the Fluid objects that will be available in the {@link IFluidContainer \| Container}.\n \n @remarks\n \n It includes both the instances of objects that are initially available upon `Container` creation, as well\n * as the types of objects that may be dynamically created throughout the lifetime of the `Container`.\n * @public\n /\nexport interface ContainerSchema {\n\t/\n\t Defines loadable objects that will be created when the {@link IFluidContainer \| Container} is first created.\n\t \n\t @remarks It uses the key as the id and the value as the loadable object to create.\n\t \n\t @example\n\t \n\t In the example below two objects will be created when the `Container` is first\n\t * created. One with id \"map1\" that will return a `SharedMap` and the other with\n\t * id \"pair1\" that will return a `KeyValueDataObject`.\n\t \n\t ```typescript\n\t * {\n\t * map1: SharedMap,\n\t * pair1: KeyValueDataObject,\n\t * }\n\t * ```\n\t /\n\treadonly initialObjects: Record<string, SharedObjectKind>;\n\n\t/\n\t Loadable objects that can be created after the initial {@link IFluidContainer \| Container} creation.\n\t \n\t @remarks\n\t \n\t Types defined in `initialObjects` will always be available and are not required to be provided here.\n\t \n\t For best practice it's recommended to define all the dynamic types you create even if they are\n\t * included via initialObjects.\n\t /\n\treadonly dynamicObjectTypes?: readonly SharedObjectKind[];\n}\n\n/\n Declares the Fluid objects that will be available in the {@link IFluidContainer \| Container}.\n \n @remarks\n \n It includes both the kind of `SharedTree` that will be initially available upon `Container` creation, as well\n * as the types of objects that may be dynamically created throughout the lifetime of the `Container`.\n \n @legacy @beta\n /\nexport interface TreeContainerSchema extends ContainerSchema {\n\t// TODO: longer term, it would be better to not have to fit into the `initialObjects` model for tree-based containers.\n\t// But in the short term, fitting into this model makes migration easier.\n\treadonly initialObjects: {\n\t\treadonly tree: SharedObjectKind<ITree>;\n\t};\n}\n\n/\n Holds the collection of objects that the container was initially created with.\n * Additionally provides the ability to dynamically create further objects during usage.\n /\nexport interface IRootDataObject {\n\t/\n\t Dynamically creates a new detached collaborative object (DDS/DataObject).\n\t \n\t @param objectClass - Type of the collaborative object to be created.\n\t \n\t @typeParam T - The class of the `DataObject` or `SharedObject`.\n\t /\n\tcreate<T>(objectClass: SharedObjectKind<T>): Promise<T>;\n\n\t/\n\t Upload a blob of data.\n\t * Although it is marked as internal, there is external usage of this function for experimental purposes.\n\t * Please contact yunho-microsoft or vladsud if you need to change it.\n\t * @param blob - blob to be uploaded.\n\t \n\t @remarks This method is used to expose uploadBlob to the IFluidContainer level. UploadBlob will upload data to server side (as of now, ODSP only). There is no downloadBlob provided as it is not needed(blob lifetime managed by server).\n\t /\n\tuploadBlob(blob: ArrayBufferLike): Promise<IFluidHandle<ArrayBufferLike>>;\n\n\t/\n\t Provides a record of the initial objects defined on creation.\n\t /\n\treadonly initialObjects: LoadableObjectRecord;\n}\n\ninterface IProvideStaticEntryPoint {\n\treadonly IStaticEntryPoint: IStaticEntryPoint;\n}\n\n/\n This is the internal entry point fluid-static creates.\n /\nexport interface IStaticEntryPoint extends IProvideStaticEntryPoint {\n\treadonly rootDataObject: IRootDataObject;\n\treadonly extensionStore: ContainerExtensionStore;\n}\n\n/\n Signature for {@link IMember} change events.\n \n @param clientId - A unique identifier for the client.\n * @param member - The service-specific member object for the client.\n \n @see See {@link IServiceAudienceEvents} for usage details.\n * @public\n /\nexport type MemberChangedListener<M extends IMember> = (clientId: string, member: M) => void;\n\n/\n Events that trigger when the roster of members in the Fluid session change.\n \n @remarks\n \n Only changes that would be reflected in the returned map of {@link IServiceAudience}'s\n * {@link IServiceAudience.getMembers} method will emit events.\n \n @typeParam M - A service-specific {@link IMember} implementation.\n * @public\n /\nexport interface IServiceAudienceEvents<M extends IMember> extends IEvent {\n\t/\n\t Emitted when a {@link IMember \| member}(s) are either added or removed.\n\t \n\t @eventProperty\n\t /\n\t(event: \"membersChanged\", listener: () => void): void;\n\n\t/\n\t Emitted when a {@link IMember \| member} joins the audience.\n\t \n\t @eventProperty\n\t /\n\t(event: \"memberAdded\", listener: MemberChangedListener<M>): void;\n\n\t/\n\t Emitted when a {@link IMember \| member} leaves the audience.\n\t \n\t @eventProperty\n\t /\n\t(event: \"memberRemoved\", listener: MemberChangedListener<M>): void;\n}\n\n/\n Base interface to be implemented to fetch each service's audience.\n \n @remarks\n \n The type parameter `M` allows consumers to further extend the client object with service-specific\n * details about the connecting client, such as device information, environment, or a username.\n \n @typeParam M - A service-specific {@link IMember} type.\n * @public\n /\nexport interface IServiceAudience<M extends IMember>\n\textends IEventProvider<IServiceAudienceEvents<M>> {\n\t/\n\t Returns an map of all users currently in the Fluid session where key is the userId and the value is the\n\t * member object. The implementation may choose to exclude certain connections from the returned map.\n\t * E.g. ServiceAudience excludes non-interactive connections to represent only the roster of live users.\n\t /\n\tgetMembers(): ReadonlyMap<string, M>;\n\n\t/\n\t Returns the current active user on this client once they are connected. Otherwise, returns undefined.\n\t /\n\tgetMyself(): Myself<M> \| undefined;\n}\n\n/\n Base interface for information for each connection made to the Fluid session.\n \n @remarks This interface can be extended to provide additional information specific to each service.\n * @public\n /\nexport interface IConnection {\n\t/\n\t A unique ID for the connection. A single user may have multiple connections, each with a different ID.\n\t /\n\treadonly id: string;\n\n\t/\n\t Whether the connection is in read or read/write mode.\n\t /\n\treadonly mode: \"write\" \| \"read\";\n}\n\n/\n Base interface to be implemented to fetch each service's member.\n \n @remarks This interface can be extended by each service to provide additional service-specific user metadata.\n * @public\n /\nexport interface IMember {\n\t/\n\t An ID for the user, unique among each individual user connecting to the session.\n\t /\n\treadonly id: string;\n\n\t/\n\t The set of connections the user has made, e.g. from multiple tabs or devices.\n\t /\n\treadonly connections: IConnection[];\n}\n\n/\n An extended member object that includes currentConnection\n * @public\n */\nexport type Myself<M extends IMember = IMember> = M & { readonly currentConnection: string };\n"]}

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/fluid-static",
-  "version": "2.53.1",
+  "version": "2.61.0-355054",
   "description": "A tool to enable consumption of Fluid Data Objects without requiring custom container code.",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -69,38 +69,38 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.53.1",
-    "@fluidframework/aqueduct": "~2.53.1",
-    "@fluidframework/container-definitions": "~2.53.1",
-    "@fluidframework/container-loader": "~2.53.1",
-    "@fluidframework/container-runtime": "~2.53.1",
-    "@fluidframework/container-runtime-definitions": "~2.53.1",
-    "@fluidframework/core-interfaces": "~2.53.1",
-    "@fluidframework/core-utils": "~2.53.1",
-    "@fluidframework/datastore-definitions": "~2.53.1",
-    "@fluidframework/driver-definitions": "~2.53.1",
-    "@fluidframework/request-handler": "~2.53.1",
-    "@fluidframework/runtime-definitions": "~2.53.1",
-    "@fluidframework/runtime-utils": "~2.53.1",
-    "@fluidframework/shared-object-base": "~2.53.1",
-    "@fluidframework/telemetry-utils": "~2.53.1",
-    "@fluidframework/tree": "~2.53.1"
+    "@fluid-internal/client-utils": "2.61.0-355054",
+    "@fluidframework/aqueduct": "2.61.0-355054",
+    "@fluidframework/container-definitions": "2.61.0-355054",
+    "@fluidframework/container-loader": "2.61.0-355054",
+    "@fluidframework/container-runtime": "2.61.0-355054",
+    "@fluidframework/container-runtime-definitions": "2.61.0-355054",
+    "@fluidframework/core-interfaces": "2.61.0-355054",
+    "@fluidframework/core-utils": "2.61.0-355054",
+    "@fluidframework/datastore-definitions": "2.61.0-355054",
+    "@fluidframework/driver-definitions": "2.61.0-355054",
+    "@fluidframework/request-handler": "2.61.0-355054",
+    "@fluidframework/runtime-definitions": "2.61.0-355054",
+    "@fluidframework/runtime-utils": "2.61.0-355054",
+    "@fluidframework/shared-object-base": "2.61.0-355054",
+    "@fluidframework/telemetry-utils": "2.61.0-355054",
+    "@fluidframework/tree": "2.61.0-355054"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "~2.53.1",
-    "@fluid-tools/build-cli": "^0.57.0",
+    "@fluid-internal/mocha-test-setup": "2.61.0-355054",
+    "@fluid-tools/build-cli": "^0.58.2",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.57.0",
-    "@fluidframework/eslint-config-fluid": "^5.7.4",
-    "@fluidframework/fluid-static-previous": "npm:@fluidframework/fluid-static@2.53.0",
-    "@fluidframework/map": "~2.53.1",
-    "@fluidframework/sequence": "~2.53.1",
-    "@microsoft/api-extractor": "7.52.8",
+    "@fluidframework/build-tools": "^0.58.2",
+    "@fluidframework/eslint-config-fluid": "^6.0.0",
+    "@fluidframework/fluid-static-previous": "npm:@fluidframework/fluid-static@2.60.0",
+    "@fluidframework/map": "2.61.0-355054",
+    "@fluidframework/sequence": "2.61.0-355054",
+    "@microsoft/api-extractor": "7.52.11",
     "@types/mocha": "^10.0.10",
     "@types/node": "^18.19.0",
-    "c8": "^8.0.1",
+    "c8": "^10.1.3",
     "concurrently": "^8.2.1",
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
@@ -116,8 +116,8 @@
   },
   "scripts": {
     "api": "fluid-build . --task api",
-    "api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
-    "api-extractor:esnext": "flub generate entrypoints --outDir ./lib --node10TypeCompat",
+    "api-extractor:commonjs": "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./dist",
+    "api-extractor:esnext": "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./lib --node10TypeCompat",
     "build": "fluid-build . --task build",
     "build:api-reports": "concurrently \"npm:build:api-reports:*\"",
     "build:api-reports:current": "api-extractor run --local --config api-extractor/api-extractor.current.json",
@@ -152,8 +152,8 @@
     "test": "npm run test:mocha",
     "test:coverage": "c8 npm test",
     "test:mocha": "npm run test:mocha:esm && echo skipping cjs to avoid overhead - npm run test:mocha:cjs",
-    "test:mocha:cjs": "mocha --recursive \"dist/test/**/*.spec.*js\"",
-    "test:mocha:esm": "mocha --recursive \"lib/test/**/*.spec.*js\"",
+    "test:mocha:cjs": "cross-env MOCHA_SPEC=dist/test mocha",
+    "test:mocha:esm": "mocha",
     "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
     "tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
     "typetests:gen": "flub generate typetests --dir . -v",

package/src/treeRootDataObject.ts CHANGED Viewed

@@ -200,7 +200,7 @@ class TreeRootDataObjectFactory extends TreeDataObjectFactory<TreeRootDataObject
  * The root data object's registry and shared objects are configured based on the provided
  * SharedTree and optionally data store registry.
  *
- * @legacy @alpha
+ * @legacy @beta
  */
 export function createTreeContainerRuntimeFactory(props: {
 	/**

package/src/types.ts CHANGED Viewed

@@ -110,7 +110,7 @@ export interface ContainerSchema {
  * It includes both the kind of `SharedTree` that will be initially available upon `Container` creation, as well
  * as the types of objects that may be dynamically created throughout the lifetime of the `Container`.
  *
- * @legacy @alpha
+ * @legacy @beta
  */
 export interface TreeContainerSchema extends ContainerSchema {
 	// TODO: longer term, it would be better to not have to fit into the `initialObjects` model for tree-based containers.

package/api-report/fluid-static.legacy.alpha.api.md DELETED Viewed

@@ -1,100 +0,0 @@
-## Alpha API Report File for "@fluidframework/fluid-static"
-> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
-```ts
-// @public
-export type CompatibilityMode = "1" | "2";
-// @public
-export type ContainerAttachProps<T = unknown> = T;
-// @public
-export interface ContainerSchema {
-    readonly dynamicObjectTypes?: readonly SharedObjectKind[];
-    readonly initialObjects: Record<string, SharedObjectKind>;
-}
-// @alpha @legacy
-export function createTreeContainerRuntimeFactory(props: {
-    readonly schema: TreeContainerSchema;
-    readonly compatibilityMode: CompatibilityMode;
-    readonly rootDataStoreRegistry?: IFluidDataStoreRegistry;
-    readonly runtimeOptionOverrides?: Partial<IContainerRuntimeOptions>;
-    readonly minVersionForCollabOverride?: MinimumVersionForCollab;
-}): IRuntimeFactory;
-// @public
-export interface IConnection {
-    readonly id: string;
-    readonly mode: "write" | "read";
-}
-// @public @sealed
-export interface IFluidContainer<TContainerSchema extends ContainerSchema = ContainerSchema> extends IEventProvider<IFluidContainerEvents> {
-    attach(props?: ContainerAttachProps): Promise<string>;
-    readonly attachState: AttachState;
-    connect(): void;
-    readonly connectionState: ConnectionState;
-    create<T extends IFluidLoadable>(objectClass: SharedObjectKind<T>): Promise<T>;
-    disconnect(): void;
-    dispose(): void;
-    readonly disposed: boolean;
-    readonly initialObjects: InitialObjects<TContainerSchema>;
-    readonly isDirty: boolean;
-}
-// @public @sealed
-export interface IFluidContainerEvents extends IEvent {
-    (event: "connected", listener: () => void): void;
-    (event: "disconnected", listener: () => void): void;
-    (event: "saved", listener: () => void): void;
-    (event: "dirty", listener: () => void): void;
-    (event: "disposed", listener: (error?: ICriticalContainerError) => void): any;
-}
-// @public
-export interface IMember {
-    readonly connections: IConnection[];
-    readonly id: string;
-}
-// @public
-export type InitialObjects<T extends ContainerSchema> = {
-    [K in keyof T["initialObjects"]]: T["initialObjects"][K] extends SharedObjectKind<infer TChannel> ? TChannel : never;
-};
-// @public
-export interface IServiceAudience<M extends IMember> extends IEventProvider<IServiceAudienceEvents<M>> {
-    getMembers(): ReadonlyMap<string, M>;
-    getMyself(): Myself<M> | undefined;
-}
-// @public
-export interface IServiceAudienceEvents<M extends IMember> extends IEvent {
-    // @eventProperty
-    (event: "membersChanged", listener: () => void): void;
-    // @eventProperty
-    (event: "memberAdded", listener: MemberChangedListener<M>): void;
-    // @eventProperty
-    (event: "memberRemoved", listener: MemberChangedListener<M>): void;
-}
-// @public
-export type MemberChangedListener<M extends IMember> = (clientId: string, member: M) => void;
-// @public
-export type Myself<M extends IMember = IMember> = M & {
-    readonly currentConnection: string;
-};
-// @alpha @legacy
-export interface TreeContainerSchema extends ContainerSchema {
-    // (undocumented)
-    readonly initialObjects: {
-        readonly tree: SharedObjectKind<ITree>;
-    };
-}
-```