Safe Haskell	None
Language	Haskell2010

WebDriverPreCore

Contents

Introduction
The API
HTTP Response
Capabilities
Errors
Action Types
Auxiliary Spec Types

Synopsis

data W3Spec a
- = Get {
  - description :: Text
  - path :: UrlPath
  - parser :: HttpResponse -> Result a
  }
- | Post {
  - description :: Text
  - path :: UrlPath
  - body :: Value
  - parser :: HttpResponse -> Result a
  }
- | PostEmpty {
  - description :: Text
  - path :: UrlPath
  - parser :: HttpResponse -> Result a
  }
- | Delete {
  - description :: Text
  - path :: UrlPath
  - parser :: HttpResponse -> Result a
  }
newSession :: FullCapabilities -> W3Spec SessionId
newSession' :: ToJSON a => a -> W3Spec SessionId
status :: W3Spec DriverStatus
acceptAlert :: SessionId -> W3Spec ()
addCookie :: SessionId -> Cookie -> W3Spec ()
back :: SessionId -> W3Spec ()
closeWindow :: SessionId -> W3Spec ()
deleteAllCookies :: SessionId -> W3Spec ()
deleteCookie :: SessionId -> Text -> W3Spec ()
deleteSession :: SessionId -> W3Spec ()
dismissAlert :: SessionId -> W3Spec ()
executeScript :: SessionId -> Text -> [Value] -> W3Spec Value
executeScriptAsync :: SessionId -> Text -> [Value] -> W3Spec Value
forward :: SessionId -> W3Spec ()
fullscreenWindow :: SessionId -> W3Spec WindowRect
getAlertText :: SessionId -> W3Spec Text
getAllCookies :: SessionId -> W3Spec [Cookie]
getCurrentUrl :: SessionId -> W3Spec Text
getNamedCookie :: SessionId -> Text -> W3Spec Cookie
getPageSource :: SessionId -> W3Spec Text
getTimeouts :: SessionId -> W3Spec Timeouts
getTitle :: SessionId -> W3Spec Text
getWindowHandle :: SessionId -> W3Spec WindowHandle
getWindowHandles :: SessionId -> W3Spec [WindowHandle]
getWindowRect :: SessionId -> W3Spec WindowRect
maximizeWindow :: SessionId -> W3Spec WindowRect
minimizeWindow :: SessionId -> W3Spec WindowRect
navigateTo :: SessionId -> Text -> W3Spec ()
newWindow :: SessionId -> W3Spec WindowHandleSpec
performActions :: SessionId -> Actions -> W3Spec ()
printPage :: SessionId -> W3Spec Text
refresh :: SessionId -> W3Spec ()
releaseActions :: SessionId -> W3Spec ()
sendAlertText :: SessionId -> Text -> W3Spec ()
setTimeouts :: SessionId -> Timeouts -> W3Spec ()
setWindowRect :: SessionId -> WindowRect -> W3Spec WindowRect
switchToFrame :: SessionId -> FrameReference -> W3Spec ()
switchToWindow :: SessionId -> WindowHandle -> W3Spec ()
takeScreenshot :: SessionId -> W3Spec Text
closeWindow :: SessionId -> W3Spec ()
fullscreenWindow :: SessionId -> W3Spec WindowRect
getWindowHandles :: SessionId -> W3Spec [WindowHandle]
getWindowRect :: SessionId -> W3Spec WindowRect
maximizeWindow :: SessionId -> W3Spec WindowRect
minimizeWindow :: SessionId -> W3Spec WindowRect
newWindow :: SessionId -> W3Spec WindowHandleSpec
setWindowRect :: SessionId -> WindowRect -> W3Spec WindowRect
switchToWindow :: SessionId -> WindowHandle -> W3Spec ()
switchToParentFrame :: SessionId -> W3Spec ()
findElement :: SessionId -> Selector -> W3Spec ElementId
findElements :: SessionId -> Selector -> W3Spec [ElementId]
getActiveElement :: SessionId -> W3Spec ElementId
elementClear :: SessionId -> ElementId -> W3Spec ()
elementClick :: SessionId -> ElementId -> W3Spec ()
elementSendKeys :: SessionId -> ElementId -> Text -> W3Spec ()
findElementFromElement :: SessionId -> ElementId -> Selector -> W3Spec ElementId
findElementsFromElement :: SessionId -> ElementId -> Selector -> W3Spec [ElementId]
getElementAttribute :: SessionId -> ElementId -> Text -> W3Spec Text
getElementComputedLabel :: SessionId -> ElementId -> W3Spec Text
getElementComputedRole :: SessionId -> ElementId -> W3Spec Text
getElementCssValue :: SessionId -> ElementId -> Text -> W3Spec Text
getElementProperty :: SessionId -> ElementId -> Text -> W3Spec Value
getElementRect :: SessionId -> ElementId -> W3Spec WindowRect
getElementShadowRoot :: SessionId -> ElementId -> W3Spec ElementId
getElementTagName :: SessionId -> ElementId -> W3Spec Text
getElementText :: SessionId -> ElementId -> W3Spec Text
isElementEnabled :: SessionId -> ElementId -> W3Spec Bool
isElementSelected :: SessionId -> ElementId -> W3Spec Bool
takeElementScreenshot :: SessionId -> ElementId -> W3Spec Text
findElementFromShadowRoot :: SessionId -> ElementId -> Selector -> W3Spec ElementId
findElementsFromShadowRoot :: SessionId -> ElementId -> Selector -> W3Spec [ElementId]
data HttpResponse = MkHttpResponse {
- statusCode :: Int
- statusMessage :: Text
- body :: Value
}
data Capabilities = MkCapabilities {
- browserName :: Maybe BrowserName
- browserVersion :: Maybe Text
- platformName :: Maybe PlatformName
- acceptInsecureCerts :: Maybe Bool
- pageLoadStrategy :: Maybe PageLoadStrategy
- proxy :: Maybe Proxy
- timeouts :: Maybe Timeouts
- strictFileInteractability :: Maybe Bool
- unhandledPromptBehavior :: Maybe UnhandledPromptBehavior
- vendorSpecific :: Maybe VendorSpecific
}
data FullCapabilities = MkFullCapabilities {
- alwaysMatch :: Maybe Capabilities
- firstMatch :: [Capabilities]
}
data LogLevel
- = Trace
- | Debug
- | Config
- | Info
- | Warning
- | Error
- | Fatal
- | Off
data Proxy
- = Direct
- | Manual {
  - ftpProxy :: Maybe Text
  - httpProxy :: Maybe Text
  - sslProxy :: Maybe Text
  - socksProxy :: Maybe SocksProxy
  - noProxy :: Maybe [Text]
  }
- | AutoDetect
- | System
- | Pac {
  - proxyAutoconfigUrl :: Text
  }
