@fluidframework/tree 2.0.0-rc.2.0.2 → 2.0.0-rc.3.0.0

package/lib/simple-tree/toMapTree.js

@@ -2,14 +2,13 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { assert } from "@fluidframework/core-utils";
-import { UsageError } from "@fluidframework/telemetry-utils";
-import { EmptyKey } from "../core/index.js";
-// Drilling into `domains` to reduce the magnitude of cycles introduced here
-// eslint-disable-next-line import/no-internal-modules
-import { leaf } from "../domains/leafDomain.js";
-import { allowsValue, cursorForMapTreeField, cursorForMapTreeNode, isFluidHandle, Multiplicity, Any, FlexFieldNodeSchema, isTreeValue, LeafNodeSchema, FlexMapNodeSchema, getAllowedTypes, typeNameSymbol, } from "../feature-libraries/index.js";
-import { brand, isReadonlyArray } from "../util/index.js";
+import { assert } from "@fluidframework/core-utils/internal";
+import { UsageError } from "@fluidframework/telemetry-utils/internal";
+import { EmptyKey, } from "../core/index.js";
+import { cursorForMapTreeField, cursorForMapTreeNode, isTreeValue, typeNameSymbol, valueSchemaAllows, } from "../feature-libraries/index.js";
+import { brand, fail, isReadonlyArray } from "../util/index.js";
+import { nullSchema } from "./leafNodeSchema.js";
+import { FieldKind, NodeKind, normalizeAllowedTypes, normalizeFieldSchema, getStoredKey, } from "./schemaTypes.js";
 /**
  * Module notes:
  *
@@ -23,25 +22,26 @@ import { brand, isReadonlyArray } from "../util/index.js";
 /**
  * Transforms an input {@link TypedNode} tree to a {@link MapTree}, and wraps the tree in a {@link CursorWithNode}.
  * @param data - The input tree to be converted.
- * @param globalSchema - Schema for the whole tree for interperting `Any`.
- * @param typeSet - The set of types allowed by the parent context. Used to validate the input tree.
+ * @param allowedTypes - The set of types allowed by the parent context. Used to validate the input tree.
  *
  * @returns A cursor (in nodes mode) for the mapped tree if the input data was defined. Otherwise, returns `undefined`.
  */
