@lleverage-ai/agent-sdk 0.0.1 → 0.0.2-alpha.3

package/dist/tools/user-interaction.js

@@ -1,147 +0,0 @@
-/**
- * User interaction tools for agent-user communication.
- *
- * These tools allow agents to ask clarifying questions and get user input
- * during execution. This enables interactive workflows where the agent
- * needs additional information from the user to proceed.
- *
- * @packageDocumentation
- */
-import { tool } from "ai";
-import { z } from "zod";
-// =============================================================================
-// AskUserQuestion Tool
-// =============================================================================
-/**
- * Creates a tool for asking the user clarifying questions.
- *
- * This tool allows agents to request additional information from users
- * during execution. It supports both single-select and multi-select
- * questions with multiple choice options.
- *
- * The tool requires a callback function that handles the actual UI
- * interaction with the user. The callback receives the question and
- * options, prompts the user, and returns their selection.
- *
- * @param onAskUser - Callback function to handle user prompts
- * @returns An AI SDK compatible tool for asking questions
- *
- * @example
- * Single-select question
- * ```typescript
- * import { createAskUserQuestionTool } from "@lleverage-ai/agent-sdk";
- *
- * const askUserQuestion = createAskUserQuestionTool(
- *   async (question, options, multiSelect) => {
- *     console.log(question);
- *     options.forEach((opt, i) => {
- *       console.log(`${i + 1}. ${opt.label}: ${opt.description}`);
- *     });
- *     const answer = await getUserInput(); // Your UI logic
- *     return options[answer - 1].value;
- *   }
- * );
- *
- * const agent = createAgent({
- *   model,
- *   tools: { askUserQuestion },
- * });
- * ```
- *
- * @example
- * Multi-select question
- * ```typescript
- * const askUserQuestion = createAskUserQuestionTool(
- *   async (question, options, multiSelect) => {
- *     if (multiSelect) {
- *       // Show checkboxes, allow multiple selections
- *       const selected = await getUserMultipleChoices();
- *       return selected.map(i => options[i].value);
- *     }
- *     // Single select logic
- *   }
- * );
- * ```
- *
- * @example
- * Integration with UI framework
- * ```typescript
- * // React example
- * const askUserQuestion = createAskUserQuestionTool(
- *   async (question, options, multiSelect) => {
- *     return new Promise((resolve) => {
- *       setQuestion({ question, options, multiSelect, resolve });
- *     });
- *   }
- * );
- *
- * // In your React component:
- * function QuestionDialog({ question, options, multiSelect, resolve }) {
- *   const [selected, setSelected] = useState([]);
- *
- *   const handleSubmit = () => {
- *     if (multiSelect) {
- *       resolve(selected);
- *     } else {
- *       resolve(selected[0]);
- *     }
- *   };
- *
- *   // Render question UI...
- * }
- * ```
- *
- * @category Tools
- */
-export function createAskUserQuestionTool(onAskUser) {
-    return tool({
-        description: "Ask the user a clarifying question with multiple choice options. Use this when you need additional information from the user to proceed.",
-        inputSchema: z.object({
-            question: z.string().describe("The question to ask the user. Should be clear and specific."),
-            options: z
-                .array(z.object({
-                label: z.string().describe("Display text for this option (concise, 1-5 words)"),
-                description: z
-                    .string()
-                    .optional()
-                    .describe("Explanation of what this option means or what will happen"),
-                value: z.string().describe("Value to return if selected (can be same as label)"),
-            }))
-                .min(2)
-                .max(10)
-                .describe("Available answer options (2-10 options)"),
-            multiSelect: z
-                .boolean()
-                .optional()
-                .default(false)
-                .describe("Whether the user can select multiple options (default: false)"),
-        }),
-        execute: async ({ question, options, multiSelect = false, }) => {
-            // Validate options
-            if (options.length < 2) {
-                return "Error: At least 2 options are required for a question.";
-            }
-            if (options.length > 10) {
-                return "Error: Maximum 10 options allowed per question.";
-            }
-            // Call the user-provided callback to handle the interaction
-            const result = await onAskUser(question, options, multiSelect);
-            // Format the response
-            if (multiSelect && Array.isArray(result)) {
-                const selectedLabels = result
-                    .map((value) => {
-                    const option = options.find((opt) => opt.value === value);
-                    return option?.label || value;
-                })
-                    .join(", ");
-                return `User selected: ${selectedLabels}`;
-            }
-            if (typeof result === "string") {
-                const option = options.find((opt) => opt.value === result);
-                return `User selected: ${option?.label || result}`;
-            }
-            return `User selected: ${String(result)}`;
-        },
-    });
-}
-//# sourceMappingURL=user-interaction.js.map

