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

package/dist/esm/tests/unit/llm-provider.test.js

@@ -0,0 +1,62 @@
+import { describe, expect, it } from "vitest";
+import { getAISDKLanguageModel } from "../../lib/v3/llm/LLMProvider.js";
+describe("getAISDKLanguageModel", () => {
+    describe("ollama provider", () => {
+        it("works without clientOptions", () => {
+            const model = getAISDKLanguageModel("ollama", "llama3.2");
+            expect(model).toBeDefined();
+        });
+        it("works with empty clientOptions", () => {
+            const model = getAISDKLanguageModel("ollama", "llama3.2", {});
+            expect(model).toBeDefined();
+        });
+        it("works with clientOptions containing only undefined values", () => {
+            const model = getAISDKLanguageModel("ollama", "llama3.2", {
+                apiKey: undefined,
+            });
+            expect(model).toBeDefined();
+        });
+        it("works with clientOptions containing only null values", () => {
+            const model = getAISDKLanguageModel("ollama", "llama3.2", {
+                apiKey: null,
+            });
+            expect(model).toBeDefined();
+        });
+        it("works with custom baseURL", () => {
+            const model = getAISDKLanguageModel("ollama", "llama3.2", {
+                baseURL: "http://custom-ollama:11434",
+            });
+            expect(model).toBeDefined();
+        });
+        it("works even when apiKey is mistakenly provided", () => {
+            // Ollama doesn't need an API key, but users might set one anyway
+            const model = getAISDKLanguageModel("ollama", "llama3.2", {
+                apiKey: "unnecessary-key",
+            });
+            expect(model).toBeDefined();
+        });
+    });
+    describe("providers with API keys", () => {
+        it("openai requires valid clientOptions for custom configuration", () => {
+            // Without clientOptions, uses default provider
+            const defaultModel = getAISDKLanguageModel("openai", "gpt-4o");
+            expect(defaultModel).toBeDefined();
+            // With valid apiKey, uses custom provider
+            const customModel = getAISDKLanguageModel("openai", "gpt-4o", {
+                apiKey: "test-key",
+            });
+            expect(customModel).toBeDefined();
+        });
+    });
+    describe("hasValidOptions logic", () => {
+        it("treats undefined apiKey as no options", () => {
+            // This should use the default provider path (AISDKProviders)
+            // not the custom provider path (AISDKProvidersWithAPIKey)
+            const model = getAISDKLanguageModel("ollama", "llama3.2", {
+                apiKey: undefined,
+            });
+            expect(model).toBeDefined();
+        });
+    });
+});
+//# sourceMappingURL=llm-provider.test.js.map

