@fluidframework/tree 2.1.0 → 2.3.0-288113

package/dist/feature-libraries/contextuallyTyped.js

@@ -1,328 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.normalizeNewFieldContent = exports.applyFieldTypesFromContext = exports.applyTypesFromContext = exports.cursorsForTypedFieldData = exports.cursorsFromContextualData = exports.cursorForTypedData = exports.cursorForTypedTreeData = exports.cursorFromContextualData = exports.isContextuallyTypedNodeDataObject = exports.isArrayLike = exports.arrayLikeMarkerSymbol = exports.getPossibleTypes = exports.getAllowedTypes = exports.getFieldKind = exports.valueSymbol = exports.typeNameSymbol = exports.areCursors = void 0;
-const internal_1 = require("@fluidframework/core-utils/internal");
-const index_js_1 = require("../core/index.js");
-const index_js_2 = require("../util/index.js");
-// TODO:
-// This module currently is assuming use of default-field-kinds.
-// The field kinds should instead come from a view schema registry thats provided somewhere.
-const index_js_3 = require("./default-schema/index.js");
-const mapTreeCursor_js_1 = require("./mapTreeCursor.js");
-const index_js_4 = require("./typed-schema/index.js");
-const valueUtilities_js_1 = require("./valueUtilities.js");
-/**
- * This library defines a tree data format that can infer its types from context.
- * It can only be used when the schema is known.
- * The format is optimized for ergonomics when the developer knows the schema,
- * and needs to declare or navigate trees.
- *
- * The format defined here is very tolerant to optimize for flexibility of expressing trees:
- * APIs exposing data in this format should likely further constrain what is allowed.
- * For example guarantee which fields and nodes should be inlined, and that types will be required everywhere.
- *
- * This is from Flex tree one which has been deleted and should no longer be used!
- */
-/**
- * Check if NewFieldContent is made of {@link ITreeCursor}s.
- *
- * Useful when APIs want to take in tree data in multiple formats, including cursors.
- */
-function areCursors(data) {
-    if ((0, index_js_1.isCursor)(data)) {
-        return true;
-    }
-    if (Array.isArray(data) && data.length >= 0 && (0, index_js_1.isCursor)(data[0])) {
-        return true;
-    }
-    return false;
-}
-exports.areCursors = areCursors;
-/**
- * String which identifies this code.
- * Targeted at developers: can be used for symbol strings, or other developer targeted strings,
- * like error messages.
- */
-const scope = "contextuallyTyped";
-/**
- * A symbol for the name of the type of a tree in contexts where string keys are already in use for fields.
- * See {@link TreeNodeSchemaIdentifier}.
- * @internal
- */
-exports.typeNameSymbol = Symbol(`${scope}:typeName`);
-/**
- * A symbol for the value of a tree node in contexts where string keys are already in use for fields.
- * @internal
- */
-exports.valueSymbol = Symbol(`${scope}:value`);
-function getFieldKind(fieldSchema) {
-    // TODO:
-    // This module currently is assuming use of defaultFieldKinds.
-    // The field kinds should instead come from a view schema registry thats provided somewhere.
-    return index_js_3.fieldKinds.get(fieldSchema.kind.identifier) ?? (0, index_js_2.fail)("missing field kind");
-}
-exports.getFieldKind = getFieldKind;
-/**
- * @returns all allowed child types for `typeSet`.
- */
-function getAllowedTypes(schemaData, typeSet) {
-    // TODO: Performance: avoid the `Any` case being frequent, possibly with caching in the caller of `getPossibleChildTypes`.
-    return typeSet === index_js_4.Any ? new Set(schemaData.nodeSchema.values()) : typeSet;
-}
-exports.getAllowedTypes = getAllowedTypes;
-/**
- * @returns all types, for which the data is schema-compatible.
- */
-function getPossibleTypes(context, typeSet, data) {
-    // All types allowed by schema
-    const allowedTypes = getAllowedTypes(context, typeSet);
-    const possibleTypes = [];
-    for (const allowed of allowedTypes) {
-        if (shallowCompatibilityTest(allowed, data)) {
-            possibleTypes.push(allowed);
-        }
-    }
-    return possibleTypes;
-}
-exports.getPossibleTypes = getPossibleTypes;
-/**
- * A symbol used to define a {@link MarkedArrayLike} interface.
- * @internal
- */
-exports.arrayLikeMarkerSymbol = Symbol("flex-tree:arrayLikeMarker");
-/**
- * Checks the type of a `ContextuallyTypedNodeData`.
- */
-function isArrayLike(data) {
-    if (typeof data !== "object" || data === null) {
-        return false;
-    }
-    return (data[exports.arrayLikeMarkerSymbol] ===
-        true || Array.isArray(data));
-}
-exports.isArrayLike = isArrayLike;
-/**
- * Checks the type of a `ContextuallyTypedNodeData`.
- * @internal
- */
-function isContextuallyTypedNodeDataObject(data) {
-    return !((0, valueUtilities_js_1.isTreeValue)(data) || isArrayLike(data));
-}
-exports.isContextuallyTypedNodeDataObject = isContextuallyTypedNodeDataObject;
-/**
- * Checks if data might be schema-compatible.
- *
- * @returns false if `data` is incompatible with `type` based on a cheap/shallow check.
- *
- * Note that this may return true for cases where data is incompatible, but it must not return false in cases where the data is compatible.
- */
-function shallowCompatibilityTest(schema, data) {
-    (0, internal_1.assert)(!areCursors(data), 0x6b1 /* cursors cannot be used as contextually typed data. */);
-    (0, internal_1.assert)(data !== undefined, 0x6b2 /* undefined cannot be used as contextually typed data. Use ContextuallyTypedFieldData. */);
-    if (schema instanceof index_js_4.LeafNodeSchema) {
-        // Reject objects with no value from being leaf nodes.
-        // Note that if allowing IFluidHandles without wrapping them in a leaf node object,
-        // this (or the above isPrimitiveValue) would have to change.
-        if ((0, valueUtilities_js_1.isTreeValue)(data)) {
-            return (0, valueUtilities_js_1.allowsValue)(schema.leafValue, data);
-        }
-        if (data[exports.valueSymbol] === undefined) {
-            return false;
-        }
-    }
-    if ((0, valueUtilities_js_1.isTreeValue)(data)) {
-        return false;
-    }
-    if (isArrayLike(data)) {
-        if (schema instanceof index_js_4.FlexFieldNodeSchema) {
-            const field = schema.getFieldSchema();
-            return field.kind.multiplicity === index_js_1.Multiplicity.Sequence;
-        }
-        else {
-            return false;
-        }
-    }
-    if (data[exports.typeNameSymbol] !== undefined) {
-        return data[exports.typeNameSymbol] === schema.name;
-    }
-    // For now, consider all not explicitly typed objects shallow compatible.
-    // This will require explicit differentiation in polymorphic cases rather than automatic structural differentiation.
-    return true;
-}
-/**
- * Construct a tree from ContextuallyTypedNodeData.
- *
- * TODO: this should probably be refactored into a `try` function which either returns a Cursor or a SchemaError with a path to the error.
- * @returns a cursor in Nodes mode for a single node containing the provided data.
- * @internal
- */
-function cursorFromContextualData(context, typeSet, data) {
-    const mapTree = applyTypesFromContext(context, typeSet, data);
-    return (0, mapTreeCursor_js_1.cursorForMapTreeNode)(mapTree);
-}
-exports.cursorFromContextualData = cursorFromContextualData;
-/**
- * Strongly typed {@link cursorFromContextualData} for a TreeNodeSchema.
- * @returns a cursor in Nodes mode for a single node containing the provided data.
- * @internal
- */
-function cursorForTypedTreeData(context, schema, data) {
-    return cursorFromContextualData(context, new Set([schema]), data);
-}
-exports.cursorForTypedTreeData = cursorForTypedTreeData;
-/**
- * Strongly typed {@link cursorFromContextualData} for AllowedTypes.
- * @returns a cursor in Nodes mode for a single node containing the provided data.
- * @internal
- */
-function cursorForTypedData(context, schema, data) {
-    return cursorFromContextualData(context, (0, index_js_4.allowedTypesSchemaSet)(schema), data);
-}
-exports.cursorForTypedData = cursorForTypedData;
-/**
- * Construct a tree from ContextuallyTypedNodeData.
- * Returns a cursor in Field mode.
- *
- * TODO: this should probably be refactored into a `try` function which either returns a Cursor or a SchemaError with a path to the error.
- */
-function cursorsFromContextualData(context, field, data) {
-    const mapTrees = applyFieldTypesFromContext(context, field, data);
-    return (0, mapTreeCursor_js_1.cursorForMapTreeField)(mapTrees);
-}
-exports.cursorsFromContextualData = cursorsFromContextualData;
-/**
- * Strongly typed {@link cursorsFromContextualData} for a TreeFieldSchema
- * @internal
- */
-function cursorsForTypedFieldData(context, schema, data) {
-    return cursorsFromContextualData(context, schema, data);
-}
-exports.cursorsForTypedFieldData = cursorsForTypedFieldData;
-/**
- * Construct a MapTree from ContextuallyTypedNodeData.
- *
- * TODO: this should probably be refactored into a `try` function which either returns a MapTree or a SchemaError with a path to the error.
- * TODO: test suite.
- *
- * @remarks
- * This version is only exported as a more testable entry point than `cursorFromContextualData` which keeps the use of `MapTree` as an implementation detail.
- * This should not be reexported from the parent module.
- */
-function applyTypesFromContext(context, typeSet, data) {
-    const possibleTypes = getPossibleTypes(context.schema, typeSet, data);
-    (0, internal_1.assert)(possibleTypes.length !== 0, 0x4d4 /* data incompatible with all types allowed by the schema */);
-    (0, internal_1.assert)(possibleTypes.length === 1, 0x4d5 /* data compatible with more than one type allowed by the schema */);
-    const schema = possibleTypes[0];
-    if (schema instanceof index_js_4.LeafNodeSchema) {
-        const value = (0, valueUtilities_js_1.isTreeValue)(data)
-            ? data
-            : data[exports.valueSymbol];
-        (0, internal_1.assert)((0, valueUtilities_js_1.allowsValue)(schema.leafValue, value), 0x4d3 /* unsupported schema for provided primitive */);
-        return { value, type: schema.name, fields: new Map() };
-    }
-    (0, internal_1.assert)(!(0, valueUtilities_js_1.isTreeValue)(data), 0x880 /* leaf value for non leaf */);
-    if (schema instanceof index_js_4.FlexFieldNodeSchema) {
-        if (isArrayLike(data)) {
-            const children = applyFieldTypesFromContext(context, schema.getFieldSchema(), data);
-            return {
-                value: undefined,
-                type: schema.name,
-                fields: new Map(children.length > 0 ? [[index_js_1.EmptyKey, children]] : []),
-            };
-        }
-    }
-    (0, internal_1.assert)(!isArrayLike(data), 0x881 /* array for non field node */);
-    if (schema instanceof index_js_4.FlexMapNodeSchema ||
-        schema instanceof index_js_4.FlexObjectNodeSchema ||
-        schema instanceof index_js_4.FlexFieldNodeSchema) {
-        const fields = new Map();
-        for (const key of fieldKeysFromData(data)) {
-            (0, internal_1.assert)(!fields.has(key), 0x6b3 /* Keys should not be duplicated */);
-            const childSchema = schema.getFieldSchema(key);
-            const children = applyFieldTypesFromContext(context, childSchema, data[key]);
-            if (children.length > 0) {
-                fields.set(key, children);
-            }
-        }
-        if (schema instanceof index_js_4.FlexObjectNodeSchema) {
-            for (const key of schema.objectNodeFields.keys()) {
-                if (data[key] === undefined) {
-                    setFieldForKey(key, context, schema, fields);
-                }
-            }
-        }
-        const value = data[exports.valueSymbol];
-        (0, internal_1.assert)(value === undefined, 0x4d7 /* provided value not permitted by the schema */);
-        return { value, type: schema.name, fields };
-    }
-    else {
-        (0, index_js_2.fail)("unexpected node kind");
-    }
-}
-exports.applyTypesFromContext = applyTypesFromContext;
-function setFieldForKey(key, context, schema, fields) {
-    const requiredFieldSchema = schema.getFieldSchema(key);
-    const multiplicity = getFieldKind(requiredFieldSchema).multiplicity;
-    if (multiplicity === index_js_1.Multiplicity.Single && context.fieldSource !== undefined) {
-        const fieldGenerator = context.fieldSource(key, requiredFieldSchema.stored);
-        if (fieldGenerator !== undefined) {
-            const children = fieldGenerator();
-            fields.set(key, children);
-        }
-    }
-}
-function fieldKeysFromData(data) {
-    const keys = Reflect.ownKeys(data).filter((key) => typeof key === "string");
-    return keys;
-}
-/**
- * Construct a MapTree from ContextuallyTypedNodeData.
- *
- * TODO: this should probably be refactored into a `try` function which either returns a MapTree or a SchemaError with a path to the error.
- * TODO: test suite.
- *
- * @remarks
- * This version is only exported as a more testable entry point than `cursorsFromContextualData` which keeps the use of `MapTree` as an implementation detail.
- * This should not be reexported from the parent module.
- */
-function applyFieldTypesFromContext(context, field, data) {
-    const multiplicity = getFieldKind(field).multiplicity;
-    if (data === undefined) {
-        (0, internal_1.assert)(multiplicity === index_js_1.Multiplicity.Forbidden || multiplicity === index_js_1.Multiplicity.Optional, 0x4d8 /* `undefined` provided for a field that does not support `undefined` */);
-        return [];
-    }
-    if (multiplicity === index_js_1.Multiplicity.Sequence) {
-        (0, internal_1.assert)(isArrayLike(data), 0x4d9 /* expected array for a sequence field */);
-        const children = Array.from(data, (child) => applyTypesFromContext(context, field.allowedTypeSet, child));
-        return children;
-    }
-    (0, internal_1.assert)(multiplicity === index_js_1.Multiplicity.Single || multiplicity === index_js_1.Multiplicity.Optional, 0x4da /* single value provided for an unsupported field */);
-    return [applyTypesFromContext(context, field.allowedTypeSet, data)];
-}
-exports.applyFieldTypesFromContext = applyFieldTypesFromContext;
-/**
- * Convert NewFieldContent into ITreeCursorSynchronous.
- * The returned cursor will be in Field mode.
- */
-function normalizeNewFieldContent(context, schema, content) {
-    if (areCursors(content)) {
-        if ((0, index_js_2.isReadonlyArray)(content)) {
-            (0, internal_1.assert)(getFieldKind(schema).multiplicity === index_js_1.Multiplicity.Sequence || content.length === 1, 0x6b8 /* non-sequence fields can not be provided content that is multiple cursors */);
-            // TODO: is there a better way to get a field cursor from an array of node cursors?
-            const mapTrees = content.map((c) => (0, mapTreeCursor_js_1.mapTreeFromCursor)(c));
-            return (0, mapTreeCursor_js_1.cursorForMapTreeField)(mapTrees);
-        }
-        if (content.mode === 1 /* CursorLocationType.Fields */) {
-            return content;
-        }
-        // TODO: is there a better way to get a field cursor from a node cursor?
-        return (0, mapTreeCursor_js_1.cursorForMapTreeField)([(0, mapTreeCursor_js_1.mapTreeFromCursor)(content)]);
-    }
-    return cursorsFromContextualData(context, schema, content);
-}
-exports.normalizeNewFieldContent = normalizeNewFieldContent;
-//# sourceMappingURL=contextuallyTyped.js.map

