@fluidframework/tree 2.0.0-dev-rc.1.0.0.224419

package/dist/simple-tree/toMapTree.js

@@ -0,0 +1,299 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getPossibleTypes = exports.fieldDataToMapTrees = exports.nodeDataToMapTree = exports.cursorFromFieldData = exports.cursorFromNodeData = void 0;
+const core_utils_1 = require("@fluidframework/core-utils");
+const telemetry_utils_1 = require("@fluidframework/telemetry-utils");
+const core_1 = require("../core");
+// Drilling into `domains` to reduce the magnitude of cycles introduced here
+// eslint-disable-next-line import/no-internal-modules
+const leafDomain_1 = require("../domains/leafDomain");
+const feature_libraries_1 = require("../feature-libraries");
+const util_1 = require("../util");
+/**
+ * Module notes:
+ *
+ * The flow of the below code is in terms of the structure of the input data. We then verify that the associated
+ * schema is appropriate for that kind of data. This is fine while we have a 1:1 mapping of kind of input data to
+ * 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
+ * the schema). If/when we begin accepting kinds of input data that are ambiguous (e.g. accepting an input that is an
+ * array of key/value tuples to instantiate a map) we may need to rethink the structure here to be based more on the
+ * schema than on the input data.
+ */
+/**
+ * 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.
+ *
+ * @returns A cursor (in nodes mode) for the mapped tree if the input data was defined. Otherwise, returns `undefined`.
+ */
+function cursorFromNodeData(data, globalSchema, typeSet) {
+    if (data === undefined) {
+        return undefined;
+    }
+    const mappedContent = nodeDataToMapTree(data, globalSchema, typeSet);
+    return (0, feature_libraries_1.cursorForMapTreeNode)(mappedContent);
+}
+exports.cursorFromNodeData = cursorFromNodeData;
+/**
+ * Transforms an input {@link TreeField} tree to a list 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`.
+ */
+function cursorFromFieldData(data, globalSchema, fieldSchema) {
+    const mappedContent = fieldDataToMapTrees(data, globalSchema, fieldSchema);
+    return (0, feature_libraries_1.cursorForMapTreeField)(mappedContent);
+}
+exports.cursorFromFieldData = cursorFromFieldData;
+/**
+ * Transforms an input {@link TypedNode} tree to a {@link MapTree}.
+ * @param data - The input tree to be converted.
+ * If the data is an unsupported value (e.g. NaN), a fallback value will be used when supported,
+ * otherwise an error will be thrown.
+ *
+ * Fallbacks:
+ *
+ * * `NaN` =\> `null`
+ *
+ * * `+/-∞` =\> `null`
+ *
+ * * `-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.
+ */
+function nodeDataToMapTree(data, globalSchema, typeSet) {
+    (0, core_utils_1.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 ((0, feature_libraries_1.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);
+            }
+        }
+    }
+}
+exports.nodeDataToMapTree = nodeDataToMapTree;
+/**
+ * Transforms an input {@link TreeField} tree to a list 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`.
+ */
+function fieldDataToMapTrees(data, globalSchema, fieldSchema) {
+    const multiplicity = fieldSchema.kind.multiplicity;
+    if (data === undefined) {
+        (0, core_utils_1.assert)(multiplicity === feature_libraries_1.Multiplicity.Forbidden || multiplicity === feature_libraries_1.Multiplicity.Optional, 0x847 /* `undefined` provided for a field that does not support `undefined` */);
+        return [];
+    }
+    const typeSet = fieldSchema.allowedTypeSet;
+    if (multiplicity === feature_libraries_1.Multiplicity.Sequence) {
+        (0, core_utils_1.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 === feature_libraries_1.Any || typeSet.has(leafDomain_1.leaf.null)) {
+                    childWithFallback = null;
+                }
+                else {
+                    throw new TypeError(`Received unsupported list entry value: ${child}.`);
+                }
+            }
+            return nodeDataToMapTree(childWithFallback, globalSchema, typeSet);
+        });
+        return children;
+    }
+    (0, core_utils_1.assert)(multiplicity === feature_libraries_1.Multiplicity.Single || multiplicity === feature_libraries_1.Multiplicity.Optional, 0x849 /* A single value was provided for an unsupported field */);
+    return [nodeDataToMapTree(data, globalSchema, typeSet)];
+}
+exports.fieldDataToMapTrees = fieldDataToMapTrees;
+function valueToMapTree(
+// eslint-disable-next-line @rushstack/no-new-null
+value, globalSchema, typeSet) {
+    const mappedValue = mapValueWithFallbacks(value, typeSet);
+    const schema = getType(mappedValue, globalSchema, typeSet);
+    (0, core_utils_1.assert)(schema instanceof feature_libraries_1.LeafNodeSchema && (0, feature_libraries_1.allowsValue)(schema.leafValue, mappedValue), 0x84a /* Unsupported schema for provided primitive. */);
+    return {
+        value: mappedValue,
+        type: schema.name,
+        fields: new Map(),
+    };
+}
+/**
+ * Checks an incoming value to ensure it is compatible with our serialization format.
+ * For unsupported values with a schema-compatible replacement, return the replacement value.
+ * 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) {
+    switch (typeof value) {
+        case "number": {
+            if (Object.is(value, -0)) {
+                // Our serialized data format does not support -0.
+                // Map such input to +0.
+                return 0;
+            }
+            else if (Number.isNaN(value) || !Number.isFinite(value)) {
+                // 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 === feature_libraries_1.Any || typeSet.has(leafDomain_1.leaf.null)) {
+                    return null;
+                }
+                else {
+                    throw new TypeError(`Received unsupported numeric value: ${value}.`);
+                }
+            }
+            else {
+                return value;
+            }
+        }
+        default:
+            return value;
+    }
+}
+function arrayToMapTree(data, globalSchema, typeSet) {
+    const schema = getType(data, globalSchema, typeSet);
+    (0, core_utils_1.assert)(schema instanceof feature_libraries_1.FieldNodeSchema, 0x84b /* Array data reported comparable with the schema without a primary field. */);
+    const mappedChildren = fieldDataToMapTrees(data, globalSchema, schema.info);
+    const fieldsEntries = mappedChildren.length === 0 ? [] : [[core_1.EmptyKey, mappedChildren]];
+    // List children are represented as a single field entry denoted with `EmptyKey`
+    const fields = new Map(fieldsEntries);
+    return {
+        type: schema.name,
+        fields,
+    };
+}
+function mapToMapTree(data, globalSchema, typeSet) {
+    const schema = getType(data, globalSchema, typeSet);
+    const fields = new Map();
+    for (const [key, value] of data) {
+        (0, core_utils_1.assert)(!fields.has((0, util_1.brand)(key)), 0x84c /* Keys should not be duplicated */);
+        // Omit undefined record entries - an entry with an undefined key is equivalent to no entry
+        if (value !== undefined) {
+            const childSchema = schema.getFieldSchema((0, util_1.brand)(key));
+            const mappedField = fieldDataToMapTrees(value, globalSchema, childSchema);
+            fields.set((0, util_1.brand)(key), mappedField);
+        }
+    }
+    return {
+        type: schema.name,
+        fields,
+    };
+}
+function recordToMapTree(data, globalSchema, typeSet) {
+    const schema = getType(data, globalSchema, typeSet);
+    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) {
+        (0, core_utils_1.assert)(!fields.has(key), 0x84d /* Keys should not be duplicated */);
+        const value = data[key];
+        // 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((0, util_1.brand)(key), mappedChildTree);
+        }
+    }
+    return {
+        type: schema.name,
+        fields,
+    };
+}
+function getType(data, globalSchema, typeSet) {
+    const possibleTypes = getPossibleTypes(globalSchema, typeSet, data);
+    (0, core_utils_1.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)}.
+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];
+}
+/**
+ * An invalid tree has been provided, presumably by the user of this package.
+ * 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).
+ */
+function invalidInput(message) {
+    throw new telemetry_utils_1.UsageError(message);
+}
+function checkInput(condition, message) {
+    if (!condition) {
+        invalidInput(typeof message === "string" ? message : message());
+    }
+}
+/**
+ * @returns all types for which the data is schema-compatible.
+ */
+function getPossibleTypes(globalSchema, typeSet, data) {
+    // All types allowed by schema
+    const allowedTypes = (0, feature_libraries_1.getAllowedTypes)(globalSchema, typeSet);
+    const possibleTypes = [];
+    for (const allowed of allowedTypes) {
+        if (shallowCompatibilityTest(allowed, data)) {
+            possibleTypes.push(allowed);
+        }
+    }
+    return possibleTypes;
+}
+exports.getPossibleTypes = getPossibleTypes;
+/**
+ * Checks if data might be schema-compatible.
+ *
+ * @returns false if `data` is incompatible with `type` based on a cheap/shallow check.
+ *
+ * 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.
+ */
+function shallowCompatibilityTest(schema, data) {
+    (0, core_utils_1.assert)(data !== undefined, "undefined cannot be used as contextually typed data. Use ContextuallyTypedFieldData.");
+    if ((0, feature_libraries_1.isTreeValue)(data)) {
+        return schema instanceof feature_libraries_1.LeafNodeSchema && (0, feature_libraries_1.allowsValue)(schema.leafValue, data);
+    }
+    if (schema instanceof feature_libraries_1.LeafNodeSchema) {
+        return false;
+    }
+    if (feature_libraries_1.typeNameSymbol in data) {
+        return data[feature_libraries_1.typeNameSymbol] === schema.name;
+    }
+    if ((0, util_1.isReadonlyArray)(data)) {
+        if (schema instanceof feature_libraries_1.FieldNodeSchema) {
+            const field = schema.getFieldSchema();
+            return field.kind.multiplicity === feature_libraries_1.Multiplicity.Sequence;
+        }
+        else {
+            return false;
+        }
+    }
+    if (data instanceof Map) {
+        return schema instanceof feature_libraries_1.MapNodeSchema;
+    }
+    // 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;
+}
+//# sourceMappingURL=toMapTree.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"toMapTree.js","sourceRoot":"","sources":["../../src/simple-tree/toMapTree.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,2DAAoD;AACpD,qEAA6D;AAE7D,kCAAgE;AAChE,4EAA4E;AAC5E,sDAAsD;AACtD,sDAA6C;AAC7C,4DAkB8B;AAC9B,kCAAiD;AAGjD;;;;;;;;;GASG;AAEH;;;;;;;GAOG;AACH,SAAgB,kBAAkB,CACjC,IAAyC,EACzC,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,IAAA,wCAAoB,EAAC,aAAa,CAAC,CAAC;AAC5C,CAAC;AAVD,gDAUC;AAED;;;;GAIG;AACH,SAAgB,mBAAmB,CAClC,IAAyB,EACzB,YAA4B,EAC5B,WAA4B;IAE5B,MAAM,aAAa,GAAG,mBAAmB,CAAC,IAAI,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;IAC3E,OAAO,IAAA,yCAAqB,EAAC,aAAa,CAAC,CAAC;AAC7C,CAAC;AAPD,kDAOC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,iBAAiB,CAChC,IAAyC,EACzC,YAA4B,EAC5B,OAAuB;IAEvB,IAAA,mBAAM,EAAC,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,IAAA,iCAAa,EAAC,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,IAA2D,EAC3D,YAAY,EACZ,OAAO,CACP,CAAC;aACF;SACD;KACD;AACF,CAAC;AAhCD,8CAgCC;AAED;;;;;;GAMG;AACH,SAAgB,mBAAmB,CAClC,IAAyB,EACzB,YAA4B,EAC5B,WAA4B;IAE5B,MAAM,YAAY,GAAG,WAAW,CAAC,IAAI,CAAC,YAAY,CAAC;IACnD,IAAI,IAAI,KAAK,SAAS,EAAE;QACvB,IAAA,mBAAM,EACL,YAAY,KAAK,gCAAY,CAAC,SAAS,IAAI,YAAY,KAAK,gCAAY,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,gCAAY,CAAC,QAAQ,EAAE;QAC3C,IAAA,mBAAM,EAAC,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,uBAAG,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAI,CAAC,IAAI,CAAC,EAAE;oBAC9C,iBAAiB,GAAG,IAAI,CAAC;iBACzB;qBAAM;oBACN,MAAM,IAAI,SAAS,CAAC,0CAA0C,KAAK,GAAG,CAAC,CAAC;iBACxE;aACD;YACD,OAAO,iBAAiB,CAAC,iBAAiB,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;QACpE,CAAC,CAAC,CAAC;QACH,OAAO,QAAQ,CAAC;KAChB;IACD,IAAA,mBAAM,EACL,YAAY,KAAK,gCAAY,CAAC,MAAM,IAAI,YAAY,KAAK,gCAAY,CAAC,QAAQ,EAC9E,KAAK,CAAC,0DAA0D,CAChE,CAAC;IACF,OAAO,CAAC,iBAAiB,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC,CAAC;AACzD,CAAC;AAtCD,kDAsCC;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,IAAA,mBAAM,EACL,MAAM,YAAY,kCAAc,IAAI,IAAA,+BAAW,EAAC,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,uBAAG,IAAI,OAAO,CAAC,GAAG,CAAC,iBAAI,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,IAA2C,EAC3C,YAA4B,EAC5B,OAAuB;IAEvB,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;IACpD,IAAA,mBAAM,EACL,MAAM,YAAY,mCAAe,EACjC,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,eAAQ,EAAE,cAAc,CAAC,CAAC,CAAC;IAEjE,gFAAgF;IAChF,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,IAAsD,EACtD,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,IAAA,mBAAM,EAAC,CAAC,MAAM,CAAC,GAAG,CAAC,IAAA,YAAK,EAAC,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,IAAA,YAAK,EAAC,GAAG,CAAC,CAAC,CAAC;YACtD,MAAM,WAAW,GAAG,mBAAmB,CAAC,KAAK,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;YAC1E,MAAM,CAAC,GAAG,CAAC,IAAA,YAAK,EAAC,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,IAA2E,EAC3E,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,IAAA,mBAAM,EAAC,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,IAAA,YAAK,EAAC,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,IAAyC,EACzC,YAA4B,EAC5B,OAAuB;IAEvB,MAAM,aAAa,GAAG,gBAAgB,CACrC,YAAY,EACZ,OAAO,EACP,IAAiC,CACjC,CAAC;IACF,IAAA,mBAAM,EACL,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,4BAAU,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,SAAgB,gBAAgB,CAC/B,YAA4B,EAC5B,OAAuB,EACvB,IAA+B;IAE/B,8BAA8B;IAC9B,MAAM,YAAY,GAAG,IAAA,mCAAe,EAAC,YAAY,EAAE,OAAO,CAAC,CAAC;IAE5D,MAAM,aAAa,GAAqB,EAAE,CAAC;IAC3C,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;AAfD,4CAeC;AAED;;;;;;GAMG;AACH,SAAS,wBAAwB,CAChC,MAAsB,EACtB,IAA+B;IAE/B,IAAA,mBAAM,EACL,IAAI,KAAK,SAAS,EAClB,sFAAsF,CACtF,CAAC;IACF,IAAI,IAAA,+BAAW,EAAC,IAAI,CAAC,EAAE;QACtB,OAAO,MAAM,YAAY,kCAAc,IAAI,IAAA,+BAAW,EAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;KAC/E;IACD,IAAI,MAAM,YAAY,kCAAc,EAAE;QACrC,OAAO,KAAK,CAAC;KACb;IACD,IAAI,kCAAc,IAAI,IAAI,EAAE;QAC3B,OAAO,IAAI,CAAC,kCAAc,CAAC,KAAK,MAAM,CAAC,IAAI,CAAC;KAC5C;IACD,IAAI,IAAA,sBAAe,EAAC,IAAI,CAAC,EAAE;QAC1B,IAAI,MAAM,YAAY,mCAAe,EAAE;YACtC,MAAM,KAAK,GAAG,MAAM,CAAC,cAAc,EAAE,CAAC;YACtC,OAAO,KAAK,CAAC,IAAI,CAAC,YAAY,KAAK,gCAAY,CAAC,QAAQ,CAAC;SACzD;aAAM;YACN,OAAO,KAAK,CAAC;SACb;KACD;IACD,IAAI,IAAI,YAAY,GAAG,EAAE;QACxB,OAAO,MAAM,YAAY,iCAAa,CAAC;KACvC;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\";\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\";\nimport {\n\tallowsValue,\n\tcursorForMapTreeField,\n\tcursorForMapTreeNode,\n\ttype CursorWithNode,\n\tisFluidHandle,\n\tMultiplicity,\n\ttype TreeNodeSchema,\n\tFlexTreeSchema,\n\ttype AllowedTypeSet,\n\tTreeFieldSchema,\n\tAny,\n\tFieldNodeSchema,\n\tisTreeValue,\n\tLeafNodeSchema,\n\tMapNodeSchema,\n\tgetAllowedTypes,\n\ttypeNameSymbol,\n} from \"../feature-libraries\";\nimport { brand, isReadonlyArray } from \"../util\";\nimport { InsertableTreeField, InsertableTypedNode } from \"./insertable\";\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: InsertableTypedNode<TreeNodeSchema>,\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\n/**\n * Transforms an input {@link TreeField} tree to a list 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: TreeFieldSchema,\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: InsertableTypedNode<TreeNodeSchema>,\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, InsertableTypedNode<TreeNodeSchema>>,\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 a list 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: TreeFieldSchema,\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 list 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: InsertableTypedNode<TreeNodeSchema>[],\n\tglobalSchema: FlexTreeSchema,\n\ttypeSet: AllowedTypeSet,\n): MapTree {\n\tconst schema = getType(data, globalSchema, typeSet);\n\tassert(\n\t\tschema instanceof FieldNodeSchema,\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// List 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, InsertableTypedNode<TreeNodeSchema>>,\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, InsertableTypedNode<TreeNodeSchema>>,\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: InsertableTypedNode<TreeNodeSchema>,\n\tglobalSchema: FlexTreeSchema,\n\ttypeSet: AllowedTypeSet,\n): TreeNodeSchema {\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: TreeNodeSchema[] = [];\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: TreeNodeSchema,\n\tdata: ContextuallyTypedNodeData,\n): boolean {\n\tassert(\n\t\tdata !== undefined,\n\t\t\"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 FieldNodeSchema) {\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 MapNodeSchema;\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"]}

