@fluidframework/aqueduct 2.50.0 → 2.51.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @fluidframework/aqueduct
 
+## 2.51.0
+
+### Minor Changes
+
+- New "PureDataObject" implementation "TreeDataObject" added ([#25025](https://github.com/microsoft/FluidFramework/pull/25025)) [f4fbd2f582c](https://github.com/microsoft/FluidFramework/commit/f4fbd2f582c22e0b6fd06986b9b5dbb6b73396a4)
+
+  A new implementation of `PureDataObject` has been added: `TreeDataObject`.
+  Where `DataObject` stores its contents in a `SharedDirectory`, `TreeDataObject` stores its contents in a `SharedTree`.
+
 ## 2.50.0
 
 Dependency updates only.

package/api-report/aqueduct.legacy.alpha.api.md

@@ -139,4 +139,16 @@ export class PureDataObjectFactory<TObj extends PureDataObject<I>, I extends Dat
     readonly type: string;
 }
 
+// @alpha @legacy
+export abstract class TreeDataObject<TDataObjectTypes extends DataObjectTypes = DataObjectTypes> extends PureDataObject<TDataObjectTypes> {
+    // (undocumented)
+    initializeInternal(existing: boolean): Promise<void>;
+    protected get tree(): ITree;
+}
+
+// @alpha @legacy
+export class TreeDataObjectFactory<TDataObject extends TreeDataObject<TDataObjectTypes>, TDataObjectTypes extends DataObjectTypes = DataObjectTypes> extends PureDataObjectFactory<TDataObject, TDataObjectTypes> {
+    constructor(props: DataObjectFactoryProps<TDataObject, TDataObjectTypes>);
+}
+
 ```

package/dist/data-object-factories/index.d.ts

@@ -4,4 +4,5 @@
  */
 export { DataObjectFactory } from "./dataObjectFactory.js";
 export { type DataObjectFactoryProps, PureDataObjectFactory, } from "./pureDataObjectFactory.js";
+export { TreeDataObjectFactory } from "./treeDataObjectFactory.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/data-object-factories/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/data-object-factories/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EACN,KAAK,sBAAsB,EAC3B,qBAAqB,GACrB,MAAM,4BAA4B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/data-object-factories/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EACN,KAAK,sBAAsB,EAC3B,qBAAqB,GACrB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC"}

package/dist/data-object-factories/index.js

@@ -4,9 +4,11 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PureDataObjectFactory = exports.DataObjectFactory = void 0;
+exports.TreeDataObjectFactory = exports.PureDataObjectFactory = exports.DataObjectFactory = void 0;
 var dataObjectFactory_js_1 = require("./dataObjectFactory.js");
 Object.defineProperty(exports, "DataObjectFactory", { enumerable: true, get: function () { return dataObjectFactory_js_1.DataObjectFactory; } });
 var pureDataObjectFactory_js_1 = require("./pureDataObjectFactory.js");
 Object.defineProperty(exports, "PureDataObjectFactory", { enumerable: true, get: function () { return pureDataObjectFactory_js_1.PureDataObjectFactory; } });
+var treeDataObjectFactory_js_1 = require("./treeDataObjectFactory.js");
+Object.defineProperty(exports, "TreeDataObjectFactory", { enumerable: true, get: function () { return treeDataObjectFactory_js_1.TreeDataObjectFactory; } });
 //# sourceMappingURL=index.js.map

package/dist/data-object-factories/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/data-object-factories/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAA2D;AAAlD,yHAAA,iBAAiB,OAAA;AAC1B,uEAGoC;AADnC,iIAAA,qBAAqB,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { DataObjectFactory } from \"./dataObjectFactory.js\";\nexport {\n\ttype DataObjectFactoryProps,\n\tPureDataObjectFactory,\n} from \"./pureDataObjectFactory.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/data-object-factories/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,+DAA2D;AAAlD,yHAAA,iBAAiB,OAAA;AAC1B,uEAGoC;AADnC,iIAAA,qBAAqB,OAAA;AAEtB,uEAAmE;AAA1D,iIAAA,qBAAqB,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { DataObjectFactory } from \"./dataObjectFactory.js\";\nexport {\n\ttype DataObjectFactoryProps,\n\tPureDataObjectFactory,\n} from \"./pureDataObjectFactory.js\";\nexport { TreeDataObjectFactory } from \"./treeDataObjectFactory.js\";\n"]}

package/dist/data-object-factories/treeDataObjectFactory.d.ts

@@ -0,0 +1,18 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { DataObjectTypes, TreeDataObject } from "../data-objects/index.js";
+import { PureDataObjectFactory, type DataObjectFactoryProps } from "./pureDataObjectFactory.js";
+/**
+ * {@link @fluidframework/runtime-definitions#IFluidDataStoreFactory} for use with {@link TreeDataObject}s.
+ *
+ * @typeParam TDataObject - The concrete TreeDataObject implementation.
+ * @typeParam TDataObjectTypes - The input types for the DataObject
+ *
+ * @legacy @alpha
+ */
+export declare class TreeDataObjectFactory<TDataObject extends TreeDataObject<TDataObjectTypes>, TDataObjectTypes extends DataObjectTypes = DataObjectTypes> extends PureDataObjectFactory<TDataObject, TDataObjectTypes> {
+    constructor(props: DataObjectFactoryProps<TDataObject, TDataObjectTypes>);
+}
+//# sourceMappingURL=treeDataObjectFactory.d.ts.map

package/dist/data-object-factories/treeDataObjectFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"treeDataObjectFactory.d.ts","sourceRoot":"","sources":["../../src/data-object-factories/treeDataObjectFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAEhF,OAAO,EACN,qBAAqB,EACrB,KAAK,sBAAsB,EAC3B,MAAM,4BAA4B,CAAC;AAEpC;;;;;;;GAOG;AACH,qBAAa,qBAAqB,CACjC,WAAW,SAAS,cAAc,CAAC,gBAAgB,CAAC,EACpD,gBAAgB,SAAS,eAAe,GAAG,eAAe,CACzD,SAAQ,qBAAqB,CAAC,WAAW,EAAE,gBAAgB,CAAC;gBAC1C,KAAK,EAAE,sBAAsB,CAAC,WAAW,EAAE,gBAAgB,CAAC;CAiB/E"}

package/dist/data-object-factories/treeDataObjectFactory.js

@@ -0,0 +1,32 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TreeDataObjectFactory = void 0;
+const internal_1 = require("@fluidframework/tree/internal");
+const pureDataObjectFactory_js_1 = require("./pureDataObjectFactory.js");
+/**
+ * {@link @fluidframework/runtime-definitions#IFluidDataStoreFactory} for use with {@link TreeDataObject}s.
+ *
+ * @typeParam TDataObject - The concrete TreeDataObject implementation.
+ * @typeParam TDataObjectTypes - The input types for the DataObject
+ *
+ * @legacy @alpha
+ */
+class TreeDataObjectFactory extends pureDataObjectFactory_js_1.PureDataObjectFactory {
+    constructor(props) {
+        const newProps = {
+            ...props,
+            sharedObjects: props.sharedObjects ? [...props.sharedObjects] : [],
+        };
+        // If the user did not specify a SharedTree factory, add it to the shared objects.
+        if (!newProps.sharedObjects.some((sharedObject) => sharedObject.type === internal_1.SharedTree.getFactory().type)) {
+            newProps.sharedObjects.push(internal_1.SharedTree.getFactory());
+        }
+        super(newProps);
+    }
+}
+exports.TreeDataObjectFactory = TreeDataObjectFactory;
+//# sourceMappingURL=treeDataObjectFactory.js.map

package/dist/data-object-factories/treeDataObjectFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"treeDataObjectFactory.js","sourceRoot":"","sources":["../../src/data-object-factories/treeDataObjectFactory.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,4DAA2D;AAI3D,yEAGoC;AAEpC;;;;;;;GAOG;AACH,MAAa,qBAGX,SAAQ,gDAAoD;IAC7D,YAAmB,KAA4D;QAC9E,MAAM,QAAQ,GAAG;YAChB,GAAG,KAAK;YACR,aAAa,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,EAAE;SAClE,CAAC;QAEF,kFAAkF;QAClF,IACC,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAC3B,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,KAAK,qBAAU,CAAC,UAAU,EAAE,CAAC,IAAI,CACpE,EACA,CAAC;YACF,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,qBAAU,CAAC,UAAU,EAAE,CAAC,CAAC;QACtD,CAAC;QAED,KAAK,CAAC,QAAQ,CAAC,CAAC;IACjB,CAAC;CACD;AArBD,sDAqBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { SharedTree } from \"@fluidframework/tree/internal\";\n\nimport type { DataObjectTypes, TreeDataObject } from \"../data-objects/index.js\";\n\nimport {\n\tPureDataObjectFactory,\n\ttype DataObjectFactoryProps,\n} from \"./pureDataObjectFactory.js\";\n\n/**\n * {@link @fluidframework/runtime-definitions#IFluidDataStoreFactory} for use with {@link TreeDataObject}s.\n *\n * @typeParam TDataObject - The concrete TreeDataObject implementation.\n * @typeParam TDataObjectTypes - The input types for the DataObject\n *\n * @legacy @alpha\n */\nexport class TreeDataObjectFactory<\n\tTDataObject extends TreeDataObject<TDataObjectTypes>,\n\tTDataObjectTypes extends DataObjectTypes = DataObjectTypes,\n> extends PureDataObjectFactory<TDataObject, TDataObjectTypes> {\n\tpublic constructor(props: DataObjectFactoryProps<TDataObject, TDataObjectTypes>) {\n\t\tconst newProps = {\n\t\t\t...props,\n\t\t\tsharedObjects: props.sharedObjects ? [...props.sharedObjects] : [],\n\t\t};\n\n\t\t// If the user did not specify a SharedTree factory, add it to the shared objects.\n\t\tif (\n\t\t\t!newProps.sharedObjects.some(\n\t\t\t\t(sharedObject) => sharedObject.type === SharedTree.getFactory().type,\n\t\t\t)\n\t\t) {\n\t\t\tnewProps.sharedObjects.push(SharedTree.getFactory());\n\t\t}\n\n\t\tsuper(newProps);\n\t}\n}\n"]}

package/dist/data-objects/treeDataObject.d.ts

@@ -4,48 +4,54 @@
  */
 import { type ITree } from "@fluidframework/tree/internal";
 import { PureDataObject } from "./pureDataObject.js";
+import type { DataObjectTypes } from "./types.js";
 /**
- * {@link @fluidframework/tree#SharedTree}-backed {@link PureDataObject | data object}.
+ * A {@link PureDataObject | data object} backed by a {@link @fluidframework/tree#ITree}.
  *
  * @remarks
  *
- * Note: to initialize the tree's data for initial creation, implementers of this class will need to override {@link PureDataObject.initializingFirstTime} and set the data in {@link TreeDataObject.treeView}.
+ * In order to view the tree's data, consumers of this type will need to apply the appropriate view schema to the {@link TreeDataObject.tree}.
+ * This will generally be done via {@link PureDataObject.initializingFromExisting} and {@link PureDataObject.initializingFirstTime} methods.
  *
- * @typeParam TTreeView - View derived from the underlying tree.
- * Can be used to derive schema-aware views of the tree.
- * See {@link TreeDataObject.generateView}.
+ * To initialize the tree's data for initial creation, implementers of this class will need to override {@link PureDataObject.initializingFirstTime} and set the data in the schema-aware view.
+ *
+ * @typeParam TDataObjectTypes - The optional input types used to strongly type the data object.
  *
  * @example Implementing `initializingFirstTime`
  *
  * ```typescript
  * protected override async initializingFirstTime(): Promise<void> {
- * 	this.tree.initialize(...);
+ * 	// Generate the schema-aware view of the tree.
+ * 	this.treeView = this.tree.viewWith(treeViewConfiguration);
+ *
+ * 	// Initialize the tree with initial data.
+ * 	this.treeView.initialize(initialTree);
+ * }
+ * ```
+ *
+ * @example Implementing `initializingFromExisting`
+ *
+ * ```typescript
+ * protected override async initializingFromExisting(): Promise<void> {
+ * 	// Generate the schema-aware view of the tree.
+ * 	this.treeView = this.tree.viewWith(treeViewConfiguration);
+ *
+ *  // Ensure the loaded tree is compatible with the view schema.
+ * 	if (!this.treeView.compatibility.canView) {
+ * 		// Handle out-of-schema data as appropriate.
+ * 	}
  * }
  * ```
  *
- * @internal
+ * @legacy @alpha
  */
-export declare abstract class TreeDataObject<TTreeView> extends PureDataObject {
+export declare abstract class TreeDataObject<TDataObjectTypes extends DataObjectTypes = DataObjectTypes> extends PureDataObject<TDataObjectTypes> {
     #private;
     /**
-     * Generates a view of the data object's {@link @fluidframework/tree#ITree | tree}.
-     * @remarks Called once during initialization.
-     */
-    protected abstract generateView(tree: ITree): TTreeView;
-    /**
-     * Gets the underlying {@link @fluidframework/tree#ITree | tree}.
-     * @remarks
-     * Note: in most cases, you will want to use {@link TreeDataObject.treeView} instead.
-     * Created once during initialization.
-     */
-    protected get sharedTree(): ITree;
-    /**
-     * Gets the derived view of the underlying tree.
-     *
-     * @throws
-     * If the tree has not yet been initialized, this will throw an error.
+     * The underlying {@link @fluidframework/tree#ITree | tree}.
+     * @remarks Created once during initialization.
      */
-    get treeView(): TTreeView;
+    protected get tree(): ITree;
     initializeInternal(existing: boolean): Promise<void>;
 }
 //# sourceMappingURL=treeDataObject.d.ts.map

package/dist/data-objects/treeDataObject.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"treeDataObject.d.ts","sourceRoot":"","sources":["../../src/data-objects/treeDataObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,KAAK,KAAK,EAAc,MAAM,+BAA+B,CAAC;AAEvE,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAUrD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,8BAAsB,cAAc,CAAC,SAAS,CAAE,SAAQ,cAAc;;IACrE;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,GAAG,SAAS;IAQvD;;;;;OAKG;IACH,SAAS,KAAK,UAAU,IAAI,KAAK,CAKhC;IAQD;;;;;OAKG;IACH,IAAW,QAAQ,IAAI,SAAS,CAK/B;IAEqB,kBAAkB,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CA6B1E"}
+{"version":3,"file":"treeDataObject.d.ts","sourceRoot":"","sources":["../../src/data-objects/treeDataObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAc,KAAK,KAAK,EAAE,MAAM,+BAA+B,CAAC;AAEvE,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAWlD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,8BAAsB,cAAc,CACnC,gBAAgB,SAAS,eAAe,GAAG,eAAe,CACzD,SAAQ,cAAc,CAAC,gBAAgB,CAAC;;IAOzC;;;OAGG;IACH,SAAS,KAAK,IAAI,IAAI,KAAK,CAK1B;IAEqB,kBAAkB,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CA8B1E"}

package/dist/data-objects/treeDataObject.js

@@ -14,7 +14,7 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
     return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
 };
-var _TreeDataObject_sharedTree, _TreeDataObject_view;
+var _TreeDataObject_tree;
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TreeDataObject = void 0;
 const internal_1 = require("@fluidframework/telemetry-utils/internal");
@@ -22,67 +22,68 @@ const internal_2 = require("@fluidframework/tree/internal");
 const pureDataObject_js_1 = require("./pureDataObject.js");
 /**
  * Channel ID of {@link TreeDataObject}'s root {@link @fluidframework/tree#SharedTree}.
+ * @privateRemarks This key is persisted and should not be changed without a migration strategy.
  */
-const treeChannelId = "tree-data-object";
+const treeChannelId = "root-tree";
 const uninitializedErrorString = "The tree has not yet been initialized. The data object must be initialized before accessing.";
 /**
- * {@link @fluidframework/tree#SharedTree}-backed {@link PureDataObject | data object}.
+ * A {@link PureDataObject | data object} backed by a {@link @fluidframework/tree#ITree}.
  *
  * @remarks
  *
- * Note: to initialize the tree's data for initial creation, implementers of this class will need to override {@link PureDataObject.initializingFirstTime} and set the data in {@link TreeDataObject.treeView}.
+ * In order to view the tree's data, consumers of this type will need to apply the appropriate view schema to the {@link TreeDataObject.tree}.
+ * This will generally be done via {@link PureDataObject.initializingFromExisting} and {@link PureDataObject.initializingFirstTime} methods.
  *
- * @typeParam TTreeView - View derived from the underlying tree.
- * Can be used to derive schema-aware views of the tree.
- * See {@link TreeDataObject.generateView}.
+ * To initialize the tree's data for initial creation, implementers of this class will need to override {@link PureDataObject.initializingFirstTime} and set the data in the schema-aware view.
+ *
+ * @typeParam TDataObjectTypes - The optional input types used to strongly type the data object.
  *
  * @example Implementing `initializingFirstTime`
  *
  * ```typescript
  * protected override async initializingFirstTime(): Promise<void> {
- * 	this.tree.initialize(...);
+ * 	// Generate the schema-aware view of the tree.
+ * 	this.treeView = this.tree.viewWith(treeViewConfiguration);
+ *
+ * 	// Initialize the tree with initial data.
+ * 	this.treeView.initialize(initialTree);
+ * }
+ * ```
+ *
+ * @example Implementing `initializingFromExisting`
+ *
+ * ```typescript
+ * protected override async initializingFromExisting(): Promise<void> {
+ * 	// Generate the schema-aware view of the tree.
+ * 	this.treeView = this.tree.viewWith(treeViewConfiguration);
+ *
+ *  // Ensure the loaded tree is compatible with the view schema.
+ * 	if (!this.treeView.compatibility.canView) {
+ * 		// Handle out-of-schema data as appropriate.
+ * 	}
  * }
  * ```
  *
- * @internal
+ * @legacy @alpha
  */
 class TreeDataObject extends pureDataObject_js_1.PureDataObject {
     constructor() {
         super(...arguments);
         /**
-         * Implementation of SharedTree which is used to generate the view.
+         * The underlying {@link @fluidframework/tree#ITree | tree}.
          * @remarks Created once during initialization.
          */
-        _TreeDataObject_sharedTree.set(this, void 0);
-        /**
-         * View derived from the underlying tree.
-         * @remarks Populated via {@link TreeDataObject.generateView}.
-         */
-        _TreeDataObject_view.set(this, void 0);
-    }
-    /**
-     * Gets the underlying {@link @fluidframework/tree#ITree | tree}.
-     * @remarks
-     * Note: in most cases, you will want to use {@link TreeDataObject.treeView} instead.
-     * Created once during initialization.
-     */
-    get sharedTree() {
-        if (__classPrivateFieldGet(this, _TreeDataObject_sharedTree, "f") === undefined) {
-            throw new internal_1.UsageError(uninitializedErrorString);
-        }
-        return __classPrivateFieldGet(this, _TreeDataObject_sharedTree, "f");
+        _TreeDataObject_tree.set(this, void 0);
     }
     /**
-     * Gets the derived view of the underlying tree.
-     *
-     * @throws
-     * If the tree has not yet been initialized, this will throw an error.
+     * The underlying {@link @fluidframework/tree#ITree | tree}.
+     * @remarks Created once during initialization.
      */
-    get treeView() {
-        if (__classPrivateFieldGet(this, _TreeDataObject_view, "f") === undefined) {
+    get tree() {
+        if (__classPrivateFieldGet(this, _TreeDataObject_tree, "f") === undefined) {
             throw new internal_1.UsageError(uninitializedErrorString);
         }
-        return __classPrivateFieldGet(this, _TreeDataObject_view, "f");
+        return __classPrivateFieldGet(this, _TreeDataObject_tree, "f");
     }
     async initializeInternal(existing) {
         if (existing) {
@@ -94,14 +95,12 @@ class TreeDataObject extends pureDataObject_js_1.PureDataObject {
                 throw new Error(`Content with id ${channel.id} is not a SharedTree and cannot be loaded with treeDataObject.`);
             }
             const sharedTree = channel;
-            __classPrivateFieldSet(this, _TreeDataObject_sharedTree, sharedTree, "f");
-            __classPrivateFieldSet(this, _TreeDataObject_view, this.generateView(sharedTree), "f");
+            __classPrivateFieldSet(this, _TreeDataObject_tree, sharedTree, "f");
         }
         else {
-            const sharedTree = internal_2.SharedTree.create(this.runtime, treeChannelId);
+            const sharedTree = this.runtime.createChannel(treeChannelId, internal_2.SharedTree.getFactory().type);
             sharedTree.bindToContext();
-            __classPrivateFieldSet(this, _TreeDataObject_sharedTree, sharedTree, "f");
-            __classPrivateFieldSet(this, _TreeDataObject_view, this.generateView(sharedTree), "f");
+            __classPrivateFieldSet(this, _TreeDataObject_tree, sharedTree, "f");
             // Note, the implementer is responsible for initializing the tree with initial data.
             // Generally, this can be done via `initializingFirstTime`.
         }
@@ -109,5 +108,5 @@ class TreeDataObject extends pureDataObject_js_1.PureDataObject {
     }
 }
 exports.TreeDataObject = TreeDataObject;
-_TreeDataObject_sharedTree = new WeakMap(), _TreeDataObject_view = new WeakMap();
+_TreeDataObject_tree = new WeakMap();
 //# sourceMappingURL=treeDataObject.js.map

package/dist/data-objects/treeDataObject.js.map

@@ -1 +1 @@
-{"version":3,"file":"treeDataObject.js","sourceRoot":"","sources":["../../src/data-objects/treeDataObject.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;AAGH,uEAAsE;AACtE,4DAAuE;AAEvE,2DAAqD;AAErD;;GAEG;AACH,MAAM,aAAa,GAAG,kBAAkB,CAAC;AAEzC,MAAM,wBAAwB,GAC7B,8FAA8F,CAAC;AAEhG;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAsB,cAA0B,SAAQ,kCAAc;IAAtE;;QAOC;;;WAGG;QACH,6CAA+B;QAe/B;;;WAGG;QACH,uCAA6B;IA4C9B,CAAC;IA7DA;;;;;OAKG;IACH,IAAc,UAAU;QACvB,IAAI,uBAAA,IAAI,kCAAY,KAAK,SAAS,EAAE,CAAC;YACpC,MAAM,IAAI,qBAAU,CAAC,wBAAwB,CAAC,CAAC;QAChD,CAAC;QACD,OAAO,uBAAA,IAAI,kCAAY,CAAC;IACzB,CAAC;IAQD;;;;;OAKG;IACH,IAAW,QAAQ;QAClB,IAAI,uBAAA,IAAI,4BAAM,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM,IAAI,qBAAU,CAAC,wBAAwB,CAAC,CAAC;QAChD,CAAC;QACD,OAAO,uBAAA,IAAI,4BAAM,CAAC;IACnB,CAAC;IAEe,KAAK,CAAC,kBAAkB,CAAC,QAAiB;QACzD,IAAI,QAAQ,EAAE,CAAC;YACd,+FAA+F;YAC/F,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;YAE7D,0FAA0F;YAC1F,8FAA8F;YAC9F,IAAI,CAAC,qBAAU,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC7B,MAAM,IAAI,KAAK,CACd,mBAAmB,OAAO,CAAC,EAAE,gEAAgE,CAC7F,CAAC;YACH,CAAC;YACD,MAAM,UAAU,GAAU,OAAO,CAAC;YAElC,uBAAA,IAAI,8BAAe,UAAU,MAAA,CAAC;YAC9B,uBAAA,IAAI,wBAAS,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,MAAA,CAAC;QAC5C,CAAC;aAAM,CAAC;YACP,MAAM,UAAU,GAAG,qBAAU,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;YACjE,UAAuC,CAAC,aAAa,EAAE,CAAC;YAEzD,uBAAA,IAAI,8BAAe,UAAU,MAAA,CAAC;YAC9B,uBAAA,IAAI,wBAAS,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,MAAA,CAAC;YAE3C,oFAAoF;YACpF,2DAA2D;QAC5D,CAAC;QAED,MAAM,KAAK,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC;CACD;AA1ED,wCA0EC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ISharedObject } from \"@fluidframework/shared-object-base/internal\";\nimport { UsageError } from \"@fluidframework/telemetry-utils/internal\";\nimport { type ITree, SharedTree } from \"@fluidframework/tree/internal\";\n\nimport { PureDataObject } from \"./pureDataObject.js\";\n\n/**\n * Channel ID of {@link TreeDataObject}'s root {@link @fluidframework/tree#SharedTree}.\n */\nconst treeChannelId = \"tree-data-object\";\n\nconst uninitializedErrorString =\n\t\"The tree has not yet been initialized. The data object must be initialized before accessing.\";\n\n/**\n * {@link @fluidframework/tree#SharedTree}-backed {@link PureDataObject | data object}.\n *\n * @remarks\n *\n * Note: to initialize the tree's data for initial creation, implementers of this class will need to override {@link PureDataObject.initializingFirstTime} and set the data in {@link TreeDataObject.treeView}.\n *\n * @typeParam TTreeView - View derived from the underlying tree.\n * Can be used to derive schema-aware views of the tree.\n * See {@link TreeDataObject.generateView}.\n *\n * @example Implementing `initializingFirstTime`\n *\n * ```typescript\n * protected override async initializingFirstTime(): Promise<void> {\n * \tthis.tree.initialize(...);\n * }\n * ```\n *\n * @internal\n */\nexport abstract class TreeDataObject<TTreeView> extends PureDataObject {\n\t/**\n\t * Generates a view of the data object's {@link @fluidframework/tree#ITree | tree}.\n\t * @remarks Called once during initialization.\n\t */\n\tprotected abstract generateView(tree: ITree): TTreeView;\n\n\t/**\n\t * Implementation of SharedTree which is used to generate the view.\n\t * @remarks Created once during initialization.\n\t */\n\t#sharedTree: ITree | undefined;\n\n\t/**\n\t * Gets the underlying {@link @fluidframework/tree#ITree | tree}.\n\t * @remarks\n\t * Note: in most cases, you will want to use {@link TreeDataObject.treeView} instead.\n\t * Created once during initialization.\n\t */\n\tprotected get sharedTree(): ITree {\n\t\tif (this.#sharedTree === undefined) {\n\t\t\tthrow new UsageError(uninitializedErrorString);\n\t\t}\n\t\treturn this.#sharedTree;\n\t}\n\n\t/**\n\t * View derived from the underlying tree.\n\t * @remarks Populated via {@link TreeDataObject.generateView}.\n\t */\n\t#view: TTreeView | undefined;\n\n\t/**\n\t * Gets the derived view of the underlying tree.\n\t *\n\t * @throws\n\t * If the tree has not yet been initialized, this will throw an error.\n\t */\n\tpublic get treeView(): TTreeView {\n\t\tif (this.#view === undefined) {\n\t\t\tthrow new UsageError(uninitializedErrorString);\n\t\t}\n\t\treturn this.#view;\n\t}\n\n\tpublic override async initializeInternal(existing: boolean): Promise<void> {\n\t\tif (existing) {\n\t\t\t// data store has a root tree so we just need to set it before calling initializingFromExisting\n\t\t\tconst channel = await this.runtime.getChannel(treeChannelId);\n\n\t\t\t// TODO: Support using a Directory to Tree migration shim and DataObject's root channel ID\n\t\t\t// to allow migrating from DataObject to TreeDataObject instead of just erroring in that case.\n\t\t\tif (!SharedTree.is(channel)) {\n\t\t\t\tthrow new Error(\n\t\t\t\t\t`Content with id ${channel.id} is not a SharedTree and cannot be loaded with treeDataObject.`,\n\t\t\t\t);\n\t\t\t}\n\t\t\tconst sharedTree: ITree = channel;\n\n\t\t\tthis.#sharedTree = sharedTree;\n\t\t\tthis.#view = this.generateView(sharedTree);\n\t\t} else {\n\t\t\tconst sharedTree = SharedTree.create(this.runtime, treeChannelId);\n\t\t\t(sharedTree as unknown as ISharedObject).bindToContext();\n\n\t\t\tthis.#sharedTree = sharedTree;\n\t\t\tthis.#view = this.generateView(sharedTree);\n\n\t\t\t// Note, the implementer is responsible for initializing the tree with initial data.\n\t\t\t// Generally, this can be done via `initializingFirstTime`.\n\t\t}\n\n\t\tawait super.initializeInternal(existing);\n\t}\n}\n"]}
+{"version":3,"file":"treeDataObject.js","sourceRoot":"","sources":["../../src/data-objects/treeDataObject.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;;;;;;;;;;;;;AAGH,uEAAsE;AACtE,4DAAuE;AAEvE,2DAAqD;AAGrD;;;GAGG;AACH,MAAM,aAAa,GAAG,WAAW,CAAC;AAElC,MAAM,wBAAwB,GAC7B,8FAA8F,CAAC;AAEhG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAsB,cAEpB,SAAQ,kCAAgC;IAF1C;;QAGC;;;WAGG;QACH,uCAAyB;IA2C1B,CAAC;IAzCA;;;OAGG;IACH,IAAc,IAAI;QACjB,IAAI,uBAAA,IAAI,4BAAM,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM,IAAI,qBAAU,CAAC,wBAAwB,CAAC,CAAC;QAChD,CAAC;QACD,OAAO,uBAAA,IAAI,4BAAM,CAAC;IACnB,CAAC;IAEe,KAAK,CAAC,kBAAkB,CAAC,QAAiB;QACzD,IAAI,QAAQ,EAAE,CAAC;YACd,+FAA+F;YAC/F,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;YAE7D,0FAA0F;YAC1F,8FAA8F;YAC9F,IAAI,CAAC,qBAAU,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC7B,MAAM,IAAI,KAAK,CACd,mBAAmB,OAAO,CAAC,EAAE,gEAAgE,CAC7F,CAAC;YACH,CAAC;YACD,MAAM,UAAU,GAAU,OAAO,CAAC;YAElC,uBAAA,IAAI,wBAAS,UAAU,MAAA,CAAC;QACzB,CAAC;aAAM,CAAC;YACP,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAC5C,aAAa,EACb,qBAAU,CAAC,UAAU,EAAE,CAAC,IAAI,CACR,CAAC;YACrB,UAAuC,CAAC,aAAa,EAAE,CAAC;YAEzD,uBAAA,IAAI,wBAAS,UAAU,MAAA,CAAC;YAExB,oFAAoF;YACpF,2DAA2D;QAC5D,CAAC;QAED,MAAM,KAAK,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC;CACD;AAlDD,wCAkDC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ISharedObject } from \"@fluidframework/shared-object-base/internal\";\nimport { UsageError } from \"@fluidframework/telemetry-utils/internal\";\nimport { SharedTree, type ITree } from \"@fluidframework/tree/internal\";\n\nimport { PureDataObject } from \"./pureDataObject.js\";\nimport type { DataObjectTypes } from \"./types.js\";\n\n/**\n * Channel ID of {@link TreeDataObject}'s root {@link @fluidframework/tree#SharedTree}.\n * @privateRemarks This key is persisted and should not be changed without a migration strategy.\n */\nconst treeChannelId = \"root-tree\";\n\nconst uninitializedErrorString =\n\t\"The tree has not yet been initialized. The data object must be initialized before accessing.\";\n\n/**\n * A {@link PureDataObject | data object} backed by a {@link @fluidframework/tree#ITree}.\n *\n * @remarks\n *\n * In order to view the tree's data, consumers of this type will need to apply the appropriate view schema to the {@link TreeDataObject.tree}.\n * This will generally be done via {@link PureDataObject.initializingFromExisting} and {@link PureDataObject.initializingFirstTime} methods.\n *\n * To initialize the tree's data for initial creation, implementers of this class will need to override {@link PureDataObject.initializingFirstTime} and set the data in the schema-aware view.\n *\n * @typeParam TDataObjectTypes - The optional input types used to strongly type the data object.\n *\n * @example Implementing `initializingFirstTime`\n *\n * ```typescript\n * protected override async initializingFirstTime(): Promise<void> {\n * \t// Generate the schema-aware view of the tree.\n * \tthis.treeView = this.tree.viewWith(treeViewConfiguration);\n *\n * \t// Initialize the tree with initial data.\n * \tthis.treeView.initialize(initialTree);\n * }\n * ```\n *\n * @example Implementing `initializingFromExisting`\n *\n * ```typescript\n * protected override async initializingFromExisting(): Promise<void> {\n * \t// Generate the schema-aware view of the tree.\n * \tthis.treeView = this.tree.viewWith(treeViewConfiguration);\n *\n *  // Ensure the loaded tree is compatible with the view schema.\n * \tif (!this.treeView.compatibility.canView) {\n * \t\t// Handle out-of-schema data as appropriate.\n * \t}\n * }\n * ```\n *\n * @legacy @alpha\n */\nexport abstract class TreeDataObject<\n\tTDataObjectTypes extends DataObjectTypes = DataObjectTypes,\n> extends PureDataObject<TDataObjectTypes> {\n\t/**\n\t * The underlying {@link @fluidframework/tree#ITree | tree}.\n\t * @remarks Created once during initialization.\n\t */\n\t#tree: ITree | undefined;\n\n\t/**\n\t * The underlying {@link @fluidframework/tree#ITree | tree}.\n\t * @remarks Created once during initialization.\n\t */\n\tprotected get tree(): ITree {\n\t\tif (this.#tree === undefined) {\n\t\t\tthrow new UsageError(uninitializedErrorString);\n\t\t}\n\t\treturn this.#tree;\n\t}\n\n\tpublic override async initializeInternal(existing: boolean): Promise<void> {\n\t\tif (existing) {\n\t\t\t// data store has a root tree so we just need to set it before calling initializingFromExisting\n\t\t\tconst channel = await this.runtime.getChannel(treeChannelId);\n\n\t\t\t// TODO: Support using a Directory to Tree migration shim and DataObject's root channel ID\n\t\t\t// to allow migrating from DataObject to TreeDataObject instead of just erroring in that case.\n\t\t\tif (!SharedTree.is(channel)) {\n\t\t\t\tthrow new Error(\n\t\t\t\t\t`Content with id ${channel.id} is not a SharedTree and cannot be loaded with treeDataObject.`,\n\t\t\t\t);\n\t\t\t}\n\t\t\tconst sharedTree: ITree = channel;\n\n\t\t\tthis.#tree = sharedTree;\n\t\t} else {\n\t\t\tconst sharedTree = this.runtime.createChannel(\n\t\t\t\ttreeChannelId,\n\t\t\t\tSharedTree.getFactory().type,\n\t\t\t) as unknown as ITree;\n\t\t\t(sharedTree as unknown as ISharedObject).bindToContext();\n\n\t\t\tthis.#tree = sharedTree;\n\n\t\t\t// Note, the implementer is responsible for initializing the tree with initial data.\n\t\t\t// Generally, this can be done via `initializingFirstTime`.\n\t\t}\n\n\t\tawait super.initializeInternal(existing);\n\t}\n}\n"]}

package/dist/index.d.ts

@@ -16,7 +16,7 @@
  *
  * @packageDocumentation
  */
-export { DataObjectFactory, PureDataObjectFactory, type DataObjectFactoryProps, } from "./data-object-factories/index.js";
+export { DataObjectFactory, type DataObjectFactoryProps, PureDataObjectFactory, TreeDataObjectFactory, } from "./data-object-factories/index.js";
 export { DataObject, type DataObjectKind, type DataObjectTypes, type IDataObjectProps, PureDataObject, TreeDataObject, createDataObjectKind, } from "./data-objects/index.js";
 export { BaseContainerRuntimeFactory, type BaseContainerRuntimeFactoryProps, ContainerRuntimeFactoryWithDefaultDataStore, type ContainerRuntimeFactoryWithDefaultDataStoreProps, } from "./container-runtime-factories/index.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;GAaG;AAEH,OAAO,EACN,iBAAiB,EACjB,qBAAqB,EACrB,KAAK,sBAAsB,GAC3B,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACN,UAAU,EACV,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,cAAc,EACd,cAAc,EACd,oBAAoB,GACpB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACN,2BAA2B,EAC3B,KAAK,gCAAgC,EACrC,2CAA2C,EAC3C,KAAK,gDAAgD,GACrD,MAAM,wCAAwC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;GAaG;AAEH,OAAO,EACN,iBAAiB,EACjB,KAAK,sBAAsB,EAC3B,qBAAqB,EACrB,qBAAqB,GACrB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACN,UAAU,EACV,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,cAAc,EACd,cAAc,EACd,oBAAoB,GACpB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACN,2BAA2B,EAC3B,KAAK,gCAAgC,EACrC,2CAA2C,EAC3C,KAAK,gDAAgD,GACrD,MAAM,wCAAwC,CAAC"}

package/dist/index.js

@@ -4,7 +4,7 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ContainerRuntimeFactoryWithDefaultDataStore = exports.BaseContainerRuntimeFactory = exports.createDataObjectKind = exports.TreeDataObject = exports.PureDataObject = exports.DataObject = exports.PureDataObjectFactory = exports.DataObjectFactory = void 0;
+exports.ContainerRuntimeFactoryWithDefaultDataStore = exports.BaseContainerRuntimeFactory = exports.createDataObjectKind = exports.TreeDataObject = exports.PureDataObject = exports.DataObject = exports.TreeDataObjectFactory = exports.PureDataObjectFactory = exports.DataObjectFactory = void 0;
 /**
  * The `aqueduct` package is a library for building Fluid objects and Fluid
  * containers within the Fluid Framework. Its goal is to provide a thin base
@@ -22,6 +22,7 @@ exports.ContainerRuntimeFactoryWithDefaultDataStore = exports.BaseContainerRunti
 var index_js_1 = require("./data-object-factories/index.js");
 Object.defineProperty(exports, "DataObjectFactory", { enumerable: true, get: function () { return index_js_1.DataObjectFactory; } });
 Object.defineProperty(exports, "PureDataObjectFactory", { enumerable: true, get: function () { return index_js_1.PureDataObjectFactory; } });
+Object.defineProperty(exports, "TreeDataObjectFactory", { enumerable: true, get: function () { return index_js_1.TreeDataObjectFactory; } });
 var index_js_2 = require("./data-objects/index.js");
 Object.defineProperty(exports, "DataObject", { enumerable: true, get: function () { return index_js_2.DataObject; } });
 Object.defineProperty(exports, "PureDataObject", { enumerable: true, get: function () { return index_js_2.PureDataObject; } });

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;;;;;;;;;;;;GAaG;AAEH,6DAI0C;AAHzC,6GAAA,iBAAiB,OAAA;AACjB,iHAAA,qBAAqB,OAAA;AAGtB,oDAQiC;AAPhC,sGAAA,UAAU,OAAA;AAIV,0GAAA,cAAc,OAAA;AACd,0GAAA,cAAc,OAAA;AACd,gHAAA,oBAAoB,OAAA;AAErB,mEAKgD;AAJ/C,uHAAA,2BAA2B,OAAA;AAE3B,uIAAA,2CAA2C,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * The `aqueduct` package is a library for building Fluid objects and Fluid\n * containers within the Fluid Framework. Its goal is to provide a thin base\n * layer over the existing Fluid Framework interfaces that allows developers to\n * get started quickly.\n *\n * @remarks\n * About the library name: An \"aqueduct\" is a way to transport water from a source\n * to another location. The library name was chosen because its purpose is to\n * facilitate using lower level constructs and therefore handle 'fluid' items\n * same as an aqueduct.\n *\n * @packageDocumentation\n */\n\nexport {\n\tDataObjectFactory,\n\tPureDataObjectFactory,\n\ttype DataObjectFactoryProps,\n} from \"./data-object-factories/index.js\";\nexport {\n\tDataObject,\n\ttype DataObjectKind,\n\ttype DataObjectTypes,\n\ttype IDataObjectProps,\n\tPureDataObject,\n\tTreeDataObject,\n\tcreateDataObjectKind,\n} from \"./data-objects/index.js\";\nexport {\n\tBaseContainerRuntimeFactory,\n\ttype BaseContainerRuntimeFactoryProps,\n\tContainerRuntimeFactoryWithDefaultDataStore,\n\ttype ContainerRuntimeFactoryWithDefaultDataStoreProps,\n} from \"./container-runtime-factories/index.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH;;;;;;;;;;;;;GAaG;AAEH,6DAK0C;AAJzC,6GAAA,iBAAiB,OAAA;AAEjB,iHAAA,qBAAqB,OAAA;AACrB,iHAAA,qBAAqB,OAAA;AAEtB,oDAQiC;AAPhC,sGAAA,UAAU,OAAA;AAIV,0GAAA,cAAc,OAAA;AACd,0GAAA,cAAc,OAAA;AACd,gHAAA,oBAAoB,OAAA;AAErB,mEAKgD;AAJ/C,uHAAA,2BAA2B,OAAA;AAE3B,uIAAA,2CAA2C,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * The `aqueduct` package is a library for building Fluid objects and Fluid\n * containers within the Fluid Framework. Its goal is to provide a thin base\n * layer over the existing Fluid Framework interfaces that allows developers to\n * get started quickly.\n *\n * @remarks\n * About the library name: An \"aqueduct\" is a way to transport water from a source\n * to another location. The library name was chosen because its purpose is to\n * facilitate using lower level constructs and therefore handle 'fluid' items\n * same as an aqueduct.\n *\n * @packageDocumentation\n */\n\nexport {\n\tDataObjectFactory,\n\ttype DataObjectFactoryProps,\n\tPureDataObjectFactory,\n\tTreeDataObjectFactory,\n} from \"./data-object-factories/index.js\";\nexport {\n\tDataObject,\n\ttype DataObjectKind,\n\ttype DataObjectTypes,\n\ttype IDataObjectProps,\n\tPureDataObject,\n\tTreeDataObject,\n\tcreateDataObjectKind,\n} from \"./data-objects/index.js\";\nexport {\n\tBaseContainerRuntimeFactory,\n\ttype BaseContainerRuntimeFactoryProps,\n\tContainerRuntimeFactoryWithDefaultDataStore,\n\ttype ContainerRuntimeFactoryWithDefaultDataStoreProps,\n} from \"./container-runtime-factories/index.js\";\n"]}

