@browserbasehq/orca 3.0.9-alpha-3 → 3.1.0-headers

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/page-snapshot.test.d.ts

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

package/dist/esm/tests/unit/page-snapshot.test.js

@@ -0,0 +1,40 @@
+import { afterEach, describe, expect, it, vi } from "vitest";
+import { promises as fs } from "fs";
+import { Page } from "../../lib/v3/understudy/page.js";
+import * as snapshotModule from "../../lib/v3/understudy/a11y/snapshot/index.js";
+const baseSnapshot = {
+    combinedTree: "tree",
+    combinedXpathMap: {},
+    combinedUrlMap: {},
+    perFrame: [],
+};
+describe("Page.snapshot", () => {
+    afterEach(() => {
+        vi.restoreAllMocks();
+    });
+    it("forwards the includeIframes flag to captureHybridSnapshot", async () => {
+        vi.spyOn(fs, "writeFile").mockResolvedValue();
+        const captureSpy = vi
+            .spyOn(snapshotModule, "captureHybridSnapshot")
+            .mockResolvedValue(baseSnapshot);
+        const fakePage = {};
+        await Page.prototype.snapshot.call(fakePage, { includeIframes: false });
+        expect(captureSpy).toHaveBeenCalledWith(fakePage, {
+            pierceShadow: true,
+            includeIframes: false,
+        });
+    });
+    it("falls back to default iframe inclusion when option is omitted", async () => {
+        vi.spyOn(fs, "writeFile").mockResolvedValue();
+        const captureSpy = vi
+            .spyOn(snapshotModule, "captureHybridSnapshot")
+            .mockResolvedValue(baseSnapshot);
+        const fakePage = {};
+        await Page.prototype.snapshot.call(fakePage);
+        expect(captureSpy).toHaveBeenCalledWith(fakePage, {
+            pierceShadow: true,
+            includeIframes: undefined,
+        });
+    });
+});
+//# sourceMappingURL=page-snapshot.test.js.map

package/dist/esm/tests/unit/page-snapshot.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"page-snapshot.test.js","sourceRoot":"","sources":["../../../../tests/unit/page-snapshot.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC7D,OAAO,EAAE,QAAQ,IAAI,EAAE,EAAE,MAAM,IAAI,CAAC;AACpC,OAAO,EAAE,IAAI,EAAE,MAAM,iCAAiC,CAAC;AACvD,OAAO,KAAK,cAAc,MAAM,gDAAgD,CAAC;AAGjF,MAAM,YAAY,GAAmB;IACnC,YAAY,EAAE,MAAM;IACpB,gBAAgB,EAAE,EAAE;IACpB,cAAc,EAAE,EAAE;IAClB,QAAQ,EAAE,EAAE;CACb,CAAC;AAEF,QAAQ,CAAC,eAAe,EAAE,GAAG,EAAE;IAC7B,SAAS,CAAC,GAAG,EAAE;QACb,EAAE,CAAC,eAAe,EAAE,CAAC;IACvB,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,2DAA2D,EAAE,KAAK,IAAI,EAAE;QACzE,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC,iBAAiB,EAAE,CAAC;QAC9C,MAAM,UAAU,GAAG,EAAE;aAClB,KAAK,CAAC,cAAc,EAAE,uBAAuB,CAAC;aAC9C,iBAAiB,CAAC,YAAY,CAAC,CAAC;QAEnC,MAAM,QAAQ,GAAG,EAAU,CAAC;QAC5B,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,EAAE,cAAc,EAAE,KAAK,EAAE,CAAC,CAAC;QAExE,MAAM,CAAC,UAAU,CAAC,CAAC,oBAAoB,CAAC,QAAQ,EAAE;YAChD,YAAY,EAAE,IAAI;YAClB,cAAc,EAAE,KAAK;SACtB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,+DAA+D,EAAE,KAAK,IAAI,EAAE;QAC7E,EAAE,CAAC,KAAK,CAAC,EAAE,EAAE,WAAW,CAAC,CAAC,iBAAiB,EAAE,CAAC;QAC9C,MAAM,UAAU,GAAG,EAAE;aAClB,KAAK,CAAC,cAAc,EAAE,uBAAuB,CAAC;aAC9C,iBAAiB,CAAC,YAAY,CAAC,CAAC;QAEnC,MAAM,QAAQ,GAAG,EAAU,CAAC;QAC5B,MAAM,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QAE7C,MAAM,CAAC,UAAU,CAAC,CAAC,oBAAoB,CAAC,QAAQ,EAAE;YAChD,YAAY,EAAE,IAAI;YAClB,cAAc,EAAE,SAAS;SAC1B,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { afterEach, describe, expect, it, vi } from \"vitest\";\nimport { promises as fs } from \"fs\";\nimport { Page } from \"../../lib/v3/understudy/page.js\";\nimport * as snapshotModule from \"../../lib/v3/understudy/a11y/snapshot/index.js\";\nimport type { HybridSnapshot } from \"../../lib/v3/types/private/index.js\";\n\nconst baseSnapshot: HybridSnapshot = {\n  combinedTree: \"tree\",\n  combinedXpathMap: {},\n  combinedUrlMap: {},\n  perFrame: [],\n};\n\ndescribe(\"Page.snapshot\", () => {\n  afterEach(() => {\n    vi.restoreAllMocks();\n  });\n\n  it(\"forwards the includeIframes flag to captureHybridSnapshot\", async () => {\n    vi.spyOn(fs, \"writeFile\").mockResolvedValue();\n    const captureSpy = vi\n      .spyOn(snapshotModule, \"captureHybridSnapshot\")\n      .mockResolvedValue(baseSnapshot);\n\n    const fakePage = {} as Page;\n    await Page.prototype.snapshot.call(fakePage, { includeIframes: false });\n\n    expect(captureSpy).toHaveBeenCalledWith(fakePage, {\n      pierceShadow: true,\n      includeIframes: false,\n    });\n  });\n\n  it(\"falls back to default iframe inclusion when option is omitted\", async () => {\n    vi.spyOn(fs, \"writeFile\").mockResolvedValue();\n    const captureSpy = vi\n      .spyOn(snapshotModule, \"captureHybridSnapshot\")\n      .mockResolvedValue(baseSnapshot);\n\n    const fakePage = {} as Page;\n    await Page.prototype.snapshot.call(fakePage);\n\n    expect(captureSpy).toHaveBeenCalledWith(fakePage, {\n      pierceShadow: true,\n      includeIframes: undefined,\n    });\n  });\n});\n"]}