package/dist/tools/user-interaction.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"user-interaction.js","sourceRoot":"","sources":["../../src/tools/user-interaction.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,IAAI,CAAC;AAC1B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAgCxB,gFAAgF;AAChF,uBAAuB;AACvB,gFAAgF;AAEhF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgFG;AACH,MAAM,UAAU,yBAAyB,CAAC,SAA0B;IAClE,OAAO,IAAI,CAAC;QACV,WAAW,EACT,0IAA0I;QAC5I,WAAW,EAAE,CAAC,CAAC,MAAM,CAAC;YACpB,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,6DAA6D,CAAC;YAC5F,OAAO,EAAE,CAAC;iBACP,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;gBACP,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,mDAAmD,CAAC;gBAC/E,WAAW,EAAE,CAAC;qBACX,MAAM,EAAE;qBACR,QAAQ,EAAE;qBACV,QAAQ,CAAC,2DAA2D,CAAC;gBACxE,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,oDAAoD,CAAC;aACjF,CAAC,CACH;iBACA,GAAG,CAAC,CAAC,CAAC;iBACN,GAAG,CAAC,EAAE,CAAC;iBACP,QAAQ,CAAC,yCAAyC,CAAC;YACtD,WAAW,EAAE,CAAC;iBACX,OAAO,EAAE;iBACT,QAAQ,EAAE;iBACV,OAAO,CAAC,KAAK,CAAC;iBACd,QAAQ,CAAC,+DAA+D,CAAC;SAC7E,CAAC;QACF,OAAO,EAAE,KAAK,EAAE,EACd,QAAQ,EACR,OAAO,EACP,WAAW,GAAG,KAAK,GAKpB,EAAE,EAAE;YACH,mBAAmB;YACnB,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;gBACvB,OAAO,wDAAwD,CAAC;YAClE,CAAC;YAED,IAAI,OAAO,CAAC,MAAM,GAAG,EAAE,EAAE,CAAC;gBACxB,OAAO,iDAAiD,CAAC;YAC3D,CAAC;YAED,4DAA4D;YAC5D,MAAM,MAAM,GAAG,MAAM,SAAS,CAAC,QAAQ,EAAE,OAAO,EAAE,WAAW,CAAC,CAAC;YAE/D,sBAAsB;YACtB,IAAI,WAAW,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC,EAAE,CAAC;gBACzC,MAAM,cAAc,GAAG,MAAM;qBAC1B,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;oBACb,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,KAAK,KAAK,CAAC,CAAC;oBAC1D,OAAO,MAAM,EAAE,KAAK,IAAI,KAAK,CAAC;gBAChC,CAAC,CAAC;qBACD,IAAI,CAAC,IAAI,CAAC,CAAC;gBAEd,OAAO,kBAAkB,cAAc,EAAE,CAAC;YAC5C,CAAC;YAED,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;gBAC/B,MAAM,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,KAAK,MAAM,CAAC,CAAC;gBAC3D,OAAO,kBAAkB,MAAM,EAAE,KAAK,IAAI,MAAM,EAAE,CAAC;YACrD,CAAC;YAED,OAAO,kBAAkB,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;QAC5C,CAAC;KACF,CAAC,CAAC;AACL,CAAC"}