Remove Need to Add Project ID in Browserbase Params if Already Passed to Stagehand (#1056)

# why

if you add custom browserbase create params, you need to include the
project id even if the project id is already passed to the stagehand
instance

# what changed

browserbaseSessionCreateParams type changed to omit project id

# test plan

build stagehand locally, use local stagehand to run sessions with
- two project ids: one in Stagehand part, one in Browserbase Session
Create Params
- one project id: only in Stagehand part

Author: chrisreadsf

.changeset/social-moles-wish.md

@@ -0,0 +1,5 @@
+---
+"@browserbasehq/stagehand": patch
+---
+
+remove need for duplicate project id if already passed to Stagehand

lib/index.ts

@@ -73,7 +73,7 @@ async function getBrowser(
   env: "LOCAL" | "BROWSERBASE" = "LOCAL",
   headless: boolean = false,
   logger: (message: LogLine) => void,
-  browserbaseSessionCreateParams?: Browserbase.Sessions.SessionCreateParams,
+  browserbaseSessionCreateParams?: ConstructorParams["browserbaseSessionCreateParams"],
   browserbaseSessionID?: string,
   localBrowserLaunchOptions?: LocalBrowserLaunchOptions,
 ): Promise<BrowserResult> {
@@ -166,6 +166,7 @@ async function getBrowser(
           stagehand: "true",
         },
       });
+      // Final projectId used: browserbaseSessionCreateParams.projectId || projectId
 
       sessionId = session.id;
       connectUrl = session.connectUrl;
@@ -377,7 +378,7 @@ export class Stagehand {
   protected apiKey: string | undefined;
   private projectId: string | undefined;
   private externalLogger?: (logLine: LogLine) => void;
-  private browserbaseSessionCreateParams?: Browserbase.Sessions.SessionCreateParams;
+  private browserbaseSessionCreateParams?: ConstructorParams["browserbaseSessionCreateParams"];
   public variables: { [key: string]: unknown };
   private contextPath?: string;
   public llmClient: LLMClient;

types/api.ts

@@ -20,7 +20,10 @@ export interface StartSessionParams {
   verbose: number;
   debugDom: boolean;
   systemPrompt?: string;
-  browserbaseSessionCreateParams?: Browserbase.Sessions.SessionCreateParams;
+  browserbaseSessionCreateParams?: Omit<
+    Browserbase.Sessions.SessionCreateParams,
+    "projectId"
+  > & { projectId?: string };
   selfHeal?: boolean;
   waitForCaptchaSolves?: boolean;
   actionTimeoutMs?: number;

types/stagehand.ts

@@ -46,8 +46,12 @@ export interface ConstructorParams {
   /**
    * The parameters to use for creating a Browserbase session
    * See https://docs.browserbase.com/reference/api/create-a-session
+   * Note: projectId is optional here as it will use the main projectId parameter if not provided
    */
-  browserbaseSessionCreateParams?: Browserbase.Sessions.SessionCreateParams;
+  browserbaseSessionCreateParams?: Omit<
+    Browserbase.Sessions.SessionCreateParams,
+    "projectId"
+  > & { projectId?: string };
   /**
    * Enable caching of LLM responses
    * @default true