@browserbasehq/orca 3.0.9-alpha-3 → 3.1.0-patch.0

package/dist/esm/lib/v3/external_clients/aisdk.js

@@ -0,0 +1,103 @@
+import { generateObject, generateText, } from "ai";
+import { LLMClient } from "../llm/LLMClient.js";
+export class AISdkClient extends LLMClient {
+    type = "aisdk";
+    model;
+    constructor({ model }) {
+        super(model.modelId);
+        this.model = model;
+    }
+    async createChatCompletion({ options, }) {
+        const formattedMessages = options.messages.map((message) => {
+            if (Array.isArray(message.content)) {
+                if (message.role === "system") {
+                    const systemMessage = {
+                        role: "system",
+                        content: message.content
+                            .map((c) => ("text" in c ? c.text : ""))
+                            .join("\n"),
+                    };
+                    return systemMessage;
+                }
+                const contentParts = message.content.map((content) => {
+                    if ("image_url" in content) {
+                        const imageContent = {
+                            type: "image",
+                            image: content.image_url.url,
+                        };
+                        return imageContent;
+                    }
+                    else {
+                        const textContent = {
+                            type: "text",
+                            text: content.text,
+                        };
+                        return textContent;
+                    }
+                });
+                if (message.role === "user") {
+                    const userMessage = {
+                        role: "user",
+                        content: contentParts,
+                    };
+                    return userMessage;
+                }
+                else {
+                    const textOnlyParts = contentParts.map((part) => ({
+                        type: "text",
+                        text: part.type === "image" ? "[Image]" : part.text,
+                    }));
+                    const assistantMessage = {
+                        role: "assistant",
+                        content: textOnlyParts,
+                    };
+                    return assistantMessage;
+                }
+            }
+            return {
+                role: message.role,
+                content: message.content,
+            };
+        });
+        if (options.response_model) {
+            const response = await generateObject({
+                model: this.model,
+                messages: formattedMessages,
+                schema: options.response_model.schema,
+            });
+            return {
+                data: response.object,
+                usage: {
+                    prompt_tokens: response.usage.inputTokens ?? 0,
+                    completion_tokens: response.usage.outputTokens ?? 0,
+                    reasoning_tokens: response.usage.reasoningTokens ?? 0,
+                    cached_input_tokens: response.usage.cachedInputTokens ?? 0,
+                    total_tokens: response.usage.totalTokens ?? 0,
+                },
+            };
+        }
+        const tools = {};
+        for (const rawTool of options.tools) {
+            tools[rawTool.name] = {
+                description: rawTool.description,
+                inputSchema: rawTool.parameters,
+            };
+        }
+        const response = await generateText({
+            model: this.model,
+            messages: formattedMessages,
+            tools,
+        });
+        return {
+            data: response.text,
+            usage: {
+                prompt_tokens: response.usage.inputTokens ?? 0,
+                completion_tokens: response.usage.outputTokens ?? 0,
+                reasoning_tokens: response.usage.reasoningTokens ?? 0,
+                cached_input_tokens: response.usage.cachedInputTokens ?? 0,
+                total_tokens: response.usage.totalTokens ?? 0,
+            },
+        };
+    }
+}
+//# sourceMappingURL=aisdk.js.map

