@browserbasehq/orca 3.2.0-preview.4 → 3.2.1-preview.0

package/dist/cjs/tests/unit/microsoft-cua-client.test.js

@@ -0,0 +1,86 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const MicrosoftCUAClient_js_1 = require("../../lib/v3/agent/MicrosoftCUAClient.js");
+const FlowLogger_js_1 = require("../../lib/v3/flowlogger/FlowLogger.js");
+function createClient() {
+    const client = new MicrosoftCUAClient_js_1.MicrosoftCUAClient("microsoft", "fara-7b", undefined, {
+        apiKey: "test-key",
+        baseURL: "https://example.com",
+    });
+    client.setScreenshotProvider(async () => "mock-base64-screenshot");
+    return client;
+}
+(0, vitest_1.describe)("MicrosoftCUAClient", () => {
+    (0, vitest_1.it)("emits FlowLogger request and response events for a successful model call", async () => {
+        const client = createClient();
+        const createCompletion = vitest_1.vi.fn().mockResolvedValue({
+            choices: [
+                {
+                    message: {
+                        content: 'thoughts\n<tool_call>\n{"name":"computer_use","arguments":{"action":"terminate","status":"success"}}\n</tool_call>',
+                    },
+                },
+            ],
+            usage: {
+                prompt_tokens: 11,
+                completion_tokens: 5,
+                total_tokens: 16,
+            },
+        });
+        client.client = {
+            chat: {
+                completions: {
+                    create: createCompletion,
+                },
+            },
+        };
+        const requestSpy = vitest_1.vi.spyOn(FlowLogger_js_1.FlowLogger, "logLlmRequest");
+        const responseSpy = vitest_1.vi.spyOn(FlowLogger_js_1.FlowLogger, "logLlmResponse");
+        try {
+            const result = await client.executeStep(vitest_1.vi.fn(), false);
+            (0, vitest_1.expect)(result.completed).toBe(true);
+            (0, vitest_1.expect)(createCompletion).toHaveBeenCalledTimes(1);
+            (0, vitest_1.expect)(requestSpy).toHaveBeenCalledTimes(1);
+            (0, vitest_1.expect)(responseSpy).toHaveBeenCalledTimes(1);
+            const requestPayload = requestSpy.mock.calls[0]?.[0];
+            const responsePayload = responseSpy.mock.calls[0]?.[0];
+            (0, vitest_1.expect)(requestPayload.model).toBe("fara-7b");
+            (0, vitest_1.expect)(responsePayload.model).toBe("fara-7b");
+            (0, vitest_1.expect)(responsePayload.requestId).toBe(requestPayload.requestId);
+            (0, vitest_1.expect)(responsePayload.inputTokens).toBe(11);
+            (0, vitest_1.expect)(responsePayload.outputTokens).toBe(5);
+            (0, vitest_1.expect)(responsePayload.output).toContain("terminate");
+        }
+        finally {
+            requestSpy.mockRestore();
+            responseSpy.mockRestore();
+        }
+    });
+    (0, vitest_1.it)("emits only FlowLogger request event when model call fails", async () => {
+        const client = createClient();
+        const createCompletion = vitest_1.vi
+            .fn()
+            .mockRejectedValue(new Error("upstream model error"));
+        client.client = {
+            chat: {
+                completions: {
+                    create: createCompletion,
+                },
+            },
+        };
+        const requestSpy = vitest_1.vi.spyOn(FlowLogger_js_1.FlowLogger, "logLlmRequest");
+        const responseSpy = vitest_1.vi.spyOn(FlowLogger_js_1.FlowLogger, "logLlmResponse");
+        try {
+            await (0, vitest_1.expect)(client.executeStep(vitest_1.vi.fn(), false)).rejects.toThrow("upstream model error");
+            (0, vitest_1.expect)(requestSpy).toHaveBeenCalledTimes(1);
+            (0, vitest_1.expect)(responseSpy).not.toHaveBeenCalled();
+            (0, vitest_1.expect)(createCompletion).toHaveBeenCalledTimes(1);
+        }
+        finally {
+            requestSpy.mockRestore();
+            responseSpy.mockRestore();
+        }
+    });
+});
+//# sourceMappingURL=microsoft-cua-client.test.js.map

