@fluid-experimental/tree 0.58.2001 → 0.59.2000-61729

package/dist/generic/Summary.d.ts

@@ -1,63 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { IFluidHandle } from '@fluidframework/core-interfaces';
-import { IFluidSerializer } from '@fluidframework/shared-object-base';
-import { EditLogSummary, OrderedEditSet } from '../EditLog';
-import { Snapshot } from '../Snapshot';
-import { SharedTreeSummary_0_0_2 } from '../SummaryBackCompatibility';
-import { ChangeNode } from './PersistedTypes';
-/**
- * Format version for summaries that are written.
- * When next changing the format, we should add a new format version variable for the edit-specific summaries and assign it an independent
- * version number.
- */
-export declare const formatVersion = "0.0.2";
-/**
- * Handler for summarizing the tree state.
- * The handler is invoked when saving a summary. It accepts a view of the current state of the tree, the sequenced edits known
- * to the SharedTree, and optional helpers for serializing the edit information.
- * @returns a summary of the supplied state.
- * @internal
- */
-export declare type SharedTreeSummarizer<TChange> = (editLog: OrderedEditSet<TChange>, currentView: Snapshot) => SharedTreeSummaryBase;
-/**
- * The minimal information on a SharedTree summary. Contains the summary format version.
- */
-export interface SharedTreeSummaryBase {
-    /**
-     * Field on summary under which version is stored.
-     */
-    readonly version: string;
-}
-/**
- * The contents of a SharedTree summary: the current tree, and the edits needed to get from `initialTree` to the current tree.
- * @public
- */
-export interface SharedTreeSummary<TChange> extends SharedTreeSummaryBase {
-    readonly currentTree: ChangeNode;
-    /**
-     * Information that can populate an edit log.
-     */
-    readonly editHistory?: EditLogSummary<TChange>;
-}
-/**
- * Serializes a SharedTree summary into a JSON string. This may later be used to initialize a SharedTree's state via `deserialize()`
- * Also replaces handle objects with their serialized form.
- *
- * @param summary - The SharedTree summary to serialize.
- * @param serializer - The serializer required to serialize handles in the summary.
- * @param bind - The object handle required to serialize handles in the summary
- */
-export declare function serialize(summary: SharedTreeSummaryBase, serializer: IFluidSerializer, bind: IFluidHandle): string;
-/**
- * Preserves the full history in the generated summary.
- * @public
- */
-export declare function fullHistorySummarizer<TChange>(editLog: OrderedEditSet<TChange>, currentView: Snapshot): SharedTreeSummary_0_0_2<TChange>;
-/**
- * Generates a summary with format version 0.1.0. This will prefer handles over edits in edit chunks where possible.
- */
-export declare function fullHistorySummarizer_0_1_0<TChange>(editLog: OrderedEditSet<TChange>, currentView: Snapshot): SharedTreeSummary<TChange>;
-//# sourceMappingURL=Summary.d.ts.map

package/dist/generic/Summary.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Summary.d.ts","sourceRoot":"","sources":["../../src/generic/Summary.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAC/D,OAAO,EAAE,gBAAgB,EAAoB,MAAM,oCAAoC,CAAC;AAExF,OAAO,EAAE,cAAc,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AACvC,OAAO,EAAqB,uBAAuB,EAAE,MAAM,6BAA6B,CAAC;AACzF,OAAO,EAAE,UAAU,EAAQ,MAAM,kBAAkB,CAAC;AAEpD;;;;GAIG;AACH,eAAO,MAAM,aAAa,UAAU,CAAC;AAErC;;;;;;GAMG;AACH,oBAAY,oBAAoB,CAAC,OAAO,IAAI,CAC3C,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,EAChC,WAAW,EAAE,QAAQ,KACjB,qBAAqB,CAAC;AAE3B;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,iBAAiB,CAAC,OAAO,CAAE,SAAQ,qBAAqB;IACxE,QAAQ,CAAC,WAAW,EAAE,UAAU,CAAC;IAEjC;;OAEG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,cAAc,CAAC,OAAO,CAAC,CAAC;CAC/C;AAED;;;;;;;GAOG;AACH,wBAAgB,SAAS,CAAC,OAAO,EAAE,qBAAqB,EAAE,UAAU,EAAE,gBAAgB,EAAE,IAAI,EAAE,YAAY,GAAG,MAAM,CAElH;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CAAC,OAAO,EAC5C,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,EAChC,WAAW,EAAE,QAAQ,GACnB,uBAAuB,CAAC,OAAO,CAAC,CAwBlC;AAED;;GAEG;AACH,wBAAgB,2BAA2B,CAAC,OAAO,EAClD,OAAO,EAAE,cAAc,CAAC,OAAO,CAAC,EAChC,WAAW,EAAE,QAAQ,GACnB,iBAAiB,CAAC,OAAO,CAAC,CAM5B"}

package/dist/generic/Summary.js

