@fluidframework/tree 2.0.0-dev-rc.1.0.0.224419

package/dist/simple-tree/index.js

@@ -0,0 +1,17 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addFactory = exports.IterableTreeListContent = exports.TreeArrayNode = exports.TreeNode = exports.getProxyForField = void 0;
+var proxies_1 = require("./proxies");
+Object.defineProperty(exports, "getProxyForField", { enumerable: true, get: function () { return proxies_1.getProxyForField; } });
+var types_1 = require("./types");
+Object.defineProperty(exports, "TreeNode", { enumerable: true, get: function () { return types_1.TreeNode; } });
+var treeListNode_1 = require("./treeListNode");
+Object.defineProperty(exports, "TreeArrayNode", { enumerable: true, get: function () { return treeListNode_1.TreeArrayNode; } });
+Object.defineProperty(exports, "IterableTreeListContent", { enumerable: true, get: function () { return treeListNode_1.IterableTreeListContent; } });
+var objectFactory_1 = require("./objectFactory");
+Object.defineProperty(exports, "addFactory", { enumerable: true, get: function () { return objectFactory_1.addFactory; } });
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/simple-tree/index.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,qCAA6C;AAApC,2GAAA,gBAAgB,OAAA;AACzB,iCAYiB;AAJhB,iGAAA,QAAQ,OAAA;AAKT,+CAAyF;AAA/D,6GAAA,aAAa,OAAA;AAAE,uHAAA,uBAAuB,OAAA;AAChE,iDAAmF;AAApC,2GAAA,UAAU,OAAA","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nexport { getProxyForField } from \"./proxies\";\nexport {\n\tTreeObjectNodeFields,\n\tTreeField,\n\tTreeFieldInner,\n\tTypedNode,\n\tTreeNodeUnion,\n\tTreeMapNode,\n\tTreeObjectNode,\n\tTreeNode,\n\tUnhydrated,\n\tTreeArrayNodeBase,\n\tTreeMapNodeBase,\n} from \"./types\";\nexport { TreeListNodeOld, TreeArrayNode, IterableTreeListContent } from \"./treeListNode\";\nexport { TreeObjectFactory, FactoryTreeSchema, addFactory } from \"./objectFactory\";\nexport {\n\tInsertableTreeRoot,\n\tInsertableTreeField,\n\tInsertableTreeFieldInner,\n\tInsertableTreeNodeUnion,\n\tInsertableTreeObjectNode,\n\tInsertableTreeObjectNodeFields,\n\tInsertableTypedNode,\n} from \"./insertable\";\n"]}

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