package/dist/legacy.d.ts

@@ -35,5 +35,7 @@ export {
 	DataObjectTypes, 
 	IDataObjectProps, 
 	PureDataObject, 
-	PureDataObjectFactory
+	PureDataObjectFactory, 
+	TreeDataObject, 
+	TreeDataObjectFactory
 } from "./index.js";

package/lib/data-object-factories/index.d.ts

@@ -4,4 +4,5 @@
  */
 export { DataObjectFactory } from "./dataObjectFactory.js";
 export { type DataObjectFactoryProps, PureDataObjectFactory, } from "./pureDataObjectFactory.js";
+export { TreeDataObjectFactory } from "./treeDataObjectFactory.js";
 //# sourceMappingURL=index.d.ts.map

package/lib/data-object-factories/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/data-object-factories/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EACN,KAAK,sBAAsB,EAC3B,qBAAqB,GACrB,MAAM,4BAA4B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/data-object-factories/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EACN,KAAK,sBAAsB,EAC3B,qBAAqB,GACrB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC"}

package/lib/data-object-factories/index.js

@@ -4,4 +4,5 @@
  */
 export { DataObjectFactory } from "./dataObjectFactory.js";
 export { PureDataObjectFactory, } from "./pureDataObjectFactory.js";
+export { TreeDataObjectFactory } from "./treeDataObjectFactory.js";
 //# sourceMappingURL=index.js.map

