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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (215) hide show
  1. package/CHANGELOG.md +34 -0
  2. package/api-extractor-lint.json +1 -10
  3. package/api-extractor.json +0 -9
  4. package/api-report/experimental-tree.api.md +131 -130
  5. package/dist/ChangeTypes.d.ts +15 -15
  6. package/dist/ChangeTypes.js +4 -4
  7. package/dist/ChangeTypes.js.map +1 -1
  8. package/dist/Checkout.d.ts +4 -4
  9. package/dist/Checkout.js +3 -3
  10. package/dist/Checkout.js.map +1 -1
  11. package/dist/Common.d.ts +1 -1
  12. package/dist/Common.d.ts.map +1 -1
  13. package/dist/Common.js.map +1 -1
  14. package/dist/EagerCheckout.d.ts +1 -1
  15. package/dist/EagerCheckout.js +1 -1
  16. package/dist/EagerCheckout.js.map +1 -1
  17. package/dist/EditLog.d.ts +3 -2
  18. package/dist/EditLog.d.ts.map +1 -1
  19. package/dist/EditLog.js +3 -5
  20. package/dist/EditLog.js.map +1 -1
  21. package/dist/EditUtilities.d.ts +5 -5
  22. package/dist/EditUtilities.js +2 -2
  23. package/dist/EditUtilities.js.map +1 -1
  24. package/dist/EventTypes.d.ts +1 -1
  25. package/dist/EventTypes.js +1 -1
  26. package/dist/EventTypes.js.map +1 -1
  27. package/dist/Forest.d.ts +4 -4
  28. package/dist/Forest.js +3 -6
  29. package/dist/Forest.js.map +1 -1
  30. package/dist/Identifiers.d.ts +14 -14
  31. package/dist/Identifiers.js.map +1 -1
  32. package/dist/InitialTree.d.ts +1 -1
  33. package/dist/InitialTree.js +1 -1
  34. package/dist/InitialTree.js.map +1 -1
  35. package/dist/LogViewer.d.ts +2 -2
  36. package/dist/LogViewer.js +1 -1
  37. package/dist/LogViewer.js.map +1 -1
  38. package/dist/NodeIdUtilities.d.ts +3 -3
  39. package/dist/NodeIdUtilities.js.map +1 -1
  40. package/dist/PayloadUtilities.d.ts +1 -1
  41. package/dist/PayloadUtilities.js +1 -1
  42. package/dist/PayloadUtilities.js.map +1 -1
  43. package/dist/ReconciliationPath.d.ts +3 -3
  44. package/dist/ReconciliationPath.js.map +1 -1
  45. package/dist/RevisionValueCache.d.ts +1 -1
  46. package/dist/RevisionValueCache.js +2 -2
  47. package/dist/RevisionValueCache.js.map +1 -1
  48. package/dist/RevisionView.d.ts +2 -2
  49. package/dist/RevisionView.js +2 -2
  50. package/dist/RevisionView.js.map +1 -1
  51. package/dist/SharedTree.d.ts +14 -14
  52. package/dist/SharedTree.js +2 -2
  53. package/dist/SharedTree.js.map +1 -1
  54. package/dist/Transaction.d.ts +3 -3
  55. package/dist/Transaction.js +2 -2
  56. package/dist/Transaction.js.map +1 -1
  57. package/dist/TransactionInternal.d.ts +17 -17
  58. package/dist/TransactionInternal.js +3 -3
  59. package/dist/TransactionInternal.js.map +1 -1
  60. package/dist/TreeView.d.ts +7 -7
  61. package/dist/TreeView.js +1 -1
  62. package/dist/TreeView.js.map +1 -1
  63. package/dist/id-compressor/IdCompressor.js +2 -5
  64. package/dist/id-compressor/IdCompressor.js.map +1 -1
  65. package/dist/migration-shim/migrationShim.d.ts +3 -3
  66. package/dist/migration-shim/migrationShim.d.ts.map +1 -1
  67. package/dist/migration-shim/migrationShim.js +9 -5
  68. package/dist/migration-shim/migrationShim.js.map +1 -1
  69. package/dist/migration-shim/migrationShimFactory.d.ts +2 -2
  70. package/dist/migration-shim/migrationShimFactory.d.ts.map +1 -1
  71. package/dist/migration-shim/migrationShimFactory.js.map +1 -1
  72. package/dist/migration-shim/sharedTreeShim.d.ts +4 -4
  73. package/dist/migration-shim/sharedTreeShim.d.ts.map +1 -1
  74. package/dist/migration-shim/sharedTreeShim.js +1 -1
  75. package/dist/migration-shim/sharedTreeShim.js.map +1 -1
  76. package/dist/migration-shim/sharedTreeShimFactory.d.ts +1 -2
  77. package/dist/migration-shim/sharedTreeShimFactory.d.ts.map +1 -1
  78. package/dist/migration-shim/sharedTreeShimFactory.js.map +1 -1
  79. package/dist/migration-shim/shimDeltaConnection.d.ts +16 -0
  80. package/dist/migration-shim/shimDeltaConnection.d.ts.map +1 -1
  81. package/dist/migration-shim/shimDeltaConnection.js +16 -2
  82. package/dist/migration-shim/shimDeltaConnection.js.map +1 -1
  83. package/dist/migration-shim/types.d.ts +1 -1
  84. package/dist/migration-shim/types.d.ts.map +1 -1
  85. package/dist/migration-shim/types.js.map +1 -1
  86. package/dist/persisted-types/0.0.2.d.ts +24 -24
  87. package/dist/persisted-types/0.0.2.js +5 -5
  88. package/dist/persisted-types/0.0.2.js.map +1 -1
  89. package/dist/persisted-types/0.1.1.d.ts +14 -14
  90. package/dist/persisted-types/0.1.1.js +3 -3
  91. package/dist/persisted-types/0.1.1.js.map +1 -1
  92. package/dist/tree-alpha.d.ts +2674 -119
  93. package/dist/tree-beta.d.ts +1 -50
  94. package/dist/tree-public.d.ts +1 -52
  95. package/dist/tree-untrimmed.d.ts +142 -143
  96. package/lib/ChangeTypes.d.ts +15 -15
  97. package/lib/ChangeTypes.js +4 -4
  98. package/lib/ChangeTypes.js.map +1 -1
  99. package/lib/Checkout.d.ts +4 -4
  100. package/lib/Checkout.js +3 -3
  101. package/lib/Checkout.js.map +1 -1
  102. package/lib/Common.d.ts +1 -1
  103. package/lib/Common.d.ts.map +1 -1
  104. package/lib/Common.js.map +1 -1
  105. package/lib/EagerCheckout.d.ts +1 -1
  106. package/lib/EagerCheckout.js +1 -1
  107. package/lib/EagerCheckout.js.map +1 -1
  108. package/lib/EditLog.d.ts +3 -2
  109. package/lib/EditLog.d.ts.map +1 -1
  110. package/lib/EditLog.js +2 -1
  111. package/lib/EditLog.js.map +1 -1
  112. package/lib/EditUtilities.d.ts +5 -5
  113. package/lib/EditUtilities.js +2 -2
  114. package/lib/EditUtilities.js.map +1 -1
  115. package/lib/EventTypes.d.ts +1 -1
  116. package/lib/EventTypes.js +1 -1
  117. package/lib/EventTypes.js.map +1 -1
  118. package/lib/Forest.d.ts +4 -4
  119. package/lib/Forest.js +2 -2
  120. package/lib/Forest.js.map +1 -1
  121. package/lib/Identifiers.d.ts +14 -14
  122. package/lib/Identifiers.js.map +1 -1
  123. package/lib/InitialTree.d.ts +1 -1
  124. package/lib/InitialTree.js +1 -1
  125. package/lib/InitialTree.js.map +1 -1
  126. package/lib/LogViewer.d.ts +2 -2
  127. package/lib/LogViewer.js +1 -1
  128. package/lib/LogViewer.js.map +1 -1
  129. package/lib/NodeIdUtilities.d.ts +3 -3
  130. package/lib/NodeIdUtilities.js.map +1 -1
  131. package/lib/PayloadUtilities.d.ts +1 -1
  132. package/lib/PayloadUtilities.js +1 -1
  133. package/lib/PayloadUtilities.js.map +1 -1
  134. package/lib/ReconciliationPath.d.ts +3 -3
  135. package/lib/ReconciliationPath.js.map +1 -1
  136. package/lib/RevisionValueCache.d.ts +1 -1
  137. package/lib/RevisionValueCache.js +1 -1
  138. package/lib/RevisionValueCache.js.map +1 -1
  139. package/lib/RevisionView.d.ts +2 -2
  140. package/lib/RevisionView.js +2 -2
  141. package/lib/RevisionView.js.map +1 -1
  142. package/lib/SharedTree.d.ts +14 -14
  143. package/lib/SharedTree.js +2 -2
  144. package/lib/SharedTree.js.map +1 -1
  145. package/lib/Transaction.d.ts +3 -3
  146. package/lib/Transaction.js +2 -2
  147. package/lib/Transaction.js.map +1 -1
  148. package/lib/TransactionInternal.d.ts +17 -17
  149. package/lib/TransactionInternal.js +3 -3
  150. package/lib/TransactionInternal.js.map +1 -1
  151. package/lib/TreeView.d.ts +7 -7
  152. package/lib/TreeView.js +1 -1
  153. package/lib/TreeView.js.map +1 -1
  154. package/lib/id-compressor/IdCompressor.js +1 -1
  155. package/lib/id-compressor/IdCompressor.js.map +1 -1
  156. package/lib/migration-shim/migrationShim.d.ts +3 -3
  157. package/lib/migration-shim/migrationShim.d.ts.map +1 -1
  158. package/lib/migration-shim/migrationShim.js +9 -5
  159. package/lib/migration-shim/migrationShim.js.map +1 -1
  160. package/lib/migration-shim/migrationShimFactory.d.ts +2 -2
  161. package/lib/migration-shim/migrationShimFactory.d.ts.map +1 -1
  162. package/lib/migration-shim/migrationShimFactory.js.map +1 -1
  163. package/lib/migration-shim/sharedTreeShim.d.ts +4 -4
  164. package/lib/migration-shim/sharedTreeShim.d.ts.map +1 -1
  165. package/lib/migration-shim/sharedTreeShim.js +1 -1
  166. package/lib/migration-shim/sharedTreeShim.js.map +1 -1
  167. package/lib/migration-shim/sharedTreeShimFactory.d.ts +1 -2
  168. package/lib/migration-shim/sharedTreeShimFactory.d.ts.map +1 -1
  169. package/lib/migration-shim/sharedTreeShimFactory.js.map +1 -1
  170. package/lib/migration-shim/shimDeltaConnection.d.ts +16 -0
  171. package/lib/migration-shim/shimDeltaConnection.d.ts.map +1 -1
  172. package/lib/migration-shim/shimDeltaConnection.js +16 -2
  173. package/lib/migration-shim/shimDeltaConnection.js.map +1 -1
  174. package/lib/migration-shim/types.d.ts +1 -1
  175. package/lib/migration-shim/types.d.ts.map +1 -1
  176. package/lib/migration-shim/types.js.map +1 -1
  177. package/lib/persisted-types/0.0.2.d.ts +24 -24
  178. package/lib/persisted-types/0.0.2.js +5 -5
  179. package/lib/persisted-types/0.0.2.js.map +1 -1
  180. package/lib/persisted-types/0.1.1.d.ts +14 -14
  181. package/lib/persisted-types/0.1.1.js +3 -3
  182. package/lib/persisted-types/0.1.1.js.map +1 -1
  183. package/lib/test/utilities/TestUtilities.d.ts +1 -2
  184. package/lib/test/utilities/TestUtilities.d.ts.map +1 -1
  185. package/lib/test/utilities/TestUtilities.js.map +1 -1
  186. package/package.json +25 -25
  187. package/src/ChangeTypes.ts +15 -15
  188. package/src/Checkout.ts +4 -4
  189. package/src/Common.ts +1 -1
  190. package/src/EagerCheckout.ts +1 -1
  191. package/src/EditLog.ts +4 -3
  192. package/src/EditUtilities.ts +5 -5
  193. package/src/EventTypes.ts +1 -1
  194. package/src/Forest.ts +5 -5
  195. package/src/Identifiers.ts +14 -14
  196. package/src/InitialTree.ts +1 -1
  197. package/src/LogViewer.ts +2 -2
  198. package/src/NodeIdUtilities.ts +3 -3
  199. package/src/PayloadUtilities.ts +1 -1
  200. package/src/ReconciliationPath.ts +3 -3
  201. package/src/RevisionValueCache.ts +2 -2
  202. package/src/RevisionView.ts +2 -2
  203. package/src/SharedTree.ts +14 -14
  204. package/src/Transaction.ts +3 -3
  205. package/src/TransactionInternal.ts +17 -17
  206. package/src/TreeView.ts +7 -7
  207. package/src/id-compressor/IdCompressor.ts +1 -1
  208. package/src/migration-shim/migrationShim.ts +17 -9
  209. package/src/migration-shim/migrationShimFactory.ts +2 -2
  210. package/src/migration-shim/sharedTreeShim.ts +6 -5
  211. package/src/migration-shim/sharedTreeShimFactory.ts +1 -2
  212. package/src/migration-shim/shimDeltaConnection.ts +16 -2
  213. package/src/migration-shim/types.ts +1 -1
  214. package/src/persisted-types/0.0.2.ts +24 -24
  215. package/src/persisted-types/0.1.1.ts +14 -14