@@ -0,0 +1,44 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { TreeValue } from "../core";
+import { RestrictiveReadonlyRecord } from "../util";
+import { FieldKind, FieldKinds, AllowedTypes, Any, FieldNodeSchema, TreeFieldSchema, InternalTypedSchemaTypes, LeafNodeSchema, MapNodeSchema, ObjectNodeSchema, TreeNodeSchema, FlexTreeSchema } from "../feature-libraries";
+/**
+ * Data from which a {@link TreeObjectNode} can be built.
+ */
+export type InsertableTreeObjectNode<TSchema extends ObjectNodeSchema> = InsertableTreeObjectNodeFields<TSchema["objectNodeFieldsObject"]>;
+/**
+ * Helper for generating the properties of a InsertableTreeObjectNode.
+ */
+export type InsertableTreeObjectNodeFields<TFields extends RestrictiveReadonlyRecord<string, TreeFieldSchema>> = {
+    readonly [key in keyof TFields]?: InsertableTreeField<TFields[key]>;
+} & {
+    readonly [key in keyof TFields as TFields[key]["kind"] extends typeof FieldKinds.optional ? never : key]-?: InsertableTreeField<TFields[key]>;
+};
+/**
+ * Data from which a {@link TreeField} can be built.
+ */
+export type InsertableTreeField<TSchema extends TreeFieldSchema = TreeFieldSchema> = InsertableTreeFieldInner<TSchema["kind"], TSchema["allowedTypes"]>;
+/**
+ * Helper for implementing InsertableTreeField.
+ */
+export type InsertableTreeFieldInner<Kind extends FieldKind, TTypes extends AllowedTypes> = Kind extends typeof FieldKinds.sequence ? never : Kind extends typeof FieldKinds.required ? InsertableTreeNodeUnion<TTypes> : Kind extends typeof FieldKinds.optional ? InsertableTreeNodeUnion<TTypes> | undefined : unknown;
+/**
+ * Given multiple node schema types, return the corresponding object type union from which the node could be built.
+ *
+ * If the types are ambagious, use the schema's factory to construct a unhydrated node instance with the desired type.
+ */
+export type InsertableTreeNodeUnion<TTypes extends AllowedTypes> = TTypes extends readonly [Any] ? unknown : {
+    [Index in keyof TTypes]: TTypes[Index] extends InternalTypedSchemaTypes.LazyItem<infer InnerType> ? InnerType extends TreeNodeSchema ? InsertableTypedNode<InnerType> : never : never;
+}[number];
+/**
+ * Given a node's schema, return the corresponding object from which the node could be built.
+ */
+export type InsertableTypedNode<TSchema extends TreeNodeSchema> = TSchema extends LeafNodeSchema ? TreeValue<TSchema["info"]> : TSchema extends MapNodeSchema ? ReadonlyMap<string, InsertableTreeField<TSchema["info"]>> : TSchema extends FieldNodeSchema ? readonly InsertableTreeNodeUnion<TSchema["info"]["allowedTypes"]>[] : TSchema extends ObjectNodeSchema ? InsertableTreeObjectNode<TSchema> : unknown;
+/**
+ * Data which can be built into an entire tree matching the provided schema.
+ */
+export type InsertableTreeRoot<TSchema extends FlexTreeSchema> = TSchema extends FlexTreeSchema<infer TRootFieldSchema> ? InsertableTreeField<TRootFieldSchema> : never;
+//# sourceMappingURL=insertable.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"insertable.d.ts","sourceRoot":"","sources":["../../src/simple-tree/insertable.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,SAAS,EAAE,MAAM,SAAS,CAAC;AACpC,OAAO,EAAE,yBAAyB,EAAE,MAAM,SAAS,CAAC;AACpD,OAAO,EACN,SAAS,EACT,UAAU,EACV,YAAY,EACZ,GAAG,EACH,eAAe,EACf,eAAe,EACf,wBAAwB,EACxB,cAAc,EACd,aAAa,EACb,gBAAgB,EAChB,cAAc,EACd,cAAc,EACd,MAAM,sBAAsB,CAAC;AAE9B;;GAEG;AACH,MAAM,MAAM,wBAAwB,CAAC,OAAO,SAAS,gBAAgB,IACpE,8BAA8B,CAAC,OAAO,CAAC,wBAAwB,CAAC,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,8BAA8B,CACzC,OAAO,SAAS,yBAAyB,CAAC,MAAM,EAAE,eAAe,CAAC,IAC/D;IAEH,QAAQ,EAAE,GAAG,IAAI,MAAM,OAAO,CAAC,CAAC,EAAE,mBAAmB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;CACnE,GAAG;IAEH,QAAQ,EAAE,GAAG,IAAI,MAAM,OAAO,IAAI,OAAO,CAAC,GAAG,CAAC,CAAC,MAAM,CAAC,SAAS,OAAO,UAAU,CAAC,QAAQ,GACtF,KAAK,GACL,GAAG,CAAC,CAAC,GAAG,mBAAmB,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;CAC5C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAAC,OAAO,SAAS,eAAe,GAAG,eAAe,IAChF,wBAAwB,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,OAAO,CAAC,cAAc,CAAC,CAAC,CAAC;AAEpE;;GAEG;AACH,MAAM,MAAM,wBAAwB,CACnC,IAAI,SAAS,SAAS,EACtB,MAAM,SAAS,YAAY,IACxB,IAAI,SAAS,OAAO,UAAU,CAAC,QAAQ,GACxC,KAAK,GACL,IAAI,SAAS,OAAO,UAAU,CAAC,QAAQ,GACvC,uBAAuB,CAAC,MAAM,CAAC,GAC/B,IAAI,SAAS,OAAO,UAAU,CAAC,QAAQ,GACvC,uBAAuB,CAAC,MAAM,CAAC,GAAG,SAAS,GAC3C,OAAO,CAAC;AAEX;;;;GAIG;AACH,MAAM,MAAM,uBAAuB,CAAC,MAAM,SAAS,YAAY,IAAI,MAAM,SAAS,SAAS,CAAC,GAAG,CAAC,GAC7F,OAAO,GACP;KAIC,KAAK,IAAI,MAAM,MAAM,GAAG,MAAM,CAAC,KAAK,CAAC,SAAS,wBAAwB,CAAC,QAAQ,CAC/E,MAAM,SAAS,CACf,GACE,SAAS,SAAS,cAAc,GAC/B,mBAAmB,CAAC,SAAS,CAAC,GAC9B,KAAK,GACN,KAAK;CACP,CAAC,MAAM,CAAC,CAAC;AAEb;;GAEG;AACH,MAAM,MAAM,mBAAmB,CAAC,OAAO,SAAS,cAAc,IAAI,OAAO,SAAS,cAAc,GAC7F,SAAS,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,GAC1B,OAAO,SAAS,aAAa,GAC7B,WAAW,CAAC,MAAM,EAAE,mBAAmB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,GACzD,OAAO,SAAS,eAAe,GAC/B,SAAS,uBAAuB,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,cAAc,CAAC,CAAC,EAAE,GACnE,OAAO,SAAS,gBAAgB,GAChC,wBAAwB,CAAC,OAAO,CAAC,GAGjC,OAAO,CAAC;AAEX;;GAEG;AACH,MAAM,MAAM,kBAAkB,CAAC,OAAO,SAAS,cAAc,IAAI,OAAO,SAAS,cAAc,CAC9F,MAAM,gBAAgB,CACtB,GACE,mBAAmB,CAAC,gBAAgB,CAAC,GACrC,KAAK,CAAC"}

