diff --git a/src/App/AuthenticationForm.purs b/src/App/AuthenticationForm.purs index dd68529..7bb712b 100644 --- a/src/App/AuthenticationForm.purs +++ b/src/App/AuthenticationForm.purs @@ -1,3 +1,4 @@ +-- | `App.AuthenticationForm` is both the authentication and registration interface. module App.AuthenticationForm where import Prelude (Unit, bind, discard, pure, ($), (<<<), (<>)) @@ -21,11 +22,19 @@ import App.Email as Email import App.LogMessage import App.Messages.AuthenticationDaemon as AuthD +-- | The component can inform the parent (`App.Container`) that the authentication is complete, +-- | and share both the uid and token. The token is useful to authenticate the user to the +-- | dnsmanager daemon. +-- | +-- | Also, the component can send a message to a websocket and log messages. data Output = AuthToken (Tuple Int String) | MessageToSend ArrayBuffer | Log LogMessage +-- | The component's parent provides received messages. +-- | +-- | Also, the component is informed when the connection went up or down. data Query a = MessageReceived ArrayBuffer a | ConnectionIsDown a