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

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

@@ -0,0 +1,11 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { NodeKind, TreeNodeSchema } from "./schemaTypes.js";
+export declare const stringSchema: TreeNodeSchema<"com.fluidframework.leaf.string", NodeKind.Leaf, string, string>;
+export declare const numberSchema: TreeNodeSchema<"com.fluidframework.leaf.number", NodeKind.Leaf, number, number>;
+export declare const booleanSchema: TreeNodeSchema<"com.fluidframework.leaf.boolean", NodeKind.Leaf, boolean, boolean>;
+export declare const nullSchema: TreeNodeSchema<"com.fluidframework.leaf.null", NodeKind.Leaf, null, null>;
+export declare const handleSchema: TreeNodeSchema<"com.fluidframework.leaf.handle", NodeKind.Leaf, import("@fluidframework/core-interfaces").IFluidHandle<import("@fluidframework/core-interfaces").FluidObject & import("@fluidframework/core-interfaces").IFluidLoadable>, import("@fluidframework/core-interfaces").IFluidHandle<import("@fluidframework/core-interfaces").FluidObject & import("@fluidframework/core-interfaces").IFluidLoadable>>;
+//# sourceMappingURL=leafNodeSchema.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"leafNodeSchema.d.ts","sourceRoot":"","sources":["../../src/simple-tree/leafNodeSchema.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAcH,OAAO,EAAE,QAAQ,EAAE,cAAc,EAA0B,MAAM,kBAAkB,CAAC;AAkDpF,eAAO,MAAM,YAAY,iFAAwB,CAAC;AAClD,eAAO,MAAM,YAAY,iFAAwB,CAAC;AAClD,eAAO,MAAM,aAAa,oFAAyB,CAAC;AACpD,eAAO,MAAM,UAAU,2EAAsB,CAAC;AAC9C,eAAO,MAAM,YAAY,qZAAwB,CAAC"}

package/dist/simple-tree/leafNodeSchema.js

@@ -0,0 +1,51 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.handleSchema = exports.nullSchema = exports.booleanSchema = exports.numberSchema = exports.stringSchema = void 0;
+const internal_1 = require("@fluidframework/core-utils/internal");
+const index_js_1 = require("../domains/index.js");
+const index_js_2 = require("../feature-libraries/index.js");
+const schemaCaching_js_1 = require("./schemaCaching.js");
+const schemaTypes_js_1 = require("./schemaTypes.js");
+/**
+ * Instances of this class are schema for leaf nodes.
+ * @remarks
+ * Unlike other schema, leaf schema are class instances instead of classes themselves.
+ * This is because the instance type (the tree node type) for leaves are not objects,
+ * so those instances can't be instances of a schema based class.
+ * @privateRemarks
+ * This class refers to the underlying flex tree schema in its constructor, so this class can't be included in the package API.
+ */
+class LeafNodeSchema {
+    create(data) {
+        if ((0, index_js_2.isFlexTreeNode)(data)) {
+            const value = data.value;
+            (0, internal_1.assert)((0, index_js_2.valueSchemaAllows)(this.info, value), 0x916 /* invalid value */);
+            return value;
+        }
+        return data;
+    }
+    constructor(schema) {
+        this.kind = schemaTypes_js_1.NodeKind.Leaf;
+        this.implicitlyConstructable = true;
+        (0, schemaCaching_js_1.setFlexSchemaFromClassSchema)(this, schema);
+        this.identifier = schema.name;
+        this.info = schema.info;
+    }
+}
+/**
+ * Wrapper around LeafNodeSchema's constructor that provides the return type that is desired in the package public API.
+ */
+function makeLeaf(schema) {
+    return new LeafNodeSchema(schema);
+}
+// Leaf schema shared between all SchemaFactory instances.
+exports.stringSchema = makeLeaf(index_js_1.leaf.string);
+exports.numberSchema = makeLeaf(index_js_1.leaf.number);
+exports.booleanSchema = makeLeaf(index_js_1.leaf.boolean);
+exports.nullSchema = makeLeaf(index_js_1.leaf.null);
+exports.handleSchema = makeLeaf(index_js_1.leaf.handle);
+//# sourceMappingURL=leafNodeSchema.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"leafNodeSchema.js","sourceRoot":"","sources":["../../src/simple-tree/leafNodeSchema.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kEAA6D;AAG7D,kDAA2C;AAC3C,4DAKuC;AAEvC,yDAAkE;AAClE,qDAAoF;AAQpF;;;;;;;;GAQG;AACH,MAAM,cAAc;IAOZ,MAAM,CAAC,IAAyC;QACtD,IAAI,IAAA,yBAAc,EAAC,IAAI,CAAC,EAAE;YACzB,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;YACzB,IAAA,iBAAM,EAAC,IAAA,4BAAiB,EAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,KAAK,CAAC,mBAAmB,CAAC,CAAC;YACvE,OAAO,KAAK,CAAC;SACb;QACD,OAAO,IAAI,CAAC;IACb,CAAC;IAED,YAAmB,MAAS;QAZZ,SAAI,GAAG,yBAAQ,CAAC,IAAI,CAAC;QAErB,4BAAuB,GAAG,IAAa,CAAC;QAWvD,IAAA,+CAA4B,EAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC3C,IAAI,CAAC,UAAU,GAAG,MAAM,CAAC,IAAwB,CAAC;QAClD,IAAI,CAAC,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;IACzB,CAAC;CACD;AAED;;GAEG;AACH,SAAS,QAAQ,CAChB,MAAS;IAET,OAAO,IAAI,cAAc,CAAC,MAAM,CAAC,CAAC;AACnC,CAAC;AAED,0DAA0D;AAC7C,QAAA,YAAY,GAAG,QAAQ,CAAC,eAAI,CAAC,MAAM,CAAC,CAAC;AACrC,QAAA,YAAY,GAAG,QAAQ,CAAC,eAAI,CAAC,MAAM,CAAC,CAAC;AACrC,QAAA,aAAa,GAAG,QAAQ,CAAC,eAAI,CAAC,OAAO,CAAC,CAAC;AACvC,QAAA,UAAU,GAAG,QAAQ,CAAC,eAAI,CAAC,IAAI,CAAC,CAAC;AACjC,QAAA,YAAY,GAAG,QAAQ,CAAC,eAAI,CAAC,MAAM,CAAC,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils/internal\";\n\nimport { TreeNodeSchemaIdentifier, TreeValue } from \"../core/index.js\";\nimport { leaf } from \"../domains/index.js\";\nimport {\n\tLeafNodeSchema as FlexLeafNodeSchema,\n\tFlexTreeNode,\n\tisFlexTreeNode,\n\tvalueSchemaAllows,\n} from \"../feature-libraries/index.js\";\n\nimport { setFlexSchemaFromClassSchema } from \"./schemaCaching.js\";\nimport { NodeKind, TreeNodeSchema, TreeNodeSchemaNonClass } from \"./schemaTypes.js\";\n\ntype UnbrandedName<T extends FlexLeafNodeSchema> = T[\"name\"] extends TreeNodeSchemaIdentifier<\n\tinfer Name extends string\n>\n\t? Name\n\t: T[\"name\"];\n\n/**\n * Instances of this class are schema for leaf nodes.\n * @remarks\n * Unlike other schema, leaf schema are class instances instead of classes themselves.\n * This is because the instance type (the tree node type) for leaves are not objects,\n * so those instances can't be instances of a schema based class.\n * @privateRemarks\n * This class refers to the underlying flex tree schema in its constructor, so this class can't be included in the package API.\n */\nclass LeafNodeSchema<T extends FlexLeafNodeSchema>\n\timplements TreeNodeSchemaNonClass<UnbrandedName<T>, NodeKind.Leaf, TreeValue<T[\"info\"]>>\n{\n\tpublic readonly identifier: UnbrandedName<T>;\n\tpublic readonly kind = NodeKind.Leaf;\n\tpublic readonly info: T[\"info\"];\n\tpublic readonly implicitlyConstructable = true as const;\n\tpublic create(data: TreeValue<T[\"info\"]> | FlexTreeNode): TreeValue<T[\"info\"]> {\n\t\tif (isFlexTreeNode(data)) {\n\t\t\tconst value = data.value;\n\t\t\tassert(valueSchemaAllows(this.info, value), 0x916 /* invalid value */);\n\t\t\treturn value;\n\t\t}\n\t\treturn data;\n\t}\n\n\tpublic constructor(schema: T) {\n\t\tsetFlexSchemaFromClassSchema(this, schema);\n\t\tthis.identifier = schema.name as UnbrandedName<T>;\n\t\tthis.info = schema.info;\n\t}\n}\n\n/**\n * Wrapper around LeafNodeSchema's constructor that provides the return type that is desired in the package public API.\n */\nfunction makeLeaf<T extends FlexLeafNodeSchema>(\n\tschema: T,\n): TreeNodeSchema<UnbrandedName<T>, NodeKind.Leaf, TreeValue<T[\"info\"]>, TreeValue<T[\"info\"]>> {\n\treturn new LeafNodeSchema(schema);\n}\n\n// Leaf schema shared between all SchemaFactory instances.\nexport const stringSchema = makeLeaf(leaf.string);\nexport const numberSchema = makeLeaf(leaf.number);\nexport const booleanSchema = makeLeaf(leaf.boolean);\nexport const nullSchema = makeLeaf(leaf.null);\nexport const handleSchema = makeLeaf(leaf.handle);\n"]}

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

