fluid-framework 2.3.1 → 2.4.0-297027

package/api-report/fluid-framework.public.api.md

@@ -89,21 +89,29 @@ export enum FieldKind {
 }
 
 // @public
-export interface FieldProps {
+export interface FieldProps<TCustomMetadata = unknown> {
     readonly defaultProvider?: DefaultProvider;
     readonly key?: string;
+    readonly metadata?: FieldSchemaMetadata<TCustomMetadata>;
 }
 
 // @public @sealed
-export class FieldSchema<out Kind extends FieldKind = FieldKind, out Types extends ImplicitAllowedTypes = ImplicitAllowedTypes> {
+export class FieldSchema<out Kind extends FieldKind = FieldKind, out Types extends ImplicitAllowedTypes = ImplicitAllowedTypes, out TCustomMetadata = unknown> {
     readonly allowedTypes: Types;
     get allowedTypeSet(): ReadonlySet<TreeNodeSchema>;
     readonly kind: Kind;
-    readonly props?: FieldProps | undefined;
+    get metadata(): FieldSchemaMetadata<TCustomMetadata> | undefined;
+    readonly props?: FieldProps<TCustomMetadata> | undefined;
     readonly requiresValue: boolean;
     protected _typeCheck: MakeNominal;
 }
 
+// @public @sealed
+export interface FieldSchemaMetadata<TCustomMetadata = unknown> {
+    readonly custom?: TCustomMetadata;
+    readonly description?: string | undefined;
+}
+
 // @public
 export interface FieldSchemaUnsafe<out Kind extends FieldKind, out Types extends Unenforced<ImplicitAllowedTypes>> extends FieldSchema<Kind, any> {
     readonly allowedTypes: Types;
@@ -398,14 +406,14 @@ export type InitialObjects<T extends ContainerSchema> = {
 type _InlineTrick = 0;
 
 // @public
-type InsertableObjectFromSchemaRecord<T extends RestrictiveReadonlyRecord<string, ImplicitFieldSchema>> = FlattenKeys<{
-    readonly [Property in keyof T]?: InsertableTreeFieldFromImplicitField<T[Property]>;
+type InsertableObjectFromSchemaRecord<T extends RestrictiveStringRecord<ImplicitFieldSchema>> = FlattenKeys<{
+    readonly [Property in keyof T]?: InsertableTreeFieldFromImplicitField<T[Property] & string>;
 } & {
-    readonly [Property in keyof T as FieldHasDefault<T[Property]> extends false ? Property : never]: InsertableTreeFieldFromImplicitField<T[Property]>;
+    readonly [Property in keyof T as FieldHasDefault<T[Property] & string> extends false ? Property : never]: InsertableTreeFieldFromImplicitField<T[Property] & string>;
 }>;
 
 // @public
-export type InsertableObjectFromSchemaRecordUnsafe<T extends Unenforced<RestrictiveReadonlyRecord<string, ImplicitFieldSchema>>> = {
+export type InsertableObjectFromSchemaRecordUnsafe<T extends Unenforced<RestrictiveStringRecord<ImplicitFieldSchema>>> = {
     readonly [Property in keyof T as FieldHasDefaultUnsafe<T[Property]> extends false ? Property : never]: InsertableTreeFieldFromImplicitFieldUnsafe<T[Property]>;
 } & {
     readonly [Property in keyof T as FieldHasDefaultUnsafe<T[Property]> extends true ? Property : never]?: InsertableTreeFieldFromImplicitFieldUnsafe<T[Property]>;
@@ -446,7 +454,6 @@ declare namespace InternalTypes {
         ApplyKind,
         NodeBuilderData,
         FieldHasDefault,
-        TreeNodeSchemaNonClass,
         TreeArrayNodeBase,
         ScopedSchemaName,
         DefaultProvider,
@@ -514,8 +521,7 @@ export class IterableTreeArrayContent<T> implements Iterable<T> {
 }
 
 // @public @sealed
-export interface ITree extends IFluidLoadable {
-    viewWith<TRoot extends ImplicitFieldSchema>(config: TreeViewConfiguration<TRoot>): TreeView<TRoot>;
+export interface ITree extends ViewableTree, IFluidLoadable {
 }
 
 // @public
@@ -547,7 +553,7 @@ export interface MakeNominal {
 }
 
 // @public
-export type MapNodeInsertableData<T extends ImplicitAllowedTypes> = Iterable<readonly [string, InsertableTreeNodeFromImplicitAllowedTypes<T>]> | RestrictiveReadonlyRecord<string, InsertableTreeNodeFromImplicitAllowedTypes<T>>;
+export type MapNodeInsertableData<T extends ImplicitAllowedTypes> = Iterable<readonly [string, InsertableTreeNodeFromImplicitAllowedTypes<T>]> | RestrictiveStringRecord<InsertableTreeNodeFromImplicitAllowedTypes<T>>;
 
 // @public
 export type MemberChangedListener<M extends IMember> = (clientId: string, member: M) => void;
@@ -586,12 +592,12 @@ export enum NodeKind {
 }
 
 // @public
-type ObjectFromSchemaRecord<T extends RestrictiveReadonlyRecord<string, ImplicitFieldSchema>> = {
-    -readonly [Property in keyof T]: TreeFieldFromImplicitField<T[Property]>;
+type ObjectFromSchemaRecord<T extends RestrictiveStringRecord<ImplicitFieldSchema>> = {
+    -readonly [Property in keyof T]: Property extends string ? TreeFieldFromImplicitField<T[Property]> : unknown;
 };
 
 // @public
-type ObjectFromSchemaRecordUnsafe<T extends Unenforced<RestrictiveReadonlyRecord<string, ImplicitFieldSchema>>> = {
+type ObjectFromSchemaRecordUnsafe<T extends Unenforced<RestrictiveStringRecord<ImplicitFieldSchema>>> = {
     -readonly [Property in keyof T]: TreeFieldFromImplicitFieldUnsafe<T[Property]>;
 };
 
@@ -619,11 +625,18 @@ export type ReplaceIEventThisPlaceHolder<L extends any[], TThis> = L extends any
     [K in keyof L]: L[K] extends IEventThisPlaceHolder ? TThis : L[K];
 } : L;
 
-// @public
+// @public @deprecated
 export type RestrictiveReadonlyRecord<K extends symbol | string, T> = {
     readonly [P in symbol | string]: P extends K ? T : never;
 };
 
+// @public
+export type RestrictiveStringRecord<T> = {
+    readonly [P in string]: T;
+} & {
+    readonly [P in symbol]?: never;
+};
+
 // @public @sealed
 export interface Revertible {
     dispose(): void;
@@ -672,7 +685,7 @@ export interface SchemaCompatibilityStatus {
 // @public @sealed
 export class SchemaFactory<out TScope extends string | undefined = string | undefined, TName extends number | string = string> {
     constructor(scope: TScope);
-    array<const T extends TreeNodeSchema | readonly TreeNodeSchema[]>(allowedTypes: T): TreeNodeSchema<ScopedSchemaName<TScope, `Array<${string}>`>, NodeKind.Array, TreeArrayNode<T> & WithType<ScopedSchemaName<TScope, `Array<${string}>`>, NodeKind.Array>, Iterable<InsertableTreeNodeFromImplicitAllowedTypes<T>>, true, T>;
+    array<const T extends TreeNodeSchema | readonly TreeNodeSchema[]>(allowedTypes: T): TreeNodeSchemaNonClass<ScopedSchemaName<TScope, `Array<${string}>`>, NodeKind.Array, TreeArrayNode<T> & WithType<ScopedSchemaName<TScope, `Array<${string}>`>, NodeKind.Array>, Iterable<InsertableTreeNodeFromImplicitAllowedTypes<T>>, true, T>;
     array<const Name extends TName, const T extends ImplicitAllowedTypes>(name: Name, allowedTypes: T): TreeNodeSchemaClass<ScopedSchemaName<TScope, Name>, NodeKind.Array, TreeArrayNode<T> & WithType<ScopedSchemaName<TScope, Name>, NodeKind.Array>, Iterable<InsertableTreeNodeFromImplicitAllowedTypes<T>>, true, T>;
     arrayRecursive<const Name extends TName, const T extends Unenforced<ImplicitAllowedTypes>>(name: Name, allowedTypes: T): TreeNodeSchemaClass<ScopedSchemaName<TScope, Name>, NodeKind.Array, TreeArrayNodeUnsafe<T> & WithType<ScopedSchemaName<TScope, Name>, NodeKind.Array, unknown>, {
         [Symbol.iterator](): Iterator<InsertableTreeNodeFromImplicitAllowedTypesUnsafe<T>>;
@@ -680,7 +693,7 @@ export class SchemaFactory<out TScope extends string | undefined = string | unde
     readonly boolean: TreeNodeSchema<"com.fluidframework.leaf.boolean", NodeKind.Leaf, boolean, boolean>;
     readonly handle: TreeNodeSchema<"com.fluidframework.leaf.handle", NodeKind.Leaf, IFluidHandle<unknown>, IFluidHandle<unknown>>;
     get identifier(): FieldSchema<FieldKind.Identifier, typeof SchemaFactory.string>;
-    map<const T extends TreeNodeSchema | readonly TreeNodeSchema[]>(allowedTypes: T): TreeNodeSchema<ScopedSchemaName<TScope, `Map<${string}>`>, NodeKind.Map, TreeMapNode<T> & WithType<ScopedSchemaName<TScope, `Map<${string}>`>, NodeKind.Map>, MapNodeInsertableData<T>, true, T>;
+    map<const T extends TreeNodeSchema | readonly TreeNodeSchema[]>(allowedTypes: T): TreeNodeSchemaNonClass<ScopedSchemaName<TScope, `Map<${string}>`>, NodeKind.Map, TreeMapNode<T> & WithType<ScopedSchemaName<TScope, `Map<${string}>`>, NodeKind.Map>, MapNodeInsertableData<T>, true, T>;
     map<Name extends TName, const T extends ImplicitAllowedTypes>(name: Name, allowedTypes: T): TreeNodeSchemaClass<ScopedSchemaName<TScope, Name>, NodeKind.Map, TreeMapNode<T> & WithType<ScopedSchemaName<TScope, Name>, NodeKind.Map>, MapNodeInsertableData<T>, true, T>;
     mapRecursive<Name extends TName, const T extends Unenforced<ImplicitAllowedTypes>>(name: Name, allowedTypes: T): TreeNodeSchemaClass<ScopedSchemaName<TScope, Name>, NodeKind.Map, TreeMapNodeUnsafe<T> & WithType<ScopedSchemaName<TScope, Name>, NodeKind.Map, unknown>, {
         [Symbol.iterator](): Iterator<[
@@ -690,11 +703,11 @@ export class SchemaFactory<out TScope extends string | undefined = string | unde
     }, false, T>;
     readonly null: TreeNodeSchema<"com.fluidframework.leaf.null", NodeKind.Leaf, null, null>;
     readonly number: TreeNodeSchema<"com.fluidframework.leaf.number", NodeKind.Leaf, number, number>;
-    object<const Name extends TName, const T extends RestrictiveReadonlyRecord<string, ImplicitFieldSchema>>(name: Name, fields: T): TreeNodeSchemaClass<ScopedSchemaName<TScope, Name>, NodeKind.Object, TreeObjectNode<T, ScopedSchemaName<TScope, Name>>, object & InsertableObjectFromSchemaRecord<T>, true, T>;
-    objectRecursive<const Name extends TName, const T extends Unenforced<RestrictiveReadonlyRecord<string, ImplicitFieldSchema>>>(name: Name, t: T): TreeNodeSchemaClass<ScopedSchemaName<TScope, Name>, NodeKind.Object, TreeObjectNodeUnsafe<T, ScopedSchemaName<TScope, Name>>, object & { readonly [Property in keyof T as FieldHasDefaultUnsafe<T[Property]> extends false ? Property : never]: InsertableTreeFieldFromImplicitFieldUnsafe<T[Property]>; } & { readonly [Property_1 in keyof T as FieldHasDefaultUnsafe<T[Property_1]> extends true ? Property_1 : never]?: InsertableTreeFieldFromImplicitFieldUnsafe<T[Property_1]> | undefined; }, false, T>;
-    optional<const T extends ImplicitAllowedTypes>(t: T, props?: Omit<FieldProps, "defaultProvider">): FieldSchema<FieldKind.Optional, T>;
+    object<const Name extends TName, const T extends RestrictiveStringRecord<ImplicitFieldSchema>>(name: Name, fields: T): TreeNodeSchemaClass<ScopedSchemaName<TScope, Name>, NodeKind.Object, TreeObjectNode<T, ScopedSchemaName<TScope, Name>>, object & InsertableObjectFromSchemaRecord<T>, true, T>;
+    objectRecursive<const Name extends TName, const T extends Unenforced<RestrictiveStringRecord<ImplicitFieldSchema>>>(name: Name, t: T): TreeNodeSchemaClass<ScopedSchemaName<TScope, Name>, NodeKind.Object, TreeObjectNodeUnsafe<T, ScopedSchemaName<TScope, Name>>, object & { readonly [Property in keyof T as FieldHasDefaultUnsafe<T[Property]> extends false ? Property : never]: InsertableTreeFieldFromImplicitFieldUnsafe<T[Property]>; } & { readonly [Property_1 in keyof T as FieldHasDefaultUnsafe<T[Property_1]> extends true ? Property_1 : never]?: InsertableTreeFieldFromImplicitFieldUnsafe<T[Property_1]> | undefined; }, false, T>;
+    optional<const T extends ImplicitAllowedTypes, const TCustomMetadata = unknown>(t: T, props?: Omit<FieldProps<TCustomMetadata>, "defaultProvider">): FieldSchema<FieldKind.Optional, T, TCustomMetadata>;
     optionalRecursive<const T extends Unenforced<ImplicitAllowedTypes>>(t: T, props?: Omit<FieldProps, "defaultProvider">): FieldSchemaUnsafe<FieldKind.Optional, T>;
-    required<const T extends ImplicitAllowedTypes>(t: T, props?: Omit<FieldProps, "defaultProvider">): FieldSchema<FieldKind.Required, T>;
+    required<const T extends ImplicitAllowedTypes, const TCustomMetadata = unknown>(t: T, props?: Omit<FieldProps<TCustomMetadata>, "defaultProvider">): FieldSchema<FieldKind.Required, T, TCustomMetadata>;
     requiredRecursive<const T extends Unenforced<ImplicitAllowedTypes>>(t: T, props?: Omit<FieldProps, "defaultProvider">): FieldSchemaUnsafe<FieldKind.Required, T>;
     // (undocumented)
     readonly scope: TScope;
@@ -754,14 +767,14 @@ interface TreeArrayNodeBase<out T, in TNew, in TMoveFrom> extends ReadonlyArray<
     insertAtStart(...value: readonly (TNew | IterableTreeArrayContent<TNew>)[]): void;
     moveRangeToEnd(sourceStart: number, sourceEnd: number): void;
     moveRangeToEnd(sourceStart: number, sourceEnd: number, source: TMoveFrom): void;
-    moveRangeToIndex(index: number, sourceStart: number, sourceEnd: number): void;
-    moveRangeToIndex(index: number, sourceStart: number, sourceEnd: number, source: TMoveFrom): void;
+    moveRangeToIndex(destinationGap: number, sourceStart: number, sourceEnd: number): void;
+    moveRangeToIndex(destinationGap: number, sourceStart: number, sourceEnd: number, source: TMoveFrom): void;
     moveRangeToStart(sourceStart: number, sourceEnd: number): void;
     moveRangeToStart(sourceStart: number, sourceEnd: number, source: TMoveFrom): void;
     moveToEnd(sourceIndex: number): void;
     moveToEnd(sourceIndex: number, source: TMoveFrom): void;
-    moveToIndex(index: number, sourceIndex: number): void;
-    moveToIndex(index: number, sourceIndex: number, source: TMoveFrom): void;
+    moveToIndex(destinationGap: number, sourceIndex: number): void;
+    moveToIndex(destinationGap: number, sourceIndex: number, source: TMoveFrom): void;
     moveToStart(sourceIndex: number): void;
     moveToStart(sourceIndex: number, source: TMoveFrom): void;
     removeAt(index: number): void;
@@ -842,6 +855,7 @@ export interface TreeNodeSchemaClass<out Name extends string = string, out Kind
 
 // @public @sealed
 export interface TreeNodeSchemaCore<out Name extends string, out Kind extends NodeKind, out ImplicitlyConstructable extends boolean, out Info = unknown> {
+    readonly childTypes: ReadonlySet<TreeNodeSchema>;
     readonly identifier: Name;
     readonly implicitlyConstructable: ImplicitlyConstructable;
     readonly info: Info;
@@ -850,16 +864,16 @@ export interface TreeNodeSchemaCore<out Name extends string, out Kind extends No
 }
 
 // @public @sealed
-interface TreeNodeSchemaNonClass<out Name extends string = string, out Kind extends NodeKind = NodeKind, out TNode = unknown, in TInsertable = never, out ImplicitlyConstructable extends boolean = boolean, out Info = unknown> extends TreeNodeSchemaCore<Name, Kind, ImplicitlyConstructable, Info> {
+export interface TreeNodeSchemaNonClass<out Name extends string = string, out Kind extends NodeKind = NodeKind, out TNode = unknown, in TInsertable = never, out ImplicitlyConstructable extends boolean = boolean, out Info = unknown> extends TreeNodeSchemaCore<Name, Kind, ImplicitlyConstructable, Info> {
     // (undocumented)
     create(data: TInsertable): TNode;
 }
 
 // @public
-export type TreeObjectNode<T extends RestrictiveReadonlyRecord<string, ImplicitFieldSchema>, TypeName extends string = string> = TreeNode & ObjectFromSchemaRecord<T> & WithType<TypeName, NodeKind.Object, T>;
+export type TreeObjectNode<T extends RestrictiveStringRecord<ImplicitFieldSchema>, TypeName extends string = string> = TreeNode & ObjectFromSchemaRecord<T> & WithType<TypeName, NodeKind.Object, T>;
 
 // @public
-export type TreeObjectNodeUnsafe<T extends Unenforced<RestrictiveReadonlyRecord<string, ImplicitFieldSchema>>, TypeName extends string = string> = TreeNode & ObjectFromSchemaRecordUnsafe<T> & WithType<TypeName, NodeKind.Object>;
+export type TreeObjectNodeUnsafe<T extends Unenforced<RestrictiveStringRecord<ImplicitFieldSchema>>, TypeName extends string = string> = TreeNode & ObjectFromSchemaRecordUnsafe<T> & WithType<TypeName, NodeKind.Object>;
 
 // @public
 export enum TreeStatus {
@@ -876,6 +890,7 @@ export interface TreeView<TSchema extends ImplicitFieldSchema> extends IDisposab
     initialize(content: InsertableTreeFieldFromImplicitField<TSchema>): void;
     get root(): TreeFieldFromImplicitField<TSchema>;
     set root(newRoot: InsertableTreeFieldFromImplicitField<TSchema>);
+    readonly schema: TSchema;
     upgradeSchema(): void;
 }
 
@@ -910,15 +925,20 @@ export type Unhydrated<T> = T;
 
 // @public
 export type ValidateRecursiveSchema<T extends TreeNodeSchemaClass<string, NodeKind.Array | NodeKind.Map | NodeKind.Object, TreeNode & WithType<T["identifier"], T["kind"]>, {
-    [NodeKind.Object]: T["info"] extends RestrictiveReadonlyRecord<string, ImplicitFieldSchema> ? InsertableObjectFromSchemaRecord<T["info"]> : unknown;
+    [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;
 }[T["kind"]], false, {
-    [NodeKind.Object]: RestrictiveReadonlyRecord<string, ImplicitFieldSchema>;
+    [NodeKind.Object]: RestrictiveStringRecord<ImplicitFieldSchema>;
     [NodeKind.Array]: ImplicitAllowedTypes;
     [NodeKind.Map]: ImplicitAllowedTypes;
 }[T["kind"]]>> = true;
 
+// @public @sealed
+export interface ViewableTree {
+    viewWith<TRoot extends ImplicitFieldSchema>(config: TreeViewConfiguration<TRoot>): TreeView<TRoot>;
+}
+
 // @public @sealed
 export interface WithType<out TName extends string = string, out TKind extends NodeKind = NodeKind, out TInfo = unknown> {
     // @deprecated

package/dist/alpha.d.ts

@@ -32,6 +32,7 @@ export {
 	FieldKind, 
 	FieldProps, 
 	FieldSchema, 
+	FieldSchemaMetadata, 
 	FieldSchemaUnsafe, 
 	FluidObject, 
 	FluidObjectProviderKeys, 
@@ -82,6 +83,7 @@ export {
 	Off, 
 	ReplaceIEventThisPlaceHolder, 
 	RestrictiveReadonlyRecord, 
+	RestrictiveStringRecord, 
 	Revertible, 
 	RevertibleFactory, 
 	RevertibleStatus, 
@@ -108,6 +110,7 @@ export {
 	TreeNodeSchema, 
 	TreeNodeSchemaClass, 
 	TreeNodeSchemaCore, 
+	TreeNodeSchemaNonClass, 
 	TreeObjectNode, 
 	TreeObjectNodeUnsafe, 
 	TreeStatus, 
@@ -117,6 +120,7 @@ export {
 	Unenforced, 
 	Unhydrated, 
 	ValidateRecursiveSchema, 
+	ViewableTree, 
 	WithType, 
 	isFluidHandle, 
 	rollback, 
@@ -142,5 +146,8 @@ export {
 	JsonSchemaRef, 
 	JsonSchemaType, 
 	JsonTreeSchema, 
+	TreeBranch, 
+	TreeBranchFork, 
+	getBranch, 
 	getJsonSchema
 } from "./index.js";

package/dist/beta.d.ts

@@ -32,6 +32,7 @@ export {
 	FieldKind, 
 	FieldProps, 
 	FieldSchema, 
+	FieldSchemaMetadata, 
 	FieldSchemaUnsafe, 
 	FluidObject, 
 	FluidObjectProviderKeys, 
@@ -82,6 +83,7 @@ export {
 	Off, 
 	ReplaceIEventThisPlaceHolder, 
 	RestrictiveReadonlyRecord, 
+	RestrictiveStringRecord, 
 	Revertible, 
 	RevertibleFactory, 
 	RevertibleStatus, 
@@ -108,6 +110,7 @@ export {
 	TreeNodeSchema, 
 	TreeNodeSchemaClass, 
 	TreeNodeSchemaCore, 
+	TreeNodeSchemaNonClass, 
 	TreeObjectNode, 
 	TreeObjectNodeUnsafe, 
 	TreeStatus, 
@@ -117,6 +120,7 @@ export {
 	Unenforced, 
 	Unhydrated, 
 	ValidateRecursiveSchema, 
+	ViewableTree, 
 	WithType, 
 	isFluidHandle, 
 	rollback, 

package/dist/legacy.d.ts

@@ -32,6 +32,7 @@ export {
 	FieldKind, 
 	FieldProps, 
 	FieldSchema, 
+	FieldSchemaMetadata, 
 	FieldSchemaUnsafe, 
 	FluidObject, 
 	FluidObjectProviderKeys, 
@@ -82,6 +83,7 @@ export {
 	Off, 
 	ReplaceIEventThisPlaceHolder, 
 	RestrictiveReadonlyRecord, 
+	RestrictiveStringRecord, 
 	Revertible, 
 	RevertibleFactory, 
 	RevertibleStatus, 
@@ -108,6 +110,7 @@ export {
 	TreeNodeSchema, 
 	TreeNodeSchemaClass, 
 	TreeNodeSchemaCore, 
+	TreeNodeSchemaNonClass, 
 	TreeObjectNode, 
 	TreeObjectNodeUnsafe, 
 	TreeStatus, 
@@ -117,6 +120,7 @@ export {
 	Unenforced, 
 	Unhydrated, 
 	ValidateRecursiveSchema, 
+	ViewableTree, 
 	WithType, 
 	isFluidHandle, 
 	rollback, 

package/dist/public.d.ts

@@ -32,6 +32,7 @@ export {
 	FieldKind, 
 	FieldProps, 
 	FieldSchema, 
+	FieldSchemaMetadata, 
 	FieldSchemaUnsafe, 
 	FluidObject, 
 	FluidObjectProviderKeys, 
@@ -82,6 +83,7 @@ export {
 	Off, 
 	ReplaceIEventThisPlaceHolder, 
 	RestrictiveReadonlyRecord, 
+	RestrictiveStringRecord, 
 	Revertible, 
 	RevertibleFactory, 
 	RevertibleStatus, 
@@ -108,6 +110,7 @@ export {
 	TreeNodeSchema, 
 	TreeNodeSchemaClass, 
 	TreeNodeSchemaCore, 
+	TreeNodeSchemaNonClass, 
 	TreeObjectNode, 
 	TreeObjectNodeUnsafe, 
 	TreeStatus, 
@@ -117,6 +120,7 @@ export {
 	Unenforced, 
 	Unhydrated, 
 	ValidateRecursiveSchema, 
+	ViewableTree, 
 	WithType, 
 	isFluidHandle, 
 	rollback, 

package/lib/alpha.d.ts

@@ -32,6 +32,7 @@ export {
 	FieldKind, 
 	FieldProps, 
 	FieldSchema, 
+	FieldSchemaMetadata, 
 	FieldSchemaUnsafe, 
 	FluidObject, 
 	FluidObjectProviderKeys, 
@@ -82,6 +83,7 @@ export {
 	Off, 
 	ReplaceIEventThisPlaceHolder, 
 	RestrictiveReadonlyRecord, 
+	RestrictiveStringRecord, 
 	Revertible, 
 	RevertibleFactory, 
 	RevertibleStatus, 
@@ -108,6 +110,7 @@ export {
 	TreeNodeSchema, 
 	TreeNodeSchemaClass, 
 	TreeNodeSchemaCore, 
+	TreeNodeSchemaNonClass, 
 	TreeObjectNode, 
 	TreeObjectNodeUnsafe, 
 	TreeStatus, 
@@ -117,6 +120,7 @@ export {
 	Unenforced, 
 	Unhydrated, 
 	ValidateRecursiveSchema, 
+	ViewableTree, 
 	WithType, 
 	isFluidHandle, 
 	rollback, 
@@ -142,5 +146,8 @@ export {
 	JsonSchemaRef, 
 	JsonSchemaType, 
 	JsonTreeSchema, 
+	TreeBranch, 
+	TreeBranchFork, 
+	getBranch, 
 	getJsonSchema
 } from "./index.js";

package/lib/beta.d.ts

@@ -32,6 +32,7 @@ export {
 	FieldKind, 
 	FieldProps, 
 	FieldSchema, 
+	FieldSchemaMetadata, 
 	FieldSchemaUnsafe, 
 	FluidObject, 
 	FluidObjectProviderKeys, 
@@ -82,6 +83,7 @@ export {
 	Off, 
 	ReplaceIEventThisPlaceHolder, 
 	RestrictiveReadonlyRecord, 
+	RestrictiveStringRecord, 
 	Revertible, 
 	RevertibleFactory, 
 	RevertibleStatus, 
@@ -108,6 +110,7 @@ export {
 	TreeNodeSchema, 
 	TreeNodeSchemaClass, 
 	TreeNodeSchemaCore, 
+	TreeNodeSchemaNonClass, 
 	TreeObjectNode, 
 	TreeObjectNodeUnsafe, 
 	TreeStatus, 
@@ -117,6 +120,7 @@ export {
 	Unenforced, 
 	Unhydrated, 
 	ValidateRecursiveSchema, 
+	ViewableTree, 
 	WithType, 
 	isFluidHandle, 
 	rollback, 

package/lib/legacy.d.ts

@@ -32,6 +32,7 @@ export {
 	FieldKind, 
 	FieldProps, 
 	FieldSchema, 
+	FieldSchemaMetadata, 
 	FieldSchemaUnsafe, 
 	FluidObject, 
 	FluidObjectProviderKeys, 
@@ -82,6 +83,7 @@ export {
 	Off, 
 	ReplaceIEventThisPlaceHolder, 
 	RestrictiveReadonlyRecord, 
+	RestrictiveStringRecord, 
 	Revertible, 
 	RevertibleFactory, 
 	RevertibleStatus, 
@@ -108,6 +110,7 @@ export {
 	TreeNodeSchema, 
 	TreeNodeSchemaClass, 
 	TreeNodeSchemaCore, 
+	TreeNodeSchemaNonClass, 
 	TreeObjectNode, 
 	TreeObjectNodeUnsafe, 
 	TreeStatus, 
@@ -117,6 +120,7 @@ export {
 	Unenforced, 
 	Unhydrated, 
 	ValidateRecursiveSchema, 
+	ViewableTree, 
 	WithType, 
 	isFluidHandle, 
 	rollback, 

package/lib/public.d.ts

@@ -32,6 +32,7 @@ export {
 	FieldKind, 
 	FieldProps, 
 	FieldSchema, 
+	FieldSchemaMetadata, 
 	FieldSchemaUnsafe, 
 	FluidObject, 
 	FluidObjectProviderKeys, 
@@ -82,6 +83,7 @@ export {
 	Off, 
 	ReplaceIEventThisPlaceHolder, 
 	RestrictiveReadonlyRecord, 
+	RestrictiveStringRecord, 
 	Revertible, 
 	RevertibleFactory, 
 	RevertibleStatus, 
@@ -108,6 +110,7 @@ export {
 	TreeNodeSchema, 
 	TreeNodeSchemaClass, 
 	TreeNodeSchemaCore, 
+	TreeNodeSchemaNonClass, 
 	TreeObjectNode, 
 	TreeObjectNodeUnsafe, 
 	TreeStatus, 
@@ -117,6 +120,7 @@ export {
 	Unenforced, 
 	Unhydrated, 
 	ValidateRecursiveSchema, 
+	ViewableTree, 
 	WithType, 
 	isFluidHandle, 
 	rollback, 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fluid-framework",
-  "version": "2.3.1",
+  "version": "2.4.0-297027",
   "description": "The main entry point into Fluid Framework public packages",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -57,16 +57,16 @@
   "main": "lib/index.js",
   "types": "lib/public.d.ts",
   "dependencies": {
-    "@fluidframework/container-definitions": "~2.3.1",
-    "@fluidframework/container-loader": "~2.3.1",
-    "@fluidframework/core-interfaces": "~2.3.1",
-    "@fluidframework/driver-definitions": "~2.3.1",
-    "@fluidframework/fluid-static": "~2.3.1",
-    "@fluidframework/map": "~2.3.1",
-    "@fluidframework/runtime-utils": "~2.3.1",
-    "@fluidframework/sequence": "~2.3.1",
-    "@fluidframework/shared-object-base": "~2.3.1",
-    "@fluidframework/tree": "~2.3.1"
+    "@fluidframework/container-definitions": "2.4.0-297027",
+    "@fluidframework/container-loader": "2.4.0-297027",
+    "@fluidframework/core-interfaces": "2.4.0-297027",
+    "@fluidframework/driver-definitions": "2.4.0-297027",
+    "@fluidframework/fluid-static": "2.4.0-297027",
+    "@fluidframework/map": "2.4.0-297027",
+    "@fluidframework/runtime-utils": "2.4.0-297027",
+    "@fluidframework/sequence": "2.4.0-297027",
+    "@fluidframework/shared-object-base": "2.4.0-297027",
+    "@fluidframework/tree": "2.4.0-297027"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",