@fluidframework/tree 2.2.0 → 2.3.0

package/dist/feature-libraries/flex-map-tree/mapTreeNode.d.ts

@@ -2,9 +2,9 @@
  * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
  * Licensed under the MIT License.
  */
-import { type AnchorNode, type ExclusiveMapTree, type FieldKey, type MapTree, type TreeNodeSchemaIdentifier, type Value } from "../../core/index.js";
-import { FlexTreeEntityKind, type FlexTreeField, type FlexTreeMapNode, type FlexTreeNode, type FlexTreeSequenceField, type FlexTreeTypedField, type FlexTreeTypedNode, type FlexTreeTypedNodeUnion, type FlexTreeUnboxField, flexTreeMarker } from "../flex-tree/index.js";
-import { type FlexAllowedTypes, FlexFieldSchema, type FlexMapNodeSchema, type FlexTreeNodeSchema } from "../typed-schema/index.js";
+import { type AnchorNode, type ExclusiveMapTree, type FieldKey, type FieldUpPath, type MapTree, type TreeFieldStoredSchema, type TreeNodeSchemaIdentifier, type TreeStoredSchema, type Value } from "../../core/index.js";
+import { type FlexTreeContext, FlexTreeEntityKind, type FlexTreeField, type FlexTreeNode, type FlexTreeSequenceField, type FlexTreeTypedField, flexTreeMarker, type FlexTreeHydratedContext } from "../flex-tree/index.js";
+import { FlexFieldSchema, type FlexTreeNodeSchema, type FlexTreeSchema } from "../typed-schema/index.js";
 import type { FlexFieldKind } from "../modular-schema/index.js";
 import { type SequenceFieldEditBuilder } from "../default-schema/index.js";
 /**
@@ -22,12 +22,12 @@ export declare function isMapTreeNode(flexNode: FlexTreeNode): flexNode is MapTr
 /**
  * Checks if the given {@link FlexTreeField} is a {@link MapTreeSequenceField}.
  */
-export declare function isMapTreeSequenceField<T extends FlexAllowedTypes>(field: FlexTreeSequenceField<T> | FlexTreeField): field is MapTreeSequenceField<T>;
+export declare function isMapTreeSequenceField(field: FlexTreeSequenceField | FlexTreeField): field is MapTreeSequenceField;
 /**
  * An unhydrated {@link FlexTreeSequenceField}, which has additional editing capabilities.
  * @remarks When doing a removal edit, a {@link MapTreeSequenceField}'s `editor` returns ownership of the removed {@link ExclusiveMapTree}s to the caller.
  */