@@ -25,9 +25,8 @@ import { ITelemetryBaseEvent } from '@fluidframework/core-interfaces';
25
25
  import { ITelemetryContext } from '@fluidframework/runtime-definitions';
26
26
  import { ITelemetryLoggerExt } from '@fluidframework/telemetry-utils';
27
27
  import { ITelemetryProperties } from '@fluidframework/core-interfaces';
28
- import { ITree } from '@fluid-experimental/tree2';
28
+ import { ITree } from '@fluidframework/tree';
29
29
  import { SharedObject } from '@fluidframework/shared-object-base';
30
- import { TreeFactory } from '@fluid-experimental/tree2';
31
30
  import { TypedEventEmitter } from '@fluid-internal/client-utils';
32
31
 
33
32
  /**
@@ -38,19 +37,19 @@ export declare function areRevisionViewsSemanticallyEqual(treeViewA: TreeView, i
38
37
 
39
38
  /**
40
39
  * An identifier associated with a session for the purpose of attributing its created content to some user/entity.
41
- * @internal
40
+ * @alpha
42
41
  */
43
42
  export declare type AttributionId = UuidString;
44
43
 
45
44
  /**
46
45
  * The result of validating a bad place.
47
- * @internal
46
+ * @alpha
48
47
  */
49
48
  export declare type BadPlaceValidationResult = Exclude<PlaceValidationResult, PlaceValidationResult.Valid>;
50
49
 
51
50
  /**
52
51
  * The result of validating a bad range.
53
- * @internal
52
+ * @alpha
54
53
  */
55
54
  export declare type BadRangeValidationResult = Exclude<RangeValidationResult, RangeValidationResultKind.Valid>;
56
55
 
@@ -60,7 +59,7 @@ export declare type BadRangeValidationResult = Exclude<RangeValidationResult, Ra
60
59
  *
61
60
  * Valid if (transitively) all DetachedSequenceId are used according to their rules (use here counts as a destination),
62
61
  * and all Nodes' identifiers are previously unused.
63
- * @internal
62
+ * @alpha
64
63
  */
