@fluidframework/tree 2.60.0 → 2.61.0-355516

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/tree",
-  "version": "2.60.0",
+  "version": "2.61.0-355516",
   "description": "Distributed tree",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -101,17 +101,17 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.60.0",
-    "@fluidframework/container-runtime": "~2.60.0",
-    "@fluidframework/core-interfaces": "~2.60.0",
-    "@fluidframework/core-utils": "~2.60.0",
-    "@fluidframework/datastore-definitions": "~2.60.0",
-    "@fluidframework/driver-definitions": "~2.60.0",
-    "@fluidframework/id-compressor": "~2.60.0",
-    "@fluidframework/runtime-definitions": "~2.60.0",
-    "@fluidframework/runtime-utils": "~2.60.0",
-    "@fluidframework/shared-object-base": "~2.60.0",
-    "@fluidframework/telemetry-utils": "~2.60.0",
+    "@fluid-internal/client-utils": "2.61.0-355516",
+    "@fluidframework/container-runtime": "2.61.0-355516",
+    "@fluidframework/core-interfaces": "2.61.0-355516",
+    "@fluidframework/core-utils": "2.61.0-355516",
+    "@fluidframework/datastore-definitions": "2.61.0-355516",
+    "@fluidframework/driver-definitions": "2.61.0-355516",
+    "@fluidframework/id-compressor": "2.61.0-355516",
+    "@fluidframework/runtime-definitions": "2.61.0-355516",
+    "@fluidframework/runtime-utils": "2.61.0-355516",
+    "@fluidframework/shared-object-base": "2.61.0-355516",
+    "@fluidframework/telemetry-utils": "2.61.0-355516",
     "@sinclair/typebox": "^0.34.13",
     "@tylerbu/sorted-btree-es6": "^1.8.0",
     "@types/ungap__structured-clone": "^1.2.0",
@@ -121,28 +121,28 @@
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "~2.60.0",
-    "@fluid-private/stochastic-test-utils": "~2.60.0",
-    "@fluid-private/test-dds-utils": "~2.60.0",
-    "@fluid-private/test-drivers": "~2.60.0",
+    "@fluid-internal/mocha-test-setup": "2.61.0-355516",
+    "@fluid-private/stochastic-test-utils": "2.61.0-355516",
+    "@fluid-private/test-dds-utils": "2.61.0-355516",
+    "@fluid-private/test-drivers": "2.61.0-355516",
     "@fluid-tools/benchmark": "^0.51.0",
-    "@fluid-tools/build-cli": "^0.57.0",
+    "@fluid-tools/build-cli": "^0.58.1",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.57.0",
-    "@fluidframework/container-definitions": "~2.60.0",
-    "@fluidframework/container-loader": "~2.60.0",
+    "@fluidframework/build-tools": "^0.58.1",
+    "@fluidframework/container-definitions": "2.61.0-355516",
+    "@fluidframework/container-loader": "2.61.0-355516",
     "@fluidframework/eslint-config-fluid": "^6.0.0",
-    "@fluidframework/test-runtime-utils": "~2.60.0",
-    "@fluidframework/test-utils": "~2.60.0",
-    "@fluidframework/tree-previous": "npm:@fluidframework/tree@2.53.0",
-    "@microsoft/api-extractor": "7.52.8",
+    "@fluidframework/test-runtime-utils": "2.61.0-355516",
+    "@fluidframework/test-utils": "2.61.0-355516",
+    "@fluidframework/tree-previous": "npm:@fluidframework/tree@2.60.0",
+    "@microsoft/api-extractor": "7.52.11",
     "@types/diff": "^3.5.1",
     "@types/easy-table": "^0.0.32",
     "@types/mocha": "^10.0.10",
     "@types/node": "^18.19.0",
     "ajv": "^8.12.0",
     "ajv-formats": "^3.0.1",