package/dist/cjs/tests/unit/microsoft-cua-client.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"microsoft-cua-client.test.js","sourceRoot":"","sources":["../../../../tests/unit/microsoft-cua-client.test.ts"],"names":[],"mappings":";;AAAA,mCAAkD;AAClD,oFAA8E;AAC9E,yEAAmE;AAEnE,SAAS,YAAY;IACnB,MAAM,MAAM,GAAG,IAAI,0CAAkB,CAAC,WAAW,EAAE,SAAS,EAAE,SAAS,EAAE;QACvE,MAAM,EAAE,UAAU;QAClB,OAAO,EAAE,qBAAqB;KAC/B,CAAC,CAAC;IACH,MAAM,CAAC,qBAAqB,CAAC,KAAK,IAAI,EAAE,CAAC,wBAAwB,CAAC,CAAC;IACnE,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,IAAA,iBAAQ,EAAC,oBAAoB,EAAE,GAAG,EAAE;IAClC,IAAA,WAAE,EAAC,0EAA0E,EAAE,KAAK,IAAI,EAAE;QACxF,MAAM,MAAM,GAAG,YAAY,EAAE,CAAC;QAC9B,MAAM,gBAAgB,GAAG,WAAE,CAAC,EAAE,EAAE,CAAC,iBAAiB,CAAC;YACjD,OAAO,EAAE;gBACP;oBACE,OAAO,EAAE;wBACP,OAAO,EACL,oHAAoH;qBACvH;iBACF;aACF;YACD,KAAK,EAAE;gBACL,aAAa,EAAE,EAAE;gBACjB,iBAAiB,EAAE,CAAC;gBACpB,YAAY,EAAE,EAAE;aACjB;SACF,CAAC,CAAC;QAGD,MAKD,CAAC,MAAM,GAAG;YACT,IAAI,EAAE;gBACJ,WAAW,EAAE;oBACX,MAAM,EAAE,gBAAgB;iBACzB;aACF;SACF,CAAC;QAEF,MAAM,UAAU,GAAG,WAAE,CAAC,KAAK,CAAC,0BAAU,EAAE,eAAe,CAAC,CAAC;QACzD,MAAM,WAAW,GAAG,WAAE,CAAC,KAAK,CAAC,0BAAU,EAAE,gBAAgB,CAAC,CAAC;QAE3D,IAAI,CAAC;YACH,MAAM,MAAM,GAAG,MACb,MAMD,CAAC,WAAW,CAAC,WAAE,CAAC,EAAE,EAAE,EAAE,KAAK,CAAC,CAAC;YAE9B,IAAA,eAAM,EAAC,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACpC,IAAA,eAAM,EAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;YAClD,IAAA,eAAM,EAAC,UAAU,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;YAC5C,IAAA,eAAM,EAAC,WAAW,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;YAE7C,MAAM,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAGlD,CAAC;YACF,MAAM,eAAe,GAAG,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAMpD,CAAC;YAEF,IAAA,eAAM,EAAC,cAAc,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC7C,IAAA,eAAM,EAAC,eAAe,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC9C,IAAA,eAAM,EAAC,eAAe,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;YACjE,IAAA,eAAM,EAAC,eAAe,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;YAC7C,IAAA,eAAM,EAAC,eAAe,CAAC,YAAY,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;YAC7C,IAAA,eAAM,EAAC,eAAe,CAAC,MAAM,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;QACxD,CAAC;gBAAS,CAAC;YACT,UAAU,CAAC,WAAW,EAAE,CAAC;YACzB,WAAW,CAAC,WAAW,EAAE,CAAC;QAC5B,CAAC;IACH,CAAC,CAAC,CAAC;IAEH,IAAA,WAAE,EAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;QACzE,MAAM,MAAM,GAAG,YAAY,EAAE,CAAC;QAC9B,MAAM,gBAAgB,GAAG,WAAE;aACxB,EAAE,EAAE;aACJ,iBAAiB,CAAC,IAAI,KAAK,CAAC,sBAAsB,CAAC,CAAC,CAAC;QAGtD,MAKD,CAAC,MAAM,GAAG;YACT,IAAI,EAAE;gBACJ,WAAW,EAAE;oBACX,MAAM,EAAE,gBAAgB;iBACzB;aACF;SACF,CAAC;QAEF,MAAM,UAAU,GAAG,WAAE,CAAC,KAAK,CAAC,0BAAU,EAAE,eAAe,CAAC,CAAC;QACzD,MAAM,WAAW,GAAG,WAAE,CAAC,KAAK,CAAC,0BAAU,EAAE,gBAAgB,CAAC,CAAC;QAE3D,IAAI,CAAC;YACH,MAAM,IAAA,eAAM,EAER,MAMD,CAAC,WAAW,CAAC,WAAE,CAAC,EAAE,EAAE,EAAE,KAAK,CAAC,CAC9B,CAAC,OAAO,CAAC,OAAO,CAAC,sBAAsB,CAAC,CAAC;YAE1C,IAAA,eAAM,EAAC,UAAU,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;YAC5C,IAAA,eAAM,EAAC,WAAW,CAAC,CAAC,GAAG,CAAC,gBAAgB,EAAE,CAAC;YAC3C,IAAA,eAAM,EAAC,gBAAgB,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QACpD,CAAC;gBAAS,CAAC;YACT,UAAU,CAAC,WAAW,EAAE,CAAC;YACzB,WAAW,CAAC,WAAW,EAAE,CAAC;QAC5B,CAAC;IACH,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { describe, expect, it, vi } from \"vitest\";\nimport { MicrosoftCUAClient } from \"../../lib/v3/agent/MicrosoftCUAClient.js\";\nimport { FlowLogger } from \"../../lib/v3/flowlogger/FlowLogger.js\";\n\nfunction createClient() {\n  const client = new MicrosoftCUAClient(\"microsoft\", \"fara-7b\", undefined, {\n    apiKey: \"test-key\",\n    baseURL: \"https://example.com\",\n  });\n  client.setScreenshotProvider(async () => \"mock-base64-screenshot\");\n  return client;\n}\n\ndescribe(\"MicrosoftCUAClient\", () => {\n  it(\"emits FlowLogger request and response events for a successful model call\", async () => {\n    const client = createClient();\n    const createCompletion = vi.fn().mockResolvedValue({\n      choices: [\n        {\n          message: {\n            content:\n              'thoughts\\n<tool_call>\\n{\"name\":\"computer_use\",\"arguments\":{\"action\":\"terminate\",\"status\":\"success\"}}\\n</tool_call>',\n          },\n        },\n      ],\n      usage: {\n        prompt_tokens: 11,\n        completion_tokens: 5,\n        total_tokens: 16,\n      },\n    });\n\n    (\n      client as unknown as {\n        client: {\n          chat: { completions: { create: (...args: unknown[]) => unknown } };\n        };\n      }\n    ).client = {\n      chat: {\n        completions: {\n          create: createCompletion,\n        },\n      },\n    };\n\n    const requestSpy = vi.spyOn(FlowLogger, \"logLlmRequest\");\n    const responseSpy = vi.spyOn(FlowLogger, \"logLlmResponse\");\n\n    try {\n      const result = await (\n        client as unknown as {\n          executeStep: (\n            logger: (message: unknown) => void,\n            isFirstRound?: boolean,\n          ) => Promise<{ completed: boolean }>;\n        }\n      ).executeStep(vi.fn(), false);\n\n      expect(result.completed).toBe(true);\n      expect(createCompletion).toHaveBeenCalledTimes(1);\n      expect(requestSpy).toHaveBeenCalledTimes(1);\n      expect(responseSpy).toHaveBeenCalledTimes(1);\n\n      const requestPayload = requestSpy.mock.calls[0]?.[0] as {\n        requestId: string;\n        model: string;\n      };\n      const responsePayload = responseSpy.mock.calls[0]?.[0] as {\n        requestId: string;\n        model: string;\n        inputTokens: number;\n        outputTokens: number;\n        output: string;\n      };\n\n      expect(requestPayload.model).toBe(\"fara-7b\");\n      expect(responsePayload.model).toBe(\"fara-7b\");\n      expect(responsePayload.requestId).toBe(requestPayload.requestId);\n      expect(responsePayload.inputTokens).toBe(11);\n      expect(responsePayload.outputTokens).toBe(5);\n      expect(responsePayload.output).toContain(\"terminate\");\n    } finally {\n      requestSpy.mockRestore();\n      responseSpy.mockRestore();\n    }\n  });\n\n  it(\"emits only FlowLogger request event when model call fails\", async () => {\n    const client = createClient();\n    const createCompletion = vi\n      .fn()\n      .mockRejectedValue(new Error(\"upstream model error\"));\n\n    (\n      client as unknown as {\n        client: {\n          chat: { completions: { create: (...args: unknown[]) => unknown } };\n        };\n      }\n    ).client = {\n      chat: {\n        completions: {\n          create: createCompletion,\n        },\n      },\n    };\n\n    const requestSpy = vi.spyOn(FlowLogger, \"logLlmRequest\");\n    const responseSpy = vi.spyOn(FlowLogger, \"logLlmResponse\");\n\n    try {\n      await expect(\n        (\n          client as unknown as {\n            executeStep: (\n              logger: (message: unknown) => void,\n              isFirstRound?: boolean,\n            ) => Promise<unknown>;\n          }\n        ).executeStep(vi.fn(), false),\n      ).rejects.toThrow(\"upstream model error\");\n\n      expect(requestSpy).toHaveBeenCalledTimes(1);\n      expect(responseSpy).not.toHaveBeenCalled();\n      expect(createCompletion).toHaveBeenCalledTimes(1);\n    } finally {\n      requestSpy.mockRestore();\n      responseSpy.mockRestore();\n    }\n  });\n});\n"]}