package/dist/esm/tests/unit/llm-provider.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"llm-provider.test.js","sourceRoot":"","sources":["../../../../tests/unit/llm-provider.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,qBAAqB,EAAE,MAAM,iCAAiC,CAAC;AAExE,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;IACrC,QAAQ,CAAC,iBAAiB,EAAE,GAAG,EAAE;QAC/B,EAAE,CAAC,6BAA6B,EAAE,GAAG,EAAE;YACrC,MAAM,KAAK,GAAG,qBAAqB,CAAC,QAAQ,EAAE,UAAU,CAAC,CAAC;YAC1D,MAAM,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;YACxC,MAAM,KAAK,GAAG,qBAAqB,CAAC,QAAQ,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC;YAC9D,MAAM,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2DAA2D,EAAE,GAAG,EAAE;YACnE,MAAM,KAAK,GAAG,qBAAqB,CAAC,QAAQ,EAAE,UAAU,EAAE;gBACxD,MAAM,EAAE,SAAS;aAClB,CAAC,CAAC;YACH,MAAM,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,sDAAsD,EAAE,GAAG,EAAE;YAC9D,MAAM,KAAK,GAAG,qBAAqB,CAAC,QAAQ,EAAE,UAAU,EAAE;gBACxD,MAAM,EAAE,IAAyB;aAClC,CAAC,CAAC;YACH,MAAM,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2BAA2B,EAAE,GAAG,EAAE;YACnC,MAAM,KAAK,GAAG,qBAAqB,CAAC,QAAQ,EAAE,UAAU,EAAE;gBACxD,OAAO,EAAE,4BAA4B;aACtC,CAAC,CAAC;YACH,MAAM,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;YACvD,iEAAiE;YACjE,MAAM,KAAK,GAAG,qBAAqB,CAAC,QAAQ,EAAE,UAAU,EAAE;gBACxD,MAAM,EAAE,iBAAiB;aAC1B,CAAC,CAAC;YACH,MAAM,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,yBAAyB,EAAE,GAAG,EAAE;QACvC,EAAE,CAAC,8DAA8D,EAAE,GAAG,EAAE;YACtE,+CAA+C;YAC/C,MAAM,YAAY,GAAG,qBAAqB,CAAC,QAAQ,EAAE,QAAQ,CAAC,CAAC;YAC/D,MAAM,CAAC,YAAY,CAAC,CAAC,WAAW,EAAE,CAAC;YAEnC,0CAA0C;YAC1C,MAAM,WAAW,GAAG,qBAAqB,CAAC,QAAQ,EAAE,QAAQ,EAAE;gBAC5D,MAAM,EAAE,UAAU;aACnB,CAAC,CAAC;YACH,MAAM,CAAC,WAAW,CAAC,CAAC,WAAW,EAAE,CAAC;QACpC,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;QACrC,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;YAC/C,6DAA6D;YAC7D,0DAA0D;YAC1D,MAAM,KAAK,GAAG,qBAAqB,CAAC,QAAQ,EAAE,UAAU,EAAE;gBACxD,MAAM,EAAE,SAAS;aAClB,CAAC,CAAC;YACH,MAAM,CAAC,KAAK,CAAC,CAAC,WAAW,EAAE,CAAC;QAC9B,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { describe, expect, it } from \"vitest\";\nimport { getAISDKLanguageModel } from \"../../lib/v3/llm/LLMProvider.js\";\n\ndescribe(\"getAISDKLanguageModel\", () => {\n  describe(\"ollama provider\", () => {\n    it(\"works without clientOptions\", () => {\n      const model = getAISDKLanguageModel(\"ollama\", \"llama3.2\");\n      expect(model).toBeDefined();\n    });\n\n    it(\"works with empty clientOptions\", () => {\n      const model = getAISDKLanguageModel(\"ollama\", \"llama3.2\", {});\n      expect(model).toBeDefined();\n    });\n\n    it(\"works with clientOptions containing only undefined values\", () => {\n      const model = getAISDKLanguageModel(\"ollama\", \"llama3.2\", {\n        apiKey: undefined,\n      });\n      expect(model).toBeDefined();\n    });\n\n    it(\"works with clientOptions containing only null values\", () => {\n      const model = getAISDKLanguageModel(\"ollama\", \"llama3.2\", {\n        apiKey: null as unknown as string,\n      });\n      expect(model).toBeDefined();\n    });\n\n    it(\"works with custom baseURL\", () => {\n      const model = getAISDKLanguageModel(\"ollama\", \"llama3.2\", {\n        baseURL: \"http://custom-ollama:11434\",\n      });\n      expect(model).toBeDefined();\n    });\n\n    it(\"works even when apiKey is mistakenly provided\", () => {\n      // Ollama doesn't need an API key, but users might set one anyway\n      const model = getAISDKLanguageModel(\"ollama\", \"llama3.2\", {\n        apiKey: \"unnecessary-key\",\n      });\n      expect(model).toBeDefined();\n    });\n  });\n\n  describe(\"providers with API keys\", () => {\n    it(\"openai requires valid clientOptions for custom configuration\", () => {\n      // Without clientOptions, uses default provider\n      const defaultModel = getAISDKLanguageModel(\"openai\", \"gpt-4o\");\n      expect(defaultModel).toBeDefined();\n\n      // With valid apiKey, uses custom provider\n      const customModel = getAISDKLanguageModel(\"openai\", \"gpt-4o\", {\n        apiKey: \"test-key\",\n      });\n      expect(customModel).toBeDefined();\n    });\n  });\n\n  describe(\"hasValidOptions logic\", () => {\n    it(\"treats undefined apiKey as no options\", () => {\n      // This should use the default provider path (AISDKProviders)\n      // not the custom provider path (AISDKProvidersWithAPIKey)\n      const model = getAISDKLanguageModel(\"ollama\", \"llama3.2\", {\n        apiKey: undefined,\n      });\n      expect(model).toBeDefined();\n    });\n  });\n});\n"]}

package/dist/esm/tests/unit/model-deprecation.test.d.ts

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

package/dist/esm/tests/unit/model-deprecation.test.js

