@fluidframework/ai-collab 2.10.0-306579

package/lib/explicit-strategy/promptGeneration.js

@@ -0,0 +1,208 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { assert } from "@fluidframework/core-utils/internal";
+import { NodeKind, getJsonSchema, getSimpleSchema, Tree, } from "@fluidframework/tree/internal";
+// eslint-disable-next-line import/no-internal-modules
+import { createZodJsonValidator } from "typechat/zod";
+import { objectIdKey } from "./agentEditTypes.js";
+import { generateGenericEditTypes } from "./typeGeneration.js";
+import { fail } from "./utils.js";
+/**
+ * TBD
+ */
+export function toDecoratedJson(idGenerator, root) {
+    idGenerator.assignIds(root);
+    const stringified = JSON.stringify(root, (_, value) => {
+        if (typeof value === "object" && !Array.isArray(value) && value !== null) {
+            // TODO: SharedTree Team needs to either publish TreeNode as a class to use .instanceof() or a typeguard.
+            // Uncomment this assertion back once we have a typeguard ready.
+            // assert(isTreeNode(node), "Non-TreeNode value in tree.");
+            const objId = 
+            // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
+            idGenerator.getId(value) ?? fail("ID of new node should have been assigned.");
+            assert(!Object.prototype.hasOwnProperty.call(value, objectIdKey), `Collision of object id property.`);
+            return {
+                [objectIdKey]: objId,
+                ...value,
+            };
+        }
+        return value;
+    });
+    return stringified;
+}
+/**
+ * Generates a prompt designed to make an LLM produce a plan to edit the SharedTree to accomplish a user-specified goal.
+ */
+export function getPlanningSystemPrompt(treeNode, userPrompt, systemRoleContext) {
+    const schema = Tree.schema(treeNode);
+    const promptFriendlySchema = getPromptFriendlyTreeSchema(getJsonSchema(schema));
+    const role = `I'm an agent who makes plans for another agent to achieve a user-specified goal to update the state of an application.${systemRoleContext === undefined
+        ? ""
+        : `
+			The other agent follows this guidance: ${systemRoleContext}`}`;
+    const systemPrompt = `
+	${role}
+	The application state tree is a JSON object with the following schema: ${promptFriendlySchema}
+	The current state is: ${JSON.stringify(treeNode)}.
+	The user requested that I accomplish the following goal:
+	"${userPrompt}"
+	I've made a plan to accomplish this goal by doing a sequence of edits to the tree.
+	Edits can include setting the root, inserting, modifying, removing, or moving elements in the tree.
+	Here is my plan:`;
+    return systemPrompt;
+}
+/**
+ * Generates a prompt that provides a history of the edits an LLM has made to a SharedTree as well as any errors that occured from attemping to apply each respsecitve edit to the tree.
+ */
+export function createEditListHistoryPrompt(edits) {
+    return edits
+        .map((edit, index) => {
+        const error = edit.error === undefined
+            ? ""
+            : ` This edit produced an error, and was discarded. The error message was: "${edit.error}"`;
+        return `${index + 1}. ${JSON.stringify(edit.edit)}${error}`;
+    })
+        .join("\n");
+}
+/**
+ * Generates the main prompt of this explicit strategy.
+ * This prompt is designed to give an LLM instructions on how it can modify a SharedTree using specific types of {@link TreeEdit}'s
+ * and provides with both a serialized version of the current state of the provided tree node as well as  the interfaces that compromise said tree nodes data.
+ */
+export function getEditingSystemPrompt(userPrompt, idGenerator, treeNode, log, appGuidance, plan) {
+    const schema = Tree.schema(treeNode);
+    const promptFriendlySchema = getPromptFriendlyTreeSchema(getJsonSchema(schema));
+    const decoratedTreeJson = toDecoratedJson(idGenerator, treeNode);
+    const role = `You are a collaborative agent who interacts with a JSON tree by performing edits to achieve a user-specified goal.${appGuidance === undefined
+        ? ""
+        : `
+			The application that owns the JSON tree has the following guidance about your role: ${appGuidance}`}`;
+    const treeSchemaString = createZodJsonValidator(...generateGenericEditTypes(getSimpleSchema(schema), false)).getSchemaText();
+    // TODO: security: user prompt in system prompt
+    const systemPrompt = `
+	${role}
+	Edits are JSON objects that conform to the following schema.
+	The top level object you produce is an "EditWrapper" object which contains one of "Insert", "Modify", "Remove", "Move", or null.
+	${treeSchemaString}
+	The tree is a JSON object with the following schema: ${promptFriendlySchema}
+	${plan === undefined ? "" : `You have made a plan to accomplish the user's goal. The plan is: "${plan}". You will perform one or more edits that correspond to that plan to accomplish the goal.`}
+	${log.length === 0
+        ? ""
+        : `You have already performed the following edits:
+			${createEditListHistoryPrompt(log)}
+			This means that the current state of the tree reflects these changes.`}
+	The current state of the tree is: ${decoratedTreeJson}.
+	${log.length > 0 ? "Before you made the above edits t" : "T"}he user requested you accomplish the following goal:
+	"${userPrompt}"
+	If the goal is now completed or is impossible, you should return null.
+	Otherwise, you should create an edit that makes progress towards the goal. It should have an English description ("explanation") of which edit to perform (specifying one of the allowed edit types).`;
+    return systemPrompt;
+}
+/**
+ * Generates a prompt designed to make an LLM review the edits it created and applied to a SharedTree based
+ * on a user-specified goal. This prompt is designed to give the LLM's ability to correct for mistakes and improve the accuracy/fidelity of its final set of tree edits
+ */
+export function getReviewSystemPrompt(userPrompt, idGenerator, treeNode, originalDecoratedJson, appGuidance) {
+    const schema = Tree.schema(treeNode);
+    const promptFriendlySchema = getPromptFriendlyTreeSchema(getJsonSchema(schema));
+    const decoratedTreeJson = toDecoratedJson(idGenerator, treeNode);
+    const role = `You are a collaborative agent who interacts with a JSON tree by performing edits to achieve a user-specified goal.${appGuidance === undefined
+        ? ""
+        : `
+			The application that owns the JSON tree has the following guidance: ${appGuidance}`}`;
+    // TODO: security: user prompt in system prompt
+    const systemPrompt = `
+	${role}
+	You have performed a number of actions already to accomplish a user request.
+	You must review the resulting state to determine if the actions you performed successfully accomplished the user's goal.
+	The tree is a JSON object with the following schema: ${promptFriendlySchema}
+	The state of the tree BEFORE changes was: ${originalDecoratedJson}.
+	The state of the tree AFTER changes is: ${decoratedTreeJson}.
+	The user requested that the following goal should be accomplished:
+	${userPrompt}
+	Was the goal accomplished?`;
+    return systemPrompt;
+}
+/**
+ * Converts a fully-qualified SharedTree schema name to a single-word name for use in textual TypeScript-style types.
+ *
+ * @remarks
+ * - TODO: Determine what to do with user-provided names that include periods (e.g. "Foo.Bar").
+ * - TODO: Should probably ensure name starts with an uppercase character.
+ */
+export function getPromptFriendlyTreeSchema(jsonSchema) {
+    let stringifiedSchema = "";
+    for (const [name, def] of Object.entries(jsonSchema.$defs)) {
+        if (def.type !== "object" || def._treeNodeSchemaKind === NodeKind.Map) {
+            continue;
+        }
+        let stringifiedEntry = `interface ${getFriendlySchemaName(name)} {`;
+        for (const [fieldName, fieldSchema] of Object.entries(def.properties)) {
+            let typeString;
+            if (isJsonSchemaRef(fieldSchema)) {
+                const nextFieldName = fieldSchema.$ref;
+                const nextDef = getDef(jsonSchema.$defs, nextFieldName);
+                typeString = `${getTypeString(jsonSchema.$defs, [nextFieldName, nextDef])}`;
+            }
+            else {
+                typeString = `${getAnyOfTypeString(jsonSchema.$defs, fieldSchema.anyOf, true)}`;
+            }
+            if (def.required && !def.required.includes(fieldName)) {
+                typeString = `${typeString} | undefined`;
+            }
+            stringifiedEntry += ` ${fieldName}: ${typeString};`;
+        }
+        stringifiedEntry += " }";
+        stringifiedSchema += (stringifiedSchema === "" ? "" : " ") + stringifiedEntry;
+    }
+    return stringifiedSchema;
+}
+function getTypeString(defs, [name, currentDef]) {
+    const { _treeNodeSchemaKind } = currentDef;
+    if (_treeNodeSchemaKind === NodeKind.Leaf) {
+        return currentDef.type;
+    }
+    if (_treeNodeSchemaKind === NodeKind.Object) {
+        return getFriendlySchemaName(name);
+    }
+    if (_treeNodeSchemaKind === NodeKind.Array) {
+        const items = currentDef.items;
+        const innerType = isJsonSchemaRef(items)
+            ? getTypeString(defs, [items.$ref, getDef(defs, items.$ref)])
+            : getAnyOfTypeString(defs, items.anyOf);
+        return `${innerType}[]`;
+    }
+    fail("Non-object, non-leaf, non-array schema type.");
+}
+function getAnyOfTypeString(defs, refList, topLevel = false) {
+    const typeNames = [];
+    for (const ref of refList) {
+        typeNames.push(getTypeString(defs, [ref.$ref, getDef(defs, ref.$ref)]));
+    }
+    const typeString = typeNames.join(" | ");
+    return topLevel ? typeString : `(${typeString})`;
+}
+function isJsonSchemaRef(field) {
+    return field.$ref !== undefined;
+}
+function getDef(defs, ref) {
+    // strip the "#/$defs/" prefix
+    const strippedRef = ref.slice(8);
+    const nextDef = defs[strippedRef];
+    assert(nextDef !== undefined, "Ref not found.");
+    return nextDef;
+}
+/**
+ * TBD
+ */
+export function getFriendlySchemaName(schemaName) {
+    const matches = schemaName.match(/[^.]+$/);
+    if (matches === null) {
+        // empty scope
+        return schemaName;
+    }
+    return matches[0];
+}
+//# sourceMappingURL=promptGeneration.js.map

package/lib/explicit-strategy/promptGeneration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"promptGeneration.js","sourceRoot":"","sources":["../../src/explicit-strategy/promptGeneration.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAC7D,OAAO,EACN,QAAQ,EAGR,aAAa,EAKb,eAAe,EACf,IAAI,GAEJ,MAAM,+BAA+B,CAAC;AACvC,sDAAsD;AACtD,OAAO,EAAE,sBAAsB,EAAE,MAAM,cAAc,CAAC;AAEtD,OAAO,EAAE,WAAW,EAAiB,MAAM,qBAAqB,CAAC;AAEjE,OAAO,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAC;AAC/D,OAAO,EAAE,IAAI,EAAE,MAAM,YAAY,CAAC;AAWlC;;GAEG;AACH,MAAM,UAAU,eAAe,CAC9B,WAAwB,EACxB,IAAqD;IAErD,WAAW,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;IAC5B,MAAM,WAAW,GAAW,IAAI,CAAC,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE;QAC7D,IAAI,OAAO,KAAK,KAAK,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YAC1E,yGAAyG;YACzG,gEAAgE;YAChE,2DAA2D;YAC3D,MAAM,KAAK;YACV,iEAAiE;YACjE,WAAW,CAAC,KAAK,CAAC,KAAK,CAAC,IAAI,IAAI,CAAC,2CAA2C,CAAC,CAAC;YAC/E,MAAM,CACL,CAAC,MAAM,CAAC,SAAS,CAAC,cAAc,CAAC,IAAI,CAAC,KAAK,EAAE,WAAW,CAAC,EACzD,kCAAkC,CAClC,CAAC;YACF,OAAO;gBACN,CAAC,WAAW,CAAC,EAAE,KAAK;gBACpB,GAAG,KAAK;aACG,CAAC;QACd,CAAC;QACD,OAAO,KAAgB,CAAC;IACzB,CAAC,CAAC,CAAC;IACH,OAAO,WAAW,CAAC;AACpB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,uBAAuB,CACtC,QAAkB,EAClB,UAAkB,EAClB,iBAA0B;IAE1B,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IAErC,MAAM,oBAAoB,GAAG,2BAA2B,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;IAChF,MAAM,IAAI,GAAG,yHACZ,iBAAiB,KAAK,SAAS;QAC9B,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC;4CACuC,iBAAiB,EAC5D,EAAE,CAAC;IAEH,MAAM,YAAY,GAAG;GACnB,IAAI;0EACmE,oBAAoB;yBACrE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;;IAE7C,UAAU;;;kBAGI,CAAC;IAElB,OAAO,YAAY,CAAC;AACrB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,2BAA2B,CAAC,KAAc;IACzD,OAAO,KAAK;SACV,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QACpB,MAAM,KAAK,GACV,IAAI,CAAC,KAAK,KAAK,SAAS;YACvB,CAAC,CAAC,EAAE;YACJ,CAAC,CAAC,4EAA4E,IAAI,CAAC,KAAK,GAAG,CAAC;QAC9F,OAAO,GAAG,KAAK,GAAG,CAAC,KAAK,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,KAAK,EAAE,CAAC;IAC7D,CAAC,CAAC;SACD,IAAI,CAAC,IAAI,CAAC,CAAC;AACd,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,sBAAsB,CACrC,UAAkB,EAClB,WAAwB,EACxB,QAAkB,EAClB,GAAY,EACZ,WAAoB,EACpB,IAAa;IAEb,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACrC,MAAM,oBAAoB,GAAG,2BAA2B,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;IAChF,MAAM,iBAAiB,GAAG,eAAe,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IAEjE,MAAM,IAAI,GAAG,qHACZ,WAAW,KAAK,SAAS;QACxB,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC;yFACoF,WAAW,EACnG,EAAE,CAAC;IAEH,MAAM,gBAAgB,GAAG,sBAAsB,CAC9C,GAAG,wBAAwB,CAAC,eAAe,CAAC,MAAM,CAAC,EAAE,KAAK,CAAC,CAC3D,CAAC,aAAa,EAAE,CAAC;IAElB,+CAA+C;IAC/C,MAAM,YAAY,GAAG;GACnB,IAAI;;;GAGJ,gBAAgB;wDACqC,oBAAoB;GACzE,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,qEAAqE,IAAI,4FAA4F;GAEhM,GAAG,CAAC,MAAM,KAAK,CAAC;QACf,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC;KACA,2BAA2B,CAAC,GAAG,CAAC;yEAEpC;qCACoC,iBAAiB;GACnD,GAAG,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,mCAAmC,CAAC,CAAC,CAAC,GAAG;IACzD,UAAU;;uMAEyL,CAAC;IACvM,OAAO,YAAY,CAAC;AACrB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,qBAAqB,CACpC,UAAkB,EAClB,WAAwB,EACxB,QAAkB,EAClB,qBAA6B,EAC7B,WAAoB;IAEpB,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;IACrC,MAAM,oBAAoB,GAAG,2BAA2B,CAAC,aAAa,CAAC,MAAM,CAAC,CAAC,CAAC;IAChF,MAAM,iBAAiB,GAAG,eAAe,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;IAEjE,MAAM,IAAI,GAAG,qHACZ,WAAW,KAAK,SAAS;QACxB,CAAC,CAAC,EAAE;QACJ,CAAC,CAAC;yEACoE,WAAW,EACnF,EAAE,CAAC;IAEH,+CAA+C;IAC/C,MAAM,YAAY,GAAG;GACnB,IAAI;;;wDAGiD,oBAAoB;6CAC/B,qBAAqB;2CACvB,iBAAiB;;GAEzD,UAAU;4BACe,CAAC;IAC5B,OAAO,YAAY,CAAC;AACrB,CAAC;AAED;;;;;;GAMG;AACH,MAAM,UAAU,2BAA2B,CAAC,UAA0B;IACrE,IAAI,iBAAiB,GAAG,EAAE,CAAC;IAC3B,KAAK,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5D,IAAI,GAAG,CAAC,IAAI,KAAK,QAAQ,IAAI,GAAG,CAAC,mBAAmB,KAAK,QAAQ,CAAC,GAAG,EAAE,CAAC;YACvE,SAAS;QACV,CAAC;QAED,IAAI,gBAAgB,GAAG,aAAa,qBAAqB,CAAC,IAAI,CAAC,IAAI,CAAC;QAEpE,KAAK,MAAM,CAAC,SAAS,EAAE,WAAW,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,CAAC,EAAE,CAAC;YACvE,IAAI,UAAkB,CAAC;YACvB,IAAI,eAAe,CAAC,WAAW,CAAC,EAAE,CAAC;gBAClC,MAAM,aAAa,GAAG,WAAW,CAAC,IAAI,CAAC;gBACvC,MAAM,OAAO,GAAG,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,aAAa,CAAC,CAAC;gBACxD,UAAU,GAAG,GAAG,aAAa,CAAC,UAAU,CAAC,KAAK,EAAE,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC,EAAE,CAAC;YAC7E,CAAC;iBAAM,CAAC;gBACP,UAAU,GAAG,GAAG,kBAAkB,CAAC,UAAU,CAAC,KAAK,EAAE,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC;YACjF,CAAC;YACD,IAAI,GAAG,CAAC,QAAQ,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;gBACvD,UAAU,GAAG,GAAG,UAAU,cAAc,CAAC;YAC1C,CAAC;YACD,gBAAgB,IAAI,IAAI,SAAS,KAAK,UAAU,GAAG,CAAC;QACrD,CAAC;QAED,gBAAgB,IAAI,IAAI,CAAC;QAEzB,iBAAiB,IAAI,CAAC,iBAAiB,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,gBAAgB,CAAC;IAC/E,CAAC;IACD,OAAO,iBAAiB,CAAC;AAC1B,CAAC;AAED,SAAS,aAAa,CACrB,IAAoC,EACpC,CAAC,IAAI,EAAE,UAAU,CAA2B;IAE5C,MAAM,EAAE,mBAAmB,EAAE,GAAG,UAAU,CAAC;IAC3C,IAAI,mBAAmB,KAAK,QAAQ,CAAC,IAAI,EAAE,CAAC;QAC3C,OAAO,UAAU,CAAC,IAAI,CAAC;IACxB,CAAC;IACD,IAAI,mBAAmB,KAAK,QAAQ,CAAC,MAAM,EAAE,CAAC;QAC7C,OAAO,qBAAqB,CAAC,IAAI,CAAC,CAAC;IACpC,CAAC;IACD,IAAI,mBAAmB,KAAK,QAAQ,CAAC,KAAK,EAAE,CAAC;QAC5C,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC;QAC/B,MAAM,SAAS,GAAG,eAAe,CAAC,KAAK,CAAC;YACvC,CAAC,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;YAC7D,CAAC,CAAC,kBAAkB,CAAC,IAAI,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;QACzC,OAAO,GAAG,SAAS,IAAI,CAAC;IACzB,CAAC;IACD,IAAI,CAAC,8CAA8C,CAAC,CAAC;AACtD,CAAC;AAED,SAAS,kBAAkB,CAC1B,IAAoC,EACpC,OAAwB,EACxB,QAAQ,GAAG,KAAK;IAEhB,MAAM,SAAS,GAAa,EAAE,CAAC;IAC/B,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;QAC3B,SAAS,CAAC,IAAI,CAAC,aAAa,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;IACzE,CAAC;IACD,MAAM,UAAU,GAAG,SAAS,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACzC,OAAO,QAAQ,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,IAAI,UAAU,GAAG,CAAC;AAClD,CAAC;AAED,SAAS,eAAe,CAAC,KAAsB;IAC9C,OAAQ,KAAuB,CAAC,IAAI,KAAK,SAAS,CAAC;AACpD,CAAC;AAED,SAAS,MAAM,CAAC,IAAoC,EAAE,GAAW;IAChE,8BAA8B;IAC9B,MAAM,WAAW,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACjC,MAAM,OAAO,GAAG,IAAI,CAAC,WAAW,CAAC,CAAC;IAClC,MAAM,CAAC,OAAO,KAAK,SAAS,EAAE,gBAAgB,CAAC,CAAC;IAChD,OAAO,OAAO,CAAC;AAChB,CAAC;AAED;;GAEG;AACH,MAAM,UAAU,qBAAqB,CAAC,UAAkB;IACvD,MAAM,OAAO,GAAG,UAAU,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;IAC3C,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;QACtB,cAAc;QACd,OAAO,UAAU,CAAC;IACnB,CAAC;IACD,OAAO,OAAO,CAAC,CAAC,CAAC,CAAC;AACnB,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport {\n\tNodeKind,\n\ttype ImplicitFieldSchema,\n\ttype TreeFieldFromImplicitField,\n\tgetJsonSchema,\n\ttype JsonFieldSchema,\n\ttype JsonNodeSchema,\n\ttype JsonSchemaRef,\n\ttype JsonTreeSchema,\n\tgetSimpleSchema,\n\tTree,\n\ttype TreeNode,\n} from \"@fluidframework/tree/internal\";\n// eslint-disable-next-line import/no-internal-modules\nimport { createZodJsonValidator } from \"typechat/zod\";\n\nimport { objectIdKey, type TreeEdit } from \"./agentEditTypes.js\";\nimport type { IdGenerator } from \"./idGenerator.js\";\nimport { generateGenericEditTypes } from \"./typeGeneration.js\";\nimport { fail } from \"./utils.js\";\n\n/**\n * A log of edits that have been made to a tree.\n * @remarks This is primarily used to help an LLM keep track of the active changes it has made.\n */\nexport type EditLog = {\n\tedit: TreeEdit;\n\terror?: string;\n}[];\n\n/**\n * TBD\n */\nexport function toDecoratedJson(\n\tidGenerator: IdGenerator,\n\troot: TreeFieldFromImplicitField<ImplicitFieldSchema>,\n): string {\n\tidGenerator.assignIds(root);\n\tconst stringified: string = JSON.stringify(root, (_, value) => {\n\t\tif (typeof value === \"object\" && !Array.isArray(value) && value !== null) {\n\t\t\t// TODO: SharedTree Team needs to either publish TreeNode as a class to use .instanceof() or a typeguard.\n\t\t\t// Uncomment this assertion back once we have a typeguard ready.\n\t\t\t// assert(isTreeNode(node), \"Non-TreeNode value in tree.\");\n\t\t\tconst objId =\n\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-argument\n\t\t\t\tidGenerator.getId(value) ?? fail(\"ID of new node should have been assigned.\");\n\t\t\tassert(\n\t\t\t\t!Object.prototype.hasOwnProperty.call(value, objectIdKey),\n\t\t\t\t`Collision of object id property.`,\n\t\t\t);\n\t\t\treturn {\n\t\t\t\t[objectIdKey]: objId,\n\t\t\t\t...value,\n\t\t\t} as unknown;\n\t\t}\n\t\treturn value as unknown;\n\t});\n\treturn stringified;\n}\n\n/**\n * Generates a prompt designed to make an LLM produce a plan to edit the SharedTree to accomplish a user-specified goal.\n */\nexport function getPlanningSystemPrompt(\n\ttreeNode: TreeNode,\n\tuserPrompt: string,\n\tsystemRoleContext?: string,\n): string {\n\tconst schema = Tree.schema(treeNode);\n\n\tconst promptFriendlySchema = getPromptFriendlyTreeSchema(getJsonSchema(schema));\n\tconst role = `I'm an agent who makes plans for another agent to achieve a user-specified goal to update the state of an application.${\n\t\tsystemRoleContext === undefined\n\t\t\t? \"\"\n\t\t\t: `\n\t\t\tThe other agent follows this guidance: ${systemRoleContext}`\n\t}`;\n\n\tconst systemPrompt = `\n\t${role}\n\tThe application state tree is a JSON object with the following schema: ${promptFriendlySchema}\n\tThe current state is: ${JSON.stringify(treeNode)}.\n\tThe user requested that I accomplish the following goal:\n\t\"${userPrompt}\"\n\tI've made a plan to accomplish this goal by doing a sequence of edits to the tree.\n\tEdits can include setting the root, inserting, modifying, removing, or moving elements in the tree.\n\tHere is my plan:`;\n\n\treturn systemPrompt;\n}\n\n/**\n * Generates a prompt that provides a history of the edits an LLM has made to a SharedTree as well as any errors that occured from attemping to apply each respsecitve edit to the tree.\n */\nexport function createEditListHistoryPrompt(edits: EditLog): string {\n\treturn edits\n\t\t.map((edit, index) => {\n\t\t\tconst error =\n\t\t\t\tedit.error === undefined\n\t\t\t\t\t? \"\"\n\t\t\t\t\t: ` This edit produced an error, and was discarded. The error message was: \"${edit.error}\"`;\n\t\t\treturn `${index + 1}. ${JSON.stringify(edit.edit)}${error}`;\n\t\t})\n\t\t.join(\"\\n\");\n}\n\n/**\n * Generates the main prompt of this explicit strategy.\n * This prompt is designed to give an LLM instructions on how it can modify a SharedTree using specific types of {@link TreeEdit}'s\n * and provides with both a serialized version of the current state of the provided tree node as well as  the interfaces that compromise said tree nodes data.\n */\nexport function getEditingSystemPrompt(\n\tuserPrompt: string,\n\tidGenerator: IdGenerator,\n\ttreeNode: TreeNode,\n\tlog: EditLog,\n\tappGuidance?: string,\n\tplan?: string,\n): string {\n\tconst schema = Tree.schema(treeNode);\n\tconst promptFriendlySchema = getPromptFriendlyTreeSchema(getJsonSchema(schema));\n\tconst decoratedTreeJson = toDecoratedJson(idGenerator, treeNode);\n\n\tconst role = `You are a collaborative agent who interacts with a JSON tree by performing edits to achieve a user-specified goal.${\n\t\tappGuidance === undefined\n\t\t\t? \"\"\n\t\t\t: `\n\t\t\tThe application that owns the JSON tree has the following guidance about your role: ${appGuidance}`\n\t}`;\n\n\tconst treeSchemaString = createZodJsonValidator(\n\t\t...generateGenericEditTypes(getSimpleSchema(schema), false),\n\t).getSchemaText();\n\n\t// TODO: security: user prompt in system prompt\n\tconst systemPrompt = `\n\t${role}\n\tEdits are JSON objects that conform to the following schema.\n\tThe top level object you produce is an \"EditWrapper\" object which contains one of \"Insert\", \"Modify\", \"Remove\", \"Move\", or null.\n\t${treeSchemaString}\n\tThe tree is a JSON object with the following schema: ${promptFriendlySchema}\n\t${plan === undefined ? \"\" : `You have made a plan to accomplish the user's goal. The plan is: \"${plan}\". You will perform one or more edits that correspond to that plan to accomplish the goal.`}\n\t${\n\t\tlog.length === 0\n\t\t\t? \"\"\n\t\t\t: `You have already performed the following edits:\n\t\t\t${createEditListHistoryPrompt(log)}\n\t\t\tThis means that the current state of the tree reflects these changes.`\n\t}\n\tThe current state of the tree is: ${decoratedTreeJson}.\n\t${log.length > 0 ? \"Before you made the above edits t\" : \"T\"}he user requested you accomplish the following goal:\n\t\"${userPrompt}\"\n\tIf the goal is now completed or is impossible, you should return null.\n\tOtherwise, you should create an edit that makes progress towards the goal. It should have an English description (\"explanation\") of which edit to perform (specifying one of the allowed edit types).`;\n\treturn systemPrompt;\n}\n\n/**\n * Generates a prompt designed to make an LLM review the edits it created and applied to a SharedTree based\n * on a user-specified goal. This prompt is designed to give the LLM's ability to correct for mistakes and improve the accuracy/fidelity of its final set of tree edits\n */\nexport function getReviewSystemPrompt(\n\tuserPrompt: string,\n\tidGenerator: IdGenerator,\n\ttreeNode: TreeNode,\n\toriginalDecoratedJson: string,\n\tappGuidance?: string,\n): string {\n\tconst schema = Tree.schema(treeNode);\n\tconst promptFriendlySchema = getPromptFriendlyTreeSchema(getJsonSchema(schema));\n\tconst decoratedTreeJson = toDecoratedJson(idGenerator, treeNode);\n\n\tconst role = `You are a collaborative agent who interacts with a JSON tree by performing edits to achieve a user-specified goal.${\n\t\tappGuidance === undefined\n\t\t\t? \"\"\n\t\t\t: `\n\t\t\tThe application that owns the JSON tree has the following guidance: ${appGuidance}`\n\t}`;\n\n\t// TODO: security: user prompt in system prompt\n\tconst systemPrompt = `\n\t${role}\n\tYou have performed a number of actions already to accomplish a user request.\n\tYou must review the resulting state to determine if the actions you performed successfully accomplished the user's goal.\n\tThe tree is a JSON object with the following schema: ${promptFriendlySchema}\n\tThe state of the tree BEFORE changes was: ${originalDecoratedJson}.\n\tThe state of the tree AFTER changes is: ${decoratedTreeJson}.\n\tThe user requested that the following goal should be accomplished:\n\t${userPrompt}\n\tWas the goal accomplished?`;\n\treturn systemPrompt;\n}\n\n/**\n * Converts a fully-qualified SharedTree schema name to a single-word name for use in textual TypeScript-style types.\n *\n * @remarks\n * - TODO: Determine what to do with user-provided names that include periods (e.g. \"Foo.Bar\").\n * - TODO: Should probably ensure name starts with an uppercase character.\n */\nexport function getPromptFriendlyTreeSchema(jsonSchema: JsonTreeSchema): string {\n\tlet stringifiedSchema = \"\";\n\tfor (const [name, def] of Object.entries(jsonSchema.$defs)) {\n\t\tif (def.type !== \"object\" || def._treeNodeSchemaKind === NodeKind.Map) {\n\t\t\tcontinue;\n\t\t}\n\n\t\tlet stringifiedEntry = `interface ${getFriendlySchemaName(name)} {`;\n\n\t\tfor (const [fieldName, fieldSchema] of Object.entries(def.properties)) {\n\t\t\tlet typeString: string;\n\t\t\tif (isJsonSchemaRef(fieldSchema)) {\n\t\t\t\tconst nextFieldName = fieldSchema.$ref;\n\t\t\t\tconst nextDef = getDef(jsonSchema.$defs, nextFieldName);\n\t\t\t\ttypeString = `${getTypeString(jsonSchema.$defs, [nextFieldName, nextDef])}`;\n\t\t\t} else {\n\t\t\t\ttypeString = `${getAnyOfTypeString(jsonSchema.$defs, fieldSchema.anyOf, true)}`;\n\t\t\t}\n\t\t\tif (def.required && !def.required.includes(fieldName)) {\n\t\t\t\ttypeString = `${typeString} | undefined`;\n\t\t\t}\n\t\t\tstringifiedEntry += ` ${fieldName}: ${typeString};`;\n\t\t}\n\n\t\tstringifiedEntry += \" }\";\n\n\t\tstringifiedSchema += (stringifiedSchema === \"\" ? \"\" : \" \") + stringifiedEntry;\n\t}\n\treturn stringifiedSchema;\n}\n\nfunction getTypeString(\n\tdefs: Record<string, JsonNodeSchema>,\n\t[name, currentDef]: [string, JsonNodeSchema],\n): string {\n\tconst { _treeNodeSchemaKind } = currentDef;\n\tif (_treeNodeSchemaKind === NodeKind.Leaf) {\n\t\treturn currentDef.type;\n\t}\n\tif (_treeNodeSchemaKind === NodeKind.Object) {\n\t\treturn getFriendlySchemaName(name);\n\t}\n\tif (_treeNodeSchemaKind === NodeKind.Array) {\n\t\tconst items = currentDef.items;\n\t\tconst innerType = isJsonSchemaRef(items)\n\t\t\t? getTypeString(defs, [items.$ref, getDef(defs, items.$ref)])\n\t\t\t: getAnyOfTypeString(defs, items.anyOf);\n\t\treturn `${innerType}[]`;\n\t}\n\tfail(\"Non-object, non-leaf, non-array schema type.\");\n}\n\nfunction getAnyOfTypeString(\n\tdefs: Record<string, JsonNodeSchema>,\n\trefList: JsonSchemaRef[],\n\ttopLevel = false,\n): string {\n\tconst typeNames: string[] = [];\n\tfor (const ref of refList) {\n\t\ttypeNames.push(getTypeString(defs, [ref.$ref, getDef(defs, ref.$ref)]));\n\t}\n\tconst typeString = typeNames.join(\" | \");\n\treturn topLevel ? typeString : `(${typeString})`;\n}\n\nfunction isJsonSchemaRef(field: JsonFieldSchema): field is JsonSchemaRef {\n\treturn (field as JsonSchemaRef).$ref !== undefined;\n}\n\nfunction getDef(defs: Record<string, JsonNodeSchema>, ref: string): JsonNodeSchema {\n\t// strip the \"#/$defs/\" prefix\n\tconst strippedRef = ref.slice(8);\n\tconst nextDef = defs[strippedRef];\n\tassert(nextDef !== undefined, \"Ref not found.\");\n\treturn nextDef;\n}\n\n/**\n * TBD\n */\nexport function getFriendlySchemaName(schemaName: string): string {\n\tconst matches = schemaName.match(/[^.]+$/);\n\tif (matches === null) {\n\t\t// empty scope\n\t\treturn schemaName;\n\t}\n\treturn matches[0];\n}\n"]}