package/dist/cjs/tests/unit/openai-cua-client.test.d.ts

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

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

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const OpenAICUAClient_js_1 = require("../../lib/v3/agent/OpenAICUAClient.js");
+function createClient() {
+    return new OpenAICUAClient_js_1.OpenAICUAClient("openai", "computer-use-preview-2025-03-11", undefined, { apiKey: "test-key" });
+}
+(0, vitest_1.describe)("OpenAICUAClient", () => {
+    (0, vitest_1.it)("exposes captchaSolvedProceed tool after a captcha context note", () => {
+        const client = createClient();
+        // Before captcha note — tool should not be active
+        (0, vitest_1.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.");
+        (0, vitest_1.expect)(client
+            .captchaSolvedToolActive).toBe(true);
+    });
+    (0, vitest_1.it)("does NOT activate captcha tool for non-captcha context notes", () => {
+        const client = createClient();
+        client.addContextNote("The page has finished loading.");
+        (0, vitest_1.expect)(client
+            .captchaSolvedToolActive).toBe(false);
+    });
+    (0, vitest_1.it)("deactivates captcha tool after takeAction handles the function call", async () => {
+        const client = createClient();
+        client.addContextNote("A captcha was solved.");
+        (0, vitest_1.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: "{}",
+            },
+        ], vitest_1.vi.fn());
+        // Tool should be deactivated
+        (0, vitest_1.expect)(client
+            .captchaSolvedToolActive).toBe(false);
+        // Result should contain a function_call_output confirming proceed
+        (0, vitest_1.expect)(result).toEqual([
+            {
+                type: "function_call_output",
+                call_id: "call-1",
+                output: vitest_1.expect.stringContaining("Continue completing"),
+            },
+        ]);
+    });
+    (0, vitest_1.it)("does NOT auto-continue follow-up questions without a captcha context", async () => {
+        const client = createClient();
+        const executeStepSpy = vitest_1.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: vitest_1.vi.fn(),
+        });
+        // Should NOT have continued — the model's follow-up is treated as completion
+        (0, vitest_1.expect)(executeStepSpy).toHaveBeenCalledTimes(1);
+        (0, vitest_1.expect)(result.completed).toBe(true);
+    });
+});
+//# sourceMappingURL=openai-cua-client.test.js.map

