@fluidframework/sequence 2.0.0-internal.7.3.0 → 2.0.0-internal.7.4.0

package/lib/sequence-untrimmed.d.ts

@@ -59,74 +59,73 @@ import { TypedEventEmitter } from '@fluid-internal/client-utils';
 
 /**
  * Create revertibles for adding an interval
- * @alpha
+ * @internal
  */
 export declare function appendAddIntervalToRevertibles(interval: SequenceInterval, revertibles: SharedStringRevertible[]): SharedStringRevertible[];
 
 /**
  * Create revertibles for moving endpoints of an interval
- * @alpha
+ * @internal
  */
 export declare function appendChangeIntervalToRevertibles(string: SharedString, newInterval: SequenceInterval, previousInterval: SequenceInterval, revertibles: SharedStringRevertible[]): SharedStringRevertible[];
 
 /**
  * Create revertibles for deleting an interval
- * @alpha
+ * @internal
  */
 export declare function appendDeleteIntervalToRevertibles(string: SharedString, interval: SequenceInterval, revertibles: SharedStringRevertible[]): SharedStringRevertible[];
 
 /**
  * Create revertibles for changing properties of an interval
- * @alpha
+ * @internal
  */
 export declare function appendIntervalPropertyChangedToRevertibles(interval: SequenceInterval, deltas: PropertySet, revertibles: SharedStringRevertible[]): SharedStringRevertible[];
 
 /**
  * Create revertibles for SharedStringDeltas, handling indirectly modified intervals
  * (e.g. reverting remove of a range that contains an interval will move the interval back)
- *
- * @alpha
+ * @internal
  */
 export declare function appendSharedStringDeltaToRevertibles(string: SharedString, delta: SequenceDeltaEvent, revertibles: SharedStringRevertible[]): void;
 
 /**
- * @public
+ * @internal
  */
 export declare function createEndpointIndex(sharedString: SharedString): IEndpointIndex<SequenceInterval>;
 
 /**
- * @public
+ * @internal
  */
 export declare function createEndpointInRangeIndex(sharedString: SharedString): IEndpointInRangeIndex<SequenceInterval>;
 
 /**
- * @public
+ * @internal
  */
 export declare function createIdIntervalIndex<TInterval extends ISerializableInterval>(): IIdIntervalIndex<TInterval>;
 
 /**
- * @public
+ * @internal
  */
 export declare function createOverlappingIntervalsIndex(sharedString: SharedString): IOverlappingIntervalsIndex<SequenceInterval>;
 
 /**
- * @public
+ * @internal
  */
 export declare function createOverlappingSequenceIntervalsIndex(sharedString: SharedString): SequenceIntervalIndexes.Overlapping;
 
 /**
- * @public
+ * @internal
  */
 export declare function createStartpointInRangeIndex(sharedString: SharedString): IStartpointInRangeIndex<SequenceInterval>;
 
 /**
- * @public
+ * @alpha
  */
 export declare type DeserializeCallback = (properties: PropertySet) => void;
 
 /**
  * Clean up resources held by revertibles that are no longer needed.
- * @alpha
+ * @internal
  */
 export declare function discardSharedStringRevertibles(sharedString: SharedString, revertibles: SharedStringRevertible[]): void;
 
