@browserbasehq/orca 3.0.9-alpha-3 → 3.1.0-patch.0

package/dist/esm/lib/prompt.js

@@ -0,0 +1,230 @@
+export function buildUserInstructionsString(userProvidedInstructions) {
+    if (!userProvidedInstructions) {
+        return "";
+    }
+    return `\n\n# Custom Instructions Provided by the User
+    
+Please keep the user's instructions in mind when performing actions. If the user's instructions are not relevant to the current task, ignore them.
+
+User Instructions:
+${userProvidedInstructions}`;
+}
+// extract
+export function buildExtractSystemPrompt(isUsingPrintExtractedDataTool = false, userProvidedInstructions) {
+    const baseContent = `You are extracting content on behalf of a user.
+  If a user asks you to extract a 'list' of information, or 'all' information, 
+  YOU MUST EXTRACT ALL OF THE INFORMATION THAT THE USER REQUESTS.
+   
+  You will be given:
+1. An instruction
+2. `;
+    const contentDetail = `A list of DOM elements to extract from.`;
+    const instructions = `
+Print the exact text from the DOM elements with all symbols, characters, and endlines as is.
+Print null or an empty string if no new information is found.
+  `.trim();
+    const toolInstructions = isUsingPrintExtractedDataTool
+        ? `
+ONLY print the content using the print_extracted_data tool provided.
+ONLY print the content using the print_extracted_data tool provided.
+  `.trim()
+        : "";
+    const additionalInstructions = "If a user is attempting to extract links or URLs, you MUST respond with ONLY the IDs of the link elements. \n" +
+        "Do not attempt to extract links directly from the text unless absolutely necessary. ";
+    const userInstructions = buildUserInstructionsString(userProvidedInstructions);
+    const content = `${baseContent}${contentDetail}\n\n${instructions}\n${toolInstructions}${additionalInstructions ? `\n\n${additionalInstructions}` : ""}${userInstructions ? `\n\n${userInstructions}` : ""}`.replace(/\s+/g, " ");
+    return {
+        role: "system",
+        content,
+    };
+}
+export function buildExtractUserPrompt(instruction, domElements, isUsingPrintExtractedDataTool = false) {
+    let content = `Instruction: ${instruction}
+DOM: ${domElements}`;
+    if (isUsingPrintExtractedDataTool) {
+        content += `
+ONLY print the content using the print_extracted_data tool provided.
+ONLY print the content using the print_extracted_data tool provided.`;
+    }
+    return {
+        role: "user",
+        content,
+    };
+}
+const metadataSystemPrompt = `You are an AI assistant tasked with evaluating the progress and completion status of an extraction task.
+Analyze the extraction response and determine if the task is completed or if more information is needed.
+Strictly abide by the following criteria:
+1. Once the instruction has been satisfied by the current extraction response, ALWAYS set completion status to true and stop processing, regardless of remaining chunks.
+2. Only set completion status to false if BOTH of these conditions are true:
+   - The instruction has not been satisfied yet
+   - There are still chunks left to process (chunksTotal > chunksSeen)`;
+export function buildMetadataSystemPrompt() {
+    return {
+        role: "system",
+        content: metadataSystemPrompt,
+    };
+}
+export function buildMetadataPrompt(instruction, extractionResponse) {
+    return {
+        role: "user",
+        content: `Instruction: ${instruction}
+Extracted content: ${JSON.stringify(extractionResponse, null, 2)}`,
+    };
+}
+// observe
+export function buildObserveSystemPrompt(userProvidedInstructions, supportedActions) {
+    const actionsString = supportedActions?.length
+        ? `\n\nSupported actions: ${supportedActions.join(", ")}`
+        : "";
+    const observeSystemPrompt = `
+You are helping the user automate the browser by finding elements based on what the user wants to observe in the page.
+
+You will be given:
+1. a instruction of elements to observe
+2. a hierarchical accessibility tree showing the semantic structure of the page. The tree is a hybrid of the DOM and the accessibility tree.
+
+Return an array of elements that match the instruction if they exist, otherwise return an empty array.
+When returning elements, include the appropriate method from the supported actions list.${actionsString}. When choosing non-left click actions, provide right or middle as the argument.`;
+    const content = observeSystemPrompt.replace(/\s+/g, " ");
+    return {
+        role: "system",
+        content: [content, buildUserInstructionsString(userProvidedInstructions)]
+            .filter(Boolean)
+            .join("\n\n"),
+    };
+}
+export function buildObserveUserMessage(instruction, domElements) {
+    return {
+        role: "user",
+        content: `instruction: ${instruction}
+Accessibility Tree: \n${domElements}\n`,
+    };
+}
+export function buildActSystemPrompt(userProvidedInstructions) {
+    const actSystemPrompt = `
+You are helping the user automate the browser by finding elements based on what action the user wants to take on the page
+
+You will be given:
+1. a user defined instruction about what action to take
+2. a hierarchical accessibility tree showing the semantic structure of the page. The tree is a hybrid of the DOM and the accessibility tree.
+
+Return the element that matches the instruction if it exists. Otherwise, return an empty object.`;
+    const content = actSystemPrompt.replace(/\s+/g, " ");
+    return {
+        role: "system",
+        content: [content, buildUserInstructionsString(userProvidedInstructions)]
+            .filter(Boolean)
+            .join("\n\n"),
+    };
+}
+export function buildActPrompt(action, supportedActions, variables) {
+    // Base instruction
+    let instruction = `Find the most relevant element to perform an action on given the following action: ${action}.  
+  IF AND ONLY IF the action EXPLICITLY includes the word 'dropdown' and implies choosing/selecting an option from a dropdown, ignore the 'General Instructions' section, and follow the 'Dropdown Specific Instructions' section carefully.
+  
+  General Instructions: 
+    Provide an action for this element such as ${supportedActions.join(", ")}. Remember that to users, buttons and links look the same in most cases.
+    When choosing non-left click actions, provide right or middle as the argument
+    If the action is completely unrelated to a potential action to be taken on the page, return an empty object. 
+    ONLY return one action. If multiple actions are relevant, return the most relevant one. 
+    If the user is asking to scroll to a position on the page, e.g., 'halfway' or 0.75, etc, you must return the argument formatted as the correct percentage, e.g., '50%' or '75%', etc.
+    If the user is asking to scroll to the next chunk/previous chunk, choose the nextChunk/prevChunk method. No arguments are required here.
+    If the action implies a key press, e.g., 'press enter', 'press a', 'press space', etc., always choose the press method with the appropriate key as argument — e.g. 'a', 'Enter', 'Space'. Do not choose a click action on an on-screen keyboard. Capitalize the first character like 'Enter', 'Tab', 'Escape' only for special keys. 
+  
+  Dropdown Specific Instructions:
+    For interacting with dropdowns, there are two specific cases that you need to handle. 
+    
+    CASE 1: the element is a 'select' element. 
+      - choose the selectOptionFromDropdown method,
+      - set the argument to the exact text of the option that should be selected,
+      - set twoStep to false.
+    CASE 2: the element is NOT a 'select' element:
+      - do not attempt to directly choose the element from the dropdown. You will need to click to expand the dropdown first. You will achieve this by following these instructions:
+        - choose the node that most closely corresponds to the given instruction EVEN if it is a 'StaticText' element, or otherwise does not appear to be interactable.  
+        - choose the 'click' method
+        - set twoStep to true.
+  `;
+    // Add variable names (not values) to the instruction if any
+    if (variables && Object.keys(variables).length > 0) {
+        const variableNames = Object.keys(variables)
+            .map((key) => `%${key}%`)
+            .join(", ");
+        const variablesPrompt = `The following variables are available to use in the action: ${variableNames}. Fill the argument variables with the variable name.`;
+        instruction += ` ${variablesPrompt}`;
+    }
+    return instruction;
+}
+export function buildStepTwoPrompt(originalUserAction, previousAction, supportedActions, variables) {
+    // Base instruction
+    let instruction = `
+  The original user action was: ${originalUserAction}.
+  You have just taken the following action which completed step 1 of 2: ${previousAction}.
+  
+  Now, you must find the most relevant element to perform an action on in order to complete step 2 of 2. 
+  
+  General Instructions: 
+  Provide an action for this element such as ${supportedActions.join(", ")}. Remember that to users, buttons and links look the same in most cases.
+  If the action is completely unrelated to a potential action to be taken on the page, return an empty object. 
+  ONLY return one action. If multiple actions are relevant, return the most relevant one. 
+  If the user is asking to scroll to a position on the page, e.g., 'halfway' or 0.75, etc, you must return the argument formatted as the correct percentage, e.g., '50%' or '75%', etc.
+  If the user is asking to scroll to the next chunk/previous chunk, choose the nextChunk/prevChunk method. No arguments are required here.
+  If the action implies a key press, e.g., 'press enter', 'press a', 'press space', etc., always choose the press method with the appropriate key as argument — e.g. 'a', 'Enter', 'Space'. Do not choose a click action on an on-screen keyboard. Capitalize the first character like 'Enter', 'Tab', 'Escape' only for special keys. 
+  `;
+    // Add variable names (not values) to the instruction if any
+    if (variables && Object.keys(variables).length > 0) {
+        const variableNames = Object.keys(variables)
+            .map((key) => `%${key}%`)
+            .join(", ");
+        const variablesPrompt = `The following variables are available to use in the action: ${variableNames}. Fill the argument variables with the variable name.`;
+        instruction += ` ${variablesPrompt}`;
+    }
+    return instruction;
+}
+export function buildOperatorSystemPrompt(goal) {
+    return {
+        role: "system",
+        content: `You are a general-purpose agent whose job is to accomplish the user's goal across multiple model calls by running actions on the page.
+
+You will be given a goal and a list of steps that have been taken so far. Your job is to determine if either the user's goal has been completed or if there are still steps that need to be taken.
+
+# Your current goal
+${goal}
+
+# CRITICAL: You MUST use the provided tools to take actions. Do not just describe what you want to do - actually call the appropriate tools.
+
+# Available tools and when to use them:
+- \`act\`: Use this to interact with the page (click, type, navigate, etc.)
+- \`extract\`: Use this to get information from the page
+- \`goto\`: Use this to navigate to a specific URL
+- \`wait\`: Use this to wait for a period of time
+- \`navback\`: Use this to go back to the previous page
+- \`refresh\`: Use this to refresh the current page
+- \`close\`: Use this ONLY when the task is complete or cannot be achieved
+- External tools: Use any additional tools (like search tools) as needed for your goal
+
+# Important guidelines
+1. ALWAYS use tools - never just provide text responses about what you plan to do
+2. Break down complex actions into individual atomic steps
+3. For \`act\` commands, use only one action at a time, such as:
+   - Single click on a specific element
+   - Type into a single input field
+   - Select a single option
+4. Avoid combining multiple actions in one instruction
+5. If multiple actions are needed, they should be separate steps
+6. Only use \`close\` when the task is genuinely complete or impossible to achieve`,
+    };
+}
+export function buildCuaDefaultSystemPrompt() {
+    return `You are a helpful assistant that can use a web browser.\nDo not ask follow up questions, the user will trust your judgement. Today's date is ${new Date().toISOString().split("T")[0]}.`;
+}
+export function buildGoogleCUASystemPrompt() {
+    return {
+        role: "system",
+        content: `You are a general-purpose browser agent whose job is to accomplish the user's goal.
+Today's date is ${new Date().toISOString().split("T")[0]}.
+You have access to a search tool; however, in most cases you should operate within the page/url the user has provided. ONLY use the search tool if you're stuck or the task is impossible to complete within the current page.
+You will be given a goal and a list of steps that have been taken so far. Avoid requesting the user for input as much as possible. Good luck!
+`,
+    };
+}
+//# sourceMappingURL=prompt.js.map

