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


-- | Talk to Urbit from Haskell
--   
--   <tt>urbit-api</tt> is a Haskell library that helps you connect to the
--   Urbit API.
--   
--   Built on req, conduit, and aeson for stability and simplicity.
@package urbit-api
@version 0.2.0.0


-- | <h3>About the Urbit API</h3>
--   
--   The Urbit API is a command-query API that lets you hook into apps
--   running on your Urbit. You can submit commands and subscribe to
--   responses.
--   
--   The Urbit vane <tt>eyre</tt> is responsible for defining the API
--   interface. The HTTP path to the API is <tt>/~/channel/...</tt>, where
--   we send messages to the global log (called <tt>poke</tt>s) which are
--   then dispatched to the appropriate apps. To receive responses, we
--   stream messages from a path associated with the app, such as
--   <tt>/mailbox/~/~zod/mc</tt>. Internally, I believe Urbit calls these
--   <tt>wire</tt>s.
--   
--   <h3>About this library</h3>
--   
--   This library helps you talk to your Urbit from Haskell, via HTTP. It
--   handles most of the path, session, and HTTP request stuff
--   automatically. You'll need to know what app and mark (data type) to
--   send to, which path/wire listen to, and the shape of the message. The
--   latter can be found in the Hoon source code, called the <tt>vase</tt>
--   on the poke arm.
--   
--   This library is built on req, conduit, and aeson, all of which are
--   very stable and usable libraries for working with HTTP requests and
--   web data. Released under the MIT License, same as Urbit.
module Urbit.API

-- | Some information about your ship needed to establish connection.
data Ship
Ship :: Text -> Text -> Int -> Text -> Text -> Ship

-- | A random string for your channel
[uid] :: Ship -> Text

-- | The <tt>@p</tt> of your ship
[name] :: Ship -> Text

-- | Track the latest event we saw (needed for poking)
[lastEventId] :: Ship -> Int

-- | Network access point, with port if necessary, like
--   <tt><a>https://sampel-palnet.arvo.network</a></tt>, or
--   <tt><a>http://localhost:8080</a></tt>
[url] :: Ship -> Text

-- | Login code, <tt>+code</tt> in the dojo. Don't share this publically
[code] :: Ship -> Text

-- | A wrapper type for the session cookies.
type Session = CookieJar

-- | Connect and login to the ship.
connect :: Ship -> IO Session

-- | Poke a ship.
poke :: ToJSON a => Session -> Ship -> Text -> Text -> Text -> a -> IO BsResponse

-- | Acknowledge receipt of a message. (This clears it from the ship's
--   queue.)
ack :: Session -> Ship -> Int -> IO BsResponse

-- | Subscribe to ship events on some path.
subscribe :: Session -> Ship -> Text -> ConduitM ByteString Void (ResourceT IO) a -> IO a
instance GHC.Show.Show Urbit.API.Ship
instance Network.HTTP.Req.MonadHttp (Data.Conduit.Internal.Conduit.ConduitM i o (Control.Monad.Trans.Resource.Internal.ResourceT GHC.Types.IO))