@fluidframework/tree 2.0.0-dev-rc.1.0.0.224419

package/lib/shared-tree-core/editManagerFormat.d.ts

@@ -0,0 +1,68 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { TSchema } from "@sinclair/typebox";
+import { Brand } from "../util";
+import { SessionId, RevisionTag, EncodedRevisionTag } from "../core";
+/**
+ * Contains a single change to the `SharedTree` and associated metadata.
+ */
+export interface Commit<TChangeset> {
+    readonly revision: RevisionTag;
+    readonly change: TChangeset;
+    /** An identifier representing the session/user/client that made this commit */
+    readonly sessionId: SessionId;
+}
+export type EncodedCommit<TChangeset> = {
+    readonly revision: EncodedRevisionTag;
+    readonly change: TChangeset;
+    readonly sessionId: SessionId;
+};
+export type SeqNumber = Brand<number, "edit-manager.SeqNumber">;
+export interface SequenceId {
+    readonly sequenceNumber: SeqNumber;
+    readonly indexInBatch?: number;
+}
+export declare const sequenceIdComparator: (a: SequenceId, b: SequenceId) => number;
+export declare const equalSequenceIds: (a: SequenceId, b: SequenceId) => boolean;
+export declare const minSequenceId: (a: SequenceId, b: SequenceId) => SequenceId;
+export declare const maxSequenceId: (a: SequenceId, b: SequenceId) => SequenceId;
+export declare const decrementSequenceId: (sequenceId: SequenceId) => SequenceId;
+/**
+ * A commit with a sequence number but no parentage; used for serializing the `EditManager` into a summary
+ */
+export interface SequencedCommit<TChangeset> extends Commit<TChangeset> {
+    sequenceNumber: SeqNumber;
+    indexInBatch?: number;
+}
+/**
+ * A branch off of the trunk for use in summaries
+ */
+export interface SummarySessionBranch<TChangeset> {
+    readonly base: RevisionTag;
+    readonly commits: Commit<TChangeset>[];
+}
+export interface EncodedEditManager<TChangeset> {
+    readonly trunk: readonly Readonly<SequencedCommit<TChangeset>>[];
+    readonly branches: readonly [SessionId, Readonly<SummarySessionBranch<TChangeset>>][];
+}
+export declare const EncodedEditManager: <ChangeSchema extends TSchema>(tChange: ChangeSchema) => import("@sinclair/typebox").TObject<{
+    trunk: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<import("@sinclair/typebox").TCompositeReduce<[import("@sinclair/typebox").TObject<{
+        revision: import("@sinclair/typebox").TUnsafe<EncodedRevisionTag>;
+        change: ChangeSchema;
+        sessionId: import("@sinclair/typebox").TUnsafe<string>;
+    }>, import("@sinclair/typebox").TObject<{
+        sequenceNumber: import("@sinclair/typebox").TUnsafe<SeqNumber>;
+        indexInBatch: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    }>]>>>;
+    branches: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TTuple<[import("@sinclair/typebox").TUnsafe<string>, import("@sinclair/typebox").TObject<{
+        base: import("@sinclair/typebox").TUnsafe<EncodedRevisionTag>;
+        commits: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<import("@sinclair/typebox").TCompositeReduce<[import("@sinclair/typebox").TObject<{
+            revision: import("@sinclair/typebox").TUnsafe<EncodedRevisionTag>;
+            change: ChangeSchema;
+            sessionId: import("@sinclair/typebox").TUnsafe<string>;
+        }>]>>>;
+    }>]>>;
+}>;
+//# sourceMappingURL=editManagerFormat.d.ts.map

package/lib/shared-tree-core/editManagerFormat.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"editManagerFormat.d.ts","sourceRoot":"","sources":["../../src/shared-tree-core/editManagerFormat.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,OAAO,EAAuB,MAAM,mBAAmB,CAAC;AACjE,OAAO,EAAE,KAAK,EAA4B,MAAM,SAAS,CAAC;AAC1D,OAAO,EACN,SAAS,EAET,WAAW,EAEX,kBAAkB,EAClB,MAAM,SAAS,CAAC;AAEjB;;GAEG;AACH,MAAM,WAAW,MAAM,CAAC,UAAU;IACjC,QAAQ,CAAC,QAAQ,EAAE,WAAW,CAAC;IAC/B,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;IAC5B,+EAA+E;IAC/E,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;CAC9B;AAGD,MAAM,MAAM,aAAa,CAAC,UAAU,IAAI;IACvC,QAAQ,CAAC,QAAQ,EAAE,kBAAkB,CAAC;IACtC,QAAQ,CAAC,MAAM,EAAE,UAAU,CAAC;IAC5B,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;CAC9B,CAAC;AAiBF,MAAM,MAAM,SAAS,GAAG,KAAK,CAAC,MAAM,EAAE,wBAAwB,CAAC,CAAC;AAGhE,MAAM,WAAW,UAAU;IAC1B,QAAQ,CAAC,cAAc,EAAE,SAAS,CAAC;IACnC,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC;CAC/B;AACD,eAAO,MAAM,oBAAoB,MAAO,UAAU,KAAK,UAAU,WAGhB,CAAC;AAClD,eAAO,MAAM,gBAAgB,MAAO,UAAU,KAAK,UAAU,YAAqC,CAAC;AACnG,eAAO,MAAM,aAAa,MAAO,UAAU,KAAK,UAAU,eACnB,CAAC;AACxC,eAAO,MAAM,aAAa,MAAO,UAAU,KAAK,UAAU,eACnB,CAAC;AACxC,eAAO,MAAM,mBAAmB,eAAgB,UAAU,KAAG,UAO5D,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,eAAe,CAAC,UAAU,CAAE,SAAQ,MAAM,CAAC,UAAU,CAAC;IACtE,cAAc,EAAE,SAAS,CAAC;IAC1B,YAAY,CAAC,EAAE,MAAM,CAAC;CACtB;AAaD;;GAEG;AACH,MAAM,WAAW,oBAAoB,CAAC,UAAU;IAC/C,QAAQ,CAAC,IAAI,EAAE,WAAW,CAAC;IAC3B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC,UAAU,CAAC,EAAE,CAAC;CACvC;AAUD,MAAM,WAAW,kBAAkB,CAAC,UAAU;IAC7C,QAAQ,CAAC,KAAK,EAAE,SAAS,QAAQ,CAAC,eAAe,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC;IACjE,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC,SAAS,EAAE,QAAQ,CAAC,oBAAoB,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,CAAC;CACtF;AACD,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;EAO7B,CAAC"}

package/lib/shared-tree-core/editManagerFormat.js

