@fluidframework/sequence 2.60.0 → 2.61.0-355516

package/.mocharc.cjs

@@ -7,6 +7,5 @@
 
 const getFluidTestMochaConfig = require("@fluid-internal/mocha-test-setup/mocharc-common");
 
-const packageDir = __dirname;
-const config = getFluidTestMochaConfig(packageDir);
+const config = getFluidTestMochaConfig(__dirname);
 module.exports = config;

package/api-report/sequence.legacy.beta.api.md

@@ -19,7 +19,40 @@ export function appendIntervalPropertyChangedToRevertibles(interval: SequenceInt
 // @beta @legacy
 export function appendSharedStringDeltaToRevertibles(string: ISharedString, delta: SequenceDeltaEvent, revertibles: SharedStringRevertible[]): void;
 
-export { BaseSegment }
+// @beta @legacy (undocumented)
+export abstract class BaseSegment implements ISegment {
+    constructor(properties?: PropertySet);
+    // (undocumented)
+    protected addSerializedProps(jseg: IJSONSegment): void;
+    // (undocumented)
+    append(other: ISegment): void;
+    // (undocumented)
+    attribution?: IAttributionCollection<AttributionKey>;
+    // (undocumented)
+    cachedLength: number;
+    // (undocumented)
+    canAppend(segment: ISegment): boolean;
+    // (undocumented)
+    abstract clone(): ISegment;
+    // (undocumented)
+    protected cloneInto(b: ISegment): void;
+    // (undocumented)
+    protected abstract createSplitSegmentAt(pos: number): BaseSegment | undefined;
+    // (undocumented)
+    hasProperty(key: string): boolean;
+    // (undocumented)
+    isLeaf(): this is ISegment;
+    // (undocumented)
+    properties?: PropertySet;
+    // (undocumented)
+    splitAt(pos: number): ISegment | undefined;
+    // (undocumented)
+    abstract toJSONObject(): any;
+    // (undocumented)
+    readonly trackingCollection: TrackingGroupCollection;
+    // (undocumented)
+    abstract readonly type: string;
+}
 
 // @beta @legacy (undocumented)
 export function createOverlappingIntervalsIndex(sharedString: ISharedString): ISequenceOverlappingIntervalsIndex;
@@ -39,7 +72,13 @@ export interface IInterval {
     overlaps(b: IInterval): boolean;
 }
 
-export { InteriorSequencePlace }
+// @beta @legacy
+export interface InteriorSequencePlace {
+    // (undocumented)
+    pos: number;
+    // (undocumented)
+    side: Side;
+}
 
 // @beta @legacy
 export const IntervalOpType: {
@@ -105,7 +144,28 @@ export enum IntervalType {
     SlideOnRemove = 2,// SlideOnRemove is default behavior - all intervals are SlideOnRemove
 }
 
-export { ISegment }
+// @beta @legacy
+export interface ISegment {
+    // (undocumented)
+    append(segment: ISegment): void;
+    attribution?: IAttributionCollection<AttributionKey>;
+    cachedLength: number;
+    // (undocumented)
+    canAppend(segment: ISegment): boolean;
+    // (undocumented)
+    clone(): ISegment;
+    // (undocumented)
+    isLeaf(): this is ISegment;
+    properties?: PropertySet;
+    // (undocumented)
+    splitAt(pos: number): ISegment | undefined;
+    // (undocumented)
+    toJSONObject(): any;
+    // (undocumented)
+    readonly trackingCollection: TrackingGroupCollection;
+    // (undocumented)
+    readonly type: string;
+}
 
 // @beta @legacy
 export interface ISequenceDeltaRange<TOperation extends MergeTreeDeltaOperationTypes = MergeTreeDeltaOperationTypes> {
@@ -250,21 +310,102 @@ export interface ISharedString extends ISharedSegmentSequence<SharedStringSegmen
     searchForMarker(startPos: number, markerLabel: string, forwards?: boolean): Marker | undefined;
 }
 
-export { LocalReferencePosition }
+// @beta @sealed @legacy (undocumented)
+export interface LocalReferencePosition extends ReferencePosition {
+    // (undocumented)
+    addProperties(newProps: PropertySet): void;
+    // (undocumented)
+    callbacks?: Partial<Record<"beforeSlide" | "afterSlide", (ref: LocalReferencePosition) => void>>;
+    readonly canSlideToEndpoint?: boolean;
+    // (undocumented)
+    readonly trackingCollection: TrackingGroupCollection;
+}
 
-export { MapLike }
+// @beta @legacy
+export interface MapLike<T> {
+    // (undocumented)
+    [index: string]: T;
+}
 
-export { Marker }
+// @beta @legacy
+export class Marker extends BaseSegment implements ReferencePosition, ISegment {
+    constructor(refType: ReferenceType, props?: PropertySet);
+    // (undocumented)
+    append(): void;
+    // (undocumented)
+    canAppend(segment: ISegment): boolean;
+    // (undocumented)
+    clone(): Marker;
+    // (undocumented)
+    protected createSplitSegmentAt(pos: number): undefined;
+    // (undocumented)
+    static fromJSONObject(spec: IJSONSegment): Marker | undefined;
+    // (undocumented)
+    getId(): string | undefined;
+    // (undocumented)
+    getOffset(): number;
+    // (undocumented)
+    getProperties(): PropertySet | undefined;
+    // (undocumented)
+    getSegment(): Marker;
+    // (undocumented)
+    static is(segment: ISegment): segment is Marker;
+    // (undocumented)
+    static make(refType: ReferenceType, props?: PropertySet): Marker;
+    // (undocumented)
+    refType: ReferenceType;
+    // (undocumented)
+    toJSONObject(): IJSONMarkerSegment;
+    // (undocumented)
+    toString(): string;
+    // (undocumented)
+    static readonly type = "Marker";
+    // (undocumented)
+    readonly type = "Marker";
+}
 
-export { MergeTreeDeltaType }
+// @beta @legacy (undocumented)
+export const MergeTreeDeltaType: {
+    readonly INSERT: 0;
+    readonly REMOVE: 1;
+    readonly ANNOTATE: 2;
+    readonly GROUP: 3;
+    readonly OBLITERATE: 4;
+    readonly OBLITERATE_SIDED: 5;
+};
 
-export { PropertySet }
+// @beta @legacy (undocumented)
+export type MergeTreeDeltaType = (typeof MergeTreeDeltaType)[keyof typeof MergeTreeDeltaType];
 
-export { ReferencePosition }
+// @beta @legacy
+export type PropertySet = MapLike<any>;
 
-export { ReferenceType }
+// @beta @legacy
+export interface ReferencePosition {
+    getOffset(): number;
+    getSegment(): ISegment | undefined;
+    // (undocumented)
+    isLeaf(): this is ISegment;
+    properties?: PropertySet;
+    // (undocumented)
+    refType: ReferenceType;
+    slidingPreference?: SlidingPreference;
+}
+
+// @beta @legacy
+export enum ReferenceType {
+    RangeBegin = 16,
+    RangeEnd = 32,
+    // (undocumented)
+    Simple = 0,
+    SlideOnRemove = 64,
+    StayOnRemove = 128,
+    Tile = 1,
+    Transient = 256
+}
 
-export { reservedMarkerIdKey }
+// @beta @legacy
+export const reservedMarkerIdKey = "markerId";
 
 // @beta @legacy
 export function revertSharedStringRevertibles(sharedString: ISharedString, revertibles: SharedStringRevertible[]): void;
@@ -324,7 +465,8 @@ export interface SequenceMaintenanceEvent extends SequenceEvent<MergeTreeMainten
     readonly opArgs: IMergeTreeDeltaOpArgs | undefined;
 }
 
-export { SequencePlace }
+// @beta @legacy
+export type SequencePlace = number | "start" | "end" | InteriorSequencePlace;
 
 // @beta @legacy
 export const SharedString: ISharedObjectKind<ISharedString> & SharedObjectKind<ISharedString>;
@@ -338,10 +480,56 @@ export type SharedStringRevertible = MergeTreeDeltaRevertible | IntervalRevertib
 // @beta @legacy (undocumented)
 export type SharedStringSegment = TextSegment | Marker;
 
-export { Side }
+// @beta @legacy
+export enum Side {
+    // (undocumented)
+    After = 1,
+    // (undocumented)
+    Before = 0
+}
 
-export { TextSegment }
+// @beta @legacy (undocumented)
+export class TextSegment extends BaseSegment {
+    constructor(text: string, props?: PropertySet);
+    // (undocumented)
+    append(segment: ISegment): void;
+    // (undocumented)
+    canAppend(segment: ISegment): boolean;
+    // (undocumented)
+    clone(start?: number, end?: number): TextSegment;
+    // (undocumented)
+    protected createSplitSegmentAt(pos: number): TextSegment | undefined;
+    // (undocumented)
+    static fromJSONObject(spec: string | IJSONSegment): TextSegment | undefined;
+    // (undocumented)
+    static is(segment: ISegment): segment is TextSegment;
+    // (undocumented)
+    static make(text: string, props?: PropertySet): TextSegment;
+    // (undocumented)
+    text: string;
+    // (undocumented)
+    toJSONObject(): IJSONTextSegment | string;
+    // (undocumented)
+    toString(): string;
+    // (undocumented)
+    static readonly type = "TextSegment";
+    // (undocumented)
+    readonly type = "TextSegment";
+}
 
-export { TrackingGroup }
+// @beta @legacy (undocumented)
+export class TrackingGroup implements ITrackingGroup {
+    constructor();
+    // (undocumented)
+    has(trackable: Trackable): boolean;
+    // (undocumented)
+    link(trackable: Trackable): void;
+    // (undocumented)
+    get size(): number;
+    // (undocumented)
+    get tracked(): readonly Trackable[];
+    // (undocumented)
+    unlink(trackable: Trackable): boolean;
+}
 
 ```

package/dist/legacy.d.ts

@@ -22,7 +22,7 @@
  */
 
 export {
-	// @legacy APIs
+	// #region @legacyBeta APIs
 	BaseSegment, 
 	DeserializeCallback, 
 	IInterval, 
@@ -68,4 +68,5 @@ export {
 	discardSharedStringRevertibles, 
 	reservedMarkerIdKey, 
 	revertSharedStringRevertibles
+	// #endregion
 } from "./index.js";

package/dist/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/sequence";
-export declare const pkgVersion = "2.60.0";
+export declare const pkgVersion = "2.61.0-355516";
 //# sourceMappingURL=packageVersion.d.ts.map

package/dist/packageVersion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,6BAA6B,CAAC;AAClD,eAAO,MAAM,UAAU,WAAW,CAAC"}
+{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,6BAA6B,CAAC;AAClD,eAAO,MAAM,UAAU,kBAAkB,CAAC"}

package/dist/packageVersion.js

@@ -8,5 +8,5 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.pkgVersion = exports.pkgName = void 0;
 exports.pkgName = "@fluidframework/sequence";
-exports.pkgVersion = "2.60.0";
+exports.pkgVersion = "2.61.0-355516";
 //# sourceMappingURL=packageVersion.js.map

package/dist/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,0BAA0B,CAAC;AACrC,QAAA,UAAU,GAAG,QAAQ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/sequence\";\nexport const pkgVersion = \"2.60.0\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":";AAAA;;;;;GAKG;;;AAEU,QAAA,OAAO,GAAG,0BAA0B,CAAC;AACrC,QAAA,UAAU,GAAG,eAAe,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/sequence\";\nexport const pkgVersion = \"2.61.0-355516\";\n"]}

package/lib/legacy.d.ts

@@ -22,7 +22,7 @@
  */
 
 export {
-	// @legacy APIs
+	// #region @legacyBeta APIs
 	BaseSegment, 
 	DeserializeCallback, 
 	IInterval, 
@@ -68,4 +68,5 @@ export {
 	discardSharedStringRevertibles, 
 	reservedMarkerIdKey, 
 	revertSharedStringRevertibles
+	// #endregion
 } from "./index.js";

package/lib/packageVersion.d.ts

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export declare const pkgName = "@fluidframework/sequence";
-export declare const pkgVersion = "2.60.0";
+export declare const pkgVersion = "2.61.0-355516";
 //# sourceMappingURL=packageVersion.d.ts.map

package/lib/packageVersion.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,6BAA6B,CAAC;AAClD,eAAO,MAAM,UAAU,WAAW,CAAC"}
+{"version":3,"file":"packageVersion.d.ts","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,eAAO,MAAM,OAAO,6BAA6B,CAAC;AAClD,eAAO,MAAM,UAAU,kBAAkB,CAAC"}

package/lib/packageVersion.js

@@ -5,5 +5,5 @@
  * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
  */
 export const pkgName = "@fluidframework/sequence";
-export const pkgVersion = "2.60.0";
+export const pkgVersion = "2.61.0-355516";
 //# sourceMappingURL=packageVersion.js.map

package/lib/packageVersion.js.map

@@ -1 +1 @@
-{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,0BAA0B,CAAC;AAClD,MAAM,CAAC,MAAM,UAAU,GAAG,QAAQ,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/sequence\";\nexport const pkgVersion = \"2.60.0\";\n"]}
+{"version":3,"file":"packageVersion.js","sourceRoot":"","sources":["../src/packageVersion.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,MAAM,CAAC,MAAM,OAAO,GAAG,0BAA0B,CAAC;AAClD,MAAM,CAAC,MAAM,UAAU,GAAG,eAAe,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n *\n * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY\n */\n\nexport const pkgName = \"@fluidframework/sequence\";\nexport const pkgVersion = \"2.61.0-355516\";\n"]}

package/lib/tsdoc-metadata.json

@@ -5,7 +5,7 @@
   "toolPackages": [
     {
       "packageName": "@microsoft/api-extractor",
-      "packageVersion": "7.52.8"
+      "packageVersion": "7.52.11"
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/sequence",
-  "version": "2.60.0",
+  "version": "2.61.0-355516",
   "description": "Distributed sequence",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -91,39 +91,39 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.60.0",
-    "@fluidframework/core-interfaces": "~2.60.0",
-    "@fluidframework/core-utils": "~2.60.0",
-    "@fluidframework/datastore-definitions": "~2.60.0",
-    "@fluidframework/driver-definitions": "~2.60.0",
-    "@fluidframework/merge-tree": "~2.60.0",
-    "@fluidframework/runtime-definitions": "~2.60.0",
-    "@fluidframework/runtime-utils": "~2.60.0",
-    "@fluidframework/shared-object-base": "~2.60.0",
-    "@fluidframework/telemetry-utils": "~2.60.0",
+    "@fluid-internal/client-utils": "2.61.0-355516",
+    "@fluidframework/core-interfaces": "2.61.0-355516",
+    "@fluidframework/core-utils": "2.61.0-355516",
+    "@fluidframework/datastore-definitions": "2.61.0-355516",
+    "@fluidframework/driver-definitions": "2.61.0-355516",
+    "@fluidframework/merge-tree": "2.61.0-355516",
+    "@fluidframework/runtime-definitions": "2.61.0-355516",
+    "@fluidframework/runtime-utils": "2.61.0-355516",
+    "@fluidframework/shared-object-base": "2.61.0-355516",
+    "@fluidframework/telemetry-utils": "2.61.0-355516",
     "double-ended-queue": "^2.1.0-0",
     "uuid": "^11.1.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "~2.60.0",
-    "@fluid-private/stochastic-test-utils": "~2.60.0",
-    "@fluid-private/test-dds-utils": "~2.60.0",
+    "@fluid-internal/mocha-test-setup": "2.61.0-355516",
+    "@fluid-private/stochastic-test-utils": "2.61.0-355516",
+    "@fluid-private/test-dds-utils": "2.61.0-355516",
     "@fluid-tools/benchmark": "^0.51.0",
-    "@fluid-tools/build-cli": "^0.57.0",
+    "@fluid-tools/build-cli": "^0.58.1",
     "@fluidframework/build-common": "^2.0.3",
-    "@fluidframework/build-tools": "^0.57.0",
-    "@fluidframework/container-definitions": "~2.60.0",
+    "@fluidframework/build-tools": "^0.58.1",
+    "@fluidframework/container-definitions": "2.61.0-355516",
     "@fluidframework/eslint-config-fluid": "^6.0.0",
-    "@fluidframework/sequence-previous": "npm:@fluidframework/sequence@2.53.0",
-    "@fluidframework/test-runtime-utils": "~2.60.0",
-    "@microsoft/api-extractor": "7.52.8",
+    "@fluidframework/sequence-previous": "npm:@fluidframework/sequence@2.60.0",
+    "@fluidframework/test-runtime-utils": "2.61.0-355516",
+    "@microsoft/api-extractor": "7.52.11",
     "@types/diff": "^3.5.1",
     "@types/double-ended-queue": "^2.1.0",
     "@types/mocha": "^10.0.10",
     "@types/node": "^18.19.0",
-    "c8": "^8.0.1",
+    "c8": "^10.1.3",
     "concurrently": "^8.2.1",
     "copyfiles": "^2.4.1",
     "cross-env": "^7.0.3",
@@ -144,30 +144,13 @@
     }
   },
   "typeValidation": {
-    "broken": {
-      "Interface_IInterval": {
-        "backCompat": false
-      },
-      "Interface_ISerializableInterval": {
-        "backCompat": false,
-        "forwardCompat": false
-      },
-      "Interface_SequenceInterval": {
-        "backCompat": false
-      },
-      "TypeAlias_IntervalRevertible": {
-        "backCompat": false
-      },
-      "TypeAlias_SharedStringRevertible": {
-        "backCompat": false
-      }
-    },
+    "broken": {},
     "entrypoint": "legacy"
   },
   "scripts": {
     "api": "fluid-build . --task api",
-    "api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
-    "api-extractor:esnext": "flub generate entrypoints --outDir ./lib --node10TypeCompat",
+    "api-extractor:commonjs": "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./dist",
+    "api-extractor:esnext": "flub generate entrypoints --outFileLegacyBeta legacy --outDir ./lib --node10TypeCompat",
     "build": "fluid-build . --task build",
     "build:api-reports": "concurrently \"npm:build:api-reports:*\"",
     "build:api-reports:current": "api-extractor run --local --config api-extractor/api-extractor.current.json",
@@ -209,10 +192,10 @@
     "test:memory": "mocha --config src/test/memory/.mocharc.cjs",
     "test:memory-profiling:report": "mocha --config src/test/memory/.mocharc.cjs",
     "test:mocha": "npm run test:mocha:esm && echo skipping cjs to avoid overhead - npm run test:mocha:cjs",
-    "test:mocha:cjs": "mocha --ignore \"dist/test/memory/**/*\" --recursive \"dist/test/**/*.spec.*js\"",
-    "test:mocha:esm": "mocha --ignore \"lib/test/memory/**/*\" --recursive \"lib/test/**/*.spec.*js\"",
+    "test:mocha:cjs": "cross-env MOCHA_SPEC=dist/test mocha",
+    "test:mocha:esm": "mocha",
     "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
-    "test:newsnapfiles": "node --conditions=allow-ff-test-exports lib/test/createSnapshotFiles.js",
+    "test:newsnapfiles": "node --conditions=allow-ff-test-exports lib/test/createSnapshotFiles.tool.js",
     "test:stress": "cross-env FUZZ_TEST_COUNT=100 FUZZ_STRESS_RUN=normal 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": "flub generate typetests --dir . -v",

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/sequence";
-export const pkgVersion = "2.60.0";
+export const pkgVersion = "2.61.0-355516";