@fluidframework/merge-tree 2.53.0 → 2.60.0

package/src/index.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-export {
+export type {
 	IAttributionCollection,
 	IAttributionCollectionSerializer,
 	IAttributionCollectionSpec,
@@ -15,61 +15,61 @@ export {
 	createPropertyTrackingAttributionPolicyFactory,
 	createPropertyTrackingAndInsertionAttributionPolicyFactory,
 } from "./attributionPolicy.js";
-export { Client, IClientEvents } from "./client.js";
+export { Client, type IClientEvents } from "./client.js";
 export {
-	ConflictAction,
-	Dictionary,
-	IRBAugmentation,
-	IRBMatcher,
-	KeyComparer,
-	Property,
-	PropertyAction,
-	QProperty,
+	type ConflictAction,
+	type Dictionary,
+	type IRBAugmentation,
+	type IRBMatcher,
+	type KeyComparer,
+	type Property,
+	type PropertyAction,
+	type QProperty,
 	RBColor,
-	RBNode,
-	RBNodeActions,
+	type RBNode,
+	type RBNodeActions,
 	RedBlackTree,
-	SortedDictionary,
+	type SortedDictionary,
 } from "./collections/index.js";
 export { UnassignedSequenceNumber, UniversalSequenceNumber } from "./constants.js";
 export {
 	createDetachedLocalReferencePosition,
 	LocalReferenceCollection,
-	LocalReferencePosition,
+	type LocalReferencePosition,
 	SlidingPreference,
 } from "./localReference.js";
 export {
-	AttributionPolicy,
-	IMergeTreeAttributionOptions,
-	IMergeTreeOptions,
-	IMergeTreeOptionsInternal,
+	type AttributionPolicy,
+	type IMergeTreeAttributionOptions,
+	type IMergeTreeOptions,
+	type IMergeTreeOptionsInternal,
 	getSlideToSegoff,
 } from "./mergeTree.js";
 export {
-	IMergeTreeDeltaCallbackArgs,
-	IMergeTreeDeltaOpArgs,
-	IMergeTreeMaintenanceCallbackArgs,
-	IMergeTreeSegmentDelta,
-	MergeTreeDeltaOperationType,
-	MergeTreeDeltaOperationTypes,
+	type IMergeTreeDeltaCallbackArgs,
+	type IMergeTreeDeltaOpArgs,
+	type IMergeTreeMaintenanceCallbackArgs,
+	type IMergeTreeSegmentDelta,
+	type MergeTreeDeltaOperationType,
+	type MergeTreeDeltaOperationTypes,
 	MergeTreeMaintenanceType,
 } from "./mergeTreeDeltaCallback.js";
 export {
 	BaseSegment,
 	CollaborationWindow,
-	IJSONMarkerSegment,
+	type IJSONMarkerSegment,
 	segmentIsRemoved,
-	ISegment,
-	ISegmentAction,
+	type ISegment,
+	type ISegmentAction,
 	Marker,
 	reservedMarkerIdKey,
 	reservedMarkerSimpleTypeKey,
-	ISegmentInternal,
+	type ISegmentInternal,
 } from "./mergeTreeNodes.js";
 export {
-	Trackable,
+	type Trackable,
 	TrackingGroup,
-	ITrackingGroup,
+	type ITrackingGroup,
 	TrackingGroupCollection,
 } from "./mergeTreeTracking.js";
 export {
@@ -81,36 +81,36 @@ export {
 	createObliterateRangeOp,
 } from "./opBuilder.js";
 export {
-	AdjustParams,
-	IJSONSegment,
-	IMarkerDef,
-	IMergeTreeAnnotateMsg,
-	IMergeTreeDelta,
-	IMergeTreeDeltaOp,
-	IMergeTreeGroupMsg,
-	IMergeTreeInsertMsg,
-	IMergeTreeOp,
-	IMergeTreeRemoveMsg,
-	IMergeTreeAnnotateAdjustMsg,
-	IRelativePosition,
+	type AdjustParams,
+	type IJSONSegment,
+	type IMarkerDef,
+	type IMergeTreeAnnotateMsg,
+	type IMergeTreeDelta,
+	type IMergeTreeDeltaOp,
+	type IMergeTreeGroupMsg,
+	type IMergeTreeInsertMsg,
+	type IMergeTreeOp,
+	type IMergeTreeRemoveMsg,
+	type IMergeTreeAnnotateAdjustMsg,
+	type IRelativePosition,
 	MergeTreeDeltaType,
 	ReferenceType,
-	IMergeTreeObliterateMsg,
-	IMergeTreeObliterateSidedMsg,
+	type IMergeTreeObliterateMsg,
+	type IMergeTreeObliterateSidedMsg,
 } from "./ops.js";
 export {
 	addProperties,
 	createMap,
-	MapLike,
+	type MapLike,
 	matchProperties,
-	PropertySet,
+	type PropertySet,
 } from "./properties.js";
 export {
 	compareReferencePositions,
 	DetachedReferencePosition,
 	maxReferencePosition,
 	minReferencePosition,
-	ReferencePosition,
+	type ReferencePosition,
 	refGetTileLabels,
 	refHasTileLabel,
 	refHasTileLabels,
@@ -119,25 +119,25 @@ export {
 	reservedTileLabelsKey,
 } from "./referencePositions.js";
 export {
-	PropsOrAdjust,
+	type PropsOrAdjust,
 	copyPropertiesAndManager,
 	PropertiesManager,
 } from "./segmentPropertiesManager.js";
 export {
-	InteriorSequencePlace,
+	type InteriorSequencePlace,
 	Side,
-	SequencePlace,
+	type SequencePlace,
 	endpointPosAndSide,
 } from "./sequencePlace.js";
 export { SortedSet } from "./sortedSet.js";
-export { SortedSegmentSet, SortedSegmentSetItem } from "./sortedSegmentSet.js";
-export { IJSONTextSegment, TextSegment } from "./textSegment.js";
+export { SortedSegmentSet, type SortedSegmentSetItem } from "./sortedSegmentSet.js";
+export { type IJSONTextSegment, TextSegment } from "./textSegment.js";
 export {
 	appendToMergeTreeDeltaRevertibles,
 	discardMergeTreeDeltaRevertible,
 	isMergeTreeDeltaRevertible,
-	MergeTreeDeltaRevertible,
-	MergeTreeRevertibleDriver,
+	type MergeTreeDeltaRevertible,
+	type MergeTreeRevertibleDriver,
 	revertMergeTreeDeltaRevertibles,
 } from "./revertibles.js";
 export type { OperationStamp } from "./stamps.js";

package/src/localReference.ts

@@ -6,22 +6,21 @@
 import {
 	assert,
 	DoublyLinkedList,
-	ListNode,
+	type ListNode,
 	walkList,
 } from "@fluidframework/core-utils/internal";
 import { UsageError } from "@fluidframework/telemetry-utils/internal";
 
-import { type ISegmentInternal } from "./mergeTreeNodes.js";
-import { TrackingGroup, TrackingGroupCollection } from "./mergeTreeTracking.js";
+import type { ISegmentInternal } from "./mergeTreeNodes.js";
+import { type TrackingGroup, TrackingGroupCollection } from "./mergeTreeTracking.js";
 import { ReferenceType } from "./ops.js";
-import { PropertySet, addProperties } from "./properties.js";
-import { ReferencePosition, refTypeIncludesFlag } from "./referencePositions.js";
+import { type PropertySet, addProperties } from "./properties.js";
+import { type ReferencePosition, refTypeIncludesFlag } from "./referencePositions.js";
 
 /**
  * Dictates the preferential direction for a {@link ReferencePosition} to slide
  * in a merge-tree
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export const SlidingPreference = {
 	/**
@@ -37,8 +36,7 @@ export const SlidingPreference = {
 /**
  * Dictates the preferential direction for a {@link ReferencePosition} to slide
  * in a merge-tree
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type SlidingPreference = (typeof SlidingPreference)[keyof typeof SlidingPreference];
 
@@ -61,8 +59,7 @@ function _validateReferenceType(refType: ReferenceType): void {
 }
 /**
  * @sealed
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface LocalReferencePosition extends ReferencePosition {
 	callbacks?: Partial<

package/src/mergeTree.ts

@@ -9,14 +9,14 @@
 import {
 	assert,
 	Heap,
-	IComparer,
+	type IComparer,
 	DoublyLinkedList,
-	ListNode,
+	type ListNode,
 } from "@fluidframework/core-utils/internal";
 import { DataProcessingError, UsageError } from "@fluidframework/telemetry-utils/internal";
 
-import { IAttributionCollectionSerializer } from "./attributionCollection.js";
-import { Client } from "./client.js";
+import type { IAttributionCollectionSerializer } from "./attributionCollection.js";
+import type { Client } from "./client.js";
 import {
 	NonCollabClient,
 	TreeMaintenanceSequenceNumber,
@@ -25,16 +25,16 @@ import {
 import { EndOfTreeSegment, StartOfTreeSegment } from "./endOfTreeSegment.js";
 import {
 	LocalReferenceCollection,
-	LocalReferencePosition,
+	type LocalReferencePosition,
 	SlidingPreference,
 	anyLocalReferencePosition,
 	filterLocalReferencePositions,
 } from "./localReference.js";
 import {
-	IMergeTreeDeltaOpArgs,
-	IMergeTreeSegmentDelta,
-	MergeTreeDeltaCallback,
-	MergeTreeMaintenanceCallback,
+	type IMergeTreeDeltaOpArgs,
+	type IMergeTreeSegmentDelta,
+	type MergeTreeDeltaCallback,
+	type MergeTreeMaintenanceCallback,
 	MergeTreeMaintenanceType,
 } from "./mergeTreeDeltaCallback.js";
 import {
@@ -47,14 +47,14 @@ import {
 } from "./mergeTreeNodeWalk.js";
 import {
 	CollaborationWindow,
-	IMergeNode,
-	ISegmentAction,
-	ISegmentChanges,
-	InsertContext,
+	type IMergeNode,
+	type ISegmentAction,
+	type ISegmentChanges,
+	type InsertContext,
 	Marker,
 	MaxNodesInBlock,
 	MergeBlock,
-	SegmentGroup,
+	type SegmentGroup,
 	assertSegmentLeaf,
 	assignChild,
 	getMinSeqPerspective,
@@ -74,7 +74,7 @@ import {
 	createRemoveRangeOp,
 } from "./opBuilder.js";
 import {
-	IRelativePosition,
+	type IRelativePosition,
 	MergeTreeDeltaType,
 	ReferenceType,
 	type IMergeTreeOp,
@@ -88,10 +88,10 @@ import {
 	RemoteObliteratePerspective,
 	allAckedChangesPerspective,
 } from "./perspective.js";
-import { PropertySet, createMap, extend, extendIfUndefined } from "./properties.js";
+import { type PropertySet, createMap, extend, extendIfUndefined } from "./properties.js";
 import {
 	DetachedReferencePosition,
-	ReferencePosition,
+	type ReferencePosition,
 	refGetTileLabels,
 	refHasTileLabel,
 	refTypeIncludesFlag,
@@ -99,7 +99,7 @@ import {
 import { SegmentGroupCollection } from "./segmentGroupCollection.js";
 import {
 	assertRemoved,
-	ISegmentInsideObliterateInfo,
+	type ISegmentInsideObliterateInfo,
 	isInsideObliterate,
 	isMergeNodeInfo,
 	isRemoved,
@@ -215,8 +215,7 @@ function ackSegment(
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IMergeTreeOptions {
 	catchUpBlobName?: string;

package/src/mergeTreeDeltaCallback.ts

@@ -3,16 +3,15 @@
  * Licensed under the MIT License.
  */
 
-import { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
+import type { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
 
-import { ISegment } from "./mergeTreeNodes.js";
+import type { ISegment } from "./mergeTreeNodes.js";
 // eslint-disable-next-line import/no-deprecated
-import { IMergeTreeGroupMsg, IMergeTreeOp, MergeTreeDeltaType } from "./ops.js";
-import { PropertySet } from "./properties.js";
+import type { IMergeTreeGroupMsg, IMergeTreeOp, MergeTreeDeltaType } from "./ops.js";
+import type { PropertySet } from "./properties.js";
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type MergeTreeDeltaOperationType =
 	| typeof MergeTreeDeltaType.ANNOTATE
@@ -25,8 +24,7 @@ export type MergeTreeDeltaOperationType =
  * Maintenance events correspond to structural segment changes or acks of pending segments.
  *
  * Note: these values are assigned negative integers to avoid clashing with `MergeTreeDeltaType`.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export const MergeTreeMaintenanceType = {
 	/**
@@ -56,23 +54,20 @@ export const MergeTreeMaintenanceType = {
 	ACKNOWLEDGED: -4,
 } as const;
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type MergeTreeMaintenanceType =
 	(typeof MergeTreeMaintenanceType)[keyof typeof MergeTreeMaintenanceType];
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type MergeTreeDeltaOperationTypes =
 	| MergeTreeDeltaOperationType
 	| MergeTreeMaintenanceType;
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IMergeTreeDeltaCallbackArgs<
 	TOperationType extends MergeTreeDeltaOperationTypes = MergeTreeDeltaOperationType,
@@ -94,8 +89,7 @@ export interface IMergeTreeDeltaCallbackArgs<
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IMergeTreeSegmentDelta {
 	/**
@@ -116,8 +110,7 @@ export interface IMergeTreeSegmentDelta {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IMergeTreeDeltaOpArgs {
 	/**
@@ -156,8 +149,7 @@ export type MergeTreeDeltaCallback = (
 ) => void;
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
 export interface IMergeTreeMaintenanceCallbackArgs

package/src/mergeTreeNodeWalk.ts

@@ -3,7 +3,7 @@
  * Licensed under the MIT License.
  */
 
-import { type ISegmentLeaf, type MergeBlock, IMergeNode } from "./mergeTreeNodes.js";
+import type { ISegmentLeaf, MergeBlock, IMergeNode } from "./mergeTreeNodes.js";
 import { isMergeNodeInfo } from "./segmentInfos.js";
 
 export const LeafAction = {

package/src/mergeTreeNodes.ts

@@ -4,9 +4,9 @@
  */
 
 import { assert } from "@fluidframework/core-utils/internal";
-import { AttributionKey } from "@fluidframework/runtime-definitions/internal";
+import type { AttributionKey } from "@fluidframework/runtime-definitions/internal";
 
-import { IAttributionCollection } from "./attributionCollection.js";
+import type { IAttributionCollection } from "./attributionCollection.js";
 import {
 	LocalClientId,
 	NonCollabClient,
@@ -15,13 +15,13 @@ import {
 } from "./constants.js";
 import { LocalReferenceCollection, type LocalReferencePosition } from "./localReference.js";
 import { TrackingGroupCollection, type ITrackingGroup } from "./mergeTreeTracking.js";
-import { IJSONSegment, IMarkerDef, ReferenceType } from "./ops.js";
+import type { IJSONSegment, IMarkerDef, ReferenceType } from "./ops.js";
 import { computeHierarchicalOrdinal } from "./ordinal.js";
 import type { PartialSequenceLengths } from "./partialLengths.js";
 import { LocalDefaultPerspective, PriorPerspective, type Perspective } from "./perspective.js";
-import { PropertySet, clone, createMap, type MapLike } from "./properties.js";
-import { ReferencePosition } from "./referencePositions.js";
-import { SegmentGroupCollection } from "./segmentGroupCollection.js";
+import { type PropertySet, clone, createMap, type MapLike } from "./properties.js";
+import type { ReferencePosition } from "./referencePositions.js";
+import type { SegmentGroupCollection } from "./segmentGroupCollection.js";
 import {
 	hasProp,
 	isInserted,
@@ -32,10 +32,10 @@ import {
 	type IMergeNodeInfo,
 	type IHasRemovalInfo,
 	type SegmentWithInfo,
-	ISegmentInsideObliterateInfo,
+	type ISegmentInsideObliterateInfo,
 	isInsideObliterate,
 } from "./segmentInfos.js";
-import { PropertiesManager } from "./segmentPropertiesManager.js";
+import type { PropertiesManager } from "./segmentPropertiesManager.js";
 import type { Side } from "./sequencePlace.js";
 import type { OperationStamp, SliceRemoveOperationStamp } from "./stamps.js";
 
@@ -132,8 +132,7 @@ export type IMergeNode = MergeBlock | ISegmentLeaf;
 /**
  * A segment representing a portion of the merge tree.
  * Segments are leaf nodes of the merge tree and contain data.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISegment {
 	readonly type: string;
@@ -178,16 +177,14 @@ export interface ISegment {
 
 /**
  * Determine if a segment has been removed.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export function segmentIsRemoved(segment: ISegment): boolean {
 	return isRemoved(segment);
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ISegmentAction<TClientData> {
 	// eslint-disable-next-line @typescript-eslint/prefer-function-type
@@ -330,8 +327,7 @@ export function seqLTE(seq: number, minOrRefSeq: number): boolean {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export abstract class BaseSegment implements ISegment {
 	public cachedLength: number = 0;
@@ -469,8 +465,7 @@ export abstract class BaseSegment implements ISegment {
  *
  * @remarks In general, marker ids should be accessed using the inherent method
  * {@link Marker.getId}. Marker ids should not be updated after creation.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export const reservedMarkerIdKey = "markerId";
 
@@ -480,8 +475,7 @@ export const reservedMarkerIdKey = "markerId";
 export const reservedMarkerSimpleTypeKey = "markerSimpleType";
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IJSONMarkerSegment extends IJSONSegment {
 	marker: IMarkerDef;
@@ -496,8 +490,7 @@ export interface IJSONMarkerSegment extends IJSONSegment {
  * start of a paragraph to the end, assuming a paragraph is bound by markers at
  * the start and end.
  *
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export class Marker extends BaseSegment implements ReferencePosition, ISegment {
 	public static readonly type = "Marker";

package/src/mergeTreeTracking.ts

@@ -3,19 +3,17 @@
  * Licensed under the MIT License.
  */
 
-import { LocalReferencePosition } from "./localReference.js";
-import { ISegment } from "./mergeTreeNodes.js";
+import type { LocalReferencePosition } from "./localReference.js";
+import type { ISegment } from "./mergeTreeNodes.js";
 import { SortedSegmentSet } from "./sortedSegmentSet.js";
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type Trackable = ISegment | LocalReferencePosition;
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ITrackingGroup {
 	tracked: readonly Trackable[];
@@ -26,8 +24,7 @@ export interface ITrackingGroup {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export class TrackingGroup implements ITrackingGroup {
 	private readonly trackedSet: SortedSegmentSet<Trackable>;
@@ -104,8 +101,7 @@ export class UnorderedTrackingGroup implements ITrackingGroup {
 
 /**
  * A collection of {@link ITrackingGroup}.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export class TrackingGroupCollection {
 	private readonly _trackingGroups: Set<ITrackingGroup>;

package/src/opBuilder.ts

@@ -3,22 +3,22 @@
  * Licensed under the MIT License.
  */
 
-import { ISegment, Marker } from "./mergeTreeNodes.js";
+import type { ISegment, Marker } from "./mergeTreeNodes.js";
 import {
-	IMergeTreeAnnotateMsg,
-	IMergeTreeDeltaOp,
+	type IMergeTreeAnnotateMsg,
+	type IMergeTreeDeltaOp,
 	// eslint-disable-next-line import/no-deprecated
-	IMergeTreeGroupMsg,
-	IMergeTreeInsertMsg,
+	type IMergeTreeGroupMsg,
+	type IMergeTreeInsertMsg,
 	// eslint-disable-next-line import/no-deprecated
-	IMergeTreeObliterateMsg,
-	IMergeTreeRemoveMsg,
+	type IMergeTreeObliterateMsg,
+	type IMergeTreeRemoveMsg,
 	MergeTreeDeltaType,
 	type AdjustParams,
 	type IMergeTreeAnnotateAdjustMsg,
 	type IMergeTreeObliterateSidedMsg,
 } from "./ops.js";
-import { PropertySet, type MapLike } from "./properties.js";
+import type { PropertySet, MapLike } from "./properties.js";
 import { normalizePlace, Side, type SequencePlace } from "./sequencePlace.js";
 
 /**