@fluid-experimental/tree 0.58.2001 → 0.59.2000-61729

package/{lib/default-edits/PersistedTypes.d.ts → dist/ChangeTypes.d.ts}

@@ -2,40 +2,18 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { DetachedSequenceId, NodeId, TraitLabel, UuidString } from '../Identifiers';
-import { Side } from '../Snapshot';
-import { EditBase, BuildNode, NodeData, Payload, TraitLocation, TreeNodeSequence } from '../generic';
+import { NodeId, TraitLabel, UuidString } from './Identifiers';
+import { ConstraintEffect, NodeData, Payload, Side, TreeNodeSequence } from './persisted-types';
+import { TraitLocation } from './TreeView';
 /**
- * Types for Edits in Fluid Ops and Fluid summaries.
- *
- * Types describing locations in the tree are stable in the presence of other concurrent edits.
- *
- * All types are compatible with Fluid Serializable.
- *
- * These types can only be modified in ways that are both backwards and forwards compatible since they
- * are used in edits, and thus are persisted (using Fluid serialization).
- *
- * This means these types cannot be changed in any way that impacts their Fluid serialization
- * except through a very careful process:
- *
- * 1. The planned change must support all old data, and maintain the exact semantics of it.
- * This means that the change is pretty much limited to adding optional fields,
- * or making required fields optional.
- * 2. Support for the new format must be deployed to all users (This means all applications using SharedTree must do this),
- * and this deployment must be confirmed to be stable and will not be rolled back.
- * 3. Usage of the new format may start.
- *
- * Support for the old format can NEVER be removed: it must be maintained indefinably or old documents will break.
- * Because this process puts requirements on applications using shared tree,
- * step 3 should only ever be done in a Major version update,
- * and must be explicitly called out in the release notes
- * stating which versions of SharedTree are supported for documents modified by the new version.
- */
-/**
- * The information included in an edit.
+ * An object which may have traits with children of the given type underneath it
  * @public
  */
-export declare type DefaultEditBase = EditBase<Change>;
+export interface HasVariadicTraits<TChild> {
+    readonly traits?: {
+        readonly [key: string]: TChild | TreeNodeSequence<TChild> | undefined;
+    };
+}
 /**
  * The type of a Change
  * @public
@@ -56,6 +34,25 @@ export declare enum ChangeType {
  * @public
  */
 export declare type Change = Insert | Detach | Build | SetValue | Constraint;
+/**
+ * Node or a detached sequence of nodes (referred to by a detached sequence ID) for use in a Build change.
+ * See `BuildTreeNode` for more.
+ * @public
+ */
+export declare type BuildNode = BuildTreeNode | number;
+/**
+ * Node for use in a Build change, which is composed of a definition describing what this nodes type, an identifier identifying this node
+ * within the tree, and a payload containing an opaque serializable piece of data.
+ * An identifier can be provided explicitly if the node must be referred to before the results of the `Change` containing this
+ * BuildTreeNode can be observed. If `identifier` is not supplied, one will be generated for it in an especially efficient manner
+ * that allows for compact storage and transmission and thus this property should be omitted if convenient.
+ * See the SharedTree readme for more on the tree format.
+ */
+export interface BuildTreeNode extends HasVariadicTraits<BuildNode> {
+    definition: string;
+    identifier?: NodeId;
+    payload?: Payload;
+}
 /**
  * Constructs a sequence of nodes, associates it with the supplied ID, and stores it for use in later changes.
  * Does not modify the document.
@@ -63,17 +60,11 @@ export declare type Change = Insert | Detach | Build | SetValue | Constraint;
  * Valid if (transitively) all DetachedSequenceId are used according to their rules (use here counts as a destination),
  * and all Nodes' identifiers are previously unused.
  *
- * TODO: Design Decision:
- * If allowing 'moving from nowhere' to restore nodes: all new Nodes must have never before used identifiers.
- * Otherwise could just forbid identifiers currently reachable?
- * Could also allow introducing a node with a particular identifier to mean replacing that node with the new one
- * (could include optional constraint to require/prevent this).
- *
  * @public
  */
 export interface Build {
-    readonly destination: DetachedSequenceId;
-    readonly source: TreeNodeSequence<BuildNode>;
+    readonly destination: number;
+    readonly source: BuildNode | TreeNodeSequence<BuildNode>;
     readonly type: typeof ChangeType.Build;
 }
 /**
@@ -83,7 +74,7 @@ export interface Build {
  */
 export interface Insert {
     readonly destination: StablePlace;
-    readonly source: DetachedSequenceId;
+    readonly source: number;
     readonly type: typeof ChangeType.Insert;
 }
 /**
@@ -94,7 +85,7 @@ export interface Insert {
  * @public
  */
 export interface Detach {
-    readonly destination?: DetachedSequenceId;
+    readonly destination?: number;
     readonly source: StableRange;
     readonly type: typeof ChangeType.Detach;
 }
@@ -167,66 +158,34 @@ export interface Constraint {
      */
     readonly type: typeof ChangeType.Constraint;
 }