@@ -1,64 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.fullHistorySummarizer_0_1_0 = exports.fullHistorySummarizer = exports.serialize = exports.formatVersion = void 0;
-const shared_object_base_1 = require("@fluidframework/shared-object-base");
-const Common_1 = require("../Common");
-const SummaryBackCompatibility_1 = require("../SummaryBackCompatibility");
-/**
- * Format version for summaries that are written.
- * When next changing the format, we should add a new format version variable for the edit-specific summaries and assign it an independent
- * version number.
- */
-exports.formatVersion = '0.0.2';
-/**
- * Serializes a SharedTree summary into a JSON string. This may later be used to initialize a SharedTree's state via `deserialize()`
- * Also replaces handle objects with their serialized form.
- *
- * @param summary - The SharedTree summary to serialize.
- * @param serializer - The serializer required to serialize handles in the summary.
- * @param bind - The object handle required to serialize handles in the summary
- */
-function serialize(summary, serializer, bind) {
-    return Common_1.assertNotUndefined(shared_object_base_1.serializeHandles(summary, serializer, bind));
-}
-exports.serialize = serialize;
-/**
- * Preserves the full history in the generated summary.
- * @public
- */
-function fullHistorySummarizer(editLog, currentView) {
-    const { editChunks, editIds } = editLog.getEditLogSummary();
-    const sequencedEdits = [];
-    let idIndex = 0;
-    editChunks.forEach(({ chunk }) => {
-        Common_1.assert(Array.isArray(chunk), 'Handles should not be included in the summary until format version 0.1.0 is being written.');
-        chunk.forEach(({ changes }) => {
-            sequencedEdits.push({
-                changes,
-                id: Common_1.assertNotUndefined(editIds[idIndex++], 'Number of edits should match number of edit IDs.'),
-            });
-        });
-    });
-    return {
-        currentTree: currentView.getChangeNodeTree(),
-        sequencedEdits,
-        version: exports.formatVersion,
-    };
-}
-exports.fullHistorySummarizer = fullHistorySummarizer;
-/**
- * Generates a summary with format version 0.1.0. This will prefer handles over edits in edit chunks where possible.
- */
-function fullHistorySummarizer_0_1_0(editLog, currentView) {
-    return {
-        currentTree: currentView.getChangeNodeTree(),
-        editHistory: editLog.getEditLogSummary(true),
-        version: SummaryBackCompatibility_1.readFormatVersion,
-    };
-}
-exports.fullHistorySummarizer_0_1_0 = fullHistorySummarizer_0_1_0;
-//# sourceMappingURL=Summary.js.map

