Safe Haskell	None
Language	Haskell2010

Shpadoinkle.Router

Contents

Classes
Types
Shpadoinkle with SPA
Navigation
Rehydration
Re-Exports

Description

This module provides for Servant-based routing for Shpadoinkle applications. The technique in use is standard for Servant. We have a GADT Router and some type class inductive programming with class HasRouter. The Router the term necessary for the runtime operation of single page application routing.

State changes are tracked by the "popstate" event and an MVar (). Ideally this is done via the browser's native APIs only and not an MVar, however that approach is blocked by a bug in GHCjs which is documented here.

Synopsis

class HasRouter layout where
- type layout :>> route :: Type
- route :: (layout :>> route) -> Router route
class Routed a r where
- redirect :: r -> Redirect a
data Redirect api = (IsElem sub api, HasLink sub) => Redirect (Proxy sub) (MkLink sub Link -> Link)
data Router a where
- RChoice :: Router a -> Router a -> Router a
- RCapture :: FromHttpApiData x => (x -> Router a) -> Router a
- RQueryParam :: (FromHttpApiData x, KnownSymbol sym) => Proxy sym -> (Maybe x -> Router a) -> Router a
- RQueryParamR :: (FromHttpApiData x, KnownSymbol sym) => Proxy sym -> (x -> Router a) -> Router a
- RQueryParams :: (FromHttpApiData x, KnownSymbol sym) => Proxy sym -> ([x] -> Router a) -> Router a
- RQueryFlag :: KnownSymbol sym => Proxy sym -> (Bool -> Router a) -> Router a
- RPath :: KnownSymbol sym => Proxy sym -> Router a -> Router a
- RView :: a -> Router a
fullPageSPAC :: forall layout b a r m. HasRouter layout => Backend b m a => Monad (b m) => Eq a => Functor m => (m ~> JSM) -> (TVar a -> b m ~> m) -> (r -> m a) -> (a -> Html (b m) a) -> b m RawNode -> (r -> m (Continuation m a)) -> (layout :>> r) -> JSM ()
fullPageSPA :: forall layout b a r m. HasRouter layout => Backend b m a => Monad (b m) => Eq a => Functor m => (m ~> JSM) -> (TVar a -> b m ~> m) -> (r -> m a) -> (a -> Html (b m) a) -> b m RawNode -> (r -> m a) -> (layout :>> r) -> JSM ()
navigate :: forall a m r. MonadJSM m => Routed a r => r -> m ()
withHydration :: (MonadJSM m, FromJSON a) => (r -> m a) -> r -> m a
toHydration :: ToJSON a => a -> Html m b
data Raw
class (Applicative m, MonadIO m) => MonadJSM (m :: Type -> Type)
class HasLink (endpoint :: k) where
- type MkLink (endpoint :: k) a :: Type
- toLink :: (Link -> a) -> Proxy endpoint -> Link -> MkLink endpoint a

Classes

class HasRouter layout where Source #

This type class traverses the Servant API and sets up a function to build its term level representation.

Associated Types

type layout :>> route :: Type infixr 4 Source #

:>> (pronounced "routed as") should be surjective, as in one route can be the handler for more than one URL.

Methods

route :: (layout :>> route) -> Router route Source #

Instances