package/lib/data-object-factories/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/data-object-factories/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAEN,qBAAqB,GACrB,MAAM,4BAA4B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { DataObjectFactory } from \"./dataObjectFactory.js\";\nexport {\n\ttype DataObjectFactoryProps,\n\tPureDataObjectFactory,\n} from \"./pureDataObjectFactory.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/data-object-factories/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAEN,qBAAqB,GACrB,MAAM,4BAA4B,CAAC;AACpC,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { DataObjectFactory } from \"./dataObjectFactory.js\";\nexport {\n\ttype DataObjectFactoryProps,\n\tPureDataObjectFactory,\n} from \"./pureDataObjectFactory.js\";\nexport { TreeDataObjectFactory } from \"./treeDataObjectFactory.js\";\n"]}

package/lib/data-object-factories/treeDataObjectFactory.d.ts

@@ -0,0 +1,18 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { DataObjectTypes, TreeDataObject } from "../data-objects/index.js";
+import { PureDataObjectFactory, type DataObjectFactoryProps } from "./pureDataObjectFactory.js";
+/**
+ * {@link @fluidframework/runtime-definitions#IFluidDataStoreFactory} for use with {@link TreeDataObject}s.
+ *
+ * @typeParam TDataObject - The concrete TreeDataObject implementation.
+ * @typeParam TDataObjectTypes - The input types for the DataObject
+ *
+ * @legacy @alpha
+ */
+export declare class TreeDataObjectFactory<TDataObject extends TreeDataObject<TDataObjectTypes>, TDataObjectTypes extends DataObjectTypes = DataObjectTypes> extends PureDataObjectFactory<TDataObject, TDataObjectTypes> {
+    constructor(props: DataObjectFactoryProps<TDataObject, TDataObjectTypes>);
+}
+//# sourceMappingURL=treeDataObjectFactory.d.ts.map