package/dist/esm/tests/unit/public-api/export-surface.test.d.ts

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

package/dist/esm/tests/unit/public-api/export-surface.test.js

@@ -0,0 +1,72 @@
+import { describe, expect, it } from "vitest";
+import StagehandDefaultExport, * as Stagehand from "@browserbasehq/stagehand";
+import { publicErrorTypes } from "./public-error-types.test.js";
+// Type matcher guidelines:
+//
+// toEqualTypeOf – Default. Assert full, deep type equality; any type change should fail.
+//   e.g. expectTypeOf<ReturnType<typeof foo>>().toEqualTypeOf<FooResult>()
+//
+// toMatchObjectType – Assert (part of) an object's shape while allowing extra fields.
+//   e.g. expectTypeOf(user).toMatchObjectType<{ id: string; email: string }>()
+//
+// toExtend – Assert that a type is compatible with a broader contract (assignable/extends).
+//   e.g. expectTypeOf<User>().toExtend<BaseUser>()
+const publicApiShape = {
+    __internalMaybeRunShutdownSupervisorFromArgv: Stagehand.__internalMaybeRunShutdownSupervisorFromArgv,
+    __internalCreateInMemoryAgentCacheHandle: Stagehand.__internalCreateInMemoryAgentCacheHandle,
+    AISdkClient: Stagehand.AISdkClient,
+    Api: Stagehand.Api,
+    AVAILABLE_CUA_MODELS: Stagehand.AVAILABLE_CUA_MODELS,
+    AgentProvider: Stagehand.AgentProvider,
+    AnnotatedScreenshotText: Stagehand.AnnotatedScreenshotText,
+    ConsoleMessage: Stagehand.ConsoleMessage,
+    CustomOpenAIClient: Stagehand.CustomOpenAIClient,
+    LLMClient: Stagehand.LLMClient,
+    LOG_LEVEL_NAMES: Stagehand.LOG_LEVEL_NAMES,
+    Response: Stagehand.Response,
+    Stagehand: Stagehand.Stagehand,
+    V3: Stagehand.V3,
+    V3Evaluator: Stagehand.V3Evaluator,
+    V3FunctionName: Stagehand.V3FunctionName,
+    connectToMCPServer: Stagehand.connectToMCPServer,
+    default: StagehandDefaultExport,
+    defaultExtractSchema: Stagehand.defaultExtractSchema,
+    getAISDKLanguageModel: Stagehand.getAISDKLanguageModel,
+    getZodType: Stagehand.getZodType,
+    injectUrls: Stagehand.injectUrls,
+    isRunningInBun: Stagehand.isRunningInBun,
+    isZod3Schema: Stagehand.isZod3Schema,
+    isZod4Schema: Stagehand.isZod4Schema,
+    jsonSchemaToZod: Stagehand.jsonSchemaToZod,
+    loadApiKeyFromEnv: Stagehand.loadApiKeyFromEnv,
+    localBrowserLaunchOptionsSchema: Stagehand.localBrowserLaunchOptionsSchema,
+    modelToAgentProviderMap: Stagehand.modelToAgentProviderMap,
+    pageTextSchema: Stagehand.pageTextSchema,
+    providerEnvVarMap: Stagehand.providerEnvVarMap,
+    toGeminiSchema: Stagehand.toGeminiSchema,
+    toJsonSchema: Stagehand.toJsonSchema,
+    tool: Stagehand.tool,
+    transformSchema: Stagehand.transformSchema,
+    trimTrailingTextNode: Stagehand.trimTrailingTextNode,
+    validateZodSchema: Stagehand.validateZodSchema,
+    ...publicErrorTypes,
+};
+describe("Stagehand public API export surface", () => {
+    it("public API shape matches module exports", () => {
+        const _check = publicApiShape;
+        void _check;
+    });
+    it("does not expose unexpected top-level exports", () => {
+        const expected = Object.keys(publicApiShape).sort();
+        const actual = Object.keys(Stagehand).sort();
+        expect(actual).toStrictEqual(expected);
+    });
+    it("default export mirrors the named export surface", () => {
+        const expected = Object.keys(Stagehand)
+            .filter((key) => key !== "default")
+            .sort();
+        const actual = Object.keys(StagehandDefaultExport).sort();
+        expect(actual).toStrictEqual(expected);
+    });
+});
+//# sourceMappingURL=export-surface.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"export-surface.test.js","sourceRoot":"","sources":["../../../../../tests/unit/public-api/export-surface.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,sBAAsB,EAAE,KAAK,SAAS,MAAM,0BAA0B,CAAC;AAC9E,OAAO,EAAE,gBAAgB,EAAE,MAAM,8BAA8B,CAAC;AAEhE,2BAA2B;AAC3B,EAAE;AACF,yFAAyF;AACzF,2EAA2E;AAC3E,EAAE;AACF,sFAAsF;AACtF,+EAA+E;AAC/E,EAAE;AACF,4FAA4F;AAC5F,mDAAmD;AAEnD,MAAM,cAAc,GAAG;IACrB,4CAA4C,EAC1C,SAAS,CAAC,4CAA4C;IACxD,wCAAwC,EACtC,SAAS,CAAC,wCAAwC;IACpD,WAAW,EAAE,SAAS,CAAC,WAAW;IAClC,GAAG,EAAE,SAAS,CAAC,GAAG;IAClB,oBAAoB,EAAE,SAAS,CAAC,oBAAoB;IACpD,aAAa,EAAE,SAAS,CAAC,aAAa;IACtC,uBAAuB,EAAE,SAAS,CAAC,uBAAuB;IAC1D,cAAc,EAAE,SAAS,CAAC,cAAc;IACxC,kBAAkB,EAAE,SAAS,CAAC,kBAAkB;IAChD,SAAS,EAAE,SAAS,CAAC,SAAS;IAC9B,eAAe,EAAE,SAAS,CAAC,eAAe;IAC1C,QAAQ,EAAE,SAAS,CAAC,QAAQ;IAC5B,SAAS,EAAE,SAAS,CAAC,SAAS;IAC9B,EAAE,EAAE,SAAS,CAAC,EAAE;IAChB,WAAW,EAAE,SAAS,CAAC,WAAW;IAClC,cAAc,EAAE,SAAS,CAAC,cAAc;IACxC,kBAAkB,EAAE,SAAS,CAAC,kBAAkB;IAChD,OAAO,EAAE,sBAAsB;IAC/B,oBAAoB,EAAE,SAAS,CAAC,oBAAoB;IACpD,qBAAqB,EAAE,SAAS,CAAC,qBAAqB;IACtD,UAAU,EAAE,SAAS,CAAC,UAAU;IAChC,UAAU,EAAE,SAAS,CAAC,UAAU;IAChC,cAAc,EAAE,SAAS,CAAC,cAAc;IACxC,YAAY,EAAE,SAAS,CAAC,YAAY;IACpC,YAAY,EAAE,SAAS,CAAC,YAAY;IACpC,eAAe,EAAE,SAAS,CAAC,eAAe;IAC1C,iBAAiB,EAAE,SAAS,CAAC,iBAAiB;IAC9C,+BAA+B,EAAE,SAAS,CAAC,+BAA+B;IAC1E,uBAAuB,EAAE,SAAS,CAAC,uBAAuB;IAC1D,cAAc,EAAE,SAAS,CAAC,cAAc;IACxC,iBAAiB,EAAE,SAAS,CAAC,iBAAiB;IAC9C,cAAc,EAAE,SAAS,CAAC,cAAc;IACxC,YAAY,EAAE,SAAS,CAAC,YAAY;IACpC,IAAI,EAAE,SAAS,CAAC,IAAI;IACpB,eAAe,EAAE,SAAS,CAAC,eAAe;IAC1C,oBAAoB,EAAE,SAAS,CAAC,oBAAoB;IACpD,iBAAiB,EAAE,SAAS,CAAC,iBAAiB;IAC9C,GAAG,gBAAgB;CACX,CAAC;AAUX,QAAQ,CAAC,qCAAqC,EAAE,GAAG,EAAE;IACnD,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QACjD,MAAM,MAAM,GAAc,cAAc,CAAC;QACzC,KAAK,MAAM,CAAC;IACd,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC,IAAI,EAAE,CAAC;QACpD,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,CAAC;QAC7C,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;QACzD,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC;aACpC,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,KAAK,SAAS,CAAC;aAClC,IAAI,EAAE,CAAC;QACV,MAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,sBAAsB,CAAC,CAAC,IAAI,EAAE,CAAC;QAC1D,MAAM,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { describe, expect, it } from \"vitest\";\nimport StagehandDefaultExport, * as Stagehand from \"@browserbasehq/stagehand\";\nimport { publicErrorTypes } from \"./public-error-types.test.js\";\n\n// Type matcher guidelines:\n//\n// toEqualTypeOf – Default. Assert full, deep type equality; any type change should fail.\n//   e.g. expectTypeOf<ReturnType<typeof foo>>().toEqualTypeOf<FooResult>()\n//\n// toMatchObjectType – Assert (part of) an object's shape while allowing extra fields.\n//   e.g. expectTypeOf(user).toMatchObjectType<{ id: string; email: string }>()\n//\n// toExtend – Assert that a type is compatible with a broader contract (assignable/extends).\n//   e.g. expectTypeOf<User>().toExtend<BaseUser>()\n\nconst publicApiShape = {\n  __internalMaybeRunShutdownSupervisorFromArgv:\n    Stagehand.__internalMaybeRunShutdownSupervisorFromArgv,\n  __internalCreateInMemoryAgentCacheHandle:\n    Stagehand.__internalCreateInMemoryAgentCacheHandle,\n  AISdkClient: Stagehand.AISdkClient,\n  Api: Stagehand.Api,\n  AVAILABLE_CUA_MODELS: Stagehand.AVAILABLE_CUA_MODELS,\n  AgentProvider: Stagehand.AgentProvider,\n  AnnotatedScreenshotText: Stagehand.AnnotatedScreenshotText,\n  ConsoleMessage: Stagehand.ConsoleMessage,\n  CustomOpenAIClient: Stagehand.CustomOpenAIClient,\n  LLMClient: Stagehand.LLMClient,\n  LOG_LEVEL_NAMES: Stagehand.LOG_LEVEL_NAMES,\n  Response: Stagehand.Response,\n  Stagehand: Stagehand.Stagehand,\n  V3: Stagehand.V3,\n  V3Evaluator: Stagehand.V3Evaluator,\n  V3FunctionName: Stagehand.V3FunctionName,\n  connectToMCPServer: Stagehand.connectToMCPServer,\n  default: StagehandDefaultExport,\n  defaultExtractSchema: Stagehand.defaultExtractSchema,\n  getAISDKLanguageModel: Stagehand.getAISDKLanguageModel,\n  getZodType: Stagehand.getZodType,\n  injectUrls: Stagehand.injectUrls,\n  isRunningInBun: Stagehand.isRunningInBun,\n  isZod3Schema: Stagehand.isZod3Schema,\n  isZod4Schema: Stagehand.isZod4Schema,\n  jsonSchemaToZod: Stagehand.jsonSchemaToZod,\n  loadApiKeyFromEnv: Stagehand.loadApiKeyFromEnv,\n  localBrowserLaunchOptionsSchema: Stagehand.localBrowserLaunchOptionsSchema,\n  modelToAgentProviderMap: Stagehand.modelToAgentProviderMap,\n  pageTextSchema: Stagehand.pageTextSchema,\n  providerEnvVarMap: Stagehand.providerEnvVarMap,\n  toGeminiSchema: Stagehand.toGeminiSchema,\n  toJsonSchema: Stagehand.toJsonSchema,\n  tool: Stagehand.tool,\n  transformSchema: Stagehand.transformSchema,\n  trimTrailingTextNode: Stagehand.trimTrailingTextNode,\n  validateZodSchema: Stagehand.validateZodSchema,\n  ...publicErrorTypes,\n} as const;\n\ntype StagehandExports = typeof Stagehand & {\n  default: typeof StagehandDefaultExport;\n};\n\ntype PublicAPI = {\n  [K in keyof typeof publicApiShape]: StagehandExports[K];\n};\n\ndescribe(\"Stagehand public API export surface\", () => {\n  it(\"public API shape matches module exports\", () => {\n    const _check: PublicAPI = publicApiShape;\n    void _check;\n  });\n\n  it(\"does not expose unexpected top-level exports\", () => {\n    const expected = Object.keys(publicApiShape).sort();\n    const actual = Object.keys(Stagehand).sort();\n    expect(actual).toStrictEqual(expected);\n  });\n\n  it(\"default export mirrors the named export surface\", () => {\n    const expected = Object.keys(Stagehand)\n      .filter((key) => key !== \"default\")\n      .sort();\n    const actual = Object.keys(StagehandDefaultExport).sort();\n    expect(actual).toStrictEqual(expected);\n  });\n});\n"]}

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

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

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