package/dist/feature-libraries/contextuallyTyped.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"contextuallyTyped.js","sourceRoot":"","sources":["../../src/feature-libraries/contextuallyTyped.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kEAA6D;AAE7D,+CAS0B;AAC1B,+CAAyD;AAEzD,QAAQ;AACR,gEAAgE;AAChE,4FAA4F;AAC5F,wDAAuD;AAEvD,yDAI4B;AAO5B,sDAYiC;AACjC,2DAA+D;AAE/D;;;;;;;;;;;GAWG;AAEH;;;;GAIG;AACH,SAAgB,UAAU,CACzB,IAAqB;IAErB,IAAI,IAAA,mBAAQ,EAAC,IAAI,CAAC,EAAE,CAAC;QACpB,OAAO,IAAI,CAAC;IACb,CAAC;IAED,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,IAAI,CAAC,IAAI,IAAA,mBAAQ,EAAC,IAAI,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;QAClE,OAAO,IAAI,CAAC;IACb,CAAC;IAED,OAAO,KAAK,CAAC;AACd,CAAC;AAZD,gCAYC;AAED;;;;GAIG;AACH,MAAM,KAAK,GAAG,mBAAmB,CAAC;AAElC;;;;GAIG;AACU,QAAA,cAAc,GAAkB,MAAM,CAAC,GAAG,KAAK,WAAW,CAAC,CAAC;AAEzE;;;GAGG;AACU,QAAA,WAAW,GAAkB,MAAM,CAAC,GAAG,KAAK,QAAQ,CAAC,CAAC;AAEnE,SAAgB,YAAY,CAAC,WAA4B;IACxD,QAAQ;IACR,8DAA8D;IAC9D,4FAA4F;IAC5F,OAAO,qBAAU,CAAC,GAAG,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,IAAI,IAAA,eAAI,EAAC,oBAAoB,CAAC,CAAC;AAClF,CAAC;AALD,oCAKC;AAED;;GAEG;AACH,SAAgB,eAAe,CAC9B,UAA0B,EAC1B,OAAuB;IAEvB,0HAA0H;IAC1H,OAAO,OAAO,KAAK,cAAG,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,UAAU,CAAC,UAAU,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC;AAC5E,CAAC;AAND,0CAMC;AAED;;GAEG;AACH,SAAgB,gBAAgB,CAC/B,OAAuB,EACvB,OAAuB,EACvB,IAA+B;IAE/B,8BAA8B;IAC9B,MAAM,YAAY,GAAG,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IAEvD,MAAM,aAAa,GAAyB,EAAE,CAAC;IAC/C,KAAK,MAAM,OAAO,IAAI,YAAY,EAAE,CAAC;QACpC,IAAI,wBAAwB,CAAC,OAAO,EAAE,IAAI,CAAC,EAAE,CAAC;YAC7C,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QAC7B,CAAC;IACF,CAAC;IACD,OAAO,aAAa,CAAC;AACtB,CAAC;AAfD,4CAeC;AAED;;;GAGG;AACU,QAAA,qBAAqB,GAAkB,MAAM,CAAC,2BAA2B,CAAC,CAAC;AA+DxF;;GAEG;AACH,SAAgB,WAAW,CAC1B,IAAgC;IAIhC,IAAI,OAAO,IAAI,KAAK,QAAQ,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;QAC/C,OAAO,KAAK,CAAC;IACd,CAAC;IACD,OAAO,CACL,IAA4D,CAAC,6BAAqB,CAAC;QACnF,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAC5B,CAAC;AACH,CAAC;AAZD,kCAYC;AAED;;;GAGG;AACH,SAAgB,iCAAiC,CAChD,IAA2C;IAE3C,OAAO,CAAC,CAAC,IAAA,+BAAW,EAAC,IAAI,CAAC,IAAI,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;AAClD,CAAC;AAJD,8EAIC;AAkCD;;;;;;GAMG;AACH,SAAS,wBAAwB,CAChC,MAA0B,EAC1B,IAA+B;IAE/B,IAAA,iBAAM,EAAC,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,wDAAwD,CAAC,CAAC;IAC1F,IAAA,iBAAM,EACL,IAAI,KAAK,SAAS,EAClB,KAAK,CAAC,0FAA0F,CAChG,CAAC;IAEF,IAAI,MAAM,YAAY,yBAAc,EAAE,CAAC;QACtC,sDAAsD;QACtD,mFAAmF;QACnF,6DAA6D;QAE7D,IAAI,IAAA,+BAAW,EAAC,IAAI,CAAC,EAAE,CAAC;YACvB,OAAO,IAAA,+BAAW,EAAC,MAAM,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAC5C,CAAC;QACD,IAAK,IAAwC,CAAC,mBAAW,CAAC,KAAK,SAAS,EAAE,CAAC;YAC1E,OAAO,KAAK,CAAC;QACd,CAAC;IACF,CAAC;IACD,IAAI,IAAA,+BAAW,EAAC,IAAI,CAAC,EAAE,CAAC;QACvB,OAAO,KAAK,CAAC;IACd,CAAC;IACD,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;QACvB,IAAI,MAAM,YAAY,8BAAmB,EAAE,CAAC;YAC3C,MAAM,KAAK,GAAG,MAAM,CAAC,cAAc,EAAE,CAAC;YACtC,OAAO,KAAK,CAAC,IAAI,CAAC,YAAY,KAAK,uBAAY,CAAC,QAAQ,CAAC;QAC1D,CAAC;aAAM,CAAC;YACP,OAAO,KAAK,CAAC;QACd,CAAC;IACF,CAAC;IACD,IAAI,IAAI,CAAC,sBAAc,CAAC,KAAK,SAAS,EAAE,CAAC;QACxC,OAAO,IAAI,CAAC,sBAAc,CAAC,KAAK,MAAM,CAAC,IAAI,CAAC;IAC7C,CAAC;IACD,yEAAyE;IACzE,oHAAoH;IAEpH,OAAO,IAAI,CAAC;AACb,CAAC;AAED;;;;;;GAMG;AACH,SAAgB,wBAAwB,CACvC,OAAwB,EACxB,OAAuB,EACvB,IAA+B;IAE/B,MAAM,OAAO,GAAG,qBAAqB,CAAC,OAAO,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAC9D,OAAO,IAAA,uCAAoB,EAAC,OAAO,CAAC,CAAC;AACtC,CAAC;AAPD,4DAOC;AAED;;;;GAIG;AACH,SAAgB,sBAAsB,CACrC,OAAwB,EACxB,MAAS,EACT,IAA2B;IAE3B,OAAO,wBAAwB,CAC9B,OAAO,EACP,IAAI,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,EACjB,IAAiC,CACjC,CAAC;AACH,CAAC;AAVD,wDAUC;AAED;;;;GAIG;AACH,SAAgB,kBAAkB,CACjC,OAAwB,EACxB,MAAS,EACT,IAAyC;IAEzC,OAAO,wBAAwB,CAC9B,OAAO,EACP,IAAA,gCAAqB,EAAC,MAAM,CAAC,EAC7B,IAA4C,CAC5C,CAAC;AACH,CAAC;AAVD,gDAUC;AAED;;;;;GAKG;AACH,SAAgB,yBAAyB,CACxC,OAAwB,EACxB,KAAsB,EACtB,IAA2C;IAE3C,MAAM,QAAQ,GAAG,0BAA0B,CAAC,OAAO,EAAE,KAAK,EAAE,IAAI,CAAC,CAAC;IAClE,OAAO,IAAA,wCAAqB,EAAC,QAAQ,CAAC,CAAC;AACxC,CAAC;AAPD,8DAOC;AAED;;;GAGG;AACH,SAAgB,wBAAwB,CACvC,OAAwB,EACxB,MAAS,EACT,IAA4B;IAE5B,OAAO,yBAAyB,CAAC,OAAO,EAAE,MAAM,EAAE,IAAiC,CAAC,CAAC;AACtF,CAAC;AAND,4DAMC;AAED;;;;;;;;;GASG;AACH,SAAgB,qBAAqB,CACpC,OAAwB,EACxB,OAAuB,EACvB,IAA+B;IAE/B,MAAM,aAAa,GAAyB,gBAAgB,CAAC,OAAO,CAAC,MAAM,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;IAE5F,IAAA,iBAAM,EACL,aAAa,CAAC,MAAM,KAAK,CAAC,EAC1B,KAAK,CAAC,4DAA4D,CAClE,CAAC;IACF,IAAA,iBAAM,EACL,aAAa,CAAC,MAAM,KAAK,CAAC,EAC1B,KAAK,CAAC,mEAAmE,CACzE,CAAC;IAEF,MAAM,MAAM,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC;IAEhC,IAAI,MAAM,YAAY,yBAAc,EAAE,CAAC;QACtC,MAAM,KAAK,GAAG,IAAA,+BAAW,EAAC,IAAI,CAAC;YAC9B,CAAC,CAAC,IAAI;YACN,CAAC,CAAE,IAAwC,CAAC,mBAAW,CAAC,CAAC;QAE1D,IAAA,iBAAM,EACL,IAAA,+BAAW,EAAC,MAAM,CAAC,SAAS,EAAE,KAAK,CAAC,EACpC,KAAK,CAAC,+CAA+C,CACrD,CAAC;QACF,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,GAAG,EAAE,EAAE,CAAC;IACxD,CAAC;IACD,IAAA,iBAAM,EAAC,CAAC,IAAA,+BAAW,EAAC,IAAI,CAAC,EAAE,KAAK,CAAC,6BAA6B,CAAC,CAAC;IAChE,IAAI,MAAM,YAAY,8BAAmB,EAAE,CAAC;QAC3C,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE,CAAC;YACvB,MAAM,QAAQ,GAAG,0BAA0B,CAAC,OAAO,EAAE,MAAM,CAAC,cAAc,EAAE,EAAE,IAAI,CAAC,CAAC;YACpF,OAAO;gBACN,KAAK,EAAE,SAAS;gBAChB,IAAI,EAAE,MAAM,CAAC,IAAI;gBACjB,MAAM,EAAE,IAAI,GAAG,CAAC,QAAQ,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,mBAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC;aAClE,CAAC;QACH,CAAC;IACF,CAAC;IACD,IAAA,iBAAM,EAAC,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,8BAA8B,CAAC,CAAC;IACjE,IACC,MAAM,YAAY,4BAAiB;QACnC,MAAM,YAAY,+BAAoB;QACtC,MAAM,YAAY,8BAAmB,EACpC,CAAC;QACF,MAAM,MAAM,GAA6B,IAAI,GAAG,EAAE,CAAC;QACnD,KAAK,MAAM,GAAG,IAAI,iBAAiB,CAAC,IAAI,CAAC,EAAE,CAAC;YAC3C,IAAA,iBAAM,EAAC,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE,KAAK,CAAC,mCAAmC,CAAC,CAAC;YACpE,MAAM,WAAW,GAAG,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;YAC/C,MAAM,QAAQ,GAAG,0BAA0B,CAAC,OAAO,EAAE,WAAW,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;YAE7E,IAAI,QAAQ,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACzB,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;YAC3B,CAAC;QACF,CAAC;QAED,IAAI,MAAM,YAAY,+BAAoB,EAAE,CAAC;YAC5C,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,gBAAgB,CAAC,IAAI,EAAE,EAAE,CAAC;gBAClD,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE,CAAC;oBAC7B,cAAc,CAAC,GAAG,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,CAAC,CAAC;gBAC9C,CAAC;YACF,CAAC;QACF,CAAC;QAED,MAAM,KAAK,GAAG,IAAI,CAAC,mBAAW,CAAC,CAAC;QAChC,IAAA,iBAAM,EAAC,KAAK,KAAK,SAAS,EAAE,KAAK,CAAC,gDAAgD,CAAC,CAAC;QACpF,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,CAAC;IAC7C,CAAC;SAAM,CAAC;QACP,IAAA,eAAI,EAAC,sBAAsB,CAAC,CAAC;IAC9B,CAAC;AACF,CAAC;AAvED,sDAuEC;AAED,SAAS,cAAc,CACtB,GAAa,EACb,OAAwB,EACxB,MAA0B,EAC1B,MAAgC;IAEhC,MAAM,mBAAmB,GAAG,MAAM,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC;IACvD,MAAM,YAAY,GAAG,YAAY,CAAC,mBAAmB,CAAC,CAAC,YAAY,CAAC;IACpE,IAAI,YAAY,KAAK,uBAAY,CAAC,MAAM,IAAI,OAAO,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QAC/E,MAAM,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC,GAAG,EAAE,mBAAmB,CAAC,MAAM,CAAC,CAAC;QAC5E,IAAI,cAAc,KAAK,SAAS,EAAE,CAAC;YAClC,MAAM,QAAQ,GAAG,cAAc,EAAE,CAAC;YAClC,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;QAC3B,CAAC;IACF,CAAC;AACF,CAAC;AAED,SAAS,iBAAiB,CAAC,IAAqC;IAC/D,MAAM,IAAI,GAAwB,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,MAAM,CAC7D,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,CAChC,CAAC;IACF,OAAO,IAAkB,CAAC;AAC3B,CAAC;AAED;;;;;;;;;GASG;AACH,SAAgB,0BAA0B,CACzC,OAAwB,EACxB,KAAsB,EACtB,IAAgC;IAEhC,MAAM,YAAY,GAAG,YAAY,CAAC,KAAK,CAAC,CAAC,YAAY,CAAC;IACtD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACxB,IAAA,iBAAM,EACL,YAAY,KAAK,uBAAY,CAAC,SAAS,IAAI,YAAY,KAAK,uBAAY,CAAC,QAAQ,EACjF,KAAK,CAAC,wEAAwE,CAC9E,CAAC;QACF,OAAO,EAAE,CAAC;IACX,CAAC;IACD,IAAI,YAAY,KAAK,uBAAY,CAAC,QAAQ,EAAE,CAAC;QAC5C,IAAA,iBAAM,EAAC,WAAW,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,yCAAyC,CAAC,CAAC;QAC3E,MAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAC3C,qBAAqB,CAAC,OAAO,EAAE,KAAK,CAAC,cAAc,EAAE,KAAK,CAAC,CAC3D,CAAC;QACF,OAAO,QAAQ,CAAC;IACjB,CAAC;IACD,IAAA,iBAAM,EACL,YAAY,KAAK,uBAAY,CAAC,MAAM,IAAI,YAAY,KAAK,uBAAY,CAAC,QAAQ,EAC9E,KAAK,CAAC,oDAAoD,CAC1D,CAAC;IACF,OAAO,CAAC,qBAAqB,CAAC,OAAO,EAAE,KAAK,CAAC,cAAc,EAAE,IAAI,CAAC,CAAC,CAAC;AACrE,CAAC;AAzBD,gEAyBC;AAoBD;;;GAGG;AACH,SAAgB,wBAAwB,CACvC,OAAwB,EACxB,MAAuB,EACvB,OAAwB;IAExB,IAAI,UAAU,CAAC,OAAO,CAAC,EAAE,CAAC;QACzB,IAAI,IAAA,0BAAe,EAAC,OAAO,CAAC,EAAE,CAAC;YAC9B,IAAA,iBAAM,EACL,YAAY,CAAC,MAAM,CAAC,CAAC,YAAY,KAAK,uBAAY,CAAC,QAAQ,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EACnF,KAAK,CAAC,8EAA8E,CACpF,CAAC;YACF,mFAAmF;YACnF,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAA,oCAAiB,EAAC,CAAC,CAAC,CAAC,CAAC;YAC1D,OAAO,IAAA,wCAAqB,EAAC,QAAQ,CAAC,CAAC;QACxC,CAAC;QACD,IAAI,OAAO,CAAC,IAAI,sCAA8B,EAAE,CAAC;YAChD,OAAO,OAAO,CAAC;QAChB,CAAC;QACD,wEAAwE;QACxE,OAAO,IAAA,wCAAqB,EAAC,CAAC,IAAA,oCAAiB,EAAC,OAAO,CAAC,CAAC,CAAC,CAAC;IAC5D,CAAC;IAED,OAAO,yBAAyB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;AAC5D,CAAC;AAvBD,4DAuBC","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\";\n\nimport {\n\tCursorLocationType,\n\tEmptyKey,\n\ttype FieldKey,\n\ttype ITreeCursorSynchronous,\n\ttype MapTree,\n\ttype Value,\n\tisCursor,\n\tMultiplicity,\n} from \"../core/index.js\";\nimport { fail, isReadonlyArray } from \"../util/index.js\";\n\n// TODO:\n// This module currently is assuming use of default-field-kinds.\n// The field kinds should instead come from a view schema registry thats provided somewhere.\nimport { fieldKinds } from \"./default-schema/index.js\";\nimport type { TreeDataContext } from \"./fieldGenerator.js\";\nimport {\n\tcursorForMapTreeField,\n\tcursorForMapTreeNode,\n\tmapTreeFromCursor,\n} from \"./mapTreeCursor.js\";\nimport type { FlexFieldKind } from \"./modular-schema/index.js\";\nimport type {\n\tAllowedTypesToFlexInsertableTree,\n\tInsertableFlexField,\n\tInsertableFlexNode,\n} from \"./schema-aware/index.js\";\nimport {\n\ttype AllowedTypeSet,\n\tAny,\n\ttype FlexAllowedTypes,\n\tFlexFieldNodeSchema,\n\ttype FlexFieldSchema,\n\tFlexMapNodeSchema,\n\tFlexObjectNodeSchema,\n\ttype FlexTreeNodeSchema,\n\ttype FlexTreeSchema,\n\tLeafNodeSchema,\n\tallowedTypesSchemaSet,\n} from \"./typed-schema/index.js\";\nimport { allowsValue, isTreeValue } from \"./valueUtilities.js\";\n\n/**\n * This library defines a tree data format that can infer its types from context.\n * It can only be used when the schema is known.\n * The format is optimized for ergonomics when the developer knows the schema,\n * and needs to declare or navigate trees.\n *\n * The format defined here is very tolerant to optimize for flexibility of expressing trees:\n * APIs exposing data in this format should likely further constrain what is allowed.\n * For example guarantee which fields and nodes should be inlined, and that types will be required everywhere.\n *\n * This is from Flex tree one which has been deleted and should no longer be used!\n */\n\n/**\n * Check if NewFieldContent is made of {@link ITreeCursor}s.\n *\n * Useful when APIs want to take in tree data in multiple formats, including cursors.\n */\nexport function areCursors(\n\tdata: NewFieldContent,\n): data is ITreeCursorSynchronous | readonly ITreeCursorSynchronous[] {\n\tif (isCursor(data)) {\n\t\treturn true;\n\t}\n\n\tif (Array.isArray(data) && data.length >= 0 && isCursor(data[0])) {\n\t\treturn true;\n\t}\n\n\treturn false;\n}\n\n/**\n * String which identifies this code.\n * Targeted at developers: can be used for symbol strings, or other developer targeted strings,\n * like error messages.\n */\nconst scope = \"contextuallyTyped\";\n\n/**\n * A symbol for the name of the type of a tree in contexts where string keys are already in use for fields.\n * See {@link TreeNodeSchemaIdentifier}.\n * @internal\n */\nexport const typeNameSymbol: unique symbol = Symbol(`${scope}:typeName`);\n\n/**\n * A symbol for the value of a tree node in contexts where string keys are already in use for fields.\n * @internal\n */\nexport const valueSymbol: unique symbol = Symbol(`${scope}:value`);\n\nexport function getFieldKind(fieldSchema: FlexFieldSchema): FlexFieldKind {\n\t// TODO:\n\t// This module currently is assuming use of defaultFieldKinds.\n\t// The field kinds should instead come from a view schema registry thats provided somewhere.\n\treturn fieldKinds.get(fieldSchema.kind.identifier) ?? fail(\"missing field kind\");\n}\n\n/**\n * @returns all allowed child types for `typeSet`.\n */\nexport function getAllowedTypes(\n\tschemaData: FlexTreeSchema,\n\ttypeSet: AllowedTypeSet,\n): ReadonlySet<FlexTreeNodeSchema> {\n\t// TODO: Performance: avoid the `Any` case being frequent, possibly with caching in the caller of `getPossibleChildTypes`.\n\treturn typeSet === Any ? new Set(schemaData.nodeSchema.values()) : typeSet;\n}\n\n/**\n * @returns all types, for which the data is schema-compatible.\n */\nexport function getPossibleTypes(\n\tcontext: FlexTreeSchema,\n\ttypeSet: AllowedTypeSet,\n\tdata: ContextuallyTypedNodeData,\n): FlexTreeNodeSchema[] {\n\t// All types allowed by schema\n\tconst allowedTypes = getAllowedTypes(context, 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 * A symbol used to define a {@link MarkedArrayLike} interface.\n * @internal\n */\nexport const arrayLikeMarkerSymbol: unique symbol = Symbol(\"flex-tree:arrayLikeMarker\");\n\n/**\n * Can be used to mark a type which works like an array, but is not compatible with `Array.isArray`.\n * @internal\n */\nexport interface MarkedArrayLike<TGet, TSet extends TGet = TGet>\n\textends ArrayLikeMut<TGet, TSet> {\n\treadonly [arrayLikeMarkerSymbol]: true;\n\t[Symbol.iterator](): IterableIterator<TGet>;\n}\n\n/**\n * Can be used to mark a type which works like an array, but is not compatible with `Array.isArray`.\n * @internal\n */\nexport interface ReadonlyMarkedArrayLike<T> extends ArrayLike<T> {\n\treadonly [arrayLikeMarkerSymbol]: true;\n\t[Symbol.iterator](): IterableIterator<T>;\n}\n\n/**\n * `ArrayLike` numeric indexed access, but writable.\n *\n * @remarks\n * Note that due to language limitations, this also allows reading as TSet.\n * This is why `TSet extends TGet` is required.\n *\n * See https://github.com/microsoft/TypeScript/issues/43826.\n * @internal\n */\nexport interface ArrayLikeMut<TGet, TSet extends TGet = TGet> extends ArrayLike<TGet> {\n\t[n: number]: TSet;\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 * @internal\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\t| MarkedArrayLike<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 * @internal\n */\nexport type ContextuallyTypedFieldData = ContextuallyTypedNodeData | undefined;\n\n/**\n * Checks the type of a `ContextuallyTypedNodeData`.\n */\nexport function isArrayLike(\n\tdata: ContextuallyTypedFieldData,\n): data is\n\t| readonly ContextuallyTypedNodeData[]\n\t| ReadonlyMarkedArrayLike<ContextuallyTypedNodeData> {\n\tif (typeof data !== \"object\" || data === null) {\n\t\treturn false;\n\t}\n\treturn (\n\t\t(data as Partial<MarkedArrayLike<ContextuallyTypedNodeData>>)[arrayLikeMarkerSymbol] ===\n\t\t\ttrue || Array.isArray(data)\n\t);\n}\n\n/**\n * Checks the type of a `ContextuallyTypedNodeData`.\n * @internal\n */\nexport function isContextuallyTypedNodeDataObject(\n\tdata: ContextuallyTypedNodeData | undefined,\n): data is ContextuallyTypedNodeDataObject {\n\treturn !(isTreeValue(data) || isArrayLike(data));\n}\n\n/**\n * Object case of {@link ContextuallyTypedNodeData}.\n * @internal\n */\nexport interface ContextuallyTypedNodeDataObject {\n\t/**\n\t * Value stored on this node.\n\t */\n\treadonly [valueSymbol]?: Value;\n\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\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(!areCursors(data), 0x6b1 /* cursors cannot be used as contextually typed data. */);\n\tassert(\n\t\tdata !== undefined,\n\t\t0x6b2 /* undefined cannot be used as contextually typed data. Use ContextuallyTypedFieldData. */,\n\t);\n\n\tif (schema instanceof LeafNodeSchema) {\n\t\t// Reject objects with no value from being leaf nodes.\n\t\t// Note that if allowing IFluidHandles without wrapping them in a leaf node object,\n\t\t// this (or the above isPrimitiveValue) would have to change.\n\n\t\tif (isTreeValue(data)) {\n\t\t\treturn allowsValue(schema.leafValue, data);\n\t\t}\n\t\tif ((data as ContextuallyTypedNodeDataObject)[valueSymbol] === undefined) {\n\t\t\treturn false;\n\t\t}\n\t}\n\tif (isTreeValue(data)) {\n\t\treturn false;\n\t}\n\tif (isArrayLike(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[typeNameSymbol] !== undefined) {\n\t\treturn data[typeNameSymbol] === schema.name;\n\t}\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 * Construct a tree from ContextuallyTypedNodeData.\n *\n * TODO: this should probably be refactored into a `try` function which either returns a Cursor or a SchemaError with a path to the error.\n * @returns a cursor in Nodes mode for a single node containing the provided data.\n * @internal\n */\nexport function cursorFromContextualData(\n\tcontext: TreeDataContext,\n\ttypeSet: AllowedTypeSet,\n\tdata: ContextuallyTypedNodeData,\n): ITreeCursorSynchronous {\n\tconst mapTree = applyTypesFromContext(context, typeSet, data);\n\treturn cursorForMapTreeNode(mapTree);\n}\n\n/**\n * Strongly typed {@link cursorFromContextualData} for a TreeNodeSchema.\n * @returns a cursor in Nodes mode for a single node containing the provided data.\n * @internal\n */\nexport function cursorForTypedTreeData<T extends FlexTreeNodeSchema>(\n\tcontext: TreeDataContext,\n\tschema: T,\n\tdata: InsertableFlexNode<T>,\n): ITreeCursorSynchronous {\n\treturn cursorFromContextualData(\n\t\tcontext,\n\t\tnew Set([schema]),\n\t\tdata as ContextuallyTypedNodeData,\n\t);\n}\n\n/**\n * Strongly typed {@link cursorFromContextualData} for AllowedTypes.\n * @returns a cursor in Nodes mode for a single node containing the provided data.\n * @internal\n */\nexport function cursorForTypedData<T extends FlexAllowedTypes>(\n\tcontext: TreeDataContext,\n\tschema: T,\n\tdata: AllowedTypesToFlexInsertableTree<T>,\n): ITreeCursorSynchronous {\n\treturn cursorFromContextualData(\n\t\tcontext,\n\t\tallowedTypesSchemaSet(schema),\n\t\tdata as unknown as ContextuallyTypedNodeData,\n\t);\n}\n\n/**\n * Construct a tree from ContextuallyTypedNodeData.\n * Returns a cursor in Field mode.\n *\n * TODO: this should probably be refactored into a `try` function which either returns a Cursor or a SchemaError with a path to the error.\n */\nexport function cursorsFromContextualData(\n\tcontext: TreeDataContext,\n\tfield: FlexFieldSchema,\n\tdata: ContextuallyTypedNodeData | undefined,\n): ITreeCursorSynchronous {\n\tconst mapTrees = applyFieldTypesFromContext(context, field, data);\n\treturn cursorForMapTreeField(mapTrees);\n}\n\n/**\n * Strongly typed {@link cursorsFromContextualData} for a TreeFieldSchema\n * @internal\n */\nexport function cursorsForTypedFieldData<T extends FlexFieldSchema>(\n\tcontext: TreeDataContext,\n\tschema: T,\n\tdata: InsertableFlexField<T>,\n): ITreeCursorSynchronous {\n\treturn cursorsFromContextualData(context, schema, data as ContextuallyTypedNodeData);\n}\n\n/**\n * Construct a MapTree from ContextuallyTypedNodeData.\n *\n * TODO: this should probably be refactored into a `try` function which either returns a MapTree or a SchemaError with a path to the error.\n * TODO: test suite.\n *\n * @remarks\n * This version is only exported as a more testable entry point than `cursorFromContextualData` which keeps the use of `MapTree` as an implementation detail.\n * This should not be reexported from the parent module.\n */\nexport function applyTypesFromContext(\n\tcontext: TreeDataContext,\n\ttypeSet: AllowedTypeSet,\n\tdata: ContextuallyTypedNodeData,\n): MapTree {\n\tconst possibleTypes: FlexTreeNodeSchema[] = getPossibleTypes(context.schema, typeSet, data);\n\n\tassert(\n\t\tpossibleTypes.length !== 0,\n\t\t0x4d4 /* data incompatible with all types allowed by the schema */,\n\t);\n\tassert(\n\t\tpossibleTypes.length === 1,\n\t\t0x4d5 /* data compatible with more than one type allowed by the schema */,\n\t);\n\n\tconst schema = possibleTypes[0];\n\n\tif (schema instanceof LeafNodeSchema) {\n\t\tconst value = isTreeValue(data)\n\t\t\t? data\n\t\t\t: (data as ContextuallyTypedNodeDataObject)[valueSymbol];\n\n\t\tassert(\n\t\t\tallowsValue(schema.leafValue, value),\n\t\t\t0x4d3 /* unsupported schema for provided primitive */,\n\t\t);\n\t\treturn { value, type: schema.name, fields: new Map() };\n\t}\n\tassert(!isTreeValue(data), 0x880 /* leaf value for non leaf */);\n\tif (schema instanceof FlexFieldNodeSchema) {\n\t\tif (isArrayLike(data)) {\n\t\t\tconst children = applyFieldTypesFromContext(context, schema.getFieldSchema(), data);\n\t\t\treturn {\n\t\t\t\tvalue: undefined,\n\t\t\t\ttype: schema.name,\n\t\t\t\tfields: new Map(children.length > 0 ? [[EmptyKey, children]] : []),\n\t\t\t};\n\t\t}\n\t}\n\tassert(!isArrayLike(data), 0x881 /* array for non field node */);\n\tif (\n\t\tschema instanceof FlexMapNodeSchema ||\n\t\tschema instanceof FlexObjectNodeSchema ||\n\t\tschema instanceof FlexFieldNodeSchema\n\t) {\n\t\tconst fields: Map<FieldKey, MapTree[]> = new Map();\n\t\tfor (const key of fieldKeysFromData(data)) {\n\t\t\tassert(!fields.has(key), 0x6b3 /* Keys should not be duplicated */);\n\t\t\tconst childSchema = schema.getFieldSchema(key);\n\t\t\tconst children = applyFieldTypesFromContext(context, childSchema, data[key]);\n\n\t\t\tif (children.length > 0) {\n\t\t\t\tfields.set(key, children);\n\t\t\t}\n\t\t}\n\n\t\tif (schema instanceof FlexObjectNodeSchema) {\n\t\t\tfor (const key of schema.objectNodeFields.keys()) {\n\t\t\t\tif (data[key] === undefined) {\n\t\t\t\t\tsetFieldForKey(key, context, schema, fields);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\n\t\tconst value = data[valueSymbol];\n\t\tassert(value === undefined, 0x4d7 /* provided value not permitted by the schema */);\n\t\treturn { value, type: schema.name, fields };\n\t} else {\n\t\tfail(\"unexpected node kind\");\n\t}\n}\n\nfunction setFieldForKey(\n\tkey: FieldKey,\n\tcontext: TreeDataContext,\n\tschema: FlexTreeNodeSchema,\n\tfields: Map<FieldKey, MapTree[]>,\n): void {\n\tconst requiredFieldSchema = schema.getFieldSchema(key);\n\tconst multiplicity = getFieldKind(requiredFieldSchema).multiplicity;\n\tif (multiplicity === Multiplicity.Single && context.fieldSource !== undefined) {\n\t\tconst fieldGenerator = context.fieldSource(key, requiredFieldSchema.stored);\n\t\tif (fieldGenerator !== undefined) {\n\t\t\tconst children = fieldGenerator();\n\t\t\tfields.set(key, children);\n\t\t}\n\t}\n}\n\nfunction fieldKeysFromData(data: ContextuallyTypedNodeDataObject): FieldKey[] {\n\tconst keys: (string | symbol)[] = Reflect.ownKeys(data).filter(\n\t\t(key) => typeof key === \"string\",\n\t);\n\treturn keys as FieldKey[];\n}\n\n/**\n * Construct a MapTree from ContextuallyTypedNodeData.\n *\n * TODO: this should probably be refactored into a `try` function which either returns a MapTree or a SchemaError with a path to the error.\n * TODO: test suite.\n *\n * @remarks\n * This version is only exported as a more testable entry point than `cursorsFromContextualData` which keeps the use of `MapTree` as an implementation detail.\n * This should not be reexported from the parent module.\n */\nexport function applyFieldTypesFromContext(\n\tcontext: TreeDataContext,\n\tfield: FlexFieldSchema,\n\tdata: ContextuallyTypedFieldData,\n): MapTree[] {\n\tconst multiplicity = getFieldKind(field).multiplicity;\n\tif (data === undefined) {\n\t\tassert(\n\t\t\tmultiplicity === Multiplicity.Forbidden || multiplicity === Multiplicity.Optional,\n\t\t\t0x4d8 /* `undefined` provided for a field that does not support `undefined` */,\n\t\t);\n\t\treturn [];\n\t}\n\tif (multiplicity === Multiplicity.Sequence) {\n\t\tassert(isArrayLike(data), 0x4d9 /* expected array for a sequence field */);\n\t\tconst children = Array.from(data, (child) =>\n\t\t\tapplyTypesFromContext(context, field.allowedTypeSet, child),\n\t\t);\n\t\treturn children;\n\t}\n\tassert(\n\t\tmultiplicity === Multiplicity.Single || multiplicity === Multiplicity.Optional,\n\t\t0x4da /* single value provided for an unsupported field */,\n\t);\n\treturn [applyTypesFromContext(context, field.allowedTypeSet, data)];\n}\n\n/**\n * Content to use for a field.\n *\n * When used, this content will be deeply copied into the tree, and must comply with the schema.\n *\n * The content must follow the {@link Multiplicity} of the {@link FlexFieldKind}:\n * - use a single cursor for an `optional` or `value` field;\n * - use array of cursors for a `sequence` field;\n *\n * TODO: this should allow a field cursor instead of an array of cursors.\n * TODO: Make this generic so a variant of this type that allows placeholders for detached sequences to consume.\n * @internal\n */\nexport type NewFieldContent =\n\t| ITreeCursorSynchronous\n\t| readonly ITreeCursorSynchronous[]\n\t| ContextuallyTypedFieldData;\n\n/**\n * Convert NewFieldContent into ITreeCursorSynchronous.\n * The returned cursor will be in Field mode.\n */\nexport function normalizeNewFieldContent(\n\tcontext: TreeDataContext,\n\tschema: FlexFieldSchema,\n\tcontent: NewFieldContent,\n): ITreeCursorSynchronous {\n\tif (areCursors(content)) {\n\t\tif (isReadonlyArray(content)) {\n\t\t\tassert(\n\t\t\t\tgetFieldKind(schema).multiplicity === Multiplicity.Sequence || content.length === 1,\n\t\t\t\t0x6b8 /* non-sequence fields can not be provided content that is multiple cursors */,\n\t\t\t);\n\t\t\t// TODO: is there a better way to get a field cursor from an array of node cursors?\n\t\t\tconst mapTrees = content.map((c) => mapTreeFromCursor(c));\n\t\t\treturn cursorForMapTreeField(mapTrees);\n\t\t}\n\t\tif (content.mode === CursorLocationType.Fields) {\n\t\t\treturn content;\n\t\t}\n\t\t// TODO: is there a better way to get a field cursor from a node cursor?\n\t\treturn cursorForMapTreeField([mapTreeFromCursor(content)]);\n\t}\n\n\treturn cursorsFromContextualData(context, schema, content);\n}\n"]}