package/dist/simple-tree/treeListNode.d.ts

@@ -0,0 +1,60 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { AllowedTypes } from "../feature-libraries";
+import { type ImplicitAllowedTypes, type TreeNodeFromImplicitAllowedTypes, type InsertableTreeNodeFromImplicitAllowedTypes } from "../class-tree";
+import { InsertableTreeNodeUnion } from "./insertable";
+import { TreeArrayNodeBase, TreeNodeUnion } from "./types";
+/**
+ * A {@link TreeNode} which implements 'readonly T[]' and the list mutation APIs.
+ */
+export interface TreeListNodeOld<out TTypes extends AllowedTypes = AllowedTypes> extends TreeArrayNodeBase<TreeNodeUnion<TTypes>, InsertableTreeNodeUnion<TTypes>, TreeListNodeOld> {
+}
+/**
+ * A {@link TreeNode} which implements 'readonly T[]' and the list mutation APIs.
+ * @beta
+ */
+export interface TreeArrayNode<T extends ImplicitAllowedTypes = ImplicitAllowedTypes> extends TreeArrayNodeBase<TreeNodeFromImplicitAllowedTypes<T>, InsertableTreeNodeFromImplicitAllowedTypes<T>, TreeArrayNode> {
+}
+/**
+ * A {@link TreeNode} which implements 'readonly T[]' and the list mutation APIs.
+ * @beta
+ */
+export declare const TreeArrayNode: {
+    /**
+     * Wrap an iterable of items to inserted as consecutive items in a list.
+     * @remarks
+     * The object returned by this function can be inserted into a {@link (TreeArrayNode:interface)}.
+     * Its contents will be inserted consecutively in the corresponding location in the list.
+     * @example
+     * ```ts
+     * list.insertAtEnd(TreeArrayNode.inline(iterable))
+     * ```
+     */
+    inline: <T>(content: Iterable<T>) => IterableTreeListContent<T>;
+};
+/**
+ * Non-exported symbol used to make IterableTreeListContent constructable only from within this file.
+ */
+declare const create: unique symbol;
+/**
+ * Used to insert iterable content into a {@link (TreeArrayNode:interface)}.
+ * Use {@link (TreeArrayNode:variable).inline} to create an instance of this type.
+ * @beta
+ */
+export declare class IterableTreeListContent<T> implements Iterable<T> {
+    private readonly content;
+    private constructor();
+    /**
+     * Package internal construction API.
+     * Use {@link (TreeArrayNode:variable).inline} to create an instance of this type instead.
+     */
+    static [create]<T>(content: Iterable<T>): IterableTreeListContent<T>;
+    /**
+     * Iterates over content for nodes to insert.
+     */
+    [Symbol.iterator](): Iterator<T>;
+}
+export {};
+//# sourceMappingURL=treeListNode.d.ts.map