@@ -0,0 +1,140 @@
+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();
+        });
+        it("extends LLMClient", () => {
+            expectTypeOf().toExtend();
+        });
+        it("constructor accepts model parameter", () => {
+            expectTypeOf().toEqualTypeOf();
+        });
+    });
+    describe("AVAILABLE_CUA_MODELS", () => {
+        const expectedModels = [
+            "openai/computer-use-preview",
+            "openai/computer-use-preview-2025-03-11",
+            "anthropic/claude-opus-4-5-20251101",
+            "anthropic/claude-opus-4-6",
+            "anthropic/claude-sonnet-4-6",
+            "anthropic/claude-haiku-4-5-20251001",
+            "anthropic/claude-sonnet-4-20250514",
+            "anthropic/claude-sonnet-4-5-20250929",
+            "google/gemini-2.5-computer-use-preview-10-2025",
+            "google/gemini-3-flash-preview",
+            "google/gemini-3-pro-preview",
+            "microsoft/fara-7b",
+        ];
+        it("AvailableCuaModel matches the known literals", () => {
+            expectTypeOf().toEqualTypeOf();
+            void expectedModels; // Mark as used to satisfy ESLint
+        });
+    });
+    describe("AgentProvider", () => {
+        it("is exported", () => {
+            expect(Stagehand.AgentProvider).toBeDefined();
+        });
+        it("has getClient method", () => {
+            expectTypeOf().toBeCallableWith("test-model");
+        });
+        it("constructor accepts logger parameter", () => {
+            expectTypeOf().toEqualTypeOf();
+        });
+    });
+    describe("AnnotatedScreenshotText", () => {
+        it("is a string literal", () => {
+            expectTypeOf().toExtend();
+        });
+    });
+    describe("ConsoleMessage", () => {
+        it("has correct public interface shape", () => {
+            expectTypeOf().toExtend();
+        });
+    });
+    describe("AgentClient", () => {
+        it("getClient returns object with expected methods", () => {
+            expectTypeOf().toExtend();
+        });
+    });
+    describe("LLMClient", () => {
+        it("has correct public interface shape", () => {
+            expectTypeOf().toExtend();
+        });
+        it("constructor parameters match expected signature", () => {
+            expectTypeOf().toEqualTypeOf();
+        });
+        it("createChatCompletion can be called with basic options", () => {
+            expectTypeOf().toBeCallableWith({
+                options: {
+                    messages: [
+                        {
+                            role: "user",
+                            content: "Hello",
+                        },
+                    ],
+                },
+                logger: () => { },
+            });
+        });
+        it("createChatCompletion can be called with response_model", () => {
+            const mockSchema = {};
+            expectTypeOf().toBeCallableWith({
+                options: {
+                    messages: [
+                        {
+                            role: "user",
+                            content: "Extract data",
+                        },
+                    ],
+                    response_model: {
+                        name: "extracted",
+                        schema: mockSchema,
+                    },
+                },
+                logger: () => { },
+            });
+        });
+        it("createChatCompletion supports generic return type", () => {
+            expectTypeOf().toExtend();
+        });
+        it("has additional methods", () => {
+            // These methods exist on LLMClient but have complex signatures from the 'ai' library
+            // We verify they exist by checking they're functions
+            expectTypeOf().toExtend();
+            expectTypeOf().toExtend();
+            expectTypeOf().toExtend();
+            expectTypeOf().toExtend();
+            expectTypeOf().toExtend();
+            expectTypeOf().toExtend();
+            expectTypeOf().toExtend();
+            expectTypeOf().toExtend();
+            expectTypeOf().toExtend();
+        });
+    });
+    describe("modelToAgentProviderMap", () => {
+        it("only stores valid provider types", () => {
+            expectTypeOf().toExtend();
+        });
+    });
+    describe("Response", () => {
+        it("has correct public interface shape", () => {
+            expectTypeOf().toExtend();
+        });
+    });
+});
+//# sourceMappingURL=llm-and-agents.test.js.map

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