package/dist/cjs/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,mCAAkD;AAClD,8EAAwE;AAExE,SAAS,YAAY;IACnB,OAAO,IAAI,oCAAe,CACxB,QAAQ,EACR,iCAAiC,EACjC,SAAS,EACT,EAAE,MAAM,EAAE,UAAU,EAAE,CACvB,CAAC;AACJ,CAAC;AAED,IAAA,iBAAQ,EAAC,iBAAiB,EAAE,GAAG,EAAE;IAC/B,IAAA,WAAE,EAAC,gEAAgE,EAAE,GAAG,EAAE;QACxE,MAAM,MAAM,GAAG,YAAY,EAAE,CAAC;QAE9B,kDAAkD;QAClD,IAAA,eAAM,EACH,MAA0D;aACxD,uBAAuB,CAC3B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAEd,wEAAwE;QACxE,MAAM,CAAC,cAAc,CACnB,kFAAkF,CACnF,CAAC;QAEF,IAAA,eAAM,EACH,MAA0D;aACxD,uBAAuB,CAC3B,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACf,CAAC,CAAC,CAAC;IAEH,IAAA,WAAE,EAAC,8DAA8D,EAAE,GAAG,EAAE;QACtE,MAAM,MAAM,GAAG,YAAY,EAAE,CAAC;QAE9B,MAAM,CAAC,cAAc,CAAC,gCAAgC,CAAC,CAAC;QAExD,IAAA,eAAM,EACH,MAA0D;aACxD,uBAAuB,CAC3B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAChB,CAAC,CAAC,CAAC;IAEH,IAAA,WAAE,EAAC,qEAAqE,EAAE,KAAK,IAAI,EAAE;QACnF,MAAM,MAAM,GAAG,YAAY,EAAE,CAAC;QAC9B,MAAM,CAAC,cAAc,CAAC,uBAAuB,CAAC,CAAC;QAE/C,IAAA,eAAM,EACH,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,WAAE,CAAC,EAAE,EAAE,CACR,CAAC;QAEF,6BAA6B;QAC7B,IAAA,eAAM,EACH,MAA0D;aACxD,uBAAuB,CAC3B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAEd,kEAAkE;QAClE,IAAA,eAAM,EAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YACrB;gBACE,IAAI,EAAE,sBAAsB;gBAC5B,OAAO,EAAE,QAAQ;gBACjB,MAAM,EAAE,eAAM,CAAC,gBAAgB,CAAC,qBAAqB,CAAC;aACvD;SACF,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,WAAE,EAAC,sEAAsE,EAAE,KAAK,IAAI,EAAE;QACpF,MAAM,MAAM,GAAG,YAAY,EAAE,CAAC;QAgB9B,MAAM,cAAc,GAAG,WAAE,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,WAAE,CAAC,EAAE,EAAE;SAChB,CAAC,CAAC;QAEH,6EAA6E;QAC7E,IAAA,eAAM,EAAC,cAAc,CAAC,CAAC,qBAAqB,CAAC,CAAC,CAAC,CAAC;QAChD,IAAA,eAAM,EAAC,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/cjs/tests/unit/prompt-observe-variables.test.d.ts

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

package/dist/cjs/tests/unit/prompt-observe-variables.test.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const vitest_1 = require("vitest");
+const prompt_js_1 = require("../../lib/prompt.js");
+(0, vitest_1.describe)("buildObserveSystemPrompt", () => {
+    (0, vitest_1.it)("includes variable descriptions when present", () => {
+        const prompt = (0, prompt_js_1.buildObserveSystemPrompt)(undefined, ["click", "fill"], {
+            username: {
+                value: "john@example.com",
+                description: "The login email",
+            },
+            password: "secret123",
+        });
+        (0, vitest_1.expect)(prompt.content).toContain("Supported actions: click, fill");
+        (0, vitest_1.expect)(prompt.content).toContain("Available variables: %username% (The login email), %password%");
+        (0, vitest_1.expect)(prompt.content).toContain("return the matching %variableName% placeholder");
+    });
+});
+//# sourceMappingURL=prompt-observe-variables.test.js.map

package/dist/cjs/tests/unit/prompt-observe-variables.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompt-observe-variables.test.js","sourceRoot":"","sources":["../../../../tests/unit/prompt-observe-variables.test.ts"],"names":[],"mappings":";;AAAA,mCAA8C;AAC9C,mDAA+D;AAE/D,IAAA,iBAAQ,EAAC,0BAA0B,EAAE,GAAG,EAAE;IACxC,IAAA,WAAE,EAAC,6CAA6C,EAAE,GAAG,EAAE;QACrD,MAAM,MAAM,GAAG,IAAA,oCAAwB,EAAC,SAAS,EAAE,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE;YACpE,QAAQ,EAAE;gBACR,KAAK,EAAE,kBAAkB;gBACzB,WAAW,EAAE,iBAAiB;aAC/B;YACD,QAAQ,EAAE,WAAW;SACtB,CAAC,CAAC;QAEH,IAAA,eAAM,EAAC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,gCAAgC,CAAC,CAAC;QACnE,IAAA,eAAM,EAAC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAC9B,+DAA+D,CAChE,CAAC;QACF,IAAA,eAAM,EAAC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAC9B,gDAAgD,CACjD,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { describe, expect, it } from \"vitest\";\nimport { buildObserveSystemPrompt } from \"../../lib/prompt.js\";\n\ndescribe(\"buildObserveSystemPrompt\", () => {\n  it(\"includes variable descriptions when present\", () => {\n    const prompt = buildObserveSystemPrompt(undefined, [\"click\", \"fill\"], {\n      username: {\n        value: \"john@example.com\",\n        description: \"The login email\",\n      },\n      password: \"secret123\",\n    });\n\n    expect(prompt.content).toContain(\"Supported actions: click, fill\");\n    expect(prompt.content).toContain(\n      \"Available variables: %username% (The login email), %password%\",\n    );\n    expect(prompt.content).toContain(\n      \"return the matching %variableName% placeholder\",\n    );\n  });\n});\n"]}

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