package/dist/generic/Summary.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Summary.js","sourceRoot":"","sources":["../../src/generic/Summary.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,2EAAwF;AACxF,sCAAuD;AAGvD,0EAAyF;AAGzF;;;;GAIG;AACU,QAAA,aAAa,GAAG,OAAO,CAAC;AAqCrC;;;;;;;GAOG;AACH,SAAgB,SAAS,CAAC,OAA8B,EAAE,UAA4B,EAAE,IAAkB;IACzG,OAAO,2BAAkB,CAAC,qCAAgB,CAAC,OAAO,EAAE,UAAU,EAAE,IAAI,CAAC,CAAC,CAAC;AACxE,CAAC;AAFD,8BAEC;AAED;;;GAGG;AACH,SAAgB,qBAAqB,CACpC,OAAgC,EAChC,WAAqB;IAErB,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,iBAAiB,EAAE,CAAC;IAE5D,MAAM,cAAc,GAAoB,EAAE,CAAC;IAC3C,IAAI,OAAO,GAAG,CAAC,CAAC;IAChB,UAAU,CAAC,OAAO,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE;QAChC,eAAM,CACL,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EACpB,4FAA4F,CAC5F,CAAC;QAEF,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE;YAC7B,cAAc,CAAC,IAAI,CAAC;gBACnB,OAAO;gBACP,EAAE,EAAE,2BAAkB,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,EAAE,kDAAkD,CAAC;aAC9F,CAAC,CAAC;QACJ,CAAC,CAAC,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,OAAO;QACN,WAAW,EAAE,WAAW,CAAC,iBAAiB,EAAE;QAC5C,cAAc;QACd,OAAO,EAAE,qBAAa;KACtB,CAAC;AACH,CAAC;AA3BD,sDA2BC;AAED;;GAEG;AACH,SAAgB,2BAA2B,CAC1C,OAAgC,EAChC,WAAqB;IAErB,OAAO;QACN,WAAW,EAAE,WAAW,CAAC,iBAAiB,EAAE;QAC5C,WAAW,EAAE,OAAO,CAAC,iBAAiB,CAAC,IAAI,CAAC;QAC5C,OAAO,EAAE,4CAAiB;KAC1B,CAAC;AACH,CAAC;AATD,kEASC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandle } from '@fluidframework/core-interfaces';\nimport { IFluidSerializer, serializeHandles } from '@fluidframework/shared-object-base';\nimport { assert, assertNotUndefined } from '../Common';\nimport { EditLogSummary, OrderedEditSet } from '../EditLog';\nimport { Snapshot } from '../Snapshot';\nimport { readFormatVersion, SharedTreeSummary_0_0_2 } from '../SummaryBackCompatibility';\nimport { ChangeNode, Edit } from './PersistedTypes';\n\n/**\n * Format version for summaries that are written.\n * When next changing the format, we should add a new format version variable for the edit-specific summaries and assign it an independent\n * version number.\n */\nexport const formatVersion = '0.0.2';\n\n/**\n * Handler for summarizing the tree state.\n * The handler is invoked when saving a summary. It accepts a view of the current state of the tree, the sequenced edits known\n * to the SharedTree, and optional helpers for serializing the edit information.\n * @returns a summary of the supplied state.\n * @internal\n */\nexport type SharedTreeSummarizer<TChange> = (\n\teditLog: OrderedEditSet<TChange>,\n\tcurrentView: Snapshot\n) => SharedTreeSummaryBase;\n\n/**\n * The minimal information on a SharedTree summary. Contains the summary format version.\n */\nexport interface SharedTreeSummaryBase {\n\t/**\n\t * Field on summary under which version is stored.\n\t */\n\treadonly version: string;\n}\n\n/**\n * The contents of a SharedTree summary: the current tree, and the edits needed to get from `initialTree` to the current tree.\n * @public\n */\nexport interface SharedTreeSummary<TChange> extends SharedTreeSummaryBase {\n\treadonly currentTree: ChangeNode;\n\n\t/**\n\t * Information that can populate an edit log.\n\t */\n\treadonly editHistory?: EditLogSummary<TChange>;\n}\n\n/**\n * Serializes a SharedTree summary into a JSON string. This may later be used to initialize a SharedTree's state via `deserialize()`\n * Also replaces handle objects with their serialized form.\n *\n * @param summary - The SharedTree summary to serialize.\n * @param serializer - The serializer required to serialize handles in the summary.\n * @param bind - The object handle required to serialize handles in the summary\n */\nexport function serialize(summary: SharedTreeSummaryBase, serializer: IFluidSerializer, bind: IFluidHandle): string {\n\treturn assertNotUndefined(serializeHandles(summary, serializer, bind));\n}\n\n/**\n * Preserves the full history in the generated summary.\n * @public\n */\nexport function fullHistorySummarizer<TChange>(\n\teditLog: OrderedEditSet<TChange>,\n\tcurrentView: Snapshot\n): SharedTreeSummary_0_0_2<TChange> {\n\tconst { editChunks, editIds } = editLog.getEditLogSummary();\n\n\tconst sequencedEdits: Edit<TChange>[] = [];\n\tlet idIndex = 0;\n\teditChunks.forEach(({ chunk }) => {\n\t\tassert(\n\t\t\tArray.isArray(chunk),\n\t\t\t'Handles should not be included in the summary until format version 0.1.0 is being written.'\n\t\t);\n\n\t\tchunk.forEach(({ changes }) => {\n\t\t\tsequencedEdits.push({\n\t\t\t\tchanges,\n\t\t\t\tid: assertNotUndefined(editIds[idIndex++], 'Number of edits should match number of edit IDs.'),\n\t\t\t});\n\t\t});\n\t});\n\n\treturn {\n\t\tcurrentTree: currentView.getChangeNodeTree(),\n\t\tsequencedEdits,\n\t\tversion: formatVersion,\n\t};\n}\n\n/**\n * Generates a summary with format version 0.1.0. This will prefer handles over edits in edit chunks where possible.\n */\nexport function fullHistorySummarizer_0_1_0<TChange>(\n\teditLog: OrderedEditSet<TChange>,\n\tcurrentView: Snapshot\n): SharedTreeSummary<TChange> {\n\treturn {\n\t\tcurrentTree: currentView.getChangeNodeTree(),\n\t\teditHistory: editLog.getEditLogSummary(true),\n\t\tversion: readFormatVersion,\n\t};\n}\n"]}

package/dist/generic/index.d.ts

@@ -1,10 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-export { EditCommittedHandler, EditCommittedEventArguments, ISharedTreeEvents, GenericSharedTree, SharedTreeEvent, SharedTreeDiagnosticEvent, } from './GenericSharedTree';
-export { Edit, EditWithoutId, EditBase, TraitMap, TreeNodeSequence, Payload, NodeData, TreeNode, ChangeNode, BuildNode, EditStatus, TraitLocation, SharedTreeOpType, } from './PersistedTypes';
-export { newEdit, newEditId } from './GenericEditUtilities';
-export { GenericTransaction, EditingResult, ValidEditingResult } from './GenericTransaction';
-export { SharedTreeSummary, SharedTreeSummaryBase, SharedTreeSummarizer, fullHistorySummarizer, fullHistorySummarizer_0_1_0, formatVersion, serialize, } from './Summary';
-//# sourceMappingURL=index.d.ts.map

package/dist/generic/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/generic/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EACN,oBAAoB,EACpB,2BAA2B,EAC3B,iBAAiB,EACjB,iBAAiB,EACjB,eAAe,EACf,yBAAyB,GACzB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EACN,IAAI,EACJ,aAAa,EACb,QAAQ,EACR,QAAQ,EACR,gBAAgB,EAChB,OAAO,EACP,QAAQ,EACR,QAAQ,EACR,UAAU,EACV,SAAS,EACT,UAAU,EACV,aAAa,EACb,gBAAgB,GAChB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAC7F,OAAO,EACN,iBAAiB,EACjB,qBAAqB,EACrB,oBAAoB,EACpB,qBAAqB,EACrB,2BAA2B,EAC3B,aAAa,EACb,SAAS,GACT,MAAM,WAAW,CAAC"}

package/dist/generic/index.js