package/lib/data-object-factories/treeDataObjectFactory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"treeDataObjectFactory.d.ts","sourceRoot":"","sources":["../../src/data-object-factories/treeDataObjectFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,0BAA0B,CAAC;AAEhF,OAAO,EACN,qBAAqB,EACrB,KAAK,sBAAsB,EAC3B,MAAM,4BAA4B,CAAC;AAEpC;;;;;;;GAOG;AACH,qBAAa,qBAAqB,CACjC,WAAW,SAAS,cAAc,CAAC,gBAAgB,CAAC,EACpD,gBAAgB,SAAS,eAAe,GAAG,eAAe,CACzD,SAAQ,qBAAqB,CAAC,WAAW,EAAE,gBAAgB,CAAC;gBAC1C,KAAK,EAAE,sBAAsB,CAAC,WAAW,EAAE,gBAAgB,CAAC;CAiB/E"}

package/lib/data-object-factories/treeDataObjectFactory.js

@@ -0,0 +1,28 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { SharedTree } from "@fluidframework/tree/internal";
+import { PureDataObjectFactory, } from "./pureDataObjectFactory.js";
+/**
+ * {@link @fluidframework/runtime-definitions#IFluidDataStoreFactory} for use with {@link TreeDataObject}s.
+ *
+ * @typeParam TDataObject - The concrete TreeDataObject implementation.
+ * @typeParam TDataObjectTypes - The input types for the DataObject
+ *
+ * @legacy @alpha
+ */
+export class TreeDataObjectFactory extends PureDataObjectFactory {
+    constructor(props) {
+        const newProps = {
+            ...props,
+            sharedObjects: props.sharedObjects ? [...props.sharedObjects] : [],
+        };
+        // If the user did not specify a SharedTree factory, add it to the shared objects.
+        if (!newProps.sharedObjects.some((sharedObject) => sharedObject.type === SharedTree.getFactory().type)) {
+            newProps.sharedObjects.push(SharedTree.getFactory());
+        }
+        super(newProps);
+    }
+}
+//# sourceMappingURL=treeDataObjectFactory.js.map