-/**
- * What to do when a Constraint is violated.
- * @public
- */
-export declare enum ConstraintEffect {
-    /**
-     * Discard Edit.
-     */
-    InvalidAndDiscard = 0,
-    /**
-     * Discard Edit, but record metadata that application may want to try and recover this change by recreating it.
-     * Should this be the default policy for when another (non Constraint) change is invalid?
-     */
-    InvalidRetry = 1,
-    /**
-     * Apply the change, but flag it for possible reconsideration by the app
-     * (applying it is better than not, but perhaps the high level logic could produce something better).
-     */
-    ValidRetry = 2
-}
 /**
  * @public
  */
 export declare const Change: {
-    build: (source: TreeNodeSequence<BuildNode>, destination: DetachedSequenceId) => Build;
-    insert: (source: DetachedSequenceId, destination: StablePlace) => Insert;
-    detach: (source: StableRange, destination?: DetachedSequenceId | undefined) => Detach;
+    build: (source: BuildNode | TreeNodeSequence<BuildNode>, destination: number) => Build;
+    insert: (source: number, destination: StablePlace) => Insert;
+    detach: (source: StableRange, destination?: number | undefined) => Detach;
     setPayload: (nodeToModify: NodeId, payload: Payload) => SetValue;
     clearPayload: (nodeToModify: NodeId) => SetValue;
-    constraint: (toConstrain: StableRange, effect: ConstraintEffect, identityHash?: UuidString | undefined, length?: number | undefined, contentHash?: UuidString | undefined, parentNode?: NodeId | undefined, label?: TraitLabel | undefined) => Constraint;
-};
-/**
- * Helper for creating a `Delete` edit.
- * @public
- */
-export declare const Delete: {
+    constraint: (toConstrain: StableRange, effect: ConstraintEffect, identityHash?: UuidString | undefined, length?: number | undefined, contentHash?: UuidString | undefined, parentNode?: (number & {
+        readonly LocalCompressedId: "6fccb42f-e2a4-4243-bd29-f13d12b9c6d1";
+    } & import("./Identifiers").SessionUnique & import("./Identifiers").NodeIdBrand) | (number & {
+        readonly FinalCompressedId: "5d83d1e2-98b7-4e4e-a889-54c855cfa73d";
+        readonly OpNormalized: "9209432d-a959-4df7-b2ad-767ead4dbcae";
+    } & import("./Identifiers").SessionUnique & import("./Identifiers").NodeIdBrand) | undefined, label?: TraitLabel | undefined) => Constraint;
+    /** Helpers for making high-level composite operations */
     /**
-     * @returns a Change that deletes the supplied part of the tree.
+     * @returns a change that deletes the supplied part of the tree.
      */
-    create: (stableRange: StableRange) => Change;
-};
-/**
- * Helper for creating an `Insert` edit.
- * @public
- */
-export declare const Insert: {
+    delete: (stableRange: StableRange) => Change;
     /**
-     * @returns a Change that inserts 'nodes' into the specified location in the tree.
+     * @returns changes that insert 'nodes' into the specified location in the tree.
      */
-    create: (nodes: TreeNodeSequence<BuildNode>, destination: StablePlace) => Change[];
-};
-/**
- * Helper for creating a `Move` edit.
- * @public
- */
-export declare const Move: {
+    insertTree: (nodes: BuildNode | TreeNodeSequence<BuildNode>, destination: StablePlace) => Change[];
     /**
-     * @returns a Change that moves the specified content to a new location in the tree.
+     * @returns changes that moves the specified content to a new location in the tree.
      */
-    create: (source: StableRange, destination: StablePlace) => Change[];
+    move: (source: StableRange, destination: StablePlace) => Change[];
 };
 /**
  * A location in a trait.
@@ -236,8 +195,10 @@ export declare const Move: {
  * To be well formed, either `sibling` or `trait` must be defined, but not both.
  *
  * Any given insertion location can be described by two `StablePlace` objects, one with `Side.After` and one with `Side.Before`.
- * For example, in a trait containing two strings "foo" and "bar", there are 6 places corresponding to 3 places into the trait a new node
- * could be inserted: at the start, before "foo", after "foo", before "bar", after "bar", and at the end.
+ * For example, in a trait containing two strings "foo" and "bar", there are 6 different `StablePlace`s corresponding to 3 locations in the
+ * trait a new node could be inserted: at the start, before "foo", after "foo", before "bar", after "bar", and at the end.
+ * Neither of the two ways to specify the same location are considered to be after each other.
+ *
  * The anchor (`referenceSibling` or `referenceTrait`) used for a particular `StablePlace` can have an impact in collaborative scenarios.
  *
  * `StablePlace` objects can be conveniently constructed with the helper methods exported on a constant of the same name.
@@ -268,6 +229,8 @@ export interface StablePlace {
  * Specifies the range of nodes from `start` to `end` within a trait.
  * Valid iff start and end are valid and are within the same trait and the start does not occur after the end in the trait.
  *
+ * See {@link (StablePlace:interface)} for what it means for a place to be "after" another place.
+ *
  * `StableRange` objects can be conveniently constructed with the helper methods exported on a constant of the same name.
  * @example
  * StableRange.from(StablePlace.before(startNode)).to(StablePlace.after(endNode))
@@ -291,11 +254,11 @@ export declare const StablePlace: {
     /**
      * @returns The location directly before `node`.
      */
-    before: (node: NodeData | NodeId) => StablePlace;
+    before: (node: NodeData<NodeId> | NodeId) => StablePlace;
     /**
      * @returns The location directly after `node`.
      */
-    after: (node: NodeData | NodeId) => StablePlace;
+    after: (node: NodeData<NodeId> | NodeId) => StablePlace;
     /**
      * @returns The location at the start of `trait`.
      */
@@ -321,7 +284,7 @@ export declare const StableRange: {
      * @returns a `StableRange` which contains only the provided `node`.
      * Both the start and end `StablePlace` objects used to anchor this `StableRange` are in terms of the passed in node.
      */
-    only: (node: NodeData | NodeId) => StableRange;
+    only: (node: NodeData<NodeId> | NodeId) => StableRange;
     /**
      * @returns a `StableRange` which contains everything in the trait.
      * This is anchored using the provided `trait`, and is independent of the actual contents of the trait:
@@ -329,14 +292,4 @@ export declare const StableRange: {
      */
     all: (trait: TraitLocation) => StableRange;
 };
-/**
- * @returns True iff the given `node` is of type NodeData.
- * @internal
- */
-export declare function isNodeData(node: NodeData | NodeId): node is NodeData;
-/**
- * @returns The NodeId for a given node or its id.
- * @internal
- */
-export declare function getNodeId(node: NodeData | NodeId): NodeId;
-//# sourceMappingURL=PersistedTypes.d.ts.map
+//# sourceMappingURL=ChangeTypes.d.ts.map

package/dist/ChangeTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChangeTypes.d.ts","sourceRoot":"","sources":["../src/ChangeTypes.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAE/D,OAAO,EAAE,gBAAgB,EAAE,QAAQ,EAAE,OAAO,EAAE,IAAI,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AAChG,OAAO,EAAE,aAAa,EAAE,MAAM,YAAY,CAAC;AAG3C;;;GAGG;AACH,MAAM,WAAW,iBAAiB,CAAC,MAAM;IACxC,QAAQ,CAAC,MAAM,CAAC,EAAE;QACjB,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;KACtE,CAAC;CACF;AAED;;;GAGG;AACH,oBAAY,UAAU;IACrB,MAAM,IAAA;IACN,MAAM,IAAA;IACN,KAAK,IAAA;IACL,QAAQ,IAAA;IACR,UAAU,IAAA;CACV;AAED;;;;;;;GAOG;AACH,oBAAY,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,KAAK,GAAG,QAAQ,GAAG,UAAU,CAAC;AAErE;;;;GAIG;AACH,oBAAY,SAAS,GAAG,aAAa,GAAG,MAAM,CAAC;AAE/C;;;;;;;GAOG;AACH,MAAM,WAAW,aAAc,SAAQ,iBAAiB,CAAC,SAAS,CAAC;IAClE,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,OAAO,CAAC,EAAE,OAAO,CAAC;CAClB;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,KAAK;IACrB,QAAQ,CAAC,WAAW,EAAE,MAAM,CAAC;IAC7B,QAAQ,CAAC,MAAM,EAAE,SAAS,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC;IACzD,QAAQ,CAAC,IAAI,EAAE,OAAO,UAAU,CAAC,KAAK,CAAC;CACvC;AAED;;;;GAIG;AACH,MAAM,WAAW,MAAM;IACtB,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAClC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;IACxB,QAAQ,CAAC,IAAI,EAAE,OAAO,UAAU,CAAC,MAAM,CAAC;CACxC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,MAAM;IACtB,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAC9B,QAAQ,CAAC,MAAM,EAAE,WAAW,CAAC;IAC7B,QAAQ,CAAC,IAAI,EAAE,OAAO,UAAU,CAAC,MAAM,CAAC;CACxC;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ;IACxB,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;IAC9B;;;;;OAKG;IAEH,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IACjC,QAAQ,CAAC,IAAI,EAAE,OAAO,UAAU,CAAC,QAAQ,CAAC;CAC1C;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,UAAU;IAC1B;;;;;;OAMG;IACH,QAAQ,CAAC,WAAW,EAAE,WAAW,CAAC;IAElC;;;;;;OAMG;IACH,QAAQ,CAAC,YAAY,CAAC,EAAE,UAAU,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IAEzB;;;;;;OAMG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;IAE7B;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC;IAE5B;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAElC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,OAAO,UAAU,CAAC,UAAU,CAAC;CAC5C;AAGD;;GAEG;AACH,eAAO,MAAM,MAAM;oBACF,SAAS,GAAG,iBAAiB,SAAS,CAAC,eAAe,MAAM,KAAG,KAAK;qBAMnE,MAAM,eAAe,WAAW,KAAG,MAAM;qBAMzC,WAAW,uCAAyB,MAAM;+BAMhC,MAAM,WAAW,OAAO,KAAG,QAAQ;iCAMjC,MAAM,KAAG,QAAQ;8BAQhC,WAAW,UAChB,gBAAgB;;;;;qIAMtB,UAAU;IAWb,yDAAyD;IAEzD;;OAEG;0BACmB,WAAW,KAAG,MAAM;IAE1C;;OAEG;wBACiB,SAAS,GAAG,iBAAiB,SAAS,CAAC,eAAe,WAAW,KAAG,MAAM,EAAE;IAKhG;;OAEG;mBACY,WAAW,eAAe,WAAW,KAAG,MAAM,EAAE;CAI/D,CAAC;AAEF;;;;;;;;;;;;;;;;;;;GAmBG;AACH,MAAM,WAAW,WAAW;IAC3B;;;;OAIG;IACH,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IAEpB;;;OAGG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAEnC;;;OAGG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,aAAa,CAAC;CACxC;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,WAAW;IAC3B,QAAQ,CAAC,KAAK,EAAE,WAAW,CAAC;IAC5B,QAAQ,CAAC,GAAG,EAAE,WAAW,CAAC;CAC1B;AAED;;;;;;GAMG;AAGH;;GAEG;AACH,eAAO,MAAM,WAAW;IACvB;;OAEG;mBACY,SAAS,MAAM,CAAC,GAAG,MAAM,KAAG,WAAW;IAItD;;OAEG;kBACW,SAAS,MAAM,CAAC,GAAG,MAAM,KAAG,WAAW;IACrD;;OAEG;uBACgB,aAAa,KAAG,WAAW;IAC9C;;OAEG;qBACc,aAAa,KAAG,WAAW;CAC5C,CAAC;AAGF;;GAEG;AACH,eAAO,MAAM,WAAW;IACvB;;;;OAIG;kBACW,WAAW;kBAAe,WAAW,KAAK,WAAW;;IAUnE;;;OAGG;iBACU,SAAS,MAAM,CAAC,GAAG,MAAM,KAAG,WAAW;IAIpD;;;;OAIG;iBACU,aAAa,KAAG,WAAW;CAIxC,CAAC"}

