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

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

@@ -1 +1 @@
-{"version":3,"file":"toMapTree.js","sourceRoot":"","sources":["../../src/simple-tree/toMapTree.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAGH,2DAAoD;AACpD,qEAA6D;AAE7D,+CAAyE;AACzE,4EAA4E;AAC5E,sDAAsD;AACtD,4DAAgD;AAChD,4DAkBuC;AACvC,+CAA0D;AAG1D;;;;;;;;;GASG;AAEH;;;;;;;GAOG;AACH,SAAgB,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,IAAA,+BAAoB,EAAC,aAAa,CAAC,CAAC;AAC5C,CAAC;AAVD,gDAUC;AAID;;;;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,gCAAqB,EAAC,aAAa,CAAC,CAAC;AAC7C,CAAC;AAPD,kDAOC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,iBAAiB,CAChC,IAAuB,EACvB,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,wBAAa,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,IAAyC,EACzC,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,uBAAY,CAAC,SAAS,IAAI,YAAY,KAAK,uBAAY,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,uBAAY,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,cAAG,IAAI,OAAO,CAAC,GAAG,CAAC,oBAAI,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,IAAA,mBAAM,EACL,YAAY,KAAK,uBAAY,CAAC,MAAM,IAAI,YAAY,KAAK,uBAAY,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,yBAAc,IAAI,IAAA,sBAAW,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,cAAG,IAAI,OAAO,CAAC,GAAG,CAAC,oBAAI,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,IAAA,mBAAM,EACL,MAAM,YAAY,8BAAmB,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,mBAAQ,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,IAAA,mBAAM,EAAC,CAAC,MAAM,CAAC,GAAG,CAAC,IAAA,gBAAK,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,gBAAK,EAAC,GAAG,CAAC,CAAC,CAAC;YACtD,MAAM,WAAW,GAAG,mBAAmB,CAAC,KAAK,EAAE,YAAY,EAAE,WAAW,CAAC,CAAC;YAC1E,MAAM,CAAC,GAAG,CAAC,IAAA,gBAAK,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,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,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,gBAAK,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,IAAuB,EACvB,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,0BAAe,EAAC,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;AAfD,4CAeC;AAED;;;;;;GAMG;AACH,SAAS,wBAAwB,CAChC,MAA0B,EAC1B,IAA+B;IAE/B,IAAA,mBAAM,EACL,IAAI,KAAK,SAAS,EAClB,KAAK,CAAC,0FAA0F,CAChG,CAAC;IACF,IAAI,IAAA,sBAAW,EAAC,IAAI,CAAC,EAAE;QACtB,OAAO,MAAM,YAAY,yBAAc,IAAI,IAAA,sBAAW,EAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;KAC/E;IACD,IAAI,MAAM,YAAY,yBAAc,EAAE;QACrC,OAAO,KAAK,CAAC;KACb;IACD,IAAI,yBAAc,IAAI,IAAI,EAAE;QAC3B,OAAO,IAAI,CAAC,yBAAc,CAAC,KAAK,MAAM,CAAC,IAAI,CAAC;KAC5C;IACD,IAAI,IAAA,0BAAe,EAAC,IAAI,CAAC,EAAE;QAC1B,IAAI,MAAM,YAAY,8BAAmB,EAAE;YAC1C,MAAM,KAAK,GAAG,MAAM,CAAC,cAAc,EAAE,CAAC;YACtC,OAAO,KAAK,CAAC,IAAI,CAAC,YAAY,KAAK,uBAAY,CAAC,QAAQ,CAAC;SACzD;aAAM;YACN,OAAO,KAAK,CAAC;SACb;KACD;IACD,IAAI,IAAI,YAAY,GAAG,EAAE;QACxB,OAAO,MAAM,YAAY,4BAAiB,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,kEAA6D;AAC7D,uEAAsE;AAEtE,+CAM0B;AAC1B,4DAOuC;AACvC,+CAAgE;AAEhE,2DAAiD;AAEjD,qDAU0B;AAE1B;;;;;;;;;GASG;AAEH;;;;;;GAMG;AACH,SAAgB,kBAAkB,CACjC,IAAuB,EACvB,YAAkC;IAElC,IAAI,IAAI,KAAK,SAAS,EAAE;QACvB,OAAO,SAAS,CAAC;KACjB;IACD,MAAM,aAAa,GAAG,iBAAiB,CAAC,IAAI,EAAE,IAAA,sCAAqB,EAAC,YAAY,CAAC,CAAC,CAAC;IACnF,OAAO,IAAA,+BAAoB,EAAC,aAAa,CAAC,CAAC;AAC5C,CAAC;AATD,gDASC;AAED;;;;GAIG;AACH,SAAgB,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,IAAA,gCAAqB,EAAC,aAAa,CAAC,CAAC;AAC7C,CAAC;AARD,kDAQC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,SAAgB,iBAAiB,CAChC,IAAuB,EACvB,YAAyC;IAEzC,IAAA,iBAAM,EAAC,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,yBAAQ,CAAC,IAAI;YACjB,OAAO,aAAa,CAAC,IAAI,EAAE,MAAM,EAAE,YAAY,CAAC,CAAC;QAClD,KAAK,yBAAQ,CAAC,KAAK;YAClB,OAAO,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACrC,KAAK,yBAAQ,CAAC,GAAG;YAChB,OAAO,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACnC,KAAK,yBAAQ,CAAC,MAAM;YACnB,OAAO,eAAe,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QACtC;YACC,IAAA,eAAI,EAAC,6BAA6B,MAAM,CAAC,IAAI,GAAG,CAAC,CAAC;KACnD;AACF,CAAC;AApBD,8CAoBC;AAED;;;;;;GAMG;AACH,SAAS,aAAa,CACrB,IAAuB,EACvB,MAAsB,EACtB,YAAyC;IAEzC,IAAA,iBAAM,EAAC,MAAM,CAAC,IAAI,KAAK,yBAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,6BAA6B,CAAC,CAAC;IAC3E,IAAI,CAAC,IAAA,sBAAW,EAAC,IAAI,CAAC,EAAE;QACvB,wFAAwF;QACxF,6GAA6G;QAC7G,gEAAgE;QAChE,MAAM,IAAI,qBAAU,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,IAAA,iBAAM,EACL,WAAW,CAAC,YAAY,EAAE,WAAW,CAAC,EACtC,KAAK,CAAC,gDAAgD,CACtD,CAAC;IAEF,OAAO;QACN,KAAK,EAAE,WAAW;QAClB,IAAI,EAAE,IAAA,gBAAK,EAAC,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,8BAAU,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,8BAAU,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,IAAA,iBAAM,EAAC,MAAM,CAAC,IAAI,KAAK,yBAAQ,CAAC,KAAK,EAAE,KAAK,CAAC,+BAA+B,CAAC,CAAC;IAC9E,IAAI,CAAC,IAAA,0BAAe,EAAC,IAAI,CAAC,EAAE;QAC3B,MAAM,IAAI,qBAAU,CAAC,iDAAiD,IAAI,EAAE,CAAC,CAAC;KAC9E;IAED,MAAM,iBAAiB,GAAG,IAAA,sCAAqB,EAAC,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,mBAAQ,EAAE,UAAU,CAAC,CAAC,CAAC;IACzD,MAAM,MAAM,GAAG,IAAI,GAAG,CAAsB,aAAa,CAAC,CAAC;IAE3D,OAAO;QACN,IAAI,EAAE,IAAA,gBAAK,EAAC,MAAM,CAAC,UAAU,CAAC;QAC9B,MAAM;KACN,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,SAAS,YAAY,CAAC,IAAuB,EAAE,MAAsB;IACpE,IAAA,iBAAM,EAAC,MAAM,CAAC,IAAI,KAAK,yBAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,4BAA4B,CAAC,CAAC;IACzE,IAAI,CAAC,CAAC,IAAI,YAAY,GAAG,CAAC,EAAE;QAC3B,MAAM,IAAI,qBAAU,CAAC,+CAA+C,IAAI,EAAE,CAAC,CAAC;KAC5E;IAED,MAAM,iBAAiB,GAAG,IAAA,sCAAqB,EAAC,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,IAAA,iBAAM,EAAC,CAAC,iBAAiB,CAAC,GAAG,CAAC,IAAA,gBAAK,EAAC,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,IAAA,gBAAK,EAAC,GAAG,CAAC,EAAE,CAAC,WAAW,CAAC,CAAC,CAAC;SACjD;KACD;IAED,OAAO;QACN,IAAI,EAAE,IAAA,gBAAK,EAAC,MAAM,CAAC,UAAU,CAAC;QAC9B,MAAM,EAAE,iBAAiB;KACzB,CAAC;AACH,CAAC;AAED;;;;;;GAMG;AACH,SAAS,eAAe,CAAC,IAAuB,EAAE,MAAsB;IACvE,IAAA,iBAAM,EAAC,MAAM,CAAC,IAAI,KAAK,yBAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;IAChF,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,EAAE;QAC9C,MAAM,IAAI,qBAAU,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,IAAA,gBAAK,EAAC,IAAA,6BAAY,EAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC;YAEpE,0FAA0F;YAC1F,6EAA6E;YAC7E,IAAA,iBAAM,EAAC,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,IAAA,gBAAK,EAAC,MAAM,CAAC,UAAU,CAAC;QAC9B,MAAM;KACN,CAAC;AACH,CAAC;AAED,SAAS,oBAAoB,CAAC,MAAsB,EAAE,GAAa;IAClE,IAAA,iBAAM,EAAC,MAAM,CAAC,IAAI,KAAK,yBAAQ,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,IAAA,eAAI,EAAC,UAAU,GAAG,0BAA0B,MAAM,CAAC,UAAU,IAAI,CAAC,CAAC;KACnE;SAAM;QACN,OAAO,IAAA,qCAAoB,EAAC,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,qBAAU,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,IAAA,iBAAM,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;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,qBAAU,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,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;AAXD,4CAWC;AAED;;;;;;GAMG;AACH,SAAS,wBAAwB,CAChC,MAAsB,EACtB,IAA+B;IAE/B,IAAA,iBAAM,EACL,IAAI,KAAK,SAAS,EAClB,KAAK,CAAC,0FAA0F,CAChG,CAAC;IAEF,IAAI,IAAA,sBAAW,EAAC,IAAI,CAAC,EAAE;QACtB,OAAO,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;KACjC;IACD,IAAI,MAAM,CAAC,IAAI,KAAK,yBAAQ,CAAC,IAAI,EAAE;QAClC,OAAO,KAAK,CAAC;KACb;IAED,IAAI,yBAAc,IAAI,IAAI,EAAE;QAC3B,OAAO,IAAI,CAAC,yBAAc,CAAC,KAAK,MAAM,CAAC,UAAU,CAAC;KAClD;IAED,IAAI,IAAA,0BAAe,EAAC,IAAI,CAAC,EAAE;QAC1B,OAAO,MAAM,CAAC,IAAI,KAAK,yBAAQ,CAAC,KAAK,CAAC;KACtC;IACD,IAAI,MAAM,CAAC,IAAI,KAAK,yBAAQ,CAAC,KAAK,EAAE;QACnC,OAAO,KAAK,CAAC;KACb;IAED,IAAI,IAAI,YAAY,GAAG,EAAE;QACxB,OAAO,MAAM,CAAC,IAAI,KAAK,yBAAQ,CAAC,GAAG,CAAC;KACpC;IACD,IAAI,MAAM,CAAC,IAAI,KAAK,yBAAQ,CAAC,GAAG,EAAE;QACjC,OAAO,KAAK,CAAC;KACb;IAED,4BAA4B;IAC5B,IAAI,MAAM,CAAC,IAAI,KAAK,yBAAQ,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,IAAA,qCAAoB,EAAC,WAAW,CAAC,CAAC;QAChE,IAAI,IAAI,CAAC,QAAQ,CAAC,KAAK,SAAS,IAAI,qBAAqB,CAAC,IAAI,KAAK,0BAAS,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,yBAAQ,CAAC,IAAI,EAAE;QAClC,OAAO,IAAA,4BAAiB,EAAC,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/dist/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/dist/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"}

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

@@ -1 +1 @@
-{"version":3,"file":"tree.js","sourceRoot":"","sources":["../../src/simple-tree/tree.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AA2DH;;;GAGG;AACH,MAAa,iBAAiB;IAC7B;;;;;;OAMG;IACH,YACiB,MAAe,EACf,WAAgE;QADhE,WAAM,GAAN,MAAM,CAAS;QACf,gBAAW,GAAX,WAAW,CAAqD;IAC9E,CAAC;CACJ;AAZD,8CAYC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IChannel } from \"@fluidframework/datastore-definitions\";\nimport { ISubscribable } from \"../events/index.js\";\nimport { IDisposable } from \"../util/index.js\";\nimport {\n\tImplicitFieldSchema,\n\tInsertableTreeFieldFromImplicitField,\n\tTreeFieldFromImplicitField,\n} from \"./schemaTypes.js\";\n\n/**\n * Channel for a Fluid Tree DDS.\n * @remarks\n * Allows storing and collaboratively editing schema-aware hierarchial data.\n * @public\n */\nexport interface ITree extends IChannel {\n\t/**\n\t * Returns a {@link TreeView} using the provided schema.\n\t * If the tree's stored schema is compatible, this will provide a schema-aware API for accessing the tree's content.\n\t * If the provided schema is incompatible with the stored data, the view will instead expose an error indicating the incompatibility.\n\t *\n\t * @remarks\n\t * If the tree is uninitialized (has no schema and no content), the tree is initialized with the `initialTree` and\n\t * view `schema` in the provided `config`.\n\t *\n\t * The tree (now known to have been initialized) has its stored schema checked against the provided view schema.\n\t *\n\t * If the schemas are compatible, the returned {@link TreeView} will expose the root with a schema-aware API based on the provided view schema.\n\t *\n\t * If the schemas are not compatible, the view will indicate the error.\n\t *\n\t * Note that other clients can modify the document at any time, causing the view to enter or leave this error state: see {@link TreeView.events} for how to handle invalidation in these cases.\n\t *\n\t * Only one schematized view may exist for a given ITree at a time.\n\t * If creating a second, the first must be disposed before calling `schematize` again.\n\t *\n\t * @privateRemarks\n\t * TODO: Provide a way to make a generic view schema for any document.\n\t * TODO: Support adapters for handling out-of-schema data.\n\t *\n\t * Doing initialization here allows a small API that is hard to use incorrectly.\n\t * Other approaches tend to have easy-to-make mistakes.\n\t * For example, having a separate initialization function means apps can forget to call it, making an app that can only open existing documents,\n\t * or call it unconditionally leaving an app that can only create new documents.\n\t * It also would require the schema to be passed into separate places and could cause issues if they didn't match.\n\t * Since the initialization function couldn't return a typed tree, the type checking wouldn't help catch that.\n\t * Also, if an app manages to create a document, but the initialization fails to get persisted, an app that only calls the initialization function\n\t * on the create code-path (for example how a schematized factory might do it),\n\t * would leave the document in an unusable state which could not be repaired when it is reopened (by the same or other clients).\n\t * Additionally, once out of schema content adapters are properly supported (with lazy document updates),\n\t * this initialization could become just another out of schema content adapter and this initialization is no longer a special case.\n\t */\n\tschematize<TRoot extends ImplicitFieldSchema>(\n\t\tconfig: TreeConfiguration<TRoot>,\n\t): TreeView<TreeFieldFromImplicitField<TRoot>>;\n}\n\n/**\n * Configuration for how to {@link ITree.schematize|schematize} a tree.\n * @public\n */\nexport class TreeConfiguration<TSchema extends ImplicitFieldSchema = ImplicitFieldSchema> {\n\t/**\n\t * @param schema - The schema which the application wants to view the tree with.\n\t * @param initialTree - A function that returns the default tree content to initialize the tree with iff the tree is uninitialized\n\t * (meaning it does not even have any schema set at all).\n\t * If `initialTree` returns any actual node instances, they should be recreated each time `initialTree` runs.\n\t * This is because if the config is used a second time any nodes that were not recreated could error since nodes cannot be inserted into the tree multiple times.\n\t */\n\tpublic constructor(\n\t\tpublic readonly schema: TSchema,\n\t\tpublic readonly initialTree: () => InsertableTreeFieldFromImplicitField<TSchema>,\n\t) {}\n}\n\n/**\n * An editable view of a (version control style) branch of a shared tree.\n *\n * This view is always in one of two states:\n * 1. In schema: the stored schema is compatible with the provided view schema. There is no error, and root can be used.\n * 2. Out of schema: the stored schema is incompatible with the provided view schema. There is an error, and root cannot be used.\n *\n * @privateRemarks\n * From an API design perspective, `upgradeSchema` could be merged into `schematize` anb/or `schematize` could return errors explicitly.\n * Such approaches would make it discoverable that out of schema handling may need to be done.\n * Doing that would however complicate trivial \"hello world\" style example slightly, as well as be a breaking API change.\n * It also seems more complex to handle invalidation with that pattern.\n * Thus this design was chosen at the risk of apps blindly accessing `root` then breaking unexpectedly when the document is incompatible.\n * If this does become a problem,\n * 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.\n * @public\n */\nexport interface TreeView<in out TRoot> extends IDisposable {\n\t/**\n\t * The current root of the tree.\n\t *\n\t * If in the out of schema state, accessing this will throw.\n\t * To handle this case, check `error` before using.\n\t *\n\t * To get notified about changes to this field (including to it being in an `error` state),\n\t * use {@link TreeViewEvents.rootChanged} via `view.events.on(\"rootChanged\", callback)`.\n\t */\n\treadonly root: TRoot;\n\n\t/**\n\t * Description of the error state, if any.\n\t * When this is undefined, the view schema and stored schema are compatible, and `root` can be used.\n\t */\n\treadonly error?: SchemaIncompatible;\n\n\t/**\n\t * When there is an `error` and {@link SchemaIncompatible.canUpgrade} is true,\n\t * this can be used to modify the stored schema to make it match the view schema.\n\t * This will clear the error state, and allow access to `root`.\n\t * @remarks\n\t * It is an error to call this when {@link SchemaIncompatible.canUpgrade} is false, and a no-op when not in an `error` state.\n\t * When this changes the stored schema, any existing or future clients which were compatible with the old stored schema will get an `error` state when trying to schematize the document.\n\t * @privateRemarks\n\t * In the future, more upgrade options could be provided here.\n\t * Some options that could be added:\n\t * - check the actual document contents (not just the schema) and attempt an atomic document update if the data is compatible.\n\t * - apply converters and upgrade the document.\n\t * - apply converters to lazily to adapt the document to the requested view schema (with optional lazy schema updates or transparent conversions on write).\n\t */\n\tupgradeSchema(): void;\n\n\t/**\n\t * Events for the tree.\n\t */\n\treadonly events: ISubscribable<TreeViewEvents>;\n}\n\n/**\n * Information about how a view schema was incompatible.\n * @public\n */\nexport interface SchemaIncompatible {\n\t/**\n\t * True iff the view schema supports all possible documents permitted by the stored schema.\n\t *\n\t * @remarks\n\t * When true, this is still an error because the view schema supports more documents than the stored schema.\n\t * This means that writes to the document using the view schema could make the document violate its stored schema.\n\t * In this case, the stored schema could be updated to match the provided view schema, allowing read write access to the tree.\n\t *\n\t * Future version of SharedTree may provide readonly access to the document in this case because that would be safe:\n\t * but this is not currently supported.\n\t */\n\treadonly canUpgrade: boolean;\n}\n\n/**\n * Events for {@link TreeView}.\n * @public\n */\nexport interface TreeViewEvents {\n\t/**\n\t * A batch of changes has finished processing and the view has been updated.\n\t */\n\tafterBatch(): void;\n\n\t/**\n\t * {@link TreeView.root} has changed.\n\t * This includes going into or out of an `error` state where the root is unavailable due to stored schema changes.\n\t * It also includes changes to the field containing the root such as setting or clearing an optional root or changing which node is the root.\n\t * This does NOT include changes to the content (fields/children) of the root node: for that case subscribe to events on the root node.\n\t */\n\trootChanged(): void;\n}\n"]}
+{"version":3,"file":"tree.js","sourceRoot":"","sources":["../../src/simple-tree/tree.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AA+DH;;;GAGG;AACH,MAAa,iBAAiB;IAC7B;;;;;;OAMG;IACH,YACiB,MAAe,EACf,WAAgE;QADhE,WAAM,GAAN,MAAM,CAAS;QACf,gBAAW,GAAX,WAAW,CAAqD;IAC9E,CAAC;CACJ;AAZD,8CAYC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { IChannel } from \"@fluidframework/datastore-definitions\";\n\nimport { CommitMetadata } from \"../core/index.js\";\nimport { ISubscribable } from \"../events/index.js\";\nimport { RevertibleFactory } from \"../shared-tree/index.js\";\nimport { IDisposable } from \"../util/index.js\";\n\nimport {\n\tImplicitFieldSchema,\n\tInsertableTreeFieldFromImplicitField,\n\tTreeFieldFromImplicitField,\n} from \"./schemaTypes.js\";\n\n/**\n * Channel for a Fluid Tree DDS.\n * @remarks\n * Allows storing and collaboratively editing schema-aware hierarchial data.\n * @public\n */\nexport interface ITree extends IChannel {\n\t/**\n\t * Returns a {@link TreeView} using the provided schema.\n\t * If the tree's stored schema is compatible, this will provide a schema-aware API for accessing the tree's content.\n\t * If the provided schema is incompatible with the stored data, the view will instead expose an error indicating the incompatibility.\n\t *\n\t * @remarks\n\t * If the tree is uninitialized (has no schema and no content), the tree is initialized with the `initialTree` and\n\t * view `schema` in the provided `config`.\n\t *\n\t * The tree (now known to have been initialized) has its stored schema checked against the provided view schema.\n\t *\n\t * If the schemas are compatible, the returned {@link TreeView} will expose the root with a schema-aware API based on the provided view schema.\n\t *\n\t * If the schemas are not compatible, the view will indicate the error.\n\t *\n\t * Note that other clients can modify the document at any time, causing the view to enter or leave this error state: see {@link TreeView.events} for how to handle invalidation in these cases.\n\t *\n\t * Only one schematized view may exist for a given ITree at a time.\n\t * If creating a second, the first must be disposed before calling `schematize` again.\n\t *\n\t * @privateRemarks\n\t * TODO: Provide a way to make a generic view schema for any document.\n\t * TODO: Support adapters for handling out-of-schema data.\n\t *\n\t * Doing initialization here allows a small API that is hard to use incorrectly.\n\t * Other approaches tend to have easy-to-make mistakes.\n\t * For example, having a separate initialization function means apps can forget to call it, making an app that can only open existing documents,\n\t * or call it unconditionally leaving an app that can only create new documents.\n\t * It also would require the schema to be passed into separate places and could cause issues if they didn't match.\n\t * Since the initialization function couldn't return a typed tree, the type checking wouldn't help catch that.\n\t * Also, if an app manages to create a document, but the initialization fails to get persisted, an app that only calls the initialization function\n\t * on the create code-path (for example how a schematized factory might do it),\n\t * would leave the document in an unusable state which could not be repaired when it is reopened (by the same or other clients).\n\t * Additionally, once out of schema content adapters are properly supported (with lazy document updates),\n\t * this initialization could become just another out of schema content adapter and this initialization is no longer a special case.\n\t */\n\tschematize<TRoot extends ImplicitFieldSchema>(\n\t\tconfig: TreeConfiguration<TRoot>,\n\t): TreeView<TRoot>;\n}\n\n/**\n * Configuration for how to {@link ITree.schematize|schematize} a tree.\n * @public\n */\nexport class TreeConfiguration<TSchema extends ImplicitFieldSchema = ImplicitFieldSchema> {\n\t/**\n\t * @param schema - The schema which the application wants to view the tree with.\n\t * @param initialTree - A function that returns the default tree content to initialize the tree with iff the tree is uninitialized\n\t * (meaning it does not even have any schema set at all).\n\t * If `initialTree` returns any actual node instances, they should be recreated each time `initialTree` runs.\n\t * This is because if the config is used a second time any nodes that were not recreated could error since nodes cannot be inserted into the tree multiple times.\n\t */\n\tpublic constructor(\n\t\tpublic readonly schema: TSchema,\n\t\tpublic readonly initialTree: () => InsertableTreeFieldFromImplicitField<TSchema>,\n\t) {}\n}\n\n/**\n * An editable view of a (version control style) branch of a shared tree.\n *\n * This view is always in one of two states:\n * 1. In schema: the stored schema is compatible with the provided view schema. There is no error, and root can be used.\n * 2. Out of schema: the stored schema is incompatible with the provided view schema. There is an error, and root cannot be used.\n *\n * @privateRemarks\n * From an API design perspective, `upgradeSchema` could be merged into `schematize` anb/or `schematize` could return errors explicitly.\n * Such approaches would make it discoverable that out of schema handling may need to be done.\n * Doing that would however complicate trivial \"hello world\" style example slightly, as well as be a breaking API change.\n * It also seems more complex to handle invalidation with that pattern.\n * Thus this design was chosen at the risk of apps blindly accessing `root` then breaking unexpectedly when the document is incompatible.\n * If this does become a problem,\n * 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.\n * @public\n */\nexport interface TreeView<TSchema extends ImplicitFieldSchema> extends IDisposable {\n\t/**\n\t * The current root of the tree.\n\t *\n\t * If in the out of schema state, accessing this will throw.\n\t * To handle this case, check `error` before using.\n\t *\n\t * To get notified about changes to this field (including to it being in an `error` state),\n\t * use {@link TreeViewEvents.rootChanged} via `view.events.on(\"rootChanged\", callback)`.\n\t */\n\tget root(): TreeFieldFromImplicitField<TSchema>;\n\n\tset root(newRoot: InsertableTreeFieldFromImplicitField<TSchema>);\n\n\t/**\n\t * Description of the error state, if any.\n\t * When this is undefined, the view schema and stored schema are compatible, and `root` can be used.\n\t */\n\treadonly error?: SchemaIncompatible;\n\n\t/**\n\t * When there is an `error` and {@link SchemaIncompatible.canUpgrade} is true,\n\t * this can be used to modify the stored schema to make it match the view schema.\n\t * This will clear the error state, and allow access to `root`.\n\t * @remarks\n\t * It is an error to call this when {@link SchemaIncompatible.canUpgrade} is false, and a no-op when not in an `error` state.\n\t * When this changes the stored schema, any existing or future clients which were compatible with the old stored schema will get an `error` state when trying to schematize the document.\n\t * @privateRemarks\n\t * In the future, more upgrade options could be provided here.\n\t * Some options that could be added:\n\t * - check the actual document contents (not just the schema) and attempt an atomic document update if the data is compatible.\n\t * - apply converters and upgrade the document.\n\t * - apply converters to lazily to adapt the document to the requested view schema (with optional lazy schema updates or transparent conversions on write).\n\t */\n\tupgradeSchema(): void;\n\n\t/**\n\t * Events for the tree.\n\t */\n\treadonly events: ISubscribable<TreeViewEvents>;\n}\n\n/**\n * Information about how a view schema was incompatible.\n * @public\n */\nexport interface SchemaIncompatible {\n\t/**\n\t * True iff the view schema supports all possible documents permitted by the stored schema.\n\t *\n\t * @remarks\n\t * When true, this is still an error because the view schema supports more documents than the stored schema.\n\t * This means that writes to the document using the view schema could make the document violate its stored schema.\n\t * In this case, the stored schema could be updated to match the provided view schema, allowing read write access to the tree.\n\t *\n\t * Future version of SharedTree may provide readonly access to the document in this case because that would be safe:\n\t * but this is not currently supported.\n\t */\n\treadonly canUpgrade: boolean;\n}\n\n/**\n * Events for {@link TreeView}.\n * @public\n */\nexport interface TreeViewEvents {\n\t/**\n\t * A batch of changes has finished processing and the view has been updated.\n\t */\n\tafterBatch(): void;\n\n\t/**\n\t * {@link TreeView.root} has changed.\n\t * This includes going into or out of an `error` state where the root is unavailable due to stored schema changes.\n\t * It also includes changes to the field containing the root such as setting or clearing an optional root or changing which node is the root.\n\t * This does NOT include changes to the content (fields/children) of the root node: for that case subscribe to events on the root node.\n\t */\n\trootChanged(): void;\n\n\t/**\n\t * Fired when:\n\t * - a local commit is applied outside of a transaction\n\t * - a local transaction is committed\n\t *\n\t * The event is not fired when:\n\t * - a local commit is applied within a transaction\n\t * - a remote commit is applied\n\t *\n\t * @param data - information about the commit that was applied\n\t * @param getRevertible - a function provided that allows users to get a revertible for the commit that was applied. If not provided,\n\t * this commit is not revertible.\n\t */\n\tcommitApplied(data: CommitMetadata, getRevertible?: RevertibleFactory): void;\n}\n"]}

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

@@ -3,8 +3,8 @@
  * Licensed under the MIT License.
  */
 import { TreeStatus } from "../feature-libraries/index.js";
+import { NodeFromSchema, NodeKind, type TreeLeafValue, TreeNodeSchema } from "./schemaTypes.js";
 import { TreeNode } from "./types.js";
-import { NodeFromSchema, NodeKind, TreeNodeSchema, TreeLeafValue } from "./schemaTypes.js";
 /**
  * Provides various functions for analyzing {@link TreeNode}s.
  *
@@ -42,14 +42,22 @@ export interface TreeNodeApi {
     key(node: TreeNode): string | number;
     /**
      * Register an event listener on the given node.
+     * @param node - The node whose events should be subscribed to.
+     * @param eventName - Which event to subscribe to.
+     * @param listener - The callback to trigger for the event. The tree can be read during the callback, but it is invalid to modify the tree during this callback.
      * @returns A callback function which will deregister the event.
      * This callback should be called only once.
      */
-    on<K extends keyof TreeNodeEvents>(node: TreeNode, eventName: K, listener: TreeNodeEvents[K]): () => void;
+    on<K extends keyof TreeChangeEvents>(node: TreeNode, eventName: K, listener: TreeChangeEvents[K]): () => void;
     /**
      * Returns the {@link TreeStatus} of the given node.
      */
     readonly status: (node: TreeNode) => TreeStatus;
+    /**
+     * If the given node has an identifier specified by a field of kind "identifier" then this returns the compressed form of that identifier.
+     * Otherwise returns undefined.
+     */
+    shortId(node: TreeNode): number | undefined;
 }
 /**
  * The `Tree` object holds various functions for analyzing {@link TreeNode}s.
@@ -57,12 +65,81 @@ export interface TreeNodeApi {
 export declare const treeNodeApi: TreeNodeApi;
 /**
  * A collection of events that can be raised by a {@link TreeNode}.
+ *
+ * @privateRemarks
+ * TODO: add a way to subscribe to a specific field (for nodeChanged and treeChanged).
+ * Probably have object node and map node specific APIs for this.
+ *
+ * TODO: ensure that subscription API for fields aligns with API for subscribing to the root.
+ *
+ * TODO: add more wider area (avoid needing tons of nodeChanged registration) events for use-cases other than treeChanged.
+ * Some ideas:
+ *
+ * - treeChanged, but with some subtrees/fields/paths excluded
+ * - helper to batch several nodeChanged calls to a treeChanged scope
+ * - parent change (ex: registration on the parent field for a specific index: maybe allow it for a range. Ex: node event takes optional field and optional index range?)
+ * - new content inserted into subtree. Either provide event for this and/or enough info to treeChanged to find and search the new sub-trees.
+ * Add separate (non event related) API to efficiently scan tree for given set of types (using low level cursor and schema based filtering)
+ * to allow efficiently searching for new content (and initial content) of a given type.
+ *
  * @public
  */