@@ -0,0 +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,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-error-types.test.d.ts

@@ -0,0 +1,62 @@
+import * as Stagehand from "@browserbasehq/stagehand";
+export declare const publicErrorTypes: {
+    readonly AgentAbortError: typeof Stagehand.AgentAbortError;
+    readonly CdpConnectionClosedError: typeof Stagehand.CdpConnectionClosedError;
+    readonly AgentScreenshotProviderError: typeof Stagehand.AgentScreenshotProviderError;
+    readonly BrowserbaseSessionNotFoundError: typeof Stagehand.BrowserbaseSessionNotFoundError;
+    readonly CaptchaTimeoutError: typeof Stagehand.CaptchaTimeoutError;
+    readonly ConnectionTimeoutError: typeof Stagehand.ConnectionTimeoutError;
+    readonly ContentFrameNotFoundError: typeof Stagehand.ContentFrameNotFoundError;
+    readonly CookieSetError: typeof Stagehand.CookieSetError;
+    readonly CookieValidationError: typeof Stagehand.CookieValidationError;
+    readonly CreateChatCompletionResponseError: typeof Stagehand.CreateChatCompletionResponseError;
+    readonly CuaModelRequiredError: typeof Stagehand.CuaModelRequiredError;
+    readonly ElementNotVisibleError: typeof Stagehand.ElementNotVisibleError;
+    readonly ExperimentalApiConflictError: typeof Stagehand.ExperimentalApiConflictError;
+    readonly ExperimentalNotConfiguredError: typeof Stagehand.ExperimentalNotConfiguredError;
+    readonly HandlerNotInitializedError: typeof Stagehand.HandlerNotInitializedError;
+    readonly InvalidAISDKModelFormatError: typeof Stagehand.InvalidAISDKModelFormatError;
+    readonly LLMResponseError: typeof Stagehand.LLMResponseError;
+    readonly MCPConnectionError: typeof Stagehand.MCPConnectionError;
+    readonly MissingEnvironmentVariableError: typeof Stagehand.MissingEnvironmentVariableError;
+    readonly MissingLLMConfigurationError: typeof Stagehand.MissingLLMConfigurationError;
+    readonly PageNotFoundError: typeof Stagehand.PageNotFoundError;
+    readonly ResponseBodyError: typeof Stagehand.ResponseBodyError;
+    readonly ResponseParseError: typeof Stagehand.ResponseParseError;
+    readonly StagehandAPIError: typeof Stagehand.StagehandAPIError;
+    readonly StagehandAPIUnauthorizedError: typeof Stagehand.StagehandAPIUnauthorizedError;
+    readonly StagehandClickError: typeof Stagehand.StagehandClickError;
+    readonly StagehandClosedError: typeof Stagehand.StagehandClosedError;
+    readonly StagehandDefaultError: typeof Stagehand.StagehandDefaultError;
+    readonly StagehandDomProcessError: typeof Stagehand.StagehandDomProcessError;
+    readonly StagehandElementNotFoundError: typeof Stagehand.StagehandElementNotFoundError;
+    readonly StagehandEnvironmentError: typeof Stagehand.StagehandEnvironmentError;
+    readonly StagehandError: typeof Stagehand.StagehandError;
+    readonly StagehandEvalError: typeof Stagehand.StagehandEvalError;
+    readonly StagehandHttpError: typeof Stagehand.StagehandHttpError;
+    readonly StagehandIframeError: typeof Stagehand.StagehandIframeError;
+    readonly StagehandInitError: typeof Stagehand.StagehandInitError;
+    readonly StagehandInvalidArgumentError: typeof Stagehand.StagehandInvalidArgumentError;
+    readonly StagehandLocatorError: typeof Stagehand.StagehandLocatorError;
+    readonly StagehandMissingArgumentError: typeof Stagehand.StagehandMissingArgumentError;
+    readonly StagehandNotInitializedError: typeof Stagehand.StagehandNotInitializedError;
+    readonly StagehandResponseBodyError: typeof Stagehand.StagehandResponseBodyError;
+    readonly StagehandResponseParseError: typeof Stagehand.StagehandResponseParseError;
+    readonly StagehandServerError: typeof Stagehand.StagehandServerError;
+    readonly StagehandShadowRootMissingError: typeof Stagehand.StagehandShadowRootMissingError;
+    readonly StagehandShadowSegmentEmptyError: typeof Stagehand.StagehandShadowSegmentEmptyError;
+    readonly StagehandShadowSegmentNotFoundError: typeof Stagehand.StagehandShadowSegmentNotFoundError;
+    readonly StreamingCallbacksInNonStreamingModeError: typeof Stagehand.StreamingCallbacksInNonStreamingModeError;
+    readonly StagehandSnapshotError: typeof Stagehand.StagehandSnapshotError;
+    readonly TimeoutError: typeof Stagehand.TimeoutError;
+    readonly UnsupportedAISDKModelProviderError: typeof Stagehand.UnsupportedAISDKModelProviderError;
+    readonly UnsupportedModelError: typeof Stagehand.UnsupportedModelError;
+    readonly UnsupportedModelProviderError: typeof Stagehand.UnsupportedModelProviderError;
+    readonly XPathResolutionError: typeof Stagehand.XPathResolutionError;
+    readonly ZodSchemaValidationError: typeof Stagehand.ZodSchemaValidationError;
+    readonly ActTimeoutError: typeof Stagehand.ActTimeoutError;
+    readonly ObserveTimeoutError: typeof Stagehand.ObserveTimeoutError;
+    readonly ExtractTimeoutError: typeof Stagehand.ExtractTimeoutError;
+    readonly UnderstudyCommandException: typeof Stagehand.UnderstudyCommandException;
+    readonly StagehandSetExtraHTTPHeadersError: typeof Stagehand.StagehandSetExtraHTTPHeadersError;
+};

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

