Jido.Browser (Jido Browser v2.1.0)

Copy Markdown View Source

Browser automation for Jido AI agents.

Jido.Browser provides a flat browser API backed by pluggable adapters. In 2.0, the default adapter is Jido.Browser.Adapters.AgentBrowser.

Summary

Functions

back(session, opts \\ [])

Navigates back in browser history.

click(session, selector, opts \\ [])

Clicks an element identified by a selector or agent-browser ref.

close_tab(session, index \\ nil, opts \\ [])

Closes the current tab or a specific tab by index.

console(session, opts \\ [])

Returns captured browser console messages when supported by the adapter.

end_session(session)

Ends an active browser session.

errors(session, opts \\ [])

Returns captured browser runtime errors when supported by the adapter.

evaluate(session, script, opts \\ [])

Evaluates JavaScript in the browser when the adapter supports it.

extract_content(session, opts \\ [])

Extracts page content as markdown, HTML, or text.

focus(session, selector, opts \\ [])

Focuses an element.

forward(session, opts \\ [])

Navigates forward in browser history.

get_attribute(session, selector, attribute, opts \\ [])

Reads an attribute value from an element.

get_status(session, opts \\ [])

Returns the current session status, including URL, title, and liveness.

get_text(session, selector, opts \\ [])

Reads text content from one or more matching elements.

get_title(session, opts \\ [])

Returns the current page title.

get_url(session, opts \\ [])

Returns the current page URL.

hover(session, selector, opts \\ [])

Moves the pointer over an element.

is_visible(session, selector, opts \\ [])

Checks whether an element exists and is visible.

list_tabs(session, opts \\ [])

Lists open browser tabs.

load_state(session, path, opts \\ [])

Restores browser session state from disk.

navigate(session, url, opts \\ [])

Navigates the current session to a URL.

new_tab(session, url \\ nil, opts \\ [])

Opens a new tab, optionally at a URL.

query(session, selector, opts \\ [])

Queries a selector and returns a stable element summary.

reload(session, opts \\ [])

Reloads the current page.

save_state(session, path, opts \\ [])

Persists browser session state to disk.

screenshot(session, opts \\ [])

Captures a screenshot of the current page.

scroll(session, opts \\ [])

Scrolls the page, by coordinates, direction, or to a specific element.

select_option(session, selector, opts \\ [])

Selects an option in a form control.

snapshot(session, opts \\ [])

Returns an agent-oriented page snapshot with ref metadata when supported.

start_pool(opts)

Starts a warm browser pool for adapters that support pooled sessions.

start_session(opts \\ [])

Starts a browser session using the configured adapter or an explicit adapter override.

stop_pool(pool)

Stops a previously started warm browser pool.

switch_tab(session, index, opts \\ [])

Switches to a tab by index.

type(session, selector, text, opts \\ [])

Types text into an element identified by a selector or agent-browser ref.

wait_for_navigation(session, opts \\ [])

Waits for a navigation or URL change to complete.

wait_for_selector(session, selector, opts \\ [])

Waits for a selector to reach a requested state.

web_fetch(url, opts \\ [])

Fetches a URL over HTTP(S) without starting a browser session.

Functions

back(session, opts \\ [])

