@fluid-experimental/tree 0.58.2002 → 0.59.1000

package/dist/persisted-types/0.0.2.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"0.0.2.d.ts","sourceRoot":"","sources":["../../src/persisted-types/0.0.2.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uCAAuC,CAAC;AAC1E,OAAO,KAAK,EACX,MAAM,EACN,UAAU,EACV,MAAM,EACN,YAAY,EACZ,UAAU,EACV,kBAAkB,EAClB,UAAU,EACV,MAAM,gBAAgB,CAAC;AAExB;;;;;;;;;;;;;;;;;;GAkBG;AACH,oBAAY,IAAI;IACf,MAAM,IAAI;IACV,KAAK,IAAI;CACT;AAED;;;;GAIG;AACH,MAAM,WAAW,IAAI,CAAC,OAAO,CAAE,SAAQ,QAAQ,CAAC,OAAO,CAAC;IACvD;;;OAGG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,aAAa,CAAC,OAAO,CAAE,SAAQ,QAAQ,CAAC,OAAO,CAAC;IAChE;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,EAAE,KAAK,CAAC;CACpB;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ,CAAC,OAAO;IAChC;;;OAGG;IACH,QAAQ,CAAC,OAAO,EAAE,SAAS,OAAO,EAAE,CAAC;IAErC;;;OAGG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAInC;AAED;;;;;;;;;;GAUG;AACH,oBAAY,OAAO,GAAG,YAAY,CAAC;AAEnC;;;;;GAKG;AACH,MAAM,WAAW,QAAQ,CAAC,MAAM;IAC/B,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAC;CACjD;AAED;;;GAGG;AACH,oBAAY,gBAAgB,CAAC,MAAM,IAAI,SAAS,MAAM,EAAE,CAAC;AAEzD;;;GAGG;AACH,MAAM,WAAW,SAAS,CAAC,MAAM;IAChC,QAAQ,CAAC,MAAM,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ,CAAC,GAAG;IAC5B;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;IAE3B;;;;OAIG;IACH,QAAQ,CAAC,UAAU,EAAE,UAAU,CAAC;IAChC;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,GAAG,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,QAAQ,CAAC,MAAM,EAAE,GAAG,CAAE,SAAQ,QAAQ,CAAC,GAAG,CAAC,EAAE,SAAS,CAAC,MAAM,CAAC;CAAG;AAElF;;GAEG;AACH,oBAAY,eAAe,CAAC,YAAY,GAAG,KAAK,IAAI,QAAQ,CAAC,eAAe,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,GAAG,YAAY,CAAC;AAEnH;;;GAGG;AACH,MAAM,WAAW,2BAA2B;IAC3C,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,KAAK,EAAE,UAAU,CAAC;CAC3B;AAED;;;GAGG;AACH,oBAAY,gBAAgB,GAAG,QAAQ,CAAC,gBAAgB,EAAE,YAAY,CAAC,CAAC;AAExE;;;GAGG;AACH,oBAAY,UAAU;IACrB;;;;OAIG;IACH,SAAS,IAAA;IACT;;;OAGG;IACH,OAAO,IAAA;IACP;;OAEG;IACH,OAAO,IAAA;CACP;AAED;;GAEG;AACH,oBAAY,gBAAgB;IAC3B,4CAA4C;IAC5C,IAAI,IAAA;IACJ,iEAAiE;IACjE,MAAM,IAAA;IACN,mDAAmD;IACnD,IAAI,IAAA;IACJ,sFAAsF;IACtF,MAAM,IAAA;CACN;AAED;;GAEG;AACH,MAAM,WAAW,WAAW,CAAC,OAAO,SAAS,WAAW,GAAG,WAAW;IACrE,uEAAuE;IACvE,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,oBAAY,kBAAkB,GAAG,sBAAsB,GAAG,cAAc,GAAG,kBAAkB,CAAC;AAE9F;;GAEG;AACH,MAAM,WAAW,cAAe,SAAQ,WAAW;IAClD,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC;CACrC;AAED;;;;;GAKG;AACH,MAAM,WAAW,kBAAmB,SAAQ,WAAW;IACtD,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC,MAAM,CAAC;CACvC;AAED;;GAEG;AACH,MAAM,WAAW,sBAAuB,SAAQ,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC;IAC9E,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC;IACrC,0CAA0C;IAC1C,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,oBAAoB,CAAC,CAAC;CAC1C;AAED;;;GAGG;AACH,oBAAY,WAAW;IACtB,4CAA4C;IAC5C,MAAM,UAAU;IAChB,2GAA2G;IAC3G,MAAM,UAAU;CAChB;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACrC;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC;CAC9B;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAwB,SAAQ,qBAAqB;IACrE,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC;IAErC,QAAQ,CAAC,WAAW,EAAE,gBAAgB,CAAC;IACvC;;OAEG;IACH,QAAQ,CAAC,cAAc,EAAE,SAAS,IAAI,CAAC,oBAAoB,CAAC,EAAE,CAAC;CAC/D;AAED;;;GAGG;AACH,oBAAY,kBAAkB;IAC7B,MAAM,IAAA;IACN,MAAM,IAAA;IACN,KAAK,IAAA;IACL,QAAQ,IAAA;IACR,UAAU,IAAA;IACV,eAAe,IAAA;CACf;AAED;;;GAGG;AACH,oBAAY,oBAAoB,GAC7B,oBAAoB,GACpB,oBAAoB,GACpB,mBAAmB,GACnB,sBAAsB,GACtB,wBAAwB,CAAC;AAE5B;;;GAGG;AACH,oBAAY,uBAAuB,GAAG,QAAQ,CAAC,uBAAuB,EAAE,YAAY,CAAC,GAAG,kBAAkB,CAAC;AAE3G;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC,uCAAuC;IACvC,QAAQ,CAAC,WAAW,EAAE,kBAAkB,CAAC;IACzC,kCAAkC;IAClC,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC,uBAAuB,CAAC,CAAC;IAC3D,kCAAkC;IAClC,QAAQ,CAAC,IAAI,EAAE,OAAO,kBAAkB,CAAC,KAAK,CAAC;CAC/C;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACpC,oDAAoD;IACpD,QAAQ,CAAC,WAAW,EAAE,yBAAyB,CAAC;IAChD,+CAA+C;IAC/C,QAAQ,CAAC,MAAM,EAAE,kBAAkB,CAAC;IACpC,+CAA+C;IAC/C,QAAQ,CAAC,IAAI,EAAE,OAAO,kBAAkB,CAAC,MAAM,CAAC;CAChD;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB;IACpC,wCAAwC;IACxC,QAAQ,CAAC,WAAW,CAAC,EAAE,kBAAkB,CAAC;IAC1C,mCAAmC;IACnC,QAAQ,CAAC,MAAM,EAAE,yBAAyB,CAAC;IAC3C,mCAAmC;IACnC,QAAQ,CAAC,IAAI,EAAE,OAAO,kBAAkB,CAAC,MAAM,CAAC;CAChD;AAED;;;GAGG;AACH,MAAM,WAAW,sBAAsB;IACtC,2CAA2C;IAC3C,QAAQ,CAAC,YAAY,EAAE,YAAY,CAAC;IACpC,sCAAsC;IAEtC,QAAQ,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI,CAAC;IACjC,qCAAqC;IACrC,QAAQ,CAAC,IAAI,EAAE,OAAO,kBAAkB,CAAC,QAAQ,CAAC;CAClD;AAED;;;GAGG;AACH,oBAAY,gBAAgB;IAC3B;;OAEG;IACH,iBAAiB,IAAA;IAEjB;;;OAGG;IACH,YAAY,IAAA;IAEZ;;;OAGG;IACH,UAAU,IAAA;CACV;AAED;;;GAGG;AACH,MAAM,WAAW,wBAAwB;IACxC,4CAA4C;IAC5C,QAAQ,CAAC,WAAW,EAAE,yBAAyB,CAAC;IAChD,6CAA6C;IAC7C,QAAQ,CAAC,YAAY,CAAC,EAAE,UAAU,CAAC;IACnC,uCAAuC;IACvC,QAAQ,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC;IACzB,4CAA4C;IAC5C,QAAQ,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC;IAClC,2CAA2C;IAC3C,QAAQ,CAAC,UAAU,CAAC,EAAE,YAAY,CAAC;IACnC,sCAAsC;IACtC,QAAQ,CAAC,KAAK,CAAC,EAAE,UAAU,CAAC;IAC5B,uCAAuC;IACvC,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAClC,uCAAuC;IACvC,QAAQ,CAAC,IAAI,EAAE,OAAO,kBAAkB,CAAC,UAAU,CAAC;CACpD;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACzC;;OAEG;IACH,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;IAEpB;;OAEG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,YAAY,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,2BAA2B,CAAC;CACtD;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACzC,mDAAmD;IACnD,QAAQ,CAAC,KAAK,EAAE,yBAAyB,CAAC;IAC1C,iDAAiD;IACjD,QAAQ,CAAC,GAAG,EAAE,yBAAyB,CAAC;CACxC"}

