mooncakes.io

README

mizchi/crater-webdriver-bidi/contract does not have a README file

#
ApiError

pub(all) enum ApiError {
  ElementNotFound(selector~ : String)
  PageNotFound(page_id~ : String)
  ContextNotFound(context_id~ : String)
  Timeout(message~ : String)
  NavigationFailed(url~ : String, reason~ : String)
  ElementNotVisible(element_id~ : String)
  ElementNotEnabled(element_id~ : String)
  EvalError(message~ : String)
  InvalidArgument(message~ : String)
  NotSupported(message~ : String)
  InternalError(message~ : String)
} derive(@moonbitlang/core/debug.Debug
Debug)

API error

impl Show for ApiError

#
ApiMethod

source

pub(all) enum ApiMethod {
  NewContext
  CloseContext(context_id~ : String)
  NewPage(context_id~ : String)
  ClosePage(page_id~ : String)
  Pages(context_id~ : String)
  Goto(page_id~ : String, url~ : String)
  GoBack(page_id~ : String)
  GoForward(page_id~ : String)
  Reload(page_id~ : String)
  Url(page_id~ : String)
  Title(page_id~ : String)
  Query(page_id~ : String, selector~ : String)
  QueryAll(page_id~ : String, selector~ : String)
  WaitFor(page_id~ : String, selector~ : String, timeout~ : Int)
  BoundingBox(element_id~ : String)
  TextContent(element_id~ : String)
  InnerText(element_id~ : String)
  InnerHtml(element_id~ : String)
  GetAttribute(element_id~ : String, name~ : String)
  IsVisible(element_id~ : String)
  IsEnabled(element_id~ : String)
  IsChecked(element_id~ : String)
  Click(element_id~ : String)
  DblClick(element_id~ : String)
  RightClick(element_id~ : String)
  Hover(element_id~ : String)
  Focus(element_id~ : String)
  Fill(element_id~ : String, value~ : String)
  Press(element_id~ : String, key~ : String)
  Clear(element_id~ : String)
  SelectOption(element_id~ : String, value~ : String)
  Check(element_id~ : String)
  Uncheck(element_id~ : String)
  MouseMove(page_id~ : String, x~ : Double, y~ : Double)
  MouseClick(page_id~ : String, x~ : Double, y~ : Double, button~ : String)
  MouseDown(page_id~ : String, button~ : String)
  MouseUp(page_id~ : String, button~ : String)
  KeyboardPress(page_id~ : String, key~ : String)
  KeyboardType(page_id~ : String, text~ : String)
  Content(page_id~ : String)
  SetContent(page_id~ : String, html~ : String)
  ViewportSize(page_id~ : String)
  SetViewportSize(page_id~ : String, width~ : Int, height~ : Int)
  Evaluate(page_id~ : String, expression~ : String)
  Screenshot(page_id~ : String)
  ElementScreenshot(element_id~ : String)
  AccessibilitySnapshot(page_id~ : String)
} derive(@moonbitlang/core/debug.Debug
Debug)

All API methods as an enum for JSON-RPC dispatch

impl Show for ApiMethod

#
ApiResult

source

pub(all) enum ApiResult[T] {
  Ok(T)
  Err(ApiError)
} derive(@moonbitlang/core/debug.Debug
Debug)

API result - success or error

#
Capabilities

source

pub(all) struct Capabilities {
  browser_name : String
  browser_version : String
  platform_name : String
  accept_insecure_certs : Bool
  page_load_strategy : PageLoadStrategy
  proxy : ProxyConfig?
  timeouts : Timeouts
} derive(@moonbitlang/core/debug.Debug
Debug)

Browser capabilities

#
Capabilities::to_json

source

fn Capabilities::to_json(self : Capabilities) -> String

Serialize Capabilities to JSON string

#
ContextId

source