HasRouter Raw Source #
Instance details Defined in Shpadoinkle.Router Associated Types type Raw :>> route :: Type Source # Methods route :: (Raw :>> route) -> Router route Source #
(HasRouter x, HasRouter y) => HasRouter (x :<\|> y) Source #
Instance details Defined in Shpadoinkle.Router Associated Types type (x :<\|> y) :>> route :: Type Source # Methods route :: ((x :<\|> y) :>> route) -> Router route Source #
(HasRouter sub, FromHttpApiData x, KnownSymbol sym) => HasRouter (QueryParam sym x :> sub) Source #
Instance details Defined in Shpadoinkle.Router Associated Types type (QueryParam sym x :> sub) :>> route :: Type Source # Methods route :: ((QueryParam sym x :> sub) :>> route) -> Router route Source #
(HasRouter sub, FromHttpApiData x, KnownSymbol sym) => HasRouter (QueryParam' (Required ': ([] :: [Type])) sym x :> sub) Source #
Instance details Defined in Shpadoinkle.Router Associated Types type (QueryParam' (Required ': []) sym x :> sub) :>> route :: Type Source # Methods route :: ((QueryParam' (Required ': []) sym x :> sub) :>> route) -> Router route Source #
(HasRouter sub, FromHttpApiData x, KnownSymbol sym) => HasRouter (QueryParams sym x :> sub) Source #
Instance details Defined in Shpadoinkle.Router Associated Types type (QueryParams sym x :> sub) :>> route :: Type Source # Methods route :: ((QueryParams sym x :> sub) :>> route) -> Router route Source #
(HasRouter sub, KnownSymbol sym) => HasRouter (QueryFlag sym :> sub) Source #
Instance details Defined in Shpadoinkle.Router Associated Types type (QueryFlag sym :> sub) :>> route :: Type Source # Methods route :: ((QueryFlag sym :> sub) :>> route) -> Router route Source #
(HasRouter sub, FromHttpApiData x) => HasRouter (Capture sym x :> sub) Source #
Instance details Defined in Shpadoinkle.Router Associated Types type (Capture sym x :> sub) :>> route :: Type Source # Methods route :: ((Capture sym x :> sub) :>> route) -> Router route Source #
(HasRouter sub, KnownSymbol path) => HasRouter (path :> sub) Source #
Instance details Defined in Shpadoinkle.Router Associated Types type (path :> sub) :>> route :: Type Source # Methods route :: ((path :> sub) :>> route) -> Router route Source #

class Routed a r where Source #

Ensure global coherence between routes and the api

Methods

redirect :: r -> Redirect a Source #

Types

data Redirect api Source #

Redirect is an existentialized Proxy that must be a member of the API

Constructors

(IsElem sub api, HasLink sub) => Redirect (Proxy sub) (MkLink sub Link -> Link)

data Router a where Source #

Term level API representation

Constructors

RChoice :: Router a -> Router a -> Router a
RCapture :: FromHttpApiData x => (x -> Router a) -> Router a
RQueryParam :: (FromHttpApiData x, KnownSymbol sym) => Proxy sym -> (Maybe x -> Router a) -> Router a
RQueryParamR :: (FromHttpApiData x, KnownSymbol sym) => Proxy sym -> (x -> Router a) -> Router a
RQueryParams :: (FromHttpApiData x, KnownSymbol sym) => Proxy sym -> ([x] -> Router a) -> Router a
RQueryFlag :: KnownSymbol sym => Proxy sym -> (Bool -> Router a) -> Router a
RPath :: KnownSymbol sym => Proxy sym -> Router a -> Router a
RView :: a -> Router a

Shpadoinkle with SPA

fullPageSPAC Source #

Arguments

:: HasRouter layout
=> Backend b m a
=> Monad (b m)
=> Eq a
=> Functor m
=> (m ~> JSM)	how do we get to JSM?
-> (TVar a -> b m ~> m)	What backend are we running?
-> (r -> m a)	what is the initial state?
-> (a -> Html (b m) a)	how should the html look?
-> b m RawNode	where do we render?
-> (r -> m (Continuation m a))	listen for route changes
-> (layout :>> r)	how shall we relate urls to routes?
-> JSM ()

This method wraps shpadoinkle, providing for a convenient entrypoint for single page applications. It wires together your normal shpadoinkle app components with a function to respond to route changes and the route mapping itself. This flavor provides access to the full power of Continuation in case you need to handle in-flight updates.

fullPageSPA Source #

Arguments

:: HasRouter layout
=> Backend b m a
=> Monad (b m)
=> Eq a
=> Functor m
=> (m ~> JSM)	how do we get to JSM?
-> (TVar a -> b m ~> m)	What backend are we running?
-> (r -> m a)	what is the initial state?
-> (a -> Html (b m) a)	how should the html look?
-> b m RawNode	where do we render?
-> (r -> m a)	listen for route changes
-> (layout :>> r)	how shall we relate urls to routes?
-> JSM ()

This method wraps shpadoinkle, providing for a convenient entrypoint for single page applications. It wires together your normal shpadoinkle app components with a function to respond to route changes and the route mapping itself.

Navigation

navigate :: forall a m r. MonadJSM m => Routed a r => r -> m () Source #

Change the browser's URL to the canonical URL for a given route r.

Rehydration

withHydration :: (MonadJSM m, FromJSON a) => (r -> m a) -> r -> m a Source #