package/lib/explicit-strategy/typeGeneration.d.ts

@@ -0,0 +1,15 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import type { SimpleTreeSchema } from "@fluidframework/tree/internal";
+/**
+ * Generates a set of ZOD validation objects for the various types of data that can be put into the provided {@link SimpleTreeSchema}
+ * and then uses those sets to generate an all-encompassing ZOD object for each type of {@link TreeEdit} that can validate any of the types of data that can be put into the tree.
+ *
+ * @returns a Record of schema names to Zod validation objects, and the name of the root schema used to encompass all of the other schemas.
+ *
+ * @remarks The return type of this function is designed to work with Typechat's createZodJsonValidator as well as be used as the JSON schema for OpenAi's structured output response format.
+ */
+export declare function generateGenericEditTypes(schema: SimpleTreeSchema, generateDomainTypes: boolean): [Record<string, Zod.ZodTypeAny>, root: string];
+//# sourceMappingURL=typeGeneration.d.ts.map

package/lib/explicit-strategy/typeGeneration.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"typeGeneration.d.ts","sourceRoot":"","sources":["../../src/explicit-strategy/typeGeneration.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAIH,OAAO,KAAK,EAGX,gBAAgB,EAChB,MAAM,+BAA+B,CAAC;AA2EvC;;;;;;;GAOG;AACH,wBAAgB,wBAAwB,CACvC,MAAM,EAAE,gBAAgB,EACxB,mBAAmB,EAAE,OAAO,GAC1B,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,UAAU,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,CA4FhD"}