package/dist/feature-libraries/schema-aware/index.d.ts

@@ -1,6 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-export type { InsertableFlexNode, InsertableFlexField, AllowedTypesToFlexInsertableTree, ApplyMultiplicity, CollectOptions, TypedFields, UnbrandedName, EmptyObject, } from "./schemaAware.js";
-//# sourceMappingURL=index.d.ts.map

package/dist/feature-libraries/schema-aware/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/schema-aware/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,YAAY,EACX,kBAAkB,EAClB,mBAAmB,EACnB,gCAAgC,EAChC,iBAAiB,EAEjB,cAAc,EACd,WAAW,EACX,aAAa,EACb,WAAW,GACX,MAAM,kBAAkB,CAAC"}

package/dist/feature-libraries/schema-aware/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/feature-libraries/schema-aware/index.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport type {\n\tInsertableFlexNode,\n\tInsertableFlexField,\n\tAllowedTypesToFlexInsertableTree,\n\tApplyMultiplicity,\n\t// Internal\n\tCollectOptions,\n\tTypedFields,\n\tUnbrandedName,\n\tEmptyObject,\n} from \"./schemaAware.js\";\n"]}

package/dist/feature-libraries/schema-aware/schemaAware.d.ts

@@ -1,76 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import type { TreeNodeSchemaIdentifier, TreeValue, ValueSchema, Multiplicity } from "../../core/index.js";
-import type { Assume, FlattenKeys, _InlineTrick } from "../../util/index.js";
-import type { ContextuallyTypedNodeData, typeNameSymbol, valueSymbol } from "../contextuallyTyped.js";
-import type { FlexAllowedTypes, FlexFieldNodeSchema, FlexFieldSchema, FlexListToUnion, FlexMapNodeSchema, FlexObjectNodeFields, FlexObjectNodeSchema, FlexTreeNodeSchema, LazyItem, LeafNodeSchema } from "../typed-schema/index.js";
-/**
- * Empty Object for use in type computations that should contribute no fields when `&`ed with another type.
- * @internal
- */
-export type EmptyObject = {};
-/**
- * Collects the various parts of the API together.
- * @internal
- */
-export type CollectOptions<TTypedFields, TValueSchema extends ValueSchema | undefined, TName> = TValueSchema extends undefined ? FlattenKeys<{
-    [typeNameSymbol]?: UnbrandedName<TName>;
-} & (TValueSchema extends ValueSchema ? {
-    [valueSymbol]: TreeValue<TValueSchema>;
-} : EmptyObject)> & TTypedFields : TValueSchema extends ValueSchema ? TreeValue<TValueSchema> : undefined;
-/**
- * Remove type brand from name.
- * @internal
- */
-export type UnbrandedName<TName> = [
-    TName extends TreeNodeSchemaIdentifier<infer S> ? S : string
-][_InlineTrick];
-/**
- * `{ [key: string]: FieldSchemaTypeInfo }` to `{ [key: string]: TypedTree }`
- *
- * In Editable mode, unwraps the fields.
- * @internal
- */
-export type TypedFields<TFields extends undefined | {
-    readonly [key: string]: FlexFieldSchema;
-}> = [
-    TFields extends {
-        [key: string]: FlexFieldSchema;
-    } ? {
-        -readonly [key in keyof TFields]: InsertableFlexField<TFields[key]>;
-    } : EmptyObject
-][_InlineTrick];
-/**
- * `TreeFieldSchema` to `TypedField`. May unwrap to child depending on FieldKind.
- * @internal
- */
-export type InsertableFlexField<TField extends FlexFieldSchema> = [
-    ApplyMultiplicity<TField["kind"]["multiplicity"], AllowedTypesToFlexInsertableTree<TField["allowedTypes"]>>
-][_InlineTrick];
-/**
- * Adjusts the API for a field based on its Multiplicity.
- * @internal
- */
-export type ApplyMultiplicity<TMultiplicity extends Multiplicity, TypedChild> = {
-    [Multiplicity.Forbidden]: undefined;
-    [Multiplicity.Optional]: undefined | TypedChild;
-    [Multiplicity.Sequence]: TypedChild[];
-    [Multiplicity.Single]: TypedChild;
-}[TMultiplicity];
-/**
- * Takes in `AllowedTypes` and returns a TypedTree union.
- * @internal
- */
-export type AllowedTypesToFlexInsertableTree<T extends FlexAllowedTypes> = [
-    T extends readonly LazyItem<FlexTreeNodeSchema>[] ? InsertableFlexNode<Assume<FlexListToUnion<T>, FlexTreeNodeSchema>> : ContextuallyTypedNodeData
-][_InlineTrick];
-/**
- * Generate a schema aware API for a single tree schema.
- * @internal
- */
-export type InsertableFlexNode<TSchema extends FlexTreeNodeSchema> = FlattenKeys<CollectOptions<TSchema extends FlexObjectNodeSchema<string, infer TFields extends FlexObjectNodeFields> ? TypedFields<TFields> : TSchema extends FlexFieldNodeSchema<string, infer TField extends FlexFieldSchema> ? InsertableFlexField<TField> : TSchema extends FlexMapNodeSchema<string, infer TField extends FlexFieldSchema> ? {
-    readonly [P in string]: InsertableFlexField<TField>;
-} : EmptyObject, TSchema extends LeafNodeSchema<string, infer TValueSchema extends ValueSchema> ? TValueSchema : undefined, TSchema["name"]>>;
-//# sourceMappingURL=schemaAware.d.ts.map

package/dist/feature-libraries/schema-aware/schemaAware.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"schemaAware.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/schema-aware/schemaAware.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EACX,wBAAwB,EACxB,SAAS,EACT,WAAW,EACX,YAAY,EACZ,MAAM,qBAAqB,CAAC;AAC7B,OAAO,KAAK,EAAE,MAAM,EAAE,WAAW,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AAC7E,OAAO,KAAK,EACX,yBAAyB,EACzB,cAAc,EACd,WAAW,EACX,MAAM,yBAAyB,CAAC;AACjC,OAAO,KAAK,EACX,gBAAgB,EAChB,mBAAmB,EACnB,eAAe,EACf,eAAe,EACf,iBAAiB,EACjB,oBAAoB,EACpB,oBAAoB,EACpB,kBAAkB,EAClB,QAAQ,EACR,cAAc,EACd,MAAM,0BAA0B,CAAC;AAElC;;;GAGG;AAIH,MAAM,MAAM,WAAW,GAAG,EAAE,CAAC;AAE7B;;;GAGG;AACH,MAAM,MAAM,cAAc,CACzB,YAAY,EACZ,YAAY,SAAS,WAAW,GAAG,SAAS,EAC5C,KAAK,IACF,YAAY,SAAS,SAAS,GAC/B,WAAW,CACX;IAAE,CAAC,cAAc,CAAC,CAAC,EAAE,aAAa,CAAC,KAAK,CAAC,CAAA;CAAE,GAAG,CAAC,YAAY,SAAS,WAAW,GAC5E;IAAE,CAAC,WAAW,CAAC,EAAE,SAAS,CAAC,YAAY,CAAC,CAAA;CAAE,GAC1C,WAAW,CAAC,CACf,GACA,YAAY,GACZ,YAAY,SAAS,WAAW,GAC/B,SAAS,CAAC,YAAY,CAAC,GACvB,SAAS,CAAC;AAEd;;;GAGG;AACH,MAAM,MAAM,aAAa,CAAC,KAAK,IAAI;IAClC,KAAK,SAAS,wBAAwB,CAAC,MAAM,CAAC,CAAC,GAAG,CAAC,GAAG,MAAM;CAC5D,CAAC,YAAY,CAAC,CAAC;AAEhB;;;;;GAKG;AACH,MAAM,MAAM,WAAW,CACtB,OAAO,SAAS,SAAS,GAAG;IAAE,QAAQ,EAAE,GAAG,EAAE,MAAM,GAAG,eAAe,CAAA;CAAE,IACpE;IACH,OAAO,SAAS;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,eAAe,CAAA;KAAE,GAC/C;QACA,CAAC,UAAU,GAAG,IAAI,MAAM,OAAO,GAAG,mBAAmB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;KACnE,GACA,WAAW;CACd,CAAC,YAAY,CAAC,CAAC;AAEhB;;;GAGG;AACH,MAAM,MAAM,mBAAmB,CAAC,MAAM,SAAS,eAAe,IAAI;IACjE,iBAAiB,CAChB,MAAM,CAAC,MAAM,CAAC,CAAC,cAAc,CAAC,EAC9B,gCAAgC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CACxD;CACD,CAAC,YAAY,CAAC,CAAC;AAEhB;;;GAGG;AACH,MAAM,MAAM,iBAAiB,CAAC,aAAa,SAAS,YAAY,EAAE,UAAU,IAAI;IAC/E,CAAC,YAAY,CAAC,SAAS,CAAC,EAAE,SAAS,CAAC;IACpC,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,SAAS,GAAG,UAAU,CAAC;IAChD,CAAC,YAAY,CAAC,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAC;IACtC,CAAC,YAAY,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC;CAClC,CAAC,aAAa,CAAC,CAAC;AAEjB;;;GAGG;AACH,MAAM,MAAM,gCAAgC,CAAC,CAAC,SAAS,gBAAgB,IAAI;IAC1E,CAAC,SAAS,SAAS,QAAQ,CAAC,kBAAkB,CAAC,EAAE,GAC9C,kBAAkB,CAAC,MAAM,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,kBAAkB,CAAC,CAAC,GAClE,yBAAyB;CAC5B,CAAC,YAAY,CAAC,CAAC;AAEhB;;;GAGG;AACH,MAAM,MAAM,kBAAkB,CAAC,OAAO,SAAS,kBAAkB,IAAI,WAAW,CAC/E,cAAc,CACb,OAAO,SAAS,oBAAoB,CAAC,MAAM,EAAE,MAAM,OAAO,SAAS,oBAAoB,CAAC,GACrF,WAAW,CAAC,OAAO,CAAC,GACpB,OAAO,SAAS,mBAAmB,CAAC,MAAM,EAAE,MAAM,MAAM,SAAS,eAAe,CAAC,GAChF,mBAAmB,CAAC,MAAM,CAAC,GAC3B,OAAO,SAAS,iBAAiB,CAAC,MAAM,EAAE,MAAM,MAAM,SAAS,eAAe,CAAC,GAC9E;IACA,QAAQ,EAAE,CAAC,IAAI,MAAM,GAAG,mBAAmB,CAAC,MAAM,CAAC;CACnD,GACA,WAAW,EAChB,OAAO,SAAS,cAAc,CAAC,MAAM,EAAE,MAAM,YAAY,SAAS,WAAW,CAAC,GAC3E,YAAY,GACZ,SAAS,EACZ,OAAO,CAAC,MAAM,CAAC,CACf,CACD,CAAC"}