package/dist/simple-tree/insertable.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"insertable.js","sourceRoot":"","sources":["../../src/simple-tree/insertable.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 { TreeValue } from \"../core\";\nimport { RestrictiveReadonlyRecord } from \"../util\";\nimport {\n\tFieldKind,\n\tFieldKinds,\n\tAllowedTypes,\n\tAny,\n\tFieldNodeSchema,\n\tTreeFieldSchema,\n\tInternalTypedSchemaTypes,\n\tLeafNodeSchema,\n\tMapNodeSchema,\n\tObjectNodeSchema,\n\tTreeNodeSchema,\n\tFlexTreeSchema,\n} from \"../feature-libraries\";\n\n/**\n * Data from which a {@link TreeObjectNode} can be built.\n */\nexport type InsertableTreeObjectNode<TSchema extends ObjectNodeSchema> =\n\tInsertableTreeObjectNodeFields<TSchema[\"objectNodeFieldsObject\"]>;\n\n/**\n * Helper for generating the properties of a InsertableTreeObjectNode.\n */\nexport type InsertableTreeObjectNodeFields<\n\tTFields extends RestrictiveReadonlyRecord<string, TreeFieldSchema>,\n> = {\n\t// Make all properties optional.\n\treadonly [key in keyof TFields]?: InsertableTreeField<TFields[key]>;\n} & {\n\t// Require non-optional.\n\treadonly [key in keyof TFields as TFields[key][\"kind\"] extends typeof FieldKinds.optional\n\t\t? never\n\t\t: key]-?: InsertableTreeField<TFields[key]>;\n};\n\n/**\n * Data from which a {@link TreeField} can be built.\n */\nexport type InsertableTreeField<TSchema extends TreeFieldSchema = TreeFieldSchema> =\n\tInsertableTreeFieldInner<TSchema[\"kind\"], TSchema[\"allowedTypes\"]>;\n\n/**\n * Helper for implementing InsertableTreeField.\n */\nexport type InsertableTreeFieldInner<\n\tKind extends FieldKind,\n\tTTypes extends AllowedTypes,\n> = Kind extends typeof FieldKinds.sequence\n\t? never // Sequences are only supported underneath FieldNodes. See FieldNode case in `ProxyNode`.\n\t: Kind extends typeof FieldKinds.required\n\t? InsertableTreeNodeUnion<TTypes>\n\t: Kind extends typeof FieldKinds.optional\n\t? InsertableTreeNodeUnion<TTypes> | undefined\n\t: unknown;\n\n/**\n * Given multiple node schema types, return the corresponding object type union from which the node could be built.\n *\n * If the types are ambagious, use the schema's factory to construct a unhydrated node instance with the desired type.\n */\nexport type InsertableTreeNodeUnion<TTypes extends AllowedTypes> = TTypes extends readonly [Any]\n\t? unknown\n\t: {\n\t\t\t// TODO: Is the the best way to write this type function? Can it be simplified?\n\t\t\t// This first maps the tuple of AllowedTypes to a tuple of node API types.\n\t\t\t// Then, it uses [number] to index arbitrarily into that tuple, effectively converting the type tuple into a type union.\n\t\t\t[Index in keyof TTypes]: TTypes[Index] extends InternalTypedSchemaTypes.LazyItem<\n\t\t\t\tinfer InnerType\n\t\t\t>\n\t\t\t\t? InnerType extends TreeNodeSchema\n\t\t\t\t\t? InsertableTypedNode<InnerType>\n\t\t\t\t\t: never\n\t\t\t\t: never;\n\t  }[number];\n\n/**\n * Given a node's schema, return the corresponding object from which the node could be built.\n */\nexport type InsertableTypedNode<TSchema extends TreeNodeSchema> = TSchema extends LeafNodeSchema\n\t? TreeValue<TSchema[\"info\"]>\n\t: TSchema extends MapNodeSchema\n\t? ReadonlyMap<string, InsertableTreeField<TSchema[\"info\"]>>\n\t: TSchema extends FieldNodeSchema\n\t? readonly InsertableTreeNodeUnion<TSchema[\"info\"][\"allowedTypes\"]>[]\n\t: TSchema extends ObjectNodeSchema\n\t? InsertableTreeObjectNode<TSchema>\n\t: // TODO: This should be `never` not `unknown` since this type is used as input, and thus should not fallback to unknown when the types are not specific enough.\n\t  // As is, this use of `unknown` causes `InsertableTypedNode<TreeNodeSchema>` to just be `unknown` which makes some code much less type safe than it should be.\n\t  unknown;\n\n/**\n * Data which can be built into an entire tree matching the provided schema.\n */\nexport type InsertableTreeRoot<TSchema extends FlexTreeSchema> = TSchema extends FlexTreeSchema<\n\tinfer TRootFieldSchema\n>\n\t? InsertableTreeField<TRootFieldSchema>\n\t: never;\n"]}

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