@@ -0,0 +1,86 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { FieldKey } from "../core/index.js";
+import { FlexMapNodeSchema, FlexTreeMapNode, FlexTreeTypedField, FlexTreeUnboxField, FlexibleFieldContent } from "../feature-libraries/index.js";
+import { InsertableContent } from "./proxies.js";
+import { NodeKind, type ImplicitAllowedTypes, type InsertableTreeNodeFromImplicitAllowedTypes, TreeNodeSchemaClass, WithType, TreeNodeFromImplicitAllowedTypes } from "./schemaTypes.js";
+import { TreeNode } from "./types.js";
+import { RawTreeNode } from "./rawNode.js";
+/**
+ * A map of string keys to tree objects.
+ *
+ * @privateRemarks
+ * Add support for `clear` once we have established merge semantics for it.
+ *
+ * @public
+ */
+export interface TreeMapNode<T extends ImplicitAllowedTypes = ImplicitAllowedTypes> extends ReadonlyMap<string, TreeNodeFromImplicitAllowedTypes<T>>, TreeNode {
+    /**
+     * Adds or updates an entry in the map with a specified `key` and a `value`.
+     *
+     * @param key - The key of the element to add to the map.
+     * @param value - The value of the element to add to the map.
+     *
+     * @remarks
+     * Setting the value at a key to `undefined` is equivalent to calling {@link TreeMapNode.delete} with that key.
+     */
+    set(key: string, value: InsertableTreeNodeFromImplicitAllowedTypes<T> | undefined): void;
+    /**
+     * Removes the specified element from this map by its `key`.
+     *
+     * @remarks
+     * Note: unlike JavaScript's Map API, this method does not return a flag indicating whether or not the value was
+     * deleted.
+     *
+     * @privateRemarks
+     * Regarding the choice to not return a boolean: Since this data structure is distributed in nature, it isn't
+     * possible to tell whether or not the item was deleted as a result of this method call. Returning a "best guess"
+     * is more likely to create issues / promote bad usage patterns than offer useful information.
+     *
+     * @param key - The key of the element to remove from the map.
+     */
+    delete(key: string): void;
+}
+export declare const mapStaticDispatchMap: PropertyDescriptorMap;
+/**
+ * @param allowAdditionalProperties - If true, setting of unexpected properties will be forwarded to the target object.
+ * Otherwise setting of unexpected properties will error.
+ * @param customTargetObject - Target object of the proxy.
+ * If not provided `new Map()` is used for the target and a separate object created to dispatch map methods.
+ * If provided, the customTargetObject will be used as both the dispatch object and the proxy target, and therefor must provide the map functionality from {@link mapPrototype}.
+ */
+export declare function createMapProxy(allowAdditionalProperties: boolean, customTargetObject?: object): TreeMapNode;
+/**
+ * Define a {@link TreeNodeSchema} for a {@link (TreeArrayNode:interface)}.
+ *
+ * @param name - Unique identifier for this schema including the factory's scope.
+ */
+export declare function mapSchema<TName extends string, const T extends ImplicitAllowedTypes, const ImplicitlyConstructable extends boolean>(base: TreeNodeSchemaClass<TName, NodeKind.Map, TreeNode & WithType<TName>, Iterable<[string, InsertableTreeNodeFromImplicitAllowedTypes<T>]>, ImplicitlyConstructable, T>, customizable: boolean): TreeNodeSchemaClass<TName, NodeKind.Map, TreeMapNode<T> & WithType<TName>, Iterable<[string, InsertableTreeNodeFromImplicitAllowedTypes<T>]>, ImplicitlyConstructable, T>;
+/**
+ * The implementation of a map node created by {@link createRawNode}.
+ */
+export declare class RawMapNode<TSchema extends FlexMapNodeSchema> extends RawTreeNode<TSchema, ReadonlyMap<string, InsertableContent>> implements FlexTreeMapNode<TSchema> {
+    get size(): number;
+    has(key: string): boolean;
+    get(key: string): FlexTreeUnboxField<TSchema["info"]>;
+    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?: any): void;
+    set(key: string, value: FlexibleFieldContent<TSchema["info"]> | undefined): void;
+    delete(key: string): void;
+    get asObject(): {
+        readonly [P in FieldKey]?: FlexTreeUnboxField<TSchema["info"], "notEmpty">;
+    };
+    [Symbol.iterator](): IterableIterator<[
+        FieldKey,
+        FlexTreeUnboxField<TSchema["info"], "notEmpty">
+    ]>;
+    boxedIterator(): IterableIterator<FlexTreeTypedField<TSchema["info"]>>;
+}
+//# sourceMappingURL=mapNode.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"mapNode.d.ts","sourceRoot":"","sources":["../../src/simple-tree/mapNode.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,QAAQ,EAA4B,MAAM,kBAAkB,CAAC;AACtE,OAAO,EACN,iBAAiB,EACjB,eAAe,EAEf,kBAAkB,EAClB,kBAAkB,EAClB,oBAAoB,EAEpB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EACN,iBAAiB,EAIjB,MAAM,cAAc,CAAC;AAGtB,OAAO,EACN,QAAQ,EACR,KAAK,oBAAoB,EACzB,KAAK,0CAA0C,EAC/C,mBAAmB,EACnB,QAAQ,EAGR,gCAAgC,EAChC,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAEtC,OAAO,EAAE,WAAW,EAAyB,MAAM,cAAc,CAAC;AAElE;;;;;;;GAOG;AACH,MAAM,WAAW,WAAW,CAAC,CAAC,SAAS,oBAAoB,GAAG,oBAAoB,CACjF,SAAQ,WAAW,CAAC,MAAM,EAAE,gCAAgC,CAAC,CAAC,CAAC,CAAC,EAC/D,QAAQ;IACT;;;;;;;;OAQG;IACH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,0CAA0C,CAAC,CAAC,CAAC,GAAG,SAAS,GAAG,IAAI,CAAC;IAEzF;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B;AAID,eAAO,MAAM,oBAAoB,EAAE,qBAsFlC,CAAC;AAMF;;;;;;GAMG;AACH,wBAAgB,cAAc,CAC7B,yBAAyB,EAAE,OAAO,EAClC,kBAAkB,CAAC,EAAE,MAAM,GACzB,WAAW,CA+Bb;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CACxB,KAAK,SAAS,MAAM,EACpB,KAAK,CAAC,CAAC,SAAS,oBAAoB,EACpC,KAAK,CAAC,uBAAuB,SAAS,OAAO,EAE7C,IAAI,EAAE,mBAAmB,CACxB,KAAK,EACL,QAAQ,CAAC,GAAG,EACZ,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,EAC1B,QAAQ,CAAC,CAAC,MAAM,EAAE,0CAA0C,CAAC,CAAC,CAAC,CAAC,CAAC,EACjE,uBAAuB,EACvB,CAAC,CACD,EACD,YAAY,EAAE,OAAO,6KAuCrB;AAED;;GAEG;AACH,qBAAa,UAAU,CAAC,OAAO,SAAS,iBAAiB,CACxD,SAAQ,WAAW,CAAC,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,iBAAiB,CAAC,CACnE,YAAW,eAAe,CAAC,OAAO,CAAC;IAEnC,IAAW,IAAI,IAAI,MAAM,CAExB;IACM,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO;IAGzB,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAGrD,IAAI,IAAI,gBAAgB,CAAC,QAAQ,CAAC;IAGlC,MAAM,IAAI,gBAAgB,CAAC,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC,CAAC;IAG3E,OAAO,IAAI,gBAAgB,CACjC;QAAC,QAAQ;QAAE,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC;KAAC,CAC3D;IAGM,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,GAAG,GACX,IAAI;IAGA,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,oBAAoB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAAG,SAAS,GAAG,IAAI;IAGhF,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI;IAIhC,IAAW,QAAQ,IAAI;QACtB,QAAQ,EAAE,CAAC,IAAI,QAAQ,CAAC,CAAC,EAAE,kBAAkB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,UAAU,CAAC;KAC1E,CAEA;IAEM,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"}