package/dist/esm/lib/prompt.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompt.js","sourceRoot":"","sources":["../../../lib/prompt.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,2BAA2B,CACzC,wBAAiC;IAEjC,IAAI,CAAC,wBAAwB,EAAE,CAAC;QAC9B,OAAO,EAAE,CAAC;IACZ,CAAC;IAED,OAAO;;;;;EAKP,wBAAwB,EAAE,CAAC;AAC7B,CAAC;AAED,UAAU;AACV,MAAM,UAAU,wBAAwB,CACtC,gCAAyC,KAAK,EAC9C,wBAAiC;IAEjC,MAAM,WAAW,GAAG;;;;;;IAMlB,CAAC;IAEH,MAAM,aAAa,GAAG,yCAAyC,CAAC;IAEhE,MAAM,YAAY,GAAG;;;GAGpB,CAAC,IAAI,EAAE,CAAC;IAET,MAAM,gBAAgB,GAAG,6BAA6B;QACpD,CAAC,CAAC;;;GAGH,CAAC,IAAI,EAAE;QACN,CAAC,CAAC,EAAE,CAAC;IAEP,MAAM,sBAAsB,GAC1B,+GAA+G;QAC/G,sFAAsF,CAAC;IAEzF,MAAM,gBAAgB,GAAG,2BAA2B,CAClD,wBAAwB,CACzB,CAAC;IAEF,MAAM,OAAO,GACX,GAAG,WAAW,GAAG,aAAa,OAAO,YAAY,KAAK,gBAAgB,GACpE,sBAAsB,CAAC,CAAC,CAAC,OAAO,sBAAsB,EAAE,CAAC,CAAC,CAAC,EAC7D,GAAG,gBAAgB,CAAC,CAAC,CAAC,OAAO,gBAAgB,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAE9E,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,OAAO;KACR,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,sBAAsB,CACpC,WAAmB,EACnB,WAAmB,EACnB,gCAAyC,KAAK;IAE9C,IAAI,OAAO,GAAG,gBAAgB,WAAW;OACpC,WAAW,EAAE,CAAC;IAEnB,IAAI,6BAA6B,EAAE,CAAC;QAClC,OAAO,IAAI;;qEAEsD,CAAC;IACpE,CAAC;IAED,OAAO;QACL,IAAI,EAAE,MAAM;QACZ,OAAO;KACR,CAAC;AACJ,CAAC;AAED,MAAM,oBAAoB,GAAG;;;;;;uEAM0C,CAAC;AAExE,MAAM,UAAU,yBAAyB;IACvC,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,oBAAoB;KAC9B,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,mBAAmB,CACjC,WAAmB,EACnB,kBAA0B;IAE1B,OAAO;QACL,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,gBAAgB,WAAW;qBACnB,IAAI,CAAC,SAAS,CAAC,kBAAkB,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE;KAC/D,CAAC;AACJ,CAAC;AAED,UAAU;AACV,MAAM,UAAU,wBAAwB,CACtC,wBAAiC,EACjC,gBAA2B;IAE3B,MAAM,aAAa,GAAG,gBAAgB,EAAE,MAAM;QAC5C,CAAC,CAAC,0BAA0B,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;QACzD,CAAC,CAAC,EAAE,CAAC;IAEP,MAAM,mBAAmB,GAAG;;;;;;;;0FAQ4D,aAAa,kFAAkF,CAAC;IACxL,MAAM,OAAO,GAAG,mBAAmB,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAEzD,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,CAAC,OAAO,EAAE,2BAA2B,CAAC,wBAAwB,CAAC,CAAC;aACtE,MAAM,CAAC,OAAO,CAAC;aACf,IAAI,CAAC,MAAM,CAAC;KAChB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,uBAAuB,CACrC,WAAmB,EACnB,WAAmB;IAEnB,OAAO;QACL,IAAI,EAAE,MAAM;QACZ,OAAO,EAAE,gBAAgB,WAAW;wBAChB,WAAW,IAAI;KACpC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,oBAAoB,CAClC,wBAAiC;IAEjC,MAAM,eAAe,GAAG;;;;;;;iGAOuE,CAAC;IAChG,MAAM,OAAO,GAAG,eAAe,CAAC,OAAO,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;IAErD,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE,CAAC,OAAO,EAAE,2BAA2B,CAAC,wBAAwB,CAAC,CAAC;aACtE,MAAM,CAAC,OAAO,CAAC;aACf,IAAI,CAAC,MAAM,CAAC;KAChB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,cAAc,CAC5B,MAAc,EACd,gBAA0B,EAC1B,SAAkC;IAElC,mBAAmB;IACnB,IAAI,WAAW,GAAG,sFAAsF,MAAM;;;;iDAI/D,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC;;;;;;;;;;;;;;;;;;;;GAoBzE,CAAC;IAEF,4DAA4D;IAC5D,IAAI,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACnD,MAAM,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;aACzC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,GAAG,GAAG,CAAC;aACxB,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,MAAM,eAAe,GAAG,+DAA+D,aAAa,uDAAuD,CAAC;QAC5J,WAAW,IAAI,IAAI,eAAe,EAAE,CAAC;IACvC,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,MAAM,UAAU,kBAAkB,CAChC,kBAA0B,EAC1B,cAAsB,EACtB,gBAA0B,EAC1B,SAAkC;IAElC,mBAAmB;IACnB,IAAI,WAAW,GAAG;kCACc,kBAAkB;0EACsB,cAAc;;;;;+CAKzC,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC;;;;;;GAMvE,CAAC;IAEF,4DAA4D;IAC5D,IAAI,SAAS,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACnD,MAAM,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;aACzC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,IAAI,GAAG,GAAG,CAAC;aACxB,IAAI,CAAC,IAAI,CAAC,CAAC;QACd,MAAM,eAAe,GAAG,+DAA+D,aAAa,uDAAuD,CAAC;QAC5J,WAAW,IAAI,IAAI,eAAe,EAAE,CAAC;IACvC,CAAC;IAED,OAAO,WAAW,CAAC;AACrB,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,IAAY;IACpD,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;;;;;EAKX,IAAI;;;;;;;;;;;;;;;;;;;;;;;mFAuB6E;KAChF,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,2BAA2B;IACzC,OAAO,gJAAgJ,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;AACnM,CAAC;AAED,MAAM,UAAU,0BAA0B;IACxC,OAAO;QACL,IAAI,EAAE,QAAQ;QACd,OAAO,EAAE;kBACK,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC;;;CAGvD;KACE,CAAC;AACJ,CAAC","sourcesContent":["import { ChatMessage } from \"./v3/llm/LLMClient.js\";\n\nexport function buildUserInstructionsString(\n  userProvidedInstructions?: string,\n): string {\n  if (!userProvidedInstructions) {\n    return \"\";\n  }\n\n  return `\\n\\n# Custom Instructions Provided by the User\n    \nPlease keep the user's instructions in mind when performing actions. If the user's instructions are not relevant to the current task, ignore them.\n\nUser Instructions:\n${userProvidedInstructions}`;\n}\n\n// extract\nexport function buildExtractSystemPrompt(\n  isUsingPrintExtractedDataTool: boolean = false,\n  userProvidedInstructions?: string,\n): ChatMessage {\n  const baseContent = `You are extracting content on behalf of a user.\n  If a user asks you to extract a 'list' of information, or 'all' information, \n  YOU MUST EXTRACT ALL OF THE INFORMATION THAT THE USER REQUESTS.\n   \n  You will be given:\n1. An instruction\n2. `;\n\n  const contentDetail = `A list of DOM elements to extract from.`;\n\n  const instructions = `\nPrint the exact text from the DOM elements with all symbols, characters, and endlines as is.\nPrint null or an empty string if no new information is found.\n  `.trim();\n\n  const toolInstructions = isUsingPrintExtractedDataTool\n    ? `\nONLY print the content using the print_extracted_data tool provided.\nONLY print the content using the print_extracted_data tool provided.\n  `.trim()\n    : \"\";\n\n  const additionalInstructions =\n    \"If a user is attempting to extract links or URLs, you MUST respond with ONLY the IDs of the link elements. \\n\" +\n    \"Do not attempt to extract links directly from the text unless absolutely necessary. \";\n\n  const userInstructions = buildUserInstructionsString(\n    userProvidedInstructions,\n  );\n\n  const content =\n    `${baseContent}${contentDetail}\\n\\n${instructions}\\n${toolInstructions}${\n      additionalInstructions ? `\\n\\n${additionalInstructions}` : \"\"\n    }${userInstructions ? `\\n\\n${userInstructions}` : \"\"}`.replace(/\\s+/g, \" \");\n\n  return {\n    role: \"system\",\n    content,\n  };\n}\n\nexport function buildExtractUserPrompt(\n  instruction: string,\n  domElements: string,\n  isUsingPrintExtractedDataTool: boolean = false,\n): ChatMessage {\n  let content = `Instruction: ${instruction}\nDOM: ${domElements}`;\n\n  if (isUsingPrintExtractedDataTool) {\n    content += `\nONLY print the content using the print_extracted_data tool provided.\nONLY print the content using the print_extracted_data tool provided.`;\n  }\n\n  return {\n    role: \"user\",\n    content,\n  };\n}\n\nconst metadataSystemPrompt = `You are an AI assistant tasked with evaluating the progress and completion status of an extraction task.\nAnalyze the extraction response and determine if the task is completed or if more information is needed.\nStrictly abide by the following criteria:\n1. Once the instruction has been satisfied by the current extraction response, ALWAYS set completion status to true and stop processing, regardless of remaining chunks.\n2. Only set completion status to false if BOTH of these conditions are true:\n   - The instruction has not been satisfied yet\n   - There are still chunks left to process (chunksTotal > chunksSeen)`;\n\nexport function buildMetadataSystemPrompt(): ChatMessage {\n  return {\n    role: \"system\",\n    content: metadataSystemPrompt,\n  };\n}\n\nexport function buildMetadataPrompt(\n  instruction: string,\n  extractionResponse: object,\n): ChatMessage {\n  return {\n    role: \"user\",\n    content: `Instruction: ${instruction}\nExtracted content: ${JSON.stringify(extractionResponse, null, 2)}`,\n  };\n}\n\n// observe\nexport function buildObserveSystemPrompt(\n  userProvidedInstructions?: string,\n  supportedActions?: string[],\n): ChatMessage {\n  const actionsString = supportedActions?.length\n    ? `\\n\\nSupported actions: ${supportedActions.join(\", \")}`\n    : \"\";\n\n  const observeSystemPrompt = `\nYou are helping the user automate the browser by finding elements based on what the user wants to observe in the page.\n\nYou will be given:\n1. a instruction of elements to observe\n2. a hierarchical accessibility tree showing the semantic structure of the page. The tree is a hybrid of the DOM and the accessibility tree.\n\nReturn an array of elements that match the instruction if they exist, otherwise return an empty array.\nWhen returning elements, include the appropriate method from the supported actions list.${actionsString}. When choosing non-left click actions, provide right or middle as the argument.`;\n  const content = observeSystemPrompt.replace(/\\s+/g, \" \");\n\n  return {\n    role: \"system\",\n    content: [content, buildUserInstructionsString(userProvidedInstructions)]\n      .filter(Boolean)\n      .join(\"\\n\\n\"),\n  };\n}\n\nexport function buildObserveUserMessage(\n  instruction: string,\n  domElements: string,\n): ChatMessage {\n  return {\n    role: \"user\",\n    content: `instruction: ${instruction}\nAccessibility Tree: \\n${domElements}\\n`,\n  };\n}\n\nexport function buildActSystemPrompt(\n  userProvidedInstructions?: string,\n): ChatMessage {\n  const actSystemPrompt = `\nYou are helping the user automate the browser by finding elements based on what action the user wants to take on the page\n\nYou will be given:\n1. a user defined instruction about what action to take\n2. a hierarchical accessibility tree showing the semantic structure of the page. The tree is a hybrid of the DOM and the accessibility tree.\n\nReturn the element that matches the instruction if it exists. Otherwise, return an empty object.`;\n  const content = actSystemPrompt.replace(/\\s+/g, \" \");\n\n  return {\n    role: \"system\",\n    content: [content, buildUserInstructionsString(userProvidedInstructions)]\n      .filter(Boolean)\n      .join(\"\\n\\n\"),\n  };\n}\n\nexport function buildActPrompt(\n  action: string,\n  supportedActions: string[],\n  variables?: Record<string, string>,\n): string {\n  // Base instruction\n  let instruction = `Find the most relevant element to perform an action on given the following action: ${action}.  \n  IF AND ONLY IF the action EXPLICITLY includes the word 'dropdown' and implies choosing/selecting an option from a dropdown, ignore the 'General Instructions' section, and follow the 'Dropdown Specific Instructions' section carefully.\n  \n  General Instructions: \n    Provide an action for this element such as ${supportedActions.join(\", \")}. Remember that to users, buttons and links look the same in most cases.\n    When choosing non-left click actions, provide right or middle as the argument\n    If the action is completely unrelated to a potential action to be taken on the page, return an empty object. \n    ONLY return one action. If multiple actions are relevant, return the most relevant one. \n    If the user is asking to scroll to a position on the page, e.g., 'halfway' or 0.75, etc, you must return the argument formatted as the correct percentage, e.g., '50%' or '75%', etc.\n    If the user is asking to scroll to the next chunk/previous chunk, choose the nextChunk/prevChunk method. No arguments are required here.\n    If the action implies a key press, e.g., 'press enter', 'press a', 'press space', etc., always choose the press method with the appropriate key as argument — e.g. 'a', 'Enter', 'Space'. Do not choose a click action on an on-screen keyboard. Capitalize the first character like 'Enter', 'Tab', 'Escape' only for special keys. \n  \n  Dropdown Specific Instructions:\n    For interacting with dropdowns, there are two specific cases that you need to handle. \n    \n    CASE 1: the element is a 'select' element. \n      - choose the selectOptionFromDropdown method,\n      - set the argument to the exact text of the option that should be selected,\n      - set twoStep to false.\n    CASE 2: the element is NOT a 'select' element:\n      - do not attempt to directly choose the element from the dropdown. You will need to click to expand the dropdown first. You will achieve this by following these instructions:\n        - choose the node that most closely corresponds to the given instruction EVEN if it is a 'StaticText' element, or otherwise does not appear to be interactable.  \n        - choose the 'click' method\n        - set twoStep to true.\n  `;\n\n  // Add variable names (not values) to the instruction if any\n  if (variables && Object.keys(variables).length > 0) {\n    const variableNames = Object.keys(variables)\n      .map((key) => `%${key}%`)\n      .join(\", \");\n    const variablesPrompt = `The following variables are available to use in the action: ${variableNames}. Fill the argument variables with the variable name.`;\n    instruction += ` ${variablesPrompt}`;\n  }\n\n  return instruction;\n}\n\nexport function buildStepTwoPrompt(\n  originalUserAction: string,\n  previousAction: string,\n  supportedActions: string[],\n  variables?: Record<string, string>,\n): string {\n  // Base instruction\n  let instruction = `\n  The original user action was: ${originalUserAction}.\n  You have just taken the following action which completed step 1 of 2: ${previousAction}.\n  \n  Now, you must find the most relevant element to perform an action on in order to complete step 2 of 2. \n  \n  General Instructions: \n  Provide an action for this element such as ${supportedActions.join(\", \")}. Remember that to users, buttons and links look the same in most cases.\n  If the action is completely unrelated to a potential action to be taken on the page, return an empty object. \n  ONLY return one action. If multiple actions are relevant, return the most relevant one. \n  If the user is asking to scroll to a position on the page, e.g., 'halfway' or 0.75, etc, you must return the argument formatted as the correct percentage, e.g., '50%' or '75%', etc.\n  If the user is asking to scroll to the next chunk/previous chunk, choose the nextChunk/prevChunk method. No arguments are required here.\n  If the action implies a key press, e.g., 'press enter', 'press a', 'press space', etc., always choose the press method with the appropriate key as argument — e.g. 'a', 'Enter', 'Space'. Do not choose a click action on an on-screen keyboard. Capitalize the first character like 'Enter', 'Tab', 'Escape' only for special keys. \n  `;\n\n  // Add variable names (not values) to the instruction if any\n  if (variables && Object.keys(variables).length > 0) {\n    const variableNames = Object.keys(variables)\n      .map((key) => `%${key}%`)\n      .join(\", \");\n    const variablesPrompt = `The following variables are available to use in the action: ${variableNames}. Fill the argument variables with the variable name.`;\n    instruction += ` ${variablesPrompt}`;\n  }\n\n  return instruction;\n}\n\nexport function buildOperatorSystemPrompt(goal: string): ChatMessage {\n  return {\n    role: \"system\",\n    content: `You are a general-purpose agent whose job is to accomplish the user's goal across multiple model calls by running actions on the page.\n\nYou will be given a goal and a list of steps that have been taken so far. Your job is to determine if either the user's goal has been completed or if there are still steps that need to be taken.\n\n# Your current goal\n${goal}\n\n# CRITICAL: You MUST use the provided tools to take actions. Do not just describe what you want to do - actually call the appropriate tools.\n\n# Available tools and when to use them:\n- \\`act\\`: Use this to interact with the page (click, type, navigate, etc.)\n- \\`extract\\`: Use this to get information from the page\n- \\`goto\\`: Use this to navigate to a specific URL\n- \\`wait\\`: Use this to wait for a period of time\n- \\`navback\\`: Use this to go back to the previous page\n- \\`refresh\\`: Use this to refresh the current page\n- \\`close\\`: Use this ONLY when the task is complete or cannot be achieved\n- External tools: Use any additional tools (like search tools) as needed for your goal\n\n# Important guidelines\n1. ALWAYS use tools - never just provide text responses about what you plan to do\n2. Break down complex actions into individual atomic steps\n3. For \\`act\\` commands, use only one action at a time, such as:\n   - Single click on a specific element\n   - Type into a single input field\n   - Select a single option\n4. Avoid combining multiple actions in one instruction\n5. If multiple actions are needed, they should be separate steps\n6. Only use \\`close\\` when the task is genuinely complete or impossible to achieve`,\n  };\n}\n\nexport function buildCuaDefaultSystemPrompt(): string {\n  return `You are a helpful assistant that can use a web browser.\\nDo not ask follow up questions, the user will trust your judgement. Today's date is ${new Date().toISOString().split(\"T\")[0]}.`;\n}\n\nexport function buildGoogleCUASystemPrompt(): ChatMessage {\n  return {\n    role: \"system\",\n    content: `You are a general-purpose browser agent whose job is to accomplish the user's goal.\nToday's date is ${new Date().toISOString().split(\"T\")[0]}.\nYou have access to a search tool; however, in most cases you should operate within the page/url the user has provided. ONLY use the search tool if you're stuck or the task is impossible to complete within the current page.\nYou will be given a goal and a list of steps that have been taken so far. Avoid requesting the user for input as much as possible. Good luck!\n`,\n  };\n}\n"]}

