@fluidframework/sequence 2.0.0-rc.3.0.2 → 2.0.0-rc.4.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/sequence",
-  "version": "2.0.0-rc.3.0.2",
+  "version": "2.0.0-rc.4.0.0",
   "description": "Distributed sequence",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -87,34 +87,34 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": ">=2.0.0-rc.3.0.2 <2.0.0-rc.3.1.0",
-    "@fluidframework/core-interfaces": ">=2.0.0-rc.3.0.2 <2.0.0-rc.3.1.0",
-    "@fluidframework/core-utils": ">=2.0.0-rc.3.0.2 <2.0.0-rc.3.1.0",
-    "@fluidframework/datastore-definitions": ">=2.0.0-rc.3.0.2 <2.0.0-rc.3.1.0",
-    "@fluidframework/merge-tree": ">=2.0.0-rc.3.0.2 <2.0.0-rc.3.1.0",
+    "@fluid-internal/client-utils": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
+    "@fluidframework/core-interfaces": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
+    "@fluidframework/core-utils": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
+    "@fluidframework/datastore-definitions": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
+    "@fluidframework/merge-tree": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
     "@fluidframework/protocol-definitions": "^3.2.0",
-    "@fluidframework/runtime-definitions": ">=2.0.0-rc.3.0.2 <2.0.0-rc.3.1.0",
-    "@fluidframework/runtime-utils": ">=2.0.0-rc.3.0.2 <2.0.0-rc.3.1.0",
-    "@fluidframework/shared-object-base": ">=2.0.0-rc.3.0.2 <2.0.0-rc.3.1.0",
-    "@fluidframework/telemetry-utils": ">=2.0.0-rc.3.0.2 <2.0.0-rc.3.1.0",
+    "@fluidframework/runtime-definitions": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
+    "@fluidframework/runtime-utils": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
+    "@fluidframework/shared-object-base": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
+    "@fluidframework/telemetry-utils": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
     "double-ended-queue": "^2.1.0-0",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
     "@biomejs/biome": "^1.6.2",
-    "@fluid-internal/mocha-test-setup": ">=2.0.0-rc.3.0.2 <2.0.0-rc.3.1.0",
-    "@fluid-private/stochastic-test-utils": ">=2.0.0-rc.3.0.2 <2.0.0-rc.3.1.0",
-    "@fluid-private/test-dds-utils": ">=2.0.0-rc.3.0.2 <2.0.0-rc.3.1.0",
+    "@fluid-internal/mocha-test-setup": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
+    "@fluid-private/stochastic-test-utils": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
+    "@fluid-private/test-dds-utils": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
     "@fluid-tools/benchmark": "^0.48.0",
-    "@fluid-tools/build-cli": "^0.37.0",
+    "@fluid-tools/build-cli": "^0.38.0",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.37.0",
-    "@fluidframework/container-definitions": ">=2.0.0-rc.3.0.2 <2.0.0-rc.3.1.0",
+    "@fluidframework/build-tools": "^0.38.0",
+    "@fluidframework/container-definitions": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
     "@fluidframework/eslint-config-fluid": "^5.1.0",
-    "@fluidframework/sequence-previous": "npm:@fluidframework/sequence@2.0.0-internal.8.0.0",
-    "@fluidframework/test-runtime-utils": ">=2.0.0-rc.3.0.2 <2.0.0-rc.3.1.0",
-    "@microsoft/api-extractor": "^7.42.3",
+    "@fluidframework/sequence-previous": "npm:@fluidframework/sequence@2.0.0-rc.3.0.0",
+    "@fluidframework/test-runtime-utils": ">=2.0.0-rc.4.0.0 <2.0.0-rc.4.1.0",
+    "@microsoft/api-extractor": "^7.43.1",
     "@types/diff": "^3.5.1",
     "@types/double-ended-queue": "^2.1.0",
     "@types/mocha": "^9.1.1",
