@fluidframework/tree 2.5.0 → 2.10.0-304831

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/tree",
-  "version": "2.5.0",
+  "version": "2.10.0-304831",
   "description": "Distributed tree",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -89,17 +89,17 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.5.0",
-    "@fluidframework/container-runtime": "~2.5.0",
-    "@fluidframework/core-interfaces": "~2.5.0",
-    "@fluidframework/core-utils": "~2.5.0",
-    "@fluidframework/datastore-definitions": "~2.5.0",
-    "@fluidframework/driver-definitions": "~2.5.0",
-    "@fluidframework/id-compressor": "~2.5.0",
-    "@fluidframework/runtime-definitions": "~2.5.0",
-    "@fluidframework/runtime-utils": "~2.5.0",
-    "@fluidframework/shared-object-base": "~2.5.0",
-    "@fluidframework/telemetry-utils": "~2.5.0",
+    "@fluid-internal/client-utils": "2.10.0-304831",
+    "@fluidframework/container-runtime": "2.10.0-304831",
+    "@fluidframework/core-interfaces": "2.10.0-304831",
+    "@fluidframework/core-utils": "2.10.0-304831",
+    "@fluidframework/datastore-definitions": "2.10.0-304831",
+    "@fluidframework/driver-definitions": "2.10.0-304831",
+    "@fluidframework/id-compressor": "2.10.0-304831",
+    "@fluidframework/runtime-definitions": "2.10.0-304831",
+    "@fluidframework/runtime-utils": "2.10.0-304831",
+    "@fluidframework/shared-object-base": "2.10.0-304831",
+    "@fluidframework/telemetry-utils": "2.10.0-304831",
     "@sinclair/typebox": "^0.32.29",
     "@tylerbu/sorted-btree-es6": "^1.8.0",
     "@types/ungap__structured-clone": "^1.2.0",
@@ -109,20 +109,20 @@
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.16.4",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "~2.5.0",
-    "@fluid-private/stochastic-test-utils": "~2.5.0",
-    "@fluid-private/test-dds-utils": "~2.5.0",
-    "@fluid-private/test-drivers": "~2.5.0",
+    "@fluid-internal/mocha-test-setup": "2.10.0-304831",
+    "@fluid-private/stochastic-test-utils": "2.10.0-304831",
+    "@fluid-private/test-dds-utils": "2.10.0-304831",
+    "@fluid-private/test-drivers": "2.10.0-304831",
     "@fluid-tools/benchmark": "^0.50.0",
-    "@fluid-tools/build-cli": "^0.49.0",
+    "@fluid-tools/build-cli": "^0.50.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.49.0",
-    "@fluidframework/container-definitions": "~2.5.0",
-    "@fluidframework/container-loader": "~2.5.0",
+    "@fluidframework/build-tools": "^0.50.0",
+    "@fluidframework/container-definitions": "2.10.0-304831",
+    "@fluidframework/container-loader": "2.10.0-304831",
     "@fluidframework/eslint-config-fluid": "^5.4.0",
-    "@fluidframework/test-runtime-utils": "~2.5.0",
-    "@fluidframework/test-utils": "~2.5.0",
-    "@fluidframework/tree-previous": "npm:@fluidframework/tree@~2.4.0",
+    "@fluidframework/test-runtime-utils": "2.10.0-304831",
+    "@fluidframework/test-utils": "2.10.0-304831",
+    "@fluidframework/tree-previous": "npm:@fluidframework/tree@2.5.0",
     "@microsoft/api-extractor": "7.47.8",
     "@types/diff": "^3.5.1",
     "@types/easy-table": "^0.0.32",