@@ -1,26 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.serialize = exports.formatVersion = exports.fullHistorySummarizer_0_1_0 = exports.fullHistorySummarizer = exports.GenericTransaction = exports.newEditId = exports.newEdit = exports.SharedTreeOpType = exports.EditStatus = exports.SharedTreeDiagnosticEvent = exports.SharedTreeEvent = exports.GenericSharedTree = void 0;
-// API Exports
-var GenericSharedTree_1 = require("./GenericSharedTree");
-Object.defineProperty(exports, "GenericSharedTree", { enumerable: true, get: function () { return GenericSharedTree_1.GenericSharedTree; } });
-Object.defineProperty(exports, "SharedTreeEvent", { enumerable: true, get: function () { return GenericSharedTree_1.SharedTreeEvent; } });
-Object.defineProperty(exports, "SharedTreeDiagnosticEvent", { enumerable: true, get: function () { return GenericSharedTree_1.SharedTreeDiagnosticEvent; } });
-var PersistedTypes_1 = require("./PersistedTypes");
-Object.defineProperty(exports, "EditStatus", { enumerable: true, get: function () { return PersistedTypes_1.EditStatus; } });
-Object.defineProperty(exports, "SharedTreeOpType", { enumerable: true, get: function () { return PersistedTypes_1.SharedTreeOpType; } });
-var GenericEditUtilities_1 = require("./GenericEditUtilities");
-Object.defineProperty(exports, "newEdit", { enumerable: true, get: function () { return GenericEditUtilities_1.newEdit; } });
-Object.defineProperty(exports, "newEditId", { enumerable: true, get: function () { return GenericEditUtilities_1.newEditId; } });
-var GenericTransaction_1 = require("./GenericTransaction");
-Object.defineProperty(exports, "GenericTransaction", { enumerable: true, get: function () { return GenericTransaction_1.GenericTransaction; } });
-var Summary_1 = require("./Summary");
-Object.defineProperty(exports, "fullHistorySummarizer", { enumerable: true, get: function () { return Summary_1.fullHistorySummarizer; } });
-Object.defineProperty(exports, "fullHistorySummarizer_0_1_0", { enumerable: true, get: function () { return Summary_1.fullHistorySummarizer_0_1_0; } });
-Object.defineProperty(exports, "formatVersion", { enumerable: true, get: function () { return Summary_1.formatVersion; } });
-Object.defineProperty(exports, "serialize", { enumerable: true, get: function () { return Summary_1.serialize; } });
-//# sourceMappingURL=index.js.map

package/dist/generic/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/generic/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,cAAc;AAEd,yDAO6B;AAH5B,sHAAA,iBAAiB,OAAA;AACjB,oHAAA,eAAe,OAAA;AACf,8HAAA,yBAAyB,OAAA;AAE1B,mDAc0B;AAHzB,4GAAA,UAAU,OAAA;AAEV,kHAAA,gBAAgB,OAAA;AAEjB,+DAA4D;AAAnD,+GAAA,OAAO,OAAA;AAAE,iHAAA,SAAS,OAAA;AAC3B,2DAA6F;AAApF,wHAAA,kBAAkB,OAAA;AAC3B,qCAQmB;AAJlB,gHAAA,qBAAqB,OAAA;AACrB,sHAAA,2BAA2B,OAAA;AAC3B,wGAAA,aAAa,OAAA;AACb,oGAAA,SAAS,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n// API Exports\n\nexport {\n\tEditCommittedHandler,\n\tEditCommittedEventArguments,\n\tISharedTreeEvents,\n\tGenericSharedTree,\n\tSharedTreeEvent,\n\tSharedTreeDiagnosticEvent,\n} from './GenericSharedTree';\nexport {\n\tEdit,\n\tEditWithoutId,\n\tEditBase,\n\tTraitMap,\n\tTreeNodeSequence,\n\tPayload,\n\tNodeData,\n\tTreeNode,\n\tChangeNode,\n\tBuildNode,\n\tEditStatus,\n\tTraitLocation,\n\tSharedTreeOpType,\n} from './PersistedTypes';\nexport { newEdit, newEditId } from './GenericEditUtilities';\nexport { GenericTransaction, EditingResult, ValidEditingResult } from './GenericTransaction';\nexport {\n\tSharedTreeSummary,\n\tSharedTreeSummaryBase,\n\tSharedTreeSummarizer,\n\tfullHistorySummarizer,\n\tfullHistorySummarizer_0_1_0,\n\tformatVersion,\n\tserialize,\n} from './Summary';\n"]}

package/docs/Future.md