When using server-side rendering you may benefit from seeding the page with data. This function get an assumed global variable on the page called "initState". If it's found, we return that, otherwise we use the provided (r -> m a) function to generate the init state for our app, based on the current route. Typically this is used on the client side.

toHydration :: ToJSON a => a -> Html m b Source #

When using server-side rendering, you may benefit from seeding the page with data. This function returns a script tag that makes a global variable "initState" containing a JSON representation to be used as the initial state of the application on page load. Typically this is used on the server side.

Re-Exports

data Raw #

Endpoint for plugging in your own Wai Applications.

The given Application will get the request as received by the server, potentially with a modified (stripped) pathInfo if the Application is being routed with :>.

In addition to just letting you plug in your existing WAI Applications, this can also be used with functions from Servant.Server.StaticFiles to serve static files stored in a particular directory on your filesystem

Instances

HasRouter Raw Source #
Instance details Defined in Shpadoinkle.Router Associated Types type Raw :>> route :: Type Source # Methods route :: (Raw :>> route) -> Router route Source #
RunClient m => HasClient m Raw	Pick a `Method` and specify where the server you want to query is. You get back the full `ResponseF`.
Instance details Defined in Servant.Client.Core.HasClient Associated Types type Client m Raw :: Type # Methods clientWithRoute :: Proxy m -> Proxy Raw -> Request -> Client m Raw # hoistClientMonad :: Proxy m -> Proxy Raw -> (forall x. mon x -> mon' x) -> Client mon Raw -> Client mon' Raw #
ServeRouter Raw r Source #
Instance details Defined in Shpadoinkle.Router.Server Methods serveUI :: FilePath -> (r -> IO (Html m a)) -> (Raw :>> r) -> Server Raw Source #
HasLink Raw
Instance details Defined in Servant.Links Associated Types type MkLink Raw a :: Type # Methods toLink :: (Link -> a) -> Proxy Raw -> Link -> MkLink Raw a #
HasServer Raw context	Just pass the request to the underlying application and serve its response. Example: type MyApi = "images" :> Raw server :: Server MyApi server = serveDirectory "/var/www/images"
Instance details Defined in Servant.Server.Internal Associated Types type ServerT Raw m :: Type # Methods route :: Proxy Raw -> Context context -> Delayed env (Server Raw) -> Router env # hoistServerWithContext :: Proxy Raw -> Proxy context -> (forall x. m x -> n x) -> ServerT Raw m -> ServerT Raw n #
type Client m Raw
Instance details Defined in Servant.Client.Core.HasClient type Client m Raw = Method -> m Response
type Raw :>> a Source #
Instance details Defined in Shpadoinkle.Router type Raw :>> a = a
type MkLink Raw a
Instance details Defined in Servant.Links type MkLink Raw a = a
type ServerT Raw m
Instance details Defined in Servant.Server.Internal type ServerT Raw m = Tagged m Application

class (Applicative m, MonadIO m) => MonadJSM (m :: Type -> Type) #

The MonadJSM is to JSM what MonadIO is to IO. When using GHCJS it is MonadIO.

Instances

MonadJSM JSM
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> JSM a #
MonadJSM ClientM
Instance details Defined in Servant.Client.JS Methods liftJSM' :: JSM a -> ClientM a #
MonadJSM m => MonadJSM (MaybeT m)
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> MaybeT m a #
MonadJSM m => MonadJSM (ListT m)
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> ListT m a #
MonadJSM m => MonadJSM (IdentityT m)
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> IdentityT m a #
MonadJSM m => MonadJSM (ExceptT e m)
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> ExceptT e m a #
(Error e, MonadJSM m) => MonadJSM (ErrorT e m)
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> ErrorT e m a #
MonadJSM m => MonadJSM (StateT s m)
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> StateT s m a #
(Monoid w, MonadJSM m) => MonadJSM (WriterT w m)
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> WriterT w m a #
MonadJSM m => MonadJSM (StateT s m)
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> StateT s m a #
(Monoid w, MonadJSM m) => MonadJSM (WriterT w m)
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> WriterT w m a #
MonadJSM m => MonadJSM (ReaderT r m)
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> ReaderT r m a #
MonadJSM m => MonadJSM (ContT r m)
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> ContT r m a #
(Monoid w, MonadJSM m) => MonadJSM (RWST r w s m)
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> RWST r w s m a #
(Monoid w, MonadJSM m) => MonadJSM (RWST r w s m)
Instance details Defined in Language.Javascript.JSaddle.Types Methods liftJSM' :: JSM a -> RWST r w s m a #