@@ -0,0 +1,140 @@
+import { describe, expect, it } from "vitest";
+import { LLMProvider } from "../../lib/v3/llm/LLMProvider.js";
+import { UnsupportedModelError, UnsupportedAISDKModelProviderError, } from "../../lib/v3/types/public/sdkErrors.js";
+// Mock client options with fake API keys for testing
+const mockClientOptions = { apiKey: "test-api-key-for-testing" };
+describe("Model format deprecation", () => {
+    describe("UnsupportedModelError", () => {
+        it("includes guidance to use provider/model format for unknown model names", () => {
+            const error = new UnsupportedModelError(["gpt-4o", "gemini-2.0-flash"]);
+            // Should mention the new format
+            expect(error.message).toContain("provider/model");
+            // Should include link to docs
+            expect(error.message).toContain("https://docs.stagehand.dev/v3/configuration/models");
+        });
+        it("includes example of provider/model format", () => {
+            const error = new UnsupportedModelError(["gpt-4o"]);
+            // Should provide examples like openai/gpt-4o
+            expect(error.message).toContain("openai/gpt-4o");
+            expect(error.message).toContain("anthropic/claude-sonnet-4");
+        });
+        it("works with feature parameter", () => {
+            const error = new UnsupportedModelError(["gpt-4o"], "extract");
+            expect(error.message).toContain("extract");
+            expect(error.message).toContain("provider/model");
+            expect(error.message).toContain("https://docs.stagehand.dev/v3/configuration/models");
+        });
+    });
+    describe("LLMProvider.getClient deprecation warning", () => {
+        it("logs deprecation warning for legacy model names", () => {
+            const logs = [];
+            const logger = (line) => logs.push(line);
+            const provider = new LLMProvider(logger);
+            // Using a legacy model name like "gpt-4o" instead of "openai/gpt-4o"
+            // Should not throw, but should log a deprecation warning
+            const client = provider.getClient("gpt-4o", mockClientOptions);
+            // Should return a client (not throw)
+            expect(client).toBeDefined();
+            // Should have logged a deprecation warning at level 0
+            const deprecationWarning = logs.find((log) => log.message.toLowerCase().includes("deprecated") ||
+                log.message.toLowerCase().includes("deprecation"));
+            expect(deprecationWarning).toBeDefined();
+            expect(deprecationWarning.level).toBe(0);
+        });
+        it("deprecation warning mentions provider/model format", () => {
+            const logs = [];
+            const logger = (line) => logs.push(line);
+            const provider = new LLMProvider(logger);
+            provider.getClient("gpt-4o", mockClientOptions);
+            const deprecationWarning = logs.find((log) => log.message.toLowerCase().includes("deprecated") ||
+                log.message.toLowerCase().includes("deprecation"));
+            expect(deprecationWarning).toBeDefined();
+            const message = deprecationWarning.message;
+            // Should mention the provider/model format
+            expect(message).toContain("provider/model");
+            // Should give an example
+            expect(message).toContain("openai/gpt-5");
+        });
+        it("returns OpenAIClient for legacy OpenAI model names", () => {
+            const logs = [];
+            const logger = (line) => logs.push(line);
+            const provider = new LLMProvider(logger);
+            const client = provider.getClient("gpt-4o", mockClientOptions);
+            // Should return a client
+            expect(client).toBeDefined();
+            // The client should be an OpenAIClient (check constructor name)
+            expect(client.constructor.name).toBe("OpenAIClient");
+        });
+        it("returns GoogleClient for legacy Google model names", () => {
+            const logs = [];
+            const logger = (line) => logs.push(line);
+            const provider = new LLMProvider(logger);
+            const client = provider.getClient("gemini-2.0-flash", mockClientOptions);
+            // Should return a client
+            expect(client).toBeDefined();
+            // The client should be a GoogleClient
+            expect(client.constructor.name).toBe("GoogleClient");
+        });
+    });
+    describe("LLMProvider.getClient error handling", () => {
+        it("throws UnsupportedModelError for unknown model without slash", () => {
+            const logs = [];
+            const logger = (line) => logs.push(line);
+            const provider = new LLMProvider(logger);
+            // Unknown model without slash should throw UnsupportedModelError
+            expect(() => {
+                provider.getClient("some-unknown-model", mockClientOptions);
+            }).toThrow(UnsupportedModelError);
+        });
+        it("UnsupportedModelError includes provider/model format guidance", () => {
+            const logs = [];
+            const logger = (line) => logs.push(line);
+            const provider = new LLMProvider(logger);
+            try {
+                provider.getClient("some-unknown-model", mockClientOptions);
+            }
+            catch (error) {
+                expect(error.message).toContain("provider/model");
+            }
+        });
+        it("throws UnsupportedAISDKModelProviderError for invalid provider in provider/model format", () => {
+            const logs = [];
+            const logger = (line) => logs.push(line);
+            const provider = new LLMProvider(logger);
+            // Invalid provider but correct format
+            expect(() => {
+                provider.getClient("invalid-provider/some-model", mockClientOptions);
+            }).toThrow(UnsupportedAISDKModelProviderError);
+        });
+        it("UnsupportedAISDKModelProviderError lists valid providers", () => {
+            const logs = [];
+            const logger = (line) => logs.push(line);
+            const provider = new LLMProvider(logger);
+            try {
+                provider.getClient("invalid-provider/some-model", mockClientOptions);
+            }
+            catch (error) {
+                const message = error.message;
+                // Should list valid providers
+                expect(message).toContain("openai");
+                expect(message).toContain("anthropic");
+                expect(message).toContain("google");
+            }
+        });
+    });
+    describe("new provider/model format", () => {
+        it("does not log deprecation warning for provider/model format", () => {
+            const logs = [];
+            const logger = (line) => logs.push(line);
+            const provider = new LLMProvider(logger);
+            // Using the new format
+            const client = provider.getClient("openai/gpt-4o", mockClientOptions);
+            expect(client).toBeDefined();
+            // Should NOT have a deprecation warning
+            const deprecationWarning = logs.find((log) => log.message.toLowerCase().includes("deprecated") ||
+                log.message.toLowerCase().includes("deprecation"));
+            expect(deprecationWarning).toBeUndefined();
+        });
+    });
+});
+//# sourceMappingURL=model-deprecation.test.js.map