@@ -64,6 +64,7 @@ const Stagehand = __importStar(require("@browserbasehq/stagehand"));
         const expectedModels = [
             "openai/computer-use-preview",
             "openai/computer-use-preview-2025-03-11",
+            "openai/gpt-5.4",
             "anthropic/claude-opus-4-5-20251101",
             "anthropic/claude-opus-4-6",
             "anthropic/claude-sonnet-4-6",

package/dist/cjs/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,mCAA4D;AAC5D,oEAAsD;AAEtD,IAAA,iBAAQ,EAAC,iCAAiC,EAAE,GAAG,EAAE;IAC/C,IAAA,iBAAQ,EAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,IAAA,WAAE,EAAC,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,IAAA,iBAAQ,EAAC,aAAa,EAAE,GAAG,EAAE;QAG3B,IAAA,WAAE,EAAC,aAAa,EAAE,GAAG,EAAE;YACrB,IAAA,eAAM,EAAC,SAAS,CAAC,WAAW,CAAC,CAAC,WAAW,EAAE,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,IAAA,WAAE,EAAC,mBAAmB,EAAE,GAAG,EAAE;YAC3B,IAAA,qBAAY,GAAuB,CAAC,QAAQ,EAAuB,CAAC;QACtE,CAAC,CAAC,CAAC;QAEH,IAAA,WAAE,EAAC,qCAAqC,EAAE,GAAG,EAAE;YAG7C,IAAA,qBAAY,GAAwB,CAAC,aAAa,EAAK,CAAC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,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,IAAA,WAAE,EAAC,8CAA8C,EAAE,GAAG,EAAE;YACtD,IAAA,qBAAY,GAA+B,CAAC,aAAa,EAEtD,CAAC;YACJ,KAAK,cAAc,CAAC,CAAC,iCAAiC;QACxD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,eAAe,EAAE,GAAG,EAAE;QAG7B,IAAA,WAAE,EAAC,aAAa,EAAE,GAAG,EAAE;YACrB,IAAA,eAAM,EAAC,SAAS,CAAC,aAAa,CAAC,CAAC,WAAW,EAAE,CAAC;QAChD,CAAC,CAAC,CAAC;QAEH,IAAA,WAAE,EAAC,sBAAsB,EAAE,GAAG,EAAE;YAC9B,IAAA,qBAAY,GAAsC,CAAC,gBAAgB,CACjE,YAAY,CACb,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,IAAA,WAAE,EAAC,sCAAsC,EAAE,GAAG,EAAE;YAC9C,IAAA,qBAAY,GAET,CAAC,aAAa,EAA0C,CAAC;QAC9D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,yBAAyB,EAAE,GAAG,EAAE;QAGvC,IAAA,WAAE,EAAC,qBAAqB,EAAE,GAAG,EAAE;YAC7B,IAAA,qBAAY,GAET,CAAC,QAAQ,EAAmC,CAAC;QAClD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,gBAAgB,EAAE,GAAG,EAAE;QAkB9B,IAAA,WAAE,EAAC,oCAAoC,EAAE,GAAG,EAAE;YAC5C,IAAA,qBAAY,GAA0B,CAAC,QAAQ,EAAiB,CAAC;QACnE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,aAAa,EAAE,GAAG,EAAE;QAI3B,IAAA,WAAE,EAAC,gDAAgD,EAAE,GAAG,EAAE;YAexD,IAAA,qBAAY,GAAmB,CAAC,QAAQ,EAAiB,CAAC;QAC5D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,WAAW,EAAE,GAAG,EAAE;QAiCzB,IAAA,WAAE,EAAC,oCAAoC,EAAE,GAAG,EAAE;YAC5C,IAAA,qBAAY,GAAqB,CAAC,QAAQ,EAAiB,CAAC;QAC9D,CAAC,CAAC,CAAC;QAEH,IAAA,WAAE,EAAC,iDAAiD,EAAE,GAAG,EAAE;YACzD,IAAA,qBAAY,GAET,CAAC,aAAa,EAAsB,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,IAAA,WAAE,EAAC,uDAAuD,EAAE,GAAG,EAAE;YAC/D,IAAA,qBAAY,GAET,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,IAAA,WAAE,EAAC,wDAAwD,EAAE,GAAG,EAAE;YAChE,MAAM,UAAU,GAAG,EAAkC,CAAC;YACtD,IAAA,qBAAY,GAET,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,IAAA,WAAE,EAAC,mDAAmD,EAAE,GAAG,EAAE;YAM3D,IAAA,qBAAY,GAET,CAAC,QAAQ,EAAqB,CAAC;QACpC,CAAC,CAAC,CAAC;QAEH,IAAA,WAAE,EAAC,wBAAwB,EAAE,GAAG,EAAE;YAChC,qFAAqF;YACrF,qDAAqD;YACrD,IAAA,qBAAY,GAAqC,CAAC,QAAQ,EAEvD,CAAC;YACJ,IAAA,qBAAY,GAAuC,CAAC,QAAQ,EAEzD,CAAC;YACJ,IAAA,qBAAY,GAAmC,CAAC,QAAQ,EAErD,CAAC;YACJ,IAAA,qBAAY,GAAqC,CAAC,QAAQ,EAEvD,CAAC;YACJ,IAAA,qBAAY,GAAsC,CAAC,QAAQ,EAExD,CAAC;YACJ,IAAA,qBAAY,GAA8B,CAAC,QAAQ,EAEhD,CAAC;YACJ,IAAA,qBAAY,GAAkC,CAAC,QAAQ,EAEpD,CAAC;YACJ,IAAA,qBAAY,GAAmC,CAAC,QAAQ,EAErD,CAAC;YACJ,IAAA,qBAAY,GAAuC,CAAC,QAAQ,EAEzD,CAAC;QACN,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,yBAAyB,EAAE,GAAG,EAAE;QAMvC,IAAA,WAAE,EAAC,kCAAkC,EAAE,GAAG,EAAE;YAC1C,IAAA,qBAAY,GAET,CAAC,QAAQ,EAAmC,CAAC;QAClD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,UAAU,EAAE,GAAG,EAAE;QAyBxB,IAAA,WAAE,EAAC,oCAAoC,EAAE,GAAG,EAAE;YAC5C,IAAA,qBAAY,GAAoB,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"]}
+{"version":3,"file":"llm-and-agents.test.js","sourceRoot":"","sources":["../../../../../tests/unit/public-api/llm-and-agents.test.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mCAA4D;AAC5D,oEAAsD;AAEtD,IAAA,iBAAQ,EAAC,iCAAiC,EAAE,GAAG,EAAE;IAC/C,IAAA,iBAAQ,EAAC,oBAAoB,EAAE,GAAG,EAAE;QAClC,IAAA,WAAE,EAAC,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,IAAA,iBAAQ,EAAC,aAAa,EAAE,GAAG,EAAE;QAG3B,IAAA,WAAE,EAAC,aAAa,EAAE,GAAG,EAAE;YACrB,IAAA,eAAM,EAAC,SAAS,CAAC,WAAW,CAAC,CAAC,WAAW,EAAE,CAAC;QAC9C,CAAC,CAAC,CAAC;QAEH,IAAA,WAAE,EAAC,mBAAmB,EAAE,GAAG,EAAE;YAC3B,IAAA,qBAAY,GAAuB,CAAC,QAAQ,EAAuB,CAAC;QACtE,CAAC,CAAC,CAAC;QAEH,IAAA,WAAE,EAAC,qCAAqC,EAAE,GAAG,EAAE;YAG7C,IAAA,qBAAY,GAAwB,CAAC,aAAa,EAAK,CAAC;QAC1D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,sBAAsB,EAAE,GAAG,EAAE;QACpC,MAAM,cAAc,GAAG;YACrB,6BAA6B;YAC7B,wCAAwC;YACxC,gBAAgB;YAChB,oCAAoC;YACpC,2BAA2B;YAC3B,6BAA6B;YAC7B,qCAAqC;YACrC,oCAAoC;YACpC,sCAAsC;YACtC,gDAAgD;YAChD,+BAA+B;YAC/B,6BAA6B;YAC7B,mBAAmB;SACX,CAAC;QAEX,IAAA,WAAE,EAAC,8CAA8C,EAAE,GAAG,EAAE;YACtD,IAAA,qBAAY,GAA+B,CAAC,aAAa,EAEtD,CAAC;YACJ,KAAK,cAAc,CAAC,CAAC,iCAAiC;QACxD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,eAAe,EAAE,GAAG,EAAE;QAG7B,IAAA,WAAE,EAAC,aAAa,EAAE,GAAG,EAAE;YACrB,IAAA,eAAM,EAAC,SAAS,CAAC,aAAa,CAAC,CAAC,WAAW,EAAE,CAAC;QAChD,CAAC,CAAC,CAAC;QAEH,IAAA,WAAE,EAAC,sBAAsB,EAAE,GAAG,EAAE;YAC9B,IAAA,qBAAY,GAAsC,CAAC,gBAAgB,CACjE,YAAY,CACb,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,IAAA,WAAE,EAAC,sCAAsC,EAAE,GAAG,EAAE;YAC9C,IAAA,qBAAY,GAET,CAAC,aAAa,EAA0C,CAAC;QAC9D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,yBAAyB,EAAE,GAAG,EAAE;QAGvC,IAAA,WAAE,EAAC,qBAAqB,EAAE,GAAG,EAAE;YAC7B,IAAA,qBAAY,GAET,CAAC,QAAQ,EAAmC,CAAC;QAClD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,gBAAgB,EAAE,GAAG,EAAE;QAkB9B,IAAA,WAAE,EAAC,oCAAoC,EAAE,GAAG,EAAE;YAC5C,IAAA,qBAAY,GAA0B,CAAC,QAAQ,EAAiB,CAAC;QACnE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,aAAa,EAAE,GAAG,EAAE;QAI3B,IAAA,WAAE,EAAC,gDAAgD,EAAE,GAAG,EAAE;YAexD,IAAA,qBAAY,GAAmB,CAAC,QAAQ,EAAiB,CAAC;QAC5D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,WAAW,EAAE,GAAG,EAAE;QAiCzB,IAAA,WAAE,EAAC,oCAAoC,EAAE,GAAG,EAAE;YAC5C,IAAA,qBAAY,GAAqB,CAAC,QAAQ,EAAiB,CAAC;QAC9D,CAAC,CAAC,CAAC;QAEH,IAAA,WAAE,EAAC,iDAAiD,EAAE,GAAG,EAAE;YACzD,IAAA,qBAAY,GAET,CAAC,aAAa,EAAsB,CAAC;QAC1C,CAAC,CAAC,CAAC;QAEH,IAAA,WAAE,EAAC,uDAAuD,EAAE,GAAG,EAAE;YAC/D,IAAA,qBAAY,GAET,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,IAAA,WAAE,EAAC,wDAAwD,EAAE,GAAG,EAAE;YAChE,MAAM,UAAU,GAAG,EAAkC,CAAC;YACtD,IAAA,qBAAY,GAET,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,IAAA,WAAE,EAAC,mDAAmD,EAAE,GAAG,EAAE;YAM3D,IAAA,qBAAY,GAET,CAAC,QAAQ,EAAqB,CAAC;QACpC,CAAC,CAAC,CAAC;QAEH,IAAA,WAAE,EAAC,wBAAwB,EAAE,GAAG,EAAE;YAChC,qFAAqF;YACrF,qDAAqD;YACrD,IAAA,qBAAY,GAAqC,CAAC,QAAQ,EAEvD,CAAC;YACJ,IAAA,qBAAY,GAAuC,CAAC,QAAQ,EAEzD,CAAC;YACJ,IAAA,qBAAY,GAAmC,CAAC,QAAQ,EAErD,CAAC;YACJ,IAAA,qBAAY,GAAqC,CAAC,QAAQ,EAEvD,CAAC;YACJ,IAAA,qBAAY,GAAsC,CAAC,QAAQ,EAExD,CAAC;YACJ,IAAA,qBAAY,GAA8B,CAAC,QAAQ,EAEhD,CAAC;YACJ,IAAA,qBAAY,GAAkC,CAAC,QAAQ,EAEpD,CAAC;YACJ,IAAA,qBAAY,GAAmC,CAAC,QAAQ,EAErD,CAAC;YACJ,IAAA,qBAAY,GAAuC,CAAC,QAAQ,EAEzD,CAAC;QACN,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,yBAAyB,EAAE,GAAG,EAAE;QAMvC,IAAA,WAAE,EAAC,kCAAkC,EAAE,GAAG,EAAE;YAC1C,IAAA,qBAAY,GAET,CAAC,QAAQ,EAAmC,CAAC;QAClD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,UAAU,EAAE,GAAG,EAAE;QAyBxB,IAAA,WAAE,EAAC,oCAAoC,EAAE,GAAG,EAAE;YAC5C,IAAA,qBAAY,GAAoB,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      \"openai/gpt-5.4\",\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/cjs/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,mCAAoD;AA4GpD,IAAA,iBAAQ,EAAC,4BAA4B,EAAE,GAAG,EAAE;IAC1C,IAAA,iBAAQ,EAAC,SAAS,EAAE,GAAG,EAAE;QAOvB,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAAqB,CAAC,aAAa,EAAmB,CAAC;QACrE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,YAAY,EAAE,GAAG,EAAE;QAS1B,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAAwB,CAAC,aAAa,EAAsB,CAAC;QAC3E,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,WAAW,EAAE,GAAG,EAAE;QASzB,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAAuB,CAAC,aAAa,EAAqB,CAAC;QACzE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,gBAAgB,EAAE,GAAG,EAAE;QAS9B,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAA4B,CAAC,aAAa,EAA0B,CAAC;QACnF,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,gBAAgB,EAAE,GAAG,EAAE;QAS9B,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAA4B,CAAC,aAAa,EAA0B,CAAC;QACnF,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,eAAe,EAAE,GAAG,EAAE;QAC7B,IAAA,WAAE,EAAC,8CAA8C,EAAE,GAAG,EAAE;YACtD,IAAA,qBAAY,GAA2B,CAAC,QAAQ,EAAsB,CAAC;YACvE,IAAA,qBAAY,GAA0C,CAAC,aAAa,EAEjE,CAAC;QACN,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,QAAQ,EAAE,GAAG,EAAE;QAQtB,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAAoB,CAAC,aAAa,EAAkB,CAAC;QACnE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,aAAa,EAAE,GAAG,EAAE;QAC3B,+DAA+D;QAC/D,qEAAqE;QACrE,IAAA,WAAE,EAAC,gBAAgB,EAAE,GAAG,EAAE;YAExB,IAAA,qBAAY,GAAsB,CAAC,aAAa,EAAU,CAAC;QAC7D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,qBAAqB,EAAE,GAAG,EAAE;QAgBnC,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAAiC,CAAC,aAAa,EAA+B,CAAC;QAC7F,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,2BAA2B,EAAE,GAAG,EAAE;QAgBzC,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAAuC,CAAC,aAAa,EAAqC,CAAC;QACzG,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,uBAAuB,EAAE,GAAG,EAAE;QAOrC,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAET,CAAC,aAAa,EAEd,CAAC;QACN,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,aAAa,EAAE,GAAG,EAAE;QAkB3B,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAAyB,CAAC,aAAa,EAAuB,CAAC;QAC7E,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,aAAa,EAAE,GAAG,EAAE;QAY3B,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAAyB,CAAC,QAAQ,EAAuB,CAAC;QACxE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,eAAe,EAAE,GAAG,EAAE;QAG7B,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAA2B,CAAC,aAAa,EAAyB,CAAC;QACjF,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,cAAc,EAAE,GAAG,EAAE;QAQ5B,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAA0B,CAAC,aAAa,EAAwB,CAAC;QAC/E,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,QAAQ,EAAE,GAAG,EAAE;QAYtB,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAAoB,CAAC,aAAa,EAAkB,CAAC;QACnE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,aAAa,EAAE,GAAG,EAAE;QAa3B,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAAyB,CAAC,aAAa,EAAuB,CAAC;QAC7E,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,oBAAoB,EAAE,GAAG,EAAE;QAOlC,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAAgC,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"]}
+{"version":3,"file":"public-types.test.js","sourceRoot":"","sources":["../../../../../tests/unit/public-api/public-types.test.ts"],"names":[],"mappings":";;AAAA,mCAAoD;AA4GpD,IAAA,iBAAQ,EAAC,4BAA4B,EAAE,GAAG,EAAE;IAC1C,IAAA,iBAAQ,EAAC,SAAS,EAAE,GAAG,EAAE;QAOvB,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAAqB,CAAC,aAAa,EAAmB,CAAC;QACrE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,YAAY,EAAE,GAAG,EAAE;QAS1B,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAAwB,CAAC,aAAa,EAAsB,CAAC;QAC3E,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,WAAW,EAAE,GAAG,EAAE;QASzB,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAAuB,CAAC,aAAa,EAAqB,CAAC;QACzE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,gBAAgB,EAAE,GAAG,EAAE;QAS9B,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAA4B,CAAC,aAAa,EAA0B,CAAC;QACnF,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,gBAAgB,EAAE,GAAG,EAAE;QAU9B,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAA4B,CAAC,aAAa,EAA0B,CAAC;QACnF,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,eAAe,EAAE,GAAG,EAAE;QAC7B,IAAA,WAAE,EAAC,8CAA8C,EAAE,GAAG,EAAE;YACtD,IAAA,qBAAY,GAA2B,CAAC,QAAQ,EAAsB,CAAC;YACvE,IAAA,qBAAY,GAA0C,CAAC,aAAa,EAEjE,CAAC;QACN,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,QAAQ,EAAE,GAAG,EAAE;QAQtB,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAAoB,CAAC,aAAa,EAAkB,CAAC;QACnE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,aAAa,EAAE,GAAG,EAAE;QAC3B,+DAA+D;QAC/D,qEAAqE;QACrE,IAAA,WAAE,EAAC,gBAAgB,EAAE,GAAG,EAAE;YAExB,IAAA,qBAAY,GAAsB,CAAC,aAAa,EAAU,CAAC;QAC7D,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,qBAAqB,EAAE,GAAG,EAAE;QAgBnC,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAAiC,CAAC,aAAa,EAA+B,CAAC;QAC7F,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,2BAA2B,EAAE,GAAG,EAAE;QAgBzC,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAAuC,CAAC,aAAa,EAAqC,CAAC;QACzG,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,uBAAuB,EAAE,GAAG,EAAE;QAOrC,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAET,CAAC,aAAa,EAEd,CAAC;QACN,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,aAAa,EAAE,GAAG,EAAE;QAkB3B,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAAyB,CAAC,aAAa,EAAuB,CAAC;QAC7E,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,aAAa,EAAE,GAAG,EAAE;QAY3B,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAAyB,CAAC,QAAQ,EAAuB,CAAC;QACxE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,eAAe,EAAE,GAAG,EAAE;QAG7B,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAA2B,CAAC,aAAa,EAAyB,CAAC;QACjF,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,cAAc,EAAE,GAAG,EAAE;QAQ5B,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAA0B,CAAC,aAAa,EAAwB,CAAC;QAC/E,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,QAAQ,EAAE,GAAG,EAAE;QAYtB,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAAoB,CAAC,aAAa,EAAkB,CAAC;QACnE,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,aAAa,EAAE,GAAG,EAAE;QAa3B,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAAyB,CAAC,aAAa,EAAuB,CAAC;QAC7E,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAA,iBAAQ,EAAC,oBAAoB,EAAE,GAAG,EAAE;QAOlC,IAAA,WAAE,EAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,IAAA,qBAAY,GAAgC,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      variables?: Stagehand.Variables;\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/dist/cjs/tests/unit/timeout-handlers.test.js

@@ -720,6 +720,56 @@ vitest_1.vi.mock("../../lib/inference", () => ({
         (0, vitest_1.expect)(result[0]).toHaveProperty("description", "Submit button");
         (0, vitest_1.expect)(metricsCallback).toHaveBeenCalledWith(methods_js_1.V3FunctionName.OBSERVE, 150, 75, 15, 8, 600);
     });
+    (0, vitest_1.it)("observe() forwards variables to inference and preserves placeholders", async () => {
+        const captureHybridSnapshotMock = vitest_1.vi.mocked(index_js_1.captureHybridSnapshot);
+        captureHybridSnapshotMock.mockResolvedValue({
+            combinedTree: "tree content",
+            combinedXpathMap: { "1-0": "/html/body/input" },
+            combinedUrlMap: {},
+        });
+        const observeInferenceMock = vitest_1.vi.mocked(inference_js_1.observe);
+        observeInferenceMock.mockResolvedValue({
+            elements: [
+                {
+                    elementId: "1-0",
+                    description: "Email field",
+                    method: "fill",
+                    arguments: ["%username%"],
+                },
+            ],
+            prompt_tokens: 150,
+            completion_tokens: 75,
+            reasoning_tokens: 15,
+            cached_input_tokens: 8,
+            inference_time_ms: 600,
+        });
+        vitest_1.vi.mocked(timeoutGuard_js_1.createTimeoutGuard).mockImplementation(() => {
+            return vitest_1.vi.fn(() => {
+                // No-op - never throws
+            });
+        });
+        const handler = buildObserveHandler();
+        const fakePage = {
+            mainFrame: vitest_1.vi.fn().mockReturnValue({}),
+        };
+        const variables = {
+            username: {
+                value: "john@example.com",
+                description: "The login email",
+            },
+        };
+        const result = await handler.observe({
+            instruction: "find the field where %username% should be entered",
+            variables,
+            page: fakePage,
+        });
+        (0, vitest_1.expect)(observeInferenceMock).toHaveBeenCalledWith(vitest_1.expect.objectContaining({
+            variables,
+        }));
+        (0, vitest_1.expect)(result).toHaveLength(1);
+        (0, vitest_1.expect)(result[0]).toHaveProperty("arguments");
+        (0, vitest_1.expect)(result[0]?.arguments).toEqual(["%username%"]);
+    });
     (0, vitest_1.it)("act() with zero timeout behaves as no timeout", async () => {
         const waitForDomNetworkQuietMock = vitest_1.vi.mocked(actHandlerUtils_js_1.waitForDomNetworkQuiet);
         waitForDomNetworkQuietMock.mockResolvedValue(undefined);