pub(all) struct ContextId {
  id : String
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Unique identifier for browser contexts

#
ElementId

source

pub(all) struct ElementId {
  id : String
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Unique identifier for browser elements

#
ElementRect

source

pub(all) struct ElementRect {
  x : Double
  y : Double
  width : Double
  height : Double
} derive(@moonbitlang/core/debug.Debug
Debug)

Element rectangle (with floating point)

#
ElementRect::to_json

source

fn ElementRect::to_json(self : ElementRect) -> String

Serialize ElementRect to JSON string

#
ErrorCode

source

pub(all) enum ErrorCode {
  ElementClickIntercepted
  ElementNotInteractable
  InsecureCertificate
  InvalidArgument
  InvalidCookieDomain
  InvalidElementState
  InvalidSelector
  InvalidSessionId
  JavascriptError
  MoveTargetOutOfBounds
  NoSuchAlert
  NoSuchCookie
  NoSuchElement
  NoSuchFrame
  NoSuchWindow
  ScriptTimeout
  SessionNotCreated
  StaleElementReference
  Timeout
  UnableToSetCookie
  UnableToCaptureScreen
  UnexpectedAlertOpen
  UnknownCommand
  UnknownError
  UnknownMethod
  UnsupportedOperation
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

WebDriver error codes as defined in W3C spec

#
ErrorCode::http_status

source

fn ErrorCode::http_status(self : ErrorCode) -> Int

HTTP status code for error

#
ErrorCode::to_string

source

fn ErrorCode::to_string(self : ErrorCode) -> String

Convert error code to string

#
HttpMethod

source

pub(all) enum HttpMethod {
  Get
  Post
  Delete
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

HTTP method

#
LocatorStrategy

source

pub(all) enum LocatorStrategy {
  CssSelector
  LinkText
  PartialLinkText
  TagName
  XPath
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Element location strategy

#
LocatorStrategy::from_string

source

fn LocatorStrategy::from_string(s : String) -> LocatorStrategy?

Parse strategy from string

#
LocatorStrategy::to_string

source

fn LocatorStrategy::to_string(self : LocatorStrategy) -> String

Convert strategy to string

#
Modifiers

source

pub(all) struct Modifiers {
  ctrl : Bool
  shift : Bool
  alt : Bool
  meta : Bool
} derive(@moonbitlang/core/debug.Debug
Debug)

Keyboard modifier keys

#
Modifiers::none

source

fn Modifiers::none() -> Modifiers

Default modifiers (none pressed)

#
MouseButton

source

pub(all) enum MouseButton {
  Left
  Right
  Middle
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Mouse button

#
PageId

source

pub(all) struct PageId {
  id : String
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Unique identifier for browser pages/tabs

#
PageLoadStrategy

source

pub(all) enum PageLoadStrategy {
  None
  Eager
  Normal
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

Page load strategy

#
PageLoadStrategy::to_json_string

source

fn PageLoadStrategy::to_json_string(self : PageLoadStrategy) -> String

Page load strategy to JSON string value

#
Point

source

pub(all) struct Point {
  x : Double
  y : Double
} derive(@moonbitlang/core/debug.Debug
Debug)

Point in 2D space

#
ProxyConfig

source

pub(all) struct ProxyConfig {
  proxy_type : String
  proxy_autoconfig_url : String?
  ftp_proxy : String?
  http_proxy : String?
  no_proxy : Array[String]
  ssl_proxy : String?
  socks_proxy : String?
  socks_version : Int?
} derive(@moonbitlang/core/debug.Debug
Debug)

Proxy configuration

#
Rect

source

pub(all) struct Rect {
  x : Double
  y : Double
  width : Double
  height : Double
} derive(@moonbitlang/core/debug.Debug
Debug)

Rectangle with position and size

#
Selector

source

pub(all) enum Selector {
  Css(String)
  XPath(String)
  Text(String)
  TextContains(String)
  Role(role~ : String, name~ : String?)
  TestId(String)
  Label(String)
  Placeholder(String)
  AltText(String)
  Title(String)
} derive(@moonbitlang/core/debug.Debug
Debug)

Element selector strategy

#
Selector::to_string

source

fn Selector::to_string(self : Selector) -> String

Convert selector to string representation

#
Session

source

pub(all) struct Session {
  id : String
  capabilities : Capabilities
} derive(@moonbitlang/core/debug.Debug
Debug)

Session information

#
Session::to_json

source

fn Session::to_json(self : Session) -> String

Serialize Session to JSON string

#
Timeouts

source

pub(all) struct Timeouts {
  script : Int
  page_load : Int
  implicit : Int
} derive(@moonbitlang/core/debug.Debug
Debug)

Timeout settings

#
Timeouts::default

source

fn Timeouts::default() -> Timeouts

Default timeouts

#
Timeouts::to_json

source

fn Timeouts::to_json(self : Timeouts) -> String

Serialize Timeouts to JSON string

#
Viewport

source

pub(all) struct Viewport {
  width : Int
  height : Int
} derive(@moonbitlang/core/debug.Debug
Debug)

Viewport size

#
WebDriverCommand

source

pub(all) enum WebDriverCommand {
  Status
  NewSession
  DeleteSession(session_id~ : String)
  GetSession(session_id~ : String)
  GetTimeouts(session_id~ : String)
  SetTimeouts(session_id~ : String)
  NavigateTo(session_id~ : String)
  GetCurrentUrl(session_id~ : String)
  Back(session_id~ : String)
  Forward(session_id~ : String)
  Refresh(session_id~ : String)
  GetTitle(session_id~ : String)
  GetWindowHandle(session_id~ : String)
  CloseWindow(session_id~ : String)
  SwitchToWindow(session_id~ : String)
  GetWindowHandles(session_id~ : String)
  NewWindow(session_id~ : String)
  SwitchToFrame(session_id~ : String)
  SwitchToParentFrame(session_id~ : String)
  GetWindowRect(session_id~ : String)
  SetWindowRect(session_id~ : String)
  MaximizeWindow(session_id~ : String)
  MinimizeWindow(session_id~ : String)
  FullscreenWindow(session_id~ : String)
  FindElement(session_id~ : String)
  FindElements(session_id~ : String)
  FindElementFromElement(session_id~ : String, element_id~ : String)
  FindElementsFromElement(session_id~ : String, element_id~ : String)
  GetActiveElement(session_id~ : String)
  IsElementSelected(session_id~ : String, element_id~ : String)
  GetElementAttribute(session_id~ : String, element_id~ : String, name~ : String)
  GetElementProperty(session_id~ : String, element_id~ : String, name~ : String)
  GetElementCssValue(session_id~ : String, element_id~ : String, name~ : String)
  GetElementText(session_id~ : String, element_id~ : String)
  GetElementTagName(session_id~ : String, element_id~ : String)
  GetElementRect(session_id~ : String, element_id~ : String)
  IsElementEnabled(session_id~ : String, element_id~ : String)
  ElementClick(session_id~ : String, element_id~ : String)
  ElementClear(session_id~ : String, element_id~ : String)
  ElementSendKeys(session_id~ : String, element_id~ : String)
  GetPageSource(session_id~ : String)
  ExecuteScript(session_id~ : String)
  ExecuteAsyncScript(session_id~ : String)
  GetAllCookies(session_id~ : String)
  GetNamedCookie(session_id~ : String, name~ : String)
  AddCookie(session_id~ : String)
  DeleteCookie(session_id~ : String, name~ : String)
  DeleteAllCookies(session_id~ : String)
  PerformActions(session_id~ : String)
  ReleaseActions(session_id~ : String)
  DismissAlert(session_id~ : String)
  AcceptAlert(session_id~ : String)
  GetAlertText(session_id~ : String)
  SendAlertText(session_id~ : String)
  TakeScreenshot(session_id~ : String)
  TakeElementScreenshot(session_id~ : String, element_id~ : String)
  PrintPage(session_id~ : String)
  Unknown(path~ : String)
} derive(@moonbitlang/core/debug.Debug
Debug)

WebDriver commands (endpoints)

impl Show for WebDriverCommand

#
WebDriverError

source

pub(all) struct WebDriverError {
  error : ErrorCode
  message : String
  stacktrace : String
} derive(@moonbitlang/core/debug.Debug
Debug)

WebDriver error response

#
WebDriverError::to_json

source

fn WebDriverError::to_json(self : WebDriverError) -> String

Serialize WebDriverError to JSON string

#
WebDriverRequest

source

pub(all) struct WebDriverRequest {
  http_method : HttpMethod
  command : WebDriverCommand
  body : String
} derive(@moonbitlang/core/debug.Debug
Debug)

Parsed WebDriver command from HTTP request

#
WebDriverResponse

source

pub(all) enum WebDriverResponse {
  Success(WebDriverValue)
  Error(WebDriverError)
} derive(@moonbitlang/core/debug.Debug
Debug)

WebDriver response (success or error)

#
WebDriverResponse::to_json

source

fn WebDriverResponse::to_json(self : WebDriverResponse) -> String

Serialize WebDriverResponse to JSON string

#
WebDriverValue

source

pub(all) enum WebDriverValue {
  Null
  Bool(Bool)
  String(String)
  Number(Double)
  Array(Array[WebDriverValue])
  Object(Map[String, WebDriverValue])
  Element(element_id~ : String)
} derive(@moonbitlang/core/debug.Debug
Debug)

WebDriver success value

#
WebDriverValue::to_json

source

fn WebDriverValue::to_json(self : WebDriverValue) -> String

Serialize WebDriverValue to JSON string

#
WindowRect

source

pub(all) struct WindowRect {
  x : Int
  y : Int
  width : Int
  height : Int
} derive(@moonbitlang/core/debug.Debug
Debug)

Window rectangle

#
WindowRect::to_json

source

fn WindowRect::to_json(self : WindowRect) -> String

Serialize WindowRect to JSON string

#
error_response

source

fn error_response(code : ErrorCode, message : String) -> WebDriverResponse

Create error response

#
escape_json_string

source

fn escape_json_string(s : String) -> String

Escape string for JSON

#
parse_request

source

fn parse_request(method_str : String, path : String, body : String) -> WebDriverRequest

Parse HTTP request into WebDriverRequest

#
success_bool

source

fn success_bool(b : Bool) -> WebDriverResponse

Create success response with bool value

#
success_element

source

fn success_element(element_id : String) -> WebDriverResponse

Create success response with element reference

#
success_null

source

fn success_null() -> WebDriverResponse

Create success response with null value

#
success_object

source

fn success_object(map : Map[String, WebDriverValue]) -> WebDriverResponse

Create success response with object value

#
success_string

source

fn success_string(s : String) -> WebDriverResponse

Create success response with string value

Source Files

Install

moon add mizchi/crater-webdriver-bidi@0.19.0

Download zip

WebDriver BiDi adapter module for crater browser integration

mizchi

0.19.0

Apache-2.0

github.com/mizchi/crater

Updated last month

28 downloads

Dependencies

Site source Report issue Packages Build queue Skills Statistics

#ApiError

#ApiMethod

#ApiResult

#Capabilities

#Capabilities::to_json

#ContextId

#ElementId

#ElementRect

#ElementRect::to_json

#ErrorCode

#ErrorCode::http_status

#ErrorCode::to_string

#HttpMethod

#LocatorStrategy

#LocatorStrategy::from_string

#LocatorStrategy::to_string

#Modifiers

#Modifiers::none

#MouseButton

#PageId

#PageLoadStrategy

#PageLoadStrategy::to_json_string

#Point

#ProxyConfig

#Rect

#Selector

#Selector::to_string

#Session

#Session::to_json

#Timeouts

#Timeouts::default

#Timeouts::to_json

#Viewport

#WebDriverCommand

#WebDriverError

#WebDriverError::to_json

#WebDriverRequest

#WebDriverResponse

#WebDriverResponse::to_json

#WebDriverValue

#WebDriverValue::to_json

#WindowRect

#WindowRect::to_json

#error_response

#escape_json_string

#parse_request

#success_bool

#success_element

#success_null

#success_object

#success_string

Source Files

#
ApiError

#
ApiMethod

#
ApiResult

#
Capabilities

#
Capabilities::to_json

#
ContextId

#
ElementId

#
ElementRect

#
ElementRect::to_json

#
ErrorCode

#
ErrorCode::http_status

#
ErrorCode::to_string

#
HttpMethod

#
LocatorStrategy

#
LocatorStrategy::from_string

#
LocatorStrategy::to_string

#
Modifiers

#
Modifiers::none

#
MouseButton

#
PageId

#
PageLoadStrategy

#
PageLoadStrategy::to_json_string

#
Point

#
ProxyConfig

#
Rect

#
Selector

#
Selector::to_string

#
Session

#
Session::to_json

#
Timeouts

#
Timeouts::default

#
Timeouts::to_json

#
Viewport

#
WebDriverCommand

#
WebDriverError

#
WebDriverError::to_json

#
WebDriverRequest

#
WebDriverResponse

#
WebDriverResponse::to_json

#
WebDriverValue

#
WebDriverValue::to_json

#
WindowRect

#
WindowRect::to_json

#
error_response

#
escape_json_string

#
parse_request

#
success_bool

#
success_element

#
success_null

#
success_object

#
success_string