package/dist/esm/tests/unit/model-deprecation.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"model-deprecation.test.js","sourceRoot":"","sources":["../../../../tests/unit/model-deprecation.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAC9D,OAAO,EACL,qBAAqB,EACrB,kCAAkC,GACnC,MAAM,wCAAwC,CAAC;AAGhD,qDAAqD;AACrD,MAAM,iBAAiB,GAAG,EAAE,MAAM,EAAE,0BAA0B,EAAE,CAAC;AAEjE,QAAQ,CAAC,0BAA0B,EAAE,GAAG,EAAE;IACxC,QAAQ,CAAC,uBAAuB,EAAE,GAAG,EAAE;QACrC,EAAE,CAAC,wEAAwE,EAAE,GAAG,EAAE;YAChF,MAAM,KAAK,GAAG,IAAI,qBAAqB,CAAC,CAAC,QAAQ,EAAE,kBAAkB,CAAC,CAAC,CAAC;YAExE,gCAAgC;YAChC,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;YAClD,8BAA8B;YAC9B,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,SAAS,CAC7B,oDAAoD,CACrD,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,2CAA2C,EAAE,GAAG,EAAE;YACnD,MAAM,KAAK,GAAG,IAAI,qBAAqB,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC;YAEpD,6CAA6C;YAC7C,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;YACjD,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,2BAA2B,CAAC,CAAC;QAC/D,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,8BAA8B,EAAE,GAAG,EAAE;YACtC,MAAM,KAAK,GAAG,IAAI,qBAAqB,CAAC,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,CAAC;YAE/D,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;YAC3C,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;YAClD,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,SAAS,CAC7B,oDAAoD,CACrD,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,2CAA2C,EAAE,GAAG,EAAE;QACzD,EAAE,CAAC,iDAAiD,EAAE,GAAG,EAAE;YACzD,MAAM,IAAI,GAAc,EAAE,CAAC;YAC3B,MAAM,MAAM,GAAG,CAAC,IAAa,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAClD,MAAM,QAAQ,GAAG,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;YAEzC,qEAAqE;YACrE,yDAAyD;YACzD,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;YAE/D,qCAAqC;YACrC,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;YAE7B,sDAAsD;YACtD,MAAM,kBAAkB,GAAG,IAAI,CAAC,IAAI,CAClC,CAAC,GAAG,EAAE,EAAE,CACN,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC;gBAChD,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,CACpD,CAAC;YACF,MAAM,CAAC,kBAAkB,CAAC,CAAC,WAAW,EAAE,CAAC;YACzC,MAAM,CAAC,kBAAmB,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;YAC5D,MAAM,IAAI,GAAc,EAAE,CAAC;YAC3B,MAAM,MAAM,GAAG,CAAC,IAAa,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAClD,MAAM,QAAQ,GAAG,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;YAEzC,QAAQ,CAAC,SAAS,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;YAEhD,MAAM,kBAAkB,GAAG,IAAI,CAAC,IAAI,CAClC,CAAC,GAAG,EAAE,EAAE,CACN,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC;gBAChD,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,CACpD,CAAC;YAEF,MAAM,CAAC,kBAAkB,CAAC,CAAC,WAAW,EAAE,CAAC;YACzC,MAAM,OAAO,GAAG,kBAAmB,CAAC,OAAO,CAAC;YAC5C,2CAA2C;YAC3C,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;YAC5C,yBAAyB;YACzB,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;QAC5C,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;YAC5D,MAAM,IAAI,GAAc,EAAE,CAAC;YAC3B,MAAM,MAAM,GAAG,CAAC,IAAa,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAClD,MAAM,QAAQ,GAAG,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;YAEzC,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,CAAC,QAAQ,EAAE,iBAAiB,CAAC,CAAC;YAE/D,yBAAyB;YACzB,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;YAC7B,gEAAgE;YAChE,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,oDAAoD,EAAE,GAAG,EAAE;YAC5D,MAAM,IAAI,GAAc,EAAE,CAAC;YAC3B,MAAM,MAAM,GAAG,CAAC,IAAa,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAClD,MAAM,QAAQ,GAAG,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;YAEzC,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,CAAC,kBAAkB,EAAE,iBAAiB,CAAC,CAAC;YAEzE,yBAAyB;YACzB,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;YAC7B,sCAAsC;YACtC,MAAM,CAAC,MAAM,CAAC,WAAW,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,sCAAsC,EAAE,GAAG,EAAE;QACpD,EAAE,CAAC,8DAA8D,EAAE,GAAG,EAAE;YACtE,MAAM,IAAI,GAAc,EAAE,CAAC;YAC3B,MAAM,MAAM,GAAG,CAAC,IAAa,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAClD,MAAM,QAAQ,GAAG,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;YAEzC,iEAAiE;YACjE,MAAM,CAAC,GAAG,EAAE;gBACV,QAAQ,CAAC,SAAS,CAAC,oBAAoB,EAAE,iBAAiB,CAAC,CAAC;YAC9D,CAAC,CAAC,CAAC,OAAO,CAAC,qBAAqB,CAAC,CAAC;QACpC,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,+DAA+D,EAAE,GAAG,EAAE;YACvE,MAAM,IAAI,GAAc,EAAE,CAAC;YAC3B,MAAM,MAAM,GAAG,CAAC,IAAa,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAClD,MAAM,QAAQ,GAAG,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;YAEzC,IAAI,CAAC;gBACH,QAAQ,CAAC,SAAS,CAAC,oBAAoB,EAAE,iBAAiB,CAAC,CAAC;YAC9D,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,CAAE,KAAe,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;YAC/D,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,yFAAyF,EAAE,GAAG,EAAE;YACjG,MAAM,IAAI,GAAc,EAAE,CAAC;YAC3B,MAAM,MAAM,GAAG,CAAC,IAAa,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAClD,MAAM,QAAQ,GAAG,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;YAEzC,sCAAsC;YACtC,MAAM,CAAC,GAAG,EAAE;gBACV,QAAQ,CAAC,SAAS,CAAC,6BAA6B,EAAE,iBAAiB,CAAC,CAAC;YACvE,CAAC,CAAC,CAAC,OAAO,CAAC,kCAAkC,CAAC,CAAC;QACjD,CAAC,CAAC,CAAC;QAEH,EAAE,CAAC,0DAA0D,EAAE,GAAG,EAAE;YAClE,MAAM,IAAI,GAAc,EAAE,CAAC;YAC3B,MAAM,MAAM,GAAG,CAAC,IAAa,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAClD,MAAM,QAAQ,GAAG,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;YAEzC,IAAI,CAAC;gBACH,QAAQ,CAAC,SAAS,CAAC,6BAA6B,EAAE,iBAAiB,CAAC,CAAC;YACvE,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,MAAM,OAAO,GAAI,KAAe,CAAC,OAAO,CAAC;gBACzC,8BAA8B;gBAC9B,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;gBACpC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;gBACvC,MAAM,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;YACtC,CAAC;QACH,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,QAAQ,CAAC,2BAA2B,EAAE,GAAG,EAAE;QACzC,EAAE,CAAC,4DAA4D,EAAE,GAAG,EAAE;YACpE,MAAM,IAAI,GAAc,EAAE,CAAC;YAC3B,MAAM,MAAM,GAAG,CAAC,IAAa,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YAClD,MAAM,QAAQ,GAAG,IAAI,WAAW,CAAC,MAAM,CAAC,CAAC;YAEzC,uBAAuB;YACvB,MAAM,MAAM,GAAG,QAAQ,CAAC,SAAS,CAAC,eAAe,EAAE,iBAAiB,CAAC,CAAC;YAEtE,MAAM,CAAC,MAAM,CAAC,CAAC,WAAW,EAAE,CAAC;YAE7B,wCAAwC;YACxC,MAAM,kBAAkB,GAAG,IAAI,CAAC,IAAI,CAClC,CAAC,GAAG,EAAE,EAAE,CACN,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC;gBAChD,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,CACpD,CAAC;YACF,MAAM,CAAC,kBAAkB,CAAC,CAAC,aAAa,EAAE,CAAC;QAC7C,CAAC,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { describe, expect, it } from \"vitest\";\nimport { LLMProvider } from \"../../lib/v3/llm/LLMProvider.js\";\nimport {\n  UnsupportedModelError,\n  UnsupportedAISDKModelProviderError,\n} from \"../../lib/v3/types/public/sdkErrors.js\";\nimport type { LogLine } from \"../../lib/v3/types/public/logs.js\";\n\n// Mock client options with fake API keys for testing\nconst mockClientOptions = { apiKey: \"test-api-key-for-testing\" };\n\ndescribe(\"Model format deprecation\", () => {\n  describe(\"UnsupportedModelError\", () => {\n    it(\"includes guidance to use provider/model format for unknown model names\", () => {\n      const error = new UnsupportedModelError([\"gpt-4o\", \"gemini-2.0-flash\"]);\n\n      // Should mention the new format\n      expect(error.message).toContain(\"provider/model\");\n      // Should include link to docs\n      expect(error.message).toContain(\n        \"https://docs.stagehand.dev/v3/configuration/models\",\n      );\n    });\n\n    it(\"includes example of provider/model format\", () => {\n      const error = new UnsupportedModelError([\"gpt-4o\"]);\n\n      // Should provide examples like openai/gpt-4o\n      expect(error.message).toContain(\"openai/gpt-4o\");\n      expect(error.message).toContain(\"anthropic/claude-sonnet-4\");\n    });\n\n    it(\"works with feature parameter\", () => {\n      const error = new UnsupportedModelError([\"gpt-4o\"], \"extract\");\n\n      expect(error.message).toContain(\"extract\");\n      expect(error.message).toContain(\"provider/model\");\n      expect(error.message).toContain(\n        \"https://docs.stagehand.dev/v3/configuration/models\",\n      );\n    });\n  });\n\n  describe(\"LLMProvider.getClient deprecation warning\", () => {\n    it(\"logs deprecation warning for legacy model names\", () => {\n      const logs: LogLine[] = [];\n      const logger = (line: LogLine) => logs.push(line);\n      const provider = new LLMProvider(logger);\n\n      // Using a legacy model name like \"gpt-4o\" instead of \"openai/gpt-4o\"\n      // Should not throw, but should log a deprecation warning\n      const client = provider.getClient(\"gpt-4o\", mockClientOptions);\n\n      // Should return a client (not throw)\n      expect(client).toBeDefined();\n\n      // Should have logged a deprecation warning at level 0\n      const deprecationWarning = logs.find(\n        (log) =>\n          log.message.toLowerCase().includes(\"deprecated\") ||\n          log.message.toLowerCase().includes(\"deprecation\"),\n      );\n      expect(deprecationWarning).toBeDefined();\n      expect(deprecationWarning!.level).toBe(0);\n    });\n\n    it(\"deprecation warning mentions provider/model format\", () => {\n      const logs: LogLine[] = [];\n      const logger = (line: LogLine) => logs.push(line);\n      const provider = new LLMProvider(logger);\n\n      provider.getClient(\"gpt-4o\", mockClientOptions);\n\n      const deprecationWarning = logs.find(\n        (log) =>\n          log.message.toLowerCase().includes(\"deprecated\") ||\n          log.message.toLowerCase().includes(\"deprecation\"),\n      );\n\n      expect(deprecationWarning).toBeDefined();\n      const message = deprecationWarning!.message;\n      // Should mention the provider/model format\n      expect(message).toContain(\"provider/model\");\n      // Should give an example\n      expect(message).toContain(\"openai/gpt-5\");\n    });\n\n    it(\"returns OpenAIClient for legacy OpenAI model names\", () => {\n      const logs: LogLine[] = [];\n      const logger = (line: LogLine) => logs.push(line);\n      const provider = new LLMProvider(logger);\n\n      const client = provider.getClient(\"gpt-4o\", mockClientOptions);\n\n      // Should return a client\n      expect(client).toBeDefined();\n      // The client should be an OpenAIClient (check constructor name)\n      expect(client.constructor.name).toBe(\"OpenAIClient\");\n    });\n\n    it(\"returns GoogleClient for legacy Google model names\", () => {\n      const logs: LogLine[] = [];\n      const logger = (line: LogLine) => logs.push(line);\n      const provider = new LLMProvider(logger);\n\n      const client = provider.getClient(\"gemini-2.0-flash\", mockClientOptions);\n\n      // Should return a client\n      expect(client).toBeDefined();\n      // The client should be a GoogleClient\n      expect(client.constructor.name).toBe(\"GoogleClient\");\n    });\n  });\n\n  describe(\"LLMProvider.getClient error handling\", () => {\n    it(\"throws UnsupportedModelError for unknown model without slash\", () => {\n      const logs: LogLine[] = [];\n      const logger = (line: LogLine) => logs.push(line);\n      const provider = new LLMProvider(logger);\n\n      // Unknown model without slash should throw UnsupportedModelError\n      expect(() => {\n        provider.getClient(\"some-unknown-model\", mockClientOptions);\n      }).toThrow(UnsupportedModelError);\n    });\n\n    it(\"UnsupportedModelError includes provider/model format guidance\", () => {\n      const logs: LogLine[] = [];\n      const logger = (line: LogLine) => logs.push(line);\n      const provider = new LLMProvider(logger);\n\n      try {\n        provider.getClient(\"some-unknown-model\", mockClientOptions);\n      } catch (error) {\n        expect((error as Error).message).toContain(\"provider/model\");\n      }\n    });\n\n    it(\"throws UnsupportedAISDKModelProviderError for invalid provider in provider/model format\", () => {\n      const logs: LogLine[] = [];\n      const logger = (line: LogLine) => logs.push(line);\n      const provider = new LLMProvider(logger);\n\n      // Invalid provider but correct format\n      expect(() => {\n        provider.getClient(\"invalid-provider/some-model\", mockClientOptions);\n      }).toThrow(UnsupportedAISDKModelProviderError);\n    });\n\n    it(\"UnsupportedAISDKModelProviderError lists valid providers\", () => {\n      const logs: LogLine[] = [];\n      const logger = (line: LogLine) => logs.push(line);\n      const provider = new LLMProvider(logger);\n\n      try {\n        provider.getClient(\"invalid-provider/some-model\", mockClientOptions);\n      } catch (error) {\n        const message = (error as Error).message;\n        // Should list valid providers\n        expect(message).toContain(\"openai\");\n        expect(message).toContain(\"anthropic\");\n        expect(message).toContain(\"google\");\n      }\n    });\n  });\n\n  describe(\"new provider/model format\", () => {\n    it(\"does not log deprecation warning for provider/model format\", () => {\n      const logs: LogLine[] = [];\n      const logger = (line: LogLine) => logs.push(line);\n      const provider = new LLMProvider(logger);\n\n      // Using the new format\n      const client = provider.getClient(\"openai/gpt-4o\", mockClientOptions);\n\n      expect(client).toBeDefined();\n\n      // Should NOT have a deprecation warning\n      const deprecationWarning = logs.find(\n        (log) =>\n          log.message.toLowerCase().includes(\"deprecated\") ||\n          log.message.toLowerCase().includes(\"deprecation\"),\n      );\n      expect(deprecationWarning).toBeUndefined();\n    });\n  });\n});\n"]}