-export function cursorFromNodeData(data, globalSchema, typeSet) {
+export function cursorFromNodeData(data, allowedTypes) {
     if (data === undefined) {
         return undefined;
     }
-    const mappedContent = nodeDataToMapTree(data, globalSchema, typeSet);
+    const mappedContent = nodeDataToMapTree(data, normalizeAllowedTypes(allowedTypes));
     return cursorForMapTreeNode(mappedContent);
 }
 /**
- * Transforms an input {@link TreeField} tree to an array of {@link MapTree}s, and wraps the tree in a {@link CursorWithNode}.
+ * Transforms an input {@link InsertableContent} tree to an array of {@link MapTree}s, and wraps the tree in a {@link CursorWithNode}.
  * @param data - The input tree to be converted.
- * @param globalSchema - Schema for the whole tree for interperting `Any`.
+ * @param schema - Schema of the field with which the input `data` is associated.
  */
-export function cursorFromFieldData(data, globalSchema, fieldSchema) {
-    const mappedContent = fieldDataToMapTrees(data, globalSchema, fieldSchema);
+export function cursorFromFieldData(data, schema) {
+    const mappedContent = Array.isArray(data)
+        ? arrayToMapTreeFields(data, schema.allowedTypeSet)
+        : [nodeDataToMapTree(data, schema.allowedTypeSet)];
     return cursorForMapTreeField(mappedContent);
 }
 /**
@@ -58,80 +58,46 @@ export function cursorFromFieldData(data, globalSchema, fieldSchema) {
  *
  * * `-0` =\> `+0`
  *
- * @param globalSchema - Schema for the whole tree for interperting `Any`.
- * @param typeSet - The set of types allowed by the parent context. Used to validate the input tree.
+ * @param data - The tree data being transformed.
+ * @param allowedTypes - The set of types allowed by the parent context. Used to validate the input tree.
  */
-export function nodeDataToMapTree(data, globalSchema, typeSet) {
+export function nodeDataToMapTree(data, allowedTypes) {
     assert(data !== undefined, 0x846 /* Cannot map undefined tree. */);
-    if (data === null) {
-        return valueToMapTree(data, globalSchema, typeSet);
-    }
-    switch (typeof data) {
-        case "number":
-        case "string":
-        case "boolean":
-            return valueToMapTree(data, globalSchema, typeSet);
-        default: {
-            if (isFluidHandle(data)) {
-                return valueToMapTree(data, globalSchema, typeSet);
-            }
-            else if (Array.isArray(data)) {
-                return arrayToMapTree(data, globalSchema, typeSet);
-            }
-            else if (data instanceof Map) {
-                return mapToMapTree(data, globalSchema, typeSet);
-            }
-            else {
-                // Assume record-like object
-                return recordToMapTree(data, globalSchema, typeSet);
-            }
-        }
+    const schema = getType(data, allowedTypes);
+    switch (schema.kind) {
+        case NodeKind.Leaf:
+            return leafToMapTree(data, schema, allowedTypes);
+        case NodeKind.Array:
+            return arrayToMapTree(data, schema);
+        case NodeKind.Map:
+            return mapToMapTree(data, schema);
+        case NodeKind.Object:
+            return objectToMapTree(data, schema);
+        default:
+            fail(`Unrecognized schema kind: ${schema.kind}.`);
     }
 }
 /**
- * Transforms an input {@link TreeField} tree to an array of {@link MapTree}s.
- * @param data - The input tree to be converted.
- * If the input is a sequence containing 1 or more `undefined` values, those values will be mapped as `null` if supported.
- * Othewise, an error will be thrown.
- * @param globalSchema - Schema for the whole tree. Used to select the valid types when encountering `any`.
+ * Transforms data under a Leaf schema.
+ * @param data - The tree data to be transformed. Must be a {@link TreeValue}.
+ * @param schema - The schema associated with the value.
+ * @param allowedTypes - The allowed types specified by the parent.
+ * Used to determine which fallback values may be appropriate.
  */
-export function fieldDataToMapTrees(data, globalSchema, fieldSchema) {
-    const multiplicity = fieldSchema.kind.multiplicity;
-    if (data === undefined) {
-        assert(multiplicity === Multiplicity.Forbidden || multiplicity === Multiplicity.Optional, 0x847 /* `undefined` provided for a field that does not support `undefined` */);
-        return [];
+function leafToMapTree(data, schema, allowedTypes) {
+    assert(schema.kind === NodeKind.Leaf, 0x921 /* Expected a leaf schema. */);
+    if (!isTreeValue(data)) {
+        // This rule exists to protect against useless `toString` output like `[object Object]`.
+        // In this case, that's actually reasonable behavior, since object input is not compatible with Leaf schemas.
+        // eslint-disable-next-line @typescript-eslint/no-base-to-string
+        throw new UsageError(`Input data is incompatible with leaf schema: ${data}`);
     }
-    const typeSet = fieldSchema.allowedTypeSet;
-    if (multiplicity === Multiplicity.Sequence) {
-        assert(Array.isArray(data), 0x848 /* Expected an array as sequence input. */);
-        const children = Array.from(data, (child) => {
-            // We do not support undefined sequence entries.
-            // If we encounter an undefined entry, use null instead if supported by the schema, otherwise throw.
-            let childWithFallback = child;
-            if (child === undefined) {
-                if (typeSet === Any || typeSet.has(leaf.null)) {
-                    childWithFallback = null;
-                }
-                else {
-                    throw new TypeError(`Received unsupported array entry value: ${child}.`);
-                }
-            }
-            return nodeDataToMapTree(childWithFallback, globalSchema, typeSet);
-        });
-        return children;
-    }
-    assert(multiplicity === Multiplicity.Single || multiplicity === Multiplicity.Optional, 0x849 /* A single value was provided for an unsupported field */);
-    return [nodeDataToMapTree(data, globalSchema, typeSet)];
-}
-function valueToMapTree(
-// eslint-disable-next-line @rushstack/no-new-null
-value, globalSchema, typeSet) {
-    const mappedValue = mapValueWithFallbacks(value, typeSet);
-    const schema = getType(mappedValue, globalSchema, typeSet);
-    assert(schema instanceof LeafNodeSchema && allowsValue(schema.leafValue, mappedValue), 0x84a /* Unsupported schema for provided primitive. */);
+    const mappedValue = mapValueWithFallbacks(data, allowedTypes);
+    const mappedSchema = getType(mappedValue, allowedTypes);
+    assert(allowsValue(mappedSchema, mappedValue), 0x84a /* Unsupported schema for provided primitive. */);
     return {
         value: mappedValue,
-        type: schema.name,
+        type: brand(mappedSchema.identifier),
         fields: new Map(),
     };
 }
@@ -141,9 +107,7 @@ value, globalSchema, typeSet) {
  * For unsupported values without a schema-compatible replacement, throw.
  * For supported values, return the input.
  */
-function mapValueWithFallbacks(
-// eslint-disable-next-line @rushstack/no-new-null
-value, typeSet) {
+function mapValueWithFallbacks(value, allowedTypes) {
     switch (typeof value) {
         case "number": {
             if (Object.is(value, -0)) {
@@ -155,7 +119,7 @@ value, typeSet) {
                 // Our serialized data format does not support NaN nor +/-∞.
                 // If the schema supports `null`, fall back to that. Otherwise, throw.
                 // This is intended to match JSON's behavior for such values.
-                if (typeSet === Any || typeSet.has(leaf.null)) {
+                if (allowedTypes.has(nullSchema)) {
                     return null;
                 }
                 else {
@@ -170,60 +134,127 @@ value, typeSet) {
             return value;
     }
 }
-function arrayToMapTree(data, globalSchema, typeSet) {
-    const schema = getType(data, globalSchema, typeSet);
-    assert(schema instanceof FlexFieldNodeSchema, 0x84b /* Array data reported comparable with the schema without a primary field. */);
-    const mappedChildren = fieldDataToMapTrees(data, globalSchema, schema.info);
-    const fieldsEntries = mappedChildren.length === 0 ? [] : [[EmptyKey, mappedChildren]];
+function arrayToMapTreeFields(data, allowedTypes) {
+    const mappedData = [];
+    for (const child of data) {
+        // We do not support undefined sequence entries.
+        // If we encounter an undefined entry, use null instead if supported by the schema, otherwise throw.
+        let childWithFallback = child;
+        if (child === undefined) {
+            if (allowedTypes.has(nullSchema)) {
+                childWithFallback = null;
+            }
+            else {
+                throw new TypeError(`Received unsupported array entry value: ${child}.`);
+            }
+        }
+        const mappedChild = nodeDataToMapTree(childWithFallback, allowedTypes);
+        mappedData.push(mappedChild);
+    }
+    return mappedData;
+}
+/**
+ * Transforms data under an Array schema.
+ * @param data - The tree data to be transformed. Must be an array.
+ * @param schema - The schema associated with the value.
+ * @param allowedTypes - The allowed types specified by the parent.
+ * Used to determine which fallback values may be appropriate.
+ */
+function arrayToMapTree(data, schema) {
+    assert(schema.kind === NodeKind.Array, 0x922 /* Expected an array schema. */);
+    if (!isReadonlyArray(data)) {
+        throw new UsageError(`Input data is incompatible with Array schema: ${data}`);
+    }
+    const allowedChildTypes = normalizeAllowedTypes(schema.info);
+    const mappedData = arrayToMapTreeFields(data, allowedChildTypes);
     // Array node children are represented as a single field entry denoted with `EmptyKey`
+    const fieldsEntries = mappedData.length === 0 ? [] : [[EmptyKey, mappedData]];
     const fields = new Map(fieldsEntries);
     return {
-        type: schema.name,
+        type: brand(schema.identifier),
         fields,
     };
 }
-function mapToMapTree(data, globalSchema, typeSet) {
-    const schema = getType(data, globalSchema, typeSet);
-    const fields = new Map();
+/**
+ * Transforms data under a Map schema.
+ * @param data - The tree data to be transformed. Must be a TypeScript Map.
+ * @param schema - The schema associated with the value.
+ * @param allowedTypes - The allowed types specified by the parent.
+ * Used to determine which fallback values may be appropriate.
+ */
+function mapToMapTree(data, schema) {
+    assert(schema.kind === NodeKind.Map, 0x923 /* Expected a Map schema. */);
+    if (!(data instanceof Map)) {
+        throw new UsageError(`Input data is incompatible with Map schema: ${data}`);
+    }
+    const allowedChildTypes = normalizeAllowedTypes(schema.info);
+    const transformedFields = new Map();
     for (const [key, value] of data) {
-        assert(!fields.has(brand(key)), 0x84c /* Keys should not be duplicated */);
-        // Omit undefined record entries - an entry with an undefined key is equivalent to no entry
+        assert(!transformedFields.has(brand(key)), 0x84c /* Keys should not be duplicated */);
+        // Omit undefined values - an entry with an undefined value is equivalent to one that has been removed or omitted
         if (value !== undefined) {
-            const childSchema = schema.getFieldSchema(brand(key));
-            const mappedField = fieldDataToMapTrees(value, globalSchema, childSchema);
-            fields.set(brand(key), mappedField);
+            const mappedField = nodeDataToMapTree(value, allowedChildTypes);
+            transformedFields.set(brand(key), [mappedField]);
         }
     }
     return {
-        type: schema.name,
-        fields,
+        type: brand(schema.identifier),
+        fields: transformedFields,
     };
 }
-function recordToMapTree(data, globalSchema, typeSet) {
-    const schema = getType(data, globalSchema, typeSet);
+/**
+ * Transforms data under an Object schema.
+ * @param data - The tree data to be transformed. Must be a Record-like object.
+ * @param schema - The schema associated with the value.
+ * @param allowedTypes - The allowed types specified by the parent.
+ * Used to determine which fallback values may be appropriate.
+ */
+function objectToMapTree(data, schema) {
+    assert(schema.kind === NodeKind.Object, 0x924 /* Expected an Object schema. */);
+    if (typeof data !== "object" || data === null) {
+        throw new UsageError(`Input data is incompatible with Object schema: ${data}`);
+    }
     const fields = new Map();
     // Filter keys to only those that are strings - our trees do not support symbol or numeric property keys
     const keys = Reflect.ownKeys(data).filter((key) => typeof key === "string");
-    for (const key of keys) {
-        assert(!fields.has(key), 0x84d /* Keys should not be duplicated */);
-        const value = data[key];
+    for (const viewKey of keys) {
+        const fieldValue = data[viewKey];
         // Omit undefined record entries - an entry with an undefined key is equivalent to no entry
-        if (value !== undefined) {
-            const childSchema = schema.getFieldSchema(key);
-            const mappedChildTree = fieldDataToMapTrees(value, globalSchema, childSchema);
-            fields.set(brand(key), mappedChildTree);
+        if (fieldValue !== undefined) {
+            const fieldSchema = getObjectFieldSchema(schema, viewKey);
+            const mappedChildTree = nodeDataToMapTree(fieldValue, fieldSchema.allowedTypeSet);
+            const flexKey = brand(getStoredKey(viewKey, fieldSchema));
+            // Note: SchemaFactory validates this at schema creation time, with a user-friendly error.
+            // So we don't expect to hit this, and if we do it is likely an internal bug.
+            assert(!fields.has(flexKey), 0x925 /* Keys must not be duplicated */);
+            fields.set(flexKey, [mappedChildTree]);
         }
     }
     return {
-        type: schema.name,
+        type: brand(schema.identifier),
         fields,
     };
 }
-function getType(data, globalSchema, typeSet) {
-    const possibleTypes = getPossibleTypes(globalSchema, typeSet, data);
+function getObjectFieldSchema(schema, key) {
+    assert(schema.kind === NodeKind.Object, 0x926 /* Expected an Object schema. */);
+    const fields = schema.info;
+    if (fields[key] === undefined) {
+        fail(`Field "${key}" not found in schema "${schema.identifier}".`);
+    }
+    else {
+        return normalizeFieldSchema(fields[key]);
+    }
+}
+function getType(data, allowedTypes) {
+    const possibleTypes = getPossibleTypes(allowedTypes, data);
+    if (possibleTypes.length === 0) {
+        throw new UsageError(`The provided data is incompatible with all of the types allowed by the schema. The set of allowed types is: ${JSON.stringify([...allowedTypes].map((schema) => schema.identifier))}.`);
+    }
     assert(possibleTypes.length !== 0, 0x84e /* data is incompatible with all types allowed by the schema */);
     checkInput(possibleTypes.length === 1, () => `The provided data is compatible with more than one type allowed by the schema.
-The set of possible types is ${JSON.stringify([...possibleTypes.map((n) => n.name)], undefined)}.
+The set of possible types is ${JSON.stringify([
+        ...possibleTypes.map((schema) => schema.identifier),
+    ])}.
 Explicitly construct an unhydrated node of the desired type to disambiguate.
 For class-based schema, this can be done by replacing an expression like "{foo: 1}" with "new MySchema({foo: 1})".`);
     return possibleTypes[0];
@@ -243,13 +274,11 @@ function checkInput(condition, message) {
 /**
  * @returns all types for which the data is schema-compatible.
  */
-export function getPossibleTypes(globalSchema, typeSet, data) {
-    // All types allowed by schema
-    const allowedTypes = getAllowedTypes(globalSchema, typeSet);
+export function getPossibleTypes(allowedTypes, data) {
     const possibleTypes = [];
-    for (const allowed of allowedTypes) {
-        if (shallowCompatibilityTest(allowed, data)) {
-            possibleTypes.push(allowed);
+    for (const schema of allowedTypes) {
+        if (shallowCompatibilityTest(schema, data)) {
+            possibleTypes.push(schema);
         }
     }
     return possibleTypes;
@@ -264,28 +293,49 @@ export function getPossibleTypes(globalSchema, typeSet, data) {
 function shallowCompatibilityTest(schema, data) {
     assert(data !== undefined, 0x889 /* undefined cannot be used as contextually typed data. Use ContextuallyTypedFieldData. */);
     if (isTreeValue(data)) {
-        return schema instanceof LeafNodeSchema && allowsValue(schema.leafValue, data);
+        return allowsValue(schema, data);
     }
-    if (schema instanceof LeafNodeSchema) {
+    if (schema.kind === NodeKind.Leaf) {
         return false;
     }
     if (typeNameSymbol in data) {
-        return data[typeNameSymbol] === schema.name;
+        return data[typeNameSymbol] === schema.identifier;
     }
     if (isReadonlyArray(data)) {
-        if (schema instanceof FlexFieldNodeSchema) {
-            const field = schema.getFieldSchema();
-            return field.kind.multiplicity === Multiplicity.Sequence;
-        }
-        else {
-            return false;
-        }
+        return schema.kind === NodeKind.Array;
+    }
+    if (schema.kind === NodeKind.Array) {
+        return false;
     }
     if (data instanceof Map) {
-        return schema instanceof FlexMapNodeSchema;
+        return schema.kind === NodeKind.Map;
+    }
+    if (schema.kind === NodeKind.Map) {
+        return false;
+    }
+    // Assume record-like object
+    if (schema.kind !== NodeKind.Object) {
+        return false;
+    }
+    const fields = schema.info;
+    // TODO: Improve type inference by making this logic more thorough. Handle at least:
+    // * Types which are strict subsets of other types in the same polymorphic union
+    // * Types which have the same keys but different types for those keys in the polymorphic union
+    // * Types which have the same required fields but different optional fields and enough of those optional fields are populated to disambiguate
+    // TODO#7441: Consider allowing data to be inserted which has keys that are extraneous/unknown to the schema (those keys are ignored)
+    // If the schema has a required key which is not present in the input object, reject it.
+    for (const [fieldKey, fieldSchema] of Object.entries(fields)) {
+        const normalizedFieldSchema = normalizeFieldSchema(fieldSchema);
+        if (data[fieldKey] === undefined && normalizedFieldSchema.kind === FieldKind.Required) {
+            return false;
+        }
     }
-    // For now, consider all not explicitly typed objects shallow compatible.
-    // This will require explicit differentiation in polymorphic cases rather than automatic structural differentiation.
     return true;
 }
+function allowsValue(schema, value) {
+    if (schema.kind === NodeKind.Leaf) {
+        return valueSchemaAllows(schema.info, value);
+    }
+    return false;
+}
 //# sourceMappingURL=toMapTree.js.map

package/lib/simple-tree/toMapTree.js.map

@@ -1 +1 @@
-{"version":3,"file":"toMapTree.js","sourceRoot":"","sources":["../../src/simple-tree/toMapTree.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,MAAM,EAAE,MAAM,4BAA4B,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAE7D,OAAO,EAAE,QAAQ,EAA+B,MAAM,kBAAkB,CAAC;AACzE,4EAA4E;AAC5E,sDAAsD;AACtD,OAAO,EAAE,IAAI,EAAE,MAAM,0BAA0B,CAAC;AAChD,OAAO,EACN,WAAW,EACX,qBAAqB,EACrB,oBAAoB,EAEpB,aAAa,EACb,YAAY,EAKZ,GAAG,EACH,mBAAmB,EACnB,WAAW,EACX,cAAc,EACd,iBAAiB,EACjB,eAAe,EACf,cAAc,GACd,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAG1D;;;;;;;;;GASG;AAEH;;;;;;;GAOG;AACH,MAAM,UAAU,kBAAkB,CACjC,IAAuB,EACvB,YAA4B,EAC5B,OAAuB;IAEvB,IAAI,IAAI,KAAK,SAAS,EAAE;QACvB,OAAO,SAAS,CAAC;KACjB;IACD,MAAM,aAAa,GAAG,iBAAiB,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IACrE,OAAO,oBAAoB,CAAC,aAAa,CAAC,CAAC;AAC5C,CAAC;AAID;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAClC,IAAyB,EACzB,YAA4B,EAC5B,WAA4B;IAE5B,MAAM,aAAa,GAAG,mBAAmB,CAAC,IAAI,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;IAC3E,OAAO,qBAAqB,CAAC,aAAa,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,iBAAiB,CAChC,IAAuB,EACvB,YAA4B,EAC5B,OAAuB;IAEvB,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;IAEnE,IAAI,IAAI,KAAK,IAAI,EAAE;QAClB,OAAO,cAAc,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;KACnD;IACD,QAAQ,OAAO,IAAI,EAAE;QACpB,KAAK,QAAQ,CAAC;QACd,KAAK,QAAQ,CAAC;QACd,KAAK,SAAS;YACb,OAAO,cAAc,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;QACpD,OAAO,CAAC,CAAC;YACR,IAAI,aAAa,CAAC,IAAI,CAAC,EAAE;gBACxB,OAAO,cAAc,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;aACnD;iBAAM,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE;gBAC/B,OAAO,cAAc,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;aACnD;iBAAM,IAAI,IAAI,YAAY,GAAG,EAAE;gBAC/B,OAAO,YAAY,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;aACjD;iBAAM;gBACN,4BAA4B;gBAC5B,OAAO,eAAe,CACrB,IAAyC,EACzC,YAAY,EACZ,OAAO,CACP,CAAC;aACF;SACD;KACD;AACF,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,mBAAmB,CAClC,IAAyB,EACzB,YAA4B,EAC5B,WAA4B;IAE5B,MAAM,YAAY,GAAG,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC;IACnD,IAAI,IAAI,KAAK,SAAS,EAAE;QACvB,MAAM,CACL,YAAY,KAAK,YAAY,CAAC,SAAS,IAAI,YAAY,KAAK,YAAY,CAAC,QAAQ,EACjF,KAAK,CAAC,wEAAwE,CAC9E,CAAC;QACF,OAAO,EAAE,CAAC;KACV;IAED,MAAM,OAAO,GAAG,WAAW,CAAC,cAAc,CAAC;IAE3C,IAAI,YAAY,KAAK,YAAY,CAAC,QAAQ,EAAE;QAC3C,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAC9E,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE;YAC3C,gDAAgD;YAChD,oGAAoG;YACpG,IAAI,iBAAiB,GAAG,KAAK,CAAC;YAC9B,IAAI,KAAK,KAAK,SAAS,EAAE;gBACxB,IAAI,OAAO,KAAK,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;oBAC9C,iBAAiB,GAAG,IAAI,CAAC;iBACzB;qBAAM;oBACN,MAAM,IAAI,SAAS,CAAC,2CAA2C,KAAK,GAAG,CAAC,CAAC;iBACzE;aACD;YACD,OAAO,iBAAiB,CAAC,iBAAiB,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC;KAChB;IACD,MAAM,CACL,YAAY,KAAK,YAAY,CAAC,MAAM,IAAI,YAAY,KAAK,YAAY,CAAC,QAAQ,EAC9E,KAAK,CAAC,0DAA0D,CAChE,CAAC;IACF,OAAO,CAAC,iBAAiB,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC;AACzD,CAAC;AAED,SAAS,cAAc;AACtB,kDAAkD;AAClD,KAAsD,EACtD,YAA4B,EAC5B,OAAuB;IAEvB,MAAM,WAAW,GAAG,qBAAqB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;IAE1D,MAAM,MAAM,GAAG,OAAO,CAAC,WAAW,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IAC3D,MAAM,CACL,MAAM,YAAY,cAAc,IAAI,WAAW,CAAC,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,EAC9E,KAAK,CAAC,gDAAgD,CACtD,CAAC;IAEF,OAAO;QACN,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,MAAM,EAAE,IAAI,GAAG,EAAE;KACjB,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAS,qBAAqB;AAC7B,kDAAkD;AAClD,KAAsD,EACtD,OAAuB;IAGvB,QAAQ,OAAO,KAAK,EAAE;QACrB,KAAK,QAAQ,CAAC,CAAC;YACd,IAAI,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE;gBACzB,kDAAkD;gBAClD,wBAAwB;gBACxB,OAAO,CAAC,CAAC;aACT;iBAAM,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;gBAC1D,4DAA4D;gBAC5D,sEAAsE;gBACtE,6DAA6D;gBAC7D,IAAI,OAAO,KAAK,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;oBAC9C,OAAO,IAAI,CAAC;iBACZ;qBAAM;oBACN,MAAM,IAAI,SAAS,CAAC,uCAAuC,KAAK,GAAG,CAAC,CAAC;iBACrE;aACD;iBAAM;gBACN,OAAO,KAAK,CAAC;aACb;SACD;QACD;YACC,OAAO,KAAK,CAAC;KACd;AACF,CAAC;AAED,SAAS,cAAc,CACtB,IAAyB,EACzB,YAA4B,EAC5B,OAAuB;IAEvB,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IACpD,MAAM,CACL,MAAM,YAAY,mBAAmB,EACrC,KAAK,CAAC,6EAA6E,CACnF,CAAC;IAEF,MAAM,cAAc,GAAG,mBAAmB,CAAC,IAAI,EAAE,YAAY,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;IAC5E,MAAM,aAAa,GAClB,cAAc,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC;IAEjE,sFAAsF;IACtF,MAAM,MAAM,GAAG,IAAI,GAAG,CAAsB,aAAa,CAAC,CAAC;IAE3D,OAAO;QACN,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,MAAM;KACN,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CACpB,IAAoC,EACpC,YAA4B,EAC5B,OAAuB;IAEvB,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IAEpD,MAAM,MAAM,GAAG,IAAI,GAAG,EAAuB,CAAC;IAC9C,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,IAAI,EAAE;QAChC,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;QAE3E,2FAA2F;QAC3F,IAAI,KAAK,KAAK,SAAS,EAAE;YACxB,MAAM,WAAW,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;YACtD,MAAM,WAAW,GAAG,mBAAmB,CAAC,KAAK,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;YAC1E,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,WAAW,CAAC,CAAC;SACpC;KACD;IACD,OAAO;QACN,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,MAAM;KACN,CAAC;AACH,CAAC;AAED,SAAS,eAAe,CACvB,IAAyD,EACzD,YAA4B,EAC5B,OAAuB;IAEvB,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IAEpD,MAAM,MAAM,GAAG,IAAI,GAAG,EAAuB,CAAC;IAE9C,wGAAwG;IACxG,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,CAAe,CAAC;IAE1F,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE;QACvB,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;QACpE,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;QAExB,2FAA2F;QAC3F,IAAI,KAAK,KAAK,SAAS,EAAE;YACxB,MAAM,WAAW,GAAG,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;YAC/C,MAAM,eAAe,GAAG,mBAAmB,CAAC,KAAK,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;YAC9E,MAAM,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,eAAe,CAAC,CAAC;SACxC;KACD;IAED,OAAO;QACN,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,MAAM;KACN,CAAC;AACH,CAAC;AAED,SAAS,OAAO,CACf,IAAuB,EACvB,YAA4B,EAC5B,OAAuB;IAEvB,MAAM,aAAa,GAAG,gBAAgB,CACrC,YAAY,EACZ,OAAO,EACP,IAAiC,CACjC,CAAC;IACF,MAAM,CACL,aAAa,CAAC,MAAM,KAAK,CAAC,EAC1B,KAAK,CAAC,+DAA+D,CACrE,CAAC;IACF,UAAU,CACT,aAAa,CAAC,MAAM,KAAK,CAAC,EAC1B,GAAG,EAAE,CACJ;+BAC4B,IAAI,CAAC,SAAS,CAAC,CAAC,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,EAAE,SAAS,CAAC;;mHAEoB,CACjH,CAAC;IACF,OAAO,aAAa,CAAC,CAAC,CAAC,CAAC;AACzB,CAAC;AAED;;;GAGG;AACH,SAAS,YAAY,CAAC,OAAe;IACpC,MAAM,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC;AAC/B,CAAC;AAED,SAAS,UAAU,CAAC,SAAkB,EAAE,OAAgC;IACvE,IAAI,CAAC,SAAS,EAAE;QACf,YAAY,CAAC,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;KAChE;AACF,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAC/B,YAA4B,EAC5B,OAAuB,EACvB,IAA+B;IAE/B,8BAA8B;IAC9B,MAAM,YAAY,GAAG,eAAe,CAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IAE5D,MAAM,aAAa,GAAyB,EAAE,CAAC;IAC/C,KAAK,MAAM,OAAO,IAAI,YAAY,EAAE;QACnC,IAAI,wBAAwB,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE;YAC5C,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;SAC5B;KACD;IACD,OAAO,aAAa,CAAC;AACtB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,wBAAwB,CAChC,MAA0B,EAC1B,IAA+B;IAE/B,MAAM,CACL,IAAI,KAAK,SAAS,EAClB,KAAK,CAAC,0FAA0F,CAChG,CAAC;IACF,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE;QACtB,OAAO,MAAM,YAAY,cAAc,IAAI,WAAW,CAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;KAC/E;IACD,IAAI,MAAM,YAAY,cAAc,EAAE;QACrC,OAAO,KAAK,CAAC;KACb;IACD,IAAI,cAAc,IAAI,IAAI,EAAE;QAC3B,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,MAAM,CAAC,IAAI,CAAC;KAC5C;IACD,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE;QAC1B,IAAI,MAAM,YAAY,mBAAmB,EAAE;YAC1C,MAAM,KAAK,GAAG,MAAM,CAAC,cAAc,EAAE,CAAC;YACtC,OAAO,KAAK,CAAC,IAAI,CAAC,YAAY,KAAK,YAAY,CAAC,QAAQ,CAAC;SACzD;aAAM;YACN,OAAO,KAAK,CAAC;SACb;KACD;IACD,IAAI,IAAI,YAAY,GAAG,EAAE;QACxB,OAAO,MAAM,YAAY,iBAAiB,CAAC;KAC3C;IAED,yEAAyE;IACzE,oHAAoH;IAEpH,OAAO,IAAI,CAAC;AACb,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IFluidHandle } from \"@fluidframework/core-interfaces\";\nimport { assert } from \"@fluidframework/core-utils\";\nimport { UsageError } from \"@fluidframework/telemetry-utils\";\n\nimport { EmptyKey, type FieldKey, type MapTree } from \"../core/index.js\";\n// Drilling into `domains` to reduce the magnitude of cycles introduced here\n// eslint-disable-next-line import/no-internal-modules\nimport { leaf } from \"../domains/leafDomain.js\";\nimport {\n\tallowsValue,\n\tcursorForMapTreeField,\n\tcursorForMapTreeNode,\n\ttype CursorWithNode,\n\tisFluidHandle,\n\tMultiplicity,\n\ttype FlexTreeNodeSchema,\n\tFlexTreeSchema,\n\ttype AllowedTypeSet,\n\tFlexFieldSchema,\n\tAny,\n\tFlexFieldNodeSchema,\n\tisTreeValue,\n\tLeafNodeSchema,\n\tFlexMapNodeSchema,\n\tgetAllowedTypes,\n\ttypeNameSymbol,\n} from \"../feature-libraries/index.js\";\nimport { brand, isReadonlyArray } from \"../util/index.js\";\nimport { InsertableContent } from \"./proxies.js\";\n\n/**\n * Module notes:\n *\n * The flow of the below code is in terms of the structure of the input data. We then verify that the associated\n * schema is appropriate for that kind of data. This is fine while we have a 1:1 mapping of kind of input data to\n * the kind of schema we expect for it (e.g. an input that is an array always need to be associated with a sequence in\n * the schema). If/when we begin accepting kinds of input data that are ambiguous (e.g. accepting an input that is an\n * array of key/value tuples to instantiate a map) we may need to rethink the structure here to be based more on the\n * schema than on the input data.\n */\n\n/**\n * Transforms an input {@link TypedNode} tree to a {@link MapTree}, and wraps the tree in a {@link CursorWithNode}.\n * @param data - The input tree to be converted.\n * @param globalSchema - Schema for the whole tree for interperting `Any`.\n * @param typeSet - The set of types allowed by the parent context. Used to validate the input tree.\n *\n * @returns A cursor (in nodes mode) for the mapped tree if the input data was defined. Otherwise, returns `undefined`.\n */\nexport function cursorFromNodeData(\n\tdata: InsertableContent,\n\tglobalSchema: FlexTreeSchema,\n\ttypeSet: AllowedTypeSet,\n): CursorWithNode<MapTree> | undefined {\n\tif (data === undefined) {\n\t\treturn undefined;\n\t}\n\tconst mappedContent = nodeDataToMapTree(data, globalSchema, typeSet);\n\treturn cursorForMapTreeNode(mappedContent);\n}\n\ntype InsertableTreeField = InsertableContent | undefined | InsertableContent[];\n\n/**\n * Transforms an input {@link TreeField} tree to an array of {@link MapTree}s, and wraps the tree in a {@link CursorWithNode}.\n * @param data - The input tree to be converted.\n * @param globalSchema - Schema for the whole tree for interperting `Any`.\n */\nexport function cursorFromFieldData(\n\tdata: InsertableTreeField,\n\tglobalSchema: FlexTreeSchema,\n\tfieldSchema: FlexFieldSchema,\n): CursorWithNode<MapTree> {\n\tconst mappedContent = fieldDataToMapTrees(data, globalSchema, fieldSchema);\n\treturn cursorForMapTreeField(mappedContent);\n}\n\n/**\n * Transforms an input {@link TypedNode} tree to a {@link MapTree}.\n * @param data - The input tree to be converted.\n * If the data is an unsupported value (e.g. NaN), a fallback value will be used when supported,\n * otherwise an error will be thrown.\n *\n * Fallbacks:\n *\n * * `NaN` =\\> `null`\n *\n * * `+/-∞` =\\> `null`\n *\n * * `-0` =\\> `+0`\n *\n * @param globalSchema - Schema for the whole tree for interperting `Any`.\n * @param typeSet - The set of types allowed by the parent context. Used to validate the input tree.\n */\nexport function nodeDataToMapTree(\n\tdata: InsertableContent,\n\tglobalSchema: FlexTreeSchema,\n\ttypeSet: AllowedTypeSet,\n): MapTree {\n\tassert(data !== undefined, 0x846 /* Cannot map undefined tree. */);\n\n\tif (data === null) {\n\t\treturn valueToMapTree(data, globalSchema, typeSet);\n\t}\n\tswitch (typeof data) {\n\t\tcase \"number\":\n\t\tcase \"string\":\n\t\tcase \"boolean\":\n\t\t\treturn valueToMapTree(data, globalSchema, typeSet);\n\t\tdefault: {\n\t\t\tif (isFluidHandle(data)) {\n\t\t\t\treturn valueToMapTree(data, globalSchema, typeSet);\n\t\t\t} else if (Array.isArray(data)) {\n\t\t\t\treturn arrayToMapTree(data, globalSchema, typeSet);\n\t\t\t} else if (data instanceof Map) {\n\t\t\t\treturn mapToMapTree(data, globalSchema, typeSet);\n\t\t\t} else {\n\t\t\t\t// Assume record-like object\n\t\t\t\treturn recordToMapTree(\n\t\t\t\t\tdata as Record<string, InsertableContent>,\n\t\t\t\t\tglobalSchema,\n\t\t\t\t\ttypeSet,\n\t\t\t\t);\n\t\t\t}\n\t\t}\n\t}\n}\n\n/**\n * Transforms an input {@link TreeField} tree to an array of {@link MapTree}s.\n * @param data - The input tree to be converted.\n * If the input is a sequence containing 1 or more `undefined` values, those values will be mapped as `null` if supported.\n * Othewise, an error will be thrown.\n * @param globalSchema - Schema for the whole tree. Used to select the valid types when encountering `any`.\n */\nexport function fieldDataToMapTrees(\n\tdata: InsertableTreeField,\n\tglobalSchema: FlexTreeSchema,\n\tfieldSchema: FlexFieldSchema,\n): MapTree[] {\n\tconst multiplicity = fieldSchema.kind.multiplicity;\n\tif (data === undefined) {\n\t\tassert(\n\t\t\tmultiplicity === Multiplicity.Forbidden || multiplicity === Multiplicity.Optional,\n\t\t\t0x847 /* `undefined` provided for a field that does not support `undefined` */,\n\t\t);\n\t\treturn [];\n\t}\n\n\tconst typeSet = fieldSchema.allowedTypeSet;\n\n\tif (multiplicity === Multiplicity.Sequence) {\n\t\tassert(Array.isArray(data), 0x848 /* Expected an array as sequence input. */);\n\t\tconst children = Array.from(data, (child) => {\n\t\t\t// We do not support undefined sequence entries.\n\t\t\t// If we encounter an undefined entry, use null instead if supported by the schema, otherwise throw.\n\t\t\tlet childWithFallback = child;\n\t\t\tif (child === undefined) {\n\t\t\t\tif (typeSet === Any || typeSet.has(leaf.null)) {\n\t\t\t\t\tchildWithFallback = null;\n\t\t\t\t} else {\n\t\t\t\t\tthrow new TypeError(`Received unsupported array entry value: ${child}.`);\n\t\t\t\t}\n\t\t\t}\n\t\t\treturn nodeDataToMapTree(childWithFallback, globalSchema, typeSet);\n\t\t});\n\t\treturn children;\n\t}\n\tassert(\n\t\tmultiplicity === Multiplicity.Single || multiplicity === Multiplicity.Optional,\n\t\t0x849 /* A single value was provided for an unsupported field */,\n\t);\n\treturn [nodeDataToMapTree(data, globalSchema, typeSet)];\n}\n\nfunction valueToMapTree(\n\t// eslint-disable-next-line @rushstack/no-new-null\n\tvalue: boolean | number | string | IFluidHandle | null,\n\tglobalSchema: FlexTreeSchema,\n\ttypeSet: AllowedTypeSet,\n): MapTree {\n\tconst mappedValue = mapValueWithFallbacks(value, typeSet);\n\n\tconst schema = getType(mappedValue, globalSchema, typeSet);\n\tassert(\n\t\tschema instanceof LeafNodeSchema && allowsValue(schema.leafValue, mappedValue),\n\t\t0x84a /* Unsupported schema for provided primitive. */,\n\t);\n\n\treturn {\n\t\tvalue: mappedValue,\n\t\ttype: schema.name,\n\t\tfields: new Map(),\n\t};\n}\n\n/**\n * Checks an incoming value to ensure it is compatible with our serialization format.\n * For unsupported values with a schema-compatible replacement, return the replacement value.\n * For unsupported values without a schema-compatible replacement, throw.\n * For supported values, return the input.\n */\nfunction mapValueWithFallbacks(\n\t// eslint-disable-next-line @rushstack/no-new-null\n\tvalue: boolean | number | string | IFluidHandle | null,\n\ttypeSet: AllowedTypeSet,\n\t// eslint-disable-next-line @rushstack/no-new-null\n): boolean | number | string | IFluidHandle | null {\n\tswitch (typeof value) {\n\t\tcase \"number\": {\n\t\t\tif (Object.is(value, -0)) {\n\t\t\t\t// Our serialized data format does not support -0.\n\t\t\t\t// Map such input to +0.\n\t\t\t\treturn 0;\n\t\t\t} else if (Number.isNaN(value) || !Number.isFinite(value)) {\n\t\t\t\t// Our serialized data format does not support NaN nor +/-∞.\n\t\t\t\t// If the schema supports `null`, fall back to that. Otherwise, throw.\n\t\t\t\t// This is intended to match JSON's behavior for such values.\n\t\t\t\tif (typeSet === Any || typeSet.has(leaf.null)) {\n\t\t\t\t\treturn null;\n\t\t\t\t} else {\n\t\t\t\t\tthrow new TypeError(`Received unsupported numeric value: ${value}.`);\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\treturn value;\n\t\t\t}\n\t\t}\n\t\tdefault:\n\t\t\treturn value;\n\t}\n}\n\nfunction arrayToMapTree(\n\tdata: InsertableContent[],\n\tglobalSchema: FlexTreeSchema,\n\ttypeSet: AllowedTypeSet,\n): MapTree {\n\tconst schema = getType(data, globalSchema, typeSet);\n\tassert(\n\t\tschema instanceof FlexFieldNodeSchema,\n\t\t0x84b /* Array data reported comparable with the schema without a primary field. */,\n\t);\n\n\tconst mappedChildren = fieldDataToMapTrees(data, globalSchema, schema.info);\n\tconst fieldsEntries: [FieldKey, MapTree[]][] =\n\t\tmappedChildren.length === 0 ? [] : [[EmptyKey, mappedChildren]];\n\n\t// Array node children are represented as a single field entry denoted with `EmptyKey`\n\tconst fields = new Map<FieldKey, MapTree[]>(fieldsEntries);\n\n\treturn {\n\t\ttype: schema.name,\n\t\tfields,\n\t};\n}\n\nfunction mapToMapTree(\n\tdata: Map<string, InsertableContent>,\n\tglobalSchema: FlexTreeSchema,\n\ttypeSet: AllowedTypeSet,\n): MapTree {\n\tconst schema = getType(data, globalSchema, typeSet);\n\n\tconst fields = new Map<FieldKey, MapTree[]>();\n\tfor (const [key, value] of data) {\n\t\tassert(!fields.has(brand(key)), 0x84c /* Keys should not be duplicated */);\n\n\t\t// Omit undefined record entries - an entry with an undefined key is equivalent to no entry\n\t\tif (value !== undefined) {\n\t\t\tconst childSchema = schema.getFieldSchema(brand(key));\n\t\t\tconst mappedField = fieldDataToMapTrees(value, globalSchema, childSchema);\n\t\t\tfields.set(brand(key), mappedField);\n\t\t}\n\t}\n\treturn {\n\t\ttype: schema.name,\n\t\tfields,\n\t};\n}\n\nfunction recordToMapTree(\n\tdata: Record<string | number | symbol, InsertableContent>,\n\tglobalSchema: FlexTreeSchema,\n\ttypeSet: AllowedTypeSet,\n): MapTree {\n\tconst schema = getType(data, globalSchema, typeSet);\n\n\tconst fields = new Map<FieldKey, MapTree[]>();\n\n\t// Filter keys to only those that are strings - our trees do not support symbol or numeric property keys\n\tconst keys = Reflect.ownKeys(data).filter((key) => typeof key === \"string\") as FieldKey[];\n\n\tfor (const key of keys) {\n\t\tassert(!fields.has(key), 0x84d /* Keys should not be duplicated */);\n\t\tconst value = data[key];\n\n\t\t// Omit undefined record entries - an entry with an undefined key is equivalent to no entry\n\t\tif (value !== undefined) {\n\t\t\tconst childSchema = schema.getFieldSchema(key);\n\t\t\tconst mappedChildTree = fieldDataToMapTrees(value, globalSchema, childSchema);\n\t\t\tfields.set(brand(key), mappedChildTree);\n\t\t}\n\t}\n\n\treturn {\n\t\ttype: schema.name,\n\t\tfields,\n\t};\n}\n\nfunction getType(\n\tdata: InsertableContent,\n\tglobalSchema: FlexTreeSchema,\n\ttypeSet: AllowedTypeSet,\n): FlexTreeNodeSchema {\n\tconst possibleTypes = getPossibleTypes(\n\t\tglobalSchema,\n\t\ttypeSet,\n\t\tdata as ContextuallyTypedNodeData,\n\t);\n\tassert(\n\t\tpossibleTypes.length !== 0,\n\t\t0x84e /* data is incompatible with all types allowed by the schema */,\n\t);\n\tcheckInput(\n\t\tpossibleTypes.length === 1,\n\t\t() =>\n\t\t\t`The provided data is compatible with more than one type allowed by the schema.\nThe set of possible types is ${JSON.stringify([...possibleTypes.map((n) => n.name)], undefined)}.\nExplicitly construct an unhydrated node of the desired type to disambiguate.\nFor class-based schema, this can be done by replacing an expression like \"{foo: 1}\" with \"new MySchema({foo: 1})\".`,\n\t);\n\treturn possibleTypes[0];\n}\n\n/**\n * An invalid tree has been provided, presumably by the user of this package.\n * Throw and an error that properly preserves the message (unlike asserts which will get hard to read short codes intended for package internal logic errors).\n */\nfunction invalidInput(message: string): never {\n\tthrow new UsageError(message);\n}\n\nfunction checkInput(condition: boolean, message: string | (() => string)): asserts condition {\n\tif (!condition) {\n\t\tinvalidInput(typeof message === \"string\" ? message : message());\n\t}\n}\n\n/**\n * @returns all types for which the data is schema-compatible.\n */\nexport function getPossibleTypes(\n\tglobalSchema: FlexTreeSchema,\n\ttypeSet: AllowedTypeSet,\n\tdata: ContextuallyTypedNodeData,\n) {\n\t// All types allowed by schema\n\tconst allowedTypes = getAllowedTypes(globalSchema, typeSet);\n\n\tconst possibleTypes: FlexTreeNodeSchema[] = [];\n\tfor (const allowed of allowedTypes) {\n\t\tif (shallowCompatibilityTest(allowed, data)) {\n\t\t\tpossibleTypes.push(allowed);\n\t\t}\n\t}\n\treturn possibleTypes;\n}\n\n/**\n * Checks if data might be schema-compatible.\n *\n * @returns false if `data` is incompatible with `type` based on a cheap/shallow check.\n *\n * Note that this may return true for cases where data is incompatible, but it must not return false in cases where the data is compatible.\n */\nfunction shallowCompatibilityTest(\n\tschema: FlexTreeNodeSchema,\n\tdata: ContextuallyTypedNodeData,\n): boolean {\n\tassert(\n\t\tdata !== undefined,\n\t\t0x889 /* undefined cannot be used as contextually typed data. Use ContextuallyTypedFieldData. */,\n\t);\n\tif (isTreeValue(data)) {\n\t\treturn schema instanceof LeafNodeSchema && allowsValue(schema.leafValue, data);\n\t}\n\tif (schema instanceof LeafNodeSchema) {\n\t\treturn false;\n\t}\n\tif (typeNameSymbol in data) {\n\t\treturn data[typeNameSymbol] === schema.name;\n\t}\n\tif (isReadonlyArray(data)) {\n\t\tif (schema instanceof FlexFieldNodeSchema) {\n\t\t\tconst field = schema.getFieldSchema();\n\t\t\treturn field.kind.multiplicity === Multiplicity.Sequence;\n\t\t} else {\n\t\t\treturn false;\n\t\t}\n\t}\n\tif (data instanceof Map) {\n\t\treturn schema instanceof FlexMapNodeSchema;\n\t}\n\n\t// For now, consider all not explicitly typed objects shallow compatible.\n\t// This will require explicit differentiation in polymorphic cases rather than automatic structural differentiation.\n\n\treturn true;\n}\n\n/**\n * Content of a tree which needs external schema information to interpret.\n *\n * This format is intended for concise authoring of tree literals when the schema is statically known.\n *\n * Once schema aware APIs are implemented, they can be used to provide schema specific subsets of this type.\n */\nexport type ContextuallyTypedNodeData =\n\t| ContextuallyTypedNodeDataObject\n\t| number\n\t| string\n\t| boolean\n\t// eslint-disable-next-line @rushstack/no-new-null\n\t| null\n\t| readonly ContextuallyTypedNodeData[];\n\n/**\n * Content of a field which needs external schema information to interpret.\n *\n * This format is intended for concise authoring of tree literals when the schema is statically known.\n *\n * Once schema aware APIs are implemented, they can be used to provide schema specific subsets of this type.\n */\nexport type ContextuallyTypedFieldData = ContextuallyTypedNodeData | undefined;\n\n/**\n * Object case of {@link ContextuallyTypedNodeData}.\n */\nexport interface ContextuallyTypedNodeDataObject {\n\t/**\n\t * The type of the node.\n\t * If this node is well-formed, it must follow this schema.\n\t */\n\treadonly [typeNameSymbol]?: string;\n\n\t/**\n\t * Fields of this node, indexed by their field keys.\n\t *\n\t * Allow explicit undefined for compatibility with EditableTree, and type-safety on read.\n\t */\n\t// TODO: make sure explicit undefined is actually handled correctly.\n\t[key: FieldKey]: ContextuallyTypedFieldData;\n\n\t/**\n\t * Fields of this node, indexed by their field keys as strings.\n\t *\n\t * Allow unbranded field keys as a convenience for literals.\n\t */\n\t[key: string]: ContextuallyTypedFieldData;\n}\n"]}
+{"version":3,"file":"toMapTree.js","sourceRoot":"","sources":["../../src/simple-tree/toMapTree.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAC7D,OAAO,EAAE,UAAU,EAAE,MAAM,0CAA0C,CAAC;AAEtE,OAAO,EACN,QAAQ,GAKR,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAEN,qBAAqB,EACrB,oBAAoB,EACpB,WAAW,EACX,cAAc,EACd,iBAAiB,GACjB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAC;AAEhE,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AAEjD,OAAO,EACN,SAAS,EAIT,QAAQ,EAER,qBAAqB,EACrB,oBAAoB,EACpB,YAAY,GACZ,MAAM,kBAAkB,CAAC;AAE1B;;;;;;;;;GASG;AAEH;;;;;;GAMG;AACH,MAAM,UAAU,kBAAkB,CACjC,IAAuB,EACvB,YAAkC;IAElC,IAAI,IAAI,KAAK,SAAS,EAAE;QACvB,OAAO,SAAS,CAAC;KACjB;IACD,MAAM,aAAa,GAAG,iBAAiB,CAAC,IAAI,EAAE,qBAAqB,CAAC,YAAY,CAAC,CAAC,CAAC;IACnF,OAAO,oBAAoB,CAAC,aAAa,CAAC,CAAC;AAC5C,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,mBAAmB,CAClC,IAAuB,EACvB,MAAmB;IAEnB,MAAM,aAAa,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC;QACxC,CAAC,CAAC,oBAAoB,CAAC,IAAI,EAAE,MAAM,CAAC,cAAc,CAAC;QACnD,CAAC,CAAC,CAAC,iBAAiB,CAAC,IAAI,EAAE,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC;IACpD,OAAO,qBAAqB,CAAC,aAAa,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,iBAAiB,CAChC,IAAuB,EACvB,YAAyC;IAEzC,MAAM,CAAC,IAAI,KAAK,SAAS,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;IAEnE,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IAE3C,QAAQ,MAAM,CAAC,IAAI,EAAE;QACpB,KAAK,QAAQ,CAAC,IAAI;YACjB,OAAO,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC;QAClD,KAAK,QAAQ,CAAC,KAAK;YAClB,OAAO,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACrC,KAAK,QAAQ,CAAC,GAAG;YAChB,OAAO,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACnC,KAAK,QAAQ,CAAC,MAAM;YACnB,OAAO,eAAe,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACtC;YACC,IAAI,CAAC,6BAA6B,MAAM,CAAC,IAAI,GAAG,CAAC,CAAC;KACnD;AACF,CAAC;AAED;;;;;;GAMG;AACH,SAAS,aAAa,CACrB,IAAuB,EACvB,MAAsB,EACtB,YAAyC;IAEzC,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,6BAA6B,CAAC,CAAC;IAC3E,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE;QACvB,wFAAwF;QACxF,6GAA6G;QAC7G,gEAAgE;QAChE,MAAM,IAAI,UAAU,CAAC,gDAAgD,IAAI,EAAE,CAAC,CAAC;KAC7E;IAED,MAAM,WAAW,GAAG,qBAAqB,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IAC9D,MAAM,YAAY,GAAG,OAAO,CAAC,WAAW,EAAE,YAAY,CAAC,CAAC;IAExD,MAAM,CACL,WAAW,CAAC,YAAY,EAAE,WAAW,CAAC,EACtC,KAAK,CAAC,gDAAgD,CACtD,CAAC;IAEF,OAAO;QACN,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,KAAK,CAAC,YAAY,CAAC,UAAU,CAAC;QACpC,MAAM,EAAE,IAAI,GAAG,EAAE;KACjB,CAAC;AACH,CAAC;AAED;;;;;GAKG;AACH,SAAS,qBAAqB,CAC7B,KAAgB,EAChB,YAAyC;IAEzC,QAAQ,OAAO,KAAK,EAAE;QACrB,KAAK,QAAQ,CAAC,CAAC;YACd,IAAI,MAAM,CAAC,EAAE,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE;gBACzB,kDAAkD;gBAClD,wBAAwB;gBACxB,OAAO,CAAC,CAAC;aACT;iBAAM,IAAI,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE;gBAC1D,4DAA4D;gBAC5D,sEAAsE;gBACtE,6DAA6D;gBAC7D,IAAI,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;oBACjC,OAAO,IAAI,CAAC;iBACZ;qBAAM;oBACN,MAAM,IAAI,SAAS,CAAC,uCAAuC,KAAK,GAAG,CAAC,CAAC;iBACrE;aACD;iBAAM;gBACN,OAAO,KAAK,CAAC;aACb;SACD;QACD;YACC,OAAO,KAAK,CAAC;KACd;AACF,CAAC;AAED,SAAS,oBAAoB,CAC5B,IAAkC,EAClC,YAAyC;IAEzC,MAAM,UAAU,GAAc,EAAE,CAAC;IACjC,KAAK,MAAM,KAAK,IAAI,IAAI,EAAE;QACzB,gDAAgD;QAChD,oGAAoG;QACpG,IAAI,iBAAiB,GAAG,KAAK,CAAC;QAC9B,IAAI,KAAK,KAAK,SAAS,EAAE;YACxB,IAAI,YAAY,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE;gBACjC,iBAAiB,GAAG,IAAI,CAAC;aACzB;iBAAM;gBACN,MAAM,IAAI,SAAS,CAAC,2CAA2C,KAAK,GAAG,CAAC,CAAC;aACzE;SACD;QACD,MAAM,WAAW,GAAG,iBAAiB,CAAC,iBAAiB,EAAE,YAAY,CAAC,CAAC;QACvE,UAAU,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;KAC7B;IAED,OAAO,UAAU,CAAC;AACnB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,cAAc,CAAC,IAAuB,EAAE,MAAsB;IACtE,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,+BAA+B,CAAC,CAAC;IAC9E,IAAI,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE;QAC3B,MAAM,IAAI,UAAU,CAAC,iDAAiD,IAAI,EAAE,CAAC,CAAC;KAC9E;IAED,MAAM,iBAAiB,GAAG,qBAAqB,CAAC,MAAM,CAAC,IAA4B,CAAC,CAAC;IAErF,MAAM,UAAU,GAAG,oBAAoB,CAAC,IAAI,EAAE,iBAAiB,CAAC,CAAC;IAEjE,sFAAsF;IACtF,MAAM,aAAa,GAClB,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;IACzD,MAAM,MAAM,GAAG,IAAI,GAAG,CAAsB,aAAa,CAAC,CAAC;IAE3D,OAAO;QACN,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC;QAC9B,MAAM;KACN,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,SAAS,YAAY,CAAC,IAAuB,EAAE,MAAsB;IACpE,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAC;IACzE,IAAI,CAAC,CAAC,IAAI,YAAY,GAAG,CAAC,EAAE;QAC3B,MAAM,IAAI,UAAU,CAAC,+CAA+C,IAAI,EAAE,CAAC,CAAC;KAC5E;IAED,MAAM,iBAAiB,GAAG,qBAAqB,CAAC,MAAM,CAAC,IAA4B,CAAC,CAAC;IAErF,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAAuB,CAAC;IACzD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,IAAI,EAAE;QAChC,MAAM,CAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;QAEtF,iHAAiH;QACjH,IAAI,KAAK,KAAK,SAAS,EAAE;YACxB,MAAM,WAAW,GAAG,iBAAiB,CAAC,KAAK,EAAE,iBAAiB,CAAC,CAAC;YAChE,iBAAiB,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;SACjD;KACD;IAED,OAAO;QACN,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC;QAC9B,MAAM,EAAE,iBAAiB;KACzB,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,SAAS,eAAe,CAAC,IAAuB,EAAE,MAAsB;IACvE,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;IAChF,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,EAAE;QAC9C,MAAM,IAAI,UAAU,CAAC,kDAAkD,IAAI,EAAE,CAAC,CAAC;KAC/E;IAED,MAAM,MAAM,GAAG,IAAI,GAAG,EAAuB,CAAC;IAE9C,wGAAwG;IACxG,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,CAAe,CAAC;IAE1F,KAAK,MAAM,OAAO,IAAI,IAAI,EAAE;QAC3B,MAAM,UAAU,GAAI,IAA4C,CAAC,OAAO,CAAC,CAAC;QAE1E,2FAA2F;QAC3F,IAAI,UAAU,KAAK,SAAS,EAAE;YAC7B,MAAM,WAAW,GAAG,oBAAoB,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;YAC1D,MAAM,eAAe,GAAG,iBAAiB,CAAC,UAAU,EAAE,WAAW,CAAC,cAAc,CAAC,CAAC;YAClF,MAAM,OAAO,GAAa,KAAK,CAAC,YAAY,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC;YAEpE,0FAA0F;YAC1F,6EAA6E;YAC7E,MAAM,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,iCAAiC,CAAC,CAAC;YACtE,MAAM,CAAC,GAAG,CAAC,OAAO,EAAE,CAAC,eAAe,CAAC,CAAC,CAAC;SACvC;KACD;IAED,OAAO;QACN,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,UAAU,CAAC;QAC9B,MAAM;KACN,CAAC;AACH,CAAC;AAED,SAAS,oBAAoB,CAAC,MAAsB,EAAE,GAAa;IAClE,MAAM,CAAC,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;IAChF,MAAM,MAAM,GAAG,MAAM,CAAC,IAA2C,CAAC;IAClE,IAAI,MAAM,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE;QAC9B,IAAI,CAAC,UAAU,GAAG,0BAA0B,MAAM,CAAC,UAAU,IAAI,CAAC,CAAC;KACnE;SAAM;QACN,OAAO,oBAAoB,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;KACzC;AACF,CAAC;AAED,SAAS,OAAO,CACf,IAAuB,EACvB,YAAyC;IAEzC,MAAM,aAAa,GAAG,gBAAgB,CAAC,YAAY,EAAE,IAAiC,CAAC,CAAC;IACxF,IAAI,aAAa,CAAC,MAAM,KAAK,CAAC,EAAE;QAC/B,MAAM,IAAI,UAAU,CACnB,+GAA+G,IAAI,CAAC,SAAS,CAC5H,CAAC,GAAG,YAAY,CAAC,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC,CACpD,GAAG,CACJ,CAAC;KACF;IACD,MAAM,CACL,aAAa,CAAC,MAAM,KAAK,CAAC,EAC1B,KAAK,CAAC,+DAA+D,CACrE,CAAC;IACF,UAAU,CACT,aAAa,CAAC,MAAM,KAAK,CAAC,EAC1B,GAAG,EAAE,CACJ;+BAC4B,IAAI,CAAC,SAAS,CAAC;QAC1C,GAAG,aAAa,CAAC,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,UAAU,CAAC;KACnD,CAAC;;mHAE8G,CACjH,CAAC;IACF,OAAO,aAAa,CAAC,CAAC,CAAC,CAAC;AACzB,CAAC;AAED;;;GAGG;AACH,SAAS,YAAY,CAAC,OAAe;IACpC,MAAM,IAAI,UAAU,CAAC,OAAO,CAAC,CAAC;AAC/B,CAAC;AAED,SAAS,UAAU,CAAC,SAAkB,EAAE,OAAgC;IACvE,IAAI,CAAC,SAAS,EAAE;QACf,YAAY,CAAC,OAAO,OAAO,KAAK,QAAQ,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;KAChE;AACF,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,gBAAgB,CAC/B,YAAyC,EACzC,IAA+B;IAE/B,MAAM,aAAa,GAAqB,EAAE,CAAC;IAC3C,KAAK,MAAM,MAAM,IAAI,YAAY,EAAE;QAClC,IAAI,wBAAwB,CAAC,MAAM,EAAE,IAAI,CAAC,EAAE;YAC3C,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;SAC3B;KACD;IACD,OAAO,aAAa,CAAC;AACtB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,wBAAwB,CAChC,MAAsB,EACtB,IAA+B;IAE/B,MAAM,CACL,IAAI,KAAK,SAAS,EAClB,KAAK,CAAC,0FAA0F,CAChG,CAAC;IAEF,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE;QACtB,OAAO,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;KACjC;IACD,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,EAAE;QAClC,OAAO,KAAK,CAAC;KACb;IAED,IAAI,cAAc,IAAI,IAAI,EAAE;QAC3B,OAAO,IAAI,CAAC,cAAc,CAAC,KAAK,MAAM,CAAC,UAAU,CAAC;KAClD;IAED,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE;QAC1B,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,KAAK,CAAC;KACtC;IACD,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,KAAK,EAAE;QACnC,OAAO,KAAK,CAAC;KACb;IAED,IAAI,IAAI,YAAY,GAAG,EAAE;QACxB,OAAO,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,GAAG,CAAC;KACpC;IACD,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,GAAG,EAAE;QACjC,OAAO,KAAK,CAAC;KACb;IAED,4BAA4B;IAC5B,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,MAAM,EAAE;QACpC,OAAO,KAAK,CAAC;KACb;IAED,MAAM,MAAM,GAAG,MAAM,CAAC,IAA2C,CAAC;IAElE,oFAAoF;IACpF,gFAAgF;IAChF,+FAA+F;IAC/F,8IAA8I;IAE9I,qIAAqI;IAErI,wFAAwF;IACxF,KAAK,MAAM,CAAC,QAAQ,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QAC7D,MAAM,qBAAqB,GAAG,oBAAoB,CAAC,WAAW,CAAC,CAAC;QAChE,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,SAAS,IAAI,qBAAqB,CAAC,IAAI,KAAK,SAAS,CAAC,QAAQ,EAAE;YACtF,OAAO,KAAK,CAAC;SACb;KACD;IAED,OAAO,IAAI,CAAC;AACb,CAAC;AAED,SAAS,WAAW,CAAC,MAAsB,EAAE,KAAgB;IAC5D,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,EAAE;QAClC,OAAO,iBAAiB,CAAC,MAAM,CAAC,IAAmB,EAAE,KAAK,CAAC,CAAC;KAC5D;IACD,OAAO,KAAK,CAAC;AACd,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport { UsageError } from \"@fluidframework/telemetry-utils/internal\";\n\nimport {\n\tEmptyKey,\n\ttype FieldKey,\n\ttype MapTree,\n\ttype TreeValue,\n\tValueSchema,\n} from \"../core/index.js\";\nimport {\n\ttype CursorWithNode,\n\tcursorForMapTreeField,\n\tcursorForMapTreeNode,\n\tisTreeValue,\n\ttypeNameSymbol,\n\tvalueSchemaAllows,\n} from \"../feature-libraries/index.js\";\nimport { brand, fail, isReadonlyArray } from \"../util/index.js\";\n\nimport { nullSchema } from \"./leafNodeSchema.js\";\nimport { InsertableContent } from \"./proxies.js\";\nimport {\n\tFieldKind,\n\tFieldSchema,\n\ttype ImplicitAllowedTypes,\n\ttype ImplicitFieldSchema,\n\tNodeKind,\n\ttype TreeNodeSchema,\n\tnormalizeAllowedTypes,\n\tnormalizeFieldSchema,\n\tgetStoredKey,\n} from \"./schemaTypes.js\";\n\n/**\n * Module notes:\n *\n * The flow of the below code is in terms of the structure of the input data. We then verify that the associated\n * schema is appropriate for that kind of data. This is fine while we have a 1:1 mapping of kind of input data to\n * the kind of schema we expect for it (e.g. an input that is an array always need to be associated with a sequence in\n * the schema). If/when we begin accepting kinds of input data that are ambiguous (e.g. accepting an input that is an\n * array of key/value tuples to instantiate a map) we may need to rethink the structure here to be based more on the\n * schema than on the input data.\n */\n\n/**\n * Transforms an input {@link TypedNode} tree to a {@link MapTree}, and wraps the tree in a {@link CursorWithNode}.\n * @param data - The input tree to be converted.\n * @param allowedTypes - The set of types allowed by the parent context. Used to validate the input tree.\n *\n * @returns A cursor (in nodes mode) for the mapped tree if the input data was defined. Otherwise, returns `undefined`.\n */\nexport function cursorFromNodeData(\n\tdata: InsertableContent,\n\tallowedTypes: ImplicitAllowedTypes,\n): CursorWithNode<MapTree> | undefined {\n\tif (data === undefined) {\n\t\treturn undefined;\n\t}\n\tconst mappedContent = nodeDataToMapTree(data, normalizeAllowedTypes(allowedTypes));\n\treturn cursorForMapTreeNode(mappedContent);\n}\n\n/**\n * Transforms an input {@link InsertableContent} tree to an array of {@link MapTree}s, and wraps the tree in a {@link CursorWithNode}.\n * @param data - The input tree to be converted.\n * @param schema - Schema of the field with which the input `data` is associated.\n */\nexport function cursorFromFieldData(\n\tdata: InsertableContent,\n\tschema: FieldSchema,\n): CursorWithNode<MapTree> {\n\tconst mappedContent = Array.isArray(data)\n\t\t? arrayToMapTreeFields(data, schema.allowedTypeSet)\n\t\t: [nodeDataToMapTree(data, schema.allowedTypeSet)];\n\treturn cursorForMapTreeField(mappedContent);\n}\n\n/**\n * Transforms an input {@link TypedNode} tree to a {@link MapTree}.\n * @param data - The input tree to be converted.\n * If the data is an unsupported value (e.g. NaN), a fallback value will be used when supported,\n * otherwise an error will be thrown.\n *\n * Fallbacks:\n *\n * * `NaN` =\\> `null`\n *\n * * `+/-∞` =\\> `null`\n *\n * * `-0` =\\> `+0`\n *\n * @param data - The tree data being transformed.\n * @param allowedTypes - The set of types allowed by the parent context. Used to validate the input tree.\n */\nexport function nodeDataToMapTree(\n\tdata: InsertableContent,\n\tallowedTypes: ReadonlySet<TreeNodeSchema>,\n): MapTree {\n\tassert(data !== undefined, 0x846 /* Cannot map undefined tree. */);\n\n\tconst schema = getType(data, allowedTypes);\n\n\tswitch (schema.kind) {\n\t\tcase NodeKind.Leaf:\n\t\t\treturn leafToMapTree(data, schema, allowedTypes);\n\t\tcase NodeKind.Array:\n\t\t\treturn arrayToMapTree(data, schema);\n\t\tcase NodeKind.Map:\n\t\t\treturn mapToMapTree(data, schema);\n\t\tcase NodeKind.Object:\n\t\t\treturn objectToMapTree(data, schema);\n\t\tdefault:\n\t\t\tfail(`Unrecognized schema kind: ${schema.kind}.`);\n\t}\n}\n\n/**\n * Transforms data under a Leaf schema.\n * @param data - The tree data to be transformed. Must be a {@link TreeValue}.\n * @param schema - The schema associated with the value.\n * @param allowedTypes - The allowed types specified by the parent.\n * Used to determine which fallback values may be appropriate.\n */\nfunction leafToMapTree(\n\tdata: InsertableContent,\n\tschema: TreeNodeSchema,\n\tallowedTypes: ReadonlySet<TreeNodeSchema>,\n): MapTree {\n\tassert(schema.kind === NodeKind.Leaf, 0x921 /* Expected a leaf schema. */);\n\tif (!isTreeValue(data)) {\n\t\t// This rule exists to protect against useless `toString` output like `[object Object]`.\n\t\t// In this case, that's actually reasonable behavior, since object input is not compatible with Leaf schemas.\n\t\t// eslint-disable-next-line @typescript-eslint/no-base-to-string\n\t\tthrow new UsageError(`Input data is incompatible with leaf schema: ${data}`);\n\t}\n\n\tconst mappedValue = mapValueWithFallbacks(data, allowedTypes);\n\tconst mappedSchema = getType(mappedValue, allowedTypes);\n\n\tassert(\n\t\tallowsValue(mappedSchema, mappedValue),\n\t\t0x84a /* Unsupported schema for provided primitive. */,\n\t);\n\n\treturn {\n\t\tvalue: mappedValue,\n\t\ttype: brand(mappedSchema.identifier),\n\t\tfields: new Map(),\n\t};\n}\n\n/**\n * Checks an incoming value to ensure it is compatible with our serialization format.\n * For unsupported values with a schema-compatible replacement, return the replacement value.\n * For unsupported values without a schema-compatible replacement, throw.\n * For supported values, return the input.\n */\nfunction mapValueWithFallbacks(\n\tvalue: TreeValue,\n\tallowedTypes: ReadonlySet<TreeNodeSchema>,\n): TreeValue {\n\tswitch (typeof value) {\n\t\tcase \"number\": {\n\t\t\tif (Object.is(value, -0)) {\n\t\t\t\t// Our serialized data format does not support -0.\n\t\t\t\t// Map such input to +0.\n\t\t\t\treturn 0;\n\t\t\t} else if (Number.isNaN(value) || !Number.isFinite(value)) {\n\t\t\t\t// Our serialized data format does not support NaN nor +/-∞.\n\t\t\t\t// If the schema supports `null`, fall back to that. Otherwise, throw.\n\t\t\t\t// This is intended to match JSON's behavior for such values.\n\t\t\t\tif (allowedTypes.has(nullSchema)) {\n\t\t\t\t\treturn null;\n\t\t\t\t} else {\n\t\t\t\t\tthrow new TypeError(`Received unsupported numeric value: ${value}.`);\n\t\t\t\t}\n\t\t\t} else {\n\t\t\t\treturn value;\n\t\t\t}\n\t\t}\n\t\tdefault:\n\t\t\treturn value;\n\t}\n}\n\nfunction arrayToMapTreeFields(\n\tdata: readonly InsertableContent[],\n\tallowedTypes: ReadonlySet<TreeNodeSchema>,\n): MapTree[] {\n\tconst mappedData: MapTree[] = [];\n\tfor (const child of data) {\n\t\t// We do not support undefined sequence entries.\n\t\t// If we encounter an undefined entry, use null instead if supported by the schema, otherwise throw.\n\t\tlet childWithFallback = child;\n\t\tif (child === undefined) {\n\t\t\tif (allowedTypes.has(nullSchema)) {\n\t\t\t\tchildWithFallback = null;\n\t\t\t} else {\n\t\t\t\tthrow new TypeError(`Received unsupported array entry value: ${child}.`);\n\t\t\t}\n\t\t}\n\t\tconst mappedChild = nodeDataToMapTree(childWithFallback, allowedTypes);\n\t\tmappedData.push(mappedChild);\n\t}\n\n\treturn mappedData;\n}\n\n/**\n * Transforms data under an Array schema.\n * @param data - The tree data to be transformed. Must be an array.\n * @param schema - The schema associated with the value.\n * @param allowedTypes - The allowed types specified by the parent.\n * Used to determine which fallback values may be appropriate.\n */\nfunction arrayToMapTree(data: InsertableContent, schema: TreeNodeSchema): MapTree {\n\tassert(schema.kind === NodeKind.Array, 0x922 /* Expected an array schema. */);\n\tif (!isReadonlyArray(data)) {\n\t\tthrow new UsageError(`Input data is incompatible with Array schema: ${data}`);\n\t}\n\n\tconst allowedChildTypes = normalizeAllowedTypes(schema.info as ImplicitAllowedTypes);\n\n\tconst mappedData = arrayToMapTreeFields(data, allowedChildTypes);\n\n\t// Array node children are represented as a single field entry denoted with `EmptyKey`\n\tconst fieldsEntries: [FieldKey, MapTree[]][] =\n\t\tmappedData.length === 0 ? [] : [[EmptyKey, mappedData]];\n\tconst fields = new Map<FieldKey, MapTree[]>(fieldsEntries);\n\n\treturn {\n\t\ttype: brand(schema.identifier),\n\t\tfields,\n\t};\n}\n\n/**\n * Transforms data under a Map schema.\n * @param data - The tree data to be transformed. Must be a TypeScript Map.\n * @param schema - The schema associated with the value.\n * @param allowedTypes - The allowed types specified by the parent.\n * Used to determine which fallback values may be appropriate.\n */\nfunction mapToMapTree(data: InsertableContent, schema: TreeNodeSchema): MapTree {\n\tassert(schema.kind === NodeKind.Map, 0x923 /* Expected a Map schema. */);\n\tif (!(data instanceof Map)) {\n\t\tthrow new UsageError(`Input data is incompatible with Map schema: ${data}`);\n\t}\n\n\tconst allowedChildTypes = normalizeAllowedTypes(schema.info as ImplicitAllowedTypes);\n\n\tconst transformedFields = new Map<FieldKey, MapTree[]>();\n\tfor (const [key, value] of data) {\n\t\tassert(!transformedFields.has(brand(key)), 0x84c /* Keys should not be duplicated */);\n\n\t\t// Omit undefined values - an entry with an undefined value is equivalent to one that has been removed or omitted\n\t\tif (value !== undefined) {\n\t\t\tconst mappedField = nodeDataToMapTree(value, allowedChildTypes);\n\t\t\ttransformedFields.set(brand(key), [mappedField]);\n\t\t}\n\t}\n\n\treturn {\n\t\ttype: brand(schema.identifier),\n\t\tfields: transformedFields,\n\t};\n}\n\n/**\n * Transforms data under an Object schema.\n * @param data - The tree data to be transformed. Must be a Record-like object.\n * @param schema - The schema associated with the value.\n * @param allowedTypes - The allowed types specified by the parent.\n * Used to determine which fallback values may be appropriate.\n */\nfunction objectToMapTree(data: InsertableContent, schema: TreeNodeSchema): MapTree {\n\tassert(schema.kind === NodeKind.Object, 0x924 /* Expected an Object schema. */);\n\tif (typeof data !== \"object\" || data === null) {\n\t\tthrow new UsageError(`Input data is incompatible with Object schema: ${data}`);\n\t}\n\n\tconst fields = new Map<FieldKey, MapTree[]>();\n\n\t// Filter keys to only those that are strings - our trees do not support symbol or numeric property keys\n\tconst keys = Reflect.ownKeys(data).filter((key) => typeof key === \"string\") as FieldKey[];\n\n\tfor (const viewKey of keys) {\n\t\tconst fieldValue = (data as Record<FieldKey, InsertableContent>)[viewKey];\n\n\t\t// Omit undefined record entries - an entry with an undefined key is equivalent to no entry\n\t\tif (fieldValue !== undefined) {\n\t\t\tconst fieldSchema = getObjectFieldSchema(schema, viewKey);\n\t\t\tconst mappedChildTree = nodeDataToMapTree(fieldValue, fieldSchema.allowedTypeSet);\n\t\t\tconst flexKey: FieldKey = brand(getStoredKey(viewKey, fieldSchema));\n\n\t\t\t// Note: SchemaFactory validates this at schema creation time, with a user-friendly error.\n\t\t\t// So we don't expect to hit this, and if we do it is likely an internal bug.\n\t\t\tassert(!fields.has(flexKey), 0x925 /* Keys must not be duplicated */);\n\t\t\tfields.set(flexKey, [mappedChildTree]);\n\t\t}\n\t}\n\n\treturn {\n\t\ttype: brand(schema.identifier),\n\t\tfields,\n\t};\n}\n\nfunction getObjectFieldSchema(schema: TreeNodeSchema, key: FieldKey): FieldSchema {\n\tassert(schema.kind === NodeKind.Object, 0x926 /* Expected an Object schema. */);\n\tconst fields = schema.info as Record<string, ImplicitFieldSchema>;\n\tif (fields[key] === undefined) {\n\t\tfail(`Field \"${key}\" not found in schema \"${schema.identifier}\".`);\n\t} else {\n\t\treturn normalizeFieldSchema(fields[key]);\n\t}\n}\n\nfunction getType(\n\tdata: InsertableContent,\n\tallowedTypes: ReadonlySet<TreeNodeSchema>,\n): TreeNodeSchema {\n\tconst possibleTypes = getPossibleTypes(allowedTypes, data as ContextuallyTypedNodeData);\n\tif (possibleTypes.length === 0) {\n\t\tthrow new UsageError(\n\t\t\t`The provided data is incompatible with all of the types allowed by the schema. The set of allowed types is: ${JSON.stringify(\n\t\t\t\t[...allowedTypes].map((schema) => schema.identifier),\n\t\t\t)}.`,\n\t\t);\n\t}\n\tassert(\n\t\tpossibleTypes.length !== 0,\n\t\t0x84e /* data is incompatible with all types allowed by the schema */,\n\t);\n\tcheckInput(\n\t\tpossibleTypes.length === 1,\n\t\t() =>\n\t\t\t`The provided data is compatible with more than one type allowed by the schema.\nThe set of possible types is ${JSON.stringify([\n\t\t\t\t...possibleTypes.map((schema) => schema.identifier),\n\t\t\t])}.\nExplicitly construct an unhydrated node of the desired type to disambiguate.\nFor class-based schema, this can be done by replacing an expression like \"{foo: 1}\" with \"new MySchema({foo: 1})\".`,\n\t);\n\treturn possibleTypes[0];\n}\n\n/**\n * An invalid tree has been provided, presumably by the user of this package.\n * Throw and an error that properly preserves the message (unlike asserts which will get hard to read short codes intended for package internal logic errors).\n */\nfunction invalidInput(message: string): never {\n\tthrow new UsageError(message);\n}\n\nfunction checkInput(condition: boolean, message: string | (() => string)): asserts condition {\n\tif (!condition) {\n\t\tinvalidInput(typeof message === \"string\" ? message : message());\n\t}\n}\n\n/**\n * @returns all types for which the data is schema-compatible.\n */\nexport function getPossibleTypes(\n\tallowedTypes: ReadonlySet<TreeNodeSchema>,\n\tdata: ContextuallyTypedNodeData,\n) {\n\tconst possibleTypes: TreeNodeSchema[] = [];\n\tfor (const schema of allowedTypes) {\n\t\tif (shallowCompatibilityTest(schema, data)) {\n\t\t\tpossibleTypes.push(schema);\n\t\t}\n\t}\n\treturn possibleTypes;\n}\n\n/**\n * Checks if data might be schema-compatible.\n *\n * @returns false if `data` is incompatible with `type` based on a cheap/shallow check.\n *\n * Note that this may return true for cases where data is incompatible, but it must not return false in cases where the data is compatible.\n */\nfunction shallowCompatibilityTest(\n\tschema: TreeNodeSchema,\n\tdata: ContextuallyTypedNodeData,\n): boolean {\n\tassert(\n\t\tdata !== undefined,\n\t\t0x889 /* undefined cannot be used as contextually typed data. Use ContextuallyTypedFieldData. */,\n\t);\n\n\tif (isTreeValue(data)) {\n\t\treturn allowsValue(schema, data);\n\t}\n\tif (schema.kind === NodeKind.Leaf) {\n\t\treturn false;\n\t}\n\n\tif (typeNameSymbol in data) {\n\t\treturn data[typeNameSymbol] === schema.identifier;\n\t}\n\n\tif (isReadonlyArray(data)) {\n\t\treturn schema.kind === NodeKind.Array;\n\t}\n\tif (schema.kind === NodeKind.Array) {\n\t\treturn false;\n\t}\n\n\tif (data instanceof Map) {\n\t\treturn schema.kind === NodeKind.Map;\n\t}\n\tif (schema.kind === NodeKind.Map) {\n\t\treturn false;\n\t}\n\n\t// Assume record-like object\n\tif (schema.kind !== NodeKind.Object) {\n\t\treturn false;\n\t}\n\n\tconst fields = schema.info as Record<string, ImplicitFieldSchema>;\n\n\t// TODO: Improve type inference by making this logic more thorough. Handle at least:\n\t// * Types which are strict subsets of other types in the same polymorphic union\n\t// * Types which have the same keys but different types for those keys in the polymorphic union\n\t// * Types which have the same required fields but different optional fields and enough of those optional fields are populated to disambiguate\n\n\t// TODO#7441: Consider allowing data to be inserted which has keys that are extraneous/unknown to the schema (those keys are ignored)\n\n\t// If the schema has a required key which is not present in the input object, reject it.\n\tfor (const [fieldKey, fieldSchema] of Object.entries(fields)) {\n\t\tconst normalizedFieldSchema = normalizeFieldSchema(fieldSchema);\n\t\tif (data[fieldKey] === undefined && normalizedFieldSchema.kind === FieldKind.Required) {\n\t\t\treturn false;\n\t\t}\n\t}\n\n\treturn true;\n}\n\nfunction allowsValue(schema: TreeNodeSchema, value: TreeValue): boolean {\n\tif (schema.kind === NodeKind.Leaf) {\n\t\treturn valueSchemaAllows(schema.info as ValueSchema, value);\n\t}\n\treturn false;\n}\n\n/**\n * Content of a tree which needs external schema information to interpret.\n *\n * This format is intended for concise authoring of tree literals when the schema is statically known.\n *\n * Once schema aware APIs are implemented, they can be used to provide schema specific subsets of this type.\n */\nexport type ContextuallyTypedNodeData =\n\t| ContextuallyTypedNodeDataObject\n\t| number\n\t| string\n\t| boolean\n\t// eslint-disable-next-line @rushstack/no-new-null\n\t| null\n\t| readonly ContextuallyTypedNodeData[];\n\n/**\n * Content of a field which needs external schema information to interpret.\n *\n * This format is intended for concise authoring of tree literals when the schema is statically known.\n *\n * Once schema aware APIs are implemented, they can be used to provide schema specific subsets of this type.\n */\nexport type ContextuallyTypedFieldData = ContextuallyTypedNodeData | undefined;\n\n/**\n * Object case of {@link ContextuallyTypedNodeData}.\n */\nexport interface ContextuallyTypedNodeDataObject {\n\t/**\n\t * The type of the node.\n\t * If this node is well-formed, it must follow this schema.\n\t */\n\treadonly [typeNameSymbol]?: string;\n\n\t/**\n\t * Fields of this node, indexed by their field keys.\n\t *\n\t * Allow explicit undefined for compatibility with FlexTree, and type-safety on read.\n\t */\n\t// TODO: make sure explicit undefined is actually handled correctly.\n\t[key: FieldKey]: ContextuallyTypedFieldData;\n\n\t/**\n\t * Fields of this node, indexed by their field keys as strings.\n\t *\n\t * Allow unbranded field keys as a convenience for literals.\n\t */\n\t[key: string]: ContextuallyTypedFieldData;\n}\n"]}

package/lib/simple-tree/tree.d.ts

@@ -3,7 +3,9 @@
  * Licensed under the MIT License.
  */
 import { IChannel } from "@fluidframework/datastore-definitions";
+import { CommitMetadata } from "../core/index.js";
 import { ISubscribable } from "../events/index.js";
+import { RevertibleFactory } from "../shared-tree/index.js";
 import { IDisposable } from "../util/index.js";
 import { ImplicitFieldSchema, InsertableTreeFieldFromImplicitField, TreeFieldFromImplicitField } from "./schemaTypes.js";
 /**
@@ -49,7 +51,7 @@ export interface ITree extends IChannel {
      * Additionally, once out of schema content adapters are properly supported (with lazy document updates),
      * this initialization could become just another out of schema content adapter and this initialization is no longer a special case.
      */
-    schematize<TRoot extends ImplicitFieldSchema>(config: TreeConfiguration<TRoot>): TreeView<TreeFieldFromImplicitField<TRoot>>;
+    schematize<TRoot extends ImplicitFieldSchema>(config: TreeConfiguration<TRoot>): TreeView<TRoot>;
 }
 /**
  * Configuration for how to {@link ITree.schematize|schematize} a tree.
@@ -84,7 +86,7 @@ export declare class TreeConfiguration<TSchema extends ImplicitFieldSchema = Imp
  * it could be mitigated by adding a `rootOrError` member and deprecating `root` to give users a warning if they might be missing the error checking.
  * @public
  */
-export interface TreeView<in out TRoot> extends IDisposable {
+export interface TreeView<TSchema extends ImplicitFieldSchema> extends IDisposable {
     /**
      * The current root of the tree.
      *
@@ -94,7 +96,8 @@ export interface TreeView<in out TRoot> extends IDisposable {
      * To get notified about changes to this field (including to it being in an `error` state),
      * use {@link TreeViewEvents.rootChanged} via `view.events.on("rootChanged", callback)`.
      */
-    readonly root: TRoot;
+    get root(): TreeFieldFromImplicitField<TSchema>;
+    set root(newRoot: InsertableTreeFieldFromImplicitField<TSchema>);
     /**
      * Description of the error state, if any.
      * When this is undefined, the view schema and stored schema are compatible, and `root` can be used.
@@ -154,5 +157,19 @@ export interface TreeViewEvents {
      * This does NOT include changes to the content (fields/children) of the root node: for that case subscribe to events on the root node.
      */
     rootChanged(): void;
+    /**
+     * Fired when:
+     * - a local commit is applied outside of a transaction
+     * - a local transaction is committed
+     *
+     * The event is not fired when:
+     * - a local commit is applied within a transaction
+     * - a remote commit is applied
+     *
+     * @param data - information about the commit that was applied
+     * @param getRevertible - a function provided that allows users to get a revertible for the commit that was applied. If not provided,
+     * this commit is not revertible.
+     */
+    commitApplied(data: CommitMetadata, getRevertible?: RevertibleFactory): void;
 }
 //# sourceMappingURL=tree.d.ts.map

package/lib/simple-tree/tree.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tree.d.ts","sourceRoot":"","sources":["../../src/simple-tree/tree.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AACjE,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EACN,mBAAmB,EACnB,oCAAoC,EACpC,0BAA0B,EAC1B,MAAM,kBAAkB,CAAC;AAE1B;;;;;GAKG;AACH,MAAM,WAAW,KAAM,SAAQ,QAAQ;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,UAAU,CAAC,KAAK,SAAS,mBAAmB,EAC3C,MAAM,EAAE,iBAAiB,CAAC,KAAK,CAAC,GAC9B,QAAQ,CAAC,0BAA0B,CAAC,KAAK,CAAC,CAAC,CAAC;CAC/C;AAED;;;GAGG;AACH,qBAAa,iBAAiB,CAAC,OAAO,SAAS,mBAAmB,GAAG,mBAAmB;aAStE,MAAM,EAAE,OAAO;aACf,WAAW,EAAE,MAAM,oCAAoC,CAAC,OAAO,CAAC;IATjF;;;;;;OAMG;gBAEc,MAAM,EAAE,OAAO,EACf,WAAW,EAAE,MAAM,oCAAoC,CAAC,OAAO,CAAC;CAEjF;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,QAAQ,CAAC,EAAE,CAAC,GAAG,CAAC,KAAK,CAAE,SAAQ,WAAW;IAC1D;;;;;;;;OAQG;IACH,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC;IAErB;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAEpC;;;;;;;;;;;;;OAaG;IACH,aAAa,IAAI,IAAI,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;CAC/C;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAClC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,UAAU,IAAI,IAAI,CAAC;IAEnB;;;;;OAKG;IACH,WAAW,IAAI,IAAI,CAAC;CACpB"}
+{"version":3,"file":"tree.d.ts","sourceRoot":"","sources":["../../src/simple-tree/tree.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,QAAQ,EAAE,MAAM,uCAAuC,CAAC;AAEjE,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,OAAO,EACN,mBAAmB,EACnB,oCAAoC,EACpC,0BAA0B,EAC1B,MAAM,kBAAkB,CAAC;AAE1B;;;;;GAKG;AACH,MAAM,WAAW,KAAM,SAAQ,QAAQ;IACtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,UAAU,CAAC,KAAK,SAAS,mBAAmB,EAC3C,MAAM,EAAE,iBAAiB,CAAC,KAAK,CAAC,GAC9B,QAAQ,CAAC,KAAK,CAAC,CAAC;CACnB;AAED;;;GAGG;AACH,qBAAa,iBAAiB,CAAC,OAAO,SAAS,mBAAmB,GAAG,mBAAmB;aAStE,MAAM,EAAE,OAAO;aACf,WAAW,EAAE,MAAM,oCAAoC,CAAC,OAAO,CAAC;IATjF;;;;;;OAMG;gBAEc,MAAM,EAAE,OAAO,EACf,WAAW,EAAE,MAAM,oCAAoC,CAAC,OAAO,CAAC;CAEjF;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,WAAW,QAAQ,CAAC,OAAO,SAAS,mBAAmB,CAAE,SAAQ,WAAW;IACjF;;;;;;;;OAQG;IACH,IAAI,IAAI,IAAI,0BAA0B,CAAC,OAAO,CAAC,CAAC;IAEhD,IAAI,IAAI,CAAC,OAAO,EAAE,oCAAoC,CAAC,OAAO,CAAC,EAAE;IAEjE;;;OAGG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,kBAAkB,CAAC;IAEpC;;;;;;;;;;;;;OAaG;IACH,aAAa,IAAI,IAAI,CAAC;IAEtB;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,cAAc,CAAC,CAAC;CAC/C;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAClC;;;;;;;;;;OAUG;IACH,QAAQ,CAAC,UAAU,EAAE,OAAO,CAAC;CAC7B;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,UAAU,IAAI,IAAI,CAAC;IAEnB;;;;;OAKG;IACH,WAAW,IAAI,IAAI,CAAC;IAEpB;;;;;;;;;;;;OAYG;IACH,aAAa,CAAC,IAAI,EAAE,cAAc,EAAE,aAAa,CAAC,EAAE,iBAAiB,GAAG,IAAI,CAAC;CAC7E"}