package/lib/data-object-factories/treeDataObjectFactory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"treeDataObjectFactory.js","sourceRoot":"","sources":["../../src/data-object-factories/treeDataObjectFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAI3D,OAAO,EACN,qBAAqB,GAErB,MAAM,4BAA4B,CAAC;AAEpC;;;;;;;GAOG;AACH,MAAM,OAAO,qBAGX,SAAQ,qBAAoD;IAC7D,YAAmB,KAA4D;QAC9E,MAAM,QAAQ,GAAG;YAChB,GAAG,KAAK;YACR,aAAa,EAAE,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,EAAE;SAClE,CAAC;QAEF,kFAAkF;QAClF,IACC,CAAC,QAAQ,CAAC,aAAa,CAAC,IAAI,CAC3B,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,KAAK,UAAU,CAAC,UAAU,EAAE,CAAC,IAAI,CACpE,EACA,CAAC;YACF,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,UAAU,EAAE,CAAC,CAAC;QACtD,CAAC;QAED,KAAK,CAAC,QAAQ,CAAC,CAAC;IACjB,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { SharedTree } from \"@fluidframework/tree/internal\";\n\nimport type { DataObjectTypes, TreeDataObject } from \"../data-objects/index.js\";\n\nimport {\n\tPureDataObjectFactory,\n\ttype DataObjectFactoryProps,\n} from \"./pureDataObjectFactory.js\";\n\n/**\n * {@link @fluidframework/runtime-definitions#IFluidDataStoreFactory} for use with {@link TreeDataObject}s.\n *\n * @typeParam TDataObject - The concrete TreeDataObject implementation.\n * @typeParam TDataObjectTypes - The input types for the DataObject\n *\n * @legacy @alpha\n */\nexport class TreeDataObjectFactory<\n\tTDataObject extends TreeDataObject<TDataObjectTypes>,\n\tTDataObjectTypes extends DataObjectTypes = DataObjectTypes,\n> extends PureDataObjectFactory<TDataObject, TDataObjectTypes> {\n\tpublic constructor(props: DataObjectFactoryProps<TDataObject, TDataObjectTypes>) {\n\t\tconst newProps = {\n\t\t\t...props,\n\t\t\tsharedObjects: props.sharedObjects ? [...props.sharedObjects] : [],\n\t\t};\n\n\t\t// If the user did not specify a SharedTree factory, add it to the shared objects.\n\t\tif (\n\t\t\t!newProps.sharedObjects.some(\n\t\t\t\t(sharedObject) => sharedObject.type === SharedTree.getFactory().type,\n\t\t\t)\n\t\t) {\n\t\t\tnewProps.sharedObjects.push(SharedTree.getFactory());\n\t\t}\n\n\t\tsuper(newProps);\n\t}\n}\n"]}

package/lib/data-objects/treeDataObject.d.ts

@@ -4,48 +4,54 @@
  */
 import { type ITree } from "@fluidframework/tree/internal";
 import { PureDataObject } from "./pureDataObject.js";
+import type { DataObjectTypes } from "./types.js";
 /**
- * {@link @fluidframework/tree#SharedTree}-backed {@link PureDataObject | data object}.
+ * A {@link PureDataObject | data object} backed by a {@link @fluidframework/tree#ITree}.
  *
  * @remarks
  *
- * Note: to initialize the tree's data for initial creation, implementers of this class will need to override {@link PureDataObject.initializingFirstTime} and set the data in {@link TreeDataObject.treeView}.
+ * In order to view the tree's data, consumers of this type will need to apply the appropriate view schema to the {@link TreeDataObject.tree}.
+ * This will generally be done via {@link PureDataObject.initializingFromExisting} and {@link PureDataObject.initializingFirstTime} methods.
  *
- * @typeParam TTreeView - View derived from the underlying tree.
- * Can be used to derive schema-aware views of the tree.
- * See {@link TreeDataObject.generateView}.
+ * To initialize the tree's data for initial creation, implementers of this class will need to override {@link PureDataObject.initializingFirstTime} and set the data in the schema-aware view.
+ *
+ * @typeParam TDataObjectTypes - The optional input types used to strongly type the data object.
  *
  * @example Implementing `initializingFirstTime`
  *
  * ```typescript
  * protected override async initializingFirstTime(): Promise<void> {
- * 	this.tree.initialize(...);
+ * 	// Generate the schema-aware view of the tree.
+ * 	this.treeView = this.tree.viewWith(treeViewConfiguration);
+ *
+ * 	// Initialize the tree with initial data.
+ * 	this.treeView.initialize(initialTree);
+ * }
+ * ```
+ *
+ * @example Implementing `initializingFromExisting`
+ *
+ * ```typescript
+ * protected override async initializingFromExisting(): Promise<void> {
+ * 	// Generate the schema-aware view of the tree.
+ * 	this.treeView = this.tree.viewWith(treeViewConfiguration);
+ *
+ *  // Ensure the loaded tree is compatible with the view schema.
+ * 	if (!this.treeView.compatibility.canView) {
+ * 		// Handle out-of-schema data as appropriate.
+ * 	}
  * }
  * ```
  *
- * @internal
+ * @legacy @alpha
  */