@@ -145,11 +145,25 @@
   },
   "typeValidation": {
     "broken": {
-      "InterfaceDeclaration_IIntervalCollection": {
-        "backCompat": false
+      "RemovedClassDeclaration_SharedString": {
+        "backCompat": false,
+        "forwardCompat": false
       },
-      "ClassDeclaration_SharedString": {
-        "backCompat": false
+      "InterfaceDeclaration_ISharedString": {
+        "forwardCompat": false
+      },
+      "ClassDeclaration_SharedIntervalCollection": {
+        "forwardCompat": false
+      },
+      "ClassDeclaration_SharedSegmentSequence": {
+        "forwardCompat": false
+      },
+      "ClassDeclaration_SharedSequence": {
+        "forwardCompat": false
+      },
+      "RemovedClassDeclaration_SharedStringFactory": {
+        "backCompat": false,
+        "forwardCompat": false
       }
     }
   },
@@ -191,7 +205,7 @@
     "test:newsnapfiles": "node lib/test/createSnapshotFiles.js",
     "test:stress": "cross-env FUZZ_TEST_COUNT=100 FUZZ_STRESS_RUN=true mocha --ignore \"lib/test/memory/**/*\" --recursive \"lib/test/**/*.fuzz.spec.*js\" -r @fluid-internal/mocha-test-setup",
     "tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
-    "typetests:gen": "fluid-type-test-generator",
+    "typetests:gen": "flub generate typetests --dir . -v --publicFallback",
     "typetests:prepare": "flub typetests --dir . --reset --previous --normalize"
   }
 }

package/src/IntervalCollectionValues.ts