data BrowserName
- = Chrome
- | Firefox
- | Safari
- | Edge
- | InternetExplorer
data DeviceMetrics = MkDeviceMetrics {
- width :: Int
- height :: Int
- pixelRatio :: Double
- touch :: Bool
}
data Capabilities = MkCapabilities {
- browserName :: Maybe BrowserName
- browserVersion :: Maybe Text
- platformName :: Maybe PlatformName
- acceptInsecureCerts :: Maybe Bool
- pageLoadStrategy :: Maybe PageLoadStrategy
- proxy :: Maybe Proxy
- timeouts :: Maybe Timeouts
- strictFileInteractability :: Maybe Bool
- unhandledPromptBehavior :: Maybe UnhandledPromptBehavior
- vendorSpecific :: Maybe VendorSpecific
}
data UnhandledPromptBehavior
- = Dismiss
- | Accept
- | DismissAndNotify
- | AcceptAndNotify
- | Ignore
data FullCapabilities = MkFullCapabilities {
- alwaysMatch :: Maybe Capabilities
- firstMatch :: [Capabilities]
}
data Timeouts = MkTimeouts {
- implicit :: Maybe Int
- pageLoad :: Maybe Int
- script :: Maybe Int
}
data PageLoadStrategy
- = None'
- | Eager
- | Normal
data PlatformName
- = Windows
- | Mac
- | Linux
- | Android
- | IOS
data VendorSpecific
- = ChromeOptions {
  - chromeArgs :: Maybe [Text]
  - chromeBinary :: Maybe Text
  - chromeExtensions :: Maybe [Text]
  - chromeLocalState :: Maybe (Map Text Value)
  - chromeMobileEmulation :: Maybe MobileEmulation
  - chromePrefs :: Maybe (Map Text Value)
  - chromeDetach :: Maybe Bool
  - chromeDebuggerAddress :: Maybe Text
  - chromeExcludeSwitches :: Maybe [Text]
  - chromeMinidumpPath :: Maybe FilePath
  - chromePerfLoggingPrefs :: Maybe PerfLoggingPrefs
  - chromeWindowTypes :: Maybe [Text]
  }
- | EdgeOptions {
  - edgeArgs :: Maybe [Text]
  - edgeBinary :: Maybe Text
  - edgeExtensions :: Maybe [Text]
  - edgeLocalState :: Maybe (Map Text Value)
  - edgeMobileEmulation :: Maybe MobileEmulation
  - edgePrefs :: Maybe (Map Text Value)
  - edgeDetach :: Maybe Bool
  - edgeDebuggerAddress :: Maybe Text
  - edgeExcludeSwitches :: Maybe [Text]
  - edgeMinidumpPath :: Maybe FilePath
  - edgePerfLoggingPrefs :: Maybe PerfLoggingPrefs
  - edgeWindowTypes :: Maybe [Text]
  }
- | FirefoxOptions {
  - firefoxArgs :: Maybe [Text]
  - firefoxBinary :: Maybe Text
  - firefoxProfile :: Maybe Text
  - firefoxLog :: Maybe LogSettings
  }
- | SafariOptions {
  - safariAutomaticInspection :: Maybe Bool
  - safariAutomaticProfiling :: Maybe Bool
  }
data SocksProxy = MkSocksProxy {
- socksProxy :: Text
- socksVersion :: Int
}
data PerfLoggingPrefs = MkPerfLoggingPrefs {
- enableNetwork :: Maybe Bool
- enablePage :: Maybe Bool
- enableTimeline :: Maybe Bool
- traceCategories :: Maybe Text
- bufferUsageReportingInterval :: Maybe Int
}
data MobileEmulation = MkMobileEmulation {
- deviceName :: Maybe Text
- deviceMetrics :: Maybe DeviceMetrics
- userAgent :: Maybe Text
}
data LogSettings = MkLogSettings {
- level :: LogLevel
}
minCapabilities :: BrowserName -> Capabilities
minFullCapabilities :: BrowserName -> FullCapabilities
minFirefoxCapabilities :: FullCapabilities
minChromeCapabilities :: FullCapabilities
data ErrorClassification
- = NotAnError {
  - httpResponse :: HttpResponse
  }
- | UnrecognisedError {
  - httpResponse :: HttpResponse
  }
- | WebDriverError {
  - error :: WebDriverErrorType
  - description :: Text
  - httpResponse :: HttpResponse
  }
data WebDriverErrorType
- = ElementClickIntercepted
- | ElementNotInteractable
- | InsecureCertificate
- | InvalidArgument
- | InvalidCookieDomain
- | InvalidElementState
- | InvalidSelector
- | InvalidSessionId
- | JavascriptError
- | MoveTargetOutOfBounds
- | NoSuchAlert
- | NoSuchCookie
- | NoSuchElement
- | NoSuchFrame
- | NoSuchWindow
- | NoSuchShadowRoot
- | ScriptTimeoutError
- | SessionNotCreated
- | StaleElementReference
- | DetachedShadowRoot
- | Timeout
- | UnableToSetCookie
- | UnableToCaptureScreen
- | UnexpectedAlertOpen
- | UnknownCommand
- | UnknownError
- | UnknownMethod
- | UnsupportedOperation
errorDescription :: WebDriverErrorType -> Text
errorCodeToErrorType :: Text -> Either Text WebDriverErrorType
errorTypeToErrorCode :: WebDriverErrorType -> Text
parseWebDriverError :: HttpResponse -> ErrorClassification
parseWebDriverErrorType :: HttpResponse -> Maybe WebDriverErrorType
data Action
- = NoneAction {
  - id :: Text
  - noneActions :: [Maybe Int]
  }
- | Key {
  - id :: Text
  - keyActions :: [KeyAction]
  }
- | Pointer {
  - id :: Text
  - subType :: Pointer
  - pointerId :: Int
  - pressed :: Set Int
  - x :: Int
  - y :: Int
  - actions :: [PointerAction]
  }
- | Wheel {
  - id :: Text
  - wheelActions :: [WheelAction]
  }
data KeyAction
- = PauseKey {
  - duration :: Maybe Int
  }
- | KeyDown {
  - value :: Text
  }
- | KeyUp {
  - value :: Text
  }
data PointerAction
- = PausePointer {
  - duration :: Maybe Int
  }
- | Up {
  - button :: Int
  - width :: Maybe Int
  - height :: Maybe Int
  - pressure :: Maybe Float
  - tangentialPressure :: Maybe Float
  - tiltX :: Maybe Int
  - tiltY :: Maybe Int
  - twist :: Maybe Int
  - altitudeAngle :: Maybe Double
  - azimuthAngle :: Maybe Double
  }
- | Down {
  - button :: Int
  - width :: Maybe Int
  - height :: Maybe Int
  - pressure :: Maybe Float
  - tangentialPressure :: Maybe Float
  - tiltX :: Maybe Int
  - tiltY :: Maybe Int
  - twist :: Maybe Int
  - altitudeAngle :: Maybe Double
  - azimuthAngle :: Maybe Double
  }
- | Move {
  - origin :: PointerOrigin
  - duration :: Maybe Int
  - width :: Maybe Int
  - height :: Maybe Int
  - pressure :: Maybe Float
  - tangentialPressure :: Maybe Float
  - tiltX :: Maybe Int
  - tiltY :: Maybe Int
  - twist :: Maybe Int
  - altitudeAngle :: Maybe Double
  - azimuthAngle :: Maybe Double
  - x :: Int
  - y :: Int
  }
- | Cancel
newtype Actions = MkActions {
- actions :: [Action]
}
data Pointer
- = Mouse
- | Pen
- | Touch
data PointerOrigin
- = Viewport
- | OriginPointer
- | OriginElement ElementId
data WheelAction
- = PauseWheel {
  - duration :: Maybe Int
  }
- | Scroll {
  - origin :: PointerOrigin
  - x :: Int
  - y :: Int
  - deltaX :: Int
  - deltaY :: Int
  - duration :: Maybe Int
  }
newtype WindowHandle = Handle {
- handle :: Text
}
data WindowHandleSpec = HandleSpec {
- handle :: WindowHandle
- handletype :: HandleType
}
data Selector
- = CSS Text
- | XPath Text
- | LinkText Text
- | PartialLinkText Text
- | TagName Text
data Cookie = MkCookie {
- name :: Text
- value :: Text
- path :: Maybe Text
- domain :: Maybe Text
- secure :: Maybe Bool
- httpOnly :: Maybe Bool
- sameSite :: Maybe SameSite
- expiry :: Maybe Int
}
newtype SessionId = Session {
- id :: Text
}
newtype ElementId = Element {
- id :: Text
}
data SameSite
- = Lax
- | Strict
- | None
newtype UrlPath = MkUrlPath {
- segments :: [Text]
}
data DriverStatus
- = Ready
- | Running
- | ServiceError {
  - statusCode :: Int
  - statusMessage :: Text
  }