@@ -0,0 +1,49 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { Type } from "@sinclair/typebox";
+import { brand, brandedNumberType } from "../util";
+import { SessionIdSchema, RevisionTagSchema, } from "../core";
+const noAdditionalProps = { additionalProperties: false };
+const CommitBase = (tChange) => Type.Object({
+    revision: RevisionTagSchema,
+    change: tChange,
+    sessionId: SessionIdSchema,
+});
+/**
+ * @privateRemarks Commits are generally encoded from `GraphCommit`s, which often contain extra data.
+ * This `noAdditionalProps` is especially important in that light.
+ */
+const Commit = (tChange) => Type.Composite([CommitBase(tChange)], noAdditionalProps);
+const SeqNumber = brandedNumberType();
+export const sequenceIdComparator = (a, b) => a.sequenceNumber !== b.sequenceNumber
+    ? a.sequenceNumber - b.sequenceNumber
+    : (a.indexInBatch ?? 0) - (b.indexInBatch ?? 0);
+export const equalSequenceIds = (a, b) => sequenceIdComparator(a, b) === 0;
+export const minSequenceId = (a, b) => sequenceIdComparator(a, b) < 0 ? a : b;
+export const maxSequenceId = (a, b) => sequenceIdComparator(a, b) > 0 ? a : b;
+export const decrementSequenceId = (sequenceId) => {
+    return sequenceId.indexInBatch !== undefined
+        ? {
+            sequenceNumber: brand(sequenceId.sequenceNumber),
+            indexInBatch: sequenceId.indexInBatch - 1,
+        }
+        : { sequenceNumber: brand(sequenceId.sequenceNumber - 1) };
+};
+const SequencedCommit = (tChange) => Type.Composite([
+    CommitBase(tChange),
+    Type.Object({
+        sequenceNumber: SeqNumber,
+        indexInBatch: Type.Optional(Type.Number()),
+    }),
+], noAdditionalProps);
+const SummarySessionBranch = (tChange) => Type.Object({
+    base: RevisionTagSchema,
+    commits: Type.Array(Commit(tChange)),
+}, noAdditionalProps);
+export const EncodedEditManager = (tChange) => Type.Object({
+    trunk: Type.Array(SequencedCommit(tChange)),
+    branches: Type.Array(Type.Tuple([SessionIdSchema, SummarySessionBranch(tChange)])),
+}, noAdditionalProps);
+//# sourceMappingURL=editManagerFormat.js.map

package/lib/shared-tree-core/editManagerFormat.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"editManagerFormat.js","sourceRoot":"","sources":["../../src/shared-tree-core/editManagerFormat.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAW,IAAI,EAAiB,MAAM,mBAAmB,CAAC;AACjE,OAAO,EAAS,KAAK,EAAE,iBAAiB,EAAE,MAAM,SAAS,CAAC;AAC1D,OAAO,EAEN,eAAe,EAEf,iBAAiB,GAEjB,MAAM,SAAS,CAAC;AAmBjB,MAAM,iBAAiB,GAAkB,EAAE,oBAAoB,EAAE,KAAK,EAAE,CAAC;AAEzE,MAAM,UAAU,GAAG,CAA+B,OAAqB,EAAE,EAAE,CAC1E,IAAI,CAAC,MAAM,CAAC;IACX,QAAQ,EAAE,iBAAiB;IAC3B,MAAM,EAAE,OAAO;IACf,SAAS,EAAE,eAAe;CAC1B,CAAC,CAAC;AACJ;;;GAGG;AACH,MAAM,MAAM,GAAG,CAA+B,OAAqB,EAAE,EAAE,CACtE,IAAI,CAAC,SAAS,CAAC,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC,EAAE,iBAAiB,CAAC,CAAC;AAG1D,MAAM,SAAS,GAAG,iBAAiB,EAAa,CAAC;AAMjD,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAa,EAAE,CAAa,EAAE,EAAE,CACpE,CAAC,CAAC,cAAc,KAAK,CAAC,CAAC,cAAc;IACpC,CAAC,CAAC,CAAC,CAAC,cAAc,GAAG,CAAC,CAAC,cAAc;IACrC,CAAC,CAAC,CAAC,CAAC,CAAC,YAAY,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,YAAY,IAAI,CAAC,CAAC,CAAC;AAClD,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,CAAa,EAAE,CAAa,EAAE,EAAE,CAAC,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC;AACnG,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAa,EAAE,CAAa,EAAE,EAAE,CAC7D,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACxC,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,CAAa,EAAE,CAAa,EAAE,EAAE,CAC7D,oBAAoB,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACxC,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,UAAsB,EAAc,EAAE;IACzE,OAAO,UAAU,CAAC,YAAY,KAAK,SAAS;QAC3C,CAAC,CAAC;YACA,cAAc,EAAE,KAAK,CAAC,UAAU,CAAC,cAAc,CAAC;YAChD,YAAY,EAAE,UAAU,CAAC,YAAY,GAAG,CAAC;SACxC;QACH,CAAC,CAAC,EAAE,cAAc,EAAE,KAAK,CAAC,UAAU,CAAC,cAAc,GAAG,CAAC,CAAC,EAAE,CAAC;AAC7D,CAAC,CAAC;AASF,MAAM,eAAe,GAAG,CAA+B,OAAqB,EAAE,EAAE,CAC/E,IAAI,CAAC,SAAS,CACb;IACC,UAAU,CAAC,OAAO,CAAC;IACnB,IAAI,CAAC,MAAM,CAAC;QACX,cAAc,EAAE,SAAS;QACzB,YAAY,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC;KAC1C,CAAC;CACF,EACD,iBAAiB,CACjB,CAAC;AASH,MAAM,oBAAoB,GAAG,CAA+B,OAAqB,EAAE,EAAE,CACpF,IAAI,CAAC,MAAM,CACV;IACC,IAAI,EAAE,iBAAiB;IACvB,OAAO,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;CACpC,EACD,iBAAiB,CACjB,CAAC;AAMH,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAA+B,OAAqB,EAAE,EAAE,CACzF,IAAI,CAAC,MAAM,CACV;IACC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC;IAC3C,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,eAAe,EAAE,oBAAoB,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;CAClF,EACD,iBAAiB,CACjB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { TSchema, Type, ObjectOptions } from \"@sinclair/typebox\";\nimport { Brand, brand, brandedNumberType } from \"../util\";\nimport {\n\tSessionId,\n\tSessionIdSchema,\n\tRevisionTag,\n\tRevisionTagSchema,\n\tEncodedRevisionTag,\n} from \"../core\";\n\n/**\n * Contains a single change to the `SharedTree` and associated metadata.\n */\nexport interface Commit<TChangeset> {\n\treadonly revision: RevisionTag;\n\treadonly change: TChangeset;\n\t/** An identifier representing the session/user/client that made this commit */\n\treadonly sessionId: SessionId;\n}\n\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\nexport type EncodedCommit<TChangeset> = {\n\treadonly revision: EncodedRevisionTag;\n\treadonly change: TChangeset;\n\treadonly sessionId: SessionId;\n};\n\nconst noAdditionalProps: ObjectOptions = { additionalProperties: false };\n\nconst CommitBase = <ChangeSchema extends TSchema>(tChange: ChangeSchema) =>\n\tType.Object({\n\t\trevision: RevisionTagSchema,\n\t\tchange: tChange,\n\t\tsessionId: SessionIdSchema,\n\t});\n/**\n * @privateRemarks Commits are generally encoded from `GraphCommit`s, which often contain extra data.\n * This `noAdditionalProps` is especially important in that light.\n */\nconst Commit = <ChangeSchema extends TSchema>(tChange: ChangeSchema) =>\n\tType.Composite([CommitBase(tChange)], noAdditionalProps);\n\nexport type SeqNumber = Brand<number, \"edit-manager.SeqNumber\">;\nconst SeqNumber = brandedNumberType<SeqNumber>();\n\nexport interface SequenceId {\n\treadonly sequenceNumber: SeqNumber;\n\treadonly indexInBatch?: number;\n}\nexport const sequenceIdComparator = (a: SequenceId, b: SequenceId) =>\n\ta.sequenceNumber !== b.sequenceNumber\n\t\t? a.sequenceNumber - b.sequenceNumber\n\t\t: (a.indexInBatch ?? 0) - (b.indexInBatch ?? 0);\nexport const equalSequenceIds = (a: SequenceId, b: SequenceId) => sequenceIdComparator(a, b) === 0;\nexport const minSequenceId = (a: SequenceId, b: SequenceId) =>\n\tsequenceIdComparator(a, b) < 0 ? a : b;\nexport const maxSequenceId = (a: SequenceId, b: SequenceId) =>\n\tsequenceIdComparator(a, b) > 0 ? a : b;\nexport const decrementSequenceId = (sequenceId: SequenceId): SequenceId => {\n\treturn sequenceId.indexInBatch !== undefined\n\t\t? {\n\t\t\t\tsequenceNumber: brand(sequenceId.sequenceNumber),\n\t\t\t\tindexInBatch: sequenceId.indexInBatch - 1,\n\t\t  }\n\t\t: { sequenceNumber: brand(sequenceId.sequenceNumber - 1) };\n};\n\n/**\n * A commit with a sequence number but no parentage; used for serializing the `EditManager` into a summary\n */\nexport interface SequencedCommit<TChangeset> extends Commit<TChangeset> {\n\tsequenceNumber: SeqNumber;\n\tindexInBatch?: number;\n}\nconst SequencedCommit = <ChangeSchema extends TSchema>(tChange: ChangeSchema) =>\n\tType.Composite(\n\t\t[\n\t\t\tCommitBase(tChange),\n\t\t\tType.Object({\n\t\t\t\tsequenceNumber: SeqNumber,\n\t\t\t\tindexInBatch: Type.Optional(Type.Number()),\n\t\t\t}),\n\t\t],\n\t\tnoAdditionalProps,\n\t);\n\n/**\n * A branch off of the trunk for use in summaries\n */\nexport interface SummarySessionBranch<TChangeset> {\n\treadonly base: RevisionTag;\n\treadonly commits: Commit<TChangeset>[];\n}\nconst SummarySessionBranch = <ChangeSchema extends TSchema>(tChange: ChangeSchema) =>\n\tType.Object(\n\t\t{\n\t\t\tbase: RevisionTagSchema,\n\t\t\tcommits: Type.Array(Commit(tChange)),\n\t\t},\n\t\tnoAdditionalProps,\n\t);\n\nexport interface EncodedEditManager<TChangeset> {\n\treadonly trunk: readonly Readonly<SequencedCommit<TChangeset>>[];\n\treadonly branches: readonly [SessionId, Readonly<SummarySessionBranch<TChangeset>>][];\n}\nexport const EncodedEditManager = <ChangeSchema extends TSchema>(tChange: ChangeSchema) =>\n\tType.Object(\n\t\t{\n\t\t\ttrunk: Type.Array(SequencedCommit(tChange)),\n\t\t\tbranches: Type.Array(Type.Tuple([SessionIdSchema, SummarySessionBranch(tChange)])),\n\t\t},\n\t\tnoAdditionalProps,\n\t);\n"]}