package/dist/simple-tree/treeListNode.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"treeListNode.d.ts","sourceRoot":"","sources":["../../src/simple-tree/treeListNode.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,YAAY,EAAE,MAAM,sBAAsB,CAAC;AACpD,OAAO,EACN,KAAK,oBAAoB,EACzB,KAAK,gCAAgC,EACrC,KAAK,0CAA0C,EAC/C,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,uBAAuB,EAAE,MAAM,cAAc,CAAC;AACvD,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AAE3D;;GAEG;AACH,MAAM,WAAW,eAAe,CAAC,GAAG,CAAC,MAAM,SAAS,YAAY,GAAG,YAAY,CAC9E,SAAQ,iBAAiB,CACxB,aAAa,CAAC,MAAM,CAAC,EACrB,uBAAuB,CAAC,MAAM,CAAC,EAC/B,eAAe,CACf;CAAG;AAEL;;;GAGG;AACH,MAAM,WAAW,aAAa,CAAC,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,CACnF,SAAQ,iBAAiB,CACxB,gCAAgC,CAAC,CAAC,CAAC,EACnC,0CAA0C,CAAC,CAAC,CAAC,EAC7C,aAAa,CACb;CAAG;AAEL;;;GAGG;AACH,eAAO,MAAM,aAAa;IACzB;;;;;;;;;OASG;;CAEH,CAAC;AAEF;;GAEG;AACH,QAAA,MAAM,MAAM,eAA2C,CAAC;AAExD;;;;GAIG;AACH,qBAAa,uBAAuB,CAAC,CAAC,CAAE,YAAW,QAAQ,CAAC,CAAC,CAAC;IACzC,OAAO,CAAC,QAAQ,CAAC,OAAO;IAA5C,OAAO;IAEP;;;OAGG;WACW,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,CAAC,CAAC,GAAG,uBAAuB,CAAC,CAAC,CAAC;IAI3E;;OAEG;IACI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,QAAQ,CAAC,CAAC,CAAC;CAGvC"}

