@@ -1,24 +1,23 @@
1−{-# LANGUAGE AllowAmbiguousTypes #-}
2−{-# LANGUAGE CPP #-}
3−{-# LANGUAGE DataKinds #-}
4−{-# LANGUAGE FlexibleContexts #-}
5−{-# LANGUAGE FlexibleInstances #-}
6−{-# LANGUAGE InstanceSigs #-}
7−{-# LANGUAGE OverloadedStrings #-}
8−{-# LANGUAGE PolyKinds #-}
9−{-# LANGUAGE ScopedTypeVariables #-}
10−{-# LANGUAGE TupleSections #-}
11−{-# LANGUAGE TypeFamilies #-}
12−{-# LANGUAGE TypeOperators #-}
13−{-# LANGUAGE UndecidableInstances #-}
14−{-# LANGUAGE MultiParamTypeClasses #-}
15−{-# LANGUAGE OverloadedStrings #-}
16−{-# LANGUAGE PolyKinds #-}
17−{-# LANGUAGE ScopedTypeVariables #-}
18−{-# LANGUAGE TupleSections #-}
19−{-# LANGUAGE TypeFamilies #-}
20−{-# LANGUAGE TypeOperators #-}
21−{-# LANGUAGE UndecidableInstances #-}
1+{-# LANGUAGE AllowAmbiguousTypes #-}
2+{-# LANGUAGE CPP #-}
3+{-# LANGUAGE DataKinds #-}
4+{-# LANGUAGE FlexibleContexts #-}
5+{-# LANGUAGE FlexibleInstances #-}
6+{-# LANGUAGE GeneralizedNewtypeDeriving #-}
7+{-# LANGUAGE InstanceSigs #-}
8+{-# LANGUAGE MultiParamTypeClasses #-}
9+{-# LANGUAGE OverloadedStrings #-}
10+{-# LANGUAGE PolyKinds #-}
11+{-# LANGUAGE Rank2Types #-}
12+{-# LANGUAGE ScopedTypeVariables #-}
13+{-# LANGUAGE TupleSections #-}
14+{-# LANGUAGE TypeFamilies #-}
15+{-# LANGUAGE TypeOperators #-}
16+{-# LANGUAGE UndecidableInstances #-}
17+
18+#if MIN_VERSION_base(4,9,0)
19+{-# OPTIONS_GHC -fno-warn-redundant-constraints #-}
20+#endif
2221
2322-- #include "overlapping-compat.h"
2423-- | This module provides 'client' which can automatically generate
@@ -26,47 +25,57 @@
2625-- API.
2726module Servant.Reflex
2827 ( client
28+ , clientWithOpts
29+ , clientWithOptsAndResultHandler
30+ , clientWithRoute
31+ , clientWithRouteAndResultHandler
2932 , BuildHeaderKeysTo(..)
3033 , toHeaders
31− , HasClient(..)
34+ , HasClient
35+ , Client
3236 , module Servant.Common.Req
3337 , module Servant.Common.BaseUrl
3438 ) where
3539
3640------------------------------------------------------------------------------
37−import Data.Aeson
3841import Control.Applicative
39−import Data.Monoid ((<>))
40−import qualified Data.Set as Set
41−import qualified Data.Text.Encoding as E
42−import Data.CaseInsensitive (mk)
42+import qualified Data.CaseInsensitive as CI
4343import Data.Functor.Identity
44−import Data.Proxy (Proxy (..))
4544import qualified Data.Map as Map
45+import Data.Monoid ((<>))
46+import Data.Proxy (Proxy (..))
47+import qualified Data.Set as Set
4648import Data.Text (Text)
4749import qualified Data.Text as T
50+import qualified Data.Text.Encoding as E
51+import GHC.Exts (Constraint)
4852import GHC.TypeLits (KnownSymbol, symbolVal)
49−import Servant.API ((:<|>)(..),(:>), BasicAuth,
50− BasicAuthData, BuildHeadersTo(..),
51− Capture, contentType, Header,
52− Headers(..), HttpVersion, IsSecure,
53− MimeRender(..), MimeUnrender,
53+import Servant.API ((:<|>) (..), (:>), BasicAuth,
54+ BasicAuthData, BuildHeadersTo (..),
55+ Capture, Header, Headers (..),
56+ HttpVersion, IsSecure,
57+ MimeRender (..), MimeUnrender,
5458 NoContent, QueryFlag, QueryParam,
55− QueryParams, Raw, ReflectMethod(..),
59+ QueryParams, Raw, ReflectMethod (..),
5660 RemoteHost, ReqBody,
57− ToHttpApiData(..), Vault, Verb)
58−
59−import Reflex.Dom (Dynamic, Event, Reflex,
60− XhrRequest(..),
61− XhrResponseHeaders(..),
62− XhrResponse(..), attachPromptlyDynWith, constDyn, ffor, fmapMaybe,
63− leftmost, performRequestsAsync,
64− )
61+ ToHttpApiData (..), Vault, Verb,
62+ contentType)
63+import Servant.API.Description (Summary)
64+import qualified Servant.Auth as Auth
65+
66+import Reflex.Dom.Core (Dynamic, Event, Reflex,
67+ XhrRequest (..), XhrResponse (..),
68+ XhrResponseHeaders (..),
69+ attachPromptlyDynWith, constDyn, ffor,
70+ fmapMaybe, leftmost,
71+ performRequestsAsync)
6572------------------------------------------------------------------------------
6673import Servant.Common.BaseUrl (BaseUrl(..), Scheme(..), baseUrlWidget,
6774 showBaseUrl,
6875 SupportsServantReflex)
69−import Servant.Common.Req (Req, ReqResult(..), QParam(..),
76+import Servant.Common.Req (ClientOptions(..),
77+ defaultClientOptions,
78+ Req, ReqResult(..), QParam(..),
7079 QueryPart(..), addHeader, authData,
7180 defReq, evalResponse, prependToPathParts,
7281 -- performRequestCT,
@@ -76,9 +85,10 @@ import Servant.Common.Req (Req, ReqResult(..), QParam(..),
7685 performSomeRequestsAsync,
7786 qParamToQueryPart, reqBody,
7887 reqSuccess, reqFailure,
79− reqMethod, respHeaders, response,
88+ reqMethod, respHeaders,
89+ response,
8090 reqTag,
81− qParams)
91+ qParams, withCredentials)
8292
8393
8494-- * Accessing APIs as a Client
@@ -93,28 +103,75 @@ import Servant.Common.Req (Req, ReqResult(..), QParam(..),
93103-- >
94104-- > getAllBooks :: Event t l -> m (Event t (l, ReqResult [Book]))
95105-- > postNewBook :: Dynamic t (Maybe Book) -> Event t l
96−-- -> m (Event t (l, ReqResult Book)))
106+-- > -> m (Event t (l, ReqResult Book)))
97107-- > (getAllBooks :<|> postNewBook) = client myApi host
98108-- > where host = constDyn $ BaseUrl Http "localhost" 8080
99−client :: (HasClient t m layout tag)
100− => Proxy layout -> Proxy m -> Proxy tag -> Dynamic t BaseUrl -> Client t m layout tag
101−client p q t baseurl = clientWithRoute p q t defReq baseurl
109+client
110+ :: (HasClient t m layout tag)
111+ => Proxy layout
112+ -> Proxy m
113+ -> Proxy tag
114+ -> Dynamic t BaseUrl
115+ -> Client t m layout tag
116+client p q t baseurl = clientWithRoute p q t defReq baseurl defaultClientOptions
117+
118+clientWithOpts
119+ :: (HasClient t m layout tag)
120+ => Proxy layout
121+ -> Proxy m
122+ -> Proxy tag
123+ -> Dynamic t BaseUrl
124+ -> ClientOptions
125+ -> Client t m layout tag
126+clientWithOpts p q t baseurl = clientWithRoute p q t defReq baseurl
127+
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)
133+ => Proxy layout
134+ -> Proxy m
135+ -> Proxy tag
136+ -> Dynamic t BaseUrl
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
102141
103142
104143-- | This class lets us define how each API combinator
105144-- influences the creation of an HTTP request. It's mostly
106145-- an internal class, you can just use 'client'.
107−class HasClient t m layout (tag :: *) where
146+class Monad m => HasClient t m layout (tag :: *) where
108147 type Client t m layout tag :: *
109− clientWithRoute :: Proxy layout -> Proxy m -> Proxy tag -> Req t -> Dynamic t BaseUrl -> Client t m layout tag
148+ clientWithRoute
149+ :: Proxy layout
150+ -> Proxy m
151+ -> Proxy tag
152+ -> Req t
153+ -> Dynamic t BaseUrl
154+ -> ClientOptions
155+ -> Client t m layout tag
156+ clientWithRoute l m t r b o = clientWithRouteAndResultHandler l m t r b o return
157+
158+ clientWithRouteAndResultHandler
159+ :: Proxy layout
160+ -> Proxy m
161+ -> Proxy tag
162+ -> Req t
163+ -> Dynamic t BaseUrl
164+ -> ClientOptions
165+ -> (forall a. Event t (ReqResult tag a) -> m (Event t (ReqResult tag a)))
166+ -> Client t m layout tag
110167
111168
112169instance (HasClient t m a tag, HasClient t m b tag) => HasClient t m (a :<|> b) tag where
113170 type Client t m (a :<|> b) tag = Client t m a tag :<|> Client t m b tag
114171
115− clientWithRoute Proxy q pTag req baseurl =
116− clientWithRoute (Proxy :: Proxy a) q pTag req baseurl :<|>
117− clientWithRoute (Proxy :: Proxy b) q pTag req baseurl
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
118175
119176
120177-- Capture. Example:
@@ -129,32 +186,29 @@ instance (HasClient t m a tag, HasClient t m b tag) => HasClient t m (a :<|> b)
129186-- -> m (Event t (l, ReqResult Book))
130187-- > getBook = client myApi (constDyn host)
131188
132−instance (SupportsServantReflex t m, FromJSON a, ToHttpApiData a, HasClient t m sublayout tag)
189+instance (SupportsServantReflex t m, ToHttpApiData a, HasClient t m sublayout tag)
133190 => HasClient t m (Capture capture a :> sublayout) tag where
134191
135192 type Client t m (Capture capture a :> sublayout) tag =
136193 Dynamic t (Either Text a) -> Client t m sublayout tag
137194
138− clientWithRoute Proxy q t req baseurl val =
139− clientWithRoute (Proxy :: Proxy sublayout)
140− q t
141− (prependToPathParts p req)
142− baseurl
195+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap val =
196+ clientWithRouteAndResultHandler
197+ (Proxy :: Proxy sublayout) q t (prependToPathParts p req) baseurl opts wrap
143198 where p = (fmap . fmap) (toUrlPiece) val
144199
145200
146201-- VERB (Returning content) --
147202instance {-# OVERLAPPABLE #-}
148203 -- Note [Non-Empty Content Types]
149− (FromJSON a, MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts), SupportsServantReflex t m
204+ (MimeUnrender ct a, ReflectMethod method, cts' ~ (ct ': cts), SupportsServantReflex t m
150205 ) => HasClient t m (Verb method status cts' a) tag where
151206 type Client t m (Verb method status cts' a) tag =
152207 Event t tag -> m (Event t (ReqResult tag a))
153208 -- TODO how to access input types here?
154209 -- ExceptT ServantError IO a
155− clientWithRoute Proxy _ _ req baseurl trigs =
156− -- performRequestCT (Proxy :: Proxy ct) method req' baseurl trigs
157− fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity $ req') baseurl trigs
210+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
211+ wrap =<< fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity $ req') baseurl opts trigs
158212 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
159213 req' = req { reqMethod = method }
160214
@@ -167,29 +221,33 @@ instance {-# OVERLAPPING #-}
167221 Event t tag -> m (Event t (ReqResult tag NoContent))
168222 -- TODO: how to access input types here?
169223 -- ExceptT ServantError IO NoContent
170− clientWithRoute Proxy _ _ req baseurl =
171− (fmap . fmap) runIdentity . performRequestsNoBody method (constDyn $ Identity req) baseurl
224+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs =
225+ wrap =<< fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req) baseurl opts trigs
172226 where method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
173227
174228
175229toHeaders :: BuildHeadersTo ls => ReqResult tag a -> ReqResult tag (Headers ls a)
176230toHeaders r =
177− let toBS = E.encodeUtf8
178− hdrs = maybe []
179− (\xhr -> fmap (\(h,v) -> (mk (toBS h), toBS v))
231+ let hdrs = maybe []
232+ (\xhr -> fmap (\(h,v) -> (CI.map E.encodeUtf8 h, E.encodeUtf8 v))
180233 (Map.toList $ _xhrResponse_headers xhr))
181234 (response r)
182235 in ffor r $ \a -> Headers {getResponse = a ,getHeadersHList = buildHeadersTo hdrs}
183236
237+
184238class BuildHeaderKeysTo hs where
185− buildHeaderKeysTo :: Proxy hs -> [T.Text]
239+ buildHeaderKeysTo :: Proxy hs -> [CI.CI T.Text]
186240
187241instance {-# OVERLAPPABLE #-} BuildHeaderKeysTo '[]
188242 where buildHeaderKeysTo _ = []
189243
190244instance {-# OVERLAPPABLE #-} (BuildHeaderKeysTo xs, KnownSymbol h)
191245 => BuildHeaderKeysTo ((Header h v) ': xs) where
192− buildHeaderKeysTo _ = T.pack (symbolVal (Proxy :: Proxy h)) : buildHeaderKeysTo (Proxy :: Proxy xs)
246+ buildHeaderKeysTo _ =
247+ let
248+ thisKey = CI.mk $ T.pack (symbolVal (Proxy :: Proxy h))
249+ in thisKey : buildHeaderKeysTo (Proxy :: Proxy xs)
250+
193251
194252-- HEADERS Verb (Content) --
195253-- Headers combinator not treated in fully general case,
@@ -199,16 +257,15 @@ instance {-# OVERLAPPABLE #-} (BuildHeaderKeysTo xs, KnownSymbol h)
199257instance {-# OVERLAPPABLE #-}
200258 -- Note [Non-Empty Content Types]
201259 ( MimeUnrender ct a, BuildHeadersTo ls, BuildHeaderKeysTo ls,
202− FromJSON a,
203260 ReflectMethod method, cts' ~ (ct ': cts),
204261 SupportsServantReflex t m
205262 ) => HasClient t m (Verb method status cts' (Headers ls a)) tag where
206263 type Client t m (Verb method status cts' (Headers ls a)) tag =
207264 Event t tag -> m (Event t (ReqResult tag (Headers ls a)))
208− clientWithRoute Proxy _ _ req baseurl trigs = do
265+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
209266 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
210− resp <- fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity req') baseurl trigs
211− return $ toHeaders <$> resp
267+ resp <- fmap runIdentity <$> performRequestsCT (Proxy :: Proxy ct) method (constDyn $ Identity req') baseurl opts trigs
268+ wrap $ toHeaders <$> resp
212269 where req' = req { respHeaders =
213270 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
214271 }
@@ -221,10 +278,10 @@ instance {-# OVERLAPPABLE #-}
221278 ) => HasClient t m (Verb method status cts (Headers ls NoContent)) tag where
222279 type Client t m (Verb method status cts (Headers ls NoContent)) tag
223280 = Event t tag -> m (Event t (ReqResult tag (Headers ls NoContent)))
224− clientWithRoute Proxy _ _ req baseurl trigs = do
281+ clientWithRouteAndResultHandler Proxy _ _ req baseurl opts wrap trigs = do
225282 let method = E.decodeUtf8 $ reflectMethod (Proxy :: Proxy method)
226− resp <- fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req') baseurl trigs
227− return $ toHeaders <$> resp
283+ resp <- fmap runIdentity <$> performRequestsNoBody method (constDyn $ Identity req') baseurl opts trigs
284+ wrap $ toHeaders <$> resp
228285 where req' = req {respHeaders =
229286 OnlyHeaders (Set.fromList (buildHeaderKeysTo (Proxy :: Proxy ls)))
230287 }
@@ -251,11 +308,11 @@ instance (KnownSymbol sym, ToHttpApiData a,
251308 type Client t m (Header sym a :> sublayout) tag =
252309 Dynamic t (Either Text a) -> Client t m sublayout tag
253310
254− clientWithRoute Proxy q t req baseurl eVal =
255− clientWithRoute (Proxy :: Proxy sublayout)
256− q t
257− (Servant.Common.Req.addHeader hname eVal req)
258− baseurl
311+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap eVal =
312+ clientWithRouteAndResultHandler
313+ (Proxy :: Proxy sublayout) q t
314+ (Servant.Common.Req.addHeader hname eVal req)
315+ baseurl opts wrap
259316 where hname = T.pack $ symbolVal (Proxy :: Proxy sym)
260317
261318
@@ -269,8 +326,21 @@ instance HasClient t m sublayout tag
269326 type Client t m (HttpVersion :> sublayout) tag =
270327 Client t m sublayout tag
271328
272− clientWithRoute Proxy q t =
273− clientWithRoute (Proxy :: Proxy sublayout) q t
329+ clientWithRouteAndResultHandler Proxy =
330+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout)
331+
332+-- | Using a 'Summary' combinator in your API doesn't affect the client
333+-- functions.
334+instance (HasClient t m sublayout tag, KnownSymbol sym)
335+ => HasClient t m (Summary sym :> sublayout) tag where
336+
337+ type Client t m (Summary sym :> sublayout) tag =
338+ Client t m sublayout tag
339+
340+ clientWithRouteAndResultHandler Proxy =
341+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout)
342+
343+
274344
275345
276346-- | If you use a 'QueryParam' in one of your endpoints in your API,
@@ -306,9 +376,9 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex
306376 Dynamic t (QParam a) -> Client t m sublayout tag
307377
308378 -- if mparam = Nothing, we don't add it to the query string
309− clientWithRoute Proxy q t req baseurl mparam =
310− clientWithRoute (Proxy :: Proxy sublayout) q t
311− (req {qParams = paramPair : qParams req}) baseurl
379+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap mparam =
380+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t
381+ (req {qParams = paramPair : qParams req}) baseurl opts wrap
312382
313383 where pname = symbolVal (Proxy :: Proxy sym)
314384 --p prm = QueryPartParam $ (fmap . fmap) (toQueryParam) prm
@@ -352,8 +422,8 @@ instance (KnownSymbol sym, ToHttpApiData a, HasClient t m sublayout tag, Reflex
352422 type Client t m (QueryParams sym a :> sublayout) tag =
353423 Dynamic t [a] -> Client t m sublayout tag
354424
355− clientWithRoute Proxy q t req baseurl paramlist =
356− clientWithRoute (Proxy :: Proxy sublayout) q t req' baseurl
425+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap paramlist =
426+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
357427
358428 where req' = req { qParams = (T.pack pname, params') : qParams req }
359429 pname = symbolVal (Proxy :: Proxy sym)
@@ -392,8 +462,8 @@ instance (KnownSymbol sym, HasClient t m sublayout tag, Reflex t)
392462 type Client t m (QueryFlag sym :> sublayout) tag =
393463 Dynamic t Bool -> Client t m sublayout tag
394464
395− clientWithRoute Proxy q t req baseurl flag =
396− clientWithRoute (Proxy :: Proxy sublayout) q t req' baseurl
465+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap flag =
466+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
397467
398468 where req' = req { qParams = thisPair : qParams req }
399469 thisPair = (T.pack pName, QueryPartFlag flag) :: (Text, QueryPart t)
@@ -407,7 +477,7 @@ instance SupportsServantReflex t m => HasClient t m Raw tag where
407477 -> Event t tag
408478 -> m (Event t (ReqResult tag ()))
409479
410− clientWithRoute _ _ _ _ baseurl xhrs triggers = do
480+ clientWithRouteAndResultHandler _ _ _ _ baseurl _ wrap xhrs triggers = do
411481
412482 let xhrs' = liftA2 (\x path -> case x of
413483 Left e -> Left e
@@ -418,7 +488,7 @@ instance SupportsServantReflex t m => HasClient t m Raw tag where
418488 okReq = fmapMaybe (\(t,x) -> either (const Nothing) (Just . (t,)) x) xhrs'' :: Event t (tag, XhrRequest ())
419489
420490 resps <- performRequestsAsync okReq
421− return $ leftmost [ uncurry RequestFailure <$> badReq
491+ wrap $ leftmost [ uncurry RequestFailure <$> badReq
422492 , evalResponse (const $ Right ()) <$> resps
423493 ]
424494
@@ -449,8 +519,8 @@ instance (MimeRender ct a, HasClient t m sublayout tag, Reflex t)
449519 type Client t m (ReqBody (ct ': cts) a :> sublayout) tag =
450520 Dynamic t (Either Text a) -> Client t m sublayout tag
451521
452− clientWithRoute Proxy q t req baseurl body =
453− clientWithRoute (Proxy :: Proxy sublayout) q t req' baseurl
522+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap body =
523+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t req' baseurl opts wrap
454524 where req' = req { reqBody = bodyBytesCT }
455525 ctProxy = Proxy :: Proxy ct
456526 ctString = T.pack $ show $ contentType ctProxy
@@ -464,9 +534,9 @@ instance (MimeRender ct a, HasClient t m sublayout tag, Reflex t)
464534instance (KnownSymbol path, HasClient t m sublayout tag, Reflex t) => HasClient t m (path :> sublayout) tag where
465535 type Client t m (path :> sublayout) tag = Client t m sublayout tag
466536
467− clientWithRoute Proxy q t req baseurl =
468− clientWithRoute (Proxy :: Proxy sublayout) q t
469− (prependToPathParts (pure (Right $ T.pack p)) req) baseurl
537+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap =
538+ clientWithRouteAndResultHandler (Proxy :: Proxy sublayout) q t
539+ (prependToPathParts (pure (Right $ T.pack p)) req) baseurl opts wrap
470540
471541 where p = symbolVal (Proxy :: Proxy path)
472542
@@ -474,23 +544,23 @@ instance (KnownSymbol path, HasClient t m sublayout tag, Reflex t) => HasClient
474544instance HasClient t m api tag => HasClient t m (Vault :> api) tag where
475545 type Client t m (Vault :> api) tag = Client t m api tag
476546
477− clientWithRoute Proxy q t req baseurl =
478− clientWithRoute (Proxy :: Proxy api) q t req baseurl
547+ clientWithRouteAndResultHandler Proxy =
548+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
479549
480550
481551instance HasClient t m api tag => HasClient t m (RemoteHost :> api) tag where
482552 type Client t m (RemoteHost :> api) tag = Client t m api tag
483553
484− clientWithRoute Proxy q t req baseurl =
485− clientWithRoute (Proxy :: Proxy api) q t req baseurl
554+ clientWithRouteAndResultHandler Proxy =
555+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
486556
487557
488558
489559instance HasClient t m api tag => HasClient t m (IsSecure :> api) tag where
490560 type Client t m (IsSecure :> api) tag = Client t m api tag
491561
492− clientWithRoute Proxy q t req baseurl =
493− clientWithRoute (Proxy :: Proxy api) q t req baseurl
562+ clientWithRouteAndResultHandler Proxy =
563+ clientWithRouteAndResultHandler (Proxy :: Proxy api)
494564
495565
496566instance (HasClient t m api tag, Reflex t)
@@ -499,8 +569,8 @@ instance (HasClient t m api tag, Reflex t)
499569 type Client t m (BasicAuth realm usr :> api) tag = Dynamic t (Maybe BasicAuthData)
500570 -> Client t m api tag
501571
502− clientWithRoute Proxy q t req baseurl authdata =
503− clientWithRoute (Proxy :: Proxy api) q t req' baseurl
572+ clientWithRouteAndResultHandler Proxy q t req baseurl opts wrap authdata =
573+ clientWithRouteAndResultHandler (Proxy :: Proxy api) q t req' baseurl opts wrap
504574 where
505575 req' = req { authData = Just authdata }
506576
@@ -526,3 +596,30 @@ non-empty lists, but is otherwise more specific, no instance will be overall
526596more specific. This in turn generally means adding yet another instance (one
527597for empty and one for non-empty lists).
528598-}
599+
600+
601+-- SUPPORT FOR servant-auth --
602+
603+-- For JavaScript clients we should be sending/storing JSON web tokens in a
604+-- way that is inaccessible to JavaScript.
605+--
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
609+-- directly.
610+
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
614+
615+ type Client t m (Auth.Auth auths a :> api) tag = Client t m api tag
616+ clientWithRouteAndResultHandler Proxy = clientWithRouteAndResultHandler (Proxy :: Proxy api)
617+
618+
619+type family HasCookieAuth xs :: Constraint where
620+ HasCookieAuth (Auth.Cookie ': xs) = ()
621+ HasCookieAuth (x ': xs) = HasCookieAuth xs
622+ HasCookieAuth '[] = CookieAuthNotEnabled
623+
624+class CookieAuthNotEnabled
625+