@fluid-experimental/tree 2.0.0-internal.8.0.1 → 2.0.0-rc.1.0.0

package/src/migration-shim/migrationShimFactory.ts

@@ -10,7 +10,7 @@ import {
 	type IChannelServices,
 	type IChannelFactory,
 } from '@fluidframework/datastore-definitions';
-import { type TreeFactory, type ITree } from '@fluid-experimental/tree2';
+import { type ITree } from '@fluidframework/tree';
 import { type SharedTreeFactory as LegacySharedTreeFactory, type SharedTree as LegacySharedTree } from '../SharedTree';
 import { MigrationShim } from './migrationShim.js';
 import { attributesMatch } from './utils.js';
@@ -30,7 +30,7 @@ import { attributesMatch } from './utils.js';
 export class MigrationShimFactory implements IChannelFactory {
 	public constructor(
 		private readonly oldFactory: LegacySharedTreeFactory,
-		private readonly newFactory: TreeFactory,
+		private readonly newFactory: IChannelFactory,
 		private readonly populateNewChannelFn: (oldChannel: LegacySharedTree, newChannel: ITree) => void
 	) {}
 

package/src/migration-shim/sharedTreeShim.ts

@@ -4,6 +4,7 @@
  */
 import { type IFluidHandle, type IFluidLoadable } from '@fluidframework/core-interfaces';
 import {
+	type IChannelFactory,
 	type IChannelAttributes,
 	type IChannelServices,
 	type IFluidDataStoreRuntime,
@@ -14,7 +15,7 @@ import {
 	type ITelemetryContext,
 	type ISummaryTreeWithStats,
 } from '@fluidframework/runtime-definitions';
-import { type ITree, type TreeFactory } from '@fluid-experimental/tree2';
+import { type ITree } from '@fluidframework/tree';
 import { AttachState } from '@fluidframework/container-definitions';
 import { assert } from '@fluidframework/core-utils';
 import { type IShimChannelServices, NoDeltasChannelServices } from './shimChannelServices.js';
@@ -38,7 +39,7 @@ export class SharedTreeShim implements IShim {
 	public constructor(
 		public readonly id: string,
 		public readonly runtime: IFluidDataStoreRuntime,
-		public readonly sharedTreeFactory: TreeFactory
+		public readonly sharedTreeFactory: IChannelFactory
 	) {
 		this.newTreeShimDeltaHandler = new SharedTreeShimDeltaHandler(sharedTreeFactory.attributes);
 		this.handle = new ShimHandle<SharedTreeShim>(this);
@@ -91,16 +92,16 @@ export class SharedTreeShim implements IShim {
 			this.runtime.attachState === AttachState.Detached
 				? new NoDeltasChannelServices(services)
 				: this.generateShimServicesOnce(services);
-		this._currentTree = await this.sharedTreeFactory.load(
+		this._currentTree = (await this.sharedTreeFactory.load(
 			this.runtime,
 			this.id,
 			shimServices,
 			this.sharedTreeFactory.attributes
-		);
+		)) as ITree;
 	}
 
 	public create(): void {
-		this._currentTree = this.sharedTreeFactory.create(this.runtime, this.id);
+		this._currentTree = this.sharedTreeFactory.create(this.runtime, this.id) as ITree;
 	}
 
 	private generateShimServicesOnce(services: IChannelServices): IShimChannelServices {

package/src/migration-shim/sharedTreeShimFactory.ts

@@ -11,7 +11,6 @@ import {
 	type IChannelFactory,
 } from '@fluidframework/datastore-definitions';
 
-import { type TreeFactory } from '@fluid-experimental/tree2';
 import { SharedTreeShim } from './sharedTreeShim.js';
 import { attributesMatch } from './utils.js';
 
@@ -29,7 +28,7 @@ import { attributesMatch } from './utils.js';
  * @internal
  */
 export class SharedTreeShimFactory implements IChannelFactory {
-	public constructor(private readonly factory: TreeFactory) {}
+	public constructor(private readonly factory: IChannelFactory) {}
 
 	/**
 	 * Can only load the new SharedTree - this allows our snapshots to be simple. We do not have to consider any new

package/src/migration-shim/shimDeltaConnection.ts

@@ -61,7 +61,14 @@ export class PreMigrationDeltaConnection implements IDeltaConnection {
 		this.deltaConnection.dirty();
 	}
 
-	// This needs to be more thoroughly thought through. What happens when the source handle is changed?
+	/**
+	 * Passes through to the underlying delta connection.
+	 *
+	 * @deprecated There is no replacement for this, its functionality is no longer needed at this layer.
+	 * It will be removed in a future release, sometime after 2.0.0-internal.8.0.0
+	 *
+	 * @privateRemarks This needs to be more thoroughly thought through. What happens when the source handle is changed?
+	 */
 	public addedGCOutboundReference?(srcHandle: IFluidHandle, outboundHandle: IFluidHandle): void {
 		this.deltaConnection.addedGCOutboundReference?.(srcHandle, outboundHandle);
 	}
@@ -112,7 +119,14 @@ export class StampDeltaConnection implements IDeltaConnection {
 		this.deltaConnection.dirty();
 	}
 
-	// This needs to be more thoroughly thought through. What happens when the source handle is changed?
+	/**
+	 * Passes through to the underlying delta connection.
+	 *
+	 * @deprecated There is no replacement for this, its functionality is no longer needed at this layer.
+	 * It will be removed in a future release, sometime after 2.0.0-internal.8.0.0
+	 *
+	 * @privateRemarks This needs to be more thoroughly thought through. What happens when the source handle is changed?
+	 */
 	public addedGCOutboundReference?(srcHandle: IFluidHandle, outboundHandle: IFluidHandle): void {
 		this.deltaConnection.addedGCOutboundReference?.(srcHandle, outboundHandle);
 	}

package/src/migration-shim/types.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { type ITree } from '@fluid-experimental/tree2';
+import { type ITree } from '@fluidframework/tree';
 import {
 	type IChannel,
 	type IChannelAttributes,

package/src/persisted-types/0.0.2.ts

@@ -30,7 +30,7 @@ import type {
  * Each place can be specified, (aka 'anchored') in two ways (relative to the sibling before or after):
  * the choice of which way to anchor a place only matters when the kept across an edit, and thus evaluated in multiple contexts where the
  * two place description may no longer evaluate to the same place.
- * @internal
+ * @alpha
  */
 export enum Side {
 	Before = 0,
@@ -40,7 +40,7 @@ export enum Side {
 /**
  * A collection of changes to the tree that are applied atomically along with a unique identifier for the edit.
  * If any individual change fails to apply, the entire Edit will fail to apply.
- * @internal
+ * @alpha
  */
 export interface Edit<TChange> extends EditBase<TChange> {
 	/**
@@ -64,7 +64,7 @@ export interface EditWithoutId<TChange> extends EditBase<TChange> {
 
 /**
  * The information included in an edit.
- * @internal
+ * @alpha
  */
 export interface EditBase<TChange> {
 	/**
@@ -91,7 +91,7 @@ export interface EditBase<TChange> {
  * See {@link comparePayloads} for equality semantics and related details (like what is allowed to be lost when serializing)
  *
  * TODO:#51984: Allow opting into heuristic blobbing in snapshots with a special IFluid key.
- * @internal
+ * @alpha
  */
 export type Payload = any;
 
@@ -99,7 +99,7 @@ export type Payload = any;
  * Json compatible map as object.
  * Keys are TraitLabels,
  * Values are the content of the trait specified by the key.
- * @internal
+ * @alpha
  */
 export interface TraitMap<TChild> {
 	readonly [key: string]: TreeNodeSequence<TChild>;
@@ -107,13 +107,13 @@ export interface TraitMap<TChild> {
 
 /**
  * A sequence of Nodes that make up a trait under a Node
- * @internal
+ * @alpha
  */
 export type TreeNodeSequence<TChild> = readonly TChild[];
 
 /**
  * An object which may have traits with children of the given type underneath it
- * @internal
+ * @alpha
  */
 export interface HasTraits<TChild> {
 	readonly traits: TraitMap<TChild>;
@@ -121,7 +121,7 @@ export interface HasTraits<TChild> {
 
 /**
  * The fields required by a node in a tree
- * @internal
+ * @alpha
  */
 export interface NodeData<TId> {
 	/**
@@ -143,7 +143,7 @@ export interface NodeData<TId> {
 
 /**
  * Satisfies `NodeData` and may contain children under traits (which may or may not be `TreeNodes`)
- * @internal
+ * @alpha
  */
 export interface TreeNode<TChild, TId> extends NodeData<TId>, HasTraits<TChild> {}
 
@@ -155,7 +155,7 @@ export type PlaceholderTree<TPlaceholder = never> = TreeNode<PlaceholderTree<TPl
 
 /**
  * Specifies the location of a trait (a labeled sequence of nodes) within the tree.
- * @internal
+ * @alpha
  */
 export interface TraitLocationInternal_0_0_2 {
 	readonly parent: StableNodeId;
@@ -164,13 +164,13 @@ export interface TraitLocationInternal_0_0_2 {
 
 /**
  * JSON-compatible Node type. Objects of this type will be persisted in internal change objects (under Edits) in the SharedTree history.
- * @internal
+ * @alpha
  */
 export type ChangeNode_0_0_2 = TreeNode<ChangeNode_0_0_2, StableNodeId>;
 
 /**
  * The status code of an attempt to apply the changes in an Edit.
- * @internal
+ * @alpha
  */
 export enum EditStatus {
 	/**
@@ -245,7 +245,7 @@ export interface SharedTreeEditOp_0_0_2 extends VersionedOp<WriteFormat.v0_0_2>
 
 /**
  * Format versions that SharedTree supports writing. Changes to op or summary formats necessitate updates.
- * @internal
+ * @alpha
  */
 export enum WriteFormat {
 	/** Stores all edits in their raw format. */
@@ -256,7 +256,7 @@ export enum WriteFormat {
 
 /**
  * The minimal information on a SharedTree summary. Contains the summary format version.
- * @internal
+ * @alpha
  */
 export interface SharedTreeSummaryBase {
 	/**
@@ -282,7 +282,7 @@ export interface SharedTreeSummary_0_0_2 extends SharedTreeSummaryBase {
 
 /**
  * {@inheritdoc ChangeType}
- * @internal
+ * @alpha
  */
 export enum ChangeTypeInternal {
 	Insert,
@@ -306,13 +306,13 @@ export type ChangeInternal_0_0_2 =
 
 /**
  * {@inheritdoc BuildNode}
- * @internal
+ * @alpha
  */
 export type BuildNodeInternal_0_0_2 = TreeNode<BuildNodeInternal_0_0_2, StableNodeId> | DetachedSequenceId;
 
 /**
  * {@inheritdoc Build}
- * @internal
+ * @alpha
  */
 export interface BuildInternal_0_0_2 {
 	/** {@inheritdoc Build.destination } */
@@ -325,7 +325,7 @@ export interface BuildInternal_0_0_2 {
 
 /**
  * {@inheritdoc (Insert:interface)}
- * @internal
+ * @alpha
  */
 export interface InsertInternal_0_0_2 {
 	/** {@inheritdoc (Insert:interface).destination } */
@@ -338,7 +338,7 @@ export interface InsertInternal_0_0_2 {
 
 /**
  * {@inheritdoc Detach}
- * @internal
+ * @alpha
  */
 export interface DetachInternal_0_0_2 {
 	/** {@inheritdoc Detach.destination } */
@@ -351,7 +351,7 @@ export interface DetachInternal_0_0_2 {
 
 /**
  * {@inheritdoc SetValue}
- * @internal
+ * @alpha
  */
 export interface SetValueInternal_0_0_2 {
 	/** {@inheritdoc SetValue.nodeToModify } */
@@ -365,7 +365,7 @@ export interface SetValueInternal_0_0_2 {
 
 /**
  * What to do when a Constraint is violated.
- * @internal
+ * @alpha
  */
 export enum ConstraintEffect {
 	/**
@@ -388,7 +388,7 @@ export enum ConstraintEffect {
 
 /**
  * {@inheritdoc Constraint}
- * @internal
+ * @alpha
  */
 export interface ConstraintInternal_0_0_2 {
 	/** {@inheritdoc Constraint.toConstrain } */
@@ -411,7 +411,7 @@ export interface ConstraintInternal_0_0_2 {
 
 /**
  * {@inheritdoc (StablePlace:interface) }
- * @internal
+ * @alpha
  */
 export interface StablePlaceInternal_0_0_2 {
 	/**
@@ -432,7 +432,7 @@ export interface StablePlaceInternal_0_0_2 {
 
 /**
  * {@inheritdoc (StableRange:interface) }
- * @internal
+ * @alpha
  */
 export interface StableRangeInternal_0_0_2 {
 	/** {@inheritdoc (StableRange:interface).start } */

package/src/persisted-types/0.1.1.ts

@@ -50,7 +50,7 @@ import {
 
 /**
  * Specifies the location of a trait (a labeled sequence of nodes) within the tree.
- * @internal
+ * @alpha
  */
 export interface TraitLocationInternal extends Omit<TraitLocationInternal_0_0_2, 'parent'> {
 	readonly parent: NodeId;
@@ -206,7 +206,7 @@ export type CompressedBuildNode<TId extends OpSpaceNodeId> = CompressedPlacehold
  * This type should be used as an opaque handle in the public API for `ChangeInternal` objects.
  * This is useful for supporting public APIs which involve working with a tree's edit history,
  * which will involve changes that have already been internalized.
- * @internal
+ * @alpha
  */
 export interface InternalizedChange {
 	InternalChangeBrand: '2cae1045-61cf-4ef7-a6a3-8ad920cb7ab3';
@@ -214,19 +214,19 @@ export interface InternalizedChange {
 
 /**
  * {@inheritdoc (Change:type)}
- * @internal
+ * @alpha
  */
 export type ChangeInternal = InsertInternal | DetachInternal | BuildInternal | SetValueInternal | ConstraintInternal;
 
 /**
  * {@inheritdoc BuildNode}
- * @internal
+ * @alpha
  */
 export type BuildNodeInternal = TreeNode<BuildNodeInternal, NodeId> | DetachedSequenceId;
 
 /**
  * {@inheritdoc Build}
- * @internal
+ * @alpha
  */
 export interface BuildInternal extends Omit<BuildInternal_0_0_2, 'source'> {
 	readonly source: TreeNodeSequence<BuildNodeInternal>;
@@ -234,7 +234,7 @@ export interface BuildInternal extends Omit<BuildInternal_0_0_2, 'source'> {
 
 /**
  * {@inheritdoc (Insert:interface)}
- * @internal
+ * @alpha
  */
 export interface InsertInternal extends Omit<InsertInternal_0_0_2, 'destination'> {
 	/** {@inheritdoc (Insert:interface).destination } */
@@ -243,7 +243,7 @@ export interface InsertInternal extends Omit<InsertInternal_0_0_2, 'destination'
 
 /**
  * {@inheritdoc Detach}
- * @internal
+ * @alpha
  */
 export interface DetachInternal extends Omit<DetachInternal_0_0_2, 'source'> {
 	/** {@inheritdoc Detach.source } */
@@ -252,7 +252,7 @@ export interface DetachInternal extends Omit<DetachInternal_0_0_2, 'source'> {
 
 /**
  * {@inheritdoc SetValue}
- * @internal
+ * @alpha
  */
 export interface SetValueInternal extends Omit<SetValueInternal_0_0_2, 'nodeToModify'> {
 	/** {@inheritdoc SetValue.nodeToModify } */
@@ -261,7 +261,7 @@ export interface SetValueInternal extends Omit<SetValueInternal_0_0_2, 'nodeToMo
 
 /**
  * {@inheritdoc Constraint}
- * @internal
+ * @alpha
  */
 export interface ConstraintInternal extends Omit<ConstraintInternal_0_0_2, 'toConstrain' | 'parentNode'> {
 	/** {@inheritdoc Constraint.toConstrain } */
@@ -272,7 +272,7 @@ export interface ConstraintInternal extends Omit<ConstraintInternal_0_0_2, 'toCo
 
 // Note: Documentation of this constant is merged with documentation of the `ChangeInternal` interface.
 /**
- * @internal
+ * @alpha
  */
 export const ChangeInternal = {
 	build: (source: TreeNodeSequence<BuildNodeInternal>, destination: DetachedSequenceId): BuildInternal => ({
@@ -343,7 +343,7 @@ export const ChangeInternal = {
 
 /**
  * {@inheritdoc (StablePlace:interface) }
- * @internal
+ * @alpha
  */
 export interface StablePlaceInternal extends Omit<StablePlaceInternal_0_0_2, 'referenceSibling' | 'referenceTrait'> {
 	/**
@@ -359,7 +359,7 @@ export interface StablePlaceInternal extends Omit<StablePlaceInternal_0_0_2, 're
 
 /**
  * {@inheritdoc (StableRange:interface) }
- * @internal
+ * @alpha
  */
 export interface StableRangeInternal {
 	/** {@inheritdoc (StableRange:interface).start } */
@@ -374,7 +374,7 @@ export interface StableRangeInternal {
  */
 
 /**
- * @internal
+ * @alpha
  */
 export const StablePlaceInternal = {
 	/**
@@ -408,7 +408,7 @@ export const StablePlaceInternal = {
 };
 
 /**
- * @internal
+ * @alpha
  */
 export const StableRangeInternal = {
 	/**