@@ -0,0 +1,30 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { Assume } from "../util";
+import { ObjectNodeSchema, TreeNodeSchemaBase } from "../feature-libraries";
+import { TreeObjectNode } from "./types";
+import { InsertableTypedNode } from "./insertable";
+/**
+ * Adds a factory function (`create`) to the given schema so that it satisfies the {@link TreeObjectFactory} interface.
+ */
+export declare function addFactory<TSchema extends ObjectNodeSchema<string, any>>(schema: TSchema): FactoryTreeSchema<TSchema>;
+/**
+ * Creates `{@link TreeObjectNode}`s of the given schema type via a `create` method.
+ */
+export interface TreeObjectFactory<TSchema extends TreeNodeSchemaBase> {
+    /**
+     * Create a {@link TreeObjectNode} that can be inserted into the tree via assignment `=`.
+     * @param content - the data making up the {@link TreeObjectNode} to be created.
+     * @remarks
+     * The {@link TreeObjectNode} created by this function may _only_ be used for insertion into the tree.
+     * It may not be read, mutated or queried in any way.
+     */
+    create(content: InsertableTypedNode<Assume<TSchema, ObjectNodeSchema>>): TreeObjectNode<Assume<TSchema, ObjectNodeSchema>>;
+}
+/**
+ * A {@link TreeNodeSchema} which is also a {@link TreeObjectFactory}.
+ */
+export type FactoryTreeSchema<TSchema extends TreeNodeSchemaBase> = TSchema & TreeObjectFactory<TSchema>;
+//# sourceMappingURL=objectFactory.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"objectFactory.d.ts","sourceRoot":"","sources":["../../src/simple-tree/objectFactory.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,SAAS,CAAC;AACjC,OAAO,EAAE,gBAAgB,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAE5E,OAAO,EAAE,cAAc,EAAE,MAAM,SAAS,CAAC;AACzC,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAEnD;;GAEG;AACH,wBAAgB,UAAU,CAAC,OAAO,SAAS,gBAAgB,CAAC,MAAM,EAAE,GAAG,CAAC,EACvE,MAAM,EAAE,OAAO,GACb,iBAAiB,CAAC,OAAO,CAAC,CAO5B;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB,CAAC,OAAO,SAAS,kBAAkB;IACpE;;;;;;OAMG;IACH,MAAM,CACL,OAAO,EAAE,mBAAmB,CAAC,MAAM,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC,GAC7D,cAAc,CAAC,MAAM,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC,CAAC;CACrD;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,CAAC,OAAO,SAAS,kBAAkB,IAAI,OAAO,GAC1E,iBAAiB,CAAC,OAAO,CAAC,CAAC"}