-    "c8": "^8.0.1",
+    "c8": "^10.1.3",
     "concurrently": "^8.2.1",
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
@@ -177,8 +177,8 @@
   },
   "scripts": {
     "api": "fluid-build . --task api",
-    "api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
-    "api-extractor:esnext": "flub generate entrypoints --outDir ./lib --node10TypeCompat",
+    "api-extractor:commonjs": "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./dist",
+    "api-extractor:esnext": "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./lib --node10TypeCompat",
     "bench": "mocha --timeout 999999 --perfMode --parentProcess --fgrep @Benchmark --fgrep @ExecutionTime --reporter @fluid-tools/benchmark/dist/MochaReporter.js",
     "bench:profile": "mocha --v8-prof --v8-logfile=profile.log --v8-no-logfile-per-isolate --timeout 999999 --perfMode --fgrep @Benchmark --fgrep @ExecutionTime --reporter @fluid-tools/benchmark/dist/MochaReporter.js && node --prof-process profile.log > profile.txt && rimraf profile.log && echo See results in profile.txt",
     "build": "fluid-build . --task build",

package/src/core/tree/anchorSet.ts

@@ -6,7 +6,7 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 
 import { createEmitter } from "@fluid-internal/client-utils";
-import type { Listenable } from "@fluidframework/core-interfaces/internal";
+import type { HasListeners, Listenable } from "@fluidframework/core-interfaces/internal";
 import { assert, fail } from "@fluidframework/core-utils/internal";
 
 import {
@@ -210,7 +210,7 @@ export interface AnchorNode extends INormalizedUpPath<AnchorNode> {
 	/**
 	 * Events for this anchor node.
 	 */
-	readonly events: Listenable<AnchorEvents>;
+	readonly events: Listenable<AnchorEvents> & HasListeners<AnchorEvents>;
 
 	/**
 	 * Allows access to data stored on the Anchor in "slots".

package/src/index.ts

@@ -267,6 +267,7 @@ export {
 	type TreeRecordNode,
 	KeyEncodingOptions,
 	type TreeParsingOptions,
+	type SchemaFactory_base,
 } from "./simple-tree/index.js";
 export {
 	SharedTree,

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/tree";
-export const pkgVersion = "2.60.0";
+export const pkgVersion = "2.61.0-355516";

package/src/shared-tree/treeCheckout.ts

@@ -883,6 +883,7 @@ export class TreeCheckout implements ITreeCheckoutFork {
 	}
 
 	private revertRevertible(revision: RevisionTag, kind: CommitKind): RevertMetrics {
+		this.editLock.checkUnlocked("Reverting a commit");
 		if (this.transaction.isInProgress()) {
 			throw new UsageError("Undo is not yet supported during transactions.");
 		}

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

@@ -31,6 +31,7 @@ export {
 	type SchemaFactoryObjectOptions,
 	type NodeSchemaOptions,
 	type NodeSchemaOptionsAlpha,
+	type SchemaFactory_base,
 } from "./schemaFactory.js";
 export { SchemaFactoryBeta } from "./schemaFactoryBeta.js";
 export { SchemaFactoryAlpha, type SchemaStaticsAlpha } from "./schemaFactoryAlpha.js";

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

@@ -174,6 +174,33 @@ export type ScopedSchemaName<
 
 const schemaStaticsPublic: SchemaStatics = schemaStatics;
 
+/**
+ * Create a class with `Statics` as both static properties and member properties.
+ * @privateRemarks
+ * An attempt was made to let this take in a base class so it could be used again on SchemaFactoryAlpha.
+ * This was unsuccessful, mostly due to issues with trying to manipulate constructor types.
+ */
+function classWithStatics<Statics extends object>(
+	statics: Statics,
+): Statics & (new () => Statics) {
+	// eslint-disable-next-line @typescript-eslint/no-extraneous-class
+	class WithStatics {}
+
+	Object.assign(WithStatics.prototype, statics);
+	Object.assign(WithStatics, statics);
+	return WithStatics as Statics & (new () => Statics);
+}
+
+/**
+ * Base class for SchemaFactory, exposes {@link SchemaStatics} as both static properties and member properties.
+ * @remarks
+ * Do not use this directly, use {@link SchemaFactory} instead.
+ * @privateRemarks
+ * Exported only as a workaround for {@link https://github.com/microsoft/TypeScript/issues/59550} and {@link https://github.com/microsoft/rushstack/issues/4429}.
+ * @system @public
+ */
+export const SchemaFactory_base = classWithStatics(schemaStaticsPublic);
+
 // TODO:
 // SchemaFactory.array references should link to the correct overloads, however the syntax for this does not seems to work currently for methods unless the they are not qualified with the class.
 // API-Extractor requires such links to be qualified with the class, so it can't work.
@@ -289,8 +316,7 @@ const schemaStaticsPublic: SchemaStatics = schemaStatics;
 export class SchemaFactory<
 	out TScope extends string | undefined = string | undefined,
 	TName extends number | string = string,
-> implements SchemaStatics
-{
+> extends SchemaFactory_base {
 	/**
 	 * TODO:
 	 * If users of this generate the same name because two different schema with the same identifier were used,
@@ -339,67 +365,9 @@ export class SchemaFactory<
 		 * ```
 		 */
 		public readonly scope: TScope,
-	) {}
-
-	/**
-	 * {@inheritDoc SchemaStatics.string}
-	 */
-	public readonly string = schemaStaticsPublic.string;
-
-	/**
-	 * {@inheritDoc SchemaStatics.number}
-	 */
-	public readonly number = schemaStaticsPublic.number;
-
-	/**
-	 * {@inheritDoc SchemaStatics.boolean}
-	 */
-	public readonly boolean = schemaStaticsPublic.boolean;
-
-	/**
-	 * {@inheritDoc SchemaStatics.null}
-	 */
-	public readonly null = schemaStaticsPublic.null;
-
-	/**
-	 * {@inheritDoc SchemaStatics.handle}
-	 */
-	public readonly handle = schemaStaticsPublic.handle;
-
-	/**
-	 * {@inheritDoc SchemaStatics.leaves}
-	 */
-	public readonly leaves = schemaStaticsPublic.leaves;
-
-	/**
-	 * {@inheritDoc SchemaStatics.string}
-	 */
-	public static readonly string = schemaStaticsPublic.string;
-
-	/**
-	 * {@inheritDoc SchemaStatics.number}
-	 */
-	public static readonly number = schemaStaticsPublic.number;
-
-	/**
-	 * {@inheritDoc SchemaStatics.boolean}
-	 */
-	public static readonly boolean = schemaStaticsPublic.boolean;
-
-	/**
-	 * {@inheritDoc SchemaStatics.null}
-	 */
-	public static readonly null = schemaStaticsPublic.null;
-
-	/**
-	 * {@inheritDoc SchemaStatics.handle}
-	 */
-	public static readonly handle = schemaStaticsPublic.handle;
-
-	/**
-	 * {@inheritDoc SchemaStatics.leaves}
-	 */
-	public static readonly leaves = schemaStaticsPublic.leaves;
+	) {
+		super();
+	}
 
 	/**
 	 * Define a {@link TreeNodeSchemaClass} for a {@link TreeObjectNode}.
@@ -807,46 +775,6 @@ export class SchemaFactory<
 		>;
 	}
 
-	/**
-	 * {@inheritDoc SchemaStatics.optional}
-	 */
-	public readonly optional = schemaStaticsPublic.optional;
-
-	/**
-	 * {@inheritDoc SchemaStatics.required}
-	 */
-	public readonly required = schemaStaticsPublic.required;
-
-	/**
-	 * {@inheritDoc SchemaStatics.optionalRecursive}
-	 */
-	public readonly optionalRecursive = schemaStaticsPublic.optionalRecursive;
-
-	/**
-	 * {@inheritDoc SchemaStatics.requiredRecursive}
-	 */
-	public readonly requiredRecursive = schemaStaticsPublic.requiredRecursive;
-
-	/**
-	 * {@inheritDoc SchemaStatics.optional}
-	 */
-	public static readonly optional = schemaStaticsPublic.optional;
-
-	/**
-	 * {@inheritDoc SchemaStatics.required}
-	 */
-	public static readonly required = schemaStaticsPublic.required;
-
-	/**
-	 * {@inheritDoc SchemaStatics.optionalRecursive}
-	 */
-	public static readonly optionalRecursive = schemaStaticsPublic.optionalRecursive;
-
-	/**
-	 * {@inheritDoc SchemaStatics.requiredRecursive}
-	 */
-	public static readonly requiredRecursive = schemaStaticsPublic.requiredRecursive;
-
 	/**
 	 * A special readonly field which holds an identifier string for an object node.
 	 * @remarks

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

@@ -11,6 +11,7 @@ import type {
 	TreeNode,
 	ImplicitAllowedTypes,
 	InsertableTreeNodeFromImplicitAllowedTypes,
+	TreeNodeSchemaClass,
 } from "../core/index.js";
 import type { InsertableObjectFromSchemaRecord } from "../node-kinds/index.js";
 import type { ImplicitFieldSchema } from "../fieldSchema.js";
@@ -136,50 +137,50 @@ import type { ImplicitFieldSchema } from "../fieldSchema.js";
  * TODO: this currently does not reject `any`, but ideally should.
  * @public
  */
-export type ValidateRecursiveSchema<
-	// Recursive types should always be using TreeNodeSchemaClass (not TreeNodeSchemaNonClass) as thats part of the requirements for the type to work across compilation boundaries correctly.
-	T extends ValidateRecursiveSchemaTemplate<T>,
-> = true;
+export type ValidateRecursiveSchema<T extends ValidateRecursiveSchemaTemplate<T>> = true;
 
 /**
  * Validation logic used by {@link ValidateRecursiveSchema}.
+ * @privateRemarks
+ * Recursive types should always be using TreeNodeSchemaClass (not TreeNodeSchemaNonClass) as that's part of the requirements for the type to work across compilation boundaries correctly.
  * @system @public
  */
-export type ValidateRecursiveSchemaTemplate<T extends TreeNodeSchema> = TreeNodeSchema<
-	// Name: This validator places no restrictions on the name other than that it's a string (as required by TreeNodeSchemaClass).
-	string,
-	// NodeKind: These are the NodeKinds which currently can be used recursively.
-	NodeKind.Array | NodeKind.Map | NodeKind.Object | NodeKind.Record,
-	// TNode: The produced node API. This is pretty minimal validation: more could be added if similar to how TInsertable works below if needed.
-	TreeNode & WithType<T["identifier"], T["kind"]>,
-	// TInsertable: What can be passed to the constructor. This should be enough to catch most issues with incorrect schema.
-	// These match whats defined in the recursive methods on `SchemaFactory` except they do not use `Unenforced`.
-	{
-		[NodeKind.Object]: T["info"] extends RestrictiveStringRecord<ImplicitFieldSchema>
-			? InsertableObjectFromSchemaRecord<T["info"]>
-			: unknown;
-		[NodeKind.Array]: T["info"] extends ImplicitAllowedTypes
-			? Iterable<InsertableTreeNodeFromImplicitAllowedTypes<T["info"]>>
-			: unknown;
-		[NodeKind.Map]: T["info"] extends ImplicitAllowedTypes
-			? Iterable<[string, InsertableTreeNodeFromImplicitAllowedTypes<T["info"]>]>
-			: unknown;
-		[NodeKind.Record]: {
-			readonly [P in string]: InsertableTreeNodeFromImplicitAllowedTypes<T>;
-		};
-		[NodeKind.Leaf]: unknown;
-	}[T["kind"]],
-	// ImplicitlyConstructable: recursive types are currently not implicitly constructable.
-	false,
-	// Info: What's passed to the method to create the schema. Constraining these here should be about as effective as if the actual constraints existed on the actual method itself.
-	{
-		[NodeKind.Object]: RestrictiveStringRecord<ImplicitFieldSchema>;
-		[NodeKind.Array]: ImplicitAllowedTypes;
-		[NodeKind.Map]: ImplicitAllowedTypes;
-		[NodeKind.Record]: ImplicitAllowedTypes;
-		[NodeKind.Leaf]: unknown;
-	}[T["kind"]]
->;
+export type ValidateRecursiveSchemaTemplate<T extends TreeNodeSchemaClass> =
+	TreeNodeSchemaClass<
+		// Name: This validator places no restrictions on the name other than that it's a string (as required by TreeNodeSchemaClass).
+		string,
+		// NodeKind: These are the NodeKinds which currently can be used recursively.
+		NodeKind.Array | NodeKind.Map | NodeKind.Object | NodeKind.Record,
+		// TNode: The produced node API. This is pretty minimal validation: more could be added if similar to how TInsertable works below if needed.
+		TreeNode & WithType<T["identifier"], T["kind"]>,
+		// TInsertable: What can be passed to the constructor. This should be enough to catch most issues with incorrect schema.
+		// These match whats defined in the recursive methods on `SchemaFactory` except they do not use `Unenforced`.
+		{
+			[NodeKind.Object]: T["info"] extends RestrictiveStringRecord<ImplicitFieldSchema>
+				? InsertableObjectFromSchemaRecord<T["info"]>
+				: unknown;
+			[NodeKind.Array]: T["info"] extends ImplicitAllowedTypes
+				? Iterable<InsertableTreeNodeFromImplicitAllowedTypes<T["info"]>>
+				: unknown;
+			[NodeKind.Map]: T["info"] extends ImplicitAllowedTypes
+				? Iterable<[string, InsertableTreeNodeFromImplicitAllowedTypes<T["info"]>]>
+				: unknown;
+			[NodeKind.Record]: {
+				readonly [P in string]: InsertableTreeNodeFromImplicitAllowedTypes<T>;
+			};
+			[NodeKind.Leaf]: unknown;
+		}[T["kind"]],
+		// ImplicitlyConstructable: recursive types are currently not implicitly constructable.
+		false,
+		// Info: What's passed to the method to create the schema. Constraining these here should be about as effective as if the actual constraints existed on the actual method itself.
+		{
+			[NodeKind.Object]: RestrictiveStringRecord<ImplicitFieldSchema>;
+			[NodeKind.Array]: ImplicitAllowedTypes;
+			[NodeKind.Map]: ImplicitAllowedTypes;
+			[NodeKind.Record]: ImplicitAllowedTypes;
+			[NodeKind.Leaf]: unknown;
+		}[T["kind"]]
+	>;
 
 /**
  * Workaround for "Type instantiation is excessively deep and possibly infinite.ts" errors.
@@ -236,7 +237,7 @@ export type ValidateRecursiveSchemaTemplate<T extends TreeNodeSchema> = TreeNode
  * This uses ValidateRecursiveSchemaTemplate since it was found to evaluate enough of the type to work.
  * @internal
  */
-export type FixRecursiveRecursionLimit<T extends TreeNodeSchema> =
+export type FixRecursiveRecursionLimit<T extends TreeNodeSchemaClass> =
 	T extends ValidateRecursiveSchemaTemplate<T> ? undefined : undefined;
 
 /**

package/src/simple-tree/core/index.ts

@@ -14,6 +14,7 @@ export {
 	treeNodeFromAnchor,
 	getSimpleNodeSchemaFromInnerNode,
 	SimpleContextSlot,
+	withBufferedTreeEvents,
 } from "./treeNodeKernel.js";
 export { type WithType, typeNameSymbol, typeSchemaSymbol } from "./withType.js";
 export {