-export interface MapTreeSequenceField<T extends FlexAllowedTypes> extends FlexTreeSequenceField<T> {
+export interface MapTreeSequenceField extends FlexTreeSequenceField {
     readonly editor: MapTreeSequenceFieldEditBuilder;
 }
 interface MapTreeSequenceFieldEditBuilder extends SequenceFieldEditBuilder<ExclusiveMapTree[]> {
@@ -51,11 +51,13 @@ interface LocationInField {
  * MapTreeNodes are unconditionally cached -
  * when retrieved via {@link getOrCreateNode}, the same {@link MapTree} object will always produce the same `MapTreeNode` object.
  */
-export declare class EagerMapTreeNode<TSchema extends FlexTreeNodeSchema> implements MapTreeNode {
-    readonly schema: TSchema;
+export declare class EagerMapTreeNode implements MapTreeNode {
+    readonly context: UnhydratedContext;
+    readonly flexSchema: FlexTreeNodeSchema;
     /** The underlying {@link MapTree} that this `MapTreeNode` reads its data from */
     readonly mapTree: ExclusiveMapTree;
     private location;
+    get schema(): TreeNodeSchemaIdentifier;
     readonly [flexTreeMarker]: FlexTreeEntityKind.Node;
     /**
      * Create a new MapTreeNode.
@@ -65,7 +67,7 @@ export declare class EagerMapTreeNode<TSchema extends FlexTreeNodeSchema> implem
      * A `MapTreeNode` may never be constructed more than once for the same {@link MapTree} object.
      * Instead, it should always be acquired via {@link getOrCreateNode}.
      */
-    constructor(schema: TSchema, 
+    constructor(context: UnhydratedContext, flexSchema: FlexTreeNodeSchema, 
     /** The underlying {@link MapTree} that this `MapTreeNode` reads its data from */
     mapTree: ExclusiveMapTree, location?: LocationInField);
     get type(): TreeNodeSchemaIdentifier;
@@ -83,32 +85,28 @@ export declare class EagerMapTreeNode<TSchema extends FlexTreeNodeSchema> implem
      * @remarks If this node is unparented, this method will return the special {@link unparentedLocation} as the parent.
      */
     get parentField(): LocationInField;
-    is<TSchemaInner extends FlexTreeNodeSchema>(schema: TSchemaInner): this is FlexTreeTypedNode<TSchemaInner>;
-    tryGetField(key: FieldKey): EagerMapTreeField<FlexAllowedTypes> | undefined;
+    is(schema: FlexTreeNodeSchema): boolean;
+    tryGetField(key: FieldKey): EagerMapTreeField | undefined;
     getBoxed(key: string): FlexTreeField;
     boxedIterator(): IterableIterator<FlexTreeField>;
+    keys(): IterableIterator<FieldKey>;
     get value(): Value;
-    context: undefined;
     get anchorNode(): AnchorNode;
     private walkTree;
 }
 /**
- * The implementation of a map node created by {@link getOrCreateNode}.
+ * Implementation of `FlexTreeContext`.
+ *
+ * @remarks An editor is required to edit the FlexTree.
  */
-export declare class EagerMapTreeMapNode<TSchema extends FlexMapNodeSchema> extends EagerMapTreeNode<TSchema> implements FlexTreeMapNode<TSchema> {
-    keys(): IterableIterator<FieldKey>;
-    values(): IterableIterator<FlexTreeUnboxField<TSchema["info"], "notEmpty">>;
-    entries(): IterableIterator<[
-        FieldKey,
-        FlexTreeUnboxField<TSchema["info"], "notEmpty">
-    ]>;
-    forEach(callbackFn: (value: FlexTreeUnboxField<TSchema["info"], "notEmpty">, key: FieldKey, map: FlexTreeMapNode<TSchema>) => void, thisArg?: unknown): void;
-    getBoxed(key: string): FlexTreeTypedField<TSchema["info"]>;
-    [Symbol.iterator](): IterableIterator<[
-        FieldKey,
-        FlexTreeUnboxField<TSchema["info"], "notEmpty">
-    ]>;
-    boxedIterator(): IterableIterator<FlexTreeTypedField<TSchema["info"]>>;
+export declare class UnhydratedContext implements FlexTreeContext {
+    readonly flexSchema: FlexTreeSchema;
+    readonly schema: TreeStoredSchema;
+    /**
+     * @param flexSchema - Schema to use when working with the tree.
+     */
+    constructor(flexSchema: FlexTreeSchema);
+    isHydrated(): this is FlexTreeHydratedContext;
 }
 /**
  * A readonly {@link FlexTreeField} which wraps an array of {@link MapTrees}.
@@ -118,18 +116,19 @@ export declare class EagerMapTreeMapNode<TSchema extends FlexMapNodeSchema> exte
 interface MapTreeField extends FlexTreeField {
     readonly mapTrees: readonly MapTree[];
 }
-declare class EagerMapTreeField<T extends FlexAllowedTypes> implements MapTreeField {
-    readonly schema: FlexFieldSchema<FlexFieldKind, T>;
+declare class EagerMapTreeField implements MapTreeField {
+    readonly context: UnhydratedContext;
+    readonly flexSchema: FlexFieldSchema;
     readonly key: FieldKey;
-    readonly parent: EagerMapTreeNode<FlexTreeNodeSchema>;
+    readonly parent: EagerMapTreeNode;
     [flexTreeMarker]: FlexTreeEntityKind.Field;
-    constructor(schema: FlexFieldSchema<FlexFieldKind, T>, key: FieldKey, parent: EagerMapTreeNode<FlexTreeNodeSchema>);
+    get schema(): TreeFieldStoredSchema;
+    constructor(context: UnhydratedContext, flexSchema: FlexFieldSchema, key: FieldKey, parent: EagerMapTreeNode);
     get mapTrees(): readonly ExclusiveMapTree[];
     get length(): number;
-    is<TSchemaInner extends FlexFieldSchema>(schema: TSchemaInner): this is FlexTreeTypedField<TSchemaInner>;
-    boxedIterator(): IterableIterator<FlexTreeTypedNodeUnion<T>>;
-    boxedAt(index: number): FlexTreeTypedNodeUnion<T> | undefined;
-    context: undefined;
+    is<TKind2 extends FlexFieldKind>(kind: TKind2): this is FlexTreeTypedField<TKind2>;
+    boxedIterator(): IterableIterator<FlexTreeNode>;
+    boxedAt(index: number): FlexTreeNode | undefined;
     /**
      * Mutate this field.
      * @param edit - A function which receives the current `MapTree`s that comprise the contents of the field so that it may be mutated.
@@ -139,6 +138,7 @@ declare class EagerMapTreeField<T extends FlexAllowedTypes> implements MapTreeFi
      * This function ensures that the parent MapTree has no empty fields (which is an invariant of `MapTree`) after the mutation.
      */
     protected edit(edit: (mapTrees: ExclusiveMapTree[]) => void | ExclusiveMapTree[]): void;
+    getFieldPath(): FieldUpPath;
 }
 /**
  * If there exists a {@link EagerMapTreeNode} for the given {@link MapTree}, returns it, otherwise returns `undefined`.
@@ -151,7 +151,7 @@ export declare function tryGetMapTreeNode(mapTree: MapTree): MapTreeNode | undef
  * @param mapTree - the {@link MapTree} containing the data for this node.
  * @remarks It must conform to the `nodeSchema`.
  */
-export declare function getOrCreateMapTreeNode(nodeSchema: FlexTreeNodeSchema, mapTree: ExclusiveMapTree): EagerMapTreeNode<FlexTreeNodeSchema>;
+export declare function getOrCreateMapTreeNode(context: UnhydratedContext, nodeSchema: FlexTreeNodeSchema, mapTree: ExclusiveMapTree): EagerMapTreeNode;
 export declare function unsupportedUsageError(message?: string): Error;
 export {};
 //# sourceMappingURL=mapTreeNode.d.ts.map

package/dist/feature-libraries/flex-map-tree/mapTreeNode.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mapTreeNode.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/flex-map-tree/mapTreeNode.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EACN,KAAK,UAAU,EAEf,KAAK,gBAAgB,EACrB,KAAK,QAAQ,EAEb,KAAK,OAAO,EACZ,KAAK,wBAAwB,EAE7B,KAAK,KAAK,EACV,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACN,kBAAkB,EAClB,KAAK,aAAa,EAElB,KAAK,eAAe,EACpB,KAAK,YAAY,EAGjB,KAAK,qBAAqB,EAC1B,KAAK,kBAAkB,EACvB,KAAK,iBAAiB,EACtB,KAAK,sBAAsB,EAC3B,KAAK,kBAAkB,EAEvB,cAAc,EAEd,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EACN,KAAK,gBAAgB,EACrB,eAAe,EACf,KAAK,iBAAiB,EACtB,KAAK,kBAAkB,EAMvB,MAAM,0BAA0B,CAAC;AAElC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAAc,KAAK,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAKvF;;;;GAIG;AACH,MAAM,WAAW,WAAY,SAAQ,YAAY;IAChD,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,YAAY,GAAG,QAAQ,IAAI,WAAW,CAE7E;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,CAAC,SAAS,gBAAgB,EAChE,KAAK,EAAE,qBAAqB,CAAC,CAAC,CAAC,GAAG,aAAa,GAC7C,KAAK,IAAI,oBAAoB,CAAC,CAAC,CAAC,CAElC;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAoB,CAAC,CAAC,SAAS,gBAAgB,CAC/D,SAAQ,qBAAqB,CAAC,CAAC,CAAC;IAChC,QAAQ,CAAC,MAAM,EAAE,+BAA+B,CAAC;CACjD;AAED,UAAU,+BACT,SAAQ,wBAAwB,CAAC,gBAAgB,EAAE,CAAC;IACpD;;;;;OAKG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,gBAAgB,EAAE,CAAC;CACzD;AAED,wDAAwD;AACxD,UAAU,eAAe;IACxB,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;GAMG;AACH,qBAAa,gBAAgB,CAAC,OAAO,SAAS,kBAAkB,CAAE,YAAW,WAAW;aAYtE,MAAM,EAAE,OAAO;IAC/B,iFAAiF;aACjE,OAAO,EAAE,gBAAgB;IACzC,OAAO,CAAC,QAAQ;IAdjB,SAAgB,CAAC,cAAc,CAAC,0BAAoC;IAEpE;;;;;;;OAOG;gBAEc,MAAM,EAAE,OAAO;IAC/B,iFAAiF;IACjE,OAAO,EAAE,gBAAgB,EACjC,QAAQ,kBAAqB;IAetC,IAAW,IAAI,IAAI,wBAAwB,CAE1C;IAED;;;;;;OAMG;IACI,OAAO,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI;IAChC,OAAO,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAkBzD;;;OAGG;IACH,IAAW,WAAW,IAAI,eAAe,CAExC;IAEM,EAAE,CAAC,YAAY,SAAS,kBAAkB,EAChD,MAAM,EAAE,YAAY,GAClB,IAAI,IAAI,iBAAiB,CAAC,YAAY,CAAC;IAInC,WAAW,CAAC,GAAG,EAAE,QAAQ,GAAG,iBAAiB,CAAC,gBAAgB,CAAC,GAAG,SAAS;IAQ3E,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa;IAKpC,aAAa,IAAI,gBAAgB,CAAC,aAAa,CAAC;IAMvD,IAAW,KAAK,IAAI,KAAK,CAExB;IAEM,OAAO,YAAa;IAE3B,IAAW,UAAU,IAAI,UAAU,CAIlC;IAED,OAAO,CAAC,QAAQ;CAoBhB;AAED;;GAEG;AACH,qBAAa,mBAAmB,CAAC,OAAO,SAAS,iBAAiB,CACjE,SAAQ,gBAAgB,CAAC,OAAO,CAChC,YAAW,eAAe,CAAC,OAAO,CAAC;IAE5B,IAAI,IAAI,gBAAgB,CAAC,QAAQ,CAAC;IAIlC,MAAM,IAAI,gBAAgB,CAAC,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,CAAC;IAa3E,OAAO,IAAI,gBAAgB,CACjC;QAAC,QAAQ;QAAE,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC;KAAC,CAC3D;IAYM,OAAO,CACb,UAAU,EAAE,CACX,KAAK,EAAE,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,EACtD,GAAG,EAAE,QAAQ,EACb,GAAG,EAAE,eAAe,CAAC,OAAO,CAAC,KACzB,IAAI,EACT,OAAO,CAAC,EAAE,OAAO,GACf,IAAI;IAOS,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAInE,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,gBAAgB,CAC3C;QAAC,QAAQ;QAAE,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC;KAAC,CAC3D;IAIe,aAAa,IAAI,gBAAgB,CAAC,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC;CAGtF;AAeD;;;;GAIG;AACH,UAAU,YAAa,SAAQ,aAAa;IAC3C,QAAQ,CAAC,QAAQ,EAAE,SAAS,OAAO,EAAE,CAAC;CACtC;AAgCD,cAAM,iBAAiB,CAAC,CAAC,SAAS,gBAAgB,CAAE,YAAW,YAAY;aAIzD,MAAM,EAAE,eAAe,CAAC,aAAa,EAAE,CAAC,CAAC;aACzC,GAAG,EAAE,QAAQ;aACb,MAAM,EAAE,gBAAgB,CAAC,kBAAkB,CAAC;IALtD,CAAC,cAAc,CAAC,2BAAqC;gBAG3C,MAAM,EAAE,eAAe,CAAC,aAAa,EAAE,CAAC,CAAC,EACzC,GAAG,EAAE,QAAQ,EACb,MAAM,EAAE,gBAAgB,CAAC,kBAAkB,CAAC;IAmB7D,IAAW,QAAQ,IAAI,SAAS,gBAAgB,EAAE,CAEjD;IAED,IAAW,MAAM,IAAI,MAAM,CAE1B;IAEM,EAAE,CAAC,YAAY,SAAS,eAAe,EAC7C,MAAM,EAAE,YAAY,GAClB,IAAI,IAAI,kBAAkB,CAAC,YAAY,CAAC;IAIpC,aAAa,IAAI,gBAAgB,CAAC,sBAAsB,CAAC,CAAC,CAAC,CAAC;IAY5D,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,sBAAsB,CAAC,CAAC,CAAC,GAAG,SAAS;IAc7D,OAAO,EAAE,SAAS,CAAC;IAE1B;;;;;;;OAOG;IACH,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE,gBAAgB,EAAE,KAAK,IAAI,GAAG,gBAAgB,EAAE,GAAG,IAAI;CASvF;AA8HD;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,WAAW,GAAG,SAAS,CAE3E;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACrC,UAAU,EAAE,kBAAkB,EAC9B,OAAO,EAAE,gBAAgB,GACvB,gBAAgB,CAAC,kBAAkB,CAAC,CAEtC;AA8HD,wBAAgB,qBAAqB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,KAAK,CAM7D"}
+{"version":3,"file":"mapTreeNode.d.ts","sourceRoot":"","sources":["../../../src/feature-libraries/flex-map-tree/mapTreeNode.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAKH,OAAO,EACN,KAAK,UAAU,EAEf,KAAK,gBAAgB,EACrB,KAAK,QAAQ,EACb,KAAK,WAAW,EAChB,KAAK,OAAO,EACZ,KAAK,qBAAqB,EAC1B,KAAK,wBAAwB,EAC7B,KAAK,gBAAgB,EACrB,KAAK,KAAK,EACV,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EACN,KAAK,eAAe,EACpB,kBAAkB,EAClB,KAAK,aAAa,EAClB,KAAK,YAAY,EAGjB,KAAK,qBAAqB,EAC1B,KAAK,kBAAkB,EAEvB,cAAc,EAEd,KAAK,uBAAuB,EAC5B,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAEN,eAAe,EACf,KAAK,kBAAkB,EACvB,KAAK,cAAc,EAGnB,MAAM,0BAA0B,CAAC;AAClC,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,4BAA4B,CAAC;AAChE,OAAO,EAGN,KAAK,wBAAwB,EAC7B,MAAM,4BAA4B,CAAC;AAIpC;;;;GAIG;AACH,MAAM,WAAW,WAAY,SAAQ,YAAY;IAChD,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;CAC1B;AAED;;GAEG;AACH,wBAAgB,aAAa,CAAC,QAAQ,EAAE,YAAY,GAAG,QAAQ,IAAI,WAAW,CAE7E;AAED;;GAEG;AACH,wBAAgB,sBAAsB,CACrC,KAAK,EAAE,qBAAqB,GAAG,aAAa,GAC1C,KAAK,IAAI,oBAAoB,CAE/B;AAED;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,qBAAqB;IAClE,QAAQ,CAAC,MAAM,EAAE,+BAA+B,CAAC;CACjD;AAED,UAAU,+BACT,SAAQ,wBAAwB,CAAC,gBAAgB,EAAE,CAAC;IACpD;;;;;OAKG;IACH,MAAM,CAAC,KAAK,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,gBAAgB,EAAE,CAAC;CACzD;AAED,wDAAwD;AACxD,UAAU,eAAe;IACxB,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC;IAC9B,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;CACvB;AAED;;;;;;GAMG;AACH,qBAAa,gBAAiB,YAAW,WAAW;aAgBlC,OAAO,EAAE,iBAAiB;aAC1B,UAAU,EAAE,kBAAkB;IAC9C,iFAAiF;aACjE,OAAO,EAAE,gBAAgB;IACzC,OAAO,CAAC,QAAQ;IAnBjB,IAAW,MAAM,IAAI,wBAAwB,CAE5C;IAED,SAAgB,CAAC,cAAc,CAAC,0BAAoC;IAEpE;;;;;;;OAOG;gBAEc,OAAO,EAAE,iBAAiB,EAC1B,UAAU,EAAE,kBAAkB;IAC9C,iFAAiF;IACjE,OAAO,EAAE,gBAAgB,EACjC,QAAQ,kBAAqB;IAetC,IAAW,IAAI,IAAI,wBAAwB,CAE1C;IAED;;;;;;OAMG;IACI,OAAO,CAAC,MAAM,EAAE,SAAS,GAAG,IAAI;IAChC,OAAO,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,EAAE,MAAM,GAAG,IAAI;IAkBzD;;;OAGG;IACH,IAAW,WAAW,IAAI,eAAe,CAExC;IAEM,EAAE,CAAC,MAAM,EAAE,kBAAkB,GAAG,OAAO;IAIvC,WAAW,CAAC,GAAG,EAAE,QAAQ,GAAG,iBAAiB,GAAG,SAAS;IAQzD,QAAQ,CAAC,GAAG,EAAE,MAAM,GAAG,aAAa;IAKpC,aAAa,IAAI,gBAAgB,CAAC,aAAa,CAAC;IAMhD,IAAI,IAAI,gBAAgB,CAAC,QAAQ,CAAC;IAKzC,IAAW,KAAK,IAAI,KAAK,CAExB;IAED,IAAW,UAAU,IAAI,UAAU,CAIlC;IAED,OAAO,CAAC,QAAQ;CAqBhB;AAID;;;;GAIG;AACH,qBAAa,iBAAkB,YAAW,eAAe;aAMrB,UAAU,EAAE,cAAc;IAL7D,SAAgB,MAAM,EAAE,gBAAgB,CAAC;IAEzC;;OAEG;gBACgC,UAAU,EAAE,cAAc;IAOtD,UAAU,IAAI,IAAI,IAAI,uBAAuB;CAGpD;AAID;;;;GAIG;AACH,UAAU,YAAa,SAAQ,aAAa;IAC3C,QAAQ,CAAC,QAAQ,EAAE,SAAS,OAAO,EAAE,CAAC;CACtC;AA0CD,cAAM,iBAAkB,YAAW,YAAY;aAQ7B,OAAO,EAAE,iBAAiB;aAC1B,UAAU,EAAE,eAAe;aAC3B,GAAG,EAAE,QAAQ;aACb,MAAM,EAAE,gBAAgB;IAVlC,CAAC,cAAc,CAAC,2BAAqC;IAE5D,IAAW,MAAM,IAAI,qBAAqB,CAEzC;gBAGgB,OAAO,EAAE,iBAAiB,EAC1B,UAAU,EAAE,eAAe,EAC3B,GAAG,EAAE,QAAQ,EACb,MAAM,EAAE,gBAAgB;IAmBzC,IAAW,QAAQ,IAAI,SAAS,gBAAgB,EAAE,CAEjD;IAED,IAAW,MAAM,IAAI,MAAM,CAE1B;IAEM,EAAE,CAAC,MAAM,SAAS,aAAa,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,IAAI,kBAAkB,CAAC,MAAM,CAAC;IAIlF,aAAa,IAAI,gBAAgB,CAAC,YAAY,CAAC;IAY/C,OAAO,CAAC,KAAK,EAAE,MAAM,GAAG,YAAY,GAAG,SAAS;IAcvD;;;;;;;OAOG;IACH,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,QAAQ,EAAE,gBAAgB,EAAE,KAAK,IAAI,GAAG,gBAAgB,EAAE,GAAG,IAAI;IAUhF,YAAY,IAAI,WAAW;CAGlC;AA4GD;;;GAGG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,EAAE,OAAO,GAAG,WAAW,GAAG,SAAS,CAE3E;AAED;;;;;GAKG;AACH,wBAAgB,sBAAsB,CACrC,OAAO,EAAE,iBAAiB,EAC1B,UAAU,EAAE,kBAAkB,EAC9B,OAAO,EAAE,gBAAgB,GACvB,gBAAgB,CAElB;AAgFD,wBAAgB,qBAAqB,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,KAAK,CAM7D"}

package/dist/feature-libraries/flex-map-tree/mapTreeNode.js

@@ -5,15 +5,14 @@
  */
 var _a, _b;
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.unsupportedUsageError = exports.getOrCreateMapTreeNode = exports.tryGetMapTreeNode = exports.EagerMapTreeMapNode = exports.EagerMapTreeNode = exports.isMapTreeSequenceField = exports.isMapTreeNode = void 0;
+exports.unsupportedUsageError = exports.getOrCreateMapTreeNode = exports.tryGetMapTreeNode = exports.UnhydratedContext = exports.EagerMapTreeNode = exports.isMapTreeSequenceField = exports.isMapTreeNode = void 0;
 const internal_1 = require("@fluidframework/core-utils/internal");
+const internal_2 = require("@fluidframework/telemetry-utils/internal");
 const index_js_1 = require("../../core/index.js");
 const index_js_2 = require("../../util/index.js");
 const index_js_3 = require("../flex-tree/index.js");
 const index_js_4 = require("../typed-schema/index.js");
-const schemaBuilderBase_js_1 = require("../schemaBuilderBase.js");
 const index_js_5 = require("../default-schema/index.js");
-const internal_2 = require("@fluidframework/telemetry-utils/internal");
 /**
  * Checks if the given {@link FlexTreeNode} is a {@link MapTreeNode}.
  */
@@ -36,6 +35,9 @@ exports.isMapTreeSequenceField = isMapTreeSequenceField;
  * when retrieved via {@link getOrCreateNode}, the same {@link MapTree} object will always produce the same `MapTreeNode` object.
  */
 class EagerMapTreeNode {
+    get schema() {
+        return this.flexSchema.name;
+    }
     /**
      * Create a new MapTreeNode.
      * @param location - the parentage of this node, if it is being created underneath an existing node and field, or undefined if not
@@ -44,14 +46,14 @@ class EagerMapTreeNode {
      * A `MapTreeNode` may never be constructed more than once for the same {@link MapTree} object.
      * Instead, it should always be acquired via {@link getOrCreateNode}.
      */
-    constructor(schema, 
+    constructor(context, flexSchema, 
     /** The underlying {@link MapTree} that this `MapTreeNode` reads its data from */
     mapTree, location = unparentedLocation) {
-        this.schema = schema;
+        this.context = context;
+        this.flexSchema = flexSchema;
         this.mapTree = mapTree;
         this.location = location;
         this[_a] = index_js_3.FlexTreeEntityKind.Node;
-        this.context = undefined;
         (0, internal_1.assert)(!nodeCache.has(mapTree), 0x98b /* A node already exists for the given MapTree */);
         nodeCache.set(mapTree, this);
         // Fully demand the tree to ensure that parent pointers are present and accurate on all nodes.
@@ -64,7 +66,7 @@ class EagerMapTreeNode {
         this.walkTree();
     }
     get type() {
-        return this.schema.name;
+        return this.flexSchema.name;
     }
     adoptBy(parent, index) {
         if (parent !== undefined) {
@@ -85,21 +87,25 @@ class EagerMapTreeNode {
         return this.location;
     }
     is(schema) {
-        return schema === this.schema;
+        return schema === this.flexSchema;
     }
     tryGetField(key) {
         const field = this.mapTree.fields.get(key);
         // Only return the field if it is not empty, in order to fulfill the contract of `tryGetField`.
         if (field !== undefined && field.length > 0) {
-            return getOrCreateField(this, key, this.schema.getFieldSchema(key));
+            return getOrCreateField(this, key, this.flexSchema.getFieldSchema(key));
         }
     }
     getBoxed(key) {
         const fieldKey = (0, index_js_2.brand)(key);
-        return getOrCreateField(this, fieldKey, this.schema.getFieldSchema(fieldKey));
+        return getOrCreateField(this, fieldKey, this.flexSchema.getFieldSchema(fieldKey));
     }
     boxedIterator() {
-        return (0, index_js_2.mapIterable)(this.mapTree.fields.entries(), ([key]) => getOrCreateField(this, key, this.schema.getFieldSchema(key)));
+        return (0, index_js_2.mapIterable)(this.mapTree.fields.entries(), ([key]) => getOrCreateField(this, key, this.flexSchema.getFieldSchema(key)));
+    }
+    keys() {
+        // TODO: how this should handle missing defaults (and empty keys if they end up being allowed) needs to be determined.
+        return this.mapTree.fields.keys();
     }
     get value() {
         return this.mapTree.value;
@@ -111,9 +117,9 @@ class EagerMapTreeNode {
     }
     walkTree() {
         for (const [key, mapTrees] of this.mapTree.fields) {
-            const field = getOrCreateField(this, key, this.schema.getFieldSchema(key));
+            const field = getOrCreateField(this, key, this.flexSchema.getFieldSchema(key));
             for (let index = 0; index < field.length; index++) {
-                const child = getOrCreateChild(mapTrees[index] ?? (0, internal_1.oob)(), this.schema.getFieldSchema(key).allowedTypes, { parent: field, index });
+                const child = getOrCreateChild(this.context, mapTrees[index] ?? (0, internal_1.oob)(), this.flexSchema.getFieldSchema(key).allowedTypes, { parent: field, index });
                 // These next asserts detect the case where `getOrCreateChild` gets a cache hit of a different node than the one we're trying to create
                 (0, internal_1.assert)(child.location !== undefined, 0x98d /* Expected node to have parent */);
                 (0, internal_1.assert)(child.location.parent.parent === this, 0x98e /* Node may not be multi-parented */);
@@ -125,44 +131,34 @@ class EagerMapTreeNode {
 }
 exports.EagerMapTreeNode = EagerMapTreeNode;
 _a = index_js_3.flexTreeMarker;
+// #endregion Nodes
 /**
- * The implementation of a map node created by {@link getOrCreateNode}.
+ * Implementation of `FlexTreeContext`.
+ *
+ * @remarks An editor is required to edit the FlexTree.
  */
-class EagerMapTreeMapNode extends EagerMapTreeNode {
-    keys() {
-        return this.mapTree.fields.keys();
-    }
-    values() {
-        return (0, index_js_2.mapIterable)(this.mapTree.fields.keys(), (key) => unboxedField(this.tryGetField(key) ?? (0, index_js_2.fail)("Unexpected empty map field"), key, this.mapTree, this));
-    }
-    entries() {
-        return (0, index_js_2.mapIterable)(this.mapTree.fields.keys(), (key) => [
-            key,
-            unboxedField(this.tryGetField(key) ?? (0, index_js_2.fail)("Unexpected empty map field"), key, this.mapTree, this),
-        ]);
-    }
-    forEach(callbackFn, thisArg) {
-        const fn = thisArg !== undefined ? callbackFn.bind(thisArg) : callbackFn;
-        for (const [key, value] of this.entries()) {
-            fn(value, key, this);
-        }
-    }
-    getBoxed(key) {
-        return super.getBoxed(key);
-    }
-    [Symbol.iterator]() {
-        return this.entries();
+class UnhydratedContext {
+    /**
+     * @param flexSchema - Schema to use when working with the tree.
+     */
+    constructor(flexSchema) {
+        this.flexSchema = flexSchema;
+        this.schema = {
+            rootFieldSchema: flexSchema.rootFieldSchema.stored,
+            ...(0, index_js_4.intoStoredSchemaCollection)(flexSchema),
+        };
     }
-    boxedIterator() {
-        return super.boxedIterator();
-    }
-}
-exports.EagerMapTreeMapNode = EagerMapTreeMapNode;
-class EagerMapTreeLeafNode extends EagerMapTreeNode {
-    get value() {
-        return super.value;
+    isHydrated() {
+        return false;
     }
 }
+exports.UnhydratedContext = UnhydratedContext;
+const emptyContext = new UnhydratedContext({
+    adapters: {},
+    nodeSchema: new Map(),
+    policy: index_js_5.defaultSchemaPolicy,
+    rootFieldSchema: index_js_4.FlexFieldSchema.empty,
+});
 /**
  * A special singleton that is the implicit {@link LocationInField} of all un-parented {@link EagerMapTreeNode}s.
  * @remarks This exists because {@link EagerMapTreeNode.parentField} must return a field.
@@ -177,8 +173,8 @@ const unparentedLocation = {
         length: 0,
         key: index_js_1.EmptyKey,
         parent: undefined,
-        is(schema) {
-            return schema === index_js_4.FlexFieldSchema.empty;
+        is(kind) {
+            return this.schema.kind === kind.identifier;
         },
         boxedIterator() {
             return [].values();
@@ -186,15 +182,22 @@ const unparentedLocation = {
         boxedAt(index) {
             return undefined;
         },
-        schema: index_js_4.FlexFieldSchema.empty,
-        context: undefined,
+        schema: index_js_4.FlexFieldSchema.empty.stored,
+        context: emptyContext,
         mapTrees: [],
+        getFieldPath() {
+            (0, index_js_2.fail)("unsupported");
+        },
     },
     index: -1,
 };
 class EagerMapTreeField {
-    constructor(schema, key, parent) {
-        this.schema = schema;
+    get schema() {
+        return this.flexSchema.stored;
+    }
+    constructor(context, flexSchema, key, parent) {
+        this.context = context;
+        this.flexSchema = flexSchema;
         this.key = key;
         this.parent = parent;
         this[_b] = index_js_3.FlexTreeEntityKind.Field;
@@ -219,12 +222,12 @@ class EagerMapTreeField {
     get length() {
         return this.mapTrees.length;
     }
-    is(schema) {
-        return this.schema.equals(schema);
+    is(kind) {
+        return this.schema.kind === kind.identifier;
     }
     boxedIterator() {
         return this.mapTrees
-            .map((m, index) => getOrCreateChild(m, this.schema.allowedTypes, {
+            .map((m, index) => getOrCreateChild(this.context, m, this.flexSchema.allowedTypes, {
             parent: this,
             index,
         }))
@@ -237,7 +240,7 @@ class EagerMapTreeField {
         }
         const m = this.mapTrees[i];
         if (m !== undefined) {
-            return getOrCreateChild(m, this.schema.allowedTypes, {
+            return getOrCreateChild(this.context, m, this.flexSchema.allowedTypes, {
                 parent: this,
                 index: i,
             });
@@ -261,6 +264,9 @@ class EagerMapTreeField {
             this.parent.mapTree.fields.delete(this.key);
         }
     }
+    getFieldPath() {
+        throw unsupportedUsageError("Editing an array");
+    }
 }
 _b = index_js_3.flexTreeMarker;
 class EagerMapTreeOptionalField extends EagerMapTreeField {
@@ -291,7 +297,7 @@ class EagerMapTreeOptionalField extends EagerMapTreeField {
     get content() {
         const value = this.mapTrees[0];
         if (value !== undefined) {
-            return unboxedUnion(this.schema, value, {
+            return unboxed(this.flexSchema, value, {
                 parent: this,
                 index: 0,
             });
@@ -344,22 +350,16 @@ class EagerMapTreeSequenceField extends EagerMapTreeField {
         if (i === undefined) {
             return undefined;
         }
-        return unboxedUnion(this.schema, this.mapTrees[i] ?? (0, internal_1.oob)(), { parent: this, index: i });
+        return unboxed(this.flexSchema, this.mapTrees[i] ?? (0, internal_1.oob)(), { parent: this, index: i });
     }
     map(callbackfn) {
         return Array.from(this, callbackfn);
     }
-    mapBoxed(callbackfn) {
-        return Array.from(this.boxedIterator(), callbackfn);
-    }
     *[Symbol.iterator]() {
         for (const [i, mapTree] of this.mapTrees.entries()) {
-            yield unboxedUnion(this.schema, mapTree, { parent: this, index: i });
+            yield unboxed(this.flexSchema, mapTree, { parent: this, index: i });
         }
     }
-    getFieldPath() {
-        throw unsupportedUsageError("Editing an array");
-    }
 }
 // #endregion Fields
 // #region Caching and unboxing utilities
@@ -383,37 +383,27 @@ exports.tryGetMapTreeNode = tryGetMapTreeNode;
  * @param mapTree - the {@link MapTree} containing the data for this node.
  * @remarks It must conform to the `nodeSchema`.
  */
-function getOrCreateMapTreeNode(nodeSchema, mapTree) {
-    return nodeCache.get(mapTree) ?? createNode(nodeSchema, mapTree, undefined);
+function getOrCreateMapTreeNode(context, nodeSchema, mapTree) {
+    return nodeCache.get(mapTree) ?? createNode(context, nodeSchema, mapTree, undefined);
 }
 exports.getOrCreateMapTreeNode = getOrCreateMapTreeNode;
 /** Helper for creating a `MapTreeNode` given the parent field (e.g. when "walking down") */
-function getOrCreateChild(mapTree, implicitAllowedTypes, parent) {
+function getOrCreateChild(context, mapTree, allowedTypes, parent) {
     const cached = nodeCache.get(mapTree);
     if (cached !== undefined) {
         return cached;
     }
-    const allowedTypes = (0, schemaBuilderBase_js_1.normalizeAllowedTypes)(implicitAllowedTypes);
+    (0, internal_1.assert)((0, index_js_2.isReadonlyArray)(allowedTypes), 0xa25 /* invalid types */);
     const nodeSchema = allowedTypes
         .map((t) => ((0, index_js_4.isLazy)(t) ? t() : t))
         .find((t) => {
-        (0, internal_1.assert)(t !== "Any", 0x993 /* 'Any' type is not supported */);
         return t.name === mapTree.type;
     }) ?? (0, index_js_2.fail)("Unsupported node schema");
-    return createNode(nodeSchema, mapTree, parent);
+    return createNode(context, nodeSchema, mapTree, parent);
 }
 /** Always constructs a new node, therefore may not be called twice for the same `MapTree`. */
-function createNode(nodeSchema, mapTree, parentField) {
-    if ((0, index_js_4.schemaIsLeaf)(nodeSchema)) {
-        return new EagerMapTreeLeafNode(nodeSchema, mapTree, parentField);
-    }
-    if ((0, index_js_4.schemaIsMap)(nodeSchema)) {
-        return new EagerMapTreeMapNode(nodeSchema, mapTree, parentField);
-    }
-    if ((0, index_js_4.schemaIsObjectNode)(nodeSchema)) {
-        return new EagerMapTreeNode(nodeSchema, mapTree, parentField);
-    }
-    (0, internal_1.assert)(false, 0x994 /* Unrecognized node kind */);
+function createNode(context, nodeSchema, mapTree, parentField) {
+    return new EagerMapTreeNode(context, nodeSchema, mapTree, parentField);
 }
 /** Creates a field with the given attributes, or returns a cached field if there is one */
 function getOrCreateField(parent, key, schema) {
@@ -423,46 +413,23 @@ function getOrCreateField(parent, key, schema) {
     }
     if (schema.kind.identifier === index_js_5.FieldKinds.required.identifier ||
         schema.kind.identifier === index_js_5.FieldKinds.identifier.identifier) {
-        return new EagerMapTreeRequiredField(schema, key, parent);
+        return new EagerMapTreeRequiredField(parent.context, schema, key, parent);
     }
     if (schema.kind.identifier === index_js_5.FieldKinds.optional.identifier) {
-        return new EagerMapTreeOptionalField(schema, key, parent);
+        return new EagerMapTreeOptionalField(parent.context, schema, key, parent);
     }
     if (schema.kind.identifier === index_js_5.FieldKinds.sequence.identifier) {
-        return new EagerMapTreeSequenceField(schema, key, parent);
+        return new EagerMapTreeSequenceField(parent.context, schema, key, parent);
     }
-    return new EagerMapTreeField(schema, key, parent);
+    return new EagerMapTreeField(parent.context, schema, key, parent);
 }
-/** Unboxes non-polymorphic leaf nodes to their values, if applicable */
-function unboxedUnion(schema, mapTree, parent) {
-    const type = schema.monomorphicChildType;
-    if (type !== undefined) {
-        if ((0, index_js_4.schemaIsLeaf)(type)) {
-            return mapTree.value;
-        }
-        return getOrCreateChild(mapTree, type, parent);
-    }
-    return getOrCreateChild(mapTree, schema.allowedTypes, parent);
-}
-/** Unboxes non-polymorphic required and optional fields holding leaf nodes to their values, if applicable */
-function unboxedField(field, key, mapTree, parentNode) {
-    const fieldSchema = field.schema;
-    const mapTrees = mapTree.fields.get(key) ?? (0, index_js_2.fail)("Key does not exist in unhydrated map tree");
-    if (fieldSchema.kind === index_js_5.FieldKinds.required) {
-        return unboxedUnion(fieldSchema, mapTrees[0] ?? (0, internal_1.oob)(), {
-            parent: field,
-            index: 0,
-        });
-    }
-    if (fieldSchema.kind === index_js_5.FieldKinds.optional) {
-        return (mapTrees.length > 0
-            ? unboxedUnion(fieldSchema, mapTrees[0] ?? (0, internal_1.oob)(), {
-                parent: field,
-                index: 0,
-            })
-            : undefined);
+/** Unboxes leaf nodes to their values */
+function unboxed(schema, mapTree, parent) {
+    const value = mapTree.value;
+    if (value !== undefined) {
+        return value;
     }
-    return getOrCreateField(parentNode, key, fieldSchema);
+    return getOrCreateChild(parent.parent.context, mapTree, schema.allowedTypes, parent);
 }
 // #endregion Caching and unboxing utilities
 function unsupportedUsageError(message) {