@@ -53,8 +53,6 @@ export function makeSerializable<T extends ISerializableInterval>(
 
 /**
  * Manages a contained value type.
- *
- * @alpha
  */
 export class IntervalCollectionTypeLocalValue<T extends ISerializableInterval>
 	implements ILocalIntervalCollection<T>

package/src/index.ts

@@ -76,12 +76,12 @@ export {
 	SequenceEvent,
 	SequenceMaintenanceEvent,
 } from "./sequenceDeltaEvent.js";
-export { SharedStringFactory } from "./sequenceFactory.js";
+export { SharedString } from "./sequenceFactory.js";
 export {
 	getTextAndMarkers,
 	ISharedString,
-	SharedString,
 	SharedStringSegment,
+	SharedStringClass,
 } from "./sharedString.js";
 export {
 	ISharedIntervalCollection,

package/src/intervalCollection.ts

@@ -1281,7 +1281,7 @@ export class IntervalCollection<TInterval extends ISerializableInterval>
 				start: startPos,
 				end: endPos,
 				intervalType: IntervalType.SlideOnRemove,
-				properties: interval.properties,
+				properties: { ...interval.properties },
 				sequenceNumber: this.client?.getCurrentSeq() ?? 0,
 				stickiness,
 				startSide,

package/src/intervalIndex/endpointInRangeIndex.ts

@@ -14,7 +14,7 @@ import {
 	SequenceInterval,
 	sequenceIntervalHelpers,
 } from "../intervals/index.js";
-import { SharedString } from "../sharedString.js";
+import { ISharedString } from "../sharedString.js";
 
 import { IntervalIndex } from "./intervalIndex.js";
 import { HasComparisonOverride, compareOverrideables, forceCompare } from "./intervalIndexUtils.js";
@@ -112,7 +112,7 @@ export class EndpointInRangeIndex<TInterval extends ISerializableInterval>
  * @internal
  */
 export function createEndpointInRangeIndex(
-	sharedString: SharedString,
+	sharedString: ISharedString,
 ): IEndpointInRangeIndex<SequenceInterval> {
 	const client = (sharedString as unknown as { client: Client }).client;
 	return new EndpointInRangeIndex<SequenceInterval>(client, sequenceIntervalHelpers);

package/src/intervalIndex/endpointIndex.ts

@@ -14,7 +14,7 @@ import {
 	SequenceInterval,
 	sequenceIntervalHelpers,
 } from "../intervals/index.js";
-import { SharedString } from "../sharedString.js";
+import { ISharedString } from "../sharedString.js";
 
 import { IntervalIndex } from "./intervalIndex.js";
 
@@ -88,7 +88,7 @@ export class EndpointIndex<TInterval extends ISerializableInterval>
 /**
  * @internal
  */
-export function createEndpointIndex(sharedString: SharedString): IEndpointIndex<SequenceInterval> {
+export function createEndpointIndex(sharedString: ISharedString): IEndpointIndex<SequenceInterval> {
 	const client = (sharedString as unknown as { client: Client }).client;
 	return new EndpointIndex<SequenceInterval>(client, sequenceIntervalHelpers);
 }

package/src/intervalIndex/overlappingIntervalsIndex.ts

@@ -16,7 +16,7 @@ import {
 	SequenceInterval,
 	sequenceIntervalHelpers,
 } from "../intervals/index.js";
-import { SharedString } from "../sharedString.js";
+import { ISharedString } from "../sharedString.js";
 
 import { IntervalIndex } from "./intervalIndex.js";
 
@@ -182,7 +182,7 @@ export class OverlappingIntervalsIndex<TInterval extends ISerializableInterval>
  * @alpha
  */
 export function createOverlappingIntervalsIndex(
-	sharedString: SharedString,
+	sharedString: ISharedString,
 ): IOverlappingIntervalsIndex<SequenceInterval> {
 	const client = (sharedString as unknown as { client: Client }).client;
 	return new OverlappingIntervalsIndex<SequenceInterval>(client, sequenceIntervalHelpers);

package/src/intervalIndex/overlappingSequenceIntervalsIndex.ts

@@ -19,7 +19,7 @@ import {
 	createPositionReferenceFromSegoff,
 	sequenceIntervalHelpers,
 } from "../intervals/index.js";
-import { SharedString } from "../sharedString.js";
+import { ISharedString } from "../sharedString.js";
 
 import { OverlappingIntervalsIndex } from "./overlappingIntervalsIndex.js";
 import { SequenceIntervalIndexes } from "./sequenceIntervalIndexes.js";
@@ -76,7 +76,7 @@ class OverlappingSequenceIntervalsIndex
  * @internal
  */
 export function createOverlappingSequenceIntervalsIndex(
-	sharedString: SharedString,
+	sharedString: ISharedString,
 ): SequenceIntervalIndexes.Overlapping {
 	const client = (sharedString as unknown as { client: Client }).client;
 	return new OverlappingSequenceIntervalsIndex(client);

package/src/intervalIndex/startpointInRangeIndex.ts

@@ -14,7 +14,7 @@ import {
 	SequenceInterval,
 	sequenceIntervalHelpers,
 } from "../intervals/index.js";
-import { SharedString } from "../sharedString.js";
+import { ISharedString } from "../sharedString.js";
 
 import { IntervalIndex } from "./intervalIndex.js";
 import { HasComparisonOverride, compareOverrideables, forceCompare } from "./intervalIndexUtils.js";
@@ -110,7 +110,7 @@ export class StartpointInRangeIndex<TInterval extends ISerializableInterval>
  * @internal
  */
 export function createStartpointInRangeIndex(
-	sharedString: SharedString,
+	sharedString: ISharedString,
 ): IStartpointInRangeIndex<SequenceInterval> {
 	const client = (sharedString as unknown as { client: Client }).client;
 	return new StartpointInRangeIndex<SequenceInterval>(client, sequenceIntervalHelpers);

package/src/intervals/interval.ts

@@ -89,7 +89,7 @@ export class Interval implements ISerializableInterval {
 			start: this.start,
 		};
 		if (this.properties) {
-			serializedInterval.properties = this.properties;
+			serializedInterval.properties = { ...this.properties };
 		}
 		return serializedInterval;
 	}

package/src/intervals/sequenceInterval.ts

@@ -198,7 +198,7 @@ export class SequenceInterval implements ISerializableInterval {
 		};
 
 		if (this.properties) {
-			serializedInterval.properties = this.properties;
+			serializedInterval.properties = { ...this.properties };
 		}
 
 		return serializedInterval;

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/sequence";
-export const pkgVersion = "2.0.0-rc.3.0.2";
+export const pkgVersion = "2.0.0-rc.4.0.0";

package/src/revertibles.ts

@@ -26,7 +26,7 @@ import {
 import { InteriorSequencePlace, Side } from "./intervalCollection.js";
 import { IntervalOpType, SequenceInterval } from "./intervals/index.js";
 import { ISequenceDeltaRange, SequenceDeltaEvent } from "./sequenceDeltaEvent.js";
-import { SharedString, SharedStringSegment } from "./sharedString.js";
+import { ISharedString, SharedStringSegment } from "./sharedString.js";
 
 /**
  * Data for undoing edits on SharedStrings and Intervals.
@@ -111,7 +111,7 @@ export function appendAddIntervalToRevertibles(
  * @alpha
  */
 export function appendDeleteIntervalToRevertibles(
-	string: SharedString,
+	string: ISharedString,
 	interval: SequenceInterval,
 	revertibles: SharedStringRevertible[],
 ): SharedStringRevertible[] {
@@ -163,7 +163,7 @@ export function appendDeleteIntervalToRevertibles(
  * @alpha
  */
 export function appendChangeIntervalToRevertibles(
-	string: SharedString,
+	string: ISharedString,
 	newInterval: SequenceInterval,
 	previousInterval: SequenceInterval,
 	revertibles: SharedStringRevertible[],
@@ -273,7 +273,7 @@ function addIfRevertibleRef(
  * @alpha
  */
 export function appendSharedStringDeltaToRevertibles(
-	string: SharedString,
+	string: ISharedString,
 	delta: SequenceDeltaEvent,
 	revertibles: SharedStringRevertible[],
 ) {
@@ -366,7 +366,7 @@ export function appendSharedStringDeltaToRevertibles(
  * @alpha
  */
 export function discardSharedStringRevertibles(
-	sharedString: SharedString,
+	sharedString: ISharedString,
 	revertibles: SharedStringRevertible[],
 ) {
 	revertibles.forEach((r) => {
@@ -379,7 +379,11 @@ export function discardSharedStringRevertibles(
 	});
 }
 
-function getSlidePosition(string: SharedString, lref: LocalReferencePosition, pos: number): number {
+function getSlidePosition(
+	string: ISharedString,
+	lref: LocalReferencePosition,
+	pos: number,
+): number {
 	const slide = getSlideToSegoff(
 		{ segment: lref.getSegment(), offset: undefined },
 		lref.slidingPreference,
@@ -397,7 +401,7 @@ function isValidRange(
 	startSlide: SlidingPreference | undefined,
 	end: number,
 	endSlide: SlidingPreference | undefined,
-	string: SharedString,
+	string: ISharedString,
 ) {
 	return (
 		start >= 0 &&
@@ -412,7 +416,7 @@ function isValidRange(
 }
 
 function revertLocalAdd(
-	string: SharedString,
+	string: ISharedString,
 	revertible: TypedRevertible<typeof IntervalOpType.ADD>,
 ) {
 	const id = getUpdatedIdFromInterval(revertible.interval);
@@ -441,7 +445,7 @@ function createSequencePlace(
 }
 
 function revertLocalDelete(
-	string: SharedString,
+	string: ISharedString,
 	revertible: TypedRevertible<typeof IntervalOpType.DELETE>,
 ) {
 	const label = revertible.interval.properties.referenceRangeLabels[0];
@@ -480,7 +484,7 @@ function revertLocalDelete(
 }
 
 function revertLocalChange(
-	string: SharedString,
+	string: ISharedString,
 	revertible: TypedRevertible<typeof IntervalOpType.CHANGE>,
 ) {
 	const label = revertible.interval.properties.referenceRangeLabels[0];
@@ -520,7 +524,7 @@ function revertLocalChange(
 }
 
 function revertLocalPropertyChanged(
-	string: SharedString,
+	string: ISharedString,
 	revertible: TypedRevertible<typeof IntervalOpType.PROPERTY_CHANGED>,
 ) {
 	const label = revertible.interval.properties.referenceRangeLabels[0];
@@ -554,7 +558,7 @@ function newPosition(offset: number | undefined, restoredRanges: SortedRangeSet)
 function newEndpointPosition(
 	offset: number | undefined,
 	restoredRanges: SortedRangeSet,
-	sharedString: SharedString,
+	sharedString: ISharedString,
 ) {
 	const pos = newPosition(offset, restoredRanges);
 	return pos === undefined ? undefined : sharedString.getPosition(pos.segment) + pos.offset;
@@ -573,7 +577,7 @@ class SortedRangeSet extends SortedSet<RangeInfo, string> {
 }
 
 function revertLocalSequenceRemove(
-	sharedString: SharedString,
+	sharedString: ISharedString,
 	revertible: TypedRevertible<typeof IntervalOpType.POSITION_REMOVE>,
 ) {
 	const restoredRanges = new SortedRangeSet();
@@ -657,7 +661,7 @@ function revertLocalSequenceRemove(
  * @alpha
  */
 export function revertSharedStringRevertibles(
-	sharedString: SharedString,
+	sharedString: ISharedString,
 	revertibles: SharedStringRevertible[],
 ) {
 	while (revertibles.length > 0) {

package/src/sequence.ts

@@ -17,7 +17,9 @@ import {
 	IJSONSegment,
 	IMergeTreeAnnotateMsg,
 	IMergeTreeDeltaOp,
+	// eslint-disable-next-line import/no-deprecated
 	IMergeTreeGroupMsg,
+	// eslint-disable-next-line import/no-deprecated
 	IMergeTreeObliterateMsg,
 	IMergeTreeOp,
 	IMergeTreeRemoveMsg,
@@ -30,9 +32,11 @@ import {
 	PropertySet,
 	ReferencePosition,
 	ReferenceType,
+	// eslint-disable-next-line import/no-deprecated
 	SegmentGroup,
 	SlidingPreference,
-	createAnnotateRangeOp, // eslint-disable-next-line import/no-deprecated
+	createAnnotateRangeOp,
+	// eslint-disable-next-line import/no-deprecated
 	createGroupOp,
 	createInsertOp,
 	createObliterateRangeOp,
@@ -180,6 +184,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 				}
 
 				case MergeTreeDeltaType.OBLITERATE: {
+					// eslint-disable-next-line import/no-deprecated
 					const lastRem = ops[ops.length - 1] as IMergeTreeObliterateMsg;
 					if (lastRem?.pos1 === r.position) {
 						assert(
@@ -235,7 +240,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 	 * DDS submits over the wire. See `inFlightRefSeqs` for more details.
 	 */
 	private get currentRefSeq() {
-		return this.ongoingResubmitRefSeq ?? this.runtime.deltaManager.lastSequenceNumber;
+		return this.ongoingResubmitRefSeq ?? this.deltaManager.lastSequenceNumber;
 	}
 
 	// eslint-disable-next-line import/no-deprecated
@@ -243,6 +248,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 	/** `Deferred` that triggers once the object is loaded */
 	protected loadedDeferred = new Deferred<void>();
 	// cache out going ops created when partial loading
+	// eslint-disable-next-line import/no-deprecated
 	private readonly loadedDeferredOutgoingOps: [IMergeTreeOp, SegmentGroup | SegmentGroup[]][] =
 		[];
 	// cache incoming ops that arrive when partial loading
@@ -340,6 +346,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 	 * release, as group ops are redundant with the native batching capabilities
 	 * of the runtime
 	 */
+	// eslint-disable-next-line import/no-deprecated
 	public groupOperation(groupOp: IMergeTreeGroupMsg) {
 		this.guardReentrancy(() => this.client.localTransaction(groupOp));
 	}
@@ -654,6 +661,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 				this.submitSequenceMessage(
 					this.client.regeneratePendingOp(
 						content as IMergeTreeOp,
+						// eslint-disable-next-line import/no-deprecated
 						localOpMetadata as SegmentGroup | SegmentGroup[],
 					),
 				);
@@ -803,7 +811,7 @@ export abstract class SharedSegmentSequence<T extends ISegment>
 			this.loadedDeferred.isCompleted,
 			0x074 /* "Snapshot called when not fully loaded" */,
 		);
-		const minSeq = this.runtime.deltaManager.minimumSequenceNumber;
+		const minSeq = this.deltaManager.minimumSequenceNumber;
 
 		this.processMinSequenceNumberChanged(minSeq);
 

package/src/sequenceDeltaEvent.ts

@@ -36,6 +36,9 @@ export abstract class SequenceEvent<
 	private readonly pLast: Lazy<ISequenceDeltaRange<TOperation>>;
 
 	constructor(
+		/**
+		 * Arguments reflecting the type of change that caused this event.
+		 */
 		public readonly deltaArgs: IMergeTreeDeltaCallbackArgs<TOperation>,
 		// eslint-disable-next-line import/no-deprecated
 		private readonly mergeTreeClient: Client,
@@ -73,7 +76,10 @@ export abstract class SequenceEvent<
 
 	/**
 	 * The in-order ranges affected by this delta.
-	 * These may not be continuous.
+	 * These are not necessarily contiguous.
+	 *
+	 * @remarks - If processing code doesn't care about the order of the ranges, it may instead consider using the
+	 * {@link @fluidframework/merge-tree#IMergeTreeDeltaCallbackArgs.deltaSegments|deltaSegments} field on {@link SequenceEvent.deltaArgs|deltaArgs}.
 	 */
 	public get ranges(): readonly Readonly<ISequenceDeltaRange<TOperation>>[] {
 		return this.sortedRanges.value.items;
@@ -140,6 +146,11 @@ export class SequenceDeltaEvent extends SequenceEvent<MergeTreeDeltaOperationTyp
  */
 export class SequenceMaintenanceEvent extends SequenceEvent<MergeTreeMaintenanceType> {
 	constructor(
+		/**
+		 * Defined iff `deltaArgs.operation` is {@link @fluidframework/merge-tree#MergeTreeMaintenanceType.ACKNOWLEDGED|MergeTreeMaintenanceType.ACKNOWLEDGED}.
+		 *
+		 * In that case, this argument provides information about the change which was acknowledged.
+		 */
 		public readonly opArgs: IMergeTreeDeltaOpArgs | undefined,
 		deltaArgs: IMergeTreeMaintenanceCallbackArgs,
 		// eslint-disable-next-line import/no-deprecated

package/src/sequenceFactory.ts

@@ -10,14 +10,13 @@ import {
 	IFluidDataStoreRuntime,
 } from "@fluidframework/datastore-definitions";
 import { Marker, TextSegment } from "@fluidframework/merge-tree/internal";
+import type { ISharedObjectKind } from "@fluidframework/shared-object-base";
+import { createSharedObjectKind } from "@fluidframework/shared-object-base/internal";
 
 import { pkgVersion } from "./packageVersion.js";
-import { SharedString, SharedStringSegment } from "./sharedString.js";
+import { SharedStringClass, SharedStringSegment, type ISharedString } from "./sharedString.js";
 
-/**
- * @alpha
- */
-export class SharedStringFactory implements IChannelFactory {
+export class SharedStringFactory implements IChannelFactory<ISharedString> {
 	// TODO rename back to https://graph.microsoft.com/types/mergeTree/string once paparazzi is able to dynamically
 	// load code (UPDATE: paparazzi is gone... anything to do here?)
 	public static Type = "https://graph.microsoft.com/types/mergeTree";
@@ -58,8 +57,8 @@ export class SharedStringFactory implements IChannelFactory {
 		id: string,
 		services: IChannelServices,
 		attributes: IChannelAttributes,
-	): Promise<SharedString> {
-		const sharedString = new SharedString(runtime, id, attributes);
+	): Promise<SharedStringClass> {
+		const sharedString = new SharedStringClass(runtime, id, attributes);
 		await sharedString.load(services);
 		return sharedString;
 	}
@@ -67,9 +66,22 @@ export class SharedStringFactory implements IChannelFactory {
 	/**
 	 * {@inheritDoc @fluidframework/datastore-definitions#IChannelFactory.create}
 	 */
-	public create(document: IFluidDataStoreRuntime, id: string): SharedString {
-		const sharedString = new SharedString(document, id, this.attributes);
+	public create(document: IFluidDataStoreRuntime, id: string): SharedStringClass {
+		const sharedString = new SharedStringClass(document, id, this.attributes);
 		sharedString.initializeLocal();
 		return sharedString;
 	}
 }
+
+/**
+ * Entrypoint for {@link ISharedString} creation.
+ * @alpha
+ */
+export const SharedString: ISharedObjectKind<ISharedString> =
+	createSharedObjectKind(SharedStringFactory);
+
+/**
+ * Alias for {@link ISharedString} for compatibility.
+ * @alpha
+ */
+export type SharedString = ISharedString;