- | Unknown {
  - statusCode :: Int
  - statusMessage :: Text
  }
data HttpResponse = MkHttpResponse {
- statusCode :: Int
- statusMessage :: Text
- body :: Value
}
data FrameReference
- = TopLevelFrame
- | FrameNumber Word16
- | FrameElementId ElementId
data Timeouts = MkTimeouts {
- implicit :: Maybe Int
- pageLoad :: Maybe Int
- script :: Maybe Int
}
data WindowRect = Rect {
- x :: Int
- y :: Int
- width :: Int
- height :: Int
}

Introduction

What is This Library?

This library provides a minimal abstraction over the WebDriver W3C Protocol endpoints without providing any implementation. It provides a description of the W3C API as a list of functions returning a W3Spec. The intention is that other libraries will provide the actual implementation.

You can not use this library directly to drive a browser. If you are looking for a library to drive a browser, you may be interested in an alternative library such haskell-webdriver.

Why This Library?

There are a number of libraries that provide WebDriver bindings for Haskell. However, at the time work on this library commenced the available libraries were either in need of maintenance, required Selenium, or part of larger opinionated testing frameworks.

The goal of the authors of this library is to enable browser interaction in our own high level testing framework. We would prefer to communicate with drivers directly, using the W3C standards (developed largely by the Selenium core contributors) rather than depend on Selenium itself. We would also like to avoid pulling in too many dependencies or potentially incompatible concepts from other high level libraries. To achieve this, we plan to first develop a number of unopinionated, lower level libraries that can be used by others without buying into our entire stack.

This library is the first of those libraries, and is intended to provide a low-dependency base on which fully featured (W3C) WebDriver libraries can be built.

Implementing WebDriver Interaction

Using webdriver-precore to build a webdriver library requires two steps to attain the basic functionality provided by the WebDriver API:

Implement a runner (run function) that, given a W3Spec, can make HTTP requests to the WebDriver server and parse the response.
Apply the runner to the W3Spec functions provided by this library to transform the W3Spec into actual IO browser interactions (this is just boilerplate).

1. Implementing a runner

This is an example of a minimal runner that implements the interaction with WebDriver endpoint definitions as provided by this library.

The first step in writing a WebDriver implementation is to choose an HTTP library. In this example we have chosen req.

Then to implement a run function requires the following:

Define a function to transform a W3Spec to RequestParams compatible with the chosen HTTP library.
Make an HTTP call to WebDriver as per the RequestParams and return a simplified HttpResponse.
Use the parser provided by the W3Spec to transform the HttpResponse to the desired result type and handle any errors.

Example

The full source for this example can be found in the project repo.

Module Header