package/dist/esm/lib/v3/external_clients/aisdk.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"aisdk.js","sourceRoot":"","sources":["../../../../../lib/v3/external_clients/aisdk.ts"],"names":[],"mappings":"AAAA,OAAO,EAML,cAAc,EACd,YAAY,GAGb,MAAM,IAAI,CAAC;AAEZ,OAAO,EAA+B,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAI7E,MAAM,OAAO,WAAY,SAAQ,SAAS;IACjC,IAAI,GAAG,OAAgB,CAAC;IACvB,KAAK,CAAkB;IAE/B,YAAY,EAAE,KAAK,EAA8B;QAC/C,KAAK,CAAC,KAAK,CAAC,OAAyB,CAAC,CAAC;QACvC,IAAI,CAAC,KAAK,GAAG,KAAK,CAAC;IACrB,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAqB,EAC7C,OAAO,GACqB;QAC5B,MAAM,iBAAiB,GAAmB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAC5D,CAAC,OAAO,EAAE,EAAE;YACV,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;gBACnC,IAAI,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAC9B,MAAM,aAAa,GAAsB;wBACvC,IAAI,EAAE,QAAQ;wBACd,OAAO,EAAE,OAAO,CAAC,OAAO;6BACrB,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,MAAM,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC;6BACvC,IAAI,CAAC,IAAI,CAAC;qBACd,CAAC;oBACF,OAAO,aAAa,CAAC;gBACvB,CAAC;gBAED,MAAM,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;oBACnD,IAAI,WAAW,IAAI,OAAO,EAAE,CAAC;wBAC3B,MAAM,YAAY,GAAc;4BAC9B,IAAI,EAAE,OAAO;4BACb,KAAK,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG;yBAC7B,CAAC;wBACF,OAAO,YAAY,CAAC;oBACtB,CAAC;yBAAM,CAAC;wBACN,MAAM,WAAW,GAAa;4BAC5B,IAAI,EAAE,MAAM;4BACZ,IAAI,EAAE,OAAO,CAAC,IAAI;yBACnB,CAAC;wBACF,OAAO,WAAW,CAAC;oBACrB,CAAC;gBACH,CAAC,CAAC,CAAC;gBAEH,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;oBAC5B,MAAM,WAAW,GAAoB;wBACnC,IAAI,EAAE,MAAM;wBACZ,OAAO,EAAE,YAAY;qBACtB,CAAC;oBACF,OAAO,WAAW,CAAC;gBACrB,CAAC;qBAAM,CAAC;oBACN,MAAM,aAAa,GAAG,YAAY,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;wBAChD,IAAI,EAAE,MAAe;wBACrB,IAAI,EAAE,IAAI,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI;qBACpD,CAAC,CAAC,CAAC;oBACJ,MAAM,gBAAgB,GAAyB;wBAC7C,IAAI,EAAE,WAAW;wBACjB,OAAO,EAAE,aAAa;qBACvB,CAAC;oBACF,OAAO,gBAAgB,CAAC;gBAC1B,CAAC;YACH,CAAC;YAED,OAAO;gBACL,IAAI,EAAE,OAAO,CAAC,IAAI;gBAClB,OAAO,EAAE,OAAO,CAAC,OAAO;aACzB,CAAC;QACJ,CAAC,CACF,CAAC;QAEF,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;YAC3B,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC;gBACpC,KAAK,EAAE,IAAI,CAAC,KAAK;gBACjB,QAAQ,EAAE,iBAAiB;gBAC3B,MAAM,EAAE,OAAO,CAAC,cAAc,CAAC,MAAM;aACtC,CAAC,CAAC;YAEH,OAAO;gBACL,IAAI,EAAE,QAAQ,CAAC,MAAM;gBACrB,KAAK,EAAE;oBACL,aAAa,EAAE,QAAQ,CAAC,KAAK,CAAC,WAAW,IAAI,CAAC;oBAC9C,iBAAiB,EAAE,QAAQ,CAAC,KAAK,CAAC,YAAY,IAAI,CAAC;oBACnD,gBAAgB,EAAE,QAAQ,CAAC,KAAK,CAAC,eAAe,IAAI,CAAC;oBACrD,mBAAmB,EAAE,QAAQ,CAAC,KAAK,CAAC,iBAAiB,IAAI,CAAC;oBAC1D,YAAY,EAAE,QAAQ,CAAC,KAAK,CAAC,WAAW,IAAI,CAAC;iBAC9C;aACG,CAAC;QACT,CAAC;QAED,MAAM,KAAK,GAAyB,EAAE,CAAC;QAEvC,KAAK,MAAM,OAAO,IAAI,OAAO,CAAC,KAAK,EAAE,CAAC;YACpC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,GAAG;gBACpB,WAAW,EAAE,OAAO,CAAC,WAAW;gBAChC,WAAW,EAAE,OAAO,CAAC,UAAU;aACxB,CAAC;QACZ,CAAC;QAED,MAAM,QAAQ,GAAG,MAAM,YAAY,CAAC;YAClC,KAAK,EAAE,IAAI,CAAC,KAAK;YACjB,QAAQ,EAAE,iBAAiB;YAC3B,KAAK;SACN,CAAC,CAAC;QAEH,OAAO;YACL,IAAI,EAAE,QAAQ,CAAC,IAAI;YACnB,KAAK,EAAE;gBACL,aAAa,EAAE,QAAQ,CAAC,KAAK,CAAC,WAAW,IAAI,CAAC;gBAC9C,iBAAiB,EAAE,QAAQ,CAAC,KAAK,CAAC,YAAY,IAAI,CAAC;gBACnD,gBAAgB,EAAE,QAAQ,CAAC,KAAK,CAAC,eAAe,IAAI,CAAC;gBACrD,mBAAmB,EAAE,QAAQ,CAAC,KAAK,CAAC,iBAAiB,IAAI,CAAC;gBAC1D,YAAY,EAAE,QAAQ,CAAC,KAAK,CAAC,WAAW,IAAI,CAAC;aAC9C;SACG,CAAC;IACT,CAAC;CACF","sourcesContent":["import {\n  CoreAssistantMessage,\n  ModelMessage,\n  CoreSystemMessage,\n  Tool,\n  CoreUserMessage,\n  generateObject,\n  generateText,\n  ImagePart,\n  TextPart,\n} from \"ai\";\nimport type { LanguageModelV2 } from \"@ai-sdk/provider\";\nimport { CreateChatCompletionOptions, LLMClient } from \"../llm/LLMClient.js\";\nimport { AvailableModel } from \"../types/public/index.js\";\nimport { ChatCompletion } from \"openai/resources\";\n\nexport class AISdkClient extends LLMClient {\n  public type = \"aisdk\" as const;\n  private model: LanguageModelV2;\n\n  constructor({ model }: { model: LanguageModelV2 }) {\n    super(model.modelId as AvailableModel);\n    this.model = model;\n  }\n\n  async createChatCompletion<T = ChatCompletion>({\n    options,\n  }: CreateChatCompletionOptions): Promise<T> {\n    const formattedMessages: ModelMessage[] = options.messages.map(\n      (message) => {\n        if (Array.isArray(message.content)) {\n          if (message.role === \"system\") {\n            const systemMessage: CoreSystemMessage = {\n              role: \"system\",\n              content: message.content\n                .map((c) => (\"text\" in c ? c.text : \"\"))\n                .join(\"\\n\"),\n            };\n            return systemMessage;\n          }\n\n          const contentParts = message.content.map((content) => {\n            if (\"image_url\" in content) {\n              const imageContent: ImagePart = {\n                type: \"image\",\n                image: content.image_url.url,\n              };\n              return imageContent;\n            } else {\n              const textContent: TextPart = {\n                type: \"text\",\n                text: content.text,\n              };\n              return textContent;\n            }\n          });\n\n          if (message.role === \"user\") {\n            const userMessage: CoreUserMessage = {\n              role: \"user\",\n              content: contentParts,\n            };\n            return userMessage;\n          } else {\n            const textOnlyParts = contentParts.map((part) => ({\n              type: \"text\" as const,\n              text: part.type === \"image\" ? \"[Image]\" : part.text,\n            }));\n            const assistantMessage: CoreAssistantMessage = {\n              role: \"assistant\",\n              content: textOnlyParts,\n            };\n            return assistantMessage;\n          }\n        }\n\n        return {\n          role: message.role,\n          content: message.content,\n        };\n      },\n    );\n\n    if (options.response_model) {\n      const response = await generateObject({\n        model: this.model,\n        messages: formattedMessages,\n        schema: options.response_model.schema,\n      });\n\n      return {\n        data: response.object,\n        usage: {\n          prompt_tokens: response.usage.inputTokens ?? 0,\n          completion_tokens: response.usage.outputTokens ?? 0,\n          reasoning_tokens: response.usage.reasoningTokens ?? 0,\n          cached_input_tokens: response.usage.cachedInputTokens ?? 0,\n          total_tokens: response.usage.totalTokens ?? 0,\n        },\n      } as T;\n    }\n\n    const tools: Record<string, Tool> = {};\n\n    for (const rawTool of options.tools) {\n      tools[rawTool.name] = {\n        description: rawTool.description,\n        inputSchema: rawTool.parameters,\n      } as Tool;\n    }\n\n    const response = await generateText({\n      model: this.model,\n      messages: formattedMessages,\n      tools,\n    });\n\n    return {\n      data: response.text,\n      usage: {\n        prompt_tokens: response.usage.inputTokens ?? 0,\n        completion_tokens: response.usage.outputTokens ?? 0,\n        reasoning_tokens: response.usage.reasoningTokens ?? 0,\n        cached_input_tokens: response.usage.cachedInputTokens ?? 0,\n        total_tokens: response.usage.totalTokens ?? 0,\n      },\n    } as T;\n  }\n}\n"]}

