@fluidframework/tree-agent 2.70.0-360374 → 2.70.0-361092

package/src/agent.ts

@@ -17,7 +17,15 @@ import type {
 } from "@fluidframework/tree/alpha";
 import { ObjectNodeSchema, Tree } from "@fluidframework/tree/alpha";
 
-import type { SharedTreeChatModel, EditResult, SemanticAgentOptions, Logger } from "./api.js";
+import type {
+	SharedTreeChatModel,
+	EditResult,
+	SemanticAgentOptions,
+	Logger,
+	SynchronousEditor,
+	AsynchronousEditor,
+	Context,
+} from "./api.js";
 import { getPrompt, stringifyTree } from "./prompt.js";
 import { Subtree } from "./subtree.js";
 import {
@@ -137,8 +145,7 @@ export class SharedTreeSemanticAgent<TSchema extends ImplicitFieldSchema> {
 			const editResult = await applyTreeFunction(
 				queryTree,
 				editCode,
-				this.options?.validateEdit ?? defaultValidateEdit,
-				this.options?.executeEdit ?? defaultExecuteEdit,
+				this.options?.editor ?? defaultEditor,
 				this.options?.logger,
 			);
 
@@ -199,51 +206,23 @@ function constructTreeNode(schema: TreeNodeSchema, value: FactoryContentObject):
 async function applyTreeFunction<TSchema extends ImplicitFieldSchema>(
 	tree: Subtree<TSchema>,
 	editCode: string,
-	validateEdit: Required<SemanticAgentOptions>["validateEdit"],
-	executeEdit: Required<SemanticAgentOptions>["executeEdit"],
+	editor: Required<SemanticAgentOptions>["editor"],
 	logger: Logger | undefined,
 ): Promise<EditResult> {
 	logger?.log(`### Editing Tool Invoked\n\n`);
 	logger?.log(`#### Generated Code\n\n\`\`\`javascript\n${editCode}\n\`\`\`\n\n`);
 
-	try {
-		await validateEdit(editCode);
-	} catch (error: unknown) {
-		logger?.log(`#### Code Validation Failed\n\n`);
-		logger?.log(`\`\`\`JSON\n${toErrorString(error)}\n\`\`\`\n\n`);
-		return {
-			type: "validationError",
-			message: `The generated code did not pass validation: ${toErrorString(error)}`,
-		};
-	}
-
-	// Stick the tree schema constructors on an object passed to the function so that the LLM can create new nodes.
-	const create: Record<string, (input: FactoryContentObject) => TreeNode> = {};
-	for (const schema of findNamedSchemas(tree.schema)) {
-		const name = getFriendlyName(schema);
-		create[name] = (input: FactoryContentObject) => constructTreeNode(schema, input);
-	}
-
 	// Fork a branch to edit. If the edit fails or produces an error, we discard this branch, otherwise we merge it.
 	const editTree = tree.fork();
-	const context = {
-		get root(): ReadableField<TSchema> {
-			return editTree.field;
-		},
-		set root(value: TreeFieldFromImplicitField<ReadSchema<TSchema>>) {
-			editTree.field = value;
-		},
-		create,
-	};
-
+	const boundEditor = bindEditorToSubtree(editTree, editor);
 	try {
-		await executeEdit(context, editCode);
+		await boundEditor(editCode);
 	} catch (error: unknown) {
 		logger?.log(`#### Error\n\n`);
 		logger?.log(`\`\`\`JSON\n${toErrorString(error)}\n\`\`\`\n\n`);
 		editTree.branch.dispose();
 		return {
-			type: "executionError",
+			type: "editingError",
 			message: `Running the generated code produced an error. The state of the tree will be reset to its previous state as it was before the code ran. Please try again. Here is the error: ${toErrorString(error)}`,
 		};
 	}
@@ -257,13 +236,87 @@ async function applyTreeFunction<TSchema extends ImplicitFieldSchema>(
 	};
 }
 
-const defaultValidateEdit: Required<SemanticAgentOptions>["validateEdit"] = () => {};
-
-const defaultExecuteEdit: Required<SemanticAgentOptions>["executeEdit"] = async (
-	context,
-	code,
-) => {
+/**
+ * The default {@link AsynchronousEditor | editor} implementation that simply uses `new Function` to run the provided code.
+ * @remarks This editor allows both synchronous and asynchronous code (i.e. the provided code may return a Promise).
+ * @example `await new Function("context", code)(context);`
+ * @alpha
+ */
+export const defaultEditor: AsynchronousEditor = async (context, code) => {
 	// eslint-disable-next-line no-new-func, @typescript-eslint/no-implied-eval
 	const fn = new Function("context", code);
 	await fn(context);
 };
+
+/**
+ * Binds the given {@link AsynchronousEditor | editor} to the given view or tree.
+ * @returns A function that takes a string of JavaScript code and executes it on the given view or tree using the given editor function.
+ * @remarks This is useful for testing/debugging code execution without needing to set up a full {@link SharedTreeSemanticAgent | agent}.
+ * @alpha
+ */
+export function bindEditorImpl<TSchema extends ImplicitFieldSchema>(
+	tree: TreeView<TSchema> | (ReadableField<TSchema> & TreeNode),
+	editor: AsynchronousEditor,
+): (code: string) => Promise<void>;
+/**
+ * Binds the given {@link SynchronousEditor | editor} to the given view or tree.
+ * @returns A function that takes a string of JavaScript code and executes it on the given view or tree using the given editor function.
+ * @remarks This is useful for testing/debugging code execution without needing to set up a full {@link SharedTreeSemanticAgent | agent}.
+ * @alpha
+ */
+export function bindEditorImpl<TSchema extends ImplicitFieldSchema>(
+	tree: TreeView<TSchema> | (ReadableField<TSchema> & TreeNode),
+	editor: SynchronousEditor,
+): (code: string) => void;
+/**
+ * Binds the given {@link SynchronousEditor | editor} or {@link AsynchronousEditor | editor} to the given view or tree.
+ * @returns A function that takes a string of JavaScript code and executes it on the given view or tree using the given editor function.
+ * @remarks This is useful for testing/debugging code execution without needing to set up a full {@link SharedTreeSemanticAgent | agent}.
+ * @alpha
+ */
+export function bindEditorImpl<TSchema extends ImplicitFieldSchema>(
+	tree: TreeView<TSchema> | (ReadableField<TSchema> & TreeNode),
+	editor: SynchronousEditor | AsynchronousEditor,
+): ((code: string) => void) | ((code: string) => Promise<void>) {
+	const subtree = new Subtree(tree);
+	return bindEditorToSubtree(subtree, editor);
+}
+
+/**
+ * Binds the given {@link SynchronousEditor | synchronous} or {@link AsynchronousEditor | asynchronous} editor to the given view or tree.
+ * @returns A function that takes a string of JavaScript code and executes it on the given view or tree using the given editor.
+ * @remarks This is useful for testing/debugging code execution without needing to set up a full {@link SharedTreeSemanticAgent | agent}.
+ * @alpha
+ * @privateRemarks This exists (as opposed to just exporting bindEditorImpl directly) so that API documentation links work correctly.
+ */
+export const bindEditor = bindEditorImpl;
+
+function bindEditorToSubtree<TSchema extends ImplicitFieldSchema>(
+	tree: Subtree<TSchema>,
+	executeEdit: SynchronousEditor | AsynchronousEditor,
+): (code: string) => void | Promise<void> {
+	// Stick the tree schema constructors on an object passed to the function so that the LLM can create new nodes.
+	const create: Record<string, (input: FactoryContentObject) => TreeNode> = {};
+	const is: Record<string, <T extends TreeNode>(input: unknown) => input is T> = {};
+	for (const schema of findNamedSchemas(tree.schema)) {
+		const name = getFriendlyName(schema);
+		create[name] = (input: FactoryContentObject) => constructTreeNode(schema, input);
+		is[name] = <T extends TreeNode>(input: unknown): input is T => Tree.is(input, schema);
+	}
+
+	const context = {
+		get root(): ReadableField<TSchema> {
+			return tree.field;
+		},
+		set root(value: TreeFieldFromImplicitField<ReadSchema<TSchema>>) {
+			tree.field = value;
+		},
+		create,
+		is,
+		parent: (child: TreeNode): TreeNode | undefined => Tree.parent(child),
+		key: (child: TreeNode): string | number => Tree.key(child),
+	} satisfies Context<TSchema>;
+
+	// eslint-disable-next-line @typescript-eslint/promise-function-async
+	return (code: string) => executeEdit(context, code);
+}

package/src/api.ts

@@ -4,9 +4,13 @@
  */
 
 import type { ImplicitFieldSchema, TreeNode } from "@fluidframework/tree";
-// This is used for doc links
+// These are used for doc links
 import type { FactoryContentObject, ReadableField } from "@fluidframework/tree/alpha";
 
+// This is used for doc links
+// eslint-disable-next-line unused-imports/no-unused-imports
+import type { bindEditor, defaultEditor } from "./agent.js";
+
 /**
  * Logger interface for logging events from a {@link SharedTreeSemanticAgent}.
  * @alpha
@@ -18,6 +22,91 @@ export interface Logger {
 	log(message: string): void;
 }
 
+/**
+ * The context object available to generated code when editing a tree.
+ * @remarks This object is provided to JavaScript code executed by the {@link SynchronousEditor | editor} as a variable named `context`.
+ * It contains the current state of the tree and utilities for creating and inspecting tree nodes.
+ * @alpha
+ */
+export interface Context<TSchema extends ImplicitFieldSchema> {
+	/**
+	 * The root of the tree that can be read or modified.
+	 * @remarks
+	 * You can read properties and navigate through the tree starting from this root.
+	 * You can also assign a new value to this property to replace the entire tree, as long as the new value is one of the types allowed at the root.
+	 *
+	 * Example: Read the current root with `const currentRoot = context.root;`
+	 *
+	 * Example: Replace the entire root with `context.root = context.create.MyRootType({ });`
+	 */
+	root: ReadableField<TSchema>;
+
+	/**
+	 * A collection of builder functions for creating new tree nodes.
+	 * @remarks
+	 * Each property on this object is named after a type in the tree schema.
+	 * Call the corresponding function to create a new node of that type.
+	 * Always use these builder functions when creating new nodes rather than plain JavaScript objects.
+	 *
+	 * Example: Create a new Person node with `context.create.Person({ name: "Alice", age: 30 })`
+	 *
+	 * Example: Create a new Task node with `context.create.Task({ title: "Buy groceries", completed: false })`
+	 */
+	create: Record<string, (input: FactoryContentObject) => TreeNode>;
+
+	/**
+	 * A collection of type-checking functions for tree nodes.
+	 * @remarks
+	 * Each property on this object is named after a type in the tree schema.
+	 * Call the corresponding function to check if a node is of that specific type.
+	 * This is useful when working with nodes that could be one of multiple types.
+	 *
+	 * Example: Check if a node is a Person with `if (context.is.Person(node)) { console.log(node.name); }`
+	 */
+	is: Record<string, <T extends TreeNode>(input: T) => input is T>;
+
+	/**
+	 * Returns the parent node of the given child node.
+	 * @param child - The node whose parent you want to find.
+	 * @returns The parent node, or `undefined` if the node is the root or is not in the tree.
+	 * @remarks
+	 * Example: Get the parent with `const parent = context.parent(childNode);`
+	 */
+	parent(child: TreeNode): TreeNode | undefined;
+
+	/**
+	 * Returns the key or index of the given node within its parent.
+	 * @param child - The node whose key you want to find.
+	 * @returns A string key if the node is in an object or map, or a numeric index if the node is in an array.
+	 * @remarks
+	 * For a node in an object, this might return a string like "firstName".
+	 * For a node in an array, this might return a number like 0, 1, 2, etc.
+	 *
+	 * Example: `const key = context.key(childNode);`
+	 */
+	key(child: TreeNode): string | number;
+}
+
+/**
+ * A synchronous function that executes a string of JavaScript code to perform an edit within a {@link SharedTreeSemanticAgent}.
+ * @param context - An object that must be provided to the generated code as a variable named "context" in its top-level scope.
+ * @param code - The JavaScript code that should be executed.
+ * @remarks To simulate the execution of an editor outside of an {@link SharedTreeSemanticAgent | agent}, you can use {@link bindEditor | bindEditor} to bind an editor to a specific subtree.
+ * @alpha
+ */
+export type SynchronousEditor = (context: Record<string, unknown>, code: string) => void;
+/**
+ * An asynchronous function that executes a string of JavaScript code to perform an edit within a {@link SharedTreeSemanticAgent}.
+ * @param context - An object that must be provided to the generated code as a variable named "context" in its top-level scope.
+ * @param code - The JavaScript code that should be executed.
+ * @remarks To simulate the execution of an editor outside of an {@link SharedTreeSemanticAgent | agent}, you can use {@link bindEditor | bindEditor} to bind an editor to a specific subtree.
+ * @alpha
+ */
+export type AsynchronousEditor = (
+	context: Record<string, unknown>,
+	code: string,
+) => Promise<void>;
+
 /**
  * Options used to parameterize the creation of a {@link SharedTreeSemanticAgent}.
  * @alpha
@@ -28,22 +117,14 @@ export interface SemanticAgentOptions {
 	 */
 	domainHints?: string;
 	/**
-	 * Validates any generated JavaScript created by the {@link SharedTreeChatModel.editToolName | model's editing tool}.
-	 * @remarks This happens before the code is executed - execution can be intercepted by using the {@link SemanticAgentOptions.executeEdit | executeEdit} callback.
-	 * @param code - The generated JavaScript code as a string.
-	 * @throws If the code is invalid, this function should throw an error with a human-readable message describing why it is invalid.
-	 */
-	validateEdit?: (code: string) => void | Promise<void>;
-	/**
-	 * Evaluates/runs any generated JavaScript created by the {@link SharedTreeChatModel.editToolName | model's editing tool}.
-	 * @remarks This happens only after the code has been successfully validated by the optional {@link SemanticAgentOptions.validateEdit | validateEdit} function.
-	 * @param context - An object that must be provided to the generated code as a variable named "context" in its top-level scope.
-	 * @param code - The generated JavaScript code as a string.
-	 * @throws If an error is thrown while executing the code, it will be caught and the message will be forwarded to the model for debugging.
-	 * @remarks If this function is not provided, the generated code will be executed using a simple `eval` call, which may not provide sufficient security guarantees for some environments.
+	 * Executes any generated JavaScript created by the {@link SharedTreeChatModel.editToolName | model's editing tool}.
+	 * @remarks If an error is thrown while executing the code, it will be caught and the message will be forwarded to the {@link SharedTreeChatModel | model} for debugging.
+	 * @remarks If this function is not provided, the generated code will be executed using a {@link defaultEditor | simple default} which may not provide sufficient security guarantees for some environments.
 	 * Use a library such as SES to provide a more secure implementation - see `@fluidframework/tree-agent-ses` for a drop-in implementation.
+	 *
+	 * To simulate the execution of an editor outside of an {@link SharedTreeSemanticAgent | agent}, you can use {@link bindEditor | bindEditor} to bind an editor to a specific subtree.
 	 */
-	executeEdit?: (context: Record<string, unknown>, code: string) => void | Promise<void>;
+	editor?: SynchronousEditor | AsynchronousEditor;
 	/**
 	 * The maximum number of sequential edits the LLM can make before we assume it's stuck in a loop.
 	 */
@@ -64,18 +145,11 @@ export interface EditResult {
 	 * @remarks
 	 * - `success`: The edit was successfully applied.
 	 * - `disabledError`: The model is not allowed to edit the tree (i.e. {@link SharedTreeChatModel.editToolName} was not provided).
-	 * - `validationError`: The provided JavaScript did not pass the optional {@link SemanticAgentOptions.validateEdit} function.
-	 * - `executionError`: An error was thrown while parsing or executing the provided JavaScript.
+	 * - `editingError`: An error was thrown while parsing or executing the provided JavaScript.
 	 * - `tooManyEditsError`: The {@link SharedTreeChatQuery.edit} function has been called more than the number of times specified by {@link SemanticAgentOptions.maximumSequentialEdits} for the same message.
 	 * - `expiredError`: The {@link SharedTreeChatQuery.edit} function was called after the issuing query has already completed.
 	 */
-	type:
-		| "success"
-		| "disabledError"
-		| "validationError"
-		| "executionError"
-		| "tooManyEditsError"
-		| "expiredError";
+	type: "success" | "disabledError" | "editingError" | "tooManyEditsError" | "expiredError";
 
 	/**
 	 * A human-readable message describing the result of the edit attempt.

package/src/index.ts

@@ -9,13 +9,20 @@
  * @packageDocumentation
  */
 
-export { SharedTreeSemanticAgent } from "./agent.js";
+export {
+	SharedTreeSemanticAgent,
+	bindEditor,
+	bindEditorImpl,
+	defaultEditor,
+} from "./agent.js";
 export type {
 	EditResult,
 	SharedTreeChatModel,
 	SharedTreeChatQuery,
 	Logger,
 	SemanticAgentOptions,
+	SynchronousEditor,
+	AsynchronousEditor,
 } from "./api.js";
 export { type TreeView, llmDefault } from "./utils.js";
 export {

package/src/prompt.ts

@@ -3,6 +3,7 @@
  * Licensed under the MIT License.
  */
 
+import { oob } from "@fluidframework/core-utils/internal";
 import { NodeKind, Tree, TreeNode } from "@fluidframework/tree";
 import type { ImplicitFieldSchema, TreeMapNode } from "@fluidframework/tree";
 import type { ReadableField } from "@fluidframework/tree/alpha";
@@ -34,10 +35,20 @@ export function getPrompt<TRoot extends ImplicitFieldSchema>(args: {
 	const mapInterfaceName = "TreeMap";
 	const simpleSchema = getSimpleSchema(schema);
 	// Inspect the schema to determine what kinds of nodes are possible - this will affect how much information we need to include in the prompt.
+	const rootTypes = [...normalizeFieldSchema(schema).allowedTypeSet];
+	const rootTypeUnion = `${rootTypes.map((t) => getFriendlyName(t)).join(" | ")}`;
+	let nodeTypeUnion: string | undefined;
 	let hasArrays = false;
 	let hasMaps = false;
 	let exampleObjectName: string | undefined;
 	for (const [definition, nodeSchema] of simpleSchema.definitions) {
+		if (nodeSchema.kind !== NodeKind.Leaf) {
+			nodeTypeUnion =
+				nodeTypeUnion === undefined
+					? unqualifySchema(definition)
+					: `${nodeTypeUnion} | ${unqualifySchema(definition)}`;
+		}
+
 		switch (nodeSchema.kind) {
 			case NodeKind.Array: {
 				hasArrays = true;
@@ -68,24 +79,81 @@ export function getPrompt<TRoot extends ImplicitFieldSchema>(args: {
 	const stringified = stringifyTree(field);
 	const details: SchemaDetails = { hasHelperMethods: false };
 	const typescriptSchemaTypes = getZodSchemaAsTypeScript(domainTypes, details);
-	const helperMethodExplanation = details.hasHelperMethods
-		? `Manipulating the data using the APIs described below is allowed, but when possible ALWAYS prefer to use any application helper methods exposed on the schema TypeScript types if the goal can be accomplished that way.
-It will often not be possible to fully accomplish the goal using those helpers. When this is the case, mutate the objects as normal, taking into account the following guidance.`
-		: "";
 
-	const builderExplanation =
+	const create =
+		exampleObjectName === undefined
+			? ""
+			: `\n	/**
+	 * A collection of builder functions for creating new tree nodes.
+	 * @remarks
+	 * Each property on this object is named after a type in the tree schema.
+	 * Call the corresponding function to create a new node of that type.
+	 * Always use these builder functions when creating new nodes rather than plain JavaScript objects.
+	 *
+	 * For example:
+	 *
+	 * \`\`\`javascript
+	 * // This creates a new ${exampleObjectName} object:
+	 * const ${communize(exampleObjectName)} = context.create.${exampleObjectName}({ ...properties });
+	 * // Don't do this:
+	 * // const ${communize(exampleObjectName)} = { ...properties };
+	 * \`\`\`
+	 */
+	create: Record<string, <T extends TreeData>(input: T) => T>;\n`;
+
+	const isDocs =
 		exampleObjectName === undefined
 			? ""
-			: `When constructing new objects, you should wrap them in the appropriate builder function rather than simply making a javascript object.
-The builders are available on the \`create\` property on the context object and are named according to the type that they create.
-For example:
+			: `\n	/**
+	 * A collection of type-guard functions for data in the tree.
+	 * @remarks
+	 * Each property on this object is named after a type in the tree schema.
+	 * Call the corresponding function to check if a node is of that specific type.
+	 * This is useful when working with nodes that could be one of multiple types.
+	 *
+	 * ${`Example: Check if a node is a ${exampleObjectName} with \`if (context.is.${exampleObjectName}(node)) {}\``}
+	 */
+	is: Record<string, <T extends TreeData>(input: unknown) => input is T>;\n`;
 
-\`\`\`javascript
-// This creates a new ${exampleObjectName} object:
-const ${communize(exampleObjectName)} = context.create.${exampleObjectName}({ /* ...properties... */ });
-// Don't do this:
-// const ${communize(exampleObjectName)} = { /* ...properties... */ };
-\`\`\`\n\n`;
+	const context = `\`\`\`typescript
+	${nodeTypeUnion === undefined ? "" : `type TreeData = ${nodeTypeUnion};\n\n`}	/**
+	 * An object available to generated code which provides read and write access to the tree as well as utilities for creating and inspecting data in the tree.
+	 * @remarks This object is available as a variable named \`context\` in the scope of the generated JavaScript snippet.
+	 */
+	interface Context<TSchema extends ImplicitFieldSchema> {
+	/**
+	 * The root of the tree that can be read or mutated.
+	 * @remarks
+	 * You can read properties and navigate through the tree starting from this root.
+	 * You can also assign a new value to this property to replace the entire tree, as long as the new value is one of the types allowed at the root.
+	 *
+	 * Example: Read the current root with \`const currentRoot = context.root;\`
+	 *${rootTypes.length > 0 ? ` Example: Replace the entire root with \`context.root = context.create.${getFriendlyName(rootTypes[0] ?? oob())}({ });\`\n	 *` : ""}/
+	root: ReadableField<TSchema>;
+	${create}
+	${isDocs}
+	/**
+	 * Returns the parent object/array/map of the given object/array/map, if there is one.
+	 * @returns The parent node, or \`undefined\` if the node is the root or is not in the tree.
+	 * @remarks
+	 * Example: Get the parent with \`const parent = context.parent(child);\`
+	 */
+	parent(child: TreeData): TreeData | undefined;
+
+	/**
+	 * Returns the property key or index of the given object/array/map within its parent.
+	 * @returns A string key if the child is in an object or map, or a numeric index if the child is in an array.
+	 *
+	 * Example: \`const key = context.key(child);\`
+	 */
+	key(child: TreeData): string | number;
+}
+\`\`\``;
+
+	const helperMethodExplanation = details.hasHelperMethods
+		? `Manipulating the data using the APIs described below is allowed, but when possible ALWAYS prefer to use any application helper methods exposed on the schema TypeScript types if the goal can be accomplished that way.
+It will often not be possible to fully accomplish the goal using those helpers. When this is the case, mutate the objects as normal, taking into account the following guidance.`
+		: "";
 
 	const reinsertionExplanation = `Once non-primitive data has been removed from the tree (e.g. replaced via assignment, or removed from an array), that data cannot be re-inserted into the tree.
 Instead, it must be deep cloned and recreated.
@@ -160,7 +228,6 @@ ${getTreeMapNodeDocumentation(mapInterfaceName)}
 
 `;
 
-	const rootTypes = normalizeFieldSchema(schema).allowedTypeSet;
 	const editing = `If the user asks you to edit the tree, you should author a snippet of JavaScript code to accomplish the user-specified goal, following the instructions for editing detailed below.
 You must use the "${editToolName}" tool to run the generated code.
 After editing the tree, review the latest state of the tree to see if it satisfies the user's request.
@@ -173,14 +240,18 @@ If the user asks you to edit the document, you will write a snippet of JavaScrip
 The snippet may be synchronous or asynchronous (i.e. it may \`await\` functions if necessary).
 The snippet has a \`context\` variable in its scope.
 This \`context\` variable holds the current state of the tree in the \`root\` property.
-You may mutate any part of the root tree as necessary, taking into account the caveats around${hasArrays ? ` arrays${hasMaps ? " and" : ""}` : ""}${hasMaps ? " maps" : ""} detailed below.
-You may also set the \`root\` property of the context to be an entirely new value as long as it is one of the types allowed at the root of the tree (\`${Array.from(rootTypes.values(), (t) => getFriendlyName(t)).join(" | ")}\`).
+You may mutate any part of this tree as necessary, taking into account the caveats around${hasArrays ? ` arrays${hasMaps ? " and" : ""}` : ""}${hasMaps ? " maps" : ""} detailed below.
+You may also set the \`root\` property of the context to be an entirely new value as long as it is one of the types allowed at the root of the tree (\`${rootTypeUnion}\`).
+You should also use the \`context\` object to create new data to insert into the tree, using the builder functions available on the \`create\` property.
+There are other additional helper functions available on the \`context\` object to help you analyze the tree.
+Here is the definition of the \`Context\` interface:
+${context}
 ${helperMethodExplanation}
 ${hasArrays ? arrayEditing : ""}${hasMaps ? mapEditing : ""}#### Additional Notes
 
 Before outputting the edit function, you should check that it is valid according to both the application tree's schema and any restrictions of the editing APIs described above.
 
-${builderExplanation}${reinsertionExplanation}
+${reinsertionExplanation}
 
 Finally, double check that the edits would accomplish the user's request (if it is possible).