package/dist/simple-tree/mapNode.js

@@ -0,0 +1,204 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RawMapNode = exports.mapSchema = exports.createMapProxy = exports.mapStaticDispatchMap = void 0;
+const internal_1 = require("@fluidframework/core-utils/internal");
+const index_js_1 = require("../feature-libraries/index.js");
+const proxies_js_1 = require("./proxies.js");
+const proxyBinding_js_1 = require("./proxyBinding.js");
+const schemaCaching_js_1 = require("./schemaCaching.js");
+const toMapTree_js_1 = require("./toMapTree.js");
+const toFlexSchema_js_1 = require("./toFlexSchema.js");
+const rawNode_js_1 = require("./rawNode.js");
+// #region Create dispatch map for maps
+exports.mapStaticDispatchMap = {
+    [Symbol.iterator]: {
+        value() {
+            return this.entries();
+        },
+    },
+    delete: {
+        value(key) {
+            const node = (0, proxyBinding_js_1.getFlexNode)(this);
+            node.delete(key);
+        },
+    },
+    entries: {
+        *value() {
+            const node = (0, proxyBinding_js_1.getFlexNode)(this);
+            for (const key of node.keys()) {
+                yield [key, (0, proxies_js_1.getProxyForField)(node.getBoxed(key))];
+            }
+        },
+    },
+    get: {
+        value(key) {
+            const node = (0, proxyBinding_js_1.getFlexNode)(this);
+            const field = node.getBoxed(key);
+            return (0, proxies_js_1.getProxyForField)(field);
+        },
+    },
+    has: {
+        value(key) {
+            const node = (0, proxyBinding_js_1.getFlexNode)(this);
+            return node.has(key);
+        },
+    },
+    keys: {
+        value() {
+            const node = (0, proxyBinding_js_1.getFlexNode)(this);
+            return node.keys();
+        },
+    },
+    set: {
+        value(key, value) {
+            const node = (0, proxyBinding_js_1.getFlexNode)(this);
+            const content = (0, proxies_js_1.prepareContentForInsert)(value, node.context.forest);
+            const classSchema = (0, schemaCaching_js_1.getSimpleNodeSchema)(node.schema);
+            const cursor = (0, toMapTree_js_1.cursorFromNodeData)(content, classSchema.info);
+            node.set(key, cursor);
+            return this;
+        },
+    },
+    size: {
+        get() {
+            return (0, proxyBinding_js_1.getFlexNode)(this).size;
+        },
+    },
+    values: {
+        *value() {
+            for (const [, value] of this.entries()) {
+                yield value;
+            }
+        },
+    },
+    forEach: {
+        value(callbackFn, thisArg) {
+            if (thisArg === undefined) {
+                // We can't pass `callbackFn` to `FlexTreeMapNode` directly, or else the third argument ("map") will be a flex node instead of the proxy.
+                (0, proxyBinding_js_1.getFlexNode)(this).forEach((v, k, _) => callbackFn(v, k, this), thisArg);
+            }
+            else {
+                const boundCallbackFn = callbackFn.bind(thisArg);
+                (0, proxyBinding_js_1.getFlexNode)(this).forEach((v, k, _) => boundCallbackFn(v, k, this), thisArg);
+            }
+        },
+    },
+    // TODO: add `clear` once we have established merge semantics for it.
+};
+const mapPrototype = Object.create(Object.prototype, exports.mapStaticDispatchMap);
+// #endregion
+/**
+ * @param allowAdditionalProperties - If true, setting of unexpected properties will be forwarded to the target object.
+ * Otherwise setting of unexpected properties will error.
+ * @param customTargetObject - Target object of the proxy.
+ * If not provided `new Map()` is used for the target and a separate object created to dispatch map methods.
+ * If provided, the customTargetObject will be used as both the dispatch object and the proxy target, and therefor must provide the map functionality from {@link mapPrototype}.
+ */
+function createMapProxy(allowAdditionalProperties, customTargetObject) {
+    // Create a 'dispatch' object that this Proxy forwards to instead of the proxy target.
+    const dispatch = customTargetObject ??
+        Object.create(mapPrototype, {
+        // Empty - JavaScript Maps do not expose any "own" properties.
+        });
+    const targetObject = customTargetObject ?? new Map();
+    // TODO: Although the target is an object literal, it's still worthwhile to try experimenting with
+    // a dispatch object to see if it improves performance.
+    const proxy = new Proxy(targetObject, {
+        get: (target, key, receiver) => {
+            // Pass the proxy as the receiver here, so that any methods on the prototype receive `proxy` as `this`.
+            return Reflect.get(dispatch, key, proxy);
+        },
+        getOwnPropertyDescriptor: (target, key) => {
+            return Reflect.getOwnPropertyDescriptor(dispatch, key);
+        },
+        has: (target, key) => {
+            return Reflect.has(dispatch, key);
+        },
+        set: (target, key, newValue) => {
+            return allowAdditionalProperties ? Reflect.set(dispatch, key, newValue) : false;
+        },
+        ownKeys: (target) => {
+            // All of Map's properties are inherited via its prototype, so there is nothing to return here,
+            return [];
+        },
+    });
+    return proxy;
+}
+exports.createMapProxy = createMapProxy;
+/**
+ * Define a {@link TreeNodeSchema} for a {@link (TreeArrayNode:interface)}.
+ *
+ * @param name - Unique identifier for this schema including the factory's scope.
+ */
+function mapSchema(base, customizable) {
+    class schema extends base {
+        constructor(input) {
+            super(input);
+            const proxyTarget = customizable ? this : undefined;
+            const flexSchema = (0, toFlexSchema_js_1.getFlexSchema)(this.constructor);
+            (0, internal_1.assert)(flexSchema instanceof index_js_1.FlexMapNodeSchema, 0x917 /* invalid flex schema */);
+            const flexNode = (0, index_js_1.isFlexTreeNode)(input)
+                ? input
+                : new RawMapNode(flexSchema, copyContent(flexSchema.name, input));
+            const proxy = createMapProxy(customizable, proxyTarget);
+            (0, proxyBinding_js_1.setFlexNode)(proxy, flexNode);
+            return proxy;
+        }
+    }
+    // Setup map functionality
+    Object.defineProperties(schema.prototype, exports.mapStaticDispatchMap);
+    return schema;
+}
+exports.mapSchema = mapSchema;
+/**
+ * The implementation of a map node created by {@link createRawNode}.
+ */
+class RawMapNode extends rawNode_js_1.RawTreeNode {
+    get size() {
+        return this[rawNode_js_1.nodeContent].size;
+    }
+    has(key) {
+        return this[rawNode_js_1.nodeContent].has(key);
+    }
+    get(key) {
+        return this[rawNode_js_1.nodeContent].get(key);
+    }
+    keys() {
+        return this[rawNode_js_1.nodeContent].keys();
+    }
+    values() {
+        throw (0, rawNode_js_1.rawError)("Iterating map values");
+    }
+    entries() {
+        throw (0, rawNode_js_1.rawError)("Iterating map entries");
+    }
+    forEach(callbackFn, thisArg) {
+        throw (0, rawNode_js_1.rawError)("Iterating maps with forEach");
+    }
+    set(key, value) {
+        throw (0, rawNode_js_1.rawError)("Setting a map entry");
+    }
+    delete(key) {
+        throw (0, rawNode_js_1.rawError)("Deleting a map entry");
+    }
+    get asObject() {
+        throw (0, rawNode_js_1.rawError)("Converting a map to an object");
+    }
+    [Symbol.iterator]() {
+        return this.entries();
+    }
+    boxedIterator() {
+        throw (0, rawNode_js_1.rawError)("Boxed iteration");
+    }
+}
+exports.RawMapNode = RawMapNode;
+function copyContent(typeName, content) {
+    const copy = new Map(content);
+    (0, proxies_js_1.markContentType)(typeName, copy);
+    return copy;
+}
+//# sourceMappingURL=mapNode.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"mapNode.js","sourceRoot":"","sources":["../../src/simple-tree/mapNode.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,kEAA6D;AAE7D,4DAQuC;AACvC,6CAKsB;AACtB,uDAA6D;AAC7D,yDAAyD;AAWzD,iDAAoD;AAEpD,uDAAkD;AAClD,6CAAkE;AAyClE,uCAAuC;AAE1B,QAAA,oBAAoB,GAA0B;IAC1D,CAAC,MAAM,CAAC,QAAQ,CAAC,EAAE;QAClB,KAAK;YACJ,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;QACvB,CAAC;KACD;IACD,MAAM,EAAE;QACP,KAAK,CAAoB,GAAW;YACnC,MAAM,IAAI,GAAG,IAAA,6BAAW,EAAC,IAAI,CAAC,CAAC;YAC/B,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QAClB,CAAC;KACD;IACD,OAAO,EAAE;QACR,CAAC,KAAK;YACL,MAAM,IAAI,GAAG,IAAA,6BAAW,EAAC,IAAI,CAAC,CAAC;YAC/B,KAAK,MAAM,GAAG,IAAI,IAAI,CAAC,IAAI,EAAE,EAAE;gBAC9B,MAAM,CAAC,GAAG,EAAE,IAAA,6BAAgB,EAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;aAClD;QACF,CAAC;KACD;IACD,GAAG,EAAE;QACJ,KAAK,CAAoB,GAAW;YACnC,MAAM,IAAI,GAAG,IAAA,6BAAW,EAAC,IAAI,CAAC,CAAC;YAC/B,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;YACjC,OAAO,IAAA,6BAAgB,EAAC,KAAK,CAAC,CAAC;QAChC,CAAC;KACD;IACD,GAAG,EAAE;QACJ,KAAK,CAAoB,GAAW;YACnC,MAAM,IAAI,GAAG,IAAA,6BAAW,EAAC,IAAI,CAAC,CAAC;YAC/B,OAAO,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;QACtB,CAAC;KACD;IACD,IAAI,EAAE;QACL,KAAK;YACJ,MAAM,IAAI,GAAG,IAAA,6BAAW,EAAC,IAAI,CAAC,CAAC;YAC/B,OAAO,IAAI,CAAC,IAAI,EAAE,CAAC;QACpB,CAAC;KACD;IACD,GAAG,EAAE;QACJ,KAAK,CAEJ,GAAW,EACX,KAA0C;YAE1C,MAAM,IAAI,GAAG,IAAA,6BAAW,EAAC,IAAI,CAAC,CAAC;YAC/B,MAAM,OAAO,GAAG,IAAA,oCAAuB,EACtC,KAA0B,EAC1B,IAAI,CAAC,OAAO,CAAC,MAAM,CACnB,CAAC;YAEF,MAAM,WAAW,GAAG,IAAA,sCAAmB,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACrD,MAAM,MAAM,GAAG,IAAA,iCAAkB,EAAC,OAAO,EAAE,WAAW,CAAC,IAA4B,CAAC,CAAC;YAErF,IAAI,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;YACtB,OAAO,IAAI,CAAC;QACb,CAAC;KACD;IACD,IAAI,EAAE;QACL,GAAG;YACF,OAAO,IAAA,6BAAW,EAAC,IAAI,CAAC,CAAC,IAAI,CAAC;QAC/B,CAAC;KACD;IACD,MAAM,EAAE;QACP,CAAC,KAAK;YACL,KAAK,MAAM,CAAC,EAAE,KAAK,CAAC,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE;gBACvC,MAAM,KAAK,CAAC;aACZ;QACF,CAAC;KACD;IACD,OAAO,EAAE;QACR,KAAK,CAEJ,UAAoF,EACpF,OAAa;YAEb,IAAI,OAAO,KAAK,SAAS,EAAE;gBAC1B,yIAAyI;gBACzI,IAAA,6BAAW,EAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,UAAU,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;aACxE;iBAAM;gBACN,MAAM,eAAe,GAAG,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;gBACjD,IAAA,6BAAW,EAAC,IAAI,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,eAAe,CAAC,CAAC,EAAE,CAAC,EAAE,IAAI,CAAC,EAAE,OAAO,CAAC,CAAC;aAC7E;QACF,CAAC;KACD;IACD,qEAAqE;CACrE,CAAC;AAEF,MAAM,YAAY,GAAG,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,EAAE,4BAAoB,CAAC,CAAC;AAE3E,aAAa;AAEb;;;;;;GAMG;AACH,SAAgB,cAAc,CAC7B,yBAAkC,EAClC,kBAA2B;IAE3B,sFAAsF;IACtF,MAAM,QAAQ,GACb,kBAAkB;QAClB,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE;QAC3B,8DAA8D;SAC9D,CAAC,CAAC;IACJ,MAAM,YAAY,GAAW,kBAAkB,IAAI,IAAI,GAAG,EAAoB,CAAC;IAE/E,kGAAkG;IAClG,uDAAuD;IACvD,MAAM,KAAK,GAAG,IAAI,KAAK,CAAc,YAA2B,EAAE;QACjE,GAAG,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAW,EAAE;YACvC,uGAAuG;YACvG,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,EAAE,KAAK,CAAC,CAAC;QAC1C,CAAC;QACD,wBAAwB,EAAE,CAAC,MAAM,EAAE,GAAG,EAAkC,EAAE;YACzE,OAAO,OAAO,CAAC,wBAAwB,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QACxD,CAAC;QACD,GAAG,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,EAAE;YACpB,OAAO,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,CAAC,CAAC;QACnC,CAAC;QACD,GAAG,EAAE,CAAC,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAW,EAAE;YACvC,OAAO,yBAAyB,CAAC,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,GAAG,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QACjF,CAAC;QACD,OAAO,EAAE,CAAC,MAAM,EAAE,EAAE;YACnB,+FAA+F;YAC/F,OAAO,EAAE,CAAC;QACX,CAAC;KACD,CAAC,CAAC;IACH,OAAO,KAAK,CAAC;AACd,CAAC;AAlCD,wCAkCC;AAED;;;;GAIG;AACH,SAAgB,SAAS,CAKxB,IAOC,EACD,YAAqB;IAErB,MAAM,MAAO,SAAQ,IAAI;QACxB,YACC,KAAwE;YAExE,KAAK,CAAC,KAAK,CAAC,CAAC;YAEb,MAAM,WAAW,GAAG,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC;YAEpD,MAAM,UAAU,GAAG,IAAA,+BAAa,EAAC,IAAI,CAAC,WAA6B,CAAC,CAAC;YACrE,IAAA,iBAAM,EAAC,UAAU,YAAY,4BAAiB,EAAE,KAAK,CAAC,yBAAyB,CAAC,CAAC;YACjF,MAAM,QAAQ,GAAiB,IAAA,yBAAc,EAAC,KAAK,CAAC;gBACnD,CAAC,CAAC,KAAK;gBACP,CAAC,CAAC,IAAI,UAAU,CACd,UAAU,EACV,WAAW,CAAC,UAAU,CAAC,IAAI,EAAE,KAAK,CAGjC,CACA,CAAC;YAEL,MAAM,KAAK,GAAa,cAAc,CAAC,YAAY,EAAE,WAAW,CAAC,CAAC;YAClE,IAAA,6BAAW,EAAC,KAAK,EAAE,QAAQ,CAAC,CAAC;YAC7B,OAAO,KAA0B,CAAC;QACnC,CAAC;KACD;IAED,0BAA0B;IAC1B,MAAM,CAAC,gBAAgB,CAAC,MAAM,CAAC,SAAS,EAAE,4BAAoB,CAAC,CAAC;IAEhE,OAAO,MAON,CAAC;AACH,CAAC;AApDD,8BAoDC;AAED;;GAEG;AACH,MAAa,UACZ,SAAQ,wBAA4D;IAGpE,IAAW,IAAI;QACd,OAAO,IAAI,CAAC,wBAAW,CAAC,CAAC,IAAI,CAAC;IAC/B,CAAC;IACM,GAAG,CAAC,GAAW;QACrB,OAAO,IAAI,CAAC,wBAAW,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IACnC,CAAC;IACM,GAAG,CAAC,GAAW;QACrB,OAAO,IAAI,CAAC,wBAAW,CAAC,CAAC,GAAG,CAAC,GAAG,CAAwC,CAAC;IAC1E,CAAC;IACM,IAAI;QACV,OAAO,IAAI,CAAC,wBAAW,CAAC,CAAC,IAAI,EAAgC,CAAC;IAC/D,CAAC;IACM,MAAM;QACZ,MAAM,IAAA,qBAAQ,EAAC,sBAAsB,CAAC,CAAC;IACxC,CAAC;IACM,OAAO;QAGb,MAAM,IAAA,qBAAQ,EAAC,uBAAuB,CAAC,CAAC;IACzC,CAAC;IACM,OAAO,CACb,UAIS,EACT,OAAa;QAEb,MAAM,IAAA,qBAAQ,EAAC,6BAA6B,CAAC,CAAC;IAC/C,CAAC;IACM,GAAG,CAAC,GAAW,EAAE,KAAwD;QAC/E,MAAM,IAAA,qBAAQ,EAAC,qBAAqB,CAAC,CAAC;IACvC,CAAC;IACM,MAAM,CAAC,GAAW;QACxB,MAAM,IAAA,qBAAQ,EAAC,sBAAsB,CAAC,CAAC;IACxC,CAAC;IAED,IAAW,QAAQ;QAGlB,MAAM,IAAA,qBAAQ,EAAC,+BAA+B,CAAC,CAAC;IACjD,CAAC;IAEM,CAAC,MAAM,CAAC,QAAQ,CAAC;QAGvB,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IACvB,CAAC;IAEe,aAAa;QAC5B,MAAM,IAAA,qBAAQ,EAAC,iBAAiB,CAAC,CAAC;IACnC,CAAC;CACD;AAxDD,gCAwDC;AAED,SAAS,WAAW,CACnB,QAAkC,EAClC,OAA8B;IAE9B,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,CAAC;IAC9B,IAAA,4BAAe,EAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;IAChC,OAAO,IAAI,CAAC;AACb,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport { FieldKey, TreeNodeSchemaIdentifier } from \"../core/index.js\";\nimport {\n\tFlexMapNodeSchema,\n\tFlexTreeMapNode,\n\tFlexTreeNode,\n\tFlexTreeTypedField,\n\tFlexTreeUnboxField,\n\tFlexibleFieldContent,\n\tisFlexTreeNode,\n} from \"../feature-libraries/index.js\";\nimport {\n\tInsertableContent,\n\tgetProxyForField,\n\tmarkContentType,\n\tprepareContentForInsert,\n} from \"./proxies.js\";\nimport { getFlexNode, setFlexNode } from \"./proxyBinding.js\";\nimport { getSimpleNodeSchema } from \"./schemaCaching.js\";\nimport {\n\tNodeKind,\n\ttype ImplicitAllowedTypes,\n\ttype InsertableTreeNodeFromImplicitAllowedTypes,\n\tTreeNodeSchemaClass,\n\tWithType,\n\tTreeNodeSchema,\n\tInsertableTypedNode,\n\tTreeNodeFromImplicitAllowedTypes,\n} from \"./schemaTypes.js\";\nimport { cursorFromNodeData } from \"./toMapTree.js\";\nimport { TreeNode } from \"./types.js\";\nimport { getFlexSchema } from \"./toFlexSchema.js\";\nimport { RawTreeNode, nodeContent, rawError } from \"./rawNode.js\";\n\n/**\n * A map of string keys to tree objects.\n *\n * @privateRemarks\n * Add support for `clear` once we have established merge semantics for it.\n *\n * @public\n */\nexport interface TreeMapNode<T extends ImplicitAllowedTypes = ImplicitAllowedTypes>\n\textends ReadonlyMap<string, TreeNodeFromImplicitAllowedTypes<T>>,\n\t\tTreeNode {\n\t/**\n\t * Adds or updates an entry in the map with a specified `key` and a `value`.\n\t *\n\t * @param key - The key of the element to add to the map.\n\t * @param value - The value of the element to add to the map.\n\t *\n\t * @remarks\n\t * Setting the value at a key to `undefined` is equivalent to calling {@link TreeMapNode.delete} with that key.\n\t */\n\tset(key: string, value: InsertableTreeNodeFromImplicitAllowedTypes<T> | undefined): void;\n\n\t/**\n\t * Removes the specified element from this map by its `key`.\n\t *\n\t * @remarks\n\t * Note: unlike JavaScript's Map API, this method does not return a flag indicating whether or not the value was\n\t * deleted.\n\t *\n\t * @privateRemarks\n\t * Regarding the choice to not return a boolean: Since this data structure is distributed in nature, it isn't\n\t * possible to tell whether or not the item was deleted as a result of this method call. Returning a \"best guess\"\n\t * is more likely to create issues / promote bad usage patterns than offer useful information.\n\t *\n\t * @param key - The key of the element to remove from the map.\n\t */\n\tdelete(key: string): void;\n}\n\n// #region Create dispatch map for maps\n\nexport const mapStaticDispatchMap: PropertyDescriptorMap = {\n\t[Symbol.iterator]: {\n\t\tvalue(this: TreeMapNode) {\n\t\t\treturn this.entries();\n\t\t},\n\t},\n\tdelete: {\n\t\tvalue(this: TreeMapNode, key: string): void {\n\t\t\tconst node = getFlexNode(this);\n\t\t\tnode.delete(key);\n\t\t},\n\t},\n\tentries: {\n\t\t*value(this: TreeMapNode): IterableIterator<[string, unknown]> {\n\t\t\tconst node = getFlexNode(this);\n\t\t\tfor (const key of node.keys()) {\n\t\t\t\tyield [key, getProxyForField(node.getBoxed(key))];\n\t\t\t}\n\t\t},\n\t},\n\tget: {\n\t\tvalue(this: TreeMapNode, key: string): unknown {\n\t\t\tconst node = getFlexNode(this);\n\t\t\tconst field = node.getBoxed(key);\n\t\t\treturn getProxyForField(field);\n\t\t},\n\t},\n\thas: {\n\t\tvalue(this: TreeMapNode, key: string): boolean {\n\t\t\tconst node = getFlexNode(this);\n\t\t\treturn node.has(key);\n\t\t},\n\t},\n\tkeys: {\n\t\tvalue(this: TreeMapNode): IterableIterator<string> {\n\t\t\tconst node = getFlexNode(this);\n\t\t\treturn node.keys();\n\t\t},\n\t},\n\tset: {\n\t\tvalue(\n\t\t\tthis: TreeMapNode,\n\t\t\tkey: string,\n\t\t\tvalue: InsertableTypedNode<TreeNodeSchema>,\n\t\t): TreeMapNode {\n\t\t\tconst node = getFlexNode(this);\n\t\t\tconst content = prepareContentForInsert(\n\t\t\t\tvalue as InsertableContent,\n\t\t\t\tnode.context.forest,\n\t\t\t);\n\n\t\t\tconst classSchema = getSimpleNodeSchema(node.schema);\n\t\t\tconst cursor = cursorFromNodeData(content, classSchema.info as ImplicitAllowedTypes);\n\n\t\t\tnode.set(key, cursor);\n\t\t\treturn this;\n\t\t},\n\t},\n\tsize: {\n\t\tget(this: TreeMapNode) {\n\t\t\treturn getFlexNode(this).size;\n\t\t},\n\t},\n\tvalues: {\n\t\t*value(this: TreeMapNode): IterableIterator<unknown> {\n\t\t\tfor (const [, value] of this.entries()) {\n\t\t\t\tyield value;\n\t\t\t}\n\t\t},\n\t},\n\tforEach: {\n\t\tvalue(\n\t\t\tthis: TreeMapNode,\n\t\t\tcallbackFn: (value: unknown, key: string, map: ReadonlyMap<string, unknown>) => void,\n\t\t\tthisArg?: any,\n\t\t): void {\n\t\t\tif (thisArg === undefined) {\n\t\t\t\t// We can't pass `callbackFn` to `FlexTreeMapNode` directly, or else the third argument (\"map\") will be a flex node instead of the proxy.\n\t\t\t\tgetFlexNode(this).forEach((v, k, _) => callbackFn(v, k, this), thisArg);\n\t\t\t} else {\n\t\t\t\tconst boundCallbackFn = callbackFn.bind(thisArg);\n\t\t\t\tgetFlexNode(this).forEach((v, k, _) => boundCallbackFn(v, k, this), thisArg);\n\t\t\t}\n\t\t},\n\t},\n\t// TODO: add `clear` once we have established merge semantics for it.\n};\n\nconst mapPrototype = Object.create(Object.prototype, mapStaticDispatchMap);\n\n// #endregion\n\n/**\n * @param allowAdditionalProperties - If true, setting of unexpected properties will be forwarded to the target object.\n * Otherwise setting of unexpected properties will error.\n * @param customTargetObject - Target object of the proxy.\n * If not provided `new Map()` is used for the target and a separate object created to dispatch map methods.\n * If provided, the customTargetObject will be used as both the dispatch object and the proxy target, and therefor must provide the map functionality from {@link mapPrototype}.\n */\nexport function createMapProxy(\n\tallowAdditionalProperties: boolean,\n\tcustomTargetObject?: object,\n): TreeMapNode {\n\t// Create a 'dispatch' object that this Proxy forwards to instead of the proxy target.\n\tconst dispatch: object =\n\t\tcustomTargetObject ??\n\t\tObject.create(mapPrototype, {\n\t\t\t// Empty - JavaScript Maps do not expose any \"own\" properties.\n\t\t});\n\tconst targetObject: object = customTargetObject ?? new Map<string, TreeNode>();\n\n\t// TODO: Although the target is an object literal, it's still worthwhile to try experimenting with\n\t// a dispatch object to see if it improves performance.\n\tconst proxy = new Proxy<TreeMapNode>(targetObject as TreeMapNode, {\n\t\tget: (target, key, receiver): unknown => {\n\t\t\t// Pass the proxy as the receiver here, so that any methods on the prototype receive `proxy` as `this`.\n\t\t\treturn Reflect.get(dispatch, key, proxy);\n\t\t},\n\t\tgetOwnPropertyDescriptor: (target, key): PropertyDescriptor | undefined => {\n\t\t\treturn Reflect.getOwnPropertyDescriptor(dispatch, key);\n\t\t},\n\t\thas: (target, key) => {\n\t\t\treturn Reflect.has(dispatch, key);\n\t\t},\n\t\tset: (target, key, newValue): boolean => {\n\t\t\treturn allowAdditionalProperties ? Reflect.set(dispatch, key, newValue) : false;\n\t\t},\n\t\townKeys: (target) => {\n\t\t\t// All of Map's properties are inherited via its prototype, so there is nothing to return here,\n\t\t\treturn [];\n\t\t},\n\t});\n\treturn proxy;\n}\n\n/**\n * Define a {@link TreeNodeSchema} for a {@link (TreeArrayNode:interface)}.\n *\n * @param name - Unique identifier for this schema including the factory's scope.\n */\nexport function mapSchema<\n\tTName extends string,\n\tconst T extends ImplicitAllowedTypes,\n\tconst ImplicitlyConstructable extends boolean,\n>(\n\tbase: TreeNodeSchemaClass<\n\t\tTName,\n\t\tNodeKind.Map,\n\t\tTreeNode & WithType<TName>,\n\t\tIterable<[string, InsertableTreeNodeFromImplicitAllowedTypes<T>]>,\n\t\tImplicitlyConstructable,\n\t\tT\n\t>,\n\tcustomizable: boolean,\n) {\n\tclass schema extends base {\n\t\tpublic constructor(\n\t\t\tinput: Iterable<[string, InsertableTreeNodeFromImplicitAllowedTypes<T>]>,\n\t\t) {\n\t\t\tsuper(input);\n\n\t\t\tconst proxyTarget = customizable ? this : undefined;\n\n\t\t\tconst flexSchema = getFlexSchema(this.constructor as TreeNodeSchema);\n\t\t\tassert(flexSchema instanceof FlexMapNodeSchema, 0x917 /* invalid flex schema */);\n\t\t\tconst flexNode: FlexTreeNode = isFlexTreeNode(input)\n\t\t\t\t? input\n\t\t\t\t: new RawMapNode(\n\t\t\t\t\t\tflexSchema,\n\t\t\t\t\t\tcopyContent(flexSchema.name, input) as ReadonlyMap<\n\t\t\t\t\t\t\tstring,\n\t\t\t\t\t\t\tInsertableContent\n\t\t\t\t\t\t>,\n\t\t\t\t  );\n\n\t\t\tconst proxy: TreeNode = createMapProxy(customizable, proxyTarget);\n\t\t\tsetFlexNode(proxy, flexNode);\n\t\t\treturn proxy as unknown as schema;\n\t\t}\n\t}\n\n\t// Setup map functionality\n\tObject.defineProperties(schema.prototype, mapStaticDispatchMap);\n\n\treturn schema as TreeNodeSchemaClass<\n\t\tTName,\n\t\tNodeKind.Map,\n\t\tTreeMapNode<T> & WithType<TName>,\n\t\tIterable<[string, InsertableTreeNodeFromImplicitAllowedTypes<T>]>,\n\t\tImplicitlyConstructable,\n\t\tT\n\t>;\n}\n\n/**\n * The implementation of a map node created by {@link createRawNode}.\n */\nexport class RawMapNode<TSchema extends FlexMapNodeSchema>\n\textends RawTreeNode<TSchema, ReadonlyMap<string, InsertableContent>>\n\timplements FlexTreeMapNode<TSchema>\n{\n\tpublic get size(): number {\n\t\treturn this[nodeContent].size;\n\t}\n\tpublic has(key: string): boolean {\n\t\treturn this[nodeContent].has(key);\n\t}\n\tpublic get(key: string): FlexTreeUnboxField<TSchema[\"info\"]> {\n\t\treturn this[nodeContent].get(key) as FlexTreeUnboxField<TSchema[\"info\"]>;\n\t}\n\tpublic keys(): IterableIterator<FieldKey> {\n\t\treturn this[nodeContent].keys() as IterableIterator<FieldKey>;\n\t}\n\tpublic values(): IterableIterator<FlexTreeUnboxField<TSchema[\"info\"], \"notEmpty\">> {\n\t\tthrow rawError(\"Iterating map values\");\n\t}\n\tpublic entries(): IterableIterator<\n\t\t[FieldKey, FlexTreeUnboxField<TSchema[\"info\"], \"notEmpty\">]\n\t> {\n\t\tthrow rawError(\"Iterating map entries\");\n\t}\n\tpublic forEach(\n\t\tcallbackFn: (\n\t\t\tvalue: FlexTreeUnboxField<TSchema[\"info\"], \"notEmpty\">,\n\t\t\tkey: FieldKey,\n\t\t\tmap: FlexTreeMapNode<TSchema>,\n\t\t) => void,\n\t\tthisArg?: any,\n\t): void {\n\t\tthrow rawError(\"Iterating maps with forEach\");\n\t}\n\tpublic set(key: string, value: FlexibleFieldContent<TSchema[\"info\"]> | undefined): void {\n\t\tthrow rawError(\"Setting a map entry\");\n\t}\n\tpublic delete(key: string): void {\n\t\tthrow rawError(\"Deleting a map entry\");\n\t}\n\n\tpublic get asObject(): {\n\t\treadonly [P in FieldKey]?: FlexTreeUnboxField<TSchema[\"info\"], \"notEmpty\">;\n\t} {\n\t\tthrow rawError(\"Converting a map to an object\");\n\t}\n\n\tpublic [Symbol.iterator](): IterableIterator<\n\t\t[FieldKey, FlexTreeUnboxField<TSchema[\"info\"], \"notEmpty\">]\n\t> {\n\t\treturn this.entries();\n\t}\n\n\tpublic override boxedIterator(): IterableIterator<FlexTreeTypedField<TSchema[\"info\"]>> {\n\t\tthrow rawError(\"Boxed iteration\");\n\t}\n}\n\nfunction copyContent<T>(\n\ttypeName: TreeNodeSchemaIdentifier,\n\tcontent: Iterable<[string, T]>,\n): Map<string, T> {\n\tconst copy = new Map(content);\n\tmarkContentType(typeName, copy);\n\treturn copy;\n}\n"]}

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

