-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Wrapper around the webdriver package that automatically manages Selenium
--   
--   Please see the README on GitHub at
--   <a>https://github.com/gtollini/webdriver-wrapper#readme</a>
@package webdriver-wrapper
@version 0.2.0.1


module Test.WebDriverWrapper.Constants

-- | Where chromedriver initially gets unziped to
chromeDriverArchiveDirectory :: IO FilePath

-- | Intermediary path for the compressed version of chromedriver. Inside
--   <a>downloadPath</a>.
chromeDriverArchivePath :: IO FilePath

-- | Index for <a>chromeDriverVersionsUrl</a>, which provides a list of
--   urls where each platform is represented by an entry. If the platform
--   is not identified, <tt>linux64</tt>'s index is used.
chromeDriverArchIndex :: Int

-- | API to get chromedriver's download url.
chromeDriverVersionsUrl :: String

-- | Path for chromedriver. Inside <a>downloadPath</a>.
chromeDriverPath :: IO FilePath

-- | Path for geckodriver. Inside <a>downloadPath</a>.
geckoDriverPath :: IO FilePath

-- | <tt>haskell-webdriver-wrapper</tt> directory, created at
--   <a>XdgData</a>.
defaultPath :: IO FilePath

-- | Url to download Selenium from.
defaultSeleniumJarUrl :: String

-- | Platform this code is running at. The options are:
--   
--   <ul>
--   <li>win64</li>
--   <li>win-aarch64</li>
--   <li>win32</li>
--   <li>macos</li>
--   <li>macos-aarch64</li>
--   <li>linux64</li>
--   <li>linux-aarch64</li>
--   <li>linux32</li>
--   </ul>
--   
--   If the platform is not identified, <tt>linux64</tt> is used.
desiredPlatform :: String

-- | Url to download geckodriver from. Always the latest version provided
--   by <a>geckoDriverVersionSource</a>.
getGeckoDriverDownloadUrl :: String -> String

-- | API to get geckodriver's latest version.
geckoDriverVersionSource :: String

-- | Directory named after <a>desiredPlatform</a>, created at the
--   <a>defaultPath</a>.
downloadPath :: IO FilePath

-- | Intermediary path for the compressed version of geckodriver. Inside
--   <a>downloadPath</a>.
geckoArchivePath :: IO FilePath

-- | Archive format for geckodriver's download. <tt>.zip</tt> for Windows,
--   <tt>.tar.gz</tt> for everyone else.
fileFormat :: String

-- | Path for selenium.jar. Inside <a>downloadPath</a>.
seleniumPath :: IO FilePath

-- | Path for Selenium's log file. Inside <a>defaultPath</a>.
seleniumLogPath :: IO FilePath


module Test.WebDriverWrapper.Helpers

-- | Downloads from <tt>url</tt> at <tt>output</tt> filepath.
download :: String -> FilePath -> IO ()

-- | Decompresses geckodriver's download, which comes in <tt>.zip</tt> for
--   Windows or <tt>.tar.gz</tt> for everyone else. Takes in the archive's
--   filepath and the output filepath.
decompressGecko :: FilePath -> FilePath -> IO ()

-- | Decompresses a Zip file. Takes in the archive's filepath and the
--   output filepath.
decompressZip :: FilePath -> FilePath -> IO ()

-- | Evaluates each IO individually and returns the first one that doesn't
--   throw an error. Throws an error if none succeed.
evalUntillSuccess :: [IO String] -> IO String

module Test.WebDriverWrapper.GeckoDriver

-- | Checks if <tt>geckodriver</tt> is in the <a>downloadPath</a>. If not,
--   download it.
getGeckoDriverIfNeeded :: IO ()

module Test.WebDriverWrapper.ChromeDriver

-- | Checks if <tt>chromedriver</tt> is in the <a>downloadPath</a>. If not,
--   download it.
getChromeDriverIfNeeded :: Maybe FilePath -> IO ()
instance Data.Aeson.Types.FromJSON.FromJSON Test.WebDriverWrapper.ChromeDriver.ChromeDriverVersion
instance Data.Aeson.Types.ToJSON.ToJSON Test.WebDriverWrapper.ChromeDriver.ChromeDriverVersion
instance GHC.Generics.Generic Test.WebDriverWrapper.ChromeDriver.ChromeDriverVersion
instance GHC.Show.Show Test.WebDriverWrapper.ChromeDriver.ChromeDriverVersion
instance Data.Aeson.Types.FromJSON.FromJSON Test.WebDriverWrapper.ChromeDriver.ChromeDriverMain
instance Data.Aeson.Types.ToJSON.ToJSON Test.WebDriverWrapper.ChromeDriver.ChromeDriverMain
instance GHC.Generics.Generic Test.WebDriverWrapper.ChromeDriver.ChromeDriverMain
instance GHC.Show.Show Test.WebDriverWrapper.ChromeDriver.ChromeDriverMain

module Test.WebDriverWrapper.Selenium

-- | Starts Selenium and waits for its ok message ( "Selenium Server is up
--   and running" ) to show up at the log file. Takes in a <a>Browser</a>
--   (since it needs to use the correct webdriver). Returns the handles for
--   the Selenium process.
startSelenium :: Browser -> IO (Maybe Handle, Maybe Handle, Maybe Handle, ProcessHandle)

-- | Checks if <tt>selenium</tt> is in the <a>downloadPath</a>. If not,
--   download it.
getSeleniumIfNeeded :: IO ()


-- | The wrapped functions (<a>wrappedRunSession</a> and
--   <tt>wrappedRunWD</tt>) will download Selenium and Firefox's webdriver
--   (geckodriver) if they're not already on the <a>downloadPath</a>, then
--   start Selenium before running the webdriver equivalent function
--   (<a>runSession</a> and <a>runWD</a>). They kill the Selenium process
--   at the end of their execution.
module Test.WebDriverWrapper

-- | Same as <a>runSession</a>, but starts Selenium before execution and
--   kills Selenium after execution. Will download Selenium or the
--   browser's webdriver (geckodriver or chromedriver) if any is missing.
wrappedRunSession :: WDConfig -> WD a -> IO a

-- | Runs a function in between starting and killing Selenium. Takes in the
--   arguments and the function, in that order. Will download Selenium and
--   the Browser's webdriver (geckodriver or chromedriver) if any is
--   missing.
wrapWebDriverFunction :: Browser -> a -> (a -> IO b) -> IO b

-- | Same as <a>runWD</a>, but starts Selenium before execution and kills
--   Selenium after execution. Will download Selenium or Firefox's
--   webdriver (geckodriver) if any is missing.
wrappedFirefoxRunWD :: WDSession -> WD a -> IO a

-- | Same as <a>runWD</a>, but starts Selenium before execution and kills
--   Selenium after execution. Will download Selenium or Chrome's webdriver
--   (chromedriver) if any is missing.
wrappedChromeRunWD :: WDSession -> WD a -> IO a