@@ -1,16 +1,23 @@
1−{-# LANGUAGE CPP #-}
1+{-# LANGUAGE AllowAmbiguousTypes #-}
2−{-# LANGUAGE DataKinds #-}
3+{-# LANGUAGE DataKinds #-}
3−{-# LANGUAGE FlexibleContexts #-}
4+{-# LANGUAGE FlexibleContexts #-}
4−{-# LANGUAGE FlexibleInstances #-}
5+{-# LANGUAGE FlexibleInstances #-}
6+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
5−{-# LANGUAGE InstanceSigs #-}
7+{-# LANGUAGE InstanceSigs #-}
6−{-# LANGUAGE MultiParamTypeClasses #-}
8+{-# LANGUAGE MultiParamTypeClasses #-}
7−{-# LANGUAGE OverloadedStrings #-}
9+{-# LANGUAGE OverloadedStrings #-}
8−{-# LANGUAGE PolyKinds #-}
10+{-# LANGUAGE PolyKinds #-}
11+{-# LANGUAGE Rank2Types #-}
9−{-# LANGUAGE ScopedTypeVariables #-}
12+{-# LANGUAGE ScopedTypeVariables #-}
10−{-# LANGUAGE TupleSections #-}
13+{-# LANGUAGE TupleSections #-}
11−{-# LANGUAGE TypeFamilies #-}
14+{-# LANGUAGE TypeFamilies #-}
12−{-# LANGUAGE TypeOperators #-}
15+{-# LANGUAGE TypeOperators #-}
13−{-# LANGUAGE UndecidableInstances #-}
16+{-# LANGUAGE UndecidableInstances #-}
18+#if MIN_VERSION_base(4,9,0)
19+{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
15-- #include "overlapping-compat.h"
22-- #include "overlapping-compat.h"
16-- | This module provides 'client' which can automatically generate
23-- | This module provides 'client' which can automatically generate
@@ -18,47 +25,71 @@
19module Servant.Reflex
26module Servant.Reflex
21− , HasClient(..)
28+ , clientWithOpts
29+ , clientWithOptsAndResultHandler
31+ , clientWithRouteAndResultHandler
32+ , BuildHeaderKeysTo(..)
22 , module Servant.Common.Req
36 , module Servant.Common.Req
23 , module Servant.Common.BaseUrl
37 , module Servant.Common.BaseUrl
26−-------------------------------------------------------------------------------
40+------------------------------------------------------------------------------
27import Control.Applicative
41import Control.Applicative
28−import Data.CaseInsensitive (mk)
42+import qualified Data.CaseInsensitive as CI
43+import Data.Functor.Identity
29−import qualified Data.Map as Map
44+import qualified Data.Map as Map
30−import Data.Monoid ((<>))
45+import Data.Monoid ((<>))
31−import Data.Proxy (Proxy (..))
46+import Data.Proxy (Proxy (..))
32−import qualified Data.Set as Set
47+import qualified Data.Set as Set
33−import Data.Text (Text)
48+import Data.Text (Text)
34−import qualified Data.Text as T
49+import qualified Data.Text as T
35−import qualified Data.Text.Encoding as E
50+import qualified Data.Text.Encoding as E
51+import GHC.Exts (Constraint)
36−import GHC.TypeLits (KnownSymbol, symbolVal)
52+import GHC.TypeLits (KnownSymbol, symbolVal)
37−import Reflex.Dom (Dynamic, Event, Reflex,
38− XhrRequest (..), XhrResponse (..),
39− XhrResponseHeaders (..), ffor,
41− performRequestAsync, tagPromptlyDyn)
42−import Servant.API ((:<|>) (..), (:>), BasicAuth,
53+import Servant.API ((:<|>) (..), (:>), BasicAuth,
43− BasicAuthData, BuildHeadersTo (..),
54+ BasicAuthData, BuildHeadersTo (..),
44− Capture, Header, Headers (..),
55+ Capture, Header, Headers (..),
45− HttpVersion, IsSecure, MimeRender (..),
56+ HttpVersion, IsSecure,
57+ MimeRender (..), MimeUnrender,
46− MimeUnrender, NoContent, QueryFlag,
58+ NoContent, QueryFlag, QueryParam,
47− QueryParam, QueryParams, Raw,
59+ QueryParams, Raw, ReflectMethod (..),
48− ReflectMethod (..), RemoteHost,
60+ RemoteHost, ReqBody,
49− ReqBody, ToHttpApiData (..), Vault,
61+ ToHttpApiData (..), Vault, Verb,
50− Verb, contentType)
62+ contentType)
63+import Servant.API.Description (Summary)
64+import qualified Servant.Auth as Auth
66+import Reflex.Dom.Core (Dynamic, Event, Reflex,
67+ XhrRequest (..), XhrResponse (..),
68+ XhrResponseHeaders (..),
69+ attachPromptlyDynWith, constDyn, ffor,
71+ performRequestsAsync)
72+------------------------------------------------------------------------------
51−import Servant.Common.BaseUrl (BaseUrl (..), Scheme (..),
73+import Servant.Common.BaseUrl (BaseUrl(..), Scheme(..), baseUrlWidget,
52− SupportsServantReflex, baseUrlWidget,
53− showBaseUrl)
74+ showBaseUrl,
75+ SupportsServantReflex)
54−import Servant.Common.Req (QParam (..), QueryPart (..), Req,
76+import Servant.Common.Req (ClientOptions(..),
77+ defaultClientOptions,
78+ Req, ReqResult(..), QParam(..),
55− ReqResult (..), addHeader, authData,
79+ QueryPart(..), addHeader, authData,
80+ defReq, evalResponse, prependToPathParts,
56− defReq, performRequestCT,
81+ -- performRequestCT,
57− performRequestNoBody,
83+ -- performRequestNoBody,
84+ performRequestsNoBody,
85+ performSomeRequestsAsync,
58− prependToPathParts, qParamToQueryPart,
86+ qParamToQueryPart, reqBody,
59− qParams, reqBody, reqFailure,
87+ reqSuccess, reqFailure,
60− reqMethod, reqSuccess, respHeaders,
88+ reqMethod, respHeaders,
61− response)
89+ response,
91+ qParams, withCredentials)
63-- * Accessing APIs as a Client
94-- * Accessing APIs as a Client
@@ -70,28 +101,78 @@ import Servant.Common.Req (QParam (..), QueryPart (..), Req,
70-- > myApi :: Proxy MyApi
101-- > myApi :: Proxy MyApi
71-- > myApi = Proxy
102-- > myApi = Proxy
73−-- > getAllBooks :: Event t () -> m (Event t (Either XhrError ((),[Book])))
104+-- > getAllBooks :: Event t l -> m (Event t (l, ReqResult [Book]))
74−-- > postNewBook :: Dynamic t (Maybe Book) -> Event t ()
105+-- > postNewBook :: Dynamic t (Maybe Book) -> Event t l
75−-- -> m (Event t (Either XhrError (Book,Book)))
106+-- > -> m (Event t (l, ReqResult Book)))
76-- > (getAllBooks :<|> postNewBook) = client myApi host
107-- > (getAllBooks :<|> postNewBook) = client myApi host
77-- > where host = constDyn $ BaseUrl Http "localhost" 8080
108-- > where host = constDyn $ BaseUrl Http "localhost" 8080
110+ :: (HasClient t m layout tag)
114+ -> Dynamic t BaseUrl
115+ -> Client t m layout tag
116+client p q t baseurl = clientWithRoute p q t defReq baseurl defaultClientOptions
78−client :: (HasClient t m layout)
119+ :: (HasClient t m layout tag)
123+ -> Dynamic t BaseUrl
125+ -> Client t m layout tag
126+clientWithOpts p q t baseurl = clientWithRoute p q t defReq baseurl
128+-- | Like 'clientWithOpts' but allows passing a function which will process the
129+-- result event in some way. This can be used to handle errors in a uniform way
130+-- across call sites.
131+clientWithOptsAndResultHandler
132+ :: (HasClient t m layout tag)
79− => Proxy layout -> Proxy m -> Dynamic t BaseUrl -> Client t m layout
136+ -> Dynamic t BaseUrl
80−client p q = clientWithRoute p q defReq
137+ -> ClientOptions
138+ -> (forall a. Event t (ReqResult tag a) -> m (Event t (ReqResult tag a)))
139+ -> Client t m layout tag
140+clientWithOptsAndResultHandler p q t = clientWithRouteAndResultHandler p q t defReq
82-- | This class lets us define how each API combinator
143-- | This class lets us define how each API combinator
83-- influences the creation of an HTTP request. It's mostly
144-- influences the creation of an HTTP request. It's mostly
84-- an internal class, you can just use 'client'.
145-- an internal class, you can just use 'client'.
85−class HasClient t m layout where
146+class Monad m => HasClient t m layout (tag :: *) where
86− type Client t m layout :: *
147+ type Client t m layout tag :: *
87− clientWithRoute :: Proxy layout -> Proxy m -> Req t -> Dynamic t BaseUrl -> Client t m layout
148+ clientWithRoute
153+ -> Dynamic t BaseUrl
155+ -> Client t m layout tag
156+ clientWithRoute l m t r b o = clientWithRouteAndResultHandler l m t r b o return
158+ clientWithRouteAndResultHandler
163+ -> Dynamic t BaseUrl
165+ -> (forall a. Event t (ReqResult tag a) -> m (Event t (ReqResult tag a)))
166+ -> Client t m layout tag
169+instance (HasClient t m a tag, HasClient t m b tag) => HasClient t m (a :<|> b) tag where
170+ type Client t m (a :<|> b) tag = Client t m a tag :<|> Client t m b tag
172+ clientWithRouteAndResultHandler Proxy q pTag req baseurl opts wrap =
173+ clientWithRouteAndResultHandler (Proxy :: Proxy a) q pTag req baseurl opts wrap :<|>
174+ clientWithRouteAndResultHandler (Proxy :: Proxy b) q pTag req baseurl opts wrap
90−instance (HasClient t m a, HasClient t m b) => HasClient t m (a :<|> b) where
91− type Client t m (a :<|> b) = Client t m a :<|> Client t m b
92− clientWithRoute Proxy q req baseurl =
93− clientWithRoute (Proxy :: Proxy a) q req baseurl :<|>
94− clientWithRoute (Proxy :: Proxy b) q req baseurl
96-- Capture. Example:
177-- Capture. Example:
97-- > type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
178-- > type MyApi = "books" :> Capture "isbn" Text :> Get '[JSON] Book
@@ -101,67 +182,72 @@ instance (HasClient t m a, HasClient t m b) => HasClient t m (a :<|> b) where
101-- > getBook :: SupportsServantReflex t m
182-- > getBook :: SupportsServantReflex t m
102-- => Dynamic t BaseUrl
183-- => Dynamic t BaseUrl
103-- -> Dynamic t (Maybe Text)
184-- -> Dynamic t (Maybe Text)
104−-- -> Event t ()
185+-- -> Event t l
105−-- -> m (Event t (Either XhrError (Text, Book)))
186+-- -> m (Event t (l, ReqResult Book))
106-- > getBook = client myApi (constDyn host)
187-- > getBook = client myApi (constDyn host)
107−instance (SupportsServantReflex t m, ToHttpApiData a, HasClient t m sublayout)
108− => HasClient t m (Capture capture a :> sublayout) where
189+instance (SupportsServantReflex t m, ToHttpApiData a, HasClient t m sublayout tag)
110− type Client t m (Capture capture a :> sublayout) =
190+ => HasClient t m (Capture capture a :> sublayout) tag where
111− Dynamic t (Either Text a) -> Client t m sublayout
192+ type Client t m (Capture capture a :> sublayout) tag =
193+ Dynamic t (Either Text a) -> Client t m sublayout tag
113− clientWithRoute Proxy q req baseurl val =
195+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap val =
114− clientWithRoute (Proxy :: Proxy sublayout)
196+ clientWithRouteAndResultHandler
116− (prependToPathParts p req)
197+ (Proxy :: Proxy sublayout) q t (prependToPathParts p req) baseurl opts wrap
117− baseurl
198+ where p = (fmap . fmap) (toUrlPiece) val
119− where p = (fmap . fmap) toUrlPiece val
121-- VERB (Returning content) --
201-- VERB (Returning content) --
122instance {-# OVERLAPPABLE #-}
202instance {-# OVERLAPPABLE #-}
123 -- Note [Non-Empty Content Types]
203 -- Note [Non-Empty Content Types]
124 (MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts), SupportsServantReflex t m
204 (MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts), SupportsServantReflex t m
125− ) => HasClient t m (Verb method status cts' a) where
205+ ) => HasClient t m (Verb method status cts' a) tag where
126− type Client t m (Verb method status cts' a) =
206+ type Client t m (Verb method status cts' a) tag =
127− Event t () -> m (Event t (ReqResult a))
207+ Event t tag -> m (Event t (ReqResult tag a))
128 -- TODO how to access input types here?
208 -- TODO how to access input types here?
129 -- ExceptT ServantError IO a
209 -- ExceptT ServantError IO a
130− clientWithRoute Proxy _ req =
210+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
131− performRequestCT (Proxy :: Proxy ct) method req'
211+ wrap =<< fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity $ req') baseurl opts trigs
132 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
212 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
133 req' = req { reqMethod = method }
213 req' = req { reqMethod = method }
135-- -- VERB (No content) --
216-- -- VERB (No content) --
136instance {-# OVERLAPPING #-}
217instance {-# OVERLAPPING #-}
137 (ReflectMethod method, SupportsServantReflex t m) =>
218 (ReflectMethod method, SupportsServantReflex t m) =>
138− HasClient t m (Verb method status cts NoContent) where
219+ HasClient t m (Verb method status cts NoContent) tag where
139− type Client t m (Verb method status cts NoContent) =
220+ type Client t m (Verb method status cts NoContent) tag =
140− Event t () -> m (Event t (ReqResult NoContent))
221+ Event t tag -> m (Event t (ReqResult tag NoContent))
141 -- TODO: how to access input types here?
222 -- TODO: how to access input types here?
142 -- ExceptT ServantError IO NoContent
223 -- ExceptT ServantError IO NoContent
143− clientWithRoute Proxy _ =
224+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
144− performRequestNoBody method
225+ wrap =<< fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req) baseurl opts trigs
145 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
226 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
147−toHeaders :: BuildHeadersTo ls => ReqResult a -> ReqResult (Headers ls a)
229+toHeaders :: BuildHeadersTo ls => ReqResult tag a -> ReqResult tag (Headers ls a)
148toHeaders r =
230toHeaders r =
149− let toBS = E.encodeUtf8
150− hdrs = maybe []
231+ let hdrs = maybe []
151− (\xhr -> fmap (\(h,v) -> (mk (toBS h), toBS v))
232+ (\xhr -> fmap (\(h,v) -> (CI.map E.encodeUtf8 h, E.encodeUtf8 v))
152 (Map.toList $ _xhrResponse_headers xhr))
233 (Map.toList $ _xhrResponse_headers xhr))
153 (response r)
234 (response r)
154 in ffor r $ \a -> Headers {getResponse = a ,getHeadersHList = buildHeadersTo hdrs}
235 in ffor r $ \a -> Headers {getResponse = a ,getHeadersHList = buildHeadersTo hdrs}
156class BuildHeaderKeysTo hs where
238class BuildHeaderKeysTo hs where
157− buildHeaderKeysTo :: Proxy hs -> [T.Text]
239+ buildHeaderKeysTo :: Proxy hs -> [CI.CI T.Text]
159instance {-# OVERLAPPABLE #-} BuildHeaderKeysTo '[]
241instance {-# OVERLAPPABLE #-} BuildHeaderKeysTo '[]
160 where buildHeaderKeysTo _ = []
242 where buildHeaderKeysTo _ = []
162instance {-# OVERLAPPABLE #-} (BuildHeaderKeysTo xs, KnownSymbol h)
244instance {-# OVERLAPPABLE #-} (BuildHeaderKeysTo xs, KnownSymbol h)
163− => BuildHeaderKeysTo '[(Header h v) ': xs] where
245+ => BuildHeaderKeysTo ((Header h v) ': xs) where
246+ buildHeaderKeysTo _ =
248+ thisKey = CI.mk $ T.pack (symbolVal (Proxy :: Proxy h))
164− buildHeaderKeysTo _ = T.pack (symbolVal (Proxy :: Proxy h)) : buildHeaderKeysTo (Proxy :: Proxy xs)
249+ in thisKey : buildHeaderKeysTo (Proxy :: Proxy xs)
166-- HEADERS Verb (Content) --
252-- HEADERS Verb (Content) --
167-- Headers combinator not treated in fully general case,
253-- Headers combinator not treated in fully general case,
@@ -173,33 +259,35 @@ instance {-# OVERLAPPABLE #-}
173 ( MimeUnrender ct a, BuildHeadersTo ls, BuildHeaderKeysTo ls,
259 ( MimeUnrender ct a, BuildHeadersTo ls, BuildHeaderKeysTo ls,
174 ReflectMethod method, cts' ~ (ct ': cts),
260 ReflectMethod method, cts' ~ (ct ': cts),
175 SupportsServantReflex t m
261 SupportsServantReflex t m
176− ) => HasClient t m (Verb method status cts' (Headers ls a)) where
262+ ) => HasClient t m (Verb method status cts' (Headers ls a)) tag where
177− type Client t m (Verb method status cts' (Headers ls a)) =
263+ type Client t m (Verb method status cts' (Headers ls a)) tag =
178− Event t () -> m (Event t (ReqResult (Headers ls a)))
264+ Event t tag -> m (Event t (ReqResult tag (Headers ls a)))
179− clientWithRoute Proxy _ req baseurl = do
265+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
180 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
266 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
181− resp <- performRequestCT (Proxy :: Proxy ct) method req' baseurl
267+ resp <- fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity req') baseurl opts trigs
182− return $ (fmap . fmap) toHeaders resp
268+ wrap $ toHeaders <$> resp
183 where req' = req { respHeaders =
269 where req' = req { respHeaders =
184 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
270 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
187-- HEADERS Verb (No content) --
274-- HEADERS Verb (No content) --
188instance {-# OVERLAPPABLE #-}
275instance {-# OVERLAPPABLE #-}
189 ( BuildHeadersTo ls, BuildHeaderKeysTo ls, ReflectMethod method,
276 ( BuildHeadersTo ls, BuildHeaderKeysTo ls, ReflectMethod method,
190 SupportsServantReflex t m
277 SupportsServantReflex t m
191− ) => HasClient t m (Verb method status cts (Headers ls NoContent)) where
278+ ) => HasClient t m (Verb method status cts (Headers ls NoContent)) tag where
192− type Client t m (Verb method status cts (Headers ls NoContent))
279+ type Client t m (Verb method status cts (Headers ls NoContent)) tag
193− = Event t () -> m (Event t (ReqResult (Headers ls NoContent)))
280+ = Event t tag -> m (Event t (ReqResult tag (Headers ls NoContent)))
194− clientWithRoute Proxy _ req baseurl = do
281+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
195 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
282 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
196− resp <- performRequestNoBody method req' baseurl
283+ resp <- fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req') baseurl opts trigs
197− return $ (fmap . fmap) toHeaders resp
284+ wrap $ toHeaders <$> resp
198 where req' = req {respHeaders =
285 where req' = req {respHeaders =
199 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
286 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
204-- > newtype Referer = Referer { referrer :: Text }
292-- > newtype Referer = Referer { referrer :: Text }
205-- > deriving (Eq, Show, Generic, FromText, ToHttpApiData)
293-- > deriving (Eq, Show, Generic, FromText, ToHttpApiData)
@@ -214,28 +302,45 @@ instance {-# OVERLAPPABLE #-}
214-- > -- then you can just use "viewRefer" to query that endpoint
302-- > -- then you can just use "viewRefer" to query that endpoint
215-- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
303-- > -- specifying Nothing or e.g Just "http://haskell.org/" as arguments
216instance (KnownSymbol sym, ToHttpApiData a,
304instance (KnownSymbol sym, ToHttpApiData a,
217− HasClient t m sublayout, SupportsServantReflex t m)
305+ HasClient t m sublayout tag, SupportsServantReflex t m)
218− => HasClient t m (Header sym a :> sublayout) where
306+ => HasClient t m (Header sym a :> sublayout) tag where
220− type Client t m (Header sym a :> sublayout) =
308+ type Client t m (Header sym a :> sublayout) tag =
221− Dynamic t (Either Text a) -> Client t m sublayout
309+ Dynamic t (Either Text a) -> Client t m sublayout tag
223− clientWithRoute Proxy q req baseurl eVal =
311+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap eVal =
312+ clientWithRouteAndResultHandler
224− clientWithRoute (Proxy :: Proxy sublayout)
313+ (Proxy :: Proxy sublayout) q t
226− (Servant.Common.Req.addHeader hname eVal req)
314+ (Servant.Common.Req.addHeader hname eVal req)
227− baseurl
315+ baseurl opts wrap
228 where hname = T.pack $ symbolVal (Proxy :: Proxy sym)
316 where hname = T.pack $ symbolVal (Proxy :: Proxy sym)
230-- | Using a 'HttpVersion' combinator in your API doesn't affect the client
321-- | Using a 'HttpVersion' combinator in your API doesn't affect the client
231-- functions.
322-- functions.
232−instance HasClient t m sublayout
323+instance HasClient t m sublayout tag
233− => HasClient t m (HttpVersion :> sublayout) where
324+ => HasClient t m (HttpVersion :> sublayout) tag where
326+ type Client t m (HttpVersion :> sublayout) tag =
327+ Client t m sublayout tag
329+ clientWithRouteAndResultHandler Proxy =
330+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout)
332+-- | Using a 'Summary' combinator in your API doesn't affect the client
334+instance (HasClient t m sublayout tag, KnownSymbol sym)
335+ => HasClient t m (Summary sym :> sublayout) tag where
337+ type Client t m (Summary sym :> sublayout) tag =
338+ Client t m sublayout tag
340+ clientWithRouteAndResultHandler Proxy =
341+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout)
235− type Client t m (HttpVersion :> sublayout) =
236− Client t m sublayout
238− clientWithRoute Proxy = clientWithRoute (Proxy :: Proxy sublayout)
241-- | If you use a 'QueryParam' in one of your endpoints in your API,
346-- | If you use a 'QueryParam' in one of your endpoints in your API,
@@ -264,16 +369,16 @@ instance HasClient t m sublayout
264-- > -- then you can just use "getBooksBy" to query that endpoint.
369-- > -- then you can just use "getBooksBy" to query that endpoint.
265-- > -- 'getBooksBy Nothing' for all books
370-- > -- 'getBooksBy Nothing' for all books
266-- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
371-- > -- 'getBooksBy (Just "Isaac Asimov")' to get all books by Isaac Asimov
267−instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
372+instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex t)
268− => HasClient t m (QueryParam sym a :> sublayout) where
373+ => HasClient t m (QueryParam sym a :> sublayout) tag where
270− type Client t m (QueryParam sym a :> sublayout) =
375+ type Client t m (QueryParam sym a :> sublayout) tag =
271− Dynamic t (QParam a) -> Client t m sublayout
376+ Dynamic t (QParam a) -> Client t m sublayout tag
273 -- if mparam = Nothing, we don't add it to the query string
378 -- if mparam = Nothing, we don't add it to the query string
274− clientWithRoute Proxy q req baseurl mparam =
379+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap mparam =
275− clientWithRoute (Proxy :: Proxy sublayout) q
380+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t
276− (req {qParams = paramPair : qParams req}) baseurl
381+ (req {qParams = paramPair : qParams req}) baseurl opts wrap
278 where pname = symbolVal (Proxy :: Proxy sym)
383 where pname = symbolVal (Proxy :: Proxy sym)
279 --p prm = QueryPartParam $ (fmap . fmap) (toQueryParam) prm
384 --p prm = QueryPartParam $ (fmap . fmap) (toQueryParam) prm
@@ -281,6 +386,8 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
281 p prm = QueryPartParam $ fmap qParamToQueryPart prm -- (fmap . fmap) (unpack . toQueryParam) prm
386 p prm = QueryPartParam $ fmap qParamToQueryPart prm -- (fmap . fmap) (unpack . toQueryParam) prm
282 paramPair = (T.pack pname, p mparam)
387 paramPair = (T.pack pname, p mparam)
284-- | If you use a 'QueryParams' in one of your endpoints in your API,
391-- | If you use a 'QueryParams' in one of your endpoints in your API,
285-- the corresponding querying function will automatically take
392-- the corresponding querying function will automatically take
286-- an additional argument, a list of values of the type specified
393-- an additional argument, a list of values of the type specified
@@ -309,14 +416,14 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
309-- > -- 'getBooksBy []' for all books
416-- > -- 'getBooksBy []' for all books
310-- > -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]'
417-- > -- 'getBooksBy ["Isaac Asimov", "Robert A. Heinlein"]'
311-- > -- to get all books by Asimov and Heinlein
418-- > -- to get all books by Asimov and Heinlein
312−instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
419+instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex t)
313− => HasClient t m (QueryParams sym a :> sublayout) where
420+ => HasClient t m (QueryParams sym a :> sublayout) tag where
315− type Client t m (QueryParams sym a :> sublayout) =
422+ type Client t m (QueryParams sym a :> sublayout) tag =
316− Dynamic t [a] -> Client t m sublayout
423+ Dynamic t [a] -> Client t m sublayout tag
318− clientWithRoute Proxy q req baseurl paramlist =
425+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap paramlist =
319− clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
426+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
321 where req' = req { qParams = (T.pack pname, params') : qParams req }
428 where req' = req { qParams = (T.pack pname, params') : qParams req }
322 pname = symbolVal (Proxy :: Proxy sym)
429 pname = symbolVal (Proxy :: Proxy sym)
@@ -324,6 +431,7 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
324 paramlist
431 paramlist
327-- | If you use a 'QueryFlag' in one of your endpoints in your API,
435-- | If you use a 'QueryFlag' in one of your endpoints in your API,
328-- the corresponding querying function will automatically take
436-- the corresponding querying function will automatically take
329-- an additional 'Bool' argument.
437-- an additional 'Bool' argument.
@@ -348,49 +456,42 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout, Reflex t)
348-- > -- 'getBooksBy True' to only get _already published_ books
456-- > -- 'getBooksBy True' to only get _already published_ books
350-- TODO Bring back
458-- TODO Bring back
351−instance (KnownSymbol sym, HasClient t m sublayout, Reflex t)
459+instance (KnownSymbol sym, HasClient t m sublayout tag, Reflex t)
352− => HasClient t m (QueryFlag sym :> sublayout) where
460+ => HasClient t m (QueryFlag sym :> sublayout) tag where
354− type Client t m (QueryFlag sym :> sublayout) =
462+ type Client t m (QueryFlag sym :> sublayout) tag =
355− Dynamic t Bool -> Client t m sublayout
463+ Dynamic t Bool -> Client t m sublayout tag
357− clientWithRoute Proxy q req baseurl flag =
465+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap flag =
358− clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
466+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
360 where req' = req { qParams = thisPair : qParams req }
468 where req' = req { qParams = thisPair : qParams req }
361 thisPair = (T.pack pName, QueryPartFlag flag) :: (Text, QueryPart t)
469 thisPair = (T.pack pName, QueryPartFlag flag) :: (Text, QueryPart t)
362 pName = symbolVal (Proxy :: Proxy sym)
470 pName = symbolVal (Proxy :: Proxy sym)
365−-- | Pick a 'Method' and specify where the server you want to query is. You get
473+
366−-- back the full `Response`.
474+-- | Send a raw 'XhrRequest ()' directly to 'baseurl'
368−instance SupportsServantReflex t m => HasClient t m Raw where
475+instance SupportsServantReflex t m => HasClient t m Raw tag where
369− type Client t m Raw = Dynamic t (Either Text (XhrRequest ()))
476+ type Client t m Raw tag = Dynamic t (Either Text (XhrRequest ()))
370− -> Event t ()
477+ -> Event t tag
371− -> m (Event t (ReqResult ()))
478+ -> m (Event t (ReqResult tag ()))
373− -- clientWithRoute :: Proxy Raw -> Proxy m -> Req -> BaseUrl -> Client t m Raw
374− clientWithRoute _ _ _ baseurl xhrs triggers = do
480+ clientWithRouteAndResultHandler _ _ _ _ baseurl _ wrap xhrs triggers = do
375− let xhrs' = liftA2 (\x path -> case x of
482+ let xhrs' = liftA2 (\x path -> case x of
376− Left e -> Left e
483+ Left e -> Left e
377− Right jx -> Right $ jx {_xhrRequest_url = path
484+ Right jx -> Right $ jx { _xhrRequest_url = path <> _xhrRequest_url jx }
378− <> _xhrRequest_url jx})
380− (showBaseUrl <$> baseurl)
485+ ) xhrs (showBaseUrl <$> baseurl)
381− reqs = tagPromptlyDyn xhrs' triggers
486+ xhrs'' = attachPromptlyDynWith (flip (,)) xhrs' triggers :: Event t (tag, Either Text (XhrRequest ()))
382− okReq = fmapMaybe hush reqs
487+ badReq = fmapMaybe (\(t,x) -> either (Just . (t,)) (const Nothing) x) xhrs'' :: Event t (tag, Text)
383− badReq = fmapMaybe tattle reqs
488+ okReq = fmapMaybe (\(t,x) -> either (const Nothing) (Just . (t,)) x) xhrs'' :: Event t (tag, XhrRequest ())
384− resps <- performRequestAsync okReq
489+
385− return $ leftmost [fmap (ResponseSuccess () ) resps
490+ resps <- performRequestsAsync okReq
386− ,fmap RequestFailure badReq]
491+ wrap $ leftmost [ uncurry RequestFailure <$> badReq
387−
492+ , evalResponse (const $ Right ()) <$> resps
389−hush :: Either e a -> Maybe a
494+
390−hush = either (const Nothing) Just
392−tattle :: Either e a -> Maybe e
393−tattle = either Just (const Nothing)
395-- | If you use a 'ReqBody' in one of your endpoints in your API,
496-- | If you use a 'ReqBody' in one of your endpoints in your API,
396-- the corresponding querying function will automatically take
497-- the corresponding querying function will automatically take
@@ -412,14 +513,14 @@ tattle = either Just (const Nothing)
412-- > where host = BaseUrl Http "localhost" 8080
513-- > where host = BaseUrl Http "localhost" 8080
413-- > -- then you can just use "addBook" to query that endpoint
514-- > -- then you can just use "addBook" to query that endpoint
415−instance (MimeRender ct a, HasClient t m sublayout, Reflex t)
516+instance (MimeRender ct a, HasClient t m sublayout tag, Reflex t)
416− => HasClient t m (ReqBody (ct ': cts) a :> sublayout) where
517+ => HasClient t m (ReqBody (ct ': cts) a :> sublayout) tag where
418− type Client t m (ReqBody (ct ': cts) a :> sublayout) =
519+ type Client t m (ReqBody (ct ': cts) a :> sublayout) tag =
419− Dynamic t (Either Text a) -> Client t m sublayout
520+ Dynamic t (Either Text a) -> Client t m sublayout tag
421− clientWithRoute Proxy q req baseurl body =
522+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap body =
422− clientWithRoute (Proxy :: Proxy sublayout) q req' baseurl
523+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
423 where req' = req { reqBody = bodyBytesCT }
524 where req' = req { reqBody = bodyBytesCT }
424 ctProxy = Proxy :: Proxy ct
525 ctProxy = Proxy :: Proxy ct
425 ctString = T.pack $ show $ contentType ctProxy
526 ctString = T.pack $ show $ contentType ctProxy
@@ -427,39 +528,49 @@ instance (MimeRender ct a, HasClient t m sublayout, Reflex t)
427 (\b -> (mimeRender ctProxy b, ctString))
528 (\b -> (mimeRender ctProxy b, ctString))
430-- | Make the querying function append @path@ to the request path.
533-- | Make the querying function append @path@ to the request path.
431−instance (KnownSymbol path, HasClient t m sublayout, Reflex t) => HasClient t m (path :> sublayout) where
534+instance (KnownSymbol path, HasClient t m sublayout tag, Reflex t) => HasClient t m (path :> sublayout) tag where
432− type Client t m (path :> sublayout) = Client t m sublayout
535+ type Client t m (path :> sublayout) tag = Client t m sublayout tag
434− clientWithRoute Proxy q req =
537+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap =
435− clientWithRoute (Proxy :: Proxy sublayout) q
538+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t
436− (prependToPathParts (pure (Right $ T.pack p)) req)
539+ (prependToPathParts (pure (Right $ T.pack p)) req) baseurl opts wrap
438 where p = symbolVal (Proxy :: Proxy path)
541 where p = symbolVal (Proxy :: Proxy path)
440−instance HasClient t m api => HasClient t m (Vault :> api) where
441− type Client t m (Vault :> api) = Client t m api
443− clientWithRoute Proxy = clientWithRoute (Proxy :: Proxy api)
544+instance HasClient t m api tag => HasClient t m (Vault :> api) tag where
545+ type Client t m (Vault :> api) tag = Client t m api tag
547+ clientWithRouteAndResultHandler Proxy =
548+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
551+instance HasClient t m api tag => HasClient t m (RemoteHost :> api) tag where
552+ type Client t m (RemoteHost :> api) tag = Client t m api tag
554+ clientWithRouteAndResultHandler Proxy =
555+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
445−instance HasClient t m api => HasClient t m (RemoteHost :> api) where
446− type Client t m (RemoteHost :> api) = Client t m api
448− clientWithRoute Proxy = clientWithRoute (Proxy :: Proxy api)
450−instance HasClient t m api => HasClient t m (IsSecure :> api) where
559+instance HasClient t m api tag => HasClient t m (IsSecure :> api) tag where
451− type Client t m (IsSecure :> api) = Client t m api
560+ type Client t m (IsSecure :> api) tag = Client t m api tag
453− clientWithRoute Proxy = clientWithRoute (Proxy :: Proxy api)
562+ clientWithRouteAndResultHandler Proxy =
563+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
455−instance (HasClient t m api, Reflex t)
456− => HasClient t m (BasicAuth realm usr :> api) where
566+instance (HasClient t m api tag, Reflex t)
458− type Client t m (BasicAuth realm usr :> api) = Dynamic t (Maybe BasicAuthData)
567+ => HasClient t m (BasicAuth realm usr :> api) tag where
569+ type Client t m (BasicAuth realm usr :> api) tag = Dynamic t (Maybe BasicAuthData)
570+ -> Client t m api tag
461− clientWithRoute Proxy q req baseurl authdata =
572+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap authdata =
462− clientWithRoute (Proxy :: Proxy api) q req' baseurl
573+ clientWithRouteAndResultHandler (Proxy :: Proxy api) q t req' baseurl opts wrap
464 req' = req { authData = Just authdata }
575 req' = req { authData = Just authdata }
@@ -485,3 +596,30 @@ non-empty lists, but is otherwise more specific, no instance will be overall
485more specific. This in turn generally means adding yet another instance (one
596more specific. This in turn generally means adding yet another instance (one
486for empty and one for non-empty lists).
597for empty and one for non-empty lists).
601+-- SUPPORT FOR servant-auth --
603+-- For JavaScript clients we should be sending/storing JSON web tokens in a
604+-- way that is inaccessible to JavaScript.
606+-- For @servant-auth@ this is done with HTTP-only cookies. In a Reflex-DOM
607+-- app this means the @servant-auth@ client should only verify that the API
608+-- supports Cookie-based authentication but do nothing with the token
611+-- @HasCookieAuth auths@ is nominally a redundant constraint, but ensures
612+-- we're not trying to rely on cookies when the API does not use them.
613+instance (HasCookieAuth auths, HasClient t m api tag) => HasClient t m (Auth.Auth auths a :> api) tag where
615+ type Client t m (Auth.Auth auths a :> api) tag = Client t m api tag
616+ clientWithRouteAndResultHandler Proxy = clientWithRouteAndResultHandler (Proxy :: Proxy api)
619+type family HasCookieAuth xs :: Constraint where
620+ HasCookieAuth (Auth.Cookie ': xs) = ()
621+ HasCookieAuth (x ': xs) = HasCookieAuth xs
622+ HasCookieAuth '[] = CookieAuthNotEnabled
624+class CookieAuthNotEnabled