package/dist/simple-tree/objectFactory.js

@@ -0,0 +1,20 @@
+"use strict";
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.addFactory = void 0;
+const proxies_1 = require("./proxies");
+/**
+ * Adds a factory function (`create`) to the given schema so that it satisfies the {@link TreeObjectFactory} interface.
+ */
+function addFactory(schema) {
+    return Object.defineProperty(schema, "create", {
+        value: (content) => (0, proxies_1.createRawNodeProxy)(schema, content, false),
+        configurable: true,
+        enumerable: true,
+    });
+}
+exports.addFactory = addFactory;
+//# sourceMappingURL=objectFactory.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"objectFactory.js","sourceRoot":"","sources":["../../src/simple-tree/objectFactory.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAIH,uCAA+C;AAI/C;;GAEG;AACH,SAAgB,UAAU,CACzB,MAAe;IAEf,OAAO,MAAM,CAAC,cAAc,CAAC,MAAM,EAAE,QAAQ,EAAE;QAC9C,KAAK,EAAE,CAAC,OAAqC,EAA2B,EAAE,CACzE,IAAA,4BAAkB,EAAC,MAAM,EAAE,OAAO,EAAE,KAAK,CAAC;QAC3C,YAAY,EAAE,IAAI;QAClB,UAAU,EAAE,IAAI;KAChB,CAA+B,CAAC;AAClC,CAAC;AATD,gCASC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { Assume } from \"../util\";\nimport { ObjectNodeSchema, TreeNodeSchemaBase } from \"../feature-libraries\";\nimport { createRawNodeProxy } from \"./proxies\";\nimport { TreeObjectNode } from \"./types\";\nimport { InsertableTypedNode } from \"./insertable\";\n\n/**\n * Adds a factory function (`create`) to the given schema so that it satisfies the {@link TreeObjectFactory} interface.\n */\nexport function addFactory<TSchema extends ObjectNodeSchema<string, any>>(\n\tschema: TSchema,\n): FactoryTreeSchema<TSchema> {\n\treturn Object.defineProperty(schema, \"create\", {\n\t\tvalue: (content: InsertableTypedNode<TSchema>): TreeObjectNode<TSchema> =>\n\t\t\tcreateRawNodeProxy(schema, content, false),\n\t\tconfigurable: true,\n\t\tenumerable: true,\n\t}) as FactoryTreeSchema<TSchema>;\n}\n\n/**\n * Creates `{@link TreeObjectNode}`s of the given schema type via a `create` method.\n */\nexport interface TreeObjectFactory<TSchema extends TreeNodeSchemaBase> {\n\t/**\n\t * Create a {@link TreeObjectNode} that can be inserted into the tree via assignment `=`.\n\t * @param content - the data making up the {@link TreeObjectNode} to be created.\n\t * @remarks\n\t * The {@link TreeObjectNode} created by this function may _only_ be used for insertion into the tree.\n\t * It may not be read, mutated or queried in any way.\n\t */\n\tcreate(\n\t\tcontent: InsertableTypedNode<Assume<TSchema, ObjectNodeSchema>>,\n\t): TreeObjectNode<Assume<TSchema, ObjectNodeSchema>>;\n}\n\n/**\n * A {@link TreeNodeSchema} which is also a {@link TreeObjectFactory}.\n */\nexport type FactoryTreeSchema<TSchema extends TreeNodeSchemaBase> = TSchema &\n\tTreeObjectFactory<TSchema>;\n"]}

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