package/lib/shared-tree-core/editManagerSummarizer.d.ts

@@ -0,0 +1,25 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IChannelStorageService } from "@fluidframework/datastore-definitions";
+import { IGarbageCollectionData, ISummaryTreeWithStats, ITelemetryContext } from "@fluidframework/runtime-definitions";
+import { ICodecOptions, IJsonCodec } from "../codec";
+import { ChangeFamily, ChangeFamilyEditor, EncodedRevisionTag, RevisionTag } from "../core";
+import { Summarizable, SummaryElementParser, SummaryElementStringifier } from "./sharedTreeCore";
+import { EditManager } from "./editManager";
+/**
+ * Provides methods for summarizing and loading an `EditManager`
+ */
+export declare class EditManagerSummarizer<TChangeset> implements Summarizable {
+    private readonly editManager;
+    readonly key = "EditManager";
+    private readonly codec;
+    constructor(editManager: EditManager<ChangeFamilyEditor, TChangeset, ChangeFamily<ChangeFamilyEditor, TChangeset>>, revisionTagCodec: IJsonCodec<RevisionTag, EncodedRevisionTag>, options: ICodecOptions);
+    getAttachSummary(stringify: SummaryElementStringifier, fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): ISummaryTreeWithStats;
+    summarize(stringify: SummaryElementStringifier, fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): Promise<ISummaryTreeWithStats>;
+    private summarizeCore;
+    getGCData(fullGC?: boolean): IGarbageCollectionData;
+    load(services: IChannelStorageService, parse: SummaryElementParser): Promise<void>;
+}
+//# sourceMappingURL=editManagerSummarizer.d.ts.map

package/lib/shared-tree-core/editManagerSummarizer.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"editManagerSummarizer.d.ts","sourceRoot":"","sources":["../../src/shared-tree-core/editManagerSummarizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,sBAAsB,EAAE,MAAM,uCAAuC,CAAC;AAC/E,OAAO,EACN,sBAAsB,EACtB,qBAAqB,EACrB,iBAAiB,EACjB,MAAM,qCAAqC,CAAC;AAE7C,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAE5F,OAAO,EAAE,YAAY,EAAE,oBAAoB,EAAE,yBAAyB,EAAE,MAAM,kBAAkB,CAAC;AACjG,OAAO,EAAE,WAAW,EAAe,MAAM,eAAe,CAAC;AAOzD;;GAEG;AACH,qBAAa,qBAAqB,CAAC,UAAU,CAAE,YAAW,YAAY;IAUpE,OAAO,CAAC,QAAQ,CAAC,WAAW;IAT7B,SAAgB,GAAG,iBAAiB;IAOpC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAsC;gBAE1C,WAAW,EAAE,WAAW,CACxC,kBAAkB,EAClB,UAAU,EACV,YAAY,CAAC,kBAAkB,EAAE,UAAU,CAAC,CAC5C,EACD,gBAAgB,EAAE,UAAU,CAAC,WAAW,EAAE,kBAAkB,CAAC,EAC7D,OAAO,EAAE,aAAa;IAMhB,gBAAgB,CACtB,SAAS,EAAE,yBAAyB,EACpC,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,qBAAqB;IAIX,SAAS,CACrB,SAAS,EAAE,yBAAyB,EACpC,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,OAAO,CAAC,qBAAqB,CAAC;IAIjC,OAAO,CAAC,aAAa;IAMd,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,sBAAsB;IAU7C,IAAI,CAChB,QAAQ,EAAE,sBAAsB,EAChC,KAAK,EAAE,oBAAoB,GACzB,OAAO,CAAC,IAAI,CAAC;CAehB"}

package/lib/shared-tree-core/editManagerSummarizer.js