Expand

  {-# LANGUAGE DataKinds #-}
  {-# LANGUAGE DuplicateRecordFields #-}
  {-# LANGUAGE ExistentialQuantification #-}
  {-# LANGUAGE GADTs #-}
  {-# LANGUAGE LambdaCase #-}
  {-# LANGUAGE NamedFieldPuns #-}
  {-# LANGUAGE NoImplicitPrelude #-}
  {-# LANGUAGE OverloadedRecordDot #-}
  {-# LANGUAGE OverloadedStrings #-}
  {-# LANGUAGE NoFieldSelectors #-}
  module IORunnerMinimal ( run ) where
  import Data.Aeson (Result (..), Value, object)
  import Data.Function ((&), ($), (.))
  import Data.Text  as T (Text, unpack)
  import Data.Text.Encoding (decodeUtf8Lenient)
  import WebDriverPreCore (
    HttpResponse (..),
    W3Spec (..),
    parseWebDriverError,
    ErrorClassification (..),
    UrlPath (..) )
  import GHC.IO (IO)
  import Data.Int (Int)
  import Control.Monad (Monad(..))
  import Data.Foldable (foldl')
  import GHC.Maybe (Maybe(..))
  import Control.Applicative (Applicative(..))
  import Control.Monad.Fail (MonadFail(..))
  import Data.Monoid ((<>))
  import GHC.Show (Show(..))
  import Network.HTTP.Req as R
    ( DELETE (DELETE),
      GET (GET),
      NoReqBody (NoReqBody),
      POST (POST),
      ReqBodyJson (ReqBodyJson),
      JsonResponse,
      defaultHttpConfig,
      http,
      jsonResponse,
      port,
      req,
      responseBody,
      responseStatusCode,
      responseStatusMessage,
      runReq,
      HttpConfig (httpConfigCheckResponse), (/:), HttpBodyAllowed, HttpMethod (..), ProvidesBody, HttpBody, Url, Scheme (..),
    )

`run` function

run :: W3Spec a -> IO a
run spec = do
  let request = mkRequest spec -- 1. Convert W3Spec to params for req
  response <- callReq request  -- 2. Call WebDriver server (via req) and return a simplified HttpResponse
  parseResponse spec response  -- 3. Use the W3Spec parser to convert the HttpResponse to the desired result type and handle any errors

1.1 `W3Spec` -> `ReqRequestParams`

Transform W3Spec to ReqRequestParams

-- ReqRequestParams are specific to the chosen HTTP library (in this example req)
-- The port would not normally be hard coded

mkRequest :: forall a. W3Spec a -> ReqRequestParams
mkRequest spec = case spec of
  Get {} -> MkRequestParams url GET NoReqBody 4444
  Post {body} -> MkRequestParams url POST (ReqBodyJson body) 4444
  PostEmpty {} -> MkRequestParams url POST (ReqBodyJson $ object []) 4444
  Delete {} -> MkRequestParams url DELETE NoReqBody 4444
  where
    url =  foldl' (/:) (http "127.0.0.1") spec.path.segments

-- A custom data type for request params specific to req

data ReqRequestParams where
  MkRequestParams ::
    (HttpBodyAllowed (AllowsBody method) (ProvidesBody body), HttpMethod method, HttpBody body) =>
    { url :: Url 'Http,
      method :: method,
      body :: body,
      port :: Int
    } ->
    ReqRequestParams

1.2 Call the WebDriver

Call WebDriver endpoints based on ReqRequestParams

callReq :: ReqRequestParams -> IO HttpResponse
callReq MkRequestParams {url, method, body, port = prt} =
  runReq defaultHttpConfig {httpConfigCheckResponse = \_ _ _ -> Nothing} $ do
    r <- req method url body jsonResponse $ port prt
    pure $
      MkHttpResponse
        { statusCode = responseStatusCode r,
          statusMessage = responseStatusText r,
          body = responseBody r :: Value
        }
  where
    responseStatusText = decodeUtf8Lenient . responseStatusMessage

1.3 Parse `HttpResponse` using the parser provided by `W3Spec`

Parse the WebDriver response (in this implimentation we are just throwing exceptions on failure)

parseResponse :: W3Spec a -> HttpResponse -> IO a
parseResponse spec r =
  spec.parser r
    & \case
      Error msg -> fail $ parseWebDriverError r & case
          e@NotAnError {} -> unpack spec.description <> "\n" <> "Failed to parse response:\n " <> msg <> "\nin response:" <> show e
          e@UnrecognisedError {} -> "UnrecognisedError:\n " <> "\nin response:" <> show e
          e@WebDriverError {} -> "WebDriver error thrown:\n " <> show e
      Success a -> pure a

2. Applying the `runner` to the `W3Spec` functions

Create an IO API by applying run to each endpoint definition exposed by this library

Full source can be found in the project repo

module IOAPI where 

import WebDriverPreCore qualified as W

status :: IO DriverStatus
status = run W.status

newSession :: W.FullCapabilities -> IO SessionId
newSession = run . W.newSession

getTimeouts :: SessionId -> IO W.Timeouts
getTimeouts = run . W.getTimeouts

setTimeouts :: SessionId -> W.Timeouts -> IO ()
setTimeouts s = run . W.setTimeouts s

getCurrentUrl :: SessionId -> IO Text
getCurrentUrl = run . W.getCurrentUrl

getTitle :: SessionId -> IO Text
getTitle = run . W.getTitle

maximizeWindow :: SessionId -> IO W.WindowRect
maximizeWindow = run . W.maximizeWindow

-- ... and 50+ more API functions

Using the API

Once all the required endpoints are implemented you will be able to interact with browsers via WebDriver

Prerequisites:

An appropriate browser and WebDriver installed.
WebDriver started.

e.g. For Firefox and geckodriver on Linux or WSL you could start geckodriver from the terminal as follows: Note: we are setting the port to 4444, which is the hard coded port in our example.

>>> pkill -f geckodriver || true  && geckodriver --port=4444 &

or with logging:

>>> pkill -f geckodriver || true  && geckodriver --log trace --port=4444 &

or similarly for Chrome and chromedriver:

>>> pkill -f chromedriver || true && chromedriver --port=4444 &

or with logging:

>>> pkill -f chromedriver || true && chromedriver --log-level=ALL --port=4444 &

With the driver running you can now interact with the browser:

Example: A full example source file can be found in the project repo.

demoForwardBackRefresh :: IO ()
demoForwardBackRefresh = do
  ses <- newSession $ minFullCapabilities Firefox
  navigateTo ses "https://the-internet.herokuapp.com/"
  link findElement ses $ CSS "#content ul:nth-child(4) > li:nth-child(6) > a:nth-child(1)"
  elementClick ses link
  back ses
  forward ses
  refresh ses
  deleteSession ses

Note this is a minimal API. There is plenty of scope to build on this to provide a more user-friendly functions.

The API

The W3Spec Type

data W3Spec a Source #

The W3Spec type is a specification for a WebDriver command. Every endpoint function in this module returns a W3Spec object.

Constructors

Get
Fields description :: Text path :: UrlPath parser :: HttpResponse -> Result a
Post
Fields description :: Text path :: UrlPath body :: Value parser :: HttpResponse -> Result a
PostEmpty
Fields description :: Text path :: UrlPath parser :: HttpResponse -> Result a
Delete
Fields description :: Text path :: UrlPath parser :: HttpResponse -> Result a

Instances

Instances details

Show a => Show (W3Spec a) Source #
Instance details Defined in WebDriverPreCore.SpecDefinition Methods showsPrec :: Int -> W3Spec a -> ShowS # show :: W3Spec a -> String # showList :: [W3Spec a] -> ShowS #

Root Methods

newSession :: FullCapabilities -> W3Spec SessionId Source #

Return a spec to create a new session given FullCapabilities object.

newSession' can be used if FullCapabilities doesn't meet your requirements.

spec

POST 	/session 	New Session

newSession' :: ToJSON a => a -> W3Spec SessionId Source #

Return a spec to create a new session given an object of any type that implements ToJSON.

The FullCapabilities type and associated types should work for the vast majority use cases, but if the required capabilities are not covered by the types provided, newSession'. can be used with a custom type instead. newSession' works with any type that implements ToJSON, (including an Aeson Value).

Obviously, any type used must produce a JSON object compatible with capabilities as defined W3C spec.

spec

POST 	/session 	New Session

status :: W3Spec DriverStatus Source #

Return a spec to get the status of the driver.

spec

GET 	/status 	Status

Session Methods

See also newSession and newSession'

acceptAlert :: SessionId -> W3Spec () Source #

Return a spec to accept an alert on the current page given a SessionId.

spec

POST 	/session/{session id}/alert/accept 	Accept Alert

addCookie :: SessionId -> Cookie -> W3Spec () Source #

Return a spec to add a cookie to the current page given a SessionId and Cookie.

spec

POST 	/session/{session id}/cookie 	Add Cookie

back :: SessionId -> W3Spec () Source #

Return a spec to navigate back in the browser history given a SessionId.

spec

POST 	/session/{session id}/back 	Back

closeWindow :: SessionId -> W3Spec () Source #

Return a spec to close the current window given a SessionId.

spec

DELETE 	/session/{session id}/window 	Close Window

deleteAllCookies :: SessionId -> W3Spec () Source #

Return a spec to delete all cookies from the current page given a SessionId.

spec

DELETE 	/session/{session id}/cookie 	Delete All Cookies

deleteCookie :: SessionId -> Text -> W3Spec () Source #

Return a spec to delete a named cookie from the current page given a SessionId and cookie name.

spec

DELETE 	/session/{session id}/cookie/{name} 	Delete Cookie

deleteSession :: SessionId -> W3Spec () Source #

Return a spec to delete a session given a SessionId.

spec

DELETE 	/session/{session id} 	Delete Session

dismissAlert :: SessionId -> W3Spec () Source #

Return a spec to dismiss an alert on the current page given a SessionId.

spec

POST 	/session/{session id}/alert/dismiss 	Dismiss Alert

executeScript :: SessionId -> Text -> [Value] -> W3Spec Value Source #

Return a spec to execute a script in the context of the current page given a SessionId, Text script, and a list of Value arguments.

spec

POST 	/session/{session id}/execute/sync 	Execute Script

executeScriptAsync :: SessionId -> Text -> [Value] -> W3Spec Value Source #

Return a spec to execute an asynchronous script in the context of the current page given a SessionId, Text script, and a list of Value arguments.

spec

POST 	/session/{session id}/execute/async 	Execute Async Script

forward :: SessionId -> W3Spec () Source #

Return a spec to navigate forward in the browser history given a SessionId.

spec

POST 	/session/{session id}/forward 	Forward

fullscreenWindow :: SessionId -> W3Spec WindowRect Source #

Return a spec to fullscreen the current window given a SessionId.

spec

POST 	/session/{session id}/window/fullscreen 	Fullscreen Window

getAlertText :: SessionId -> W3Spec Text Source #

Return a spec to get the text of an alert on the current page given a SessionId.

spec

GET 	/session/{session id}/alert/text 	Get Alert Text

getAllCookies :: SessionId -> W3Spec [Cookie] Source #

Return a spec to get all cookies of the current page given a SessionId.

spec

GET 	/session/{session id}/cookie 	Get All Cookies

getCurrentUrl :: SessionId -> W3Spec Text Source #

Return a spec to get the current URL of a session given a SessionId.

spec

GET 	/session/{session id}/url 	Get Current URL

getNamedCookie :: SessionId -> Text -> W3Spec Cookie Source #

Return a spec to get a named cookie of the current page given a SessionId and cookie name.

spec

GET 	/session/{session id}/cookie/{name} 	Get Named Cookie

getPageSource :: SessionId -> W3Spec Text Source #

Return a spec to get the source of the current page given a SessionId.

spec

GET 	/session/{session id}/source 	Get Page Source

getTimeouts :: SessionId -> W3Spec Timeouts Source #

Return a spec to get the timeouts of a session given a SessionId.

spec

GET 	/session/{session id}/timeouts 	Get Timeouts

getTitle :: SessionId -> W3Spec Text Source #

Return a spec to get the title of the current page given a SessionId.

spec

GET 	/session/{session id}/title 	Get Title

getWindowHandle :: SessionId -> W3Spec WindowHandle Source #

Return a spec to get the current window handle given a SessionId.

spec

GET 	/session/{session id}/window 	Get Window Handle

getWindowHandles :: SessionId -> W3Spec [WindowHandle] Source #

Return a spec to get all window handles of the current session given a SessionId.

spec

GET 	/session/{session id}/window/handles 	Get Window Handles

getWindowRect :: SessionId -> W3Spec WindowRect Source #

Return a spec to get the window rect of the current window given a SessionId.

spec

GET 	/session/{session id}/window/rect 	Get Window Rect

maximizeWindow :: SessionId -> W3Spec WindowRect Source #

Return a spec to maximize the current window given a SessionId.

spec

POST 	/session/{session id}/window/maximize 	Maximize Window

minimizeWindow :: SessionId -> W3Spec WindowRect Source #

Return a spec to minimize the current window given a SessionId.

spec

POST 	/session/{session id}/window/minimize 	Minimize Window

navigateTo :: SessionId -> Text -> W3Spec () Source #

Return a spec to navigate to a URL given a SessionId and a Text URL.

spec

POST 	/session/{session id}/url 	Navigate To

newWindow :: SessionId -> W3Spec WindowHandleSpec Source #

Return a spec to create a new window given a SessionId.

spec

POST 	/session/{session id}/window/new 	New Window

performActions :: SessionId -> Actions -> W3Spec () Source #

Return a spec to perform actions on the current page given a SessionId and Actions.

spec

POST 	/session/{session id}/actions 	Perform Actions

printPage :: SessionId -> W3Spec Text Source #

Return a spec to print the current page given a SessionId.

spec

POST 	/session/{session id}/print 	Print Page

refresh :: SessionId -> W3Spec () Source #

Return a spec to refresh the current page given a SessionId.

spec

POST 	/session/{session id}/refresh 	Refresh

releaseActions :: SessionId -> W3Spec () Source #

Return a spec to release actions on the current page given a SessionId.

spec

DELETE 	/session/{session id}/actions 	Release Actions

sendAlertText :: SessionId -> Text -> W3Spec () Source #

Return a spec to send text to an alert on the current page given a SessionId and Text.

spec

POST 	/session/{session id}/alert/text 	Send Alert Text

setTimeouts :: SessionId -> Timeouts -> W3Spec () Source #

Return a spec to set the timeouts of a session given a SessionId and Timeouts.

spec

POST 	/session/{session id}/timeouts 	Set Timeouts

setWindowRect :: SessionId -> WindowRect -> W3Spec WindowRect Source #

Return a spec to set the window rect of the current window given a SessionId and WindowRect.

spec

POST 	/session/{session id}/window/rect 	Set Window Rect

switchToFrame :: SessionId -> FrameReference -> W3Spec () Source #

Return a spec to switch to a different frame given a SessionId and FrameReference.

spec

POST 	/session/{session id}/frame 	Switch To Frame

switchToWindow :: SessionId -> WindowHandle -> W3Spec () Source #

Return a spec to switch to a different window given a SessionId and WindowHandle.

spec

POST 	/session/{session id}/window 	Switch To Window

takeScreenshot :: SessionId -> W3Spec Text Source #

Return a spec to take a screenshot of the current page given a SessionId.

spec

GET 	/session/{session id}/screenshot 	Take Screenshot

Window Methods

closeWindow :: SessionId -> W3Spec () Source #

Return a spec to close the current window given a SessionId.

spec

DELETE 	/session/{session id}/window 	Close Window

fullscreenWindow :: SessionId -> W3Spec WindowRect Source #

Return a spec to fullscreen the current window given a SessionId.

spec

POST 	/session/{session id}/window/fullscreen 	Fullscreen Window

getWindowHandles :: SessionId -> W3Spec [WindowHandle] Source #

Return a spec to get all window handles of the current session given a SessionId.

spec

GET 	/session/{session id}/window/handles 	Get Window Handles

getWindowRect :: SessionId -> W3Spec WindowRect Source #

Return a spec to get the window rect of the current window given a SessionId.

spec

GET 	/session/{session id}/window/rect 	Get Window Rect

maximizeWindow :: SessionId -> W3Spec WindowRect Source #

Return a spec to maximize the current window given a SessionId.

spec

POST 	/session/{session id}/window/maximize 	Maximize Window

minimizeWindow :: SessionId -> W3Spec WindowRect Source #

Return a spec to minimize the current window given a SessionId.

spec

POST 	/session/{session id}/window/minimize 	Minimize Window

newWindow :: SessionId -> W3Spec WindowHandleSpec Source #

Return a spec to create a new window given a SessionId.

spec

POST 	/session/{session id}/window/new 	New Window

setWindowRect :: SessionId -> WindowRect -> W3Spec WindowRect Source #

Return a spec to set the window rect of the current window given a SessionId and WindowRect.

spec

POST 	/session/{session id}/window/rect 	Set Window Rect

switchToWindow :: SessionId -> WindowHandle -> W3Spec () Source #

Return a spec to switch to a different window given a SessionId and WindowHandle.

spec

POST 	/session/{session id}/window 	Switch To Window

Frame Methods

switchToParentFrame :: SessionId -> W3Spec () Source #

Return a spec to switch to the parent frame given a SessionId.

spec

POST 	/session/{session id}/frame/parent 	Switch To Parent Frame

Element(s) Methods

findElement :: SessionId -> Selector -> W3Spec ElementId Source #

Return a spec to find an element on the current page given a SessionId and Selector.

spec

POST 	/session/{session id}/element 	Find Element

findElements :: SessionId -> Selector -> W3Spec [ElementId] Source #

Return a spec to find elements on the current page given a SessionId and Selector.

spec

POST 	/session/{session id}/elements 	Find Elements

getActiveElement :: SessionId -> W3Spec ElementId Source #

Return a spec to get the active element of the current page given a SessionId.

spec

GET 	/session/{session id}/element/active 	Get Active Element

Element Instance Methods

elementClear :: SessionId -> ElementId -> W3Spec () Source #

Return a spec to clear an element given a SessionId and ElementId.

spec

POST 	/session/{session id}/element/{element id}/clear 	Element Clear

elementClick :: SessionId -> ElementId -> W3Spec () Source #

Return a spec to click an element given a SessionId and ElementId.

spec

POST 	/session/{session id}/element/{element id}/click 	Element Click

elementSendKeys :: SessionId -> ElementId -> Text -> W3Spec () Source #

Return a spec to send keys to an element given a SessionId, ElementId, and keys to send.

spec

POST 	/session/{session id}/element/{element id}/value 	Element Send Keys

findElementFromElement :: SessionId -> ElementId -> Selector -> W3Spec ElementId Source #

Return a spec to find an element from another element given a SessionId, ElementId, and Selector.

spec

POST 	/session/{session id}/element/{element id}/element 	Find Element From Element

findElementsFromElement :: SessionId -> ElementId -> Selector -> W3Spec [ElementId] Source #

Return a spec to find elements from another element given a SessionId, ElementId, and Selector.

spec

POST 	/session/{session id}/element/{element id}/elements 	Find Elements From Element

getElementAttribute :: SessionId -> ElementId -> Text -> W3Spec Text Source #

Return a spec to get an attribute of an element given a SessionId, ElementId, and attribute name.

spec

GET 	/session/{session id}/element/{element id}/attribute/{name} 	Get Element Attribute

getElementComputedLabel :: SessionId -> ElementId -> W3Spec Text Source #

Return a spec to get the computed label of an element given a SessionId and ElementId.

spec

GET 	/session/{session id}/element/{element id}/computedlabel 	Get Computed Label

getElementComputedRole :: SessionId -> ElementId -> W3Spec Text Source #

Return a spec to get the computed role of an element given a SessionId and ElementId.

spec

GET 	/session/{session id}/element/{element id}/computedrole 	Get Computed Role

getElementCssValue :: SessionId -> ElementId -> Text -> W3Spec Text Source #

Return a spec to get the CSS value of an element given a SessionId, ElementId, and CSS property name.

spec

GET 	/session/{session id}/element/{element id}/css/{property name} 	Get Element CSS Value

getElementProperty :: SessionId -> ElementId -> Text -> W3Spec Value Source #

Return a spec to get a property of an element given a SessionId, ElementId, and property name.

spec

GET 	/session/{session id}/element/{element id}/property/{name} 	Get Element Property

getElementRect :: SessionId -> ElementId -> W3Spec WindowRect Source #

Return a spec to get the rect of an element given a SessionId and ElementId.

spec

GET 	/session/{session id}/element/{element id}/rect 	Get Element Rect

getElementShadowRoot :: SessionId -> ElementId -> W3Spec ElementId Source #

Return a spec to get the shadow root of an element given a SessionId and ElementId.

spec

GET 	/session/{session id}/element/{element id}/shadow 	Get Element Shadow Root

getElementTagName :: SessionId -> ElementId -> W3Spec Text Source #

Return a spec to get the tag name of an element given a SessionId and ElementId.

spec

GET 	/session/{session id}/element/{element id}/name 	Get Element Tag Name

getElementText :: SessionId -> ElementId -> W3Spec Text Source #

Return a spec to get the text of an element given a SessionId and ElementId.

spec

GET 	/session/{session id}/element/{element id}/text 	Get Element Text

isElementEnabled :: SessionId -> ElementId -> W3Spec Bool Source #

Return a spec to check if an element is enabled given a SessionId and ElementId.

spec

GET 	/session/{session id}/element/{element id}/enabled 	Is Element Enabled

isElementSelected :: SessionId -> ElementId -> W3Spec Bool Source #

Return a spec to check if an element is selected given a SessionId and ElementId.

spec

GET 	/session/{session id}/element/{element id}/selected 	Is Element Selected

takeElementScreenshot :: SessionId -> ElementId -> W3Spec Text Source #

Return a spec to take a screenshot of an element given a SessionId and ElementId.

spec

GET 	/session/{session id}/element/{element id}/screenshot 	Take Element Screenshot

Shadow DOM Methods

findElementFromShadowRoot :: SessionId -> ElementId -> Selector -> W3Spec ElementId Source #

Return a spec to find an element from the shadow root given a SessionId, ElementId, and Selector.

spec

POST 	/session/{session id}/shadow/{shadow id}/element 	Find Element From Shadow Root

findElementsFromShadowRoot :: SessionId -> ElementId -> Selector -> W3Spec [ElementId] Source #

Return a spec to find elements from the shadow root given a SessionId, ElementId, and Selector.

spec

POST 	/session/{session id}/shadow/{shadow id}/elements 	Find Elements From Shadow Root

HTTP Response

data HttpResponse Source #

HttpResponse represents a WebDriver HTTP response.

Constructors

MkHttpResponse
Fields statusCode :: Int HTTP status code. statusMessage :: Text HTTP status message. body :: Value Response body in JSON format.

Instances

Instances details

Show HttpResponse Source #
Instance details Defined in WebDriverPreCore.HttpResponse Methods showsPrec :: Int -> HttpResponse -> ShowS # show :: HttpResponse -> String # showList :: [HttpResponse] -> ShowS #
Eq HttpResponse Source #
Instance details Defined in WebDriverPreCore.HttpResponse Methods (==) :: HttpResponse -> HttpResponse -> Bool # (/=) :: HttpResponse -> HttpResponse -> Bool #
Ord HttpResponse Source #
Instance details Defined in WebDriverPreCore.HttpResponse Methods compare :: HttpResponse -> HttpResponse -> Ordering # (<) :: HttpResponse -> HttpResponse -> Bool # (<=) :: HttpResponse -> HttpResponse -> Bool # (>) :: HttpResponse -> HttpResponse -> Bool # (>=) :: HttpResponse -> HttpResponse -> Bool # max :: HttpResponse -> HttpResponse -> HttpResponse # min :: HttpResponse -> HttpResponse -> HttpResponse #

Capabilities

data Capabilities Source #

Capabilities define the properties of the session and are passed to the webdriver via fields of the FullCapabilities object.

See spec See also: FullCapabilities and related constructors such as minCapabilities, minFullCapabilities, minFirefoxCapabilities and minChromeCapabilities

Constructors

MkCapabilities
Fields browserName :: Maybe BrowserName browserVersion :: Maybe Text platformName :: Maybe PlatformName acceptInsecureCerts :: Maybe Bool pageLoadStrategy :: Maybe PageLoadStrategy proxy :: Maybe Proxy timeouts :: Maybe Timeouts strictFileInteractability :: Maybe Bool unhandledPromptBehavior :: Maybe UnhandledPromptBehavior vendorSpecific :: Maybe VendorSpecific

Instances

Instances details

FromJSON Capabilities Source #

Instance details

MkFullCapabilities
Fields alwaysMatch :: Maybe Capabilities capabilities that are always matched firstMatch :: [Capabilities] a list of capabilities that are matched in order, the first matching capabilities that matches the capabilities of the session is used

Trace	Most verbose logging
Debug	Debug-level information
Config	Configuration details
Info	General operational logs
Warning	Potential issues
Error	Recoverable errors
Fatal	Critical failures
Off	No logging

Direct
Manual
Fields ftpProxy :: Maybe Text httpProxy :: Maybe Text sslProxy :: Maybe Text socksProxy :: Maybe SocksProxy noProxy :: Maybe [Text]
AutoDetect
System
Pac
Fields proxyAutoconfigUrl :: Text

FromJSON Proxy Source #
Instance details Defined in WebDriverPreCore.Capabilities Methods parseJSON :: Value -> Parser Proxy # parseJSONList :: Value -> Parser [Proxy] # omittedField :: Maybe Proxy #
ToJSON Proxy Source #
Instance details Defined in WebDriverPreCore.Capabilities Methods toJSON :: Proxy -> Value # toEncoding :: Proxy -> Encoding # toJSONList :: [Proxy] -> Value # toEncodingList :: [Proxy] -> Encoding # omitField :: Proxy -> Bool #
Show Proxy Source #
Instance details Defined in WebDriverPreCore.Capabilities Methods showsPrec :: Int -> Proxy -> ShowS # show :: Proxy -> String # showList :: [Proxy] -> ShowS #
Eq Proxy Source #
Instance details Defined in WebDriverPreCore.Capabilities Methods (==) :: Proxy -> Proxy -> Bool # (/=) :: Proxy -> Proxy -> Bool #

MkDeviceMetrics
Fields width :: Int height :: Int pixelRatio :: Double touch :: Bool

MkTimeouts
Fields implicit :: Maybe Int pageLoad :: Maybe Int script :: Maybe Int

ChromeOptions	Chrome-specific capabilities
Fields chromeArgs :: Maybe [Text] chromeBinary :: Maybe Text chromeExtensions :: Maybe [Text] chromeLocalState :: Maybe (Map Text Value) chromeMobileEmulation :: Maybe MobileEmulation chromePrefs :: Maybe (Map Text Value) chromeDetach :: Maybe Bool chromeDebuggerAddress :: Maybe Text chromeExcludeSwitches :: Maybe [Text] chromeMinidumpPath :: Maybe FilePath chromePerfLoggingPrefs :: Maybe PerfLoggingPrefs chromeWindowTypes :: Maybe [Text]
EdgeOptions
Fields edgeArgs :: Maybe [Text] edgeBinary :: Maybe Text edgeExtensions :: Maybe [Text] edgeLocalState :: Maybe (Map Text Value) edgeMobileEmulation :: Maybe MobileEmulation edgePrefs :: Maybe (Map Text Value) edgeDetach :: Maybe Bool edgeDebuggerAddress :: Maybe Text edgeExcludeSwitches :: Maybe [Text] edgeMinidumpPath :: Maybe FilePath edgePerfLoggingPrefs :: Maybe PerfLoggingPrefs edgeWindowTypes :: Maybe [Text]
FirefoxOptions
Fields firefoxArgs :: Maybe [Text] firefoxBinary :: Maybe Text firefoxProfile :: Maybe Text firefoxLog :: Maybe LogSettings
SafariOptions
Fields safariAutomaticInspection :: Maybe Bool safariAutomaticProfiling :: Maybe Bool

MkPerfLoggingPrefs
Fields enableNetwork :: Maybe Bool enablePage :: Maybe Bool enableTimeline :: Maybe Bool traceCategories :: Maybe Text bufferUsageReportingInterval :: Maybe Int

MkMobileEmulation
Fields deviceName :: Maybe Text deviceMetrics :: Maybe DeviceMetrics userAgent :: Maybe Text

NotAnError
Fields httpResponse :: HttpResponse
UnrecognisedError
Fields httpResponse :: HttpResponse
WebDriverError
Fields error :: WebDriverErrorType description :: Text httpResponse :: HttpResponse

Show ErrorClassification Source #
Instance details Defined in WebDriverPreCore.Error Methods showsPrec :: Int -> ErrorClassification -> ShowS # show :: ErrorClassification -> String # showList :: [ErrorClassification] -> ShowS #
Eq ErrorClassification Source #
Instance details Defined in WebDriverPreCore.Error Methods (==) :: ErrorClassification -> ErrorClassification -> Bool # (/=) :: ErrorClassification -> ErrorClassification -> Bool #
Ord ErrorClassification Source #
Instance details Defined in WebDriverPreCore.Error Methods compare :: ErrorClassification -> ErrorClassification -> Ordering # (<) :: ErrorClassification -> ErrorClassification -> Bool # (<=) :: ErrorClassification -> ErrorClassification -> Bool # (>) :: ErrorClassification -> ErrorClassification -> Bool # (>=) :: ErrorClassification -> ErrorClassification -> Bool # max :: ErrorClassification -> ErrorClassification -> ErrorClassification # min :: ErrorClassification -> ErrorClassification -> ErrorClassification #

ElementClickIntercepted
ElementNotInteractable
InsecureCertificate
InvalidArgument
InvalidCookieDomain
InvalidElementState
InvalidSelector
InvalidSessionId
JavascriptError
MoveTargetOutOfBounds
NoSuchAlert
NoSuchCookie
NoSuchElement
NoSuchFrame
NoSuchWindow
NoSuchShadowRoot
ScriptTimeoutError
SessionNotCreated
StaleElementReference
DetachedShadowRoot
Timeout
UnableToSetCookie
UnableToCaptureScreen
UnexpectedAlertOpen
UnknownCommand
UnknownError
UnknownMethod
UnsupportedOperation

Bounded WebDriverErrorType Source #
Instance details Defined in WebDriverPreCore.Error Methods minBound :: WebDriverErrorType # maxBound :: WebDriverErrorType #
Enum WebDriverErrorType Source #
Instance details Defined in WebDriverPreCore.Error Methods succ :: WebDriverErrorType -> WebDriverErrorType # pred :: WebDriverErrorType -> WebDriverErrorType # toEnum :: Int -> WebDriverErrorType # fromEnum :: WebDriverErrorType -> Int # enumFrom :: WebDriverErrorType -> [WebDriverErrorType] # enumFromThen :: WebDriverErrorType -> WebDriverErrorType -> [WebDriverErrorType] # enumFromTo :: WebDriverErrorType -> WebDriverErrorType -> [WebDriverErrorType] # enumFromThenTo :: WebDriverErrorType -> WebDriverErrorType -> WebDriverErrorType -> [WebDriverErrorType] #
Show WebDriverErrorType Source #
Instance details Defined in WebDriverPreCore.Error Methods showsPrec :: Int -> WebDriverErrorType -> ShowS # show :: WebDriverErrorType -> String # showList :: [WebDriverErrorType] -> ShowS #
Eq WebDriverErrorType Source #
Instance details Defined in WebDriverPreCore.Error Methods (==) :: WebDriverErrorType -> WebDriverErrorType -> Bool # (/=) :: WebDriverErrorType -> WebDriverErrorType -> Bool #
Ord WebDriverErrorType Source #
Instance details Defined in WebDriverPreCore.Error Methods compare :: WebDriverErrorType -> WebDriverErrorType -> Ordering # (<) :: WebDriverErrorType -> WebDriverErrorType -> Bool # (<=) :: WebDriverErrorType -> WebDriverErrorType -> Bool # (>) :: WebDriverErrorType -> WebDriverErrorType -> Bool # (>=) :: WebDriverErrorType -> WebDriverErrorType -> Bool # max :: WebDriverErrorType -> WebDriverErrorType -> WebDriverErrorType # min :: WebDriverErrorType -> WebDriverErrorType -> WebDriverErrorType #

NoneAction
Fields id :: Text noneActions :: [Maybe Int]
Key
Fields id :: Text keyActions :: [KeyAction]
Pointer
Fields id :: Text subType :: Pointer pointerId :: Int pressed :: Set Int x :: Int y :: Int actions :: [PointerAction]
Wheel
Fields id :: Text wheelActions :: [WheelAction]

ToJSON Action Source #
Instance details Defined in WebDriverPreCore.SpecDefinition Methods toJSON :: Action -> Value # toEncoding :: Action -> Encoding # toJSONList :: [Action] -> Value # toEncodingList :: [Action] -> Encoding # omitField :: Action -> Bool #
Show Action Source #
Instance details Defined in WebDriverPreCore.SpecDefinition Methods showsPrec :: Int -> Action -> ShowS # show :: Action -> String # showList :: [Action] -> ShowS #
Eq Action Source #
Instance details Defined in WebDriverPreCore.SpecDefinition Methods (==) :: Action -> Action -> Bool # (/=) :: Action -> Action -> Bool #

PauseKey
Fields duration :: Maybe Int
KeyDown
Fields value :: Text
KeyUp
Fields value :: Text

ToJSON KeyAction Source #
Instance details Defined in WebDriverPreCore.SpecDefinition Methods toJSON :: KeyAction -> Value # toEncoding :: KeyAction -> Encoding # toJSONList :: [KeyAction] -> Value # toEncodingList :: [KeyAction] -> Encoding # omitField :: KeyAction -> Bool #
Show KeyAction Source #
Instance details Defined in WebDriverPreCore.SpecDefinition Methods showsPrec :: Int -> KeyAction -> ShowS # show :: KeyAction -> String # showList :: [KeyAction] -> ShowS #
Eq KeyAction Source #
Instance details Defined in WebDriverPreCore.SpecDefinition Methods (==) :: KeyAction -> KeyAction -> Bool # (/=) :: KeyAction -> KeyAction -> Bool #

PausePointer
Fields duration :: Maybe Int
Up
Fields button :: Int width :: Maybe Int height :: Maybe Int pressure :: Maybe Float tangentialPressure :: Maybe Float tiltX :: Maybe Int tiltY :: Maybe Int twist :: Maybe Int altitudeAngle :: Maybe Double azimuthAngle :: Maybe Double
Down
Fields button :: Int width :: Maybe Int height :: Maybe Int pressure :: Maybe Float tangentialPressure :: Maybe Float tiltX :: Maybe Int tiltY :: Maybe Int twist :: Maybe Int altitudeAngle :: Maybe Double azimuthAngle :: Maybe Double
Move
Fields origin :: PointerOrigin duration :: Maybe Int width :: Maybe Int height :: Maybe Int pressure :: Maybe Float tangentialPressure :: Maybe Float tiltX :: Maybe Int tiltY :: Maybe Int twist :: Maybe Int altitudeAngle :: Maybe Double azimuthAngle :: Maybe Double x :: Int y :: Int
Cancel

ToJSON PointerAction Source #
Instance details Defined in WebDriverPreCore.SpecDefinition Methods toJSON :: PointerAction -> Value # toEncoding :: PointerAction -> Encoding # toJSONList :: [PointerAction] -> Value # toEncodingList :: [PointerAction] -> Encoding # omitField :: PointerAction -> Bool #
Show PointerAction Source #
Instance details Defined in WebDriverPreCore.SpecDefinition Methods showsPrec :: Int -> PointerAction -> ShowS # show :: PointerAction -> String # showList :: [PointerAction] -> ShowS #
Eq PointerAction Source #
Instance details Defined in WebDriverPreCore.SpecDefinition Methods (==) :: PointerAction -> PointerAction -> Bool # (/=) :: PointerAction -> PointerAction -> Bool #

ToJSON Pointer Source #
Instance details Defined in WebDriverPreCore.SpecDefinition Methods toJSON :: Pointer -> Value # toEncoding :: Pointer -> Encoding # toJSONList :: [Pointer] -> Value # toEncodingList :: [Pointer] -> Encoding # omitField :: Pointer -> Bool #
Show Pointer Source #
Instance details Defined in WebDriverPreCore.SpecDefinition Methods showsPrec :: Int -> Pointer -> ShowS # show :: Pointer -> String # showList :: [Pointer] -> ShowS #
Eq Pointer Source #
Instance details Defined in WebDriverPreCore.SpecDefinition Methods (==) :: Pointer -> Pointer -> Bool # (/=) :: Pointer -> Pointer -> Bool #

Introduction

What is This Library?

Why This Library?

Implementing WebDriver Interaction

1. Implementing a runner

Example

Module Header

run function

1.1 W3Spec -> ReqRequestParams

1.2 Call the WebDriver

1.3 Parse HttpResponse using the parser provided by W3Spec

2. Applying the runner to the W3Spec functions

Using the API

The API

The W3Spec Type

Instances

Root Methods

Session Methods

Window Methods

Frame Methods

Element(s) Methods

Element Instance Methods

Shadow DOM Methods

HTTP Response

Instances

Capabilities

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Errors

Instances

Instances

Action Types

Instances

Instances

Instances

Instances

Instances

Instances

Auxiliary Spec Types

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

Instances

`run` function

1.1 `W3Spec` -> `ReqRequestParams`

1.3 Parse `HttpResponse` using the parser provided by `W3Spec`

2. Applying the `runner` to the `W3Spec` functions

ToJSON PointerOrigin Source #
Instance details Defined in WebDriverPreCore.SpecDefinition Methods toJSON :: PointerOrigin -> Value # toEncoding :: PointerOrigin -> Encoding # toJSONList :: [PointerOrigin] -> Value # toEncodingList :: [PointerOrigin] -> Encoding # omitField :: PointerOrigin -> Bool #
Show PointerOrigin Source #
Instance details Defined in WebDriverPreCore.SpecDefinition Methods showsPrec :: Int -> PointerOrigin -> ShowS # show :: PointerOrigin -> String # showList :: [PointerOrigin] -> ShowS #
Eq PointerOrigin Source #
Instance details Defined in WebDriverPreCore.SpecDefinition Methods (==) :: PointerOrigin -> PointerOrigin -> Bool # (/=) :: PointerOrigin -> PointerOrigin -> Bool #

PauseWheel
Fields duration :: Maybe Int
Scroll
Fields origin :: PointerOrigin x :: Int y :: Int deltaX :: Int deltaY :: Int duration :: Maybe Int

ToJSON WheelAction Source #
Instance details Defined in WebDriverPreCore.SpecDefinition Methods toJSON :: WheelAction -> Value # toEncoding :: WheelAction -> Encoding # toJSONList :: [WheelAction] -> Value # toEncodingList :: [WheelAction] -> Encoding # omitField :: WheelAction -> Bool #
Show WheelAction Source #
Instance details Defined in WebDriverPreCore.SpecDefinition Methods showsPrec :: Int -> WheelAction -> ShowS # show :: WheelAction -> String # showList :: [WheelAction] -> ShowS #
Eq WheelAction Source #
Instance details Defined in WebDriverPreCore.SpecDefinition Methods (==) :: WheelAction -> WheelAction -> Bool # (/=) :: WheelAction -> WheelAction -> Bool #

Show WindowHandle Source #
Instance details Defined in WebDriverPreCore.SpecDefinition Methods showsPrec :: Int -> WindowHandle -> ShowS # show :: WindowHandle -> String # showList :: [WindowHandle] -> ShowS #
Eq WindowHandle Source #
Instance details Defined in WebDriverPreCore.SpecDefinition Methods (==) :: WindowHandle -> WindowHandle -> Bool # (/=) :: WindowHandle -> WindowHandle -> Bool #

HandleSpec
Fields handle :: WindowHandle handletype :: HandleType

FromJSON WindowHandleSpec Source #
Instance details Defined in WebDriverPreCore.SpecDefinition Methods parseJSON :: Value -> Parser WindowHandleSpec # parseJSONList :: Value -> Parser [WindowHandleSpec] # omittedField :: Maybe WindowHandleSpec #
ToJSON WindowHandleSpec Source #
Instance details Defined in WebDriverPreCore.SpecDefinition Methods toJSON :: WindowHandleSpec -> Value # toEncoding :: WindowHandleSpec -> Encoding # toJSONList :: [WindowHandleSpec] -> Value # toEncodingList :: [WindowHandleSpec] -> Encoding # omitField :: WindowHandleSpec -> Bool #
Show WindowHandleSpec Source #
Instance details Defined in WebDriverPreCore.SpecDefinition Methods showsPrec :: Int -> WindowHandleSpec -> ShowS # show :: WindowHandleSpec -> String # showList :: [WindowHandleSpec] -> ShowS #
Eq WindowHandleSpec Source #
Instance details Defined in WebDriverPreCore.SpecDefinition Methods (==) :: WindowHandleSpec -> WindowHandleSpec -> Bool # (/=) :: WindowHandleSpec -> WindowHandleSpec -> Bool #

CSS Text
XPath Text
LinkText Text
PartialLinkText Text
TagName Text

Show Selector Source #
Instance details Defined in WebDriverPreCore.SpecDefinition Methods showsPrec :: Int -> Selector -> ShowS # show :: Selector -> String # showList :: [Selector] -> ShowS #
Eq Selector Source #
Instance details Defined in WebDriverPreCore.SpecDefinition Methods (==) :: Selector -> Selector -> Bool # (/=) :: Selector -> Selector -> Bool #

MkCookie
Fields name :: Text value :: Text path :: Maybe Text domain :: Maybe Text secure :: Maybe Bool httpOnly :: Maybe Bool sameSite :: Maybe SameSite expiry :: Maybe Int

Show SessionId Source #
Instance details Defined in WebDriverPreCore.SpecDefinition Methods showsPrec :: Int -> SessionId -> ShowS # show :: SessionId -> String # showList :: [SessionId] -> ShowS #