@spec back(
  Jido.Browser.Session.t(),
  keyword()
) :: {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Navigates back in browser history.

click(session, selector, opts \\ [])

@spec click(Jido.Browser.Session.t(), String.t(), keyword()) ::
  {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Clicks an element identified by a selector or agent-browser ref.

close_tab(session, index \\ nil, opts \\ [])

@spec close_tab(Jido.Browser.Session.t(), non_neg_integer() | nil, keyword()) ::
  {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Closes the current tab or a specific tab by index.

console(session, opts \\ [])

@spec console(
  Jido.Browser.Session.t(),
  keyword()
) :: {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Returns captured browser console messages when supported by the adapter.

end_session(session)

@spec end_session(Jido.Browser.Session.t()) :: :ok | {:error, term()}

Ends an active browser session.

errors(session, opts \\ [])

@spec errors(
  Jido.Browser.Session.t(),
  keyword()
) :: {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Returns captured browser runtime errors when supported by the adapter.

evaluate(session, script, opts \\ [])

@spec evaluate(Jido.Browser.Session.t(), String.t(), keyword()) ::
  {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Evaluates JavaScript in the browser when the adapter supports it.

extract_content(session, opts \\ [])

@spec extract_content(
  Jido.Browser.Session.t(),
  keyword()
) :: {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Extracts page content as markdown, HTML, or text.

focus(session, selector, opts \\ [])

@spec focus(Jido.Browser.Session.t(), String.t(), keyword()) ::
  {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Focuses an element.

forward(session, opts \\ [])

@spec forward(
  Jido.Browser.Session.t(),
  keyword()
) :: {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Navigates forward in browser history.

get_attribute(session, selector, attribute, opts \\ [])

@spec get_attribute(Jido.Browser.Session.t(), String.t(), String.t(), keyword()) ::
  {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Reads an attribute value from an element.

get_status(session, opts \\ [])

@spec get_status(
  Jido.Browser.Session.t(),
  keyword()
) :: {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Returns the current session status, including URL, title, and liveness.

get_text(session, selector, opts \\ [])

@spec get_text(Jido.Browser.Session.t(), String.t(), keyword()) ::
  {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Reads text content from one or more matching elements.

get_title(session, opts \\ [])

@spec get_title(
  Jido.Browser.Session.t(),
  keyword()
) :: {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Returns the current page title.

get_url(session, opts \\ [])

@spec get_url(
  Jido.Browser.Session.t(),
  keyword()
) :: {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Returns the current page URL.

hover(session, selector, opts \\ [])

@spec hover(Jido.Browser.Session.t(), String.t(), keyword()) ::
  {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Moves the pointer over an element.

is_visible(session, selector, opts \\ [])

@spec is_visible(Jido.Browser.Session.t(), String.t(), keyword()) ::
  {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Checks whether an element exists and is visible.

list_tabs(session, opts \\ [])

@spec list_tabs(
  Jido.Browser.Session.t(),
  keyword()
) :: {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Lists open browser tabs.

load_state(session, path, opts \\ [])

@spec load_state(Jido.Browser.Session.t(), String.t(), keyword()) ::
  {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Restores browser session state from disk.

new_tab(session, url \\ nil, opts \\ [])

@spec new_tab(Jido.Browser.Session.t(), String.t() | nil, keyword()) ::
  {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Opens a new tab, optionally at a URL.

query(session, selector, opts \\ [])

@spec query(Jido.Browser.Session.t(), String.t(), keyword()) ::
  {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Queries a selector and returns a stable element summary.

reload(session, opts \\ [])

@spec reload(
  Jido.Browser.Session.t(),
  keyword()
) :: {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Reloads the current page.

save_state(session, path, opts \\ [])

@spec save_state(Jido.Browser.Session.t(), String.t(), keyword()) ::
  {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Persists browser session state to disk.

screenshot(session, opts \\ [])

@spec screenshot(
  Jido.Browser.Session.t(),
  keyword()
) :: {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Captures a screenshot of the current page.

scroll(session, opts \\ [])

@spec scroll(
  Jido.Browser.Session.t(),
  keyword()
) :: {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Scrolls the page, by coordinates, direction, or to a specific element.

select_option(session, selector, opts \\ [])

@spec select_option(Jido.Browser.Session.t(), String.t(), keyword()) ::
  {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Selects an option in a form control.

snapshot(session, opts \\ [])

@spec snapshot(
  Jido.Browser.Session.t(),
  keyword()
) :: {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Returns an agent-oriented page snapshot with ref metadata when supported.

start_pool(opts)

@spec start_pool(keyword()) :: {:ok, pid()} | {:error, term()}

Starts a warm browser pool for adapters that support pooled sessions.

This is intended for scripts, tests, and ad hoc startup. OTP applications should prefer adding Jido.Browser.Pool to their supervision tree.

start_session(opts \\ [])

@spec start_session(keyword()) :: {:ok, Jido.Browser.Session.t()} | {:error, term()}

Starts a browser session using the configured adapter or an explicit adapter override.

stop_pool(pool)

@spec stop_pool(term()) :: :ok | {:error, term()}

Stops a previously started warm browser pool.

switch_tab(session, index, opts \\ [])

@spec switch_tab(Jido.Browser.Session.t(), non_neg_integer(), keyword()) ::
  {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Switches to a tab by index.

type(session, selector, text, opts \\ [])

@spec type(Jido.Browser.Session.t(), String.t(), String.t(), keyword()) ::
  {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Types text into an element identified by a selector or agent-browser ref.

wait_for_navigation(session, opts \\ [])

@spec wait_for_navigation(
  Jido.Browser.Session.t(),
  keyword()
) :: {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Waits for a navigation or URL change to complete.

wait_for_selector(session, selector, opts \\ [])

@spec wait_for_selector(Jido.Browser.Session.t(), String.t(), keyword()) ::
  {:ok, Jido.Browser.Session.t(), map()} | {:error, term()}

Waits for a selector to reach a requested state.

web_fetch(url, opts \\ [])

@spec web_fetch(
  String.t(),
  keyword()
) :: {:ok, map()} | {:error, term()}

Fetches a URL over HTTP(S) without starting a browser session.

HTML responses keep native selector extraction and format conversion, while fetched binary documents such as PDFs and office files are extracted through ExtractousEx.