package/dist/simple-tree/treeListNode.js

@@ -0,0 +1,53 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.IterableTreeListContent = exports.TreeArrayNode = void 0;
+/**
+ * A {@link TreeNode} which implements 'readonly T[]' and the list mutation APIs.
+ * @beta
+ */
+exports.TreeArrayNode = {
+    /**
+     * Wrap an iterable of items to inserted as consecutive items in a list.
+     * @remarks
+     * The object returned by this function can be inserted into a {@link (TreeArrayNode:interface)}.
+     * Its contents will be inserted consecutively in the corresponding location in the list.
+     * @example
+     * ```ts
+     * list.insertAtEnd(TreeArrayNode.inline(iterable))
+     * ```
+     */
+    inline: (content) => IterableTreeListContent[create](content),
+};
+/**
+ * Non-exported symbol used to make IterableTreeListContent constructable only from within this file.
+ */
+const create = Symbol("Create IterableTreeListContent");
+/**
+ * Used to insert iterable content into a {@link (TreeArrayNode:interface)}.
+ * Use {@link (TreeArrayNode:variable).inline} to create an instance of this type.
+ * @beta
+ */
+class IterableTreeListContent {
+    constructor(content) {
+        this.content = content;
+    }
+    /**
+     * Package internal construction API.
+     * Use {@link (TreeArrayNode:variable).inline} to create an instance of this type instead.
+     */
+    static [create](content) {
+        return new IterableTreeListContent(content);
+    }
+    /**
+     * Iterates over content for nodes to insert.
+     */
+    [Symbol.iterator]() {
+        return this.content[Symbol.iterator]();
+    }
+}
+exports.IterableTreeListContent = IterableTreeListContent;
+//# sourceMappingURL=treeListNode.js.map