@@ -1,155 +0,0 @@
-# Future Plans
-
-This document contains high-level overviews of several desired SharedTree features.
-
-## Edits
-
-1. Allow edits to contain metadata for use by the application. The contents would be application specific. Example use cases might include:
-
-    1. "Hierarchal edits": Encoding of how to regenerate the edit in a more semantic way (as commands in higher level domains).
-       These are allowed to be non-deterministic, and might change behavior as the application is updated.
-       They depend on the necessary domain code being loaded and supporting the used commands: some clients may be unable to make use of this data.
-    1. Metadata about the changes for use with history viewing and manipulation tools (ex: author, time etc)
-
-1. Provide a way to detect if two edits [commute](https://en.wikipedia.org/wiki/Commutative_property) for a particular version of the document (edits might commute for some documents but not others, so providing the document is required).
-   This can be conservative in that it would be allowed to return false if it is unclear it they commute.
-   A basic implementation of this would be a check if the _write set_ of each change does not overlap the _read set + write set_ of the other.
-
-1. Provide a way to detect if the applying an edit had the _intended_ effect (ex: was it turned into a noop due to conflicts, or has high risk of other kinds of merge issues)
-
-## Conflict Resolution
-
-Rather than drop edits which cause a conflict, SharedTree could expose this, giving the application an opportunity to use the Edit metadata and its domain knowledge to attempt to recreate the Edit, resolving the conflict.
-
-# Editing History
-
-The history is a sequence of Edits, but it is append only.
-Thus, a logical edit of the history is done by creating a new Edit which modifies the current version of the document to be that which would have been produced by the alternative history.
-
-This functionality will be provided by a library (yet to be written) which uses SharedTree's history inspection and Editing APIs to create history modifying Edits, including metadata necessary to properly inspect and merge them with future history modifying Edits.
-This approach does not require extra functionality in SharedTree's core.
-This approach intentionally pushes the complex merge logic into code that is not part of the DDS to:
-
--   reduce the code which can possibly impact consistency of documents between clients.
--   reduce the computation needed to interpret the history (apply Edits): burden of hard merges goes on the client that requested the merge.
--   minimize the feature set which must be supported long term for document compatibility.
-
-This design has some downsides as well:
-
--   if used to make edits far back in the history, merge resolution can produce very bloated changes (large and expensive to store and apply)
--   repeated history edits (like someone undoing and redoing a change a lot) can bloat history
-
-Because of these downsides, it may be desirable to limit use of history editing (it is intended to handle cases like undo and redo of recent edits),
-particularly when the initial edit requires Automatic Conflict Resolution, and/or is working on very large Edits or Edits which are not recent.
-
-These costs can be mitigated by encoding optimizations (Ex: allowing edits to refer to trees in snapshots and/or other edits to avoid duplication).
-
-If necessary, directly supporting history editing within SharedTree's Edits could be added without breaking existing documents or legacy support for the old approach
-(other than optionally reading the metadata when viewing history).
-This is not on the roadmap and would only be considered after a formal cost/benefit analysis.
-
-## Example History Edit
-
-This example shows how to replace the middle of 3 edits.
-This generalizes to making arbitrary history edits by considering A, B, C, and X to be arbitrary (possibly empty) sequences of edits.
-
-We start with these changes:
-
-```mermaid
-graph LR
-A(A) --> B(B) --> C(C)
-```
-
-And want to end with changes:
-
-```mermaid
-graph LR
-A(A) --> X(X) --> C(C)
-```
-
-Since history is append only, we actually end with:
-
-```mermaid
-graph LR
-A(A) --> B(B) --> C(C) --> Merge(Merge)
-```
-
-### Low Level Commuting Merge
-
-If B commutes with C in the revision output from A, and X commutes with C in the revision output from A, then the history edit is considered non-conflicted, since there is a clear way to construct the Merge edit.
-This is the only case supported by the "Low Level Commuting Merge."
-
-In this case Merge can be constructed as inverse(B) followed by X.
-Note that computing the inverse depends on the revision.
-In this case a special revision produced by A followed by C is used.
-Then B is applied, constructing inverse(B) in the process to use as part of the merge.
-
-This amounts to moving B past C (allowed because they commute), then adding inverse(B), followed by X.
-Placing X at the end is the same as placing it between A and C since it commutes with C (at revision output by A).
-
-```mermaid
-graph LR
-A(A) --> C(C) --> B(B) --> B2("B⁻¹") --> X(X)
-```
-
-This can then be transformed into its final form, which meets the requirement of only adding to the original:
-
-```mermaid
-graph LR
-A(A) --> B(B) --> C(C) --> B2("Merge: B⁻¹ + X")
-```
-
-Note that if B deletes any nodes, B⁻¹ must restore them with the same identity.
-
-### Automatic Conflict Resolution
-
-If a low level merge can not be applied directly because it is conflicted,
-it can often be restated in terms of a different history edit which will have a non-conflicting Low Level Commuting Merge.
-
-In the above example, it conflicts IIF A or X fail to commute with C.
-In the general case, where C is a sequence of Edits,
-this can always be avoided by moving edits from the beginning of C to the ends of B and X.
-This can continue until there no longer is a conflict due to lack of commuting.
-This is guaranteed to eventually fix the conflict since it can continue until C is empty, and thus commutes with anything.
-
-For initial state:
-
-```mermaid
-graph LR
-A(A) --> B(B) --> C("C1 + C2")
-```
-
-it can be regrouped like:
-
-```mermaid
-graph LR
-A(A) --> B("B + C1") --> C(C2)
-```
-
-Making the desired final state:
-
-```mermaid
-graph LR
-A(A) --> X("X + C1") --> C(C2)
-```
-
-This process can be though of as expanding the portion of the history being replaced to include a segment long enough to contain all the conflicts.
-This modified replacement can then be applied using the Low Level Commuting Merge.
-
-The challenge here is constructing `X + C1`.
-Doing this applies C1 in a different context than it was initially applied, and this C1 itself could fail to apply.
-This is where the hierarchal edit metadata can be used to assist merging.
-If there is code loaded which can use the metadata from the Edits to reapply the edits at a higher level,
-this can be used to generate a contextualized version of C1 to include in `X + C1`.
-If the higher level edits fail to be applied (either they are not available, or they fail),
-then the automatic merge resolution fails, and no merge is created
-(effectively merging the change by picking the current version as the result).
-
-### Editing Edited History
-
-When editing history that has already been edited, care must be taken to not accidentally revert the previous edits.
-This can be done by using metadata in history edits to construct the branch the history edit logically made with its alternative history instead of walking the actual op sequence.
-
-When this is implemented, particular care will have to be taken to make sure that multiple edits to history which are created concurrently either merge safely (and in a way that future edits will handle), or conflict.
-Details of this design are to be determined, but having history edits reference the newest acknowledged edit, and the range of history they are actually editing,
-and only allowing edits of the acknowledged portion of history may be enough.

package/lib/BasicCheckout.d.ts

@@ -1,23 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { Snapshot } from './Snapshot';
-import { Checkout } from './Checkout';
-import { GenericSharedTree } from './generic';
-/**
- * Basic Session that stays up to date with the SharedTree.
- *
- * waitForPendingUpdates is always a no-op since BasicCheckout is always up to date.
- * @public
- * @sealed
- */
-export declare class BasicCheckout<TChange> extends Checkout<TChange> {
-    /**
-     * @param tree - the tree
-     */
-    constructor(tree: GenericSharedTree<TChange>);
-    protected get latestCommittedView(): Snapshot;
-    waitForPendingUpdates(): Promise<void>;
-}
-//# sourceMappingURL=BasicCheckout.d.ts.map

package/lib/BasicCheckout.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"BasicCheckout.d.ts","sourceRoot":"","sources":["../src/BasicCheckout.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAA+B,iBAAiB,EAAE,MAAM,WAAW,CAAC;AAE3E;;;;;;GAMG;AACH,qBAAa,aAAa,CAAC,OAAO,CAAE,SAAQ,QAAQ,CAAC,OAAO,CAAC;IAC5D;;OAEG;gBACgB,IAAI,EAAE,iBAAiB,CAAC,OAAO,CAAC;IAMnD,SAAS,KAAK,mBAAmB,IAAI,QAAQ,CAE5C;IAEY,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC;CAGnD"}

package/lib/BasicCheckout.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"BasicCheckout.js","sourceRoot":"","sources":["../src/BasicCheckout.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAGtC;;;;;;GAMG;AACH,MAAM,OAAO,aAAuB,SAAQ,QAAiB;IAC5D;;OAEG;IACH,YAAmB,IAAgC;QAClD,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,EAAE,CAAC,IAA6D,EAAE,EAAE;YAC/F,IAAI,CAAC,UAAU,EAAE,CAAC;QACnB,CAAC,CAAC,CAAC;IACJ,CAAC;IAED,IAAc,mBAAmB;QAChC,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC;IAC9B,CAAC;IAEM,KAAK,CAAC,qBAAqB;QACjC,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC1B,CAAC;CACD","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { Snapshot } from './Snapshot';\nimport { Checkout } from './Checkout';\nimport { EditCommittedEventArguments, GenericSharedTree } from './generic';\n\n/**\n * Basic Session that stays up to date with the SharedTree.\n *\n * waitForPendingUpdates is always a no-op since BasicCheckout is always up to date.\n * @public\n * @sealed\n */\nexport class BasicCheckout<TChange> extends Checkout<TChange> {\n\t/**\n\t * @param tree - the tree\n\t */\n\tpublic constructor(tree: GenericSharedTree<TChange>) {\n\t\tsuper(tree, tree.currentView, (args: EditCommittedEventArguments<GenericSharedTree<TChange>>) => {\n\t\t\tthis.emitChange();\n\t\t});\n\t}\n\n\tprotected get latestCommittedView(): Snapshot {\n\t\treturn this.tree.currentView;\n\t}\n\n\tpublic async waitForPendingUpdates(): Promise<void> {\n\t\treturn Promise.resolve();\n\t}\n}\n"]}