class HasLink (endpoint :: k) where #

Construct a toLink for an endpoint.

Associated Types

type MkLink (endpoint :: k) a :: Type #

Methods

toLink #

Arguments

:: (Link -> a)
-> Proxy endpoint	The API endpoint you would like to point to
-> Link
-> MkLink endpoint a

Instances

HasLink Raw
Instance details Defined in Servant.Links Associated Types type MkLink Raw a :: Type # Methods toLink :: (Link -> a) -> Proxy Raw -> Link -> MkLink Raw a #
HasLink EmptyAPI
Instance details Defined in Servant.Links Associated Types type MkLink EmptyAPI a :: Type # Methods toLink :: (Link -> a) -> Proxy EmptyAPI -> Link -> MkLink EmptyAPI a #
HasLink (NoContentVerb m :: Type)
Instance details Defined in Servant.Links Associated Types type MkLink (NoContentVerb m) a :: Type # Methods toLink :: (Link -> a) -> Proxy (NoContentVerb m) -> Link -> MkLink (NoContentVerb m) a #
(HasLink a, HasLink b) => HasLink (a :<\|> b :: Type)
Instance details Defined in Servant.Links Associated Types type MkLink (a :<\|> b) a :: Type # Methods toLink :: (Link -> a0) -> Proxy (a :<\|> b) -> Link -> MkLink (a :<\|> b) a0 #
HasLink sub => HasLink (WithNamedContext name context sub :: Type)
Instance details Defined in Servant.Links Associated Types type MkLink (WithNamedContext name context sub) a :: Type # Methods toLink :: (Link -> a) -> Proxy (WithNamedContext name context sub) -> Link -> MkLink (WithNamedContext name context sub) a #
HasLink sub => HasLink (HttpVersion :> sub :: Type)
Instance details Defined in Servant.Links Associated Types type MkLink (HttpVersion :> sub) a :: Type # Methods toLink :: (Link -> a) -> Proxy (HttpVersion :> sub) -> Link -> MkLink (HttpVersion :> sub) a #
HasLink sub => HasLink (StreamBody' mods framing ct a :> sub :: Type)
Instance details Defined in Servant.Links Associated Types type MkLink (StreamBody' mods framing ct a :> sub) a :: Type # Methods toLink :: (Link -> a0) -> Proxy (StreamBody' mods framing ct a :> sub) -> Link -> MkLink (StreamBody' mods framing ct a :> sub) a0 #
HasLink sub => HasLink (ReqBody' mods ct a :> sub :: Type)
Instance details Defined in Servant.Links Associated Types type MkLink (ReqBody' mods ct a :> sub) a :: Type # Methods toLink :: (Link -> a0) -> Proxy (ReqBody' mods ct a :> sub) -> Link -> MkLink (ReqBody' mods ct a :> sub) a0 #
HasLink sub => HasLink (RemoteHost :> sub :: Type)
Instance details Defined in Servant.Links Associated Types type MkLink (RemoteHost :> sub) a :: Type # Methods toLink :: (Link -> a) -> Proxy (RemoteHost :> sub) -> Link -> MkLink (RemoteHost :> sub) a #
(KnownSymbol sym, ToHttpApiData v, HasLink sub, SBoolI (FoldRequired mods)) => HasLink (QueryParam' mods sym v :> sub :: Type)
Instance details Defined in Servant.Links Associated Types type MkLink (QueryParam' mods sym v :> sub) a :: Type # Methods toLink :: (Link -> a) -> Proxy (QueryParam' mods sym v :> sub) -> Link -> MkLink (QueryParam' mods sym v :> sub) a #
(KnownSymbol sym, ToHttpApiData v, HasLink sub) => HasLink (QueryParams sym v :> sub :: Type)
Instance details Defined in Servant.Links Associated Types type MkLink (QueryParams sym v :> sub) a :: Type # Methods toLink :: (Link -> a) -> Proxy (QueryParams sym v :> sub) -> Link -> MkLink (QueryParams sym v :> sub) a #
(KnownSymbol sym, HasLink sub) => HasLink (QueryFlag sym :> sub :: Type)
Instance details Defined in Servant.Links Associated Types type MkLink (QueryFlag sym :> sub) a :: Type # Methods toLink :: (Link -> a) -> Proxy (QueryFlag sym :> sub) -> Link -> MkLink (QueryFlag sym :> sub) a #
HasLink sub => HasLink (Header' mods sym a :> sub :: Type)
Instance details Defined in Servant.Links Associated Types type MkLink (Header' mods sym a :> sub) a :: Type # Methods toLink :: (Link -> a0) -> Proxy (Header' mods sym a :> sub) -> Link -> MkLink (Header' mods sym a :> sub) a0 #
HasLink sub => HasLink (IsSecure :> sub :: Type)
Instance details Defined in Servant.Links Associated Types type MkLink (IsSecure :> sub) a :: Type # Methods toLink :: (Link -> a) -> Proxy (IsSecure :> sub) -> Link -> MkLink (IsSecure :> sub) a #
HasLink sub => HasLink (AuthProtect tag :> sub :: Type)
Instance details Defined in Servant.Links Associated Types type MkLink (AuthProtect tag :> sub) a :: Type # Methods toLink :: (Link -> a) -> Proxy (AuthProtect tag :> sub) -> Link -> MkLink (AuthProtect tag :> sub) a #
HasLink sub => HasLink (Summary s :> sub :: Type)
Instance details Defined in Servant.Links Associated Types type MkLink (Summary s :> sub) a :: Type # Methods toLink :: (Link -> a) -> Proxy (Summary s :> sub) -> Link -> MkLink (Summary s :> sub) a #
HasLink sub => HasLink (Description s :> sub :: Type)
Instance details Defined in Servant.Links Associated Types type MkLink (Description s :> sub) a :: Type # Methods toLink :: (Link -> a) -> Proxy (Description s :> sub) -> Link -> MkLink (Description s :> sub) a #
(ToHttpApiData v, HasLink sub) => HasLink (Capture' mods sym v :> sub :: Type)
Instance details Defined in Servant.Links Associated Types type MkLink (Capture' mods sym v :> sub) a :: Type # Methods toLink :: (Link -> a) -> Proxy (Capture' mods sym v :> sub) -> Link -> MkLink (Capture' mods sym v :> sub) a #
(ToHttpApiData v, HasLink sub) => HasLink (CaptureAll sym v :> sub :: Type)
Instance details Defined in Servant.Links Associated Types type MkLink (CaptureAll sym v :> sub) a :: Type # Methods toLink :: (Link -> a) -> Proxy (CaptureAll sym v :> sub) -> Link -> MkLink (CaptureAll sym v :> sub) a #
HasLink sub => HasLink (BasicAuth realm a :> sub :: Type)
Instance details Defined in Servant.Links Associated Types type MkLink (BasicAuth realm a :> sub) a :: Type # Methods toLink :: (Link -> a0) -> Proxy (BasicAuth realm a :> sub) -> Link -> MkLink (BasicAuth realm a :> sub) a0 #
HasLink sub => HasLink (Vault :> sub :: Type)
Instance details Defined in Servant.Links Associated Types type MkLink (Vault :> sub) a :: Type # Methods toLink :: (Link -> a) -> Proxy (Vault :> sub) -> Link -> MkLink (Vault :> sub) a #
(KnownSymbol sym, HasLink sub) => HasLink (sym :> sub :: Type)
Instance details Defined in Servant.Links Associated Types type MkLink (sym :> sub) a :: Type # Methods toLink :: (Link -> a) -> Proxy (sym :> sub) -> Link -> MkLink (sym :> sub) a #
HasLink (Verb m s ct a :: Type)
Instance details Defined in Servant.Links Associated Types type MkLink (Verb m s ct a) a :: Type # Methods toLink :: (Link -> a0) -> Proxy (Verb m s ct a) -> Link -> MkLink (Verb m s ct a) a0 #
HasLink (Stream m status fr ct a :: Type)
Instance details Defined in Servant.Links Associated Types type MkLink (Stream m status fr ct a) a :: Type # Methods toLink :: (Link -> a0) -> Proxy (Stream m status fr ct a) -> Link -> MkLink (Stream m status fr ct a) a0 #