@browserbasehq/orca 3.1.0-patch.4 → 3.2.0-middleware.1

package/dist/esm/tests/unit/openai-cua-client.test.js

@@ -0,0 +1,69 @@
+import { describe, expect, it, vi } from "vitest";
+import { OpenAICUAClient } from "../../lib/v3/agent/OpenAICUAClient.js";
+function createClient() {
+    return new OpenAICUAClient("openai", "computer-use-preview-2025-03-11", undefined, { apiKey: "test-key" });
+}
+describe("OpenAICUAClient", () => {
+    it("exposes captchaSolvedProceed tool after a captcha context note", () => {
+        const client = createClient();
+        // Before captcha note — tool should not be active
+        expect(client
+            .captchaSolvedToolActive).toBe(false);
+        // Simulate a captcha context note being added (as the CUA handler does)
+        client.addContextNote("A captcha was automatically detected and solved — no further interaction needed.");
+        expect(client
+            .captchaSolvedToolActive).toBe(true);
+    });
+    it("does NOT activate captcha tool for non-captcha context notes", () => {
+        const client = createClient();
+        client.addContextNote("The page has finished loading.");
+        expect(client
+            .captchaSolvedToolActive).toBe(false);
+    });
+    it("deactivates captcha tool after takeAction handles the function call", async () => {
+        const client = createClient();
+        client.addContextNote("A captcha was solved.");
+        expect(client
+            .captchaSolvedToolActive).toBe(true);
+        // Simulate the model calling the captchaSolvedProceed tool
+        const result = await client.takeAction([
+            {
+                type: "function_call",
+                name: "captchaSolvedProceed",
+                call_id: "call-1",
+                arguments: "{}",
+            },
+        ], vi.fn());
+        // Tool should be deactivated
+        expect(client
+            .captchaSolvedToolActive).toBe(false);
+        // Result should contain a function_call_output confirming proceed
+        expect(result).toEqual([
+            {
+                type: "function_call_output",
+                call_id: "call-1",
+                output: expect.stringContaining("Continue completing"),
+            },
+        ]);
+    });
+    it("does NOT auto-continue follow-up questions without a captcha context", async () => {
+        const client = createClient();
+        const executeStepSpy = vi.spyOn(client, "executeStep");
+        executeStepSpy.mockResolvedValueOnce({
+            actions: [],
+            message: "I've located the Submit button. Should I go ahead and submit it?",
+            completed: true,
+            nextInputItems: [],
+            responseId: "response-1",
+            usage: { input_tokens: 1, output_tokens: 1, inference_time_ms: 1 },
+        });
+        const result = await client.execute({
+            options: { instruction: "Submit the form.", maxSteps: 10 },
+            logger: vi.fn(),
+        });
+        // Should NOT have continued — the model's follow-up is treated as completion
+        expect(executeStepSpy).toHaveBeenCalledTimes(1);
+        expect(result.completed).toBe(true);
+    });
+});
+//# sourceMappingURL=openai-cua-client.test.js.map

package/dist/esm/tests/unit/openai-cua-client.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"openai-cua-client.test.js","sourceRoot":"","sources":["../../../../tests/unit/openai-cua-client.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAClD,OAAO,EAAE,eAAe,EAAE,MAAM,uCAAuC,CAAC;AAExE,SAAS,YAAY;IACnB,OAAO,IAAI,eAAe,CACxB,QAAQ,EACR,iCAAiC,EACjC,SAAS,EACT,EAAE,MAAM,EAAE,UAAU,EAAE,CACvB,CAAC;AACJ,CAAC;AAED,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,EAAE,CAAC,gEAAgE,EAAE,GAAG,EAAE;QACxE,MAAM,MAAM,GAAG,YAAY,EAAE,CAAC;QAE9B,kDAAkD;QAClD,MAAM,CACH,MAA0D;aACxD,uBAAuB,CAC3B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAEd,wEAAwE;QACxE,MAAM,CAAC,cAAc,CACnB,kFAAkF,CACnF,CAAC;QAEF,MAAM,CACH,MAA0D;aACxD,uBAAuB,CAC3B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACf,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8DAA8D,EAAE,GAAG,EAAE;QACtE,MAAM,MAAM,GAAG,YAAY,EAAE,CAAC;QAE9B,MAAM,CAAC,cAAc,CAAC,gCAAgC,CAAC,CAAC;QAExD,MAAM,CACH,MAA0D;aACxD,uBAAuB,CAC3B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,qEAAqE,EAAE,KAAK,IAAI,EAAE;QACnF,MAAM,MAAM,GAAG,YAAY,EAAE,CAAC;QAC9B,MAAM,CAAC,cAAc,CAAC,uBAAuB,CAAC,CAAC;QAE/C,MAAM,CACH,MAA0D;aACxD,uBAAuB,CAC3B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QAEb,2DAA2D;QAC3D,MAAM,MAAM,GAAG,MACb,MAMD,CAAC,UAAU,CACV;YACE;gBACE,IAAI,EAAE,eAAe;gBACrB,IAAI,EAAE,sBAAsB;gBAC5B,OAAO,EAAE,QAAQ;gBACjB,SAAS,EAAE,IAAI;aAChB;SACF,EACD,EAAE,CAAC,EAAE,EAAE,CACR,CAAC;QAEF,6BAA6B;QAC7B,MAAM,CACH,MAA0D;aACxD,uBAAuB,CAC3B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAEd,kEAAkE;QAClE,MAAM,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACrB;gBACE,IAAI,EAAE,sBAAsB;gBAC5B,OAAO,EAAE,QAAQ;gBACjB,MAAM,EAAE,MAAM,CAAC,gBAAgB,CAAC,qBAAqB,CAAC;aACvD;SACF,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sEAAsE,EAAE,KAAK,IAAI,EAAE;QACpF,MAAM,MAAM,GAAG,YAAY,EAAE,CAAC;QAgB9B,MAAM,cAAc,GAAG,EAAE,CAAC,KAAK,CAC7B,MAMC,EACD,aAAa,CACd,CAAC;QAEF,cAAc,CAAC,qBAAqB,CAAC;YACnC,OAAO,EAAE,EAAE;YACX,OAAO,EACL,kEAAkE;YACpE,SAAS,EAAE,IAAI;YACf,cAAc,EAAE,EAAE;YAClB,UAAU,EAAE,YAAY;YACxB,KAAK,EAAE,EAAE,YAAY,EAAE,CAAC,EAAE,aAAa,EAAE,CAAC,EAAE,iBAAiB,EAAE,CAAC,EAAE;SACnE,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,MAAM,MAAM,CAAC,OAAO,CAAC;YAClC,OAAO,EAAE,EAAE,WAAW,EAAE,kBAAkB,EAAE,QAAQ,EAAE,EAAE,EAAW;YACnE,MAAM,EAAE,EAAE,CAAC,EAAE,EAAE;SAChB,CAAC,CAAC;QAEH,6EAA6E;QAC7E,MAAM,CAAC,cAAc,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAChD,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACtC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { describe, expect, it, vi } from \"vitest\";\nimport { OpenAICUAClient } from \"../../lib/v3/agent/OpenAICUAClient.js\";\n\nfunction createClient() {\n  return new OpenAICUAClient(\n    \"openai\",\n    \"computer-use-preview-2025-03-11\",\n    undefined,\n    { apiKey: \"test-key\" },\n  );\n}\n\ndescribe(\"OpenAICUAClient\", () => {\n  it(\"exposes captchaSolvedProceed tool after a captcha context note\", () => {\n    const client = createClient();\n\n    // Before captcha note — tool should not be active\n    expect(\n      (client as unknown as { captchaSolvedToolActive: boolean })\n        .captchaSolvedToolActive,\n    ).toBe(false);\n\n    // Simulate a captcha context note being added (as the CUA handler does)\n    client.addContextNote(\n      \"A captcha was automatically detected and solved — no further interaction needed.\",\n    );\n\n    expect(\n      (client as unknown as { captchaSolvedToolActive: boolean })\n        .captchaSolvedToolActive,\n    ).toBe(true);\n  });\n\n  it(\"does NOT activate captcha tool for non-captcha context notes\", () => {\n    const client = createClient();\n\n    client.addContextNote(\"The page has finished loading.\");\n\n    expect(\n      (client as unknown as { captchaSolvedToolActive: boolean })\n        .captchaSolvedToolActive,\n    ).toBe(false);\n  });\n\n  it(\"deactivates captcha tool after takeAction handles the function call\", async () => {\n    const client = createClient();\n    client.addContextNote(\"A captcha was solved.\");\n\n    expect(\n      (client as unknown as { captchaSolvedToolActive: boolean })\n        .captchaSolvedToolActive,\n    ).toBe(true);\n\n    // Simulate the model calling the captchaSolvedProceed tool\n    const result = await (\n      client as unknown as {\n        takeAction: (\n          output: unknown[],\n          logger: (msg: unknown) => void,\n        ) => Promise<unknown[]>;\n      }\n    ).takeAction(\n      [\n        {\n          type: \"function_call\",\n          name: \"captchaSolvedProceed\",\n          call_id: \"call-1\",\n          arguments: \"{}\",\n        },\n      ],\n      vi.fn(),\n    );\n\n    // Tool should be deactivated\n    expect(\n      (client as unknown as { captchaSolvedToolActive: boolean })\n        .captchaSolvedToolActive,\n    ).toBe(false);\n\n    // Result should contain a function_call_output confirming proceed\n    expect(result).toEqual([\n      {\n        type: \"function_call_output\",\n        call_id: \"call-1\",\n        output: expect.stringContaining(\"Continue completing\"),\n      },\n    ]);\n  });\n\n  it(\"does NOT auto-continue follow-up questions without a captcha context\", async () => {\n    const client = createClient();\n    // No captcha context note — no tool should be exposed\n\n    type ExecuteStepResult = {\n      actions: Array<{ type: string }>;\n      message: string;\n      completed: boolean;\n      nextInputItems: unknown[];\n      responseId: string;\n      usage: {\n        input_tokens: number;\n        output_tokens: number;\n        inference_time_ms: number;\n      };\n    };\n\n    const executeStepSpy = vi.spyOn(\n      client as unknown as {\n        executeStep: (\n          inputItems: unknown[],\n          previousResponseId: string | undefined,\n          logger: (message: { message: string }) => void,\n        ) => Promise<ExecuteStepResult>;\n      },\n      \"executeStep\",\n    );\n\n    executeStepSpy.mockResolvedValueOnce({\n      actions: [],\n      message:\n        \"I've located the Submit button. Should I go ahead and submit it?\",\n      completed: true,\n      nextInputItems: [],\n      responseId: \"response-1\",\n      usage: { input_tokens: 1, output_tokens: 1, inference_time_ms: 1 },\n    });\n\n    const result = await client.execute({\n      options: { instruction: \"Submit the form.\", maxSteps: 10 } as never,\n      logger: vi.fn(),\n    });\n\n    // Should NOT have continued — the model's follow-up is treated as completion\n    expect(executeStepSpy).toHaveBeenCalledTimes(1);\n    expect(result.completed).toBe(true);\n  });\n});\n"]}

package/dist/esm/tests/unit/page-extra-http-headers.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/esm/tests/unit/page-extra-http-headers.test.js