package/dist/feature-libraries/schema-aware/schemaAware.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"schemaAware.js","sourceRoot":"","sources":["../../../src/feature-libraries/schema-aware/schemaAware.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type {\n\tTreeNodeSchemaIdentifier,\n\tTreeValue,\n\tValueSchema,\n\tMultiplicity,\n} from \"../../core/index.js\";\nimport type { Assume, FlattenKeys, _InlineTrick } from \"../../util/index.js\";\nimport type {\n\tContextuallyTypedNodeData,\n\ttypeNameSymbol,\n\tvalueSymbol,\n} from \"../contextuallyTyped.js\";\nimport type {\n\tFlexAllowedTypes,\n\tFlexFieldNodeSchema,\n\tFlexFieldSchema,\n\tFlexListToUnion,\n\tFlexMapNodeSchema,\n\tFlexObjectNodeFields,\n\tFlexObjectNodeSchema,\n\tFlexTreeNodeSchema,\n\tLazyItem,\n\tLeafNodeSchema,\n} from \"../typed-schema/index.js\";\n\n/**\n * Empty Object for use in type computations that should contribute no fields when `&`ed with another type.\n * @internal\n */\n// Using {} instead of interface {} or Record<string, never> for empty object here produces better IntelliSense in the generated types than `Record<string, never>` recommended by the linter.\n// Making this a type instead of an interface prevents it from showing up in IntelliSense, and also avoids breaking the typing somehow.\n// eslint-disable-next-line @typescript-eslint/ban-types, @typescript-eslint/consistent-type-definitions\nexport type EmptyObject = {};\n\n/**\n * Collects the various parts of the API together.\n * @internal\n */\nexport type CollectOptions<\n\tTTypedFields,\n\tTValueSchema extends ValueSchema | undefined,\n\tTName,\n> = TValueSchema extends undefined\n\t? FlattenKeys<\n\t\t\t{ [typeNameSymbol]?: UnbrandedName<TName> } & (TValueSchema extends ValueSchema\n\t\t\t\t? { [valueSymbol]: TreeValue<TValueSchema> }\n\t\t\t\t: EmptyObject)\n\t\t> &\n\t\t\tTTypedFields\n\t: TValueSchema extends ValueSchema\n\t\t? TreeValue<TValueSchema>\n\t\t: undefined;\n\n/**\n * Remove type brand from name.\n * @internal\n */\nexport type UnbrandedName<TName> = [\n\tTName extends TreeNodeSchemaIdentifier<infer S> ? S : string,\n][_InlineTrick];\n\n/**\n * `{ [key: string]: FieldSchemaTypeInfo }` to `{ [key: string]: TypedTree }`\n *\n * In Editable mode, unwraps the fields.\n * @internal\n */\nexport type TypedFields<\n\tTFields extends undefined | { readonly [key: string]: FlexFieldSchema },\n> = [\n\tTFields extends { [key: string]: FlexFieldSchema }\n\t\t? {\n\t\t\t\t-readonly [key in keyof TFields]: InsertableFlexField<TFields[key]>;\n\t\t\t}\n\t\t: EmptyObject,\n][_InlineTrick];\n\n/**\n * `TreeFieldSchema` to `TypedField`. May unwrap to child depending on FieldKind.\n * @internal\n */\nexport type InsertableFlexField<TField extends FlexFieldSchema> = [\n\tApplyMultiplicity<\n\t\tTField[\"kind\"][\"multiplicity\"],\n\t\tAllowedTypesToFlexInsertableTree<TField[\"allowedTypes\"]>\n\t>,\n][_InlineTrick];\n\n/**\n * Adjusts the API for a field based on its Multiplicity.\n * @internal\n */\nexport type ApplyMultiplicity<TMultiplicity extends Multiplicity, TypedChild> = {\n\t[Multiplicity.Forbidden]: undefined;\n\t[Multiplicity.Optional]: undefined | TypedChild;\n\t[Multiplicity.Sequence]: TypedChild[];\n\t[Multiplicity.Single]: TypedChild;\n}[TMultiplicity];\n\n/**\n * Takes in `AllowedTypes` and returns a TypedTree union.\n * @internal\n */\nexport type AllowedTypesToFlexInsertableTree<T extends FlexAllowedTypes> = [\n\tT extends readonly LazyItem<FlexTreeNodeSchema>[]\n\t\t? InsertableFlexNode<Assume<FlexListToUnion<T>, FlexTreeNodeSchema>>\n\t\t: ContextuallyTypedNodeData,\n][_InlineTrick];\n\n/**\n * Generate a schema aware API for a single tree schema.\n * @internal\n */\nexport type InsertableFlexNode<TSchema extends FlexTreeNodeSchema> = FlattenKeys<\n\tCollectOptions<\n\t\tTSchema extends FlexObjectNodeSchema<string, infer TFields extends FlexObjectNodeFields>\n\t\t\t? TypedFields<TFields>\n\t\t\t: TSchema extends FlexFieldNodeSchema<string, infer TField extends FlexFieldSchema>\n\t\t\t\t? InsertableFlexField<TField>\n\t\t\t\t: TSchema extends FlexMapNodeSchema<string, infer TField extends FlexFieldSchema>\n\t\t\t\t\t? {\n\t\t\t\t\t\t\treadonly [P in string]: InsertableFlexField<TField>;\n\t\t\t\t\t\t}\n\t\t\t\t\t: EmptyObject,\n\t\tTSchema extends LeafNodeSchema<string, infer TValueSchema extends ValueSchema>\n\t\t\t? TValueSchema\n\t\t\t: undefined,\n\t\tTSchema[\"name\"]\n\t>\n>;\n"]}

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