@@ -0,0 +1,52 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { bufferToString } from "@fluid-internal/client-utils";
+import { assert } from "@fluidframework/core-utils";
+import { createSingleBlobSummary } from "@fluidframework/shared-object-base";
+import { makeEditManagerCodec } from "./editManagerCodecs";
+const stringKey = "String";
+const formatVersion = 0;
+/**
+ * Provides methods for summarizing and loading an `EditManager`
+ */
+export class EditManagerSummarizer {
+    constructor(editManager, revisionTagCodec, options) {
+        this.editManager = editManager;
+        this.key = "EditManager";
+        const changesetCodec = this.editManager.changeFamily.codecs.resolve(formatVersion);
+        this.codec = makeEditManagerCodec(changesetCodec, revisionTagCodec, options);
+    }
+    getAttachSummary(stringify, fullTree, trackState, telemetryContext) {
+        return this.summarizeCore(stringify);
+    }
+    async summarize(stringify, fullTree, trackState, telemetryContext) {
+        return this.summarizeCore(stringify);
+    }
+    summarizeCore(stringify) {
+        const jsonCompatible = this.codec.encode(this.editManager.getSummaryData());
+        const dataString = stringify(jsonCompatible);
+        return createSingleBlobSummary(stringKey, dataString);
+    }
+    getGCData(fullGC) {
+        // TODO: Properly implement garbage collection. Right now, garbage collection is performed automatically
+        // by the code in SharedObject (from which SharedTreeCore extends). The `runtime.uploadBlob` API delegates
+        // to the `BlobManager`, which automatically populates the summary with ISummaryAttachment entries for each
+        // blob.
+        return {
+            gcNodes: {},
+        };
+    }
+    async load(services, parse) {
+        const schemaBuffer = await services.readBlob(stringKey);
+        // After the awaits, validate that the data is in a clean state.
+        // This detects any data that could have been accidentally added through
+        // invalid means and is about to be overwritten.
+        assert(this.editManager.isEmpty(), 0x42c /* There should not already be stored EditManager data when loading from summary */);
+        const summary = parse(bufferToString(schemaBuffer, "utf-8"));
+        const data = this.codec.decode(summary);
+        this.editManager.loadSummaryData(data);
+    }
+}
+//# sourceMappingURL=editManagerSummarizer.js.map

package/lib/shared-tree-core/editManagerSummarizer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"editManagerSummarizer.js","sourceRoot":"","sources":["../../src/shared-tree-core/editManagerSummarizer.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,cAAc,EAAE,MAAM,8BAA8B,CAAC;AAC9D,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AAOpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,oCAAoC,CAAC;AAM7E,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAE3D,MAAM,SAAS,GAAG,QAAQ,CAAC;AAE3B,MAAM,aAAa,GAAG,CAAC,CAAC;AAExB;;GAEG;AACH,MAAM,OAAO,qBAAqB;IASjC,YACkB,WAIhB,EACD,gBAA6D,EAC7D,OAAsB;QANL,gBAAW,GAAX,WAAW,CAI3B;QAbc,QAAG,GAAG,aAAa,CAAC;QAiBnC,MAAM,cAAc,GAAG,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,aAAa,CAAC,CAAC;QACnF,IAAI,CAAC,KAAK,GAAG,oBAAoB,CAAC,cAAc,EAAE,gBAAgB,EAAE,OAAO,CAAC,CAAC;IAC9E,CAAC;IAEM,gBAAgB,CACtB,SAAoC,EACpC,QAAkB,EAClB,UAAoB,EACpB,gBAAoC;QAEpC,OAAO,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC;IAEM,KAAK,CAAC,SAAS,CACrB,SAAoC,EACpC,QAAkB,EAClB,UAAoB,EACpB,gBAAoC;QAEpC,OAAO,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IACtC,CAAC;IAEO,aAAa,CAAC,SAAoC;QACzD,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,cAAc,EAAE,CAAC,CAAC;QAC5E,MAAM,UAAU,GAAG,SAAS,CAAC,cAAc,CAAC,CAAC;QAC7C,OAAO,uBAAuB,CAAC,SAAS,EAAE,UAAU,CAAC,CAAC;IACvD,CAAC;IAEM,SAAS,CAAC,MAAgB;QAChC,wGAAwG;QACxG,0GAA0G;QAC1G,2GAA2G;QAC3G,QAAQ;QACR,OAAO;YACN,OAAO,EAAE,EAAE;SACX,CAAC;IACH,CAAC;IAEM,KAAK,CAAC,IAAI,CAChB,QAAgC,EAChC,KAA2B;QAE3B,MAAM,YAAY,GAAoB,MAAM,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;QAEzE,gEAAgE;QAChE,wEAAwE;QACxE,gDAAgD;QAChD,MAAM,CACL,IAAI,CAAC,WAAW,CAAC,OAAO,EAAE,EAC1B,KAAK,CAAC,mFAAmF,CACzF,CAAC;QAEF,MAAM,OAAO,GAAG,KAAK,CAAC,cAAc,CAAC,YAAY,EAAE,OAAO,CAAC,CAA2B,CAAC;QACvF,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC;QACxC,IAAI,CAAC,WAAW,CAAC,eAAe,CAAC,IAAI,CAAC,CAAC;IACxC,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { bufferToString } from \"@fluid-internal/client-utils\";\nimport { assert } from \"@fluidframework/core-utils\";\nimport { IChannelStorageService } from \"@fluidframework/datastore-definitions\";\nimport {\n\tIGarbageCollectionData,\n\tISummaryTreeWithStats,\n\tITelemetryContext,\n} from \"@fluidframework/runtime-definitions\";\nimport { createSingleBlobSummary } from \"@fluidframework/shared-object-base\";\nimport { ICodecOptions, IJsonCodec } from \"../codec\";\nimport { ChangeFamily, ChangeFamilyEditor, EncodedRevisionTag, RevisionTag } from \"../core\";\nimport { JsonCompatibleReadOnly } from \"../util\";\nimport { Summarizable, SummaryElementParser, SummaryElementStringifier } from \"./sharedTreeCore\";\nimport { EditManager, SummaryData } from \"./editManager\";\nimport { makeEditManagerCodec } from \"./editManagerCodecs\";\n\nconst stringKey = \"String\";\n\nconst formatVersion = 0;\n\n/**\n * Provides methods for summarizing and loading an `EditManager`\n */\nexport class EditManagerSummarizer<TChangeset> implements Summarizable {\n\tpublic readonly key = \"EditManager\";\n\n\t// Note: since there is only one format, this can just be cached on the class.\n\t// With more write formats active, it may make sense to keep around the \"usual\" format codec\n\t// (the one for the current persisted configuration) and resolve codecs for different versions\n\t// as necessary (e.g. an upgrade op came in, or the configuration changed within the collab window\n\t// and an op needs to be interpreted which isn't written with the current configuration).\n\tprivate readonly codec: IJsonCodec<SummaryData<TChangeset>>;\n\tpublic constructor(\n\t\tprivate readonly editManager: EditManager<\n\t\t\tChangeFamilyEditor,\n\t\t\tTChangeset,\n\t\t\tChangeFamily<ChangeFamilyEditor, TChangeset>\n\t\t>,\n\t\trevisionTagCodec: IJsonCodec<RevisionTag, EncodedRevisionTag>,\n\t\toptions: ICodecOptions,\n\t) {\n\t\tconst changesetCodec = this.editManager.changeFamily.codecs.resolve(formatVersion);\n\t\tthis.codec = makeEditManagerCodec(changesetCodec, revisionTagCodec, options);\n\t}\n\n\tpublic getAttachSummary(\n\t\tstringify: SummaryElementStringifier,\n\t\tfullTree?: boolean,\n\t\ttrackState?: boolean,\n\t\ttelemetryContext?: ITelemetryContext,\n\t): ISummaryTreeWithStats {\n\t\treturn this.summarizeCore(stringify);\n\t}\n\n\tpublic async summarize(\n\t\tstringify: SummaryElementStringifier,\n\t\tfullTree?: boolean,\n\t\ttrackState?: boolean,\n\t\ttelemetryContext?: ITelemetryContext,\n\t): Promise<ISummaryTreeWithStats> {\n\t\treturn this.summarizeCore(stringify);\n\t}\n\n\tprivate summarizeCore(stringify: SummaryElementStringifier): ISummaryTreeWithStats {\n\t\tconst jsonCompatible = this.codec.encode(this.editManager.getSummaryData());\n\t\tconst dataString = stringify(jsonCompatible);\n\t\treturn createSingleBlobSummary(stringKey, dataString);\n\t}\n\n\tpublic getGCData(fullGC?: boolean): IGarbageCollectionData {\n\t\t// TODO: Properly implement garbage collection. Right now, garbage collection is performed automatically\n\t\t// by the code in SharedObject (from which SharedTreeCore extends). The `runtime.uploadBlob` API delegates\n\t\t// to the `BlobManager`, which automatically populates the summary with ISummaryAttachment entries for each\n\t\t// blob.\n\t\treturn {\n\t\t\tgcNodes: {},\n\t\t};\n\t}\n\n\tpublic async load(\n\t\tservices: IChannelStorageService,\n\t\tparse: SummaryElementParser,\n\t): Promise<void> {\n\t\tconst schemaBuffer: ArrayBufferLike = await services.readBlob(stringKey);\n\n\t\t// After the awaits, validate that the data is in a clean state.\n\t\t// This detects any data that could have been accidentally added through\n\t\t// invalid means and is about to be overwritten.\n\t\tassert(\n\t\t\tthis.editManager.isEmpty(),\n\t\t\t0x42c /* There should not already be stored EditManager data when loading from summary */,\n\t\t);\n\n\t\tconst summary = parse(bufferToString(schemaBuffer, \"utf-8\")) as JsonCompatibleReadOnly;\n\t\tconst data = this.codec.decode(summary);\n\t\tthis.editManager.loadSummaryData(data);\n\t}\n}\n"]}