@@ -143,7 +142,7 @@ export declare function discardSharedStringRevertibles(sharedString: SharedStrin
  * // parallelMarkers === [<paragraph marker 1 object>, <paragraph marker 2 object>]
  * // Note parallelText does not include "missing".
  * ```
- * @public
+ * @internal
  */
 export declare function getTextAndMarkers(sharedString: SharedString, label: string, start?: number, end?: number): {
     parallelText: string[];
@@ -151,7 +150,7 @@ export declare function getTextAndMarkers(sharedString: SharedString, label: str
 };
 
 /**
- * @public
+ * @internal
  */
 export declare interface IEndpointIndex<TInterval extends ISerializableInterval> extends IntervalIndex<TInterval> {
     /**
@@ -170,7 +169,7 @@ export declare interface IEndpointIndex<TInterval extends ISerializableInterval>
  * Collection of intervals.
  *
  * Provide additional APIs to support efficiently querying a collection of intervals whose endpoints fall within a specified range.
- * @public
+ * @internal
  */
 export declare interface IEndpointInRangeIndex<TInterval extends ISerializableInterval> extends IntervalIndex<TInterval> {
     /**
@@ -180,7 +179,7 @@ export declare interface IEndpointInRangeIndex<TInterval extends ISerializableIn
 }
 
 /**
- * @public
+ * @internal
  */
 export declare interface IIdIntervalIndex<TInterval extends ISerializableInterval> extends IntervalIndex<TInterval>, Iterable<TInterval> {
     getIntervalById(id: string): TInterval | undefined;
@@ -189,7 +188,7 @@ export declare interface IIdIntervalIndex<TInterval extends ISerializableInterva
 
 /**
  * Basic interval abstraction
- * @public
+ * @alpha
  */
 export declare interface IInterval {
     /**
@@ -218,7 +217,6 @@ export declare interface IInterval {
     compareEnd(b: IInterval): number;
     /**
      * Modifies one or more of the endpoints of this interval, returning a new interval representing the result.
-     * @internal
      */
     modify(label: string, start: SequencePlace | undefined, end: SequencePlace | undefined, op?: ISequencedDocumentMessage, localSeq?: number, useNewSlidingBehavior?: boolean): IInterval | undefined;
     /**
@@ -230,7 +228,6 @@ export declare interface IInterval {
      * Unions this interval with `b`, returning a new interval.
      * The union operates as a convex hull, i.e. if the two intervals are disjoint, the return value includes
      * intermediate values between the two intervals.
-     * @internal
      */
     union(b: IInterval): IInterval;
 }
@@ -238,7 +235,7 @@ export declare interface IInterval {
 /**
  * Collection of intervals that supports addition, modification, removal, and efficient spatial querying.
  * Changes to this collection will be incur updates on collaborating clients (i.e. they are not local-only).
- * @public
+ * @alpha
  */
 export declare interface IIntervalCollection<TInterval extends ISerializableInterval> extends TypedEventEmitter<IIntervalCollectionEvent<TInterval>> {
     readonly attached: boolean;
@@ -360,6 +357,7 @@ export declare interface IIntervalCollection<TInterval extends ISerializableInte
     removeIntervalById(id: string): TInterval | undefined;
     /**
      * Changes the properties on an existing interval.
+     * @deprecated - call change with the id and and object containing the new properties
      * @param id - Id of the interval whose properties should be changed
      * @param props - Property set to apply to the interval. Shallow merging is used between any existing properties
      * and `prop`, i.e. the interval will end up with a property object equivalent to `{ ...oldProps, ...props }`.
@@ -367,12 +365,26 @@ export declare interface IIntervalCollection<TInterval extends ISerializableInte
     changeProperties(id: string, props: PropertySet): any;
     /**
      * Changes the endpoints of an existing interval.
+     * @deprecated - call change with the start and end parameters encapsulated in an object
      * @param id - Id of the interval to change
      * @param start - New start value. To leave the endpoint unchanged, pass the current value.
      * @param end - New end value. To leave the endpoint unchanged, pass the current value.
      * @returns the interval that was changed, if it existed in the collection.
      */
     change(id: string, start: SequencePlace, end: SequencePlace): TInterval | undefined;
+    /**
+     * Changes the endpoints, properties, or both of an existing interval.
+     * @param id - Id of the Interval to change
+     * @returns the interval that was changed, if it existed in the collection.
+     * Pass the desired new start position, end position, and/or properties in an object. Start and end positions must be changed
+     * simultaneously - they must either both be specified or both undefined. To only change the properties, leave both endpoints
+     * undefined. To only change the endpoints, leave the properties undefined.
+     */
+    change(id: string, { start, end, props }: {
+        start?: SequencePlace;
+        end?: SequencePlace;
+        props?: PropertySet;
+    }): TInterval | undefined;
     attachDeserializer(onDeserialize: DeserializeCallback): void;
     /**
      * @returns an iterator over all intervals in this collection.
@@ -404,6 +416,14 @@ export declare interface IIntervalCollection<TInterval extends ISerializableInte
      */
     gatherIterationResults(results: TInterval[], iteratesForward: boolean, start?: number, end?: number): void;
     /**
+     * @deprecated - Users must manually attach the corresponding interval index to utilize this functionality, for instance:
+     *
+     * ```typescript
+     * const overlappingIntervalsIndex = createOverlappingIntervalsIndex(sharedString);
+     * collection.attachIndex(overlappingIntervalsIndex)
+     * const result = overlappingIntervalsIndex.findOverlappingIntervals(start, end);
+     * ```
+     *
      * @returns an array of all intervals in this collection that overlap with the interval
      * `[startPosition, endPosition]`.
      */
@@ -412,13 +432,34 @@ export declare interface IIntervalCollection<TInterval extends ISerializableInte
      * Applies a function to each interval in this collection.
      */
     map(fn: (interval: TInterval) => void): void;
+    /**
+     * @deprecated - due to the forthcoming change where the endpointIndex will no longer be
+     * automatically added to the collection. Users are advised to independently attach the
+     * index to the collection and utilize the API accordingly, for instance:
+     * ```typescript
+     * const endpointIndex = createEndpointIndex(sharedString);
+     * collection.attachIndex(endpointIndex);
+     * const result1 = endpointIndex.previousInterval(pos);
+     * ```
+     * If an index is used repeatedly, applications should generally attach it once and store it in memory.
+     */
     previousInterval(pos: number): TInterval | undefined;
+    /**
+     * @deprecated - due to the forthcoming change where the endpointIndex will no longer be
+     * automatically added to the collection. Users are advised to independently attach the
+     * index to the collection and utilize the API accordingly, for instance:
+     * ```typescript
+     * const endpointIndex = createEndpointIndex(sharedString);
+     * collection.attachIndex(endpointIndex);
+     * const result2 = endpointIndex.nextInterval(pos);
+     * ```
+     */
     nextInterval(pos: number): TInterval | undefined;
 }
 
 /**
  * Change events emitted by `IntervalCollection`s
- * @public
+ * @alpha
  */
 export declare interface IIntervalCollectionEvent<TInterval extends ISerializableInterval> extends IEvent {
     /**
@@ -456,7 +497,7 @@ export declare interface IIntervalCollectionEvent<TInterval extends ISerializabl
 /**
  * @sealed
  * @deprecated The methods within have substitutions
- * @public
+ * @internal
  */
 export declare interface IIntervalHelpers<TInterval extends ISerializableInterval> {
     /**
@@ -479,7 +520,7 @@ export declare interface IIntervalHelpers<TInterval extends ISerializableInterva
 
 /**
  * @deprecated IJSONRunSegment will be removed in a upcoming release. It has been moved to the fluid-experimental/sequence-deprecated package
- * @public
+ * @internal
  */
 export declare interface IJSONRunSegment<T> extends IJSONSegment {
     items: Serializable<T>[];
@@ -496,7 +537,7 @@ export declare interface IMapMessageLocalMetadata {
  * A sequence place that does not refer to the special endpoint segments.
  *
  * See {@link SequencePlace} for additional context.
- * @public
+ * @alpha
  */
 export declare interface InteriorSequencePlace {
     pos: number;
@@ -505,7 +546,7 @@ export declare interface InteriorSequencePlace {
 
 /**
  * Serializable interval whose endpoints are plain-old numbers.
- * @public
+ * @internal
  */
 export declare class Interval implements ISerializableInterval {
     start: number;
@@ -514,11 +555,10 @@ export declare class Interval implements ISerializableInterval {
      * {@inheritDoc ISerializableInterval.properties}
      */
     properties: PropertySet;
-    /** @internal */
+    /***/
     auxProps: PropertySet[] | undefined;
     /**
      * {@inheritDoc ISerializableInterval.propertyManager}
-     * @internal
      */
     propertyManager: PropertiesManager;
     constructor(start: number, end: number, props?: PropertySet);
@@ -541,7 +581,6 @@ export declare class Interval implements ISerializableInterval {
     addPropertySet(props: PropertySet): void;
     /**
      * {@inheritDoc ISerializableInterval.serialize}
-     * @internal
      */
     serialize(): ISerializedInterval;
     /**
@@ -566,18 +605,15 @@ export declare class Interval implements ISerializableInterval {
     overlaps(b: Interval): boolean;
     /**
      * {@inheritDoc IInterval.union}
-     * @internal
      */
     union(b: Interval): Interval;
     getProperties(): PropertySet;
     /**
      * {@inheritDoc ISerializableInterval.addProperties}
-     * @internal
      */
     addProperties(newProps: PropertySet, collaborating?: boolean, seq?: number, op?: ICombiningOp): PropertySet | undefined;
     /**
      * {@inheritDoc IInterval.modify}
-     * @internal
      */
     modify(label: string, start?: SequencePlace, end?: SequencePlace, op?: ISequencedDocumentMessage): Interval | undefined;
     private initializeProperties;
@@ -591,7 +627,7 @@ export declare class Interval implements ISerializableInterval {
  * - "find all intervals with start endpoint between these two points"
  * - "find all intervals which overlap this range"
  * etc.
- * @public
+ * @alpha
  */
 export declare interface IntervalIndex<TInterval extends ISerializableInterval> {
     /**
@@ -610,7 +646,7 @@ export declare interface IntervalIndex<TInterval extends ISerializableInterval>
 
 /**
  * Information that identifies an interval within a `Sequence`.
- * @public
+ * @internal
  */
 export declare interface IntervalLocator {
     /**
@@ -628,13 +664,13 @@ export declare interface IntervalLocator {
  * @returns undefined if the reference position is not the endpoint of any interval (e.g. it was created
  * on the merge tree directly by app code), otherwise an {@link IntervalLocator} for the interval this
  * endpoint is a part of.
- * @public
+ * @internal
  */
 export declare function intervalLocatorFromEndpoint(potentialEndpoint: LocalReferencePosition): IntervalLocator | undefined;
 
 /**
  * Values are used in persisted formats (ops) and revertibles.
- * @alpha
+ * @internal
  */
 export declare const IntervalOpType: {
     readonly ADD: "add";
@@ -644,10 +680,14 @@ export declare const IntervalOpType: {
     readonly POSITION_REMOVE: "positionRemove";
 };
 
+/**
+ * @internal
+ */
+export declare type IntervalOpType = (typeof IntervalOpType)[keyof typeof IntervalOpType];
+
 /**
  * Data for undoing edits affecting Intervals.
- *
- * @alpha
+ * @internal
  */
 export declare type IntervalRevertible = {
     event: typeof IntervalOpType.CHANGE;
@@ -689,7 +729,7 @@ export declare type IntervalRevertible = {
  * Note that interval stickiness is currently an experimental feature and must
  * be explicitly enabled with the `intervalStickinessEnabled` flag
  *
- * @internal
+ * @alpha
  */
 export declare const IntervalStickiness: {
     /**
@@ -718,13 +758,12 @@ export declare const IntervalStickiness: {
  *
  * Note that interval stickiness is currently an experimental feature and must
  * be explicitly enabled with the `intervalStickinessEnabled` flag
- *
- * @internal
+ * @alpha
  */
 export declare type IntervalStickiness = (typeof IntervalStickiness)[keyof typeof IntervalStickiness];
 
 /**
- * @public
+ * @alpha
  */
 export declare enum IntervalType {
     Simple = 0,
@@ -747,7 +786,7 @@ export declare enum IntervalType {
 }
 
 /**
- * @public
+ * @internal
  */
 export declare interface IOverlappingIntervalsIndex<TInterval extends ISerializableInterval> extends IntervalIndex<TInterval> {
     /**
@@ -763,7 +802,7 @@ export declare interface IOverlappingIntervalsIndex<TInterval extends ISerializa
 
 /**
  * A range that has changed corresponding to a segment modification.
- * @public
+ * @alpha
  */
 export declare interface ISequenceDeltaRange<TOperation extends MergeTreeDeltaOperationTypes = MergeTreeDeltaOperationTypes> {
     /**
@@ -798,16 +837,16 @@ export declare interface ISequenceDeltaRange<TOperation extends MergeTreeDeltaOp
 }
 
 /**
- * @public
+ * @alpha
  */
 export declare interface ISerializableInterval extends IInterval {
     /** Serializable bag of properties associated with the interval. */
     properties: PropertySet;
-    /** @internal */
+    /***/
     propertyManager: PropertiesManager;
-    /** @internal */
+    /***/
     serialize(): ISerializedInterval;
-    /** @internal */
+    /***/
     addProperties(props: PropertySet, collaborating?: boolean, seq?: number): PropertySet | undefined;
     /**
      * Gets the id associated with this interval.
@@ -822,7 +861,7 @@ export declare interface ISerializableInterval extends IInterval {
 /**
  * Serialized object representation of an interval.
  * This representation is used for ops that create or change intervals.
- * @internal
+ * @alpha
  */
 export declare interface ISerializedInterval {
     /**
@@ -850,7 +889,7 @@ export declare interface ISerializedInterval {
 }
 
 /**
- * @public
+ * @alpha
  */
 export declare interface ISharedIntervalCollection<TInterval extends ISerializableInterval> {
     getIntervalCollection(label: string): IIntervalCollection<TInterval>;
@@ -888,7 +927,7 @@ export declare interface ISharedIntervalCollection<TInterval extends ISerializab
  * - `event` - Various information on the segments that were modified.
  *
  * - `target` - The sequence itself.
- * @public
+ * @alpha
  */
 export declare interface ISharedSegmentSequenceEvents extends ISharedObjectEvents {
     (event: "createIntervalCollection", listener: (label: string, local: boolean, target: IEventThisPlaceHolder) => void): any;
@@ -898,7 +937,7 @@ export declare interface ISharedSegmentSequenceEvents extends ISharedObjectEvent
 
 /**
  * Fluid object interface describing access methods on a SharedString
- * @public
+ * @alpha
  */
 export declare interface ISharedString extends SharedSegmentSequence<SharedStringSegment> {
     /**
@@ -925,7 +964,7 @@ export declare interface ISharedString extends SharedSegmentSequence<SharedStrin
  * Collection of intervals.
  *
  * Provide additional APIs to support efficiently querying a collection of intervals whose startpoints fall within a specified range.
- * @public
+ * @internal
  */
 export declare interface IStartpointInRangeIndex<TInterval extends ISerializableInterval> extends IntervalIndex<TInterval> {
     /**
@@ -937,23 +976,22 @@ export declare interface IStartpointInRangeIndex<TInterval extends ISerializable
 /**
  * Value types are given an IValueOpEmitter to emit their ops through the container type that holds them.
  * @internal
+ * @deprecated - will be remove from public api as there is no public used of this type
  */
 export declare interface IValueOpEmitter {
     /**
      * Called by the value type to emit a value type operation through the container type holding it.
      * @param opName - Name of the emitted operation
-     * @param previousValue - JSONable previous value as defined by the value type
+     * @param previousValue - JSONable previous value as defined by the value type @deprecated unused
      * @param params - JSONable params for the operation as defined by the value type
      * @param localOpMetadata - JSONable local metadata which should be submitted with the op
-     * @internal
      */
-    emit(opName: string, previousValue: any, params: any, localOpMetadata: IMapMessageLocalMetadata): void;
+    emit(opName: IntervalOpType, previousValue: undefined, params: SerializedIntervalDelta, localOpMetadata: IMapMessageLocalMetadata): void;
 }
 
 /**
  * Invoke revertibles to reverse prior edits
- *
- * @alpha
+ * @internal
  */
 export declare function revertSharedStringRevertibles(sharedString: SharedString, revertibles: SharedStringRevertible[]): void;
 
@@ -967,7 +1005,7 @@ export declare function revertSharedStringRevertibles(sharedString: SharedString
  * For group ops, each op will get its own event, and the group op property will be set on the op args.
  *
  * Ops may get multiple events. For instance, an insert-replace will get a remove then an insert event.
- * @public
+ * @alpha
  */
 export declare class SequenceDeltaEvent extends SequenceEvent<MergeTreeDeltaOperationType> {
     readonly opArgs: IMergeTreeDeltaOpArgs;
@@ -984,7 +1022,7 @@ export declare class SequenceDeltaEvent extends SequenceEvent<MergeTreeDeltaOper
  * The properties of this object and its sub-objects represent the state of the sequence at the
  * point in time at which the operation was applied.
  * They will not take into any future modifications performed to the underlying sequence and merge tree.
- * @public
+ * @alpha
  */
 export declare abstract class SequenceEvent<TOperation extends MergeTreeDeltaOperationTypes = MergeTreeDeltaOperationTypes> {
     readonly deltaArgs: IMergeTreeDeltaCallbackArgs<TOperation>;
@@ -1039,7 +1077,7 @@ export declare abstract class SequenceEvent<TOperation extends MergeTreeDeltaOpe
  * `mergeTreeReferencesCanSlideToEndpoint` feature flag set to true, the endpoints
  * of the interval that are exclusive will have the ability to slide to these
  * special endpoint segments.
- * @public
+ * @alpha
  */
 export declare class SequenceInterval implements ISerializableInterval {
     private readonly client;
@@ -1062,12 +1100,9 @@ export declare class SequenceInterval implements ISerializableInterval {
     properties: PropertySet;
     /**
      * {@inheritDoc ISerializableInterval.propertyManager}
-     * @internal
      */
     propertyManager: PropertiesManager;
-    /**
-     * @internal
-     */
+    /***/
     get stickiness(): IntervalStickiness;
     constructor(client: Client, 
     /**
@@ -1083,17 +1118,14 @@ export declare class SequenceInterval implements ISerializableInterval {
     private callbacks?;
     /**
      * Subscribes to position change events on this interval if there are no current listeners.
-     * @internal
      */
     addPositionChangeListeners(beforePositionChange: () => void, afterPositionChange: () => void): void;
     /**
      * Removes the currently subscribed position change listeners.
-     * @internal
      */
     removePositionChangeListeners(): void;
     /**
      * {@inheritDoc ISerializableInterval.serialize}
-     * @internal
      */
     serialize(): ISerializedInterval;
     /**
@@ -1122,12 +1154,10 @@ export declare class SequenceInterval implements ISerializableInterval {
     getIntervalId(): string;
     /**
      * {@inheritDoc IInterval.union}
-     * @internal
      */
     union(b: SequenceInterval): SequenceInterval;
     /**
      * {@inheritDoc ISerializableInterval.addProperties}
-     * @internal
      */
     addProperties(newProps: PropertySet, collab?: boolean, seq?: number, op?: ICombiningOp): PropertySet | undefined;
     /**
@@ -1136,7 +1166,6 @@ export declare class SequenceInterval implements ISerializableInterval {
     overlapsPos(bstart: number, bend: number): boolean;
     /**
      * {@inheritDoc IInterval.modify}
-     * @internal
      */
     modify(label: string, start: SequencePlace | undefined, end: SequencePlace | undefined, op?: ISequencedDocumentMessage, localSeq?: number, useNewSlidingBehavior?: boolean): SequenceInterval;
     private initializeProperties;
@@ -1144,20 +1173,21 @@ export declare class SequenceInterval implements ISerializableInterval {
 
 /**
  * @deprecated The methods within have substitutions
- * @public
+ * @internal
  */
 export declare const sequenceIntervalHelpers: IIntervalHelpers<SequenceInterval>;
 
 /**
  * This namespace contains specialiazations of indexes which support spatial queries
  * specifically for `SequenceInterval`s.
- * @public
+ * @internal
  */
 export declare namespace SequenceIntervalIndexes {
     /**
      * Collection of intervals.
      *
      * Provides additional APIs to support efficiently querying a collection of intervals based on segments and offset.
+     * @internal
      */
     export interface Overlapping extends IOverlappingIntervalsIndex<SequenceInterval> {
         /**
@@ -1181,7 +1211,7 @@ export declare namespace SequenceIntervalIndexes {
  * The properties of this object and its sub-objects represent the state of the sequence at the
  * point in time at which the operation was applied.
  * They will not take into consideration any future modifications performed to the underlying sequence and merge tree.
- * @public
+ * @alpha
  */
 export declare class SequenceMaintenanceEvent extends SequenceEvent<MergeTreeMaintenanceType> {
     readonly opArgs: IMergeTreeDeltaOpArgs | undefined;
@@ -1190,7 +1220,7 @@ export declare class SequenceMaintenanceEvent extends SequenceEvent<MergeTreeMai
 
 /**
  * Optional flags that configure options for sequence DDSs
- * @public
+ * @internal
  */
 export declare interface SequenceOptions {
     /**
@@ -1243,7 +1273,7 @@ export declare interface SequenceOptions {
  * 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.
- * @public
+ * @alpha
  */
 export declare type SequencePlace = number | "start" | "end" | InteriorSequencePlace;
 
@@ -1256,7 +1286,7 @@ export declare type SerializedIntervalDelta = Omit<ISerializedInterval, "start"
 
 /**
  * @deprecated `SharedIntervalCollection` is not maintained and is planned to be removed.
- * @public
+ * @internal
  */
 export declare class SharedIntervalCollection extends SharedObject implements ISharedIntervalCollection<Interval> {
     /**
@@ -1300,7 +1330,7 @@ export declare class SharedIntervalCollection extends SharedObject implements IS
 /**
  * The factory that defines the SharedIntervalCollection.
  * @deprecated `SharedIntervalCollection` is not maintained and is planned to be removed.
- * @public
+ * @internal
  */
 export declare class SharedIntervalCollectionFactory implements IChannelFactory {
     static readonly Type = "https://graph.microsoft.com/types/sharedIntervalCollection";
@@ -1315,7 +1345,7 @@ export declare class SharedIntervalCollectionFactory implements IChannelFactory
 }
 
 /**
- * @public
+ * @alpha
  */
 export declare abstract class SharedSegmentSequence<T extends ISegment> extends SharedObject<ISharedSegmentSequenceEvents> implements ISharedIntervalCollection<SequenceInterval>, MergeTreeRevertibleDriver {
     private readonly dataStoreRuntime;
@@ -1333,7 +1363,6 @@ export declare abstract class SharedSegmentSequence<T extends ISegment> extends
      *
      * An application using SharedString which explicitly wants to opt in to allowing reentrancy anyway can set `sharedStringPreventReentrancy`
      * on the data store options to `false`.
-     * @internal
      */
     protected guardReentrancy: <TRet>(callback: () => TRet) => TRet;
     private static createOpsFromDelta;
@@ -1544,7 +1573,7 @@ export declare abstract class SharedSegmentSequence<T extends ISegment> extends
 
 /**
  * @deprecated SharedSequence will be removed in a upcoming release. It has been moved to the fluid-experimental/sequence-deprecated package
- * @public
+ * @internal
  */
 export declare class SharedSequence<T> extends SharedSegmentSequence<SubSequence<T>> {
     id: string;
@@ -1581,8 +1610,7 @@ export declare class SharedSequence<T> extends SharedSegmentSequence<SubSequence
  * In addition to text, a Shared String can also contain markers. Markers can be
  * used to store metadata at positions within the text, like the details of an
  * image or Fluid object that should be rendered with the text.
- *
- * @public
+ * @alpha
  */
 export declare class SharedString extends SharedSegmentSequence<SharedStringSegment> implements ISharedString {
     id: string;
@@ -1643,6 +1671,10 @@ export declare class SharedString extends SharedSegmentSequence<SharedStringSegm
      * @param marker - The marker to annotate
      * @param props - The properties to annotate the marker with
      * @param consensusCallback - The callback called when consensus is reached
+     *
+     * @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.
      */
     annotateMarkerNotifyConsensus(marker: Marker, props: PropertySet, callback: (m: Marker) => void): void;
     /**
@@ -1698,7 +1730,7 @@ export declare class SharedString extends SharedSegmentSequence<SharedStringSegm
 }
 
 /**
- * @public
+ * @alpha
  */
 export declare class SharedStringFactory implements IChannelFactory {
     static Type: string;
@@ -1715,13 +1747,12 @@ export declare class SharedStringFactory implements IChannelFactory {
 
 /**
  * Data for undoing edits on SharedStrings and Intervals.
- *
- * @alpha
+ * @internal
  */
 export declare type SharedStringRevertible = MergeTreeDeltaRevertible | IntervalRevertible;
 
 /**
- * @public
+ * @alpha
  */
 export declare type SharedStringSegment = TextSegment | Marker;
 
@@ -1729,7 +1760,7 @@ export declare type SharedStringSegment = TextSegment | Marker;
  * Defines a side relative to a character in a sequence.
  *
  * @remarks See {@link SequencePlace} for additional context on usage.
- * @public
+ * @alpha
  */
 export declare enum Side {
     Before = 0,
@@ -1738,7 +1769,7 @@ export declare enum Side {
 
 /**
  * @deprecated SubSequence will be removed in a upcoming release. It has been moved to the fluid-experimental/sequence-deprecated package
- * @public
+ * @internal
  */
 export declare class SubSequence<T> extends BaseSegment {
     items: Serializable<T>[];