@@ -0,0 +1,62 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { FlexObjectNodeSchema, FlexTreeField, FlexTreeObjectNode, LocalNodeKey } from "../feature-libraries/index.js";
+import { InsertableContent } from "./proxies.js";
+import { NodeKind, ImplicitFieldSchema, TreeNodeSchemaClass, WithType, TreeFieldFromImplicitField, InsertableTreeFieldFromImplicitField, FieldSchema } from "./schemaTypes.js";
+import { TreeNode } from "./types.js";
+import { RestrictiveReadonlyRecord } from "../util/index.js";
+import { RawTreeNode } from "./rawNode.js";
+/**
+ * Helper used to produce types for object nodes.
+ * @public
+ */
+export type ObjectFromSchemaRecord<T extends RestrictiveReadonlyRecord<string, ImplicitFieldSchema>> = {
+    -readonly [Property in keyof T]: TreeFieldFromImplicitField<T[Property]>;
+};
+/**
+ * A {@link TreeNode} which modules a JavaScript object.
+ * @remarks
+ * Object nodes consist of a type which specifies which {@link TreeNodeSchema} they use (see {@link TreeNodeApi.schema}), and a collections of fields, each with a distinct `key` and its own {@link FieldSchema} defining what can be placed under that key.
+ *
+ * All fields on an object node are exposed as own properties with string keys.
+ * Non-empty fields are enumerable and empty optional fields are non-enumerable own properties with the value `undefined`.
+ * No other own `own` or `enumerable` properties are included on object nodes unless the user of the node manually adds custom session only state.
+ * This allows a majority of general purpose JavaScript object processing operations (like `for...in`, `Reflect.ownKeys()` and `Object.entries()`) to enumerate all the children.
+ * @public
+ */
+export type TreeObjectNode<T extends RestrictiveReadonlyRecord<string, ImplicitFieldSchema>, TypeName extends string = string> = TreeNode & ObjectFromSchemaRecord<T> & WithType<TypeName>;
+/**
+ * Helper used to produce types for:
+ *
+ * 1. Insertable content which can be used to construct an object node.
+ *
+ * 2. Insertable content which is an unhydrated object node.
+ *
+ * 3. Union of 1 and 2.
+ *
+ * @privateRemarks TODO: consider separating these cases into different types.
+ *
+ * @public
+ */
+export type InsertableObjectFromSchemaRecord<T extends RestrictiveReadonlyRecord<string, ImplicitFieldSchema>> = {
+    readonly [Property in keyof T]: InsertableTreeFieldFromImplicitField<T[Property]>;
+};
+export declare function setField(field: FlexTreeField, simpleFieldSchema: FieldSchema, value: InsertableContent): void;
+type ObjectNodeSchema<TName extends string = string, T extends RestrictiveReadonlyRecord<string, ImplicitFieldSchema> = RestrictiveReadonlyRecord<string, ImplicitFieldSchema>, ImplicitlyConstructable extends boolean = boolean> = TreeNodeSchemaClass<TName, NodeKind.Object, TreeNode & WithType<TName>, InsertableObjectFromSchemaRecord<T>, ImplicitlyConstructable, T>;
+/**
+ * Define a {@link TreeNodeSchema} for a {@link TreeObjectNode}.
+ *
+ * @param name - Unique identifier for this schema within this factory's scope.
+ * @param fields - Schema for fields of the object node's schema. Defines what children can be placed under each key.
+ */
+export declare function objectSchema<TName extends string, const T extends RestrictiveReadonlyRecord<string, ImplicitFieldSchema>, const ImplicitlyConstructable extends boolean>(base: ObjectNodeSchema<TName, T, ImplicitlyConstructable>): TreeNodeSchemaClass<TName, NodeKind.Object, TreeObjectNode<T, TName>, object & InsertableObjectFromSchemaRecord<T>, true, T>;
+/**
+ * The implementation of an object node created by {@link createRawNode}.
+ */
+export declare class RawObjectNode<TSchema extends FlexObjectNodeSchema, TContent extends object> extends RawTreeNode<TSchema, TContent> implements FlexTreeObjectNode {
+    get localNodeKey(): LocalNodeKey | undefined;
+}
+export {};
+//# sourceMappingURL=objectNode.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"objectNode.d.ts","sourceRoot":"","sources":["../../src/simple-tree/objectNode.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAMH,OAAO,EAGN,oBAAoB,EACpB,aAAa,EAEb,kBAAkB,EAGlB,YAAY,EAEZ,MAAM,+BAA+B,CAAC;AACvC,OAAO,EACN,iBAAiB,EAIjB,MAAM,cAAc,CAAC;AAEtB,OAAO,EACN,QAAQ,EACR,mBAAmB,EACnB,mBAAmB,EACnB,QAAQ,EAIR,0BAA0B,EAC1B,oCAAoC,EACpC,WAAW,EAEX,MAAM,kBAAkB,CAAC;AAE1B,OAAO,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AACtC,OAAO,EAAE,yBAAyB,EAAQ,MAAM,kBAAkB,CAAC;AAEnE,OAAO,EAAE,WAAW,EAAY,MAAM,cAAc,CAAC;AAErD;;;GAGG;AACH,MAAM,MAAM,sBAAsB,CACjC,CAAC,SAAS,yBAAyB,CAAC,MAAM,EAAE,mBAAmB,CAAC,IAC7D;IACH,CAAC,UAAU,QAAQ,IAAI,MAAM,CAAC,GAAG,0BAA0B,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;CACxE,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,MAAM,cAAc,CACzB,CAAC,SAAS,yBAAyB,CAAC,MAAM,EAAE,mBAAmB,CAAC,EAChE,QAAQ,SAAS,MAAM,GAAG,MAAM,IAC7B,QAAQ,GAAG,sBAAsB,CAAC,CAAC,CAAC,GAAG,QAAQ,CAAC,QAAQ,CAAC,CAAC;AAE9D;;;;;;;;;;;;GAYG;AACH,MAAM,MAAM,gCAAgC,CAC3C,CAAC,SAAS,yBAAyB,CAAC,MAAM,EAAE,mBAAmB,CAAC,IAC7D;IACH,QAAQ,EAAE,QAAQ,IAAI,MAAM,CAAC,GAAG,oCAAoC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;CACjF,CAAC;AAgHF,wBAAgB,QAAQ,CACvB,KAAK,EAAE,aAAa,EACpB,iBAAiB,EAAE,WAAW,EAC9B,KAAK,EAAE,iBAAiB,GACtB,IAAI,CAiBN;AAED,KAAK,gBAAgB,CACpB,KAAK,SAAS,MAAM,GAAG,MAAM,EAC7B,CAAC,SAAS,yBAAyB,CAAC,MAAM,EAAE,mBAAmB,CAAC,GAAG,yBAAyB,CAC3F,MAAM,EACN,mBAAmB,CACnB,EACD,uBAAuB,SAAS,OAAO,GAAG,OAAO,IAC9C,mBAAmB,CACtB,KAAK,EACL,QAAQ,CAAC,MAAM,EACf,QAAQ,GAAG,QAAQ,CAAC,KAAK,CAAC,EAC1B,gCAAgC,CAAC,CAAC,CAAC,EACnC,uBAAuB,EACvB,CAAC,CACD,CAAC;AAEF;;;;;GAKG;AACH,wBAAgB,YAAY,CAC3B,KAAK,SAAS,MAAM,EACpB,KAAK,CAAC,CAAC,SAAS,yBAAyB,CAAC,MAAM,EAAE,mBAAmB,CAAC,EACtE,KAAK,CAAC,uBAAuB,SAAS,OAAO,EAC5C,IAAI,EAAE,gBAAgB,CAAC,KAAK,EAAE,CAAC,EAAE,uBAAuB,CAAC,gIAqG1D;AAID;;GAEG;AACH,qBAAa,aAAa,CAAC,OAAO,SAAS,oBAAoB,EAAE,QAAQ,SAAS,MAAM,CACvF,SAAQ,WAAW,CAAC,OAAO,EAAE,QAAQ,CACrC,YAAW,kBAAkB;IAE7B,IAAW,YAAY,IAAI,YAAY,GAAG,SAAS,CAElD;CACD"}