package/lib/shared-tree-core/index.d.ts

@@ -0,0 +1,13 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { onForkTransitive, SharedTreeBranch, SharedTreeBranchChange, SharedTreeBranchEvents, getChangeReplaceType, } from "./branch";
+export { SharedTreeCore, Summarizable, SummaryElementParser, SummaryElementStringifier, } from "./sharedTreeCore";
+export { TransactionStack } from "./transactionStack";
+export { makeEditManagerCodec } from "./editManagerCodecs";
+export { EditManagerSummarizer } from "./editManagerSummarizer";
+export { EditManager, minimumPossibleSequenceNumber, SummaryData } from "./editManager";
+export { Commit, SeqNumber, SequencedCommit, SummarySessionBranch, EncodedCommit, } from "./editManagerFormat";
+export { RevisionTagCodec } from "./revisionTagCodecs";
+//# sourceMappingURL=index.d.ts.map

package/lib/shared-tree-core/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/shared-tree-core/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EACN,gBAAgB,EAChB,gBAAgB,EAChB,sBAAsB,EACtB,sBAAsB,EACtB,oBAAoB,GACpB,MAAM,UAAU,CAAC;AAElB,OAAO,EACN,cAAc,EACd,YAAY,EACZ,oBAAoB,EACpB,yBAAyB,GACzB,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,6BAA6B,EAAE,WAAW,EAAE,MAAM,eAAe,CAAC;AACxF,OAAO,EACN,MAAM,EACN,SAAS,EACT,eAAe,EACf,oBAAoB,EACpB,aAAa,GACb,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC"}

package/lib/shared-tree-core/index.js

@@ -0,0 +1,12 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export { onForkTransitive, SharedTreeBranch, getChangeReplaceType, } from "./branch";
+export { SharedTreeCore, } from "./sharedTreeCore";
+export { TransactionStack } from "./transactionStack";
+export { makeEditManagerCodec } from "./editManagerCodecs";
+export { EditManagerSummarizer } from "./editManagerSummarizer";
+export { EditManager, minimumPossibleSequenceNumber } from "./editManager";
+export { RevisionTagCodec } from "./revisionTagCodecs";
+//# sourceMappingURL=index.js.map

package/lib/shared-tree-core/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/shared-tree-core/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EACN,gBAAgB,EAChB,gBAAgB,EAGhB,oBAAoB,GACpB,MAAM,UAAU,CAAC;AAElB,OAAO,EACN,cAAc,GAId,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,EAAE,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3D,OAAO,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAC;AAChE,OAAO,EAAE,WAAW,EAAE,6BAA6B,EAAe,MAAM,eAAe,CAAC;AAQxF,OAAO,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\nexport {\n\tonForkTransitive,\n\tSharedTreeBranch,\n\tSharedTreeBranchChange,\n\tSharedTreeBranchEvents,\n\tgetChangeReplaceType,\n} from \"./branch\";\n\nexport {\n\tSharedTreeCore,\n\tSummarizable,\n\tSummaryElementParser,\n\tSummaryElementStringifier,\n} from \"./sharedTreeCore\";\n\nexport { TransactionStack } from \"./transactionStack\";\n\nexport { makeEditManagerCodec } from \"./editManagerCodecs\";\nexport { EditManagerSummarizer } from \"./editManagerSummarizer\";\nexport { EditManager, minimumPossibleSequenceNumber, SummaryData } from \"./editManager\";\nexport {\n\tCommit,\n\tSeqNumber,\n\tSequencedCommit,\n\tSummarySessionBranch,\n\tEncodedCommit,\n} from \"./editManagerFormat\";\nexport { RevisionTagCodec } from \"./revisionTagCodecs\";\n"]}

package/lib/shared-tree-core/messageCodecs.d.ts

@@ -0,0 +1,9 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ICodecOptions, IJsonCodec } from "../codec";
+import { EncodedRevisionTag, RevisionTag } from "../core";
+import { DecodedMessage } from "./messageTypes";
+export declare function makeMessageCodec<TChangeset>(changesetCodec: IJsonCodec<TChangeset>, revisionTagCodec: IJsonCodec<RevisionTag, EncodedRevisionTag>, options: ICodecOptions): IJsonCodec<DecodedMessage<TChangeset>>;
+//# sourceMappingURL=messageCodecs.d.ts.map

package/lib/shared-tree-core/messageCodecs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"messageCodecs.d.ts","sourceRoot":"","sources":["../../src/shared-tree-core/messageCodecs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAAE,aAAa,EAAE,UAAU,EAAwB,MAAM,UAAU,CAAC;AAC3E,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAC1D,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,wBAAgB,gBAAgB,CAAC,UAAU,EAC1C,cAAc,EAAE,UAAU,CAAC,UAAU,CAAC,EACtC,gBAAgB,EAAE,UAAU,CAAC,WAAW,EAAE,kBAAkB,CAAC,EAC7D,OAAO,EAAE,aAAa,GACpB,UAAU,CAAC,cAAc,CAAC,UAAU,CAAC,CAAC,CA0BxC"}

package/lib/shared-tree-core/messageCodecs.js

@@ -0,0 +1,31 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { Type } from "@sinclair/typebox";
+import { withSchemaValidation } from "../codec";
+import { Message } from "./messageFormat";
+export function makeMessageCodec(changesetCodec, revisionTagCodec, options) {
+    // TODO: consider adding version and using makeVersionedValidatedCodec
+    return withSchemaValidation(Message(changesetCodec.encodedSchema ?? Type.Any()), {
+        encode: ({ commit, sessionId }) => {
+            const message = {
+                revision: revisionTagCodec.encode(commit.revision),
+                originatorId: sessionId,
+                changeset: changesetCodec.encode(commit.change),
+            };
+            return message;
+        },
+        decode: (encoded) => {
+            const { revision, originatorId, changeset } = encoded;
+            return {
+                commit: {
+                    revision: revisionTagCodec.decode(revision),
+                    change: changesetCodec.decode(changeset),
+                },
+                sessionId: originatorId,
+            };
+        },
+    }, options.jsonValidator);
+}
+//# sourceMappingURL=messageCodecs.js.map