-export declare abstract class TreeDataObject<TTreeView> extends PureDataObject {
+export declare abstract class TreeDataObject<TDataObjectTypes extends DataObjectTypes = DataObjectTypes> extends PureDataObject<TDataObjectTypes> {
     #private;
     /**
-     * Generates a view of the data object's {@link @fluidframework/tree#ITree | tree}.
-     * @remarks Called once during initialization.
-     */
-    protected abstract generateView(tree: ITree): TTreeView;
-    /**
-     * Gets the underlying {@link @fluidframework/tree#ITree | tree}.
-     * @remarks
-     * Note: in most cases, you will want to use {@link TreeDataObject.treeView} instead.
-     * Created once during initialization.
-     */
-    protected get sharedTree(): ITree;
-    /**
-     * Gets the derived view of the underlying tree.
-     *
-     * @throws
-     * If the tree has not yet been initialized, this will throw an error.
+     * The underlying {@link @fluidframework/tree#ITree | tree}.
+     * @remarks Created once during initialization.
      */
-    get treeView(): TTreeView;
+    protected get tree(): ITree;
     initializeInternal(existing: boolean): Promise<void>;
 }
 //# sourceMappingURL=treeDataObject.d.ts.map

package/lib/data-objects/treeDataObject.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"treeDataObject.d.ts","sourceRoot":"","sources":["../../src/data-objects/treeDataObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,KAAK,KAAK,EAAc,MAAM,+BAA+B,CAAC;AAEvE,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAUrD;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,8BAAsB,cAAc,CAAC,SAAS,CAAE,SAAQ,cAAc;;IACrE;;;OAGG;IACH,SAAS,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,GAAG,SAAS;IAQvD;;;;;OAKG;IACH,SAAS,KAAK,UAAU,IAAI,KAAK,CAKhC;IAQD;;;;;OAKG;IACH,IAAW,QAAQ,IAAI,SAAS,CAK/B;IAEqB,kBAAkB,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CA6B1E"}
+{"version":3,"file":"treeDataObject.d.ts","sourceRoot":"","sources":["../../src/data-objects/treeDataObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAc,KAAK,KAAK,EAAE,MAAM,+BAA+B,CAAC;AAEvE,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AACrD,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,YAAY,CAAC;AAWlD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,8BAAsB,cAAc,CACnC,gBAAgB,SAAS,eAAe,GAAG,eAAe,CACzD,SAAQ,cAAc,CAAC,gBAAgB,CAAC;;IAOzC;;;OAGG;IACH,SAAS,KAAK,IAAI,IAAI,KAAK,CAK1B;IAEqB,kBAAkB,CAAC,QAAQ,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CA8B1E"}

package/lib/data-objects/treeDataObject.js

@@ -13,73 +13,74 @@ var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (
     if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
     return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
 };
-var _TreeDataObject_sharedTree, _TreeDataObject_view;
+var _TreeDataObject_tree;
 import { UsageError } from "@fluidframework/telemetry-utils/internal";
 import { SharedTree } from "@fluidframework/tree/internal";
 import { PureDataObject } from "./pureDataObject.js";
 /**
  * Channel ID of {@link TreeDataObject}'s root {@link @fluidframework/tree#SharedTree}.
+ * @privateRemarks This key is persisted and should not be changed without a migration strategy.
  */
-const treeChannelId = "tree-data-object";
+const treeChannelId = "root-tree";
 const uninitializedErrorString = "The tree has not yet been initialized. The data object must be initialized before accessing.";
 /**
- * {@link @fluidframework/tree#SharedTree}-backed {@link PureDataObject | data object}.
+ * A {@link PureDataObject | data object} backed by a {@link @fluidframework/tree#ITree}.
  *
  * @remarks
  *
- * Note: to initialize the tree's data for initial creation, implementers of this class will need to override {@link PureDataObject.initializingFirstTime} and set the data in {@link TreeDataObject.treeView}.
+ * In order to view the tree's data, consumers of this type will need to apply the appropriate view schema to the {@link TreeDataObject.tree}.
+ * This will generally be done via {@link PureDataObject.initializingFromExisting} and {@link PureDataObject.initializingFirstTime} methods.
  *
- * @typeParam TTreeView - View derived from the underlying tree.
- * Can be used to derive schema-aware views of the tree.
- * See {@link TreeDataObject.generateView}.
+ * To initialize the tree's data for initial creation, implementers of this class will need to override {@link PureDataObject.initializingFirstTime} and set the data in the schema-aware view.
+ *
+ * @typeParam TDataObjectTypes - The optional input types used to strongly type the data object.
  *
  * @example Implementing `initializingFirstTime`
  *
  * ```typescript
  * protected override async initializingFirstTime(): Promise<void> {
- * 	this.tree.initialize(...);
+ * 	// Generate the schema-aware view of the tree.
+ * 	this.treeView = this.tree.viewWith(treeViewConfiguration);
+ *
+ * 	// Initialize the tree with initial data.
+ * 	this.treeView.initialize(initialTree);
+ * }
+ * ```
+ *
+ * @example Implementing `initializingFromExisting`
+ *
+ * ```typescript
+ * protected override async initializingFromExisting(): Promise<void> {
+ * 	// Generate the schema-aware view of the tree.
+ * 	this.treeView = this.tree.viewWith(treeViewConfiguration);
+ *
+ *  // Ensure the loaded tree is compatible with the view schema.
+ * 	if (!this.treeView.compatibility.canView) {
+ * 		// Handle out-of-schema data as appropriate.
+ * 	}
  * }
  * ```
  *
- * @internal
+ * @legacy @alpha
  */
 export class TreeDataObject extends PureDataObject {
     constructor() {
         super(...arguments);
         /**
-         * Implementation of SharedTree which is used to generate the view.
+         * The underlying {@link @fluidframework/tree#ITree | tree}.
          * @remarks Created once during initialization.
          */
-        _TreeDataObject_sharedTree.set(this, void 0);
-        /**
-         * View derived from the underlying tree.
-         * @remarks Populated via {@link TreeDataObject.generateView}.
-         */
-        _TreeDataObject_view.set(this, void 0);
-    }
-    /**
-     * Gets the underlying {@link @fluidframework/tree#ITree | tree}.
-     * @remarks
-     * Note: in most cases, you will want to use {@link TreeDataObject.treeView} instead.
-     * Created once during initialization.
-     */
-    get sharedTree() {
-        if (__classPrivateFieldGet(this, _TreeDataObject_sharedTree, "f") === undefined) {
-            throw new UsageError(uninitializedErrorString);
-        }
-        return __classPrivateFieldGet(this, _TreeDataObject_sharedTree, "f");
+        _TreeDataObject_tree.set(this, void 0);
     }
     /**
-     * Gets the derived view of the underlying tree.
-     *
-     * @throws
-     * If the tree has not yet been initialized, this will throw an error.
+     * The underlying {@link @fluidframework/tree#ITree | tree}.
+     * @remarks Created once during initialization.
      */
-    get treeView() {
-        if (__classPrivateFieldGet(this, _TreeDataObject_view, "f") === undefined) {
+    get tree() {
+        if (__classPrivateFieldGet(this, _TreeDataObject_tree, "f") === undefined) {
             throw new UsageError(uninitializedErrorString);
         }
-        return __classPrivateFieldGet(this, _TreeDataObject_view, "f");
+        return __classPrivateFieldGet(this, _TreeDataObject_tree, "f");
     }
     async initializeInternal(existing) {
         if (existing) {
@@ -91,19 +92,17 @@ export class TreeDataObject extends PureDataObject {
                 throw new Error(`Content with id ${channel.id} is not a SharedTree and cannot be loaded with treeDataObject.`);
             }
             const sharedTree = channel;
-            __classPrivateFieldSet(this, _TreeDataObject_sharedTree, sharedTree, "f");
-            __classPrivateFieldSet(this, _TreeDataObject_view, this.generateView(sharedTree), "f");
+            __classPrivateFieldSet(this, _TreeDataObject_tree, sharedTree, "f");
         }
         else {
-            const sharedTree = SharedTree.create(this.runtime, treeChannelId);
+            const sharedTree = this.runtime.createChannel(treeChannelId, SharedTree.getFactory().type);
             sharedTree.bindToContext();
-            __classPrivateFieldSet(this, _TreeDataObject_sharedTree, sharedTree, "f");
-            __classPrivateFieldSet(this, _TreeDataObject_view, this.generateView(sharedTree), "f");
+            __classPrivateFieldSet(this, _TreeDataObject_tree, sharedTree, "f");
             // Note, the implementer is responsible for initializing the tree with initial data.
             // Generally, this can be done via `initializingFirstTime`.
         }
         await super.initializeInternal(existing);
     }
 }
-_TreeDataObject_sharedTree = new WeakMap(), _TreeDataObject_view = new WeakMap();
+_TreeDataObject_tree = new WeakMap();
 //# sourceMappingURL=treeDataObject.js.map

package/lib/data-objects/treeDataObject.js.map

@@ -1 +1 @@
-{"version":3,"file":"treeDataObject.js","sourceRoot":"","sources":["../../src/data-objects/treeDataObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;;;;;;;;;;;;;AAGH,OAAO,EAAE,UAAU,EAAE,MAAM,0CAA0C,CAAC;AACtE,OAAO,EAAc,UAAU,EAAE,MAAM,+BAA+B,CAAC;AAEvE,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAErD;;GAEG;AACH,MAAM,aAAa,GAAG,kBAAkB,CAAC;AAEzC,MAAM,wBAAwB,GAC7B,8FAA8F,CAAC;AAEhG;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,OAAgB,cAA0B,SAAQ,cAAc;IAAtE;;QAOC;;;WAGG;QACH,6CAA+B;QAe/B;;;WAGG;QACH,uCAA6B;IA4C9B,CAAC;IA7DA;;;;;OAKG;IACH,IAAc,UAAU;QACvB,IAAI,uBAAA,IAAI,kCAAY,KAAK,SAAS,EAAE,CAAC;YACpC,MAAM,IAAI,UAAU,CAAC,wBAAwB,CAAC,CAAC;QAChD,CAAC;QACD,OAAO,uBAAA,IAAI,kCAAY,CAAC;IACzB,CAAC;IAQD;;;;;OAKG;IACH,IAAW,QAAQ;QAClB,IAAI,uBAAA,IAAI,4BAAM,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM,IAAI,UAAU,CAAC,wBAAwB,CAAC,CAAC;QAChD,CAAC;QACD,OAAO,uBAAA,IAAI,4BAAM,CAAC;IACnB,CAAC;IAEe,KAAK,CAAC,kBAAkB,CAAC,QAAiB;QACzD,IAAI,QAAQ,EAAE,CAAC;YACd,+FAA+F;YAC/F,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;YAE7D,0FAA0F;YAC1F,8FAA8F;YAC9F,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC7B,MAAM,IAAI,KAAK,CACd,mBAAmB,OAAO,CAAC,EAAE,gEAAgE,CAC7F,CAAC;YACH,CAAC;YACD,MAAM,UAAU,GAAU,OAAO,CAAC;YAElC,uBAAA,IAAI,8BAAe,UAAU,MAAA,CAAC;YAC9B,uBAAA,IAAI,wBAAS,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,MAAA,CAAC;QAC5C,CAAC;aAAM,CAAC;YACP,MAAM,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,EAAE,aAAa,CAAC,CAAC;YACjE,UAAuC,CAAC,aAAa,EAAE,CAAC;YAEzD,uBAAA,IAAI,8BAAe,UAAU,MAAA,CAAC;YAC9B,uBAAA,IAAI,wBAAS,IAAI,CAAC,YAAY,CAAC,UAAU,CAAC,MAAA,CAAC;YAE3C,oFAAoF;YACpF,2DAA2D;QAC5D,CAAC;QAED,MAAM,KAAK,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ISharedObject } from \"@fluidframework/shared-object-base/internal\";\nimport { UsageError } from \"@fluidframework/telemetry-utils/internal\";\nimport { type ITree, SharedTree } from \"@fluidframework/tree/internal\";\n\nimport { PureDataObject } from \"./pureDataObject.js\";\n\n/**\n * Channel ID of {@link TreeDataObject}'s root {@link @fluidframework/tree#SharedTree}.\n */\nconst treeChannelId = \"tree-data-object\";\n\nconst uninitializedErrorString =\n\t\"The tree has not yet been initialized. The data object must be initialized before accessing.\";\n\n/**\n * {@link @fluidframework/tree#SharedTree}-backed {@link PureDataObject | data object}.\n *\n * @remarks\n *\n * Note: to initialize the tree's data for initial creation, implementers of this class will need to override {@link PureDataObject.initializingFirstTime} and set the data in {@link TreeDataObject.treeView}.\n *\n * @typeParam TTreeView - View derived from the underlying tree.\n * Can be used to derive schema-aware views of the tree.\n * See {@link TreeDataObject.generateView}.\n *\n * @example Implementing `initializingFirstTime`\n *\n * ```typescript\n * protected override async initializingFirstTime(): Promise<void> {\n * \tthis.tree.initialize(...);\n * }\n * ```\n *\n * @internal\n */\nexport abstract class TreeDataObject<TTreeView> extends PureDataObject {\n\t/**\n\t * Generates a view of the data object's {@link @fluidframework/tree#ITree | tree}.\n\t * @remarks Called once during initialization.\n\t */\n\tprotected abstract generateView(tree: ITree): TTreeView;\n\n\t/**\n\t * Implementation of SharedTree which is used to generate the view.\n\t * @remarks Created once during initialization.\n\t */\n\t#sharedTree: ITree | undefined;\n\n\t/**\n\t * Gets the underlying {@link @fluidframework/tree#ITree | tree}.\n\t * @remarks\n\t * Note: in most cases, you will want to use {@link TreeDataObject.treeView} instead.\n\t * Created once during initialization.\n\t */\n\tprotected get sharedTree(): ITree {\n\t\tif (this.#sharedTree === undefined) {\n\t\t\tthrow new UsageError(uninitializedErrorString);\n\t\t}\n\t\treturn this.#sharedTree;\n\t}\n\n\t/**\n\t * View derived from the underlying tree.\n\t * @remarks Populated via {@link TreeDataObject.generateView}.\n\t */\n\t#view: TTreeView | undefined;\n\n\t/**\n\t * Gets the derived view of the underlying tree.\n\t *\n\t * @throws\n\t * If the tree has not yet been initialized, this will throw an error.\n\t */\n\tpublic get treeView(): TTreeView {\n\t\tif (this.#view === undefined) {\n\t\t\tthrow new UsageError(uninitializedErrorString);\n\t\t}\n\t\treturn this.#view;\n\t}\n\n\tpublic override async initializeInternal(existing: boolean): Promise<void> {\n\t\tif (existing) {\n\t\t\t// data store has a root tree so we just need to set it before calling initializingFromExisting\n\t\t\tconst channel = await this.runtime.getChannel(treeChannelId);\n\n\t\t\t// TODO: Support using a Directory to Tree migration shim and DataObject's root channel ID\n\t\t\t// to allow migrating from DataObject to TreeDataObject instead of just erroring in that case.\n\t\t\tif (!SharedTree.is(channel)) {\n\t\t\t\tthrow new Error(\n\t\t\t\t\t`Content with id ${channel.id} is not a SharedTree and cannot be loaded with treeDataObject.`,\n\t\t\t\t);\n\t\t\t}\n\t\t\tconst sharedTree: ITree = channel;\n\n\t\t\tthis.#sharedTree = sharedTree;\n\t\t\tthis.#view = this.generateView(sharedTree);\n\t\t} else {\n\t\t\tconst sharedTree = SharedTree.create(this.runtime, treeChannelId);\n\t\t\t(sharedTree as unknown as ISharedObject).bindToContext();\n\n\t\t\tthis.#sharedTree = sharedTree;\n\t\t\tthis.#view = this.generateView(sharedTree);\n\n\t\t\t// Note, the implementer is responsible for initializing the tree with initial data.\n\t\t\t// Generally, this can be done via `initializingFirstTime`.\n\t\t}\n\n\t\tawait super.initializeInternal(existing);\n\t}\n}\n"]}
+{"version":3,"file":"treeDataObject.js","sourceRoot":"","sources":["../../src/data-objects/treeDataObject.ts"],"names":[],"mappings":"AAAA;;;GAGG;;;;;;;;;;;;;AAGH,OAAO,EAAE,UAAU,EAAE,MAAM,0CAA0C,CAAC;AACtE,OAAO,EAAE,UAAU,EAAc,MAAM,+BAA+B,CAAC;AAEvE,OAAO,EAAE,cAAc,EAAE,MAAM,qBAAqB,CAAC;AAGrD;;;GAGG;AACH,MAAM,aAAa,GAAG,WAAW,CAAC;AAElC,MAAM,wBAAwB,GAC7B,8FAA8F,CAAC;AAEhG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuCG;AACH,MAAM,OAAgB,cAEpB,SAAQ,cAAgC;IAF1C;;QAGC;;;WAGG;QACH,uCAAyB;IA2C1B,CAAC;IAzCA;;;OAGG;IACH,IAAc,IAAI;QACjB,IAAI,uBAAA,IAAI,4BAAM,KAAK,SAAS,EAAE,CAAC;YAC9B,MAAM,IAAI,UAAU,CAAC,wBAAwB,CAAC,CAAC;QAChD,CAAC;QACD,OAAO,uBAAA,IAAI,4BAAM,CAAC;IACnB,CAAC;IAEe,KAAK,CAAC,kBAAkB,CAAC,QAAiB;QACzD,IAAI,QAAQ,EAAE,CAAC;YACd,+FAA+F;YAC/F,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;YAE7D,0FAA0F;YAC1F,8FAA8F;YAC9F,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,OAAO,CAAC,EAAE,CAAC;gBAC7B,MAAM,IAAI,KAAK,CACd,mBAAmB,OAAO,CAAC,EAAE,gEAAgE,CAC7F,CAAC;YACH,CAAC;YACD,MAAM,UAAU,GAAU,OAAO,CAAC;YAElC,uBAAA,IAAI,wBAAS,UAAU,MAAA,CAAC;QACzB,CAAC;aAAM,CAAC;YACP,MAAM,UAAU,GAAG,IAAI,CAAC,OAAO,CAAC,aAAa,CAC5C,aAAa,EACb,UAAU,CAAC,UAAU,EAAE,CAAC,IAAI,CACR,CAAC;YACrB,UAAuC,CAAC,aAAa,EAAE,CAAC;YAEzD,uBAAA,IAAI,wBAAS,UAAU,MAAA,CAAC;YAExB,oFAAoF;YACpF,2DAA2D;QAC5D,CAAC;QAED,MAAM,KAAK,CAAC,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IAC1C,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { ISharedObject } from \"@fluidframework/shared-object-base/internal\";\nimport { UsageError } from \"@fluidframework/telemetry-utils/internal\";\nimport { SharedTree, type ITree } from \"@fluidframework/tree/internal\";\n\nimport { PureDataObject } from \"./pureDataObject.js\";\nimport type { DataObjectTypes } from \"./types.js\";\n\n/**\n * Channel ID of {@link TreeDataObject}'s root {@link @fluidframework/tree#SharedTree}.\n * @privateRemarks This key is persisted and should not be changed without a migration strategy.\n */\nconst treeChannelId = \"root-tree\";\n\nconst uninitializedErrorString =\n\t\"The tree has not yet been initialized. The data object must be initialized before accessing.\";\n\n/**\n * A {@link PureDataObject | data object} backed by a {@link @fluidframework/tree#ITree}.\n *\n * @remarks\n *\n * In order to view the tree's data, consumers of this type will need to apply the appropriate view schema to the {@link TreeDataObject.tree}.\n * This will generally be done via {@link PureDataObject.initializingFromExisting} and {@link PureDataObject.initializingFirstTime} methods.\n *\n * To initialize the tree's data for initial creation, implementers of this class will need to override {@link PureDataObject.initializingFirstTime} and set the data in the schema-aware view.\n *\n * @typeParam TDataObjectTypes - The optional input types used to strongly type the data object.\n *\n * @example Implementing `initializingFirstTime`\n *\n * ```typescript\n * protected override async initializingFirstTime(): Promise<void> {\n * \t// Generate the schema-aware view of the tree.\n * \tthis.treeView = this.tree.viewWith(treeViewConfiguration);\n *\n * \t// Initialize the tree with initial data.\n * \tthis.treeView.initialize(initialTree);\n * }\n * ```\n *\n * @example Implementing `initializingFromExisting`\n *\n * ```typescript\n * protected override async initializingFromExisting(): Promise<void> {\n * \t// Generate the schema-aware view of the tree.\n * \tthis.treeView = this.tree.viewWith(treeViewConfiguration);\n *\n *  // Ensure the loaded tree is compatible with the view schema.\n * \tif (!this.treeView.compatibility.canView) {\n * \t\t// Handle out-of-schema data as appropriate.\n * \t}\n * }\n * ```\n *\n * @legacy @alpha\n */\nexport abstract class TreeDataObject<\n\tTDataObjectTypes extends DataObjectTypes = DataObjectTypes,\n> extends PureDataObject<TDataObjectTypes> {\n\t/**\n\t * The underlying {@link @fluidframework/tree#ITree | tree}.\n\t * @remarks Created once during initialization.\n\t */\n\t#tree: ITree | undefined;\n\n\t/**\n\t * The underlying {@link @fluidframework/tree#ITree | tree}.\n\t * @remarks Created once during initialization.\n\t */\n\tprotected get tree(): ITree {\n\t\tif (this.#tree === undefined) {\n\t\t\tthrow new UsageError(uninitializedErrorString);\n\t\t}\n\t\treturn this.#tree;\n\t}\n\n\tpublic override async initializeInternal(existing: boolean): Promise<void> {\n\t\tif (existing) {\n\t\t\t// data store has a root tree so we just need to set it before calling initializingFromExisting\n\t\t\tconst channel = await this.runtime.getChannel(treeChannelId);\n\n\t\t\t// TODO: Support using a Directory to Tree migration shim and DataObject's root channel ID\n\t\t\t// to allow migrating from DataObject to TreeDataObject instead of just erroring in that case.\n\t\t\tif (!SharedTree.is(channel)) {\n\t\t\t\tthrow new Error(\n\t\t\t\t\t`Content with id ${channel.id} is not a SharedTree and cannot be loaded with treeDataObject.`,\n\t\t\t\t);\n\t\t\t}\n\t\t\tconst sharedTree: ITree = channel;\n\n\t\t\tthis.#tree = sharedTree;\n\t\t} else {\n\t\t\tconst sharedTree = this.runtime.createChannel(\n\t\t\t\ttreeChannelId,\n\t\t\t\tSharedTree.getFactory().type,\n\t\t\t) as unknown as ITree;\n\t\t\t(sharedTree as unknown as ISharedObject).bindToContext();\n\n\t\t\tthis.#tree = sharedTree;\n\n\t\t\t// Note, the implementer is responsible for initializing the tree with initial data.\n\t\t\t// Generally, this can be done via `initializingFirstTime`.\n\t\t}\n\n\t\tawait super.initializeInternal(existing);\n\t}\n}\n"]}

package/lib/index.d.ts

@@ -16,7 +16,7 @@
  *
  * @packageDocumentation
  */
-export { DataObjectFactory, PureDataObjectFactory, type DataObjectFactoryProps, } from "./data-object-factories/index.js";
+export { DataObjectFactory, type DataObjectFactoryProps, PureDataObjectFactory, TreeDataObjectFactory, } from "./data-object-factories/index.js";
 export { DataObject, type DataObjectKind, type DataObjectTypes, type IDataObjectProps, PureDataObject, TreeDataObject, createDataObjectKind, } from "./data-objects/index.js";
 export { BaseContainerRuntimeFactory, type BaseContainerRuntimeFactoryProps, ContainerRuntimeFactoryWithDefaultDataStore, type ContainerRuntimeFactoryWithDefaultDataStoreProps, } from "./container-runtime-factories/index.js";
 //# sourceMappingURL=index.d.ts.map

package/lib/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;GAaG;AAEH,OAAO,EACN,iBAAiB,EACjB,qBAAqB,EACrB,KAAK,sBAAsB,GAC3B,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACN,UAAU,EACV,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,cAAc,EACd,cAAc,EACd,oBAAoB,GACpB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACN,2BAA2B,EAC3B,KAAK,gCAAgC,EACrC,2CAA2C,EAC3C,KAAK,gDAAgD,GACrD,MAAM,wCAAwC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;GAaG;AAEH,OAAO,EACN,iBAAiB,EACjB,KAAK,sBAAsB,EAC3B,qBAAqB,EACrB,qBAAqB,GACrB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACN,UAAU,EACV,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,cAAc,EACd,cAAc,EACd,oBAAoB,GACpB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACN,2BAA2B,EAC3B,KAAK,gCAAgC,EACrC,2CAA2C,EAC3C,KAAK,gDAAgD,GACrD,MAAM,wCAAwC,CAAC"}

package/lib/index.js

@@ -16,7 +16,7 @@
  *
  * @packageDocumentation
  */
-export { DataObjectFactory, PureDataObjectFactory, } from "./data-object-factories/index.js";
+export { DataObjectFactory, PureDataObjectFactory, TreeDataObjectFactory, } from "./data-object-factories/index.js";
 export { DataObject, PureDataObject, TreeDataObject, createDataObjectKind, } from "./data-objects/index.js";
 export { BaseContainerRuntimeFactory, ContainerRuntimeFactoryWithDefaultDataStore, } from "./container-runtime-factories/index.js";
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;GAaG;AAEH,OAAO,EACN,iBAAiB,EACjB,qBAAqB,GAErB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACN,UAAU,EAIV,cAAc,EACd,cAAc,EACd,oBAAoB,GACpB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACN,2BAA2B,EAE3B,2CAA2C,GAE3C,MAAM,wCAAwC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * The `aqueduct` package is a library for building Fluid objects and Fluid\n * containers within the Fluid Framework. Its goal is to provide a thin base\n * layer over the existing Fluid Framework interfaces that allows developers to\n * get started quickly.\n *\n * @remarks\n * About the library name: An \"aqueduct\" is a way to transport water from a source\n * to another location. The library name was chosen because its purpose is to\n * facilitate using lower level constructs and therefore handle 'fluid' items\n * same as an aqueduct.\n *\n * @packageDocumentation\n */\n\nexport {\n\tDataObjectFactory,\n\tPureDataObjectFactory,\n\ttype DataObjectFactoryProps,\n} from \"./data-object-factories/index.js\";\nexport {\n\tDataObject,\n\ttype DataObjectKind,\n\ttype DataObjectTypes,\n\ttype IDataObjectProps,\n\tPureDataObject,\n\tTreeDataObject,\n\tcreateDataObjectKind,\n} from \"./data-objects/index.js\";\nexport {\n\tBaseContainerRuntimeFactory,\n\ttype BaseContainerRuntimeFactoryProps,\n\tContainerRuntimeFactoryWithDefaultDataStore,\n\ttype ContainerRuntimeFactoryWithDefaultDataStoreProps,\n} from \"./container-runtime-factories/index.js\";\n"]}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;;;;;;;;;;GAaG;AAEH,OAAO,EACN,iBAAiB,EAEjB,qBAAqB,EACrB,qBAAqB,GACrB,MAAM,kCAAkC,CAAC;AAC1C,OAAO,EACN,UAAU,EAIV,cAAc,EACd,cAAc,EACd,oBAAoB,GACpB,MAAM,yBAAyB,CAAC;AACjC,OAAO,EACN,2BAA2B,EAE3B,2CAA2C,GAE3C,MAAM,wCAAwC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/**\n * The `aqueduct` package is a library for building Fluid objects and Fluid\n * containers within the Fluid Framework. Its goal is to provide a thin base\n * layer over the existing Fluid Framework interfaces that allows developers to\n * get started quickly.\n *\n * @remarks\n * About the library name: An \"aqueduct\" is a way to transport water from a source\n * to another location. The library name was chosen because its purpose is to\n * facilitate using lower level constructs and therefore handle 'fluid' items\n * same as an aqueduct.\n *\n * @packageDocumentation\n */\n\nexport {\n\tDataObjectFactory,\n\ttype DataObjectFactoryProps,\n\tPureDataObjectFactory,\n\tTreeDataObjectFactory,\n} from \"./data-object-factories/index.js\";\nexport {\n\tDataObject,\n\ttype DataObjectKind,\n\ttype DataObjectTypes,\n\ttype IDataObjectProps,\n\tPureDataObject,\n\tTreeDataObject,\n\tcreateDataObjectKind,\n} from \"./data-objects/index.js\";\nexport {\n\tBaseContainerRuntimeFactory,\n\ttype BaseContainerRuntimeFactoryProps,\n\tContainerRuntimeFactoryWithDefaultDataStore,\n\ttype ContainerRuntimeFactoryWithDefaultDataStoreProps,\n} from \"./container-runtime-factories/index.js\";\n"]}

