fix conflict

Author: JerryWu1234

.changeset/khaki-numbers-fly.md

@@ -1,5 +1,27 @@
 # @browserbasehq/stagehand
 
+## 3.0.0
+
+### Major Changes 
+
+- Removes internal Playwright dependency
+- A generous 20-40% speed increase across `act`, `extract`, & `observe` calls
+- Compatibility with Playwright, Puppeteer, and Patchright
+- Automatic action caching (agent, stagehand.act). Go from CUA → deterministic scripts w/o inference
+- A suite of non AI primitives:
+    - `page`
+    - `locator` (built in closed mode shadow root traversal, with xpaths & css selectors)
+    - `frameLocator`
+    - `deepLocator` (crosses iframes & shadow roots)
+- bun compatibility
+- Simplified extract schemas
+- CSS selector support (id-based support coming soon)
+- Targeted extract and observe across iframes & shadow roots
+- More intuitive type names (observeResult is now action, act accepts an instruction string instead of an action string, solidified ModelConfiguration)
+
+Check the [migration guide](https://docs.stagehand.dev/v3/migrations/v2) for more information
+
+
 ## 2.5.0
 
 ### Minor Changes

CHANGELOG.md

@@ -129,8 +129,6 @@ At a high level, we're focused on improving reliability, speed, and cost in that
 
 ## Acknowledgements
 
-This project heavily relies on [Playwright](https://playwright.dev/) as a resilient backbone to automate the web. It also would not be possible without the awesome techniques and discoveries made by [tarsier](https://github.com/reworkd/tarsier), [gemini-zod](https://github.com/jbeoris/gemini-zod), and [fuji-web](https://github.com/normal-computing/fuji-web).
-
 We'd like to thank the following people for their major contributions to Stagehand:
 - [Paul Klein](https://github.com/pkiv)
 - [Sean McGuire](https://github.com/seanmcguire12)

README.md

@@ -0,0 +1,17 @@
+# @browserbasehq/stagehand
+
+## 3.0.1
+
+### Patch Changes
+
+- [#1207](https://github.com/browserbase/stagehand/pull/1207) [`55da8c6`](https://github.com/browserbase/stagehand/commit/55da8c6e9575cbad3246c55b17650cf6b293ddbe) Thanks [@miguelg719](https://github.com/miguelg719)! - Fix broken links to quickstart docs
+
+- [#1200](https://github.com/browserbase/stagehand/pull/1200) [`0a5ee63`](https://github.com/browserbase/stagehand/commit/0a5ee638bde051d109eb2266e665934a12f3dc31) Thanks [@seanmcguire12](https://github.com/seanmcguire12)! - log info when scope narrowing selector fails
+
+- [#1205](https://github.com/browserbase/stagehand/pull/1205) [`ee76881`](https://github.com/browserbase/stagehand/commit/ee7688156cb67a9f0f90dfe0dbab77423693a332) Thanks [@miguelg719](https://github.com/miguelg719)! - Update README.md, add Changelog for v3
+
+- [#1209](https://github.com/browserbase/stagehand/pull/1209) [`9e95add`](https://github.com/browserbase/stagehand/commit/9e95add37eb30db4f85e73df7760c7e63fb4131e) Thanks [@seanmcguire12](https://github.com/seanmcguire12)! - fix circular import in exported aisdk example client
+
+- [#1211](https://github.com/browserbase/stagehand/pull/1211) [`98e212b`](https://github.com/browserbase/stagehand/commit/98e212b27887241879608c6c1b6c2524477a40d7) Thanks [@miguelg719](https://github.com/miguelg719)! - Add an example for passing custom tools to agent
+
+- [#1206](https://github.com/browserbase/stagehand/pull/1206) [`d5ecbfc`](https://github.com/browserbase/stagehand/commit/d5ecbfc8e419a59b91c2115fd7f984378381d3d0) Thanks [@miguelg719](https://github.com/miguelg719)! - Export example AISdkClient properly from the stagehand package

packages/core/CHANGELOG.md

@@ -0,0 +1,148 @@
+<div id="toc" align="center" style="margin-bottom: 0;">
+  <ul style="list-style: none; margin: 0; padding: 0;">
+    <a href="https://stagehand.dev">
+      <picture>
+        <source media="(prefers-color-scheme: dark)" srcset="media/dark_logo.png" />
+        <img alt="Stagehand" src="media/light_logo.png" width="200" style="margin-right: 30px;" />
+      </picture>
+    </a>
+  </ul>
+</div>
+<p align="center">
+  <strong>The AI Browser Automation Framework</strong><br>
+  <a href="https://docs.stagehand.dev">Read the Docs</a>
+</p>
+
+<p align="center">
+  <a href="https://github.com/browserbase/stagehand/tree/main?tab=MIT-1-ov-file#MIT-1-ov-file">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="media/dark_license.svg" />
+      <img alt="MIT License" src="media/light_license.svg" />
+    </picture>
+  </a>
+  <a href="https://join.slack.com/t/stagehand-dev/shared_invite/zt-38khc8iv5-T2acb50_0OILUaX7lxeBOg">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="media/dark_slack.svg" />
+      <img alt="Slack Community" src="media/light_slack.svg" />
+    </picture>
+  </a>
+</p>
+
+<p align="center">
+	<a href="https://trendshift.io/repositories/12122" target="_blank"><img src="https://trendshift.io/api/badge/repositories/12122" alt="browserbase%2Fstagehand | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
+</p>
+
+<p align="center">
+If you're looking for the Python implementation, you can find it 
+<a href="https://github.com/browserbase/stagehand-python"> here</a>
+</p>
+
+<div align="center" style="display: flex; align-items: center; justify-content: center; gap: 4px; margin-bottom: 0;">
+  <b>Vibe code</b>
+  <span style="font-size: 1.05em;"> Stagehand with </span>
+  <a href="https://director.ai" style="display: flex; align-items: center;">
+    <span>Director</span>
+  </a>
+  <span> </span>
+  <picture>
+    <img alt="Director" src="media/director_icon.svg" width="25" />
+  </picture>
+</div>
+
+## What is Stagehand?
+
+Stagehand is a browser automation framework used to control web browsers with natural language and code. By combining the power of AI with the precision of code, Stagehand makes web automation flexible, maintainable, and actually reliable.
+
+## Why Stagehand?
+
+Most existing browser automation tools either require you to write low-level code in a framework like Selenium, Playwright, or Puppeteer, or use high-level agents that can be unpredictable in production. By letting developers choose what to write in code vs. natural language (and bridging the gap between the two) Stagehand is the natural choice for browser automations in production.
+
+1. **Choose when to write code vs. natural language**: use AI when you want to navigate unfamiliar pages, and use code when you know exactly what you want to do.
+
+2. **Go from AI-driven to repeatable workflows**: Stagehand lets you preview AI actions before running them, and also helps you easily cache repeatable actions to save time and tokens.
+
+3. **Write once, run forever**: Stagehand's auto-caching combined with self-healing remembers previous actions, runs without LLM inference, and knows when to involve AI whenever the website changes and your automation breaks.
+
+## Getting Started
+
+Start with Stagehand with one line of code, or check out our [Quickstart Guide](https://docs.stagehand.dev/v3/first-steps/quickstart) for more information:
+
+```bash
+npx create-browser-app
+```
+
+## Example
+
+Here's how to build a sample browser automation with Stagehand:
+
+```typescript
+// Stagehand's CDP engine provides an optimized, low level interface to the browser built for automation
+const page = stagehand.context.pages()[0];
+await page.goto("https://github.com/browserbase");
+
+// Use act() to execute individual actions
+await stagehand.act("click on the stagehand repo");
+
+// Use agent() for multi-step tasks
+const agent = stagehand.agent();
+await agent.execute("Get to the latest PR");
+
+// Use extract() to get structured data from the page
+const { author, title } = await stagehand.extract(
+  "extract the author and title of the PR",
+  z.object({
+    author: z.string().describe("The username of the PR author"),
+    title: z.string().describe("The title of the PR"),
+  }),
+);
+```
+
+## Documentation
+
+Visit [docs.stagehand.dev](https://docs.stagehand.dev) to view the full documentation.
+
+### Build and Run from Source
+
+```bash
+git clone https://github.com/browserbase/stagehand.git
+cd stagehand
+pnpm install
+pnpm run build
+pnpm run example # run the blank script at ./examples/example.ts
+```
+
+Stagehand is best when you have an API key for an LLM provider and Browserbase credentials. To add these to your project, run:
+
+```bash
+cp .env.example .env
+nano .env # Edit the .env file to add API keys
+```
+
+## Contributing
+
+> [!NOTE]  
+> We highly value contributions to Stagehand! For questions or support, please join our [Slack community](https://join.slack.com/t/stagehand-dev/shared_invite/zt-38khc8iv5-T2acb50_0OILUaX7lxeBOg).
+
+At a high level, we're focused on improving reliability, extensibility, speed, and cost in that order of priority. If you're interested in contributing, **bug fixes and small improvements are the best way to get started**. For more involved features, we strongly recommend reaching out to [Miguel Gonzalez](https://x.com/miguel_gonzf) or [Paul Klein](https://x.com/pk_iv) in our [Slack community](https://join.slack.com/t/stagehand-dev/shared_invite/zt-38khc8iv5-T2acb50_0OILUaX7lxeBOg) before starting to ensure that your contribution aligns with our goals.
+
+<!-- For more information, please see our [Contributing Guide](https://docs.stagehand.dev/examples/contributing). -->
+
+## Acknowledgements
+
+We'd like to thank the following people for their major contributions to Stagehand:
+
+- [Paul Klein](https://github.com/pkiv)
+- [Sean McGuire](https://github.com/seanmcguire12)
+- [Miguel Gonzalez](https://github.com/miguelg719)
+- [Sameel Arif](https://github.com/sameelarif)
+- [Thomas Katwan](https://github.com/tkattkat)
+- [Filip Michalsky](https://github.com/filip-michalsky)
+- [Anirudh Kamath](https://github.com/kamath)
+- [Jeremy Press](https://x.com/jeremypress)
+- [Navid Pour](https://github.com/navidpour)
+
+## License
+
+Licensed under the MIT License.
+
+Copyright 2025 Browserbase, Inc.

packages/core/README.md

@@ -0,0 +1,107 @@
+/**
+ * This example shows how to pass custom tools to stagehand agent (both CUA and non-CUA)
+ */
+import { z } from "zod/v3";
+import { tool } from "ai";
+import { Stagehand } from "../lib/v3";
+import chalk from "chalk";
+
+// Mock weather API, replace with your own API/tool logic
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+const fetchWeatherAPI = async (location: string) => {
+  return {
+    temp: 70,
+    conditions: "sunny",
+  };
+};
+
+// Define the tool in an AI SDK format
+const getWeather = tool({
+  description: "Get the current weather in a location",
+  inputSchema: z.object({
+    location: z.string().describe("The location to get weather for"),
+  }),
+  execute: async ({ location }) => {
+    // Your custom logic here
+    const weather = await fetchWeatherAPI(location);
+    return {
+      location,
+      temperature: weather.temp,
+      conditions: weather.conditions,
+    };
+  },
+});
+
+async function main() {
+  console.log(
+    `\n${chalk.bold("Stagehand 🤘 Computer Use Agent (CUA) Demo")}\n`,
+  );
+
+  // Initialize Stagehand
+  const stagehand = new Stagehand({
+    env: "LOCAL",
+    verbose: 2,
+    experimental: true, // You must enable experimental mode to use custom tools / MCP integrations
+    model: "anthropic/claude-sonnet-4-5",
+  });
+  await stagehand.init();
+
+  try {
+    const page = stagehand.context.pages()[0];
+
+    // Create a computer use agent
+    const agent = stagehand.agent({
+      cua: true,
+      model: {
+        modelName: "anthropic/claude-sonnet-4-5-20250929",
+        apiKey: process.env.ANTHROPIC_API_KEY,
+      },
+      systemPrompt: `You are a helpful assistant that can use a web browser.
+      You are currently on the following page: ${page.url()}.
+      Do not ask follow up questions, the user will trust your judgement. Today's date is ${new Date().toLocaleDateString()}.`,
+      tools: {
+        getWeather, // Pass the tools to the agent
+      },
+    });
+
+    // const agent = stagehand.agent({
+    //   systemPrompt: `You are a helpful assistant that can use a web browser.
+    //   You are currently on the following page: ${page.url()}.
+    //   Do not ask follow up questions, the user will trust your judgement. Today's date is ${new Date().toLocaleDateString()}.`,
+    //   // Pass the tools to the agent
+    //   tools: {
+    //     getWeather: getWeather,
+    //   },
+    // });
+
+    // Navigate to the Browserbase careers page
+    await page.goto("https://www.google.com");
+
+    // Define the instruction for the CUA
+    const instruction = "What's the weather in San Francisco?";
+    console.log(`Instruction: ${chalk.white(instruction)}`);
+
+    // Execute the instruction
+    const result = await agent.execute({
+      instruction,
+      maxSteps: 20,
+    });
+
+    console.log(`${chalk.green("✓")} Execution complete`);
+    console.log(`${chalk.yellow("⤷")} Result:`);
+    console.log(chalk.white(JSON.stringify(result, null, 2)));
+  } catch (error) {
+    console.log(`${chalk.red("✗")} Error: ${error}`);
+    if (error instanceof Error && error.stack) {
+      console.log(chalk.dim(error.stack.split("\n").slice(1).join("\n")));
+    }
+  } finally {
+    // Close the browser
+    await stagehand.close();
+  }
+}
+
+main().catch((error) => {
+  console.log(`${chalk.red("✗")} Unhandled error in main function`);
+  console.log(chalk.red(error));
+});

packages/core/examples/agent-custom-tools.ts

@@ -13,8 +13,8 @@ import type { LanguageModelV2 } from "@ai-sdk/provider";
 import {
   CreateChatCompletionOptions,
   LLMClient,
-  AvailableModel,
-} from "../../lib/v3";
+} from "../../lib/v3/llm/LLMClient";
+import { AvailableModel } from "../../lib/v3/types/public";
 import { ChatCompletion } from "openai/resources";
 
 export class AISdkClient extends LLMClient {

packages/core/examples/external_clients/aisdk.ts

@@ -27,6 +27,7 @@ export const v3DynamicTestConfig: V3Options =
         env: "BROWSERBASE",
         apiKey: process.env.BROWSERBASE_API_KEY!,
         projectId: process.env.BROWSERBASE_PROJECT_ID!,
+        disableAPI: true,
       }
     : {
         ...baseConfig,

packages/core/lib/v3/tests/v3.dynamic.config.ts

@@ -7,3 +7,6 @@ export * from "./model";
 export * from "./options";
 export * from "./page";
 export * from "./sdkErrors";
+// Exporting the example AISdkClient for backwards compatibility
+// Note added for revisiting this scaffold for an improved version based on llm/aisdk.ts
+export { AISdkClient } from "../../../../examples/external_clients/aisdk";

packages/core/lib/v3/types/public/index.ts

@@ -1363,25 +1363,34 @@ export class V3 {
   } {
     this.logger({
       category: "agent",
-      message: "Creating v3 agent instance with options:",
+      message: `Creating v3 agent instance with options: ${JSON.stringify(options)}`,
       level: 1,
       auxiliary: {
         cua: { value: options?.cua ? "true" : "false", type: "boolean" },
-        model:
-          typeof options?.model === "string"
+        model: options?.model
+          ? typeof options?.model === "string"
             ? { value: options.model, type: "string" }
-            : { value: options.model.modelName, type: "string" },
+            : { value: options.model.modelName, type: "string" }
+          : { value: this.llmClient.modelName, type: "string" },
         systemPrompt: { value: options?.systemPrompt ?? "", type: "string" },
         tools: { value: JSON.stringify(options?.tools ?? {}), type: "object" },
-        integrations: {
-          value: JSON.stringify(options?.integrations ?? []),
-          type: "object",
-        },
+        ...(options?.integrations && {
+          integrations: {
+            value: JSON.stringify(options.integrations),
+            type: "object",
+          },
+        }),
       },
     });
 
     // If CUA is enabled, use the computer-use agent path
     if (options?.cua) {
+      if ((options?.integrations || options?.tools) && !this.experimental) {
+        throw new Error(
+          "MCP integrations and custom tools are experimental. Enable experimental: true in V3 options.",
+        );
+      }
+
       const modelToUse = options?.model || {
         modelName: this.modelName,
         ...this.modelClientOptions,
@@ -1499,9 +1508,9 @@ export class V3 {
     return {
       execute: async (instructionOrOptions: string | AgentExecuteOptions) =>
         withInstanceLogContext(this.instanceId, async () => {
-          if (options?.integrations && !this.experimental) {
+          if ((options?.integrations || options?.tools) && !this.experimental) {
             throw new Error(
-              "MCP integrations are experimental. Enable experimental: true in V3 options.",
+              "MCP integrations and custom tools are experimental. Enable experimental: true in V3 options.",
             );
           }