@@ -0,0 +1,112 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { IFluidHandle } from "@fluidframework/core-interfaces";
+import { AllowedTypes, TreeFieldSchema, ObjectNodeSchema, TreeNodeSchema, MapNodeSchema, FieldNodeSchema, FlexTreeSequenceField, FlexTreeNode, FlexTreeTypedField } from "../feature-libraries";
+import { type TreeNodeSchema as TreeNodeSchemaClass } from "../class-tree";
+import { TreeListNodeOld } from "./treeListNode";
+import { TreeField, TypedNode, TreeMapNode, TreeObjectNode, Unhydrated, TreeNode } from "./types";
+import { InsertableTypedNode } from "./insertable";
+/** Retrieve the associated proxy for the given field. */
+export declare function getProxyForField<TSchema extends TreeFieldSchema>(field: FlexTreeTypedField<TSchema>): TreeField<TSchema>;
+/**
+ * A symbol for storing TreeNodeSchemaClass on FlexTreeNode's schema.
+ */
+export declare const simpleSchemaSymbol: unique symbol;
+export declare function getClassSchema(schema: TreeNodeSchema): TreeNodeSchemaClass | undefined;
+export declare function getOrCreateNodeProxy<TSchema extends TreeNodeSchema>(flexNode: FlexTreeNode): TypedNode<TSchema>;
+/**
+ * @param flexNode - underlying tree node which this proxy should wrap.
+ * @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 an empty collection of the relevant type is used for the target and a separate object created to dispatch methods.
+ * If provided, the customTargetObject will be used as both the dispatch object and the proxy target, and therefor must provide needed functionality depending on the schema kind.
+ */
+export declare function createNodeProxy<TSchema extends TreeNodeSchema>(flexNode: FlexTreeNode, allowAdditionalProperties: boolean, targetObject?: object): TypedNode<TSchema>;
+/**
+ * @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 `{}` is used for the target.
+ */
+export declare function createObjectProxy<TSchema extends ObjectNodeSchema>(schema: TSchema, allowAdditionalProperties: boolean, targetObject?: object): TreeObjectNode<TSchema>;
+/**
+ * Given a list proxy, returns its underlying LazySequence field.
+ */
+export declare const getSequenceField: <TTypes extends AllowedTypes>(list: TreeListNodeOld) => FlexTreeSequenceField<TTypes>;
+/**
+ * PropertyDescriptorMap used to build the prototype for our SharedListNode dispatch object.
+ */
+export declare const listPrototypeProperties: PropertyDescriptorMap;
+export declare const mapStaticDispatchMap: PropertyDescriptorMap;
+/**
+ * Create a proxy to a {@link TreeObjectNode} that is backed by a raw object node (see {@link createRawNode}).
+ * @param schema - the schema of the object node
+ * @param content - the content to be stored in the raw node.
+ * A copy of content is stored, the input `content` is not modified and can be safely reused in another call to {@link createRawObjectProxy}.
+ * @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 `{}` is used for the target.
+ * @remarks
+ * Because this proxy is backed by a raw node, it has the same limitations as the node created by {@link createRawNode}.
+ * Most of its properties and methods will error if read/called.
+ */
+export declare function createRawNodeProxy<TSchema extends ObjectNodeSchema>(schema: TSchema, content: InsertableTypedNode<TSchema>, allowAdditionalProperties: boolean, target?: object): Unhydrated<TreeObjectNode<TSchema>>;
+export declare function createRawNodeProxy<TSchema extends FieldNodeSchema>(schema: TSchema, content: InsertableTypedNode<TSchema>, allowAdditionalProperties: boolean, target?: object): Unhydrated<TreeListNodeOld<TSchema["info"]["allowedTypes"]>>;
+export declare function createRawNodeProxy<TSchema extends MapNodeSchema>(schema: TSchema, content: InsertableTypedNode<TSchema>, allowAdditionalProperties: boolean, target?: object): Unhydrated<TreeMapNode<TSchema>>;
+type ProxyHydrator = (flexNode: FlexTreeNode | undefined) => void;
+/** The result returned by {@link extractFactoryContent} and its related helpers. */
+interface ExtractedFactoryContent<out T = FactoryContent> {
+    /** The content with the factory subtrees replaced. */
+    readonly content: T;
+    /**
+     * A function which walks all factory-created object that underwent replacement/extraction.
+     * Before hydration, those objects are unusable (see {@link createRawObjectProxy}).
+     * However, after the content is fully inserted into the tree the `hydrateProxies` function may be invoked in order to update the contents of these objects such that they become a mirror of the content in the tree.
+     * This must be done before any calls to {@link getOrCreateNodeProxy} so that the "edit node to proxy" mapping is correctly updated (see {@link setFlexNode}).
+     */
+    readonly hydrateProxies: ProxyHydrator;
+}
+/**
+ * Given a content tree that is to be inserted into the shared tree, replace all subtrees that were created by factories
+ * (via {@link SharedTreeObjectFactory.create}) with the content that was passed to those factories.
+ * @param content - the content being inserted which may be, and/or may contain, factory-created content
+ * @param insertedAtIndex - if the content being inserted is list content, this must be the index in the list at which the content is being inserted
+ * @returns the result of the content replacement and a {@link ExtractedFactoryContent.hydrateProxies} function which must be invoked if present.
+ * @remarks
+ * This functions works recursively.
+ * Factory-created objects that are nested inside of the content passed to other factory-created objects, and so on, will be in-lined.
+ * This function also adds the hidden {@link typeNameSymbol} of each object schema to the output.
+ * @example
+ * ```ts
+ * const x = foo.create({
+ *   a: 3, b: bar.create({
+ *     c: [baz.create({ d: 5 })]
+ *   })
+ * });
+ * const y = extractFactoryContent(x);
+ * y === {
+ *   [typeNameSymbol]: "foo", a: 3, b: {
+ *     [typeNameSymbol]: "bar", c: [{ [typeNameSymbol]: "baz", d: 5 }]
+ *  }
+ * }
+ * ```
+ */
+export declare function extractFactoryContent(input: InsertableContent, insertedAtIndex?: number): ExtractedFactoryContent;
+/**
+ * Content which can be used to build a node.
+ * @remarks
+ * Can contain unhydrated nodes, but can not be an unhydrated node at the root.
+ */
+export type FactoryContent = IFluidHandle | string | number | boolean | null | ReadonlyMap<string, InsertableContent> | readonly InsertableContent[] | {
+    readonly [P in string]?: InsertableContent;
+};
+/**
+ * Content which can be inserted into a tree.
+ */
+export type InsertableContent = Unhydrated<TreeNode> | FactoryContent;
+export {};
+//# sourceMappingURL=proxies.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"proxies.d.ts","sourceRoot":"","sources":["../../src/simple-tree/proxies.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAGH,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAE/D,OAAO,EACN,YAAY,EACZ,eAAe,EACf,gBAAgB,EAChB,cAAc,EAKd,aAAa,EACb,eAAe,EAOf,qBAAqB,EACrB,YAAY,EACZ,kBAAkB,EAKlB,MAAM,sBAAsB,CAAC;AAK9B,OAAO,EAAE,KAAK,cAAc,IAAI,mBAAmB,EAAE,MAAM,eAAe,CAAC;AAG3E,OAAO,EAA2B,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAC1E,OAAO,EAAE,SAAS,EAAE,SAAS,EAAE,WAAW,EAAE,cAAc,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAElG,OAAO,EAA2B,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAI5E,yDAAyD;AACzD,wBAAgB,gBAAgB,CAAC,OAAO,SAAS,eAAe,EAC/D,KAAK,EAAE,kBAAkB,CAAC,OAAO,CAAC,GAChC,SAAS,CAAC,OAAO,CAAC,CAsCpB;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,EAAE,OAAO,MAA+B,CAAC;AAExE,wBAAgB,cAAc,CAAC,MAAM,EAAE,cAAc,GAAG,mBAAmB,GAAG,SAAS,CAKtF;AAED,wBAAgB,oBAAoB,CAAC,OAAO,SAAS,cAAc,EAClE,QAAQ,EAAE,YAAY,GACpB,SAAS,CAAC,OAAO,CAAC,CA0BpB;AAED;;;;;;;GAOG;AACH,wBAAgB,eAAe,CAAC,OAAO,SAAS,cAAc,EAC7D,QAAQ,EAAE,YAAY,EACtB,yBAAyB,EAAE,OAAO,EAClC,YAAY,CAAC,EAAE,MAAM,GACnB,SAAS,CAAC,OAAO,CAAC,CAqBpB;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,CAAC,OAAO,SAAS,gBAAgB,EACjE,MAAM,EAAE,OAAO,EACf,yBAAyB,EAAE,OAAO,EAClC,YAAY,GAAE,MAAW,GACvB,cAAc,CAAC,OAAO,CAAC,CA8FzB;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB,sCAAuC,eAAe,kCACxB,CAAC;AAoB5D;;GAEG;AACH,eAAO,MAAM,uBAAuB,EAAE,qBAwLrC,CAAC;AA8LF,eAAO,MAAM,oBAAoB,EAAE,qBA0ElC,CAAC;AAqDF;;;;;;;;;;;;GAYG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,SAAS,gBAAgB,EAClE,MAAM,EAAE,OAAO,EACf,OAAO,EAAE,mBAAmB,CAAC,OAAO,CAAC,EACrC,yBAAyB,EAAE,OAAO,EAClC,MAAM,CAAC,EAAE,MAAM,GACb,UAAU,CAAC,cAAc,CAAC,OAAO,CAAC,CAAC,CAAC;AACvC,wBAAgB,kBAAkB,CAAC,OAAO,SAAS,eAAe,EACjE,MAAM,EAAE,OAAO,EACf,OAAO,EAAE,mBAAmB,CAAC,OAAO,CAAC,EACrC,yBAAyB,EAAE,OAAO,EAClC,MAAM,CAAC,EAAE,MAAM,GACb,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;AAChE,wBAAgB,kBAAkB,CAAC,OAAO,SAAS,aAAa,EAC/D,MAAM,EAAE,OAAO,EACf,OAAO,EAAE,mBAAmB,CAAC,OAAO,CAAC,EACrC,yBAAyB,EAAE,OAAO,EAClC,MAAM,CAAC,EAAE,MAAM,GACb,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;AAyCpC,KAAK,aAAa,GAAG,CAAC,QAAQ,EAAE,YAAY,GAAG,SAAS,KAAK,IAAI,CAAC;AAGlE,oFAAoF;AACpF,UAAU,uBAAuB,CAAC,GAAG,CAAC,CAAC,GAAG,cAAc;IACvD,sDAAsD;IACtD,QAAQ,CAAC,OAAO,EAAE,CAAC,CAAC;IACpB;;;;;OAKG;IACH,QAAQ,CAAC,cAAc,EAAE,aAAa,CAAC;CACvC;AAED;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,qBAAqB,CACpC,KAAK,EAAE,iBAAiB,EACxB,eAAe,SAAI,GACjB,uBAAuB,CAyDzB;AA8GD;;;;GAIG;AACH,MAAM,MAAM,cAAc,GACvB,YAAY,GACZ,MAAM,GACN,MAAM,GACN,OAAO,GAEP,IAAI,GACJ,WAAW,CAAC,MAAM,EAAE,iBAAiB,CAAC,GACtC,SAAS,iBAAiB,EAAE,GAC5B;IACA,QAAQ,EAAE,CAAC,IAAI,MAAM,CAAC,CAAC,EAAE,iBAAiB;CACzC,CAAC;AAEL;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,UAAU,CAAC,QAAQ,CAAC,GAAG,cAAc,CAAC"}