65
64
  export declare interface Build {
66
65
  readonly destination: number;
@@ -70,7 +69,7 @@ export declare interface Build {
70
69
 
71
70
  /**
72
71
  * {@inheritdoc Build}
73
- * @internal
72
+ * @alpha
74
73
  */
75
74
  export declare interface BuildInternal extends Omit<BuildInternal_0_0_2, 'source'> {
76
75
  readonly source: TreeNodeSequence<BuildNodeInternal>;
@@ -78,7 +77,7 @@ export declare interface BuildInternal extends Omit<BuildInternal_0_0_2, 'source
78
77
 
79
78
  /**
80
79
  * {@inheritdoc Build}
81
- * @internal
80
+ * @alpha
82
81
  */
83
82
  export declare interface BuildInternal_0_0_2 {
84
83
  /** {@inheritdoc Build.destination } */
@@ -92,19 +91,19 @@ export declare interface BuildInternal_0_0_2 {
92
91
  /**
93
92
  * Node or a detached sequence of nodes (referred to by a detached sequence ID) for use in a Build change.
94
93
  * See `BuildTreeNode` for more.
95
- * @internal
94
+ * @alpha
96
95
  */
97
96
  export declare type BuildNode = BuildTreeNode | number;
98
97
 
99
98
  /**
100
99
  * {@inheritdoc BuildNode}
101
- * @internal
100
+ * @alpha
102
101
  */
103
102
  export declare type BuildNodeInternal = TreeNode<BuildNodeInternal, NodeId> | DetachedSequenceId;
104
103
 
105
104
  /**
106
105
  * {@inheritdoc BuildNode}
107
- * @internal
106
+ * @alpha
108
107
  */
109
108
  export declare type BuildNodeInternal_0_0_2 = TreeNode<BuildNodeInternal_0_0_2, StableNodeId> | DetachedSequenceId;
110
109
 
@@ -115,7 +114,7 @@ export declare type BuildNodeInternal_0_0_2 = TreeNode<BuildNodeInternal_0_0_2,
115
114
  * BuildTreeNode can be observed. If `identifier` is not supplied, one will be generated for it in an especially efficient manner
116
115
  * that allows for compact storage and transmission and thus this property should be omitted if convenient.
117
116
  * See the SharedTree readme for more on the tree format.
118
- * @internal
117
+ * @alpha
119
118
  */
120
119
  export declare interface BuildTreeNode extends HasVariadicTraits<BuildNode> {
121
120
  definition: string;
@@ -135,12 +134,12 @@ export declare interface BuildTreeNode extends HasVariadicTraits<BuildNode> {
135
134
  * ```typescript
136
135
  * Change.insert(sourceId, destination)
137
136
  * ```
138
- * @internal
137
+ * @alpha
139
138
  */
140
139
  export declare type Change = Insert | Detach | Build | SetValue | Constraint;
141
140
 
142
141
  /**
143
- * @internal
142
+ * @alpha
144
143
  */
145
144
  export declare const Change: {
146
145
  build: (source: BuildNode | TreeNodeSequence<BuildNode>, destination: number) => Build;
@@ -166,12 +165,12 @@ export declare const Change: {
166
165
 
167
166
  /**
168
167
  * {@inheritdoc (Change:type)}
169
- * @internal
168
+ * @alpha
170
169
  */
171
170
  export declare type ChangeInternal = InsertInternal | DetachInternal | BuildInternal | SetValueInternal | ConstraintInternal;
172
171
 
173
172
  /**
174
- * @internal
173
+ * @alpha
175
174
  */
176
175
  export declare const ChangeInternal: {
177
176
  build: (source: TreeNodeSequence<BuildNodeInternal>, destination: DetachedSequenceId) => BuildInternal;
@@ -196,7 +195,7 @@ export declare type ChangeNode = TreeNode<ChangeNode, NodeId>;
196
195
 
197
196
  /**
198
197
  * JSON-compatible Node type. Objects of this type will be persisted in internal change objects (under Edits) in the SharedTree history.
199
- * @internal
198
+ * @alpha
200
199
  */
201
200
  export declare type ChangeNode_0_0_2 = TreeNode<ChangeNode_0_0_2, StableNodeId>;
202
201
 
@@ -208,7 +207,7 @@ export declare type ChangeResult = Result<TransactionView, TransactionFailure>;
208
207
 
209
208
  /**
210
209
  * The type of a Change
211
- * @internal
210
+ * @alpha
212
211
  */
213
212
  export declare enum ChangeType {
214
213
  Insert = 0,
@@ -220,7 +219,7 @@ export declare enum ChangeType {
220
219
 
221
220
  /**
222
221
  * {@inheritdoc ChangeType}
223
- * @internal
222
+ * @alpha
224
223
  */
225
224
  export declare enum ChangeTypeInternal {
226
225
  Insert = 0,
@@ -244,7 +243,7 @@ export declare enum ChangeTypeInternal {
244
243
  * Events emitted by `Checkout` are documented in {@link CheckoutEvent}.
245
244
  * Exceptions thrown during event handling will be emitted as error events, which are automatically surfaced as error events on the
246
245
  * `SharedTree` used at construction time.
247
- * @internal
246
+ * @alpha
248
247
  */
249
248
  export declare abstract class Checkout extends EventEmitterWithErrorHandling<ICheckoutEvents> implements IDisposable {
250
249
  /**
@@ -400,7 +399,7 @@ export declare abstract class Checkout extends EventEmitterWithErrorHandling<ICh
400
399
 
401
400
  /**
402
401
  * An event emitted by a `Checkout` to indicate a state change. See {@link ICheckoutEvents} for event argument information.
403
- * @internal
402
+ * @alpha
404
403
  */
405
404
  export declare enum CheckoutEvent {
406
405
  /**
@@ -443,13 +442,13 @@ export declare enum CheckoutEvent {
443
442
  * IFluidHandle instances (detected via JavaScript feature detection pattern) are only compared by absolutePath.
444
443
  *
445
444
  * TODO:#54095: Is there a better way to do this comparison?
446
- * @internal
445
+ * @alpha
447
446
  */
448
447
  export declare function comparePayloads(a: Payload, b: Payload): boolean;
449
448
 
450
449
  /**
451
450
  * An identifier (UUID) that has been shortened by a distributed compression algorithm.
452
- * @internal
451
+ * @alpha
453
452
  */
454
453
  export declare type CompressedId = FinalCompressedId | LocalCompressedId;
455
454
 
@@ -459,7 +458,7 @@ export declare type CompressedId = FinalCompressedId | LocalCompressedId;
459
458
  * non-semantic ways. It is processed in order like any other Change in an Edit. It can cause an edit to fail if the
460
459
  * various constraints are not met at the time of evaluation (ex: the parentNode has changed due to concurrent editing).
461
460
  * Does not modify the document.
462
- * @internal
461
+ * @alpha
463
462
  */
464
463
  export declare interface Constraint {
465
464
  /**
@@ -510,7 +509,7 @@ export declare interface Constraint {
510
509
 
511
510
  /**
512
511
  * What to do when a Constraint is violated.
513
- * @internal
512
+ * @alpha
514
513
  */
515
514
  export declare enum ConstraintEffect {
516
515
  /**
@@ -531,7 +530,7 @@ export declare enum ConstraintEffect {
531
530
 
532
531
  /**
533
532
  * {@inheritdoc Constraint}
534
- * @internal
533
+ * @alpha
535
534
  */
536
535
  export declare interface ConstraintInternal extends Omit<ConstraintInternal_0_0_2, 'toConstrain' | 'parentNode'> {
537
536
  /** {@inheritdoc Constraint.toConstrain } */
@@ -542,7 +541,7 @@ export declare interface ConstraintInternal extends Omit<ConstraintInternal_0_0_
542
541
 
543
542
  /**
544
543
  * {@inheritdoc Constraint}
545
- * @internal
544
+ * @alpha
546
545
  */
547
546
  export declare interface ConstraintInternal_0_0_2 {
548
547
  /** {@inheritdoc Constraint.toConstrain } */
@@ -566,7 +565,7 @@ export declare interface ConstraintInternal_0_0_2 {
566
565
  /**
567
566
  * Definition.
568
567
  * A full (Uuid) persistable definition.
569
- * @internal
568
+ * @alpha
570
569
  */
571
570
  export declare type Definition = UuidString & {
572
571
  readonly Definition: 'c0ef9488-2a78-482d-aeed-37fba996354c';
@@ -574,7 +573,7 @@ export declare type Definition = UuidString & {
574
573
 
575
574
  /**
576
575
  * Differences from one forest to another.
577
- * @internal
576
+ * @alpha
578
577
  */
579
578
  export declare interface Delta<NodeId> {
580
579
  /**
@@ -596,7 +595,7 @@ export declare interface Delta<NodeId> {
596
595
  * If a destination is specified, the detached sequence is associated with that ID and held for possible reuse
597
596
  * by later changes in this same Edit (such as by an Insert).
598
597
  * A Detach without a destination is a deletion of the specified sequence, as is a Detach with a destination that is not used later.
599
- * @internal
598
+ * @alpha
600
599
  */
601
600
  export declare interface Detach {
602
601
  readonly destination?: number;
@@ -610,7 +609,7 @@ export declare interface Detach {
610
609
  * Within a given Edit, any DetachedSequenceId must be a source at most once, and a destination at most once.
611
610
  * If used as a source, it must be after it is used as a destination.
612
611
  * If this is violated, the Edit is considered malformed.
613
- * @internal
612
+ * @alpha
614
613
  */
615
614
  export declare type DetachedSequenceId = number & {
616
615
  readonly DetachedSequenceId: 'f7d7903a-194e-45e7-8e82-c9ef4333577d';
@@ -618,7 +617,7 @@ export declare type DetachedSequenceId = number & {
618
617
 
619
618
  /**
620
619
  * {@inheritdoc Detach}
621
- * @internal
620
+ * @alpha
622
621
  */
623
622
  export declare interface DetachInternal extends Omit<DetachInternal_0_0_2, 'source'> {
624
623
  /** {@inheritdoc Detach.source } */
@@ -627,7 +626,7 @@ export declare interface DetachInternal extends Omit<DetachInternal_0_0_2, 'sour
627
626
 
628
627
  /**
629
628
  * {@inheritdoc Detach}
630
- * @internal
629
+ * @alpha
631
630
  */
632
631
  export declare interface DetachInternal_0_0_2 {
633
632
  /** {@inheritdoc Detach.destination } */
@@ -642,7 +641,7 @@ export declare interface DetachInternal_0_0_2 {
642
641
  * Checkout that always stays up to date with the SharedTree.
643
642
  * This means that {@link EagerCheckout.waitForPendingUpdates} is always a no-op since EagerCheckout is always up to date.
644
643
  * @sealed
645
- * @internal
644
+ * @alpha
646
645
  */
647
646
  export declare class EagerCheckout extends Checkout {
648
647
  /**
@@ -657,7 +656,7 @@ export declare class EagerCheckout extends Checkout {
657
656
  /**
658
657
  * A collection of changes to the tree that are applied atomically along with a unique identifier for the edit.
659
658
  * If any individual change fails to apply, the entire Edit will fail to apply.
660
- * @internal
659
+ * @alpha
661
660
  */
662
661
  export declare interface Edit<TChange> extends EditBase<TChange> {
663
662
  /**
@@ -669,7 +668,7 @@ export declare interface Edit<TChange> extends EditBase<TChange> {
669
668
 
670
669
  /**
671
670
  * The outcome of an edit.
672
- * @internal
671
+ * @alpha
673
672
  */
674
673
  export declare type EditApplicationOutcome = {
675
674
  /**
@@ -693,7 +692,7 @@ export declare type EditApplicationOutcome = {
693
692
 
694
693
  /**
695
694
  * The information included in an edit.
696
- * @internal
695
+ * @alpha
697
696
  */
698
697
  export declare interface EditBase<TChange> {
699
698
  /**
@@ -710,7 +709,7 @@ export declare interface EditBase<TChange> {
710
709
 
711
710
  /**
712
711
  * The arguments included when the EditCommitted SharedTreeEvent is emitted.
713
- * @internal
712
+ * @alpha
714
713
  */
715
714
  export declare interface EditCommittedEventArguments {
716
715
  /** The ID of the edit committed. */
@@ -723,7 +722,7 @@ export declare interface EditCommittedEventArguments {
723
722
 
724
723
  /**
725
724
  * Expected type for a handler of the `EditCommitted` event.
726
- * @internal
725
+ * @alpha
727
726
  */
728
727
  export declare type EditCommittedHandler = (args: EditCommittedEventArguments) => void;
729
728
 
@@ -740,7 +739,7 @@ export declare interface EditHandle<TChange> {
740
739
 
741
740
  /**
742
741
  * Edit identifier
743
- * @internal
742
+ * @alpha
744
743
  */
745
744
  export declare type EditId = UuidString & {
746
745
  readonly EditId: '56897beb-53e4-4e66-85da-4bf5cd5d0d49';
@@ -754,7 +753,7 @@ export declare type EditingResult = FailedEditingResult | ValidEditingResult;
754
753
 
755
754
  /**
756
755
  * Basic result of applying a transaction.
757
- * @internal
756
+ * @alpha
758
757
  */
759
758
  export declare interface EditingResultBase {
760
759
  /**
@@ -803,7 +802,7 @@ export declare interface EditLogSummary<TChange, THandle> {
803
802
 
804
803
  /**
805
804
  * The status code of an attempt to apply the changes in an Edit.
806
- * @internal
805
+ * @alpha
807
806
  */
808
807
  export declare enum EditStatus {
809
808
  /**
@@ -825,7 +824,7 @@ export declare enum EditStatus {
825
824
 
826
825
  /**
827
826
  * The result of validation of an Edit.
828
- * @internal
827
+ * @alpha
829
828
  */
830
829
  export declare enum EditValidationResult {
831
830
  /**
@@ -906,7 +905,7 @@ export declare interface FailingTransactionState extends TransactionFailure {
906
905
  * A compressed ID that is local to a document. Stable across all revisions of a document starting from the one in which it was created.
907
906
  * It should not be persisted outside of the history as it can only be decompressed in the context of the originating document.
908
907
  * If external persistence is needed (e.g. by a client), a StableId should be used instead.
909
- * @internal
908
+ * @alpha
910
909
  */
911
910
  export declare type FinalCompressedId = number & {
912
911
  readonly FinalCompressedId: '5d83d1e2-98b7-4e4e-a889-54c855cfa73d';
@@ -928,7 +927,7 @@ export declare interface FluidEditHandle {
928
927
  /**
929
928
  * An immutable forest of ForestNode.
930
929
  * Enforces single parenting, and allows querying the parent.
931
- * @internal
930
+ * @alpha
932
931
  */
933
932
  export declare class Forest {
934
933
  /**
@@ -1039,7 +1038,7 @@ export declare class Forest {
1039
1038
 
1040
1039
  /**
1041
1040
  * A node that can be contained within a Forest
1042
- * @internal
1041
+ * @alpha
1043
1042
  */
1044
1043
  export declare interface ForestNode extends NodeData<NodeId> {
1045
1044
  readonly traits: ReadonlyMap<TraitLabel, readonly NodeId[]>;
@@ -1168,7 +1167,7 @@ export declare function getTraitLocationOfRange(view: TreeView, range: StableRan
1168
1167
 
1169
1168
  /**
1170
1169
  * An object which may have traits with children of the given type underneath it
1171
- * @internal
1170
+ * @alpha
1172
1171
  */
1173
1172
  export declare interface HasTraits<TChild> {
1174
1173
  readonly traits: TraitMap<TChild>;
@@ -1176,7 +1175,7 @@ export declare interface HasTraits<TChild> {
1176
1175
 
1177
1176
  /**
1178
1177
  * An object which may have traits with children of the given type underneath it
1179
- * @internal
1178
+ * @alpha
1180
1179
  */
1181
1180
  export declare interface HasVariadicTraits<TChild> {
1182
1181
  readonly traits?: {
@@ -1186,7 +1185,7 @@ export declare interface HasVariadicTraits<TChild> {
1186
1185
 
1187
1186
  /**
1188
1187
  * Events which may be emitted by `Checkout`. See {@link CheckoutEvent} for documentation of event semantics.
1189
- * @internal
1188
+ * @alpha
1190
1189
  */
1191
1190
  export declare interface ICheckoutEvents extends IErrorEvent {
1192
1191
  (event: 'viewChange', listener: (before: TreeView, after: TreeView) => void): any;
@@ -1206,14 +1205,14 @@ export declare interface IMigrationEvent extends IEvent {
1206
1205
 
1207
1206
  /**
1208
1207
  * The initial tree.
1209
- * @internal
1208
+ * @alpha
1210
1209
  */
1211
1210
  export declare const initialTree: ChangeNode_0_0_2;
1212
1211
 
1213
1212
  /**
1214
1213
  * Inserts a sequence of nodes at the specified destination.
1215
1214
  * The source can be constructed either by a Build (used to insert new nodes) or a Detach (amounts to a "move" operation).
1216
- * @internal
1215
+ * @alpha
1217
1216
  */
1218
1217
  export declare interface Insert {
1219
1218
  readonly destination: StablePlace;
@@ -1223,7 +1222,7 @@ export declare interface Insert {
1223
1222
 
1224
1223
  /**
1225
1224
  * {@inheritdoc (Insert:interface)}
1226
- * @internal
1225
+ * @alpha
1227
1226
  */
1228
1227
  export declare interface InsertInternal extends Omit<InsertInternal_0_0_2, 'destination'> {
1229
1228
  /** {@inheritdoc (Insert:interface).destination } */
@@ -1232,7 +1231,7 @@ export declare interface InsertInternal extends Omit<InsertInternal_0_0_2, 'dest
1232
1231
 
1233
1232
  /**
1234
1233
  * {@inheritdoc (Insert:interface)}
1235
- * @internal
1234
+ * @alpha
1236
1235
  */
1237
1236
  export declare interface InsertInternal_0_0_2 {
1238
1237
  /** {@inheritdoc (Insert:interface).destination } */
@@ -1247,7 +1246,7 @@ export declare interface InsertInternal_0_0_2 {
1247
1246
  * This type should be used as an opaque handle in the public API for `ChangeInternal` objects.
1248
1247
  * This is useful for supporting public APIs which involve working with a tree's edit history,
1249
1248
  * which will involve changes that have already been internalized.
1250
- * @internal
1249
+ * @alpha
1251
1250
  */
1252
1251
  export declare interface InternalizedChange {
1253
1252
  InternalChangeBrand: '2cae1045-61cf-4ef7-a6a3-8ad920cb7ab3';
@@ -1269,7 +1268,7 @@ export declare function isDetachedSequenceId(node: DetachedSequenceId | object):
1269
1268
 
1270
1269
  /**
1271
1270
  * Events which may be emitted by `SharedTree`. See {@link SharedTreeEvent} for documentation of event semantics.
1272
- * @internal
1271
+ * @alpha
1273
1272
  */
1274
1273
  export declare interface ISharedTreeEvents extends ISharedObjectEvents {
1275
1274
  (event: 'committedEdit', listener: EditCommittedHandler): any;
@@ -1315,7 +1314,7 @@ export declare class LazyCheckout extends Checkout {
1315
1314
  * A compressed ID that is local to a session (can only be decompressed when paired with a SessionId).
1316
1315
  * It should not be persisted outside of the history as it can only be decompressed in the context of the originating session.
1317
1316
  * If external persistence is needed (e.g. by a client), a StableId should be used instead.
1318
- * @internal
1317
+ * @alpha
1319
1318
  */
1320
1319
  export declare type LocalCompressedId = number & {
1321
1320
  readonly LocalCompressedId: '6fccb42f-e2a4-4243-bd29-f13d12b9c6d1';
@@ -1323,7 +1322,7 @@ export declare type LocalCompressedId = number & {
1323
1322
 
1324
1323
  /**
1325
1324
  * Creates `RevisionView`s for the revisions in an `EditLog`
1326
- * @internal
1325
+ * @alpha
1327
1326
  */
1328
1327
  export declare interface LogViewer {
1329
1328
  /**
@@ -1539,7 +1538,7 @@ export declare class MigrationShim extends EventEmitterWithErrorHandling<IMigrat
1539
1538
  private readonly legacyTreeFactory;
1540
1539
  private readonly newTreeFactory;
1541
1540
  private readonly populateNewSharedObjectFn;
1542
- constructor(id: string, runtime: IFluidDataStoreRuntime, legacyTreeFactory: SharedTreeFactory, newTreeFactory: TreeFactory, populateNewSharedObjectFn: (legacyTree: SharedTree, newTree: ITree) => void);
1541
+ constructor(id: string, runtime: IFluidDataStoreRuntime, legacyTreeFactory: SharedTreeFactory, newTreeFactory: IChannelFactory, populateNewSharedObjectFn: (legacyTree: SharedTree, newTree: ITree) => void);
1543
1542
  private readonly processMigrateOp;
1544
1543
  private readonly migrationDeltaHandler;
1545
1544
  private services?;
@@ -1607,7 +1606,7 @@ export declare class MigrationShimFactory implements IChannelFactory {
1607
1606
  private readonly oldFactory;
1608
1607
  private readonly newFactory;
1609
1608
  private readonly populateNewChannelFn;
1610
- constructor(oldFactory: SharedTreeFactory, newFactory: TreeFactory, populateNewChannelFn: (oldChannel: SharedTree, newChannel: ITree) => void);
1609
+ constructor(oldFactory: SharedTreeFactory, newFactory: IChannelFactory, populateNewChannelFn: (oldChannel: SharedTree, newChannel: ITree) => void);
1611
1610
  /**
1612
1611
  * This factory takes over the type of the oldFactory to load in its place. The user must not include the MigrationShimFactory and the oldFactory in the same registry to avoid conflict.
1613
1612
  *
@@ -1639,7 +1638,7 @@ export declare class MigrationShimFactory implements IChannelFactory {
1639
1638
 
1640
1639
  /**
1641
1640
  * The fields required by a node in a tree
1642
- * @internal
1641
+ * @alpha
1643
1642
  */
1644
1643
  export declare interface NodeData<TId> {
1645
1644
  /**
@@ -1661,12 +1660,12 @@ export declare interface NodeData<TId> {
1661
1660
  /**
1662
1661
  * Node identifier.
1663
1662
  * Identifies a node within a document.
1664
- * @internal
1663
+ * @alpha
1665
1664
  */
1666
1665
  export declare type NodeId = number & SessionSpaceCompressedId & NodeIdBrand;
1667
1666
 
1668
1667
  /**
1669
- * @internal
1668
+ * @alpha
1670
1669
  */
1671
1670
  export declare interface NodeIdBrand {
1672
1671
  readonly NodeId: 'e53e7d6b-c8b9-431a-8805-4843fc639342';
@@ -1674,14 +1673,14 @@ export declare interface NodeIdBrand {
1674
1673
 
1675
1674
  /**
1676
1675
  * An object which can generate node IDs and convert node IDs between compressed and stable variants
1677
- * @internal
1676
+ * @alpha
1678
1677
  */
1679
1678
  export declare interface NodeIdContext extends NodeIdGenerator, NodeIdConverter {
1680
1679
  }
1681
1680
 
1682
1681
  /**
1683
1682
  * An object which can convert node IDs between compressed and stable variants
1684
- * @internal
1683
+ * @alpha
1685
1684
  */
1686
1685
  export declare interface NodeIdConverter {
1687
1686
  /**
@@ -1717,7 +1716,7 @@ export declare interface NodeIdConverter {
1717
1716
 
1718
1717
  /**
1719
1718
  * An object which can generate node IDs
1720
- * @internal
1719
+ * @alpha
1721
1720
  */
1722
1721
  export declare interface NodeIdGenerator {
1723
1722
  /**
@@ -1747,7 +1746,7 @@ export declare interface NodeInTrait {
1747
1746
  * An ordered set of Edits associated with a SharedTree.
1748
1747
  * Supports fast lookup of edits by ID and enforces idempotence.
1749
1748
  * @sealed
1750
- * @internal
1749
+ * @alpha
1751
1750
  */
1752
1751
  export declare interface OrderedEditSet<TChange = unknown> {
1753
1752
  /**
@@ -1797,7 +1796,7 @@ export declare interface OrderedEditSet<TChange = unknown> {
1797
1796
 
1798
1797
  /**
1799
1798
  * Information about a ForestNode's parent
1800
- * @internal
1799
+ * @alpha
1801
1800
  */
1802
1801
  export declare interface ParentData {
1803
1802
  readonly parentId: NodeId;
@@ -1812,7 +1811,7 @@ export declare interface ParentData {
1812
1811
  * See {@link comparePayloads} for equality semantics and related details (like what is allowed to be lost when serializing)
1813
1812
  *
1814
1813
  * TODO:#51984: Allow opting into heuristic blobbing in snapshots with a special IFluid key.
1815
- * @internal
1814
+ * @alpha
1816
1815
  */
1817
1816
  export declare type Payload = any;
1818
1817
 
@@ -1833,7 +1832,7 @@ export declare type PlaceholderTree<TPlaceholder = never> = TreeNode<Placeholder
1833
1832
  * 0 = before all nodes,
1834
1833
  * 1 = after first node,
1835
1834
  * etc.
1836
- * @internal
1835
+ * @alpha
1837
1836
  */
1838
1837
  export declare type PlaceIndex = number & {
1839
1838
  readonly PlaceIndex: unique symbol;
@@ -1841,7 +1840,7 @@ export declare type PlaceIndex = number & {
1841
1840
 
1842
1841
  /**
1843
1842
  * The result of validating a place.
1844
- * @internal
1843
+ * @alpha
1845
1844
  */
1846
1845
  export declare enum PlaceValidationResult {
1847
1846
  Valid = "Valid",
@@ -1859,7 +1858,7 @@ export declare function rangeFromStableRange(view: TreeView, range: StableRange)
1859
1858
 
1860
1859
  /**
1861
1860
  * The result of validating a range.
1862
- * @internal
1861
+ * @alpha
1863
1862
  */
1864
1863
  export declare type RangeValidationResult = RangeValidationResultKind.Valid | RangeValidationResultKind.PlacesInDifferentTraits | RangeValidationResultKind.Inverted | {
1865
1864
  kind: RangeValidationResultKind.BadPlace;
@@ -1869,7 +1868,7 @@ export declare type RangeValidationResult = RangeValidationResultKind.Valid | Ra
1869
1868
 
1870
1869
  /**
1871
1870
  * The kinds of result of validating a range.
1872
- * @internal
1871
+ * @alpha
1873
1872
  */
1874
1873
  export declare enum RangeValidationResultKind {
1875
1874
  Valid = "Valid",
@@ -1880,7 +1879,7 @@ export declare enum RangeValidationResultKind {
1880
1879
 
1881
1880
  /**
1882
1881
  * A change in the `ReconciliationPath`.
1883
- * @internal
1882
+ * @alpha
1884
1883
  */
1885
1884
  export declare interface ReconciliationChange {
1886
1885
  /**
@@ -1896,7 +1895,7 @@ export declare interface ReconciliationChange {
1896
1895
 
1897
1896
  /**
1898
1897
  * An edit in the `ReconciliationPath`.
1899
- * @internal
1898
+ * @alpha
1900
1899
  */
1901
1900
  export declare interface ReconciliationEdit {
1902
1901
  /**
@@ -1923,7 +1922,7 @@ export declare interface ReconciliationEdit {
1923
1922
  * change is actually applied.
1924
1923
  * The path only contains edits that were successfully applied.
1925
1924
  * This path is always empty for a change that has no concurrent edits.
1926
- * @internal
1925
+ * @alpha
1927
1926
  */
1928
1927
  export declare interface ReconciliationPath {
1929
1928
  /**
@@ -2024,13 +2023,13 @@ export declare namespace Result {
2024
2023
  * - revision 0 corresponds to the initialRevision.
2025
2024
  *
2026
2025
  * - revision 1 corresponds to the output of editLog[0] applied to the initialRevision.
2027
- * @internal
2026
+ * @alpha
2028
2027
  */
2029
2028
  export declare type Revision = number;
2030
2029
 
2031
2030
  /**
2032
2031
  * An immutable view of a distributed tree.
2033
- * @internal
2032
+ * @alpha
2034
2033
  */
2035
2034
  export declare class RevisionView extends TreeView {
2036
2035
  /**
@@ -2053,7 +2052,7 @@ export declare class RevisionView extends TreeView {
2053
2052
 
2054
2053
  /**
2055
2054
  * The arguments included when the {@link SharedTreeEvent.SequencedEditApplied} SharedTreeEvent is emitted.
2056
- * @internal
2055
+ * @alpha
2057
2056
  */
2058
2057
  export declare interface SequencedEditAppliedEventArguments {
2059
2058
  /** The ID of the edit committed. */
@@ -2072,7 +2071,7 @@ export declare interface SequencedEditAppliedEventArguments {
2072
2071
 
2073
2072
  /**
2074
2073
  * Expected type for a handler of the {@link SharedTreeEvent.SequencedEditApplied} event.
2075
- * @internal
2074
+ * @alpha
2076
2075
  */
2077
2076
  export declare type SequencedEditAppliedHandler = (args: SequencedEditAppliedEventArguments) => void;
2078
2077
 
@@ -2080,13 +2079,13 @@ export declare type SequencedEditAppliedHandler = (args: SequencedEditAppliedEve
2080
2079
  * A compressed ID that has been normalized into "session space" (see `IdCompressor` for more).
2081
2080
  * Consumer-facing APIs and data structures should use session-space IDs as their lifetime and equality is stable and tied to the
2082
2081
  * compressor that produced them.
2083
- * @internal
2082
+ * @alpha
2084
2083
  */
2085
2084
  export declare type SessionSpaceCompressedId = CompressedId & SessionUnique;
2086
2085
 
2087
2086
  /**
2088
2087
  * A brand for identity types that are unique within a particular session (SharedTree instance).
2089
- * @internal
2088
+ * @alpha
2090
2089
  */
2091
2090
  export declare interface SessionUnique {
2092
2091
  readonly SessionUnique: 'cea55054-6b82-4cbf-ad19-1fa645ea3b3e';
@@ -2100,7 +2099,7 @@ export declare function setTrait(trait: TraitLocation, nodes: BuildNode | TreeNo
2100
2099
 
2101
2100
  /**
2102
2101
  * Modifies the payload of a node.
2103
- * @internal
2102
+ * @alpha
2104
2103
  */
2105
2104
  export declare interface SetValue {
2106
2105
  readonly nodeToModify: NodeId;
@@ -2116,7 +2115,7 @@ export declare interface SetValue {
2116
2115
 
2117
2116
  /**
2118
2117
  * {@inheritdoc SetValue}
2119
- * @internal
2118
+ * @alpha
2120
2119
  */
2121
2120
  export declare interface SetValueInternal extends Omit<SetValueInternal_0_0_2, 'nodeToModify'> {
2122
2121
  /** {@inheritdoc SetValue.nodeToModify } */
@@ -2125,7 +2124,7 @@ export declare interface SetValueInternal extends Omit<SetValueInternal_0_0_2, '
2125
2124
 
2126
2125
  /**
2127
2126
  * {@inheritdoc SetValue}
2128
- * @internal
2127
+ * @alpha
2129
2128
  */
2130
2129
  export declare interface SetValueInternal_0_0_2 {
2131
2130
  /** {@inheritdoc SetValue.nodeToModify } */
@@ -2138,7 +2137,7 @@ export declare interface SetValueInternal_0_0_2 {
2138
2137
 
2139
2138
  /**
2140
2139
  * A [distributed tree](../Readme.md).
2141
- * @internal
2140
+ * @alpha
2142
2141
  */
2143
2142
  export declare class SharedTree extends SharedObject<ISharedTreeEvents> implements NodeIdContext {
2144
2143
  private writeFormat;
@@ -2439,7 +2438,7 @@ export declare class SharedTree extends SharedObject<ISharedTreeEvents> implemen
2439
2438
 
2440
2439
  /**
2441
2440
  * The write format and associated options used to construct a `SharedTree`
2442
- * @internal
2441
+ * @alpha
2443
2442
  */
2444
2443
  export declare type SharedTreeArgs<WF extends WriteFormat = WriteFormat> = [writeFormat: WF, options?: SharedTreeOptions<WF>];
2445
2444
 
@@ -2455,7 +2454,7 @@ export declare const sharedTreeAssertionErrorType = "SharedTreeAssertion";
2455
2454
 
2456
2455
  /**
2457
2456
  * Configuration options for SharedTree that are independent of write format versions.
2458
- * @internal
2457
+ * @alpha
2459
2458
  */
2460
2459
  export declare interface SharedTreeBaseOptions {
2461
2460
  /**
@@ -2523,7 +2522,7 @@ export declare enum SharedTreeDiagnosticEvent {
2523
2522
  /**
2524
2523
  * An event emitted by a `SharedTree` to indicate a state change. See {@link ISharedTreeEvents} for event
2525
2524
  * argument information.
2526
- * @internal
2525
+ * @alpha
2527
2526
  */
2528
2527
  export declare enum SharedTreeEvent {
2529
2528
  /**
@@ -2565,7 +2564,7 @@ export declare enum SharedTreeEvent {
2565
2564
  /**
2566
2565
  * Factory for SharedTree.
2567
2566
  * Includes history in the summary.
2568
- * @internal
2567
+ * @alpha
2569
2568
  */
2570
2569
  export declare class SharedTreeFactory implements IChannelFactory {
2571
2570
  /**
@@ -2671,13 +2670,13 @@ export declare class SharedTreeMergeHealthTelemetryHeartbeat {
2671
2670
 
2672
2671
  /**
2673
2672
  * The type of shared tree options for a given write format
2674
- * @internal
2673
+ * @alpha
2675
2674
  */
2676
2675
  export declare type SharedTreeOptions<WF extends WriteFormat, HistoryCompatibility extends 'Forwards' | 'None' = 'Forwards'> = SharedTreeBaseOptions & Omit<WF extends WriteFormat.v0_0_2 ? SharedTreeOptions_0_0_2 : WF extends WriteFormat.v0_1_1 ? SharedTreeOptions_0_1_1 : never, HistoryCompatibility extends 'Forwards' ? 'summarizeHistory' : never>;
2677
2676
 
2678
2677
  /**
2679
2678
  * Configuration options for a SharedTree with write format 0.0.2
2680
- * @internal
2679
+ * @alpha
2681
2680
  */
2682
2681
  export declare interface SharedTreeOptions_0_0_2 {
2683
2682
  /**
@@ -2699,7 +2698,7 @@ export declare interface SharedTreeOptions_0_0_2 {
2699
2698
 
2700
2699
  /**
2701
2700
  * Configuration options for a SharedTree with write format 0.1.1
2702
- * @internal
2701
+ * @alpha
2703
2702
  */
2704
2703
  export declare interface SharedTreeOptions_0_1_1 {
2705
2704
  /**
@@ -2737,8 +2736,8 @@ export declare interface SharedTreeOptions_0_1_1 {
2737
2736
  export declare class SharedTreeShim implements IShim {
2738
2737
  readonly id: string;
2739
2738
  readonly runtime: IFluidDataStoreRuntime;
2740
- readonly sharedTreeFactory: TreeFactory;
2741
- constructor(id: string, runtime: IFluidDataStoreRuntime, sharedTreeFactory: TreeFactory);
2739
+ readonly sharedTreeFactory: IChannelFactory;
2740
+ constructor(id: string, runtime: IFluidDataStoreRuntime, sharedTreeFactory: IChannelFactory);
2742
2741
  private readonly newTreeShimDeltaHandler;
2743
2742
  private services?;
2744
2743
  private _currentTree?;
@@ -2771,7 +2770,7 @@ export declare class SharedTreeShim implements IShim {
2771
2770
  */
2772
2771
  export declare class SharedTreeShimFactory implements IChannelFactory {
2773
2772
  private readonly factory;
2774
- constructor(factory: TreeFactory);
2773
+ constructor(factory: IChannelFactory);
2775
2774
  /**
2776
2775
  * Can only load the new SharedTree - this allows our snapshots to be simple. We do not have to consider any new
2777
2776
  * unique snapshot formats and how to load from them.
@@ -2803,7 +2802,7 @@ export declare class SharedTreeShimFactory implements IChannelFactory {
2803
2802
 
2804
2803
  /**
2805
2804
  * The minimal information on a SharedTree summary. Contains the summary format version.
2806
- * @internal
2805
+ * @alpha
2807
2806
  */
2808
2807
  export declare interface SharedTreeSummaryBase {
2809
2808
  /**
@@ -2829,7 +2828,7 @@ export declare interface SharedTreeSummaryBase {
2829
2828
  * Each place can be specified, (aka 'anchored') in two ways (relative to the sibling before or after):
2830
2829
  * 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
2831
2830
  * two place description may no longer evaluate to the same place.
2832
- * @internal
2831
+ * @alpha
2833
2832
  */
2834
2833
  export declare enum Side {
2835
2834
  Before = 0,
@@ -2839,7 +2838,7 @@ export declare enum Side {
2839
2838
  /**
2840
2839
  * Globally unique node identifier.
2841
2840
  * Uniquely identifies a node within and across documents. Can be used across SharedTree instances.
2842
- * @internal
2841
+ * @alpha
2843
2842
  */
2844
2843
  export declare type StableNodeId = string & {
2845
2844
  readonly StableNodeId: 'a0843b38-699d-4bb2-aa7a-16c502a71151';
@@ -2867,7 +2866,7 @@ export declare type StableNodeId = string & {
2867
2866
  * StablePlace.before(node)
2868
2867
  * StablePlace.atStartOf(trait)
2869
2868
  * ```
2870
- * @internal
2869
+ * @alpha
2871
2870
  */
2872
2871
  export declare interface StablePlace {
2873
2872
  /**
@@ -2889,7 +2888,7 @@ export declare interface StablePlace {
2889
2888
  }
2890
2889
 
2891
2890
  /**
2892
- * @internal
2891
+ * @alpha
2893
2892
  */
2894
2893
  export declare const StablePlace: {
2895
2894
  /**
@@ -2912,7 +2911,7 @@ export declare const StablePlace: {
2912
2911
 
2913
2912
  /**
2914
2913
  * {@inheritdoc (StablePlace:interface) }
2915
- * @internal
2914
+ * @alpha
2916
2915
  */
2917
2916
  export declare interface StablePlaceInternal extends Omit<StablePlaceInternal_0_0_2, 'referenceSibling' | 'referenceTrait'> {
2918
2917
  /**
@@ -2926,7 +2925,7 @@ export declare interface StablePlaceInternal extends Omit<StablePlaceInternal_0_
2926
2925
  }
2927
2926
 
2928
2927
  /**
2929
- * @internal
2928
+ * @alpha
2930
2929
  */
2931
2930
  export declare const StablePlaceInternal: {
2932
2931
  /**
@@ -2949,7 +2948,7 @@ export declare const StablePlaceInternal: {
2949
2948
 
2950
2949
  /**
2951
2950
  * {@inheritdoc (StablePlace:interface) }
2952
- * @internal
2951
+ * @alpha
2953
2952
  */
2954
2953
  export declare interface StablePlaceInternal_0_0_2 {
2955
2954
  /**
@@ -2981,7 +2980,7 @@ export declare interface StablePlaceInternal_0_0_2 {
2981
2980
  * ```typescript
2982
2981
  * StableRange.from(StablePlace.before(startNode)).to(StablePlace.after(endNode))
2983
2982
  * ```
2984
- * @internal
2983
+ * @alpha
2985
2984
  */
2986
2985
  export declare interface StableRange {
2987
2986
  readonly start: StablePlace;
@@ -2989,7 +2988,7 @@ export declare interface StableRange {
2989
2988
  }
2990
2989
 
2991
2990
  /**
2992
- * @internal
2991
+ * @alpha
2993
2992
  */
2994
2993
  export declare const StableRange: {
2995
2994
  /**
@@ -3019,7 +3018,7 @@ export declare const StableRange: {
3019
3018
 
3020
3019
  /**
3021
3020
  * {@inheritdoc (StableRange:interface) }
3022
- * @internal
3021
+ * @alpha
3023
3022
  */
3024
3023
  export declare interface StableRangeInternal {
3025
3024
  /** {@inheritdoc (StableRange:interface).start } */
@@ -3029,7 +3028,7 @@ export declare interface StableRangeInternal {
3029
3028
  }
3030
3029
 
3031
3030
  /**
3032
- * @internal
3031
+ * @alpha
3033
3032
  */
3034
3033
  export declare const StableRangeInternal: {
3035
3034
  /**
@@ -3059,7 +3058,7 @@ export declare const StableRangeInternal: {
3059
3058
 
3060
3059
  /**
3061
3060
  * {@inheritdoc (StableRange:interface) }
3062
- * @internal
3061
+ * @alpha
3063
3062
  */
3064
3063
  export declare interface StableRangeInternal_0_0_2 {
3065
3064
  /** {@inheritdoc (StableRange:interface).start } */
@@ -3070,7 +3069,7 @@ export declare interface StableRangeInternal_0_0_2 {
3070
3069
 
3071
3070
  /**
3072
3071
  * Contains information resulting from processing stashed shared tree ops
3073
- * @internal
3072
+ * @alpha
3074
3073
  */
3075
3074
  export declare interface StashedLocalOpMetadata {
3076
3075
  /** A modified version of the edit in an edit op that should be resubmitted rather than the original edit */
@@ -3089,7 +3088,7 @@ export declare interface StringInterner {
3089
3088
 
3090
3089
  /**
3091
3090
  * The state of a transaction that has not encountered an error.
3092
- * @internal
3091
+ * @alpha
3093
3092
  */
3094
3093
  export declare interface SucceedingTransactionState {
3095
3094
  /**
@@ -3113,7 +3112,7 @@ export declare interface SucceedingTransactionState {
3113
3112
  /**
3114
3113
  * Definition.
3115
3114
  * A full (Uuid) persistable label for a trait.
3116
- * @internal
3115
+ * @alpha
3117
3116
  */
3118
3117
  export declare type TraitLabel = UuidString & {
3119
3118
  readonly TraitLabel: '613826ed-49cc-4df3-b2b8-bfc6866af8e3';
@@ -3121,7 +3120,7 @@ export declare type TraitLabel = UuidString & {
3121
3120
 
3122
3121
  /**
3123
3122
  * Specifies the location of a trait (a labeled sequence of nodes) within the tree.
3124
- * @internal
3123
+ * @alpha
3125
3124
  */
3126
3125
  export declare interface TraitLocation {
3127
3126
  readonly parent: NodeId;
@@ -3130,7 +3129,7 @@ export declare interface TraitLocation {
3130
3129
 
3131
3130
  /**
3132
3131
  * Specifies the location of a trait (a labeled sequence of nodes) within the tree.
3133
- * @internal
3132
+ * @alpha
3134
3133
  */
3135
3134
  export declare interface TraitLocationInternal extends Omit<TraitLocationInternal_0_0_2, 'parent'> {
3136
3135
  readonly parent: NodeId;
@@ -3138,7 +3137,7 @@ export declare interface TraitLocationInternal extends Omit<TraitLocationInterna
3138
3137
 
3139
3138
  /**
3140
3139
  * Specifies the location of a trait (a labeled sequence of nodes) within the tree.
3141
- * @internal
3140
+ * @alpha
3142
3141
  */
3143
3142
  export declare interface TraitLocationInternal_0_0_2 {
3144
3143
  readonly parent: StableNodeId;
@@ -3149,7 +3148,7 @@ export declare interface TraitLocationInternal_0_0_2 {
3149
3148
  * Json compatible map as object.
3150
3149
  * Keys are TraitLabels,
3151
3150
  * Values are the content of the trait specified by the key.
3152
- * @internal
3151
+ * @alpha
3153
3152
  */
3154
3153
  export declare interface TraitMap<TChild> {
3155
3154
  readonly [key: string]: TreeNodeSequence<TChild>;
@@ -3160,7 +3159,7 @@ export declare interface TraitMap<TChild> {
3160
3159
  * 0 = first node,
3161
3160
  * 1 = second node,
3162
3161
  * etc.
3163
- * @internal
3162
+ * @alpha
3164
3163
  */
3165
3164
  export declare type TraitNodeIndex = number & {
3166
3165
  readonly TraitNodeIndex: unique symbol;
@@ -3169,7 +3168,7 @@ export declare type TraitNodeIndex = number & {
3169
3168
  /**
3170
3169
  * Buffers changes to be applied to an isolated view of a `SharedTree` over time before applying them directly to the tree itself as a
3171
3170
  * single edit
3172
- * @internal
3171
+ * @alpha
3173
3172
  */
3174
3173
  export declare class Transaction extends TypedEventEmitter<TransactionEvents> {
3175
3174
  readonly tree: SharedTree;
@@ -3214,7 +3213,7 @@ export declare class Transaction extends TypedEventEmitter<TransactionEvents> {
3214
3213
 
3215
3214
  /**
3216
3215
  * An event emitted by a `Transaction` to indicate a state change. See {@link TransactionEvents} for event argument information.
3217
- * @internal
3216
+ * @alpha
3218
3217
  */
3219
3218
  export declare enum TransactionEvent {
3220
3219
  /**
@@ -3225,7 +3224,7 @@ export declare enum TransactionEvent {
3225
3224
 
3226
3225
  /**
3227
3226
  * Events which may be emitted by `Transaction`
3228
- * @internal
3227
+ * @alpha
3229
3228
  */
3230
3229
  export declare interface TransactionEvents extends IErrorEvent {
3231
3230
  (event: TransactionEvent.ViewChange, listener: (before: TreeView, after: TreeView) => void): any;
@@ -3258,7 +3257,7 @@ export declare interface TransactionFailure {
3258
3257
  *
3259
3258
  * No data outside the Transaction is modified by Transaction:
3260
3259
  * the results from `close` must be used to actually submit an `Edit`.
3261
- * @internal
3260
+ * @alpha
3262
3261
  */
3263
3262
  export declare namespace TransactionInternal {
3264
3263
  /**
@@ -3315,7 +3314,7 @@ export declare namespace TransactionInternal {
3315
3314
  }
3316
3315
  /**
3317
3316
  * The kinds of failures that a transaction might encounter.
3318
- * @internal
3317
+ * @alpha
3319
3318
  */
3320
3319
  export enum FailureKind {
3321
3320
  /**
@@ -3357,12 +3356,12 @@ export declare namespace TransactionInternal {
3357
3356
  }
3358
3357
  /**
3359
3358
  * A failure encountered by a transaction.
3360
- * @internal
3359
+ * @alpha
3361
3360
  */
3362
3361
  export type Failure = UnusedDetachedSequenceFailure | DetachedSequenceIdAlreadyInUseFailure | DetachedSequenceNotFoundFailure | DuplicateIdInBuildFailure | IdAlreadyInUseFailure | UnknownIdFailure | BadPlaceFailure | BadRangeFailure | ConstraintViolationFailure;
3363
3362
  /**
3364
3363
  * Error returned when a transaction is closed while there is an unused detached sequence.
3365
- * @internal
3364
+ * @alpha
3366
3365
  */
3367
3366
  export interface UnusedDetachedSequenceFailure {
3368
3367
  /**
@@ -3376,7 +3375,7 @@ export declare namespace TransactionInternal {
3376
3375
  }
3377
3376
  /**
3378
3377
  * Error thrown when a transaction encounters a build operation using an already in use DetachedSequenceID.
3379
- * @internal
3378
+ * @alpha
3380
3379
  */
3381
3380
  export interface DetachedSequenceIdAlreadyInUseFailure {
3382
3381
  /**
@@ -3394,7 +3393,7 @@ export declare namespace TransactionInternal {
3394
3393
  }
3395
3394
  /**
3396
3395
  * Error thrown when a transaction tries to operate on an unknown DetachedSequenceID
3397
- * @internal
3396
+ * @alpha
3398
3397
  */
3399
3398
  export interface DetachedSequenceNotFoundFailure {
3400
3399
  /**
@@ -3412,7 +3411,7 @@ export declare namespace TransactionInternal {
3412
3411
  }
3413
3412
  /**
3414
3413
  * Error thrown when a build uses a duplicated NodeId
3415
- * @internal
3414
+ * @alpha
3416
3415
  */
3417
3416
  export interface DuplicateIdInBuildFailure {
3418
3417
  /**
@@ -3430,7 +3429,7 @@ export declare namespace TransactionInternal {
3430
3429
  }
3431
3430
  /**
3432
3431
  * Error thrown when a build node ID is already used in the current state
3433
- * @internal
3432
+ * @alpha
3434
3433
  */
3435
3434
  export interface IdAlreadyInUseFailure {
3436
3435
  /**
@@ -3448,7 +3447,7 @@ export declare namespace TransactionInternal {
3448
3447
  }
3449
3448
  /**
3450
3449
  * Error thrown when a change is attempted on an unknown NodeId
3451
- * @internal
3450
+ * @alpha
3452
3451
  */
3453
3452
  export interface UnknownIdFailure {
3454
3453
  /**
@@ -3466,7 +3465,7 @@ export declare namespace TransactionInternal {
3466
3465
  }
3467
3466
  /**
3468
3467
  * Error thrown when an insert change uses an invalid Place
3469
- * @internal
3468
+ * @alpha
3470
3469
  */
3471
3470
  export interface BadPlaceFailure {
3472
3471
  /**
@@ -3488,7 +3487,7 @@ export declare namespace TransactionInternal {
3488
3487
  }
3489
3488
  /**
3490
3489
  * Error thrown when a detach operation is given an invalid or malformed Range
3491
- * @internal
3490
+ * @alpha
3492
3491
  */
3493
3492
  export interface BadRangeFailure {
3494
3493
  /**
@@ -3510,7 +3509,7 @@ export declare namespace TransactionInternal {
3510
3509
  }
3511
3510
  /**
3512
3511
  * Error thrown when a constraint fails to apply
3513
- * @internal
3512
+ * @alpha
3514
3513
  */
3515
3514
  export interface ConstraintViolationFailure {
3516
3515
  /**
@@ -3528,7 +3527,7 @@ export declare namespace TransactionInternal {
3528
3527
  }
3529
3528
  /**
3530
3529
  * The details of what kind of constraint was violated and caused a ConstraintViolationFailure error to occur
3531
- * @internal
3530
+ * @alpha
3532
3531
  */
3533
3532
  export type ConstraintViolationResult = {
3534
3533
  readonly kind: ConstraintViolationKind.BadRange;
@@ -3545,7 +3544,7 @@ export declare namespace TransactionInternal {
3545
3544
  };
3546
3545
  /**
3547
3546
  * Enum of possible kinds of constraint violations that can be encountered
3548
- * @internal
3547
+ * @alpha
3549
3548
  */
3550
3549
  export enum ConstraintViolationKind {
3551
3550
  /**
@@ -3576,7 +3575,7 @@ export declare type TransactionState = SucceedingTransactionState | FailingTrans
3576
3575
 
3577
3576
  /**
3578
3577
  * An view of a distributed tree that is part of an ongoing transaction between `RevisionView`s.
3579
- * @internal
3578
+ * @alpha
3580
3579
  */
3581
3580
  export declare class TransactionView extends TreeView {
3582
3581
  /** Conclude a transaction by generating an immutable `RevisionView` from this view */
@@ -3610,7 +3609,7 @@ export declare class TransactionView extends TreeView {
3610
3609
 
3611
3610
  /**
3612
3611
  * Satisfies `NodeData` and may contain children under traits (which may or may not be `TreeNodes`)
3613
- * @internal
3612
+ * @alpha
3614
3613
  */
3615
3614
  export declare interface TreeNode<TChild, TId> extends NodeData<TId>, HasTraits<TChild> {
3616
3615
  }
@@ -3638,13 +3637,13 @@ export declare class TreeNodeHandle implements TreeNode<TreeNodeHandle, NodeId>
3638
3637
 
3639
3638
  /**
3640
3639
  * A sequence of Nodes that make up a trait under a Node
3641
- * @internal
3640
+ * @alpha
3642
3641
  */
3643
3642
  export declare type TreeNodeSequence<TChild> = readonly TChild[];
3644
3643
 
3645
3644
  /**
3646
3645
  * A view of a distributed tree.
3647
- * @internal
3646
+ * @alpha
3648
3647
  */
3649
3648
  export declare abstract class TreeView {
3650
3649
  readonly root: NodeId;
@@ -3738,7 +3737,7 @@ export declare abstract class TreeView {
3738
3737
 
3739
3738
  /**
3740
3739
  * An immutable view of a distributed tree node.
3741
- * @internal
3740
+ * @alpha
3742
3741
  */
3743
3742
  export declare interface TreeViewNode extends NodeData<NodeId> {
3744
3743
  /** The IDs of the children under this node */
@@ -3750,7 +3749,7 @@ export declare interface TreeViewNode extends NodeData<NodeId> {
3750
3749
  /**
3751
3750
  * A place within a particular `TreeView` that is anchored relative to a specific node in the tree, or relative to the outside of the trait.
3752
3751
  * Valid iff 'trait' is valid and, if provided, sibling is in the Location specified by 'trait'.
3753
- * @internal
3752
+ * @alpha
3754
3753
  */
3755
3754
  export declare interface TreeViewPlace {
3756
3755
  readonly sibling?: NodeId;
@@ -3761,7 +3760,7 @@ export declare interface TreeViewPlace {
3761
3760
  /**
3762
3761
  * Specifies the range of nodes from `start` to `end` within a trait within a particular `TreeView`.
3763
3762
  * Valid iff start and end are valid and are within the same trait.
3764
- * @internal
3763
+ * @alpha
3765
3764
  */
3766
3765
  export declare interface TreeViewRange {
3767
3766
  readonly start: TreeViewPlace;
@@ -3785,7 +3784,7 @@ export declare function useFailedSequencedEditTelemetry(tree: SharedTree): {
3785
3784
  * A 128-bit Universally Unique IDentifier. Represented here
3786
3785
  * with a string of the form xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx,
3787
3786
  * where x is a lowercase hex digit.
3788
- * @internal
3787
+ * @alpha
3789
3788
  */
3790
3789
  export declare type UuidString = string & {
3791
3790
  readonly UuidString: '9d40d0ae-90d9-44b1-9482-9f55d59d5465';
@@ -3793,7 +3792,7 @@ export declare type UuidString = string & {
3793
3792
 
3794
3793
  /**
3795
3794
  * Result of applying a valid transaction.
3796
- * @internal
3795
+ * @alpha
3797
3796
  */
3798
3797
  export declare interface ValidEditingResult extends EditingResultBase {
3799
3798
  /**
@@ -3808,7 +3807,7 @@ export declare interface ValidEditingResult extends EditingResultBase {
3808
3807
 
3809
3808
  /**
3810
3809
  * Format versions that SharedTree supports writing. Changes to op or summary formats necessitate updates.
3811
- * @internal
3810
+ * @alpha
3812
3811
  */
3813
3812
  export declare enum WriteFormat {
3814
3813
  /** Stores all edits in their raw format. */