package/dist/esm/tests/unit/model-utils.test.d.ts

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

package/dist/esm/tests/unit/model-utils.test.js

@@ -0,0 +1,40 @@
+import { describe, expect, it } from "vitest";
+import { extractModelName, resolveModel } from "../../lib/modelUtils.js";
+describe("extractModelName", () => {
+    it("returns undefined for undefined input", () => {
+        expect(extractModelName(undefined)).toBeUndefined();
+    });
+    it("returns the string as-is for a string input", () => {
+        expect(extractModelName("openai/gpt-4o")).toBe("openai/gpt-4o");
+    });
+    it("returns modelName from an object input", () => {
+        expect(extractModelName({ modelName: "anthropic/claude-sonnet-4-20250514" })).toBe("anthropic/claude-sonnet-4-20250514");
+    });
+    it("returns modelName from an object with extra properties", () => {
+        expect(extractModelName({
+            modelName: "openai/gpt-4o-mini",
+            apiKey: "sk-test",
+            baseURL: "https://custom.endpoint",
+        })).toBe("openai/gpt-4o-mini");
+    });
+});
+describe("resolveModel", () => {
+    it("extracts provider and modelName from a string", () => {
+        const result = resolveModel("openai/gpt-4o");
+        expect(result.provider).toBe("openai");
+        expect(result.modelName).toBe("gpt-4o");
+        expect(result.clientOptions).toEqual({});
+    });
+    it("extracts clientOptions from an object config", () => {
+        const result = resolveModel({
+            modelName: "openai/gpt-4o",
+            apiKey: "sk-test",
+        });
+        expect(result.provider).toBe("openai");
+        expect(result.modelName).toBe("gpt-4o");
+        expect(result.clientOptions).toMatchObject({ apiKey: "sk-test" });
+        // modelName should not leak into clientOptions
+        expect(result.clientOptions).not.toHaveProperty("modelName");
+    });
+});
+//# sourceMappingURL=model-utils.test.js.map