@@ -1,41 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-import type { LocalNodeKey, StableNodeKey } from "../feature-libraries/index.js";
-import type { TreeNode } from "./types.js";
-/**
- * A collection of utilities for managing {@link StableNodeKey}s.
- * A node key can be assigned to a node and allows that node to be easily retrieved from the tree at a later time. (see `nodeKey.map`).
- * @remarks {@link LocalNodeKey}s are put on {@link FlexTreeObjectNode}s via a special field.
- * A node with a node key in its schema must always have a node key.
- * TODO: A node key index leveraging this {@link NodeKeys} interface should be implemented for the simple tree layer.
- * @internal
- */
-export interface NodeKeys {
-    /**
-     * Create a new {@link LocalNodeKey} which can be used as the key for a node in the tree.
-     */
-    generate(): LocalNodeKey;
-    /**
-     * Convert the given {@link LocalNodeKey} into a UUID that can be serialized.
-     * @param key - the key to convert
-     */
-    stabilize(key: LocalNodeKey): StableNodeKey;
-    /**
-     * Convert a {@link StableNodeKey} back into its {@link LocalNodeKey} form.
-     * @param key - the key to convert
-     */
-    localize(key: StableNodeKey): LocalNodeKey;
-    /**
-     * Attempts to recompress a string key back into its {@link LocalNodeKey} form.
-     * @param key - The key to convert.
-     * @returns The {@link LocalNodeKey} associated with `key` or undefined if the key was not generated by any session known to this compressor.
-     */
-    tryLocalize(key: string): LocalNodeKey | undefined;
-    /**
-     * A map of all {@link LocalNodeKey}s in the document to their corresponding nodes.
-     */
-    readonly map: ReadonlyMap<LocalNodeKey, TreeNode>;
-}
-//# sourceMappingURL=nodeKeys.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"nodeKeys.d.ts","sourceRoot":"","sources":["../../src/simple-tree/nodeKeys.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AACjF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAE3C;;;;;;;GAOG;AACH,MAAM,WAAW,QAAQ;IACxB;;OAEG;IACH,QAAQ,IAAI,YAAY,CAAC;IACzB;;;OAGG;IACH,SAAS,CAAC,GAAG,EAAE,YAAY,GAAG,aAAa,CAAC;IAC5C;;;OAGG;IACH,QAAQ,CAAC,GAAG,EAAE,aAAa,GAAG,YAAY,CAAC;IAC3C;;;;OAIG;IACH,WAAW,CAAC,GAAG,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS,CAAC;IACnD;;OAEG;IACH,QAAQ,CAAC,GAAG,EAAE,WAAW,CAAC,YAAY,EAAE,QAAQ,CAAC,CAAC;CAClD"}