package/lib/explicit-strategy/typeGeneration.js

@@ -0,0 +1,260 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+import { assert } from "@fluidframework/core-utils/internal";
+import { FieldKind, NodeKind, ValueSchema } from "@fluidframework/tree/internal";
+import { z } from "zod";
+import { objectIdKey, typeField } from "./agentEditTypes.js";
+import { fail, getOrCreate, mapIterable } from "./utils.js";
+/**
+ * Zod Object type used to represent & validate the ObjectTarget type within a {@link TreeEdit}.
+ * @remarks this is used as a component with {@link generateGenericEditTypes} to produce the final zod validation objects.
+ */
+const objectTarget = z.object({
+    target: z
+        .string()
+        .describe(`The id of the object (as specified by the object's ${objectIdKey} property) that is being referenced`),
+});
+/**
+ * Zod Object type used to represent & validate the ObjectPlace type within a {@link TreeEdit}.
+ * @remarks this is used as a component with {@link generateGenericEditTypes} to produce the final zod validation objects.
+ */
+const objectPlace = z
+    .object({
+    type: z.enum(["objectPlace"]),
+    target: z
+        .string()
+        .describe(`The id (${objectIdKey}) of the object that the new/moved object should be placed relative to. This must be the id of an object that already existed in the tree content that was originally supplied.`),
+    place: z
+        .enum(["before", "after"])
+        .describe("Where the new/moved object will be relative to the target object - either just before or just after"),
+})
+    .describe("A pointer to a location either just before or just after an object that is in an array");
+/**
+ * Zod Object type used to represent & validate the ArrayPlace type within a {@link TreeEdit}.
+ * @remarks this is used as a component with {@link generateGenericEditTypes} to produce the final zod validation objects.
+ */
+const arrayPlace = z
+    .object({
+    type: z.enum(["arrayPlace"]),
+    parentId: z
+        .string()
+        .describe(`The id (${objectIdKey}) of the parent object of the array. This must be the id of an object that already existed in the tree content that was originally supplied.`),
+    field: z.string().describe("The key of the array to insert into"),
+    location: z
+        .enum(["start", "end"])
+        .describe("Where to insert into the array - either the start or the end"),
+})
+    .describe(`either the "start" or "end" of an array, as specified by a "parent" ObjectTarget and a "field" name under which the array is stored (useful for prepending or appending)`);
+/**
+ * Zod Object type used to represent & validate the Range type within a {@link TreeEdit}.
+ * @remarks this is used as a component with {@link generateGenericEditTypes} to produce the final zod validation objects.
+ */
+const range = z
+    .object({
+    from: objectPlace,
+    to: objectPlace,
+})
+    .describe('A range of objects in the same array specified by a "from" and "to" Place. The "to" and "from" objects MUST be in the same array.');
+/**
+ * Cache used to prevent repeatedly generating the same Zod validation objects for the same {@link SimpleTreeSchema} as generate propts for repeated calls to an LLM
+ */
+const cache = new WeakMap();
+/**
+ * Generates a set of ZOD validation objects for the various types of data that can be put into the provided {@link SimpleTreeSchema}
+ * and then uses those sets to generate an all-encompassing ZOD object for each type of {@link TreeEdit} that can validate any of the types of data that can be put into the tree.
+ *
+ * @returns a Record of schema names to Zod validation objects, and the name of the root schema used to encompass all of the other schemas.
+ *
+ * @remarks The return type of this function is designed to work with Typechat's createZodJsonValidator as well as be used as the JSON schema for OpenAi's structured output response format.
+ */
+export function generateGenericEditTypes(schema, generateDomainTypes) {
+    return getOrCreate(cache, schema, () => {
+        const insertSet = new Set();
+        const modifyFieldSet = new Set();
+        const modifyTypeSet = new Set();
+        const typeMap = new Map();
+        for (const name of schema.definitions.keys()) {
+            getOrCreateType(schema.definitions, typeMap, insertSet, modifyFieldSet, modifyTypeSet, name);
+        }
+        function getType(allowedTypes) {
+            switch (allowedTypes.size) {
+                case 0: {
+                    return z.never();
+                }
+                case 1: {
+                    return (typeMap.get(tryGetSingleton(allowedTypes) ?? fail("Expected singleton")) ??
+                        fail("Unknown type"));
+                }
+                default: {
+                    const types = Array.from(allowedTypes, (name) => typeMap.get(name) ?? fail("Unknown type"));
+                    assert(hasAtLeastTwo(types), "Expected at least two types");
+                    return z.union(types);
+                }
+            }
+        }
+        const insert = z
+            .object({
+            type: z.literal("insert"),
+            explanation: z.string().describe(editDescription),
+            content: generateDomainTypes
+                ? getType(insertSet)
+                : z.any().describe("Domain-specific content here"),
+            destination: z.union([arrayPlace, objectPlace]),
+        })
+            .describe("Inserts a new object at a specific Place or ArrayPlace.");
+        const remove = z
+            .object({
+            type: z.literal("remove"),
+            explanation: z.string().describe(editDescription),
+            source: z.union([objectTarget, range]),
+        })
+            .describe("Deletes an object or Range of objects from the tree.");
+        const move = z
+            .object({
+            type: z.literal("move"),
+            explanation: z.string().describe(editDescription),
+            source: z.union([objectTarget, range]),
+            destination: z.union([arrayPlace, objectPlace]),
+        })
+            .describe("Moves an object or Range of objects to a new Place or ArrayPlace.");
+        const modify = z
+            .object({
+            type: z.enum(["modify"]),
+            explanation: z.string().describe(editDescription),
+            target: objectTarget,
+            field: z.enum([...modifyFieldSet]), // Modify with appropriate fields
+            modification: generateDomainTypes
+                ? getType(modifyTypeSet)
+                : z.any().describe("Domain-specific content here"),
+        })
+            .describe("Sets a field on a specific ObjectTarget.");
+        const editTypes = [insert, remove, move, modify, z.null()];
+        const editWrapper = z.object({
+            edit: z
+                .union(editTypes)
+                .describe("The next edit to apply to the tree, or null if the task is complete."),
+        });
+        const typeRecord = {
+            ObjectTarget: objectTarget,
+            ObjectPlace: objectPlace,
+            ArrayPlace: arrayPlace,
+            Range: range,
+            Insert: insert,
+            Remove: remove,
+            Move: move,
+            Modify: modify,
+            EditWrapper: editWrapper,
+        };
+        return [typeRecord, "EditWrapper"];
+    });
+}
+const editDescription = "A description of what this edit is meant to accomplish in human readable English";
+function getOrCreateType(definitionMap, typeMap, insertSet, modifyFieldSet, modifyTypeSet, definition) {
+    return getOrCreate(typeMap, definition, () => {
+        const nodeSchema = definitionMap.get(definition) ?? fail("Unexpected definition");
+        switch (nodeSchema.kind) {
+            case NodeKind.Object: {
+                for (const [key, field] of Object.entries(nodeSchema.fields)) {
+                    // TODO: Remove when AI better
+                    if (Array.from(field.allowedTypes, (n) => definitionMap.get(n) ?? fail("Unknown definition")).some((n) => n.kind === NodeKind.Array)) {
+                        continue;
+                    }
+                    modifyFieldSet.add(key);
+                    for (const type of field.allowedTypes) {
+                        modifyTypeSet.add(type);
+                    }
+                }
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment
+                const properties = Object.fromEntries(Object.entries(nodeSchema.fields)
+                    .map(([key, field]) => {
+                    return [
+                        key,
+                        getOrCreateTypeForField(definitionMap, typeMap, insertSet, modifyFieldSet, modifyTypeSet, field),
+                    ];
+                })
+                    .filter(([, value]) => value !== undefined));
+                // eslint-disable-next-line @typescript-eslint/no-unsafe-member-access
+                properties[typeField] = z.enum([definition]);
+                return z.object(properties);
+            }
+            case NodeKind.Array: {
+                for (const [name] of Array.from(nodeSchema.allowedTypes, (n) => [
+                    n,
+                    definitionMap.get(n) ?? fail("Unknown definition"),
+                ]).filter(([_, schema]) => schema.kind === NodeKind.Object || schema.kind === NodeKind.Leaf)) {
+                    insertSet.add(name);
+                }
+                return z.array(getTypeForAllowedTypes(definitionMap, typeMap, insertSet, modifyFieldSet, modifyTypeSet, nodeSchema.allowedTypes));
+            }
+            case NodeKind.Leaf: {
+                switch (nodeSchema.leafKind) {
+                    case ValueSchema.Boolean: {
+                        return z.boolean();
+                    }
+                    case ValueSchema.Number: {
+                        return z.number();
+                    }
+                    case ValueSchema.String: {
+                        return z.string();
+                    }
+                    case ValueSchema.Null: {
+                        return z.null();
+                    }
+                    default: {
+                        throw new Error(`Unsupported leaf kind ${NodeKind[nodeSchema.leafKind]}.`);
+                    }
+                }
+            }
+            default: {
+                throw new Error(`Unsupported node kind ${NodeKind[nodeSchema.kind]}.`);
+            }
+        }
+    });
+}
+function getOrCreateTypeForField(definitionMap, typeMap, insertSet, modifyFieldSet, modifyTypeSet, fieldSchema) {
+    switch (fieldSchema.kind) {
+        case FieldKind.Required: {
+            return getTypeForAllowedTypes(definitionMap, typeMap, insertSet, modifyFieldSet, modifyTypeSet, fieldSchema.allowedTypes);
+        }
+        case FieldKind.Optional: {
+            return z.union([
+                z.null(),
+                getTypeForAllowedTypes(definitionMap, typeMap, insertSet, modifyFieldSet, modifyTypeSet, fieldSchema.allowedTypes),
+            ]);
+        }
+        case FieldKind.Identifier: {
+            return undefined;
+        }
+        default: {
+            throw new Error(`Unsupported field kind ${NodeKind[fieldSchema.kind]}.`);
+        }
+    }
+}
+function getTypeForAllowedTypes(definitionMap, typeMap, insertSet, modifyFieldSet, modifyTypeSet, allowedTypes) {
+    const single = tryGetSingleton(allowedTypes);
+    if (single === undefined) {
+        const types = [
+            ...mapIterable(allowedTypes, (name) => {
+                return getOrCreateType(definitionMap, typeMap, insertSet, modifyFieldSet, modifyTypeSet, name);
+            }),
+        ];
+        assert(hasAtLeastTwo(types), "Expected at least two types");
+        return z.union(types);
+    }
+    else {
+        return getOrCreateType(definitionMap, typeMap, insertSet, modifyFieldSet, modifyTypeSet, single);
+    }
+}
+function tryGetSingleton(set) {
+    if (set.size === 1) {
+        for (const item of set) {
+            return item;
+        }
+    }
+}
+function hasAtLeastTwo(array) {
+    return array.length >= 2;
+}
+//# sourceMappingURL=typeGeneration.js.map