-export interface TreeNodeEvents {
+export interface TreeChangeEvents {
+    /**
+     * Emitted by a node when a batch of changes is applied to it, where a change is:
+     *
+     * - For an object node, when the value of one of its properties changes (i.e., the property's value is set
+     * to something else, including `undefined`).
+     *
+     * - For an array node, when an element is added, removed, or moved.
+     *
+     * - For a map node, when an entry is added, updated, or removed.
+     *
+     * @remarks
+     * This event is not raised when:
+     *
+     * - Properties of a child node change. Notably, updates to an array node or a map node (like adding or removing
+     * elements/entries) will raise this event on the array/map node itself, but not on the node that contains the
+     * array/map node as one of its properties.
+     *
+     * - The node is moved to a different location in the tree or removed from the tree.
+     * In this case the event is raised on the _parent_ node, not the node itself.
+     *
+     * For remote edits, this event is not guaranteed to occur in the same order or quantity that it did in
+     * the client that made the original edit.
+     * While a batch of edits will as a whole update the tree to the appropriate end state, no guarantees are made about
+     * how many times this event will be raised during any intermediate states.
+     * When it is raised, the tree is guaranteed to be in-schema.
+     *
+     * @privateRemarks
+     * This event occurs whenever the apparent contents of the node instance change, regardless of what caused the change.
+     * For example, it will fire when the local client reassigns a child, when part of a remote edit is applied to the
+     * node, or when the node has to be updated due to resolution of a merge conflict
+     * (for example a previously applied local change might be undone, then reapplied differently or not at all).
+     */
+    nodeChanged(): void;
     /**
-     * Raised on a node right after a change is applied to one of its fields or the fields of a descendant node.
+     * Emitted by a node when something _may_ have changed anywhere in the subtree rooted at it.
+     *
+     * @remarks
+     * This event is guaranteed to be emitted whenever the subtree _has_ changed.
+     * However, it might also be emitted when the subtree has no visible changes compared to before the event firing.
+     *
+     * Consumers of this event have the guarantee that they won't miss any changes, but should also handle the scenario
+     * where the event fires with no visible changes as well.
+     *
+     * This event is not raised when the node itself is moved to a different location in the tree or removed from the tree.
+     * In that case it is raised on the _parent_ node, not the node itself.
+     *
+     * The node itself is part of the subtree, so this event will be emitted even if the only changes are to the properties
+     * of the node itself.
+     *
+     * For remote edits, this event is not guaranteed to occur in the same order or quantity that it did in
+     * the client that made the original edit.
+     * While a batch of edits will as a whole update the tree to the appropriate end state, no guarantees are made about
+     * how many times this event will be raised during any intermediate states.
+     * When it is raised, the tree is guaranteed to be in-schema.
      */
-    afterChange(): void;
+    treeChanged(): void;
 }
 //# sourceMappingURL=treeApi.d.ts.map

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

@@ -1 +1 @@
-{"version":3,"file":"treeApi.d.ts","sourceRoot":"","sources":["../../src/simple-tree/treeApi.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,EAIN,UAAU,EAGV,MAAM,+BAA+B,CAAC;AACvC,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAItC,OAAO,EAAE,cAAc,EAAE,QAAQ,EAAE,cAAc,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAG3F;;;;;;;;GAQG;AACH,MAAM,WAAW,WAAW;IAC3B;;OAEG;IACH,MAAM,CAAC,CAAC,SAAS,QAAQ,GAAG,aAAa,EACxC,IAAI,EAAE,CAAC,GACL,cAAc,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;IAChD;;;;;;;;OAQG;IACH,EAAE,CAAC,OAAO,SAAS,cAAc,EAChC,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,OAAO,GACb,KAAK,IAAI,cAAc,CAAC,OAAO,CAAC,CAAC;IACpC;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;IAC7C;;;;;OAKG;IACH,GAAG,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC;IACrC;;;;OAIG;IACH,EAAE,CAAC,CAAC,SAAS,MAAM,cAAc,EAChC,IAAI,EAAE,QAAQ,EACd,SAAS,EAAE,CAAC,EACZ,QAAQ,EAAE,cAAc,CAAC,CAAC,CAAC,GACzB,MAAM,IAAI,CAAC;IACd;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,UAAU,CAAC;CAChD;AAED;;GAEG;AACH,eAAO,MAAM,WAAW,EAAE,WAyDzB,CAAC;AAEF;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC9B;;OAEG;IACH,WAAW,IAAI,IAAI,CAAC;CACpB"}
+{"version":3,"file":"treeApi.d.ts","sourceRoot":"","sources":["../../src/simple-tree/treeApi.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EAIN,UAAU,EAGV,MAAM,+BAA+B,CAAC;AAOvC,OAAO,EACN,cAAc,EACd,QAAQ,EACR,KAAK,aAAa,EAClB,cAAc,EAGd,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC;;;;;;;;GAQG;AACH,MAAM,WAAW,WAAW;IAC3B;;OAEG;IACH,MAAM,CAAC,CAAC,SAAS,QAAQ,GAAG,aAAa,EACxC,IAAI,EAAE,CAAC,GACL,cAAc,CAAC,MAAM,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC,CAAC;IAEhD;;;;;;;;OAQG;IACH,EAAE,CAAC,OAAO,SAAS,cAAc,EAChC,KAAK,EAAE,OAAO,EACd,MAAM,EAAE,OAAO,GACb,KAAK,IAAI,cAAc,CAAC,OAAO,CAAC,CAAC;IAEpC;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,SAAS,CAAC;IAE7C;;;;;OAKG;IACH,GAAG,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,MAAM,CAAC;IAErC;;;;;;;OAOG;IACH,EAAE,CAAC,CAAC,SAAS,MAAM,gBAAgB,EAClC,IAAI,EAAE,QAAQ,EACd,SAAS,EAAE,CAAC,EACZ,QAAQ,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAC3B,MAAM,IAAI,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,QAAQ,KAAK,UAAU,CAAC;IAEhD;;;OAGG;IACH,OAAO,CAAC,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,SAAS,CAAC;CAC5C;AAED;;GAEG;AACH,eAAO,MAAM,WAAW,EAAE,WAkGzB,CAAC;AAmDF;;;;;;;;;;;;;;;;;;;;GAoBG;AACH,MAAM,WAAW,gBAAgB;IAChC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA+BG;IACH,WAAW,IAAI,IAAI,CAAC;IAEpB;;;;;;;;;;;;;;;;;;;;;OAqBG;IACH,WAAW,IAAI,IAAI,CAAC;CACpB"}

package/dist/simple-tree/treeApi.js

@@ -5,52 +5,130 @@
  */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.treeNodeApi = void 0;
-const core_utils_1 = require("@fluidframework/core-utils");
-const index_js_1 = require("../feature-libraries/index.js");
-const flexNode_js_1 = require("./flexNode.js");
+const internal_1 = require("@fluidframework/core-utils/internal");
+const index_js_1 = require("../core/index.js");
+const index_js_2 = require("../feature-libraries/index.js");
+const index_js_3 = require("../util/index.js");
 const proxies_js_1 = require("./proxies.js");
+const proxyBinding_js_1 = require("./proxyBinding.js");
+const schemaCaching_js_1 = require("./schemaCaching.js");
 const schemaFactory_js_1 = require("./schemaFactory.js");
+const schemaTypes_js_1 = require("./schemaTypes.js");
 const toFlexSchema_js_1 = require("./toFlexSchema.js");
 /**
  * The `Tree` object holds various functions for analyzing {@link TreeNode}s.
  */
 exports.treeNodeApi = {
     parent: (node) => {
-        const editNode = (0, flexNode_js_1.getFlexNode)(node).parentField.parent.parent;
+        const editNode = (0, proxyBinding_js_1.getFlexNode)(node).parentField.parent.parent;
         if (editNode === undefined) {
             return undefined;
         }
         const output = (0, proxies_js_1.getOrCreateNodeProxy)(editNode);
-        (0, core_utils_1.assert)(!(0, index_js_1.isTreeValue)(output), 0x87f /* Parent can't be a leaf, so it should be a node not a value */);
+        (0, internal_1.assert)(!(0, index_js_2.isTreeValue)(output), 0x87f /* Parent can't be a leaf, so it should be a node not a value */);
         return output;
     },
     key: (node) => {
-        const parentField = (0, flexNode_js_1.getFlexNode)(node).parentField;
-        if (parentField.parent.schema.kind.multiplicity === index_js_1.Multiplicity.Sequence) {
-            // The parent of `node` is an array node
-            return parentField.index;
+        // If the parent is undefined, then this node is under the root field,
+        // so we know its key is the special root one.
+        const parent = exports.treeNodeApi.parent(node);
+        if (parent === undefined) {
+            return index_js_1.rootFieldKey;
         }
-        // The parent of `node` is an object, a map, or undefined (and therefore `node` is a root/detached node).
-        return parentField.parent.key;
+        // The flex-domain strictly operates in terms of "stored keys".
+        // To find the associated developer-facing "view key", we need to look up the field associated with
+        // the stored key from the flex-domain, and get view key its simple-domain counterpart was created with.
+        const storedKey = getStoredKey(node);
+        const parentSchema = exports.treeNodeApi.schema(parent);
+        const viewKey = getViewKeyFromStoredKey(parentSchema, storedKey);
+        return viewKey;
     },
     on: (node, eventName, listener) => {
-        return (0, flexNode_js_1.getFlexNode)(node).on(eventName, listener);
+        const flex = (0, proxyBinding_js_1.getFlexNode)(node);
+        const anchor = flex.anchorNode;
+        switch (eventName) {
+            case "nodeChanged": {
+                let unsubscribeFromTreeChanged;
+                return anchor.on("childrenChanged", () => {
+                    if (unsubscribeFromTreeChanged === undefined) {
+                        unsubscribeFromTreeChanged = anchor.on("subtreeChanged", () => {
+                            listener();
+                            unsubscribeFromTreeChanged?.();
+                            unsubscribeFromTreeChanged = undefined;
+                        });
+                    }
+                });
+            }
+            case "treeChanged":
+                return anchor.on("subtreeChanged", () => listener());
+            default:
+                return (0, internal_1.unreachableCase)(eventName);
+        }
     },
     status: (node) => {
-        return (0, flexNode_js_1.getFlexNode)(node, true).treeStatus();
+        return (0, proxyBinding_js_1.getFlexNode)(node, true).treeStatus();
     },
     is: (value, schema) => {
         const flexSchema = (0, toFlexSchema_js_1.getFlexSchema)(schema);
-        if ((0, index_js_1.isTreeValue)(value)) {
-            return (flexSchema instanceof index_js_1.LeafNodeSchema && (0, index_js_1.valueSchemaAllows)(flexSchema.info, value));
+        if ((0, index_js_2.isTreeValue)(value)) {
+            return (flexSchema instanceof index_js_2.LeafNodeSchema && (0, index_js_2.valueSchemaAllows)(flexSchema.info, value));
         }
-        return (0, flexNode_js_1.tryGetFlexNode)(value)?.is(flexSchema) ?? false;
+        return (0, proxyBinding_js_1.tryGetFlexNode)(value)?.is(flexSchema) ?? false;
     },
     schema(node) {
-        if ((0, index_js_1.isTreeValue)(node)) {
+        if ((0, index_js_2.isTreeValue)(node)) {
             return (0, schemaFactory_js_1.schemaFromValue)(node);
         }
-        return (0, proxies_js_1.getClassSchema)((0, flexNode_js_1.getFlexNode)(node).schema);
+        return (0, schemaCaching_js_1.tryGetSimpleNodeSchema)((0, proxyBinding_js_1.getFlexNode)(node).schema);
+    },
+    shortId(node) {
+        const flexNode = (0, proxyBinding_js_1.getFlexNode)(node);
+        for (const field of flexNode.boxedIterator()) {
+            if (field.schema.kind === index_js_2.FieldKinds.identifier) {
+                const identifier = field.boxedAt(0);
+                (0, internal_1.assert)(identifier !== undefined, 0x927 /* The identifier must exist */);
+                return (0, index_js_3.extractFromOpaque)(identifier.context.nodeKeys.localize(identifier.value));
+            }
+        }
     },
 };
+/**
+ * Gets the stored key with which the provided node is associated in the parent.
+ */
+function getStoredKey(node) {
+    // Note: the flex domain strictly works with "stored keys", and knows nothing about the developer-facing
+    // "view keys".
+    const parentField = (0, proxyBinding_js_1.getFlexNode)(node).parentField;
+    if (parentField.parent.schema.kind.multiplicity === index_js_1.Multiplicity.Sequence) {
+        // The parent of `node` is an array node
+        return parentField.index;
+    }
+    // The parent of `node` is an object, a map, or undefined (and therefore `node` is a root/detached node).
+    return parentField.parent.key;
+}
+/**
+ * Given a node schema, gets the view key corresponding with the provided {@link FieldProps.key | stored key}.
+ */
+function getViewKeyFromStoredKey(schema, storedKey) {
+    // Only object nodes have the concept of a "stored key", differentiated from the developer-facing "view key".
+    // For any other kind of node, the stored key and the view key are the same.
+    if (schema.kind !== schemaTypes_js_1.NodeKind.Object) {
+        return storedKey;
+    }
+    const fields = schema.info;
+    // Invariants:
+    // - The set of all view keys under an object must be unique.
+    // - The set of all stored keys (including those implicitly created from view keys) must be unique.
+    // To find the view key associated with the provided stored key, first check for any stored key matches (which are optionally populated).
+    // If we don't find any, then search for a matching view key.
+    for (const [viewKey, fieldSchema] of Object.entries(fields)) {
+        if (fieldSchema instanceof schemaTypes_js_1.FieldSchema && fieldSchema.props?.key === storedKey) {
+            return viewKey;
+        }
+    }
+    if (fields[storedKey] === undefined) {
+        (0, index_js_3.fail)("Existing stored key should always map to a view key");
+    }
+    return storedKey;
+}
 //# sourceMappingURL=treeApi.js.map

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

@@ -1 +1 @@
-{"version":3,"file":"treeApi.js","sourceRoot":"","sources":["../../src/simple-tree/treeApi.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2DAAoD;AAEpD,4DAOuC;AAEvC,+CAA4D;AAC5D,6CAAoE;AACpE,yDAAqD;AAErD,uDAAkD;AA0DlD;;GAEG;AACU,QAAA,WAAW,GAAgB;IACvC,MAAM,EAAE,CAAC,IAAc,EAAwB,EAAE;QAChD,MAAM,QAAQ,GAAG,IAAA,yBAAW,EAAC,IAAI,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC;QAC7D,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC3B,OAAO,SAAS,CAAC;SACjB;QAED,MAAM,MAAM,GAAG,IAAA,iCAAoB,EAAC,QAAQ,CAAC,CAAC;QAC9C,IAAA,mBAAM,EACL,CAAC,IAAA,sBAAW,EAAC,MAAM,CAAC,EACpB,KAAK,CAAC,gEAAgE,CACtE,CAAC;QACF,OAAO,MAAM,CAAC;IACf,CAAC;IACD,GAAG,EAAE,CAAC,IAAc,EAAE,EAAE;QACvB,MAAM,WAAW,GAAG,IAAA,yBAAW,EAAC,IAAI,CAAC,CAAC,WAAW,CAAC;QAClD,IAAI,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,KAAK,uBAAY,CAAC,QAAQ,EAAE;YAC1E,wCAAwC;YACxC,OAAO,WAAW,CAAC,KAAK,CAAC;SACzB;QAED,yGAAyG;QACzG,OAAO,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC;IAC/B,CAAC;IACD,EAAE,EAAE,CACH,IAAc,EACd,SAAY,EACZ,QAA+B,EAC9B,EAAE;QACH,OAAO,IAAA,yBAAW,EAAC,IAAI,CAAC,CAAC,EAAE,CAAC,SAAS,EAAE,QAAQ,CAAC,CAAC;IAClD,CAAC;IACD,MAAM,EAAE,CAAC,IAAc,EAAE,EAAE;QAC1B,OAAO,IAAA,yBAAW,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC,UAAU,EAAE,CAAC;IAC7C,CAAC;IACD,EAAE,EAAE,CACH,KAAc,EACd,MAAe,EACoB,EAAE;QACrC,MAAM,UAAU,GAAG,IAAA,+BAAa,EAAC,MAAM,CAAC,CAAC;QACzC,IAAI,IAAA,sBAAW,EAAC,KAAK,CAAC,EAAE;YACvB,OAAO,CACN,UAAU,YAAY,yBAAc,IAAI,IAAA,4BAAiB,EAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CACjF,CAAC;SACF;QACD,OAAO,IAAA,4BAAc,EAAC,KAAK,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,KAAK,CAAC;IACvD,CAAC;IACD,MAAM,CAAiC,IAAO;QAC7C,IAAI,IAAA,sBAAW,EAAC,IAAI,CAAC,EAAE;YACtB,OAAO,IAAA,kCAAe,EAAC,IAAI,CAAiD,CAAC;SAC7E;QACD,OAAO,IAAA,2BAAc,EAAC,IAAA,yBAAW,EAAC,IAAI,CAAC,CAAC,MAAM,CAK7C,CAAC;IACH,CAAC;CACD,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\";\nimport { TreeValue } from \"../core/index.js\";\nimport {\n\tEditableTreeEvents,\n\tLeafNodeSchema,\n\tMultiplicity,\n\tTreeStatus,\n\tisTreeValue,\n\tvalueSchemaAllows,\n} from \"../feature-libraries/index.js\";\nimport { TreeNode } from \"./types.js\";\nimport { getFlexNode, tryGetFlexNode } from \"./flexNode.js\";\nimport { getClassSchema, getOrCreateNodeProxy } from \"./proxies.js\";\nimport { schemaFromValue } from \"./schemaFactory.js\";\nimport { NodeFromSchema, NodeKind, TreeNodeSchema, TreeLeafValue } from \"./schemaTypes.js\";\nimport { getFlexSchema } from \"./toFlexSchema.js\";\n\n/**\n * Provides various functions for analyzing {@link TreeNode}s.\n *\n * @privateRemarks\n * Inlining the typing of this interface onto the `Tree` object provides slightly different .d.ts generation,\n * which avoids typescript expanding the type of TreeNodeSchema and thus encountering\n * https://github.com/microsoft/rushstack/issues/1958.\n * @public\n */\nexport interface TreeNodeApi {\n\t/**\n\t * The schema information for this node.\n\t */\n\tschema<T extends TreeNode | TreeLeafValue>(\n\t\tnode: T,\n\t): TreeNodeSchema<string, NodeKind, unknown, T>;\n\t/**\n\t * Narrow the type of the given value if it satisfies the given schema.\n\t * @example\n\t * ```ts\n\t * if (node.is(myNode, point)) {\n\t *     const y = myNode.y; // `myNode` is now known to satisfy the `point` schema and therefore has a `y` coordinate.\n\t * }\n\t * ```\n\t */\n\tis<TSchema extends TreeNodeSchema>(\n\t\tvalue: unknown,\n\t\tschema: TSchema,\n\t): value is NodeFromSchema<TSchema>;\n\t/**\n\t * Return the node under which this node resides in the tree (or undefined if this is a root node of the tree).\n\t */\n\tparent(node: TreeNode): TreeNode | undefined;\n\t/**\n\t * The key of the given node under its parent.\n\t * @remarks\n\t * If `node` is an element in a {@link (TreeArrayNode:interface)}, this returns the index of `node` in the array node (a `number`).\n\t * Otherwise, this returns the key of the field that it is under (a `string`).\n\t */\n\tkey(node: TreeNode): string | number;\n\t/**\n\t * Register an event listener on the given node.\n\t * @returns A callback function which will deregister the event.\n\t * This callback should be called only once.\n\t */\n\ton<K extends keyof TreeNodeEvents>(\n\t\tnode: TreeNode,\n\t\teventName: K,\n\t\tlistener: TreeNodeEvents[K],\n\t): () => void;\n\t/**\n\t * Returns the {@link TreeStatus} of the given node.\n\t */\n\treadonly status: (node: TreeNode) => TreeStatus;\n}\n\n/**\n * The `Tree` object holds various functions for analyzing {@link TreeNode}s.\n */\nexport const treeNodeApi: TreeNodeApi = {\n\tparent: (node: TreeNode): TreeNode | undefined => {\n\t\tconst editNode = getFlexNode(node).parentField.parent.parent;\n\t\tif (editNode === undefined) {\n\t\t\treturn undefined;\n\t\t}\n\n\t\tconst output = getOrCreateNodeProxy(editNode);\n\t\tassert(\n\t\t\t!isTreeValue(output),\n\t\t\t0x87f /* Parent can't be a leaf, so it should be a node not a value */,\n\t\t);\n\t\treturn output;\n\t},\n\tkey: (node: TreeNode) => {\n\t\tconst parentField = getFlexNode(node).parentField;\n\t\tif (parentField.parent.schema.kind.multiplicity === Multiplicity.Sequence) {\n\t\t\t// The parent of `node` is an array node\n\t\t\treturn parentField.index;\n\t\t}\n\n\t\t// The parent of `node` is an object, a map, or undefined (and therefore `node` is a root/detached node).\n\t\treturn parentField.parent.key;\n\t},\n\ton: <K extends keyof EditableTreeEvents>(\n\t\tnode: TreeNode,\n\t\teventName: K,\n\t\tlistener: EditableTreeEvents[K],\n\t) => {\n\t\treturn getFlexNode(node).on(eventName, listener);\n\t},\n\tstatus: (node: TreeNode) => {\n\t\treturn getFlexNode(node, true).treeStatus();\n\t},\n\tis: <TSchema extends TreeNodeSchema>(\n\t\tvalue: unknown,\n\t\tschema: TSchema,\n\t): value is NodeFromSchema<TSchema> => {\n\t\tconst flexSchema = getFlexSchema(schema);\n\t\tif (isTreeValue(value)) {\n\t\t\treturn (\n\t\t\t\tflexSchema instanceof LeafNodeSchema && valueSchemaAllows(flexSchema.info, value)\n\t\t\t);\n\t\t}\n\t\treturn tryGetFlexNode(value)?.is(flexSchema) ?? false;\n\t},\n\tschema<T extends TreeNode | TreeValue>(node: T): TreeNodeSchema<string, NodeKind, unknown, T> {\n\t\tif (isTreeValue(node)) {\n\t\t\treturn schemaFromValue(node) as TreeNodeSchema<string, NodeKind, unknown, T>;\n\t\t}\n\t\treturn getClassSchema(getFlexNode(node).schema) as TreeNodeSchema<\n\t\t\tstring,\n\t\t\tNodeKind,\n\t\t\tunknown,\n\t\t\tT\n\t\t>;\n\t},\n};\n\n/**\n * A collection of events that can be raised by a {@link TreeNode}.\n * @public\n */\nexport interface TreeNodeEvents {\n\t/**\n\t * Raised on a node right after a change is applied to one of its fields or the fields of a descendant node.\n\t */\n\tafterChange(): void;\n}\n"]}
+{"version":3,"file":"treeApi.js","sourceRoot":"","sources":["../../src/simple-tree/treeApi.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kEAA8E;AAE9E,+CAA8D;AAC9D,4DAOuC;AACvC,+CAA2D;AAE3D,6CAAoD;AACpD,uDAAgE;AAChE,yDAA4D;AAC5D,yDAAqD;AACrD,qDAO0B;AAC1B,uDAAkD;AAyElD;;GAEG;AACU,QAAA,WAAW,GAAgB;IACvC,MAAM,EAAE,CAAC,IAAc,EAAwB,EAAE;QAChD,MAAM,QAAQ,GAAG,IAAA,6BAAW,EAAC,IAAI,CAAC,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC;QAC7D,IAAI,QAAQ,KAAK,SAAS,EAAE;YAC3B,OAAO,SAAS,CAAC;SACjB;QAED,MAAM,MAAM,GAAG,IAAA,iCAAoB,EAAC,QAAQ,CAAC,CAAC;QAC9C,IAAA,iBAAM,EACL,CAAC,IAAA,sBAAW,EAAC,MAAM,CAAC,EACpB,KAAK,CAAC,gEAAgE,CACtE,CAAC;QACF,OAAO,MAAM,CAAC;IACf,CAAC;IACD,GAAG,EAAE,CAAC,IAAc,EAAE,EAAE;QACvB,sEAAsE;QACtE,8CAA8C;QAC9C,MAAM,MAAM,GAAG,mBAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QACxC,IAAI,MAAM,KAAK,SAAS,EAAE;YACzB,OAAO,uBAAY,CAAC;SACpB;QAED,+DAA+D;QAC/D,mGAAmG;QACnG,wGAAwG;QACxG,MAAM,SAAS,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;QACrC,MAAM,YAAY,GAAG,mBAAW,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAChD,MAAM,OAAO,GAAG,uBAAuB,CAAC,YAAY,EAAE,SAAS,CAAC,CAAC;QACjE,OAAO,OAAO,CAAC;IAChB,CAAC;IACD,EAAE,EAAE,CACH,IAAc,EACd,SAAY,EACZ,QAA6B,EAC5B,EAAE;QACH,MAAM,IAAI,GAAG,IAAA,6BAAW,EAAC,IAAI,CAAC,CAAC;QAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC;QAE/B,QAAQ,SAAS,EAAE;YAClB,KAAK,aAAa,CAAC,CAAC;gBACnB,IAAI,0BAAoD,CAAC;gBACzD,OAAO,MAAM,CAAC,EAAE,CAAC,iBAAiB,EAAE,GAAG,EAAE;oBACxC,IAAI,0BAA0B,KAAK,SAAS,EAAE;wBAC7C,0BAA0B,GAAG,MAAM,CAAC,EAAE,CAAC,gBAAgB,EAAE,GAAG,EAAE;4BAC7D,QAAQ,EAAE,CAAC;4BACX,0BAA0B,EAAE,EAAE,CAAC;4BAC/B,0BAA0B,GAAG,SAAS,CAAC;wBACxC,CAAC,CAAC,CAAC;qBACH;gBACF,CAAC,CAAC,CAAC;aACH;YACD,KAAK,aAAa;gBACjB,OAAO,MAAM,CAAC,EAAE,CAAC,gBAAgB,EAAE,GAAG,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAC;YACtD;gBACC,OAAO,IAAA,0BAAe,EAAC,SAAS,CAAC,CAAC;SACnC;IACF,CAAC;IACD,MAAM,EAAE,CAAC,IAAc,EAAE,EAAE;QAC1B,OAAO,IAAA,6BAAW,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC,UAAU,EAAE,CAAC;IAC7C,CAAC;IACD,EAAE,EAAE,CACH,KAAc,EACd,MAAe,EACoB,EAAE;QACrC,MAAM,UAAU,GAAG,IAAA,+BAAa,EAAC,MAAM,CAAC,CAAC;QACzC,IAAI,IAAA,sBAAW,EAAC,KAAK,CAAC,EAAE;YACvB,OAAO,CACN,UAAU,YAAY,yBAAc,IAAI,IAAA,4BAAiB,EAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAAC,CACjF,CAAC;SACF;QACD,OAAO,IAAA,gCAAc,EAAC,KAAK,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,KAAK,CAAC;IACvD,CAAC;IACD,MAAM,CACL,IAAO;QAEP,IAAI,IAAA,sBAAW,EAAC,IAAI,CAAC,EAAE;YACtB,OAAO,IAAA,kCAAe,EAAC,IAAI,CAAiD,CAAC;SAC7E;QACD,OAAO,IAAA,yCAAsB,EAAC,IAAA,6BAAW,EAAC,IAAI,CAAC,CAAC,MAAM,CAKrD,CAAC;IACH,CAAC;IACD,OAAO,CAAC,IAAc;QACrB,MAAM,QAAQ,GAAG,IAAA,6BAAW,EAAC,IAAI,CAAC,CAAC;QACnC,KAAK,MAAM,KAAK,IAAI,QAAQ,CAAC,aAAa,EAAE,EAAE;YAC7C,IAAI,KAAK,CAAC,MAAM,CAAC,IAAI,KAAK,qBAAU,CAAC,UAAU,EAAE;gBAChD,MAAM,UAAU,GAAG,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;gBACpC,IAAA,iBAAM,EAAC,UAAU,KAAK,SAAS,EAAE,KAAK,CAAC,+BAA+B,CAAC,CAAC;gBAExE,OAAO,IAAA,4BAAiB,EACvB,UAAU,CAAC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,UAAU,CAAC,KAAsB,CAAC,CACvE,CAAC;aACF;SACD;IACF,CAAC;CACD,CAAC;AAEF;;GAEG;AACH,SAAS,YAAY,CAAC,IAAc;IACnC,wGAAwG;IACxG,eAAe;IACf,MAAM,WAAW,GAAG,IAAA,6BAAW,EAAC,IAAI,CAAC,CAAC,WAAW,CAAC;IAClD,IAAI,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,YAAY,KAAK,uBAAY,CAAC,QAAQ,EAAE;QAC1E,wCAAwC;QACxC,OAAO,WAAW,CAAC,KAAK,CAAC;KACzB;IAED,yGAAyG;IACzG,OAAO,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC;AAC/B,CAAC;AAED;;GAEG;AACH,SAAS,uBAAuB,CAC/B,MAAsB,EACtB,SAA0B;IAE1B,6GAA6G;IAC7G,4EAA4E;IAC5E,IAAI,MAAM,CAAC,IAAI,KAAK,yBAAQ,CAAC,MAAM,EAAE;QACpC,OAAO,SAAS,CAAC;KACjB;IAED,MAAM,MAAM,GAAG,MAAM,CAAC,IAA2C,CAAC;IAElE,cAAc;IACd,6DAA6D;IAC7D,mGAAmG;IACnG,yIAAyI;IACzI,6DAA6D;IAC7D,KAAK,MAAM,CAAC,OAAO,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE;QAC5D,IAAI,WAAW,YAAY,4BAAW,IAAI,WAAW,CAAC,KAAK,EAAE,GAAG,KAAK,SAAS,EAAE;YAC/E,OAAO,OAAO,CAAC;SACf;KACD;IAED,IAAI,MAAM,CAAC,SAAS,CAAC,KAAK,SAAS,EAAE;QACpC,IAAA,eAAI,EAAC,qDAAqD,CAAC,CAAC;KAC5D;IAED,OAAO,SAAS,CAAC;AAClB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert, unreachableCase } from \"@fluidframework/core-utils/internal\";\n\nimport { Multiplicity, rootFieldKey } from \"../core/index.js\";\nimport {\n\tFieldKinds,\n\tLeafNodeSchema,\n\tStableNodeKey,\n\tTreeStatus,\n\tisTreeValue,\n\tvalueSchemaAllows,\n} from \"../feature-libraries/index.js\";\nimport { fail, extractFromOpaque } from \"../util/index.js\";\n\nimport { getOrCreateNodeProxy } from \"./proxies.js\";\nimport { getFlexNode, tryGetFlexNode } from \"./proxyBinding.js\";\nimport { tryGetSimpleNodeSchema } from \"./schemaCaching.js\";\nimport { schemaFromValue } from \"./schemaFactory.js\";\nimport {\n\tNodeFromSchema,\n\tNodeKind,\n\ttype TreeLeafValue,\n\tTreeNodeSchema,\n\ttype ImplicitFieldSchema,\n\tFieldSchema,\n} from \"./schemaTypes.js\";\nimport { getFlexSchema } from \"./toFlexSchema.js\";\nimport { TreeNode } from \"./types.js\";\n\n/**\n * Provides various functions for analyzing {@link TreeNode}s.\n *\n * @privateRemarks\n * Inlining the typing of this interface onto the `Tree` object provides slightly different .d.ts generation,\n * which avoids typescript expanding the type of TreeNodeSchema and thus encountering\n * https://github.com/microsoft/rushstack/issues/1958.\n * @public\n */\nexport interface TreeNodeApi {\n\t/**\n\t * The schema information for this node.\n\t */\n\tschema<T extends TreeNode | TreeLeafValue>(\n\t\tnode: T,\n\t): TreeNodeSchema<string, NodeKind, unknown, T>;\n\n\t/**\n\t * Narrow the type of the given value if it satisfies the given schema.\n\t * @example\n\t * ```ts\n\t * if (node.is(myNode, point)) {\n\t *     const y = myNode.y; // `myNode` is now known to satisfy the `point` schema and therefore has a `y` coordinate.\n\t * }\n\t * ```\n\t */\n\tis<TSchema extends TreeNodeSchema>(\n\t\tvalue: unknown,\n\t\tschema: TSchema,\n\t): value is NodeFromSchema<TSchema>;\n\n\t/**\n\t * Return the node under which this node resides in the tree (or undefined if this is a root node of the tree).\n\t */\n\tparent(node: TreeNode): TreeNode | undefined;\n\n\t/**\n\t * The key of the given node under its parent.\n\t * @remarks\n\t * If `node` is an element in a {@link (TreeArrayNode:interface)}, this returns the index of `node` in the array node (a `number`).\n\t * Otherwise, this returns the key of the field that it is under (a `string`).\n\t */\n\tkey(node: TreeNode): string | number;\n\n\t/**\n\t * Register an event listener on the given node.\n\t * @param node - The node whose events should be subscribed to.\n\t * @param eventName - Which event to subscribe to.\n\t * @param listener - The callback to trigger for the event. The tree can be read during the callback, but it is invalid to modify the tree during this callback.\n\t * @returns A callback function which will deregister the event.\n\t * This callback should be called only once.\n\t */\n\ton<K extends keyof TreeChangeEvents>(\n\t\tnode: TreeNode,\n\t\teventName: K,\n\t\tlistener: TreeChangeEvents[K],\n\t): () => void;\n\n\t/**\n\t * Returns the {@link TreeStatus} of the given node.\n\t */\n\treadonly status: (node: TreeNode) => TreeStatus;\n\n\t/**\n\t * If the given node has an identifier specified by a field of kind \"identifier\" then this returns the compressed form of that identifier.\n\t * Otherwise returns undefined.\n\t */\n\tshortId(node: TreeNode): number | undefined;\n}\n\n/**\n * The `Tree` object holds various functions for analyzing {@link TreeNode}s.\n */\nexport const treeNodeApi: TreeNodeApi = {\n\tparent: (node: TreeNode): TreeNode | undefined => {\n\t\tconst editNode = getFlexNode(node).parentField.parent.parent;\n\t\tif (editNode === undefined) {\n\t\t\treturn undefined;\n\t\t}\n\n\t\tconst output = getOrCreateNodeProxy(editNode);\n\t\tassert(\n\t\t\t!isTreeValue(output),\n\t\t\t0x87f /* Parent can't be a leaf, so it should be a node not a value */,\n\t\t);\n\t\treturn output;\n\t},\n\tkey: (node: TreeNode) => {\n\t\t// If the parent is undefined, then this node is under the root field,\n\t\t// so we know its key is the special root one.\n\t\tconst parent = treeNodeApi.parent(node);\n\t\tif (parent === undefined) {\n\t\t\treturn rootFieldKey;\n\t\t}\n\n\t\t// The flex-domain strictly operates in terms of \"stored keys\".\n\t\t// To find the associated developer-facing \"view key\", we need to look up the field associated with\n\t\t// the stored key from the flex-domain, and get view key its simple-domain counterpart was created with.\n\t\tconst storedKey = getStoredKey(node);\n\t\tconst parentSchema = treeNodeApi.schema(parent);\n\t\tconst viewKey = getViewKeyFromStoredKey(parentSchema, storedKey);\n\t\treturn viewKey;\n\t},\n\ton: <K extends keyof TreeChangeEvents>(\n\t\tnode: TreeNode,\n\t\teventName: K,\n\t\tlistener: TreeChangeEvents[K],\n\t) => {\n\t\tconst flex = getFlexNode(node);\n\t\tconst anchor = flex.anchorNode;\n\n\t\tswitch (eventName) {\n\t\t\tcase \"nodeChanged\": {\n\t\t\t\tlet unsubscribeFromTreeChanged: (() => void) | undefined;\n\t\t\t\treturn anchor.on(\"childrenChanged\", () => {\n\t\t\t\t\tif (unsubscribeFromTreeChanged === undefined) {\n\t\t\t\t\t\tunsubscribeFromTreeChanged = anchor.on(\"subtreeChanged\", () => {\n\t\t\t\t\t\t\tlistener();\n\t\t\t\t\t\t\tunsubscribeFromTreeChanged?.();\n\t\t\t\t\t\t\tunsubscribeFromTreeChanged = undefined;\n\t\t\t\t\t\t});\n\t\t\t\t\t}\n\t\t\t\t});\n\t\t\t}\n\t\t\tcase \"treeChanged\":\n\t\t\t\treturn anchor.on(\"subtreeChanged\", () => listener());\n\t\t\tdefault:\n\t\t\t\treturn unreachableCase(eventName);\n\t\t}\n\t},\n\tstatus: (node: TreeNode) => {\n\t\treturn getFlexNode(node, true).treeStatus();\n\t},\n\tis: <TSchema extends TreeNodeSchema>(\n\t\tvalue: unknown,\n\t\tschema: TSchema,\n\t): value is NodeFromSchema<TSchema> => {\n\t\tconst flexSchema = getFlexSchema(schema);\n\t\tif (isTreeValue(value)) {\n\t\t\treturn (\n\t\t\t\tflexSchema instanceof LeafNodeSchema && valueSchemaAllows(flexSchema.info, value)\n\t\t\t);\n\t\t}\n\t\treturn tryGetFlexNode(value)?.is(flexSchema) ?? false;\n\t},\n\tschema<T extends TreeNode | TreeLeafValue>(\n\t\tnode: T,\n\t): TreeNodeSchema<string, NodeKind, unknown, T> {\n\t\tif (isTreeValue(node)) {\n\t\t\treturn schemaFromValue(node) as TreeNodeSchema<string, NodeKind, unknown, T>;\n\t\t}\n\t\treturn tryGetSimpleNodeSchema(getFlexNode(node).schema) as TreeNodeSchema<\n\t\t\tstring,\n\t\t\tNodeKind,\n\t\t\tunknown,\n\t\t\tT\n\t\t>;\n\t},\n\tshortId(node: TreeNode): number | undefined {\n\t\tconst flexNode = getFlexNode(node);\n\t\tfor (const field of flexNode.boxedIterator()) {\n\t\t\tif (field.schema.kind === FieldKinds.identifier) {\n\t\t\t\tconst identifier = field.boxedAt(0);\n\t\t\t\tassert(identifier !== undefined, 0x927 /* The identifier must exist */);\n\n\t\t\t\treturn extractFromOpaque(\n\t\t\t\t\tidentifier.context.nodeKeys.localize(identifier.value as StableNodeKey),\n\t\t\t\t);\n\t\t\t}\n\t\t}\n\t},\n};\n\n/**\n * Gets the stored key with which the provided node is associated in the parent.\n */\nfunction getStoredKey(node: TreeNode): string | number {\n\t// Note: the flex domain strictly works with \"stored keys\", and knows nothing about the developer-facing\n\t// \"view keys\".\n\tconst parentField = getFlexNode(node).parentField;\n\tif (parentField.parent.schema.kind.multiplicity === Multiplicity.Sequence) {\n\t\t// The parent of `node` is an array node\n\t\treturn parentField.index;\n\t}\n\n\t// The parent of `node` is an object, a map, or undefined (and therefore `node` is a root/detached node).\n\treturn parentField.parent.key;\n}\n\n/**\n * Given a node schema, gets the view key corresponding with the provided {@link FieldProps.key | stored key}.\n */\nfunction getViewKeyFromStoredKey(\n\tschema: TreeNodeSchema,\n\tstoredKey: string | number,\n): string | number {\n\t// Only object nodes have the concept of a \"stored key\", differentiated from the developer-facing \"view key\".\n\t// For any other kind of node, the stored key and the view key are the same.\n\tif (schema.kind !== NodeKind.Object) {\n\t\treturn storedKey;\n\t}\n\n\tconst fields = schema.info as Record<string, ImplicitFieldSchema>;\n\n\t// Invariants:\n\t// - The set of all view keys under an object must be unique.\n\t// - The set of all stored keys (including those implicitly created from view keys) must be unique.\n\t// To find the view key associated with the provided stored key, first check for any stored key matches (which are optionally populated).\n\t// If we don't find any, then search for a matching view key.\n\tfor (const [viewKey, fieldSchema] of Object.entries(fields)) {\n\t\tif (fieldSchema instanceof FieldSchema && fieldSchema.props?.key === storedKey) {\n\t\t\treturn viewKey;\n\t\t}\n\t}\n\n\tif (fields[storedKey] === undefined) {\n\t\tfail(\"Existing stored key should always map to a view key\");\n\t}\n\n\treturn storedKey;\n}\n\n/**\n * A collection of events that can be raised by a {@link TreeNode}.\n *\n * @privateRemarks\n * TODO: add a way to subscribe to a specific field (for nodeChanged and treeChanged).\n * Probably have object node and map node specific APIs for this.\n *\n * TODO: ensure that subscription API for fields aligns with API for subscribing to the root.\n *\n * TODO: add more wider area (avoid needing tons of nodeChanged registration) events for use-cases other than treeChanged.\n * Some ideas:\n *\n * - treeChanged, but with some subtrees/fields/paths excluded\n * - helper to batch several nodeChanged calls to a treeChanged scope\n * - parent change (ex: registration on the parent field for a specific index: maybe allow it for a range. Ex: node event takes optional field and optional index range?)\n * - new content inserted into subtree. Either provide event for this and/or enough info to treeChanged to find and search the new sub-trees.\n * Add separate (non event related) API to efficiently scan tree for given set of types (using low level cursor and schema based filtering)\n * to allow efficiently searching for new content (and initial content) of a given type.\n *\n * @public\n */\nexport interface TreeChangeEvents {\n\t/**\n\t * Emitted by a node when a batch of changes is applied to it, where a change is:\n\t *\n\t * - For an object node, when the value of one of its properties changes (i.e., the property's value is set\n\t * to something else, including `undefined`).\n\t *\n\t * - For an array node, when an element is added, removed, or moved.\n\t *\n\t * - For a map node, when an entry is added, updated, or removed.\n\t *\n\t * @remarks\n\t * This event is not raised when:\n\t *\n\t * - Properties of a child node change. Notably, updates to an array node or a map node (like adding or removing\n\t * elements/entries) will raise this event on the array/map node itself, but not on the node that contains the\n\t * array/map node as one of its properties.\n\t *\n\t * - The node is moved to a different location in the tree or removed from the tree.\n\t * In this case the event is raised on the _parent_ node, not the node itself.\n\t *\n\t * For remote edits, this event is not guaranteed to occur in the same order or quantity that it did in\n\t * the client that made the original edit.\n\t * While a batch of edits will as a whole update the tree to the appropriate end state, no guarantees are made about\n\t * how many times this event will be raised during any intermediate states.\n\t * When it is raised, the tree is guaranteed to be in-schema.\n\t *\n\t * @privateRemarks\n\t * This event occurs whenever the apparent contents of the node instance change, regardless of what caused the change.\n\t * For example, it will fire when the local client reassigns a child, when part of a remote edit is applied to the\n\t * node, or when the node has to be updated due to resolution of a merge conflict\n\t * (for example a previously applied local change might be undone, then reapplied differently or not at all).\n\t */\n\tnodeChanged(): void;\n\n\t/**\n\t * Emitted by a node when something _may_ have changed anywhere in the subtree rooted at it.\n\t *\n\t * @remarks\n\t * This event is guaranteed to be emitted whenever the subtree _has_ changed.\n\t * However, it might also be emitted when the subtree has no visible changes compared to before the event firing.\n\t *\n\t * Consumers of this event have the guarantee that they won't miss any changes, but should also handle the scenario\n\t * where the event fires with no visible changes as well.\n\t *\n\t * This event is not raised when the node itself is moved to a different location in the tree or removed from the tree.\n\t * In that case it is raised on the _parent_ node, not the node itself.\n\t *\n\t * The node itself is part of the subtree, so this event will be emitted even if the only changes are to the properties\n\t * of the node itself.\n\t *\n\t * For remote edits, this event is not guaranteed to occur in the same order or quantity that it did in\n\t * the client that made the original edit.\n\t * While a batch of edits will as a whole update the tree to the appropriate end state, no guarantees are made about\n\t * how many times this event will be raised during any intermediate states.\n\t * When it is raised, the tree is guaranteed to be in-schema.\n\t */\n\ttreeChanged(): void;\n}\n"]}