package/lib/Snapshot.d.ts

@@ -1,198 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import { NodeId, TraitLabel } from './Identifiers';
-import { Delta } from './Forest';
-import { ChangeNode, NodeData, Payload, TraitLocation } from './generic';
-/**
- * An immutable view of a distributed tree node.
- * @public
- */
-export interface SnapshotNode extends NodeData {
-    readonly traits: ReadonlyMap<TraitLabel, readonly NodeId[]>;
-}
-/**
- * Index of a place within a trait.
- * 0 = before all nodes,
- * 1 = after first node,
- * etc.
- * @public
- */
-export declare type PlaceIndex = number & {
-    readonly PlaceIndex: unique symbol;
-};
-/**
- * Index of a node within a trait.
- * 0 = first node,
- * 1 = second node,
- * etc.
- * @public
- */
-export declare type TraitNodeIndex = number & {
-    readonly TraitNodeIndex: unique symbol;
-};
-/**
- * A place within a particular `Snapshot` that is anchored relative to a specific node in the tree, or relative to the outside of the trait.
- * Valid iff 'trait' is valid and, if provided, sibling is in the Location specified by 'trait'.
- * @public
- */
-export interface SnapshotPlace {
-    readonly sibling?: NodeId;
-    readonly side: Side;
-    readonly trait: TraitLocation;
-}
-/**
- * Defines a place relative to sibling.
- * The "outside" of a trait is the `undefined` sibling,
- * so After `undefined` is the beginning of the trait, and before `undefined` is the end.
- *
- * For this purpose, traits look like:
- *
- * `{undefined} - {Node 0} - {Node 1} - ... - {Node N} - {undefined}`
- *
- * Each `{value}` in the diagram is a possible sibling, which is either a Node or undefined.
- * Each `-` in the above diagram is a `Place`, and can be describe as being `After` a particular `{sibling}` or `Before` it.
- * This means that `After` `{undefined}` means the same `Place` as before the first node
- * and `Before` `{undefined}` means the `Place` after the last Node.
- *
- * Each place can be specified, (aka 'anchored') in two ways (relative to the sibling before or after):
- * the choice of which way to anchor a place only matters when the kept across an edit, and thus evaluated in multiple contexts where the
- * two place description may no longer evaluate to the same place.
- * @public
- */
-export declare enum Side {
-    Before = 0,
-    After = 1
-}
-/**
- * Specifies the range of nodes from `start` to `end` within a trait within a particular `Snapshot`.
- * Valid iff start and end are valid and are withing the same trait.
- * @public
- */
-export interface SnapshotRange {
-    readonly start: SnapshotPlace;
-    readonly end: SnapshotPlace;
-}
-/**
- * An immutable view of a distributed tree.
- * @public
- */
-export declare class Snapshot {
-    readonly root: NodeId;
-    private readonly forest;
-    /**
-     * A cache of node's index within their parent trait.
-     * Used to avoid redundant linear scans of traits.
-     * Not shared across snapshots; initialized to empty each time a Snapshot is created.
-     */
-    private traitIndicesCache?;
-    /**
-     * Constructs a Snapshot using the supplied tree.
-     * @param root - the root of the tree to use as the contents of the `Snapshot`
-     */
-    static fromTree(root: ChangeNode, expensiveValidation?: boolean): Snapshot;
-    private constructor();
-    /** Return a tree of JSON-compatible `ChangeNode`s representing the current state of this `Snapshot` */
-    getChangeNodeTree(): ChangeNode;
-    /**
-     * Returns the number of nodes in this `Snapshot`
-     */
-    get size(): number;
-    /**
-     * @returns true iff the nodeId exists.
-     */
-    hasNode(id: NodeId): boolean;
-    /**
-     * @returns a `ChangeNode` derived from the `SnapshotNode` in this snapshot with the given `NodeId`.
-     */
-    getChangeNode(id: NodeId): ChangeNode;
-    /**
-     * @returns the `ChangeNode`s derived from the `SnapshotNode`s in this snapshot with the given `NodeId`s.
-     */
-    getChangeNodes(nodeIds: readonly NodeId[]): ChangeNode[];
-    /**
-     * Asserts the forest is in a consistent state.
-     */
-    assertConsistent(): void;
-    /**
-     * Inserts all nodes in a NodeSequence into the forest.
-     */
-    addNodes(sequence: Iterable<SnapshotNode>): Snapshot;
-    /**
-     * Remove all nodes with the given ids from the forest
-     */
-    deleteNodes(nodes: Iterable<NodeId>): Snapshot;
-    /**
-     * Parents a set of detached nodes at a specified place.
-     * @param nodesToAttach - the nodes to parent in the specified place. The nodes must already be present in the Snapshot.
-     * @param place - the location to insert the nodes.
-     */
-    attachRange(nodesToAttach: readonly NodeId[], place: SnapshotPlace): Snapshot;
-    /**
-     * Detaches a range of nodes from their parent. The detached nodes remain in the Snapshot.
-     * @param rangeToDetach - the range of nodes to detach
-     */
-    detachRange(rangeToDetach: SnapshotRange): {
-        snapshot: Snapshot;
-        detached: readonly NodeId[];
-    };
-    /**
-     * Sets a node's value. The node must exist in this `Snapshot`.
-     * @param nodeId - the id of the node
-     * @param value - the new value
-     */
-    setNodeValue(nodeId: NodeId, value: Payload): Snapshot;
-    /**
-     * @returns the index just after place (which specifies a location between items).
-     * Performance note: this is O(siblings in trait).
-     */
-    findIndexWithinTrait(place: SnapshotPlace): PlaceIndex;
-    /**
-     * Returns the node associated with `id` in this `Snapshot`.
-     */
-    getSnapshotNode(id: NodeId): SnapshotNode;
-    /**
-     * Returns the label of the trait that a node is under. Returns undefined if the node is not present or if it is the root node.
-     */
-    getTraitLabel(id: NodeId): TraitLabel | undefined;
-    /**
-     * Returns the parent of a node. Returns undefined if the node does not exist in the snapshot or if it does not have a parent.
-     */
-    getParentSnapshotNode(id: NodeId): SnapshotNode | undefined;
-    /**
-     * @param node - must have a parent.
-     */
-    getTraitLocation(node: NodeId): TraitLocation;
-    /**
-     * @param node - must have a parent.
-     * Performance note: this is O(siblings in trait).
-     */
-    getIndexInTrait(node: NodeId): TraitNodeIndex;
-    /**
-     * Return a trait given its location
-     * @param traitLocation - the location of the trait
-     */
-    getTrait(traitLocation: TraitLocation): readonly NodeId[];
-    private getIndexOfSide;
-    /** Compares this snapshot to another for equality. */
-    equals(snapshot: Snapshot): boolean;
-    private iterateNodeDescendants;
-    /**
-     * Calculate the difference between two `Snapshot`s
-     * @param snapshot - the other snapshot to compare to this one
-     * @returns A {@link Delta} which nodes must be changed, added, and removed to get from `this` to `snapshot`.
-     * The snapshots must share a root.
-     */
-    delta(snapshot: Snapshot): Delta<NodeId>;
-    [Symbol.iterator](): IterableIterator<SnapshotNode>;
-}
-/**
- * Contains some redundant information. Use only in computations between edits. Do not store.
- * @public
- */
-export interface NodeInTrait {
-    readonly trait: TraitLocation;
-    readonly index: TraitNodeIndex;
-}
-//# sourceMappingURL=Snapshot.d.ts.map