package/lib/shared-tree-core/messageCodecs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"messageCodecs.js","sourceRoot":"","sources":["../../src/shared-tree-core/messageCodecs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAc,IAAI,EAAE,MAAM,mBAAmB,CAAC;AAErD,OAAO,EAA6B,oBAAoB,EAAE,MAAM,UAAU,CAAC;AAG3E,OAAO,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAC;AAE1C,MAAM,UAAU,gBAAgB,CAC/B,cAAsC,EACtC,gBAA6D,EAC7D,OAAsB;IAEtB,sEAAsE;IACtE,OAAO,oBAAoB,CAC1B,OAAO,CAAC,cAAc,CAAC,aAAa,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC,EACnD;QACC,MAAM,EAAE,CAAC,EAAE,MAAM,EAAE,SAAS,EAA8B,EAAE,EAAE;YAC7D,MAAM,OAAO,GAAY;gBACxB,QAAQ,EAAE,gBAAgB,CAAC,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC;gBAClD,YAAY,EAAE,SAAS;gBACvB,SAAS,EAAE,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC;aAC/C,CAAC;YACF,OAAO,OAA4C,CAAC;QACrD,CAAC;QACD,MAAM,EAAE,CAAC,OAA+B,EAAE,EAAE;YAC3C,MAAM,EAAE,QAAQ,EAAE,YAAY,EAAE,SAAS,EAAE,GAAG,OAA6B,CAAC;YAC5E,OAAO;gBACN,MAAM,EAAE;oBACP,QAAQ,EAAE,gBAAgB,CAAC,MAAM,CAAC,QAAQ,CAAC;oBAC3C,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC,SAAS,CAAC;iBACxC;gBACD,SAAS,EAAE,YAAY;aACvB,CAAC;QACH,CAAC;KACD,EACD,OAAO,CAAC,aAAa,CACrB,CAAC;AACH,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { TAnySchema, Type } from \"@sinclair/typebox\";\nimport { JsonCompatibleReadOnly } from \"../util\";\nimport { ICodecOptions, IJsonCodec, withSchemaValidation } from \"../codec\";\nimport { EncodedRevisionTag, RevisionTag } from \"../core\";\nimport { DecodedMessage } from \"./messageTypes\";\nimport { Message } from \"./messageFormat\";\n\nexport function makeMessageCodec<TChangeset>(\n\tchangesetCodec: IJsonCodec<TChangeset>,\n\trevisionTagCodec: IJsonCodec<RevisionTag, EncodedRevisionTag>,\n\toptions: ICodecOptions,\n): IJsonCodec<DecodedMessage<TChangeset>> {\n\t// TODO: consider adding version and using makeVersionedValidatedCodec\n\treturn withSchemaValidation<DecodedMessage<TChangeset>, TAnySchema>(\n\t\tMessage(changesetCodec.encodedSchema ?? Type.Any()),\n\t\t{\n\t\t\tencode: ({ commit, sessionId }: DecodedMessage<TChangeset>) => {\n\t\t\t\tconst message: Message = {\n\t\t\t\t\trevision: revisionTagCodec.encode(commit.revision),\n\t\t\t\t\toriginatorId: sessionId,\n\t\t\t\t\tchangeset: changesetCodec.encode(commit.change),\n\t\t\t\t};\n\t\t\t\treturn message as unknown as JsonCompatibleReadOnly;\n\t\t\t},\n\t\t\tdecode: (encoded: JsonCompatibleReadOnly) => {\n\t\t\t\tconst { revision, originatorId, changeset } = encoded as unknown as Message;\n\t\t\t\treturn {\n\t\t\t\t\tcommit: {\n\t\t\t\t\t\trevision: revisionTagCodec.decode(revision),\n\t\t\t\t\t\tchange: changesetCodec.decode(changeset),\n\t\t\t\t\t},\n\t\t\t\t\tsessionId: originatorId,\n\t\t\t\t};\n\t\t\t},\n\t\t},\n\t\toptions.jsonValidator,\n\t);\n}\n"]}

package/lib/shared-tree-core/messageFormat.d.ts

@@ -0,0 +1,30 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { TSchema } from "@sinclair/typebox";
+import { JsonCompatibleReadOnly } from "../util";
+import { EncodedRevisionTag } from "../core";
+/**
+ * The format of messages that SharedTree sends and receives.
+ */
+export interface Message {
+    /**
+     * The revision tag for the change in this message
+     */
+    readonly revision: EncodedRevisionTag;
+    /**
+     * The stable ID that identifies the originator of the message.
+     */
+    readonly originatorId: string;
+    /**
+     * The changeset to be applied.
+     */
+    readonly changeset: JsonCompatibleReadOnly;
+}
+export declare const Message: <ChangeSchema extends TSchema>(tChange: ChangeSchema) => import("@sinclair/typebox").TObject<{
+    revision: import("@sinclair/typebox").TUnsafe<EncodedRevisionTag>;
+    originatorId: import("@sinclair/typebox").TUnsafe<string>;
+    changeset: ChangeSchema;
+}>;
+//# sourceMappingURL=messageFormat.d.ts.map

package/lib/shared-tree-core/messageFormat.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"messageFormat.d.ts","sourceRoot":"","sources":["../../src/shared-tree-core/messageFormat.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAQ,OAAO,EAAE,MAAM,mBAAmB,CAAC;AAClD,OAAO,EAAE,sBAAsB,EAAE,MAAM,SAAS,CAAC;AACjD,OAAO,EAAE,kBAAkB,EAAsC,MAAM,SAAS,CAAC;AAEjF;;GAEG;AACH,MAAM,WAAW,OAAO;IACvB;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,kBAAkB,CAAC;IACtC;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B;;OAEG;IACH,QAAQ,CAAC,SAAS,EAAE,sBAAsB,CAAC;CAC3C;AAED,eAAO,MAAM,OAAO;;;;EAKjB,CAAC"}

package/lib/shared-tree-core/messageFormat.js

@@ -0,0 +1,12 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { Type } from "@sinclair/typebox";
+import { RevisionTagSchema, SessionIdSchema } from "../core";
+export const Message = (tChange) => Type.Object({
+    revision: RevisionTagSchema,
+    originatorId: SessionIdSchema,
+    changeset: tChange,
+});
+//# sourceMappingURL=messageFormat.js.map