package/dist/esm/lib/utils.d.ts

@@ -0,0 +1,68 @@
+import { Schema } from "@google/genai";
+import { z, ZodTypeAny } from "zod";
+import { LogLine } from "./v3/types/public/logs.js";
+import { ModelProvider } from "./v3/types/public/model.js";
+import { ZodPathSegments } from "./v3/types/private/internal.js";
+import type { StagehandZodSchema } from "./v3/zodCompat.js";
+export declare function getZFactory(schema: StagehandZodSchema): typeof z;
+export declare function validateZodSchema(schema: StagehandZodSchema, data: unknown): boolean;
+/**
+ * Detects if the code is running in the Bun runtime environment.
+ * @returns {boolean} True if running in Bun, false otherwise.
+ */
+export declare function isRunningInBun(): boolean;
+export declare function toGeminiSchema(zodSchema: StagehandZodSchema): Schema;
+export declare function getZodType(schema: StagehandZodSchema): string;
+/**
+ * Recursively traverses a given Zod schema, scanning for any fields of type `z.string().url()`.
+ * For each such field, it replaces the `z.string().url()` with `z.number()`.
+ *
+ * This function is used internally by higher-level utilities (e.g., transforming entire object schemas)
+ * and handles nested objects, arrays, unions, intersections, optionals.
+ *
+ * @param schema - The Zod schema to transform.
+ * @param currentPath - An array of string/number keys representing the current schema path (used internally for recursion).
+ * @returns A two-element tuple:
+ *   1. The updated Zod schema, with any `.url()` fields replaced by `z.number()`.
+ *   2. An array of {@link ZodPathSegments} objects representing each replaced field, including the path segments.
+ */
+export declare function transformSchema(schema: StagehandZodSchema, currentPath: Array<string | number>): [StagehandZodSchema, ZodPathSegments[]];
+/**
+ * Once we get the final extracted object that has numeric IDs in place of URLs,
+ * use `injectUrls` to walk the object and replace numeric IDs
+ * with the real URL strings from idToUrlMapping. The `path` may include `*`
+ * for array indices (indicating "all items in the array").
+ */
+export declare function injectUrls(obj: unknown, path: Array<string | number>, idToUrlMapping: Record<string, string>): void;
+/**
+ * Mapping from LLM provider names to their corresponding environment variable names for API keys.
+ */
+export declare const providerEnvVarMap: Partial<Record<ModelProvider | string, string | Array<string>>>;
+/**
+ * Loads an API key for a provider, checking environment variables.
+ * @param provider The name of the provider (e.g., 'openai', 'anthropic')
+ * @param logger Optional logger for info/error messages
+ * @returns The API key if found, undefined otherwise
+ */
+export declare function loadApiKeyFromEnv(provider: string | undefined, logger: (logLine: LogLine) => void): string | undefined;
+export declare function trimTrailingTextNode(path: string | undefined): string | undefined;
+export interface JsonSchemaProperty {
+    type: string;
+    enum?: unknown[];
+    items?: JsonSchemaProperty;
+    properties?: Record<string, JsonSchemaProperty>;
+    required?: string[];
+    minimum?: number;
+    maximum?: number;
+    description?: string;
+    format?: string;
+}
+export interface JsonSchema extends JsonSchemaProperty {
+    type: string;
+}
+/**
+ * Converts a JSON Schema object to a Zod schema
+ * @param schema The JSON Schema object to convert
+ * @returns A Zod schema equivalent to the input JSON Schema
+ */
+export declare function jsonSchemaToZod(schema: JsonSchema): ZodTypeAny;