package/dist/esm/lib/v3/external_clients/customOpenAI.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Welcome to the Stagehand custom OpenAI client!
+ *
+ * This is a client for models that are compatible with the OpenAI API, like Ollama, Gemini, etc.
+ * You can just pass in an OpenAI instance to the client and it will work.
+ */
+import { CreateChatCompletionOptions, LLMClient } from "../llm/LLMClient.js";
+import OpenAI from "openai";
+import type { ChatCompletion } from "openai/resources/chat/completions";
+export declare class CustomOpenAIClient extends LLMClient {
+    type: "openai";
+    private client;
+    constructor({ modelName, client }: {
+        modelName: string;
+        client: OpenAI;
+    });
+    createChatCompletion<T = ChatCompletion>({ options, retries, logger, }: CreateChatCompletionOptions): Promise<T>;
+}

package/dist/esm/lib/v3/external_clients/customOpenAI.js

@@ -0,0 +1,220 @@
+/**
+ * Welcome to the Stagehand custom OpenAI client!
+ *
+ * This is a client for models that are compatible with the OpenAI API, like Ollama, Gemini, etc.
+ * You can just pass in an OpenAI instance to the client and it will work.
+ */
+import { LLMClient } from "../llm/LLMClient.js";
+import { toJsonSchema } from "../zodCompat.js";
+import { validateZodSchema } from "../../utils.js";
+import { CreateChatCompletionResponseError, ZodSchemaValidationError, } from "../types/public/sdkErrors.js";
+export class CustomOpenAIClient extends LLMClient {
+    type = "openai";
+    client;
+    constructor({ modelName, client }) {
+        super(modelName);
+        this.client = client;
+        this.modelName = modelName;
+    }
+    async createChatCompletion({ options, retries = 3, logger, }) {
+        const { image, requestId, ...optionsWithoutImageAndRequestId } = options;
+        // TODO: Implement vision support
+        if (image) {
+            console.warn("Image provided. Vision is not currently supported for openai");
+        }
+        logger({
+            category: "openai",
+            message: "creating chat completion",
+            level: 1,
+            auxiliary: {
+                options: {
+                    value: JSON.stringify({
+                        ...optionsWithoutImageAndRequestId,
+                        requestId,
+                    }),
+                    type: "object",
+                },
+                modelName: {
+                    value: this.modelName,
+                    type: "string",
+                },
+            },
+        });
+        let responseFormat;
+        if (options.response_model) {
+            responseFormat = {
+                type: "json_object",
+            };
+        }
+        /* eslint-disable */
+        // Remove unsupported options
+        const { response_model, ...openaiOptions } = {
+            ...optionsWithoutImageAndRequestId,
+            model: this.modelName,
+        };
+        logger({
+            category: "openai",
+            message: "creating chat completion",
+            level: 1,
+            auxiliary: {
+                openaiOptions: {
+                    value: JSON.stringify(openaiOptions),
+                    type: "object",
+                },
+            },
+        });
+        const formattedMessages = options.messages.map((message) => {
+            if (Array.isArray(message.content)) {
+                const contentParts = message.content.map((content) => {
+                    if ("image_url" in content) {
+                        const imageContent = {
+                            image_url: {
+                                url: content.image_url.url,
+                            },
+                            type: "image_url",
+                        };
+                        return imageContent;
+                    }
+                    else {
+                        const textContent = {
+                            text: content.text,
+                            type: "text",
+                        };
+                        return textContent;
+                    }
+                });
+                if (message.role === "system") {
+                    const formattedMessage = {
+                        ...message,
+                        role: "system",
+                        content: contentParts.filter((content) => content.type === "text"),
+                    };
+                    return formattedMessage;
+                }
+                else if (message.role === "user") {
+                    const formattedMessage = {
+                        ...message,
+                        role: "user",
+                        content: contentParts,
+                    };
+                    return formattedMessage;
+                }
+                else {
+                    const formattedMessage = {
+                        ...message,
+                        role: "assistant",
+                        content: contentParts.filter((content) => content.type === "text"),
+                    };
+                    return formattedMessage;
+                }
+            }
+            return {
+                ...message,
+                content: message.content,
+            };
+        });
+        if (options.response_model) {
+            const schemaJson = JSON.stringify(toJsonSchema(options.response_model.schema), null, 2);
+            formattedMessages.push({
+                role: "user",
+                content: `Respond with valid JSON matching this schema:\n${schemaJson}\n\nDo not include any other text, formatting or markdown in your output. Do not include \`\`\` or \`\`\`json in your response. Only the JSON object itself.`,
+            });
+        }
+        const body = {
+            ...openaiOptions,
+            model: this.modelName,
+            messages: formattedMessages,
+            response_format: responseFormat,
+            stream: false,
+            tools: options.tools?.map((tool) => ({
+                function: {
+                    name: tool.name,
+                    description: tool.description,
+                    parameters: tool.parameters,
+                },
+                type: "function",
+            })),
+        };
+        const response = await this.client.chat.completions.create(body);
+        logger({
+            category: "openai",
+            message: "response",
+            level: 1,
+            auxiliary: {
+                response: {
+                    value: JSON.stringify(response),
+                    type: "object",
+                },
+                requestId: {
+                    value: requestId,
+                    type: "string",
+                },
+            },
+        });
+        if (options.response_model) {
+            const extractedData = response.choices[0].message.content;
+            if (!extractedData) {
+                throw new CreateChatCompletionResponseError("No content in response");
+            }
+            let parsedData;
+            try {
+                parsedData = JSON.parse(extractedData);
+                validateZodSchema(options.response_model.schema, parsedData);
+            }
+            catch (e) {
+                const isParseError = e instanceof SyntaxError;
+                logger({
+                    category: "openai",
+                    message: isParseError
+                        ? "Response is not valid JSON"
+                        : "Response failed Zod schema validation",
+                    level: 0,
+                });
+                if (retries > 0) {
+                    return this.createChatCompletion({
+                        options,
+                        logger,
+                        retries: retries - 1,
+                    });
+                }
+                if (e instanceof ZodSchemaValidationError) {
+                    logger({
+                        category: "openai",
+                        message: `Error during chat completion: ${e.message}`,
+                        level: 0,
+                        auxiliary: {
+                            errorDetails: {
+                                value: `Message: ${e.message}${e.stack ? "\nStack: " + e.stack : ""}`,
+                                type: "string",
+                            },
+                            requestId: { value: requestId, type: "string" },
+                        },
+                    });
+                    throw new CreateChatCompletionResponseError(e.message);
+                }
+                throw new CreateChatCompletionResponseError(isParseError
+                    ? "Failed to parse model response as JSON"
+                    : e instanceof Error
+                        ? e.message
+                        : "Unknown error during response processing");
+            }
+            return {
+                data: parsedData,
+                usage: {
+                    prompt_tokens: response.usage?.prompt_tokens ?? 0,
+                    completion_tokens: response.usage?.completion_tokens ?? 0,
+                    total_tokens: response.usage?.total_tokens ?? 0,
+                },
+            };
+        }
+        return {
+            data: response.choices[0].message.content,
+            usage: {
+                prompt_tokens: response.usage?.prompt_tokens ?? 0,
+                completion_tokens: response.usage?.completion_tokens ?? 0,
+                total_tokens: response.usage?.total_tokens ?? 0,
+            },
+        };
+    }
+}
+//# sourceMappingURL=customOpenAI.js.map

