@fluidframework/aqueduct 2.30.0 → 2.31.1

package/lib/data-objects/treeDataObject.js

@@ -0,0 +1,95 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
+    if (kind === "m") throw new TypeError("Private method is not writable");
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
+    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_view;
+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}.
+ */
+const treeChannelId = "tree-data-object";
+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}.
+ *
+ * @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}.
+ *
+ * @typeParam TTreeView - View derived from the underlying tree.
+ * Can be used to derive schema-aware views of the tree.
+ * See {@link TreeDataObject.generateView}.
+ *
+ * @example Implementing `initializingFirstTime`
+ *
+ * ```typescript
+ * protected override async initializingFirstTime(): Promise<void> {
+ * 	this.tree.initialize(...);
+ * }
+ * ```
+ *
+ * @privateRemarks
+ * TODO: Before promoting this beyond internal, we should consider alternative API patterns that don't depend on
+ * sub-classing and don't leak Fluid concepts that should ideally be internal.
+ * See `tree-react-api` for an example of a pattern that avoids unnecessary leakage of implementation details.
+ *
+ * @internal
+ */
+export class TreeDataObject extends PureDataObject {
+    constructor() {
+        super(...arguments);
+        /**
+         * View derived from the underlying tree.
+         * @remarks Populated via {@link TreeDataObject.generateView}.
+         */
+        _TreeDataObject_view.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.
+     */
+    get treeView() {
+        if (__classPrivateFieldGet(this, _TreeDataObject_view, "f") === undefined) {
+            throw new UsageError(uninitializedErrorString);
+        }
+        return __classPrivateFieldGet(this, _TreeDataObject_view, "f");
+    }
+    async initializeInternal(existing) {
+        if (existing) {
+            // data store has a root tree so we just need to set it before calling initializingFromExisting
+            const channel = await this.runtime.getChannel(treeChannelId);
+            // TODO: Support using a Directory to Tree migration shim and DataObject's root channel ID
+            // to allow migrating from DataObject to TreeDataObject instead of just erroring in that case.
+            if (!SharedTree.is(channel)) {
+                throw new Error(`Content with id ${channel.id} is not a SharedTree and cannot be loaded with treeDataObject.`);
+            }
+            const sharedTree = channel;
+            __classPrivateFieldSet(this, _TreeDataObject_view, this.generateView(sharedTree), "f");
+        }
+        else {
+            const sharedTree = SharedTree.create(this.runtime, treeChannelId);
+            sharedTree.bindToContext();
+            __classPrivateFieldSet(this, _TreeDataObject_view, this.generateView(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_view = new WeakMap();
+//# sourceMappingURL=treeDataObject.js.map

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

@@ -0,0 +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;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,OAAgB,cAA0B,SAAQ,cAAc;IAAtE;;QAOC;;;WAGG;QACH,uCAA6B;IAyC9B,CAAC;IAvCA;;;;;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;YAClC,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,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 * @privateRemarks\n * TODO: Before promoting this beyond internal, we should consider alternative API patterns that don't depend on\n * sub-classing and don't leak Fluid concepts that should ideally be internal.\n * See `tree-react-api` for an example of a pattern that avoids unnecessary leakage of implementation details.\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 * 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\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.#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"]}

package/lib/index.d.ts

@@ -16,7 +16,7 @@
  *
  * @packageDocumentation
  */
-export { DataObjectFactory, PureDataObjectFactory } from "./data-object-factories/index.js";
-export { DataObject, type DataObjectKind, type DataObjectTypes, type IDataObjectProps, PureDataObject, createDataObjectKind, } from "./data-objects/index.js";
+export { DataObjectFactory, PureDataObjectFactory, } 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,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AAC5F,OAAO,EACN,UAAU,EACV,KAAK,cAAc,EACnB,KAAK,eAAe,EACpB,KAAK,gBAAgB,EACrB,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,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 { DataObject, PureDataObject, createDataObjectKind, } from "./data-objects/index.js";
+export { DataObjectFactory, PureDataObjectFactory, } 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,EAAE,iBAAiB,EAAE,qBAAqB,EAAE,MAAM,kCAAkC,CAAC;AAC5F,OAAO,EACN,UAAU,EAIV,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 { DataObjectFactory, PureDataObjectFactory } from \"./data-object-factories/index.js\";\nexport {\n\tDataObject,\n\ttype DataObjectKind,\n\ttype DataObjectTypes,\n\ttype IDataObjectProps,\n\tPureDataObject,\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,EACjB,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\tPureDataObjectFactory,\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/tsdoc-metadata.json

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/aqueduct",
-  "version": "2.30.0",
+  "version": "2.31.1",
   "description": "A set of implementations for Fluid Framework interfaces.",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -69,31 +69,33 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.30.0",
-    "@fluidframework/container-definitions": "~2.30.0",
-    "@fluidframework/container-runtime": "~2.30.0",
-    "@fluidframework/container-runtime-definitions": "~2.30.0",
-    "@fluidframework/core-interfaces": "~2.30.0",
-    "@fluidframework/core-utils": "~2.30.0",
-    "@fluidframework/datastore": "~2.30.0",
-    "@fluidframework/datastore-definitions": "~2.30.0",
-    "@fluidframework/map": "~2.30.0",
-    "@fluidframework/request-handler": "~2.30.0",
-    "@fluidframework/runtime-definitions": "~2.30.0",
-    "@fluidframework/runtime-utils": "~2.30.0",
-    "@fluidframework/shared-object-base": "~2.30.0",
-    "@fluidframework/synthesize": "~2.30.0"
+    "@fluid-internal/client-utils": "~2.31.1",
+    "@fluidframework/container-definitions": "~2.31.1",
+    "@fluidframework/container-runtime": "~2.31.1",
+    "@fluidframework/container-runtime-definitions": "~2.31.1",
+    "@fluidframework/core-interfaces": "~2.31.1",
+    "@fluidframework/core-utils": "~2.31.1",
+    "@fluidframework/datastore": "~2.31.1",
+    "@fluidframework/datastore-definitions": "~2.31.1",
+    "@fluidframework/map": "~2.31.1",
+    "@fluidframework/request-handler": "~2.31.1",
+    "@fluidframework/runtime-definitions": "~2.31.1",
+    "@fluidframework/runtime-utils": "~2.31.1",
+    "@fluidframework/shared-object-base": "~2.31.1",
+    "@fluidframework/synthesize": "~2.31.1",
+    "@fluidframework/telemetry-utils": "~2.31.1",
+    "@fluidframework/tree": "~2.31.1"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "~2.30.0",
+    "@fluid-internal/mocha-test-setup": "~2.31.1",
     "@fluid-tools/build-cli": "^0.54.0",
-    "@fluidframework/aqueduct-previous": "npm:@fluidframework/aqueduct@2.23.0",
+    "@fluidframework/aqueduct-previous": "npm:@fluidframework/aqueduct@2.31.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.54.0",
     "@fluidframework/eslint-config-fluid": "^5.7.3",
-    "@microsoft/api-extractor": "7.47.8",
+    "@microsoft/api-extractor": "7.50.1",
     "@types/mocha": "^10.0.10",
     "@types/node": "^18.19.0",
     "c8": "^8.0.1",
@@ -104,7 +106,6 @@
     "mocha": "^10.8.2",
     "mocha-multi-reporters": "^1.5.1",
     "moment": "^2.21.0",
-    "prettier": "~3.0.3",
     "rimraf": "^4.4.0",
     "typescript": "~5.4.5"
   },
@@ -136,7 +137,6 @@
     "check:exports:esm:legacy": "api-extractor run --config api-extractor/api-extractor-lint-legacy.esm.json",
     "check:exports:esm:public": "api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
     "check:format": "npm run check:biome",
-    "check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
     "ci:build:api-reports": "concurrently \"npm:ci:build:api-reports:*\"",
     "ci:build:api-reports:current": "api-extractor run --config api-extractor/api-extractor.current.json",
     "ci:build:api-reports:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
@@ -146,7 +146,6 @@
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
     "format": "npm run format:biome",
     "format:biome": "biome check . --write",
-    "format:prettier": "prettier --write . --cache --ignore-path ../../../.prettierignore",
     "lint": "fluid-build . --task lint",
     "lint:fix": "fluid-build . --task eslint:fix --task format",
     "test": "npm run test:mocha",

package/src/data-objects/createDataObjectKind.ts

@@ -0,0 +1,19 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+import type { SharedObjectKind } from "@fluidframework/shared-object-base";
+
+import type { DataObjectKind } from "./types.js";
+
+/**
+ * Utility for creating SharedObjectKind instances for data objects.
+ * @typeParam T - The kind of data object.
+ * @internal
+ */
+export function createDataObjectKind<T extends DataObjectKind>(
+	factory: T,
+): T & SharedObjectKind<T extends DataObjectKind<infer I> ? I : unknown> {
+	return factory as T & SharedObjectKind<T extends DataObjectKind<infer I> ? I : unknown>;
+}

package/src/data-objects/dataObject.ts

@@ -8,10 +8,9 @@ import {
 	MapFactory,
 	SharedDirectory,
 } from "@fluidframework/map/internal";
-import type { SharedObjectKind } from "@fluidframework/shared-object-base";
 
 import { PureDataObject } from "./pureDataObject.js";
-import type { DataObjectKind, DataObjectTypes } from "./types.js";
+import type { DataObjectTypes } from "./types.js";
 
 /**
  * DataObject is a base data store that is primed with a root directory. It
@@ -82,14 +81,3 @@ export abstract class DataObject<
 		return `${item} must be initialized before being accessed.`;
 	}
 }
-
-/**
- * Utility for creating SharedObjectKind instances for data objects.
- * @typeParam T - The kind of data object.
- * @internal
- */
-export function createDataObjectKind<T extends DataObjectKind>(
-	factory: T,
-): T & SharedObjectKind<T extends DataObjectKind<infer I> ? I : unknown> {
-	return factory as T & SharedObjectKind<T extends DataObjectKind<infer I> ? I : unknown>;
-}

package/src/data-objects/index.ts

@@ -3,6 +3,8 @@
  * Licensed under the MIT License.
  */
 
-export { DataObject, createDataObjectKind } from "./dataObject.js";
+export { createDataObjectKind } from "./createDataObjectKind.js";
+export { DataObject } from "./dataObject.js";
 export { PureDataObject } from "./pureDataObject.js";
+export { TreeDataObject } from "./treeDataObject.js";
 export type { DataObjectKind, DataObjectTypes, IDataObjectProps } from "./types.js";

package/src/data-objects/treeDataObject.ts

@@ -0,0 +1,98 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+
+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 { PureDataObject } from "./pureDataObject.js";
+
+/**
+ * Channel ID of {@link TreeDataObject}'s root {@link @fluidframework/tree#SharedTree}.
+ */
+const treeChannelId = "tree-data-object";
+
+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}.
+ *
+ * @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}.
+ *
+ * @typeParam TTreeView - View derived from the underlying tree.
+ * Can be used to derive schema-aware views of the tree.
+ * See {@link TreeDataObject.generateView}.
+ *
+ * @example Implementing `initializingFirstTime`
+ *
+ * ```typescript
+ * protected override async initializingFirstTime(): Promise<void> {
+ * 	this.tree.initialize(...);
+ * }
+ * ```
+ *
+ * @privateRemarks
+ * TODO: Before promoting this beyond internal, we should consider alternative API patterns that don't depend on
+ * sub-classing and don't leak Fluid concepts that should ideally be internal.
+ * See `tree-react-api` for an example of a pattern that avoids unnecessary leakage of implementation details.
+ *
+ * @internal
+ */
+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;
+
+	/**
+	 * 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.
+	 */
+	public get treeView(): TTreeView {
+		if (this.#view === undefined) {
+			throw new UsageError(uninitializedErrorString);
+		}
+		return this.#view;
+	}
+
+	public override async initializeInternal(existing: boolean): Promise<void> {
+		if (existing) {
+			// data store has a root tree so we just need to set it before calling initializingFromExisting
+			const channel = await this.runtime.getChannel(treeChannelId);
+
+			// TODO: Support using a Directory to Tree migration shim and DataObject's root channel ID
+			// to allow migrating from DataObject to TreeDataObject instead of just erroring in that case.
+			if (!SharedTree.is(channel)) {
+				throw new Error(
+					`Content with id ${channel.id} is not a SharedTree and cannot be loaded with treeDataObject.`,
+				);
+			}
+			const sharedTree: ITree = channel;
+			this.#view = this.generateView(sharedTree);
+		} else {
+			const sharedTree = SharedTree.create(this.runtime, treeChannelId);
+			(sharedTree as unknown as ISharedObject).bindToContext();
+
+			this.#view = this.generateView(sharedTree);
+
+			// Note, the implementer is responsible for initializing the tree with initial data.
+			// Generally, this can be done via `initializingFirstTime`.
+		}
+
+		await super.initializeInternal(existing);
+	}
+}

package/src/index.ts

@@ -18,13 +18,17 @@
  * @packageDocumentation
  */
 
-export { DataObjectFactory, PureDataObjectFactory } from "./data-object-factories/index.js";
+export {
+	DataObjectFactory,
+	PureDataObjectFactory,
+} from "./data-object-factories/index.js";
 export {
 	DataObject,
 	type DataObjectKind,
 	type DataObjectTypes,
 	type IDataObjectProps,
 	PureDataObject,
+	TreeDataObject,
 	createDataObjectKind,
 } from "./data-objects/index.js";
 export {

package/prettier.config.cjs

@@ -1,8 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-
-module.exports = {
-	...require("@fluidframework/build-common/prettier.config.cjs"),
-};