@@ -0,0 +1,90 @@
+import { describe, expect, it } from "vitest";
+import { Page } from "../../lib/v3/understudy/page.js";
+import { MockCDPSession } from "./helpers/mockCDPSession.js";
+import { StagehandSetExtraHTTPHeadersError } from "../../lib/v3/types/public/sdkErrors.js";
+const makePage = (sessions) => {
+    const mainSession = sessions[0] ?? new MockCDPSession({}, "main");
+    const stub = {
+        mainSession,
+        sessions: new Map(sessions.map((s) => [s.id, s])),
+        extraHTTPHeaders: {},
+        // Bind the private helper from Page.prototype so setExtraHTTPHeaders can call it
+        applyExtraHTTPHeadersToSession: Page.prototype
+            .applyExtraHTTPHeadersToSession,
+    };
+    return stub;
+};
+describe("Page.setExtraHTTPHeaders", () => {
+    const setExtraHTTPHeaders = Page.prototype.setExtraHTTPHeaders;
+    it("sends headers to all sessions owned by the page", async () => {
+        const sessionA = new MockCDPSession({}, "session-a");
+        const sessionB = new MockCDPSession({}, "session-b");
+        const page = makePage([sessionA, sessionB]);
+        await setExtraHTTPHeaders.call(page, {
+            "x-stagehand-test": "hello",
+        });
+        for (const session of [sessionA, sessionB]) {
+            expect(session.callsFor("Network.enable").length).toBe(1);
+            expect(session.callsFor("Network.setExtraHTTPHeaders")[0]?.params).toEqual({
+                headers: { "x-stagehand-test": "hello" },
+            });
+        }
+    });
+    it("applies headers to mainSession even when sessions map is empty", async () => {
+        const page = makePage([]);
+        await setExtraHTTPHeaders.call(page, { "x-test": "value" });
+        // mainSession should still receive headers even though it's not in the sessions map
+        expect(page.mainSession.callsFor("Network.enable").length).toBe(1);
+        expect(page.mainSession.callsFor("Network.setExtraHTTPHeaders")[0]?.params).toEqual({
+            headers: { "x-test": "value" },
+        });
+    });
+    it("throws StagehandSetExtraHTTPHeadersError with session failure details", async () => {
+        const sessionA = new MockCDPSession({
+            "Network.setExtraHTTPHeaders": () => {
+                throw new Error("connection closed");
+            },
+        }, "session-a");
+        const sessionB = new MockCDPSession({}, "session-b");
+        const page = makePage([sessionA, sessionB]);
+        let caughtError;
+        try {
+            await setExtraHTTPHeaders.call(page, {
+                "x-stagehand-test": "yes",
+            });
+        }
+        catch (error) {
+            caughtError = error;
+        }
+        expect(caughtError).toBeInstanceOf(StagehandSetExtraHTTPHeadersError);
+        expect(caughtError?.failures).toHaveLength(1);
+        expect(caughtError?.failures[0]).toContain("session=session-a");
+        expect(caughtError?.failures[0]).toContain("connection closed");
+        // sessionB should still have been called successfully
+        expect(sessionB.callsFor("Network.setExtraHTTPHeaders").length).toBe(1);
+    });
+    it("applies headers to sessions adopted after the call", async () => {
+        const sessionA = new MockCDPSession({}, "session-a");
+        const page = makePage([sessionA]);
+        await setExtraHTTPHeaders.call(page, { "x-before": "yes" });
+        // A new OOPIF session is adopted after headers were set
+        const sessionB = new MockCDPSession({}, "session-b");
+        page.sessions.set(sessionB.id, sessionB);
+        // Simulate what adoptOopifSession does: replay headers onto the new session
+        await page.applyExtraHTTPHeadersToSession.call(page, sessionB, page.extraHTTPHeaders);
+        // The late-arriving session should have received the headers
+        expect(sessionB.callsFor("Network.enable").length).toBe(1);
+        expect(sessionB.callsFor("Network.setExtraHTTPHeaders")[0]?.params).toEqual({
+            headers: { "x-before": "yes" },
+        });
+    });
+    it("does not mutate the original headers object", async () => {
+        const session = new MockCDPSession({}, "session-a");
+        const page = makePage([session]);
+        const original = { "x-custom": "value" };
+        const frozen = { ...original };
+        await setExtraHTTPHeaders.call(page, original);
+        expect(original).toEqual(frozen);
+    });
+});
+//# sourceMappingURL=page-extra-http-headers.test.js.map

package/dist/esm/tests/unit/page-extra-http-headers.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"page-extra-http-headers.test.js","sourceRoot":"","sources":["../../../../tests/unit/page-extra-http-headers.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,IAAI,EAAE,MAAM,iCAAiC,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,EAAE,iCAAiC,EAAE,MAAM,wCAAwC,CAAC;AAY3F,MAAM,QAAQ,GAAG,CAAC,QAA0B,EAAY,EAAE;IACxD,MAAM,WAAW,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,IAAI,cAAc,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;IAClE,MAAM,IAAI,GAAa;QACrB,WAAW;QACX,QAAQ,EAAE,IAAI,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,CAAC;QACjD,gBAAgB,EAAE,EAAE;QACpB,iFAAiF;QACjF,8BAA8B,EAAG,IAAI,CAAC,SAAiC;aACpE,8BAA8B;KAClC,CAAC;IACF,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;IACxC,MAAM,mBAAmB,GAAG,IAAI,CAAC,SAAS,CAAC,mBAGzB,CAAC;IAEnB,EAAE,CAAC,iDAAiD,EAAE,KAAK,IAAI,EAAE;QAC/D,MAAM,QAAQ,GAAG,IAAI,cAAc,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QACrD,MAAM,QAAQ,GAAG,IAAI,cAAc,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QACrD,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;QAE5C,MAAM,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE;YACnC,kBAAkB,EAAE,OAAO;SAC5B,CAAC,CAAC;QAEH,KAAK,MAAM,OAAO,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,CAAC;YAC3C,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC1D,MAAM,CACJ,OAAO,CAAC,QAAQ,CAAC,6BAA6B,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAC3D,CAAC,OAAO,CAAC;gBACR,OAAO,EAAE,EAAE,kBAAkB,EAAE,OAAO,EAAE;aACzC,CAAC,CAAC;QACL,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,gEAAgE,EAAE,KAAK,IAAI,EAAE;QAC9E,MAAM,IAAI,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC;QAE1B,MAAM,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE,CAAC,CAAC;QAE5D,oFAAoF;QACpF,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACnE,MAAM,CACJ,IAAI,CAAC,WAAW,CAAC,QAAQ,CAAC,6BAA6B,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CACpE,CAAC,OAAO,CAAC;YACR,OAAO,EAAE,EAAE,QAAQ,EAAE,OAAO,EAAE;SAC/B,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uEAAuE,EAAE,KAAK,IAAI,EAAE;QACrF,MAAM,QAAQ,GAAG,IAAI,cAAc,CACjC;YACE,6BAA6B,EAAE,GAAG,EAAE;gBAClC,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;YACvC,CAAC;SACF,EACD,WAAW,CACZ,CAAC;QACF,MAAM,QAAQ,GAAG,IAAI,cAAc,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QACrD,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC,CAAC;QAE5C,IAAI,WAA0D,CAAC;QAC/D,IAAI,CAAC;YACH,MAAM,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE;gBACnC,kBAAkB,EAAE,KAAK;aAC1B,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,WAAW,GAAG,KAA0C,CAAC;QAC3D,CAAC;QAED,MAAM,CAAC,WAAW,CAAC,CAAC,cAAc,CAAC,iCAAiC,CAAC,CAAC;QACtE,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC;QAC9C,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;QAChE,MAAM,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;QAEhE,sDAAsD;QACtD,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,6BAA6B,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IAC1E,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oDAAoD,EAAE,KAAK,IAAI,EAAE;QAClE,MAAM,QAAQ,GAAG,IAAI,cAAc,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QACrD,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;QAElC,MAAM,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE,CAAC,CAAC;QAE5D,wDAAwD;QACxD,MAAM,QAAQ,GAAG,IAAI,cAAc,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QACrD,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;QAEzC,4EAA4E;QAC5E,MAAM,IAAI,CAAC,8BAA8B,CAAC,IAAI,CAC5C,IAAI,EACJ,QAAQ,EACR,IAAI,CAAC,gBAAgB,CACtB,CAAC;QAEF,6DAA6D;QAC7D,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC3D,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,6BAA6B,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,OAAO,CACzE;YACE,OAAO,EAAE,EAAE,UAAU,EAAE,KAAK,EAAE;SAC/B,CACF,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,KAAK,IAAI,EAAE;QAC3D,MAAM,OAAO,GAAG,IAAI,cAAc,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC;QACpD,MAAM,IAAI,GAAG,QAAQ,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC;QAEjC,MAAM,QAAQ,GAAG,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC;QACzC,MAAM,MAAM,GAAG,EAAE,GAAG,QAAQ,EAAE,CAAC;QAE/B,MAAM,mBAAmB,CAAC,IAAI,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC;QAE/C,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IACnC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { describe, expect, it } from \"vitest\";\nimport { Page } from \"../../lib/v3/understudy/page.js\";\nimport { MockCDPSession } from \"./helpers/mockCDPSession.js\";\nimport { StagehandSetExtraHTTPHeadersError } from \"../../lib/v3/types/public/sdkErrors.js\";\n\ntype PageStub = {\n  mainSession: MockCDPSession;\n  sessions: Map<string, MockCDPSession>;\n  extraHTTPHeaders: Record<string, string>;\n  applyExtraHTTPHeadersToSession: (\n    session: MockCDPSession,\n    headers: Record<string, string>,\n  ) => Promise<void>;\n};\n\nconst makePage = (sessions: MockCDPSession[]): PageStub => {\n  const mainSession = sessions[0] ?? new MockCDPSession({}, \"main\");\n  const stub: PageStub = {\n    mainSession,\n    sessions: new Map(sessions.map((s) => [s.id, s])),\n    extraHTTPHeaders: {},\n    // Bind the private helper from Page.prototype so setExtraHTTPHeaders can call it\n    applyExtraHTTPHeadersToSession: (Page.prototype as unknown as PageStub)\n      .applyExtraHTTPHeadersToSession,\n  };\n  return stub;\n};\n\ndescribe(\"Page.setExtraHTTPHeaders\", () => {\n  const setExtraHTTPHeaders = Page.prototype.setExtraHTTPHeaders as (\n    this: PageStub,\n    headers: Record<string, string>,\n  ) => Promise<void>;\n\n  it(\"sends headers to all sessions owned by the page\", async () => {\n    const sessionA = new MockCDPSession({}, \"session-a\");\n    const sessionB = new MockCDPSession({}, \"session-b\");\n    const page = makePage([sessionA, sessionB]);\n\n    await setExtraHTTPHeaders.call(page, {\n      \"x-stagehand-test\": \"hello\",\n    });\n\n    for (const session of [sessionA, sessionB]) {\n      expect(session.callsFor(\"Network.enable\").length).toBe(1);\n      expect(\n        session.callsFor(\"Network.setExtraHTTPHeaders\")[0]?.params,\n      ).toEqual({\n        headers: { \"x-stagehand-test\": \"hello\" },\n      });\n    }\n  });\n\n  it(\"applies headers to mainSession even when sessions map is empty\", async () => {\n    const page = makePage([]);\n\n    await setExtraHTTPHeaders.call(page, { \"x-test\": \"value\" });\n\n    // mainSession should still receive headers even though it's not in the sessions map\n    expect(page.mainSession.callsFor(\"Network.enable\").length).toBe(1);\n    expect(\n      page.mainSession.callsFor(\"Network.setExtraHTTPHeaders\")[0]?.params,\n    ).toEqual({\n      headers: { \"x-test\": \"value\" },\n    });\n  });\n\n  it(\"throws StagehandSetExtraHTTPHeadersError with session failure details\", async () => {\n    const sessionA = new MockCDPSession(\n      {\n        \"Network.setExtraHTTPHeaders\": () => {\n          throw new Error(\"connection closed\");\n        },\n      },\n      \"session-a\",\n    );\n    const sessionB = new MockCDPSession({}, \"session-b\");\n    const page = makePage([sessionA, sessionB]);\n\n    let caughtError: StagehandSetExtraHTTPHeadersError | undefined;\n    try {\n      await setExtraHTTPHeaders.call(page, {\n        \"x-stagehand-test\": \"yes\",\n      });\n    } catch (error) {\n      caughtError = error as StagehandSetExtraHTTPHeadersError;\n    }\n\n    expect(caughtError).toBeInstanceOf(StagehandSetExtraHTTPHeadersError);\n    expect(caughtError?.failures).toHaveLength(1);\n    expect(caughtError?.failures[0]).toContain(\"session=session-a\");\n    expect(caughtError?.failures[0]).toContain(\"connection closed\");\n\n    // sessionB should still have been called successfully\n    expect(sessionB.callsFor(\"Network.setExtraHTTPHeaders\").length).toBe(1);\n  });\n\n  it(\"applies headers to sessions adopted after the call\", async () => {\n    const sessionA = new MockCDPSession({}, \"session-a\");\n    const page = makePage([sessionA]);\n\n    await setExtraHTTPHeaders.call(page, { \"x-before\": \"yes\" });\n\n    // A new OOPIF session is adopted after headers were set\n    const sessionB = new MockCDPSession({}, \"session-b\");\n    page.sessions.set(sessionB.id, sessionB);\n\n    // Simulate what adoptOopifSession does: replay headers onto the new session\n    await page.applyExtraHTTPHeadersToSession.call(\n      page,\n      sessionB,\n      page.extraHTTPHeaders,\n    );\n\n    // The late-arriving session should have received the headers\n    expect(sessionB.callsFor(\"Network.enable\").length).toBe(1);\n    expect(sessionB.callsFor(\"Network.setExtraHTTPHeaders\")[0]?.params).toEqual(\n      {\n        headers: { \"x-before\": \"yes\" },\n      },\n    );\n  });\n\n  it(\"does not mutate the original headers object\", async () => {\n    const session = new MockCDPSession({}, \"session-a\");\n    const page = makePage([session]);\n\n    const original = { \"x-custom\": \"value\" };\n    const frozen = { ...original };\n\n    await setExtraHTTPHeaders.call(page, original);\n\n    expect(original).toEqual(frozen);\n  });\n});\n"]}

package/dist/esm/tests/unit/public-api/llm-and-agents.test.js