package/lib/Snapshot.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Snapshot.d.ts","sourceRoot":"","sources":["../src/Snapshot.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAEnD,OAAO,EAAE,KAAK,EAAU,MAAM,UAAU,CAAC;AACzC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,OAAO,EAAE,aAAa,EAAE,MAAM,WAAW,CAAC;AAEzE;;;GAGG;AACH,MAAM,WAAW,YAAa,SAAQ,QAAQ;IAC7C,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC,UAAU,EAAE,SAAS,MAAM,EAAE,CAAC,CAAC;CAC5D;AAED;;;;;;GAMG;AACH,oBAAY,UAAU,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,UAAU,EAAE,OAAO,MAAM,CAAA;CAAE,CAAC;AAEzE;;;;;;GAMG;AACH,oBAAY,cAAc,GAAG,MAAM,GAAG;IAAE,QAAQ,CAAC,cAAc,EAAE,OAAO,MAAM,CAAA;CAAE,CAAC;AAEjF;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC7B,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,CAAC;IAC1B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IACpB,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;CAC9B;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,oBAAY,IAAI;IACf,MAAM,IAAI;IACV,KAAK,IAAI;CACT;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa;IAC7B,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;IAC9B,QAAQ,CAAC,GAAG,EAAE,aAAa,CAAC;CAC5B;AAED;;;GAGG;AACH,qBAAa,QAAQ;IACpB,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAEhC;;;;OAIG;IACH,OAAO,CAAC,iBAAiB,CAAC,CAA8B;IAExD;;;OAGG;WACW,QAAQ,CAAC,IAAI,EAAE,UAAU,EAAE,mBAAmB,UAAQ,GAAG,QAAQ;IA+B/E,OAAO;IAKP,uGAAuG;IAChG,iBAAiB,IAAI,UAAU;IAItC;;OAEG;IACH,IAAW,IAAI,IAAI,MAAM,CAExB;IAED;;OAEG;IACI,OAAO,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO;IAInC;;OAEG;IACI,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU;IAI5C;;OAEG;IACI,cAAc,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,GAAG,UAAU,EAAE;IAI/D;;OAEG;IACI,gBAAgB,IAAI,IAAI;IAI/B;;OAEG;IACI,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,YAAY,CAAC,GAAG,QAAQ;IAI3D;;OAEG;IACI,WAAW,CAAC,KAAK,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,QAAQ;IAIrD;;;;OAIG;IACI,WAAW,CAAC,aAAa,EAAE,SAAS,MAAM,EAAE,EAAE,KAAK,EAAE,aAAa,GAAG,QAAQ;IAMpF;;;OAGG;IACI,WAAW,CAAC,aAAa,EAAE,aAAa,GAAG;QAAE,QAAQ,EAAE,QAAQ,CAAC;QAAC,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAA;KAAE;IAUrG;;;;OAIG;IACI,YAAY,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,OAAO,GAAG,QAAQ;IAI7D;;;OAGG;IACI,oBAAoB,CAAC,KAAK,EAAE,aAAa,GAAG,UAAU;IAO7D;;OAEG;IACI,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,YAAY;IAIhD;;OAEG;IACI,aAAa,CAAC,EAAE,EAAE,MAAM,GAAG,UAAU,GAAG,SAAS;IAIxD;;OAEG;IACI,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;IAQlE;;OAEG;IACI,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,aAAa;IASpD;;;OAGG;IACI,eAAe,CAAC,IAAI,EAAE,MAAM,GAAG,cAAc;IAyBpD;;;OAGG;IACI,QAAQ,CAAC,aAAa,EAAE,aAAa,GAAG,SAAS,MAAM,EAAE;IAIhE,OAAO,CAAC,cAAc;IAItB,sDAAsD;IAC/C,MAAM,CAAC,QAAQ,EAAE,QAAQ,GAAG,OAAO;IAS1C,OAAO,CAAE,sBAAsB;IAU/B;;;;;OAKG;IACI,KAAK,CAAC,QAAQ,EAAE,QAAQ,GAAG,KAAK,CAAC,MAAM,CAAC;IAKxC,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAAC,YAAY,CAAC;CAG1D;AAOD;;;GAGG;AACH,MAAM,WAAW,WAAW;IAC3B,QAAQ,CAAC,KAAK,EAAE,aAAa,CAAC;IAC9B,QAAQ,CAAC,KAAK,EAAE,cAAc,CAAC;CAC/B"}