package/dist/{default-edits/PersistedTypes.js → ChangeTypes.js}

@@ -4,9 +4,10 @@
  * Licensed under the MIT License.
  */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getNodeId = exports.isNodeData = exports.StableRange = exports.StablePlace = exports.Move = exports.Insert = exports.Delete = exports.Change = exports.ConstraintEffect = exports.ChangeType = void 0;
-const Common_1 = require("../Common");
-const Snapshot_1 = require("../Snapshot");
+exports.StableRange = exports.StablePlace = exports.Change = exports.ChangeType = void 0;
+const Common_1 = require("./Common");
+const persisted_types_1 = require("./persisted-types");
+const NodeIdUtilities_1 = require("./NodeIdUtilities");
 /**
  * The type of a Change
  * @public
@@ -19,27 +20,6 @@ var ChangeType;
     ChangeType[ChangeType["SetValue"] = 3] = "SetValue";
     ChangeType[ChangeType["Constraint"] = 4] = "Constraint";
 })(ChangeType = exports.ChangeType || (exports.ChangeType = {}));
-/**
- * What to do when a Constraint is violated.
- * @public
- */
-var ConstraintEffect;
-(function (ConstraintEffect) {
-    /**
-     * Discard Edit.
-     */
-    ConstraintEffect[ConstraintEffect["InvalidAndDiscard"] = 0] = "InvalidAndDiscard";
-    /**
-     * Discard Edit, but record metadata that application may want to try and recover this change by recreating it.
-     * Should this be the default policy for when another (non Constraint) change is invalid?
-     */
-    ConstraintEffect[ConstraintEffect["InvalidRetry"] = 1] = "InvalidRetry";
-    /**
-     * Apply the change, but flag it for possible reconsideration by the app
-     * (applying it is better than not, but perhaps the high level logic could produce something better).
-     */
-    ConstraintEffect[ConstraintEffect["ValidRetry"] = 2] = "ValidRetry";
-})(ConstraintEffect = exports.ConstraintEffect || (exports.ConstraintEffect = {}));
 // Note: Documentation of this constant is merged with documentation of the `Change` interface.
 /**
  * @public
@@ -81,39 +61,22 @@ exports.Change = {
         label,
         type: ChangeType.Constraint,
     }),
-};
-/**
- * Helper for creating a `Delete` edit.
- * @public
- */
-exports.Delete = {
+    /** Helpers for making high-level composite operations */
     /**
-     * @returns a Change that deletes the supplied part of the tree.
+     * @returns a change that deletes the supplied part of the tree.
      */
-    create: (stableRange) => exports.Change.detach(stableRange),
-};
-/**
- * Helper for creating an `Insert` edit.
- * @public
- */
-exports.Insert = {
+    delete: (stableRange) => exports.Change.detach(stableRange),
     /**
-     * @returns a Change that inserts 'nodes' into the specified location in the tree.
+     * @returns changes that insert 'nodes' into the specified location in the tree.
      */
-    create: (nodes, destination) => {
+    insertTree: (nodes, destination) => {
         const build = exports.Change.build(nodes, 0);
         return [build, exports.Change.insert(build.destination, destination)];
     },
-};
-/**
- * Helper for creating a `Move` edit.
- * @public
- */
-exports.Move = {
     /**
-     * @returns a Change that moves the specified content to a new location in the tree.
+     * @returns changes that moves the specified content to a new location in the tree.
      */
-    create: (source, destination) => {
+    move: (source, destination) => {
         const detach = exports.Change.detach(source, 0);
         return [detach, exports.Change.insert(Common_1.assertNotUndefined(detach.destination), destination)];
     },
@@ -134,21 +97,21 @@ exports.StablePlace = {
      * @returns The location directly before `node`.
      */
     before: (node) => ({
-        side: Snapshot_1.Side.Before,
-        referenceSibling: getNodeId(node),
+        side: persisted_types_1.Side.Before,
+        referenceSibling: NodeIdUtilities_1.getNodeId(node),
     }),
     /**
      * @returns The location directly after `node`.
      */
-    after: (node) => ({ side: Snapshot_1.Side.After, referenceSibling: getNodeId(node) }),
+    after: (node) => ({ side: persisted_types_1.Side.After, referenceSibling: NodeIdUtilities_1.getNodeId(node) }),
     /**
      * @returns The location at the start of `trait`.
      */
-    atStartOf: (trait) => ({ side: Snapshot_1.Side.After, referenceTrait: trait }),
+    atStartOf: (trait) => ({ side: persisted_types_1.Side.After, referenceTrait: trait }),
     /**
      * @returns The location at the end of `trait`.
      */
-    atEndOf: (trait) => ({ side: Snapshot_1.Side.Before, referenceTrait: trait }),
+    atEndOf: (trait) => ({ side: persisted_types_1.Side.Before, referenceTrait: trait }),
 };
 // Note: Documentation of this constant is merged with documentation of the `StableRange` interface.
 /**
@@ -174,7 +137,10 @@ exports.StableRange = {
      * @returns a `StableRange` which contains only the provided `node`.
      * Both the start and end `StablePlace` objects used to anchor this `StableRange` are in terms of the passed in node.
      */
-    only: (node) => ({ start: exports.StablePlace.before(node), end: exports.StablePlace.after(node) }),
+    only: (node) => ({
+        start: exports.StablePlace.before(node),
+        end: exports.StablePlace.after(node),
+    }),
     /**
      * @returns a `StableRange` which contains everything in the trait.
      * This is anchored using the provided `trait`, and is independent of the actual contents of the trait:
@@ -185,25 +151,4 @@ exports.StableRange = {
         end: exports.StablePlace.atEndOf(trait),
     }),
 };
-/**
- * @returns True iff the given `node` is of type NodeData.
- * @internal
- */
-function isNodeData(node) {
-    return node.definition !== undefined && node.identifier !== undefined;
-}
-exports.isNodeData = isNodeData;
-/**
- * @returns The NodeId for a given node or its id.
- * @internal
- */
-function getNodeId(node) {
-    if (isNodeData(node)) {
-        return node.identifier;
-    }
-    else {
-        return node;
-    }
-}
-exports.getNodeId = getNodeId;
-//# sourceMappingURL=PersistedTypes.js.map
+//# sourceMappingURL=ChangeTypes.js.map

package/dist/ChangeTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChangeTypes.js","sourceRoot":"","sources":["../src/ChangeTypes.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,qCAAsD;AACtD,uDAAgG;AAEhG,uDAA8C;AAY9C;;;GAGG;AACH,IAAY,UAMX;AAND,WAAY,UAAU;IACrB,+CAAM,CAAA;IACN,+CAAM,CAAA;IACN,6CAAK,CAAA;IACL,mDAAQ,CAAA;IACR,uDAAU,CAAA;AACX,CAAC,EANW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAMrB;AAuJD,+FAA+F;AAC/F;;GAEG;AACU,QAAA,MAAM,GAAG;IACrB,KAAK,EAAE,CAAC,MAA+C,EAAE,WAAmB,EAAS,EAAE,CAAC,CAAC;QACxF,WAAW;QACX,MAAM;QACN,IAAI,EAAE,UAAU,CAAC,KAAK;KACtB,CAAC;IAEF,MAAM,EAAE,CAAC,MAAc,EAAE,WAAwB,EAAU,EAAE,CAAC,CAAC;QAC9D,WAAW;QACX,MAAM;QACN,IAAI,EAAE,UAAU,CAAC,MAAM;KACvB,CAAC;IAEF,MAAM,EAAE,CAAC,MAAmB,EAAE,WAAoB,EAAU,EAAE,CAAC,CAAC;QAC/D,WAAW;QACX,MAAM;QACN,IAAI,EAAE,UAAU,CAAC,MAAM;KACvB,CAAC;IAEF,UAAU,EAAE,CAAC,YAAoB,EAAE,OAAgB,EAAY,EAAE,CAAC,CAAC;QAClE,YAAY;QACZ,OAAO;QACP,IAAI,EAAE,UAAU,CAAC,QAAQ;KACzB,CAAC;IAEF,YAAY,EAAE,CAAC,YAAoB,EAAY,EAAE,CAAC,CAAC;QAClD,YAAY;QACZ,sFAAsF;QACtF,OAAO,EAAE,IAAI;QACb,IAAI,EAAE,UAAU,CAAC,QAAQ;KACzB,CAAC;IAEF,UAAU,EAAE,CACX,WAAwB,EACxB,MAAwB,EACxB,YAAyB,EACzB,MAAe,EACf,WAAwB,EACxB,UAAmB,EACnB,KAAkB,EACL,EAAE,CAAC,CAAC;QACjB,WAAW;QACX,MAAM;QACN,YAAY;QACZ,MAAM;QACN,WAAW;QACX,UAAU;QACV,KAAK;QACL,IAAI,EAAE,UAAU,CAAC,UAAU;KAC3B,CAAC;IAEF,yDAAyD;IAEzD;;OAEG;IACH,MAAM,EAAE,CAAC,WAAwB,EAAU,EAAE,CAAC,cAAM,CAAC,MAAM,CAAC,WAAW,CAAC;IAExE;;OAEG;IACH,UAAU,EAAE,CAAC,KAA8C,EAAE,WAAwB,EAAY,EAAE;QAClG,MAAM,KAAK,GAAG,cAAM,CAAC,KAAK,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC;QACrC,OAAO,CAAC,KAAK,EAAE,cAAM,CAAC,MAAM,CAAC,KAAK,CAAC,WAAW,EAAE,WAAW,CAAC,CAAC,CAAC;IAC/D,CAAC;IAED;;OAEG;IACH,IAAI,EAAE,CAAC,MAAmB,EAAE,WAAwB,EAAY,EAAE;QACjE,MAAM,MAAM,GAAG,cAAM,CAAC,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC;QACxC,OAAO,CAAC,MAAM,EAAE,cAAM,CAAC,MAAM,CAAC,2BAAkB,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,WAAW,CAAC,CAAC,CAAC;IACrF,CAAC;CACD,CAAC;AA2DF;;;;;;GAMG;AAEH,oGAAoG;AACpG;;GAEG;AACU,QAAA,WAAW,GAAG;IAC1B;;OAEG;IACH,MAAM,EAAE,CAAC,IAA+B,EAAe,EAAE,CAAC,CAAC;QAC1D,IAAI,EAAE,sBAAI,CAAC,MAAM;QACjB,gBAAgB,EAAE,2BAAS,CAAC,IAAI,CAAC;KACjC,CAAC;IACF;;OAEG;IACH,KAAK,EAAE,CAAC,IAA+B,EAAe,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,sBAAI,CAAC,KAAK,EAAE,gBAAgB,EAAE,2BAAS,CAAC,IAAI,CAAC,EAAE,CAAC;IAClH;;OAEG;IACH,SAAS,EAAE,CAAC,KAAoB,EAAe,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,sBAAI,CAAC,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC;IAC/F;;OAEG;IACH,OAAO,EAAE,CAAC,KAAoB,EAAe,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,sBAAI,CAAC,MAAM,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC;CAC9F,CAAC;AAEF,oGAAoG;AACpG;;GAEG;AACU,QAAA,WAAW,GAAG;IAC1B;;;;OAIG;IACH,IAAI,EAAE,CAAC,KAAkB,EAA6C,EAAE,CAAC,CAAC;QACzE,EAAE,EAAE,CAAC,GAAgB,EAAe,EAAE;YACrC,IAAI,KAAK,CAAC,cAAc,IAAI,GAAG,CAAC,cAAc,EAAE;gBAC/C,MAAM,OAAO,GAAG,oEAAoE,CAAC;gBACrF,eAAM,CAAC,KAAK,CAAC,cAAc,CAAC,MAAM,KAAK,GAAG,CAAC,cAAc,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;gBAC3E,eAAM,CAAC,KAAK,CAAC,cAAc,CAAC,KAAK,KAAK,GAAG,CAAC,cAAc,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;aACzE;YACD,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC;QACvB,CAAC;KACD,CAAC;IACF;;;OAGG;IACH,IAAI,EAAE,CAAC,IAA+B,EAAe,EAAE,CAAC,CAAC;QACxD,KAAK,EAAE,mBAAW,CAAC,MAAM,CAAC,IAAI,CAAC;QAC/B,GAAG,EAAE,mBAAW,CAAC,KAAK,CAAC,IAAI,CAAC;KAC5B,CAAC;IACF;;;;OAIG;IACH,GAAG,EAAE,CAAC,KAAoB,EAAe,EAAE,CAAC,CAAC;QAC5C,KAAK,EAAE,mBAAW,CAAC,SAAS,CAAC,KAAK,CAAC;QACnC,GAAG,EAAE,mBAAW,CAAC,OAAO,CAAC,KAAK,CAAC;KAC/B,CAAC;CACF,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { NodeId, TraitLabel, UuidString } from './Identifiers';\nimport { assert, assertNotUndefined } from './Common';\nimport { ConstraintEffect, NodeData, Payload, Side, TreeNodeSequence } from './persisted-types';\nimport { TraitLocation } from './TreeView';\nimport { getNodeId } from './NodeIdUtilities';\n\n/**\n * An object which may have traits with children of the given type underneath it\n * @public\n */\nexport interface HasVariadicTraits<TChild> {\n\treadonly traits?: {\n\t\treadonly [key: string]: TChild | TreeNodeSequence<TChild> | undefined;\n\t};\n}\n\n/**\n * The type of a Change\n * @public\n */\nexport enum ChangeType {\n\tInsert,\n\tDetach,\n\tBuild,\n\tSetValue,\n\tConstraint,\n}\n\n/**\n * A change that composes an Edit.\n *\n * `Change` objects can be conveniently constructed with the helper methods exported on a constant of the same name.\n * @example\n * Change.insert(sourceId, destination)\n * @public\n */\nexport type Change = Insert | Detach | Build | SetValue | Constraint;\n\n/**\n * Node or a detached sequence of nodes (referred to by a detached sequence ID) for use in a Build change.\n * See `BuildTreeNode` for more.\n * @public\n */\nexport type BuildNode = BuildTreeNode | number;\n\n/**\n * Node for use in a Build change, which is composed of a definition describing what this nodes type, an identifier identifying this node\n * within the tree, and a payload containing an opaque serializable piece of data.\n * An identifier can be provided explicitly if the node must be referred to before the results of the `Change` containing this\n * BuildTreeNode can be observed. If `identifier` is not supplied, one will be generated for it in an especially efficient manner\n * that allows for compact storage and transmission and thus this property should be omitted if convenient.\n * See the SharedTree readme for more on the tree format.\n */\nexport interface BuildTreeNode extends HasVariadicTraits<BuildNode> {\n\tdefinition: string;\n\tidentifier?: NodeId;\n\tpayload?: Payload;\n}\n\n/**\n * Constructs a sequence of nodes, associates it with the supplied ID, and stores it for use in later changes.\n * Does not modify the document.\n *\n * Valid if (transitively) all DetachedSequenceId are used according to their rules (use here counts as a destination),\n * and all Nodes' identifiers are previously unused.\n *\n * @public\n */\nexport interface Build {\n\treadonly destination: number;\n\treadonly source: BuildNode | TreeNodeSequence<BuildNode>;\n\treadonly type: typeof ChangeType.Build;\n}\n\n/**\n * Inserts a sequence of nodes at the specified destination.\n * The source can be constructed either by a Build (used to insert new nodes) or a Detach (amounts to a \"move\" operation).\n * @public\n */\nexport interface Insert {\n\treadonly destination: StablePlace;\n\treadonly source: number;\n\treadonly type: typeof ChangeType.Insert;\n}\n\n/**\n * Removes a sequence of nodes from the tree.\n * If a destination is specified, the detached sequence is associated with that ID and held for possible reuse\n * by later changes in this same Edit (such as by an Insert).\n * A Detach without a destination is a deletion of the specified sequence, as is a Detach with a destination that is not used later.\n * @public\n */\nexport interface Detach {\n\treadonly destination?: number;\n\treadonly source: StableRange;\n\treadonly type: typeof ChangeType.Detach;\n}\n\n/**\n * Modifies the payload of a node.\n * @public\n */\nexport interface SetValue {\n\treadonly nodeToModify: NodeId;\n\t/**\n\t * Sets or clears the payload.\n\t * To improve ease of forwards compatibility, an explicit `null` value is used to represent the clearing of a payload.\n\t * SetValue may use `undefined` in future API versions to mean \"don't change the payload\" (which is useful if e.g. other\n\t * fields are added to SetValue that can be changed without altering the payload)\n\t */\n\t// eslint-disable-next-line @rushstack/no-new-null\n\treadonly payload: Payload | null;\n\treadonly type: typeof ChangeType.SetValue;\n}\n\n/**\n * A set of constraints on the validity of an Edit.\n * A Constraint is used to detect when an Edit, due to other concurrent edits, may have unintended effects or merge in\n * non-semantic ways. It is processed in order like any other Change in an Edit. It can cause an edit to fail if the\n * various constraints are not met at the time of evaluation (ex: the parentNode has changed due to concurrent editing).\n * Does not modify the document.\n * @public\n */\nexport interface Constraint {\n\t/**\n\t * Selects a sequence of nodes which will be checked against the constraints specified by the optional fields.\n\t * If `toConstrain` is invalid, it will be treated like a constraint being unmet.\n\t * Depending on `effect` this may or may not make the Edit invalid.\n\t *\n\t * When a constraint is not met, the effects is specified by `effect`.\n\t */\n\treadonly toConstrain: StableRange;\n\n\t/**\n\t * Require that the identities of all the nodes in toConstrain hash to this value.\n\t * Hash is order dependent.\n\t * TODO: implement and specify exact hash function.\n\t *\n\t * This is an efficient (O(1) space) way to constrain a sequence of nodes to have specific identities.\n\t */\n\treadonly identityHash?: UuidString;\n\n\t/**\n\t * Require that the number of nodes in toConstrain is this value.\n\t */\n\treadonly length?: number;\n\n\t/**\n\t * Require that the contents of all of the nodes in toConstrain hash to this value.\n\t * Hash is an order dependant deep hash, which includes all subtree content recursively.\n\t * TODO: implement and specify exact hash function.\n\t *\n\t * This is an efficient (O(1) space) way to constrain a sequence of nodes have exact values (transitively).\n\t */\n\treadonly contentHash?: UuidString;\n\n\t/**\n\t * Require that parent under which toConstrain is located has this identifier.\n\t */\n\treadonly parentNode?: NodeId;\n\n\t/**\n\t * Require that the trait under which toConstrain is located has this label.\n\t */\n\treadonly label?: TraitLabel;\n\n\t/**\n\t * What to do if a constraint is not met.\n\t */\n\treadonly effect: ConstraintEffect;\n\n\t/**\n\t * Marker for which kind of Change this is.\n\t */\n\treadonly type: typeof ChangeType.Constraint;\n}\n\n// Note: Documentation of this constant is merged with documentation of the `Change` interface.\n/**\n * @public\n */\nexport const Change = {\n\tbuild: (source: BuildNode | TreeNodeSequence<BuildNode>, destination: number): Build => ({\n\t\tdestination,\n\t\tsource,\n\t\ttype: ChangeType.Build,\n\t}),\n\n\tinsert: (source: number, destination: StablePlace): Insert => ({\n\t\tdestination,\n\t\tsource,\n\t\ttype: ChangeType.Insert,\n\t}),\n\n\tdetach: (source: StableRange, destination?: number): Detach => ({\n\t\tdestination,\n\t\tsource,\n\t\ttype: ChangeType.Detach,\n\t}),\n\n\tsetPayload: (nodeToModify: NodeId, payload: Payload): SetValue => ({\n\t\tnodeToModify,\n\t\tpayload,\n\t\ttype: ChangeType.SetValue,\n\t}),\n\n\tclearPayload: (nodeToModify: NodeId): SetValue => ({\n\t\tnodeToModify,\n\t\t// Rationale: 'undefined' is reserved for future use (see 'SetValue' interface above.)\n\t\tpayload: null,\n\t\ttype: ChangeType.SetValue,\n\t}),\n\n\tconstraint: (\n\t\ttoConstrain: StableRange,\n\t\teffect: ConstraintEffect,\n\t\tidentityHash?: UuidString,\n\t\tlength?: number,\n\t\tcontentHash?: UuidString,\n\t\tparentNode?: NodeId,\n\t\tlabel?: TraitLabel\n\t): Constraint => ({\n\t\ttoConstrain,\n\t\teffect,\n\t\tidentityHash,\n\t\tlength,\n\t\tcontentHash,\n\t\tparentNode,\n\t\tlabel,\n\t\ttype: ChangeType.Constraint,\n\t}),\n\n\t/** Helpers for making high-level composite operations */\n\n\t/**\n\t * @returns a change that deletes the supplied part of the tree.\n\t */\n\tdelete: (stableRange: StableRange): Change => Change.detach(stableRange),\n\n\t/**\n\t * @returns changes that insert 'nodes' into the specified location in the tree.\n\t */\n\tinsertTree: (nodes: BuildNode | TreeNodeSequence<BuildNode>, destination: StablePlace): Change[] => {\n\t\tconst build = Change.build(nodes, 0);\n\t\treturn [build, Change.insert(build.destination, destination)];\n\t},\n\n\t/**\n\t * @returns changes that moves the specified content to a new location in the tree.\n\t */\n\tmove: (source: StableRange, destination: StablePlace): Change[] => {\n\t\tconst detach = Change.detach(source, 0);\n\t\treturn [detach, Change.insert(assertNotUndefined(detach.destination), destination)];\n\t},\n};\n\n/**\n * A location in a trait.\n * This is NOT the location of a node, but a location where a node could be inserted:\n * it is next to a sibling or at one end of the trait.\n *\n * To be well formed, either `sibling` or `trait` must be defined, but not both.\n *\n * Any given insertion location can be described by two `StablePlace` objects, one with `Side.After` and one with `Side.Before`.\n * For example, in a trait containing two strings \"foo\" and \"bar\", there are 6 different `StablePlace`s corresponding to 3 locations in the\n * trait a new node could be inserted: at the start, before \"foo\", after \"foo\", before \"bar\", after \"bar\", and at the end.\n * Neither of the two ways to specify the same location are considered to be after each other.\n *\n * The anchor (`referenceSibling` or `referenceTrait`) used for a particular `StablePlace` can have an impact in collaborative scenarios.\n *\n * `StablePlace` objects can be conveniently constructed with the helper methods exported on a constant of the same name.\n * @example\n * StablePlace.before(node)\n * StablePlace.atStartOf(trait)\n * @public\n */\nexport interface StablePlace {\n\t/**\n\t * Where this StablePlace is relative to the sibling (if specified), or an end of the trait (if no sibling specified).\n\t * If 'After' and there is no sibling, this StablePlace is after the front of the trait.\n\t * If 'Before' and there is no sibling, this StablePlace is before the back of the trait.\n\t */\n\treadonly side: Side;\n\n\t/**\n\t * The sibling to which this 'StablePlace' is anchored (by 'side').\n\t * If specified, referenceTrait must be unspecified.\n\t */\n\treadonly referenceSibling?: NodeId;\n\n\t/**\n\t * The trait to which this 'StablePlace' is anchored (by 'side').\n\t * If specified, referenceSibling must be unspecified.\n\t */\n\treadonly referenceTrait?: TraitLocation;\n}\n\n/**\n * Specifies the range of nodes from `start` to `end` within a trait.\n * Valid iff start and end are valid and are within the same trait and the start does not occur after the end in the trait.\n *\n * See {@link (StablePlace:interface)} for what it means for a place to be \"after\" another place.\n *\n * `StableRange` objects can be conveniently constructed with the helper methods exported on a constant of the same name.\n * @example\n * StableRange.from(StablePlace.before(startNode)).to(StablePlace.after(endNode))\n * @public\n */\nexport interface StableRange {\n\treadonly start: StablePlace;\n\treadonly end: StablePlace;\n}\n\n/**\n * The remainder of this file consists of ergonomic factory methods for persisted types, or common combinations thereof (e.g. \"Move\" as a\n * combination of a \"Detach\" change and an \"Insert\" change).\n *\n * None of these helpers are persisted in documents, and therefore changes to their semantics need only follow standard semantic versioning\n * practices.\n */\n\n// Note: Documentation of this constant is merged with documentation of the `StablePlace` interface.\n/**\n * @public\n */\nexport const StablePlace = {\n\t/**\n\t * @returns The location directly before `node`.\n\t */\n\tbefore: (node: NodeData<NodeId> | NodeId): StablePlace => ({\n\t\tside: Side.Before,\n\t\treferenceSibling: getNodeId(node),\n\t}),\n\t/**\n\t * @returns The location directly after `node`.\n\t */\n\tafter: (node: NodeData<NodeId> | NodeId): StablePlace => ({ side: Side.After, referenceSibling: getNodeId(node) }),\n\t/**\n\t * @returns The location at the start of `trait`.\n\t */\n\tatStartOf: (trait: TraitLocation): StablePlace => ({ side: Side.After, referenceTrait: trait }),\n\t/**\n\t * @returns The location at the end of `trait`.\n\t */\n\tatEndOf: (trait: TraitLocation): StablePlace => ({ side: Side.Before, referenceTrait: trait }),\n};\n\n// Note: Documentation of this constant is merged with documentation of the `StableRange` interface.\n/**\n * @public\n */\nexport const StableRange = {\n\t/**\n\t * Factory for producing a `StableRange` from a start `StablePlace` to an end `StablePlace`.\n\t * @example\n\t * StableRange.from(StablePlace.before(startNode)).to(StablePlace.after(endNode))\n\t */\n\tfrom: (start: StablePlace): { to: (end: StablePlace) => StableRange } => ({\n\t\tto: (end: StablePlace): StableRange => {\n\t\t\tif (start.referenceTrait && end.referenceTrait) {\n\t\t\t\tconst message = 'StableRange must be constructed with endpoints from the same trait';\n\t\t\t\tassert(start.referenceTrait.parent === end.referenceTrait.parent, message);\n\t\t\t\tassert(start.referenceTrait.label === end.referenceTrait.label, message);\n\t\t\t}\n\t\t\treturn { start, end };\n\t\t},\n\t}),\n\t/**\n\t * @returns a `StableRange` which contains only the provided `node`.\n\t * Both the start and end `StablePlace` objects used to anchor this `StableRange` are in terms of the passed in node.\n\t */\n\tonly: (node: NodeData<NodeId> | NodeId): StableRange => ({\n\t\tstart: StablePlace.before(node),\n\t\tend: StablePlace.after(node),\n\t}),\n\t/**\n\t * @returns a `StableRange` which contains everything in the trait.\n\t * This is anchored using the provided `trait`, and is independent of the actual contents of the trait:\n\t * it does not use sibling anchoring.\n\t */\n\tall: (trait: TraitLocation): StableRange => ({\n\t\tstart: StablePlace.atStartOf(trait),\n\t\tend: StablePlace.atEndOf(trait),\n\t}),\n};\n"]}

package/dist/Checkout.d.ts

@@ -5,8 +5,12 @@
 import { EventEmitterWithErrorHandling } from '@fluidframework/telemetry-utils';
 import { IDisposable, IErrorEvent } from '@fluidframework/common-definitions';
 import { EditId } from './Identifiers';
-import { Snapshot } from './Snapshot';
-import { ValidEditingResult, Edit, EditStatus, EditCommittedHandler, GenericSharedTree } from './generic';
+import { TreeView } from './TreeView';
+import { RevisionView } from './RevisionView';
+import { EditCommittedHandler, SharedTree } from './SharedTree';
+import { ValidEditingResult } from './TransactionInternal';
+import { ChangeInternal, Edit, EditStatus } from './persisted-types';
+import { Change } from './ChangeTypes';
 /**
  * An event emitted by a `Checkout` to indicate a state change. See {@link ICheckoutEvents} for event argument information.
  * @public
@@ -14,7 +18,7 @@ import { ValidEditingResult, Edit, EditStatus, EditCommittedHandler, GenericShar
 export declare enum CheckoutEvent {
     /**
      * `currentView` has changed.
-     * Passed a before and after Snapshot.
+     * Passed a before and after TreeView.
      */
     ViewChange = "viewChange"
 }
@@ -22,7 +26,7 @@ export declare enum CheckoutEvent {
  * Events which may be emitted by `Checkout`. See {@link CheckoutEvent} for documentation of event semantics.
  */
 export interface ICheckoutEvents extends IErrorEvent {
-    (event: 'viewChange', listener: (before: Snapshot, after: Snapshot) => void): any;
+    (event: 'viewChange', listener: (before: TreeView, after: TreeView) => void): any;
 }
 /**
  * The result of validation of an Edit.
@@ -48,7 +52,7 @@ export declare enum EditValidationResult {
 }
 /**
  * A mutable Checkout of a SharedTree, allowing viewing and interactive transactional editing.
- * Provides (snapshot-isolation)[https://en.wikipedia.org/wiki/Snapshot_isolation] while editing.
+ * Provides {@link https://en.wikipedia.org/wiki/Snapshot_isolation | snapshot-isolation} while editing.
  *
  * A Checkout always shows a consistent sequence of versions of the SharedTree, but it may skip intermediate versions, and may fall behind.
  * In this case consistent means the sequence of versions could occur with fully synchronous shared tree access,
@@ -61,14 +65,14 @@ export declare enum EditValidationResult {
  * `SharedTree` used at construction time.
  * @public
  */
-export declare abstract class Checkout<TChange> extends EventEmitterWithErrorHandling<ICheckoutEvents> implements IDisposable {
+export declare abstract class Checkout extends EventEmitterWithErrorHandling<ICheckoutEvents> implements IDisposable {
     /**
      * The view of the latest committed revision.
      * Does not include changes from any open edits.
      *
      * When this changes, emitChange must be called.
      */
-    protected abstract get latestCommittedView(): Snapshot;
+    protected abstract get latestCommittedView(): RevisionView;
     /**
      * The last view for which invalidation was sent.
      * Updated by emitChange.
@@ -81,7 +85,7 @@ export declare abstract class Checkout<TChange> extends EventEmitterWithErrorHan
     /**
      * The shared tree this checkout views/edits.
      */
-    readonly tree: GenericSharedTree<TChange>;
+    readonly tree: SharedTree;
     /**
      * `tree`'s log viewer as a CachingLogViewer if it is one, otherwise undefined.
      * Used for optimizations if provided.
@@ -96,12 +100,12 @@ export declare abstract class Checkout<TChange> extends EventEmitterWithErrorHan
      */
     private currentEdit?;
     disposed: boolean;
-    protected constructor(tree: GenericSharedTree<TChange>, currentView: Snapshot, onEditCommitted: EditCommittedHandler<GenericSharedTree<TChange>>);
+    protected constructor(tree: SharedTree, currentView: RevisionView, onEditCommitted: EditCommittedHandler);
     /**
      * @returns the current view of the tree, including the result of changes applied so far during an edit.
      * Note that any external edits (from other clients) will not added to view while there is a `currentEdit`.
      */
-    get currentView(): Snapshot;
+    get currentView(): TreeView;
     /**
      * @returns true iff there is an open edit.
      * @internal
@@ -122,28 +126,40 @@ export declare abstract class Checkout<TChange> extends EventEmitterWithErrorHan
      */
     closeEdit(): EditId;
     /**
-     * Inform the Checkout that a particular edit is know to have a specific result when applied to a particular Snapshot.
+     * Inform the Checkout that a particular edit is know to have a specific result when applied to a particular TreeView.
      * This may be used as a caching hint to avoid recomputation.
      */
-    protected hintKnownEditingResult(edit: Edit<TChange>, result: ValidEditingResult<TChange>): void;
+    protected hintKnownEditingResult(edit: Edit<ChangeInternal>, result: ValidEditingResult): void;
     /**
      * Take any needed action between when an edit is completed.
      * Usually this will include submitting it to a SharedTree.
      *
      * Override this to customize.
      */
-    protected handleNewEdit(id: EditId, result: ValidEditingResult<TChange>): void;
+    protected handleNewEdit(id: EditId, result: ValidEditingResult): void;
     /**
      * Applies the supplied changes to the tree and emits a change event.
      * Must be called during an ongoing edit (see `openEdit()`/`closeEdit()`).
      * `changes` must be well-formed and valid: it is an error if they do not apply cleanly.
      */
-    applyChanges(...changes: TChange[]): void;
+    applyChanges(...changes: Change[]): void;
+    /**
+     * Applies the supplied changes to the tree and emits a change event.
+     * Must be called during an ongoing edit (see `openEdit()`/`closeEdit()`).
+     * `changes` must be well-formed and valid: it is an error if they do not apply cleanly.
+     */
+    protected tryApplyChangesInternal(...changes: ChangeInternal[]): EditStatus;
     /**
      * Convenience helper for applying an edit containing the given changes.
      * Opens an edit, applies the given changes, and closes the edit. See (`openEdit()`/`applyChanges()`/`closeEdit()`).
      */
-    applyEdit(...changes: TChange[]): EditId;
+    applyEdit(...changes: Change[]): EditId;
+    /**
+     * Apply an edit, if valid, otherwise does nothing (the edit is not added to the history).
+     * If the edit applied, its changes will be immediately visible on this checkout, though it still may end up invalid once sequenced due to concurrent edits.
+     * @returns The EditId if the edit was valid and thus applied, and undefined if it was invalid and thus not applied.
+     */
+    tryApplyEdit(...changes: Change[]): EditId | undefined;
     /**
      * Rebases the ongoing edit to the latest revision loaded by this 'Checkout'.
      * If the rebase succeeds (none of the changes in the ongoing edit became invalid), the ongoing edit will remain open and the current
@@ -168,19 +184,10 @@ export declare abstract class Checkout<TChange> extends EventEmitterWithErrorHan
      */
     getEditStatus(): EditStatus;
     /**
-     * @param id - an edit added during the current session.
-     *
-     * @returns the edit with the specified `id`, and a snapshot just before applying the edit.
-     * The returned snapshot may be the exact version that the exit was made against, or it may have additional remote edits included.
-     *
-     * This requires that the edit was added during the current session as this guarantees its available synchronously.
-     *
-     * Override this in Checkouts that may have edits which are not included in tree.edits.
+     * Reverts a collection of edits.
+     * @param editIds - the edits to revert
      */
-    getChangesAndSnapshotBeforeInSession(id: EditId): {
-        changes: readonly TChange[];
-        before: Snapshot;
-    };
+    revert(editId: EditId): void;
     /**
      * Send invalidation message for all changes since last call to emitChange.
      * This must be called every time `currentView` could have changed.
@@ -191,6 +198,11 @@ export declare abstract class Checkout<TChange> extends EventEmitterWithErrorHan
      * @returns a Promise which completes after all currently known edits are available in this checkout.
      */
     abstract waitForPendingUpdates(): Promise<void>;
+    /**
+     * @returns a Promise which completes after edits that were closed on this checkout (before calling this) have been
+     * submitted to Fluid. This does NOT wait for the Fluid service to ack them
+     */
+    abstract waitForEditsToSubmit(): Promise<void>;
     /**
      * release all unmanaged resources
      * e.g. unregister event listeners

package/dist/Checkout.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Checkout.d.ts","sourceRoot":"","sources":["../src/Checkout.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAChF,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AAE9E,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAEN,kBAAkB,EAElB,IAAI,EACJ,UAAU,EACV,oBAAoB,EACpB,iBAAiB,EAEjB,MAAM,WAAW,CAAC;AAGnB;;;GAGG;AACH,oBAAY,aAAa;IACxB;;;OAGG;IACH,UAAU,eAAe;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,WAAW;IACnD,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,KAAK,IAAI,OAAE;CAC7E;AAED;;;GAGG;AACH,oBAAY,oBAAoB;IAC/B;;;;OAIG;IACH,SAAS,IAAA;IACT;;;;OAIG;IACH,OAAO,IAAA;IACP;;OAEG;IACH,KAAK,IAAA;CACL;AAED;;;;;;;;;;;;;;GAcG;AACH,8BAAsB,QAAQ,CAAC,OAAO,CAAE,SAAQ,6BAA6B,CAAC,eAAe,CAAE,YAAW,WAAW;IACpH;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,KAAK,mBAAmB,IAAI,QAAQ,CAAC;IAEvD;;;OAGG;IACH,OAAO,CAAC,YAAY,CAAW;IAE/B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAmD;IAExF;;OAEG;IACH,SAAgB,IAAI,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAEjD;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAA4B;IAE9D;;;;;;OAMG;IACH,OAAO,CAAC,WAAW,CAAC,CAA8B;IAE3C,QAAQ,EAAE,OAAO,CAAS;IAEjC,SAAS,aACR,IAAI,EAAE,iBAAiB,CAAC,OAAO,CAAC,EAChC,WAAW,EAAE,QAAQ,EACrB,eAAe,EAAE,oBAAoB,CAAC,iBAAiB,CAAC,OAAO,CAAC,CAAC;IAgBlE;;;OAGG;IACH,IAAW,WAAW,IAAI,QAAQ,CAEjC;IAED;;;OAGG;IACI,WAAW,IAAI,OAAO;IAI7B;;;OAGG;IACI,QAAQ,IAAI,IAAI;IAKvB;;;;;;;OAOG;IACI,SAAS,IAAI,MAAM;IAa1B;;;OAGG;IACH,SAAS,CAAC,sBAAsB,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,kBAAkB,CAAC,OAAO,CAAC,GAAG,IAAI;IAKhG;;;;;OAKG;IACH,SAAS,CAAC,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,CAAC,OAAO,CAAC,GAAG,IAAI;IAW9E;;;;OAIG;IACI,YAAY,CAAC,GAAG,OAAO,EAAE,OAAO,EAAE,GAAG,IAAI;IAOhD;;;OAGG;IACI,SAAS,CAAC,GAAG,OAAO,EAAE,OAAO,EAAE,GAAG,MAAM;IAM/C;;;;;;;;;;OAUG;IACI,iBAAiB,IAAI,oBAAoB,CAAC,KAAK,GAAG,oBAAoB,CAAC,OAAO;IAuBrF;;;OAGG;IACI,SAAS,IAAI,IAAI;IAOxB;;;;OAIG;IACI,aAAa,IAAI,UAAU;IAQlC;;;;;;;;;OASG;IACI,oCAAoC,CAAC,EAAE,EAAE,MAAM,GAAG;QAAE,OAAO,EAAE,SAAS,OAAO,EAAE,CAAC;QAAC,MAAM,EAAE,QAAQ,CAAA;KAAE;IAQ1G;;;;OAIG;IACH,SAAS,CAAC,UAAU,IAAI,IAAI;IAU5B;;OAEG;aACa,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC;IAEtD;;;OAGG;IACI,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,IAAI;CAUnC"}
+{"version":3,"file":"Checkout.d.ts","sourceRoot":"","sources":["../src/Checkout.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,6BAA6B,EAAE,MAAM,iCAAiC,CAAC;AAChF,OAAO,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,oCAAoC,CAAC;AAE9E,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAEvC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,oBAAoB,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAChE,OAAO,EAA2C,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AACpG,OAAO,EAAE,cAAc,EAAE,IAAI,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAGrE,OAAO,EAAE,MAAM,EAAE,MAAM,eAAe,CAAC;AAEvC;;;GAGG;AACH,oBAAY,aAAa;IACxB;;;OAGG;IACH,UAAU,eAAe;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,WAAW;IACnD,CAAC,KAAK,EAAE,YAAY,EAAE,QAAQ,EAAE,CAAC,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,QAAQ,KAAK,IAAI,OAAE;CAC7E;AAED;;;GAGG;AACH,oBAAY,oBAAoB;IAC/B;;;;OAIG;IACH,SAAS,IAAA;IACT;;;;OAIG;IACH,OAAO,IAAA;IACP;;OAEG;IACH,KAAK,IAAA;CACL;AAED;;;;;;;;;;;;;;GAcG;AACH,8BAAsB,QAAS,SAAQ,6BAA6B,CAAC,eAAe,CAAE,YAAW,WAAW;IAC3G;;;;;OAKG;IACH,SAAS,CAAC,QAAQ,KAAK,mBAAmB,IAAI,YAAY,CAAC;IAE3D;;;OAGG;IACH,OAAO,CAAC,YAAY,CAAW;IAE/B;;OAEG;IACH,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAuB;IAE5D;;OAEG;IACH,SAAgB,IAAI,EAAE,UAAU,CAAC;IAEjC;;;OAGG;IACH,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAmB;IAErD;;;;;;OAMG;IACH,OAAO,CAAC,WAAW,CAAC,CAAqB;IAElC,QAAQ,EAAE,OAAO,CAAS;IAEjC,SAAS,aAAa,IAAI,EAAE,UAAU,EAAE,WAAW,EAAE,YAAY,EAAE,eAAe,EAAE,oBAAoB;IAexG;;;OAGG;IACH,IAAW,WAAW,IAAI,QAAQ,CAEjC;IAED;;;OAGG;IACI,WAAW,IAAI,OAAO;IAI7B;;;OAGG;IACI,QAAQ,IAAI,IAAI;IAKvB;;;;;;;OAOG;IACI,SAAS,IAAI,MAAM;IAa1B;;;OAGG;IACH,SAAS,CAAC,sBAAsB,CAAC,IAAI,EAAE,IAAI,CAAC,cAAc,CAAC,EAAE,MAAM,EAAE,kBAAkB,GAAG,IAAI;IAK9F;;;;;OAKG;IACH,SAAS,CAAC,aAAa,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,kBAAkB,GAAG,IAAI;IAWrE;;;;OAIG;IACI,YAAY,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,IAAI;IAO/C;;;;OAIG;IACH,SAAS,CAAC,uBAAuB,CAAC,GAAG,OAAO,EAAE,cAAc,EAAE,GAAG,UAAU;IAS3E;;;OAGG;IACI,SAAS,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM;IAM9C;;;;OAIG;IACI,YAAY,CAAC,GAAG,OAAO,EAAE,MAAM,EAAE,GAAG,MAAM,GAAG,SAAS;IAc7D;;;;;;;;;;OAUG;IACI,iBAAiB,IAAI,oBAAoB,CAAC,KAAK,GAAG,oBAAoB,CAAC,OAAO;IAuBrF;;;OAGG;IACI,SAAS,IAAI,IAAI;IAOxB;;;;OAIG;IACI,aAAa,IAAI,UAAU;IAQlC;;;OAGG;IACI,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,IAAI;IAWnC;;;;OAIG;IACH,SAAS,CAAC,UAAU,IAAI,IAAI;IAU5B;;OAEG;aACa,qBAAqB,IAAI,OAAO,CAAC,IAAI,CAAC;IAEtD;;;OAGG;aACa,oBAAoB,IAAI,OAAO,CAAC,IAAI,CAAC;IAErD;;;OAGG;IACI,OAAO,CAAC,KAAK,CAAC,EAAE,KAAK,GAAG,IAAI;CAUnC"}