package/lib/shared-tree-core/messageFormat.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"messageFormat.js","sourceRoot":"","sources":["../../src/shared-tree-core/messageFormat.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,IAAI,EAAW,MAAM,mBAAmB,CAAC;AAElD,OAAO,EAAsB,iBAAiB,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAoBjF,MAAM,CAAC,MAAM,OAAO,GAAG,CAA+B,OAAqB,EAAE,EAAE,CAC9E,IAAI,CAAC,MAAM,CAAC;IACX,QAAQ,EAAE,iBAAiB;IAC3B,YAAY,EAAE,eAAe;IAC7B,SAAS,EAAE,OAAO;CAClB,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { Type, TSchema } from \"@sinclair/typebox\";\nimport { JsonCompatibleReadOnly } from \"../util\";\nimport { EncodedRevisionTag, RevisionTagSchema, SessionIdSchema } from \"../core\";\n\n/**\n * The format of messages that SharedTree sends and receives.\n */\nexport interface Message {\n\t/**\n\t * The revision tag for the change in this message\n\t */\n\treadonly revision: EncodedRevisionTag;\n\t/**\n\t * The stable ID that identifies the originator of the message.\n\t */\n\treadonly originatorId: string;\n\t/**\n\t * The changeset to be applied.\n\t */\n\treadonly changeset: JsonCompatibleReadOnly;\n}\n\nexport const Message = <ChangeSchema extends TSchema>(tChange: ChangeSchema) =>\n\tType.Object({\n\t\trevision: RevisionTagSchema,\n\t\toriginatorId: SessionIdSchema,\n\t\tchangeset: tChange,\n\t});\n"]}

package/lib/shared-tree-core/messageTypes.d.ts

@@ -0,0 +1,10 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { GraphCommit, SessionId } from "../core";
+export interface DecodedMessage<TChange> {
+    commit: GraphCommit<TChange>;
+    sessionId: SessionId;
+}
+//# sourceMappingURL=messageTypes.d.ts.map

package/lib/shared-tree-core/messageTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"messageTypes.d.ts","sourceRoot":"","sources":["../../src/shared-tree-core/messageTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AAEjD,MAAM,WAAW,cAAc,CAAC,OAAO;IACtC,MAAM,EAAE,WAAW,CAAC,OAAO,CAAC,CAAC;IAC7B,SAAS,EAAE,SAAS,CAAC;CACrB"}

package/lib/shared-tree-core/messageTypes.js

@@ -0,0 +1,6 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export {};
+//# sourceMappingURL=messageTypes.js.map

package/lib/shared-tree-core/messageTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"messageTypes.js","sourceRoot":"","sources":["../../src/shared-tree-core/messageTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { GraphCommit, SessionId } from \"../core\";\n\nexport interface DecodedMessage<TChange> {\n\tcommit: GraphCommit<TChange>;\n\tsessionId: SessionId;\n}\n"]}

package/lib/shared-tree-core/revisionTagCodecs.d.ts

@@ -0,0 +1,11 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IJsonCodec } from "../codec";
+import { EncodedRevisionTag, RevisionTag } from "../core";
+export declare class RevisionTagCodec implements IJsonCodec<RevisionTag, EncodedRevisionTag> {
+    encode(tag: RevisionTag): EncodedRevisionTag;
+    decode(tag: EncodedRevisionTag): import("@fluidframework/id-compressor").StableId;
+}
+//# sourceMappingURL=revisionTagCodecs.d.ts.map

package/lib/shared-tree-core/revisionTagCodecs.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"revisionTagCodecs.d.ts","sourceRoot":"","sources":["../../src/shared-tree-core/revisionTagCodecs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AACtC,OAAO,EAAE,kBAAkB,EAAE,WAAW,EAAE,MAAM,SAAS,CAAC;AAE1D,qBAAa,gBAAiB,YAAW,UAAU,CAAC,WAAW,EAAE,kBAAkB,CAAC;IAC5E,MAAM,CAAC,GAAG,EAAE,WAAW;IAGvB,MAAM,CAAC,GAAG,EAAE,kBAAkB;CAGrC"}

package/lib/shared-tree-core/revisionTagCodecs.js

@@ -0,0 +1,13 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+export class RevisionTagCodec {
+    encode(tag) {
+        return tag;
+    }
+    decode(tag) {
+        return tag;
+    }
+}
+//# sourceMappingURL=revisionTagCodecs.js.map

package/lib/shared-tree-core/revisionTagCodecs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"revisionTagCodecs.js","sourceRoot":"","sources":["../../src/shared-tree-core/revisionTagCodecs.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,MAAM,OAAO,gBAAgB;IACrB,MAAM,CAAC,GAAgB;QAC7B,OAAO,GAAoC,CAAC;IAC7C,CAAC;IACM,MAAM,CAAC,GAAuB;QACpC,OAAO,GAA6B,CAAC;IACtC,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IJsonCodec } from \"../codec\";\nimport { EncodedRevisionTag, RevisionTag } from \"../core\";\n\nexport class RevisionTagCodec implements IJsonCodec<RevisionTag, EncodedRevisionTag> {\n\tpublic encode(tag: RevisionTag) {\n\t\treturn tag as unknown as EncodedRevisionTag;\n\t}\n\tpublic decode(tag: EncodedRevisionTag) {\n\t\treturn tag as unknown as RevisionTag;\n\t}\n}\n"]}

package/lib/shared-tree-core/sharedTreeCore.d.ts