@@ -1,6 +1,19 @@
 import { describe, expect, expectTypeOf, it } from "vitest";
 import * as Stagehand from "@browserbasehq/stagehand";
 describe("LLM and Agents public API types", () => {
+    describe("ModelConfiguration", () => {
+        it("accepts Vertex headers in model config", () => {
+            const googleConfig = {
+                modelName: "google/gemini-3-flash-preview",
+                project: "test-project",
+                location: "global",
+                headers: {
+                    "X-Goog-Priority": "high",
+                },
+            };
+            void googleConfig;
+        });
+    });
     describe("AISdkClient", () => {
         it("is exported", () => {
             expect(Stagehand.AISdkClient).toBeDefined();
@@ -16,7 +29,6 @@ describe("LLM and Agents public API types", () => {
         const expectedModels = [
             "openai/computer-use-preview",
             "openai/computer-use-preview-2025-03-11",
-            "anthropic/claude-3-7-sonnet-latest",
             "anthropic/claude-opus-4-5-20251101",
             "anthropic/claude-opus-4-6",
             "anthropic/claude-sonnet-4-6",

package/dist/esm/tests/unit/public-api/llm-and-agents.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"llm-and-agents.test.js","sourceRoot":"","sources":["../../../../../tests/unit/public-api/llm-and-agents.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC5D,OAAO,KAAK,SAAS,MAAM,0BAA0B,CAAC;AAEtD,QAAQ,CAAC,iCAAiC,EAAE,GAAG,EAAE;IAC/C,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QAG3B,EAAE,CAAC,aAAa,EAAE,GAAG,EAAE;YACrB,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,WAAW,EAAE,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mBAAmB,EAAE,GAAG,EAAE;YAC3B,YAAY,EAAuB,CAAC,QAAQ,EAAuB,CAAC;QACtE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;YAG7C,YAAY,EAAwB,CAAC,aAAa,EAAK,CAAC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;QACpC,MAAM,cAAc,GAAG;YACrB,6BAA6B;YAC7B,wCAAwC;YACxC,oCAAoC;YACpC,oCAAoC;YACpC,2BAA2B;YAC3B,6BAA6B;YAC7B,qCAAqC;YACrC,oCAAoC;YACpC,sCAAsC;YACtC,gDAAgD;YAChD,+BAA+B;YAC/B,6BAA6B;YAC7B,mBAAmB;SACX,CAAC;QAEX,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACtD,YAAY,EAA+B,CAAC,aAAa,EAEtD,CAAC;YACJ,KAAK,cAAc,CAAC,CAAC,iCAAiC;QACxD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAG7B,EAAE,CAAC,aAAa,EAAE,GAAG,EAAE;YACrB,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,WAAW,EAAE,CAAC;QAChD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;YAC9B,YAAY,EAAsC,CAAC,gBAAgB,CACjE,YAAY,CACb,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;YAC9C,YAAY,EAET,CAAC,aAAa,EAA0C,CAAC;QAC9D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;QAGvC,EAAE,CAAC,qBAAqB,EAAE,GAAG,EAAE;YAC7B,YAAY,EAET,CAAC,QAAQ,EAAmC,CAAC;QAClD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAkB9B,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;YAC5C,YAAY,EAA0B,CAAC,QAAQ,EAAiB,CAAC;QACnE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QAI3B,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;YAexD,YAAY,EAAmB,CAAC,QAAQ,EAAiB,CAAC;QAC5D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;QAiCzB,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;YAC5C,YAAY,EAAqB,CAAC,QAAQ,EAAiB,CAAC;QAC9D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;YACzD,YAAY,EAET,CAAC,aAAa,EAAsB,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;YAC/D,YAAY,EAET,CAAC,gBAAgB,CAAC;gBACnB,OAAO,EAAE;oBACP,QAAQ,EAAE;wBACR;4BACE,IAAI,EAAE,MAAM;4BACZ,OAAO,EAAE,OAAO;yBACjB;qBACF;iBACF;gBACD,MAAM,EAAE,GAAG,EAAE,GAAE,CAAC;aACc,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;YAChE,MAAM,UAAU,GAAG,EAAkC,CAAC;YACtD,YAAY,EAET,CAAC,gBAAgB,CAAC;gBACnB,OAAO,EAAE;oBACP,QAAQ,EAAE;wBACR;4BACE,IAAI,EAAE,MAAM;4BACZ,OAAO,EAAE,cAAc;yBACxB;qBACF;oBACD,cAAc,EAAE;wBACd,IAAI,EAAE,WAAW;wBACjB,MAAM,EAAE,UAAU;qBACnB;iBACF;gBACD,MAAM,EAAE,GAAG,EAAE,GAAE,CAAC;aACmB,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;YAM3D,YAAY,EAET,CAAC,QAAQ,EAAqB,CAAC;QACpC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wBAAwB,EAAE,GAAG,EAAE;YAChC,qFAAqF;YACrF,qDAAqD;YACrD,YAAY,EAAqC,CAAC,QAAQ,EAEvD,CAAC;YACJ,YAAY,EAAuC,CAAC,QAAQ,EAEzD,CAAC;YACJ,YAAY,EAAmC,CAAC,QAAQ,EAErD,CAAC;YACJ,YAAY,EAAqC,CAAC,QAAQ,EAEvD,CAAC;YACJ,YAAY,EAAsC,CAAC,QAAQ,EAExD,CAAC;YACJ,YAAY,EAA8B,CAAC,QAAQ,EAEhD,CAAC;YACJ,YAAY,EAAkC,CAAC,QAAQ,EAEpD,CAAC;YACJ,YAAY,EAAmC,CAAC,QAAQ,EAErD,CAAC;YACJ,YAAY,EAAuC,CAAC,QAAQ,EAEzD,CAAC;QACN,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;QAMvC,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;YAC1C,YAAY,EAET,CAAC,QAAQ,EAAmC,CAAC;QAClD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;QAyBxB,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;YAC5C,YAAY,EAAoB,CAAC,QAAQ,EAAiB,CAAC;QAC7D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { describe, expect, expectTypeOf, it } from \"vitest\";\nimport * as Stagehand from \"@browserbasehq/stagehand\";\n\ndescribe(\"LLM and Agents public API types\", () => {\n  describe(\"AISdkClient\", () => {\n    type AISdkClientInstance = InstanceType<typeof Stagehand.AISdkClient>;\n\n    it(\"is exported\", () => {\n      expect(Stagehand.AISdkClient).toBeDefined();\n    });\n\n    it(\"extends LLMClient\", () => {\n      expectTypeOf<AISdkClientInstance>().toExtend<Stagehand.LLMClient>();\n    });\n\n    it(\"constructor accepts model parameter\", () => {\n      // AISdkClient constructor takes { model: LanguageModelV2 }\n      type CtorParams = ConstructorParameters<typeof Stagehand.AISdkClient>;\n      expectTypeOf<CtorParams[\"length\"]>().toEqualTypeOf<1>();\n    });\n  });\n\n  describe(\"AVAILABLE_CUA_MODELS\", () => {\n    const expectedModels = [\n      \"openai/computer-use-preview\",\n      \"openai/computer-use-preview-2025-03-11\",\n      \"anthropic/claude-3-7-sonnet-latest\",\n      \"anthropic/claude-opus-4-5-20251101\",\n      \"anthropic/claude-opus-4-6\",\n      \"anthropic/claude-sonnet-4-6\",\n      \"anthropic/claude-haiku-4-5-20251001\",\n      \"anthropic/claude-sonnet-4-20250514\",\n      \"anthropic/claude-sonnet-4-5-20250929\",\n      \"google/gemini-2.5-computer-use-preview-10-2025\",\n      \"google/gemini-3-flash-preview\",\n      \"google/gemini-3-pro-preview\",\n      \"microsoft/fara-7b\",\n    ] as const;\n\n    it(\"AvailableCuaModel matches the known literals\", () => {\n      expectTypeOf<Stagehand.AvailableCuaModel>().toEqualTypeOf<\n        (typeof expectedModels)[number]\n      >();\n      void expectedModels; // Mark as used to satisfy ESLint\n    });\n  });\n\n  describe(\"AgentProvider\", () => {\n    type AgentProviderInstance = InstanceType<typeof Stagehand.AgentProvider>;\n\n    it(\"is exported\", () => {\n      expect(Stagehand.AgentProvider).toBeDefined();\n    });\n\n    it(\"has getClient method\", () => {\n      expectTypeOf<AgentProviderInstance[\"getClient\"]>().toBeCallableWith(\n        \"test-model\",\n      );\n    });\n\n    it(\"constructor accepts logger parameter\", () => {\n      expectTypeOf<\n        ConstructorParameters<typeof Stagehand.AgentProvider>\n      >().toEqualTypeOf<[(message: Stagehand.LogLine) => void]>();\n    });\n  });\n\n  describe(\"AnnotatedScreenshotText\", () => {\n    type ExpectedAnnotatedScreenshotText = string;\n\n    it(\"is a string literal\", () => {\n      expectTypeOf<\n        typeof Stagehand.AnnotatedScreenshotText\n      >().toExtend<ExpectedAnnotatedScreenshotText>();\n    });\n  });\n\n  describe(\"ConsoleMessage\", () => {\n    type ExpectedShape = {\n      type: () => string;\n      text: () => string;\n      args: () => unknown[];\n      location: () => {\n        url?: string;\n        lineNumber?: number;\n        columnNumber?: number;\n      };\n      page: () => unknown;\n      timestamp: () => number | undefined;\n      raw: () => unknown;\n      toString: () => string;\n    };\n\n    type ConsoleMessageInstance = InstanceType<typeof Stagehand.ConsoleMessage>;\n\n    it(\"has correct public interface shape\", () => {\n      expectTypeOf<ConsoleMessageInstance>().toExtend<ExpectedShape>();\n    });\n  });\n\n  describe(\"AgentClient\", () => {\n    type AgentProviderInstance = InstanceType<typeof Stagehand.AgentProvider>;\n    type GetClientReturn = ReturnType<AgentProviderInstance[\"getClient\"]>;\n\n    it(\"getClient returns object with expected methods\", () => {\n      type ExpectedShape = {\n        execute: (\n          options: Stagehand.AgentExecutionOptions,\n        ) => Promise<Stagehand.AgentResult>;\n        captureScreenshot: (\n          options?: Record<string, unknown>,\n        ) => Promise<unknown>;\n        setViewport: (width: number, height: number) => void;\n        setCurrentUrl: (url: string) => void;\n        setScreenshotProvider: (provider: () => Promise<string>) => void;\n        setActionHandler: (\n          handler: (action: Stagehand.AgentAction) => Promise<void>,\n        ) => void;\n      };\n      expectTypeOf<GetClientReturn>().toExtend<ExpectedShape>();\n    });\n  });\n\n  describe(\"LLMClient\", () => {\n    type ExpectedShape = {\n      type: \"openai\" | \"anthropic\" | \"cerebras\" | \"groq\" | (string & {});\n      modelName: Stagehand.AvailableModel | (string & {});\n      hasVision: boolean;\n      clientOptions: Stagehand.ClientOptions;\n      userProvidedInstructions?: string;\n    };\n\n    type ExpectedCtorParams = [Stagehand.AvailableModel, string?];\n\n    type ExpectedBasicOptions = {\n      options: {\n        messages: Array<{\n          role: \"system\" | \"user\" | \"assistant\";\n          content: string | Array<unknown>;\n        }>;\n      };\n      logger: (message: unknown) => void;\n      retries?: number;\n    };\n\n    type ExpectedWithResponseModel = ExpectedBasicOptions & {\n      options: ExpectedBasicOptions[\"options\"] & {\n        response_model: {\n          name: string;\n          schema: Stagehand.StagehandZodSchema;\n        };\n      };\n    };\n\n    type LLMClientInstance = InstanceType<typeof Stagehand.LLMClient>;\n\n    it(\"has correct public interface shape\", () => {\n      expectTypeOf<LLMClientInstance>().toExtend<ExpectedShape>();\n    });\n\n    it(\"constructor parameters match expected signature\", () => {\n      expectTypeOf<\n        ConstructorParameters<typeof Stagehand.LLMClient>\n      >().toEqualTypeOf<ExpectedCtorParams>();\n    });\n\n    it(\"createChatCompletion can be called with basic options\", () => {\n      expectTypeOf<\n        LLMClientInstance[\"createChatCompletion\"]\n      >().toBeCallableWith({\n        options: {\n          messages: [\n            {\n              role: \"user\",\n              content: \"Hello\",\n            },\n          ],\n        },\n        logger: () => {},\n      } satisfies ExpectedBasicOptions);\n    });\n\n    it(\"createChatCompletion can be called with response_model\", () => {\n      const mockSchema = {} as Stagehand.StagehandZodSchema;\n      expectTypeOf<\n        LLMClientInstance[\"createChatCompletion\"]\n      >().toBeCallableWith({\n        options: {\n          messages: [\n            {\n              role: \"user\",\n              content: \"Extract data\",\n            },\n          ],\n          response_model: {\n            name: \"extracted\",\n            schema: mockSchema,\n          },\n        },\n        logger: () => {},\n      } satisfies ExpectedWithResponseModel);\n    });\n\n    it(\"createChatCompletion supports generic return type\", () => {\n      type Result = { custom: string };\n      type ExpectedSignature = (\n        options: Stagehand.CreateChatCompletionOptions,\n      ) => Promise<Result>;\n\n      expectTypeOf<\n        LLMClientInstance[\"createChatCompletion\"]\n      >().toExtend<ExpectedSignature>();\n    });\n\n    it(\"has additional methods\", () => {\n      // These methods exist on LLMClient but have complex signatures from the 'ai' library\n      // We verify they exist by checking they're functions\n      expectTypeOf<LLMClientInstance[\"generateText\"]>().toExtend<\n        (...args: unknown[]) => unknown\n      >();\n      expectTypeOf<LLMClientInstance[\"generateObject\"]>().toExtend<\n        (...args: unknown[]) => unknown\n      >();\n      expectTypeOf<LLMClientInstance[\"streamText\"]>().toExtend<\n        (...args: unknown[]) => unknown\n      >();\n      expectTypeOf<LLMClientInstance[\"streamObject\"]>().toExtend<\n        (...args: unknown[]) => unknown\n      >();\n      expectTypeOf<LLMClientInstance[\"generateImage\"]>().toExtend<\n        (...args: unknown[]) => unknown\n      >();\n      expectTypeOf<LLMClientInstance[\"embed\"]>().toExtend<\n        (...args: unknown[]) => unknown\n      >();\n      expectTypeOf<LLMClientInstance[\"embedMany\"]>().toExtend<\n        (...args: unknown[]) => unknown\n      >();\n      expectTypeOf<LLMClientInstance[\"transcribe\"]>().toExtend<\n        (...args: unknown[]) => unknown\n      >();\n      expectTypeOf<LLMClientInstance[\"generateSpeech\"]>().toExtend<\n        (...args: unknown[]) => unknown\n      >();\n    });\n  });\n\n  describe(\"modelToAgentProviderMap\", () => {\n    type ExpectedModelToAgentProviderMap = Record<\n      string,\n      Stagehand.AgentProviderType\n    >;\n\n    it(\"only stores valid provider types\", () => {\n      expectTypeOf<\n        typeof Stagehand.modelToAgentProviderMap\n      >().toExtend<ExpectedModelToAgentProviderMap>();\n    });\n  });\n\n  describe(\"Response\", () => {\n    type ExpectedShape = {\n      url: () => string;\n      status: () => number;\n      statusText: () => string;\n      ok: () => boolean;\n      frame: () => unknown;\n      fromServiceWorker: () => boolean;\n      securityDetails: () => Promise<unknown>;\n      serverAddr: () => Promise<unknown>;\n      headers: () => Record<string, string>;\n      allHeaders: () => Promise<Record<string, string>>;\n      headerValue: (name: string) => Promise<string | null>;\n      headerValues: (name: string) => Promise<string[]>;\n      headersArray: () => Promise<Array<{ name: string; value: string }>>;\n      body: () => Promise<Buffer>;\n      text: () => Promise<string>;\n      json: <T = unknown>() => Promise<T>;\n      finished: () => Promise<null | Error>;\n      markFinished: (error: Error | null) => void;\n      applyExtraInfo: (info: unknown) => void;\n    };\n\n    type ResponseInstance = InstanceType<typeof Stagehand.Response>;\n\n    it(\"has correct public interface shape\", () => {\n      expectTypeOf<ResponseInstance>().toExtend<ExpectedShape>();\n    });\n  });\n});\n"]}
+{"version":3,"file":"llm-and-agents.test.js","sourceRoot":"","sources":["../../../../../tests/unit/public-api/llm-and-agents.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,YAAY,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC5D,OAAO,KAAK,SAAS,MAAM,0BAA0B,CAAC;AAEtD,QAAQ,CAAC,iCAAiC,EAAE,GAAG,EAAE;IAC/C,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;YAChD,MAAM,YAAY,GAAG;gBACnB,SAAS,EAAE,+BAA+B;gBAC1C,OAAO,EAAE,cAAc;gBACvB,QAAQ,EAAE,QAAQ;gBAClB,OAAO,EAAE;oBACP,iBAAiB,EAAE,MAAM;iBAC1B;aACqC,CAAC;YAEzC,KAAK,YAAY,CAAC;QACpB,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QAG3B,EAAE,CAAC,aAAa,EAAE,GAAG,EAAE;YACrB,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC,WAAW,EAAE,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mBAAmB,EAAE,GAAG,EAAE;YAC3B,YAAY,EAAuB,CAAC,QAAQ,EAAuB,CAAC;QACtE,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,qCAAqC,EAAE,GAAG,EAAE;YAG7C,YAAY,EAAwB,CAAC,aAAa,EAAK,CAAC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,sBAAsB,EAAE,GAAG,EAAE;QACpC,MAAM,cAAc,GAAG;YACrB,6BAA6B;YAC7B,wCAAwC;YACxC,oCAAoC;YACpC,2BAA2B;YAC3B,6BAA6B;YAC7B,qCAAqC;YACrC,oCAAoC;YACpC,sCAAsC;YACtC,gDAAgD;YAChD,+BAA+B;YAC/B,6BAA6B;YAC7B,mBAAmB;SACX,CAAC;QAEX,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACtD,YAAY,EAA+B,CAAC,aAAa,EAEtD,CAAC;YACJ,KAAK,cAAc,CAAC,CAAC,iCAAiC;QACxD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAG7B,EAAE,CAAC,aAAa,EAAE,GAAG,EAAE;YACrB,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,WAAW,EAAE,CAAC;QAChD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sBAAsB,EAAE,GAAG,EAAE;YAC9B,YAAY,EAAsC,CAAC,gBAAgB,CACjE,YAAY,CACb,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;YAC9C,YAAY,EAET,CAAC,aAAa,EAA0C,CAAC;QAC9D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;QAGvC,EAAE,CAAC,qBAAqB,EAAE,GAAG,EAAE;YAC7B,YAAY,EAET,CAAC,QAAQ,EAAmC,CAAC;QAClD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAkB9B,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;YAC5C,YAAY,EAA0B,CAAC,QAAQ,EAAiB,CAAC;QACnE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QAI3B,EAAE,CAAC,gDAAgD,EAAE,GAAG,EAAE;YAexD,YAAY,EAAmB,CAAC,QAAQ,EAAiB,CAAC;QAC5D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;QAiCzB,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;YAC5C,YAAY,EAAqB,CAAC,QAAQ,EAAiB,CAAC;QAC9D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;YACzD,YAAY,EAET,CAAC,aAAa,EAAsB,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,uDAAuD,EAAE,GAAG,EAAE;YAC/D,YAAY,EAET,CAAC,gBAAgB,CAAC;gBACnB,OAAO,EAAE;oBACP,QAAQ,EAAE;wBACR;4BACE,IAAI,EAAE,MAAM;4BACZ,OAAO,EAAE,OAAO;yBACjB;qBACF;iBACF;gBACD,MAAM,EAAE,GAAG,EAAE,GAAE,CAAC;aACc,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;YAChE,MAAM,UAAU,GAAG,EAAkC,CAAC;YACtD,YAAY,EAET,CAAC,gBAAgB,CAAC;gBACnB,OAAO,EAAE;oBACP,QAAQ,EAAE;wBACR;4BACE,IAAI,EAAE,MAAM;4BACZ,OAAO,EAAE,cAAc;yBACxB;qBACF;oBACD,cAAc,EAAE;wBACd,IAAI,EAAE,WAAW;wBACjB,MAAM,EAAE,UAAU;qBACnB;iBACF;gBACD,MAAM,EAAE,GAAG,EAAE,GAAE,CAAC;aACmB,CAAC,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,mDAAmD,EAAE,GAAG,EAAE;YAM3D,YAAY,EAET,CAAC,QAAQ,EAAqB,CAAC;QACpC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,wBAAwB,EAAE,GAAG,EAAE;YAChC,qFAAqF;YACrF,qDAAqD;YACrD,YAAY,EAAqC,CAAC,QAAQ,EAEvD,CAAC;YACJ,YAAY,EAAuC,CAAC,QAAQ,EAEzD,CAAC;YACJ,YAAY,EAAmC,CAAC,QAAQ,EAErD,CAAC;YACJ,YAAY,EAAqC,CAAC,QAAQ,EAEvD,CAAC;YACJ,YAAY,EAAsC,CAAC,QAAQ,EAExD,CAAC;YACJ,YAAY,EAA8B,CAAC,QAAQ,EAEhD,CAAC;YACJ,YAAY,EAAkC,CAAC,QAAQ,EAEpD,CAAC;YACJ,YAAY,EAAmC,CAAC,QAAQ,EAErD,CAAC;YACJ,YAAY,EAAuC,CAAC,QAAQ,EAEzD,CAAC;QACN,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;QAMvC,EAAE,CAAC,kCAAkC,EAAE,GAAG,EAAE;YAC1C,YAAY,EAET,CAAC,QAAQ,EAAmC,CAAC;QAClD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE;QAyBxB,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;YAC5C,YAAY,EAAoB,CAAC,QAAQ,EAAiB,CAAC;QAC7D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { describe, expect, expectTypeOf, it } from \"vitest\";\nimport * as Stagehand from \"@browserbasehq/stagehand\";\n\ndescribe(\"LLM and Agents public API types\", () => {\n  describe(\"ModelConfiguration\", () => {\n    it(\"accepts Vertex headers in model config\", () => {\n      const googleConfig = {\n        modelName: \"google/gemini-3-flash-preview\",\n        project: \"test-project\",\n        location: \"global\",\n        headers: {\n          \"X-Goog-Priority\": \"high\",\n        },\n      } satisfies Stagehand.ModelConfiguration;\n\n      void googleConfig;\n    });\n  });\n\n  describe(\"AISdkClient\", () => {\n    type AISdkClientInstance = InstanceType<typeof Stagehand.AISdkClient>;\n\n    it(\"is exported\", () => {\n      expect(Stagehand.AISdkClient).toBeDefined();\n    });\n\n    it(\"extends LLMClient\", () => {\n      expectTypeOf<AISdkClientInstance>().toExtend<Stagehand.LLMClient>();\n    });\n\n    it(\"constructor accepts model parameter\", () => {\n      // AISdkClient constructor takes { model: LanguageModelV2 }\n      type CtorParams = ConstructorParameters<typeof Stagehand.AISdkClient>;\n      expectTypeOf<CtorParams[\"length\"]>().toEqualTypeOf<1>();\n    });\n  });\n\n  describe(\"AVAILABLE_CUA_MODELS\", () => {\n    const expectedModels = [\n      \"openai/computer-use-preview\",\n      \"openai/computer-use-preview-2025-03-11\",\n      \"anthropic/claude-opus-4-5-20251101\",\n      \"anthropic/claude-opus-4-6\",\n      \"anthropic/claude-sonnet-4-6\",\n      \"anthropic/claude-haiku-4-5-20251001\",\n      \"anthropic/claude-sonnet-4-20250514\",\n      \"anthropic/claude-sonnet-4-5-20250929\",\n      \"google/gemini-2.5-computer-use-preview-10-2025\",\n      \"google/gemini-3-flash-preview\",\n      \"google/gemini-3-pro-preview\",\n      \"microsoft/fara-7b\",\n    ] as const;\n\n    it(\"AvailableCuaModel matches the known literals\", () => {\n      expectTypeOf<Stagehand.AvailableCuaModel>().toEqualTypeOf<\n        (typeof expectedModels)[number]\n      >();\n      void expectedModels; // Mark as used to satisfy ESLint\n    });\n  });\n\n  describe(\"AgentProvider\", () => {\n    type AgentProviderInstance = InstanceType<typeof Stagehand.AgentProvider>;\n\n    it(\"is exported\", () => {\n      expect(Stagehand.AgentProvider).toBeDefined();\n    });\n\n    it(\"has getClient method\", () => {\n      expectTypeOf<AgentProviderInstance[\"getClient\"]>().toBeCallableWith(\n        \"test-model\",\n      );\n    });\n\n    it(\"constructor accepts logger parameter\", () => {\n      expectTypeOf<\n        ConstructorParameters<typeof Stagehand.AgentProvider>\n      >().toEqualTypeOf<[(message: Stagehand.LogLine) => void]>();\n    });\n  });\n\n  describe(\"AnnotatedScreenshotText\", () => {\n    type ExpectedAnnotatedScreenshotText = string;\n\n    it(\"is a string literal\", () => {\n      expectTypeOf<\n        typeof Stagehand.AnnotatedScreenshotText\n      >().toExtend<ExpectedAnnotatedScreenshotText>();\n    });\n  });\n\n  describe(\"ConsoleMessage\", () => {\n    type ExpectedShape = {\n      type: () => string;\n      text: () => string;\n      args: () => unknown[];\n      location: () => {\n        url?: string;\n        lineNumber?: number;\n        columnNumber?: number;\n      };\n      page: () => unknown;\n      timestamp: () => number | undefined;\n      raw: () => unknown;\n      toString: () => string;\n    };\n\n    type ConsoleMessageInstance = InstanceType<typeof Stagehand.ConsoleMessage>;\n\n    it(\"has correct public interface shape\", () => {\n      expectTypeOf<ConsoleMessageInstance>().toExtend<ExpectedShape>();\n    });\n  });\n\n  describe(\"AgentClient\", () => {\n    type AgentProviderInstance = InstanceType<typeof Stagehand.AgentProvider>;\n    type GetClientReturn = ReturnType<AgentProviderInstance[\"getClient\"]>;\n\n    it(\"getClient returns object with expected methods\", () => {\n      type ExpectedShape = {\n        execute: (\n          options: Stagehand.AgentExecutionOptions,\n        ) => Promise<Stagehand.AgentResult>;\n        captureScreenshot: (\n          options?: Record<string, unknown>,\n        ) => Promise<unknown>;\n        setViewport: (width: number, height: number) => void;\n        setCurrentUrl: (url: string) => void;\n        setScreenshotProvider: (provider: () => Promise<string>) => void;\n        setActionHandler: (\n          handler: (action: Stagehand.AgentAction) => Promise<void>,\n        ) => void;\n      };\n      expectTypeOf<GetClientReturn>().toExtend<ExpectedShape>();\n    });\n  });\n\n  describe(\"LLMClient\", () => {\n    type ExpectedShape = {\n      type: \"openai\" | \"anthropic\" | \"cerebras\" | \"groq\" | (string & {});\n      modelName: Stagehand.AvailableModel | (string & {});\n      hasVision: boolean;\n      clientOptions: Stagehand.ClientOptions;\n      userProvidedInstructions?: string;\n    };\n\n    type ExpectedCtorParams = [Stagehand.AvailableModel, string?];\n\n    type ExpectedBasicOptions = {\n      options: {\n        messages: Array<{\n          role: \"system\" | \"user\" | \"assistant\";\n          content: string | Array<unknown>;\n        }>;\n      };\n      logger: (message: unknown) => void;\n      retries?: number;\n    };\n\n    type ExpectedWithResponseModel = ExpectedBasicOptions & {\n      options: ExpectedBasicOptions[\"options\"] & {\n        response_model: {\n          name: string;\n          schema: Stagehand.StagehandZodSchema;\n        };\n      };\n    };\n\n    type LLMClientInstance = InstanceType<typeof Stagehand.LLMClient>;\n\n    it(\"has correct public interface shape\", () => {\n      expectTypeOf<LLMClientInstance>().toExtend<ExpectedShape>();\n    });\n\n    it(\"constructor parameters match expected signature\", () => {\n      expectTypeOf<\n        ConstructorParameters<typeof Stagehand.LLMClient>\n      >().toEqualTypeOf<ExpectedCtorParams>();\n    });\n\n    it(\"createChatCompletion can be called with basic options\", () => {\n      expectTypeOf<\n        LLMClientInstance[\"createChatCompletion\"]\n      >().toBeCallableWith({\n        options: {\n          messages: [\n            {\n              role: \"user\",\n              content: \"Hello\",\n            },\n          ],\n        },\n        logger: () => {},\n      } satisfies ExpectedBasicOptions);\n    });\n\n    it(\"createChatCompletion can be called with response_model\", () => {\n      const mockSchema = {} as Stagehand.StagehandZodSchema;\n      expectTypeOf<\n        LLMClientInstance[\"createChatCompletion\"]\n      >().toBeCallableWith({\n        options: {\n          messages: [\n            {\n              role: \"user\",\n              content: \"Extract data\",\n            },\n          ],\n          response_model: {\n            name: \"extracted\",\n            schema: mockSchema,\n          },\n        },\n        logger: () => {},\n      } satisfies ExpectedWithResponseModel);\n    });\n\n    it(\"createChatCompletion supports generic return type\", () => {\n      type Result = { custom: string };\n      type ExpectedSignature = (\n        options: Stagehand.CreateChatCompletionOptions,\n      ) => Promise<Result>;\n\n      expectTypeOf<\n        LLMClientInstance[\"createChatCompletion\"]\n      >().toExtend<ExpectedSignature>();\n    });\n\n    it(\"has additional methods\", () => {\n      // These methods exist on LLMClient but have complex signatures from the 'ai' library\n      // We verify they exist by checking they're functions\n      expectTypeOf<LLMClientInstance[\"generateText\"]>().toExtend<\n        (...args: unknown[]) => unknown\n      >();\n      expectTypeOf<LLMClientInstance[\"generateObject\"]>().toExtend<\n        (...args: unknown[]) => unknown\n      >();\n      expectTypeOf<LLMClientInstance[\"streamText\"]>().toExtend<\n        (...args: unknown[]) => unknown\n      >();\n      expectTypeOf<LLMClientInstance[\"streamObject\"]>().toExtend<\n        (...args: unknown[]) => unknown\n      >();\n      expectTypeOf<LLMClientInstance[\"generateImage\"]>().toExtend<\n        (...args: unknown[]) => unknown\n      >();\n      expectTypeOf<LLMClientInstance[\"embed\"]>().toExtend<\n        (...args: unknown[]) => unknown\n      >();\n      expectTypeOf<LLMClientInstance[\"embedMany\"]>().toExtend<\n        (...args: unknown[]) => unknown\n      >();\n      expectTypeOf<LLMClientInstance[\"transcribe\"]>().toExtend<\n        (...args: unknown[]) => unknown\n      >();\n      expectTypeOf<LLMClientInstance[\"generateSpeech\"]>().toExtend<\n        (...args: unknown[]) => unknown\n      >();\n    });\n  });\n\n  describe(\"modelToAgentProviderMap\", () => {\n    type ExpectedModelToAgentProviderMap = Record<\n      string,\n      Stagehand.AgentProviderType\n    >;\n\n    it(\"only stores valid provider types\", () => {\n      expectTypeOf<\n        typeof Stagehand.modelToAgentProviderMap\n      >().toExtend<ExpectedModelToAgentProviderMap>();\n    });\n  });\n\n  describe(\"Response\", () => {\n    type ExpectedShape = {\n      url: () => string;\n      status: () => number;\n      statusText: () => string;\n      ok: () => boolean;\n      frame: () => unknown;\n      fromServiceWorker: () => boolean;\n      securityDetails: () => Promise<unknown>;\n      serverAddr: () => Promise<unknown>;\n      headers: () => Record<string, string>;\n      allHeaders: () => Promise<Record<string, string>>;\n      headerValue: (name: string) => Promise<string | null>;\n      headerValues: (name: string) => Promise<string[]>;\n      headersArray: () => Promise<Array<{ name: string; value: string }>>;\n      body: () => Promise<Buffer>;\n      text: () => Promise<string>;\n      json: <T = unknown>() => Promise<T>;\n      finished: () => Promise<null | Error>;\n      markFinished: (error: Error | null) => void;\n      applyExtraInfo: (info: unknown) => void;\n    };\n\n    type ResponseInstance = InstanceType<typeof Stagehand.Response>;\n\n    it(\"has correct public interface shape\", () => {\n      expectTypeOf<ResponseInstance>().toExtend<ExpectedShape>();\n    });\n  });\n});\n"]}

package/dist/esm/tests/unit/public-api/public-types.test.js.map

@@ -1 +1 @@
-{"version":3,"file":"public-types.test.js","sourceRoot":"","sources":["../../../../../tests/unit/public-api/public-types.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AA4GpD,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;IAC1C,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;QAOvB,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAAqB,CAAC,aAAa,EAAmB,CAAC;QACrE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QAS1B,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAAwB,CAAC,aAAa,EAAsB,CAAC;QAC3E,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;QASzB,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAAuB,CAAC,aAAa,EAAqB,CAAC;QACzE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAS9B,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAA4B,CAAC,aAAa,EAA0B,CAAC;QACnF,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAS9B,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAA4B,CAAC,aAAa,EAA0B,CAAC;QACnF,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC7B,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACtD,YAAY,EAA2B,CAAC,QAAQ,EAAsB,CAAC;YACvE,YAAY,EAA0C,CAAC,aAAa,EAEjE,CAAC;QACN,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;QAQtB,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAAoB,CAAC,aAAa,EAAkB,CAAC;QACnE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QAC3B,+DAA+D;QAC/D,qEAAqE;QACrE,EAAE,CAAC,gBAAgB,EAAE,GAAG,EAAE;YAExB,YAAY,EAAsB,CAAC,aAAa,EAAU,CAAC;QAC7D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;QAcnC,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAAiC,CAAC,aAAa,EAA+B,CAAC;QAC7F,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;QAczC,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAAuC,CAAC,aAAa,EAAqC,CAAC;QACzG,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;QAOrC,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAET,CAAC,aAAa,EAEd,CAAC;QACN,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QAkB3B,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAAyB,CAAC,aAAa,EAAuB,CAAC;QAC7E,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QAY3B,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAAyB,CAAC,QAAQ,EAAuB,CAAC;QACxE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAG7B,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAA2B,CAAC,aAAa,EAAyB,CAAC;QACjF,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAQ5B,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAA0B,CAAC,aAAa,EAAwB,CAAC;QAC/E,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;QAYtB,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAAoB,CAAC,aAAa,EAAkB,CAAC;QACnE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QAa3B,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAAyB,CAAC,aAAa,EAAuB,CAAC;QAC7E,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAOlC,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAAgC,CAAC,aAAa,EAA8B,CAAC;QAC3F,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { describe, expectTypeOf, it } from \"vitest\";\nimport * as Stagehand from \"@browserbasehq/stagehand\";\n\n// Type-level manifest of all expected exported types\n// Since these types don't exist at runtime, we currently need to manually add new publicly exported types\n// to this list ourselves - it's not automatically going to catch changes like our export-surface.test.ts does.\n\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\ntype ExpectedExportedTypes = {\n  // Types from model.ts\n  AvailableModel: Stagehand.AvailableModel;\n  AvailableCuaModel: Stagehand.AvailableCuaModel;\n  ModelProvider: Stagehand.ModelProvider;\n  ClientOptions: Stagehand.ClientOptions;\n  ModelConfiguration: Stagehand.ModelConfiguration;\n  AnthropicJsonSchemaObject: Stagehand.AnthropicJsonSchemaObject;\n  AISDKProvider: Stagehand.AISDKProvider;\n  AISDKCustomProvider: Stagehand.AISDKCustomProvider;\n  LLMTool: Stagehand.LLMTool;\n  // Types from methods.ts\n  ActOptions: Stagehand.ActOptions;\n  ActResult: Stagehand.ActResult;\n  ExtractResult: Stagehand.ExtractResult<Stagehand.StagehandZodSchema>;\n  Action: Stagehand.Action;\n  HistoryEntry: Stagehand.HistoryEntry;\n  ExtractOptions: Stagehand.ExtractOptions;\n  ObserveOptions: Stagehand.ObserveOptions;\n  ObserveResult: Stagehand.ObserveResult;\n  V3FunctionName: Stagehand.V3FunctionName;\n  // Types from agent.ts\n  Tool: Stagehand.Tool;\n  AgentAction: Stagehand.AgentAction;\n  AgentResult: Stagehand.AgentResult;\n  AgentExecuteOptions: Stagehand.AgentExecuteOptions;\n  AgentType: Stagehand.AgentType;\n  AgentExecutionOptions: Stagehand.AgentExecutionOptions<Stagehand.AgentExecuteOptions>;\n  AgentHandlerOptions: Stagehand.AgentHandlerOptions;\n  ActionExecutionResult: Stagehand.ActionExecutionResult;\n  ToolUseItem: Stagehand.ToolUseItem;\n  AnthropicMessage: Stagehand.AnthropicMessage;\n  AnthropicContentBlock: Stagehand.AnthropicContentBlock;\n  AnthropicTextBlock: Stagehand.AnthropicTextBlock;\n  AnthropicToolResult: Stagehand.AnthropicToolResult;\n  ResponseItem: Stagehand.ResponseItem;\n  ComputerCallItem: Stagehand.ComputerCallItem;\n  FunctionCallItem: Stagehand.FunctionCallItem;\n  ResponseInputItem: Stagehand.ResponseInputItem;\n  AgentInstance: Stagehand.AgentInstance;\n  AgentProviderType: Stagehand.AgentProviderType;\n  AgentModelConfig: Stagehand.AgentModelConfig;\n  AgentConfig: Stagehand.AgentConfig;\n  AgentToolMode: Stagehand.AgentToolMode;\n  VariableValue: Stagehand.VariableValue;\n  Variables: Stagehand.Variables;\n  AgentCallbacks: Stagehand.AgentCallbacks;\n  AgentExecuteCallbacks: Stagehand.AgentExecuteCallbacks;\n  AgentStreamCallbacks: Stagehand.AgentStreamCallbacks;\n  AgentExecuteOptionsBase: Stagehand.AgentExecuteOptionsBase;\n  AgentStreamExecuteOptions: Stagehand.AgentStreamExecuteOptions;\n  ModelMessage: Stagehand.ModelMessage;\n  // Types from agent/tools\n  AgentTools: Stagehand.AgentTools;\n  AgentToolTypesMap: Stagehand.AgentToolTypesMap;\n  AgentUITools: Stagehand.AgentUITools;\n  AgentToolCall: Stagehand.AgentToolCall;\n  AgentToolResult: Stagehand.AgentToolResult;\n  // Types from logs.ts\n  LogLevel: Stagehand.LogLevel;\n  LogLine: Stagehand.LogLine;\n  Logger: Stagehand.Logger;\n  // Types from metrics.ts\n  StagehandMetrics: Stagehand.StagehandMetrics;\n  // Types from options.ts\n  V3Env: Stagehand.V3Env;\n  LocalBrowserLaunchOptions: Stagehand.LocalBrowserLaunchOptions;\n  V3Options: Stagehand.V3Options;\n  // Types from page.ts\n  AnyPage: Stagehand.AnyPage;\n  Page: Stagehand.Page;\n  PlaywrightPage: Stagehand.PlaywrightPage;\n  PatchrightPage: Stagehand.PatchrightPage;\n  PuppeteerPage: Stagehand.PuppeteerPage;\n  ConsoleListener: Stagehand.ConsoleListener;\n  LoadState: Stagehand.LoadState;\n  // Types from LLMClient.ts\n  ChatMessage: Stagehand.ChatMessage;\n  ChatMessageContent: Stagehand.ChatMessageContent;\n  ChatMessageImageContent: Stagehand.ChatMessageImageContent;\n  ChatMessageTextContent: Stagehand.ChatMessageTextContent;\n  ChatCompletionOptions: Stagehand.ChatCompletionOptions;\n  LLMResponse: Stagehand.LLMResponse;\n  CreateChatCompletionOptions: Stagehand.CreateChatCompletionOptions;\n  LLMUsage: Stagehand.LLMUsage;\n  LLMParsedResponse: Stagehand.LLMParsedResponse<Record<string, unknown>>;\n  // Types from zodCompat.ts\n  StagehandZodSchema: Stagehand.StagehandZodSchema;\n  StagehandZodObject: Stagehand.StagehandZodObject;\n  InferStagehandSchema: Stagehand.InferStagehandSchema<Stagehand.StagehandZodSchema>;\n  JsonSchemaDocument: Stagehand.JsonSchemaDocument;\n  // Types from utils.ts\n  JsonSchema: Stagehand.JsonSchema;\n  JsonSchemaProperty: Stagehand.JsonSchemaProperty;\n  // Types from cookies.ts\n  Cookie: Stagehand.Cookie;\n  CookieParam: Stagehand.CookieParam;\n  ClearCookieOptions: Stagehand.ClearCookieOptions;\n};\n\ndescribe(\"Stagehand public API types\", () => {\n  describe(\"AnyPage\", () => {\n    type ExpectedAnyPage =\n      | Stagehand.PlaywrightPage\n      | Stagehand.PuppeteerPage\n      | Stagehand.PatchrightPage\n      | Stagehand.Page;\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.AnyPage>().toEqualTypeOf<ExpectedAnyPage>();\n    });\n  });\n\n  describe(\"ActOptions\", () => {\n    type ExpectedActOptions = {\n      model?: Stagehand.ModelConfiguration;\n      variables?: Stagehand.Variables;\n      timeout?: number;\n      page?: Stagehand.AnyPage;\n      serverCache?: boolean;\n    };\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.ActOptions>().toEqualTypeOf<ExpectedActOptions>();\n    });\n  });\n\n  describe(\"ActResult\", () => {\n    type ExpectedActResult = {\n      success: boolean;\n      message: string;\n      actionDescription: string;\n      actions: Stagehand.Action[];\n      cacheStatus?: \"HIT\" | \"MISS\";\n    };\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.ActResult>().toEqualTypeOf<ExpectedActResult>();\n    });\n  });\n\n  describe(\"ExtractOptions\", () => {\n    type ExpectedExtractOptions = {\n      model?: Stagehand.ModelConfiguration;\n      timeout?: number;\n      selector?: string;\n      page?: Stagehand.AnyPage;\n      serverCache?: boolean;\n    };\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.ExtractOptions>().toEqualTypeOf<ExpectedExtractOptions>();\n    });\n  });\n\n  describe(\"ObserveOptions\", () => {\n    type ExpectedObserveOptions = {\n      model?: Stagehand.ModelConfiguration;\n      timeout?: number;\n      selector?: string;\n      page?: Stagehand.AnyPage;\n      serverCache?: boolean;\n    };\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.ObserveOptions>().toEqualTypeOf<ExpectedObserveOptions>();\n    });\n  });\n\n  describe(\"ObserveResult\", () => {\n    it(\"is an Action array with optional cacheStatus\", () => {\n      expectTypeOf<Stagehand.ObserveResult>().toExtend<Stagehand.Action[]>();\n      expectTypeOf<Stagehand.ObserveResult[\"cacheStatus\"]>().toEqualTypeOf<\n        \"HIT\" | \"MISS\" | undefined\n      >();\n    });\n  });\n\n  describe(\"Action\", () => {\n    type ExpectedAction = {\n      selector: string;\n      description: string;\n      method?: string;\n      arguments?: string[];\n    };\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.Action>().toEqualTypeOf<ExpectedAction>();\n    });\n  });\n\n  describe(\"AgentAction\", () => {\n    // AgentAction is a separate type from Action, not an extension\n    // It has additional fields like type, reasoning, taskCompleted, etc.\n    it(\"has type field\", () => {\n      type TestAction = { type: string } & Stagehand.AgentAction;\n      expectTypeOf<TestAction[\"type\"]>().toEqualTypeOf<string>();\n    });\n  });\n\n  describe(\"AgentExecuteOptions\", () => {\n    type ExpectedAgentExecuteOptions = {\n      instruction: string;\n      maxSteps?: number;\n      page?: Stagehand.AnyPage;\n      highlightCursor?: boolean;\n      messages?: Stagehand.ModelMessage[];\n      signal?: AbortSignal;\n      excludeTools?: string[];\n      output?: Stagehand.StagehandZodObject;\n      callbacks?: Stagehand.AgentExecuteCallbacks;\n      variables?: Stagehand.Variables;\n    };\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.AgentExecuteOptions>().toEqualTypeOf<ExpectedAgentExecuteOptions>();\n    });\n  });\n\n  describe(\"AgentStreamExecuteOptions\", () => {\n    type ExpectedAgentStreamExecuteOptions = {\n      instruction: string;\n      maxSteps?: number;\n      page?: Stagehand.AnyPage;\n      highlightCursor?: boolean;\n      messages?: Stagehand.ModelMessage[];\n      signal?: AbortSignal;\n      excludeTools?: string[];\n      output?: Stagehand.StagehandZodObject;\n      callbacks?: Stagehand.AgentStreamCallbacks;\n      variables?: Stagehand.Variables;\n    };\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.AgentStreamExecuteOptions>().toEqualTypeOf<ExpectedAgentStreamExecuteOptions>();\n    });\n  });\n\n  describe(\"AgentExecutionOptions\", () => {\n    type ExpectedAgentExecutionOptions<T = Stagehand.AgentExecuteOptions> = {\n      options: T;\n      logger: (message: Stagehand.LogLine) => void;\n      retries?: number;\n    };\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<\n        Stagehand.AgentExecutionOptions<Stagehand.AgentExecuteOptions>\n      >().toEqualTypeOf<\n        ExpectedAgentExecutionOptions<Stagehand.AgentExecuteOptions>\n      >();\n    });\n  });\n\n  describe(\"AgentResult\", () => {\n    type ExpectedAgentResult = {\n      success: boolean;\n      message: string;\n      actions: Stagehand.AgentAction[];\n      completed: boolean;\n      metadata?: Record<string, unknown>;\n      usage?: {\n        input_tokens: number;\n        output_tokens: number;\n        reasoning_tokens?: number;\n        cached_input_tokens?: number;\n        inference_time_ms: number;\n      };\n      messages?: Stagehand.ModelMessage[];\n      output?: Record<string, unknown>;\n    };\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.AgentResult>().toEqualTypeOf<ExpectedAgentResult>();\n    });\n  });\n\n  describe(\"AgentConfig\", () => {\n    type ExpectedAgentConfig = {\n      systemPrompt?: string;\n      integrations?: (unknown | string)[];\n      tools?: unknown;\n      cua?: boolean;\n      model?: string | Stagehand.AgentModelConfig<string>;\n      executionModel?: string | Stagehand.AgentModelConfig<string>;\n      stream?: boolean;\n      mode?: Stagehand.AgentToolMode;\n    };\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.AgentConfig>().toExtend<ExpectedAgentConfig>();\n    });\n  });\n\n  describe(\"AgentToolMode\", () => {\n    type ExpectedAgentToolMode = \"dom\" | \"hybrid\" | \"cua\";\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.AgentToolMode>().toEqualTypeOf<ExpectedAgentToolMode>();\n    });\n  });\n\n  describe(\"HistoryEntry\", () => {\n    type ExpectedHistoryEntry = {\n      method: \"act\" | \"extract\" | \"observe\" | \"navigate\" | \"agent\";\n      parameters: unknown;\n      result: unknown;\n      timestamp: string;\n    };\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.HistoryEntry>().toEqualTypeOf<ExpectedHistoryEntry>();\n    });\n  });\n\n  describe(\"Cookie\", () => {\n    type ExpectedCookie = {\n      name: string;\n      value: string;\n      domain: string;\n      path: string;\n      expires: number;\n      httpOnly: boolean;\n      secure: boolean;\n      sameSite: \"Strict\" | \"Lax\" | \"None\";\n    };\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.Cookie>().toEqualTypeOf<ExpectedCookie>();\n    });\n  });\n\n  describe(\"CookieParam\", () => {\n    type ExpectedCookieParam = {\n      name: string;\n      value: string;\n      url?: string;\n      domain?: string;\n      path?: string;\n      expires?: number;\n      httpOnly?: boolean;\n      secure?: boolean;\n      sameSite?: \"Strict\" | \"Lax\" | \"None\";\n    };\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.CookieParam>().toEqualTypeOf<ExpectedCookieParam>();\n    });\n  });\n\n  describe(\"ClearCookieOptions\", () => {\n    type ExpectedClearCookieOptions = {\n      name?: string | RegExp;\n      domain?: string | RegExp;\n      path?: string | RegExp;\n    };\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.ClearCookieOptions>().toEqualTypeOf<ExpectedClearCookieOptions>();\n    });\n  });\n});\n"]}
+{"version":3,"file":"public-types.test.js","sourceRoot":"","sources":["../../../../../tests/unit/public-api/public-types.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AA4GpD,QAAQ,CAAC,4BAA4B,EAAE,GAAG,EAAE;IAC1C,QAAQ,CAAC,SAAS,EAAE,GAAG,EAAE;QAOvB,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAAqB,CAAC,aAAa,EAAmB,CAAC;QACrE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;QAS1B,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAAwB,CAAC,aAAa,EAAsB,CAAC;QAC3E,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,WAAW,EAAE,GAAG,EAAE;QASzB,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAAuB,CAAC,aAAa,EAAqB,CAAC;QACzE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAS9B,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAA4B,CAAC,aAAa,EAA0B,CAAC;QACnF,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,gBAAgB,EAAE,GAAG,EAAE;QAS9B,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAA4B,CAAC,aAAa,EAA0B,CAAC;QACnF,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAC7B,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;YACtD,YAAY,EAA2B,CAAC,QAAQ,EAAsB,CAAC;YACvE,YAAY,EAA0C,CAAC,aAAa,EAEjE,CAAC;QACN,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;QAQtB,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAAoB,CAAC,aAAa,EAAkB,CAAC;QACnE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QAC3B,+DAA+D;QAC/D,qEAAqE;QACrE,EAAE,CAAC,gBAAgB,EAAE,GAAG,EAAE;YAExB,YAAY,EAAsB,CAAC,aAAa,EAAU,CAAC;QAC7D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,qBAAqB,EAAE,GAAG,EAAE;QAgBnC,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAAiC,CAAC,aAAa,EAA+B,CAAC;QAC7F,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;QAgBzC,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAAuC,CAAC,aAAa,EAAqC,CAAC;QACzG,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;QAOrC,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAET,CAAC,aAAa,EAEd,CAAC;QACN,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QAkB3B,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAAyB,CAAC,aAAa,EAAuB,CAAC;QAC7E,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QAY3B,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAAyB,CAAC,QAAQ,EAAuB,CAAC;QACxE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;QAG7B,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAA2B,CAAC,aAAa,EAAyB,CAAC;QACjF,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;QAQ5B,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAA0B,CAAC,aAAa,EAAwB,CAAC;QAC/E,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;QAYtB,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAAoB,CAAC,aAAa,EAAkB,CAAC;QACnE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;QAa3B,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAAyB,CAAC,aAAa,EAAuB,CAAC;QAC7E,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,oBAAoB,EAAE,GAAG,EAAE;QAOlC,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,YAAY,EAAgC,CAAC,aAAa,EAA8B,CAAC;QAC3F,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { describe, expectTypeOf, it } from \"vitest\";\nimport * as Stagehand from \"@browserbasehq/stagehand\";\n\n// Type-level manifest of all expected exported types\n// Since these types don't exist at runtime, we currently need to manually add new publicly exported types\n// to this list ourselves - it's not automatically going to catch changes like our export-surface.test.ts does.\n\n// eslint-disable-next-line @typescript-eslint/no-unused-vars\ntype ExpectedExportedTypes = {\n  // Types from model.ts\n  AvailableModel: Stagehand.AvailableModel;\n  AvailableCuaModel: Stagehand.AvailableCuaModel;\n  ModelProvider: Stagehand.ModelProvider;\n  ClientOptions: Stagehand.ClientOptions;\n  ModelConfiguration: Stagehand.ModelConfiguration;\n  AnthropicJsonSchemaObject: Stagehand.AnthropicJsonSchemaObject;\n  AISDKProvider: Stagehand.AISDKProvider;\n  AISDKCustomProvider: Stagehand.AISDKCustomProvider;\n  LLMTool: Stagehand.LLMTool;\n  // Types from methods.ts\n  ActOptions: Stagehand.ActOptions;\n  ActResult: Stagehand.ActResult;\n  ExtractResult: Stagehand.ExtractResult<Stagehand.StagehandZodSchema>;\n  Action: Stagehand.Action;\n  HistoryEntry: Stagehand.HistoryEntry;\n  ExtractOptions: Stagehand.ExtractOptions;\n  ObserveOptions: Stagehand.ObserveOptions;\n  ObserveResult: Stagehand.ObserveResult;\n  V3FunctionName: Stagehand.V3FunctionName;\n  // Types from agent.ts\n  Tool: Stagehand.Tool;\n  AgentAction: Stagehand.AgentAction;\n  AgentResult: Stagehand.AgentResult;\n  AgentExecuteOptions: Stagehand.AgentExecuteOptions;\n  AgentType: Stagehand.AgentType;\n  AgentExecutionOptions: Stagehand.AgentExecutionOptions<Stagehand.AgentExecuteOptions>;\n  AgentHandlerOptions: Stagehand.AgentHandlerOptions;\n  ActionExecutionResult: Stagehand.ActionExecutionResult;\n  ToolUseItem: Stagehand.ToolUseItem;\n  AnthropicMessage: Stagehand.AnthropicMessage;\n  AnthropicContentBlock: Stagehand.AnthropicContentBlock;\n  AnthropicTextBlock: Stagehand.AnthropicTextBlock;\n  AnthropicToolResult: Stagehand.AnthropicToolResult;\n  ResponseItem: Stagehand.ResponseItem;\n  ComputerCallItem: Stagehand.ComputerCallItem;\n  FunctionCallItem: Stagehand.FunctionCallItem;\n  ResponseInputItem: Stagehand.ResponseInputItem;\n  AgentInstance: Stagehand.AgentInstance;\n  AgentProviderType: Stagehand.AgentProviderType;\n  AgentModelConfig: Stagehand.AgentModelConfig;\n  AgentConfig: Stagehand.AgentConfig;\n  AgentToolMode: Stagehand.AgentToolMode;\n  VariableValue: Stagehand.VariableValue;\n  Variables: Stagehand.Variables;\n  AgentCallbacks: Stagehand.AgentCallbacks;\n  AgentExecuteCallbacks: Stagehand.AgentExecuteCallbacks;\n  AgentStreamCallbacks: Stagehand.AgentStreamCallbacks;\n  AgentExecuteOptionsBase: Stagehand.AgentExecuteOptionsBase;\n  AgentStreamExecuteOptions: Stagehand.AgentStreamExecuteOptions;\n  ModelMessage: Stagehand.ModelMessage;\n  // Types from agent/tools\n  AgentTools: Stagehand.AgentTools;\n  AgentToolTypesMap: Stagehand.AgentToolTypesMap;\n  AgentUITools: Stagehand.AgentUITools;\n  AgentToolCall: Stagehand.AgentToolCall;\n  AgentToolResult: Stagehand.AgentToolResult;\n  // Types from logs.ts\n  LogLevel: Stagehand.LogLevel;\n  LogLine: Stagehand.LogLine;\n  Logger: Stagehand.Logger;\n  // Types from metrics.ts\n  StagehandMetrics: Stagehand.StagehandMetrics;\n  // Types from options.ts\n  V3Env: Stagehand.V3Env;\n  LocalBrowserLaunchOptions: Stagehand.LocalBrowserLaunchOptions;\n  V3Options: Stagehand.V3Options;\n  // Types from page.ts\n  AnyPage: Stagehand.AnyPage;\n  Page: Stagehand.Page;\n  PlaywrightPage: Stagehand.PlaywrightPage;\n  PatchrightPage: Stagehand.PatchrightPage;\n  PuppeteerPage: Stagehand.PuppeteerPage;\n  ConsoleListener: Stagehand.ConsoleListener;\n  LoadState: Stagehand.LoadState;\n  // Types from LLMClient.ts\n  ChatMessage: Stagehand.ChatMessage;\n  ChatMessageContent: Stagehand.ChatMessageContent;\n  ChatMessageImageContent: Stagehand.ChatMessageImageContent;\n  ChatMessageTextContent: Stagehand.ChatMessageTextContent;\n  ChatCompletionOptions: Stagehand.ChatCompletionOptions;\n  LLMResponse: Stagehand.LLMResponse;\n  CreateChatCompletionOptions: Stagehand.CreateChatCompletionOptions;\n  LLMUsage: Stagehand.LLMUsage;\n  LLMParsedResponse: Stagehand.LLMParsedResponse<Record<string, unknown>>;\n  // Types from zodCompat.ts\n  StagehandZodSchema: Stagehand.StagehandZodSchema;\n  StagehandZodObject: Stagehand.StagehandZodObject;\n  InferStagehandSchema: Stagehand.InferStagehandSchema<Stagehand.StagehandZodSchema>;\n  JsonSchemaDocument: Stagehand.JsonSchemaDocument;\n  // Types from utils.ts\n  JsonSchema: Stagehand.JsonSchema;\n  JsonSchemaProperty: Stagehand.JsonSchemaProperty;\n  // Types from cookies.ts\n  Cookie: Stagehand.Cookie;\n  CookieParam: Stagehand.CookieParam;\n  ClearCookieOptions: Stagehand.ClearCookieOptions;\n};\n\ndescribe(\"Stagehand public API types\", () => {\n  describe(\"AnyPage\", () => {\n    type ExpectedAnyPage =\n      | Stagehand.PlaywrightPage\n      | Stagehand.PuppeteerPage\n      | Stagehand.PatchrightPage\n      | Stagehand.Page;\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.AnyPage>().toEqualTypeOf<ExpectedAnyPage>();\n    });\n  });\n\n  describe(\"ActOptions\", () => {\n    type ExpectedActOptions = {\n      model?: Stagehand.ModelConfiguration;\n      variables?: Stagehand.Variables;\n      timeout?: number;\n      page?: Stagehand.AnyPage;\n      serverCache?: boolean;\n    };\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.ActOptions>().toEqualTypeOf<ExpectedActOptions>();\n    });\n  });\n\n  describe(\"ActResult\", () => {\n    type ExpectedActResult = {\n      success: boolean;\n      message: string;\n      actionDescription: string;\n      actions: Stagehand.Action[];\n      cacheStatus?: \"HIT\" | \"MISS\";\n    };\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.ActResult>().toEqualTypeOf<ExpectedActResult>();\n    });\n  });\n\n  describe(\"ExtractOptions\", () => {\n    type ExpectedExtractOptions = {\n      model?: Stagehand.ModelConfiguration;\n      timeout?: number;\n      selector?: string;\n      page?: Stagehand.AnyPage;\n      serverCache?: boolean;\n    };\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.ExtractOptions>().toEqualTypeOf<ExpectedExtractOptions>();\n    });\n  });\n\n  describe(\"ObserveOptions\", () => {\n    type ExpectedObserveOptions = {\n      model?: Stagehand.ModelConfiguration;\n      timeout?: number;\n      selector?: string;\n      page?: Stagehand.AnyPage;\n      serverCache?: boolean;\n    };\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.ObserveOptions>().toEqualTypeOf<ExpectedObserveOptions>();\n    });\n  });\n\n  describe(\"ObserveResult\", () => {\n    it(\"is an Action array with optional cacheStatus\", () => {\n      expectTypeOf<Stagehand.ObserveResult>().toExtend<Stagehand.Action[]>();\n      expectTypeOf<Stagehand.ObserveResult[\"cacheStatus\"]>().toEqualTypeOf<\n        \"HIT\" | \"MISS\" | undefined\n      >();\n    });\n  });\n\n  describe(\"Action\", () => {\n    type ExpectedAction = {\n      selector: string;\n      description: string;\n      method?: string;\n      arguments?: string[];\n    };\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.Action>().toEqualTypeOf<ExpectedAction>();\n    });\n  });\n\n  describe(\"AgentAction\", () => {\n    // AgentAction is a separate type from Action, not an extension\n    // It has additional fields like type, reasoning, taskCompleted, etc.\n    it(\"has type field\", () => {\n      type TestAction = { type: string } & Stagehand.AgentAction;\n      expectTypeOf<TestAction[\"type\"]>().toEqualTypeOf<string>();\n    });\n  });\n\n  describe(\"AgentExecuteOptions\", () => {\n    type ExpectedAgentExecuteOptions = {\n      instruction: string;\n      maxSteps?: number;\n      page?: Stagehand.AnyPage;\n      highlightCursor?: boolean;\n      messages?: Stagehand.ModelMessage[];\n      signal?: AbortSignal;\n      excludeTools?: string[];\n      output?: Stagehand.StagehandZodObject;\n      callbacks?: Stagehand.AgentExecuteCallbacks;\n      variables?: Stagehand.Variables;\n      toolTimeout?: number;\n      useSearch?: boolean;\n    };\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.AgentExecuteOptions>().toEqualTypeOf<ExpectedAgentExecuteOptions>();\n    });\n  });\n\n  describe(\"AgentStreamExecuteOptions\", () => {\n    type ExpectedAgentStreamExecuteOptions = {\n      instruction: string;\n      maxSteps?: number;\n      page?: Stagehand.AnyPage;\n      highlightCursor?: boolean;\n      messages?: Stagehand.ModelMessage[];\n      signal?: AbortSignal;\n      excludeTools?: string[];\n      output?: Stagehand.StagehandZodObject;\n      callbacks?: Stagehand.AgentStreamCallbacks;\n      variables?: Stagehand.Variables;\n      toolTimeout?: number;\n      useSearch?: boolean;\n    };\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.AgentStreamExecuteOptions>().toEqualTypeOf<ExpectedAgentStreamExecuteOptions>();\n    });\n  });\n\n  describe(\"AgentExecutionOptions\", () => {\n    type ExpectedAgentExecutionOptions<T = Stagehand.AgentExecuteOptions> = {\n      options: T;\n      logger: (message: Stagehand.LogLine) => void;\n      retries?: number;\n    };\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<\n        Stagehand.AgentExecutionOptions<Stagehand.AgentExecuteOptions>\n      >().toEqualTypeOf<\n        ExpectedAgentExecutionOptions<Stagehand.AgentExecuteOptions>\n      >();\n    });\n  });\n\n  describe(\"AgentResult\", () => {\n    type ExpectedAgentResult = {\n      success: boolean;\n      message: string;\n      actions: Stagehand.AgentAction[];\n      completed: boolean;\n      metadata?: Record<string, unknown>;\n      usage?: {\n        input_tokens: number;\n        output_tokens: number;\n        reasoning_tokens?: number;\n        cached_input_tokens?: number;\n        inference_time_ms: number;\n      };\n      messages?: Stagehand.ModelMessage[];\n      output?: Record<string, unknown>;\n    };\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.AgentResult>().toEqualTypeOf<ExpectedAgentResult>();\n    });\n  });\n\n  describe(\"AgentConfig\", () => {\n    type ExpectedAgentConfig = {\n      systemPrompt?: string;\n      integrations?: (unknown | string)[];\n      tools?: unknown;\n      cua?: boolean;\n      model?: string | Stagehand.AgentModelConfig<string>;\n      executionModel?: string | Stagehand.AgentModelConfig<string>;\n      stream?: boolean;\n      mode?: Stagehand.AgentToolMode;\n    };\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.AgentConfig>().toExtend<ExpectedAgentConfig>();\n    });\n  });\n\n  describe(\"AgentToolMode\", () => {\n    type ExpectedAgentToolMode = \"dom\" | \"hybrid\" | \"cua\";\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.AgentToolMode>().toEqualTypeOf<ExpectedAgentToolMode>();\n    });\n  });\n\n  describe(\"HistoryEntry\", () => {\n    type ExpectedHistoryEntry = {\n      method: \"act\" | \"extract\" | \"observe\" | \"navigate\" | \"agent\";\n      parameters: unknown;\n      result: unknown;\n      timestamp: string;\n    };\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.HistoryEntry>().toEqualTypeOf<ExpectedHistoryEntry>();\n    });\n  });\n\n  describe(\"Cookie\", () => {\n    type ExpectedCookie = {\n      name: string;\n      value: string;\n      domain: string;\n      path: string;\n      expires: number;\n      httpOnly: boolean;\n      secure: boolean;\n      sameSite: \"Strict\" | \"Lax\" | \"None\";\n    };\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.Cookie>().toEqualTypeOf<ExpectedCookie>();\n    });\n  });\n\n  describe(\"CookieParam\", () => {\n    type ExpectedCookieParam = {\n      name: string;\n      value: string;\n      url?: string;\n      domain?: string;\n      path?: string;\n      expires?: number;\n      httpOnly?: boolean;\n      secure?: boolean;\n      sameSite?: \"Strict\" | \"Lax\" | \"None\";\n    };\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.CookieParam>().toEqualTypeOf<ExpectedCookieParam>();\n    });\n  });\n\n  describe(\"ClearCookieOptions\", () => {\n    type ExpectedClearCookieOptions = {\n      name?: string | RegExp;\n      domain?: string | RegExp;\n      path?: string | RegExp;\n    };\n\n    it(\"matches expected type shape\", () => {\n      expectTypeOf<Stagehand.ClearCookieOptions>().toEqualTypeOf<ExpectedClearCookieOptions>();\n    });\n  });\n});\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@browserbasehq/orca",
-  "version": "3.1.0-patch.4",
+  "version": "3.2.0-middleware.1",
   "description": "An AI web browsing framework focused on simplicity and extensibility.",
   "type": "module",
   "main": "./dist/cjs/index.js",
@@ -39,7 +39,7 @@
     "build-dom-scripts:a11y": "tsx lib/v3/dom/genA11yScripts.ts",
     "build:cjs": "tsx scripts/build-cjs.ts",
     "build:esm": "tsx scripts/build-esm.ts",
-    "build": "pnpm --filter @browserbasehq/stagehand run --parallel \"/^build:(esm|cjs)$/\"",
+    "build": "pnpm --filter @browserbasehq/orca run --parallel \"/^build:(esm|cjs)$/\"",
     "example": "node --import tsx -e \"const args=process.argv.slice(1).filter(a=>a!=='--'); const [p]=args; const n=(p||'example').replace(/^\\.\\//,'').replace(/\\.ts$/i,''); import('node:path').then(path=>import(new URL(path.resolve('examples', n + '.ts'), 'file:')));\" --",
     "test": "pnpm -w --dir ../.. exec turbo run test:core test:e2e --filter=@browserbasehq/stagehand --",
     "test:core": "tsx scripts/test-core.ts",
@@ -69,8 +69,9 @@
   "dependencies": {
     "@ai-sdk/provider": "^2.0.0",
     "@anthropic-ai/sdk": "0.39.0",
-    "@browserbasehq/sdk": "^2.4.0",
+    "@browserbasehq/sdk": "^2.7.0",
     "@google/genai": "^1.22.0",
+    "@langchain/openai": "^0.4.4",
     "@modelcontextprotocol/sdk": "^1.17.2",
     "ai": "^5.0.133",
     "devtools-protocol": "^0.0.1464554",
@@ -96,6 +97,7 @@
     "@ai-sdk/perplexity": "^2.0.13",
     "@ai-sdk/togetherai": "^1.0.23",
     "@ai-sdk/xai": "^2.0.26",
+    "@langchain/core": "^0.3.80",
     "bufferutil": "^4.0.9",
     "chrome-launcher": "^1.2.0",
     "ollama-ai-provider-v2": "^1.5.0",

package/dist/cjs/lib/v3/agent/tools/search.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"search.js","sourceRoot":"","sources":["../../../../../../lib/v3/agent/tools/search.ts"],"names":[],"mappings":";;;AAAA,2BAA0B;AAC1B,6BAAwB;AAgCxB,KAAK,UAAU,kBAAkB,CAAC,KAAa;IAC7C,IAAI,CAAC;QACH,MAAM,YAAY,GAAG,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAC/C,MAAM,QAAQ,GAAG,MAAM,KAAK,CAC1B,oDAAoD,YAAY,EAAE,EAClE;YACE,MAAM,EAAE,KAAK;YACb,OAAO,EAAE;gBACP,MAAM,EAAE,kBAAkB;gBAC1B,iBAAiB,EAAE,MAAM;gBACzB,sBAAsB,EAAE,OAAO,CAAC,GAAG,CAAC,aAAc;aACnD;SACF,CACF,CAAC;QAEF,IAAI,CAAC,QAAQ,CAAC,EAAE,EAAE,CAAC;YACjB,OAAO;gBACL,KAAK,EAAE,oBAAoB,QAAQ,CAAC,MAAM,IAAI,QAAQ,CAAC,UAAU,EAAE;gBACnE,IAAI,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;aACtB,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAqB,CAAC;QACzD,MAAM,OAAO,GAAwB,EAAE,CAAC;QAExC,IAAI,IAAI,EAAE,GAAG,EAAE,OAAO,IAAI,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YAC1D,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC;gBAChD,IAAI,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,EAAE,CAAC;oBAC3B,OAAO,CAAC,IAAI,CAAC;wBACX,KAAK,EAAE,IAAI,CAAC,KAAK;wBACjB,GAAG,EAAE,IAAI,CAAC,GAAG;wBACb,WAAW,EAAE,IAAI,CAAC,WAAW;qBAC9B,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,EAAE,CAAC;IAC/B,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,OAAO,CAAC,KAAK,CAAC,cAAc,EAAE,KAAK,CAAC,CAAC;QACrC,OAAO;YACL,KAAK,EAAE,4BAA6B,KAAe,CAAC,OAAO,EAAE;YAC7D,IAAI,EAAE,EAAE,OAAO,EAAE,EAAE,EAAE;SACtB,CAAC;IACJ,CAAC;AACH,CAAC;AAEM,MAAM,UAAU,GAAG,CAAC,EAAM,EAAE,EAAE,CACnC,IAAA,SAAI,EAAC;IACH,WAAW,EACT,wSAAwS;IAC1S,WAAW,EAAE,OAAC,CAAC,MAAM,CAAC;QACpB,KAAK,EAAE,OAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,yCAAyC,CAAC;KACtE,CAAC;IACF,OAAO,EAAE,KAAK,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE;QAC3B,EAAE,CAAC,MAAM,CAAC;YACR,QAAQ,EAAE,OAAO;YACjB,OAAO,EAAE,4BAA4B;YACrC,KAAK,EAAE,CAAC;YACR,SAAS,EAAE;gBACT,SAAS,EAAE;oBACT,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,CAAC;oBAChC,IAAI,EAAE,QAAQ;iBACf;aACF;SACF,CAAC,CAAC;QAEH,MAAM,MAAM,GAAG,MAAM,kBAAkB,CAAC,KAAK,CAAC,CAAC;QAE/C,EAAE,CAAC,qBAAqB,CAAC;YACvB,IAAI,EAAE,QAAQ;YACd,WAAW,EAAE,KAAK;YAClB,mBAAmB,EAAE,EAAE,KAAK,EAAE;YAC9B,OAAO,EACL,MAAM,CAAC,KAAK,IAAI,SAAS,MAAM,CAAC,IAAI,EAAE,OAAO,CAAC,MAAM,IAAI,CAAC,UAAU;SACtE,CAAC,CAAC;QAEH,OAAO;YACL,GAAG,MAAM;YACT,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;SACtB,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAnCQ,QAAA,UAAU,cAmClB","sourcesContent":["import { tool } from \"ai\";\nimport { z } from \"zod\";\nimport type { V3 } from \"../../v3.js\";\n\nexport interface BraveSearchResult {\n  title: string;\n  url: string;\n  description?: string;\n}\n\ninterface SearchResponse {\n  data?: {\n    results: BraveSearchResult[];\n  };\n  error?: string;\n}\n\ninterface BraveWebResult {\n  title?: string;\n  url?: string;\n  description?: string;\n  age?: string;\n  meta_url?: {\n    favicon?: string;\n  };\n}\n\ninterface BraveApiResponse {\n  web?: {\n    results?: BraveWebResult[];\n  };\n}\n\nasync function performBraveSearch(query: string): Promise<SearchResponse> {\n  try {\n    const encodedQuery = encodeURIComponent(query);\n    const response = await fetch(\n      `https://api.search.brave.com/res/v1/web/search?q=${encodedQuery}`,\n      {\n        method: \"GET\",\n        headers: {\n          Accept: \"application/json\",\n          \"Accept-Encoding\": \"gzip\",\n          \"X-Subscription-Token\": process.env.BRAVE_API_KEY!,\n        },\n      },\n    );\n\n    if (!response.ok) {\n      return {\n        error: `Brave API error: ${response.status} ${response.statusText}`,\n        data: { results: [] },\n      };\n    }\n\n    const data = (await response.json()) as BraveApiResponse;\n    const results: BraveSearchResult[] = [];\n\n    if (data?.web?.results && Array.isArray(data.web.results)) {\n      for (const item of data.web.results.slice(0, 5)) {\n        if (item.title && item.url) {\n          results.push({\n            title: item.title,\n            url: item.url,\n            description: item.description,\n          });\n        }\n      }\n    }\n\n    return { data: { results } };\n  } catch (error) {\n    console.error(\"Search error\", error);\n    return {\n      error: `Error performing search: ${(error as Error).message}`,\n      data: { results: [] },\n    };\n  }\n}\n\nexport const searchTool = (v3: V3) =>\n  tool({\n    description:\n      \"Perform a web search and returns results. Use this tool when you need information from the web or when you are unsure of the exact URL you want to navigate to. This can be used to find the ideal entry point, resulting in a task that is easier to complete due to starting further in the process.\",\n    inputSchema: z.object({\n      query: z.string().describe(\"The search query to look for on the web\"),\n    }),\n    execute: async ({ query }) => {\n      v3.logger({\n        category: \"agent\",\n        message: `Agent calling tool: search`,\n        level: 1,\n        auxiliary: {\n          arguments: {\n            value: JSON.stringify({ query }),\n            type: \"object\",\n          },\n        },\n      });\n\n      const result = await performBraveSearch(query);\n\n      v3.recordAgentReplayStep({\n        type: \"search\",\n        instruction: query,\n        playwrightArguments: { query },\n        message:\n          result.error ?? `Found ${result.data?.results.length ?? 0} results`,\n      });\n\n      return {\n        ...result,\n        timestamp: Date.now(),\n      };\n    },\n  });\n"]}

package/dist/cjs/lib/v3/flowLogger.d.ts

@@ -1,139 +0,0 @@
-import fs from "node:fs";
-import pino from "pino";
-import type { LanguageModelMiddleware } from "ai";
-import type { V3Options } from "./types/public/index.js";
-interface FlowLoggerMetrics {
-    taskStartTime?: number;
-    stepStartTime?: number;
-    actionStartTime?: number;
-    llmRequests: number;
-    llmInputTokens: number;
-    llmOutputTokens: number;
-    cdpEvents: number;
-}
-export interface FlowLoggerContext {
-    logger: pino.Logger;
-    metrics: FlowLoggerMetrics;
-    sessionId: string;
-    sessionDir: string;
-    configDir: string;
-    initPromise: Promise<void>;
-    initialized: boolean;
-    taskId: string | null;
-    stepId: string | null;
-    stepLabel: string | null;
-    actionId: string | null;
-    actionLabel: string | null;
-    fileStreams: {
-        agent: fs.WriteStream | null;
-        stagehand: fs.WriteStream | null;
-        understudy: fs.WriteStream | null;
-        cdp: fs.WriteStream | null;
-        llm: fs.WriteStream | null;
-        jsonl: fs.WriteStream | null;
-    };
-}
-/**
- * Get the config directory. Returns empty string if logging is disabled.
- */
-export declare function getConfigDir(): string;
-/**
- * Format a prompt preview from LLM messages for logging.
- * Returns format like: "some text... +{5.8kb image} +{schema} +{12 tools}"
- */
-export declare function formatLlmPromptPreview(messages: Array<{
-    role: string;
-    content: unknown;
-}>, options?: {
-    toolCount?: number;
-    hasSchema?: boolean;
-}): string | undefined;
-/**
- * Extract a text preview from CUA-style messages.
- * Accepts various message formats (Anthropic, OpenAI, Google).
- */
-export declare function formatCuaPromptPreview(messages: unknown[], maxLen?: number): string | undefined;
-/** Format CUA response output for logging */
-export declare function formatCuaResponsePreview(output: unknown, maxLen?: number): string;
-export declare class SessionFileLogger {
-    /**
-     * Initialize a new logging context. Call this at the start of a session.
-     * If BROWSERBASE_CONFIG_DIR is not set, logging is disabled.
-     */
-    static init(sessionId: string, v3Options?: V3Options): void;
-    private static initAsync;
-    static close(): Promise<void>;
-    static get sessionId(): string | null;
-    static get sessionDir(): string | null;
-    /**
-     * Get the current logger context object.
-     */
-    static getContext(): FlowLoggerContext | null;
-    /**
-     * Start a new task and log it.
-     */
-    static logAgentTaskStarted({ invocation, args, }: {
-        invocation: string;
-        args?: unknown | unknown[];
-    }): void;
-    /**
-     * Log task completion with metrics summary.
-     */
-    static logAgentTaskCompleted(options?: {
-        cacheHit?: boolean;
-    }): void;
-    static logStagehandStepEvent({ invocation, args, label, }: {
-        invocation: string;
-        args?: unknown | unknown[];
-        label: string;
-    }): string;
-    static logStagehandStepCompleted(): void;
-    static logUnderstudyActionEvent({ actionType, target, args, }: {
-        actionType: string;
-        target?: string;
-        args?: unknown | unknown[];
-    }): string;
-    static logUnderstudyActionCompleted(): void;
-    private static logCdpEvent;
-    static logCdpCallEvent(data: {
-        method: string;
-        params?: object;
-        targetId?: string | null;
-    }, ctx?: FlowLoggerContext | null): void;
-    static logCdpMessageEvent(data: {
-        method: string;
-        params?: unknown;
-        targetId?: string | null;
-    }, ctx?: FlowLoggerContext | null): void;
-    static logLlmRequest({ requestId, model, prompt, }: {
-        requestId: string;
-        model: string;
-        operation: string;
-        prompt?: string;
-    }, explicitCtx?: FlowLoggerContext | null): void;
-    static logLlmResponse({ requestId, model, output, inputTokens, outputTokens, }: {
-        requestId: string;
-        model: string;
-        operation: string;
-        output?: string;
-        inputTokens?: number;
-        outputTokens?: number;
-    }, explicitCtx?: FlowLoggerContext | null): void;
-    /**
-     * Create middleware for wrapping language models with LLM call logging.
-     * Returns a no-op middleware when logging is disabled.
-     */
-    static createLlmLoggingMiddleware(modelId: string): Pick<LanguageModelMiddleware, "wrapGenerate">;
-}
-/**
- * Method decorator for logging understudy actions with automatic start/complete.
- * Logs all arguments automatically. No-op when CONFIG_DIR is empty.
- */
-export declare function logAction(actionType: string): <T extends (...args: never[]) => Promise<unknown>>(originalMethod: T) => T;
-/**
- * Method decorator for logging Stagehand step events (act, extract, observe).
- * Only adds logging - does NOT wrap with withInstanceLogContext (caller handles that).
- * No-op when CONFIG_DIR is empty.
- */
-export declare function logStagehandStep(invocation: string, label: string): <T extends (...args: never[]) => Promise<unknown>>(originalMethod: T) => T;
-export {};