package/dist/esm/tests/unit/model-utils.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"model-utils.test.js","sourceRoot":"","sources":["../../../../tests/unit/model-utils.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,QAAQ,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAEzE,QAAQ,CAAC,kBAAkB,EAAE,GAAG,EAAE;IAChC,EAAE,CAAC,uCAAuC,EAAE,GAAG,EAAE;QAC/C,MAAM,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC,CAAC,aAAa,EAAE,CAAC;IACtD,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,6CAA6C,EAAE,GAAG,EAAE;QACrD,MAAM,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wCAAwC,EAAE,GAAG,EAAE;QAChD,MAAM,CACJ,gBAAgB,CAAC,EAAE,SAAS,EAAE,oCAAoC,EAAE,CAAC,CACtE,CAAC,IAAI,CAAC,oCAAoC,CAAC,CAAC;IAC/C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAChE,MAAM,CACJ,gBAAgB,CAAC;YACf,SAAS,EAAE,oBAAoB;YAC/B,MAAM,EAAE,SAAS;YACjB,OAAO,EAAE,yBAAyB;SACnC,CAAC,CACH,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IAC/B,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,cAAc,EAAE,GAAG,EAAE;IAC5B,EAAE,CAAC,+CAA+C,EAAE,GAAG,EAAE;QACvD,MAAM,MAAM,GAAG,YAAY,CAAC,eAAe,CAAC,CAAC;QAC7C,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACxC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAC3C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,8CAA8C,EAAE,GAAG,EAAE;QACtD,MAAM,MAAM,GAAG,YAAY,CAAC;YAC1B,SAAS,EAAE,eAAwB;YACnC,MAAM,EAAE,SAAS;SAClB,CAAC,CAAC;QACH,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACxC,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,aAAa,CAAC,EAAE,MAAM,EAAE,SAAS,EAAE,CAAC,CAAC;QAClE,+CAA+C;QAC/C,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,CAAC,GAAG,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;IAC/D,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC","sourcesContent":["import { describe, expect, it } from \"vitest\";\nimport { extractModelName, resolveModel } from \"../../lib/modelUtils.js\";\n\ndescribe(\"extractModelName\", () => {\n  it(\"returns undefined for undefined input\", () => {\n    expect(extractModelName(undefined)).toBeUndefined();\n  });\n\n  it(\"returns the string as-is for a string input\", () => {\n    expect(extractModelName(\"openai/gpt-4o\")).toBe(\"openai/gpt-4o\");\n  });\n\n  it(\"returns modelName from an object input\", () => {\n    expect(\n      extractModelName({ modelName: \"anthropic/claude-sonnet-4-20250514\" }),\n    ).toBe(\"anthropic/claude-sonnet-4-20250514\");\n  });\n\n  it(\"returns modelName from an object with extra properties\", () => {\n    expect(\n      extractModelName({\n        modelName: \"openai/gpt-4o-mini\",\n        apiKey: \"sk-test\",\n        baseURL: \"https://custom.endpoint\",\n      }),\n    ).toBe(\"openai/gpt-4o-mini\");\n  });\n});\n\ndescribe(\"resolveModel\", () => {\n  it(\"extracts provider and modelName from a string\", () => {\n    const result = resolveModel(\"openai/gpt-4o\");\n    expect(result.provider).toBe(\"openai\");\n    expect(result.modelName).toBe(\"gpt-4o\");\n    expect(result.clientOptions).toEqual({});\n  });\n\n  it(\"extracts clientOptions from an object config\", () => {\n    const result = resolveModel({\n      modelName: \"openai/gpt-4o\" as never,\n      apiKey: \"sk-test\",\n    });\n    expect(result.provider).toBe(\"openai\");\n    expect(result.modelName).toBe(\"gpt-4o\");\n    expect(result.clientOptions).toMatchObject({ apiKey: \"sk-test\" });\n    // modelName should not leak into clientOptions\n    expect(result.clientOptions).not.toHaveProperty(\"modelName\");\n  });\n});\n"]}

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

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

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

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

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

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

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

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

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

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

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

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

package/dist/esm/tests/unit/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 {};