@@ -164,48 +164,12 @@
   },
   "typeValidation": {
     "broken": {
-      "TypeAlias_InsertableTreeFieldFromImplicitField": {
+      "TypeAlias_Input": {
         "backCompat": false,
         "forwardCompat": false
       },
-      "Interface_TreeArrayNode": {
+      "Interface_InternalTypes_TreeArrayNodeBase": {
         "backCompat": false
-      },
-      "TypeAlias_InsertableTreeNodeFromImplicitAllowedTypes": {
-        "backCompat": false,
-        "forwardCompat": false
-      },
-      "TypeAlias_NodeFromSchema": {
-        "backCompat": false
-      },
-      "TypeAlias_TreeFieldFromImplicitField": {
-        "backCompat": false
-      },
-      "TypeAlias_TreeNodeFromImplicitAllowedTypes": {
-        "backCompat": false
-      },
-      "TypeAlias_InternalTypes_ApplyKind": {
-        "forwardCompat": false,
-        "backCompat": false
-      },
-      "TypeAlias_InternalTypes_InsertableObjectFromSchemaRecord": {
-        "forwardCompat": false,
-        "backCompat": false
-      },
-      "TypeAlias_InsertableTreeFieldFromImplicitFieldUnsafe": {
-        "forwardCompat": false
-      },
-      "TypeAlias_InternalTypes_InsertableTreeFieldFromImplicitFieldUnsafe": {
-        "forwardCompat": false
-      },
-      "Interface_ITreeViewConfiguration": {
-        "forwardCompat": false
-      },
-      "TypeAlias_ImplicitAllowedTypes": {
-        "forwardCompat": false
-      },
-      "TypeAlias_ImplicitFieldSchema": {
-        "forwardCompat": false
       }
     },
     "entrypoint": "public"

package/src/core/rebase/types.ts

@@ -161,11 +161,11 @@ export interface GraphCommit<TChange> {
  * @public
  */
 export enum CommitKind {
-	/** A commit corresponding to a change that is not the result of an undo/redo. */
+	/** A commit corresponding to a change that is not the result of an undo/redo from this client. */
 	Default,
-	/** A commit that is the result of an undo. */
+	/** A commit that is the result of an undo from this client. */
 	Undo,
-	/** A commit that is the result of a redo. */
+	/** A commit that is the result of a redo from this client. */
 	Redo,
 }
 

package/src/core/revertible.ts

@@ -50,7 +50,7 @@ export enum RevertibleStatus {
 
 /**
  * Factory for creating a {@link Revertible}.
- * Will error if invoked outside the scope of the `commitApplied` event that provides it, or if invoked multiple times.
+ * Will error if invoked outside the scope of the `changed` event that provides it, or if invoked multiple times.
  *
  * @param onRevertibleDisposed - A callback that will be invoked when the `Revertible` generated by this factory is disposed.
  * This happens when the `Revertible` is disposed manually, or when the `TreeView` that the `Revertible` belongs to is disposed,

package/src/internalTypes.ts

@@ -13,7 +13,6 @@ export type {
 	ApplyKindInput,
 	NodeBuilderData,
 	FieldHasDefault,
-	TreeArrayNodeBase,
 	ScopedSchemaName,
 	DefaultProvider,
 	typeNameSymbol,

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/tree";
-export const pkgVersion = "2.5.0";
+export const pkgVersion = "2.10.0-304831";

package/src/shared-tree/schematizingTreeView.ts

@@ -47,6 +47,7 @@ import {
 	type ReadSchema,
 	type UnsafeUnknownSchema,
 	type TreeBranch,
+	type TreeBranchEvents,
 } from "../simple-tree/index.js";
 import { Breakable, breakingClass, disposeSymbol, type WithBreakable } from "../util/index.js";
 
@@ -84,9 +85,9 @@ export class SchematizingSimpleTreeView<
 	 */
 	private currentCompatibility: SchemaCompatibilityStatus | undefined;
 	private readonly schemaPolicy: SchemaPolicy;
-	public readonly events: Listenable<TreeViewEvents> &
-		IEmitter<TreeViewEvents> &
-		HasListeners<TreeViewEvents> = createEmitter();
+	public readonly events: Listenable<TreeViewEvents & TreeBranchEvents> &
+		IEmitter<TreeViewEvents & TreeBranchEvents> &
+		HasListeners<TreeViewEvents & TreeBranchEvents> = createEmitter();
 
 	private readonly viewSchema: ViewSchema;
 
@@ -133,9 +134,10 @@ export class SchematizingSimpleTreeView<
 		this.update();
 
 		this.unregisterCallbacks.add(
-			this.checkout.events.on("commitApplied", (data, getRevertible) =>
-				this.events.emit("commitApplied", data, getRevertible),
-			),
+			this.checkout.events.on("changed", (data, getRevertible) => {
+				this.events.emit("changed", data, getRevertible);
+				this.events.emit("commitApplied", data, getRevertible);
+			}),
 		);
 	}
 

package/src/shared-tree/treeCheckout.ts

@@ -85,18 +85,14 @@ export interface CheckoutEvents {
 	afterBatch(): void;
 
 	/**
-	 * Fired when a revertible change has been made to this view.
+	 * Fired when a change is made to the branch. Includes data about the change that is made which listeners
+	 * can use to filter on changes they care about e.g. local vs remote changes.
 	 *
-	 * Applications which subscribe to this event are expected to revert or discard revertibles they acquire (failure to do so will leak memory).
-	 * The provided revertible is inherently bound to the view that raised the event, calling `revert` won't apply to forked views.
-	 *
-	 * @param revertible - The revertible that can be used to revert the change.
-	 */
-
-	/**
-	 * {@inheritdoc TreeViewEvents.commitApplied}
+	 * @param data - information about the change
+	 * @param getRevertible - a function provided that allows users to get a revertible for the change. If not provided,
+	 * this change is not revertible.
 	 */
-	commitApplied(data: CommitMetadata, getRevertible?: RevertibleFactory): void;
+	changed(data: CommitMetadata, getRevertible?: RevertibleFactory): void;
 }
 
 /**
@@ -118,7 +114,7 @@ export interface BranchableTree extends ViewableTree {
 	 * @param view - a branch which was created by a call to `branch()`.
 	 * It is automatically disposed after the merge completes.
 	 * @remarks All ongoing transactions (if any) in `branch` will be committed before the merge.
-	 * A "commitApplied" event and a corresponding {@link Revertible} will be emitted on this branch for each new change merged from 'branch'.
+	 * A "changed" event and a corresponding {@link Revertible} will be emitted on this branch for each new change merged from 'branch'.
 	 */
 	merge(branch: TreeBranchFork): void;
 
@@ -532,12 +528,12 @@ export class TreeCheckout implements ITreeCheckoutFork {
 							: (onRevertibleDisposed?: (revertible: Revertible) => void) => {
 									if (!withinEventContext) {
 										throw new UsageError(
-											"Cannot get a revertible outside of the context of a commitApplied event.",
+											"Cannot get a revertible outside of the context of a changed event.",
 										);
 									}
 									if (this.revertibleCommitBranches.get(revision) !== undefined) {
 										throw new UsageError(
-											"Cannot generate the same revertible more than once. Note that this can happen when multiple commitApplied event listeners are registered.",
+											"Cannot generate the same revertible more than once. Note that this can happen when multiple changed event listeners are registered.",
 										);
 									}
 									const revertibleCommits = this.revertibleCommitBranches;
@@ -582,9 +578,12 @@ export class TreeCheckout implements ITreeCheckoutFork {
 								};
 
 						let withinEventContext = true;
-						this.events.emit("commitApplied", { isLocal: true, kind }, getRevertible);
+						this.events.emit("changed", { isLocal: true, kind }, getRevertible);
 						withinEventContext = false;
 					}
+				} else if (event.type === "replace") {
+					// TODO: figure out how to plumb through commit kind info for remote changes
+					this.events.emit("changed", { isLocal: false, kind: CommitKind.Default });
 				}
 			}
 		});

package/src/simple-tree/api/tree.ts

@@ -522,11 +522,13 @@ export interface TreeView<in out TSchema extends ImplicitFieldSchema> extends ID
 export interface TreeViewAlpha<
 	in out TSchema extends ImplicitFieldSchema | UnsafeUnknownSchema,
 > extends Omit<TreeView<ReadSchema<TSchema>>, "root" | "initialize">,
-		Omit<TreeBranch, "events"> {
+		TreeBranch {
 	get root(): ReadableField<TSchema>;
 
 	set root(newRoot: InsertableField<TSchema>);
 
+	readonly events: Listenable<TreeViewEvents & TreeBranchEvents>;
+
 	initialize(content: InsertableField<TSchema>): void;
 
 	// Override the base branch method to return a typed view rather than merely a branch.
@@ -619,6 +621,16 @@ export interface TreeBranchEvents {
 	 */
 	schemaChanged(): void;
 
+	/**
+	 * Fired when a change is made to the branch. Includes data about the change that is made which listeners
+	 * can use to filter on changes they care about (e.g. local vs. remote changes).
+	 *
+	 * @param data - information about the change
+	 * @param getRevertible - a function that allows users to get a revertible for the change. If not provided,
+	 * this change is not revertible.
+	 */
+	changed(data: CommitMetadata, getRevertible?: RevertibleFactory): void;
+
 	/**
 	 * Fired when:
 	 * - a local commit is applied outside of a transaction

package/src/simple-tree/api/typesUnsafe.ts

@@ -23,7 +23,7 @@ import type {
 	TreeNodeSchema,
 	TreeNodeSchemaCore,
 } from "../core/index.js";
-import type { TreeArrayNodeBase } from "../arrayNode.js";
+import type { TreeArrayNode } from "../arrayNode.js";
 import type { FlexListToUnion, LazyItem } from "../flexList.js";
 
 /*
@@ -238,7 +238,8 @@ export type NodeBuilderDataUnsafe<T extends Unenforced<TreeNodeSchema>> =
  * @system @sealed @public
  */
 export interface TreeArrayNodeUnsafe<TAllowedTypes extends Unenforced<ImplicitAllowedTypes>>
-	extends TreeArrayNodeBase<
+	extends TreeArrayNode<
+		TAllowedTypes,
 		TreeNodeFromImplicitAllowedTypesUnsafe<TAllowedTypes>,
 		InsertableTreeNodeFromImplicitAllowedTypesUnsafe<TAllowedTypes>
 	> {}

package/src/simple-tree/arrayNode.ts

@@ -46,6 +46,7 @@ import {
 } from "./core/index.js";
 import { TreeNodeValid, type MostDerivedData } from "./treeNodeValid.js";
 import { getUnhydratedContext } from "./createContext.js";
+import type { Unenforced } from "./api/index.js";
 
 /**
  * A covariant base type for {@link (TreeArrayNode:interface)}.
@@ -61,15 +62,25 @@ export interface ReadonlyArrayNode<out T = TreeNode | TreeLeafValue>
 		Awaited<TreeNode & WithType<string, NodeKind.Array>> {}
 
 /**
- * A generic array type, used to defined types like {@link (TreeArrayNode:interface)}.
+ * A {@link TreeNode} which implements 'readonly T[]' and the array mutation APIs.
  *
- * @privateRemarks
- * Inlining this into TreeArrayNode causes recursive array use to stop compiling.
+ * @typeParam TAllowedTypes - Schema for types which are allowed as members of this array.
+ * @typeParam T - Use Default: Do not specify. Type of values to read from the array.
+ * @typeParam TNew - Use Default: Do not specify. Type of values to write into the array.
+ * @typeParam TMoveFrom - Use Default: Do not specify. Type of node from which children can be moved into this array.
  *
- * @system @sealed @public
+ * @sealed @public
  */
-export interface TreeArrayNodeBase<out T, in TNew, in TMoveFrom = ReadonlyArrayNode>
-	extends ReadonlyArrayNode<T> {
+export interface TreeArrayNode<
+	TAllowedTypes extends Unenforced<ImplicitAllowedTypes> = ImplicitAllowedTypes,
+	out T = [TAllowedTypes] extends [ImplicitAllowedTypes]
+		? TreeNodeFromImplicitAllowedTypes<TAllowedTypes>
+		: TreeNodeFromImplicitAllowedTypes<ImplicitAllowedTypes>,
+	in TNew = [TAllowedTypes] extends [ImplicitAllowedTypes]
+		? InsertableTreeNodeFromImplicitAllowedTypes<TAllowedTypes>
+		: InsertableTreeNodeFromImplicitAllowedTypes<ImplicitAllowedTypes>,
+	in TMoveFrom = ReadonlyArrayNode,
+> extends ReadonlyArrayNode<T> {
 	/**
 	 * Inserts new item(s) at a specified location.
 	 * @param index - The index at which to insert `value`.
@@ -369,20 +380,6 @@ export interface TreeArrayNodeBase<out T, in TNew, in TMoveFrom = ReadonlyArrayN
 	values(): IterableIterator<T>;
 }
 
-/**
- * A {@link TreeNode} which implements 'readonly T[]' and the array mutation APIs.
- *
- * @typeParam TAllowedTypes - Schema for types which are allowed as members of this array.
- *
- * @sealed @public
- */
-export interface TreeArrayNode<
-	TAllowedTypes extends ImplicitAllowedTypes = ImplicitAllowedTypes,
-> extends TreeArrayNodeBase<
-		TreeNodeFromImplicitAllowedTypes<TAllowedTypes>,
-		InsertableTreeNodeFromImplicitAllowedTypes<TAllowedTypes>
-	> {}
-
 /**
  * A {@link TreeNode} which implements 'readonly T[]' and the array mutation APIs.
  * @public

package/src/simple-tree/index.ts

@@ -146,7 +146,6 @@ export {
 export {
 	TreeArrayNode,
 	IterableTreeArrayContent,
-	type TreeArrayNodeBase,
 	type ReadonlyArrayNode,
 } from "./arrayNode.js";
 export {