package/lib/legacy.d.ts

@@ -35,5 +35,7 @@ export {
 	DataObjectTypes, 
 	IDataObjectProps, 
 	PureDataObject, 
-	PureDataObjectFactory
+	PureDataObjectFactory, 
+	TreeDataObject, 
+	TreeDataObjectFactory
 } from "./index.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/aqueduct",
-  "version": "2.50.0",
+  "version": "2.51.0",
   "description": "A set of implementations for Fluid Framework interfaces.",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -69,29 +69,29 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.50.0",
-    "@fluidframework/container-definitions": "~2.50.0",
-    "@fluidframework/container-runtime": "~2.50.0",
-    "@fluidframework/container-runtime-definitions": "~2.50.0",
-    "@fluidframework/core-interfaces": "~2.50.0",
-    "@fluidframework/core-utils": "~2.50.0",
-    "@fluidframework/datastore": "~2.50.0",
-    "@fluidframework/datastore-definitions": "~2.50.0",
-    "@fluidframework/map": "~2.50.0",
-    "@fluidframework/request-handler": "~2.50.0",
-    "@fluidframework/runtime-definitions": "~2.50.0",
-    "@fluidframework/runtime-utils": "~2.50.0",
-    "@fluidframework/shared-object-base": "~2.50.0",
-    "@fluidframework/synthesize": "~2.50.0",
-    "@fluidframework/telemetry-utils": "~2.50.0",
-    "@fluidframework/tree": "~2.50.0"
+    "@fluid-internal/client-utils": "~2.51.0",
+    "@fluidframework/container-definitions": "~2.51.0",
+    "@fluidframework/container-runtime": "~2.51.0",
+    "@fluidframework/container-runtime-definitions": "~2.51.0",
+    "@fluidframework/core-interfaces": "~2.51.0",
+    "@fluidframework/core-utils": "~2.51.0",
+    "@fluidframework/datastore": "~2.51.0",
+    "@fluidframework/datastore-definitions": "~2.51.0",
+    "@fluidframework/map": "~2.51.0",
+    "@fluidframework/request-handler": "~2.51.0",
+    "@fluidframework/runtime-definitions": "~2.51.0",
+    "@fluidframework/runtime-utils": "~2.51.0",
+    "@fluidframework/shared-object-base": "~2.51.0",
+    "@fluidframework/synthesize": "~2.51.0",
+    "@fluidframework/telemetry-utils": "~2.51.0",
+    "@fluidframework/tree": "~2.51.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "~2.50.0",
+    "@fluid-internal/mocha-test-setup": "~2.51.0",
     "@fluid-tools/build-cli": "^0.56.0",