package/dist/simple-tree/nodeKeys.js

@@ -1,7 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-//# sourceMappingURL=nodeKeys.js.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"nodeKeys.js","sourceRoot":"","sources":["../../src/simple-tree/nodeKeys.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport type { LocalNodeKey, StableNodeKey } from \"../feature-libraries/index.js\";\nimport type { TreeNode } from \"./types.js\";\n\n/**\n * A collection of utilities for managing {@link StableNodeKey}s.\n * A node key can be assigned to a node and allows that node to be easily retrieved from the tree at a later time. (see `nodeKey.map`).\n * @remarks {@link LocalNodeKey}s are put on {@link FlexTreeObjectNode}s via a special field.\n * A node with a node key in its schema must always have a node key.\n * TODO: A node key index leveraging this {@link NodeKeys} interface should be implemented for the simple tree layer.\n * @internal\n */\nexport interface NodeKeys {\n\t/**\n\t * Create a new {@link LocalNodeKey} which can be used as the key for a node in the tree.\n\t */\n\tgenerate(): LocalNodeKey;\n\t/**\n\t * Convert the given {@link LocalNodeKey} into a UUID that can be serialized.\n\t * @param key - the key to convert\n\t */\n\tstabilize(key: LocalNodeKey): StableNodeKey;\n\t/**\n\t * Convert a {@link StableNodeKey} back into its {@link LocalNodeKey} form.\n\t * @param key - the key to convert\n\t */\n\tlocalize(key: StableNodeKey): LocalNodeKey;\n\t/**\n\t * Attempts to recompress a string key back into its {@link LocalNodeKey} form.\n\t * @param key - The key to convert.\n\t * @returns The {@link LocalNodeKey} associated with `key` or undefined if the key was not generated by any session known to this compressor.\n\t */\n\ttryLocalize(key: string): LocalNodeKey | undefined;\n\t/**\n\t * A map of all {@link LocalNodeKey}s in the document to their corresponding nodes.\n\t */\n\treadonly map: ReadonlyMap<LocalNodeKey, TreeNode>;\n}\n"]}

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