package/dist/esm/lib/v3/external_clients/customOpenAI.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"customOpenAI.js","sourceRoot":"","sources":["../../../../../lib/v3/external_clients/customOpenAI.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,OAAO,EAA+B,SAAS,EAAE,MAAM,qBAAqB,CAAC;AAY7E,OAAO,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AAC/C,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,EACL,iCAAiC,EACjC,wBAAwB,GACzB,MAAM,8BAA8B,CAAC;AAEtC,MAAM,OAAO,kBAAmB,SAAQ,SAAS;IACxC,IAAI,GAAG,QAAiB,CAAC;IACxB,MAAM,CAAS;IAEvB,YAAY,EAAE,SAAS,EAAE,MAAM,EAAyC;QACtE,KAAK,CAAC,SAA2B,CAAC,CAAC;QACnC,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,SAAS,GAAG,SAA2B,CAAC;IAC/C,CAAC;IAED,KAAK,CAAC,oBAAoB,CAAqB,EAC7C,OAAO,EACP,OAAO,GAAG,CAAC,EACX,MAAM,GACsB;QAC5B,MAAM,EAAE,KAAK,EAAE,SAAS,EAAE,GAAG,+BAA+B,EAAE,GAAG,OAAO,CAAC;QAEzE,iCAAiC;QACjC,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,CAAC,IAAI,CACV,8DAA8D,CAC/D,CAAC;QACJ,CAAC;QAED,MAAM,CAAC;YACL,QAAQ,EAAE,QAAQ;YAClB,OAAO,EAAE,0BAA0B;YACnC,KAAK,EAAE,CAAC;YACR,SAAS,EAAE;gBACT,OAAO,EAAE;oBACP,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC;wBACpB,GAAG,+BAA+B;wBAClC,SAAS;qBACV,CAAC;oBACF,IAAI,EAAE,QAAQ;iBACf;gBACD,SAAS,EAAE;oBACT,KAAK,EAAE,IAAI,CAAC,SAAS;oBACrB,IAAI,EAAE,QAAQ;iBACf;aACF;SACF,CAAC,CAAC;QAEH,IAAI,cAES,CAAC;QACd,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;YAC3B,cAAc,GAAG;gBACf,IAAI,EAAE,aAAa;aACpB,CAAC;QACJ,CAAC;QAED,oBAAoB;QACpB,6BAA6B;QAC7B,MAAM,EAAE,cAAc,EAAE,GAAG,aAAa,EAAE,GAAG;YAC3C,GAAG,+BAA+B;YAClC,KAAK,EAAE,IAAI,CAAC,SAAS;SACtB,CAAC;QAEF,MAAM,CAAC;YACL,QAAQ,EAAE,QAAQ;YAClB,OAAO,EAAE,0BAA0B;YACnC,KAAK,EAAE,CAAC;YACR,SAAS,EAAE;gBACT,aAAa,EAAE;oBACb,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC;oBACpC,IAAI,EAAE,QAAQ;iBACf;aACF;SACF,CAAC,CAAC;QAEH,MAAM,iBAAiB,GACrB,OAAO,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;YAC/B,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;gBACnC,MAAM,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE;oBACnD,IAAI,WAAW,IAAI,OAAO,EAAE,CAAC;wBAC3B,MAAM,YAAY,GAAmC;4BACnD,SAAS,EAAE;gCACT,GAAG,EAAE,OAAO,CAAC,SAAS,CAAC,GAAG;6BAC3B;4BACD,IAAI,EAAE,WAAW;yBAClB,CAAC;wBACF,OAAO,YAAY,CAAC;oBACtB,CAAC;yBAAM,CAAC;wBACN,MAAM,WAAW,GAAkC;4BACjD,IAAI,EAAE,OAAO,CAAC,IAAI;4BAClB,IAAI,EAAE,MAAM;yBACb,CAAC;wBACF,OAAO,WAAW,CAAC;oBACrB,CAAC;gBACH,CAAC,CAAC,CAAC;gBAEH,IAAI,OAAO,CAAC,IAAI,KAAK,QAAQ,EAAE,CAAC;oBAC9B,MAAM,gBAAgB,GAAqC;wBACzD,GAAG,OAAO;wBACV,IAAI,EAAE,QAAQ;wBACd,OAAO,EAAE,YAAY,CAAC,MAAM,CAC1B,CAAC,OAAO,EAA4C,EAAE,CACpD,OAAO,CAAC,IAAI,KAAK,MAAM,CAC1B;qBACF,CAAC;oBACF,OAAO,gBAAgB,CAAC;gBAC1B,CAAC;qBAAM,IAAI,OAAO,CAAC,IAAI,KAAK,MAAM,EAAE,CAAC;oBACnC,MAAM,gBAAgB,GAAmC;wBACvD,GAAG,OAAO;wBACV,IAAI,EAAE,MAAM;wBACZ,OAAO,EAAE,YAAY;qBACtB,CAAC;oBACF,OAAO,gBAAgB,CAAC;gBAC1B,CAAC;qBAAM,CAAC;oBACN,MAAM,gBAAgB,GAAwC;wBAC5D,GAAG,OAAO;wBACV,IAAI,EAAE,WAAW;wBACjB,OAAO,EAAE,YAAY,CAAC,MAAM,CAC1B,CAAC,OAAO,EAA4C,EAAE,CACpD,OAAO,CAAC,IAAI,KAAK,MAAM,CAC1B;qBACF,CAAC;oBACF,OAAO,gBAAgB,CAAC;gBAC1B,CAAC;YACH,CAAC;YAED,OAAO;gBACL,GAAG,OAAO;gBACV,OAAO,EAAE,OAAO,CAAC,OAAO;aACK,CAAC;QAClC,CAAC,CAAC,CAAC;QAEL,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;YAC3B,MAAM,UAAU,GAAG,IAAI,CAAC,SAAS,CAC/B,YAAY,CAAC,OAAO,CAAC,cAAc,CAAC,MAAM,CAAC,EAC3C,IAAI,EACJ,CAAC,CACF,CAAC;YACF,iBAAiB,CAAC,IAAI,CAAC;gBACrB,IAAI,EAAE,MAAM;gBACZ,OAAO,EAAE,kDAAkD,UAAU,8JAA8J;aACpO,CAAC,CAAC;QACL,CAAC;QAED,MAAM,IAAI,GAA2C;YACnD,GAAG,aAAa;YAChB,KAAK,EAAE,IAAI,CAAC,SAAS;YACrB,QAAQ,EAAE,iBAAiB;YAC3B,eAAe,EAAE,cAAc;YAC/B,MAAM,EAAE,KAAK;YACb,KAAK,EAAE,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;gBACnC,QAAQ,EAAE;oBACR,IAAI,EAAE,IAAI,CAAC,IAAI;oBACf,WAAW,EAAE,IAAI,CAAC,WAAW;oBAC7B,UAAU,EAAE,IAAI,CAAC,UAAU;iBAC5B;gBACD,IAAI,EAAE,UAAU;aACjB,CAAC,CAAC;SACJ,CAAC;QAEF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;QAEjE,MAAM,CAAC;YACL,QAAQ,EAAE,QAAQ;YAClB,OAAO,EAAE,UAAU;YACnB,KAAK,EAAE,CAAC;YACR,SAAS,EAAE;gBACT,QAAQ,EAAE;oBACR,KAAK,EAAE,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC;oBAC/B,IAAI,EAAE,QAAQ;iBACf;gBACD,SAAS,EAAE;oBACT,KAAK,EAAE,SAAS;oBAChB,IAAI,EAAE,QAAQ;iBACf;aACF;SACF,CAAC,CAAC;QAEH,IAAI,OAAO,CAAC,cAAc,EAAE,CAAC;YAC3B,MAAM,aAAa,GAAG,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO,CAAC;YAC1D,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,MAAM,IAAI,iCAAiC,CAAC,wBAAwB,CAAC,CAAC;YACxE,CAAC;YAED,IAAI,UAAmB,CAAC;YACxB,IAAI,CAAC;gBACH,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,CAAC;gBACvC,iBAAiB,CAAC,OAAO,CAAC,cAAc,CAAC,MAAM,EAAE,UAAU,CAAC,CAAC;YAC/D,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,MAAM,YAAY,GAAG,CAAC,YAAY,WAAW,CAAC;gBAC9C,MAAM,CAAC;oBACL,QAAQ,EAAE,QAAQ;oBAClB,OAAO,EAAE,YAAY;wBACnB,CAAC,CAAC,4BAA4B;wBAC9B,CAAC,CAAC,uCAAuC;oBAC3C,KAAK,EAAE,CAAC;iBACT,CAAC,CAAC;gBACH,IAAI,OAAO,GAAG,CAAC,EAAE,CAAC;oBAChB,OAAO,IAAI,CAAC,oBAAoB,CAAC;wBAC/B,OAAO;wBACP,MAAM;wBACN,OAAO,EAAE,OAAO,GAAG,CAAC;qBACrB,CAAC,CAAC;gBACL,CAAC;gBAED,IAAI,CAAC,YAAY,wBAAwB,EAAE,CAAC;oBAC1C,MAAM,CAAC;wBACL,QAAQ,EAAE,QAAQ;wBAClB,OAAO,EAAE,iCAAiC,CAAC,CAAC,OAAO,EAAE;wBACrD,KAAK,EAAE,CAAC;wBACR,SAAS,EAAE;4BACT,YAAY,EAAE;gCACZ,KAAK,EAAE,YAAY,CAAC,CAAC,OAAO,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,WAAW,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE;gCACrE,IAAI,EAAE,QAAQ;6BACf;4BACD,SAAS,EAAE,EAAE,KAAK,EAAE,SAAS,EAAE,IAAI,EAAE,QAAQ,EAAE;yBAChD;qBACF,CAAC,CAAC;oBACH,MAAM,IAAI,iCAAiC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC;gBACzD,CAAC;gBACD,MAAM,IAAI,iCAAiC,CACzC,YAAY;oBACV,CAAC,CAAC,wCAAwC;oBAC1C,CAAC,CAAC,CAAC,YAAY,KAAK;wBAClB,CAAC,CAAC,CAAC,CAAC,OAAO;wBACX,CAAC,CAAC,0CAA0C,CACjD,CAAC;YACJ,CAAC;YAED,OAAO;gBACL,IAAI,EAAE,UAAU;gBAChB,KAAK,EAAE;oBACL,aAAa,EAAE,QAAQ,CAAC,KAAK,EAAE,aAAa,IAAI,CAAC;oBACjD,iBAAiB,EAAE,QAAQ,CAAC,KAAK,EAAE,iBAAiB,IAAI,CAAC;oBACzD,YAAY,EAAE,QAAQ,CAAC,KAAK,EAAE,YAAY,IAAI,CAAC;iBAChD;aACG,CAAC;QACT,CAAC;QAED,OAAO;YACL,IAAI,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,OAAO;YACzC,KAAK,EAAE;gBACL,aAAa,EAAE,QAAQ,CAAC,KAAK,EAAE,aAAa,IAAI,CAAC;gBACjD,iBAAiB,EAAE,QAAQ,CAAC,KAAK,EAAE,iBAAiB,IAAI,CAAC;gBACzD,YAAY,EAAE,QAAQ,CAAC,KAAK,EAAE,YAAY,IAAI,CAAC;aAChD;SACG,CAAC;IACT,CAAC;CACF","sourcesContent":["/**\n * Welcome to the Stagehand custom OpenAI client!\n *\n * This is a client for models that are compatible with the OpenAI API, like Ollama, Gemini, etc.\n * You can just pass in an OpenAI instance to the client and it will work.\n */\n\nimport type { AvailableModel } from \"../types/public/model.js\";\nimport { CreateChatCompletionOptions, LLMClient } from \"../llm/LLMClient.js\";\nimport OpenAI from \"openai\";\nimport type {\n  ChatCompletion,\n  ChatCompletionAssistantMessageParam,\n  ChatCompletionContentPartImage,\n  ChatCompletionContentPartText,\n  ChatCompletionCreateParamsNonStreaming,\n  ChatCompletionMessageParam,\n  ChatCompletionSystemMessageParam,\n  ChatCompletionUserMessageParam,\n} from \"openai/resources/chat/completions\";\nimport { toJsonSchema } from \"../zodCompat.js\";\nimport { validateZodSchema } from \"../../utils.js\";\nimport {\n  CreateChatCompletionResponseError,\n  ZodSchemaValidationError,\n} from \"../types/public/sdkErrors.js\";\n\nexport class CustomOpenAIClient extends LLMClient {\n  public type = \"openai\" as const;\n  private client: OpenAI;\n\n  constructor({ modelName, client }: { modelName: string; client: OpenAI }) {\n    super(modelName as AvailableModel);\n    this.client = client;\n    this.modelName = modelName as AvailableModel;\n  }\n\n  async createChatCompletion<T = ChatCompletion>({\n    options,\n    retries = 3,\n    logger,\n  }: CreateChatCompletionOptions): Promise<T> {\n    const { image, requestId, ...optionsWithoutImageAndRequestId } = options;\n\n    // TODO: Implement vision support\n    if (image) {\n      console.warn(\n        \"Image provided. Vision is not currently supported for openai\",\n      );\n    }\n\n    logger({\n      category: \"openai\",\n      message: \"creating chat completion\",\n      level: 1,\n      auxiliary: {\n        options: {\n          value: JSON.stringify({\n            ...optionsWithoutImageAndRequestId,\n            requestId,\n          }),\n          type: \"object\",\n        },\n        modelName: {\n          value: this.modelName,\n          type: \"string\",\n        },\n      },\n    });\n\n    let responseFormat:\n      | ChatCompletionCreateParamsNonStreaming[\"response_format\"]\n      | undefined;\n    if (options.response_model) {\n      responseFormat = {\n        type: \"json_object\",\n      };\n    }\n\n    /* eslint-disable */\n    // Remove unsupported options\n    const { response_model, ...openaiOptions } = {\n      ...optionsWithoutImageAndRequestId,\n      model: this.modelName,\n    };\n\n    logger({\n      category: \"openai\",\n      message: \"creating chat completion\",\n      level: 1,\n      auxiliary: {\n        openaiOptions: {\n          value: JSON.stringify(openaiOptions),\n          type: \"object\",\n        },\n      },\n    });\n\n    const formattedMessages: ChatCompletionMessageParam[] =\n      options.messages.map((message) => {\n        if (Array.isArray(message.content)) {\n          const contentParts = message.content.map((content) => {\n            if (\"image_url\" in content) {\n              const imageContent: ChatCompletionContentPartImage = {\n                image_url: {\n                  url: content.image_url.url,\n                },\n                type: \"image_url\",\n              };\n              return imageContent;\n            } else {\n              const textContent: ChatCompletionContentPartText = {\n                text: content.text,\n                type: \"text\",\n              };\n              return textContent;\n            }\n          });\n\n          if (message.role === \"system\") {\n            const formattedMessage: ChatCompletionSystemMessageParam = {\n              ...message,\n              role: \"system\",\n              content: contentParts.filter(\n                (content): content is ChatCompletionContentPartText =>\n                  content.type === \"text\",\n              ),\n            };\n            return formattedMessage;\n          } else if (message.role === \"user\") {\n            const formattedMessage: ChatCompletionUserMessageParam = {\n              ...message,\n              role: \"user\",\n              content: contentParts,\n            };\n            return formattedMessage;\n          } else {\n            const formattedMessage: ChatCompletionAssistantMessageParam = {\n              ...message,\n              role: \"assistant\",\n              content: contentParts.filter(\n                (content): content is ChatCompletionContentPartText =>\n                  content.type === \"text\",\n              ),\n            };\n            return formattedMessage;\n          }\n        }\n\n        return {\n          ...message,\n          content: message.content,\n        } as ChatCompletionMessageParam;\n      });\n\n    if (options.response_model) {\n      const schemaJson = JSON.stringify(\n        toJsonSchema(options.response_model.schema),\n        null,\n        2,\n      );\n      formattedMessages.push({\n        role: \"user\",\n        content: `Respond with valid JSON matching this schema:\\n${schemaJson}\\n\\nDo not include any other text, formatting or markdown in your output. Do not include \\`\\`\\` or \\`\\`\\`json in your response. Only the JSON object itself.`,\n      });\n    }\n\n    const body: ChatCompletionCreateParamsNonStreaming = {\n      ...openaiOptions,\n      model: this.modelName,\n      messages: formattedMessages,\n      response_format: responseFormat,\n      stream: false,\n      tools: options.tools?.map((tool) => ({\n        function: {\n          name: tool.name,\n          description: tool.description,\n          parameters: tool.parameters,\n        },\n        type: \"function\",\n      })),\n    };\n\n    const response = await this.client.chat.completions.create(body);\n\n    logger({\n      category: \"openai\",\n      message: \"response\",\n      level: 1,\n      auxiliary: {\n        response: {\n          value: JSON.stringify(response),\n          type: \"object\",\n        },\n        requestId: {\n          value: requestId,\n          type: \"string\",\n        },\n      },\n    });\n\n    if (options.response_model) {\n      const extractedData = response.choices[0].message.content;\n      if (!extractedData) {\n        throw new CreateChatCompletionResponseError(\"No content in response\");\n      }\n\n      let parsedData: unknown;\n      try {\n        parsedData = JSON.parse(extractedData);\n        validateZodSchema(options.response_model.schema, parsedData);\n      } catch (e) {\n        const isParseError = e instanceof SyntaxError;\n        logger({\n          category: \"openai\",\n          message: isParseError\n            ? \"Response is not valid JSON\"\n            : \"Response failed Zod schema validation\",\n          level: 0,\n        });\n        if (retries > 0) {\n          return this.createChatCompletion({\n            options,\n            logger,\n            retries: retries - 1,\n          });\n        }\n\n        if (e instanceof ZodSchemaValidationError) {\n          logger({\n            category: \"openai\",\n            message: `Error during chat completion: ${e.message}`,\n            level: 0,\n            auxiliary: {\n              errorDetails: {\n                value: `Message: ${e.message}${e.stack ? \"\\nStack: \" + e.stack : \"\"}`,\n                type: \"string\",\n              },\n              requestId: { value: requestId, type: \"string\" },\n            },\n          });\n          throw new CreateChatCompletionResponseError(e.message);\n        }\n        throw new CreateChatCompletionResponseError(\n          isParseError\n            ? \"Failed to parse model response as JSON\"\n            : e instanceof Error\n              ? e.message\n              : \"Unknown error during response processing\",\n        );\n      }\n\n      return {\n        data: parsedData,\n        usage: {\n          prompt_tokens: response.usage?.prompt_tokens ?? 0,\n          completion_tokens: response.usage?.completion_tokens ?? 0,\n          total_tokens: response.usage?.total_tokens ?? 0,\n        },\n      } as T;\n    }\n\n    return {\n      data: response.choices[0].message.content,\n      usage: {\n        prompt_tokens: response.usage?.prompt_tokens ?? 0,\n        completion_tokens: response.usage?.completion_tokens ?? 0,\n        total_tokens: response.usage?.total_tokens ?? 0,\n      },\n    } as T;\n  }\n}\n"]}

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

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