-    "@fluidframework/aqueduct-previous": "npm:@fluidframework/aqueduct@2.43.0",
+    "@fluidframework/aqueduct-previous": "npm:@fluidframework/aqueduct@2.50.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.56.0",
     "@fluidframework/eslint-config-fluid": "^5.7.4",
@@ -109,23 +109,7 @@
     "typescript": "~5.4.5"
   },
   "typeValidation": {
-    "broken": {
-      "Class_DataObject": {
-        "backCompat": false
-      },
-      "Class_PureDataObject": {
-        "backCompat": false
-      },
-      "ClassStatics_DataObject": {
-        "backCompat": false
-      },
-      "ClassStatics_PureDataObject": {
-        "backCompat": false
-      },
-      "Interface_DataObjectFactoryProps": {
-        "backCompat": false
-      }
-    },
+    "broken": {},
     "entrypoint": "legacy"
   },
   "scripts": {

package/src/data-object-factories/index.ts

@@ -8,3 +8,4 @@ export {
 	type DataObjectFactoryProps,
 	PureDataObjectFactory,
 } from "./pureDataObjectFactory.js";
+export { TreeDataObjectFactory } from "./treeDataObjectFactory.js";

package/src/data-object-factories/treeDataObjectFactory.ts

@@ -0,0 +1,44 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import { SharedTree } from "@fluidframework/tree/internal";
+
+import type { DataObjectTypes, TreeDataObject } from "../data-objects/index.js";
+
+import {
+	PureDataObjectFactory,
+	type DataObjectFactoryProps,
+} from "./pureDataObjectFactory.js";
+
+/**
+ * {@link @fluidframework/runtime-definitions#IFluidDataStoreFactory} for use with {@link TreeDataObject}s.
+ *
+ * @typeParam TDataObject - The concrete TreeDataObject implementation.
+ * @typeParam TDataObjectTypes - The input types for the DataObject
+ *
+ * @legacy @alpha
+ */
+export class TreeDataObjectFactory<
+	TDataObject extends TreeDataObject<TDataObjectTypes>,
+	TDataObjectTypes extends DataObjectTypes = DataObjectTypes,
+> extends PureDataObjectFactory<TDataObject, TDataObjectTypes> {
+	public constructor(props: DataObjectFactoryProps<TDataObject, TDataObjectTypes>) {
+		const newProps = {
+			...props,
+			sharedObjects: props.sharedObjects ? [...props.sharedObjects] : [],
+		};
+
+		// If the user did not specify a SharedTree factory, add it to the shared objects.
+		if (
+			!newProps.sharedObjects.some(
+				(sharedObject) => sharedObject.type === SharedTree.getFactory().type,
+			)
+		) {
+			newProps.sharedObjects.push(SharedTree.getFactory());
+		}
+
+		super(newProps);
+	}
+}

package/src/data-objects/treeDataObject.ts

@@ -5,82 +5,78 @@
 
 import type { ISharedObject } from "@fluidframework/shared-object-base/internal";
 import { UsageError } from "@fluidframework/telemetry-utils/internal";
-import { type ITree, SharedTree } from "@fluidframework/tree/internal";
+import { SharedTree, type ITree } from "@fluidframework/tree/internal";
 
 import { PureDataObject } from "./pureDataObject.js";
+import type { DataObjectTypes } from "./types.js";
 
 /**
  * Channel ID of {@link TreeDataObject}'s root {@link @fluidframework/tree#SharedTree}.
+ * @privateRemarks This key is persisted and should not be changed without a migration strategy.
  */
-const treeChannelId = "tree-data-object";
+const treeChannelId = "root-tree";
 
 const uninitializedErrorString =
 	"The tree has not yet been initialized. The data object must be initialized before accessing.";
 
 /**
- * {@link @fluidframework/tree#SharedTree}-backed {@link PureDataObject | data object}.
+ * A {@link PureDataObject | data object} backed by a {@link @fluidframework/tree#ITree}.
  *
  * @remarks
  *
- * Note: to initialize the tree's data for initial creation, implementers of this class will need to override {@link PureDataObject.initializingFirstTime} and set the data in {@link TreeDataObject.treeView}.
+ * In order to view the tree's data, consumers of this type will need to apply the appropriate view schema to the {@link TreeDataObject.tree}.
+ * This will generally be done via {@link PureDataObject.initializingFromExisting} and {@link PureDataObject.initializingFirstTime} methods.
  *
- * @typeParam TTreeView - View derived from the underlying tree.
- * Can be used to derive schema-aware views of the tree.
- * See {@link TreeDataObject.generateView}.
+ * To initialize the tree's data for initial creation, implementers of this class will need to override {@link PureDataObject.initializingFirstTime} and set the data in the schema-aware view.
+ *
+ * @typeParam TDataObjectTypes - The optional input types used to strongly type the data object.
  *
  * @example Implementing `initializingFirstTime`
  *
  * ```typescript
  * protected override async initializingFirstTime(): Promise<void> {
- * 	this.tree.initialize(...);
+ * 	// Generate the schema-aware view of the tree.
+ * 	this.treeView = this.tree.viewWith(treeViewConfiguration);
+ *
+ * 	// Initialize the tree with initial data.
+ * 	this.treeView.initialize(initialTree);
  * }
  * ```
  *
- * @internal
+ * @example Implementing `initializingFromExisting`
+ *
+ * ```typescript
+ * protected override async initializingFromExisting(): Promise<void> {
+ * 	// Generate the schema-aware view of the tree.
+ * 	this.treeView = this.tree.viewWith(treeViewConfiguration);
+ *
+ *  // Ensure the loaded tree is compatible with the view schema.
+ * 	if (!this.treeView.compatibility.canView) {
+ * 		// Handle out-of-schema data as appropriate.
+ * 	}
+ * }
+ * ```
+ *
+ * @legacy @alpha
  */
-export abstract class TreeDataObject<TTreeView> extends PureDataObject {
-	/**
-	 * Generates a view of the data object's {@link @fluidframework/tree#ITree | tree}.
-	 * @remarks Called once during initialization.
-	 */
-	protected abstract generateView(tree: ITree): TTreeView;
-
+export abstract class TreeDataObject<
+	TDataObjectTypes extends DataObjectTypes = DataObjectTypes,
+> extends PureDataObject<TDataObjectTypes> {
 	/**
-	 * Implementation of SharedTree which is used to generate the view.
+	 * The underlying {@link @fluidframework/tree#ITree | tree}.
 	 * @remarks Created once during initialization.
 	 */
-	#sharedTree: ITree | undefined;
+	#tree: ITree | undefined;
 
 	/**
-	 * Gets the underlying {@link @fluidframework/tree#ITree | tree}.
-	 * @remarks
-	 * Note: in most cases, you will want to use {@link TreeDataObject.treeView} instead.
-	 * Created once during initialization.
-	 */
-	protected get sharedTree(): ITree {
-		if (this.#sharedTree === undefined) {
-			throw new UsageError(uninitializedErrorString);
-		}
-		return this.#sharedTree;
-	}
-
-	/**
-	 * View derived from the underlying tree.
-	 * @remarks Populated via {@link TreeDataObject.generateView}.
-	 */
-	#view: TTreeView | undefined;
-
-	/**
-	 * Gets the derived view of the underlying tree.
-	 *
-	 * @throws
-	 * If the tree has not yet been initialized, this will throw an error.
+	 * The underlying {@link @fluidframework/tree#ITree | tree}.
+	 * @remarks Created once during initialization.
 	 */
-	public get treeView(): TTreeView {
-		if (this.#view === undefined) {
+	protected get tree(): ITree {
+		if (this.#tree === undefined) {
 			throw new UsageError(uninitializedErrorString);
 		}
-		return this.#view;
+		return this.#tree;
 	}
 
 	public override async initializeInternal(existing: boolean): Promise<void> {
@@ -97,14 +93,15 @@ export abstract class TreeDataObject<TTreeView> extends PureDataObject {
 			}
 			const sharedTree: ITree = channel;
 
-			this.#sharedTree = sharedTree;
-			this.#view = this.generateView(sharedTree);
+			this.#tree = sharedTree;
 		} else {
-			const sharedTree = SharedTree.create(this.runtime, treeChannelId);
+			const sharedTree = this.runtime.createChannel(
+				treeChannelId,
+				SharedTree.getFactory().type,
+			) as unknown as ITree;
 			(sharedTree as unknown as ISharedObject).bindToContext();
 
-			this.#sharedTree = sharedTree;
-			this.#view = this.generateView(sharedTree);
+			this.#tree = sharedTree;
 
 			// Note, the implementer is responsible for initializing the tree with initial data.
 			// Generally, this can be done via `initializingFirstTime`.

package/src/index.ts

@@ -20,8 +20,9 @@
 
 export {
 	DataObjectFactory,
-	PureDataObjectFactory,
 	type DataObjectFactoryProps,
+	PureDataObjectFactory,
+	TreeDataObjectFactory,
 } from "./data-object-factories/index.js";
 export {
 	DataObject,