@fluidframework/merge-tree 2.53.0 → 2.60.0

package/src/ops.ts

@@ -5,8 +5,7 @@
 
 /**
  * Flags enum that dictates behavior of a {@link ReferencePosition}
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export enum ReferenceType {
 	Simple = 0x0,
@@ -49,8 +48,7 @@ export enum ReferenceType {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IMarkerDef {
 	refType?: ReferenceType;
@@ -58,8 +56,7 @@ export interface IMarkerDef {
 
 // Note: Assigned positive integers to avoid clashing with MergeTreeMaintenanceType
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export const MergeTreeDeltaType = {
 	INSERT: 0,
@@ -74,14 +71,12 @@ export const MergeTreeDeltaType = {
 } as const;
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type MergeTreeDeltaType = (typeof MergeTreeDeltaType)[keyof typeof MergeTreeDeltaType];
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IMergeTreeDelta {
 	/**
@@ -92,8 +87,7 @@ export interface IMergeTreeDelta {
 
 /**
  * A position specified relative to a segment.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IRelativePosition {
 	/**
@@ -113,8 +107,7 @@ export interface IRelativePosition {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IMergeTreeInsertMsg extends IMergeTreeDelta {
 	type: typeof MergeTreeDeltaType.INSERT;
@@ -129,8 +122,7 @@ export interface IMergeTreeInsertMsg extends IMergeTreeDelta {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IMergeTreeRemoveMsg extends IMergeTreeDelta {
 	type: typeof MergeTreeDeltaType.REMOVE;
@@ -144,8 +136,7 @@ export interface IMergeTreeRemoveMsg extends IMergeTreeDelta {
  * @deprecated We no longer intend to support this functionality and it will
  * be removed in a future release. There is no replacement for this
  * functionality.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IMergeTreeObliterateMsg extends IMergeTreeDelta {
 	type: typeof MergeTreeDeltaType.OBLITERATE;
@@ -164,8 +155,7 @@ export interface IMergeTreeObliterateMsg extends IMergeTreeDelta {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IMergeTreeObliterateSidedMsg extends IMergeTreeDelta {
 	type: typeof MergeTreeDeltaType.OBLITERATE_SIDED;
@@ -184,8 +174,7 @@ export interface IMergeTreeObliterateSidedMsg extends IMergeTreeDelta {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IMergeTreeAnnotateMsg extends IMergeTreeDelta {
 	type: typeof MergeTreeDeltaType.ANNOTATE;
@@ -200,8 +189,7 @@ export interface IMergeTreeAnnotateMsg extends IMergeTreeDelta {
 
 /**
  * Used to define per key adjustments in an {@link IMergeTreeAnnotateAdjustMsg}
- * @alpha
- * @legacy
+ * @legacy @beta
  */
 export interface AdjustParams {
 	/**
@@ -222,8 +210,7 @@ export interface AdjustParams {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IMergeTreeAnnotateAdjustMsg extends IMergeTreeDelta {
 	type: typeof MergeTreeDeltaType.ANNOTATE;
@@ -240,8 +227,7 @@ export interface IMergeTreeAnnotateAdjustMsg extends IMergeTreeDelta {
  * release, as group ops are redundant with the native batching capabilities
  * of the runtime
  *
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IMergeTreeGroupMsg extends IMergeTreeDelta {
 	type: typeof MergeTreeDeltaType.GROUP;
@@ -249,8 +235,7 @@ export interface IMergeTreeGroupMsg extends IMergeTreeDelta {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IJSONSegment {
 	// eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -258,8 +243,7 @@ export interface IJSONSegment {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type IMergeTreeDeltaOp =
 	| IMergeTreeInsertMsg
@@ -270,7 +254,6 @@ export type IMergeTreeDeltaOp =
 	| IMergeTreeObliterateSidedMsg;
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type IMergeTreeOp = IMergeTreeDeltaOp | IMergeTreeGroupMsg;

package/src/partialLengths.ts

@@ -5,12 +5,12 @@
 
 import { assert } from "@fluidframework/core-utils/internal";
 
-import { MergeTree } from "./mergeTree.js";
+import type { MergeTree } from "./mergeTree.js";
 import {
-	CollaborationWindow,
+	type CollaborationWindow,
 	getMinSeqStamp,
-	IMergeNode,
-	ISegmentPrivate,
+	type IMergeNode,
+	type ISegmentPrivate,
 	type MergeBlock,
 } from "./mergeTreeNodes.js";
 import {

package/src/properties.ts

@@ -5,8 +5,7 @@
 
 /**
  * Any mapping from a string to values of type `T`
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface MapLike<T> {
 	[index: string]: T;
@@ -20,8 +19,7 @@ export interface MapLike<T> {
  * @privateRemarks PropertySet is typed using `any` because when you include
  * custom methods such as toJSON(), JSON.stringify accepts most types other than
  * functions
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
 export type PropertySet = MapLike<any>;

package/src/referencePositions.ts

@@ -3,10 +3,10 @@
  * Licensed under the MIT License.
  */
 
-import { SlidingPreference } from "./localReference.js";
-import { ISegment } from "./mergeTreeNodes.js";
+import type { SlidingPreference } from "./localReference.js";
+import type { ISegment } from "./mergeTreeNodes.js";
 import { ReferenceType } from "./ops.js";
-import { PropertySet } from "./properties.js";
+import type { PropertySet } from "./properties.js";
 import { isMergeNodeInfo } from "./segmentInfos.js";
 
 /**
@@ -33,8 +33,7 @@ export function refTypeIncludesFlag(
 
 /**
  * Gets the tile labels stored in the given reference position.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export const refGetTileLabels = (refPos: ReferencePosition): string[] | undefined =>
 	refTypeIncludesFlag(refPos, ReferenceType.Tile) && refPos.properties
@@ -43,8 +42,7 @@ export const refGetTileLabels = (refPos: ReferencePosition): string[] | undefine
 
 /**
  * Determines if a reference position has the given tile label.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export function refHasTileLabel(refPos: ReferencePosition, label: string): boolean {
 	const tileLabels = refGetTileLabels(refPos);
@@ -63,8 +61,7 @@ export function refHasTileLabels(refPos: ReferencePosition): boolean {
  * Represents a reference to a place within a merge tree. This place conceptually remains stable over time
  * by referring to a particular segment and offset within that segment.
  * Thus, this reference's character position changes as the tree is edited.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface ReferencePosition {
 	/**

package/src/revertibles.ts

@@ -11,9 +11,9 @@ import {
 import { UsageError } from "@fluidframework/telemetry-utils/internal";
 
 import { EndOfTreeSegment } from "./endOfTreeSegment.js";
-import { LocalReferenceCollection, LocalReferencePosition } from "./localReference.js";
-import { MergeTree, findRootMergeBlock } from "./mergeTree.js";
-import { IMergeTreeDeltaCallbackArgs } from "./mergeTreeDeltaCallback.js";
+import { LocalReferenceCollection, type LocalReferencePosition } from "./localReference.js";
+import { type MergeTree, findRootMergeBlock } from "./mergeTree.js";
+import type { IMergeTreeDeltaCallbackArgs } from "./mergeTreeDeltaCallback.js";
 import { depthFirstNodeWalk } from "./mergeTreeNodeWalk.js";
 import {
 	assertSegmentLeaf,
@@ -22,15 +22,18 @@ import {
 	type ISegmentLeaf,
 	type ISegmentPrivate,
 } from "./mergeTreeNodes.js";
-import { ITrackingGroup, Trackable, UnorderedTrackingGroup } from "./mergeTreeTracking.js";
-import { IJSONSegment, MergeTreeDeltaType, ReferenceType } from "./ops.js";
-import { PropertySet, matchProperties } from "./properties.js";
+import {
+	type ITrackingGroup,
+	type Trackable,
+	UnorderedTrackingGroup,
+} from "./mergeTreeTracking.js";
+import { type IJSONSegment, MergeTreeDeltaType, ReferenceType } from "./ops.js";
+import { type PropertySet, matchProperties } from "./properties.js";
 import { DetachedReferencePosition } from "./referencePositions.js";
 import { toRemovalInfo } from "./segmentInfos.js";
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type MergeTreeDeltaRevertible =
 	| {
@@ -72,8 +75,7 @@ interface RemoveSegmentRefProperties {
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface MergeTreeRevertibleDriver {
 	insertFromSpec(pos: number, spec: IJSONSegment): void;
@@ -203,8 +205,7 @@ function appendLocalAnnotateToRevertibles(
 /**
  * Appends a merge tree delta to the list of revertibles.
  *
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export function appendToMergeTreeDeltaRevertibles(
 	deltaArgs: IMergeTreeDeltaCallbackArgs,
@@ -240,8 +241,7 @@ export function appendToMergeTreeDeltaRevertibles(
 /**
  * Removes all revertibles from the list of revertibles.
  *
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export function discardMergeTreeDeltaRevertible(
 	revertibles: MergeTreeDeltaRevertible[],
@@ -403,8 +403,7 @@ function getPosition(mergeTreeWithRevert: MergeTreeWithRevert, segment: ISegment
 /**
  * Reverts all operations in the list of revertibles.
  *
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export function revertMergeTreeDeltaRevertibles(
 	driver: MergeTreeRevertibleDriver,

package/src/segmentGroupCollection.ts

@@ -5,7 +5,7 @@
 
 import { DoublyLinkedList, walkList } from "@fluidframework/core-utils/internal";
 
-import { SegmentGroup, type ISegmentLeaf } from "./mergeTreeNodes.js";
+import type { SegmentGroup, ISegmentLeaf } from "./mergeTreeNodes.js";
 
 export class SegmentGroupCollection {
 	private readonly segmentGroups: DoublyLinkedList<SegmentGroup>;

package/src/segmentInfos.ts

@@ -7,8 +7,8 @@ import { assert, isObject } from "@fluidframework/core-utils/internal";
 
 import { UnassignedSequenceNumber } from "./constants.js";
 import {
-	ISegmentInternal,
-	ISegmentPrivate,
+	type ISegmentInternal,
+	type ISegmentPrivate,
 	MergeBlock,
 	type ObliterateInfo,
 } from "./mergeTreeNodes.js";

package/src/segmentPropertiesManager.ts

@@ -15,7 +15,7 @@ import type {
 	IMergeTreeAnnotateAdjustMsg,
 	IMergeTreeAnnotateMsg,
 } from "./ops.js";
-import { MapLike, PropertySet, clone, createMap } from "./properties.js";
+import { type MapLike, type PropertySet, clone, createMap } from "./properties.js";
 
 /**
  * Minimally copies properties and the property manager from source to destination.

package/src/sequencePlace.ts

@@ -26,8 +26,7 @@
  * If a SequencePlace is the endpoint of a range (e.g. start/end of an interval or search range),
  * the Side value means it is exclusive if it is nearer to the other position and inclusive if it is farther.
  * E.g. the start of a range with Side.After is exclusive of the character at the position.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export type SequencePlace = number | "start" | "end" | InteriorSequencePlace;
 
@@ -35,8 +34,7 @@ export type SequencePlace = number | "start" | "end" | InteriorSequencePlace;
  * A sequence place that does not refer to the special endpoint segments.
  *
  * See {@link SequencePlace} for additional context.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface InteriorSequencePlace {
 	pos: number;
@@ -47,8 +45,7 @@ export interface InteriorSequencePlace {
  * Defines a side relative to a character in a sequence.
  *
  * @remarks See {@link SequencePlace} for additional context on usage.
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export enum Side {
 	Before = 0,
@@ -58,8 +55,7 @@ export enum Side {
 /**
  * Returns the position and side of the start and end of a sequence.
  *
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export function endpointPosAndSide(
 	start: SequencePlace | undefined,

package/src/snapshotChunks.ts

@@ -5,13 +5,13 @@
 
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 
-import { IFluidHandle } from "@fluidframework/core-interfaces";
-import { IFluidSerializer } from "@fluidframework/shared-object-base/internal";
-import { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
+import type { IFluidHandle } from "@fluidframework/core-interfaces";
+import type { IFluidSerializer } from "@fluidframework/shared-object-base/internal";
+import type { ITelemetryLoggerExt } from "@fluidframework/telemetry-utils/internal";
 
-import { SerializedAttributionCollection } from "./attributionCollection.js";
-import { IJSONSegment } from "./ops.js";
-import { PropertySet } from "./properties.js";
+import type { SerializedAttributionCollection } from "./attributionCollection.js";
+import type { IJSONSegment } from "./ops.js";
+import type { PropertySet } from "./properties.js";
 import { SnapshotLegacy } from "./snapshotlegacy.js";
 
 export interface VersionedMergeTreeChunk {

package/src/snapshotLoader.ts

@@ -8,33 +8,33 @@
 import { bufferToString } from "@fluid-internal/client-utils";
 import { AttachState } from "@fluidframework/container-definitions";
 import { assert } from "@fluidframework/core-utils/internal";
-import {
+import type {
 	IFluidDataStoreRuntime,
 	IChannelStorageService,
 } from "@fluidframework/datastore-definitions/internal";
-import { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
-import { IFluidSerializer } from "@fluidframework/shared-object-base/internal";
+import type { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
+import type { IFluidSerializer } from "@fluidframework/shared-object-base/internal";
 import {
-	ITelemetryLoggerExt,
+	type ITelemetryLoggerExt,
 	UsageError,
 	createChildLogger,
 } from "@fluidframework/telemetry-utils/internal";
 
-import { Client } from "./client.js";
+import type { Client } from "./client.js";
 import { NonCollabClient, UniversalSequenceNumber } from "./constants.js";
-import { MergeTree } from "./mergeTree.js";
-import { ISegmentPrivate } from "./mergeTreeNodes.js";
-import { IJSONSegment } from "./ops.js";
+import type { MergeTree } from "./mergeTree.js";
+import type { ISegmentPrivate } from "./mergeTreeNodes.js";
+import type { IJSONSegment } from "./ops.js";
 import { PriorPerspective } from "./perspective.js";
 import {
-	IHasRemovalInfo,
+	type IHasRemovalInfo,
 	overwriteInfo,
 	type IHasInsertionInfo,
 	type SegmentWithInfo,
 } from "./segmentInfos.js";
 import {
-	IJSONSegmentWithMergeInfo,
-	MergeTreeChunkV1,
+	type IJSONSegmentWithMergeInfo,
+	type MergeTreeChunkV1,
 	hasMergeInfo,
 } from "./snapshotChunks.js";
 import { SnapshotV1 } from "./snapshotV1.js";

package/src/snapshotV1.ts

@@ -4,33 +4,33 @@
  */
 
 import { bufferToString } from "@fluid-internal/client-utils";
-import { IFluidHandle } from "@fluidframework/core-interfaces";
+import type { IFluidHandle } from "@fluidframework/core-interfaces";
 import { assert } from "@fluidframework/core-utils/internal";
-import { IChannelStorageService } from "@fluidframework/datastore-definitions/internal";
-import {
+import type { IChannelStorageService } from "@fluidframework/datastore-definitions/internal";
+import type {
 	ISummaryTreeWithStats,
 	AttributionKey,
 } from "@fluidframework/runtime-definitions/internal";
 import { SummaryTreeBuilder } from "@fluidframework/runtime-utils/internal";
-import { IFluidSerializer } from "@fluidframework/shared-object-base/internal";
+import type { IFluidSerializer } from "@fluidframework/shared-object-base/internal";
 import {
-	ITelemetryLoggerExt,
+	type ITelemetryLoggerExt,
 	createChildLogger,
 } from "@fluidframework/telemetry-utils/internal";
 
-import { IAttributionCollection } from "./attributionCollection.js";
+import type { IAttributionCollection } from "./attributionCollection.js";
 import { NonCollabClient } from "./constants.js";
-import { MergeTree } from "./mergeTree.js";
+import type { MergeTree } from "./mergeTree.js";
 import { walkAllChildSegments } from "./mergeTreeNodeWalk.js";
-import { ISegmentPrivate } from "./mergeTreeNodes.js";
+import type { ISegmentPrivate } from "./mergeTreeNodes.js";
 import type { IJSONSegment } from "./ops.js";
-import { PropertySet, matchProperties } from "./properties.js";
+import { type PropertySet, matchProperties } from "./properties.js";
 import { assertInserted, isRemoved } from "./segmentInfos.js";
 import {
-	IJSONSegmentWithMergeInfo,
-	JsonSegmentSpecs,
-	MergeTreeChunkV1,
-	MergeTreeHeaderMetadata,
+	type IJSONSegmentWithMergeInfo,
+	type JsonSegmentSpecs,
+	type MergeTreeChunkV1,
+	type MergeTreeHeaderMetadata,
 	serializeAsMaxSupportedVersion,
 	toLatestVersion,
 	type VersionedMergeTreeChunk,

package/src/snapshotlegacy.ts

@@ -5,25 +5,25 @@
 
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 
-import { IFluidHandle } from "@fluidframework/core-interfaces";
+import type { IFluidHandle } from "@fluidframework/core-interfaces";
 import { assert } from "@fluidframework/core-utils/internal";
-import { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
-import { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions/internal";
+import type { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
+import type { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions/internal";
 import { SummaryTreeBuilder } from "@fluidframework/runtime-utils/internal";
-import { IFluidSerializer } from "@fluidframework/shared-object-base/internal";
+import type { IFluidSerializer } from "@fluidframework/shared-object-base/internal";
 import {
-	ITelemetryLoggerExt,
+	type ITelemetryLoggerExt,
 	createChildLogger,
 } from "@fluidframework/telemetry-utils/internal";
 
 import { NonCollabClient } from "./constants.js";
-import { MergeTree } from "./mergeTree.js";
+import type { MergeTree } from "./mergeTree.js";
 import { isSegmentLeaf, type ISegmentPrivate } from "./mergeTreeNodes.js";
 import { PriorPerspective } from "./perspective.js";
 import { matchProperties } from "./properties.js";
 import {
-	JsonSegmentSpecs,
-	MergeTreeChunkLegacy,
+	type JsonSegmentSpecs,
+	type MergeTreeChunkLegacy,
 	serializeAsMinSupportedVersion,
 } from "./snapshotChunks.js";
 

package/src/sortedSegmentSet.ts

@@ -3,8 +3,8 @@
  * Licensed under the MIT License.
  */
 
-import { LocalReferencePosition } from "./localReference.js";
-import { ISegmentInternal } from "./mergeTreeNodes.js";
+import type { LocalReferencePosition } from "./localReference.js";
+import type { ISegmentInternal } from "./mergeTreeNodes.js";
 import { hasProp, toMergeNodeInfo } from "./segmentInfos.js";
 import { SortedSet } from "./sortedSet.js";
 

package/src/textSegment.ts

@@ -5,8 +5,8 @@
 
 import { assert } from "@fluidframework/core-utils/internal";
 
-import { BaseSegment, ISegment } from "./mergeTreeNodes.js";
-import { IJSONSegment } from "./ops.js";
+import { BaseSegment, type ISegment } from "./mergeTreeNodes.js";
+import type { IJSONSegment } from "./ops.js";
 import type { PropertySet } from "./properties.js";
 
 // Maximum length of text segment to be considered to be merged with other segment.
@@ -21,16 +21,14 @@ import type { PropertySet } from "./properties.js";
 export const TextSegmentGranularity = 256;
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export interface IJSONTextSegment extends IJSONSegment {
 	text: string;
 }
 
 /**
- * @legacy
- * @alpha
+ * @legacy @beta
  */
 export class TextSegment extends BaseSegment {
 	public static readonly type = "TextSegment";

package/src/zamboni.ts

@@ -6,14 +6,14 @@
 /* eslint-disable @typescript-eslint/no-non-null-assertion */
 
 import { UnassignedSequenceNumber } from "./constants.js";
-import { MergeTree } from "./mergeTree.js";
+import type { MergeTree } from "./mergeTree.js";
 import { MergeTreeMaintenanceType } from "./mergeTreeDeltaCallback.js";
 import {
 	type MergeBlock,
 	assignChild,
 	getMinSeqStamp,
-	IMergeNode,
-	ISegmentPrivate,
+	type IMergeNode,
+	type ISegmentPrivate,
 	Marker,
 	MaxNodesInBlock,
 } from "./mergeTreeNodes.js";