package/lib/explicit-strategy/typeGeneration.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"typeGeneration.js","sourceRoot":"","sources":["../../src/explicit-strategy/typeGeneration.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,EAAE,MAAM,EAAE,MAAM,qCAAqC,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,+BAA+B,CAAC;AAMjF,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,OAAO,EAAE,WAAW,EAAE,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAC7D,OAAO,EAAE,IAAI,EAAE,WAAW,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE5D;;;GAGG;AACH,MAAM,YAAY,GAAG,CAAC,CAAC,MAAM,CAAC;IAC7B,MAAM,EAAE,CAAC;SACP,MAAM,EAAE;SACR,QAAQ,CACR,sDAAsD,WAAW,qCAAqC,CACtG;CACF,CAAC,CAAC;AACH;;;GAGG;AACH,MAAM,WAAW,GAAG,CAAC;KACnB,MAAM,CAAC;IACP,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC,CAAC;IAC7B,MAAM,EAAE,CAAC;SACP,MAAM,EAAE;SACR,QAAQ,CACR,WAAW,WAAW,iLAAiL,CACvM;IACF,KAAK,EAAE,CAAC;SACN,IAAI,CAAC,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;SACzB,QAAQ,CACR,qGAAqG,CACrG;CACF,CAAC;KACD,QAAQ,CACR,wFAAwF,CACxF,CAAC;AACH;;;GAGG;AACH,MAAM,UAAU,GAAG,CAAC;KAClB,MAAM,CAAC;IACP,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,YAAY,CAAC,CAAC;IAC5B,QAAQ,EAAE,CAAC;SACT,MAAM,EAAE;SACR,QAAQ,CACR,WAAW,WAAW,8IAA8I,CACpK;IACF,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,qCAAqC,CAAC;IACjE,QAAQ,EAAE,CAAC;SACT,IAAI,CAAC,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;SACtB,QAAQ,CAAC,8DAA8D,CAAC;CAC1E,CAAC;KACD,QAAQ,CACR,0KAA0K,CAC1K,CAAC;AACH;;;GAGG;AACH,MAAM,KAAK,GAAG,CAAC;KACb,MAAM,CAAC;IACP,IAAI,EAAE,WAAW;IACjB,EAAE,EAAE,WAAW;CACf,CAAC;KACD,QAAQ,CACR,mIAAmI,CACnI,CAAC;AACH;;GAEG;AACH,MAAM,KAAK,GAAG,IAAI,OAAO,EAAiE,CAAC;AAE3F;;;;;;;GAOG;AACH,MAAM,UAAU,wBAAwB,CACvC,MAAwB,EACxB,mBAA4B;IAE5B,OAAO,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE;QACtC,MAAM,SAAS,GAAG,IAAI,GAAG,EAAU,CAAC;QACpC,MAAM,cAAc,GAAG,IAAI,GAAG,EAAU,CAAC;QACzC,MAAM,aAAa,GAAG,IAAI,GAAG,EAAU,CAAC;QACxC,MAAM,OAAO,GAAG,IAAI,GAAG,EAA0B,CAAC;QAClD,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,CAAC;YAC9C,eAAe,CACd,MAAM,CAAC,WAAW,EAClB,OAAO,EACP,SAAS,EACT,cAAc,EACd,aAAa,EACb,IAAI,CACJ,CAAC;QACH,CAAC;QACD,SAAS,OAAO,CAAC,YAAiC;YACjD,QAAQ,YAAY,CAAC,IAAI,EAAE,CAAC;gBAC3B,KAAK,CAAC,CAAC,CAAC,CAAC;oBACR,OAAO,CAAC,CAAC,KAAK,EAAE,CAAC;gBAClB,CAAC;gBACD,KAAK,CAAC,CAAC,CAAC,CAAC;oBACR,OAAO,CACN,OAAO,CAAC,GAAG,CAAC,eAAe,CAAC,YAAY,CAAC,IAAI,IAAI,CAAC,oBAAoB,CAAC,CAAC;wBACxE,IAAI,CAAC,cAAc,CAAC,CACpB,CAAC;gBACH,CAAC;gBACD,OAAO,CAAC,CAAC,CAAC;oBACT,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CACvB,YAAY,EACZ,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,cAAc,CAAC,CACnD,CAAC;oBACF,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,6BAA6B,CAAC,CAAC;oBAC5D,OAAO,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;gBACvB,CAAC;YACF,CAAC;QACF,CAAC;QACD,MAAM,MAAM,GAAG,CAAC;aACd,MAAM,CAAC;YACP,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;YACzB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC;YACjD,OAAO,EAAE,mBAAmB;gBAC3B,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC;gBACpB,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,8BAA8B,CAAC;YACnD,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;SAC/C,CAAC;aACD,QAAQ,CAAC,yDAAyD,CAAC,CAAC;QACtE,MAAM,MAAM,GAAG,CAAC;aACd,MAAM,CAAC;YACP,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC;YACzB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC;YACjD,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;SACtC,CAAC;aACD,QAAQ,CAAC,sDAAsD,CAAC,CAAC;QACnE,MAAM,IAAI,GAAG,CAAC;aACZ,MAAM,CAAC;YACP,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC;YACvB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC;YACjD,MAAM,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,YAAY,EAAE,KAAK,CAAC,CAAC;YACtC,WAAW,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,UAAU,EAAE,WAAW,CAAC,CAAC;SAC/C,CAAC;aACD,QAAQ,CAAC,mEAAmE,CAAC,CAAC;QAChF,MAAM,MAAM,GAAG,CAAC;aACd,MAAM,CAAC;YACP,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,CAAC;YACxB,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,eAAe,CAAC;YACjD,MAAM,EAAE,YAAY;YACpB,KAAK,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,GAAG,cAAc,CAA0B,CAAC,EAAE,iCAAiC;YAC9F,YAAY,EAAE,mBAAmB;gBAChC,CAAC,CAAC,OAAO,CAAC,aAAa,CAAC;gBACxB,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,QAAQ,CAAC,8BAA8B,CAAC;SACnD,CAAC;aACD,QAAQ,CAAC,0CAA0C,CAAC,CAAC;QACvD,MAAM,SAAS,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,CAAC,CAAC,IAAI,EAAE,CAAU,CAAC;QACpE,MAAM,WAAW,GAAG,CAAC,CAAC,MAAM,CAAC;YAC5B,IAAI,EAAE,CAAC;iBACL,KAAK,CAAC,SAAS,CAAC;iBAChB,QAAQ,CAAC,sEAAsE,CAAC;SAClF,CAAC,CAAC;QACH,MAAM,UAAU,GAAmC;YAClD,YAAY,EAAE,YAAY;YAC1B,WAAW,EAAE,WAAW;YACxB,UAAU,EAAE,UAAU;YACtB,KAAK,EAAE,KAAK;YACZ,MAAM,EAAE,MAAM;YACd,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,IAAI;YACV,MAAM,EAAE,MAAM;YACd,WAAW,EAAE,WAAW;SACxB,CAAC;QACF,OAAO,CAAC,UAAU,EAAE,aAAa,CAAC,CAAC;IACpC,CAAC,CAAC,CAAC;AACJ,CAAC;AACD,MAAM,eAAe,GACpB,kFAAkF,CAAC;AACpF,SAAS,eAAe,CACvB,aAAoD,EACpD,OAAoC,EACpC,SAAsB,EACtB,cAA2B,EAC3B,aAA0B,EAC1B,UAAkB;IAElB,OAAO,WAAW,CAAC,OAAO,EAAE,UAAU,EAAE,GAAG,EAAE;QAC5C,MAAM,UAAU,GAAG,aAAa,CAAC,GAAG,CAAC,UAAU,CAAC,IAAI,IAAI,CAAC,uBAAuB,CAAC,CAAC;QAClF,QAAQ,UAAU,CAAC,IAAI,EAAE,CAAC;YACzB,KAAK,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;gBACtB,KAAK,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,EAAE,CAAC;oBAC9D,8BAA8B;oBAC9B,IACC,KAAK,CAAC,IAAI,CACT,KAAK,CAAC,YAAY,EAClB,CAAC,CAAC,EAAE,EAAE,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,oBAAoB,CAAC,CACzD,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,KAAK,CAAC,EACvC,CAAC;wBACF,SAAS;oBACV,CAAC;oBACD,cAAc,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;oBACxB,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,YAAY,EAAE,CAAC;wBACvC,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;oBACzB,CAAC;gBACF,CAAC;gBACD,mEAAmE;gBACnE,MAAM,UAAU,GAAG,MAAM,CAAC,WAAW,CACpC,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC;qBAC/B,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE;oBACrB,OAAO;wBACN,GAAG;wBACH,uBAAuB,CACtB,aAAa,EACb,OAAO,EACP,SAAS,EACT,cAAc,EACd,aAAa,EACb,KAAK,CACL;qBACD,CAAC;gBACH,CAAC,CAAC;qBACD,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,KAAK,KAAK,SAAS,CAAC,CAC5C,CAAC;gBACF,sEAAsE;gBACtE,UAAU,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC;gBAC7C,OAAO,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC;YAC7B,CAAC;YACD,KAAK,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC;gBACrB,KAAK,MAAM,CAAC,IAAI,CAAC,IAAI,KAAK,CAAC,IAAI,CAC9B,UAAU,CAAC,YAAY,EACvB,CAAC,CAAC,EAA8B,EAAE,CAAC;oBAClC,CAAC;oBACD,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,oBAAoB,CAAC;iBAClD,CACD,CAAC,MAAM,CACP,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,MAAM,IAAI,MAAM,CAAC,IAAI,KAAK,QAAQ,CAAC,IAAI,CACjF,EAAE,CAAC;oBACH,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;gBACrB,CAAC;gBACD,OAAO,CAAC,CAAC,KAAK,CACb,sBAAsB,CACrB,aAAa,EACb,OAAO,EACP,SAAS,EACT,cAAc,EACd,aAAa,EACb,UAAU,CAAC,YAAY,CACvB,CACD,CAAC;YACH,CAAC;YACD,KAAK,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;gBACpB,QAAQ,UAAU,CAAC,QAAQ,EAAE,CAAC;oBAC7B,KAAK,WAAW,CAAC,OAAO,CAAC,CAAC,CAAC;wBAC1B,OAAO,CAAC,CAAC,OAAO,EAAE,CAAC;oBACpB,CAAC;oBACD,KAAK,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;wBACzB,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC;oBACnB,CAAC;oBACD,KAAK,WAAW,CAAC,MAAM,CAAC,CAAC,CAAC;wBACzB,OAAO,CAAC,CAAC,MAAM,EAAE,CAAC;oBACnB,CAAC;oBACD,KAAK,WAAW,CAAC,IAAI,CAAC,CAAC,CAAC;wBACvB,OAAO,CAAC,CAAC,IAAI,EAAE,CAAC;oBACjB,CAAC;oBACD,OAAO,CAAC,CAAC,CAAC;wBACT,MAAM,IAAI,KAAK,CAAC,yBAAyB,QAAQ,CAAC,UAAU,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC;oBAC5E,CAAC;gBACF,CAAC;YACF,CAAC;YACD,OAAO,CAAC,CAAC,CAAC;gBACT,MAAM,IAAI,KAAK,CAAC,yBAAyB,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACxE,CAAC;QACF,CAAC;IACF,CAAC,CAAC,CAAC;AACJ,CAAC;AACD,SAAS,uBAAuB,CAC/B,aAAoD,EACpD,OAAoC,EACpC,SAAsB,EACtB,cAA2B,EAC3B,aAA0B,EAC1B,WAA8B;IAE9B,QAAQ,WAAW,CAAC,IAAI,EAAE,CAAC;QAC1B,KAAK,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;YACzB,OAAO,sBAAsB,CAC5B,aAAa,EACb,OAAO,EACP,SAAS,EACT,cAAc,EACd,aAAa,EACb,WAAW,CAAC,YAAY,CACxB,CAAC;QACH,CAAC;QACD,KAAK,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;YACzB,OAAO,CAAC,CAAC,KAAK,CAAC;gBACd,CAAC,CAAC,IAAI,EAAE;gBACR,sBAAsB,CACrB,aAAa,EACb,OAAO,EACP,SAAS,EACT,cAAc,EACd,aAAa,EACb,WAAW,CAAC,YAAY,CACxB;aACD,CAAC,CAAC;QACJ,CAAC;QACD,KAAK,SAAS,CAAC,UAAU,CAAC,CAAC,CAAC;YAC3B,OAAO,SAAS,CAAC;QAClB,CAAC;QACD,OAAO,CAAC,CAAC,CAAC;YACT,MAAM,IAAI,KAAK,CAAC,0BAA0B,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC1E,CAAC;IACF,CAAC;AACF,CAAC;AACD,SAAS,sBAAsB,CAC9B,aAAoD,EACpD,OAAoC,EACpC,SAAsB,EACtB,cAA2B,EAC3B,aAA0B,EAC1B,YAAiC;IAEjC,MAAM,MAAM,GAAG,eAAe,CAAC,YAAY,CAAC,CAAC;IAC7C,IAAI,MAAM,KAAK,SAAS,EAAE,CAAC;QAC1B,MAAM,KAAK,GAAG;YACb,GAAG,WAAW,CAAC,YAAY,EAAE,CAAC,IAAI,EAAE,EAAE;gBACrC,OAAO,eAAe,CACrB,aAAa,EACb,OAAO,EACP,SAAS,EACT,cAAc,EACd,aAAa,EACb,IAAI,CACJ,CAAC;YACH,CAAC,CAAC;SACF,CAAC;QACF,MAAM,CAAC,aAAa,CAAC,KAAK,CAAC,EAAE,6BAA6B,CAAC,CAAC;QAC5D,OAAO,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;SAAM,CAAC;QACP,OAAO,eAAe,CACrB,aAAa,EACb,OAAO,EACP,SAAS,EACT,cAAc,EACd,aAAa,EACb,MAAM,CACN,CAAC;IACH,CAAC;AACF,CAAC;AACD,SAAS,eAAe,CAAI,GAAmB;IAC9C,IAAI,GAAG,CAAC,IAAI,KAAK,CAAC,EAAE,CAAC;QACpB,KAAK,MAAM,IAAI,IAAI,GAAG,EAAE,CAAC;YACxB,OAAO,IAAI,CAAC;QACb,CAAC;IACF,CAAC;AACF,CAAC;AACD,SAAS,aAAa,CAAI,KAAU;IACnC,OAAO,KAAK,CAAC,MAAM,IAAI,CAAC,CAAC;AAC1B,CAAC","sourcesContent":["/*!\n * Copyright (c) Microsoft Corporation and contributors. All rights reserved.\n * Licensed under the MIT License.\n */\n\nimport { assert } from \"@fluidframework/core-utils/internal\";\nimport { FieldKind, NodeKind, ValueSchema } from \"@fluidframework/tree/internal\";\nimport type {\n\tSimpleFieldSchema,\n\tSimpleNodeSchema,\n\tSimpleTreeSchema,\n} from \"@fluidframework/tree/internal\";\nimport { z } from \"zod\";\n\nimport { objectIdKey, typeField } from \"./agentEditTypes.js\";\nimport { fail, getOrCreate, mapIterable } from \"./utils.js\";\n\n/**\n * Zod Object type used to represent & validate the ObjectTarget type within a {@link TreeEdit}.\n * @remarks this is used as a component with {@link generateGenericEditTypes} to produce the final zod validation objects.\n */\nconst objectTarget = z.object({\n\ttarget: z\n\t\t.string()\n\t\t.describe(\n\t\t\t`The id of the object (as specified by the object's ${objectIdKey} property) that is being referenced`,\n\t\t),\n});\n/**\n * Zod Object type used to represent & validate the ObjectPlace type within a {@link TreeEdit}.\n * @remarks this is used as a component with {@link generateGenericEditTypes} to produce the final zod validation objects.\n */\nconst objectPlace = z\n\t.object({\n\t\ttype: z.enum([\"objectPlace\"]),\n\t\ttarget: z\n\t\t\t.string()\n\t\t\t.describe(\n\t\t\t\t`The id (${objectIdKey}) of the object that the new/moved object should be placed relative to. This must be the id of an object that already existed in the tree content that was originally supplied.`,\n\t\t\t),\n\t\tplace: z\n\t\t\t.enum([\"before\", \"after\"])\n\t\t\t.describe(\n\t\t\t\t\"Where the new/moved object will be relative to the target object - either just before or just after\",\n\t\t\t),\n\t})\n\t.describe(\n\t\t\"A pointer to a location either just before or just after an object that is in an array\",\n\t);\n/**\n * Zod Object type used to represent & validate the ArrayPlace type within a {@link TreeEdit}.\n * @remarks this is used as a component with {@link generateGenericEditTypes} to produce the final zod validation objects.\n */\nconst arrayPlace = z\n\t.object({\n\t\ttype: z.enum([\"arrayPlace\"]),\n\t\tparentId: z\n\t\t\t.string()\n\t\t\t.describe(\n\t\t\t\t`The id (${objectIdKey}) of the parent object of the array. This must be the id of an object that already existed in the tree content that was originally supplied.`,\n\t\t\t),\n\t\tfield: z.string().describe(\"The key of the array to insert into\"),\n\t\tlocation: z\n\t\t\t.enum([\"start\", \"end\"])\n\t\t\t.describe(\"Where to insert into the array - either the start or the end\"),\n\t})\n\t.describe(\n\t\t`either the \"start\" or \"end\" of an array, as specified by a \"parent\" ObjectTarget and a \"field\" name under which the array is stored (useful for prepending or appending)`,\n\t);\n/**\n * Zod Object type used to represent & validate the Range type within a {@link TreeEdit}.\n * @remarks this is used as a component with {@link generateGenericEditTypes} to produce the final zod validation objects.\n */\nconst range = z\n\t.object({\n\t\tfrom: objectPlace,\n\t\tto: objectPlace,\n\t})\n\t.describe(\n\t\t'A range of objects in the same array specified by a \"from\" and \"to\" Place. The \"to\" and \"from\" objects MUST be in the same array.',\n\t);\n/**\n * Cache used to prevent repeatedly generating the same Zod validation objects for the same {@link SimpleTreeSchema} as generate propts for repeated calls to an LLM\n */\nconst cache = new WeakMap<SimpleTreeSchema, ReturnType<typeof generateGenericEditTypes>>();\n\n/**\n * Generates a set of ZOD validation objects for the various types of data that can be put into the provided {@link SimpleTreeSchema}\n * and then uses those sets to generate an all-encompassing ZOD object for each type of {@link TreeEdit} that can validate any of the types of data that can be put into the tree.\n *\n * @returns a Record of schema names to Zod validation objects, and the name of the root schema used to encompass all of the other schemas.\n *\n * @remarks The return type of this function is designed to work with Typechat's createZodJsonValidator as well as be used as the JSON schema for OpenAi's structured output response format.\n */\nexport function generateGenericEditTypes(\n\tschema: SimpleTreeSchema,\n\tgenerateDomainTypes: boolean,\n): [Record<string, Zod.ZodTypeAny>, root: string] {\n\treturn getOrCreate(cache, schema, () => {\n\t\tconst insertSet = new Set<string>();\n\t\tconst modifyFieldSet = new Set<string>();\n\t\tconst modifyTypeSet = new Set<string>();\n\t\tconst typeMap = new Map<string, Zod.ZodTypeAny>();\n\t\tfor (const name of schema.definitions.keys()) {\n\t\t\tgetOrCreateType(\n\t\t\t\tschema.definitions,\n\t\t\t\ttypeMap,\n\t\t\t\tinsertSet,\n\t\t\t\tmodifyFieldSet,\n\t\t\t\tmodifyTypeSet,\n\t\t\t\tname,\n\t\t\t);\n\t\t}\n\t\tfunction getType(allowedTypes: ReadonlySet<string>): Zod.ZodTypeAny {\n\t\t\tswitch (allowedTypes.size) {\n\t\t\t\tcase 0: {\n\t\t\t\t\treturn z.never();\n\t\t\t\t}\n\t\t\t\tcase 1: {\n\t\t\t\t\treturn (\n\t\t\t\t\t\ttypeMap.get(tryGetSingleton(allowedTypes) ?? fail(\"Expected singleton\")) ??\n\t\t\t\t\t\tfail(\"Unknown type\")\n\t\t\t\t\t);\n\t\t\t\t}\n\t\t\t\tdefault: {\n\t\t\t\t\tconst types = Array.from(\n\t\t\t\t\t\tallowedTypes,\n\t\t\t\t\t\t(name) => typeMap.get(name) ?? fail(\"Unknown type\"),\n\t\t\t\t\t);\n\t\t\t\t\tassert(hasAtLeastTwo(types), \"Expected at least two types\");\n\t\t\t\t\treturn z.union(types);\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\tconst insert = z\n\t\t\t.object({\n\t\t\t\ttype: z.literal(\"insert\"),\n\t\t\t\texplanation: z.string().describe(editDescription),\n\t\t\t\tcontent: generateDomainTypes\n\t\t\t\t\t? getType(insertSet)\n\t\t\t\t\t: z.any().describe(\"Domain-specific content here\"),\n\t\t\t\tdestination: z.union([arrayPlace, objectPlace]),\n\t\t\t})\n\t\t\t.describe(\"Inserts a new object at a specific Place or ArrayPlace.\");\n\t\tconst remove = z\n\t\t\t.object({\n\t\t\t\ttype: z.literal(\"remove\"),\n\t\t\t\texplanation: z.string().describe(editDescription),\n\t\t\t\tsource: z.union([objectTarget, range]),\n\t\t\t})\n\t\t\t.describe(\"Deletes an object or Range of objects from the tree.\");\n\t\tconst move = z\n\t\t\t.object({\n\t\t\t\ttype: z.literal(\"move\"),\n\t\t\t\texplanation: z.string().describe(editDescription),\n\t\t\t\tsource: z.union([objectTarget, range]),\n\t\t\t\tdestination: z.union([arrayPlace, objectPlace]),\n\t\t\t})\n\t\t\t.describe(\"Moves an object or Range of objects to a new Place or ArrayPlace.\");\n\t\tconst modify = z\n\t\t\t.object({\n\t\t\t\ttype: z.enum([\"modify\"]),\n\t\t\t\texplanation: z.string().describe(editDescription),\n\t\t\t\ttarget: objectTarget,\n\t\t\t\tfield: z.enum([...modifyFieldSet] as [string, ...string[]]), // Modify with appropriate fields\n\t\t\t\tmodification: generateDomainTypes\n\t\t\t\t\t? getType(modifyTypeSet)\n\t\t\t\t\t: z.any().describe(\"Domain-specific content here\"),\n\t\t\t})\n\t\t\t.describe(\"Sets a field on a specific ObjectTarget.\");\n\t\tconst editTypes = [insert, remove, move, modify, z.null()] as const;\n\t\tconst editWrapper = z.object({\n\t\t\tedit: z\n\t\t\t\t.union(editTypes)\n\t\t\t\t.describe(\"The next edit to apply to the tree, or null if the task is complete.\"),\n\t\t});\n\t\tconst typeRecord: Record<string, Zod.ZodTypeAny> = {\n\t\t\tObjectTarget: objectTarget,\n\t\t\tObjectPlace: objectPlace,\n\t\t\tArrayPlace: arrayPlace,\n\t\t\tRange: range,\n\t\t\tInsert: insert,\n\t\t\tRemove: remove,\n\t\t\tMove: move,\n\t\t\tModify: modify,\n\t\t\tEditWrapper: editWrapper,\n\t\t};\n\t\treturn [typeRecord, \"EditWrapper\"];\n\t});\n}\nconst editDescription =\n\t\"A description of what this edit is meant to accomplish in human readable English\";\nfunction getOrCreateType(\n\tdefinitionMap: ReadonlyMap<string, SimpleNodeSchema>,\n\ttypeMap: Map<string, Zod.ZodTypeAny>,\n\tinsertSet: Set<string>,\n\tmodifyFieldSet: Set<string>,\n\tmodifyTypeSet: Set<string>,\n\tdefinition: string,\n): Zod.ZodTypeAny {\n\treturn getOrCreate(typeMap, definition, () => {\n\t\tconst nodeSchema = definitionMap.get(definition) ?? fail(\"Unexpected definition\");\n\t\tswitch (nodeSchema.kind) {\n\t\t\tcase NodeKind.Object: {\n\t\t\t\tfor (const [key, field] of Object.entries(nodeSchema.fields)) {\n\t\t\t\t\t// TODO: Remove when AI better\n\t\t\t\t\tif (\n\t\t\t\t\t\tArray.from(\n\t\t\t\t\t\t\tfield.allowedTypes,\n\t\t\t\t\t\t\t(n) => definitionMap.get(n) ?? fail(\"Unknown definition\"),\n\t\t\t\t\t\t).some((n) => n.kind === NodeKind.Array)\n\t\t\t\t\t) {\n\t\t\t\t\t\tcontinue;\n\t\t\t\t\t}\n\t\t\t\t\tmodifyFieldSet.add(key);\n\t\t\t\t\tfor (const type of field.allowedTypes) {\n\t\t\t\t\t\tmodifyTypeSet.add(type);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-assignment\n\t\t\t\tconst properties = Object.fromEntries(\n\t\t\t\t\tObject.entries(nodeSchema.fields)\n\t\t\t\t\t\t.map(([key, field]) => {\n\t\t\t\t\t\t\treturn [\n\t\t\t\t\t\t\t\tkey,\n\t\t\t\t\t\t\t\tgetOrCreateTypeForField(\n\t\t\t\t\t\t\t\t\tdefinitionMap,\n\t\t\t\t\t\t\t\t\ttypeMap,\n\t\t\t\t\t\t\t\t\tinsertSet,\n\t\t\t\t\t\t\t\t\tmodifyFieldSet,\n\t\t\t\t\t\t\t\t\tmodifyTypeSet,\n\t\t\t\t\t\t\t\t\tfield,\n\t\t\t\t\t\t\t\t),\n\t\t\t\t\t\t\t];\n\t\t\t\t\t\t})\n\t\t\t\t\t\t.filter(([, value]) => value !== undefined),\n\t\t\t\t);\n\t\t\t\t// eslint-disable-next-line @typescript-eslint/no-unsafe-member-access\n\t\t\t\tproperties[typeField] = z.enum([definition]);\n\t\t\t\treturn z.object(properties);\n\t\t\t}\n\t\t\tcase NodeKind.Array: {\n\t\t\t\tfor (const [name] of Array.from(\n\t\t\t\t\tnodeSchema.allowedTypes,\n\t\t\t\t\t(n): [string, SimpleNodeSchema] => [\n\t\t\t\t\t\tn,\n\t\t\t\t\t\tdefinitionMap.get(n) ?? fail(\"Unknown definition\"),\n\t\t\t\t\t],\n\t\t\t\t).filter(\n\t\t\t\t\t([_, schema]) => schema.kind === NodeKind.Object || schema.kind === NodeKind.Leaf,\n\t\t\t\t)) {\n\t\t\t\t\tinsertSet.add(name);\n\t\t\t\t}\n\t\t\t\treturn z.array(\n\t\t\t\t\tgetTypeForAllowedTypes(\n\t\t\t\t\t\tdefinitionMap,\n\t\t\t\t\t\ttypeMap,\n\t\t\t\t\t\tinsertSet,\n\t\t\t\t\t\tmodifyFieldSet,\n\t\t\t\t\t\tmodifyTypeSet,\n\t\t\t\t\t\tnodeSchema.allowedTypes,\n\t\t\t\t\t),\n\t\t\t\t);\n\t\t\t}\n\t\t\tcase NodeKind.Leaf: {\n\t\t\t\tswitch (nodeSchema.leafKind) {\n\t\t\t\t\tcase ValueSchema.Boolean: {\n\t\t\t\t\t\treturn z.boolean();\n\t\t\t\t\t}\n\t\t\t\t\tcase ValueSchema.Number: {\n\t\t\t\t\t\treturn z.number();\n\t\t\t\t\t}\n\t\t\t\t\tcase ValueSchema.String: {\n\t\t\t\t\t\treturn z.string();\n\t\t\t\t\t}\n\t\t\t\t\tcase ValueSchema.Null: {\n\t\t\t\t\t\treturn z.null();\n\t\t\t\t\t}\n\t\t\t\t\tdefault: {\n\t\t\t\t\t\tthrow new Error(`Unsupported leaf kind ${NodeKind[nodeSchema.leafKind]}.`);\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t\tdefault: {\n\t\t\t\tthrow new Error(`Unsupported node kind ${NodeKind[nodeSchema.kind]}.`);\n\t\t\t}\n\t\t}\n\t});\n}\nfunction getOrCreateTypeForField(\n\tdefinitionMap: ReadonlyMap<string, SimpleNodeSchema>,\n\ttypeMap: Map<string, Zod.ZodTypeAny>,\n\tinsertSet: Set<string>,\n\tmodifyFieldSet: Set<string>,\n\tmodifyTypeSet: Set<string>,\n\tfieldSchema: SimpleFieldSchema,\n): Zod.ZodTypeAny | undefined {\n\tswitch (fieldSchema.kind) {\n\t\tcase FieldKind.Required: {\n\t\t\treturn getTypeForAllowedTypes(\n\t\t\t\tdefinitionMap,\n\t\t\t\ttypeMap,\n\t\t\t\tinsertSet,\n\t\t\t\tmodifyFieldSet,\n\t\t\t\tmodifyTypeSet,\n\t\t\t\tfieldSchema.allowedTypes,\n\t\t\t);\n\t\t}\n\t\tcase FieldKind.Optional: {\n\t\t\treturn z.union([\n\t\t\t\tz.null(),\n\t\t\t\tgetTypeForAllowedTypes(\n\t\t\t\t\tdefinitionMap,\n\t\t\t\t\ttypeMap,\n\t\t\t\t\tinsertSet,\n\t\t\t\t\tmodifyFieldSet,\n\t\t\t\t\tmodifyTypeSet,\n\t\t\t\t\tfieldSchema.allowedTypes,\n\t\t\t\t),\n\t\t\t]);\n\t\t}\n\t\tcase FieldKind.Identifier: {\n\t\t\treturn undefined;\n\t\t}\n\t\tdefault: {\n\t\t\tthrow new Error(`Unsupported field kind ${NodeKind[fieldSchema.kind]}.`);\n\t\t}\n\t}\n}\nfunction getTypeForAllowedTypes(\n\tdefinitionMap: ReadonlyMap<string, SimpleNodeSchema>,\n\ttypeMap: Map<string, Zod.ZodTypeAny>,\n\tinsertSet: Set<string>,\n\tmodifyFieldSet: Set<string>,\n\tmodifyTypeSet: Set<string>,\n\tallowedTypes: ReadonlySet<string>,\n): Zod.ZodTypeAny {\n\tconst single = tryGetSingleton(allowedTypes);\n\tif (single === undefined) {\n\t\tconst types = [\n\t\t\t...mapIterable(allowedTypes, (name) => {\n\t\t\t\treturn getOrCreateType(\n\t\t\t\t\tdefinitionMap,\n\t\t\t\t\ttypeMap,\n\t\t\t\t\tinsertSet,\n\t\t\t\t\tmodifyFieldSet,\n\t\t\t\t\tmodifyTypeSet,\n\t\t\t\t\tname,\n\t\t\t\t);\n\t\t\t}),\n\t\t];\n\t\tassert(hasAtLeastTwo(types), \"Expected at least two types\");\n\t\treturn z.union(types);\n\t} else {\n\t\treturn getOrCreateType(\n\t\t\tdefinitionMap,\n\t\t\ttypeMap,\n\t\t\tinsertSet,\n\t\t\tmodifyFieldSet,\n\t\t\tmodifyTypeSet,\n\t\t\tsingle,\n\t\t);\n\t}\n}\nfunction tryGetSingleton<T>(set: ReadonlySet<T>): T | undefined {\n\tif (set.size === 1) {\n\t\tfor (const item of set) {\n\t\t\treturn item;\n\t\t}\n\t}\n}\nfunction hasAtLeastTwo<T>(array: T[]): array is [T, T, ...T[]] {\n\treturn array.length >= 2;\n}\n"]}