package/dist/simple-tree/treeListNode.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"treeListNode.js","sourceRoot":"","sources":["../../src/simple-tree/treeListNode.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAgCH;;;GAGG;AACU,QAAA,aAAa,GAAG;IAC5B;;;;;;;;;OASG;IACH,MAAM,EAAE,CAAI,OAAoB,EAAE,EAAE,CAAC,uBAAuB,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;CAC7E,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,GAAG,MAAM,CAAC,gCAAgC,CAAC,CAAC;AAExD;;;;GAIG;AACH,MAAa,uBAAuB;IACnC,YAAqC,OAAoB;QAApB,YAAO,GAAP,OAAO,CAAa;IAAG,CAAC;IAE7D;;;OAGG;IACI,MAAM,CAAC,CAAC,MAAM,CAAC,CAAI,OAAoB;QAC7C,OAAO,IAAI,uBAAuB,CAAC,OAAO,CAAC,CAAC;IAC7C,CAAC;IAED;;OAEG;IACI,CAAC,MAAM,CAAC,QAAQ,CAAC;QACvB,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE,CAAC;IACxC,CAAC;CACD;AAjBD,0DAiBC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { AllowedTypes } from \"../feature-libraries\";\nimport {\n\ttype ImplicitAllowedTypes,\n\ttype TreeNodeFromImplicitAllowedTypes,\n\ttype InsertableTreeNodeFromImplicitAllowedTypes,\n} from \"../class-tree\";\nimport { InsertableTreeNodeUnion } from \"./insertable\";\nimport { TreeArrayNodeBase, TreeNodeUnion } from \"./types\";\n\n/**\n * A {@link TreeNode} which implements 'readonly T[]' and the list mutation APIs.\n */\nexport interface TreeListNodeOld<out TTypes extends AllowedTypes = AllowedTypes>\n\textends TreeArrayNodeBase<\n\t\tTreeNodeUnion<TTypes>,\n\t\tInsertableTreeNodeUnion<TTypes>,\n\t\tTreeListNodeOld\n\t> {}\n\n/**\n * A {@link TreeNode} which implements 'readonly T[]' and the list mutation APIs.\n * @beta\n */\nexport interface TreeArrayNode<T extends ImplicitAllowedTypes = ImplicitAllowedTypes>\n\textends TreeArrayNodeBase<\n\t\tTreeNodeFromImplicitAllowedTypes<T>,\n\t\tInsertableTreeNodeFromImplicitAllowedTypes<T>,\n\t\tTreeArrayNode\n\t> {}\n\n/**\n * A {@link TreeNode} which implements 'readonly T[]' and the list mutation APIs.\n * @beta\n */\nexport const TreeArrayNode = {\n\t/**\n\t * Wrap an iterable of items to inserted as consecutive items in a list.\n\t * @remarks\n\t * The object returned by this function can be inserted into a {@link (TreeArrayNode:interface)}.\n\t * Its contents will be inserted consecutively in the corresponding location in the list.\n\t * @example\n\t * ```ts\n\t * list.insertAtEnd(TreeArrayNode.inline(iterable))\n\t * ```\n\t */\n\tinline: <T>(content: Iterable<T>) => IterableTreeListContent[create](content),\n};\n\n/**\n * Non-exported symbol used to make IterableTreeListContent constructable only from within this file.\n */\nconst create = Symbol(\"Create IterableTreeListContent\");\n\n/**\n * Used to insert iterable content into a {@link (TreeArrayNode:interface)}.\n * Use {@link (TreeArrayNode:variable).inline} to create an instance of this type.\n * @beta\n */\nexport class IterableTreeListContent<T> implements Iterable<T> {\n\tprivate constructor(private readonly content: Iterable<T>) {}\n\n\t/**\n\t * Package internal construction API.\n\t * Use {@link (TreeArrayNode:variable).inline} to create an instance of this type instead.\n\t */\n\tpublic static [create]<T>(content: Iterable<T>): IterableTreeListContent<T> {\n\t\treturn new IterableTreeListContent(content);\n\t}\n\n\t/**\n\t * Iterates over content for nodes to insert.\n\t */\n\tpublic [Symbol.iterator](): Iterator<T> {\n\t\treturn this.content[Symbol.iterator]();\n\t}\n}\n"]}