Safe Haskell	None
Language	Haskell2010

Thentos.Frontend.Types

Contents

content types
frontend actions
session state

Synopsis

content types

type HTM = PrettyHTML

Html content type with pretty printing. (See also: package servant-blaze.)

renderHTM :: Html -> LBS

data PrettyHTML

Instances

Accept * PrettyHTML
ToMarkup a => MimeRender * PrettyHTML a
MimeRender * PrettyHTML Html

data TextCss

Instances

Accept * TextCss
MimeRender * TextCss String
MimeRender * TextCss ST
MimeRender * TextCss SBS
MimeRender * TextCss LT
MimeRender * TextCss LBS

frontend actions

type FAction = Action FActionError FrontendSessionData

data FActionError

Constructors

FActionError303 SBS
FActionError404
FActionErrorNoToken
FActionErrorCreateService
FActionErrorServiceLoginNoCbUrl
FActionError500 String

Instances

Eq FActionError
Show FActionError

session state

data FrontendSessionData

Constructors

FrontendSessionData
Fields _fsdLogin :: Maybe FrontendSessionLoginData _fsdServiceLoginState :: Maybe ServiceLoginState (see `ServiceLoginState`) _fsdMessages :: [FrontendMsg]

Instances

Eq FrontendSessionData
Show FrontendSessionData
Generic FrontendSessionData
ToJSON FrontendSessionData
FromJSON FrontendSessionData
type Rep FrontendSessionData

emptyFrontendSessionData :: FrontendSessionData

data FrontendSessionLoginData

Constructors

FrontendSessionLoginData
Fields _fslToken :: ThentosSessionToken _fslUserId :: UserId _fslDashboardTab :: Maybe DashboardTab

Instances

Eq FrontendSessionLoginData
Show FrontendSessionLoginData
Generic FrontendSessionLoginData
ToJSON FrontendSessionLoginData
FromJSON FrontendSessionLoginData
type Rep FrontendSessionLoginData

data DashboardTab

Constructors

DashboardTabDetails
DashboardTabServices
DashboardTabOwnServices
DashboardTabUsers
DashboardTabLogout

Instances

Bounded DashboardTab
Enum DashboardTab
Eq DashboardTab
Ord DashboardTab
Read DashboardTab
Show DashboardTab
Generic DashboardTab
ToJSON DashboardTab
FromJSON DashboardTab
type Rep DashboardTab

data ServiceLoginState

If a user comes from a service login and is sent to the "register with a new service" page because no valid ServiceAccount exists in thentos, an extra round of indirection is required (the user is confronted with the service details and must say "yes, i want to register", "share this-and-that data", etc.). There may be further extra rounds for logging in to thentos or registering with thentos. This type is used to store the information from the service login request in FrontendSessionData until all these steps have been taken.

Constructors

ServiceLoginState
Fields _fslServiceId :: ServiceId _fslRR :: RelativeRef e.g. `servicelogin?...` FIXME: give fslRR a better name. something that explains the meaning of where it is pointing.

Instances

Eq ServiceLoginState
Show ServiceLoginState
Generic ServiceLoginState
ToJSON ServiceLoginState
FromJSON ServiceLoginState
type Rep ServiceLoginState

data FrontendMsg

If we want to communicate information from the last request to the user in the next one, we need to stash it in the state. This is the type for that.

Constructors

FrontendMsgError ST
FrontendMsgSuccess ST

Instances

Eq FrontendMsg
Show FrontendMsg
Generic FrontendMsg
ToJSON FrontendMsg
FromJSON FrontendMsg
type Rep FrontendMsg

fsdServiceLoginState :: Lens' FrontendSessionData (Maybe ServiceLoginState)

fsdMessages :: Lens' FrontendSessionData [FrontendMsg]

fsdLogin :: Lens' FrontendSessionData (Maybe FrontendSessionLoginData)

fslUserId :: Lens' FrontendSessionLoginData UserId

fslToken :: Lens' FrontendSessionLoginData ThentosSessionToken

fslDashboardTab :: Lens' FrontendSessionLoginData (Maybe DashboardTab)

fslServiceId :: Lens' ServiceLoginState ServiceId

fslRR :: Lens' ServiceLoginState RelativeRef