@@ -0,0 +1,112 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IChannelAttributes, IChannelStorageService, IFluidDataStoreRuntime } from "@fluidframework/datastore-definitions";
+import { ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
+import { ITelemetryContext, ISummaryTreeWithStats, IGarbageCollectionData, IExperimentalIncrementalSummaryContext } from "@fluidframework/runtime-definitions";
+import { IFluidSerializer, SharedObject } from "@fluidframework/shared-object-base";
+import { ICodecOptions } from "../codec";
+import { ChangeFamily, ChangeFamilyEditor } from "../core";
+import { JsonCompatibleReadOnly } from "../util";
+import { SharedTreeBranch } from "./branch";
+/**
+ * Generic shared tree, which needs to be configured with indexes, field kinds and a history policy to be used.
+ *
+ * TODO: actually implement
+ * TODO: is history policy a detail of what indexes are used, or is there something else to it?
+ */
+export declare class SharedTreeCore<TEditor extends ChangeFamilyEditor, TChange> extends SharedObject {
+    private readonly editManager;
+    private readonly summarizables;
+    /** Iff false, calls to `submitOp` will have no effect */
+    private submitOps;
+    /**
+     * The sequence number that this instance is at.
+     * This is number is artificial in that it is made up by this instance as opposed to being provided by the runtime.
+     * Is `undefined` after (and only after) this instance is attached.
+     */
+    private detachedRevision;
+    /**
+     * Used to edit the state of the tree. Edits will be immediately applied locally to the tree.
+     * If there is no transaction currently ongoing, then the edits will be submitted to Fluid immediately as well.
+     */
+    get editor(): TEditor;
+    /**
+     * Used to encode/decode messages sent to/received from the Fluid runtime.
+     *
+     * @remarks Since there is currently only one format, this can just be cached on the class.
+     * With more write formats active, it may make sense to keep around the "usual" format codec
+     * (the one for the current persisted configuration) and resolve codecs for different versions
+     * as necessary (e.g. an upgrade op came in, or the configuration changed within the collab window
+     * and an op needs to be interpreted which isn't written with the current configuration).
+     */
+    private readonly messageCodec;
+    /**
+     * @param summarizables - Summarizers for all indexes used by this tree
+     * @param changeFamily - The change family
+     * @param editManager - The edit manager
+     * @param id - The id of the shared object
+     * @param runtime - The IFluidDataStoreRuntime which contains the shared object
+     * @param attributes - Attributes of the shared object
+     * @param telemetryContextPrefix - the context for any telemetry logs/errors emitted
+     */
+    constructor(summarizables: readonly Summarizable[], changeFamily: ChangeFamily<TEditor, TChange>, options: ICodecOptions, id: string, runtime: IFluidDataStoreRuntime, attributes: IChannelAttributes, telemetryContextPrefix: string);
+    protected summarizeCore(serializer: IFluidSerializer, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext): ISummaryTreeWithStats;
+    protected loadCore(services: IChannelStorageService): Promise<void>;
+    /**
+     * Submits an op to the Fluid runtime containing the given commit
+     * @param commit - the commit to submit
+     */
+    private submitCommit;
+    protected processCore(message: ISequencedDocumentMessage, local: boolean, localOpMetadata: unknown): void;
+    /**
+     * @returns the head commit of the root local branch
+     */
+    protected getLocalBranch(): SharedTreeBranch<TEditor, TChange>;
+    protected onDisconnect(): void;
+    protected didAttach(): void;
+    protected reSubmitCore(content: JsonCompatibleReadOnly, localOpMetadata: unknown): void;
+    protected applyStashedOp(content: JsonCompatibleReadOnly): undefined;
+    getGCData(fullGC?: boolean): IGarbageCollectionData;
+}
+/**
+ * Specifies the behavior of a component that puts data in a summary.
+ */
+export interface Summarizable {
+    /**
+     * Field name in summary json under which this element stores its data.
+     */
+    readonly key: string;
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getAttachSummary}
+     * @param stringify - Serializes the contents of the component (including {@link IFluidHandle}s) for storage.
+     */
+    getAttachSummary(stringify: SummaryElementStringifier, fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext, incrementalSummaryContext?: IExperimentalIncrementalSummaryContext): ISummaryTreeWithStats;
+    /**
+     * {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).summarize}
+     * @param stringify - Serializes the contents of the component (including {@link IFluidHandle}s) for storage.
+     */
+    summarize(stringify: SummaryElementStringifier, fullTree?: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): Promise<ISummaryTreeWithStats>;
+    /**
+     * {@inheritDoc (ISharedObject:interface).getGCData}
+     */
+    getGCData(fullGC?: boolean): IGarbageCollectionData;
+    /**
+     * Allows the component to perform custom loading. The storage service is scoped to this component and therefore
+     * paths in this component will not collide with those in other components, even if they are the same string.
+     * @param service - Storage used by the component
+     * @param parse - Parses serialized data from storage into runtime objects for the component
+     */
+    load(service: IChannelStorageService, parse: SummaryElementParser): Promise<void>;
+}
+/**
+ * Serializes the given contents into a string acceptable for storing in summaries, i.e. all
+ * Fluid handles have been replaced appropriately by an IFluidSerializer
+ */
+export type SummaryElementStringifier = (contents: unknown) => string;
+/**
+ * Parses a serialized/summarized string into an object, rehydrating any Fluid handles as necessary
+ */
+export type SummaryElementParser = (contents: string) => unknown;
+//# sourceMappingURL=sharedTreeCore.d.ts.map

package/lib/shared-tree-core/sharedTreeCore.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"sharedTreeCore.d.ts","sourceRoot":"","sources":["../../src/shared-tree-core/sharedTreeCore.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACN,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,MAAM,uCAAuC,CAAC;AAC/C,OAAO,EAAE,yBAAyB,EAAE,MAAM,sCAAsC,CAAC;AACjF,OAAO,EACN,iBAAiB,EACjB,qBAAqB,EACrB,sBAAsB,EACtB,sCAAsC,EACtC,MAAM,qCAAqC,CAAC;AAE7C,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,oCAAoC,CAAC;AACpF,OAAO,EAAE,aAAa,EAAc,MAAM,UAAU,CAAC;AACrD,OAAO,EAAE,YAAY,EAAE,kBAAkB,EAAe,MAAM,SAAS,CAAC;AACxE,OAAO,EAAS,sBAAsB,EAAoB,MAAM,SAAS,CAAC;AAC1E,OAAO,EAAE,gBAAgB,EAAwB,MAAM,UAAU,CAAC;AAalE;;;;;GAKG;AACH,qBAAa,cAAc,CAAC,OAAO,SAAS,kBAAkB,EAAE,OAAO,CAAE,SAAQ,YAAY;IAC5F,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAgE;IAC5F,OAAO,CAAC,QAAQ,CAAC,aAAa,CAA0B;IAExD,yDAAyD;IACzD,OAAO,CAAC,SAAS,CAAQ;IAEzB;;;;OAIG;IACH,OAAO,CAAC,gBAAgB,CAAwD;IAEhF;;;OAGG;IACH,IAAW,MAAM,IAAI,OAAO,CAE3B;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,QAAQ,CAAC,YAAY,CAA+C;IAE5E;;;;;;;;OAQG;gBAEF,aAAa,EAAE,SAAS,YAAY,EAAE,EACtC,YAAY,EAAE,YAAY,CAAC,OAAO,EAAE,OAAO,CAAC,EAC5C,OAAO,EAAE,aAAa,EAEtB,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,sBAAsB,EAC/B,UAAU,EAAE,kBAAkB,EAC9B,sBAAsB,EAAE,MAAM;IAqD/B,SAAS,CAAC,aAAa,CACtB,UAAU,EAAE,gBAAgB,EAC5B,gBAAgB,CAAC,EAAE,iBAAiB,EACpC,yBAAyB,CAAC,EAAE,sCAAsC,GAChE,qBAAqB;cAqBR,QAAQ,CAAC,QAAQ,EAAE,sBAAsB,GAAG,OAAO,CAAC,IAAI,CAAC;IAWzE;;;OAGG;IACH,OAAO,CAAC,YAAY;IA8BpB,SAAS,CAAC,WAAW,CACpB,OAAO,EAAE,yBAAyB,EAClC,KAAK,EAAE,OAAO,EACd,eAAe,EAAE,OAAO;IAazB;;OAEG;IACH,SAAS,CAAC,cAAc,IAAI,gBAAgB,CAAC,OAAO,EAAE,OAAO,CAAC;IAI9D,SAAS,CAAC,YAAY;cAEH,SAAS,IAAI,IAAI;cAMjB,YAAY,CAAC,OAAO,EAAE,sBAAsB,EAAE,eAAe,EAAE,OAAO;IAQzF,SAAS,CAAC,cAAc,CAAC,OAAO,EAAE,sBAAsB,GAAG,SAAS;IAcpD,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,sBAAsB;CAenE;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC5B;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,gBAAgB,CACf,SAAS,EAAE,yBAAyB,EACpC,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,EACpC,yBAAyB,CAAC,EAAE,sCAAsC,GAChE,qBAAqB,CAAC;IAEzB;;;OAGG;IACH,SAAS,CACR,SAAS,EAAE,yBAAyB,EACpC,QAAQ,CAAC,EAAE,OAAO,EAClB,UAAU,CAAC,EAAE,OAAO,EACpB,gBAAgB,CAAC,EAAE,iBAAiB,GAClC,OAAO,CAAC,qBAAqB,CAAC,CAAC;IAElC;;OAEG;IAGH,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,GAAG,sBAAsB,CAAC;IAEpD;;;;;OAKG;IACH,IAAI,CAAC,OAAO,EAAE,sBAAsB,EAAE,KAAK,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;CAClF;AAED;;;GAGG;AACH,MAAM,MAAM,yBAAyB,GAAG,CAAC,QAAQ,EAAE,OAAO,KAAK,MAAM,CAAC;AAEtE;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,CAAC,QAAQ,EAAE,MAAM,KAAK,OAAO,CAAC"}