@fluidframework/tree-agent 2.63.0-359461 → 2.63.0-359962

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/tree-agent",
-  "version": "2.63.0-359461",
+  "version": "2.63.0-359962",
   "description": "Experimental package to simplify integrating AI into Fluid-based applications",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -70,28 +70,26 @@
   },
   "dependencies": {
     "@anthropic-ai/sdk": "^0.39.0",
-    "@fluidframework/core-utils": "2.63.0-359461",
-    "@fluidframework/runtime-utils": "2.63.0-359461",
-    "@fluidframework/telemetry-utils": "2.63.0-359461",
-    "@fluidframework/tree": "2.63.0-359461",
-    "@langchain/core": "^0.3.66",
-    "acorn": "^8.15.0",
-    "langchain": "^0.3.30",
+    "@fluidframework/core-utils": "2.63.0-359962",
+    "@fluidframework/runtime-utils": "2.63.0-359962",
+    "@fluidframework/telemetry-utils": "2.63.0-359962",
+    "@fluidframework/tree": "2.63.0-359962",
     "uuid": "^11.1.0",
     "zod": "^3.25.32"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.17.1",
     "@biomejs/biome": "~1.9.3",
-    "@fluid-internal/mocha-test-setup": "2.63.0-359461",
+    "@fluid-internal/mocha-test-setup": "2.63.0-359962",
     "@fluid-tools/build-cli": "^0.58.3",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.58.3",
     "@fluidframework/eslint-config-fluid": "^6.0.0",
-    "@fluidframework/id-compressor": "2.63.0-359461",
-    "@fluidframework/runtime-utils": "2.63.0-359461",
-    "@fluidframework/test-runtime-utils": "2.63.0-359461",
+    "@fluidframework/id-compressor": "2.63.0-359962",
+    "@fluidframework/runtime-utils": "2.63.0-359962",
+    "@fluidframework/test-runtime-utils": "2.63.0-359962",
     "@langchain/anthropic": "^0.3.24",
+    "@langchain/core": "^0.3.78",
     "@langchain/google-genai": "^0.2.16",
     "@langchain/openai": "^0.6.12",
     "@microsoft/api-extractor": "7.52.11",
@@ -108,6 +106,7 @@
     "mocha-multi-reporters": "^1.5.1",
     "prettier": "~3.0.3",
     "rimraf": "^4.4.0",
+    "ses": "^1.14.0",
     "typescript": "~5.4.5"
   },
   "fluidBuild": {

package/src/agent.ts

@@ -17,14 +17,7 @@ import type {
 } from "@fluidframework/tree/alpha";
 import { ObjectNodeSchema, Tree } from "@fluidframework/tree/alpha";
 
-import type {
-	SharedTreeChatModel,
-	EditFunction,
-	EditResult,
-	SemanticAgentOptions,
-	Logger,
-} from "./api.js";
-import { findInvocableFunctionName, stripExportSyntax } from "./functionParsing.js";
+import type { SharedTreeChatModel, EditResult, SemanticAgentOptions, Logger } from "./api.js";
 import { getPrompt, stringifyTree } from "./prompt.js";
 import { Subtree } from "./subtree.js";
 import {
@@ -33,6 +26,7 @@ import {
 	llmDefault,
 	type TreeView,
 	findNamedSchemas,
+	toErrorString,
 } from "./utils.js";
 
 /**
@@ -41,11 +35,6 @@ import {
  */
 const defaultMaxSequentialEdits = 20;
 
-/**
- * The name of the parameter passed to the edit function.
- */
-const paramsName = "params";
-
 /**
  * An agent that uses a {@link SharedTreeChatModel} to interact with a SharedTree.
  * @remarks This class forwards user queries to the chat model, and handles the application of any edits to the tree that the model requests.
@@ -123,7 +112,7 @@ export class SharedTreeSemanticAgent<TSchema extends ImplicitFieldSchema> {
 		let editCount = 0;
 		let editFailed = false;
 		const { editToolName } = this.client;
-		const edit = async (js: string): Promise<EditResult> => {
+		const edit = async (editCode: string): Promise<EditResult> => {
 			if (editToolName === undefined) {
 				return {
 					type: "disabledError",
@@ -147,8 +136,9 @@ export class SharedTreeSemanticAgent<TSchema extends ImplicitFieldSchema> {
 
 			const editResult = await applyTreeFunction(
 				queryTree,
-				js,
-				this.options?.validator,
+				editCode,
+				this.options?.validateEdit ?? defaultValidateEdit,
+				this.options?.executeEdit ?? defaultExecuteEdit,
 				this.options?.logger,
 			);
 
@@ -208,18 +198,22 @@ function constructTreeNode(schema: TreeNodeSchema, value: FactoryContentObject):
  */
 async function applyTreeFunction<TSchema extends ImplicitFieldSchema>(
 	tree: Subtree<TSchema>,
-	fn: string | EditFunction<TSchema>,
-	validator: ((js: string) => boolean) | undefined,
+	editCode: string,
+	validateEdit: Required<SemanticAgentOptions>["validateEdit"],
+	executeEdit: Required<SemanticAgentOptions>["executeEdit"],
 	logger: Logger | undefined,
 ): Promise<EditResult> {
 	logger?.log(`### Editing Tool Invoked\n\n`);
-	logger?.log(`#### Generated Code\n\n\`\`\`javascript\n${fn}\n\`\`\`\n\n`);
+	logger?.log(`#### Generated Code\n\n\`\`\`javascript\n${editCode}\n\`\`\`\n\n`);
 
-	if (validator?.(fn.toString()) === false) {
+	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. Please try again.",
+			message: `The generated code did not pass validation: ${toErrorString(error)}`,
 		};
 	}
 
@@ -232,7 +226,7 @@ async function applyTreeFunction<TSchema extends ImplicitFieldSchema>(
 
 	// 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 params = {
+	const context = {
 		get root(): ReadableField<TSchema> {
 			return editTree.field;
 		},
@@ -242,34 +236,15 @@ async function applyTreeFunction<TSchema extends ImplicitFieldSchema>(
 		create,
 	};
 
-	let editFunction: EditFunction<TSchema>;
-	if (typeof fn === "string") {
-		try {
-			editFunction = processLlmCode(fn);
-		} catch (error) {
-			logger?.log(`#### Error\n\n`);
-			const errorMessage = error instanceof Error ? error.message : JSON.stringify(error);
-			logger?.log(`\`\`\`JSON\n${errorMessage}\n\`\`\`\n\n`);
-			editTree.branch.dispose();
-			return {
-				type: "compileError",
-				message: `The supplied JavaScript function is not valid: ${errorMessage}`,
-			};
-		}
-	} else {
-		editFunction = fn;
-	}
-
 	try {
-		await editFunction(params);
+		await executeEdit(context, editCode);
 	} catch (error: unknown) {
 		logger?.log(`#### Error\n\n`);
-		const errorMessage = error instanceof Error ? error.message : JSON.stringify(error);
-		logger?.log(`\`\`\`JSON\n${errorMessage}\n\`\`\`\n\n`);
+		logger?.log(`\`\`\`JSON\n${toErrorString(error)}\n\`\`\`\n\n`);
 		editTree.branch.dispose();
 		return {
-			type: "runtimeError",
-			message: `Running the function produced an error. The state of the tree will be reset to its previous state as it was before the function ran. Please try again. Here is the error: ${errorMessage}`,
+			type: "executionError",
+			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)}`,
 		};
 	}
 
@@ -278,24 +253,17 @@ async function applyTreeFunction<TSchema extends ImplicitFieldSchema>(
 	logger?.log(`${`\`\`\`JSON\n${stringifyTree(tree.field)}\n\`\`\``}\n\n`);
 	return {
 		type: "success",
-		message: `After running the function, the new state of the tree is:\n\n\`\`\`JSON\n${stringifyTree(tree.field)}\n\`\`\``,
+		message: `After running the code, the new state of the tree is:\n\n\`\`\`JSON\n${stringifyTree(tree.field)}\n\`\`\``,
 	};
 }
 
-function processLlmCode<TSchema extends ImplicitFieldSchema>(
-	code: string,
-): EditFunction<TSchema> {
-	const functionName = findInvocableFunctionName(code);
-	if (functionName === undefined) {
-		throw new Error("Generated code does not contain an invokable function");
-	}
+const defaultValidateEdit: Required<SemanticAgentOptions>["validateEdit"] = () => {};
 
-	const executionCode = `${stripExportSyntax(code)}\n\nreturn ${functionName}(${paramsName});`;
+const defaultExecuteEdit: Required<SemanticAgentOptions>["executeEdit"] = async (
+	context,
+	code,
+) => {
 	// eslint-disable-next-line no-new-func, @typescript-eslint/no-implied-eval
-	const fn = new Function(paramsName, executionCode);
-	return fn as EditFunction<TSchema>;
-}
-
-/**
- * Finds the name of the first invocable function in the given code.
- */
+	const fn = new Function("context", code);
+	await fn(context);
+};

package/src/api.ts

@@ -4,11 +4,8 @@
  */
 
 import type { ImplicitFieldSchema, TreeNode } from "@fluidframework/tree";
-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 { SharedTreeSemanticAgent } from "./agent.js";
+import type { FactoryContentObject, ReadableField } from "@fluidframework/tree/alpha";
 
 /**
  * Logger interface for logging events from a {@link SharedTreeSemanticAgent}.
@@ -31,10 +28,22 @@ export interface SemanticAgentOptions {
 	 */
 	domainHints?: string;
 	/**
-	 * Validates any generated JavaScript created by the {@link SharedTreeChatModel.editToolName | model's editing tool} before running it.
-	 * @remarks If this returns false, then the edit will throw an error instead of attempting to execute the JavaScript.
+	 * 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.
+	 * Use a library such as SES to provide a more secure implementation - see `@fluidframework/tree-agent-ses` for a drop-in implementation.
 	 */
-	validator?: (js: string) => boolean;
+	executeEdit?: (context: Record<string, unknown>, code: string) => void | Promise<void>;
 	/**
 	 * The maximum number of sequential edits the LLM can make before we assume it's stuck in a loop.
 	 */
@@ -50,9 +59,8 @@ export interface SemanticAgentOptions {
  * @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.validator} function.
- * - `compileError`: The provided JavaScript could not be parsed or compiled.
- * - `runtimeError`: An error was thrown while executing the provided JavaScript.
+ * - `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.
  * - `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.
  * @alpha
@@ -62,8 +70,7 @@ export interface EditResult {
 		| "success"
 		| "disabledError"
 		| "validationError"
-		| "compileError"
-		| "runtimeError"
+		| "executionError"
 		| "tooManyEditsError"
 		| "expiredError";
 
@@ -107,6 +114,7 @@ export interface SharedTreeChatQuery {
 /**
  * A plugin interface that handles queries from a {@link SharedTreeSemanticAgent}.
  * @remarks This wraps an underlying communication with an LLM and receives all necessary {@link SharedTreeChatModel.appendContext | context} from the {@link SharedTreeSemanticAgent | agent} for the LLM to properly analyze and edit the tree.
+ * See `@fluidframework/tree-agent-langchain` for a drop-in implementation based on the LangChain library.
  * @alpha
  */
 export interface SharedTreeChatModel {

package/src/index.ts

@@ -31,4 +31,3 @@ export {
 	type Infer,
 	type IExposedMethods,
 } from "./methodBinding.js";
-export { LangchainChatModel, createSemanticAgent } from "./langchain.js";

package/src/prompt.ts

@@ -69,7 +69,7 @@ export function getPrompt<TRoot extends ImplicitFieldSchema>(args: {
 	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 the application helper methods exposed on the schema TypeScript types if the goal can be accomplished that way.
+		? `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.`
 		: "";
 
@@ -77,16 +77,14 @@ It will often not be possible to fully accomplish the goal using those helpers.
 		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 first argument of the edit function and are named according to the type that they create.
+The builders are available on the \`create\` property on the context object and are named according to the type that they create.
 For example:
 
 \`\`\`javascript
-function editTree({ root, create }) {
-	// This creates a new ${exampleObjectName} object:
-	const ${communize(exampleObjectName)} = create.${exampleObjectName}({ /* ...properties... */ });
-	// Don't do this:
-	// const ${communize(exampleObjectName)} = { /* ...properties... */ };
-}
+// This creates a new ${exampleObjectName} object:
+const ${communize(exampleObjectName)} = context.create.${exampleObjectName}({ /* ...properties... */ });
+// Don't do this:
+// const ${communize(exampleObjectName)} = { /* ...properties... */ };
 \`\`\`\n\n`;
 
 	const arrayEditing = `#### Editing Arrays
@@ -120,20 +118,20 @@ ${getTreeMapNodeDocumentation(mapInterfaceName)}
 `;
 
 	const rootTypes = normalizeFieldSchema(schema).allowedTypeSet;
-	const editing = `If the user asks you to edit the tree, you should author a JavaScript function to accomplish the user-specified goal, following the instructions for editing detailed below.
-You must use the "${editToolName}" tool to perform the edit.
+	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.
 If it does not, or if you receive an error, you may try again with a different approach.
 Once the tree is in the desired state, you should inform the user that the request has been completed.
 
 ### Editing
 
-If the user asks you to edit the document, you will write a JavaScript function that mutates the data in-place to achieve the user's goal.
-The edit function may be synchronous or asynchronous.
-The edit function must have a first parameter which has a \`root\` property.
-This \`root\` property holds the current state of the tree as shown above.
-You may mutate any part of the tree as necessary, taking into account the caveats around arrays and maps detailed below.
-You may also set the \`root\` property 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(" | ")}\`).
+If the user asks you to edit the document, you will write a snippet of JavaScript code that mutates the data in-place to achieve the user's goal.
+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(" | ")}\`).
 ${helperMethodExplanation}
 
 ${hasArrays ? arrayEditing : ""}${hasMaps ? mapEditing : ""}#### Additional Notes
@@ -163,7 +161,7 @@ ${
 		? ""
 		: `\nThe application supplied the following additional instructions: ${domainHints}`
 }
-The current state of the application tree (a \`${field === undefined ? "undefined" : getFriendlyName(Tree.schema(field))}\`) is:
+The current state of \`context.root\` (a \`${field === undefined ? "undefined" : getFriendlyName(Tree.schema(field))}\`) is:
 
 \`\`\`JSON
 ${stringified}

package/src/utils.ts

@@ -619,3 +619,17 @@ export function findNamedSchemas(
 export function communize(str: string): string {
 	return str.charAt(0).toLowerCase() + str.slice(1);
 }
+
+/**
+ * Stringify an unknown error value
+ */
+export function toErrorString(error: unknown): string {
+	if (error instanceof Error) {
+		return error.message;
+	}
+	try {
+		return JSON.stringify(error);
+	} catch {
+		return String(error);
+	}
+}

package/dist/functionParsing.d.ts

@@ -1,13 +0,0 @@
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-/**
- * Finds the name of the first invocable function in the given code string.
- */
-export declare function findInvocableFunctionName(code: string): string | undefined;
-/**
- * Removes top-level export syntax so that the provided code can execute in a classic script context.
- */
-export declare function stripExportSyntax(code: string): string;
-//# sourceMappingURL=functionParsing.d.ts.map

package/dist/functionParsing.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"functionParsing.d.ts","sourceRoot":"","sources":["../src/functionParsing.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAsBH;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAc1E;AAED;;GAEG;AACH,wBAAgB,iBAAiB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CA0DtD"}

package/dist/functionParsing.js

@@ -1,215 +0,0 @@
-"use strict";
-/*!
- * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
- * Licensed under the MIT License.
- */
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.stripExportSyntax = exports.findInvocableFunctionName = void 0;
-/* eslint-disable @rushstack/no-new-null */
-const acorn_1 = require("acorn");
-/**
- * Finds the name of the first invocable function in the given code string.
- */
-function findInvocableFunctionName(code) {
-    const program = parseProgram(code);
-    if (program === undefined) {
-        return undefined;
-    }
-    for (const node of program.body) {
-        const name = getNameFromTopLevelNode(node);
-        if (name !== undefined) {
-            return name;
-        }
-    }
-    return undefined;
-}
-exports.findInvocableFunctionName = findInvocableFunctionName;
-/**
- * Removes top-level export syntax so that the provided code can execute in a classic script context.
- */
-function stripExportSyntax(code) {
-    const program = parseProgram(code);
-    if (program === undefined) {
-        return code;
-    }
-    const replacements = [];
-    for (const node of program.body) {
-        switch (node.type) {
-            case "ExportNamedDeclaration": {
-                if (node.declaration !== undefined && node.declaration !== null) {
-                    replacements.push({
-                        start: node.start,
-                        end: node.declaration.start,
-                        replacement: "",
-                    });
-                }
-                else {
-                    replacements.push({ start: node.start, end: node.end, replacement: "" });
-                }
-                break;
-            }
-            case "ExportDefaultDeclaration": {
-                const { declaration, start, end } = node;
-                if (declaration.type === "FunctionDeclaration" ||
-                    declaration.type === "FunctionExpression") {
-                    replacements.push({
-                        start,
-                        end: declaration.start,
-                        replacement: "",
-                    });
-                }
-                else {
-                    replacements.push({ start, end, replacement: "" });
-                }
-                break;
-            }
-            case "ExportAllDeclaration": {
-                replacements.push({ start: node.start, end: node.end, replacement: "" });
-                break;
-            }
-            // No default
-        }
-    }
-    if (replacements.length === 0) {
-        return code;
-    }
-    replacements.sort((a, b) => b.start - a.start);
-    let sanitized = code;
-    for (const { start, end, replacement } of replacements) {
-        sanitized = `${sanitized.slice(0, start)}${replacement}${sanitized.slice(end)}`;
-    }
-    return sanitized;
-}
-exports.stripExportSyntax = stripExportSyntax;
-function parseProgram(code) {
-    try {
-        return (0, acorn_1.parse)(code, {
-            ecmaVersion: "latest",
-            sourceType: "module",
-        });
-    }
-    catch {
-        try {
-            return (0, acorn_1.parse)(code, {
-                ecmaVersion: "latest",
-                sourceType: "script",
-                allowReturnOutsideFunction: true,
-                allowAwaitOutsideFunction: true,
-                allowSuperOutsideMethod: true,
-            });
-        }
-        catch {
-            return undefined;
-        }
-    }
-}
-function getNameFromTopLevelNode(node) {
-    switch (node.type) {
-        case "FunctionDeclaration": {
-            return getFunctionIdentifier(node);
-        }
-        case "VariableDeclaration": {
-            return getNameFromVariableDeclaration(node);
-        }
-        case "ExpressionStatement": {
-            return getNameFromExpression(node.expression);
-        }
-        case "ExportNamedDeclaration": {
-            return getNameFromExportNamed(node);
-        }
-        case "ExportDefaultDeclaration": {
-            return getNameFromExportDefault(node);
-        }
-        default: {
-            return undefined;
-        }
-    }
-}
-function getNameFromVariableDeclaration(node) {
-    for (const declarator of node.declarations) {
-        const name = getIdentifierFromPattern(declarator.id);
-        if (name === undefined) {
-            continue;
-        }
-        if (isFunctionLikeExpression(declarator.init)) {
-            return name;
-        }
-    }
-    return undefined;
-}
-function getNameFromExpression(expression) {
-    if (!isAssignmentExpression(expression)) {
-        return undefined;
-    }
-    if (expression.operator !== "=") {
-        return undefined;
-    }
-    const target = getIdentifierFromPattern(expression.left);
-    if (target === undefined) {
-        return undefined;
-    }
-    return isFunctionLikeExpression(expression.right) ? target : undefined;
-}
-function getNameFromExportNamed(node) {
-    const declaration = node.declaration;
-    if (declaration !== undefined && declaration !== null) {
-        if (declaration.type === "FunctionDeclaration") {
-            const name = getFunctionIdentifier(declaration);
-            if (name !== undefined) {
-                return name;
-            }
-        }
-        else if (declaration.type === "VariableDeclaration") {
-            const name = getNameFromVariableDeclaration(declaration);
-            if (name !== undefined) {
-                return name;
-            }
-        }
-    }
-    if (node.source === undefined || node.source === null) {
-        for (const specifier of node.specifiers) {
-            const localName = getIdentifierName(specifier.local);
-            if (localName !== undefined) {
-                return localName;
-            }
-        }
-    }
-    return undefined;
-}
-function getNameFromExportDefault(node) {
-    const declaration = node.declaration;
-    if (declaration.type === "Identifier") {
-        return declaration.name;
-    }
-    if (declaration.type === "FunctionDeclaration" ||
-        declaration.type === "FunctionExpression") {
-        return getFunctionIdentifier(declaration);
-    }
-    return undefined;
-}
-function isAssignmentExpression(expression) {
-    return expression?.type === "AssignmentExpression";
-}
-function getIdentifierFromPattern(pattern) {
-    if (pattern.type === "Identifier") {
-        return pattern.name;
-    }
-    return undefined;
-}
-function isFunctionLikeExpression(expression) {
-    return (expression?.type === "FunctionExpression" || expression?.type === "ArrowFunctionExpression");
-}
-function getFunctionIdentifier(fn) {
-    const id = fn.id;
-    if (id === undefined || id === null) {
-        return undefined;
-    }
-    return id.name;
-}
-function getIdentifierName(node) {
-    if (node.type === "Identifier") {
-        return node.name;
-    }
-    return undefined;
-}
-//# sourceMappingURL=functionParsing.js.map

package/dist/functionParsing.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"functionParsing.js","sourceRoot":"","sources":["../src/functionParsing.ts"],"names":[],"mappings":";AAAA;;;GAGG;;;AAEH,2CAA2C;AAE3C,iCAA8B;AAkB9B;;GAEG;AACH,SAAgB,yBAAyB,CAAC,IAAY;IACrD,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IACnC,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC3B,OAAO,SAAS,CAAC;IAClB,CAAC;IAED,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACjC,MAAM,IAAI,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAC;QAC3C,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,IAAI,CAAC;QACb,CAAC;IACF,CAAC;IAED,OAAO,SAAS,CAAC;AAClB,CAAC;AAdD,8DAcC;AAED;;GAEG;AACH,SAAgB,iBAAiB,CAAC,IAAY;IAC7C,MAAM,OAAO,GAAG,YAAY,CAAC,IAAI,CAAC,CAAC;IACnC,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC3B,OAAO,IAAI,CAAC;IACb,CAAC;IAED,MAAM,YAAY,GAA0D,EAAE,CAAC;IAC/E,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACjC,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;YACnB,KAAK,wBAAwB,CAAC,CAAC,CAAC;gBAC/B,IAAI,IAAI,CAAC,WAAW,KAAK,SAAS,IAAI,IAAI,CAAC,WAAW,KAAK,IAAI,EAAE,CAAC;oBACjE,YAAY,CAAC,IAAI,CAAC;wBACjB,KAAK,EAAE,IAAI,CAAC,KAAK;wBACjB,GAAG,EAAE,IAAI,CAAC,WAAW,CAAC,KAAK;wBAC3B,WAAW,EAAE,EAAE;qBACf,CAAC,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACP,YAAY,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;gBAC1E,CAAC;gBAED,MAAM;YACP,CAAC;YACD,KAAK,0BAA0B,CAAC,CAAC,CAAC;gBACjC,MAAM,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC;gBACzC,IACC,WAAW,CAAC,IAAI,KAAK,qBAAqB;oBAC1C,WAAW,CAAC,IAAI,KAAK,oBAAoB,EACxC,CAAC;oBACF,YAAY,CAAC,IAAI,CAAC;wBACjB,KAAK;wBACL,GAAG,EAAE,WAAW,CAAC,KAAK;wBACtB,WAAW,EAAE,EAAE;qBACf,CAAC,CAAC;gBACJ,CAAC;qBAAM,CAAC;oBACP,YAAY,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,GAAG,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;gBACpD,CAAC;gBAED,MAAM;YACP,CAAC;YACD,KAAK,sBAAsB,CAAC,CAAC,CAAC;gBAC7B,YAAY,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,IAAI,CAAC,KAAK,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,WAAW,EAAE,EAAE,EAAE,CAAC,CAAC;gBAEzE,MAAM;YACP,CAAC;YACD,aAAa;QACd,CAAC;IACF,CAAC;IAED,IAAI,YAAY,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QAC/B,OAAO,IAAI,CAAC;IACb,CAAC;IAED,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;IAC/C,IAAI,SAAS,GAAG,IAAI,CAAC;IACrB,KAAK,MAAM,EAAE,KAAK,EAAE,GAAG,EAAE,WAAW,EAAE,IAAI,YAAY,EAAE,CAAC;QACxD,SAAS,GAAG,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,GAAG,WAAW,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;IACjF,CAAC;IACD,OAAO,SAAS,CAAC;AAClB,CAAC;AA1DD,8CA0DC;AAID,SAAS,YAAY,CAAC,IAAY;IACjC,IAAI,CAAC;QACJ,OAAO,IAAA,aAAK,EAAC,IAAI,EAAE;YAClB,WAAW,EAAE,QAAQ;YACrB,UAAU,EAAE,QAAQ;SACpB,CAAC,CAAC;IACJ,CAAC;IAAC,MAAM,CAAC;QACR,IAAI,CAAC;YACJ,OAAO,IAAA,aAAK,EAAC,IAAI,EAAE;gBAClB,WAAW,EAAE,QAAQ;gBACrB,UAAU,EAAE,QAAQ;gBACpB,0BAA0B,EAAE,IAAI;gBAChC,yBAAyB,EAAE,IAAI;gBAC/B,uBAAuB,EAAE,IAAI;aAC7B,CAAC,CAAC;QACJ,CAAC;QAAC,MAAM,CAAC;YACR,OAAO,SAAS,CAAC;QAClB,CAAC;IACF,CAAC;AACF,CAAC;AAED,SAAS,uBAAuB,CAAC,IAAkB;IAClD,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;QACnB,KAAK,qBAAqB,CAAC,CAAC,CAAC;YAC5B,OAAO,qBAAqB,CAAC,IAAI,CAAC,CAAC;QACpC,CAAC;QACD,KAAK,qBAAqB,CAAC,CAAC,CAAC;YAC5B,OAAO,8BAA8B,CAAC,IAAI,CAAC,CAAC;QAC7C,CAAC;QACD,KAAK,qBAAqB,CAAC,CAAC,CAAC;YAC5B,OAAO,qBAAqB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC/C,CAAC;QACD,KAAK,wBAAwB,CAAC,CAAC,CAAC;YAC/B,OAAO,sBAAsB,CAAC,IAAI,CAAC,CAAC;QACrC,CAAC;QACD,KAAK,0BAA0B,CAAC,CAAC,CAAC;YACjC,OAAO,wBAAwB,CAAC,IAAI,CAAC,CAAC;QACvC,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACT,OAAO,SAAS,CAAC;QAClB,CAAC;IACF,CAAC;AACF,CAAC;AAED,SAAS,8BAA8B,CAAC,IAAyB;IAChE,KAAK,MAAM,UAAU,IAAI,IAAI,CAAC,YAAY,EAAE,CAAC;QAC5C,MAAM,IAAI,GAAG,wBAAwB,CAAC,UAAU,CAAC,EAAE,CAAC,CAAC;QACrD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACxB,SAAS;QACV,CAAC;QAED,IAAI,wBAAwB,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;YAC/C,OAAO,IAAI,CAAC;QACb,CAAC;IACF,CAAC;IAED,OAAO,SAAS,CAAC;AAClB,CAAC;AAED,SAAS,qBAAqB,CAC7B,UAA4C;IAE5C,IAAI,CAAC,sBAAsB,CAAC,UAAU,CAAC,EAAE,CAAC;QACzC,OAAO,SAAS,CAAC;IAClB,CAAC;IAED,IAAI,UAAU,CAAC,QAAQ,KAAK,GAAG,EAAE,CAAC;QACjC,OAAO,SAAS,CAAC;IAClB,CAAC;IAED,MAAM,MAAM,GAAG,wBAAwB,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;IACzD,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QAC1B,OAAO,SAAS,CAAC;IAClB,CAAC;IAED,OAAO,wBAAwB,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;AACxE,CAAC;AAED,SAAS,sBAAsB,CAAC,IAA4B;IAC3D,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;IACrC,IAAI,WAAW,KAAK,SAAS,IAAI,WAAW,KAAK,IAAI,EAAE,CAAC;QACvD,IAAI,WAAW,CAAC,IAAI,KAAK,qBAAqB,EAAE,CAAC;YAChD,MAAM,IAAI,GAAG,qBAAqB,CAAC,WAAW,CAAC,CAAC;YAChD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACxB,OAAO,IAAI,CAAC;YACb,CAAC;QACF,CAAC;aAAM,IAAI,WAAW,CAAC,IAAI,KAAK,qBAAqB,EAAE,CAAC;YACvD,MAAM,IAAI,GAAG,8BAA8B,CAAC,WAAW,CAAC,CAAC;YACzD,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;gBACxB,OAAO,IAAI,CAAC;YACb,CAAC;QACF,CAAC;IACF,CAAC;IAED,IAAI,IAAI,CAAC,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,MAAM,KAAK,IAAI,EAAE,CAAC;QACvD,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU,EAAE,CAAC;YACzC,MAAM,SAAS,GAAG,iBAAiB,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;YACrD,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;gBAC7B,OAAO,SAAS,CAAC;YAClB,CAAC;QACF,CAAC;IACF,CAAC;IAED,OAAO,SAAS,CAAC;AAClB,CAAC;AAED,SAAS,wBAAwB,CAAC,IAA8B;IAC/D,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC;IACrC,IAAI,WAAW,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;QACvC,OAAO,WAAW,CAAC,IAAI,CAAC;IACzB,CAAC;IAED,IACC,WAAW,CAAC,IAAI,KAAK,qBAAqB;QAC1C,WAAW,CAAC,IAAI,KAAK,oBAAoB,EACxC,CAAC;QACF,OAAO,qBAAqB,CAAC,WAAW,CAAC,CAAC;IAC3C,CAAC;IAED,OAAO,SAAS,CAAC;AAClB,CAAC;AAED,SAAS,sBAAsB,CAC9B,UAA4C;IAE5C,OAAO,UAAU,EAAE,IAAI,KAAK,sBAAsB,CAAC;AACpD,CAAC;AAED,SAAS,wBAAwB,CAAC,OAAgB;IACjD,IAAI,OAAO,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;QACnC,OAAO,OAAO,CAAC,IAAI,CAAC;IACrB,CAAC;IACD,OAAO,SAAS,CAAC;AAClB,CAAC;AAED,SAAS,wBAAwB,CAChC,UAAyC;IAEzC,OAAO,CACN,UAAU,EAAE,IAAI,KAAK,oBAAoB,IAAI,UAAU,EAAE,IAAI,KAAK,yBAAyB,CAC3F,CAAC;AACH,CAAC;AAED,SAAS,qBAAqB,CAC7B,EAAyE;IAEzE,MAAM,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC;IACjB,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,KAAK,IAAI,EAAE,CAAC;QACrC,OAAO,SAAS,CAAC;IAClB,CAAC;IACD,OAAO,EAAE,CAAC,IAAI,CAAC;AAChB,CAAC;AAED,SAAS,iBAAiB,CAAC,IAA0B;IACpD,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;QAChC,OAAO,IAAI,CAAC,IAAI,CAAC;IAClB,CAAC;IACD,OAAO,SAAS,CAAC;AAClB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\n/* eslint-disable @rushstack/no-new-null */\n\nimport { parse } from \"acorn\";\nimport type {\n\tProgram,\n\tStatement,\n\tModuleDeclaration,\n\tVariableDeclaration,\n\tExpression,\n\tAssignmentExpression,\n\tPattern,\n\tIdentifier,\n\tLiteral,\n\tExportNamedDeclaration,\n\tExportDefaultDeclaration,\n\tFunctionDeclaration,\n\tFunctionExpression,\n\tArrowFunctionExpression,\n} from \"acorn\";\n\n/**\n * Finds the name of the first invocable function in the given code string.\n */\nexport function findInvocableFunctionName(code: string): string | undefined {\n\tconst program = parseProgram(code);\n\tif (program === undefined) {\n\t\treturn undefined;\n\t}\n\n\tfor (const node of program.body) {\n\t\tconst name = getNameFromTopLevelNode(node);\n\t\tif (name !== undefined) {\n\t\t\treturn name;\n\t\t}\n\t}\n\n\treturn undefined;\n}\n\n/**\n * Removes top-level export syntax so that the provided code can execute in a classic script context.\n */\nexport function stripExportSyntax(code: string): string {\n\tconst program = parseProgram(code);\n\tif (program === undefined) {\n\t\treturn code;\n\t}\n\n\tconst replacements: { start: number; end: number; replacement: string }[] = [];\n\tfor (const node of program.body) {\n\t\tswitch (node.type) {\n\t\t\tcase \"ExportNamedDeclaration\": {\n\t\t\t\tif (node.declaration !== undefined && node.declaration !== null) {\n\t\t\t\t\treplacements.push({\n\t\t\t\t\t\tstart: node.start,\n\t\t\t\t\t\tend: node.declaration.start,\n\t\t\t\t\t\treplacement: \"\",\n\t\t\t\t\t});\n\t\t\t\t} else {\n\t\t\t\t\treplacements.push({ start: node.start, end: node.end, replacement: \"\" });\n\t\t\t\t}\n\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase \"ExportDefaultDeclaration\": {\n\t\t\t\tconst { declaration, start, end } = node;\n\t\t\t\tif (\n\t\t\t\t\tdeclaration.type === \"FunctionDeclaration\" ||\n\t\t\t\t\tdeclaration.type === \"FunctionExpression\"\n\t\t\t\t) {\n\t\t\t\t\treplacements.push({\n\t\t\t\t\t\tstart,\n\t\t\t\t\t\tend: declaration.start,\n\t\t\t\t\t\treplacement: \"\",\n\t\t\t\t\t});\n\t\t\t\t} else {\n\t\t\t\t\treplacements.push({ start, end, replacement: \"\" });\n\t\t\t\t}\n\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\tcase \"ExportAllDeclaration\": {\n\t\t\t\treplacements.push({ start: node.start, end: node.end, replacement: \"\" });\n\n\t\t\t\tbreak;\n\t\t\t}\n\t\t\t// No default\n\t\t}\n\t}\n\n\tif (replacements.length === 0) {\n\t\treturn code;\n\t}\n\n\treplacements.sort((a, b) => b.start - a.start);\n\tlet sanitized = code;\n\tfor (const { start, end, replacement } of replacements) {\n\t\tsanitized = `${sanitized.slice(0, start)}${replacement}${sanitized.slice(end)}`;\n\t}\n\treturn sanitized;\n}\n\ntype TopLevelNode = Statement | ModuleDeclaration;\n\nfunction parseProgram(code: string): Program | undefined {\n\ttry {\n\t\treturn parse(code, {\n\t\t\tecmaVersion: \"latest\",\n\t\t\tsourceType: \"module\",\n\t\t});\n\t} catch {\n\t\ttry {\n\t\t\treturn parse(code, {\n\t\t\t\tecmaVersion: \"latest\",\n\t\t\t\tsourceType: \"script\",\n\t\t\t\tallowReturnOutsideFunction: true,\n\t\t\t\tallowAwaitOutsideFunction: true,\n\t\t\t\tallowSuperOutsideMethod: true,\n\t\t\t});\n\t\t} catch {\n\t\t\treturn undefined;\n\t\t}\n\t}\n}\n\nfunction getNameFromTopLevelNode(node: TopLevelNode): string | undefined {\n\tswitch (node.type) {\n\t\tcase \"FunctionDeclaration\": {\n\t\t\treturn getFunctionIdentifier(node);\n\t\t}\n\t\tcase \"VariableDeclaration\": {\n\t\t\treturn getNameFromVariableDeclaration(node);\n\t\t}\n\t\tcase \"ExpressionStatement\": {\n\t\t\treturn getNameFromExpression(node.expression);\n\t\t}\n\t\tcase \"ExportNamedDeclaration\": {\n\t\t\treturn getNameFromExportNamed(node);\n\t\t}\n\t\tcase \"ExportDefaultDeclaration\": {\n\t\t\treturn getNameFromExportDefault(node);\n\t\t}\n\t\tdefault: {\n\t\t\treturn undefined;\n\t\t}\n\t}\n}\n\nfunction getNameFromVariableDeclaration(node: VariableDeclaration): string | undefined {\n\tfor (const declarator of node.declarations) {\n\t\tconst name = getIdentifierFromPattern(declarator.id);\n\t\tif (name === undefined) {\n\t\t\tcontinue;\n\t\t}\n\n\t\tif (isFunctionLikeExpression(declarator.init)) {\n\t\t\treturn name;\n\t\t}\n\t}\n\n\treturn undefined;\n}\n\nfunction getNameFromExpression(\n\texpression: Expression | Literal | undefined,\n): string | undefined {\n\tif (!isAssignmentExpression(expression)) {\n\t\treturn undefined;\n\t}\n\n\tif (expression.operator !== \"=\") {\n\t\treturn undefined;\n\t}\n\n\tconst target = getIdentifierFromPattern(expression.left);\n\tif (target === undefined) {\n\t\treturn undefined;\n\t}\n\n\treturn isFunctionLikeExpression(expression.right) ? target : undefined;\n}\n\nfunction getNameFromExportNamed(node: ExportNamedDeclaration): string | undefined {\n\tconst declaration = node.declaration;\n\tif (declaration !== undefined && declaration !== null) {\n\t\tif (declaration.type === \"FunctionDeclaration\") {\n\t\t\tconst name = getFunctionIdentifier(declaration);\n\t\t\tif (name !== undefined) {\n\t\t\t\treturn name;\n\t\t\t}\n\t\t} else if (declaration.type === \"VariableDeclaration\") {\n\t\t\tconst name = getNameFromVariableDeclaration(declaration);\n\t\t\tif (name !== undefined) {\n\t\t\t\treturn name;\n\t\t\t}\n\t\t}\n\t}\n\n\tif (node.source === undefined || node.source === null) {\n\t\tfor (const specifier of node.specifiers) {\n\t\t\tconst localName = getIdentifierName(specifier.local);\n\t\t\tif (localName !== undefined) {\n\t\t\t\treturn localName;\n\t\t\t}\n\t\t}\n\t}\n\n\treturn undefined;\n}\n\nfunction getNameFromExportDefault(node: ExportDefaultDeclaration): string | undefined {\n\tconst declaration = node.declaration;\n\tif (declaration.type === \"Identifier\") {\n\t\treturn declaration.name;\n\t}\n\n\tif (\n\t\tdeclaration.type === \"FunctionDeclaration\" ||\n\t\tdeclaration.type === \"FunctionExpression\"\n\t) {\n\t\treturn getFunctionIdentifier(declaration);\n\t}\n\n\treturn undefined;\n}\n\nfunction isAssignmentExpression(\n\texpression: Expression | Literal | undefined,\n): expression is AssignmentExpression {\n\treturn expression?.type === \"AssignmentExpression\";\n}\n\nfunction getIdentifierFromPattern(pattern: Pattern): string | undefined {\n\tif (pattern.type === \"Identifier\") {\n\t\treturn pattern.name;\n\t}\n\treturn undefined;\n}\n\nfunction isFunctionLikeExpression(\n\texpression: Expression | null | undefined,\n): expression is FunctionExpression | ArrowFunctionExpression {\n\treturn (\n\t\texpression?.type === \"FunctionExpression\" || expression?.type === \"ArrowFunctionExpression\"\n\t);\n}\n\nfunction getFunctionIdentifier(\n\tfn: FunctionDeclaration | FunctionExpression | { id?: Identifier | null },\n): string | undefined {\n\tconst id = fn.id;\n\tif (id === undefined || id === null) {\n\t\treturn undefined;\n\t}\n\treturn id.name;\n}\n\nfunction getIdentifierName(node: Identifier | Literal): string | undefined {\n\tif (node.type === \"Identifier\") {\n\t\treturn node.name;\n\t}\n\treturn undefined;\n}\n"]}