Browser Settings

import { BrowserSession, Agent } from "browsernode";

const browserSession = new BrowserSession({
    headless: true,
    viewport: { width: 964, height: 647 },
    userDataDir: "~/.config/browsernode/profiles/default",
});

const agent = new Agent({
  task: "fill out the form on this page",
  browserSession: browserSession,
});

wssUrl: string | null = null

cdpUrl: string | null = null

browserPid: number | null = null

browserProfile: BrowserProfile = BrowserProfile()

playwright: Playwright | null = null

browser: Browser | null = null

browserContext: BrowserContext | null = null

page: Page | null = null

humanCurrentPage: Page | null = null

initialized: boolean = false

baseIphone13 = BrowserProfile(
    storageState='/tmp/auth.json',     # share cookies between parallel browsers
    ...playwright.devices['iPhone 13'],
    timezoneId='UTC',
)
usaPhone = BrowserSession(
    browserProfile=baseIphone13,
    timezoneId='America/New_York',     # kwargs override values in baseIphone13
)
euPhone = BrowserSession(
    browserProfile=baseIphone13,
    timezoneId='Europe/Paris',
)

usaAgent = Agent({task: 'show me todays schedule...', browserSession: usaPhone})
euAgent = Agent({task: 'show me todays schedule...', browserSession: euPhone})
await Promise.all([usaAgent.run(), euAgent.run()])

- config = {key: val, key: val, ...}
- BrowserSession({...config})

+ config = BrowserProfile(key=val, key=val, ...)
+ BrowserSession(browserProfile=config)

import { BrowserProfile } from "browsernode/browser";

const profile = new BrowserProfile(
    stealth: true,
    storageState: '/tmp/google_docs_cookies.json',
    allowedDomains: ['docs.google.com', 'https://accounts.google.com'],
    viewport: { width: 396, height: 774 },
    # ... playwright args / browsernode config args ...
)

const phone1 = new BrowserSession(browserProfile: profile, deviceScaleFactor: 1)
const phone2 = new BrowserSession(browserProfile: profile, deviceScaleFactor: 2)
const phone3 = new BrowserSession(browserProfile: profile, deviceScaleFactor: 3)

keepAlive: boolean | null = null

stealth: boolean = false

allowedDomains: list[str] | null = null

disableSecurity: boolean = false

deterministicRendering: boolean = false

highlightElements: bool = True

viewportExpansion: int = 500

includeDynamicAttributes: boolean = true

minimumWaitPageLoadTime: number = 0.25

waitForNetworkIdlePageLoadTime: number = 0.5

maximumWaitPageLoadTime: number = 5.0

waitBetweenActions: number = 0.5

cookiesFile: string | null = null

profileDirectory: string = 'Default'

windowPosition: Record<string, number> | null = {"width": 0, "height": 0}

saveRecordingPath: string | null = null

tracePath: string | null = null

headless: boolean | null = null

channel: BrowserChannel = 'chromium'

executablePath: string | Path | null = null

userDataDir: string | Path | null = '~/.config/browsernode/profiles/default'

args: string[] = []

ignoreDefaultArgs: list[str] | bool = ['--enable-automation', '--disable-extensions']

env: Record<string, string> = {}

chromiumSandbox: bool = not IN_DOCKER

devtools: bool = False

slowMo: float = 0

timeout: float = 30000

acceptDownloads: bool = True

proxy: Record<string, unknown> | null = null

permissions: string[] = ['clipboard-read', 'clipboard-write', 'notifications']

storageState: string | Path | Record<string, unknown> | null = null

# to create a storage state file, run the following and log into the sites you need once the browser opens:
playwright open https://example.com/ --save-storage=./storageState.json
# then setup a BrowserSession with storageState='./storageState.json' and userDataDir=null to use it

defaultTimeout: number | null = null

defaultNavigationTimeout: number | null = null

userAgent: string | null = null

isMobile: boolean = false

hasTouch: boolean = false

geolocation: Record<string, number> | null = null

locale: string | null = null

timezoneId: string | null = null

windowSize: Record<string, number> | null = null

viewport: Record<string, number> | null = null

noViewport: boolean | null = not headless

deviceScaleFactor: number | null = null

screen: Record<string, number> | null = null

colorScheme: ColorScheme = 'light'

contrast: Contrast = 'no-preference'

reducedMotion: ReducedMotion = 'no-preference'

forcedColors: ForcedColors = 'null'

offline: boolean = false

httpCredentials: Record<string, unknown> | null = null

extraHTTPHeaders: Record<string, string> = {}

ignoreHTTPSErrors: boolean = false

bypassCSP: boolean = false

javaScriptEnabled: boolean = true

serviceWorkers: ServiceWorkers = 'allow'

baseURL: string | null = null

strictSelectors: boolean = false

clientCertificates: ClientCertificate[] = []

recordVideoDir: string | null = null

recordVideoSize: Record<string, number> | null = null

recordHarPath: string | null = null

recordHarContent: RecordHarContent = 'embed'

recordHarMode: RecordHarMode = 'full'

recordHarOmitContent: boolean = false

recordHarUrlFilter: string | RegExp | null = null

downloadsPath: string | null = '~/.config/browsernode/downloads'

tracesDir: string | null = null

handleSIGHUP: boolean = true

handleSIGINT: boolean = false

handleSIGTERM: boolean = false

import { BrowserSession, BrowserProfile, Agent } from "browsernode";

browserProfile = BrowserProfile(
    headless: false,
    storageState: "path/to/storage_state.json",
    waitForNetworkIdlePageLoadTime: 3.0,
    viewport: { width: 1280, height: 1100 },
    locale: 'en-US',
    userAgent: 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.102 Safari/537.36',
    highlightElements: true,
    viewportExpansion: 500,
    allowedDomains: ['*.google.com', 'http*://*.wikipedia.org'],
    userDataDir: null,
)

const browserSession = new BrowserSession(
    browserProfile: browserProfile,
    headless: true,                          # extra kwargs to the session override the defaults in the profile
)

# you can drive a session without the agent / reuse it between agents
await browserSession.start()
const page = await browserSession.getCurrentPage()
await page.goto('https://example.com/first/page')

async function runSearch(): Promise<void> {
    const agent = new Agent({
        task: 'Your task',
        llm: llm,
        page: page,                        // optional: pass a specific playwright page to start on
        browserSession: browserSession,  // optional: pass an existing browser session to an agent
    })
}