@@ -1 +0,0 @@
-{"version":3,"file":"schemaCaching.d.ts","sourceRoot":"","sources":["../../src/simple-tree/schemaCaching.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EACX,eAAe,EACf,kBAAkB,EAClB,kBAAkB,EAClB,MAAM,+BAA+B,CAAC;AAGvC,OAAO,EACN,KAAK,WAAW,EAChB,KAAK,mBAAmB,EACxB,KAAK,cAAc,EAEnB,MAAM,kBAAkB,CAAC;AAkB1B,wBAAgB,+BAA+B,CAC9C,MAAM,EAAE,cAAc,GACpB,kBAAkB,GAAG,SAAS,CAGhC;AAED,wBAAgB,4BAA4B,CAC3C,MAAM,EAAE,cAAc,EACtB,IAAI,EAAE,kBAAkB,GACtB,IAAI,CAON;AAED;;;GAGG;AACH,wBAAgB,sBAAsB,CACrC,UAAU,EAAE,kBAAkB,GAC5B,cAAc,GAAG,SAAS,CAK5B;AAED;;;GAGG;AACH,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,kBAAkB,GAAG,cAAc,CAElF;AAED;;;;;GAKG;AACH,wBAAgB,oBAAoB,CACnC,UAAU,EAAE,eAAe,EAC3B,oBAAoB,EAAE,mBAAmB,GACvC,WAAW,CASb"}

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

@@ -1 +0,0 @@
-{"version":3,"file":"schemaCaching.js","sourceRoot":"","sources":["../../src/simple-tree/schemaCaching.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kEAA6D;AAO7D,+CAAwC;AAExC,qDAK0B;AAE1B;;;GAGG;AACH,MAAM,gBAAgB,GAAkB,MAAM,CAAC,YAAY,CAAC,CAAC;AAE7D;;GAEG;AACH,MAAM,sBAAsB,GAAkB,MAAM,CAAC,kBAAkB,CAAC,CAAC;AAEzE;;GAEG;AACH,MAAM,uBAAuB,GAAkB,MAAM,CAAC,mBAAmB,CAAC,CAAC;AAE3E,SAAgB,+BAA+B,CAC9C,MAAsB;IAEtB,8DAA8D;IAC9D,OAAQ,MAAc,CAAC,gBAAgB,CAAmC,CAAC;AAC5E,CAAC;AALD,0EAKC;AAED,SAAgB,4BAA4B,CAC3C,MAAsB,EACtB,IAAwB;IAExB,IAAA,iBAAM,EAAC,CAAC,CAAC,gBAAgB,IAAI,MAAM,CAAC,EAAE,KAAK,CAAC,kCAAkC,CAAC,CAAC;IAChF,IAAA,iBAAM,EAAC,CAAC,CAAC,sBAAsB,IAAI,IAAI,CAAC,EAAE,KAAK,CAAC,gCAAgC,CAAC,CAAC;IAClF,8DAA8D;IAC7D,MAAc,CAAC,gBAAgB,CAAC,GAAG,IAAI,CAAC;IACzC,8DAA8D;IAC7D,IAAY,CAAC,sBAAsB,CAAC,GAAG,MAAM,CAAC;AAChD,CAAC;AAVD,oEAUC;AAED;;;GAGG;AACH,SAAgB,sBAAsB,CACrC,UAA8B;IAE9B,IAAI,sBAAsB,IAAI,UAAU,EAAE,CAAC;QAC1C,OAAO,UAAU,CAAC,sBAAsB,CAAmB,CAAC;IAC7D,CAAC;IACD,OAAO,SAAS,CAAC;AAClB,CAAC;AAPD,wDAOC;AAED;;;GAGG;AACH,SAAgB,mBAAmB,CAAC,UAA8B;IACjE,OAAO,sBAAsB,CAAC,UAAU,CAAC,IAAI,IAAA,eAAI,EAAC,uBAAuB,CAAC,CAAC;AAC5E,CAAC;AAFD,kDAEC;AAED;;;;;GAKG;AACH,SAAgB,oBAAoB,CACnC,UAA2B,EAC3B,oBAAyC;IAEzC,IAAI,uBAAuB,IAAI,UAAU,EAAE,CAAC;QAC3C,OAAO,UAAU,CAAC,uBAAuB,CAAgB,CAAC;IAC3D,CAAC;IAED,MAAM,WAAW,GAAG,IAAA,qCAAoB,EAAC,oBAAoB,CAAC,CAAC;IAC/D,8DAA8D;IAC7D,UAAkB,CAAC,uBAAuB,CAAC,GAAG,WAAW,CAAC;IAC3D,OAAO,WAAW,CAAC;AACpB,CAAC;AAZD,oDAYC","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\";\n\nimport type {\n\tFlexFieldSchema,\n\tFlexTreeNodeSchema,\n\tTreeNodeSchemaBase,\n} from \"../feature-libraries/index.js\";\nimport { fail } from \"../util/index.js\";\n\nimport {\n\ttype FieldSchema,\n\ttype ImplicitFieldSchema,\n\ttype TreeNodeSchema,\n\tnormalizeFieldSchema,\n} from \"./schemaTypes.js\";\n\n/**\n * A symbol for storing FlexTreeSchema on TreeNodeSchema.\n * Eagerly set on leaves, and lazily set for other cases.\n */\nconst flexSchemaSymbol: unique symbol = Symbol(`flexSchema`);\n\n/**\n * A symbol for storing TreeNodeSchema on FlexTreeNode's schema.\n */\nconst simpleNodeSchemaSymbol: unique symbol = Symbol(`simpleNodeSchema`);\n\n/**\n * A symbol for storing {@link FieldSchema}s on a {@link FlexFieldSchema}.\n */\nconst simpleFieldSchemaSymbol: unique symbol = Symbol(`simpleFieldSchema`);\n\nexport function cachedFlexSchemaFromClassSchema(\n\tschema: TreeNodeSchema,\n): TreeNodeSchemaBase | undefined {\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\treturn (schema as any)[flexSchemaSymbol] as TreeNodeSchemaBase | undefined;\n}\n\nexport function setFlexSchemaFromClassSchema(\n\tsimple: TreeNodeSchema,\n\tflex: TreeNodeSchemaBase,\n): void {\n\tassert(!(flexSchemaSymbol in simple), 0x91f /* simple schema already marked */);\n\tassert(!(simpleNodeSchemaSymbol in flex), 0x920 /* flex schema already marked */);\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t(simple as any)[flexSchemaSymbol] = flex;\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t(flex as any)[simpleNodeSchemaSymbol] = simple;\n}\n\n/**\n * Gets the {@link TreeNodeSchema} cached on the provided {@link FlexTreeNodeSchema | flexSchema}.\n * Returns `undefined` if no cached value is found.\n */\nexport function tryGetSimpleNodeSchema(\n\tflexSchema: FlexTreeNodeSchema,\n): TreeNodeSchema | undefined {\n\tif (simpleNodeSchemaSymbol in flexSchema) {\n\t\treturn flexSchema[simpleNodeSchemaSymbol] as TreeNodeSchema;\n\t}\n\treturn undefined;\n}\n\n/**\n * Gets the {@link TreeNodeSchema} cached on the provided {@link FlexTreeNodeSchema | flexSchema}.\n * Fails if no cached value is found.\n */\nexport function getSimpleNodeSchema(flexSchema: FlexTreeNodeSchema): TreeNodeSchema {\n\treturn tryGetSimpleNodeSchema(flexSchema) ?? fail(\"missing simple schema\");\n}\n\n/**\n * Gets the {@link FieldSchema} which corresponds with the provided {@link FlexFieldSchema | flexSchema}.\n * Caches the result on the provided `flexSchema` for future access.\n * @param flexSchema - The flex schema on which the result will be cached.\n * @param implicitSimpleSchema - The allowed types from which the `FieldSchema` will be derived.\n */\nexport function getSimpleFieldSchema(\n\tflexSchema: FlexFieldSchema,\n\timplicitSimpleSchema: ImplicitFieldSchema,\n): FieldSchema {\n\tif (simpleFieldSchemaSymbol in flexSchema) {\n\t\treturn flexSchema[simpleFieldSchemaSymbol] as FieldSchema;\n\t}\n\n\tconst fieldSchema = normalizeFieldSchema(implicitSimpleSchema);\n\t// eslint-disable-next-line @typescript-eslint/no-explicit-any\n\t(flexSchema as any)[simpleFieldSchemaSymbol] = fieldSchema;\n\treturn fieldSchema;\n}\n"]}

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

@@ -1 +0,0 @@
-{"version":3,"file":"schemaCreationUtilities.d.ts","sourceRoot":"","sources":["../../src/simple-tree/schemaCreationUtilities.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAGjE,OAAO,KAAK,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAC1E,OAAO,KAAK,EAAkB,QAAQ,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AACtF,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3C,OAAO,KAAK,EAEX,sBAAsB,EACtB,MAAM,iBAAiB,CAAC;AAEzB;;;;;;GAMG;AAGH,wBAAgB,eAAe,CAAC,MAAM,SAAS,MAAM,EAAE,KAAK,SAAS,MAAM,GAAG,MAAM,EACnF,OAAO,EAAE,aAAa,CAAC,MAAM,EAAE,KAAK,CAAC,EACrC,IAAI,EAAE,KAAK;oBAa8C,KAAK;;oBAAL,KAAK;GAiB9D;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AAEH,wBAAgB,SAAS,CAAC,MAAM,SAAS,MAAM,EAAE,KAAK,CAAC,KAAK,SAAS,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,EAC1F,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,EAC9B,OAAO,EAAE,KAAK,+CAmBoC,MAAM;;;;;;MAgBxD;AAED;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,SAAS,MAAM,EAAE,OAAO,EAC7D,MAAM,EAAE,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,GAC3B,OAAO,EAAE,CAEX;AAED;;;;;;;;;;;;;;;;;;GAkBG;AAEH,wBAAgB,eAAe,CAAC,MAAM,SAAS,MAAM,EAAE,KAAK,CAAC,OAAO,SAAS,MAAM,EAClF,OAAO,EAAE,aAAa,CAAC,MAAM,CAAC,EAC9B,OAAO,EAAE,SAAS,OAAO,EAAE,oCASwB,MAAM;;;;;;IAgBzD"}

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

@@ -1 +0,0 @@
-{"version":3,"file":"schemaCreationUtilities.js","sourceRoot":"","sources":["../../src/simple-tree/schemaCreationUtilities.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,uEAAsE;AAGtE,+CAAwC;AAUxC;;;;;;GAMG;AACH,wCAAwC;AACxC,4EAA4E;AAC5E,SAAgB,eAAe,CAC9B,OAAqC,EACrC,IAAW;IAEX,MAAM,eAAgB,SAAQ,OAAO,CAAC,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC;QACrD,YAAmB,IAAkB;YACpC,KAAK,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC;QACnB,CAAC;QACD,IAAW,KAAK;YACf,OAAO,IAAI,CAAC;QACb,CAAC;KACD;IAMD,8IAA8I;IAC9I,2CAA2C;IAC3C,yHAAyH;IACzH,iDAAiD;IACjD,qFAAqF;IACrF,MAAM,QAAQ,GAOU,eAAe,CAAC;IAExC,OAAO,QAAQ,CAAC;AACjB,CAAC;AAhCD,0CAgCC;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,4EAA4E;AAC5E,SAAgB,SAAS,CACxB,OAA8B,EAC9B,OAAc;IAGd,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,CAAC,OAAO,CAAa,CAAC;IAClD,MAAM,OAAO,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,CAGlF,CAAC;IAEF,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,CAAC,MAAM,EAAE,CAAC;QACpC,MAAM,IAAI,qBAAU,CAAC,iDAAiD,CAAC,CAAC;IACzE,CAAC;IAOD,4EAA4E;IAC5E,MAAM,UAAU,GAAG,CAAwB,KAAa,EAAE,EAAE;QAC3D,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,IAAA,eAAI,EAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,CAElE,CAAC;IACH,CAAC,CAAC;IACF,MAAM,GAAG,GAAG,UAAsC,CAAC;IACnD,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACpD,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,GAAG,EAAE;YAC/B,UAAU,EAAE,IAAI;YAChB,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,KAAK;YACf,KAAK,EAAE,eAAe,CAAC,OAAO,EAAE,KAAK,CAAC;SACtC,CAAC,CAAC;IACJ,CAAC;IAED,OAAO,GAAG,CAAC;AACZ,CAAC;AArCD,8BAqCC;AAED;;;GAGG;AACH,SAAgB,iBAAiB,CAChC,MAA6B;IAE7B,OAAO,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;AAC9B,CAAC;AAJD,8CAIC;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,4EAA4E;AAC5E,SAAgB,eAAe,CAC9B,OAA8B,EAC9B,OAA2B;IAE3B,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;IAC/B,IAAI,KAAK,CAAC,IAAI,KAAK,OAAO,CAAC,MAAM,EAAE,CAAC;QACnC,MAAM,IAAI,qBAAU,CAAC,+CAA+C,CAAC,CAAC;IACvE,CAAC;IAGD,4EAA4E;IAC5E,MAAM,UAAU,GAAG,CAAyB,KAAa,EAAE,EAAE;QAC5D,OAAO,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,CAEvB,CAAC;IACH,CAAC,CAAC;IACF,MAAM,GAAG,GAAG,UAAsC,CAAC;IACnD,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;QAC5B,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,IAAI,EAAE;YAChC,UAAU,EAAE,IAAI;YAChB,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,KAAK;YACf,KAAK,EAAE,eAAe,CAAC,OAAO,EAAE,IAAI,CAAC;SACrC,CAAC,CAAC;IACJ,CAAC;IAED,OAAO,GAAG,CAAC;AACZ,CAAC;AA3BD,0CA2BC;AAED,qEAAqE;AACrE,kEAAkE;AAClE,4GAA4G;AAC5G,4EAA4E;AAC5E,SAAS,iBAAiB,CACzB,OAA8B,EAC9B,OAAgB;IAEhB,MAAM,UAAU,GAIZ,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACxB,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;QAC5B,MAAM,CAAC,cAAc,CAAC,UAAU,EAAE,IAAI,EAAE;YACvC,UAAU,EAAE,IAAI;YAChB,YAAY,EAAE,KAAK;YACnB,QAAQ,EAAE,KAAK;YACf,KAAK,EAAE,IAAI;SACX,CAAC,CAAC;IACJ,CAAC;IAED,OAAO,SAAS,CAAC,OAAO,EAAE,UAAU,CAAC,CAAC;AACvC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { UsageError } from \"@fluidframework/telemetry-utils/internal\";\n\nimport type { EmptyObject } from \"../feature-libraries/index.js\";\nimport { fail } from \"../util/index.js\";\n\nimport type { SchemaFactory, ScopedSchemaName } from \"./schemaFactory.js\";\nimport type { NodeFromSchema, NodeKind, TreeNodeSchemaClass } from \"./schemaTypes.js\";\nimport type { TreeNode } from \"./types.js\";\nimport type {\n\tInsertableObjectFromSchemaRecord,\n\tObjectFromSchemaRecord,\n} from \"./objectNode.js\";\n\n/**\n * Create a schema for a node with no state.\n * @remarks\n * This is commonly used in unions when the only information needed is which kind of node the value is.\n * Enums are a common example of this pattern.\n * @internal\n */\n// Return type is intentionally derived.\n// eslint-disable-next-line @typescript-eslint/explicit-function-return-type\nexport function singletonSchema<TScope extends string, TName extends string | number>(\n\tfactory: SchemaFactory<TScope, TName>,\n\tname: TName,\n) {\n\tclass SingletonSchema extends factory.object(name, {}) {\n\t\tpublic constructor(data?: EmptyObject) {\n\t\t\tsuper(data ?? {});\n\t\t}\n\t\tpublic get value(): TName {\n\t\t\treturn name;\n\t\t}\n\t}\n\n\ttype NodeType = object &\n\t\tTreeNode &\n\t\tObjectFromSchemaRecord<EmptyObject> & { readonly value: TName };\n\n\t// Returning SingletonSchema without a type conversion results in TypeScript generating something like `readonly \"__#124291@#brand\": unknown;`\n\t// for the private brand field of TreeNode.\n\t// This numeric id doesn't seem to be stable over incremental builds, and thus causes diffs in the API extractor reports.\n\t// This is avoided by doing this type conversion.\n\t// The conversion is done via assignment instead of `as` to get stronger type safety.\n\tconst toReturn: TreeNodeSchemaClass<\n\t\tScopedSchemaName<TScope, TName>,\n\t\tNodeKind.Object,\n\t\tNodeType,\n\t\tobject & InsertableObjectFromSchemaRecord<EmptyObject>,\n\t\ttrue\n\t> &\n\t\t(new () => NodeType) = SingletonSchema;\n\n\treturn toReturn;\n}\n\n/**\n * Converts an enum into a collection of schema which can be used in a union.\n * @remarks\n * Currently only supports `string` enums.\n * @example\n * ```typescript\n * enum Mode {\n * \ta = \"A\",\n * \tb = \"B\",\n * }\n * const ModeNodes = adaptEnum(schema, Mode);\n * type ModeNodes = NodeFromSchema<(typeof ModeNodes)[keyof typeof ModeNodes]>;\n * const nodeFromString: ModeNodes = ModeNodes(Mode.a);\n * const nodeFromSchema: ModeNodes = new ModeNodes.a();\n * const nameFromNode: Mode = nodeFromSchema.value;\n * class Parent extends schemaFactory.object(\"Parent\", {\n * \tmode: typedObjectValues(ModeNodes),\n * }) {}\n * ```\n * @privateRemarks\n * TODO:\n * Extends this to support numeric enums.\n * Maybe require an explicit nested scope to group them under, or at least a warning about collisions.\n * Maybe just provide `SchemaFactory.nested` to east creating nested scopes?\n * @internal\n */\n// eslint-disable-next-line @typescript-eslint/explicit-function-return-type\nexport function adaptEnum<TScope extends string, const TEnum extends Record<string, string>>(\n\tfactory: SchemaFactory<TScope>,\n\tmembers: TEnum,\n) {\n\ttype Values = TEnum[keyof TEnum];\n\tconst values = Object.values(members) as Values[];\n\tconst inverse = new Map(Object.entries(members).map(([key, value]) => [value, key])) as Map<\n\t\tValues,\n\t\tkeyof TEnum\n\t>;\n\n\tif (inverse.size !== values.length) {\n\t\tthrow new UsageError(\"All members of enums must have distinct values.\");\n\t}\n\n\ttype TOut = {\n\t\treadonly [Property in keyof TEnum]: ReturnType<\n\t\t\ttypeof singletonSchema<TScope, TEnum[Property]>\n\t\t>;\n\t};\n\t// eslint-disable-next-line @typescript-eslint/explicit-function-return-type\n\tconst factoryOut = <TValue extends Values>(value: TValue) => {\n\t\treturn new out[inverse.get(value) ?? fail(\"missing enum value\")]({}) as NodeFromSchema<\n\t\t\tReturnType<typeof singletonSchema<TScope, TValue>>\n\t\t>;\n\t};\n\tconst out = factoryOut as typeof factoryOut & TOut;\n\tfor (const [key, value] of Object.entries(members)) {\n\t\tObject.defineProperty(out, key, {\n\t\t\tenumerable: true,\n\t\t\tconfigurable: false,\n\t\t\twritable: false,\n\t\t\tvalue: singletonSchema(factory, value),\n\t\t});\n\t}\n\n\treturn out;\n}\n\n/**\n * `Object.values`, but with more specific types.\n * @internal\n */\nexport function typedObjectValues<TKey extends string, TValues>(\n\tobject: Record<TKey, TValues>,\n): TValues[] {\n\treturn Object.values(object);\n}\n\n/**\n * Converts an array of distinct strings into a collection of schema which can be used like an enum style union.\n * @remarks\n * The returned collection is also a function which can be used to convert strings into {@link Unhydrated} nodes in the union.\n * Each node type has a `.value` getter which returns the associated string.\n *\n * The produced nodes use the provided strings as their `name`, and don't store any data beyond that.\n * @example\n * ```typescript\n * const Mode = enumFromStrings(schemaFactory, [\"Fun\", \"Cool\"]);\n * type Mode = NodeFromSchema<(typeof Mode)[keyof typeof Mode]>;\n * const nodeFromString: Mode = Mode(\"Fun\");\n * const nodeFromSchema: Mode = new Mode.Fun();\n * const nameFromNode = nodeFromSchema.value;\n *\n * class Parent extends schemaFactory.object(\"Parent\", { mode: typedObjectValues(Mode) }) {}\n * ```\n * @internal\n */\n// eslint-disable-next-line @typescript-eslint/explicit-function-return-type\nexport function enumFromStrings<TScope extends string, const Members extends string>(\n\tfactory: SchemaFactory<TScope>,\n\tmembers: readonly Members[],\n) {\n\tconst names = new Set(members);\n\tif (names.size !== members.length) {\n\t\tthrow new UsageError(\"All members of enums must have distinct names\");\n\t}\n\n\ttype TOut = Record<Members, ReturnType<typeof singletonSchema<TScope, Members>>>;\n\t// eslint-disable-next-line @typescript-eslint/explicit-function-return-type\n\tconst factoryOut = <TValue extends Members>(value: TValue) => {\n\t\treturn new out[value]({}) as NodeFromSchema<\n\t\t\tReturnType<typeof singletonSchema<TScope, TValue>>\n\t\t>;\n\t};\n\tconst out = factoryOut as typeof factoryOut & TOut;\n\tfor (const name of members) {\n\t\tObject.defineProperty(out, name, {\n\t\t\tenumerable: true,\n\t\t\tconfigurable: false,\n\t\t\twritable: false,\n\t\t\tvalue: singletonSchema(factory, name),\n\t\t});\n\t}\n\n\treturn out;\n}\n\n// TODO: Why does this one generate an invalid d.ts file if exported?\n// Tracked by https://github.com/microsoft/TypeScript/issues/58688\n// TODO: replace enumFromStrings above with this simpler implementation when the TypeScript bug is resolved.\n// eslint-disable-next-line @typescript-eslint/explicit-function-return-type\nfunction _enumFromStrings2<TScope extends string, const Members extends readonly string[]>(\n\tfactory: SchemaFactory<TScope>,\n\tmembers: Members,\n) {\n\tconst enumObject: {\n\t\t[key in keyof Members as Members[key] extends string\n\t\t\t? Members[key]\n\t\t\t: string]: Members[key] extends string ? Members[key] : string;\n\t} = Object.create(null);\n\tfor (const name of members) {\n\t\tObject.defineProperty(enumObject, name, {\n\t\t\tenumerable: true,\n\t\t\tconfigurable: false,\n\t\t\twritable: false,\n\t\t\tvalue: name,\n\t\t});\n\t}\n\n\treturn adaptEnum(factory, enumObject);\n}\n"]}

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

@@ -1 +0,0 @@
-{"version":3,"file":"schemaFactory.d.ts","sourceRoot":"","sources":["../../src/simple-tree/schemaFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,OAAO,KAAK,EAAE,YAAY,IAAI,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAIpF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAuB,KAAK,UAAU,EAAU,MAAM,+BAA+B,CAAC;AAC7F,OAAO,EACN,KAAK,yBAAyB,EAG9B,MAAM,kBAAkB,CAAC;AAU1B,OAAO,EACN,SAAS,EACT,KAAK,WAAW,EAChB,KAAK,oBAAoB,EACzB,KAAK,mBAAmB,EACxB,KAAK,0CAA0C,EAC/C,KAAK,QAAQ,EACb,KAAK,cAAc,EACnB,KAAK,mBAAmB,EACxB,KAAK,QAAQ,EACb,KAAK,UAAU,EAIf,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,KAAK,aAAa,EAAe,MAAM,gBAAgB,CAAC;AACjE,OAAO,EACN,KAAK,gCAAgC,EACrC,KAAK,cAAc,EAEnB,MAAM,iBAAiB,CAAC;AACzB,OAAO,EAAE,KAAK,WAAW,EAAa,MAAM,cAAc,CAAC;AAC3D,OAAO,KAAK,EACX,iBAAiB,EAMjB,qBAAqB,EAErB,0CAA0C,EAE1C,gDAAgD,EAChD,mBAAmB,EACnB,iBAAiB,EACjB,oBAAoB,EACpB,MAAM,kBAAkB,CAAC;AAG1B;;GAEG;AACH,wBAAgB,eAAe,CAAC,KAAK,EAAE,SAAS,GAAG,cAAc,CAkBhE;AAED;;;;GAIG;AACH,MAAM,MAAM,gBAAgB,CAC3B,MAAM,SAAS,MAAM,GAAG,SAAS,EACjC,KAAK,SAAS,MAAM,GAAG,MAAM,IAC1B,MAAM,SAAS,SAAS,GAAG,GAAG,KAAK,EAAE,GAAG,GAAG,MAAM,IAAI,KAAK,EAAE,CAAC;AAOjE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsDG;AACH,qBAAa,aAAa,CACzB,GAAG,CAAC,MAAM,SAAS,MAAM,GAAG,SAAS,GAAG,MAAM,GAAG,SAAS,EAC1D,KAAK,SAAS,MAAM,GAAG,MAAM,GAAG,MAAM;aAwBH,KAAK,EAAE,MAAM;IAtBhD;;;;;;OAMG;IACH,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA0C;IAE1E;;;;;;;;;;;;OAYG;gBACgC,KAAK,EAAE,MAAM;IAEhD,OAAO,CAAC,MAAM;IAMd;;;;;;;;;;;;OAYG;IACH,SAAgB,MAAM,kFAAgB;IAEtC;;;;;;;;;;;;;OAaG;IACH,SAAgB,MAAM,kFAAgB;IAEtC;;OAEG;IACH,SAAgB,OAAO,qFAAiB;IAExC;;;;;;;OAOG;IACH,SAAgB,IAAI,4EAAc;IAElC;;OAEG;IACH,SAAgB,MAAM,gHAAgB;IAEtC;;;;;OAKG;IACI,MAAM,CACZ,KAAK,CAAC,IAAI,SAAS,KAAK,EACxB,KAAK,CAAC,CAAC,SAAS,yBAAyB,CAAC,MAAM,EAAE,mBAAmB,CAAC,EAEtE,IAAI,EAAE,IAAI,EACV,MAAM,EAAE,CAAC,GACP,mBAAmB,CACrB,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,EAC9B,QAAQ,CAAC,MAAM,EACf,cAAc,CAAC,CAAC,EAAE,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,EACjD,MAAM,GAAG,gCAAgC,CAAC,CAAC,CAAC,EAC5C,IAAI,EACJ,CAAC,CACD;IAID;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACI,GAAG,CAAC,KAAK,CAAC,CAAC,SAAS,cAAc,GAAG,SAAS,cAAc,EAAE,EACpE,YAAY,EAAE,CAAC,GACb,cAAc,CAChB,gBAAgB,CAAC,MAAM,EAAE,OAAO,MAAM,GAAG,CAAC,EAC1C,QAAQ,CAAC,GAAG,EACZ,WAAW,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,gBAAgB,CAAC,MAAM,EAAE,OAAO,MAAM,GAAG,CAAC,CAAC,EACrE,QAAQ,CAAC,CAAC,MAAM,EAAE,0CAA0C,CAAC,CAAC,CAAC,CAAC,CAAC,EACjE,IAAI,EACJ,CAAC,CACD;IAED;;;;;;;;;OASG;IACI,GAAG,CAAC,IAAI,SAAS,KAAK,EAAE,KAAK,CAAC,CAAC,SAAS,oBAAoB,EAClE,IAAI,EAAE,IAAI,EACV,YAAY,EAAE,CAAC,GACb,mBAAmB,CACrB,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,EAC9B,QAAQ,CAAC,GAAG,EACZ,WAAW,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,EACzD,QAAQ,CAAC,CAAC,MAAM,EAAE,0CAA0C,CAAC,CAAC,CAAC,CAAC,CAAC,EACjE,IAAI,EACJ,CAAC,CACD;IAsCD;;;;OAIG;IACH,OAAO,CAAC,QAAQ;IA0BhB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgCG;IACI,KAAK,CAAC,KAAK,CAAC,CAAC,SAAS,cAAc,GAAG,SAAS,cAAc,EAAE,EACtE,YAAY,EAAE,CAAC,GACb,cAAc,CAChB,gBAAgB,CAAC,MAAM,EAAE,SAAS,MAAM,GAAG,CAAC,EAC5C,QAAQ,CAAC,KAAK,EACd,aAAa,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,gBAAgB,CAAC,MAAM,EAAE,SAAS,MAAM,GAAG,CAAC,CAAC,EACzE,QAAQ,CAAC,0CAA0C,CAAC,CAAC,CAAC,CAAC,EACvD,IAAI,EACJ,CAAC,CACD;IAED;;;;;;;;;;;OAWG;IACI,KAAK,CAAC,KAAK,CAAC,IAAI,SAAS,KAAK,EAAE,KAAK,CAAC,CAAC,SAAS,oBAAoB,EAC1E,IAAI,EAAE,IAAI,EACV,YAAY,EAAE,CAAC,GACb,mBAAmB,CACrB,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,EAC9B,QAAQ,CAAC,KAAK,EACd,aAAa,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,gBAAgB,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC,EAC3D,QAAQ,CAAC,0CAA0C,CAAC,CAAC,CAAC,CAAC,EACvD,IAAI,EACJ,CAAC,CACD;IA8BD;;;;;;;;OAQG;IACH,OAAO,CAAC,UAAU;IAoBlB;;;;;OAKG;IACI,QAAQ,CAAC,KAAK,CAAC,CAAC,SAAS,oBAAoB,EACnD,CAAC,EAAE,CAAC,EACJ,KAAK,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,iBAAiB,CAAC,GACzC,WAAW,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;IAUrC;;;;;;;;;OASG;IACI,QAAQ,CAAC,KAAK,CAAC,CAAC,SAAS,oBAAoB,EACnD,CAAC,EAAE,CAAC,EACJ,KAAK,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,iBAAiB,CAAC,GACzC,WAAW,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;IAIrC;;;;;;OAMG;IACI,iBAAiB,CAAC,KAAK,CAAC,CAAC,SAAS,UAAU,CAAC,oBAAoB,CAAC,EACxE,CAAC,EAAE,CAAC,EACJ,KAAK,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,iBAAiB,CAAC,GACzC,iBAAiB,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;IAI3C;;;;;;OAMG;IACI,iBAAiB,CAAC,KAAK,CAAC,CAAC,SAAS,UAAU,CAAC,oBAAoB,CAAC,EACxE,CAAC,EAAE,CAAC,EACJ,KAAK,CAAC,EAAE,IAAI,CAAC,UAAU,EAAE,iBAAiB,CAAC,GACzC,iBAAiB,CAAC,SAAS,CAAC,QAAQ,EAAE,CAAC,CAAC;IAI3C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,IAAW,UAAU,IAAI,WAAW,CAAC,SAAS,CAAC,UAAU,EAAE,OAAO,IAAI,CAAC,MAAM,CAAC,CAS7E;IAED;;;;;;;;;;OAUG;IAEI,eAAe,CACrB,KAAK,CAAC,IAAI,SAAS,KAAK,EACxB,KAAK,CAAC,CAAC,SAAS,UAAU,CAAC,yBAAyB,CAAC,MAAM,EAAE,mBAAmB,CAAC,CAAC,EACjF,IAAI,EAAE,IAAI,EAAE,CAAC,EAAE,CAAC;IAelB;;;;;;OAMG;IAEI,cAAc,CACpB,KAAK,CAAC,IAAI,SAAS,KAAK,EACxB,KAAK,CAAC,CAAC,SAAS,UAAU,CAAC,oBAAoB,CAAC,EAC/C,IAAI,EAAE,IAAI,EAAE,YAAY,EAAE,CAAC;QAa1B;;;;;;;;;;WAUG;6BACkB,SAAS,iDAAiD,CAAC,CAAC,CAAC;;IAOrF;;;;;;OAMG;IAEI,YAAY,CAAC,IAAI,SAAS,KAAK,EAAE,KAAK,CAAC,CAAC,SAAS,UAAU,CAAC,oBAAoB,CAAC,EACvF,IAAI,EAAE,IAAI,EACV,YAAY,EAAE,CAAC;QAcb;;;;;;;;;;WAUG;6BACkB,SACpB;YAAC,MAAM;YAAE,iDAAiD,CAAC,CAAC;SAAC,CAC7D;;CAMJ;AAED,wBAAgB,cAAc,CAAC,KAAK,CAAC,CAAC,SAAS,MAAM,EACpD,cAAc,EAAE,CAAC,EACjB,YAAY,EAAE,cAAc,GAAG,SAAS,cAAc,EAAE,GACtD,GAAG,CAAC,IAAI,MAAM,GAAG,CAmBnB;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,cAAc,GAAG,IAAI,CAelE"}