@fluidframework/sequence 2.23.0 → 2.31.0

package/src/intervals/sequenceInterval.ts

@@ -4,7 +4,6 @@
  */
 
 /* eslint-disable no-bitwise */
-/* eslint-disable import/no-deprecated */
 
 import { assert } from "@fluidframework/core-utils/internal";
 import { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
@@ -46,7 +45,6 @@ import {
 	IntervalType,
 	endReferenceSlidingPreference,
 	startReferenceSlidingPreference,
-	type IIntervalHelpers,
 } from "./intervalUtils.js";
 
 function compareSides(sideA: Side, sideB: Side): number {
@@ -292,7 +290,7 @@ export class SequenceIntervalClass implements SequenceInterval {
 	/**
 	 * {@inheritDoc IInterval.clone}
 	 */
-	public clone(): SequenceInterval {
+	public clone(): SequenceIntervalClass {
 		return new SequenceIntervalClass(
 			this.client,
 			this.start,
@@ -605,7 +603,7 @@ export function createSequenceInterval(
 	op?: ISequencedDocumentMessage,
 	fromSnapshot?: boolean,
 	useNewSlidingBehavior: boolean = false,
-): SequenceInterval {
+): SequenceIntervalClass {
 	const { startPos, startSide, endPos, endSide } = endpointPosAndSide(
 		start ?? "start",
 		end ?? "end",
@@ -677,11 +675,3 @@ export function createSequenceInterval(
 	);
 	return ival;
 }
-
-/**
- * @deprecated The methods within have substitutions
- * @internal
- */
-export const sequenceIntervalHelpers: IIntervalHelpers<SequenceInterval> = {
-	create: createSequenceInterval,
-};

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/sequence";
-export const pkgVersion = "2.23.0";
+export const pkgVersion = "2.31.0";

package/src/sequence.ts

@@ -69,24 +69,18 @@ import {
 } from "@fluidframework/telemetry-utils/internal";
 import Deque from "double-ended-queue";
 
-import {
-	IIntervalCollection,
-	SequenceIntervalCollectionValueType,
-} from "./intervalCollection.js";
+import { type ISequenceIntervalCollection } from "./intervalCollection.js";
 import { IMapOperation, IntervalCollectionMap } from "./intervalCollectionMap.js";
 import {
 	IMapMessageLocalMetadata,
-	IValueChanged,
 	type SequenceOptions,
 } from "./intervalCollectionMapInterfaces.js";
-import { SequenceInterval } from "./intervals/index.js";
 import {
 	SequenceDeltaEvent,
 	SequenceDeltaEventClass,
 	SequenceMaintenanceEvent,
 	SequenceMaintenanceEventClass,
 } from "./sequenceDeltaEvent.js";
-import { ISharedIntervalCollection } from "./sharedIntervalCollection.js";
 
 const snapshotFileName = "header";
 const contentPath = "content";
@@ -147,7 +141,6 @@ export interface ISharedSegmentSequenceEvents extends ISharedObjectEvents {
  */
 export interface ISharedSegmentSequence<T extends ISegment>
 	extends ISharedObject<ISharedSegmentSequenceEvents>,
-		ISharedIntervalCollection<SequenceInterval>,
 		MergeTreeRevertibleDriver {
 	/**
 	 * Creates a `LocalReferencePosition` on this SharedString. If the refType does not include
@@ -254,7 +247,7 @@ export interface ISharedSegmentSequence<T extends ISegment>
 	 * Retrieves the interval collection keyed on `label`. If no such interval collection exists,
 	 * creates one.
 	 */
-	getIntervalCollection(label: string): IIntervalCollection<SequenceInterval>;
+	getIntervalCollection(label: string): ISequenceIntervalCollection;
 
 	/**
 	 * Obliterate is similar to remove, but differs in that segments concurrently
@@ -494,7 +487,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 
 	protected client: Client;
 	private messagesSinceMSNChange: ISequencedDocumentMessage[] = [];
-	private readonly intervalCollections: IntervalCollectionMap<SequenceInterval>;
+	private readonly intervalCollections: IntervalCollectionMap;
 	constructor(
 		dataStoreRuntime: IFluidDataStoreRuntime,
 		public id: string,
@@ -542,7 +535,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 
 		this.client.prependListener("delta", (opArgs, deltaArgs) => {
 			const event = new SequenceDeltaEventClass(opArgs, deltaArgs, this.client);
-			if (event.isLocal) {
+			if (event.isLocal && event.opArgs.rollback !== true) {
 				this.submitSequenceMessage(opArgs.op);
 			}
 			if (deltaArgs.deltaSegments.length > 0) {
@@ -569,7 +562,6 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 				this.inFlightRefSeqs.push(this.currentRefSeq);
 				this.submitLocalMessage(op, localOpMetadata);
 			},
-			new SequenceIntervalCollectionValueType(),
 			options,
 		);
 	}
@@ -705,7 +697,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 		this.guardReentrancy(() => this.client.insertSegmentLocal(pos, segment));
 	}
 
-	public getIntervalCollection(label: string): IIntervalCollection<SequenceInterval> {
+	public getIntervalCollection(label: string): ISequenceIntervalCollection {
 		return this.intervalCollections.get(label);
 	}
 
@@ -999,17 +991,13 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 
 	private initializeIntervalCollections() {
 		// Listen and initialize new SharedIntervalCollections
-		this.intervalCollections.eventEmitter.on(
-			"create",
-			({ key, previousValue }: IValueChanged, local: boolean) => {
+		this.intervalCollections.events.on(
+			"createIntervalCollection",
+			(key: string, local: boolean) => {
 				const intervalCollection = this.intervalCollections.get(key);
 				if (!intervalCollection.attached) {
 					intervalCollection.attachGraph(this.client, key);
 				}
-				assert(
-					previousValue === undefined,
-					0x2c1 /* "Creating an interval collection that already exists?" */,
-				);
 				this.emit("createIntervalCollection", key, local, this);
 			},
 		);

package/src/sharedIntervalCollection.ts

@@ -3,194 +3,16 @@
  * Licensed under the MIT License.
  */
 
-import { bufferToString } from "@fluid-internal/client-utils";
-import { assert } from "@fluidframework/core-utils/internal";
-import {
-	IChannelAttributes,
-	IChannelFactory,
-	IFluidDataStoreRuntime,
-	IChannelServices,
-	IChannelStorageService,
-} from "@fluidframework/datastore-definitions/internal";
-import {
-	MessageType,
-	ISequencedDocumentMessage,
-} from "@fluidframework/driver-definitions/internal";
-import { ISummaryTreeWithStats } from "@fluidframework/runtime-definitions/internal";
-import {
-	IFluidSerializer,
-	SharedObject,
-	createSingleBlobSummary,
-} from "@fluidframework/shared-object-base/internal";
-
-import { IIntervalCollection, IntervalCollectionValueType } from "./intervalCollection.js";
-import { IMapOperation, IntervalCollectionMap } from "./intervalCollectionMap.js";
-import { IMapMessageLocalMetadata } from "./intervalCollectionMapInterfaces.js";
-import { ISerializableInterval, Interval } from "./intervals/index.js";
-import { pkgVersion } from "./packageVersion.js";
-
-const snapshotFileName = "header";
-
-/**
- * The factory that defines the SharedIntervalCollection.
- * @deprecated `SharedIntervalCollection` is not maintained and is planned to be removed.
- * @internal
- */
-export class SharedIntervalCollectionFactory implements IChannelFactory {
-	public static readonly Type = "https://graph.microsoft.com/types/sharedIntervalCollection";
-
-	public static readonly Attributes: IChannelAttributes = {
-		type: SharedIntervalCollectionFactory.Type,
-		snapshotFormatVersion: "0.1",
-		packageVersion: pkgVersion,
-	};
-
-	public get type() {
-		return SharedIntervalCollectionFactory.Type;
-	}
-
-	public get attributes() {
-		return SharedIntervalCollectionFactory.Attributes;
-	}
-
-	/**
-	 * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.load}
-	 */
-	public async load(
-		runtime: IFluidDataStoreRuntime,
-		id: string,
-		services: IChannelServices,
-		attributes: IChannelAttributes,
-	): Promise<SharedIntervalCollection> {
-		const map = new SharedIntervalCollection(id, runtime, attributes);
-		await map.load(services);
-
-		return map;
-	}
-
-	public create(runtime: IFluidDataStoreRuntime, id: string): SharedIntervalCollection {
-		const map = new SharedIntervalCollection(id, runtime, this.attributes);
-		map.initializeLocal();
-
-		return map;
-	}
-}
+// eslint-disable-next-line import/no-deprecated
+import { IIntervalCollection } from "./intervalCollection.js";
+import { ISerializableInterval } from "./intervals/index.js";
 
 /**
  * @legacy
  * @alpha
+ * @remarks This interface is no longer used and will be removed.
  */
 export interface ISharedIntervalCollection<TInterval extends ISerializableInterval> {
+	// eslint-disable-next-line import/no-deprecated
 	getIntervalCollection(label: string): IIntervalCollection<TInterval>;
 }
-
-/**
- * @deprecated `SharedIntervalCollection` is not maintained and is planned to be removed.
- * @internal
- */
-export class SharedIntervalCollection
-	extends SharedObject
-	implements ISharedIntervalCollection<Interval>
-{
-	/**
-	 * Create a SharedIntervalCollection
-	 *
-	 * @param runtime - data store runtime the new shared map belongs to
-	 * @param id - optional name of the shared map
-	 * @returns newly create shared map (but not attached yet)
-	 */
-	public static create(runtime: IFluidDataStoreRuntime, id?: string) {
-		return runtime.createChannel(
-			id,
-			SharedIntervalCollectionFactory.Type,
-		) as SharedIntervalCollection;
-	}
-
-	/**
-	 * Get a factory for SharedIntervalCollection to register with the data store.
-	 *
-	 * @returns a factory that creates and load SharedIntervalCollection
-	 */
-	public static getFactory(): IChannelFactory {
-		return new SharedIntervalCollectionFactory();
-	}
-
-	public readonly [Symbol.toStringTag]: string = "SharedIntervalCollection";
-	private readonly intervalCollections: IntervalCollectionMap<Interval>;
-
-	/**
-	 * Constructs a new shared SharedIntervalCollection. If the object is non-local an id and service interfaces will
-	 * be provided
-	 */
-	constructor(id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes) {
-		super(id, runtime, attributes, "fluid_sharedIntervalCollection_");
-		this.intervalCollections = new IntervalCollectionMap(
-			this.serializer,
-			this.handle,
-			(op, localOpMetadata) => this.submitLocalMessage(op, localOpMetadata),
-			new IntervalCollectionValueType(),
-			runtime.options,
-		);
-	}
-
-	public getIntervalCollection(label: string): IIntervalCollection<Interval> {
-		const realLabel = this.getIntervalCollectionPath(label);
-		const sharedCollection = this.intervalCollections.get(realLabel);
-		return sharedCollection;
-	}
-
-	protected summarizeCore(serializer: IFluidSerializer): ISummaryTreeWithStats {
-		return createSingleBlobSummary(
-			snapshotFileName,
-			this.intervalCollections.serialize(serializer),
-		);
-	}
-
-	protected reSubmitCore(content: any, localOpMetadata: unknown) {
-		this.intervalCollections.tryResubmitMessage(
-			content,
-			localOpMetadata as IMapMessageLocalMetadata,
-		);
-	}
-
-	protected onDisconnect() {}
-
-	/**
-	 * {@inheritDoc @fluidframework/shared-object-base#SharedObject.loadCore}
-	 */
-	protected async loadCore(storage: IChannelStorageService) {
-		const blob = await storage.readBlob(snapshotFileName);
-		const header = bufferToString(blob, "utf8");
-		this.intervalCollections.populate(header);
-	}
-
-	protected processCore(
-		message: ISequencedDocumentMessage,
-		local: boolean,
-		localOpMetadata: unknown,
-	) {
-		if (message.type === MessageType.Operation) {
-			assert(
-				this.intervalCollections.tryProcessMessage(
-					message.contents as IMapOperation,
-					local,
-					message,
-					localOpMetadata,
-				),
-				0xab3 /* SharedIntervalCollection received an unrecognized op, possibly from a newer version */,
-			);
-		}
-	}
-
-	/**
-	 * Creates the full path of the intervalCollection label
-	 * @param label - the incoming label
-	 */
-	protected getIntervalCollectionPath(label: string): string {
-		return label;
-	}
-
-	protected applyStashedOp() {
-		throw new Error("not implemented");
-	}
-}

package/src/sharedString.ts

@@ -245,42 +245,24 @@ export class SharedStringClass
 	 * {@inheritDoc ISharedString.getText}
 	 */
 	public getText(start?: number, end?: number) {
-		const segmentWindow = this.client.getCollabWindow();
-		return this.mergeTreeTextHelper.getText(
-			segmentWindow.currentSeq,
-			segmentWindow.clientId,
-			"",
-			start,
-			end,
-		);
+		const collabWindow = this.client.getCollabWindow();
+		return this.mergeTreeTextHelper.getText(collabWindow.localPerspective, "", start, end);
 	}
 
 	/**
 	 * {@inheritDoc ISharedString.getTextWithPlaceholders}
 	 */
 	public getTextWithPlaceholders(start?: number, end?: number) {
-		const segmentWindow = this.client.getCollabWindow();
-		return this.mergeTreeTextHelper.getText(
-			segmentWindow.currentSeq,
-			segmentWindow.clientId,
-			" ",
-			start,
-			end,
-		);
+		const collabWindow = this.client.getCollabWindow();
+		return this.mergeTreeTextHelper.getText(collabWindow.localPerspective, " ", start, end);
 	}
 
 	/**
 	 * {@inheritDoc ISharedString.getTextRangeWithMarkers}
 	 */
 	public getTextRangeWithMarkers(start: number, end: number) {
-		const segmentWindow = this.client.getCollabWindow();
-		return this.mergeTreeTextHelper.getText(
-			segmentWindow.currentSeq,
-			segmentWindow.clientId,
-			"*",
-			start,
-			end,
-		);
+		const collabWindow = this.client.getCollabWindow();
+		return this.mergeTreeTextHelper.getText(collabWindow.localPerspective, "*", start, end);
 	}
 
 	/**

package/dist/intervals/interval.d.ts

@@ -1,76 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
-import { PropertiesManager, PropertySet, SequencePlace } from "@fluidframework/merge-tree/internal";
-import { IIntervalHelpers, ISerializableInterval, ISerializedInterval } from "./intervalUtils.js";
-/**
- * Serializable interval whose endpoints are plain-old numbers.
- * @internal
- */
-export declare class Interval implements ISerializableInterval {
-    start: number;
-    end: number;
-    /**
-     * {@inheritDoc ISerializableInterval.properties}
-     */
-    properties: PropertySet;
-    /***/
-    auxProps: PropertySet[] | undefined;
-    propertyManager?: PropertiesManager;
-    constructor(start: number, end: number, props?: PropertySet);
-    /**
-     * {@inheritDoc ISerializableInterval.getIntervalId}
-     */
-    getIntervalId(): string;
-    /**
-     * @returns an array containing any auxiliary property sets added with `addPropertySet`.
-     */
-    getAdditionalPropertySets(): PropertySet[];
-    /**
-     * Adds an auxiliary set of properties to this interval.
-     * These properties can be recovered using `getAdditionalPropertySets`
-     * @param props - set of properties to add
-     * @remarks This gets called as part of the default conflict resolver for `IIntervalCollection<Interval>`
-     * (i.e. non-sequence-based interval collections). However, the additional properties don't get serialized.
-     * This functionality seems half-baked.
-     */
-    addPropertySet(props: PropertySet): void;
-    /**
-     * {@inheritDoc ISerializableInterval.serialize}
-     */
-    serialize(): ISerializedInterval;
-    /**
-     * {@inheritDoc IInterval.clone}
-     */
-    clone(): Interval;
-    /**
-     * {@inheritDoc IInterval.compare}
-     */
-    compare(b: Interval): number;
-    /**
-     * {@inheritDoc IInterval.compareStart}
-     */
-    compareStart(b: Interval): number;
-    /**
-     * {@inheritDoc IInterval.compareEnd}
-     */
-    compareEnd(b: Interval): number;
-    /**
-     * {@inheritDoc IInterval.overlaps}
-     */
-    overlaps(b: Interval): boolean;
-    /**
-     * {@inheritDoc IInterval.union}
-     */
-    union(b: Interval): Interval;
-    getProperties(): PropertySet;
-    /**
-     * {@inheritDoc IInterval.modify}
-     */
-    modify(label: string, start?: SequencePlace, end?: SequencePlace, op?: ISequencedDocumentMessage): Interval | undefined;
-}
-export declare function createInterval(label: string, start: SequencePlace, end: SequencePlace): Interval;
-export declare const intervalHelpers: IIntervalHelpers<Interval>;
-//# sourceMappingURL=interval.d.ts.map

package/dist/intervals/interval.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"interval.d.ts","sourceRoot":"","sources":["../../src/intervals/interval.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EAAE,yBAAyB,EAAE,MAAM,6CAA6C,CAAC;AACxF,OAAO,EACN,iBAAiB,EACjB,WAAW,EAGX,aAAa,EAGb,MAAM,qCAAqC,CAAC;AAK7C,OAAO,EACN,gBAAgB,EAChB,qBAAqB,EACrB,mBAAmB,EACnB,MAAM,oBAAoB,CAAC;AAE5B;;;GAGG;AACH,qBAAa,QAAS,YAAW,qBAAqB;IAY7C,KAAK,EAAE,MAAM;IACb,GAAG,EAAE,MAAM;IAZnB;;OAEG;IACI,UAAU,EAAE,WAAW,CAAoB;IAElD,KAAK;IACE,QAAQ,EAAE,WAAW,EAAE,GAAG,SAAS,CAAC;IAEpC,eAAe,CAAC,EAAE,iBAAiB,CAAC;gBAGnC,KAAK,EAAE,MAAM,EACb,GAAG,EAAE,MAAM,EAClB,KAAK,CAAC,EAAE,WAAW;IAOpB;;OAEG;IACI,aAAa,IAAI,MAAM;IAM9B;;OAEG;IACI,yBAAyB,IAAI,WAAW,EAAE;IAIjD;;;;;;;OAOG;IACI,cAAc,CAAC,KAAK,EAAE,WAAW;IAOxC;;OAEG;IACI,SAAS,IAAI,mBAAmB;IAgBvC;;OAEG;IACI,KAAK;IAIZ;;OAEG;IACI,OAAO,CAAC,CAAC,EAAE,QAAQ;IAsB1B;;OAEG;IACI,YAAY,CAAC,CAAC,EAAE,QAAQ;IAI/B;;OAEG;IACI,UAAU,CAAC,CAAC,EAAE,QAAQ;IAI7B;;OAEG;IACI,QAAQ,CAAC,CAAC,EAAE,QAAQ;IAK3B;;OAEG;IACI,KAAK,CAAC,CAAC,EAAE,QAAQ;IAQjB,aAAa;IAIpB;;OAEG;IACI,MAAM,CACZ,KAAK,EAAE,MAAM,EACb,KAAK,CAAC,EAAE,aAAa,EACrB,GAAG,CAAC,EAAE,aAAa,EACnB,EAAE,CAAC,EAAE,yBAAyB;CAmB/B;AAED,wBAAgB,cAAc,CAC7B,KAAK,EAAE,MAAM,EACb,KAAK,EAAE,aAAa,EACpB,GAAG,EAAE,aAAa,GAChB,QAAQ,CAiBV;AAED,eAAO,MAAM,eAAe,EAAE,gBAAgB,CAAC,QAAQ,CAEtD,CAAC"}

package/dist/intervals/interval.js

@@ -1,167 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.intervalHelpers = exports.createInterval = exports.Interval = void 0;
-/* eslint-disable import/no-deprecated */
-const internal_1 = require("@fluidframework/core-utils/internal");
-const internal_2 = require("@fluidframework/merge-tree/internal");
-const internal_3 = require("@fluidframework/telemetry-utils/internal");
-const intervalCollection_js_1 = require("../intervalCollection.js");
-/**
- * Serializable interval whose endpoints are plain-old numbers.
- * @internal
- */
-class Interval {
-    constructor(start, end, props) {
-        this.start = start;
-        this.end = end;
-        /**
-         * {@inheritDoc ISerializableInterval.properties}
-         */
-        this.properties = (0, internal_2.createMap)();
-        if (props) {
-            this.properties = (0, internal_2.addProperties)(this.properties, props);
-        }
-    }
-    /**
-     * {@inheritDoc ISerializableInterval.getIntervalId}
-     */
-    getIntervalId() {
-        const id = this.properties?.[intervalCollection_js_1.reservedIntervalIdKey];
-        (0, internal_1.assert)(id !== undefined, 0x5e1 /* interval ID should not be undefined */);
-        return `${id}`;
-    }
-    /**
-     * @returns an array containing any auxiliary property sets added with `addPropertySet`.
-     */
-    getAdditionalPropertySets() {
-        return this.auxProps ?? [];
-    }
-    /**
-     * Adds an auxiliary set of properties to this interval.
-     * These properties can be recovered using `getAdditionalPropertySets`
-     * @param props - set of properties to add
-     * @remarks This gets called as part of the default conflict resolver for `IIntervalCollection<Interval>`
-     * (i.e. non-sequence-based interval collections). However, the additional properties don't get serialized.
-     * This functionality seems half-baked.
-     */
-    addPropertySet(props) {
-        if (this.auxProps === undefined) {
-            this.auxProps = [];
-        }
-        this.auxProps.push(props);
-    }
-    /**
-     * {@inheritDoc ISerializableInterval.serialize}
-     */
-    serialize() {
-        const serializedInterval = {
-            end: this.end,
-            intervalType: 0,
-            sequenceNumber: 0,
-            start: this.start,
-        };
-        if (this.properties) {
-            serializedInterval.properties = (0, internal_2.addProperties)(serializedInterval.properties, this.properties);
-        }
-        return serializedInterval;
-    }
-    /**
-     * {@inheritDoc IInterval.clone}
-     */
-    clone() {
-        return new Interval(this.start, this.end, this.properties);
-    }
-    /**
-     * {@inheritDoc IInterval.compare}
-     */
-    compare(b) {
-        const startResult = this.compareStart(b);
-        if (startResult === 0) {
-            const endResult = this.compareEnd(b);
-            if (endResult === 0) {
-                const thisId = this.getIntervalId();
-                if (thisId) {
-                    const bId = b.getIntervalId();
-                    if (bId) {
-                        return thisId > bId ? 1 : thisId < bId ? -1 : 0;
-                    }
-                    return 0;
-                }
-                return 0;
-            }
-            else {
-                return endResult;
-            }
-        }
-        else {
-            return startResult;
-        }
-    }
-    /**
-     * {@inheritDoc IInterval.compareStart}
-     */
-    compareStart(b) {
-        return this.start - b.start;
-    }
-    /**
-     * {@inheritDoc IInterval.compareEnd}
-     */
-    compareEnd(b) {
-        return this.end - b.end;
-    }
-    /**
-     * {@inheritDoc IInterval.overlaps}
-     */
-    overlaps(b) {
-        const result = this.start <= b.end && this.end >= b.start;
-        return result;
-    }
-    /**
-     * {@inheritDoc IInterval.union}
-     */
-    union(b) {
-        return new Interval(Math.min(this.start, b.start), Math.max(this.end, b.end), this.properties);
-    }
-    getProperties() {
-        return this.properties;
-    }
-    /**
-     * {@inheritDoc IInterval.modify}
-     */
-    modify(label, start, end, op) {
-        if (typeof start === "string" || typeof end === "string") {
-            throw new internal_3.UsageError("The start and end positions of a plain interval may not be on the special endpoint segments.");
-        }
-        const startPos = typeof start === "number" ? start : (start?.pos ?? this.start);
-        const endPos = typeof end === "number" ? end : (end?.pos ?? this.end);
-        if (this.start === startPos && this.end === endPos) {
-            // Return undefined to indicate that no change is necessary.
-            return;
-        }
-        const newInterval = new Interval(startPos, endPos);
-        (0, internal_2.copyPropertiesAndManager)(this, newInterval);
-        return newInterval;
-    }
-}
-exports.Interval = Interval;
-function createInterval(label, start, end) {
-    if (typeof start === "string" || typeof end === "string") {
-        throw new internal_3.UsageError("The start and end positions of a plain interval may not be on the special endpoint segments.");
-    }
-    const rangeProp = {};
-    if (label && label.length > 0) {
-        rangeProp[internal_2.reservedRangeLabelsKey] = [label];
-    }
-    const startPos = typeof start === "number" ? start : start.pos;
-    const endPos = typeof end === "number" ? end : end.pos;
-    return new Interval(startPos, endPos, rangeProp);
-}
-exports.createInterval = createInterval;
-exports.intervalHelpers = {
-    create: createInterval,
-};
-//# sourceMappingURL=interval.js.map

package/dist/intervals/interval.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"interval.js","sourceRoot":"","sources":["../../src/intervals/interval.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,yCAAyC;AAEzC,kEAA6D;AAE7D,kEAQ6C;AAC7C,uEAAsE;AAEtE,oEAAiE;AAQjE;;;GAGG;AACH,MAAa,QAAQ;IAWpB,YACQ,KAAa,EACb,GAAW,EAClB,KAAmB;QAFZ,UAAK,GAAL,KAAK,CAAQ;QACb,QAAG,GAAH,GAAG,CAAQ;QAZnB;;WAEG;QACI,eAAU,GAAgB,IAAA,oBAAS,GAAO,CAAC;QAYjD,IAAI,KAAK,EAAE,CAAC;YACX,IAAI,CAAC,UAAU,GAAG,IAAA,wBAAa,EAAC,IAAI,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;QACzD,CAAC;IACF,CAAC;IAED;;OAEG;IACI,aAAa;QACnB,MAAM,EAAE,GAAG,IAAI,CAAC,UAAU,EAAE,CAAC,6CAAqB,CAAC,CAAC;QACpD,IAAA,iBAAM,EAAC,EAAE,KAAK,SAAS,EAAE,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAC1E,OAAO,GAAG,EAAE,EAAE,CAAC;IAChB,CAAC;IAED;;OAEG;IACI,yBAAyB;QAC/B,OAAO,IAAI,CAAC,QAAQ,IAAI,EAAE,CAAC;IAC5B,CAAC;IAED;;;;;;;OAOG;IACI,cAAc,CAAC,KAAkB;QACvC,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS,EAAE,CAAC;YACjC,IAAI,CAAC,QAAQ,GAAG,EAAE,CAAC;QACpB,CAAC;QACD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,SAAS;QACf,MAAM,kBAAkB,GAAwB;YAC/C,GAAG,EAAE,IAAI,CAAC,GAAG;YACb,YAAY,EAAE,CAAC;YACf,cAAc,EAAE,CAAC;YACjB,KAAK,EAAE,IAAI,CAAC,KAAK;SACjB,CAAC;QACF,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACrB,kBAAkB,CAAC,UAAU,GAAG,IAAA,wBAAa,EAC5C,kBAAkB,CAAC,UAAU,EAC7B,IAAI,CAAC,UAAU,CACf,CAAC;QACH,CAAC;QACD,OAAO,kBAAkB,CAAC;IAC3B,CAAC;IAED;;OAEG;IACI,KAAK;QACX,OAAO,IAAI,QAAQ,CAAC,IAAI,CAAC,KAAK,EAAE,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IAC5D,CAAC;IAED;;OAEG;IACI,OAAO,CAAC,CAAW;QACzB,MAAM,WAAW,GAAG,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QACzC,IAAI,WAAW,KAAK,CAAC,EAAE,CAAC;YACvB,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC;YACrC,IAAI,SAAS,KAAK,CAAC,EAAE,CAAC;gBACrB,MAAM,MAAM,GAAG,IAAI,CAAC,aAAa,EAAE,CAAC;gBACpC,IAAI,MAAM,EAAE,CAAC;oBACZ,MAAM,GAAG,GAAG,CAAC,CAAC,aAAa,EAAE,CAAC;oBAC9B,IAAI,GAAG,EAAE,CAAC;wBACT,OAAO,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;oBACjD,CAAC;oBACD,OAAO,CAAC,CAAC;gBACV,CAAC;gBACD,OAAO,CAAC,CAAC;YACV,CAAC;iBAAM,CAAC;gBACP,OAAO,SAAS,CAAC;YAClB,CAAC;QACF,CAAC;aAAM,CAAC;YACP,OAAO,WAAW,CAAC;QACpB,CAAC;IACF,CAAC;IAED;;OAEG;IACI,YAAY,CAAC,CAAW;QAC9B,OAAO,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC;IAC7B,CAAC;IAED;;OAEG;IACI,UAAU,CAAC,CAAW;QAC5B,OAAO,IAAI,CAAC,GAAG,GAAG,CAAC,CAAC,GAAG,CAAC;IACzB,CAAC;IAED;;OAEG;IACI,QAAQ,CAAC,CAAW;QAC1B,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,IAAI,CAAC,CAAC,GAAG,IAAI,IAAI,CAAC,GAAG,IAAI,CAAC,CAAC,KAAK,CAAC;QAC1D,OAAO,MAAM,CAAC;IACf,CAAC;IAED;;OAEG;IACI,KAAK,CAAC,CAAW;QACvB,OAAO,IAAI,QAAQ,CAClB,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,KAAK,CAAC,EAC7B,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,GAAG,CAAC,EACzB,IAAI,CAAC,UAAU,CACf,CAAC;IACH,CAAC;IAEM,aAAa;QACnB,OAAO,IAAI,CAAC,UAAU,CAAC;IACxB,CAAC;IAED;;OAEG;IACI,MAAM,CACZ,KAAa,EACb,KAAqB,EACrB,GAAmB,EACnB,EAA8B;QAE9B,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;YAC1D,MAAM,IAAI,qBAAU,CACnB,8FAA8F,CAC9F,CAAC;QACH,CAAC;QAED,MAAM,QAAQ,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,GAAG,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC;QAChF,MAAM,MAAM,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,GAAG,IAAI,IAAI,CAAC,GAAG,CAAC,CAAC;QAEtE,IAAI,IAAI,CAAC,KAAK,KAAK,QAAQ,IAAI,IAAI,CAAC,GAAG,KAAK,MAAM,EAAE,CAAC;YACpD,4DAA4D;YAC5D,OAAO;QACR,CAAC;QACD,MAAM,WAAW,GAAG,IAAI,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;QACnD,IAAA,mCAAwB,EAAC,IAAI,EAAE,WAAW,CAAC,CAAC;QAC5C,OAAO,WAAW,CAAC;IACpB,CAAC;CACD;AAtKD,4BAsKC;AAED,SAAgB,cAAc,CAC7B,KAAa,EACb,KAAoB,EACpB,GAAkB;IAElB,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,OAAO,GAAG,KAAK,QAAQ,EAAE,CAAC;QAC1D,MAAM,IAAI,qBAAU,CACnB,8FAA8F,CAC9F,CAAC;IACH,CAAC;IAED,MAAM,SAAS,GAAgB,EAAE,CAAC;IAElC,IAAI,KAAK,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC/B,SAAS,CAAC,iCAAsB,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAC7C,CAAC;IAED,MAAM,QAAQ,GAAG,OAAO,KAAK,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,KAAK,CAAC,GAAG,CAAC;IAC/D,MAAM,MAAM,GAAG,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC;IAEvD,OAAO,IAAI,QAAQ,CAAC,QAAQ,EAAE,MAAM,EAAE,SAAS,CAAC,CAAC;AAClD,CAAC;AArBD,wCAqBC;AAEY,QAAA,eAAe,GAA+B;IAC1D,MAAM,EAAE,cAAc;CACtB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/* eslint-disable import/no-deprecated */\n\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport { ISequencedDocumentMessage } from \"@fluidframework/driver-definitions/internal\";\nimport {\n\tPropertiesManager,\n\tPropertySet,\n\tcreateMap,\n\treservedRangeLabelsKey,\n\tSequencePlace,\n\taddProperties,\n\tcopyPropertiesAndManager,\n} from \"@fluidframework/merge-tree/internal\";\nimport { UsageError } from \"@fluidframework/telemetry-utils/internal\";\n\nimport { reservedIntervalIdKey } from \"../intervalCollection.js\";\n\nimport {\n\tIIntervalHelpers,\n\tISerializableInterval,\n\tISerializedInterval,\n} from \"./intervalUtils.js\";\n\n/**\n * Serializable interval whose endpoints are plain-old numbers.\n * @internal\n */\nexport class Interval implements ISerializableInterval {\n\t/**\n\t * {@inheritDoc ISerializableInterval.properties}\n\t */\n\tpublic properties: PropertySet = createMap<any>();\n\n\t/***/\n\tpublic auxProps: PropertySet[] | undefined;\n\n\tpublic propertyManager?: PropertiesManager;\n\n\tconstructor(\n\t\tpublic start: number,\n\t\tpublic end: number,\n\t\tprops?: PropertySet,\n\t) {\n\t\tif (props) {\n\t\t\tthis.properties = addProperties(this.properties, props);\n\t\t}\n\t}\n\n\t/**\n\t * {@inheritDoc ISerializableInterval.getIntervalId}\n\t */\n\tpublic getIntervalId(): string {\n\t\tconst id = this.properties?.[reservedIntervalIdKey];\n\t\tassert(id !== undefined, 0x5e1 /* interval ID should not be undefined */);\n\t\treturn `${id}`;\n\t}\n\n\t/**\n\t * @returns an array containing any auxiliary property sets added with `addPropertySet`.\n\t */\n\tpublic getAdditionalPropertySets(): PropertySet[] {\n\t\treturn this.auxProps ?? [];\n\t}\n\n\t/**\n\t * Adds an auxiliary set of properties to this interval.\n\t * These properties can be recovered using `getAdditionalPropertySets`\n\t * @param props - set of properties to add\n\t * @remarks This gets called as part of the default conflict resolver for `IIntervalCollection<Interval>`\n\t * (i.e. non-sequence-based interval collections). However, the additional properties don't get serialized.\n\t * This functionality seems half-baked.\n\t */\n\tpublic addPropertySet(props: PropertySet) {\n\t\tif (this.auxProps === undefined) {\n\t\t\tthis.auxProps = [];\n\t\t}\n\t\tthis.auxProps.push(props);\n\t}\n\n\t/**\n\t * {@inheritDoc ISerializableInterval.serialize}\n\t */\n\tpublic serialize(): ISerializedInterval {\n\t\tconst serializedInterval: ISerializedInterval = {\n\t\t\tend: this.end,\n\t\t\tintervalType: 0,\n\t\t\tsequenceNumber: 0,\n\t\t\tstart: this.start,\n\t\t};\n\t\tif (this.properties) {\n\t\t\tserializedInterval.properties = addProperties(\n\t\t\t\tserializedInterval.properties,\n\t\t\t\tthis.properties,\n\t\t\t);\n\t\t}\n\t\treturn serializedInterval;\n\t}\n\n\t/**\n\t * {@inheritDoc IInterval.clone}\n\t */\n\tpublic clone() {\n\t\treturn new Interval(this.start, this.end, this.properties);\n\t}\n\n\t/**\n\t * {@inheritDoc IInterval.compare}\n\t */\n\tpublic compare(b: Interval) {\n\t\tconst startResult = this.compareStart(b);\n\t\tif (startResult === 0) {\n\t\t\tconst endResult = this.compareEnd(b);\n\t\t\tif (endResult === 0) {\n\t\t\t\tconst thisId = this.getIntervalId();\n\t\t\t\tif (thisId) {\n\t\t\t\t\tconst bId = b.getIntervalId();\n\t\t\t\t\tif (bId) {\n\t\t\t\t\t\treturn thisId > bId ? 1 : thisId < bId ? -1 : 0;\n\t\t\t\t\t}\n\t\t\t\t\treturn 0;\n\t\t\t\t}\n\t\t\t\treturn 0;\n\t\t\t} else {\n\t\t\t\treturn endResult;\n\t\t\t}\n\t\t} else {\n\t\t\treturn startResult;\n\t\t}\n\t}\n\n\t/**\n\t * {@inheritDoc IInterval.compareStart}\n\t */\n\tpublic compareStart(b: Interval) {\n\t\treturn this.start - b.start;\n\t}\n\n\t/**\n\t * {@inheritDoc IInterval.compareEnd}\n\t */\n\tpublic compareEnd(b: Interval) {\n\t\treturn this.end - b.end;\n\t}\n\n\t/**\n\t * {@inheritDoc IInterval.overlaps}\n\t */\n\tpublic overlaps(b: Interval) {\n\t\tconst result = this.start <= b.end && this.end >= b.start;\n\t\treturn result;\n\t}\n\n\t/**\n\t * {@inheritDoc IInterval.union}\n\t */\n\tpublic union(b: Interval) {\n\t\treturn new Interval(\n\t\t\tMath.min(this.start, b.start),\n\t\t\tMath.max(this.end, b.end),\n\t\t\tthis.properties,\n\t\t);\n\t}\n\n\tpublic getProperties() {\n\t\treturn this.properties;\n\t}\n\n\t/**\n\t * {@inheritDoc IInterval.modify}\n\t */\n\tpublic modify(\n\t\tlabel: string,\n\t\tstart?: SequencePlace,\n\t\tend?: SequencePlace,\n\t\top?: ISequencedDocumentMessage,\n\t) {\n\t\tif (typeof start === \"string\" || typeof end === \"string\") {\n\t\t\tthrow new UsageError(\n\t\t\t\t\"The start and end positions of a plain interval may not be on the special endpoint segments.\",\n\t\t\t);\n\t\t}\n\n\t\tconst startPos = typeof start === \"number\" ? start : (start?.pos ?? this.start);\n\t\tconst endPos = typeof end === \"number\" ? end : (end?.pos ?? this.end);\n\n\t\tif (this.start === startPos && this.end === endPos) {\n\t\t\t// Return undefined to indicate that no change is necessary.\n\t\t\treturn;\n\t\t}\n\t\tconst newInterval = new Interval(startPos, endPos);\n\t\tcopyPropertiesAndManager(this, newInterval);\n\t\treturn newInterval;\n\t}\n}\n\nexport function createInterval(\n\tlabel: string,\n\tstart: SequencePlace,\n\tend: SequencePlace,\n): Interval {\n\tif (typeof start === \"string\" || typeof end === \"string\") {\n\t\tthrow new UsageError(\n\t\t\t\"The start and end positions of a plain interval may not be on the special endpoint segments.\",\n\t\t);\n\t}\n\n\tconst rangeProp: PropertySet = {};\n\n\tif (label && label.length > 0) {\n\t\trangeProp[reservedRangeLabelsKey] = [label];\n\t}\n\n\tconst startPos = typeof start === \"number\" ? start : start.pos;\n\tconst endPos = typeof end === \"number\" ? end : end.pos;\n\n\treturn new Interval(startPos, endPos, rangeProp);\n}\n\nexport const intervalHelpers: IIntervalHelpers<Interval> = {\n\tcreate: createInterval,\n};\n"]}