package/lib/explicit-strategy/utils.d.ts

@@ -0,0 +1,37 @@
+/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ */
+/**
+ * Subset of Map interface.
+ *
+ * @remarks originally from tree/src/util/utils.ts
+ */
+export interface MapGetSet<K, V> {
+    get(key: K): V | undefined;
+    set(key: K, value: V): void;
+}
+/**
+ * TBD
+ */
+export declare function fail(message: string): never;
+/**
+ * Map one iterable to another by transforming each element one at a time
+ * @param iterable - the iterable to transform
+ * @param map - the transformation function to run on each element of the iterable
+ * @returns a new iterable of elements which have been transformed by the `map` function
+ *
+ * @remarks originally from tree/src/util/utils.ts
+ */
+export declare function mapIterable<T, U>(iterable: Iterable<T>, map: (t: T) => U): IterableIterator<U>;
+/**
+ * Retrieve a value from a map with the given key, or create a new entry if the key is not in the map.
+ * @param map - The map to query/update
+ * @param key - The key to lookup in the map
+ * @param defaultValue - a function which returns a default value. This is called and used to set an initial value for the given key in the map if none exists
+ * @returns either the existing value for the given key, or the newly-created value (the result of `defaultValue`)
+ *
+ * @remarks originally from tree/src/util/utils.ts
+ */
+export declare function getOrCreate<K, V>(map: MapGetSet<K, V>, key: K, defaultValue: (key: K) => V): V;
+//# sourceMappingURL=utils.d.ts.map

package/lib/explicit-strategy/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/explicit-strategy/utils.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH;;;;GAIG;AACH,MAAM,WAAW,SAAS,CAAC,CAAC,EAAE,CAAC;IAC9B,GAAG,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,GAAG,SAAS,CAAC;IAC3B,GAAG,CAAC,GAAG,EAAE,CAAC,EAAE,KAAK,EAAE,CAAC,GAAG,IAAI,CAAC;CAC5B;AAED;;GAEG;AACH,wBAAgB,IAAI,CAAC,OAAO,EAAE,MAAM,GAAG,KAAK,CAE3C;AAED;;;;;;;GAOG;AACH,wBAAiB,WAAW,CAAC,CAAC,EAAE,CAAC,EAChC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC,EACrB,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,KAAK,CAAC,GACd,gBAAgB,CAAC,CAAC,CAAC,CAIrB;AAED;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,CAAC,EAAE,CAAC,EAC/B,GAAG,EAAE,SAAS,CAAC,CAAC,EAAE,CAAC,CAAC,EACpB,GAAG,EAAE,CAAC,EACN,YAAY,EAAE,CAAC,GAAG,EAAE,CAAC,KAAK,CAAC,GACzB,CAAC,CAOH"}