package/dist/persisted-types/0.0.2.js

@@ -0,0 +1,113 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConstraintEffect = exports.ChangeTypeInternal = exports.WriteFormat = exports.SharedTreeOpType = exports.EditStatus = exports.Side = void 0;
+/**
+ * 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
+ */
+var Side;
+(function (Side) {
+    Side[Side["Before"] = 0] = "Before";
+    Side[Side["After"] = 1] = "After";
+})(Side = exports.Side || (exports.Side = {}));
+/**
+ * The status code of an attempt to apply the changes in an Edit.
+ * @public
+ */
+var EditStatus;
+(function (EditStatus) {
+    /**
+     * The edit contained one or more malformed changes (e.g. was missing required fields such as `id`),
+     * or contained a sequence of changes that could not possibly be applied sequentially without error
+     * (e.g. an edit which tries to insert the same detached node twice).
+     */
+    EditStatus[EditStatus["Malformed"] = 0] = "Malformed";
+    /**
+     * The edit contained a well-formed sequence of changes that couldn't be applied to the current view,
+     * generally because concurrent changes caused one or more merge conflicts.
+     */
+    EditStatus[EditStatus["Invalid"] = 1] = "Invalid";
+    /**
+     * The edit was applied to the current view successfully.
+     */
+    EditStatus[EditStatus["Applied"] = 2] = "Applied";
+})(EditStatus = exports.EditStatus || (exports.EditStatus = {}));
+/**
+ * Types of ops handled by SharedTree.
+ */
+var SharedTreeOpType;
+(function (SharedTreeOpType) {
+    /** An op that includes edit information. */
+    SharedTreeOpType[SharedTreeOpType["Edit"] = 0] = "Edit";
+    /** Includes a Fluid handle that corresponds to an edit chunk. */
+    SharedTreeOpType[SharedTreeOpType["Handle"] = 1] = "Handle";
+    /** An op that does not affect the tree's state. */
+    SharedTreeOpType[SharedTreeOpType["NoOp"] = 2] = "NoOp";
+    /** Signals that SharedTree contents should be updated to match a new write format. */
+    SharedTreeOpType[SharedTreeOpType["Update"] = 3] = "Update";
+})(SharedTreeOpType = exports.SharedTreeOpType || (exports.SharedTreeOpType = {}));
+/**
+ * Format versions that SharedTree supports writing. Changes to op or summary formats necessitate updates.
+ * @public
+ */
+var WriteFormat;
+(function (WriteFormat) {
+    /** Stores all edits in their raw format. */
+    WriteFormat["v0_0_2"] = "0.0.2";
+    /** Supports history virtualization, tree compression, string interning, and makes currentView optional. */
+    WriteFormat["v0_1_1"] = "0.1.1";
+})(WriteFormat = exports.WriteFormat || (exports.WriteFormat = {}));
+/**
+ * {@inheritdoc ChangeType}
+ * @public
+ */
+var ChangeTypeInternal;
+(function (ChangeTypeInternal) {
+    ChangeTypeInternal[ChangeTypeInternal["Insert"] = 0] = "Insert";
+    ChangeTypeInternal[ChangeTypeInternal["Detach"] = 1] = "Detach";
+    ChangeTypeInternal[ChangeTypeInternal["Build"] = 2] = "Build";
+    ChangeTypeInternal[ChangeTypeInternal["SetValue"] = 3] = "SetValue";
+    ChangeTypeInternal[ChangeTypeInternal["Constraint"] = 4] = "Constraint";
+    ChangeTypeInternal[ChangeTypeInternal["CompressedBuild"] = 5] = "CompressedBuild";
+})(ChangeTypeInternal = exports.ChangeTypeInternal || (exports.ChangeTypeInternal = {}));
+/**
+ * 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 = {}));
+//# sourceMappingURL=0.0.2.js.map

package/dist/persisted-types/0.0.2.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"0.0.2.js","sourceRoot":"","sources":["../../src/persisted-types/0.0.2.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAaH;;;;;;;;;;;;;;;;;;GAkBG;AACH,IAAY,IAGX;AAHD,WAAY,IAAI;IACf,mCAAU,CAAA;IACV,iCAAS,CAAA;AACV,CAAC,EAHW,IAAI,GAAJ,YAAI,KAAJ,YAAI,QAGf;AAqID;;;GAGG;AACH,IAAY,UAgBX;AAhBD,WAAY,UAAU;IACrB;;;;OAIG;IACH,qDAAS,CAAA;IACT;;;OAGG;IACH,iDAAO,CAAA;IACP;;OAEG;IACH,iDAAO,CAAA;AACR,CAAC,EAhBW,UAAU,GAAV,kBAAU,KAAV,kBAAU,QAgBrB;AAED;;GAEG;AACH,IAAY,gBASX;AATD,WAAY,gBAAgB;IAC3B,4CAA4C;IAC5C,uDAAI,CAAA;IACJ,iEAAiE;IACjE,2DAAM,CAAA;IACN,mDAAmD;IACnD,uDAAI,CAAA;IACJ,sFAAsF;IACtF,2DAAM,CAAA;AACP,CAAC,EATW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAS3B;AAyCD;;;GAGG;AACH,IAAY,WAKX;AALD,WAAY,WAAW;IACtB,4CAA4C;IAC5C,+BAAgB,CAAA;IAChB,2GAA2G;IAC3G,+BAAgB,CAAA;AACjB,CAAC,EALW,WAAW,GAAX,mBAAW,KAAX,mBAAW,QAKtB;AA2BD;;;GAGG;AACH,IAAY,kBAOX;AAPD,WAAY,kBAAkB;IAC7B,+DAAM,CAAA;IACN,+DAAM,CAAA;IACN,6DAAK,CAAA;IACL,mEAAQ,CAAA;IACR,uEAAU,CAAA;IACV,iFAAe,CAAA;AAChB,CAAC,EAPW,kBAAkB,GAAlB,0BAAkB,KAAlB,0BAAkB,QAO7B;AAwED;;;GAGG;AACH,IAAY,gBAiBX;AAjBD,WAAY,gBAAgB;IAC3B;;OAEG;IACH,iFAAiB,CAAA;IAEjB;;;OAGG;IACH,uEAAY,CAAA;IAEZ;;;OAGG;IACH,mEAAU,CAAA;AACX,CAAC,EAjBW,gBAAgB,GAAhB,wBAAgB,KAAhB,wBAAgB,QAiB3B","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { Serializable } from '@fluidframework/datastore-definitions';\nimport type {\n\tEditId,\n\tDefinition,\n\tNodeId,\n\tStableNodeId,\n\tTraitLabel,\n\tDetachedSequenceId,\n\tUuidString,\n} from '../Identifiers';\n\n/**\n * Defines a place relative to sibling.\n * The \"outside\" of a trait is the `undefined` sibling,\n * so After `undefined` is the beginning of the trait, and before `undefined` is the end.\n *\n * For this purpose, traits look like:\n *\n * `{undefined} - {Node 0} - {Node 1} - ... - {Node N} - {undefined}`\n *\n * Each `{value}` in the diagram is a possible sibling, which is either a Node or undefined.\n * Each `-` in the above diagram is a `Place`, and can be describe as being `After` a particular `{sibling}` or `Before` it.\n * This means that `After` `{undefined}` means the same `Place` as before the first node\n * and `Before` `{undefined}` means the `Place` after the last Node.\n *\n * Each place can be specified, (aka 'anchored') in two ways (relative to the sibling before or after):\n * 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\n * two place description may no longer evaluate to the same place.\n * @public\n */\nexport enum Side {\n\tBefore = 0,\n\tAfter = 1,\n}\n\n/**\n * A collection of changes to the tree that are applied atomically along with a unique identifier for the edit.\n * If any individual change fails to apply, the entire Edit will fail to apply.\n * @public\n */\nexport interface Edit<TChange> extends EditBase<TChange> {\n\t/**\n\t * Unique identifier for this edit. Must never be reused.\n\t * Used for referencing and de-duplicating edits.\n\t */\n\treadonly id: EditId;\n}\n\n/**\n * A collection of changes to the tree that are applied atomically. If any individual change fails to apply,\n * the entire Edit will fail to apply.\n * @public\n */\nexport interface EditWithoutId<TChange> extends EditBase<TChange> {\n\t/**\n\t * Used to explicitly state that EditWithoutId cannot contain an id and prevents type Edit from being assigned to type EditWithoutId.\n\t */\n\treadonly id?: never;\n}\n\n/**\n * The information included in an edit.\n * @public\n */\nexport interface EditBase<TChange> {\n\t/**\n\t * Actual changes to apply.\n\t * Applied in order as part of a single transaction.\n\t */\n\treadonly changes: readonly TChange[];\n\n\t/**\n\t * For edits which are being re-issued due to a conflict, the number of times this edit has already been attempted.\n\t * Undefined means 0.\n\t */\n\treadonly pastAttemptCount?: number;\n\n\t// Add more metadata fields as needed in the future.\n\t// Include \"high level\"/\"Domain Specific\"/\"Hierarchal\" edits for application/domain use in implementing domain aware merge heuristics.\n}\n\n/**\n * Json compatible representation of a payload storing arbitrary Serializable data.\n *\n * Keys starting with \"IFluid\" are reserved for special use such as the JavaScript feature detection pattern and should not be used.\n *\n * See {@link comparePayloads} for equality semantics and related details (like what is allowed to be lost when serializing)\n *\n * TODO:#51984: Allow opting into heuristic blobbing in snapshots with a special IFluid key.\n *\n * @public\n */\nexport type Payload = Serializable;\n\n/**\n * Json compatible map as object.\n * Keys are TraitLabels,\n * Values are the content of the trait specified by the key.\n * @public\n */\nexport interface TraitMap<TChild> {\n\treadonly [key: string]: TreeNodeSequence<TChild>;\n}\n\n/**\n * A sequence of Nodes that make up a trait under a Node\n * @public\n */\nexport type TreeNodeSequence<TChild> = readonly TChild[];\n\n/**\n * An object which may have traits with children of the given type underneath it\n * @public\n */\nexport interface HasTraits<TChild> {\n\treadonly traits: TraitMap<TChild>;\n}\n\n/**\n * The fields required by a node in a tree\n * @public\n */\nexport interface NodeData<TId> {\n\t/**\n\t * A payload of arbitrary serializable data\n\t */\n\treadonly payload?: Payload;\n\n\t/**\n\t * The meaning of this node.\n\t * Provides contexts/semantics for this node and its content.\n\t * Typically use to associate a node with metadata (including a schema) and source code (types, behaviors, etc).\n\t */\n\treadonly definition: Definition;\n\t/**\n\t * Identifier which can be used to refer to this Node.\n\t */\n\treadonly identifier: TId;\n}\n\n/**\n * Satisfies `NodeData` and may contain children under traits (which may or may not be `TreeNodes`)\n * @public\n */\nexport interface TreeNode<TChild, TId> extends NodeData<TId>, HasTraits<TChild> {}\n\n/**\n * A tree whose nodes are either TreeNodes or a placeholder\n */\nexport type PlaceholderTree<TPlaceholder = never> = TreeNode<PlaceholderTree<TPlaceholder>, NodeId> | TPlaceholder;\n\n/**\n * Specifies the location of a trait (a labeled sequence of nodes) within the tree.\n * @public\n */\nexport interface TraitLocationInternal_0_0_2 {\n\treadonly parent: StableNodeId;\n\treadonly label: TraitLabel;\n}\n\n/**\n * JSON-compatible Node type. Objects of this type will be persisted in internal change objects (under Edits) in the SharedTree history.\n * @public\n */\nexport type ChangeNode_0_0_2 = TreeNode<ChangeNode_0_0_2, StableNodeId>;\n\n/**\n * The status code of an attempt to apply the changes in an Edit.\n * @public\n */\nexport enum EditStatus {\n\t/**\n\t * The edit contained one or more malformed changes (e.g. was missing required fields such as `id`),\n\t * or contained a sequence of changes that could not possibly be applied sequentially without error\n\t * (e.g. an edit which tries to insert the same detached node twice).\n\t */\n\tMalformed,\n\t/**\n\t * The edit contained a well-formed sequence of changes that couldn't be applied to the current view,\n\t * generally because concurrent changes caused one or more merge conflicts.\n\t */\n\tInvalid,\n\t/**\n\t * The edit was applied to the current view successfully.\n\t */\n\tApplied,\n}\n\n/**\n * Types of ops handled by SharedTree.\n */\nexport enum SharedTreeOpType {\n\t/** An op that includes edit information. */\n\tEdit,\n\t/** Includes a Fluid handle that corresponds to an edit chunk. */\n\tHandle,\n\t/** An op that does not affect the tree's state. */\n\tNoOp,\n\t/** Signals that SharedTree contents should be updated to match a new write format. */\n\tUpdate,\n}\n\n/**\n * SharedTreeOp containing a version stamp marking the write format of the tree which submitted it.\n */\nexport interface VersionedOp<Version extends WriteFormat = WriteFormat> {\n\t/** The supported SharedTree write version, see {@link WriteFormat}. */\n\treadonly version: Version;\n}\n\n/**\n * Requirements for SharedTree ops.\n */\nexport type SharedTreeOp_0_0_2 = SharedTreeEditOp_0_0_2 | SharedTreeNoOp | SharedTreeUpdateOp;\n\n/**\n * Op which has no application semantics. This op can be useful for triggering other\n */\nexport interface SharedTreeNoOp extends VersionedOp {\n\treadonly type: SharedTreeOpType.NoOp;\n}\n\n/**\n * Op indicating this SharedTree should upgrade its write format to the specified version.\n * The `version` field of this op reflects the version which should be upgraded to, not\n * the current version.\n * See docs/Breaking-Change-Migration.md for more details on the semantics of this op.\n */\nexport interface SharedTreeUpdateOp extends VersionedOp {\n\treadonly type: SharedTreeOpType.Update;\n}\n\n/**\n * A SharedTree op that includes edit information, and optionally a list of interned strings.\n */\nexport interface SharedTreeEditOp_0_0_2 extends VersionedOp<WriteFormat.v0_0_2> {\n\treadonly type: SharedTreeOpType.Edit;\n\t/** The collection of changes to apply. */\n\treadonly edit: Edit<ChangeInternal_0_0_2>;\n}\n\n/**\n * Format versions that SharedTree supports writing. Changes to op or summary formats necessitate updates.\n * @public\n */\nexport enum WriteFormat {\n\t/** Stores all edits in their raw format. */\n\tv0_0_2 = '0.0.2',\n\t/** Supports history virtualization, tree compression, string interning, and makes currentView optional. */\n\tv0_1_1 = '0.1.1',\n}\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: WriteFormat;\n}\n\n/**\n * Legacy summary format currently still used for writing.\n * TODO:#49901: Remove export when this format is no longer written.\n * @internal\n */\nexport interface SharedTreeSummary_0_0_2 extends SharedTreeSummaryBase {\n\treadonly version: WriteFormat.v0_0_2;\n\n\treadonly currentTree: ChangeNode_0_0_2;\n\t/**\n\t * A list of edits.\n\t */\n\treadonly sequencedEdits: readonly Edit<ChangeInternal_0_0_2>[];\n}\n\n/**\n * {@inheritdoc ChangeType}\n * @public\n */\nexport enum ChangeTypeInternal {\n\tInsert,\n\tDetach,\n\tBuild,\n\tSetValue,\n\tConstraint,\n\tCompressedBuild,\n}\n\n/**\n * {@inheritdoc (Change:type)}\n * @public\n */\nexport type ChangeInternal_0_0_2 =\n\t| InsertInternal_0_0_2\n\t| DetachInternal_0_0_2\n\t| BuildInternal_0_0_2\n\t| SetValueInternal_0_0_2\n\t| ConstraintInternal_0_0_2;\n\n/**\n * {@inheritdoc BuildNode}\n * @public\n */\nexport type BuildNodeInternal_0_0_2 = TreeNode<BuildNodeInternal_0_0_2, StableNodeId> | DetachedSequenceId;\n\n/**\n * {@inheritdoc Build}\n * @public\n */\nexport interface BuildInternal_0_0_2 {\n\t/** {@inheritdoc Build.destination } */\n\treadonly destination: DetachedSequenceId;\n\t/** {@inheritdoc Build.source } */\n\treadonly source: TreeNodeSequence<BuildNodeInternal_0_0_2>;\n\t/** {@inheritdoc Build.\"type\" } */\n\treadonly type: typeof ChangeTypeInternal.Build;\n}\n\n/**\n * {@inheritdoc (Insert:interface)}\n * @public\n */\nexport interface InsertInternal_0_0_2 {\n\t/** {@inheritdoc (Insert:interface).destination } */\n\treadonly destination: StablePlaceInternal_0_0_2;\n\t/** {@inheritdoc (Insert:interface).source } */\n\treadonly source: DetachedSequenceId;\n\t/** {@inheritdoc (Insert:interface).\"type\" } */\n\treadonly type: typeof ChangeTypeInternal.Insert;\n}\n\n/**\n * {@inheritdoc Detach}\n * @public\n */\nexport interface DetachInternal_0_0_2 {\n\t/** {@inheritdoc Detach.destination } */\n\treadonly destination?: DetachedSequenceId;\n\t/** {@inheritdoc Detach.source } */\n\treadonly source: StableRangeInternal_0_0_2;\n\t/** {@inheritdoc Detach.\"type\" } */\n\treadonly type: typeof ChangeTypeInternal.Detach;\n}\n\n/**\n * {@inheritdoc SetValue}\n * @public\n */\nexport interface SetValueInternal_0_0_2 {\n\t/** {@inheritdoc SetValue.nodeToModify } */\n\treadonly nodeToModify: StableNodeId;\n\t/** {@inheritdoc SetValue.payload } */\n\t// eslint-disable-next-line @rushstack/no-new-null\n\treadonly payload: Payload | null;\n\t/** {@inheritdoc SetValue.\"type\" } */\n\treadonly type: typeof ChangeTypeInternal.SetValue;\n}\n\n/**\n * What to do when a Constraint is violated.\n * @public\n */\nexport enum ConstraintEffect {\n\t/**\n\t * Discard Edit.\n\t */\n\tInvalidAndDiscard,\n\n\t/**\n\t * Discard Edit, but record metadata that application may want to try and recover this change by recreating it.\n\t * Should this be the default policy for when another (non Constraint) change is invalid?\n\t */\n\tInvalidRetry,\n\n\t/**\n\t * Apply the change, but flag it for possible reconsideration by the app\n\t * (applying it is better than not, but perhaps the high level logic could produce something better).\n\t */\n\tValidRetry,\n}\n\n/**\n * {@inheritdoc Constraint}\n * @public\n */\nexport interface ConstraintInternal_0_0_2 {\n\t/** {@inheritdoc Constraint.toConstrain } */\n\treadonly toConstrain: StableRangeInternal_0_0_2;\n\t/** {@inheritdoc Constraint.identityHash } */\n\treadonly identityHash?: UuidString;\n\t/** {@inheritdoc Constraint.length } */\n\treadonly length?: number;\n\t/** {@inheritdoc Constraint.contentHash } */\n\treadonly contentHash?: UuidString;\n\t/** {@inheritdoc Constraint.parentNode } */\n\treadonly parentNode?: StableNodeId;\n\t/** {@inheritdoc Constraint.label } */\n\treadonly label?: TraitLabel;\n\t/** {@inheritdoc Constraint.effect } */\n\treadonly effect: ConstraintEffect;\n\t/** {@inheritdoc Constraint.\"type\" } */\n\treadonly type: typeof ChangeTypeInternal.Constraint;\n}\n\n/**\n * {@inheritdoc (StablePlace:interface) }\n * @public\n */\nexport interface StablePlaceInternal_0_0_2 {\n\t/**\n\t * {@inheritdoc (StablePlace:interface).side }\n\t */\n\treadonly side: Side;\n\n\t/**\n\t * {@inheritdoc (StablePlace:interface).referenceSibling }\n\t */\n\treadonly referenceSibling?: StableNodeId;\n\n\t/**\n\t * {@inheritdoc (StablePlace:interface).referenceTrait }\n\t */\n\treadonly referenceTrait?: TraitLocationInternal_0_0_2;\n}\n\n/**\n * {@inheritdoc (StableRange:interface) }\n * @public\n */\nexport interface StableRangeInternal_0_0_2 {\n\t/** {@inheritdoc (StableRange:interface).start } */\n\treadonly start: StablePlaceInternal_0_0_2;\n\t/** {@inheritdoc (StableRange:interface).end } */\n\treadonly end: StablePlaceInternal_0_0_2;\n}\n"]}

package/dist/persisted-types/0.1.1.d.ts

@@ -0,0 +1,314 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { ReplaceRecursive } from '../Common';
+import type { IdCreationRange, SerializedIdCompressorWithNoSession, SerializedIdCompressorWithOngoingSession } from '../id-compressor';
+import type { Definition, DetachedSequenceId, EditId, FinalNodeId, InternedStringId, NodeId, OpSpaceNodeId, SessionId, TraitLabel, UuidString } from '../Identifiers';
+import { BuildInternal_0_0_2, ChangeTypeInternal, ConstraintEffect, ConstraintInternal_0_0_2, DetachInternal_0_0_2, Edit, EditWithoutId, InsertInternal_0_0_2, NodeData, Payload, SetValueInternal_0_0_2, SharedTreeNoOp, SharedTreeOpType, SharedTreeSummaryBase, SharedTreeUpdateOp, StablePlaceInternal_0_0_2, TraitLocationInternal_0_0_2, TreeNode, TreeNodeSequence, VersionedOp, WriteFormat } from './0.0.2';
+/**
+ * Specifies the location of a trait (a labeled sequence of nodes) within the tree.
+ * @public
+ */
+export interface TraitLocationInternal extends Omit<TraitLocationInternal_0_0_2, 'parent'> {
+    readonly parent: NodeId;
+}
+/**
+ * Alternating list of label then children list under that label.
+ * The label may be interned, and children are {@link CompressedPlaceholderTree}.
+ */
+export declare type CompressedTraits<TId extends OpSpaceNodeId, TPlaceholder extends number | never> = (InternedStringId | TraitLabel | (CompressedPlaceholderTree<TId, TPlaceholder> | TPlaceholder)[])[];
+/**
+ * A TreeNode that has been compressed into the following array format:
+ * [identifier, definition, traits, payload],
+ * where traits is also an array of [label, [trait], label, [trait], ...].
+ * Payload is omitted if empty, and traits will be an empty subarray if no traits exist but a payload exists.
+ * If both traits and payload does not exist, then both are omitted.
+ * All trait labels and node definitions may also be string interned.
+ * @internal
+ */
+export declare type CompressedPlaceholderTree<TId extends OpSpaceNodeId, TPlaceholder extends number | never> = TPlaceholder | [InternedStringId | Definition] | [InternedStringId | Definition, TId] | [
+    InternedStringId | Definition,
+    [
+        Payload,
+        ...CompressedTraits<TId, TPlaceholder>
+    ] | CompressedTraits<TId, TPlaceholder>
+] | [
+    InternedStringId | Definition,
+    TId,
+    [
+        Payload,
+        ...CompressedTraits<TId, TPlaceholder>
+    ] | CompressedTraits<TId, TPlaceholder>
+];
+/**
+ * JSON-compatible Node type. Objects of this type will be persisted in internal change objects (under Edits) in the SharedTree history.
+ * @public
+ */
+export declare type ChangeNode = TreeNode<ChangeNode, NodeId>;
+/**
+ * A ChangeNode that has been compressed into a {@link CompressedPlaceholderTree}.
+ */
+export declare type CompressedChangeNode<TId extends OpSpaceNodeId> = CompressedPlaceholderTree<TId, never>;
+/**
+ * The contents of a SharedTree summary for write format 0.1.1.
+ * Contains the current tree in a compressed format,
+ * the edits needed to get from `initialTree` to the current tree,
+ * and the interned strings that can be used to retrieve the interned summary.
+ */
+export interface SharedTreeSummary extends SharedTreeSummaryBase {
+    readonly version: WriteFormat.v0_1_1;
+    readonly currentTree?: CompressedChangeNode<FinalNodeId>;
+    /**
+     * Information that can populate an edit log.
+     */
+    readonly editHistory: EditLogSummary<CompressedChangeInternal<FinalNodeId>, FluidEditHandle>;
+    /**
+     * List of interned strings.
+     * In 0.1.1, definitions and trait labels are interned deterministically on sequenced ops,
+     * and each client maintains a string interner whose lifetime is tied to the SharedTree.
+     */
+    readonly internedStrings: readonly string[];
+    /**
+     * Information about all IDs compressed in the summary
+     */
+    readonly idCompressor: SerializedIdCompressorWithNoSession | SerializedIdCompressorWithOngoingSession;
+}
+/**
+ * Information used to populate an edit log.
+ * In 0.1.1, this is a persisted type only for `EditLogSummary<CompressedChangeInternal, FluidEditHandle>`,
+ * where calling `FluidEditHandle.get` returns an array buffer of compressed `editChunk` contents.
+ * The type is parameterized to avoid nearly identical type definitions for uncompressed forms of the edit
+ * log, and abstracting away the fact that handle fetching needs to invoke decompression.
+ * @public
+ */
+export interface EditLogSummary<TChange, THandle> {
+    /**
+     * A of list of serialized chunks and their corresponding keys.
+     * Start revision is the index of the first edit in the chunk in relation to the edit log.
+     */
+    readonly editChunks: readonly {
+        readonly startRevision: number;
+        /**
+         * Either a chunk of edits or a handle that can be used to load that chunk.
+         */
+        readonly chunk: THandle | readonly EditWithoutId<TChange>[];
+    }[];
+    /**
+     * A list of edits IDs for all sequenced edits.
+     */
+    readonly editIds: readonly EditId[];
+}
+/**
+ * FluidEditHandles are used to load edit chunks stored outside of the EditLog.
+ * Can be satisfied by IFluidHandle<ArrayBufferLike>.
+ * Note that though this is in `PersistedTypes`, it isn't directly serializable (e.g. `get` is a function).
+ * Its serialization relies on being encoded via an IFluidSerializer.
+ * @public
+ */
+export interface FluidEditHandle {
+    readonly get: () => Promise<ArrayBuffer>;
+    readonly absolutePath: string;
+}
+export declare type EditChunkContents = EditChunkContents_0_1_1;
+export interface EditChunkContents_0_1_1 {
+    version: WriteFormat.v0_1_1;
+    edits: readonly EditWithoutId<CompressedChangeInternal<FinalNodeId>>[];
+}
+/**
+ * Edits per edit chunk. This value is in persisted types because it requires consensus to change.
+ */
+export declare const editsPerChunk = 100;
+/**
+ * Compressed change format type.
+ * Encodes the same information as a {@link ChangeInternal}, but uses a more compact object format for `build` changes.
+ */
+export declare type CompressedChangeInternal<TId extends OpSpaceNodeId> = ReplaceRecursive<Exclude<ChangeInternal, BuildInternal>, NodeId, TId> | CompressedBuildInternal<TId>;
+/**
+ * A compressed version of {@link BuildInternal} where the source is a sequence of compressed nodes.
+ */
+export interface CompressedBuildInternal<TId extends OpSpaceNodeId> {
+    /** {@inheritdoc Build.destination } */
+    readonly destination: DetachedSequenceId;
+    /** A sequence of nodes to build in some compressed format. */
+    readonly source: TreeNodeSequence<CompressedBuildNode<TId>>;
+    /** {@inheritdoc Build."type" } */
+    readonly type: typeof ChangeTypeInternal.CompressedBuild;
+}
+/**
+ * A BuildNode that has been compressed into a {@link CompressedPlaceholderTree}.
+ */
+export declare type CompressedBuildNode<TId extends OpSpaceNodeId> = CompressedPlaceholderTree<TId, DetachedSequenceId>;
+/**
+ * {@inheritdoc (Change:type)}
+ * @public
+ */
+export declare type ChangeInternal = InsertInternal | DetachInternal | BuildInternal | SetValueInternal | ConstraintInternal;
+/**
+ * {@inheritdoc BuildNode}
+ * @public
+ */
+export declare type BuildNodeInternal = TreeNode<BuildNodeInternal, NodeId> | DetachedSequenceId;
+/**
+ * {@inheritdoc Build}
+ * @public
+ */
+export interface BuildInternal extends Omit<BuildInternal_0_0_2, 'source'> {
+    readonly source: TreeNodeSequence<BuildNodeInternal>;
+}
+/**
+ * {@inheritdoc (Insert:interface)}
+ * @public
+ */
+export interface InsertInternal extends Omit<InsertInternal_0_0_2, 'destination'> {
+    /** {@inheritdoc (Insert:interface).destination } */
+    readonly destination: StablePlaceInternal;
+}
+/**
+ * {@inheritdoc Detach}
+ * @public
+ */
+export interface DetachInternal extends Omit<DetachInternal_0_0_2, 'source'> {
+    /** {@inheritdoc Detach.source } */
+    readonly source: StableRangeInternal;
+}
+/**
+ * {@inheritdoc SetValue}
+ * @public
+ */
+export interface SetValueInternal extends Omit<SetValueInternal_0_0_2, 'nodeToModify'> {
+    /** {@inheritdoc SetValue.nodeToModify } */
+    readonly nodeToModify: NodeId;
+}
+/**
+ * {@inheritdoc Constraint}
+ * @public
+ */
+export interface ConstraintInternal extends Omit<ConstraintInternal_0_0_2, 'toConstrain' | 'parentNode'> {
+    /** {@inheritdoc Constraint.toConstrain } */
+    readonly toConstrain: StableRangeInternal;
+    /** {@inheritdoc Constraint.parentNode } */
+    readonly parentNode?: NodeId;
+}
+/**
+ * @public
+ */
+export declare const ChangeInternal: {
+    build: (source: TreeNodeSequence<BuildNodeInternal>, destination: DetachedSequenceId) => BuildInternal;
+    insert: (source: DetachedSequenceId, destination: StablePlaceInternal) => InsertInternal;
+    detach: (source: StableRangeInternal, destination?: DetachedSequenceId | undefined) => DetachInternal;
+    setPayload: (nodeToModify: NodeData<NodeId> | NodeId, payload: Payload) => SetValueInternal;
+    clearPayload: (nodeToModify: NodeData<NodeId> | NodeId) => SetValueInternal;
+    constraint: (toConstrain: StableRangeInternal, 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) => ConstraintInternal;
+    /** {@inheritdoc (Change:variable).delete } */
+    delete: (stableRange: StableRangeInternal) => ChangeInternal;
+    /** {@inheritdoc (Change:variable).insertTree } */
+    insertTree: (nodes: TreeNodeSequence<BuildNodeInternal>, destination: StablePlaceInternal) => ChangeInternal[];
+    /** {@inheritdoc (Change:variable).move } */
+    move: (source: StableRangeInternal, destination: StablePlaceInternal) => ChangeInternal[];
+};
+/**
+ * {@inheritdoc (StablePlace:interface) }
+ * @public
+ */
+export interface StablePlaceInternal extends Omit<StablePlaceInternal_0_0_2, 'referenceSibling' | 'referenceTrait'> {
+    /**
+     * {@inheritdoc (StablePlace:interface).referenceSibling }
+     */
+    readonly referenceSibling?: NodeId;
+    /**
+     * {@inheritdoc (StablePlace:interface).referenceTrait }
+     */
+    readonly referenceTrait?: TraitLocationInternal;
+}
+/**
+ * {@inheritdoc (StableRange:interface) }
+ * @public
+ */
+export interface StableRangeInternal {
+    /** {@inheritdoc (StableRange:interface).start } */
+    readonly start: StablePlaceInternal;
+    /** {@inheritdoc (StableRange:interface).end } */
+    readonly end: StablePlaceInternal;
+}
+/**
+ * The remainder of this file consists of factory methods duplicated with those for StableRange/StablePlace and are maintained while
+ * the new persisted version of SharedTree ops/summaries is rolled out.
+ */
+/**
+ * @public
+ */
+export declare const StablePlaceInternal: {
+    /**
+     * @returns The location directly before `node`.
+     */
+    before: (node: NodeData<NodeId> | NodeId) => StablePlaceInternal;
+    /**
+     * @returns The location directly after `node`.
+     */
+    after: (node: NodeData<NodeId> | NodeId) => StablePlaceInternal;
+    /**
+     * @returns The location at the start of `trait`.
+     */
+    atStartOf: (trait: TraitLocationInternal) => StablePlaceInternal;
+    /**
+     * @returns The location at the end of `trait`.
+     */
+    atEndOf: (trait: TraitLocationInternal) => StablePlaceInternal;
+};
+/**
+ * @public
+ */
+export declare const StableRangeInternal: {
+    /**
+     * Factory for producing a `StableRange` from a start `StablePlace` to an end `StablePlace`.
+     * @example
+     * StableRange.from(StablePlace.before(startNode)).to(StablePlace.after(endNode))
+     */
+    from: (start: StablePlaceInternal) => {
+        to: (end: StablePlaceInternal) => StableRangeInternal;
+    };
+    /**
+     * @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> | NodeId) => StableRangeInternal;
+    /**
+     * @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:
+     * it does not use sibling anchoring.
+     */
+    all: (trait: TraitLocationInternal) => StableRangeInternal;
+};
+/**
+ * Discriminated union of valid 0.0.1 SharedTree op types.
+ */
+export declare type SharedTreeOp = SharedTreeEditOp | SharedTreeHandleOp | SharedTreeUpdateOp | SharedTreeNoOp;
+export interface SharedTreeEditOp extends VersionedOp<WriteFormat.v0_1_1> {
+    readonly type: SharedTreeOpType.Edit;
+    /** The collection of changes to apply. */
+    readonly edit: Edit<CompressedChangeInternal<OpSpaceNodeId>>;
+    /** Contains all the IDs generated by the originating client since the last sent op */
+    readonly idRange: IdCreationRange;
+}
+/**
+ * A SharedTree op that includes edit handle information.
+ * The handle corresponds to an edit chunk in the edit log.
+ */
+export interface SharedTreeHandleOp extends VersionedOp<WriteFormat.v0_1_1> {
+    readonly type: SharedTreeOpType.Handle;
+    /** The serialized handle to an uploaded edit chunk. */
+    readonly editHandle: string;
+    /** The index of the first edit in the chunk that corresponds to the handle. */
+    readonly startRevision: number;
+}
+/** The number of IDs that a SharedTree reserves for current or future internal use */
+export declare const reservedIdCount = 10;
+/** The SessionID of the Upgrade Session */
+export declare const ghostSessionId: SessionId;
+//# sourceMappingURL=0.1.1.d.ts.map

package/dist/persisted-types/0.1.1.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"0.1.1.d.ts","sourceRoot":"","sources":["../../src/persisted-types/0.1.1.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,EAA8B,gBAAgB,EAAE,MAAM,WAAW,CAAC;AAEzE,OAAO,KAAK,EACX,eAAe,EACf,mCAAmC,EACnC,wCAAwC,EACxC,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,EACX,UAAU,EACV,kBAAkB,EAClB,MAAM,EACN,WAAW,EACX,gBAAgB,EAChB,MAAM,EACN,aAAa,EACb,SAAS,EACT,UAAU,EACV,UAAU,EACV,MAAM,gBAAgB,CAAC;AACxB,OAAO,EACN,mBAAmB,EACnB,kBAAkB,EAClB,gBAAgB,EAChB,wBAAwB,EACxB,oBAAoB,EACpB,IAAI,EACJ,aAAa,EACb,oBAAoB,EACpB,QAAQ,EACR,OAAO,EACP,sBAAsB,EACtB,cAAc,EACd,gBAAgB,EAChB,qBAAqB,EACrB,kBAAkB,EAElB,yBAAyB,EACzB,2BAA2B,EAC3B,QAAQ,EACR,gBAAgB,EAChB,WAAW,EACX,WAAW,EACX,MAAM,SAAS,CAAC;AAEjB;;;GAGG;AACH,MAAM,WAAW,qBAAsB,SAAQ,IAAI,CAAC,2BAA2B,EAAE,QAAQ,CAAC;IACzF,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,oBAAY,gBAAgB,CAAC,GAAG,SAAS,aAAa,EAAE,YAAY,SAAS,MAAM,GAAG,KAAK,IAAI,CAC5F,gBAAgB,GAChB,UAAU,GACV,CAAC,yBAAyB,CAAC,GAAG,EAAE,YAAY,CAAC,GAAG,YAAY,CAAC,EAAE,CACjE,EAAE,CAAC;AAEJ;;;;;;;;GAQG;AACH,oBAAY,yBAAyB,CAAC,GAAG,SAAS,aAAa,EAAE,YAAY,SAAS,MAAM,GAAG,KAAK,IACjG,YAAY,GACZ,CAAC,gBAAgB,GAAG,UAAU,CAAC,GAC/B,CAAC,gBAAgB,GAAG,UAAU,EAAE,GAAG,CAAC,GACpC;IACA,gBAAgB,GAAG,UAAU;IAC7B;QAAC,OAAO;QAAE,GAAG,gBAAgB,CAAC,GAAG,EAAE,YAAY,CAAC;KAAC,GAAG,gBAAgB,CAAC,GAAG,EAAE,YAAY,CAAC;CACtF,GACD;IACA,gBAAgB,GAAG,UAAU;IAC7B,GAAG;IACH;QAAC,OAAO;QAAE,GAAG,gBAAgB,CAAC,GAAG,EAAE,YAAY,CAAC;KAAC,GAAG,gBAAgB,CAAC,GAAG,EAAE,YAAY,CAAC;CACtF,CAAC;AAEL;;;GAGG;AACH,oBAAY,UAAU,GAAG,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;AAEtD;;GAEG;AACH,oBAAY,oBAAoB,CAAC,GAAG,SAAS,aAAa,IAAI,yBAAyB,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;AAEpG;;;;;GAKG;AACH,MAAM,WAAW,iBAAkB,SAAQ,qBAAqB;IAC/D,QAAQ,CAAC,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC;IAErC,QAAQ,CAAC,WAAW,CAAC,EAAE,oBAAoB,CAAC,WAAW,CAAC,CAAC;IAEzD;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,cAAc,CAAC,wBAAwB,CAAC,WAAW,CAAC,EAAE,eAAe,CAAC,CAAC;IAE7F;;;;OAIG;IACH,QAAQ,CAAC,eAAe,EAAE,SAAS,MAAM,EAAE,CAAC;IAE5C;;OAEG;IACH,QAAQ,CAAC,YAAY,EAAE,mCAAmC,GAAG,wCAAwC,CAAC;CACtG;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,cAAc,CAAC,OAAO,EAAE,OAAO;IAC/C;;;OAGG;IACH,QAAQ,CAAC,UAAU,EAAE,SAAS;QAC7B,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;QAC/B;;WAEG;QACH,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,SAAS,aAAa,CAAC,OAAO,CAAC,EAAE,CAAC;KAC5D,EAAE,CAAC;IAEJ;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,SAAS,MAAM,EAAE,CAAC;CACpC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,eAAe;IAC/B,QAAQ,CAAC,GAAG,EAAE,MAAM,OAAO,CAAC,WAAW,CAAC,CAAC;IACzC,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;CAC9B;AAGD,oBAAY,iBAAiB,GAAG,uBAAuB,CAAC;AAExD,MAAM,WAAW,uBAAuB;IACvC,OAAO,EAAE,WAAW,CAAC,MAAM,CAAC;IAC5B,KAAK,EAAE,SAAS,aAAa,CAAC,wBAAwB,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC;CACvE;AAED;;GAEG;AACH,eAAO,MAAM,aAAa,MAAM,CAAC;AAEjC;;;GAGG;AACH,oBAAY,wBAAwB,CAAC,GAAG,SAAS,aAAa,IAC3D,gBAAgB,CAAC,OAAO,CAAC,cAAc,EAAE,aAAa,CAAC,EAAE,MAAM,EAAE,GAAG,CAAC,GACrE,uBAAuB,CAAC,GAAG,CAAC,CAAC;AAEhC;;GAEG;AACH,MAAM,WAAW,uBAAuB,CAAC,GAAG,SAAS,aAAa;IACjE,uCAAuC;IACvC,QAAQ,CAAC,WAAW,EAAE,kBAAkB,CAAC;IACzC,8DAA8D;IAC9D,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC,mBAAmB,CAAC,GAAG,CAAC,CAAC,CAAC;IAC5D,kCAAkC;IAClC,QAAQ,CAAC,IAAI,EAAE,OAAO,kBAAkB,CAAC,eAAe,CAAC;CACzD;AAED;;GAEG;AACH,oBAAY,mBAAmB,CAAC,GAAG,SAAS,aAAa,IAAI,yBAAyB,CAAC,GAAG,EAAE,kBAAkB,CAAC,CAAC;AAEhH;;;GAGG;AACH,oBAAY,cAAc,GAAG,cAAc,GAAG,cAAc,GAAG,aAAa,GAAG,gBAAgB,GAAG,kBAAkB,CAAC;AAErH;;;GAGG;AACH,oBAAY,iBAAiB,GAAG,QAAQ,CAAC,iBAAiB,EAAE,MAAM,CAAC,GAAG,kBAAkB,CAAC;AAEzF;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,IAAI,CAAC,mBAAmB,EAAE,QAAQ,CAAC;IACzE,QAAQ,CAAC,MAAM,EAAE,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;CACrD;AAED;;;GAGG;AACH,MAAM,WAAW,cAAe,SAAQ,IAAI,CAAC,oBAAoB,EAAE,aAAa,CAAC;IAChF,oDAAoD;IACpD,QAAQ,CAAC,WAAW,EAAE,mBAAmB,CAAC;CAC1C;AAED;;;GAGG;AACH,MAAM,WAAW,cAAe,SAAQ,IAAI,CAAC,oBAAoB,EAAE,QAAQ,CAAC;IAC3E,mCAAmC;IACnC,QAAQ,CAAC,MAAM,EAAE,mBAAmB,CAAC;CACrC;AAED;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,IAAI,CAAC,sBAAsB,EAAE,cAAc,CAAC;IACrF,2CAA2C;IAC3C,QAAQ,CAAC,YAAY,EAAE,MAAM,CAAC;CAC9B;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,IAAI,CAAC,wBAAwB,EAAE,aAAa,GAAG,YAAY,CAAC;IACvG,4CAA4C;IAC5C,QAAQ,CAAC,WAAW,EAAE,mBAAmB,CAAC;IAC1C,2CAA2C;IAC3C,QAAQ,CAAC,UAAU,CAAC,EAAE,MAAM,CAAC;CAC7B;AAGD;;GAEG;AACH,eAAO,MAAM,cAAc;oBACV,iBAAiB,iBAAiB,CAAC,eAAe,kBAAkB,KAAG,aAAa;qBAMnF,kBAAkB,eAAe,mBAAmB,KAAG,cAAc;qBAMrE,mBAAmB,mDAAqC,cAAc;+BAM5D,SAAS,MAAM,CAAC,GAAG,MAAM,WAAW,OAAO,KAAG,gBAAgB;iCAM5D,SAAS,MAAM,CAAC,GAAG,MAAM,KAAG,gBAAgB;8BAQ3D,mBAAmB,UACxB,gBAAgB;;;;;uIAMtB,kBAAkB;IAWrB,8CAA8C;0BACxB,mBAAmB,KAAG,cAAc;IAE1D,kDAAkD;wBAC9B,iBAAiB,iBAAiB,CAAC,eAAe,mBAAmB,KAAG,cAAc,EAAE;IAK5G,4CAA4C;mBAC7B,mBAAmB,eAAe,mBAAmB,KAAG,cAAc,EAAE;CAIvF,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,mBAAoB,SAAQ,IAAI,CAAC,yBAAyB,EAAE,kBAAkB,GAAG,gBAAgB,CAAC;IAClH;;OAEG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAEnC;;OAEG;IACH,QAAQ,CAAC,cAAc,CAAC,EAAE,qBAAqB,CAAC;CAChD;AAED;;;GAGG;AACH,MAAM,WAAW,mBAAmB;IACnC,mDAAmD;IACnD,QAAQ,CAAC,KAAK,EAAE,mBAAmB,CAAC;IACpC,iDAAiD;IACjD,QAAQ,CAAC,GAAG,EAAE,mBAAmB,CAAC;CAClC;AAED;;;GAGG;AAEH;;GAEG;AACH,eAAO,MAAM,mBAAmB;IAC/B;;OAEG;mBACY,SAAS,MAAM,CAAC,GAAG,MAAM,KAAG,mBAAmB;IAI9D;;OAEG;kBACW,SAAS,MAAM,CAAC,GAAG,MAAM,KAAG,mBAAmB;IAI7D;;OAEG;uBACgB,qBAAqB,KAAG,mBAAmB;IAI9D;;OAEG;qBACc,qBAAqB,KAAG,mBAAmB;CAI5D,CAAC;AAEF;;GAEG;AACH,eAAO,MAAM,mBAAmB;IAC/B;;;;OAIG;kBACW,mBAAmB;kBAAe,mBAAmB,KAAK,mBAAmB;;IAU3F;;;OAGG;iBACU,SAAS,MAAM,CAAC,GAAG,MAAM,KAAG,mBAAmB;IAI5D;;;;OAIG;iBACU,qBAAqB,KAAG,mBAAmB;CAIxD,CAAC;AAEF;;GAEG;AACH,oBAAY,YAAY,GAAG,gBAAgB,GAAG,kBAAkB,GAAG,kBAAkB,GAAG,cAAc,CAAC;AAEvG,MAAM,WAAW,gBAAiB,SAAQ,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC;IACxE,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC,IAAI,CAAC;IACrC,0CAA0C;IAC1C,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,wBAAwB,CAAC,aAAa,CAAC,CAAC,CAAC;IAC7D,sFAAsF;IACtF,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;CAClC;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAmB,SAAQ,WAAW,CAAC,WAAW,CAAC,MAAM,CAAC;IAC1E,QAAQ,CAAC,IAAI,EAAE,gBAAgB,CAAC,MAAM,CAAC;IACvC,uDAAuD;IACvD,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAC5B,+EAA+E;IAC/E,QAAQ,CAAC,aAAa,EAAE,MAAM,CAAC;CAC/B;AAED,sFAAsF;AAEtF,eAAO,MAAM,eAAe,KAAK,CAAC;AAElC,2CAA2C;AAE3C,eAAO,MAAM,cAAc,WAAsD,CAAC"}

package/dist/persisted-types/0.1.1.js

@@ -0,0 +1,153 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ghostSessionId = exports.reservedIdCount = exports.StableRangeInternal = exports.StablePlaceInternal = exports.ChangeInternal = exports.editsPerChunk = void 0;
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+const Common_1 = require("../Common");
+const _0_0_2_1 = require("./0.0.2");
+/**
+ * Edits per edit chunk. This value is in persisted types because it requires consensus to change.
+ */
+exports.editsPerChunk = 100;
+// Note: Documentation of this constant is merged with documentation of the `ChangeInternal` interface.
+/**
+ * @public
+ */
+exports.ChangeInternal = {
+    build: (source, destination) => ({
+        destination,
+        source,
+        type: _0_0_2_1.ChangeTypeInternal.Build,
+    }),
+    insert: (source, destination) => ({
+        destination,
+        source,
+        type: _0_0_2_1.ChangeTypeInternal.Insert,
+    }),
+    detach: (source, destination) => ({
+        destination,
+        source,
+        type: _0_0_2_1.ChangeTypeInternal.Detach,
+    }),
+    setPayload: (nodeToModify, payload) => ({
+        nodeToModify: getNodeId(nodeToModify),
+        payload,
+        type: _0_0_2_1.ChangeTypeInternal.SetValue,
+    }),
+    clearPayload: (nodeToModify) => ({
+        nodeToModify: getNodeId(nodeToModify),
+        // Rationale: 'undefined' is reserved for future use (see 'SetValue' interface above.)
+        payload: null,
+        type: _0_0_2_1.ChangeTypeInternal.SetValue,
+    }),
+    constraint: (toConstrain, effect, identityHash, length, contentHash, parentNode, label) => ({
+        toConstrain,
+        effect,
+        identityHash,
+        length,
+        contentHash,
+        parentNode,
+        label,
+        type: _0_0_2_1.ChangeTypeInternal.Constraint,
+    }),
+    /** {@inheritdoc (Change:variable).delete } */
+    delete: (stableRange) => exports.ChangeInternal.detach(stableRange),
+    /** {@inheritdoc (Change:variable).insertTree } */
+    insertTree: (nodes, destination) => {
+        const build = exports.ChangeInternal.build(nodes, 0);
+        return [build, exports.ChangeInternal.insert(build.destination, destination)];
+    },
+    /** {@inheritdoc (Change:variable).move } */
+    move: (source, destination) => {
+        const detach = exports.ChangeInternal.detach(source, 0);
+        return [detach, exports.ChangeInternal.insert(Common_1.assertNotUndefined(detach.destination), destination)];
+    },
+};
+/**
+ * The remainder of this file consists of factory methods duplicated with those for StableRange/StablePlace and are maintained while
+ * the new persisted version of SharedTree ops/summaries is rolled out.
+ */
+/**
+ * @public
+ */
+exports.StablePlaceInternal = {
+    /**
+     * @returns The location directly before `node`.
+     */
+    before: (node) => ({
+        side: _0_0_2_1.Side.Before,
+        referenceSibling: getNodeId(node),
+    }),
+    /**
+     * @returns The location directly after `node`.
+     */
+    after: (node) => ({
+        side: _0_0_2_1.Side.After,
+        referenceSibling: getNodeId(node),
+    }),
+    /**
+     * @returns The location at the start of `trait`.
+     */
+    atStartOf: (trait) => ({
+        side: _0_0_2_1.Side.After,
+        referenceTrait: trait,
+    }),
+    /**
+     * @returns The location at the end of `trait`.
+     */
+    atEndOf: (trait) => ({
+        side: _0_0_2_1.Side.Before,
+        referenceTrait: trait,
+    }),
+};
+/**
+ * @public
+ */
+exports.StableRangeInternal = {
+    /**
+     * Factory for producing a `StableRange` from a start `StablePlace` to an end `StablePlace`.
+     * @example
+     * StableRange.from(StablePlace.before(startNode)).to(StablePlace.after(endNode))
+     */
+    from: (start) => ({
+        to: (end) => {
+            if (start.referenceTrait && end.referenceTrait) {
+                const message = 'StableRange must be constructed with endpoints from the same trait';
+                Common_1.assert(start.referenceTrait.parent === end.referenceTrait.parent, message);
+                Common_1.assert(start.referenceTrait.label === end.referenceTrait.label, message);
+            }
+            return { start, end };
+        },
+    }),
+    /**
+     * @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.StablePlaceInternal.before(node),
+        end: exports.StablePlaceInternal.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:
+     * it does not use sibling anchoring.
+     */
+    all: (trait) => ({
+        start: exports.StablePlaceInternal.atStartOf(trait),
+        end: exports.StablePlaceInternal.atEndOf(trait),
+    }),
+};
+/** The number of IDs that a SharedTree reserves for current or future internal use */
+// This value must never change
+exports.reservedIdCount = 10;
+/** The SessionID of the Upgrade Session */
+// This UUID must never change
+exports.ghostSessionId = '79590933-1c70-4fda-817a-adab57c20318';
+/** Accepts either a node or a node's identifier, and returns the identifier */
+function getNodeId(node) {
+    var _a;
+    return (_a = node.identifier) !== null && _a !== void 0 ? _a : node;
+}
+//# sourceMappingURL=0.1.1.js.map