@@ -0,0 +1,74 @@
+import { describe, expectTypeOf, it } from "vitest";
+import * as Stagehand from "@browserbasehq/stagehand";
+export const publicErrorTypes = {
+    AgentAbortError: Stagehand.AgentAbortError,
+    CdpConnectionClosedError: Stagehand.CdpConnectionClosedError,
+    AgentScreenshotProviderError: Stagehand.AgentScreenshotProviderError,
+    BrowserbaseSessionNotFoundError: Stagehand.BrowserbaseSessionNotFoundError,
+    CaptchaTimeoutError: Stagehand.CaptchaTimeoutError,
+    ConnectionTimeoutError: Stagehand.ConnectionTimeoutError,
+    ContentFrameNotFoundError: Stagehand.ContentFrameNotFoundError,
+    CookieSetError: Stagehand.CookieSetError,
+    CookieValidationError: Stagehand.CookieValidationError,
+    CreateChatCompletionResponseError: Stagehand.CreateChatCompletionResponseError,
+    CuaModelRequiredError: Stagehand.CuaModelRequiredError,
+    ElementNotVisibleError: Stagehand.ElementNotVisibleError,
+    ExperimentalApiConflictError: Stagehand.ExperimentalApiConflictError,
+    ExperimentalNotConfiguredError: Stagehand.ExperimentalNotConfiguredError,
+    HandlerNotInitializedError: Stagehand.HandlerNotInitializedError,
+    InvalidAISDKModelFormatError: Stagehand.InvalidAISDKModelFormatError,
+    LLMResponseError: Stagehand.LLMResponseError,
+    MCPConnectionError: Stagehand.MCPConnectionError,
+    MissingEnvironmentVariableError: Stagehand.MissingEnvironmentVariableError,
+    MissingLLMConfigurationError: Stagehand.MissingLLMConfigurationError,
+    PageNotFoundError: Stagehand.PageNotFoundError,
+    ResponseBodyError: Stagehand.ResponseBodyError,
+    ResponseParseError: Stagehand.ResponseParseError,
+    StagehandAPIError: Stagehand.StagehandAPIError,
+    StagehandAPIUnauthorizedError: Stagehand.StagehandAPIUnauthorizedError,
+    StagehandClickError: Stagehand.StagehandClickError,
+    StagehandClosedError: Stagehand.StagehandClosedError,
+    StagehandDefaultError: Stagehand.StagehandDefaultError,
+    StagehandDomProcessError: Stagehand.StagehandDomProcessError,
+    StagehandElementNotFoundError: Stagehand.StagehandElementNotFoundError,
+    StagehandEnvironmentError: Stagehand.StagehandEnvironmentError,
+    StagehandError: Stagehand.StagehandError,
+    StagehandEvalError: Stagehand.StagehandEvalError,
+    StagehandHttpError: Stagehand.StagehandHttpError,
+    StagehandIframeError: Stagehand.StagehandIframeError,
+    StagehandInitError: Stagehand.StagehandInitError,
+    StagehandInvalidArgumentError: Stagehand.StagehandInvalidArgumentError,
+    StagehandLocatorError: Stagehand.StagehandLocatorError,
+    StagehandMissingArgumentError: Stagehand.StagehandMissingArgumentError,
+    StagehandNotInitializedError: Stagehand.StagehandNotInitializedError,
+    StagehandResponseBodyError: Stagehand.StagehandResponseBodyError,
+    StagehandResponseParseError: Stagehand.StagehandResponseParseError,
+    StagehandServerError: Stagehand.StagehandServerError,
+    StagehandShadowRootMissingError: Stagehand.StagehandShadowRootMissingError,
+    StagehandShadowSegmentEmptyError: Stagehand.StagehandShadowSegmentEmptyError,
+    StagehandShadowSegmentNotFoundError: Stagehand.StagehandShadowSegmentNotFoundError,
+    StreamingCallbacksInNonStreamingModeError: Stagehand.StreamingCallbacksInNonStreamingModeError,
+    StagehandSnapshotError: Stagehand.StagehandSnapshotError,
+    TimeoutError: Stagehand.TimeoutError,
+    UnsupportedAISDKModelProviderError: Stagehand.UnsupportedAISDKModelProviderError,
+    UnsupportedModelError: Stagehand.UnsupportedModelError,
+    UnsupportedModelProviderError: Stagehand.UnsupportedModelProviderError,
+    XPathResolutionError: Stagehand.XPathResolutionError,
+    ZodSchemaValidationError: Stagehand.ZodSchemaValidationError,
+    ActTimeoutError: Stagehand.ActTimeoutError,
+    ObserveTimeoutError: Stagehand.ObserveTimeoutError,
+    ExtractTimeoutError: Stagehand.ExtractTimeoutError,
+    UnderstudyCommandException: Stagehand.UnderstudyCommandException,
+    StagehandSetExtraHTTPHeadersError: Stagehand.StagehandSetExtraHTTPHeadersError,
+};
+const errorTypes = Object.keys(publicErrorTypes);
+describe("Stagehand public error types", () => {
+    describe("errors", () => {
+        it.each(errorTypes)("%s extends Error", (errorTypeName) => {
+            const ErrorClass = Stagehand[errorTypeName];
+            expectTypeOf().toExtend();
+            void ErrorClass; // Mark as used to satisfy ESLint
+        });
+    });
+});
+//# sourceMappingURL=public-error-types.test.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"public-error-types.test.js","sourceRoot":"","sources":["../../../../../tests/unit/public-api/public-error-types.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,YAAY,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AACpD,OAAO,KAAK,SAAS,MAAM,0BAA0B,CAAC;AAEtD,MAAM,CAAC,MAAM,gBAAgB,GAAG;IAC9B,eAAe,EAAE,SAAS,CAAC,eAAe;IAC1C,wBAAwB,EAAE,SAAS,CAAC,wBAAwB;IAC5D,4BAA4B,EAAE,SAAS,CAAC,4BAA4B;IACpE,+BAA+B,EAAE,SAAS,CAAC,+BAA+B;IAC1E,mBAAmB,EAAE,SAAS,CAAC,mBAAmB;IAClD,sBAAsB,EAAE,SAAS,CAAC,sBAAsB;IACxD,yBAAyB,EAAE,SAAS,CAAC,yBAAyB;IAC9D,cAAc,EAAE,SAAS,CAAC,cAAc;IACxC,qBAAqB,EAAE,SAAS,CAAC,qBAAqB;IACtD,iCAAiC,EAC/B,SAAS,CAAC,iCAAiC;IAC7C,qBAAqB,EAAE,SAAS,CAAC,qBAAqB;IACtD,sBAAsB,EAAE,SAAS,CAAC,sBAAsB;IACxD,4BAA4B,EAAE,SAAS,CAAC,4BAA4B;IACpE,8BAA8B,EAAE,SAAS,CAAC,8BAA8B;IACxE,0BAA0B,EAAE,SAAS,CAAC,0BAA0B;IAChE,4BAA4B,EAAE,SAAS,CAAC,4BAA4B;IACpE,gBAAgB,EAAE,SAAS,CAAC,gBAAgB;IAC5C,kBAAkB,EAAE,SAAS,CAAC,kBAAkB;IAChD,+BAA+B,EAAE,SAAS,CAAC,+BAA+B;IAC1E,4BAA4B,EAAE,SAAS,CAAC,4BAA4B;IACpE,iBAAiB,EAAE,SAAS,CAAC,iBAAiB;IAC9C,iBAAiB,EAAE,SAAS,CAAC,iBAAiB;IAC9C,kBAAkB,EAAE,SAAS,CAAC,kBAAkB;IAChD,iBAAiB,EAAE,SAAS,CAAC,iBAAiB;IAC9C,6BAA6B,EAAE,SAAS,CAAC,6BAA6B;IACtE,mBAAmB,EAAE,SAAS,CAAC,mBAAmB;IAClD,oBAAoB,EAAE,SAAS,CAAC,oBAAoB;IACpD,qBAAqB,EAAE,SAAS,CAAC,qBAAqB;IACtD,wBAAwB,EAAE,SAAS,CAAC,wBAAwB;IAC5D,6BAA6B,EAAE,SAAS,CAAC,6BAA6B;IACtE,yBAAyB,EAAE,SAAS,CAAC,yBAAyB;IAC9D,cAAc,EAAE,SAAS,CAAC,cAAc;IACxC,kBAAkB,EAAE,SAAS,CAAC,kBAAkB;IAChD,kBAAkB,EAAE,SAAS,CAAC,kBAAkB;IAChD,oBAAoB,EAAE,SAAS,CAAC,oBAAoB;IACpD,kBAAkB,EAAE,SAAS,CAAC,kBAAkB;IAChD,6BAA6B,EAAE,SAAS,CAAC,6BAA6B;IACtE,qBAAqB,EAAE,SAAS,CAAC,qBAAqB;IACtD,6BAA6B,EAAE,SAAS,CAAC,6BAA6B;IACtE,4BAA4B,EAAE,SAAS,CAAC,4BAA4B;IACpE,0BAA0B,EAAE,SAAS,CAAC,0BAA0B;IAChE,2BAA2B,EAAE,SAAS,CAAC,2BAA2B;IAClE,oBAAoB,EAAE,SAAS,CAAC,oBAAoB;IACpD,+BAA+B,EAAE,SAAS,CAAC,+BAA+B;IAC1E,gCAAgC,EAAE,SAAS,CAAC,gCAAgC;IAC5E,mCAAmC,EACjC,SAAS,CAAC,mCAAmC;IAC/C,yCAAyC,EACvC,SAAS,CAAC,yCAAyC;IACrD,sBAAsB,EAAE,SAAS,CAAC,sBAAsB;IACxD,YAAY,EAAE,SAAS,CAAC,YAAY;IACpC,kCAAkC,EAChC,SAAS,CAAC,kCAAkC;IAC9C,qBAAqB,EAAE,SAAS,CAAC,qBAAqB;IACtD,6BAA6B,EAAE,SAAS,CAAC,6BAA6B;IACtE,oBAAoB,EAAE,SAAS,CAAC,oBAAoB;IACpD,wBAAwB,EAAE,SAAS,CAAC,wBAAwB;IAC5D,eAAe,EAAE,SAAS,CAAC,eAAe;IAC1C,mBAAmB,EAAE,SAAS,CAAC,mBAAmB;IAClD,mBAAmB,EAAE,SAAS,CAAC,mBAAmB;IAClD,0BAA0B,EAAE,SAAS,CAAC,0BAA0B;IAChE,iCAAiC,EAC/B,SAAS,CAAC,iCAAiC;CACrC,CAAC;AAEX,MAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAE9C,CAAC;AAEF,QAAQ,CAAC,8BAA8B,EAAE,GAAG,EAAE;IAC5C,QAAQ,CAAC,QAAQ,EAAE,GAAG,EAAE;QACtB,EAAE,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,kBAAkB,EAAE,CAAC,aAAa,EAAE,EAAE;YACxD,MAAM,UAAU,GAAG,SAAS,CAAC,aAAa,CAAC,CAAC;YAE5C,YAAY,EAAgC,CAAC,QAAQ,EAAS,CAAC;YAC/D,KAAK,UAAU,CAAC,CAAC,iCAAiC;QACpD,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\nexport const publicErrorTypes = {\n  AgentAbortError: Stagehand.AgentAbortError,\n  CdpConnectionClosedError: Stagehand.CdpConnectionClosedError,\n  AgentScreenshotProviderError: Stagehand.AgentScreenshotProviderError,\n  BrowserbaseSessionNotFoundError: Stagehand.BrowserbaseSessionNotFoundError,\n  CaptchaTimeoutError: Stagehand.CaptchaTimeoutError,\n  ConnectionTimeoutError: Stagehand.ConnectionTimeoutError,\n  ContentFrameNotFoundError: Stagehand.ContentFrameNotFoundError,\n  CookieSetError: Stagehand.CookieSetError,\n  CookieValidationError: Stagehand.CookieValidationError,\n  CreateChatCompletionResponseError:\n    Stagehand.CreateChatCompletionResponseError,\n  CuaModelRequiredError: Stagehand.CuaModelRequiredError,\n  ElementNotVisibleError: Stagehand.ElementNotVisibleError,\n  ExperimentalApiConflictError: Stagehand.ExperimentalApiConflictError,\n  ExperimentalNotConfiguredError: Stagehand.ExperimentalNotConfiguredError,\n  HandlerNotInitializedError: Stagehand.HandlerNotInitializedError,\n  InvalidAISDKModelFormatError: Stagehand.InvalidAISDKModelFormatError,\n  LLMResponseError: Stagehand.LLMResponseError,\n  MCPConnectionError: Stagehand.MCPConnectionError,\n  MissingEnvironmentVariableError: Stagehand.MissingEnvironmentVariableError,\n  MissingLLMConfigurationError: Stagehand.MissingLLMConfigurationError,\n  PageNotFoundError: Stagehand.PageNotFoundError,\n  ResponseBodyError: Stagehand.ResponseBodyError,\n  ResponseParseError: Stagehand.ResponseParseError,\n  StagehandAPIError: Stagehand.StagehandAPIError,\n  StagehandAPIUnauthorizedError: Stagehand.StagehandAPIUnauthorizedError,\n  StagehandClickError: Stagehand.StagehandClickError,\n  StagehandClosedError: Stagehand.StagehandClosedError,\n  StagehandDefaultError: Stagehand.StagehandDefaultError,\n  StagehandDomProcessError: Stagehand.StagehandDomProcessError,\n  StagehandElementNotFoundError: Stagehand.StagehandElementNotFoundError,\n  StagehandEnvironmentError: Stagehand.StagehandEnvironmentError,\n  StagehandError: Stagehand.StagehandError,\n  StagehandEvalError: Stagehand.StagehandEvalError,\n  StagehandHttpError: Stagehand.StagehandHttpError,\n  StagehandIframeError: Stagehand.StagehandIframeError,\n  StagehandInitError: Stagehand.StagehandInitError,\n  StagehandInvalidArgumentError: Stagehand.StagehandInvalidArgumentError,\n  StagehandLocatorError: Stagehand.StagehandLocatorError,\n  StagehandMissingArgumentError: Stagehand.StagehandMissingArgumentError,\n  StagehandNotInitializedError: Stagehand.StagehandNotInitializedError,\n  StagehandResponseBodyError: Stagehand.StagehandResponseBodyError,\n  StagehandResponseParseError: Stagehand.StagehandResponseParseError,\n  StagehandServerError: Stagehand.StagehandServerError,\n  StagehandShadowRootMissingError: Stagehand.StagehandShadowRootMissingError,\n  StagehandShadowSegmentEmptyError: Stagehand.StagehandShadowSegmentEmptyError,\n  StagehandShadowSegmentNotFoundError:\n    Stagehand.StagehandShadowSegmentNotFoundError,\n  StreamingCallbacksInNonStreamingModeError:\n    Stagehand.StreamingCallbacksInNonStreamingModeError,\n  StagehandSnapshotError: Stagehand.StagehandSnapshotError,\n  TimeoutError: Stagehand.TimeoutError,\n  UnsupportedAISDKModelProviderError:\n    Stagehand.UnsupportedAISDKModelProviderError,\n  UnsupportedModelError: Stagehand.UnsupportedModelError,\n  UnsupportedModelProviderError: Stagehand.UnsupportedModelProviderError,\n  XPathResolutionError: Stagehand.XPathResolutionError,\n  ZodSchemaValidationError: Stagehand.ZodSchemaValidationError,\n  ActTimeoutError: Stagehand.ActTimeoutError,\n  ObserveTimeoutError: Stagehand.ObserveTimeoutError,\n  ExtractTimeoutError: Stagehand.ExtractTimeoutError,\n  UnderstudyCommandException: Stagehand.UnderstudyCommandException,\n  StagehandSetExtraHTTPHeadersError:\n    Stagehand.StagehandSetExtraHTTPHeadersError,\n} as const;\n\nconst errorTypes = Object.keys(publicErrorTypes) as Array<\n  keyof typeof publicErrorTypes\n>;\n\ndescribe(\"Stagehand public error types\", () => {\n  describe(\"errors\", () => {\n    it.each(errorTypes)(\"%s extends Error\", (errorTypeName) => {\n      const ErrorClass = Stagehand[errorTypeName];\n      type ErrorClassType = typeof ErrorClass;\n      expectTypeOf<InstanceType<ErrorClassType>>().toExtend<Error>();\n      void ErrorClass; // Mark as used to satisfy ESLint\n    });\n  });\n});\n"]}

package/dist/esm/tests/unit/public-api/public-types.test.d.ts

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